Julien Palard
3c4cbd177f
gh-91485: Doc: Using Python syntax to document builtin Python functions. (GH-96579)
2022-10-15 12:19:35 +02:00
Stanley
4a74e6ab38
gh-64921: Clarify wording for open()'s newline arg ( #96171 )
2022-10-07 11:12:08 -07:00
Jeff Allen
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
Gregory P. Smith
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
Gregory P. Smith
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
Dong-hee Na
0319cd6825
gh-96197: Define the behavior of repr if sys.displayhook is lost (gh-96242)
2022-08-26 11:02:57 +09:00
Dong-hee Na
47d406ffc4
gh-96197: Fix expression when :func:`sys.breakpointhook is missing (gh-96293)
2022-08-26 10:43:02 +09:00
Dong-hee Na
09563a764e
gh-96197: Define the behavior of breakpoint if sys.breakpointhook is lost (gh-96231)
2022-08-24 23:03:36 +09:00
Adam Turner
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 5c1f15b4b1
* Revert "bpo-42579: Make workaround for various versions of Sphinx more robust (GH-23662)"
This reverts commit b63a620014
.
2022-06-21 17:04:46 +02:00
Serhiy Storchaka
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
Rafael Fontenelle
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
larryhastings
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
Raymond Hettinger
ebaf0945f9
GH-89519: Deprecate classmethod descriptor chaining ( #92379 )
2022-05-06 02:57:53 -05:00
slateny
1066ecb970
gh-81488: Add recursive wording for issubclass docs ( #92087 )
2022-04-30 22:05:20 -06:00
Yurii Karabas
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
Inada Naoki
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
slateny
5101d97d0b
bpo-30718: Add information about text buffering (GH-32351)
2022-04-20 17:24:53 +09:00
Zackery Spytz
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
Nikita Sobolev
b9d8980d89
bpo-43698: do not use `...` as argument name in docs (GH-30502)
2022-01-26 19:06:10 +09:00
Vivek Vashist
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
180909
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
Brett Cannon
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
Andre Delfino
48824fa1e2
[doc] Link to section File input (GH-28941)
2021-11-02 22:34:00 +01:00
Mark Dickinson
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
Serhiy Storchaka
4f05f15d7b
[docs] Improve the markup of powers (GH-28598)
2021-09-28 22:40:57 +02:00
Raymond Hettinger
9a0dcc5b2e
bpo-45246: Document that sorted() only uses "<" comparisons (GH-28494)
2021-09-21 12:26:27 -05:00
Victor Stinner
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
Ken Jin
9a7ec2fcde
bpo-44135: [docs] Fix inline markup (GH-28095)
2021-08-31 18:01:17 +02:00
Zack Kneupper
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
meowmeowmeowcat
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
Mariusz Felisiak
d18e5dae91
bpo-20408: Fix memoryview() signature in docs (GH-24431)
2021-05-25 17:24:30 +03:00
Andre Delfino
69a733bda3
[doc] Be more clear on super() regarding multiple base classes methods (GH-21789)
2021-04-28 18:12:15 -07:00
Géry Ogam
d35eef3b90
Update Sphinx directive for super from function to class (GH-25489)
2021-04-20 11:58:02 -07:00
Victor Stinner
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
Victor Stinner
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
Pablo Galindo
d9692027f4
bpo-31861: Complete the C-API docs for PyObject_GetAiter and PyAiter_Check (GH-25004)
2021-03-23 23:57:03 +00:00
Joshua Bronson
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
Erik Soma
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
Ken Jin
5f77dee056
Improve docs of PEP 604 Union ( #24301 )
2021-02-08 17:57:11 -08:00
Terry Jan Reedy
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
Ken Jin
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
Julien Palard
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
Andre Delfino
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
Antoine
fc3dca3e16
Clarify eval() doc from library/functions. (GH-22700)
2020-12-16 16:45:19 +01:00
Rafael Fontenelle
b76a840021
bpo-42180: fix plural in arguments and control (GH-23015)
...
https://bugs.python.org/issue42180
2020-10-29 20:48:21 +00:00
Antoine
0f25c231b3
Add a link to buffer protocol in bytearray() doc (GH-22675)
2020-10-26 14:26:34 +09:00
Saiyang Gou
3f7e990fd4
bpo-41192: Add documentation of undocumented audit events (GH-21308)
2020-10-20 15:23:15 -04:00
Batuhan Taskaya
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