Skip to content

gh-141004: Document unstable executable kind macros in pyframe.h #143490

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
Yashp002 wants to merge 12 commits into
base: main
Choose a base branch
from
Open

gh-141004: Document unstable executable kind macros in pyframe.h #143490

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
1efbe41
first unstable py
Yashp002 Jan 6, 2026
4572008
fix 1
Yashp002 Jan 6, 2026
54495a2
fix 2(version)
Yashp002 Jan 6, 2026
e8097b1
fix 2 pyframe
Yashp002 Jan 7, 2026
9c1492f
fix 3 pyframe
Yashp002 Jan 8, 2026
a0b1951
fix 4 pyframe
Yashp002 Jan 8, 2026
927383b
fix 5 pyframe
Yashp002 Jan 22, 2026
e51340a
Merge branch 'main' into doc-pyframe-unstable
Yashp002 Jan 22, 2026
3fafd77
fix 6 pyframe
Yashp002 Jan 22, 2026
45e9a6d
pyframe fix 7
Yashp002 Jan 22, 2026
43e9c9f
pyframe fix 8
Yashp002 Feb 5, 2026
efe7161
pyframe fix 9-test
Yashp002 Feb 6, 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
59 changes: 59 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 @@ -250,3 +250,62 @@ Unless using :pep:`523`, you will not need this.
.. versionadded:: 3.12


.. c:type:: PyUnstable_ExecutableKinds

An array of executable kinds (executor types) for frames, used for internal
debugging and tracing.

Tools like debuggers and profilers can use this to identify the type of execution
context associated with a frame (For example: to filter out internal frames).
The entries are indexed by the following constants:

.. list-table::
:header-rows: 1
:widths: auto

* - Constant
- Description
* - .. c:macro:: PyUnstable_EXECUTABLE_KIND_SKIP
- The frame is internal (For example: inlined) and should be skipped by tools.
* - .. c:macro:: PyUnstable_EXECUTABLE_KIND_PY_FUNCTION
- The frame corresponds to a standard Python function.

Example usage:

.. code-block:: c

int kind = PyUnstable_Frame_GetExecutableKind(frame);

if (kind == PyUnstable_EXECUTABLE_KIND_SKIP) {
Copy link
Member

@encukou encukou Jan 30, 2026

Choose a reason for hiding this comment

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

What is kind? How do you get it?

Copy link
Contributor Author

@Yashp002 Yashp002 Jan 31, 2026

Choose a reason for hiding this comment

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

@encukou kind here refers to the executable kind field stored in the frame's executor (e.g. _PyFrame_GetExecutableKind(frame))
Do you think it's better to explicitly show _PyFrame_GetExecutableKind (if exposed), or should I just remove the example block to avoid confusion?

Copy link
Member

@encukou encukou Feb 3, 2026 •
edited
Loading

Choose a reason for hiding this comment

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

Yes, explicitly show your _PyFrame_GetExecutableKind. We'll also need to make it public (or at least unstable) if we want users to use it.

continue;
}

.. versionadded:: 3.13


.. c:macro:: PyUnstable_EXECUTABLE_KIND_PY_FUNCTION

Index for the "Python function" kind in ``PyUnstable_ExecutableKinds``.
Copy link
Member

@ZeroIntensity ZeroIntensity Jan 8, 2026

Choose a reason for hiding this comment

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

These should be links via :c:data:`PyUnstable_ExecutableKinds`


.. versionadded:: 3.13


.. c:macro:: PyUnstable_EXECUTABLE_KIND_BUILTIN_FUNCTION

Index for the "built-in function" kind in ``PyUnstable_ExecutableKinds``.

.. versionadded:: 3.13


.. c:macro:: PyUnstable_EXECUTABLE_KIND_METHOD_DESCRIPTOR

Index for the "method descriptor" kind in ``PyUnstable_ExecutableKinds``.

.. versionadded:: 3.13


.. c:macro:: PyUnstable_EXECUTABLE_KINDS

The number of entries in ``PyUnstable_ExecutableKinds``.

.. versionadded:: 3.13
1 change: 1 addition & 0 deletions Include/cpython/frameobject.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ PyAPI_FUNC(void) PyFrame_LocalsToFast(PyFrameObject *, int);
* obsolete or outdated. */

PyAPI_FUNC(int) _PyFrame_IsEntryFrame(PyFrameObject *frame);
PyAPI_FUNC(int) PyUnstable_Frame_GetExecutableKind(PyFrameObject *frame);

PyAPI_FUNC(int) PyFrame_FastToLocalsWithError(PyFrameObject *f);
PyAPI_FUNC(void) PyFrame_FastToLocals(PyFrameObject *);
Expand Down
20 changes: 19 additions & 1 deletion Modules/_testcapi/frame.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,26 @@ frame_getvarstring(PyObject *self, PyObject *args)
}


static PyObject *
test_my_doc_example(PyObject *self, PyObject *arg)
{
PyFrameObject *frame = (PyFrameObject *)PyEval_GetFrame();
if (frame == NULL) {
Py_RETURN_NONE;
}

int kind = PyUnstable_Frame_GetExecutableKind(frame);

if (kind == PyUnstable_EXECUTABLE_KIND_SKIP) {
return PyLong_FromLong(kind);
}

return PyLong_FromLong(kind);
Copy link
Member

@vstinner vstinner Feb 10, 2026

Choose a reason for hiding this comment

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

This test emits a DeprecationWarning:

ERROR: test_my_doc_example (test.test_capi.test_misc.Test_testcapi.test_my_doc_example)
----------------------------------------------------------------------
DeprecationWarning: It is deprecated to return a value that is not None from a test case (<built-in function test_my_doc_example> returned 'int')

Copy link
Contributor Author

@Yashp002 Yashp002 Feb 14, 2026

Choose a reason for hiding this comment

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

@vstinner Honestly, i think im a little stuck on this issue, could you help?

}


static PyMethodDef test_methods[] = {
{"test_my_doc_example", test_my_doc_example, METH_NOARGS, NULL},
{"frame_getlocals", frame_getlocals, METH_O, NULL},
{"frame_getglobals", frame_getglobals, METH_O, NULL},
{"frame_getgenerator", frame_getgenerator, METH_O, NULL},
Expand All @@ -131,4 +150,3 @@ _PyTestCapi_Init_Frame(PyObject *m)
{
return PyModule_AddFunctions(m, test_methods);
}

20 changes: 20 additions & 0 deletions Python/frame.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,3 +157,23 @@ const PyTypeObject *const PyUnstable_ExecutableKinds[PyUnstable_EXECUTABLE_KINDS
[PyUnstable_EXECUTABLE_KIND_METHOD_DESCRIPTOR] = &PyMethodDescr_Type,
[PyUnstable_EXECUTABLE_KINDS] = NULL,
};

PyAPI_FUNC(int)
PyUnstable_Frame_GetExecutableKind(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;
}
6 changes: 0 additions & 6 deletions Tools/check-c-api-docs/ignored_c_api.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,12 +75,6 @@ Py_UniversalNewlineFgets
PyUnstable_CopyPerfMapFile
PyUnstable_PerfTrampoline_CompileCode
PyUnstable_PerfTrampoline_SetPersistAfterFork
# cpython/pyframe.h
PyUnstable_EXECUTABLE_KINDS
PyUnstable_EXECUTABLE_KIND_BUILTIN_FUNCTION
PyUnstable_EXECUTABLE_KIND_METHOD_DESCRIPTOR
PyUnstable_EXECUTABLE_KIND_PY_FUNCTION
PyUnstable_EXECUTABLE_KIND_SKIP
# cpython/pylifecycle.h
Py_FrozenMain
# pythonrun.h
Expand Down
Loading