# Objetos código

Os objetos código são um detalhe de baixo nível da implementação do CPython. Cada um representa um pedaço de código executável que ainda não foi vinculado a uma função.

type PyCodeObject

  A estrutura C dos objetos usados para descrever objetos código. Os campos deste tipo estão sujeitos a alterações a qualquer momento.

PyTypeObject PyCode_Type

  Esta é uma instância de `PyTypeObject` representando o objeto código Python.

int PyCode_Check(PyObject *co)

  Retorna verdadeiro se co for um objeto código. Esta função sempre tem sucesso.

int PyCode_GetNumFree(PyCodeObject *co)

  Retorna o número de variáveis livres em co.

PyCodeObject *PyCode_New(int argcount, int kwonlyargcount, int nlocals, int stacksize, int flags, PyObject *code, PyObject *consts, PyObject *names, PyObject *varnames, PyObject *freevars, PyObject *cellvars, PyObject *filename, PyObject *name, PyObject *qualname, int firstlineno, PyObject *linetable, PyObject *exceptiontable)
  Retorna valor: Nova referência.

  Retorna um novo objeto código. Se você precisar de um objeto código fictício para criar um quadro, use `PyCode_NewEmpty()`. Chamar `PyCode_New()` diretamente irá vincular você a uma versão precisa do Python, já que a definição do bytecode muda frequentemente. Os muitos argumentos dessa função são interdependentes de maneiras complexas, o que significa que alterações sutis nos valores provavelmente resultarão em execução incorreta ou travamentos da VM. Use esta função apenas com extremo cuidado.

  Alterado na versão 3.11: Adicionou os parâmetros `qualname` e `exceptiontable`

PyCodeObject *PyCode_NewWithPosOnlyArgs(int argcount, int posonlyargcount, int kwonlyargcount, int nlocals, int stacksize, int flags, PyObject *code, PyObject *consts, PyObject *names, PyObject *varnames, PyObject *freevars, PyObject *cellvars, PyObject *filename, PyObject *name, PyObject *qualname, int firstlineno, PyObject *linetable, PyObject *exceptiontable)
  Retorna valor: Nova referência.

  Semelhante a `PyCode_New()` mas com um “posonlyargcount” extra para argumentos somente posicionais. As mesmas advertências que se aplicam a `PyCode_New` também se aplicam a esta função.

  Novo na versão 3.8.

  Alterado na versão 3.11: Adicionados os parâmetros `qualname` e `exceptiontable`

PyCodeObject *PyCode_NewEmpty(const char *filename, const char *funcname, int firstlineno)
  Retorna valor: Nova referência.

  Retorna um novo objeto código vazio com o nome de arquivo, nome da função e número da primeira linha especificados. O objeto código resultante irá levantar uma `Exception` se executado.

int PyCode_Addr2Line(PyCodeObject *co, int byte_offset)

  Retorna o número da linha da instrução que ocorre em ou antes de `byte_offset` e termina depois disso. Se você só precisa do número da linha de um quadro, use `PyFrame_GetLineNumber()`.

  Para iterar eficientemente sobre os números de linha em um objeto código, use a API descrita em PEP 626 .

int PyCode_Addr2Location(PyObject *co, int byte_offset, int *start_line, int *start_column, int *end_line, int *end_column)

  Define os ponteiros `int` passados para a linha do código-fonte e os números da coluna para a instrução em `byte_offset`. Define o valor como `0` quando as informações não estão disponíveis para nenhum elemento em particular.

  Retorna `1` se a função for bem-sucedida e 0 caso contrário.

  Novo na versão 3.11.

PyObject *PyCode_GetCode(PyCodeObject *co)

  Equivalente ao código Python `getattr(co, 'co_code')`. Retorna uma referência forte a um `PyBytesObject` representando o bytecode em um objeto código. Em caso de erro, `NULL` é retornado e uma exceção é levantada.

  Este `PyBytesObject` pode ser criado sob demanda pelo interpretador e não representa necessariamente o bytecode realmente executado pelo CPython. O caso de uso primário para esta função são depuradores e criadores de perfil.

  Novo na versão 3.11.

PyObject *PyCode_GetVarnames(PyCodeObject *co)

  Equivalente ao código Python `getattr(co, 'co_varnames')`. Retorna uma nova referência a um `PyTupleObject` contendo os nomes das variáveis locais. Em caso de erro, `NULL` é retornado e uma exceção é levantada.

  Novo na versão 3.11.

PyObject *PyCode_GetCellvars(PyCodeObject *co)

  Equivalente ao código Python `getattr(co, 'co_cellvars')`. Retorna uma nova referência a um `PyTupleObject` contendo os nomes das variáveis locais referenciadas por funções aninhadas. Em caso de erro, `NULL` é retornado e uma exceção é levantada.

  Novo na versão 3.11.

PyObject *PyCode_GetFreevars(PyCodeObject *co)

  Equivalente ao código Python `getattr(co, 'co_freevars')`. Retorna uma nova referência a um `PyTupleObject` contendo os nomes das variáveis livres. Em caso de erro, `NULL` é retornado e uma exceção é levantada.

  Novo na versão 3.11.