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.
Return true if co is a code object. This function always succeeds.
Return the number of free (closure) variables in a code object.
Return the position of the first free (closure) variable in a code object.
Changed in version 3.13: Renamed from PyCode_GetFirstFree
as part of Unstable C API. The old name is deprecated, but will remain available until the signature changes again.
Return a new code object. If you need a dummy code object to create a frame, use PyCode_NewEmpty()
instead.
Since the definition of the bytecode changes often, calling PyUnstable_Code_New()
directly can bind you to a precise Python version.
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.
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.
Similar to 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.
Added in version 3.8: as PyCode_NewWithPosOnlyArgs
Changed in version 3.11: Added qualname
and exceptiontable
parameters.
Changed in version 3.12: Renamed to PyUnstable_Code_NewWithPosOnlyArgs
. The old name is deprecated, but will remain available until the signature changes again.
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.
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()
instead.
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.
Returns 1
if the function succeeds and 0 otherwise.
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.
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.
Added in version 3.11.
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.
Added in version 3.11.
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.
Added in version 3.11.
Equivalent to the Python code getattr(co, 'co_freevars')
. Returns a new reference to a PyTupleObject
containing the names of the free (closure) variables. On error, NULL
is returned and an exception is raised.
Added in version 3.11.
Register 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.
Added in version 3.12.
Clear watcher identified by watcher_id previously returned from PyCode_AddWatcher()
for the current interpreter. Return 0
on success, or -1
and set an exception on error (e.g. if the given watcher_id was never registered.)
Added in version 3.12.
Enumeration of possible code object watcher events: - PY_CODE_EVENT_CREATE
- PY_CODE_EVENT_DESTROY
Added in version 3.12.
Type of a code object watcher callback function.
If 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.
If 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
.
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.
Added in version 3.12.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4