`structures.md`

176 строк · 16.8 КБ · обычная страница · сырой текст · скачать
1> **Источник:** https://python-all.ru/3.5/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.5/c-api/structures.html#c.PyObject) и [`PyVarObject`](https://python-all.ru/3.5/c-api/structures.html#c.PyVarObject), которые, в свою очередь, определяются через раскрытие некоторых макросов, используемых (прямо или косвенно) при определении всех остальных объектов Python.1213**`PyObject`**1415Все типы объектов являются расширениями этого типа. Это тип, который содержит информацию, необходимую Python для обработки указателя на объект как объекта. В обычной сборке «release» он содержит только счетчик ссылок объекта и указатель на соответствующий объект типа. Ничто на самом деле не объявляется как [`PyObject`](https://python-all.ru/3.5/c-api/structures.html#c.PyObject), но любой указатель на объект Python может быть приведен к [`PyObject*`](https://python-all.ru/3.5/c-api/structures.html#c.PyObject). Доступ к членам должен осуществляться с помощью макросов [`Py_REFCNT`](https://python-all.ru/3.5/c-api/structures.html#c.Py_REFCNT) и [`Py_TYPE`](https://python-all.ru/3.5/c-api/structures.html#c.Py_TYPE).1617**`PyVarObject`**1819Это расширение [`PyObject`](https://python-all.ru/3.5/c-api/structures.html#c.PyObject), добавляющее поле `ob_size`. Он используется только для объектов, которые имеют некоторое понятие *длины*. Этот тип не часто встречается в Python/C API. Доступ к членам должен осуществляться с помощью макросов [`Py_REFCNT`](https://python-all.ru/3.5/c-api/structures.html#c.Py_REFCNT), [`Py_TYPE`](https://python-all.ru/3.5/c-api/structures.html#c.Py_TYPE) и [`Py_SIZE`](https://python-all.ru/3.5/c-api/structures.html#c.Py_SIZE).2021**`PyObject_HEAD`**2223Это макрос, используемый при объявлении новых типов, представляющих объекты без изменяемой длины. Макрос PyObject\_HEAD раскрывается в:2425```c26PyObject ob_base;27```2829См. документацию [`PyObject`](https://python-all.ru/3.5/c-api/structures.html#c.PyObject) выше.3031**`PyObject_VAR_HEAD`**3233Это макрос, используемый при объявлении новых типов, представляющих объекты с длиной, которая меняется от экземпляра к экземпляру. Макрос PyObject\_VAR\_HEAD раскрывается в:3435```c36PyVarObject ob_base;37```3839См. документацию [`PyVarObject`](https://python-all.ru/3.5/c-api/structures.html#c.PyVarObject) выше.4041**`Py_TYPE`(o)**4243Этот макрос используется для доступа к полю `ob_type` объекта Python. Он раскрывается в:4445```c46(((PyObject*)(o))->ob_type)47```4849**`Py_REFCNT`(o)**5051Этот макрос используется для доступа к полю `ob_refcnt` объекта Python. Он раскрывается в:5253```c54(((PyObject*)(o))->ob_refcnt)55```5657**`Py_SIZE`(o)**5859Этот макрос используется для доступа к полю `ob_size` объекта Python. Он раскрывается в:6061```c62(((PyVarObject*)(o))->ob_size)63```6465**`PyObject_HEAD_INIT`(type)**6667Это макрос, который раскрывается в значения инициализации для нового типа [`PyObject`](https://python-all.ru/3.5/c-api/structures.html#c.PyObject). Этот макрос раскрывается в:6869```c70_PyObject_EXTRA_INIT711, type,72```7374**`PyVarObject_HEAD_INIT`(type, size)**7576Это макрос, который разворачивается в значения инициализации для нового типа [`PyVarObject`](https://python-all.ru/3.5/c-api/structures.html#c.PyVarObject), включая поле `ob_size`. Этот макрос разворачивается в:7778```c79_PyObject_EXTRA_INIT801, type, size,81```8283**`PyCFunction`**8485Тип функций, используемых для реализации большинства вызываемых объектов Python в C. Функции этого типа принимают два параметра [`PyObject*`](https://python-all.ru/3.5/c-api/structures.html#c.PyObject) и возвращают одно такое значение. Если возвращаемое значение равно *NULL*, то было установлено исключение. Если не *NULL*, возвращаемое значение интерпретируется как возвращаемое значение функции, доступное в Python. Функция должна возвращать новую ссылку.8687**`PyCFunctionWithKeywords`**8889Тип функций, используемых для реализации вызываемых объектов Python в C, которые принимают именованные аргументы: они принимают три параметра [`PyObject*`](https://python-all.ru/3.5/c-api/structures.html#c.PyObject) и возвращают одно такое значение. См. [`PyCFunction`](https://python-all.ru/3.5/c-api/structures.html#c.PyCFunction) выше для описания возвращаемого значения.9091**`PyMethodDef`**9293Структура, используемая для описания метода типа-расширения. Эта структура имеет четыре поля:9495| Поле | Тип C | Значение |96| --- | --- | --- |97| `ml_name` | char \* | имя метода |98| `ml_meth` | PyCFunction | указатель на реализацию на C |99| `ml_flags` | int | биты флагов, указывающие, как должен быть построен вызов |100| `ml_doc` | char \* | указывает на содержимое докстринга |101102`ml_meth` – это указатель на функцию C. Функции могут быть разных типов, но они всегда возвращают [`PyObject*`](https://python-all.ru/3.5/c-api/structures.html#c.PyObject). Если функция не является [`PyCFunction`](https://python-all.ru/3.5/c-api/structures.html#c.PyCFunction), компилятор потребует приведения в таблице методов. Хотя [`PyCFunction`](https://python-all.ru/3.5/c-api/structures.html#c.PyCFunction) определяет первый параметр как [`PyObject*`](https://python-all.ru/3.5/c-api/structures.html#c.PyObject), обычно реализация метода использует конкретный тип C объекта *self*.103104Поле `ml_flags` является битовым полем, которое может содержать следующие флаги. Отдельные флаги указывают либо на соглашение о вызове, либо на соглашение о привязке. Из флагов соглашения о вызове можно комбинировать только [`METH_VARARGS`](https://python-all.ru/3.5/c-api/structures.html#METH_VARARGS) и [`METH_KEYWORDS`](https://python-all.ru/3.5/c-api/structures.html#METH_KEYWORDS). Любой из флагов соглашения о вызове можно комбинировать с флагом привязки.105106#### `METH_VARARGS`107108Это типичное соглашение о вызове, где методы имеют тип [`PyCFunction`](https://python-all.ru/3.5/c-api/structures.html#c.PyCFunction). Функция ожидает два значения [`PyObject*`](https://python-all.ru/3.5/c-api/structures.html#c.PyObject). Первое – это объект *self* для методов; для функций модуля – это объект модуля. Второй параметр (часто называемый *args*) – это кортеж, представляющий все аргументы. Этот параметр обычно обрабатывается с помощью [`PyArg_ParseTuple()`](https://python-all.ru/3.5/c-api/arg.html#c.PyArg_ParseTuple) или [`PyArg_UnpackTuple()`](https://python-all.ru/3.5/c-api/arg.html#c.PyArg_UnpackTuple).109110#### `METH_KEYWORDS`111112Методы с этими флагами должны быть типа [`PyCFunctionWithKeywords`](https://python-all.ru/3.5/c-api/structures.html#c.PyCFunctionWithKeywords). Функция ожидает три параметра: *self*, *args* и словарь всех именованных аргументов. Флаг должен быть объединён с [`METH_VARARGS`](https://python-all.ru/3.5/c-api/structures.html#METH_VARARGS), а параметры обычно обрабатываются с помощью [`PyArg_ParseTupleAndKeywords()`](https://python-all.ru/3.5/c-api/arg.html#c.PyArg_ParseTupleAndKeywords).113114#### `METH_NOARGS`115116Методы без параметров не должны проверять, переданы ли аргументы, если они указаны с флагом [`METH_NOARGS`](https://python-all.ru/3.5/c-api/structures.html#METH_NOARGS). Они должны быть типа [`PyCFunction`](https://python-all.ru/3.5/c-api/structures.html#c.PyCFunction). Первый параметр обычно называется *self* и содержит ссылку на модуль или экземпляр объекта. Во всех случаях второй параметр будет *NULL*.117118#### `METH_O`119120Методы с одним аргументом-объектом могут быть перечислены с помощью флага [`METH_O`](https://python-all.ru/3.5/c-api/structures.html#METH_O) вместо вызова [`PyArg_ParseTuple()`](https://python-all.ru/3.5/c-api/arg.html#c.PyArg_ParseTuple) с аргументом `"O"`. Они имеют тип [`PyCFunction`](https://python-all.ru/3.5/c-api/structures.html#c.PyCFunction), с параметром *self* и параметром [`PyObject*`](https://python-all.ru/3.5/c-api/structures.html#c.PyObject), представляющим единственный аргумент.121122Эти две константы не используются для указания соглашения о вызовах, а для привязки при использовании с методами классов. Они не могут использоваться для функций, определённых для модулей. Для любого данного метода может быть установлен не более чем один из этих флагов.123124#### `METH_CLASS`125126Метод получит объект типа в качестве первого параметра, а не экземпляр типа. Это используется для создания *методов класса*, аналогично тому, что создаётся при использовании [`classmethod()`](https://python-all.ru/3.5/library/functions.html#classmethod) встроенной функции.127128#### `METH_STATIC`129130Методу будет передан *NULL* в качестве первого параметра вместо экземпляра типа. Это используется для создания *статических методов*, аналогичных тому, что создаётся при использовании встроенной функции [`staticmethod()`](https://python-all.ru/3.5/library/functions.html#staticmethod).131132Ещё одна константа управляет тем, загружается ли метод вместо другого определения с тем же именем метода.133134#### `METH_COEXIST`135136Метод будет загружен вместо существующих определений. Без *METH\_COEXIST* по умолчанию повторяющиеся определения пропускаются. Поскольку обёртки слотов загружаются до таблицы методов, наличие слота *sq\_contains*, например, приведёт к созданию обёрнутого метода с именем [`__contains__()`](https://python-all.ru/3.5/reference/datamodel.html#object.__contains__) и предотвратит загрузку соответствующего PyCFunction с тем же именем. При установленном флаге PyCFunction будет загружен вместо объекта-обёртки и будет сосуществовать со слотом. Это полезно, поскольку вызовы PyCFunctions оптимизированы лучше, чем вызовы объектов-обёрток.137138**`PyMemberDef`**139140Структура, описывающая атрибут типа, который соответствует члену C-структуры. Её поля:141142| Поле | Тип C | Значение |143| --- | --- | --- |144| `name` | char \* | имя члена |145| `type` | int | тип члена в C-структуре |146| `offset` | Py\_ssize\_t | смещение в байтах, по которому член расположен в объектной структуре типа |147| `flags` | int | биты флага, указывающие, должно ли поле быть только для чтения или доступным для записи |148| `doc` | char \* | указывает на содержимое докстринга |149150`type` может быть одним из многих макросов `T_`, соответствующих различным C типам. При обращении к члену из Python он будет преобразован в эквивалентный тип Python.151152| Имя макроса | Тип C |153| --- | --- |154| T\_SHORT | short |155| T\_INT | int |156| T\_LONG | long |157| T\_FLOAT | float |158| T\_DOUBLE | double |159| T\_STRING | char \* |160| T\_OBJECT | PyObject \* |161| T\_OBJECT\_EX | PyObject \* |162| T\_CHAR | char |163| T\_BYTE | char |164| T\_UBYTE | unsigned char |165| T\_UINT | unsigned int |166| T\_USHORT | unsigned short |167| T\_ULONG | unsigned long |168| T\_BOOL | char |169| T\_LONGLONG | long long |170| T\_ULONGLONG | unsigned long long |171| T\_PYSSIZET | Py\_ssize\_t |172173`T_OBJECT` и `T_OBJECT_EX` различаются тем, что `T_OBJECT` возвращает `None`, если поле равно *NULL*, а `T_OBJECT_EX` возбуждает [`AttributeError`](https://python-all.ru/3.5/library/exceptions.html#AttributeError). Старайтесь использовать `T_OBJECT_EX` вместо `T_OBJECT`, поскольку `T_OBJECT_EX` более корректно обрабатывает использование оператора [`del`](https://python-all.ru/3.5/reference/simple_stmts.html#del) для этого атрибута, чем `T_OBJECT`.174175`flags` может быть `0` для доступа на запись и чтение или `READONLY` для доступа только для чтения. Использование `T_STRING` для [`type`](https://python-all.ru/3.5/library/functions.html#type) подразумевает `READONLY`. Могут быть удалены только члены `T_OBJECT` и `T_OBJECT_EX`. (Они устанавливаются в *NULL*).176