mirror of
https://github.com/python/cpython.git
synced 2025-08-02 16:13:13 +00:00
Docs: Resolve Sphinx warnings in dis.rst (#108476)
- Link to the code objects reference - Suppress link to deliberately undocumented builtins.__build_class__ - Suppress links for example methods
This commit is contained in:
parent
2b7bff0655
commit
cb1184280b
3 changed files with 14 additions and 11 deletions
|
@ -43,13 +43,13 @@ interpreter.
|
||||||
adaptive bytecode can be shown by passing ``adaptive=True``.
|
adaptive bytecode can be shown by passing ``adaptive=True``.
|
||||||
|
|
||||||
|
|
||||||
Example: Given the function :func:`myfunc`::
|
Example: Given the function :func:`!myfunc`::
|
||||||
|
|
||||||
def myfunc(alist):
|
def myfunc(alist):
|
||||||
return len(alist)
|
return len(alist)
|
||||||
|
|
||||||
the following command can be used to display the disassembly of
|
the following command can be used to display the disassembly of
|
||||||
:func:`myfunc`:
|
:func:`!myfunc`:
|
||||||
|
|
||||||
.. doctest::
|
.. doctest::
|
||||||
|
|
||||||
|
@ -862,7 +862,7 @@ iterations of the loop.
|
||||||
|
|
||||||
.. opcode:: LOAD_BUILD_CLASS
|
.. opcode:: LOAD_BUILD_CLASS
|
||||||
|
|
||||||
Pushes :func:`builtins.__build_class__` onto the stack. It is later called
|
Pushes :func:`!builtins.__build_class__` onto the stack. It is later called
|
||||||
to construct a class.
|
to construct a class.
|
||||||
|
|
||||||
|
|
||||||
|
@ -920,14 +920,14 @@ iterations of the loop.
|
||||||
.. opcode:: STORE_NAME (namei)
|
.. opcode:: STORE_NAME (namei)
|
||||||
|
|
||||||
Implements ``name = STACK.pop()``. *namei* is the index of *name* in the attribute
|
Implements ``name = STACK.pop()``. *namei* is the index of *name* in the attribute
|
||||||
:attr:`co_names` of the code object. The compiler tries to use
|
:attr:`!co_names` of the :ref:`code object <code-objects>`.
|
||||||
:opcode:`STORE_FAST` or :opcode:`STORE_GLOBAL` if possible.
|
The compiler tries to use :opcode:`STORE_FAST` or :opcode:`STORE_GLOBAL` if possible.
|
||||||
|
|
||||||
|
|
||||||
.. opcode:: DELETE_NAME (namei)
|
.. opcode:: DELETE_NAME (namei)
|
||||||
|
|
||||||
Implements ``del name``, where *namei* is the index into :attr:`co_names`
|
Implements ``del name``, where *namei* is the index into :attr:`!co_names`
|
||||||
attribute of the code object.
|
attribute of the :ref:`code object <code-objects>`.
|
||||||
|
|
||||||
|
|
||||||
.. opcode:: UNPACK_SEQUENCE (count)
|
.. opcode:: UNPACK_SEQUENCE (count)
|
||||||
|
@ -966,7 +966,8 @@ iterations of the loop.
|
||||||
value = STACK.pop()
|
value = STACK.pop()
|
||||||
obj.name = value
|
obj.name = value
|
||||||
|
|
||||||
where *namei* is the index of name in :attr:`co_names`.
|
where *namei* is the index of name in :attr:`!co_names` of the
|
||||||
|
:ref:`code object <code-objects>`.
|
||||||
|
|
||||||
.. opcode:: DELETE_ATTR (namei)
|
.. opcode:: DELETE_ATTR (namei)
|
||||||
|
|
||||||
|
@ -975,7 +976,8 @@ iterations of the loop.
|
||||||
obj = STACK.pop()
|
obj = STACK.pop()
|
||||||
del obj.name
|
del obj.name
|
||||||
|
|
||||||
where *namei* is the index of name into :attr:`co_names`.
|
where *namei* is the index of name into :attr:`!co_names` of the
|
||||||
|
:ref:`code object <code-objects>`.
|
||||||
|
|
||||||
|
|
||||||
.. opcode:: STORE_GLOBAL (namei)
|
.. opcode:: STORE_GLOBAL (namei)
|
||||||
|
|
|
@ -1039,12 +1039,14 @@ A few types used internally by the interpreter are exposed to the user. Their
|
||||||
definitions may change with future versions of the interpreter, but they are
|
definitions may change with future versions of the interpreter, but they are
|
||||||
mentioned here for completeness.
|
mentioned here for completeness.
|
||||||
|
|
||||||
.. index:: bytecode, object; code, code object
|
|
||||||
|
|
||||||
|
.. _code-objects:
|
||||||
|
|
||||||
Code objects
|
Code objects
|
||||||
^^^^^^^^^^^^
|
^^^^^^^^^^^^
|
||||||
|
|
||||||
|
.. index:: bytecode, object; code, code object
|
||||||
|
|
||||||
Code objects represent *byte-compiled* executable Python code, or :term:`bytecode`.
|
Code objects represent *byte-compiled* executable Python code, or :term:`bytecode`.
|
||||||
The difference between a code object and a function object is that the function
|
The difference between a code object and a function object is that the function
|
||||||
object contains an explicit reference to the function's globals (the module in
|
object contains an explicit reference to the function's globals (the module in
|
||||||
|
|
|
@ -57,7 +57,6 @@ Doc/library/dbm.rst
|
||||||
Doc/library/decimal.rst
|
Doc/library/decimal.rst
|
||||||
Doc/library/devmode.rst
|
Doc/library/devmode.rst
|
||||||
Doc/library/difflib.rst
|
Doc/library/difflib.rst
|
||||||
Doc/library/dis.rst
|
|
||||||
Doc/library/doctest.rst
|
Doc/library/doctest.rst
|
||||||
Doc/library/email.charset.rst
|
Doc/library/email.charset.rst
|
||||||
Doc/library/email.compat32-message.rst
|
Doc/library/email.compat32-message.rst
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue