blob: 13c614933c7c2b062770cb7bfcb5ee34acc37362 [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
Benjamin Petersonc65ef772018-01-29 11:33:57 -080011PyMODINIT_FUNC PyInit__imp(void);
Serhiy Storchaka34d0ac82016-12-27 14:57:39 +020012#endif /* !Py_LIMITED_API */
Mark Hammond8235ea12002-07-19 06:55:41 +000013PyAPI_FUNC(long) PyImport_GetMagicNumber(void);
Barry Warsaw28a691b2010-04-17 00:19:56 +000014PyAPI_FUNC(const char *) PyImport_GetMagicTag(void);
Victor Stinnerd7e76402011-02-22 23:38:34 +000015PyAPI_FUNC(PyObject *) PyImport_ExecCodeModule(
Serhiy Storchakac6792272013-10-19 21:03:34 +030016 const char *name, /* UTF-8 encoded string */
Victor Stinnerd7e76402011-02-22 23:38:34 +000017 PyObject *co
18 );
Mark Hammond8235ea12002-07-19 06:55:41 +000019PyAPI_FUNC(PyObject *) PyImport_ExecCodeModuleEx(
Serhiy Storchakac6792272013-10-19 21:03:34 +030020 const char *name, /* UTF-8 encoded string */
Victor Stinnerd7e76402011-02-22 23:38:34 +000021 PyObject *co,
Serhiy Storchakac6792272013-10-19 21:03:34 +030022 const char *pathname /* decoded from the filesystem encoding */
Victor Stinnerd7e76402011-02-22 23:38:34 +000023 );
Barry Warsaw28a691b2010-04-17 00:19:56 +000024PyAPI_FUNC(PyObject *) PyImport_ExecCodeModuleWithPathnames(
Serhiy Storchakac6792272013-10-19 21:03:34 +030025 const char *name, /* UTF-8 encoded string */
Victor Stinnerd7e76402011-02-22 23:38:34 +000026 PyObject *co,
Serhiy Storchakac6792272013-10-19 21:03:34 +030027 const char *pathname, /* decoded from the filesystem encoding */
28 const char *cpathname /* decoded from the filesystem encoding */
Victor Stinnerd7e76402011-02-22 23:38:34 +000029 );
Serhiy Storchaka34d0ac82016-12-27 14:57:39 +020030#if !defined(Py_LIMITED_API) || Py_LIMITED_API+0 >= 0x03030000
Victor Stinner27ee0892011-03-04 12:57:09 +000031PyAPI_FUNC(PyObject *) PyImport_ExecCodeModuleObject(
32 PyObject *name,
33 PyObject *co,
34 PyObject *pathname,
35 PyObject *cpathname
36 );
Serhiy Storchaka34d0ac82016-12-27 14:57:39 +020037#endif
Mark Hammond8235ea12002-07-19 06:55:41 +000038PyAPI_FUNC(PyObject *) PyImport_GetModuleDict(void);
Serhiy Storchaka4e29f562018-05-22 20:59:42 +030039#if !defined(Py_LIMITED_API) || Py_LIMITED_API+0 >= 0x03070000
Eric Snow3f9eee62017-09-15 16:35:20 -060040PyAPI_FUNC(PyObject *) PyImport_GetModule(PyObject *name);
Serhiy Storchaka4e29f562018-05-22 20:59:42 +030041#endif
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
Victor Stinnerd7e76402011-02-22 23:38:34 +000055PyAPI_FUNC(PyObject *) PyImport_AddModule(
56 const char *name /* UTF-8 encoded string */
57 );
58PyAPI_FUNC(PyObject *) PyImport_ImportModule(
59 const char *name /* UTF-8 encoded string */
60 );
61PyAPI_FUNC(PyObject *) PyImport_ImportModuleNoBlock(
62 const char *name /* UTF-8 encoded string */
63 );
64PyAPI_FUNC(PyObject *) PyImport_ImportModuleLevel(
Benjamin Peterson04778a82011-05-25 09:29:00 -050065 const char *name, /* UTF-8 encoded string */
Victor Stinnerd7e76402011-02-22 23:38:34 +000066 PyObject *globals,
67 PyObject *locals,
68 PyObject *fromlist,
69 int level
70 );
Serhiy Storchaka34d0ac82016-12-27 14:57:39 +020071#if !defined(Py_LIMITED_API) || Py_LIMITED_API+0 >= 0x03050000
Victor Stinnerfe93faf2011-03-14 15:54:52 -040072PyAPI_FUNC(PyObject *) PyImport_ImportModuleLevelObject(
73 PyObject *name,
74 PyObject *globals,
75 PyObject *locals,
76 PyObject *fromlist,
77 int level
78 );
Serhiy Storchaka34d0ac82016-12-27 14:57:39 +020079#endif
Thomas Woutersf7f438b2006-02-28 16:09:29 +000080
Thomas Woutersf7f438b2006-02-28 16:09:29 +000081#define PyImport_ImportModuleEx(n, g, l, f) \
Brett Cannon522267e2012-08-10 18:55:08 -040082 PyImport_ImportModuleLevel(n, g, l, f, 0)
Thomas Woutersf7f438b2006-02-28 16:09:29 +000083
Christian Heimes9cd17752007-11-18 19:35:23 +000084PyAPI_FUNC(PyObject *) PyImport_GetImporter(PyObject *path);
Mark Hammond8235ea12002-07-19 06:55:41 +000085PyAPI_FUNC(PyObject *) PyImport_Import(PyObject *name);
86PyAPI_FUNC(PyObject *) PyImport_ReloadModule(PyObject *m);
87PyAPI_FUNC(void) PyImport_Cleanup(void);
Serhiy Storchaka34d0ac82016-12-27 14:57:39 +020088#if !defined(Py_LIMITED_API) || Py_LIMITED_API+0 >= 0x03030000
Victor Stinner53dc7352011-03-20 01:50:21 +010089PyAPI_FUNC(int) PyImport_ImportFrozenModuleObject(
90 PyObject *name
91 );
Serhiy Storchaka34d0ac82016-12-27 14:57:39 +020092#endif
Victor Stinnerd7e76402011-02-22 23:38:34 +000093PyAPI_FUNC(int) PyImport_ImportFrozenModule(
Serhiy Storchakac6792272013-10-19 21:03:34 +030094 const char *name /* UTF-8 encoded string */
Victor Stinnerd7e76402011-02-22 23:38:34 +000095 );
Fred Drake5eb6d4e2000-07-08 23:37:28 +000096
Martin v. Löwis4d0d4712010-12-03 20:14:31 +000097#ifndef Py_LIMITED_API
Benjamin Peterson0df35a92009-10-04 20:32:25 +000098PyAPI_FUNC(void) _PyImport_AcquireLock(void);
99PyAPI_FUNC(int) _PyImport_ReleaseLock(void);
Benjamin Peterson0df35a92009-10-04 20:32:25 +0000100
Guido van Rossum8ee3e5a2005-09-14 18:09:42 +0000101PyAPI_FUNC(void) _PyImport_ReInitLock(void);
Raymond Hettingerdb29e0f2004-10-07 06:46:25 +0000102
Victor Stinnerd860d5c2013-12-10 01:19:58 +0100103PyAPI_FUNC(PyObject *) _PyImport_FindBuiltin(
Eric Snowd393c1b2017-09-14 12:18:12 -0600104 const char *name, /* UTF-8 encoded string */
105 PyObject *modules
Victor Stinnerd7e76402011-02-22 23:38:34 +0000106 );
Victor Stinnerd860d5c2013-12-10 01:19:58 +0100107PyAPI_FUNC(PyObject *) _PyImport_FindExtensionObject(PyObject *, PyObject *);
Eric Snowd393c1b2017-09-14 12:18:12 -0600108PyAPI_FUNC(PyObject *) _PyImport_FindExtensionObjectEx(PyObject *, PyObject *,
109 PyObject *);
Victor Stinnerd860d5c2013-12-10 01:19:58 +0100110PyAPI_FUNC(int) _PyImport_FixupBuiltin(
Victor Stinnerd7e76402011-02-22 23:38:34 +0000111 PyObject *mod,
Eric Snowd393c1b2017-09-14 12:18:12 -0600112 const char *name, /* UTF-8 encoded string */
113 PyObject *modules
Victor Stinnerd7e76402011-02-22 23:38:34 +0000114 );
Eric Snowd393c1b2017-09-14 12:18:12 -0600115PyAPI_FUNC(int) _PyImport_FixupExtensionObject(PyObject*, PyObject *,
116 PyObject *, PyObject *);
Guido van Rossum29e46a91997-08-02 02:56:48 +0000117
Guido van Rossum39c2aae1996-05-22 17:25:28 +0000118struct _inittab {
Serhiy Storchakac6792272013-10-19 21:03:34 +0300119 const char *name; /* ASCII encoded string */
Martin v. Löwis1a214512008-06-11 05:26:20 +0000120 PyObject* (*initfunc)(void);
Guido van Rossum39c2aae1996-05-22 17:25:28 +0000121};
Martin v. Löwis4d0d4712010-12-03 20:14:31 +0000122PyAPI_DATA(struct _inittab *) PyImport_Inittab;
123PyAPI_FUNC(int) PyImport_ExtendInittab(struct _inittab *newtab);
124#endif /* Py_LIMITED_API */
Guido van Rossum39c2aae1996-05-22 17:25:28 +0000125
Christian Heimes9cd17752007-11-18 19:35:23 +0000126PyAPI_DATA(PyTypeObject) PyNullImporter_Type;
Guido van Rossuma3309961993-07-28 09:05:47 +0000127
Victor Stinnerd7e76402011-02-22 23:38:34 +0000128PyAPI_FUNC(int) PyImport_AppendInittab(
129 const char *name, /* ASCII encoded string */
130 PyObject* (*initfunc)(void)
131 );
Guido van Rossum16926bd1998-06-29 20:34:46 +0000132
Martin v. Löwis4d0d4712010-12-03 20:14:31 +0000133#ifndef Py_LIMITED_API
Guido van Rossum4ee68d91996-06-17 17:05:01 +0000134struct _frozen {
Benjamin Peterson7701e6e2013-03-13 14:06:39 -0500135 const char *name; /* ASCII encoded string */
136 const unsigned char *code;
Fred Drake5eb6d4e2000-07-08 23:37:28 +0000137 int size;
Guido van Rossum4ee68d91996-06-17 17:05:01 +0000138};
139
140/* Embedding apps may change this pointer to point to their favorite
141 collection of frozen modules: */
142
Benjamin Peterson7701e6e2013-03-13 14:06:39 -0500143PyAPI_DATA(const struct _frozen *) PyImport_FrozenModules;
Martin v. Löwis4d0d4712010-12-03 20:14:31 +0000144#endif
Guido van Rossum4ee68d91996-06-17 17:05:01 +0000145
Guido van Rossuma3309961993-07-28 09:05:47 +0000146#ifdef __cplusplus
147}
148#endif
149#endif /* !Py_IMPORT_H */