Skip to content

gh-141004: Document stack effect APIs #141843

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
merged 3 commits into from
Nov 24, 2025
+40 −0
Merged

gh-141004: Document stack effect APIs #141843

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e73dfcd
Document stack effect APIs.
ZeroIntensity Nov 22, 2025
1bb20e3
Document the jump parameter.
ZeroIntensity Nov 22, 2025
ebc1d47
Update Doc/c-api/veryhigh.rst
ZeroIntensity Nov 24, 2025
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
40 changes: 40 additions & 0 deletions Doc/c-api/veryhigh.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -396,3 +396,43 @@ Available start symbols
* :pep:`484`
.. versionadded:: 3.8
Stack Effects
^^^^^^^^^^^^^
Copy link
Member

@vstinner vstinner Nov 24, 2025

Choose a reason for hiding this comment

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

I'm not sure that these funtions belong to "The Very High Level Layer", but I cannot find a better home for them. So I'm fine with documenting them in this file.

Copy link
Member Author

@ZeroIntensity ZeroIntensity Nov 24, 2025

Choose a reason for hiding this comment

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

The ideal solution would be to move all the compiler functions to their own file, but unfortunately, we're not allowed to do that without the EB approving it (see #141811 (comment)).

.. seealso::
:py:func:`dis.stack_effect`
.. c:macro:: PY_INVALID_STACK_EFFECT
Sentinel value representing an invalid stack effect.
This is currently equivalent to ``INT_MAX``.
.. versionadded:: 3.8
.. c:function:: int PyCompile_OpcodeStackEffect(int opcode, int oparg)
Compute the stack effect of *opcode* with argument *oparg*.
On success, this function returns the stack effect; on failure, this
returns :c:macro:`PY_INVALID_STACK_EFFECT`.
.. versionadded:: 3.4
.. c:function:: int PyCompile_OpcodeStackEffectWithJump(int opcode, int oparg, int jump)
Similar to :c:func:`PyCompile_OpcodeStackEffect`, but don't include the
stack effect of jumping if *jump* is zero.
If *jump* is ``0``, this will not include the stack effect of jumping, but
if *jump* is ``1`` or ``-1``, this will include it.
On success, this function returns the stack effect; on failure, this
returns :c:macro:`PY_INVALID_STACK_EFFECT`.
.. versionadded:: 3.8
Loading