Integer Objects¶
All integers are implemented as “long” integer objects of arbitrary size.
On error, most PyLong_As* APIs return (return type)-1 which cannot be
distinguished from a number.  Use PyErr_Occurred() to disambiguate.
- 
PyTypeObject PyLong_Type¶
- This instance of - PyTypeObjectrepresents the Python integer type. This is the same object as- intin the Python layer.
- 
int PyLong_Check(PyObject *p)¶
- Return true if its argument is a - PyLongObjector a subtype of- PyLongObject.
- 
int PyLong_CheckExact(PyObject *p)¶
- Return true if its argument is a - PyLongObject, but not a subtype of- PyLongObject.
- 
PyObject* PyLong_FromLong(long v)¶
- Return value: New reference.Return a new PyLongObjectobject from v, orNULLon 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, orNULLon failure.
- 
PyObject* PyLong_FromSsize_t(Py_ssize_t v)¶
- Return value: New reference.Return a new PyLongObjectobject from a CPy_ssize_t, orNULLon failure.
- 
PyObject* PyLong_FromSize_t(size_t v)¶
- Return value: New reference.Return a new PyLongObjectobject from a Csize_t, orNULLon failure.
- 
PyObject* PyLong_FromLongLong(long long v)¶
- Return value: New reference.Return a new PyLongObjectobject from a Clong long, orNULLon failure.
- 
PyObject* PyLong_FromUnsignedLongLong(unsigned long long v)¶
- Return value: New reference.Return a new PyLongObjectobject from a Cunsigned long long, orNULLon failure.
- 
PyObject* PyLong_FromDouble(double v)¶
- Return value: New reference.Return a new PyLongObjectobject from the integer part of v, orNULLon 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, str is interpreted using the Integer literals definition; in this case, leading zeros in a non-zero decimal number raises aValueError. If base is not0, it must be between2and36, inclusive. Leading spaces and single underscores after a base specifier and between digits 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)¶
- Return value: New reference.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 of- PyLongObject, first call its- __int__()method (if present) to convert it to a- PyLongObject.- Raise - OverflowErrorif the value of obj is out of range for a- long.- Returns - -1on error. Use- PyErr_Occurred()to disambiguate.
- 
long PyLong_AsLongAndOverflow(PyObject *obj, int *overflow)¶
- Return a C - longrepresentation of obj. If obj is not an instance of- PyLongObject, first call its- __int__()method (if present) to convert it to a- PyLongObject.- If the value of obj is greater than - LONG_MAXor less than- LONG_MIN, set *overflow to- 1or- -1, respectively, and return- -1; otherwise, set *overflow to- 0. If any other exception occurs set *overflow to- 0and return- -1as usual.- Returns - -1on error. Use- PyErr_Occurred()to disambiguate.
- 
long long PyLong_AsLongLong(PyObject *obj)¶
- Return a C - long longrepresentation of obj. If obj is not an instance of- PyLongObject, first call its- __int__()method (if present) to convert it to a- PyLongObject.- Raise - OverflowErrorif the value of obj is out of range for a- long long.- Returns - -1on error. Use- PyErr_Occurred()to disambiguate.
- 
long long PyLong_AsLongLongAndOverflow(PyObject *obj, int *overflow)¶
- Return a C - long longrepresentation of obj. If obj is not an instance of- PyLongObject, first call its- __int__()method (if present) to convert it to a- PyLongObject.- If the value of obj is greater than - PY_LLONG_MAXor less than- PY_LLONG_MIN, set *overflow to- 1or- -1, respectively, and return- -1; otherwise, set *overflow to- 0. If any other exception occurs set *overflow to- 0and return- -1as usual.- Returns - -1on error. Use- PyErr_Occurred()to disambiguate.- 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 of- PyLongObject.- Raise - OverflowErrorif the value of pylong is out of range for a- Py_ssize_t.- Returns - -1on error. Use- PyErr_Occurred()to disambiguate.
- 
unsigned long PyLong_AsUnsignedLong(PyObject *pylong)¶
- Return a C - unsigned longrepresentation of pylong. pylong must be an instance of- PyLongObject.- Raise - OverflowErrorif the value of pylong is out of range for a- unsigned long.- Returns - (unsigned long)-1on error. Use- PyErr_Occurred()to disambiguate.
- 
size_t PyLong_AsSize_t(PyObject *pylong)¶
- Return a C - size_trepresentation of pylong. pylong must be an instance of- PyLongObject.- Raise - OverflowErrorif the value of pylong is out of range for a- size_t.- Returns - (size_t)-1on error. Use- PyErr_Occurred()to disambiguate.
- 
unsigned long long PyLong_AsUnsignedLongLong(PyObject *pylong)¶
- Return a C - unsigned long longrepresentation of pylong. pylong must be an instance of- PyLongObject.- Raise - OverflowErrorif the value of pylong is out of range for an- unsigned long long.- Returns - (unsigned long long)-1on error. Use- PyErr_Occurred()to disambiguate.- Changed in version 3.1: A negative pylong now raises - OverflowError, not- TypeError.
- 
unsigned long PyLong_AsUnsignedLongMask(PyObject *obj)¶
- Return a C - unsigned longrepresentation of obj. If obj is not an instance of- PyLongObject, first call its- __int__()method (if present) to convert it to a- PyLongObject.- If the value of obj is out of range for an - unsigned long, return the reduction of that value modulo- ULONG_MAX + 1.- Returns - (unsigned long)-1on error. Use- PyErr_Occurred()to disambiguate.
- 
unsigned long long PyLong_AsUnsignedLongLongMask(PyObject *obj)¶
- Return a C - unsigned long longrepresentation of obj. If obj is not an instance of- PyLongObject, first call its- __int__()method (if present) to convert it to a- PyLongObject.- If the value of obj is out of range for an - unsigned long long, return the reduction of that value modulo- PY_ULLONG_MAX + 1.- Returns - (unsigned long long)-1on error. Use- PyErr_Occurred()to disambiguate.
- 
double PyLong_AsDouble(PyObject *pylong)¶
- Return a C - doublerepresentation of pylong. pylong must be an instance of- PyLongObject.- Raise - OverflowErrorif the value of pylong is out of range for a- double.- Returns - -1.0on error. Use- PyErr_Occurred()to disambiguate.
- 
void* PyLong_AsVoidPtr(PyObject *pylong)¶
- Convert a Python integer pylong to a C - voidpointer. If pylong cannot be converted, an- OverflowErrorwill be raised. This is only assured to produce a usable- voidpointer for values created with- PyLong_FromVoidPtr().- Returns - NULLon error. Use- PyErr_Occurred()to disambiguate.
