Skip to content

GH-96803: Document and test new unstable internal frame API functions #104211

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
markshannon merged 9 commits into from
May 18, 2023
Merged

GH-96803: Document and test new unstable internal frame API functions #104211

Changes from 2 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
9bcf13a
Document new unstable internal frame API functions
markshannon May 5, 2023
c144a62
Weaken contract of PyUnstable_InterpreterFrame_GetCode to return PyOb…
markshannon May 5, 2023
dea0300
Add tests
markshannon May 5, 2023
2a82445
Use correct sphinx tag
markshannon May 5, 2023
b9d25c5
Merge branch 'main' into doc-internal-frame-api
markshannon May 5, 2023
1e7a1a0
Apply suggestions from code review
markshannon May 6, 2023
37a96e2
Merge branch 'main' into doc-internal-frame-api
markshannon May 5, 2023
86865b5
Apply suggestions from code review
markshannon May 16, 2023
31e386c
Update Doc/c-api/frame.rst
markshannon May 16, 2023
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
34 changes: 34 additions & 0 deletions Doc/c-api/frame.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,3 +130,37 @@ See also :ref:`Reflection <reflection>`.
.. c:function:: int PyFrame_GetLineNumber(PyFrameObject *frame)

Return the line number that *frame* is currently executing.



Internal Frames
---------------

Unless using PEP 523, you will not need this.
Comment thread
markshannon marked this conversation as resolved.
Outdated

.. c:type:: struct _PyInterpreterFrame
Comment thread
AA-Turner marked this conversation as resolved.
Outdated

The interpreter's internal frame representation.

Comment thread
markshannon marked this conversation as resolved.

.. c:function:: PyCodeObject* PyUnstable_InterpreterFrame_GetCode(struct _PyInterpreterFrame *frame);

Return a :term:`strong reference` to the code object for the frame.

.. versionadded:: 3.12


.. c:function:: int PyUnstable_InterpreterFrame_GetLasti(struct _PyInterpreterFrame *frame);

Return the byte offset into the last executed instruction.

.. versionadded:: 3.12


.. c:function:: int PyUnstable_InterpreterFrame_GetLine(struct _PyInterpreterFrame *frame);

Return the currently executing line number, or -1 if there is no line number.
Comment thread
markshannon marked this conversation as resolved.
Outdated

.. versionadded:: 3.12