blob: 46c0d8e8e7b6a611400f58c357a39f43fd61090a [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
Brett Cannonfd074152012-04-14 14:10:13 -040011PyAPI_FUNC(void) _PyImportZip_Init(void);
Serhiy Storchaka9fab79b2016-09-11 11:03:14 +030012#endif /* !Py_LIMITED_API */
Brett Cannonfd074152012-04-14 14:10:13 -040013
14PyMODINIT_FUNC PyInit_imp(void);
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 );
Victor Stinner27ee0892011-03-04 12:57:09 +000032PyAPI_FUNC(PyObject *) PyImport_ExecCodeModuleObject(
33 PyObject *name,
34 PyObject *co,
35 PyObject *pathname,
36 PyObject *cpathname
37 );
Mark Hammond8235ea12002-07-19 06:55:41 +000038PyAPI_FUNC(PyObject *) PyImport_GetModuleDict(void);
Victor Stinner27ee0892011-03-04 12:57:09 +000039PyAPI_FUNC(PyObject *) PyImport_AddModuleObject(
40 PyObject *name
41 );
Victor Stinnerd7e76402011-02-22 23:38:34 +000042PyAPI_FUNC(PyObject *) PyImport_AddModule(
43 const char *name /* UTF-8 encoded string */
44 );
45PyAPI_FUNC(PyObject *) PyImport_ImportModule(
46 const char *name /* UTF-8 encoded string */
47 );
48PyAPI_FUNC(PyObject *) PyImport_ImportModuleNoBlock(
49 const char *name /* UTF-8 encoded string */
50 );
51PyAPI_FUNC(PyObject *) PyImport_ImportModuleLevel(
Benjamin Peterson04778a82011-05-25 09:29:00 -050052 const char *name, /* UTF-8 encoded string */
Victor Stinnerd7e76402011-02-22 23:38:34 +000053 PyObject *globals,
54 PyObject *locals,
55 PyObject *fromlist,
56 int level
57 );
Victor Stinnerfe93faf2011-03-14 15:54:52 -040058PyAPI_FUNC(PyObject *) PyImport_ImportModuleLevelObject(
59 PyObject *name,
60 PyObject *globals,
61 PyObject *locals,
62 PyObject *fromlist,
63 int level
64 );
Thomas Woutersf7f438b2006-02-28 16:09:29 +000065
Thomas Woutersf7f438b2006-02-28 16:09:29 +000066#define PyImport_ImportModuleEx(n, g, l, f) \
Brett Cannon522267e2012-08-10 18:55:08 -040067 PyImport_ImportModuleLevel(n, g, l, f, 0)
Thomas Woutersf7f438b2006-02-28 16:09:29 +000068
Christian Heimes9cd17752007-11-18 19:35:23 +000069PyAPI_FUNC(PyObject *) PyImport_GetImporter(PyObject *path);
Mark Hammond8235ea12002-07-19 06:55:41 +000070PyAPI_FUNC(PyObject *) PyImport_Import(PyObject *name);
71PyAPI_FUNC(PyObject *) PyImport_ReloadModule(PyObject *m);
72PyAPI_FUNC(void) PyImport_Cleanup(void);
Victor Stinner53dc7352011-03-20 01:50:21 +010073PyAPI_FUNC(int) PyImport_ImportFrozenModuleObject(
74 PyObject *name
75 );
Victor Stinnerd7e76402011-02-22 23:38:34 +000076PyAPI_FUNC(int) PyImport_ImportFrozenModule(
Serhiy Storchakac6792272013-10-19 21:03:34 +030077 const char *name /* UTF-8 encoded string */
Victor Stinnerd7e76402011-02-22 23:38:34 +000078 );
Fred Drake5eb6d4e2000-07-08 23:37:28 +000079
Martin v. Löwis4d0d4712010-12-03 20:14:31 +000080#ifndef Py_LIMITED_API
Benjamin Peterson0df35a92009-10-04 20:32:25 +000081#ifdef WITH_THREAD
82PyAPI_FUNC(void) _PyImport_AcquireLock(void);
83PyAPI_FUNC(int) _PyImport_ReleaseLock(void);
84#else
85#define _PyImport_AcquireLock()
86#define _PyImport_ReleaseLock() 1
87#endif
88
Guido van Rossum8ee3e5a2005-09-14 18:09:42 +000089PyAPI_FUNC(void) _PyImport_ReInitLock(void);
Raymond Hettingerdb29e0f2004-10-07 06:46:25 +000090
Victor Stinnerd860d5c2013-12-10 01:19:58 +010091PyAPI_FUNC(PyObject *) _PyImport_FindBuiltin(
Victor Stinner501c09a2011-02-23 00:02:00 +000092 const char *name /* UTF-8 encoded string */
Victor Stinnerd7e76402011-02-22 23:38:34 +000093 );
Victor Stinnerd860d5c2013-12-10 01:19:58 +010094PyAPI_FUNC(PyObject *) _PyImport_FindExtensionObject(PyObject *, PyObject *);
95PyAPI_FUNC(int) _PyImport_FixupBuiltin(
Victor Stinnerd7e76402011-02-22 23:38:34 +000096 PyObject *mod,
Serhiy Storchakac6792272013-10-19 21:03:34 +030097 const char *name /* UTF-8 encoded string */
Victor Stinnerd7e76402011-02-22 23:38:34 +000098 );
Victor Stinnerd860d5c2013-12-10 01:19:58 +010099PyAPI_FUNC(int) _PyImport_FixupExtensionObject(PyObject*, PyObject *, PyObject *);
Guido van Rossum29e46a91997-08-02 02:56:48 +0000100
Guido van Rossum39c2aae1996-05-22 17:25:28 +0000101struct _inittab {
Serhiy Storchakac6792272013-10-19 21:03:34 +0300102 const char *name; /* ASCII encoded string */
Martin v. Löwis1a214512008-06-11 05:26:20 +0000103 PyObject* (*initfunc)(void);
Guido van Rossum39c2aae1996-05-22 17:25:28 +0000104};
Martin v. Löwis4d0d4712010-12-03 20:14:31 +0000105PyAPI_DATA(struct _inittab *) PyImport_Inittab;
106PyAPI_FUNC(int) PyImport_ExtendInittab(struct _inittab *newtab);
107#endif /* Py_LIMITED_API */
Guido van Rossum39c2aae1996-05-22 17:25:28 +0000108
Christian Heimes9cd17752007-11-18 19:35:23 +0000109PyAPI_DATA(PyTypeObject) PyNullImporter_Type;
Guido van Rossuma3309961993-07-28 09:05:47 +0000110
Victor Stinnerd7e76402011-02-22 23:38:34 +0000111PyAPI_FUNC(int) PyImport_AppendInittab(
112 const char *name, /* ASCII encoded string */
113 PyObject* (*initfunc)(void)
114 );
Guido van Rossum16926bd1998-06-29 20:34:46 +0000115
Martin v. Löwis4d0d4712010-12-03 20:14:31 +0000116#ifndef Py_LIMITED_API
Guido van Rossum4ee68d91996-06-17 17:05:01 +0000117struct _frozen {
Benjamin Peterson7701e6e2013-03-13 14:06:39 -0500118 const char *name; /* ASCII encoded string */
119 const unsigned char *code;
Fred Drake5eb6d4e2000-07-08 23:37:28 +0000120 int size;
Guido van Rossum4ee68d91996-06-17 17:05:01 +0000121};
122
123/* Embedding apps may change this pointer to point to their favorite
124 collection of frozen modules: */
125
Benjamin Peterson7701e6e2013-03-13 14:06:39 -0500126PyAPI_DATA(const struct _frozen *) PyImport_FrozenModules;
Martin v. Löwis4d0d4712010-12-03 20:14:31 +0000127#endif
Guido van Rossum4ee68d91996-06-17 17:05:01 +0000128
Guido van Rossuma3309961993-07-28 09:05:47 +0000129#ifdef __cplusplus
130}
131#endif
132#endif /* !Py_IMPORT_H */