Commit graph

26918 commits

Author SHA1 Message Date
Miss Islington (bot)
70a378c888
[3.12] gh-105563: reference DateType in datetime's documentation (GH-105946) (#108789)
gh-105563: reference DateType in datetime's documentation (GH-105946)
(cherry picked from commit 8f9ea43ee8)

Co-authored-by: TATHAGATA ROY <royzen9495@gmail.com>
2023-09-02 23:44:06 +02:00
Serhiy Storchaka
246cb64984
[3.12] Improve some C API documentation (GH-108768) (#108785)
* Express functions which take argument as a C string in terms of
  functions which take Python object.
* Use "note" directive for PyMapping_HasKey() and
  PyMapping_HasKeyString() notes..
(cherry picked from commit 6f97eeec22)
2023-09-02 23:43:41 +02:00
Hugo van Kemenade
f58617a3bc
[3.12] gh-101100: Fix sphinx warnings in tutorial/appendix.rst (GH-108750) (#108759)
(cherry picked from commit 3047f09490)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
2023-09-02 23:42:40 +02:00
Miss Islington (bot)
712994e1ab
[3.12] gh-101100: Fix sphinx warnings in tutorial/classes.rst (GH-108746) (#108756)
gh-101100: Fix sphinx warnings in `tutorial/classes.rst` (GH-108746)
(cherry picked from commit e775601ef1)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
2023-09-01 15:33:36 +02:00
Miss Islington (bot)
1e15c1501c
[3.12] ast docs: Fix incorrect link on keyword (GH-108728) (#108737)
`ast` docs: Fix incorrect link on `keyword` (GH-108728)

In two places, Sphinx was erroneously adding links to the `keyword` module instead of the `ast.keyword` class
(cherry picked from commit c1e2f3b2f7)

Co-authored-by: Alex Povel <git@alexpovel.de>
2023-09-01 15:32:13 +02:00
Miss Islington (bot)
8c3793a539
[3.12] gh-108682: [Enum] raise TypeError if super().__new__ called in custom __new__ (GH-108704) (#108733)
gh-108682: [Enum] raise TypeError if super().__new__ called in custom __new__ (GH-108704)

When overriding the `__new__` method of an enum, the underlying data type should be created directly; i.e. .

    member = object.__new__(cls)
    member = int.__new__(cls, value)
    member = str.__new__(cls, value)

Calling `super().__new__()` finds the lookup version of `Enum.__new__`, and will now raise an exception when detected.
(cherry picked from commit d48760b2f1)

Co-authored-by: Ethan Furman <ethan@stoneleaf.us>
2023-09-01 00:04:55 +02:00
Miss Islington (bot)
a92c60c99b
[3.12] gh-97850: Note in py312 whatsnew that importlib.util.set_loader and importlib.util.module_for_loader have been removed (GH-108719) (#108723)
gh-97850: Note in py312 whatsnew that `importlib.util.set_loader` and `importlib.util.module_for_loader` have been removed (GH-108719)

Note in py312 whatsnew that `importlib.util.set_loader` and `importlib.util.module_for_loader` have been removed
(cherry picked from commit 013a99a47b)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-09-01 00:03:02 +02:00
Miss Islington (bot)
bc42d6c604
[3.12] gh-101100: Fix sphinx warnings in threading.rst (GH-108684) (#108707)
gh-101100: Fix sphinx warnings in `threading.rst` (GH-108684)
(cherry picked from commit 991e4e76b5)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-08-31 15:32:39 +02:00
Miss Islington (bot)
420db1027b
[3.12] gh-101100: Fix Sphinx warnings in the Logging Cookbook (GH-108678) (#108680)
gh-101100: Fix Sphinx warnings in the Logging Cookbook (GH-108678)
(cherry picked from commit c7cef54631)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-08-30 15:21:58 +02:00
Miss Islington (bot)
2e60d58fff
[3.12] Fix typo in multiprocessing docs (GH-108666) (#108677)
Fix typo in multiprocessing docs (GH-108666)
(cherry picked from commit 38ab0dba80)

Co-authored-by: kato8966 <66937409+kato8966@users.noreply.github.com>
2023-08-30 15:21:32 +02:00
Miss Islington (bot)
ecabf1e19f
[3.12] gh-108669: unittest: Fix documentation for TestResult.collectedDurations (GH-108670) (#108672)
gh-108669: unittest: Fix documentation for TestResult.collectedDurations (GH-108670)
(cherry picked from commit 6c484c39be)

Co-authored-by: Sebastian Rittau <srittau@rittau.biz>
2023-08-30 15:21:05 +02:00
Miss Islington (bot)
1d6d05aa82
[3.12] Mention Ellipsis pickling in the docs (GH-103660) (#108661)
Mention Ellipsis pickling in the docs (GH-103660)
(cherry picked from commit 14ec0bb7c3)

Co-authored-by: sterliakov <50529348+sterliakov@users.noreply.github.com>
2023-08-30 15:20:45 +02:00
Erlend E. Aasland
036dd6958a
[3.12] gh-107801: Improve the accuracy of io.IOBase.seek docs (#108268) (#108655)
(cherry picked from commit 8178a88bd8)

- Add param docstrings
- Link to os.SEEK_* constants
- Mention the return value in the initial paragraph

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-08-29 22:19:08 +02:00
Miss Islington (bot)
ae9bbd16d8
[3.12] Fix misc doc typos (GH-108592) (#108594)
Fix misc doc typos (GH-108592)
(cherry picked from commit 88f1c5b454)

Co-authored-by: xzmeng <aumo@foxmail.com>
2023-08-29 12:38:03 +02:00
Adam Turner
7c7b2bfb3f
[3.12] GH-108202: Combine documentation of `calendar` constants (GH-108492) (#108579)
[3.12] GH-108202: Combine documentation of ``calendar`` constants (GH-108492).
(cherry picked from commit 5d936b6479)
2023-08-29 00:26:48 +02:00
Miss Islington (bot)
5531d03d99
[3.12] Fix typo in typing docs: Remove redundant backtick (GH-108559) (#108560)
Fix typo in typing docs: Remove redundant backtick (GH-108559)
(cherry picked from commit 72b615ab01)

Co-authored-by: nikkie <takuyafjp+develop@gmail.com>
2023-08-29 00:24:41 +02:00
Erlend E. Aasland
f90099c3bd
[3.12] gh-107801: Document io.TextIOWrapper.tell (#108265) (#108547)
(cherry picked from commit 38afa4af9b)
2023-08-28 01:59:48 +02:00
Miss Islington (bot)
311fd96dae
[3.12] Docs: Resolve Sphinx warnings in dis.rst (GH-108476) (#108546)
Docs: Resolve Sphinx warnings in dis.rst (GH-108476)

- Link to the code objects reference
- Suppress link to deliberately undocumented builtins.__build_class__
- Suppress links for example methods
(cherry picked from commit cb1184280b)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
2023-08-28 01:59:35 +02:00
Miss Islington (bot)
752d5254f5
[3.12] Fix grammatical error in stringprep documentation (GH-108414) (#108537)
Fix grammatical error in stringprep documentation (GH-108414)

Remove the word "them", which didn't make grammatical sense.

(cherry picked from commit cd0a8aece9)

Co-authored-by: Matthew James Kraai <kraai@ftbfs.org>
Co-authored-by: KRAAI, MATTHEW [VISUS] <mkraai@its.jnj.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-08-27 17:00:07 +02:00
Miss Islington (bot)
0b0238d6a1
[3.12] gh-105052:update timeit function's description (GH-105060) (#108534)
gh-105052:update timeit function's description (GH-105060)

---------

(cherry picked from commit 7096a2be33)

Co-authored-by: R <cherrymelon@foxmail.com>
2023-08-27 16:15:01 +02:00
Miss Islington (bot)
387cb9f324
[3.12] gh-107453: Document errno.{ECANCELED,EOWNERDEAD,ENOTRECOVERABLE,ENOTSUP} (GH-107486) (#108529)
gh-107453: Document errno.{ECANCELED,EOWNERDEAD,ENOTRECOVERABLE,ENOTSUP} (GH-107486)
(cherry picked from commit 1ac64237e6)

Co-authored-by: qqwqqw689 <114795525+qqwqqw689@users.noreply.github.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-08-27 16:13:26 +02:00
Miss Islington (bot)
208741cc30
[3.12] gh-102211: Document re.{Pattern,Match}’s existence (GH-102212) (#108490)
gh-102211: Document `re.{Pattern,Match}`’s existence (GH-102212)
(cherry picked from commit 6895ddf6cb)

Co-authored-by: Philipp A <flying-sheep@web.de>
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-08-27 01:21:24 +02:00
Miss Islington (bot)
ce37fbc778
[3.12] Docs: Datamodel: Merge "Notes on using __slots__" with the parent section (GH-108400) (#108474)
Docs: Datamodel: Merge "Notes on using __slots__" with the parent section (GH-108400)
(cherry picked from commit 7f5b1a0661)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-08-25 18:23:11 +02:00
Miss Islington (bot)
334da81992
[3.12] Datamodel: Add headings to the standard type hierarchy (GH-108146) (#108477)
Datamodel: Add headings to the standard type hierarchy (GH-108146)

Dedent content according to the new layout.
(cherry picked from commit 2b7bff0655)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-08-25 18:22:45 +02:00
Miss Islington (bot)
c5448ab6d4
[3.12] GH-108202: Document `calendar` exceptions (GH-108398) (#108467)
GH-108202: Document ``calendar`` exceptions (GH-108398)
(cherry picked from commit 135098743a)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-08-25 18:20:38 +02:00
Victor Stinner
9a225d7d5b
[3.12] gh-108314: PyDict_GetItemString() mentions UTF-8 (#108448)
gh-108314: PyDict_GetItemString() mentions UTF-8

PyDict_GetItemString(), PyDict_SetItemString() and
PyDict_DelItemString() expects a UTF-8 encoding string for the key.
2023-08-25 18:19:53 +02:00
Miss Islington (bot)
09487a202f
[3.12] gh-107432 Update Porting Python 2 Code to Python 3 how-to (GH-107434) (#108409)
gh-107432 Update Porting Python 2 Code to Python 3 how-to (GH-107434)

https://docs.python.org/3/howto/pyporting.htmlGH-porting-python-2-code-to-python-3 was written for another time. In this patch:

- material that frames Python 3 as "new" is removed
- descriptions and directions have been trimmed
(cherry picked from commit 809ea7c4b6)

Co-authored-by: Daniele Procida <daniele@vurt.org>
2023-08-24 12:30:57 +02:00
Miss Islington (bot)
b312d4fd7e
[3.12] gh-70766: Mention the object getstate caveat in 3.11 What's new. (GH-108379) (#108384)
gh-70766: Mention the object getstate caveat in 3.11 What's new. (GH-108379)
(cherry picked from commit b6be18812c)

Co-authored-by: Gregory P. Smith <greg@krypto.org>
2023-08-24 01:44:50 +02:00
Miss Islington (bot)
3aa7df6544
[3.12] gh-108267: Dataclasses docs: Fix object.__setattr__ typo (GH-108355) (#108358)
gh-108267: Dataclasses docs: Fix object.__setattr__ typo (GH-108355)

Fixed a sentence in dataclasses.rst

Changed "__setattr__" to "object.__setattr__" in a section that was specifically supposed to refer to the __setattr__ method of the object class. Also suppressed the link to the data model docs for __setattr__, since we're talking about a specific __setattr__ implementation, not __setattr__ methods in general.
(cherry picked from commit 79fdacc005)

Co-authored-by: FrozenBob <30644137+FrozenBob@users.noreply.github.com>
2023-08-23 13:46:03 +02:00
Miss Islington (bot)
314c98d293
[3.12] gh-107136: Remove Plausible for docs metrics (GH-107856) (#108334)
(cherry picked from commit fc23f34cc9)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-08-23 11:01:19 +02:00
Miss Islington (bot)
200af4294e
[3.12] GH-92584: Remove distutils from the newtypes tutorial includes (GH-108024) (#108333)
GH-92584: Remove distutils from the newtypes tutorial includes (GH-108024)
(cherry picked from commit e97b7bef4f)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-08-22 22:07:15 +02:00
Miss Islington (bot)
92cbe739d4
[3.12] Docs: Add link to skip to datetime's format codes (GH-108027) (#108329)
Docs: Add link to skip to datetime's format codes (GH-108027)
(cherry picked from commit 35cb1605d0)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-08-22 22:06:53 +02:00
Miss Islington (bot)
fad80598dc
[3.12] Document 3.13, 3.14 and future removals (GH-108055) (#108331)
(cherry picked from commit 39de79b345)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-08-22 21:38:13 +02:00
Miss Islington (bot)
3cdaa6a794
[3.12] gh-105857: Document that asyncio subprocess std{in,out,err} can be file handles (GH-107986) (#108332)
(cherry picked from commit 13966da71b)

Co-authored-by: Hadházy Tamás <85063808+Hels15@users.noreply.github.com>
2023-08-22 21:37:14 +02:00
Miss Islington (bot)
1dbf11814f
[3.12] gh-107700: [Enum] Document that EnumType was added in 3.11 (GH-108260) (#108301)
(cherry picked from commit e8ef0bdd8c)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
2023-08-22 20:34:56 +02:00
Miss Islington (bot)
68fd6db981
[3.12] Docs: align the param spec of sqlite3.Connection methods with the implementation (GH-108285) (#108287)
Docs: align the param spec of sqlite3.Connection methods with the implementation (GH-108285)

- no parameters of create_aggregate() are positional-only
- all parameters of create_collation() are positional-only
(cherry picked from commit 893215a4e7)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
2023-08-22 16:17:03 +02:00
Miss Islington (bot)
e5d779c0e2
[3.12] gh-107298: Fix numerous ref errors and typos in the C API docs (GH-108258) (#108284)
gh-107298: Fix numerous ref errors and typos in the C API docs (GH-108258)
(cherry picked from commit d7202e4879)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2023-08-22 16:16:31 +02:00
Miss Islington (bot)
a2b680d9e9
[3.12] gh-106971: Docs: Add missing issue reference (GH-106992) (#108283)
gh-106971: Docs: Add missing issue reference (GH-106992)
(cherry picked from commit c556f9a3c9)

Co-authored-by: Junya Fukuda <junya.fukuda.e@gmail.com>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-08-22 16:15:59 +02:00
Erlend E. Aasland
ef4d427fd8
[3.12] gh-107801: Improve the accuracy of io.TextIOWrapper.seek docs (#107933) (#108262)
(cherry picked from commit 7f87ebbc3f)

Clearly document the supported seek() operations:

- Rewind to the start of the stream
- Restore a previous stream position (given by tell())
- Fast-forward to the end of the stream
2023-08-22 12:01:38 +02:00
Serhiy Storchaka
47f60c3f67
[3.12] gh-107298: Fix C API datetime documentation (GH-108034). (#108234)
(cherry picked from commit d63972e289)
2023-08-21 21:44:45 +02:00
Miss Islington (bot)
f51cdfaaac
[3.12] gh-108224: Fix asyncio doc inconsistency (GH-108230) (#108231)
gh-108224: Fix asyncio doc inconsistency (GH-108230)

(Spawning subprocesses does not require the event loop to run in the main thread -- only signal handling does.)
(cherry picked from commit 1cc391d9e2)

Co-authored-by: temach <tematibr@gmail.com>
2023-08-21 21:44:08 +02:00
Miss Islington (bot)
78a2a8c026
[3.12] gh-107298: Fix references to deprecated and removed PyUnicode C API (GH-108077) (#108225)
gh-107298: Fix references to deprecated and removed PyUnicode C API (GH-108077)
(cherry picked from commit db55383829)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2023-08-21 21:43:28 +02:00
Miss Islington (bot)
a27f18a382
[3.12] docs: fix grammar in isolating-extensions.rst (GH-108037) (#108218)
docs: fix grammar in isolating-extensions.rst (GH-108037)
(cherry picked from commit 47022a079e)

Co-authored-by: David Lechner <david@pybricks.com>
2023-08-21 21:40:08 +02:00
Miss Islington (bot)
a909ec399d
[3.12] gh-107845: Fix symlink handling for tarfile.data_filter (GH-107846) (#108211)
gh-107845: Fix symlink handling for tarfile.data_filter (GH-107846)

(cherry picked from commit acbd3f9c5c)

Co-authored-by: Petr Viktorin <encukou@gmail.com>
Co-authored-by: Victor Stinner <vstinner@python.org>
Co-authored-by: Lumír 'Frenzy' Balhar <frenzy.madness@gmail.com>
2023-08-21 15:31:40 +02:00
Miss Islington (bot)
f798a6360b
[3.12] Improve references in the tutorial (GH-108069) (#108203)
Improve references in the tutorial (GH-108069)

* Use full qualified names for references (even if they do not work now,
  they will work in future).
* Silence references to examples.
(cherry picked from commit 622ddc4167)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2023-08-21 13:20:21 +02:00
Miss Islington (bot)
9cd15cab77
[3.12] Docs: document 'manager' and '_log' attrs of logging.Logging (GH-108145) (#108190)
Docs: document 'manager' and '_log' attrs of logging.Logging (GH-108145)
(cherry picked from commit f904aa4e1f)


Authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>

Co-authored-by: Erlend E. Aasland <erlend@python.org>
2023-08-21 13:16:53 +02:00
Miss Islington (bot)
f2cc00527e
[3.12] Resolve reference warnings in faq/library.rst (GH-108149) (#108182)
Resolve reference warnings in faq/library.rst (GH-108149)
(cherry picked from commit 6323bc33ff)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-08-20 23:09:18 +02:00
Miss Islington (bot)
a6f15af866
[3.12] Resolve reference warnings in faq/design.rst (GH-108148) (#108180)
Resolve reference warnings in faq/design.rst (GH-108148)
(cherry picked from commit 92815cc7cf)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-08-20 23:08:57 +02:00
Erlend E. Aasland
399825ed26
[3.12] Docs: Fix Sphinx warnings in sys.rst (#108106) (#108178)
(cherry picked from commit 29fa7afef9)

- Mark up named tuple attributes as attributes
- Remove links for external functions
- io.BufferedIOBase has no 'buffer' attribute;
  remove the link and mark up using :attr:`!buffer`
- (Re)format some tables as bullet lists:
  - sys._emscripten_info
  - sys.hash_info
  - sys.int_info
  - sys.thread_info
- In the paragraphs mentioning 'f_trace_lines' and 'f_trace_opcodes',
  add links to the frame objects reference.

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-08-20 23:08:39 +02:00
Erlend E. Aasland
fa6cd7f43f
[3.12] Docs: Fix Sphinx warnings in logging.rst (GH-108139) (#108174)
(cherry picked from commit c735e79afb)

Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
2023-08-20 23:08:16 +02:00