Name	Size	Mode	Actions
abstract.rst.txt	702	0644	editdlrm
allocation.rst.txt	4796	0644	editdlrm
arg.rst.txt	26004	0644	editdlrm
bool.rst.txt	1304	0644	editdlrm
buffer.rst.txt	22965	0644	editdlrm
bytearray.rst.txt	2181	0644	editdlrm
capsule.rst.txt	5741	0644	editdlrm
cell.rst.txt	1940	0644	editdlrm
class.rst.txt	1866	0644	editdlrm
cobject.rst.txt	1870	0644	editdlrm
code.rst.txt	1635	0644	editdlrm
codec.rst.txt	4643	0644	editdlrm
complex.rst.txt	4079	0644	editdlrm
concrete.rst.txt	1963	0644	editdlrm
conversion.rst.txt	7092	0644	editdlrm
datetime.rst.txt	6413	0644	editdlrm
descriptor.rst.txt	1296	0644	editdlrm
dict.rst.txt	7757	0644	editdlrm
exceptions.rst.txt	35304	0644	editdlrm
file.rst.txt	6198	0644	editdlrm
float.rst.txt	3371	0644	editdlrm
function.rst.txt	2421	0644	editdlrm
gcsupport.rst.txt	6587	0644	editdlrm
gen.rst.txt	920	0644	editdlrm
import.rst.txt	11221	0644	editdlrm
index.rst.txt	578	0644	editdlrm
init.rst.txt	49160	0644	editdlrm
int.rst.txt	4578	0644	editdlrm
intro.rst.txt	28473	0644	editdlrm
iter.rst.txt	1390	0644	editdlrm
iterator.rst.txt	1796	0644	editdlrm
list.rst.txt	6362	0644	editdlrm
long.rst.txt	7987	0644	editdlrm
mapping.rst.txt	2874	0644	editdlrm
marshal.rst.txt	3985	0644	editdlrm
memory.rst.txt	11556	0644	editdlrm
method.rst.txt	2099	0644	editdlrm
module.rst.txt	3867	0644	editdlrm
none.rst.txt	697	0644	editdlrm
number.rst.txt	11939	0644	editdlrm
objbuffer.rst.txt	2516	0644	editdlrm
object.rst.txt	17491	0644	editdlrm
objimpl.rst.txt	305	0644	editdlrm
refcounting.rst.txt	2934	0644	editdlrm
reflection.rst.txt	1567	0644	editdlrm
sequence.rst.txt	8716	0644	editdlrm
set.rst.txt	6588	0644	editdlrm
slice.rst.txt	2979	0644	editdlrm
string.rst.txt	15422	0644	editdlrm
structures.rst.txt	14966	0644	editdlrm
sys.rst.txt	5714	0644	editdlrm
tuple.rst.txt	5491	0644	editdlrm
type.rst.txt	2761	0644	editdlrm
typeobj.rst.txt	66936	0644	editdlrm
unicode.rst.txt	45126	0644	editdlrm
utilities.rst.txt	415	0644	editdlrm
veryhigh.rst.txt	13363	0644	editdlrm
weakref.rst.txt	2820	0644	editdlrm

.. highlightlang:: c .. _number: Number Protocol =============== .. c:function:: int PyNumber_Check(PyObject *o) Returns ``1`` if the object *o* provides numeric protocols, and false otherwise. This function always succeeds. .. c:function:: PyObject* PyNumber_Add(PyObject *o1, PyObject *o2) Returns the result of adding *o1* and *o2*, or *NULL* on failure. This is the equivalent of the Python expression ``o1 + o2``. .. c:function:: PyObject* PyNumber_Subtract(PyObject *o1, PyObject *o2) Returns the result of subtracting *o2* from *o1*, or *NULL* on failure. This is the equivalent of the Python expression ``o1 - o2``. .. c:function:: PyObject* PyNumber_Multiply(PyObject *o1, PyObject *o2) Returns the result of multiplying *o1* and *o2*, or *NULL* on failure. This is the equivalent of the Python expression ``o1 * o2``. .. c:function:: PyObject* PyNumber_Divide(PyObject *o1, PyObject *o2) Returns the result of dividing *o1* by *o2*, or *NULL* on failure. This is the equivalent of the Python expression ``o1 / o2``. .. c:function:: PyObject* PyNumber_FloorDivide(PyObject *o1, PyObject *o2) Return the floor of *o1* divided by *o2*, or *NULL* on failure. This is equivalent to the "classic" division of integers. .. versionadded:: 2.2 .. c:function:: PyObject* PyNumber_TrueDivide(PyObject *o1, PyObject *o2) Return a reasonable approximation for the mathematical value of *o1* divided by *o2*, or *NULL* on failure. The return value is "approximate" because binary floating point numbers are approximate; it is not possible to represent all real numbers in base two. This function can return a floating point value when passed two integers. .. versionadded:: 2.2 .. c:function:: PyObject* PyNumber_Remainder(PyObject *o1, PyObject *o2) Returns the remainder of dividing *o1* by *o2*, or *NULL* on failure. This is the equivalent of the Python expression ``o1 % o2``. .. c:function:: PyObject* PyNumber_Divmod(PyObject *o1, PyObject *o2) .. index:: builtin: divmod See the built-in function :func:`divmod`. Returns *NULL* on failure. This is the equivalent of the Python expression ``divmod(o1, o2)``. .. c:function:: PyObject* PyNumber_Power(PyObject *o1, PyObject *o2, PyObject *o3) .. index:: builtin: pow See the built-in function :func:`pow`. Returns *NULL* on failure. This is the equivalent of the Python expression ``pow(o1, o2, o3)``, where *o3* is optional. If *o3* is to be ignored, pass :c:data:`Py_None` in its place (passing *NULL* for *o3* would cause an illegal memory access). .. c:function:: PyObject* PyNumber_Negative(PyObject *o) Returns the negation of *o* on success, or *NULL* on failure. This is the equivalent of the Python expression ``-o``. .. c:function:: PyObject* PyNumber_Positive(PyObject *o) Returns *o* on success, or *NULL* on failure. This is the equivalent of the Python expression ``+o``. .. c:function:: PyObject* PyNumber_Absolute(PyObject *o) .. index:: builtin: abs Returns the absolute value of *o*, or *NULL* on failure. This is the equivalent of the Python expression ``abs(o)``. .. c:function:: PyObject* PyNumber_Invert(PyObject *o) Returns the bitwise negation of *o* on success, or *NULL* on failure. This is the equivalent of the Python expression ``~o``. .. c:function:: PyObject* PyNumber_Lshift(PyObject *o1, PyObject *o2) Returns the result of left shifting *o1* by *o2* on success, or *NULL* on failure. This is the equivalent of the Python expression ``o1 << o2``. .. c:function:: PyObject* PyNumber_Rshift(PyObject *o1, PyObject *o2) Returns the result of right shifting *o1* by *o2* on success, or *NULL* on failure. This is the equivalent of the Python expression ``o1 >> o2``. .. c:function:: PyObject* PyNumber_And(PyObject *o1, PyObject *o2) Returns the "bitwise and" of *o1* and *o2* on success and *NULL* on failure. This is the equivalent of the Python expression ``o1 & o2``. .. c:function:: PyObject* PyNumber_Xor(PyObject *o1, PyObject *o2) Returns the "bitwise exclusive or" of *o1* by *o2* on success, or *NULL* on failure. This is the equivalent of the Python expression ``o1 ^ o2``. .. c:function:: PyObject* PyNumber_Or(PyObject *o1, PyObject *o2) Returns the "bitwise or" of *o1* and *o2* on success, or *NULL* on failure. This is the equivalent of the Python expression ``o1 | o2``. .. c:function:: PyObject* PyNumber_InPlaceAdd(PyObject *o1, PyObject *o2) Returns the result of adding *o1* and *o2*, or *NULL* on failure. The operation is done *in-place* when *o1* supports it. This is the equivalent of the Python statement ``o1 += o2``. .. c:function:: PyObject* PyNumber_InPlaceSubtract(PyObject *o1, PyObject *o2) Returns the result of subtracting *o2* from *o1*, or *NULL* on failure. The operation is done *in-place* when *o1* supports it. This is the equivalent of the Python statement ``o1 -= o2``. .. c:function:: PyObject* PyNumber_InPlaceMultiply(PyObject *o1, PyObject *o2) Returns the result of multiplying *o1* and *o2*, or *NULL* on failure. The operation is done *in-place* when *o1* supports it. This is the equivalent of the Python statement ``o1 *= o2``. .. c:function:: PyObject* PyNumber_InPlaceDivide(PyObject *o1, PyObject *o2) Returns the result of dividing *o1* by *o2*, or *NULL* on failure. The operation is done *in-place* when *o1* supports it. This is the equivalent of the Python statement ``o1 /= o2``. .. c:function:: PyObject* PyNumber_InPlaceFloorDivide(PyObject *o1, PyObject *o2) Returns the mathematical floor of dividing *o1* by *o2*, or *NULL* on failure. The operation is done *in-place* when *o1* supports it. This is the equivalent of the Python statement ``o1 //= o2``. .. versionadded:: 2.2 .. c:function:: PyObject* PyNumber_InPlaceTrueDivide(PyObject *o1, PyObject *o2) Return a reasonable approximation for the mathematical value of *o1* divided by *o2*, or *NULL* on failure. The return value is "approximate" because binary floating point numbers are approximate; it is not possible to represent all real numbers in base two. This function can return a floating point value when passed two integers. The operation is done *in-place* when *o1* supports it. .. versionadded:: 2.2 .. c:function:: PyObject* PyNumber_InPlaceRemainder(PyObject *o1, PyObject *o2) Returns the remainder of dividing *o1* by *o2*, or *NULL* on failure. The operation is done *in-place* when *o1* supports it. This is the equivalent of the Python statement ``o1 %= o2``. .. c:function:: PyObject* PyNumber_InPlacePower(PyObject *o1, PyObject *o2, PyObject *o3) .. index:: builtin: pow See the built-in function :func:`pow`. Returns *NULL* on failure. The operation is done *in-place* when *o1* supports it. This is the equivalent of the Python statement ``o1 **= o2`` when o3 is :c:data:`Py_None`, or an in-place variant of ``pow(o1, o2, o3)`` otherwise. If *o3* is to be ignored, pass :c:data:`Py_None` in its place (passing *NULL* for *o3* would cause an illegal memory access). .. c:function:: PyObject* PyNumber_InPlaceLshift(PyObject *o1, PyObject *o2) Returns the result of left shifting *o1* by *o2* on success, or *NULL* on failure. The operation is done *in-place* when *o1* supports it. This is the equivalent of the Python statement ``o1 <<= o2``. .. c:function:: PyObject* PyNumber_InPlaceRshift(PyObject *o1, PyObject *o2) Returns the result of right shifting *o1* by *o2* on success, or *NULL* on failure. The operation is done *in-place* when *o1* supports it. This is the equivalent of the Python statement ``o1 >>= o2``. .. c:function:: PyObject* PyNumber_InPlaceAnd(PyObject *o1, PyObject *o2) Returns the "bitwise and" of *o1* and *o2* on success and *NULL* on failure. The operation is done *in-place* when *o1* supports it. This is the equivalent of the Python statement ``o1 &= o2``. .. c:function:: PyObject* PyNumber_InPlaceXor(PyObject *o1, PyObject *o2) Returns the "bitwise exclusive or" of *o1* by *o2* on success, or *NULL* on failure. The operation is done *in-place* when *o1* supports it. This is the equivalent of the Python statement ``o1 ^= o2``. .. c:function:: PyObject* PyNumber_InPlaceOr(PyObject *o1, PyObject *o2) Returns the "bitwise or" of *o1* and *o2* on success, or *NULL* on failure. The operation is done *in-place* when *o1* supports it. This is the equivalent of the Python statement ``o1 |= o2``. .. c:function:: int PyNumber_Coerce(PyObject **p1, PyObject **p2) .. index:: builtin: coerce This function takes the addresses of two variables of type :c:type:`PyObject\*`. If the objects pointed to by ``*p1`` and ``*p2`` have the same type, increment their reference count and return ``0`` (success). If the objects can be converted to a common numeric type, replace ``*p1`` and ``*p2`` by their converted value (with 'new' reference counts), and return ``0``. If no conversion is possible, or if some other error occurs, return ``-1`` (failure) and don't increment the reference counts. The call ``PyNumber_Coerce(&o1, &o2)`` is equivalent to the Python statement ``o1, o2 = coerce(o1, o2)``. .. c:function:: int PyNumber_CoerceEx(PyObject **p1, PyObject **p2) This function is similar to :c:func:`PyNumber_Coerce`, except that it returns ``1`` when the conversion is not possible and when no error is raised. Reference counts are still not increased in this case. .. c:function:: PyObject* PyNumber_Int(PyObject *o) .. index:: builtin: int Returns the *o* converted to an integer object on success, or *NULL* on failure. If the argument is outside the integer range a long object will be returned instead. This is the equivalent of the Python expression ``int(o)``. .. c:function:: PyObject* PyNumber_Long(PyObject *o) .. index:: builtin: long Returns the *o* converted to a long integer object on success, or *NULL* on failure. This is the equivalent of the Python expression ``long(o)``. .. c:function:: PyObject* PyNumber_Float(PyObject *o) .. index:: builtin: float Returns the *o* converted to a float object on success, or *NULL* on failure. This is the equivalent of the Python expression ``float(o)``. .. c:function:: PyObject* PyNumber_Index(PyObject *o) Returns the *o* converted to a Python int or long on success or *NULL* with a :exc:`TypeError` exception raised on failure. .. versionadded:: 2.5 .. c:function:: PyObject* PyNumber_ToBase(PyObject *n, int base) Returns the integer *n* converted to *base* as a string with a base marker of ``'0b'``, ``'0o'``, or ``'0x'`` if applicable. When *base* is not 2, 8, 10, or 16, the format is ``'x#num'`` where x is the base. If *n* is not an int object, it is converted with :c:func:`PyNumber_Index` first. .. versionadded:: 2.6 .. c:function:: Py_ssize_t PyNumber_AsSsize_t(PyObject *o, PyObject *exc) Returns *o* converted to a Py_ssize_t value if *o* can be interpreted as an integer. If *o* can be converted to a Python int or long but the attempt to convert to a Py_ssize_t value would raise an :exc:`OverflowError`, then the *exc* argument is the type of exception that will be raised (usually :exc:`IndexError` or :exc:`OverflowError`). If *exc* is *NULL*, then the exception is cleared and the value is clipped to *PY_SSIZE_T_MIN* for a negative integer or *PY_SSIZE_T_MAX* for a positive integer. .. versionadded:: 2.5 .. c:function:: int PyIndex_Check(PyObject *o) Returns ``1`` if *o* is an index integer (has the nb_index slot of the tp_as_number structure filled in), and ``0`` otherwise. .. versionadded:: 2.5