blob: f2d79b80491125c69c8332e6e0ceaf98e61b5b65 [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 );
Victor Stinner27ee0892011-03-04 12:57:09 +000027PyAPI_FUNC(PyObject *) PyImport_ExecCodeModuleObject(
28 PyObject *name,
29 PyObject *co,
30 PyObject *pathname,
31 PyObject *cpathname
32 );
Mark Hammond8235ea12002-07-19 06:55:41 +000033PyAPI_FUNC(PyObject *) PyImport_GetModuleDict(void);
Victor Stinner27ee0892011-03-04 12:57:09 +000034PyAPI_FUNC(PyObject *) PyImport_AddModuleObject(
35 PyObject *name
36 );
Victor Stinnerd7e76402011-02-22 23:38:34 +000037PyAPI_FUNC(PyObject *) PyImport_AddModule(
38 const char *name /* UTF-8 encoded string */
39 );
40PyAPI_FUNC(PyObject *) PyImport_ImportModule(
41 const char *name /* UTF-8 encoded string */
42 );
43PyAPI_FUNC(PyObject *) PyImport_ImportModuleNoBlock(
44 const char *name /* UTF-8 encoded string */
45 );
46PyAPI_FUNC(PyObject *) PyImport_ImportModuleLevel(
47 char *name, /* UTF-8 encoded string */
48 PyObject *globals,
49 PyObject *locals,
50 PyObject *fromlist,
51 int level
52 );
Thomas Woutersf7f438b2006-02-28 16:09:29 +000053
Thomas Woutersf7f438b2006-02-28 16:09:29 +000054#define PyImport_ImportModuleEx(n, g, l, f) \
Victor Stinnerd7e76402011-02-22 23:38:34 +000055 PyImport_ImportModuleLevel(n, g, l, f, -1)
Thomas Woutersf7f438b2006-02-28 16:09:29 +000056
Christian Heimes9cd17752007-11-18 19:35:23 +000057PyAPI_FUNC(PyObject *) PyImport_GetImporter(PyObject *path);
Mark Hammond8235ea12002-07-19 06:55:41 +000058PyAPI_FUNC(PyObject *) PyImport_Import(PyObject *name);
59PyAPI_FUNC(PyObject *) PyImport_ReloadModule(PyObject *m);
60PyAPI_FUNC(void) PyImport_Cleanup(void);
Victor Stinnerd7e76402011-02-22 23:38:34 +000061PyAPI_FUNC(int) PyImport_ImportFrozenModule(
62 char *name /* UTF-8 encoded string */
63 );
Fred Drake5eb6d4e2000-07-08 23:37:28 +000064
Martin v. Löwis4d0d4712010-12-03 20:14:31 +000065#ifndef Py_LIMITED_API
Benjamin Peterson0df35a92009-10-04 20:32:25 +000066#ifdef WITH_THREAD
67PyAPI_FUNC(void) _PyImport_AcquireLock(void);
68PyAPI_FUNC(int) _PyImport_ReleaseLock(void);
69#else
70#define _PyImport_AcquireLock()
71#define _PyImport_ReleaseLock() 1
72#endif
73
Guido van Rossum8ee3e5a2005-09-14 18:09:42 +000074PyAPI_FUNC(void) _PyImport_ReInitLock(void);
Raymond Hettingerdb29e0f2004-10-07 06:46:25 +000075
Victor Stinnerd7e76402011-02-22 23:38:34 +000076PyAPI_FUNC(PyObject *)_PyImport_FindBuiltin(
Victor Stinner501c09a2011-02-23 00:02:00 +000077 const char *name /* UTF-8 encoded string */
Victor Stinnerd7e76402011-02-22 23:38:34 +000078 );
Victor Stinner501c09a2011-02-23 00:02:00 +000079PyAPI_FUNC(PyObject *)_PyImport_FindExtensionUnicode(const char *, PyObject *);
Victor Stinnerd7e76402011-02-22 23:38:34 +000080PyAPI_FUNC(int)_PyImport_FixupBuiltin(
81 PyObject *mod,
82 char *name /* UTF-8 encoded string */
83 );
Victor Stinner49d3f252010-10-17 01:24:53 +000084PyAPI_FUNC(int)_PyImport_FixupExtensionUnicode(PyObject*, char *, PyObject *);
Guido van Rossum29e46a91997-08-02 02:56:48 +000085
Guido van Rossum39c2aae1996-05-22 17:25:28 +000086struct _inittab {
Fred Drake5eb6d4e2000-07-08 23:37:28 +000087 char *name;
Martin v. Löwis1a214512008-06-11 05:26:20 +000088 PyObject* (*initfunc)(void);
Guido van Rossum39c2aae1996-05-22 17:25:28 +000089};
Martin v. Löwis4d0d4712010-12-03 20:14:31 +000090PyAPI_DATA(struct _inittab *) PyImport_Inittab;
91PyAPI_FUNC(int) PyImport_ExtendInittab(struct _inittab *newtab);
92#endif /* Py_LIMITED_API */
Guido van Rossum39c2aae1996-05-22 17:25:28 +000093
Christian Heimes9cd17752007-11-18 19:35:23 +000094PyAPI_DATA(PyTypeObject) PyNullImporter_Type;
Guido van Rossuma3309961993-07-28 09:05:47 +000095
Victor Stinnerd7e76402011-02-22 23:38:34 +000096PyAPI_FUNC(int) PyImport_AppendInittab(
97 const char *name, /* ASCII encoded string */
98 PyObject* (*initfunc)(void)
99 );
Guido van Rossum16926bd1998-06-29 20:34:46 +0000100
Martin v. Löwis4d0d4712010-12-03 20:14:31 +0000101#ifndef Py_LIMITED_API
Guido van Rossum4ee68d91996-06-17 17:05:01 +0000102struct _frozen {
Victor Stinnerd7e76402011-02-22 23:38:34 +0000103 char *name; /* ASCII encoded string */
Fred Drake5eb6d4e2000-07-08 23:37:28 +0000104 unsigned char *code;
105 int size;
Guido van Rossum4ee68d91996-06-17 17:05:01 +0000106};
107
108/* Embedding apps may change this pointer to point to their favorite
109 collection of frozen modules: */
110
Mark Hammonda2905272002-07-29 13:42:14 +0000111PyAPI_DATA(struct _frozen *) PyImport_FrozenModules;
Martin v. Löwis4d0d4712010-12-03 20:14:31 +0000112#endif
Guido van Rossum4ee68d91996-06-17 17:05:01 +0000113
Guido van Rossuma3309961993-07-28 09:05:47 +0000114#ifdef __cplusplus
115}
116#endif
117#endif /* !Py_IMPORT_H */