blob: 50267895c5eb9676259471e1a8d138e139d02cf3 [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 implementation */
3
Guido van Rossum79f25d91997-04-29 20:08:16 +00004#include "Python.h"
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00005
Jeremy Hylton3e0055f2005-10-20 19:59:25 +00006#include "Python-ast.h"
Guido van Rossumd8faa362007-04-27 19:54:29 +00007#undef Yield /* undefine macro conflicting with winbase.h */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00008#include "errcode.h"
Guido van Rossumc405b7b1991-06-04 19:39:42 +00009#include "marshal.h"
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000010#include "code.h"
Antoine Pitroubc07a5c2012-07-08 12:01:27 +020011#include "frameobject.h"
Guido van Rossumd8bac6d1992-02-26 15:19:13 +000012#include "osdefs.h"
Guido van Rossum1ae940a1995-01-02 19:04:15 +000013#include "importdl.h"
Guido van Rossumc405b7b1991-06-04 19:39:42 +000014
Guido van Rossum55a83382000-09-20 20:31:38 +000015#ifdef HAVE_FCNTL_H
16#include <fcntl.h>
17#endif
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000018#ifdef __cplusplus
Brett Cannon9a5b25a2010-03-01 02:09:17 +000019extern "C" {
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000020#endif
Guido van Rossum55a83382000-09-20 20:31:38 +000021
Christian Heimesd3eb5a152008-02-24 00:38:49 +000022#ifdef MS_WINDOWS
23/* for stat.st_mode */
24typedef unsigned short mode_t;
Daniel Stutzbachc7937792010-09-09 21:18:04 +000025/* for _mkdir */
26#include <direct.h>
Christian Heimesd3eb5a152008-02-24 00:38:49 +000027#endif
28
Guido van Rossum21d335e1993-10-15 13:01:11 +000029
Barry Warsaw28a691b2010-04-17 00:19:56 +000030#define CACHEDIR "__pycache__"
Guido van Rossum96774c12000-05-01 20:19:08 +000031
Victor Stinner95872862011-03-07 18:20:56 +010032/* See _PyImport_FixupExtensionObject() below */
Guido van Rossum25ce5661997-08-02 03:10:38 +000033static PyObject *extensions = NULL;
Guido van Rossum3f5da241990-12-20 15:06:42 +000034
Victor Stinnerfe7c5b52011-04-05 01:48:03 +020035/* Function from Parser/tokenizer.c */
36extern char * PyTokenizer_FindEncodingFilename(int, PyObject *);
37
Guido van Rossum771c6c81997-10-31 18:37:24 +000038/* This table is defined in config.c: */
39extern struct _inittab _PyImport_Inittab[];
40
41struct _inittab *PyImport_Inittab = _PyImport_Inittab;
Guido van Rossum66f1fa81991-04-03 19:03:52 +000042
Victor Stinnerd0296212011-03-14 14:04:10 -040043static PyObject *initstr = NULL;
Thomas Wouters0e3f5912006-08-11 14:57:12 +000044
Guido van Rossum1ae940a1995-01-02 19:04:15 +000045/* Initialize things */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000046
47void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +000048_PyImport_Init(void)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000049{
Victor Stinnerd0296212011-03-14 14:04:10 -040050 initstr = PyUnicode_InternFromString("__init__");
51 if (initstr == NULL)
52 Py_FatalError("Can't initialize import variables");
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000053}
54
Guido van Rossum25ce5661997-08-02 03:10:38 +000055void
Just van Rossum52e14d62002-12-30 22:08:05 +000056_PyImportHooks_Init(void)
57{
Brett Cannonfd074152012-04-14 14:10:13 -040058 PyObject *v, *path_hooks = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000059 int err = 0;
Just van Rossum52e14d62002-12-30 22:08:05 +000060
Brett Cannonfd074152012-04-14 14:10:13 -040061 /* adding sys.path_hooks and sys.path_importer_cache */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000062 v = PyList_New(0);
63 if (v == NULL)
64 goto error;
65 err = PySys_SetObject("meta_path", v);
66 Py_DECREF(v);
67 if (err)
68 goto error;
69 v = PyDict_New();
70 if (v == NULL)
71 goto error;
72 err = PySys_SetObject("path_importer_cache", v);
73 Py_DECREF(v);
74 if (err)
75 goto error;
76 path_hooks = PyList_New(0);
77 if (path_hooks == NULL)
78 goto error;
79 err = PySys_SetObject("path_hooks", path_hooks);
80 if (err) {
Just van Rossum52e14d62002-12-30 22:08:05 +000081 error:
Brett Cannonfd074152012-04-14 14:10:13 -040082 PyErr_Print();
83 Py_FatalError("initializing sys.meta_path, sys.path_hooks, "
Nadeem Vawda8f46d652012-05-05 12:27:30 +020084 "or path_importer_cache failed");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000085 }
Brett Cannonfd074152012-04-14 14:10:13 -040086 Py_DECREF(path_hooks);
87}
88
89void
90_PyImportZip_Init(void)
91{
92 PyObject *path_hooks, *zimpimport;
93 int err = 0;
94
95 path_hooks = PySys_GetObject("path_hooks");
96 if (path_hooks == NULL)
97 goto error;
98
99 if (Py_VerboseFlag)
100 PySys_WriteStderr("# installing zipimport hook\n");
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000101
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000102 zimpimport = PyImport_ImportModule("zipimport");
103 if (zimpimport == NULL) {
104 PyErr_Clear(); /* No zip import module -- okay */
105 if (Py_VerboseFlag)
106 PySys_WriteStderr("# can't import zipimport\n");
107 }
108 else {
Martin v. Löwisbd928fe2011-10-14 10:20:37 +0200109 _Py_IDENTIFIER(zipimporter);
Martin v. Löwis1ee1b6f2011-10-10 18:11:30 +0200110 PyObject *zipimporter = _PyObject_GetAttrId(zimpimport,
111 &PyId_zipimporter);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000112 Py_DECREF(zimpimport);
113 if (zipimporter == NULL) {
114 PyErr_Clear(); /* No zipimporter object -- okay */
115 if (Py_VerboseFlag)
116 PySys_WriteStderr(
117 "# can't import zipimport.zipimporter\n");
118 }
119 else {
Brett Cannon8923a4d2012-04-24 22:03:46 -0400120 /* sys.path_hooks.insert(0, zipimporter) */
121 err = PyList_Insert(path_hooks, 0, zipimporter);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000122 Py_DECREF(zipimporter);
Brett Cannonfd074152012-04-14 14:10:13 -0400123 if (err < 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000124 goto error;
Brett Cannonfd074152012-04-14 14:10:13 -0400125 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000126 if (Py_VerboseFlag)
127 PySys_WriteStderr(
128 "# installed zipimport hook\n");
129 }
130 }
Brett Cannonfd074152012-04-14 14:10:13 -0400131
132 return;
133
134 error:
135 PyErr_Print();
Brett Cannonacf85cd2012-04-29 12:50:03 -0400136 Py_FatalError("initializing zipimport failed");
Just van Rossum52e14d62002-12-30 22:08:05 +0000137}
138
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000139/* Locking primitives to prevent parallel imports of the same module
140 in different threads to return with a partially loaded module.
141 These calls are serialized by the global interpreter lock. */
142
143#ifdef WITH_THREAD
144
Guido van Rossum49b56061998-10-01 20:42:43 +0000145#include "pythread.h"
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000146
Guido van Rossum65d5b571998-12-21 19:32:43 +0000147static PyThread_type_lock import_lock = 0;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000148static long import_lock_thread = -1;
149static int import_lock_level = 0;
150
Benjamin Peterson0df35a92009-10-04 20:32:25 +0000151void
152_PyImport_AcquireLock(void)
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000153{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000154 long me = PyThread_get_thread_ident();
155 if (me == -1)
156 return; /* Too bad */
157 if (import_lock == NULL) {
158 import_lock = PyThread_allocate_lock();
159 if (import_lock == NULL)
160 return; /* Nothing much we can do. */
161 }
162 if (import_lock_thread == me) {
163 import_lock_level++;
164 return;
165 }
166 if (import_lock_thread != -1 || !PyThread_acquire_lock(import_lock, 0))
167 {
168 PyThreadState *tstate = PyEval_SaveThread();
169 PyThread_acquire_lock(import_lock, 1);
170 PyEval_RestoreThread(tstate);
171 }
172 import_lock_thread = me;
173 import_lock_level = 1;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000174}
175
Benjamin Peterson0df35a92009-10-04 20:32:25 +0000176int
177_PyImport_ReleaseLock(void)
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000178{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000179 long me = PyThread_get_thread_ident();
180 if (me == -1 || import_lock == NULL)
181 return 0; /* Too bad */
182 if (import_lock_thread != me)
183 return -1;
184 import_lock_level--;
185 if (import_lock_level == 0) {
186 import_lock_thread = -1;
187 PyThread_release_lock(import_lock);
188 }
189 return 1;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000190}
191
Gregory P. Smith24cec9f2010-03-01 06:18:41 +0000192/* This function is called from PyOS_AfterFork to ensure that newly
193 created child processes do not share locks with the parent.
194 We now acquire the import lock around fork() calls but on some platforms
195 (Solaris 9 and earlier? see isue7242) that still left us with problems. */
Guido van Rossum8ee3e5a2005-09-14 18:09:42 +0000196
197void
198_PyImport_ReInitLock(void)
199{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000200 if (import_lock != NULL)
201 import_lock = PyThread_allocate_lock();
Nick Coghlanb2ddf792010-12-02 04:11:46 +0000202 if (import_lock_level > 1) {
203 /* Forked as a side effect of import */
204 long me = PyThread_get_thread_ident();
Brett Cannone4710cf2012-11-15 21:39:36 -0500205 /* The following could fail if the lock is already held, but forking as
206 a side-effect of an import is a) rare, b) nuts, and c) difficult to
207 do thanks to the lock only being held when doing individual module
208 locks per import. */
209 PyThread_acquire_lock(import_lock, NOWAIT_LOCK);
Nick Coghlanb2ddf792010-12-02 04:11:46 +0000210 import_lock_thread = me;
211 import_lock_level--;
212 } else {
213 import_lock_thread = -1;
214 import_lock_level = 0;
215 }
Guido van Rossum8ee3e5a2005-09-14 18:09:42 +0000216}
217
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000218#endif
219
Tim Peters69232342001-08-30 05:16:13 +0000220static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000221imp_lock_held(PyObject *self, PyObject *noargs)
Tim Peters69232342001-08-30 05:16:13 +0000222{
Tim Peters69232342001-08-30 05:16:13 +0000223#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000224 return PyBool_FromLong(import_lock_thread != -1);
Tim Peters69232342001-08-30 05:16:13 +0000225#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000226 return PyBool_FromLong(0);
Tim Peters69232342001-08-30 05:16:13 +0000227#endif
228}
229
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000230static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000231imp_acquire_lock(PyObject *self, PyObject *noargs)
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000232{
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000233#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000234 _PyImport_AcquireLock();
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000235#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000236 Py_INCREF(Py_None);
237 return Py_None;
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000238}
239
240static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000241imp_release_lock(PyObject *self, PyObject *noargs)
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000242{
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000243#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000244 if (_PyImport_ReleaseLock() < 0) {
245 PyErr_SetString(PyExc_RuntimeError,
246 "not holding the import lock");
247 return NULL;
248 }
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000249#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000250 Py_INCREF(Py_None);
251 return Py_None;
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000252}
253
Antoine Pitrou8db076c2011-10-30 19:13:55 +0100254void
255_PyImport_Fini(void)
256{
257 Py_XDECREF(extensions);
258 extensions = NULL;
Antoine Pitrou8db076c2011-10-30 19:13:55 +0100259#ifdef WITH_THREAD
260 if (import_lock != NULL) {
261 PyThread_free_lock(import_lock);
262 import_lock = NULL;
263 }
264#endif
265}
266
Guido van Rossum25ce5661997-08-02 03:10:38 +0000267/* Helper for sys */
268
269PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000270PyImport_GetModuleDict(void)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000271{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000272 PyInterpreterState *interp = PyThreadState_GET()->interp;
273 if (interp->modules == NULL)
274 Py_FatalError("PyImport_GetModuleDict: no module dictionary!");
275 return interp->modules;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000276}
277
Guido van Rossum3f5da241990-12-20 15:06:42 +0000278
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000279/* List of names to clear in sys */
280static char* sys_deletes[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000281 "path", "argv", "ps1", "ps2",
282 "last_type", "last_value", "last_traceback",
283 "path_hooks", "path_importer_cache", "meta_path",
284 /* misc stuff */
285 "flags", "float_info",
286 NULL
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000287};
288
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000289static char* sys_files[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000290 "stdin", "__stdin__",
291 "stdout", "__stdout__",
292 "stderr", "__stderr__",
293 NULL
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000294};
295
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000296
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000297/* Un-initialize things, as good as we can */
Guido van Rossum3f5da241990-12-20 15:06:42 +0000298
Guido van Rossum3f5da241990-12-20 15:06:42 +0000299void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000300PyImport_Cleanup(void)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000301{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000302 Py_ssize_t pos, ndone;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000303 PyObject *key, *value, *dict;
304 PyInterpreterState *interp = PyThreadState_GET()->interp;
305 PyObject *modules = interp->modules;
Guido van Rossum758eec01998-01-19 21:58:26 +0000306
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000307 if (modules == NULL)
308 return; /* Already done */
Guido van Rossum758eec01998-01-19 21:58:26 +0000309
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000310 /* Delete some special variables first. These are common
311 places where user values hide and people complain when their
312 destructors fail. Since the modules containing them are
313 deleted *last* of all, they would come too late in the normal
314 destruction order. Sigh. */
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000315
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000316 value = PyDict_GetItemString(modules, "builtins");
317 if (value != NULL && PyModule_Check(value)) {
318 dict = PyModule_GetDict(value);
319 if (Py_VerboseFlag)
320 PySys_WriteStderr("# clear builtins._\n");
321 PyDict_SetItemString(dict, "_", Py_None);
322 }
323 value = PyDict_GetItemString(modules, "sys");
324 if (value != NULL && PyModule_Check(value)) {
325 char **p;
326 PyObject *v;
327 dict = PyModule_GetDict(value);
328 for (p = sys_deletes; *p != NULL; p++) {
329 if (Py_VerboseFlag)
330 PySys_WriteStderr("# clear sys.%s\n", *p);
331 PyDict_SetItemString(dict, *p, Py_None);
332 }
333 for (p = sys_files; *p != NULL; p+=2) {
334 if (Py_VerboseFlag)
335 PySys_WriteStderr("# restore sys.%s\n", *p);
336 v = PyDict_GetItemString(dict, *(p+1));
337 if (v == NULL)
338 v = Py_None;
339 PyDict_SetItemString(dict, *p, v);
340 }
341 }
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000342
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000343 /* First, delete __main__ */
344 value = PyDict_GetItemString(modules, "__main__");
345 if (value != NULL && PyModule_Check(value)) {
346 if (Py_VerboseFlag)
347 PySys_WriteStderr("# cleanup __main__\n");
348 _PyModule_Clear(value);
349 PyDict_SetItemString(modules, "__main__", Py_None);
350 }
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000351
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000352 /* The special treatment of "builtins" here is because even
353 when it's not referenced as a module, its dictionary is
354 referenced by almost every module's __builtins__. Since
355 deleting a module clears its dictionary (even if there are
356 references left to it), we need to delete the "builtins"
357 module last. Likewise, we don't delete sys until the very
358 end because it is implicitly referenced (e.g. by print).
Guido van Rossum758eec01998-01-19 21:58:26 +0000359
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000360 Also note that we 'delete' modules by replacing their entry
361 in the modules dict with None, rather than really deleting
362 them; this avoids a rehash of the modules dictionary and
363 also marks them as "non existent" so they won't be
364 re-imported. */
Guido van Rossum758eec01998-01-19 21:58:26 +0000365
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000366 /* Next, repeatedly delete modules with a reference count of
367 one (skipping builtins and sys) and delete them */
368 do {
369 ndone = 0;
370 pos = 0;
371 while (PyDict_Next(modules, &pos, &key, &value)) {
372 if (value->ob_refcnt != 1)
373 continue;
374 if (PyUnicode_Check(key) && PyModule_Check(value)) {
Victor Stinner9464d612011-03-07 17:08:21 +0100375 if (PyUnicode_CompareWithASCIIString(key, "builtins") == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000376 continue;
Victor Stinner9464d612011-03-07 17:08:21 +0100377 if (PyUnicode_CompareWithASCIIString(key, "sys") == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000378 continue;
379 if (Py_VerboseFlag)
Victor Stinner9464d612011-03-07 17:08:21 +0100380 PySys_FormatStderr(
381 "# cleanup[1] %U\n", key);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000382 _PyModule_Clear(value);
383 PyDict_SetItem(modules, key, Py_None);
384 ndone++;
385 }
386 }
387 } while (ndone > 0);
Guido van Rossum758eec01998-01-19 21:58:26 +0000388
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000389 /* Next, delete all modules (still skipping builtins and sys) */
390 pos = 0;
391 while (PyDict_Next(modules, &pos, &key, &value)) {
392 if (PyUnicode_Check(key) && PyModule_Check(value)) {
Victor Stinner9464d612011-03-07 17:08:21 +0100393 if (PyUnicode_CompareWithASCIIString(key, "builtins") == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000394 continue;
Victor Stinner9464d612011-03-07 17:08:21 +0100395 if (PyUnicode_CompareWithASCIIString(key, "sys") == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000396 continue;
397 if (Py_VerboseFlag)
Victor Stinner9464d612011-03-07 17:08:21 +0100398 PySys_FormatStderr("# cleanup[2] %U\n", key);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000399 _PyModule_Clear(value);
400 PyDict_SetItem(modules, key, Py_None);
401 }
402 }
Guido van Rossum758eec01998-01-19 21:58:26 +0000403
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000404 /* Next, delete sys and builtins (in that order) */
405 value = PyDict_GetItemString(modules, "sys");
406 if (value != NULL && PyModule_Check(value)) {
407 if (Py_VerboseFlag)
408 PySys_WriteStderr("# cleanup sys\n");
409 _PyModule_Clear(value);
410 PyDict_SetItemString(modules, "sys", Py_None);
411 }
412 value = PyDict_GetItemString(modules, "builtins");
413 if (value != NULL && PyModule_Check(value)) {
414 if (Py_VerboseFlag)
415 PySys_WriteStderr("# cleanup builtins\n");
416 _PyModule_Clear(value);
417 PyDict_SetItemString(modules, "builtins", Py_None);
418 }
Guido van Rossum758eec01998-01-19 21:58:26 +0000419
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000420 /* Finally, clear and delete the modules directory */
421 PyDict_Clear(modules);
422 interp->modules = NULL;
423 Py_DECREF(modules);
Guido van Rossum8d15b5d1990-10-26 14:58:58 +0000424}
Guido van Rossum7f133ed1991-02-19 12:23:57 +0000425
426
Barry Warsaw28a691b2010-04-17 00:19:56 +0000427/* Helper for pythonrun.c -- return magic number and tag. */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000428
429long
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000430PyImport_GetMagicNumber(void)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000431{
Antoine Pitrou44b4b6a2012-07-10 18:27:54 +0200432 long res;
Brett Cannon77b2abd2012-07-09 16:09:00 -0400433 PyInterpreterState *interp = PyThreadState_Get()->interp;
434 PyObject *pyc_magic = PyObject_GetAttrString(interp->importlib,
435 "_RAW_MAGIC_NUMBER");
436 if (pyc_magic == NULL)
437 return -1;
Antoine Pitrou44b4b6a2012-07-10 18:27:54 +0200438 res = PyLong_AsLong(pyc_magic);
Benjamin Peterson66f36592012-07-09 22:21:55 -0700439 Py_DECREF(pyc_magic);
440 return res;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000441}
442
443
Brett Cannon3adc7b72012-07-09 14:22:12 -0400444extern const char * _PySys_ImplCacheTag;
445
Barry Warsaw28a691b2010-04-17 00:19:56 +0000446const char *
447PyImport_GetMagicTag(void)
448{
Brett Cannon3adc7b72012-07-09 14:22:12 -0400449 return _PySys_ImplCacheTag;
Barry Warsaw28a691b2010-04-17 00:19:56 +0000450}
451
Brett Cannon98979b82012-07-02 15:13:11 -0400452
Guido van Rossum25ce5661997-08-02 03:10:38 +0000453/* Magic for extension modules (built-in as well as dynamically
454 loaded). To prevent initializing an extension module more than
Andrew Svetlov6b2cbeb2012-12-14 17:04:59 +0200455 once, we keep a static dictionary 'extensions' keyed by the tuple
456 (module name, module name) (for built-in modules) or by
457 (filename, module name) (for dynamically loaded modules), containing these
458 modules. A copy of the module's dictionary is stored by calling
459 _PyImport_FixupExtensionObject() immediately after the module initialization
460 function succeeds. A copy can be retrieved from there by calling
Victor Stinner95872862011-03-07 18:20:56 +0100461 _PyImport_FindExtensionObject().
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000462
Barry Warsaw7c9627b2010-06-17 18:38:20 +0000463 Modules which do support multiple initialization set their m_size
464 field to a non-negative number (indicating the size of the
465 module-specific state). They are still recorded in the extensions
466 dictionary, to avoid loading shared libraries twice.
Martin v. Löwis1a214512008-06-11 05:26:20 +0000467*/
468
469int
Victor Stinner95872862011-03-07 18:20:56 +0100470_PyImport_FixupExtensionObject(PyObject *mod, PyObject *name,
471 PyObject *filename)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000472{
Benjamin Peterson5cb8a312012-12-15 00:05:16 -0500473 PyObject *modules, *dict, *key;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000474 struct PyModuleDef *def;
Benjamin Peterson5cb8a312012-12-15 00:05:16 -0500475 int res;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000476 if (extensions == NULL) {
477 extensions = PyDict_New();
478 if (extensions == NULL)
479 return -1;
480 }
481 if (mod == NULL || !PyModule_Check(mod)) {
482 PyErr_BadInternalCall();
483 return -1;
484 }
485 def = PyModule_GetDef(mod);
486 if (!def) {
487 PyErr_BadInternalCall();
488 return -1;
489 }
490 modules = PyImport_GetModuleDict();
Victor Stinner95872862011-03-07 18:20:56 +0100491 if (PyDict_SetItem(modules, name, mod) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000492 return -1;
493 if (_PyState_AddModule(mod, def) < 0) {
Victor Stinner95872862011-03-07 18:20:56 +0100494 PyDict_DelItem(modules, name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000495 return -1;
496 }
497 if (def->m_size == -1) {
498 if (def->m_base.m_copy) {
499 /* Somebody already imported the module,
500 likely under a different name.
501 XXX this should really not happen. */
502 Py_DECREF(def->m_base.m_copy);
503 def->m_base.m_copy = NULL;
504 }
505 dict = PyModule_GetDict(mod);
506 if (dict == NULL)
507 return -1;
508 def->m_base.m_copy = PyDict_Copy(dict);
509 if (def->m_base.m_copy == NULL)
510 return -1;
511 }
Benjamin Peterson5cb8a312012-12-15 00:05:16 -0500512 key = PyTuple_Pack(2, filename, name);
513 if (key == NULL)
Andrew Svetlov6b2cbeb2012-12-14 17:04:59 +0200514 return -1;
Benjamin Peterson5cb8a312012-12-15 00:05:16 -0500515 res = PyDict_SetItem(extensions, key, (PyObject *)def);
516 Py_DECREF(key);
517 if (res < 0)
Andrew Svetlov6b2cbeb2012-12-14 17:04:59 +0200518 return -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000519 return 0;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000520}
521
Victor Stinner49d3f252010-10-17 01:24:53 +0000522int
523_PyImport_FixupBuiltin(PyObject *mod, char *name)
524{
525 int res;
Victor Stinner95872862011-03-07 18:20:56 +0100526 PyObject *nameobj;
Victor Stinner21fcd0c2011-03-07 18:28:15 +0100527 nameobj = PyUnicode_InternFromString(name);
Victor Stinner95872862011-03-07 18:20:56 +0100528 if (nameobj == NULL)
Victor Stinner49d3f252010-10-17 01:24:53 +0000529 return -1;
Victor Stinner95872862011-03-07 18:20:56 +0100530 res = _PyImport_FixupExtensionObject(mod, nameobj, nameobj);
531 Py_DECREF(nameobj);
Victor Stinner49d3f252010-10-17 01:24:53 +0000532 return res;
533}
534
Guido van Rossum25ce5661997-08-02 03:10:38 +0000535PyObject *
Victor Stinner95872862011-03-07 18:20:56 +0100536_PyImport_FindExtensionObject(PyObject *name, PyObject *filename)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000537{
Benjamin Peterson5cb8a312012-12-15 00:05:16 -0500538 PyObject *mod, *mdict, *key;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000539 PyModuleDef* def;
540 if (extensions == NULL)
541 return NULL;
Benjamin Peterson5cb8a312012-12-15 00:05:16 -0500542 key = PyTuple_Pack(2, filename, name);
543 if (key == NULL)
Andrew Svetlov6b2cbeb2012-12-14 17:04:59 +0200544 return NULL;
Benjamin Peterson5cb8a312012-12-15 00:05:16 -0500545 def = (PyModuleDef *)PyDict_GetItem(extensions, key);
546 Py_DECREF(key);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000547 if (def == NULL)
548 return NULL;
549 if (def->m_size == -1) {
550 /* Module does not support repeated initialization */
551 if (def->m_base.m_copy == NULL)
552 return NULL;
Victor Stinner95872862011-03-07 18:20:56 +0100553 mod = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000554 if (mod == NULL)
555 return NULL;
556 mdict = PyModule_GetDict(mod);
557 if (mdict == NULL)
558 return NULL;
559 if (PyDict_Update(mdict, def->m_base.m_copy))
560 return NULL;
561 }
562 else {
563 if (def->m_base.m_init == NULL)
564 return NULL;
565 mod = def->m_base.m_init();
566 if (mod == NULL)
567 return NULL;
Victor Stinner95872862011-03-07 18:20:56 +0100568 PyDict_SetItem(PyImport_GetModuleDict(), name, mod);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000569 Py_DECREF(mod);
570 }
571 if (_PyState_AddModule(mod, def) < 0) {
Victor Stinner95872862011-03-07 18:20:56 +0100572 PyDict_DelItem(PyImport_GetModuleDict(), name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000573 Py_DECREF(mod);
574 return NULL;
575 }
576 if (Py_VerboseFlag)
Victor Stinner95872862011-03-07 18:20:56 +0100577 PySys_FormatStderr("import %U # previously loaded (%R)\n",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000578 name, filename);
579 return mod;
Brett Cannon9a5b25a2010-03-01 02:09:17 +0000580
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000581}
582
Victor Stinner49d3f252010-10-17 01:24:53 +0000583PyObject *
Victor Stinner501c09a2011-02-23 00:02:00 +0000584_PyImport_FindBuiltin(const char *name)
Victor Stinner49d3f252010-10-17 01:24:53 +0000585{
Victor Stinner95872862011-03-07 18:20:56 +0100586 PyObject *res, *nameobj;
Victor Stinner21fcd0c2011-03-07 18:28:15 +0100587 nameobj = PyUnicode_InternFromString(name);
Victor Stinner95872862011-03-07 18:20:56 +0100588 if (nameobj == NULL)
Victor Stinner49d3f252010-10-17 01:24:53 +0000589 return NULL;
Victor Stinner95872862011-03-07 18:20:56 +0100590 res = _PyImport_FindExtensionObject(nameobj, nameobj);
591 Py_DECREF(nameobj);
Victor Stinner49d3f252010-10-17 01:24:53 +0000592 return res;
593}
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000594
595/* Get the module object corresponding to a module name.
596 First check the modules dictionary if there's one there,
Walter Dörwaldf0dfc7a2003-10-20 14:01:56 +0000597 if not, create a new one and insert it in the modules dictionary.
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000598 Because the former action is most common, THIS DOES NOT RETURN A
599 'NEW' REFERENCE! */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000600
Guido van Rossum79f25d91997-04-29 20:08:16 +0000601PyObject *
Victor Stinner27ee0892011-03-04 12:57:09 +0000602PyImport_AddModuleObject(PyObject *name)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000603{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000604 PyObject *modules = PyImport_GetModuleDict();
605 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000606
Victor Stinner27ee0892011-03-04 12:57:09 +0000607 if ((m = PyDict_GetItem(modules, name)) != NULL &&
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000608 PyModule_Check(m))
609 return m;
Victor Stinner27ee0892011-03-04 12:57:09 +0000610 m = PyModule_NewObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000611 if (m == NULL)
612 return NULL;
Victor Stinner27ee0892011-03-04 12:57:09 +0000613 if (PyDict_SetItem(modules, name, m) != 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000614 Py_DECREF(m);
615 return NULL;
616 }
617 Py_DECREF(m); /* Yes, it still exists, in modules! */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000618
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000619 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000620}
621
Victor Stinner27ee0892011-03-04 12:57:09 +0000622PyObject *
623PyImport_AddModule(const char *name)
624{
625 PyObject *nameobj, *module;
626 nameobj = PyUnicode_FromString(name);
627 if (nameobj == NULL)
628 return NULL;
629 module = PyImport_AddModuleObject(nameobj);
630 Py_DECREF(nameobj);
631 return module;
632}
633
634
Tim Peters1cd70172004-08-02 03:52:12 +0000635/* Remove name from sys.modules, if it's there. */
636static void
Victor Stinner27ee0892011-03-04 12:57:09 +0000637remove_module(PyObject *name)
Tim Peters1cd70172004-08-02 03:52:12 +0000638{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000639 PyObject *modules = PyImport_GetModuleDict();
Victor Stinner27ee0892011-03-04 12:57:09 +0000640 if (PyDict_GetItem(modules, name) == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000641 return;
Victor Stinner27ee0892011-03-04 12:57:09 +0000642 if (PyDict_DelItem(modules, name) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000643 Py_FatalError("import: deleting existing key in"
644 "sys.modules failed");
Tim Peters1cd70172004-08-02 03:52:12 +0000645}
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000646
Christian Heimes3b06e532008-01-07 20:12:44 +0000647
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000648/* Execute a code object in a module and return the module object
Tim Peters1cd70172004-08-02 03:52:12 +0000649 * WITH INCREMENTED REFERENCE COUNT. If an error occurs, name is
650 * removed from sys.modules, to avoid leaving damaged module objects
651 * in sys.modules. The caller may wish to restore the original
652 * module object (if any) in this case; PyImport_ReloadModule is an
653 * example.
Barry Warsaw28a691b2010-04-17 00:19:56 +0000654 *
655 * Note that PyImport_ExecCodeModuleWithPathnames() is the preferred, richer
656 * interface. The other two exist primarily for backward compatibility.
Tim Peters1cd70172004-08-02 03:52:12 +0000657 */
Guido van Rossum79f25d91997-04-29 20:08:16 +0000658PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000659PyImport_ExecCodeModule(char *name, PyObject *co)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000660{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000661 return PyImport_ExecCodeModuleWithPathnames(
662 name, co, (char *)NULL, (char *)NULL);
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000663}
664
665PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000666PyImport_ExecCodeModuleEx(char *name, PyObject *co, char *pathname)
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000667{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000668 return PyImport_ExecCodeModuleWithPathnames(
669 name, co, pathname, (char *)NULL);
Barry Warsaw28a691b2010-04-17 00:19:56 +0000670}
671
672PyObject *
673PyImport_ExecCodeModuleWithPathnames(char *name, PyObject *co, char *pathname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000674 char *cpathname)
Barry Warsaw28a691b2010-04-17 00:19:56 +0000675{
Victor Stinner27ee0892011-03-04 12:57:09 +0000676 PyObject *m = NULL;
677 PyObject *nameobj, *pathobj = NULL, *cpathobj = NULL;
678
679 nameobj = PyUnicode_FromString(name);
680 if (nameobj == NULL)
681 return NULL;
682
Victor Stinner27ee0892011-03-04 12:57:09 +0000683 if (cpathname != NULL) {
684 cpathobj = PyUnicode_DecodeFSDefault(cpathname);
685 if (cpathobj == NULL)
686 goto error;
Brett Cannona6473f92012-07-13 13:57:03 -0400687 }
688 else
Victor Stinner27ee0892011-03-04 12:57:09 +0000689 cpathobj = NULL;
Brett Cannona6473f92012-07-13 13:57:03 -0400690
691 if (pathname != NULL) {
692 pathobj = PyUnicode_DecodeFSDefault(pathname);
693 if (pathobj == NULL)
694 goto error;
695 }
696 else if (cpathobj != NULL) {
697 PyInterpreterState *interp = PyThreadState_GET()->interp;
698 _Py_IDENTIFIER(_get_sourcefile);
699
700 if (interp == NULL) {
701 Py_FatalError("PyImport_ExecCodeModuleWithPathnames: "
702 "no interpreter!");
703 }
704
705 pathobj = _PyObject_CallMethodObjIdArgs(interp->importlib,
706 &PyId__get_sourcefile, cpathobj,
707 NULL);
708 if (pathobj == NULL)
709 PyErr_Clear();
710 }
711 else
712 pathobj = NULL;
713
Victor Stinner27ee0892011-03-04 12:57:09 +0000714 m = PyImport_ExecCodeModuleObject(nameobj, co, pathobj, cpathobj);
715error:
716 Py_DECREF(nameobj);
717 Py_XDECREF(pathobj);
718 Py_XDECREF(cpathobj);
719 return m;
720}
721
722PyObject*
723PyImport_ExecCodeModuleObject(PyObject *name, PyObject *co, PyObject *pathname,
724 PyObject *cpathname)
725{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000726 PyObject *modules = PyImport_GetModuleDict();
727 PyObject *m, *d, *v;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000728
Victor Stinner27ee0892011-03-04 12:57:09 +0000729 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000730 if (m == NULL)
731 return NULL;
732 /* If the module is being reloaded, we get the old module back
733 and re-use its dict to exec the new code. */
734 d = PyModule_GetDict(m);
735 if (PyDict_GetItemString(d, "__builtins__") == NULL) {
736 if (PyDict_SetItemString(d, "__builtins__",
737 PyEval_GetBuiltins()) != 0)
738 goto error;
739 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000740 if (pathname != NULL) {
Brett Cannona6473f92012-07-13 13:57:03 -0400741 v = pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000742 }
Brett Cannona6473f92012-07-13 13:57:03 -0400743 else {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000744 v = ((PyCodeObject *)co)->co_filename;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000745 }
Brett Cannona6473f92012-07-13 13:57:03 -0400746 Py_INCREF(v);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000747 if (PyDict_SetItemString(d, "__file__", v) != 0)
748 PyErr_Clear(); /* Not important enough to report */
749 Py_DECREF(v);
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000750
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000751 /* Remember the pyc path name as the __cached__ attribute. */
Victor Stinner27ee0892011-03-04 12:57:09 +0000752 if (cpathname != NULL)
753 v = cpathname;
754 else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000755 v = Py_None;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000756 if (PyDict_SetItemString(d, "__cached__", v) != 0)
757 PyErr_Clear(); /* Not important enough to report */
Barry Warsaw28a691b2010-04-17 00:19:56 +0000758
Martin v. Löwis4d0d4712010-12-03 20:14:31 +0000759 v = PyEval_EvalCode(co, d, d);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000760 if (v == NULL)
761 goto error;
762 Py_DECREF(v);
Guido van Rossumb65e85c1997-07-10 18:00:45 +0000763
Victor Stinner27ee0892011-03-04 12:57:09 +0000764 if ((m = PyDict_GetItem(modules, name)) == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000765 PyErr_Format(PyExc_ImportError,
Victor Stinner27ee0892011-03-04 12:57:09 +0000766 "Loaded module %R not found in sys.modules",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000767 name);
768 return NULL;
769 }
Guido van Rossumb65e85c1997-07-10 18:00:45 +0000770
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000771 Py_INCREF(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000772
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000773 return m;
Tim Peters1cd70172004-08-02 03:52:12 +0000774
775 error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000776 remove_module(name);
777 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000778}
779
780
Antoine Pitroud35cbf62009-01-06 19:02:24 +0000781static void
782update_code_filenames(PyCodeObject *co, PyObject *oldname, PyObject *newname)
783{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000784 PyObject *constants, *tmp;
785 Py_ssize_t i, n;
Antoine Pitroud35cbf62009-01-06 19:02:24 +0000786
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000787 if (PyUnicode_Compare(co->co_filename, oldname))
788 return;
Antoine Pitroud35cbf62009-01-06 19:02:24 +0000789
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000790 tmp = co->co_filename;
791 co->co_filename = newname;
792 Py_INCREF(co->co_filename);
793 Py_DECREF(tmp);
Antoine Pitroud35cbf62009-01-06 19:02:24 +0000794
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000795 constants = co->co_consts;
796 n = PyTuple_GET_SIZE(constants);
797 for (i = 0; i < n; i++) {
798 tmp = PyTuple_GET_ITEM(constants, i);
799 if (PyCode_Check(tmp))
800 update_code_filenames((PyCodeObject *)tmp,
801 oldname, newname);
802 }
Antoine Pitroud35cbf62009-01-06 19:02:24 +0000803}
804
Victor Stinner2f42ae52011-03-20 00:41:24 +0100805static void
806update_compiled_module(PyCodeObject *co, PyObject *newname)
Antoine Pitroud35cbf62009-01-06 19:02:24 +0000807{
Victor Stinner2f42ae52011-03-20 00:41:24 +0100808 PyObject *oldname;
Antoine Pitroud35cbf62009-01-06 19:02:24 +0000809
Victor Stinner2f42ae52011-03-20 00:41:24 +0100810 if (PyUnicode_Compare(co->co_filename, newname) == 0)
811 return;
Hirokazu Yamamoto4f447fb2009-03-04 01:52:10 +0000812
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000813 oldname = co->co_filename;
814 Py_INCREF(oldname);
815 update_code_filenames(co, oldname, newname);
816 Py_DECREF(oldname);
Antoine Pitroud35cbf62009-01-06 19:02:24 +0000817}
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000818
Brett Cannon442c9b92011-03-23 16:14:42 -0700819static PyObject *
820imp_fix_co_filename(PyObject *self, PyObject *args)
821{
822 PyObject *co;
823 PyObject *file_path;
824
825 if (!PyArg_ParseTuple(args, "OO:_fix_co_filename", &co, &file_path))
826 return NULL;
827
828 if (!PyCode_Check(co)) {
829 PyErr_SetString(PyExc_TypeError,
830 "first argument must be a code object");
831 return NULL;
832 }
833
834 if (!PyUnicode_Check(file_path)) {
835 PyErr_SetString(PyExc_TypeError,
836 "second argument must be a string");
837 return NULL;
838 }
839
840 update_compiled_module((PyCodeObject*)co, file_path);
841
842 Py_RETURN_NONE;
843}
844
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000845
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000846/* Forward */
Victor Stinner53dc7352011-03-20 01:50:21 +0100847static struct _frozen * find_frozen(PyObject *);
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000848
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000849
850/* Helper to test for built-in module */
851
852static int
Victor Stinner95872862011-03-07 18:20:56 +0100853is_builtin(PyObject *name)
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000854{
Victor Stinner95872862011-03-07 18:20:56 +0100855 int i, cmp;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000856 for (i = 0; PyImport_Inittab[i].name != NULL; i++) {
Victor Stinner95872862011-03-07 18:20:56 +0100857 cmp = PyUnicode_CompareWithASCIIString(name, PyImport_Inittab[i].name);
858 if (cmp == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000859 if (PyImport_Inittab[i].initfunc == NULL)
860 return -1;
861 else
862 return 1;
863 }
864 }
865 return 0;
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000866}
867
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000868
Just van Rossum52e14d62002-12-30 22:08:05 +0000869/* Return an importer object for a sys.path/pkg.__path__ item 'p',
870 possibly by fetching it from the path_importer_cache dict. If it
Thomas Wouters89f507f2006-12-13 04:49:30 +0000871 wasn't yet cached, traverse path_hooks until a hook is found
Just van Rossum52e14d62002-12-30 22:08:05 +0000872 that can handle the path item. Return None if no hook could;
873 this tells our caller it should fall back to the builtin
874 import mechanism. Cache the result in path_importer_cache.
875 Returns a borrowed reference. */
876
877static PyObject *
878get_path_importer(PyObject *path_importer_cache, PyObject *path_hooks,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000879 PyObject *p)
Just van Rossum52e14d62002-12-30 22:08:05 +0000880{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000881 PyObject *importer;
882 Py_ssize_t j, nhooks;
Just van Rossum52e14d62002-12-30 22:08:05 +0000883
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000884 /* These conditions are the caller's responsibility: */
885 assert(PyList_Check(path_hooks));
886 assert(PyDict_Check(path_importer_cache));
Just van Rossum52e14d62002-12-30 22:08:05 +0000887
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000888 nhooks = PyList_Size(path_hooks);
889 if (nhooks < 0)
890 return NULL; /* Shouldn't happen */
Just van Rossum52e14d62002-12-30 22:08:05 +0000891
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000892 importer = PyDict_GetItem(path_importer_cache, p);
893 if (importer != NULL)
894 return importer;
Just van Rossum52e14d62002-12-30 22:08:05 +0000895
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000896 /* set path_importer_cache[p] to None to avoid recursion */
897 if (PyDict_SetItem(path_importer_cache, p, Py_None) != 0)
898 return NULL;
Just van Rossum52e14d62002-12-30 22:08:05 +0000899
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000900 for (j = 0; j < nhooks; j++) {
901 PyObject *hook = PyList_GetItem(path_hooks, j);
902 if (hook == NULL)
903 return NULL;
904 importer = PyObject_CallFunctionObjArgs(hook, p, NULL);
905 if (importer != NULL)
906 break;
Just van Rossum52e14d62002-12-30 22:08:05 +0000907
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000908 if (!PyErr_ExceptionMatches(PyExc_ImportError)) {
909 return NULL;
910 }
911 PyErr_Clear();
912 }
913 if (importer == NULL) {
Brett Cannonaa936422012-04-27 15:30:58 -0400914 return Py_None;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000915 }
916 if (importer != NULL) {
917 int err = PyDict_SetItem(path_importer_cache, p, importer);
918 Py_DECREF(importer);
919 if (err != 0)
920 return NULL;
921 }
922 return importer;
Just van Rossum52e14d62002-12-30 22:08:05 +0000923}
924
Christian Heimes9cd17752007-11-18 19:35:23 +0000925PyAPI_FUNC(PyObject *)
926PyImport_GetImporter(PyObject *path) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000927 PyObject *importer=NULL, *path_importer_cache=NULL, *path_hooks=NULL;
Christian Heimes9cd17752007-11-18 19:35:23 +0000928
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000929 if ((path_importer_cache = PySys_GetObject("path_importer_cache"))) {
930 if ((path_hooks = PySys_GetObject("path_hooks"))) {
931 importer = get_path_importer(path_importer_cache,
932 path_hooks, path);
933 }
934 }
935 Py_XINCREF(importer); /* get_path_importer returns a borrowed reference */
936 return importer;
Christian Heimes9cd17752007-11-18 19:35:23 +0000937}
938
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000939
Victor Stinner95872862011-03-07 18:20:56 +0100940static int init_builtin(PyObject *); /* Forward */
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000941
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000942/* Initialize a built-in module.
Thomas Wouters89f507f2006-12-13 04:49:30 +0000943 Return 1 for success, 0 if the module is not found, and -1 with
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000944 an exception set if the initialization failed. */
Guido van Rossum7f133ed1991-02-19 12:23:57 +0000945
Guido van Rossum7f133ed1991-02-19 12:23:57 +0000946static int
Victor Stinner95872862011-03-07 18:20:56 +0100947init_builtin(PyObject *name)
Guido van Rossum7f133ed1991-02-19 12:23:57 +0000948{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000949 struct _inittab *p;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000950
Victor Stinner95872862011-03-07 18:20:56 +0100951 if (_PyImport_FindExtensionObject(name, name) != NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000952 return 1;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000953
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000954 for (p = PyImport_Inittab; p->name != NULL; p++) {
955 PyObject *mod;
Antoine Pitrou6c40eb72012-01-18 20:16:09 +0100956 PyModuleDef *def;
Victor Stinner95872862011-03-07 18:20:56 +0100957 if (PyUnicode_CompareWithASCIIString(name, p->name) == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000958 if (p->initfunc == NULL) {
959 PyErr_Format(PyExc_ImportError,
Victor Stinner95872862011-03-07 18:20:56 +0100960 "Cannot re-init internal module %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000961 name);
962 return -1;
963 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000964 mod = (*p->initfunc)();
965 if (mod == 0)
966 return -1;
Antoine Pitrou6c40eb72012-01-18 20:16:09 +0100967 /* Remember pointer to module init function. */
968 def = PyModule_GetDef(mod);
969 def->m_base.m_init = p->initfunc;
Victor Stinner95872862011-03-07 18:20:56 +0100970 if (_PyImport_FixupExtensionObject(mod, name, name) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000971 return -1;
972 /* FixupExtension has put the module into sys.modules,
973 so we can release our own reference. */
974 Py_DECREF(mod);
975 return 1;
976 }
977 }
978 return 0;
Guido van Rossum7f133ed1991-02-19 12:23:57 +0000979}
Guido van Rossumf56e3db1993-04-01 20:59:32 +0000980
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000981
Guido van Rossum6ec1efb1995-08-04 04:08:57 +0000982/* Frozen modules */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000983
Guido van Rossumcfd0a221996-06-17 17:06:34 +0000984static struct _frozen *
Victor Stinner53dc7352011-03-20 01:50:21 +0100985find_frozen(PyObject *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +0000986{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000987 struct _frozen *p;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +0000988
Victor Stinner53dc7352011-03-20 01:50:21 +0100989 if (name == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000990 return NULL;
Benjamin Petersond968e272008-11-05 22:48:33 +0000991
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000992 for (p = PyImport_FrozenModules; ; p++) {
993 if (p->name == NULL)
994 return NULL;
Victor Stinner53dc7352011-03-20 01:50:21 +0100995 if (PyUnicode_CompareWithASCIIString(name, p->name) == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000996 break;
997 }
998 return p;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +0000999}
1000
Guido van Rossum79f25d91997-04-29 20:08:16 +00001001static PyObject *
Victor Stinner53dc7352011-03-20 01:50:21 +01001002get_frozen_object(PyObject *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001003{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001004 struct _frozen *p = find_frozen(name);
1005 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001006
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001007 if (p == NULL) {
1008 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01001009 "No such frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001010 name);
1011 return NULL;
1012 }
1013 if (p->code == NULL) {
1014 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01001015 "Excluded frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001016 name);
1017 return NULL;
1018 }
1019 size = p->size;
1020 if (size < 0)
1021 size = -size;
1022 return PyMarshal_ReadObjectFromString((char *)p->code, size);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001023}
1024
Brett Cannon8d110132009-03-15 02:20:16 +00001025static PyObject *
Victor Stinner53dc7352011-03-20 01:50:21 +01001026is_frozen_package(PyObject *name)
Brett Cannon8d110132009-03-15 02:20:16 +00001027{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001028 struct _frozen *p = find_frozen(name);
1029 int size;
Brett Cannon8d110132009-03-15 02:20:16 +00001030
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001031 if (p == NULL) {
1032 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01001033 "No such frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001034 name);
1035 return NULL;
1036 }
Brett Cannon8d110132009-03-15 02:20:16 +00001037
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001038 size = p->size;
Brett Cannon8d110132009-03-15 02:20:16 +00001039
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001040 if (size < 0)
1041 Py_RETURN_TRUE;
1042 else
1043 Py_RETURN_FALSE;
Brett Cannon8d110132009-03-15 02:20:16 +00001044}
1045
1046
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001047/* Initialize a frozen module.
Brett Cannon3c2ac442009-03-08 20:49:47 +00001048 Return 1 for success, 0 if the module is not found, and -1 with
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001049 an exception set if the initialization failed.
1050 This function is also used from frozenmain.c */
Guido van Rossum0b344901995-02-07 15:35:27 +00001051
1052int
Victor Stinner53dc7352011-03-20 01:50:21 +01001053PyImport_ImportFrozenModuleObject(PyObject *name)
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001054{
Victor Stinner53dc7352011-03-20 01:50:21 +01001055 struct _frozen *p;
1056 PyObject *co, *m, *path;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001057 int ispackage;
1058 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001059
Victor Stinner53dc7352011-03-20 01:50:21 +01001060 p = find_frozen(name);
1061
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001062 if (p == NULL)
1063 return 0;
1064 if (p->code == NULL) {
1065 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01001066 "Excluded frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001067 name);
1068 return -1;
1069 }
1070 size = p->size;
1071 ispackage = (size < 0);
1072 if (ispackage)
1073 size = -size;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001074 co = PyMarshal_ReadObjectFromString((char *)p->code, size);
1075 if (co == NULL)
1076 return -1;
1077 if (!PyCode_Check(co)) {
1078 PyErr_Format(PyExc_TypeError,
Victor Stinner53dc7352011-03-20 01:50:21 +01001079 "frozen object %R is not a code object",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001080 name);
1081 goto err_return;
1082 }
1083 if (ispackage) {
1084 /* Set __path__ to the package name */
Victor Stinner53dc7352011-03-20 01:50:21 +01001085 PyObject *d, *l;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001086 int err;
Victor Stinner53dc7352011-03-20 01:50:21 +01001087 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001088 if (m == NULL)
1089 goto err_return;
1090 d = PyModule_GetDict(m);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001091 l = PyList_New(1);
1092 if (l == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001093 goto err_return;
1094 }
Victor Stinner53dc7352011-03-20 01:50:21 +01001095 Py_INCREF(name);
1096 PyList_SET_ITEM(l, 0, name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001097 err = PyDict_SetItemString(d, "__path__", l);
1098 Py_DECREF(l);
1099 if (err != 0)
1100 goto err_return;
1101 }
Victor Stinner53dc7352011-03-20 01:50:21 +01001102 path = PyUnicode_FromString("<frozen>");
1103 if (path == NULL)
1104 goto err_return;
1105 m = PyImport_ExecCodeModuleObject(name, co, path, NULL);
1106 Py_DECREF(path);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001107 if (m == NULL)
1108 goto err_return;
1109 Py_DECREF(co);
1110 Py_DECREF(m);
1111 return 1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001112err_return:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001113 Py_DECREF(co);
1114 return -1;
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001115}
Guido van Rossum74e6a111994-08-29 12:54:38 +00001116
Victor Stinner53dc7352011-03-20 01:50:21 +01001117int
1118PyImport_ImportFrozenModule(char *name)
1119{
1120 PyObject *nameobj;
1121 int ret;
1122 nameobj = PyUnicode_InternFromString(name);
1123 if (nameobj == NULL)
1124 return -1;
1125 ret = PyImport_ImportFrozenModuleObject(nameobj);
1126 Py_DECREF(nameobj);
1127 return ret;
1128}
1129
Guido van Rossum74e6a111994-08-29 12:54:38 +00001130
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001131/* Import a module, either built-in, frozen, or external, and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001132 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum74e6a111994-08-29 12:54:38 +00001133
Guido van Rossum79f25d91997-04-29 20:08:16 +00001134PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001135PyImport_ImportModule(const char *name)
Guido van Rossum74e6a111994-08-29 12:54:38 +00001136{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001137 PyObject *pname;
1138 PyObject *result;
Marc-André Lemburg3c61c352001-02-09 19:40:15 +00001139
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001140 pname = PyUnicode_FromString(name);
1141 if (pname == NULL)
1142 return NULL;
1143 result = PyImport_Import(pname);
1144 Py_DECREF(pname);
1145 return result;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001146}
1147
Christian Heimes072c0f12008-01-03 23:01:04 +00001148/* Import a module without blocking
1149 *
1150 * At first it tries to fetch the module from sys.modules. If the module was
1151 * never loaded before it loads it with PyImport_ImportModule() unless another
1152 * thread holds the import lock. In the latter case the function raises an
1153 * ImportError instead of blocking.
1154 *
1155 * Returns the module object with incremented ref count.
1156 */
1157PyObject *
1158PyImport_ImportModuleNoBlock(const char *name)
1159{
Antoine Pitrouea3eb882012-05-17 18:55:59 +02001160 return PyImport_ImportModule(name);
Christian Heimes072c0f12008-01-03 23:01:04 +00001161}
1162
Guido van Rossum17fc85f1997-09-06 18:52:03 +00001163
Antoine Pitroubc07a5c2012-07-08 12:01:27 +02001164/* Remove importlib frames from the traceback,
1165 * except in Verbose mode. */
1166static void
1167remove_importlib_frames(void)
1168{
1169 const char *importlib_filename = "<frozen importlib._bootstrap>";
Nick Coghlan42c07662012-07-31 21:14:18 +10001170 const char *remove_frames = "_call_with_frames_removed";
Antoine Pitroubc07a5c2012-07-08 12:01:27 +02001171 int always_trim = 0;
Benjamin Petersonfa873702012-07-09 13:43:53 -07001172 int in_importlib = 0;
Antoine Pitroubc07a5c2012-07-08 12:01:27 +02001173 PyObject *exception, *value, *base_tb, *tb;
Benjamin Petersonfa873702012-07-09 13:43:53 -07001174 PyObject **prev_link, **outer_link = NULL;
Antoine Pitroubc07a5c2012-07-08 12:01:27 +02001175
1176 /* Synopsis: if it's an ImportError, we trim all importlib chunks
Nick Coghlan42c07662012-07-31 21:14:18 +10001177 from the traceback. We always trim chunks
1178 which end with a call to "_call_with_frames_removed". */
Antoine Pitroubc07a5c2012-07-08 12:01:27 +02001179
1180 PyErr_Fetch(&exception, &value, &base_tb);
1181 if (!exception || Py_VerboseFlag)
1182 goto done;
1183 if (PyType_IsSubtype((PyTypeObject *) exception,
1184 (PyTypeObject *) PyExc_ImportError))
1185 always_trim = 1;
1186
1187 prev_link = &base_tb;
1188 tb = base_tb;
Antoine Pitroubc07a5c2012-07-08 12:01:27 +02001189 while (tb != NULL) {
1190 PyTracebackObject *traceback = (PyTracebackObject *)tb;
1191 PyObject *next = (PyObject *) traceback->tb_next;
1192 PyFrameObject *frame = traceback->tb_frame;
1193 PyCodeObject *code = frame->f_code;
1194 int now_in_importlib;
1195
1196 assert(PyTraceBack_Check(tb));
1197 now_in_importlib = (PyUnicode_CompareWithASCIIString(
1198 code->co_filename,
1199 importlib_filename) == 0);
1200 if (now_in_importlib && !in_importlib) {
1201 /* This is the link to this chunk of importlib tracebacks */
1202 outer_link = prev_link;
1203 }
1204 in_importlib = now_in_importlib;
1205
1206 if (in_importlib &&
1207 (always_trim ||
Nick Coghlan42c07662012-07-31 21:14:18 +10001208 PyUnicode_CompareWithASCIIString(code->co_name,
1209 remove_frames) == 0)) {
Antoine Pitroubc07a5c2012-07-08 12:01:27 +02001210 PyObject *tmp = *outer_link;
1211 *outer_link = next;
1212 Py_XINCREF(next);
1213 Py_DECREF(tmp);
1214 prev_link = outer_link;
1215 }
1216 else {
1217 prev_link = (PyObject **) &traceback->tb_next;
1218 }
1219 tb = next;
1220 }
1221done:
1222 PyErr_Restore(exception, value, base_tb);
1223}
1224
1225
Thomas Woutersf7f438b2006-02-28 16:09:29 +00001226PyObject *
Brett Cannonfd074152012-04-14 14:10:13 -04001227PyImport_ImportModuleLevelObject(PyObject *name, PyObject *given_globals,
1228 PyObject *locals, PyObject *given_fromlist,
Victor Stinnerfe93faf2011-03-14 15:54:52 -04001229 int level)
Thomas Woutersf7f438b2006-02-28 16:09:29 +00001230{
Brett Cannonfd074152012-04-14 14:10:13 -04001231 _Py_IDENTIFIER(__import__);
Antoine Pitrouea3eb882012-05-17 18:55:59 +02001232 _Py_IDENTIFIER(__initializing__);
Brett Cannonfd074152012-04-14 14:10:13 -04001233 _Py_IDENTIFIER(__package__);
1234 _Py_IDENTIFIER(__path__);
1235 _Py_IDENTIFIER(__name__);
1236 _Py_IDENTIFIER(_find_and_load);
1237 _Py_IDENTIFIER(_handle_fromlist);
Antoine Pitrouea3eb882012-05-17 18:55:59 +02001238 _Py_IDENTIFIER(_lock_unlock_module);
Brett Cannonfd074152012-04-14 14:10:13 -04001239 _Py_static_string(single_dot, ".");
1240 PyObject *abs_name = NULL;
1241 PyObject *builtins_import = NULL;
1242 PyObject *final_mod = NULL;
1243 PyObject *mod = NULL;
1244 PyObject *package = NULL;
1245 PyObject *globals = NULL;
1246 PyObject *fromlist = NULL;
1247 PyInterpreterState *interp = PyThreadState_GET()->interp;
1248
1249 /* Make sure to use default values so as to not have
1250 PyObject_CallMethodObjArgs() truncate the parameter list because of a
1251 NULL argument. */
1252 if (given_globals == NULL) {
1253 globals = PyDict_New();
1254 if (globals == NULL) {
1255 goto error;
1256 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001257 }
Brett Cannonfd074152012-04-14 14:10:13 -04001258 else {
1259 /* Only have to care what given_globals is if it will be used
Brett Cannonecfefb72012-08-05 19:24:57 -04001260 for something. */
Brett Cannonfd074152012-04-14 14:10:13 -04001261 if (level > 0 && !PyDict_Check(given_globals)) {
1262 PyErr_SetString(PyExc_TypeError, "globals must be a dict");
1263 goto error;
1264 }
1265 globals = given_globals;
1266 Py_INCREF(globals);
1267 }
1268
1269 if (given_fromlist == NULL) {
1270 fromlist = PyList_New(0);
1271 if (fromlist == NULL) {
1272 goto error;
1273 }
1274 }
1275 else {
1276 fromlist = given_fromlist;
1277 Py_INCREF(fromlist);
1278 }
1279 if (name == NULL) {
1280 PyErr_SetString(PyExc_ValueError, "Empty module name");
1281 goto error;
1282 }
1283
1284 /* The below code is importlib.__import__() & _gcd_import(), ported to C
1285 for added performance. */
1286
1287 if (!PyUnicode_Check(name)) {
1288 PyErr_SetString(PyExc_TypeError, "module name must be a string");
1289 goto error;
1290 }
1291 else if (PyUnicode_READY(name) < 0) {
1292 goto error;
1293 }
1294 if (level < 0) {
1295 PyErr_SetString(PyExc_ValueError, "level must be >= 0");
1296 goto error;
1297 }
1298 else if (level > 0) {
1299 package = _PyDict_GetItemId(globals, &PyId___package__);
1300 if (package != NULL && package != Py_None) {
1301 Py_INCREF(package);
1302 if (!PyUnicode_Check(package)) {
1303 PyErr_SetString(PyExc_TypeError, "package must be a string");
1304 goto error;
1305 }
1306 }
1307 else {
Brett Cannon273323c2012-04-17 19:05:11 -04001308 package = _PyDict_GetItemId(globals, &PyId___name__);
Brett Cannonfd074152012-04-14 14:10:13 -04001309 if (package == NULL) {
Brett Cannon273323c2012-04-17 19:05:11 -04001310 PyErr_SetString(PyExc_KeyError, "'__name__' not in globals");
Brett Cannonfd074152012-04-14 14:10:13 -04001311 goto error;
1312 }
1313 else if (!PyUnicode_Check(package)) {
1314 PyErr_SetString(PyExc_TypeError, "__name__ must be a string");
1315 }
1316 Py_INCREF(package);
1317
1318 if (_PyDict_GetItemId(globals, &PyId___path__) == NULL) {
Brett Cannon740fce02012-04-14 14:23:49 -04001319 PyObject *partition = NULL;
Brett Cannonfd074152012-04-14 14:10:13 -04001320 PyObject *borrowed_dot = _PyUnicode_FromId(&single_dot);
1321 if (borrowed_dot == NULL) {
1322 goto error;
1323 }
Brett Cannon740fce02012-04-14 14:23:49 -04001324 partition = PyUnicode_RPartition(package, borrowed_dot);
Brett Cannonfd074152012-04-14 14:10:13 -04001325 Py_DECREF(package);
1326 if (partition == NULL) {
1327 goto error;
1328 }
1329 package = PyTuple_GET_ITEM(partition, 0);
1330 Py_INCREF(package);
1331 Py_DECREF(partition);
1332 }
1333 }
1334
1335 if (PyDict_GetItem(interp->modules, package) == NULL) {
1336 PyErr_Format(PyExc_SystemError,
1337 "Parent module %R not loaded, cannot perform relative "
1338 "import", package);
1339 goto error;
1340 }
1341 }
1342 else { /* level == 0 */
1343 if (PyUnicode_GET_LENGTH(name) == 0) {
1344 PyErr_SetString(PyExc_ValueError, "Empty module name");
1345 goto error;
1346 }
1347 package = Py_None;
1348 Py_INCREF(package);
1349 }
1350
1351 if (level > 0) {
1352 Py_ssize_t last_dot = PyUnicode_GET_LENGTH(package);
1353 PyObject *base = NULL;
1354 int level_up = 1;
1355
1356 for (level_up = 1; level_up < level; level_up += 1) {
1357 last_dot = PyUnicode_FindChar(package, '.', 0, last_dot, -1);
1358 if (last_dot == -2) {
1359 goto error;
1360 }
1361 else if (last_dot == -1) {
1362 PyErr_SetString(PyExc_ValueError,
1363 "attempted relative import beyond top-level "
1364 "package");
1365 goto error;
1366 }
1367 }
1368 base = PyUnicode_Substring(package, 0, last_dot);
1369 if (PyUnicode_GET_LENGTH(name) > 0) {
Antoine Pitrou538ba2a2012-04-16 21:52:45 +02001370 PyObject *borrowed_dot, *seq = NULL;
Brett Cannonfd074152012-04-14 14:10:13 -04001371
1372 borrowed_dot = _PyUnicode_FromId(&single_dot);
Antoine Pitrou538ba2a2012-04-16 21:52:45 +02001373 seq = PyTuple_Pack(2, base, name);
1374 Py_DECREF(base);
Brett Cannonfd074152012-04-14 14:10:13 -04001375 if (borrowed_dot == NULL || seq == NULL) {
1376 goto error;
1377 }
1378
1379 abs_name = PyUnicode_Join(borrowed_dot, seq);
1380 Py_DECREF(seq);
1381 if (abs_name == NULL) {
1382 goto error;
1383 }
1384 }
1385 else {
1386 abs_name = base;
1387 }
1388 }
1389 else {
1390 abs_name = name;
1391 Py_INCREF(abs_name);
1392 }
1393
Brian Curtine6b299f2012-04-14 14:19:33 -05001394#ifdef WITH_THREAD
Brett Cannonfd074152012-04-14 14:10:13 -04001395 _PyImport_AcquireLock();
1396#endif
1397 /* From this point forward, goto error_with_unlock! */
1398 if (PyDict_Check(globals)) {
1399 builtins_import = _PyDict_GetItemId(globals, &PyId___import__);
1400 }
1401 if (builtins_import == NULL) {
1402 builtins_import = _PyDict_GetItemId(interp->builtins, &PyId___import__);
1403 if (builtins_import == NULL) {
1404 Py_FatalError("__import__ missing");
1405 }
1406 }
1407 Py_INCREF(builtins_import);
1408
1409 mod = PyDict_GetItem(interp->modules, abs_name);
1410 if (mod == Py_None) {
Brett Cannon27fc5282012-04-15 14:15:31 -04001411 PyObject *msg = PyUnicode_FromFormat("import of %R halted; "
1412 "None in sys.modules", abs_name);
1413 if (msg != NULL) {
Brian Curtin09b86d12012-04-17 16:57:09 -05001414 PyErr_SetImportError(msg, abs_name, NULL);
1415 Py_DECREF(msg);
Brett Cannon27fc5282012-04-15 14:15:31 -04001416 }
Antoine Pitrou71382cb2012-04-16 18:48:49 +02001417 mod = NULL;
Brett Cannonfd074152012-04-14 14:10:13 -04001418 goto error_with_unlock;
1419 }
1420 else if (mod != NULL) {
Antoine Pitrouea3eb882012-05-17 18:55:59 +02001421 PyObject *value;
1422 int initializing = 0;
1423
Brett Cannonfd074152012-04-14 14:10:13 -04001424 Py_INCREF(mod);
Antoine Pitrou03989852012-08-28 00:24:52 +02001425 /* Optimization: only call _bootstrap._lock_unlock_module() if
1426 __initializing__ is true.
1427 NOTE: because of this, __initializing__ must be set *before*
1428 stuffing the new module in sys.modules.
1429 */
Antoine Pitrouea3eb882012-05-17 18:55:59 +02001430 value = _PyObject_GetAttrId(mod, &PyId___initializing__);
1431 if (value == NULL)
1432 PyErr_Clear();
1433 else {
1434 initializing = PyObject_IsTrue(value);
1435 Py_DECREF(value);
1436 if (initializing == -1)
1437 PyErr_Clear();
1438 }
1439 if (initializing > 0) {
1440 /* _bootstrap._lock_unlock_module() releases the import lock */
1441 value = _PyObject_CallMethodObjIdArgs(interp->importlib,
1442 &PyId__lock_unlock_module, abs_name,
1443 NULL);
1444 if (value == NULL)
1445 goto error;
1446 Py_DECREF(value);
1447 }
1448 else {
1449#ifdef WITH_THREAD
1450 if (_PyImport_ReleaseLock() < 0) {
1451 PyErr_SetString(PyExc_RuntimeError, "not holding the import lock");
1452 goto error;
1453 }
1454#endif
1455 }
Brett Cannonfd074152012-04-14 14:10:13 -04001456 }
1457 else {
Antoine Pitrouea3eb882012-05-17 18:55:59 +02001458 /* _bootstrap._find_and_load() releases the import lock */
Brett Cannonfd074152012-04-14 14:10:13 -04001459 mod = _PyObject_CallMethodObjIdArgs(interp->importlib,
1460 &PyId__find_and_load, abs_name,
1461 builtins_import, NULL);
1462 if (mod == NULL) {
Antoine Pitrouea3eb882012-05-17 18:55:59 +02001463 goto error;
Brett Cannonfd074152012-04-14 14:10:13 -04001464 }
1465 }
Antoine Pitrouea3eb882012-05-17 18:55:59 +02001466 /* From now on we don't hold the import lock anymore. */
Brett Cannonfd074152012-04-14 14:10:13 -04001467
1468 if (PyObject_Not(fromlist)) {
1469 if (level == 0 || PyUnicode_GET_LENGTH(name) > 0) {
1470 PyObject *front = NULL;
Brian Curtine6b299f2012-04-14 14:19:33 -05001471 PyObject *partition = NULL;
Brett Cannonfd074152012-04-14 14:10:13 -04001472 PyObject *borrowed_dot = _PyUnicode_FromId(&single_dot);
1473
1474 if (borrowed_dot == NULL) {
Antoine Pitrouea3eb882012-05-17 18:55:59 +02001475 goto error;
Brett Cannonfd074152012-04-14 14:10:13 -04001476 }
1477
Brian Curtine6b299f2012-04-14 14:19:33 -05001478 partition = PyUnicode_Partition(name, borrowed_dot);
Brett Cannonfd074152012-04-14 14:10:13 -04001479 if (partition == NULL) {
Antoine Pitrouea3eb882012-05-17 18:55:59 +02001480 goto error;
Brett Cannonfd074152012-04-14 14:10:13 -04001481 }
1482
Antoine Pitrou6efa50a2012-05-07 21:41:59 +02001483 if (PyUnicode_GET_LENGTH(PyTuple_GET_ITEM(partition, 1)) == 0) {
1484 /* No dot in module name, simple exit */
1485 Py_DECREF(partition);
1486 final_mod = mod;
1487 Py_INCREF(mod);
Antoine Pitrouea3eb882012-05-17 18:55:59 +02001488 goto error;
Antoine Pitrou6efa50a2012-05-07 21:41:59 +02001489 }
1490
Brett Cannonfd074152012-04-14 14:10:13 -04001491 front = PyTuple_GET_ITEM(partition, 0);
1492 Py_INCREF(front);
1493 Py_DECREF(partition);
1494
1495 if (level == 0) {
Antoine Pitrou6efa50a2012-05-07 21:41:59 +02001496 final_mod = PyObject_CallFunctionObjArgs(builtins_import, front, NULL);
Antoine Pitroub78174c2012-05-06 17:15:23 +02001497 Py_DECREF(front);
Brett Cannonfd074152012-04-14 14:10:13 -04001498 }
1499 else {
Antoine Pitrou22a1d172012-04-16 22:06:21 +02001500 Py_ssize_t cut_off = PyUnicode_GET_LENGTH(name) -
1501 PyUnicode_GET_LENGTH(front);
1502 Py_ssize_t abs_name_len = PyUnicode_GET_LENGTH(abs_name);
Brett Cannon49f8d8b2012-04-14 21:50:00 -04001503 PyObject *to_return = PyUnicode_Substring(abs_name, 0,
Brett Cannonfd074152012-04-14 14:10:13 -04001504 abs_name_len - cut_off);
Antoine Pitrou22a1d172012-04-16 22:06:21 +02001505 Py_DECREF(front);
1506 if (to_return == NULL) {
Antoine Pitrouea3eb882012-05-17 18:55:59 +02001507 goto error;
Antoine Pitrou22a1d172012-04-16 22:06:21 +02001508 }
Brett Cannonfd074152012-04-14 14:10:13 -04001509
1510 final_mod = PyDict_GetItem(interp->modules, to_return);
Brett Cannon49f8d8b2012-04-14 21:50:00 -04001511 if (final_mod == NULL) {
1512 PyErr_Format(PyExc_KeyError,
1513 "%R not in sys.modules as expected",
1514 to_return);
1515 }
1516 else {
1517 Py_INCREF(final_mod);
1518 }
Antoine Pitroub78174c2012-05-06 17:15:23 +02001519 Py_DECREF(to_return);
Brett Cannonfd074152012-04-14 14:10:13 -04001520 }
1521 }
1522 else {
1523 final_mod = mod;
1524 Py_INCREF(mod);
1525 }
1526 }
1527 else {
1528 final_mod = _PyObject_CallMethodObjIdArgs(interp->importlib,
1529 &PyId__handle_fromlist, mod,
1530 fromlist, builtins_import,
1531 NULL);
1532 }
Antoine Pitrouea3eb882012-05-17 18:55:59 +02001533 goto error;
Antoine Pitrou6efa50a2012-05-07 21:41:59 +02001534
Brett Cannonfd074152012-04-14 14:10:13 -04001535 error_with_unlock:
Brian Curtine6b299f2012-04-14 14:19:33 -05001536#ifdef WITH_THREAD
Brett Cannonfd074152012-04-14 14:10:13 -04001537 if (_PyImport_ReleaseLock() < 0) {
1538 PyErr_SetString(PyExc_RuntimeError, "not holding the import lock");
1539 }
1540#endif
1541 error:
1542 Py_XDECREF(abs_name);
1543 Py_XDECREF(builtins_import);
1544 Py_XDECREF(mod);
1545 Py_XDECREF(package);
1546 Py_XDECREF(globals);
1547 Py_XDECREF(fromlist);
Antoine Pitroubc07a5c2012-07-08 12:01:27 +02001548 if (final_mod == NULL)
1549 remove_importlib_frames();
Brett Cannonfd074152012-04-14 14:10:13 -04001550 return final_mod;
Guido van Rossum75acc9c1998-03-03 22:26:50 +00001551}
1552
Victor Stinnerfe93faf2011-03-14 15:54:52 -04001553PyObject *
Benjamin Peterson04778a82011-05-25 09:29:00 -05001554PyImport_ImportModuleLevel(const char *name, PyObject *globals, PyObject *locals,
Victor Stinnerfe93faf2011-03-14 15:54:52 -04001555 PyObject *fromlist, int level)
1556{
1557 PyObject *nameobj, *mod;
1558 nameobj = PyUnicode_FromString(name);
1559 if (nameobj == NULL)
1560 return NULL;
1561 mod = PyImport_ImportModuleLevelObject(nameobj, globals, locals,
1562 fromlist, level);
1563 Py_DECREF(nameobj);
1564 return mod;
1565}
1566
1567
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001568/* Re-import a module of any kind and return its module object, WITH
1569 INCREMENTED REFERENCE COUNT */
1570
Guido van Rossum79f25d91997-04-29 20:08:16 +00001571PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001572PyImport_ReloadModule(PyObject *m)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001573{
Brett Cannon62228db2012-04-29 14:38:11 -04001574 _Py_IDENTIFIER(reload);
1575 PyObject *reloaded_module = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001576 PyObject *modules = PyImport_GetModuleDict();
Brett Cannon62228db2012-04-29 14:38:11 -04001577 PyObject *imp = PyDict_GetItemString(modules, "imp");
1578 if (imp == NULL) {
1579 imp = PyImport_ImportModule("imp");
1580 if (imp == NULL) {
1581 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001582 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001583 }
Brett Cannon62228db2012-04-29 14:38:11 -04001584 else {
1585 Py_INCREF(imp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001586 }
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001587
Brett Cannon62228db2012-04-29 14:38:11 -04001588 reloaded_module = _PyObject_CallMethodId(imp, &PyId_reload, "O", m);
1589 Py_DECREF(imp);
1590 return reloaded_module;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001591}
1592
1593
Guido van Rossumd47a0a81997-08-14 20:11:26 +00001594/* Higher-level import emulator which emulates the "import" statement
1595 more accurately -- it invokes the __import__() function from the
1596 builtins of the current globals. This means that the import is
1597 done using whatever import hooks are installed in the current
Brett Cannonbc2eff32010-09-19 21:39:02 +00001598 environment.
Guido van Rossum6058eb41998-12-21 19:51:00 +00001599 A dummy list ["__doc__"] is passed as the 4th argument so that
Neal Norwitz80e7f272007-08-26 06:45:23 +00001600 e.g. PyImport_Import(PyUnicode_FromString("win32com.client.gencache"))
Guido van Rossum6058eb41998-12-21 19:51:00 +00001601 will return <module "gencache"> instead of <module "win32com">. */
Guido van Rossumd47a0a81997-08-14 20:11:26 +00001602
1603PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001604PyImport_Import(PyObject *module_name)
Guido van Rossumd47a0a81997-08-14 20:11:26 +00001605{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001606 static PyObject *silly_list = NULL;
1607 static PyObject *builtins_str = NULL;
1608 static PyObject *import_str = NULL;
1609 PyObject *globals = NULL;
1610 PyObject *import = NULL;
1611 PyObject *builtins = NULL;
Brett Cannonbc2eff32010-09-19 21:39:02 +00001612 PyObject *modules = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001613 PyObject *r = NULL;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00001614
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001615 /* Initialize constant string objects */
1616 if (silly_list == NULL) {
1617 import_str = PyUnicode_InternFromString("__import__");
1618 if (import_str == NULL)
1619 return NULL;
1620 builtins_str = PyUnicode_InternFromString("__builtins__");
1621 if (builtins_str == NULL)
1622 return NULL;
Brett Cannonbc2eff32010-09-19 21:39:02 +00001623 silly_list = PyList_New(0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001624 if (silly_list == NULL)
1625 return NULL;
1626 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00001627
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001628 /* Get the builtins from current globals */
1629 globals = PyEval_GetGlobals();
1630 if (globals != NULL) {
1631 Py_INCREF(globals);
1632 builtins = PyObject_GetItem(globals, builtins_str);
1633 if (builtins == NULL)
1634 goto err;
1635 }
1636 else {
1637 /* No globals -- use standard builtins, and fake globals */
1638 builtins = PyImport_ImportModuleLevel("builtins",
1639 NULL, NULL, NULL, 0);
1640 if (builtins == NULL)
1641 return NULL;
1642 globals = Py_BuildValue("{OO}", builtins_str, builtins);
1643 if (globals == NULL)
1644 goto err;
1645 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00001646
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001647 /* Get the __import__ function from the builtins */
1648 if (PyDict_Check(builtins)) {
1649 import = PyObject_GetItem(builtins, import_str);
1650 if (import == NULL)
1651 PyErr_SetObject(PyExc_KeyError, import_str);
1652 }
1653 else
1654 import = PyObject_GetAttr(builtins, import_str);
1655 if (import == NULL)
1656 goto err;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00001657
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001658 /* Call the __import__ function with the proper argument list
Brett Cannonbc2eff32010-09-19 21:39:02 +00001659 Always use absolute import here.
1660 Calling for side-effect of import. */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001661 r = PyObject_CallFunction(import, "OOOOi", module_name, globals,
1662 globals, silly_list, 0, NULL);
Brett Cannonbc2eff32010-09-19 21:39:02 +00001663 if (r == NULL)
1664 goto err;
1665 Py_DECREF(r);
1666
1667 modules = PyImport_GetModuleDict();
1668 r = PyDict_GetItem(modules, module_name);
1669 if (r != NULL)
1670 Py_INCREF(r);
Guido van Rossumd47a0a81997-08-14 20:11:26 +00001671
1672 err:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001673 Py_XDECREF(globals);
1674 Py_XDECREF(builtins);
1675 Py_XDECREF(import);
Tim Peters50d8d372001-02-28 05:34:27 +00001676
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001677 return r;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00001678}
1679
Barry Warsaw28a691b2010-04-17 00:19:56 +00001680static PyObject *
Brett Cannon2657df42012-05-04 15:20:40 -04001681imp_extension_suffixes(PyObject *self, PyObject *noargs)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001682{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001683 PyObject *list;
Brett Cannon2657df42012-05-04 15:20:40 -04001684 const char *suffix;
1685 unsigned int index = 0;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001686
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001687 list = PyList_New(0);
1688 if (list == NULL)
1689 return NULL;
Brett Cannon2657df42012-05-04 15:20:40 -04001690#ifdef HAVE_DYNAMIC_LOADING
1691 while ((suffix = _PyImport_DynLoadFiletab[index])) {
1692 PyObject *item = PyUnicode_FromString(suffix);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001693 if (item == NULL) {
1694 Py_DECREF(list);
1695 return NULL;
1696 }
1697 if (PyList_Append(list, item) < 0) {
1698 Py_DECREF(list);
1699 Py_DECREF(item);
1700 return NULL;
1701 }
1702 Py_DECREF(item);
Brett Cannon2657df42012-05-04 15:20:40 -04001703 index += 1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001704 }
Brett Cannon2657df42012-05-04 15:20:40 -04001705#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001706 return list;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001707}
1708
Guido van Rossum79f25d91997-04-29 20:08:16 +00001709static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001710imp_init_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001711{
Victor Stinner95872862011-03-07 18:20:56 +01001712 PyObject *name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001713 int ret;
1714 PyObject *m;
Victor Stinner95872862011-03-07 18:20:56 +01001715 if (!PyArg_ParseTuple(args, "U:init_builtin", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001716 return NULL;
1717 ret = init_builtin(name);
1718 if (ret < 0)
1719 return NULL;
1720 if (ret == 0) {
1721 Py_INCREF(Py_None);
1722 return Py_None;
1723 }
Victor Stinner95872862011-03-07 18:20:56 +01001724 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001725 Py_XINCREF(m);
1726 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001727}
1728
Guido van Rossum79f25d91997-04-29 20:08:16 +00001729static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001730imp_init_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001731{
Victor Stinner53dc7352011-03-20 01:50:21 +01001732 PyObject *name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001733 int ret;
1734 PyObject *m;
Victor Stinner53dc7352011-03-20 01:50:21 +01001735 if (!PyArg_ParseTuple(args, "U:init_frozen", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001736 return NULL;
Victor Stinner53dc7352011-03-20 01:50:21 +01001737 ret = PyImport_ImportFrozenModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001738 if (ret < 0)
1739 return NULL;
1740 if (ret == 0) {
1741 Py_INCREF(Py_None);
1742 return Py_None;
1743 }
Victor Stinner53dc7352011-03-20 01:50:21 +01001744 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001745 Py_XINCREF(m);
1746 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001747}
1748
Guido van Rossum79f25d91997-04-29 20:08:16 +00001749static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001750imp_get_frozen_object(PyObject *self, PyObject *args)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001751{
Victor Stinner53dc7352011-03-20 01:50:21 +01001752 PyObject *name;
Jack Jansen95ffa231995-10-03 14:38:41 +00001753
Victor Stinner53dc7352011-03-20 01:50:21 +01001754 if (!PyArg_ParseTuple(args, "U:get_frozen_object", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001755 return NULL;
1756 return get_frozen_object(name);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001757}
1758
Guido van Rossum79f25d91997-04-29 20:08:16 +00001759static PyObject *
Brett Cannon8d110132009-03-15 02:20:16 +00001760imp_is_frozen_package(PyObject *self, PyObject *args)
1761{
Victor Stinner53dc7352011-03-20 01:50:21 +01001762 PyObject *name;
Brett Cannon8d110132009-03-15 02:20:16 +00001763
Victor Stinner53dc7352011-03-20 01:50:21 +01001764 if (!PyArg_ParseTuple(args, "U:is_frozen_package", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001765 return NULL;
1766 return is_frozen_package(name);
Brett Cannon8d110132009-03-15 02:20:16 +00001767}
1768
1769static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001770imp_is_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001771{
Victor Stinner95872862011-03-07 18:20:56 +01001772 PyObject *name;
1773 if (!PyArg_ParseTuple(args, "U:is_builtin", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001774 return NULL;
1775 return PyLong_FromLong(is_builtin(name));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001776}
1777
Guido van Rossum79f25d91997-04-29 20:08:16 +00001778static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001779imp_is_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001780{
Victor Stinner53dc7352011-03-20 01:50:21 +01001781 PyObject *name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001782 struct _frozen *p;
Victor Stinner53dc7352011-03-20 01:50:21 +01001783 if (!PyArg_ParseTuple(args, "U:is_frozen", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001784 return NULL;
1785 p = find_frozen(name);
1786 return PyBool_FromLong((long) (p == NULL ? 0 : p->size));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001787}
1788
Guido van Rossum96a8fb71999-12-22 14:09:35 +00001789#ifdef HAVE_DYNAMIC_LOADING
1790
Guido van Rossum79f25d91997-04-29 20:08:16 +00001791static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001792imp_load_dynamic(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001793{
Victor Stinnerfefd70c2011-03-14 15:54:07 -04001794 PyObject *name, *pathname, *fob = NULL, *mod;
1795 FILE *fp;
1796
1797 if (!PyArg_ParseTuple(args, "UO&|O:load_dynamic",
1798 &name, PyUnicode_FSDecoder, &pathname, &fob))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001799 return NULL;
Victor Stinnerfefd70c2011-03-14 15:54:07 -04001800 if (fob != NULL) {
Antoine Pitrouf3a42de2012-05-04 22:40:25 +02001801 fp = _Py_fopen(pathname, "r");
Victor Stinnere9ddbf62011-03-22 10:46:35 +01001802 if (fp == NULL) {
1803 Py_DECREF(pathname);
Antoine Pitrouf3a42de2012-05-04 22:40:25 +02001804 if (!PyErr_Occurred())
1805 PyErr_SetFromErrno(PyExc_IOError);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001806 return NULL;
Victor Stinnere9ddbf62011-03-22 10:46:35 +01001807 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001808 }
Victor Stinnerfefd70c2011-03-14 15:54:07 -04001809 else
1810 fp = NULL;
1811 mod = _PyImport_LoadDynamicModule(name, pathname, fp);
Victor Stinnere9ddbf62011-03-22 10:46:35 +01001812 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001813 if (fp)
1814 fclose(fp);
Victor Stinnerfefd70c2011-03-14 15:54:07 -04001815 return mod;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001816}
1817
Guido van Rossum96a8fb71999-12-22 14:09:35 +00001818#endif /* HAVE_DYNAMIC_LOADING */
1819
Barry Warsaw28a691b2010-04-17 00:19:56 +00001820
Guido van Rossum0207e6d1997-09-09 22:04:42 +00001821/* Doc strings */
1822
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001823PyDoc_STRVAR(doc_imp,
Brett Cannon6f44d662012-04-15 16:08:47 -04001824"(Extremely) low-level import machinery bits as used by importlib and imp.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00001825
Brett Cannon2657df42012-05-04 15:20:40 -04001826PyDoc_STRVAR(doc_extension_suffixes,
1827"extension_suffixes() -> list of strings\n\
1828Returns the list of file suffixes used to identify extension modules.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00001829
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001830PyDoc_STRVAR(doc_lock_held,
Tim Petersa7c65092004-08-01 23:26:05 +00001831"lock_held() -> boolean\n\
1832Return True if the import lock is currently held, else False.\n\
1833On platforms without threads, return False.");
Tim Peters69232342001-08-30 05:16:13 +00001834
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00001835PyDoc_STRVAR(doc_acquire_lock,
1836"acquire_lock() -> None\n\
Neal Norwitz2294c0d2003-02-12 23:02:21 +00001837Acquires the interpreter's import lock for the current thread.\n\
1838This lock should be used by import hooks to ensure thread-safety\n\
1839when importing modules.\n\
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00001840On platforms without threads, this function does nothing.");
1841
1842PyDoc_STRVAR(doc_release_lock,
1843"release_lock() -> None\n\
1844Release the interpreter's import lock.\n\
1845On platforms without threads, this function does nothing.");
1846
Guido van Rossum79f25d91997-04-29 20:08:16 +00001847static PyMethodDef imp_methods[] = {
Brett Cannon2657df42012-05-04 15:20:40 -04001848 {"extension_suffixes", imp_extension_suffixes, METH_NOARGS,
1849 doc_extension_suffixes},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001850 {"lock_held", imp_lock_held, METH_NOARGS, doc_lock_held},
1851 {"acquire_lock", imp_acquire_lock, METH_NOARGS, doc_acquire_lock},
1852 {"release_lock", imp_release_lock, METH_NOARGS, doc_release_lock},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001853 {"get_frozen_object", imp_get_frozen_object, METH_VARARGS},
1854 {"is_frozen_package", imp_is_frozen_package, METH_VARARGS},
1855 {"init_builtin", imp_init_builtin, METH_VARARGS},
1856 {"init_frozen", imp_init_frozen, METH_VARARGS},
1857 {"is_builtin", imp_is_builtin, METH_VARARGS},
1858 {"is_frozen", imp_is_frozen, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00001859#ifdef HAVE_DYNAMIC_LOADING
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001860 {"load_dynamic", imp_load_dynamic, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00001861#endif
Brett Cannon442c9b92011-03-23 16:14:42 -07001862 {"_fix_co_filename", imp_fix_co_filename, METH_VARARGS},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001863 {NULL, NULL} /* sentinel */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001864};
1865
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001866
Martin v. Löwis1a214512008-06-11 05:26:20 +00001867static struct PyModuleDef impmodule = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001868 PyModuleDef_HEAD_INIT,
Brett Cannon6f44d662012-04-15 16:08:47 -04001869 "_imp",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001870 doc_imp,
1871 0,
1872 imp_methods,
1873 NULL,
1874 NULL,
1875 NULL,
1876 NULL
Martin v. Löwis1a214512008-06-11 05:26:20 +00001877};
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001878
Jason Tishler6bc06ec2003-09-04 11:59:50 +00001879PyMODINIT_FUNC
Martin v. Löwis1a214512008-06-11 05:26:20 +00001880PyInit_imp(void)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001881{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001882 PyObject *m, *d;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001883
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001884 m = PyModule_Create(&impmodule);
1885 if (m == NULL)
1886 goto failure;
1887 d = PyModule_GetDict(m);
1888 if (d == NULL)
1889 goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001890
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001891 return m;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001892 failure:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001893 Py_XDECREF(m);
1894 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001895}
Guido van Rossum09cae1f1998-05-14 02:32:54 +00001896
1897
Guido van Rossumb18618d2000-05-03 23:44:39 +00001898/* API for embedding applications that want to add their own entries
1899 to the table of built-in modules. This should normally be called
1900 *before* Py_Initialize(). When the table resize fails, -1 is
1901 returned and the existing table is unchanged.
Guido van Rossum09cae1f1998-05-14 02:32:54 +00001902
1903 After a similar function by Just van Rossum. */
1904
1905int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001906PyImport_ExtendInittab(struct _inittab *newtab)
Guido van Rossum09cae1f1998-05-14 02:32:54 +00001907{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001908 static struct _inittab *our_copy = NULL;
1909 struct _inittab *p;
1910 int i, n;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00001911
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001912 /* Count the number of entries in both tables */
1913 for (n = 0; newtab[n].name != NULL; n++)
1914 ;
1915 if (n == 0)
1916 return 0; /* Nothing to do */
1917 for (i = 0; PyImport_Inittab[i].name != NULL; i++)
1918 ;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00001919
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001920 /* Allocate new memory for the combined table */
1921 p = our_copy;
1922 PyMem_RESIZE(p, struct _inittab, i+n+1);
1923 if (p == NULL)
1924 return -1;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00001925
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001926 /* Copy the tables into the new memory */
1927 if (our_copy != PyImport_Inittab)
1928 memcpy(p, PyImport_Inittab, (i+1) * sizeof(struct _inittab));
1929 PyImport_Inittab = our_copy = p;
1930 memcpy(p+i, newtab, (n+1) * sizeof(struct _inittab));
Guido van Rossum09cae1f1998-05-14 02:32:54 +00001931
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001932 return 0;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00001933}
1934
1935/* Shorthand to add a single entry given a name and a function */
1936
1937int
Brett Cannona826f322009-04-02 03:41:46 +00001938PyImport_AppendInittab(const char *name, PyObject* (*initfunc)(void))
Guido van Rossum09cae1f1998-05-14 02:32:54 +00001939{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001940 struct _inittab newtab[2];
Guido van Rossum09cae1f1998-05-14 02:32:54 +00001941
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001942 memset(newtab, '\0', sizeof newtab);
Guido van Rossum09cae1f1998-05-14 02:32:54 +00001943
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001944 newtab[0].name = (char *)name;
1945 newtab[0].initfunc = initfunc;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00001946
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001947 return PyImport_ExtendInittab(newtab);
Guido van Rossum09cae1f1998-05-14 02:32:54 +00001948}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001949
1950#ifdef __cplusplus
1951}
1952#endif