モジュールオブジェクト (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.

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 definition¶

Modules created using the C API are typically defined using an array of slots. The slots provide a "description" of how a module should be created.

バージョン 3.15.0a2 (unreleased) で変更: Previously, a PyModuleDef struct was necessary to define modules. The older way of defining modules is still available: consult either the Module definition struct section or earlier versions of this documentation if you plan to support earlier Python versions.

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

Unless specified otherwise, the same slot ID may not be repeated in an array of slots.

type PyModuleDef_Slot¶

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

int slot¶

A slot ID, chosen from the available Py_mod_* values explained below.

An ID of 0 marks the end of a PyModuleDef_Slot array.

void *value¶

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

The value may not be NULL. To leave a slot out, omit the PyModuleDef_Slot entry entirely.

Added in version 3.5.

Metadata slots¶

Py_mod_name¶

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

Slot ID for the name of the new module, as a NUL-terminated UTF8-encoded const char *.

Note that modules are typically created using a ModuleSpec, and when they are, the name from the spec will be used instead of Py_mod_name. However, it is still recommended to include this slot for introspection and debugging purposes.

Added in version 3.15.0a2 (unreleased): Use PyModuleDef.m_name instead to support previous versions.

Py_mod_doc¶

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

Slot ID for the docstring of the new module, as a NUL-terminated UTF8-encoded const char *.

Usually it is set to a variable created with PyDoc_STRVAR.

Added in version 3.15.0a2 (unreleased): Use PyModuleDef.m_doc instead to support previous versions.

Feature slots¶

Py_mod_abi¶

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

Slot ID whose value points to a PyABIInfo structure describing the ABI that the extension is using.

A suitable PyABIInfo variable can be defined using the PyABIInfo_VAR macro, as in:

PyABIInfo_VAR(abi_info);

static PyModuleDef_Slot mymodule_slots[] = {
   {Py_mod_abi, &abi_info},
   ...
};

When creating a module, Python checks the value of this slot using PyABIInfo_Check().

Added in version 3.15.

Py_mod_multiple_interpreters¶

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

Slot ID whose value is one of:

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.

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 より).

Slot ID whose value is one of:

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.

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

Added in version 3.13.

Creation and initialization slots¶

Py_mod_create¶

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

Slot ID for a function that creates the module object itself. The function must have the signature:

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

The function will be called with:

spec: a ModuleSpec-like object, meaning that any attributes defined for importlib.machinery.ModuleSpec have matching semantics. However, any of the attributes may be missing.
def: NULL, or the module definition if the module is created from one.

The function should return a new module object, or set an error and return NULL.

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

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

There is no requirement for the returned object to be an instance of PyModule_Type. However, some slots may only be used with PyModule_Type instances; in particular:

Py_mod_exec,
module state slots (Py_mod_state_*),
Py_mod_token.

Added in version 3.5.

バージョン 3.15.0a2 (unreleased) で変更: The slots argument may be a ModuleSpec-like object, rather than a true ModuleSpec instance. Note that previous versions of CPython did not enforce this.

The def argument may now be NULL, since modules are not necessarily made from definitions.

Py_mod_exec¶

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

Slot ID for a function that will execute, or initialize, the module. This function does the equivalent to executing the code of a Python module: typically, it adds classes and constants to the module. The signature of the function is:

int exec_module(PyObject *module)¶

See the サポート関数 section for some useful functions to call.

For backwards compatibility, the PyModuleDef.m_slots array may contain multiple Py_mod_exec slots; these are processed in the order they appear in the array. Elsewhere (that is, in arguments to PyModule_FromSlotsAndSpec() and in return values of PyModExport_<name>), repeating the slot is not allowed.

Added in version 3.5.

バージョン 3.15.0a2 (unreleased) で変更: Repeated Py_mod_exec slots are disallowed, except in PyModuleDef.m_slots.

Py_mod_methods¶

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

Slot ID for a table of module-level functions, as an array of PyMethodDef values suitable as the functions argument to PyModule_AddFunctions().

Like other slot IDs, a slots array may only contain one Py_mod_methods entry. To add functions from multiple PyMethodDef arrays, call PyModule_AddFunctions() in the Py_mod_exec function.

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

Added in version 3.15.0a2 (unreleased): Use PyModuleDef.m_methods instead to support previous versions.

Module state¶

Extension modules can have module state -- a piece of memory that is allocated on module creation, and freed when the module object is deallocated. The module state is specified using dedicated slots.

A typical use of module state is storing an exception type -- or indeed any type object defined by the module --

Unlike the module's Python attributes, Python code cannot replace or delete data stored in module state.

Keeping per-module information in attributes and module state, rather than in static globals, makes module objects isolated and safer for use in multiple sub-interpreters. It also helps Python do an orderly clean-up when it shuts down.

Extensions that keep references to Python objects as part of module state must implement Py_mod_state_traverse and Py_mod_state_clear functions to avoid reference leaks.

To retrieve the state from a given module, use the following functions:

void *PyModule_GetState(PyObject *module)¶

次に属します: Stable ABI.

Return the "state" of the module, that is, a pointer to the block of memory allocated at module creation time, or NULL. See Py_mod_state_size.

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

int PyModule_GetStateSize(PyObject*, Py_ssize_t *result)¶

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

Set *result to the size of the module's state, as specified using Py_mod_state_size (or PyModuleDef.m_size), and return 0.

On error, set *result to -1, and return -1 with an exception set.

Added in version 3.15.0a2 (unreleased).

Slots for defining module state¶

The following PyModuleDef_Slot.slot IDs are available for defining the module state.

Py_mod_state_size¶

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

Slot ID for the size of the module state, in bytes.

Setting the value 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.

詳細は PEP 3121 を参照。

Use PyModule_GetStateSize() to retrieve the size of a given module.

Added in version 3.15.0a2 (unreleased): Use PyModuleDef.m_size instead to support previous versions.

Py_mod_state_traverse¶

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

Slot ID for a traversal function to call during GC traversal of the module object.

The signature of the function, and meanings of the arguments, is similar as for PyTypeObject.tp_traverse:

int traverse_module_state(PyObject *module, visitproc visit, void *arg)¶

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 the state size (Py_mod_state_size) is greater than 0 and the module state (as returned by PyModule_GetState()) is NULL.

Added in version 3.15.0a2 (unreleased): Use PyModuleDef.m_size instead to support previous versions.

Py_mod_state_clear¶

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

Slot ID for a clear function to call during GC clearing of the module object.

The signature of the function is:

int clear_module_state(PyObject *module)¶

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 the state size (Py_mod_state_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 the Py_mod_state_free function is called directly.

Added in version 3.15.0a2 (unreleased): Use PyModuleDef.m_clear instead to support previous versions.

Py_mod_state_free¶

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

Slot ID for a function to call during deallocation of the module object.

The signature of the function is:

int free_module_state(PyObject *module)¶

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 the state size (Py_mod_state_size) is greater than 0 and the module state (as returned by PyModule_GetState()) is NULL.

Added in version 3.15.0a2 (unreleased): Use PyModuleDef.m_free instead to support previous versions.

Module token¶

Each module may have an associated token: a pointer-sized value intended to identify of the module state's memory layout. This means that if you have a module object, but you are not sure if it “belongs” to your extension, you can check using code like this:

PyObject *module = <the module in question>

void *module_token;
if (PyModule_GetToken(module, &module_token) < 0) {
    return NULL;
}
if (module_token != your_token) {
    PyErr_SetString(PyExc_ValueError, "unexpected module")
    return NULL;
}

// This module's state has the expected memory layout; it's safe to cast
struct my_state state = (struct my_state*)PyModule_GetState(module)

A module's token -- and the your_token value to use in the above code -- is:

For modules created with PyModuleDef: the address of that PyModuleDef;
For modules defined with the Py_mod_token slot: the value of that slot;
For modules created from an PyModExport_* export hook: the slots array that the export hook returned (unless overriden with Py_mod_token).

Py_mod_token¶

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

Slot ID for the module token.

If you use this slot to set the module token (rather than rely on the default), you must ensure that:

The pointer outlives the class, so it's not reused for something else while the class exists.
It "belongs" to the extension module where the class lives, so it will not clash with other extensions.
If the token points to a PyModuleDef struct, the module should behave as if it was created from that PyModuleDef. In particular, the module state must have matching layout and semantics.

Modules created from PyModuleDef allways use the address of the PyModuleDef as the token. This means that Py_mod_token cannot be used in PyModuleDef.m_slots.

Added in version 3.15.0a2 (unreleased).

int PyModule_GetToken(PyObject *module, void **result)¶

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

Set *result to the module's token and return 0.

On error, set *result to NULL, and return -1 with an exception set.

Added in version 3.15.0a2 (unreleased).

Creating extension modules dynamically¶

The following functions may be used to create an extension module dynamically, rather than from an extension's export hook.

PyObject *PyModule_FromSlotsAndSpec(const PyModuleDef_Slot *slots, PyObject *spec)¶

戻り値: 新しい参照。 次に属します: Stable ABI (バージョン 3.15 より).

Create a new module object, given an array of slots and the ModuleSpec spec.

The slots argument must point to an array of PyModuleDef_Slot structures, terminated by an entry slot with slot ID of 0 (typically written as {0} or {0, NULL} in C). The slots argument may not be NULL.

The spec argument may be any ModuleSpec-like object, as described in Py_mod_create documentation. Currently, the spec must have a name attribute.

On success, return the new module. On error, return NULL with an exception set.

Note that this does not process the module's execution slot (Py_mod_exec). Both PyModule_FromSlotsAndSpec() and PyModule_Exec() must be called to fully initialize a module. (See also 多段階初期化.)

The slots array only needs to be valid for the duration of the PyModule_FromSlotsAndSpec() call. In particular, it may be heap-allocated.

Added in version 3.15.0a2 (unreleased).

int PyModule_Exec(PyObject *module)¶

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

Execute the Py_mod_exec slot(s) of the given module.

On success, return 0. On error, return -1 with an exception set.

For clarity: If module has no slots, for example if it uses legacy single-phase initialization, this function does nothing and returns 0.

Added in version 3.15.0a2 (unreleased).

Module definition struct¶

Traditionally, extension modules were defined using a module definition as the “description" of how a module should be created. Rather than using an array of slots directly, the definition has dedicated members for most common functionality, and allows additional slots as an extension mechanism.

This way of defining modules is still available and there are no plans to remove it.

type PyModuleDef¶

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

The module definition struct, which holds 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 defined this way.

PyModuleDef_Base m_base¶

Always initialize this member to PyModuleDef_HEAD_INIT:

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

PyModuleDef_HEAD_INIT¶: The required initial value for PyModuleDef.m_base.

const char *m_name¶: Corresponds to the Py_mod_name slot.

const char *m_doc¶: These members correspond to the Py_mod_doc slot. Setting this to NULL is equivalent to omitting the slot.

Py_ssize_t m_size¶

Corresponds to the Py_mod_state_size slot. Setting this to zero is equivalent to omitting the slot.

When using legacy single-phase initialization or when creating modules dynamically using PyModule_Create() or PyModule_Create2(), m_size may be set to -1. This indicates that the module does not support sub-interpreters, because it has global state.

PyMethodDef *m_methods¶: Corresponds to the Py_mod_methods slot. Setting this to NULL is equivalent to omitting the slot.

PyModuleDef_Slot *m_slots¶

An array of additional slots, terminated by a {0, NULL} entry.

This array may not contain slots corresponding to PyModuleDef members. For example, you cannot use Py_mod_name in m_slots; the module name must be given as PyModuleDef.m_name.

バージョン 3.5 で変更: バージョン 3.5 より前は、このメンバは常に NULL に設定されていて、次のものとして定義されていました:

inquiry m_reload¶

traverseproc m_traverse¶

inquiry m_clear¶

freefunc m_free¶

These members correspond to the Py_mod_state_traverse, Py_mod_state_clear, and Py_mod_state_free slots, respectively.

Setting these members to NULL is equivalent to omitting the corresponding slots.

バージョン 3.9 で変更: m_traverse, m_clear and m_free functions are longer called before the module state is allocated.

The following API can be used to create modules from a PyModuleDef struct:

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 object. They are intended for a module's execution slot (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).

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.

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

Module definition¶

Metadata slots¶

Feature slots¶

Creation and initialization slots¶

Module state¶

Slots for defining module state¶

Module token¶

Creating extension modules dynamically¶

Module definition struct¶

サポート関数¶

Module lookup (single-phase initialization)¶

目次

前のトピックへ

次のトピックへ

This page