Протокол чисел

int PyNumber_Check(PyObject *o)

Часть Стабильной ABI.

Возвращает 1, если объект o поддерживает числовые протоколы, и ложь в противном случае. Эта функция всегда успешна.

Изменено в версии 3.8: Возвращает 1 если o является целочисленным индексом.

PyObject *PyNumber_Add(PyObject *o1, PyObject *o2)

Значение возврата: Новая ссылка. Часть Стабильной ABI.

Возвращает результат сложения o1 и o2, или NULL при неудаче. Это эквивалент выражению Python o1 + o2.

PyObject *PyNumber_Subtract(PyObject *o1, PyObject *o2)

Значение возврата: Новая ссылка. Часть Стабильной ABI.

Возвращает результат вычитания o2 из o1, или NULL при неудаче. Это эквивалент выражению Python o1 - o2.

PyObject *PyNumber_Multiply(PyObject *o1, PyObject *o2)

Значение возврата: Новая ссылка. Часть Стабильной ABI.

Возвращает результат умножения o1 и o2, или NULL при неудаче. Это эквивалент выражению Python o1 * o2.

PyObject *PyNumber_MatrixMultiply(PyObject *o1, PyObject *o2)

Значение возврата: Новая ссылка. Часть Стабильной ABI с версии 3.7.

Возвращает результат матричного умножения o1 и o2, или NULL при неудаче. Это эквивалент выражению Python o1 @ o2.

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

PyObject *PyNumber_FloorDivide(PyObject *o1, PyObject *o2)

Значение возврата: Новая ссылка. Часть Стабильной ABI.

Возвращает целую часть от деления o1 на o2, или NULL при неудаче. Это эквивалент выражению Python o1 // o2.

PyObject *PyNumber_TrueDivide(PyObject *o1, PyObject *o2)

Значение возврата: Новая ссылка. Часть Стабильной ABI.

Возвращает разумное приближение математического значения o1, делённого на o2, или NULL при неудаче. Возвращаемое значение является «приближенным», так как двоичные числа с плавающей точкой являются приближениями; не все действительные числа могут быть представлены в двоичной системе. Эта функция может вернуть значение с плавающей точкой, если ей переданы два целых числа. Это эквивалентно выражению Python o1 / o2.

PyObject *PyNumber_Remainder(PyObject *o1, PyObject *o2)

Значение возврата: Новая ссылка. Часть Стабильной ABI.

Возвращает остаток от деления o1 на o2, или NULL при неудаче. Это эквивалент выражению Python o1 % o2.

PyObject *PyNumber_Divmod(PyObject *o1, PyObject *o2)

Значение возврата: Новая ссылка. Часть Стабильной ABI.

См. встроенную функцию divmod(). Возвращает NULL при неудаче. Это эквивалент выражению Python divmod(o1, o2).

PyObject *PyNumber_Power(PyObject *o1, PyObject *o2, PyObject *o3)

Значение возврата: Новая ссылка. Часть Стабильной ABI.

См. встроенную функцию pow(). Возвращает NULL при неудаче. Это эквивалентно выражению Python pow(o1, o2, o3), где o3 является необязательным. Если o3 следует игнорировать, передайте Py_None вместо него (передача NULL для o3 приведёт к некорректному доступу к памяти).

PyObject *PyNumber_Negative(PyObject *o)

Значение возврата: Новая ссылка. Часть Стабильной ABI.

Возвращает отрицание o при успехе, или NULL при неудаче. Это эквивалентно выражению Python -o.

PyObject *PyNumber_Positive(PyObject *o)

Значение возврата: Новая ссылка. Часть Стабильной ABI.

Возвращает o при успехе, или NULL при неудаче. Это эквивалентно выражению Python +o.

PyObject *PyNumber_Absolute(PyObject *o)

Значение возврата: Новая ссылка. Часть Стабильной ABI.

Возвращает абсолютное значение o, или NULL при неудаче. Это эквивалентно выражению Python abs(o).

PyObject *PyNumber_Invert(PyObject *o)

Значение возврата: Новая ссылка. Часть Стабильной ABI.

Возвращает побитовое отрицание o при успехе, или NULL при неудаче. Это эквивалентно выражению Python ~o.

PyObject *PyNumber_Lshift(PyObject *o1, PyObject *o2)

Значение возврата: Новая ссылка. Часть Стабильной ABI.

Возвращает результат сдвига o1 влево на o2 позиций при успехе, или NULL при неудаче. Это эквивалентно выражению Python o1 << o2.

PyObject *PyNumber_Rshift(PyObject *o1, PyObject *o2)

Значение возврата: Новая ссылка. Часть Стабильной ABI.

Возвращает результат сдвига o1 вправо на o2 позиций при успехе, или NULL при неудаче. Это эквивалентно выражению Python o1 >> o2.

PyObject *PyNumber_And(PyObject *o1, PyObject *o2)

Значение возврата: Новая ссылка. Часть Стабильной ABI.

Возвращает результат побитового И o1 и o2 при успехе, или NULL при неудаче. Это эквивалентно выражению Python o1 & o2.

PyObject *PyNumber_Xor(PyObject *o1, PyObject *o2)

Значение возврата: Новая ссылка. Часть Стабильной ABI.

Возвращает результат побитового исключающего ИЛИ o1 и o2 при успехе, или NULL при неудаче. Это эквивалентно выражению Python o1 ^ o2.

PyObject *PyNumber_Or(PyObject *o1, PyObject *o2)

Значение возврата: Новая ссылка. Часть Стабильной ABI.

Возвращает результат побитового ИЛИ o1 и o2 при успехе, или NULL при неудаче. Это эквивалентно выражению Python o1 | o2.

PyObject *PyNumber_InPlaceAdd(PyObject *o1, PyObject *o2)

Значение возврата: Новая ссылка. Часть Стабильной ABI.

Возвращает результат сложения o1 и o2, или NULL при неудаче. Операция выполняется «вместо» (in-place), когда o1 её поддерживает. Это эквивалентно оператору Python o1 += o2.

PyObject *PyNumber_InPlaceSubtract(PyObject *o1, PyObject *o2)

Значение возврата: Новая ссылка. Часть Стабильной ABI.

Возвращает результат вычитания o2 из o1, или NULL при неудаче. Операция выполняется «вместо» (in-place), когда o1 её поддерживает. Это эквивалентно оператору Python o1 -= o2.

PyObject *PyNumber_InPlaceMultiply(PyObject *o1, PyObject *o2)

Возвращаемое значение: новая ссылка. Часть Стабильной ABI.

Возвращает результат умножения o1 и o2, или NULL в случае ошибки. Операция выполняется внутри объекта, если o1 её поддерживает. Это эквивалентно Python-выражению o1 *= o2.

PyObject *PyNumber_InPlaceMatrixMultiply(PyObject *o1, PyObject *o2)

Возвращаемое значение: новая ссылка. Часть Стабильной ABI с версии 3.7.

Возвращает результат матричного умножения o1 и o2, или NULL в случае ошибки. Операция выполняется внутри объекта, если o1 её поддерживает. Это эквивалентно Python-выражению o1 @= o2.

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

PyObject *PyNumber_InPlaceFloorDivide(PyObject *o1, PyObject *o2)

Возвращаемое значение: новая ссылка. Часть Стабильной ABI.

Возвращает математическое целое значение от деления o1 на o2, или NULL в случае ошибки. Операция выполняется внутри объекта, если o1 её поддерживает. Это эквивалентно Python-выражению o1 //= o2.

PyObject *PyNumber_InPlaceTrueDivide(PyObject *o1, PyObject *o2)

Возвращаемое значение: новая ссылка. Часть Стабильной ABI.

Возвращает разумное приближение математического значения o1, делённого на o2, или NULL в случае ошибки. Возвращаемое значение «приблизительное», так как двоичные числа с плавающей запятой приближённые; не все вещественные числа могут быть представлены в двоичной системе. Эта функция может возвращать число с плавающей запятой, если ей переданы два целых числа. Операция выполняется внутри объекта, если o1 её поддерживает. Это эквивалентно Python-выражению o1 /= o2.

PyObject *PyNumber_InPlaceRemainder(PyObject *o1, PyObject *o2)

Возвращаемое значение: новая ссылка. Часть Стабильной ABI.

Возвращает остаток от деления o1 на o2, или NULL в случае ошибки. Операция выполняется внутри объекта, если o1 её поддерживает. Это эквивалентно Python-выражению o1 %= o2.

PyObject *PyNumber_InPlacePower(PyObject *o1, PyObject *o2, PyObject *o3)

Возвращаемое значение: новая ссылка. Часть Стабильной ABI.

См. встроенную функцию pow(). Возвращает NULL в случае ошибки. Операция выполняется внутри объекта, если o1 её поддерживает. Это эквивалентно Python-выражению o1 **= o2 если o3 — Py_None, или варианту с изменением внутри объекта выражения pow(o1, o2, o3) в противном случае. Если o3 нужно игнорировать, передайте Py_None вместо него (передача NULL для o3 приведёт к недопустимому доступу к памяти).

PyObject *PyNumber_InPlaceLshift(PyObject *o1, PyObject *o2)

Возвращаемое значение: новая ссылка. Часть Стабильной ABI.

Возвращает результат сдвига o1 влево на o2 при успехе, или NULL в случае ошибки. Операция выполняется внутри объекта, если o1 её поддерживает. Это эквивалентно Python-выражению o1 <<= o2.

PyObject *PyNumber_InPlaceRshift(PyObject *o1, PyObject *o2)

Возвращаемое значение: новая ссылка. Часть Стабильной ABI.

Возвращает результат сдвига o1 вправо на o2 при успехе, или NULL в случае ошибки. Операция выполняется внутри объекта, если o1 её поддерживает. Это эквивалентно Python-выражению o1 >>= o2.

PyObject *PyNumber_InPlaceAnd(PyObject *o1, PyObject *o2)

Возвращаемое значение: новая ссылка. Часть Стабильной ABI.

Возвращает побитовое И o1 и o2 при успехе, и NULL в случае ошибки. Операция выполняется внутри объекта, если o1 её поддерживает. Это эквивалентно Python-выражению o1 &= o2.

PyObject *PyNumber_InPlaceXor(PyObject *o1, PyObject *o2)

Возвращаемое значение: новая ссылка. Часть Стабильной ABI.

Возвращает побитовое исключающее ИЛИ o1 и o2 при успехе, или NULL в случае ошибки. Операция выполняется внутри объекта, если o1 её поддерживает. Это эквивалентно Python-выражению o1 ^= o2.

PyObject *PyNumber_InPlaceOr(PyObject *o1, PyObject *o2)

Возвращаемое значение: новая ссылка. Часть Стабильной ABI.

Возвращает побитовое ИЛИ o1 и o2 при успехе, или NULL в случае ошибки. Операция выполняется внутри объекта, если o1 её поддерживает. Это эквивалентно Python-выражению o1 |= o2.

PyObject *PyNumber_Long(PyObject *o)

Возвращаемое значение: новая ссылка. Часть Стабильной ABI.

Возвращает o, преобразованное в объект целого числа при успехе, или NULL в случае ошибки. Это эквивалентно Python-выражению int(o).

PyObject *PyNumber_Float(PyObject *o)

Возвращаемое значение: новая ссылка. Часть Стабильной ABI.

Возвращает o, преобразованное в объект с плавающей запятой при успехе, или NULL в случае ошибки. Это эквивалентно Python-выражению float(o).

PyObject *PyNumber_Index(PyObject *o)

Возвращаемое значение: новая ссылка. Часть Стабильной ABI.

Возвращает o, преобразованное в Python-целое число при успехе, или NULL с исключением TypeError при ошибке.

Изменено в версии 3.10: Результат всегда имеет точный тип int. Раньше результат мог быть экземпляром подкласса int.

PyObject *PyNumber_ToBase(PyObject *n, int base)

Возвращаемое значение: новая ссылка. Часть Стабильной ABI.

Возвращает целое число n, преобразованное в строку в системе счисления base. Аргумент base должен быть 2, 8, 10 или 16. Для систем счисления 2, 8 или 16 возвращаемая строка префиксруется маркерами основания соответственно '0b', '0o', или '0x'. Если n не является Python-целым числом, оно сначала преобразуется с помощью PyNumber_Index().

Py_ssize_t PyNumber_AsSsize_t(PyObject *o, PyObject *exc)

Часть Стабильной ABI.

Возвращает o, преобразованное в значение Py_ssize_t, если o может быть интерпретировано как целое число. Если вызов завершился неудачей, генерируется исключение, и возвращается -1.

Если o может быть преобразовано в Python-целое число, но попытка преобразования в значение Py_ssize_t вызовет OverflowError, тогда аргумент exc указывает на тип исключения, которое будет сгенерировано (обычно IndexError или OverflowError). Если exc — NULL, то исключение очищается, а значение обрезается до PY_SSIZE_T_MIN для отрицательного целого числа или PY_SSIZE_T_MAX для положительного целого числа.

int PyIndex_Check(PyObject *o)

Часть Стабильного ABI с версии 3.8.

Возвращает 1, если o — целое число индекса (имеет заполненный слот nb_index структуры tp_as_number), и 0 в противном случае. Эта функция всегда выполняется успешно.