`structures.md`

637 строк · 52.5 КБ · обычная страница · сырой текст · скачать
1> **Источник:** https://python-all.ru/3/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/c-api/structures.html#c.PyObject) и [`PyVarObject`](https://python-all.ru/3/c-api/structures.html#c.PyVarObject), которые, в свою очередь, определяются расширениями некоторых макросов, также используемых (прямо или косвенно) в определении всех остальных объектов Python. Дополнительные макросы можно найти в разделе [подсчёт ссылок](https://python-all.ru/3/c-api/refcounting.html#countingrefs).1415#### `type PyObject`1617*Часть [Limited API](https://python-all.ru/3/c-api/stable.html#stable). (Только некоторые члены являются частью стабильного ABI.)*1819Все типы объектов являются расширениями этого типа. Это тип, который содержит информацию, необходимую Python для обработки указателя на объект как объекта. В обычной сборке «release» он содержит только счётчик ссылок объекта и указатель на соответствующий объект типа. Ничто на самом деле не объявляется как [`PyObject`](https://python-all.ru/3/c-api/structures.html#c.PyObject), но любой указатель на объект Python может быть приведён к [PyObject](https://python-all.ru/3/c-api/structures.html#c.PyObject)\*.2021К элементам нельзя обращаться напрямую; вместо этого используйте макросы, такие как [`Py_REFCNT`](https://python-all.ru/3/c-api/refcounting.html#c.Py_REFCNT) и [`Py_TYPE`](https://python-all.ru/3/c-api/structures.html#c.Py_TYPE).2223#### `Py_ssize_t ob_refcnt`2425*Часть [Stable ABI](https://python-all.ru/3/c-api/stable.html#stable).*2627Счётчик ссылок объекта, возвращаемый [`Py_REFCNT`](https://python-all.ru/3/c-api/refcounting.html#c.Py_REFCNT). Не используйте это поле напрямую; вместо этого используйте функции и макросы, такие как `Py_REFCNT`, [`Py_INCREF()`](https://python-all.ru/3/c-api/refcounting.html#c.Py_INCREF) и [`Py_DecRef()`](https://python-all.ru/3/c-api/refcounting.html#c.Py_DecRef).2829Тип поля может отличаться от `Py_ssize_t` в зависимости от конфигурации сборки и платформы.3031#### `PyTypeObject *ob_type`3233*Часть [Stable ABI](https://python-all.ru/3/c-api/stable.html#stable).*3435Тип объекта. Не используйте это поле напрямую; вместо этого используйте [`Py_TYPE`](https://python-all.ru/3/c-api/structures.html#c.Py_TYPE) и [`Py_SET_TYPE()`](https://python-all.ru/3/c-api/structures.html#c.Py_SET_TYPE).3637#### `type PyVarObject`3839*Часть [Limited API](https://python-all.ru/3/c-api/stable.html#stable). (Только некоторые члены являются частью стабильного ABI.)*4041Расширение [`PyObject`](https://python-all.ru/3/c-api/structures.html#c.PyObject), добавляющее поле [`ob_size`](https://python-all.ru/3/c-api/structures.html#c.PyVarObject.ob_size). Предназначено для объектов, имеющих некоторое понятие *длины*.4243Как и в случае с `PyObject`, к элементам нельзя обращаться напрямую; вместо этого используйте макросы, такие как [`Py_SIZE`](https://python-all.ru/3/c-api/structures.html#c.Py_SIZE), [`Py_REFCNT`](https://python-all.ru/3/c-api/refcounting.html#c.Py_REFCNT) и [`Py_TYPE`](https://python-all.ru/3/c-api/structures.html#c.Py_TYPE).4445#### `Py_ssize_t ob_size`4647*Часть [Stable ABI](https://python-all.ru/3/c-api/stable.html#stable).*4849Поле размера, содержимое которого следует считать внутренней деталью реализации объекта.5051Не используйте это поле напрямую; вместо этого используйте [`Py_SIZE`](https://python-all.ru/3/c-api/structures.html#c.Py_SIZE).5253Функции создания объектов, такие как [`PyObject_NewVar()`](https://python-all.ru/3/c-api/allocation.html#c.PyObject_NewVar), обычно устанавливают это поле в запрошенный размер (количество элементов). После создания в `ob_size` можно сохранять произвольные значения с помощью [`Py_SET_SIZE`](https://python-all.ru/3/c-api/structures.html#c.Py_SET_SIZE).5455Чтобы получить публично доступную длину объекта, возвращаемую функцией Python [`len()`](https://python-all.ru/3/library/functions.html#len), используйте [`PyObject_Length()`](https://python-all.ru/3/c-api/object.html#c.PyObject_Length).5657#### `PyObject_HEAD`5859Это макрос, используемый при объявлении новых типов, представляющих объекты без изменяемой длины. Макрос PyObject\_HEAD раскрывается в:6061```c62PyObject ob_base;63```6465См. документацию [`PyObject`](https://python-all.ru/3/c-api/structures.html#c.PyObject) выше.6667#### `PyObject_VAR_HEAD`6869Это макрос, используемый при объявлении новых типов, представляющих объекты с длиной, которая меняется от экземпляра к экземпляру. Макрос PyObject\_VAR\_HEAD раскрывается в:7071```c72PyVarObject ob_base;73```7475См. документацию [`PyVarObject`](https://python-all.ru/3/c-api/structures.html#c.PyVarObject) выше.7677#### `PyTypeObject PyBaseObject_Type`7879*Часть [Stable ABI](https://python-all.ru/3/c-api/stable.html#stable).*8081Базовый класс всех остальных объектов, аналогичен [`object`](https://python-all.ru/3/library/functions.html#object) в Python.8283#### `int Py_Is(PyObject *x, PyObject *y)`8485*Часть [Stable ABI](https://python-all.ru/3/c-api/stable.html#stable) начиная с версии 3.10.*8687Проверяет, является ли объект *x* тем же объектом, что и *y*, аналогично `x is y` в Python.8889Добавлено в версии 3.10.9091#### `int Py_IsNone(PyObject *x)`9293*Часть [Stable ABI](https://python-all.ru/3/c-api/stable.html#stable) начиная с версии 3.10.*9495Проверяет, является ли объект синглтоном `None`, аналогично `x is None` в Python.9697Добавлено в версии 3.10.9899#### `int Py_IsTrue(PyObject *x)`100101*Часть [Stable ABI](https://python-all.ru/3/c-api/stable.html#stable) начиная с версии 3.10.*102103Проверяет, является ли объект синглтоном `True`, аналогично `x is True` в Python.104105Добавлено в версии 3.10.106107#### `int Py_IsFalse(PyObject *x)`108109*Часть [Stable ABI](https://python-all.ru/3/c-api/stable.html#stable) начиная с версии 3.10.*110111Проверяет, является ли объект синглтоном `False`, аналогично `x is False` в Python.112113Добавлено в версии 3.10.114115#### `PyTypeObject *Py_TYPE(PyObject *o)`116117*Возвращаемое значение: заёмная ссылка.*118119*Часть [Stable ABI](https://python-all.ru/3/c-api/stable.html#stable) начиная с версии 3.14.*120121Возвращает тип объекта Python *o*.122123Возвращаемая ссылка является [заёмной](https://python-all.ru/3/glossary.html#term-borrowed-reference) из *o*. Не освобождайте её с помощью [`Py_DECREF()`](https://python-all.ru/3/c-api/refcounting.html#c.Py_DECREF) или аналогичных средств.124125Изменено в версии 3.11: [`Py_TYPE()`](https://python-all.ru/3/c-api/structures.html#c.Py_TYPE) изменён на встроенную статическую функцию. Тип параметра больше не const [PyObject](https://python-all.ru/3/c-api/structures.html#c.PyObject)\*.126127#### `int Py_IS_TYPE(PyObject *o, PyTypeObject *type)`128129Возвращает ненулевое значение, если тип объекта *o* равен *type*. В противном случае возвращает нуль. Эквивалентно `Py_TYPE(o) == type`.130131Добавлено в версии 3.9.132133#### `void Py_SET_TYPE(PyObject *o, PyTypeObject *type)`134135Устанавливает тип объекта *o* в *type* без какой-либо проверки или подсчёта ссылок.136137Это операция очень низкого уровня. Вместо этого рекомендуется устанавливать атрибут Python [`__class__`](https://python-all.ru/3/reference/datamodel.html#object.__class__) с помощью [`PyObject_SetAttrString()`](https://python-all.ru/3/c-api/object.html#c.PyObject_SetAttrString) или аналогичного.138139Обратите внимание, что присвоение несовместимого типа может привести к неопределённому поведению.140141Если *type* является [кучным типом (heap type)](https://python-all.ru/3/c-api/typeobj.html#heap-types), вызывающий должен создать новую ссылку на него. Аналогично, если старый тип *o* является кучным типом, вызывающий должен освободить ссылку на этот тип.142143Добавлено в версии 3.9.144145#### `Py_ssize_t Py_SIZE(PyVarObject *o)`146147Возвращает поле [`ob_size`](https://python-all.ru/3/c-api/structures.html#c.PyVarObject.ob_size) объекта *o*.148149Изменено в версии 3.11: [`Py_SIZE()`](https://python-all.ru/3/c-api/structures.html#c.Py_SIZE) изменён на встроенную статическую функцию. Тип параметра больше не const [PyVarObject](https://python-all.ru/3/c-api/structures.html#c.PyVarObject)\*.150151#### `void Py_SET_SIZE(PyVarObject *o, Py_ssize_t size)`152153Устанавливает поле [`ob_size`](https://python-all.ru/3/c-api/structures.html#c.PyVarObject.ob_size) объекта *o* в *size*.154155Добавлено в версии 3.9.156157#### `PyObject_HEAD_INIT(type)`158159Это макрос, который раскрывается в значения инициализации для нового типа [`PyObject`](https://python-all.ru/3/c-api/structures.html#c.PyObject). Этот макрос раскрывается в:160161```c162_PyObject_EXTRA_INIT1631, type,164```165166#### `PyVarObject_HEAD_INIT(type, size)`167168Это макрос, который разворачивается в значения инициализации для нового типа [`PyVarObject`](https://python-all.ru/3/c-api/structures.html#c.PyVarObject), включая поле [`ob_size`](https://python-all.ru/3/c-api/structures.html#c.PyVarObject.ob_size). Этот макрос разворачивается в:169170```c171_PyObject_EXTRA_INIT1721, type, size,173```174175## Реализация функций и методов176177#### `type PyCFunction`178179*Часть [Stable ABI](https://python-all.ru/3/c-api/stable.html#stable).*180181Тип функций, используемых для реализации большинства вызываемых объектов Python на C. Функции этого типа принимают два параметра [PyObject](https://python-all.ru/3/c-api/structures.html#c.PyObject)\* и возвращают одно такое значение. Если возвращаемое значение равно `NULL`, должно быть установлено исключение. Если не `NULL`, возвращаемое значение интерпретируется как возвращаемое значение функции, доступной в Python. Функция должна возвращать новую ссылку.182183Сигнатура функции:184185```c186PyObject *PyCFunction(PyObject *self,187                      PyObject *args);188```189190#### `type PyCFunctionWithKeywords`191192*Часть [Stable ABI](https://python-all.ru/3/c-api/stable.html#stable).*193194Тип функций, используемых для реализации вызываемых объектов Python на C с сигнатурой [METH\_VARARGS | METH\_KEYWORDS](https://python-all.ru/3/c-api/structures.html#meth-varargs-meth-keywords). Сигнатура функции:195196```c197PyObject *PyCFunctionWithKeywords(PyObject *self,198                                  PyObject *args,199                                  PyObject *kwargs);200```201202#### `type PyCFunctionFast`203204*Часть [Stable ABI](https://python-all.ru/3/c-api/stable.html#stable), начиная с версии 3.13.*205206Тип функций, используемых для реализации вызываемых объектов Python на C с сигнатурой [`METH_FASTCALL`](https://python-all.ru/3/c-api/structures.html#c.METH_FASTCALL). Сигнатура функции:207208```c209PyObject *PyCFunctionFast(PyObject *self,210                          PyObject *const *args,211                          Py_ssize_t nargs);212```213214#### `type PyCFunctionFastWithKeywords`215216*Часть [Stable ABI](https://python-all.ru/3/c-api/stable.html#stable), начиная с версии 3.13.*217218Тип функций, используемых для реализации вызываемых объектов Python на C с сигнатурой [METH\_FASTCALL | METH\_KEYWORDS](https://python-all.ru/3/c-api/structures.html#meth-fastcall-meth-keywords). Сигнатура функции:219220```c221PyObject *PyCFunctionFastWithKeywords(PyObject *self,222                                      PyObject *const *args,223                                      Py_ssize_t nargs,224                                      PyObject *kwnames);225```226227#### `type PyCMethod`228229Тип функций, используемых для реализации вызываемых объектов Python на C с сигнатурой [METH\_METHOD | METH\_FASTCALL | METH\_KEYWORDS](https://python-all.ru/3/c-api/structures.html#meth-method-meth-fastcall-meth-keywords). Сигнатура функции:230231```c232PyObject *PyCMethod(PyObject *self,233                    PyTypeObject *defining_class,234                    PyObject *const *args,235                    Py_ssize_t nargs,236                    PyObject *kwnames)237```238239Добавлено в версии 3.9.240241#### `type PyMethodDef`242243*Часть [Stable ABI](https://python-all.ru/3/c-api/stable.html#stable) (включая все члены).*244245Структура, используемая для описания метода типа-расширения. Эта структура имеет четыре поля:246247#### `const char *ml_name`248249Имя метода.250251#### `PyCFunction ml_meth`252253Указатель на реализацию на C.254255#### `int ml_flags`256257Битовые флаги, указывающие, как должен быть построен вызов.258259#### `const char *ml_doc`260261Указывает на содержимое строки документации.262263[`ml_meth`](https://python-all.ru/3/c-api/structures.html#c.PyMethodDef.ml_meth) – это указатель на функцию C. Функции могут быть разных типов, но они всегда возвращают [PyObject](https://python-all.ru/3/c-api/structures.html#c.PyObject)\*. Если функция не относится к [`PyCFunction`](https://python-all.ru/3/c-api/structures.html#c.PyCFunction), компилятор потребует приведения типа в таблице методов. Несмотря на то, что `PyCFunction` определяет первый параметр как PyObject\*, обычно реализация метода использует конкретный тип C объекта *self*.264265Поле [`ml_flags`](https://python-all.ru/3/c-api/structures.html#c.PyMethodDef.ml_flags) – это битовое поле, которое может содержать следующие флаги. Отдельные флаги указывают либо соглашение о вызове, либо соглашение о связывании.266267Существуют следующие соглашения о вызове:268269#### `METH_VARARGS`270271*Часть [Stable ABI](https://python-all.ru/3/c-api/stable.html#stable).*272273Это типичное соглашение о вызове, при котором методы имеют тип [`PyCFunction`](https://python-all.ru/3/c-api/structures.html#c.PyCFunction). Функция ожидает два значения [PyObject](https://python-all.ru/3/c-api/structures.html#c.PyObject)\*. Первое – это объект *self* для методов; для функций модуля это объект модуля. Второй параметр (часто называемый *args*) – это объект-кортеж, представляющий все аргументы. Этот параметр обычно обрабатывается с помощью [`PyArg_ParseTuple()`](https://python-all.ru/3/c-api/arg.html#c.PyArg_ParseTuple) или [`PyArg_UnpackTuple()`](https://python-all.ru/3/c-api/arg.html#c.PyArg_UnpackTuple).274275#### `METH_KEYWORDS`276277Может использоваться только в определённых комбинациях с другими флагами: [METH\_VARARGS | METH\_KEYWORDS](https://python-all.ru/3/c-api/structures.html#meth-varargs-meth-keywords), [METH\_FASTCALL | METH\_KEYWORDS](https://python-all.ru/3/c-api/structures.html#meth-fastcall-meth-keywords) и [METH\_METHOD | METH\_FASTCALL | METH\_KEYWORDS](https://python-all.ru/3/c-api/structures.html#meth-method-meth-fastcall-meth-keywords).278279**[METH\_VARARGS](https://python-all.ru/3/c-api/structures.html#c.METH_VARARGS) | [METH\_KEYWORDS](https://python-all.ru/3/c-api/structures.html#c.METH_KEYWORDS)**280281Методы с этими флагами должны быть типа [`PyCFunctionWithKeywords`](https://python-all.ru/3/c-api/structures.html#c.PyCFunctionWithKeywords). Функция ожидает три параметра: *self*, *args*, *kwargs*, где *kwargs* – это словарь всех именованных аргументов или `NULL`, если именованных аргументов нет. Параметры обычно обрабатываются с помощью [`PyArg_ParseTupleAndKeywords()`](https://python-all.ru/3/c-api/arg.html#c.PyArg_ParseTupleAndKeywords).282283#### `METH_FASTCALL`284285*Часть [Stable ABI](https://python-all.ru/3/c-api/stable.html#stable) начиная с версии 3.10.*286287Быстрое соглашение о вызове, поддерживающее только позиционные аргументы. Методы имеют тип [`PyCFunctionFast`](https://python-all.ru/3/c-api/structures.html#c.PyCFunctionFast). Первый параметр – *self*, второй параметр – массив C из значений [PyObject](https://python-all.ru/3/c-api/structures.html#c.PyObject)\*, указывающих аргументы, а третий параметр – количество аргументов (длина массива).288289Добавлено в версии 3.7.290291Изменено в версии 3.10: `METH_FASTCALL` теперь является частью [стабильного ABI](https://python-all.ru/3/c-api/stable.html#stable-abi).292293**[METH\_FASTCALL](https://python-all.ru/3/c-api/structures.html#c.METH_FASTCALL) | [METH\_KEYWORDS](https://python-all.ru/3/c-api/structures.html#c.METH_KEYWORDS)**294295Расширение [`METH_FASTCALL`](https://python-all.ru/3/c-api/structures.html#c.METH_FASTCALL), также поддерживающее именованные аргументы, с методами типа [`PyCFunctionFastWithKeywords`](https://python-all.ru/3/c-api/structures.html#c.PyCFunctionFastWithKeywords). Именованные аргументы передаются так же, как в [протоколе vectorcall](https://python-all.ru/3/c-api/call.html#vectorcall): добавляется четвёртый параметр [PyObject](https://python-all.ru/3/c-api/structures.html#c.PyObject)\*, который является кортежем, представляющим имена именованных аргументов (гарантированно строки) или `NULL`, если ключевых слов нет. Значения именованных аргументов хранятся в массиве *args* после позиционных аргументов.296297Добавлено в версии 3.7.298299#### `METH_METHOD`300301*Часть [Stable ABI](https://python-all.ru/3/c-api/stable.html#stable) начиная с версии 3.7.*302303Может использоваться только в комбинации с другими флагами: [METH\_METHOD | METH\_FASTCALL | METH\_KEYWORDS](https://python-all.ru/3/c-api/structures.html#meth-method-meth-fastcall-meth-keywords).304305**[METH\_METHOD](https://python-all.ru/3/c-api/structures.html#c.METH_METHOD) | [METH\_FASTCALL](https://python-all.ru/3/c-api/structures.html#c.METH_FASTCALL) | [METH\_KEYWORDS](https://python-all.ru/3/c-api/structures.html#c.METH_KEYWORDS)**306307Расширение [METH\_FASTCALL | METH\_KEYWORDS](https://python-all.ru/3/c-api/structures.html#meth-fastcall-meth-keywords), поддерживающее *определяющий класс*, то есть класс, который содержит данный метод. Определяющий класс может быть суперклассом `Py_TYPE(self)`.308309Метод должен быть типа [`PyCMethod`](https://python-all.ru/3/c-api/structures.html#c.PyCMethod), как и для `METH_FASTCALL | METH_KEYWORDS` с добавленным аргументом `defining_class` после `self`.310311Добавлено в версии 3.9.312313#### `METH_NOARGS`314315*Часть [Stable ABI](https://python-all.ru/3/c-api/stable.html#stable).*316317Методы без параметров не должны проверять, переданы ли аргументы, если они перечислены с флагом [`METH_NOARGS`](https://python-all.ru/3/c-api/structures.html#c.METH_NOARGS). Они должны быть типа [`PyCFunction`](https://python-all.ru/3/c-api/structures.html#c.PyCFunction). Первый параметр обычно называется *self* и будет содержать ссылку на модуль или экземпляр объекта. Во всех случаях второй параметр будет `NULL`.318319Функция должна иметь 2 параметра. Поскольку второй параметр не используется, [`Py_UNUSED`](https://python-all.ru/3/c-api/intro.html#c.Py_UNUSED) можно использовать для предотвращения предупреждения компилятора.320321#### `METH_O`322323*Часть [Stable ABI](https://python-all.ru/3/c-api/stable.html#stable).*324325Методы с одним объектным аргументом могут быть перечислены с флагом [`METH_O`](https://python-all.ru/3/c-api/structures.html#c.METH_O) вместо вызова [`PyArg_ParseTuple()`](https://python-all.ru/3/c-api/arg.html#c.PyArg_ParseTuple) с аргументом `"O"`. Они имеют тип [`PyCFunction`](https://python-all.ru/3/c-api/structures.html#c.PyCFunction), с параметром *self* и параметром [PyObject](https://python-all.ru/3/c-api/structures.html#c.PyObject)\*, представляющим единственный аргумент.326327Эти две константы используются не для указания соглашения о вызове, а для привязки при использовании с методами классов. Они не могут использоваться для функций, определённых для модулей. Для любого заданного метода может быть установлен не более одного из этих флагов.328329#### `METH_CLASS`330331*Часть [Stable ABI](https://python-all.ru/3/c-api/stable.html#stable).*332333Метод получит объект типа в качестве первого параметра, а не экземпляр типа. Это используется для создания *методов класса*, аналогично тому, что создаётся при использовании [`classmethod()`](https://python-all.ru/3/library/functions.html#classmethod) встроенной функции.334335#### `METH_STATIC`336337*Часть [Stable ABI](https://python-all.ru/3/c-api/stable.html#stable).*338339Метод получит `NULL` в качестве первого параметра, а не экземпляр типа. Это используется для создания *статических методов*, аналогично тому, что создаётся при использовании встроенной функции [`staticmethod()`](https://python-all.ru/3/library/functions.html#staticmethod).340341Ещё одна константа управляет тем, загружается ли метод вместо другого определения с тем же именем метода.342343#### `METH_COEXIST`344345*Часть [Stable ABI](https://python-all.ru/3/c-api/stable.html#stable).*346347Метод будет загружен вместо существующих определений. Без *METH\_COEXIST* по умолчанию повторяющиеся определения пропускаются. Поскольку обёртки слотов загружаются до таблицы методов, наличие слота *sq\_contains*, например, приведёт к созданию обёрнутого метода с именем [`__contains__()`](https://python-all.ru/3/reference/datamodel.html#object.__contains__) и предотвратит загрузку соответствующего PyCFunction с тем же именем. При установленном флаге PyCFunction будет загружен вместо объекта-обёртки и будет сосуществовать со слотом. Это полезно, поскольку вызовы PyCFunctions оптимизированы лучше, чем вызовы объектов-обёрток.348349#### `PyTypeObject PyCMethod_Type`350351Объект типа, соответствующий объектам методов C Python. Доступен как [`types.BuiltinMethodType`](https://python-all.ru/3/library/types.html#types.BuiltinMethodType) в слое Python.352353#### `int PyCMethod_Check(PyObject *op)`354355Возвращает true, если *op* является экземпляром типа [`PyCMethod_Type`](https://python-all.ru/3/c-api/structures.html#c.PyCMethod_Type) или его подтипом. Эта функция всегда выполняется успешно.356357#### `int PyCMethod_CheckExact(PyObject *op)`358359То же, что и [`PyCMethod_Check()`](https://python-all.ru/3/c-api/structures.html#c.PyCMethod_Check), но не учитывает подтипы.360361#### `PyObject *PyCMethod_New(PyMethodDef *ml, PyObject *self, PyObject *module, PyTypeObject *cls)`362363*Возвращаемое значение: новая ссылка.*364365*Часть [Stable ABI](https://python-all.ru/3/c-api/stable.html#stable) с версии 3.9.*366367Преобразует *ml* в Python-объект [вызываемый](https://python-all.ru/3/glossary.html#term-callable). Вызывающий код должен гарантировать, что *ml* переживёт вызываемый объект. Обычно *ml* определяется как статическая переменная.368369Параметр *self* будет передан как аргумент *self* в C-функцию из `ml->ml_meth` при вызове. *self* может быть `NULL`.370371Атрибут `__module__` объекта [callable](https://python-all.ru/3/glossary.html#term-callable) можно задать из аргумента *module*. *module* должна быть строкой Python, которая будет использоваться как имя модуля, в котором определена функция. Если это недоступно, можно задать [`None`](https://python-all.ru/3/library/constants.html#None) или `NULL`.372373> **См. также**374>375> [`function.__module__`](https://python-all.ru/3/reference/datamodel.html#function.__module__)376377Параметр *cls* будет передан как аргумент *defining\_class* в C-функцию. Должен быть задан, если [`METH_METHOD`](https://python-all.ru/3/c-api/structures.html#c.METH_METHOD) установлен на `ml->ml_flags`.378379Добавлено в версии 3.9.380381#### `PyTypeObject PyCFunction_Type`382383*Часть [Stable ABI](https://python-all.ru/3/c-api/stable.html#stable).*384385Объект типа, соответствующий объектам C-функций Python. Доступен как [`types.BuiltinFunctionType`](https://python-all.ru/3/library/types.html#types.BuiltinFunctionType) на уровне Python.386387#### `int PyCFunction_Check(PyObject *op)`388389Возвращает true, если *op* является экземпляром типа [`PyCFunction_Type`](https://python-all.ru/3/c-api/structures.html#c.PyCFunction_Type) или его подтипом. Эта функция всегда выполняется успешно.390391#### `int PyCFunction_CheckExact(PyObject *op)`392393То же, что и [`PyCFunction_Check()`](https://python-all.ru/3/c-api/structures.html#c.PyCFunction_Check), но не учитывает подтипы.394395#### `PyObject *PyCFunction_NewEx(PyMethodDef *ml, PyObject *self, PyObject *module)`396397*Возвращаемое значение: новая ссылка.*398399*Часть [Stable ABI](https://python-all.ru/3/c-api/stable.html#stable).*400401Эквивалентно `PyCMethod_New(ml, self, module, NULL)`.402403#### `PyObject *PyCFunction_New(PyMethodDef *ml, PyObject *self)`404405*Возвращаемое значение: новая ссылка.*406407*Часть [Stable ABI](https://python-all.ru/3/c-api/stable.html#stable) с версии 3.4.*408409Эквивалентно `PyCMethod_New(ml, self, NULL, NULL)`.410411#### `int PyCFunction_GetFlags(PyObject *func)`412413*Часть [Stable ABI](https://python-all.ru/3/c-api/stable.html#stable).*414415Получает флаги функции для *func*, переданные в [`ml_flags`](https://python-all.ru/3/c-api/structures.html#c.PyMethodDef.ml_flags).416417Если *func* не является объектом C-функции, возникает исключение. *func* не должен быть `NULL`.418419Эта функция возвращает флаги функции в случае успеха и `-1` с установленным исключением в случае неудачи.420421#### `int PyCFunction_GET_FLAGS(PyObject *func)`422423То же, что и [`PyCFunction_GetFlags()`](https://python-all.ru/3/c-api/structures.html#c.PyCFunction_GetFlags), но без проверки ошибок или типа.424425#### `PyCFunction PyCFunction_GetFunction(PyObject *func)`426427*Часть [Stable ABI](https://python-all.ru/3/c-api/stable.html#stable).*428429Получает указатель на функцию для *func*, переданный в [`ml_meth`](https://python-all.ru/3/c-api/structures.html#c.PyMethodDef.ml_meth).430431Если *func* не является объектом C-функции, возникает исключение. *func* не должен быть `NULL`.432433Эта функция возвращает указатель на функцию в случае успеха и `NULL` с установленным исключением в случае неудачи.434435#### `int PyCFunction_GET_FUNCTION(PyObject *func)`436437То же, что и [`PyCFunction_GetFunction()`](https://python-all.ru/3/c-api/structures.html#c.PyCFunction_GetFunction), но без проверки ошибок или типа.438439#### `PyObject *PyCFunction_GetSelf(PyObject *func)`440441*Часть [Stable ABI](https://python-all.ru/3/c-api/stable.html#stable).*442443Получает объект «self» для *func*. Это объект, который будет передан первым аргументом [`PyCFunction`](https://python-all.ru/3/c-api/structures.html#c.PyCFunction). Для объектов C-функций, созданных через [`PyMethodDef`](https://python-all.ru/3/c-api/structures.html#c.PyMethodDef) на [`PyModuleDef`](https://python-all.ru/3/c-api/module.html#c.PyModuleDef), это результирующий объект модуля.444445Если *func* не является объектом C-функции, возникает исключение. *func* не должен быть `NULL`.446447Эта функция возвращает [заимствованную ссылку](https://python-all.ru/3/glossary.html#term-borrowed-reference) на объект «self» в случае успеха и `NULL` с установленным исключением в случае неудачи.448449#### `PyObject *PyCFunction_GET_SELF(PyObject *func)`450451То же, что и [`PyCFunction_GetSelf()`](https://python-all.ru/3/c-api/structures.html#c.PyCFunction_GetSelf), но без проверки ошибок или типа.452453## Доступ к атрибутам типов расширений454455#### `type PyMemberDef`456457*Часть [Stable ABI](https://python-all.ru/3/c-api/stable.html#stable) (включая все члены).*458459Структура, описывающая атрибут типа, соответствующий элементу структуры C. При определении класса поместите массив таких структур, завершающийся NULL, в слот [`tp_members`](https://python-all.ru/3/c-api/typeobj.html#c.PyTypeObject.tp_members).460461Его поля, по порядку:462463#### `const char *name`464465Имя элемента. Значение NULL обозначает конец массива `PyMemberDef[]`.466467Строка должна быть статической, её копия не создаётся.468469#### `int type`470471Тип элемента в структуре C. См. [типы элементов](https://python-all.ru/3/c-api/structures.html#pymemberdef-types) для возможных значений.472473#### `Py_ssize_t offset`474475Смещение в байтах, по которому элемент находится в структуре объекта типа.476477#### `int flags`478479Ноль или более [флагов элементов](https://python-all.ru/3/c-api/structures.html#pymemberdef-flags), объединённых с помощью побитового ИЛИ.480481#### `const char *doc`482483Строка документации (docstring) или NULL. Строка должна быть статической, её копия не создаётся. Обычно она определяется с помощью [`PyDoc_STR`](https://python-all.ru/3/c-api/intro.html#c.PyDoc_STR).484485По умолчанию (когда [`flags`](https://python-all.ru/3/c-api/structures.html#c.PyMemberDef.flags) равно `0`) элементы допускают как чтение, так и запись. Используйте флаг [`Py_READONLY`](https://python-all.ru/3/c-api/structures.html#c.Py_READONLY) для доступа только на чтение. Некоторые типы, например [`Py_T_STRING`](https://python-all.ru/3/c-api/structures.html#c.Py_T_STRING), подразумевают `Py_READONLY`. Только элементы [`Py_T_OBJECT_EX`](https://python-all.ru/3/c-api/structures.html#c.Py_T_OBJECT_EX) (и устаревшие [`T_OBJECT`](https://python-all.ru/3/c-api/structures.html#c.T_OBJECT)) могут быть удалены.486487Для типов, выделяемых в куче (созданных с помощью [`PyType_FromSpec()`](https://python-all.ru/3/c-api/type.html#c.PyType_FromSpec) или аналогично), `PyMemberDef` может содержать определение специального элемента `"__vectorcalloffset__"`, соответствующего [`tp_vectorcall_offset`](https://python-all.ru/3/c-api/typeobj.html#c.PyTypeObject.tp_vectorcall_offset) в объектах типа. Этот элемент должен быть определён с `Py_T_PYSSIZET` и либо `Py_READONLY`, либо `Py_READONLY | Py_RELATIVE_OFFSET`. Например:488489```c490static PyMemberDef spam_type_members[] = {491    {"__vectorcalloffset__", Py_T_PYSSIZET,492     offsetof(Spam_object, vectorcall), Py_READONLY},493    {NULL}  /* Страж */494};495```496497(Возможно, потребуется `#include <stddef.h>` для `offsetof()`.)498499Устаревшие смещения [`tp_dictoffset`](https://python-all.ru/3/c-api/typeobj.html#c.PyTypeObject.tp_dictoffset) и [`tp_weaklistoffset`](https://python-all.ru/3/c-api/typeobj.html#c.PyTypeObject.tp_weaklistoffset) можно определить аналогично, используя элементы `"__dictoffset__"` и `"__weaklistoffset__"`, однако расширениям настоятельно рекомендуется использовать [`Py_TPFLAGS_MANAGED_DICT`](https://python-all.ru/3/c-api/typeobj.html#c.Py_TPFLAGS_MANAGED_DICT) и [`Py_TPFLAGS_MANAGED_WEAKREF`](https://python-all.ru/3/c-api/typeobj.html#c.Py_TPFLAGS_MANAGED_WEAKREF) вместо них.500501Изменено в версии 3.12: `PyMemberDef` всегда доступен. Ранее требовалось включение `"structmember.h"`.502503Изменено в версии 3.14: [`Py_RELATIVE_OFFSET`](https://python-all.ru/3/c-api/structures.html#c.Py_RELATIVE_OFFSET) теперь разрешён для `"__vectorcalloffset__"`, `"__dictoffset__"` и `"__weaklistoffset__"`.504505#### `PyObject *PyMember_GetOne(const char *obj_addr, struct PyMemberDef *m)`506507*Часть [Stable ABI](https://python-all.ru/3/c-api/stable.html#stable).*508509Получает атрибут, принадлежащий объекту по адресу *obj\_addr*. Атрибут описывается с помощью `PyMemberDef` *m*. Возвращает `NULL` при ошибке.510511Изменено в версии 3.12: `PyMember_GetOne` всегда доступен. Ранее требовалось включение `"structmember.h"`.512513#### `int PyMember_SetOne(char *obj_addr, struct PyMemberDef *m, PyObject *o)`514515*Часть [Stable ABI](https://python-all.ru/3/c-api/stable.html#stable).*516517Устанавливает атрибут, принадлежащий объекту по адресу *obj\_addr*, в значение объекта *o*. Устанавливаемый атрибут описывается с помощью `PyMemberDef` *m*. Возвращает `0` в случае успеха и отрицательное значение при ошибке.518519Изменено в версии 3.12: `PyMember_SetOne` всегда доступен. Ранее требовалось включение `"structmember.h"`.520521### Флаги элементов522523Следующие флаги могут использоваться с [`PyMemberDef.flags`](https://python-all.ru/3/c-api/structures.html#c.PyMemberDef.flags):524525#### `Py_READONLY`526527*Часть [Stable ABI](https://python-all.ru/3/c-api/stable.html#stable) начиная с версии 3.12.*528529Не доступен для записи.530531#### `Py_AUDIT_READ`532533*Часть [Stable ABI](https://python-all.ru/3/c-api/stable.html#stable) начиная с версии 3.12.*534535Отправляет `object.__getattr__` [событие аудита](https://python-all.ru/3/library/audit_events.html#audit-events) перед чтением.536537#### `Py_RELATIVE_OFFSET`538539*Часть [Stable ABI](https://python-all.ru/3/c-api/stable.html#stable) начиная с версии 3.12.*540541Указывает, что [`offset`](https://python-all.ru/3/c-api/structures.html#c.PyMemberDef.offset) этой `PyMemberDef` записи является смещением от данных, специфичных для подкласса, а не от `PyObject`.542543Может использоваться только как часть [`Py_tp_members`](https://python-all.ru/3/c-api/typeobj.html#c.Py_tp_members) [`slot`](https://python-all.ru/3/c-api/type.html#c.PyType_Slot) при создании класса с использованием отрицательных [`basicsize`](https://python-all.ru/3/c-api/type.html#c.PyType_Spec.basicsize). В этом случае это обязательно. При установке [`tp_members`](https://python-all.ru/3/c-api/typeobj.html#c.PyTypeObject.tp_members) из слота во время создания класса Python сбрасывает флаг и устанавливает [`PyMemberDef.offset`](https://python-all.ru/3/c-api/structures.html#c.PyMemberDef.offset) в смещение от структуры `PyObject`.544545Изменено в версии 3.10: Макросы `RESTRICTED`, `READ_RESTRICTED` и `WRITE_RESTRICTED`, доступные с `#include "structmember.h"`, устарели. `READ_RESTRICTED` и `RESTRICTED` эквивалентны [`Py_AUDIT_READ`](https://python-all.ru/3/c-api/structures.html#c.Py_AUDIT_READ); `WRITE_RESTRICTED` ничего не делает.546547Изменено в версии 3.12: Макрос `READONLY` был переименован в [`Py_READONLY`](https://python-all.ru/3/c-api/structures.html#c.Py_READONLY). Макрос `PY_AUDIT_READ` был переименован с префиксом `Py_`. Новые имена теперь всегда доступны. Ранее для них требовался `#include "structmember.h"`. Заголовочный файл всё ещё доступен и содержит старые имена.548549### Типы членов550551[`PyMemberDef.type`](https://python-all.ru/3/c-api/structures.html#c.PyMemberDef.type) может быть одним из следующих макросов, соответствующих различным типам C. Когда поле доступно из Python, оно преобразуется в эквивалентный тип Python. Когда оно устанавливается из Python, оно преобразуется обратно в тип C. Если это невозможно, возникает исключение, такое как [`TypeError`](https://python-all.ru/3/library/exceptions.html#TypeError) или [`ValueError`](https://python-all.ru/3/library/exceptions.html#ValueError).552553Если не помечено (D), атрибуты, определённые таким образом, нельзя удалить с помощью, например, [`del`](https://python-all.ru/3/reference/simple_stmts.html#del) или [`delattr()`](https://python-all.ru/3/library/functions.html#delattr).554555| Имя макроса | Тип C | Тип Python |556| --- | --- | --- |557| Py\_T\_BYTE *Часть [Stable ABI](https://python-all.ru/3/c-api/stable.html#stable) начиная с версии 3.12.* | char | [`int`](https://python-all.ru/3/library/functions.html#int) |558| Py\_T\_SHORT *Часть [Stable ABI](https://python-all.ru/3/c-api/stable.html#stable) начиная с версии 3.12.* | short | [`int`](https://python-all.ru/3/library/functions.html#int) |559| Py\_T\_INT *Часть [Stable ABI](https://python-all.ru/3/c-api/stable.html#stable) начиная с версии 3.12.* | int | [`int`](https://python-all.ru/3/library/functions.html#int) |560| Py\_T\_LONG *Часть [Stable ABI](https://python-all.ru/3/c-api/stable.html#stable) начиная с версии 3.12.* | long | [`int`](https://python-all.ru/3/library/functions.html#int) |561| Py\_T\_LONGLONG *Часть [Stable ABI](https://python-all.ru/3/c-api/stable.html#stable) начиная с версии 3.12.* | long long | [`int`](https://python-all.ru/3/library/functions.html#int) |562| Py\_T\_UBYTE *Часть [Stable ABI](https://python-all.ru/3/c-api/stable.html#stable) начиная с версии 3.12.* | unsigned char | [`int`](https://python-all.ru/3/library/functions.html#int) |563| Py\_T\_UINT *Часть [Stable ABI](https://python-all.ru/3/c-api/stable.html#stable) начиная с версии 3.12.* | unsigned int | [`int`](https://python-all.ru/3/library/functions.html#int) |564| Py\_T\_USHORT *Часть [Stable ABI](https://python-all.ru/3/c-api/stable.html#stable) начиная с версии 3.12.* | unsigned short | [`int`](https://python-all.ru/3/library/functions.html#int) |565| Py\_T\_ULONG *Часть [Stable ABI](https://python-all.ru/3/c-api/stable.html#stable) начиная с версии 3.12.* | unsigned long | [`int`](https://python-all.ru/3/library/functions.html#int) |566| Py\_T\_ULONGLONG *Часть [Stable ABI](https://python-all.ru/3/c-api/stable.html#stable) начиная с версии 3.12.* | unsigned long long | [`int`](https://python-all.ru/3/library/functions.html#int) |567| Py\_T\_PYSSIZET *Часть [Stable ABI](https://python-all.ru/3/c-api/stable.html#stable) начиная с версии 3.12.* | [Py\_ssize\_t](https://python-all.ru/3/c-api/intro.html#c.Py_ssize_t) | [`int`](https://python-all.ru/3/library/functions.html#int) |568| Py\_T\_FLOAT *Часть [Stable ABI](https://python-all.ru/3/c-api/stable.html#stable) начиная с версии 3.12.* | float | [`float`](https://python-all.ru/3/library/functions.html#float) |569| Py\_T\_DOUBLE *Часть [Stable ABI](https://python-all.ru/3/c-api/stable.html#stable) начиная с версии 3.12.* | double | [`float`](https://python-all.ru/3/library/functions.html#float) |570| Py\_T\_BOOL *Часть [Stable ABI](https://python-all.ru/3/c-api/stable.html#stable) начиная с версии 3.12.* | char (записывается как 0 или 1) | [`bool`](https://python-all.ru/3/library/functions.html#bool) |571| Py\_T\_STRING *Часть [Stable ABI](https://python-all.ru/3/c-api/stable.html#stable) начиная с версии 3.12.* | const char\* (\*) | [`str`](https://python-all.ru/3/library/stdtypes.html#str) (RO) |572| Py\_T\_STRING\_INPLACE *Часть [Stable ABI](https://python-all.ru/3/c-api/stable.html#stable) начиная с версии 3.12.* | const char\[\] (\*) | [`str`](https://python-all.ru/3/library/stdtypes.html#str) (только для чтения) |573| Py\_T\_CHAR *Часть [Stable ABI](https://python-all.ru/3/c-api/stable.html#stable) начиная с версии 3.12.* | char (0-127) | [`str`](https://python-all.ru/3/library/stdtypes.html#str) (\*\*) |574| Py\_T\_OBJECT\_EX *Часть [Stable ABI](https://python-all.ru/3/c-api/stable.html#stable) начиная с версии 3.12.* | [PyObject](https://python-all.ru/3/c-api/structures.html#c.PyObject)\* | [`object`](https://python-all.ru/3/library/functions.html#object) (по умолчанию) |575576> (\*): Нуль-терминированная строка C в кодировке UTF-8. С `Py_T_STRING` представление в C – указатель; с `Py_T_STRING_INPLACE` строка хранится непосредственно в структуре.577>578> (\*\*): Строка длиной 1. Допустимы только символы ASCII.579>580> (RO): Подразумевает [`Py_READONLY`](https://python-all.ru/3/c-api/structures.html#c.Py_READONLY).581>582> (D): Может быть удалено, в этом случае указатель устанавливается в `NULL`. Чтение указателя `NULL` возбуждает [`AttributeError`](https://python-all.ru/3/library/exceptions.html#AttributeError).583584Добавлено в версии 3.12: В предыдущих версиях макросы были доступны только с `#include "structmember.h"` и назывались без префикса `Py_` (например, `T_INT`). Заголовочный файл по-прежнему доступен и содержит старые имена, а также следующие устаревшие типы:585586#### `T_OBJECT`587588Как `Py_T_OBJECT_EX`, но `NULL` преобразуется в `None`. Это приводит к неожиданному поведению в Python: удаление атрибута фактически устанавливает его в `None`.589590#### `T_NONE`591592Всегда `None`. Должен использоваться с [`Py_READONLY`](https://python-all.ru/3/c-api/structures.html#c.Py_READONLY).593594### Определение геттеров и сеттеров595596#### `type PyGetSetDef`597598*Часть [Stable ABI](https://python-all.ru/3/c-api/stable.html#stable) (включая все члены).*599600Структура для определения доступа по типу свойства для типа. См. также описание слота [`PyTypeObject.tp_getset`](https://python-all.ru/3/c-api/typeobj.html#c.PyTypeObject.tp_getset).601602#### `const char *name`603604имя атрибута605606#### `getter get`607608C-функция для получения атрибута.609610#### `setter set`611612Необязательная C-функция для установки или удаления атрибута. Если `NULL`, атрибут доступен только для чтения.613614#### `const char *doc`615616необязательная строка документации617618#### `void *closure`619620Необязательный указатель на пользовательские данные, предоставляющий дополнительные данные для getter и setter.621622#### `typedef PyObject *(*getter)(PyObject*, void*)`623624*Часть [Stable ABI](https://python-all.ru/3/c-api/stable.html#stable).*625626Функция `get` принимает один параметр [PyObject](https://python-all.ru/3/c-api/structures.html#c.PyObject)\* (экземпляр) и указатель на пользовательские данные (связанный `closure`):627628В случае успеха должна возвращать новую ссылку или `NULL` с установленным исключением в случае неудачи.629630#### `typedef int (*setter)(PyObject*, PyObject*, void*)`631632*Часть [Stable ABI](https://python-all.ru/3/c-api/stable.html#stable).*633634Функции `set` принимают два параметра [PyObject](https://python-all.ru/3/c-api/structures.html#c.PyObject)\* (экземпляр и устанавливаемое значение) и указатель на пользовательские данные (связанный `closure`):635636Если атрибут должен быть удален, второй параметр равен `NULL`. В случае успеха должна возвращать `0` или `-1` с установленным исключением в случае неудачи.637