> **Источник:** https://python-all.ru/3.9/c-api/object.html
>
> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.

---

# Протокол объектов

**[PyObject](https://python-all.ru/3.9/c-api/structures.html#c.PyObject)\* `Py_NotImplemented`**

Синглтон `NotImplemented`, используемый для указания, что операция не реализована для данной комбинации типов.

**`Py_RETURN_NOTIMPLEMENTED`**

Правильно обрабатывает возврат [`Py_NotImplemented`](https://python-all.ru/3.9/c-api/object.html#c.Py_NotImplemented) из C-функции (то есть увеличивает счётчик ссылок NotImplemented и возвращает его).

#### `int PyObject_Print(PyObject *o, FILE *fp, int flags)`

Выводит объект *o* в файл *fp*. В случае ошибки возвращает `-1`. Аргумент flags используется для включения определённых параметров вывода. Единственный поддерживаемый в настоящее время параметр – `Py_PRINT_RAW`; если он указан, записывается [`str()`](https://python-all.ru/3.9/library/stdtypes.html#str) объекта вместо [`repr()`](https://python-all.ru/3.9/library/functions.html#repr).

#### `int PyObject_HasAttr(PyObject *o, PyObject *attr_name)`

Возвращает `1`, если *o* имеет атрибут *attr\_name*, и `0` в противном случае. Это эквивалентно выражению Python `hasattr(o, attr_name)`. Эта функция всегда завершается успешно.

Обратите внимание, что исключения, возникающие при вызове методов [`__getattr__()`](https://python-all.ru/3.9/reference/datamodel.html#object.__getattr__) и [`__getattribute__()`](https://python-all.ru/3.9/reference/datamodel.html#object.__getattribute__), подавляются. Для получения сообщений об ошибках используйте вместо этого [`PyObject_GetAttr()`](https://python-all.ru/3.9/c-api/object.html#c.PyObject_GetAttr).

#### `int PyObject_HasAttrString(PyObject *o, const char *attr_name)`

Возвращает `1`, если *o* имеет атрибут *attr\_name*, и `0` в противном случае. Это эквивалентно выражению Python `hasattr(o, attr_name)`. Эта функция всегда завершается успешно.

Обратите внимание, что исключения, возникающие при вызове методов [`__getattr__()`](https://python-all.ru/3.9/reference/datamodel.html#object.__getattr__) и [`__getattribute__()`](https://python-all.ru/3.9/reference/datamodel.html#object.__getattribute__) и при создании временного строкового объекта, подавляются. Для получения сообщений об ошибках используйте вместо этого [`PyObject_GetAttrString()`](https://python-all.ru/3.9/c-api/object.html#c.PyObject_GetAttrString).

#### `PyObject* PyObject_GetAttr(PyObject *o, PyObject *attr_name)`

*Возвращаемое значение: новая ссылка.*

Извлекает атрибут с именем *attr\_name* из объекта *o*. Возвращает значение атрибута в случае успеха или `NULL` в случае ошибки. Это эквивалентно выражению Python `o.attr_name`.

#### `PyObject* PyObject_GetAttrString(PyObject *o, const char *attr_name)`

*Возвращаемое значение: новая ссылка.*

Извлекает атрибут с именем *attr\_name* из объекта *o*. Возвращает значение атрибута в случае успеха или `NULL` при неудаче. Это эквивалент выражения Python `o.attr_name`.

#### `PyObject* PyObject_GenericGetAttr(PyObject *o, PyObject *name)`

*Возвращаемое значение: новая ссылка.*

Обобщённая функция получения атрибута, предназначенная для размещения в слоте `tp_getattro` объекта типа. Она ищет дескриптор в словаре классов в MRO объекта, а также атрибут в [`__dict__`](https://python-all.ru/3.9/library/stdtypes.html#object.__dict__) объекта (если он есть). Как описано в [Реализация дескрипторов](https://python-all.ru/3.9/reference/datamodel.html#descriptors), дескрипторы данных имеют приоритет над атрибутами экземпляра, а дескрипторы не данных – нет. В противном случае вызывается [`AttributeError`](https://python-all.ru/3.9/library/exceptions.html#AttributeError).

#### `int PyObject_SetAttr(PyObject *o, PyObject *attr_name, PyObject *v)`

Устанавливает значение атрибута с именем *attr\_name* для объекта *o* равным значению *v*. В случае ошибки возбуждает исключение и возвращает `-1`; при успехе возвращает `0`. Это эквивалент инструкции Python `o.attr_name = v`.

Если *v* равно `NULL`, атрибут удаляется. Такое поведение устарело в пользу использования [`PyObject_DelAttr()`](https://python-all.ru/3.9/c-api/object.html#c.PyObject_DelAttr), однако в настоящее время нет планов по его удалению.

#### `int PyObject_SetAttrString(PyObject *o, const char *attr_name, PyObject *v)`

Устанавливает значение атрибута с именем *attr\_name* для объекта *o* равным значению *v*. В случае ошибки возбуждает исключение и возвращает `-1`; при успехе возвращает `0`. Это эквивалент инструкции Python `o.attr_name = v`.

Если *v* равно `NULL`, атрибут удаляется, но эта возможность устарела в пользу использования [`PyObject_DelAttrString()`](https://python-all.ru/3.9/c-api/object.html#c.PyObject_DelAttrString).

#### `int PyObject_GenericSetAttr(PyObject *o, PyObject *name, PyObject *value)`

Универсальная функция установки и удаления атрибута, предназначенная для помещения в слот [`tp_setattro`](https://python-all.ru/3.9/c-api/typeobj.html#c.PyTypeObject.tp_setattro) объекта типа. Она ищет дескриптор данных в словаре классов в MRO объекта, и если он найден, то приоритет имеет установка или удаление атрибута в словаре экземпляра. В противном случае атрибут устанавливается или удаляется в [`__dict__`](https://python-all.ru/3.9/library/stdtypes.html#object.__dict__) объекта (если он есть). При успехе возвращается `0`, иначе возбуждается [`AttributeError`](https://python-all.ru/3.9/library/exceptions.html#AttributeError) и возвращается `-1`.

#### `int PyObject_DelAttr(PyObject *o, PyObject *attr_name)`

Удаляет атрибут с именем *attr\_name* у объекта *o*. При ошибке возвращает `-1`. Это эквивалент инструкции Python `del o.attr_name`.

#### `int PyObject_DelAttrString(PyObject *o, const char *attr_name)`

Удаляет атрибут с именем *attr\_name* у объекта *o*. При ошибке возвращает `-1`. Это эквивалент инструкции Python `del o.attr_name`.

#### `PyObject* PyObject_GenericGetDict(PyObject *o, void *context)`

*Возвращаемое значение: новая ссылка.*

Универсальная реализация геттера дескриптора `__dict__`. При необходимости создаёт словарь.

Новое в версии 3.3.

#### `int PyObject_GenericSetDict(PyObject *o, PyObject *value, void *context)`

Универсальная реализация сеттера дескриптора `__dict__`. Эта реализация не позволяет удалять словарь.

Новое в версии 3.3.

#### `PyObject* PyObject_RichCompare(PyObject *o1, PyObject *o2, int opid)`

*Возвращаемое значение: новая ссылка.*

Сравнивает значения *o1* и *o2* с помощью операции, заданной *opid*, которая должна быть одной из `Py_LT`, `Py_LE`, `Py_EQ`, `Py_NE`, `Py_GT` или `Py_GE`, соответствующих `<`, `<=`, `==`, `!=`, `>` или `>=` соответственно. Это эквивалент выражения Python `o1 op o2`, где `op` – оператор, соответствующий *opid*. При успехе возвращает результат сравнения, при ошибке – `NULL`.

#### `int PyObject_RichCompareBool(PyObject *o1, PyObject *o2, int opid)`

Сравнивает значения *o1* и *o2* с помощью операции, заданной в *opid*, которая должна быть одной из `Py_LT`, `Py_LE`, `Py_EQ`, `Py_NE`, `Py_GT` или `Py_GE`, соответствующих `<`, `<=`, `==`, `!=`, `>` или `>=` соответственно. Возвращает `-1` в случае ошибки, `0` если результат ложный, `1` в противном случае. Это эквивалент выражения Python `o1 op o2`, где `op` – оператор, соответствующий *opid*.

> **Примечание**
>
> Если *o1* и *o2* – один и тот же объект, [`PyObject_RichCompareBool()`](https://python-all.ru/3.9/c-api/object.html#c.PyObject_RichCompareBool) всегда будет возвращать `1` для `Py_EQ` и `0` для `Py_NE`.

#### `PyObject* PyObject_Repr(PyObject *o)`

*Возвращаемое значение: новая ссылка.*

Вычисляет строковое представление объекта *o*. Возвращает строковое представление в случае успеха и `NULL` при неудаче. Это эквивалент выражения Python `repr(o)`. Вызывается встроенной функцией [`repr()`](https://python-all.ru/3.9/library/functions.html#repr).

Изменено в версии 3.4: Эта функция теперь включает отладочное утверждение, помогающее гарантировать, что она не игнорирует активное исключение без уведомления.

#### `PyObject* PyObject_ASCII(PyObject *o)`

*Возвращаемое значение: новая ссылка.*

Как и [`PyObject_Repr()`](https://python-all.ru/3.9/c-api/object.html#c.PyObject_Repr), вычисляет строковое представление объекта *o*, но экранирует не-ASCII символы в строке, возвращаемой [`PyObject_Repr()`](https://python-all.ru/3.9/c-api/object.html#c.PyObject_Repr), с помощью управляющих последовательностей `\x`, `\u` или `\U`. Это создаёт строку, похожую на ту, что возвращается [`PyObject_Repr()`](https://python-all.ru/3.9/c-api/object.html#c.PyObject_Repr) в Python 2. Вызывается встроенной функцией [`ascii()`](https://python-all.ru/3.9/library/functions.html#ascii).

#### `PyObject* PyObject_Str(PyObject *o)`

*Возвращаемое значение: новая ссылка.*

Вычисляет строковое представление объекта *o*. Возвращает строковое представление в случае успеха и `NULL` при неудаче. Это эквивалент выражения Python `str(o)`. Вызывается встроенной функцией [`str()`](https://python-all.ru/3.9/library/stdtypes.html#str) и, следовательно, функцией [`print()`](https://python-all.ru/3.9/library/functions.html#print).

Изменено в версии 3.4: Эта функция теперь включает отладочное утверждение, помогающее гарантировать, что она не игнорирует активное исключение без уведомления.

#### `PyObject* PyObject_Bytes(PyObject *o)`

*Возвращаемое значение: новая ссылка.*

Вычисляет байтовое представление объекта *o*. При неудаче возвращается `NULL`, а при успехе – объект bytes. Это эквивалентно выражению Python `bytes(o)`, когда *o* не является целым числом. В отличие от `bytes(o)`, возникает TypeError, когда *o* является целым числом вместо объекта bytes, инициализированного нулями.

#### `int PyObject_IsSubclass(PyObject *derived, PyObject *cls)`

Возвращает `1`, если класс *derived* идентичен классу *cls* или является его подклассом, иначе возвращает `0`. В случае ошибки возвращает `-1`.

Если *cls* является кортежем, проверка будет выполняться для каждого элемента в *cls*. Результатом будет `1`, если хотя бы одна из проверок вернёт `1`, иначе `0`.

Если у *cls* есть метод [`__subclasscheck__()`](https://python-all.ru/3.9/reference/datamodel.html#class.__subclasscheck__), он будет вызван для определения статуса подкласса, как описано в [**PEP 3119**](https://python-all.ru/3.9/c-api/object.html). В противном случае *derived* является подклассом *cls*, если он является прямым или косвенным подклассом, т.е. содержится в `cls.__mro__`.

Обычно в качестве классов рассматриваются только объекты классов, т.е. экземпляры [`type`](https://python-all.ru/3.9/library/functions.html#type) или производного класса. Однако объекты могут переопределить это, имея атрибут `__bases__` (который должен быть кортежем базовых классов).

#### `int PyObject_IsInstance(PyObject *inst, PyObject *cls)`

Возвращает `1`, если *inst* является экземпляром класса *cls* или подкласса *cls*, или `0`, если нет. При ошибке возвращает `-1` и устанавливает исключение.

Если *cls* является кортежем, проверка будет выполняться для каждого элемента в *cls*. Результатом будет `1`, если хотя бы одна из проверок вернёт `1`, иначе `0`.

Если у *cls* есть метод [`__instancecheck__()`](https://python-all.ru/3.9/reference/datamodel.html#class.__instancecheck__), он будет вызван для определения статуса подкласса, как описано в [**PEP 3119**](https://python-all.ru/3.9/c-api/object.html). В противном случае *inst* является экземпляром *cls*, если его класс является подклассом *cls*.

Экземпляр *inst* может переопределить то, что считается его классом, с помощью атрибута `__class__`.

Объект *cls* может переопределить, считается ли он классом и каковы его базовые классы, с помощью атрибута `__bases__` (который должен быть кортежем базовых классов).

#### `Py_hash_t PyObject_Hash(PyObject *o)`

Вычисляет и возвращает хеш-значение объекта *o*. При неудаче возвращает `-1`. Это эквивалент выражения Python `hash(o)`.

Изменено в версии 3.2: Тип возвращаемого значения теперь Py\_hash\_t. Это знаковое целое число того же размера, что и [`Py_ssize_t`](https://python-all.ru/3.9/c-api/intro.html#c.Py_ssize_t).

#### `Py_hash_t PyObject_HashNotImplemented(PyObject *o)`

Устанавливает [`TypeError`](https://python-all.ru/3.9/library/exceptions.html#TypeError), указывающий, что `type(o)` не хешируется, и возвращает `-1`. Эта функция получает особую обработку при сохранении в слоте `tp_hash`, позволяя типу явно указать интерпретатору, что он не хешируется.

#### `int PyObject_IsTrue(PyObject *o)`

Возвращает `1`, если объект *o* считается истинным, и `0` в противном случае. Эквивалентно выражению Python `not not o`. При неудаче возвращает `-1`.

#### `int PyObject_Not(PyObject *o)`

Возвращает `0`, если объект *o* считается истинным, и `1` в противном случае. Эквивалентно выражению Python `not o`. При неудаче возвращает `-1`.

#### `PyObject* PyObject_Type(PyObject *o)`

*Возвращаемое значение: новая ссылка.*

Когда *o* не равен `NULL`, возвращает объект типа, соответствующий типу объекта *o*. В случае неудачи возбуждает [`SystemError`](https://python-all.ru/3.9/library/exceptions.html#SystemError) и возвращает `NULL`. Это эквивалентно выражению Python `type(o)`. Эта функция увеличивает счётчик ссылок возвращаемого значения. Нет особой причины использовать эту функцию вместо функции [`Py_TYPE()`](https://python-all.ru/3.9/c-api/structures.html#c.Py_TYPE), которая возвращает указатель типа [`PyTypeObject*`](https://python-all.ru/3.9/c-api/type.html#c.PyTypeObject), кроме случаев, когда требуется увеличенный счётчик ссылок.

#### `int PyObject_TypeCheck(PyObject *o, PyTypeObject *type)`

Возвращает true, если объект *o* имеет тип *type* или является подтипом *type*. Оба параметра должны быть не-`NULL`.

#### `Py_ssize_t PyObject_Size(PyObject *o)`

#### `Py_ssize_t PyObject_Length(PyObject *o)`

Возвращает длину объекта *o*. Если объект *o* предоставляет протоколы последовательности и отображения, возвращается длина последовательности. При ошибке возвращается `-1`. Эквивалентно выражению Python `len(o)`.

#### `Py_ssize_t PyObject_LengthHint(PyObject *o, Py_ssize_t defaultvalue)`

Возвращает оценочную длину объекта *o*. Сначала пытается вернуть его фактическую длину, затем оценку с помощью [`__length_hint__()`](https://python-all.ru/3.9/reference/datamodel.html#object.__length_hint__), и в итоге возвращает значение по умолчанию. При ошибке возвращает `-1`. Эквивалентно выражению Python `operator.length_hint(o, defaultvalue)`.

Новое в версии 3.4.

#### `PyObject* PyObject_GetItem(PyObject *o, PyObject *key)`

*Возвращаемое значение: новая ссылка.*

Возвращает элемент *o*, соответствующий объекту *key*, или `NULL` при неудаче. Эквивалентно выражению Python `o[key]`.

#### `int PyObject_SetItem(PyObject *o, PyObject *key, PyObject *v)`

Сопоставляет объекту *key* значение *v*. Возбуждает исключение и возвращает `-1` при неудаче; возвращает `0` в случае успеха. Эквивалентно инструкции Python `o[key] = v`. Эта функция *не* крадёт ссылку на *v*.

#### `int PyObject_DelItem(PyObject *o, PyObject *key)`

Удаляет сопоставление для объекта *key* из объекта *o*. Возвращает `-1` при неудаче. Эквивалентно инструкции Python `del o[key]`.

#### `PyObject* PyObject_Dir(PyObject *o)`

*Возвращаемое значение: новая ссылка.*

Эквивалентно выражению Python `dir(o)`, возвращает (возможно пустой) список строк, подходящих для аргумента-объекта, или `NULL`, если произошла ошибка. Если аргумент равен `NULL`, это похоже на `dir()` в Python, возвращает имена текущих локальных переменных; в этом случае, если нет активного фрейма выполнения, возвращается `NULL`, но [`PyErr_Occurred()`](https://python-all.ru/3.9/c-api/exceptions.html#c.PyErr_Occurred) вернёт false.

#### `PyObject* PyObject_GetIter(PyObject *o)`

*Возвращаемое значение: новая ссылка.*

Эквивалентно выражению Python `iter(o)`. Возвращает новый итератор для аргумента-объекта, или сам объект, если объект уже является итератором. Возбуждает [`TypeError`](https://python-all.ru/3.9/library/exceptions.html#TypeError) и возвращает `NULL`, если объект не может быть итерирован.