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

Merged
ZeroIntensity merged 19 commits into from
Jul 18, 2026
Merged

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

Show file tree
Hide file tree
Changes from 10 commits
Commits
Show all changes
19 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
42b775b
Merge branch 'main' into doc-pyframe-unstable
ZeroIntensity Jun 24, 2026
e8cd832
Merge branch 'main' of https://github.com/python/cpython into doc-pyf…
ZeroIntensity Jun 24, 2026
2cffd86
Address feedback.
ZeroIntensity Jun 24, 2026
a92546c
Fix stray newline change.
ZeroIntensity Jun 24, 2026
561c580
Fix stupid lint.
ZeroIntensity Jun 24, 2026
5c56ebb
Fix missing type.
ZeroIntensity Jun 24, 2026
e5e6937
Merge branch 'main' into doc-pyframe-unstable
ZeroIntensity Jul 18, 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
60 changes: 60 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,63 @@ 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

// Check if a frame should be skipped
if (kind == PyUnstable_EXECUTABLE_KIND_SKIP) {

@encukou encukou Jan 30, 2026

Copy link
Copy Markdown
Member

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?

@Yashp002 Yashp002 Jan 31, 2026

Copy link
Copy Markdown
Contributor Author

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?

@encukou encukou Feb 3, 2026 •
edited
Loading

Copy link
Copy Markdown
Member

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.

@ZeroIntensity ZeroIntensity Jun 24, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Yeah, there's no API for getting kind. The only way to get the right thing is to check the type, but at that point, you don't need PyUnstable_ExecutableKinds anyway (because the whole point of it is that you're not supposed to know the type in advance). This API is quite literally useless. I think we should remove it in 3.16, but for completeness, I want this documented in 3.13+.

// This is an internal frame (like a Tier 2 optimizer frame)
// Tools should ignore it.
continue;
}

.. versionadded:: 3.13


.. c:macro:: PyUnstable_EXECUTABLE_KIND_PY_FUNCTION

Index for the "Python function" kind in ``PyUnstable_ExecutableKinds``.

@ZeroIntensity ZeroIntensity Jan 8, 2026

Copy link
Copy Markdown
Member

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
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