8e99495701
gh-118577: Clarify that inspect.BoundArguments prefers to put values in args (GH-119936)
2024-09-12 14:03:32 +02:00
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
103a0470e3
gh-123492: Remove unnecessary `:func:` parentheses ( #123493 )
2024-08-30 14:34:09 +03:00
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
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
83d3d7aace
gh-120773: document introspective attributes of an async generator object in the inspect module ( #120778 )
2024-06-21 10:55:36 +00:00
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
bcb435ee8f
docs: module page titles should not start with a link to themselves ( #117099 )
2024-05-08 20:34:40 +01:00
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
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
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
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
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
45650d1c47
gh-101100: Fix most Sphinx nitpicks in `inspect.rst` ( #112662 )
2023-12-03 17:32:49 +00:00
4ed46d2244
Run more `inspect.rst` code snippets in CI ( #112654 )
2023-12-03 11:50:22 +00:00
fc9e24b01f
gh-112316: improve docs for `inspect.signature` and `inspect.Signature` ( #112631 )
2023-12-03 01:37:34 -08:00
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
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
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
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
77e9aae383
Docs: Avoid the deprecated ``.. cmdoption::`` directive ( #110292 )
2023-10-03 17:38:12 +00:00
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
6f8411cfd6
gh-108857: improve markup in inspect.Signature.replace() docs ( #108862 )
2023-09-05 17:27:59 -07: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
b6132085ca
gh-98239: Document that `inspect.getsource()` can raise `TypeError` ( #101689 )
2023-03-23 19:35:02 +00:00
ced13c96a4
gh-79940: add introspection API for asynchronous generators to `inspect` module ( #11590 )
2023-03-11 18:49:40 +05:30
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
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
532aa4e4e0
gh-94912: Added marker for non-standard coroutine function detection ( #99247 )
...
This introduces a new decorator `@inspect.markcoroutinefunction`,
which, applied to a sync function, makes it appear async to
`inspect.iscoroutinefunction()`.
2022-12-18 11:13:24 -08:00
286e3c76a9
gh-99087: Add missing newline for prompts in docs (GH-98993)
...
Add newline for prompts so copying to REPL does not cause errors.
2022-12-08 19:31:19 -08:00
7d2dcc53d0
gh-64019: Have attribute table in `inspect` docs link to module attributes instead of listing them (GH-98116)
...
Co-authored-by: Michael Anckaert <michael.anckaert@sinax.be>
2022-11-25 11:10:22 -08:00
8f30267ab4
gh-95913: Copyedit & xref FrameInfo in Whatsnew inspect section ( #98304 )
2022-10-22 20:12:04 +01:00
3440d197a5
Docs: remove redundant "adverb-adjective" hyphens from compound modifiers (GH-94551)
...
Discussion: https://discuss.python.org/t/slight-grammar-fix-throughout-adverbs-dont-need-hyphen/17021
2022-07-05 11:16:10 +02:00
b86d783a4e
bpo-40838: document `getdoc`, `getmodule`, `getsourcefile` in `inspect` returns `None` ( #30575 )
...
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2022-05-17 18:24:35 -07:00
0daa99f68b
gh-88116: Enhance the inspect frame APIs to use the extended position information (GH-91531)
2022-04-23 03:16:48 +01:00
3257d49d23
bpo-45492: Corrected documentation for co_names in inspect library doc (GH-31456)
2022-03-02 19:03:38 +00:00
562c13f573
bpo-29418: Implement inspect.ismethodwrapper and fix inspect.isroutine for cases where methodwrapper is given (GH-19261)
...
Automerge-Triggered-By: GH:isidentical
2022-02-16 04:46:20 -08:00
c2bb29ce9a
bpo-30533: Add docs for `inspect.getmembers_static` ( #29874 )
...
* Add docs for `inspect.getmembers_static`
* update
2021-12-01 11:23:46 -08:00
d89fb9a5a6
bpo-45320: Remove long-deprecated inspect methods (GH-28618)
2021-10-20 20:48:55 +02:00
8363c53369
bpo-44530: Document the new CodeObject.co_qualname attribute (GH-27052)
2021-07-07 14:20:49 +01:00
769d7d0c66
bpo-43693 Get rid of CO_NOFREE -- it's unused (GH-26839)
...
All uses of this flag are either setting it
or in doc or tests for it. So we should be
able to get rid of it completely.
2021-06-23 09:51:44 -07:00
642fdfdc04
[doc] Fix indentation in inspect documentation (GH-24846)
2021-05-21 18:05:35 +01:00
49b26fa517
bpo-43987: Add "Annotations Best Practices" HOWTO doc. ( #25746 )
...
Add "Annotations Best Practices" HOWTO doc.
2021-05-01 21:19:24 -07:00
74613a46fc
bpo-43817: Add inspect.get_annotations(). ( #25522 )
...
Add inspect.get_annotations, which safely computes the annotations defined on an object. It works around the quirks of accessing the annotations from various types of objects, and makes very few assumptions about the object passed in. inspect.get_annotations can also correctly un-stringize stringized annotations.
inspect.signature, inspect.from_callable, and inspect.from_function now call inspect.get_annotations to retrieve annotations. This means inspect.signature and inspect.from_callable can now un-stringize stringized annotations, too.
2021-04-29 21:16:28 -07:00
a3c3ffa68e
bpo-42990: Add __builtins__ attribute to functions (GH-24559)
...
Expose the new PyFunctionObject.func_builtins member in Python as a
new __builtins__ attribute on functions.
Document also the behavior change in What's New in Python 3.10.
2021-02-18 12:35:37 +01:00
eee1c7745a
bpo-41960: Add globalns and localns parameters to inspect.signature and Signature.from_callable (GH-22583)
2020-12-24 01:45:13 +03:00
dcc997cd28
[doc] Fix erroneous backslashes in signatures and names (GH-23658)
...
The issue being resolved is shown in the 3.10 docs (if you select docs for older versions you won't see a visual glitch).
The newer sphinx version that produces the 3.10 docs doesn't treat the backslash to escape things in some situations it previously did.
2020-12-16 17:37:28 -08:00
08b47c367a
bpo-40257: Revert changes to inspect.getdoc() (GH-20073)
2020-05-18 20:25:07 +03:00
Nice Zombies
Jelle Zijlstra
Wei-Hsiang (Matt) Wang
Kirill Podoprigora
Ville Skyttä
blhsing
Jan Kaliszewski
Ned Batchelder
Nikita Sobolev
Erlend E. Aasland
Martijn Pieters
Alex Waygood
Gouvernathor
Ezio Melotti
Adam Turner
Serhiy Storchaka
nabin2004
Thomas Krennwallner
Furkan Onder
Carlton Gibson
Stanley
C.A.M. Gerlach
Pablo Galindo Salgado
Hakan Çelik
Weipeng Hong
Hugo van Kemenade
Guido van Rossum
Numerlor
larryhastings
Victor Stinner
Batuhan Taskaya
Andre Delfino