Skip to content

gh-138191: Document frame.f_generator in the data model #138540

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
merged 6 commits into from
Sep 5, 2025
Merged

gh-138191: Document frame.f_generator in the data model #138540

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
cd69f5b
Docs: add f_generator attribute to datamodel page and update index
Devansh-b Sep 5, 2025
c8c9956
Docs: move f_generator attribute to end of datamodel page
Devansh-b Sep 5, 2025
143a22d
Update Doc/reference/datamodel.rst
dbXD320 Sep 5, 2025
5d85385
Update Doc/reference/datamodel.rst
AA-Turner Sep 5, 2025
fdad13a
whitespace
AA-Turner Sep 5, 2025
7e44b33
whitespace
AA-Turner Sep 5, 2025
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
5 changes: 5 additions & 0 deletions Doc/reference/datamodel.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1633,6 +1633,7 @@ and are also passed to registered trace functions.

.. index::
single: f_back (frame attribute)
single: f_generator (frame attribute)
single: f_code (frame attribute)
single: f_globals (frame attribute)
single: f_locals (frame attribute)
Expand All @@ -1648,6 +1649,10 @@ Special read-only attributes
- Points to the previous stack frame (towards the caller),
or ``None`` if this is the bottom stack frame

* - .. attribute:: frame.f_generator
- Returns the generator or coroutine object that owns this frame,
or ``None`` if the frame is of a regular function.

* - .. attribute:: frame.f_code
- The :ref:`code object <code-objects>` being executed in this frame.
Accessing this attribute raises an :ref:`auditing event <auditing>`
Expand Down