`object.md`

250 строк · 26.9 КБ · обычная страница · сырой текст · скачать
1> **Источник:** https://python-all.ru/3.5/c-api/object.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# Протокол объектов89**[PyObject](https://python-all.ru/3.5/c-api/structures.html#c.PyObject)\* `Py_NotImplemented`**1011Синглтон `NotImplemented`, используемый для указания, что операция не реализована для данной комбинации типов.1213**`Py_RETURN_NOTIMPLEMENTED`**1415Правильно обрабатывает возврат [`Py_NotImplemented`](https://python-all.ru/3.5/c-api/object.html#c.Py_NotImplemented) из C-функции (то есть увеличивает счётчик ссылок NotImplemented и возвращает его).1617#### `int PyObject_Print(PyObject *o, FILE *fp, int flags)`1819Выводит объект *o* в файл *fp*. В случае ошибки возвращает `-1`. Аргумент flags используется для включения определённых параметров вывода. Единственный поддерживаемый в настоящее время параметр – `Py_PRINT_RAW`; если он указан, записывается [`str()`](https://python-all.ru/3.5/library/stdtypes.html#str) объекта вместо [`repr()`](https://python-all.ru/3.5/library/functions.html#repr).2021#### `int PyObject_HasAttr(PyObject *o, PyObject *attr_name)`2223Возвращает `1`, если *o* имеет атрибут *attr\_name*, и `0` в противном случае. Это эквивалентно выражению Python `hasattr(o, attr_name)`. Эта функция всегда завершается успешно.2425#### `int PyObject_HasAttrString(PyObject *o, const char *attr_name)`2627Возвращает `1`, если *o* имеет атрибут *attr\_name*, и `0` в противном случае. Это эквивалентно выражению Python `hasattr(o, attr_name)`. Эта функция всегда завершается успешно.2829#### `PyObject* PyObject_GetAttr(PyObject *o, PyObject *attr_name)`3031*Возвращаемое значение: новая ссылка.*3233Извлекает атрибут с именем *attr\_name* из объекта *o*. При успехе возвращает значение атрибута, при неудаче – *NULL*. Это эквивалент выражения Python `o.attr_name`.3435#### `PyObject* PyObject_GetAttrString(PyObject *o, const char *attr_name)`3637*Возвращаемое значение: новая ссылка.*3839Извлекает атрибут с именем *attr\_name* из объекта *o*. При успехе возвращает значение атрибута, при неудаче – *NULL*. Это эквивалент выражения Python `o.attr_name`.4041#### `PyObject* PyObject_GenericGetAttr(PyObject *o, PyObject *name)`4243Обобщённая функция получения атрибута, предназначенная для размещения в слоте `tp_getattro` объекта типа. Она ищет дескриптор в словаре классов в MRO объекта, а также атрибут в [`__dict__`](https://python-all.ru/3.5/library/stdtypes.html#object.__dict__) объекта (если он есть). Как описано в [Реализация дескрипторов](https://python-all.ru/3.5/reference/datamodel.html#descriptors), дескрипторы данных имеют приоритет над атрибутами экземпляра, а дескрипторы не данных – нет. В противном случае вызывается [`AttributeError`](https://python-all.ru/3.5/library/exceptions.html#AttributeError).4445#### `int PyObject_SetAttr(PyObject *o, PyObject *attr_name, PyObject *v)`4647Устанавливает значение атрибута с именем *attr\_name* для объекта *o* равным значению *v*. В случае ошибки возбуждает исключение и возвращает `-1`; при успехе возвращает `0`. Это эквивалент инструкции Python `o.attr_name = v`.4849Если *v* равно *NULL*, атрибут удаляется, однако эта возможность устарела в пользу использования [`PyObject_DelAttr()`](https://python-all.ru/3.5/c-api/object.html#c.PyObject_DelAttr).5051#### `int PyObject_SetAttrString(PyObject *o, const char *attr_name, PyObject *v)`5253Устанавливает значение атрибута с именем *attr\_name* для объекта *o* равным значению *v*. В случае ошибки возбуждает исключение и возвращает `-1`; при успехе возвращает `0`. Это эквивалент инструкции Python `o.attr_name = v`.5455Если *v* равно *NULL*, атрибут удаляется, однако эта возможность устарела в пользу использования [`PyObject_DelAttrString()`](https://python-all.ru/3.5/c-api/object.html#c.PyObject_DelAttrString).5657#### `int PyObject_GenericSetAttr(PyObject *o, PyObject *name, PyObject *value)`5859Универсальная функция установки и удаления атрибута, предназначенная для помещения в слот [`tp_setattro`](https://python-all.ru/3.5/c-api/typeobj.html#c.PyTypeObject.tp_setattro) объекта типа. Она ищет дескриптор данных в словаре классов в MRO объекта, и если он найден, то приоритет имеет установка или удаление атрибута в словаре экземпляра. В противном случае атрибут устанавливается или удаляется в [`__dict__`](https://python-all.ru/3.5/library/stdtypes.html#object.__dict__) объекта (если он есть). При успехе возвращается `0`, иначе возбуждается [`AttributeError`](https://python-all.ru/3.5/library/exceptions.html#AttributeError) и возвращается `-1`.6061#### `int PyObject_DelAttr(PyObject *o, PyObject *attr_name)`6263Удаляет атрибут с именем *attr\_name* у объекта *o*. При ошибке возвращает `-1`. Это эквивалент инструкции Python `del o.attr_name`.6465#### `int PyObject_DelAttrString(PyObject *o, const char *attr_name)`6667Удаляет атрибут с именем *attr\_name* у объекта *o*. При ошибке возвращает `-1`. Это эквивалент инструкции Python `del o.attr_name`.6869#### `PyObject* PyObject_GenericGetDict(PyObject *o, void *context)`7071Универсальная реализация геттера дескриптора `__dict__`. При необходимости создаёт словарь.7273Новое в версии 3.3.7475#### `int PyObject_GenericSetDict(PyObject *o, void *context)`7677Универсальная реализация сеттера дескриптора `__dict__`. Эта реализация не позволяет удалять словарь.7879Новое в версии 3.3.8081#### `PyObject* PyObject_RichCompare(PyObject *o1, PyObject *o2, int opid)`8283*Возвращаемое значение: новая ссылка.*8485Сравнивает значения *o1* и *o2* с помощью операции, заданной в *opid*, которая должна быть одной из `Py_LT`, `Py_LE`, `Py_EQ`, `Py_NE`, `Py_GT` или `Py_GE`, что соответствует `<`, `<=`, `==`, `!=`, `>` или `>=` соответственно. Это эквивалент выражения Python `o1 op o2`, где `op` – оператор, соответствующий *opid*. При успехе возвращает результат сравнения, при неудаче – *NULL*.8687#### `int PyObject_RichCompareBool(PyObject *o1, PyObject *o2, int opid)`8889Сравнивает значения *o1* и *o2* с помощью операции, заданной в *opid*, которая должна быть одной из `Py_LT`, `Py_LE`, `Py_EQ`, `Py_NE`, `Py_GT` или `Py_GE`, соответствующих `<`, `<=`, `==`, `!=`, `>` или `>=` соответственно. Возвращает `-1` в случае ошибки, `0` если результат ложный, `1` в противном случае. Это эквивалент выражения Python `o1 op o2`, где `op` – оператор, соответствующий *opid*.9091> **Примечание**92>93> Если *o1* и *o2* – один и тот же объект, [`PyObject_RichCompareBool()`](https://python-all.ru/3.5/c-api/object.html#c.PyObject_RichCompareBool) всегда будет возвращать `1` для `Py_EQ` и `0` для `Py_NE`.9495#### `PyObject* PyObject_Repr(PyObject *o)`9697*Возвращаемое значение: новая ссылка.*9899Вычисляет строковое представление объекта *o*. При успехе возвращает строковое представление, при неудаче – *NULL*. Это эквивалент выражения Python `repr(o)`. Вызывается встроенной функцией [`repr()`](https://python-all.ru/3.5/library/functions.html#repr).100101Изменено в версии 3.4: Эта функция теперь включает отладочное утверждение, помогающее гарантировать, что она не игнорирует активное исключение без уведомления.102103#### `PyObject* PyObject_ASCII(PyObject *o)`104105Как и [`PyObject_Repr()`](https://python-all.ru/3.5/c-api/object.html#c.PyObject_Repr), вычисляет строковое представление объекта *o*, но экранирует не-ASCII символы в строке, возвращаемой [`PyObject_Repr()`](https://python-all.ru/3.5/c-api/object.html#c.PyObject_Repr), с помощью управляющих последовательностей `\x`, `\u` или `\U`. Это создаёт строку, похожую на ту, что возвращается [`PyObject_Repr()`](https://python-all.ru/3.5/c-api/object.html#c.PyObject_Repr) в Python 2. Вызывается встроенной функцией [`ascii()`](https://python-all.ru/3.5/library/functions.html#ascii).106107#### `PyObject* PyObject_Str(PyObject *o)`108109*Возвращаемое значение: новая ссылка.*110111Вычисляет строковое представление объекта *o*. При успехе возвращает строковое представление, при неудаче – *NULL*. Это эквивалент выражения Python `str(o)`. Вызывается встроенной функцией [`str()`](https://python-all.ru/3.5/library/stdtypes.html#str) и, следовательно, функцией [`print()`](https://python-all.ru/3.5/library/functions.html#print).112113Изменено в версии 3.4: Эта функция теперь включает отладочное утверждение, помогающее гарантировать, что она не игнорирует активное исключение без уведомления.114115#### `PyObject* PyObject_Bytes(PyObject *o)`116117Вычисляет байтовое представление объекта *o*. При неудаче возвращается *NULL*, при успехе – объект bytes. Это эквивалент выражения Python `bytes(o)`, если *o* не является целым числом. В отличие от `bytes(o)`, при передаче целого числа *o* возбуждается TypeError вместо создания байтового объекта, инициализированного нулями.118119#### `int PyObject_IsSubclass(PyObject *derived, PyObject *cls)`120121Возвращает `1`, если класс *derived* идентичен классу *cls* или является его подклассом, иначе возвращает `0`. В случае ошибки возвращает `-1`.122123Если *cls* является кортежем, проверка будет выполняться для каждого элемента в *cls*. Результатом будет `1`, если хотя бы одна из проверок вернёт `1`, иначе `0`.124125Если у *cls* есть метод [`__subclasscheck__()`](https://python-all.ru/3.5/reference/datamodel.html#class.__subclasscheck__), он будет вызван для определения статуса подкласса, как описано в [**PEP 3119**](https://python-all.ru/3.5/c-api/object.html). В противном случае *derived* является подклассом *cls*, если он является прямым или косвенным подклассом, т.е. содержится в `cls.__mro__`.126127Обычно в качестве классов рассматриваются только объекты классов, т.е. экземпляры [`type`](https://python-all.ru/3.5/library/functions.html#type) или производного класса. Однако объекты могут переопределить это, имея атрибут `__bases__` (который должен быть кортежем базовых классов).128129#### `int PyObject_IsInstance(PyObject *inst, PyObject *cls)`130131Возвращает `1`, если *inst* является экземпляром класса *cls* или подкласса *cls*, или `0`, если нет. При ошибке возвращает `-1` и устанавливает исключение.132133Если *cls* является кортежем, проверка будет выполняться для каждого элемента в *cls*. Результатом будет `1`, если хотя бы одна из проверок вернёт `1`, иначе `0`.134135Если у *cls* есть метод [`__instancecheck__()`](https://python-all.ru/3.5/reference/datamodel.html#class.__instancecheck__), он будет вызван для определения статуса подкласса, как описано в [**PEP 3119**](https://python-all.ru/3.5/c-api/object.html). В противном случае *inst* является экземпляром *cls*, если его класс является подклассом *cls*.136137Экземпляр *inst* может переопределить то, что считается его классом, с помощью атрибута `__class__`.138139Объект *cls* может переопределить, считается ли он классом и каковы его базовые классы, с помощью атрибута `__bases__` (который должен быть кортежем базовых классов).140141#### `int PyCallable_Check(PyObject *o)`142143Определяет, является ли объект *o* вызываемым. Возвращает `1`, если объект вызываем, и `0` в противном случае. Эта функция всегда завершается успешно.144145#### `PyObject* PyObject_Call(PyObject *callable_object, PyObject *args, PyObject *kw)`146147*Возвращаемое значение: новая ссылка.*148149Вызывает вызываемый объект Python *callable\_object* с аргументами, заданными кортежем *args*, и именованными аргументами, заданными словарём *kw*. Если именованные аргументы не нужны, *kw* может быть *NULL*. *args* не должен быть *NULL*; если аргументы не нужны, используйте пустой кортеж. При успехе возвращает результат вызова, при неудаче – *NULL*. Это эквивалент выражения Python `callable_object(*args, **kw)`.150151#### `PyObject* PyObject_CallObject(PyObject *callable_object, PyObject *args)`152153*Возвращаемое значение: новая ссылка.*154155Вызывает вызываемый объект Python *callable\_object* с аргументами, заданными кортежем *args*. Если аргументы не нужны, *args* может быть *NULL*. При успехе возвращает результат вызова, при неудаче – *NULL*. Это эквивалент выражения Python `callable_object(*args)`.156157#### `PyObject* PyObject_CallFunction(PyObject *callable, const char *format, ...)`158159*Возвращаемое значение: новая ссылка.*160161Вызывает вызываемый объект Python *callable* с переменным числом аргументов C. Аргументы C описываются строкой формата в стиле [`Py_BuildValue()`](https://python-all.ru/3.5/c-api/arg.html#c.Py_BuildValue). Формат может быть *NULL*, что означает отсутствие аргументов. При успехе возвращает результат вызова, при неудаче – *NULL*. Это эквивалент выражения Python `callable(*args)`. Обратите внимание: если передаются только аргументы [`PyObject *`](https://python-all.ru/3.5/c-api/structures.html#c.PyObject), то [`PyObject_CallFunctionObjArgs()`](https://python-all.ru/3.5/c-api/object.html#c.PyObject_CallFunctionObjArgs) является более быстрой альтернативой.162163Изменено в версии 3.4: Тип *format* был изменён с `char *`.164165#### `PyObject* PyObject_CallMethod(PyObject *o, const char *method, const char *format, ...)`166167*Возвращаемое значение: новая ссылка.*168169Вызывает метод с именем *method* объекта *o* с переменным числом аргументов C. Аргументы C описываются строкой формата [`Py_BuildValue()`](https://python-all.ru/3.5/c-api/arg.html#c.Py_BuildValue), которая должна порождать кортеж. Формат может быть *NULL*, что означает отсутствие аргументов. При успехе возвращает результат вызова, при неудаче – *NULL*. Это эквивалент выражения Python `o.method(args)`. Обратите внимание: если передаются только аргументы [`PyObject *`](https://python-all.ru/3.5/c-api/structures.html#c.PyObject), то [`PyObject_CallMethodObjArgs()`](https://python-all.ru/3.5/c-api/object.html#c.PyObject_CallMethodObjArgs) является более быстрой альтернативой.170171Изменено в версии 3.4: Типы *method* и *format* были изменены с `char *`.172173#### `PyObject* PyObject_CallFunctionObjArgs(PyObject *callable, ..., NULL)`174175*Возвращаемое значение: новая ссылка.*176177Вызывает вызываемый объект Python *callable* с переменным числом аргументов [`PyObject*`](https://python-all.ru/3.5/c-api/structures.html#c.PyObject). Аргументы передаются как переменное число параметров, за которыми следует *NULL*. При успехе возвращает результат вызова, при неудаче – *NULL*.178179#### `PyObject* PyObject_CallMethodObjArgs(PyObject *o, PyObject *name, ..., NULL)`180181*Возвращаемое значение: новая ссылка.*182183Вызывает метод объекта *o*, имя которого задано как объект строки Python в *name*. Он вызывается с переменным числом аргументов [`PyObject*`](https://python-all.ru/3.5/c-api/structures.html#c.PyObject). Аргументы передаются как переменное число параметров, за которыми следует *NULL*. При успехе возвращает результат вызова, при неудаче – *NULL*.184185#### `Py_hash_t PyObject_Hash(PyObject *o)`186187Вычисляет и возвращает хеш-значение объекта *o*. При неудаче возвращает `-1`. Это эквивалент выражения Python `hash(o)`.188189Изменено в версии 3.2: Тип возвращаемого значения теперь Py\_hash\_t. Это знаковое целое того же размера, что и Py\_ssize\_t.190191#### `Py_hash_t PyObject_HashNotImplemented(PyObject *o)`192193Устанавливает [`TypeError`](https://python-all.ru/3.5/library/exceptions.html#TypeError), указывающий, что `type(o)` не хешируется, и возвращает `-1`. Эта функция получает особую обработку при сохранении в слоте `tp_hash`, позволяя типу явно указать интерпретатору, что он не хешируется.194195#### `int PyObject_IsTrue(PyObject *o)`196197Возвращает `1`, если объект *o* считается истинным, и `0` в противном случае. Эквивалентно выражению Python `not not o`. При неудаче возвращает `-1`.198199#### `int PyObject_Not(PyObject *o)`200201Возвращает `0`, если объект *o* считается истинным, и `1` в противном случае. Эквивалентно выражению Python `not o`. При неудаче возвращает `-1`.202203#### `PyObject* PyObject_Type(PyObject *o)`204205*Возвращаемое значение: новая ссылка.*206207Если *o* не равно *NULL*, возвращает объект типа, соответствующий типу объекта *o*. При неудаче возбуждает [`SystemError`](https://python-all.ru/3.5/library/exceptions.html#SystemError) и возвращает *NULL*. Это эквивалент выражения Python `type(o)`. Эта функция увеличивает счётчик ссылок возвращаемого значения. Нет особых причин использовать эту функцию вместо обычного выражения `o->ob_type`, которое возвращает указатель типа [`PyTypeObject*`](https://python-all.ru/3.5/c-api/type.html#c.PyTypeObject), за исключением случаев, когда требуется увеличенный счётчик ссылок.208209#### `int PyObject_TypeCheck(PyObject *o, PyTypeObject *type)`210211Возвращает истину, если объект *o* имеет тип *type* или является подтипом *type*. Оба параметра не должны быть *NULL*.212213#### `Py_ssize_t PyObject_Length(PyObject *o)`214215#### `Py_ssize_t PyObject_Size(PyObject *o)`216217Возвращает длину объекта *o*. Если объект *o* предоставляет протоколы последовательности и отображения, возвращается длина последовательности. При ошибке возвращается `-1`. Эквивалентно выражению Python `len(o)`.218219#### `Py_ssize_t PyObject_LengthHint(PyObject *o, Py_ssize_t default)`220221Возвращает оценочную длину объекта *o*. Сначала пытается вернуть его фактическую длину, затем оценку с помощью [`__length_hint__()`](https://python-all.ru/3.5/reference/datamodel.html#object.__length_hint__), и в итоге возвращает значение по умолчанию. При ошибке возвращает `-1`. Эквивалентно выражению Python `operator.length_hint(o, default)`.222223Новое в версии 3.4.224225#### `PyObject* PyObject_GetItem(PyObject *o, PyObject *key)`226227*Возвращаемое значение: новая ссылка.*228229Возвращает элемент *o*, соответствующий объекту *key*, или *NULL* при неудаче. Это эквивалент выражения Python `o[key]`.230231#### `int PyObject_SetItem(PyObject *o, PyObject *key, PyObject *v)`232233Отображает объект *key* на значение *v*. Возбуждает исключение и возвращает `-1` при неудаче; возвращает `0` при успехе. Это эквивалент оператора Python `o[key] = v`.234235#### `int PyObject_DelItem(PyObject *o, PyObject *key)`236237Удаляет отображение для *ключа* из *o*. В случае неудачи возвращает `-1`. Это eквивалентно оператору Python `del o[key]`.238239#### `PyObject* PyObject_Dir(PyObject *o)`240241*Возвращаемое значение: новая ссылка.*242243Это эквивалент выражения Python `dir(o)`; возвращает (возможно пустой) список строк, соответствующих аргументу-объекту, или *NULL* в случае ошибки. Если аргумент равен *NULL*, это аналогично Python `dir()`: возвращает имена текущих локальных переменных; в этом случае, если нет активного фрейма выполнения, возвращается *NULL*, но [`PyErr_Occurred()`](https://python-all.ru/3.5/c-api/exceptions.html#c.PyErr_Occurred) вернёт ложь.244245#### `PyObject* PyObject_GetIter(PyObject *o)`246247*Возвращаемое значение: новая ссылка.*248249Это эквивалент выражения Python `iter(o)`. Возвращает новый итератор для аргумента-объекта или сам объект, если он уже является итератором. Возбуждает [`TypeError`](https://python-all.ru/3.5/library/exceptions.html#TypeError) и возвращает *NULL*, если объект не может быть проитерирован.250