# 정수 객체

모든 정수는 임의의 크기의 “long” 정수 객체로 구현됩니다.

에러 시, 대부분의 `PyLong_As*` API는 숫자와 구별할 수 없는 `(return type)-1`을 반환합니다. 모호성을 제거하려면 `PyErr_Occurred()`를 사용하십시오.

type PyLongObject
  Part of the 제한된 API (as an opaque struct).

  이 `PyObject`의 서브 형은 파이썬 정수 객체를 나타냅니다.

PyTypeObject PyLong_Type
  Part of the 안정 ABI.

  이 `PyTypeObject` 인스턴스는 파이썬 정수 형을 나타냅니다. 이것은 파이썬 계층의 `int`와 같은 객체입니다.

int PyLong_Check(PyObject *p)

  인자가 `PyLongObject`이나 `PyLongObject`의 서브 형이면 참을 반환합니다. 이 함수는 항상 성공합니다.

int PyLong_CheckExact(PyObject *p)

  인자가 `PyLongObject` 이지만 `PyLongObject`의 서브 형이 아니면 참을 반환합니다. 이 함수는 항상 성공합니다.

PyObject *PyLong_FromLong(long v)
  반환값: 새 참조. Part of the 안정 ABI.

  v로부터 새 `PyLongObject` 객체를 반환하거나, 실패하면 `NULL`을 반환합니다.

  CPython 구현 상세: CPython keeps an array of integer objects for all integers between `-5` and `256`. When you create an int in that range you actually just get back a reference to the existing object.

PyObject *PyLong_FromUnsignedLong(unsigned long v)
  반환값: 새 참조. Part of the 안정 ABI.

  C unsigned long으로부터 새 `PyLongObject` 객체를 반환하거나, 실패하면 `NULL`을 반환합니다.

PyObject *PyLong_FromSsize_t(Py_ssize_t v)
  반환값: 새 참조. Part of the 안정 ABI.

  C `Py_ssize_t`로부터 새 `PyLongObject` 객체를 반환하거나, 실패하면 `NULL`을 반환합니다.

PyObject *PyLong_FromSize_t(size_t v)
  반환값: 새 참조. Part of the 안정 ABI.

  C `size_t`로부터 새 `PyLongObject` 객체를 반환하거나, 실패하면 `NULL`을 반환합니다.

PyObject *PyLong_FromLongLong(long long v)
  반환값: 새 참조. Part of the 안정 ABI.

  C long long으로부터 새 `PyLongObject` 객체를 반환하거나, 실패하면 `NULL`을 반환합니다.

PyObject *PyLong_FromUnsignedLongLong(unsigned long long v)
  반환값: 새 참조. Part of the 안정 ABI.

  C unsigned long long으로부터 새 `PyLongObject` 객체를 반환하거나, 실패하면 `NULL`을 반환합니다.

PyObject *PyLong_FromDouble(double v)
  반환값: 새 참조. Part of the 안정 ABI.

  v의 정수 부분으로부터 새 `PyLongObject` 객체를 반환하거나, 실패하면 `NULL`을 반환합니다.

PyObject *PyLong_FromString(const char *str, char **pend, int base)
  반환값: 새 참조. Part of the 안정 ABI.

  str의 문자열 값을 기반으로 한 새 `PyLongObject`를 반환하거나, 실패하면 `NULL`을 반환합니다. 문자열 값은 base의 진수(기수)에 따라 해석됩니다. pend가 `NULL`이 아니면, *pend는 성공 시에 str의 끝을 가리키고, 에러 시에 처리할 수 없었던 첫 번째 문자를 가리킵니다. base가 `0`이면, str은 정수 리터럴 정의를 사용해서 해석됩니다; 이때, 0이 아닌 십진수의 선행 0은 `ValueError`를 발생시킵니다. base가 `0`이 아니면, `2`와 `36` 사이에 있어야 하며, 경계를 포함합니다. 선행과 후행 공백과 진수 지정자 뒤나 숫자 사이의 단일 밑줄은 무시됩니다. 숫자가 없거나 str이 숫자와 후행 공백 뒤에 NULL-종료하지 않으면, `ValueError`가 발생합니다.

  더 보기

  Python methods `int.to_bytes()` and `int.from_bytes()` to convert a `PyLongObject` to/from an array of bytes in base `256`. You can call those from C using `PyObject_CallMethod()`.

PyObject *PyLong_FromUnicodeObject(PyObject *u, int base)
  반환값: 새 참조.

  문자열 u에 있는 유니코드 숫자의 시퀀스를 파이썬 정숫값으로 변환합니다.

  Added in version 3.3.

PyObject *PyLong_FromVoidPtr(void *p)
  반환값: 새 참조. Part of the 안정 ABI.

  포인터 p로부터 파이썬 정수를 만듭니다. 포인터 값은 `PyLong_AsVoidPtr()`를 사용하여 결괏값에서 조회할 수 있습니다.

PyObject *PyLong_FromNativeBytes(const void *buffer, size_t n_bytes, int flags)

  Create a Python integer from the value contained in the first n_bytes of buffer, interpreted as a two’s-complement signed number.

  flags are as for `PyLong_AsNativeBytes()`. Passing `-1` will select the native endian that CPython was compiled with and assume that the most-significant bit is a sign bit. Passing `Py_ASNATIVEBYTES_UNSIGNED_BUFFER` will produce the same result as calling `PyLong_FromUnsignedNativeBytes()`. Other flags are ignored.

  Added in version 3.13.

PyObject *PyLong_FromUnsignedNativeBytes(const void *buffer, size_t n_bytes, int flags)

  Create a Python integer from the value contained in the first n_bytes of buffer, interpreted as an unsigned number.

  flags are as for `PyLong_AsNativeBytes()`. Passing `-1` will select the native endian that CPython was compiled with and assume that the most-significant bit is not a sign bit. Flags other than endian are ignored.

  Added in version 3.13.

PyLong_FromPid(pid)

  Macro for creating a Python integer from a process identifier.

  This can be defined as an alias to `PyLong_FromLong()` or `PyLong_FromLongLong()`, depending on the size of the system’s PID type.

  Added in version 3.2.

long PyLong_AsLong(PyObject *obj)
  Part of the 안정 ABI.

  obj의 C long 표현을 반환합니다. obj가 `PyLongObject`의 인스턴스가 아니면, (있다면) 먼저 `__index__()` 메서드를 호출하여 `PyLongObject`로 변환합니다.

  obj의 값이 long의 범위를 벗어나면 `OverflowError`를 발생시킵니다.

  에러 시 `-1`을 반환합니다. 모호성을 제거하려면 `PyErr_Occurred()`를 사용하십시오.

  버전 3.8에서 변경: 사용할 수 있으면 `__index__()`를 사용합니다.

  버전 3.10에서 변경: This function will no longer use `__int__()`.

  long PyLong_AS_LONG(PyObject *obj)

    A soft deprecated alias. Exactly equivalent to the preferred `PyLong_AsLong`. In particular, it can fail with `OverflowError` or another exception.

    버전 3.14부터 폐지됨: The function is soft deprecated.

int PyLong_AsInt(PyObject *obj)
  Part of the 안정 ABI 버전 3.13 이후로.

  Similar to `PyLong_AsLong()`, but store the result in a C int instead of a C long.

  Added in version 3.13.

long PyLong_AsLongAndOverflow(PyObject *obj, int *overflow)
  Part of the 안정 ABI.

  obj의 C long 표현을 반환합니다. obj가 `PyLongObject`의 인스턴스가 아니면, (있다면) 먼저 `__index__()` 메서드를 호출하여 `PyLongObject`로 변환합니다.

  obj의 값이 `LONG_MAX`보다 크거나 `LONG_MIN`보다 작으면, *overflow를 각각 `1`이나 `-1`로 설정하고 `-1`을 반환합니다; 그렇지 않으면, *overflow를 `0`으로 설정합니다. 다른 예외가 발생하면 *overflow를 `0`으로 설정하고 `-1`을 평소와 같이 반환합니다.

  에러 시 `-1`을 반환합니다. 모호성을 제거하려면 `PyErr_Occurred()`를 사용하십시오.

  버전 3.8에서 변경: 사용할 수 있으면 `__index__()`를 사용합니다.

  버전 3.10에서 변경: This function will no longer use `__int__()`.

long long PyLong_AsLongLong(PyObject *obj)
  Part of the 안정 ABI.

  obj의 C long long 표현을 반환합니다. obj가 `PyLongObject`의 인스턴스가 아니면, (있다면) 먼저 `__index__()` 메서드를 호출하여 `PyLongObject`로 변환합니다.

  obj의 값이 long long의 범위를 벗어나면 `OverflowError`를 발생시킵니다.

  에러 시 `-1`을 반환합니다. 모호성을 제거하려면 `PyErr_Occurred()`를 사용하십시오.

  버전 3.8에서 변경: 사용할 수 있으면 `__index__()`를 사용합니다.

  버전 3.10에서 변경: This function will no longer use `__int__()`.

long long PyLong_AsLongLongAndOverflow(PyObject *obj, int *overflow)
  Part of the 안정 ABI.

  obj의 C long long 표현을 반환합니다. obj가 `PyLongObject`의 인스턴스가 아니면, (있다면) 먼저 `__index__()` 메서드를 호출하여 `PyLongObject`로 변환합니다.

  obj의 값이 `LLONG_MAX`보다 크거나 `LLONG_MIN`보다 작으면, *overflow를 각각 `1`이나 `-1`로 설정하고 `-1`을 반환합니다; 그렇지 않으면, *overflow를 `0`으로 설정합니다. 다른 예외가 발생하면 *overflow를 `0`으로 설정하고 `-1`을 평소와 같이 반환합니다.

  에러 시 `-1`을 반환합니다. 모호성을 제거하려면 `PyErr_Occurred()`를 사용하십시오.

  Added in version 3.2.

  버전 3.8에서 변경: 사용할 수 있으면 `__index__()`를 사용합니다.

  버전 3.10에서 변경: This function will no longer use `__int__()`.

Py_ssize_t PyLong_AsSsize_t(PyObject *pylong)
  Part of the 안정 ABI.

  pylong의 C `Py_ssize_t` 표현을 반환합니다. pylong은 `PyLongObject`의 인스턴스여야 합니다.

  pylong의 값이 `Py_ssize_t`의 범위를 벗어나면 `OverflowError`를 발생시킵니다.

  에러 시 `-1`을 반환합니다. 모호성을 제거하려면 `PyErr_Occurred()`를 사용하십시오.

unsigned long PyLong_AsUnsignedLong(PyObject *pylong)
  Part of the 안정 ABI.

  pylong의 C unsigned long 표현을 반환합니다. pylong은 `PyLongObject`의 인스턴스여야 합니다.

  pylong의 값이 unsigned long의 범위를 벗어나면 `OverflowError`를 발생시킵니다.

  에러 시 `(unsigned long)-1`을 반환합니다. 모호성을 제거하려면 `PyErr_Occurred()`를 사용하십시오.

size_t PyLong_AsSize_t(PyObject *pylong)
  Part of the 안정 ABI.

  pylong의 C `size_t` 표현을 반환합니다. pylong은 `PyLongObject`의 인스턴스여야 합니다.

  pylong의 값이 `size_t`의 범위를 벗어나면 `OverflowError`를 발생시킵니다.

  에러 시 `(size_t)-1`을 반환합니다. 모호성을 제거하려면 `PyErr_Occurred()`를 사용하십시오.

unsigned long long PyLong_AsUnsignedLongLong(PyObject *pylong)
  Part of the 안정 ABI.

  pylong의 C unsigned long long 표현을 반환합니다. pylong은 `PyLongObject`의 인스턴스여야 합니다.

  pylong의 값이 unsigned long long의 범위를 벗어나면 `OverflowError`를 발생시킵니다.

  에러 시 `(unsigned long long)-1`을 반환합니다. 모호성을 제거하려면 `PyErr_Occurred()`를 사용하십시오.

  버전 3.1에서 변경: 음의 pylong는 이제 `TypeError`가 아니라 `OverflowError`를 발생시킵니다.

unsigned long PyLong_AsUnsignedLongMask(PyObject *obj)
  Part of the 안정 ABI.

  obj의 C unsigned long 표현을 반환합니다. obj가 `PyLongObject`의 인스턴스가 아니면, (있다면) 먼저 `__index__()` 메서드를 호출하여 `PyLongObject`로 변환합니다.

  obj의 값이 unsigned long의 범위를 벗어나면, 그 값의 모듈로 `ULONG_MAX + 1` 환원을 반환합니다.

  에러 시 `(unsigned long)-1`을 반환합니다. 모호성을 제거하려면 `PyErr_Occurred()`를 사용하십시오.

  버전 3.8에서 변경: 사용할 수 있으면 `__index__()`를 사용합니다.

  버전 3.10에서 변경: This function will no longer use `__int__()`.

unsigned long long PyLong_AsUnsignedLongLongMask(PyObject *obj)
  Part of the 안정 ABI.

  obj의 C unsigned long long 표현을 반환합니다. obj가 `PyLongObject`의 인스턴스가 아니면, (있다면) 먼저 `__index__()` 메서드를 호출하여 `PyLongObject`로 변환합니다.

  obj의 값이 unsigned long long의 범위를 벗어나면, 그 값의 모듈로 `ULLONG_MAX + 1` 환원을 반환합니다.

  에러 시 `(unsigned long long)-1`을 반환합니다. 모호성을 제거하려면 `PyErr_Occurred()`를 사용하십시오.

  버전 3.8에서 변경: 사용할 수 있으면 `__index__()`를 사용합니다.

  버전 3.10에서 변경: This function will no longer use `__int__()`.

double PyLong_AsDouble(PyObject *pylong)
  Part of the 안정 ABI.

  pylong의 C double 표현을 반환합니다. pylong은 `PyLongObject`의 인스턴스여야 합니다.

  pylong의 값이 double의 범위를 벗어나면 `OverflowError`를 발생시킵니다.

  에러 시 `-1.0`을 반환합니다. 모호성을 제거하려면 `PyErr_Occurred()`를 사용하십시오.

void *PyLong_AsVoidPtr(PyObject *pylong)
  Part of the 안정 ABI.

  파이썬 정수 pylong을 C void 포인터로 변환합니다. pylong을 변환할 수 없으면, `OverflowError`가 발생합니다. 이것은 `PyLong_FromVoidPtr()`로 만들어진 값에 대해서만 사용할 수 있는 void 포인터를 생성하는 것이 보장됩니다.

  에러 시 `NULL`을 반환합니다. 모호성을 제거하려면 `PyErr_Occurred()`를 사용하십시오.

PyLong_AsPid(pid)

  Macro for converting a Python integer into a process identifier.

  This can be defined as an alias to `PyLong_AsLong()`, `PyLong_FromLongLong()`, or `PyLong_AsInt()`, depending on the size of the system’s PID type.

  Added in version 3.2.

Py_ssize_t PyLong_AsNativeBytes(PyObject *pylong, void *buffer, Py_ssize_t n_bytes, int flags)

  Copy the Python integer value pylong to a native buffer of size n_bytes. The flags can be set to `-1` to behave similarly to a C cast, or to values documented below to control the behavior.

  Returns `-1` with an exception raised on error. This may happen if pylong cannot be interpreted as an integer, or if pylong was negative and the `Py_ASNATIVEBYTES_REJECT_NEGATIVE` flag was set.

  Otherwise, returns the number of bytes required to store the value. If this is equal to or less than n_bytes, the entire value was copied. All n_bytes of the buffer are written: remaining bytes filled by copies of the sign bit.

  If the returned value is greater than n_bytes, the value was truncated: as many of the lowest bits of the value as could fit are written, and the higher bits are ignored. This matches the typical behavior of a C-style downcast.

  참고

  Overflow is not considered an error. If the returned value is larger than n_bytes, most significant bits were discarded.

  `0` will never be returned.

  Values are always copied as two’s-complement.

  Usage example:

      int32_t value;
      Py_ssize_t bytes = PyLong_AsNativeBytes(pylong, &value, sizeof(value), -1);
      if (bytes < 0) {
          // 실패. 이유와 함께 파이썬 예외가 설정됩니다.
          return NULL;
      }
      else if (bytes <= (Py_ssize_t)sizeof(value)) {
          // 성공!
      }
      else {
          // 오버플로우가 발생했지만, 'value' 에 pylong 의 잘린
          // 하위 비트들이 담깁니다.
      }

  Passing zero to n_bytes will return the size of a buffer that would be large enough to hold the value. This may be larger than technically necessary, but not unreasonably so. If n_bytes=0, buffer may be `NULL`.

  참고

  Passing n_bytes=0 to this function is not an accurate way to determine the bit length of the value.

  To get at the entire Python value of an unknown size, the function can be called twice: first to determine the buffer size, then to fill it:

      // 필요한 공간의 크기를 물어봅니다.
      Py_ssize_t expected = PyLong_AsNativeBytes(pylong, NULL, 0, -1);
      if (expected < 0) {
          // 실패. 이유와 함께 파이썬 예외가 설정됩니다.
          return NULL;
      }
      assert(expected != 0);  // API 정의에 따라 불가능합니다.
      uint8_t *bignum = malloc(expected);
      if (!bignum) {
          PyErr_SetString(PyExc_MemoryError, "bignum malloc failed.");
          return NULL;
      }
      // 안전하게 전체 값을 얻습니다.
      Py_ssize_t bytes = PyLong_AsNativeBytes(pylong, bignum, expected, -1);
      if (bytes < 0) {  // 예외가 설정되었습니다.
          free(bignum);
          return NULL;
      }
      else if (bytes > expected) {  // 이는 불가능해야 합니다.
          PyErr_SetString(PyExc_RuntimeError,
              "Unexpected bignum truncation after a size check.");
          free(bignum);
          return NULL;
      }
      // 위의 사전 점검을 고려할 때 예상되는 성공.
      // ... bignum 을 사용합니다 ...
      free(bignum);

  flags is either `-1` (`Py_ASNATIVEBYTES_DEFAULTS`) to select defaults that behave most like a C cast, or a combination of the other flags in the table below. Note that `-1` cannot be combined with other flags.

  Currently, `-1` corresponds to `Py_ASNATIVEBYTES_NATIVE_ENDIAN | Py_ASNATIVEBYTES_UNSIGNED_BUFFER`.

  플래그 | 값
  --- | ---
  Py_ASNATIVEBYTES_DEFAULTS | `-1`
  Py_ASNATIVEBYTES_BIG_ENDIAN | `0`
  Py_ASNATIVEBYTES_LITTLE_ENDIAN | `1`
  Py_ASNATIVEBYTES_NATIVE_ENDIAN | `3`
  Py_ASNATIVEBYTES_UNSIGNED_BUFFER | `4`
  Py_ASNATIVEBYTES_REJECT_NEGATIVE | `8`
  Py_ASNATIVEBYTES_ALLOW_INDEX | `16`

  Specifying `Py_ASNATIVEBYTES_NATIVE_ENDIAN` will override any other endian flags. Passing `2` is reserved.

  By default, sufficient buffer will be requested to include a sign bit. For example, when converting 128 with n_bytes=1, the function will return 2 (or more) in order to store a zero sign bit.

  If `Py_ASNATIVEBYTES_UNSIGNED_BUFFER` is specified, a zero sign bit will be omitted from size calculations. This allows, for example, 128 to fit in a single-byte buffer. If the destination buffer is later treated as signed, a positive input value may become negative. Note that the flag does not affect handling of negative values: for those, space for a sign bit is always requested.

  Specifying `Py_ASNATIVEBYTES_REJECT_NEGATIVE` causes an exception to be set if pylong is negative. Without this flag, negative values will be copied provided there is enough space for at least one sign bit, regardless of whether `Py_ASNATIVEBYTES_UNSIGNED_BUFFER` was specified.

  If `Py_ASNATIVEBYTES_ALLOW_INDEX` is specified and a non-integer value is passed, its `__index__()` method will be called first. This may result in Python code executing and other threads being allowed to run, which could cause changes to other objects or values in use. When flags is `-1`, this option is not set, and non-integer values will raise `TypeError`.

  참고

  With the default flags (`-1`, or UNSIGNED_BUFFER without REJECT_NEGATIVE), multiple Python integers can map to a single value without overflow. For example, both `255` and `-1` fit a single-byte buffer and set all its bits. This matches typical C cast behavior.

  Added in version 3.13.

PyObject *PyLong_GetInfo(void)
  Part of the 안정 ABI.

  On success, return a read only named tuple, that holds information about Python’s internal representation of integers. See `sys.int_info` for description of individual fields.

  On failure, return `NULL` with an exception set.

  Added in version 3.1.

int PyUnstable_Long_IsCompact(const PyLongObject *op)
  이것은 불안정 API. It may change without warning in minor releases.

  Return 1 if op is compact, 0 otherwise.

  This function makes it possible for performance-critical code to implement a “fast path” for small integers. For compact values use `PyUnstable_Long_CompactValue()`; for others fall back to a `PyLong_As*` function or `PyLong_AsNativeBytes()`.

  The speedup is expected to be negligible for most users.

  Exactly what values are considered compact is an implementation detail and is subject to change.

  Added in version 3.12.

Py_ssize_t PyUnstable_Long_CompactValue(const PyLongObject *op)
  이것은 불안정 API. It may change without warning in minor releases.

  If op is compact, as determined by `PyUnstable_Long_IsCompact()`, return its value.

  Otherwise, the return value is undefined.

  Added in version 3.12.