mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-08-31 14:07:50 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 9
118681 commits 7 branches 624 tags 2.5 GiB
Commit graph

189 commits

Author SHA1 Message Date
Hugo van Kemenade
54fcfbde30
[3.12] gh-101100: Improve documentation on function attributes (GH-112933) (#112974) 
(cherry picked from commit 4c5b9c107a)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
 2023-12-12 10:10:27 +00:00
Miss Islington (bot)
b39e90e4d1
[3.12] gh-101100: Improve documentation for attributes on instance methods (GH-112832) (#112872) 
gh-101100: Improve documentation for attributes on instance methods (GH-112832)
(cherry picked from commit ed21d0c1f4)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
 2023-12-08 13:25:52 +00:00
Alex Waygood
ca11aec98c
[3.12] gh-101100: Improve documentation of code object attributes (#112781) (#112816) 
(cherry-picked from commit e9707d3c3d)
 2023-12-06 22:11:53 +00:00
Miss Islington (bot)
ef92e9e666
[3.12] gh-101100: Properly document frame object attributes (GH-112735) (#112772) 
gh-101100: Properly document frame object attributes (GH-112735)
(cherry picked from commit d109f637c0)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
 2023-12-05 19:34:06 +00:00
Miss Islington (bot)
5608112fa9
[3.12] gh-101100: Fix most Sphinx nitpicks in inspect.rst (GH-112662) (#112666) 
gh-101100: Fix most Sphinx nitpicks in `inspect.rst` (GH-112662)
(cherry picked from commit 45650d1c47)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
 2023-12-03 17:39:26 +00:00
Miss Islington (bot)
12083c0299
[3.12] Run more inspect.rst code snippets in CI (GH-112654) (#112655) 
Run more `inspect.rst` code snippets in CI (GH-112654)
(cherry picked from commit 4ed46d2244)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
 2023-12-03 11:57:15 +00:00
Alex Waygood
6221482f0c
[3.12] gh-112316: improve docs for inspect.signature and inspect.Signature (#112631) (#112649) 
(cherry-picked from commit fc9e24b01f)
 2023-12-03 11:26:53 +00:00
Alex Waygood
e3c7947770
[3.12] gh-112316: Improve docs of inspect.signature and Signature.from_callable (#112317) (#112629) 
gh-112316: Improve docs of `inspect.signature` and `Signature.from_callable` (#112317)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
 2023-12-02 22:38:11 +00:00
Miss Islington (bot)
6a5aab0cb4
[3.12] gh-106310 - document the __signature__ attribute (GH-106311) (#111145) 
Co-authored-by: Gouvernathor <44340603+Gouvernathor@users.noreply.github.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
 2023-10-23 18:49:12 +03:00
Miss Islington (bot)
cae968ba17
[3.12] gh-110631: Fix reST indentation in Doc/library (GH-110685) (#110736) 
gh-110631: Fix reST indentation in `Doc/library` (GH-110685)

Fix wrong indentation in the Doc/library dir.
(cherry picked from commit bb7923f556)

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
 2023-10-11 23:11:28 +02:00
Adam Turner
4c0f42bbc6
[3.12] Docs: Avoid the deprecated `.. cmdoption::` directive (GH-110292) (#110302) 
[3.12] Docs: Avoid the deprecated ``.. cmdoption::`` directive (GH-110292).
(cherry picked from commit 77e9aae383)
 2023-10-03 20:55:29 +03:00
Miss Islington (bot)
d7869ec22a
[3.12] gh-108857: improve markup in inspect.Signature.replace() docs (GH-108862) (#108971) 
gh-108857: improve markup in inspect.Signature.replace() docs (GH-108862)
(cherry picked from commit 6f8411cfd6)

Co-authored-by: nabin2004 <107109731+nabin2004@users.noreply.github.com>
 2023-09-06 00:39:21 +00: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
Furkan Onder
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
Carlton Gibson
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
Stanley
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
Stanley
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
C.A.M. Gerlach
8f30267ab4
gh-95913: Copyedit & xref FrameInfo in Whatsnew inspect section (#98304) 2022-10-22 20:12:04 +01:00
Ned Batchelder
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
Nikita Sobolev
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
Pablo Galindo Salgado
0daa99f68b
gh-88116: Enhance the inspect frame APIs to use the extended position information (GH-91531) 2022-04-23 03:16:48 +01:00
slateny
3257d49d23
bpo-45492: Corrected documentation for co_names in inspect library doc (GH-31456) 2022-03-02 19:03:38 +00:00
Hakan Çelik
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
Weipeng Hong
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
Hugo van Kemenade
d89fb9a5a6
bpo-45320: Remove long-deprecated inspect methods (GH-28618) 2021-10-20 20:48:55 +02:00
Pablo Galindo
8363c53369
bpo-44530: Document the new CodeObject.co_qualname attribute (GH-27052) 2021-07-07 14:20:49 +01:00
Guido van Rossum
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
Numerlor
642fdfdc04
[doc] Fix indentation in inspect documentation (GH-24846) 2021-05-21 18:05:35 +01:00
larryhastings
49b26fa517
bpo-43987: Add "Annotations Best Practices" HOWTO doc. (#25746) 
Add "Annotations Best Practices" HOWTO doc.
 2021-05-01 21:19:24 -07:00
larryhastings
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
Victor Stinner
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
Batuhan Taskaya
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
Andre Delfino
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
Serhiy Storchaka
08b47c367a
bpo-40257: Revert changes to inspect.getdoc() (GH-20073) 2020-05-18 20:25:07 +03:00
Serhiy Storchaka
fbf2786c4c
bpo-40257: Output object's own docstring in pydoc (GH-19479) 2020-04-15 23:00:20 +03:00
Inada Naoki
2110551761
bpo-39775: inspect: Change Signature.parameters back to OrderedDict. (GH-18684) 2020-03-02 18:54:48 +09:00
Rémi Lapeyre
2cca8efe46 bpo-36350: inspect: Replace OrderedDict with dict. (GH-12412) 2020-01-28 21:47:03 +09:00
Parth Sharma
f522a6ddb6 bpo-38918: Add __module__ entry for function & method type in inspect docs table (GH-17408) 
Adds` __module__ ` entries for function & method types in inspect docs table.





https://bugs.python.org/issue38918
 2019-12-20 11:18:33 -08:00
HongWeipeng
84f2528d48 Fix the description of isdatadescriptor in inspect.rst (#16645) 2019-11-15 23:47:26 +02:00
Serhiy Storchaka
138ccbb022
bpo-38738: Fix formatting of True and False. (GH-17083) 
* "Return true/false" is replaced with "Return ``True``/``False``"
  if the function actually returns a bool.
* Fixed formatting of some True and False literals (now in monospace).
* Replaced "True/False" with "true/false" if it can be not only bool.
* Replaced some 1/0 with True/False if it corresponds the code.
* "Returns <bool>" is replaced with "Return <bool>".
 2019-11-12 16:57:03 +02:00
Serhiy Storchaka
2085bd0877
bpo-37116: Use PEP 570 syntax for positional-only parameters. (GH-13700) 2019-06-01 11:00:15 +03:00
Pablo Galindo
b76302ddd0 bpo-36540: Documentation for PEP570 - Python positional only arguments (#13202) 
* bpo-36540: Documentation for PEP570 - Python positional only arguments

* fixup! bpo-36540: Documentation for PEP570 - Python positional only arguments

* Update reference for compound statements

* Apply suggestions from Carol

Co-Authored-By: Carol Willing <carolcode@willingconsulting.com>

* Update Doc/tutorial/controlflow.rst

Co-Authored-By: Carol Willing <carolcode@willingconsulting.com>

* Add extra bullet point and minor edits
 2019-05-28 16:45:32 -07:00
Pablo Galindo
aee19f54f6
bpo-36751: Undeprecate getfullargspec (GH-13245) 2019-05-16 21:08:15 +01:00
Pablo Galindo
d5d2b45469
bpo-36751: Deprecate getfullargspec and report positional-only args as regular args (GH-13016) 
* bpo-36751: Deprecate getfullargspec and report positional-only args as regular args

* Use inspect.signature in testhelpers
 2019-04-30 02:01:14 +01:00
Lysandros Nikolaou
1aeeaeb79e bpo-21314: Add a FAQ entry about positional only parameters (GH-10641) 2019-03-10 21:30:11 +10:00
Pablo Galindo
7cd2543416
bpo-34890: Make iscoroutinefunction, isgeneratorfunction and isasyncgenfunction work with functools.partial (GH-9903) 
inspect.isfunction() processes both inspect.isfunction(func) and
inspect.isfunction(partial(func, arg)) correctly but some other functions in the
inspect module (iscoroutinefunction, isgeneratorfunction and isasyncgenfunction)
lack this functionality. This commits adds a new check in the mentioned functions
in the inspect module so they can work correctly with arbitrarily nested partial
functions.
 2018-10-26 12:19:14 +01:00
Stéphane Wirtel
1770d1c512 bpo-35038: AttributeError: 'frame' object has no attribute 'f_restricted'. (GH-10098) 
https://bugs.python.org/issue35038
 2018-10-25 14:13:45 -07:00