blob: 26e1f0f28dad595534510d87dd1b53109db40d09 [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
Mark Hammond8235ea12002-07-19 06:55:41 +000010PyAPI_FUNC(long) PyImport_GetMagicNumber(void);
Barry Warsaw28a691b2010-04-17 00:19:56 +000011PyAPI_FUNC(const char *) PyImport_GetMagicTag(void);
Victor Stinnerd7e76402011-02-22 23:38:34 +000012PyAPI_FUNC(PyObject *) PyImport_ExecCodeModule(
13 char *name, /* UTF-8 encoded string */
14 PyObject *co
15 );
Mark Hammond8235ea12002-07-19 06:55:41 +000016PyAPI_FUNC(PyObject *) PyImport_ExecCodeModuleEx(
Victor Stinnerd7e76402011-02-22 23:38:34 +000017 char *name, /* UTF-8 encoded string */
18 PyObject *co,
19 char *pathname /* decoded from the filesystem encoding */
20 );
Barry Warsaw28a691b2010-04-17 00:19:56 +000021PyAPI_FUNC(PyObject *) PyImport_ExecCodeModuleWithPathnames(
Victor Stinnerd7e76402011-02-22 23:38:34 +000022 char *name, /* UTF-8 encoded string */
23 PyObject *co,
24 char *pathname, /* decoded from the filesystem encoding */
25 char *cpathname /* decoded from the filesystem encoding */
26 );
Mark Hammond8235ea12002-07-19 06:55:41 +000027PyAPI_FUNC(PyObject *) PyImport_GetModuleDict(void);
Victor Stinnerd7e76402011-02-22 23:38:34 +000028PyAPI_FUNC(PyObject *) PyImport_AddModule(
29 const char *name /* UTF-8 encoded string */
30 );
31PyAPI_FUNC(PyObject *) PyImport_ImportModule(
32 const char *name /* UTF-8 encoded string */
33 );
34PyAPI_FUNC(PyObject *) PyImport_ImportModuleNoBlock(
35 const char *name /* UTF-8 encoded string */
36 );
37PyAPI_FUNC(PyObject *) PyImport_ImportModuleLevel(
38 char *name, /* UTF-8 encoded string */
39 PyObject *globals,
40 PyObject *locals,
41 PyObject *fromlist,
42 int level
43 );
Thomas Woutersf7f438b2006-02-28 16:09:29 +000044
Thomas Woutersf7f438b2006-02-28 16:09:29 +000045#define PyImport_ImportModuleEx(n, g, l, f) \
Victor Stinnerd7e76402011-02-22 23:38:34 +000046 PyImport_ImportModuleLevel(n, g, l, f, -1)
Thomas Woutersf7f438b2006-02-28 16:09:29 +000047
Christian Heimes9cd17752007-11-18 19:35:23 +000048PyAPI_FUNC(PyObject *) PyImport_GetImporter(PyObject *path);
Mark Hammond8235ea12002-07-19 06:55:41 +000049PyAPI_FUNC(PyObject *) PyImport_Import(PyObject *name);
50PyAPI_FUNC(PyObject *) PyImport_ReloadModule(PyObject *m);
51PyAPI_FUNC(void) PyImport_Cleanup(void);
Victor Stinnerd7e76402011-02-22 23:38:34 +000052PyAPI_FUNC(int) PyImport_ImportFrozenModule(
53 char *name /* UTF-8 encoded string */
54 );
Fred Drake5eb6d4e2000-07-08 23:37:28 +000055
Martin v. Löwis4d0d4712010-12-03 20:14:31 +000056#ifndef Py_LIMITED_API
Benjamin Peterson0df35a92009-10-04 20:32:25 +000057#ifdef WITH_THREAD
58PyAPI_FUNC(void) _PyImport_AcquireLock(void);
59PyAPI_FUNC(int) _PyImport_ReleaseLock(void);
60#else
61#define _PyImport_AcquireLock()
62#define _PyImport_ReleaseLock() 1
63#endif
64
Guido van Rossum8ee3e5a2005-09-14 18:09:42 +000065PyAPI_FUNC(void) _PyImport_ReInitLock(void);
Raymond Hettingerdb29e0f2004-10-07 06:46:25 +000066
Victor Stinnerd7e76402011-02-22 23:38:34 +000067PyAPI_FUNC(PyObject *)_PyImport_FindBuiltin(
Victor Stinner501c09a2011-02-23 00:02:00 +000068 const char *name /* UTF-8 encoded string */
Victor Stinnerd7e76402011-02-22 23:38:34 +000069 );
Victor Stinner501c09a2011-02-23 00:02:00 +000070PyAPI_FUNC(PyObject *)_PyImport_FindExtensionUnicode(const char *, PyObject *);
Victor Stinnerd7e76402011-02-22 23:38:34 +000071PyAPI_FUNC(int)_PyImport_FixupBuiltin(
72 PyObject *mod,
73 char *name /* UTF-8 encoded string */
74 );
Victor Stinner49d3f252010-10-17 01:24:53 +000075PyAPI_FUNC(int)_PyImport_FixupExtensionUnicode(PyObject*, char *, PyObject *);
Guido van Rossum29e46a91997-08-02 02:56:48 +000076
Guido van Rossum39c2aae1996-05-22 17:25:28 +000077struct _inittab {
Fred Drake5eb6d4e2000-07-08 23:37:28 +000078 char *name;
Martin v. Löwis1a214512008-06-11 05:26:20 +000079 PyObject* (*initfunc)(void);
Guido van Rossum39c2aae1996-05-22 17:25:28 +000080};
Martin v. Löwis4d0d4712010-12-03 20:14:31 +000081PyAPI_DATA(struct _inittab *) PyImport_Inittab;
82PyAPI_FUNC(int) PyImport_ExtendInittab(struct _inittab *newtab);
83#endif /* Py_LIMITED_API */
Guido van Rossum39c2aae1996-05-22 17:25:28 +000084
Christian Heimes9cd17752007-11-18 19:35:23 +000085PyAPI_DATA(PyTypeObject) PyNullImporter_Type;
Guido van Rossuma3309961993-07-28 09:05:47 +000086
Victor Stinnerd7e76402011-02-22 23:38:34 +000087PyAPI_FUNC(int) PyImport_AppendInittab(
88 const char *name, /* ASCII encoded string */
89 PyObject* (*initfunc)(void)
90 );
Guido van Rossum16926bd1998-06-29 20:34:46 +000091
Martin v. Löwis4d0d4712010-12-03 20:14:31 +000092#ifndef Py_LIMITED_API
Guido van Rossum4ee68d91996-06-17 17:05:01 +000093struct _frozen {
Victor Stinnerd7e76402011-02-22 23:38:34 +000094 char *name; /* ASCII encoded string */
Fred Drake5eb6d4e2000-07-08 23:37:28 +000095 unsigned char *code;
96 int size;
Guido van Rossum4ee68d91996-06-17 17:05:01 +000097};
98
99/* Embedding apps may change this pointer to point to their favorite
100 collection of frozen modules: */
101
Mark Hammonda2905272002-07-29 13:42:14 +0000102PyAPI_DATA(struct _frozen *) PyImport_FrozenModules;
Martin v. Löwis4d0d4712010-12-03 20:14:31 +0000103#endif
Guido van Rossum4ee68d91996-06-17 17:05:01 +0000104
Guido van Rossuma3309961993-07-28 09:05:47 +0000105#ifdef __cplusplus
106}
107#endif
108#endif /* !Py_IMPORT_H */