Skip to content

gh-152105: Remove docs snippet that uses internal C API #155122

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

Open
encukou wants to merge 2 commits into
base: main
Choose a base branch
from
+2 −23
Open

gh-152105: Remove docs snippet that uses internal C API #155122

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
88ee59e
gh-141004: Remove docs snippet that uses internal C API
encukou Aug 3, 2026
76359dd
APIs
encukou Aug 4, 2026
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
25 changes: 2 additions & 23 deletions Doc/c-api/frame.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -269,29 +269,8 @@ Unless using :pep:`523`, you will not need this.
* - .. c:macro:: PyUnstable_EXECUTABLE_KIND_METHOD_DESCRIPTOR
- The frame corresponds to a method on a class instance.

However, Python's C API lacks a function to read the executable kind from
a frame. Instead, use this recipe:

.. code-block:: c

int
get_executable_kind(PyFrameObject *frame)
{
_PyInterpreterFrame *f = frame->f_frame;
PyObject *exec = PyStackRef_AsPyObjectBorrow(f->f_executable);

if (PyCode_Check(exec)) {
return PyUnstable_EXECUTABLE_KIND_PY_FUNCTION;
}
if (PyMethod_Check(exec)) {
return PyUnstable_EXECUTABLE_KIND_BUILTIN_FUNCTION;
}
if (Py_IS_TYPE(exec, &PyMethodDescr_Type)) {
return PyUnstable_EXECUTABLE_KIND_METHOD_DESCRIPTOR;
}

return PyUnstable_EXECUTABLE_KIND_SKIP;
}
Note that reading the executable kind from a frame is currently only
possible with undocumented internal APIs.

.. versionadded:: 3.13

Expand Down
Loading