blob: edf030d87ae9d359947a767c15aa0ed265525a39 [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
Guido van Rossum771c6c81997-10-31 18:37:24 +000027/* This table is defined in config.c: */
28extern struct _inittab _PyImport_Inittab[];
29
30struct _inittab *PyImport_Inittab = _PyImport_Inittab;
Guido van Rossum66f1fa81991-04-03 19:03:52 +000031
Victor Stinnerd0296212011-03-14 14:04:10 -040032static PyObject *initstr = NULL;
Thomas Wouters0e3f5912006-08-11 14:57:12 +000033
Brett Cannon4caa61d2014-01-09 19:03:32 -050034/*[clinic input]
35module _imp
36[clinic start generated code]*/
Serhiy Storchaka1009bf12015-04-03 23:53:51 +030037/*[clinic end generated code: output=da39a3ee5e6b4b0d input=9c332475d8686284]*/
Brett Cannonfd4d0502014-05-30 11:21:14 -040038
39#include "clinic/import.c.h"
Brett Cannon4caa61d2014-01-09 19:03:32 -050040
41/*[python input]
42class fs_unicode_converter(CConverter):
43 type = 'PyObject *'
44 converter = 'PyUnicode_FSDecoder'
45
46[python start generated code]*/
Larry Hastings581ee362014-01-28 05:00:08 -080047/*[python end generated code: output=da39a3ee5e6b4b0d input=9d6786230166006e]*/
Brett Cannon4caa61d2014-01-09 19:03:32 -050048
Guido van Rossum1ae940a1995-01-02 19:04:15 +000049/* Initialize things */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000050
51void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +000052_PyImport_Init(void)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000053{
Serhiy Storchaka013bb912014-02-10 18:21:34 +020054 PyInterpreterState *interp = PyThreadState_Get()->interp;
Victor Stinnerd0296212011-03-14 14:04:10 -040055 initstr = PyUnicode_InternFromString("__init__");
56 if (initstr == NULL)
57 Py_FatalError("Can't initialize import variables");
Serhiy Storchaka013bb912014-02-10 18:21:34 +020058 interp->builtins_copy = PyDict_Copy(interp->builtins);
59 if (interp->builtins_copy == NULL)
60 Py_FatalError("Can't backup builtins dict");
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000061}
62
Guido van Rossum25ce5661997-08-02 03:10:38 +000063void
Just van Rossum52e14d62002-12-30 22:08:05 +000064_PyImportHooks_Init(void)
65{
Brett Cannonfd074152012-04-14 14:10:13 -040066 PyObject *v, *path_hooks = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000067 int err = 0;
Just van Rossum52e14d62002-12-30 22:08:05 +000068
Brett Cannonfd074152012-04-14 14:10:13 -040069 /* adding sys.path_hooks and sys.path_importer_cache */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000070 v = PyList_New(0);
71 if (v == NULL)
72 goto error;
73 err = PySys_SetObject("meta_path", v);
74 Py_DECREF(v);
75 if (err)
76 goto error;
77 v = PyDict_New();
78 if (v == NULL)
79 goto error;
80 err = PySys_SetObject("path_importer_cache", v);
81 Py_DECREF(v);
82 if (err)
83 goto error;
84 path_hooks = PyList_New(0);
85 if (path_hooks == NULL)
86 goto error;
87 err = PySys_SetObject("path_hooks", path_hooks);
88 if (err) {
Just van Rossum52e14d62002-12-30 22:08:05 +000089 error:
Brett Cannonfd074152012-04-14 14:10:13 -040090 PyErr_Print();
91 Py_FatalError("initializing sys.meta_path, sys.path_hooks, "
Nadeem Vawda8f46d652012-05-05 12:27:30 +020092 "or path_importer_cache failed");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000093 }
Brett Cannonfd074152012-04-14 14:10:13 -040094 Py_DECREF(path_hooks);
95}
96
97void
98_PyImportZip_Init(void)
99{
100 PyObject *path_hooks, *zimpimport;
101 int err = 0;
102
103 path_hooks = PySys_GetObject("path_hooks");
Victor Stinner1e53bba2013-07-16 22:26:05 +0200104 if (path_hooks == NULL) {
105 PyErr_SetString(PyExc_RuntimeError, "unable to get sys.path_hooks");
Brett Cannonfd074152012-04-14 14:10:13 -0400106 goto error;
Victor Stinner1e53bba2013-07-16 22:26:05 +0200107 }
Brett Cannonfd074152012-04-14 14:10:13 -0400108
109 if (Py_VerboseFlag)
110 PySys_WriteStderr("# installing zipimport hook\n");
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000111
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000112 zimpimport = PyImport_ImportModule("zipimport");
113 if (zimpimport == NULL) {
114 PyErr_Clear(); /* No zip import module -- okay */
115 if (Py_VerboseFlag)
116 PySys_WriteStderr("# can't import zipimport\n");
117 }
118 else {
Martin v. Löwisbd928fe2011-10-14 10:20:37 +0200119 _Py_IDENTIFIER(zipimporter);
Martin v. Löwis1ee1b6f2011-10-10 18:11:30 +0200120 PyObject *zipimporter = _PyObject_GetAttrId(zimpimport,
121 &PyId_zipimporter);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000122 Py_DECREF(zimpimport);
123 if (zipimporter == NULL) {
124 PyErr_Clear(); /* No zipimporter object -- okay */
125 if (Py_VerboseFlag)
126 PySys_WriteStderr(
127 "# can't import zipimport.zipimporter\n");
128 }
129 else {
Brett Cannon8923a4d2012-04-24 22:03:46 -0400130 /* sys.path_hooks.insert(0, zipimporter) */
131 err = PyList_Insert(path_hooks, 0, zipimporter);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000132 Py_DECREF(zipimporter);
Brett Cannonfd074152012-04-14 14:10:13 -0400133 if (err < 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000134 goto error;
Brett Cannonfd074152012-04-14 14:10:13 -0400135 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000136 if (Py_VerboseFlag)
137 PySys_WriteStderr(
138 "# installed zipimport hook\n");
139 }
140 }
Brett Cannonfd074152012-04-14 14:10:13 -0400141
142 return;
143
144 error:
145 PyErr_Print();
Brett Cannonacf85cd2012-04-29 12:50:03 -0400146 Py_FatalError("initializing zipimport failed");
Just van Rossum52e14d62002-12-30 22:08:05 +0000147}
148
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000149/* Locking primitives to prevent parallel imports of the same module
150 in different threads to return with a partially loaded module.
151 These calls are serialized by the global interpreter lock. */
152
153#ifdef WITH_THREAD
154
Guido van Rossum49b56061998-10-01 20:42:43 +0000155#include "pythread.h"
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000156
Guido van Rossum65d5b571998-12-21 19:32:43 +0000157static PyThread_type_lock import_lock = 0;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000158static long import_lock_thread = -1;
159static int import_lock_level = 0;
160
Benjamin Peterson0df35a92009-10-04 20:32:25 +0000161void
162_PyImport_AcquireLock(void)
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000163{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000164 long me = PyThread_get_thread_ident();
165 if (me == -1)
166 return; /* Too bad */
167 if (import_lock == NULL) {
168 import_lock = PyThread_allocate_lock();
169 if (import_lock == NULL)
170 return; /* Nothing much we can do. */
171 }
172 if (import_lock_thread == me) {
173 import_lock_level++;
174 return;
175 }
176 if (import_lock_thread != -1 || !PyThread_acquire_lock(import_lock, 0))
177 {
178 PyThreadState *tstate = PyEval_SaveThread();
179 PyThread_acquire_lock(import_lock, 1);
180 PyEval_RestoreThread(tstate);
181 }
Antoine Pitrou202b6062012-12-18 22:18:17 +0100182 assert(import_lock_level == 0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000183 import_lock_thread = me;
184 import_lock_level = 1;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000185}
186
Benjamin Peterson0df35a92009-10-04 20:32:25 +0000187int
188_PyImport_ReleaseLock(void)
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000189{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000190 long me = PyThread_get_thread_ident();
191 if (me == -1 || import_lock == NULL)
192 return 0; /* Too bad */
193 if (import_lock_thread != me)
194 return -1;
195 import_lock_level--;
Antoine Pitrou202b6062012-12-18 22:18:17 +0100196 assert(import_lock_level >= 0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000197 if (import_lock_level == 0) {
198 import_lock_thread = -1;
199 PyThread_release_lock(import_lock);
200 }
201 return 1;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000202}
203
Gregory P. Smith24cec9f2010-03-01 06:18:41 +0000204/* This function is called from PyOS_AfterFork to ensure that newly
205 created child processes do not share locks with the parent.
206 We now acquire the import lock around fork() calls but on some platforms
207 (Solaris 9 and earlier? see isue7242) that still left us with problems. */
Guido van Rossum8ee3e5a2005-09-14 18:09:42 +0000208
209void
210_PyImport_ReInitLock(void)
211{
Christian Heimes418fd742015-04-19 21:08:42 +0200212 if (import_lock != NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000213 import_lock = PyThread_allocate_lock();
Christian Heimes418fd742015-04-19 21:08:42 +0200214 if (import_lock == NULL) {
215 Py_FatalError("PyImport_ReInitLock failed to create a new lock");
216 }
217 }
Nick Coghlanb2ddf792010-12-02 04:11:46 +0000218 if (import_lock_level > 1) {
219 /* Forked as a side effect of import */
220 long me = PyThread_get_thread_ident();
Brett Cannone4710cf2012-11-15 21:39:36 -0500221 /* The following could fail if the lock is already held, but forking as
222 a side-effect of an import is a) rare, b) nuts, and c) difficult to
223 do thanks to the lock only being held when doing individual module
224 locks per import. */
225 PyThread_acquire_lock(import_lock, NOWAIT_LOCK);
Nick Coghlanb2ddf792010-12-02 04:11:46 +0000226 import_lock_thread = me;
227 import_lock_level--;
228 } else {
229 import_lock_thread = -1;
230 import_lock_level = 0;
231 }
Guido van Rossum8ee3e5a2005-09-14 18:09:42 +0000232}
233
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000234#endif
235
Brett Cannon4caa61d2014-01-09 19:03:32 -0500236/*[clinic input]
237_imp.lock_held
238
239Return True if the import lock is currently held, else False.
240
241On platforms without threads, return False.
242[clinic start generated code]*/
243
Brett Cannon4caa61d2014-01-09 19:03:32 -0500244static PyObject *
245_imp_lock_held_impl(PyModuleDef *module)
Brett Cannonfd4d0502014-05-30 11:21:14 -0400246/*[clinic end generated code: output=d7a8cc3a5169081a input=9b088f9b217d9bdf]*/
Tim Peters69232342001-08-30 05:16:13 +0000247{
Tim Peters69232342001-08-30 05:16:13 +0000248#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000249 return PyBool_FromLong(import_lock_thread != -1);
Tim Peters69232342001-08-30 05:16:13 +0000250#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000251 return PyBool_FromLong(0);
Tim Peters69232342001-08-30 05:16:13 +0000252#endif
253}
254
Brett Cannon4caa61d2014-01-09 19:03:32 -0500255/*[clinic input]
256_imp.acquire_lock
257
258Acquires the interpreter's import lock for the current thread.
259
260This lock should be used by import hooks to ensure thread-safety when importing
261modules. On platforms without threads, this function does nothing.
262[clinic start generated code]*/
263
Brett Cannon4caa61d2014-01-09 19:03:32 -0500264static PyObject *
265_imp_acquire_lock_impl(PyModuleDef *module)
Brett Cannonfd4d0502014-05-30 11:21:14 -0400266/*[clinic end generated code: output=cc143b1d16422cae input=4a2d4381866d5fdc]*/
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000267{
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000268#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000269 _PyImport_AcquireLock();
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000270#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000271 Py_INCREF(Py_None);
272 return Py_None;
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000273}
274
Brett Cannon4caa61d2014-01-09 19:03:32 -0500275/*[clinic input]
276_imp.release_lock
277
278Release the interpreter's import lock.
279
280On platforms without threads, this function does nothing.
281[clinic start generated code]*/
282
Brett Cannon4caa61d2014-01-09 19:03:32 -0500283static PyObject *
284_imp_release_lock_impl(PyModuleDef *module)
Brett Cannonfd4d0502014-05-30 11:21:14 -0400285/*[clinic end generated code: output=74d28e38ebe2b224 input=934fb11516dd778b]*/
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000286{
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000287#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000288 if (_PyImport_ReleaseLock() < 0) {
289 PyErr_SetString(PyExc_RuntimeError,
290 "not holding the import lock");
291 return NULL;
292 }
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000293#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000294 Py_INCREF(Py_None);
295 return Py_None;
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000296}
297
Antoine Pitrou8db076c2011-10-30 19:13:55 +0100298void
299_PyImport_Fini(void)
300{
Serhiy Storchaka505ff752014-02-09 13:33:53 +0200301 Py_CLEAR(extensions);
Antoine Pitrou8db076c2011-10-30 19:13:55 +0100302#ifdef WITH_THREAD
303 if (import_lock != NULL) {
304 PyThread_free_lock(import_lock);
305 import_lock = NULL;
306 }
307#endif
308}
309
Guido van Rossum25ce5661997-08-02 03:10:38 +0000310/* Helper for sys */
311
312PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000313PyImport_GetModuleDict(void)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000314{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000315 PyInterpreterState *interp = PyThreadState_GET()->interp;
316 if (interp->modules == NULL)
317 Py_FatalError("PyImport_GetModuleDict: no module dictionary!");
318 return interp->modules;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000319}
320
Guido van Rossum3f5da241990-12-20 15:06:42 +0000321
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000322/* List of names to clear in sys */
323static char* sys_deletes[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000324 "path", "argv", "ps1", "ps2",
325 "last_type", "last_value", "last_traceback",
326 "path_hooks", "path_importer_cache", "meta_path",
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200327 "__interactivehook__",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000328 /* misc stuff */
329 "flags", "float_info",
330 NULL
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000331};
332
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000333static char* sys_files[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000334 "stdin", "__stdin__",
335 "stdout", "__stdout__",
336 "stderr", "__stderr__",
337 NULL
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000338};
339
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000340/* Un-initialize things, as good as we can */
Guido van Rossum3f5da241990-12-20 15:06:42 +0000341
Guido van Rossum3f5da241990-12-20 15:06:42 +0000342void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000343PyImport_Cleanup(void)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000344{
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200345 Py_ssize_t pos;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000346 PyObject *key, *value, *dict;
347 PyInterpreterState *interp = PyThreadState_GET()->interp;
348 PyObject *modules = interp->modules;
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200349 PyObject *weaklist = NULL;
Serhiy Storchaka013bb912014-02-10 18:21:34 +0200350 char **p;
Guido van Rossum758eec01998-01-19 21:58:26 +0000351
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000352 if (modules == NULL)
353 return; /* Already done */
Guido van Rossum758eec01998-01-19 21:58:26 +0000354
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000355 /* Delete some special variables first. These are common
356 places where user values hide and people complain when their
357 destructors fail. Since the modules containing them are
358 deleted *last* of all, they would come too late in the normal
359 destruction order. Sigh. */
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000360
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200361 /* XXX Perhaps these precautions are obsolete. Who knows? */
362
Serhiy Storchaka013bb912014-02-10 18:21:34 +0200363 if (Py_VerboseFlag)
364 PySys_WriteStderr("# clear builtins._\n");
365 PyDict_SetItemString(interp->builtins, "_", Py_None);
366
367 for (p = sys_deletes; *p != NULL; p++) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000368 if (Py_VerboseFlag)
Serhiy Storchaka013bb912014-02-10 18:21:34 +0200369 PySys_WriteStderr("# clear sys.%s\n", *p);
370 PyDict_SetItemString(interp->sysdict, *p, Py_None);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000371 }
Serhiy Storchaka013bb912014-02-10 18:21:34 +0200372 for (p = sys_files; *p != NULL; p+=2) {
373 if (Py_VerboseFlag)
374 PySys_WriteStderr("# restore sys.%s\n", *p);
375 value = PyDict_GetItemString(interp->sysdict, *(p+1));
376 if (value == NULL)
377 value = Py_None;
378 PyDict_SetItemString(interp->sysdict, *p, value);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000379 }
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000380
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200381 /* We prepare a list which will receive (name, weakref) tuples of
382 modules when they are removed from sys.modules. The name is used
383 for diagnosis messages (in verbose mode), while the weakref helps
384 detect those modules which have been held alive. */
385 weaklist = PyList_New(0);
Antoine Pitrou79ba3882013-08-06 22:50:15 +0200386 if (weaklist == NULL)
387 PyErr_Clear();
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200388
Antoine Pitrou79ba3882013-08-06 22:50:15 +0200389#define STORE_MODULE_WEAKREF(name, mod) \
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200390 if (weaklist != NULL) { \
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200391 PyObject *wr = PyWeakref_NewRef(mod, NULL); \
392 if (name && wr) { \
393 PyObject *tup = PyTuple_Pack(2, name, wr); \
394 PyList_Append(weaklist, tup); \
395 Py_XDECREF(tup); \
396 } \
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200397 Py_XDECREF(wr); \
398 if (PyErr_Occurred()) \
399 PyErr_Clear(); \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000400 }
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000401
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200402 /* Remove all modules from sys.modules, hoping that garbage collection
403 can reclaim most of them. */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000404 pos = 0;
405 while (PyDict_Next(modules, &pos, &key, &value)) {
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200406 if (PyModule_Check(value)) {
407 if (Py_VerboseFlag && PyUnicode_Check(key))
Victor Stinnerab826d12014-07-07 23:06:15 +0200408 PySys_FormatStderr("# cleanup[2] removing %U\n", key);
Antoine Pitrou79ba3882013-08-06 22:50:15 +0200409 STORE_MODULE_WEAKREF(key, value);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000410 PyDict_SetItem(modules, key, Py_None);
411 }
412 }
Guido van Rossum758eec01998-01-19 21:58:26 +0000413
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200414 /* Clear the modules dict. */
415 PyDict_Clear(modules);
Serhiy Storchaka013bb912014-02-10 18:21:34 +0200416 /* Restore the original builtins dict, to ensure that any
417 user data gets cleared. */
418 dict = PyDict_Copy(interp->builtins);
419 if (dict == NULL)
420 PyErr_Clear();
421 PyDict_Clear(interp->builtins);
422 if (PyDict_Update(interp->builtins, interp->builtins_copy))
423 PyErr_Clear();
424 Py_XDECREF(dict);
Antoine Pitrou40322e62013-08-11 00:30:09 +0200425 /* Clear module dict copies stored in the interpreter state */
426 _PyState_ClearModules();
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200427 /* Collect references */
428 _PyGC_CollectNoFail();
Antoine Pitrou5f454a02013-05-06 21:15:57 +0200429 /* Dump GC stats before it's too late, since it uses the warnings
430 machinery. */
431 _PyGC_DumpShutdownStats();
432
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200433 /* Now, if there are any modules left alive, clear their globals to
434 minimize potential leaks. All C extension modules actually end
Serhiy Storchaka013bb912014-02-10 18:21:34 +0200435 up here, since they are kept alive in the interpreter state.
436
437 The special treatment of "builtins" here is because even
438 when it's not referenced as a module, its dictionary is
439 referenced by almost every module's __builtins__. Since
440 deleting a module clears its dictionary (even if there are
441 references left to it), we need to delete the "builtins"
442 module last. Likewise, we don't delete sys until the very
443 end because it is implicitly referenced (e.g. by print). */
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200444 if (weaklist != NULL) {
445 Py_ssize_t i, n;
446 n = PyList_GET_SIZE(weaklist);
447 for (i = 0; i < n; i++) {
448 PyObject *tup = PyList_GET_ITEM(weaklist, i);
Antoine Pitrou79ba3882013-08-06 22:50:15 +0200449 PyObject *name = PyTuple_GET_ITEM(tup, 0);
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200450 PyObject *mod = PyWeakref_GET_OBJECT(PyTuple_GET_ITEM(tup, 1));
451 if (mod == Py_None)
452 continue;
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200453 assert(PyModule_Check(mod));
Serhiy Storchaka013bb912014-02-10 18:21:34 +0200454 dict = PyModule_GetDict(mod);
455 if (dict == interp->builtins || dict == interp->sysdict)
456 continue;
457 Py_INCREF(mod);
Antoine Pitrou79ba3882013-08-06 22:50:15 +0200458 if (Py_VerboseFlag && PyUnicode_Check(name))
Serhiy Storchaka013bb912014-02-10 18:21:34 +0200459 PySys_FormatStderr("# cleanup[3] wiping %U\n", name);
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200460 _PyModule_Clear(mod);
461 Py_DECREF(mod);
Antoine Pitrou070cb3c2013-05-08 13:23:25 +0200462 }
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200463 Py_DECREF(weaklist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000464 }
Guido van Rossum758eec01998-01-19 21:58:26 +0000465
Serhiy Storchaka013bb912014-02-10 18:21:34 +0200466 /* Next, delete sys and builtins (in that order) */
467 if (Py_VerboseFlag)
468 PySys_FormatStderr("# cleanup[3] wiping sys\n");
469 _PyModule_ClearDict(interp->sysdict);
470 if (Py_VerboseFlag)
471 PySys_FormatStderr("# cleanup[3] wiping builtins\n");
472 _PyModule_ClearDict(interp->builtins);
473
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200474 /* Clear and delete the modules directory. Actual modules will
475 still be there only if imported during the execution of some
476 destructor. */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000477 interp->modules = NULL;
478 Py_DECREF(modules);
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200479
480 /* Once more */
481 _PyGC_CollectNoFail();
482
483#undef STORE_MODULE_WEAKREF
Guido van Rossum8d15b5d1990-10-26 14:58:58 +0000484}
Guido van Rossum7f133ed1991-02-19 12:23:57 +0000485
486
Barry Warsaw28a691b2010-04-17 00:19:56 +0000487/* Helper for pythonrun.c -- return magic number and tag. */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000488
489long
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000490PyImport_GetMagicNumber(void)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000491{
Antoine Pitrou44b4b6a2012-07-10 18:27:54 +0200492 long res;
Brett Cannon77b2abd2012-07-09 16:09:00 -0400493 PyInterpreterState *interp = PyThreadState_Get()->interp;
Eric Snow32439d62015-05-02 19:15:18 -0600494 PyObject *external, *pyc_magic;
495
496 external = PyObject_GetAttrString(interp->importlib, "_bootstrap_external");
497 if (external == NULL)
498 return -1;
499 pyc_magic = PyObject_GetAttrString(external, "_RAW_MAGIC_NUMBER");
500 Py_DECREF(external);
Brett Cannon77b2abd2012-07-09 16:09:00 -0400501 if (pyc_magic == NULL)
502 return -1;
Antoine Pitrou44b4b6a2012-07-10 18:27:54 +0200503 res = PyLong_AsLong(pyc_magic);
Benjamin Peterson66f36592012-07-09 22:21:55 -0700504 Py_DECREF(pyc_magic);
505 return res;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000506}
507
508
Brett Cannon3adc7b72012-07-09 14:22:12 -0400509extern const char * _PySys_ImplCacheTag;
510
Barry Warsaw28a691b2010-04-17 00:19:56 +0000511const char *
512PyImport_GetMagicTag(void)
513{
Brett Cannon3adc7b72012-07-09 14:22:12 -0400514 return _PySys_ImplCacheTag;
Barry Warsaw28a691b2010-04-17 00:19:56 +0000515}
516
Brett Cannon98979b82012-07-02 15:13:11 -0400517
Guido van Rossum25ce5661997-08-02 03:10:38 +0000518/* Magic for extension modules (built-in as well as dynamically
519 loaded). To prevent initializing an extension module more than
Andrew Svetlov6b2cbeb2012-12-14 17:04:59 +0200520 once, we keep a static dictionary 'extensions' keyed by the tuple
521 (module name, module name) (for built-in modules) or by
522 (filename, module name) (for dynamically loaded modules), containing these
523 modules. A copy of the module's dictionary is stored by calling
524 _PyImport_FixupExtensionObject() immediately after the module initialization
525 function succeeds. A copy can be retrieved from there by calling
Victor Stinner95872862011-03-07 18:20:56 +0100526 _PyImport_FindExtensionObject().
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000527
Barry Warsaw7c9627b2010-06-17 18:38:20 +0000528 Modules which do support multiple initialization set their m_size
529 field to a non-negative number (indicating the size of the
530 module-specific state). They are still recorded in the extensions
531 dictionary, to avoid loading shared libraries twice.
Martin v. Löwis1a214512008-06-11 05:26:20 +0000532*/
533
534int
Victor Stinner95872862011-03-07 18:20:56 +0100535_PyImport_FixupExtensionObject(PyObject *mod, PyObject *name,
536 PyObject *filename)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000537{
Benjamin Peterson5cb8a312012-12-15 00:05:16 -0500538 PyObject *modules, *dict, *key;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000539 struct PyModuleDef *def;
Benjamin Peterson5cb8a312012-12-15 00:05:16 -0500540 int res;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000541 if (extensions == NULL) {
542 extensions = PyDict_New();
543 if (extensions == NULL)
544 return -1;
545 }
546 if (mod == NULL || !PyModule_Check(mod)) {
547 PyErr_BadInternalCall();
548 return -1;
549 }
550 def = PyModule_GetDef(mod);
551 if (!def) {
552 PyErr_BadInternalCall();
553 return -1;
554 }
555 modules = PyImport_GetModuleDict();
Victor Stinner95872862011-03-07 18:20:56 +0100556 if (PyDict_SetItem(modules, name, mod) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000557 return -1;
558 if (_PyState_AddModule(mod, def) < 0) {
Victor Stinner95872862011-03-07 18:20:56 +0100559 PyDict_DelItem(modules, name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000560 return -1;
561 }
562 if (def->m_size == -1) {
563 if (def->m_base.m_copy) {
564 /* Somebody already imported the module,
565 likely under a different name.
566 XXX this should really not happen. */
Serhiy Storchaka505ff752014-02-09 13:33:53 +0200567 Py_CLEAR(def->m_base.m_copy);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000568 }
569 dict = PyModule_GetDict(mod);
570 if (dict == NULL)
571 return -1;
572 def->m_base.m_copy = PyDict_Copy(dict);
573 if (def->m_base.m_copy == NULL)
574 return -1;
575 }
Benjamin Peterson5cb8a312012-12-15 00:05:16 -0500576 key = PyTuple_Pack(2, filename, name);
577 if (key == NULL)
Andrew Svetlov6b2cbeb2012-12-14 17:04:59 +0200578 return -1;
Benjamin Peterson5cb8a312012-12-15 00:05:16 -0500579 res = PyDict_SetItem(extensions, key, (PyObject *)def);
580 Py_DECREF(key);
581 if (res < 0)
Andrew Svetlov6b2cbeb2012-12-14 17:04:59 +0200582 return -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000583 return 0;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000584}
585
Victor Stinner49d3f252010-10-17 01:24:53 +0000586int
Serhiy Storchakac6792272013-10-19 21:03:34 +0300587_PyImport_FixupBuiltin(PyObject *mod, const char *name)
Victor Stinner49d3f252010-10-17 01:24:53 +0000588{
589 int res;
Victor Stinner95872862011-03-07 18:20:56 +0100590 PyObject *nameobj;
Victor Stinner21fcd0c2011-03-07 18:28:15 +0100591 nameobj = PyUnicode_InternFromString(name);
Victor Stinner95872862011-03-07 18:20:56 +0100592 if (nameobj == NULL)
Victor Stinner49d3f252010-10-17 01:24:53 +0000593 return -1;
Victor Stinner95872862011-03-07 18:20:56 +0100594 res = _PyImport_FixupExtensionObject(mod, nameobj, nameobj);
595 Py_DECREF(nameobj);
Victor Stinner49d3f252010-10-17 01:24:53 +0000596 return res;
597}
598
Guido van Rossum25ce5661997-08-02 03:10:38 +0000599PyObject *
Victor Stinner95872862011-03-07 18:20:56 +0100600_PyImport_FindExtensionObject(PyObject *name, PyObject *filename)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000601{
Benjamin Peterson5cb8a312012-12-15 00:05:16 -0500602 PyObject *mod, *mdict, *key;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000603 PyModuleDef* def;
604 if (extensions == NULL)
605 return NULL;
Benjamin Peterson5cb8a312012-12-15 00:05:16 -0500606 key = PyTuple_Pack(2, filename, name);
607 if (key == NULL)
Andrew Svetlov6b2cbeb2012-12-14 17:04:59 +0200608 return NULL;
Benjamin Peterson5cb8a312012-12-15 00:05:16 -0500609 def = (PyModuleDef *)PyDict_GetItem(extensions, key);
610 Py_DECREF(key);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000611 if (def == NULL)
612 return NULL;
613 if (def->m_size == -1) {
614 /* Module does not support repeated initialization */
615 if (def->m_base.m_copy == NULL)
616 return NULL;
Victor Stinner95872862011-03-07 18:20:56 +0100617 mod = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000618 if (mod == NULL)
619 return NULL;
620 mdict = PyModule_GetDict(mod);
621 if (mdict == NULL)
622 return NULL;
623 if (PyDict_Update(mdict, def->m_base.m_copy))
624 return NULL;
625 }
626 else {
627 if (def->m_base.m_init == NULL)
628 return NULL;
629 mod = def->m_base.m_init();
630 if (mod == NULL)
631 return NULL;
Christian Heimes09ca7942013-07-20 14:51:53 +0200632 if (PyDict_SetItem(PyImport_GetModuleDict(), name, mod) == -1) {
633 Py_DECREF(mod);
634 return NULL;
635 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000636 Py_DECREF(mod);
637 }
638 if (_PyState_AddModule(mod, def) < 0) {
Victor Stinner95872862011-03-07 18:20:56 +0100639 PyDict_DelItem(PyImport_GetModuleDict(), name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000640 Py_DECREF(mod);
641 return NULL;
642 }
643 if (Py_VerboseFlag)
Victor Stinner95872862011-03-07 18:20:56 +0100644 PySys_FormatStderr("import %U # previously loaded (%R)\n",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000645 name, filename);
646 return mod;
Brett Cannon9a5b25a2010-03-01 02:09:17 +0000647
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000648}
649
Victor Stinner49d3f252010-10-17 01:24:53 +0000650PyObject *
Victor Stinner501c09a2011-02-23 00:02:00 +0000651_PyImport_FindBuiltin(const char *name)
Victor Stinner49d3f252010-10-17 01:24:53 +0000652{
Victor Stinner95872862011-03-07 18:20:56 +0100653 PyObject *res, *nameobj;
Victor Stinner21fcd0c2011-03-07 18:28:15 +0100654 nameobj = PyUnicode_InternFromString(name);
Victor Stinner95872862011-03-07 18:20:56 +0100655 if (nameobj == NULL)
Victor Stinner49d3f252010-10-17 01:24:53 +0000656 return NULL;
Victor Stinner95872862011-03-07 18:20:56 +0100657 res = _PyImport_FindExtensionObject(nameobj, nameobj);
658 Py_DECREF(nameobj);
Victor Stinner49d3f252010-10-17 01:24:53 +0000659 return res;
660}
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000661
662/* Get the module object corresponding to a module name.
663 First check the modules dictionary if there's one there,
Walter Dörwaldf0dfc7a2003-10-20 14:01:56 +0000664 if not, create a new one and insert it in the modules dictionary.
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000665 Because the former action is most common, THIS DOES NOT RETURN A
666 'NEW' REFERENCE! */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000667
Guido van Rossum79f25d91997-04-29 20:08:16 +0000668PyObject *
Victor Stinner27ee0892011-03-04 12:57:09 +0000669PyImport_AddModuleObject(PyObject *name)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000670{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000671 PyObject *modules = PyImport_GetModuleDict();
672 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000673
Victor Stinner27ee0892011-03-04 12:57:09 +0000674 if ((m = PyDict_GetItem(modules, name)) != NULL &&
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000675 PyModule_Check(m))
676 return m;
Victor Stinner27ee0892011-03-04 12:57:09 +0000677 m = PyModule_NewObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000678 if (m == NULL)
679 return NULL;
Victor Stinner27ee0892011-03-04 12:57:09 +0000680 if (PyDict_SetItem(modules, name, m) != 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000681 Py_DECREF(m);
682 return NULL;
683 }
684 Py_DECREF(m); /* Yes, it still exists, in modules! */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000685
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000686 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000687}
688
Victor Stinner27ee0892011-03-04 12:57:09 +0000689PyObject *
690PyImport_AddModule(const char *name)
691{
692 PyObject *nameobj, *module;
693 nameobj = PyUnicode_FromString(name);
694 if (nameobj == NULL)
695 return NULL;
696 module = PyImport_AddModuleObject(nameobj);
697 Py_DECREF(nameobj);
698 return module;
699}
700
701
Tim Peters1cd70172004-08-02 03:52:12 +0000702/* Remove name from sys.modules, if it's there. */
703static void
Victor Stinner27ee0892011-03-04 12:57:09 +0000704remove_module(PyObject *name)
Tim Peters1cd70172004-08-02 03:52:12 +0000705{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000706 PyObject *modules = PyImport_GetModuleDict();
Victor Stinner27ee0892011-03-04 12:57:09 +0000707 if (PyDict_GetItem(modules, name) == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000708 return;
Victor Stinner27ee0892011-03-04 12:57:09 +0000709 if (PyDict_DelItem(modules, name) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000710 Py_FatalError("import: deleting existing key in"
711 "sys.modules failed");
Tim Peters1cd70172004-08-02 03:52:12 +0000712}
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000713
Christian Heimes3b06e532008-01-07 20:12:44 +0000714
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000715/* Execute a code object in a module and return the module object
Tim Peters1cd70172004-08-02 03:52:12 +0000716 * WITH INCREMENTED REFERENCE COUNT. If an error occurs, name is
717 * removed from sys.modules, to avoid leaving damaged module objects
718 * in sys.modules. The caller may wish to restore the original
719 * module object (if any) in this case; PyImport_ReloadModule is an
720 * example.
Barry Warsaw28a691b2010-04-17 00:19:56 +0000721 *
722 * Note that PyImport_ExecCodeModuleWithPathnames() is the preferred, richer
723 * interface. The other two exist primarily for backward compatibility.
Tim Peters1cd70172004-08-02 03:52:12 +0000724 */
Guido van Rossum79f25d91997-04-29 20:08:16 +0000725PyObject *
Serhiy Storchakac6792272013-10-19 21:03:34 +0300726PyImport_ExecCodeModule(const char *name, PyObject *co)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000727{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000728 return PyImport_ExecCodeModuleWithPathnames(
729 name, co, (char *)NULL, (char *)NULL);
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000730}
731
732PyObject *
Serhiy Storchakac6792272013-10-19 21:03:34 +0300733PyImport_ExecCodeModuleEx(const char *name, PyObject *co, const char *pathname)
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000734{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000735 return PyImport_ExecCodeModuleWithPathnames(
736 name, co, pathname, (char *)NULL);
Barry Warsaw28a691b2010-04-17 00:19:56 +0000737}
738
739PyObject *
Serhiy Storchakac6792272013-10-19 21:03:34 +0300740PyImport_ExecCodeModuleWithPathnames(const char *name, PyObject *co,
741 const char *pathname,
742 const char *cpathname)
Barry Warsaw28a691b2010-04-17 00:19:56 +0000743{
Victor Stinner27ee0892011-03-04 12:57:09 +0000744 PyObject *m = NULL;
Eric Snow32439d62015-05-02 19:15:18 -0600745 PyObject *nameobj, *pathobj = NULL, *cpathobj = NULL, *external= NULL;
Victor Stinner27ee0892011-03-04 12:57:09 +0000746
747 nameobj = PyUnicode_FromString(name);
748 if (nameobj == NULL)
749 return NULL;
750
Victor Stinner27ee0892011-03-04 12:57:09 +0000751 if (cpathname != NULL) {
752 cpathobj = PyUnicode_DecodeFSDefault(cpathname);
753 if (cpathobj == NULL)
754 goto error;
Brett Cannona6473f92012-07-13 13:57:03 -0400755 }
756 else
Victor Stinner27ee0892011-03-04 12:57:09 +0000757 cpathobj = NULL;
Brett Cannona6473f92012-07-13 13:57:03 -0400758
759 if (pathname != NULL) {
760 pathobj = PyUnicode_DecodeFSDefault(pathname);
761 if (pathobj == NULL)
762 goto error;
763 }
764 else if (cpathobj != NULL) {
765 PyInterpreterState *interp = PyThreadState_GET()->interp;
766 _Py_IDENTIFIER(_get_sourcefile);
767
768 if (interp == NULL) {
769 Py_FatalError("PyImport_ExecCodeModuleWithPathnames: "
770 "no interpreter!");
771 }
772
Eric Snow32439d62015-05-02 19:15:18 -0600773 external= PyObject_GetAttrString(interp->importlib,
774 "_bootstrap_external");
775 if (external != NULL) {
776 pathobj = _PyObject_CallMethodIdObjArgs(external,
777 &PyId__get_sourcefile, cpathobj,
778 NULL);
779 Py_DECREF(external);
780 }
Brett Cannona6473f92012-07-13 13:57:03 -0400781 if (pathobj == NULL)
782 PyErr_Clear();
783 }
784 else
785 pathobj = NULL;
786
Victor Stinner27ee0892011-03-04 12:57:09 +0000787 m = PyImport_ExecCodeModuleObject(nameobj, co, pathobj, cpathobj);
788error:
789 Py_DECREF(nameobj);
790 Py_XDECREF(pathobj);
791 Py_XDECREF(cpathobj);
792 return m;
793}
794
Brett Cannon18fc4e72014-04-04 10:01:46 -0400795static PyObject *
796module_dict_for_exec(PyObject *name)
Victor Stinner27ee0892011-03-04 12:57:09 +0000797{
Brett Cannon18fc4e72014-04-04 10:01:46 -0400798 PyObject *m, *d = NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000799
Victor Stinner27ee0892011-03-04 12:57:09 +0000800 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000801 if (m == NULL)
802 return NULL;
803 /* If the module is being reloaded, we get the old module back
804 and re-use its dict to exec the new code. */
805 d = PyModule_GetDict(m);
806 if (PyDict_GetItemString(d, "__builtins__") == NULL) {
807 if (PyDict_SetItemString(d, "__builtins__",
Brett Cannon18fc4e72014-04-04 10:01:46 -0400808 PyEval_GetBuiltins()) != 0) {
809 remove_module(name);
810 return NULL;
811 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000812 }
Brett Cannon18fc4e72014-04-04 10:01:46 -0400813
Eric Snow08197a42014-05-12 17:54:55 -0600814 return d; /* Return a borrowed reference. */
Brett Cannon18fc4e72014-04-04 10:01:46 -0400815}
816
817static PyObject *
818exec_code_in_module(PyObject *name, PyObject *module_dict, PyObject *code_object)
819{
820 PyObject *modules = PyImport_GetModuleDict();
821 PyObject *v, *m;
822
823 v = PyEval_EvalCode(code_object, module_dict, module_dict);
824 if (v == NULL) {
825 remove_module(name);
826 return NULL;
827 }
828 Py_DECREF(v);
829
830 if ((m = PyDict_GetItem(modules, name)) == NULL) {
831 PyErr_Format(PyExc_ImportError,
832 "Loaded module %R not found in sys.modules",
833 name);
834 return NULL;
835 }
836
837 Py_INCREF(m);
838
839 return m;
840}
841
842PyObject*
843PyImport_ExecCodeModuleObject(PyObject *name, PyObject *co, PyObject *pathname,
844 PyObject *cpathname)
845{
Eric Snow32439d62015-05-02 19:15:18 -0600846 PyObject *d, *external, *res;
Eric Snow08197a42014-05-12 17:54:55 -0600847 PyInterpreterState *interp = PyThreadState_GET()->interp;
848 _Py_IDENTIFIER(_fix_up_module);
Brett Cannon18fc4e72014-04-04 10:01:46 -0400849
850 d = module_dict_for_exec(name);
851 if (d == NULL) {
852 return NULL;
853 }
854
Eric Snow08197a42014-05-12 17:54:55 -0600855 if (pathname == NULL) {
856 pathname = ((PyCodeObject *)co)->co_filename;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000857 }
Eric Snow32439d62015-05-02 19:15:18 -0600858 external = PyObject_GetAttrString(interp->importlib, "_bootstrap_external");
859 if (external == NULL)
860 return NULL;
861 res = _PyObject_CallMethodIdObjArgs(external,
Eric Snow08197a42014-05-12 17:54:55 -0600862 &PyId__fix_up_module,
863 d, name, pathname, cpathname, NULL);
Eric Snow32439d62015-05-02 19:15:18 -0600864 Py_DECREF(external);
Eric Snow08197a42014-05-12 17:54:55 -0600865 if (res != NULL) {
Eric Snow58cfdd82014-05-29 12:31:39 -0600866 Py_DECREF(res);
Eric Snow08197a42014-05-12 17:54:55 -0600867 res = exec_code_in_module(name, d, co);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000868 }
Eric Snow08197a42014-05-12 17:54:55 -0600869 return res;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000870}
871
872
Antoine Pitroud35cbf62009-01-06 19:02:24 +0000873static void
874update_code_filenames(PyCodeObject *co, PyObject *oldname, PyObject *newname)
875{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000876 PyObject *constants, *tmp;
877 Py_ssize_t i, n;
Antoine Pitroud35cbf62009-01-06 19:02:24 +0000878
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000879 if (PyUnicode_Compare(co->co_filename, oldname))
880 return;
Antoine Pitroud35cbf62009-01-06 19:02:24 +0000881
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000882 tmp = co->co_filename;
883 co->co_filename = newname;
884 Py_INCREF(co->co_filename);
885 Py_DECREF(tmp);
Antoine Pitroud35cbf62009-01-06 19:02:24 +0000886
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000887 constants = co->co_consts;
888 n = PyTuple_GET_SIZE(constants);
889 for (i = 0; i < n; i++) {
890 tmp = PyTuple_GET_ITEM(constants, i);
891 if (PyCode_Check(tmp))
892 update_code_filenames((PyCodeObject *)tmp,
893 oldname, newname);
894 }
Antoine Pitroud35cbf62009-01-06 19:02:24 +0000895}
896
Victor Stinner2f42ae52011-03-20 00:41:24 +0100897static void
898update_compiled_module(PyCodeObject *co, PyObject *newname)
Antoine Pitroud35cbf62009-01-06 19:02:24 +0000899{
Victor Stinner2f42ae52011-03-20 00:41:24 +0100900 PyObject *oldname;
Antoine Pitroud35cbf62009-01-06 19:02:24 +0000901
Victor Stinner2f42ae52011-03-20 00:41:24 +0100902 if (PyUnicode_Compare(co->co_filename, newname) == 0)
903 return;
Hirokazu Yamamoto4f447fb2009-03-04 01:52:10 +0000904
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000905 oldname = co->co_filename;
906 Py_INCREF(oldname);
907 update_code_filenames(co, oldname, newname);
908 Py_DECREF(oldname);
Antoine Pitroud35cbf62009-01-06 19:02:24 +0000909}
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000910
Brett Cannon4caa61d2014-01-09 19:03:32 -0500911/*[clinic input]
912_imp._fix_co_filename
913
914 code: object(type="PyCodeObject *", subclass_of="&PyCode_Type")
915 Code object to change.
916
917 path: unicode
918 File path to use.
919 /
920
921Changes code.co_filename to specify the passed-in file path.
922[clinic start generated code]*/
923
Brett Cannon4caa61d2014-01-09 19:03:32 -0500924static PyObject *
Larry Hastings89964c42015-04-14 18:07:59 -0400925_imp__fix_co_filename_impl(PyModuleDef *module, PyCodeObject *code,
926 PyObject *path)
927/*[clinic end generated code: output=f4db56aac0a1327f input=895ba50e78b82f05]*/
Brett Cannon442c9b92011-03-23 16:14:42 -0700928
Brett Cannon4caa61d2014-01-09 19:03:32 -0500929{
Brett Cannona6dec2e2014-01-10 07:43:55 -0500930 update_compiled_module(code, path);
Brett Cannon442c9b92011-03-23 16:14:42 -0700931
932 Py_RETURN_NONE;
933}
934
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000935
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000936/* Forward */
Benjamin Peterson6fba3db2013-03-18 23:13:31 -0700937static const struct _frozen * find_frozen(PyObject *);
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000938
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000939
940/* Helper to test for built-in module */
941
942static int
Victor Stinner95872862011-03-07 18:20:56 +0100943is_builtin(PyObject *name)
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000944{
Victor Stinner95872862011-03-07 18:20:56 +0100945 int i, cmp;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000946 for (i = 0; PyImport_Inittab[i].name != NULL; i++) {
Victor Stinner95872862011-03-07 18:20:56 +0100947 cmp = PyUnicode_CompareWithASCIIString(name, PyImport_Inittab[i].name);
948 if (cmp == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000949 if (PyImport_Inittab[i].initfunc == NULL)
950 return -1;
951 else
952 return 1;
953 }
954 }
955 return 0;
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000956}
957
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000958
Just van Rossum52e14d62002-12-30 22:08:05 +0000959/* Return an importer object for a sys.path/pkg.__path__ item 'p',
960 possibly by fetching it from the path_importer_cache dict. If it
Thomas Wouters89f507f2006-12-13 04:49:30 +0000961 wasn't yet cached, traverse path_hooks until a hook is found
Just van Rossum52e14d62002-12-30 22:08:05 +0000962 that can handle the path item. Return None if no hook could;
963 this tells our caller it should fall back to the builtin
964 import mechanism. Cache the result in path_importer_cache.
965 Returns a borrowed reference. */
966
967static PyObject *
968get_path_importer(PyObject *path_importer_cache, PyObject *path_hooks,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000969 PyObject *p)
Just van Rossum52e14d62002-12-30 22:08:05 +0000970{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000971 PyObject *importer;
972 Py_ssize_t j, nhooks;
Just van Rossum52e14d62002-12-30 22:08:05 +0000973
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000974 /* These conditions are the caller's responsibility: */
975 assert(PyList_Check(path_hooks));
976 assert(PyDict_Check(path_importer_cache));
Just van Rossum52e14d62002-12-30 22:08:05 +0000977
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000978 nhooks = PyList_Size(path_hooks);
979 if (nhooks < 0)
980 return NULL; /* Shouldn't happen */
Just van Rossum52e14d62002-12-30 22:08:05 +0000981
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000982 importer = PyDict_GetItem(path_importer_cache, p);
983 if (importer != NULL)
984 return importer;
Just van Rossum52e14d62002-12-30 22:08:05 +0000985
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000986 /* set path_importer_cache[p] to None to avoid recursion */
987 if (PyDict_SetItem(path_importer_cache, p, Py_None) != 0)
988 return NULL;
Just van Rossum52e14d62002-12-30 22:08:05 +0000989
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000990 for (j = 0; j < nhooks; j++) {
991 PyObject *hook = PyList_GetItem(path_hooks, j);
992 if (hook == NULL)
993 return NULL;
994 importer = PyObject_CallFunctionObjArgs(hook, p, NULL);
995 if (importer != NULL)
996 break;
Just van Rossum52e14d62002-12-30 22:08:05 +0000997
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000998 if (!PyErr_ExceptionMatches(PyExc_ImportError)) {
999 return NULL;
1000 }
1001 PyErr_Clear();
1002 }
1003 if (importer == NULL) {
Brett Cannonaa936422012-04-27 15:30:58 -04001004 return Py_None;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001005 }
1006 if (importer != NULL) {
1007 int err = PyDict_SetItem(path_importer_cache, p, importer);
1008 Py_DECREF(importer);
1009 if (err != 0)
1010 return NULL;
1011 }
1012 return importer;
Just van Rossum52e14d62002-12-30 22:08:05 +00001013}
1014
Christian Heimes9cd17752007-11-18 19:35:23 +00001015PyAPI_FUNC(PyObject *)
1016PyImport_GetImporter(PyObject *path) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001017 PyObject *importer=NULL, *path_importer_cache=NULL, *path_hooks=NULL;
Christian Heimes9cd17752007-11-18 19:35:23 +00001018
Victor Stinner1e53bba2013-07-16 22:26:05 +02001019 path_importer_cache = PySys_GetObject("path_importer_cache");
1020 path_hooks = PySys_GetObject("path_hooks");
1021 if (path_importer_cache != NULL && path_hooks != NULL) {
1022 importer = get_path_importer(path_importer_cache,
1023 path_hooks, path);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001024 }
1025 Py_XINCREF(importer); /* get_path_importer returns a borrowed reference */
1026 return importer;
Christian Heimes9cd17752007-11-18 19:35:23 +00001027}
1028
Nick Coghland5cacbb2015-05-23 22:24:10 +10001029/*[clinic input]
1030_imp.create_builtin
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001031
Nick Coghland5cacbb2015-05-23 22:24:10 +10001032 spec: object
1033 /
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001034
Nick Coghland5cacbb2015-05-23 22:24:10 +10001035Create an extension module.
1036[clinic start generated code]*/
Guido van Rossum7f133ed1991-02-19 12:23:57 +00001037
Nick Coghland5cacbb2015-05-23 22:24:10 +10001038static PyObject *
1039_imp_create_builtin(PyModuleDef *module, PyObject *spec)
1040/*[clinic end generated code: output=5038f467617226bd input=37f966f890384e47]*/
Guido van Rossum7f133ed1991-02-19 12:23:57 +00001041{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001042 struct _inittab *p;
Nick Coghland5cacbb2015-05-23 22:24:10 +10001043 PyObject *name;
1044 char *namestr;
Victor Stinner5eb4f592013-11-14 22:38:52 +01001045 PyObject *mod;
Guido van Rossum25ce5661997-08-02 03:10:38 +00001046
Nick Coghland5cacbb2015-05-23 22:24:10 +10001047 name = PyObject_GetAttrString(spec, "name");
1048 if (name == NULL) {
1049 return NULL;
1050 }
1051
Victor Stinner5eb4f592013-11-14 22:38:52 +01001052 mod = _PyImport_FindExtensionObject(name, name);
Nick Coghland5cacbb2015-05-23 22:24:10 +10001053 if (mod || PyErr_Occurred()) {
1054 Py_DECREF(name);
1055 Py_INCREF(mod);
1056 return mod;
1057 }
1058
1059 namestr = PyUnicode_AsUTF8(name);
1060 if (namestr == NULL) {
1061 Py_DECREF(name);
1062 return NULL;
1063 }
Guido van Rossum25ce5661997-08-02 03:10:38 +00001064
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001065 for (p = PyImport_Inittab; p->name != NULL; p++) {
Antoine Pitrou6c40eb72012-01-18 20:16:09 +01001066 PyModuleDef *def;
Victor Stinner95872862011-03-07 18:20:56 +01001067 if (PyUnicode_CompareWithASCIIString(name, p->name) == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001068 if (p->initfunc == NULL) {
Nick Coghland5cacbb2015-05-23 22:24:10 +10001069 /* Cannot re-init internal module ("sys" or "builtins") */
1070 mod = PyImport_AddModule(namestr);
1071 Py_DECREF(name);
1072 return mod;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001073 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001074 mod = (*p->initfunc)();
Nick Coghland5cacbb2015-05-23 22:24:10 +10001075 if (mod == NULL) {
1076 Py_DECREF(name);
1077 return NULL;
1078 }
1079 if (PyObject_TypeCheck(mod, &PyModuleDef_Type)) {
1080 Py_DECREF(name);
1081 return PyModule_FromDefAndSpec((PyModuleDef*)mod, spec);
1082 } else {
1083 /* Remember pointer to module init function. */
1084 def = PyModule_GetDef(mod);
1085 def->m_base.m_init = p->initfunc;
1086 if (_PyImport_FixupExtensionObject(mod, name, name) < 0) {
1087 Py_DECREF(name);
1088 return NULL;
1089 }
1090 Py_DECREF(name);
1091 return mod;
1092 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001093 }
1094 }
Nick Coghland5cacbb2015-05-23 22:24:10 +10001095 Py_DECREF(name);
1096 Py_RETURN_NONE;
Guido van Rossum7f133ed1991-02-19 12:23:57 +00001097}
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001098
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001099
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001100/* Frozen modules */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001101
Benjamin Peterson6fba3db2013-03-18 23:13:31 -07001102static const struct _frozen *
Victor Stinner53dc7352011-03-20 01:50:21 +01001103find_frozen(PyObject *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001104{
Benjamin Peterson6fba3db2013-03-18 23:13:31 -07001105 const struct _frozen *p;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001106
Victor Stinner53dc7352011-03-20 01:50:21 +01001107 if (name == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001108 return NULL;
Benjamin Petersond968e272008-11-05 22:48:33 +00001109
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001110 for (p = PyImport_FrozenModules; ; p++) {
1111 if (p->name == NULL)
1112 return NULL;
Victor Stinner53dc7352011-03-20 01:50:21 +01001113 if (PyUnicode_CompareWithASCIIString(name, p->name) == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001114 break;
1115 }
1116 return p;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001117}
1118
Guido van Rossum79f25d91997-04-29 20:08:16 +00001119static PyObject *
Victor Stinner53dc7352011-03-20 01:50:21 +01001120get_frozen_object(PyObject *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001121{
Benjamin Peterson6fba3db2013-03-18 23:13:31 -07001122 const struct _frozen *p = find_frozen(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001123 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001124
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001125 if (p == NULL) {
1126 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01001127 "No such frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001128 name);
1129 return NULL;
1130 }
1131 if (p->code == NULL) {
1132 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01001133 "Excluded frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001134 name);
1135 return NULL;
1136 }
1137 size = p->size;
1138 if (size < 0)
1139 size = -size;
Serhiy Storchakac6792272013-10-19 21:03:34 +03001140 return PyMarshal_ReadObjectFromString((const char *)p->code, size);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001141}
1142
Brett Cannon8d110132009-03-15 02:20:16 +00001143static PyObject *
Victor Stinner53dc7352011-03-20 01:50:21 +01001144is_frozen_package(PyObject *name)
Brett Cannon8d110132009-03-15 02:20:16 +00001145{
Benjamin Peterson6fba3db2013-03-18 23:13:31 -07001146 const struct _frozen *p = find_frozen(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001147 int size;
Brett Cannon8d110132009-03-15 02:20:16 +00001148
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001149 if (p == NULL) {
1150 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01001151 "No such frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001152 name);
1153 return NULL;
1154 }
Brett Cannon8d110132009-03-15 02:20:16 +00001155
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001156 size = p->size;
Brett Cannon8d110132009-03-15 02:20:16 +00001157
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001158 if (size < 0)
1159 Py_RETURN_TRUE;
1160 else
1161 Py_RETURN_FALSE;
Brett Cannon8d110132009-03-15 02:20:16 +00001162}
1163
1164
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001165/* Initialize a frozen module.
Brett Cannon3c2ac442009-03-08 20:49:47 +00001166 Return 1 for success, 0 if the module is not found, and -1 with
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001167 an exception set if the initialization failed.
1168 This function is also used from frozenmain.c */
Guido van Rossum0b344901995-02-07 15:35:27 +00001169
1170int
Victor Stinner53dc7352011-03-20 01:50:21 +01001171PyImport_ImportFrozenModuleObject(PyObject *name)
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001172{
Benjamin Peterson6fba3db2013-03-18 23:13:31 -07001173 const struct _frozen *p;
Brett Cannon18fc4e72014-04-04 10:01:46 -04001174 PyObject *co, *m, *d;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001175 int ispackage;
1176 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001177
Victor Stinner53dc7352011-03-20 01:50:21 +01001178 p = find_frozen(name);
1179
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001180 if (p == NULL)
1181 return 0;
1182 if (p->code == NULL) {
1183 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01001184 "Excluded frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001185 name);
1186 return -1;
1187 }
1188 size = p->size;
1189 ispackage = (size < 0);
1190 if (ispackage)
1191 size = -size;
Serhiy Storchakac6792272013-10-19 21:03:34 +03001192 co = PyMarshal_ReadObjectFromString((const char *)p->code, size);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001193 if (co == NULL)
1194 return -1;
1195 if (!PyCode_Check(co)) {
1196 PyErr_Format(PyExc_TypeError,
Victor Stinner53dc7352011-03-20 01:50:21 +01001197 "frozen object %R is not a code object",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001198 name);
1199 goto err_return;
1200 }
1201 if (ispackage) {
Brett Cannon3e0651b2013-05-31 23:18:39 -04001202 /* Set __path__ to the empty list */
Brett Cannon18fc4e72014-04-04 10:01:46 -04001203 PyObject *l;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001204 int err;
Victor Stinner53dc7352011-03-20 01:50:21 +01001205 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001206 if (m == NULL)
1207 goto err_return;
1208 d = PyModule_GetDict(m);
Brett Cannon3e0651b2013-05-31 23:18:39 -04001209 l = PyList_New(0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001210 if (l == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001211 goto err_return;
1212 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001213 err = PyDict_SetItemString(d, "__path__", l);
1214 Py_DECREF(l);
1215 if (err != 0)
1216 goto err_return;
1217 }
Brett Cannon18fc4e72014-04-04 10:01:46 -04001218 d = module_dict_for_exec(name);
1219 if (d == NULL) {
Victor Stinner53dc7352011-03-20 01:50:21 +01001220 goto err_return;
Brett Cannon18fc4e72014-04-04 10:01:46 -04001221 }
1222 m = exec_code_in_module(name, d, co);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001223 if (m == NULL)
1224 goto err_return;
1225 Py_DECREF(co);
1226 Py_DECREF(m);
1227 return 1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001228err_return:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001229 Py_DECREF(co);
1230 return -1;
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001231}
Guido van Rossum74e6a111994-08-29 12:54:38 +00001232
Victor Stinner53dc7352011-03-20 01:50:21 +01001233int
Serhiy Storchakac6792272013-10-19 21:03:34 +03001234PyImport_ImportFrozenModule(const char *name)
Victor Stinner53dc7352011-03-20 01:50:21 +01001235{
1236 PyObject *nameobj;
1237 int ret;
1238 nameobj = PyUnicode_InternFromString(name);
1239 if (nameobj == NULL)
1240 return -1;
1241 ret = PyImport_ImportFrozenModuleObject(nameobj);
1242 Py_DECREF(nameobj);
1243 return ret;
1244}
1245
Guido van Rossum74e6a111994-08-29 12:54:38 +00001246
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001247/* Import a module, either built-in, frozen, or external, and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001248 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum74e6a111994-08-29 12:54:38 +00001249
Guido van Rossum79f25d91997-04-29 20:08:16 +00001250PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001251PyImport_ImportModule(const char *name)
Guido van Rossum74e6a111994-08-29 12:54:38 +00001252{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001253 PyObject *pname;
1254 PyObject *result;
Marc-André Lemburg3c61c352001-02-09 19:40:15 +00001255
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001256 pname = PyUnicode_FromString(name);
1257 if (pname == NULL)
1258 return NULL;
1259 result = PyImport_Import(pname);
1260 Py_DECREF(pname);
1261 return result;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001262}
1263
Christian Heimes072c0f12008-01-03 23:01:04 +00001264/* Import a module without blocking
1265 *
1266 * At first it tries to fetch the module from sys.modules. If the module was
1267 * never loaded before it loads it with PyImport_ImportModule() unless another
1268 * thread holds the import lock. In the latter case the function raises an
1269 * ImportError instead of blocking.
1270 *
1271 * Returns the module object with incremented ref count.
1272 */
1273PyObject *
1274PyImport_ImportModuleNoBlock(const char *name)
1275{
Antoine Pitrouea3eb882012-05-17 18:55:59 +02001276 return PyImport_ImportModule(name);
Christian Heimes072c0f12008-01-03 23:01:04 +00001277}
1278
Guido van Rossum17fc85f1997-09-06 18:52:03 +00001279
Antoine Pitroubc07a5c2012-07-08 12:01:27 +02001280/* Remove importlib frames from the traceback,
1281 * except in Verbose mode. */
1282static void
1283remove_importlib_frames(void)
1284{
1285 const char *importlib_filename = "<frozen importlib._bootstrap>";
Eric Snow32439d62015-05-02 19:15:18 -06001286 const char *external_filename = "<frozen importlib._bootstrap_external>";
Nick Coghlan42c07662012-07-31 21:14:18 +10001287 const char *remove_frames = "_call_with_frames_removed";
Antoine Pitroubc07a5c2012-07-08 12:01:27 +02001288 int always_trim = 0;
Benjamin Petersonfa873702012-07-09 13:43:53 -07001289 int in_importlib = 0;
Antoine Pitroubc07a5c2012-07-08 12:01:27 +02001290 PyObject *exception, *value, *base_tb, *tb;
Benjamin Petersonfa873702012-07-09 13:43:53 -07001291 PyObject **prev_link, **outer_link = NULL;
Antoine Pitroubc07a5c2012-07-08 12:01:27 +02001292
1293 /* Synopsis: if it's an ImportError, we trim all importlib chunks
Nick Coghlan42c07662012-07-31 21:14:18 +10001294 from the traceback. We always trim chunks
1295 which end with a call to "_call_with_frames_removed". */
Antoine Pitroubc07a5c2012-07-08 12:01:27 +02001296
1297 PyErr_Fetch(&exception, &value, &base_tb);
1298 if (!exception || Py_VerboseFlag)
1299 goto done;
1300 if (PyType_IsSubtype((PyTypeObject *) exception,
1301 (PyTypeObject *) PyExc_ImportError))
1302 always_trim = 1;
1303
1304 prev_link = &base_tb;
1305 tb = base_tb;
Antoine Pitroubc07a5c2012-07-08 12:01:27 +02001306 while (tb != NULL) {
1307 PyTracebackObject *traceback = (PyTracebackObject *)tb;
1308 PyObject *next = (PyObject *) traceback->tb_next;
1309 PyFrameObject *frame = traceback->tb_frame;
1310 PyCodeObject *code = frame->f_code;
1311 int now_in_importlib;
1312
1313 assert(PyTraceBack_Check(tb));
1314 now_in_importlib = (PyUnicode_CompareWithASCIIString(
1315 code->co_filename,
Eric Snow32439d62015-05-02 19:15:18 -06001316 importlib_filename) == 0) ||
1317 (PyUnicode_CompareWithASCIIString(
1318 code->co_filename,
1319 external_filename) == 0);
Antoine Pitroubc07a5c2012-07-08 12:01:27 +02001320 if (now_in_importlib && !in_importlib) {
1321 /* This is the link to this chunk of importlib tracebacks */
1322 outer_link = prev_link;
1323 }
1324 in_importlib = now_in_importlib;
1325
1326 if (in_importlib &&
1327 (always_trim ||
Nick Coghlan42c07662012-07-31 21:14:18 +10001328 PyUnicode_CompareWithASCIIString(code->co_name,
1329 remove_frames) == 0)) {
Antoine Pitroubc07a5c2012-07-08 12:01:27 +02001330 PyObject *tmp = *outer_link;
1331 *outer_link = next;
1332 Py_XINCREF(next);
1333 Py_DECREF(tmp);
1334 prev_link = outer_link;
1335 }
1336 else {
1337 prev_link = (PyObject **) &traceback->tb_next;
1338 }
1339 tb = next;
1340 }
1341done:
1342 PyErr_Restore(exception, value, base_tb);
1343}
1344
1345
Thomas Woutersf7f438b2006-02-28 16:09:29 +00001346PyObject *
Brett Cannonfd074152012-04-14 14:10:13 -04001347PyImport_ImportModuleLevelObject(PyObject *name, PyObject *given_globals,
1348 PyObject *locals, PyObject *given_fromlist,
Victor Stinnerfe93faf2011-03-14 15:54:52 -04001349 int level)
Thomas Woutersf7f438b2006-02-28 16:09:29 +00001350{
Brett Cannonfd074152012-04-14 14:10:13 -04001351 _Py_IDENTIFIER(__import__);
Eric Snowb523f842013-11-22 09:05:39 -07001352 _Py_IDENTIFIER(__spec__);
1353 _Py_IDENTIFIER(_initializing);
Brett Cannonfd074152012-04-14 14:10:13 -04001354 _Py_IDENTIFIER(__package__);
1355 _Py_IDENTIFIER(__path__);
1356 _Py_IDENTIFIER(__name__);
1357 _Py_IDENTIFIER(_find_and_load);
1358 _Py_IDENTIFIER(_handle_fromlist);
Antoine Pitrouea3eb882012-05-17 18:55:59 +02001359 _Py_IDENTIFIER(_lock_unlock_module);
Brett Cannonfd074152012-04-14 14:10:13 -04001360 _Py_static_string(single_dot, ".");
1361 PyObject *abs_name = NULL;
1362 PyObject *builtins_import = NULL;
1363 PyObject *final_mod = NULL;
1364 PyObject *mod = NULL;
1365 PyObject *package = NULL;
1366 PyObject *globals = NULL;
1367 PyObject *fromlist = NULL;
1368 PyInterpreterState *interp = PyThreadState_GET()->interp;
Serhiy Storchakafa494fd2015-05-30 17:45:22 +03001369 int has_from;
Brett Cannonfd074152012-04-14 14:10:13 -04001370
1371 /* Make sure to use default values so as to not have
1372 PyObject_CallMethodObjArgs() truncate the parameter list because of a
1373 NULL argument. */
1374 if (given_globals == NULL) {
1375 globals = PyDict_New();
1376 if (globals == NULL) {
1377 goto error;
1378 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001379 }
Brett Cannonfd074152012-04-14 14:10:13 -04001380 else {
1381 /* Only have to care what given_globals is if it will be used
Brett Cannonecfefb72012-08-05 19:24:57 -04001382 for something. */
Brett Cannonfd074152012-04-14 14:10:13 -04001383 if (level > 0 && !PyDict_Check(given_globals)) {
1384 PyErr_SetString(PyExc_TypeError, "globals must be a dict");
1385 goto error;
1386 }
1387 globals = given_globals;
1388 Py_INCREF(globals);
1389 }
1390
1391 if (given_fromlist == NULL) {
1392 fromlist = PyList_New(0);
1393 if (fromlist == NULL) {
1394 goto error;
1395 }
1396 }
1397 else {
1398 fromlist = given_fromlist;
1399 Py_INCREF(fromlist);
1400 }
1401 if (name == NULL) {
1402 PyErr_SetString(PyExc_ValueError, "Empty module name");
1403 goto error;
1404 }
1405
1406 /* The below code is importlib.__import__() & _gcd_import(), ported to C
1407 for added performance. */
1408
1409 if (!PyUnicode_Check(name)) {
1410 PyErr_SetString(PyExc_TypeError, "module name must be a string");
1411 goto error;
1412 }
1413 else if (PyUnicode_READY(name) < 0) {
1414 goto error;
1415 }
1416 if (level < 0) {
1417 PyErr_SetString(PyExc_ValueError, "level must be >= 0");
1418 goto error;
1419 }
1420 else if (level > 0) {
1421 package = _PyDict_GetItemId(globals, &PyId___package__);
1422 if (package != NULL && package != Py_None) {
1423 Py_INCREF(package);
1424 if (!PyUnicode_Check(package)) {
1425 PyErr_SetString(PyExc_TypeError, "package must be a string");
1426 goto error;
1427 }
1428 }
1429 else {
Brett Cannon273323c2012-04-17 19:05:11 -04001430 package = _PyDict_GetItemId(globals, &PyId___name__);
Brett Cannonfd074152012-04-14 14:10:13 -04001431 if (package == NULL) {
Brett Cannon273323c2012-04-17 19:05:11 -04001432 PyErr_SetString(PyExc_KeyError, "'__name__' not in globals");
Brett Cannonfd074152012-04-14 14:10:13 -04001433 goto error;
1434 }
1435 else if (!PyUnicode_Check(package)) {
1436 PyErr_SetString(PyExc_TypeError, "__name__ must be a string");
1437 }
1438 Py_INCREF(package);
1439
1440 if (_PyDict_GetItemId(globals, &PyId___path__) == NULL) {
Brett Cannon740fce02012-04-14 14:23:49 -04001441 PyObject *partition = NULL;
Brett Cannonfd074152012-04-14 14:10:13 -04001442 PyObject *borrowed_dot = _PyUnicode_FromId(&single_dot);
1443 if (borrowed_dot == NULL) {
1444 goto error;
1445 }
Brett Cannon740fce02012-04-14 14:23:49 -04001446 partition = PyUnicode_RPartition(package, borrowed_dot);
Brett Cannonfd074152012-04-14 14:10:13 -04001447 Py_DECREF(package);
1448 if (partition == NULL) {
1449 goto error;
1450 }
1451 package = PyTuple_GET_ITEM(partition, 0);
1452 Py_INCREF(package);
1453 Py_DECREF(partition);
1454 }
1455 }
1456
1457 if (PyDict_GetItem(interp->modules, package) == NULL) {
1458 PyErr_Format(PyExc_SystemError,
1459 "Parent module %R not loaded, cannot perform relative "
1460 "import", package);
1461 goto error;
1462 }
1463 }
1464 else { /* level == 0 */
1465 if (PyUnicode_GET_LENGTH(name) == 0) {
1466 PyErr_SetString(PyExc_ValueError, "Empty module name");
1467 goto error;
1468 }
1469 package = Py_None;
1470 Py_INCREF(package);
1471 }
1472
1473 if (level > 0) {
1474 Py_ssize_t last_dot = PyUnicode_GET_LENGTH(package);
1475 PyObject *base = NULL;
1476 int level_up = 1;
1477
1478 for (level_up = 1; level_up < level; level_up += 1) {
1479 last_dot = PyUnicode_FindChar(package, '.', 0, last_dot, -1);
1480 if (last_dot == -2) {
1481 goto error;
1482 }
1483 else if (last_dot == -1) {
1484 PyErr_SetString(PyExc_ValueError,
1485 "attempted relative import beyond top-level "
1486 "package");
1487 goto error;
1488 }
1489 }
Victor Stinner22af2592013-11-13 12:11:36 +01001490
Brett Cannonfd074152012-04-14 14:10:13 -04001491 base = PyUnicode_Substring(package, 0, last_dot);
Victor Stinner22af2592013-11-13 12:11:36 +01001492 if (base == NULL)
1493 goto error;
1494
Brett Cannonfd074152012-04-14 14:10:13 -04001495 if (PyUnicode_GET_LENGTH(name) > 0) {
Antoine Pitrou538ba2a2012-04-16 21:52:45 +02001496 PyObject *borrowed_dot, *seq = NULL;
Brett Cannonfd074152012-04-14 14:10:13 -04001497
1498 borrowed_dot = _PyUnicode_FromId(&single_dot);
Antoine Pitrou538ba2a2012-04-16 21:52:45 +02001499 seq = PyTuple_Pack(2, base, name);
1500 Py_DECREF(base);
Brett Cannonfd074152012-04-14 14:10:13 -04001501 if (borrowed_dot == NULL || seq == NULL) {
1502 goto error;
1503 }
1504
1505 abs_name = PyUnicode_Join(borrowed_dot, seq);
1506 Py_DECREF(seq);
1507 if (abs_name == NULL) {
1508 goto error;
1509 }
1510 }
1511 else {
1512 abs_name = base;
1513 }
1514 }
1515 else {
1516 abs_name = name;
1517 Py_INCREF(abs_name);
1518 }
1519
Brian Curtine6b299f2012-04-14 14:19:33 -05001520#ifdef WITH_THREAD
Brett Cannonfd074152012-04-14 14:10:13 -04001521 _PyImport_AcquireLock();
1522#endif
1523 /* From this point forward, goto error_with_unlock! */
1524 if (PyDict_Check(globals)) {
1525 builtins_import = _PyDict_GetItemId(globals, &PyId___import__);
1526 }
1527 if (builtins_import == NULL) {
1528 builtins_import = _PyDict_GetItemId(interp->builtins, &PyId___import__);
1529 if (builtins_import == NULL) {
Benjamin Peterson7d110042013-04-29 09:08:14 -04001530 PyErr_SetString(PyExc_ImportError, "__import__ not found");
1531 goto error_with_unlock;
Brett Cannonfd074152012-04-14 14:10:13 -04001532 }
1533 }
1534 Py_INCREF(builtins_import);
1535
1536 mod = PyDict_GetItem(interp->modules, abs_name);
1537 if (mod == Py_None) {
Brett Cannon27fc5282012-04-15 14:15:31 -04001538 PyObject *msg = PyUnicode_FromFormat("import of %R halted; "
1539 "None in sys.modules", abs_name);
1540 if (msg != NULL) {
Brett Cannon82da8882013-07-04 17:48:16 -04001541 PyErr_SetImportError(msg, abs_name, NULL);
Brian Curtin09b86d12012-04-17 16:57:09 -05001542 Py_DECREF(msg);
Brett Cannon27fc5282012-04-15 14:15:31 -04001543 }
Antoine Pitrou71382cb2012-04-16 18:48:49 +02001544 mod = NULL;
Brett Cannonfd074152012-04-14 14:10:13 -04001545 goto error_with_unlock;
1546 }
1547 else if (mod != NULL) {
Eric Snowb523f842013-11-22 09:05:39 -07001548 PyObject *value = NULL;
1549 PyObject *spec;
Antoine Pitrouea3eb882012-05-17 18:55:59 +02001550 int initializing = 0;
1551
Brett Cannonfd074152012-04-14 14:10:13 -04001552 Py_INCREF(mod);
Antoine Pitrou03989852012-08-28 00:24:52 +02001553 /* Optimization: only call _bootstrap._lock_unlock_module() if
Eric Snowb523f842013-11-22 09:05:39 -07001554 __spec__._initializing is true.
1555 NOTE: because of this, initializing must be set *before*
Antoine Pitrou03989852012-08-28 00:24:52 +02001556 stuffing the new module in sys.modules.
1557 */
Eric Snowb523f842013-11-22 09:05:39 -07001558 spec = _PyObject_GetAttrId(mod, &PyId___spec__);
1559 if (spec != NULL) {
1560 value = _PyObject_GetAttrId(spec, &PyId__initializing);
1561 Py_DECREF(spec);
1562 }
Antoine Pitrouea3eb882012-05-17 18:55:59 +02001563 if (value == NULL)
1564 PyErr_Clear();
1565 else {
1566 initializing = PyObject_IsTrue(value);
1567 Py_DECREF(value);
1568 if (initializing == -1)
1569 PyErr_Clear();
1570 }
1571 if (initializing > 0) {
1572 /* _bootstrap._lock_unlock_module() releases the import lock */
Alexandre Vassalotti865eaa12013-05-02 10:44:04 -07001573 value = _PyObject_CallMethodIdObjArgs(interp->importlib,
Antoine Pitrouea3eb882012-05-17 18:55:59 +02001574 &PyId__lock_unlock_module, abs_name,
1575 NULL);
1576 if (value == NULL)
1577 goto error;
1578 Py_DECREF(value);
1579 }
1580 else {
1581#ifdef WITH_THREAD
1582 if (_PyImport_ReleaseLock() < 0) {
1583 PyErr_SetString(PyExc_RuntimeError, "not holding the import lock");
1584 goto error;
1585 }
1586#endif
1587 }
Brett Cannonfd074152012-04-14 14:10:13 -04001588 }
1589 else {
Antoine Pitrouea3eb882012-05-17 18:55:59 +02001590 /* _bootstrap._find_and_load() releases the import lock */
Alexandre Vassalotti865eaa12013-05-02 10:44:04 -07001591 mod = _PyObject_CallMethodIdObjArgs(interp->importlib,
Brett Cannonfd074152012-04-14 14:10:13 -04001592 &PyId__find_and_load, abs_name,
1593 builtins_import, NULL);
1594 if (mod == NULL) {
Antoine Pitrouea3eb882012-05-17 18:55:59 +02001595 goto error;
Brett Cannonfd074152012-04-14 14:10:13 -04001596 }
1597 }
Antoine Pitrouea3eb882012-05-17 18:55:59 +02001598 /* From now on we don't hold the import lock anymore. */
Brett Cannonfd074152012-04-14 14:10:13 -04001599
Serhiy Storchakafa494fd2015-05-30 17:45:22 +03001600 has_from = PyObject_IsTrue(fromlist);
1601 if (has_from < 0)
1602 goto error;
1603 if (!has_from) {
Brett Cannonfd074152012-04-14 14:10:13 -04001604 if (level == 0 || PyUnicode_GET_LENGTH(name) > 0) {
1605 PyObject *front = NULL;
Brian Curtine6b299f2012-04-14 14:19:33 -05001606 PyObject *partition = NULL;
Brett Cannonfd074152012-04-14 14:10:13 -04001607 PyObject *borrowed_dot = _PyUnicode_FromId(&single_dot);
1608
1609 if (borrowed_dot == NULL) {
Antoine Pitrouea3eb882012-05-17 18:55:59 +02001610 goto error;
Brett Cannonfd074152012-04-14 14:10:13 -04001611 }
1612
Brian Curtine6b299f2012-04-14 14:19:33 -05001613 partition = PyUnicode_Partition(name, borrowed_dot);
Brett Cannonfd074152012-04-14 14:10:13 -04001614 if (partition == NULL) {
Antoine Pitrouea3eb882012-05-17 18:55:59 +02001615 goto error;
Brett Cannonfd074152012-04-14 14:10:13 -04001616 }
1617
Antoine Pitrou6efa50a2012-05-07 21:41:59 +02001618 if (PyUnicode_GET_LENGTH(PyTuple_GET_ITEM(partition, 1)) == 0) {
1619 /* No dot in module name, simple exit */
1620 Py_DECREF(partition);
1621 final_mod = mod;
1622 Py_INCREF(mod);
Antoine Pitrouea3eb882012-05-17 18:55:59 +02001623 goto error;
Antoine Pitrou6efa50a2012-05-07 21:41:59 +02001624 }
1625
Brett Cannonfd074152012-04-14 14:10:13 -04001626 front = PyTuple_GET_ITEM(partition, 0);
1627 Py_INCREF(front);
1628 Py_DECREF(partition);
1629
1630 if (level == 0) {
Antoine Pitrou6efa50a2012-05-07 21:41:59 +02001631 final_mod = PyObject_CallFunctionObjArgs(builtins_import, front, NULL);
Antoine Pitroub78174c2012-05-06 17:15:23 +02001632 Py_DECREF(front);
Brett Cannonfd074152012-04-14 14:10:13 -04001633 }
1634 else {
Antoine Pitrou22a1d172012-04-16 22:06:21 +02001635 Py_ssize_t cut_off = PyUnicode_GET_LENGTH(name) -
1636 PyUnicode_GET_LENGTH(front);
1637 Py_ssize_t abs_name_len = PyUnicode_GET_LENGTH(abs_name);
Brett Cannon49f8d8b2012-04-14 21:50:00 -04001638 PyObject *to_return = PyUnicode_Substring(abs_name, 0,
Brett Cannonfd074152012-04-14 14:10:13 -04001639 abs_name_len - cut_off);
Antoine Pitrou22a1d172012-04-16 22:06:21 +02001640 Py_DECREF(front);
1641 if (to_return == NULL) {
Antoine Pitrouea3eb882012-05-17 18:55:59 +02001642 goto error;
Antoine Pitrou22a1d172012-04-16 22:06:21 +02001643 }
Brett Cannonfd074152012-04-14 14:10:13 -04001644
1645 final_mod = PyDict_GetItem(interp->modules, to_return);
Brett Cannon49f8d8b2012-04-14 21:50:00 -04001646 if (final_mod == NULL) {
1647 PyErr_Format(PyExc_KeyError,
1648 "%R not in sys.modules as expected",
1649 to_return);
1650 }
1651 else {
1652 Py_INCREF(final_mod);
1653 }
Antoine Pitroub78174c2012-05-06 17:15:23 +02001654 Py_DECREF(to_return);
Brett Cannonfd074152012-04-14 14:10:13 -04001655 }
1656 }
1657 else {
1658 final_mod = mod;
1659 Py_INCREF(mod);
1660 }
1661 }
1662 else {
Alexandre Vassalotti865eaa12013-05-02 10:44:04 -07001663 final_mod = _PyObject_CallMethodIdObjArgs(interp->importlib,
Brett Cannonfd074152012-04-14 14:10:13 -04001664 &PyId__handle_fromlist, mod,
1665 fromlist, builtins_import,
1666 NULL);
1667 }
Antoine Pitrouea3eb882012-05-17 18:55:59 +02001668 goto error;
Antoine Pitrou6efa50a2012-05-07 21:41:59 +02001669
Brett Cannonfd074152012-04-14 14:10:13 -04001670 error_with_unlock:
Brian Curtine6b299f2012-04-14 14:19:33 -05001671#ifdef WITH_THREAD
Brett Cannonfd074152012-04-14 14:10:13 -04001672 if (_PyImport_ReleaseLock() < 0) {
1673 PyErr_SetString(PyExc_RuntimeError, "not holding the import lock");
1674 }
1675#endif
1676 error:
1677 Py_XDECREF(abs_name);
1678 Py_XDECREF(builtins_import);
1679 Py_XDECREF(mod);
1680 Py_XDECREF(package);
1681 Py_XDECREF(globals);
1682 Py_XDECREF(fromlist);
Antoine Pitroubc07a5c2012-07-08 12:01:27 +02001683 if (final_mod == NULL)
1684 remove_importlib_frames();
Brett Cannonfd074152012-04-14 14:10:13 -04001685 return final_mod;
Guido van Rossum75acc9c1998-03-03 22:26:50 +00001686}
1687
Victor Stinnerfe93faf2011-03-14 15:54:52 -04001688PyObject *
Benjamin Peterson04778a82011-05-25 09:29:00 -05001689PyImport_ImportModuleLevel(const char *name, PyObject *globals, PyObject *locals,
Victor Stinnerfe93faf2011-03-14 15:54:52 -04001690 PyObject *fromlist, int level)
1691{
1692 PyObject *nameobj, *mod;
1693 nameobj = PyUnicode_FromString(name);
1694 if (nameobj == NULL)
1695 return NULL;
1696 mod = PyImport_ImportModuleLevelObject(nameobj, globals, locals,
1697 fromlist, level);
1698 Py_DECREF(nameobj);
1699 return mod;
1700}
1701
1702
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001703/* Re-import a module of any kind and return its module object, WITH
1704 INCREMENTED REFERENCE COUNT */
1705
Guido van Rossum79f25d91997-04-29 20:08:16 +00001706PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001707PyImport_ReloadModule(PyObject *m)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001708{
Brett Cannon62228db2012-04-29 14:38:11 -04001709 _Py_IDENTIFIER(reload);
1710 PyObject *reloaded_module = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001711 PyObject *modules = PyImport_GetModuleDict();
Brett Cannon62228db2012-04-29 14:38:11 -04001712 PyObject *imp = PyDict_GetItemString(modules, "imp");
1713 if (imp == NULL) {
1714 imp = PyImport_ImportModule("imp");
1715 if (imp == NULL) {
1716 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001717 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001718 }
Brett Cannon62228db2012-04-29 14:38:11 -04001719 else {
1720 Py_INCREF(imp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001721 }
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001722
Brett Cannon62228db2012-04-29 14:38:11 -04001723 reloaded_module = _PyObject_CallMethodId(imp, &PyId_reload, "O", m);
1724 Py_DECREF(imp);
1725 return reloaded_module;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001726}
1727
1728
Guido van Rossumd47a0a81997-08-14 20:11:26 +00001729/* Higher-level import emulator which emulates the "import" statement
1730 more accurately -- it invokes the __import__() function from the
1731 builtins of the current globals. This means that the import is
1732 done using whatever import hooks are installed in the current
Brett Cannonbc2eff32010-09-19 21:39:02 +00001733 environment.
Guido van Rossum6058eb41998-12-21 19:51:00 +00001734 A dummy list ["__doc__"] is passed as the 4th argument so that
Neal Norwitz80e7f272007-08-26 06:45:23 +00001735 e.g. PyImport_Import(PyUnicode_FromString("win32com.client.gencache"))
Guido van Rossum6058eb41998-12-21 19:51:00 +00001736 will return <module "gencache"> instead of <module "win32com">. */
Guido van Rossumd47a0a81997-08-14 20:11:26 +00001737
1738PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001739PyImport_Import(PyObject *module_name)
Guido van Rossumd47a0a81997-08-14 20:11:26 +00001740{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001741 static PyObject *silly_list = NULL;
1742 static PyObject *builtins_str = NULL;
1743 static PyObject *import_str = NULL;
1744 PyObject *globals = NULL;
1745 PyObject *import = NULL;
1746 PyObject *builtins = NULL;
Brett Cannonbc2eff32010-09-19 21:39:02 +00001747 PyObject *modules = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001748 PyObject *r = NULL;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00001749
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001750 /* Initialize constant string objects */
1751 if (silly_list == NULL) {
1752 import_str = PyUnicode_InternFromString("__import__");
1753 if (import_str == NULL)
1754 return NULL;
1755 builtins_str = PyUnicode_InternFromString("__builtins__");
1756 if (builtins_str == NULL)
1757 return NULL;
Brett Cannonbc2eff32010-09-19 21:39:02 +00001758 silly_list = PyList_New(0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001759 if (silly_list == NULL)
1760 return NULL;
1761 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00001762
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001763 /* Get the builtins from current globals */
1764 globals = PyEval_GetGlobals();
1765 if (globals != NULL) {
1766 Py_INCREF(globals);
1767 builtins = PyObject_GetItem(globals, builtins_str);
1768 if (builtins == NULL)
1769 goto err;
1770 }
1771 else {
1772 /* No globals -- use standard builtins, and fake globals */
1773 builtins = PyImport_ImportModuleLevel("builtins",
1774 NULL, NULL, NULL, 0);
1775 if (builtins == NULL)
1776 return NULL;
1777 globals = Py_BuildValue("{OO}", builtins_str, builtins);
1778 if (globals == NULL)
1779 goto err;
1780 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00001781
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001782 /* Get the __import__ function from the builtins */
1783 if (PyDict_Check(builtins)) {
1784 import = PyObject_GetItem(builtins, import_str);
1785 if (import == NULL)
1786 PyErr_SetObject(PyExc_KeyError, import_str);
1787 }
1788 else
1789 import = PyObject_GetAttr(builtins, import_str);
1790 if (import == NULL)
1791 goto err;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00001792
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001793 /* Call the __import__ function with the proper argument list
Brett Cannonbc2eff32010-09-19 21:39:02 +00001794 Always use absolute import here.
1795 Calling for side-effect of import. */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001796 r = PyObject_CallFunction(import, "OOOOi", module_name, globals,
1797 globals, silly_list, 0, NULL);
Brett Cannonbc2eff32010-09-19 21:39:02 +00001798 if (r == NULL)
1799 goto err;
1800 Py_DECREF(r);
1801
1802 modules = PyImport_GetModuleDict();
1803 r = PyDict_GetItem(modules, module_name);
1804 if (r != NULL)
1805 Py_INCREF(r);
Guido van Rossumd47a0a81997-08-14 20:11:26 +00001806
1807 err:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001808 Py_XDECREF(globals);
1809 Py_XDECREF(builtins);
1810 Py_XDECREF(import);
Tim Peters50d8d372001-02-28 05:34:27 +00001811
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001812 return r;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00001813}
1814
Brett Cannon4caa61d2014-01-09 19:03:32 -05001815/*[clinic input]
1816_imp.extension_suffixes
1817
1818Returns the list of file suffixes used to identify extension modules.
1819[clinic start generated code]*/
1820
Brett Cannon4caa61d2014-01-09 19:03:32 -05001821static PyObject *
1822_imp_extension_suffixes_impl(PyModuleDef *module)
Brett Cannonfd4d0502014-05-30 11:21:14 -04001823/*[clinic end generated code: output=d44c1566ef362229 input=ecdeeecfcb6f839e]*/
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001824{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001825 PyObject *list;
Brett Cannon2657df42012-05-04 15:20:40 -04001826 const char *suffix;
1827 unsigned int index = 0;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001828
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001829 list = PyList_New(0);
1830 if (list == NULL)
1831 return NULL;
Brett Cannon2657df42012-05-04 15:20:40 -04001832#ifdef HAVE_DYNAMIC_LOADING
1833 while ((suffix = _PyImport_DynLoadFiletab[index])) {
1834 PyObject *item = PyUnicode_FromString(suffix);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001835 if (item == NULL) {
1836 Py_DECREF(list);
1837 return NULL;
1838 }
1839 if (PyList_Append(list, item) < 0) {
1840 Py_DECREF(list);
1841 Py_DECREF(item);
1842 return NULL;
1843 }
1844 Py_DECREF(item);
Brett Cannon2657df42012-05-04 15:20:40 -04001845 index += 1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001846 }
Brett Cannon2657df42012-05-04 15:20:40 -04001847#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001848 return list;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001849}
1850
Brett Cannon4caa61d2014-01-09 19:03:32 -05001851/*[clinic input]
Brett Cannon4caa61d2014-01-09 19:03:32 -05001852_imp.init_frozen
1853
1854 name: unicode
1855 /
1856
1857Initializes a frozen module.
1858[clinic start generated code]*/
1859
Brett Cannon4caa61d2014-01-09 19:03:32 -05001860static PyObject *
1861_imp_init_frozen_impl(PyModuleDef *module, PyObject *name)
Brett Cannonfd4d0502014-05-30 11:21:14 -04001862/*[clinic end generated code: output=a9de493bdd711878 input=13019adfc04f3fb3]*/
Brett Cannon4caa61d2014-01-09 19:03:32 -05001863{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001864 int ret;
1865 PyObject *m;
Brett Cannon4caa61d2014-01-09 19:03:32 -05001866
Victor Stinner53dc7352011-03-20 01:50:21 +01001867 ret = PyImport_ImportFrozenModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001868 if (ret < 0)
1869 return NULL;
1870 if (ret == 0) {
1871 Py_INCREF(Py_None);
1872 return Py_None;
1873 }
Victor Stinner53dc7352011-03-20 01:50:21 +01001874 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001875 Py_XINCREF(m);
1876 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001877}
1878
Brett Cannon4caa61d2014-01-09 19:03:32 -05001879/*[clinic input]
1880_imp.get_frozen_object
1881
1882 name: unicode
1883 /
1884
1885Create a code object for a frozen module.
1886[clinic start generated code]*/
1887
Brett Cannon4caa61d2014-01-09 19:03:32 -05001888static PyObject *
1889_imp_get_frozen_object_impl(PyModuleDef *module, PyObject *name)
Brett Cannonfd4d0502014-05-30 11:21:14 -04001890/*[clinic end generated code: output=3114c970a47f2e3c input=ed689bc05358fdbd]*/
Brett Cannon4caa61d2014-01-09 19:03:32 -05001891{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001892 return get_frozen_object(name);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001893}
1894
Brett Cannon4caa61d2014-01-09 19:03:32 -05001895/*[clinic input]
1896_imp.is_frozen_package
1897
1898 name: unicode
1899 /
1900
1901Returns True if the module name is of a frozen package.
1902[clinic start generated code]*/
1903
Brett Cannon4caa61d2014-01-09 19:03:32 -05001904static PyObject *
1905_imp_is_frozen_package_impl(PyModuleDef *module, PyObject *name)
Brett Cannonfd4d0502014-05-30 11:21:14 -04001906/*[clinic end generated code: output=3e4cab802b56d649 input=81b6cdecd080fbb8]*/
Brett Cannon4caa61d2014-01-09 19:03:32 -05001907{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001908 return is_frozen_package(name);
Brett Cannon8d110132009-03-15 02:20:16 +00001909}
1910
Brett Cannon4caa61d2014-01-09 19:03:32 -05001911/*[clinic input]
1912_imp.is_builtin
1913
1914 name: unicode
1915 /
1916
1917Returns True if the module name corresponds to a built-in module.
1918[clinic start generated code]*/
1919
Guido van Rossum79f25d91997-04-29 20:08:16 +00001920static PyObject *
Brett Cannon4caa61d2014-01-09 19:03:32 -05001921_imp_is_builtin_impl(PyModuleDef *module, PyObject *name)
Brett Cannonfd4d0502014-05-30 11:21:14 -04001922/*[clinic end generated code: output=2deec9cac6fb9a7e input=86befdac021dd1c7]*/
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001923{
Brett Cannon4caa61d2014-01-09 19:03:32 -05001924 return PyLong_FromLong(is_builtin(name));
1925}
1926
1927/*[clinic input]
1928_imp.is_frozen
1929
1930 name: unicode
1931 /
1932
1933Returns True if the module name corresponds to a frozen module.
1934[clinic start generated code]*/
1935
Brett Cannon4caa61d2014-01-09 19:03:32 -05001936static PyObject *
1937_imp_is_frozen_impl(PyModuleDef *module, PyObject *name)
Brett Cannonfd4d0502014-05-30 11:21:14 -04001938/*[clinic end generated code: output=7de8e260c8e36aed input=7301dbca1897d66b]*/
Brett Cannon4caa61d2014-01-09 19:03:32 -05001939{
Benjamin Peterson6fba3db2013-03-18 23:13:31 -07001940 const struct _frozen *p;
Brett Cannon4caa61d2014-01-09 19:03:32 -05001941
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001942 p = find_frozen(name);
1943 return PyBool_FromLong((long) (p == NULL ? 0 : p->size));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001944}
1945
Larry Hastings1df0b352015-08-24 19:53:56 -07001946/* Common implementation for _imp.exec_dynamic and _imp.exec_builtin */
1947static int
1948exec_builtin_or_dynamic(PyObject *mod) {
1949 PyModuleDef *def;
1950 void *state;
1951
1952 if (!PyModule_Check(mod)) {
1953 return 0;
1954 }
1955
1956 def = PyModule_GetDef(mod);
1957 if (def == NULL) {
1958 if (PyErr_Occurred()) {
1959 return -1;
1960 }
1961 return 0;
1962 }
1963 state = PyModule_GetState(mod);
1964 if (PyErr_Occurred()) {
1965 return -1;
1966 }
1967 if (state) {
1968 /* Already initialized; skip reload */
1969 return 0;
1970 }
1971 return PyModule_ExecDef(mod, def);
1972}
1973
Guido van Rossum96a8fb71999-12-22 14:09:35 +00001974#ifdef HAVE_DYNAMIC_LOADING
1975
Brett Cannon4caa61d2014-01-09 19:03:32 -05001976/*[clinic input]
Nick Coghland5cacbb2015-05-23 22:24:10 +10001977_imp.create_dynamic
Brett Cannon4caa61d2014-01-09 19:03:32 -05001978
Nick Coghland5cacbb2015-05-23 22:24:10 +10001979 spec: object
Brett Cannon4caa61d2014-01-09 19:03:32 -05001980 file: object = NULL
1981 /
1982
Nick Coghland5cacbb2015-05-23 22:24:10 +10001983Create an extension module.
Brett Cannon4caa61d2014-01-09 19:03:32 -05001984[clinic start generated code]*/
1985
Brett Cannon4caa61d2014-01-09 19:03:32 -05001986static PyObject *
Nick Coghland5cacbb2015-05-23 22:24:10 +10001987_imp_create_dynamic_impl(PyModuleDef *module, PyObject *spec, PyObject *file)
1988/*[clinic end generated code: output=935cde5b3872d56d input=c31b954f4cf4e09d]*/
Brett Cannon4caa61d2014-01-09 19:03:32 -05001989{
Nick Coghland5cacbb2015-05-23 22:24:10 +10001990 PyObject *mod, *name, *path;
Victor Stinnerfefd70c2011-03-14 15:54:07 -04001991 FILE *fp;
1992
Nick Coghland5cacbb2015-05-23 22:24:10 +10001993 name = PyObject_GetAttrString(spec, "name");
1994 if (name == NULL) {
1995 return NULL;
1996 }
1997
1998 path = PyObject_GetAttrString(spec, "origin");
1999 if (path == NULL) {
2000 Py_DECREF(name);
2001 return NULL;
2002 }
2003
2004 mod = _PyImport_FindExtensionObject(name, path);
2005 if (mod != NULL) {
2006 Py_DECREF(name);
2007 Py_DECREF(path);
2008 Py_INCREF(mod);
2009 return mod;
2010 }
2011
Brett Cannon4caa61d2014-01-09 19:03:32 -05002012 if (file != NULL) {
2013 fp = _Py_fopen_obj(path, "r");
Victor Stinnere9ddbf62011-03-22 10:46:35 +01002014 if (fp == NULL) {
Nick Coghland5cacbb2015-05-23 22:24:10 +10002015 Py_DECREF(name);
Brett Cannon4caa61d2014-01-09 19:03:32 -05002016 Py_DECREF(path);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002017 return NULL;
Victor Stinnere9ddbf62011-03-22 10:46:35 +01002018 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002019 }
Victor Stinnerfefd70c2011-03-14 15:54:07 -04002020 else
2021 fp = NULL;
Nick Coghland5cacbb2015-05-23 22:24:10 +10002022
2023 mod = _PyImport_LoadDynamicModuleWithSpec(spec, fp);
2024
2025 Py_DECREF(name);
Brett Cannon4caa61d2014-01-09 19:03:32 -05002026 Py_DECREF(path);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002027 if (fp)
2028 fclose(fp);
Victor Stinnerfefd70c2011-03-14 15:54:07 -04002029 return mod;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002030}
2031
Nick Coghland5cacbb2015-05-23 22:24:10 +10002032/*[clinic input]
2033_imp.exec_dynamic -> int
2034
2035 mod: object
2036 /
2037
2038Initialize an extension module.
2039[clinic start generated code]*/
2040
2041static int
2042_imp_exec_dynamic_impl(PyModuleDef *module, PyObject *mod)
2043/*[clinic end generated code: output=4b84f1301b22d4bd input=9fdbfcb250280d3a]*/
2044{
Larry Hastings1df0b352015-08-24 19:53:56 -07002045 return exec_builtin_or_dynamic(mod);
Nick Coghland5cacbb2015-05-23 22:24:10 +10002046}
2047
2048
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002049#endif /* HAVE_DYNAMIC_LOADING */
2050
Larry Hastings7726ac92014-01-31 22:03:12 -08002051/*[clinic input]
Larry Hastings1df0b352015-08-24 19:53:56 -07002052_imp.exec_builtin -> int
2053
2054 mod: object
2055 /
2056
2057Initialize a built-in module.
2058[clinic start generated code]*/
2059
2060static int
2061_imp_exec_builtin_impl(PyModuleDef *module, PyObject *mod)
Larry Hastings01b1ff62015-08-24 20:23:27 -07002062/*[clinic end generated code: output=215e99876a27e284 input=7beed5a2f12a60ca]*/
Larry Hastings1df0b352015-08-24 19:53:56 -07002063{
2064 return exec_builtin_or_dynamic(mod);
2065}
2066
2067/*[clinic input]
Larry Hastings7726ac92014-01-31 22:03:12 -08002068dump buffer
2069[clinic start generated code]*/
Brett Cannonfd4d0502014-05-30 11:21:14 -04002070/*[clinic end generated code: output=da39a3ee5e6b4b0d input=524ce2e021e4eba6]*/
Larry Hastings7726ac92014-01-31 22:03:12 -08002071
Barry Warsaw28a691b2010-04-17 00:19:56 +00002072
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002073PyDoc_STRVAR(doc_imp,
Brett Cannon6f44d662012-04-15 16:08:47 -04002074"(Extremely) low-level import machinery bits as used by importlib and imp.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002075
Guido van Rossum79f25d91997-04-29 20:08:16 +00002076static PyMethodDef imp_methods[] = {
Brett Cannon4caa61d2014-01-09 19:03:32 -05002077 _IMP_EXTENSION_SUFFIXES_METHODDEF
2078 _IMP_LOCK_HELD_METHODDEF
2079 _IMP_ACQUIRE_LOCK_METHODDEF
2080 _IMP_RELEASE_LOCK_METHODDEF
2081 _IMP_GET_FROZEN_OBJECT_METHODDEF
2082 _IMP_IS_FROZEN_PACKAGE_METHODDEF
Nick Coghland5cacbb2015-05-23 22:24:10 +10002083 _IMP_CREATE_BUILTIN_METHODDEF
Brett Cannon4caa61d2014-01-09 19:03:32 -05002084 _IMP_INIT_FROZEN_METHODDEF
2085 _IMP_IS_BUILTIN_METHODDEF
2086 _IMP_IS_FROZEN_METHODDEF
Nick Coghland5cacbb2015-05-23 22:24:10 +10002087 _IMP_CREATE_DYNAMIC_METHODDEF
2088 _IMP_EXEC_DYNAMIC_METHODDEF
Larry Hastings1df0b352015-08-24 19:53:56 -07002089 _IMP_EXEC_BUILTIN_METHODDEF
Brett Cannon4caa61d2014-01-09 19:03:32 -05002090 _IMP__FIX_CO_FILENAME_METHODDEF
2091 {NULL, NULL} /* sentinel */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002092};
2093
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002094
Martin v. Löwis1a214512008-06-11 05:26:20 +00002095static struct PyModuleDef impmodule = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002096 PyModuleDef_HEAD_INIT,
Brett Cannon6f44d662012-04-15 16:08:47 -04002097 "_imp",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002098 doc_imp,
2099 0,
2100 imp_methods,
2101 NULL,
2102 NULL,
2103 NULL,
2104 NULL
Martin v. Löwis1a214512008-06-11 05:26:20 +00002105};
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002106
Jason Tishler6bc06ec2003-09-04 11:59:50 +00002107PyMODINIT_FUNC
Martin v. Löwis1a214512008-06-11 05:26:20 +00002108PyInit_imp(void)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002109{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002110 PyObject *m, *d;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002111
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002112 m = PyModule_Create(&impmodule);
2113 if (m == NULL)
2114 goto failure;
2115 d = PyModule_GetDict(m);
2116 if (d == NULL)
2117 goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002118
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002119 return m;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002120 failure:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002121 Py_XDECREF(m);
2122 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002123}
Guido van Rossum09cae1f1998-05-14 02:32:54 +00002124
2125
Guido van Rossumb18618d2000-05-03 23:44:39 +00002126/* API for embedding applications that want to add their own entries
2127 to the table of built-in modules. This should normally be called
2128 *before* Py_Initialize(). When the table resize fails, -1 is
2129 returned and the existing table is unchanged.
Guido van Rossum09cae1f1998-05-14 02:32:54 +00002130
2131 After a similar function by Just van Rossum. */
2132
2133int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002134PyImport_ExtendInittab(struct _inittab *newtab)
Guido van Rossum09cae1f1998-05-14 02:32:54 +00002135{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002136 static struct _inittab *our_copy = NULL;
2137 struct _inittab *p;
2138 int i, n;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00002139
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002140 /* Count the number of entries in both tables */
2141 for (n = 0; newtab[n].name != NULL; n++)
2142 ;
2143 if (n == 0)
2144 return 0; /* Nothing to do */
2145 for (i = 0; PyImport_Inittab[i].name != NULL; i++)
2146 ;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00002147
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002148 /* Allocate new memory for the combined table */
2149 p = our_copy;
2150 PyMem_RESIZE(p, struct _inittab, i+n+1);
2151 if (p == NULL)
2152 return -1;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00002153
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002154 /* Copy the tables into the new memory */
2155 if (our_copy != PyImport_Inittab)
2156 memcpy(p, PyImport_Inittab, (i+1) * sizeof(struct _inittab));
2157 PyImport_Inittab = our_copy = p;
2158 memcpy(p+i, newtab, (n+1) * sizeof(struct _inittab));
Guido van Rossum09cae1f1998-05-14 02:32:54 +00002159
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002160 return 0;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00002161}
2162
2163/* Shorthand to add a single entry given a name and a function */
2164
2165int
Brett Cannona826f322009-04-02 03:41:46 +00002166PyImport_AppendInittab(const char *name, PyObject* (*initfunc)(void))
Guido van Rossum09cae1f1998-05-14 02:32:54 +00002167{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002168 struct _inittab newtab[2];
Guido van Rossum09cae1f1998-05-14 02:32:54 +00002169
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002170 memset(newtab, '\0', sizeof newtab);
Guido van Rossum09cae1f1998-05-14 02:32:54 +00002171
Serhiy Storchaka20b39b22014-09-28 11:27:24 +03002172 newtab[0].name = name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002173 newtab[0].initfunc = initfunc;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00002174
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002175 return PyImport_ExtendInittab(newtab);
Guido van Rossum09cae1f1998-05-14 02:32:54 +00002176}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002177
2178#ifdef __cplusplus
2179}
2180#endif