mirror of
https://github.com/python/cpython
synced 2024-09-05 16:38:56 +00:00
dd36b71fa6
We also move the closely related max_module_number and add comments documenting the group of struct members. https://github.com/python/cpython/issues/81057
110 lines
3.1 KiB
C
110 lines
3.1 KiB
C
|
|
/* Module object interface */
|
|
|
|
#ifndef Py_MODULEOBJECT_H
|
|
#define Py_MODULEOBJECT_H
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
PyAPI_DATA(PyTypeObject) PyModule_Type;
|
|
|
|
#define PyModule_Check(op) PyObject_TypeCheck((op), &PyModule_Type)
|
|
#define PyModule_CheckExact(op) Py_IS_TYPE((op), &PyModule_Type)
|
|
|
|
#if !defined(Py_LIMITED_API) || Py_LIMITED_API+0 >= 0x03030000
|
|
PyAPI_FUNC(PyObject *) PyModule_NewObject(
|
|
PyObject *name
|
|
);
|
|
#endif
|
|
PyAPI_FUNC(PyObject *) PyModule_New(
|
|
const char *name /* UTF-8 encoded string */
|
|
);
|
|
PyAPI_FUNC(PyObject *) PyModule_GetDict(PyObject *);
|
|
#if !defined(Py_LIMITED_API) || Py_LIMITED_API+0 >= 0x03030000
|
|
PyAPI_FUNC(PyObject *) PyModule_GetNameObject(PyObject *);
|
|
#endif
|
|
PyAPI_FUNC(const char *) PyModule_GetName(PyObject *);
|
|
Py_DEPRECATED(3.2) PyAPI_FUNC(const char *) PyModule_GetFilename(PyObject *);
|
|
PyAPI_FUNC(PyObject *) PyModule_GetFilenameObject(PyObject *);
|
|
#ifndef Py_LIMITED_API
|
|
PyAPI_FUNC(void) _PyModule_Clear(PyObject *);
|
|
PyAPI_FUNC(void) _PyModule_ClearDict(PyObject *);
|
|
PyAPI_FUNC(int) _PyModuleSpec_IsInitializing(PyObject *);
|
|
#endif
|
|
PyAPI_FUNC(PyModuleDef*) PyModule_GetDef(PyObject*);
|
|
PyAPI_FUNC(void*) PyModule_GetState(PyObject*);
|
|
|
|
#if !defined(Py_LIMITED_API) || Py_LIMITED_API+0 >= 0x03050000
|
|
/* New in 3.5 */
|
|
PyAPI_FUNC(PyObject *) PyModuleDef_Init(PyModuleDef*);
|
|
PyAPI_DATA(PyTypeObject) PyModuleDef_Type;
|
|
#endif
|
|
|
|
typedef struct PyModuleDef_Base {
|
|
PyObject_HEAD
|
|
/* The function used to re-initialize the module.
|
|
This is only set for legacy (single-phase init) extension modules
|
|
and only used for those that support multiple initializations
|
|
(m_size >= 0).
|
|
It is set by _PyImport_LoadDynamicModuleWithSpec()
|
|
and _imp.create_builtin(). */
|
|
PyObject* (*m_init)(void);
|
|
/* The module's index into its interpreter's modules_by_index cache.
|
|
This is set for all extension modules but only used for legacy ones.
|
|
(See PyInterpreterState.modules_by_index for more info.)
|
|
It is set by PyModuleDef_Init(). */
|
|
Py_ssize_t m_index;
|
|
/* A copy of the module's __dict__ after the first time it was loaded.
|
|
This is only set/used for legacy modules that do not support
|
|
multiple initializations.
|
|
It is set by _PyImport_FixupExtensionObject(). */
|
|
PyObject* m_copy;
|
|
} PyModuleDef_Base;
|
|
|
|
#define PyModuleDef_HEAD_INIT { \
|
|
PyObject_HEAD_INIT(_Py_NULL) \
|
|
_Py_NULL, /* m_init */ \
|
|
0, /* m_index */ \
|
|
_Py_NULL, /* m_copy */ \
|
|
}
|
|
|
|
#if !defined(Py_LIMITED_API) || Py_LIMITED_API+0 >= 0x03050000
|
|
/* New in 3.5 */
|
|
struct PyModuleDef_Slot {
|
|
int slot;
|
|
void *value;
|
|
};
|
|
|
|
#define Py_mod_create 1
|
|
#define Py_mod_exec 2
|
|
|
|
#ifndef Py_LIMITED_API
|
|
#define _Py_mod_LAST_SLOT 2
|
|
#endif
|
|
|
|
#endif /* New in 3.5 */
|
|
|
|
struct PyModuleDef {
|
|
PyModuleDef_Base m_base;
|
|
const char* m_name;
|
|
const char* m_doc;
|
|
Py_ssize_t m_size;
|
|
PyMethodDef *m_methods;
|
|
PyModuleDef_Slot *m_slots;
|
|
traverseproc m_traverse;
|
|
inquiry m_clear;
|
|
freefunc m_free;
|
|
};
|
|
|
|
|
|
// Internal C API
|
|
#ifdef Py_BUILD_CORE
|
|
extern int _PyModule_IsExtension(PyObject *obj);
|
|
#endif
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
#endif /* !Py_MODULEOBJECT_H */
|