Commit graph

27516 commits

Author SHA1 Message Date
Miss Islington (bot)
c784b3e8fc
[3.12] gh-85453: Make numeric literals consistent across datetime.rst (GH-118245) (#118248)
Remove code formatting from remaining numeric literals.
(cherry picked from commit 59a4d52973)

Co-authored-by: edson duarte <eduarte.uatach@gmail.com>
2024-04-24 20:27:19 +00:00
Miss Islington (bot)
0049e2bd38
[3.12] gh-85453: Adapt datetime.rst to devguide recommendations for code snippets and variables (GH-118068) (#118244)
Also remove formatting from numeric literals.

(cherry picked from commit 809aa9a682)

Co-authored-by: edson duarte <eduarte.uatach@gmail.com>
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
Co-authored-by: Erlend E. Aasland <erlend@python.org>
2024-04-24 20:02:53 +00:00
Miss Islington (bot)
0691bd860d
[3.12] gh-118013: Use weakrefs for the cache key in inspect._shadowed_dict (GH-118202) (#118232)
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2024-04-24 15:27:08 +00:00
Petr Viktorin
f86b17ac51
[3.12] gh-113171: gh-65056: Fix "private" (non-global) IP address ranges (GH-113179) (GH-113186) (GH-118177)
* GH-113171: Fix "private" (non-global) IP address ranges (GH-113179)

The _private_networks variables, used by various is_private
implementations, were missing some ranges and at the same time had
overly strict ranges (where there are more specific ranges considered
globally reachable by the IANA registries).

This patch updates the ranges with what was missing or otherwise
incorrect.

100.64.0.0/10 is left alone, for now, as it's been made special in [1].

The _address_exclude_many() call returns 8 networks for IPv4, 121
networks for IPv6.

[1] https://github.com/python/cpython/issues/61602

* GH-65056: Improve the IP address' is_global/is_private documentation (GH-113186)

It wasn't clear what the semantics of is_global/is_private are and, when
one gets to the bottom of it, it's not quite so simple (hence the
exceptions listed).

(cherry picked from commit 2a4cbf17af)
(cherry picked from commit 40d75c2b7f)

---------

Co-authored-by: Jakub Stasiak <jakub@stasiak.at>
2024-04-24 14:29:30 +02:00
Miss Islington (bot)
4d34b7f201
[3.12] Fix typo in py_compile.rst (GH-118102) (GH-118191)
(cherry picked from commit 0d221e9a19)

Co-authored-by: Animesh Kumar <animesh0721@gmail.com>
2024-04-23 17:22:19 +00:00
Miss Islington (bot)
fbe29e639d
[3.12] gh-59215: unittest: restore _top_level_dir at end of discovery (GH-15242) (GH-117508)
* gh-59215: unittest: restore _top_level_dir at end of discovery (GH-15242)
(cherry picked from commit fc5f68e58e)


Co-authored-by: Zackery Spytz <zspytz@gmail.com>
Co-authored-by: Petr Viktorin <encukou@gmail.com>
2024-04-23 12:41:32 +00:00
Miss Islington (bot)
c869f4ed5c
[3.12] gh-118030: Group definitions for ParamSpecArgs and ParamSpecKwargs in typing.rst (GH-118154) (#118155)
Co-authored-by: Nice Zombies <nineteendo19d0@gmail.com>
2024-04-22 15:04:11 +00:00
Miss Islington (bot)
b1e5f2746d
[3.12] gh-115986 Improve pprint documentation accuracy (GH-117403) (#118146)
(cherry picked from commit ceb6038b05)

Co-authored-by: Kerim Kabirov <the.privat33r+gh@pm.me>
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2024-04-22 10:34:48 +00:00
Miss Islington (bot)
6d87cb494b
[3.12] Docs: replace Harry Potter reference with Monty Python (GH-118130) (#118135)
Docs: replace Harry Potter reference with Monty Python (GH-118130)
(cherry picked from commit 1446024124)

Co-authored-by: Clément Robert <cr52@protonmail.com>
2024-04-21 18:10:15 +00:00
Miss Islington (bot)
4d85f0ae76
[3.12] Clarifying nonlocal doc: SyntaxError is raised if nearest enclosing scope is global (GH-114009) (#118128)
Clarifying nonlocal doc: SyntaxError is raised if nearest enclosing scope is global (GH-114009)
(cherry picked from commit 1558d99316)

Co-authored-by: Quazi Irfan <quazirfan@gmail.com>
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2024-04-21 01:50:01 +00:00
Miss Islington (bot)
ecb8e2bdac
[3.12] gh-118100: Improve links in ast.rst (GH-118101) (#118110)
gh-118100: Improve links in `ast.rst` (GH-118101)
(cherry picked from commit 2aa11cca11)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
2024-04-19 18:34:55 +00:00
Alex Waygood
5430f61437
[3.12] gh-114053: Fix bad interaction of PEP-695, PEP-563 and `get_type_hints` (#118009) (#118104)
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2024-04-19 13:41:28 +00:00
Miss Islington (bot)
26c659ecbd
[3.12] gh-87969: Align docs and docstrings with implementation for ctypes' [w]string_at() (GH-25384) (GH-118046)
gh-87969: Align docs and docstrings with implementation for ctypes' [w]string_at() (GH-25384)

The implementation uses 'ptr' for the name of the first parameter of
ctypes.string_at() and ctypes.wstring_at(). Align docs and docstrings
with the naming used in the implementation.

(cherry picked from commit 81a926bd20)

Co-authored-by: Shreyan Avigyan <shreyan.avigyan@gmail.com>
Co-authored-by: Irit Katriel <1055913+iritkatriel@users.noreply.github.com>
Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
2024-04-19 13:23:26 +02:00
Miss Islington (bot)
f278b8fefc
[3.12] gh-116935: Document that heap types need to support garbage collection (GH-118021) (GH-118092)
gh-116935: Document that heap types need to support garbage collection (GH-118021)
(cherry picked from commit 5d54436574)

Co-authored-by: Savannah Ostrowski <savannahostrowski@gmail.com>
2024-04-19 11:44:19 +02:00
Miss Islington (bot)
15be34ade8
[3.12] gh-117518: Clarify PyTuple_GetItem() borrowed reference in the doc (GH-117920) (#118087)
gh-117518: Clarify PyTuple_GetItem() borrowed reference in the doc (GH-117920)
(cherry picked from commit 4605a197bd)

Co-authored-by: Victor Stinner <vstinner@python.org>
2024-04-19 10:57:51 +02:00
Miss Islington (bot)
a0f82dd6cc
[3.12] gh-64588: Clarify the difference between mu and xbar in statistics docs (GH-117333) (#118080)
gh-64588: Clarify the difference between mu and xbar in statistics docs (GH-117333)

Thanks Davin Potts for the clarification idea.
(cherry picked from commit fefd5d9711)

Co-authored-by: Mariusz Felisiak <felisiak.mariusz@gmail.com>
2024-04-19 05:42:35 +00:00
Miss Islington (bot)
632f353d9e
[3.12] Use "Contributed by" in a couple of occurrences of 3.12 whatsnew (GH-118070) (#118078)
Use "Contributed by" in a couple of occurrences of 3.12 whatsnew (GH-118070)
(cherry picked from commit 398abdd6fa)

Co-authored-by: Rafael Fontenelle <rffontenelle@users.noreply.github.com>
2024-04-19 03:34:56 +00:00
Miss Islington (bot)
aa2fc81ea3
[3.12] Doc: Render version/language selector on Read the Docs (GH-116966) (#118038)
Co-authored-by: Manuel Kaufmann <humitos@gmail.com>
2024-04-18 11:40:05 +00:00
Miss Islington (bot)
5af8fcaf05
[3.12] gh-116932: Add note on how to report python documentation theme bugs (GH-117989) (GH-118031)
gh-116932: Add note on how to report python documentation theme bugs (GH-117989)
(cherry picked from commit 468b9aeb92)

Co-authored-by: lyc8503 <me@lyc8503.site>
2024-04-18 08:52:09 +00:00
Miss Islington (bot)
859fdee0b6
[3.12] gh-114539: Clarify implicit launching of shells by subprocess (GH-117996) (#118002)
gh-114539: Clarify implicit launching of shells by subprocess (GH-117996)
(cherry picked from commit a4b44d39cd)

Co-authored-by: Steve Dower <steve.dower@python.org>
2024-04-17 19:44:38 +01:00
Miss Islington (bot)
e95a535ea2
[3.12] gh-117977: Amend version changed annotation for os.chmod, os.chown, and os.listdir (GH-117978) (#117992)
(cherry picked from commit fccedbda93)

Co-authored-by: Nice Zombies <nineteendo19d0@gmail.com>
2024-04-17 15:05:35 +00:00
Miss Islington (bot)
ac48fdeb0d
[3.12] gh-73231: Update documentation for PyErr_SetFromWindowsErr() (GH-117226) (GH-117973)
(cherry picked from commit 438b7c3071)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2024-04-17 10:28:55 +00:00
Miss Islington (bot)
5f4c7cf3f4
[3.12] gh-117945: Fix os.path.ismount() documentation (GH-117947) (#117952)
gh-117945: Fix `os.path.ismount()` documentation (GH-117947)
(cherry picked from commit a23fa3368e)

Co-authored-by: Nice Zombies <nineteendo19d0@gmail.com>
2024-04-16 23:02:13 +00:00
Miss Islington (bot)
67dc68141a
[3.12] Docs: Add classes to C API return value annotations (GH-117926) (#117937)
Docs: Add classes to C API return value annotations (GH-117926)
(cherry picked from commit 3284b84c43)

Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
2024-04-16 19:29:52 +03:00
Miss Islington (bot)
556fb3675c
[3.12] gh-117804: Document how to suppress PGO unprofiled source warnings (GH-117859) (#117912)
(cherry picked from commit 757891ee8a)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
2024-04-15 21:24:35 +00:00
Hugo van Kemenade
eb0bfb5910
[3.12] Docs: add link roles with Sphinx extlinks (GH-117850) (#117910)
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2024-04-15 13:18:21 -06:00
Miss Islington (bot)
6dfb7e1f27
[3.12] Docs: make the whatsnew-typing-py312 anchor point to things that were new in the typing module (GH-117904) (#117905)
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2024-04-15 16:55:04 +00:00
Serhiy Storchaka
3e5109682b
[3.12] gh-115664: Reorganize versionadded directives for -X options (GH-116304) (GH-117900)
Add the versionadded directives just under the description of the
corresponding option.
(cherry picked from commit 10f1a2687a)
2024-04-15 15:15:43 +00:00
Nice Zombies
2dcb267324
[3.12] gh-117114: Update os.path function availability and link to genericpath.py in os.path.rst (GH-117756) 2024-04-15 15:49:44 +01:00
Hugo van Kemenade
a844e83b06
[3.12] Add 'The Python 2.3 Method Resolution Order' (GH-116435) (#117885)
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
2024-04-15 14:14:16 +03:00
Miss Islington (bot)
a00dd31ee7
[3.12] Doc: mark up classes, attributes, parameters, and methods in dataclasses.rst (GH-117820) (#117877)
(cherry picked from commit e01831760e)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
2024-04-14 17:00:00 +00:00
Miss Islington (bot)
1bf2d4be7e
[3.12] Tweak wording for dataclasses.replace (gh-117758) (#117876)
(cherry picked from commit e7cce2a9c6)

Co-authored-by: Gouvernathor <44340603+Gouvernathor@users.noreply.github.com>
2024-04-14 16:52:44 +00:00
Miss Islington (bot)
b6cb36574d
[3.12] dataclasses docs: add some link anchors (GH-117601) (#117863)
dataclasses docs: add some link anchors (GH-117601)
(cherry picked from commit c99d374fc7)

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2024-04-14 08:10:07 +00:00
Miss Islington (bot)
efeb8a24b8
[3.12] Simpler example of shallow dict export of a dataclass (GH-117812) (#117862)
Simpler example of shallow dict export of a dataclass (GH-117812)
(cherry picked from commit f303651b45)

Co-authored-by: Gouvernathor <44340603+Gouvernathor@users.noreply.github.com>
2024-04-14 00:22:35 +00:00
Miss Islington (bot)
222d16a18c
[3.12] gh-117840: Fix indent to fix shlex syntax highlighting (GH-117843) (#117844)
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
2024-04-13 11:37:32 +00:00
Miss Islington (bot)
14cdb0d7a5
[3.12] gh-114466: explicitly define heap invariant (GH-117778) (#117835)
I think the choice of wording in these docs is great and doesn't
need to change. However, it could be useful to explicitly define
this term / the cost of doing so seems relatively low.
(cherry picked from commit 37a4cbd872)

Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
2024-04-13 07:11:49 +00:00
Hugo van Kemenade
aeb4ac7441
[3.12] Fix version directive indents (GH-117719) (#117810) 2024-04-12 10:41:25 +00:00
Miss Islington (bot)
84fb531fc2
[3.12] gh-104269: Document glob.glob duplicates when using multiple ** patterns (GH-105406) (#117757)
gh-104269: Document `glob.glob` duplicates when using multiple `**` patterns (GH-105406)
(cherry picked from commit c06be6bbb8)

Co-authored-by: Tomas R <tomas.roun8@gmail.com>
2024-04-11 18:44:46 +01:00
Miss Islington (bot)
a3f1e980c3
[3.12] gh-101549: fix documentation of xml.etree.ElementInclude (GH-101550) (#117754)
Co-authored-by: Mikhail B <55960560+mbel0@users.noreply.github.com>
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
2024-04-11 14:53:27 +00:00
Miss Islington (bot)
a4541a6080
[3.12] Fix markup of win32_ver in platform.rst (GH-116492) (#117753)
Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
2024-04-11 14:20:29 +00:00
Miss Islington (bot)
559b25fcc8
[3.12] gh-117360: Clearer wording in os.path.lexists() docs (GH-117679) (#117701)
(cherry picked from commit 73906d5c90)

Co-authored-by: Nice Zombies <nineteendo19d0@gmail.com>
Co-authored-by: Zachary Ware <zach@python.org>
2024-04-09 21:11:07 +00:00
Miss Islington (bot)
e46fd7257a
[3.12] gh-117597: Clarify exception handling in the tutorial (GH-117681) (#117700)
(cherry picked from commit a05068db0c)

Co-authored-by: Nice Zombies <nineteendo19d0@gmail.com>
2024-04-09 21:06:35 +00:00
Miss Islington (bot)
ced359855e
[3.12] gh-111726: Explicitly close database connections in sqlite3 doctests (GH-111730) (#117630)
(cherry picked from commit a7702663e3)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
Co-authored-by: Erlend E. Aasland <erlend@python.org>
2024-04-08 11:59:02 +02:00
Alex Waygood
3734bee764
[3.12] Fix reference in code.rs (#117615) (#117628)
Co-authored-by: Anita Hammer <166057949+anitahammer@users.noreply.github.com>
Fix reference in code.rst (#117615)
2024-04-08 09:18:44 +00:00
Miss Islington (bot)
7374d65376
[3.12] gh-111726: Remove some doctests from sqlite3 docs (GH-117623) (#117625)
* remove load extension doctest since we cannot skip it conditionally
* remove sys.unraisablehook example; using unraisable hooks is not "an
  improved debug experience"

(cherry picked from commit e338e1a4ec)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
2024-04-08 08:18:55 +00:00
Miss Islington (bot)
e9a49c273e
[3.12] gh-111726: Cleanup test files after running sqlite3 doctest (GH-117604) (#117622)
Remove all temporary databases in a dedicated 'testcleanup' step
at the end of the file.
(cherry picked from commit a453f5ef9d)

Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
2024-04-08 06:42:42 +00:00
Miss Islington (bot)
558b517bb5
[3.12] gh-117074: Update Traversable.joinpath docs to the 3.11+ protocol (GH-117113) (GH-117571)
gh-117074: Update Traversable.joinpath docs to the 3.11+ protocol (GH-117113)
(cherry picked from commit e569f9132b)

Co-authored-by: Petr Viktorin <encukou@gmail.com>
2024-04-05 17:33:52 +02:00
Miss Islington (bot)
663e7bc2ee
[3.12] [doc] Update logging documentation to improve grammar and elucidate an example. (GH-117541) (GH-117542)
(cherry picked from commit df912c913a)
2024-04-04 14:19:10 +01:00
Miss Islington (bot)
52f1fb6f7d
[3.12] Link to the Python type system specification (GH-117400) (#117448)
Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
2024-04-02 09:29:10 +00:00
Miss Islington (bot)
a4a8af07cf
[3.12] Docs: specify XML document name in xml.etree.elementtree example (GH-24223) (#117429)
(cherry picked from commit 9dae05ee59)

Co-authored-by: Moshe Kaplan <mosheekaplan@gmail.com>
2024-04-01 22:02:34 +02:00