Протокол чисел¶Number Protocol

int PyNumber_Check(PyObject *o)¶

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

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

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

Возвращаемое значение: новая ссылка.

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

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

Возвращаемое значение: новая ссылка.

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

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

Возвращаемое значение: новая ссылка.

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

PyObject* PyNumber_Long(PyObject *o)¶

Возвращаемое значение: новая ссылка.

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

PyObject* PyNumber_Float(PyObject *o)¶

Возвращаемое значение: новая ссылка.

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

PyObject* PyNumber_Index(PyObject *o)¶

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

PyObject* PyNumber_ToBase(PyObject *n, int base)¶

Возвращает целое число 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 можно преобразовать в int Python, но попытка\nпреобразования в значение Py_ssize_t привела бы к исключению OverflowError, тогда аргумент\nexc – это тип возбуждаемого исключения (обычно\nIndexError или OverflowError). Если exc равен NULL, то\nисключение очищается, а значение усекается до PY_SSIZE_T_MIN для отрицательного\nцелого или до PY_SSIZE_T_MAX для положительного.

int PyIndex_Check(PyObject *o)¶

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