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.

Detalhes da implementação do CPython: 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.

Alterado na versão 3.10: O argumento para instruções de pulo, tratamento de exceção e laço é agora o deslocamento em instruções, ao invés de em bytes.

Alterado na versão 3.11: Algumas instruções vêm acompanhadas de uma ou mais entradas de cache em linha, as quais assumem a forma de instruções CACHE. Tais instruções são escondidas por padrão, mas podem ser visualizadas passando show_caches=True para qualquer utilidade do dis. Além disso, o interpretador agora adapta o bytecode para especializá-lo a diferentes condições de tempo de execução. O bytecode adaptativo pode ser visualizado passando adaptive=True.

Exemplo: Dada a função 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)
             14 LOAD_FAST                0 (alist)
             16 PRECALL                  1
             20 CALL                     1
             30 RETURN_VALUE

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

Interface de linha de comando

O módulo dis pode ser invocado como um script na linha de comando:

python -m dis [-h] [-C] [infile]

As seguintes opções são aceitas:

-h, --help

Exibe o modo de uso e sai.

-C, --show-caches

Show inline caches.

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

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, show_caches=False, adaptive=False)

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.

Se show_caches for True, o dis() vai exibir entradas de cache em linha usadas pelo interpretador para especializar o bytecode.

Se adaptive for True, o dis() vai exibir bytecode especializado que pode ser diferente do bytecode original.

classmethod from_traceback(tb, *, show_caches=False)

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.

Alterado na versão 3.11: Adicionados os parâmetros show_caches e adaptive.

Exemplo:

>>> bytecode = dis.Bytecode(myfunc)
>>> for instr in bytecode:
...     print(instr.opname)
...
RESUME
LOAD_GLOBAL
LOAD_FAST
PRECALL
CALL
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, 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 (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.

Se show_caches for True, essa função vai exibir entradas de cache em linha usadas pelo interpretador para especializar o bytecode.

Se adaptive for True, essa função vai exibir bytecode especializado que pode ser diferente do bytecode original.

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.

Alterado na versão 3.11: Adicionados os parâmetros show_caches e adaptive.

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

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.

Alterado na versão 3.11: Adicionados os parâmetros show_caches e adaptive.

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

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.

Alterado na versão 3.11: Adicionados os parâmetros show_caches e adaptive.

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

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.

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

Novo na versão 3.4.

Alterado na versão 3.11: Adicionados os parâmetros show_caches e adaptive.

dis.findlinestarts(code)

Essa função geradora usa o método co_lines() do objeto de código code para encontrar as posições que correspondem aos inícios de cada linha do código-fonte. Elas são geradas em pares (offset, lineno).

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

Alterado na versão 3.10: O método co_lines() da PEP 626 é usado ao invés dos atributos co_firstlineno e co_lnotab do objeto de código.

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

valor resolvido do argumento (se houver), caso contrário None

argrepr

descrição legível por humanos do argumento da operação (se houver), caso contrário uma string vazia.

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

positions

objeto dis.Positions contendo os pontos de início e fim cobertos por esta instrução.

Novo na versão 3.4.

Alterado na versão 3.11: Adicionado o campo positions.

class dis.Positions

Caso a informação não esteja disponível, alguns campos podem ser None.

lineno
end_lineno
col_offset
end_col_offset

Novo na versão 3.11.

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

Instruções gerais

NOP

Código para não fazer nada. Usado como espaço reservado pelo otimizador de bytecode, e para gerar eventos de rastreamento de linha.

POP_TOP

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

COPY(i)

Push the i-th item to the top of the stack. The item is not removed from its original location.

Novo na versão 3.11.

SWAP(i)

Swap TOS with the item at position i.

Novo na versão 3.11.

CACHE

Ao invés de ser uma instrução de fato, este opcode é usado para demarcar espaço extra para o interpretador armazernar dados úteis diretamente no próprio bytecode. É escondido automaticamente por todas as utilidades do dis, mas pode ser visualizado com show_caches=True.

Do ponto de vista lógico, este espaço faz parte da instrução anterior. Muitos opcodes esperam ser seguidos por um número exato de caches, e instruem o interpretador a pulá-los em tempo de execução.

Caches populados podem se parecer com qualquer instrução, de forma que ler ou modificar bytecode adaptativo bruto contendo dados “quickened” requer muito cuidado.

Novo na versão 3.11.

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

Implements TOS = ~TOS.

GET_ITER

Implements 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 e internas

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.

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.

BINARY_OP(op)

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

Novo na versão 3.11.

BINARY_SUBSCR

Implements TOS = TOS1[TOS].

STORE_SUBSCR

Implements TOS1[TOS] = TOS2.

DELETE_SUBSCR

Implements del TOS1[TOS].

Opcodes para corrotinas

GET_AWAITABLE(where)

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__.

Se o operando where não for zero, ele indica onde a instrução ocorre:

  • 1 After a call to __aenter__

  • 2 After a call to __aexit__

Novo na versão 3.5.

Alterado na versão 3.11: Anteriormente, esta instrução não tinha um oparg.

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

Pushes get_awaitable(TOS.__anext__()) to the stack. 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. The stack contains the async iterable in TOS1 and the raised exception in TOS. Both are popped. If the exception is not StopAsyncIteration, it is re-raised.

Novo na versão 3.8.

Alterado na versão 3.11: A representação da exceção na pilha consiste agora de um item, ao invés de três.

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.

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.

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_EXCEPT

Remove o valor no topo da pilha, o qual é usado para restaurar o estado de exceção.

Alterado na versão 3.11: A representação da exceção na pilha consiste agora de um item, ao invés de três.

RERAISE

Re-levanta a exceção que se encontra no topo da pilha. Se o oparg não for zero, remove um valor adicional do topo da pilha, o qual é atribuído ao f_lasti` do quadro atual.

Novo na versão 3.9.

Alterado na versão 3.11: A representação da exceção na pilha consiste agora de um item, ao invés de três.

PUSH_EXC_INFO

Remove um valor do topo da pilha. Põe a exceção atual no topo da pilha. Põe de volta no topo da pilha o valor que foi removido inicialmente. Usado em tratadores de exceções.

Novo na versão 3.11.

CHECK_EXC_MATCH

Performs exception matching for except. Tests whether the TOS1 is an exception matching TOS. Pops TOS and pushes the boolean result of the test.

Novo na versão 3.11.

CHECK_EG_MATCH

Performs exception matching for except*. Applies split(TOS) on the exception group representing TOS1.

No caso de uma correspondência, remove dois itens do topo da pilha e põe nela o subgrupo que falhou a correspondência (None caso a correspondência tenha sido total), seguido pelo subgrupo que correspondeu. Quando não há correspondência nenhuma, remove um item (o tipo da correspondêcia) e põe None no seu lugar.

Novo na versão 3.11.

PREP_RERAISE_STAR

Combines the raised and reraised exceptions list from TOS, into an exception group to propagate from a try-except* block. Uses the original exception group from TOS1 to reconstruct the structure of reraised exceptions. Pops two items from the stack and pushes the exception to reraise or None if there isn’t one.

Novo na versão 3.11.

WITH_EXCEPT_START

Chama a função na posição 4 da pilha com argumentos (tipo, val, tb) representando a exceção no topo da pilha. Usado para implementar a chamada context_manager.__exit__(*exc_info()) quando uma exceção ocorreu em uma instrução with.

Novo na versão 3.9.

Alterado na versão 3.11: A função __exit__ fica agora na posição 4 pilha, ao invés da 7. A representação da exceção pilha consiste agora de um item, não três.

LOAD_ASSERTION_ERROR

Põe AssertionError no topo da pilha. Usado pela instrução assert.

Novo na versão 3.9.

LOAD_BUILD_CLASS

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

BEFORE_WITH(delta)

Este opcode realiza várias operações antes do início de um bloco “with”. Primeiro, ele carrega o __exit__() do gerenciador de contexto e o coloca no topo da pilha para ser usado posteriormente pela WITH_EXCEPT_START. Então, o método __enter__() é chamado. Por fim, o resultado do __enter__() é posto no topo da pilha.

Novo na versão 3.11.

GET_LEN

Push len(TOS) onto the stack.

Novo na versão 3.10.

MATCH_MAPPING

If TOS 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.

Novo na versão 3.10.

MATCH_SEQUENCE

If TOS 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.

Novo na versão 3.10.

MATCH_KEYS

TOS is a tuple of mapping keys, and TOS1 is the match subject. If TOS1 contains all of the keys in TOS, push a tuple containing the corresponding values. Otherwise, push None.

Novo na versão 3.10.

Alterado na versão 3.11: Anteriormente, essa instrução também colocava na pilha um valor booleano indicando sucesso (True) ou falha (False).

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)

Implementa del name, onde namei é o índice no atributo co_names do objeto de código.

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 of the code object.

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.

LIST_TO_TUPLE

Pops a list from the stack and pushes a tuple containing the same values.

Novo na versão 3.9.

LIST_EXTEND(i)

Calls list.extend(TOS1[-i], TOS). Used to build lists.

Novo na versão 3.9.

SET_UPDATE(i)

Calls set.update(TOS1[-i], TOS). Used to build sets.

Novo na versão 3.9.

DICT_UPDATE(i)

Calls dict.update(TOS1[-i], TOS). Used to build dicts.

Novo na versão 3.9.

DICT_MERGE(i)

Like DICT_UPDATE but raises an exception for duplicate keys.

Novo na versão 3.9.

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].

IS_OP(invert)

Performs is comparison, or is not if invert is 1.

Novo na versão 3.9.

CONTAINS_OP(invert)

Performs in comparison, or not in if invert is 1.

Novo na versão 3.9.

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.

JUMP_BACKWARD(delta)

Decrements bytecode counter by delta. Checks for interrupts.

Novo na versão 3.11.

JUMP_BACKWARD_NO_INTERRUPT(delta)

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

Novo na versão 3.11.

POP_JUMP_FORWARD_IF_TRUE(delta)

If TOS is true, increments the bytecode counter by delta. TOS is popped.

Novo na versão 3.11.

POP_JUMP_BACKWARD_IF_TRUE(delta)

If TOS is true, decrements the bytecode counter by delta. TOS is popped.

Novo na versão 3.11.

POP_JUMP_FORWARD_IF_FALSE(delta)

If TOS is false, increments the bytecode counter by delta. TOS is popped.

Novo na versão 3.11.

POP_JUMP_BACKWARD_IF_FALSE(delta)

If TOS is false, decrements the bytecode counter by delta. TOS is popped.

Novo na versão 3.11.

POP_JUMP_FORWARD_IF_NOT_NONE(delta)

If TOS is not None, increments the bytecode counter by delta. TOS is popped.

Novo na versão 3.11.

POP_JUMP_BACKWARD_IF_NOT_NONE(delta)

If TOS is not None, decrements the bytecode counter by delta. TOS is popped.

Novo na versão 3.11.

POP_JUMP_FORWARD_IF_NONE(delta)

If TOS is None, increments the bytecode counter by delta. TOS is popped.

Novo na versão 3.11.

POP_JUMP_BACKWARD_IF_NONE(delta)

If TOS is None, decrements the bytecode counter by delta. TOS is popped.

Novo na versão 3.11.

JUMP_IF_TRUE_OR_POP(delta)

If TOS is true, increments the bytecode counter by delta and leaves TOS on the stack. Otherwise (TOS is false), TOS is popped.

Novo na versão 3.1.

Alterado na versão 3.11: The oparg is now a relative delta rather than an absolute target.

JUMP_IF_FALSE_OR_POP(delta)

If TOS is false, increments the bytecode counter by delta and leaves TOS on the stack. Otherwise (TOS is true), TOS is popped.

Novo na versão 3.1.

Alterado na versão 3.11: The oparg is now a relative delta rather than an absolute 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>>1] onto the stack.

Alterado na versão 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)

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].

MAKE_CELL(i)

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

Novo na versão 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.

Alterado na versão 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.

Alterado na versão 3.11: i is no longer offset by the length of co_varnames.

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.

Alterado na versão 3.11: i is no longer offset by the length of co_varnames.

STORE_DEREF(i)

Stores TOS into the cell contained in slot i of the “fast locals” storage.

Alterado na versão 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.

Novo na versão 3.2.

Alterado na versão 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.

Novo na versão 3.11.

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(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.

Novo na versão 3.11.

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. 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 when calling the unbound method. Otherwise, NULL and the object return by the attribute lookup are pushed.

Novo na versão 3.7.

PRECALL(argc)

Prefixes CALL. Logically this is a no op. It exists to enable effective specialization of calls. argc is the number of arguments as described in CALL.

Novo na versão 3.11.

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.

Novo na versão 3.11.

KW_NAMES(i)

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

Novo na versão 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 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 a tuple of strings containing parameters’ annotations

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

  • the code associated with the function (at TOS)

Alterado na versão 3.10: Flag value 0x04 is a tuple of strings instead of dictionary

Alterado na versão 3.11: Qualified name at TOS was removed.

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.

MATCH_CLASS(count)

TOS is a tuple of keyword attribute names, TOS1 is the class being matched against, and TOS2 is the match subject. count is the number of positional sub-patterns.

Pop TOS, TOS1, and TOS2. If TOS2 is an instance of TOS1 and has the positional and keyword attributes required by count and TOS, push a tuple of extracted attributes. Otherwise, push None.

Novo na versão 3.10.

Alterado na versão 3.11: Anteriormente, essa instrução também colocava na pilha um valor booleano indicando sucesso (True) ou falha (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

  • 1 Depois de uma expressão yield

  • 2 After a yield from expression

  • 3 Depois de uma expressão await

Novo na versão 3.11.

RETURN_GENERATOR

Create a generator, coroutine, or async generator from the current frame. Clear the current frame and return the newly created generator.

Novo na versão 3.11.

SEND

Sends None to the sub-generator of this generator. Used in yield from and await statements.

Novo na versão 3.11.

ASYNC_GEN_WRAP

Wraps the value on top of the stack in an async_generator_wrapped_value. Used to yield in async generators.

Novo na versão 3.11.

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.