blob: 63c99ea5c1abc7e7f6a4dfaa595af54644de2a8e [file] [log] [blame]
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001/* Module definition and import implementation */
2
Guido van Rossum79f25d91997-04-29 20:08:16 +00003#include "Python.h"
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00004
Jeremy Hylton3e0055f2005-10-20 19:59:25 +00005#include "Python-ast.h"
Guido van Rossumd8faa362007-04-27 19:54:29 +00006#undef Yield /* undefine macro conflicting with winbase.h */
Benjamin Peterson42aa93b2017-12-09 10:26:52 -08007#include "internal/hash.h"
8#include "internal/import.h"
Eric Snow2ebc5ce2017-09-07 23:51:28 -06009#include "internal/pystate.h"
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000010#include "errcode.h"
Guido van Rossumc405b7b1991-06-04 19:39:42 +000011#include "marshal.h"
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000012#include "code.h"
Antoine Pitroubc07a5c2012-07-08 12:01:27 +020013#include "frameobject.h"
Guido van Rossumd8bac6d1992-02-26 15:19:13 +000014#include "osdefs.h"
Guido van Rossum1ae940a1995-01-02 19:04:15 +000015#include "importdl.h"
Christian Heimes3d2b4072017-09-30 00:53:19 +020016#include "pydtrace.h"
Guido van Rossumc405b7b1991-06-04 19:39:42 +000017
Guido van Rossum55a83382000-09-20 20:31:38 +000018#ifdef HAVE_FCNTL_H
19#include <fcntl.h>
20#endif
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000021#ifdef __cplusplus
Brett Cannon9a5b25a2010-03-01 02:09:17 +000022extern "C" {
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000023#endif
Guido van Rossum55a83382000-09-20 20:31:38 +000024
Barry Warsaw28a691b2010-04-17 00:19:56 +000025#define CACHEDIR "__pycache__"
Guido van Rossum96774c12000-05-01 20:19:08 +000026
Victor Stinner95872862011-03-07 18:20:56 +010027/* See _PyImport_FixupExtensionObject() below */
Guido van Rossum25ce5661997-08-02 03:10:38 +000028static PyObject *extensions = NULL;
Guido van Rossum3f5da241990-12-20 15:06:42 +000029
Guido van Rossum771c6c81997-10-31 18:37:24 +000030/* This table is defined in config.c: */
31extern struct _inittab _PyImport_Inittab[];
32
33struct _inittab *PyImport_Inittab = _PyImport_Inittab;
Victor Stinner92a3c6f2017-12-06 18:12:59 +010034static struct _inittab *inittab_copy = NULL;
Guido van Rossum66f1fa81991-04-03 19:03:52 +000035
Brett Cannon4caa61d2014-01-09 19:03:32 -050036/*[clinic input]
37module _imp
38[clinic start generated code]*/
Serhiy Storchaka1009bf12015-04-03 23:53:51 +030039/*[clinic end generated code: output=da39a3ee5e6b4b0d input=9c332475d8686284]*/
Brett Cannonfd4d0502014-05-30 11:21:14 -040040
41#include "clinic/import.c.h"
Brett Cannon4caa61d2014-01-09 19:03:32 -050042
Guido van Rossum1ae940a1995-01-02 19:04:15 +000043/* Initialize things */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000044
Victor Stinnerf7e5b562017-11-15 15:48:08 -080045_PyInitError
Victor Stinner672b6ba2017-12-06 17:25:50 +010046_PyImport_Init(PyInterpreterState *interp)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000047{
Serhiy Storchaka013bb912014-02-10 18:21:34 +020048 interp->builtins_copy = PyDict_Copy(interp->builtins);
Victor Stinnerf7e5b562017-11-15 15:48:08 -080049 if (interp->builtins_copy == NULL) {
50 return _Py_INIT_ERR("Can't backup builtins dict");
51 }
52 return _Py_INIT_OK();
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000053}
54
Victor Stinnerf7e5b562017-11-15 15:48:08 -080055_PyInitError
Just van Rossum52e14d62002-12-30 22:08:05 +000056_PyImportHooks_Init(void)
57{
Brett Cannonfd074152012-04-14 14:10:13 -040058 PyObject *v, *path_hooks = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000059 int err = 0;
Just van Rossum52e14d62002-12-30 22:08:05 +000060
Brett Cannonfd074152012-04-14 14:10:13 -040061 /* adding sys.path_hooks and sys.path_importer_cache */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000062 v = PyList_New(0);
63 if (v == NULL)
64 goto error;
65 err = PySys_SetObject("meta_path", v);
66 Py_DECREF(v);
67 if (err)
68 goto error;
69 v = PyDict_New();
70 if (v == NULL)
71 goto error;
72 err = PySys_SetObject("path_importer_cache", v);
73 Py_DECREF(v);
74 if (err)
75 goto error;
76 path_hooks = PyList_New(0);
77 if (path_hooks == NULL)
78 goto error;
79 err = PySys_SetObject("path_hooks", path_hooks);
80 if (err) {
Victor Stinnerf7e5b562017-11-15 15:48:08 -080081 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000082 }
Brett Cannonfd074152012-04-14 14:10:13 -040083 Py_DECREF(path_hooks);
Victor Stinnerf7e5b562017-11-15 15:48:08 -080084 return _Py_INIT_OK();
85
86 error:
87 PyErr_Print();
88 return _Py_INIT_ERR("initializing sys.meta_path, sys.path_hooks, "
89 "or path_importer_cache failed");
Brett Cannonfd074152012-04-14 14:10:13 -040090}
91
Victor Stinnerf7e5b562017-11-15 15:48:08 -080092_PyInitError
Brett Cannonfd074152012-04-14 14:10:13 -040093_PyImportZip_Init(void)
94{
95 PyObject *path_hooks, *zimpimport;
96 int err = 0;
97
98 path_hooks = PySys_GetObject("path_hooks");
Victor Stinner1e53bba2013-07-16 22:26:05 +020099 if (path_hooks == NULL) {
100 PyErr_SetString(PyExc_RuntimeError, "unable to get sys.path_hooks");
Brett Cannonfd074152012-04-14 14:10:13 -0400101 goto error;
Victor Stinner1e53bba2013-07-16 22:26:05 +0200102 }
Brett Cannonfd074152012-04-14 14:10:13 -0400103
104 if (Py_VerboseFlag)
105 PySys_WriteStderr("# installing zipimport hook\n");
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000106
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000107 zimpimport = PyImport_ImportModule("zipimport");
108 if (zimpimport == NULL) {
109 PyErr_Clear(); /* No zip import module -- okay */
110 if (Py_VerboseFlag)
111 PySys_WriteStderr("# can't import zipimport\n");
112 }
113 else {
Martin v. Löwisbd928fe2011-10-14 10:20:37 +0200114 _Py_IDENTIFIER(zipimporter);
Martin v. Löwis1ee1b6f2011-10-10 18:11:30 +0200115 PyObject *zipimporter = _PyObject_GetAttrId(zimpimport,
116 &PyId_zipimporter);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000117 Py_DECREF(zimpimport);
118 if (zipimporter == NULL) {
119 PyErr_Clear(); /* No zipimporter object -- okay */
120 if (Py_VerboseFlag)
121 PySys_WriteStderr(
122 "# can't import zipimport.zipimporter\n");
123 }
124 else {
Brett Cannon8923a4d2012-04-24 22:03:46 -0400125 /* sys.path_hooks.insert(0, zipimporter) */
126 err = PyList_Insert(path_hooks, 0, zipimporter);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000127 Py_DECREF(zipimporter);
Brett Cannonfd074152012-04-14 14:10:13 -0400128 if (err < 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000129 goto error;
Brett Cannonfd074152012-04-14 14:10:13 -0400130 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000131 if (Py_VerboseFlag)
132 PySys_WriteStderr(
133 "# installed zipimport hook\n");
134 }
135 }
Brett Cannonfd074152012-04-14 14:10:13 -0400136
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800137 return _Py_INIT_OK();
Brett Cannonfd074152012-04-14 14:10:13 -0400138
139 error:
140 PyErr_Print();
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800141 return _Py_INIT_ERR("initializing zipimport failed");
Just van Rossum52e14d62002-12-30 22:08:05 +0000142}
143
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000144/* Locking primitives to prevent parallel imports of the same module
145 in different threads to return with a partially loaded module.
146 These calls are serialized by the global interpreter lock. */
147
Guido van Rossum49b56061998-10-01 20:42:43 +0000148#include "pythread.h"
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000149
Guido van Rossum65d5b571998-12-21 19:32:43 +0000150static PyThread_type_lock import_lock = 0;
Serhiy Storchakaaefa7eb2017-03-23 15:48:39 +0200151static unsigned long import_lock_thread = PYTHREAD_INVALID_THREAD_ID;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000152static int import_lock_level = 0;
153
Benjamin Peterson0df35a92009-10-04 20:32:25 +0000154void
155_PyImport_AcquireLock(void)
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000156{
Serhiy Storchakaaefa7eb2017-03-23 15:48:39 +0200157 unsigned long me = PyThread_get_thread_ident();
158 if (me == PYTHREAD_INVALID_THREAD_ID)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000159 return; /* Too bad */
160 if (import_lock == NULL) {
161 import_lock = PyThread_allocate_lock();
162 if (import_lock == NULL)
163 return; /* Nothing much we can do. */
164 }
165 if (import_lock_thread == me) {
166 import_lock_level++;
167 return;
168 }
Serhiy Storchakaaefa7eb2017-03-23 15:48:39 +0200169 if (import_lock_thread != PYTHREAD_INVALID_THREAD_ID ||
170 !PyThread_acquire_lock(import_lock, 0))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000171 {
172 PyThreadState *tstate = PyEval_SaveThread();
173 PyThread_acquire_lock(import_lock, 1);
174 PyEval_RestoreThread(tstate);
175 }
Antoine Pitrou202b6062012-12-18 22:18:17 +0100176 assert(import_lock_level == 0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000177 import_lock_thread = me;
178 import_lock_level = 1;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000179}
180
Benjamin Peterson0df35a92009-10-04 20:32:25 +0000181int
182_PyImport_ReleaseLock(void)
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000183{
Serhiy Storchakaaefa7eb2017-03-23 15:48:39 +0200184 unsigned long me = PyThread_get_thread_ident();
185 if (me == PYTHREAD_INVALID_THREAD_ID || import_lock == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000186 return 0; /* Too bad */
187 if (import_lock_thread != me)
188 return -1;
189 import_lock_level--;
Antoine Pitrou202b6062012-12-18 22:18:17 +0100190 assert(import_lock_level >= 0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000191 if (import_lock_level == 0) {
Serhiy Storchakaaefa7eb2017-03-23 15:48:39 +0200192 import_lock_thread = PYTHREAD_INVALID_THREAD_ID;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000193 PyThread_release_lock(import_lock);
194 }
195 return 1;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000196}
197
Antoine Pitrouf7ecfac2017-05-28 11:35:14 +0200198/* This function is called from PyOS_AfterFork_Child to ensure that newly
Gregory P. Smith24cec9f2010-03-01 06:18:41 +0000199 created child processes do not share locks with the parent.
200 We now acquire the import lock around fork() calls but on some platforms
201 (Solaris 9 and earlier? see isue7242) that still left us with problems. */
Guido van Rossum8ee3e5a2005-09-14 18:09:42 +0000202
203void
204_PyImport_ReInitLock(void)
205{
Christian Heimes418fd742015-04-19 21:08:42 +0200206 if (import_lock != NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000207 import_lock = PyThread_allocate_lock();
Christian Heimes418fd742015-04-19 21:08:42 +0200208 if (import_lock == NULL) {
209 Py_FatalError("PyImport_ReInitLock failed to create a new lock");
210 }
211 }
Nick Coghlanb2ddf792010-12-02 04:11:46 +0000212 if (import_lock_level > 1) {
213 /* Forked as a side effect of import */
Serhiy Storchakaaefa7eb2017-03-23 15:48:39 +0200214 unsigned long me = PyThread_get_thread_ident();
Brett Cannone4710cf2012-11-15 21:39:36 -0500215 /* The following could fail if the lock is already held, but forking as
216 a side-effect of an import is a) rare, b) nuts, and c) difficult to
217 do thanks to the lock only being held when doing individual module
218 locks per import. */
219 PyThread_acquire_lock(import_lock, NOWAIT_LOCK);
Nick Coghlanb2ddf792010-12-02 04:11:46 +0000220 import_lock_thread = me;
221 import_lock_level--;
222 } else {
Serhiy Storchakaaefa7eb2017-03-23 15:48:39 +0200223 import_lock_thread = PYTHREAD_INVALID_THREAD_ID;
Nick Coghlanb2ddf792010-12-02 04:11:46 +0000224 import_lock_level = 0;
225 }
Guido van Rossum8ee3e5a2005-09-14 18:09:42 +0000226}
227
Brett Cannon4caa61d2014-01-09 19:03:32 -0500228/*[clinic input]
229_imp.lock_held
230
231Return True if the import lock is currently held, else False.
232
233On platforms without threads, return False.
234[clinic start generated code]*/
235
Brett Cannon4caa61d2014-01-09 19:03:32 -0500236static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +0300237_imp_lock_held_impl(PyObject *module)
238/*[clinic end generated code: output=8b89384b5e1963fc input=9b088f9b217d9bdf]*/
Tim Peters69232342001-08-30 05:16:13 +0000239{
Serhiy Storchakaaefa7eb2017-03-23 15:48:39 +0200240 return PyBool_FromLong(import_lock_thread != PYTHREAD_INVALID_THREAD_ID);
Tim Peters69232342001-08-30 05:16:13 +0000241}
242
Brett Cannon4caa61d2014-01-09 19:03:32 -0500243/*[clinic input]
244_imp.acquire_lock
245
246Acquires the interpreter's import lock for the current thread.
247
248This lock should be used by import hooks to ensure thread-safety when importing
249modules. On platforms without threads, this function does nothing.
250[clinic start generated code]*/
251
Brett Cannon4caa61d2014-01-09 19:03:32 -0500252static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +0300253_imp_acquire_lock_impl(PyObject *module)
254/*[clinic end generated code: output=1aff58cb0ee1b026 input=4a2d4381866d5fdc]*/
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000255{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000256 _PyImport_AcquireLock();
Serhiy Storchaka228b12e2017-01-23 09:47:21 +0200257 Py_RETURN_NONE;
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000258}
259
Brett Cannon4caa61d2014-01-09 19:03:32 -0500260/*[clinic input]
261_imp.release_lock
262
263Release the interpreter's import lock.
264
265On platforms without threads, this function does nothing.
266[clinic start generated code]*/
267
Brett Cannon4caa61d2014-01-09 19:03:32 -0500268static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +0300269_imp_release_lock_impl(PyObject *module)
270/*[clinic end generated code: output=7faab6d0be178b0a input=934fb11516dd778b]*/
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000271{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000272 if (_PyImport_ReleaseLock() < 0) {
273 PyErr_SetString(PyExc_RuntimeError,
274 "not holding the import lock");
275 return NULL;
276 }
Serhiy Storchaka228b12e2017-01-23 09:47:21 +0200277 Py_RETURN_NONE;
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000278}
279
Antoine Pitrou8db076c2011-10-30 19:13:55 +0100280void
281_PyImport_Fini(void)
282{
Serhiy Storchaka505ff752014-02-09 13:33:53 +0200283 Py_CLEAR(extensions);
Antoine Pitrou8db076c2011-10-30 19:13:55 +0100284 if (import_lock != NULL) {
285 PyThread_free_lock(import_lock);
286 import_lock = NULL;
287 }
Antoine Pitrou8db076c2011-10-30 19:13:55 +0100288}
289
Victor Stinner92a3c6f2017-12-06 18:12:59 +0100290void
291_PyImport_Fini2(void)
292{
293 /* Use the same memory allocator than PyImport_ExtendInittab(). */
294 PyMemAllocatorEx old_alloc;
295 _PyMem_SetDefaultAllocator(PYMEM_DOMAIN_RAW, &old_alloc);
296
297 /* Free memory allocated by PyImport_ExtendInittab() */
298 PyMem_RawFree(inittab_copy);
299
300 PyMem_SetAllocator(PYMEM_DOMAIN_RAW, &old_alloc);
301}
302
Guido van Rossum25ce5661997-08-02 03:10:38 +0000303/* Helper for sys */
304
305PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000306PyImport_GetModuleDict(void)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000307{
Eric Snow93c92f72017-09-13 23:46:04 -0700308 PyInterpreterState *interp = PyThreadState_GET()->interp;
Eric Snow3f9eee62017-09-15 16:35:20 -0600309 if (interp->modules == NULL) {
Eric Snow93c92f72017-09-13 23:46:04 -0700310 Py_FatalError("PyImport_GetModuleDict: no module dictionary!");
Eric Snow3f9eee62017-09-15 16:35:20 -0600311 }
Eric Snow93c92f72017-09-13 23:46:04 -0700312 return interp->modules;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000313}
314
Eric Snowd393c1b2017-09-14 12:18:12 -0600315/* In some corner cases it is important to be sure that the import
316 machinery has been initialized (or not cleaned up yet). For
317 example, see issue #4236 and PyModule_Create2(). */
318
319int
320_PyImport_IsInitialized(PyInterpreterState *interp)
321{
322 if (interp->modules == NULL)
323 return 0;
324 return 1;
325}
Guido van Rossum3f5da241990-12-20 15:06:42 +0000326
Eric Snow3f9eee62017-09-15 16:35:20 -0600327PyObject *
328_PyImport_GetModuleId(struct _Py_Identifier *nameid)
329{
330 PyObject *name = _PyUnicode_FromId(nameid); /* borrowed */
331 if (name == NULL) {
332 return NULL;
333 }
334 return PyImport_GetModule(name);
335}
336
337int
338_PyImport_SetModule(PyObject *name, PyObject *m)
339{
340 PyObject *modules = PyImport_GetModuleDict();
341 return PyObject_SetItem(modules, name, m);
342}
343
344int
345_PyImport_SetModuleString(const char *name, PyObject *m)
346{
347 PyObject *modules = PyImport_GetModuleDict();
348 return PyMapping_SetItemString(modules, name, m);
349}
350
351PyObject *
352PyImport_GetModule(PyObject *name)
353{
354 PyObject *m;
355 PyObject *modules = PyImport_GetModuleDict();
356 if (modules == NULL) {
357 PyErr_SetString(PyExc_RuntimeError, "unable to get sys.modules");
358 return NULL;
359 }
360 Py_INCREF(modules);
361 if (PyDict_CheckExact(modules)) {
362 m = PyDict_GetItemWithError(modules, name); /* borrowed */
363 Py_XINCREF(m);
364 }
365 else {
366 m = PyObject_GetItem(modules, name);
Miss Islington (bot)291c9d42018-04-25 11:32:52 -0700367 if (m == NULL && PyErr_ExceptionMatches(PyExc_KeyError)) {
Eric Snow3f9eee62017-09-15 16:35:20 -0600368 PyErr_Clear();
369 }
370 }
371 Py_DECREF(modules);
372 return m;
373}
374
375
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000376/* List of names to clear in sys */
Serhiy Storchaka2d06e842015-12-25 19:53:18 +0200377static const char * const sys_deletes[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000378 "path", "argv", "ps1", "ps2",
379 "last_type", "last_value", "last_traceback",
380 "path_hooks", "path_importer_cache", "meta_path",
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200381 "__interactivehook__",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000382 /* misc stuff */
383 "flags", "float_info",
384 NULL
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000385};
386
Serhiy Storchaka2d06e842015-12-25 19:53:18 +0200387static const char * const sys_files[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000388 "stdin", "__stdin__",
389 "stdout", "__stdout__",
390 "stderr", "__stderr__",
391 NULL
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000392};
393
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000394/* Un-initialize things, as good as we can */
Guido van Rossum3f5da241990-12-20 15:06:42 +0000395
Guido van Rossum3f5da241990-12-20 15:06:42 +0000396void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000397PyImport_Cleanup(void)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000398{
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200399 Py_ssize_t pos;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000400 PyObject *key, *value, *dict;
401 PyInterpreterState *interp = PyThreadState_GET()->interp;
Eric Snowd393c1b2017-09-14 12:18:12 -0600402 PyObject *modules = PyImport_GetModuleDict();
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200403 PyObject *weaklist = NULL;
Serhiy Storchaka2d06e842015-12-25 19:53:18 +0200404 const char * const *p;
Guido van Rossum758eec01998-01-19 21:58:26 +0000405
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000406 if (modules == NULL)
407 return; /* Already done */
Guido van Rossum758eec01998-01-19 21:58:26 +0000408
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000409 /* Delete some special variables first. These are common
410 places where user values hide and people complain when their
411 destructors fail. Since the modules containing them are
412 deleted *last* of all, they would come too late in the normal
413 destruction order. Sigh. */
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000414
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200415 /* XXX Perhaps these precautions are obsolete. Who knows? */
416
Serhiy Storchaka013bb912014-02-10 18:21:34 +0200417 if (Py_VerboseFlag)
418 PySys_WriteStderr("# clear builtins._\n");
Miss Islington (bot)291c9d42018-04-25 11:32:52 -0700419 if (PyDict_SetItemString(interp->builtins, "_", Py_None) < 0) {
420 PyErr_Clear();
421 }
Serhiy Storchaka013bb912014-02-10 18:21:34 +0200422
423 for (p = sys_deletes; *p != NULL; p++) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000424 if (Py_VerboseFlag)
Serhiy Storchaka013bb912014-02-10 18:21:34 +0200425 PySys_WriteStderr("# clear sys.%s\n", *p);
Miss Islington (bot)291c9d42018-04-25 11:32:52 -0700426 if (PyDict_SetItemString(interp->sysdict, *p, Py_None) < 0) {
427 PyErr_Clear();
428 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000429 }
Serhiy Storchaka013bb912014-02-10 18:21:34 +0200430 for (p = sys_files; *p != NULL; p+=2) {
431 if (Py_VerboseFlag)
432 PySys_WriteStderr("# restore sys.%s\n", *p);
433 value = PyDict_GetItemString(interp->sysdict, *(p+1));
434 if (value == NULL)
435 value = Py_None;
Miss Islington (bot)291c9d42018-04-25 11:32:52 -0700436 if (PyDict_SetItemString(interp->sysdict, *p, value) < 0) {
437 PyErr_Clear();
438 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000439 }
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000440
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200441 /* We prepare a list which will receive (name, weakref) tuples of
442 modules when they are removed from sys.modules. The name is used
443 for diagnosis messages (in verbose mode), while the weakref helps
444 detect those modules which have been held alive. */
445 weaklist = PyList_New(0);
Antoine Pitrou79ba3882013-08-06 22:50:15 +0200446 if (weaklist == NULL)
447 PyErr_Clear();
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200448
Antoine Pitrou79ba3882013-08-06 22:50:15 +0200449#define STORE_MODULE_WEAKREF(name, mod) \
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200450 if (weaklist != NULL) { \
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200451 PyObject *wr = PyWeakref_NewRef(mod, NULL); \
Miss Islington (bot)291c9d42018-04-25 11:32:52 -0700452 if (wr) { \
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200453 PyObject *tup = PyTuple_Pack(2, name, wr); \
Miss Islington (bot)291c9d42018-04-25 11:32:52 -0700454 if (!tup || PyList_Append(weaklist, tup) < 0) { \
455 PyErr_Clear(); \
456 } \
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200457 Py_XDECREF(tup); \
Miss Islington (bot)291c9d42018-04-25 11:32:52 -0700458 Py_DECREF(wr); \
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200459 } \
Miss Islington (bot)291c9d42018-04-25 11:32:52 -0700460 else { \
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200461 PyErr_Clear(); \
Miss Islington (bot)291c9d42018-04-25 11:32:52 -0700462 } \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000463 }
Eric Snow3f9eee62017-09-15 16:35:20 -0600464#define CLEAR_MODULE(name, mod) \
465 if (PyModule_Check(mod)) { \
466 if (Py_VerboseFlag && PyUnicode_Check(name)) \
467 PySys_FormatStderr("# cleanup[2] removing %U\n", name); \
468 STORE_MODULE_WEAKREF(name, mod); \
Miss Islington (bot)291c9d42018-04-25 11:32:52 -0700469 if (PyObject_SetItem(modules, name, Py_None) < 0) { \
470 PyErr_Clear(); \
471 } \
Eric Snow3f9eee62017-09-15 16:35:20 -0600472 }
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000473
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200474 /* Remove all modules from sys.modules, hoping that garbage collection
475 can reclaim most of them. */
Eric Snow3f9eee62017-09-15 16:35:20 -0600476 if (PyDict_CheckExact(modules)) {
477 pos = 0;
478 while (PyDict_Next(modules, &pos, &key, &value)) {
479 CLEAR_MODULE(key, value);
480 }
481 }
482 else {
483 PyObject *iterator = PyObject_GetIter(modules);
484 if (iterator == NULL) {
485 PyErr_Clear();
486 }
487 else {
488 while ((key = PyIter_Next(iterator))) {
489 value = PyObject_GetItem(modules, key);
490 if (value == NULL) {
491 PyErr_Clear();
492 continue;
493 }
494 CLEAR_MODULE(key, value);
495 Py_DECREF(value);
496 Py_DECREF(key);
497 }
Miss Islington (bot)291c9d42018-04-25 11:32:52 -0700498 if (PyErr_Occurred()) {
499 PyErr_Clear();
500 }
Eric Snow3f9eee62017-09-15 16:35:20 -0600501 Py_DECREF(iterator);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000502 }
503 }
Guido van Rossum758eec01998-01-19 21:58:26 +0000504
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200505 /* Clear the modules dict. */
Eric Snow3f9eee62017-09-15 16:35:20 -0600506 if (PyDict_CheckExact(modules)) {
507 PyDict_Clear(modules);
508 }
509 else {
510 _Py_IDENTIFIER(clear);
511 if (_PyObject_CallMethodId(modules, &PyId_clear, "") == NULL)
512 PyErr_Clear();
513 }
Serhiy Storchaka013bb912014-02-10 18:21:34 +0200514 /* Restore the original builtins dict, to ensure that any
515 user data gets cleared. */
516 dict = PyDict_Copy(interp->builtins);
517 if (dict == NULL)
518 PyErr_Clear();
519 PyDict_Clear(interp->builtins);
520 if (PyDict_Update(interp->builtins, interp->builtins_copy))
521 PyErr_Clear();
522 Py_XDECREF(dict);
Antoine Pitrou40322e62013-08-11 00:30:09 +0200523 /* Clear module dict copies stored in the interpreter state */
524 _PyState_ClearModules();
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200525 /* Collect references */
526 _PyGC_CollectNoFail();
Antoine Pitrou5f454a02013-05-06 21:15:57 +0200527 /* Dump GC stats before it's too late, since it uses the warnings
528 machinery. */
529 _PyGC_DumpShutdownStats();
530
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200531 /* Now, if there are any modules left alive, clear their globals to
532 minimize potential leaks. All C extension modules actually end
Serhiy Storchaka013bb912014-02-10 18:21:34 +0200533 up here, since they are kept alive in the interpreter state.
534
535 The special treatment of "builtins" here is because even
536 when it's not referenced as a module, its dictionary is
537 referenced by almost every module's __builtins__. Since
538 deleting a module clears its dictionary (even if there are
539 references left to it), we need to delete the "builtins"
540 module last. Likewise, we don't delete sys until the very
541 end because it is implicitly referenced (e.g. by print). */
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200542 if (weaklist != NULL) {
543 Py_ssize_t i, n;
544 n = PyList_GET_SIZE(weaklist);
545 for (i = 0; i < n; i++) {
546 PyObject *tup = PyList_GET_ITEM(weaklist, i);
Antoine Pitrou79ba3882013-08-06 22:50:15 +0200547 PyObject *name = PyTuple_GET_ITEM(tup, 0);
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200548 PyObject *mod = PyWeakref_GET_OBJECT(PyTuple_GET_ITEM(tup, 1));
549 if (mod == Py_None)
550 continue;
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200551 assert(PyModule_Check(mod));
Serhiy Storchaka013bb912014-02-10 18:21:34 +0200552 dict = PyModule_GetDict(mod);
553 if (dict == interp->builtins || dict == interp->sysdict)
554 continue;
555 Py_INCREF(mod);
Antoine Pitrou79ba3882013-08-06 22:50:15 +0200556 if (Py_VerboseFlag && PyUnicode_Check(name))
Serhiy Storchaka013bb912014-02-10 18:21:34 +0200557 PySys_FormatStderr("# cleanup[3] wiping %U\n", name);
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200558 _PyModule_Clear(mod);
559 Py_DECREF(mod);
Antoine Pitrou070cb3c2013-05-08 13:23:25 +0200560 }
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200561 Py_DECREF(weaklist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000562 }
Guido van Rossum758eec01998-01-19 21:58:26 +0000563
Serhiy Storchaka013bb912014-02-10 18:21:34 +0200564 /* Next, delete sys and builtins (in that order) */
565 if (Py_VerboseFlag)
566 PySys_FormatStderr("# cleanup[3] wiping sys\n");
567 _PyModule_ClearDict(interp->sysdict);
568 if (Py_VerboseFlag)
569 PySys_FormatStderr("# cleanup[3] wiping builtins\n");
570 _PyModule_ClearDict(interp->builtins);
571
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200572 /* Clear and delete the modules directory. Actual modules will
573 still be there only if imported during the execution of some
574 destructor. */
Eric Snow93c92f72017-09-13 23:46:04 -0700575 interp->modules = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000576 Py_DECREF(modules);
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200577
578 /* Once more */
579 _PyGC_CollectNoFail();
580
Miss Islington (bot)291c9d42018-04-25 11:32:52 -0700581#undef CLEAR_MODULE
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200582#undef STORE_MODULE_WEAKREF
Guido van Rossum8d15b5d1990-10-26 14:58:58 +0000583}
Guido van Rossum7f133ed1991-02-19 12:23:57 +0000584
585
Barry Warsaw28a691b2010-04-17 00:19:56 +0000586/* Helper for pythonrun.c -- return magic number and tag. */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000587
588long
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000589PyImport_GetMagicNumber(void)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000590{
Antoine Pitrou44b4b6a2012-07-10 18:27:54 +0200591 long res;
Brett Cannon77b2abd2012-07-09 16:09:00 -0400592 PyInterpreterState *interp = PyThreadState_Get()->interp;
Eric Snow32439d62015-05-02 19:15:18 -0600593 PyObject *external, *pyc_magic;
594
595 external = PyObject_GetAttrString(interp->importlib, "_bootstrap_external");
596 if (external == NULL)
597 return -1;
598 pyc_magic = PyObject_GetAttrString(external, "_RAW_MAGIC_NUMBER");
599 Py_DECREF(external);
Brett Cannon77b2abd2012-07-09 16:09:00 -0400600 if (pyc_magic == NULL)
601 return -1;
Antoine Pitrou44b4b6a2012-07-10 18:27:54 +0200602 res = PyLong_AsLong(pyc_magic);
Benjamin Peterson66f36592012-07-09 22:21:55 -0700603 Py_DECREF(pyc_magic);
604 return res;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000605}
606
607
Brett Cannon3adc7b72012-07-09 14:22:12 -0400608extern const char * _PySys_ImplCacheTag;
609
Barry Warsaw28a691b2010-04-17 00:19:56 +0000610const char *
611PyImport_GetMagicTag(void)
612{
Brett Cannon3adc7b72012-07-09 14:22:12 -0400613 return _PySys_ImplCacheTag;
Barry Warsaw28a691b2010-04-17 00:19:56 +0000614}
615
Brett Cannon98979b82012-07-02 15:13:11 -0400616
Guido van Rossum25ce5661997-08-02 03:10:38 +0000617/* Magic for extension modules (built-in as well as dynamically
618 loaded). To prevent initializing an extension module more than
Andrew Svetlov6b2cbeb2012-12-14 17:04:59 +0200619 once, we keep a static dictionary 'extensions' keyed by the tuple
620 (module name, module name) (for built-in modules) or by
621 (filename, module name) (for dynamically loaded modules), containing these
622 modules. A copy of the module's dictionary is stored by calling
623 _PyImport_FixupExtensionObject() immediately after the module initialization
624 function succeeds. A copy can be retrieved from there by calling
Victor Stinner95872862011-03-07 18:20:56 +0100625 _PyImport_FindExtensionObject().
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000626
Barry Warsaw7c9627b2010-06-17 18:38:20 +0000627 Modules which do support multiple initialization set their m_size
628 field to a non-negative number (indicating the size of the
629 module-specific state). They are still recorded in the extensions
630 dictionary, to avoid loading shared libraries twice.
Martin v. Löwis1a214512008-06-11 05:26:20 +0000631*/
632
633int
Victor Stinner95872862011-03-07 18:20:56 +0100634_PyImport_FixupExtensionObject(PyObject *mod, PyObject *name,
Eric Snowd393c1b2017-09-14 12:18:12 -0600635 PyObject *filename, PyObject *modules)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000636{
Eric Snowd393c1b2017-09-14 12:18:12 -0600637 PyObject *dict, *key;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000638 struct PyModuleDef *def;
Benjamin Peterson5cb8a312012-12-15 00:05:16 -0500639 int res;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000640 if (extensions == NULL) {
641 extensions = PyDict_New();
642 if (extensions == NULL)
643 return -1;
644 }
645 if (mod == NULL || !PyModule_Check(mod)) {
646 PyErr_BadInternalCall();
647 return -1;
648 }
649 def = PyModule_GetDef(mod);
650 if (!def) {
651 PyErr_BadInternalCall();
652 return -1;
653 }
Eric Snow3f9eee62017-09-15 16:35:20 -0600654 if (PyObject_SetItem(modules, name, mod) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000655 return -1;
656 if (_PyState_AddModule(mod, def) < 0) {
Eric Snow3f9eee62017-09-15 16:35:20 -0600657 PyMapping_DelItem(modules, name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000658 return -1;
659 }
660 if (def->m_size == -1) {
661 if (def->m_base.m_copy) {
662 /* Somebody already imported the module,
663 likely under a different name.
664 XXX this should really not happen. */
Serhiy Storchaka505ff752014-02-09 13:33:53 +0200665 Py_CLEAR(def->m_base.m_copy);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000666 }
667 dict = PyModule_GetDict(mod);
668 if (dict == NULL)
669 return -1;
670 def->m_base.m_copy = PyDict_Copy(dict);
671 if (def->m_base.m_copy == NULL)
672 return -1;
673 }
Benjamin Peterson5cb8a312012-12-15 00:05:16 -0500674 key = PyTuple_Pack(2, filename, name);
675 if (key == NULL)
Andrew Svetlov6b2cbeb2012-12-14 17:04:59 +0200676 return -1;
Benjamin Peterson5cb8a312012-12-15 00:05:16 -0500677 res = PyDict_SetItem(extensions, key, (PyObject *)def);
678 Py_DECREF(key);
679 if (res < 0)
Andrew Svetlov6b2cbeb2012-12-14 17:04:59 +0200680 return -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000681 return 0;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000682}
683
Victor Stinner49d3f252010-10-17 01:24:53 +0000684int
Eric Snowd393c1b2017-09-14 12:18:12 -0600685_PyImport_FixupBuiltin(PyObject *mod, const char *name, PyObject *modules)
Victor Stinner49d3f252010-10-17 01:24:53 +0000686{
687 int res;
Victor Stinner95872862011-03-07 18:20:56 +0100688 PyObject *nameobj;
Victor Stinner21fcd0c2011-03-07 18:28:15 +0100689 nameobj = PyUnicode_InternFromString(name);
Victor Stinner95872862011-03-07 18:20:56 +0100690 if (nameobj == NULL)
Victor Stinner49d3f252010-10-17 01:24:53 +0000691 return -1;
Eric Snowd393c1b2017-09-14 12:18:12 -0600692 res = _PyImport_FixupExtensionObject(mod, nameobj, nameobj, modules);
Victor Stinner95872862011-03-07 18:20:56 +0100693 Py_DECREF(nameobj);
Victor Stinner49d3f252010-10-17 01:24:53 +0000694 return res;
695}
696
Guido van Rossum25ce5661997-08-02 03:10:38 +0000697PyObject *
Victor Stinner95872862011-03-07 18:20:56 +0100698_PyImport_FindExtensionObject(PyObject *name, PyObject *filename)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000699{
Eric Snowd393c1b2017-09-14 12:18:12 -0600700 PyObject *modules = PyImport_GetModuleDict();
701 return _PyImport_FindExtensionObjectEx(name, filename, modules);
702}
703
704PyObject *
705_PyImport_FindExtensionObjectEx(PyObject *name, PyObject *filename,
706 PyObject *modules)
707{
Benjamin Peterson5cb8a312012-12-15 00:05:16 -0500708 PyObject *mod, *mdict, *key;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000709 PyModuleDef* def;
710 if (extensions == NULL)
711 return NULL;
Benjamin Peterson5cb8a312012-12-15 00:05:16 -0500712 key = PyTuple_Pack(2, filename, name);
713 if (key == NULL)
Andrew Svetlov6b2cbeb2012-12-14 17:04:59 +0200714 return NULL;
Benjamin Peterson5cb8a312012-12-15 00:05:16 -0500715 def = (PyModuleDef *)PyDict_GetItem(extensions, key);
716 Py_DECREF(key);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000717 if (def == NULL)
718 return NULL;
719 if (def->m_size == -1) {
720 /* Module does not support repeated initialization */
721 if (def->m_base.m_copy == NULL)
722 return NULL;
Eric Snowd393c1b2017-09-14 12:18:12 -0600723 mod = _PyImport_AddModuleObject(name, modules);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000724 if (mod == NULL)
725 return NULL;
726 mdict = PyModule_GetDict(mod);
727 if (mdict == NULL)
728 return NULL;
729 if (PyDict_Update(mdict, def->m_base.m_copy))
730 return NULL;
731 }
732 else {
733 if (def->m_base.m_init == NULL)
734 return NULL;
735 mod = def->m_base.m_init();
736 if (mod == NULL)
737 return NULL;
Eric Snow3f9eee62017-09-15 16:35:20 -0600738 if (PyObject_SetItem(modules, name, mod) == -1) {
Christian Heimes09ca7942013-07-20 14:51:53 +0200739 Py_DECREF(mod);
740 return NULL;
741 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000742 Py_DECREF(mod);
743 }
744 if (_PyState_AddModule(mod, def) < 0) {
Eric Snow3f9eee62017-09-15 16:35:20 -0600745 PyMapping_DelItem(modules, name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000746 return NULL;
747 }
748 if (Py_VerboseFlag)
Victor Stinner95872862011-03-07 18:20:56 +0100749 PySys_FormatStderr("import %U # previously loaded (%R)\n",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000750 name, filename);
751 return mod;
Brett Cannon9a5b25a2010-03-01 02:09:17 +0000752
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000753}
754
Victor Stinner49d3f252010-10-17 01:24:53 +0000755PyObject *
Eric Snowd393c1b2017-09-14 12:18:12 -0600756_PyImport_FindBuiltin(const char *name, PyObject *modules)
Victor Stinner49d3f252010-10-17 01:24:53 +0000757{
Victor Stinner95872862011-03-07 18:20:56 +0100758 PyObject *res, *nameobj;
Victor Stinner21fcd0c2011-03-07 18:28:15 +0100759 nameobj = PyUnicode_InternFromString(name);
Victor Stinner95872862011-03-07 18:20:56 +0100760 if (nameobj == NULL)
Victor Stinner49d3f252010-10-17 01:24:53 +0000761 return NULL;
Eric Snowd393c1b2017-09-14 12:18:12 -0600762 res = _PyImport_FindExtensionObjectEx(nameobj, nameobj, modules);
Victor Stinner95872862011-03-07 18:20:56 +0100763 Py_DECREF(nameobj);
Victor Stinner49d3f252010-10-17 01:24:53 +0000764 return res;
765}
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000766
767/* Get the module object corresponding to a module name.
768 First check the modules dictionary if there's one there,
Walter Dörwaldf0dfc7a2003-10-20 14:01:56 +0000769 if not, create a new one and insert it in the modules dictionary.
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000770 Because the former action is most common, THIS DOES NOT RETURN A
771 'NEW' REFERENCE! */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000772
Guido van Rossum79f25d91997-04-29 20:08:16 +0000773PyObject *
Victor Stinner27ee0892011-03-04 12:57:09 +0000774PyImport_AddModuleObject(PyObject *name)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000775{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000776 PyObject *modules = PyImport_GetModuleDict();
Eric Snowd393c1b2017-09-14 12:18:12 -0600777 return _PyImport_AddModuleObject(name, modules);
778}
779
780PyObject *
781_PyImport_AddModuleObject(PyObject *name, PyObject *modules)
782{
Eric Snow86b7afd2017-09-04 17:54:09 -0600783 PyObject *m;
Eric Snow3f9eee62017-09-15 16:35:20 -0600784 if (PyDict_CheckExact(modules)) {
785 m = PyDict_GetItemWithError(modules, name);
786 }
787 else {
788 m = PyObject_GetItem(modules, name);
789 // For backward-comaptibility we copy the behavior
790 // of PyDict_GetItemWithError().
791 if (PyErr_ExceptionMatches(PyExc_KeyError)) {
792 PyErr_Clear();
793 }
Serhiy Storchaka48a583b2016-02-10 10:31:20 +0200794 }
795 if (PyErr_Occurred()) {
796 return NULL;
797 }
Eric Snow3f9eee62017-09-15 16:35:20 -0600798 if (m != NULL && PyModule_Check(m)) {
799 return m;
800 }
Victor Stinner27ee0892011-03-04 12:57:09 +0000801 m = PyModule_NewObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000802 if (m == NULL)
803 return NULL;
Eric Snow3f9eee62017-09-15 16:35:20 -0600804 if (PyObject_SetItem(modules, name, m) != 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000805 Py_DECREF(m);
806 return NULL;
807 }
808 Py_DECREF(m); /* Yes, it still exists, in modules! */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000809
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000810 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000811}
812
Victor Stinner27ee0892011-03-04 12:57:09 +0000813PyObject *
814PyImport_AddModule(const char *name)
815{
816 PyObject *nameobj, *module;
817 nameobj = PyUnicode_FromString(name);
818 if (nameobj == NULL)
819 return NULL;
820 module = PyImport_AddModuleObject(nameobj);
821 Py_DECREF(nameobj);
822 return module;
823}
824
825
Tim Peters1cd70172004-08-02 03:52:12 +0000826/* Remove name from sys.modules, if it's there. */
827static void
Victor Stinner27ee0892011-03-04 12:57:09 +0000828remove_module(PyObject *name)
Tim Peters1cd70172004-08-02 03:52:12 +0000829{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000830 PyObject *modules = PyImport_GetModuleDict();
Eric Snow3f9eee62017-09-15 16:35:20 -0600831 if (PyMapping_DelItem(modules, name) < 0) {
832 if (!PyMapping_HasKey(modules, name)) {
833 return;
834 }
Miss Islington (bot)7beb8c52018-11-05 06:52:58 -0800835 Py_FatalError("import: deleting existing key in "
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000836 "sys.modules failed");
Eric Snow3f9eee62017-09-15 16:35:20 -0600837 }
Tim Peters1cd70172004-08-02 03:52:12 +0000838}
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000839
Christian Heimes3b06e532008-01-07 20:12:44 +0000840
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000841/* Execute a code object in a module and return the module object
Tim Peters1cd70172004-08-02 03:52:12 +0000842 * WITH INCREMENTED REFERENCE COUNT. If an error occurs, name is
843 * removed from sys.modules, to avoid leaving damaged module objects
844 * in sys.modules. The caller may wish to restore the original
845 * module object (if any) in this case; PyImport_ReloadModule is an
846 * example.
Barry Warsaw28a691b2010-04-17 00:19:56 +0000847 *
848 * Note that PyImport_ExecCodeModuleWithPathnames() is the preferred, richer
849 * interface. The other two exist primarily for backward compatibility.
Tim Peters1cd70172004-08-02 03:52:12 +0000850 */
Guido van Rossum79f25d91997-04-29 20:08:16 +0000851PyObject *
Serhiy Storchakac6792272013-10-19 21:03:34 +0300852PyImport_ExecCodeModule(const char *name, PyObject *co)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000853{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000854 return PyImport_ExecCodeModuleWithPathnames(
855 name, co, (char *)NULL, (char *)NULL);
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000856}
857
858PyObject *
Serhiy Storchakac6792272013-10-19 21:03:34 +0300859PyImport_ExecCodeModuleEx(const char *name, PyObject *co, const char *pathname)
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000860{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000861 return PyImport_ExecCodeModuleWithPathnames(
862 name, co, pathname, (char *)NULL);
Barry Warsaw28a691b2010-04-17 00:19:56 +0000863}
864
865PyObject *
Serhiy Storchakac6792272013-10-19 21:03:34 +0300866PyImport_ExecCodeModuleWithPathnames(const char *name, PyObject *co,
867 const char *pathname,
868 const char *cpathname)
Barry Warsaw28a691b2010-04-17 00:19:56 +0000869{
Victor Stinner27ee0892011-03-04 12:57:09 +0000870 PyObject *m = NULL;
Eric Snow32439d62015-05-02 19:15:18 -0600871 PyObject *nameobj, *pathobj = NULL, *cpathobj = NULL, *external= NULL;
Victor Stinner27ee0892011-03-04 12:57:09 +0000872
873 nameobj = PyUnicode_FromString(name);
874 if (nameobj == NULL)
875 return NULL;
876
Victor Stinner27ee0892011-03-04 12:57:09 +0000877 if (cpathname != NULL) {
878 cpathobj = PyUnicode_DecodeFSDefault(cpathname);
879 if (cpathobj == NULL)
880 goto error;
Brett Cannona6473f92012-07-13 13:57:03 -0400881 }
882 else
Victor Stinner27ee0892011-03-04 12:57:09 +0000883 cpathobj = NULL;
Brett Cannona6473f92012-07-13 13:57:03 -0400884
885 if (pathname != NULL) {
886 pathobj = PyUnicode_DecodeFSDefault(pathname);
887 if (pathobj == NULL)
888 goto error;
889 }
890 else if (cpathobj != NULL) {
891 PyInterpreterState *interp = PyThreadState_GET()->interp;
892 _Py_IDENTIFIER(_get_sourcefile);
893
894 if (interp == NULL) {
895 Py_FatalError("PyImport_ExecCodeModuleWithPathnames: "
896 "no interpreter!");
897 }
898
Eric Snow32439d62015-05-02 19:15:18 -0600899 external= PyObject_GetAttrString(interp->importlib,
900 "_bootstrap_external");
901 if (external != NULL) {
902 pathobj = _PyObject_CallMethodIdObjArgs(external,
903 &PyId__get_sourcefile, cpathobj,
904 NULL);
905 Py_DECREF(external);
906 }
Brett Cannona6473f92012-07-13 13:57:03 -0400907 if (pathobj == NULL)
908 PyErr_Clear();
909 }
910 else
911 pathobj = NULL;
912
Victor Stinner27ee0892011-03-04 12:57:09 +0000913 m = PyImport_ExecCodeModuleObject(nameobj, co, pathobj, cpathobj);
914error:
915 Py_DECREF(nameobj);
916 Py_XDECREF(pathobj);
917 Py_XDECREF(cpathobj);
918 return m;
919}
920
Brett Cannon18fc4e72014-04-04 10:01:46 -0400921static PyObject *
922module_dict_for_exec(PyObject *name)
Victor Stinner27ee0892011-03-04 12:57:09 +0000923{
Brett Cannon18fc4e72014-04-04 10:01:46 -0400924 PyObject *m, *d = NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000925
Victor Stinner27ee0892011-03-04 12:57:09 +0000926 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000927 if (m == NULL)
928 return NULL;
929 /* If the module is being reloaded, we get the old module back
930 and re-use its dict to exec the new code. */
931 d = PyModule_GetDict(m);
932 if (PyDict_GetItemString(d, "__builtins__") == NULL) {
933 if (PyDict_SetItemString(d, "__builtins__",
Brett Cannon18fc4e72014-04-04 10:01:46 -0400934 PyEval_GetBuiltins()) != 0) {
935 remove_module(name);
936 return NULL;
937 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000938 }
Brett Cannon18fc4e72014-04-04 10:01:46 -0400939
Eric Snow08197a42014-05-12 17:54:55 -0600940 return d; /* Return a borrowed reference. */
Brett Cannon18fc4e72014-04-04 10:01:46 -0400941}
942
943static PyObject *
944exec_code_in_module(PyObject *name, PyObject *module_dict, PyObject *code_object)
945{
Brett Cannon18fc4e72014-04-04 10:01:46 -0400946 PyObject *v, *m;
947
948 v = PyEval_EvalCode(code_object, module_dict, module_dict);
949 if (v == NULL) {
950 remove_module(name);
951 return NULL;
952 }
953 Py_DECREF(v);
954
Eric Snow3f9eee62017-09-15 16:35:20 -0600955 m = PyImport_GetModule(name);
Miss Islington (bot)cdd8d4d2019-03-25 14:36:43 -0700956 if (m == NULL && !PyErr_Occurred()) {
Brett Cannon18fc4e72014-04-04 10:01:46 -0400957 PyErr_Format(PyExc_ImportError,
958 "Loaded module %R not found in sys.modules",
959 name);
Brett Cannon18fc4e72014-04-04 10:01:46 -0400960 }
961
Brett Cannon18fc4e72014-04-04 10:01:46 -0400962 return m;
963}
964
965PyObject*
966PyImport_ExecCodeModuleObject(PyObject *name, PyObject *co, PyObject *pathname,
967 PyObject *cpathname)
968{
Eric Snow32439d62015-05-02 19:15:18 -0600969 PyObject *d, *external, *res;
Eric Snow08197a42014-05-12 17:54:55 -0600970 PyInterpreterState *interp = PyThreadState_GET()->interp;
971 _Py_IDENTIFIER(_fix_up_module);
Brett Cannon18fc4e72014-04-04 10:01:46 -0400972
973 d = module_dict_for_exec(name);
974 if (d == NULL) {
975 return NULL;
976 }
977
Eric Snow08197a42014-05-12 17:54:55 -0600978 if (pathname == NULL) {
979 pathname = ((PyCodeObject *)co)->co_filename;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000980 }
Eric Snow32439d62015-05-02 19:15:18 -0600981 external = PyObject_GetAttrString(interp->importlib, "_bootstrap_external");
982 if (external == NULL)
983 return NULL;
984 res = _PyObject_CallMethodIdObjArgs(external,
Eric Snow08197a42014-05-12 17:54:55 -0600985 &PyId__fix_up_module,
986 d, name, pathname, cpathname, NULL);
Eric Snow32439d62015-05-02 19:15:18 -0600987 Py_DECREF(external);
Eric Snow08197a42014-05-12 17:54:55 -0600988 if (res != NULL) {
Eric Snow58cfdd82014-05-29 12:31:39 -0600989 Py_DECREF(res);
Eric Snow08197a42014-05-12 17:54:55 -0600990 res = exec_code_in_module(name, d, co);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000991 }
Eric Snow08197a42014-05-12 17:54:55 -0600992 return res;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000993}
994
995
Antoine Pitroud35cbf62009-01-06 19:02:24 +0000996static void
997update_code_filenames(PyCodeObject *co, PyObject *oldname, PyObject *newname)
998{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000999 PyObject *constants, *tmp;
1000 Py_ssize_t i, n;
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001001
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001002 if (PyUnicode_Compare(co->co_filename, oldname))
1003 return;
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001004
Serhiy Storchaka576f1322016-01-05 21:27:54 +02001005 Py_INCREF(newname);
Serhiy Storchakaec397562016-04-06 09:50:03 +03001006 Py_XSETREF(co->co_filename, newname);
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001007
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001008 constants = co->co_consts;
1009 n = PyTuple_GET_SIZE(constants);
1010 for (i = 0; i < n; i++) {
1011 tmp = PyTuple_GET_ITEM(constants, i);
1012 if (PyCode_Check(tmp))
1013 update_code_filenames((PyCodeObject *)tmp,
1014 oldname, newname);
1015 }
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001016}
1017
Victor Stinner2f42ae52011-03-20 00:41:24 +01001018static void
1019update_compiled_module(PyCodeObject *co, PyObject *newname)
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001020{
Victor Stinner2f42ae52011-03-20 00:41:24 +01001021 PyObject *oldname;
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001022
Victor Stinner2f42ae52011-03-20 00:41:24 +01001023 if (PyUnicode_Compare(co->co_filename, newname) == 0)
1024 return;
Hirokazu Yamamoto4f447fb2009-03-04 01:52:10 +00001025
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001026 oldname = co->co_filename;
1027 Py_INCREF(oldname);
1028 update_code_filenames(co, oldname, newname);
1029 Py_DECREF(oldname);
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001030}
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001031
Brett Cannon4caa61d2014-01-09 19:03:32 -05001032/*[clinic input]
1033_imp._fix_co_filename
1034
1035 code: object(type="PyCodeObject *", subclass_of="&PyCode_Type")
1036 Code object to change.
1037
1038 path: unicode
1039 File path to use.
1040 /
1041
1042Changes code.co_filename to specify the passed-in file path.
1043[clinic start generated code]*/
1044
Brett Cannon4caa61d2014-01-09 19:03:32 -05001045static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03001046_imp__fix_co_filename_impl(PyObject *module, PyCodeObject *code,
Larry Hastings89964c42015-04-14 18:07:59 -04001047 PyObject *path)
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03001048/*[clinic end generated code: output=1d002f100235587d input=895ba50e78b82f05]*/
Brett Cannon442c9b92011-03-23 16:14:42 -07001049
Brett Cannon4caa61d2014-01-09 19:03:32 -05001050{
Brett Cannona6dec2e2014-01-10 07:43:55 -05001051 update_compiled_module(code, path);
Brett Cannon442c9b92011-03-23 16:14:42 -07001052
1053 Py_RETURN_NONE;
1054}
1055
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001056
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001057/* Forward */
Benjamin Peterson6fba3db2013-03-18 23:13:31 -07001058static const struct _frozen * find_frozen(PyObject *);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001059
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001060
1061/* Helper to test for built-in module */
1062
1063static int
Victor Stinner95872862011-03-07 18:20:56 +01001064is_builtin(PyObject *name)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001065{
Serhiy Storchakaf4934ea2016-11-16 10:17:58 +02001066 int i;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001067 for (i = 0; PyImport_Inittab[i].name != NULL; i++) {
Serhiy Storchakaf4934ea2016-11-16 10:17:58 +02001068 if (_PyUnicode_EqualToASCIIString(name, PyImport_Inittab[i].name)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001069 if (PyImport_Inittab[i].initfunc == NULL)
1070 return -1;
1071 else
1072 return 1;
1073 }
1074 }
1075 return 0;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001076}
1077
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001078
Brett Cannonfdcdd9e2016-07-08 11:00:00 -07001079/* Return a finder object for a sys.path/pkg.__path__ item 'p',
Just van Rossum52e14d62002-12-30 22:08:05 +00001080 possibly by fetching it from the path_importer_cache dict. If it
Thomas Wouters89f507f2006-12-13 04:49:30 +00001081 wasn't yet cached, traverse path_hooks until a hook is found
Just van Rossum52e14d62002-12-30 22:08:05 +00001082 that can handle the path item. Return None if no hook could;
Brett Cannonfdcdd9e2016-07-08 11:00:00 -07001083 this tells our caller that the path based finder could not find
1084 a finder for this path item. Cache the result in
1085 path_importer_cache.
Just van Rossum52e14d62002-12-30 22:08:05 +00001086 Returns a borrowed reference. */
1087
1088static PyObject *
1089get_path_importer(PyObject *path_importer_cache, PyObject *path_hooks,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001090 PyObject *p)
Just van Rossum52e14d62002-12-30 22:08:05 +00001091{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001092 PyObject *importer;
1093 Py_ssize_t j, nhooks;
Just van Rossum52e14d62002-12-30 22:08:05 +00001094
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001095 /* These conditions are the caller's responsibility: */
1096 assert(PyList_Check(path_hooks));
1097 assert(PyDict_Check(path_importer_cache));
Just van Rossum52e14d62002-12-30 22:08:05 +00001098
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001099 nhooks = PyList_Size(path_hooks);
1100 if (nhooks < 0)
1101 return NULL; /* Shouldn't happen */
Just van Rossum52e14d62002-12-30 22:08:05 +00001102
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001103 importer = PyDict_GetItem(path_importer_cache, p);
1104 if (importer != NULL)
1105 return importer;
Just van Rossum52e14d62002-12-30 22:08:05 +00001106
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001107 /* set path_importer_cache[p] to None to avoid recursion */
1108 if (PyDict_SetItem(path_importer_cache, p, Py_None) != 0)
1109 return NULL;
Just van Rossum52e14d62002-12-30 22:08:05 +00001110
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001111 for (j = 0; j < nhooks; j++) {
1112 PyObject *hook = PyList_GetItem(path_hooks, j);
1113 if (hook == NULL)
1114 return NULL;
Victor Stinnerde4ae3d2016-12-04 22:59:09 +01001115 importer = PyObject_CallFunctionObjArgs(hook, p, NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001116 if (importer != NULL)
1117 break;
Just van Rossum52e14d62002-12-30 22:08:05 +00001118
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001119 if (!PyErr_ExceptionMatches(PyExc_ImportError)) {
1120 return NULL;
1121 }
1122 PyErr_Clear();
1123 }
1124 if (importer == NULL) {
Brett Cannonaa936422012-04-27 15:30:58 -04001125 return Py_None;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001126 }
1127 if (importer != NULL) {
1128 int err = PyDict_SetItem(path_importer_cache, p, importer);
1129 Py_DECREF(importer);
1130 if (err != 0)
1131 return NULL;
1132 }
1133 return importer;
Just van Rossum52e14d62002-12-30 22:08:05 +00001134}
1135
Christian Heimes9cd17752007-11-18 19:35:23 +00001136PyAPI_FUNC(PyObject *)
1137PyImport_GetImporter(PyObject *path) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001138 PyObject *importer=NULL, *path_importer_cache=NULL, *path_hooks=NULL;
Christian Heimes9cd17752007-11-18 19:35:23 +00001139
Victor Stinner1e53bba2013-07-16 22:26:05 +02001140 path_importer_cache = PySys_GetObject("path_importer_cache");
1141 path_hooks = PySys_GetObject("path_hooks");
1142 if (path_importer_cache != NULL && path_hooks != NULL) {
1143 importer = get_path_importer(path_importer_cache,
1144 path_hooks, path);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001145 }
1146 Py_XINCREF(importer); /* get_path_importer returns a borrowed reference */
1147 return importer;
Christian Heimes9cd17752007-11-18 19:35:23 +00001148}
1149
Nick Coghland5cacbb2015-05-23 22:24:10 +10001150/*[clinic input]
1151_imp.create_builtin
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001152
Nick Coghland5cacbb2015-05-23 22:24:10 +10001153 spec: object
1154 /
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001155
Nick Coghland5cacbb2015-05-23 22:24:10 +10001156Create an extension module.
1157[clinic start generated code]*/
Guido van Rossum7f133ed1991-02-19 12:23:57 +00001158
Nick Coghland5cacbb2015-05-23 22:24:10 +10001159static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03001160_imp_create_builtin(PyObject *module, PyObject *spec)
1161/*[clinic end generated code: output=ace7ff22271e6f39 input=37f966f890384e47]*/
Guido van Rossum7f133ed1991-02-19 12:23:57 +00001162{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001163 struct _inittab *p;
Nick Coghland5cacbb2015-05-23 22:24:10 +10001164 PyObject *name;
Serhiy Storchaka85b0f5b2016-11-20 10:16:47 +02001165 const char *namestr;
Victor Stinner5eb4f592013-11-14 22:38:52 +01001166 PyObject *mod;
Guido van Rossum25ce5661997-08-02 03:10:38 +00001167
Nick Coghland5cacbb2015-05-23 22:24:10 +10001168 name = PyObject_GetAttrString(spec, "name");
1169 if (name == NULL) {
1170 return NULL;
1171 }
1172
Victor Stinner5eb4f592013-11-14 22:38:52 +01001173 mod = _PyImport_FindExtensionObject(name, name);
Nick Coghland5cacbb2015-05-23 22:24:10 +10001174 if (mod || PyErr_Occurred()) {
1175 Py_DECREF(name);
Raymond Hettingerf0afe772016-08-31 08:44:11 -07001176 Py_XINCREF(mod);
Nick Coghland5cacbb2015-05-23 22:24:10 +10001177 return mod;
1178 }
1179
1180 namestr = PyUnicode_AsUTF8(name);
1181 if (namestr == NULL) {
1182 Py_DECREF(name);
1183 return NULL;
1184 }
Guido van Rossum25ce5661997-08-02 03:10:38 +00001185
Eric Snowd393c1b2017-09-14 12:18:12 -06001186 PyObject *modules = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001187 for (p = PyImport_Inittab; p->name != NULL; p++) {
Antoine Pitrou6c40eb72012-01-18 20:16:09 +01001188 PyModuleDef *def;
Serhiy Storchakaf4934ea2016-11-16 10:17:58 +02001189 if (_PyUnicode_EqualToASCIIString(name, p->name)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001190 if (p->initfunc == NULL) {
Nick Coghland5cacbb2015-05-23 22:24:10 +10001191 /* Cannot re-init internal module ("sys" or "builtins") */
1192 mod = PyImport_AddModule(namestr);
1193 Py_DECREF(name);
1194 return mod;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001195 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001196 mod = (*p->initfunc)();
Nick Coghland5cacbb2015-05-23 22:24:10 +10001197 if (mod == NULL) {
1198 Py_DECREF(name);
1199 return NULL;
1200 }
1201 if (PyObject_TypeCheck(mod, &PyModuleDef_Type)) {
1202 Py_DECREF(name);
1203 return PyModule_FromDefAndSpec((PyModuleDef*)mod, spec);
1204 } else {
1205 /* Remember pointer to module init function. */
1206 def = PyModule_GetDef(mod);
Christian Heimesa78b6272016-09-09 00:25:03 +02001207 if (def == NULL) {
1208 Py_DECREF(name);
1209 return NULL;
1210 }
Nick Coghland5cacbb2015-05-23 22:24:10 +10001211 def->m_base.m_init = p->initfunc;
Eric Snowd393c1b2017-09-14 12:18:12 -06001212 if (modules == NULL) {
1213 modules = PyImport_GetModuleDict();
1214 }
1215 if (_PyImport_FixupExtensionObject(mod, name, name,
1216 modules) < 0) {
Nick Coghland5cacbb2015-05-23 22:24:10 +10001217 Py_DECREF(name);
1218 return NULL;
1219 }
1220 Py_DECREF(name);
1221 return mod;
1222 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001223 }
1224 }
Nick Coghland5cacbb2015-05-23 22:24:10 +10001225 Py_DECREF(name);
1226 Py_RETURN_NONE;
Guido van Rossum7f133ed1991-02-19 12:23:57 +00001227}
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001228
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001229
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001230/* Frozen modules */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001231
Benjamin Peterson6fba3db2013-03-18 23:13:31 -07001232static const struct _frozen *
Victor Stinner53dc7352011-03-20 01:50:21 +01001233find_frozen(PyObject *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001234{
Benjamin Peterson6fba3db2013-03-18 23:13:31 -07001235 const struct _frozen *p;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001236
Victor Stinner53dc7352011-03-20 01:50:21 +01001237 if (name == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001238 return NULL;
Benjamin Petersond968e272008-11-05 22:48:33 +00001239
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001240 for (p = PyImport_FrozenModules; ; p++) {
1241 if (p->name == NULL)
1242 return NULL;
Serhiy Storchakaf4934ea2016-11-16 10:17:58 +02001243 if (_PyUnicode_EqualToASCIIString(name, p->name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001244 break;
1245 }
1246 return p;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001247}
1248
Guido van Rossum79f25d91997-04-29 20:08:16 +00001249static PyObject *
Victor Stinner53dc7352011-03-20 01:50:21 +01001250get_frozen_object(PyObject *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001251{
Benjamin Peterson6fba3db2013-03-18 23:13:31 -07001252 const struct _frozen *p = find_frozen(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001253 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001254
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001255 if (p == NULL) {
1256 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01001257 "No such frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001258 name);
1259 return NULL;
1260 }
1261 if (p->code == NULL) {
1262 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01001263 "Excluded frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001264 name);
1265 return NULL;
1266 }
1267 size = p->size;
1268 if (size < 0)
1269 size = -size;
Serhiy Storchakac6792272013-10-19 21:03:34 +03001270 return PyMarshal_ReadObjectFromString((const char *)p->code, size);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001271}
1272
Brett Cannon8d110132009-03-15 02:20:16 +00001273static PyObject *
Victor Stinner53dc7352011-03-20 01:50:21 +01001274is_frozen_package(PyObject *name)
Brett Cannon8d110132009-03-15 02:20:16 +00001275{
Benjamin Peterson6fba3db2013-03-18 23:13:31 -07001276 const struct _frozen *p = find_frozen(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001277 int size;
Brett Cannon8d110132009-03-15 02:20:16 +00001278
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001279 if (p == NULL) {
1280 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01001281 "No such frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001282 name);
1283 return NULL;
1284 }
Brett Cannon8d110132009-03-15 02:20:16 +00001285
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001286 size = p->size;
Brett Cannon8d110132009-03-15 02:20:16 +00001287
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001288 if (size < 0)
1289 Py_RETURN_TRUE;
1290 else
1291 Py_RETURN_FALSE;
Brett Cannon8d110132009-03-15 02:20:16 +00001292}
1293
1294
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001295/* Initialize a frozen module.
Brett Cannon3c2ac442009-03-08 20:49:47 +00001296 Return 1 for success, 0 if the module is not found, and -1 with
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001297 an exception set if the initialization failed.
1298 This function is also used from frozenmain.c */
Guido van Rossum0b344901995-02-07 15:35:27 +00001299
1300int
Victor Stinner53dc7352011-03-20 01:50:21 +01001301PyImport_ImportFrozenModuleObject(PyObject *name)
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001302{
Benjamin Peterson6fba3db2013-03-18 23:13:31 -07001303 const struct _frozen *p;
Brett Cannon18fc4e72014-04-04 10:01:46 -04001304 PyObject *co, *m, *d;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001305 int ispackage;
1306 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001307
Victor Stinner53dc7352011-03-20 01:50:21 +01001308 p = find_frozen(name);
1309
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001310 if (p == NULL)
1311 return 0;
1312 if (p->code == NULL) {
1313 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01001314 "Excluded frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001315 name);
1316 return -1;
1317 }
1318 size = p->size;
1319 ispackage = (size < 0);
1320 if (ispackage)
1321 size = -size;
Serhiy Storchakac6792272013-10-19 21:03:34 +03001322 co = PyMarshal_ReadObjectFromString((const char *)p->code, size);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001323 if (co == NULL)
1324 return -1;
1325 if (!PyCode_Check(co)) {
1326 PyErr_Format(PyExc_TypeError,
Victor Stinner53dc7352011-03-20 01:50:21 +01001327 "frozen object %R is not a code object",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001328 name);
1329 goto err_return;
1330 }
1331 if (ispackage) {
Brett Cannon3e0651b2013-05-31 23:18:39 -04001332 /* Set __path__ to the empty list */
Brett Cannon18fc4e72014-04-04 10:01:46 -04001333 PyObject *l;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001334 int err;
Victor Stinner53dc7352011-03-20 01:50:21 +01001335 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001336 if (m == NULL)
1337 goto err_return;
1338 d = PyModule_GetDict(m);
Brett Cannon3e0651b2013-05-31 23:18:39 -04001339 l = PyList_New(0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001340 if (l == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001341 goto err_return;
1342 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001343 err = PyDict_SetItemString(d, "__path__", l);
1344 Py_DECREF(l);
1345 if (err != 0)
1346 goto err_return;
1347 }
Brett Cannon18fc4e72014-04-04 10:01:46 -04001348 d = module_dict_for_exec(name);
1349 if (d == NULL) {
Victor Stinner53dc7352011-03-20 01:50:21 +01001350 goto err_return;
Brett Cannon18fc4e72014-04-04 10:01:46 -04001351 }
1352 m = exec_code_in_module(name, d, co);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001353 if (m == NULL)
1354 goto err_return;
1355 Py_DECREF(co);
1356 Py_DECREF(m);
1357 return 1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001358err_return:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001359 Py_DECREF(co);
1360 return -1;
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001361}
Guido van Rossum74e6a111994-08-29 12:54:38 +00001362
Victor Stinner53dc7352011-03-20 01:50:21 +01001363int
Serhiy Storchakac6792272013-10-19 21:03:34 +03001364PyImport_ImportFrozenModule(const char *name)
Victor Stinner53dc7352011-03-20 01:50:21 +01001365{
1366 PyObject *nameobj;
1367 int ret;
1368 nameobj = PyUnicode_InternFromString(name);
1369 if (nameobj == NULL)
1370 return -1;
1371 ret = PyImport_ImportFrozenModuleObject(nameobj);
1372 Py_DECREF(nameobj);
1373 return ret;
1374}
1375
Guido van Rossum74e6a111994-08-29 12:54:38 +00001376
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001377/* Import a module, either built-in, frozen, or external, and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001378 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum74e6a111994-08-29 12:54:38 +00001379
Guido van Rossum79f25d91997-04-29 20:08:16 +00001380PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001381PyImport_ImportModule(const char *name)
Guido van Rossum74e6a111994-08-29 12:54:38 +00001382{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001383 PyObject *pname;
1384 PyObject *result;
Marc-André Lemburg3c61c352001-02-09 19:40:15 +00001385
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001386 pname = PyUnicode_FromString(name);
1387 if (pname == NULL)
1388 return NULL;
1389 result = PyImport_Import(pname);
1390 Py_DECREF(pname);
1391 return result;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001392}
1393
Christian Heimes072c0f12008-01-03 23:01:04 +00001394/* Import a module without blocking
1395 *
1396 * At first it tries to fetch the module from sys.modules. If the module was
1397 * never loaded before it loads it with PyImport_ImportModule() unless another
1398 * thread holds the import lock. In the latter case the function raises an
1399 * ImportError instead of blocking.
1400 *
1401 * Returns the module object with incremented ref count.
1402 */
1403PyObject *
1404PyImport_ImportModuleNoBlock(const char *name)
1405{
Antoine Pitrouea3eb882012-05-17 18:55:59 +02001406 return PyImport_ImportModule(name);
Christian Heimes072c0f12008-01-03 23:01:04 +00001407}
1408
Guido van Rossum17fc85f1997-09-06 18:52:03 +00001409
Antoine Pitroubc07a5c2012-07-08 12:01:27 +02001410/* Remove importlib frames from the traceback,
1411 * except in Verbose mode. */
1412static void
1413remove_importlib_frames(void)
1414{
1415 const char *importlib_filename = "<frozen importlib._bootstrap>";
Eric Snow32439d62015-05-02 19:15:18 -06001416 const char *external_filename = "<frozen importlib._bootstrap_external>";
Nick Coghlan42c07662012-07-31 21:14:18 +10001417 const char *remove_frames = "_call_with_frames_removed";
Antoine Pitroubc07a5c2012-07-08 12:01:27 +02001418 int always_trim = 0;
Benjamin Petersonfa873702012-07-09 13:43:53 -07001419 int in_importlib = 0;
Antoine Pitroubc07a5c2012-07-08 12:01:27 +02001420 PyObject *exception, *value, *base_tb, *tb;
Benjamin Petersonfa873702012-07-09 13:43:53 -07001421 PyObject **prev_link, **outer_link = NULL;
Antoine Pitroubc07a5c2012-07-08 12:01:27 +02001422
1423 /* Synopsis: if it's an ImportError, we trim all importlib chunks
Nick Coghlan42c07662012-07-31 21:14:18 +10001424 from the traceback. We always trim chunks
1425 which end with a call to "_call_with_frames_removed". */
Antoine Pitroubc07a5c2012-07-08 12:01:27 +02001426
1427 PyErr_Fetch(&exception, &value, &base_tb);
1428 if (!exception || Py_VerboseFlag)
1429 goto done;
1430 if (PyType_IsSubtype((PyTypeObject *) exception,
1431 (PyTypeObject *) PyExc_ImportError))
1432 always_trim = 1;
1433
1434 prev_link = &base_tb;
1435 tb = base_tb;
Antoine Pitroubc07a5c2012-07-08 12:01:27 +02001436 while (tb != NULL) {
1437 PyTracebackObject *traceback = (PyTracebackObject *)tb;
1438 PyObject *next = (PyObject *) traceback->tb_next;
1439 PyFrameObject *frame = traceback->tb_frame;
1440 PyCodeObject *code = frame->f_code;
1441 int now_in_importlib;
1442
1443 assert(PyTraceBack_Check(tb));
Serhiy Storchakaf4934ea2016-11-16 10:17:58 +02001444 now_in_importlib = _PyUnicode_EqualToASCIIString(code->co_filename, importlib_filename) ||
1445 _PyUnicode_EqualToASCIIString(code->co_filename, external_filename);
Antoine Pitroubc07a5c2012-07-08 12:01:27 +02001446 if (now_in_importlib && !in_importlib) {
1447 /* This is the link to this chunk of importlib tracebacks */
1448 outer_link = prev_link;
1449 }
1450 in_importlib = now_in_importlib;
1451
1452 if (in_importlib &&
1453 (always_trim ||
Serhiy Storchakaf4934ea2016-11-16 10:17:58 +02001454 _PyUnicode_EqualToASCIIString(code->co_name, remove_frames))) {
Antoine Pitroubc07a5c2012-07-08 12:01:27 +02001455 Py_XINCREF(next);
Serhiy Storchakaec397562016-04-06 09:50:03 +03001456 Py_XSETREF(*outer_link, next);
Antoine Pitroubc07a5c2012-07-08 12:01:27 +02001457 prev_link = outer_link;
1458 }
1459 else {
1460 prev_link = (PyObject **) &traceback->tb_next;
1461 }
1462 tb = next;
1463 }
1464done:
1465 PyErr_Restore(exception, value, base_tb);
1466}
1467
1468
Serhiy Storchaka133138a2016-08-02 22:51:21 +03001469static PyObject *
1470resolve_name(PyObject *name, PyObject *globals, int level)
Thomas Woutersf7f438b2006-02-28 16:09:29 +00001471{
Eric Snowb523f842013-11-22 09:05:39 -07001472 _Py_IDENTIFIER(__spec__);
Brett Cannonfd074152012-04-14 14:10:13 -04001473 _Py_IDENTIFIER(__package__);
1474 _Py_IDENTIFIER(__path__);
1475 _Py_IDENTIFIER(__name__);
Serhiy Storchaka133138a2016-08-02 22:51:21 +03001476 _Py_IDENTIFIER(parent);
1477 PyObject *abs_name;
1478 PyObject *package = NULL;
1479 PyObject *spec;
Serhiy Storchaka133138a2016-08-02 22:51:21 +03001480 Py_ssize_t last_dot;
1481 PyObject *base;
1482 int level_up;
1483
1484 if (globals == NULL) {
1485 PyErr_SetString(PyExc_KeyError, "'__name__' not in globals");
1486 goto error;
1487 }
1488 if (!PyDict_Check(globals)) {
1489 PyErr_SetString(PyExc_TypeError, "globals must be a dict");
1490 goto error;
1491 }
1492 package = _PyDict_GetItemId(globals, &PyId___package__);
1493 if (package == Py_None) {
1494 package = NULL;
1495 }
1496 spec = _PyDict_GetItemId(globals, &PyId___spec__);
1497
1498 if (package != NULL) {
1499 Py_INCREF(package);
1500 if (!PyUnicode_Check(package)) {
1501 PyErr_SetString(PyExc_TypeError, "package must be a string");
1502 goto error;
1503 }
1504 else if (spec != NULL && spec != Py_None) {
1505 int equal;
1506 PyObject *parent = _PyObject_GetAttrId(spec, &PyId_parent);
1507 if (parent == NULL) {
1508 goto error;
1509 }
1510
1511 equal = PyObject_RichCompareBool(package, parent, Py_EQ);
1512 Py_DECREF(parent);
1513 if (equal < 0) {
1514 goto error;
1515 }
1516 else if (equal == 0) {
1517 if (PyErr_WarnEx(PyExc_ImportWarning,
1518 "__package__ != __spec__.parent", 1) < 0) {
1519 goto error;
1520 }
1521 }
1522 }
1523 }
1524 else if (spec != NULL && spec != Py_None) {
1525 package = _PyObject_GetAttrId(spec, &PyId_parent);
1526 if (package == NULL) {
1527 goto error;
1528 }
1529 else if (!PyUnicode_Check(package)) {
1530 PyErr_SetString(PyExc_TypeError,
1531 "__spec__.parent must be a string");
1532 goto error;
1533 }
1534 }
1535 else {
1536 if (PyErr_WarnEx(PyExc_ImportWarning,
1537 "can't resolve package from __spec__ or __package__, "
1538 "falling back on __name__ and __path__", 1) < 0) {
1539 goto error;
1540 }
1541
1542 package = _PyDict_GetItemId(globals, &PyId___name__);
1543 if (package == NULL) {
1544 PyErr_SetString(PyExc_KeyError, "'__name__' not in globals");
1545 goto error;
1546 }
1547
1548 Py_INCREF(package);
1549 if (!PyUnicode_Check(package)) {
1550 PyErr_SetString(PyExc_TypeError, "__name__ must be a string");
1551 goto error;
1552 }
1553
1554 if (_PyDict_GetItemId(globals, &PyId___path__) == NULL) {
1555 Py_ssize_t dot;
1556
1557 if (PyUnicode_READY(package) < 0) {
1558 goto error;
1559 }
1560
1561 dot = PyUnicode_FindChar(package, '.',
1562 0, PyUnicode_GET_LENGTH(package), -1);
1563 if (dot == -2) {
1564 goto error;
1565 }
1566
1567 if (dot >= 0) {
1568 PyObject *substr = PyUnicode_Substring(package, 0, dot);
1569 if (substr == NULL) {
1570 goto error;
1571 }
1572 Py_SETREF(package, substr);
1573 }
1574 }
1575 }
1576
1577 last_dot = PyUnicode_GET_LENGTH(package);
1578 if (last_dot == 0) {
1579 PyErr_SetString(PyExc_ImportError,
1580 "attempted relative import with no known parent package");
1581 goto error;
1582 }
Serhiy Storchaka133138a2016-08-02 22:51:21 +03001583
1584 for (level_up = 1; level_up < level; level_up += 1) {
1585 last_dot = PyUnicode_FindChar(package, '.', 0, last_dot, -1);
1586 if (last_dot == -2) {
1587 goto error;
1588 }
1589 else if (last_dot == -1) {
1590 PyErr_SetString(PyExc_ValueError,
1591 "attempted relative import beyond top-level "
1592 "package");
1593 goto error;
1594 }
1595 }
1596
1597 base = PyUnicode_Substring(package, 0, last_dot);
1598 Py_DECREF(package);
1599 if (base == NULL || PyUnicode_GET_LENGTH(name) == 0) {
1600 return base;
1601 }
1602
1603 abs_name = PyUnicode_FromFormat("%U.%U", base, name);
1604 Py_DECREF(base);
1605 return abs_name;
1606
1607 error:
1608 Py_XDECREF(package);
1609 return NULL;
1610}
1611
Neil Schemenauereea3cc12017-12-03 09:26:03 -08001612static PyObject *
1613import_find_and_load(PyObject *abs_name)
1614{
1615 _Py_IDENTIFIER(_find_and_load);
1616 PyObject *mod = NULL;
1617 PyInterpreterState *interp = PyThreadState_GET()->interp;
1618 int import_time = interp->core_config.import_time;
1619 static int import_level;
1620 static _PyTime_t accumulated;
1621
1622 _PyTime_t t1 = 0, accumulated_copy = accumulated;
1623
1624 /* XOptions is initialized after first some imports.
1625 * So we can't have negative cache before completed initialization.
1626 * Anyway, importlib._find_and_load is much slower than
1627 * _PyDict_GetItemIdWithError().
1628 */
1629 if (import_time) {
1630 static int header = 1;
1631 if (header) {
1632 fputs("import time: self [us] | cumulative | imported package\n",
1633 stderr);
1634 header = 0;
1635 }
1636
1637 import_level++;
1638 t1 = _PyTime_GetPerfCounter();
1639 accumulated = 0;
1640 }
1641
1642 if (PyDTrace_IMPORT_FIND_LOAD_START_ENABLED())
1643 PyDTrace_IMPORT_FIND_LOAD_START(PyUnicode_AsUTF8(abs_name));
1644
1645 mod = _PyObject_CallMethodIdObjArgs(interp->importlib,
1646 &PyId__find_and_load, abs_name,
1647 interp->import_func, NULL);
1648
1649 if (PyDTrace_IMPORT_FIND_LOAD_DONE_ENABLED())
1650 PyDTrace_IMPORT_FIND_LOAD_DONE(PyUnicode_AsUTF8(abs_name),
1651 mod != NULL);
1652
1653 if (import_time) {
1654 _PyTime_t cum = _PyTime_GetPerfCounter() - t1;
1655
1656 import_level--;
1657 fprintf(stderr, "import time: %9ld | %10ld | %*s%s\n",
1658 (long)_PyTime_AsMicroseconds(cum - accumulated, _PyTime_ROUND_CEILING),
1659 (long)_PyTime_AsMicroseconds(cum, _PyTime_ROUND_CEILING),
1660 import_level*2, "", PyUnicode_AsUTF8(abs_name));
1661
1662 accumulated = accumulated_copy + cum;
1663 }
1664
1665 return mod;
1666}
1667
Serhiy Storchaka133138a2016-08-02 22:51:21 +03001668PyObject *
1669PyImport_ImportModuleLevelObject(PyObject *name, PyObject *globals,
1670 PyObject *locals, PyObject *fromlist,
1671 int level)
1672{
Brett Cannonfd074152012-04-14 14:10:13 -04001673 _Py_IDENTIFIER(_handle_fromlist);
Brett Cannonfd074152012-04-14 14:10:13 -04001674 PyObject *abs_name = NULL;
Brett Cannonfd074152012-04-14 14:10:13 -04001675 PyObject *final_mod = NULL;
1676 PyObject *mod = NULL;
1677 PyObject *package = NULL;
Brett Cannonfd074152012-04-14 14:10:13 -04001678 PyInterpreterState *interp = PyThreadState_GET()->interp;
Serhiy Storchakafa494fd2015-05-30 17:45:22 +03001679 int has_from;
Brett Cannonfd074152012-04-14 14:10:13 -04001680
Brett Cannonfd074152012-04-14 14:10:13 -04001681 if (name == NULL) {
1682 PyErr_SetString(PyExc_ValueError, "Empty module name");
1683 goto error;
1684 }
1685
1686 /* The below code is importlib.__import__() & _gcd_import(), ported to C
1687 for added performance. */
1688
1689 if (!PyUnicode_Check(name)) {
1690 PyErr_SetString(PyExc_TypeError, "module name must be a string");
1691 goto error;
1692 }
Serhiy Storchaka133138a2016-08-02 22:51:21 +03001693 if (PyUnicode_READY(name) < 0) {
Brett Cannonfd074152012-04-14 14:10:13 -04001694 goto error;
1695 }
1696 if (level < 0) {
1697 PyErr_SetString(PyExc_ValueError, "level must be >= 0");
1698 goto error;
1699 }
Brett Cannon849113a2016-01-22 15:25:50 -08001700
Serhiy Storchaka133138a2016-08-02 22:51:21 +03001701 if (level > 0) {
1702 abs_name = resolve_name(name, globals, level);
1703 if (abs_name == NULL)
Brett Cannon9fa81262016-01-22 16:39:02 -08001704 goto error;
Brett Cannonfd074152012-04-14 14:10:13 -04001705 }
1706 else { /* level == 0 */
1707 if (PyUnicode_GET_LENGTH(name) == 0) {
1708 PyErr_SetString(PyExc_ValueError, "Empty module name");
1709 goto error;
1710 }
Brett Cannonfd074152012-04-14 14:10:13 -04001711 abs_name = name;
1712 Py_INCREF(abs_name);
1713 }
1714
Eric Snow3f9eee62017-09-15 16:35:20 -06001715 mod = PyImport_GetModule(abs_name);
Miss Islington (bot)cdd8d4d2019-03-25 14:36:43 -07001716 if (mod == NULL && PyErr_Occurred()) {
1717 goto error;
1718 }
1719
Serhiy Storchakab4baace2017-07-06 08:09:03 +03001720 if (mod != NULL && mod != Py_None) {
Serhiy Storchaka133138a2016-08-02 22:51:21 +03001721 _Py_IDENTIFIER(__spec__);
1722 _Py_IDENTIFIER(_initializing);
1723 _Py_IDENTIFIER(_lock_unlock_module);
Eric Snowb523f842013-11-22 09:05:39 -07001724 PyObject *value = NULL;
1725 PyObject *spec;
Antoine Pitrouea3eb882012-05-17 18:55:59 +02001726 int initializing = 0;
1727
Antoine Pitrou03989852012-08-28 00:24:52 +02001728 /* Optimization: only call _bootstrap._lock_unlock_module() if
Eric Snowb523f842013-11-22 09:05:39 -07001729 __spec__._initializing is true.
1730 NOTE: because of this, initializing must be set *before*
Antoine Pitrou03989852012-08-28 00:24:52 +02001731 stuffing the new module in sys.modules.
1732 */
Eric Snowb523f842013-11-22 09:05:39 -07001733 spec = _PyObject_GetAttrId(mod, &PyId___spec__);
1734 if (spec != NULL) {
1735 value = _PyObject_GetAttrId(spec, &PyId__initializing);
1736 Py_DECREF(spec);
1737 }
Antoine Pitrouea3eb882012-05-17 18:55:59 +02001738 if (value == NULL)
1739 PyErr_Clear();
1740 else {
1741 initializing = PyObject_IsTrue(value);
1742 Py_DECREF(value);
1743 if (initializing == -1)
1744 PyErr_Clear();
Serhiy Storchaka133138a2016-08-02 22:51:21 +03001745 if (initializing > 0) {
Serhiy Storchaka133138a2016-08-02 22:51:21 +03001746 value = _PyObject_CallMethodIdObjArgs(interp->importlib,
1747 &PyId__lock_unlock_module, abs_name,
1748 NULL);
1749 if (value == NULL)
1750 goto error;
1751 Py_DECREF(value);
1752 }
Antoine Pitrouea3eb882012-05-17 18:55:59 +02001753 }
Brett Cannonfd074152012-04-14 14:10:13 -04001754 }
1755 else {
Neil Schemenauer11cc2892017-12-07 16:24:59 -08001756 Py_XDECREF(mod);
Neil Schemenauereea3cc12017-12-03 09:26:03 -08001757 mod = import_find_and_load(abs_name);
Brett Cannonfd074152012-04-14 14:10:13 -04001758 if (mod == NULL) {
Antoine Pitrouea3eb882012-05-17 18:55:59 +02001759 goto error;
Brett Cannonfd074152012-04-14 14:10:13 -04001760 }
1761 }
1762
Serhiy Storchaka133138a2016-08-02 22:51:21 +03001763 has_from = 0;
1764 if (fromlist != NULL && fromlist != Py_None) {
1765 has_from = PyObject_IsTrue(fromlist);
1766 if (has_from < 0)
1767 goto error;
1768 }
Serhiy Storchakafa494fd2015-05-30 17:45:22 +03001769 if (!has_from) {
Victor Stinner744c34e2016-05-20 11:36:13 +02001770 Py_ssize_t len = PyUnicode_GET_LENGTH(name);
1771 if (level == 0 || len > 0) {
1772 Py_ssize_t dot;
Brett Cannonfd074152012-04-14 14:10:13 -04001773
Victor Stinner744c34e2016-05-20 11:36:13 +02001774 dot = PyUnicode_FindChar(name, '.', 0, len, 1);
1775 if (dot == -2) {
Antoine Pitrouea3eb882012-05-17 18:55:59 +02001776 goto error;
Brett Cannonfd074152012-04-14 14:10:13 -04001777 }
1778
Victor Stinner744c34e2016-05-20 11:36:13 +02001779 if (dot == -1) {
Antoine Pitrou6efa50a2012-05-07 21:41:59 +02001780 /* No dot in module name, simple exit */
Antoine Pitrou6efa50a2012-05-07 21:41:59 +02001781 final_mod = mod;
1782 Py_INCREF(mod);
Antoine Pitrouea3eb882012-05-17 18:55:59 +02001783 goto error;
Antoine Pitrou6efa50a2012-05-07 21:41:59 +02001784 }
1785
Brett Cannonfd074152012-04-14 14:10:13 -04001786 if (level == 0) {
Victor Stinner744c34e2016-05-20 11:36:13 +02001787 PyObject *front = PyUnicode_Substring(name, 0, dot);
1788 if (front == NULL) {
1789 goto error;
1790 }
1791
Serhiy Storchaka133138a2016-08-02 22:51:21 +03001792 final_mod = PyImport_ImportModuleLevelObject(front, NULL, NULL, NULL, 0);
Antoine Pitroub78174c2012-05-06 17:15:23 +02001793 Py_DECREF(front);
Brett Cannonfd074152012-04-14 14:10:13 -04001794 }
1795 else {
Victor Stinner744c34e2016-05-20 11:36:13 +02001796 Py_ssize_t cut_off = len - dot;
Antoine Pitrou22a1d172012-04-16 22:06:21 +02001797 Py_ssize_t abs_name_len = PyUnicode_GET_LENGTH(abs_name);
Brett Cannon49f8d8b2012-04-14 21:50:00 -04001798 PyObject *to_return = PyUnicode_Substring(abs_name, 0,
Brett Cannonfd074152012-04-14 14:10:13 -04001799 abs_name_len - cut_off);
Antoine Pitrou22a1d172012-04-16 22:06:21 +02001800 if (to_return == NULL) {
Antoine Pitrouea3eb882012-05-17 18:55:59 +02001801 goto error;
Antoine Pitrou22a1d172012-04-16 22:06:21 +02001802 }
Brett Cannonfd074152012-04-14 14:10:13 -04001803
Eric Snow3f9eee62017-09-15 16:35:20 -06001804 final_mod = PyImport_GetModule(to_return);
Serhiy Storchaka133138a2016-08-02 22:51:21 +03001805 Py_DECREF(to_return);
Brett Cannon49f8d8b2012-04-14 21:50:00 -04001806 if (final_mod == NULL) {
Miss Islington (bot)cdd8d4d2019-03-25 14:36:43 -07001807 if (!PyErr_Occurred()) {
1808 PyErr_Format(PyExc_KeyError,
1809 "%R not in sys.modules as expected",
1810 to_return);
1811 }
Serhiy Storchaka133138a2016-08-02 22:51:21 +03001812 goto error;
Brett Cannon49f8d8b2012-04-14 21:50:00 -04001813 }
Brett Cannonfd074152012-04-14 14:10:13 -04001814 }
1815 }
1816 else {
1817 final_mod = mod;
1818 Py_INCREF(mod);
1819 }
1820 }
1821 else {
Alexandre Vassalotti865eaa12013-05-02 10:44:04 -07001822 final_mod = _PyObject_CallMethodIdObjArgs(interp->importlib,
Brett Cannonfd074152012-04-14 14:10:13 -04001823 &PyId__handle_fromlist, mod,
Serhiy Storchaka133138a2016-08-02 22:51:21 +03001824 fromlist, interp->import_func,
Brett Cannonfd074152012-04-14 14:10:13 -04001825 NULL);
1826 }
Antoine Pitrou6efa50a2012-05-07 21:41:59 +02001827
Brett Cannonfd074152012-04-14 14:10:13 -04001828 error:
1829 Py_XDECREF(abs_name);
Brett Cannonfd074152012-04-14 14:10:13 -04001830 Py_XDECREF(mod);
1831 Py_XDECREF(package);
Antoine Pitroubc07a5c2012-07-08 12:01:27 +02001832 if (final_mod == NULL)
1833 remove_importlib_frames();
Brett Cannonfd074152012-04-14 14:10:13 -04001834 return final_mod;
Guido van Rossum75acc9c1998-03-03 22:26:50 +00001835}
1836
Victor Stinnerfe93faf2011-03-14 15:54:52 -04001837PyObject *
Benjamin Peterson04778a82011-05-25 09:29:00 -05001838PyImport_ImportModuleLevel(const char *name, PyObject *globals, PyObject *locals,
Victor Stinnerfe93faf2011-03-14 15:54:52 -04001839 PyObject *fromlist, int level)
1840{
1841 PyObject *nameobj, *mod;
1842 nameobj = PyUnicode_FromString(name);
1843 if (nameobj == NULL)
1844 return NULL;
1845 mod = PyImport_ImportModuleLevelObject(nameobj, globals, locals,
1846 fromlist, level);
1847 Py_DECREF(nameobj);
1848 return mod;
1849}
1850
1851
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001852/* Re-import a module of any kind and return its module object, WITH
1853 INCREMENTED REFERENCE COUNT */
1854
Guido van Rossum79f25d91997-04-29 20:08:16 +00001855PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001856PyImport_ReloadModule(PyObject *m)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001857{
Eric Snow3f9eee62017-09-15 16:35:20 -06001858 _Py_IDENTIFIER(imp);
Brett Cannon62228db2012-04-29 14:38:11 -04001859 _Py_IDENTIFIER(reload);
1860 PyObject *reloaded_module = NULL;
Eric Snow3f9eee62017-09-15 16:35:20 -06001861 PyObject *imp = _PyImport_GetModuleId(&PyId_imp);
Brett Cannon62228db2012-04-29 14:38:11 -04001862 if (imp == NULL) {
Miss Islington (bot)cdd8d4d2019-03-25 14:36:43 -07001863 if (PyErr_Occurred()) {
1864 return NULL;
1865 }
1866
Brett Cannon62228db2012-04-29 14:38:11 -04001867 imp = PyImport_ImportModule("imp");
1868 if (imp == NULL) {
1869 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001870 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001871 }
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001872
Victor Stinner55ba38a2016-12-09 16:09:30 +01001873 reloaded_module = _PyObject_CallMethodIdObjArgs(imp, &PyId_reload, m, NULL);
Brett Cannon62228db2012-04-29 14:38:11 -04001874 Py_DECREF(imp);
1875 return reloaded_module;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001876}
1877
1878
Guido van Rossumd47a0a81997-08-14 20:11:26 +00001879/* Higher-level import emulator which emulates the "import" statement
1880 more accurately -- it invokes the __import__() function from the
1881 builtins of the current globals. This means that the import is
1882 done using whatever import hooks are installed in the current
Brett Cannonbc2eff32010-09-19 21:39:02 +00001883 environment.
Guido van Rossum6058eb41998-12-21 19:51:00 +00001884 A dummy list ["__doc__"] is passed as the 4th argument so that
Neal Norwitz80e7f272007-08-26 06:45:23 +00001885 e.g. PyImport_Import(PyUnicode_FromString("win32com.client.gencache"))
Guido van Rossum6058eb41998-12-21 19:51:00 +00001886 will return <module "gencache"> instead of <module "win32com">. */
Guido van Rossumd47a0a81997-08-14 20:11:26 +00001887
1888PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001889PyImport_Import(PyObject *module_name)
Guido van Rossumd47a0a81997-08-14 20:11:26 +00001890{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001891 static PyObject *silly_list = NULL;
1892 static PyObject *builtins_str = NULL;
1893 static PyObject *import_str = NULL;
1894 PyObject *globals = NULL;
1895 PyObject *import = NULL;
1896 PyObject *builtins = NULL;
1897 PyObject *r = NULL;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00001898
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001899 /* Initialize constant string objects */
1900 if (silly_list == NULL) {
1901 import_str = PyUnicode_InternFromString("__import__");
1902 if (import_str == NULL)
1903 return NULL;
1904 builtins_str = PyUnicode_InternFromString("__builtins__");
1905 if (builtins_str == NULL)
1906 return NULL;
Brett Cannonbc2eff32010-09-19 21:39:02 +00001907 silly_list = PyList_New(0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001908 if (silly_list == NULL)
1909 return NULL;
1910 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00001911
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001912 /* Get the builtins from current globals */
1913 globals = PyEval_GetGlobals();
1914 if (globals != NULL) {
1915 Py_INCREF(globals);
1916 builtins = PyObject_GetItem(globals, builtins_str);
1917 if (builtins == NULL)
1918 goto err;
1919 }
1920 else {
1921 /* No globals -- use standard builtins, and fake globals */
1922 builtins = PyImport_ImportModuleLevel("builtins",
1923 NULL, NULL, NULL, 0);
1924 if (builtins == NULL)
1925 return NULL;
1926 globals = Py_BuildValue("{OO}", builtins_str, builtins);
1927 if (globals == NULL)
1928 goto err;
1929 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00001930
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001931 /* Get the __import__ function from the builtins */
1932 if (PyDict_Check(builtins)) {
1933 import = PyObject_GetItem(builtins, import_str);
1934 if (import == NULL)
1935 PyErr_SetObject(PyExc_KeyError, import_str);
1936 }
1937 else
1938 import = PyObject_GetAttr(builtins, import_str);
1939 if (import == NULL)
1940 goto err;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00001941
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001942 /* Call the __import__ function with the proper argument list
Brett Cannonbc2eff32010-09-19 21:39:02 +00001943 Always use absolute import here.
1944 Calling for side-effect of import. */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001945 r = PyObject_CallFunction(import, "OOOOi", module_name, globals,
1946 globals, silly_list, 0, NULL);
Brett Cannonbc2eff32010-09-19 21:39:02 +00001947 if (r == NULL)
1948 goto err;
1949 Py_DECREF(r);
1950
Eric Snow3f9eee62017-09-15 16:35:20 -06001951 r = PyImport_GetModule(module_name);
1952 if (r == NULL && !PyErr_Occurred()) {
Serhiy Storchaka145541c2017-06-15 20:54:38 +03001953 PyErr_SetObject(PyExc_KeyError, module_name);
1954 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00001955
1956 err:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001957 Py_XDECREF(globals);
1958 Py_XDECREF(builtins);
1959 Py_XDECREF(import);
Tim Peters50d8d372001-02-28 05:34:27 +00001960
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001961 return r;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00001962}
1963
Brett Cannon4caa61d2014-01-09 19:03:32 -05001964/*[clinic input]
1965_imp.extension_suffixes
1966
1967Returns the list of file suffixes used to identify extension modules.
1968[clinic start generated code]*/
1969
Brett Cannon4caa61d2014-01-09 19:03:32 -05001970static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03001971_imp_extension_suffixes_impl(PyObject *module)
1972/*[clinic end generated code: output=0bf346e25a8f0cd3 input=ecdeeecfcb6f839e]*/
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001973{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001974 PyObject *list;
Brett Cannon2657df42012-05-04 15:20:40 -04001975 const char *suffix;
1976 unsigned int index = 0;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001977
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001978 list = PyList_New(0);
1979 if (list == NULL)
1980 return NULL;
Brett Cannon2657df42012-05-04 15:20:40 -04001981#ifdef HAVE_DYNAMIC_LOADING
1982 while ((suffix = _PyImport_DynLoadFiletab[index])) {
1983 PyObject *item = PyUnicode_FromString(suffix);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001984 if (item == NULL) {
1985 Py_DECREF(list);
1986 return NULL;
1987 }
1988 if (PyList_Append(list, item) < 0) {
1989 Py_DECREF(list);
1990 Py_DECREF(item);
1991 return NULL;
1992 }
1993 Py_DECREF(item);
Brett Cannon2657df42012-05-04 15:20:40 -04001994 index += 1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001995 }
Brett Cannon2657df42012-05-04 15:20:40 -04001996#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001997 return list;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001998}
1999
Brett Cannon4caa61d2014-01-09 19:03:32 -05002000/*[clinic input]
Brett Cannon4caa61d2014-01-09 19:03:32 -05002001_imp.init_frozen
2002
2003 name: unicode
2004 /
2005
2006Initializes a frozen module.
2007[clinic start generated code]*/
2008
Brett Cannon4caa61d2014-01-09 19:03:32 -05002009static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03002010_imp_init_frozen_impl(PyObject *module, PyObject *name)
2011/*[clinic end generated code: output=fc0511ed869fd69c input=13019adfc04f3fb3]*/
Brett Cannon4caa61d2014-01-09 19:03:32 -05002012{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002013 int ret;
2014 PyObject *m;
Brett Cannon4caa61d2014-01-09 19:03:32 -05002015
Victor Stinner53dc7352011-03-20 01:50:21 +01002016 ret = PyImport_ImportFrozenModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002017 if (ret < 0)
2018 return NULL;
2019 if (ret == 0) {
Serhiy Storchaka228b12e2017-01-23 09:47:21 +02002020 Py_RETURN_NONE;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002021 }
Victor Stinner53dc7352011-03-20 01:50:21 +01002022 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002023 Py_XINCREF(m);
2024 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002025}
2026
Brett Cannon4caa61d2014-01-09 19:03:32 -05002027/*[clinic input]
2028_imp.get_frozen_object
2029
2030 name: unicode
2031 /
2032
2033Create a code object for a frozen module.
2034[clinic start generated code]*/
2035
Brett Cannon4caa61d2014-01-09 19:03:32 -05002036static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03002037_imp_get_frozen_object_impl(PyObject *module, PyObject *name)
2038/*[clinic end generated code: output=2568cc5b7aa0da63 input=ed689bc05358fdbd]*/
Brett Cannon4caa61d2014-01-09 19:03:32 -05002039{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002040 return get_frozen_object(name);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002041}
2042
Brett Cannon4caa61d2014-01-09 19:03:32 -05002043/*[clinic input]
2044_imp.is_frozen_package
2045
2046 name: unicode
2047 /
2048
2049Returns True if the module name is of a frozen package.
2050[clinic start generated code]*/
2051
Brett Cannon4caa61d2014-01-09 19:03:32 -05002052static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03002053_imp_is_frozen_package_impl(PyObject *module, PyObject *name)
2054/*[clinic end generated code: output=e70cbdb45784a1c9 input=81b6cdecd080fbb8]*/
Brett Cannon4caa61d2014-01-09 19:03:32 -05002055{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002056 return is_frozen_package(name);
Brett Cannon8d110132009-03-15 02:20:16 +00002057}
2058
Brett Cannon4caa61d2014-01-09 19:03:32 -05002059/*[clinic input]
2060_imp.is_builtin
2061
2062 name: unicode
2063 /
2064
2065Returns True if the module name corresponds to a built-in module.
2066[clinic start generated code]*/
2067
Guido van Rossum79f25d91997-04-29 20:08:16 +00002068static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03002069_imp_is_builtin_impl(PyObject *module, PyObject *name)
2070/*[clinic end generated code: output=3bfd1162e2d3be82 input=86befdac021dd1c7]*/
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002071{
Brett Cannon4caa61d2014-01-09 19:03:32 -05002072 return PyLong_FromLong(is_builtin(name));
2073}
2074
2075/*[clinic input]
2076_imp.is_frozen
2077
2078 name: unicode
2079 /
2080
2081Returns True if the module name corresponds to a frozen module.
2082[clinic start generated code]*/
2083
Brett Cannon4caa61d2014-01-09 19:03:32 -05002084static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03002085_imp_is_frozen_impl(PyObject *module, PyObject *name)
2086/*[clinic end generated code: output=01f408f5ec0f2577 input=7301dbca1897d66b]*/
Brett Cannon4caa61d2014-01-09 19:03:32 -05002087{
Benjamin Peterson6fba3db2013-03-18 23:13:31 -07002088 const struct _frozen *p;
Brett Cannon4caa61d2014-01-09 19:03:32 -05002089
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002090 p = find_frozen(name);
2091 return PyBool_FromLong((long) (p == NULL ? 0 : p->size));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002092}
2093
Larry Hastings1df0b352015-08-24 19:53:56 -07002094/* Common implementation for _imp.exec_dynamic and _imp.exec_builtin */
2095static int
2096exec_builtin_or_dynamic(PyObject *mod) {
2097 PyModuleDef *def;
2098 void *state;
2099
2100 if (!PyModule_Check(mod)) {
2101 return 0;
2102 }
2103
2104 def = PyModule_GetDef(mod);
2105 if (def == NULL) {
Larry Hastings1df0b352015-08-24 19:53:56 -07002106 return 0;
2107 }
Brett Cannon52794db2016-09-07 17:00:43 -07002108
Larry Hastings1df0b352015-08-24 19:53:56 -07002109 state = PyModule_GetState(mod);
Larry Hastings1df0b352015-08-24 19:53:56 -07002110 if (state) {
2111 /* Already initialized; skip reload */
2112 return 0;
2113 }
Brett Cannon52794db2016-09-07 17:00:43 -07002114
Larry Hastings1df0b352015-08-24 19:53:56 -07002115 return PyModule_ExecDef(mod, def);
2116}
2117
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002118#ifdef HAVE_DYNAMIC_LOADING
2119
Brett Cannon4caa61d2014-01-09 19:03:32 -05002120/*[clinic input]
Nick Coghland5cacbb2015-05-23 22:24:10 +10002121_imp.create_dynamic
Brett Cannon4caa61d2014-01-09 19:03:32 -05002122
Nick Coghland5cacbb2015-05-23 22:24:10 +10002123 spec: object
Brett Cannon4caa61d2014-01-09 19:03:32 -05002124 file: object = NULL
2125 /
2126
Nick Coghland5cacbb2015-05-23 22:24:10 +10002127Create an extension module.
Brett Cannon4caa61d2014-01-09 19:03:32 -05002128[clinic start generated code]*/
2129
Brett Cannon4caa61d2014-01-09 19:03:32 -05002130static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03002131_imp_create_dynamic_impl(PyObject *module, PyObject *spec, PyObject *file)
2132/*[clinic end generated code: output=83249b827a4fde77 input=c31b954f4cf4e09d]*/
Brett Cannon4caa61d2014-01-09 19:03:32 -05002133{
Nick Coghland5cacbb2015-05-23 22:24:10 +10002134 PyObject *mod, *name, *path;
Victor Stinnerfefd70c2011-03-14 15:54:07 -04002135 FILE *fp;
2136
Nick Coghland5cacbb2015-05-23 22:24:10 +10002137 name = PyObject_GetAttrString(spec, "name");
2138 if (name == NULL) {
2139 return NULL;
2140 }
2141
2142 path = PyObject_GetAttrString(spec, "origin");
2143 if (path == NULL) {
2144 Py_DECREF(name);
2145 return NULL;
2146 }
2147
2148 mod = _PyImport_FindExtensionObject(name, path);
Miss Islington (bot)62674f32018-12-10 23:05:13 -08002149 if (mod != NULL || PyErr_Occurred()) {
Nick Coghland5cacbb2015-05-23 22:24:10 +10002150 Py_DECREF(name);
2151 Py_DECREF(path);
Miss Islington (bot)62674f32018-12-10 23:05:13 -08002152 Py_XINCREF(mod);
Nick Coghland5cacbb2015-05-23 22:24:10 +10002153 return mod;
2154 }
2155
Brett Cannon4caa61d2014-01-09 19:03:32 -05002156 if (file != NULL) {
2157 fp = _Py_fopen_obj(path, "r");
Victor Stinnere9ddbf62011-03-22 10:46:35 +01002158 if (fp == NULL) {
Nick Coghland5cacbb2015-05-23 22:24:10 +10002159 Py_DECREF(name);
Brett Cannon4caa61d2014-01-09 19:03:32 -05002160 Py_DECREF(path);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002161 return NULL;
Victor Stinnere9ddbf62011-03-22 10:46:35 +01002162 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002163 }
Victor Stinnerfefd70c2011-03-14 15:54:07 -04002164 else
2165 fp = NULL;
Nick Coghland5cacbb2015-05-23 22:24:10 +10002166
2167 mod = _PyImport_LoadDynamicModuleWithSpec(spec, fp);
2168
2169 Py_DECREF(name);
Brett Cannon4caa61d2014-01-09 19:03:32 -05002170 Py_DECREF(path);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002171 if (fp)
2172 fclose(fp);
Victor Stinnerfefd70c2011-03-14 15:54:07 -04002173 return mod;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002174}
2175
Nick Coghland5cacbb2015-05-23 22:24:10 +10002176/*[clinic input]
2177_imp.exec_dynamic -> int
2178
2179 mod: object
2180 /
2181
2182Initialize an extension module.
2183[clinic start generated code]*/
2184
2185static int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03002186_imp_exec_dynamic_impl(PyObject *module, PyObject *mod)
2187/*[clinic end generated code: output=f5720ac7b465877d input=9fdbfcb250280d3a]*/
Nick Coghland5cacbb2015-05-23 22:24:10 +10002188{
Larry Hastings1df0b352015-08-24 19:53:56 -07002189 return exec_builtin_or_dynamic(mod);
Nick Coghland5cacbb2015-05-23 22:24:10 +10002190}
2191
2192
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002193#endif /* HAVE_DYNAMIC_LOADING */
2194
Larry Hastings7726ac92014-01-31 22:03:12 -08002195/*[clinic input]
Larry Hastings1df0b352015-08-24 19:53:56 -07002196_imp.exec_builtin -> int
2197
2198 mod: object
2199 /
2200
2201Initialize a built-in module.
2202[clinic start generated code]*/
2203
2204static int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03002205_imp_exec_builtin_impl(PyObject *module, PyObject *mod)
2206/*[clinic end generated code: output=0262447b240c038e input=7beed5a2f12a60ca]*/
Larry Hastings1df0b352015-08-24 19:53:56 -07002207{
2208 return exec_builtin_or_dynamic(mod);
2209}
2210
Benjamin Peterson42aa93b2017-12-09 10:26:52 -08002211/*[clinic input]
2212_imp.source_hash
2213
2214 key: long
2215 source: Py_buffer
2216[clinic start generated code]*/
2217
2218static PyObject *
2219_imp_source_hash_impl(PyObject *module, long key, Py_buffer *source)
2220/*[clinic end generated code: output=edb292448cf399ea input=9aaad1e590089789]*/
2221{
Benjamin Peterson83620772017-12-09 12:18:56 -08002222 union {
2223 uint64_t x;
2224 char data[sizeof(uint64_t)];
2225 } hash;
2226 hash.x = _Py_KeyedHash((uint64_t)key, source->buf, source->len);
Benjamin Peterson42aa93b2017-12-09 10:26:52 -08002227#if !PY_LITTLE_ENDIAN
2228 // Force to little-endian. There really ought to be a succinct standard way
2229 // to do this.
Benjamin Peterson83620772017-12-09 12:18:56 -08002230 for (size_t i = 0; i < sizeof(hash.data)/2; i++) {
2231 char tmp = hash.data[i];
2232 hash.data[i] = hash.data[sizeof(hash.data) - i - 1];
2233 hash.data[sizeof(hash.data) - i - 1] = tmp;
Benjamin Peterson42aa93b2017-12-09 10:26:52 -08002234 }
Benjamin Peterson42aa93b2017-12-09 10:26:52 -08002235#endif
Benjamin Peterson83620772017-12-09 12:18:56 -08002236 return PyBytes_FromStringAndSize(hash.data, sizeof(hash.data));
Benjamin Peterson42aa93b2017-12-09 10:26:52 -08002237}
2238
Barry Warsaw28a691b2010-04-17 00:19:56 +00002239
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002240PyDoc_STRVAR(doc_imp,
Brett Cannon6f44d662012-04-15 16:08:47 -04002241"(Extremely) low-level import machinery bits as used by importlib and imp.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002242
Guido van Rossum79f25d91997-04-29 20:08:16 +00002243static PyMethodDef imp_methods[] = {
Brett Cannon4caa61d2014-01-09 19:03:32 -05002244 _IMP_EXTENSION_SUFFIXES_METHODDEF
2245 _IMP_LOCK_HELD_METHODDEF
2246 _IMP_ACQUIRE_LOCK_METHODDEF
2247 _IMP_RELEASE_LOCK_METHODDEF
2248 _IMP_GET_FROZEN_OBJECT_METHODDEF
2249 _IMP_IS_FROZEN_PACKAGE_METHODDEF
Nick Coghland5cacbb2015-05-23 22:24:10 +10002250 _IMP_CREATE_BUILTIN_METHODDEF
Brett Cannon4caa61d2014-01-09 19:03:32 -05002251 _IMP_INIT_FROZEN_METHODDEF
2252 _IMP_IS_BUILTIN_METHODDEF
2253 _IMP_IS_FROZEN_METHODDEF
Nick Coghland5cacbb2015-05-23 22:24:10 +10002254 _IMP_CREATE_DYNAMIC_METHODDEF
2255 _IMP_EXEC_DYNAMIC_METHODDEF
Larry Hastings1df0b352015-08-24 19:53:56 -07002256 _IMP_EXEC_BUILTIN_METHODDEF
Brett Cannon4caa61d2014-01-09 19:03:32 -05002257 _IMP__FIX_CO_FILENAME_METHODDEF
Benjamin Peterson42aa93b2017-12-09 10:26:52 -08002258 _IMP_SOURCE_HASH_METHODDEF
Brett Cannon4caa61d2014-01-09 19:03:32 -05002259 {NULL, NULL} /* sentinel */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002260};
2261
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002262
Martin v. Löwis1a214512008-06-11 05:26:20 +00002263static struct PyModuleDef impmodule = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002264 PyModuleDef_HEAD_INIT,
Brett Cannon6f44d662012-04-15 16:08:47 -04002265 "_imp",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002266 doc_imp,
2267 0,
2268 imp_methods,
2269 NULL,
2270 NULL,
2271 NULL,
2272 NULL
Martin v. Löwis1a214512008-06-11 05:26:20 +00002273};
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002274
Benjamin Peterson42aa93b2017-12-09 10:26:52 -08002275const char *_Py_CheckHashBasedPycsMode = "default";
2276
Jason Tishler6bc06ec2003-09-04 11:59:50 +00002277PyMODINIT_FUNC
Benjamin Petersonc65ef772018-01-29 11:33:57 -08002278PyInit__imp(void)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002279{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002280 PyObject *m, *d;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002281
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002282 m = PyModule_Create(&impmodule);
2283 if (m == NULL)
2284 goto failure;
2285 d = PyModule_GetDict(m);
2286 if (d == NULL)
2287 goto failure;
Benjamin Peterson42aa93b2017-12-09 10:26:52 -08002288 PyObject *pyc_mode = PyUnicode_FromString(_Py_CheckHashBasedPycsMode);
2289 if (pyc_mode == NULL) {
2290 goto failure;
2291 }
2292 if (PyDict_SetItemString(d, "check_hash_based_pycs", pyc_mode) < 0) {
2293 Py_DECREF(pyc_mode);
2294 goto failure;
2295 }
2296 Py_DECREF(pyc_mode);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002297
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002298 return m;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002299 failure:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002300 Py_XDECREF(m);
2301 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002302}
Guido van Rossum09cae1f1998-05-14 02:32:54 +00002303
2304
Guido van Rossumb18618d2000-05-03 23:44:39 +00002305/* API for embedding applications that want to add their own entries
2306 to the table of built-in modules. This should normally be called
2307 *before* Py_Initialize(). When the table resize fails, -1 is
2308 returned and the existing table is unchanged.
Guido van Rossum09cae1f1998-05-14 02:32:54 +00002309
2310 After a similar function by Just van Rossum. */
2311
2312int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002313PyImport_ExtendInittab(struct _inittab *newtab)
Guido van Rossum09cae1f1998-05-14 02:32:54 +00002314{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002315 struct _inittab *p;
Benjamin Peterson0c644fc2017-12-15 23:42:33 -08002316 size_t i, n;
Victor Stinner92a3c6f2017-12-06 18:12:59 +01002317 int res = 0;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00002318
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002319 /* Count the number of entries in both tables */
2320 for (n = 0; newtab[n].name != NULL; n++)
2321 ;
2322 if (n == 0)
2323 return 0; /* Nothing to do */
2324 for (i = 0; PyImport_Inittab[i].name != NULL; i++)
2325 ;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00002326
Victor Stinner92a3c6f2017-12-06 18:12:59 +01002327 /* Force default raw memory allocator to get a known allocator to be able
2328 to release the memory in _PyImport_Fini2() */
2329 PyMemAllocatorEx old_alloc;
2330 _PyMem_SetDefaultAllocator(PYMEM_DOMAIN_RAW, &old_alloc);
2331
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002332 /* Allocate new memory for the combined table */
Benjamin Peterson0c644fc2017-12-15 23:42:33 -08002333 p = NULL;
2334 if (i + n <= SIZE_MAX / sizeof(struct _inittab) - 1) {
Victor Stinner92a3c6f2017-12-06 18:12:59 +01002335 size_t size = sizeof(struct _inittab) * (i + n + 1);
2336 p = PyMem_RawRealloc(inittab_copy, size);
2337 }
Victor Stinner92a3c6f2017-12-06 18:12:59 +01002338 if (p == NULL) {
2339 res = -1;
2340 goto done;
2341 }
Guido van Rossum09cae1f1998-05-14 02:32:54 +00002342
Victor Stinner92a3c6f2017-12-06 18:12:59 +01002343 /* Copy the tables into the new memory at the first call
2344 to PyImport_ExtendInittab(). */
2345 if (inittab_copy != PyImport_Inittab) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002346 memcpy(p, PyImport_Inittab, (i+1) * sizeof(struct _inittab));
Victor Stinner92a3c6f2017-12-06 18:12:59 +01002347 }
2348 memcpy(p + i, newtab, (n + 1) * sizeof(struct _inittab));
2349 PyImport_Inittab = inittab_copy = p;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00002350
Victor Stinner92a3c6f2017-12-06 18:12:59 +01002351done:
2352 PyMem_SetAllocator(PYMEM_DOMAIN_RAW, &old_alloc);
2353 return res;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00002354}
2355
2356/* Shorthand to add a single entry given a name and a function */
2357
2358int
Brett Cannona826f322009-04-02 03:41:46 +00002359PyImport_AppendInittab(const char *name, PyObject* (*initfunc)(void))
Guido van Rossum09cae1f1998-05-14 02:32:54 +00002360{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002361 struct _inittab newtab[2];
Guido van Rossum09cae1f1998-05-14 02:32:54 +00002362
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002363 memset(newtab, '\0', sizeof newtab);
Guido van Rossum09cae1f1998-05-14 02:32:54 +00002364
Serhiy Storchaka20b39b22014-09-28 11:27:24 +03002365 newtab[0].name = name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002366 newtab[0].initfunc = initfunc;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00002367
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002368 return PyImport_ExtendInittab(newtab);
Guido van Rossum09cae1f1998-05-14 02:32:54 +00002369}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002370
2371#ifdef __cplusplus
2372}
2373#endif