`structures.md`

325 строк · 25.2 КБ · обычная страница · сырой текст · скачать
1> **Источник:** https://python-all.ru/3.9/c-api/structures.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# Структуры общих объектов89При определении типов объектов Python используется большое количество структур. В данном разделе описываются эти структуры и принципы их использования.1011## Базовые типы объектов и макросы1213Все объекты Python имеют в начале своего представления в памяти небольшое число общих полей. Эти поля описываются типами [`PyObject`](https://python-all.ru/3.9/c-api/structures.html#c.PyObject) и [`PyVarObject`](https://python-all.ru/3.9/c-api/structures.html#c.PyVarObject), которые, в свою очередь, определяются через раскрытие некоторых макросов, используемых (прямо или косвенно) при определении всех остальных объектов Python.1415**`PyObject`**1617Все типы объектов являются расширениями этого типа. Это тип, который содержит информацию, необходимую Python для обработки указателя на объект как объекта. В обычной сборке «release» он содержит только счетчик ссылок объекта и указатель на соответствующий объект типа. Ничто на самом деле не объявляется как [`PyObject`](https://python-all.ru/3.9/c-api/structures.html#c.PyObject), но любой указатель на объект Python может быть приведен к [`PyObject*`](https://python-all.ru/3.9/c-api/structures.html#c.PyObject). Доступ к членам должен осуществляться с помощью макросов [`Py_REFCNT`](https://python-all.ru/3.9/c-api/structures.html#c.Py_REFCNT) и [`Py_TYPE`](https://python-all.ru/3.9/c-api/structures.html#c.Py_TYPE).1819**`PyVarObject`**2021Это расширение [`PyObject`](https://python-all.ru/3.9/c-api/structures.html#c.PyObject), добавляющее поле `ob_size`. Он используется только для объектов, которые имеют некоторое понятие *длины*. Этот тип не часто встречается в Python/C API. Доступ к членам должен осуществляться с помощью макросов [`Py_REFCNT`](https://python-all.ru/3.9/c-api/structures.html#c.Py_REFCNT), [`Py_TYPE`](https://python-all.ru/3.9/c-api/structures.html#c.Py_TYPE) и [`Py_SIZE`](https://python-all.ru/3.9/c-api/structures.html#c.Py_SIZE).2223**`PyObject_HEAD`**2425Это макрос, используемый при объявлении новых типов, представляющих объекты без изменяемой длины. Макрос PyObject\_HEAD раскрывается в:2627```c28PyObject ob_base;29```3031См. документацию [`PyObject`](https://python-all.ru/3.9/c-api/structures.html#c.PyObject) выше.3233**`PyObject_VAR_HEAD`**3435Это макрос, используемый при объявлении новых типов, представляющих объекты с длиной, которая меняется от экземпляра к экземпляру. Макрос PyObject\_VAR\_HEAD раскрывается в:3637```c38PyVarObject ob_base;39```4041См. документацию [`PyVarObject`](https://python-all.ru/3.9/c-api/structures.html#c.PyVarObject) выше.4243**`Py_TYPE`(o)**4445Этот макрос используется для доступа к полю `ob_type` объекта Python. Он раскрывается в:4647```c48(((PyObject*)(o))->ob_type)49```5051#### `int Py_IS_TYPE(PyObject *o, PyTypeObject *type)`5253Возвращает ненулевое значение, если тип объекта *o* равен *type*. В противном случае возвращает нуль. Эквивалентно `Py_TYPE(o) == type`.5455Новое в версии 3.9.5657#### `void Py_SET_TYPE(PyObject *o, PyTypeObject *type)`5859Устанавливает тип объекта *o* в *type*.6061Новое в версии 3.9.6263**`Py_REFCNT`(o)**6465Этот макрос используется для доступа к полю `ob_refcnt` объекта Python. Он раскрывается в:6667```c68(((PyObject*)(o))->ob_refcnt)69```7071#### `void Py_SET_REFCNT(PyObject *o, Py_ssize_t refcnt)`7273Устанавливает счётчик ссылок объекта *o* в значение *refcnt*.7475Новое в версии 3.9.7677**`Py_SIZE`(o)**7879Этот макрос используется для доступа к полю `ob_size` объекта Python. Он раскрывается в:8081```c82(((PyVarObject*)(o))->ob_size)83```8485#### `void Py_SET_SIZE(PyVarObject *o, Py_ssize_t size)`8687Устанавливает размер объекта *o* в *size*.8889Новое в версии 3.9.9091**`PyObject_HEAD_INIT`(type)**9293Это макрос, который раскрывается в значения инициализации для нового типа [`PyObject`](https://python-all.ru/3.9/c-api/structures.html#c.PyObject). Этот макрос раскрывается в:9495```c96_PyObject_EXTRA_INIT971, type,98```99100**`PyVarObject_HEAD_INIT`(type, size)**101102Это макрос, который разворачивается в значения инициализации для нового типа [`PyVarObject`](https://python-all.ru/3.9/c-api/structures.html#c.PyVarObject), включая поле `ob_size`. Этот макрос разворачивается в:103104```c105_PyObject_EXTRA_INIT1061, type, size,107```108109## Реализация функций и методов110111**`PyCFunction`**112113Тип функций, используемых для реализации большинства вызываемых объектов Python в C. Функции этого типа принимают два параметра [`PyObject*`](https://python-all.ru/3.9/c-api/structures.html#c.PyObject) и возвращают одно такое значение. Если возвращаемое значение равно `NULL`, должно быть установлено исключение. Если не `NULL`, возвращаемое значение интерпретируется как возвращаемое значение функции, как она представлена в Python. Функция должна возвращать новую ссылку.114115Сигнатура функции:116117```c118PyObject *PyCFunction(PyObject *self,119                      PyObject *args);120```121122**`PyCFunctionWithKeywords`**123124Тип функций, используемых для реализации вызываемых объектов Python на C с сигнатурой `METH_VARARGS | METH_KEYWORDS`. Сигнатура функции:125126```c127PyObject *PyCFunctionWithKeywords(PyObject *self,128                                  PyObject *args,129                                  PyObject *kwargs);130```131132**`_PyCFunctionFast`**133134Тип функций, используемых для реализации вызываемых объектов Python на C с сигнатурой [`METH_FASTCALL`](https://python-all.ru/3.9/c-api/structures.html#METH_FASTCALL). Сигнатура функции:135136```c137PyObject *_PyCFunctionFast(PyObject *self,138                           PyObject *const *args,139                           Py_ssize_t nargs);140```141142**`_PyCFunctionFastWithKeywords`**143144Тип функций, используемых для реализации вызываемых объектов Python на C с сигнатурой `METH_FASTCALL | METH_KEYWORDS`. Сигнатура функции:145146```c147PyObject *_PyCFunctionFastWithKeywords(PyObject *self,148                                       PyObject *const *args,149                                       Py_ssize_t nargs,150                                       PyObject *kwnames);151```152153**`PyCMethod`**154155Тип функций, используемых для реализации вызываемых объектов Python на C с сигнатурой `METH_METHOD | METH_FASTCALL | METH_KEYWORDS`. Сигнатура функции:156157```c158PyObject *PyCMethod(PyObject *self,159                    PyTypeObject *defining_class,160                    PyObject *const *args,161                    Py_ssize_t nargs,162                    PyObject *kwnames)163```164165Новое в версии 3.9.166167**`PyMethodDef`**168169Структура, используемая для описания метода типа-расширения. Эта структура имеет четыре поля:170171| Поле | Тип C | Значение |172| --- | --- | --- |173| `ml_name` | const char \* | имя метода |174| `ml_meth` | PyCFunction | указатель на реализацию на C |175| `ml_flags` | int | биты флагов, указывающие, как должен быть построен вызов |176| `ml_doc` | const char \* | указывает на содержимое докстринга |177178`ml_meth` – это указатель на функцию C. Функции могут быть разных типов, но они всегда возвращают [`PyObject*`](https://python-all.ru/3.9/c-api/structures.html#c.PyObject). Если функция не является [`PyCFunction`](https://python-all.ru/3.9/c-api/structures.html#c.PyCFunction), компилятор потребует приведения в таблице методов. Хотя [`PyCFunction`](https://python-all.ru/3.9/c-api/structures.html#c.PyCFunction) определяет первый параметр как [`PyObject*`](https://python-all.ru/3.9/c-api/structures.html#c.PyObject), обычно реализация метода использует конкретный тип C объекта *self*.179180Поле `ml_flags` – это битовое поле, которое может содержать следующие флаги. Отдельные флаги указывают либо соглашение о вызове, либо соглашение о связывании.181182Существуют следующие соглашения о вызове:183184#### `METH_VARARGS`185186Это типичное соглашение о вызове, где методы имеют тип [`PyCFunction`](https://python-all.ru/3.9/c-api/structures.html#c.PyCFunction). Функция ожидает два значения [`PyObject*`](https://python-all.ru/3.9/c-api/structures.html#c.PyObject). Первое – это объект *self* для методов; для функций модуля – это объект модуля. Второй параметр (часто называемый *args*) – это кортеж, представляющий все аргументы. Этот параметр обычно обрабатывается с помощью [`PyArg_ParseTuple()`](https://python-all.ru/3.9/c-api/arg.html#c.PyArg_ParseTuple) или [`PyArg_UnpackTuple()`](https://python-all.ru/3.9/c-api/arg.html#c.PyArg_UnpackTuple).187188#### `METH_VARARGS | METH_KEYWORDS`189190Методы с этими флагами должны быть типа [`PyCFunctionWithKeywords`](https://python-all.ru/3.9/c-api/structures.html#c.PyCFunctionWithKeywords). Функция ожидает три параметра: *self*, *args*, *kwargs*, где *kwargs* – это словарь всех именованных аргументов или `NULL`, если именованных аргументов нет. Параметры обычно обрабатываются с помощью [`PyArg_ParseTupleAndKeywords()`](https://python-all.ru/3.9/c-api/arg.html#c.PyArg_ParseTupleAndKeywords).191192#### `METH_FASTCALL`193194Быстрое соглашение о вызове, поддерживающее только позиционные аргументы. Методы имеют тип [`_PyCFunctionFast`](https://python-all.ru/3.9/c-api/structures.html#c._PyCFunctionFast). Первый параметр – *self*, второй параметр – массив C из значений [`PyObject*`](https://python-all.ru/3.9/c-api/structures.html#c.PyObject), указывающих аргументы, а третий параметр – количество аргументов (длина массива).195196Это не является частью [ограниченного API](https://python-all.ru/3.9/c-api/stable.html#stable).197198Добавлено в версии 3.7.199200#### `METH_FASTCALL | METH_KEYWORDS`201202Расширение [`METH_FASTCALL`](https://python-all.ru/3.9/c-api/structures.html#METH_FASTCALL), поддерживающее также именованные аргументы, с методами типа [`_PyCFunctionFastWithKeywords`](https://python-all.ru/3.9/c-api/structures.html#c._PyCFunctionFastWithKeywords). Именованные аргументы передаются так же, как и в [протоколе vectorcall](https://python-all.ru/3.9/c-api/call.html#vectorcall): есть дополнительный четвертый параметр [`PyObject*`](https://python-all.ru/3.9/c-api/structures.html#c.PyObject), который является кортежем, представляющим имена именованных аргументов (гарантированно строки) или возможно `NULL`, если нет ключевых слов. Значения именованных аргументов хранятся в массиве *args* после позиционных аргументов.203204Это не является частью [ограниченного API](https://python-all.ru/3.9/c-api/stable.html#stable).205206Добавлено в версии 3.7.207208#### `METH_METHOD | METH_FASTCALL | METH_KEYWORDS`209210Расширение `METH_FASTCALL | METH_KEYWORDS`, поддерживающее *определяющий класс*, то есть класс, содержащий данный метод. Определяющий класс может быть суперклассом `Py_TYPE(self)`.211212Метод должен быть типа [`PyCMethod`](https://python-all.ru/3.9/c-api/structures.html#c.PyCMethod), как и для `METH_FASTCALL | METH_KEYWORDS` с добавленным аргументом `defining_class` после `self`.213214Новое в версии 3.9.215216#### `METH_NOARGS`217218Методы без параметров не должны проверять, переданы ли аргументы, если они перечислены с флагом [`METH_NOARGS`](https://python-all.ru/3.9/c-api/structures.html#METH_NOARGS). Они должны быть типа [`PyCFunction`](https://python-all.ru/3.9/c-api/structures.html#c.PyCFunction). Первый параметр обычно называется *self* и будет содержать ссылку на модуль или экземпляр объекта. Во всех случаях второй параметр будет `NULL`.219220#### `METH_O`221222Методы с одним аргументом-объектом могут быть перечислены с помощью флага [`METH_O`](https://python-all.ru/3.9/c-api/structures.html#METH_O) вместо вызова [`PyArg_ParseTuple()`](https://python-all.ru/3.9/c-api/arg.html#c.PyArg_ParseTuple) с аргументом `"O"`. Они имеют тип [`PyCFunction`](https://python-all.ru/3.9/c-api/structures.html#c.PyCFunction), с параметром *self* и параметром [`PyObject*`](https://python-all.ru/3.9/c-api/structures.html#c.PyObject), представляющим единственный аргумент.223224Эти две константы не используются для указания соглашения о вызовах, а для привязки при использовании с методами классов. Они не могут использоваться для функций, определённых для модулей. Для любого данного метода может быть установлен не более чем один из этих флагов.225226#### `METH_CLASS`227228Метод получит объект типа в качестве первого параметра, а не экземпляр типа. Это используется для создания *методов класса*, аналогично тому, что создаётся при использовании [`classmethod()`](https://python-all.ru/3.9/library/functions.html#classmethod) встроенной функции.229230#### `METH_STATIC`231232Метод получит `NULL` в качестве первого параметра, а не экземпляр типа. Это используется для создания *статических методов*, аналогично тому, что создаётся при использовании встроенной функции [`staticmethod()`](https://python-all.ru/3.9/library/functions.html#staticmethod).233234Ещё одна константа управляет тем, загружается ли метод вместо другого определения с тем же именем метода.235236#### `METH_COEXIST`237238Метод будет загружен вместо существующих определений. Без *METH\_COEXIST* по умолчанию повторяющиеся определения пропускаются. Поскольку обёртки слотов загружаются до таблицы методов, наличие слота *sq\_contains*, например, приведёт к созданию обёрнутого метода с именем [`__contains__()`](https://python-all.ru/3.9/reference/datamodel.html#object.__contains__) и предотвратит загрузку соответствующего PyCFunction с тем же именем. При установленном флаге PyCFunction будет загружен вместо объекта-обёртки и будет сосуществовать со слотом. Это полезно, поскольку вызовы PyCFunctions оптимизированы лучше, чем вызовы объектов-обёрток.239240## Доступ к атрибутам типов расширений241242**`PyMemberDef`**243244Структура, описывающая атрибут типа, который соответствует члену C-структуры. Её поля:245246| Поле | Тип C | Значение |247| --- | --- | --- |248| `name` | const char \* | имя члена |249| `type` | int | тип члена в C-структуре |250| `offset` | Py\_ssize\_t | смещение в байтах, по которому член расположен в объектной структуре типа |251| `flags` | int | биты флага, указывающие, должно ли поле быть только для чтения или доступным для записи |252| `doc` | const char \* | указывает на содержимое докстринга |253254`type` может быть одним из многих макросов `T_`, соответствующих различным C типам. При обращении к члену из Python он будет преобразован в эквивалентный тип Python.255256| Имя макроса | Тип C |257| --- | --- |258| T\_SHORT | short |259| T\_INT | int |260| T\_LONG | long |261| T\_FLOAT | float |262| T\_DOUBLE | double |263| T\_STRING | const char \* |264| T\_OBJECT | PyObject \* |265| T\_OBJECT\_EX | PyObject \* |266| T\_CHAR | char |267| T\_BYTE | char |268| T\_UBYTE | unsigned char |269| T\_UINT | unsigned int |270| T\_USHORT | unsigned short |271| T\_ULONG | unsigned long |272| T\_BOOL | char |273| T\_LONGLONG | long long |274| T\_ULONGLONG | unsigned long long |275| T\_PYSSIZET | Py\_ssize\_t |276277`T_OBJECT` и `T_OBJECT_EX` различаются тем, что `T_OBJECT` возвращает `None`, если член равен `NULL`, а `T_OBJECT_EX` возбуждает [`AttributeError`](https://python-all.ru/3.9/library/exceptions.html#AttributeError). Старайтесь использовать `T_OBJECT_EX` вместо `T_OBJECT`, потому что `T_OBJECT_EX` правильнее обрабатывает использование оператора [`del`](https://python-all.ru/3.9/reference/simple_stmts.html#del) для этого атрибута, чем `T_OBJECT`.278279`flags` может быть `0` для доступа на запись и чтение или `READONLY` для доступа только на чтение. Использование `T_STRING` для [`type`](https://python-all.ru/3.9/library/functions.html#type) подразумевает `READONLY`. Данные `T_STRING` интерпретируются как UTF-8. Удалять можно только члены `T_OBJECT` и `T_OBJECT_EX`. (Они устанавливаются в `NULL`).280281Heap allocated types (created using [`PyType_FromSpec()`](https://python-all.ru/3.9/c-api/type.html#c.PyType_FromSpec) or similar), `PyMemberDef` may contain definitions for the special members `__dictoffset__`, `__weaklistoffset__` and `__vectorcalloffset__`, corresponding to [`tp_dictoffset`](https://python-all.ru/3.9/c-api/typeobj.html#c.PyTypeObject.tp_dictoffset), [`tp_weaklistoffset`](https://python-all.ru/3.9/c-api/typeobj.html#c.PyTypeObject.tp_weaklistoffset) and [`tp_vectorcall_offset`](https://python-all.ru/3.9/c-api/typeobj.html#c.PyTypeObject.tp_vectorcall_offset) in type objects. These must be defined with `T_PYSSIZET` and `READONLY`, for example:282283```c284static PyMemberDef spam_type_members[] = {285    {"__dictoffset__", T_PYSSIZET, offsetof(Spam_object, dict), READONLY},286    {NULL}  /* Страж */287};288```289290#### `PyObject* PyMember_GetOne(const char *obj_addr, struct PyMemberDef *m)`291292Получает атрибут, принадлежащий объекту по адресу *obj\_addr*. Атрибут описывается с помощью `PyMemberDef` *m*. Возвращает `NULL` при ошибке.293294#### `int PyMember_SetOne(char *obj_addr, struct PyMemberDef *m, PyObject *o)`295296Устанавливает атрибут, принадлежащий объекту по адресу *obj\_addr*, в значение объекта *o*. Устанавливаемый атрибут описывается с помощью `PyMemberDef` *m*. Возвращает `0` в случае успеха и отрицательное значение при ошибке.297298**`PyGetSetDef`**299300Структура для определения доступа по типу свойства для типа. См. также описание слота [`PyTypeObject.tp_getset`](https://python-all.ru/3.9/c-api/typeobj.html#c.PyTypeObject.tp_getset).301302| Поле | Тип C | Значение |303| --- | --- | --- |304| имя | const char \* | имя атрибута |305| get | getter | C-функция для получения атрибута |306| множество | setter | необязательная C-функция для установки или удаления атрибута, если не указана, атрибут доступен только для чтения |307| doc | const char \* | необязательная строка документации |308| closure | void \* | необязательный указатель на функцию, предоставляющий дополнительные данные для геттера и сеттера |309310Функция `get` принимает один параметр [`PyObject*`](https://python-all.ru/3.9/c-api/structures.html#c.PyObject) (экземпляр) и указатель на функцию (связанный `closure`):311312```c313typedef PyObject *(*getter)(PyObject *, void *);314```315316В случае успеха должна возвращать новую ссылку или `NULL` с установленным исключением в случае неудачи.317318Функции `set` принимают два параметра [`PyObject*`](https://python-all.ru/3.9/c-api/structures.html#c.PyObject) (экземпляр и устанавливаемое значение) и указатель на функцию (связанный `closure`):319320```c321typedef int (*setter)(PyObject *, PyObject *, void *);322```323324Если атрибут должен быть удален, второй параметр равен `NULL`. В случае успеха должна возвращать `0` или `-1` с установленным исключением в случае неудачи.325