`structures.md`

298 строк · 17.2 КБ · обычная страница · сырой текст · скачать
1> **Источник:** https://python-all.ru/3.1/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.1/c-api/structures.html#PyObject) и [`PyVarObject`](https://python-all.ru/3.1/c-api/structures.html#PyVarObject), которые, в свою очередь, определяются через раскрытие некоторых макросов, также используемых (напрямую или косвенно) в определении всех остальных объектов Python.1213**`PyObject`**1415Все типы объектов являются расширениями этого типа. Это тип, содержащий информацию, необходимую Python для обработки указателя на объект как объекта. В обычной «релизной» сборке он содержит только счетчик ссылок объекта и указатель на соответствующий объект типа. Он соответствует полям, определяемым раскрытием макроса1617`PyObject_HEAD`1819.2021**`PyVarObject`**2223Это расширение2425[`PyObject`](https://python-all.ru/3.1/c-api/structures.html#PyObject)2627, которое добавляет поле2829[`ob_size`](https://python-all.ru/3.1/c-api/typeobj.html#ob_size)3031. Используется только для объектов, имеющих некоторое понятие3233*длины*3435. Этот тип нечасто встречается в Python/C API. Он соответствует полям, определяемым развёртыванием макроса3637`PyObject_VAR_HEAD`3839.4041Эти макросы используются в определении [`PyObject`](https://python-all.ru/3.1/c-api/structures.html#PyObject) и [`PyVarObject`](https://python-all.ru/3.1/c-api/structures.html#PyVarObject):4243**`PyObject_HEAD`**4445Это макрос, который раскрывается в объявления полей типа [`PyObject`](https://python-all.ru/3.1/c-api/structures.html#PyObject); он используется при объявлении новых типов, представляющих объекты без изменяемой длины. Конкретные поля, в которые он раскрывается, зависят от определения `Py_TRACE_REFS`. По умолчанию этот макрос не определен, и [`PyObject_HEAD`](https://python-all.ru/3.1/c-api/structures.html#PyObject_HEAD) раскрывается в:4647```c48Py_ssize_t ob_refcnt;49PyTypeObject *ob_type;50```5152Когда `Py_TRACE_REFS` определен, он раскрывается в:5354```c55PyObject *_ob_next, *_ob_prev;56Py_ssize_t ob_refcnt;57PyTypeObject *ob_type;58```5960**`PyObject_VAR_HEAD`**6162Это макрос, который раскрывается в объявления полей типа [`PyVarObject`](https://python-all.ru/3.1/c-api/structures.html#PyVarObject); он используется при объявлении новых типов, представляющих объекты с длиной, которая меняется от экземпляра к экземпляру. Этот макрос всегда раскрывается в:6364```c65PyObject_HEAD66Py_ssize_t ob_size;67```6869Обратите внимание, что [`PyObject_HEAD`](https://python-all.ru/3.1/c-api/structures.html#PyObject_HEAD) является частью раскрытия, и его собственное раскрытие зависит от определения `Py_TRACE_REFS`.7071**`PyObject_HEAD_INIT`(type)**7273Это макрос, который раскрывается в значения инициализации для нового типа [`PyObject`](https://python-all.ru/3.1/c-api/structures.html#PyObject). Он раскрывается в:7475```c76_PyObject_EXTRA_INIT771, type,78```7980**`PyVarObject_HEAD_INIT`(type, size)**8182Это макрос, который раскрывается в значения инициализации для нового типа [`PyVarObject`](https://python-all.ru/3.1/c-api/structures.html#PyVarObject), включая поле [`ob_size`](https://python-all.ru/3.1/c-api/typeobj.html#ob_size). Этот макрос раскрывается в:8384```c85_PyObject_EXTRA_INIT861, type, size,87```8889**`PyCFunction`**9091Тип функций, используемых для реализации большинства вызываемых объектов Python на C. Функции этого типа принимают два параметра9293[`PyObject*`](https://python-all.ru/3.1/c-api/structures.html#PyObject)9495и возвращают одно такое значение. Если возвращаемое значение9697*NULL*9899, то должно быть установлено исключение. Если не100101*NULL*102103, возвращаемое значение интерпретируется как возвращаемое значение функции, доступное в Python. Функция должна возвращать новую ссылку.104105**`PyCFunctionWithKeywords`**106107Тип функций, используемых для реализации вызываемых объектов Python на C, которые принимают именованные аргументы: они принимают три параметра108109[`PyObject*`](https://python-all.ru/3.1/c-api/structures.html#PyObject)110111и возвращают одно такое значение. См.112113[`PyCFunction`](https://python-all.ru/3.1/c-api/structures.html#PyCFunction)114115выше для описания возвращаемого значения.116117**`PyMethodDef`**118119Структура, используемая для описания метода типа-расширения. Эта структура имеет четыре поля:120121| Поле | Тип C | Значение |122| --- | --- | --- |123| `ml_name` | char \* | имя метода |124| `ml_meth` | PyCFunction | указатель на реализацию на C |125| `ml_flags` | int | биты флагов, указывающие, как должен быть построен вызов |126| `ml_doc` | char \* | указывает на содержимое докстринга |127128Поле `ml_meth` – это указатель на функцию C. Функции могут быть разных типов, но они всегда возвращают [`PyObject*`](https://python-all.ru/3.1/c-api/structures.html#PyObject). Если функция не является [`PyCFunction`](https://python-all.ru/3.1/c-api/structures.html#PyCFunction), компилятор потребует приведения типа в таблице методов. Хотя [`PyCFunction`](https://python-all.ru/3.1/c-api/structures.html#PyCFunction) определяет первый параметр как [`PyObject*`](https://python-all.ru/3.1/c-api/structures.html#PyObject), часто реализация метода использует конкретный C-тип объекта *self*.129130Поле `ml_flags` – это битовое поле, которое может содержать следующие флаги. Отдельные флаги указывают либо соглашение о вызове, либо соглашение о связывании. Из флагов соглашения о вызове можно комбинировать только [`METH_VARARGS`](https://python-all.ru/3.1/c-api/structures.html#METH_VARARGS) и [`METH_KEYWORDS`](https://python-all.ru/3.1/c-api/structures.html#METH_KEYWORDS) (но обратите внимание, что [`METH_KEYWORDS`](https://python-all.ru/3.1/c-api/structures.html#METH_KEYWORDS) сам по себе эквивалентен `METH_VARARGS | METH_KEYWORDS`). Любой флаг соглашения о вызове можно комбинировать с флагом связывания.131132#### `METH_VARARGS`133134Это стандартное соглашение о вызове, при котором методы имеют тип135136[`PyCFunction`](https://python-all.ru/3.1/c-api/structures.html#PyCFunction)137138. Функция ожидает два значения139140[`PyObject*`](https://python-all.ru/3.1/c-api/structures.html#PyObject)141142. Первое – это объект143144*self*145146для методов; для модульных функций это объект модуля. Второй параметр (часто называемый147148*args*149150) представляет собой кортеж, содержащий все аргументы. Этот параметр обычно обрабатывается с помощью151152[`PyArg_ParseTuple()`](https://python-all.ru/3.1/c-api/arg.html#PyArg_ParseTuple)153154или155156[`PyArg_UnpackTuple()`](https://python-all.ru/3.1/c-api/arg.html#PyArg_UnpackTuple)157158.159160#### `METH_KEYWORDS`161162Методы с этими флагами должны иметь тип163164[`PyCFunctionWithKeywords`](https://python-all.ru/3.1/c-api/structures.html#PyCFunctionWithKeywords)165166. Функция ожидает три параметра:167168*self*169170,171172*args*173174и словарь всех именованных аргументов. Этот флаг обычно комбинируется с175176[`METH_VARARGS`](https://python-all.ru/3.1/c-api/structures.html#METH_VARARGS)177178, и параметры обычно обрабатываются с помощью179180[`PyArg_ParseTupleAndKeywords()`](https://python-all.ru/3.1/c-api/arg.html#PyArg_ParseTupleAndKeywords)181182.183184#### `METH_NOARGS`185186Методы без параметров не должны проверять, переданы ли аргументы, если они указаны с флагом187188[`METH_NOARGS`](https://python-all.ru/3.1/c-api/structures.html#METH_NOARGS)189190. Они должны иметь тип191192[`PyCFunction`](https://python-all.ru/3.1/c-api/structures.html#PyCFunction)193194. Первый параметр обычно называется195196*self*197198и содержит ссылку на модуль или экземпляр объекта. Во всех случаях второй параметр будет199200*NULL*201202.203204#### `METH_O`205206Методы с одним объектным аргументом могут быть указаны с флагом207208[`METH_O`](https://python-all.ru/3.1/c-api/structures.html#METH_O)209210вместо вызова211212[`PyArg_ParseTuple()`](https://python-all.ru/3.1/c-api/arg.html#PyArg_ParseTuple)213214с аргументом215216`"O"`217218. Они имеют тип219220[`PyCFunction`](https://python-all.ru/3.1/c-api/structures.html#PyCFunction)221222, с параметром223224*self*225226и параметром227228[`PyObject*`](https://python-all.ru/3.1/c-api/structures.html#PyObject)229230, представляющим единственный аргумент.231232Эти две константы не используются для указания соглашения о вызовах, а для привязки при использовании с методами классов. Они не могут использоваться для функций, определённых для модулей. Для любого данного метода может быть установлен не более чем один из этих флагов.233234#### `METH_CLASS`235236Методу будет передан объект типа в качестве первого параметра, а не экземпляр этого типа. Это используется для создания *методов класса*, аналогично тому, что создаётся при использовании встроенной функции [`classmethod()`](https://python-all.ru/3.1/library/functions.html#classmethod).237238#### `METH_STATIC`239240Методу будет передан *NULL* в качестве первого параметра, а не экземпляр типа. Это используется для создания *статических методов*, аналогично тому, что создаётся при использовании встроенной функции [`staticmethod()`](https://python-all.ru/3.1/library/functions.html#staticmethod).241242Ещё одна константа управляет тем, загружается ли метод вместо другого определения с тем же именем метода.243244#### `METH_COEXIST`245246Метод будет загружен вместо существующих определений. Без247248*METH\_COEXIST*249250по умолчанию повторные определения пропускаются. Поскольку обёртки слотов загружаются до таблицы методов, существование слота251252*sq\_contains*253254, например, породит метод-обёртку с именем255256[`__contains__()`](https://python-all.ru/3.1/reference/datamodel.html#object.__contains__)257258и помешает загрузке соответствующей PyCFunction с тем же именем. Если флаг определён, PyCFunction будет загружена вместо объекта-обёртки и будет сосуществовать со слотом. Это полезно, потому что вызовы PyCFunctions оптимизированы лучше, чем вызовы объектов-обёрток.259260**`PyMemberDef`**261262Структура, описывающая атрибут типа, который соответствует члену C-структуры. Её поля:263264| Поле | Тип C | Значение |265| --- | --- | --- |266| `name` | char \* | имя члена |267| [`type`](https://python-all.ru/3.1/library/functions.html#type) | int | тип члена в C-структуре |268| `offset` | Py\_ssize\_t | смещение в байтах, по которому член расположен в объектной структуре типа |269| `flags` | int | биты флага, указывающие, должно ли поле быть только для чтения или доступным для записи |270| `doc` | char \* | указывает на содержимое докстринга |271272Поле [`type`](https://python-all.ru/3.1/library/functions.html#type) может быть одним из многих макросов `T_`, соответствующих различным типам C. При обращении к элементу из Python он будет преобразован в соответствующий тип Python.273274| Имя макроса | Тип C |275| --- | --- |276| T\_SHORT | short |277| T\_INT | int |278| T\_LONG | long |279| T\_FLOAT | float |280| T\_DOUBLE | double |281| T\_STRING | char \* |282| T\_OBJECT | PyObject \* |283| T\_OBJECT\_EX | PyObject \* |284| T\_CHAR | char |285| T\_BYTE | char |286| T\_UBYTE | беззнаковый char |287| T\_UINT | беззнаковый int |288| T\_USHORT | беззнаковый short |289| T\_ULONG | беззнаковый long |290| T\_BOOL | char |291| T\_LONGLONG | long long |292| T\_ULONGLONG | беззнаковый long long |293| T\_PYSSIZET | Py\_ssize\_t |294295`T_OBJECT` и `T_OBJECT_EX` различаются тем, что `T_OBJECT` возвращает `None`, если поле равно *NULL*, а `T_OBJECT_EX` возбуждает [`AttributeError`](https://python-all.ru/3.1/library/exceptions.html#AttributeError). Рекомендуется использовать `T_OBJECT_EX` вместо `T_OBJECT`, так как `T_OBJECT_EX` корректнее обрабатывает применение оператора [`del`](https://python-all.ru/3.1/reference/simple_stmts.html#del) к этому атрибуту, чем `T_OBJECT`.296297`flags` может быть 0 для доступа на запись и чтение или `READONLY` для доступа только для чтения. Использование `T_STRING` для [`type`](https://python-all.ru/3.1/library/functions.html#type) неявно подразумевает `READONLY`. Только члены `T_OBJECT` и `T_OBJECT_EX` могут быть удалены. (Они устанавливаются в *NULL*).298