bf5e1065f4
doc: Mention the missing reflected special methods for all binary operations (GH-119931)
2024-06-04 17:55:11 +00:00
f79ffc879b
gh-119740: Remove deprecated trunc delegation ( #119743 )
...
Remove the delegation of `int` to the `__trunc__` special method: `int` will now only delegate to `__int__` and `__index__` (in that order). `__trunc__` continues to exist, but its sole purpose is to support `math.trunc`.
---------
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2024-06-02 10:16:49 +01:00
fd6cd621e0
gh-118934: Fix PyEval_GetLocals docs (PEP 667) ( #119932 )
...
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)
2024-06-02 04:44:29 +00:00
015b1fdd0a
gh-100117: Fix inaccuracy in documentation of the CodeObject's co_positions field. ( #119364 )
2024-05-31 17:09:48 +00:00
e870c852c0
gh-74929: PEP 667 general docs update (gh-119201)
...
* 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)
2024-05-21 03:32:15 +00:00
35b5eaa176
gh-118767: Improve tests and docs for bool(NotImplemented) ( #118813 )
2024-05-09 13:52:08 +00:00
3c079a0203
gh-118767: Make bool(NotImplemented) raise TypeError ( #118775 )
2024-05-08 11:12:00 -07:00
153b3f7530
gh-118465: Add __firstlineno__ attribute to class (GH-118475)
...
It is set by compiler with the line number of the first line of
the class definition.
2024-05-06 12:02:37 +03:00
9c13d9e37a
gh-74929: Rudimentary docs for PEP 667 ( #118581 )
...
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).
2024-05-05 15:31:26 +00:00
ca269e58c2
gh-116126: Implement PEP 696 ( #116129 )
...
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>
2024-05-03 06:17:32 -07:00
1558d99316
Clarifying nonlocal doc: SyntaxError is raised if nearest enclosing scope is global ( #114009 )
...
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2024-04-20 18:42:51 -07:00
8a01fd7b9b
gh-115775: Add whatsnew entry about __static_attributes__ (GH-117909)
...
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>
2024-04-19 12:57:31 +02:00
7d0be7aea5
Add 'The Python 2.3 Method Resolution Order' ( #116435 )
2024-04-15 13:01:15 +03:00
c2276176d5
Add information about negative indexes to sequence datamodel doc ( #110903 )
...
Co-authored by Terry Jan Reedy
2024-03-25 18:34:20 -04:00
025ef7a5f7
gh-56374: Clarify documentation of nonlocal ( #116942 )
...
Define 'nonlocal scopes' in a way that excludes class scopes.
Rearrange the rest of the doc. Add "Programmer's note".
2024-03-19 13:55:21 -04:00
7f64ae30dd
gh-107607: Update comment about utf-8 BOM being ignored ( #107858 )
...
---------
Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2024-03-19 11:51:12 -04:00
4e45c6c54a
gh-116881: Remove erroneous or redundant grammar NULL (GH-116885)
...
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.
2024-03-18 10:31:13 +01:00
808a77612f
gh-115664: Fix ordering of more versionadded and versionchanged directives (GH-116298)
2024-03-07 10:05:03 +02:00
67f742e03a
gh-72971: Clarify the special no-TypeError behavior for equality ( #110729 )
2024-03-03 00:45:48 +00:00
2713c2abc8
gh-104219: Document that idunders can return NotImplemented ( #104220 )
...
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2024-03-01 16:51:47 +01:00
dbe44f150c
Docs: mark up NotImplemented using the :data: role throughout the docs ( #116135 )
2024-02-29 20:46:12 +00:00
f7455864f2
Erase some unnecessary quotes on data model doc ( #113521 )
...
Thanks to Pedro Arthur Duarte (pedroarthur.jedi at gmail.com) for help with this bug.
2024-02-24 19:16:19 -05:00
0c80da4c14
gh-115572: Move `codeobject.replace()` docs to the data model ( #115631 )
2024-02-18 14:13:46 +00:00
de07941729
gh-115405: add versionadded tag for co_qualname in code objects documentation ( #115411 )
2024-02-13 16:10:00 +00:00
e19103a346
gh-114552: Update `__dir__` method docs: it allows returning an iterable ( #114662 )
2024-02-10 08:34:23 +00:00
a1332a99cf
Clarify one-item tuple ( #114745 )
...
A 'single tuple' means 'one typle, of whatever length.
Remove the unneeded and slight distracting parenthetical 'singleton' comment.
2024-01-30 18:40:54 +00:00
a384b20c0c
gh-101100: Fix sphinx warnings in `reference/import.rst` ( #114646 )
2024-01-27 07:30:21 -07:00
8ccd1ba461
gh-101100: Fix Sphinx warnings in `reference/expressions.rst` ( #114194 )
2024-01-22 18:21:14 +02:00
b04c5005cc
Fix the confusing "User-defined methods" reference in the datamodel ( #114276 )
...
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Sergey B Kirpichev <skirpichev@gmail.com>
2024-01-21 03:45:38 +00:00
029ecee10d
gh-114070: fix token reference warnings in expressions.rst ( #114169 )
2024-01-17 18:39:50 +02:00
a47353d587
datamodel: Fix a typo in ``object.__init_subclass__`` ( #111599 )
2024-01-12 22:59:24 +00:00
e68806c712
Docs: Amend codeobject.co_lines docs; end number is exclusive ( #113970 )
...
The end number should be exclusive, not inclusive.
2024-01-12 16:04:14 +01:00
a8629816c6
gh-113664: Improve style of Big O notation (GH-113695)
...
Use cursive to make it looking like mathematic formulas.
2024-01-10 15:01:18 +02:00
f1f8392432
Document the `co_lines` method on code objects ( #113682 )
...
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2024-01-03 19:29:24 +00:00
8ff44f8554
gh-81094: Refer to PEP 318 in compound_statements.rst ( #113588 )
...
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2024-01-02 10:40:14 +02:00
6a5b4736e5
gh-113313: Note that slice support is not required for all sequences. (gh-113377)
2023-12-21 15:54:59 -06:00
5a7cc667f8
Fix typo in datamodel docs ( #113314 )
...
Co-authored-by: Rodrigo Girão Serrão <5621605+rodrigogiraoserrao@users.noreply.github.com>
2023-12-20 11:58:38 +00:00
32d87a8899
Docs: Add label to grammar spec for linking from PEPs ( #113235 )
2023-12-17 12:23:14 -07:00
4b3cb082da
gh-101100: Fix Sphinx nitpicks in `library/inspect.rst` and `reference/simple_stmts.rst` ( #113107 )
2023-12-14 13:30:57 +00:00
d05a180350
gh-101100: Improve docs on exception attributes (GH-113057)
...
* Improve docs on exception attributes
* thanks sphinx-lint
* fix doctests
* argh, okay, give up on doctests
* Various improvements
2023-12-13 10:59:36 -08:00
81a15ea74e
gh-101100: Further improve docs on function attributes ( #113001 )
2023-12-12 20:21:12 +00:00
4c5b9c107a
gh-101100: Improve documentation on function attributes ( #112933 )
...
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-12-11 12:00:42 +02:00
5bf7580d72
Docs: Use 'f-strings' as header ( #112888 )
2023-12-10 10:39:51 +02:00
96f64a2b1b
gh-101100: Improve documentation of `TracebackType` attributes ( #112884 )
2023-12-09 22:43:53 +00:00
ed21d0c1f4
gh-101100: Improve documentation for attributes on instance methods ( #112832 )
2023-12-08 13:18:53 +00:00
e9707d3c3d
gh-101100: Improve documentation of code object attributes ( #112781 )
2023-12-06 20:15:46 +00:00
d109f637c0
gh-101100: Properly document frame object attributes ( #112735 )
2023-12-05 19:27:59 +00:00
2f20cafdbf
gh-101100: Fix many easily solvable Sphinx nitpicks in the datamodel docs ( #112737 )
2023-12-05 09:59:52 +00:00
45650d1c47
gh-101100: Fix most Sphinx nitpicks in `inspect.rst` ( #112662 )
2023-12-03 17:32:49 +00:00
97f8f28b3e
gh-112331: Fix reference manual description of attribute lookup mechanics (gh-112375)
2023-11-25 16:20:53 -06:00
9a2f25d374
gh-111944: Add assignment expression parentheses requirements ( #111977 )
...
gh-111944: Clarify where assignment expressions require ()s
Augment the list of places where parentheses are
required around assignnment statements. In particular,
'a := 0' and 'a = b := 1' are syntax errors.
2023-11-12 19:06:50 -05:00
13405ecffd
gh-79932: raise exception if frame.clear() is called on a suspended frame ( #111792 )
2023-11-07 08:49:30 +00:00
9a2f2f46ca
Fix typos in import system docs ( #111396 )
2023-10-27 13:20:55 +00:00
63acf78d71
GH-101100: Fix reference warnings for ``__enter__`` and ``__exit__`` ( #110112 )
2023-10-19 18:05:17 +03:00
da99133710
GH-101100: Fix reference warnings for ``__getitem__`` ( #110118 )
2023-10-19 18:05:05 +03:00
42a5d21d46
gh-110886 Doc: add a link to BNF Wikipedia article ( #110887 )
...
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-10-15 10:52:13 -06:00
41d8ec5a1b
gh-110631: Fix reST indentation in `Doc/reference` ( #110708 )
...
Fix wrong indentation in the Doc/reference dir.
2023-10-11 22:50:55 +02:00
e27adc68cc
gh-109634: Fix `:samp:` syntax (GH-110073)
2023-09-29 14:21:34 +03:00
92af0cc580
gh-109634: Use :samp: role (GH-109635)
2023-09-23 09:31:20 +03:00
def828995a
fixes gh-109559: Update `unicodedata` for Unicode 15.1.0 (GH-109560)
...
---------
Co-authored-by: Benjamin Peterson <benjamin@python.org>
2023-09-19 22:07:47 -07:00
cb1184280b
Docs: Resolve Sphinx warnings in dis.rst ( #108476 )
...
- Link to the code objects reference
- Suppress link to deliberately undocumented builtins.__build_class__
- Suppress links for example methods
2023-08-25 13:28:47 +02:00
2b7bff0655
Datamodel: Add headings to the standard type hierarchy ( #108146 )
...
Dedent content according to the new layout.
2023-08-25 13:02:36 +02:00
7f5b1a0661
Docs: Datamodel: Merge "Notes on using __slots__" with the parent section ( #108400 )
2023-08-25 12:27:36 +02:00
f2d07d3289
gh-101100: Sphinx warnings: pick the low hanging fruits (GH-107386)
2023-07-29 08:48:10 +03:00
0af247da09
gh-102111: Add link to string escape sequences in re module ( #106995 )
...
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-07-23 02:50:38 -06:00
d036db728e
gh-106892: Use roles :data: and :const: for referencing module variables (GH-106894)
2023-07-21 12:34:30 +03:00
fcc816dbff
gh-106919: Use role :c:macro: for referencing the C "constants" (GH-106920)
2023-07-21 10:52:07 +03:00
43389e4a3a
Fix typo in datamodel.rst ( #106587 )
2023-07-10 17:22:41 +05:30
987b712b4a
Replace the esoteric term 'datum' when describing dict comprehensions ( #106119 )
2023-07-02 20:22:40 -07:00
93a970ffbc
gh-106046: Improve error message from `os.fspath` if `__fspath__` is set to `None` ( #106082 )
2023-06-26 00:06:12 +01:00
060277d96b
gh-103921: Document PEP 695 ( #104642 )
...
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-05-26 10:48:17 -07:00
8e5b3b90c8
gh-102856: Update "Formatted string literals" docs section after PEP701 ( #104861 )
2023-05-24 15:38:37 +02:00
d56c933992
gh-104770: Let generator.close() return value ( #104771 )
...
Co-authored-by: Irit Katriel <1055913+iritkatriel@users.noreply.github.com>
2023-05-23 13:51:56 -07:00
f5088006ca
GH-97950: Use new-style index directive ('builtin') ( #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
2023-05-06 06:54:08 +03:00
b7a0a52196
gh-102500: Document PEP 688 ( #102571 )
...
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
2023-05-04 08:23:40 -07:00
55d50d147c
GH-97950: Use new-style index directive ('statement') ( #104162 )
2023-05-04 13:48:45 +03:00
3e7995ca11
GH-97950: Use new-style index directive ('exception') ( #104160 )
2023-05-04 13:30:24 +03:00
6ab463684b
GH-97950: Use new-style index directive ('object') ( #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
2023-05-04 13:04:41 +03:00
b0ce2db118
GH-97950: Use new-style index directive ('operator') ( #104156 )
2023-05-04 12:03:11 +03:00
33ca322c50
GH-97950: Use new-style index directive ('keyword') ( #104153 )
...
* Uncomment keyword removal in pairindextypes
* Use new-style index directive ('keyword') - Reference
2023-05-04 10:44:12 +02:00
d0122372f2
GH-97950: Use new-style index directive ('module') ( #103996 )
...
* Use new-style index directive ('module') - C API
* Use new-style index directive ('module') - Library
* Use new-style index directive ('module') - Reference
* Use new-style index directive ('module') - Tutorial
* Uncomment module removal in pairindextypes
* Use new-style index directive ('module') - C API
* Use new-style index directive ('module') - Library
* Use new-style index directive ('module') - Reference
2023-05-04 10:17:12 +02:00
9f9e001ab2
gh-103590: mention that the change is included in 3.11.4 and clarify except* documentation ( #104095 )
2023-05-03 21:55:19 +01:00
8b03e5ff94
GH-97850: Suppress cross-references to the removed ``module_repr`` method ( #104133 )
...
Suppress cross-references to ``module_repr``
2023-05-03 13:57:23 +01:00
326997829d
gh-98040: Remove find_loader, find_module and other deprecated APIs ( #98059 )
...
* Remove deprecated classes from pkgutil
* Remove some other PEP 302 obsolescence
* Use find_spec instead of load_module
* Remove more tests of PEP 302 obsolete APIs
* Remove another bunch of tests using obsolete load_modules()
* Remove deleted names from __all__
* Remove obsolete footnote
* imp is removed
* Remove `imp` from generated stdlib names
* What's new and blurb
* Update zipimport documentation for the removed methods
* Fix some Windows tests
* Remove any test (or part of a test) that references `find_module()`.
* Use assertIsNone() / assertIsNotNone() consistently.
* Update Doc/reference/import.rst
* We don't need pkgutil._get_spec() any more either
* test.test_importlib.fixtures.NullFinder
* ...BadLoaderFinder.find_module
* ...test_api.InvalidatingNullFinder.find_module
* ...test.test_zipimport test of z.find_module
* Suppress cross-references to find_loader and find_module
* Suppress cross-references to Finder
* Suppress cross-references to pkgutil.ImpImporter and pkgutil.ImpLoader
---------
Co-authored-by: Oleg Iarygin <oleg@arhadthedev.net>
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
2023-05-03 04:55:22 -07:00
68ed2a2a3f
GH-103484: Fix redirected permanently URLs ( #104001 )
...
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Co-authored-by: Oleg Iarygin <dralife@yandex.ru>
2023-05-02 09:34:44 +03:00
e1f14643dc
gh-98040: Remove just the `imp` module ( #98573 )
2023-04-28 16:17:58 -07:00
730bbddfdf
gh-101688: Implement types.get_original_bases ( #101827 )
...
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-04-23 20:24:30 +01:00
e071f00aae
gh-103373: `__mro_entries__` docs: improve cross references ( #103398 )
...
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2023-04-11 11:25:45 +01:00
0ba0ca05d2
gh-103373: Improve documentation for `__mro_entries__` ( #103374 )
2023-04-08 15:09:00 +01:00
2a721258a1
gh-101865: Deprecate `co_lnotab` from code objects as per PEP 626 ( #101866 )
...
Co-authored-by: Oleg Iarygin <oleg@arhadthedev.net>
2023-04-03 17:35:04 +02:00
88c262c086
gh-100315: clarification to `__slots__` docs. ( #102621 )
...
refer to tp_itemsize in discussion on "variable-length" built-in types
2023-03-14 09:23:52 +00:00
f6ca71a422
Fix duplicated words in the docs (GH-102629)
...
With grep utility found some duplicated words
Automerge-Triggered-By: GH:AlexWaygood
2023-03-12 11:03:59 -07:00
4d3bc89a3f
gh-102011: use sys.exception() instead of sys.exc_info() in docs where possible ( #102012 )
2023-02-20 21:54:19 +00:00
3690688149
GH-101898: Fix missing term references for hashable definition ( #101899 )
...
Fix missing term references for hashable definition
2023-02-14 14:20:11 +04:00
8b1f125121
gh-81611: Improve `range` paragraph in 8.3 of language reference ( #98353 )
...
Co-authored-by: Kumar Aditya <59607654+kumaraditya303@users.noreply.github.com>
Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2023-01-03 13:46:51 +05:30
7feb6d2f85
fix `grammer` -> `grammar` typo in expressions.rst (GH-100683)
...
Automerge-Triggered-By: GH:AlexWaygood
2023-01-02 03:49:06 -08:00
1aab269d4a
gh-100201: Document behavior with a bare `yield` statement ( #100416 )
...
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2023-01-01 21:06:13 +05:30
f59c7f8edd
GH-85979: Clarify specification of `object.__await__` ( #22320 )
...
Co-authored-by: Kumar Aditya <59607654+kumaraditya303@users.noreply.github.com>
2022-12-31 11:54:04 +05:30
f3db68e6e6
gh-48496: Added example and link to faq for UnboundLocalError in reference ( #93068 )
2022-12-22 17:23:25 -06:00
f23236a92d
"Compound statement" docs: Fix with-statement step indexing ( #100286 )
...
Back in commit 226e6e7d43
2022-12-16 18:43:43 +00:00
Paulo Freitas