bpo-31183: `dis` now handles coroutines & async generators (GH-3077)
Coroutines and async generators use a distinct attribute name for their
code objects, so this updates the `dis` module to correctly disassemble
objects with those attributes.
Due to the increase in the test module length, it also fixes some latent
defects in the tests related to how the displayed source line numbers
are extracted.
https://bugs.python.org/issue31230 is a follow-up issue suggesting we
may want to solve this a different way, by instead giving all these object
types a common `__code__` attribute, avoiding the need for special
casing in the `dis` module.
diff --git a/Doc/library/dis.rst b/Doc/library/dis.rst
index bc32380..7b7c84d 100644
--- a/Doc/library/dis.rst
+++ b/Doc/library/dis.rst
@@ -53,8 +53,9 @@
.. class:: Bytecode(x, *, first_line=None, current_offset=None)
- Analyse the bytecode corresponding to a function, generator, method, string
- of source code, or a code object (as returned by :func:`compile`).
+ Analyse the bytecode corresponding to a function, generator, asynchronous
+ generator, coroutine, method, string of source code, or a code object (as
+ returned by :func:`compile`).
This is a convenience wrapper around many of the functions listed below, most
notably :func:`get_instructions`, as iterating over a :class:`Bytecode`
@@ -92,6 +93,9 @@
Return a formatted multi-line string with detailed information about the
code object, like :func:`code_info`.
+ .. versionchanged:: 3.7
+ This can now handle coroutine and asynchronous generator objects.
+
Example::
>>> bytecode = dis.Bytecode(myfunc)
@@ -114,7 +118,8 @@
.. function:: code_info(x)
Return a formatted multi-line string with detailed code object information
- for the supplied function, generator, method, source code string or code object.
+ for the supplied function, generator, asynchronous generator, coroutine,
+ method, source code string or code object.
Note that the exact contents of code info strings are highly implementation
dependent and they may change arbitrarily across Python VMs or Python
@@ -122,6 +127,9 @@
.. versionadded:: 3.2
+ .. versionchanged:: 3.7
+ This can now handle coroutine and asynchronous generator objects.
+
.. function:: show_code(x, *, file=None)
@@ -141,12 +149,13 @@
.. function:: dis(x=None, *, file=None, depth=None)
Disassemble the *x* object. *x* can denote either a module, a class, a
- method, a function, a generator, a code object, a string of source code or
- a byte sequence of raw bytecode. For a module, it disassembles all functions.
- For a class, it disassembles all methods (including class and static methods).
- For a code object or sequence of raw bytecode, it prints one line per bytecode
- instruction. It also recursively disassembles nested code objects (the code
- of comprehensions, generator expressions and nested functions, and the code
+ method, a function, a generator, an asynchronous generator, a couroutine,
+ a code object, a string of source code or a byte sequence of raw bytecode.
+ For a module, it disassembles all functions. For a class, it disassembles
+ all methods (including class and static methods). For a code object or
+ sequence of raw bytecode, it prints one line per bytecode instruction.
+ It also recursively disassembles nested code objects (the code of
+ comprehensions, generator expressions and nested functions, and the code
used for building nested classes).
Strings are first compiled to code objects with the :func:`compile`
built-in function before being disassembled. If no object is provided, this
@@ -164,6 +173,9 @@
.. versionchanged:: 3.7
Implemented recursive disassembling and added *depth* parameter.
+ .. versionchanged:: 3.7
+ This can now handle coroutine and asynchronous generator objects.
+
.. function:: distb(tb=None, *, file=None)