50b4b15984
gh-87864: Use correct function definition syntax in the docs ( #103312 )
2023-04-11 16:50:25 +03:00
c396b6ddf3
gh-81762: Clarify and simplify description of print's flush param ( #103264 )
2023-04-05 12:16:36 +01:00
81bf10e4f2
gh-102105 Fix wording in filterfalse/quantify/filter (GH-102189)
2023-02-24 10:13:05 -06:00
61f1e67c6f
GH-84783: Make the slice object hashable (GH-101264)
2023-02-18 18:22:02 -06:00
ef633e5000
Sync-up parameter name in equivalent code snippet of `enumerate` (GH-101029)
2023-01-13 23:55:35 -06:00
edfbf56f4c
gh-100428: Make int documentation more accurate ( #100436 )
...
- Remove first link to lexical definition of integer literal, since it
doesn't apply (differs in handling of leading zeros, base needs to be
explicitly specified, unicode digits are allowed)
- Better describe handling of leading zeros, unicode digits, underscores
- Base 0 does not work exactly as like a code literal, since it allows
Unicode digits. Link code literal to lexical definition of integer
literal.
2023-01-01 19:14:18 -08:00
71159a8e07
gh-100546: Remove incorrect positional-only marker from eval ( #100547 )
...
All the arguments are positional-only.
The current status after #99476 seems to be to not use positional-only
markers in documentation, hence I've simply removed it.
2022-12-31 17:59:31 -07:00
cf1c098180
GH-100101: Clarify documentation of zip's strict option (GH-100103)
2022-12-28 13:24:50 -08:00
2e1a9ce989
gh-100428: Make float documentation more accurate ( #100437 )
...
Previously, the grammar did not accept `float("10")`.
Also implement mdickinson's suggestion of removing the indirection.
2022-12-24 14:09:31 -06:00
5d84966cce
GH-100425: Improve accuracy of builtin sum() for float inputs (GH-100426)
2022-12-23 14:35:58 -08:00
286e3c76a9
gh-99087: Add missing newline for prompts in docs (GH-98993)
...
Add newline for prompts so copying to REPL does not cause errors.
2022-12-08 19:31:19 -08:00
858cb79486
Doc: Make functions.html readable again. (GH-99476)
2022-11-19 11:25:45 +01:00
2db55e0c00
gh-94286 Fix documentation of print default param (GH-94297)
2022-11-06 20:14:58 +00:00
3c4cbd177f
gh-91485: Doc: Using Python syntax to document builtin Python functions. (GH-96579)
2022-10-15 12:19:35 +02:00
4a74e6ab38
gh-64921: Clarify wording for open()'s newline arg ( #96171 )
2022-10-07 11:12:08 -07:00
9a11ed8e50
gh-96397: Document that attributes need not be identifiers ( #96454 )
...
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2022-09-29 16:02:27 -07:00
34de67c094
gh-96512: Update int_max_str docs to say 3.11 ( #96942 )
...
It was unknown if it'd be before 3.11.0 when creating the original
changes. It's in 3.11rc2, so 3.11 it is.
2022-09-19 16:43:11 -07:00
511ca94520
gh-95778: CVE-2020-10735: Prevent DoS by very large int() ( #96499 )
...
Integer to and from text conversions via CPython's bignum `int` type is not safe against denial of service attacks due to malicious input. Very large input strings with hundred thousands of digits can consume several CPU seconds.
This PR comes fresh from a pile of work done in our private PSRT security response team repo.
Signed-off-by: Christian Heimes [Red Hat] <christian@python.org>
Tons-of-polishing-up-by: Gregory P. Smith [Google] <greg@krypto.org>
Reviews via the private PSRT repo via many others (see the NEWS entry in the PR).
<!-- gh-issue-number: gh-95778 -->
* Issue: gh-95778
<!-- /gh-issue-number -->
I wrote up [a one pager for the release managers](https://docs.google.com/document/d/1KjuF_aXlzPUxTK4BMgezGJ2Pn7uevfX7g0_mvgHlL7Y/edit# ). Much of that text wound up in the Issue. Backports PRs already exist. See the issue for links.
2022-09-02 09:35:08 -07:00
0319cd6825
gh-96197: Define the behavior of repr if sys.displayhook is lost (gh-96242)
2022-08-26 11:02:57 +09:00
47d406ffc4
gh-96197: Fix expression when :func:`sys.breakpointhook is missing (gh-96293)
2022-08-26 10:43:02 +09:00
09563a764e
gh-96197: Define the behavior of breakpoint if sys.breakpointhook is lost (gh-96231)
2022-08-24 23:03:36 +09:00
0efe3a1636
gh-86986: Drop compatibility support for Sphinx 2 (GH-93737)
...
* Revert "bpo-42843: Keep Sphinx 1.8 and Sphinx 2 compatibility (GH-24282)"
This reverts commit 5c1f15b4b1b63a620014
2022-06-21 17:04:46 +02:00
7f835923c1
gh-71223: Improve rendering of some references in the docs (GH-93041)
...
For example, instead of "eval()uated" (link from "eval()")
show "evaluated" (link from the whole word).
2022-05-21 10:33:23 +03:00
f298ba1f27
bpo-39229: fix formatting in library/functions.rst ( #17857 )
...
Missing reference of auditing event presents error when building translated documentation
2022-05-08 16:21:19 -07:00
5021064390
gh-92203: Add closure support to exec(). ( #92204 )
...
Add a closure keyword-only parameter to exec(). It can only be specified when exec-ing a code object that uses free variables. When specified, it must be a tuple, with exactly the number of cell variables referenced by the code object. closure has a default value of None, and it must be None if the code object doesn't refer to any free variables.
2022-05-06 10:09:35 -07:00
ebaf0945f9
GH-89519: Deprecate classmethod descriptor chaining ( #92379 )
2022-05-06 02:57:53 -05:00
1066ecb970
gh-81488: Add recursive wording for issubclass docs ( #92087 )
2022-04-30 22:05:20 -06:00
0ef8d921f5
gh-91603: Speed up isinstance/issubclass on union types (GH-91631)
...
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
2022-04-28 23:24:19 +08:00
1317b70f89
gh-91156: Use `locale.getencoding()` instead of getpreferredencoding (GH-91732)
...
Co-authored-by: Victor Stinner <vstinner@python.org>
2022-04-22 10:39:24 +09:00
5101d97d0b
bpo-30718: Add information about text buffering (GH-32351)
2022-04-20 17:24:53 +09:00
b4bd1e1422
bpo-44977: Deprecate delegation of int to __trunc__ (GH-31031)
...
Calling int(a) when type(a) implements __trunc__ but not __int__
or __index__ now raises a DeprecationWarning.
2022-02-03 11:43:25 +02:00
b9d8980d89
bpo-43698: do not use `...` as argument name in docs (GH-30502)
2022-01-26 19:06:10 +09:00
f025ae63dc
Add Positional only arguments forward slash (/) to sorted() function in Built-in Functions document (GH-30113)
...
sorted() function is missing forward slash (/) in Built-in Functions documentation page.
Automerge-Triggered-By: GH:asvetlov
2021-12-15 03:24:38 -08:00
4fe5585240
bpo-19737: Improved the documentation for globals (GH-29823)
...
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
2021-12-11 01:04:21 +01:00
be36e06340
bpo-45250: fix docs regarding `__iter__` and iterators being inconsistently required by CPython (GH-29170)
...
It is now considered a historical accident that e.g. `for` loops and the `iter()` built-in function do not require the iterators they work with to define `__iter__`, only `__next__`.
2021-11-19 16:40:34 -08:00
48824fa1e2
[doc] Link to section File input (GH-28941)
2021-11-02 22:34:00 +01:00
887a55705b
bpo-44344: Document that pow can return a complex number for non-complex inputs. (GH-27853)
...
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
2021-10-21 22:57:49 +02:00
4f05f15d7b
[docs] Improve the markup of powers (GH-28598)
2021-09-28 22:40:57 +02:00
9a0dcc5b2e
bpo-45246: Document that sorted() only uses "<" comparisons (GH-28494)
2021-09-21 12:26:27 -05:00
19ba2122ac
bpo-37330: open() no longer accept 'U' in file mode (GH-28118)
...
open(), io.open(), codecs.open() and fileinput.FileInput no longer
accept "U" ("universal newline") in the file mode. This flag was
deprecated since Python 3.3.
2021-09-02 12:58:00 +02:00
9a7ec2fcde
bpo-44135: [docs] Fix inline markup (GH-28095)
2021-08-31 18:01:17 +02:00
08767c73b5
bpo-44135: Refine explanation of how passing tuples to issubclass() behaves (GH-26193)
...
Co-authored-by: Zachary Kneupper <zachary.kneupper@gmail.com>
2021-08-31 15:39:19 +02:00
b05e9b63fc
bpo-44522: Fix inaccurate information in open() function (GH-27650)
...
- Use "Low surrogate code units" instead of "Unicode Private Use Area"
2021-08-09 16:14:54 +02:00
1e651c6ada
Clean up comma usage in Doc/library/functions.rst ( #27083 )
2021-07-19 18:02:23 +02:00
d18e5dae91
bpo-20408: Fix memoryview() signature in docs (GH-24431)
2021-05-25 17:24:30 +03:00
69a733bda3
[doc] Be more clear on super() regarding multiple base classes methods (GH-21789)
2021-04-28 18:12:15 -07:00
d35eef3b90
Update Sphinx directive for super from function to class (GH-25489)
2021-04-20 11:58:02 -07:00
553ee2781a
bpo-43682: Make staticmethod objects callable (GH-25117)
...
Static methods (@staticmethod) are now callable as regular functions.
2021-04-12 00:21:22 +02:00
507a574de3
bpo-43682: @staticmethod inherits attributes (GH-25268)
...
Static methods (@staticmethod) and class methods (@classmethod) now
inherit the method attributes (__module__, __name__, __qualname__,
__doc__, __annotations__) and have a new __wrapped__ attribute.
Changes:
* Add a repr() method to staticmethod and classmethod types.
* Add tests on the @classmethod decorator.
2021-04-09 17:51:22 +02:00
d9692027f4
bpo-31861: Complete the C-API docs for PyObject_GetAiter and PyAiter_Check (GH-25004)
2021-03-23 23:57:03 +00:00
f0a6fde882
bpo-31861: Add aiter and anext to builtins ( #23847 )
...
Co-authored-by: jab <jab@users.noreply.github.com>
Co-authored-by: Daniel Pope <mauve@mauveweb.co.uk>
Co-authored-by: Justin Wang <justin39@gmail.com>
2021-03-23 15:47:21 -07:00
72fcd14a82
bpo-42840: Document providing kwargs to type. ( #24173 )
...
Co-authored-by: Ken Jin <28750310+Fidget-Spinner@users.noreply.github.com>
2021-03-01 15:21:04 -08:00
5f77dee056
Improve docs of PEP 604 Union ( #24301 )
2021-02-08 17:57:11 -08:00
0ec57e25c9
bpo-16781: In 'exec' doc, add 'nonlocal' to 'yield' and 'return' (GH-2446)
...
These 3 statements cannot be used at module scope -- nor in exec with one namespace.
2021-02-07 00:28:50 -05:00
2edaf6a4fb
bpo-8264: Document hasattr and getattr behavior for private attributes (GH-23513)
...
Clarify ``getattr`` and ``setattr`` requirements for accessing name-mangled attributes
Co-Authored-By: Catalin Iacob <iacobcatalin@gmail.com>
2021-02-02 13:06:57 -08:00
5c1f15b4b1
bpo-42843: Keep Sphinx 1.8 and Sphinx 2 compatibility (GH-24282)
2021-01-25 15:46:06 +01:00
644d52818a
bpo-40304: Correct type(name, bases, dict) doc (GH-19553)
...
Co-authored-by: Éric Araujo <merwok@netwok.org>
Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
Co-authored-by: Tal Einat <532281+taleinat@users.noreply.github.com>
2021-01-22 00:47:23 -05:00
dcc997cd28
[doc] Fix erroneous backslashes in signatures and names (GH-23658)
...
The issue being resolved is shown in the 3.10 docs (if you select docs for older versions you won't see a visual glitch).
The newer sphinx version that produces the 3.10 docs doesn't treat the backslash to escape things in some situations it previously did.
2020-12-16 17:37:28 -08:00
fc3dca3e16
Clarify eval() doc from library/functions. (GH-22700)
2020-12-16 16:45:19 +01:00
b76a840021
bpo-42180: fix plural in arguments and control (GH-23015)
...
https://bugs.python.org/issue42180
2020-10-29 20:48:21 +00:00
0f25c231b3
Add a link to buffer protocol in bytearray() doc (GH-22675)
2020-10-26 14:26:34 +09:00
3f7e990fd4
bpo-41192: Add documentation of undocumented audit events (GH-21308)
2020-10-20 15:23:15 -04:00
155938907c
bpo-40484: Document compiler flags under AST module (GH-19885)
...
Co-authored-by: Pablo Galindo <Pablogsal@gmail.com>
Co-authored-by: Shantanu <hauntsaninja@users.noreply.github.com>
2020-10-19 02:14:11 +01:00
e799aa8b92
bpo-41887: omit leading spaces/tabs on ast.literal_eval ( #22469 )
...
Also document that eval() does this (the same way).
2020-10-03 17:46:44 -07:00
c8bb24166e
[doc] Update references to NumPy (GH-22458)
...
Numeric(al) Python to NumPy. It seems the old name hasn't been used for some time.
2020-10-01 16:22:14 -07:00
8af239eacf
bpo-41762: Fix usage of productionlist markup in the doc (GH-22281)
...
Use an unique identifier for the different grammars documented using
the Sphinx productionlist markup.
productionlist markups of the same grammar, like "expressions" or
"compound statements", use the same identifier "python-grammar".
2020-09-18 09:10:15 +02:00
802726acf6
Document vars behavior when __dict__ is missing ( #21466 )
2020-08-21 19:29:34 -03:00
705f145565
Doc: Add a link to tutorial page from `open()` doc (GH-21737)
...
Adds a link to the "Reading and Writing Files" page so users can
more easily discover how file handles are handled with the `with`
context manager vs without it.
2020-08-08 11:57:03 +09:00
a908bc4dd8
Doc: Builtins functions: faster jump table (GH-21376)
2020-07-09 11:38:41 +02:00
77ed29b2c2
Fix typo in functions.rst (GH-21131)
2020-06-25 14:50:37 -07:00
59cf853332
bpo-40636: Documentation for zip-strict ( #20961 )
2020-06-19 13:39:22 -07:00
2831642212
Indicate that abs() method accept argument that implement __abs__(), just like call() method in the docs (GH-20509)
2020-05-29 07:35:34 -04:00
c691f20952
Fix "versionchanged" for pow named arguments (GH-19042)
...
The ability to use named arguments in "pow" was introduced in Python 3.8, not Python 3.9. See https://bugs.python.org/issue38237
2020-03-19 18:12:59 +00:00
fc72ab6913
bpo-38691: importlib ignores PYTHONCASEOK if -E is used (GH-18627)
...
The importlib module now ignores the PYTHONCASEOK
environment variable when the -E or -I command line
options are being used.
2020-03-09 12:57:53 +01:00
942f7a2dea
bpo-39674: Revert "bpo-37330: open() no longer accept 'U' in file mode (GH-16959)" (GH-18767)
...
This reverts commit e471e72977
2020-03-04 18:50:22 +01:00
4dee92b0ad
Revert "bpo-38691 Added a switch to ignore PYTHONCASEOK when -E or -I flags passed ( #18314 )" (GH-18553)
...
This reverts commit d83b6600b2
2020-02-19 14:23:47 +01:00
d83b6600b2
bpo-38691 Added a switch to ignore PYTHONCASEOK when -E or -I flags passed ( #18314 )
...
* Hard reset + cherry piciking the changes.
* 📜 🤖 Added by blurb_it.
* Added @vstinner News
* Update Misc/NEWS.d/next/Library/2020-02-11-13-01-38.bpo-38691.oND8Sk.rst
Co-Authored-By: Victor Stinner <vstinner@python.org>
* Hard reset to master
* Hard reset to master + latest changes
Co-authored-by: blurb-it[bot] <43283697+blurb-it[bot]@users.noreply.github.com>
Co-authored-by: Victor Stinner <vstinner@python.org>
2020-02-17 10:05:11 +01:00
d7c7adde00
bpo-12159: Document sys.maxsize limit in len() function reference (GH-17934)
2020-01-12 10:04:14 +01:00
ee9ff05ec2
bpo-34118: memoryview, range, and tuple are classes (GH-17761)
...
Tag memoryview, range, and tuple as classes, the same as list, etcetera, in
the library manual built-in functions list.
2019-12-30 17:16:43 -05:00
d67279147a
Update functions.rst (GH-16468)
...
This PR will make the following changes to the [_Built-in Functions_](https://docs.python.org/3/library/functions.html ) chapter of the library documentation:
- improve hyperlinks in Sphinx roles (trailing 's' belong to hyperlinks).
Automerge-Triggered-By: @csabella
2019-11-20 18:10:19 -08:00
138ccbb022
bpo-38738: Fix formatting of True and False. (GH-17083)
...
* "Return true/false" is replaced with "Return ``True``/``False``"
if the function actually returns a bool.
* Fixed formatting of some True and False literals (now in monospace).
* Replaced "True/False" with "true/false" if it can be not only bool.
* Replaced some 1/0 with True/False if it corresponds the code.
* "Returns <bool>" is replaced with "Return <bool>".
2019-11-12 16:57:03 +02:00
e471e72977
bpo-37330: open() no longer accept 'U' in file mode (GH-16959)
...
open(), io.open(), codecs.open() and fileinput.FileInput no longer
accept "U" ("universal newline") in the file mode. This flag was
deprecated since Python 3.3.
2019-10-28 15:40:08 +01:00
15ccc4fac0
bpo-38255: super() can search attributes as well as methods (GH-16368)
...
Improvement suggested by Géry Ogam.
2019-09-25 08:13:19 -07:00
87d6cd3604
bpo-38237: Make pow's arguments have more descriptive names and be keyword passable (GH-16302)
...
Edit: `math.pow` changes removed on Mark's request.
https://bugs.python.org/issue38237
Automerge-Triggered-By: @rhettinger
2019-09-20 21:28:49 -07:00
7a0023e8d1
bpo-25810: Clarify eval() docs, it does not keywords (GH-15173)
2019-09-11 05:30:04 -05:00
05184515f9
Correct minor grammatical mistake in open docs (GH-15865)
2019-09-10 15:48:05 +01:00
c1d8c1cb8e
Note regarding + mode truncation applies to both text and binary mode ( #11314 )
...
* Improve doc on open's mode +
* Improve wording
* Address comment from Rémi
2019-09-10 14:04:22 +01:00
cd81f0500f
bpo-23674: Clarify ambiguities in super() docs ( #15564 )
2019-08-29 00:44:02 -07:00
805f8f9afe
bpo-19072: Make @classmethod support chained decorators (GH-8405)
2019-08-24 15:37:25 -07:00
610a4823cc
bpo-37646: Document that eval() cannot access nested scopes (GH-15117)
2019-08-06 17:56:22 -07:00
44f91c388a
bpo-37390: Add audit event table to documentations (GH-14406)
...
Also updates some (unreleased) event names to be consistent with the others.
2019-06-27 10:47:59 -07:00
60419a7e96
bpo-37363: Add audit events for a range of modules (GH-14301)
2019-06-24 08:42:54 -07:00
c4c421d619
bpo-37134: Use PEP570 syntax for sum() (GH-13851)
2019-06-06 00:11:46 +01:00
c52996785a
bpo-36027: Extend three-argument pow to negative second argument (GH-13266)
2019-06-02 10:24:06 +01:00
bdbad71b9d
bpo-20092. Use __index__ in constructors of int, float and complex. (GH-13108)
2019-06-02 00:05:48 +03:00
059b9ea5ac
bpo-31968: Documentation -- add clarification on the globals dict for exec() (GH-13140)
2019-06-01 08:51:58 -07:00
b82e17e626
bpo-36842: Implement PEP 578 (GH-12613)
...
Adds sys.audit, sys.addaudithook, io.open_code, and associated C APIs.
2019-05-23 08:45:22 -07:00
565b4f1ac7
bpo-34616: Add PyCF_ALLOW_TOP_LEVEL_AWAIT to allow top-level await (GH-13148)
...
Co-Authored-By: Yury Selivanov <yury@magic.io>
2019-05-21 16:12:02 -04:00
1c5fa5af8a
bpo-32413: Add documentation that at the module level, locals(), globals() are the same dictionary (GH-5004)
...
https://bugs.python.org/issue32413
2019-04-02 10:58:50 -07:00
548cb6060a
bpo-34085: Improve wording on classmethod/staticmethod ( #8228 )
...
* bpo-34085: Improve wording on classmethod/staticmethod
* Address comments from Éric
* Address comments from Éric
2019-03-25 18:53:43 -04:00
Nikita Sobolev