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

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 в противном случае. Эта функция всегда выполняется успешно.