Integer Objects¶
All integers are implemented as “long” integer objects of arbitrary size.
-
PyTypeObject
PyLong_Type¶ This instance of
PyTypeObjectrepresents the Python integer type. This is the same object asintin the Python layer.
-
int
PyLong_Check(PyObject *p)¶ Return true if its argument is a
PyLongObjector a subtype ofPyLongObject.
-
int
PyLong_CheckExact(PyObject *p)¶ Return true if its argument is a
PyLongObject, but not a subtype ofPyLongObject.
-
PyObject*
PyLong_FromLong(long v)¶ - Return value: New reference.
Return a new
PyLongObjectobject from v, or NULL on failure.The current implementation keeps an array of integer objects for all integers between
-5and256, when you create an int in that range you actually just get back a reference to the existing object. So it should be possible to change the value of1. I suspect the behaviour of Python in this case is undefined. :-)
-
PyObject*
PyLong_FromUnsignedLong(unsigned long v)¶ - Return value: New reference.
Return a new
PyLongObjectobject from a Cunsigned long, or NULL on failure.
-
PyObject*
PyLong_FromSsize_t(Py_ssize_t v)¶ Return a new
PyLongObjectobject from a CPy_ssize_t, or NULL on failure.
-
PyObject*
PyLong_FromSize_t(size_t v)¶ Return a new
PyLongObjectobject from a Csize_t, or NULL on failure.
-
PyObject*
PyLong_FromLongLong(PY_LONG_LONG v)¶ - Return value: New reference.
Return a new
PyLongObjectobject from a Clong long, or NULL on failure.
-
PyObject*
PyLong_FromUnsignedLongLong(unsigned PY_LONG_LONG v)¶ - Return value: New reference.
Return a new
PyLongObjectobject from a Cunsigned long long, or NULL on failure.
-
PyObject*
PyLong_FromDouble(double v)¶ - Return value: New reference.
Return a new
PyLongObjectobject from the integer part of v, or NULL on failure.
-
PyObject*
PyLong_FromString(const char *str, char **pend, int base)¶ - Return value: New reference.
Return a new
PyLongObjectbased on the string value in str, which is interpreted according to the radix in base. If pend is non-NULL, *pend will point to the first character in str which follows the representation of the number. If base is0, the radix will be determined based on the leading characters of str: if str starts with'0x'or'0X', radix 16 will be used; if str starts with'0o'or'0O', radix 8 will be used; if str starts with'0b'or'0B', radix 2 will be used; otherwise radix 10 will be used. If base is not0, it must be between2and36, inclusive. Leading spaces are ignored. If there are no digits,ValueErrorwill be raised.
-
PyObject*
PyLong_FromUnicode(Py_UNICODE *u, Py_ssize_t length, int base)¶ - Return value: New reference.
Convert a sequence of Unicode digits to a Python integer value. The Unicode string is first encoded to a byte string using
PyUnicode_EncodeDecimal()and then converted usingPyLong_FromString().Deprecated since version 3.3, will be removed in version 4.0: Part of the old-style
Py_UNICODEAPI; please migrate to usingPyLong_FromUnicodeObject().
-
PyObject*
PyLong_FromUnicodeObject(PyObject *u, int base)¶ Convert a sequence of Unicode digits in the string u to a Python integer value. The Unicode string is first encoded to a byte string using
PyUnicode_EncodeDecimal()and then converted usingPyLong_FromString().New in version 3.3.
-
PyObject*
PyLong_FromVoidPtr(void *p)¶ - Return value: New reference.
Create a Python integer from the pointer p. The pointer value can be retrieved from the resulting value using
PyLong_AsVoidPtr().
-
long
PyLong_AsLong(PyObject *obj)¶ Return a C
longrepresentation of obj. If obj is not an instance ofPyLongObject, first call its__int__()method (if present) to convert it to aPyLongObject.Raise
OverflowErrorif the value of obj is out of range for along.
-
long
PyLong_AsLongAndOverflow(PyObject *obj, int *overflow)¶ Return a C
longrepresentation of obj. If obj is not an instance ofPyLongObject, first call its__int__()method (if present) to convert it to aPyLongObject.If the value of obj is greater than
LONG_MAXor less thanLONG_MIN, set *overflow to1or-1, respectively, and return-1; otherwise, set *overflow to0. If any other exception occurs set *overflow to0and return-1as usual.
-
PY_LONG_LONG
PyLong_AsLongLong(PyObject *obj)¶ Return a C
long longrepresentation of obj. If obj is not an instance ofPyLongObject, first call its__int__()method (if present) to convert it to aPyLongObject.Raise
OverflowErrorif the value of obj is out of range for along.
-
PY_LONG_LONG
PyLong_AsLongLongAndOverflow(PyObject *obj, int *overflow)¶ Return a C
long longrepresentation of obj. If obj is not an instance ofPyLongObject, first call its__int__()method (if present) to convert it to aPyLongObject.If the value of obj is greater than
PY_LLONG_MAXor less thanPY_LLONG_MIN, set *overflow to1or-1, respectively, and return-1; otherwise, set *overflow to0. If any other exception occurs set *overflow to0and return-1as usual.New in version 3.2.
-
Py_ssize_t
PyLong_AsSsize_t(PyObject *pylong)¶ Return a C
Py_ssize_trepresentation of pylong. pylong must be an instance ofPyLongObject.Raise
OverflowErrorif the value of pylong is out of range for aPy_ssize_t.
-
unsigned long
PyLong_AsUnsignedLong(PyObject *pylong)¶ Return a C
unsigned longrepresentation of pylong. pylong must be an instance ofPyLongObject.Raise
OverflowErrorif the value of pylong is out of range for aunsigned long.
-
size_t
PyLong_AsSize_t(PyObject *pylong)¶ Return a C
size_trepresentation of pylong. pylong must be an instance ofPyLongObject.Raise
OverflowErrorif the value of pylong is out of range for asize_t.
-
unsigned PY_LONG_LONG
PyLong_AsUnsignedLongLong(PyObject *pylong)¶ Return a C
unsigned PY_LONG_LONGrepresentation of pylong. pylong must be an instance ofPyLongObject.Raise
OverflowErrorif the value of pylong is out of range for anunsigned PY_LONG_LONG.Changed in version 3.1: A negative pylong now raises
OverflowError, notTypeError.
-
unsigned long
PyLong_AsUnsignedLongMask(PyObject *obj)¶ Return a C
unsigned longrepresentation of obj. If obj is not an instance ofPyLongObject, first call its__int__()method (if present) to convert it to aPyLongObject.If the value of obj is out of range for an
unsigned long, return the reduction of that value moduloULONG_MAX + 1.
-
unsigned PY_LONG_LONG
PyLong_AsUnsignedLongLongMask(PyObject *obj)¶ Return a C
unsigned long longrepresentation of obj. If obj is not an instance ofPyLongObject, first call its__int__()method (if present) to convert it to aPyLongObject.If the value of obj is out of range for an
unsigned long long, return the reduction of that value moduloPY_ULLONG_MAX + 1.
-
double
PyLong_AsDouble(PyObject *pylong)¶ Return a C
doublerepresentation of pylong. pylong must be an instance ofPyLongObject.Raise
OverflowErrorif the value of pylong is out of range for adouble.
-
void*
PyLong_AsVoidPtr(PyObject *pylong)¶ Convert a Python integer pylong to a C
voidpointer. If pylong cannot be converted, anOverflowErrorwill be raised. This is only assured to produce a usablevoidpointer for values created withPyLong_FromVoidPtr().
