`structures.md`

162 строк · 16.9 КБ · обычная страница · сырой текст · скачать
1> **Источник:** https://python-all.ru/3.2/c-api/structures.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# Структуры общих объектов89При определении типов объектов Python используется большое количество структур. В данном разделе описываются эти структуры и принципы их использования.1011Все объекты Python в конечном счёте имеют несколько общих полей в начале представления объекта в памяти. Они представлены типами [`PyObject`](https://python-all.ru/3.2/c-api/structures.html#PyObject) и [`PyVarObject`](https://python-all.ru/3.2/c-api/structures.html#PyVarObject), которые, в свою очередь, определяются через раскрытие некоторых макросов, также используемых (напрямую или косвенно) в определении всех остальных объектов Python.1213**`PyObject`**1415Все типы объектов являются расширениями этого типа. Это тип, содержащий информацию, необходимую Python для обработки указателя на объект как объекта. В обычной «релизной» сборке он содержит только счетчик ссылок объекта и указатель на соответствующий объект типа. Он соответствует полям, определяемым раскрытием макроса `PyObject_HEAD`.1617**`PyVarObject`**1819Это расширение [`PyObject`](https://python-all.ru/3.2/c-api/structures.html#PyObject), добавляющее поле `ob_size`. Оно используется только для объектов, имеющих некоторое понятие *длины*. Этот тип нечасто встречается в Python/C API. Он соответствует полям, определяемым раскрытием макроса `PyObject_VAR_HEAD`.2021Эти макросы используются в определении [`PyObject`](https://python-all.ru/3.2/c-api/structures.html#PyObject) и [`PyVarObject`](https://python-all.ru/3.2/c-api/structures.html#PyVarObject):2223**`PyObject_HEAD`**2425Это макрос, который раскрывается в объявления полей типа [`PyObject`](https://python-all.ru/3.2/c-api/structures.html#PyObject); он используется при объявлении новых типов, представляющих объекты без изменяемой длины. Конкретные поля, в которые он раскрывается, зависят от определения `Py_TRACE_REFS`. По умолчанию этот макрос не определен, и [`PyObject_HEAD`](https://python-all.ru/3.2/c-api/structures.html#PyObject_HEAD) раскрывается в:2627```c28Py_ssize_t ob_refcnt;29PyTypeObject *ob_type;30```3132Когда `Py_TRACE_REFS` определен, он раскрывается в:3334```c35PyObject *_ob_next, *_ob_prev;36Py_ssize_t ob_refcnt;37PyTypeObject *ob_type;38```3940**`PyObject_VAR_HEAD`**4142Это макрос, который раскрывается в объявления полей типа [`PyVarObject`](https://python-all.ru/3.2/c-api/structures.html#PyVarObject); он используется при объявлении новых типов, представляющих объекты с длиной, которая меняется от экземпляра к экземпляру. Этот макрос всегда раскрывается в:4344```c45PyObject_HEAD46Py_ssize_t ob_size;47```4849Обратите внимание, что [`PyObject_HEAD`](https://python-all.ru/3.2/c-api/structures.html#PyObject_HEAD) является частью раскрытия, и его собственное раскрытие зависит от определения `Py_TRACE_REFS`.5051**`PyObject_HEAD_INIT`(type)**5253Это макрос, который раскрывается в значения инициализации для нового типа [`PyObject`](https://python-all.ru/3.2/c-api/structures.html#PyObject). Он раскрывается в:5455```c56_PyObject_EXTRA_INIT571, type,58```5960**`PyVarObject_HEAD_INIT`(type, size)**6162Это макрос, который раскрывается в значения инициализации для нового типа [`PyVarObject`](https://python-all.ru/3.2/c-api/structures.html#PyVarObject), включая поле `ob_size`. Он раскрывается в:6364```c65_PyObject_EXTRA_INIT661, type, size,67```6869**`PyCFunction`**7071Тип функций, используемых для реализации большинства вызываемых объектов Python на C. Функции этого типа принимают два параметра [`PyObject*`](https://python-all.ru/3.2/c-api/structures.html#PyObject) и возвращают одно такое значение. Если возвращаемое значение *NULL*, то должно быть установлено исключение. Если не *NULL*, возвращаемое значение интерпретируется как возвращаемое значение функции, доступное в Python. Функция должна возвращать новую ссылку.7273**`PyCFunctionWithKeywords`**7475Тип функций, используемых для реализации вызываемых объектов Python на C, которые принимают именованные аргументы: они принимают три параметра [`PyObject*`](https://python-all.ru/3.2/c-api/structures.html#PyObject) и возвращают одно такое значение. См. [`PyCFunction`](https://python-all.ru/3.2/c-api/structures.html#PyCFunction) выше для описания возвращаемого значения.7677**`PyMethodDef`**7879Структура, используемая для описания метода типа-расширения. Эта структура имеет четыре поля:8081| Поле | Тип C | Значение |82| --- | --- | --- |83| `ml_name` | char \* | имя метода |84| `ml_meth` | PyCFunction | указатель на реализацию на C |85| `ml_flags` | int | биты флагов, указывающие, как должен быть построен вызов |86| `ml_doc` | char \* | указывает на содержимое докстринга |8788Поле `ml_meth` – это указатель на функцию C. Функции могут быть разных типов, но они всегда возвращают [`PyObject*`](https://python-all.ru/3.2/c-api/structures.html#PyObject). Если функция не является [`PyCFunction`](https://python-all.ru/3.2/c-api/structures.html#PyCFunction), компилятор потребует приведения типа в таблице методов. Хотя [`PyCFunction`](https://python-all.ru/3.2/c-api/structures.html#PyCFunction) определяет первый параметр как [`PyObject*`](https://python-all.ru/3.2/c-api/structures.html#PyObject), часто реализация метода использует конкретный C-тип объекта *self*.8990Поле `ml_flags` – это битовое поле, которое может содержать следующие флаги. Отдельные флаги указывают либо соглашение о вызове, либо соглашение о связывании. Из флагов соглашения о вызове можно комбинировать только [`METH_VARARGS`](https://python-all.ru/3.2/c-api/structures.html#METH_VARARGS) и [`METH_KEYWORDS`](https://python-all.ru/3.2/c-api/structures.html#METH_KEYWORDS) (но обратите внимание, что [`METH_KEYWORDS`](https://python-all.ru/3.2/c-api/structures.html#METH_KEYWORDS) сам по себе эквивалентен `METH_VARARGS | METH_KEYWORDS`). Любой флаг соглашения о вызове можно комбинировать с флагом связывания.9192#### `METH_VARARGS`9394Это стандартное соглашение о вызове, при котором методы имеют тип [`PyCFunction`](https://python-all.ru/3.2/c-api/structures.html#PyCFunction). Функция ожидает два значения [`PyObject*`](https://python-all.ru/3.2/c-api/structures.html#PyObject). Первое – это объект *self* для методов; для модульных функций это объект модуля. Второй параметр (часто называемый *args*) представляет собой кортеж, содержащий все аргументы. Этот параметр обычно обрабатывается с помощью [`PyArg_ParseTuple()`](https://python-all.ru/3.2/c-api/arg.html#PyArg_ParseTuple) или [`PyArg_UnpackTuple()`](https://python-all.ru/3.2/c-api/arg.html#PyArg_UnpackTuple).9596#### `METH_KEYWORDS`9798Методы с этими флагами должны иметь тип [`PyCFunctionWithKeywords`](https://python-all.ru/3.2/c-api/structures.html#PyCFunctionWithKeywords). Функция ожидает три параметра: *self*, *args* и словарь всех именованных аргументов. Этот флаг обычно комбинируется с [`METH_VARARGS`](https://python-all.ru/3.2/c-api/structures.html#METH_VARARGS), и параметры обычно обрабатываются с помощью [`PyArg_ParseTupleAndKeywords()`](https://python-all.ru/3.2/c-api/arg.html#PyArg_ParseTupleAndKeywords).99100#### `METH_NOARGS`101102Методы без параметров не должны проверять, переданы ли аргументы, если они указаны с флагом [`METH_NOARGS`](https://python-all.ru/3.2/c-api/structures.html#METH_NOARGS). Они должны иметь тип [`PyCFunction`](https://python-all.ru/3.2/c-api/structures.html#PyCFunction). Первый параметр обычно называется *self* и содержит ссылку на модуль или экземпляр объекта. Во всех случаях второй параметр будет *NULL*.103104#### `METH_O`105106Методы с одним объектным аргументом могут быть указаны с флагом [`METH_O`](https://python-all.ru/3.2/c-api/structures.html#METH_O) вместо вызова [`PyArg_ParseTuple()`](https://python-all.ru/3.2/c-api/arg.html#PyArg_ParseTuple) с аргументом `"O"`. Они имеют тип [`PyCFunction`](https://python-all.ru/3.2/c-api/structures.html#PyCFunction), с параметром *self* и параметром [`PyObject*`](https://python-all.ru/3.2/c-api/structures.html#PyObject), представляющим единственный аргумент.107108Эти две константы не используются для указания соглашения о вызовах, а для привязки при использовании с методами классов. Они не могут использоваться для функций, определённых для модулей. Для любого данного метода может быть установлен не более чем один из этих флагов.109110#### `METH_CLASS`111112Методу будет передан объект типа в качестве первого параметра, а не экземпляр этого типа. Это используется для создания *методов класса*, аналогично тому, что создаётся при использовании встроенной функции [`classmethod()`](https://python-all.ru/3.2/library/functions.html#classmethod).113114#### `METH_STATIC`115116Методу будет передан *NULL* в качестве первого параметра, а не экземпляр типа. Это используется для создания *статических методов*, аналогично тому, что создаётся при использовании встроенной функции [`staticmethod()`](https://python-all.ru/3.2/library/functions.html#staticmethod).117118Ещё одна константа управляет тем, загружается ли метод вместо другого определения с тем же именем метода.119120#### `METH_COEXIST`121122Метод будет загружен вместо существующих определений. Без *METH\_COEXIST* по умолчанию повторные определения пропускаются. Поскольку обёртки слотов загружаются до таблицы методов, существование слота *sq\_contains*, например, породит метод-обёртку с именем [`__contains__()`](https://python-all.ru/3.2/reference/datamodel.html#object.__contains__) и помешает загрузке соответствующей PyCFunction с тем же именем. Если флаг определён, PyCFunction будет загружена вместо объекта-обёртки и будет сосуществовать со слотом. Это полезно, потому что вызовы PyCFunctions оптимизированы лучше, чем вызовы объектов-обёрток.123124**`PyMemberDef`**125126Структура, описывающая атрибут типа, который соответствует члену C-структуры. Её поля:127128| Поле | Тип C | Значение |129| --- | --- | --- |130| `name` | char \* | имя члена |131| [`type`](https://python-all.ru/3.2/library/functions.html#type) | int | тип члена в C-структуре |132| `offset` | Py\_ssize\_t | смещение в байтах, по которому член расположен в объектной структуре типа |133| `flags` | int | биты флага, указывающие, должно ли поле быть только для чтения или доступным для записи |134| `doc` | char \* | указывает на содержимое докстринга |135136Поле [`type`](https://python-all.ru/3.2/library/functions.html#type) может быть одним из многих макросов `T_`, соответствующих различным типам C. При обращении к элементу из Python он будет преобразован в соответствующий тип Python.137138| Имя макроса | Тип C |139| --- | --- |140| T\_SHORT | short |141| T\_INT | int |142| T\_LONG | long |143| T\_FLOAT | float |144| T\_DOUBLE | double |145| T\_STRING | char \* |146| T\_OBJECT | PyObject \* |147| T\_OBJECT\_EX | PyObject \* |148| T\_CHAR | char |149| T\_BYTE | char |150| T\_UBYTE | беззнаковый char |151| T\_UINT | беззнаковый int |152| T\_USHORT | беззнаковый short |153| T\_ULONG | беззнаковый long |154| T\_BOOL | char |155| T\_LONGLONG | long long |156| T\_ULONGLONG | беззнаковый long long |157| T\_PYSSIZET | Py\_ssize\_t |158159`T_OBJECT` и `T_OBJECT_EX` различаются тем, что `T_OBJECT` возвращает `None`, если поле равно *NULL*, а `T_OBJECT_EX` возбуждает [`AttributeError`](https://python-all.ru/3.2/library/exceptions.html#AttributeError). Рекомендуется использовать `T_OBJECT_EX` вместо `T_OBJECT`, так как `T_OBJECT_EX` корректнее обрабатывает применение оператора [`del`](https://python-all.ru/3.2/reference/simple_stmts.html#del) к этому атрибуту, чем `T_OBJECT`.160161`flags` может быть 0 для доступа на запись и чтение или `READONLY` для доступа только для чтения. Использование `T_STRING` для [`type`](https://python-all.ru/3.2/library/functions.html#type) неявно подразумевает `READONLY`. Только члены `T_OBJECT` и `T_OBJECT_EX` могут быть удалены. (Они устанавливаются в *NULL*).162