Commit graph

12108 commits

Author SHA1 Message Date
Miss Islington (bot)
40d1d28b07
[3.11] gh-90015: Document that PEP-604 unions do not support forward references (GH-105366) (#105461)
gh-90015: Document that PEP-604 unions do not support forward references (GH-105366)
(cherry picked from commit fbdee000de)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-06-07 19:11:33 +01:00
Jelle Zijlstra
34f23904e1
[3.11] Improve docs for typing.TypeAlias (GH-105372). (#105447)
(cherry picked from commit c5ec51ec8f)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-06-07 07:14:36 -07:00
Jelle Zijlstra
d0af5272a7
[3.11] gh-97797: Improve documentation for typing.Annotated (GH-105365). (#105449)
(cherry picked from commit e26d296984)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-06-07 07:14:01 -07:00
Alex Waygood
0d2ed56f6c
[3.11] Improve code examples in typing.rst (#105346) (#105427) 2023-06-07 06:41:35 -07:00
Miss Islington (bot)
039f30380b
[3.11] typing docs: Make the PEPs list an expandable section, hidden by default (GH-105353) (#105421)
typing docs: Make the PEPs list an expandable section, hidden by default (GH-105353)
(cherry picked from commit d7645124f5)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-06-07 07:50:31 +01:00
Miss Islington (bot)
5e4c46f029
[3.11] GH-95088: Clarify rules for parsing an item key for format strings (GH-103779) (#105418)
GH-95088: Clarify rules for parsing an item key for format strings (GH-103779)
(cherry picked from commit 3e7316d7e8)

Co-authored-by: achhina <amanschhina@gmail.com>
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2023-06-06 20:56:03 -07:00
Miss Islington (bot)
2456136360
[3.11] typing.NewType docs: the future performance improvements are now in the past (GH-105354) (#105415)
`typing.NewType` docs: the future performance improvements are now in the past (GH-105354)
(cherry picked from commit 5f65ff0370)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-06-06 20:55:46 -07:00
Miss Islington (bot)
faae548e0e
[3.11] gh-89412: Add missing attributes (added in 3.10) to traceback module docs (GH-105046) (#105328)
(cherry picked from commit a4f72fa39a)

Co-authored-by: Jakub Kuczys <me@jacken.men>
2023-06-05 19:02:23 +02:00
Miss Islington (bot)
86eab0807f
[3.11] gh-104882: Docs: fix description of relationship between socket.getblocking() and socket.gettimeout() (GH-105026) (#105284)
gh-104882: Docs: fix description of relationship between `socket.getblocking()` and `socket.gettimeout()` (GH-105026)
(cherry picked from commit 5a5ed7a3e6)

Co-authored-by: Joe Geisbauer <joegeisbauer@gmail.com>
2023-06-04 17:09:13 +01:00
Victor Stinner
5de6ca59fb
[3.11] gh-105096: Reformat wave documentation (#105136) (#105138) (#105155)
[3.12] gh-105096: Reformat wave documentation (#105136) (#105138)

gh-105096: Reformat wave documentation (#105136)

Add ".. class::" markups in the wave documentation.

* Reformat also wave.py (minor PEP 8 changes).
* Remove redundant "import struct": it's already imported at top
  level.
* Remove wave.rst from .nitignore

(cherry picked from commit 85e5d03163)
(cherry picked from commit 01b42f9559)
2023-05-31 16:40:25 +00:00
Miss Islington (bot)
c39500db52
[3.11] GH-89455: Add missing attributes (added in 3.11) to traceback module docs (GH-105044) (#105067)
GH-89455: Add missing attributes (added in 3.11) to traceback module docs (GH-105044)
(cherry picked from commit 39f6a0489f)

Co-authored-by: Jakub Kuczys <me@jacken.men>
2023-05-29 20:37:49 +01:00
Jelle Zijlstra
d34e58a1d5
[3.11] gh-103921: Improve typing documentation (GH-104642) (#105007)
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-05-27 16:30:41 -07:00
Miss Islington (bot)
a632697225
[3.11] gh-104984: remove kwargs and starargs from Call & ClassDef (GH-104986) (#104988)
gh-104984: remove kwargs and starargs from Call & ClassDef (GH-104986)

These fields are removed in 025e9ebd0a
(cherry picked from commit 61c1d6760f)

Co-authored-by: Shaygan Hooshyari <sh.hooshyari@gmail.com>
2023-05-26 18:14:03 +01:00
Miss Islington (bot)
3b3f2e107b
[3.11] gh-104874: Document NewType.__supertype__ (GH-104875) (#104907)
gh-104874: Document NewType.__supertype__ (GH-104875)
(cherry picked from commit 41768a2bd3)

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2023-05-25 00:35:58 +01:00
Prince Roshan
2ade563abc
[3.11] gh-103606: Improve error message from logging.config.FileConfig (GH-103628) (#104687)
* gh-103606: Improve error message from logging.config.FileConfig (GH-103628)

(cherry picked from commit 152227b569)

plus backport the followup exception change fix to that in #104701
2023-05-21 12:17:18 -07:00
Jelle Zijlstra
abb32de8c4
[3.11] typing docs: Move some classes out of the "Generics" section (GH-104707) (#104721)
- AnyStr can be used in type annotations, contrary to the section header
- Unpack can also be used in annotations, and its use is not restricted
  to generics. It makes more sense with other building blocks like Required.
- Protocol is not necessarily generic.

Also fix the indentation for two notes associated with Concatenate.

(cherry picked from commit ab71acd67b)

---------

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-05-21 14:31:26 +01:00
Miss Islington (bot)
dc0c41b2e5
[3.11] Corrected identifier (GH-104713) (#104714)
Corrected identifier (GH-104713)
(cherry picked from commit 60993ba8b4)

Co-authored-by: William Sawyer <wmsawyer2609@gmail.com>
2023-05-21 02:06:17 -04:00
Miss Islington (bot)
d45c1df83e
[3.11] gh-49174: document that the effect of calling gc.collect() during a collection is undefined (GH-104699) (#104703)
gh-49174: document that the effect of calling gc.collect() during a collection is undefined (GH-104699)
(cherry picked from commit 30488fa22a)

Co-authored-by: Irit Katriel <1055913+iritkatriel@users.noreply.github.com>
2023-05-20 20:12:52 +00:00
han-solo
89bd454cd9
[3.11] gh-104679 Fixed syntax highlighting in turtle docs (GH-104682). (#104695)
(cherry picked from commit 2c97878bb8)
2023-05-20 12:36:43 -04:00
Miss Islington (bot)
e5b6f38df4
[3.11] docs: fix wrong indentation causing rendering error in dis page (GH-104661) (#104670)
docs: fix wrong indentation causing rendering error in dis page (GH-104661)
(cherry picked from commit 3bc94e678f)

Co-authored-by: Nyakku Shigure <sigure.qaq@gmail.com>
2023-05-19 23:25:43 +03:00
Hugo van Kemenade
cd13f73afd
[3.11] gh-104659: Consolidate python examples in enum documentation (#104665) (#104666)
gh-104659: Consolidate python examples in enum documentation (#104665)

(cherry picked from commit 3ac856e697)

Co-authored-by: Thomas Hisch <t.hisch@gmail.com>
2023-05-19 23:12:57 +03:00
Miss Islington (bot)
610cc0ab1b
[3.11] gh-102153: Start stripping C0 control and space chars in urlsplit (GH-102508) (#104575)
* gh-102153: Start stripping C0 control and space chars in `urlsplit` (GH-102508)

`urllib.parse.urlsplit` has already been respecting the WHATWG spec a bit GH-25595.

This adds more sanitizing to respect the "Remove any leading C0 control or space from input" [rule](https://url.spec.whatwg.org/GH-url-parsing:~:text=Remove%20any%20leading%20and%20trailing%20C0%20control%20or%20space%20from%20input.) in response to [CVE-2023-24329](https://nvd.nist.gov/vuln/detail/CVE-2023-24329).

---------

(cherry picked from commit 2f630e1ce1)

Co-authored-by: Illia Volochii <illia.volochii@gmail.com>
Co-authored-by: Gregory P. Smith [Google] <greg@krypto.org>
2023-05-17 21:41:25 +00:00
Miss Islington (bot)
9cac6c414f
[3.11] gh-104539: Fix indentation error in logging.config.rst (GH-104545) (#104546)
gh-104539: Fix indentation error in logging.config.rst (GH-104545)

Fix indentation error in logging.config.rst
(cherry picked from commit 0bb61dd5b0)

Co-authored-by: Jesper Noordsij <45041769+jnoordsij@users.noreply.github.com>
2023-05-16 13:53:18 +01:00
Miss Islington (bot)
a712c5f42d
[3.11] gh-67056: document that registering/unregistering an atexit func from within an atexit func is undefined (GH-104473) (#104500) 2023-05-15 10:15:07 +01:00
Miss Islington (bot)
8e79414efc
[3.11] gh-104337: Clarify random.gammavariate doc entry (GH-104410) (#104481)
(cherry picked from commit 88c5c58670)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2023-05-14 16:25:25 -04:00
Miss Islington (bot)
f5f99756e1
[3.11] Minor improvements to typing docs (GH-104465) (#104475)
Minor improvements to typing docs (GH-104465)
(cherry picked from commit 2f7b5e458e)

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2023-05-14 13:00:57 +01:00
Miss Islington (bot)
e794d469e3
[3.11] Add a mention of PYTHONBREAKPOINT to breakpoint() docs (GH-104430) (#104447)
Add a mention of PYTHONBREAKPOINT to breakpoint() docs (GH-104430)
(cherry picked from commit 1be80ed107)

Co-authored-by: Ned Batchelder <ned@nedbatchelder.com>
2023-05-13 07:16:28 +00:00
Erlend E. Aasland
7055088500
[3.11] gh-101117: Improve accuracy of sqlite3.Cursor.rowcount docs (#104287) (#104381)
The SQLite C API sqlite3_changes() can only be relied upon when the
current active statement has been run to completion.
2023-05-11 11:09:46 +02:00
Miss Islington (bot)
a8e902d2c2
[3.11] gh-104010: Separate and improve docs for typing.get_origin and typing.get_args (GH-104013) (#104359)
* separate documentation and examples for both functions
* add examples demonstrating behaviour with unsupported types
* document return value of `get_origin` for `ParamSpecArgs` and `ParamSpecKwargs` instances

(cherry picked from commit a7a2dbbf72)

Co-authored-by: chgnrdv <52372310+chgnrdv@users.noreply.github.com>
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2023-05-10 07:49:49 -07:00
Miss Islington (bot)
03abac239c
[3.11] gh-103960: Dark mode: invert image brightness (GH-103983) (#104358)
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-05-10 14:19:38 +00:00
Miss Islington (bot)
2fa14d47af
[3.11] gh-48241: Clarify URL needs to be encoded when provided to urlopen and Request (GH-103855) (#103891)
(cherry picked from commit 44010d0f12)

Co-authored-by: Michael Blahay <mblahay@users.noreply.github.com>
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
2023-05-10 00:22:06 +02:00
Miss Islington (bot)
fffdbf4831
[3.11] gh-102327: Extend docs for "url" and "headers" parameters to HTTPConnection.request()
gh-102327: Extend docs for "url" and "headers" parameters to HTTPConnection.request()

Added example on how to use the HTTPConnection object for making GET request.

Original issue: https://github.com/python/cpython/issues/102327

---------

(cherry picked from commit 7ba6288feb)

Co-authored-by: David Foster <david@dafoster.net>
Co-authored-by: Éric <earaujo@caravan.coop>
2023-05-09 20:00:58 +00:00
Shantanu
15624b445e
[3.11] gh-102500: collections.abc.Buffer doesn't exist in 3.11 (#104317) 2023-05-09 10:27:15 +01:00
Miss Islington (bot)
8a6ff59e09
[3.11] GH-104145: Use fully-qualified cross reference types for the bisect module (GH-104172) (#104295)
GH-104145: Use fully-qualified cross reference types for the bisect module (GH-104172)
(cherry picked from commit 76eef552f3)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-05-08 17:41:20 +01:00
Alex Waygood
499b79d0b9
[3.11] gh-102500: Remove mention of bytes shorthand (#104281) (#104288)
gh-102500: Remove mention of bytes shorthand (#104281)

The bytes shorthand was removed in PEP 688:
https://peps.python.org/pep-0688/#no-special-meaning-for-bytes

The reference to collections.abc.ByteString is also removed, since that object is deprecated (#91896) and has different semantics (#102092)

Although PEP 688 is new in Python 3.12, type checkers are expected to implement the new semantics for type annotations even if users are using an older version of Python, so this docs PR is backported to Python 3.11.

Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
2023-05-08 15:23:10 +01:00
Miss Islington (bot)
efcd4bcb87
[3.11] gh-104254: Document the optional keyword-only "context" argument to Task constructor (GH-104251) (#104258)
gh-104254: Document the optional keyword-only "context" argument to Task constructor (GH-104251)

(This was added in 3.11. It was already documented for `create_task()`, but not for `Task()`.)
(cherry picked from commit 4ee2068c34)

Co-authored-by: Itamar Ostricher <itamarost@gmail.com>
2023-05-07 09:52:23 +05:30
Miss Islington (bot)
4b11af058e
[3.11] GH-97950: Use new-style index directive ('builtin') (GH-104164) (#104221)
GH-97950: Use new-style index directive ('builtin') (GH-104164)

* Uncomment builtin removal in pairindextypes

* Use new-style index directive ('builtin') - C API

* Use new-style index directive ('builtin') - Extending

* Use new-style index directive ('builtin') - Library

* Use new-style index directive ('builtin') - Reference

* Use new-style index directive ('builtin') - Tutorial
(cherry picked from commit f5088006ca)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-05-06 07:14:37 +03:00
Miss Islington (bot)
bb4369e15f
[3.11] gh-104112: link from cached_property docs to method-caching FAQ (GH-104113) (#104182)
gh-104112: link from cached_property docs to method-caching FAQ (GH-104113)
(cherry picked from commit fa86a77589)

Co-authored-by: Carl Meyer <carl@oddbird.net>
Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
2023-05-04 17:10:34 -06:00
Miss Islington (bot)
6a970ae666
[3.11] GH-97950: Use new-style index directive ('statement') (GH-104162) (#104163)
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-05-04 13:57:14 +03:00
Miss Islington (bot)
c463796ba7
[3.11] GH-97950: Use new-style index directive ('object') (GH-104158) (#104159)
GH-97950: Use new-style index directive ('object') (GH-104158)

* Uncomment object removal in pairindextypes

* Use new-style index directive ('object') - C API

* Use new-style index directive ('object') - Library

* Use new-style index directive ('object') - Reference

* Use new-style index directive ('object') - Tutorial
(cherry picked from commit 6ab463684b)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-05-04 13:14:16 +03:00
Miss Islington (bot)
693ef48df1
[3.11] GH-97950: Use new-style index directive ('operator') (GH-104156) (#104157)
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-05-04 12:27:04 +03:00
Adam Turner
00563694bb
[3.11] GH-97950: Use new-style index directive ('module') (GH-103996) (#104154) 2023-05-04 11:39:15 +03:00
Miss Islington (bot)
365e0772c9
[3.11] gh-101100: Fix Sphinx warnings in curses and curses.ascii modules (GH-103457) (#104124)
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
2023-05-02 23:20:50 -06:00
Shantanu
f9231a09be
[3.11] gh-65022: Fix description of tuple return value in copyreg (GH-103892) (#104098)
(cherry picked from commit 587f2f0180)
2023-05-02 11:18:41 -07:00
Rafael Fontenelle
5e76305236
[3.11] GH-103484: Fix redirected permanently URLs (GH-104001) (#104088)
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Co-authored-by: Oleg Iarygin <dralife@yandex.ru>
Fix redirected permanently URLs (#104001)
2023-05-02 14:50:16 +03:00
Miss Islington (bot)
3e7e50e656
[3.11] Improve assert_type phrasing (GH-104081) (#104084)
Improve assert_type phrasing (GH-104081)

I'd like to make the fact that this does nothing at runtime
really obvious, since I suspect this is unintuitive for users who are
unfamiliar with static type checking.

I thought of this because of
https://discuss.python.org/t/add-arg-check-type-to-types/26384
wherein I'm skeptical that the user really did want `assert_type`.
(cherry picked from commit 82ba6ce303)

Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
2023-05-02 08:44:16 +01:00
Miss Islington (bot)
d8055b889c
[3.11] Adjust expression from == to != in alignment with the meaning of the paragraph. (GH-104021) (GH-104031)
(cherry picked from commit 93107aa2a4)
2023-05-01 06:58:33 +01:00
Shantanu
86ef1ce121
[3.11] Fix description of MAKE_CELL (#103986)
Backport of part of #103923
2023-04-29 06:12:46 -07:00
Miss Islington (bot)
9fbb614c4e
[3.11] gh-99032: datetime docs: Encoding is no longer relevant (GH-93365) (#103788)
This removes a section of the `strftime` and `strptime` documentation that refers to a bygone era when `strftime` would return an encoded byte string.

---------

(cherry picked from commit 2aa22f72fb)

Co-authored-by: William Andrea <william.j.andrea@gmail.com>
Co-authored-by: Paul Ganssle <1377457+pganssle@users.noreply.github.com>
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
2023-04-28 20:09:55 -07:00
Petr Viktorin
241f2e54a6
[3.11] gh-102950: Implement PEP 706 – Filter for tarfile.extractall (GH-102953) (GH-103832)
See [Backporting & Forward Compatibility in PEP 706](https://peps.python.org/pep-0706/#backporting-forward-compatibility).

- Backport b52ad18a76
- Backport c8c3956d90
- Remove the DeprecationWarning
- Adjust docs
- Remove new `__all__` entries
2023-04-28 17:41:09 +02:00