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
+99 −7
Open

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

Changes from 4 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
46 changes: 46 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,49 @@ Unless using :pep:`523`, you will not need this.
.. versionadded:: 3.12


.. c:enum:: PyUnstable_ExecutableKinds

An enumeration of the different kinds of executables (code objects) in a frame.
This can be one of the constants :c:macro:`PyUnstable_EXECUTABLE_KIND_SKIP`
or :c:macro:`PyUnstable_EXECUTABLE_KIND_PY_FUNCTION`.
Copy link
Copy Markdown
Member

@encukou encukou Jan 7, 2026

Choose a reason for hiding this comment

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

It's an array, not an enum.
Could you document what it's useful for or how to use it? That part isn't very clear to me.

Copy link
Copy Markdown
Contributor Author

@Yashp002 Yashp002 Jan 7, 2026

Choose a reason for hiding this comment

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

Please go through what i've mentioned below and let me know if its perfectly appropriate, and as soon I recieve the heads up i'll update and commit:

.. c:var:: PyUnstable_ExecutableKinds

An array of executable kinds (executor types) for frames, used for internal
debugging and tracing. The entries are indexed by the constants
:c:macro:PyUnstable_EXECUTABLE_KIND_SKIP or
:c:macro:PyUnstable_EXECUTABLE_KIND_PY_FUNCTION.

This can be used to identify the type of the code object associated with a frame.

.. versionadded:: 3.13

Copy link
Copy Markdown
Contributor Author

@Yashp002 Yashp002 Jan 8, 2026

Choose a reason for hiding this comment

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

Could @encukou or @StanFromIreland please review my suggestion above and correct it if its wrong or gimme the green light to commit this ⬆️

Copy link
Copy Markdown
Member

@encukou encukou Jan 8, 2026

Choose a reason for hiding this comment

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

I'd prefer some words on why/how you'd use this.

You can say “The entries are indexed by the following constants:”, and indent the docs for the constants. Since the entries are all similar, you could even use a compact table, like in code object flags.


.. versionadded:: 3.13
Copy link
Copy Markdown
Member

@StanFromIreland StanFromIreland Jan 22, 2026

Choose a reason for hiding this comment

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

The .. versionadded:: ... should be the last thing in a function's/macro's/type's/etc. doc, please move it after the example.



.. c:macro:: PyUnstable_EXECUTABLE_KIND_SKIP

Index for the "skip" kind in ``PyUnstable_ExecutableKinds``.
Indicates that the frame's code object should be skipped.

.. versionadded:: 3.13


.. c:macro:: PyUnstable_EXECUTABLE_KIND_PY_FUNCTION

Index for the "Python function" kind in ``PyUnstable_ExecutableKinds``.
Copy link
Copy Markdown
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



Copy link
Copy Markdown
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.

Too many blank lines.

Loading