Skip to content

GH-88756: Update docs for PEP 523 eval function type. #91788

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 5 commits into from
Apr 21, 2022
Merged

GH-88756: Update docs for PEP 523 eval function type. #91788

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ef5f888
Update docs for PEP 523 eval function type.
markshannon Apr 21, 2022
e690b1f
Add versionchanged info to _PyFrameEvalFunction docs.
markshannon Apr 21, 2022
7b298fa
fix typo
markshannon Apr 21, 2022
2ee4cd6
Update Doc/whatsnew/3.11.rst
markshannon Apr 21, 2022
28c6411
Update Doc/c-api/init.rst
markshannon Apr 21, 2022
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: 4 additions & 1 deletion Doc/c-api/init.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1228,7 +1228,7 @@ All of the following functions must be called after :c:func:`Py_Initialize`.

.. versionadded:: 3.8

.. c:type:: PyObject* (*_PyFrameEvalFunction)(PyThreadState *tstate, PyFrameObject *frame, int throwflag)
.. c:type:: PyObject* (*_PyFrameEvalFunction)(PyThreadState *tstate, _PyInterpreterFrame *frame, int throwflag)

Type of a frame evaluation function.

Expand All @@ -1238,6 +1238,9 @@ All of the following functions must be called after :c:func:`Py_Initialize`.
.. versionchanged:: 3.9
The function now takes a *tstate* parameter.

.. versionchanged:: 3.11
The *frame* parameter changed from ``PyFrameObject *`` to ``_PyInterpreterFrame *``.

.. c:function:: _PyFrameEvalFunction _PyInterpreterState_GetEvalFrameFunc(PyInterpreterState *interp)

Get the frame evaluation function.
Expand Down
4 changes: 4 additions & 0 deletions Doc/whatsnew/3.11.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1155,6 +1155,10 @@ C API Changes
be used for ``size``.
(Contributed by Kumar Aditya in :issue:`46608`.)

* :c:func:`_PyFrameEvalFunction` now takes :c:struct:`_PyInterpreterFrame`
as its second parameter, instead of :c:struct:`PyFrameObject`.
See PEP 523 for more details of how to use this function pointer type.

New Features
------------

Expand Down