dis — Disassembler de bytecode do Python

Código-fonte: Lib/dis.py

---

O módulo dis oferece suporte à análise de bytecode do CPython, desmontando-o. O bytecode do CPython que o módulo leva como entrada é definido no arquivo Include/opcode.h e usado pelo compilador e pelo interpretador.

CPython implementation detail: O bytecode é um detalhe de implementação do interpretador CPython. Não há garantias de que bytecodes não serão adicionados, removidos ou alterados entre as versões do Python. O uso deste módulo não deve ser considerado que funcionará em todas as VMs do Python ou mesmo versões do Python.

Alterado na versão 3.6: Cada instrução ocupa 2 bytes. Anteriormente, o número de bytes variava de acordo com a instrução.

Exemplo: Dada a função myfunc():

def myfunc(alist):
    return len(alist)

o seguinte comando pode ser usado para exibir a desmontagem da função myfunc():

>>> dis.dis(myfunc)
  2           0 LOAD_GLOBAL              0 (len)
              2 LOAD_FAST                0 (alist)
              4 CALL_FUNCTION            1
              6 RETURN_VALUE

(O “2” é o número da linha).

Análise de bytecode

Novo na versão 3.4.

A API de análise de bytecode permite que partes do código Python sejam encapsuladas em um objeto Bytecode que facilite o acesso aos detalhes do código compilado.

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

Analisa o bytecode correspondente a uma função, um gerador, um gerador assíncrono, uma corrotina, um método, uma string de código-fonte, ou um objeto de código (conforme retornado por compile()).

Esta é um invólucro de conveniência que encapsula muitas das funções listadas abaixo, principalmente a get_instructions(), já que iterar sobre sobre uma instância de Bytecode produz operações bytecode como instâncias de Instruction.

Se first_line não for None, ele indica o número de linha que deve ser reportado para a primeira linha de código-fonte no código desmontado. Caso contrário, a informação de linha de código-fonte (se houver) é extraída diretamente da desconstrução do objeto de código.

Se current_offset não for None, ele é um deslocamento em instruções no código desconstruído. Definir este argumento significa que o dis() vai mostrar um marcador de “instrução atual” sobre o opcode especificado.

classmethod from_traceback(tb)

Constrói uma instância de Bytecode a partir do traceback fornecido, definindo current_offset apontando para a instrução responsável pela exceção.

codeobj

O objeto de código compilado.

first_line

A primeira linha de código-fonte do objeto de código (caso disponível).

dis()

Retorna uma visualização formatada das operações em bytecode (as mesmas que seriam impressas pela dis.dis(), mas retornadas como uma string multilinha).

info()

Retorna uma string multilinha formatada com informação detalhada sobre o objeto de código, como code_info().

Alterado na versão 3.7: Este método agora lida com objetos de corrotina e de gerador assíncrono.

Exemplo:

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

Funções de análise

O módulo dis também define as seguintes funções que convertem a entrada diretamente para a saída desejada. Elas podem ser úteis se somente uma única operação está sendo feita, de forma que o objeto de análise intermediário não é útil:

dis.code_info(x)

Retorna uma string multilinha formatada com informação detalhada sobre o objeto de código correspondente à função, gerador, gerador assíncrono, corrotina, método, string de código-fonte ou objeto de código fornecido.

Observe que o conteúdo exato de strings de informação de código são altamente dependentes da implementação e podem mudar de forma arbitrária através de VMs Python ou lançamentos do Python.

Novo na versão 3.2.

Alterado na versão 3.7: Este método agora lida com objetos de corrotina e de gerador assíncrono.

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

Imprime no arquivo file (ou sys.stdout caso file não seja especificado) informações detalhadas sobre o objeto de código correspondente à função, método, string de código-fonte fornecido.

Este é um atalho conveniente para print(code_info(x), file=file), destinado à exploração interativa no prompt do interpretador.

Novo na versão 3.2.

Alterado na versão 3.4: Adicionado o parâmetro file.

dis.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, 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 (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 compile() built-in function before being disassembled. If no object is provided, this function disassembles the last traceback.

O resultado é escrito como texto no arquivo file caso tenha sido fornecido como argumento, ou para sys.stdout caso contrário.

A profundidade máxima de recursão é limitada por depth a menos que seja None. depth=0 significa não fazer recursão.

Alterado na versão 3.4: Adicionado o parâmetro file.

Alterado na versão 3.7: Foi implementada a desmontagem recursiva, e adicionado o parâmetro depth.

Alterado na versão 3.7: Este método agora lida com objetos de corrotina e de gerador assíncrono.

dis.distb(tb=None, *, file=None)

Desmonta a função no topo da pilha de um traceback, usando o último traceback caso nenhum tenha sido passado. A instrução que causou a exceção é indicada.

O resultado é escrito como texto no arquivo file caso tenha sido fornecido como argumento, ou para sys.stdout caso contrário.

Alterado na versão 3.4: Adicionado o parâmetro file.

dis.disassemble(code, lasti=-1, *, file=None)

dis.disco(code, lasti=-1, *, file=None)

Desmonta um objeto de código, indicando a última instrução se lasti tiver sido fornecido. A saída é dividida em colunas da seguinte forma:

1. o número da linha, para a primeira instrução de cada linha

2. a instrução atual, indicada por -->,

3. um rótulo da instrução, indicado com >>,

4. o endereço da instrução

5. o nome do código da operação,

6. os parâmetros da operação, e

7. a interpretação dos parâmetros, em parênteses.

A interpretação dos parâmetros reconhece nomes de variáveis locais e globais, valores de constantes, alvos de ramificações, e operadores de comparação.

O resultado é escrito como texto no arquivo file caso tenha sido fornecido como argumento, ou para sys.stdout caso contrário.

Alterado na versão 3.4: Adicionado o parâmetro file.

dis.get_instructions(x, *, first_line=None)

Retorna um iterador sobre as instruções na função, método, string de código-fonte ou objeto de código fornecido.

O iterador gera uma série de tuplas nomeadas Instruction contendo detalhes de cada operação no código fornecido.

Se first_line não for None, ele indica o número de linha que deve ser reportado para a primeira linha de código-fonte no código desmontado. Caso contrário, a informação de linha de código-fonte (se houver) é extraída diretamente da desconstrução do objeto de código.

Novo na versão 3.4.

dis.findlinestarts(code)

This generator function uses the co_firstlineno and co_lnotab attributes 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. See Objects/lnotab_notes.txt for the co_lnotab format and how to decode it.

Alterado na versão 3.6: Números de linhas podem ser decrescentes. Antes, eles eram sempre crescentes.

dis.findlabels(code)

Detecta todas as posições na string de bytecode compilado bruto code que são alvos de pulos, e as retorna em uma lista.

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

Calcula o efeito que o opcode com argumento oparg tem na pilha.

Se a operação tiver um alvo de pulo e jump for True, stack_effect() vai retornar o efeito na pilha de realizar o pulo. Se jump for False, ela vai retornar o efeito na pilha de não pular. E se jump for None (o padrão), vai retornar o efeito máximo na pilha dentre os dois casos.

Novo na versão 3.4.

Alterado na versão 3.8: Adicionado o parâmetro jump.

Instruções em bytecode do Python

A função get_instructions() e a classe Bytecode fornecem detalhes de instruções de bytecode como instâncias de Instruction:

class dis.Instruction

Detalhes de uma operação em bytecode

opcode

código numérico da operação, correspondendo aos valores dos opcodes listados abaixo e aos valores dos bytecodes nas Opcode collections.

opname

nome legível por humanos para a operação

arg

argumento numérico para a operação (se houver), caso contrário None

argval

resolved arg value (if known), otherwise same as arg

argrepr

human readable description of operation argument

offset

índice de início da operação dentro da sequência de bytecodes

starts_line

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

is_jump_target

True se algum outro código pula para cá, senão False

Novo na versão 3.4.

O compilador de Python atualmente gera as seguintes instruções de bytecode.

Instruções gerais

NOP

Do nothing code. Used as a placeholder by the bytecode optimizer.

POP_TOP

Removes the top-of-stack (TOS) item.

ROT_TWO

Swaps the two top-most stack items.

ROT_THREE

Lifts second and third stack item one position up, moves top down to position three.

ROT_FOUR

Lifts second, third and fourth stack items one position up, moves top down to position four.

Novo na versão 3.8.

DUP_TOP

Duplicates the reference on top of the stack.

Novo na versão 3.2.

DUP_TOP_TWO

Duplicates the two references on top of the stack, leaving them in the same order.

Novo na versão 3.2.

Operações unárias

Operações unárias tiram o topo da pilha, aplicam a operação, e põem o resultado de volta na pilha.

UNARY_POSITIVE

Implements TOS = +TOS.

UNARY_NEGATIVE

Implements TOS = -TOS.

UNARY_NOT

Implements TOS = not TOS.

UNARY_INVERT

Implementação TOS = ~TOS.

GET_ITER

Implementa TOS = iter(TOS).

GET_YIELD_FROM_ITER

If TOS is a generator iterator or coroutine object it is left as is. Otherwise, implements TOS = iter(TOS).

Novo na versão 3.5.

Operações Binárias

Binary operations remove the top of the stack (TOS) and the second top-most stack item (TOS1) from the stack. They perform the operation, and put the result back on the stack.

BINARY_POWER

Implementa TOS = TOS1 ** TOS.

BINARY_MULTIPLY

Implements TOS = TOS1 * TOS.

BINARY_MATRIX_MULTIPLY

Implementado TOS = TOS1 @ TOS.

Novo na versão 3.5.

BINARY_FLOOR_DIVIDE

Implementa TOS = TOS1 // TOS.

BINARY_TRUE_DIVIDE

Implementa TOS = TOS1 / TOS.

BINARY_MODULO

Implementa TOS = TOS1 % TOS.

BINARY_ADD

Implements TOS = TOS1 + TOS.

BINARY_SUBTRACT

Implements TOS = TOS1 - TOS.

BINARY_SUBSCR

Implements TOS = TOS1[TOS].

BINARY_LSHIFT

Implements TOS = TOS1 << TOS.

BINARY_RSHIFT

Implements TOS = TOS1 >> TOS.

BINARY_AND

Implements TOS = TOS1 & TOS.

BINARY_XOR

Implements TOS = TOS1 ^ TOS.

BINARY_OR

Implements TOS = TOS1 | TOS.

In-place operations

In-place operations are like binary operations, in that they remove TOS and TOS1, and push the result back on the stack, but the operation is done in-place when TOS1 supports it, and the resulting TOS may be (but does not have to be) the original TOS1.

INPLACE_POWER

Implements in-place TOS = TOS1 ** TOS.

INPLACE_MULTIPLY

Implements in-place TOS = TOS1 * TOS.

INPLACE_MATRIX_MULTIPLY

Implements in-place TOS = TOS1 @ TOS.

Novo na versão 3.5.

INPLACE_FLOOR_DIVIDE

Implements in-place TOS = TOS1 // TOS.

INPLACE_TRUE_DIVIDE

Implements in-place TOS = TOS1 / TOS.

INPLACE_MODULO

Implements in-place TOS = TOS1 % TOS.

INPLACE_ADD

Implements in-place TOS = TOS1 + TOS.

INPLACE_SUBTRACT

Implements in-place TOS = TOS1 - TOS.

INPLACE_LSHIFT

Implements in-place TOS = TOS1 << TOS.

INPLACE_RSHIFT

Implements in-place TOS = TOS1 >> TOS.

INPLACE_AND

Implements in-place TOS = TOS1 & TOS.

INPLACE_XOR

Implements in-place TOS = TOS1 ^ TOS.

INPLACE_OR

Implements in-place TOS = TOS1 | TOS.

STORE_SUBSCR

Implements TOS1[TOS] = TOS2.

DELETE_SUBSCR

Implements del TOS1[TOS].

Opcodes para corrotinas

GET_AWAITABLE

Implements TOS = get_awaitable(TOS), 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__.

Novo na versão 3.5.

GET_AITER

Implements TOS = TOS.__aiter__().

Novo na versão 3.5.

Alterado na versão 3.7: Não é mais aceitado que o __aiter__ retorne objetos aguardáveis.

GET_ANEXT

Implements PUSH(get_awaitable(TOS.__anext__())). See GET_AWAITABLE for details about get_awaitable

Novo na versão 3.5.

END_ASYNC_FOR

Terminates an async for loop. Handles an exception raised when awaiting a next item. If TOS is StopAsyncIteration pop 7 values from the stack and restore the exception state using the second three of them. Otherwise re-raise the exception using the three values from the stack. An exception handler block is removed from the block stack.

Novo na versão 3.8.

BEFORE_ASYNC_WITH

Resolves __aenter__ and __aexit__ from the object on top of the stack. Pushes __aexit__ and result of __aenter__() to the stack.

Novo na versão 3.5.

SETUP_ASYNC_WITH

Creates a new frame object.

Novo na versão 3.5.

Opcodes genéricos

PRINT_EXPR

Implements the expression statement for the interactive mode. TOS is removed from the stack and printed. In non-interactive mode, an expression statement is terminated with POP_TOP.

SET_ADD(i)

Calls set.add(TOS1[-i], TOS). Used to implement set comprehensions.

LIST_APPEND(i)

Calls list.append(TOS1[-i], TOS). Used to implement list comprehensions.

MAP_ADD(i)

Calls dict.__setitem__(TOS1[-i], TOS1, TOS). Used to implement dict comprehensions.

Novo na versão 3.1.

Alterado na versão 3.8: Map value is TOS and map key is TOS1. Before, those were reversed.

Para as instruções SET_ADD, LIST_APPEND e MAP_ADD, o valor ou par chave/valor é removido da pilha, mas o objeto de contêiner continua na pilha para que ele esteja disponível para as iterações seguintes do laço.

RETURN_VALUE

Returns with TOS to the caller of the function.

YIELD_VALUE

Pops TOS and yields it from a generator.

YIELD_FROM

Pops TOS and delegates to it as a subiterator from a generator.

Novo na versão 3.3.

SETUP_ANNOTATIONS

Verifica se __annotations__ está definido em locals() e, se não estiver, é inicializado como um dict vazio. Este opcode é emitido somente se o corpo de uma classe ou módulo contém anotações de variáveis estaticamente.

Novo na versão 3.6.

IMPORT_STAR

Loads all symbols not starting with '_' directly from the module TOS to the local namespace. The module is popped after loading all names. This opcode implements from module import *.

POP_BLOCK

Removes one block from the block stack. Per frame, there is a stack of blocks, denoting try statements, and such.

POP_EXCEPT

Removes one block from the block stack. The popped block must be an exception handler block, as implicitly created when entering an except handler. In addition to popping extraneous values from the frame stack, the last three popped values are used to restore the exception state.

POP_FINALLY(preserve_tos)

Cleans up the value stack and the block stack. If preserve_tos is not 0 TOS first is popped from the stack and pushed on the stack after performing other stack operations:

• If TOS is NULL or an integer (pushed by BEGIN_FINALLY or CALL_FINALLY) it is popped from the stack.

• If TOS is an exception type (pushed when an exception has been raised) 6 values are popped from the stack, the last three popped values are used to restore the exception state. An exception handler block is removed from the block stack.

It is similar to END_FINALLY, but doesn’t change the bytecode counter nor raise an exception. Used for implementing break, continue and return in the finally block.

Novo na versão 3.8.

BEGIN_FINALLY

Pushes NULL onto the stack for using it in END_FINALLY, POP_FINALLY, WITH_CLEANUP_START and WITH_CLEANUP_FINISH. Starts the finally block.

Novo na versão 3.8.

END_FINALLY

Terminates a finally clause. The interpreter recalls whether the exception has to be re-raised or execution has to be continued depending on the value of TOS.

• If TOS is NULL (pushed by BEGIN_FINALLY) continue from the next instruction. TOS is popped.

• If TOS is an integer (pushed by CALL_FINALLY), sets the bytecode counter to TOS. TOS is popped.

• If TOS is an exception type (pushed when an exception has been raised) 6 values are popped from the stack, the first three popped values are used to re-raise the exception and the last three popped values are used to restore the exception state. An exception handler block is removed from the block stack.

LOAD_BUILD_CLASS

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

SETUP_WITH(delta)

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_CLEANUP_START. Then, __enter__() is called, and a finally block pointing to delta is pushed. Finally, the result of calling the __enter__() method is pushed onto the stack. The next opcode will either ignore it (POP_TOP), or store it in (a) variable(s) (STORE_FAST, STORE_NAME, or UNPACK_SEQUENCE).

Novo na versão 3.2.

WITH_CLEANUP_START

Starts cleaning up the stack when a with statement block exits.

At the top of the stack are either NULL (pushed by BEGIN_FINALLY) or 6 values pushed if an exception has been raised in the with block. Below is the context manager’s __exit__() or __aexit__() bound method.

If TOS is NULL, calls SECOND(None, None, None), removes the function from the stack, leaving TOS, and pushes None to the stack. Otherwise calls SEVENTH(TOP, SECOND, THIRD), shifts the bottom 3 values of the stack down, replaces the empty spot with NULL and pushes TOS. Finally pushes the result of the call.

WITH_CLEANUP_FINISH

Finishes cleaning up the stack when a with statement block exits.

TOS is result of __exit__() or __aexit__() function call pushed by WITH_CLEANUP_START. SECOND is None or an exception type (pushed when an exception has been raised).

Pops two values from the stack. If SECOND is not None and TOS is true unwinds the EXCEPT_HANDLER block which was created when the exception was caught and pushes NULL to the stack.

All of the following opcodes use their arguments.

STORE_NAME(namei)

Implements name = TOS. 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 TOS into count individual values, which are put onto the stack right-to-left.

UNPACK_EX(counts)

Implements assignment with a starred target: Unpacks an iterable in TOS 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 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 resulting values are put onto the stack right-to-left.

STORE_ATTR(namei)

Implements TOS.name = TOS1, where namei is the index of name in co_names.

DELETE_ATTR(namei)

Implements del TOS.name, using namei as index into co_names.

STORE_GLOBAL(namei)

Funciona como o STORE_NAME, mas o nome é armazenado com um nome global.

DELETE_GLOBAL(namei)

Funciona como o DELETE_NAME, mas deleta um nome global.

LOAD_CONST(consti)

Põe co_consts[consti] no topo da pilha.

LOAD_NAME(namei)

Pushes the value associated with co_names[namei] onto the stack.

BUILD_TUPLE(count)

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

BUILD_LIST(count)

Works as BUILD_TUPLE, but creates a list.

BUILD_SET(count)

Works as BUILD_TUPLE, but creates a set.

BUILD_MAP(count)

Pushes a new dictionary object onto the stack. Pops 2 * count items so that the dictionary holds count entries: {..., TOS3: TOS2, TOS1: TOS}.

Alterado na versão 3.5: The dictionary is created from stack items instead of creating an empty dictionary pre-sized to hold count items.

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 TOS1, pops count values to form values in the built dictionary.

Novo na versão 3.6.

BUILD_STRING(count)

Concatenates count strings from the stack and pushes the resulting string onto the stack.

Novo na versão 3.6.

BUILD_TUPLE_UNPACK(count)

Pops count iterables from the stack, joins them in a single tuple, and pushes the result. Implements iterable unpacking in tuple displays (*x, *y, *z).

Novo na versão 3.5.

BUILD_TUPLE_UNPACK_WITH_CALL(count)

This is similar to BUILD_TUPLE_UNPACK, but is used for f(*x, *y, *z) call syntax. The stack item at position count + 1 should be the corresponding callable f.

Novo na versão 3.6.

BUILD_LIST_UNPACK(count)

This is similar to BUILD_TUPLE_UNPACK, but pushes a list instead of tuple. Implements iterable unpacking in list displays [*x, *y, *z].

Novo na versão 3.5.

BUILD_SET_UNPACK(count)

This is similar to BUILD_TUPLE_UNPACK, but pushes a set instead of tuple. Implements iterable unpacking in set displays {*x, *y, *z}.

Novo na versão 3.5.

BUILD_MAP_UNPACK(count)

Pops count mappings from the stack, merges them into a single dictionary, and pushes the result. Implements dictionary unpacking in dictionary displays {**x, **y, **z}.

Novo na versão 3.5.

BUILD_MAP_UNPACK_WITH_CALL(count)

This is similar to BUILD_MAP_UNPACK, but is used for f(**x, **y, **z) call syntax. The stack item at position count + 2 should be the corresponding callable f.

Novo na versão 3.5.

Alterado na versão 3.6: The position of the callable is determined by adding 2 to the opcode argument instead of encoding it in the second byte of the argument.

LOAD_ATTR(namei)

Replaces TOS with getattr(TOS, co_names[namei]).

COMPARE_OP(opname)

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

IMPORT_NAME(namei)

Imports the module co_names[namei]. TOS and TOS1 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 TOS. The resulting object is pushed onto the stack, to be subsequently stored by a STORE_FAST instruction.

JUMP_FORWARD(delta)

Increments bytecode counter by delta.

POP_JUMP_IF_TRUE(target)

If TOS is true, sets the bytecode counter to target. TOS is popped.

Novo na versão 3.1.

POP_JUMP_IF_FALSE(target)

If TOS is false, sets the bytecode counter to target. TOS is popped.

Novo na versão 3.1.

JUMP_IF_TRUE_OR_POP(target)

If TOS is true, sets the bytecode counter to target and leaves TOS on the stack. Otherwise (TOS is false), TOS is popped.

Novo na versão 3.1.

JUMP_IF_FALSE_OR_POP(target)

If TOS is false, sets the bytecode counter to target and leaves TOS on the stack. Otherwise (TOS is true), TOS is popped.

Novo na versão 3.1.

JUMP_ABSOLUTE(target)

Set bytecode counter to target.

FOR_ITER(delta)

TOS 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 TOS is popped, and the byte code counter is incremented by delta.

LOAD_GLOBAL(namei)

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

SETUP_FINALLY(delta)

Pushes a try block from a try-finally or try-except clause onto the block stack. delta points to the finally block or the first except block.

CALL_FINALLY(delta)

Pushes the address of the next instruction onto the stack and increments bytecode counter by delta. Used for calling the finally block as a “subroutine”.

Novo na versão 3.8.

LOAD_FAST(var_num)

Pushes a reference to the local co_varnames[var_num] onto the stack.

STORE_FAST(var_num)

Stores TOS into the local co_varnames[var_num].

DELETE_FAST(var_num)

Deletes local co_varnames[var_num].

LOAD_CLOSURE(i)

Pushes a reference to the cell contained in slot i of the cell and free variable storage. The name of the variable is co_cellvars[i] if i is less than the length of co_cellvars. Otherwise it is co_freevars[i - len(co_cellvars)].

LOAD_DEREF(i)

Loads the cell contained in slot i of the cell and free variable storage. Pushes a reference to the object the cell contains on the stack.

LOAD_CLASSDEREF(i)

Much like LOAD_DEREF but first checks the locals dictionary before consulting the cell. This is used for loading free variables in class bodies.

Novo na versão 3.4.

STORE_DEREF(i)

Stores TOS into the cell contained in slot i of the cell and free variable storage.

DELETE_DEREF(i)

Empties the cell contained in slot i of the cell and free variable storage. Used by the del statement.

Novo na versão 3.2.

RAISE_VARARGS(argc)

Raises an exception using one of the 3 forms of the raise statement, depending on the value of argc:

• 0: raise (re-raise previous exception)

• 1: raise TOS (raise exception instance or type at TOS)

• 2: raise TOS1 from TOS (raise exception instance or type at TOS1 with __cause__ set to TOS)

CALL_FUNCTION(argc)

Calls a callable object with positional arguments. argc indicates the number of positional arguments. The top of the stack contains positional arguments, with the right-most argument on top. Below the arguments is a callable object to call. CALL_FUNCTION 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.

Alterado na versão 3.6: This opcode is used only for calls with positional arguments.

CALL_FUNCTION_KW(argc)

Calls a callable object with positional (if any) and keyword arguments. argc indicates the total number of positional and keyword arguments. The top element on the stack contains a tuple of keyword argument names. Below that are keyword arguments in the order corresponding to the tuple. Below that are positional arguments, with the right-most parameter on top. Below the arguments is a callable object to call. CALL_FUNCTION_KW 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.

Alterado na versão 3.6: Keyword arguments are packed in a tuple instead of a dictionary, argc indicates the total number of arguments.

CALL_FUNCTION_EX(flags)

Calls a callable object with variable set of positional and keyword arguments. If the lowest bit of flags is set, the top of the stack contains a mapping object containing additional keyword arguments. Below that is an iterable object containing positional arguments and a callable object to call. BUILD_MAP_UNPACK_WITH_CALL and BUILD_TUPLE_UNPACK_WITH_CALL can be used for merging multiple mapping objects and iterables containing arguments. Before the callable is called, the mapping object and iterable object are each “unpacked” and their contents passed in as keyword and positional arguments respectively. CALL_FUNCTION_EX 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.

Novo na versão 3.6.

LOAD_METHOD(namei)

Loads a method named co_names[namei] from the TOS object. TOS is popped. This bytecode distinguishes two cases: if TOS has a method with the correct name, the bytecode pushes the unbound method and TOS. TOS will be used as the first argument (self) by CALL_METHOD when calling the unbound method. Otherwise, NULL and the object return by the attribute lookup are pushed.

Novo na versão 3.7.

CALL_METHOD(argc)

Calls a method. argc is the number of positional arguments. Keyword arguments are not supported. This opcode is designed to be used with LOAD_METHOD. Positional arguments are on top of the stack. Below them, the two items described in LOAD_METHOD are on the stack (either self and an unbound method object or NULL and an arbitrary callable). All of them are popped and the return value is pushed.

Novo na versão 3.7.

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 a tuple of default values for positional-only and positional-or-keyword parameters in positional order

• 0x02 a dictionary of keyword-only parameters’ default values

• 0x04 an annotation dictionary

• 0x08 a tuple containing cells for free variables, making a closure

• the code associated with the function (at TOS1)

• the qualified name of the function (at TOS)

BUILD_SLICE(argc)

Pushes a slice object on the stack. argc must be 2 or 3. If it is 2, slice(TOS1, TOS) is pushed; if it is 3, slice(TOS2, TOS1, TOS) is pushed. See the slice() built-in function for more information.

EXTENDED_ARG(ext)

Prefixes any opcode which has an argument too big to fit into the default one byte. ext holds an additional byte which act as higher bits in the argument. For each opcode, at most three prefixal EXTENDED_ARG are allowed, forming an argument from two-byte to four-byte.

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.

Novo na versão 3.6.

HAVE_ARGUMENT

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

Alterado na versão 3.6: Now every instruction has an argument, but opcodes < HAVE_ARGUMENT ignore it. Before, only opcodes >= HAVE_ARGUMENT had an argument.

Opcode collections

These collections are provided for automatic introspection of bytecode instructions:

dis.opname

Sequence of operation names, indexable using the bytecode.

dis.opmap

Dictionary mapping operation names to bytecodes.

dis.cmp_op

Sequence of all compare operation names.

dis.hasconst

Sequence of bytecodes that access a constant.

dis.hasfree

Sequence of bytecodes that access a free variable (note that ‘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

Sequence of bytecodes that access an attribute by name.

dis.hasjrel

Sequence of bytecodes that have a relative jump target.

dis.hasjabs

Sequence of bytecodes that have an absolute jump target.

dis.haslocal

Sequence of bytecodes that access a local variable.

dis.hascompare

Sequence of bytecodes of Boolean operations.