blob: 113123d56495e0be9d65fee55001717e4f8fe7ef [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
Barry Warsaw28a691b2010-04-17 00:19:56 +000022#define CACHEDIR "__pycache__"
Guido van Rossum96774c12000-05-01 20:19:08 +000023
Victor Stinner95872862011-03-07 18:20:56 +010024/* See _PyImport_FixupExtensionObject() below */
Guido van Rossum25ce5661997-08-02 03:10:38 +000025static PyObject *extensions = NULL;
Guido van Rossum3f5da241990-12-20 15:06:42 +000026
Victor Stinnerfe7c5b52011-04-05 01:48:03 +020027/* Function from Parser/tokenizer.c */
28extern char * PyTokenizer_FindEncodingFilename(int, PyObject *);
29
Guido van Rossum771c6c81997-10-31 18:37:24 +000030/* This table is defined in config.c: */
31extern struct _inittab _PyImport_Inittab[];
32
33struct _inittab *PyImport_Inittab = _PyImport_Inittab;
Guido van Rossum66f1fa81991-04-03 19:03:52 +000034
Victor Stinnerd0296212011-03-14 14:04:10 -040035static PyObject *initstr = NULL;
Thomas Wouters0e3f5912006-08-11 14:57:12 +000036
Guido van Rossum1ae940a1995-01-02 19:04:15 +000037/* Initialize things */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000038
39void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +000040_PyImport_Init(void)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000041{
Victor Stinnerd0296212011-03-14 14:04:10 -040042 initstr = PyUnicode_InternFromString("__init__");
43 if (initstr == NULL)
44 Py_FatalError("Can't initialize import variables");
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000045}
46
Guido van Rossum25ce5661997-08-02 03:10:38 +000047void
Just van Rossum52e14d62002-12-30 22:08:05 +000048_PyImportHooks_Init(void)
49{
Brett Cannonfd074152012-04-14 14:10:13 -040050 PyObject *v, *path_hooks = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000051 int err = 0;
Just van Rossum52e14d62002-12-30 22:08:05 +000052
Brett Cannonfd074152012-04-14 14:10:13 -040053 /* adding sys.path_hooks and sys.path_importer_cache */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000054 v = PyList_New(0);
55 if (v == NULL)
56 goto error;
57 err = PySys_SetObject("meta_path", v);
58 Py_DECREF(v);
59 if (err)
60 goto error;
61 v = PyDict_New();
62 if (v == NULL)
63 goto error;
64 err = PySys_SetObject("path_importer_cache", v);
65 Py_DECREF(v);
66 if (err)
67 goto error;
68 path_hooks = PyList_New(0);
69 if (path_hooks == NULL)
70 goto error;
71 err = PySys_SetObject("path_hooks", path_hooks);
72 if (err) {
Just van Rossum52e14d62002-12-30 22:08:05 +000073 error:
Brett Cannonfd074152012-04-14 14:10:13 -040074 PyErr_Print();
75 Py_FatalError("initializing sys.meta_path, sys.path_hooks, "
Nadeem Vawda8f46d652012-05-05 12:27:30 +020076 "or path_importer_cache failed");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000077 }
Brett Cannonfd074152012-04-14 14:10:13 -040078 Py_DECREF(path_hooks);
79}
80
81void
82_PyImportZip_Init(void)
83{
84 PyObject *path_hooks, *zimpimport;
85 int err = 0;
86
87 path_hooks = PySys_GetObject("path_hooks");
Victor Stinner1e53bba2013-07-16 22:26:05 +020088 if (path_hooks == NULL) {
89 PyErr_SetString(PyExc_RuntimeError, "unable to get sys.path_hooks");
Brett Cannonfd074152012-04-14 14:10:13 -040090 goto error;
Victor Stinner1e53bba2013-07-16 22:26:05 +020091 }
Brett Cannonfd074152012-04-14 14:10:13 -040092
93 if (Py_VerboseFlag)
94 PySys_WriteStderr("# installing zipimport hook\n");
Thomas Wouters0e3f5912006-08-11 14:57:12 +000095
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000096 zimpimport = PyImport_ImportModule("zipimport");
97 if (zimpimport == NULL) {
98 PyErr_Clear(); /* No zip import module -- okay */
99 if (Py_VerboseFlag)
100 PySys_WriteStderr("# can't import zipimport\n");
101 }
102 else {
Martin v. Löwisbd928fe2011-10-14 10:20:37 +0200103 _Py_IDENTIFIER(zipimporter);
Martin v. Löwis1ee1b6f2011-10-10 18:11:30 +0200104 PyObject *zipimporter = _PyObject_GetAttrId(zimpimport,
105 &PyId_zipimporter);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000106 Py_DECREF(zimpimport);
107 if (zipimporter == NULL) {
108 PyErr_Clear(); /* No zipimporter object -- okay */
109 if (Py_VerboseFlag)
110 PySys_WriteStderr(
111 "# can't import zipimport.zipimporter\n");
112 }
113 else {
Brett Cannon8923a4d2012-04-24 22:03:46 -0400114 /* sys.path_hooks.insert(0, zipimporter) */
115 err = PyList_Insert(path_hooks, 0, zipimporter);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000116 Py_DECREF(zipimporter);
Brett Cannonfd074152012-04-14 14:10:13 -0400117 if (err < 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000118 goto error;
Brett Cannonfd074152012-04-14 14:10:13 -0400119 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000120 if (Py_VerboseFlag)
121 PySys_WriteStderr(
122 "# installed zipimport hook\n");
123 }
124 }
Brett Cannonfd074152012-04-14 14:10:13 -0400125
126 return;
127
128 error:
129 PyErr_Print();
Brett Cannonacf85cd2012-04-29 12:50:03 -0400130 Py_FatalError("initializing zipimport failed");
Just van Rossum52e14d62002-12-30 22:08:05 +0000131}
132
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000133/* Locking primitives to prevent parallel imports of the same module
134 in different threads to return with a partially loaded module.
135 These calls are serialized by the global interpreter lock. */
136
137#ifdef WITH_THREAD
138
Guido van Rossum49b56061998-10-01 20:42:43 +0000139#include "pythread.h"
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000140
Guido van Rossum65d5b571998-12-21 19:32:43 +0000141static PyThread_type_lock import_lock = 0;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000142static long import_lock_thread = -1;
143static int import_lock_level = 0;
144
Benjamin Peterson0df35a92009-10-04 20:32:25 +0000145void
146_PyImport_AcquireLock(void)
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000147{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000148 long me = PyThread_get_thread_ident();
149 if (me == -1)
150 return; /* Too bad */
151 if (import_lock == NULL) {
152 import_lock = PyThread_allocate_lock();
153 if (import_lock == NULL)
154 return; /* Nothing much we can do. */
155 }
156 if (import_lock_thread == me) {
157 import_lock_level++;
158 return;
159 }
160 if (import_lock_thread != -1 || !PyThread_acquire_lock(import_lock, 0))
161 {
162 PyThreadState *tstate = PyEval_SaveThread();
163 PyThread_acquire_lock(import_lock, 1);
164 PyEval_RestoreThread(tstate);
165 }
Antoine Pitrou202b6062012-12-18 22:18:17 +0100166 assert(import_lock_level == 0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000167 import_lock_thread = me;
168 import_lock_level = 1;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000169}
170
Benjamin Peterson0df35a92009-10-04 20:32:25 +0000171int
172_PyImport_ReleaseLock(void)
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000173{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000174 long me = PyThread_get_thread_ident();
175 if (me == -1 || import_lock == NULL)
176 return 0; /* Too bad */
177 if (import_lock_thread != me)
178 return -1;
179 import_lock_level--;
Antoine Pitrou202b6062012-12-18 22:18:17 +0100180 assert(import_lock_level >= 0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000181 if (import_lock_level == 0) {
182 import_lock_thread = -1;
183 PyThread_release_lock(import_lock);
184 }
185 return 1;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000186}
187
Gregory P. Smith24cec9f2010-03-01 06:18:41 +0000188/* This function is called from PyOS_AfterFork to ensure that newly
189 created child processes do not share locks with the parent.
190 We now acquire the import lock around fork() calls but on some platforms
191 (Solaris 9 and earlier? see isue7242) that still left us with problems. */
Guido van Rossum8ee3e5a2005-09-14 18:09:42 +0000192
193void
194_PyImport_ReInitLock(void)
195{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000196 if (import_lock != NULL)
197 import_lock = PyThread_allocate_lock();
Nick Coghlanb2ddf792010-12-02 04:11:46 +0000198 if (import_lock_level > 1) {
199 /* Forked as a side effect of import */
200 long me = PyThread_get_thread_ident();
Brett Cannone4710cf2012-11-15 21:39:36 -0500201 /* The following could fail if the lock is already held, but forking as
202 a side-effect of an import is a) rare, b) nuts, and c) difficult to
203 do thanks to the lock only being held when doing individual module
204 locks per import. */
205 PyThread_acquire_lock(import_lock, NOWAIT_LOCK);
Nick Coghlanb2ddf792010-12-02 04:11:46 +0000206 import_lock_thread = me;
207 import_lock_level--;
208 } else {
209 import_lock_thread = -1;
210 import_lock_level = 0;
211 }
Guido van Rossum8ee3e5a2005-09-14 18:09:42 +0000212}
213
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000214#endif
215
Tim Peters69232342001-08-30 05:16:13 +0000216static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000217imp_lock_held(PyObject *self, PyObject *noargs)
Tim Peters69232342001-08-30 05:16:13 +0000218{
Tim Peters69232342001-08-30 05:16:13 +0000219#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000220 return PyBool_FromLong(import_lock_thread != -1);
Tim Peters69232342001-08-30 05:16:13 +0000221#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000222 return PyBool_FromLong(0);
Tim Peters69232342001-08-30 05:16:13 +0000223#endif
224}
225
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000226static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000227imp_acquire_lock(PyObject *self, PyObject *noargs)
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000228{
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000229#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000230 _PyImport_AcquireLock();
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000231#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000232 Py_INCREF(Py_None);
233 return Py_None;
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000234}
235
236static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000237imp_release_lock(PyObject *self, PyObject *noargs)
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000238{
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000239#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000240 if (_PyImport_ReleaseLock() < 0) {
241 PyErr_SetString(PyExc_RuntimeError,
242 "not holding the import lock");
243 return NULL;
244 }
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000245#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000246 Py_INCREF(Py_None);
247 return Py_None;
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000248}
249
Antoine Pitrou8db076c2011-10-30 19:13:55 +0100250void
251_PyImport_Fini(void)
252{
253 Py_XDECREF(extensions);
254 extensions = NULL;
Antoine Pitrou8db076c2011-10-30 19:13:55 +0100255#ifdef WITH_THREAD
256 if (import_lock != NULL) {
257 PyThread_free_lock(import_lock);
258 import_lock = NULL;
259 }
260#endif
261}
262
Guido van Rossum25ce5661997-08-02 03:10:38 +0000263/* Helper for sys */
264
265PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000266PyImport_GetModuleDict(void)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000267{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000268 PyInterpreterState *interp = PyThreadState_GET()->interp;
269 if (interp->modules == NULL)
270 Py_FatalError("PyImport_GetModuleDict: no module dictionary!");
271 return interp->modules;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000272}
273
Guido van Rossum3f5da241990-12-20 15:06:42 +0000274
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000275/* List of names to clear in sys */
276static char* sys_deletes[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000277 "path", "argv", "ps1", "ps2",
278 "last_type", "last_value", "last_traceback",
279 "path_hooks", "path_importer_cache", "meta_path",
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200280 "__interactivehook__",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000281 /* 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 Rossum1ae940a1995-01-02 19:04:15 +0000293/* Un-initialize things, as good as we can */
Guido van Rossum3f5da241990-12-20 15:06:42 +0000294
Guido van Rossum3f5da241990-12-20 15:06:42 +0000295void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000296PyImport_Cleanup(void)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000297{
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200298 Py_ssize_t pos;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000299 PyObject *key, *value, *dict;
300 PyInterpreterState *interp = PyThreadState_GET()->interp;
301 PyObject *modules = interp->modules;
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200302 PyObject *builtins = interp->builtins;
303 PyObject *weaklist = NULL;
Guido van Rossum758eec01998-01-19 21:58:26 +0000304
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000305 if (modules == NULL)
306 return; /* Already done */
Guido van Rossum758eec01998-01-19 21:58:26 +0000307
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000308 /* Delete some special variables first. These are common
309 places where user values hide and people complain when their
310 destructors fail. Since the modules containing them are
311 deleted *last* of all, they would come too late in the normal
312 destruction order. Sigh. */
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000313
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200314 /* XXX Perhaps these precautions are obsolete. Who knows? */
315
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000316 value = PyDict_GetItemString(modules, "builtins");
317 if (value != NULL && PyModule_Check(value)) {
318 dict = PyModule_GetDict(value);
319 if (Py_VerboseFlag)
320 PySys_WriteStderr("# clear builtins._\n");
321 PyDict_SetItemString(dict, "_", Py_None);
322 }
323 value = PyDict_GetItemString(modules, "sys");
324 if (value != NULL && PyModule_Check(value)) {
325 char **p;
326 PyObject *v;
327 dict = PyModule_GetDict(value);
328 for (p = sys_deletes; *p != NULL; p++) {
329 if (Py_VerboseFlag)
330 PySys_WriteStderr("# clear sys.%s\n", *p);
331 PyDict_SetItemString(dict, *p, Py_None);
332 }
333 for (p = sys_files; *p != NULL; p+=2) {
334 if (Py_VerboseFlag)
335 PySys_WriteStderr("# restore sys.%s\n", *p);
336 v = PyDict_GetItemString(dict, *(p+1));
337 if (v == NULL)
338 v = Py_None;
339 PyDict_SetItemString(dict, *p, v);
340 }
341 }
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000342
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200343 /* We prepare a list which will receive (name, weakref) tuples of
344 modules when they are removed from sys.modules. The name is used
345 for diagnosis messages (in verbose mode), while the weakref helps
346 detect those modules which have been held alive. */
347 weaklist = PyList_New(0);
Antoine Pitrou79ba3882013-08-06 22:50:15 +0200348 if (weaklist == NULL)
349 PyErr_Clear();
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200350
Antoine Pitrou79ba3882013-08-06 22:50:15 +0200351#define STORE_MODULE_WEAKREF(name, mod) \
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200352 if (weaklist != NULL) { \
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200353 PyObject *wr = PyWeakref_NewRef(mod, NULL); \
354 if (name && wr) { \
355 PyObject *tup = PyTuple_Pack(2, name, wr); \
356 PyList_Append(weaklist, tup); \
357 Py_XDECREF(tup); \
358 } \
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200359 Py_XDECREF(wr); \
360 if (PyErr_Occurred()) \
361 PyErr_Clear(); \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000362 }
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000363
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200364 /* Remove all modules from sys.modules, hoping that garbage collection
365 can reclaim most of them. */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000366 pos = 0;
367 while (PyDict_Next(modules, &pos, &key, &value)) {
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200368 if (PyModule_Check(value)) {
369 if (Py_VerboseFlag && PyUnicode_Check(key))
370 PySys_FormatStderr("# cleanup[2] removing %U\n", key, value);
Antoine Pitrou79ba3882013-08-06 22:50:15 +0200371 STORE_MODULE_WEAKREF(key, value);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000372 PyDict_SetItem(modules, key, Py_None);
373 }
374 }
Guido van Rossum758eec01998-01-19 21:58:26 +0000375
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200376 /* Clear the modules dict. */
377 PyDict_Clear(modules);
378 /* Replace the interpreter's reference to builtins with an empty dict
379 (module globals still have a reference to the original builtins). */
380 builtins = interp->builtins;
381 interp->builtins = PyDict_New();
382 Py_DECREF(builtins);
Antoine Pitrou40322e62013-08-11 00:30:09 +0200383 /* Clear module dict copies stored in the interpreter state */
384 _PyState_ClearModules();
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200385 /* Collect references */
386 _PyGC_CollectNoFail();
Antoine Pitrou5f454a02013-05-06 21:15:57 +0200387 /* Dump GC stats before it's too late, since it uses the warnings
388 machinery. */
389 _PyGC_DumpShutdownStats();
390
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200391 /* Now, if there are any modules left alive, clear their globals to
392 minimize potential leaks. All C extension modules actually end
393 up here, since they are kept alive in the interpreter state. */
394 if (weaklist != NULL) {
395 Py_ssize_t i, n;
396 n = PyList_GET_SIZE(weaklist);
397 for (i = 0; i < n; i++) {
398 PyObject *tup = PyList_GET_ITEM(weaklist, i);
Antoine Pitrou79ba3882013-08-06 22:50:15 +0200399 PyObject *name = PyTuple_GET_ITEM(tup, 0);
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200400 PyObject *mod = PyWeakref_GET_OBJECT(PyTuple_GET_ITEM(tup, 1));
401 if (mod == Py_None)
402 continue;
403 Py_INCREF(mod);
404 assert(PyModule_Check(mod));
Antoine Pitrou79ba3882013-08-06 22:50:15 +0200405 if (Py_VerboseFlag && PyUnicode_Check(name))
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200406 PySys_FormatStderr("# cleanup[3] wiping %U\n",
Antoine Pitrou79ba3882013-08-06 22:50:15 +0200407 name, mod);
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200408 _PyModule_Clear(mod);
409 Py_DECREF(mod);
Antoine Pitrou070cb3c2013-05-08 13:23:25 +0200410 }
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200411 Py_DECREF(weaklist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000412 }
Guido van Rossum758eec01998-01-19 21:58:26 +0000413
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200414 /* Clear and delete the modules directory. Actual modules will
415 still be there only if imported during the execution of some
416 destructor. */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000417 interp->modules = NULL;
418 Py_DECREF(modules);
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200419
420 /* Once more */
421 _PyGC_CollectNoFail();
422
423#undef STORE_MODULE_WEAKREF
Guido van Rossum8d15b5d1990-10-26 14:58:58 +0000424}
Guido van Rossum7f133ed1991-02-19 12:23:57 +0000425
426
Barry Warsaw28a691b2010-04-17 00:19:56 +0000427/* Helper for pythonrun.c -- return magic number and tag. */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000428
429long
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000430PyImport_GetMagicNumber(void)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000431{
Antoine Pitrou44b4b6a2012-07-10 18:27:54 +0200432 long res;
Brett Cannon77b2abd2012-07-09 16:09:00 -0400433 PyInterpreterState *interp = PyThreadState_Get()->interp;
434 PyObject *pyc_magic = PyObject_GetAttrString(interp->importlib,
435 "_RAW_MAGIC_NUMBER");
436 if (pyc_magic == NULL)
437 return -1;
Antoine Pitrou44b4b6a2012-07-10 18:27:54 +0200438 res = PyLong_AsLong(pyc_magic);
Benjamin Peterson66f36592012-07-09 22:21:55 -0700439 Py_DECREF(pyc_magic);
440 return res;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000441}
442
443
Brett Cannon3adc7b72012-07-09 14:22:12 -0400444extern const char * _PySys_ImplCacheTag;
445
Barry Warsaw28a691b2010-04-17 00:19:56 +0000446const char *
447PyImport_GetMagicTag(void)
448{
Brett Cannon3adc7b72012-07-09 14:22:12 -0400449 return _PySys_ImplCacheTag;
Barry Warsaw28a691b2010-04-17 00:19:56 +0000450}
451
Brett Cannon98979b82012-07-02 15:13:11 -0400452
Guido van Rossum25ce5661997-08-02 03:10:38 +0000453/* Magic for extension modules (built-in as well as dynamically
454 loaded). To prevent initializing an extension module more than
Andrew Svetlov6b2cbeb2012-12-14 17:04:59 +0200455 once, we keep a static dictionary 'extensions' keyed by the tuple
456 (module name, module name) (for built-in modules) or by
457 (filename, module name) (for dynamically loaded modules), containing these
458 modules. A copy of the module's dictionary is stored by calling
459 _PyImport_FixupExtensionObject() immediately after the module initialization
460 function succeeds. A copy can be retrieved from there by calling
Victor Stinner95872862011-03-07 18:20:56 +0100461 _PyImport_FindExtensionObject().
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000462
Barry Warsaw7c9627b2010-06-17 18:38:20 +0000463 Modules which do support multiple initialization set their m_size
464 field to a non-negative number (indicating the size of the
465 module-specific state). They are still recorded in the extensions
466 dictionary, to avoid loading shared libraries twice.
Martin v. Löwis1a214512008-06-11 05:26:20 +0000467*/
468
469int
Victor Stinner95872862011-03-07 18:20:56 +0100470_PyImport_FixupExtensionObject(PyObject *mod, PyObject *name,
471 PyObject *filename)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000472{
Benjamin Peterson5cb8a312012-12-15 00:05:16 -0500473 PyObject *modules, *dict, *key;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000474 struct PyModuleDef *def;
Benjamin Peterson5cb8a312012-12-15 00:05:16 -0500475 int res;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000476 if (extensions == NULL) {
477 extensions = PyDict_New();
478 if (extensions == NULL)
479 return -1;
480 }
481 if (mod == NULL || !PyModule_Check(mod)) {
482 PyErr_BadInternalCall();
483 return -1;
484 }
485 def = PyModule_GetDef(mod);
486 if (!def) {
487 PyErr_BadInternalCall();
488 return -1;
489 }
490 modules = PyImport_GetModuleDict();
Victor Stinner95872862011-03-07 18:20:56 +0100491 if (PyDict_SetItem(modules, name, mod) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000492 return -1;
493 if (_PyState_AddModule(mod, def) < 0) {
Victor Stinner95872862011-03-07 18:20:56 +0100494 PyDict_DelItem(modules, name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000495 return -1;
496 }
497 if (def->m_size == -1) {
498 if (def->m_base.m_copy) {
499 /* Somebody already imported the module,
500 likely under a different name.
501 XXX this should really not happen. */
502 Py_DECREF(def->m_base.m_copy);
503 def->m_base.m_copy = NULL;
504 }
505 dict = PyModule_GetDict(mod);
506 if (dict == NULL)
507 return -1;
508 def->m_base.m_copy = PyDict_Copy(dict);
509 if (def->m_base.m_copy == NULL)
510 return -1;
511 }
Benjamin Peterson5cb8a312012-12-15 00:05:16 -0500512 key = PyTuple_Pack(2, filename, name);
513 if (key == NULL)
Andrew Svetlov6b2cbeb2012-12-14 17:04:59 +0200514 return -1;
Benjamin Peterson5cb8a312012-12-15 00:05:16 -0500515 res = PyDict_SetItem(extensions, key, (PyObject *)def);
516 Py_DECREF(key);
517 if (res < 0)
Andrew Svetlov6b2cbeb2012-12-14 17:04:59 +0200518 return -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000519 return 0;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000520}
521
Victor Stinner49d3f252010-10-17 01:24:53 +0000522int
523_PyImport_FixupBuiltin(PyObject *mod, char *name)
524{
525 int res;
Victor Stinner95872862011-03-07 18:20:56 +0100526 PyObject *nameobj;
Victor Stinner21fcd0c2011-03-07 18:28:15 +0100527 nameobj = PyUnicode_InternFromString(name);
Victor Stinner95872862011-03-07 18:20:56 +0100528 if (nameobj == NULL)
Victor Stinner49d3f252010-10-17 01:24:53 +0000529 return -1;
Victor Stinner95872862011-03-07 18:20:56 +0100530 res = _PyImport_FixupExtensionObject(mod, nameobj, nameobj);
531 Py_DECREF(nameobj);
Victor Stinner49d3f252010-10-17 01:24:53 +0000532 return res;
533}
534
Guido van Rossum25ce5661997-08-02 03:10:38 +0000535PyObject *
Victor Stinner95872862011-03-07 18:20:56 +0100536_PyImport_FindExtensionObject(PyObject *name, PyObject *filename)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000537{
Benjamin Peterson5cb8a312012-12-15 00:05:16 -0500538 PyObject *mod, *mdict, *key;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000539 PyModuleDef* def;
540 if (extensions == NULL)
541 return NULL;
Benjamin Peterson5cb8a312012-12-15 00:05:16 -0500542 key = PyTuple_Pack(2, filename, name);
543 if (key == NULL)
Andrew Svetlov6b2cbeb2012-12-14 17:04:59 +0200544 return NULL;
Benjamin Peterson5cb8a312012-12-15 00:05:16 -0500545 def = (PyModuleDef *)PyDict_GetItem(extensions, key);
546 Py_DECREF(key);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000547 if (def == NULL)
548 return NULL;
549 if (def->m_size == -1) {
550 /* Module does not support repeated initialization */
551 if (def->m_base.m_copy == NULL)
552 return NULL;
Victor Stinner95872862011-03-07 18:20:56 +0100553 mod = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000554 if (mod == NULL)
555 return NULL;
556 mdict = PyModule_GetDict(mod);
557 if (mdict == NULL)
558 return NULL;
559 if (PyDict_Update(mdict, def->m_base.m_copy))
560 return NULL;
561 }
562 else {
563 if (def->m_base.m_init == NULL)
564 return NULL;
565 mod = def->m_base.m_init();
566 if (mod == NULL)
567 return NULL;
Christian Heimes09ca7942013-07-20 14:51:53 +0200568 if (PyDict_SetItem(PyImport_GetModuleDict(), name, mod) == -1) {
569 Py_DECREF(mod);
570 return NULL;
571 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000572 Py_DECREF(mod);
573 }
574 if (_PyState_AddModule(mod, def) < 0) {
Victor Stinner95872862011-03-07 18:20:56 +0100575 PyDict_DelItem(PyImport_GetModuleDict(), name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000576 Py_DECREF(mod);
577 return NULL;
578 }
579 if (Py_VerboseFlag)
Victor Stinner95872862011-03-07 18:20:56 +0100580 PySys_FormatStderr("import %U # previously loaded (%R)\n",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000581 name, filename);
582 return mod;
Brett Cannon9a5b25a2010-03-01 02:09:17 +0000583
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000584}
585
Victor Stinner49d3f252010-10-17 01:24:53 +0000586PyObject *
Victor Stinner501c09a2011-02-23 00:02:00 +0000587_PyImport_FindBuiltin(const char *name)
Victor Stinner49d3f252010-10-17 01:24:53 +0000588{
Victor Stinner95872862011-03-07 18:20:56 +0100589 PyObject *res, *nameobj;
Victor Stinner21fcd0c2011-03-07 18:28:15 +0100590 nameobj = PyUnicode_InternFromString(name);
Victor Stinner95872862011-03-07 18:20:56 +0100591 if (nameobj == NULL)
Victor Stinner49d3f252010-10-17 01:24:53 +0000592 return NULL;
Victor Stinner95872862011-03-07 18:20:56 +0100593 res = _PyImport_FindExtensionObject(nameobj, nameobj);
594 Py_DECREF(nameobj);
Victor Stinner49d3f252010-10-17 01:24:53 +0000595 return res;
596}
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000597
598/* Get the module object corresponding to a module name.
599 First check the modules dictionary if there's one there,
Walter Dörwaldf0dfc7a2003-10-20 14:01:56 +0000600 if not, create a new one and insert it in the modules dictionary.
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000601 Because the former action is most common, THIS DOES NOT RETURN A
602 'NEW' REFERENCE! */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000603
Guido van Rossum79f25d91997-04-29 20:08:16 +0000604PyObject *
Victor Stinner27ee0892011-03-04 12:57:09 +0000605PyImport_AddModuleObject(PyObject *name)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000606{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000607 PyObject *modules = PyImport_GetModuleDict();
608 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000609
Victor Stinner27ee0892011-03-04 12:57:09 +0000610 if ((m = PyDict_GetItem(modules, name)) != NULL &&
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000611 PyModule_Check(m))
612 return m;
Victor Stinner27ee0892011-03-04 12:57:09 +0000613 m = PyModule_NewObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000614 if (m == NULL)
615 return NULL;
Victor Stinner27ee0892011-03-04 12:57:09 +0000616 if (PyDict_SetItem(modules, name, m) != 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000617 Py_DECREF(m);
618 return NULL;
619 }
620 Py_DECREF(m); /* Yes, it still exists, in modules! */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000621
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000622 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000623}
624
Victor Stinner27ee0892011-03-04 12:57:09 +0000625PyObject *
626PyImport_AddModule(const char *name)
627{
628 PyObject *nameobj, *module;
629 nameobj = PyUnicode_FromString(name);
630 if (nameobj == NULL)
631 return NULL;
632 module = PyImport_AddModuleObject(nameobj);
633 Py_DECREF(nameobj);
634 return module;
635}
636
637
Tim Peters1cd70172004-08-02 03:52:12 +0000638/* Remove name from sys.modules, if it's there. */
639static void
Victor Stinner27ee0892011-03-04 12:57:09 +0000640remove_module(PyObject *name)
Tim Peters1cd70172004-08-02 03:52:12 +0000641{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000642 PyObject *modules = PyImport_GetModuleDict();
Victor Stinner27ee0892011-03-04 12:57:09 +0000643 if (PyDict_GetItem(modules, name) == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000644 return;
Victor Stinner27ee0892011-03-04 12:57:09 +0000645 if (PyDict_DelItem(modules, name) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000646 Py_FatalError("import: deleting existing key in"
647 "sys.modules failed");
Tim Peters1cd70172004-08-02 03:52:12 +0000648}
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000649
Christian Heimes3b06e532008-01-07 20:12:44 +0000650
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000651/* Execute a code object in a module and return the module object
Tim Peters1cd70172004-08-02 03:52:12 +0000652 * WITH INCREMENTED REFERENCE COUNT. If an error occurs, name is
653 * removed from sys.modules, to avoid leaving damaged module objects
654 * in sys.modules. The caller may wish to restore the original
655 * module object (if any) in this case; PyImport_ReloadModule is an
656 * example.
Barry Warsaw28a691b2010-04-17 00:19:56 +0000657 *
658 * Note that PyImport_ExecCodeModuleWithPathnames() is the preferred, richer
659 * interface. The other two exist primarily for backward compatibility.
Tim Peters1cd70172004-08-02 03:52:12 +0000660 */
Guido van Rossum79f25d91997-04-29 20:08:16 +0000661PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000662PyImport_ExecCodeModule(char *name, PyObject *co)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000663{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000664 return PyImport_ExecCodeModuleWithPathnames(
665 name, co, (char *)NULL, (char *)NULL);
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000666}
667
668PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000669PyImport_ExecCodeModuleEx(char *name, PyObject *co, char *pathname)
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000670{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000671 return PyImport_ExecCodeModuleWithPathnames(
672 name, co, pathname, (char *)NULL);
Barry Warsaw28a691b2010-04-17 00:19:56 +0000673}
674
675PyObject *
676PyImport_ExecCodeModuleWithPathnames(char *name, PyObject *co, char *pathname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000677 char *cpathname)
Barry Warsaw28a691b2010-04-17 00:19:56 +0000678{
Victor Stinner27ee0892011-03-04 12:57:09 +0000679 PyObject *m = NULL;
680 PyObject *nameobj, *pathobj = NULL, *cpathobj = NULL;
681
682 nameobj = PyUnicode_FromString(name);
683 if (nameobj == NULL)
684 return NULL;
685
Victor Stinner27ee0892011-03-04 12:57:09 +0000686 if (cpathname != NULL) {
687 cpathobj = PyUnicode_DecodeFSDefault(cpathname);
688 if (cpathobj == NULL)
689 goto error;
Brett Cannona6473f92012-07-13 13:57:03 -0400690 }
691 else
Victor Stinner27ee0892011-03-04 12:57:09 +0000692 cpathobj = NULL;
Brett Cannona6473f92012-07-13 13:57:03 -0400693
694 if (pathname != NULL) {
695 pathobj = PyUnicode_DecodeFSDefault(pathname);
696 if (pathobj == NULL)
697 goto error;
698 }
699 else if (cpathobj != NULL) {
700 PyInterpreterState *interp = PyThreadState_GET()->interp;
701 _Py_IDENTIFIER(_get_sourcefile);
702
703 if (interp == NULL) {
704 Py_FatalError("PyImport_ExecCodeModuleWithPathnames: "
705 "no interpreter!");
706 }
707
Alexandre Vassalotti865eaa12013-05-02 10:44:04 -0700708 pathobj = _PyObject_CallMethodIdObjArgs(interp->importlib,
Brett Cannona6473f92012-07-13 13:57:03 -0400709 &PyId__get_sourcefile, cpathobj,
710 NULL);
711 if (pathobj == NULL)
712 PyErr_Clear();
713 }
714 else
715 pathobj = NULL;
716
Victor Stinner27ee0892011-03-04 12:57:09 +0000717 m = PyImport_ExecCodeModuleObject(nameobj, co, pathobj, cpathobj);
718error:
719 Py_DECREF(nameobj);
720 Py_XDECREF(pathobj);
721 Py_XDECREF(cpathobj);
722 return m;
723}
724
725PyObject*
726PyImport_ExecCodeModuleObject(PyObject *name, PyObject *co, PyObject *pathname,
727 PyObject *cpathname)
728{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000729 PyObject *modules = PyImport_GetModuleDict();
730 PyObject *m, *d, *v;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000731
Victor Stinner27ee0892011-03-04 12:57:09 +0000732 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000733 if (m == NULL)
734 return NULL;
735 /* If the module is being reloaded, we get the old module back
736 and re-use its dict to exec the new code. */
737 d = PyModule_GetDict(m);
738 if (PyDict_GetItemString(d, "__builtins__") == NULL) {
739 if (PyDict_SetItemString(d, "__builtins__",
740 PyEval_GetBuiltins()) != 0)
741 goto error;
742 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000743 if (pathname != NULL) {
Brett Cannona6473f92012-07-13 13:57:03 -0400744 v = pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000745 }
Brett Cannona6473f92012-07-13 13:57:03 -0400746 else {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000747 v = ((PyCodeObject *)co)->co_filename;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000748 }
Brett Cannona6473f92012-07-13 13:57:03 -0400749 Py_INCREF(v);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000750 if (PyDict_SetItemString(d, "__file__", v) != 0)
751 PyErr_Clear(); /* Not important enough to report */
752 Py_DECREF(v);
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000753
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000754 /* Remember the pyc path name as the __cached__ attribute. */
Victor Stinner27ee0892011-03-04 12:57:09 +0000755 if (cpathname != NULL)
756 v = cpathname;
757 else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000758 v = Py_None;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000759 if (PyDict_SetItemString(d, "__cached__", v) != 0)
760 PyErr_Clear(); /* Not important enough to report */
Barry Warsaw28a691b2010-04-17 00:19:56 +0000761
Martin v. Löwis4d0d4712010-12-03 20:14:31 +0000762 v = PyEval_EvalCode(co, d, d);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000763 if (v == NULL)
764 goto error;
765 Py_DECREF(v);
Guido van Rossumb65e85c1997-07-10 18:00:45 +0000766
Victor Stinner27ee0892011-03-04 12:57:09 +0000767 if ((m = PyDict_GetItem(modules, name)) == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000768 PyErr_Format(PyExc_ImportError,
Victor Stinner27ee0892011-03-04 12:57:09 +0000769 "Loaded module %R not found in sys.modules",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000770 name);
771 return NULL;
772 }
Guido van Rossumb65e85c1997-07-10 18:00:45 +0000773
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000774 Py_INCREF(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000775
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000776 return m;
Tim Peters1cd70172004-08-02 03:52:12 +0000777
778 error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000779 remove_module(name);
780 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000781}
782
783
Antoine Pitroud35cbf62009-01-06 19:02:24 +0000784static void
785update_code_filenames(PyCodeObject *co, PyObject *oldname, PyObject *newname)
786{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000787 PyObject *constants, *tmp;
788 Py_ssize_t i, n;
Antoine Pitroud35cbf62009-01-06 19:02:24 +0000789
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000790 if (PyUnicode_Compare(co->co_filename, oldname))
791 return;
Antoine Pitroud35cbf62009-01-06 19:02:24 +0000792
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000793 tmp = co->co_filename;
794 co->co_filename = newname;
795 Py_INCREF(co->co_filename);
796 Py_DECREF(tmp);
Antoine Pitroud35cbf62009-01-06 19:02:24 +0000797
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000798 constants = co->co_consts;
799 n = PyTuple_GET_SIZE(constants);
800 for (i = 0; i < n; i++) {
801 tmp = PyTuple_GET_ITEM(constants, i);
802 if (PyCode_Check(tmp))
803 update_code_filenames((PyCodeObject *)tmp,
804 oldname, newname);
805 }
Antoine Pitroud35cbf62009-01-06 19:02:24 +0000806}
807
Victor Stinner2f42ae52011-03-20 00:41:24 +0100808static void
809update_compiled_module(PyCodeObject *co, PyObject *newname)
Antoine Pitroud35cbf62009-01-06 19:02:24 +0000810{
Victor Stinner2f42ae52011-03-20 00:41:24 +0100811 PyObject *oldname;
Antoine Pitroud35cbf62009-01-06 19:02:24 +0000812
Victor Stinner2f42ae52011-03-20 00:41:24 +0100813 if (PyUnicode_Compare(co->co_filename, newname) == 0)
814 return;
Hirokazu Yamamoto4f447fb2009-03-04 01:52:10 +0000815
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000816 oldname = co->co_filename;
817 Py_INCREF(oldname);
818 update_code_filenames(co, oldname, newname);
819 Py_DECREF(oldname);
Antoine Pitroud35cbf62009-01-06 19:02:24 +0000820}
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000821
Brett Cannon442c9b92011-03-23 16:14:42 -0700822static PyObject *
823imp_fix_co_filename(PyObject *self, PyObject *args)
824{
825 PyObject *co;
826 PyObject *file_path;
827
828 if (!PyArg_ParseTuple(args, "OO:_fix_co_filename", &co, &file_path))
829 return NULL;
830
831 if (!PyCode_Check(co)) {
832 PyErr_SetString(PyExc_TypeError,
833 "first argument must be a code object");
834 return NULL;
835 }
836
837 if (!PyUnicode_Check(file_path)) {
838 PyErr_SetString(PyExc_TypeError,
839 "second argument must be a string");
840 return NULL;
841 }
842
843 update_compiled_module((PyCodeObject*)co, file_path);
844
845 Py_RETURN_NONE;
846}
847
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000848
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000849/* Forward */
Benjamin Peterson6fba3db2013-03-18 23:13:31 -0700850static const struct _frozen * find_frozen(PyObject *);
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000851
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000852
853/* Helper to test for built-in module */
854
855static int
Victor Stinner95872862011-03-07 18:20:56 +0100856is_builtin(PyObject *name)
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000857{
Victor Stinner95872862011-03-07 18:20:56 +0100858 int i, cmp;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000859 for (i = 0; PyImport_Inittab[i].name != NULL; i++) {
Victor Stinner95872862011-03-07 18:20:56 +0100860 cmp = PyUnicode_CompareWithASCIIString(name, PyImport_Inittab[i].name);
861 if (cmp == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000862 if (PyImport_Inittab[i].initfunc == NULL)
863 return -1;
864 else
865 return 1;
866 }
867 }
868 return 0;
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000869}
870
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000871
Just van Rossum52e14d62002-12-30 22:08:05 +0000872/* Return an importer object for a sys.path/pkg.__path__ item 'p',
873 possibly by fetching it from the path_importer_cache dict. If it
Thomas Wouters89f507f2006-12-13 04:49:30 +0000874 wasn't yet cached, traverse path_hooks until a hook is found
Just van Rossum52e14d62002-12-30 22:08:05 +0000875 that can handle the path item. Return None if no hook could;
876 this tells our caller it should fall back to the builtin
877 import mechanism. Cache the result in path_importer_cache.
878 Returns a borrowed reference. */
879
880static PyObject *
881get_path_importer(PyObject *path_importer_cache, PyObject *path_hooks,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000882 PyObject *p)
Just van Rossum52e14d62002-12-30 22:08:05 +0000883{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000884 PyObject *importer;
885 Py_ssize_t j, nhooks;
Just van Rossum52e14d62002-12-30 22:08:05 +0000886
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000887 /* These conditions are the caller's responsibility: */
888 assert(PyList_Check(path_hooks));
889 assert(PyDict_Check(path_importer_cache));
Just van Rossum52e14d62002-12-30 22:08:05 +0000890
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000891 nhooks = PyList_Size(path_hooks);
892 if (nhooks < 0)
893 return NULL; /* Shouldn't happen */
Just van Rossum52e14d62002-12-30 22:08:05 +0000894
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000895 importer = PyDict_GetItem(path_importer_cache, p);
896 if (importer != NULL)
897 return importer;
Just van Rossum52e14d62002-12-30 22:08:05 +0000898
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000899 /* set path_importer_cache[p] to None to avoid recursion */
900 if (PyDict_SetItem(path_importer_cache, p, Py_None) != 0)
901 return NULL;
Just van Rossum52e14d62002-12-30 22:08:05 +0000902
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000903 for (j = 0; j < nhooks; j++) {
904 PyObject *hook = PyList_GetItem(path_hooks, j);
905 if (hook == NULL)
906 return NULL;
907 importer = PyObject_CallFunctionObjArgs(hook, p, NULL);
908 if (importer != NULL)
909 break;
Just van Rossum52e14d62002-12-30 22:08:05 +0000910
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000911 if (!PyErr_ExceptionMatches(PyExc_ImportError)) {
912 return NULL;
913 }
914 PyErr_Clear();
915 }
916 if (importer == NULL) {
Brett Cannonaa936422012-04-27 15:30:58 -0400917 return Py_None;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000918 }
919 if (importer != NULL) {
920 int err = PyDict_SetItem(path_importer_cache, p, importer);
921 Py_DECREF(importer);
922 if (err != 0)
923 return NULL;
924 }
925 return importer;
Just van Rossum52e14d62002-12-30 22:08:05 +0000926}
927
Christian Heimes9cd17752007-11-18 19:35:23 +0000928PyAPI_FUNC(PyObject *)
929PyImport_GetImporter(PyObject *path) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000930 PyObject *importer=NULL, *path_importer_cache=NULL, *path_hooks=NULL;
Christian Heimes9cd17752007-11-18 19:35:23 +0000931
Victor Stinner1e53bba2013-07-16 22:26:05 +0200932 path_importer_cache = PySys_GetObject("path_importer_cache");
933 path_hooks = PySys_GetObject("path_hooks");
934 if (path_importer_cache != NULL && path_hooks != NULL) {
935 importer = get_path_importer(path_importer_cache,
936 path_hooks, path);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000937 }
938 Py_XINCREF(importer); /* get_path_importer returns a borrowed reference */
939 return importer;
Christian Heimes9cd17752007-11-18 19:35:23 +0000940}
941
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000942
Victor Stinner95872862011-03-07 18:20:56 +0100943static int init_builtin(PyObject *); /* Forward */
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000944
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000945/* Initialize a built-in module.
Thomas Wouters89f507f2006-12-13 04:49:30 +0000946 Return 1 for success, 0 if the module is not found, and -1 with
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000947 an exception set if the initialization failed. */
Guido van Rossum7f133ed1991-02-19 12:23:57 +0000948
Guido van Rossum7f133ed1991-02-19 12:23:57 +0000949static int
Victor Stinner95872862011-03-07 18:20:56 +0100950init_builtin(PyObject *name)
Guido van Rossum7f133ed1991-02-19 12:23:57 +0000951{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000952 struct _inittab *p;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000953
Victor Stinner95872862011-03-07 18:20:56 +0100954 if (_PyImport_FindExtensionObject(name, name) != NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000955 return 1;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000956
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000957 for (p = PyImport_Inittab; p->name != NULL; p++) {
958 PyObject *mod;
Antoine Pitrou6c40eb72012-01-18 20:16:09 +0100959 PyModuleDef *def;
Victor Stinner95872862011-03-07 18:20:56 +0100960 if (PyUnicode_CompareWithASCIIString(name, p->name) == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000961 if (p->initfunc == NULL) {
962 PyErr_Format(PyExc_ImportError,
Victor Stinner95872862011-03-07 18:20:56 +0100963 "Cannot re-init internal module %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000964 name);
965 return -1;
966 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000967 mod = (*p->initfunc)();
968 if (mod == 0)
969 return -1;
Antoine Pitrou6c40eb72012-01-18 20:16:09 +0100970 /* Remember pointer to module init function. */
971 def = PyModule_GetDef(mod);
972 def->m_base.m_init = p->initfunc;
Victor Stinner95872862011-03-07 18:20:56 +0100973 if (_PyImport_FixupExtensionObject(mod, name, name) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000974 return -1;
975 /* FixupExtension has put the module into sys.modules,
976 so we can release our own reference. */
977 Py_DECREF(mod);
978 return 1;
979 }
980 }
981 return 0;
Guido van Rossum7f133ed1991-02-19 12:23:57 +0000982}
Guido van Rossumf56e3db1993-04-01 20:59:32 +0000983
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000984
Guido van Rossum6ec1efb1995-08-04 04:08:57 +0000985/* Frozen modules */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000986
Benjamin Peterson6fba3db2013-03-18 23:13:31 -0700987static const struct _frozen *
Victor Stinner53dc7352011-03-20 01:50:21 +0100988find_frozen(PyObject *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +0000989{
Benjamin Peterson6fba3db2013-03-18 23:13:31 -0700990 const struct _frozen *p;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +0000991
Victor Stinner53dc7352011-03-20 01:50:21 +0100992 if (name == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000993 return NULL;
Benjamin Petersond968e272008-11-05 22:48:33 +0000994
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000995 for (p = PyImport_FrozenModules; ; p++) {
996 if (p->name == NULL)
997 return NULL;
Victor Stinner53dc7352011-03-20 01:50:21 +0100998 if (PyUnicode_CompareWithASCIIString(name, p->name) == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000999 break;
1000 }
1001 return p;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001002}
1003
Guido van Rossum79f25d91997-04-29 20:08:16 +00001004static PyObject *
Victor Stinner53dc7352011-03-20 01:50:21 +01001005get_frozen_object(PyObject *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001006{
Benjamin Peterson6fba3db2013-03-18 23:13:31 -07001007 const struct _frozen *p = find_frozen(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001008 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001009
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001010 if (p == NULL) {
1011 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01001012 "No such frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001013 name);
1014 return NULL;
1015 }
1016 if (p->code == NULL) {
1017 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01001018 "Excluded frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001019 name);
1020 return NULL;
1021 }
1022 size = p->size;
1023 if (size < 0)
1024 size = -size;
1025 return PyMarshal_ReadObjectFromString((char *)p->code, size);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001026}
1027
Brett Cannon8d110132009-03-15 02:20:16 +00001028static PyObject *
Victor Stinner53dc7352011-03-20 01:50:21 +01001029is_frozen_package(PyObject *name)
Brett Cannon8d110132009-03-15 02:20:16 +00001030{
Benjamin Peterson6fba3db2013-03-18 23:13:31 -07001031 const struct _frozen *p = find_frozen(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001032 int size;
Brett Cannon8d110132009-03-15 02:20:16 +00001033
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001034 if (p == NULL) {
1035 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01001036 "No such frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001037 name);
1038 return NULL;
1039 }
Brett Cannon8d110132009-03-15 02:20:16 +00001040
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001041 size = p->size;
Brett Cannon8d110132009-03-15 02:20:16 +00001042
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001043 if (size < 0)
1044 Py_RETURN_TRUE;
1045 else
1046 Py_RETURN_FALSE;
Brett Cannon8d110132009-03-15 02:20:16 +00001047}
1048
1049
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001050/* Initialize a frozen module.
Brett Cannon3c2ac442009-03-08 20:49:47 +00001051 Return 1 for success, 0 if the module is not found, and -1 with
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001052 an exception set if the initialization failed.
1053 This function is also used from frozenmain.c */
Guido van Rossum0b344901995-02-07 15:35:27 +00001054
1055int
Victor Stinner53dc7352011-03-20 01:50:21 +01001056PyImport_ImportFrozenModuleObject(PyObject *name)
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001057{
Benjamin Peterson6fba3db2013-03-18 23:13:31 -07001058 const struct _frozen *p;
Victor Stinner53dc7352011-03-20 01:50:21 +01001059 PyObject *co, *m, *path;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001060 int ispackage;
1061 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001062
Victor Stinner53dc7352011-03-20 01:50:21 +01001063 p = find_frozen(name);
1064
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001065 if (p == NULL)
1066 return 0;
1067 if (p->code == NULL) {
1068 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01001069 "Excluded frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001070 name);
1071 return -1;
1072 }
1073 size = p->size;
1074 ispackage = (size < 0);
1075 if (ispackage)
1076 size = -size;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001077 co = PyMarshal_ReadObjectFromString((char *)p->code, size);
1078 if (co == NULL)
1079 return -1;
1080 if (!PyCode_Check(co)) {
1081 PyErr_Format(PyExc_TypeError,
Victor Stinner53dc7352011-03-20 01:50:21 +01001082 "frozen object %R is not a code object",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001083 name);
1084 goto err_return;
1085 }
1086 if (ispackage) {
Brett Cannon3e0651b2013-05-31 23:18:39 -04001087 /* Set __path__ to the empty list */
Victor Stinner53dc7352011-03-20 01:50:21 +01001088 PyObject *d, *l;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001089 int err;
Victor Stinner53dc7352011-03-20 01:50:21 +01001090 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001091 if (m == NULL)
1092 goto err_return;
1093 d = PyModule_GetDict(m);
Brett Cannon3e0651b2013-05-31 23:18:39 -04001094 l = PyList_New(0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001095 if (l == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001096 goto err_return;
1097 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001098 err = PyDict_SetItemString(d, "__path__", l);
1099 Py_DECREF(l);
1100 if (err != 0)
1101 goto err_return;
1102 }
Victor Stinner53dc7352011-03-20 01:50:21 +01001103 path = PyUnicode_FromString("<frozen>");
1104 if (path == NULL)
1105 goto err_return;
1106 m = PyImport_ExecCodeModuleObject(name, co, path, NULL);
1107 Py_DECREF(path);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001108 if (m == NULL)
1109 goto err_return;
1110 Py_DECREF(co);
1111 Py_DECREF(m);
1112 return 1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001113err_return:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001114 Py_DECREF(co);
1115 return -1;
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001116}
Guido van Rossum74e6a111994-08-29 12:54:38 +00001117
Victor Stinner53dc7352011-03-20 01:50:21 +01001118int
1119PyImport_ImportFrozenModule(char *name)
1120{
1121 PyObject *nameobj;
1122 int ret;
1123 nameobj = PyUnicode_InternFromString(name);
1124 if (nameobj == NULL)
1125 return -1;
1126 ret = PyImport_ImportFrozenModuleObject(nameobj);
1127 Py_DECREF(nameobj);
1128 return ret;
1129}
1130
Guido van Rossum74e6a111994-08-29 12:54:38 +00001131
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001132/* Import a module, either built-in, frozen, or external, and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001133 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum74e6a111994-08-29 12:54:38 +00001134
Guido van Rossum79f25d91997-04-29 20:08:16 +00001135PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001136PyImport_ImportModule(const char *name)
Guido van Rossum74e6a111994-08-29 12:54:38 +00001137{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001138 PyObject *pname;
1139 PyObject *result;
Marc-André Lemburg3c61c352001-02-09 19:40:15 +00001140
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001141 pname = PyUnicode_FromString(name);
1142 if (pname == NULL)
1143 return NULL;
1144 result = PyImport_Import(pname);
1145 Py_DECREF(pname);
1146 return result;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001147}
1148
Christian Heimes072c0f12008-01-03 23:01:04 +00001149/* Import a module without blocking
1150 *
1151 * At first it tries to fetch the module from sys.modules. If the module was
1152 * never loaded before it loads it with PyImport_ImportModule() unless another
1153 * thread holds the import lock. In the latter case the function raises an
1154 * ImportError instead of blocking.
1155 *
1156 * Returns the module object with incremented ref count.
1157 */
1158PyObject *
1159PyImport_ImportModuleNoBlock(const char *name)
1160{
Antoine Pitrouea3eb882012-05-17 18:55:59 +02001161 return PyImport_ImportModule(name);
Christian Heimes072c0f12008-01-03 23:01:04 +00001162}
1163
Guido van Rossum17fc85f1997-09-06 18:52:03 +00001164
Antoine Pitroubc07a5c2012-07-08 12:01:27 +02001165/* Remove importlib frames from the traceback,
1166 * except in Verbose mode. */
1167static void
1168remove_importlib_frames(void)
1169{
1170 const char *importlib_filename = "<frozen importlib._bootstrap>";
Nick Coghlan42c07662012-07-31 21:14:18 +10001171 const char *remove_frames = "_call_with_frames_removed";
Antoine Pitroubc07a5c2012-07-08 12:01:27 +02001172 int always_trim = 0;
Benjamin Petersonfa873702012-07-09 13:43:53 -07001173 int in_importlib = 0;
Antoine Pitroubc07a5c2012-07-08 12:01:27 +02001174 PyObject *exception, *value, *base_tb, *tb;
Benjamin Petersonfa873702012-07-09 13:43:53 -07001175 PyObject **prev_link, **outer_link = NULL;
Antoine Pitroubc07a5c2012-07-08 12:01:27 +02001176
1177 /* Synopsis: if it's an ImportError, we trim all importlib chunks
Nick Coghlan42c07662012-07-31 21:14:18 +10001178 from the traceback. We always trim chunks
1179 which end with a call to "_call_with_frames_removed". */
Antoine Pitroubc07a5c2012-07-08 12:01:27 +02001180
1181 PyErr_Fetch(&exception, &value, &base_tb);
1182 if (!exception || Py_VerboseFlag)
1183 goto done;
1184 if (PyType_IsSubtype((PyTypeObject *) exception,
1185 (PyTypeObject *) PyExc_ImportError))
1186 always_trim = 1;
1187
1188 prev_link = &base_tb;
1189 tb = base_tb;
Antoine Pitroubc07a5c2012-07-08 12:01:27 +02001190 while (tb != NULL) {
1191 PyTracebackObject *traceback = (PyTracebackObject *)tb;
1192 PyObject *next = (PyObject *) traceback->tb_next;
1193 PyFrameObject *frame = traceback->tb_frame;
1194 PyCodeObject *code = frame->f_code;
1195 int now_in_importlib;
1196
1197 assert(PyTraceBack_Check(tb));
1198 now_in_importlib = (PyUnicode_CompareWithASCIIString(
1199 code->co_filename,
1200 importlib_filename) == 0);
1201 if (now_in_importlib && !in_importlib) {
1202 /* This is the link to this chunk of importlib tracebacks */
1203 outer_link = prev_link;
1204 }
1205 in_importlib = now_in_importlib;
1206
1207 if (in_importlib &&
1208 (always_trim ||
Nick Coghlan42c07662012-07-31 21:14:18 +10001209 PyUnicode_CompareWithASCIIString(code->co_name,
1210 remove_frames) == 0)) {
Antoine Pitroubc07a5c2012-07-08 12:01:27 +02001211 PyObject *tmp = *outer_link;
1212 *outer_link = next;
1213 Py_XINCREF(next);
1214 Py_DECREF(tmp);
1215 prev_link = outer_link;
1216 }
1217 else {
1218 prev_link = (PyObject **) &traceback->tb_next;
1219 }
1220 tb = next;
1221 }
1222done:
1223 PyErr_Restore(exception, value, base_tb);
1224}
1225
1226
Thomas Woutersf7f438b2006-02-28 16:09:29 +00001227PyObject *
Brett Cannonfd074152012-04-14 14:10:13 -04001228PyImport_ImportModuleLevelObject(PyObject *name, PyObject *given_globals,
1229 PyObject *locals, PyObject *given_fromlist,
Victor Stinnerfe93faf2011-03-14 15:54:52 -04001230 int level)
Thomas Woutersf7f438b2006-02-28 16:09:29 +00001231{
Brett Cannonfd074152012-04-14 14:10:13 -04001232 _Py_IDENTIFIER(__import__);
Antoine Pitrouea3eb882012-05-17 18:55:59 +02001233 _Py_IDENTIFIER(__initializing__);
Brett Cannonfd074152012-04-14 14:10:13 -04001234 _Py_IDENTIFIER(__package__);
1235 _Py_IDENTIFIER(__path__);
1236 _Py_IDENTIFIER(__name__);
1237 _Py_IDENTIFIER(_find_and_load);
1238 _Py_IDENTIFIER(_handle_fromlist);
Antoine Pitrouea3eb882012-05-17 18:55:59 +02001239 _Py_IDENTIFIER(_lock_unlock_module);
Brett Cannonfd074152012-04-14 14:10:13 -04001240 _Py_static_string(single_dot, ".");
1241 PyObject *abs_name = NULL;
1242 PyObject *builtins_import = NULL;
1243 PyObject *final_mod = NULL;
1244 PyObject *mod = NULL;
1245 PyObject *package = NULL;
1246 PyObject *globals = NULL;
1247 PyObject *fromlist = NULL;
1248 PyInterpreterState *interp = PyThreadState_GET()->interp;
1249
1250 /* Make sure to use default values so as to not have
1251 PyObject_CallMethodObjArgs() truncate the parameter list because of a
1252 NULL argument. */
1253 if (given_globals == NULL) {
1254 globals = PyDict_New();
1255 if (globals == NULL) {
1256 goto error;
1257 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001258 }
Brett Cannonfd074152012-04-14 14:10:13 -04001259 else {
1260 /* Only have to care what given_globals is if it will be used
Brett Cannonecfefb72012-08-05 19:24:57 -04001261 for something. */
Brett Cannonfd074152012-04-14 14:10:13 -04001262 if (level > 0 && !PyDict_Check(given_globals)) {
1263 PyErr_SetString(PyExc_TypeError, "globals must be a dict");
1264 goto error;
1265 }
1266 globals = given_globals;
1267 Py_INCREF(globals);
1268 }
1269
1270 if (given_fromlist == NULL) {
1271 fromlist = PyList_New(0);
1272 if (fromlist == NULL) {
1273 goto error;
1274 }
1275 }
1276 else {
1277 fromlist = given_fromlist;
1278 Py_INCREF(fromlist);
1279 }
1280 if (name == NULL) {
1281 PyErr_SetString(PyExc_ValueError, "Empty module name");
1282 goto error;
1283 }
1284
1285 /* The below code is importlib.__import__() & _gcd_import(), ported to C
1286 for added performance. */
1287
1288 if (!PyUnicode_Check(name)) {
1289 PyErr_SetString(PyExc_TypeError, "module name must be a string");
1290 goto error;
1291 }
1292 else if (PyUnicode_READY(name) < 0) {
1293 goto error;
1294 }
1295 if (level < 0) {
1296 PyErr_SetString(PyExc_ValueError, "level must be >= 0");
1297 goto error;
1298 }
1299 else if (level > 0) {
1300 package = _PyDict_GetItemId(globals, &PyId___package__);
1301 if (package != NULL && package != Py_None) {
1302 Py_INCREF(package);
1303 if (!PyUnicode_Check(package)) {
1304 PyErr_SetString(PyExc_TypeError, "package must be a string");
1305 goto error;
1306 }
1307 }
1308 else {
Brett Cannon273323c2012-04-17 19:05:11 -04001309 package = _PyDict_GetItemId(globals, &PyId___name__);
Brett Cannonfd074152012-04-14 14:10:13 -04001310 if (package == NULL) {
Brett Cannon273323c2012-04-17 19:05:11 -04001311 PyErr_SetString(PyExc_KeyError, "'__name__' not in globals");
Brett Cannonfd074152012-04-14 14:10:13 -04001312 goto error;
1313 }
1314 else if (!PyUnicode_Check(package)) {
1315 PyErr_SetString(PyExc_TypeError, "__name__ must be a string");
1316 }
1317 Py_INCREF(package);
1318
1319 if (_PyDict_GetItemId(globals, &PyId___path__) == NULL) {
Brett Cannon740fce02012-04-14 14:23:49 -04001320 PyObject *partition = NULL;
Brett Cannonfd074152012-04-14 14:10:13 -04001321 PyObject *borrowed_dot = _PyUnicode_FromId(&single_dot);
1322 if (borrowed_dot == NULL) {
1323 goto error;
1324 }
Brett Cannon740fce02012-04-14 14:23:49 -04001325 partition = PyUnicode_RPartition(package, borrowed_dot);
Brett Cannonfd074152012-04-14 14:10:13 -04001326 Py_DECREF(package);
1327 if (partition == NULL) {
1328 goto error;
1329 }
1330 package = PyTuple_GET_ITEM(partition, 0);
1331 Py_INCREF(package);
1332 Py_DECREF(partition);
1333 }
1334 }
1335
1336 if (PyDict_GetItem(interp->modules, package) == NULL) {
1337 PyErr_Format(PyExc_SystemError,
1338 "Parent module %R not loaded, cannot perform relative "
1339 "import", package);
1340 goto error;
1341 }
1342 }
1343 else { /* level == 0 */
1344 if (PyUnicode_GET_LENGTH(name) == 0) {
1345 PyErr_SetString(PyExc_ValueError, "Empty module name");
1346 goto error;
1347 }
1348 package = Py_None;
1349 Py_INCREF(package);
1350 }
1351
1352 if (level > 0) {
1353 Py_ssize_t last_dot = PyUnicode_GET_LENGTH(package);
1354 PyObject *base = NULL;
1355 int level_up = 1;
1356
1357 for (level_up = 1; level_up < level; level_up += 1) {
1358 last_dot = PyUnicode_FindChar(package, '.', 0, last_dot, -1);
1359 if (last_dot == -2) {
1360 goto error;
1361 }
1362 else if (last_dot == -1) {
1363 PyErr_SetString(PyExc_ValueError,
1364 "attempted relative import beyond top-level "
1365 "package");
1366 goto error;
1367 }
1368 }
1369 base = PyUnicode_Substring(package, 0, last_dot);
1370 if (PyUnicode_GET_LENGTH(name) > 0) {
Antoine Pitrou538ba2a2012-04-16 21:52:45 +02001371 PyObject *borrowed_dot, *seq = NULL;
Brett Cannonfd074152012-04-14 14:10:13 -04001372
1373 borrowed_dot = _PyUnicode_FromId(&single_dot);
Antoine Pitrou538ba2a2012-04-16 21:52:45 +02001374 seq = PyTuple_Pack(2, base, name);
1375 Py_DECREF(base);
Brett Cannonfd074152012-04-14 14:10:13 -04001376 if (borrowed_dot == NULL || seq == NULL) {
1377 goto error;
1378 }
1379
1380 abs_name = PyUnicode_Join(borrowed_dot, seq);
1381 Py_DECREF(seq);
1382 if (abs_name == NULL) {
1383 goto error;
1384 }
1385 }
1386 else {
1387 abs_name = base;
1388 }
1389 }
1390 else {
1391 abs_name = name;
1392 Py_INCREF(abs_name);
1393 }
1394
Brian Curtine6b299f2012-04-14 14:19:33 -05001395#ifdef WITH_THREAD
Brett Cannonfd074152012-04-14 14:10:13 -04001396 _PyImport_AcquireLock();
1397#endif
1398 /* From this point forward, goto error_with_unlock! */
1399 if (PyDict_Check(globals)) {
1400 builtins_import = _PyDict_GetItemId(globals, &PyId___import__);
1401 }
1402 if (builtins_import == NULL) {
1403 builtins_import = _PyDict_GetItemId(interp->builtins, &PyId___import__);
1404 if (builtins_import == NULL) {
Benjamin Peterson7d110042013-04-29 09:08:14 -04001405 PyErr_SetString(PyExc_ImportError, "__import__ not found");
1406 goto error_with_unlock;
Brett Cannonfd074152012-04-14 14:10:13 -04001407 }
1408 }
1409 Py_INCREF(builtins_import);
1410
1411 mod = PyDict_GetItem(interp->modules, abs_name);
1412 if (mod == Py_None) {
Brett Cannon27fc5282012-04-15 14:15:31 -04001413 PyObject *msg = PyUnicode_FromFormat("import of %R halted; "
1414 "None in sys.modules", abs_name);
1415 if (msg != NULL) {
Brett Cannon82da8882013-07-04 17:48:16 -04001416 PyErr_SetImportError(msg, abs_name, NULL);
Brian Curtin09b86d12012-04-17 16:57:09 -05001417 Py_DECREF(msg);
Brett Cannon27fc5282012-04-15 14:15:31 -04001418 }
Antoine Pitrou71382cb2012-04-16 18:48:49 +02001419 mod = NULL;
Brett Cannonfd074152012-04-14 14:10:13 -04001420 goto error_with_unlock;
1421 }
1422 else if (mod != NULL) {
Antoine Pitrouea3eb882012-05-17 18:55:59 +02001423 PyObject *value;
1424 int initializing = 0;
1425
Brett Cannonfd074152012-04-14 14:10:13 -04001426 Py_INCREF(mod);
Antoine Pitrou03989852012-08-28 00:24:52 +02001427 /* Optimization: only call _bootstrap._lock_unlock_module() if
1428 __initializing__ is true.
1429 NOTE: because of this, __initializing__ must be set *before*
1430 stuffing the new module in sys.modules.
1431 */
Antoine Pitrouea3eb882012-05-17 18:55:59 +02001432 value = _PyObject_GetAttrId(mod, &PyId___initializing__);
1433 if (value == NULL)
1434 PyErr_Clear();
1435 else {
1436 initializing = PyObject_IsTrue(value);
1437 Py_DECREF(value);
1438 if (initializing == -1)
1439 PyErr_Clear();
1440 }
1441 if (initializing > 0) {
1442 /* _bootstrap._lock_unlock_module() releases the import lock */
Alexandre Vassalotti865eaa12013-05-02 10:44:04 -07001443 value = _PyObject_CallMethodIdObjArgs(interp->importlib,
Antoine Pitrouea3eb882012-05-17 18:55:59 +02001444 &PyId__lock_unlock_module, abs_name,
1445 NULL);
1446 if (value == NULL)
1447 goto error;
1448 Py_DECREF(value);
1449 }
1450 else {
1451#ifdef WITH_THREAD
1452 if (_PyImport_ReleaseLock() < 0) {
1453 PyErr_SetString(PyExc_RuntimeError, "not holding the import lock");
1454 goto error;
1455 }
1456#endif
1457 }
Brett Cannonfd074152012-04-14 14:10:13 -04001458 }
1459 else {
Antoine Pitrouea3eb882012-05-17 18:55:59 +02001460 /* _bootstrap._find_and_load() releases the import lock */
Alexandre Vassalotti865eaa12013-05-02 10:44:04 -07001461 mod = _PyObject_CallMethodIdObjArgs(interp->importlib,
Brett Cannonfd074152012-04-14 14:10:13 -04001462 &PyId__find_and_load, abs_name,
1463 builtins_import, NULL);
1464 if (mod == NULL) {
Antoine Pitrouea3eb882012-05-17 18:55:59 +02001465 goto error;
Brett Cannonfd074152012-04-14 14:10:13 -04001466 }
1467 }
Antoine Pitrouea3eb882012-05-17 18:55:59 +02001468 /* From now on we don't hold the import lock anymore. */
Brett Cannonfd074152012-04-14 14:10:13 -04001469
1470 if (PyObject_Not(fromlist)) {
1471 if (level == 0 || PyUnicode_GET_LENGTH(name) > 0) {
1472 PyObject *front = NULL;
Brian Curtine6b299f2012-04-14 14:19:33 -05001473 PyObject *partition = NULL;
Brett Cannonfd074152012-04-14 14:10:13 -04001474 PyObject *borrowed_dot = _PyUnicode_FromId(&single_dot);
1475
1476 if (borrowed_dot == NULL) {
Antoine Pitrouea3eb882012-05-17 18:55:59 +02001477 goto error;
Brett Cannonfd074152012-04-14 14:10:13 -04001478 }
1479
Brian Curtine6b299f2012-04-14 14:19:33 -05001480 partition = PyUnicode_Partition(name, borrowed_dot);
Brett Cannonfd074152012-04-14 14:10:13 -04001481 if (partition == NULL) {
Antoine Pitrouea3eb882012-05-17 18:55:59 +02001482 goto error;
Brett Cannonfd074152012-04-14 14:10:13 -04001483 }
1484
Antoine Pitrou6efa50a2012-05-07 21:41:59 +02001485 if (PyUnicode_GET_LENGTH(PyTuple_GET_ITEM(partition, 1)) == 0) {
1486 /* No dot in module name, simple exit */
1487 Py_DECREF(partition);
1488 final_mod = mod;
1489 Py_INCREF(mod);
Antoine Pitrouea3eb882012-05-17 18:55:59 +02001490 goto error;
Antoine Pitrou6efa50a2012-05-07 21:41:59 +02001491 }
1492
Brett Cannonfd074152012-04-14 14:10:13 -04001493 front = PyTuple_GET_ITEM(partition, 0);
1494 Py_INCREF(front);
1495 Py_DECREF(partition);
1496
1497 if (level == 0) {
Antoine Pitrou6efa50a2012-05-07 21:41:59 +02001498 final_mod = PyObject_CallFunctionObjArgs(builtins_import, front, NULL);
Antoine Pitroub78174c2012-05-06 17:15:23 +02001499 Py_DECREF(front);
Brett Cannonfd074152012-04-14 14:10:13 -04001500 }
1501 else {
Antoine Pitrou22a1d172012-04-16 22:06:21 +02001502 Py_ssize_t cut_off = PyUnicode_GET_LENGTH(name) -
1503 PyUnicode_GET_LENGTH(front);
1504 Py_ssize_t abs_name_len = PyUnicode_GET_LENGTH(abs_name);
Brett Cannon49f8d8b2012-04-14 21:50:00 -04001505 PyObject *to_return = PyUnicode_Substring(abs_name, 0,
Brett Cannonfd074152012-04-14 14:10:13 -04001506 abs_name_len - cut_off);
Antoine Pitrou22a1d172012-04-16 22:06:21 +02001507 Py_DECREF(front);
1508 if (to_return == NULL) {
Antoine Pitrouea3eb882012-05-17 18:55:59 +02001509 goto error;
Antoine Pitrou22a1d172012-04-16 22:06:21 +02001510 }
Brett Cannonfd074152012-04-14 14:10:13 -04001511
1512 final_mod = PyDict_GetItem(interp->modules, to_return);
Brett Cannon49f8d8b2012-04-14 21:50:00 -04001513 if (final_mod == NULL) {
1514 PyErr_Format(PyExc_KeyError,
1515 "%R not in sys.modules as expected",
1516 to_return);
1517 }
1518 else {
1519 Py_INCREF(final_mod);
1520 }
Antoine Pitroub78174c2012-05-06 17:15:23 +02001521 Py_DECREF(to_return);
Brett Cannonfd074152012-04-14 14:10:13 -04001522 }
1523 }
1524 else {
1525 final_mod = mod;
1526 Py_INCREF(mod);
1527 }
1528 }
1529 else {
Alexandre Vassalotti865eaa12013-05-02 10:44:04 -07001530 final_mod = _PyObject_CallMethodIdObjArgs(interp->importlib,
Brett Cannonfd074152012-04-14 14:10:13 -04001531 &PyId__handle_fromlist, mod,
1532 fromlist, builtins_import,
1533 NULL);
1534 }
Antoine Pitrouea3eb882012-05-17 18:55:59 +02001535 goto error;
Antoine Pitrou6efa50a2012-05-07 21:41:59 +02001536
Brett Cannonfd074152012-04-14 14:10:13 -04001537 error_with_unlock:
Brian Curtine6b299f2012-04-14 14:19:33 -05001538#ifdef WITH_THREAD
Brett Cannonfd074152012-04-14 14:10:13 -04001539 if (_PyImport_ReleaseLock() < 0) {
1540 PyErr_SetString(PyExc_RuntimeError, "not holding the import lock");
1541 }
1542#endif
1543 error:
1544 Py_XDECREF(abs_name);
1545 Py_XDECREF(builtins_import);
1546 Py_XDECREF(mod);
1547 Py_XDECREF(package);
1548 Py_XDECREF(globals);
1549 Py_XDECREF(fromlist);
Antoine Pitroubc07a5c2012-07-08 12:01:27 +02001550 if (final_mod == NULL)
1551 remove_importlib_frames();
Brett Cannonfd074152012-04-14 14:10:13 -04001552 return final_mod;
Guido van Rossum75acc9c1998-03-03 22:26:50 +00001553}
1554
Victor Stinnerfe93faf2011-03-14 15:54:52 -04001555PyObject *
Benjamin Peterson04778a82011-05-25 09:29:00 -05001556PyImport_ImportModuleLevel(const char *name, PyObject *globals, PyObject *locals,
Victor Stinnerfe93faf2011-03-14 15:54:52 -04001557 PyObject *fromlist, int level)
1558{
1559 PyObject *nameobj, *mod;
1560 nameobj = PyUnicode_FromString(name);
1561 if (nameobj == NULL)
1562 return NULL;
1563 mod = PyImport_ImportModuleLevelObject(nameobj, globals, locals,
1564 fromlist, level);
1565 Py_DECREF(nameobj);
1566 return mod;
1567}
1568
1569
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001570/* Re-import a module of any kind and return its module object, WITH
1571 INCREMENTED REFERENCE COUNT */
1572
Guido van Rossum79f25d91997-04-29 20:08:16 +00001573PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001574PyImport_ReloadModule(PyObject *m)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001575{
Brett Cannon62228db2012-04-29 14:38:11 -04001576 _Py_IDENTIFIER(reload);
1577 PyObject *reloaded_module = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001578 PyObject *modules = PyImport_GetModuleDict();
Brett Cannon62228db2012-04-29 14:38:11 -04001579 PyObject *imp = PyDict_GetItemString(modules, "imp");
1580 if (imp == NULL) {
1581 imp = PyImport_ImportModule("imp");
1582 if (imp == NULL) {
1583 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001584 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001585 }
Brett Cannon62228db2012-04-29 14:38:11 -04001586 else {
1587 Py_INCREF(imp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001588 }
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001589
Brett Cannon62228db2012-04-29 14:38:11 -04001590 reloaded_module = _PyObject_CallMethodId(imp, &PyId_reload, "O", m);
1591 Py_DECREF(imp);
1592 return reloaded_module;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001593}
1594
1595
Guido van Rossumd47a0a81997-08-14 20:11:26 +00001596/* Higher-level import emulator which emulates the "import" statement
1597 more accurately -- it invokes the __import__() function from the
1598 builtins of the current globals. This means that the import is
1599 done using whatever import hooks are installed in the current
Brett Cannonbc2eff32010-09-19 21:39:02 +00001600 environment.
Guido van Rossum6058eb41998-12-21 19:51:00 +00001601 A dummy list ["__doc__"] is passed as the 4th argument so that
Neal Norwitz80e7f272007-08-26 06:45:23 +00001602 e.g. PyImport_Import(PyUnicode_FromString("win32com.client.gencache"))
Guido van Rossum6058eb41998-12-21 19:51:00 +00001603 will return <module "gencache"> instead of <module "win32com">. */
Guido van Rossumd47a0a81997-08-14 20:11:26 +00001604
1605PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001606PyImport_Import(PyObject *module_name)
Guido van Rossumd47a0a81997-08-14 20:11:26 +00001607{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001608 static PyObject *silly_list = NULL;
1609 static PyObject *builtins_str = NULL;
1610 static PyObject *import_str = NULL;
1611 PyObject *globals = NULL;
1612 PyObject *import = NULL;
1613 PyObject *builtins = NULL;
Brett Cannonbc2eff32010-09-19 21:39:02 +00001614 PyObject *modules = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001615 PyObject *r = NULL;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00001616
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001617 /* Initialize constant string objects */
1618 if (silly_list == NULL) {
1619 import_str = PyUnicode_InternFromString("__import__");
1620 if (import_str == NULL)
1621 return NULL;
1622 builtins_str = PyUnicode_InternFromString("__builtins__");
1623 if (builtins_str == NULL)
1624 return NULL;
Brett Cannonbc2eff32010-09-19 21:39:02 +00001625 silly_list = PyList_New(0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001626 if (silly_list == NULL)
1627 return NULL;
1628 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00001629
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001630 /* Get the builtins from current globals */
1631 globals = PyEval_GetGlobals();
1632 if (globals != NULL) {
1633 Py_INCREF(globals);
1634 builtins = PyObject_GetItem(globals, builtins_str);
1635 if (builtins == NULL)
1636 goto err;
1637 }
1638 else {
1639 /* No globals -- use standard builtins, and fake globals */
1640 builtins = PyImport_ImportModuleLevel("builtins",
1641 NULL, NULL, NULL, 0);
1642 if (builtins == NULL)
1643 return NULL;
1644 globals = Py_BuildValue("{OO}", builtins_str, builtins);
1645 if (globals == NULL)
1646 goto err;
1647 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00001648
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001649 /* Get the __import__ function from the builtins */
1650 if (PyDict_Check(builtins)) {
1651 import = PyObject_GetItem(builtins, import_str);
1652 if (import == NULL)
1653 PyErr_SetObject(PyExc_KeyError, import_str);
1654 }
1655 else
1656 import = PyObject_GetAttr(builtins, import_str);
1657 if (import == NULL)
1658 goto err;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00001659
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001660 /* Call the __import__ function with the proper argument list
Brett Cannonbc2eff32010-09-19 21:39:02 +00001661 Always use absolute import here.
1662 Calling for side-effect of import. */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001663 r = PyObject_CallFunction(import, "OOOOi", module_name, globals,
1664 globals, silly_list, 0, NULL);
Brett Cannonbc2eff32010-09-19 21:39:02 +00001665 if (r == NULL)
1666 goto err;
1667 Py_DECREF(r);
1668
1669 modules = PyImport_GetModuleDict();
1670 r = PyDict_GetItem(modules, module_name);
1671 if (r != NULL)
1672 Py_INCREF(r);
Guido van Rossumd47a0a81997-08-14 20:11:26 +00001673
1674 err:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001675 Py_XDECREF(globals);
1676 Py_XDECREF(builtins);
1677 Py_XDECREF(import);
Tim Peters50d8d372001-02-28 05:34:27 +00001678
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001679 return r;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00001680}
1681
Barry Warsaw28a691b2010-04-17 00:19:56 +00001682static PyObject *
Brett Cannon2657df42012-05-04 15:20:40 -04001683imp_extension_suffixes(PyObject *self, PyObject *noargs)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001684{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001685 PyObject *list;
Brett Cannon2657df42012-05-04 15:20:40 -04001686 const char *suffix;
1687 unsigned int index = 0;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001688
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001689 list = PyList_New(0);
1690 if (list == NULL)
1691 return NULL;
Brett Cannon2657df42012-05-04 15:20:40 -04001692#ifdef HAVE_DYNAMIC_LOADING
1693 while ((suffix = _PyImport_DynLoadFiletab[index])) {
1694 PyObject *item = PyUnicode_FromString(suffix);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001695 if (item == NULL) {
1696 Py_DECREF(list);
1697 return NULL;
1698 }
1699 if (PyList_Append(list, item) < 0) {
1700 Py_DECREF(list);
1701 Py_DECREF(item);
1702 return NULL;
1703 }
1704 Py_DECREF(item);
Brett Cannon2657df42012-05-04 15:20:40 -04001705 index += 1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001706 }
Brett Cannon2657df42012-05-04 15:20:40 -04001707#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001708 return list;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001709}
1710
Guido van Rossum79f25d91997-04-29 20:08:16 +00001711static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001712imp_init_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001713{
Victor Stinner95872862011-03-07 18:20:56 +01001714 PyObject *name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001715 int ret;
1716 PyObject *m;
Victor Stinner95872862011-03-07 18:20:56 +01001717 if (!PyArg_ParseTuple(args, "U:init_builtin", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001718 return NULL;
1719 ret = init_builtin(name);
1720 if (ret < 0)
1721 return NULL;
1722 if (ret == 0) {
1723 Py_INCREF(Py_None);
1724 return Py_None;
1725 }
Victor Stinner95872862011-03-07 18:20:56 +01001726 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001727 Py_XINCREF(m);
1728 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001729}
1730
Guido van Rossum79f25d91997-04-29 20:08:16 +00001731static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001732imp_init_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001733{
Victor Stinner53dc7352011-03-20 01:50:21 +01001734 PyObject *name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001735 int ret;
1736 PyObject *m;
Victor Stinner53dc7352011-03-20 01:50:21 +01001737 if (!PyArg_ParseTuple(args, "U:init_frozen", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001738 return NULL;
Victor Stinner53dc7352011-03-20 01:50:21 +01001739 ret = PyImport_ImportFrozenModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001740 if (ret < 0)
1741 return NULL;
1742 if (ret == 0) {
1743 Py_INCREF(Py_None);
1744 return Py_None;
1745 }
Victor Stinner53dc7352011-03-20 01:50:21 +01001746 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001747 Py_XINCREF(m);
1748 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001749}
1750
Guido van Rossum79f25d91997-04-29 20:08:16 +00001751static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001752imp_get_frozen_object(PyObject *self, PyObject *args)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001753{
Victor Stinner53dc7352011-03-20 01:50:21 +01001754 PyObject *name;
Jack Jansen95ffa231995-10-03 14:38:41 +00001755
Victor Stinner53dc7352011-03-20 01:50:21 +01001756 if (!PyArg_ParseTuple(args, "U:get_frozen_object", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001757 return NULL;
1758 return get_frozen_object(name);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001759}
1760
Guido van Rossum79f25d91997-04-29 20:08:16 +00001761static PyObject *
Brett Cannon8d110132009-03-15 02:20:16 +00001762imp_is_frozen_package(PyObject *self, PyObject *args)
1763{
Victor Stinner53dc7352011-03-20 01:50:21 +01001764 PyObject *name;
Brett Cannon8d110132009-03-15 02:20:16 +00001765
Victor Stinner53dc7352011-03-20 01:50:21 +01001766 if (!PyArg_ParseTuple(args, "U:is_frozen_package", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001767 return NULL;
1768 return is_frozen_package(name);
Brett Cannon8d110132009-03-15 02:20:16 +00001769}
1770
1771static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001772imp_is_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001773{
Victor Stinner95872862011-03-07 18:20:56 +01001774 PyObject *name;
1775 if (!PyArg_ParseTuple(args, "U:is_builtin", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001776 return NULL;
1777 return PyLong_FromLong(is_builtin(name));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001778}
1779
Guido van Rossum79f25d91997-04-29 20:08:16 +00001780static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001781imp_is_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001782{
Victor Stinner53dc7352011-03-20 01:50:21 +01001783 PyObject *name;
Benjamin Peterson6fba3db2013-03-18 23:13:31 -07001784 const struct _frozen *p;
Victor Stinner53dc7352011-03-20 01:50:21 +01001785 if (!PyArg_ParseTuple(args, "U:is_frozen", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001786 return NULL;
1787 p = find_frozen(name);
1788 return PyBool_FromLong((long) (p == NULL ? 0 : p->size));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001789}
1790
Guido van Rossum96a8fb71999-12-22 14:09:35 +00001791#ifdef HAVE_DYNAMIC_LOADING
1792
Guido van Rossum79f25d91997-04-29 20:08:16 +00001793static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001794imp_load_dynamic(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001795{
Victor Stinnerfefd70c2011-03-14 15:54:07 -04001796 PyObject *name, *pathname, *fob = NULL, *mod;
1797 FILE *fp;
1798
1799 if (!PyArg_ParseTuple(args, "UO&|O:load_dynamic",
1800 &name, PyUnicode_FSDecoder, &pathname, &fob))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001801 return NULL;
Victor Stinnerfefd70c2011-03-14 15:54:07 -04001802 if (fob != NULL) {
Antoine Pitrouf3a42de2012-05-04 22:40:25 +02001803 fp = _Py_fopen(pathname, "r");
Victor Stinnere9ddbf62011-03-22 10:46:35 +01001804 if (fp == NULL) {
1805 Py_DECREF(pathname);
Antoine Pitrouf3a42de2012-05-04 22:40:25 +02001806 if (!PyErr_Occurred())
1807 PyErr_SetFromErrno(PyExc_IOError);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001808 return NULL;
Victor Stinnere9ddbf62011-03-22 10:46:35 +01001809 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001810 }
Victor Stinnerfefd70c2011-03-14 15:54:07 -04001811 else
1812 fp = NULL;
1813 mod = _PyImport_LoadDynamicModule(name, pathname, fp);
Victor Stinnere9ddbf62011-03-22 10:46:35 +01001814 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001815 if (fp)
1816 fclose(fp);
Victor Stinnerfefd70c2011-03-14 15:54:07 -04001817 return mod;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001818}
1819
Guido van Rossum96a8fb71999-12-22 14:09:35 +00001820#endif /* HAVE_DYNAMIC_LOADING */
1821
Barry Warsaw28a691b2010-04-17 00:19:56 +00001822
Guido van Rossum0207e6d1997-09-09 22:04:42 +00001823/* Doc strings */
1824
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001825PyDoc_STRVAR(doc_imp,
Brett Cannon6f44d662012-04-15 16:08:47 -04001826"(Extremely) low-level import machinery bits as used by importlib and imp.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00001827
Brett Cannon2657df42012-05-04 15:20:40 -04001828PyDoc_STRVAR(doc_extension_suffixes,
1829"extension_suffixes() -> list of strings\n\
1830Returns the list of file suffixes used to identify extension modules.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00001831
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001832PyDoc_STRVAR(doc_lock_held,
Tim Petersa7c65092004-08-01 23:26:05 +00001833"lock_held() -> boolean\n\
1834Return True if the import lock is currently held, else False.\n\
1835On platforms without threads, return False.");
Tim Peters69232342001-08-30 05:16:13 +00001836
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00001837PyDoc_STRVAR(doc_acquire_lock,
1838"acquire_lock() -> None\n\
Neal Norwitz2294c0d2003-02-12 23:02:21 +00001839Acquires the interpreter's import lock for the current thread.\n\
1840This lock should be used by import hooks to ensure thread-safety\n\
1841when importing modules.\n\
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00001842On platforms without threads, this function does nothing.");
1843
1844PyDoc_STRVAR(doc_release_lock,
1845"release_lock() -> None\n\
1846Release the interpreter's import lock.\n\
1847On platforms without threads, this function does nothing.");
1848
Guido van Rossum79f25d91997-04-29 20:08:16 +00001849static PyMethodDef imp_methods[] = {
Brett Cannon2657df42012-05-04 15:20:40 -04001850 {"extension_suffixes", imp_extension_suffixes, METH_NOARGS,
1851 doc_extension_suffixes},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001852 {"lock_held", imp_lock_held, METH_NOARGS, doc_lock_held},
1853 {"acquire_lock", imp_acquire_lock, METH_NOARGS, doc_acquire_lock},
1854 {"release_lock", imp_release_lock, METH_NOARGS, doc_release_lock},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001855 {"get_frozen_object", imp_get_frozen_object, METH_VARARGS},
1856 {"is_frozen_package", imp_is_frozen_package, METH_VARARGS},
1857 {"init_builtin", imp_init_builtin, METH_VARARGS},
1858 {"init_frozen", imp_init_frozen, METH_VARARGS},
1859 {"is_builtin", imp_is_builtin, METH_VARARGS},
1860 {"is_frozen", imp_is_frozen, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00001861#ifdef HAVE_DYNAMIC_LOADING
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001862 {"load_dynamic", imp_load_dynamic, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00001863#endif
Brett Cannon442c9b92011-03-23 16:14:42 -07001864 {"_fix_co_filename", imp_fix_co_filename, METH_VARARGS},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001865 {NULL, NULL} /* sentinel */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001866};
1867
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001868
Martin v. Löwis1a214512008-06-11 05:26:20 +00001869static struct PyModuleDef impmodule = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001870 PyModuleDef_HEAD_INIT,
Brett Cannon6f44d662012-04-15 16:08:47 -04001871 "_imp",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001872 doc_imp,
1873 0,
1874 imp_methods,
1875 NULL,
1876 NULL,
1877 NULL,
1878 NULL
Martin v. Löwis1a214512008-06-11 05:26:20 +00001879};
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001880
Jason Tishler6bc06ec2003-09-04 11:59:50 +00001881PyMODINIT_FUNC
Martin v. Löwis1a214512008-06-11 05:26:20 +00001882PyInit_imp(void)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001883{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001884 PyObject *m, *d;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001885
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001886 m = PyModule_Create(&impmodule);
1887 if (m == NULL)
1888 goto failure;
1889 d = PyModule_GetDict(m);
1890 if (d == NULL)
1891 goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001892
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001893 return m;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001894 failure:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001895 Py_XDECREF(m);
1896 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001897}
Guido van Rossum09cae1f1998-05-14 02:32:54 +00001898
1899
Guido van Rossumb18618d2000-05-03 23:44:39 +00001900/* API for embedding applications that want to add their own entries
1901 to the table of built-in modules. This should normally be called
1902 *before* Py_Initialize(). When the table resize fails, -1 is
1903 returned and the existing table is unchanged.
Guido van Rossum09cae1f1998-05-14 02:32:54 +00001904
1905 After a similar function by Just van Rossum. */
1906
1907int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001908PyImport_ExtendInittab(struct _inittab *newtab)
Guido van Rossum09cae1f1998-05-14 02:32:54 +00001909{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001910 static struct _inittab *our_copy = NULL;
1911 struct _inittab *p;
1912 int i, n;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00001913
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001914 /* Count the number of entries in both tables */
1915 for (n = 0; newtab[n].name != NULL; n++)
1916 ;
1917 if (n == 0)
1918 return 0; /* Nothing to do */
1919 for (i = 0; PyImport_Inittab[i].name != NULL; i++)
1920 ;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00001921
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001922 /* Allocate new memory for the combined table */
1923 p = our_copy;
1924 PyMem_RESIZE(p, struct _inittab, i+n+1);
1925 if (p == NULL)
1926 return -1;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00001927
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001928 /* Copy the tables into the new memory */
1929 if (our_copy != PyImport_Inittab)
1930 memcpy(p, PyImport_Inittab, (i+1) * sizeof(struct _inittab));
1931 PyImport_Inittab = our_copy = p;
1932 memcpy(p+i, newtab, (n+1) * sizeof(struct _inittab));
Guido van Rossum09cae1f1998-05-14 02:32:54 +00001933
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001934 return 0;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00001935}
1936
1937/* Shorthand to add a single entry given a name and a function */
1938
1939int
Brett Cannona826f322009-04-02 03:41:46 +00001940PyImport_AppendInittab(const char *name, PyObject* (*initfunc)(void))
Guido van Rossum09cae1f1998-05-14 02:32:54 +00001941{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001942 struct _inittab newtab[2];
Guido van Rossum09cae1f1998-05-14 02:32:54 +00001943
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001944 memset(newtab, '\0', sizeof newtab);
Guido van Rossum09cae1f1998-05-14 02:32:54 +00001945
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001946 newtab[0].name = (char *)name;
1947 newtab[0].initfunc = initfunc;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00001948
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001949 return PyImport_ExtendInittab(newtab);
Guido van Rossum09cae1f1998-05-14 02:32:54 +00001950}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001951
1952#ifdef __cplusplus
1953}
1954#endif