FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

gh-108901: Add `inspect.Signature.from_frame` by sobolevn · Pull Request #116537 · python/cpython · GitHub

/ cpython Public

gh-108901: Add inspect.Signature.from_frame - #116537

Open
sobolevn wants to merge 7 commits into
python:mainfrom
sobolevn:issue-108901-signature-from_frame
Open

gh-108901: Add inspect.Signature.from_frame#116537
sobolevn wants to merge 7 commits into
python:mainfrom
sobolevn:issue-108901-signature-from_frame

Conversation

sobolevn commented Mar 9, 2024
edited
Loading

Copy link
Copy Markdown
Member

I had to go with a bigger diff, but easier code and probably more optimal one.
The main reason was that creating types.FunctionType is not trivial, for example, it required the correct amount of __closure__ vars for a code object. So, let's not create it: it will reduce the amount of possible errors.

First PR: #112639


📚 Documentation preview 📚: https://cpython-previews--116537.org.readthedocs.build/

Comment thread Doc/library/inspect.rst Outdated
Comment thread Lib/inspect.py Outdated
Comment thread Lib/test/test_inspect/test_inspect.py Outdated
Comment thread Doc/library/inspect.rst Outdated

vstinner left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

LGTM

Copy link
Copy Markdown
Member

I haven't really got the bandwidth to look at this right now, sorry :)

AlexWaygood removed their request for review March 10, 2024 08:59

Copy link
Copy Markdown
Member

cc @serhiy-storchaka @pitrou

Comment thread Lib/test/test_inspect/test_inspect.py Outdated

sobolevn commented Mar 10, 2024
edited
Loading

Copy link
Copy Markdown
Member Author

I agree, we should drop the defaults part.

>>> import sys, inspect
>>> def f(x=1):
...    print(inspect.getargvalues(sys._getframe()))
...
>>> f()
ArgInfo(args=['x'], varargs=None, keywords=None, locals={'x': 1})

Current API does not show defaults, only locals. But, locals are stored as .f_locals, it is a stable API. Users can use .f_locals to populate defaults, it is quite easy. Later we can add defaults support if users ask for it.

Showing defaults is also not safe in this case by default, for example we can leak things like passwords or secret keys.

Copy link
Copy Markdown
Member

I agree, we should drop the defaults part.

I looked at tests where the frame is captured whereas frame locals are not modified, so "it just works" magically. But if I look at the test which modify a variable, I now understand how wrong it is. A frame local is not a function default parameter value: they are two different things. signature() is the signature, before the function is called. Frame locals is the "live state" of a frame, it's unrelated.

Moreover, frame locals can contain sensitive information (like a password) which should not be exposed in a signature.

Copy link
Copy Markdown
Member Author

Updated, now defaults are not shown. Right now this is very close to getargvalues:

>>> import sys, inspect
>>> def f(x=1):
...    print(inspect.getargvalues(sys._getframe()))
...
>>> f()
ArgInfo(args=['x'], varargs=None, keywords=None, locals={'x': 1})

And we are trying to replace this old function, so I guess it is fine :)

hugovk removed their request for review October 24, 2024 18:00

hugovk commented Oct 24, 2024

Copy link
Copy Markdown
Member

(This has a merge conflict)

Copy link
Copy Markdown
Member

@sobolevn: Can you please try to fix the merge conflict?

Comment thread Doc/library/inspect.rst
in a function inside ``__defaults__``, ``__kwdefaults__``,
and ``__annotations__`` attributes.

.. versionadded:: 3.13

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality
Suggested change
.. versionadded:: 3.13
.. versionadded:: next

Comment thread Doc/whatsnew/3.13.rst
inspect
-------

* Add :meth:`inspect.Signature.from_frame` to get signatures from frame objects.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Don't we need the "Contributed by" part? (to have the issue number)

Copy link
Copy Markdown

This PR is stale because it has been open for 30 days with no activity.

github-actions Bot added the stale Stale PR or inactive for long period of time. label Apr 15, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

awaiting merge stale Stale PR or inactive for long period of time.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants


Back | FazBrowse Home | New Git URL