Skip to content

gh-115937: Remove implementation details from inspect.signature() docs #116086

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
erlend-aasland merged 4 commits into from
Feb 29, 2024
Merged

gh-115937: Remove implementation details from inspect.signature() docs #116086

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
72823f5
gh-115937: Remove implementation details from inspect.signature() docs
erlend-aasland Feb 28, 2024
15a5e30
Update Doc/library/inspect.rst
erlend-aasland Feb 28, 2024
8fb6a11
Reflow
erlend-aasland Feb 28, 2024
c1dec41
Update Doc/library/inspect.rst
erlend-aasland Feb 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
gh-115937: Remove implementation details from inspect.signature() docs 
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>
  • Loading branch information
@erlend-aasland @willingc
@gpshead @JelleZijlstra
4 people committed Feb 28, 2024
commit 72823f5517c94ec924440c4df24b677fd125444c
9 changes: 6 additions & 3 deletions Doc/library/inspect.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -665,9 +665,6 @@ function.
Accepts a wide range of Python callables, from plain functions and classes to
:func:`functools.partial` objects.

If the passed object has a ``__signature__`` attribute, this function
returns it without further computations.

For objects defined in modules using stringized annotations
(``from __future__ import annotations``), :func:`signature` will
attempt to automatically un-stringize the annotations using
Expand Down Expand Up @@ -702,6 +699,12 @@ function.
Python. For example, in CPython, some built-in functions defined in
C provide no metadata about their arguments.

.. note::
Comment thread
erlend-aasland marked this conversation as resolved.
Outdated

We may use the :attr:`!__signature__` attribute to create the signature.
Comment thread
erlend-aasland marked this conversation as resolved.
Outdated
The exact semantics are an implementation detail and are subject to
unannounced changes. Consult the source code for current semantics.


.. class:: Signature(parameters=None, *, return_annotation=Signature.empty)

Expand Down