`object.md`

294 строк · 26.7 КБ · обычная страница · сырой текст · скачать
1> **Источник:** https://python-all.ru/3.10/c-api/object.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# Протокол объектов89#### `PyObject *Py_NotImplemented`1011Синглтон `NotImplemented`, используемый для указания, что операция не реализована для данной комбинации типов.1213#### `Py_RETURN_NOTIMPLEMENTED`1415Правильно обрабатывает возврат [`Py_NotImplemented`](https://python-all.ru/3.10/c-api/object.html#c.Py_NotImplemented) из C-функции (то есть создаёт новую [сильную ссылку](https://python-all.ru/3.10/glossary.html#term-strong-reference) на 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.10/library/stdtypes.html#str) объекта вместо [`repr()`](https://python-all.ru/3.10/library/functions.html#repr).2021#### `int PyObject_HasAttr(PyObject *o, PyObject *attr_name)`2223*Часть [Stable ABI](https://python-all.ru/3.10/c-api/stable.html#stable).*2425Возвращает `1`, если *o* имеет атрибут *attr\_name*, и `0` в противном случае. Это эквивалентно выражению Python `hasattr(o, attr_name)`. Эта функция всегда завершается успешно.2627Обратите внимание, что исключения, возникающие при вызове методов `__getattr__()` и `__getattribute__()`, подавляются. Для получения сообщений об ошибках используйте вместо этого [`PyObject_GetAttr()`](https://python-all.ru/3.10/c-api/object.html#c.PyObject_GetAttr).2829#### `int PyObject_HasAttrString(PyObject *o, const char *attr_name)`3031*Часть [Stable ABI](https://python-all.ru/3.10/c-api/stable.html#stable).*3233Возвращает `1`, если *o* имеет атрибут *attr\_name*, и `0` в противном случае. Это эквивалентно выражению Python `hasattr(o, attr_name)`. Эта функция всегда завершается успешно.3435Обратите внимание, что исключения, возникающие при вызове методов `__getattr__()` и `__getattribute__()` и при создании временного строкового объекта, подавляются. Для получения сообщений об ошибках используйте вместо этого [`PyObject_GetAttrString()`](https://python-all.ru/3.10/c-api/object.html#c.PyObject_GetAttrString).3637#### `PyObject *PyObject_GetAttr(PyObject *o, PyObject *attr_name)`3839*Возвращаемое значение: новая ссылка.*4041*Часть [Stable ABI](https://python-all.ru/3.10/c-api/stable.html#stable).*4243Извлекает атрибут с именем *attr\_name* из объекта *o*. Возвращает значение атрибута в случае успеха или `NULL` в случае ошибки. Это эквивалентно выражению Python `o.attr_name`.4445#### `PyObject *PyObject_GetAttrString(PyObject *o, const char *attr_name)`4647*Возвращаемое значение: новая ссылка.*4849*Часть [Stable ABI](https://python-all.ru/3.10/c-api/stable.html#stable).*5051Извлекает атрибут с именем *attr\_name* из объекта *o*. Возвращает значение атрибута в случае успеха или `NULL` при неудаче. Это эквивалент выражения Python `o.attr_name`.5253#### `PyObject *PyObject_GenericGetAttr(PyObject *o, PyObject *name)`5455*Возвращаемое значение: новая ссылка.*5657*Часть [Stable ABI](https://python-all.ru/3.10/c-api/stable.html#stable).*5859Обобщённая функция получения атрибута, предназначенная для размещения в слоте `tp_getattro` объекта типа. Она ищет дескриптор в словаре классов в MRO объекта, а также атрибут в [`__dict__`](https://python-all.ru/3.10/library/stdtypes.html#object.__dict__) объекта (если он есть). Как описано в [Реализация дескрипторов](https://python-all.ru/3.10/reference/datamodel.html#descriptors), дескрипторы данных имеют приоритет над атрибутами экземпляра, а дескрипторы не данных – нет. В противном случае вызывается [`AttributeError`](https://python-all.ru/3.10/library/exceptions.html#AttributeError).6061#### `int PyObject_SetAttr(PyObject *o, PyObject *attr_name, PyObject *v)`6263*Часть [Stable ABI](https://python-all.ru/3.10/c-api/stable.html#stable).*6465Устанавливает значение атрибута с именем *attr\_name* для объекта *o* равным значению *v*. В случае ошибки возбуждает исключение и возвращает `-1`; при успехе возвращает `0`. Это эквивалент инструкции Python `o.attr_name = v`.6667Если *v* равно `NULL`, атрибут удаляется. Такое поведение устарело в пользу использования [`PyObject_DelAttr()`](https://python-all.ru/3.10/c-api/object.html#c.PyObject_DelAttr), однако в настоящее время нет планов по его удалению.6869#### `int PyObject_SetAttrString(PyObject *o, const char *attr_name, PyObject *v)`7071*Часть [Stable ABI](https://python-all.ru/3.10/c-api/stable.html#stable).*7273Устанавливает значение атрибута с именем *attr\_name* для объекта *o* равным значению *v*. В случае ошибки возбуждает исключение и возвращает `-1`; при успехе возвращает `0`. Это эквивалент инструкции Python `o.attr_name = v`.7475Если *v* равно `NULL`, атрибут удаляется, но эта возможность устарела в пользу использования [`PyObject_DelAttrString()`](https://python-all.ru/3.10/c-api/object.html#c.PyObject_DelAttrString).7677#### `int PyObject_GenericSetAttr(PyObject *o, PyObject *name, PyObject *value)`7879*Часть [Stable ABI](https://python-all.ru/3.10/c-api/stable.html#stable).*8081Универсальная функция установки и удаления атрибута, предназначенная для помещения в слот [`tp_setattro`](https://python-all.ru/3.10/c-api/typeobj.html#c.PyTypeObject.tp_setattro) объекта типа. Она ищет дескриптор данных в словаре классов в MRO объекта, и если он найден, то приоритет имеет установка или удаление атрибута в словаре экземпляра. В противном случае атрибут устанавливается или удаляется в [`__dict__`](https://python-all.ru/3.10/library/stdtypes.html#object.__dict__) объекта (если он есть). При успехе возвращается `0`, иначе возбуждается [`AttributeError`](https://python-all.ru/3.10/library/exceptions.html#AttributeError) и возвращается `-1`.8283#### `int PyObject_DelAttr(PyObject *o, PyObject *attr_name)`8485Удаляет атрибут с именем *attr\_name* у объекта *o*. При ошибке возвращает `-1`. Это эквивалент инструкции Python `del o.attr_name`.8687#### `int PyObject_DelAttrString(PyObject *o, const char *attr_name)`8889Удаляет атрибут с именем *attr\_name* у объекта *o*. При ошибке возвращает `-1`. Это эквивалент инструкции Python `del o.attr_name`.9091#### `PyObject *PyObject_GenericGetDict(PyObject *o, void *context)`9293*Возвращаемое значение: новая ссылка.*9495*Часть [Stable ABI](https://python-all.ru/3.10/c-api/stable.html#stable) начиная с версии 3.10.*9697Универсальная реализация геттера дескриптора `__dict__`. При необходимости создаёт словарь.9899Новое в версии 3.3.100101#### `int PyObject_GenericSetDict(PyObject *o, PyObject *value, void *context)`102103*Часть [Stable ABI](https://python-all.ru/3.10/c-api/stable.html#stable) начиная с версии 3.7.*104105Универсальная реализация сеттера дескриптора `__dict__`. Эта реализация не позволяет удалять словарь.106107Новое в версии 3.3.108109#### `PyObject *PyObject_RichCompare(PyObject *o1, PyObject *o2, int opid)`110111*Возвращаемое значение: новая ссылка.*112113*Часть [Stable ABI](https://python-all.ru/3.10/c-api/stable.html#stable).*114115Сравнивает значения *o1* и *o2* с помощью операции, заданной *opid*, которая должна быть одной из `Py_LT`, `Py_LE`, `Py_EQ`, `Py_NE`, `Py_GT` или `Py_GE`, соответствующих `<`, `<=`, `==`, `!=`, `>` или `>=` соответственно. Это эквивалент выражения Python `o1 op o2`, где `op` – оператор, соответствующий *opid*. При успехе возвращает результат сравнения, при ошибке – `NULL`.116117#### `int PyObject_RichCompareBool(PyObject *o1, PyObject *o2, int opid)`118119*Часть [Stable ABI](https://python-all.ru/3.10/c-api/stable.html#stable).*120121Сравнивает значения *o1* и *o2* с помощью операции, заданной в *opid*, которая должна быть одной из `Py_LT`, `Py_LE`, `Py_EQ`, `Py_NE`, `Py_GT` или `Py_GE`, соответствующих `<`, `<=`, `==`, `!=`, `>` или `>=` соответственно. Возвращает `-1` в случае ошибки, `0` если результат ложный, `1` в противном случае. Это эквивалент выражения Python `o1 op o2`, где `op` – оператор, соответствующий *opid*.122123> **Примечание**124>125> Если *o1* и *o2* – один и тот же объект, [`PyObject_RichCompareBool()`](https://python-all.ru/3.10/c-api/object.html#c.PyObject_RichCompareBool) всегда будет возвращать `1` для `Py_EQ` и `0` для `Py_NE`.126127#### `PyObject *PyObject_Format(PyObject *obj, PyObject *format_spec)`128129*Часть [Stable ABI](https://python-all.ru/3.10/c-api/stable.html#stable).*130131Форматирует *obj* с помощью *format\_spec*. Эквивалентно выражению Python `format(obj, format_spec)`.132133*format\_spec* может быть `NULL`. В этом случае вызов эквивалентен `format(obj)`. Возвращает форматированную строку в случае успеха и `NULL` при неудаче.134135#### `PyObject *PyObject_Repr(PyObject *o)`136137*Возвращаемое значение: новая ссылка.*138139*Часть [Stable ABI](https://python-all.ru/3.10/c-api/stable.html#stable).*140141Вычисляет строковое представление объекта *o*. Возвращает строковое представление в случае успеха и `NULL` при неудаче. Это эквивалент выражения Python `repr(o)`. Вызывается встроенной функцией [`repr()`](https://python-all.ru/3.10/library/functions.html#repr).142143Изменено в версии 3.4: Эта функция теперь включает отладочное утверждение, помогающее гарантировать, что она не игнорирует активное исключение без уведомления.144145#### `PyObject *PyObject_ASCII(PyObject *o)`146147*Возвращаемое значение: новая ссылка.*148149*Часть [Stable ABI](https://python-all.ru/3.10/c-api/stable.html#stable).*150151Как и [`PyObject_Repr()`](https://python-all.ru/3.10/c-api/object.html#c.PyObject_Repr), вычисляет строковое представление объекта *o*, но экранирует не-ASCII символы в строке, возвращаемой [`PyObject_Repr()`](https://python-all.ru/3.10/c-api/object.html#c.PyObject_Repr), с помощью управляющих последовательностей `\x`, `\u` или `\U`. Это создаёт строку, похожую на ту, что возвращается [`PyObject_Repr()`](https://python-all.ru/3.10/c-api/object.html#c.PyObject_Repr) в Python 2. Вызывается встроенной функцией [`ascii()`](https://python-all.ru/3.10/library/functions.html#ascii).152153#### `PyObject *PyObject_Str(PyObject *o)`154155*Возвращаемое значение: новая ссылка.*156157*Часть [Stable ABI](https://python-all.ru/3.10/c-api/stable.html#stable).*158159Вычисляет строковое представление объекта *o*. Возвращает строковое представление в случае успеха и `NULL` при неудаче. Это эквивалент выражения Python `str(o)`. Вызывается встроенной функцией [`str()`](https://python-all.ru/3.10/library/stdtypes.html#str) и, следовательно, функцией [`print()`](https://python-all.ru/3.10/library/functions.html#print).160161Изменено в версии 3.4: Эта функция теперь включает отладочное утверждение, помогающее гарантировать, что она не игнорирует активное исключение без уведомления.162163#### `PyObject *PyObject_Bytes(PyObject *o)`164165*Возвращаемое значение: новая ссылка.*166167*Часть [Stable ABI](https://python-all.ru/3.10/c-api/stable.html#stable).*168169Вычисляет байтовое представление объекта *o*. При неудаче возвращается `NULL`, а при успехе – объект bytes. Это эквивалентно выражению Python `bytes(o)`, когда *o* не является целым числом. В отличие от `bytes(o)`, возникает TypeError, когда *o* является целым числом вместо объекта bytes, инициализированного нулями.170171#### `int PyObject_IsSubclass(PyObject *derived, PyObject *cls)`172173*Часть [Stable ABI](https://python-all.ru/3.10/c-api/stable.html#stable).*174175Возвращает `1`, если класс *derived* идентичен классу *cls* или является его подклассом, иначе возвращает `0`. В случае ошибки возвращает `-1`.176177Если *cls* является кортежем, проверка будет выполняться для каждого элемента в *cls*. Результатом будет `1`, если хотя бы одна из проверок вернёт `1`, иначе `0`.178179Если у *cls* есть метод [`__subclasscheck__()`](https://python-all.ru/3.10/reference/datamodel.html#class.__subclasscheck__), он будет вызван для определения статуса подкласса, как описано в [**PEP 3119**](https://python-all.ru/3.10/c-api/object.html). В противном случае *derived* является подклассом *cls*, если он является прямым или косвенным подклассом, т.е. содержится в `cls.__mro__`.180181Обычно в качестве классов рассматриваются только объекты классов, т.е. экземпляры [`type`](https://python-all.ru/3.10/library/functions.html#type) или производного класса. Однако объекты могут переопределить это, имея атрибут `__bases__` (который должен быть кортежем базовых классов).182183#### `int PyObject_IsInstance(PyObject *inst, PyObject *cls)`184185*Часть [Stable ABI](https://python-all.ru/3.10/c-api/stable.html#stable).*186187Возвращает `1`, если *inst* является экземпляром класса *cls* или подкласса *cls*, или `0`, если нет. При ошибке возвращает `-1` и устанавливает исключение.188189Если *cls* является кортежем, проверка будет выполняться для каждого элемента в *cls*. Результатом будет `1`, если хотя бы одна из проверок вернёт `1`, иначе `0`.190191Если у *cls* есть метод [`__instancecheck__()`](https://python-all.ru/3.10/reference/datamodel.html#class.__instancecheck__), он будет вызван для определения статуса подкласса, как описано в [**PEP 3119**](https://python-all.ru/3.10/c-api/object.html). В противном случае *inst* является экземпляром *cls*, если его класс является подклассом *cls*.192193Экземпляр *inst* может переопределить то, что считается его классом, с помощью атрибута `__class__`.194195Объект *cls* может переопределить, считается ли он классом и каковы его базовые классы, с помощью атрибута `__bases__` (который должен быть кортежем базовых классов).196197#### `Py_hash_t PyObject_Hash(PyObject *o)`198199*Часть [Stable ABI](https://python-all.ru/3.10/c-api/stable.html#stable).*200201Вычисляет и возвращает хеш-значение объекта *o*. При неудаче возвращает `-1`. Это эквивалент выражения Python `hash(o)`.202203Изменено в версии 3.2: Тип возвращаемого значения теперь Py\_hash\_t. Это знаковое целое число того же размера, что и [`Py_ssize_t`](https://python-all.ru/3.10/c-api/intro.html#c.Py_ssize_t).204205#### `Py_hash_t PyObject_HashNotImplemented(PyObject *o)`206207*Часть [Stable ABI](https://python-all.ru/3.10/c-api/stable.html#stable).*208209Set a [`TypeError`](https://python-all.ru/3.10/library/exceptions.html#TypeError) indicating that `type(o)` is not [hashable](https://python-all.ru/3.10/glossary.html#term-hashable) and return `-1`. This function receives special treatment when stored in a `tp_hash` slot, allowing a type to explicitly indicate to the interpreter that it is not hashable.210211#### `int PyObject_IsTrue(PyObject *o)`212213*Часть [Stable ABI](https://python-all.ru/3.10/c-api/stable.html#stable).*214215Возвращает `1`, если объект *o* считается истинным, и `0` в противном случае. Эквивалентно выражению Python `not not o`. При неудаче возвращает `-1`.216217#### `int PyObject_Not(PyObject *o)`218219*Часть [Stable ABI](https://python-all.ru/3.10/c-api/stable.html#stable).*220221Возвращает `0`, если объект *o* считается истинным, и `1` в противном случае. Эквивалентно выражению Python `not o`. При неудаче возвращает `-1`.222223#### `PyObject *PyObject_Type(PyObject *o)`224225*Возвращаемое значение: новая ссылка.*226227*Часть [Stable ABI](https://python-all.ru/3.10/c-api/stable.html#stable).*228229Когда *o* не равен `NULL`, возвращает объект типа, соответствующего типу объекта *o*. В случае неудачи возбуждает [`SystemError`](https://python-all.ru/3.10/library/exceptions.html#SystemError) и возвращает `NULL`. Это эквивалент выражения Python `type(o)`. Эта функция создаёт новую [сильную ссылку](https://python-all.ru/3.10/glossary.html#term-strong-reference) на возвращаемое значение. Нет особого смысла использовать эту функцию вместо функции [`Py_TYPE()`](https://python-all.ru/3.10/c-api/structures.html#c.Py_TYPE), которая возвращает указатель типа `PyTypeObject*`, если только не требуется новая [сильная ссылка](https://python-all.ru/3.10/glossary.html#term-strong-reference).230231#### `int PyObject_TypeCheck(PyObject *o, PyTypeObject *type)`232233Возвращает ненулевое значение, если объект *o* имеет тип *type* или является подтипом *type*, и `0` в противном случае. Оба параметра должны быть не равны `NULL`.234235#### `Py_ssize_t PyObject_Size(PyObject *o)`236237#### `Py_ssize_t PyObject_Length(PyObject *o)`238239*Часть [Stable ABI](https://python-all.ru/3.10/c-api/stable.html#stable).*240241Возвращает длину объекта *o*. Если объект *o* предоставляет протоколы последовательности и отображения, возвращается длина последовательности. При ошибке возвращается `-1`. Эквивалентно выражению Python `len(o)`.242243#### `Py_ssize_t PyObject_LengthHint(PyObject *o, Py_ssize_t defaultvalue)`244245Возвращает оценочную длину объекта *o*. Сначала пытается вернуть его фактическую длину, затем оценку с помощью [`__length_hint__()`](https://python-all.ru/3.10/reference/datamodel.html#object.__length_hint__), и в итоге возвращает значение по умолчанию. При ошибке возвращает `-1`. Эквивалентно выражению Python `operator.length_hint(o, defaultvalue)`.246247Новое в версии 3.4.248249#### `PyObject *PyObject_GetItem(PyObject *o, PyObject *key)`250251*Возвращаемое значение: новая ссылка.*252253*Часть [Stable ABI](https://python-all.ru/3.10/c-api/stable.html#stable).*254255Возвращает элемент *o*, соответствующий объекту *key*, или `NULL` при неудаче. Эквивалентно выражению Python `o[key]`.256257#### `int PyObject_SetItem(PyObject *o, PyObject *key, PyObject *v)`258259*Часть [Stable ABI](https://python-all.ru/3.10/c-api/stable.html#stable).*260261Сопоставляет объекту *key* значение *v*. Возбуждает исключение и возвращает `-1` при неудаче; возвращает `0` в случае успеха. Эквивалентно инструкции Python `o[key] = v`. Эта функция *не* крадёт ссылку на *v*.262263#### `int PyObject_DelItem(PyObject *o, PyObject *key)`264265*Часть [Stable ABI](https://python-all.ru/3.10/c-api/stable.html#stable).*266267Удаляет сопоставление для объекта *key* из объекта *o*. Возвращает `-1` при неудаче. Эквивалентно инструкции Python `del o[key]`.268269#### `PyObject *PyObject_Dir(PyObject *o)`270271*Возвращаемое значение: новая ссылка.*272273*Часть [Stable ABI](https://python-all.ru/3.10/c-api/stable.html#stable).*274275Эквивалентно выражению Python `dir(o)`, возвращает (возможно пустой) список строк, подходящих для аргумента-объекта, или `NULL`, если произошла ошибка. Если аргумент равен `NULL`, это похоже на `dir()` в Python, возвращает имена текущих локальных переменных; в этом случае, если нет активного фрейма выполнения, возвращается `NULL`, но [`PyErr_Occurred()`](https://python-all.ru/3.10/c-api/exceptions.html#c.PyErr_Occurred) вернёт false.276277#### `PyObject *PyObject_GetIter(PyObject *o)`278279*Возвращаемое значение: новая ссылка.*280281*Часть [Stable ABI](https://python-all.ru/3.10/c-api/stable.html#stable).*282283Эквивалентно выражению Python `iter(o)`. Возвращает новый итератор для аргумента-объекта, или сам объект, если объект уже является итератором. Возбуждает [`TypeError`](https://python-all.ru/3.10/library/exceptions.html#TypeError) и возвращает `NULL`, если объект не может быть итерирован.284285#### `PyObject *PyObject_GetAIter(PyObject *o)`286287*Возвращаемое значение: новая ссылка.*288289*Часть [Stable ABI](https://python-all.ru/3.10/c-api/stable.html#stable) начиная с версии 3.10.*290291Эквивалентно выражению Python `aiter(o)`. Принимает объект `AsyncIterable` и возвращает для него `AsyncIterator`. Обычно это новый итератор, но если аргумент является `AsyncIterator`, возвращает самого себя. Возбуждает [`TypeError`](https://python-all.ru/3.10/library/exceptions.html#TypeError) и возвращает `NULL`, если объект не может быть итерирован.292293Новое в версии 3.10.294