blob: cf9ad40c0a17a0518f169d9d0d18645206da0cbb [file] [log] [blame]
Guido van Rossumf70e43a1991-02-19 12:39:46 +00001
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002/* Module object interface */
3
Fred Drake3cf4d2b2000-07-09 00:55:06 +00004#ifndef Py_MODULEOBJECT_H
5#define Py_MODULEOBJECT_H
6#ifdef __cplusplus
7extern "C" {
8#endif
9
Mark Hammond91a681d2002-08-12 07:21:58 +000010PyAPI_DATA(PyTypeObject) PyModule_Type;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000011
Guido van Rossumb8755092001-09-10 18:21:59 +000012#define PyModule_Check(op) PyObject_TypeCheck(op, &PyModule_Type)
Dong-hee Nad905df72020-02-14 02:37:17 +090013#define PyModule_CheckExact(op) Py_IS_TYPE(op, &PyModule_Type)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000014
Serhiy Storchaka34d0ac82016-12-27 14:57:39 +020015#if !defined(Py_LIMITED_API) || Py_LIMITED_API+0 >= 0x03030000
Victor Stinner0639b562011-03-04 12:57:07 +000016PyAPI_FUNC(PyObject *) PyModule_NewObject(
17 PyObject *name
18 );
Serhiy Storchaka34d0ac82016-12-27 14:57:39 +020019#endif
Victor Stinnerd7e76402011-02-22 23:38:34 +000020PyAPI_FUNC(PyObject *) PyModule_New(
21 const char *name /* UTF-8 encoded string */
22 );
Mark Hammond91a681d2002-08-12 07:21:58 +000023PyAPI_FUNC(PyObject *) PyModule_GetDict(PyObject *);
Serhiy Storchaka34d0ac82016-12-27 14:57:39 +020024#if !defined(Py_LIMITED_API) || Py_LIMITED_API+0 >= 0x03030000
Victor Stinnerbd475112011-02-23 00:21:43 +000025PyAPI_FUNC(PyObject *) PyModule_GetNameObject(PyObject *);
Serhiy Storchaka34d0ac82016-12-27 14:57:39 +020026#endif
Neal Norwitz312e10d2007-08-26 02:21:42 +000027PyAPI_FUNC(const char *) PyModule_GetName(PyObject *);
Zackery Spytz3c8724f2019-05-28 09:16:33 -060028Py_DEPRECATED(3.2) PyAPI_FUNC(const char *) PyModule_GetFilename(PyObject *);
Victor Stinner6c00c142010-08-17 23:37:11 +000029PyAPI_FUNC(PyObject *) PyModule_GetFilenameObject(PyObject *);
Martin v. Löwis4d0d4712010-12-03 20:14:31 +000030#ifndef Py_LIMITED_API
Mark Hammond91a681d2002-08-12 07:21:58 +000031PyAPI_FUNC(void) _PyModule_Clear(PyObject *);
Serhiy Storchaka87a5c512014-02-10 18:21:34 +020032PyAPI_FUNC(void) _PyModule_ClearDict(PyObject *);
Serhiy Storchaka3e429dc2018-10-30 13:19:51 +020033PyAPI_FUNC(int) _PyModuleSpec_IsInitializing(PyObject *);
Martin v. Löwis4d0d4712010-12-03 20:14:31 +000034#endif
Martin v. Löwis1a214512008-06-11 05:26:20 +000035PyAPI_FUNC(struct PyModuleDef*) PyModule_GetDef(PyObject*);
36PyAPI_FUNC(void*) PyModule_GetState(PyObject*);
37
Yury Selivanovca829102015-06-02 19:06:47 -040038#if !defined(Py_LIMITED_API) || Py_LIMITED_API+0 >= 0x03050000
39/* New in 3.5 */
Nick Coghland5cacbb2015-05-23 22:24:10 +100040PyAPI_FUNC(PyObject *) PyModuleDef_Init(struct PyModuleDef*);
Steve Dower11d7b142015-05-23 14:44:37 -070041PyAPI_DATA(PyTypeObject) PyModuleDef_Type;
Yury Selivanovca829102015-06-02 19:06:47 -040042#endif
Nick Coghland5cacbb2015-05-23 22:24:10 +100043
Martin v. Löwis1a214512008-06-11 05:26:20 +000044typedef struct PyModuleDef_Base {
45 PyObject_HEAD
46 PyObject* (*m_init)(void);
47 Py_ssize_t m_index;
48 PyObject* m_copy;
49} PyModuleDef_Base;
50
David Malcolm82e73cb2010-11-17 21:20:18 +000051#define PyModuleDef_HEAD_INIT { \
52 PyObject_HEAD_INIT(NULL) \
53 NULL, /* m_init */ \
54 0, /* m_index */ \
55 NULL, /* m_copy */ \
56 }
Martin v. Löwis1a214512008-06-11 05:26:20 +000057
Yury Selivanovca829102015-06-02 19:06:47 -040058struct PyModuleDef_Slot;
59#if !defined(Py_LIMITED_API) || Py_LIMITED_API+0 >= 0x03050000
60/* New in 3.5 */
Nick Coghland5cacbb2015-05-23 22:24:10 +100061typedef struct PyModuleDef_Slot{
62 int slot;
63 void *value;
64} PyModuleDef_Slot;
65
Nick Coghland5cacbb2015-05-23 22:24:10 +100066#define Py_mod_create 1
67#define Py_mod_exec 2
68
69#ifndef Py_LIMITED_API
70#define _Py_mod_LAST_SLOT 2
71#endif
Guido van Rossuma3309961993-07-28 09:05:47 +000072
Yury Selivanovca829102015-06-02 19:06:47 -040073#endif /* New in 3.5 */
74
75typedef struct PyModuleDef{
76 PyModuleDef_Base m_base;
77 const char* m_name;
78 const char* m_doc;
79 Py_ssize_t m_size;
80 PyMethodDef *m_methods;
81 struct PyModuleDef_Slot* m_slots;
82 traverseproc m_traverse;
83 inquiry m_clear;
84 freefunc m_free;
Nick Coghlan8682f572016-08-21 17:41:56 +100085} PyModuleDef;
Yury Selivanovca829102015-06-02 19:06:47 -040086
Guido van Rossuma3309961993-07-28 09:05:47 +000087#ifdef __cplusplus
88}
89#endif
90#endif /* !Py_MODULEOBJECT_H */