Ned Batchelder
852ec18978
Docs: remove unneeded author attributions ( #145002 )
...
These directives are not maintained and misleadingly indicate individual
rather than community ownership.
See https://github.com/python/docs-community/issues/180 for discussion,
and https://github.com/python/devguide/pull/1740 for an update to the
devguide.
Also ensured that everyone is in the Misc/ACKS file.
2026-02-19 18:45:28 -05:00
Hugo van Kemenade
15b216f30d
Python 3.15.0a6
2026-02-11 14:23:15 +02:00
Ned Batchelder
638d22c6e7
Docs: module pages should not link to themselves ( #144505 )
...
* Docs: module pages should not link to themselves
* fix header punctuation
2026-02-06 06:48:27 -05:00
Sam Gross
7e2c9bdc98
gh-120321: Add gi_state, cr_state, and ag_state attributes (gh-144409)
...
Add `gi_state`, `cr_state`, and `ag_state` attributes to generators,
coroutines, and async generators respectively. These attributes return the
current state as a string (e.g., `GEN_RUNNING`, `CORO_SUSPENDED`).
The `inspect.getgeneratorstate()`, `inspect.getcoroutinestate()`, and
`inspect.getasyncgenstate()` functions now return these attributes directly.
This is in preparation for making `gi_frame` thread-safe, which may involve
stop-the-world synchronization. The new state attributes avoid potential
performance cliffs in `inspect.getgeneratorstate()` and similar functions by
not requiring frame access.
Also removes unused `FRAME_COMPLETED` state and renumbers the frame state enum
to start at 0 instead of -1.
2026-02-03 13:06:32 -05:00
Yongtao Huang
f3dd0cae6c
Doc: fix incorrect reference in isasyncgenfunction docs (GH-144099)
...
Fix incorrect reference in isasyncgenfunction docs
2026-01-23 09:06:47 +01:00
wangxiaolei
0efbad60e1
gh-142994, gh-142996: document missing async generator and coroutine field entries in inspect ( #142997 )
2025-12-28 19:03:30 +01:00
SYan212
39ecb17103
typo fixes in docs ( #142683 )
2025-12-14 13:47:22 +05:30
Hugo van Kemenade
a62562859d
Python 3.15.0a2
2025-11-18 16:51:17 +02:00
Semyon Moroz
cc6b62ac56
gh-130160: Add anchors to CLI Usage section for cmdline ( #133182 )
2025-11-17 14:51:21 +00:00
Jacob Austin Lincoln
70748bdbea
gh-131116: Fix inspect.getdoc() to work with cached_property objects (GH-131165)
2025-11-12 10:07:21 +00:00
Serhiy Storchaka
7906f4d96a
gh-132686: Add parameters inherit_class_doc and fallback_to_class_doc for inspect.getdoc() (GH-132691)
2025-11-12 00:01:25 +02:00
Donghoon Nam
c025576a8f
gh-138966: Add description for gi_suspended attribute (GH-139008)
2025-09-17 04:21:52 -04:00
Adam Turner
22cb9ba8f9
GH-101100: Remove some entries from `nitpick_ignore` ( #138464 )
2025-09-08 22:10:26 +00:00
Jelle Zijlstra
9158bcf86b
annotationlib: add note on security to docs ( #138508 )
2025-09-05 08:26:58 -07:00
Hugo van Kemenade
3ae9101482
Python 3.14.0a5
2025-02-11 19:16:29 +02:00
Yury Selivanov
188598851d
GH-91048: Add utils for capturing async call stack for asyncio programs and enable profiling ( #124640 )
...
Signed-off-by: Pablo Galindo <pablogsal@gmail.com>
Co-authored-by: Pablo Galindo <pablogsal@gmail.com>
Co-authored-by: Kumar Aditya <kumaraditya@python.org>
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
Co-authored-by: Savannah Ostrowski <savannahostrowski@gmail.com>
Co-authored-by: Jacob Coffee <jacob@z7x.org>
Co-authored-by: Irit Katriel <1055913+iritkatriel@users.noreply.github.com>
2025-01-22 17:25:29 +01:00
mpage
255762c09f
gh-127274: Defer nested methods ( #128012 )
...
Methods (functions defined in class scope) are likely to be cleaned
up by the GC anyway.
Add a new code flag, `CO_METHOD`, that is set for functions defined
in a class scope. Use that when deciding to defer functions.
2024-12-19 13:03:14 -08:00
Xuanteng Huang
35df4eb959
gh-126072: do not add None to co_consts if there is no docstring (GH-126101)
2024-10-30 09:01:09 +00:00
Zhikang Yan
dad3453129
gh-125633: Add function ispackage to stdlib inspect ( #125634 )
...
---------
Co-authored-by: blurb-it[bot] <43283697+blurb-it[bot]@users.noreply.github.com>
2024-10-27 14:57:43 +10:00
Jelle Zijlstra
78406382c9
gh-101552: Allow pydoc to display signatures in source format ( #124669 )
...
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2024-10-09 05:03:53 +00:00
Alex Waygood
0d9d56c4e4
gh-101100: Add a table of class attributes to the "Custom classes" section of the data model docs ( #124480 )
2024-09-25 19:29:58 +00:00
Nice Zombies
8e99495701
gh-118577: Clarify that inspect.BoundArguments prefers to put values in args (GH-119936)
2024-09-12 14:03:32 +02:00
Jelle Zijlstra
5436d8b9c3
gh-119180: Documentation for PEP 649 and 749 ( #122235 )
...
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>
Co-authored-by: Carol Willing <carolcode@willingconsulting.com>
2024-09-11 07:49:59 -07:00
Wei-Hsiang (Matt) Wang
103a0470e3
gh-123492: Remove unnecessary :func: parentheses ( #123493 )
2024-08-30 14:34:09 +03:00
Kirill Podoprigora
8ce70d6c69
gh-122058: Lib/inspect: Update docstrings for isfunction, isgenerator, isframe, iscode. ( #122059 )
...
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
Co-authored-by: Victor Stinner <vstinner@python.org>
2024-08-06 14:47:31 +02:00
Ville Skyttä
bc264eac3a
Docs: spelling and grammar fixes ( #122084 )
...
Corrected some grammar and spelling issues in documentation.
Co-authored-by: Russell Keith-Magee <russell@keith-magee.com>
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
2024-07-22 09:14:25 +08:00
blhsing
83d3d7aace
gh-120773: document introspective attributes of an async generator object in the inspect module ( #120778 )
2024-06-21 10:55:36 +00:00
Jan Kaliszewski
dacc5ac71a
gh-120381: Fix inspect.ismethoddescriptor() ( #120383 )
...
The `inspect.ismethoddescriptor()` function did not check for the lack of
`__delete__()` and, consequently, erroneously returned True when applied
to *data* descriptors with only `__get__()` and `__delete__()` defined.
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
Co-authored-by: Alyssa Coghlan <ncoghlan@gmail.com>
2024-06-18 12:19:43 +00:00
Ned Batchelder
bcb435ee8f
docs: module page titles should not start with a link to themselves ( #117099 )
2024-05-08 20:34:40 +01:00
Nikita Sobolev
16349868d3
gh-116782: Mention __type_params__ in inspect.getmembers docs ( #116783 )
...
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2024-03-15 18:47:46 +03:00
Erlend E. Aasland
fb2e17b642
gh-115937: Remove implementation details from inspect.signature() docs ( #116086 )
...
Co-authored-by: Carol Willing <carolcode@willingconsulting.com>
Co-authored-by: Gregory P. Smith <greg@krypto.org>
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2024-02-29 09:42:28 +00:00
Martijn Pieters
edb59d5718
bpo-38364: unwrap partialmethods just like we unwrap partials ( #16600 )
...
* bpo-38364: unwrap partialmethods just like we unwrap partials
The inspect.isgeneratorfunction, inspect.iscoroutinefunction and inspect.isasyncgenfunction already unwrap functools.partial objects, this patch adds support for partialmethod objects as well.
Also: Rename _partialmethod to __partialmethod__.
Since we're checking this attribute on arbitrary function-like objects,
we should use the namespace reserved for core Python.
---------
Co-authored-by: Petr Viktorin <encukou@gmail.com>
2024-02-15 12:08:45 +01:00
Alex Waygood
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
Alex Waygood
ed21d0c1f4
gh-101100: Improve documentation for attributes on instance methods ( #112832 )
2023-12-08 13:18:53 +00:00
Alex Waygood
e9707d3c3d
gh-101100: Improve documentation of code object attributes ( #112781 )
2023-12-06 20:15:46 +00:00
Alex Waygood
d109f637c0
gh-101100: Properly document frame object attributes ( #112735 )
2023-12-05 19:27:59 +00:00
Alex Waygood
45650d1c47
gh-101100: Fix most Sphinx nitpicks in inspect.rst ( #112662 )
2023-12-03 17:32:49 +00:00
Alex Waygood
4ed46d2244
Run more inspect.rst code snippets in CI ( #112654 )
2023-12-03 11:50:22 +00:00
Alex Waygood
fc9e24b01f
gh-112316: improve docs for inspect.signature and inspect.Signature ( #112631 )
2023-12-03 01:37:34 -08:00
Nikita Sobolev
a9574c68f0
gh-112139: Add inspect.Signature.format and use it in pydoc ( #112143 )
...
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2023-12-02 15:39:43 -08:00
Nikita Sobolev
a74daba7ca
gh-112316: Improve docs of inspect.signature and Signature.from_callable ( #112317 )
...
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-12-02 13:13:44 +00:00
Gouvernathor
b07f23259d
gh-106310 - document the __signature__ attribute ( #106311 )
...
Document the __signature__ attribute
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-10-21 08:54:02 +10:00
Ezio Melotti
bb7923f556
gh-110631: Fix reST indentation in Doc/library ( #110685 )
...
Fix wrong indentation in the Doc/library dir.
2023-10-11 22:24:12 +02:00
Adam Turner
77e9aae383
Docs: Avoid the deprecated `.. cmdoption::` directive ( #110292 )
2023-10-03 17:38:12 +00:00
Serhiy Storchaka
6f3c138dfa
gh-108751: Add copy.replace() function (GH-108752)
...
It creates a modified copy of an object by calling the object's
__replace__() method.
It is a generalization of dataclasses.replace(), named tuple's _replace()
method and replace() methods in various classes, and supports all these
stdlib classes.
2023-09-06 23:55:42 +03:00
nabin2004
6f8411cfd6
gh-108857: improve markup in inspect.Signature.replace() docs ( #108862 )
2023-09-05 17:27:59 -07:00
Jelle Zijlstra
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
Nikita Sobolev
b6132085ca
gh-98239: Document that inspect.getsource() can raise TypeError ( #101689 )
2023-03-23 19:35:02 +00:00
Thomas Krennwallner
ced13c96a4
gh-79940: add introspection API for asynchronous generators to inspect module ( #11590 )
2023-03-11 18:49:40 +05:30
Gouvernathor
0db6f44259
gh-102296 Document that inspect.Parameter kinds support ordering (GH-102297)
...
Automerge-Triggered-By: GH:AlexWaygood
2023-02-27 07:13:18 -08:00
