dis — Disassembler for Python bytecode

Вихідний код: Lib/dis.py


Модуль dis підтримує аналіз bytecode CPython шляхом його розбирання. Байт-код CPython, який цей модуль приймає як вхідні дані, визначається у файлі Include/opcode.h і використовується компілятором та інтерпретатором.

Деталі реалізації CPython: Байт-код — це деталь реалізації інтерпретатора CPython. Немає гарантій, що байт-код не буде додано, видалено або змінено між версіями Python. Використання цього модуля не слід вважати таким, що працює на віртуальних машинах Python або випусках Python.

Змінено в версії 3.6: Використовуйте 2 байти для кожної інструкції. Раніше кількість байтів змінювалася залежно від інструкції.

Змінено в версії 3.10: The argument of jump, exception handling and loop instructions is now the instruction offset rather than the byte offset.

Змінено в версії 3.11: Some instructions are accompanied by one or more inline cache entries, which take the form of CACHE instructions. These instructions are hidden by default, but can be shown by passing show_caches=True to any dis utility. Furthermore, the interpreter now adapts the bytecode to specialize it for different runtime conditions. The adaptive bytecode can be shown by passing adaptive=True.

Змінено в версії 3.12: The argument of a jump is the offset of the target instruction relative to the instruction that appears immediately after the jump instruction’s CACHE entries.

As a consequence, the presence of the CACHE instructions is transparent for forward jumps but needs to be taken into account when reasoning about backward jumps.

Example: Given the function myfunc():

def myfunc(alist):
    return len(alist)

the following command can be used to display the disassembly of myfunc():

>>> dis.dis(myfunc)
  2           0 RESUME                   0

  3           2 LOAD_GLOBAL              1 (NULL + len)
             12 LOAD_FAST                0 (alist)
             14 CALL                     1
             22 RETURN_VALUE

(«2» — це номер рядка).

Command-line interface

The dis module can be invoked as a script from the command line:

python -m dis [-h] [infile]

Приймаються такі варіанти:

-h, --help

Показ використання та вихід.

If infile is specified, its disassembled code will be written to stdout. Otherwise, disassembly is performed on compiled source code recieved from stdin.

Аналіз байт-коду

Added in version 3.4.

API аналізу байт-коду дозволяє обернути фрагменти коду Python в об’єкт Bytecode, який забезпечує легкий доступ до деталей скомпільованого коду.

class dis.Bytecode(x, *, first_line=None, current_offset=None, show_caches=False, adaptive=False)

Проаналізуйте байт-код, що відповідає функції, генератору, асинхронному генератору, співпрограмі, методу, рядку вихідного коду або об’єкту коду (як повертає compile()).

Це зручна обгортка для багатьох функцій, перелічених нижче, особливо get_instructions(), оскільки ітерація над екземпляром Bytecode дає операції з байт-кодом як екземпляри Instruction.

Якщо first_line не є None, це вказує номер рядка, який має бути повідомлено для першого вихідного рядка в дизассембленому коді. В іншому випадку інформація про вихідний рядок (якщо така є) береться безпосередньо з розібраного об’єкта коду.

Якщо current_offset не є None, це стосується зсуву інструкції в дизассембленому коді. Якщо встановити це значення, dis() відображатиме маркер «поточна інструкція» проти вказаного коду операції.

If show_caches is True, dis() will display inline cache entries used by the interpreter to specialize the bytecode.

If adaptive is True, dis() will display specialized bytecode that may be different from the original bytecode.

classmethod from_traceback(tb, *, show_caches=False)

Створіть екземпляр Bytecode із заданого трасування, встановивши current_offset для інструкції, відповідальної за виняток.

codeobj

Об’єкт скомпільованого коду.

first_line

Перший вихідний рядок об’єкта коду (якщо доступний)

dis()

Повертає відформатований вигляд операцій байт-коду (те саме, що надруковано dis.dis(), але повертається як багаторядковий рядок).

info()

Повертає відформатований багаторядковий рядок із детальною інформацією про об’єкт коду, наприклад code_info().

Змінено в версії 3.7: Тепер це може обробляти об’єкти співпрограми та асинхронного генератора.

Змінено в версії 3.11: Added the show_caches and adaptive parameters.

приклад:

>>> bytecode = dis.Bytecode(myfunc)
>>> for instr in bytecode:
...     print(instr.opname)
...
RESUME
LOAD_GLOBAL
LOAD_FAST
CALL
RETURN_VALUE

Функції аналізу

Модуль dis також визначає наступні функції аналізу, які перетворюють вхідні дані безпосередньо в бажані вивідні дані. Вони можуть бути корисними, якщо виконується лише одна операція, тому проміжний об’єкт аналізу не корисний:

dis.code_info(x)

Повертає відформатований багаторядковий рядок із детальною інформацією про об’єкт коду для наданої функції, генератора, асинхронного генератора, співпрограми, методу, рядка вихідного коду чи об’єкта коду.

Зауважте, що точний вміст інформаційних рядків коду сильно залежить від реалізації та може довільно змінюватися на різних віртуальних машинах Python або випусках Python.

Added in version 3.2.

Змінено в версії 3.7: Тепер це може обробляти об’єкти співпрограми та асинхронного генератора.

dis.show_code(x, *, file=None)

Вивести детальну інформацію про об’єкт коду для наданої функції, методу, рядка вихідного коду або об’єкта коду у файл (або sys.stdout, якщо файл не вказано).

Це зручне скорочення для print(code_info(x), file=file), призначене для інтерактивного дослідження під час підказки інтерпретатора.

Added in version 3.2.

Змінено в версії 3.4: Додано параметр file.

dis.dis(x=None, *, file=None, depth=None, show_caches=False, adaptive=False)

Disassemble the x object. x can denote either a module, a class, a method, a function, a generator, an asynchronous generator, a coroutine, 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. These can include generator expressions, nested functions, the bodies of nested classes, and the code objects used for annotation scopes. Strings are first compiled to code objects with the compile() built-in function before being disassembled. If no object is provided, this function disassembles the last traceback.

Розбирання записується як текст до наданого аргументу file, якщо він надається, та до sys.stdout інакше.

Максимальна глибина рекурсії обмежена параметром depth, якщо не встановлено None. depth=0 означає відсутність рекурсії.

If show_caches is True, this function will display inline cache entries used by the interpreter to specialize the bytecode.

If adaptive is True, this function will display specialized bytecode that may be different from the original bytecode.

Змінено в версії 3.4: Додано параметр file.

Змінено в версії 3.7: Реалізовано рекурсивне розбирання та додано параметр depth.

Змінено в версії 3.7: Тепер це може обробляти об’єкти співпрограми та асинхронного генератора.

Змінено в версії 3.11: Added the show_caches and adaptive parameters.

dis.distb(tb=None, *, file=None, show_caches=False, adaptive=False)

Розберіть функцію top-of-stack зворотного трасування, використовуючи останню трасування, якщо жодного не було передано. Вказується інструкція, що спричиняє виняток.

Розбирання записується як текст до наданого аргументу file, якщо він надається, та до sys.stdout інакше.

Змінено в версії 3.4: Додано параметр file.

Змінено в версії 3.11: Added the show_caches and adaptive parameters.

dis.disassemble(code, lasti=-1, *, file=None, show_caches=False, adaptive=False)
dis.disco(code, lasti=-1, *, file=None, show_caches=False, adaptive=False)

Розберіть об’єкт коду, вказавши останню інструкцію, якщо було надано lasti. Результат поділено на такі стовпці:

  1. номер рядка для першої інструкції кожного рядка

  2. поточна інструкція, позначена як -->,

  3. маркована інструкція, позначена >>,

  4. адреса інструкції,

  5. кодова назва операції,

  6. параметри роботи, і

  7. інтерпретація параметрів у дужках.

Інтерпретація параметрів розпізнає імена локальних і глобальних змінних, постійні значення, цілі розгалужень і оператори порівняння.

Розбирання записується як текст до наданого аргументу file, якщо він надається, та до sys.stdout інакше.

Змінено в версії 3.4: Додано параметр file.

Змінено в версії 3.11: Added the show_caches and adaptive parameters.

dis.get_instructions(x, *, first_line=None, show_caches=False, adaptive=False)

Повертає ітератор над інструкціями в наданій функції, методі, рядку вихідного коду або об’єкті коду.

Ітератор генерує ряд іменованих кортежів Instruction, що надає деталі кожної операції в наданому коді.

Якщо first_line не є None, це вказує номер рядка, який має бути повідомлено для першого вихідного рядка в дизассембленому коді. В іншому випадку інформація про вихідний рядок (якщо така є) береться безпосередньо з розібраного об’єкта коду.

The show_caches and adaptive parameters work as they do in dis().

Added in version 3.4.

Змінено в версії 3.11: Added the show_caches and adaptive parameters.

dis.findlinestarts(code)

This generator function uses the co_lines() method of the code object code to find the offsets which are starts of lines in the source code. They are generated as (offset, lineno) pairs.

Змінено в версії 3.6: Номери рядків можуть зменшуватися. Раніше вони постійно зростали.

Змінено в версії 3.10: The PEP 626 co_lines() method is used instead of the co_firstlineno and co_lnotab attributes of the code object.

dis.findlabels(code)

Виявлення всіх зсувів у необробленому скомпільованому рядку code байт-коду, які є цілями переходу, і повернення списку цих зсувів.

dis.stack_effect(opcode, oparg=None, *, jump=None)

Обчисліть ефект стека opcode з аргументом oparg.

Якщо код має ціль переходу і jump має значення True, stack_effect() поверне ефект стека стрибка. Якщо jump має значення False, він поверне ефект стека без стрибка. І якщо jump має значення None (за замовчуванням), він поверне максимальний ефект стека в обох випадках.

Added in version 3.4.

Змінено в версії 3.8: Додано параметр jump.

Інструкції щодо байт-коду Python

Функція get_instructions() і клас Bytecode надають деталі інструкцій байт-коду як екземпляри Instruction:

class dis.Instruction

Подробиці для операції байт-коду

opcode

числовий код для операції, що відповідає значенням коду операції, наведеним нижче, і значенням байт-коду в Колекції кодів операцій.

opname

зрозуміла для людини назва операції

arg

числовий аргумент операції (якщо є), інакше None

argval

resolved arg value (if any), otherwise None

argrepr

human readable description of operation argument (if any), otherwise an empty string.

offset

початковий індекс операції в послідовності байт-коду

starts_line

line started by this opcode (if any), otherwise None

is_jump_target

True, якщо інший код переходить сюди, інакше False

positions

dis.Positions object holding the start and end locations that are covered by this instruction.

Added in version 3.4.

Змінено в версії 3.11: Field positions is added.

class dis.Positions

In case the information is not available, some fields might be None.

lineno
end_lineno
col_offset
end_col_offset

Added in version 3.11.

Наразі компілятор Python генерує наступні інструкції байт-коду.

Загальні інструкції

In the following, We will refer to the interpreter stack as STACK and describe operations on it as if it was a Python list. The top of the stack corresponds to STACK[-1] in this language.

NOP

Do nothing code. Used as a placeholder by the bytecode optimizer, and to generate line tracing events.

POP_TOP

Removes the top-of-stack item:

STACK.pop()
END_FOR

Removes the top two values from the stack. Equivalent to POP_TOP; POP_TOP. Used to clean up at the end of loops, hence the name.

Added in version 3.12.

END_SEND

Implements del STACK[-2]. Used to clean up when a generator exits.

Added in version 3.12.

COPY(i)

Push the i-th item to the top of the stack without removing it from its original location:

assert i > 0
STACK.append(STACK[-i])

Added in version 3.11.

SWAP(i)

Swap the top of the stack with the i-th element:

STACK[-i], STACK[-1] = STACK[-1], STACK[-i]

Added in version 3.11.

CACHE

Rather than being an actual instruction, this opcode is used to mark extra space for the interpreter to cache useful data directly in the bytecode itself. It is automatically hidden by all dis utilities, but can be viewed with show_caches=True.

Logically, this space is part of the preceding instruction. Many opcodes expect to be followed by an exact number of caches, and will instruct the interpreter to skip over them at runtime.

Populated caches can look like arbitrary instructions, so great care should be taken when reading or modifying raw, adaptive bytecode containing quickened data.

Added in version 3.11.

Унарні операції

Унарні операції займають вершину стека, застосовують операцію та повертають результат назад у стек.

UNARY_NEGATIVE

Implements STACK[-1] = -STACK[-1].

UNARY_NOT

Implements STACK[-1] = not STACK[-1].

UNARY_INVERT

Implements STACK[-1] = ~STACK[-1].

GET_ITER

Implements STACK[-1] = iter(STACK[-1]).

GET_YIELD_FROM_ITER

If STACK[-1] is a generator iterator or coroutine object it is left as is. Otherwise, implements STACK[-1] = iter(STACK[-1]).

Added in version 3.5.

Binary and in-place operations

Binary operations remove the top two items from the stack (STACK[-1] and STACK[-2]). They perform the operation, then put the result back on the stack.

In-place operations are like binary operations, but the operation is done in-place when STACK[-2] supports it, and the resulting STACK[-1] may be (but does not have to be) the original STACK[-2].

BINARY_OP(op)

Implements the binary and in-place operators (depending on the value of op):

rhs = STACK.pop()
lhs = STACK.pop()
STACK.append(lhs op rhs)

Added in version 3.11.

BINARY_SUBSCR

Implements:

key = STACK.pop()
container = STACK.pop()
STACK.append(container[key])
STORE_SUBSCR

Implements:

key = STACK.pop()
container = STACK.pop()
value = STACK.pop()
container[key] = value
DELETE_SUBSCR

Implements:

key = STACK.pop()
container = STACK.pop()
del container[key]
BINARY_SLICE

Implements:

end = STACK.pop()
start = STACK.pop()
container = STACK.pop()
STACK.append(container[start:end])

Added in version 3.12.

STORE_SLICE

Implements:

end = STACK.pop()
start = STACK.pop()
container = STACK.pop()
values = STACK.pop()
container[start:end] = value

Added in version 3.12.

Коди операцій співпрограми

GET_AWAITABLE(where)

Implements STACK[-1] = get_awaitable(STACK[-1]), where get_awaitable(o) returns o if o is a coroutine object or a generator object with the CO_ITERABLE_COROUTINE flag, or resolves o.__await__.

If the where operand is nonzero, it indicates where the instruction occurs:

  • 1: After a call to __aenter__

  • 2: After a call to __aexit__

Added in version 3.5.

Змінено в версії 3.11: Previously, this instruction did not have an oparg.

GET_AITER

Implements STACK[-1] = STACK[-1].__aiter__().

Added in version 3.5.

Змінено в версії 3.7: Повернення очікуваних об’єктів із __aiter__ більше не підтримується.

GET_ANEXT

Implement STACK.append(get_awaitable(STACK[-1].__anext__())) to the stack. See GET_AWAITABLE for details about get_awaitable.

Added in version 3.5.

END_ASYNC_FOR

Terminates an async for loop. Handles an exception raised when awaiting a next item. The stack contains the async iterable in STACK[-2] and the raised exception in STACK[-1]. Both are popped. If the exception is not StopAsyncIteration, it is re-raised.

Added in version 3.8.

Змінено в версії 3.11: Exception representation on the stack now consist of one, not three, items.

CLEANUP_THROW

Handles an exception raised during a throw() or close() call through the current frame. If STACK[-1] is an instance of StopIteration, pop three values from the stack and push its value member. Otherwise, re-raise STACK[-1].

Added in version 3.12.

BEFORE_ASYNC_WITH

Resolves __aenter__ and __aexit__ from STACK[-1]. Pushes __aexit__ and result of __aenter__() to the stack:

STACK.extend((__aexit__, __aenter__())

Added in version 3.5.

Різні коди операцій

SET_ADD(i)

Implements:

item = STACK.pop()
set.add(STACK[-i], item)

Used to implement set comprehensions.

LIST_APPEND(i)

Implements:

item = STACK.pop()
list.append(STACK[-i], item)

Used to implement list comprehensions.

MAP_ADD(i)

Implements:

value = STACK.pop()
key = STACK.pop()
dict.__setitem__(STACK[-i], key, value)

Used to implement dict comprehensions.

Added in version 3.1.

Змінено в версії 3.8: Map value is STACK[-1] and map key is STACK[-2]. Before, those were reversed.

Для всіх інструкцій SET_ADD, LIST_APPEND і MAP_ADD, поки додане значення або пара ключ/значення видаляється, об’єкт-контейнер залишається в стеку, тому він доступний для подальших ітерацій циклу.

RETURN_VALUE

Returns with STACK[-1] to the caller of the function.

RETURN_CONST(consti)

Returns with co_consts[consti] to the caller of the function.

Added in version 3.12.

YIELD_VALUE

Yields STACK.pop() from a generator.

Змінено в версії 3.11: oparg set to be the stack depth.

Змінено в версії 3.12: oparg set to be the exception block depth, for efficient closing of generators.

SETUP_ANNOTATIONS

Перевіряє, чи визначено __annotations__ в locals(), якщо ні, воно встановлюється на порожній dict. Цей код операції видається, лише якщо тіло класу або модуля містить анотації змінних статично.

Added in version 3.6.

POP_EXCEPT

Pops a value from the stack, which is used to restore the exception state.

Змінено в версії 3.11: Exception representation on the stack now consist of one, not three, items.

RERAISE

Re-raises the exception currently on top of the stack. If oparg is non-zero, pops an additional value from the stack which is used to set f_lasti of the current frame.

Added in version 3.9.

Змінено в версії 3.11: Exception representation on the stack now consist of one, not three, items.

PUSH_EXC_INFO

Pops a value from the stack. Pushes the current exception to the top of the stack. Pushes the value originally popped back to the stack. Used in exception handlers.

Added in version 3.11.

CHECK_EXC_MATCH

Performs exception matching for except. Tests whether the STACK[-2] is an exception matching STACK[-1]. Pops STACK[-1] and pushes the boolean result of the test.

Added in version 3.11.

CHECK_EG_MATCH

Performs exception matching for except*. Applies split(STACK[-1]) on the exception group representing STACK[-2].

In case of a match, pops two items from the stack and pushes the non-matching subgroup (None in case of full match) followed by the matching subgroup. When there is no match, pops one item (the match type) and pushes None.

Added in version 3.11.

WITH_EXCEPT_START

Calls the function in position 4 on the stack with arguments (type, val, tb) representing the exception at the top of the stack. Used to implement the call context_manager.__exit__(*exc_info()) when an exception has occurred in a with statement.

Added in version 3.9.

Змінено в версії 3.11: The __exit__ function is in position 4 of the stack rather than 7. Exception representation on the stack now consist of one, not three, items.

LOAD_ASSERTION_ERROR

Поміщає AssertionError у стек. Використовується оператором assert.

Added in version 3.9.

LOAD_BUILD_CLASS

Pushes builtins.__build_class__() onto the stack. It is later called to construct a class.

BEFORE_WITH

This opcode performs several operations before a with block starts. First, it loads __exit__() from the context manager and pushes it onto the stack for later use by WITH_EXCEPT_START. Then, __enter__() is called. Finally, the result of calling the __enter__() method is pushed onto the stack.

Added in version 3.11.

GET_LEN

Perform STACK.append(len(STACK[-1])). Used in match statements where comparison with structure of pattern is needed.

Added in version 3.10.

MATCH_MAPPING

If STACK[-1] is an instance of collections.abc.Mapping (or, more technically: if it has the Py_TPFLAGS_MAPPING flag set in its tp_flags), push True onto the stack. Otherwise, push False.

Added in version 3.10.

MATCH_SEQUENCE

If STACK[-1] is an instance of collections.abc.Sequence and is not an instance of str/bytes/bytearray (or, more technically: if it has the Py_TPFLAGS_SEQUENCE flag set in its tp_flags), push True onto the stack. Otherwise, push False.

Added in version 3.10.

MATCH_KEYS

STACK[-1] is a tuple of mapping keys, and STACK[-2] is the match subject. If STACK[-2] contains all of the keys in STACK[-1], push a tuple containing the corresponding values. Otherwise, push None.

Added in version 3.10.

Змінено в версії 3.11: Previously, this instruction also pushed a boolean value indicating success (True) or failure (False).

STORE_NAME(namei)

Implements name = STACK.pop(). namei is the index of name in the attribute co_names of the code object. The compiler tries to use STORE_FAST or STORE_GLOBAL if possible.

DELETE_NAME(namei)

Implements del name, where namei is the index into co_names attribute of the code object.

UNPACK_SEQUENCE(count)

Unpacks STACK[-1] into count individual values, which are put onto the stack right-to-left. Require there to be exactly count values.:

assert(len(STACK[-1]) == count)
STACK.extend(STACK.pop()[:-count-1:-1])
UNPACK_EX(counts)

Implements assignment with a starred target: Unpacks an iterable in STACK[-1] into individual values, where the total number of values can be smaller than the number of items in the iterable: one of the new values will be a list of all leftover items.

The number of values before and after the list value is limited to 255.

The number of values before the list value is encoded in the argument of the opcode. The number of values after the list if any is encoded using an EXTENDED_ARG. As a consequence, the argument can be seen as a two bytes values where the low byte of counts is the number of values before the list value, the high byte of counts the number of values after it.

The extracted values are put onto the stack right-to-left, i.e. a, *b, c = d will be stored after execution as STACK.extend((a, b, c)).

STORE_ATTR(namei)

Implements:

obj = STACK.pop()
value = STACK.pop()
obj.name = value

where namei is the index of name in co_names of the code object.

DELETE_ATTR(namei)

Implements:

obj = STACK.pop()
del obj.name

where namei is the index of name into co_names of the code object.

STORE_GLOBAL(namei)

Працює як STORE_NAME, але зберігає назву як глобальну.

DELETE_GLOBAL(namei)

Працює як DELETE_NAME, але видаляє глобальне ім’я.

LOAD_CONST(consti)

Поміщає co_consts[consti] в стек.

LOAD_NAME(namei)

Pushes the value associated with co_names[namei] onto the stack. The name is looked up within the locals, then the globals, then the builtins.

LOAD_LOCALS

Pushes a reference to the locals dictionary onto the stack. This is used to prepare namespace dictionaries for LOAD_FROM_DICT_OR_DEREF and LOAD_FROM_DICT_OR_GLOBALS.

Added in version 3.12.

LOAD_FROM_DICT_OR_GLOBALS(i)

Pops a mapping off the stack and looks up the value for co_names[namei]. If the name is not found there, looks it up in the globals and then the builtins, similar to LOAD_GLOBAL. This is used for loading global variables in annotation scopes within class bodies.

Added in version 3.12.

BUILD_TUPLE(count)

Creates a tuple consuming count items from the stack, and pushes the resulting tuple onto the stack:

if count == 0:
    value = ()
else:
    value = tuple(STACK[-count:])
    STACK = STACK[:-count]

STACK.append(value)
BUILD_LIST(count)

Працює як BUILD_TUPLE, але створює список.

BUILD_SET(count)

Працює як BUILD_TUPLE, але створює набір.

BUILD_MAP(count)

Pushes a new dictionary object onto the stack. Pops 2 * count items so that the dictionary holds count entries: {..., STACK[-4]: STACK[-3], STACK[-2]: STACK[-1]}.

Змінено в версії 3.5: Словник створюється з елементів стека замість створення порожнього словника попереднього розміру для кількості елементів.

BUILD_CONST_KEY_MAP(count)

The version of BUILD_MAP specialized for constant keys. Pops the top element on the stack which contains a tuple of keys, then starting from STACK[-2], pops count values to form values in the built dictionary.

Added in version 3.6.

BUILD_STRING(count)

З’єднує count рядки зі стеку та надихає отриманий рядок у стек.

Added in version 3.6.

LIST_EXTEND(i)

Implements:

seq = STACK.pop()
list.extend(STACK[-i], seq)

Used to build lists.

Added in version 3.9.

SET_UPDATE(i)

Implements:

seq = STACK.pop()
set.update(STACK[-i], seq)

Used to build sets.

Added in version 3.9.

DICT_UPDATE(i)

Implements:

map = STACK.pop()
dict.update(STACK[-i], map)

Used to build dicts.

Added in version 3.9.

DICT_MERGE(i)

Подібно до DICT_UPDATE, але створює виняток для дублікатів ключів.

Added in version 3.9.

LOAD_ATTR(namei)

If the low bit of namei is not set, this replaces STACK[-1] with getattr(STACK[-1], co_names[namei>>1]).

If the low bit of namei is set, this will attempt to load a method named co_names[namei>>1] from the STACK[-1] object. STACK[-1] is popped. This bytecode distinguishes two cases: if STACK[-1] has a method with the correct name, the bytecode pushes the unbound method and STACK[-1]. STACK[-1] will be used as the first argument (self) by CALL when calling the unbound method. Otherwise, NULL and the object returned by the attribute lookup are pushed.

Змінено в версії 3.12: If the low bit of namei is set, then a NULL or self is pushed to the stack before the attribute or unbound method respectively.

LOAD_SUPER_ATTR(namei)

This opcode implements 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 - the global super

With respect to its argument, it works similarly to 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 LOAD_ATTR, which results in pushing NULL 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 call to super() (unset means zero-argument).

Added in version 3.12.

COMPARE_OP(opname)

Performs a Boolean operation. The operation name can be found in cmp_op[opname >> 4].

Змінено в версії 3.12: The cmp_op index is now stored in the four-highest bits of oparg instead of the four-lowest bits of oparg.

IS_OP(invert)

Виконує порівняння is або is not, якщо invert дорівнює 1.

Added in version 3.9.

CONTAINS_OP(invert)

Виконує порівняння in або not in, якщо invert дорівнює 1.

Added in version 3.9.

IMPORT_NAME(namei)

Imports the module co_names[namei]. STACK[-1] and STACK[-2] are popped and provide the fromlist and level arguments of __import__(). The module object is pushed onto the stack. The current namespace is not affected: for a proper import statement, a subsequent STORE_FAST instruction modifies the namespace.

IMPORT_FROM(namei)

Loads the attribute co_names[namei] from the module found in STACK[-1]. The resulting object is pushed onto the stack, to be subsequently stored by a STORE_FAST instruction.

JUMP_FORWARD(delta)

Збільшує лічильник байт-коду на delta.

JUMP_BACKWARD(delta)

Decrements bytecode counter by delta. Checks for interrupts.

Added in version 3.11.

JUMP_BACKWARD_NO_INTERRUPT(delta)

Decrements bytecode counter by delta. Does not check for interrupts.

Added in version 3.11.

POP_JUMP_IF_TRUE(delta)

If STACK[-1] is true, increments the bytecode counter by delta. STACK[-1] is popped.

Змінено в версії 3.11: The oparg is now a relative delta rather than an absolute target. This opcode is a pseudo-instruction, replaced in final bytecode by the directed versions (forward/backward).

Змінено в версії 3.12: This is no longer a pseudo-instruction.

POP_JUMP_IF_FALSE(delta)

If STACK[-1] is false, increments the bytecode counter by delta. STACK[-1] is popped.

Змінено в версії 3.11: The oparg is now a relative delta rather than an absolute target. This opcode is a pseudo-instruction, replaced in final bytecode by the directed versions (forward/backward).

Змінено в версії 3.12: This is no longer a pseudo-instruction.

POP_JUMP_IF_NOT_NONE(delta)

If STACK[-1] is not None, increments the bytecode counter by delta. STACK[-1] is popped.

This opcode is a pseudo-instruction, replaced in final bytecode by the directed versions (forward/backward).

Added in version 3.11.

Змінено в версії 3.12: This is no longer a pseudo-instruction.

POP_JUMP_IF_NONE(delta)

If STACK[-1] is None, increments the bytecode counter by delta. STACK[-1] is popped.

This opcode is a pseudo-instruction, replaced in final bytecode by the directed versions (forward/backward).

Added in version 3.11.

Змінено в версії 3.12: This is no longer a pseudo-instruction.

FOR_ITER(delta)

STACK[-1] is an iterator. Call its __next__() method. If this yields a new value, push it on the stack (leaving the iterator below it). If the iterator indicates it is exhausted then the byte code counter is incremented by delta.

Змінено в версії 3.12: Up until 3.11 the iterator was popped when it was exhausted.

LOAD_GLOBAL(namei)

Loads the global named co_names[namei>>1] onto the stack.

Змінено в версії 3.11: If the low bit of namei is set, then a NULL is pushed to the stack before the global variable.

LOAD_FAST(var_num)

Надсилає посилання на локальні co_var_names[var_num] у стек.

Змінено в версії 3.12: This opcode is now only used in situations where the local variable is guaranteed to be initialized. It cannot raise UnboundLocalError.

LOAD_FAST_CHECK(var_num)

Pushes a reference to the local co_varnames[var_num] onto the stack, raising an UnboundLocalError if the local variable has not been initialized.

Added in version 3.12.

LOAD_FAST_AND_CLEAR(var_num)

Pushes a reference to the local co_varnames[var_num] onto the stack (or pushes NULL onto the stack if the local variable has not been initialized) and sets co_varnames[var_num] to NULL.

Added in version 3.12.

STORE_FAST(var_num)

Stores STACK.pop() into the local co_varnames[var_num].

DELETE_FAST(var_num)

Видаляє локальні co_var_names[var_num].

MAKE_CELL(i)

Creates a new cell in slot i. If that slot is nonempty then that value is stored into the new cell.

Added in version 3.11.

LOAD_CLOSURE(i)

Pushes a reference to the cell contained in slot i of the «fast locals» storage. The name of the variable is co_fastlocalnames[i].

Note that LOAD_CLOSURE is effectively an alias for LOAD_FAST. It exists to keep bytecode a little more readable.

Змінено в версії 3.11: i is no longer offset by the length of co_varnames.

LOAD_DEREF(i)

Loads the cell contained in slot i of the «fast locals» storage. Pushes a reference to the object the cell contains on the stack.

Змінено в версії 3.11: i is no longer offset by the length of co_varnames.

LOAD_FROM_DICT_OR_DEREF(i)

Pops a mapping off the stack and looks up the name associated with slot i of the «fast locals» storage in this mapping. If the name is not found there, loads it from the cell contained in slot i, similar to LOAD_DEREF. This is used for loading free variables in class bodies (which previously used LOAD_CLASSDEREF) and in annotation scopes within class bodies.

Added in version 3.12.

STORE_DEREF(i)

Stores STACK.pop() into the cell contained in slot i of the «fast locals» storage.

Змінено в версії 3.11: i is no longer offset by the length of co_varnames.

DELETE_DEREF(i)

Empties the cell contained in slot i of the «fast locals» storage. Used by the del statement.

Added in version 3.2.

Змінено в версії 3.11: i is no longer offset by the length of co_varnames.

COPY_FREE_VARS(n)

Copies the n free variables from the closure into the frame. Removes the need for special code on the caller’s side when calling closures.

Added in version 3.11.

RAISE_VARARGS(argc)

Створює виняток, використовуючи одну з 3 форм оператора raise, залежно від значення argc:

  • 0: raise (повторно підняти попередній виняток)

  • 1: raise STACK[-1] (raise exception instance or type at STACK[-1])

  • 2: raise STACK[-2] from STACK[-1] (raise exception instance or type at STACK[-2] with __cause__ set to STACK[-1])

CALL(argc)

Calls a callable object with the number of arguments specified by argc, including the named arguments specified by the preceding KW_NAMES, if any. On the stack are (in ascending order), either:

  • NULL

  • The callable

  • The positional arguments

  • The named arguments

or:

  • The callable

  • self

  • The remaining positional arguments

  • The named arguments

argc is the total of the positional and named arguments, excluding self when a NULL is not present.

CALL pops all arguments and the callable object off the stack, calls the callable object with those arguments, and pushes the return value returned by the callable object.

Added in version 3.11.

CALL_FUNCTION_EX(flags)

Викликає викликаний об’єкт зі змінним набором позиційних і ключових аргументів. Якщо встановлено найнижчий біт flags, верхня частина стека містить об’єкт відображення, що містить додаткові аргументи ключового слова. Перед викликом викликаного об’єкта відображення та ітерованого об’єкта кожен «розпаковується», а їхній вміст передається як ключове слово та позиційний аргумент відповідно. CALL_FUNCTION_EX видаляє зі стеку всі аргументи та об’єкт, який викликається, викликає об’єкт, який викликається, з цими аргументами та надсилає значення, яке повертає об’єкт, який викликається.

Added in version 3.6.

PUSH_NULL

Pushes a NULL to the stack. Used in the call sequence to match the NULL pushed by LOAD_METHOD for non-method calls.

Added in version 3.11.

KW_NAMES(consti)

Prefixes CALL. Stores a reference to co_consts[consti] into an internal variable for use by CALL. co_consts[consti] must be a tuple of strings.

Added in version 3.11.

MAKE_FUNCTION(flags)

Pushes a new function object on the stack. From bottom to top, the consumed stack must consist of values if the argument carries a specified flag value

  • 0x01 кортеж значень за замовчуванням для позиційних параметрів і параметрів позиційного або ключового слова в позиційному порядку

  • 0x02 словник значень за замовчуванням параметрів лише ключових слів

  • 0x04 кортеж рядків, що містять анотації параметрів

  • 0x08 кортеж, що містить комірки для вільних змінних, створюючи закриття

  • the code associated with the function (at STACK[-1])

Змінено в версії 3.10: Значення прапора 0x04 є кортежем рядків замість словника

Змінено в версії 3.11: Qualified name at STACK[-1] was removed.

BUILD_SLICE(argc)

Pushes a slice object on the stack. argc must be 2 or 3. If it is 2, implements:

end = STACK.pop()
start = STACK.pop()
STACK.append(slice(start, end))

if it is 3, implements:

step = STACK.pop()
end = STACK.pop()
start = STACK.pop()
STACK.append(slice(start, end, step))

See the slice() built-in function for more information.

EXTENDED_ARG(ext)

Додає префікс до будь-якого коду операції, який має занадто великий аргумент, щоб поміститися в стандартний один байт. ext містить додатковий байт, який діє як старші біти в аргументі. Для кожного коду операції дозволено не більше трьох префіксів EXTENDED_ARG, які утворюють аргумент розміром від двох до чотирьох байтів.

FORMAT_VALUE(flags)

Used for implementing formatted literal strings (f-strings). Pops an optional fmt_spec from the stack, then a required value. flags is interpreted as follows:

  • (flags & 0x03) == 0x00: value is formatted as-is.

  • (flags & 0x03) == 0x01: call str() on value before formatting it.

  • (flags & 0x03) == 0x02: call repr() on value before formatting it.

  • (flags & 0x03) == 0x03: call ascii() on value before formatting it.

  • (flags & 0x04) == 0x04: pop fmt_spec from the stack and use it, else use an empty fmt_spec.

Formatting is performed using PyObject_Format(). The result is pushed on the stack.

Added in version 3.6.

MATCH_CLASS(count)

STACK[-1] is a tuple of keyword attribute names, STACK[-2] is the class being matched against, and STACK[-3] is the match subject. count is the number of positional sub-patterns.

Pop STACK[-1], STACK[-2], and STACK[-3]. If STACK[-3] is an instance of STACK[-2] and has the positional and keyword attributes required by count and STACK[-1], push a tuple of extracted attributes. Otherwise, push None.

Added in version 3.10.

Змінено в версії 3.11: Previously, this instruction also pushed a boolean value indicating success (True) or failure (False).

RESUME(where)

A no-op. Performs internal tracing, debugging and optimization checks.

The where operand marks where the RESUME occurs:

  • 0 The start of a function, which is neither a generator, coroutine nor an async generator

  • 1 After a yield expression

  • 2 After a yield from expression

  • 3 After an await expression

Added in version 3.11.

RETURN_GENERATOR

Create a generator, coroutine, or async generator from the current frame. Used as first opcode of in code object for the above mentioned callables. Clear the current frame and return the newly created generator.

Added in version 3.11.

SEND(delta)

Equivalent to STACK[-1] = STACK[-2].send(STACK[-1]). Used in yield from and await statements.

If the call raises StopIteration, pop the top value from the stack, push the exception’s value attribute, and increment the bytecode counter by delta.

Added in version 3.11.

HAVE_ARGUMENT

This is not really an opcode. It identifies the dividing line between opcodes in the range [0,255] which don’t use their argument and those that do (< HAVE_ARGUMENT and >= HAVE_ARGUMENT, respectively).

If your application uses pseudo instructions, use the hasarg collection instead.

Змінено в версії 3.6: Тепер кожна інструкція має аргумент, але коди операцій < HAVE_ARGUMENT ignore it. Before, only opcodes > = HAVE_ARGUMENT мали аргумент.

Змінено в версії 3.12: Pseudo instructions were added to the dis module, and for them it is not true that comparison with HAVE_ARGUMENT indicates whether they use their arg.

CALL_INTRINSIC_1

Calls an intrinsic function with one argument. Passes STACK[-1] as the argument and sets STACK[-1] to the result. Used to implement functionality that is not performance critical.

The operand determines which intrinsic function is called:

Operand

Опис

INTRINSIC_1_INVALID

Not valid

INTRINSIC_PRINT

Prints the argument to standard out. Used in the REPL.

INTRINSIC_IMPORT_STAR

Performs import * for the named module.

INTRINSIC_STOPITERATION_ERROR

Extracts the return value from a StopIteration exception.

INTRINSIC_ASYNC_GEN_WRAP

Wraps an async generator value

INTRINSIC_UNARY_POSITIVE

Performs the unary + operation

INTRINSIC_LIST_TO_TUPLE

Converts a list to a tuple

INTRINSIC_TYPEVAR

Creates a typing.TypeVar

INTRINSIC_PARAMSPEC

Creates a typing.ParamSpec

INTRINSIC_TYPEVARTUPLE

Creates a typing.TypeVarTuple

INTRINSIC_SUBSCRIPT_GENERIC

Returns typing.Generic subscripted with the argument

INTRINSIC_TYPEALIAS

Creates a typing.TypeAliasType; used in the type statement. The argument is a tuple of the type alias’s name, type parameters, and value.

Added in version 3.12.

CALL_INTRINSIC_2

Calls an intrinsic function with two arguments. Used to implement functionality that is not performance critical:

arg2 = STACK.pop()
arg1 = STACK.pop()
result = intrinsic2(arg1, arg2)
STACK.push(result)

The operand determines which intrinsic function is called:

Operand

Опис

INTRINSIC_2_INVALID

Not valid

INTRINSIC_PREP_RERAISE_STAR

Calculates the ExceptionGroup to raise from a try-except*.

INTRINSIC_TYPEVAR_WITH_BOUND

Creates a typing.TypeVar with a bound.

INTRINSIC_TYPEVAR_WITH_CONSTRAINTS

Creates a typing.TypeVar with constraints.

INTRINSIC_SET_FUNCTION_TYPE_PARAMS

Sets the __type_params__ attribute of a function.

Added in version 3.12.

Pseudo-instructions

These opcodes do not appear in Python bytecode. They are used by the compiler but are replaced by real opcodes or removed before bytecode is generated.

SETUP_FINALLY(target)

Set up an exception handler for the following code block. If an exception occurs, the value stack level is restored to its current state and control is transferred to the exception handler at target.

SETUP_CLEANUP(target)

Like SETUP_FINALLY, but in case of an exception also pushes the last instruction (lasti) to the stack so that RERAISE can restore it. If an exception occurs, the value stack level and the last instruction on the frame are restored to their current state, and control is transferred to the exception handler at target.

SETUP_WITH(target)

Like SETUP_CLEANUP, but in case of an exception one more item is popped from the stack before control is transferred to the exception handler at target.

This variant is used in with and async with constructs, which push the return value of the context manager’s __enter__() or __aenter__() to the stack.

POP_BLOCK

Marks the end of the code block associated with the last SETUP_FINALLY, SETUP_CLEANUP or SETUP_WITH.

JUMP
JUMP_NO_INTERRUPT

Undirected relative jump instructions which are replaced by their directed (forward/backward) counterparts by the assembler.

LOAD_METHOD

Optimized unbound method lookup. Emitted as a LOAD_ATTR opcode with a flag set in the arg.

Колекції кодів операцій

Ці колекції надаються для автоматичного аналізу інструкцій байт-коду:

Змінено в версії 3.12: The collections now contain pseudo instructions and instrumented instructions as well. These are opcodes with values >= MIN_PSEUDO_OPCODE and >= MIN_INSTRUMENTED_OPCODE.

dis.opname

Послідовність імен операцій, індексованих за допомогою байт-коду.

dis.opmap

Словник зіставляє назви операцій із байт-кодами.

dis.cmp_op

Послідовність імен усіх операцій порівняння.

dis.hasarg

Sequence of bytecodes that use their argument.

Added in version 3.12.

dis.hasconst

Послідовність байт-кодів, які звертаються до константи.

dis.hasfree

Sequence of bytecodes that access a free variable. „free“ in this context refers to names in the current scope that are referenced by inner scopes or names in outer scopes that are referenced from this scope. It does not include references to global or builtin scopes.

dis.hasname

Послідовність байт-кодів, які звертаються до атрибута за назвою.

dis.hasjrel

Послідовність байт-кодів, які мають відносну ціль переходу.

dis.hasjabs

Послідовність байт-кодів, які мають абсолютну ціль переходу.

dis.haslocal

Послідовність байт-кодів, які звертаються до локальної змінної.

dis.hascompare

Послідовність байт-кодів булевих операцій.

dis.hasexc

Sequence of bytecodes that set an exception handler.

Added in version 3.12.