blob: 26f4772da7b9e7224cc5fd47c0ff2944d75eff9f [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();
205 PyThread_acquire_lock(import_lock, 0);
Victor Stinner942003c2011-03-07 16:57:48 +0100206 /* XXX: can the previous line fail? */
Nick Coghlanb2ddf792010-12-02 04:11:46 +0000207 import_lock_thread = me;
208 import_lock_level--;
209 } else {
210 import_lock_thread = -1;
211 import_lock_level = 0;
212 }
Guido van Rossum8ee3e5a2005-09-14 18:09:42 +0000213}
214
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000215#endif
216
Tim Peters69232342001-08-30 05:16:13 +0000217static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000218imp_lock_held(PyObject *self, PyObject *noargs)
Tim Peters69232342001-08-30 05:16:13 +0000219{
Tim Peters69232342001-08-30 05:16:13 +0000220#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000221 return PyBool_FromLong(import_lock_thread != -1);
Tim Peters69232342001-08-30 05:16:13 +0000222#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000223 return PyBool_FromLong(0);
Tim Peters69232342001-08-30 05:16:13 +0000224#endif
225}
226
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000227static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000228imp_acquire_lock(PyObject *self, PyObject *noargs)
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000229{
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000230#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000231 _PyImport_AcquireLock();
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000232#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000233 Py_INCREF(Py_None);
234 return Py_None;
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000235}
236
237static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000238imp_release_lock(PyObject *self, PyObject *noargs)
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000239{
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000240#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000241 if (_PyImport_ReleaseLock() < 0) {
242 PyErr_SetString(PyExc_RuntimeError,
243 "not holding the import lock");
244 return NULL;
245 }
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000246#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000247 Py_INCREF(Py_None);
248 return Py_None;
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000249}
250
Antoine Pitrou8db076c2011-10-30 19:13:55 +0100251void
252_PyImport_Fini(void)
253{
254 Py_XDECREF(extensions);
255 extensions = NULL;
Antoine Pitrou8db076c2011-10-30 19:13:55 +0100256#ifdef WITH_THREAD
257 if (import_lock != NULL) {
258 PyThread_free_lock(import_lock);
259 import_lock = NULL;
260 }
261#endif
262}
263
Guido van Rossum25ce5661997-08-02 03:10:38 +0000264/* Helper for sys */
265
266PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000267PyImport_GetModuleDict(void)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000268{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000269 PyInterpreterState *interp = PyThreadState_GET()->interp;
270 if (interp->modules == NULL)
271 Py_FatalError("PyImport_GetModuleDict: no module dictionary!");
272 return interp->modules;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000273}
274
Guido van Rossum3f5da241990-12-20 15:06:42 +0000275
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000276/* List of names to clear in sys */
277static char* sys_deletes[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000278 "path", "argv", "ps1", "ps2",
279 "last_type", "last_value", "last_traceback",
280 "path_hooks", "path_importer_cache", "meta_path",
281 /* misc stuff */
282 "flags", "float_info",
283 NULL
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000284};
285
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000286static char* sys_files[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000287 "stdin", "__stdin__",
288 "stdout", "__stdout__",
289 "stderr", "__stderr__",
290 NULL
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000291};
292
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000293
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000294/* Un-initialize things, as good as we can */
Guido van Rossum3f5da241990-12-20 15:06:42 +0000295
Guido van Rossum3f5da241990-12-20 15:06:42 +0000296void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000297PyImport_Cleanup(void)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000298{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000299 Py_ssize_t pos, ndone;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000300 PyObject *key, *value, *dict;
301 PyInterpreterState *interp = PyThreadState_GET()->interp;
302 PyObject *modules = interp->modules;
Guido van Rossum758eec01998-01-19 21:58:26 +0000303
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000304 if (modules == NULL)
305 return; /* Already done */
Guido van Rossum758eec01998-01-19 21:58:26 +0000306
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000307 /* Delete some special variables first. These are common
308 places where user values hide and people complain when their
309 destructors fail. Since the modules containing them are
310 deleted *last* of all, they would come too late in the normal
311 destruction order. Sigh. */
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000312
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000313 value = PyDict_GetItemString(modules, "builtins");
314 if (value != NULL && PyModule_Check(value)) {
315 dict = PyModule_GetDict(value);
316 if (Py_VerboseFlag)
317 PySys_WriteStderr("# clear builtins._\n");
318 PyDict_SetItemString(dict, "_", Py_None);
319 }
320 value = PyDict_GetItemString(modules, "sys");
321 if (value != NULL && PyModule_Check(value)) {
322 char **p;
323 PyObject *v;
324 dict = PyModule_GetDict(value);
325 for (p = sys_deletes; *p != NULL; p++) {
326 if (Py_VerboseFlag)
327 PySys_WriteStderr("# clear sys.%s\n", *p);
328 PyDict_SetItemString(dict, *p, Py_None);
329 }
330 for (p = sys_files; *p != NULL; p+=2) {
331 if (Py_VerboseFlag)
332 PySys_WriteStderr("# restore sys.%s\n", *p);
333 v = PyDict_GetItemString(dict, *(p+1));
334 if (v == NULL)
335 v = Py_None;
336 PyDict_SetItemString(dict, *p, v);
337 }
338 }
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000339
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000340 /* First, delete __main__ */
341 value = PyDict_GetItemString(modules, "__main__");
342 if (value != NULL && PyModule_Check(value)) {
343 if (Py_VerboseFlag)
344 PySys_WriteStderr("# cleanup __main__\n");
345 _PyModule_Clear(value);
346 PyDict_SetItemString(modules, "__main__", Py_None);
347 }
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000348
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000349 /* The special treatment of "builtins" here is because even
350 when it's not referenced as a module, its dictionary is
351 referenced by almost every module's __builtins__. Since
352 deleting a module clears its dictionary (even if there are
353 references left to it), we need to delete the "builtins"
354 module last. Likewise, we don't delete sys until the very
355 end because it is implicitly referenced (e.g. by print).
Guido van Rossum758eec01998-01-19 21:58:26 +0000356
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000357 Also note that we 'delete' modules by replacing their entry
358 in the modules dict with None, rather than really deleting
359 them; this avoids a rehash of the modules dictionary and
360 also marks them as "non existent" so they won't be
361 re-imported. */
Guido van Rossum758eec01998-01-19 21:58:26 +0000362
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000363 /* Next, repeatedly delete modules with a reference count of
364 one (skipping builtins and sys) and delete them */
365 do {
366 ndone = 0;
367 pos = 0;
368 while (PyDict_Next(modules, &pos, &key, &value)) {
369 if (value->ob_refcnt != 1)
370 continue;
371 if (PyUnicode_Check(key) && PyModule_Check(value)) {
Victor Stinner9464d612011-03-07 17:08:21 +0100372 if (PyUnicode_CompareWithASCIIString(key, "builtins") == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000373 continue;
Victor Stinner9464d612011-03-07 17:08:21 +0100374 if (PyUnicode_CompareWithASCIIString(key, "sys") == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000375 continue;
376 if (Py_VerboseFlag)
Victor Stinner9464d612011-03-07 17:08:21 +0100377 PySys_FormatStderr(
378 "# cleanup[1] %U\n", key);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000379 _PyModule_Clear(value);
380 PyDict_SetItem(modules, key, Py_None);
381 ndone++;
382 }
383 }
384 } while (ndone > 0);
Guido van Rossum758eec01998-01-19 21:58:26 +0000385
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000386 /* Next, delete all modules (still skipping builtins and sys) */
387 pos = 0;
388 while (PyDict_Next(modules, &pos, &key, &value)) {
389 if (PyUnicode_Check(key) && PyModule_Check(value)) {
Victor Stinner9464d612011-03-07 17:08:21 +0100390 if (PyUnicode_CompareWithASCIIString(key, "builtins") == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000391 continue;
Victor Stinner9464d612011-03-07 17:08:21 +0100392 if (PyUnicode_CompareWithASCIIString(key, "sys") == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000393 continue;
394 if (Py_VerboseFlag)
Victor Stinner9464d612011-03-07 17:08:21 +0100395 PySys_FormatStderr("# cleanup[2] %U\n", key);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000396 _PyModule_Clear(value);
397 PyDict_SetItem(modules, key, Py_None);
398 }
399 }
Guido van Rossum758eec01998-01-19 21:58:26 +0000400
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000401 /* Next, delete sys and builtins (in that order) */
402 value = PyDict_GetItemString(modules, "sys");
403 if (value != NULL && PyModule_Check(value)) {
404 if (Py_VerboseFlag)
405 PySys_WriteStderr("# cleanup sys\n");
406 _PyModule_Clear(value);
407 PyDict_SetItemString(modules, "sys", Py_None);
408 }
409 value = PyDict_GetItemString(modules, "builtins");
410 if (value != NULL && PyModule_Check(value)) {
411 if (Py_VerboseFlag)
412 PySys_WriteStderr("# cleanup builtins\n");
413 _PyModule_Clear(value);
414 PyDict_SetItemString(modules, "builtins", Py_None);
415 }
Guido van Rossum758eec01998-01-19 21:58:26 +0000416
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000417 /* Finally, clear and delete the modules directory */
418 PyDict_Clear(modules);
419 interp->modules = NULL;
420 Py_DECREF(modules);
Guido van Rossum8d15b5d1990-10-26 14:58:58 +0000421}
Guido van Rossum7f133ed1991-02-19 12:23:57 +0000422
423
Barry Warsaw28a691b2010-04-17 00:19:56 +0000424/* Helper for pythonrun.c -- return magic number and tag. */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000425
426long
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000427PyImport_GetMagicNumber(void)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000428{
Antoine Pitrou44b4b6a2012-07-10 18:27:54 +0200429 long res;
Brett Cannon77b2abd2012-07-09 16:09:00 -0400430 PyInterpreterState *interp = PyThreadState_Get()->interp;
431 PyObject *pyc_magic = PyObject_GetAttrString(interp->importlib,
432 "_RAW_MAGIC_NUMBER");
433 if (pyc_magic == NULL)
434 return -1;
Antoine Pitrou44b4b6a2012-07-10 18:27:54 +0200435 res = PyLong_AsLong(pyc_magic);
Benjamin Peterson66f36592012-07-09 22:21:55 -0700436 Py_DECREF(pyc_magic);
437 return res;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000438}
439
440
Brett Cannon3adc7b72012-07-09 14:22:12 -0400441extern const char * _PySys_ImplCacheTag;
442
Barry Warsaw28a691b2010-04-17 00:19:56 +0000443const char *
444PyImport_GetMagicTag(void)
445{
Brett Cannon3adc7b72012-07-09 14:22:12 -0400446 return _PySys_ImplCacheTag;
Barry Warsaw28a691b2010-04-17 00:19:56 +0000447}
448
Brett Cannon98979b82012-07-02 15:13:11 -0400449
Guido van Rossum25ce5661997-08-02 03:10:38 +0000450/* Magic for extension modules (built-in as well as dynamically
451 loaded). To prevent initializing an extension module more than
452 once, we keep a static dictionary 'extensions' keyed by module name
453 (for built-in modules) or by filename (for dynamically loaded
Barry Warsaw92883382001-08-13 23:05:44 +0000454 modules), containing these modules. A copy of the module's
Victor Stinner95872862011-03-07 18:20:56 +0100455 dictionary is stored by calling _PyImport_FixupExtensionObject()
Guido van Rossum25ce5661997-08-02 03:10:38 +0000456 immediately after the module initialization function succeeds. A
457 copy can be retrieved from there by calling
Victor Stinner95872862011-03-07 18:20:56 +0100458 _PyImport_FindExtensionObject().
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000459
Barry Warsaw7c9627b2010-06-17 18:38:20 +0000460 Modules which do support multiple initialization set their m_size
461 field to a non-negative number (indicating the size of the
462 module-specific state). They are still recorded in the extensions
463 dictionary, to avoid loading shared libraries twice.
Martin v. Löwis1a214512008-06-11 05:26:20 +0000464*/
465
466int
Victor Stinner95872862011-03-07 18:20:56 +0100467_PyImport_FixupExtensionObject(PyObject *mod, PyObject *name,
468 PyObject *filename)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000469{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000470 PyObject *modules, *dict;
471 struct PyModuleDef *def;
472 if (extensions == NULL) {
473 extensions = PyDict_New();
474 if (extensions == NULL)
475 return -1;
476 }
477 if (mod == NULL || !PyModule_Check(mod)) {
478 PyErr_BadInternalCall();
479 return -1;
480 }
481 def = PyModule_GetDef(mod);
482 if (!def) {
483 PyErr_BadInternalCall();
484 return -1;
485 }
486 modules = PyImport_GetModuleDict();
Victor Stinner95872862011-03-07 18:20:56 +0100487 if (PyDict_SetItem(modules, name, mod) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000488 return -1;
489 if (_PyState_AddModule(mod, def) < 0) {
Victor Stinner95872862011-03-07 18:20:56 +0100490 PyDict_DelItem(modules, name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000491 return -1;
492 }
493 if (def->m_size == -1) {
494 if (def->m_base.m_copy) {
495 /* Somebody already imported the module,
496 likely under a different name.
497 XXX this should really not happen. */
498 Py_DECREF(def->m_base.m_copy);
499 def->m_base.m_copy = NULL;
500 }
501 dict = PyModule_GetDict(mod);
502 if (dict == NULL)
503 return -1;
504 def->m_base.m_copy = PyDict_Copy(dict);
505 if (def->m_base.m_copy == NULL)
506 return -1;
507 }
Victor Stinner49d3f252010-10-17 01:24:53 +0000508 PyDict_SetItem(extensions, filename, (PyObject*)def);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000509 return 0;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000510}
511
Victor Stinner49d3f252010-10-17 01:24:53 +0000512int
513_PyImport_FixupBuiltin(PyObject *mod, char *name)
514{
515 int res;
Victor Stinner95872862011-03-07 18:20:56 +0100516 PyObject *nameobj;
Victor Stinner21fcd0c2011-03-07 18:28:15 +0100517 nameobj = PyUnicode_InternFromString(name);
Victor Stinner95872862011-03-07 18:20:56 +0100518 if (nameobj == NULL)
Victor Stinner49d3f252010-10-17 01:24:53 +0000519 return -1;
Victor Stinner95872862011-03-07 18:20:56 +0100520 res = _PyImport_FixupExtensionObject(mod, nameobj, nameobj);
521 Py_DECREF(nameobj);
Victor Stinner49d3f252010-10-17 01:24:53 +0000522 return res;
523}
524
Guido van Rossum25ce5661997-08-02 03:10:38 +0000525PyObject *
Victor Stinner95872862011-03-07 18:20:56 +0100526_PyImport_FindExtensionObject(PyObject *name, PyObject *filename)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000527{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000528 PyObject *mod, *mdict;
529 PyModuleDef* def;
530 if (extensions == NULL)
531 return NULL;
Victor Stinner49d3f252010-10-17 01:24:53 +0000532 def = (PyModuleDef*)PyDict_GetItem(extensions, filename);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000533 if (def == NULL)
534 return NULL;
535 if (def->m_size == -1) {
536 /* Module does not support repeated initialization */
537 if (def->m_base.m_copy == NULL)
538 return NULL;
Victor Stinner95872862011-03-07 18:20:56 +0100539 mod = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000540 if (mod == NULL)
541 return NULL;
542 mdict = PyModule_GetDict(mod);
543 if (mdict == NULL)
544 return NULL;
545 if (PyDict_Update(mdict, def->m_base.m_copy))
546 return NULL;
547 }
548 else {
549 if (def->m_base.m_init == NULL)
550 return NULL;
551 mod = def->m_base.m_init();
552 if (mod == NULL)
553 return NULL;
Victor Stinner95872862011-03-07 18:20:56 +0100554 PyDict_SetItem(PyImport_GetModuleDict(), name, mod);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000555 Py_DECREF(mod);
556 }
557 if (_PyState_AddModule(mod, def) < 0) {
Victor Stinner95872862011-03-07 18:20:56 +0100558 PyDict_DelItem(PyImport_GetModuleDict(), name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000559 Py_DECREF(mod);
560 return NULL;
561 }
562 if (Py_VerboseFlag)
Victor Stinner95872862011-03-07 18:20:56 +0100563 PySys_FormatStderr("import %U # previously loaded (%R)\n",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000564 name, filename);
565 return mod;
Brett Cannon9a5b25a2010-03-01 02:09:17 +0000566
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000567}
568
Victor Stinner49d3f252010-10-17 01:24:53 +0000569PyObject *
Victor Stinner501c09a2011-02-23 00:02:00 +0000570_PyImport_FindBuiltin(const char *name)
Victor Stinner49d3f252010-10-17 01:24:53 +0000571{
Victor Stinner95872862011-03-07 18:20:56 +0100572 PyObject *res, *nameobj;
Victor Stinner21fcd0c2011-03-07 18:28:15 +0100573 nameobj = PyUnicode_InternFromString(name);
Victor Stinner95872862011-03-07 18:20:56 +0100574 if (nameobj == NULL)
Victor Stinner49d3f252010-10-17 01:24:53 +0000575 return NULL;
Victor Stinner95872862011-03-07 18:20:56 +0100576 res = _PyImport_FindExtensionObject(nameobj, nameobj);
577 Py_DECREF(nameobj);
Victor Stinner49d3f252010-10-17 01:24:53 +0000578 return res;
579}
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000580
581/* Get the module object corresponding to a module name.
582 First check the modules dictionary if there's one there,
Walter Dörwaldf0dfc7a2003-10-20 14:01:56 +0000583 if not, create a new one and insert it in the modules dictionary.
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000584 Because the former action is most common, THIS DOES NOT RETURN A
585 'NEW' REFERENCE! */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000586
Guido van Rossum79f25d91997-04-29 20:08:16 +0000587PyObject *
Victor Stinner27ee0892011-03-04 12:57:09 +0000588PyImport_AddModuleObject(PyObject *name)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000589{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000590 PyObject *modules = PyImport_GetModuleDict();
591 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000592
Victor Stinner27ee0892011-03-04 12:57:09 +0000593 if ((m = PyDict_GetItem(modules, name)) != NULL &&
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000594 PyModule_Check(m))
595 return m;
Victor Stinner27ee0892011-03-04 12:57:09 +0000596 m = PyModule_NewObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000597 if (m == NULL)
598 return NULL;
Victor Stinner27ee0892011-03-04 12:57:09 +0000599 if (PyDict_SetItem(modules, name, m) != 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000600 Py_DECREF(m);
601 return NULL;
602 }
603 Py_DECREF(m); /* Yes, it still exists, in modules! */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000604
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000605 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000606}
607
Victor Stinner27ee0892011-03-04 12:57:09 +0000608PyObject *
609PyImport_AddModule(const char *name)
610{
611 PyObject *nameobj, *module;
612 nameobj = PyUnicode_FromString(name);
613 if (nameobj == NULL)
614 return NULL;
615 module = PyImport_AddModuleObject(nameobj);
616 Py_DECREF(nameobj);
617 return module;
618}
619
620
Tim Peters1cd70172004-08-02 03:52:12 +0000621/* Remove name from sys.modules, if it's there. */
622static void
Victor Stinner27ee0892011-03-04 12:57:09 +0000623remove_module(PyObject *name)
Tim Peters1cd70172004-08-02 03:52:12 +0000624{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000625 PyObject *modules = PyImport_GetModuleDict();
Victor Stinner27ee0892011-03-04 12:57:09 +0000626 if (PyDict_GetItem(modules, name) == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000627 return;
Victor Stinner27ee0892011-03-04 12:57:09 +0000628 if (PyDict_DelItem(modules, name) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000629 Py_FatalError("import: deleting existing key in"
630 "sys.modules failed");
Tim Peters1cd70172004-08-02 03:52:12 +0000631}
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000632
Victor Stinnerc9abda02011-03-14 13:33:46 -0400633static PyObject * get_sourcefile(PyObject *filename);
634static PyObject *make_source_pathname(PyObject *pathname);
Christian Heimes3b06e532008-01-07 20:12:44 +0000635
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000636/* Execute a code object in a module and return the module object
Tim Peters1cd70172004-08-02 03:52:12 +0000637 * WITH INCREMENTED REFERENCE COUNT. If an error occurs, name is
638 * removed from sys.modules, to avoid leaving damaged module objects
639 * in sys.modules. The caller may wish to restore the original
640 * module object (if any) in this case; PyImport_ReloadModule is an
641 * example.
Barry Warsaw28a691b2010-04-17 00:19:56 +0000642 *
643 * Note that PyImport_ExecCodeModuleWithPathnames() is the preferred, richer
644 * interface. The other two exist primarily for backward compatibility.
Tim Peters1cd70172004-08-02 03:52:12 +0000645 */
Guido van Rossum79f25d91997-04-29 20:08:16 +0000646PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000647PyImport_ExecCodeModule(char *name, PyObject *co)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000648{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000649 return PyImport_ExecCodeModuleWithPathnames(
650 name, co, (char *)NULL, (char *)NULL);
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000651}
652
653PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000654PyImport_ExecCodeModuleEx(char *name, PyObject *co, char *pathname)
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000655{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000656 return PyImport_ExecCodeModuleWithPathnames(
657 name, co, pathname, (char *)NULL);
Barry Warsaw28a691b2010-04-17 00:19:56 +0000658}
659
660PyObject *
661PyImport_ExecCodeModuleWithPathnames(char *name, PyObject *co, char *pathname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000662 char *cpathname)
Barry Warsaw28a691b2010-04-17 00:19:56 +0000663{
Victor Stinner27ee0892011-03-04 12:57:09 +0000664 PyObject *m = NULL;
665 PyObject *nameobj, *pathobj = NULL, *cpathobj = NULL;
666
667 nameobj = PyUnicode_FromString(name);
668 if (nameobj == NULL)
669 return NULL;
670
671 if (pathname != NULL) {
672 pathobj = PyUnicode_DecodeFSDefault(pathname);
673 if (pathobj == NULL)
674 goto error;
675 } else
676 pathobj = NULL;
677 if (cpathname != NULL) {
678 cpathobj = PyUnicode_DecodeFSDefault(cpathname);
679 if (cpathobj == NULL)
680 goto error;
681 } else
682 cpathobj = NULL;
683 m = PyImport_ExecCodeModuleObject(nameobj, co, pathobj, cpathobj);
684error:
685 Py_DECREF(nameobj);
686 Py_XDECREF(pathobj);
687 Py_XDECREF(cpathobj);
688 return m;
689}
690
691PyObject*
692PyImport_ExecCodeModuleObject(PyObject *name, PyObject *co, PyObject *pathname,
693 PyObject *cpathname)
694{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000695 PyObject *modules = PyImport_GetModuleDict();
696 PyObject *m, *d, *v;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000697
Victor Stinner27ee0892011-03-04 12:57:09 +0000698 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000699 if (m == NULL)
700 return NULL;
701 /* If the module is being reloaded, we get the old module back
702 and re-use its dict to exec the new code. */
703 d = PyModule_GetDict(m);
704 if (PyDict_GetItemString(d, "__builtins__") == NULL) {
705 if (PyDict_SetItemString(d, "__builtins__",
706 PyEval_GetBuiltins()) != 0)
707 goto error;
708 }
709 /* Remember the filename as the __file__ attribute */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000710 if (pathname != NULL) {
Victor Stinnerc9abda02011-03-14 13:33:46 -0400711 v = get_sourcefile(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000712 if (v == NULL)
713 PyErr_Clear();
714 }
Victor Stinner27ee0892011-03-04 12:57:09 +0000715 else
716 v = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000717 if (v == NULL) {
718 v = ((PyCodeObject *)co)->co_filename;
719 Py_INCREF(v);
720 }
721 if (PyDict_SetItemString(d, "__file__", v) != 0)
722 PyErr_Clear(); /* Not important enough to report */
723 Py_DECREF(v);
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000724
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000725 /* Remember the pyc path name as the __cached__ attribute. */
Victor Stinner27ee0892011-03-04 12:57:09 +0000726 if (cpathname != NULL)
727 v = cpathname;
728 else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000729 v = Py_None;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000730 if (PyDict_SetItemString(d, "__cached__", v) != 0)
731 PyErr_Clear(); /* Not important enough to report */
Barry Warsaw28a691b2010-04-17 00:19:56 +0000732
Martin v. Löwis4d0d4712010-12-03 20:14:31 +0000733 v = PyEval_EvalCode(co, d, d);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000734 if (v == NULL)
735 goto error;
736 Py_DECREF(v);
Guido van Rossumb65e85c1997-07-10 18:00:45 +0000737
Victor Stinner27ee0892011-03-04 12:57:09 +0000738 if ((m = PyDict_GetItem(modules, name)) == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000739 PyErr_Format(PyExc_ImportError,
Victor Stinner27ee0892011-03-04 12:57:09 +0000740 "Loaded module %R not found in sys.modules",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000741 name);
742 return NULL;
743 }
Guido van Rossumb65e85c1997-07-10 18:00:45 +0000744
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000745 Py_INCREF(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000746
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000747 return m;
Tim Peters1cd70172004-08-02 03:52:12 +0000748
749 error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000750 remove_module(name);
751 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000752}
753
754
Martin v. Löwis2db72862011-10-23 17:29:08 +0200755/* Like rightmost_sep, but operate on unicode objects. */
756static Py_ssize_t
Martin v. Löwis8a0ef782011-10-23 18:05:06 +0200757rightmost_sep_obj(PyObject* o, Py_ssize_t start, Py_ssize_t end)
Martin v. Löwis2db72862011-10-23 17:29:08 +0200758{
759 Py_ssize_t found, i;
760 Py_UCS4 c;
Martin v. Löwis8a0ef782011-10-23 18:05:06 +0200761 for (found = -1, i = start; i < end; i++) {
Martin v. Löwis2db72862011-10-23 17:29:08 +0200762 c = PyUnicode_READ_CHAR(o, i);
763 if (c == SEP
764#ifdef ALTSEP
765 || c == ALTSEP
766#endif
767 )
768 {
769 found = i;
770 }
771 }
772 return found;
773}
Victor Stinnerc9abda02011-03-14 13:33:46 -0400774
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000775
Barry Warsaw28a691b2010-04-17 00:19:56 +0000776/* Given a pathname to a Python byte compiled file, return the path to the
777 source file, if the path matches the PEP 3147 format. This does not check
778 for any file existence, however, if the pyc file name does not match PEP
779 3147 style, NULL is returned. buf must be at least as big as pathname;
Victor Stinnerc9abda02011-03-14 13:33:46 -0400780 the resulting path will always be shorter.
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000781
Victor Stinnerc9abda02011-03-14 13:33:46 -0400782 (...)/__pycache__/foo.<tag>.pyc -> (...)/foo.py */
783
784static PyObject*
Martin v. Löwis8a0ef782011-10-23 18:05:06 +0200785make_source_pathname(PyObject *path)
Barry Warsaw28a691b2010-04-17 00:19:56 +0000786{
Martin v. Löwis8a0ef782011-10-23 18:05:06 +0200787 Py_ssize_t left, right, dot0, dot1, len;
788 Py_ssize_t i, j;
789 PyObject *result;
790 int kind;
791 void *data;
Victor Stinnerc9abda02011-03-14 13:33:46 -0400792
Martin v. Löwis8a0ef782011-10-23 18:05:06 +0200793 len = PyUnicode_GET_LENGTH(path);
794 if (len > MAXPATHLEN)
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200795 return NULL;
Barry Warsaw28a691b2010-04-17 00:19:56 +0000796
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000797 /* Look back two slashes from the end. In between these two slashes
798 must be the string __pycache__ or this is not a PEP 3147 style
799 path. It's possible for there to be only one slash.
800 */
Martin v. Löwis8a0ef782011-10-23 18:05:06 +0200801 right = rightmost_sep_obj(path, 0, len);
802 if (right == -1)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000803 return NULL;
Martin v. Löwis8a0ef782011-10-23 18:05:06 +0200804 left = rightmost_sep_obj(path, 0, right);
805 if (left == -1)
806 left = 0;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000807 else
808 left++;
Martin v. Löwis8a0ef782011-10-23 18:05:06 +0200809 if (right-left != sizeof(CACHEDIR)-1)
810 return NULL;
811 for (i = 0; i < sizeof(CACHEDIR)-1; i++)
812 if (PyUnicode_READ_CHAR(path, left+i) != CACHEDIR[i])
813 return NULL;
Barry Warsaw28a691b2010-04-17 00:19:56 +0000814
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000815 /* Now verify that the path component to the right of the last slash
816 has two dots in it.
817 */
Martin v. Löwis8a0ef782011-10-23 18:05:06 +0200818 dot0 = PyUnicode_FindChar(path, '.', right+1, len, 1);
819 if (dot0 < 0)
820 return NULL;
821 dot1 = PyUnicode_FindChar(path, '.', dot0+1, len, 1);
822 if (dot1 < 0)
823 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000824 /* Too many dots? */
Martin v. Löwis8a0ef782011-10-23 18:05:06 +0200825 if (PyUnicode_FindChar(path, '.', dot1+1, len, 1) != -1)
826 return NULL;
Barry Warsaw28a691b2010-04-17 00:19:56 +0000827
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000828 /* This is a PEP 3147 path. Start by copying everything from the
829 start of pathname up to and including the leftmost slash. Then
830 copy the file's basename, removing the magic tag and adding a .py
831 suffix.
832 */
Martin v. Löwis8a0ef782011-10-23 18:05:06 +0200833 result = PyUnicode_New(left + (dot0-right) + 2,
834 PyUnicode_MAX_CHAR_VALUE(path));
835 if (!result)
836 return NULL;
837 kind = PyUnicode_KIND(result);
838 data = PyUnicode_DATA(result);
839 PyUnicode_CopyCharacters(result, 0, path, 0, (i = left));
840 PyUnicode_CopyCharacters(result, left, path, right+1,
841 (j = dot0-right));
842 PyUnicode_WRITE(kind, data, i+j, 'p');
843 PyUnicode_WRITE(kind, data, i+j+1, 'y');
Victor Stinner8f825062012-04-27 13:55:39 +0200844 assert(_PyUnicode_CheckConsistency(result, 1));
Martin v. Löwis8a0ef782011-10-23 18:05:06 +0200845 return result;
Barry Warsaw28a691b2010-04-17 00:19:56 +0000846}
847
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000848
Antoine Pitroud35cbf62009-01-06 19:02:24 +0000849static void
850update_code_filenames(PyCodeObject *co, PyObject *oldname, PyObject *newname)
851{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000852 PyObject *constants, *tmp;
853 Py_ssize_t i, n;
Antoine Pitroud35cbf62009-01-06 19:02:24 +0000854
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000855 if (PyUnicode_Compare(co->co_filename, oldname))
856 return;
Antoine Pitroud35cbf62009-01-06 19:02:24 +0000857
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000858 tmp = co->co_filename;
859 co->co_filename = newname;
860 Py_INCREF(co->co_filename);
861 Py_DECREF(tmp);
Antoine Pitroud35cbf62009-01-06 19:02:24 +0000862
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000863 constants = co->co_consts;
864 n = PyTuple_GET_SIZE(constants);
865 for (i = 0; i < n; i++) {
866 tmp = PyTuple_GET_ITEM(constants, i);
867 if (PyCode_Check(tmp))
868 update_code_filenames((PyCodeObject *)tmp,
869 oldname, newname);
870 }
Antoine Pitroud35cbf62009-01-06 19:02:24 +0000871}
872
Victor Stinner2f42ae52011-03-20 00:41:24 +0100873static void
874update_compiled_module(PyCodeObject *co, PyObject *newname)
Antoine Pitroud35cbf62009-01-06 19:02:24 +0000875{
Victor Stinner2f42ae52011-03-20 00:41:24 +0100876 PyObject *oldname;
Antoine Pitroud35cbf62009-01-06 19:02:24 +0000877
Victor Stinner2f42ae52011-03-20 00:41:24 +0100878 if (PyUnicode_Compare(co->co_filename, newname) == 0)
879 return;
Hirokazu Yamamoto4f447fb2009-03-04 01:52:10 +0000880
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000881 oldname = co->co_filename;
882 Py_INCREF(oldname);
883 update_code_filenames(co, oldname, newname);
884 Py_DECREF(oldname);
Antoine Pitroud35cbf62009-01-06 19:02:24 +0000885}
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000886
Brett Cannon442c9b92011-03-23 16:14:42 -0700887static PyObject *
888imp_fix_co_filename(PyObject *self, PyObject *args)
889{
890 PyObject *co;
891 PyObject *file_path;
892
893 if (!PyArg_ParseTuple(args, "OO:_fix_co_filename", &co, &file_path))
894 return NULL;
895
896 if (!PyCode_Check(co)) {
897 PyErr_SetString(PyExc_TypeError,
898 "first argument must be a code object");
899 return NULL;
900 }
901
902 if (!PyUnicode_Check(file_path)) {
903 PyErr_SetString(PyExc_TypeError,
904 "second argument must be a string");
905 return NULL;
906 }
907
908 update_compiled_module((PyCodeObject*)co, file_path);
909
910 Py_RETURN_NONE;
911}
912
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000913
Christian Heimes3b06e532008-01-07 20:12:44 +0000914/* Get source file -> unicode or None
915 * Returns the path to the py file if available, else the given path
916 */
917static PyObject *
Victor Stinnerc9abda02011-03-14 13:33:46 -0400918get_sourcefile(PyObject *filename)
Christian Heimes3b06e532008-01-07 20:12:44 +0000919{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000920 Py_ssize_t len;
Victor Stinnerc9abda02011-03-14 13:33:46 -0400921 PyObject *py;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000922 struct stat statbuf;
Victor Stinnerbd0850b2011-12-18 20:47:30 +0100923 int err;
Victor Stinner81c39a82012-06-16 03:22:05 +0200924 void *data;
925 unsigned int kind;
Christian Heimes3b06e532008-01-07 20:12:44 +0000926
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200927 len = PyUnicode_GET_LENGTH(filename);
Victor Stinnerc9abda02011-03-14 13:33:46 -0400928 if (len == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000929 Py_RETURN_NONE;
Christian Heimes3b06e532008-01-07 20:12:44 +0000930
Victor Stinnerc9abda02011-03-14 13:33:46 -0400931 /* don't match *.pyc or *.pyo? */
Victor Stinner81c39a82012-06-16 03:22:05 +0200932 data = PyUnicode_DATA(filename);
933 kind = PyUnicode_KIND(filename);
Victor Stinnerc9abda02011-03-14 13:33:46 -0400934 if (len < 5
Victor Stinner81c39a82012-06-16 03:22:05 +0200935 || PyUnicode_READ(kind, data, len-4) != '.'
936 || (PyUnicode_READ(kind, data, len-3) != 'p'
937 && PyUnicode_READ(kind, data, len-3) != 'P')
938 || (PyUnicode_READ(kind, data, len-2) != 'y'
939 && PyUnicode_READ(kind, data, len-2) != 'Y'))
Victor Stinnerc9abda02011-03-14 13:33:46 -0400940 goto unchanged;
Christian Heimes3b06e532008-01-07 20:12:44 +0000941
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000942 /* Start by trying to turn PEP 3147 path into source path. If that
943 * fails, just chop off the trailing character, i.e. legacy pyc path
944 * to py.
945 */
Victor Stinnerc9abda02011-03-14 13:33:46 -0400946 py = make_source_pathname(filename);
947 if (py == NULL) {
948 PyErr_Clear();
Victor Stinner81c39a82012-06-16 03:22:05 +0200949 py = PyUnicode_Substring(filename, 0, len - 1);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000950 }
Victor Stinnerc9abda02011-03-14 13:33:46 -0400951 if (py == NULL)
952 goto error;
Barry Warsaw28a691b2010-04-17 00:19:56 +0000953
Victor Stinnerbd0850b2011-12-18 20:47:30 +0100954 err = _Py_stat(py, &statbuf);
955 if (err == -2)
956 goto error;
Victor Stinner81c39a82012-06-16 03:22:05 +0200957 if (err == 0 && S_ISREG(statbuf.st_mode))
Victor Stinnerc9abda02011-03-14 13:33:46 -0400958 return py;
959 Py_DECREF(py);
960 goto unchanged;
961
962error:
963 PyErr_Clear();
964unchanged:
965 Py_INCREF(filename);
966 return filename;
Christian Heimes3b06e532008-01-07 20:12:44 +0000967}
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000968
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000969/* Forward */
Victor Stinner53dc7352011-03-20 01:50:21 +0100970static struct _frozen * find_frozen(PyObject *);
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000971
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000972
973/* Helper to test for built-in module */
974
975static int
Victor Stinner95872862011-03-07 18:20:56 +0100976is_builtin(PyObject *name)
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000977{
Victor Stinner95872862011-03-07 18:20:56 +0100978 int i, cmp;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000979 for (i = 0; PyImport_Inittab[i].name != NULL; i++) {
Victor Stinner95872862011-03-07 18:20:56 +0100980 cmp = PyUnicode_CompareWithASCIIString(name, PyImport_Inittab[i].name);
981 if (cmp == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000982 if (PyImport_Inittab[i].initfunc == NULL)
983 return -1;
984 else
985 return 1;
986 }
987 }
988 return 0;
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000989}
990
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000991
Just van Rossum52e14d62002-12-30 22:08:05 +0000992/* Return an importer object for a sys.path/pkg.__path__ item 'p',
993 possibly by fetching it from the path_importer_cache dict. If it
Thomas Wouters89f507f2006-12-13 04:49:30 +0000994 wasn't yet cached, traverse path_hooks until a hook is found
Just van Rossum52e14d62002-12-30 22:08:05 +0000995 that can handle the path item. Return None if no hook could;
996 this tells our caller it should fall back to the builtin
997 import mechanism. Cache the result in path_importer_cache.
998 Returns a borrowed reference. */
999
1000static PyObject *
1001get_path_importer(PyObject *path_importer_cache, PyObject *path_hooks,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001002 PyObject *p)
Just van Rossum52e14d62002-12-30 22:08:05 +00001003{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001004 PyObject *importer;
1005 Py_ssize_t j, nhooks;
Just van Rossum52e14d62002-12-30 22:08:05 +00001006
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001007 /* These conditions are the caller's responsibility: */
1008 assert(PyList_Check(path_hooks));
1009 assert(PyDict_Check(path_importer_cache));
Just van Rossum52e14d62002-12-30 22:08:05 +00001010
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001011 nhooks = PyList_Size(path_hooks);
1012 if (nhooks < 0)
1013 return NULL; /* Shouldn't happen */
Just van Rossum52e14d62002-12-30 22:08:05 +00001014
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001015 importer = PyDict_GetItem(path_importer_cache, p);
1016 if (importer != NULL)
1017 return importer;
Just van Rossum52e14d62002-12-30 22:08:05 +00001018
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001019 /* set path_importer_cache[p] to None to avoid recursion */
1020 if (PyDict_SetItem(path_importer_cache, p, Py_None) != 0)
1021 return NULL;
Just van Rossum52e14d62002-12-30 22:08:05 +00001022
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001023 for (j = 0; j < nhooks; j++) {
1024 PyObject *hook = PyList_GetItem(path_hooks, j);
1025 if (hook == NULL)
1026 return NULL;
1027 importer = PyObject_CallFunctionObjArgs(hook, p, NULL);
1028 if (importer != NULL)
1029 break;
Just van Rossum52e14d62002-12-30 22:08:05 +00001030
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001031 if (!PyErr_ExceptionMatches(PyExc_ImportError)) {
1032 return NULL;
1033 }
1034 PyErr_Clear();
1035 }
1036 if (importer == NULL) {
Brett Cannonaa936422012-04-27 15:30:58 -04001037 return Py_None;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001038 }
1039 if (importer != NULL) {
1040 int err = PyDict_SetItem(path_importer_cache, p, importer);
1041 Py_DECREF(importer);
1042 if (err != 0)
1043 return NULL;
1044 }
1045 return importer;
Just van Rossum52e14d62002-12-30 22:08:05 +00001046}
1047
Christian Heimes9cd17752007-11-18 19:35:23 +00001048PyAPI_FUNC(PyObject *)
1049PyImport_GetImporter(PyObject *path) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001050 PyObject *importer=NULL, *path_importer_cache=NULL, *path_hooks=NULL;
Christian Heimes9cd17752007-11-18 19:35:23 +00001051
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001052 if ((path_importer_cache = PySys_GetObject("path_importer_cache"))) {
1053 if ((path_hooks = PySys_GetObject("path_hooks"))) {
1054 importer = get_path_importer(path_importer_cache,
1055 path_hooks, path);
1056 }
1057 }
1058 Py_XINCREF(importer); /* get_path_importer returns a borrowed reference */
1059 return importer;
Christian Heimes9cd17752007-11-18 19:35:23 +00001060}
1061
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001062
Victor Stinner95872862011-03-07 18:20:56 +01001063static int init_builtin(PyObject *); /* Forward */
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001064
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001065/* Initialize a built-in module.
Thomas Wouters89f507f2006-12-13 04:49:30 +00001066 Return 1 for success, 0 if the module is not found, and -1 with
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001067 an exception set if the initialization failed. */
Guido van Rossum7f133ed1991-02-19 12:23:57 +00001068
Guido van Rossum7f133ed1991-02-19 12:23:57 +00001069static int
Victor Stinner95872862011-03-07 18:20:56 +01001070init_builtin(PyObject *name)
Guido van Rossum7f133ed1991-02-19 12:23:57 +00001071{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001072 struct _inittab *p;
Guido van Rossum25ce5661997-08-02 03:10:38 +00001073
Victor Stinner95872862011-03-07 18:20:56 +01001074 if (_PyImport_FindExtensionObject(name, name) != NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001075 return 1;
Guido van Rossum25ce5661997-08-02 03:10:38 +00001076
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001077 for (p = PyImport_Inittab; p->name != NULL; p++) {
1078 PyObject *mod;
Antoine Pitrou6c40eb72012-01-18 20:16:09 +01001079 PyModuleDef *def;
Victor Stinner95872862011-03-07 18:20:56 +01001080 if (PyUnicode_CompareWithASCIIString(name, p->name) == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001081 if (p->initfunc == NULL) {
1082 PyErr_Format(PyExc_ImportError,
Victor Stinner95872862011-03-07 18:20:56 +01001083 "Cannot re-init internal module %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001084 name);
1085 return -1;
1086 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001087 mod = (*p->initfunc)();
1088 if (mod == 0)
1089 return -1;
Antoine Pitrou6c40eb72012-01-18 20:16:09 +01001090 /* Remember pointer to module init function. */
1091 def = PyModule_GetDef(mod);
1092 def->m_base.m_init = p->initfunc;
Victor Stinner95872862011-03-07 18:20:56 +01001093 if (_PyImport_FixupExtensionObject(mod, name, name) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001094 return -1;
1095 /* FixupExtension has put the module into sys.modules,
1096 so we can release our own reference. */
1097 Py_DECREF(mod);
1098 return 1;
1099 }
1100 }
1101 return 0;
Guido van Rossum7f133ed1991-02-19 12:23:57 +00001102}
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001103
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001104
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001105/* Frozen modules */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001106
Guido van Rossumcfd0a221996-06-17 17:06:34 +00001107static struct _frozen *
Victor Stinner53dc7352011-03-20 01:50:21 +01001108find_frozen(PyObject *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001109{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001110 struct _frozen *p;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001111
Victor Stinner53dc7352011-03-20 01:50:21 +01001112 if (name == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001113 return NULL;
Benjamin Petersond968e272008-11-05 22:48:33 +00001114
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001115 for (p = PyImport_FrozenModules; ; p++) {
1116 if (p->name == NULL)
1117 return NULL;
Victor Stinner53dc7352011-03-20 01:50:21 +01001118 if (PyUnicode_CompareWithASCIIString(name, p->name) == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001119 break;
1120 }
1121 return p;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001122}
1123
Guido van Rossum79f25d91997-04-29 20:08:16 +00001124static PyObject *
Victor Stinner53dc7352011-03-20 01:50:21 +01001125get_frozen_object(PyObject *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001126{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001127 struct _frozen *p = find_frozen(name);
1128 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001129
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001130 if (p == NULL) {
1131 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01001132 "No such frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001133 name);
1134 return NULL;
1135 }
1136 if (p->code == NULL) {
1137 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01001138 "Excluded frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001139 name);
1140 return NULL;
1141 }
1142 size = p->size;
1143 if (size < 0)
1144 size = -size;
1145 return PyMarshal_ReadObjectFromString((char *)p->code, size);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001146}
1147
Brett Cannon8d110132009-03-15 02:20:16 +00001148static PyObject *
Victor Stinner53dc7352011-03-20 01:50:21 +01001149is_frozen_package(PyObject *name)
Brett Cannon8d110132009-03-15 02:20:16 +00001150{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001151 struct _frozen *p = find_frozen(name);
1152 int size;
Brett Cannon8d110132009-03-15 02:20:16 +00001153
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001154 if (p == NULL) {
1155 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01001156 "No such frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001157 name);
1158 return NULL;
1159 }
Brett Cannon8d110132009-03-15 02:20:16 +00001160
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001161 size = p->size;
Brett Cannon8d110132009-03-15 02:20:16 +00001162
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001163 if (size < 0)
1164 Py_RETURN_TRUE;
1165 else
1166 Py_RETURN_FALSE;
Brett Cannon8d110132009-03-15 02:20:16 +00001167}
1168
1169
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001170/* Initialize a frozen module.
Brett Cannon3c2ac442009-03-08 20:49:47 +00001171 Return 1 for success, 0 if the module is not found, and -1 with
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001172 an exception set if the initialization failed.
1173 This function is also used from frozenmain.c */
Guido van Rossum0b344901995-02-07 15:35:27 +00001174
1175int
Victor Stinner53dc7352011-03-20 01:50:21 +01001176PyImport_ImportFrozenModuleObject(PyObject *name)
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001177{
Victor Stinner53dc7352011-03-20 01:50:21 +01001178 struct _frozen *p;
1179 PyObject *co, *m, *path;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001180 int ispackage;
1181 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001182
Victor Stinner53dc7352011-03-20 01:50:21 +01001183 p = find_frozen(name);
1184
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001185 if (p == NULL)
1186 return 0;
1187 if (p->code == NULL) {
1188 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01001189 "Excluded frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001190 name);
1191 return -1;
1192 }
1193 size = p->size;
1194 ispackage = (size < 0);
1195 if (ispackage)
1196 size = -size;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001197 co = PyMarshal_ReadObjectFromString((char *)p->code, size);
1198 if (co == NULL)
1199 return -1;
1200 if (!PyCode_Check(co)) {
1201 PyErr_Format(PyExc_TypeError,
Victor Stinner53dc7352011-03-20 01:50:21 +01001202 "frozen object %R is not a code object",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001203 name);
1204 goto err_return;
1205 }
1206 if (ispackage) {
1207 /* Set __path__ to the package name */
Victor Stinner53dc7352011-03-20 01:50:21 +01001208 PyObject *d, *l;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001209 int err;
Victor Stinner53dc7352011-03-20 01:50:21 +01001210 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001211 if (m == NULL)
1212 goto err_return;
1213 d = PyModule_GetDict(m);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001214 l = PyList_New(1);
1215 if (l == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001216 goto err_return;
1217 }
Victor Stinner53dc7352011-03-20 01:50:21 +01001218 Py_INCREF(name);
1219 PyList_SET_ITEM(l, 0, name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001220 err = PyDict_SetItemString(d, "__path__", l);
1221 Py_DECREF(l);
1222 if (err != 0)
1223 goto err_return;
1224 }
Victor Stinner53dc7352011-03-20 01:50:21 +01001225 path = PyUnicode_FromString("<frozen>");
1226 if (path == NULL)
1227 goto err_return;
1228 m = PyImport_ExecCodeModuleObject(name, co, path, NULL);
1229 Py_DECREF(path);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001230 if (m == NULL)
1231 goto err_return;
1232 Py_DECREF(co);
1233 Py_DECREF(m);
1234 return 1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001235err_return:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001236 Py_DECREF(co);
1237 return -1;
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001238}
Guido van Rossum74e6a111994-08-29 12:54:38 +00001239
Victor Stinner53dc7352011-03-20 01:50:21 +01001240int
1241PyImport_ImportFrozenModule(char *name)
1242{
1243 PyObject *nameobj;
1244 int ret;
1245 nameobj = PyUnicode_InternFromString(name);
1246 if (nameobj == NULL)
1247 return -1;
1248 ret = PyImport_ImportFrozenModuleObject(nameobj);
1249 Py_DECREF(nameobj);
1250 return ret;
1251}
1252
Guido van Rossum74e6a111994-08-29 12:54:38 +00001253
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001254/* Import a module, either built-in, frozen, or external, and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001255 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum74e6a111994-08-29 12:54:38 +00001256
Guido van Rossum79f25d91997-04-29 20:08:16 +00001257PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001258PyImport_ImportModule(const char *name)
Guido van Rossum74e6a111994-08-29 12:54:38 +00001259{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001260 PyObject *pname;
1261 PyObject *result;
Marc-André Lemburg3c61c352001-02-09 19:40:15 +00001262
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001263 pname = PyUnicode_FromString(name);
1264 if (pname == NULL)
1265 return NULL;
1266 result = PyImport_Import(pname);
1267 Py_DECREF(pname);
1268 return result;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001269}
1270
Christian Heimes072c0f12008-01-03 23:01:04 +00001271/* Import a module without blocking
1272 *
1273 * At first it tries to fetch the module from sys.modules. If the module was
1274 * never loaded before it loads it with PyImport_ImportModule() unless another
1275 * thread holds the import lock. In the latter case the function raises an
1276 * ImportError instead of blocking.
1277 *
1278 * Returns the module object with incremented ref count.
1279 */
1280PyObject *
1281PyImport_ImportModuleNoBlock(const char *name)
1282{
Antoine Pitrouea3eb882012-05-17 18:55:59 +02001283 return PyImport_ImportModule(name);
Christian Heimes072c0f12008-01-03 23:01:04 +00001284}
1285
Guido van Rossum17fc85f1997-09-06 18:52:03 +00001286
Antoine Pitroubc07a5c2012-07-08 12:01:27 +02001287/* Remove importlib frames from the traceback,
1288 * except in Verbose mode. */
1289static void
1290remove_importlib_frames(void)
1291{
1292 const char *importlib_filename = "<frozen importlib._bootstrap>";
1293 const char *exec_funcname = "_exec_module";
1294 int always_trim = 0;
Benjamin Petersonfa873702012-07-09 13:43:53 -07001295 int in_importlib = 0;
Antoine Pitroubc07a5c2012-07-08 12:01:27 +02001296 PyObject *exception, *value, *base_tb, *tb;
Benjamin Petersonfa873702012-07-09 13:43:53 -07001297 PyObject **prev_link, **outer_link = NULL;
Antoine Pitroubc07a5c2012-07-08 12:01:27 +02001298
1299 /* Synopsis: if it's an ImportError, we trim all importlib chunks
1300 from the traceback. Otherwise, we trim only those chunks which
1301 end with a call to "_exec_module". */
1302
1303 PyErr_Fetch(&exception, &value, &base_tb);
1304 if (!exception || Py_VerboseFlag)
1305 goto done;
1306 if (PyType_IsSubtype((PyTypeObject *) exception,
1307 (PyTypeObject *) PyExc_ImportError))
1308 always_trim = 1;
1309
1310 prev_link = &base_tb;
1311 tb = base_tb;
Antoine Pitroubc07a5c2012-07-08 12:01:27 +02001312 while (tb != NULL) {
1313 PyTracebackObject *traceback = (PyTracebackObject *)tb;
1314 PyObject *next = (PyObject *) traceback->tb_next;
1315 PyFrameObject *frame = traceback->tb_frame;
1316 PyCodeObject *code = frame->f_code;
1317 int now_in_importlib;
1318
1319 assert(PyTraceBack_Check(tb));
1320 now_in_importlib = (PyUnicode_CompareWithASCIIString(
1321 code->co_filename,
1322 importlib_filename) == 0);
1323 if (now_in_importlib && !in_importlib) {
1324 /* This is the link to this chunk of importlib tracebacks */
1325 outer_link = prev_link;
1326 }
1327 in_importlib = now_in_importlib;
1328
1329 if (in_importlib &&
1330 (always_trim ||
1331 PyUnicode_CompareWithASCIIString(code->co_name,
1332 exec_funcname) == 0)) {
1333 PyObject *tmp = *outer_link;
1334 *outer_link = next;
1335 Py_XINCREF(next);
1336 Py_DECREF(tmp);
1337 prev_link = outer_link;
1338 }
1339 else {
1340 prev_link = (PyObject **) &traceback->tb_next;
1341 }
1342 tb = next;
1343 }
1344done:
1345 PyErr_Restore(exception, value, base_tb);
1346}
1347
1348
Thomas Woutersf7f438b2006-02-28 16:09:29 +00001349PyObject *
Brett Cannonfd074152012-04-14 14:10:13 -04001350PyImport_ImportModuleLevelObject(PyObject *name, PyObject *given_globals,
1351 PyObject *locals, PyObject *given_fromlist,
Victor Stinnerfe93faf2011-03-14 15:54:52 -04001352 int level)
Thomas Woutersf7f438b2006-02-28 16:09:29 +00001353{
Brett Cannonfd074152012-04-14 14:10:13 -04001354 _Py_IDENTIFIER(__import__);
Antoine Pitrouea3eb882012-05-17 18:55:59 +02001355 _Py_IDENTIFIER(__initializing__);
Brett Cannonfd074152012-04-14 14:10:13 -04001356 _Py_IDENTIFIER(__package__);
1357 _Py_IDENTIFIER(__path__);
1358 _Py_IDENTIFIER(__name__);
1359 _Py_IDENTIFIER(_find_and_load);
1360 _Py_IDENTIFIER(_handle_fromlist);
Antoine Pitrouea3eb882012-05-17 18:55:59 +02001361 _Py_IDENTIFIER(_lock_unlock_module);
Brett Cannonfd074152012-04-14 14:10:13 -04001362 _Py_static_string(single_dot, ".");
1363 PyObject *abs_name = NULL;
1364 PyObject *builtins_import = NULL;
1365 PyObject *final_mod = NULL;
1366 PyObject *mod = NULL;
1367 PyObject *package = NULL;
1368 PyObject *globals = NULL;
1369 PyObject *fromlist = NULL;
1370 PyInterpreterState *interp = PyThreadState_GET()->interp;
1371
1372 /* Make sure to use default values so as to not have
1373 PyObject_CallMethodObjArgs() truncate the parameter list because of a
1374 NULL argument. */
1375 if (given_globals == NULL) {
1376 globals = PyDict_New();
1377 if (globals == NULL) {
1378 goto error;
1379 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001380 }
Brett Cannonfd074152012-04-14 14:10:13 -04001381 else {
1382 /* Only have to care what given_globals is if it will be used
1383 fortsomething. */
1384 if (level > 0 && !PyDict_Check(given_globals)) {
1385 PyErr_SetString(PyExc_TypeError, "globals must be a dict");
1386 goto error;
1387 }
1388 globals = given_globals;
1389 Py_INCREF(globals);
1390 }
1391
1392 if (given_fromlist == NULL) {
1393 fromlist = PyList_New(0);
1394 if (fromlist == NULL) {
1395 goto error;
1396 }
1397 }
1398 else {
1399 fromlist = given_fromlist;
1400 Py_INCREF(fromlist);
1401 }
1402 if (name == NULL) {
1403 PyErr_SetString(PyExc_ValueError, "Empty module name");
1404 goto error;
1405 }
1406
1407 /* The below code is importlib.__import__() & _gcd_import(), ported to C
1408 for added performance. */
1409
1410 if (!PyUnicode_Check(name)) {
1411 PyErr_SetString(PyExc_TypeError, "module name must be a string");
1412 goto error;
1413 }
1414 else if (PyUnicode_READY(name) < 0) {
1415 goto error;
1416 }
1417 if (level < 0) {
1418 PyErr_SetString(PyExc_ValueError, "level must be >= 0");
1419 goto error;
1420 }
1421 else if (level > 0) {
1422 package = _PyDict_GetItemId(globals, &PyId___package__);
1423 if (package != NULL && package != Py_None) {
1424 Py_INCREF(package);
1425 if (!PyUnicode_Check(package)) {
1426 PyErr_SetString(PyExc_TypeError, "package must be a string");
1427 goto error;
1428 }
1429 }
1430 else {
Brett Cannon273323c2012-04-17 19:05:11 -04001431 package = _PyDict_GetItemId(globals, &PyId___name__);
Brett Cannonfd074152012-04-14 14:10:13 -04001432 if (package == NULL) {
Brett Cannon273323c2012-04-17 19:05:11 -04001433 PyErr_SetString(PyExc_KeyError, "'__name__' not in globals");
Brett Cannonfd074152012-04-14 14:10:13 -04001434 goto error;
1435 }
1436 else if (!PyUnicode_Check(package)) {
1437 PyErr_SetString(PyExc_TypeError, "__name__ must be a string");
1438 }
1439 Py_INCREF(package);
1440
1441 if (_PyDict_GetItemId(globals, &PyId___path__) == NULL) {
Brett Cannon740fce02012-04-14 14:23:49 -04001442 PyObject *partition = NULL;
Brett Cannonfd074152012-04-14 14:10:13 -04001443 PyObject *borrowed_dot = _PyUnicode_FromId(&single_dot);
1444 if (borrowed_dot == NULL) {
1445 goto error;
1446 }
Brett Cannon740fce02012-04-14 14:23:49 -04001447 partition = PyUnicode_RPartition(package, borrowed_dot);
Brett Cannonfd074152012-04-14 14:10:13 -04001448 Py_DECREF(package);
1449 if (partition == NULL) {
1450 goto error;
1451 }
1452 package = PyTuple_GET_ITEM(partition, 0);
1453 Py_INCREF(package);
1454 Py_DECREF(partition);
1455 }
1456 }
1457
1458 if (PyDict_GetItem(interp->modules, package) == NULL) {
1459 PyErr_Format(PyExc_SystemError,
1460 "Parent module %R not loaded, cannot perform relative "
1461 "import", package);
1462 goto error;
1463 }
1464 }
1465 else { /* level == 0 */
1466 if (PyUnicode_GET_LENGTH(name) == 0) {
1467 PyErr_SetString(PyExc_ValueError, "Empty module name");
1468 goto error;
1469 }
1470 package = Py_None;
1471 Py_INCREF(package);
1472 }
1473
1474 if (level > 0) {
1475 Py_ssize_t last_dot = PyUnicode_GET_LENGTH(package);
1476 PyObject *base = NULL;
1477 int level_up = 1;
1478
1479 for (level_up = 1; level_up < level; level_up += 1) {
1480 last_dot = PyUnicode_FindChar(package, '.', 0, last_dot, -1);
1481 if (last_dot == -2) {
1482 goto error;
1483 }
1484 else if (last_dot == -1) {
1485 PyErr_SetString(PyExc_ValueError,
1486 "attempted relative import beyond top-level "
1487 "package");
1488 goto error;
1489 }
1490 }
1491 base = PyUnicode_Substring(package, 0, last_dot);
1492 if (PyUnicode_GET_LENGTH(name) > 0) {
Antoine Pitrou538ba2a2012-04-16 21:52:45 +02001493 PyObject *borrowed_dot, *seq = NULL;
Brett Cannonfd074152012-04-14 14:10:13 -04001494
1495 borrowed_dot = _PyUnicode_FromId(&single_dot);
Antoine Pitrou538ba2a2012-04-16 21:52:45 +02001496 seq = PyTuple_Pack(2, base, name);
1497 Py_DECREF(base);
Brett Cannonfd074152012-04-14 14:10:13 -04001498 if (borrowed_dot == NULL || seq == NULL) {
1499 goto error;
1500 }
1501
1502 abs_name = PyUnicode_Join(borrowed_dot, seq);
1503 Py_DECREF(seq);
1504 if (abs_name == NULL) {
1505 goto error;
1506 }
1507 }
1508 else {
1509 abs_name = base;
1510 }
1511 }
1512 else {
1513 abs_name = name;
1514 Py_INCREF(abs_name);
1515 }
1516
Brian Curtine6b299f2012-04-14 14:19:33 -05001517#ifdef WITH_THREAD
Brett Cannonfd074152012-04-14 14:10:13 -04001518 _PyImport_AcquireLock();
1519#endif
1520 /* From this point forward, goto error_with_unlock! */
1521 if (PyDict_Check(globals)) {
1522 builtins_import = _PyDict_GetItemId(globals, &PyId___import__);
1523 }
1524 if (builtins_import == NULL) {
1525 builtins_import = _PyDict_GetItemId(interp->builtins, &PyId___import__);
1526 if (builtins_import == NULL) {
1527 Py_FatalError("__import__ missing");
1528 }
1529 }
1530 Py_INCREF(builtins_import);
1531
1532 mod = PyDict_GetItem(interp->modules, abs_name);
1533 if (mod == Py_None) {
Brett Cannon27fc5282012-04-15 14:15:31 -04001534 PyObject *msg = PyUnicode_FromFormat("import of %R halted; "
1535 "None in sys.modules", abs_name);
1536 if (msg != NULL) {
Brian Curtin09b86d12012-04-17 16:57:09 -05001537 PyErr_SetImportError(msg, abs_name, NULL);
1538 Py_DECREF(msg);
Brett Cannon27fc5282012-04-15 14:15:31 -04001539 }
Antoine Pitrou71382cb2012-04-16 18:48:49 +02001540 mod = NULL;
Brett Cannonfd074152012-04-14 14:10:13 -04001541 goto error_with_unlock;
1542 }
1543 else if (mod != NULL) {
Antoine Pitrouea3eb882012-05-17 18:55:59 +02001544 PyObject *value;
1545 int initializing = 0;
1546
Brett Cannonfd074152012-04-14 14:10:13 -04001547 Py_INCREF(mod);
Antoine Pitrouea3eb882012-05-17 18:55:59 +02001548 /* Only call _bootstrap._lock_unlock_module() if __initializing__ is true. */
1549 value = _PyObject_GetAttrId(mod, &PyId___initializing__);
1550 if (value == NULL)
1551 PyErr_Clear();
1552 else {
1553 initializing = PyObject_IsTrue(value);
1554 Py_DECREF(value);
1555 if (initializing == -1)
1556 PyErr_Clear();
1557 }
1558 if (initializing > 0) {
1559 /* _bootstrap._lock_unlock_module() releases the import lock */
1560 value = _PyObject_CallMethodObjIdArgs(interp->importlib,
1561 &PyId__lock_unlock_module, abs_name,
1562 NULL);
1563 if (value == NULL)
1564 goto error;
1565 Py_DECREF(value);
1566 }
1567 else {
1568#ifdef WITH_THREAD
1569 if (_PyImport_ReleaseLock() < 0) {
1570 PyErr_SetString(PyExc_RuntimeError, "not holding the import lock");
1571 goto error;
1572 }
1573#endif
1574 }
Brett Cannonfd074152012-04-14 14:10:13 -04001575 }
1576 else {
Antoine Pitrouea3eb882012-05-17 18:55:59 +02001577 /* _bootstrap._find_and_load() releases the import lock */
Brett Cannonfd074152012-04-14 14:10:13 -04001578 mod = _PyObject_CallMethodObjIdArgs(interp->importlib,
1579 &PyId__find_and_load, abs_name,
1580 builtins_import, NULL);
1581 if (mod == NULL) {
Antoine Pitrouea3eb882012-05-17 18:55:59 +02001582 goto error;
Brett Cannonfd074152012-04-14 14:10:13 -04001583 }
1584 }
Antoine Pitrouea3eb882012-05-17 18:55:59 +02001585 /* From now on we don't hold the import lock anymore. */
Brett Cannonfd074152012-04-14 14:10:13 -04001586
1587 if (PyObject_Not(fromlist)) {
1588 if (level == 0 || PyUnicode_GET_LENGTH(name) > 0) {
1589 PyObject *front = NULL;
Brian Curtine6b299f2012-04-14 14:19:33 -05001590 PyObject *partition = NULL;
Brett Cannonfd074152012-04-14 14:10:13 -04001591 PyObject *borrowed_dot = _PyUnicode_FromId(&single_dot);
1592
1593 if (borrowed_dot == NULL) {
Antoine Pitrouea3eb882012-05-17 18:55:59 +02001594 goto error;
Brett Cannonfd074152012-04-14 14:10:13 -04001595 }
1596
Brian Curtine6b299f2012-04-14 14:19:33 -05001597 partition = PyUnicode_Partition(name, borrowed_dot);
Brett Cannonfd074152012-04-14 14:10:13 -04001598 if (partition == NULL) {
Antoine Pitrouea3eb882012-05-17 18:55:59 +02001599 goto error;
Brett Cannonfd074152012-04-14 14:10:13 -04001600 }
1601
Antoine Pitrou6efa50a2012-05-07 21:41:59 +02001602 if (PyUnicode_GET_LENGTH(PyTuple_GET_ITEM(partition, 1)) == 0) {
1603 /* No dot in module name, simple exit */
1604 Py_DECREF(partition);
1605 final_mod = mod;
1606 Py_INCREF(mod);
Antoine Pitrouea3eb882012-05-17 18:55:59 +02001607 goto error;
Antoine Pitrou6efa50a2012-05-07 21:41:59 +02001608 }
1609
Brett Cannonfd074152012-04-14 14:10:13 -04001610 front = PyTuple_GET_ITEM(partition, 0);
1611 Py_INCREF(front);
1612 Py_DECREF(partition);
1613
1614 if (level == 0) {
Antoine Pitrou6efa50a2012-05-07 21:41:59 +02001615 final_mod = PyObject_CallFunctionObjArgs(builtins_import, front, NULL);
Antoine Pitroub78174c2012-05-06 17:15:23 +02001616 Py_DECREF(front);
Brett Cannonfd074152012-04-14 14:10:13 -04001617 }
1618 else {
Antoine Pitrou22a1d172012-04-16 22:06:21 +02001619 Py_ssize_t cut_off = PyUnicode_GET_LENGTH(name) -
1620 PyUnicode_GET_LENGTH(front);
1621 Py_ssize_t abs_name_len = PyUnicode_GET_LENGTH(abs_name);
Brett Cannon49f8d8b2012-04-14 21:50:00 -04001622 PyObject *to_return = PyUnicode_Substring(abs_name, 0,
Brett Cannonfd074152012-04-14 14:10:13 -04001623 abs_name_len - cut_off);
Antoine Pitrou22a1d172012-04-16 22:06:21 +02001624 Py_DECREF(front);
1625 if (to_return == NULL) {
Antoine Pitrouea3eb882012-05-17 18:55:59 +02001626 goto error;
Antoine Pitrou22a1d172012-04-16 22:06:21 +02001627 }
Brett Cannonfd074152012-04-14 14:10:13 -04001628
1629 final_mod = PyDict_GetItem(interp->modules, to_return);
Brett Cannon49f8d8b2012-04-14 21:50:00 -04001630 if (final_mod == NULL) {
1631 PyErr_Format(PyExc_KeyError,
1632 "%R not in sys.modules as expected",
1633 to_return);
1634 }
1635 else {
1636 Py_INCREF(final_mod);
1637 }
Antoine Pitroub78174c2012-05-06 17:15:23 +02001638 Py_DECREF(to_return);
Brett Cannonfd074152012-04-14 14:10:13 -04001639 }
1640 }
1641 else {
1642 final_mod = mod;
1643 Py_INCREF(mod);
1644 }
1645 }
1646 else {
1647 final_mod = _PyObject_CallMethodObjIdArgs(interp->importlib,
1648 &PyId__handle_fromlist, mod,
1649 fromlist, builtins_import,
1650 NULL);
1651 }
Antoine Pitrouea3eb882012-05-17 18:55:59 +02001652 goto error;
Antoine Pitrou6efa50a2012-05-07 21:41:59 +02001653
Brett Cannonfd074152012-04-14 14:10:13 -04001654 error_with_unlock:
Brian Curtine6b299f2012-04-14 14:19:33 -05001655#ifdef WITH_THREAD
Brett Cannonfd074152012-04-14 14:10:13 -04001656 if (_PyImport_ReleaseLock() < 0) {
1657 PyErr_SetString(PyExc_RuntimeError, "not holding the import lock");
1658 }
1659#endif
1660 error:
1661 Py_XDECREF(abs_name);
1662 Py_XDECREF(builtins_import);
1663 Py_XDECREF(mod);
1664 Py_XDECREF(package);
1665 Py_XDECREF(globals);
1666 Py_XDECREF(fromlist);
Antoine Pitroubc07a5c2012-07-08 12:01:27 +02001667 if (final_mod == NULL)
1668 remove_importlib_frames();
Brett Cannonfd074152012-04-14 14:10:13 -04001669 return final_mod;
Guido van Rossum75acc9c1998-03-03 22:26:50 +00001670}
1671
Victor Stinnerfe93faf2011-03-14 15:54:52 -04001672PyObject *
Benjamin Peterson04778a82011-05-25 09:29:00 -05001673PyImport_ImportModuleLevel(const char *name, PyObject *globals, PyObject *locals,
Victor Stinnerfe93faf2011-03-14 15:54:52 -04001674 PyObject *fromlist, int level)
1675{
1676 PyObject *nameobj, *mod;
1677 nameobj = PyUnicode_FromString(name);
1678 if (nameobj == NULL)
1679 return NULL;
1680 mod = PyImport_ImportModuleLevelObject(nameobj, globals, locals,
1681 fromlist, level);
1682 Py_DECREF(nameobj);
1683 return mod;
1684}
1685
1686
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001687/* Re-import a module of any kind and return its module object, WITH
1688 INCREMENTED REFERENCE COUNT */
1689
Guido van Rossum79f25d91997-04-29 20:08:16 +00001690PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001691PyImport_ReloadModule(PyObject *m)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001692{
Brett Cannon62228db2012-04-29 14:38:11 -04001693 _Py_IDENTIFIER(reload);
1694 PyObject *reloaded_module = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001695 PyObject *modules = PyImport_GetModuleDict();
Brett Cannon62228db2012-04-29 14:38:11 -04001696 PyObject *imp = PyDict_GetItemString(modules, "imp");
1697 if (imp == NULL) {
1698 imp = PyImport_ImportModule("imp");
1699 if (imp == NULL) {
1700 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001701 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001702 }
Brett Cannon62228db2012-04-29 14:38:11 -04001703 else {
1704 Py_INCREF(imp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001705 }
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001706
Brett Cannon62228db2012-04-29 14:38:11 -04001707 reloaded_module = _PyObject_CallMethodId(imp, &PyId_reload, "O", m);
1708 Py_DECREF(imp);
1709 return reloaded_module;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001710}
1711
1712
Guido van Rossumd47a0a81997-08-14 20:11:26 +00001713/* Higher-level import emulator which emulates the "import" statement
1714 more accurately -- it invokes the __import__() function from the
1715 builtins of the current globals. This means that the import is
1716 done using whatever import hooks are installed in the current
Brett Cannonbc2eff32010-09-19 21:39:02 +00001717 environment.
Guido van Rossum6058eb41998-12-21 19:51:00 +00001718 A dummy list ["__doc__"] is passed as the 4th argument so that
Neal Norwitz80e7f272007-08-26 06:45:23 +00001719 e.g. PyImport_Import(PyUnicode_FromString("win32com.client.gencache"))
Guido van Rossum6058eb41998-12-21 19:51:00 +00001720 will return <module "gencache"> instead of <module "win32com">. */
Guido van Rossumd47a0a81997-08-14 20:11:26 +00001721
1722PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001723PyImport_Import(PyObject *module_name)
Guido van Rossumd47a0a81997-08-14 20:11:26 +00001724{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001725 static PyObject *silly_list = NULL;
1726 static PyObject *builtins_str = NULL;
1727 static PyObject *import_str = NULL;
1728 PyObject *globals = NULL;
1729 PyObject *import = NULL;
1730 PyObject *builtins = NULL;
Brett Cannonbc2eff32010-09-19 21:39:02 +00001731 PyObject *modules = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001732 PyObject *r = NULL;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00001733
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001734 /* Initialize constant string objects */
1735 if (silly_list == NULL) {
1736 import_str = PyUnicode_InternFromString("__import__");
1737 if (import_str == NULL)
1738 return NULL;
1739 builtins_str = PyUnicode_InternFromString("__builtins__");
1740 if (builtins_str == NULL)
1741 return NULL;
Brett Cannonbc2eff32010-09-19 21:39:02 +00001742 silly_list = PyList_New(0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001743 if (silly_list == NULL)
1744 return NULL;
1745 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00001746
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001747 /* Get the builtins from current globals */
1748 globals = PyEval_GetGlobals();
1749 if (globals != NULL) {
1750 Py_INCREF(globals);
1751 builtins = PyObject_GetItem(globals, builtins_str);
1752 if (builtins == NULL)
1753 goto err;
1754 }
1755 else {
1756 /* No globals -- use standard builtins, and fake globals */
1757 builtins = PyImport_ImportModuleLevel("builtins",
1758 NULL, NULL, NULL, 0);
1759 if (builtins == NULL)
1760 return NULL;
1761 globals = Py_BuildValue("{OO}", builtins_str, builtins);
1762 if (globals == NULL)
1763 goto err;
1764 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00001765
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001766 /* Get the __import__ function from the builtins */
1767 if (PyDict_Check(builtins)) {
1768 import = PyObject_GetItem(builtins, import_str);
1769 if (import == NULL)
1770 PyErr_SetObject(PyExc_KeyError, import_str);
1771 }
1772 else
1773 import = PyObject_GetAttr(builtins, import_str);
1774 if (import == NULL)
1775 goto err;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00001776
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001777 /* Call the __import__ function with the proper argument list
Brett Cannonbc2eff32010-09-19 21:39:02 +00001778 Always use absolute import here.
1779 Calling for side-effect of import. */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001780 r = PyObject_CallFunction(import, "OOOOi", module_name, globals,
1781 globals, silly_list, 0, NULL);
Brett Cannonbc2eff32010-09-19 21:39:02 +00001782 if (r == NULL)
1783 goto err;
1784 Py_DECREF(r);
1785
1786 modules = PyImport_GetModuleDict();
1787 r = PyDict_GetItem(modules, module_name);
1788 if (r != NULL)
1789 Py_INCREF(r);
Guido van Rossumd47a0a81997-08-14 20:11:26 +00001790
1791 err:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001792 Py_XDECREF(globals);
1793 Py_XDECREF(builtins);
1794 Py_XDECREF(import);
Tim Peters50d8d372001-02-28 05:34:27 +00001795
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001796 return r;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00001797}
1798
Barry Warsaw28a691b2010-04-17 00:19:56 +00001799static PyObject *
Brett Cannon2657df42012-05-04 15:20:40 -04001800imp_extension_suffixes(PyObject *self, PyObject *noargs)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001801{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001802 PyObject *list;
Brett Cannon2657df42012-05-04 15:20:40 -04001803 const char *suffix;
1804 unsigned int index = 0;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001805
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001806 list = PyList_New(0);
1807 if (list == NULL)
1808 return NULL;
Brett Cannon2657df42012-05-04 15:20:40 -04001809#ifdef HAVE_DYNAMIC_LOADING
1810 while ((suffix = _PyImport_DynLoadFiletab[index])) {
1811 PyObject *item = PyUnicode_FromString(suffix);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001812 if (item == NULL) {
1813 Py_DECREF(list);
1814 return NULL;
1815 }
1816 if (PyList_Append(list, item) < 0) {
1817 Py_DECREF(list);
1818 Py_DECREF(item);
1819 return NULL;
1820 }
1821 Py_DECREF(item);
Brett Cannon2657df42012-05-04 15:20:40 -04001822 index += 1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001823 }
Brett Cannon2657df42012-05-04 15:20:40 -04001824#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001825 return list;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001826}
1827
Guido van Rossum79f25d91997-04-29 20:08:16 +00001828static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001829imp_init_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001830{
Victor Stinner95872862011-03-07 18:20:56 +01001831 PyObject *name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001832 int ret;
1833 PyObject *m;
Victor Stinner95872862011-03-07 18:20:56 +01001834 if (!PyArg_ParseTuple(args, "U:init_builtin", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001835 return NULL;
1836 ret = init_builtin(name);
1837 if (ret < 0)
1838 return NULL;
1839 if (ret == 0) {
1840 Py_INCREF(Py_None);
1841 return Py_None;
1842 }
Victor Stinner95872862011-03-07 18:20:56 +01001843 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001844 Py_XINCREF(m);
1845 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001846}
1847
Guido van Rossum79f25d91997-04-29 20:08:16 +00001848static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001849imp_init_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001850{
Victor Stinner53dc7352011-03-20 01:50:21 +01001851 PyObject *name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001852 int ret;
1853 PyObject *m;
Victor Stinner53dc7352011-03-20 01:50:21 +01001854 if (!PyArg_ParseTuple(args, "U:init_frozen", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001855 return NULL;
Victor Stinner53dc7352011-03-20 01:50:21 +01001856 ret = PyImport_ImportFrozenModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001857 if (ret < 0)
1858 return NULL;
1859 if (ret == 0) {
1860 Py_INCREF(Py_None);
1861 return Py_None;
1862 }
Victor Stinner53dc7352011-03-20 01:50:21 +01001863 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001864 Py_XINCREF(m);
1865 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001866}
1867
Guido van Rossum79f25d91997-04-29 20:08:16 +00001868static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001869imp_get_frozen_object(PyObject *self, PyObject *args)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001870{
Victor Stinner53dc7352011-03-20 01:50:21 +01001871 PyObject *name;
Jack Jansen95ffa231995-10-03 14:38:41 +00001872
Victor Stinner53dc7352011-03-20 01:50:21 +01001873 if (!PyArg_ParseTuple(args, "U:get_frozen_object", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001874 return NULL;
1875 return get_frozen_object(name);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001876}
1877
Guido van Rossum79f25d91997-04-29 20:08:16 +00001878static PyObject *
Brett Cannon8d110132009-03-15 02:20:16 +00001879imp_is_frozen_package(PyObject *self, PyObject *args)
1880{
Victor Stinner53dc7352011-03-20 01:50:21 +01001881 PyObject *name;
Brett Cannon8d110132009-03-15 02:20:16 +00001882
Victor Stinner53dc7352011-03-20 01:50:21 +01001883 if (!PyArg_ParseTuple(args, "U:is_frozen_package", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001884 return NULL;
1885 return is_frozen_package(name);
Brett Cannon8d110132009-03-15 02:20:16 +00001886}
1887
1888static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001889imp_is_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001890{
Victor Stinner95872862011-03-07 18:20:56 +01001891 PyObject *name;
1892 if (!PyArg_ParseTuple(args, "U:is_builtin", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001893 return NULL;
1894 return PyLong_FromLong(is_builtin(name));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001895}
1896
Guido van Rossum79f25d91997-04-29 20:08:16 +00001897static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001898imp_is_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001899{
Victor Stinner53dc7352011-03-20 01:50:21 +01001900 PyObject *name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001901 struct _frozen *p;
Victor Stinner53dc7352011-03-20 01:50:21 +01001902 if (!PyArg_ParseTuple(args, "U:is_frozen", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001903 return NULL;
1904 p = find_frozen(name);
1905 return PyBool_FromLong((long) (p == NULL ? 0 : p->size));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001906}
1907
Guido van Rossum96a8fb71999-12-22 14:09:35 +00001908#ifdef HAVE_DYNAMIC_LOADING
1909
Guido van Rossum79f25d91997-04-29 20:08:16 +00001910static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001911imp_load_dynamic(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001912{
Victor Stinnerfefd70c2011-03-14 15:54:07 -04001913 PyObject *name, *pathname, *fob = NULL, *mod;
1914 FILE *fp;
1915
1916 if (!PyArg_ParseTuple(args, "UO&|O:load_dynamic",
1917 &name, PyUnicode_FSDecoder, &pathname, &fob))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001918 return NULL;
Victor Stinnerfefd70c2011-03-14 15:54:07 -04001919 if (fob != NULL) {
Antoine Pitrouf3a42de2012-05-04 22:40:25 +02001920 fp = _Py_fopen(pathname, "r");
Victor Stinnere9ddbf62011-03-22 10:46:35 +01001921 if (fp == NULL) {
1922 Py_DECREF(pathname);
Antoine Pitrouf3a42de2012-05-04 22:40:25 +02001923 if (!PyErr_Occurred())
1924 PyErr_SetFromErrno(PyExc_IOError);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001925 return NULL;
Victor Stinnere9ddbf62011-03-22 10:46:35 +01001926 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001927 }
Victor Stinnerfefd70c2011-03-14 15:54:07 -04001928 else
1929 fp = NULL;
1930 mod = _PyImport_LoadDynamicModule(name, pathname, fp);
Victor Stinnere9ddbf62011-03-22 10:46:35 +01001931 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001932 if (fp)
1933 fclose(fp);
Victor Stinnerfefd70c2011-03-14 15:54:07 -04001934 return mod;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001935}
1936
Guido van Rossum96a8fb71999-12-22 14:09:35 +00001937#endif /* HAVE_DYNAMIC_LOADING */
1938
Barry Warsaw28a691b2010-04-17 00:19:56 +00001939
Guido van Rossum0207e6d1997-09-09 22:04:42 +00001940/* Doc strings */
1941
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001942PyDoc_STRVAR(doc_imp,
Brett Cannon6f44d662012-04-15 16:08:47 -04001943"(Extremely) low-level import machinery bits as used by importlib and imp.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00001944
Brett Cannon2657df42012-05-04 15:20:40 -04001945PyDoc_STRVAR(doc_extension_suffixes,
1946"extension_suffixes() -> list of strings\n\
1947Returns the list of file suffixes used to identify extension modules.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00001948
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001949PyDoc_STRVAR(doc_lock_held,
Tim Petersa7c65092004-08-01 23:26:05 +00001950"lock_held() -> boolean\n\
1951Return True if the import lock is currently held, else False.\n\
1952On platforms without threads, return False.");
Tim Peters69232342001-08-30 05:16:13 +00001953
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00001954PyDoc_STRVAR(doc_acquire_lock,
1955"acquire_lock() -> None\n\
Neal Norwitz2294c0d2003-02-12 23:02:21 +00001956Acquires the interpreter's import lock for the current thread.\n\
1957This lock should be used by import hooks to ensure thread-safety\n\
1958when importing modules.\n\
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00001959On platforms without threads, this function does nothing.");
1960
1961PyDoc_STRVAR(doc_release_lock,
1962"release_lock() -> None\n\
1963Release the interpreter's import lock.\n\
1964On platforms without threads, this function does nothing.");
1965
Guido van Rossum79f25d91997-04-29 20:08:16 +00001966static PyMethodDef imp_methods[] = {
Brett Cannon2657df42012-05-04 15:20:40 -04001967 {"extension_suffixes", imp_extension_suffixes, METH_NOARGS,
1968 doc_extension_suffixes},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001969 {"lock_held", imp_lock_held, METH_NOARGS, doc_lock_held},
1970 {"acquire_lock", imp_acquire_lock, METH_NOARGS, doc_acquire_lock},
1971 {"release_lock", imp_release_lock, METH_NOARGS, doc_release_lock},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001972 {"get_frozen_object", imp_get_frozen_object, METH_VARARGS},
1973 {"is_frozen_package", imp_is_frozen_package, METH_VARARGS},
1974 {"init_builtin", imp_init_builtin, METH_VARARGS},
1975 {"init_frozen", imp_init_frozen, METH_VARARGS},
1976 {"is_builtin", imp_is_builtin, METH_VARARGS},
1977 {"is_frozen", imp_is_frozen, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00001978#ifdef HAVE_DYNAMIC_LOADING
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001979 {"load_dynamic", imp_load_dynamic, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00001980#endif
Brett Cannon442c9b92011-03-23 16:14:42 -07001981 {"_fix_co_filename", imp_fix_co_filename, METH_VARARGS},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001982 {NULL, NULL} /* sentinel */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001983};
1984
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001985
Martin v. Löwis1a214512008-06-11 05:26:20 +00001986static struct PyModuleDef impmodule = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001987 PyModuleDef_HEAD_INIT,
Brett Cannon6f44d662012-04-15 16:08:47 -04001988 "_imp",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001989 doc_imp,
1990 0,
1991 imp_methods,
1992 NULL,
1993 NULL,
1994 NULL,
1995 NULL
Martin v. Löwis1a214512008-06-11 05:26:20 +00001996};
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001997
Jason Tishler6bc06ec2003-09-04 11:59:50 +00001998PyMODINIT_FUNC
Martin v. Löwis1a214512008-06-11 05:26:20 +00001999PyInit_imp(void)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002000{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002001 PyObject *m, *d;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002002
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002003 m = PyModule_Create(&impmodule);
2004 if (m == NULL)
2005 goto failure;
2006 d = PyModule_GetDict(m);
2007 if (d == NULL)
2008 goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002009
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002010 return m;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002011 failure:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002012 Py_XDECREF(m);
2013 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002014}
Guido van Rossum09cae1f1998-05-14 02:32:54 +00002015
2016
Guido van Rossumb18618d2000-05-03 23:44:39 +00002017/* API for embedding applications that want to add their own entries
2018 to the table of built-in modules. This should normally be called
2019 *before* Py_Initialize(). When the table resize fails, -1 is
2020 returned and the existing table is unchanged.
Guido van Rossum09cae1f1998-05-14 02:32:54 +00002021
2022 After a similar function by Just van Rossum. */
2023
2024int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002025PyImport_ExtendInittab(struct _inittab *newtab)
Guido van Rossum09cae1f1998-05-14 02:32:54 +00002026{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002027 static struct _inittab *our_copy = NULL;
2028 struct _inittab *p;
2029 int i, n;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00002030
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002031 /* Count the number of entries in both tables */
2032 for (n = 0; newtab[n].name != NULL; n++)
2033 ;
2034 if (n == 0)
2035 return 0; /* Nothing to do */
2036 for (i = 0; PyImport_Inittab[i].name != NULL; i++)
2037 ;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00002038
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002039 /* Allocate new memory for the combined table */
2040 p = our_copy;
2041 PyMem_RESIZE(p, struct _inittab, i+n+1);
2042 if (p == NULL)
2043 return -1;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00002044
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002045 /* Copy the tables into the new memory */
2046 if (our_copy != PyImport_Inittab)
2047 memcpy(p, PyImport_Inittab, (i+1) * sizeof(struct _inittab));
2048 PyImport_Inittab = our_copy = p;
2049 memcpy(p+i, newtab, (n+1) * sizeof(struct _inittab));
Guido van Rossum09cae1f1998-05-14 02:32:54 +00002050
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002051 return 0;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00002052}
2053
2054/* Shorthand to add a single entry given a name and a function */
2055
2056int
Brett Cannona826f322009-04-02 03:41:46 +00002057PyImport_AppendInittab(const char *name, PyObject* (*initfunc)(void))
Guido van Rossum09cae1f1998-05-14 02:32:54 +00002058{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002059 struct _inittab newtab[2];
Guido van Rossum09cae1f1998-05-14 02:32:54 +00002060
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002061 memset(newtab, '\0', sizeof newtab);
Guido van Rossum09cae1f1998-05-14 02:32:54 +00002062
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002063 newtab[0].name = (char *)name;
2064 newtab[0].initfunc = initfunc;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00002065
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002066 return PyImport_ExtendInittab(newtab);
Guido van Rossum09cae1f1998-05-14 02:32:54 +00002067}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002068
2069#ifdef __cplusplus
2070}
2071#endif