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

int PyNumber_Check(PyObject *o)

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

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

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