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

int PyNumber_Check(PyObject *o)¶

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

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

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 это поддерживает. Это eквивалент инструкции 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 это поддерживает. Это eквивалент инструкции Python o1 <<= o2.

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

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

Возвращает результат сдвига вправо o1 на o2 при успехе, или NULL в случае неудачи. Операция выполняется на месте, если o1 это поддерживает. Это eквивалент инструкции 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, преобразованный в объект целого числа в случае успеха, или NULL в случае неудачи. Это эквивалент выражения Python int(o).

PyObject* PyNumber_Float(PyObject *o)¶

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

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

PyObject* PyNumber_Index(PyObject *o)¶

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

Возвращает o, преобразованный в Python int в случае успеха, или NULL с возбуждением исключения 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 можно преобразовать в 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 в противном случае. Эта функция всегда завершается успешно.