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.
The C structure of the objects used to describe code objects. The fields of this type are subject to change at any time.
This is an instance of PyTypeObject representing the Python code object .
PyTypeObject
返回 True 若 co 是 code object . This function always succeeds.
Return the number of free variables in a code object.
Return the position of the first free variable in a code object.
Return a new code object. If you need a dummy code object to create a frame, use PyCode_NewEmpty() 代替。
PyCode_NewEmpty()
Since the definition of the bytecode changes often, calling PyUnstable_Code_New() directly can bind you to a precise Python version.
PyUnstable_Code_New()
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.
3.11 版改变： 添加 qualname and exceptiontable 参数。
qualname
exceptiontable
Changed in version 3.12: Renamed from PyCode_New as part of Unstable C API . The old name is deprecated, but will remain available until the signature changes again.
PyCode_New
类似于 PyUnstable_Code_New() , but with an extra “posonlyargcount” for positional-only arguments. The same caveats that apply to PyUnstable_Code_New also apply to this function.
PyUnstable_Code_New
Added in version 3.8: as PyCode_NewWithPosOnlyArgs
PyCode_NewWithPosOnlyArgs
Changed in version 3.12: Renamed to PyUnstable_Code_NewWithPosOnlyArgs . The old name is deprecated, but will remain available until the signature changes again.
PyUnstable_Code_NewWithPosOnlyArgs
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.
Exception
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 PyFrame_GetLineNumber() 代替。
byte_offset
PyFrame_GetLineNumber()
For efficiently iterating over the line numbers in a code object, use the API described in PEP 626 .
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.
int
0
返回 1 if the function succeeds and 0 otherwise.
1
Added in version 3.11.
Equivalent to the Python code getattr(co, 'co_code') . Returns a strong reference to a PyBytesObject representing the bytecode in a code object. On error, NULL is returned and an exception is raised.
getattr(co, 'co_code')
PyBytesObject
NULL
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.
Equivalent to the Python code getattr(co, 'co_varnames') . Returns a new reference to a PyTupleObject containing the names of the local variables. On error, NULL is returned and an exception is raised.
getattr(co, 'co_varnames')
PyTupleObject
Equivalent to the Python code getattr(co, 'co_cellvars') . Returns a new reference to a PyTupleObject containing the names of the local variables that are referenced by nested functions. On error, NULL is returned and an exception is raised.
getattr(co, 'co_cellvars')
Equivalent to the Python code getattr(co, 'co_freevars') . Returns a new reference to a PyTupleObject containing the names of the free variables. On error, NULL is returned and an exception is raised.
getattr(co, 'co_freevars')
注册 callback as a code object watcher for the current interpreter. Return an ID which may be passed to PyCode_ClearWatcher() . In case of error (e.g. no more watcher IDs available), return -1 and set an exception.
PyCode_ClearWatcher()
-1
3.12 版添加。
Clear watcher identified by watcher_id previously returned from PyCode_AddWatcher() for the current interpreter. Return 0 当成功时，或 -1 and set an exception on error (e.g. if the given watcher_id was never registered.)
PyCode_AddWatcher()
Enumeration of possible code object watcher events: - PY_CODE_EVENT_CREATE - PY_CODE_EVENT_DESTROY
PY_CODE_EVENT_CREATE
PY_CODE_EVENT_DESTROY
Type of a code object watcher callback function.
若 event is PY_CODE_EVENT_CREATE , then the callback is invoked after co has been fully initialized. Otherwise, the callback is invoked before the destruction of co takes place, so the prior state of co can be inspected.
若 event is PY_CODE_EVENT_DESTROY , taking a reference in the callback to the about-to-be-destroyed code object will resurrect it and prevent it from being freed at this time. When the resurrected object is destroyed later, any watcher callbacks active at that time will be called again.
Users of this API should not rely on internal runtime implementation details. Such details may include, but are not limited to, the exact order and timing of creation and destruction of code objects. While changes in these details may result in differences observable by watchers (including whether a callback is invoked or not), it does not change the semantics of the Python code being executed.
If the callback sets an exception, it must return -1 ; this exception will be printed as an unraisable exception using PyErr_WriteUnraisable() . Otherwise it should return 0 .
PyErr_WriteUnraisable()
There may already be a pending exception set on entry to the callback. In this case, the callback should return 0 with the same exception still set. This means the callback may not call any other API that can set an exception unless it saves and clears the exception state first, and restores it before returning.
To support low-level extensions to frame evaluation, such as external just-in-time compilers, it is possible to attach arbitrary extra data to code objects.
These functions are part of the unstable C API tier: this functionality is a CPython implementation detail, and the API may change without deprecation warnings.
Return a new an opaque index value used to adding data to code objects.
You generally call this function once (per interpreter) and use the result with PyCode_GetExtra and PyCode_SetExtra to manipulate data on individual code objects.
PyCode_GetExtra
PyCode_SetExtra
若 free 不是 NULL : when a code object is deallocated, free will be called on non- NULL data stored under the new index. Use Py_DecRef() when storing PyObject .
Py_DecRef()
PyObject
Added in version 3.6: as _PyEval_RequestCodeExtraIndex
_PyEval_RequestCodeExtraIndex
Changed in version 3.12: Renamed to PyUnstable_Eval_RequestCodeExtraIndex . The old private name is deprecated, but will be available until the API changes.
PyUnstable_Eval_RequestCodeExtraIndex
Set extra to the extra data stored under the given index. Return 0 on success. Set an exception and return -1 on failure.
If no data was set under the index, set extra to NULL and return 0 without setting an exception.
Added in version 3.6: as _PyCode_GetExtra
_PyCode_GetExtra
Changed in version 3.12: Renamed to PyUnstable_Code_GetExtra . The old private name is deprecated, but will be available until the API changes.
PyUnstable_Code_GetExtra
Set the extra data stored under the given index to extra . Return 0 on success. Set an exception and return -1 on failure.
Added in version 3.6: as _PyCode_SetExtra
_PyCode_SetExtra
Changed in version 3.12: Renamed to PyUnstable_Code_SetExtra . The old private name is deprecated, but will be available until the API changes.
PyUnstable_Code_SetExtra
单元格对象
文件对象
键入搜索术语或模块、类、函数名称。