From: Erlend E. Aasland Date: Thu, 29 Feb 2024 09:42:28 +0000 (+0100) Subject: gh-115937: Remove implementation details from inspect.signature() docs (#116086) X-Git-Tag: v3.13.0a5~187 X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=fb2e17b642fc3089e4f98e4bf6b09dd362e6b27d;p=thirdparty%2FPython%2Fcpython.git gh-115937: Remove implementation details from inspect.signature() docs (#116086) Co-authored-by: Carol Willing Co-authored-by: Gregory P. Smith Co-authored-by: Jelle Zijlstra --- diff --git a/Doc/library/inspect.rst b/Doc/library/inspect.rst index 8a74cadb98a0..ed8d705da3b0 100644 --- a/Doc/library/inspect.rst +++ b/Doc/library/inspect.rst @@ -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 @@ -702,6 +699,13 @@ function. Python. For example, in CPython, some built-in functions defined in C provide no metadata about their arguments. + .. impl-detail:: + + If the passed object has a :attr:`!__signature__` attribute, + we may use it to create the signature. + 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)