Python’s support for detecting and collecting garbage which involves circular references requires support from object types which are “containers” for other objects which may also be containers. Types which do not store references to other objects, or which only store references to atomic types (such as numbers or strings), do not need to provide any explicit support for garbage collection.
To create a container type, the tp_flags field of the type object must include the Py_TPFLAGS_HAVE_GC and provide an implementation of the tp_traverse handler. If instances of the type are mutable, a tp_clear implementation must also be provided.
tp_flags
Py_TPFLAGS_HAVE_GC
tp_traverse
tp_clear
Objects with a type with this flag set must conform with the rules documented here. For convenience these objects will be referred to as container objects.
Constructors for container types must conform to two rules:
The memory for the object must be allocated using PyObject_GC_New or PyObject_GC_NewVar .
PyObject_GC_New
PyObject_GC_NewVar
Once all the fields which may contain references to other containers are initialized, it must call PyObject_GC_Track() .
PyObject_GC_Track()
Similarly, the deallocator for the object must conform to a similar pair of rules:
Before fields which refer to other containers are invalidated, PyObject_GC_UnTrack() must be called.
PyObject_GC_UnTrack()
The object’s memory must be deallocated using PyObject_GC_Del() .
PyObject_GC_Del()
警告
If a type adds the Py_TPFLAGS_HAVE_GC, then it must implement at least a tp_traverse handler or explicitly use one from its subclass or subclasses.
When calling PyType_Ready() or some of the APIs that indirectly call it like PyType_FromSpecWithBases() or PyType_FromSpec() the interpreter will automatically populate the tp_flags , tp_traverse and tp_clear fields if the type inherits from a class that implements the garbage collector protocol and the child class does not include the Py_TPFLAGS_HAVE_GC 标志。
PyType_Ready()
PyType_FromSpecWithBases()
PyType_FromSpec()
Analogous to PyObject_New but for container objects with the Py_TPFLAGS_HAVE_GC 设置标志。
PyObject_New
Analogous to PyObject_NewVar but for container objects with the Py_TPFLAGS_HAVE_GC 设置标志。
PyObject_NewVar
Analogous to PyObject_GC_New but allocates extra_size bytes at the end of the object (at offset tp_basicsize ). The allocated memory is initialized to zeros, except for the Python object header .
tp_basicsize
Python object header
The extra data will be deallocated with the object, but otherwise it is not managed by Python.
The function is marked as unstable because the final mechanism for reserving extra data after an instance is not yet decided. For allocating a variable number of fields, prefer using PyVarObject and tp_itemsize 代替。
PyVarObject
tp_itemsize
3.12 版添加。
Resize an object allocated by PyObject_NewVar . Returns the resized object of type TYPE* (refers to any C type) or NULL 当故障时。
TYPE*
NULL
op must be of type PyVarObject * and must not be tracked by the collector yet. newsize must be of type Py_ssize_t .
Py_ssize_t
Adds the object op to the set of container objects tracked by the collector. The collector can run at unexpected times so objects must be valid while being tracked. This should be called once all the fields followed by the tp_traverse handler become valid, usually near the end of the constructor.
Returns non-zero if the object implements the garbage collector protocol, otherwise returns 0.
The object cannot be tracked by the garbage collector if this function returns 0.
Returns 1 if the object type of op implements the GC protocol and op is being currently tracked by the garbage collector and 0 otherwise.
This is analogous to the Python function gc.is_tracked() .
gc.is_tracked()
Added in version 3.9.
Returns 1 if the object type of op implements the GC protocol and op has been already finalized by the garbage collector and 0 otherwise.
This is analogous to the Python function gc.is_finalized() .
gc.is_finalized()
Releases memory allocated to an object using PyObject_GC_New or PyObject_GC_NewVar .
Remove the object op from the set of container objects tracked by the collector. Note that PyObject_GC_Track() can be called again on this object to add it back to the set of tracked objects. The deallocator ( tp_dealloc handler) should call this for the object before any of the fields used by the tp_traverse handler become invalid.
tp_dealloc
3.8 版改变： The _PyObject_GC_TRACK() and _PyObject_GC_UNTRACK() macros have been removed from the public C API.
_PyObject_GC_TRACK()
_PyObject_GC_UNTRACK()
The tp_traverse handler accepts a function parameter of this type:
Type of the visitor function passed to the tp_traverse handler. The function should be called with an object to traverse as object and the third parameter to the tp_traverse handler as arg . The Python core uses several visitor functions to implement cyclic garbage detection; it’s not expected that users will need to write their own visitor functions.
The tp_traverse handler must have the following type:
Traversal function for a container object. Implementations must call the visit function for each object directly contained by self , with the parameters to visit being the contained object and the arg value passed to the handler. The visit function must not be called with a NULL object argument. If visit returns a non-zero value that value should be returned immediately.
To simplify writing tp_traverse handlers, a Py_VISIT() macro is provided. In order to use this macro, the tp_traverse implementation must name its arguments exactly visit and arg :
Py_VISIT()
若 o 不是 NULL , call the visit callback, with arguments o and arg 。若 visit returns a non-zero value, then return it. Using this macro, tp_traverse handlers look like:
static int my_traverse(Noddy *self, visitproc visit, void *arg) { Py_VISIT(self->foo); Py_VISIT(self->bar); return 0; }
The tp_clear handler must be of the inquiry type, or NULL if the object is immutable.
inquiry
Drop references that may have created reference cycles. Immutable objects do not have to define this method since they can never directly create reference cycles. Note that the object must still be valid after calling this method (don’t just call Py_DECREF() on a reference). The collector will call this method if it detects that this object is involved in a reference cycle.
Py_DECREF()
The C-API provides the following functions for controlling garbage collection runs.
Perform a full garbage collection, if the garbage collector is enabled. (Note that gc.collect() runs it unconditionally.)
gc.collect()
Returns the number of collected + unreachable objects which cannot be collected. If the garbage collector is disabled or already collecting, returns 0 immediately. Errors during garbage collection are passed to sys.unraisablehook . This function does not raise exceptions.
0
sys.unraisablehook
Enable the garbage collector: similar to gc.enable() . Returns the previous state, 0 for disabled and 1 for enabled.
gc.enable()
Added in version 3.10.
Disable the garbage collector: similar to gc.disable() . Returns the previous state, 0 for disabled and 1 for enabled.
gc.disable()
Query the state of the garbage collector: similar to gc.isenabled() . Returns the current state, 0 for disabled and 1 for enabled.
gc.isenabled()
The C-API provides the following interface for querying information about the garbage collector.
Run supplied callback on all live GC-capable objects. arg is passed through to all invocations of callback .
If new objects are (de)allocated by the callback it is undefined if they will be visited.
Garbage collection is disabled during operation. Explicitly running a collection in the callback may lead to undefined behaviour e.g. visiting the same objects multiple times or not at all.
Type of the visitor function to be passed to PyUnstable_GC_VisitObjects() . arg is the same as the arg passed to PyUnstable_GC_VisitObjects 。返回 0 to continue iteration, return 1 to stop iteration. Other return values are reserved for now so behavior on returning anything else is undefined.
PyUnstable_GC_VisitObjects()
PyUnstable_GC_VisitObjects
1
类型对象
API 和 ABI 版本控制
键入搜索术语或模块、类、函数名称。