# 모듈 객체

PyTypeObject PyModule_Type
  Part of the Stable ABI.

  이 `PyTypeObject` 인스턴스는 파이썬 모듈 형을 나타냅니다. 이것은 `types.ModuleType`으로 파이썬 프로그램에 노출됩니다.

int PyModule_Check(PyObject *p)

  p가 모듈 객체이거나 모듈 객체의 서브 형이면 참을 반환합니다. 이 함수는 항상 성공합니다.

int PyModule_CheckExact(PyObject *p)

  p가 모듈 객체이지만, `PyModule_Type`의 서브 형이 아니면 참을 반환합니다. 이 함수는 항상 성공합니다.

PyObject *PyModule_NewObject(PyObject *name)
  Return value: New reference. Part of the Stable ABI since version 3.7.

  Return a new module object with `module.__name__` set to name. The module’s `__name__`, `__doc__`, `__package__` and `__loader__` attributes are filled in (all but `__name__` are set to `None`). The caller is responsible for setting a `__file__` attribute.

  Return `NULL` with an exception set on error.

  Added in version 3.3.

  버전 3.4에서 변경: `__package__` and `__loader__` are now set to `None`.

PyObject *PyModule_New(const char *name)
  Return value: New reference. Part of the Stable ABI.

  `PyModule_NewObject()`와 비슷하지만, name이 유니코드 객체 대신 UTF-8로 인코딩된 문자열입니다.

PyObject *PyModule_GetDict(PyObject *module)
  Return value: Borrowed reference. Part of the Stable ABI.

  module의 이름 공간을 구현하는 딕셔너리 객체를 반환합니다; 이 객체는 모듈 객체의 `__dict__` 어트리뷰트와 같습니다. module이 모듈 객체(또는 모듈 객체의 서브 형)가 아니면, `SystemError`가 발생하고 `NULL`이 반환됩니다.

  It is recommended extensions use other `PyModule_*` and `PyObject_*` functions rather than directly manipulate a module’s `__dict__`.

PyObject *PyModule_GetNameObject(PyObject *module)
  Return value: New reference. Part of the Stable ABI since version 3.7.

  Return module’s `__name__` value. If the module does not provide one, or if it is not a string, `SystemError` is raised and `NULL` is returned.

  Added in version 3.3.

const char *PyModule_GetName(PyObject *module)
  Part of the Stable ABI.

  `PyModule_GetNameObject()`와 비슷하지만 `'utf-8'`로 인코딩된 이름을 반환합니다.

void *PyModule_GetState(PyObject *module)
  Part of the Stable ABI.

  모듈의 “상태”, 즉 모듈 생성 시 할당된 메모리 블록을 가리키는 포인터나 `NULL`을 반환합니다. `PyModuleDef.m_size`를 참조하십시오.

PyModuleDef *PyModule_GetDef(PyObject *module)
  Part of the Stable ABI.

  모듈이 만들어진 `PyModuleDef` 구조체에 대한 포인터나 모듈이 정의에서 만들어지지 않았으면 `NULL`을 반환합니다.

PyObject *PyModule_GetFilenameObject(PyObject *module)
  Return value: New reference. Part of the Stable ABI.

  Return the name of the file from which module was loaded using module’s `__file__` attribute. If this is not defined, or if it is not a string, raise `SystemError` and return `NULL`; otherwise return a reference to a Unicode object.

  Added in version 3.2.

const char *PyModule_GetFilename(PyObject *module)
  Part of the Stable ABI.

  `PyModule_GetFilenameObject()`와 비슷하지만 ‘utf-8’로 인코딩된 파일명을 반환합니다.

  버전 3.2부터 폐지됨: `PyModule_GetFilename()` raises `UnicodeEncodeError` on unencodable filenames, use `PyModule_GetFilenameObject()` instead.

## C 모듈 초기화

모듈 객체는 일반적으로 확장 모듈(초기화 함수를 내보내는 공유 라이브러리)이나 컴파일된 모듈(초기화 함수가 `PyImport_AppendInittab()`을 사용하여 추가된)에서 만들어집니다. 자세한 내용은 C와 C++ 확장 빌드하기나 내장된 파이썬을 확장하기를 참조하십시오.

초기화 함수는 모듈 정의 인스턴스를 `PyModule_Create()`에 전달하고 결과 모듈 객체를 반환하거나, 정의 구조체 자체를 반환하여 “다단계 초기화”를 요청할 수 있습니다.

type PyModuleDef
  Part of the Stable ABI (including all members).

  모듈 객체를 만드는 데 필요한 모든 정보를 담고 있는 모듈 정의 구조체. 일반적으로 각 모듈에 대해 이 형의 정적으로 초기화된 변수가 하나만 있습니다.

  PyModuleDef_Base m_base

    Always initialize this member to `PyModuleDef_HEAD_INIT`.

  const char *m_name

    새 모듈의 이름.

  const char *m_doc

    모듈의 독스트링; 일반적으로 `PyDoc_STRVAR`로 만들어진 독스트링 변수가 사용됩니다.

  Py_ssize_t m_size

    모듈 상태는 정적 전역이 아닌 `PyModule_GetState()`로 조회할 수 있는 모듈별 메모리 영역에 유지될 수 있습니다. 이것은 여러 서브 인터프리터에서 모듈을 사용하는 것을 안전하게 만듭니다.

    This memory area is allocated based on m_size on module creation, and freed when the module object is deallocated, after the `m_free` function has been called, if present.

    `m_size`를 `-1`로 설정하면 모듈이 전역 상태를 갖기 때문에 서브 인터프리터를 지원하지 않는다는 뜻입니다.

    음수가 아닌 값으로 설정하면 모듈을 다시 초기화 할 수 있다는 뜻이며 상태에 필요한 추가 메모리양을 지정합니다. 다단계 초기화에는 음이 아닌 `m_size`가 필요합니다.

    자세한 내용은 PEP 3121을 참조하십시오.

  PyMethodDef *m_methods

    `PyMethodDef` 값으로 기술되는 모듈 수준 함수 테이블에 대한 포인터. 함수가 없으면 `NULL`일 수 있습니다.

  PyModuleDef_Slot *m_slots

    다단계 초기화를 위한 슬롯 정의 배열, `{0, NULL}` 항목으로 종료됩니다. 단단계 초기화를 사용할 때, m_slots는 `NULL`이어야 합니다.

    버전 3.5에서 변경: 버전 3.5 이전에는, 이 멤버가 항상 `NULL`로 설정되었으며, 다음과 같이 정의되었습니다:

    > inquiry m_reload

  traverseproc m_traverse

    모듈 객체의 GC 탐색 중 호출할 탐색 함수나, 필요하지 않으면 `NULL`.

    This function is not called if the module state was requested but is not allocated yet. This is the case immediately after the module is created and before the module is executed (`Py_mod_exec` function). More precisely, this function is not called if `m_size` is greater than 0 and the module state (as returned by `PyModule_GetState()`) is `NULL`.

    버전 3.9에서 변경: 모듈 상태가 할당되기 전에 더는 호출되지 않습니다.

  inquiry m_clear

    모듈 객체의 GC 정리 중에 호출할 정리(clear) 함수나, 필요하지 않으면 `NULL`.

    This function is not called if the module state was requested but is not allocated yet. This is the case immediately after the module is created and before the module is executed (`Py_mod_exec` function). More precisely, this function is not called if `m_size` is greater than 0 and the module state (as returned by `PyModule_GetState()`) is `NULL`.

    Like `PyTypeObject.tp_clear`, this function is not always called before a module is deallocated. For example, when reference counting is enough to determine that an object is no longer used, the cyclic garbage collector is not involved and `m_free` is called directly.

    버전 3.9에서 변경: 모듈 상태가 할당되기 전에 더는 호출되지 않습니다.

  freefunc m_free

    모듈 객체 할당 해제 중에 호출할 함수나, 필요하지 않으면 `NULL`.

    This function is not called if the module state was requested but is not allocated yet. This is the case immediately after the module is created and before the module is executed (`Py_mod_exec` function). More precisely, this function is not called if `m_size` is greater than 0 and the module state (as returned by `PyModule_GetState()`) is `NULL`.

    버전 3.9에서 변경: 모듈 상태가 할당되기 전에 더는 호출되지 않습니다.

### 단단계 초기화

모듈 초기화 함수는 모듈 객체를 직접 만들고 반환할 수 있습니다. 이것을 “단단계 초기화”라고 하며, 다음 두 모듈 생성 함수 중 하나를 사용합니다:

PyObject *PyModule_Create(PyModuleDef *def)
  Return value: New reference.

  Create a new module object, given the definition in def. This behaves like `PyModule_Create2()` with module_api_version set to `PYTHON_API_VERSION`.

PyObject *PyModule_Create2(PyModuleDef *def, int module_api_version)
  Return value: New reference. Part of the Stable ABI.

  def의 정의에 따라, API 버전 module_api_version을 가정하여 새 모듈 객체를 만듭니다. 해당 버전이 실행 중인 인터프리터 버전과 일치하지 않으면, `RuntimeWarning`을 발생시킵니다.

  Return `NULL` with an exception set on error.

  참고

  이 함수는 대부분 `PyModule_Create()`를 대신 사용해야 합니다; 확실히 필요할 때만 사용하십시오.

Before it is returned from in the initialization function, the resulting module object is typically populated using functions like `PyModule_AddObjectRef()`.

### 다단계 초기화

An alternate way to specify extensions is to request “multi-phase initialization”. Extension modules created this way behave more like Python modules: the initialization is split between the creation phase, when the module object is created, and the execution phase, when it is populated. The distinction is similar to the `__new__()` and `__init__()` methods of classes.

Unlike modules created using single-phase initialization, these modules are not singletons: if the sys.modules entry is removed and the module is re-imported, a new module object is created, and the old module is subject to normal garbage collection – as with Python modules. By default, multiple modules created from the same definition should be independent: changes to one should not affect the others. This means that all state should be specific to the module object (using e.g. using `PyModule_GetState()`), or its contents (such as the module’s `__dict__` or individual classes created with `PyType_FromSpec()`).

다단계 초기화를 사용하여 만들어진 모든 모듈은 서브 인터프리터를 지원할 것으로 기대됩니다. 다중 모듈을 독립적으로 유지하는 것은 일반적으로 이를 달성하기에 충분합니다.

다단계 초기화를 요청하기 위해, 초기화 함수(PyInit_modulename)는 비어 있지 않은 `m_slots`를 가진 `PyModuleDef` 인스턴스를 반환합니다. 반환되기 전에, `PyModuleDef` 인스턴스를 다음 함수를 사용하여 초기화해야 합니다:

PyObject *PyModuleDef_Init(PyModuleDef *def)
  Return value: Borrowed reference. Part of the Stable ABI since version 3.5.

  모듈 정의가 형과 참조 횟수를 올바르게 보고하는 올바르게 초기화된 파이썬 객체이게 합니다.

  def를 `PyObject*`로 캐스트 하거나, 에러가 발생하면 `NULL`을 반환합니다.

  Added in version 3.5.

모듈 정의의 m_slots 멤버는 `PyModuleDef_Slot` 구조체의 배열을 가리켜야 합니다:

type PyModuleDef_Slot
  int slot

    아래 설명된 사용 가능한 값 중에서 선택된, 슬롯 ID.

  void *value

    슬롯 ID에 따라 그 의미가 달라지는, 슬롯의 값.

  Added in version 3.5.

m_slots 배열은 id가 0인 슬롯으로 종료해야 합니다.

사용 가능한 슬롯 형은 다음과 같습니다:

Py_mod_create

  모듈 객체 자체를 만들기 위해 호출되는 함수를 지정합니다. 이 슬롯의 value 포인터는 다음과 같은 서명을 갖는 함수를 가리켜야 합니다:

  PyObject *create_module(PyObject *spec, PyModuleDef *def)

  이 함수는 PEP 451에 정의된 대로, `ModuleSpec` 인스턴스와 모듈 정의를 받습니다. 새 모듈 객체를 반환하거나, 에러를 설정하고 `NULL`을 반환해야 합니다.

  이 함수는 최소한으로 유지해야 합니다. 특히 같은 모듈을 다시 임포트 하려고 시도하면 무한 루프가 발생할 수 있어서, 임의의 파이썬 코드를 호출하면 안 됩니다.

  하나의 모듈 정의에서 여러 `Py_mod_create` 슬롯을 지정할 수 없습니다.

  `Py_mod_create`를 지정하지 않으면, 임포트 절차는 `PyModule_New()`를 사용하여 일반 모듈 객체를 만듭니다. 이름은 정의가 아니라 spec에서 취합니다, 확장 모듈이 단일 모듈 정의를 공유하면서 모듈 계층 구조에서 해당 위치에 동적으로 조정되고 심볼릭 링크를 통해 다른 이름으로 임포트 될 수 있도록 하기 위함입니다.

  반환된 객체가 `PyModule_Type`의 인스턴스 일 필요는 없습니다. 임포트 관련 어트리뷰트 설정과 읽기를 지원하는 한 모든 형을 사용할 수 있습니다. 그러나, `PyModuleDef`에 `NULL`이 아닌 `m_traverse`, `m_clear`, `m_free`; 0이 아닌 `m_size`; 또는 `Py_mod_create` 이외의 슬롯이 있으면, `PyModule_Type` 인스턴스 만 반환될 수 있습니다.

Py_mod_exec

  모듈을 실행하기 위해 호출되는 함수를 지정합니다. 이것은 파이썬 모듈의 코드를 실행하는 것과 동등합니다: 일반적으로, 이 함수는 클래스와 상수를 모듈에 추가합니다. 함수의 서명은 다음과 같습니다:

  int exec_module(PyObject *module)

  여러 개의 `Py_mod_exec` 슬롯이 지정되면, m_slots 배열에 나타나는 순서대로 처리됩니다.

Py_mod_multiple_interpreters

  Specifies one of the following values:

  Py_MOD_MULTIPLE_INTERPRETERS_NOT_SUPPORTED

    The module does not support being imported in subinterpreters.

  Py_MOD_MULTIPLE_INTERPRETERS_SUPPORTED

    The module supports being imported in subinterpreters, but only when they share the main interpreter’s GIL. (See Isolating Extension Modules.)

  Py_MOD_PER_INTERPRETER_GIL_SUPPORTED

    The module supports being imported in subinterpreters, even when they have their own GIL. (See Isolating Extension Modules.)

  This slot determines whether or not importing this module in a subinterpreter will fail.

  Multiple `Py_mod_multiple_interpreters` slots may not be specified in one module definition.

  If `Py_mod_multiple_interpreters` is not specified, the import machinery defaults to `Py_MOD_MULTIPLE_INTERPRETERS_SUPPORTED`.

  Added in version 3.12.

다단계 초기화에 대한 자세한 내용은 PEP 489를 참조하십시오.

### 저수준 모듈 생성 함수

다단계 초기화를 사용할 때 수면 아래에서는 다음 함수가 호출됩니다. 이들은 직접 사용할 수 있는데, 예를 들어 모듈 객체를 동적으로 생성할 때 그렇습니다. 모듈을 완전히 초기화하려면 `PyModule_FromDefAndSpec`과 `PyModule_ExecDef`를 모두 호출해야 함에 유의하십시오.

PyObject *PyModule_FromDefAndSpec(PyModuleDef *def, PyObject *spec)
  Return value: New reference.

  Create a new module object, given the definition in def and the ModuleSpec spec. This behaves like `PyModule_FromDefAndSpec2()` with module_api_version set to `PYTHON_API_VERSION`.

  Added in version 3.5.

PyObject *PyModule_FromDefAndSpec2(PyModuleDef *def, PyObject *spec, int module_api_version)
  Return value: New reference. Part of the Stable ABI since version 3.7.

  Create a new module object, given the definition in def and the ModuleSpec spec, assuming the API version module_api_version. If that version does not match the version of the running interpreter, a `RuntimeWarning` is emitted.

  Return `NULL` with an exception set on error.

  참고

  이 함수는 대부분 `PyModule_FromDefAndSpec()`을 대신 사용해야 합니다; 확실히 필요할 때만 사용하십시오.

  Added in version 3.5.

int PyModule_ExecDef(PyObject *module, PyModuleDef *def)
  Part of the Stable ABI since version 3.7.

  def에 지정된 모든 실행 슬롯(`Py_mod_exec`)을 처리합니다.

  Added in version 3.5.

int PyModule_SetDocString(PyObject *module, const char *docstring)
  Part of the Stable ABI since version 3.7.

  module의 독스트링을 docstring으로 설정합니다. 이 함수는 `PyModule_Create`나 `PyModule_FromDefAndSpec`을 사용하여 `PyModuleDef`에서 모듈을 만들 때 자동으로 호출됩니다.

  Added in version 3.5.

int PyModule_AddFunctions(PyObject *module, PyMethodDef *functions)
  Part of the Stable ABI since version 3.7.

  `NULL` 종료 functions 배열의 함수를 module에 추가합니다. 개별 항목에 대한 자세한 내용은 `PyMethodDef` 설명서를 참조하십시오 (공유 모듈 이름 공간이 없기 때문에, C로 구현된 모듈 수준 “함수(functions)”는 일반적으로 첫 번째 매개 변수로 모듈을 수신하여, 파이썬 클래스의 인스턴스 메서드와 유사하게 만듭니다). 이 함수는 `PyModule_Create`나 `PyModule_FromDefAndSpec`을 사용하여 `PyModuleDef`에서 모듈을 만들 때 자동으로 호출됩니다.

  Added in version 3.5.

### 지원 함수

모듈 초기화 함수(단단계 초기화를 사용하는 경우)나 모듈 실행 슬롯에서 호출되는 함수(다단계 초기화를 사용하는 경우)는, 모듈 상태 초기화를 도우려고 다음 함수를 사용할 수 있습니다:

int PyModule_AddObjectRef(PyObject *module, const char *name, PyObject *value)
  Part of the Stable ABI since version 3.10.

  Add an object to module as name. This is a convenience function which can be used from the module’s initialization function.

  On success, return `0`. On error, raise an exception and return `-1`.

  Example usage:

      static int
      add_spam(PyObject *module, int value)
      {
          PyObject *obj = PyLong_FromLong(value);
          if (obj == NULL) {
              return -1;
          }
          int res = PyModule_AddObjectRef(module, "spam", obj);
          Py_DECREF(obj);
          return res;
       }

  To be convenient, the function accepts `NULL` value with an exception set. In this case, return `-1` and just leave the raised exception unchanged.

  The example can also be written without checking explicitly if obj is `NULL`:

      static int
      add_spam(PyObject *module, int value)
      {
          PyObject *obj = PyLong_FromLong(value);
          int res = PyModule_AddObjectRef(module, "spam", obj);
          Py_XDECREF(obj);
          return res;
       }

  Note that `Py_XDECREF()` should be used instead of `Py_DECREF()` in this case, since obj can be `NULL`.

  The number of different name strings passed to this function should be kept small, usually by only using statically allocated strings as name. For names that aren’t known at compile time, prefer calling `PyUnicode_FromString()` and `PyObject_SetAttr()` directly. For more details, see `PyUnicode_InternFromString()`, which may be used internally to create a key object.

  Added in version 3.10.

int PyModule_AddObject(PyObject *module, const char *name, PyObject *value)
  Part of the Stable ABI.

  Similar to `PyModule_AddObjectRef()`, but steals a reference to value on success (if it returns `0`).

  The new `PyModule_AddObjectRef()` function is recommended, since it is easy to introduce reference leaks by misusing the `PyModule_AddObject()` function.

  참고

  Unlike other functions that steal references, `PyModule_AddObject()` only releases the reference to value on success.

  This means that its return value must be checked, and calling code must `Py_DECREF()` value manually on error.

  Example usage:

      static int
      add_spam(PyObject *module, int value)
      {
          PyObject *obj = PyLong_FromLong(value);
          if (obj == NULL) {
              return -1;
          }
          if (PyModule_AddObject(module, "spam", obj) < 0) {
              Py_DECREF(obj);
              return -1;
          }
          // PyModule_AddObject() stole a reference to obj:
          // Py_DECREF(obj) is not needed here
          return 0;
      }

  The example can also be written without checking explicitly if obj is `NULL`:

      static int
      add_spam(PyObject *module, int value)
      {
          PyObject *obj = PyLong_FromLong(value);
          if (PyModule_AddObject(module, "spam", obj) < 0) {
              Py_XDECREF(obj);
              return -1;
          }
          // PyModule_AddObject() stole a reference to obj:
          // Py_DECREF(obj) is not needed here
          return 0;
      }

  Note that `Py_XDECREF()` should be used instead of `Py_DECREF()` in this case, since obj can be `NULL`.

int PyModule_AddIntConstant(PyObject *module, const char *name, long value)
  Part of the Stable ABI.

  Add an integer constant to module as name. This convenience function can be used from the module’s initialization function. Return `-1` with an exception set on error, `0` on success.

  This is a convenience function that calls `PyLong_FromLong()` and `PyModule_AddObjectRef()`; see their documentation for details.

int PyModule_AddStringConstant(PyObject *module, const char *name, const char *value)
  Part of the Stable ABI.

  Add a string constant to module as name. This convenience function can be used from the module’s initialization function. The string value must be `NULL`-terminated. Return `-1` with an exception set on error, `0` on success.

  This is a convenience function that calls `PyUnicode_InternFromString()` and `PyModule_AddObjectRef()`; see their documentation for details.

PyModule_AddIntMacro(module, macro)

  Add an int constant to module. The name and the value are taken from macro. For example `PyModule_AddIntMacro(module, AF_INET)` adds the int constant AF_INET with the value of AF_INET to module. Return `-1` with an exception set on error, `0` on success.

PyModule_AddStringMacro(module, macro)

  module에 문자열 상수를 추가합니다.

int PyModule_AddType(PyObject *module, PyTypeObject *type)
  Part of the Stable ABI since version 3.10.

  Add a type object to module. The type object is finalized by calling internally `PyType_Ready()`. The name of the type object is taken from the last component of `tp_name` after dot. Return `-1` with an exception set on error, `0` on success.

  Added in version 3.9.

## 모듈 조회

단단계 초기화는 현재 인터프리터의 컨텍스트에서 조회할 수 있는 싱글톤 모듈을 만듭니다. 이는 나중에 모듈 정의에 대한 참조만으로 모듈 객체를 검색할 수 있도록 합니다.

이 함수들은 다단계 초기화를 사용하여 만들어진 모듈에서는 작동하지 않습니다. 단일 정의에서 그러한 모듈이 여러 개 만들어질 수 있기 때문입니다.

PyObject *PyState_FindModule(PyModuleDef *def)
  Return value: Borrowed reference. Part of the Stable ABI.

  현재 인터프리터에 대해 def에서 만들어진 모듈 객체를 반환합니다. 이 메서드를 사용하려면 먼저 모듈 객체가 `PyState_AddModule()`로 인터프리터 상태에 연결되어 있어야 합니다. 해당 모듈 객체를 찾을 수 없거나 인터프리터 상태에 아직 연결되지 않았으면, `NULL`을 반환합니다.

int PyState_AddModule(PyObject *module, PyModuleDef *def)
  Part of the Stable ABI since version 3.3.

  함수에 전달된 모듈 객체를 인터프리터 상태에 연결합니다. 이는 `PyState_FindModule()`을 통해 모듈 객체에 액세스 할 수 있도록 합니다.

  단단계 초기화를 사용하여 만든 모듈에만 효과가 있습니다.

  파이썬은 모듈을 임포트 한 후 자동으로 `PyState_AddModule`을 호출하므로, 모듈 초기화 코드에서 호출하는 것은 불필요합니다 (하지만 무해합니다). 모듈의 자체 초기화 코드가 추후 `PyState_FindModule`을 호출하는 경우에만 명시적인 호출이 필요합니다. 이 함수는 주로 대안 임포트 메커니즘을 구현하기 위한 것입니다 (직접 호출하거나, 필요한 상태 갱신에 대한 자세한 내용에 대해 해당 구현을 참조함으로써).

  호출자는 GIL을 보유해야 합니다.

  Return `-1` with an exception set on error, `0` on success.

  Added in version 3.3.

int PyState_RemoveModule(PyModuleDef *def)
  Part of the Stable ABI since version 3.3.

  Removes the module object created from def from the interpreter state. Return `-1` with an exception set on error, `0` on success.

  호출자는 GIL을 보유해야 합니다.

  Added in version 3.3.