Code objects are a low-level detail of the CPython implementation. Each one represents a chunk of executable code that hasn’t yet been bound into a function.
typePyCodeObject
The C structure of the objects used to describe code objects. The fields of this type are subject to change at any time.
PyCode_Type
This is an instance of
representing the Python
.
intPyCode_Check(
*co)
Return true if co is a
. This function always succeeds.
intPyCode_GetNumFree(
*co)
Return the number of free variables in co.
*PyCode_New(intargcount, intkwonlyargcount, intnlocals, intstacksize, intflags,
*code,
*consts,
*names,
*varnames,
*freevars,
*cellvars,
*filename,
*name,
*qualname, intfirstlineno,
*linetable,
*exceptiontable)
Return value: New reference.Return a new code object. If you need a dummy code object to create a frame, use
instead. Calling
directly will bind you to a precise Python version since the definition of the bytecode changes often. The many arguments of this function are inter-dependent in complex ways, meaning that subtle changes to values are likely to result in incorrect execution or VM crashes. Use this function only with extreme care.
Changed in version 3.11: Added qualname and exceptiontable parameters.
*PyCode_NewWithPosOnlyArgs(intargcount, intposonlyargcount, intkwonlyargcount, intnlocals, intstacksize, intflags,
*code,
*consts,
*names,
*varnames,
*freevars,
*cellvars,
*filename,
*name,
*qualname, intfirstlineno,
*linetable,
*exceptiontable)
Return value: New reference.Similar to
, but with an extra “posonlyargcount” for positional-only arguments. The same caveats that apply to PyCode_New also apply to this function.
New in version 3.8.
Changed in version 3.11: Added qualname and exceptiontable parameters.
*PyCode_NewEmpty(constchar*filename, constchar*funcname, intfirstlineno)
Return value: New reference.Return a new empty code object with the specified filename, function name, and first line number. The resulting code object will raise an Exception if executed.
intPyCode_Addr2Line(
*co, intbyte_offset)
Return the line number of the instruction that occurs on or before byte_offset and ends after it. If you just need the line number of a frame, use
instead.
For efficiently iterating over the line numbers in a code object, use
.
intPyCode_Addr2Location(
*co, intbyte_offset, int*start_line, int*start_column, int*end_line, int*end_column)
Sets the passed int pointers to the source code line and column numbers for the instruction at byte_offset. Sets the value to 0 when information is not available for any particular element.
Returns 1 if the function succeeds and 0 otherwise.
New in version 3.11.
*PyCode_GetCode(
*co)
Equivalent to the Python code getattr(co,'co_code'). Returns a strong reference to a
representing the bytecode in a code object. On error, NULL is returned and an exception is raised.
This PyBytesObject may be created on-demand by the interpreter and does not necessarily represent the bytecode actually executed by CPython. The primary use case for this function is debuggers and profilers.
New in version 3.11.
*PyCode_GetVarnames(
*co)
Equivalent to the Python code getattr(co,'co_varnames'). Returns a new reference to a
containing the names of the local variables. On error, NULL is returned and an exception is raised.
New in version 3.11.
*PyCode_GetCellvars(
*co)
Equivalent to the Python code getattr(co,'co_cellvars'). Returns a new reference to a
containing the names of the local variables that are referenced by nested functions. On error, NULL is returned and an exception is raised.
New in version 3.11.
*PyCode_GetFreevars(
*co)
Equivalent to the Python code getattr(co,'co_freevars'). Returns a new reference to a
containing the names of the free variables. On error, NULL is returned and an exception is raised.
New in version 3.11.