Commit graph

23895 commits

Author SHA1 Message Date
Miss Islington (bot)
031e2bb332
bpo-33381: [doc] strftime's %f option may pad zeros on the left or the right (GH-29801) (GH-29863)
(cherry picked from commit f97ec09baf)

Co-authored-by: Vishal Pandey <vishalpandeyviptsk@gmail.com>
2021-11-30 11:50:28 +00:00
Miss Islington (bot)
376b24e4f6
bpo-43905: Expand dataclasses.astuple() and asdict() docs (GH-26154)
Expanded ``astuple()`` docs, warning about deepcopy being applied
and providing a workaround.

Automerge-Triggered-By: GH:ericvsmith
(cherry picked from commit c1f93f0d37)

Co-authored-by: andrei kulakov <andrei.avk@gmail.com>
2021-11-29 10:30:38 -08:00
Miss Islington (bot)
da3e9ddde7
[3.9] [Doc] Add info to logging cookbook about running logging socket listeners i… (GH-29838) (GH-29840) 2021-11-29 13:49:20 +00:00
Miss Islington (bot)
151c9bf649
bpo-45693: Document port parameter to loop.create_server (GH-29760) (GH-29763)
Document the `port` parameter to `loop.create_server` in `asyncio`. In
particular, note that if `host` resolves to multiple network interfaces,
passing in `port=0` will result in a different random unused port being
used for each interface.

Automerge-Triggered-By: GH:ericvsmith
(cherry picked from commit d71c7bc733)

Co-authored-by: Jim Crist-Harif <jcristharif@gmail.com>

Co-authored-by: Jim Crist-Harif <jcristharif@gmail.com>
2021-11-24 15:40:09 -05:00
Miss Islington (bot)
e81e1d7f81
[3.9] bpo-45845: Change link for pyserial (GH-29675)
(cherry picked from commit 123a3527dd)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2021-11-20 15:52:07 -05:00
Miss Islington (bot)
d1855ed752
bpo-44844: Remove unresponsive web link (GH-29651)
Threading notes by Aahz from OSCON 2001.
(cherry picked from commit 9852339145)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2021-11-20 10:44:04 -08:00
Miss Islington (bot)
e88f9787ab
bpo-45846: Fix capitalisation of Van Rossum at the start of sentence (GH-29641) (GH-29657)
(cherry picked from commit bc2bc0dbdb)

Co-authored-by: JMcB <joel.mcbride1@live.com>
2021-11-20 16:57:37 +01:00
Miss Islington (bot)
c06c7c489a
[3.9] bpo-45788: Link sys.prefix doc to 'Installation paths' (GH-29606) (GH-29632)
... To the Installation paths section of the sysconfig doc.
(cherry picked from commit 4575c01b75)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2021-11-18 16:45:15 -05:00
Miss Islington (bot)
591bf41609
[3.9] [doc] bpo-45680: Disambiguate `__getitem__ and __class_getitem__` in the data model (GH-29389) (GH-29619)
The documentation explaining Python's data model does not adequately explain
the differences between ``__getitem__`` and ``__class_getitem__``, nor does it
explain when each is called. There is an attempt at explaining
``__class_getitem__`` in the documentation for ``GenericAlias`` objects, but
this does not give sufficient clarity into how the method works. Moreover, it
is the wrong place for that information to be found; the explanation of
``__class_getitem__`` should be in the documentation explaining the data model.

This PR has been split off from GH-29335.
(cherry picked from commit 31b3a70edb)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
2021-11-18 18:41:09 +01:00
Ethan Furman
feccea6a7e
[3.9] [Enum] update member.member removal (GH-29611)
Accessing one enum member from another originally raised an `AttributeError`, but became possible due to a performance boost implementation detail.  In 3.11 it will again raise an `AttributeError`.
2021-11-18 00:50:42 -08:00
Miss Islington (bot)
17f5c5cad3
[docs] Add missing word "any" in unittest -k cmdline option description (GH-29571) (GH-29604)
(cherry picked from commit abc0d754c3)

Co-authored-by: ch33zer <ch33zer@gmail.com>
2021-11-18 01:26:12 +01:00
Miss Islington (bot)
fd206b6807
[3.9] Save a reference for ensure_future and create_task (GH-29163) (GH-29573)
Co-authored-by: Joannah Nanjekye <jnanjekye@python.org>
(cherry picked from commit c750adbe69)


Co-authored-by: Joannah Nanjekye <33177550+nanjekyejoannah@users.noreply.github.com>

Automerge-Triggered-By: GH:asvetlov
2021-11-16 03:47:02 -08:00
Miss Islington (bot)
a40d066e8e
bpo-45677: Reword first section of sqlite3 docs (GH-29326) (GH-29567)
* bpo-45677: Avoid addressing the reader as 'you' in sqlite3 docs

* Adjust wording

* Adjust wording again

* Typo

* Update Doc/library/sqlite3.rst

Co-authored-by: Jacob Walls <jacobtylerwalls@gmail.com>

* Address review: adjust wording

* Update Doc/library/sqlite3.rst

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>

* Update Lib/sqlite3/__init__.py

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>

* Update Doc/library/sqlite3.rst

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>

* Update Doc/library/sqlite3.rst

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>

* Update Lib/sqlite3/__init__.py

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>

* Update Doc/library/sqlite3.rst

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>

* Apply Alex' suggestion, and apply 80 char limit to PR

* Minor adjustment

Co-authored-by: Jacob Walls <jacobtylerwalls@gmail.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
(cherry picked from commit 6c5a312fb6)

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@innova.no>

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@innova.no>
2021-11-15 15:32:31 -08:00
Miss Islington (bot)
b0bdc093c2
bpo-25381: Update explanation of exceptions in C. (GH-26838) (GH-29569)
Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>

(cherry picked from commit ad43dc0b54)
2021-11-15 18:07:58 -05:00
Miss Islington (bot)
6073920fcd
bpo-45752: Fix no-support examples in 'copy' docs (GH-29548)
(cherry picked from commit b7360ae395)

Co-authored-by: M. Mostafa Farzan <m2_farzan@yahoo.com>
2021-11-14 01:58:01 -08:00
Miss Islington (bot)
b952f60213
[3.9] bpo-45772: socket.socket should be a class instead of a function (GH-23960) (GH-29543)
* [bpo-45772](): socket.socket should be a class instead of a function

Currently `socket.socket` is documented as a function, but it is really
a class (and thus has function-like usage to construct an object). This
correction would ensure that Python projects that are interlinking
Python's documentation can properly locate `socket.socket` as a type.
(cherry picked from commit 4c792f39e6)


Co-authored-by: Hong Xu <hong@topbug.net>

Automerge-Triggered-By: GH:asvetlov
2021-11-12 22:29:01 -08:00
Miss Islington (bot)
8b6a474071
bpo-45792: Fix contextvar.Token's intersphinx FQN (GH-29533) (GH-29536)
Since `.. module:: contextvars` sets the module using `.. class:: contextvars.Token`, intersphinx records it as `contextvars.contextvars.Token`.
(cherry picked from commit e501d70b34)

Co-authored-by: Hynek Schlawack <hs@ox.cx>

Co-authored-by: Hynek Schlawack <hs@ox.cx>
2021-11-12 12:20:20 +02:00
Miss Islington (bot)
80580f5ab8
bpo-40170: Update What's New in Python 3.9 (GH-29470) (GH-29472)
The PyType_HasFeature() change has been reverted: the static inline
function access directly the PyTypeObject.tp_flags member.
(cherry picked from commit 99c7e9853f)

Co-authored-by: Victor Stinner <vstinner@python.org>
2021-11-08 18:10:41 +01:00
Miss Islington (bot)
643f50ca5e
[doc] bpo-45680: Improve glossary entry for generic types (GH-29388) (GH-29448)
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
(cherry picked from commit 77a2c77c84)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2021-11-06 19:50:18 +01:00
Miss Islington (bot)
a8ae7a5613
bpo-45762: Improve docs for `@singledispatch/@singledispatchmethod` (GH-29426) (GH-29430)
(cherry picked from commit 71e8a3e76a)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2021-11-05 17:52:14 +01:00
Miss Islington (bot)
7e244fc804
Remove reference to `Tuple at top of typing` docs (GH-29401)
``typing.Tuple`` has been deprecated since Python 3.9, so it makes no sense to mention it so prominently in the documentation for the ``typing`` module.
(cherry picked from commit 87032cfa3d)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2021-11-04 05:13:24 -07:00
Miss Islington (bot)
e813dd4d7b
bpo-45680: `typing docs: improve links to docs on GenericAlias/__class_getitem__` (GH-29387)
(cherry picked from commit e03e50377d)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2021-11-03 21:34:31 -07:00
Miss Islington (bot)
3a93c669f5
bpo-45633: Fix newtypes doc typo (GH-29318) (GH-29365)
(cherry picked from commit 454cdb99ab)

Co-authored-by: Dmitry Smirnov <dmitrysmirnov931@gmail.com>
2021-11-03 17:30:59 +08:00
Miss Islington (bot)
d3e7755015
[doc] Link to section File input (GH-28941) (GH-29376)
(cherry picked from commit 48824fa1e2)

Co-authored-by: Andre Delfino <adelfino@gmail.com>
2021-11-02 22:59:42 +01:00
Miss Islington (bot)
4ab6e524ab
bpo-45457: Minor fix to documentation for SSLContext.load_default_certs. (GH-28947) (GH-29374)
Specify that SSLContext.set_default_verify_paths is called on ALL systems.

The code of SSLContext.load_default_certs was changed in bpo-22449 to do this,
this fix corrects the documentation to match that change.
(cherry picked from commit 3551bf16ee)

Co-authored-by: LincolnPuzey <lincoln@puzey.dev>
2021-11-02 22:53:45 +01:00
Miss Islington (bot)
da04bef5f7
[3.9] Move field width to the right field (GH-29344) (GH-29350)
Co-authored-by: Olaf van der Spek <olafvdspek@gmail.com>
2021-10-31 20:25:21 +00:00
Miss Islington (bot)
b04b307e0e
bpo-45516: add protocol description to the Traversable documentation (GH-29039)
* bpo-45516: add protocol description to the Traversable documentation

Signed-off-by: Filipe Laíns <lains@riseup.net>

* Update Doc/library/importlib.rst

Co-authored-by: Jason R. Coombs <jaraco@jaraco.com>

* Update Lib/importlib/abc.py

* Update Doc/library/importlib.rst

Co-authored-by: Jason R. Coombs <jaraco@jaraco.com>

Co-authored-by: Jason R. Coombs <jaraco@jaraco.com>
(cherry picked from commit 4d03de3329)

Co-authored-by: Filipe Laíns <filipe.lains@gmail.com>
2021-10-31 12:27:49 -07:00
Miss Islington (bot)
3ec1124de2
bpo-45600: Enhanced / clarified the docs for os.environ and os.environb (GH-29204) (GH-29321)
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
(cherry picked from commit b17cfd150f)

Co-authored-by: andrei kulakov <andrei.avk@gmail.com>
2021-10-29 22:52:59 +02:00
Miss Islington (bot)
e1560313d4
bpo-45335: Add note to sqlite3 docs about "timestamp" converter (GH-29200) (GH-29320)
(cherry picked from commit 3877fc02f7)

Co-authored-by: Ian Fisher <ian@iafisher.com>
2021-10-29 22:42:38 +02:00
Alex Waygood
8813a987b1
[3.9] bpo-45655: Add "relevant PEPs" section to typing documentation (GH-29297)
Backport of https://github.com/python/cpython/pull/29280 to the 3.9 branch.
2021-10-28 23:17:28 +02:00
Miss Islington (bot)
3767e0d943
bpo-45583: Correct datamodel documentation of int() (GH-29182) (GH-29286)
It should be noted that this part of the documentation is redundant with
function.rst's documentation of int. This one was correctly updated with Python 3.8.
(cherry picked from commit d9c1868c25)

Co-authored-by: Arthur Milchior <arthur@milchior.fr>
2021-10-28 22:17:20 +02:00
Miss Islington (bot)
01d11b1d62
bpo-45604: add level argument to multiprocessing.log_to_stderr func (GH-29226) (GH-29284)
Co-authored-by: blurb-it[bot] <43283697+blurb-it[bot]@users.noreply.github.com>
(cherry picked from commit 1fb968c07a)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
2021-10-28 22:03:32 +02:00
Miss Islington (bot)
020aa06ec8
bpo-45608: Document missing sqlite3 DB-API attributes and methods (GH-29219) (GH-29282)
(cherry picked from commit 88d8a1a340)

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@innova.no>
2021-10-28 21:57:35 +02:00
Miss Islington (bot)
193504acf3
bpo-28737: Document when tp_dealloc should call PyObject_GC_UnTrack() (GH-29246) (GH-29248)
Objects that support garbage collection ("container" objects) should
call PyObject_GC_UnTrack() from their destructors before clearing any
fields which may point to other "container" objects.
(cherry picked from commit 35e1ff38ee)

Co-authored-by: Sam Gross <colesbury@gmail.com>
2021-10-28 21:23:19 +02:00
Ned Deily
30c1f18ee6
[3.9] bpo-45618: Fix documentation build by pinning Docutils version to 0.17.1 (GH-29230) (GH-29241)
Co-authored-by: Maciej Olko <maciej.olko@yougov.com>
Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@innova.no>
2021-10-27 11:04:38 -04:00
Miss Islington (bot)
c53428fe89
bpo-44344: Document that pow can return a complex number for non-complex inputs. (GH-27853) (GH-29134)
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
(cherry picked from commit 887a55705b)

Co-authored-by: Mark Dickinson <mdickinson@enthought.com>
2021-10-22 00:08:36 +02:00
Miss Islington (bot)
b26eae54e9
bpo-41983: add availability info to socket docs (GH-27519) (GH-29137)
* add availability info to AF_PACKET section
* add availability for AF_QIPCRTR as well

(cherry picked from commit 51375388be)

Co-authored-by: andrei kulakov <andrei.avk@gmail.com>
2021-10-22 00:07:38 +02:00
Ethan Furman
e628700dbf
[3.9] bpo-44174: [Enum] add name-mangling reference (GH-29128) 2021-10-21 11:32:18 -07:00
Miss Islington (bot)
bfa4237ecf
bpo-34451: Document prompt and output toggle feature in html tutorial (GH-27105) (GH-29120)
(cherry picked from commit 5a14f71fe8)

Co-authored-by: Thomas <thmsdnnr@gmail.com>
2021-10-21 14:42:10 +02:00
Ethan Furman
9733c9651a
[3.9] bpo-42517: [ENUM] update docs for changes coming in 3.11 (GH-29113) 2021-10-20 16:11:47 -07:00
Miss Islington (bot)
427ab124b3
bpo-45464: [doc] Explain that subclassing multiple exceptions is fragile (GH-29094) (GH-29105)
Co-authored-by: Pablo Galindo Salgado <Pablogsal@gmail.com>
(cherry picked from commit dff0b71343)

Co-authored-by: Łukasz Langa <lukasz@langa.pl>
2021-10-20 20:50:28 +02:00
Łukasz Langa
a18e4e9c15
[3.9] bpo-45449: add note about PEP 585 in collections.abc's documentation (GH-29047) (GH-29068)
Signed-off-by: Filipe Laíns <lains@riseup.net>

Co-authored-by: Łukasz Langa <lukasz@langa.pl>.
(cherry picked from commit 7bafa0cf58)

Co-authored-by: Filipe Laíns <lains@riseup.net>
2021-10-19 20:50:09 +02:00
Miss Islington (bot)
76578884c5
bpo-45515: Add zoneinfo to the datetime documentation (GH-29038) (GH-29066)
We should have done this way back when 3.9 was released, but it fell off
the radar.

Co-authored-by: Paul Ganssle <git@m.ganssle.io>
(cherry picked from commit 8e40ca127f)
2021-10-19 20:35:56 +02:00
Miss Islington (bot)
cb34c1ee1b
Improve multiserver queue recipe (GH-29012) (GH-29014) 2021-10-18 00:24:51 -05:00
Miss Islington (bot)
ac1b7a3319
[3.9]bpo-45463: Clarify that global statements allows multiple names (GH-28851) (GH-28990)
The global statement allows specifying a list of identifiers
(https://docs.python.org/3/reference/simple_stmts.htmlGH-the-global-statement).

The "Execution model" chapter described the global statement as if it
only allowed one single name. Pluralize "name" in the appropriate places.
(cherry picked from commit 4ecd119b00)

Co-authored-by: Luca Chiodini <luca@chiodini.org>

Co-authored-by: Luca Chiodini <luca@chiodini.org>
2021-10-16 10:01:14 -04:00
Serhiy Storchaka
6848602806
bpo-45467: Fix IncrementalDecoder and StreamReader in the "raw-unicode-escape" codec (GH-28944) (GH-28953)
They support now splitting escape sequences between input chunks.

Add the third parameter "final" in codecs.raw_unicode_escape_decode().
It is True by default to match the former behavior.

(cherry picked from commit 39aa98346d)
2021-10-14 21:23:52 +03:00
Serhiy Storchaka
7c722e32bf
[3.9] bpo-45461: Fix IncrementalDecoder and StreamReader in the "unicode-escape" codec (GH-28939) (GH-28945)
They support now splitting escape sequences between input chunks.

Add the third parameter "final" in codecs.unicode_escape_decode().
It is True by default to match the former behavior.
(cherry picked from commit c96d1546b1)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2021-10-14 20:03:29 +03:00
Miss Islington (bot)
cc90732d15
bpo-20692: Add Programming FAQ entry for 1.__class__ error. (GH-28918)
To avoid error, add either space or parentheses.
(cherry picked from commit 380c440875)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2021-10-12 22:40:18 -07:00
Miss Islington (bot)
0cd5bf9194
Slight correct grammar (GH-28860)
(cherry picked from commit 1b11582f0e)

Co-authored-by: nobodyatandnothing <91722596+nobodyatandnothing@users.noreply.github.com>
2021-10-12 10:01:26 -07:00
Miss Islington (bot)
38e3ada75a
bpo-45441: Update some moved URLs in documentation (GH-28861)
(cherry picked from commit b37dc9b3bc)

Co-authored-by: 180909 <wjh180909@gmail.com>
2021-10-12 07:20:50 -07:00