参照カウント

このセクションにある関数とマクロは、 Python オブジェクトの参照カウントの管理に使用されます。

Py_ssize_t Py_REFCNT(PyObject *o)

次に属します: Stable ABI (バージョン 3.14 より).

Python オブジェクト o の参照カウントを取得します。

戻り値は、実際に保持されているオブジェクトの参照の数を実際に反映しているとは限らないことに注意してください。例えば、一部のオブジェクトは永続 (immortal) であり、実際の参照の数を反映しない非常に高い参照数を持ちます。したがって、 0 か 1 の値以外では、正確な戻り値に頼らないでください。

オブジェクトの参照カウントを設定するためには、 Py_SET_REFCNT() 関数を使用してください。

バージョン 3.10 で変更: Py_REFCNT() は static なインライン関数に変更されました。

バージョン 3.11 で変更: 引数の型は const PyObject* ではなくなりました。

void Py_SET_REFCNT(PyObject *o, Py_ssize_t refcnt)

オブジェクト o の参照カウントを refcnt に設定します。

フリースレッドな Python ビルド では、 refcnt が UINT32_MAX より大きい場合、オブジェクトは永続 (immortal) となります。

この関数は永続 (immortal) オブジェクトには何もしません。

Added in version 3.9.

バージョン 3.12 で変更: 永続オブジェクトは変更されません。

void Py_INCREF(PyObject *o)

オブジェクト o への新しい 強参照 を取得し、それが使用中で破棄されてはならないことを示します。

この関数は永続 (immortal) オブジェクトには何もしません。

This function is usually used to convert a borrowed reference to a strong reference in-place. The Py_NewRef() function can be used to create a new strong reference.

When done using the object, release is by calling Py_DECREF().

オブジェクトが NULL であってはいけません。それが NULL ではないと確信が持てないならば、 Py_XINCREF() を使ってください。

Do not expect this function to actually modify o in any way. For at least some objects, this function has no effect.

バージョン 3.12 で変更: 永続オブジェクトは変更されません。

void Py_XINCREF(PyObject *o)

Similar to Py_INCREF(), but the object o can be NULL, in which case this has no effect.

See also Py_XNewRef().

PyObject *Py_NewRef(PyObject *o)

次に属します: Stable ABI (バージョン 3.10 より).

Create a new strong reference to an object: call Py_INCREF() on o and return the object o.

When the strong reference is no longer needed, Py_DECREF() should be called on it to release the reference.

The object o must not be NULL; use Py_XNewRef() if o can be NULL.

例えば:

Py_INCREF(obj);
self->attr = obj;

can be written as:

self->attr = Py_NewRef(obj);

See also Py_INCREF().

Added in version 3.10.

PyObject *Py_XNewRef(PyObject *o)

次に属します: Stable ABI (バージョン 3.10 より).

Similar to Py_NewRef(), but the object o can be NULL.

If the object o is NULL, the function just returns NULL.

Added in version 3.10.

void Py_DECREF(PyObject *o)

Release a strong reference to object o, indicating the reference is no longer used.

この関数は永続 (immortal) オブジェクトには何もしません。

Once the last strong reference is released (i.e. the object's reference count reaches 0), the object's type's deallocation function (which must not be NULL) is invoked.

This function is usually used to delete a strong reference before exiting its scope.

オブジェクトが NULL であってはいけません。それが NULL ではないと確信が持てないならば、 Py_XDECREF() を使ってください。

Do not expect this function to actually modify o in any way. For at least some objects, this function has no effect.

警告

The deallocation function can cause arbitrary Python code to be invoked (e.g. when a class instance with a __del__() method is deallocated). While exceptions in such code are not propagated, the executed code has free access to all Python global variables. This means that any object that is reachable from a global variable should be in a consistent state before Py_DECREF() is invoked. For example, code to delete an object from a list should copy a reference to the deleted object in a temporary variable, update the list data structure, and then call Py_DECREF() for the temporary variable.

バージョン 3.12 で変更: 永続オブジェクトは変更されません。

void Py_XDECREF(PyObject *o)

Similar to Py_DECREF(), but the object o can be NULL, in which case this has no effect. The same warning from Py_DECREF() applies here as well.

void Py_CLEAR(PyObject *o)

Release a strong reference for object o. The object may be NULL, in which case the macro has no effect; otherwise the effect is the same as for Py_DECREF(), except that the argument is also set to NULL. The warning for Py_DECREF() does not apply with respect to the object passed because the macro carefully uses a temporary variable and sets the argument to NULL before releasing the reference.

It is a good idea to use this macro whenever releasing a reference to an object that might be traversed during garbage collection.

バージョン 3.12 で変更: The macro argument is now only evaluated once. If the argument has side effects, these are no longer duplicated.

void Py_IncRef(PyObject *o)

次に属します: Stable ABI.

Indicate taking a new strong reference to object o. A function version of Py_XINCREF(). It can be used for runtime dynamic embedding of Python.

void Py_DecRef(PyObject *o)

次に属します: Stable ABI.

Release a strong reference to object o. A function version of Py_XDECREF(). It can be used for runtime dynamic embedding of Python.

Py_SETREF(dst, src)

Macro safely releasing a strong reference to object dst and setting dst to src.

As in case of Py_CLEAR(), "the obvious" code can be deadly:

Py_DECREF(dst);
dst = src;

The safe way is:

Py_SETREF(dst, src);

That arranges to set dst to src _before_ releasing the reference to the old value of dst, so that any code triggered as a side-effect of dst getting torn down no longer believes dst points to a valid object.

Added in version 3.6.

バージョン 3.12 で変更: The macro arguments are now only evaluated once. If an argument has side effects, these are no longer duplicated.

Py_XSETREF(dst, src)

Variant of Py_SETREF macro that uses Py_XDECREF() instead of Py_DECREF().

Added in version 3.6.

バージョン 3.12 で変更: The macro arguments are now only evaluated once. If an argument has side effects, these are no longer duplicated.