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

---

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

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

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

**`PyObject`**

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

`PyObject_HEAD`

.

**`PyVarObject`**

Это расширение

[`PyObject`](https://python-all.ru/2.6/c-api/structures.html#PyObject)

, которое добавляет поле

[`ob_size`](https://python-all.ru/2.6/c-api/typeobj.html#ob_size)

. Используется только для объектов, имеющих некоторое понятие

*длины*

. Этот тип нечасто встречается в Python/C API. Он соответствует полям, определяемым развёртыванием макроса

`PyObject_VAR_HEAD`

.

Эти макросы используются в определении [`PyObject`](https://python-all.ru/2.6/c-api/structures.html#PyObject) и [`PyVarObject`](https://python-all.ru/2.6/c-api/structures.html#PyVarObject):

**`PyObject_HEAD`**

Это макрос, который раскрывается в объявления полей типа [`PyObject`](https://python-all.ru/2.6/c-api/structures.html#PyObject); он используется при объявлении новых типов, представляющих объекты без изменяемой длины. Конкретные поля, в которые он раскрывается, зависят от определения `Py_TRACE_REFS`. По умолчанию этот макрос не определен, и [`PyObject_HEAD`](https://python-all.ru/2.6/c-api/structures.html#PyObject_HEAD) раскрывается в:

```c
Py_ssize_t ob_refcnt;
PyTypeObject *ob_type;
```

Когда `Py_TRACE_REFS` определен, он раскрывается в:

```c
PyObject *_ob_next, *_ob_prev;
Py_ssize_t ob_refcnt;
PyTypeObject *ob_type;
```

**`PyObject_VAR_HEAD`**

Это макрос, который раскрывается в объявления полей типа [`PyVarObject`](https://python-all.ru/2.6/c-api/structures.html#PyVarObject); он используется при объявлении новых типов, представляющих объекты с длиной, которая меняется от экземпляра к экземпляру. Этот макрос всегда раскрывается в:

```c
PyObject_HEAD
Py_ssize_t ob_size;
```

Обратите внимание, что [`PyObject_HEAD`](https://python-all.ru/2.6/c-api/structures.html#PyObject_HEAD) является частью раскрытия, и его собственное раскрытие зависит от определения `Py_TRACE_REFS`.

**`PyObject_HEAD_INIT`(type)**

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

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

**`PyVarObject_HEAD_INIT`(type, size)**

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

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

**`PyCFunction`**

Тип функций, используемых для реализации большинства вызываемых объектов Python на C. Функции этого типа принимают два параметра

[`PyObject*`](https://python-all.ru/2.6/c-api/structures.html#PyObject)

и возвращают одно такое значение. Если возвращаемое значение

*NULL*

, то должно быть установлено исключение. Если не

*NULL*

, возвращаемое значение интерпретируется как возвращаемое значение функции, доступное в Python. Функция должна возвращать новую ссылку.

**`PyMethodDef`**

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

| Поле | Тип C | Значение |
| --- | --- | --- |
| `ml_name` | char \* | имя метода |
| `ml_meth` | PyCFunction | указатель на реализацию на C |
| `ml_flags` | int | биты флагов, указывающие, как должен быть построен вызов |
| `ml_doc` | char \* | указывает на содержимое докстринга |

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

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

#### `METH_VARARGS`

Это типичное соглашение о вызове, при котором методы имеют тип

[`PyCFunction`](https://python-all.ru/2.6/c-api/structures.html#PyCFunction)

. Функция ожидает два значения

[`PyObject*`](https://python-all.ru/2.6/c-api/structures.html#PyObject)

. Первое значение – это объект

*self*

для методов; для функций модуля оно равно значению, переданному в

[`Py_InitModule4()`](https://python-all.ru/2.6/c-api/allocation.html#Py_InitModule4)

(или

*NULL*

, если использовалась

[`Py_InitModule()`](https://python-all.ru/2.6/c-api/allocation.html#Py_InitModule)

). Второй параметр (часто называемый

*args*

) – это объект-кортеж, представляющий все аргументы. Этот параметр обычно обрабатывается с помощью

[`PyArg_ParseTuple()`](https://python-all.ru/2.6/c-api/arg.html#PyArg_ParseTuple)

или

[`PyArg_UnpackTuple()`](https://python-all.ru/2.6/c-api/arg.html#PyArg_UnpackTuple)

.

#### `METH_KEYWORDS`

Методы с этими флагами должны иметь тип

`PyCFunctionWithKeywords`

. Функция ожидает три параметра:

*self*

,

*args*

и словарь всех именованных аргументов. Обычно этот флаг комбинируют с

[`METH_VARARGS`](https://python-all.ru/2.6/c-api/structures.html#METH_VARARGS)

, а параметры обычно обрабатывают с помощью

[`PyArg_ParseTupleAndKeywords()`](https://python-all.ru/2.6/c-api/arg.html#PyArg_ParseTupleAndKeywords)

.

#### `METH_NOARGS`

Методам без параметров не нужно проверять, переданы ли аргументы, если они указаны с флагом

[`METH_NOARGS`](https://python-all.ru/2.6/c-api/structures.html#METH_NOARGS)

. Они должны быть типа

[`PyCFunction`](https://python-all.ru/2.6/c-api/structures.html#PyCFunction)

. При использовании в методах объектов первый параметр обычно называется

`self`

и содержит ссылку на экземпляр объекта. Во всех случаях второй параметр будет

*NULL*

.

#### `METH_O`

Методы с одним объектным аргументом могут быть указаны с флагом

[`METH_O`](https://python-all.ru/2.6/c-api/structures.html#METH_O)

вместо вызова

[`PyArg_ParseTuple()`](https://python-all.ru/2.6/c-api/arg.html#PyArg_ParseTuple)

с аргументом

`"O"`

. Они имеют тип

[`PyCFunction`](https://python-all.ru/2.6/c-api/structures.html#PyCFunction)

, с параметром

*self*

и параметром

[`PyObject*`](https://python-all.ru/2.6/c-api/structures.html#PyObject)

, представляющим единственный аргумент.

#### `METH_OLDARGS`

Это соглашение о вызове устарело. Метод должен быть типа

[`PyCFunction`](https://python-all.ru/2.6/c-api/structures.html#PyCFunction)

. Второй аргумент равен

*NULL*

, если аргументы не переданы, одному объекту, если передан ровно один аргумент, и кортежу объектов, если передано более одного аргумента. Функция, использующая это соглашение, не может различить вызов с несколькими аргументами и вызов с единственным аргументом-кортежем.

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

#### `METH_CLASS`

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

Новое в версии 2.3.

#### `METH_STATIC`

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

Новое в версии 2.3.

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

#### `METH_COEXIST`

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

Новое в версии 2.4.

**`PyMemberDef`**

Структура, описывающая атрибут типа, который соответствует члену C-структуры. Её поля:

| Поле | Тип C | Значение |
| --- | --- | --- |
| `name` | char \* | имя члена |
| [`type`](https://python-all.ru/2.6/library/functions.html#type) | int | тип члена в C-структуре |
| `offset` | Py\_ssize\_t | смещение в байтах, по которому член расположен в объектной структуре типа |
| `flags` | int | биты флага, указывающие, должно ли поле быть только для чтения или доступным для записи |
| `doc` | char \* | указывает на содержимое докстринга |

Поле [`type`](https://python-all.ru/2.6/library/functions.html#type) может быть одним из многих макросов `T_`, соответствующих различным типам C. При обращении к элементу из Python он будет преобразован в соответствующий тип Python.

| Имя макроса | Тип C |
| --- | --- |
| T\_SHORT | short |
| T\_INT | int |
| T\_LONG | long |
| T\_FLOAT | float |
| T\_DOUBLE | double |
| T\_STRING | char \* |
| T\_OBJECT | PyObject \* |
| T\_OBJECT\_EX | PyObject \* |
| T\_CHAR | char |
| T\_BYTE | char |
| T\_UBYTE | беззнаковый char |
| T\_UINT | беззнаковый int |
| T\_USHORT | беззнаковый short |
| T\_ULONG | беззнаковый long |
| T\_BOOL | char |
| T\_LONGLONG | long long |
| T\_ULONGLONG | беззнаковый long long |
| T\_PYSSIZET | Py\_ssize\_t |

`T_OBJECT` и `T_OBJECT_EX` различаются тем, что `T_OBJECT` возвращает `None`, если поле равно *NULL*, а `T_OBJECT_EX` возбуждает [`AttributeError`](https://python-all.ru/2.6/library/exceptions.html#exceptions.AttributeError). Рекомендуется использовать `T_OBJECT_EX` вместо `T_OBJECT`, так как `T_OBJECT_EX` корректнее обрабатывает применение оператора [`del`](https://python-all.ru/2.6/reference/simple_stmts.html#del) к этому атрибуту, чем `T_OBJECT`.

`flags` может быть 0 для доступа на запись и чтение или `READONLY` для доступа только для чтения. Использование `T_STRING` для [`type`](https://python-all.ru/2.6/library/functions.html#type) неявно подразумевает `READONLY`. Только члены `T_OBJECT` и `T_OBJECT_EX` могут быть удалены. (Они устанавливаются в *NULL*).

**[PyObject](https://python-all.ru/2.6/c-api/structures.html#PyObject)\* `Py_FindMethod`([PyMethodDef](https://python-all.ru/2.6/c-api/structures.html#PyMethodDef) *table\[\]*, [PyObject](https://python-all.ru/2.6/c-api/structures.html#PyObject) *\*ob*, char *\*name*)**

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

Возвращает объект привязанного метода для типа-расширения, реализованного на C. Это может быть полезно при реализации обработчика [`tp_getattro`](https://python-all.ru/2.6/c-api/typeobj.html#tp_getattro) или [`tp_getattr`](https://python-all.ru/2.6/c-api/typeobj.html#tp_getattr), который не использует функцию [`PyObject_GenericGetAttr()`](https://python-all.ru/2.6/c-api/object.html#PyObject_GenericGetAttr).
