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

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 при ошибке. Операция выполняется «на месте», если o1 поддерживает это. Это эквивалентно выражению Python o1 += o2.

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

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

Возвращает результат вычитания o2 из o1 или NULL при ошибке. Операция выполняется «на месте», если 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 в противном случае. Эта функция всегда завершается успешно.