summaryrefslogtreecommitdiffstats
path: root/Doc/reference
Commit message (Collapse)AuthorAgeFilesLines
* [3.13] gh-124370: Add "howto" for free-threaded Python (GH-124371) (#124860)Miss Islington (bot)2024-10-031-0/+1
| | | | | | | | | | gh-124370: Add "howto" for free-threaded Python (GH-124371) (cherry picked from commit 68e384c2179fba41bc3be469e6ef34927a37f4a5) Co-authored-by: Sam Gross <colesbury@gmail.com> Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com> Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com> Co-authored-by: mpage <mpage@cs.stanford.edu> Co-authored-by: Carol Willing <carolcode@willingconsulting.com>
* [3.13] gh-123339: Fix cases of inconsistency of __module__ and ↵Serhiy Storchaka2024-09-301-1/+4
| | | | | | | | | | | | | __firstlineno__ in classes (GH-123613) (#124735) * Setting the __module__ attribute for a class now removes the __firstlineno__ item from the type's dict. * The _collections_abc and _pydecimal modules now completely replace the collections.abc and decimal modules after importing them. This allows to get the source of classes and functions defined in these modules. * inspect.findsource() now checks whether the first line number for a class is out of bound. (cherry picked from commit 69a4063ca516360b5eb96f5432ad9f9dfc32a72e)
* [3.13] gh-81263: Add assignment expressions to `help` (GH-124641) (#124713)Emily Morehouse2024-09-271-0/+1
| | | | | | | gh-81263: Add assignment expressions to `help` (#124641) * Add assignment expression (:=) to `help` * Update index for Assignment Expressions to include pair of `assignment; expression`
* [3.13] GH-65961: Document the deprecation of `__package__` and `__cached__` ↵Miss Islington (bot)2024-09-271-0/+8
| | | | | | | | | | | | | | (GH-124377) (#124380) * GH-65961: Document the deprecation of `__package__` and `__cached__` (GH-124377) The code changes for warning related to `__package__` landed in Python 3.12. `__cached__` doesn't have any changes as it isn't used but only set by the import system. (cherry picked from commit 67201ad53ff11576c69a9b762540b77128285f8d) --------- Co-authored-by: Brett Cannon <brett@python.org> Co-authored-by: Barry Warsaw <barry@python.org>
* [3.13] gh-123242: Note that type.__annotations__ may not exist (GH-124557) ↵Jelle Zijlstra2024-09-261-0/+8
| | | | | | | | | (#124569) Closes GH-123242. The real criterion is that the attribute does not exist on heap types, but I don't think we should discuss heap vs. static types in the language reference. (cherry picked from commit 99b23c64de301c9e77add6b0d8e60118ef807840)
* [3.13] gh-101100: Make __subclasses__ doctest stable (GH-124577) (#124579)Miss Islington (bot)2024-09-261-2/+4
| | | | | | | | | | gh-101100: Make __subclasses__ doctest stable (GH-124577) Using a standard library class makes this test difficult to maintain as other tests and other parts of the stdlib may create subclasses, which may still be alive when this test runs depending on GC timing. (cherry picked from commit 08a467b537b3d9b499d060697e79b3950374ab0f) Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
* [3.13] gh-115528: Update language reference for PEP 646 (GH-121181) (#124632)Miss Islington (bot)2024-09-262-17/+32
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | gh-115528: Update language reference for PEP 646 (GH-121181) To recap: the objective is to make starred expressions valid in `subscription`, which is used for generics: `Generic[...]`, `list[...]`, etc. What _is_ gramatically valid in such contexts? Seemingly any of the following. (At least, none of the following throw `SyntaxError` in a 3.12.3 REPL.) Generic[x] Generic[*x] Generic[*x, y] Generic[y, *x] Generic[x := 1] Generic[x := 1, y := 2] So introducting flexible_expression: expression | assignment_expression | starred_item end then switching `subscription` to use `flexible_expression` sorts that. But then we need to field `yield` - for which any of the following are apparently valid: yield x yield x, yield x, y yield *x, yield *x, *y Introducing a separate `yield_list` is the simplest way I've been figure out to do this - separating out the special case of `starred_item ,`. (cherry picked from commit 7d3497f617edf77cb6ead6f5e62bce98d77b9ab8) Co-authored-by: Matthew Rahtz <matthew.rahtz@gmail.com> Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
* [3.13] gh-101100: Add a table of class attributes to the "Custom classes" ↵Alex Waygood2024-09-264-49/+108
| | | | section of the data model docs (#124480) (#124556)
* [3.13] GH-103484: Fix permanently redirects reported by linkcheck ↵Miss Islington (bot)2024-09-241-1/+1
| | | | | | | | | | | (GH-124144) (#124151) GH-103484: Fix permanently redirects reported by linkcheck (GH-124144) Fix redirects reported by linkcheck, update docs conf.py checks. (cherry picked from commit 0a32c6959c265d21d7c43fe8e4aefc8c0983e85e) Co-authored-by: Rafael Fontenelle <rffontenelle@users.noreply.github.com>
* [3.13] gh-123580: Fix `signed_number` token in documentation (GH-123582) ↵Miss Islington (bot)2024-09-041-1/+1
| | | | | | | | | | (GH-123623) gh-123580: Fix `signed_number` token in documentation (GH-123582) (cherry picked from commit 9e079c220b7f64d78a1aa36a23b513d7f377a694) Co-authored-by: CBerJun <121291537+CBerJun@users.noreply.github.com> Co-authored-by: Sergey B Kirpichev <skirpichev@gmail.com>
* [3.13] gh-123621: Fix `datamodel.rst` with proper `dict` notation ↵Miss Islington (bot)2024-09-031-1/+1
| | | | | | | | (GH-123648) (#123653) gh-123621: Fix `datamodel.rst` with proper `dict` notation (GH-123648) (cherry picked from commit cfbc841ef3c27b3e65d1223bf8fedf1f652137bc) Co-authored-by: Lipták Attila (Flash) <113017309+AttilaLiptak@users.noreply.github.com>
* [3.13] gh-123579: Document exclamation token (GH-123612) (#123637)Miss Islington (bot)2024-09-031-3/+3
| | | | | (cherry picked from commit 68fe5758bf1900ffdcdf7cd9e40f5018555a39d4) Co-authored-by: Shaygan Hooshyari <sh.hooshyari@gmail.com>
* [3.13] gh-123517: Remove unnecessary `:meth:` parentheses (gh-123518) ↵Wei-Hsiang (Matt) Wang2024-09-022-3/+3
| | | | (GH-123577)
* [3.13] gh-123492: Remove unnecessary `:func:` parentheses (gh-123493) (#123513)Wei-Hsiang (Matt) Wang2024-08-301-1/+1
|
* [3.13] gh-122701: Fix wording of raw strings/bytes in `lexical_analysis.rst` ↵Miss Islington (bot)2024-08-111-5/+4
| | | | | | | | | (GH-122702) (#122914) gh-122701: Fix wording of raw strings/bytes in `lexical_analysis.rst` (GH-122702) (cherry picked from commit ea70439bd2b5a1c881342646f30942f527f61373) Co-authored-by: sobolevn <mail@sobolevn.me> Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* [3.13] gh-122511: Improve documentation for object identity of ↵Miss Islington (bot)2024-08-071-6/+10
| | | | | | | | | mutable/immutable types (GH-122512) (#122778) gh-122511: Improve documentation for object identity of mutable/immutable types (GH-122512) (cherry picked from commit 76bdeebef6c6206f3e0af1e42cbfc75c51fbb8ca) Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com> Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* [3.13] gh-122445: populate only modified fields in __static_attributes__ ↵Irit Katriel2024-08-021-1/+1
| | | | | | | (#122446) (#122621) gh-122445: populate only modified fields in __static_attributes__ (#122446) (cherry picked from commit 498376d7a7d6f704f22a2c963130cc15c17e7a6f)
* [3.13] Remove outdated note about instance methods from datamodel.rst ↵Miss Islington (bot)2024-07-301-8/+1
| | | | | | | | (GH-122471) (#122479) Remove outdated note about instance methods from datamodel.rst (GH-122471) (cherry picked from commit c68cb8e0c9bd75ded25578c2fba6469e55a06e93) Co-authored-by: Thomas Grainger <tagrain@gmail.com>
* [3.13] gh-121905: Consistently use "floating-point" instead of "floating ↵Serhiy Storchaka2024-07-193-21/+21
| | | | | point" (GH-121907) (GH-122012) (cherry picked from commit 1a0c7b9ba48a2dffb70bb0c7327abae1d3e87356)
* [3.13] gh-120452: improve documentation about private name mangling ↵Miss Islington (bot)2024-07-131-11/+40
| | | | | | | | | (GH-120451) (#121715) gh-120452: improve documentation about private name mangling (GH-120451) (cherry picked from commit f4d6e45c1e7161878b36ef9e876ca3e44b80a97d) Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com> Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
* [3.13] gh-121355: Fix incorrect word in simple_stmts.rst (GH-121356) (#121362)Miss Islington (bot)2024-07-041-1/+1
| | | | | (cherry picked from commit 715ec630dd78819ed79cad5ac28617daefe1e745) Co-authored-by: Jongbum Won <71166964+Wondaeng@users.noreply.github.com>
* [3.13] gh-114104: clarify asynchronous comprehension docs to match runtime ↵Miss Islington (bot)2024-07-011-4/+6
| | | | | | | | behavior (GH-121175) (#121234) gh-114104: clarify asynchronous comprehension docs to match runtime behavior (GH-121175) (cherry picked from commit 91313afdb392d0d6105e9aaa57b5a50112b613e7) Co-authored-by: Danny Yang <yangdanny97@users.noreply.github.com>
* [3.13] doc: Mention the missing reflected special methods for all binary ↵Miss Islington (bot)2024-06-291-7/+17
| | | | | | | | operations (GH-119931) (#120063) doc: Mention the missing reflected special methods for all binary operations (GH-119931) (cherry picked from commit bf5e1065f4ec2077c6ca352fc1ad940a76d1f6c9) Co-authored-by: Paulo Freitas <me@paulofreitas.me>
* [3.13] gh-120937: Reference weakref from the `__del__` documentation ↵Miss Islington (bot)2024-06-261-0/+2
| | | | | | | | | (GH-120940) (#121061) gh-120937: Reference weakref from the `__del__` documentation (GH-120940) (cherry picked from commit 1c13b29d54ad6d7c9e030227d575ad7d21b4054f) Co-authored-by: chaen <christophe.haen@cern.ch> Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
* [3.13] gh-120521: clarify except* documentation to allow tuples (GH-120523) ↵Miss Islington (bot)2024-06-191-9/+10
| | | | | | | | | (#120750) (cherry picked from commit 58b3f111767148e9011ccd52660e208f0c834b2a) Co-authored-by: Danny Yang <yangdanny97@users.noreply.github.com> Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com> Co-authored-by: Irit Katriel <1055913+iritkatriel@users.noreply.github.com>
* [3.13] annotations: expand documentation on "simple" assignment targets ↵Miss Islington (bot)2024-06-151-2/+5
| | | | | | | | | | | | (GH-120535) (#120555) This behavior is rather surprising and it was not clearly specified. (cherry picked from commit 9e0b11eb21930b7b8e4a396200a921e9985cfca4) Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com> Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
* [3.13] gh-118934: Fix PyEval_GetLocals docs (PEP 667) (GH-119934)Miss Islington (bot)2024-06-021-2/+2
| | | | | | | | | | | | | | | | PEP 667's description of the planned changes to PyEval_GetLocals was internally inconsistent when accepted, so the docs added for gh-74929 didn't match either the current behaviour or the intended behaviour once gh-118934 is fixed. This PR updates the documentation and 3.13 What's New to match the intended behaviour (once gh-118934 is fixed). It also tidies up lingering references to `f_locals` always being a dictionary (this hasn't been true since at least when custom namespace support for class statement execution was added) (cherry picked from commit fd6cd621e0cce6ba2e737103d2a62b5ade90f41f) Co-authored-by: Alyssa Coghlan <ncoghlan@gmail.com>
* [3.13] gh-100117: Fix inaccuracy in documentation of the CodeObject's ↵Miss Islington (bot)2024-05-311-1/+1
| | | | | | | | co_positions field. (GH-119364) (#119869) gh-100117: Fix inaccuracy in documentation of the CodeObject's co_positions field. (GH-119364) (cherry picked from commit 015b1fdd0ae03f94a5dfda051b020810d1c952dd) Co-authored-by: Irit Katriel <1055913+iritkatriel@users.noreply.github.com>
* [3.13] gh-74929: PEP 667 general docs update (gh-119291)Miss Islington (bot)2024-05-211-1/+1
| | | | | | | | | | | * expand on What's New entry for PEP 667 (including porting notes) * define 'optimized scope' as a glossary term * cover comprehensions and generator expressions in locals() docs * review all mentions of "locals" in documentation (updating if needed) * review all mentions of "f_locals" in documentation (updating if needed) (cherry picked from commit e870c852c0ea96fa4e4569e9c39c7ceb80ce858d) Co-authored-by: Alyssa Coghlan <ncoghlan@gmail.com>
* gh-118465: Add __firstlineno__ attribute to class (GH-118475)Serhiy Storchaka2024-05-061-0/+4
| | | | It is set by compiler with the line number of the first line of the class definition.
* gh-74929: Rudimentary docs for PEP 667 (#118581)Guido van Rossum2024-05-051-1/+6
| | | | | | | | | This is *not* sufficient for the final 3.13 release, but it will do for beta 1: - What's new entry - Updated changelog entry (news blurb) - Mention the proxy for f_globals in the datamodel and Python frame object docs This doesn't have any C API details (what's new refers to the PEP).
* gh-116126: Implement PEP 696 (#116129)Jelle Zijlstra2024-05-032-10/+29
| | | | | Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com> Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com> Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
* Clarifying nonlocal doc: SyntaxError is raised if nearest enclosing scope is ↵Quazi Irfan2024-04-211-2/+3
| | | | | global (#114009) Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
* gh-115775: Add whatsnew entry about __static_attributes__ (GH-117909)Irit Katriel2024-04-191-0/+5
| | | | | Co-authored-by: Kirill Podoprigora <kirill.bast9@mail.ru> Co-authored-by: Petr Viktorin <encukou@gmail.com> Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
* Add 'The Python 2.3 Method Resolution Order' (#116435)Hugo van Kemenade2024-04-151-5/+2
|
* Add information about negative indexes to sequence datamodel doc (#110903)Adorilson Bezerra2024-03-251-3/+6
| | | Co-authored by Terry Jan Reedy
* gh-56374: Clarify documentation of nonlocal (#116942)Terry Jan Reedy2024-03-191-13/+17
| | | | | Define 'nonlocal scopes' in a way that excludes class scopes. Rearrange the rest of the doc. Add "Programmer's note".
* gh-107607: Update comment about utf-8 BOM being ignored (#107858)Sunghyun Kim2024-03-191-4/+3
| | | | | --------- Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
* gh-116881: Remove erroneous or redundant grammar NULL (GH-116885)Terry Jan Reedy2024-03-181-1/+1
| | | | | | In Lexical Analysis f-strings section, NULL in the description of 'literal character' means '\0'. In the format_spec grammar production, it is wrong with that meaning and redundant if instead interpreted as <nothing>. Remove it there.
* gh-115664: Fix ordering of more versionadded and versionchanged directives ↵Serhiy Storchaka2024-03-072-3/+1
| | | | (GH-116298)
* gh-72971: Clarify the special no-TypeError behavior for equality (#110729)Gouvernathor2024-03-031-1/+4
|
* gh-104219: Document that idunders can return NotImplemented (#104220)Gouvernathor2024-03-011-2/+4
| | | | Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM> Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
* Docs: mark up NotImplemented using the :data: role throughout the docs (#116135)Erlend E. Aasland2024-02-292-10/+10
|
* Erase some unnecessary quotes on data model doc (#113521)Adorilson Bezerra2024-02-251-4/+4
| | | | Thanks to Pedro Arthur Duarte (pedroarthur.jedi at gmail.com) for help with this bug.
* gh-115572: Move `codeobject.replace()` docs to the data model (#115631)Daler2024-02-181-0/+8
|
* gh-115405: add versionadded tag for co_qualname in code objects ↵Christophe Papazian2024-02-131-0/+2
| | | | documentation (#115411)
* gh-114552: Update `__dir__` method docs: it allows returning an iterable ↵Nikita Sobolev2024-02-101-3/+3
| | | | (#114662)
* Clarify one-item tuple (#114745)Terry Jan Reedy2024-01-301-2/+3
| | | | A 'single tuple' means 'one typle, of whatever length. Remove the unneeded and slight distracting parenthetical 'singleton' comment.
* gh-101100: Fix sphinx warnings in `reference/import.rst` (#114646)Nikita Sobolev2024-01-271-3/+4
|
* gh-101100: Fix Sphinx warnings in `reference/expressions.rst` (#114194)Hugo van Kemenade2024-01-221-26/+26
|