Skip to content

gh-107457: update dis documentation with changes in 3.12 #108900

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
iritkatriel merged 9 commits into from
Oct 17, 2023
Merged

gh-107457: update dis documentation with changes in 3.12 #108900

Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
34250f3
doc: describe how CACHE opcodes are taken into account in jumps
MatthieuDartiailh Sep 4, 2023
e7d9021
doc: document MIN_INSTRUMENTED_OPCODE in dis
MatthieuDartiailh Sep 4, 2023
0586fec
doc: document END_SEND and fix SEND documentation
MatthieuDartiailh Sep 4, 2023
7617456
Doc: clarify CALL_INSTRINSIC_2 stack effect
MatthieuDartiailh Sep 5, 2023
6ad38e3
doc: clarify the stack manipulation of LOAD_SUPER_ATTR
MatthieuDartiailh Sep 5, 2023
3644200
Apply suggestions from code review
MatthieuDartiailh Sep 25, 2023
0a1dee2
Update dis.rst
MatthieuDartiailh Sep 28, 2023
5a93f49
docs: address review comments
MatthieuDartiailh Oct 17, 2023
4291f95
Merge branch 'main' into dis-docs
iritkatriel Oct 17, 2023
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
Prev Previous commit
Next Next commit
Apply suggestions from code review 
Co-authored-by: Carl Meyer <carl@oddbird.net>
  • Loading branch information
@MatthieuDartiailh @carljm
MatthieuDartiailh and carljm authored Sep 25, 2023
commit 364420046e6bc79585db918409f24fc98cf1d6c5
10 changes: 5 additions & 5 deletions Doc/library/dis.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -501,7 +501,7 @@ operations on it as if it was a Python list. The top of the stack corresponds to

Removes the top value from the stack.
Equivalent to ``POP_TOP``.
Used to clean up when a generator exit, hence the name.
Used to clean up when a generator exits.

.. versionadded:: 3.12

Expand Down Expand Up @@ -1151,20 +1151,20 @@ iterations of the loop.

.. opcode:: LOAD_SUPER_ATTR (namei)

This opcode implements :func:`super` both in its 0 argument form and in its
2 arguments form (e.g. ``super().method()``, ``super().attr`` and
This opcode implements :func:`super`, both in its zero-argument and
two-argument forms (e.g. ``super().method()``, ``super().attr`` and
``super(cls, self).method()``, ``super(cls, self).attr``).

It pops three values from the stack (from top of stack down):
- ``self``: the first argument to the current method
- ``cls``: the class within which the current method was defined)
- ``cls``: the class within which the current method was defined
- the global ``super``

With respect to its argument, it works similarly to :opcode:`LOAD_ATTR`,
except that ``namei`` is shifted left by 2 bits instead of 1.

The low bit of ``namei`` signals to attempt a method load, as with
:opcode:`LOAD_ATTR` which results in pushing ``None`` and the loaded method.
:opcode:`LOAD_ATTR`, which results in pushing ``None`` and the loaded method.
When it is unset a single value is pushed to the stack.

The second-low bit of ``namei``, if set, means that this was a two-argument
Expand Down