blob: b79bda058db822401ebeac73400a77fa9869f641 [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"
Victor Stinner3bb183d2018-11-22 18:38:38 +01006#undef Yield /* undefine macro conflicting with <winbase.h> */
Victor Stinner61691d82019-10-02 23:51:20 +02007#include "pycore_initconfig.h"
Victor Stinner0a28f8d2019-06-19 02:54:39 +02008#include "pycore_pyerrors.h"
Victor Stinner621cebe2018-11-12 16:53:38 +01009#include "pycore_pyhash.h"
10#include "pycore_pylifecycle.h"
Victor Stinnerd9ea5ca2020-04-15 02:57:50 +020011#include "pycore_pymem.h" // _PyMem_SetDefaultAllocator()
Victor Stinnere5014be2020-04-14 17:52:15 +020012#include "pycore_interp.h" // _PyInterpreterState_ClearModules()
13#include "pycore_pystate.h" // _PyInterpreterState_GET()
Victor Stinner1c1e68c2020-03-27 15:11:45 +010014#include "pycore_sysmodule.h"
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000015#include "errcode.h"
Guido van Rossumc405b7b1991-06-04 19:39:42 +000016#include "marshal.h"
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000017#include "code.h"
Guido van Rossum1ae940a1995-01-02 19:04:15 +000018#include "importdl.h"
Christian Heimes3d2b4072017-09-30 00:53:19 +020019#include "pydtrace.h"
Guido van Rossumc405b7b1991-06-04 19:39:42 +000020
Guido van Rossum55a83382000-09-20 20:31:38 +000021#ifdef HAVE_FCNTL_H
22#include <fcntl.h>
23#endif
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000024#ifdef __cplusplus
Brett Cannon9a5b25a2010-03-01 02:09:17 +000025extern "C" {
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000026#endif
Guido van Rossum55a83382000-09-20 20:31:38 +000027
Barry Warsaw28a691b2010-04-17 00:19:56 +000028#define CACHEDIR "__pycache__"
Guido van Rossum96774c12000-05-01 20:19:08 +000029
Victor Stinner0a28f8d2019-06-19 02:54:39 +020030/* Forward references */
31static PyObject *import_add_module(PyThreadState *tstate, PyObject *name);
32
Victor Stinner95872862011-03-07 18:20:56 +010033/* See _PyImport_FixupExtensionObject() below */
Guido van Rossum25ce5661997-08-02 03:10:38 +000034static PyObject *extensions = NULL;
Guido van Rossum3f5da241990-12-20 15:06:42 +000035
Guido van Rossum771c6c81997-10-31 18:37:24 +000036/* This table is defined in config.c: */
37extern struct _inittab _PyImport_Inittab[];
38
39struct _inittab *PyImport_Inittab = _PyImport_Inittab;
Victor Stinner92a3c6f2017-12-06 18:12:59 +010040static struct _inittab *inittab_copy = NULL;
Guido van Rossum66f1fa81991-04-03 19:03:52 +000041
Hai Shi46874c22020-01-30 17:20:25 -060042_Py_IDENTIFIER(__path__);
43_Py_IDENTIFIER(__spec__);
44
Brett Cannon4caa61d2014-01-09 19:03:32 -050045/*[clinic input]
46module _imp
47[clinic start generated code]*/
Serhiy Storchaka1009bf12015-04-03 23:53:51 +030048/*[clinic end generated code: output=da39a3ee5e6b4b0d input=9c332475d8686284]*/
Brett Cannonfd4d0502014-05-30 11:21:14 -040049
50#include "clinic/import.c.h"
Brett Cannon4caa61d2014-01-09 19:03:32 -050051
Guido van Rossum1ae940a1995-01-02 19:04:15 +000052/* Initialize things */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000053
Victor Stinner331a6a52019-05-27 16:39:22 +020054PyStatus
Victor Stinnerb45d2592019-06-20 00:05:23 +020055_PyImportHooks_Init(PyThreadState *tstate)
Just van Rossum52e14d62002-12-30 22:08:05 +000056{
Brett Cannonfd074152012-04-14 14:10:13 -040057 PyObject *v, *path_hooks = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000058 int err = 0;
Just van Rossum52e14d62002-12-30 22:08:05 +000059
Brett Cannonfd074152012-04-14 14:10:13 -040060 /* adding sys.path_hooks and sys.path_importer_cache */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000061 v = PyList_New(0);
62 if (v == NULL)
63 goto error;
64 err = PySys_SetObject("meta_path", v);
65 Py_DECREF(v);
66 if (err)
67 goto error;
68 v = PyDict_New();
69 if (v == NULL)
70 goto error;
71 err = PySys_SetObject("path_importer_cache", v);
72 Py_DECREF(v);
73 if (err)
74 goto error;
75 path_hooks = PyList_New(0);
76 if (path_hooks == NULL)
77 goto error;
78 err = PySys_SetObject("path_hooks", path_hooks);
79 if (err) {
Victor Stinnerf7e5b562017-11-15 15:48:08 -080080 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000081 }
Brett Cannonfd074152012-04-14 14:10:13 -040082 Py_DECREF(path_hooks);
Victor Stinner331a6a52019-05-27 16:39:22 +020083 return _PyStatus_OK();
Victor Stinnerf7e5b562017-11-15 15:48:08 -080084
85 error:
Victor Stinnerb45d2592019-06-20 00:05:23 +020086 _PyErr_Print(tstate);
Victor Stinner331a6a52019-05-27 16:39:22 +020087 return _PyStatus_ERR("initializing sys.meta_path, sys.path_hooks, "
Victor Stinnerf7e5b562017-11-15 15:48:08 -080088 "or path_importer_cache failed");
Brett Cannonfd074152012-04-14 14:10:13 -040089}
90
Victor Stinner331a6a52019-05-27 16:39:22 +020091PyStatus
Victor Stinner0a28f8d2019-06-19 02:54:39 +020092_PyImportZip_Init(PyThreadState *tstate)
Brett Cannonfd074152012-04-14 14:10:13 -040093{
ukwksk5e6312c2018-05-15 04:10:52 +090094 PyObject *path_hooks, *zipimport;
Brett Cannonfd074152012-04-14 14:10:13 -040095 int err = 0;
96
97 path_hooks = PySys_GetObject("path_hooks");
Victor Stinner1e53bba2013-07-16 22:26:05 +020098 if (path_hooks == NULL) {
Victor Stinner0a28f8d2019-06-19 02:54:39 +020099 _PyErr_SetString(tstate, PyExc_RuntimeError,
100 "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
Victor Stinnerda7933e2020-04-13 03:04:28 +0200104 int verbose = _PyInterpreterState_GetConfig(tstate->interp)->verbose;
Victor Stinner410b85a2019-05-13 17:12:45 +0200105 if (verbose) {
Brett Cannonfd074152012-04-14 14:10:13 -0400106 PySys_WriteStderr("# installing zipimport hook\n");
Victor Stinner410b85a2019-05-13 17:12:45 +0200107 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000108
ukwksk5e6312c2018-05-15 04:10:52 +0900109 zipimport = PyImport_ImportModule("zipimport");
110 if (zipimport == NULL) {
Victor Stinner0a28f8d2019-06-19 02:54:39 +0200111 _PyErr_Clear(tstate); /* No zip import module -- okay */
Victor Stinner410b85a2019-05-13 17:12:45 +0200112 if (verbose) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000113 PySys_WriteStderr("# can't import zipimport\n");
Victor Stinner410b85a2019-05-13 17:12:45 +0200114 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000115 }
116 else {
Martin v. Löwisbd928fe2011-10-14 10:20:37 +0200117 _Py_IDENTIFIER(zipimporter);
ukwksk5e6312c2018-05-15 04:10:52 +0900118 PyObject *zipimporter = _PyObject_GetAttrId(zipimport,
Martin v. Löwis1ee1b6f2011-10-10 18:11:30 +0200119 &PyId_zipimporter);
ukwksk5e6312c2018-05-15 04:10:52 +0900120 Py_DECREF(zipimport);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000121 if (zipimporter == NULL) {
Victor Stinner0a28f8d2019-06-19 02:54:39 +0200122 _PyErr_Clear(tstate); /* No zipimporter object -- okay */
Victor Stinner410b85a2019-05-13 17:12:45 +0200123 if (verbose) {
124 PySys_WriteStderr("# can't import zipimport.zipimporter\n");
125 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000126 }
127 else {
Brett Cannon8923a4d2012-04-24 22:03:46 -0400128 /* sys.path_hooks.insert(0, zipimporter) */
129 err = PyList_Insert(path_hooks, 0, zipimporter);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000130 Py_DECREF(zipimporter);
Brett Cannonfd074152012-04-14 14:10:13 -0400131 if (err < 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000132 goto error;
Brett Cannonfd074152012-04-14 14:10:13 -0400133 }
Victor Stinner410b85a2019-05-13 17:12:45 +0200134 if (verbose) {
135 PySys_WriteStderr("# installed zipimport hook\n");
136 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000137 }
138 }
Brett Cannonfd074152012-04-14 14:10:13 -0400139
Victor Stinner331a6a52019-05-27 16:39:22 +0200140 return _PyStatus_OK();
Brett Cannonfd074152012-04-14 14:10:13 -0400141
142 error:
143 PyErr_Print();
Victor Stinner331a6a52019-05-27 16:39:22 +0200144 return _PyStatus_ERR("initializing zipimport failed");
Just van Rossum52e14d62002-12-30 22:08:05 +0000145}
146
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000147/* Locking primitives to prevent parallel imports of the same module
148 in different threads to return with a partially loaded module.
149 These calls are serialized by the global interpreter lock. */
150
Victor Stinner26881c82020-06-02 15:51:37 +0200151static PyThread_type_lock import_lock = NULL;
Serhiy Storchakaaefa7eb2017-03-23 15:48:39 +0200152static unsigned long import_lock_thread = PYTHREAD_INVALID_THREAD_ID;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000153static int import_lock_level = 0;
154
Benjamin Peterson0df35a92009-10-04 20:32:25 +0000155void
156_PyImport_AcquireLock(void)
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000157{
Serhiy Storchakaaefa7eb2017-03-23 15:48:39 +0200158 unsigned long me = PyThread_get_thread_ident();
159 if (me == PYTHREAD_INVALID_THREAD_ID)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000160 return; /* Too bad */
161 if (import_lock == NULL) {
162 import_lock = PyThread_allocate_lock();
163 if (import_lock == NULL)
164 return; /* Nothing much we can do. */
165 }
166 if (import_lock_thread == me) {
167 import_lock_level++;
168 return;
169 }
Serhiy Storchakaaefa7eb2017-03-23 15:48:39 +0200170 if (import_lock_thread != PYTHREAD_INVALID_THREAD_ID ||
171 !PyThread_acquire_lock(import_lock, 0))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000172 {
173 PyThreadState *tstate = PyEval_SaveThread();
Victor Stinner26881c82020-06-02 15:51:37 +0200174 PyThread_acquire_lock(import_lock, WAIT_LOCK);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000175 PyEval_RestoreThread(tstate);
176 }
Antoine Pitrou202b6062012-12-18 22:18:17 +0100177 assert(import_lock_level == 0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000178 import_lock_thread = me;
179 import_lock_level = 1;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000180}
181
Benjamin Peterson0df35a92009-10-04 20:32:25 +0000182int
183_PyImport_ReleaseLock(void)
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000184{
Serhiy Storchakaaefa7eb2017-03-23 15:48:39 +0200185 unsigned long me = PyThread_get_thread_ident();
186 if (me == PYTHREAD_INVALID_THREAD_ID || import_lock == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000187 return 0; /* Too bad */
188 if (import_lock_thread != me)
189 return -1;
190 import_lock_level--;
Antoine Pitrou202b6062012-12-18 22:18:17 +0100191 assert(import_lock_level >= 0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000192 if (import_lock_level == 0) {
Serhiy Storchakaaefa7eb2017-03-23 15:48:39 +0200193 import_lock_thread = PYTHREAD_INVALID_THREAD_ID;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000194 PyThread_release_lock(import_lock);
195 }
196 return 1;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000197}
198
Dong-hee Na62f75fe2020-04-15 01:16:24 +0900199#ifdef HAVE_FORK
Victor Stinner26881c82020-06-02 15:51:37 +0200200/* This function is called from PyOS_AfterFork_Child() to ensure that newly
Gregory P. Smith24cec9f2010-03-01 06:18:41 +0000201 created child processes do not share locks with the parent.
202 We now acquire the import lock around fork() calls but on some platforms
203 (Solaris 9 and earlier? see isue7242) that still left us with problems. */
Victor Stinner26881c82020-06-02 15:51:37 +0200204PyStatus
Guido van Rossum8ee3e5a2005-09-14 18:09:42 +0000205_PyImport_ReInitLock(void)
206{
Christian Heimes418fd742015-04-19 21:08:42 +0200207 if (import_lock != NULL) {
Dong-hee Na62f75fe2020-04-15 01:16:24 +0900208 if (_PyThread_at_fork_reinit(&import_lock) < 0) {
Victor Stinner26881c82020-06-02 15:51:37 +0200209 return _PyStatus_ERR("failed to create a new lock");
Christian Heimes418fd742015-04-19 21:08:42 +0200210 }
211 }
Victor Stinner26881c82020-06-02 15:51:37 +0200212
Nick Coghlanb2ddf792010-12-02 04:11:46 +0000213 if (import_lock_level > 1) {
214 /* Forked as a side effect of import */
Serhiy Storchakaaefa7eb2017-03-23 15:48:39 +0200215 unsigned long me = PyThread_get_thread_ident();
Victor Stinner45b34a02020-06-02 17:13:49 +0200216 PyThread_acquire_lock(import_lock, WAIT_LOCK);
Nick Coghlanb2ddf792010-12-02 04:11:46 +0000217 import_lock_thread = me;
218 import_lock_level--;
219 } else {
Serhiy Storchakaaefa7eb2017-03-23 15:48:39 +0200220 import_lock_thread = PYTHREAD_INVALID_THREAD_ID;
Nick Coghlanb2ddf792010-12-02 04:11:46 +0000221 import_lock_level = 0;
222 }
Victor Stinner26881c82020-06-02 15:51:37 +0200223 return _PyStatus_OK();
Guido van Rossum8ee3e5a2005-09-14 18:09:42 +0000224}
Dong-hee Na62f75fe2020-04-15 01:16:24 +0900225#endif
Guido van Rossum8ee3e5a2005-09-14 18:09:42 +0000226
Brett Cannon4caa61d2014-01-09 19:03:32 -0500227/*[clinic input]
228_imp.lock_held
229
230Return True if the import lock is currently held, else False.
231
232On platforms without threads, return False.
233[clinic start generated code]*/
234
Brett Cannon4caa61d2014-01-09 19:03:32 -0500235static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +0300236_imp_lock_held_impl(PyObject *module)
237/*[clinic end generated code: output=8b89384b5e1963fc input=9b088f9b217d9bdf]*/
Tim Peters69232342001-08-30 05:16:13 +0000238{
Serhiy Storchakaaefa7eb2017-03-23 15:48:39 +0200239 return PyBool_FromLong(import_lock_thread != PYTHREAD_INVALID_THREAD_ID);
Tim Peters69232342001-08-30 05:16:13 +0000240}
241
Brett Cannon4caa61d2014-01-09 19:03:32 -0500242/*[clinic input]
243_imp.acquire_lock
244
245Acquires the interpreter's import lock for the current thread.
246
247This lock should be used by import hooks to ensure thread-safety when importing
248modules. On platforms without threads, this function does nothing.
249[clinic start generated code]*/
250
Brett Cannon4caa61d2014-01-09 19:03:32 -0500251static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +0300252_imp_acquire_lock_impl(PyObject *module)
253/*[clinic end generated code: output=1aff58cb0ee1b026 input=4a2d4381866d5fdc]*/
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000254{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000255 _PyImport_AcquireLock();
Serhiy Storchaka228b12e2017-01-23 09:47:21 +0200256 Py_RETURN_NONE;
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000257}
258
Brett Cannon4caa61d2014-01-09 19:03:32 -0500259/*[clinic input]
260_imp.release_lock
261
262Release the interpreter's import lock.
263
264On platforms without threads, this function does nothing.
265[clinic start generated code]*/
266
Brett Cannon4caa61d2014-01-09 19:03:32 -0500267static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +0300268_imp_release_lock_impl(PyObject *module)
269/*[clinic end generated code: output=7faab6d0be178b0a input=934fb11516dd778b]*/
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000270{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000271 if (_PyImport_ReleaseLock() < 0) {
272 PyErr_SetString(PyExc_RuntimeError,
273 "not holding the import lock");
274 return NULL;
275 }
Serhiy Storchaka228b12e2017-01-23 09:47:21 +0200276 Py_RETURN_NONE;
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000277}
278
Antoine Pitrou8db076c2011-10-30 19:13:55 +0100279void
280_PyImport_Fini(void)
281{
Serhiy Storchaka505ff752014-02-09 13:33:53 +0200282 Py_CLEAR(extensions);
Antoine Pitrou8db076c2011-10-30 19:13:55 +0100283 if (import_lock != NULL) {
284 PyThread_free_lock(import_lock);
285 import_lock = NULL;
286 }
Antoine Pitrou8db076c2011-10-30 19:13:55 +0100287}
288
Victor Stinner92a3c6f2017-12-06 18:12:59 +0100289void
290_PyImport_Fini2(void)
291{
292 /* Use the same memory allocator than PyImport_ExtendInittab(). */
293 PyMemAllocatorEx old_alloc;
294 _PyMem_SetDefaultAllocator(PYMEM_DOMAIN_RAW, &old_alloc);
295
296 /* Free memory allocated by PyImport_ExtendInittab() */
297 PyMem_RawFree(inittab_copy);
Gregory Szorc64224a42020-05-01 11:07:54 -0700298 inittab_copy = NULL;
Victor Stinner92a3c6f2017-12-06 18:12:59 +0100299
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{
Victor Stinner81a7be32020-04-14 15:14:01 +0200308 PyInterpreterState *interp = _PyInterpreterState_GET();
Eric Snow3f9eee62017-09-15 16:35:20 -0600309 if (interp->modules == NULL) {
Victor Stinner87d3b9d2020-03-25 19:27:36 +0100310 Py_FatalError("interpreter has no modules 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{
Victor Stinner0a28f8d2019-06-19 02:54:39 +0200340 PyThreadState *tstate = _PyThreadState_GET();
341 PyObject *modules = tstate->interp->modules;
Eric Snow3f9eee62017-09-15 16:35:20 -0600342 return PyObject_SetItem(modules, name, m);
343}
344
345int
346_PyImport_SetModuleString(const char *name, PyObject *m)
347{
Victor Stinner0a28f8d2019-06-19 02:54:39 +0200348 PyThreadState *tstate = _PyThreadState_GET();
349 PyObject *modules = tstate->interp->modules;
Eric Snow3f9eee62017-09-15 16:35:20 -0600350 return PyMapping_SetItemString(modules, name, m);
351}
352
Victor Stinner0a28f8d2019-06-19 02:54:39 +0200353static PyObject *
354import_get_module(PyThreadState *tstate, PyObject *name)
Eric Snow3f9eee62017-09-15 16:35:20 -0600355{
Victor Stinner0a28f8d2019-06-19 02:54:39 +0200356 PyObject *modules = tstate->interp->modules;
Eric Snow3f9eee62017-09-15 16:35:20 -0600357 if (modules == NULL) {
Victor Stinner0a28f8d2019-06-19 02:54:39 +0200358 _PyErr_SetString(tstate, PyExc_RuntimeError,
359 "unable to get sys.modules");
Eric Snow3f9eee62017-09-15 16:35:20 -0600360 return NULL;
361 }
Victor Stinner0a28f8d2019-06-19 02:54:39 +0200362
363 PyObject *m;
Eric Snow3f9eee62017-09-15 16:35:20 -0600364 Py_INCREF(modules);
365 if (PyDict_CheckExact(modules)) {
366 m = PyDict_GetItemWithError(modules, name); /* borrowed */
367 Py_XINCREF(m);
368 }
369 else {
370 m = PyObject_GetItem(modules, name);
Victor Stinner0a28f8d2019-06-19 02:54:39 +0200371 if (m == NULL && _PyErr_ExceptionMatches(tstate, PyExc_KeyError)) {
372 _PyErr_Clear(tstate);
Eric Snow3f9eee62017-09-15 16:35:20 -0600373 }
374 }
375 Py_DECREF(modules);
376 return m;
377}
378
379
Joannah Nanjekye37c22202019-09-11 13:47:39 +0100380static int
381import_ensure_initialized(PyThreadState *tstate, PyObject *mod, PyObject *name)
Victor Stinner0a28f8d2019-06-19 02:54:39 +0200382{
Joannah Nanjekye37c22202019-09-11 13:47:39 +0100383 PyInterpreterState *interp = tstate->interp;
384 PyObject *spec;
385
Joannah Nanjekye37c22202019-09-11 13:47:39 +0100386 _Py_IDENTIFIER(_lock_unlock_module);
387
388 /* Optimization: only call _bootstrap._lock_unlock_module() if
389 __spec__._initializing is true.
390 NOTE: because of this, initializing must be set *before*
391 stuffing the new module in sys.modules.
392 */
393 spec = _PyObject_GetAttrId(mod, &PyId___spec__);
394 int busy = _PyModuleSpec_IsInitializing(spec);
395 Py_XDECREF(spec);
396 if (busy) {
397 /* Wait until module is done importing. */
398 PyObject *value = _PyObject_CallMethodIdOneArg(
399 interp->importlib, &PyId__lock_unlock_module, name);
400 if (value == NULL) {
401 return -1;
402 }
403 Py_DECREF(value);
404 }
405 return 0;
Victor Stinner0a28f8d2019-06-19 02:54:39 +0200406}
407
408
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000409/* List of names to clear in sys */
Serhiy Storchaka2d06e842015-12-25 19:53:18 +0200410static const char * const sys_deletes[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000411 "path", "argv", "ps1", "ps2",
412 "last_type", "last_value", "last_traceback",
413 "path_hooks", "path_importer_cache", "meta_path",
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200414 "__interactivehook__",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000415 NULL
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000416};
417
Serhiy Storchaka2d06e842015-12-25 19:53:18 +0200418static const char * const sys_files[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000419 "stdin", "__stdin__",
420 "stdout", "__stdout__",
421 "stderr", "__stderr__",
422 NULL
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000423};
424
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000425/* Un-initialize things, as good as we can */
Guido van Rossum3f5da241990-12-20 15:06:42 +0000426
Guido van Rossum3f5da241990-12-20 15:06:42 +0000427void
Victor Stinner987a0dc2019-06-19 10:36:10 +0200428_PyImport_Cleanup(PyThreadState *tstate)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000429{
Victor Stinner0a28f8d2019-06-19 02:54:39 +0200430 PyInterpreterState *interp = tstate->interp;
431 PyObject *modules = interp->modules;
432 if (modules == NULL) {
433 /* Already done */
434 return;
435 }
Guido van Rossum758eec01998-01-19 21:58:26 +0000436
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000437 /* Delete some special variables first. These are common
438 places where user values hide and people complain when their
439 destructors fail. Since the modules containing them are
440 deleted *last* of all, they would come too late in the normal
441 destruction order. Sigh. */
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000442
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200443 /* XXX Perhaps these precautions are obsolete. Who knows? */
444
Victor Stinnerda7933e2020-04-13 03:04:28 +0200445 int verbose = _PyInterpreterState_GetConfig(interp)->verbose;
Victor Stinner410b85a2019-05-13 17:12:45 +0200446 if (verbose) {
Serhiy Storchaka013bb912014-02-10 18:21:34 +0200447 PySys_WriteStderr("# clear builtins._\n");
Victor Stinner410b85a2019-05-13 17:12:45 +0200448 }
Serhiy Storchakae9d94942018-04-25 20:58:40 +0300449 if (PyDict_SetItemString(interp->builtins, "_", Py_None) < 0) {
Serhiy Storchakac1a68322018-04-29 22:16:30 +0300450 PyErr_WriteUnraisable(NULL);
Serhiy Storchakae9d94942018-04-25 20:58:40 +0300451 }
Serhiy Storchaka013bb912014-02-10 18:21:34 +0200452
Victor Stinner0a28f8d2019-06-19 02:54:39 +0200453 const char * const *p;
Serhiy Storchaka013bb912014-02-10 18:21:34 +0200454 for (p = sys_deletes; *p != NULL; p++) {
Victor Stinner410b85a2019-05-13 17:12:45 +0200455 if (verbose) {
Serhiy Storchaka013bb912014-02-10 18:21:34 +0200456 PySys_WriteStderr("# clear sys.%s\n", *p);
Victor Stinner410b85a2019-05-13 17:12:45 +0200457 }
Serhiy Storchakae9d94942018-04-25 20:58:40 +0300458 if (PyDict_SetItemString(interp->sysdict, *p, Py_None) < 0) {
Serhiy Storchakac1a68322018-04-29 22:16:30 +0300459 PyErr_WriteUnraisable(NULL);
Serhiy Storchakae9d94942018-04-25 20:58:40 +0300460 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000461 }
Serhiy Storchaka013bb912014-02-10 18:21:34 +0200462 for (p = sys_files; *p != NULL; p+=2) {
Victor Stinner410b85a2019-05-13 17:12:45 +0200463 if (verbose) {
Serhiy Storchaka013bb912014-02-10 18:21:34 +0200464 PySys_WriteStderr("# restore sys.%s\n", *p);
Victor Stinner410b85a2019-05-13 17:12:45 +0200465 }
Victor Stinner0a28f8d2019-06-19 02:54:39 +0200466 PyObject *value = _PyDict_GetItemStringWithError(interp->sysdict,
467 *(p+1));
Serhiy Storchakaa24107b2019-02-25 17:59:46 +0200468 if (value == NULL) {
Victor Stinner0a28f8d2019-06-19 02:54:39 +0200469 if (_PyErr_Occurred(tstate)) {
Serhiy Storchakaa24107b2019-02-25 17:59:46 +0200470 PyErr_WriteUnraisable(NULL);
471 }
Serhiy Storchaka013bb912014-02-10 18:21:34 +0200472 value = Py_None;
Serhiy Storchakaa24107b2019-02-25 17:59:46 +0200473 }
Serhiy Storchakae9d94942018-04-25 20:58:40 +0300474 if (PyDict_SetItemString(interp->sysdict, *p, value) < 0) {
Serhiy Storchakac1a68322018-04-29 22:16:30 +0300475 PyErr_WriteUnraisable(NULL);
Serhiy Storchakae9d94942018-04-25 20:58:40 +0300476 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000477 }
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000478
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200479 /* We prepare a list which will receive (name, weakref) tuples of
480 modules when they are removed from sys.modules. The name is used
481 for diagnosis messages (in verbose mode), while the weakref helps
482 detect those modules which have been held alive. */
Victor Stinner0a28f8d2019-06-19 02:54:39 +0200483 PyObject *weaklist = PyList_New(0);
Serhiy Storchakac1a68322018-04-29 22:16:30 +0300484 if (weaklist == NULL) {
485 PyErr_WriteUnraisable(NULL);
486 }
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200487
Antoine Pitrou79ba3882013-08-06 22:50:15 +0200488#define STORE_MODULE_WEAKREF(name, mod) \
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200489 if (weaklist != NULL) { \
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200490 PyObject *wr = PyWeakref_NewRef(mod, NULL); \
Serhiy Storchakae9d94942018-04-25 20:58:40 +0300491 if (wr) { \
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200492 PyObject *tup = PyTuple_Pack(2, name, wr); \
Serhiy Storchakae9d94942018-04-25 20:58:40 +0300493 if (!tup || PyList_Append(weaklist, tup) < 0) { \
Serhiy Storchakac1a68322018-04-29 22:16:30 +0300494 PyErr_WriteUnraisable(NULL); \
Serhiy Storchakae9d94942018-04-25 20:58:40 +0300495 } \
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200496 Py_XDECREF(tup); \
Serhiy Storchakae9d94942018-04-25 20:58:40 +0300497 Py_DECREF(wr); \
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200498 } \
Serhiy Storchakae9d94942018-04-25 20:58:40 +0300499 else { \
Serhiy Storchakac1a68322018-04-29 22:16:30 +0300500 PyErr_WriteUnraisable(NULL); \
Serhiy Storchakae9d94942018-04-25 20:58:40 +0300501 } \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000502 }
Eric Snow3f9eee62017-09-15 16:35:20 -0600503#define CLEAR_MODULE(name, mod) \
504 if (PyModule_Check(mod)) { \
Victor Stinner410b85a2019-05-13 17:12:45 +0200505 if (verbose && PyUnicode_Check(name)) { \
Eric Snow3f9eee62017-09-15 16:35:20 -0600506 PySys_FormatStderr("# cleanup[2] removing %U\n", name); \
Victor Stinner410b85a2019-05-13 17:12:45 +0200507 } \
Eric Snow3f9eee62017-09-15 16:35:20 -0600508 STORE_MODULE_WEAKREF(name, mod); \
Serhiy Storchakae9d94942018-04-25 20:58:40 +0300509 if (PyObject_SetItem(modules, name, Py_None) < 0) { \
Serhiy Storchakac1a68322018-04-29 22:16:30 +0300510 PyErr_WriteUnraisable(NULL); \
Serhiy Storchakae9d94942018-04-25 20:58:40 +0300511 } \
Eric Snow3f9eee62017-09-15 16:35:20 -0600512 }
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000513
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200514 /* Remove all modules from sys.modules, hoping that garbage collection
515 can reclaim most of them. */
Eric Snow3f9eee62017-09-15 16:35:20 -0600516 if (PyDict_CheckExact(modules)) {
Victor Stinner0a28f8d2019-06-19 02:54:39 +0200517 Py_ssize_t pos = 0;
518 PyObject *key, *value;
Eric Snow3f9eee62017-09-15 16:35:20 -0600519 while (PyDict_Next(modules, &pos, &key, &value)) {
520 CLEAR_MODULE(key, value);
521 }
522 }
523 else {
524 PyObject *iterator = PyObject_GetIter(modules);
525 if (iterator == NULL) {
Serhiy Storchakac1a68322018-04-29 22:16:30 +0300526 PyErr_WriteUnraisable(NULL);
Eric Snow3f9eee62017-09-15 16:35:20 -0600527 }
528 else {
Victor Stinner0a28f8d2019-06-19 02:54:39 +0200529 PyObject *key;
Eric Snow3f9eee62017-09-15 16:35:20 -0600530 while ((key = PyIter_Next(iterator))) {
Victor Stinner0a28f8d2019-06-19 02:54:39 +0200531 PyObject *value = PyObject_GetItem(modules, key);
Eric Snow3f9eee62017-09-15 16:35:20 -0600532 if (value == NULL) {
Serhiy Storchakac1a68322018-04-29 22:16:30 +0300533 PyErr_WriteUnraisable(NULL);
Eric Snow3f9eee62017-09-15 16:35:20 -0600534 continue;
535 }
536 CLEAR_MODULE(key, value);
537 Py_DECREF(value);
538 Py_DECREF(key);
539 }
Serhiy Storchakae9d94942018-04-25 20:58:40 +0300540 if (PyErr_Occurred()) {
Serhiy Storchakac1a68322018-04-29 22:16:30 +0300541 PyErr_WriteUnraisable(NULL);
Serhiy Storchakae9d94942018-04-25 20:58:40 +0300542 }
Eric Snow3f9eee62017-09-15 16:35:20 -0600543 Py_DECREF(iterator);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000544 }
545 }
Guido van Rossum758eec01998-01-19 21:58:26 +0000546
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200547 /* Clear the modules dict. */
Eric Snow3f9eee62017-09-15 16:35:20 -0600548 if (PyDict_CheckExact(modules)) {
549 PyDict_Clear(modules);
550 }
551 else {
552 _Py_IDENTIFIER(clear);
Jeroen Demeyer762f93f2019-07-08 10:19:25 +0200553 if (_PyObject_CallMethodIdNoArgs(modules, &PyId_clear) == NULL) {
Serhiy Storchakac1a68322018-04-29 22:16:30 +0300554 PyErr_WriteUnraisable(NULL);
555 }
Eric Snow3f9eee62017-09-15 16:35:20 -0600556 }
Serhiy Storchaka013bb912014-02-10 18:21:34 +0200557 /* Restore the original builtins dict, to ensure that any
558 user data gets cleared. */
Victor Stinner0a28f8d2019-06-19 02:54:39 +0200559 PyObject *dict = PyDict_Copy(interp->builtins);
Serhiy Storchakac1a68322018-04-29 22:16:30 +0300560 if (dict == NULL) {
561 PyErr_WriteUnraisable(NULL);
562 }
Serhiy Storchaka013bb912014-02-10 18:21:34 +0200563 PyDict_Clear(interp->builtins);
Serhiy Storchakac1a68322018-04-29 22:16:30 +0300564 if (PyDict_Update(interp->builtins, interp->builtins_copy)) {
Victor Stinner0a28f8d2019-06-19 02:54:39 +0200565 _PyErr_Clear(tstate);
Serhiy Storchakac1a68322018-04-29 22:16:30 +0300566 }
Serhiy Storchaka013bb912014-02-10 18:21:34 +0200567 Py_XDECREF(dict);
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200568 /* Collect references */
569 _PyGC_CollectNoFail();
Antoine Pitrou5f454a02013-05-06 21:15:57 +0200570 /* Dump GC stats before it's too late, since it uses the warnings
571 machinery. */
Victor Stinner67e0de62019-11-20 11:48:18 +0100572 _PyGC_DumpShutdownStats(tstate);
Antoine Pitrou5f454a02013-05-06 21:15:57 +0200573
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200574 /* Now, if there are any modules left alive, clear their globals to
575 minimize potential leaks. All C extension modules actually end
Serhiy Storchaka013bb912014-02-10 18:21:34 +0200576 up here, since they are kept alive in the interpreter state.
577
578 The special treatment of "builtins" here is because even
579 when it's not referenced as a module, its dictionary is
580 referenced by almost every module's __builtins__. Since
581 deleting a module clears its dictionary (even if there are
582 references left to it), we need to delete the "builtins"
583 module last. Likewise, we don't delete sys until the very
584 end because it is implicitly referenced (e.g. by print). */
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200585 if (weaklist != NULL) {
Serhiy Storchakac93c58b2018-10-29 19:30:16 +0200586 Py_ssize_t i;
587 /* Since dict is ordered in CPython 3.6+, modules are saved in
588 importing order. First clear modules imported later. */
589 for (i = PyList_GET_SIZE(weaklist) - 1; i >= 0; i--) {
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200590 PyObject *tup = PyList_GET_ITEM(weaklist, i);
Antoine Pitrou79ba3882013-08-06 22:50:15 +0200591 PyObject *name = PyTuple_GET_ITEM(tup, 0);
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200592 PyObject *mod = PyWeakref_GET_OBJECT(PyTuple_GET_ITEM(tup, 1));
593 if (mod == Py_None)
594 continue;
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200595 assert(PyModule_Check(mod));
Serhiy Storchaka013bb912014-02-10 18:21:34 +0200596 dict = PyModule_GetDict(mod);
597 if (dict == interp->builtins || dict == interp->sysdict)
598 continue;
599 Py_INCREF(mod);
Victor Stinner410b85a2019-05-13 17:12:45 +0200600 if (verbose && PyUnicode_Check(name)) {
Serhiy Storchaka013bb912014-02-10 18:21:34 +0200601 PySys_FormatStderr("# cleanup[3] wiping %U\n", name);
Victor Stinner410b85a2019-05-13 17:12:45 +0200602 }
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200603 _PyModule_Clear(mod);
604 Py_DECREF(mod);
Antoine Pitrou070cb3c2013-05-08 13:23:25 +0200605 }
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200606 Py_DECREF(weaklist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000607 }
Guido van Rossum758eec01998-01-19 21:58:26 +0000608
Serhiy Storchaka013bb912014-02-10 18:21:34 +0200609 /* Next, delete sys and builtins (in that order) */
Victor Stinner410b85a2019-05-13 17:12:45 +0200610 if (verbose) {
Serhiy Storchaka013bb912014-02-10 18:21:34 +0200611 PySys_FormatStderr("# cleanup[3] wiping sys\n");
Victor Stinner410b85a2019-05-13 17:12:45 +0200612 }
Serhiy Storchaka013bb912014-02-10 18:21:34 +0200613 _PyModule_ClearDict(interp->sysdict);
Victor Stinner410b85a2019-05-13 17:12:45 +0200614 if (verbose) {
Serhiy Storchaka013bb912014-02-10 18:21:34 +0200615 PySys_FormatStderr("# cleanup[3] wiping builtins\n");
Victor Stinner410b85a2019-05-13 17:12:45 +0200616 }
Serhiy Storchaka013bb912014-02-10 18:21:34 +0200617 _PyModule_ClearDict(interp->builtins);
618
Eddie Elizondo4590f722020-02-04 02:29:25 -0800619 /* Clear module dict copies stored in the interpreter state */
620 _PyInterpreterState_ClearModules(interp);
621
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200622 /* Clear and delete the modules directory. Actual modules will
623 still be there only if imported during the execution of some
624 destructor. */
Eric Snow93c92f72017-09-13 23:46:04 -0700625 interp->modules = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000626 Py_DECREF(modules);
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200627
628 /* Once more */
629 _PyGC_CollectNoFail();
630
Serhiy Storchakae9d94942018-04-25 20:58:40 +0300631#undef CLEAR_MODULE
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200632#undef STORE_MODULE_WEAKREF
Guido van Rossum8d15b5d1990-10-26 14:58:58 +0000633}
Guido van Rossum7f133ed1991-02-19 12:23:57 +0000634
635
Barry Warsaw28a691b2010-04-17 00:19:56 +0000636/* Helper for pythonrun.c -- return magic number and tag. */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000637
638long
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000639PyImport_GetMagicNumber(void)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000640{
Antoine Pitrou44b4b6a2012-07-10 18:27:54 +0200641 long res;
Victor Stinner81a7be32020-04-14 15:14:01 +0200642 PyInterpreterState *interp = _PyInterpreterState_GET();
Eric Snow32439d62015-05-02 19:15:18 -0600643 PyObject *external, *pyc_magic;
644
645 external = PyObject_GetAttrString(interp->importlib, "_bootstrap_external");
646 if (external == NULL)
647 return -1;
648 pyc_magic = PyObject_GetAttrString(external, "_RAW_MAGIC_NUMBER");
649 Py_DECREF(external);
Brett Cannon77b2abd2012-07-09 16:09:00 -0400650 if (pyc_magic == NULL)
651 return -1;
Antoine Pitrou44b4b6a2012-07-10 18:27:54 +0200652 res = PyLong_AsLong(pyc_magic);
Benjamin Peterson66f36592012-07-09 22:21:55 -0700653 Py_DECREF(pyc_magic);
654 return res;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000655}
656
657
Brett Cannon3adc7b72012-07-09 14:22:12 -0400658extern const char * _PySys_ImplCacheTag;
659
Barry Warsaw28a691b2010-04-17 00:19:56 +0000660const char *
661PyImport_GetMagicTag(void)
662{
Brett Cannon3adc7b72012-07-09 14:22:12 -0400663 return _PySys_ImplCacheTag;
Barry Warsaw28a691b2010-04-17 00:19:56 +0000664}
665
Brett Cannon98979b82012-07-02 15:13:11 -0400666
Guido van Rossum25ce5661997-08-02 03:10:38 +0000667/* Magic for extension modules (built-in as well as dynamically
668 loaded). To prevent initializing an extension module more than
Andrew Svetlov6b2cbeb2012-12-14 17:04:59 +0200669 once, we keep a static dictionary 'extensions' keyed by the tuple
670 (module name, module name) (for built-in modules) or by
671 (filename, module name) (for dynamically loaded modules), containing these
672 modules. A copy of the module's dictionary is stored by calling
673 _PyImport_FixupExtensionObject() immediately after the module initialization
674 function succeeds. A copy can be retrieved from there by calling
Victor Stinner95872862011-03-07 18:20:56 +0100675 _PyImport_FindExtensionObject().
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000676
Barry Warsaw7c9627b2010-06-17 18:38:20 +0000677 Modules which do support multiple initialization set their m_size
678 field to a non-negative number (indicating the size of the
679 module-specific state). They are still recorded in the extensions
680 dictionary, to avoid loading shared libraries twice.
Martin v. Löwis1a214512008-06-11 05:26:20 +0000681*/
682
683int
Victor Stinner95872862011-03-07 18:20:56 +0100684_PyImport_FixupExtensionObject(PyObject *mod, PyObject *name,
Victor Stinner0a28f8d2019-06-19 02:54:39 +0200685 PyObject *filename, PyObject *modules)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000686{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000687 if (mod == NULL || !PyModule_Check(mod)) {
688 PyErr_BadInternalCall();
689 return -1;
690 }
Victor Stinner82c83bd2019-11-22 18:52:27 +0100691
692 struct PyModuleDef *def = PyModule_GetDef(mod);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000693 if (!def) {
694 PyErr_BadInternalCall();
695 return -1;
696 }
Victor Stinner82c83bd2019-11-22 18:52:27 +0100697
698 PyThreadState *tstate = _PyThreadState_GET();
699 if (PyObject_SetItem(modules, name, mod) < 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000700 return -1;
Victor Stinner82c83bd2019-11-22 18:52:27 +0100701 }
702 if (_PyState_AddModule(tstate, mod, def) < 0) {
Eric Snow3f9eee62017-09-15 16:35:20 -0600703 PyMapping_DelItem(modules, name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000704 return -1;
705 }
Victor Stinner82c83bd2019-11-22 18:52:27 +0100706
707 if (_Py_IsMainInterpreter(tstate)) {
708 if (def->m_size == -1) {
709 if (def->m_base.m_copy) {
710 /* Somebody already imported the module,
711 likely under a different name.
712 XXX this should really not happen. */
713 Py_CLEAR(def->m_base.m_copy);
714 }
715 PyObject *dict = PyModule_GetDict(mod);
716 if (dict == NULL) {
717 return -1;
718 }
719 def->m_base.m_copy = PyDict_Copy(dict);
720 if (def->m_base.m_copy == NULL) {
721 return -1;
722 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000723 }
Victor Stinner82c83bd2019-11-22 18:52:27 +0100724
725 if (extensions == NULL) {
726 extensions = PyDict_New();
727 if (extensions == NULL) {
728 return -1;
729 }
730 }
731
732 PyObject *key = PyTuple_Pack(2, filename, name);
733 if (key == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000734 return -1;
Victor Stinner82c83bd2019-11-22 18:52:27 +0100735 }
736 int res = PyDict_SetItem(extensions, key, (PyObject *)def);
737 Py_DECREF(key);
738 if (res < 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000739 return -1;
Victor Stinner82c83bd2019-11-22 18:52:27 +0100740 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000741 }
Victor Stinner82c83bd2019-11-22 18:52:27 +0100742
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000743 return 0;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000744}
745
Victor Stinner49d3f252010-10-17 01:24:53 +0000746int
Eric Snowd393c1b2017-09-14 12:18:12 -0600747_PyImport_FixupBuiltin(PyObject *mod, const char *name, PyObject *modules)
Victor Stinner49d3f252010-10-17 01:24:53 +0000748{
749 int res;
Victor Stinner95872862011-03-07 18:20:56 +0100750 PyObject *nameobj;
Victor Stinner21fcd0c2011-03-07 18:28:15 +0100751 nameobj = PyUnicode_InternFromString(name);
Victor Stinner95872862011-03-07 18:20:56 +0100752 if (nameobj == NULL)
Victor Stinner49d3f252010-10-17 01:24:53 +0000753 return -1;
Eric Snowd393c1b2017-09-14 12:18:12 -0600754 res = _PyImport_FixupExtensionObject(mod, nameobj, nameobj, modules);
Victor Stinner95872862011-03-07 18:20:56 +0100755 Py_DECREF(nameobj);
Victor Stinner49d3f252010-10-17 01:24:53 +0000756 return res;
757}
758
Victor Stinner0a28f8d2019-06-19 02:54:39 +0200759static PyObject *
760import_find_extension(PyThreadState *tstate, PyObject *name,
761 PyObject *filename)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000762{
Victor Stinner0a28f8d2019-06-19 02:54:39 +0200763 if (extensions == NULL) {
764 return NULL;
765 }
Eric Snowd393c1b2017-09-14 12:18:12 -0600766
Victor Stinner0a28f8d2019-06-19 02:54:39 +0200767 PyObject *key = PyTuple_Pack(2, filename, name);
768 if (key == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000769 return NULL;
Victor Stinner0a28f8d2019-06-19 02:54:39 +0200770 }
771 PyModuleDef* def = (PyModuleDef *)PyDict_GetItemWithError(extensions, key);
Benjamin Peterson5cb8a312012-12-15 00:05:16 -0500772 Py_DECREF(key);
Victor Stinner0a28f8d2019-06-19 02:54:39 +0200773 if (def == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000774 return NULL;
Victor Stinner0a28f8d2019-06-19 02:54:39 +0200775 }
776
777 PyObject *mod, *mdict;
778 PyObject *modules = tstate->interp->modules;
779
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000780 if (def->m_size == -1) {
781 /* Module does not support repeated initialization */
782 if (def->m_base.m_copy == NULL)
783 return NULL;
Victor Stinner0a28f8d2019-06-19 02:54:39 +0200784 mod = import_add_module(tstate, name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000785 if (mod == NULL)
786 return NULL;
787 mdict = PyModule_GetDict(mod);
788 if (mdict == NULL)
789 return NULL;
790 if (PyDict_Update(mdict, def->m_base.m_copy))
791 return NULL;
792 }
793 else {
794 if (def->m_base.m_init == NULL)
795 return NULL;
796 mod = def->m_base.m_init();
797 if (mod == NULL)
798 return NULL;
Eric Snow3f9eee62017-09-15 16:35:20 -0600799 if (PyObject_SetItem(modules, name, mod) == -1) {
Christian Heimes09ca7942013-07-20 14:51:53 +0200800 Py_DECREF(mod);
801 return NULL;
802 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000803 Py_DECREF(mod);
804 }
Victor Stinner82c83bd2019-11-22 18:52:27 +0100805 if (_PyState_AddModule(tstate, mod, def) < 0) {
Eric Snow3f9eee62017-09-15 16:35:20 -0600806 PyMapping_DelItem(modules, name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000807 return NULL;
808 }
Victor Stinner0a28f8d2019-06-19 02:54:39 +0200809
Victor Stinnerda7933e2020-04-13 03:04:28 +0200810 int verbose = _PyInterpreterState_GetConfig(tstate->interp)->verbose;
Victor Stinner410b85a2019-05-13 17:12:45 +0200811 if (verbose) {
Victor Stinner95872862011-03-07 18:20:56 +0100812 PySys_FormatStderr("import %U # previously loaded (%R)\n",
Victor Stinner410b85a2019-05-13 17:12:45 +0200813 name, filename);
814 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000815 return mod;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000816}
817
Victor Stinner49d3f252010-10-17 01:24:53 +0000818PyObject *
Victor Stinner0a28f8d2019-06-19 02:54:39 +0200819_PyImport_FindExtensionObject(PyObject *name, PyObject *filename)
820{
821 PyThreadState *tstate = _PyThreadState_GET();
822 return import_find_extension(tstate, name, filename);
823}
824
825
826PyObject *
827_PyImport_FindBuiltin(PyThreadState *tstate, const char *name)
Victor Stinner49d3f252010-10-17 01:24:53 +0000828{
Victor Stinner95872862011-03-07 18:20:56 +0100829 PyObject *res, *nameobj;
Victor Stinner21fcd0c2011-03-07 18:28:15 +0100830 nameobj = PyUnicode_InternFromString(name);
Victor Stinner95872862011-03-07 18:20:56 +0100831 if (nameobj == NULL)
Victor Stinner49d3f252010-10-17 01:24:53 +0000832 return NULL;
Victor Stinner0a28f8d2019-06-19 02:54:39 +0200833 res = import_find_extension(tstate, nameobj, nameobj);
Victor Stinner95872862011-03-07 18:20:56 +0100834 Py_DECREF(nameobj);
Victor Stinner49d3f252010-10-17 01:24:53 +0000835 return res;
836}
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000837
838/* Get the module object corresponding to a module name.
839 First check the modules dictionary if there's one there,
Walter Dörwaldf0dfc7a2003-10-20 14:01:56 +0000840 if not, create a new one and insert it in the modules dictionary.
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000841 Because the former action is most common, THIS DOES NOT RETURN A
842 'NEW' REFERENCE! */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000843
Victor Stinner0a28f8d2019-06-19 02:54:39 +0200844static PyObject *
845import_add_module(PyThreadState *tstate, PyObject *name)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000846{
Victor Stinner0a28f8d2019-06-19 02:54:39 +0200847 PyObject *modules = tstate->interp->modules;
848 if (modules == NULL) {
849 _PyErr_SetString(tstate, PyExc_RuntimeError,
850 "no import module dictionary");
851 return NULL;
852 }
Eric Snowd393c1b2017-09-14 12:18:12 -0600853
Eric Snow86b7afd2017-09-04 17:54:09 -0600854 PyObject *m;
Eric Snow3f9eee62017-09-15 16:35:20 -0600855 if (PyDict_CheckExact(modules)) {
856 m = PyDict_GetItemWithError(modules, name);
857 }
858 else {
859 m = PyObject_GetItem(modules, name);
Min ho Kimc4cacc82019-07-31 08:16:13 +1000860 // For backward-compatibility we copy the behavior
Eric Snow3f9eee62017-09-15 16:35:20 -0600861 // of PyDict_GetItemWithError().
Victor Stinner0a28f8d2019-06-19 02:54:39 +0200862 if (_PyErr_ExceptionMatches(tstate, PyExc_KeyError)) {
863 _PyErr_Clear(tstate);
Eric Snow3f9eee62017-09-15 16:35:20 -0600864 }
Serhiy Storchaka48a583b2016-02-10 10:31:20 +0200865 }
Victor Stinner0a28f8d2019-06-19 02:54:39 +0200866 if (_PyErr_Occurred(tstate)) {
Serhiy Storchaka48a583b2016-02-10 10:31:20 +0200867 return NULL;
868 }
Eric Snow3f9eee62017-09-15 16:35:20 -0600869 if (m != NULL && PyModule_Check(m)) {
870 return m;
871 }
Victor Stinner27ee0892011-03-04 12:57:09 +0000872 m = PyModule_NewObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000873 if (m == NULL)
874 return NULL;
Eric Snow3f9eee62017-09-15 16:35:20 -0600875 if (PyObject_SetItem(modules, name, m) != 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000876 Py_DECREF(m);
877 return NULL;
878 }
879 Py_DECREF(m); /* Yes, it still exists, in modules! */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000880
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000881 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000882}
883
Victor Stinner27ee0892011-03-04 12:57:09 +0000884PyObject *
Victor Stinner0a28f8d2019-06-19 02:54:39 +0200885PyImport_AddModuleObject(PyObject *name)
886{
887 PyThreadState *tstate = _PyThreadState_GET();
888 return import_add_module(tstate, name);
889}
890
891
892PyObject *
Victor Stinner27ee0892011-03-04 12:57:09 +0000893PyImport_AddModule(const char *name)
894{
Victor Stinner0a28f8d2019-06-19 02:54:39 +0200895 PyObject *nameobj = PyUnicode_FromString(name);
896 if (nameobj == NULL) {
Victor Stinner27ee0892011-03-04 12:57:09 +0000897 return NULL;
Victor Stinner0a28f8d2019-06-19 02:54:39 +0200898 }
899 PyObject *module = PyImport_AddModuleObject(nameobj);
Victor Stinner27ee0892011-03-04 12:57:09 +0000900 Py_DECREF(nameobj);
901 return module;
902}
903
904
Serhiy Storchaka8287aad2020-10-11 16:51:07 +0300905/* Remove name from sys.modules, if it's there.
906 * Can be called with an exception raised.
907 * If fail to remove name a new exception will be chained with the old
908 * exception, otherwise the old exception is preserved.
909 */
Tim Peters1cd70172004-08-02 03:52:12 +0000910static void
Victor Stinner0a28f8d2019-06-19 02:54:39 +0200911remove_module(PyThreadState *tstate, PyObject *name)
Tim Peters1cd70172004-08-02 03:52:12 +0000912{
Zackery Spytz94a64e92019-05-08 10:31:23 -0600913 PyObject *type, *value, *traceback;
Victor Stinner0a28f8d2019-06-19 02:54:39 +0200914 _PyErr_Fetch(tstate, &type, &value, &traceback);
915
916 PyObject *modules = tstate->interp->modules;
Serhiy Storchaka8287aad2020-10-11 16:51:07 +0300917 if (PyDict_CheckExact(modules)) {
918 PyObject *mod = _PyDict_Pop(modules, name, Py_None);
919 Py_XDECREF(mod);
Zackery Spytz94a64e92019-05-08 10:31:23 -0600920 }
Serhiy Storchaka8287aad2020-10-11 16:51:07 +0300921 else if (PyMapping_DelItem(modules, name) < 0) {
922 if (_PyErr_ExceptionMatches(tstate, PyExc_KeyError)) {
923 _PyErr_Clear(tstate);
924 }
Eric Snow3f9eee62017-09-15 16:35:20 -0600925 }
Victor Stinner0a28f8d2019-06-19 02:54:39 +0200926
Serhiy Storchaka8287aad2020-10-11 16:51:07 +0300927 _PyErr_ChainExceptions(type, value, traceback);
Tim Peters1cd70172004-08-02 03:52:12 +0000928}
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000929
Christian Heimes3b06e532008-01-07 20:12:44 +0000930
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000931/* Execute a code object in a module and return the module object
Tim Peters1cd70172004-08-02 03:52:12 +0000932 * WITH INCREMENTED REFERENCE COUNT. If an error occurs, name is
933 * removed from sys.modules, to avoid leaving damaged module objects
934 * in sys.modules. The caller may wish to restore the original
935 * module object (if any) in this case; PyImport_ReloadModule is an
936 * example.
Barry Warsaw28a691b2010-04-17 00:19:56 +0000937 *
938 * Note that PyImport_ExecCodeModuleWithPathnames() is the preferred, richer
939 * interface. The other two exist primarily for backward compatibility.
Tim Peters1cd70172004-08-02 03:52:12 +0000940 */
Guido van Rossum79f25d91997-04-29 20:08:16 +0000941PyObject *
Serhiy Storchakac6792272013-10-19 21:03:34 +0300942PyImport_ExecCodeModule(const char *name, PyObject *co)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000943{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000944 return PyImport_ExecCodeModuleWithPathnames(
945 name, co, (char *)NULL, (char *)NULL);
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000946}
947
948PyObject *
Serhiy Storchakac6792272013-10-19 21:03:34 +0300949PyImport_ExecCodeModuleEx(const char *name, PyObject *co, const char *pathname)
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000950{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000951 return PyImport_ExecCodeModuleWithPathnames(
952 name, co, pathname, (char *)NULL);
Barry Warsaw28a691b2010-04-17 00:19:56 +0000953}
954
955PyObject *
Serhiy Storchakac6792272013-10-19 21:03:34 +0300956PyImport_ExecCodeModuleWithPathnames(const char *name, PyObject *co,
957 const char *pathname,
958 const char *cpathname)
Barry Warsaw28a691b2010-04-17 00:19:56 +0000959{
Victor Stinner27ee0892011-03-04 12:57:09 +0000960 PyObject *m = NULL;
Eric Snow32439d62015-05-02 19:15:18 -0600961 PyObject *nameobj, *pathobj = NULL, *cpathobj = NULL, *external= NULL;
Victor Stinner27ee0892011-03-04 12:57:09 +0000962
963 nameobj = PyUnicode_FromString(name);
964 if (nameobj == NULL)
965 return NULL;
966
Victor Stinner27ee0892011-03-04 12:57:09 +0000967 if (cpathname != NULL) {
968 cpathobj = PyUnicode_DecodeFSDefault(cpathname);
969 if (cpathobj == NULL)
970 goto error;
Brett Cannona6473f92012-07-13 13:57:03 -0400971 }
972 else
Victor Stinner27ee0892011-03-04 12:57:09 +0000973 cpathobj = NULL;
Brett Cannona6473f92012-07-13 13:57:03 -0400974
975 if (pathname != NULL) {
976 pathobj = PyUnicode_DecodeFSDefault(pathname);
977 if (pathobj == NULL)
978 goto error;
979 }
980 else if (cpathobj != NULL) {
Victor Stinner81a7be32020-04-14 15:14:01 +0200981 PyInterpreterState *interp = _PyInterpreterState_GET();
Brett Cannona6473f92012-07-13 13:57:03 -0400982 _Py_IDENTIFIER(_get_sourcefile);
983
984 if (interp == NULL) {
Victor Stinner87d3b9d2020-03-25 19:27:36 +0100985 Py_FatalError("no current interpreter");
Brett Cannona6473f92012-07-13 13:57:03 -0400986 }
987
Eric Snow32439d62015-05-02 19:15:18 -0600988 external= PyObject_GetAttrString(interp->importlib,
989 "_bootstrap_external");
990 if (external != NULL) {
Jeroen Demeyer59ad1102019-07-11 10:59:05 +0200991 pathobj = _PyObject_CallMethodIdOneArg(
992 external, &PyId__get_sourcefile, cpathobj);
Eric Snow32439d62015-05-02 19:15:18 -0600993 Py_DECREF(external);
994 }
Brett Cannona6473f92012-07-13 13:57:03 -0400995 if (pathobj == NULL)
996 PyErr_Clear();
997 }
998 else
999 pathobj = NULL;
1000
Victor Stinner27ee0892011-03-04 12:57:09 +00001001 m = PyImport_ExecCodeModuleObject(nameobj, co, pathobj, cpathobj);
1002error:
1003 Py_DECREF(nameobj);
1004 Py_XDECREF(pathobj);
1005 Py_XDECREF(cpathobj);
1006 return m;
1007}
1008
Brett Cannon18fc4e72014-04-04 10:01:46 -04001009static PyObject *
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001010module_dict_for_exec(PyThreadState *tstate, PyObject *name)
Victor Stinner27ee0892011-03-04 12:57:09 +00001011{
Serhiy Storchakaa24107b2019-02-25 17:59:46 +02001012 _Py_IDENTIFIER(__builtins__);
Brett Cannon18fc4e72014-04-04 10:01:46 -04001013 PyObject *m, *d = NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001014
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001015 m = import_add_module(tstate, name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001016 if (m == NULL)
1017 return NULL;
1018 /* If the module is being reloaded, we get the old module back
1019 and re-use its dict to exec the new code. */
1020 d = PyModule_GetDict(m);
Serhiy Storchakab510e102020-10-26 12:47:57 +02001021 int r = _PyDict_ContainsId(d, &PyId___builtins__);
1022 if (r == 0) {
1023 r = _PyDict_SetItemId(d, &PyId___builtins__,
1024 PyEval_GetBuiltins());
1025 }
1026 if (r < 0) {
1027 remove_module(tstate, name);
1028 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001029 }
Brett Cannon18fc4e72014-04-04 10:01:46 -04001030
Eric Snow08197a42014-05-12 17:54:55 -06001031 return d; /* Return a borrowed reference. */
Brett Cannon18fc4e72014-04-04 10:01:46 -04001032}
1033
1034static PyObject *
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001035exec_code_in_module(PyThreadState *tstate, PyObject *name,
1036 PyObject *module_dict, PyObject *code_object)
Brett Cannon18fc4e72014-04-04 10:01:46 -04001037{
Brett Cannon18fc4e72014-04-04 10:01:46 -04001038 PyObject *v, *m;
1039
1040 v = PyEval_EvalCode(code_object, module_dict, module_dict);
1041 if (v == NULL) {
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001042 remove_module(tstate, name);
Brett Cannon18fc4e72014-04-04 10:01:46 -04001043 return NULL;
1044 }
1045 Py_DECREF(v);
1046
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001047 m = import_get_module(tstate, name);
1048 if (m == NULL && !_PyErr_Occurred(tstate)) {
1049 _PyErr_Format(tstate, PyExc_ImportError,
1050 "Loaded module %R not found in sys.modules",
1051 name);
Brett Cannon18fc4e72014-04-04 10:01:46 -04001052 }
1053
Brett Cannon18fc4e72014-04-04 10:01:46 -04001054 return m;
1055}
1056
1057PyObject*
1058PyImport_ExecCodeModuleObject(PyObject *name, PyObject *co, PyObject *pathname,
1059 PyObject *cpathname)
1060{
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001061 PyThreadState *tstate = _PyThreadState_GET();
Eric Snow32439d62015-05-02 19:15:18 -06001062 PyObject *d, *external, *res;
Eric Snow08197a42014-05-12 17:54:55 -06001063 _Py_IDENTIFIER(_fix_up_module);
Brett Cannon18fc4e72014-04-04 10:01:46 -04001064
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001065 d = module_dict_for_exec(tstate, name);
Brett Cannon18fc4e72014-04-04 10:01:46 -04001066 if (d == NULL) {
1067 return NULL;
1068 }
1069
Eric Snow08197a42014-05-12 17:54:55 -06001070 if (pathname == NULL) {
1071 pathname = ((PyCodeObject *)co)->co_filename;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001072 }
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001073 external = PyObject_GetAttrString(tstate->interp->importlib,
1074 "_bootstrap_external");
Eric Snow32439d62015-05-02 19:15:18 -06001075 if (external == NULL)
1076 return NULL;
1077 res = _PyObject_CallMethodIdObjArgs(external,
Eric Snow08197a42014-05-12 17:54:55 -06001078 &PyId__fix_up_module,
1079 d, name, pathname, cpathname, NULL);
Eric Snow32439d62015-05-02 19:15:18 -06001080 Py_DECREF(external);
Eric Snow08197a42014-05-12 17:54:55 -06001081 if (res != NULL) {
Eric Snow58cfdd82014-05-29 12:31:39 -06001082 Py_DECREF(res);
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001083 res = exec_code_in_module(tstate, name, d, co);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001084 }
Eric Snow08197a42014-05-12 17:54:55 -06001085 return res;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001086}
1087
1088
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001089static void
1090update_code_filenames(PyCodeObject *co, PyObject *oldname, PyObject *newname)
1091{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001092 PyObject *constants, *tmp;
1093 Py_ssize_t i, n;
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001094
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001095 if (PyUnicode_Compare(co->co_filename, oldname))
1096 return;
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001097
Serhiy Storchaka576f1322016-01-05 21:27:54 +02001098 Py_INCREF(newname);
Serhiy Storchakaec397562016-04-06 09:50:03 +03001099 Py_XSETREF(co->co_filename, newname);
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001100
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001101 constants = co->co_consts;
1102 n = PyTuple_GET_SIZE(constants);
1103 for (i = 0; i < n; i++) {
1104 tmp = PyTuple_GET_ITEM(constants, i);
1105 if (PyCode_Check(tmp))
1106 update_code_filenames((PyCodeObject *)tmp,
1107 oldname, newname);
1108 }
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001109}
1110
Victor Stinner2f42ae52011-03-20 00:41:24 +01001111static void
1112update_compiled_module(PyCodeObject *co, PyObject *newname)
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001113{
Victor Stinner2f42ae52011-03-20 00:41:24 +01001114 PyObject *oldname;
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001115
Victor Stinner2f42ae52011-03-20 00:41:24 +01001116 if (PyUnicode_Compare(co->co_filename, newname) == 0)
1117 return;
Hirokazu Yamamoto4f447fb2009-03-04 01:52:10 +00001118
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001119 oldname = co->co_filename;
1120 Py_INCREF(oldname);
1121 update_code_filenames(co, oldname, newname);
1122 Py_DECREF(oldname);
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001123}
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001124
Brett Cannon4caa61d2014-01-09 19:03:32 -05001125/*[clinic input]
1126_imp._fix_co_filename
1127
1128 code: object(type="PyCodeObject *", subclass_of="&PyCode_Type")
1129 Code object to change.
1130
1131 path: unicode
1132 File path to use.
1133 /
1134
1135Changes code.co_filename to specify the passed-in file path.
1136[clinic start generated code]*/
1137
Brett Cannon4caa61d2014-01-09 19:03:32 -05001138static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03001139_imp__fix_co_filename_impl(PyObject *module, PyCodeObject *code,
Larry Hastings89964c42015-04-14 18:07:59 -04001140 PyObject *path)
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03001141/*[clinic end generated code: output=1d002f100235587d input=895ba50e78b82f05]*/
Brett Cannon442c9b92011-03-23 16:14:42 -07001142
Brett Cannon4caa61d2014-01-09 19:03:32 -05001143{
Brett Cannona6dec2e2014-01-10 07:43:55 -05001144 update_compiled_module(code, path);
Brett Cannon442c9b92011-03-23 16:14:42 -07001145
1146 Py_RETURN_NONE;
1147}
1148
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001149
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001150/* Forward */
Benjamin Peterson6fba3db2013-03-18 23:13:31 -07001151static const struct _frozen * find_frozen(PyObject *);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001152
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001153
1154/* Helper to test for built-in module */
1155
1156static int
Victor Stinner95872862011-03-07 18:20:56 +01001157is_builtin(PyObject *name)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001158{
Serhiy Storchakaf4934ea2016-11-16 10:17:58 +02001159 int i;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001160 for (i = 0; PyImport_Inittab[i].name != NULL; i++) {
Serhiy Storchakaf4934ea2016-11-16 10:17:58 +02001161 if (_PyUnicode_EqualToASCIIString(name, PyImport_Inittab[i].name)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001162 if (PyImport_Inittab[i].initfunc == NULL)
1163 return -1;
1164 else
1165 return 1;
1166 }
1167 }
1168 return 0;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001169}
1170
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001171
Brett Cannonfdcdd9e2016-07-08 11:00:00 -07001172/* Return a finder object for a sys.path/pkg.__path__ item 'p',
Just van Rossum52e14d62002-12-30 22:08:05 +00001173 possibly by fetching it from the path_importer_cache dict. If it
Thomas Wouters89f507f2006-12-13 04:49:30 +00001174 wasn't yet cached, traverse path_hooks until a hook is found
Just van Rossum52e14d62002-12-30 22:08:05 +00001175 that can handle the path item. Return None if no hook could;
Brett Cannonfdcdd9e2016-07-08 11:00:00 -07001176 this tells our caller that the path based finder could not find
1177 a finder for this path item. Cache the result in
1178 path_importer_cache.
Just van Rossum52e14d62002-12-30 22:08:05 +00001179 Returns a borrowed reference. */
1180
1181static PyObject *
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001182get_path_importer(PyThreadState *tstate, PyObject *path_importer_cache,
1183 PyObject *path_hooks, PyObject *p)
Just van Rossum52e14d62002-12-30 22:08:05 +00001184{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001185 PyObject *importer;
1186 Py_ssize_t j, nhooks;
Just van Rossum52e14d62002-12-30 22:08:05 +00001187
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001188 /* These conditions are the caller's responsibility: */
1189 assert(PyList_Check(path_hooks));
1190 assert(PyDict_Check(path_importer_cache));
Just van Rossum52e14d62002-12-30 22:08:05 +00001191
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001192 nhooks = PyList_Size(path_hooks);
1193 if (nhooks < 0)
1194 return NULL; /* Shouldn't happen */
Just van Rossum52e14d62002-12-30 22:08:05 +00001195
Serhiy Storchakaa24107b2019-02-25 17:59:46 +02001196 importer = PyDict_GetItemWithError(path_importer_cache, p);
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001197 if (importer != NULL || _PyErr_Occurred(tstate))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001198 return importer;
Just van Rossum52e14d62002-12-30 22:08:05 +00001199
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001200 /* set path_importer_cache[p] to None to avoid recursion */
1201 if (PyDict_SetItem(path_importer_cache, p, Py_None) != 0)
1202 return NULL;
Just van Rossum52e14d62002-12-30 22:08:05 +00001203
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001204 for (j = 0; j < nhooks; j++) {
1205 PyObject *hook = PyList_GetItem(path_hooks, j);
1206 if (hook == NULL)
1207 return NULL;
Petr Viktorinffd97532020-02-11 17:46:57 +01001208 importer = PyObject_CallOneArg(hook, p);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001209 if (importer != NULL)
1210 break;
Just van Rossum52e14d62002-12-30 22:08:05 +00001211
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001212 if (!_PyErr_ExceptionMatches(tstate, PyExc_ImportError)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001213 return NULL;
1214 }
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001215 _PyErr_Clear(tstate);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001216 }
1217 if (importer == NULL) {
Brett Cannonaa936422012-04-27 15:30:58 -04001218 return Py_None;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001219 }
1220 if (importer != NULL) {
1221 int err = PyDict_SetItem(path_importer_cache, p, importer);
1222 Py_DECREF(importer);
1223 if (err != 0)
1224 return NULL;
1225 }
1226 return importer;
Just van Rossum52e14d62002-12-30 22:08:05 +00001227}
1228
Benjamin Petersone5024512018-09-12 12:06:42 -07001229PyObject *
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001230PyImport_GetImporter(PyObject *path)
1231{
1232 PyThreadState *tstate = _PyThreadState_GET();
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001233 PyObject *importer=NULL, *path_importer_cache=NULL, *path_hooks=NULL;
Christian Heimes9cd17752007-11-18 19:35:23 +00001234
Victor Stinner1e53bba2013-07-16 22:26:05 +02001235 path_importer_cache = PySys_GetObject("path_importer_cache");
1236 path_hooks = PySys_GetObject("path_hooks");
1237 if (path_importer_cache != NULL && path_hooks != NULL) {
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001238 importer = get_path_importer(tstate, path_importer_cache,
Victor Stinner1e53bba2013-07-16 22:26:05 +02001239 path_hooks, path);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001240 }
1241 Py_XINCREF(importer); /* get_path_importer returns a borrowed reference */
1242 return importer;
Christian Heimes9cd17752007-11-18 19:35:23 +00001243}
1244
Nick Coghland5cacbb2015-05-23 22:24:10 +10001245/*[clinic input]
1246_imp.create_builtin
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001247
Nick Coghland5cacbb2015-05-23 22:24:10 +10001248 spec: object
1249 /
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001250
Nick Coghland5cacbb2015-05-23 22:24:10 +10001251Create an extension module.
1252[clinic start generated code]*/
Guido van Rossum7f133ed1991-02-19 12:23:57 +00001253
Nick Coghland5cacbb2015-05-23 22:24:10 +10001254static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03001255_imp_create_builtin(PyObject *module, PyObject *spec)
1256/*[clinic end generated code: output=ace7ff22271e6f39 input=37f966f890384e47]*/
Guido van Rossum7f133ed1991-02-19 12:23:57 +00001257{
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001258 PyThreadState *tstate = _PyThreadState_GET();
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001259 struct _inittab *p;
Nick Coghland5cacbb2015-05-23 22:24:10 +10001260 PyObject *name;
Serhiy Storchaka85b0f5b2016-11-20 10:16:47 +02001261 const char *namestr;
Victor Stinner5eb4f592013-11-14 22:38:52 +01001262 PyObject *mod;
Guido van Rossum25ce5661997-08-02 03:10:38 +00001263
Nick Coghland5cacbb2015-05-23 22:24:10 +10001264 name = PyObject_GetAttrString(spec, "name");
1265 if (name == NULL) {
1266 return NULL;
1267 }
1268
Victor Stinner5eb4f592013-11-14 22:38:52 +01001269 mod = _PyImport_FindExtensionObject(name, name);
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001270 if (mod || _PyErr_Occurred(tstate)) {
Nick Coghland5cacbb2015-05-23 22:24:10 +10001271 Py_DECREF(name);
Raymond Hettingerf0afe772016-08-31 08:44:11 -07001272 Py_XINCREF(mod);
Nick Coghland5cacbb2015-05-23 22:24:10 +10001273 return mod;
1274 }
1275
1276 namestr = PyUnicode_AsUTF8(name);
1277 if (namestr == NULL) {
1278 Py_DECREF(name);
1279 return NULL;
1280 }
Guido van Rossum25ce5661997-08-02 03:10:38 +00001281
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001282 PyObject *modules = tstate->interp->modules;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001283 for (p = PyImport_Inittab; p->name != NULL; p++) {
Antoine Pitrou6c40eb72012-01-18 20:16:09 +01001284 PyModuleDef *def;
Serhiy Storchakaf4934ea2016-11-16 10:17:58 +02001285 if (_PyUnicode_EqualToASCIIString(name, p->name)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001286 if (p->initfunc == NULL) {
Nick Coghland5cacbb2015-05-23 22:24:10 +10001287 /* Cannot re-init internal module ("sys" or "builtins") */
1288 mod = PyImport_AddModule(namestr);
1289 Py_DECREF(name);
1290 return mod;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001291 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001292 mod = (*p->initfunc)();
Nick Coghland5cacbb2015-05-23 22:24:10 +10001293 if (mod == NULL) {
1294 Py_DECREF(name);
1295 return NULL;
1296 }
1297 if (PyObject_TypeCheck(mod, &PyModuleDef_Type)) {
1298 Py_DECREF(name);
1299 return PyModule_FromDefAndSpec((PyModuleDef*)mod, spec);
1300 } else {
1301 /* Remember pointer to module init function. */
1302 def = PyModule_GetDef(mod);
Christian Heimesa78b6272016-09-09 00:25:03 +02001303 if (def == NULL) {
1304 Py_DECREF(name);
1305 return NULL;
1306 }
Nick Coghland5cacbb2015-05-23 22:24:10 +10001307 def->m_base.m_init = p->initfunc;
Eric Snowd393c1b2017-09-14 12:18:12 -06001308 if (_PyImport_FixupExtensionObject(mod, name, name,
1309 modules) < 0) {
Nick Coghland5cacbb2015-05-23 22:24:10 +10001310 Py_DECREF(name);
1311 return NULL;
1312 }
1313 Py_DECREF(name);
1314 return mod;
1315 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001316 }
1317 }
Nick Coghland5cacbb2015-05-23 22:24:10 +10001318 Py_DECREF(name);
1319 Py_RETURN_NONE;
Guido van Rossum7f133ed1991-02-19 12:23:57 +00001320}
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001321
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001322
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001323/* Frozen modules */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001324
Benjamin Peterson6fba3db2013-03-18 23:13:31 -07001325static const struct _frozen *
Victor Stinner53dc7352011-03-20 01:50:21 +01001326find_frozen(PyObject *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001327{
Benjamin Peterson6fba3db2013-03-18 23:13:31 -07001328 const struct _frozen *p;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001329
Victor Stinner53dc7352011-03-20 01:50:21 +01001330 if (name == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001331 return NULL;
Benjamin Petersond968e272008-11-05 22:48:33 +00001332
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001333 for (p = PyImport_FrozenModules; ; p++) {
1334 if (p->name == NULL)
1335 return NULL;
Serhiy Storchakaf4934ea2016-11-16 10:17:58 +02001336 if (_PyUnicode_EqualToASCIIString(name, p->name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001337 break;
1338 }
1339 return p;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001340}
1341
Guido van Rossum79f25d91997-04-29 20:08:16 +00001342static PyObject *
Victor Stinner53dc7352011-03-20 01:50:21 +01001343get_frozen_object(PyObject *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001344{
Benjamin Peterson6fba3db2013-03-18 23:13:31 -07001345 const struct _frozen *p = find_frozen(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001346 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001347
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001348 if (p == NULL) {
1349 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01001350 "No such frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001351 name);
1352 return NULL;
1353 }
1354 if (p->code == NULL) {
1355 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01001356 "Excluded frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001357 name);
1358 return NULL;
1359 }
1360 size = p->size;
1361 if (size < 0)
1362 size = -size;
Serhiy Storchakac6792272013-10-19 21:03:34 +03001363 return PyMarshal_ReadObjectFromString((const char *)p->code, size);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001364}
1365
Brett Cannon8d110132009-03-15 02:20:16 +00001366static PyObject *
Victor Stinner53dc7352011-03-20 01:50:21 +01001367is_frozen_package(PyObject *name)
Brett Cannon8d110132009-03-15 02:20:16 +00001368{
Benjamin Peterson6fba3db2013-03-18 23:13:31 -07001369 const struct _frozen *p = find_frozen(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001370 int size;
Brett Cannon8d110132009-03-15 02:20:16 +00001371
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001372 if (p == NULL) {
1373 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01001374 "No such frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001375 name);
1376 return NULL;
1377 }
Brett Cannon8d110132009-03-15 02:20:16 +00001378
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001379 size = p->size;
Brett Cannon8d110132009-03-15 02:20:16 +00001380
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001381 if (size < 0)
1382 Py_RETURN_TRUE;
1383 else
1384 Py_RETURN_FALSE;
Brett Cannon8d110132009-03-15 02:20:16 +00001385}
1386
1387
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001388/* Initialize a frozen module.
Brett Cannon3c2ac442009-03-08 20:49:47 +00001389 Return 1 for success, 0 if the module is not found, and -1 with
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001390 an exception set if the initialization failed.
1391 This function is also used from frozenmain.c */
Guido van Rossum0b344901995-02-07 15:35:27 +00001392
1393int
Victor Stinner53dc7352011-03-20 01:50:21 +01001394PyImport_ImportFrozenModuleObject(PyObject *name)
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001395{
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001396 PyThreadState *tstate = _PyThreadState_GET();
Benjamin Peterson6fba3db2013-03-18 23:13:31 -07001397 const struct _frozen *p;
Brett Cannon18fc4e72014-04-04 10:01:46 -04001398 PyObject *co, *m, *d;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001399 int ispackage;
1400 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001401
Victor Stinner53dc7352011-03-20 01:50:21 +01001402 p = find_frozen(name);
1403
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001404 if (p == NULL)
1405 return 0;
1406 if (p->code == NULL) {
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001407 _PyErr_Format(tstate, PyExc_ImportError,
1408 "Excluded frozen object named %R",
1409 name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001410 return -1;
1411 }
1412 size = p->size;
1413 ispackage = (size < 0);
1414 if (ispackage)
1415 size = -size;
Serhiy Storchakac6792272013-10-19 21:03:34 +03001416 co = PyMarshal_ReadObjectFromString((const char *)p->code, size);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001417 if (co == NULL)
1418 return -1;
1419 if (!PyCode_Check(co)) {
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001420 _PyErr_Format(tstate, PyExc_TypeError,
1421 "frozen object %R is not a code object",
1422 name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001423 goto err_return;
1424 }
1425 if (ispackage) {
Brett Cannon3e0651b2013-05-31 23:18:39 -04001426 /* Set __path__ to the empty list */
Brett Cannon18fc4e72014-04-04 10:01:46 -04001427 PyObject *l;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001428 int err;
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001429 m = import_add_module(tstate, name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001430 if (m == NULL)
1431 goto err_return;
1432 d = PyModule_GetDict(m);
Brett Cannon3e0651b2013-05-31 23:18:39 -04001433 l = PyList_New(0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001434 if (l == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001435 goto err_return;
1436 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001437 err = PyDict_SetItemString(d, "__path__", l);
1438 Py_DECREF(l);
1439 if (err != 0)
1440 goto err_return;
1441 }
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001442 d = module_dict_for_exec(tstate, name);
Brett Cannon18fc4e72014-04-04 10:01:46 -04001443 if (d == NULL) {
Victor Stinner53dc7352011-03-20 01:50:21 +01001444 goto err_return;
Brett Cannon18fc4e72014-04-04 10:01:46 -04001445 }
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001446 m = exec_code_in_module(tstate, name, d, co);
1447 if (m == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001448 goto err_return;
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001449 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001450 Py_DECREF(co);
1451 Py_DECREF(m);
1452 return 1;
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001453
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001454err_return:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001455 Py_DECREF(co);
1456 return -1;
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001457}
Guido van Rossum74e6a111994-08-29 12:54:38 +00001458
Victor Stinner53dc7352011-03-20 01:50:21 +01001459int
Serhiy Storchakac6792272013-10-19 21:03:34 +03001460PyImport_ImportFrozenModule(const char *name)
Victor Stinner53dc7352011-03-20 01:50:21 +01001461{
1462 PyObject *nameobj;
1463 int ret;
1464 nameobj = PyUnicode_InternFromString(name);
1465 if (nameobj == NULL)
1466 return -1;
1467 ret = PyImport_ImportFrozenModuleObject(nameobj);
1468 Py_DECREF(nameobj);
1469 return ret;
1470}
1471
Guido van Rossum74e6a111994-08-29 12:54:38 +00001472
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001473/* Import a module, either built-in, frozen, or external, and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001474 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum74e6a111994-08-29 12:54:38 +00001475
Guido van Rossum79f25d91997-04-29 20:08:16 +00001476PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001477PyImport_ImportModule(const char *name)
Guido van Rossum74e6a111994-08-29 12:54:38 +00001478{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001479 PyObject *pname;
1480 PyObject *result;
Marc-André Lemburg3c61c352001-02-09 19:40:15 +00001481
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001482 pname = PyUnicode_FromString(name);
1483 if (pname == NULL)
1484 return NULL;
1485 result = PyImport_Import(pname);
1486 Py_DECREF(pname);
1487 return result;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001488}
1489
Joannah Nanjekye37c22202019-09-11 13:47:39 +01001490
Christian Heimes072c0f12008-01-03 23:01:04 +00001491/* Import a module without blocking
1492 *
1493 * At first it tries to fetch the module from sys.modules. If the module was
1494 * never loaded before it loads it with PyImport_ImportModule() unless another
1495 * thread holds the import lock. In the latter case the function raises an
1496 * ImportError instead of blocking.
1497 *
1498 * Returns the module object with incremented ref count.
1499 */
1500PyObject *
1501PyImport_ImportModuleNoBlock(const char *name)
1502{
Antoine Pitrouea3eb882012-05-17 18:55:59 +02001503 return PyImport_ImportModule(name);
Christian Heimes072c0f12008-01-03 23:01:04 +00001504}
1505
Guido van Rossum17fc85f1997-09-06 18:52:03 +00001506
Antoine Pitroubc07a5c2012-07-08 12:01:27 +02001507/* Remove importlib frames from the traceback,
1508 * except in Verbose mode. */
1509static void
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001510remove_importlib_frames(PyThreadState *tstate)
Antoine Pitroubc07a5c2012-07-08 12:01:27 +02001511{
1512 const char *importlib_filename = "<frozen importlib._bootstrap>";
Eric Snow32439d62015-05-02 19:15:18 -06001513 const char *external_filename = "<frozen importlib._bootstrap_external>";
Nick Coghlan42c07662012-07-31 21:14:18 +10001514 const char *remove_frames = "_call_with_frames_removed";
Antoine Pitroubc07a5c2012-07-08 12:01:27 +02001515 int always_trim = 0;
Benjamin Petersonfa873702012-07-09 13:43:53 -07001516 int in_importlib = 0;
Antoine Pitroubc07a5c2012-07-08 12:01:27 +02001517 PyObject *exception, *value, *base_tb, *tb;
Benjamin Petersonfa873702012-07-09 13:43:53 -07001518 PyObject **prev_link, **outer_link = NULL;
Antoine Pitroubc07a5c2012-07-08 12:01:27 +02001519
1520 /* Synopsis: if it's an ImportError, we trim all importlib chunks
Nick Coghlan42c07662012-07-31 21:14:18 +10001521 from the traceback. We always trim chunks
1522 which end with a call to "_call_with_frames_removed". */
Antoine Pitroubc07a5c2012-07-08 12:01:27 +02001523
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001524 _PyErr_Fetch(tstate, &exception, &value, &base_tb);
Victor Stinnerda7933e2020-04-13 03:04:28 +02001525 if (!exception || _PyInterpreterState_GetConfig(tstate->interp)->verbose) {
Antoine Pitroubc07a5c2012-07-08 12:01:27 +02001526 goto done;
Victor Stinner410b85a2019-05-13 17:12:45 +02001527 }
1528
Antoine Pitroubc07a5c2012-07-08 12:01:27 +02001529 if (PyType_IsSubtype((PyTypeObject *) exception,
1530 (PyTypeObject *) PyExc_ImportError))
1531 always_trim = 1;
1532
1533 prev_link = &base_tb;
1534 tb = base_tb;
Antoine Pitroubc07a5c2012-07-08 12:01:27 +02001535 while (tb != NULL) {
1536 PyTracebackObject *traceback = (PyTracebackObject *)tb;
1537 PyObject *next = (PyObject *) traceback->tb_next;
1538 PyFrameObject *frame = traceback->tb_frame;
Victor Stinnera42ca742020-04-28 19:01:31 +02001539 PyCodeObject *code = PyFrame_GetCode(frame);
Antoine Pitroubc07a5c2012-07-08 12:01:27 +02001540 int now_in_importlib;
1541
1542 assert(PyTraceBack_Check(tb));
Serhiy Storchakaf4934ea2016-11-16 10:17:58 +02001543 now_in_importlib = _PyUnicode_EqualToASCIIString(code->co_filename, importlib_filename) ||
1544 _PyUnicode_EqualToASCIIString(code->co_filename, external_filename);
Antoine Pitroubc07a5c2012-07-08 12:01:27 +02001545 if (now_in_importlib && !in_importlib) {
1546 /* This is the link to this chunk of importlib tracebacks */
1547 outer_link = prev_link;
1548 }
1549 in_importlib = now_in_importlib;
1550
1551 if (in_importlib &&
1552 (always_trim ||
Serhiy Storchakaf4934ea2016-11-16 10:17:58 +02001553 _PyUnicode_EqualToASCIIString(code->co_name, remove_frames))) {
Antoine Pitroubc07a5c2012-07-08 12:01:27 +02001554 Py_XINCREF(next);
Serhiy Storchakaec397562016-04-06 09:50:03 +03001555 Py_XSETREF(*outer_link, next);
Antoine Pitroubc07a5c2012-07-08 12:01:27 +02001556 prev_link = outer_link;
1557 }
1558 else {
1559 prev_link = (PyObject **) &traceback->tb_next;
1560 }
Victor Stinner8852ad42020-04-29 01:28:13 +02001561 Py_DECREF(code);
Antoine Pitroubc07a5c2012-07-08 12:01:27 +02001562 tb = next;
1563 }
1564done:
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001565 _PyErr_Restore(tstate, exception, value, base_tb);
Antoine Pitroubc07a5c2012-07-08 12:01:27 +02001566}
1567
1568
Serhiy Storchaka133138a2016-08-02 22:51:21 +03001569static PyObject *
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001570resolve_name(PyThreadState *tstate, PyObject *name, PyObject *globals, int level)
Thomas Woutersf7f438b2006-02-28 16:09:29 +00001571{
Brett Cannonfd074152012-04-14 14:10:13 -04001572 _Py_IDENTIFIER(__package__);
Brett Cannonfd074152012-04-14 14:10:13 -04001573 _Py_IDENTIFIER(__name__);
Serhiy Storchaka133138a2016-08-02 22:51:21 +03001574 _Py_IDENTIFIER(parent);
1575 PyObject *abs_name;
1576 PyObject *package = NULL;
1577 PyObject *spec;
Serhiy Storchaka133138a2016-08-02 22:51:21 +03001578 Py_ssize_t last_dot;
1579 PyObject *base;
1580 int level_up;
1581
1582 if (globals == NULL) {
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001583 _PyErr_SetString(tstate, PyExc_KeyError, "'__name__' not in globals");
Serhiy Storchaka133138a2016-08-02 22:51:21 +03001584 goto error;
1585 }
1586 if (!PyDict_Check(globals)) {
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001587 _PyErr_SetString(tstate, PyExc_TypeError, "globals must be a dict");
Serhiy Storchaka133138a2016-08-02 22:51:21 +03001588 goto error;
1589 }
Serhiy Storchakaa24107b2019-02-25 17:59:46 +02001590 package = _PyDict_GetItemIdWithError(globals, &PyId___package__);
Serhiy Storchaka133138a2016-08-02 22:51:21 +03001591 if (package == Py_None) {
1592 package = NULL;
1593 }
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001594 else if (package == NULL && _PyErr_Occurred(tstate)) {
Serhiy Storchakaa24107b2019-02-25 17:59:46 +02001595 goto error;
1596 }
1597 spec = _PyDict_GetItemIdWithError(globals, &PyId___spec__);
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001598 if (spec == NULL && _PyErr_Occurred(tstate)) {
Serhiy Storchakaa24107b2019-02-25 17:59:46 +02001599 goto error;
1600 }
Serhiy Storchaka133138a2016-08-02 22:51:21 +03001601
1602 if (package != NULL) {
1603 Py_INCREF(package);
1604 if (!PyUnicode_Check(package)) {
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001605 _PyErr_SetString(tstate, PyExc_TypeError,
1606 "package must be a string");
Serhiy Storchaka133138a2016-08-02 22:51:21 +03001607 goto error;
1608 }
1609 else if (spec != NULL && spec != Py_None) {
1610 int equal;
1611 PyObject *parent = _PyObject_GetAttrId(spec, &PyId_parent);
1612 if (parent == NULL) {
1613 goto error;
1614 }
1615
1616 equal = PyObject_RichCompareBool(package, parent, Py_EQ);
1617 Py_DECREF(parent);
1618 if (equal < 0) {
1619 goto error;
1620 }
1621 else if (equal == 0) {
1622 if (PyErr_WarnEx(PyExc_ImportWarning,
1623 "__package__ != __spec__.parent", 1) < 0) {
1624 goto error;
1625 }
1626 }
1627 }
1628 }
1629 else if (spec != NULL && spec != Py_None) {
1630 package = _PyObject_GetAttrId(spec, &PyId_parent);
1631 if (package == NULL) {
1632 goto error;
1633 }
1634 else if (!PyUnicode_Check(package)) {
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001635 _PyErr_SetString(tstate, PyExc_TypeError,
1636 "__spec__.parent must be a string");
Serhiy Storchaka133138a2016-08-02 22:51:21 +03001637 goto error;
1638 }
1639 }
1640 else {
1641 if (PyErr_WarnEx(PyExc_ImportWarning,
1642 "can't resolve package from __spec__ or __package__, "
1643 "falling back on __name__ and __path__", 1) < 0) {
1644 goto error;
1645 }
1646
Serhiy Storchakaa24107b2019-02-25 17:59:46 +02001647 package = _PyDict_GetItemIdWithError(globals, &PyId___name__);
Serhiy Storchaka133138a2016-08-02 22:51:21 +03001648 if (package == NULL) {
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001649 if (!_PyErr_Occurred(tstate)) {
1650 _PyErr_SetString(tstate, PyExc_KeyError,
1651 "'__name__' not in globals");
Serhiy Storchakaa24107b2019-02-25 17:59:46 +02001652 }
Serhiy Storchaka133138a2016-08-02 22:51:21 +03001653 goto error;
1654 }
1655
1656 Py_INCREF(package);
1657 if (!PyUnicode_Check(package)) {
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001658 _PyErr_SetString(tstate, PyExc_TypeError,
1659 "__name__ must be a string");
Serhiy Storchaka133138a2016-08-02 22:51:21 +03001660 goto error;
1661 }
1662
Serhiy Storchakab510e102020-10-26 12:47:57 +02001663 int haspath = _PyDict_ContainsId(globals, &PyId___path__);
1664 if (haspath < 0) {
1665 goto error;
1666 }
1667 if (!haspath) {
Serhiy Storchaka133138a2016-08-02 22:51:21 +03001668 Py_ssize_t dot;
1669
Serhiy Storchakab510e102020-10-26 12:47:57 +02001670 if (PyUnicode_READY(package) < 0) {
Serhiy Storchaka133138a2016-08-02 22:51:21 +03001671 goto error;
1672 }
1673
1674 dot = PyUnicode_FindChar(package, '.',
1675 0, PyUnicode_GET_LENGTH(package), -1);
1676 if (dot == -2) {
1677 goto error;
1678 }
Ben Lewis92420b32019-09-11 20:09:47 +10001679 else if (dot == -1) {
1680 goto no_parent_error;
Serhiy Storchaka133138a2016-08-02 22:51:21 +03001681 }
Ben Lewis92420b32019-09-11 20:09:47 +10001682 PyObject *substr = PyUnicode_Substring(package, 0, dot);
1683 if (substr == NULL) {
1684 goto error;
1685 }
1686 Py_SETREF(package, substr);
Serhiy Storchaka133138a2016-08-02 22:51:21 +03001687 }
1688 }
1689
1690 last_dot = PyUnicode_GET_LENGTH(package);
1691 if (last_dot == 0) {
Ben Lewis92420b32019-09-11 20:09:47 +10001692 goto no_parent_error;
Serhiy Storchaka133138a2016-08-02 22:51:21 +03001693 }
Serhiy Storchaka133138a2016-08-02 22:51:21 +03001694
1695 for (level_up = 1; level_up < level; level_up += 1) {
1696 last_dot = PyUnicode_FindChar(package, '.', 0, last_dot, -1);
1697 if (last_dot == -2) {
1698 goto error;
1699 }
1700 else if (last_dot == -1) {
Ngalim Siregarc5fa4492019-08-03 12:46:02 +07001701 _PyErr_SetString(tstate, PyExc_ImportError,
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001702 "attempted relative import beyond top-level "
1703 "package");
Serhiy Storchaka133138a2016-08-02 22:51:21 +03001704 goto error;
1705 }
1706 }
1707
1708 base = PyUnicode_Substring(package, 0, last_dot);
1709 Py_DECREF(package);
1710 if (base == NULL || PyUnicode_GET_LENGTH(name) == 0) {
1711 return base;
1712 }
1713
1714 abs_name = PyUnicode_FromFormat("%U.%U", base, name);
1715 Py_DECREF(base);
1716 return abs_name;
1717
Ben Lewis92420b32019-09-11 20:09:47 +10001718 no_parent_error:
1719 _PyErr_SetString(tstate, PyExc_ImportError,
1720 "attempted relative import "
1721 "with no known parent package");
1722
Serhiy Storchaka133138a2016-08-02 22:51:21 +03001723 error:
1724 Py_XDECREF(package);
1725 return NULL;
1726}
1727
Neil Schemenauereea3cc12017-12-03 09:26:03 -08001728static PyObject *
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001729import_find_and_load(PyThreadState *tstate, PyObject *abs_name)
Neil Schemenauereea3cc12017-12-03 09:26:03 -08001730{
1731 _Py_IDENTIFIER(_find_and_load);
1732 PyObject *mod = NULL;
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001733 PyInterpreterState *interp = tstate->interp;
Victor Stinnerda7933e2020-04-13 03:04:28 +02001734 int import_time = _PyInterpreterState_GetConfig(interp)->import_time;
Neil Schemenauereea3cc12017-12-03 09:26:03 -08001735 static int import_level;
1736 static _PyTime_t accumulated;
1737
1738 _PyTime_t t1 = 0, accumulated_copy = accumulated;
1739
Steve Dowerb82e17e2019-05-23 08:45:22 -07001740 PyObject *sys_path = PySys_GetObject("path");
1741 PyObject *sys_meta_path = PySys_GetObject("meta_path");
1742 PyObject *sys_path_hooks = PySys_GetObject("path_hooks");
Victor Stinner1c1e68c2020-03-27 15:11:45 +01001743 if (_PySys_Audit(tstate, "import", "OOOOO",
1744 abs_name, Py_None, sys_path ? sys_path : Py_None,
1745 sys_meta_path ? sys_meta_path : Py_None,
1746 sys_path_hooks ? sys_path_hooks : Py_None) < 0) {
Steve Dowerb82e17e2019-05-23 08:45:22 -07001747 return NULL;
1748 }
1749
1750
Neil Schemenauereea3cc12017-12-03 09:26:03 -08001751 /* XOptions is initialized after first some imports.
1752 * So we can't have negative cache before completed initialization.
1753 * Anyway, importlib._find_and_load is much slower than
1754 * _PyDict_GetItemIdWithError().
1755 */
1756 if (import_time) {
1757 static int header = 1;
1758 if (header) {
1759 fputs("import time: self [us] | cumulative | imported package\n",
1760 stderr);
1761 header = 0;
1762 }
1763
1764 import_level++;
1765 t1 = _PyTime_GetPerfCounter();
1766 accumulated = 0;
1767 }
1768
1769 if (PyDTrace_IMPORT_FIND_LOAD_START_ENABLED())
Andy Lesterfc2d8d62020-03-30 15:19:14 -05001770 PyDTrace_IMPORT_FIND_LOAD_START(PyUnicode_AsUTF8(abs_name));
Neil Schemenauereea3cc12017-12-03 09:26:03 -08001771
1772 mod = _PyObject_CallMethodIdObjArgs(interp->importlib,
1773 &PyId__find_and_load, abs_name,
1774 interp->import_func, NULL);
1775
1776 if (PyDTrace_IMPORT_FIND_LOAD_DONE_ENABLED())
Andy Lesterfc2d8d62020-03-30 15:19:14 -05001777 PyDTrace_IMPORT_FIND_LOAD_DONE(PyUnicode_AsUTF8(abs_name),
Neil Schemenauereea3cc12017-12-03 09:26:03 -08001778 mod != NULL);
1779
1780 if (import_time) {
1781 _PyTime_t cum = _PyTime_GetPerfCounter() - t1;
1782
1783 import_level--;
1784 fprintf(stderr, "import time: %9ld | %10ld | %*s%s\n",
1785 (long)_PyTime_AsMicroseconds(cum - accumulated, _PyTime_ROUND_CEILING),
1786 (long)_PyTime_AsMicroseconds(cum, _PyTime_ROUND_CEILING),
1787 import_level*2, "", PyUnicode_AsUTF8(abs_name));
1788
1789 accumulated = accumulated_copy + cum;
1790 }
1791
1792 return mod;
1793}
1794
Serhiy Storchaka133138a2016-08-02 22:51:21 +03001795PyObject *
Joannah Nanjekye37c22202019-09-11 13:47:39 +01001796PyImport_GetModule(PyObject *name)
1797{
1798 PyThreadState *tstate = _PyThreadState_GET();
1799 PyObject *mod;
1800
1801 mod = import_get_module(tstate, name);
1802 if (mod != NULL && mod != Py_None) {
1803 if (import_ensure_initialized(tstate, mod, name) < 0) {
1804 Py_DECREF(mod);
1805 remove_importlib_frames(tstate);
1806 return NULL;
1807 }
1808 }
1809 return mod;
1810}
1811
1812PyObject *
Serhiy Storchaka133138a2016-08-02 22:51:21 +03001813PyImport_ImportModuleLevelObject(PyObject *name, PyObject *globals,
1814 PyObject *locals, PyObject *fromlist,
1815 int level)
1816{
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001817 PyThreadState *tstate = _PyThreadState_GET();
Brett Cannonfd074152012-04-14 14:10:13 -04001818 _Py_IDENTIFIER(_handle_fromlist);
Brett Cannonfd074152012-04-14 14:10:13 -04001819 PyObject *abs_name = NULL;
Brett Cannonfd074152012-04-14 14:10:13 -04001820 PyObject *final_mod = NULL;
1821 PyObject *mod = NULL;
1822 PyObject *package = NULL;
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001823 PyInterpreterState *interp = tstate->interp;
Serhiy Storchakafa494fd2015-05-30 17:45:22 +03001824 int has_from;
Brett Cannonfd074152012-04-14 14:10:13 -04001825
Brett Cannonfd074152012-04-14 14:10:13 -04001826 if (name == NULL) {
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001827 _PyErr_SetString(tstate, PyExc_ValueError, "Empty module name");
Brett Cannonfd074152012-04-14 14:10:13 -04001828 goto error;
1829 }
1830
1831 /* The below code is importlib.__import__() & _gcd_import(), ported to C
1832 for added performance. */
1833
1834 if (!PyUnicode_Check(name)) {
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001835 _PyErr_SetString(tstate, PyExc_TypeError,
1836 "module name must be a string");
Brett Cannonfd074152012-04-14 14:10:13 -04001837 goto error;
1838 }
Serhiy Storchaka133138a2016-08-02 22:51:21 +03001839 if (PyUnicode_READY(name) < 0) {
Brett Cannonfd074152012-04-14 14:10:13 -04001840 goto error;
1841 }
1842 if (level < 0) {
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001843 _PyErr_SetString(tstate, PyExc_ValueError, "level must be >= 0");
Brett Cannonfd074152012-04-14 14:10:13 -04001844 goto error;
1845 }
Brett Cannon849113a2016-01-22 15:25:50 -08001846
Serhiy Storchaka133138a2016-08-02 22:51:21 +03001847 if (level > 0) {
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001848 abs_name = resolve_name(tstate, name, globals, level);
Serhiy Storchaka133138a2016-08-02 22:51:21 +03001849 if (abs_name == NULL)
Brett Cannon9fa81262016-01-22 16:39:02 -08001850 goto error;
Brett Cannonfd074152012-04-14 14:10:13 -04001851 }
1852 else { /* level == 0 */
1853 if (PyUnicode_GET_LENGTH(name) == 0) {
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001854 _PyErr_SetString(tstate, PyExc_ValueError, "Empty module name");
Brett Cannonfd074152012-04-14 14:10:13 -04001855 goto error;
1856 }
Brett Cannonfd074152012-04-14 14:10:13 -04001857 abs_name = name;
1858 Py_INCREF(abs_name);
1859 }
1860
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001861 mod = import_get_module(tstate, abs_name);
1862 if (mod == NULL && _PyErr_Occurred(tstate)) {
Stefan Krah027b09c2019-03-25 21:50:58 +01001863 goto error;
1864 }
1865
Serhiy Storchakab4baace2017-07-06 08:09:03 +03001866 if (mod != NULL && mod != Py_None) {
Joannah Nanjekye37c22202019-09-11 13:47:39 +01001867 if (import_ensure_initialized(tstate, mod, name) < 0) {
1868 goto error;
Antoine Pitrouea3eb882012-05-17 18:55:59 +02001869 }
Brett Cannonfd074152012-04-14 14:10:13 -04001870 }
1871 else {
Neil Schemenauer11cc2892017-12-07 16:24:59 -08001872 Py_XDECREF(mod);
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001873 mod = import_find_and_load(tstate, abs_name);
Brett Cannonfd074152012-04-14 14:10:13 -04001874 if (mod == NULL) {
Antoine Pitrouea3eb882012-05-17 18:55:59 +02001875 goto error;
Brett Cannonfd074152012-04-14 14:10:13 -04001876 }
1877 }
1878
Serhiy Storchaka133138a2016-08-02 22:51:21 +03001879 has_from = 0;
1880 if (fromlist != NULL && fromlist != Py_None) {
1881 has_from = PyObject_IsTrue(fromlist);
1882 if (has_from < 0)
1883 goto error;
1884 }
Serhiy Storchakafa494fd2015-05-30 17:45:22 +03001885 if (!has_from) {
Victor Stinner744c34e2016-05-20 11:36:13 +02001886 Py_ssize_t len = PyUnicode_GET_LENGTH(name);
1887 if (level == 0 || len > 0) {
1888 Py_ssize_t dot;
Brett Cannonfd074152012-04-14 14:10:13 -04001889
Victor Stinner744c34e2016-05-20 11:36:13 +02001890 dot = PyUnicode_FindChar(name, '.', 0, len, 1);
1891 if (dot == -2) {
Antoine Pitrouea3eb882012-05-17 18:55:59 +02001892 goto error;
Brett Cannonfd074152012-04-14 14:10:13 -04001893 }
1894
Victor Stinner744c34e2016-05-20 11:36:13 +02001895 if (dot == -1) {
Antoine Pitrou6efa50a2012-05-07 21:41:59 +02001896 /* No dot in module name, simple exit */
Antoine Pitrou6efa50a2012-05-07 21:41:59 +02001897 final_mod = mod;
1898 Py_INCREF(mod);
Antoine Pitrouea3eb882012-05-17 18:55:59 +02001899 goto error;
Antoine Pitrou6efa50a2012-05-07 21:41:59 +02001900 }
1901
Brett Cannonfd074152012-04-14 14:10:13 -04001902 if (level == 0) {
Victor Stinner744c34e2016-05-20 11:36:13 +02001903 PyObject *front = PyUnicode_Substring(name, 0, dot);
1904 if (front == NULL) {
1905 goto error;
1906 }
1907
Serhiy Storchaka133138a2016-08-02 22:51:21 +03001908 final_mod = PyImport_ImportModuleLevelObject(front, NULL, NULL, NULL, 0);
Antoine Pitroub78174c2012-05-06 17:15:23 +02001909 Py_DECREF(front);
Brett Cannonfd074152012-04-14 14:10:13 -04001910 }
1911 else {
Victor Stinner744c34e2016-05-20 11:36:13 +02001912 Py_ssize_t cut_off = len - dot;
Antoine Pitrou22a1d172012-04-16 22:06:21 +02001913 Py_ssize_t abs_name_len = PyUnicode_GET_LENGTH(abs_name);
Brett Cannon49f8d8b2012-04-14 21:50:00 -04001914 PyObject *to_return = PyUnicode_Substring(abs_name, 0,
Brett Cannonfd074152012-04-14 14:10:13 -04001915 abs_name_len - cut_off);
Antoine Pitrou22a1d172012-04-16 22:06:21 +02001916 if (to_return == NULL) {
Antoine Pitrouea3eb882012-05-17 18:55:59 +02001917 goto error;
Antoine Pitrou22a1d172012-04-16 22:06:21 +02001918 }
Brett Cannonfd074152012-04-14 14:10:13 -04001919
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001920 final_mod = import_get_module(tstate, to_return);
Serhiy Storchaka133138a2016-08-02 22:51:21 +03001921 Py_DECREF(to_return);
Brett Cannon49f8d8b2012-04-14 21:50:00 -04001922 if (final_mod == NULL) {
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001923 if (!_PyErr_Occurred(tstate)) {
1924 _PyErr_Format(tstate, PyExc_KeyError,
1925 "%R not in sys.modules as expected",
1926 to_return);
Stefan Krah027b09c2019-03-25 21:50:58 +01001927 }
Serhiy Storchaka133138a2016-08-02 22:51:21 +03001928 goto error;
Brett Cannon49f8d8b2012-04-14 21:50:00 -04001929 }
Brett Cannonfd074152012-04-14 14:10:13 -04001930 }
1931 }
1932 else {
1933 final_mod = mod;
1934 Py_INCREF(mod);
1935 }
1936 }
1937 else {
Serhiy Storchaka4e244252018-03-11 10:52:37 +02001938 PyObject *path;
1939 if (_PyObject_LookupAttrId(mod, &PyId___path__, &path) < 0) {
1940 goto error;
1941 }
1942 if (path) {
1943 Py_DECREF(path);
1944 final_mod = _PyObject_CallMethodIdObjArgs(
1945 interp->importlib, &PyId__handle_fromlist,
1946 mod, fromlist, interp->import_func, NULL);
1947 }
1948 else {
1949 final_mod = mod;
1950 Py_INCREF(mod);
1951 }
Brett Cannonfd074152012-04-14 14:10:13 -04001952 }
Antoine Pitrou6efa50a2012-05-07 21:41:59 +02001953
Brett Cannonfd074152012-04-14 14:10:13 -04001954 error:
1955 Py_XDECREF(abs_name);
Brett Cannonfd074152012-04-14 14:10:13 -04001956 Py_XDECREF(mod);
1957 Py_XDECREF(package);
Victor Stinner410b85a2019-05-13 17:12:45 +02001958 if (final_mod == NULL) {
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001959 remove_importlib_frames(tstate);
Victor Stinner410b85a2019-05-13 17:12:45 +02001960 }
Brett Cannonfd074152012-04-14 14:10:13 -04001961 return final_mod;
Guido van Rossum75acc9c1998-03-03 22:26:50 +00001962}
1963
Victor Stinnerfe93faf2011-03-14 15:54:52 -04001964PyObject *
Benjamin Peterson04778a82011-05-25 09:29:00 -05001965PyImport_ImportModuleLevel(const char *name, PyObject *globals, PyObject *locals,
Victor Stinnerfe93faf2011-03-14 15:54:52 -04001966 PyObject *fromlist, int level)
1967{
1968 PyObject *nameobj, *mod;
1969 nameobj = PyUnicode_FromString(name);
1970 if (nameobj == NULL)
1971 return NULL;
1972 mod = PyImport_ImportModuleLevelObject(nameobj, globals, locals,
1973 fromlist, level);
1974 Py_DECREF(nameobj);
1975 return mod;
1976}
1977
1978
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001979/* Re-import a module of any kind and return its module object, WITH
1980 INCREMENTED REFERENCE COUNT */
1981
Guido van Rossum79f25d91997-04-29 20:08:16 +00001982PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001983PyImport_ReloadModule(PyObject *m)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001984{
Robert Rouhanif40bd462020-05-01 16:28:06 -07001985 _Py_IDENTIFIER(importlib);
Brett Cannon62228db2012-04-29 14:38:11 -04001986 _Py_IDENTIFIER(reload);
1987 PyObject *reloaded_module = NULL;
Robert Rouhanif40bd462020-05-01 16:28:06 -07001988 PyObject *importlib = _PyImport_GetModuleId(&PyId_importlib);
1989 if (importlib == NULL) {
Stefan Krah027b09c2019-03-25 21:50:58 +01001990 if (PyErr_Occurred()) {
1991 return NULL;
1992 }
1993
Robert Rouhanif40bd462020-05-01 16:28:06 -07001994 importlib = PyImport_ImportModule("importlib");
1995 if (importlib == NULL) {
Brett Cannon62228db2012-04-29 14:38:11 -04001996 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001997 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001998 }
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001999
Robert Rouhanif40bd462020-05-01 16:28:06 -07002000 reloaded_module = _PyObject_CallMethodIdOneArg(importlib, &PyId_reload, m);
2001 Py_DECREF(importlib);
Brett Cannon62228db2012-04-29 14:38:11 -04002002 return reloaded_module;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002003}
2004
2005
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002006/* Higher-level import emulator which emulates the "import" statement
2007 more accurately -- it invokes the __import__() function from the
2008 builtins of the current globals. This means that the import is
2009 done using whatever import hooks are installed in the current
Brett Cannonbc2eff32010-09-19 21:39:02 +00002010 environment.
Guido van Rossum6058eb41998-12-21 19:51:00 +00002011 A dummy list ["__doc__"] is passed as the 4th argument so that
Neal Norwitz80e7f272007-08-26 06:45:23 +00002012 e.g. PyImport_Import(PyUnicode_FromString("win32com.client.gencache"))
Guido van Rossum6058eb41998-12-21 19:51:00 +00002013 will return <module "gencache"> instead of <module "win32com">. */
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002014
2015PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002016PyImport_Import(PyObject *module_name)
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002017{
Victor Stinner0a28f8d2019-06-19 02:54:39 +02002018 PyThreadState *tstate = _PyThreadState_GET();
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002019 static PyObject *silly_list = NULL;
2020 static PyObject *builtins_str = NULL;
2021 static PyObject *import_str = NULL;
2022 PyObject *globals = NULL;
2023 PyObject *import = NULL;
2024 PyObject *builtins = NULL;
2025 PyObject *r = NULL;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002026
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002027 /* Initialize constant string objects */
2028 if (silly_list == NULL) {
2029 import_str = PyUnicode_InternFromString("__import__");
2030 if (import_str == NULL)
2031 return NULL;
2032 builtins_str = PyUnicode_InternFromString("__builtins__");
2033 if (builtins_str == NULL)
2034 return NULL;
Brett Cannonbc2eff32010-09-19 21:39:02 +00002035 silly_list = PyList_New(0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002036 if (silly_list == NULL)
2037 return NULL;
2038 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002039
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002040 /* Get the builtins from current globals */
2041 globals = PyEval_GetGlobals();
2042 if (globals != NULL) {
2043 Py_INCREF(globals);
2044 builtins = PyObject_GetItem(globals, builtins_str);
2045 if (builtins == NULL)
2046 goto err;
2047 }
2048 else {
2049 /* No globals -- use standard builtins, and fake globals */
2050 builtins = PyImport_ImportModuleLevel("builtins",
2051 NULL, NULL, NULL, 0);
2052 if (builtins == NULL)
2053 return NULL;
2054 globals = Py_BuildValue("{OO}", builtins_str, builtins);
2055 if (globals == NULL)
2056 goto err;
2057 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002058
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002059 /* Get the __import__ function from the builtins */
2060 if (PyDict_Check(builtins)) {
2061 import = PyObject_GetItem(builtins, import_str);
Victor Stinner0a28f8d2019-06-19 02:54:39 +02002062 if (import == NULL) {
2063 _PyErr_SetObject(tstate, PyExc_KeyError, import_str);
2064 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002065 }
2066 else
2067 import = PyObject_GetAttr(builtins, import_str);
2068 if (import == NULL)
2069 goto err;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002070
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002071 /* Call the __import__ function with the proper argument list
Brett Cannonbc2eff32010-09-19 21:39:02 +00002072 Always use absolute import here.
2073 Calling for side-effect of import. */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002074 r = PyObject_CallFunction(import, "OOOOi", module_name, globals,
2075 globals, silly_list, 0, NULL);
Brett Cannonbc2eff32010-09-19 21:39:02 +00002076 if (r == NULL)
2077 goto err;
2078 Py_DECREF(r);
2079
Victor Stinner0a28f8d2019-06-19 02:54:39 +02002080 r = import_get_module(tstate, module_name);
2081 if (r == NULL && !_PyErr_Occurred(tstate)) {
2082 _PyErr_SetObject(tstate, PyExc_KeyError, module_name);
Serhiy Storchaka145541c2017-06-15 20:54:38 +03002083 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002084
2085 err:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002086 Py_XDECREF(globals);
2087 Py_XDECREF(builtins);
2088 Py_XDECREF(import);
Tim Peters50d8d372001-02-28 05:34:27 +00002089
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002090 return r;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002091}
2092
Brett Cannon4caa61d2014-01-09 19:03:32 -05002093/*[clinic input]
2094_imp.extension_suffixes
2095
2096Returns the list of file suffixes used to identify extension modules.
2097[clinic start generated code]*/
2098
Brett Cannon4caa61d2014-01-09 19:03:32 -05002099static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03002100_imp_extension_suffixes_impl(PyObject *module)
2101/*[clinic end generated code: output=0bf346e25a8f0cd3 input=ecdeeecfcb6f839e]*/
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002102{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002103 PyObject *list;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002104
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002105 list = PyList_New(0);
2106 if (list == NULL)
2107 return NULL;
Brett Cannon2657df42012-05-04 15:20:40 -04002108#ifdef HAVE_DYNAMIC_LOADING
Stéphane Wirtel0d765e32019-03-20 00:37:20 +01002109 const char *suffix;
2110 unsigned int index = 0;
2111
Brett Cannon2657df42012-05-04 15:20:40 -04002112 while ((suffix = _PyImport_DynLoadFiletab[index])) {
2113 PyObject *item = PyUnicode_FromString(suffix);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002114 if (item == NULL) {
2115 Py_DECREF(list);
2116 return NULL;
2117 }
2118 if (PyList_Append(list, item) < 0) {
2119 Py_DECREF(list);
2120 Py_DECREF(item);
2121 return NULL;
2122 }
2123 Py_DECREF(item);
Brett Cannon2657df42012-05-04 15:20:40 -04002124 index += 1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002125 }
Brett Cannon2657df42012-05-04 15:20:40 -04002126#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002127 return list;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002128}
2129
Brett Cannon4caa61d2014-01-09 19:03:32 -05002130/*[clinic input]
Brett Cannon4caa61d2014-01-09 19:03:32 -05002131_imp.init_frozen
2132
2133 name: unicode
2134 /
2135
2136Initializes a frozen module.
2137[clinic start generated code]*/
2138
Brett Cannon4caa61d2014-01-09 19:03:32 -05002139static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03002140_imp_init_frozen_impl(PyObject *module, PyObject *name)
2141/*[clinic end generated code: output=fc0511ed869fd69c input=13019adfc04f3fb3]*/
Brett Cannon4caa61d2014-01-09 19:03:32 -05002142{
Victor Stinner0a28f8d2019-06-19 02:54:39 +02002143 PyThreadState *tstate = _PyThreadState_GET();
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002144 int ret;
2145 PyObject *m;
Brett Cannon4caa61d2014-01-09 19:03:32 -05002146
Victor Stinner53dc7352011-03-20 01:50:21 +01002147 ret = PyImport_ImportFrozenModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002148 if (ret < 0)
2149 return NULL;
2150 if (ret == 0) {
Serhiy Storchaka228b12e2017-01-23 09:47:21 +02002151 Py_RETURN_NONE;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002152 }
Victor Stinner0a28f8d2019-06-19 02:54:39 +02002153 m = import_add_module(tstate, name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002154 Py_XINCREF(m);
2155 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002156}
2157
Brett Cannon4caa61d2014-01-09 19:03:32 -05002158/*[clinic input]
2159_imp.get_frozen_object
2160
2161 name: unicode
2162 /
2163
2164Create a code object for a frozen module.
2165[clinic start generated code]*/
2166
Brett Cannon4caa61d2014-01-09 19:03:32 -05002167static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03002168_imp_get_frozen_object_impl(PyObject *module, PyObject *name)
2169/*[clinic end generated code: output=2568cc5b7aa0da63 input=ed689bc05358fdbd]*/
Brett Cannon4caa61d2014-01-09 19:03:32 -05002170{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002171 return get_frozen_object(name);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002172}
2173
Brett Cannon4caa61d2014-01-09 19:03:32 -05002174/*[clinic input]
2175_imp.is_frozen_package
2176
2177 name: unicode
2178 /
2179
2180Returns True if the module name is of a frozen package.
2181[clinic start generated code]*/
2182
Brett Cannon4caa61d2014-01-09 19:03:32 -05002183static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03002184_imp_is_frozen_package_impl(PyObject *module, PyObject *name)
2185/*[clinic end generated code: output=e70cbdb45784a1c9 input=81b6cdecd080fbb8]*/
Brett Cannon4caa61d2014-01-09 19:03:32 -05002186{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002187 return is_frozen_package(name);
Brett Cannon8d110132009-03-15 02:20:16 +00002188}
2189
Brett Cannon4caa61d2014-01-09 19:03:32 -05002190/*[clinic input]
2191_imp.is_builtin
2192
2193 name: unicode
2194 /
2195
2196Returns True if the module name corresponds to a built-in module.
2197[clinic start generated code]*/
2198
Guido van Rossum79f25d91997-04-29 20:08:16 +00002199static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03002200_imp_is_builtin_impl(PyObject *module, PyObject *name)
2201/*[clinic end generated code: output=3bfd1162e2d3be82 input=86befdac021dd1c7]*/
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002202{
Brett Cannon4caa61d2014-01-09 19:03:32 -05002203 return PyLong_FromLong(is_builtin(name));
2204}
2205
2206/*[clinic input]
2207_imp.is_frozen
2208
2209 name: unicode
2210 /
2211
2212Returns True if the module name corresponds to a frozen module.
2213[clinic start generated code]*/
2214
Brett Cannon4caa61d2014-01-09 19:03:32 -05002215static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03002216_imp_is_frozen_impl(PyObject *module, PyObject *name)
2217/*[clinic end generated code: output=01f408f5ec0f2577 input=7301dbca1897d66b]*/
Brett Cannon4caa61d2014-01-09 19:03:32 -05002218{
Benjamin Peterson6fba3db2013-03-18 23:13:31 -07002219 const struct _frozen *p;
Brett Cannon4caa61d2014-01-09 19:03:32 -05002220
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002221 p = find_frozen(name);
2222 return PyBool_FromLong((long) (p == NULL ? 0 : p->size));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002223}
2224
Larry Hastings1df0b352015-08-24 19:53:56 -07002225/* Common implementation for _imp.exec_dynamic and _imp.exec_builtin */
2226static int
2227exec_builtin_or_dynamic(PyObject *mod) {
2228 PyModuleDef *def;
2229 void *state;
2230
2231 if (!PyModule_Check(mod)) {
2232 return 0;
2233 }
2234
2235 def = PyModule_GetDef(mod);
2236 if (def == NULL) {
Larry Hastings1df0b352015-08-24 19:53:56 -07002237 return 0;
2238 }
Brett Cannon52794db2016-09-07 17:00:43 -07002239
Larry Hastings1df0b352015-08-24 19:53:56 -07002240 state = PyModule_GetState(mod);
Larry Hastings1df0b352015-08-24 19:53:56 -07002241 if (state) {
2242 /* Already initialized; skip reload */
2243 return 0;
2244 }
Brett Cannon52794db2016-09-07 17:00:43 -07002245
Larry Hastings1df0b352015-08-24 19:53:56 -07002246 return PyModule_ExecDef(mod, def);
2247}
2248
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002249#ifdef HAVE_DYNAMIC_LOADING
2250
Brett Cannon4caa61d2014-01-09 19:03:32 -05002251/*[clinic input]
Nick Coghland5cacbb2015-05-23 22:24:10 +10002252_imp.create_dynamic
Brett Cannon4caa61d2014-01-09 19:03:32 -05002253
Nick Coghland5cacbb2015-05-23 22:24:10 +10002254 spec: object
Brett Cannon4caa61d2014-01-09 19:03:32 -05002255 file: object = NULL
2256 /
2257
Nick Coghland5cacbb2015-05-23 22:24:10 +10002258Create an extension module.
Brett Cannon4caa61d2014-01-09 19:03:32 -05002259[clinic start generated code]*/
2260
Brett Cannon4caa61d2014-01-09 19:03:32 -05002261static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03002262_imp_create_dynamic_impl(PyObject *module, PyObject *spec, PyObject *file)
2263/*[clinic end generated code: output=83249b827a4fde77 input=c31b954f4cf4e09d]*/
Brett Cannon4caa61d2014-01-09 19:03:32 -05002264{
Nick Coghland5cacbb2015-05-23 22:24:10 +10002265 PyObject *mod, *name, *path;
Victor Stinnerfefd70c2011-03-14 15:54:07 -04002266 FILE *fp;
2267
Nick Coghland5cacbb2015-05-23 22:24:10 +10002268 name = PyObject_GetAttrString(spec, "name");
2269 if (name == NULL) {
2270 return NULL;
2271 }
2272
2273 path = PyObject_GetAttrString(spec, "origin");
2274 if (path == NULL) {
2275 Py_DECREF(name);
2276 return NULL;
2277 }
2278
2279 mod = _PyImport_FindExtensionObject(name, path);
Serhiy Storchaka8905fcc2018-12-11 08:38:03 +02002280 if (mod != NULL || PyErr_Occurred()) {
Nick Coghland5cacbb2015-05-23 22:24:10 +10002281 Py_DECREF(name);
2282 Py_DECREF(path);
Serhiy Storchaka8905fcc2018-12-11 08:38:03 +02002283 Py_XINCREF(mod);
Nick Coghland5cacbb2015-05-23 22:24:10 +10002284 return mod;
2285 }
2286
Brett Cannon4caa61d2014-01-09 19:03:32 -05002287 if (file != NULL) {
2288 fp = _Py_fopen_obj(path, "r");
Victor Stinnere9ddbf62011-03-22 10:46:35 +01002289 if (fp == NULL) {
Nick Coghland5cacbb2015-05-23 22:24:10 +10002290 Py_DECREF(name);
Brett Cannon4caa61d2014-01-09 19:03:32 -05002291 Py_DECREF(path);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002292 return NULL;
Victor Stinnere9ddbf62011-03-22 10:46:35 +01002293 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002294 }
Victor Stinnerfefd70c2011-03-14 15:54:07 -04002295 else
2296 fp = NULL;
Nick Coghland5cacbb2015-05-23 22:24:10 +10002297
2298 mod = _PyImport_LoadDynamicModuleWithSpec(spec, fp);
2299
2300 Py_DECREF(name);
Brett Cannon4caa61d2014-01-09 19:03:32 -05002301 Py_DECREF(path);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002302 if (fp)
2303 fclose(fp);
Victor Stinnerfefd70c2011-03-14 15:54:07 -04002304 return mod;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002305}
2306
Nick Coghland5cacbb2015-05-23 22:24:10 +10002307/*[clinic input]
2308_imp.exec_dynamic -> int
2309
2310 mod: object
2311 /
2312
2313Initialize an extension module.
2314[clinic start generated code]*/
2315
2316static int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03002317_imp_exec_dynamic_impl(PyObject *module, PyObject *mod)
2318/*[clinic end generated code: output=f5720ac7b465877d input=9fdbfcb250280d3a]*/
Nick Coghland5cacbb2015-05-23 22:24:10 +10002319{
Larry Hastings1df0b352015-08-24 19:53:56 -07002320 return exec_builtin_or_dynamic(mod);
Nick Coghland5cacbb2015-05-23 22:24:10 +10002321}
2322
2323
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002324#endif /* HAVE_DYNAMIC_LOADING */
2325
Larry Hastings7726ac92014-01-31 22:03:12 -08002326/*[clinic input]
Larry Hastings1df0b352015-08-24 19:53:56 -07002327_imp.exec_builtin -> int
2328
2329 mod: object
2330 /
2331
2332Initialize a built-in module.
2333[clinic start generated code]*/
2334
2335static int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03002336_imp_exec_builtin_impl(PyObject *module, PyObject *mod)
2337/*[clinic end generated code: output=0262447b240c038e input=7beed5a2f12a60ca]*/
Larry Hastings1df0b352015-08-24 19:53:56 -07002338{
2339 return exec_builtin_or_dynamic(mod);
2340}
2341
Benjamin Peterson42aa93b2017-12-09 10:26:52 -08002342/*[clinic input]
2343_imp.source_hash
2344
2345 key: long
2346 source: Py_buffer
2347[clinic start generated code]*/
2348
2349static PyObject *
2350_imp_source_hash_impl(PyObject *module, long key, Py_buffer *source)
2351/*[clinic end generated code: output=edb292448cf399ea input=9aaad1e590089789]*/
2352{
Benjamin Peterson83620772017-12-09 12:18:56 -08002353 union {
2354 uint64_t x;
2355 char data[sizeof(uint64_t)];
2356 } hash;
2357 hash.x = _Py_KeyedHash((uint64_t)key, source->buf, source->len);
Benjamin Peterson42aa93b2017-12-09 10:26:52 -08002358#if !PY_LITTLE_ENDIAN
2359 // Force to little-endian. There really ought to be a succinct standard way
2360 // to do this.
Benjamin Peterson83620772017-12-09 12:18:56 -08002361 for (size_t i = 0; i < sizeof(hash.data)/2; i++) {
2362 char tmp = hash.data[i];
2363 hash.data[i] = hash.data[sizeof(hash.data) - i - 1];
2364 hash.data[sizeof(hash.data) - i - 1] = tmp;
Benjamin Peterson42aa93b2017-12-09 10:26:52 -08002365 }
Benjamin Peterson42aa93b2017-12-09 10:26:52 -08002366#endif
Benjamin Peterson83620772017-12-09 12:18:56 -08002367 return PyBytes_FromStringAndSize(hash.data, sizeof(hash.data));
Benjamin Peterson42aa93b2017-12-09 10:26:52 -08002368}
2369
Barry Warsaw28a691b2010-04-17 00:19:56 +00002370
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002371PyDoc_STRVAR(doc_imp,
Brett Cannon6f44d662012-04-15 16:08:47 -04002372"(Extremely) low-level import machinery bits as used by importlib and imp.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002373
Guido van Rossum79f25d91997-04-29 20:08:16 +00002374static PyMethodDef imp_methods[] = {
Brett Cannon4caa61d2014-01-09 19:03:32 -05002375 _IMP_EXTENSION_SUFFIXES_METHODDEF
2376 _IMP_LOCK_HELD_METHODDEF
2377 _IMP_ACQUIRE_LOCK_METHODDEF
2378 _IMP_RELEASE_LOCK_METHODDEF
2379 _IMP_GET_FROZEN_OBJECT_METHODDEF
2380 _IMP_IS_FROZEN_PACKAGE_METHODDEF
Nick Coghland5cacbb2015-05-23 22:24:10 +10002381 _IMP_CREATE_BUILTIN_METHODDEF
Brett Cannon4caa61d2014-01-09 19:03:32 -05002382 _IMP_INIT_FROZEN_METHODDEF
2383 _IMP_IS_BUILTIN_METHODDEF
2384 _IMP_IS_FROZEN_METHODDEF
Nick Coghland5cacbb2015-05-23 22:24:10 +10002385 _IMP_CREATE_DYNAMIC_METHODDEF
2386 _IMP_EXEC_DYNAMIC_METHODDEF
Larry Hastings1df0b352015-08-24 19:53:56 -07002387 _IMP_EXEC_BUILTIN_METHODDEF
Brett Cannon4caa61d2014-01-09 19:03:32 -05002388 _IMP__FIX_CO_FILENAME_METHODDEF
Benjamin Peterson42aa93b2017-12-09 10:26:52 -08002389 _IMP_SOURCE_HASH_METHODDEF
Brett Cannon4caa61d2014-01-09 19:03:32 -05002390 {NULL, NULL} /* sentinel */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002391};
2392
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002393
Martin v. Löwis1a214512008-06-11 05:26:20 +00002394static struct PyModuleDef impmodule = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002395 PyModuleDef_HEAD_INIT,
Brett Cannon6f44d662012-04-15 16:08:47 -04002396 "_imp",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002397 doc_imp,
2398 0,
2399 imp_methods,
2400 NULL,
2401 NULL,
2402 NULL,
2403 NULL
Martin v. Löwis1a214512008-06-11 05:26:20 +00002404};
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002405
Jason Tishler6bc06ec2003-09-04 11:59:50 +00002406PyMODINIT_FUNC
Benjamin Petersonc65ef772018-01-29 11:33:57 -08002407PyInit__imp(void)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002408{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002409 PyObject *m, *d;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002410
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002411 m = PyModule_Create(&impmodule);
Victor Stinner410b85a2019-05-13 17:12:45 +02002412 if (m == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002413 goto failure;
Victor Stinner410b85a2019-05-13 17:12:45 +02002414 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002415 d = PyModule_GetDict(m);
Victor Stinner410b85a2019-05-13 17:12:45 +02002416 if (d == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002417 goto failure;
Victor Stinner410b85a2019-05-13 17:12:45 +02002418 }
2419
Victor Stinnerda7933e2020-04-13 03:04:28 +02002420 const wchar_t *mode = _Py_GetConfig()->check_hash_pycs_mode;
Victor Stinner410b85a2019-05-13 17:12:45 +02002421 PyObject *pyc_mode = PyUnicode_FromWideChar(mode, -1);
Benjamin Peterson42aa93b2017-12-09 10:26:52 -08002422 if (pyc_mode == NULL) {
2423 goto failure;
2424 }
2425 if (PyDict_SetItemString(d, "check_hash_based_pycs", pyc_mode) < 0) {
2426 Py_DECREF(pyc_mode);
2427 goto failure;
2428 }
2429 Py_DECREF(pyc_mode);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002430
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002431 return m;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002432 failure:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002433 Py_XDECREF(m);
2434 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002435}
Guido van Rossum09cae1f1998-05-14 02:32:54 +00002436
2437
Guido van Rossumb18618d2000-05-03 23:44:39 +00002438/* API for embedding applications that want to add their own entries
2439 to the table of built-in modules. This should normally be called
2440 *before* Py_Initialize(). When the table resize fails, -1 is
2441 returned and the existing table is unchanged.
Guido van Rossum09cae1f1998-05-14 02:32:54 +00002442
2443 After a similar function by Just van Rossum. */
2444
2445int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002446PyImport_ExtendInittab(struct _inittab *newtab)
Guido van Rossum09cae1f1998-05-14 02:32:54 +00002447{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002448 struct _inittab *p;
Benjamin Peterson0c644fc2017-12-15 23:42:33 -08002449 size_t i, n;
Victor Stinner92a3c6f2017-12-06 18:12:59 +01002450 int res = 0;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00002451
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002452 /* Count the number of entries in both tables */
2453 for (n = 0; newtab[n].name != NULL; n++)
2454 ;
2455 if (n == 0)
2456 return 0; /* Nothing to do */
2457 for (i = 0; PyImport_Inittab[i].name != NULL; i++)
2458 ;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00002459
Victor Stinner92a3c6f2017-12-06 18:12:59 +01002460 /* Force default raw memory allocator to get a known allocator to be able
2461 to release the memory in _PyImport_Fini2() */
2462 PyMemAllocatorEx old_alloc;
2463 _PyMem_SetDefaultAllocator(PYMEM_DOMAIN_RAW, &old_alloc);
2464
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002465 /* Allocate new memory for the combined table */
Benjamin Peterson0c644fc2017-12-15 23:42:33 -08002466 p = NULL;
2467 if (i + n <= SIZE_MAX / sizeof(struct _inittab) - 1) {
Victor Stinner92a3c6f2017-12-06 18:12:59 +01002468 size_t size = sizeof(struct _inittab) * (i + n + 1);
2469 p = PyMem_RawRealloc(inittab_copy, size);
2470 }
Victor Stinner92a3c6f2017-12-06 18:12:59 +01002471 if (p == NULL) {
2472 res = -1;
2473 goto done;
2474 }
Guido van Rossum09cae1f1998-05-14 02:32:54 +00002475
Victor Stinner92a3c6f2017-12-06 18:12:59 +01002476 /* Copy the tables into the new memory at the first call
2477 to PyImport_ExtendInittab(). */
2478 if (inittab_copy != PyImport_Inittab) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002479 memcpy(p, PyImport_Inittab, (i+1) * sizeof(struct _inittab));
Victor Stinner92a3c6f2017-12-06 18:12:59 +01002480 }
2481 memcpy(p + i, newtab, (n + 1) * sizeof(struct _inittab));
2482 PyImport_Inittab = inittab_copy = p;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00002483
Victor Stinner92a3c6f2017-12-06 18:12:59 +01002484done:
2485 PyMem_SetAllocator(PYMEM_DOMAIN_RAW, &old_alloc);
2486 return res;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00002487}
2488
2489/* Shorthand to add a single entry given a name and a function */
2490
2491int
Brett Cannona826f322009-04-02 03:41:46 +00002492PyImport_AppendInittab(const char *name, PyObject* (*initfunc)(void))
Guido van Rossum09cae1f1998-05-14 02:32:54 +00002493{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002494 struct _inittab newtab[2];
Guido van Rossum09cae1f1998-05-14 02:32:54 +00002495
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002496 memset(newtab, '\0', sizeof newtab);
Guido van Rossum09cae1f1998-05-14 02:32:54 +00002497
Serhiy Storchaka20b39b22014-09-28 11:27:24 +03002498 newtab[0].name = name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002499 newtab[0].initfunc = initfunc;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00002500
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002501 return PyImport_ExtendInittab(newtab);
Guido van Rossum09cae1f1998-05-14 02:32:54 +00002502}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002503
2504#ifdef __cplusplus
2505}
2506#endif