Протокол номера

int PyNumber_Check(PyObject *o)

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

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

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

Return value: New reference.

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

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

Return value: New reference.

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

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

Return value: New reference.

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

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

Return value: New reference.

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

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

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

Return value: New reference.

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

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

Return value: New reference.

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

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

Return value: New reference.

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

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

Return value: New reference.

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

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

Return value: New reference.

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

PyObject* PyNumber_Negative(PyObject *o)

Return value: New reference.

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

PyObject* PyNumber_Positive(PyObject *o)

Return value: New reference.

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

PyObject* PyNumber_Absolute(PyObject *o)

Return value: New reference.

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

PyObject* PyNumber_Invert(PyObject *o)

Return value: New reference.

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

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

Return value: New reference.

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

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

Return value: New reference.

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

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

Return value: New reference.

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

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

Return value: New reference.

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

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

Return value: New reference.

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

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

Return value: New reference.

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

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

Return value: New reference.

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

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

Return value: New reference.

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

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

Return value: New reference.

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

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

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

Return value: New reference.

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

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

Return value: New reference.

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

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

Return value: New reference.

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

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

Return value: New reference.

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

Return value: New reference.

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

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

Return value: New reference.

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

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

Return value: New reference.

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

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

Return value: New reference.

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

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

Return value: New reference.

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

PyObject* PyNumber_Long(PyObject *o)

Return value: New reference.

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

PyObject* PyNumber_Float(PyObject *o)

Return value: New reference.

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

PyObject* PyNumber_Index(PyObject *o)

Return value: New reference.

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

PyObject* PyNumber_ToBase(PyObject *n, int base)

Return value: New reference.

Возвращает целое число n преобразованное по основанию base в виде строки. Аргумент base должен иметь значение 2, 8, 10 или 16. Для оснований 2, 8 или 16 возвращенная строка имеет префикс маркера основания '0b', '0o' или '0x' соответственно. Если n не является Python int, он преобразуется в 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 иначе. Функция всегда выполняется успешно.