blob: ac3fc3bd28c017288c22f3b59c6dd8abb00d6b13 [file] [log] [blame]
Guido van Rossumf70e43a1991-02-19 12:39:46 +00001
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002/* Module definition and import interface */
3
Fred Drake5eb6d4e2000-07-08 23:37:28 +00004#ifndef Py_IMPORT_H
5#define Py_IMPORT_H
6#ifdef __cplusplus
7extern "C" {
8#endif
Guido van Rossum34679b71993-01-26 13:33:44 +00009
Serhiy Storchaka9fab79b2016-09-11 11:03:14 +030010#ifndef Py_LIMITED_API
Victor Stinnerf7e5b562017-11-15 15:48:08 -080011PyAPI_FUNC(_PyInitError) _PyImportZip_Init(void);
Brett Cannonfd074152012-04-14 14:10:13 -040012
Benjamin Petersonc65ef772018-01-29 11:33:57 -080013PyMODINIT_FUNC PyInit__imp(void);
Serhiy Storchaka34d0ac82016-12-27 14:57:39 +020014#endif /* !Py_LIMITED_API */
Mark Hammond8235ea12002-07-19 06:55:41 +000015PyAPI_FUNC(long) PyImport_GetMagicNumber(void);
Barry Warsaw28a691b2010-04-17 00:19:56 +000016PyAPI_FUNC(const char *) PyImport_GetMagicTag(void);
Victor Stinnerd7e76402011-02-22 23:38:34 +000017PyAPI_FUNC(PyObject *) PyImport_ExecCodeModule(
Serhiy Storchakac6792272013-10-19 21:03:34 +030018 const char *name, /* UTF-8 encoded string */
Victor Stinnerd7e76402011-02-22 23:38:34 +000019 PyObject *co
20 );
Mark Hammond8235ea12002-07-19 06:55:41 +000021PyAPI_FUNC(PyObject *) PyImport_ExecCodeModuleEx(
Serhiy Storchakac6792272013-10-19 21:03:34 +030022 const char *name, /* UTF-8 encoded string */
Victor Stinnerd7e76402011-02-22 23:38:34 +000023 PyObject *co,
Serhiy Storchakac6792272013-10-19 21:03:34 +030024 const char *pathname /* decoded from the filesystem encoding */
Victor Stinnerd7e76402011-02-22 23:38:34 +000025 );
Barry Warsaw28a691b2010-04-17 00:19:56 +000026PyAPI_FUNC(PyObject *) PyImport_ExecCodeModuleWithPathnames(
Serhiy Storchakac6792272013-10-19 21:03:34 +030027 const char *name, /* UTF-8 encoded string */
Victor Stinnerd7e76402011-02-22 23:38:34 +000028 PyObject *co,
Serhiy Storchakac6792272013-10-19 21:03:34 +030029 const char *pathname, /* decoded from the filesystem encoding */
30 const char *cpathname /* decoded from the filesystem encoding */
Victor Stinnerd7e76402011-02-22 23:38:34 +000031 );
Serhiy Storchaka34d0ac82016-12-27 14:57:39 +020032#if !defined(Py_LIMITED_API) || Py_LIMITED_API+0 >= 0x03030000
Victor Stinner27ee0892011-03-04 12:57:09 +000033PyAPI_FUNC(PyObject *) PyImport_ExecCodeModuleObject(
34 PyObject *name,
35 PyObject *co,
36 PyObject *pathname,
37 PyObject *cpathname
38 );
Serhiy Storchaka34d0ac82016-12-27 14:57:39 +020039#endif
Mark Hammond8235ea12002-07-19 06:55:41 +000040PyAPI_FUNC(PyObject *) PyImport_GetModuleDict(void);
Eric Snow3f9eee62017-09-15 16:35:20 -060041PyAPI_FUNC(PyObject *) PyImport_GetModule(PyObject *name);
Eric Snowd393c1b2017-09-14 12:18:12 -060042#ifndef Py_LIMITED_API
43PyAPI_FUNC(int) _PyImport_IsInitialized(PyInterpreterState *);
Eric Snow3f9eee62017-09-15 16:35:20 -060044PyAPI_FUNC(PyObject *) _PyImport_GetModuleId(struct _Py_Identifier *name);
45PyAPI_FUNC(PyObject *) _PyImport_AddModuleObject(PyObject *name,
46 PyObject *modules);
47PyAPI_FUNC(int) _PyImport_SetModule(PyObject *name, PyObject *module);
48PyAPI_FUNC(int) _PyImport_SetModuleString(const char *name, PyObject* module);
Eric Snowd393c1b2017-09-14 12:18:12 -060049#endif
Serhiy Storchaka34d0ac82016-12-27 14:57:39 +020050#if !defined(Py_LIMITED_API) || Py_LIMITED_API+0 >= 0x03030000
Victor Stinner27ee0892011-03-04 12:57:09 +000051PyAPI_FUNC(PyObject *) PyImport_AddModuleObject(
52 PyObject *name
53 );
Serhiy Storchaka34d0ac82016-12-27 14:57:39 +020054#endif
Eric Snowd393c1b2017-09-14 12:18:12 -060055#ifndef Py_LIMITED_API
56PyAPI_FUNC(PyObject *) _PyImport_AddModuleObject(PyObject *, PyObject *);
57#endif
Victor Stinnerd7e76402011-02-22 23:38:34 +000058PyAPI_FUNC(PyObject *) PyImport_AddModule(
59 const char *name /* UTF-8 encoded string */
60 );
61PyAPI_FUNC(PyObject *) PyImport_ImportModule(
62 const char *name /* UTF-8 encoded string */
63 );
64PyAPI_FUNC(PyObject *) PyImport_ImportModuleNoBlock(
65 const char *name /* UTF-8 encoded string */
66 );
67PyAPI_FUNC(PyObject *) PyImport_ImportModuleLevel(
Benjamin Peterson04778a82011-05-25 09:29:00 -050068 const char *name, /* UTF-8 encoded string */
Victor Stinnerd7e76402011-02-22 23:38:34 +000069 PyObject *globals,
70 PyObject *locals,
71 PyObject *fromlist,
72 int level
73 );
Serhiy Storchaka34d0ac82016-12-27 14:57:39 +020074#if !defined(Py_LIMITED_API) || Py_LIMITED_API+0 >= 0x03050000
Victor Stinnerfe93faf2011-03-14 15:54:52 -040075PyAPI_FUNC(PyObject *) PyImport_ImportModuleLevelObject(
76 PyObject *name,
77 PyObject *globals,
78 PyObject *locals,
79 PyObject *fromlist,
80 int level
81 );
Serhiy Storchaka34d0ac82016-12-27 14:57:39 +020082#endif
Thomas Woutersf7f438b2006-02-28 16:09:29 +000083
Thomas Woutersf7f438b2006-02-28 16:09:29 +000084#define PyImport_ImportModuleEx(n, g, l, f) \
Brett Cannon522267e2012-08-10 18:55:08 -040085 PyImport_ImportModuleLevel(n, g, l, f, 0)
Thomas Woutersf7f438b2006-02-28 16:09:29 +000086
Christian Heimes9cd17752007-11-18 19:35:23 +000087PyAPI_FUNC(PyObject *) PyImport_GetImporter(PyObject *path);
Mark Hammond8235ea12002-07-19 06:55:41 +000088PyAPI_FUNC(PyObject *) PyImport_Import(PyObject *name);
89PyAPI_FUNC(PyObject *) PyImport_ReloadModule(PyObject *m);
90PyAPI_FUNC(void) PyImport_Cleanup(void);
Serhiy Storchaka34d0ac82016-12-27 14:57:39 +020091#if !defined(Py_LIMITED_API) || Py_LIMITED_API+0 >= 0x03030000
Victor Stinner53dc7352011-03-20 01:50:21 +010092PyAPI_FUNC(int) PyImport_ImportFrozenModuleObject(
93 PyObject *name
94 );
Serhiy Storchaka34d0ac82016-12-27 14:57:39 +020095#endif
Victor Stinnerd7e76402011-02-22 23:38:34 +000096PyAPI_FUNC(int) PyImport_ImportFrozenModule(
Serhiy Storchakac6792272013-10-19 21:03:34 +030097 const char *name /* UTF-8 encoded string */
Victor Stinnerd7e76402011-02-22 23:38:34 +000098 );
Fred Drake5eb6d4e2000-07-08 23:37:28 +000099
Martin v. Löwis4d0d4712010-12-03 20:14:31 +0000100#ifndef Py_LIMITED_API
Benjamin Peterson0df35a92009-10-04 20:32:25 +0000101PyAPI_FUNC(void) _PyImport_AcquireLock(void);
102PyAPI_FUNC(int) _PyImport_ReleaseLock(void);
Benjamin Peterson0df35a92009-10-04 20:32:25 +0000103
Guido van Rossum8ee3e5a2005-09-14 18:09:42 +0000104PyAPI_FUNC(void) _PyImport_ReInitLock(void);
Raymond Hettingerdb29e0f2004-10-07 06:46:25 +0000105
Victor Stinnerd860d5c2013-12-10 01:19:58 +0100106PyAPI_FUNC(PyObject *) _PyImport_FindBuiltin(
Eric Snowd393c1b2017-09-14 12:18:12 -0600107 const char *name, /* UTF-8 encoded string */
108 PyObject *modules
Victor Stinnerd7e76402011-02-22 23:38:34 +0000109 );
Victor Stinnerd860d5c2013-12-10 01:19:58 +0100110PyAPI_FUNC(PyObject *) _PyImport_FindExtensionObject(PyObject *, PyObject *);
Eric Snowd393c1b2017-09-14 12:18:12 -0600111PyAPI_FUNC(PyObject *) _PyImport_FindExtensionObjectEx(PyObject *, PyObject *,
112 PyObject *);
Victor Stinnerd860d5c2013-12-10 01:19:58 +0100113PyAPI_FUNC(int) _PyImport_FixupBuiltin(
Victor Stinnerd7e76402011-02-22 23:38:34 +0000114 PyObject *mod,
Eric Snowd393c1b2017-09-14 12:18:12 -0600115 const char *name, /* UTF-8 encoded string */
116 PyObject *modules
Victor Stinnerd7e76402011-02-22 23:38:34 +0000117 );
Eric Snowd393c1b2017-09-14 12:18:12 -0600118PyAPI_FUNC(int) _PyImport_FixupExtensionObject(PyObject*, PyObject *,
119 PyObject *, PyObject *);
Guido van Rossum29e46a91997-08-02 02:56:48 +0000120
Guido van Rossum39c2aae1996-05-22 17:25:28 +0000121struct _inittab {
Serhiy Storchakac6792272013-10-19 21:03:34 +0300122 const char *name; /* ASCII encoded string */
Martin v. Löwis1a214512008-06-11 05:26:20 +0000123 PyObject* (*initfunc)(void);
Guido van Rossum39c2aae1996-05-22 17:25:28 +0000124};
Martin v. Löwis4d0d4712010-12-03 20:14:31 +0000125PyAPI_DATA(struct _inittab *) PyImport_Inittab;
126PyAPI_FUNC(int) PyImport_ExtendInittab(struct _inittab *newtab);
127#endif /* Py_LIMITED_API */
Guido van Rossum39c2aae1996-05-22 17:25:28 +0000128
Christian Heimes9cd17752007-11-18 19:35:23 +0000129PyAPI_DATA(PyTypeObject) PyNullImporter_Type;
Guido van Rossuma3309961993-07-28 09:05:47 +0000130
Victor Stinnerd7e76402011-02-22 23:38:34 +0000131PyAPI_FUNC(int) PyImport_AppendInittab(
132 const char *name, /* ASCII encoded string */
133 PyObject* (*initfunc)(void)
134 );
Guido van Rossum16926bd1998-06-29 20:34:46 +0000135
Martin v. Löwis4d0d4712010-12-03 20:14:31 +0000136#ifndef Py_LIMITED_API
Guido van Rossum4ee68d91996-06-17 17:05:01 +0000137struct _frozen {
Benjamin Peterson7701e6e2013-03-13 14:06:39 -0500138 const char *name; /* ASCII encoded string */
139 const unsigned char *code;
Fred Drake5eb6d4e2000-07-08 23:37:28 +0000140 int size;
Guido van Rossum4ee68d91996-06-17 17:05:01 +0000141};
142
143/* Embedding apps may change this pointer to point to their favorite
144 collection of frozen modules: */
145
Benjamin Peterson7701e6e2013-03-13 14:06:39 -0500146PyAPI_DATA(const struct _frozen *) PyImport_FrozenModules;
Martin v. Löwis4d0d4712010-12-03 20:14:31 +0000147#endif
Guido van Rossum4ee68d91996-06-17 17:05:01 +0000148
Guido van Rossuma3309961993-07-28 09:05:47 +0000149#ifdef __cplusplus
150}
151#endif
152#endif /* !Py_IMPORT_H */