# モジュールオブジェクト (module object)

PyTypeObject PyModule_Type
  次に属します: Stable ABI.

  This instance of `PyTypeObject` represents the Python module type. This is exposed to Python programs as `types.ModuleType`.

int PyModule_Check(PyObject *p)

  p がモジュールオブジェクトかモジュールオブジェクトのサブタイプであるときに真を返します。この関数は常に成功します。

int PyModule_CheckExact(PyObject *p)

  p がモジュールオブジェクトで、かつ `PyModule_Type` のサブタイプでないときに真を返します。この関数は常に成功します。

PyObject *PyModule_NewObject(PyObject *name)
  戻り値: 新しい参照。 次に属します: Stable ABI (バージョン 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)
  戻り値: 新しい参照。 次に属します: Stable ABI.

  `PyModule_NewObject()` に似ていますが、 name は Unicode オブジェクトではなく UTF-8 でエンコードされた文字列です。

PyObject *PyModule_GetDict(PyObject *module)
  戻り値: 借用参照。 次に属します: Stable ABI.

  module の名前空間を実装する辞書オブジェクトを返します; このオブジェクトは、モジュールオブジェクトの `__dict__` 属性と同じものです。 module がモジュールオブジェクト (もしくはモジュールオブジェクトのサブタイプ) でない場合は、 `SystemError` が送出され `NULL` が返されます。

  拡張モジュールでは、モジュールの `__dict__` を直接操作するよりも、 `PyModule_*` および `PyObject_*` 関数を使う方が推奨されます。

  The returned reference is borrowed from the module; it is valid until the module is destroyed.

PyObject *PyModule_GetNameObject(PyObject *module)
  戻り値: 新しい参照。 次に属します: Stable ABI (バージョン 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)
  次に属します: Stable ABI.

  `PyModule_GetNameObject()` に似ていますが、 `'utf-8'` でエンコードされた name を返します。

  The returned buffer is only valid until the module is renamed or destroyed. Note that Python code may rename a module by setting its `__name__` attribute.

void *PyModule_GetState(PyObject *module)
  次に属します: Stable ABI.

  モジュールの "state"(モジュールを生成したタイミングで確保されるメモリブロックへのポインター) か、なければ `NULL` を返します。 `PyModuleDef.m_size` を参照してください。

PyModuleDef *PyModule_GetDef(PyObject *module)
  次に属します: Stable ABI.

  モジュールが作られる元となった `PyModuleDef` 構造体へのポインタを返します。 モジュールが定義によって作られていなかった場合は `NULL` を返します。

  On error, return `NULL` with an exception set. Use `PyErr_Occurred()` to tell this case apart from a missing `PyModuleDef`.

PyObject *PyModule_GetFilenameObject(PyObject *module)
  戻り値: 新しい参照。 次に属します: 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)
  次に属します: Stable ABI.

  `PyModule_GetFilenameObject()` と似ていますが、 'utf-8' でエンコードされたファイル名を返します。

  The returned buffer is only valid until the module's `__file__` attribute is reassigned or the module is destroyed.

  バージョン 3.2 で非推奨: `PyModule_GetFilename()` はエンコードできないファイル名に対しては `UnicodeEncodeError` を送出します。これの代わりに `PyModule_GetFilenameObject()` を使用してください。

# Module definitions

The functions in the previous section work on any module object, including modules imported from Python code.

Modules defined using the C API typically use a module definition, `PyModuleDef` -- a statically allocated, constant “description" of how a module should be created.

The definition is usually used to define an extension's “main” module object (see 拡張モジュールの定義 for details). It is also used to create extension modules dynamically.

Unlike `PyModule_New()`, the definition allows management of module state -- a piece of memory that is allocated and cleared together with the module object. Unlike the module's Python attributes, Python code cannot replace or delete data stored in module state.

type PyModuleDef
  次に属します: Stable ABI (すべてのメンバーを含む).

  The module definition struct, which holds all information needed to create a module object. This structure must be statically allocated (or be otherwise guaranteed to be valid while any modules created from it exist). Usually, there is only one variable of this type for each extension module.

  PyModuleDef_Base m_base

    このメンバーは常に `PyModuleDef_HEAD_INIT` で初期化してください。

  const char *m_name

    新しいモジュールの名前。

  const char *m_doc

    モジュールの docstring。たいてい docstring は `PyDoc_STRVAR` を利用して生成されます。

  Py_ssize_t m_size

    モジュールの状態は、静的なグローバルな領域ではなく `PyModule_GetState()` で取得できるモジュールごとのメモリ領域に保持されていることがあります。 これによってモジュールは複数のサブ・インタプリターで安全に使えます。

    このメモリ領域は m_size に基づいてモジュール作成時に確保され、モジュールオブジェクトが破棄されるときに、 `m_free` 関数があればそれが呼ばれた後で解放されます。

    Setting it to a non-negative value means that the module can be re-initialized and specifies the additional amount of memory it requires for its state.

    Setting `m_size` to `-1` means that the module does not support sub-interpreters, because it has global state. Negative `m_size` is only allowed when using legacy single-phase initialization or when creating modules dynamically.

    詳細は PEP 3121 を参照。

  PyMethodDef *m_methods

    `PyMethodDef` で定義される、モジュールレベル関数のテーブルへのポインター。関数が存在しない場合は `NULL` を設定することが可能。

  PyModuleDef_Slot *m_slots

    An array of slot definitions for multi-phase initialization, terminated by a `{0, NULL}` entry. When using legacy single-phase initialization, m_slots must be `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 で変更: No longer called before the module state is allocated.

  inquiry m_clear

    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`.

    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 で変更: No longer called before the module state is allocated.

  freefunc m_free

    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 で変更: No longer called before the module state is allocated.

## Module slots

type PyModuleDef_Slot
  次に属します: Stable ABI (すべてのメンバーを含む) (バージョン 3.5 より).
  int slot

    スロット ID で、以下で説明されている利用可能な値から選ばれます。

  void *value

    スロットの値で、意味はスロット ID に依存します。

  Added in version 3.5.

利用可能なスロットの型は以下です:

Py_mod_create
  次に属します: Stable ABI (バージョン 3.5 より).

  モジュールオブジェクト自身を生成するために呼ばれる関数を指定します。 このスロットの value ポインタは次のシグネチャを持つ関数を指していなくてはいけません:

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

  PEP 451 で定義された `ModuleSpec` インスタンスと、モジュール定義を受け取る関数です。 これは新しいモジュールオブジェクトを返すか、エラーを設定して `NULL` を返すべきです。

  この関数は最小限に留めておくべきです。 特に任意のPythonコードを呼び出すべきではなく、同じモジュールをインポートしようとすると無限ループに陥るでしょう。

  複数の `Py_mod_create` スロットを1つのモジュール定義に設定しない方がよいです。

  `Py_mod_create` が設定されていない場合は、インポート機構は `PyModule_New()` を使って通常のモジュールオブジェクトを生成します。 モジュールの名前は定義ではなく spec から取得され、これによって拡張モジュールが動的にモジュール階層における位置を調整できたり、シンボリックリンクを通して同一のモジュール定義を共有しつつ別の名前でインポートできたりします。

  返されるオブジェクトが `PyModule_Type` のインスタンスである必要はありません。 インポートに関連する属性の設定と取得ができる限りは、どんな型でも使えます。 しかし、 `PyModuleDef` が `NULL` でない `m_traverse`, `m_clear`, `m_free` 、もしくはゼロでない `m_size` 、もしくは `Py_mod_create` 以外のスロットを持つ場合は、 `PyModule_Type` インスタンスのみが返されるでしょう。

  Added in version 3.5.

Py_mod_exec
  次に属します: Stable ABI (バージョン 3.5 より).

  モジュールを 実行する ときに呼ばれる関数を指定します。 これはPythonモジュールのコードを実行するのと同等です: この関数はたいていはクラスと定数をモジュールにします。 この関数のシグネチャは以下です:

  int exec_module(PyObject *module)

  複数の `Py_mod_exec` スロットが設定されていた場合は、 m_slots 配列に現れた順に処理されていきます。

  Added in version 3.5.

Py_mod_multiple_interpreters
  次に属します: Stable ABI (バージョン 3.12 より).

  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 拡張モジュールを分離する.)

  Py_MOD_PER_INTERPRETER_GIL_SUPPORTED

    The module supports being imported in subinterpreters, even when they have their own GIL. (See 拡張モジュールを分離する.)

  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.

Py_mod_gil
  次に属します: Stable ABI (バージョン 3.13 より).

  Specifies one of the following values:

  Py_MOD_GIL_USED

    The module depends on the presence of the global interpreter lock (GIL), and may access global state without synchronization.

  Py_MOD_GIL_NOT_USED

    The module is safe to run without an active GIL.

  This slot is ignored by Python builds not configured with `--disable-gil`. Otherwise, it determines whether or not importing this module will cause the GIL to be automatically enabled. See フリースレッドの CPython for more detail.

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

  If `Py_mod_gil` is not specified, the import machinery defaults to `Py_MOD_GIL_USED`.

  Added in version 3.13.

# Creating extension modules dynamically

The following functions may be used to create a module outside of an extension's initialization function. They are also used in single-phase initialization.

PyObject *PyModule_Create(PyModuleDef *def)
  戻り値: 新しい参照。

  Create a new module object, given the definition in def. This is a macro that calls `PyModule_Create2()` with module_api_version set to `PYTHON_API_VERSION`, or to `PYTHON_ABI_VERSION` if using the limited API.

PyObject *PyModule_Create2(PyModuleDef *def, int module_api_version)
  戻り値: 新しい参照。 次に属します: Stable ABI.

  APIバージョンを module_api_version として def での定義に従って新しいモジュールオブジェクトを生成します。 もし指定されたバージョンが実行しているインタープリターのバージョンと異なる場合は、 `RuntimeWarning` を発生させます。

  Return `NULL` with an exception set on error.

  This function does not support slots. The `m_slots` member of def must be `NULL`.

  注釈

  ほとんどの場合、この関数ではなく `PyModule_Create()` を利用するべきです。この関数は、この関数の必要性を理解しているときにだけ利用してください。

PyObject *PyModule_FromDefAndSpec(PyModuleDef *def, PyObject *spec)
  戻り値: 新しい参照。

  This macro calls `PyModule_FromDefAndSpec2()` with module_api_version set to `PYTHON_API_VERSION`, or to `PYTHON_ABI_VERSION` if using the limited API.

  Added in version 3.5.

PyObject *PyModule_FromDefAndSpec2(PyModuleDef *def, PyObject *spec, int module_api_version)
  戻り値: 新しい参照。 次に属します: Stable ABI (バージョン 3.7 より).

  APIバージョンを module_api_version として、 def と ModuleSpec オブジェクトの spec で定義されたとおりに新しいモジュールオブジェクトを生成します。 もし指定されたバージョンが実行しているインタープリターのバージョンと異なる場合は、 `RuntimeWarning` を発生させます。

  Return `NULL` with an exception set on error.

  Note that this does not process execution slots (`Py_mod_exec`). Both `PyModule_FromDefAndSpec` and `PyModule_ExecDef` must be called to fully initialize a module.

  注釈

  ほとんどの場合、この関数ではなく `PyModule_FromDefAndSpec()` を利用するべきです。 この関数は、この関数の必要性を理解しているときにだけ利用してください。

  Added in version 3.5.

int PyModule_ExecDef(PyObject *module, PyModuleDef *def)
  次に属します: Stable ABI (バージョン 3.7 より).

  def で与えられた任意の実行スロット (`Py_mod_exec`) を実行します。

  Added in version 3.5.

PYTHON_API_VERSION

  The C API version. Defined for backwards compatibility.

  Currently, this constant is not updated in new Python versions, and is not useful for versioning. This may change in the future.

PYTHON_ABI_VERSION

  Defined as `3` for backwards compatibility.

  Currently, this constant is not updated in new Python versions, and is not useful for versioning. This may change in the future.

# サポート関数

The following functions are provided to help initialize a module state. They are intended for a module's execution slots (`Py_mod_exec`), the initialization function for legacy single-phase initialization, or code that creates modules dynamically.

int PyModule_AddObjectRef(PyObject *module, const char *name, PyObject *value)
  次に属します: Stable ABI (バージョン 3.10 より).

  module にオブジェクトを name として追加します。 この関数はモジュールの初期化関数から利用される便利関数です。

  成功すると `0` を返し、エラーになると例外を送出して `-1` を返します。

  使用例:

      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.

  この例は、明示的に obj が `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;
       }

  この場合は、 obj が `NULL` でありうるため、 `Py_DECREF()` の代わりに `Py_XDECREF()` を呼び出す必要があることに注意してください。

  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_Add(PyObject *module, const char *name, PyObject *value)
  次に属します: Stable ABI (バージョン 3.13 より).

  Similar to `PyModule_AddObjectRef()`, but "steals" a reference to value. It can be called with a result of function that returns a new reference without bothering to check its result or even saving it to a variable.

  使用例:

      if (PyModule_Add(module, "spam", PyBytes_FromString(value)) < 0) {
          goto error;
      }

  Added in version 3.13.

int PyModule_AddObject(PyObject *module, const char *name, PyObject *value)
  次に属します: Stable ABI.

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

  The new `PyModule_Add()` or `PyModule_AddObjectRef()` functions are 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_XDECREF()` value manually on error.

  使用例:

      PyObject *obj = PyBytes_FromString(value);
      if (PyModule_AddObject(module, "spam", obj) < 0) {
          // If 'obj' is not NULL and PyModule_AddObject() failed,
          // 'obj' strong reference must be deleted with Py_XDECREF().
          // If 'obj' is NULL, Py_XDECREF() does nothing.
          Py_XDECREF(obj);
          goto error;
      }
      // PyModule_AddObject() stole a reference to obj:
      // Py_XDECREF(obj) is not needed here.

  バージョン 3.13 で非推奨: `PyModule_AddObject()` is soft deprecated.

int PyModule_AddIntConstant(PyObject *module, const char *name, long value)
  次に属します: 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)
  次に属します: 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)
  次に属します: Stable ABI (バージョン 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.

int PyModule_AddFunctions(PyObject *module, PyMethodDef *functions)
  次に属します: Stable ABI (バージョン 3.7 より).

  Add the functions from the `NULL` terminated functions array to module. Refer to the `PyMethodDef` documentation for details on individual entries (due to the lack of a shared module namespace, module level "functions" implemented in C typically receive the module as their first parameter, making them similar to instance methods on Python classes).

  This function is called automatically when creating a module from `PyModuleDef` (such as when using 多段階初期化, `PyModule_Create`, or `PyModule_FromDefAndSpec`). Some module authors may prefer defining functions in multiple `PyMethodDef` arrays; in that case they should call this function directly.

  The functions array must be statically allocated (or otherwise guaranteed to outlive the module object).

  Added in version 3.5.

int PyModule_SetDocString(PyObject *module, const char *docstring)
  次に属します: Stable ABI (バージョン 3.7 より).

  Set the docstring for module to docstring. This function is called automatically when creating a module from `PyModuleDef` (such as when using 多段階初期化, `PyModule_Create`, or `PyModule_FromDefAndSpec`).

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

  Added in version 3.5.

int PyUnstable_Module_SetGIL(PyObject *module, void *gil)
  これは Unstable APIです。マイナーリリースで予告なく変更されることがあります。

  Indicate that module does or does not support running without the global interpreter lock (GIL), using one of the values from `Py_mod_gil`. It must be called during module's initialization function when using 従来の一段階初期化. If this function is not called during module initialization, the import machinery assumes the module does not support running without the GIL. This function is only available in Python builds configured with `--disable-gil`. Return `-1` with an exception set on error, `0` on success.

  Added in version 3.13.

## Module lookup (single-phase initialization)

The legacy single-phase initialization initialization scheme creates singleton modules that can be looked up in the context of the current interpreter. This allows the module object to be retrieved later with only a reference to the module definition.

多段階初期化を使うと単一の定義から複数のモジュールが作成できるので、これらの関数は多段階初期化を使って作成されたモジュールには使えません。

PyObject *PyState_FindModule(PyModuleDef *def)
  戻り値: 借用参照。 次に属します: Stable ABI.

  現在のインタプリタの def から作られたモジュールオブジェクトを返します。このメソッドの前提条件として、前もって `PyState_AddModule()` でインタプリタの state にモジュールオブジェクトを連結しておくことを要求します。対応するモジュールオブジェクトが見付からない、もしくは事前にインタプリタの state に連結されていない場合は、 `NULL` を返します。

int PyState_AddModule(PyObject *module, PyModuleDef *def)
  次に属します: Stable ABI (バージョン 3.3 より).

  関数に渡されたモジュールオブジェクトを、インタプリタの state に連結します。この関数を使うことで `PyState_FindModule()` からモジュールオブジェクトにアクセスできるようになります。

  一段階初期化を使って作成されたモジュールにのみ有効です。

  Python calls `PyState_AddModule` automatically after importing a module that uses single-phase initialization, so it is unnecessary (but harmless) to call it from module initialization code. An explicit call is needed only if the module's own init code subsequently calls `PyState_FindModule`. The function is mainly intended for implementing alternative import mechanisms (either by calling it directly, or by referring to its implementation for details of the required state updates).

  If a module was attached previously using the same def, it is replaced by the new module.

  The caller must have an attached thread state.

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

  Added in version 3.3.

int PyState_RemoveModule(PyModuleDef *def)
  次に属します: Stable ABI (バージョン 3.3 より).

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

  The caller must have an attached thread state.

  Added in version 3.3.