From ac3fa694e8f32d2448922516598845a0abb1e722 Mon Sep 17 00:00:00 2001 From: "Erlend E. Aasland" Date: Thu, 29 Feb 2024 10:42:28 +0100 Subject: [PATCH] gh-115937: Remove implementation details from inspect.signature() docs (GH-116086) (cherry picked from commit fb2e17b642fc3089e4f98e4bf6b09dd362e6b27d) Co-authored-by: Erlend E. Aasland Co-authored-by: Carol Willing Co-authored-by: Gregory P. Smith Co-authored-by: Jelle Zijlstra --- Doc/library/inspect.rst | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/Doc/library/inspect.rst b/Doc/library/inspect.rst index a1178cfccddf82..c4c381bb8335b8 100644 --- a/Doc/library/inspect.rst +++ b/Doc/library/inspect.rst @@ -655,9 +655,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 @@ -692,6 +689,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)