> **Источник:** https://python-all.ru/3.12/c-api/structures.html
>
> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.

---

# Структуры общих объектов

При определении типов объектов Python используется большое количество структур. В данном разделе описываются эти структуры и принципы их использования.

## Базовые типы объектов и макросы

Все объекты Python имеют общие несколько полей в начале своего представления в памяти. Они представлены типами [`PyObject`](https://python-all.ru/3.12/c-api/structures.html#c.PyObject) и [`PyVarObject`](https://python-all.ru/3.12/c-api/structures.html#c.PyVarObject), которые, в свою очередь, определяются расширениями некоторых макросов, также используемых (прямо или косвенно) в определении всех остальных объектов Python. Дополнительные макросы можно найти в разделе [подсчёт ссылок](https://python-all.ru/3.12/c-api/refcounting.html#countingrefs).

#### `type PyObject`

*Часть [Limited API](https://python-all.ru/3.12/c-api/stable.html#stable). (Только некоторые члены являются частью стабильного ABI.)*

Все типы объектов являются расширениями этого типа. Это тип, который содержит информацию, необходимую Python для обработки указателя на объект как объекта. В обычной «релизной» сборке он содержит только счетчик ссылок объекта и указатель на соответствующий объект типа. Ничто не объявлено как [`PyObject`](https://python-all.ru/3.12/c-api/structures.html#c.PyObject), но любой указатель на объект Python может быть приведен к [PyObject](https://python-all.ru/3.12/c-api/structures.html#c.PyObject)\*. Доступ к членам должен осуществляться с помощью макросов [`Py_REFCNT`](https://python-all.ru/3.12/c-api/refcounting.html#c.Py_REFCNT) и [`Py_TYPE`](https://python-all.ru/3.12/c-api/structures.html#c.Py_TYPE).

#### `type PyVarObject`

*Часть [Limited API](https://python-all.ru/3.12/c-api/stable.html#stable). (Только некоторые члены являются частью стабильного ABI.)*

Это расширение [`PyObject`](https://python-all.ru/3.12/c-api/structures.html#c.PyObject), добавляющее поле [`ob_size`](https://python-all.ru/3.12/c-api/typeobj.html#c.PyVarObject.ob_size). Он используется только для объектов, которые имеют некоторое понятие *длины*. Этот тип не часто встречается в Python/C API. Доступ к членам должен осуществляться с помощью макросов [`Py_REFCNT`](https://python-all.ru/3.12/c-api/refcounting.html#c.Py_REFCNT), [`Py_TYPE`](https://python-all.ru/3.12/c-api/structures.html#c.Py_TYPE) и [`Py_SIZE`](https://python-all.ru/3.12/c-api/structures.html#c.Py_SIZE).

#### `PyObject_HEAD`

Это макрос, используемый при объявлении новых типов, представляющих объекты без изменяемой длины. Макрос PyObject\_HEAD раскрывается в:

```c
PyObject ob_base;
```

См. документацию [`PyObject`](https://python-all.ru/3.12/c-api/structures.html#c.PyObject) выше.

#### `PyObject_VAR_HEAD`

Это макрос, используемый при объявлении новых типов, представляющих объекты с длиной, которая меняется от экземпляра к экземпляру. Макрос PyObject\_VAR\_HEAD раскрывается в:

```c
PyVarObject ob_base;
```

См. документацию [`PyVarObject`](https://python-all.ru/3.12/c-api/structures.html#c.PyVarObject) выше.

#### `PyTypeObject PyBaseObject_Type`

*Часть [Stable ABI](https://python-all.ru/3.12/c-api/stable.html#stable).*

Базовый класс всех остальных объектов, аналогичен [`object`](https://python-all.ru/3.12/library/functions.html#object) в Python.

#### `int Py_Is(PyObject *x, PyObject *y)`

*Часть [Stable ABI](https://python-all.ru/3.12/c-api/stable.html#stable) начиная с версии 3.10.*

Проверяет, является ли объект *x* тем же объектом, что и *y*, аналогично `x is y` в Python.

Добавлено в версии 3.10.

#### `int Py_IsNone(PyObject *x)`

*Часть [Stable ABI](https://python-all.ru/3.12/c-api/stable.html#stable) начиная с версии 3.10.*

Проверяет, является ли объект синглтоном `None`, аналогично `x is None` в Python.

Добавлено в версии 3.10.

#### `int Py_IsTrue(PyObject *x)`

*Часть [Stable ABI](https://python-all.ru/3.12/c-api/stable.html#stable) начиная с версии 3.10.*

Проверяет, является ли объект синглтоном `True`, аналогично `x is True` в Python.

Добавлено в версии 3.10.

#### `int Py_IsFalse(PyObject *x)`

*Часть [Stable ABI](https://python-all.ru/3.12/c-api/stable.html#stable) начиная с версии 3.10.*

Проверяет, является ли объект синглтоном `False`, аналогично `x is False` в Python.

Добавлено в версии 3.10.

#### `PyTypeObject *Py_TYPE(PyObject *o)`

Возвращает тип объекта Python *o*.

Возвращает [заимствованную ссылку](https://python-all.ru/3.12/glossary.html#term-borrowed-reference).

Для установки типа объекта используется функция [`Py_SET_TYPE()`](https://python-all.ru/3.12/c-api/structures.html#c.Py_SET_TYPE).

Изменено в версии 3.11: [`Py_TYPE()`](https://python-all.ru/3.12/c-api/structures.html#c.Py_TYPE) изменён на встроенную статическую функцию. Тип параметра больше не const [PyObject](https://python-all.ru/3.12/c-api/structures.html#c.PyObject)\*.

#### `int Py_IS_TYPE(PyObject *o, PyTypeObject *type)`

Возвращает ненулевое значение, если тип объекта *o* равен *type*. В противном случае возвращает нуль. Эквивалентно `Py_TYPE(o) == type`.

Добавлено в версии 3.9.

#### `void Py_SET_TYPE(PyObject *o, PyTypeObject *type)`

Устанавливает тип объекта *o* в *type*.

Добавлено в версии 3.9.

#### `Py_ssize_t Py_SIZE(PyVarObject *o)`

Возвращает размер объекта Python *o*.

Для установки размера объекта используется функция [`Py_SET_SIZE()`](https://python-all.ru/3.12/c-api/structures.html#c.Py_SET_SIZE).

Изменено в версии 3.11: [`Py_SIZE()`](https://python-all.ru/3.12/c-api/structures.html#c.Py_SIZE) изменён на встроенную статическую функцию. Тип параметра больше не const [PyVarObject](https://python-all.ru/3.12/c-api/structures.html#c.PyVarObject)\*.

#### `void Py_SET_SIZE(PyVarObject *o, Py_ssize_t size)`

Устанавливает размер объекта *o* в *size*.

Добавлено в версии 3.9.

#### `PyObject_HEAD_INIT(type)`

Это макрос, который раскрывается в значения инициализации для нового типа [`PyObject`](https://python-all.ru/3.12/c-api/structures.html#c.PyObject). Этот макрос раскрывается в:

```c
_PyObject_EXTRA_INIT
1, type,
```

#### `PyVarObject_HEAD_INIT(type, size)`

Это макрос, который разворачивается в значения инициализации для нового типа [`PyVarObject`](https://python-all.ru/3.12/c-api/structures.html#c.PyVarObject), включая поле [`ob_size`](https://python-all.ru/3.12/c-api/typeobj.html#c.PyVarObject.ob_size). Этот макрос разворачивается в:

```c
_PyObject_EXTRA_INIT
1, type, size,
```

## Реализация функций и методов

#### `type PyCFunction`

*Часть [Stable ABI](https://python-all.ru/3.12/c-api/stable.html#stable).*

Тип функций, используемых для реализации большинства вызываемых объектов Python на C. Функции этого типа принимают два параметра [PyObject](https://python-all.ru/3.12/c-api/structures.html#c.PyObject)\* и возвращают одно такое значение. Если возвращаемое значение равно `NULL`, должно быть установлено исключение. Если не `NULL`, возвращаемое значение интерпретируется как возвращаемое значение функции, доступной в Python. Функция должна возвращать новую ссылку.

Сигнатура функции:

```c
PyObject *PyCFunction(PyObject *self,
                      PyObject *args);
```

#### `type PyCFunctionWithKeywords`

*Часть [Stable ABI](https://python-all.ru/3.12/c-api/stable.html#stable).*

Тип функций, используемых для реализации вызываемых объектов Python на C с сигнатурой [METH\_VARARGS | METH\_KEYWORDS](https://python-all.ru/3.12/c-api/structures.html#meth-varargs-meth-keywords). Сигнатура функции:

```c
PyObject *PyCFunctionWithKeywords(PyObject *self,
                                  PyObject *args,
                                  PyObject *kwargs);
```

#### `type _PyCFunctionFast`

Тип функций, используемых для реализации вызываемых объектов Python на C с сигнатурой [`METH_FASTCALL`](https://python-all.ru/3.12/c-api/structures.html#c.METH_FASTCALL). Сигнатура функции:

```c
PyObject *_PyCFunctionFast(PyObject *self,
                           PyObject *const *args,
                           Py_ssize_t nargs);
```

#### `type _PyCFunctionFastWithKeywords`

Тип функций, используемых для реализации вызываемых объектов Python на C с сигнатурой [METH\_FASTCALL | METH\_KEYWORDS](https://python-all.ru/3.12/c-api/structures.html#meth-fastcall-meth-keywords). Сигнатура функции:

```c
PyObject *_PyCFunctionFastWithKeywords(PyObject *self,
                                       PyObject *const *args,
                                       Py_ssize_t nargs,
                                       PyObject *kwnames);
```

#### `type PyCMethod`

Тип функций, используемых для реализации вызываемых объектов Python на C с сигнатурой [METH\_METHOD | METH\_FASTCALL | METH\_KEYWORDS](https://python-all.ru/3.12/c-api/structures.html#meth-method-meth-fastcall-meth-keywords). Сигнатура функции:

```c
PyObject *PyCMethod(PyObject *self,
                    PyTypeObject *defining_class,
                    PyObject *const *args,
                    Py_ssize_t nargs,
                    PyObject *kwnames)
```

Добавлено в версии 3.9.

#### `type PyMethodDef`

*Часть [Stable ABI](https://python-all.ru/3.12/c-api/stable.html#stable) (включая все члены).*

Структура, используемая для описания метода типа-расширения. Эта структура имеет четыре поля:

#### `const char *ml_name`

Имя метода.

#### `PyCFunction ml_meth`

Указатель на реализацию на C.

#### `int ml_flags`

Битовые флаги, указывающие, как должен быть построен вызов.

#### `const char *ml_doc`

Указывает на содержимое строки документации.

[`ml_meth`](https://python-all.ru/3.12/c-api/structures.html#c.PyMethodDef.ml_meth) – это указатель на функцию C. Функции могут быть разных tипов, но они всегда возвращают [PyObject](https://python-all.ru/3.12/c-api/structures.html#c.PyObject)\*. Если функция не относится к [`PyCFunction`](https://python-all.ru/3.12/c-api/structures.html#c.PyCFunction), компилятор потребует приведения типов в таблице методов. Хотя [`PyCFunction`](https://python-all.ru/3.12/c-api/structures.html#c.PyCFunction) определяет первый параметр как [PyObject](https://python-all.ru/3.12/c-api/structures.html#c.PyObject)\*, обычно реализация метода использует конкретный тип C объекта *self*.

Поле [`ml_flags`](https://python-all.ru/3.12/c-api/structures.html#c.PyMethodDef.ml_flags) – это битовое поле, которое может содержать следующие флаги. Отдельные флаги указывают либо соглашение о вызове, либо соглашение о связывании.

Существуют следующие соглашения о вызове:

#### `METH_VARARGS`

Это типичное соглашение о вызове, при котором методы имеют тип [`PyCFunction`](https://python-all.ru/3.12/c-api/structures.html#c.PyCFunction). Функция ожидает два значения [PyObject](https://python-all.ru/3.12/c-api/structures.html#c.PyObject)\*. Первое – это объект *self* для методов; для функций модуля это объект модуля. Второй параметр (часто называемый *args*) – это объект-кортеж, представляющий все аргументы. Этот параметр обычно обрабатывается с помощью [`PyArg_ParseTuple()`](https://python-all.ru/3.12/c-api/arg.html#c.PyArg_ParseTuple) или [`PyArg_UnpackTuple()`](https://python-all.ru/3.12/c-api/arg.html#c.PyArg_UnpackTuple).

#### `METH_KEYWORDS`

Может использоваться только в определённых комбинациях с другими флагами: [METH\_VARARGS | METH\_KEYWORDS](https://python-all.ru/3.12/c-api/structures.html#meth-varargs-meth-keywords), [METH\_FASTCALL | METH\_KEYWORDS](https://python-all.ru/3.12/c-api/structures.html#meth-fastcall-meth-keywords) и [METH\_METHOD | METH\_FASTCALL | METH\_KEYWORDS](https://python-all.ru/3.12/c-api/structures.html#meth-method-meth-fastcall-meth-keywords).

**[METH\_VARARGS](https://python-all.ru/3.12/c-api/structures.html#c.METH_VARARGS) | [METH\_KEYWORDS](https://python-all.ru/3.12/c-api/structures.html#c.METH_KEYWORDS)**

Методы с этими флагами должны быть типа [`PyCFunctionWithKeywords`](https://python-all.ru/3.12/c-api/structures.html#c.PyCFunctionWithKeywords). Функция ожидает три параметра: *self*, *args*, *kwargs*, где *kwargs* – это словарь всех именованных аргументов или `NULL`, если именованных аргументов нет. Параметры обычно обрабатываются с помощью [`PyArg_ParseTupleAndKeywords()`](https://python-all.ru/3.12/c-api/arg.html#c.PyArg_ParseTupleAndKeywords).

#### `METH_FASTCALL`

Быстрое соглашение о вызове, поддерживающее только позиционные аргументы. Методы имеют тип [`_PyCFunctionFast`](https://python-all.ru/3.12/c-api/structures.html#c._PyCFunctionFast). Первый параметр – *self*, второй параметр – массив C из значений [PyObject](https://python-all.ru/3.12/c-api/structures.html#c.PyObject)\*, указывающих аргументы, а третий параметр – количество аргументов (длина массива).

Добавлено в версии 3.7.

Изменено в версии 3.10: `METH_FASTCALL` теперь является частью [стабильного ABI](https://python-all.ru/3.12/c-api/stable.html#stable-abi).

**[METH\_FASTCALL](https://python-all.ru/3.12/c-api/structures.html#c.METH_FASTCALL) | [METH\_KEYWORDS](https://python-all.ru/3.12/c-api/structures.html#c.METH_KEYWORDS)**

Расширение [`METH_FASTCALL`](https://python-all.ru/3.12/c-api/structures.html#c.METH_FASTCALL), также поддерживающее именованные аргументы, с методами типа [`_PyCFunctionFastWithKeywords`](https://python-all.ru/3.12/c-api/structures.html#c._PyCFunctionFastWithKeywords). Именованные аргументы передаются так же, как в [протоколе vectorcall](https://python-all.ru/3.12/c-api/call.html#vectorcall): добавляется четвёртый параметр [PyObject](https://python-all.ru/3.12/c-api/structures.html#c.PyObject)\*, который является кортежем, представляющим имена именованных аргументов (гарантированно строки) или `NULL`, если ключевых слов нет. Значения именованных аргументов хранятся в массиве *args* после позиционных аргументов.

Добавлено в версии 3.7.

#### `METH_METHOD`

Может использоваться только в комбинации с другими флагами: [METH\_METHOD | METH\_FASTCALL | METH\_KEYWORDS](https://python-all.ru/3.12/c-api/structures.html#meth-method-meth-fastcall-meth-keywords).

**[METH\_METHOD](https://python-all.ru/3.12/c-api/structures.html#c.METH_METHOD) | [METH\_FASTCALL](https://python-all.ru/3.12/c-api/structures.html#c.METH_FASTCALL) | [METH\_KEYWORDS](https://python-all.ru/3.12/c-api/structures.html#c.METH_KEYWORDS)**

Расширение [METH\_FASTCALL | METH\_KEYWORDS](https://python-all.ru/3.12/c-api/structures.html#meth-fastcall-meth-keywords), поддерживающее *определяющий класс*, то есть класс, который содержит данный метод. Определяющий класс может быть суперклассом `Py_TYPE(self)`.

Метод должен быть типа [`PyCMethod`](https://python-all.ru/3.12/c-api/structures.html#c.PyCMethod), как и для `METH_FASTCALL | METH_KEYWORDS` с добавленным аргументом `defining_class` после `self`.

Добавлено в версии 3.9.

#### `METH_NOARGS`

Методы без параметров не должны проверять, переданы ли аргументы, если они перечислены с флагом [`METH_NOARGS`](https://python-all.ru/3.12/c-api/structures.html#c.METH_NOARGS). Они должны быть типа [`PyCFunction`](https://python-all.ru/3.12/c-api/structures.html#c.PyCFunction). Первый параметр обычно называется *self* и будет содержать ссылку на модуль или экземпляр объекта. Во всех случаях второй параметр будет `NULL`.

Функция должна иметь 2 параметра. Поскольку второй параметр не используется, [`Py_UNUSED`](https://python-all.ru/3.12/c-api/intro.html#c.Py_UNUSED) можно использовать для предотвращения предупреждения компилятора.

#### `METH_O`

Методы с одним объектным аргументом могут быть перечислены с флагом [`METH_O`](https://python-all.ru/3.12/c-api/structures.html#c.METH_O) вместо вызова [`PyArg_ParseTuple()`](https://python-all.ru/3.12/c-api/arg.html#c.PyArg_ParseTuple) с аргументом `"O"`. Они имеют тип [`PyCFunction`](https://python-all.ru/3.12/c-api/structures.html#c.PyCFunction), с параметром *self* и параметром [PyObject](https://python-all.ru/3.12/c-api/structures.html#c.PyObject)\*, представляющим единственный аргумент.

Эти две константы не используются для указания соглашения о вызовах, а для привязки при использовании с методами классов. Они не могут использоваться для функций, определённых для модулей. Для любого данного метода может быть установлен не более чем один из этих флагов.

#### `METH_CLASS`

Метод получит объект типа в качестве первого параметра, а не экземпляр типа. Это используется для создания *методов класса*, аналогично тому, что создаётся при использовании [`classmethod()`](https://python-all.ru/3.12/library/functions.html#classmethod) встроенной функции.

#### `METH_STATIC`

Метод получит `NULL` в качестве первого параметра, а не экземпляр типа. Это используется для создания *статических методов*, аналогично тому, что создаётся при использовании встроенной функции [`staticmethod()`](https://python-all.ru/3.12/library/functions.html#staticmethod).

Ещё одна константа управляет тем, загружается ли метод вместо другого определения с тем же именем метода.

#### `METH_COEXIST`

Метод будет загружен вместо существующих определений. Без *METH\_COEXIST* по умолчанию повторяющиеся определения пропускаются. Поскольку обёртки слотов загружаются до таблицы методов, наличие слота *sq\_contains*, например, приведёт к созданию обёрнутого метода с именем [`__contains__()`](https://python-all.ru/3.12/reference/datamodel.html#object.__contains__) и предотвратит загрузку соответствующего PyCFunction с тем же именем. При установленном флаге PyCFunction будет загружен вместо объекта-обёртки и будет сосуществовать со слотом. Это полезно, поскольку вызовы PyCFunctions оптимизированы лучше, чем вызовы объектов-обёрток.

#### `PyObject *PyCMethod_New(PyMethodDef *ml, PyObject *self, PyObject *module, PyTypeObject *cls)`

*Возвращаемое значение: новая ссылка.*

*Часть [Stable ABI](https://python-all.ru/3.12/c-api/stable.html#stable) с версии 3.9.*

Преобразует *ml* в объект Python [callable](https://python-all.ru/3.12/glossary.html#term-callable). Вызывающий код должен гарантировать, что *ml* переживёт [callable](https://python-all.ru/3.12/glossary.html#term-callable). Обычно *ml* определяется как статическая переменная.

Параметр *self* будет передан как аргумент *self* в C-функцию из `ml->ml_meth` при вызове. *self* может быть `NULL`.

Атрибут `__module__` объекта [callable](https://python-all.ru/3.12/glossary.html#term-callable) можно задать из аргумента *module*. *module* должна быть строкой Python, которая будет использоваться как имя модуля, в котором определена функция. Если это недоступно, можно задать [`None`](https://python-all.ru/3.12/library/constants.html#None) или `NULL`.

> **См. также**
>
> [`function.__module__`](https://python-all.ru/3.12/reference/datamodel.html#function.__module__)

Параметр *cls* будет передан как аргумент *defining\_class* в C-функцию. Должен быть задан, если [`METH_METHOD`](https://python-all.ru/3.12/c-api/structures.html#c.METH_METHOD) установлен на `ml->ml_flags`.

Добавлено в версии 3.9.

#### `PyObject *PyCFunction_NewEx(PyMethodDef *ml, PyObject *self, PyObject *module)`

*Возвращаемое значение: новая ссылка.*

*Часть [Stable ABI](https://python-all.ru/3.12/c-api/stable.html#stable).*

Эквивалентно `PyCMethod_New(ml, self, module, NULL)`.

#### `PyObject *PyCFunction_New(PyMethodDef *ml, PyObject *self)`

*Возвращаемое значение: новая ссылка.*

*Часть [Stable ABI](https://python-all.ru/3.12/c-api/stable.html#stable) с версии 3.4.*

Эквивалентно `PyCMethod_New(ml, self, NULL, NULL)`.

## Доступ к атрибутам типов расширений

#### `type PyMemberDef`

*Часть [Stable ABI](https://python-all.ru/3.12/c-api/stable.html#stable) (включая все члены).*

Структура, описывающая атрибут типа, соответствующий элементу структуры C. При определении класса поместите массив таких структур, завершающийся NULL, в слот [`tp_members`](https://python-all.ru/3.12/c-api/typeobj.html#c.PyTypeObject.tp_members).

Его поля, по порядку:

#### `const char *name`

Имя элемента. Значение NULL обозначает конец массива `PyMemberDef[]`.

Строка должна быть статической, её копия не создаётся.

#### `int type`

Тип элемента в структуре C. См. [типы элементов](https://python-all.ru/3.12/c-api/structures.html#pymemberdef-types) для возможных значений.

#### `Py_ssize_t offset`

Смещение в байтах, по которому элемент находится в структуре объекта типа.

#### `int flags`

Ноль или более [флагов элементов](https://python-all.ru/3.12/c-api/structures.html#pymemberdef-flags), объединённых с помощью побитового ИЛИ.

#### `const char *doc`

Строка документации (docstring) или NULL. Строка должна быть статической, её копия не создаётся. Обычно она определяется с помощью [`PyDoc_STR`](https://python-all.ru/3.12/c-api/intro.html#c.PyDoc_STR).

По умолчанию (когда [`flags`](https://python-all.ru/3.12/c-api/structures.html#c.PyMemberDef.flags) равно `0`) элементы допускают как чтение, так и запись. Используйте флаг [`Py_READONLY`](https://python-all.ru/3.12/c-api/structures.html#c.Py_READONLY) для доступа только на чтение. Некоторые типы, например [`Py_T_STRING`](https://python-all.ru/3.12/c-api/structures.html#c.Py_T_STRING), подразумевают [`Py_READONLY`](https://python-all.ru/3.12/c-api/structures.html#c.Py_READONLY). Только элементы [`Py_T_OBJECT_EX`](https://python-all.ru/3.12/c-api/structures.html#c.Py_T_OBJECT_EX) (и устаревшие [`T_OBJECT`](https://python-all.ru/3.12/c-api/structures.html#c.T_OBJECT)) могут быть удалены.

Для типов, выделяемых в куче (созданных с помощью [`PyType_FromSpec()`](https://python-all.ru/3.12/c-api/type.html#c.PyType_FromSpec) или аналогично), `PyMemberDef` может содержать определение специального члена `"__vectorcalloffset__"`, соответствующего [`tp_vectorcall_offset`](https://python-all.ru/3.12/c-api/typeobj.html#c.PyTypeObject.tp_vectorcall_offset) в объектах типа. Они должны быть определены с `Py_T_PYSSIZET` и `Py_READONLY`, например:

```c
static PyMemberDef spam_type_members[] = {
    {"__vectorcalloffset__", Py_T_PYSSIZET,
     offsetof(Spam_object, vectorcall), Py_READONLY},
    {NULL}  /* Страж */
};
```

(Возможно, потребуется `#include <stddef.h>` для `offsetof()`.)

Устаревшие смещения [`tp_dictoffset`](https://python-all.ru/3.12/c-api/typeobj.html#c.PyTypeObject.tp_dictoffset) и [`tp_weaklistoffset`](https://python-all.ru/3.12/c-api/typeobj.html#c.PyTypeObject.tp_weaklistoffset) можно определить аналогично, используя элементы `"__dictoffset__"` и `"__weaklistoffset__"`, однако расширениям настоятельно рекомендуется использовать [`Py_TPFLAGS_MANAGED_DICT`](https://python-all.ru/3.12/c-api/typeobj.html#c.Py_TPFLAGS_MANAGED_DICT) и [`Py_TPFLAGS_MANAGED_WEAKREF`](https://python-all.ru/3.12/c-api/typeobj.html#c.Py_TPFLAGS_MANAGED_WEAKREF) вместо них.

Изменено в версии 3.12: `PyMemberDef` всегда доступен. Ранее требовалось включение `"structmember.h"`.

#### `PyObject *PyMember_GetOne(const char *obj_addr, struct PyMemberDef *m)`

*Часть [Stable ABI](https://python-all.ru/3.12/c-api/stable.html#stable).*

Получает атрибут, принадлежащий объекту по адресу *obj\_addr*. Атрибут описывается с помощью `PyMemberDef` *m*. Возвращает `NULL` при ошибке.

Изменено в версии 3.12: `PyMember_GetOne` всегда доступен. Ранее требовалось включение `"structmember.h"`.

#### `int PyMember_SetOne(char *obj_addr, struct PyMemberDef *m, PyObject *o)`

*Часть [Stable ABI](https://python-all.ru/3.12/c-api/stable.html#stable).*

Устанавливает атрибут, принадлежащий объекту по адресу *obj\_addr*, в значение объекта *o*. Устанавливаемый атрибут описывается с помощью `PyMemberDef` *m*. Возвращает `0` в случае успеха и отрицательное значение при ошибке.

Изменено в версии 3.12: `PyMember_SetOne` всегда доступен. Ранее требовалось включение `"structmember.h"`.

### Флаги элементов

Следующие флаги могут использоваться с [`PyMemberDef.flags`](https://python-all.ru/3.12/c-api/structures.html#c.PyMemberDef.flags):

#### `Py_READONLY`

Не доступен для записи.

#### `Py_AUDIT_READ`

Отправляет `object.__getattr__` [событие аудита](https://python-all.ru/3.12/library/audit_events.html#audit-events) перед чтением.

#### `Py_RELATIVE_OFFSET`

Указывает, что [`offset`](https://python-all.ru/3.12/c-api/structures.html#c.PyMemberDef.offset) этой `PyMemberDef` записи является смещением от данных, специфичных для подкласса, а не от `PyObject`.

Может использоваться только как часть [`Py_tp_members`](https://python-all.ru/3.12/c-api/typeobj.html#c.PyTypeObject.tp_members) [`slot`](https://python-all.ru/3.12/c-api/type.html#c.PyType_Slot) при создании класса с использованием отрицательного [`basicsize`](https://python-all.ru/3.12/c-api/type.html#c.PyType_Spec.basicsize). В этом случае это обязательно.

Этот флаг используется только в [`PyType_Slot`](https://python-all.ru/3.12/c-api/type.html#c.PyType_Slot). При установке [`tp_members`](https://python-all.ru/3.12/c-api/typeobj.html#c.PyTypeObject.tp_members) во время создания класса Python сбрасывает его и устанавливает [`PyMemberDef.offset`](https://python-all.ru/3.12/c-api/structures.html#c.PyMemberDef.offset) в смещение от структуры `PyObject`.

Изменено в версии 3.10: Макросы `RESTRICTED`, `READ_RESTRICTED` и `WRITE_RESTRICTED`, доступные с `#include "structmember.h"`, устарели. `READ_RESTRICTED` и `RESTRICTED` эквивалентны [`Py_AUDIT_READ`](https://python-all.ru/3.12/c-api/structures.html#c.Py_AUDIT_READ); `WRITE_RESTRICTED` ничего не делает.

Изменено в версии 3.12: Макрос `READONLY` был переименован в [`Py_READONLY`](https://python-all.ru/3.12/c-api/structures.html#c.Py_READONLY). Макрос `PY_AUDIT_READ` был переименован с префиксом `Py_`. Новые имена теперь всегда доступны. Ранее для них требовался `#include "structmember.h"`. Заголовочный файл всё ещё доступен и содержит старые имена.

### Типы членов

[`PyMemberDef.type`](https://python-all.ru/3.12/c-api/structures.html#c.PyMemberDef.type) может быть одним из следующих макросов, соответствующих различным типам C. Когда поле доступно из Python, оно преобразуется в эквивалентный тип Python. Когда оно устанавливается из Python, оно преобразуется обратно в тип C. Если это невозможно, возникает исключение, такое как [`TypeError`](https://python-all.ru/3.12/library/exceptions.html#TypeError) или [`ValueError`](https://python-all.ru/3.12/library/exceptions.html#ValueError).

Если не помечено (D), атрибуты, определённые таким образом, нельзя удалить с помощью, например, [`del`](https://python-all.ru/3.12/reference/simple_stmts.html#del) или [`delattr()`](https://python-all.ru/3.12/library/functions.html#delattr).

| Имя макроса | Тип C | Тип Python |
| --- | --- | --- |
| Py\_T\_BYTE | char | [`int`](https://python-all.ru/3.12/library/functions.html#int) |
| Py\_T\_SHORT | short | [`int`](https://python-all.ru/3.12/library/functions.html#int) |
| Py\_T\_INT | int | [`int`](https://python-all.ru/3.12/library/functions.html#int) |
| Py\_T\_LONG | long | [`int`](https://python-all.ru/3.12/library/functions.html#int) |
| Py\_T\_LONGLONG | long long | [`int`](https://python-all.ru/3.12/library/functions.html#int) |
| Py\_T\_UBYTE | unsigned char | [`int`](https://python-all.ru/3.12/library/functions.html#int) |
| Py\_T\_UINT | unsigned int | [`int`](https://python-all.ru/3.12/library/functions.html#int) |
| Py\_T\_USHORT | unsigned short | [`int`](https://python-all.ru/3.12/library/functions.html#int) |
| Py\_T\_ULONG | unsigned long | [`int`](https://python-all.ru/3.12/library/functions.html#int) |
| Py\_T\_ULONGLONG | unsigned long long | [`int`](https://python-all.ru/3.12/library/functions.html#int) |
| Py\_T\_PYSSIZET | [Py\_ssize\_t](https://python-all.ru/3.12/c-api/intro.html#c.Py_ssize_t) | [`int`](https://python-all.ru/3.12/library/functions.html#int) |
| Py\_T\_FLOAT | float | [`float`](https://python-all.ru/3.12/library/functions.html#float) |
| Py\_T\_DOUBLE | double | [`float`](https://python-all.ru/3.12/library/functions.html#float) |
| Py\_T\_BOOL | char (записывается как 0 или 1) | [`bool`](https://python-all.ru/3.12/library/functions.html#bool) |
| Py\_T\_STRING | const char\* (\*) | [`str`](https://python-all.ru/3.12/library/stdtypes.html#str) (только для чтения) |
| Py\_T\_STRING\_INPLACE | const char\[\] (\*) | [`str`](https://python-all.ru/3.12/library/stdtypes.html#str) (только для чтения) |
| Py\_T\_CHAR | char (0-127) | [`str`](https://python-all.ru/3.12/library/stdtypes.html#str) (\*\*) |
| Py\_T\_OBJECT\_EX | [PyObject](https://python-all.ru/3.12/c-api/structures.html#c.PyObject)\* | [`object`](https://python-all.ru/3.12/library/functions.html#object) (по умолчанию) |

> (\*): Нуль-терминированная строка C в кодировке UTF-8. С `Py_T_STRING` представление в C – указатель; с `Py_T_STRING_INPLACE` строка хранится непосредственно в структуре.
>
> (\*\*): Строка длиной 1. Допустимы только символы ASCII.
>
> (RO): Подразумевает [`Py_READONLY`](https://python-all.ru/3.12/c-api/structures.html#c.Py_READONLY).
>
> (D): Может быть удалено, в этом случае указатель устанавливается в `NULL`. Чтение указателя `NULL` возбуждает [`AttributeError`](https://python-all.ru/3.12/library/exceptions.html#AttributeError).

Добавлено в версии 3.12: В предыдущих версиях макросы были доступны только с `#include "structmember.h"` и назывались без префикса `Py_` (например, `T_INT`). Заголовочный файл по-прежнему доступен и содержит старые имена, а также следующие устаревшие типы:

#### `T_OBJECT`

Как `Py_T_OBJECT_EX`, но `NULL` преобразуется в `None`. Это приводит к неожиданному поведению в Python: удаление атрибута фактически устанавливает его в `None`.

#### `T_NONE`

Всегда `None`. Должен использоваться с [`Py_READONLY`](https://python-all.ru/3.12/c-api/structures.html#c.Py_READONLY).

### Определение геттеров и сеттеров

#### `type PyGetSetDef`

*Часть [Stable ABI](https://python-all.ru/3.12/c-api/stable.html#stable) (включая все члены).*

Структура для определения доступа по типу свойства для типа. См. также описание слота [`PyTypeObject.tp_getset`](https://python-all.ru/3.12/c-api/typeobj.html#c.PyTypeObject.tp_getset).

#### `const char *name`

имя атрибута

#### `getter get`

C-функция для получения атрибута.

#### `setter set`

Необязательная C-функция для установки или удаления атрибута. Если `NULL`, атрибут доступен только для чтения.

#### `const char *doc`

необязательная строка документации

#### `void *closure`

Необязательный указатель на пользовательские данные, предоставляющий дополнительные данные для getter и setter.

#### `typedef PyObject *(*getter)(PyObject*, void*)`

*Часть [Stable ABI](https://python-all.ru/3.12/c-api/stable.html#stable).*

Функция `get` принимает один параметр [PyObject](https://python-all.ru/3.12/c-api/structures.html#c.PyObject)\* (экземпляр) и указатель на пользовательские данные (связанный `closure`):

В случае успеха должна возвращать новую ссылку или `NULL` с установленным исключением в случае неудачи.

#### `typedef int (*setter)(PyObject*, PyObject*, void*)`

*Часть [Stable ABI](https://python-all.ru/3.12/c-api/stable.html#stable).*

Функции `set` принимают два параметра [PyObject](https://python-all.ru/3.12/c-api/structures.html#c.PyObject)\* (экземпляр и устанавливаемое значение) и указатель на пользовательские данные (связанный `closure`):

Если атрибут должен быть удален, второй параметр равен `NULL`. В случае успеха должна возвращать `0` или `-1` с установленным исключением в случае неудачи.