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

---

# Целочисленные объекты

Все целые числа реализованы как «длинные» целочисленные объекты произвольного размера.

При ошибке большинство API `PyLong_As*` возвращают `(return type)-1`, который невозможно отличить от числа. Используйте [`PyErr_Occurred()`](https://python-all.ru/3.14/c-api/exceptions.html#c.PyErr_Occurred) для устранения неоднозначности.

#### `type PyLongObject`

*Часть [Limited API](https://python-all.ru/3.14/c-api/stable.html#stable) (как непрозрачная структура).*

Этот подтип [`PyObject`](https://python-all.ru/3.14/c-api/structures.html#c.PyObject) представляет целочисленный объект Python.

#### `PyTypeObject PyLong_Type`

*Часть [Stable ABI](https://python-all.ru/3.14/c-api/stable.html#stable).*

Этот экземпляр [`PyTypeObject`](https://python-all.ru/3.14/c-api/type.html#c.PyTypeObject) представляет целочисленный тип Python. Это тот же объект, что и [`int`](https://python-all.ru/3.14/library/functions.html#int) на уровне Python.

#### `int PyLong_Check(PyObject *p)`

Возвращает истину, если аргумент является [`PyLongObject`](https://python-all.ru/3.14/c-api/long.html#c.PyLongObject) или подтипом `PyLongObject`. Эта функция всегда завершается успешно.

#### `int PyLong_CheckExact(PyObject *p)`

Возвращает истину, если аргумент является [`PyLongObject`](https://python-all.ru/3.14/c-api/long.html#c.PyLongObject), но не подтипом `PyLongObject`. Эта функция всегда завершается успешно.

#### `PyObject *PyLong_FromLong(long v)`

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

*Часть [Stable ABI](https://python-all.ru/3.14/c-api/stable.html#stable).*

Возвращает новый объект [`PyLongObject`](https://python-all.ru/3.14/c-api/long.html#c.PyLongObject) из *v* или `NULL` при ошибке.

**Деталь реализации CPython:** CPython хранит массив целочисленных объектов для всех целых чисел в диапазоне от `-5` до `256`. При создании int в этом диапазоне фактически возвращается ссылка на существующий объект.

#### `PyObject *PyLong_FromUnsignedLong(unsigned long v)`

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

*Часть [Stable ABI](https://python-all.ru/3.14/c-api/stable.html#stable).*

Возвращает новый объект [`PyLongObject`](https://python-all.ru/3.14/c-api/long.html#c.PyLongObject) из C unsigned long или `NULL` при ошибке.

#### `PyObject *PyLong_FromSsize_t(Py_ssize_t v)`

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

*Часть [Stable ABI](https://python-all.ru/3.14/c-api/stable.html#stable).*

Возвращает новый объект [`PyLongObject`](https://python-all.ru/3.14/c-api/long.html#c.PyLongObject) из C [`Py_ssize_t`](https://python-all.ru/3.14/c-api/intro.html#c.Py_ssize_t) или `NULL` при ошибке.

#### `PyObject *PyLong_FromSize_t(size_t v)`

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

*Часть [Stable ABI](https://python-all.ru/3.14/c-api/stable.html#stable).*

Возвращает новый объект [`PyLongObject`](https://python-all.ru/3.14/c-api/long.html#c.PyLongObject) из C `size_t` или `NULL` при ошибке.

#### `PyObject *PyLong_FromLongLong(long long v)`

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

*Часть [Stable ABI](https://python-all.ru/3.14/c-api/stable.html#stable).*

Возвращает новый объект [`PyLongObject`](https://python-all.ru/3.14/c-api/long.html#c.PyLongObject) из C long long или `NULL` при ошибке.

#### `PyObject *PyLong_FromUnsignedLongLong(unsigned long long v)`

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

*Часть [Stable ABI](https://python-all.ru/3.14/c-api/stable.html#stable).*

Возвращает новый объект [`PyLongObject`](https://python-all.ru/3.14/c-api/long.html#c.PyLongObject) из C unsigned long long или `NULL` при ошибке.

#### `PyObject *PyLong_FromInt32(int32_t value)`

#### `PyObject *PyLong_FromInt64(int64_t value)`

*Часть [Stable ABI](https://python-all.ru/3.14/c-api/stable.html#stable) начиная с версии 3.14.*

Возвращает новый объект [`PyLongObject`](https://python-all.ru/3.14/c-api/long.html#c.PyLongObject) из знакового C int32\_t или int64\_t, или `NULL` с установленным исключением при ошибке.

Добавлено в версии 3.14.

#### `PyObject *PyLong_FromUInt32(uint32_t value)`

#### `PyObject *PyLong_FromUInt64(uint64_t value)`

*Часть [Stable ABI](https://python-all.ru/3.14/c-api/stable.html#stable) начиная с версии 3.14.*

Возвращает новый объект [`PyLongObject`](https://python-all.ru/3.14/c-api/long.html#c.PyLongObject) из беззнакового C uint32\_t или uint64\_t, или `NULL` с установленным исключением при ошибке.

Добавлено в версии 3.14.

#### `PyObject *PyLong_FromDouble(double v)`

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

*Часть [Stable ABI](https://python-all.ru/3.14/c-api/stable.html#stable).*

Возвращает новый объект [`PyLongObject`](https://python-all.ru/3.14/c-api/long.html#c.PyLongObject) из целой части *v* или `NULL` в случае ошибки.

#### `PyObject *PyLong_FromString(const char *str, char **pend, int base)`

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

*Часть [Stable ABI](https://python-all.ru/3.14/c-api/stable.html#stable).*

Возвращает новый [`PyLongObject`](https://python-all.ru/3.14/c-api/long.html#c.PyLongObject) на основе строкового значения *str*, которое интерпретируется в соответствии с основанием *base*, или `NULL` в случае ошибки. Если *pend* не `NULL`, то *\*pend* будет указывать на конец *str* в случае успеха или на первый символ, который не удалось обработать, в случае ошибки. Если *base* равно `0`, то *str* интерпретируется в соответствии с определением [Integer literals](https://python-all.ru/3.14/reference/lexical_analysis.html#integers); в этом случае ведущие нули в ненулевом десятичном числе вызывают [`ValueError`](https://python-all.ru/3.14/library/exceptions.html#ValueError). Если *base* не равно `0`, оно должно быть между `2` и `36` включительно. Начальные и конечные пробелы, а также одиночные символы подчёркивания после спецификатора основания и между цифрами игнорируются. Если цифр нет или *str* не завершается нулевым символом после цифр и конечных пробелов, будет вызвано `ValueError`.

> **См. также**
>
> Функции [`PyLong_AsNativeBytes()`](https://python-all.ru/3.14/c-api/long.html#c.PyLong_AsNativeBytes) и [`PyLong_FromNativeBytes()`](https://python-all.ru/3.14/c-api/long.html#c.PyLong_FromNativeBytes) можно использовать для преобразования [`PyLongObject`](https://python-all.ru/3.14/c-api/long.html#c.PyLongObject) в массив байтов и обратно в системе счисления `256`.

#### `PyObject *PyLong_FromUnicodeObject(PyObject *u, int base)`

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

Преобразует последовательность цифр Unicode в строке *u* в целое число Python.

Добавлено в версии 3.3.

#### `PyObject *PyLong_FromVoidPtr(void *p)`

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

*Часть [Stable ABI](https://python-all.ru/3.14/c-api/stable.html#stable).*

Создаёт целое число Python из указателя *p*. Значение указателя можно извлечь из полученного значения с помощью [`PyLong_AsVoidPtr()`](https://python-all.ru/3.14/c-api/long.html#c.PyLong_AsVoidPtr).

#### `PyObject *PyLong_FromNativeBytes(const void *buffer, size_t n_bytes, int flags)`

*Часть [Stable ABI](https://python-all.ru/3.14/c-api/stable.html#stable) начиная с версии 3.14.*

Создаёт целое число Python из значения, содержащегося в первых *n\_bytes* буфера *buffer*, интерпретируемого как знаковое число в дополнительном коде.

*flags* – как для [`PyLong_AsNativeBytes()`](https://python-all.ru/3.14/c-api/long.html#c.PyLong_AsNativeBytes). Передача `-1` выберет нативный порядок байтов, используемый CPython, и будет считать, что старший бит является знаковым. Передача `Py_ASNATIVEBYTES_UNSIGNED_BUFFER` даёт тот же результат, что и вызов [`PyLong_FromUnsignedNativeBytes()`](https://python-all.ru/3.14/c-api/long.html#c.PyLong_FromUnsignedNativeBytes). Остальные флаги игнорируются.

Добавлено в версии 3.13.

#### `PyObject *PyLong_FromUnsignedNativeBytes(const void *buffer, size_t n_bytes, int flags)`

*Часть [Stable ABI](https://python-all.ru/3.14/c-api/stable.html#stable) начиная с версии 3.14.*

Создаёт целое число Python из значения, содержащегося в первых *n\_bytes* буфера *buffer*, интерпретируемого как беззнаковое число.

*flags* – как для [`PyLong_AsNativeBytes()`](https://python-all.ru/3.14/c-api/long.html#c.PyLong_AsNativeBytes). Передача `-1` выберет нативный порядок байтов, используемый CPython, и будет считать, что старший бит не является знаковым. Флаги, не связанные с порядком байтов, игнорируются.

Добавлено в версии 3.13.

#### `PyLong_FromPid(pid)`

Макрос для создания целого числа Python из идентификатора процесса.

Может быть определён как псевдоним [`PyLong_FromLong()`](https://python-all.ru/3.14/c-api/long.html#c.PyLong_FromLong) или [`PyLong_FromLongLong()`](https://python-all.ru/3.14/c-api/long.html#c.PyLong_FromLongLong) в зависимости от размера типа PID в системе.

Добавлено в версии 3.2.

#### `long PyLong_AsLong(PyObject *obj)`

*Часть [Stable ABI](https://python-all.ru/3.14/c-api/stable.html#stable).*

Возвращает представление на C long для *obj*. Если *obj* не является экземпляром [`PyLongObject`](https://python-all.ru/3.14/c-api/long.html#c.PyLongObject), сначала вызывается его метод [`__index__()`](https://python-all.ru/3.14/reference/datamodel.html#object.__index__) (если он присутствует) для преобразования в `PyLongObject`.

Вызывает [`OverflowError`](https://python-all.ru/3.14/library/exceptions.html#OverflowError), если значение *obj* выходит за пределы допустимого диапазона для long.

При ошибке возвращает `-1`. Используйте [`PyErr_Occurred()`](https://python-all.ru/3.14/c-api/exceptions.html#c.PyErr_Occurred) для разрешения неоднозначности.

Изменено в версии 3.8: Используйте [`__index__()`](https://python-all.ru/3.14/reference/datamodel.html#object.__index__), если доступно.

Изменено в версии 3.10: Эта функция больше не использует [`__int__()`](https://python-all.ru/3.14/reference/datamodel.html#object.__int__).

#### `long PyLong_AS_LONG(PyObject *obj)`

Полностью эквивалентна предпочтительной `PyLong_AsLong`. В частности, может завершиться ошибкой с [`OverflowError`](https://python-all.ru/3.14/library/exceptions.html#OverflowError) или другим исключением.

[Soft deprecated](https://python-all.ru/3.14/glossary.html#term-soft-deprecated) since version 3.14.

#### `int PyLong_AsInt(PyObject *obj)`

*Часть [Stable ABI](https://python-all.ru/3.14/c-api/stable.html#stable), начиная с версии 3.13.*

Аналогична [`PyLong_AsLong()`](https://python-all.ru/3.14/c-api/long.html#c.PyLong_AsLong), но сохраняет результат в C int вместо C long.

Добавлено в версии 3.13.

#### `long PyLong_AsLongAndOverflow(PyObject *obj, int *overflow)`

*Часть [Stable ABI](https://python-all.ru/3.14/c-api/stable.html#stable).*

Возвращает представление на C long для *obj*. Если *obj* не является экземпляром [`PyLongObject`](https://python-all.ru/3.14/c-api/long.html#c.PyLongObject), сначала вызывается его метод [`__index__()`](https://python-all.ru/3.14/reference/datamodel.html#object.__index__) (если он присутствует) для преобразования в `PyLongObject`.

Если значение *obj* больше `LONG_MAX` или меньше `LONG_MIN`, установите *\*overflow* в `1` или `-1` соответственно и верните `-1`; в противном случае установите *\*overflow* в `0`. Если возникает любое другое исключение, установите *\*overflow* в `0` и верните `-1` как обычно.

При ошибке возвращает `-1`. Используйте [`PyErr_Occurred()`](https://python-all.ru/3.14/c-api/exceptions.html#c.PyErr_Occurred) для разрешения неоднозначности.

Изменено в версии 3.8: Используйте [`__index__()`](https://python-all.ru/3.14/reference/datamodel.html#object.__index__), если доступно.

Изменено в версии 3.10: Эта функция больше не использует [`__int__()`](https://python-all.ru/3.14/reference/datamodel.html#object.__int__).

#### `long long PyLong_AsLongLong(PyObject *obj)`

*Часть [Stable ABI](https://python-all.ru/3.14/c-api/stable.html#stable).*

Возвращает C-представление long long объекта *obj*. Если *obj* не является экземпляром [`PyLongObject`](https://python-all.ru/3.14/c-api/long.html#c.PyLongObject), сначала вызывается его метод [`__index__()`](https://python-all.ru/3.14/reference/datamodel.html#object.__index__) (если он есть) для преобразования в `PyLongObject`.

Вызывает [`OverflowError`](https://python-all.ru/3.14/library/exceptions.html#OverflowError), если значение *obj* выходит за пределы допустимого диапазона для long long.

При ошибке возвращает `-1`. Используйте [`PyErr_Occurred()`](https://python-all.ru/3.14/c-api/exceptions.html#c.PyErr_Occurred) для разрешения неоднозначности.

Изменено в версии 3.8: Используйте [`__index__()`](https://python-all.ru/3.14/reference/datamodel.html#object.__index__), если доступно.

Изменено в версии 3.10: Эта функция больше не использует [`__int__()`](https://python-all.ru/3.14/reference/datamodel.html#object.__int__).

#### `long long PyLong_AsLongLongAndOverflow(PyObject *obj, int *overflow)`

*Часть [Stable ABI](https://python-all.ru/3.14/c-api/stable.html#stable).*

Возвращает C-представление long long объекта *obj*. Если *obj* не является экземпляром [`PyLongObject`](https://python-all.ru/3.14/c-api/long.html#c.PyLongObject), сначала вызывается его метод [`__index__()`](https://python-all.ru/3.14/reference/datamodel.html#object.__index__) (если он есть) для преобразования в `PyLongObject`.

Если значение *obj* больше `LLONG_MAX` или меньше `LLONG_MIN`, устанавливает *\*overflow* в `1` или `-1` соответственно и возвращает `-1`; в противном случае устанавливает *\*overflow* в `0`. Если возникает любое другое исключение, устанавливает *\*overflow* в `0` и возвращает `-1` как обычно.

При ошибке возвращает `-1`. Используйте [`PyErr_Occurred()`](https://python-all.ru/3.14/c-api/exceptions.html#c.PyErr_Occurred) для разрешения неоднозначности.

Добавлено в версии 3.2.

Изменено в версии 3.8: Используйте [`__index__()`](https://python-all.ru/3.14/reference/datamodel.html#object.__index__), если доступно.

Изменено в версии 3.10: Эта функция больше не использует [`__int__()`](https://python-all.ru/3.14/reference/datamodel.html#object.__int__).

#### `Py_ssize_t PyLong_AsSsize_t(PyObject *pylong)`

*Часть [Stable ABI](https://python-all.ru/3.14/c-api/stable.html#stable).*

Возвращает C-представление [`Py_ssize_t`](https://python-all.ru/3.14/c-api/intro.html#c.Py_ssize_t) объекта *pylong*. *pylong* должен быть экземпляром [`PyLongObject`](https://python-all.ru/3.14/c-api/long.html#c.PyLongObject).

Вызывает [`OverflowError`](https://python-all.ru/3.14/library/exceptions.html#OverflowError), если значение *pylong* выходит за пределы диапазона для [`Py_ssize_t`](https://python-all.ru/3.14/c-api/intro.html#c.Py_ssize_t).

При ошибке возвращает `-1`. Используйте [`PyErr_Occurred()`](https://python-all.ru/3.14/c-api/exceptions.html#c.PyErr_Occurred) для разрешения неоднозначности.

#### `unsigned long PyLong_AsUnsignedLong(PyObject *pylong)`

*Часть [Stable ABI](https://python-all.ru/3.14/c-api/stable.html#stable).*

Возвращает C-представление unsigned long объекта *pylong*. *pylong* должен быть экземпляром [`PyLongObject`](https://python-all.ru/3.14/c-api/long.html#c.PyLongObject).

Вызывает [`OverflowError`](https://python-all.ru/3.14/library/exceptions.html#OverflowError), если значение *pylong* выходит за пределы диапазона для unsigned long.

Возвращает `(unsigned long)-1` в случае ошибки. Для устранения неоднозначности используйте [`PyErr_Occurred()`](https://python-all.ru/3.14/c-api/exceptions.html#c.PyErr_Occurred).

#### `size_t PyLong_AsSize_t(PyObject *pylong)`

*Часть [Stable ABI](https://python-all.ru/3.14/c-api/stable.html#stable).*

Возвращает C-представление `size_t` объекта *pylong*. *pylong* должен быть экземпляром [`PyLongObject`](https://python-all.ru/3.14/c-api/long.html#c.PyLongObject).

Вызывает [`OverflowError`](https://python-all.ru/3.14/library/exceptions.html#OverflowError), если значение *pylong* выходит за пределы диапазона для `size_t`.

Возвращает `(size_t)-1` в случае ошибки. Для устранения неоднозначности используйте [`PyErr_Occurred()`](https://python-all.ru/3.14/c-api/exceptions.html#c.PyErr_Occurred).

#### `unsigned long long PyLong_AsUnsignedLongLong(PyObject *pylong)`

*Часть [Stable ABI](https://python-all.ru/3.14/c-api/stable.html#stable).*

Возвращает C-представление unsigned long long объекта *pylong*. *pylong* должен быть экземпляром [`PyLongObject`](https://python-all.ru/3.14/c-api/long.html#c.PyLongObject).

Вызывает [`OverflowError`](https://python-all.ru/3.14/library/exceptions.html#OverflowError), если значение *pylong* выходит за пределы диапазона для unsigned long long.

Возвращает `(unsigned long long)-1` в случае ошибки. Для устранения неоднозначности используйте [`PyErr_Occurred()`](https://python-all.ru/3.14/c-api/exceptions.html#c.PyErr_Occurred).

Изменено в версии 3.1: Отрицательное значение *pylong* теперь вызывает [`OverflowError`](https://python-all.ru/3.14/library/exceptions.html#OverflowError), а не [`TypeError`](https://python-all.ru/3.14/library/exceptions.html#TypeError).

#### `unsigned long PyLong_AsUnsignedLongMask(PyObject *obj)`

*Часть [Stable ABI](https://python-all.ru/3.14/c-api/stable.html#stable).*

Возвращает C-представление unsigned long объекта *obj*. Если *obj* не является экземпляром [`PyLongObject`](https://python-all.ru/3.14/c-api/long.html#c.PyLongObject), сначала вызывается его метод [`__index__()`](https://python-all.ru/3.14/reference/datamodel.html#object.__index__) (если он есть) для преобразования в `PyLongObject`.

Если значение *obj* выходит за пределы диапазона для unsigned long, возвращается приведение этого значения по модулю `ULONG_MAX + 1`.

При ошибке возвращает `(unsigned long)-1`. Используйте [`PyErr_Occurred()`](https://python-all.ru/3.14/c-api/exceptions.html#c.PyErr_Occurred) для разрешения неоднозначности.

Изменено в версии 3.8: Используйте [`__index__()`](https://python-all.ru/3.14/reference/datamodel.html#object.__index__), если доступно.

Изменено в версии 3.10: Эта функция больше не использует [`__int__()`](https://python-all.ru/3.14/reference/datamodel.html#object.__int__).

#### `unsigned long long PyLong_AsUnsignedLongLongMask(PyObject *obj)`

*Часть [Stable ABI](https://python-all.ru/3.14/c-api/stable.html#stable).*

Возвращает представление unsigned long long на языке C для *obj*. Если *obj* не является экземпляром [`PyLongObject`](https://python-all.ru/3.14/c-api/long.html#c.PyLongObject), сначала вызывается его метод [`__index__()`](https://python-all.ru/3.14/reference/datamodel.html#object.__index__) (если он есть) для преобразования в `PyLongObject`.

Если значение *obj* выходит за пределы диапазона для unsigned long long, возвращается приведение этого значения по модулю `ULLONG_MAX + 1`.

При ошибке возвращает `(unsigned long long)-1`. Используйте [`PyErr_Occurred()`](https://python-all.ru/3.14/c-api/exceptions.html#c.PyErr_Occurred) для разрешения неоднозначности.

Изменено в версии 3.8: Используйте [`__index__()`](https://python-all.ru/3.14/reference/datamodel.html#object.__index__), если доступно.

Изменено в версии 3.10: Эта функция больше не использует [`__int__()`](https://python-all.ru/3.14/reference/datamodel.html#object.__int__).

#### `int PyLong_AsInt32(PyObject *obj, int32_t *value)`

#### `int PyLong_AsInt64(PyObject *obj, int64_t *value)`

*Часть [Stable ABI](https://python-all.ru/3.14/c-api/stable.html#stable) начиная с версии 3.14.*

Присваивает *\*value* знаковое представление int32\_t или int64\_t на языке C для *obj*.

Если *obj* не является экземпляром [`PyLongObject`](https://python-all.ru/3.14/c-api/long.html#c.PyLongObject), сначала вызывается его метод [`__index__()`](https://python-all.ru/3.14/reference/datamodel.html#object.__index__) (если он есть) для преобразования в `PyLongObject`.

Если значение *obj* выходит за пределы диапазона, возбуждается исключение [`OverflowError`](https://python-all.ru/3.14/library/exceptions.html#OverflowError).

Присваивает значение *\*value* и возвращает `0` при успехе. Возбуждает исключение и возвращает `-1` при ошибке.

*value* не должен быть `NULL`.

Добавлено в версии 3.14.

#### `int PyLong_AsUInt32(PyObject *obj, uint32_t *value)`

#### `int PyLong_AsUInt64(PyObject *obj, uint64_t *value)`

*Часть [Stable ABI](https://python-all.ru/3.14/c-api/stable.html#stable) начиная с версии 3.14.*

Присваивает *\*value* беззнаковое представление uint32\_t или uint64\_t на языке C для *obj*.

Если *obj* не является экземпляром [`PyLongObject`](https://python-all.ru/3.14/c-api/long.html#c.PyLongObject), сначала вызывается его метод [`__index__()`](https://python-all.ru/3.14/reference/datamodel.html#object.__index__) (если он есть) для преобразования в `PyLongObject`.

- Если *obj* отрицательное, возбуждается исключение [`ValueError`](https://python-all.ru/3.14/library/exceptions.html#ValueError).
- Если значение *obj* выходит за пределы диапазона, возбуждается исключение [`OverflowError`](https://python-all.ru/3.14/library/exceptions.html#OverflowError).

Присваивает значение *\*value* и возвращает `0` при успехе. Возбуждает исключение и возвращает `-1` при ошибке.

*value* не должен быть `NULL`.

Добавлено в версии 3.14.

#### `double PyLong_AsDouble(PyObject *pylong)`

*Часть [Stable ABI](https://python-all.ru/3.14/c-api/stable.html#stable).*

Возвращает представление double на языке C для *pylong*. *pylong* должен быть экземпляром [`PyLongObject`](https://python-all.ru/3.14/c-api/long.html#c.PyLongObject).

Возбуждает исключение [`OverflowError`](https://python-all.ru/3.14/library/exceptions.html#OverflowError), если значение *pylong* выходит за пределы диапазона для double.

При ошибке возвращает `-1.0`. Используйте [`PyErr_Occurred()`](https://python-all.ru/3.14/c-api/exceptions.html#c.PyErr_Occurred) для разрешения неоднозначности.

#### `void *PyLong_AsVoidPtr(PyObject *pylong)`

*Часть [Stable ABI](https://python-all.ru/3.14/c-api/stable.html#stable).*

Преобразует целое число Python *pylong* в указатель void на языке C. Если *pylong* не удаётся преобразовать, возбуждается исключение [`OverflowError`](https://python-all.ru/3.14/library/exceptions.html#OverflowError). Это гарантирует, что полученный указатель void будет пригоден для использования только для значений, созданных с помощью [`PyLong_FromVoidPtr()`](https://python-all.ru/3.14/c-api/long.html#c.PyLong_FromVoidPtr).

При ошибке возвращает `NULL`. Используйте [`PyErr_Occurred()`](https://python-all.ru/3.14/c-api/exceptions.html#c.PyErr_Occurred) для разрешения неоднозначности.

#### `Py_ssize_t PyLong_AsNativeBytes(PyObject *pylong, void *buffer, Py_ssize_t n_bytes, int flags)`

*Часть [Stable ABI](https://python-all.ru/3.14/c-api/stable.html#stable) начиная с версии 3.14.*

Копирует значение целого числа Python *pylong* в нативный *buffer* размера *n\_bytes*. Флаг *flags* можно установить в `-1` для поведения, аналогичного приведению в C, или в значения, описанные ниже, для управления поведением.

Возвращает `-1` с возбуждением исключения при ошибке. Это может произойти, если *pylong* не удаётся интерпретировать как целое число, или если *pylong* было отрицательным и был установлен флаг `Py_ASNATIVEBYTES_REJECT_NEGATIVE`.

В противном случае возвращает количество байт, необходимое для хранения значения. Если оно меньше или равно *n\_bytes*, значение было скопировано целиком. Заполняются все *n\_bytes* буфера: оставшиеся байты заполняются копиями знакового бита.

Если возвращённое значение больше *n\_bytes*, значение было усечено: записывается столько младших битов значения, сколько помещается, а старшие биты игнорируются. Это соответствует типичному поведению нисходящего приведения в стиле C.

> **Примечание**
>
> Переполнение не считается ошибкой. Если возвращённое значение больше *n\_bytes*, старшие биты были отброшены.

`0` никогда не будет возвращён.

Значения всегда копируются в дополнительном коде.

Пример использования:

```c
int32_t value;
Py_ssize_t bytes = PyLong_AsNativeBytes(pylong, &value, sizeof(value), -1);
if (bytes < 0) {
    // Не удалось. Установлено исключение Python с указанием причины.
    return NULL;
}
else if (bytes <= (Py_ssize_t)sizeof(value)) {
    // Успешно!
}
else {
    // Произошло переполнение, но 'value' содержит усечённые
    // младшие биты pylong.
}
```

Передача нуля в *n\_bytes* возвращает размер буфера, которого будет достаточно для хранения значения. Он может быть больше, чем технически необходимо, но не чрезмерно. Если *n\_bytes=0*, *buffer* может быть `NULL`.

> **Примечание**
>
> Передача *n\_bytes=0* в эту функцию не является надёжным способом определения битовой длины значения.

Чтобы получить всё значение Python неизвестного размера, функцию можно вызвать дважды: сначала для определения размера буфера, затем для его заполнения:

```c
// Запрос необходимого объёма памяти.
Py_ssize_t expected = PyLong_AsNativeBytes(pylong, NULL, 0, -1);
if (expected < 0) {
    // Не удалось. Установлено исключение Python с указанием причины.
    return NULL;
}
assert(expected != 0);  // Невозможно согласно определению API.
uint8_t *bignum = malloc(expected);
if (!bignum) {
    PyErr_SetString(PyExc_MemoryError, "bignum malloc failed.");
    return NULL;
}
// Безопасно получить всё значение.
Py_ssize_t bytes = PyLong_AsNativeBytes(pylong, bignum, expected, -1);
if (bytes < 0) {  // Установлено исключение.
    free(bignum);
    return NULL;
}
else if (bytes > expected) {  // Этого не должно быть возможно.
    PyErr_SetString(PyExc_RuntimeError,
        "Unexpected bignum truncation after a size check.");
    free(bignum);
    return NULL;
}
// Ожидаемый успех с учётом предварительной проверки выше.
// ... использовать bignum ...
free(bignum);
```

*flags* может быть либо `-1` (`Py_ASNATIVEBYTES_DEFAULTS`) для выбора значений по умолчанию, поведение которых наиболее похоже на приведение C, либо комбинацией других флагов из таблицы ниже. Обратите внимание, что `-1` нельзя комбинировать с другими флагами.

В настоящее время `-1` соответствует `Py_ASNATIVEBYTES_NATIVE_ENDIAN | Py_ASNATIVEBYTES_UNSIGNED_BUFFER`.

| Флаг | Значение |
| --- | --- |
| Py\_ASNATIVEBYTES\_DEFAULTS *Часть [Stable ABI](https://python-all.ru/3.14/c-api/stable.html#stable) начиная с версии 3.14.* | `-1` |
| Py\_ASNATIVEBYTES\_BIG\_ENDIAN *Часть [Stable ABI](https://python-all.ru/3.14/c-api/stable.html#stable) начиная с версии 3.14.* | `0` |
| Py\_ASNATIVEBYTES\_LITTLE\_ENDIAN *Часть [Stable ABI](https://python-all.ru/3.14/c-api/stable.html#stable) начиная с версии 3.14.* | `1` |
| Py\_ASNATIVEBYTES\_NATIVE\_ENDIAN *Часть [Stable ABI](https://python-all.ru/3.14/c-api/stable.html#stable) начиная с версии 3.14.* | `3` |
| Py\_ASNATIVEBYTES\_UNSIGNED\_BUFFER *Часть [Stable ABI](https://python-all.ru/3.14/c-api/stable.html#stable) начиная с версии 3.14.* | `4` |
| Py\_ASNATIVEBYTES\_REJECT\_NEGATIVE *Часть [Stable ABI](https://python-all.ru/3.14/c-api/stable.html#stable) начиная с версии 3.14.* | `8` |
| Py\_ASNATIVEBYTES\_ALLOW\_INDEX *Часть [Stable ABI](https://python-all.ru/3.14/c-api/stable.html#stable) начиная с версии 3.14.* | `16` |

Указание `Py_ASNATIVEBYTES_NATIVE_ENDIAN` переопределяет любые другие флаги порядка байтов. Передача `2` зарезервирована.

По умолчанию будет запрошен буфер достаточного размера для включения знакового бита. Например, при преобразовании 128 с *n\_bytes=1* функция вернёт 2 (или больше), чтобы сохранить нулевой знаковый бит.

Если указан `Py_ASNATIVEBYTES_UNSIGNED_BUFFER`, нулевой знаковый бит будет опущен при расчёте размера. Это позволяет, например, 128 поместиться в однобайтовый буфер. Если впоследствии целевой буфер будет трактоваться как знаковый, положительное входное значение может стать отрицательным. Обратите внимание, что флаг не влияет на обработку отрицательных значений: для них всегда запрашивается место под знаковый бит.

Указание `Py_ASNATIVEBYTES_REJECT_NEGATIVE` приводит к установке исключения, если *pylong* отрицательно. Без этого флага отрицательные значения будут копироваться при условии, что достаточно места хотя бы для одного знакового бита, независимо от того, было ли указано `Py_ASNATIVEBYTES_UNSIGNED_BUFFER`.

Если указан `Py_ASNATIVEBYTES_ALLOW_INDEX` и передано нецелое значение, сначала будет вызван его метод [`__index__()`](https://python-all.ru/3.14/reference/datamodel.html#object.__index__). Это может привести к выполнению кода Python и возможности выполнения других потоков, что может вызвать изменения других объектов или используемых значений. Когда *flags* равно `-1`, эта опция не установлена, и нецелые значения вызовут [`TypeError`](https://python-all.ru/3.14/library/exceptions.html#TypeError).

> **Примечание**
>
> С флагами по умолчанию *flags* (`-1`, или *UNSIGNED\_BUFFER* без *REJECT\_NEGATIVE*) несколько целых чисел Python могут отображаться на одно значение без переполнения. Например, и `255`, и `-1` помещаются в однобайтовый буфер и устанавливают все его биты. Это соответствует типичному поведению приведения в C.

Добавлено в версии 3.13.

#### `PyLong_AsPid(pid)`

Макрос для преобразования целого числа Python в идентификатор процесса.

Он может быть определён как псевдоним для [`PyLong_AsLong()`](https://python-all.ru/3.14/c-api/long.html#c.PyLong_AsLong), [`PyLong_FromLongLong()`](https://python-all.ru/3.14/c-api/long.html#c.PyLong_FromLongLong) или [`PyLong_AsInt()`](https://python-all.ru/3.14/c-api/long.html#c.PyLong_AsInt) в зависимости от размера типа PID в системе.

Добавлено в версии 3.2.

#### `int PyLong_GetSign(PyObject *obj, int *sign)`

Получить знак целочисленного объекта *obj*.

В случае успеха присвоить *\*sign* знак целого числа (0, -1 или +1 для нуля, отрицательного или положительного числа соответственно) и вернуть 0.

В случае ошибки вернуть -1 с установленным исключением. Эта функция всегда завершается успешно, если *obj* является [`PyLongObject`](https://python-all.ru/3.14/c-api/long.html#c.PyLongObject) или его подтипом.

Добавлено в версии 3.14.

#### `int PyLong_IsPositive(PyObject *obj)`

Проверить, является ли целочисленный объект *obj* положительным (`obj > 0`).

Если *obj* является экземпляром [`PyLongObject`](https://python-all.ru/3.14/c-api/long.html#c.PyLongObject) или его подтипа, вернуть `1`, если он положительный, и `0` в противном случае. Иначе установить исключение и вернуть `-1`.

Добавлено в версии 3.14.

#### `int PyLong_IsNegative(PyObject *obj)`

Проверить, является ли целочисленный объект *obj* отрицательным (`obj < 0`).

Если *obj* является экземпляром [`PyLongObject`](https://python-all.ru/3.14/c-api/long.html#c.PyLongObject) или его подтипа, вернуть `1`, если он отрицательный, и `0` в противном случае. Иначе установить исключение и вернуть `-1`.

Добавлено в версии 3.14.

#### `int PyLong_IsZero(PyObject *obj)`

Проверить, является ли целочисленный объект *obj* нулём.

Если *obj* является экземпляром [`PyLongObject`](https://python-all.ru/3.14/c-api/long.html#c.PyLongObject) или его подтипа, вернуть `1`, если он равен нулю, и `0` в противном случае. Иначе установить исключение и вернуть `-1`.

Добавлено в версии 3.14.

#### `PyObject *PyLong_GetInfo(void)`

*Часть [Stable ABI](https://python-all.ru/3.14/c-api/stable.html#stable).*

В случае успеха возвращает доступный только для чтения [именованный кортеж](https://python-all.ru/3.14/glossary.html#term-named-tuple), содержащий информацию о внутреннем представлении целых чисел в Python. Описание отдельных полей см. в [`sys.int_info`](https://python-all.ru/3.14/library/sys.html#sys.int_info).

При ошибке возвращает `NULL` с установленным исключением.

Добавлено в версии 3.1.

#### `int PyUnstable_Long_IsCompact(const PyLongObject *op)`

> *Это [нестабильное API](https://python-all.ru/3.14/c-api/stable.html#unstable-c-api). Оно может меняться без предупреждения в минорных версиях.*

Возвращает 1, если *op* компактный, и 0 в противном случае.

Эта функция позволяет критичному к производительности коду реализовать «быстрый путь» для малых целых чисел. Для компактных значений используйте [`PyUnstable_Long_CompactValue()`](https://python-all.ru/3.14/c-api/long.html#c.PyUnstable_Long_CompactValue); для остальных используйте [`PyLong_As*`](https://python-all.ru/3.14/c-api/long.html#c.PyLong_AsSize_t) или [`PyLong_AsNativeBytes()`](https://python-all.ru/3.14/c-api/long.html#c.PyLong_AsNativeBytes).

Ожидается, что ускорение будет незначительным для большинства пользователей.

Какие именно значения считаются компактными, является деталью реализации и может измениться.

Добавлено в версии 3.12.

#### `Py_ssize_t PyUnstable_Long_CompactValue(const PyLongObject *op)`

> *Это [нестабильное API](https://python-all.ru/3.14/c-api/stable.html#unstable-c-api). Оно может меняться без предупреждения в минорных версиях.*

Если *op* компактный, как определено с помощью [`PyUnstable_Long_IsCompact()`](https://python-all.ru/3.14/c-api/long.html#c.PyUnstable_Long_IsCompact), вернуть его значение.

В противном случае возвращаемое значение не определено.

Добавлено в версии 3.12.

## Экспорт API

Добавлено в версии 3.14.

#### `struct PyLongLayout`

Макет массива «цифр» («лимпов» в терминологии GMP), используемый для представления абсолютного значения целых чисел произвольной точности.

Используйте [`PyLong_GetNativeLayout()`](https://python-all.ru/3.14/c-api/long.html#c.PyLong_GetNativeLayout), чтобы получить собственный макет объектов [`int`](https://python-all.ru/3.14/library/functions.html#int) Python, которые внутри используются для целых чисел с «достаточно большим» абсолютным значением.

См. также [`sys.int_info`](https://python-all.ru/3.14/library/sys.html#sys.int_info), который предоставляет аналогичную информацию в Python.

#### `uint8_t bits_per_digit`

Количество битов на цифру. Например, 15-битная цифра означает, что биты 0-14 содержат значимую информацию.

#### `uint8_t digit_size`

Размер цифры в байтах. Например, для 15-битной цифры потребуется не менее 2 байт.

#### `int8_t digits_order`

Порядок цифр:

- `1` – сначала старшая цифра
- `-1` – сначала младшая цифра

#### `int8_t digit_endianness`

Порядок байтов в цифре:

- `1` – сначала старший байт (big endian)
- `-1` – сначала младший байт (little endian)

#### `const PyLongLayout *PyLong_GetNativeLayout(void)`

Получает собственный макет объектов [`int`](https://python-all.ru/3.14/library/functions.html#int) Python.

См. структуру [`PyLongLayout`](https://python-all.ru/3.14/c-api/long.html#c.PyLongLayout).

Функцию нельзя вызывать до инициализации Python или после финализации Python. Возвращаемый макет действителен до завершения Python. Макет одинаков для всех под-интерпретаторов Python в процессе, поэтому его можно кэшировать.

#### `struct PyLongExport`

Экспорт объекта [`int`](https://python-all.ru/3.14/library/functions.html#int) Python.

Есть два случая:

- Если [`digits`](https://python-all.ru/3.14/c-api/long.html#c.PyLongExport.digits) равно `NULL`, используйте только поле [`value`](https://python-all.ru/3.14/c-api/long.html#c.PyLongExport.value).
- Если [`digits`](https://python-all.ru/3.14/c-api/long.html#c.PyLongExport.digits) не равно `NULL`, используйте поля [`negative`](https://python-all.ru/3.14/c-api/long.html#c.PyLongExport.negative), [`ndigits`](https://python-all.ru/3.14/c-api/long.html#c.PyLongExport.ndigits) и `digits`.

#### `int64_t value`

Собственное целочисленное значение экспортируемого объекта [`int`](https://python-all.ru/3.14/library/functions.html#int). Допустимо только если [`digits`](https://python-all.ru/3.14/c-api/long.html#c.PyLongExport.digits) равно `NULL`.

#### `uint8_t negative`

`1` если число отрицательное, `0` в противном случае. Допустимо только если [`digits`](https://python-all.ru/3.14/c-api/long.html#c.PyLongExport.digits) не равно `NULL`.

#### `Py_ssize_t ndigits`

Количество цифр в массиве [`digits`](https://python-all.ru/3.14/c-api/long.html#c.PyLongExport.digits). Допустимо только если `digits` не равно `NULL`.

#### `const void *digits`

Массив беззнаковых разрядов, доступный только для чтения. Может быть `NULL`.

#### `int PyLong_Export(PyObject *obj, PyLongExport *export_long)`

Экспортирует объект Python [`int`](https://python-all.ru/3.14/library/functions.html#int).

*export\_long* должен указывать на структуру [`PyLongExport`](https://python-all.ru/3.14/c-api/long.html#c.PyLongExport), выделенную вызывающим. Он не должен быть `NULL`.

При успехе заполняет *\*export\_long* и возвращает `0`. При ошибке устанавливает исключение и возвращает `-1`.

[`PyLong_FreeExport()`](https://python-all.ru/3.14/c-api/long.html#c.PyLong_FreeExport) должен вызываться, когда экспорт больше не нужен.

> **Деталь реализации CPython:** Эта функция всегда завершается успешно, если *obj* является объектом Python [`int`](https://python-all.ru/3.14/library/functions.html#int) или его подклассом.

#### `void PyLong_FreeExport(PyLongExport *export_long)`

Освобождает экспорт *export\_long*, созданный [`PyLong_Export()`](https://python-all.ru/3.14/c-api/long.html#c.PyLong_Export).

**Деталь реализации CPython:** Вызов [`PyLong_FreeExport()`](https://python-all.ru/3.14/c-api/long.html#c.PyLong_FreeExport) необязателен, если *export\_long-\>digits* равен `NULL`.

## PyLongWriter API

API [`PyLongWriter`](https://python-all.ru/3.14/c-api/long.html#c.PyLongWriter) можно использовать для импорта целого числа.

Добавлено в версии 3.14.

#### `struct PyLongWriter`

Экземпляр писателя Python [`int`](https://python-all.ru/3.14/library/functions.html#int).

Экземпляр должен быть уничтожен с помощью [`PyLongWriter_Finish()`](https://python-all.ru/3.14/c-api/long.html#c.PyLongWriter_Finish) или [`PyLongWriter_Discard()`](https://python-all.ru/3.14/c-api/long.html#c.PyLongWriter_Discard).

#### `PyLongWriter *PyLongWriter_Create(int negative, Py_ssize_t ndigits, void **digits)`

Создаёт [`PyLongWriter`](https://python-all.ru/3.14/c-api/long.html#c.PyLongWriter).

При успехе выделяет *\*digits* и возвращает писатель. При ошибке устанавливает исключение и возвращает `NULL`.

*negative* равен `1`, если число отрицательное, или `0` в противном случае.

*ndigits* – количество разрядов в массиве *digits*. Оно должно быть больше 0.

*digits* не должен быть NULL.

После успешного вызова этой функции вызывающий должен заполнить массив разрядов *digits*, а затем вызвать [`PyLongWriter_Finish()`](https://python-all.ru/3.14/c-api/long.html#c.PyLongWriter_Finish), чтобы получить объект Python [`int`](https://python-all.ru/3.14/library/functions.html#int). Расположение *digits* описано в [`PyLong_GetNativeLayout()`](https://python-all.ru/3.14/c-api/long.html#c.PyLong_GetNativeLayout).

Разряды должны находиться в диапазоне \[`0`; `(1 << bits_per_digit) - 1`\] (где [`bits_per_digit`](https://python-all.ru/3.14/c-api/long.html#c.PyLongLayout.bits_per_digit) – количество бит на разряд). Любые неиспользуемые старшие разряды должны быть установлены в `0`.

В качестве альтернативы можно вызвать [`PyLongWriter_Discard()`](https://python-all.ru/3.14/c-api/long.html#c.PyLongWriter_Discard) для уничтожения экземпляра писателя без создания объекта [`int`](https://python-all.ru/3.14/library/functions.html#int).

#### `PyObject *PyLongWriter_Finish(PyLongWriter *writer)`

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

Завершает [`PyLongWriter`](https://python-all.ru/3.14/c-api/long.html#c.PyLongWriter), созданный [`PyLongWriter_Create()`](https://python-all.ru/3.14/c-api/long.html#c.PyLongWriter_Create).

При успехе возвращает объект Python [`int`](https://python-all.ru/3.14/library/functions.html#int). При ошибке устанавливает исключение и возвращает `NULL`.

Функция заботится о нормализации разрядов и при необходимости преобразует объект в компактное целое число.

Экземпляр писателя и массив *digits* становятся недействительными после вызова.

#### `void PyLongWriter_Discard(PyLongWriter *writer)`

Отменяет объект [`PyLongWriter`](https://python-all.ru/3.14/c-api/long.html#c.PyLongWriter), созданный с помощью [`PyLongWriter_Create()`](https://python-all.ru/3.14/c-api/long.html#c.PyLongWriter_Create).

Если *writer* равен `NULL`, операция не выполняется.

Экземпляр писателя и массив *digits* становятся недействительными после вызова.

## Устаревший API

Эти макросы [мягко устарели](https://python-all.ru/3.14/glossary.html#term-soft-deprecated). Они описывают параметры внутреннего представления экземпляров [`PyLongObject`](https://python-all.ru/3.14/c-api/long.html#c.PyLongObject).

Используйте [`PyLong_GetNativeLayout()`](https://python-all.ru/3.14/c-api/long.html#c.PyLong_GetNativeLayout) вместе с [`PyLong_Export()`](https://python-all.ru/3.14/c-api/long.html#c.PyLong_Export) для чтения целочисленных данных или [`PyLongWriter`](https://python-all.ru/3.14/c-api/long.html#c.PyLongWriter) для их записи. В настоящее время они используют одну и ту же разметку, но спроектированы так, чтобы продолжать корректно работать, даже если внутреннее представление целых чисел в CPython изменится.

#### `PyLong_SHIFT`

Это эквивалентно [`bits_per_digit`](https://python-all.ru/3.14/c-api/long.html#c.PyLongLayout.bits_per_digit) в выводе [`PyLong_GetNativeLayout()`](https://python-all.ru/3.14/c-api/long.html#c.PyLong_GetNativeLayout).

#### `PyLong_BASE`

В настоящее время это эквивалентно 1 \<\< [PyLong\_SHIFT](https://python-all.ru/3.14/c-api/long.html#c.PyLong_SHIFT).

#### `PyLong_MASK`

В настоящее время это эквивалентно (1 \<\< [PyLong\_SHIFT](https://python-all.ru/3.14/c-api/long.html#c.PyLong_SHIFT)) - 1