blob: 26261e191488be57ff13e56631e137a8cb94d730 [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 }
Antoine Pitrou202b6062012-12-18 22:18:17 +0100172 assert(import_lock_level == 0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000173 import_lock_thread = me;
174 import_lock_level = 1;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000175}
176
Benjamin Peterson0df35a92009-10-04 20:32:25 +0000177int
178_PyImport_ReleaseLock(void)
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000179{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000180 long me = PyThread_get_thread_ident();
181 if (me == -1 || import_lock == NULL)
182 return 0; /* Too bad */
183 if (import_lock_thread != me)
184 return -1;
185 import_lock_level--;
Antoine Pitrou202b6062012-12-18 22:18:17 +0100186 assert(import_lock_level >= 0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000187 if (import_lock_level == 0) {
188 import_lock_thread = -1;
189 PyThread_release_lock(import_lock);
190 }
191 return 1;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000192}
193
Gregory P. Smith24cec9f2010-03-01 06:18:41 +0000194/* This function is called from PyOS_AfterFork to ensure that newly
195 created child processes do not share locks with the parent.
196 We now acquire the import lock around fork() calls but on some platforms
197 (Solaris 9 and earlier? see isue7242) that still left us with problems. */
Guido van Rossum8ee3e5a2005-09-14 18:09:42 +0000198
199void
200_PyImport_ReInitLock(void)
201{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000202 if (import_lock != NULL)
203 import_lock = PyThread_allocate_lock();
Nick Coghlanb2ddf792010-12-02 04:11:46 +0000204 if (import_lock_level > 1) {
205 /* Forked as a side effect of import */
206 long me = PyThread_get_thread_ident();
207 PyThread_acquire_lock(import_lock, 0);
Victor Stinner942003c2011-03-07 16:57:48 +0100208 /* XXX: can the previous line fail? */
Nick Coghlanb2ddf792010-12-02 04:11:46 +0000209 import_lock_thread = me;
210 import_lock_level--;
211 } else {
212 import_lock_thread = -1;
213 import_lock_level = 0;
214 }
Guido van Rossum8ee3e5a2005-09-14 18:09:42 +0000215}
216
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000217#endif
218
Tim Peters69232342001-08-30 05:16:13 +0000219static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000220imp_lock_held(PyObject *self, PyObject *noargs)
Tim Peters69232342001-08-30 05:16:13 +0000221{
Tim Peters69232342001-08-30 05:16:13 +0000222#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000223 return PyBool_FromLong(import_lock_thread != -1);
Tim Peters69232342001-08-30 05:16:13 +0000224#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000225 return PyBool_FromLong(0);
Tim Peters69232342001-08-30 05:16:13 +0000226#endif
227}
228
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000229static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000230imp_acquire_lock(PyObject *self, PyObject *noargs)
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000231{
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000232#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000233 _PyImport_AcquireLock();
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000234#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000235 Py_INCREF(Py_None);
236 return Py_None;
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000237}
238
239static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000240imp_release_lock(PyObject *self, PyObject *noargs)
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000241{
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000242#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000243 if (_PyImport_ReleaseLock() < 0) {
244 PyErr_SetString(PyExc_RuntimeError,
245 "not holding the import lock");
246 return NULL;
247 }
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000248#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000249 Py_INCREF(Py_None);
250 return Py_None;
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000251}
252
Antoine Pitrou8db076c2011-10-30 19:13:55 +0100253void
254_PyImport_Fini(void)
255{
256 Py_XDECREF(extensions);
257 extensions = NULL;
Antoine Pitrou8db076c2011-10-30 19:13:55 +0100258#ifdef WITH_THREAD
259 if (import_lock != NULL) {
260 PyThread_free_lock(import_lock);
261 import_lock = NULL;
262 }
263#endif
264}
265
Guido van Rossum25ce5661997-08-02 03:10:38 +0000266/* Helper for sys */
267
268PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000269PyImport_GetModuleDict(void)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000270{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000271 PyInterpreterState *interp = PyThreadState_GET()->interp;
272 if (interp->modules == NULL)
273 Py_FatalError("PyImport_GetModuleDict: no module dictionary!");
274 return interp->modules;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000275}
276
Guido van Rossum3f5da241990-12-20 15:06:42 +0000277
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000278/* List of names to clear in sys */
279static char* sys_deletes[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000280 "path", "argv", "ps1", "ps2",
281 "last_type", "last_value", "last_traceback",
282 "path_hooks", "path_importer_cache", "meta_path",
283 /* misc stuff */
284 "flags", "float_info",
285 NULL
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000286};
287
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000288static char* sys_files[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000289 "stdin", "__stdin__",
290 "stdout", "__stdout__",
291 "stderr", "__stderr__",
292 NULL
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000293};
294
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000295
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000296/* Un-initialize things, as good as we can */
Guido van Rossum3f5da241990-12-20 15:06:42 +0000297
Guido van Rossum3f5da241990-12-20 15:06:42 +0000298void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000299PyImport_Cleanup(void)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000300{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000301 Py_ssize_t pos, ndone;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000302 PyObject *key, *value, *dict;
303 PyInterpreterState *interp = PyThreadState_GET()->interp;
304 PyObject *modules = interp->modules;
Guido van Rossum758eec01998-01-19 21:58:26 +0000305
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000306 if (modules == NULL)
307 return; /* Already done */
Guido van Rossum758eec01998-01-19 21:58:26 +0000308
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000309 /* Delete some special variables first. These are common
310 places where user values hide and people complain when their
311 destructors fail. Since the modules containing them are
312 deleted *last* of all, they would come too late in the normal
313 destruction order. Sigh. */
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000314
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000315 value = PyDict_GetItemString(modules, "builtins");
316 if (value != NULL && PyModule_Check(value)) {
317 dict = PyModule_GetDict(value);
318 if (Py_VerboseFlag)
319 PySys_WriteStderr("# clear builtins._\n");
320 PyDict_SetItemString(dict, "_", Py_None);
321 }
322 value = PyDict_GetItemString(modules, "sys");
323 if (value != NULL && PyModule_Check(value)) {
324 char **p;
325 PyObject *v;
326 dict = PyModule_GetDict(value);
327 for (p = sys_deletes; *p != NULL; p++) {
328 if (Py_VerboseFlag)
329 PySys_WriteStderr("# clear sys.%s\n", *p);
330 PyDict_SetItemString(dict, *p, Py_None);
331 }
332 for (p = sys_files; *p != NULL; p+=2) {
333 if (Py_VerboseFlag)
334 PySys_WriteStderr("# restore sys.%s\n", *p);
335 v = PyDict_GetItemString(dict, *(p+1));
336 if (v == NULL)
337 v = Py_None;
338 PyDict_SetItemString(dict, *p, v);
339 }
340 }
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000341
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000342 /* First, delete __main__ */
343 value = PyDict_GetItemString(modules, "__main__");
344 if (value != NULL && PyModule_Check(value)) {
345 if (Py_VerboseFlag)
346 PySys_WriteStderr("# cleanup __main__\n");
347 _PyModule_Clear(value);
348 PyDict_SetItemString(modules, "__main__", Py_None);
349 }
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000350
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000351 /* The special treatment of "builtins" here is because even
352 when it's not referenced as a module, its dictionary is
353 referenced by almost every module's __builtins__. Since
354 deleting a module clears its dictionary (even if there are
355 references left to it), we need to delete the "builtins"
356 module last. Likewise, we don't delete sys until the very
357 end because it is implicitly referenced (e.g. by print).
Guido van Rossum758eec01998-01-19 21:58:26 +0000358
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000359 Also note that we 'delete' modules by replacing their entry
360 in the modules dict with None, rather than really deleting
361 them; this avoids a rehash of the modules dictionary and
362 also marks them as "non existent" so they won't be
363 re-imported. */
Guido van Rossum758eec01998-01-19 21:58:26 +0000364
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000365 /* Next, repeatedly delete modules with a reference count of
366 one (skipping builtins and sys) and delete them */
367 do {
368 ndone = 0;
369 pos = 0;
370 while (PyDict_Next(modules, &pos, &key, &value)) {
371 if (value->ob_refcnt != 1)
372 continue;
373 if (PyUnicode_Check(key) && PyModule_Check(value)) {
Victor Stinner9464d612011-03-07 17:08:21 +0100374 if (PyUnicode_CompareWithASCIIString(key, "builtins") == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000375 continue;
Victor Stinner9464d612011-03-07 17:08:21 +0100376 if (PyUnicode_CompareWithASCIIString(key, "sys") == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000377 continue;
378 if (Py_VerboseFlag)
Victor Stinner9464d612011-03-07 17:08:21 +0100379 PySys_FormatStderr(
380 "# cleanup[1] %U\n", key);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000381 _PyModule_Clear(value);
382 PyDict_SetItem(modules, key, Py_None);
383 ndone++;
384 }
385 }
386 } while (ndone > 0);
Guido van Rossum758eec01998-01-19 21:58:26 +0000387
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000388 /* Next, delete all modules (still skipping builtins and sys) */
389 pos = 0;
390 while (PyDict_Next(modules, &pos, &key, &value)) {
391 if (PyUnicode_Check(key) && PyModule_Check(value)) {
Victor Stinner9464d612011-03-07 17:08:21 +0100392 if (PyUnicode_CompareWithASCIIString(key, "builtins") == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000393 continue;
Victor Stinner9464d612011-03-07 17:08:21 +0100394 if (PyUnicode_CompareWithASCIIString(key, "sys") == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000395 continue;
396 if (Py_VerboseFlag)
Victor Stinner9464d612011-03-07 17:08:21 +0100397 PySys_FormatStderr("# cleanup[2] %U\n", key);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000398 _PyModule_Clear(value);
399 PyDict_SetItem(modules, key, Py_None);
400 }
401 }
Guido van Rossum758eec01998-01-19 21:58:26 +0000402
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000403 /* Next, delete sys and builtins (in that order) */
404 value = PyDict_GetItemString(modules, "sys");
405 if (value != NULL && PyModule_Check(value)) {
406 if (Py_VerboseFlag)
407 PySys_WriteStderr("# cleanup sys\n");
408 _PyModule_Clear(value);
409 PyDict_SetItemString(modules, "sys", Py_None);
410 }
411 value = PyDict_GetItemString(modules, "builtins");
412 if (value != NULL && PyModule_Check(value)) {
413 if (Py_VerboseFlag)
414 PySys_WriteStderr("# cleanup builtins\n");
415 _PyModule_Clear(value);
416 PyDict_SetItemString(modules, "builtins", Py_None);
417 }
Guido van Rossum758eec01998-01-19 21:58:26 +0000418
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000419 /* Finally, clear and delete the modules directory */
420 PyDict_Clear(modules);
421 interp->modules = NULL;
422 Py_DECREF(modules);
Guido van Rossum8d15b5d1990-10-26 14:58:58 +0000423}
Guido van Rossum7f133ed1991-02-19 12:23:57 +0000424
425
Barry Warsaw28a691b2010-04-17 00:19:56 +0000426/* Helper for pythonrun.c -- return magic number and tag. */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000427
428long
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000429PyImport_GetMagicNumber(void)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000430{
Antoine Pitrou44b4b6a2012-07-10 18:27:54 +0200431 long res;
Brett Cannon77b2abd2012-07-09 16:09:00 -0400432 PyInterpreterState *interp = PyThreadState_Get()->interp;
433 PyObject *pyc_magic = PyObject_GetAttrString(interp->importlib,
434 "_RAW_MAGIC_NUMBER");
435 if (pyc_magic == NULL)
436 return -1;
Antoine Pitrou44b4b6a2012-07-10 18:27:54 +0200437 res = PyLong_AsLong(pyc_magic);
Benjamin Peterson66f36592012-07-09 22:21:55 -0700438 Py_DECREF(pyc_magic);
439 return res;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000440}
441
442
Brett Cannon3adc7b72012-07-09 14:22:12 -0400443extern const char * _PySys_ImplCacheTag;
444
Barry Warsaw28a691b2010-04-17 00:19:56 +0000445const char *
446PyImport_GetMagicTag(void)
447{
Brett Cannon3adc7b72012-07-09 14:22:12 -0400448 return _PySys_ImplCacheTag;
Barry Warsaw28a691b2010-04-17 00:19:56 +0000449}
450
Brett Cannon98979b82012-07-02 15:13:11 -0400451
Guido van Rossum25ce5661997-08-02 03:10:38 +0000452/* Magic for extension modules (built-in as well as dynamically
453 loaded). To prevent initializing an extension module more than
454 once, we keep a static dictionary 'extensions' keyed by module name
455 (for built-in modules) or by filename (for dynamically loaded
Barry Warsaw92883382001-08-13 23:05:44 +0000456 modules), containing these modules. A copy of the module's
Victor Stinner95872862011-03-07 18:20:56 +0100457 dictionary is stored by calling _PyImport_FixupExtensionObject()
Guido van Rossum25ce5661997-08-02 03:10:38 +0000458 immediately after the module initialization function succeeds. A
459 copy can be retrieved from there by calling
Victor Stinner95872862011-03-07 18:20:56 +0100460 _PyImport_FindExtensionObject().
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000461
Barry Warsaw7c9627b2010-06-17 18:38:20 +0000462 Modules which do support multiple initialization set their m_size
463 field to a non-negative number (indicating the size of the
464 module-specific state). They are still recorded in the extensions
465 dictionary, to avoid loading shared libraries twice.
Martin v. Löwis1a214512008-06-11 05:26:20 +0000466*/
467
468int
Victor Stinner95872862011-03-07 18:20:56 +0100469_PyImport_FixupExtensionObject(PyObject *mod, PyObject *name,
470 PyObject *filename)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000471{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000472 PyObject *modules, *dict;
473 struct PyModuleDef *def;
474 if (extensions == NULL) {
475 extensions = PyDict_New();
476 if (extensions == NULL)
477 return -1;
478 }
479 if (mod == NULL || !PyModule_Check(mod)) {
480 PyErr_BadInternalCall();
481 return -1;
482 }
483 def = PyModule_GetDef(mod);
484 if (!def) {
485 PyErr_BadInternalCall();
486 return -1;
487 }
488 modules = PyImport_GetModuleDict();
Victor Stinner95872862011-03-07 18:20:56 +0100489 if (PyDict_SetItem(modules, name, mod) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000490 return -1;
491 if (_PyState_AddModule(mod, def) < 0) {
Victor Stinner95872862011-03-07 18:20:56 +0100492 PyDict_DelItem(modules, name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000493 return -1;
494 }
495 if (def->m_size == -1) {
496 if (def->m_base.m_copy) {
497 /* Somebody already imported the module,
498 likely under a different name.
499 XXX this should really not happen. */
500 Py_DECREF(def->m_base.m_copy);
501 def->m_base.m_copy = NULL;
502 }
503 dict = PyModule_GetDict(mod);
504 if (dict == NULL)
505 return -1;
506 def->m_base.m_copy = PyDict_Copy(dict);
507 if (def->m_base.m_copy == NULL)
508 return -1;
509 }
Victor Stinner49d3f252010-10-17 01:24:53 +0000510 PyDict_SetItem(extensions, filename, (PyObject*)def);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000511 return 0;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000512}
513
Victor Stinner49d3f252010-10-17 01:24:53 +0000514int
515_PyImport_FixupBuiltin(PyObject *mod, char *name)
516{
517 int res;
Victor Stinner95872862011-03-07 18:20:56 +0100518 PyObject *nameobj;
Victor Stinner21fcd0c2011-03-07 18:28:15 +0100519 nameobj = PyUnicode_InternFromString(name);
Victor Stinner95872862011-03-07 18:20:56 +0100520 if (nameobj == NULL)
Victor Stinner49d3f252010-10-17 01:24:53 +0000521 return -1;
Victor Stinner95872862011-03-07 18:20:56 +0100522 res = _PyImport_FixupExtensionObject(mod, nameobj, nameobj);
523 Py_DECREF(nameobj);
Victor Stinner49d3f252010-10-17 01:24:53 +0000524 return res;
525}
526
Guido van Rossum25ce5661997-08-02 03:10:38 +0000527PyObject *
Victor Stinner95872862011-03-07 18:20:56 +0100528_PyImport_FindExtensionObject(PyObject *name, PyObject *filename)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000529{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000530 PyObject *mod, *mdict;
531 PyModuleDef* def;
532 if (extensions == NULL)
533 return NULL;
Victor Stinner49d3f252010-10-17 01:24:53 +0000534 def = (PyModuleDef*)PyDict_GetItem(extensions, filename);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000535 if (def == NULL)
536 return NULL;
537 if (def->m_size == -1) {
538 /* Module does not support repeated initialization */
539 if (def->m_base.m_copy == NULL)
540 return NULL;
Victor Stinner95872862011-03-07 18:20:56 +0100541 mod = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000542 if (mod == NULL)
543 return NULL;
544 mdict = PyModule_GetDict(mod);
545 if (mdict == NULL)
546 return NULL;
547 if (PyDict_Update(mdict, def->m_base.m_copy))
548 return NULL;
549 }
550 else {
551 if (def->m_base.m_init == NULL)
552 return NULL;
553 mod = def->m_base.m_init();
554 if (mod == NULL)
555 return NULL;
Victor Stinner95872862011-03-07 18:20:56 +0100556 PyDict_SetItem(PyImport_GetModuleDict(), name, mod);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000557 Py_DECREF(mod);
558 }
559 if (_PyState_AddModule(mod, def) < 0) {
Victor Stinner95872862011-03-07 18:20:56 +0100560 PyDict_DelItem(PyImport_GetModuleDict(), name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000561 Py_DECREF(mod);
562 return NULL;
563 }
564 if (Py_VerboseFlag)
Victor Stinner95872862011-03-07 18:20:56 +0100565 PySys_FormatStderr("import %U # previously loaded (%R)\n",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000566 name, filename);
567 return mod;
Brett Cannon9a5b25a2010-03-01 02:09:17 +0000568
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000569}
570
Victor Stinner49d3f252010-10-17 01:24:53 +0000571PyObject *
Victor Stinner501c09a2011-02-23 00:02:00 +0000572_PyImport_FindBuiltin(const char *name)
Victor Stinner49d3f252010-10-17 01:24:53 +0000573{
Victor Stinner95872862011-03-07 18:20:56 +0100574 PyObject *res, *nameobj;
Victor Stinner21fcd0c2011-03-07 18:28:15 +0100575 nameobj = PyUnicode_InternFromString(name);
Victor Stinner95872862011-03-07 18:20:56 +0100576 if (nameobj == NULL)
Victor Stinner49d3f252010-10-17 01:24:53 +0000577 return NULL;
Victor Stinner95872862011-03-07 18:20:56 +0100578 res = _PyImport_FindExtensionObject(nameobj, nameobj);
579 Py_DECREF(nameobj);
Victor Stinner49d3f252010-10-17 01:24:53 +0000580 return res;
581}
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000582
583/* Get the module object corresponding to a module name.
584 First check the modules dictionary if there's one there,
Walter Dörwaldf0dfc7a2003-10-20 14:01:56 +0000585 if not, create a new one and insert it in the modules dictionary.
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000586 Because the former action is most common, THIS DOES NOT RETURN A
587 'NEW' REFERENCE! */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000588
Guido van Rossum79f25d91997-04-29 20:08:16 +0000589PyObject *
Victor Stinner27ee0892011-03-04 12:57:09 +0000590PyImport_AddModuleObject(PyObject *name)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000591{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000592 PyObject *modules = PyImport_GetModuleDict();
593 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000594
Victor Stinner27ee0892011-03-04 12:57:09 +0000595 if ((m = PyDict_GetItem(modules, name)) != NULL &&
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000596 PyModule_Check(m))
597 return m;
Victor Stinner27ee0892011-03-04 12:57:09 +0000598 m = PyModule_NewObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000599 if (m == NULL)
600 return NULL;
Victor Stinner27ee0892011-03-04 12:57:09 +0000601 if (PyDict_SetItem(modules, name, m) != 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000602 Py_DECREF(m);
603 return NULL;
604 }
605 Py_DECREF(m); /* Yes, it still exists, in modules! */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000606
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000607 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000608}
609
Victor Stinner27ee0892011-03-04 12:57:09 +0000610PyObject *
611PyImport_AddModule(const char *name)
612{
613 PyObject *nameobj, *module;
614 nameobj = PyUnicode_FromString(name);
615 if (nameobj == NULL)
616 return NULL;
617 module = PyImport_AddModuleObject(nameobj);
618 Py_DECREF(nameobj);
619 return module;
620}
621
622
Tim Peters1cd70172004-08-02 03:52:12 +0000623/* Remove name from sys.modules, if it's there. */
624static void
Victor Stinner27ee0892011-03-04 12:57:09 +0000625remove_module(PyObject *name)
Tim Peters1cd70172004-08-02 03:52:12 +0000626{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000627 PyObject *modules = PyImport_GetModuleDict();
Victor Stinner27ee0892011-03-04 12:57:09 +0000628 if (PyDict_GetItem(modules, name) == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000629 return;
Victor Stinner27ee0892011-03-04 12:57:09 +0000630 if (PyDict_DelItem(modules, name) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000631 Py_FatalError("import: deleting existing key in"
632 "sys.modules failed");
Tim Peters1cd70172004-08-02 03:52:12 +0000633}
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000634
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
Victor Stinner27ee0892011-03-04 12:57:09 +0000671 if (cpathname != NULL) {
672 cpathobj = PyUnicode_DecodeFSDefault(cpathname);
673 if (cpathobj == NULL)
674 goto error;
Brett Cannona6473f92012-07-13 13:57:03 -0400675 }
676 else
Victor Stinner27ee0892011-03-04 12:57:09 +0000677 cpathobj = NULL;
Brett Cannona6473f92012-07-13 13:57:03 -0400678
679 if (pathname != NULL) {
680 pathobj = PyUnicode_DecodeFSDefault(pathname);
681 if (pathobj == NULL)
682 goto error;
683 }
684 else if (cpathobj != NULL) {
685 PyInterpreterState *interp = PyThreadState_GET()->interp;
686 _Py_IDENTIFIER(_get_sourcefile);
687
688 if (interp == NULL) {
689 Py_FatalError("PyImport_ExecCodeModuleWithPathnames: "
690 "no interpreter!");
691 }
692
693 pathobj = _PyObject_CallMethodObjIdArgs(interp->importlib,
694 &PyId__get_sourcefile, cpathobj,
695 NULL);
696 if (pathobj == NULL)
697 PyErr_Clear();
698 }
699 else
700 pathobj = NULL;
701
Victor Stinner27ee0892011-03-04 12:57:09 +0000702 m = PyImport_ExecCodeModuleObject(nameobj, co, pathobj, cpathobj);
703error:
704 Py_DECREF(nameobj);
705 Py_XDECREF(pathobj);
706 Py_XDECREF(cpathobj);
707 return m;
708}
709
710PyObject*
711PyImport_ExecCodeModuleObject(PyObject *name, PyObject *co, PyObject *pathname,
712 PyObject *cpathname)
713{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000714 PyObject *modules = PyImport_GetModuleDict();
715 PyObject *m, *d, *v;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000716
Victor Stinner27ee0892011-03-04 12:57:09 +0000717 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000718 if (m == NULL)
719 return NULL;
720 /* If the module is being reloaded, we get the old module back
721 and re-use its dict to exec the new code. */
722 d = PyModule_GetDict(m);
723 if (PyDict_GetItemString(d, "__builtins__") == NULL) {
724 if (PyDict_SetItemString(d, "__builtins__",
725 PyEval_GetBuiltins()) != 0)
726 goto error;
727 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000728 if (pathname != NULL) {
Brett Cannona6473f92012-07-13 13:57:03 -0400729 v = pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000730 }
Brett Cannona6473f92012-07-13 13:57:03 -0400731 else {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000732 v = ((PyCodeObject *)co)->co_filename;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000733 }
Brett Cannona6473f92012-07-13 13:57:03 -0400734 Py_INCREF(v);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000735 if (PyDict_SetItemString(d, "__file__", v) != 0)
736 PyErr_Clear(); /* Not important enough to report */
737 Py_DECREF(v);
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000738
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000739 /* Remember the pyc path name as the __cached__ attribute. */
Victor Stinner27ee0892011-03-04 12:57:09 +0000740 if (cpathname != NULL)
741 v = cpathname;
742 else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000743 v = Py_None;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000744 if (PyDict_SetItemString(d, "__cached__", v) != 0)
745 PyErr_Clear(); /* Not important enough to report */
Barry Warsaw28a691b2010-04-17 00:19:56 +0000746
Martin v. Löwis4d0d4712010-12-03 20:14:31 +0000747 v = PyEval_EvalCode(co, d, d);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000748 if (v == NULL)
749 goto error;
750 Py_DECREF(v);
Guido van Rossumb65e85c1997-07-10 18:00:45 +0000751
Victor Stinner27ee0892011-03-04 12:57:09 +0000752 if ((m = PyDict_GetItem(modules, name)) == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000753 PyErr_Format(PyExc_ImportError,
Victor Stinner27ee0892011-03-04 12:57:09 +0000754 "Loaded module %R not found in sys.modules",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000755 name);
756 return NULL;
757 }
Guido van Rossumb65e85c1997-07-10 18:00:45 +0000758
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000759 Py_INCREF(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000760
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000761 return m;
Tim Peters1cd70172004-08-02 03:52:12 +0000762
763 error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000764 remove_module(name);
765 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000766}
767
768
Antoine Pitroud35cbf62009-01-06 19:02:24 +0000769static void
770update_code_filenames(PyCodeObject *co, PyObject *oldname, PyObject *newname)
771{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000772 PyObject *constants, *tmp;
773 Py_ssize_t i, n;
Antoine Pitroud35cbf62009-01-06 19:02:24 +0000774
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000775 if (PyUnicode_Compare(co->co_filename, oldname))
776 return;
Antoine Pitroud35cbf62009-01-06 19:02:24 +0000777
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000778 tmp = co->co_filename;
779 co->co_filename = newname;
780 Py_INCREF(co->co_filename);
781 Py_DECREF(tmp);
Antoine Pitroud35cbf62009-01-06 19:02:24 +0000782
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000783 constants = co->co_consts;
784 n = PyTuple_GET_SIZE(constants);
785 for (i = 0; i < n; i++) {
786 tmp = PyTuple_GET_ITEM(constants, i);
787 if (PyCode_Check(tmp))
788 update_code_filenames((PyCodeObject *)tmp,
789 oldname, newname);
790 }
Antoine Pitroud35cbf62009-01-06 19:02:24 +0000791}
792
Victor Stinner2f42ae52011-03-20 00:41:24 +0100793static void
794update_compiled_module(PyCodeObject *co, PyObject *newname)
Antoine Pitroud35cbf62009-01-06 19:02:24 +0000795{
Victor Stinner2f42ae52011-03-20 00:41:24 +0100796 PyObject *oldname;
Antoine Pitroud35cbf62009-01-06 19:02:24 +0000797
Victor Stinner2f42ae52011-03-20 00:41:24 +0100798 if (PyUnicode_Compare(co->co_filename, newname) == 0)
799 return;
Hirokazu Yamamoto4f447fb2009-03-04 01:52:10 +0000800
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000801 oldname = co->co_filename;
802 Py_INCREF(oldname);
803 update_code_filenames(co, oldname, newname);
804 Py_DECREF(oldname);
Antoine Pitroud35cbf62009-01-06 19:02:24 +0000805}
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000806
Brett Cannon442c9b92011-03-23 16:14:42 -0700807static PyObject *
808imp_fix_co_filename(PyObject *self, PyObject *args)
809{
810 PyObject *co;
811 PyObject *file_path;
812
813 if (!PyArg_ParseTuple(args, "OO:_fix_co_filename", &co, &file_path))
814 return NULL;
815
816 if (!PyCode_Check(co)) {
817 PyErr_SetString(PyExc_TypeError,
818 "first argument must be a code object");
819 return NULL;
820 }
821
822 if (!PyUnicode_Check(file_path)) {
823 PyErr_SetString(PyExc_TypeError,
824 "second argument must be a string");
825 return NULL;
826 }
827
828 update_compiled_module((PyCodeObject*)co, file_path);
829
830 Py_RETURN_NONE;
831}
832
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000833
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000834/* Forward */
Victor Stinner53dc7352011-03-20 01:50:21 +0100835static struct _frozen * find_frozen(PyObject *);
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000836
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000837
838/* Helper to test for built-in module */
839
840static int
Victor Stinner95872862011-03-07 18:20:56 +0100841is_builtin(PyObject *name)
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000842{
Victor Stinner95872862011-03-07 18:20:56 +0100843 int i, cmp;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000844 for (i = 0; PyImport_Inittab[i].name != NULL; i++) {
Victor Stinner95872862011-03-07 18:20:56 +0100845 cmp = PyUnicode_CompareWithASCIIString(name, PyImport_Inittab[i].name);
846 if (cmp == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000847 if (PyImport_Inittab[i].initfunc == NULL)
848 return -1;
849 else
850 return 1;
851 }
852 }
853 return 0;
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000854}
855
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000856
Just van Rossum52e14d62002-12-30 22:08:05 +0000857/* Return an importer object for a sys.path/pkg.__path__ item 'p',
858 possibly by fetching it from the path_importer_cache dict. If it
Thomas Wouters89f507f2006-12-13 04:49:30 +0000859 wasn't yet cached, traverse path_hooks until a hook is found
Just van Rossum52e14d62002-12-30 22:08:05 +0000860 that can handle the path item. Return None if no hook could;
861 this tells our caller it should fall back to the builtin
862 import mechanism. Cache the result in path_importer_cache.
863 Returns a borrowed reference. */
864
865static PyObject *
866get_path_importer(PyObject *path_importer_cache, PyObject *path_hooks,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000867 PyObject *p)
Just van Rossum52e14d62002-12-30 22:08:05 +0000868{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000869 PyObject *importer;
870 Py_ssize_t j, nhooks;
Just van Rossum52e14d62002-12-30 22:08:05 +0000871
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000872 /* These conditions are the caller's responsibility: */
873 assert(PyList_Check(path_hooks));
874 assert(PyDict_Check(path_importer_cache));
Just van Rossum52e14d62002-12-30 22:08:05 +0000875
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000876 nhooks = PyList_Size(path_hooks);
877 if (nhooks < 0)
878 return NULL; /* Shouldn't happen */
Just van Rossum52e14d62002-12-30 22:08:05 +0000879
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000880 importer = PyDict_GetItem(path_importer_cache, p);
881 if (importer != NULL)
882 return importer;
Just van Rossum52e14d62002-12-30 22:08:05 +0000883
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000884 /* set path_importer_cache[p] to None to avoid recursion */
885 if (PyDict_SetItem(path_importer_cache, p, Py_None) != 0)
886 return NULL;
Just van Rossum52e14d62002-12-30 22:08:05 +0000887
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000888 for (j = 0; j < nhooks; j++) {
889 PyObject *hook = PyList_GetItem(path_hooks, j);
890 if (hook == NULL)
891 return NULL;
892 importer = PyObject_CallFunctionObjArgs(hook, p, NULL);
893 if (importer != NULL)
894 break;
Just van Rossum52e14d62002-12-30 22:08:05 +0000895
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000896 if (!PyErr_ExceptionMatches(PyExc_ImportError)) {
897 return NULL;
898 }
899 PyErr_Clear();
900 }
901 if (importer == NULL) {
Brett Cannonaa936422012-04-27 15:30:58 -0400902 return Py_None;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000903 }
904 if (importer != NULL) {
905 int err = PyDict_SetItem(path_importer_cache, p, importer);
906 Py_DECREF(importer);
907 if (err != 0)
908 return NULL;
909 }
910 return importer;
Just van Rossum52e14d62002-12-30 22:08:05 +0000911}
912
Christian Heimes9cd17752007-11-18 19:35:23 +0000913PyAPI_FUNC(PyObject *)
914PyImport_GetImporter(PyObject *path) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000915 PyObject *importer=NULL, *path_importer_cache=NULL, *path_hooks=NULL;
Christian Heimes9cd17752007-11-18 19:35:23 +0000916
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000917 if ((path_importer_cache = PySys_GetObject("path_importer_cache"))) {
918 if ((path_hooks = PySys_GetObject("path_hooks"))) {
919 importer = get_path_importer(path_importer_cache,
920 path_hooks, path);
921 }
922 }
923 Py_XINCREF(importer); /* get_path_importer returns a borrowed reference */
924 return importer;
Christian Heimes9cd17752007-11-18 19:35:23 +0000925}
926
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000927
Victor Stinner95872862011-03-07 18:20:56 +0100928static int init_builtin(PyObject *); /* Forward */
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000929
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000930/* Initialize a built-in module.
Thomas Wouters89f507f2006-12-13 04:49:30 +0000931 Return 1 for success, 0 if the module is not found, and -1 with
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000932 an exception set if the initialization failed. */
Guido van Rossum7f133ed1991-02-19 12:23:57 +0000933
Guido van Rossum7f133ed1991-02-19 12:23:57 +0000934static int
Victor Stinner95872862011-03-07 18:20:56 +0100935init_builtin(PyObject *name)
Guido van Rossum7f133ed1991-02-19 12:23:57 +0000936{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000937 struct _inittab *p;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000938
Victor Stinner95872862011-03-07 18:20:56 +0100939 if (_PyImport_FindExtensionObject(name, name) != NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000940 return 1;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000941
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000942 for (p = PyImport_Inittab; p->name != NULL; p++) {
943 PyObject *mod;
Antoine Pitrou6c40eb72012-01-18 20:16:09 +0100944 PyModuleDef *def;
Victor Stinner95872862011-03-07 18:20:56 +0100945 if (PyUnicode_CompareWithASCIIString(name, p->name) == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000946 if (p->initfunc == NULL) {
947 PyErr_Format(PyExc_ImportError,
Victor Stinner95872862011-03-07 18:20:56 +0100948 "Cannot re-init internal module %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000949 name);
950 return -1;
951 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000952 mod = (*p->initfunc)();
953 if (mod == 0)
954 return -1;
Antoine Pitrou6c40eb72012-01-18 20:16:09 +0100955 /* Remember pointer to module init function. */
956 def = PyModule_GetDef(mod);
957 def->m_base.m_init = p->initfunc;
Victor Stinner95872862011-03-07 18:20:56 +0100958 if (_PyImport_FixupExtensionObject(mod, name, name) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000959 return -1;
960 /* FixupExtension has put the module into sys.modules,
961 so we can release our own reference. */
962 Py_DECREF(mod);
963 return 1;
964 }
965 }
966 return 0;
Guido van Rossum7f133ed1991-02-19 12:23:57 +0000967}
Guido van Rossumf56e3db1993-04-01 20:59:32 +0000968
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000969
Guido van Rossum6ec1efb1995-08-04 04:08:57 +0000970/* Frozen modules */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000971
Guido van Rossumcfd0a221996-06-17 17:06:34 +0000972static struct _frozen *
Victor Stinner53dc7352011-03-20 01:50:21 +0100973find_frozen(PyObject *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +0000974{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000975 struct _frozen *p;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +0000976
Victor Stinner53dc7352011-03-20 01:50:21 +0100977 if (name == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000978 return NULL;
Benjamin Petersond968e272008-11-05 22:48:33 +0000979
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000980 for (p = PyImport_FrozenModules; ; p++) {
981 if (p->name == NULL)
982 return NULL;
Victor Stinner53dc7352011-03-20 01:50:21 +0100983 if (PyUnicode_CompareWithASCIIString(name, p->name) == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000984 break;
985 }
986 return p;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +0000987}
988
Guido van Rossum79f25d91997-04-29 20:08:16 +0000989static PyObject *
Victor Stinner53dc7352011-03-20 01:50:21 +0100990get_frozen_object(PyObject *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +0000991{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000992 struct _frozen *p = find_frozen(name);
993 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +0000994
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000995 if (p == NULL) {
996 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +0100997 "No such frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000998 name);
999 return NULL;
1000 }
1001 if (p->code == NULL) {
1002 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01001003 "Excluded frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001004 name);
1005 return NULL;
1006 }
1007 size = p->size;
1008 if (size < 0)
1009 size = -size;
1010 return PyMarshal_ReadObjectFromString((char *)p->code, size);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001011}
1012
Brett Cannon8d110132009-03-15 02:20:16 +00001013static PyObject *
Victor Stinner53dc7352011-03-20 01:50:21 +01001014is_frozen_package(PyObject *name)
Brett Cannon8d110132009-03-15 02:20:16 +00001015{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001016 struct _frozen *p = find_frozen(name);
1017 int size;
Brett Cannon8d110132009-03-15 02:20:16 +00001018
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001019 if (p == NULL) {
1020 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01001021 "No such frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001022 name);
1023 return NULL;
1024 }
Brett Cannon8d110132009-03-15 02:20:16 +00001025
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001026 size = p->size;
Brett Cannon8d110132009-03-15 02:20:16 +00001027
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001028 if (size < 0)
1029 Py_RETURN_TRUE;
1030 else
1031 Py_RETURN_FALSE;
Brett Cannon8d110132009-03-15 02:20:16 +00001032}
1033
1034
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001035/* Initialize a frozen module.
Brett Cannon3c2ac442009-03-08 20:49:47 +00001036 Return 1 for success, 0 if the module is not found, and -1 with
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001037 an exception set if the initialization failed.
1038 This function is also used from frozenmain.c */
Guido van Rossum0b344901995-02-07 15:35:27 +00001039
1040int
Victor Stinner53dc7352011-03-20 01:50:21 +01001041PyImport_ImportFrozenModuleObject(PyObject *name)
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001042{
Victor Stinner53dc7352011-03-20 01:50:21 +01001043 struct _frozen *p;
1044 PyObject *co, *m, *path;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001045 int ispackage;
1046 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001047
Victor Stinner53dc7352011-03-20 01:50:21 +01001048 p = find_frozen(name);
1049
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001050 if (p == NULL)
1051 return 0;
1052 if (p->code == NULL) {
1053 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01001054 "Excluded frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001055 name);
1056 return -1;
1057 }
1058 size = p->size;
1059 ispackage = (size < 0);
1060 if (ispackage)
1061 size = -size;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001062 co = PyMarshal_ReadObjectFromString((char *)p->code, size);
1063 if (co == NULL)
1064 return -1;
1065 if (!PyCode_Check(co)) {
1066 PyErr_Format(PyExc_TypeError,
Victor Stinner53dc7352011-03-20 01:50:21 +01001067 "frozen object %R is not a code object",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001068 name);
1069 goto err_return;
1070 }
1071 if (ispackage) {
1072 /* Set __path__ to the package name */
Victor Stinner53dc7352011-03-20 01:50:21 +01001073 PyObject *d, *l;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001074 int err;
Victor Stinner53dc7352011-03-20 01:50:21 +01001075 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001076 if (m == NULL)
1077 goto err_return;
1078 d = PyModule_GetDict(m);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001079 l = PyList_New(1);
1080 if (l == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001081 goto err_return;
1082 }
Victor Stinner53dc7352011-03-20 01:50:21 +01001083 Py_INCREF(name);
1084 PyList_SET_ITEM(l, 0, name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001085 err = PyDict_SetItemString(d, "__path__", l);
1086 Py_DECREF(l);
1087 if (err != 0)
1088 goto err_return;
1089 }
Victor Stinner53dc7352011-03-20 01:50:21 +01001090 path = PyUnicode_FromString("<frozen>");
1091 if (path == NULL)
1092 goto err_return;
1093 m = PyImport_ExecCodeModuleObject(name, co, path, NULL);
1094 Py_DECREF(path);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001095 if (m == NULL)
1096 goto err_return;
1097 Py_DECREF(co);
1098 Py_DECREF(m);
1099 return 1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001100err_return:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001101 Py_DECREF(co);
1102 return -1;
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001103}
Guido van Rossum74e6a111994-08-29 12:54:38 +00001104
Victor Stinner53dc7352011-03-20 01:50:21 +01001105int
1106PyImport_ImportFrozenModule(char *name)
1107{
1108 PyObject *nameobj;
1109 int ret;
1110 nameobj = PyUnicode_InternFromString(name);
1111 if (nameobj == NULL)
1112 return -1;
1113 ret = PyImport_ImportFrozenModuleObject(nameobj);
1114 Py_DECREF(nameobj);
1115 return ret;
1116}
1117
Guido van Rossum74e6a111994-08-29 12:54:38 +00001118
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001119/* Import a module, either built-in, frozen, or external, and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001120 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum74e6a111994-08-29 12:54:38 +00001121
Guido van Rossum79f25d91997-04-29 20:08:16 +00001122PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001123PyImport_ImportModule(const char *name)
Guido van Rossum74e6a111994-08-29 12:54:38 +00001124{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001125 PyObject *pname;
1126 PyObject *result;
Marc-André Lemburg3c61c352001-02-09 19:40:15 +00001127
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001128 pname = PyUnicode_FromString(name);
1129 if (pname == NULL)
1130 return NULL;
1131 result = PyImport_Import(pname);
1132 Py_DECREF(pname);
1133 return result;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001134}
1135
Christian Heimes072c0f12008-01-03 23:01:04 +00001136/* Import a module without blocking
1137 *
1138 * At first it tries to fetch the module from sys.modules. If the module was
1139 * never loaded before it loads it with PyImport_ImportModule() unless another
1140 * thread holds the import lock. In the latter case the function raises an
1141 * ImportError instead of blocking.
1142 *
1143 * Returns the module object with incremented ref count.
1144 */
1145PyObject *
1146PyImport_ImportModuleNoBlock(const char *name)
1147{
Antoine Pitrouea3eb882012-05-17 18:55:59 +02001148 return PyImport_ImportModule(name);
Christian Heimes072c0f12008-01-03 23:01:04 +00001149}
1150
Guido van Rossum17fc85f1997-09-06 18:52:03 +00001151
Antoine Pitroubc07a5c2012-07-08 12:01:27 +02001152/* Remove importlib frames from the traceback,
1153 * except in Verbose mode. */
1154static void
1155remove_importlib_frames(void)
1156{
1157 const char *importlib_filename = "<frozen importlib._bootstrap>";
Nick Coghlan42c07662012-07-31 21:14:18 +10001158 const char *remove_frames = "_call_with_frames_removed";
Antoine Pitroubc07a5c2012-07-08 12:01:27 +02001159 int always_trim = 0;
Benjamin Petersonfa873702012-07-09 13:43:53 -07001160 int in_importlib = 0;
Antoine Pitroubc07a5c2012-07-08 12:01:27 +02001161 PyObject *exception, *value, *base_tb, *tb;
Benjamin Petersonfa873702012-07-09 13:43:53 -07001162 PyObject **prev_link, **outer_link = NULL;
Antoine Pitroubc07a5c2012-07-08 12:01:27 +02001163
1164 /* Synopsis: if it's an ImportError, we trim all importlib chunks
Nick Coghlan42c07662012-07-31 21:14:18 +10001165 from the traceback. We always trim chunks
1166 which end with a call to "_call_with_frames_removed". */
Antoine Pitroubc07a5c2012-07-08 12:01:27 +02001167
1168 PyErr_Fetch(&exception, &value, &base_tb);
1169 if (!exception || Py_VerboseFlag)
1170 goto done;
1171 if (PyType_IsSubtype((PyTypeObject *) exception,
1172 (PyTypeObject *) PyExc_ImportError))
1173 always_trim = 1;
1174
1175 prev_link = &base_tb;
1176 tb = base_tb;
Antoine Pitroubc07a5c2012-07-08 12:01:27 +02001177 while (tb != NULL) {
1178 PyTracebackObject *traceback = (PyTracebackObject *)tb;
1179 PyObject *next = (PyObject *) traceback->tb_next;
1180 PyFrameObject *frame = traceback->tb_frame;
1181 PyCodeObject *code = frame->f_code;
1182 int now_in_importlib;
1183
1184 assert(PyTraceBack_Check(tb));
1185 now_in_importlib = (PyUnicode_CompareWithASCIIString(
1186 code->co_filename,
1187 importlib_filename) == 0);
1188 if (now_in_importlib && !in_importlib) {
1189 /* This is the link to this chunk of importlib tracebacks */
1190 outer_link = prev_link;
1191 }
1192 in_importlib = now_in_importlib;
1193
1194 if (in_importlib &&
1195 (always_trim ||
Nick Coghlan42c07662012-07-31 21:14:18 +10001196 PyUnicode_CompareWithASCIIString(code->co_name,
1197 remove_frames) == 0)) {
Antoine Pitroubc07a5c2012-07-08 12:01:27 +02001198 PyObject *tmp = *outer_link;
1199 *outer_link = next;
1200 Py_XINCREF(next);
1201 Py_DECREF(tmp);
1202 prev_link = outer_link;
1203 }
1204 else {
1205 prev_link = (PyObject **) &traceback->tb_next;
1206 }
1207 tb = next;
1208 }
1209done:
1210 PyErr_Restore(exception, value, base_tb);
1211}
1212
1213
Thomas Woutersf7f438b2006-02-28 16:09:29 +00001214PyObject *
Brett Cannonfd074152012-04-14 14:10:13 -04001215PyImport_ImportModuleLevelObject(PyObject *name, PyObject *given_globals,
1216 PyObject *locals, PyObject *given_fromlist,
Victor Stinnerfe93faf2011-03-14 15:54:52 -04001217 int level)
Thomas Woutersf7f438b2006-02-28 16:09:29 +00001218{
Brett Cannonfd074152012-04-14 14:10:13 -04001219 _Py_IDENTIFIER(__import__);
Antoine Pitrouea3eb882012-05-17 18:55:59 +02001220 _Py_IDENTIFIER(__initializing__);
Brett Cannonfd074152012-04-14 14:10:13 -04001221 _Py_IDENTIFIER(__package__);
1222 _Py_IDENTIFIER(__path__);
1223 _Py_IDENTIFIER(__name__);
1224 _Py_IDENTIFIER(_find_and_load);
1225 _Py_IDENTIFIER(_handle_fromlist);
Antoine Pitrouea3eb882012-05-17 18:55:59 +02001226 _Py_IDENTIFIER(_lock_unlock_module);
Brett Cannonfd074152012-04-14 14:10:13 -04001227 _Py_static_string(single_dot, ".");
1228 PyObject *abs_name = NULL;
1229 PyObject *builtins_import = NULL;
1230 PyObject *final_mod = NULL;
1231 PyObject *mod = NULL;
1232 PyObject *package = NULL;
1233 PyObject *globals = NULL;
1234 PyObject *fromlist = NULL;
1235 PyInterpreterState *interp = PyThreadState_GET()->interp;
1236
1237 /* Make sure to use default values so as to not have
1238 PyObject_CallMethodObjArgs() truncate the parameter list because of a
1239 NULL argument. */
1240 if (given_globals == NULL) {
1241 globals = PyDict_New();
1242 if (globals == NULL) {
1243 goto error;
1244 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001245 }
Brett Cannonfd074152012-04-14 14:10:13 -04001246 else {
1247 /* Only have to care what given_globals is if it will be used
Brett Cannonecfefb72012-08-05 19:24:57 -04001248 for something. */
Brett Cannonfd074152012-04-14 14:10:13 -04001249 if (level > 0 && !PyDict_Check(given_globals)) {
1250 PyErr_SetString(PyExc_TypeError, "globals must be a dict");
1251 goto error;
1252 }
1253 globals = given_globals;
1254 Py_INCREF(globals);
1255 }
1256
1257 if (given_fromlist == NULL) {
1258 fromlist = PyList_New(0);
1259 if (fromlist == NULL) {
1260 goto error;
1261 }
1262 }
1263 else {
1264 fromlist = given_fromlist;
1265 Py_INCREF(fromlist);
1266 }
1267 if (name == NULL) {
1268 PyErr_SetString(PyExc_ValueError, "Empty module name");
1269 goto error;
1270 }
1271
1272 /* The below code is importlib.__import__() & _gcd_import(), ported to C
1273 for added performance. */
1274
1275 if (!PyUnicode_Check(name)) {
1276 PyErr_SetString(PyExc_TypeError, "module name must be a string");
1277 goto error;
1278 }
1279 else if (PyUnicode_READY(name) < 0) {
1280 goto error;
1281 }
1282 if (level < 0) {
1283 PyErr_SetString(PyExc_ValueError, "level must be >= 0");
1284 goto error;
1285 }
1286 else if (level > 0) {
1287 package = _PyDict_GetItemId(globals, &PyId___package__);
1288 if (package != NULL && package != Py_None) {
1289 Py_INCREF(package);
1290 if (!PyUnicode_Check(package)) {
1291 PyErr_SetString(PyExc_TypeError, "package must be a string");
1292 goto error;
1293 }
1294 }
1295 else {
Brett Cannon273323c2012-04-17 19:05:11 -04001296 package = _PyDict_GetItemId(globals, &PyId___name__);
Brett Cannonfd074152012-04-14 14:10:13 -04001297 if (package == NULL) {
Brett Cannon273323c2012-04-17 19:05:11 -04001298 PyErr_SetString(PyExc_KeyError, "'__name__' not in globals");
Brett Cannonfd074152012-04-14 14:10:13 -04001299 goto error;
1300 }
1301 else if (!PyUnicode_Check(package)) {
1302 PyErr_SetString(PyExc_TypeError, "__name__ must be a string");
1303 }
1304 Py_INCREF(package);
1305
1306 if (_PyDict_GetItemId(globals, &PyId___path__) == NULL) {
Brett Cannon740fce02012-04-14 14:23:49 -04001307 PyObject *partition = NULL;
Brett Cannonfd074152012-04-14 14:10:13 -04001308 PyObject *borrowed_dot = _PyUnicode_FromId(&single_dot);
1309 if (borrowed_dot == NULL) {
1310 goto error;
1311 }
Brett Cannon740fce02012-04-14 14:23:49 -04001312 partition = PyUnicode_RPartition(package, borrowed_dot);
Brett Cannonfd074152012-04-14 14:10:13 -04001313 Py_DECREF(package);
1314 if (partition == NULL) {
1315 goto error;
1316 }
1317 package = PyTuple_GET_ITEM(partition, 0);
1318 Py_INCREF(package);
1319 Py_DECREF(partition);
1320 }
1321 }
1322
1323 if (PyDict_GetItem(interp->modules, package) == NULL) {
1324 PyErr_Format(PyExc_SystemError,
1325 "Parent module %R not loaded, cannot perform relative "
1326 "import", package);
1327 goto error;
1328 }
1329 }
1330 else { /* level == 0 */
1331 if (PyUnicode_GET_LENGTH(name) == 0) {
1332 PyErr_SetString(PyExc_ValueError, "Empty module name");
1333 goto error;
1334 }
1335 package = Py_None;
1336 Py_INCREF(package);
1337 }
1338
1339 if (level > 0) {
1340 Py_ssize_t last_dot = PyUnicode_GET_LENGTH(package);
1341 PyObject *base = NULL;
1342 int level_up = 1;
1343
1344 for (level_up = 1; level_up < level; level_up += 1) {
1345 last_dot = PyUnicode_FindChar(package, '.', 0, last_dot, -1);
1346 if (last_dot == -2) {
1347 goto error;
1348 }
1349 else if (last_dot == -1) {
1350 PyErr_SetString(PyExc_ValueError,
1351 "attempted relative import beyond top-level "
1352 "package");
1353 goto error;
1354 }
1355 }
1356 base = PyUnicode_Substring(package, 0, last_dot);
1357 if (PyUnicode_GET_LENGTH(name) > 0) {
Antoine Pitrou538ba2a2012-04-16 21:52:45 +02001358 PyObject *borrowed_dot, *seq = NULL;
Brett Cannonfd074152012-04-14 14:10:13 -04001359
1360 borrowed_dot = _PyUnicode_FromId(&single_dot);
Antoine Pitrou538ba2a2012-04-16 21:52:45 +02001361 seq = PyTuple_Pack(2, base, name);
1362 Py_DECREF(base);
Brett Cannonfd074152012-04-14 14:10:13 -04001363 if (borrowed_dot == NULL || seq == NULL) {
1364 goto error;
1365 }
1366
1367 abs_name = PyUnicode_Join(borrowed_dot, seq);
1368 Py_DECREF(seq);
1369 if (abs_name == NULL) {
1370 goto error;
1371 }
1372 }
1373 else {
1374 abs_name = base;
1375 }
1376 }
1377 else {
1378 abs_name = name;
1379 Py_INCREF(abs_name);
1380 }
1381
Brian Curtine6b299f2012-04-14 14:19:33 -05001382#ifdef WITH_THREAD
Brett Cannonfd074152012-04-14 14:10:13 -04001383 _PyImport_AcquireLock();
1384#endif
1385 /* From this point forward, goto error_with_unlock! */
1386 if (PyDict_Check(globals)) {
1387 builtins_import = _PyDict_GetItemId(globals, &PyId___import__);
1388 }
1389 if (builtins_import == NULL) {
1390 builtins_import = _PyDict_GetItemId(interp->builtins, &PyId___import__);
1391 if (builtins_import == NULL) {
Benjamin Peterson7d110042013-04-29 09:08:14 -04001392 PyErr_SetString(PyExc_ImportError, "__import__ not found");
1393 goto error_with_unlock;
Brett Cannonfd074152012-04-14 14:10:13 -04001394 }
1395 }
1396 Py_INCREF(builtins_import);
1397
1398 mod = PyDict_GetItem(interp->modules, abs_name);
1399 if (mod == Py_None) {
Brett Cannon27fc5282012-04-15 14:15:31 -04001400 PyObject *msg = PyUnicode_FromFormat("import of %R halted; "
1401 "None in sys.modules", abs_name);
1402 if (msg != NULL) {
Brian Curtin09b86d12012-04-17 16:57:09 -05001403 PyErr_SetImportError(msg, abs_name, NULL);
1404 Py_DECREF(msg);
Brett Cannon27fc5282012-04-15 14:15:31 -04001405 }
Antoine Pitrou71382cb2012-04-16 18:48:49 +02001406 mod = NULL;
Brett Cannonfd074152012-04-14 14:10:13 -04001407 goto error_with_unlock;
1408 }
1409 else if (mod != NULL) {
Antoine Pitrouea3eb882012-05-17 18:55:59 +02001410 PyObject *value;
1411 int initializing = 0;
1412
Brett Cannonfd074152012-04-14 14:10:13 -04001413 Py_INCREF(mod);
Antoine Pitrou03989852012-08-28 00:24:52 +02001414 /* Optimization: only call _bootstrap._lock_unlock_module() if
1415 __initializing__ is true.
1416 NOTE: because of this, __initializing__ must be set *before*
1417 stuffing the new module in sys.modules.
1418 */
Antoine Pitrouea3eb882012-05-17 18:55:59 +02001419 value = _PyObject_GetAttrId(mod, &PyId___initializing__);
1420 if (value == NULL)
1421 PyErr_Clear();
1422 else {
1423 initializing = PyObject_IsTrue(value);
1424 Py_DECREF(value);
1425 if (initializing == -1)
1426 PyErr_Clear();
1427 }
1428 if (initializing > 0) {
1429 /* _bootstrap._lock_unlock_module() releases the import lock */
1430 value = _PyObject_CallMethodObjIdArgs(interp->importlib,
1431 &PyId__lock_unlock_module, abs_name,
1432 NULL);
1433 if (value == NULL)
1434 goto error;
1435 Py_DECREF(value);
1436 }
1437 else {
1438#ifdef WITH_THREAD
1439 if (_PyImport_ReleaseLock() < 0) {
1440 PyErr_SetString(PyExc_RuntimeError, "not holding the import lock");
1441 goto error;
1442 }
1443#endif
1444 }
Brett Cannonfd074152012-04-14 14:10:13 -04001445 }
1446 else {
Antoine Pitrouea3eb882012-05-17 18:55:59 +02001447 /* _bootstrap._find_and_load() releases the import lock */
Brett Cannonfd074152012-04-14 14:10:13 -04001448 mod = _PyObject_CallMethodObjIdArgs(interp->importlib,
1449 &PyId__find_and_load, abs_name,
1450 builtins_import, NULL);
1451 if (mod == NULL) {
Antoine Pitrouea3eb882012-05-17 18:55:59 +02001452 goto error;
Brett Cannonfd074152012-04-14 14:10:13 -04001453 }
1454 }
Antoine Pitrouea3eb882012-05-17 18:55:59 +02001455 /* From now on we don't hold the import lock anymore. */
Brett Cannonfd074152012-04-14 14:10:13 -04001456
1457 if (PyObject_Not(fromlist)) {
1458 if (level == 0 || PyUnicode_GET_LENGTH(name) > 0) {
1459 PyObject *front = NULL;
Brian Curtine6b299f2012-04-14 14:19:33 -05001460 PyObject *partition = NULL;
Brett Cannonfd074152012-04-14 14:10:13 -04001461 PyObject *borrowed_dot = _PyUnicode_FromId(&single_dot);
1462
1463 if (borrowed_dot == NULL) {
Antoine Pitrouea3eb882012-05-17 18:55:59 +02001464 goto error;
Brett Cannonfd074152012-04-14 14:10:13 -04001465 }
1466
Brian Curtine6b299f2012-04-14 14:19:33 -05001467 partition = PyUnicode_Partition(name, borrowed_dot);
Brett Cannonfd074152012-04-14 14:10:13 -04001468 if (partition == NULL) {
Antoine Pitrouea3eb882012-05-17 18:55:59 +02001469 goto error;
Brett Cannonfd074152012-04-14 14:10:13 -04001470 }
1471
Antoine Pitrou6efa50a2012-05-07 21:41:59 +02001472 if (PyUnicode_GET_LENGTH(PyTuple_GET_ITEM(partition, 1)) == 0) {
1473 /* No dot in module name, simple exit */
1474 Py_DECREF(partition);
1475 final_mod = mod;
1476 Py_INCREF(mod);
Antoine Pitrouea3eb882012-05-17 18:55:59 +02001477 goto error;
Antoine Pitrou6efa50a2012-05-07 21:41:59 +02001478 }
1479
Brett Cannonfd074152012-04-14 14:10:13 -04001480 front = PyTuple_GET_ITEM(partition, 0);
1481 Py_INCREF(front);
1482 Py_DECREF(partition);
1483
1484 if (level == 0) {
Antoine Pitrou6efa50a2012-05-07 21:41:59 +02001485 final_mod = PyObject_CallFunctionObjArgs(builtins_import, front, NULL);
Antoine Pitroub78174c2012-05-06 17:15:23 +02001486 Py_DECREF(front);
Brett Cannonfd074152012-04-14 14:10:13 -04001487 }
1488 else {
Antoine Pitrou22a1d172012-04-16 22:06:21 +02001489 Py_ssize_t cut_off = PyUnicode_GET_LENGTH(name) -
1490 PyUnicode_GET_LENGTH(front);
1491 Py_ssize_t abs_name_len = PyUnicode_GET_LENGTH(abs_name);
Brett Cannon49f8d8b2012-04-14 21:50:00 -04001492 PyObject *to_return = PyUnicode_Substring(abs_name, 0,
Brett Cannonfd074152012-04-14 14:10:13 -04001493 abs_name_len - cut_off);
Antoine Pitrou22a1d172012-04-16 22:06:21 +02001494 Py_DECREF(front);
1495 if (to_return == NULL) {
Antoine Pitrouea3eb882012-05-17 18:55:59 +02001496 goto error;
Antoine Pitrou22a1d172012-04-16 22:06:21 +02001497 }
Brett Cannonfd074152012-04-14 14:10:13 -04001498
1499 final_mod = PyDict_GetItem(interp->modules, to_return);
Brett Cannon49f8d8b2012-04-14 21:50:00 -04001500 if (final_mod == NULL) {
1501 PyErr_Format(PyExc_KeyError,
1502 "%R not in sys.modules as expected",
1503 to_return);
1504 }
1505 else {
1506 Py_INCREF(final_mod);
1507 }
Antoine Pitroub78174c2012-05-06 17:15:23 +02001508 Py_DECREF(to_return);
Brett Cannonfd074152012-04-14 14:10:13 -04001509 }
1510 }
1511 else {
1512 final_mod = mod;
1513 Py_INCREF(mod);
1514 }
1515 }
1516 else {
1517 final_mod = _PyObject_CallMethodObjIdArgs(interp->importlib,
1518 &PyId__handle_fromlist, mod,
1519 fromlist, builtins_import,
1520 NULL);
1521 }
Antoine Pitrouea3eb882012-05-17 18:55:59 +02001522 goto error;
Antoine Pitrou6efa50a2012-05-07 21:41:59 +02001523
Brett Cannonfd074152012-04-14 14:10:13 -04001524 error_with_unlock:
Brian Curtine6b299f2012-04-14 14:19:33 -05001525#ifdef WITH_THREAD
Brett Cannonfd074152012-04-14 14:10:13 -04001526 if (_PyImport_ReleaseLock() < 0) {
1527 PyErr_SetString(PyExc_RuntimeError, "not holding the import lock");
1528 }
1529#endif
1530 error:
1531 Py_XDECREF(abs_name);
1532 Py_XDECREF(builtins_import);
1533 Py_XDECREF(mod);
1534 Py_XDECREF(package);
1535 Py_XDECREF(globals);
1536 Py_XDECREF(fromlist);
Antoine Pitroubc07a5c2012-07-08 12:01:27 +02001537 if (final_mod == NULL)
1538 remove_importlib_frames();
Brett Cannonfd074152012-04-14 14:10:13 -04001539 return final_mod;
Guido van Rossum75acc9c1998-03-03 22:26:50 +00001540}
1541
Victor Stinnerfe93faf2011-03-14 15:54:52 -04001542PyObject *
Benjamin Peterson04778a82011-05-25 09:29:00 -05001543PyImport_ImportModuleLevel(const char *name, PyObject *globals, PyObject *locals,
Victor Stinnerfe93faf2011-03-14 15:54:52 -04001544 PyObject *fromlist, int level)
1545{
1546 PyObject *nameobj, *mod;
1547 nameobj = PyUnicode_FromString(name);
1548 if (nameobj == NULL)
1549 return NULL;
1550 mod = PyImport_ImportModuleLevelObject(nameobj, globals, locals,
1551 fromlist, level);
1552 Py_DECREF(nameobj);
1553 return mod;
1554}
1555
1556
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001557/* Re-import a module of any kind and return its module object, WITH
1558 INCREMENTED REFERENCE COUNT */
1559
Guido van Rossum79f25d91997-04-29 20:08:16 +00001560PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001561PyImport_ReloadModule(PyObject *m)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001562{
Brett Cannon62228db2012-04-29 14:38:11 -04001563 _Py_IDENTIFIER(reload);
1564 PyObject *reloaded_module = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001565 PyObject *modules = PyImport_GetModuleDict();
Brett Cannon62228db2012-04-29 14:38:11 -04001566 PyObject *imp = PyDict_GetItemString(modules, "imp");
1567 if (imp == NULL) {
1568 imp = PyImport_ImportModule("imp");
1569 if (imp == NULL) {
1570 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001571 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001572 }
Brett Cannon62228db2012-04-29 14:38:11 -04001573 else {
1574 Py_INCREF(imp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001575 }
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001576
Brett Cannon62228db2012-04-29 14:38:11 -04001577 reloaded_module = _PyObject_CallMethodId(imp, &PyId_reload, "O", m);
1578 Py_DECREF(imp);
1579 return reloaded_module;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001580}
1581
1582
Guido van Rossumd47a0a81997-08-14 20:11:26 +00001583/* Higher-level import emulator which emulates the "import" statement
1584 more accurately -- it invokes the __import__() function from the
1585 builtins of the current globals. This means that the import is
1586 done using whatever import hooks are installed in the current
Brett Cannonbc2eff32010-09-19 21:39:02 +00001587 environment.
Guido van Rossum6058eb41998-12-21 19:51:00 +00001588 A dummy list ["__doc__"] is passed as the 4th argument so that
Neal Norwitz80e7f272007-08-26 06:45:23 +00001589 e.g. PyImport_Import(PyUnicode_FromString("win32com.client.gencache"))
Guido van Rossum6058eb41998-12-21 19:51:00 +00001590 will return <module "gencache"> instead of <module "win32com">. */
Guido van Rossumd47a0a81997-08-14 20:11:26 +00001591
1592PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001593PyImport_Import(PyObject *module_name)
Guido van Rossumd47a0a81997-08-14 20:11:26 +00001594{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001595 static PyObject *silly_list = NULL;
1596 static PyObject *builtins_str = NULL;
1597 static PyObject *import_str = NULL;
1598 PyObject *globals = NULL;
1599 PyObject *import = NULL;
1600 PyObject *builtins = NULL;
Brett Cannonbc2eff32010-09-19 21:39:02 +00001601 PyObject *modules = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001602 PyObject *r = NULL;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00001603
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001604 /* Initialize constant string objects */
1605 if (silly_list == NULL) {
1606 import_str = PyUnicode_InternFromString("__import__");
1607 if (import_str == NULL)
1608 return NULL;
1609 builtins_str = PyUnicode_InternFromString("__builtins__");
1610 if (builtins_str == NULL)
1611 return NULL;
Brett Cannonbc2eff32010-09-19 21:39:02 +00001612 silly_list = PyList_New(0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001613 if (silly_list == NULL)
1614 return NULL;
1615 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00001616
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001617 /* Get the builtins from current globals */
1618 globals = PyEval_GetGlobals();
1619 if (globals != NULL) {
1620 Py_INCREF(globals);
1621 builtins = PyObject_GetItem(globals, builtins_str);
1622 if (builtins == NULL)
1623 goto err;
1624 }
1625 else {
1626 /* No globals -- use standard builtins, and fake globals */
1627 builtins = PyImport_ImportModuleLevel("builtins",
1628 NULL, NULL, NULL, 0);
1629 if (builtins == NULL)
1630 return NULL;
1631 globals = Py_BuildValue("{OO}", builtins_str, builtins);
1632 if (globals == NULL)
1633 goto err;
1634 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00001635
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001636 /* Get the __import__ function from the builtins */
1637 if (PyDict_Check(builtins)) {
1638 import = PyObject_GetItem(builtins, import_str);
1639 if (import == NULL)
1640 PyErr_SetObject(PyExc_KeyError, import_str);
1641 }
1642 else
1643 import = PyObject_GetAttr(builtins, import_str);
1644 if (import == NULL)
1645 goto err;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00001646
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001647 /* Call the __import__ function with the proper argument list
Brett Cannonbc2eff32010-09-19 21:39:02 +00001648 Always use absolute import here.
1649 Calling for side-effect of import. */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001650 r = PyObject_CallFunction(import, "OOOOi", module_name, globals,
1651 globals, silly_list, 0, NULL);
Brett Cannonbc2eff32010-09-19 21:39:02 +00001652 if (r == NULL)
1653 goto err;
1654 Py_DECREF(r);
1655
1656 modules = PyImport_GetModuleDict();
1657 r = PyDict_GetItem(modules, module_name);
1658 if (r != NULL)
1659 Py_INCREF(r);
Guido van Rossumd47a0a81997-08-14 20:11:26 +00001660
1661 err:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001662 Py_XDECREF(globals);
1663 Py_XDECREF(builtins);
1664 Py_XDECREF(import);
Tim Peters50d8d372001-02-28 05:34:27 +00001665
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001666 return r;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00001667}
1668
Barry Warsaw28a691b2010-04-17 00:19:56 +00001669static PyObject *
Brett Cannon2657df42012-05-04 15:20:40 -04001670imp_extension_suffixes(PyObject *self, PyObject *noargs)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001671{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001672 PyObject *list;
Brett Cannon2657df42012-05-04 15:20:40 -04001673 const char *suffix;
1674 unsigned int index = 0;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001675
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001676 list = PyList_New(0);
1677 if (list == NULL)
1678 return NULL;
Brett Cannon2657df42012-05-04 15:20:40 -04001679#ifdef HAVE_DYNAMIC_LOADING
1680 while ((suffix = _PyImport_DynLoadFiletab[index])) {
1681 PyObject *item = PyUnicode_FromString(suffix);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001682 if (item == NULL) {
1683 Py_DECREF(list);
1684 return NULL;
1685 }
1686 if (PyList_Append(list, item) < 0) {
1687 Py_DECREF(list);
1688 Py_DECREF(item);
1689 return NULL;
1690 }
1691 Py_DECREF(item);
Brett Cannon2657df42012-05-04 15:20:40 -04001692 index += 1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001693 }
Brett Cannon2657df42012-05-04 15:20:40 -04001694#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001695 return list;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001696}
1697
Guido van Rossum79f25d91997-04-29 20:08:16 +00001698static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001699imp_init_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001700{
Victor Stinner95872862011-03-07 18:20:56 +01001701 PyObject *name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001702 int ret;
1703 PyObject *m;
Victor Stinner95872862011-03-07 18:20:56 +01001704 if (!PyArg_ParseTuple(args, "U:init_builtin", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001705 return NULL;
1706 ret = init_builtin(name);
1707 if (ret < 0)
1708 return NULL;
1709 if (ret == 0) {
1710 Py_INCREF(Py_None);
1711 return Py_None;
1712 }
Victor Stinner95872862011-03-07 18:20:56 +01001713 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001714 Py_XINCREF(m);
1715 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001716}
1717
Guido van Rossum79f25d91997-04-29 20:08:16 +00001718static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001719imp_init_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001720{
Victor Stinner53dc7352011-03-20 01:50:21 +01001721 PyObject *name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001722 int ret;
1723 PyObject *m;
Victor Stinner53dc7352011-03-20 01:50:21 +01001724 if (!PyArg_ParseTuple(args, "U:init_frozen", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001725 return NULL;
Victor Stinner53dc7352011-03-20 01:50:21 +01001726 ret = PyImport_ImportFrozenModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001727 if (ret < 0)
1728 return NULL;
1729 if (ret == 0) {
1730 Py_INCREF(Py_None);
1731 return Py_None;
1732 }
Victor Stinner53dc7352011-03-20 01:50:21 +01001733 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001734 Py_XINCREF(m);
1735 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001736}
1737
Guido van Rossum79f25d91997-04-29 20:08:16 +00001738static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001739imp_get_frozen_object(PyObject *self, PyObject *args)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001740{
Victor Stinner53dc7352011-03-20 01:50:21 +01001741 PyObject *name;
Jack Jansen95ffa231995-10-03 14:38:41 +00001742
Victor Stinner53dc7352011-03-20 01:50:21 +01001743 if (!PyArg_ParseTuple(args, "U:get_frozen_object", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001744 return NULL;
1745 return get_frozen_object(name);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001746}
1747
Guido van Rossum79f25d91997-04-29 20:08:16 +00001748static PyObject *
Brett Cannon8d110132009-03-15 02:20:16 +00001749imp_is_frozen_package(PyObject *self, PyObject *args)
1750{
Victor Stinner53dc7352011-03-20 01:50:21 +01001751 PyObject *name;
Brett Cannon8d110132009-03-15 02:20:16 +00001752
Victor Stinner53dc7352011-03-20 01:50:21 +01001753 if (!PyArg_ParseTuple(args, "U:is_frozen_package", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001754 return NULL;
1755 return is_frozen_package(name);
Brett Cannon8d110132009-03-15 02:20:16 +00001756}
1757
1758static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001759imp_is_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001760{
Victor Stinner95872862011-03-07 18:20:56 +01001761 PyObject *name;
1762 if (!PyArg_ParseTuple(args, "U:is_builtin", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001763 return NULL;
1764 return PyLong_FromLong(is_builtin(name));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001765}
1766
Guido van Rossum79f25d91997-04-29 20:08:16 +00001767static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001768imp_is_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001769{
Victor Stinner53dc7352011-03-20 01:50:21 +01001770 PyObject *name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001771 struct _frozen *p;
Victor Stinner53dc7352011-03-20 01:50:21 +01001772 if (!PyArg_ParseTuple(args, "U:is_frozen", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001773 return NULL;
1774 p = find_frozen(name);
1775 return PyBool_FromLong((long) (p == NULL ? 0 : p->size));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001776}
1777
Guido van Rossum96a8fb71999-12-22 14:09:35 +00001778#ifdef HAVE_DYNAMIC_LOADING
1779
Guido van Rossum79f25d91997-04-29 20:08:16 +00001780static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001781imp_load_dynamic(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001782{
Victor Stinnerfefd70c2011-03-14 15:54:07 -04001783 PyObject *name, *pathname, *fob = NULL, *mod;
1784 FILE *fp;
1785
1786 if (!PyArg_ParseTuple(args, "UO&|O:load_dynamic",
1787 &name, PyUnicode_FSDecoder, &pathname, &fob))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001788 return NULL;
Victor Stinnerfefd70c2011-03-14 15:54:07 -04001789 if (fob != NULL) {
Antoine Pitrouf3a42de2012-05-04 22:40:25 +02001790 fp = _Py_fopen(pathname, "r");
Victor Stinnere9ddbf62011-03-22 10:46:35 +01001791 if (fp == NULL) {
1792 Py_DECREF(pathname);
Antoine Pitrouf3a42de2012-05-04 22:40:25 +02001793 if (!PyErr_Occurred())
1794 PyErr_SetFromErrno(PyExc_IOError);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001795 return NULL;
Victor Stinnere9ddbf62011-03-22 10:46:35 +01001796 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001797 }
Victor Stinnerfefd70c2011-03-14 15:54:07 -04001798 else
1799 fp = NULL;
1800 mod = _PyImport_LoadDynamicModule(name, pathname, fp);
Victor Stinnere9ddbf62011-03-22 10:46:35 +01001801 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001802 if (fp)
1803 fclose(fp);
Victor Stinnerfefd70c2011-03-14 15:54:07 -04001804 return mod;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001805}
1806
Guido van Rossum96a8fb71999-12-22 14:09:35 +00001807#endif /* HAVE_DYNAMIC_LOADING */
1808
Barry Warsaw28a691b2010-04-17 00:19:56 +00001809
Guido van Rossum0207e6d1997-09-09 22:04:42 +00001810/* Doc strings */
1811
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001812PyDoc_STRVAR(doc_imp,
Brett Cannon6f44d662012-04-15 16:08:47 -04001813"(Extremely) low-level import machinery bits as used by importlib and imp.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00001814
Brett Cannon2657df42012-05-04 15:20:40 -04001815PyDoc_STRVAR(doc_extension_suffixes,
1816"extension_suffixes() -> list of strings\n\
1817Returns the list of file suffixes used to identify extension modules.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00001818
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001819PyDoc_STRVAR(doc_lock_held,
Tim Petersa7c65092004-08-01 23:26:05 +00001820"lock_held() -> boolean\n\
1821Return True if the import lock is currently held, else False.\n\
1822On platforms without threads, return False.");
Tim Peters69232342001-08-30 05:16:13 +00001823
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00001824PyDoc_STRVAR(doc_acquire_lock,
1825"acquire_lock() -> None\n\
Neal Norwitz2294c0d2003-02-12 23:02:21 +00001826Acquires the interpreter's import lock for the current thread.\n\
1827This lock should be used by import hooks to ensure thread-safety\n\
1828when importing modules.\n\
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00001829On platforms without threads, this function does nothing.");
1830
1831PyDoc_STRVAR(doc_release_lock,
1832"release_lock() -> None\n\
1833Release the interpreter's import lock.\n\
1834On platforms without threads, this function does nothing.");
1835
Guido van Rossum79f25d91997-04-29 20:08:16 +00001836static PyMethodDef imp_methods[] = {
Brett Cannon2657df42012-05-04 15:20:40 -04001837 {"extension_suffixes", imp_extension_suffixes, METH_NOARGS,
1838 doc_extension_suffixes},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001839 {"lock_held", imp_lock_held, METH_NOARGS, doc_lock_held},
1840 {"acquire_lock", imp_acquire_lock, METH_NOARGS, doc_acquire_lock},
1841 {"release_lock", imp_release_lock, METH_NOARGS, doc_release_lock},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001842 {"get_frozen_object", imp_get_frozen_object, METH_VARARGS},
1843 {"is_frozen_package", imp_is_frozen_package, METH_VARARGS},
1844 {"init_builtin", imp_init_builtin, METH_VARARGS},
1845 {"init_frozen", imp_init_frozen, METH_VARARGS},
1846 {"is_builtin", imp_is_builtin, METH_VARARGS},
1847 {"is_frozen", imp_is_frozen, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00001848#ifdef HAVE_DYNAMIC_LOADING
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001849 {"load_dynamic", imp_load_dynamic, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00001850#endif
Brett Cannon442c9b92011-03-23 16:14:42 -07001851 {"_fix_co_filename", imp_fix_co_filename, METH_VARARGS},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001852 {NULL, NULL} /* sentinel */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001853};
1854
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001855
Martin v. Löwis1a214512008-06-11 05:26:20 +00001856static struct PyModuleDef impmodule = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001857 PyModuleDef_HEAD_INIT,
Brett Cannon6f44d662012-04-15 16:08:47 -04001858 "_imp",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001859 doc_imp,
1860 0,
1861 imp_methods,
1862 NULL,
1863 NULL,
1864 NULL,
1865 NULL
Martin v. Löwis1a214512008-06-11 05:26:20 +00001866};
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001867
Jason Tishler6bc06ec2003-09-04 11:59:50 +00001868PyMODINIT_FUNC
Martin v. Löwis1a214512008-06-11 05:26:20 +00001869PyInit_imp(void)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001870{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001871 PyObject *m, *d;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001872
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001873 m = PyModule_Create(&impmodule);
1874 if (m == NULL)
1875 goto failure;
1876 d = PyModule_GetDict(m);
1877 if (d == NULL)
1878 goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001879
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001880 return m;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001881 failure:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001882 Py_XDECREF(m);
1883 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001884}
Guido van Rossum09cae1f1998-05-14 02:32:54 +00001885
1886
Guido van Rossumb18618d2000-05-03 23:44:39 +00001887/* API for embedding applications that want to add their own entries
1888 to the table of built-in modules. This should normally be called
1889 *before* Py_Initialize(). When the table resize fails, -1 is
1890 returned and the existing table is unchanged.
Guido van Rossum09cae1f1998-05-14 02:32:54 +00001891
1892 After a similar function by Just van Rossum. */
1893
1894int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001895PyImport_ExtendInittab(struct _inittab *newtab)
Guido van Rossum09cae1f1998-05-14 02:32:54 +00001896{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001897 static struct _inittab *our_copy = NULL;
1898 struct _inittab *p;
1899 int i, n;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00001900
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001901 /* Count the number of entries in both tables */
1902 for (n = 0; newtab[n].name != NULL; n++)
1903 ;
1904 if (n == 0)
1905 return 0; /* Nothing to do */
1906 for (i = 0; PyImport_Inittab[i].name != NULL; i++)
1907 ;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00001908
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001909 /* Allocate new memory for the combined table */
1910 p = our_copy;
1911 PyMem_RESIZE(p, struct _inittab, i+n+1);
1912 if (p == NULL)
1913 return -1;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00001914
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001915 /* Copy the tables into the new memory */
1916 if (our_copy != PyImport_Inittab)
1917 memcpy(p, PyImport_Inittab, (i+1) * sizeof(struct _inittab));
1918 PyImport_Inittab = our_copy = p;
1919 memcpy(p+i, newtab, (n+1) * sizeof(struct _inittab));
Guido van Rossum09cae1f1998-05-14 02:32:54 +00001920
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001921 return 0;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00001922}
1923
1924/* Shorthand to add a single entry given a name and a function */
1925
1926int
Brett Cannona826f322009-04-02 03:41:46 +00001927PyImport_AppendInittab(const char *name, PyObject* (*initfunc)(void))
Guido van Rossum09cae1f1998-05-14 02:32:54 +00001928{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001929 struct _inittab newtab[2];
Guido van Rossum09cae1f1998-05-14 02:32:54 +00001930
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001931 memset(newtab, '\0', sizeof newtab);
Guido van Rossum09cae1f1998-05-14 02:32:54 +00001932
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001933 newtab[0].name = (char *)name;
1934 newtab[0].initfunc = initfunc;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00001935
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001936 return PyImport_ExtendInittab(newtab);
Guido van Rossum09cae1f1998-05-14 02:32:54 +00001937}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001938
1939#ifdef __cplusplus
1940}
1941#endif