数字协议¶
-
int PyNumber_Check(PyObject *o)¶
- 作为 稳定 ABI 的一部分。
如果对象 o 提供数字协议,则返回
1
,否则返回 false。此函数总是成功。版本 3.8 中的变更: 如果 o 是一个索引整数,则返回
1
。
-
PyObject *PyNumber_Add(PyObject *o1, PyObject *o2)¶
- 返回值: 新引用。 稳定ABI 的一部分。
返回 o1 和 o2 相加的结果,失败时返回
NULL
。这等同于 Python 表达式o1 + o2
。
-
PyObject *PyNumber_Subtract(PyObject *o1, PyObject *o2)¶
- 返回值: 新引用。 稳定ABI 的一部分。
返回 o1 减去 o2 的结果,失败时返回
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)¶
- 返回值: 新引用。 自 3.7 版本起成为 稳定ABI 的一部分。
返回 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
(为 o3 传入NULL
会导致非法内存访问)。
-
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 的一部分。
返回 o1 减去 o2 的结果,失败时返回
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)¶
- 返回值: 新引用。 自 3.7 版本起成为 稳定ABI 的一部分。
返回 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 支持就地操作,则进行就地操作。当 o3 为Py_None
时,这等同于 Python 语句o1 **= o2
;否则是pow(o1, o2, o3)
的就地变体。如果 o3 被忽略,则在其位置传入Py_None
(为 o3 传入NULL
会导致非法内存访问)。
-
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 的一部分。
成功时返回转换为 Python int 的 o,失败时返回
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 int,则首先通过PyNumber_Index()
转换。
-
Py_ssize_t PyNumber_AsSsize_t(PyObject *o, PyObject *exc)¶
- 作为 稳定 ABI 的一部分。
如果 o 可以解释为整数,则返回转换为
Py_ssize_t
值。如果调用失败,则会抛出异常并返回-1
。如果 o 可以转换为 Python int,但尝试转换为
Py_ssize_t
值会引发OverflowError
,则 exc 参数将是要引发的异常类型(通常是IndexError
或OverflowError
)。如果 exc 是NULL
,则清除异常,并且对于负整数,该值被截断为PY_SSIZE_T_MIN
,对于正整数,则被截断为PY_SSIZE_T_MAX
。