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

int PyNumber_Check(PyObject *o)

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

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

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

Значение возврата: Новая ссылка.

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

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

Значение возврата: Новая ссылка.

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

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

Значение возврата: Новая ссылка.

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

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

Значение возврата: Новая ссылка.

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

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

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

Значение возврата: Новая ссылка.

Возвращает целую часть от деления o1 на o2, или NULL при ошибке. Это эквивалентно «классическому» целочисленному делению.

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

Значение возврата: Новая ссылка.

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

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

Значение возврата: Новая ссылка.

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

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

Значение возврата: Новая ссылка.

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

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

Значение возврата: Новая ссылка.

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

PyObject* PyNumber_Negative(PyObject *o)

Значение возврата: Новая ссылка.

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

PyObject* PyNumber_Positive(PyObject *o)

Значение возврата: Новая ссылка.

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

PyObject* PyNumber_Absolute(PyObject *o)

Значение возврата: Новая ссылка.

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

PyObject* PyNumber_Invert(PyObject *o)

Значение возврата: Новая ссылка.

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

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

Значение возврата: Новая ссылка.

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

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

Значение возврата: Новая ссылка.

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

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

Значение возврата: Новая ссылка.

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

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

Значение возврата: Новая ссылка.

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

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

Значение возврата: Новая ссылка.

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

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

Значение возврата: Новая ссылка.

Возвращает результат сложения o1 и o2, или NULL при ошибке. Операция выполняется «на месте» если o1 это поддерживает. Это эквивалентно оператору Python o1 += o2.

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

Значение возврата: Новая ссылка.

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

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

Значение возврата: Новая ссылка.

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

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

Значение возврата: Новая ссылка.

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

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

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

Значение возврата: Новая ссылка.

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

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

Значение возврата: Новая ссылка.

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

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

Значение возврата: Новая ссылка.

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

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

Значение возврата: Новая ссылка.

См. встроенную функцию 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)

Значение возврата: Новая ссылка.

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

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

Значение возврата: Новая ссылка.

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

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

Значение возврата: Новая ссылка.

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

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

Значение возврата: Новая ссылка.

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

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

Значение возврата: Новая ссылка.

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

PyObject* PyNumber_Long(PyObject *o)

Значение возврата: Новая ссылка.

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

PyObject* PyNumber_Float(PyObject *o)

Значение возврата: Новая ссылка.

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

PyObject* PyNumber_Index(PyObject *o)

Значение возврата: Новая ссылка.

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

PyObject* PyNumber_ToBase(PyObject *n, int base)

Значение возврата: Новая ссылка.

Возвращает целое число 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)

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

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

int PyIndex_Check(PyObject *o)

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