整数型オブジェクト (integer object)

すべての整数は任意の長さをもつ "long" 整数として実装されます。

エラーが起きると、ほとんどの PyLong_As* API は (return type)-1 を返しますが、これは数値と見分けが付きません。 見分けを付けるためには PyErr_Occurred() を使ってください。

PyLongObject

この PyObject のサブタイプは整数型を表現します。

PyTypeObject PyLong_Type

この PyTypeObject のインスタンスは Python 整数型を表現します。これは Python レイヤにおける int と同じオブジェクトです。

int PyLong_Check(PyObject *p)

引数が PyLongObjectPyLongObject のサブタイプのときに真を返します。

int PyLong_CheckExact(PyObject *p)

引数が PyLongObject 型で、かつ PyLongObject 型のサブタイプでないときに真を返します。

PyObject* PyLong_FromLong(long v)
Return value: New reference.

Return a new PyLongObject object from v, or NULL on failure.

現在の実装では、-5 から 256 までの全ての整数に対する整数オブジェクトの配列を保持するようにしており、この範囲の数を生成すると、実際には既存のオブジェクトに対する参照が返るようになっています。従って、1 の値を変えることすら可能です。変えてしまった場合の Python の挙動は未定義です :-)

PyObject* PyLong_FromUnsignedLong(unsigned long v)
Return value: New reference.

Return a new PyLongObject object from a C unsigned long, or NULL on failure.

PyObject* PyLong_FromSsize_t(Py_ssize_t v)
Return value: New reference.

Return a new PyLongObject object from a C Py_ssize_t, or NULL on failure.

PyObject* PyLong_FromSize_t(size_t v)
Return value: New reference.

Return a new PyLongObject object from a C size_t, or NULL on failure.

PyObject* PyLong_FromLongLong(long long v)
Return value: New reference.

Return a new PyLongObject object from a C long long, or NULL on failure.

PyObject* PyLong_FromUnsignedLongLong(unsigned long long v)
Return value: New reference.

Return a new PyLongObject object from a C unsigned long long, or NULL on failure.

PyObject* PyLong_FromDouble(double v)
Return value: New reference.

Return a new PyLongObject object 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 PyLongObject based 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 is 0, str is interpreted using the 整数リテラル definition; in this case, leading zeros in a non-zero decimal number raises a ValueError. If base is not 0, it must be between 2 and 36, inclusive. Leading spaces and single underscores after a base specifier and between digits are ignored. If there are no digits, ValueError will be raised.

PyObject* PyLong_FromUnicode(Py_UNICODE *u, Py_ssize_t length, int base)
Return value: New reference.

Unicode 数値列を Python 整数値に変換します。Unicode 文字列はまず PyUnicode_EncodeDecimal() を用いてバイト文字列にエンコードされ、次に PyLong_FromString() を用いて変換されます。

Deprecated since version 3.3, will be removed in version 4.0: 古いスタイルの Py_UNICODE APIの一部です; PyLong_FromUnicodeObject() を使用するように移行してください。

PyObject* PyLong_FromUnicodeObject(PyObject *u, int base)
Return value: New reference.

u 文字列中の Unicode 数値列を Python 整数値に変換します。Unicode 文字列はまず PyUnicode_EncodeDecimal() を用いてバイト文字列にエンコードされ、次に PyLong_FromString() を用いて変換されます。

バージョン 3.3 で追加.

PyObject* PyLong_FromVoidPtr(void *p)
Return value: New reference.

ポインタ p から Python 整数値を生成します。ポインタの値は PyLong_AsVoidPtr() を適用した結果から取得されます。

long PyLong_AsLong(PyObject *obj)

Return a C long representation of obj. If obj is not an instance of PyLongObject, first call its __index__() or __int__() method (if present) to convert it to a PyLongObject.

もし obj の値が long の範囲外であれば、 OverflowError を送出します。

エラーが起きたときに -1 を返します。 見分けを付けるためには PyErr_Occurred() を使ってください。

バージョン 3.8 で変更: Use __index__() if available.

バージョン 3.8 で非推奨: Using __int__() is deprecated.

long PyLong_AsLongAndOverflow(PyObject *obj, int *overflow)

Return a C long representation of obj. If obj is not an instance of PyLongObject, first call its __index__() or __int__() method (if present) to convert it to a PyLongObject.

もし、 obj の値が LONG_MAX より大きいか、 LONG_MIN より小さければ、 *overflow は、それぞれ 1-1 に設定され、 -1 を返します; さもなければ *overflow0 に設定されます。もし、ほかの例外が発生した場合は *overflow0 に設定され -1 を返します。

エラーが起きたときに -1 を返します。 見分けを付けるためには PyErr_Occurred() を使ってください。

バージョン 3.8 で変更: Use __index__() if available.

バージョン 3.8 で非推奨: Using __int__() is deprecated.

long long PyLong_AsLongLong(PyObject *obj)

Return a C long long representation of obj. If obj is not an instance of PyLongObject, first call its __index__() or __int__() method (if present) to convert it to a PyLongObject.

もし obj の値が long の範囲外であれば、 OverflowError を送出します。

エラーが起きたときに -1 を返します。 見分けを付けるためには PyErr_Occurred() を使ってください。

バージョン 3.8 で変更: Use __index__() if available.

バージョン 3.8 で非推奨: Using __int__() is deprecated.

long long PyLong_AsLongLongAndOverflow(PyObject *obj, int *overflow)

Return a C long long representation of obj. If obj is not an instance of PyLongObject, first call its __index__() or __int__() method (if present) to convert it to a PyLongObject.

もし、 obj の値が PY_LLONG_MAX より大きいか、 PY_LLONG_MIN より小さければ、 *overflow は、それぞれ 1-1 に設定され、 -1 を返します; さもなければ *overflow0 に設定されます。もし、ほかの例外が発生した場合は *overflow0 に設定され -1 を返します。

エラーが起きたときに -1 を返します。 見分けを付けるためには PyErr_Occurred() を使ってください。

バージョン 3.2 で追加.

バージョン 3.8 で変更: Use __index__() if available.

バージョン 3.8 で非推奨: Using __int__() is deprecated.

Py_ssize_t PyLong_AsSsize_t(PyObject *pylong)

pylong を表す C の Py_ssize_t を返します。 pylongPyLongObject のインスタンスでなければなりません。

もし pylong の値が Py_ssize_t の範囲外であれば、 OverflowError を送出します。

エラーが起きたときに -1 を返します。 見分けを付けるためには PyErr_Occurred() を使ってください。

unsigned long PyLong_AsUnsignedLong(PyObject *pylong)

pylong を表す C の unsigned long を返します。 pylongPyLongObject のインスタンスでなければなりません。

もし pylong の値が unsigned long の範囲外であれば、 OverflowError を送出します。

エラーが起きたときに (unsigned long)-1 を返します。 見分けを付けるためには PyErr_Occurred() を使ってください。

size_t PyLong_AsSize_t(PyObject *pylong)

pylong を表す C の size_t を返します。 pylongPyLongObject のインスタンスでなければなりません。

もし pylong の値が size_t の範囲外であれば、 OverflowError を送出します。

エラーが起きたときに (size_t)-1 を返します。 見分けを付けるためには PyErr_Occurred() を使ってください。

unsigned long long PyLong_AsUnsignedLongLong(PyObject *pylong)

pylong を表す C の unsigned long long を返します。 pylongPyLongObject のインスタンスでなければなりません。

もし pylong の値が unsigned long long の範囲外であれば、 OverflowError を送出します。

エラーが起きたときに (unsigned long long)-1 を返します。 見分けを付けるためには PyErr_Occurred() を使ってください。

バージョン 3.1 で変更: pylong を指定した際に TypeError ではなく、 OverflowError を送出するようになりました。

unsigned long PyLong_AsUnsignedLongMask(PyObject *obj)

Return a C unsigned long representation of obj. If obj is not an instance of PyLongObject, first call its __index__() or __int__() method (if present) to convert it to a PyLongObject.

obj の値が unsigned long の範囲から外れていた場合は、 ULONG_MAX + 1 を法とした剰余を返します。

エラーが起きたときに (unsigned long)-1 を返します。 見分けを付けるためには PyErr_Occurred() を使ってください。

バージョン 3.8 で変更: Use __index__() if available.

バージョン 3.8 で非推奨: Using __int__() is deprecated.

unsigned long long PyLong_AsUnsignedLongLongMask(PyObject *obj)

Return a C unsigned long long representation of obj. If obj is not an instance of PyLongObject, first call its __index__() or __int__() method (if present) to convert it to a PyLongObject.

obj の値が unsigned long long の範囲から外れていた場合は、 PY_ULLONG_MAX + 1 を法とした剰余を返します。

エラーが起きたときに (unsigned long long)-1 を返します。 見分けを付けるためには PyErr_Occurred() を使ってください。

バージョン 3.8 で変更: Use __index__() if available.

バージョン 3.8 で非推奨: Using __int__() is deprecated.

double PyLong_AsDouble(PyObject *pylong)

pylong を表す C の double を返します。 pylongPyLongObject のインスタンスでなければなりません。

もし pylong の値が double の範囲外であれば、 OverflowError を送出します。

エラーが起きたときに -1.0 を返します。 見分けを付けるためには PyErr_Occurred() を使ってください。

void* PyLong_AsVoidPtr(PyObject *pylong)

Python の整数型を指す pylong を、 C の void ポインタに変換します。 pylong を変換できなければ、 OverflowError を送出します。この関数は PyLong_FromVoidPtr() で値を生成するときに使うような void ポインタ型を生成できるだけです。

Returns NULL on error. Use PyErr_Occurred() to disambiguate.