通用物件結構

There are a large number of structures which are used in the definition of object types for Python. This section describes these structures and how they are used.

Base object types and macros

All Python objects ultimately share a small number of fields at the beginning of the object's representation in memory. These are represented by the PyObject and PyVarObject types, which are defined, in turn, by the expansions of some macros also used, whether directly or indirectly, in the definition of all other Python objects. Additional macros can be found under reference counting.

type PyObject
受限 API 的一部分. (只有部分成員是穩定 ABI 的一部分。)

All object types are extensions of this type. This is a type which contains the information Python needs to treat a pointer to an object as an object. In a normal "release" build, it contains only the object's reference count and a pointer to the corresponding type object. Nothing is actually declared to be a PyObject, but every pointer to a Python object can be cast to a PyObject*.

The members must not be accessed directly; instead use macros such as Py_REFCNT and Py_TYPE.

Py_ssize_t ob_refcnt
穩定 ABI 的一部分.

The object's reference count, as returned by Py_REFCNT. Do not use this field directly; instead use functions and macros such as Py_REFCNT, Py_INCREF() and Py_DecRef().

The field type may be different from Py_ssize_t, depending on build configuration and platform.

PyTypeObject *ob_type
穩定 ABI 的一部分.

The object's type. Do not use this field directly; use Py_TYPE and Py_SET_TYPE() instead.

type PyVarObject
受限 API 的一部分. (只有部分成員是穩定 ABI 的一部分。)

An extension of PyObject that adds the ob_size field. This is intended for objects that have some notion of length.

As with PyObject, the members must not be accessed directly; instead use macros such as Py_SIZE, Py_REFCNT and Py_TYPE.

Py_ssize_t ob_size
穩定 ABI 的一部分.

A size field, whose contents should be considered an object's internal implementation detail.

Do not use this field directly; use Py_SIZE instead.

Object creation functions such as PyObject_NewVar() will generally set this field to the requested size (number of items). After creation, arbitrary values can be stored in ob_size using Py_SET_SIZE.

To get an object's publicly exposed length, as returned by the Python function len(), use PyObject_Length() instead.

PyObject_HEAD

This is a macro used when declaring new types which represent objects without a varying length. The PyObject_HEAD macro expands to:

PyObject ob_base;

請見上面 PyObject 的文件。

PyObject_VAR_HEAD

This is a macro used when declaring new types which represent objects with a length that varies from instance to instance. The PyObject_VAR_HEAD macro expands to:

PyVarObject ob_base;

請見上面 PyVarObject 的文件。

PyTypeObject PyBaseObject_Type
穩定 ABI 的一部分.

The base class of all other objects, the same as object in Python.

int Py_Is(PyObject *x, PyObject *y)
穩定 ABI 的一部分 自 3.10 版本開始.

Test if the x object is the y object, the same as x is y in Python.

在 3.10 版被加入.

int Py_IsNone(PyObject *