/usr/share/doc/python3-docs/html/_sources/c-api
NameSizeModeActions
abstract.rst.txt7150644editdlrm
allocation.rst.txt26530644editdlrm
apiabiversion.rst.txt22420644editdlrm
arg.rst.txt306510644editdlrm
bool.rst.txt12000644editdlrm
buffer.rst.txt222670644editdlrm
bytearray.rst.txt22500644editdlrm
bytes.rst.txt92110644editdlrm
capsule.rst.txt57410644editdlrm
cell.rst.txt19400644editdlrm
code.rst.txt16660644editdlrm
codec.rst.txt47990644editdlrm
complex.rst.txt39460644editdlrm
concrete.rst.txt20460644editdlrm
conversion.rst.txt55160644editdlrm
coro.rst.txt8200644editdlrm
datetime.rst.txt64150644editdlrm
descriptor.rst.txt11110644editdlrm
dict.rst.txt79520644editdlrm
exceptions.rst.txt478140644editdlrm
file.rst.txt32480644editdlrm
float.rst.txt22430644editdlrm
function.rst.txt33480644editdlrm
gcsupport.rst.txt60570644editdlrm
gen.rst.txt13010644editdlrm
import.rst.txt128250644editdlrm
index.rst.txt6130644editdlrm
init.rst.txt523830644editdlrm
intro.rst.txt287510644editdlrm
iter.rst.txt11290644editdlrm
iterator.rst.txt16400644editdlrm
list.rst.txt47350644editdlrm
long.rst.txt104360644editdlrm
mapping.rst.txt28710644editdlrm
marshal.rst.txt35610644editdlrm
memory.rst.txt213690644editdlrm
memoryview.rst.txt23480644editdlrm
method.rst.txt28180644editdlrm
module.rst.txt182660644editdlrm
none.rst.txt7400644editdlrm
number.rst.txt105830644editdlrm
objbuffer.rst.txt21980644editdlrm
object.rst.txt174200644editdlrm
objimpl.rst.txt3040644editdlrm
refcounting.rst.txt29090644editdlrm
reflection.rst.txt14170644editdlrm
sequence.rst.txt65470644editdlrm
set.rst.txt61440644editdlrm
slice.rst.txt24040644editdlrm
stable.rst.txt19690644editdlrm
structures.rst.txt137870644editdlrm
sys.rst.txt99440644editdlrm
tuple.rst.txt80310644editdlrm
type.rst.txt39630644editdlrm
typeobj.rst.txt601840644editdlrm
unicode.rst.txt680740644editdlrm
utilities.rst.txt4140644editdlrm
veryhigh.rst.txt166550644editdlrm
weakref.rst.txt26350644editdlrm
Edit: /usr/share/doc/python3-docs/html/_sources/c-api/weakref.rst.txt (2635B)
.. highlightlang:: c .. _weakrefobjects: Weak Reference Objects ---------------------- Python supports *weak references* as first-class objects. There are two specific object types which directly implement weak references. The first is a simple reference object, and the second acts as a proxy for the original object as much as it can. .. c:function:: int PyWeakref_Check(ob) Return true if *ob* is either a reference or proxy object. .. c:function:: int PyWeakref_CheckRef(ob) Return true if *ob* is a reference object. .. c:function:: int PyWeakref_CheckProxy(ob) Return true if *ob* is a proxy object. .. c:function:: PyObject* PyWeakref_NewRef(PyObject *ob, PyObject *callback) Return a weak reference object for the object *ob*. This will always return a new reference, but is not guaranteed to create a new object; an existing reference object may be returned. The second parameter, *callback*, can be a callable object that receives notification when *ob* is garbage collected; it should accept a single parameter, which will be the weak reference object itself. *callback* may also be ``None`` or *NULL*. If *ob* is not a weakly-referencable object, or if *callback* is not callable, ``None``, or *NULL*, this will return *NULL* and raise :exc:`TypeError`. .. c:function:: PyObject* PyWeakref_NewProxy(PyObject *ob, PyObject *callback) Return a weak reference proxy object for the object *ob*. This will always return a new reference, but is not guaranteed to create a new object; an existing proxy object may be returned. The second parameter, *callback*, can be a callable object that receives notification when *ob* is garbage collected; it should accept a single parameter, which will be the weak reference object itself. *callback* may also be ``None`` or *NULL*. If *ob* is not a weakly-referencable object, or if *callback* is not callable, ``None``, or *NULL*, this will return *NULL* and raise :exc:`TypeError`. .. c:function:: PyObject* PyWeakref_GetObject(PyObject *ref) Return the referenced object from a weak reference, *ref*. If the referent is no longer live, returns :const:`Py_None`. .. note:: This function returns a **borrowed reference** to the referenced object. This means that you should always call :c:func:`Py_INCREF` on the object except if you know that it cannot be destroyed while you are still using it. .. c:function:: PyObject* PyWeakref_GET_OBJECT(PyObject *ref) Similar to :c:func:`PyWeakref_GetObject`, but implemented as a macro that does no error checking.