Протокол чисел¶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_Divide(PyObject *o1, PyObject *o2)¶: Возвращаемое значение: новая ссылка.
Возвращает результат деления o1 на o2 или NULL в случае ошибки. Это эквивалент выражения Python o1 / o2.

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

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

Возвращает целую часть от деления o1 на o2 или NULL в случае ошибки. Эквивалентно «классическому» делению целых чисел.

Новое в версии 2.2.

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

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

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

Новое в версии 2.2.

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)¶: Возвращаемое значение: новая ссылка.
Возвращает побитовое И (and) o1 и o2 в случае успеха или NULL в случае ошибки. Это эквивалент выражения Python o1 & o2.

PyObject* PyNumber_Xor(PyObject *o1, PyObject *o2)¶: Возвращаемое значение: новая ссылка.
Возвращает побитовое исключающее ИЛИ (xor) 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 при ошибке. Операция выполняется на месте (in-place), если o1 это поддерживает. Это эквивалент оператора Python o1 += o2.

PyObject* PyNumber_InPlaceSubtract(PyObject *o1, PyObject *o2)¶: Возвращаемое значение: новая ссылка.
Возвращает результат вычитания o2 из o1 или NULL при ошибке. Операция выполняется на месте (in-place), если o1 это поддерживает. Это эквивалент оператора Python o1 -= o2.

PyObject* PyNumber_InPlaceMultiply(PyObject *o1, PyObject *o2)¶: Возвращаемое значение: новая ссылка.
Возвращает результат умножения o1 и o2 или NULL при ошибке. Операция выполняется на месте (in-place), если o1 это поддерживает. Это эквивалент оператора Python o1 *= o2.

PyObject* PyNumber_InPlaceDivide(PyObject *o1, PyObject *o2)¶: Возвращаемое значение: новая ссылка.
Возвращает результат деления o1 на o2 или NULL в случае ошибки. Операция выполняется на месте, если o1 это поддерживает. Это эквивалент оператора Python o1 /= o2.

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

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

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

Новое в версии 2.2.

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

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

Новое в версии 2.2.

PyObject* PyNumber_InPlaceRemainder(PyObject *o1, PyObject *o2)¶: Возвращаемое значение: новая ссылка.
Возвращает остаток от деления o1 на o2 или NULL при ошибке. Операция выполняется на месте (in-place), если o1 это поддерживает. Это эквивалент оператора Python o1 %= o2.

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

PyObject* PyNumber_InPlaceLshift(PyObject *o1, PyObject *o2)¶: Возвращаемое значение: новая ссылка.
Возвращает результат сдвига o1 влево на o2 в случае успеха или NULL при ошибке. Операция выполняется на месте (in-place), если o1 это поддерживает. Это эквивалент оператора Python o1 <<= o2.

PyObject* PyNumber_InPlaceRshift(PyObject *o1, PyObject *o2)¶: Возвращаемое значение: новая ссылка.
Возвращает результат сдвига o1 вправо на o2 в случае успеха или NULL при ошибке. Операция выполняется на месте (in-place), если o1 это поддерживает. Это эквивалент оператора Python o1 >>= o2.

PyObject* PyNumber_InPlaceAnd(PyObject *o1, PyObject *o2)¶: Возвращаемое значение: новая ссылка.
Возвращает результат побитового И (bitwise and) o1 и o2 в случае успеха или NULL при ошибке. Операция выполняется на месте (in-place), если o1 это поддерживает. Это эквивалент оператора Python o1 &= o2.

PyObject* PyNumber_InPlaceXor(PyObject *o1, PyObject *o2)¶: Возвращаемое значение: новая ссылка.
Возвращает результат побитового исключающего ИЛИ (bitwise exclusive or) o1 и o2 в случае успеха или NULL при ошибке. Операция выполняется на месте (in-place), если o1 это поддерживает. Это эквивалент оператора Python o1 ^= o2.

PyObject* PyNumber_InPlaceOr(PyObject *o1, PyObject *o2)¶: Возвращаемое значение: новая ссылка.
Возвращает «побитовое ИЛИ» o1 и o2 в случае успеха или NULL при ошибке. Операция выполняется на месте (in-place), если o1 это поддерживает. Это эквивалент оператора Python o1 |= o2.

int PyNumber_Coerce(PyObject **p1, PyObject **p2)¶: Эта функция принимает адреса двух переменных типа PyObject*. Если объекты, на которые указывают *p1 и *p2, имеют один и тот же тип, увеличивает их счетчик ссылок и возвращает 0 (успех). Если объекты могут быть преобразованы к общему числовому типу, заменяет *p1 и *p2 на их преобразованные значения (с «новыми» счетчиками ссылок) и возвращает 0. Если преобразование невозможно или произошла какая-либо другая ошибка, возвращает -1 (неудача) и не увеличивает счетчики ссылок. Вызов PyNumber_Coerce(&o1, &o2) эквивалентен оператору Python o1, o2 = coerce(o1, o2).

int PyNumber_CoerceEx(PyObject **p1, PyObject **p2)¶: Эта функция похожа на PyNumber_Coerce(), за исключением того, что возвращает 1, когда преобразование невозможно и при этом не возникает ошибки. Счетчики ссылок в этом случае по-прежнему не увеличиваются.

PyObject* PyNumber_Int(PyObject *o)¶: Возвращаемое значение: новая ссылка.
Возвращает o, преобразованный в целочисленный объект, в случае успеха, или NULL при неудаче. Если аргумент выходит за пределы диапазона целых чисел, вместо него будет возвращен объект long. Это эквивалент выражения Python int(o).

PyObject* PyNumber_Long(PyObject *o)¶: Возвращаемое значение: новая ссылка.
Возвращает o, преобразованный в объект длинного целого, в случае успеха, или NULL при неудаче. Это эквивалент выражения Python long(o).

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

PyObject* PyNumber_Index(PyObject *o)¶

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

Новое в версии 2.5.

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

Возвращает целое число n, преобразованное в строку в системе счисления base с префиксом '0b', '0o' или '0x', если применимо. Если base не равно 2, 8, 10 или 16, используется формат 'x#num', где x – это основание. Если n не является объектом int, он сначала преобразуется с помощью PyNumber_Index().

Новое в версии 2.6.

Py_ssize_t PyNumber_AsSsize_t(PyObject *o, PyObject *exc)¶

Возвращает o, преобразованный в значение Py_ssize_t, если o можно интерпретировать как целое число. Если o может быть преобразован в Python int или long, но попытка преобразовать в значение Py_ssize_t приведет к возбуждению OverflowError, то аргумент exc – это тип исключения, которое будет возбуждено (обычно IndexError или OverflowError). Если exc равен NULL, то исключение очищается, а значение усекается до PY_SSIZE_T_MIN для отрицательного целого или PY_SSIZE_T_MAX для положительного целого.

Новое в версии 2.5.

int PyIndex_Check(PyObject *o)¶

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

Новое в версии 2.5.