blob: 045b6d0a9bf6f973bac84061b73b6ac911dc8cdf [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"
11#include "pycore_pymem.h"
12#include "pycore_pystate.h"
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000013#include "errcode.h"
Guido van Rossumc405b7b1991-06-04 19:39:42 +000014#include "marshal.h"
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000015#include "code.h"
Antoine Pitroubc07a5c2012-07-08 12:01:27 +020016#include "frameobject.h"
Guido van Rossumd8bac6d1992-02-26 15:19:13 +000017#include "osdefs.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
Brett Cannon4caa61d2014-01-09 19:03:32 -050042/*[clinic input]
43module _imp
44[clinic start generated code]*/
Serhiy Storchaka1009bf12015-04-03 23:53:51 +030045/*[clinic end generated code: output=da39a3ee5e6b4b0d input=9c332475d8686284]*/
Brett Cannonfd4d0502014-05-30 11:21:14 -040046
47#include "clinic/import.c.h"
Brett Cannon4caa61d2014-01-09 19:03:32 -050048
Guido van Rossum1ae940a1995-01-02 19:04:15 +000049/* Initialize things */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000050
Victor Stinner331a6a52019-05-27 16:39:22 +020051PyStatus
Victor Stinnerb45d2592019-06-20 00:05:23 +020052_PyImportHooks_Init(PyThreadState *tstate)
Just van Rossum52e14d62002-12-30 22:08:05 +000053{
Brett Cannonfd074152012-04-14 14:10:13 -040054 PyObject *v, *path_hooks = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000055 int err = 0;
Just van Rossum52e14d62002-12-30 22:08:05 +000056
Brett Cannonfd074152012-04-14 14:10:13 -040057 /* adding sys.path_hooks and sys.path_importer_cache */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000058 v = PyList_New(0);
59 if (v == NULL)
60 goto error;
61 err = PySys_SetObject("meta_path", v);
62 Py_DECREF(v);
63 if (err)
64 goto error;
65 v = PyDict_New();
66 if (v == NULL)
67 goto error;
68 err = PySys_SetObject("path_importer_cache", v);
69 Py_DECREF(v);
70 if (err)
71 goto error;
72 path_hooks = PyList_New(0);
73 if (path_hooks == NULL)
74 goto error;
75 err = PySys_SetObject("path_hooks", path_hooks);
76 if (err) {
Victor Stinnerf7e5b562017-11-15 15:48:08 -080077 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000078 }
Brett Cannonfd074152012-04-14 14:10:13 -040079 Py_DECREF(path_hooks);
Victor Stinner331a6a52019-05-27 16:39:22 +020080 return _PyStatus_OK();
Victor Stinnerf7e5b562017-11-15 15:48:08 -080081
82 error:
Victor Stinnerb45d2592019-06-20 00:05:23 +020083 _PyErr_Print(tstate);
Victor Stinner331a6a52019-05-27 16:39:22 +020084 return _PyStatus_ERR("initializing sys.meta_path, sys.path_hooks, "
Victor Stinnerf7e5b562017-11-15 15:48:08 -080085 "or path_importer_cache failed");
Brett Cannonfd074152012-04-14 14:10:13 -040086}
87
Victor Stinner331a6a52019-05-27 16:39:22 +020088PyStatus
Victor Stinner0a28f8d2019-06-19 02:54:39 +020089_PyImportZip_Init(PyThreadState *tstate)
Brett Cannonfd074152012-04-14 14:10:13 -040090{
ukwksk5e6312c2018-05-15 04:10:52 +090091 PyObject *path_hooks, *zipimport;
Brett Cannonfd074152012-04-14 14:10:13 -040092 int err = 0;
93
94 path_hooks = PySys_GetObject("path_hooks");
Victor Stinner1e53bba2013-07-16 22:26:05 +020095 if (path_hooks == NULL) {
Victor Stinner0a28f8d2019-06-19 02:54:39 +020096 _PyErr_SetString(tstate, PyExc_RuntimeError,
97 "unable to get sys.path_hooks");
Brett Cannonfd074152012-04-14 14:10:13 -040098 goto error;
Victor Stinner1e53bba2013-07-16 22:26:05 +020099 }
Brett Cannonfd074152012-04-14 14:10:13 -0400100
Victor Stinner0a28f8d2019-06-19 02:54:39 +0200101 int verbose = tstate->interp->config.verbose;
Victor Stinner410b85a2019-05-13 17:12:45 +0200102 if (verbose) {
Brett Cannonfd074152012-04-14 14:10:13 -0400103 PySys_WriteStderr("# installing zipimport hook\n");
Victor Stinner410b85a2019-05-13 17:12:45 +0200104 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000105
ukwksk5e6312c2018-05-15 04:10:52 +0900106 zipimport = PyImport_ImportModule("zipimport");
107 if (zipimport == NULL) {
Victor Stinner0a28f8d2019-06-19 02:54:39 +0200108 _PyErr_Clear(tstate); /* No zip import module -- okay */
Victor Stinner410b85a2019-05-13 17:12:45 +0200109 if (verbose) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000110 PySys_WriteStderr("# can't import zipimport\n");
Victor Stinner410b85a2019-05-13 17:12:45 +0200111 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000112 }
113 else {
Martin v. Löwisbd928fe2011-10-14 10:20:37 +0200114 _Py_IDENTIFIER(zipimporter);
ukwksk5e6312c2018-05-15 04:10:52 +0900115 PyObject *zipimporter = _PyObject_GetAttrId(zipimport,
Martin v. Löwis1ee1b6f2011-10-10 18:11:30 +0200116 &PyId_zipimporter);
ukwksk5e6312c2018-05-15 04:10:52 +0900117 Py_DECREF(zipimport);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000118 if (zipimporter == NULL) {
Victor Stinner0a28f8d2019-06-19 02:54:39 +0200119 _PyErr_Clear(tstate); /* No zipimporter object -- okay */
Victor Stinner410b85a2019-05-13 17:12:45 +0200120 if (verbose) {
121 PySys_WriteStderr("# can't import zipimport.zipimporter\n");
122 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000123 }
124 else {
Brett Cannon8923a4d2012-04-24 22:03:46 -0400125 /* sys.path_hooks.insert(0, zipimporter) */
126 err = PyList_Insert(path_hooks, 0, zipimporter);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000127 Py_DECREF(zipimporter);
Brett Cannonfd074152012-04-14 14:10:13 -0400128 if (err < 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000129 goto error;
Brett Cannonfd074152012-04-14 14:10:13 -0400130 }
Victor Stinner410b85a2019-05-13 17:12:45 +0200131 if (verbose) {
132 PySys_WriteStderr("# installed zipimport hook\n");
133 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000134 }
135 }
Brett Cannonfd074152012-04-14 14:10:13 -0400136
Victor Stinner331a6a52019-05-27 16:39:22 +0200137 return _PyStatus_OK();
Brett Cannonfd074152012-04-14 14:10:13 -0400138
139 error:
140 PyErr_Print();
Victor Stinner331a6a52019-05-27 16:39:22 +0200141 return _PyStatus_ERR("initializing zipimport failed");
Just van Rossum52e14d62002-12-30 22:08:05 +0000142}
143
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000144/* Locking primitives to prevent parallel imports of the same module
145 in different threads to return with a partially loaded module.
146 These calls are serialized by the global interpreter lock. */
147
Guido van Rossum49b56061998-10-01 20:42:43 +0000148#include "pythread.h"
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000149
Guido van Rossum65d5b571998-12-21 19:32:43 +0000150static PyThread_type_lock import_lock = 0;
Serhiy Storchakaaefa7eb2017-03-23 15:48:39 +0200151static unsigned long import_lock_thread = PYTHREAD_INVALID_THREAD_ID;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000152static int import_lock_level = 0;
153
Benjamin Peterson0df35a92009-10-04 20:32:25 +0000154void
155_PyImport_AcquireLock(void)
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000156{
Serhiy Storchakaaefa7eb2017-03-23 15:48:39 +0200157 unsigned long me = PyThread_get_thread_ident();
158 if (me == PYTHREAD_INVALID_THREAD_ID)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000159 return; /* Too bad */
160 if (import_lock == NULL) {
161 import_lock = PyThread_allocate_lock();
162 if (import_lock == NULL)
163 return; /* Nothing much we can do. */
164 }
165 if (import_lock_thread == me) {
166 import_lock_level++;
167 return;
168 }
Serhiy Storchakaaefa7eb2017-03-23 15:48:39 +0200169 if (import_lock_thread != PYTHREAD_INVALID_THREAD_ID ||
170 !PyThread_acquire_lock(import_lock, 0))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000171 {
172 PyThreadState *tstate = PyEval_SaveThread();
173 PyThread_acquire_lock(import_lock, 1);
174 PyEval_RestoreThread(tstate);
175 }
Antoine Pitrou202b6062012-12-18 22:18:17 +0100176 assert(import_lock_level == 0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000177 import_lock_thread = me;
178 import_lock_level = 1;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000179}
180
Benjamin Peterson0df35a92009-10-04 20:32:25 +0000181int
182_PyImport_ReleaseLock(void)
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000183{
Serhiy Storchakaaefa7eb2017-03-23 15:48:39 +0200184 unsigned long me = PyThread_get_thread_ident();
185 if (me == PYTHREAD_INVALID_THREAD_ID || import_lock == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000186 return 0; /* Too bad */
187 if (import_lock_thread != me)
188 return -1;
189 import_lock_level--;
Antoine Pitrou202b6062012-12-18 22:18:17 +0100190 assert(import_lock_level >= 0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000191 if (import_lock_level == 0) {
Serhiy Storchakaaefa7eb2017-03-23 15:48:39 +0200192 import_lock_thread = PYTHREAD_INVALID_THREAD_ID;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000193 PyThread_release_lock(import_lock);
194 }
195 return 1;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000196}
197
Antoine Pitrouf7ecfac2017-05-28 11:35:14 +0200198/* This function is called from PyOS_AfterFork_Child to ensure that newly
Gregory P. Smith24cec9f2010-03-01 06:18:41 +0000199 created child processes do not share locks with the parent.
200 We now acquire the import lock around fork() calls but on some platforms
201 (Solaris 9 and earlier? see isue7242) that still left us with problems. */
Guido van Rossum8ee3e5a2005-09-14 18:09:42 +0000202
203void
204_PyImport_ReInitLock(void)
205{
Christian Heimes418fd742015-04-19 21:08:42 +0200206 if (import_lock != NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000207 import_lock = PyThread_allocate_lock();
Christian Heimes418fd742015-04-19 21:08:42 +0200208 if (import_lock == NULL) {
209 Py_FatalError("PyImport_ReInitLock failed to create a new lock");
210 }
211 }
Nick Coghlanb2ddf792010-12-02 04:11:46 +0000212 if (import_lock_level > 1) {
213 /* Forked as a side effect of import */
Serhiy Storchakaaefa7eb2017-03-23 15:48:39 +0200214 unsigned long me = PyThread_get_thread_ident();
Brett Cannone4710cf2012-11-15 21:39:36 -0500215 /* The following could fail if the lock is already held, but forking as
216 a side-effect of an import is a) rare, b) nuts, and c) difficult to
217 do thanks to the lock only being held when doing individual module
218 locks per import. */
219 PyThread_acquire_lock(import_lock, NOWAIT_LOCK);
Nick Coghlanb2ddf792010-12-02 04:11:46 +0000220 import_lock_thread = me;
221 import_lock_level--;
222 } else {
Serhiy Storchakaaefa7eb2017-03-23 15:48:39 +0200223 import_lock_thread = PYTHREAD_INVALID_THREAD_ID;
Nick Coghlanb2ddf792010-12-02 04:11:46 +0000224 import_lock_level = 0;
225 }
Guido van Rossum8ee3e5a2005-09-14 18:09:42 +0000226}
227
Brett Cannon4caa61d2014-01-09 19:03:32 -0500228/*[clinic input]
229_imp.lock_held
230
231Return True if the import lock is currently held, else False.
232
233On platforms without threads, return False.
234[clinic start generated code]*/
235
Brett Cannon4caa61d2014-01-09 19:03:32 -0500236static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +0300237_imp_lock_held_impl(PyObject *module)
238/*[clinic end generated code: output=8b89384b5e1963fc input=9b088f9b217d9bdf]*/
Tim Peters69232342001-08-30 05:16:13 +0000239{
Serhiy Storchakaaefa7eb2017-03-23 15:48:39 +0200240 return PyBool_FromLong(import_lock_thread != PYTHREAD_INVALID_THREAD_ID);
Tim Peters69232342001-08-30 05:16:13 +0000241}
242
Brett Cannon4caa61d2014-01-09 19:03:32 -0500243/*[clinic input]
244_imp.acquire_lock
245
246Acquires the interpreter's import lock for the current thread.
247
248This lock should be used by import hooks to ensure thread-safety when importing
249modules. On platforms without threads, this function does nothing.
250[clinic start generated code]*/
251
Brett Cannon4caa61d2014-01-09 19:03:32 -0500252static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +0300253_imp_acquire_lock_impl(PyObject *module)
254/*[clinic end generated code: output=1aff58cb0ee1b026 input=4a2d4381866d5fdc]*/
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000255{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000256 _PyImport_AcquireLock();
Serhiy Storchaka228b12e2017-01-23 09:47:21 +0200257 Py_RETURN_NONE;
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000258}
259
Brett Cannon4caa61d2014-01-09 19:03:32 -0500260/*[clinic input]
261_imp.release_lock
262
263Release the interpreter's import lock.
264
265On platforms without threads, this function does nothing.
266[clinic start generated code]*/
267
Brett Cannon4caa61d2014-01-09 19:03:32 -0500268static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +0300269_imp_release_lock_impl(PyObject *module)
270/*[clinic end generated code: output=7faab6d0be178b0a input=934fb11516dd778b]*/
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000271{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000272 if (_PyImport_ReleaseLock() < 0) {
273 PyErr_SetString(PyExc_RuntimeError,
274 "not holding the import lock");
275 return NULL;
276 }
Serhiy Storchaka228b12e2017-01-23 09:47:21 +0200277 Py_RETURN_NONE;
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000278}
279
Antoine Pitrou8db076c2011-10-30 19:13:55 +0100280void
281_PyImport_Fini(void)
282{
Serhiy Storchaka505ff752014-02-09 13:33:53 +0200283 Py_CLEAR(extensions);
Antoine Pitrou8db076c2011-10-30 19:13:55 +0100284 if (import_lock != NULL) {
285 PyThread_free_lock(import_lock);
286 import_lock = NULL;
287 }
Antoine Pitrou8db076c2011-10-30 19:13:55 +0100288}
289
Victor Stinner92a3c6f2017-12-06 18:12:59 +0100290void
291_PyImport_Fini2(void)
292{
293 /* Use the same memory allocator than PyImport_ExtendInittab(). */
294 PyMemAllocatorEx old_alloc;
295 _PyMem_SetDefaultAllocator(PYMEM_DOMAIN_RAW, &old_alloc);
296
297 /* Free memory allocated by PyImport_ExtendInittab() */
298 PyMem_RawFree(inittab_copy);
299
300 PyMem_SetAllocator(PYMEM_DOMAIN_RAW, &old_alloc);
301}
302
Guido van Rossum25ce5661997-08-02 03:10:38 +0000303/* Helper for sys */
304
305PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000306PyImport_GetModuleDict(void)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000307{
Victor Stinnercaba55b2018-08-03 15:33:52 +0200308 PyInterpreterState *interp = _PyInterpreterState_GET_UNSAFE();
Eric Snow3f9eee62017-09-15 16:35:20 -0600309 if (interp->modules == NULL) {
Eric Snow93c92f72017-09-13 23:46:04 -0700310 Py_FatalError("PyImport_GetModuleDict: no module dictionary!");
Eric Snow3f9eee62017-09-15 16:35:20 -0600311 }
Eric Snow93c92f72017-09-13 23:46:04 -0700312 return interp->modules;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000313}
314
Eric Snowd393c1b2017-09-14 12:18:12 -0600315/* In some corner cases it is important to be sure that the import
316 machinery has been initialized (or not cleaned up yet). For
317 example, see issue #4236 and PyModule_Create2(). */
318
319int
320_PyImport_IsInitialized(PyInterpreterState *interp)
321{
322 if (interp->modules == NULL)
323 return 0;
324 return 1;
325}
Guido van Rossum3f5da241990-12-20 15:06:42 +0000326
Eric Snow3f9eee62017-09-15 16:35:20 -0600327PyObject *
328_PyImport_GetModuleId(struct _Py_Identifier *nameid)
329{
330 PyObject *name = _PyUnicode_FromId(nameid); /* borrowed */
331 if (name == NULL) {
332 return NULL;
333 }
334 return PyImport_GetModule(name);
335}
336
337int
338_PyImport_SetModule(PyObject *name, PyObject *m)
339{
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
386 _Py_IDENTIFIER(__spec__);
387 _Py_IDENTIFIER(_lock_unlock_module);
388
389 /* Optimization: only call _bootstrap._lock_unlock_module() if
390 __spec__._initializing is true.
391 NOTE: because of this, initializing must be set *before*
392 stuffing the new module in sys.modules.
393 */
394 spec = _PyObject_GetAttrId(mod, &PyId___spec__);
395 int busy = _PyModuleSpec_IsInitializing(spec);
396 Py_XDECREF(spec);
397 if (busy) {
398 /* Wait until module is done importing. */
399 PyObject *value = _PyObject_CallMethodIdOneArg(
400 interp->importlib, &PyId__lock_unlock_module, name);
401 if (value == NULL) {
402 return -1;
403 }
404 Py_DECREF(value);
405 }
406 return 0;
Victor Stinner0a28f8d2019-06-19 02:54:39 +0200407}
408
409
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000410/* List of names to clear in sys */
Serhiy Storchaka2d06e842015-12-25 19:53:18 +0200411static const char * const sys_deletes[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000412 "path", "argv", "ps1", "ps2",
413 "last_type", "last_value", "last_traceback",
414 "path_hooks", "path_importer_cache", "meta_path",
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200415 "__interactivehook__",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000416 NULL
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000417};
418
Serhiy Storchaka2d06e842015-12-25 19:53:18 +0200419static const char * const sys_files[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000420 "stdin", "__stdin__",
421 "stdout", "__stdout__",
422 "stderr", "__stderr__",
423 NULL
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000424};
425
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000426/* Un-initialize things, as good as we can */
Guido van Rossum3f5da241990-12-20 15:06:42 +0000427
Guido van Rossum3f5da241990-12-20 15:06:42 +0000428void
Victor Stinner987a0dc2019-06-19 10:36:10 +0200429_PyImport_Cleanup(PyThreadState *tstate)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000430{
Victor Stinner0a28f8d2019-06-19 02:54:39 +0200431 PyInterpreterState *interp = tstate->interp;
432 PyObject *modules = interp->modules;
433 if (modules == NULL) {
434 /* Already done */
435 return;
436 }
Guido van Rossum758eec01998-01-19 21:58:26 +0000437
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000438 /* Delete some special variables first. These are common
439 places where user values hide and people complain when their
440 destructors fail. Since the modules containing them are
441 deleted *last* of all, they would come too late in the normal
442 destruction order. Sigh. */
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000443
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200444 /* XXX Perhaps these precautions are obsolete. Who knows? */
445
Victor Stinner331a6a52019-05-27 16:39:22 +0200446 int verbose = interp->config.verbose;
Victor Stinner410b85a2019-05-13 17:12:45 +0200447 if (verbose) {
Serhiy Storchaka013bb912014-02-10 18:21:34 +0200448 PySys_WriteStderr("# clear builtins._\n");
Victor Stinner410b85a2019-05-13 17:12:45 +0200449 }
Serhiy Storchakae9d94942018-04-25 20:58:40 +0300450 if (PyDict_SetItemString(interp->builtins, "_", Py_None) < 0) {
Serhiy Storchakac1a68322018-04-29 22:16:30 +0300451 PyErr_WriteUnraisable(NULL);
Serhiy Storchakae9d94942018-04-25 20:58:40 +0300452 }
Serhiy Storchaka013bb912014-02-10 18:21:34 +0200453
Victor Stinner0a28f8d2019-06-19 02:54:39 +0200454 const char * const *p;
Serhiy Storchaka013bb912014-02-10 18:21:34 +0200455 for (p = sys_deletes; *p != NULL; p++) {
Victor Stinner410b85a2019-05-13 17:12:45 +0200456 if (verbose) {
Serhiy Storchaka013bb912014-02-10 18:21:34 +0200457 PySys_WriteStderr("# clear sys.%s\n", *p);
Victor Stinner410b85a2019-05-13 17:12:45 +0200458 }
Serhiy Storchakae9d94942018-04-25 20:58:40 +0300459 if (PyDict_SetItemString(interp->sysdict, *p, Py_None) < 0) {
Serhiy Storchakac1a68322018-04-29 22:16:30 +0300460 PyErr_WriteUnraisable(NULL);
Serhiy Storchakae9d94942018-04-25 20:58:40 +0300461 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000462 }
Serhiy Storchaka013bb912014-02-10 18:21:34 +0200463 for (p = sys_files; *p != NULL; p+=2) {
Victor Stinner410b85a2019-05-13 17:12:45 +0200464 if (verbose) {
Serhiy Storchaka013bb912014-02-10 18:21:34 +0200465 PySys_WriteStderr("# restore sys.%s\n", *p);
Victor Stinner410b85a2019-05-13 17:12:45 +0200466 }
Victor Stinner0a28f8d2019-06-19 02:54:39 +0200467 PyObject *value = _PyDict_GetItemStringWithError(interp->sysdict,
468 *(p+1));
Serhiy Storchakaa24107b2019-02-25 17:59:46 +0200469 if (value == NULL) {
Victor Stinner0a28f8d2019-06-19 02:54:39 +0200470 if (_PyErr_Occurred(tstate)) {
Serhiy Storchakaa24107b2019-02-25 17:59:46 +0200471 PyErr_WriteUnraisable(NULL);
472 }
Serhiy Storchaka013bb912014-02-10 18:21:34 +0200473 value = Py_None;
Serhiy Storchakaa24107b2019-02-25 17:59:46 +0200474 }
Serhiy Storchakae9d94942018-04-25 20:58:40 +0300475 if (PyDict_SetItemString(interp->sysdict, *p, value) < 0) {
Serhiy Storchakac1a68322018-04-29 22:16:30 +0300476 PyErr_WriteUnraisable(NULL);
Serhiy Storchakae9d94942018-04-25 20:58:40 +0300477 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000478 }
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000479
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200480 /* We prepare a list which will receive (name, weakref) tuples of
481 modules when they are removed from sys.modules. The name is used
482 for diagnosis messages (in verbose mode), while the weakref helps
483 detect those modules which have been held alive. */
Victor Stinner0a28f8d2019-06-19 02:54:39 +0200484 PyObject *weaklist = PyList_New(0);
Serhiy Storchakac1a68322018-04-29 22:16:30 +0300485 if (weaklist == NULL) {
486 PyErr_WriteUnraisable(NULL);
487 }
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200488
Antoine Pitrou79ba3882013-08-06 22:50:15 +0200489#define STORE_MODULE_WEAKREF(name, mod) \
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200490 if (weaklist != NULL) { \
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200491 PyObject *wr = PyWeakref_NewRef(mod, NULL); \
Serhiy Storchakae9d94942018-04-25 20:58:40 +0300492 if (wr) { \
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200493 PyObject *tup = PyTuple_Pack(2, name, wr); \
Serhiy Storchakae9d94942018-04-25 20:58:40 +0300494 if (!tup || PyList_Append(weaklist, tup) < 0) { \
Serhiy Storchakac1a68322018-04-29 22:16:30 +0300495 PyErr_WriteUnraisable(NULL); \
Serhiy Storchakae9d94942018-04-25 20:58:40 +0300496 } \
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200497 Py_XDECREF(tup); \
Serhiy Storchakae9d94942018-04-25 20:58:40 +0300498 Py_DECREF(wr); \
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200499 } \
Serhiy Storchakae9d94942018-04-25 20:58:40 +0300500 else { \
Serhiy Storchakac1a68322018-04-29 22:16:30 +0300501 PyErr_WriteUnraisable(NULL); \
Serhiy Storchakae9d94942018-04-25 20:58:40 +0300502 } \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000503 }
Eric Snow3f9eee62017-09-15 16:35:20 -0600504#define CLEAR_MODULE(name, mod) \
505 if (PyModule_Check(mod)) { \
Victor Stinner410b85a2019-05-13 17:12:45 +0200506 if (verbose && PyUnicode_Check(name)) { \
Eric Snow3f9eee62017-09-15 16:35:20 -0600507 PySys_FormatStderr("# cleanup[2] removing %U\n", name); \
Victor Stinner410b85a2019-05-13 17:12:45 +0200508 } \
Eric Snow3f9eee62017-09-15 16:35:20 -0600509 STORE_MODULE_WEAKREF(name, mod); \
Serhiy Storchakae9d94942018-04-25 20:58:40 +0300510 if (PyObject_SetItem(modules, name, Py_None) < 0) { \
Serhiy Storchakac1a68322018-04-29 22:16:30 +0300511 PyErr_WriteUnraisable(NULL); \
Serhiy Storchakae9d94942018-04-25 20:58:40 +0300512 } \
Eric Snow3f9eee62017-09-15 16:35:20 -0600513 }
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000514
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200515 /* Remove all modules from sys.modules, hoping that garbage collection
516 can reclaim most of them. */
Eric Snow3f9eee62017-09-15 16:35:20 -0600517 if (PyDict_CheckExact(modules)) {
Victor Stinner0a28f8d2019-06-19 02:54:39 +0200518 Py_ssize_t pos = 0;
519 PyObject *key, *value;
Eric Snow3f9eee62017-09-15 16:35:20 -0600520 while (PyDict_Next(modules, &pos, &key, &value)) {
521 CLEAR_MODULE(key, value);
522 }
523 }
524 else {
525 PyObject *iterator = PyObject_GetIter(modules);
526 if (iterator == NULL) {
Serhiy Storchakac1a68322018-04-29 22:16:30 +0300527 PyErr_WriteUnraisable(NULL);
Eric Snow3f9eee62017-09-15 16:35:20 -0600528 }
529 else {
Victor Stinner0a28f8d2019-06-19 02:54:39 +0200530 PyObject *key;
Eric Snow3f9eee62017-09-15 16:35:20 -0600531 while ((key = PyIter_Next(iterator))) {
Victor Stinner0a28f8d2019-06-19 02:54:39 +0200532 PyObject *value = PyObject_GetItem(modules, key);
Eric Snow3f9eee62017-09-15 16:35:20 -0600533 if (value == NULL) {
Serhiy Storchakac1a68322018-04-29 22:16:30 +0300534 PyErr_WriteUnraisable(NULL);
Eric Snow3f9eee62017-09-15 16:35:20 -0600535 continue;
536 }
537 CLEAR_MODULE(key, value);
538 Py_DECREF(value);
539 Py_DECREF(key);
540 }
Serhiy Storchakae9d94942018-04-25 20:58:40 +0300541 if (PyErr_Occurred()) {
Serhiy Storchakac1a68322018-04-29 22:16:30 +0300542 PyErr_WriteUnraisable(NULL);
Serhiy Storchakae9d94942018-04-25 20:58:40 +0300543 }
Eric Snow3f9eee62017-09-15 16:35:20 -0600544 Py_DECREF(iterator);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000545 }
546 }
Guido van Rossum758eec01998-01-19 21:58:26 +0000547
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200548 /* Clear the modules dict. */
Eric Snow3f9eee62017-09-15 16:35:20 -0600549 if (PyDict_CheckExact(modules)) {
550 PyDict_Clear(modules);
551 }
552 else {
553 _Py_IDENTIFIER(clear);
Jeroen Demeyer762f93f2019-07-08 10:19:25 +0200554 if (_PyObject_CallMethodIdNoArgs(modules, &PyId_clear) == NULL) {
Serhiy Storchakac1a68322018-04-29 22:16:30 +0300555 PyErr_WriteUnraisable(NULL);
556 }
Eric Snow3f9eee62017-09-15 16:35:20 -0600557 }
Serhiy Storchaka013bb912014-02-10 18:21:34 +0200558 /* Restore the original builtins dict, to ensure that any
559 user data gets cleared. */
Victor Stinner0a28f8d2019-06-19 02:54:39 +0200560 PyObject *dict = PyDict_Copy(interp->builtins);
Serhiy Storchakac1a68322018-04-29 22:16:30 +0300561 if (dict == NULL) {
562 PyErr_WriteUnraisable(NULL);
563 }
Serhiy Storchaka013bb912014-02-10 18:21:34 +0200564 PyDict_Clear(interp->builtins);
Serhiy Storchakac1a68322018-04-29 22:16:30 +0300565 if (PyDict_Update(interp->builtins, interp->builtins_copy)) {
Victor Stinner0a28f8d2019-06-19 02:54:39 +0200566 _PyErr_Clear(tstate);
Serhiy Storchakac1a68322018-04-29 22:16:30 +0300567 }
Serhiy Storchaka013bb912014-02-10 18:21:34 +0200568 Py_XDECREF(dict);
Antoine Pitrou40322e62013-08-11 00:30:09 +0200569 /* Clear module dict copies stored in the interpreter state */
Victor Stinnerb45d2592019-06-20 00:05:23 +0200570 _PyInterpreterState_ClearModules(interp);
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200571 /* Collect references */
572 _PyGC_CollectNoFail();
Antoine Pitrou5f454a02013-05-06 21:15:57 +0200573 /* Dump GC stats before it's too late, since it uses the warnings
574 machinery. */
Victor Stinner67e0de62019-11-20 11:48:18 +0100575 _PyGC_DumpShutdownStats(tstate);
Antoine Pitrou5f454a02013-05-06 21:15:57 +0200576
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200577 /* Now, if there are any modules left alive, clear their globals to
578 minimize potential leaks. All C extension modules actually end
Serhiy Storchaka013bb912014-02-10 18:21:34 +0200579 up here, since they are kept alive in the interpreter state.
580
581 The special treatment of "builtins" here is because even
582 when it's not referenced as a module, its dictionary is
583 referenced by almost every module's __builtins__. Since
584 deleting a module clears its dictionary (even if there are
585 references left to it), we need to delete the "builtins"
586 module last. Likewise, we don't delete sys until the very
587 end because it is implicitly referenced (e.g. by print). */
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200588 if (weaklist != NULL) {
Serhiy Storchakac93c58b2018-10-29 19:30:16 +0200589 Py_ssize_t i;
590 /* Since dict is ordered in CPython 3.6+, modules are saved in
591 importing order. First clear modules imported later. */
592 for (i = PyList_GET_SIZE(weaklist) - 1; i >= 0; i--) {
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200593 PyObject *tup = PyList_GET_ITEM(weaklist, i);
Antoine Pitrou79ba3882013-08-06 22:50:15 +0200594 PyObject *name = PyTuple_GET_ITEM(tup, 0);
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200595 PyObject *mod = PyWeakref_GET_OBJECT(PyTuple_GET_ITEM(tup, 1));
596 if (mod == Py_None)
597 continue;
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200598 assert(PyModule_Check(mod));
Serhiy Storchaka013bb912014-02-10 18:21:34 +0200599 dict = PyModule_GetDict(mod);
600 if (dict == interp->builtins || dict == interp->sysdict)
601 continue;
602 Py_INCREF(mod);
Victor Stinner410b85a2019-05-13 17:12:45 +0200603 if (verbose && PyUnicode_Check(name)) {
Serhiy Storchaka013bb912014-02-10 18:21:34 +0200604 PySys_FormatStderr("# cleanup[3] wiping %U\n", name);
Victor Stinner410b85a2019-05-13 17:12:45 +0200605 }
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200606 _PyModule_Clear(mod);
607 Py_DECREF(mod);
Antoine Pitrou070cb3c2013-05-08 13:23:25 +0200608 }
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200609 Py_DECREF(weaklist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000610 }
Guido van Rossum758eec01998-01-19 21:58:26 +0000611
Serhiy Storchaka013bb912014-02-10 18:21:34 +0200612 /* Next, delete sys and builtins (in that order) */
Victor Stinner410b85a2019-05-13 17:12:45 +0200613 if (verbose) {
Serhiy Storchaka013bb912014-02-10 18:21:34 +0200614 PySys_FormatStderr("# cleanup[3] wiping sys\n");
Victor Stinner410b85a2019-05-13 17:12:45 +0200615 }
Serhiy Storchaka013bb912014-02-10 18:21:34 +0200616 _PyModule_ClearDict(interp->sysdict);
Victor Stinner410b85a2019-05-13 17:12:45 +0200617 if (verbose) {
Serhiy Storchaka013bb912014-02-10 18:21:34 +0200618 PySys_FormatStderr("# cleanup[3] wiping builtins\n");
Victor Stinner410b85a2019-05-13 17:12:45 +0200619 }
Serhiy Storchaka013bb912014-02-10 18:21:34 +0200620 _PyModule_ClearDict(interp->builtins);
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 Stinnercaba55b2018-08-03 15:33:52 +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
810 int verbose = tstate->interp->config.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
Tim Peters1cd70172004-08-02 03:52:12 +0000905/* Remove name from sys.modules, if it's there. */
906static void
Victor Stinner0a28f8d2019-06-19 02:54:39 +0200907remove_module(PyThreadState *tstate, PyObject *name)
Tim Peters1cd70172004-08-02 03:52:12 +0000908{
Zackery Spytz94a64e92019-05-08 10:31:23 -0600909 PyObject *type, *value, *traceback;
Victor Stinner0a28f8d2019-06-19 02:54:39 +0200910 _PyErr_Fetch(tstate, &type, &value, &traceback);
911
912 PyObject *modules = tstate->interp->modules;
Zackery Spytz94a64e92019-05-08 10:31:23 -0600913 if (!PyMapping_HasKey(modules, name)) {
914 goto out;
915 }
Eric Snow3f9eee62017-09-15 16:35:20 -0600916 if (PyMapping_DelItem(modules, name) < 0) {
Victor Stinner0a28f8d2019-06-19 02:54:39 +0200917 _PyErr_SetString(tstate, PyExc_RuntimeError,
918 "deleting key in sys.modules failed");
919 _PyErr_ChainExceptions(type, value, traceback);
920 return;
Eric Snow3f9eee62017-09-15 16:35:20 -0600921 }
Victor Stinner0a28f8d2019-06-19 02:54:39 +0200922
Zackery Spytz94a64e92019-05-08 10:31:23 -0600923out:
Victor Stinner0a28f8d2019-06-19 02:54:39 +0200924 _PyErr_Restore(tstate, type, value, traceback);
Tim Peters1cd70172004-08-02 03:52:12 +0000925}
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000926
Christian Heimes3b06e532008-01-07 20:12:44 +0000927
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000928/* Execute a code object in a module and return the module object
Tim Peters1cd70172004-08-02 03:52:12 +0000929 * WITH INCREMENTED REFERENCE COUNT. If an error occurs, name is
930 * removed from sys.modules, to avoid leaving damaged module objects
931 * in sys.modules. The caller may wish to restore the original
932 * module object (if any) in this case; PyImport_ReloadModule is an
933 * example.
Barry Warsaw28a691b2010-04-17 00:19:56 +0000934 *
935 * Note that PyImport_ExecCodeModuleWithPathnames() is the preferred, richer
936 * interface. The other two exist primarily for backward compatibility.
Tim Peters1cd70172004-08-02 03:52:12 +0000937 */
Guido van Rossum79f25d91997-04-29 20:08:16 +0000938PyObject *
Serhiy Storchakac6792272013-10-19 21:03:34 +0300939PyImport_ExecCodeModule(const char *name, PyObject *co)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000940{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000941 return PyImport_ExecCodeModuleWithPathnames(
942 name, co, (char *)NULL, (char *)NULL);
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000943}
944
945PyObject *
Serhiy Storchakac6792272013-10-19 21:03:34 +0300946PyImport_ExecCodeModuleEx(const char *name, PyObject *co, const char *pathname)
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000947{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000948 return PyImport_ExecCodeModuleWithPathnames(
949 name, co, pathname, (char *)NULL);
Barry Warsaw28a691b2010-04-17 00:19:56 +0000950}
951
952PyObject *
Serhiy Storchakac6792272013-10-19 21:03:34 +0300953PyImport_ExecCodeModuleWithPathnames(const char *name, PyObject *co,
954 const char *pathname,
955 const char *cpathname)
Barry Warsaw28a691b2010-04-17 00:19:56 +0000956{
Victor Stinner27ee0892011-03-04 12:57:09 +0000957 PyObject *m = NULL;
Eric Snow32439d62015-05-02 19:15:18 -0600958 PyObject *nameobj, *pathobj = NULL, *cpathobj = NULL, *external= NULL;
Victor Stinner27ee0892011-03-04 12:57:09 +0000959
960 nameobj = PyUnicode_FromString(name);
961 if (nameobj == NULL)
962 return NULL;
963
Victor Stinner27ee0892011-03-04 12:57:09 +0000964 if (cpathname != NULL) {
965 cpathobj = PyUnicode_DecodeFSDefault(cpathname);
966 if (cpathobj == NULL)
967 goto error;
Brett Cannona6473f92012-07-13 13:57:03 -0400968 }
969 else
Victor Stinner27ee0892011-03-04 12:57:09 +0000970 cpathobj = NULL;
Brett Cannona6473f92012-07-13 13:57:03 -0400971
972 if (pathname != NULL) {
973 pathobj = PyUnicode_DecodeFSDefault(pathname);
974 if (pathobj == NULL)
975 goto error;
976 }
977 else if (cpathobj != NULL) {
Victor Stinnercaba55b2018-08-03 15:33:52 +0200978 PyInterpreterState *interp = _PyInterpreterState_GET_UNSAFE();
Brett Cannona6473f92012-07-13 13:57:03 -0400979 _Py_IDENTIFIER(_get_sourcefile);
980
981 if (interp == NULL) {
982 Py_FatalError("PyImport_ExecCodeModuleWithPathnames: "
983 "no interpreter!");
984 }
985
Eric Snow32439d62015-05-02 19:15:18 -0600986 external= PyObject_GetAttrString(interp->importlib,
987 "_bootstrap_external");
988 if (external != NULL) {
Jeroen Demeyer59ad1102019-07-11 10:59:05 +0200989 pathobj = _PyObject_CallMethodIdOneArg(
990 external, &PyId__get_sourcefile, cpathobj);
Eric Snow32439d62015-05-02 19:15:18 -0600991 Py_DECREF(external);
992 }
Brett Cannona6473f92012-07-13 13:57:03 -0400993 if (pathobj == NULL)
994 PyErr_Clear();
995 }
996 else
997 pathobj = NULL;
998
Victor Stinner27ee0892011-03-04 12:57:09 +0000999 m = PyImport_ExecCodeModuleObject(nameobj, co, pathobj, cpathobj);
1000error:
1001 Py_DECREF(nameobj);
1002 Py_XDECREF(pathobj);
1003 Py_XDECREF(cpathobj);
1004 return m;
1005}
1006
Brett Cannon18fc4e72014-04-04 10:01:46 -04001007static PyObject *
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001008module_dict_for_exec(PyThreadState *tstate, PyObject *name)
Victor Stinner27ee0892011-03-04 12:57:09 +00001009{
Serhiy Storchakaa24107b2019-02-25 17:59:46 +02001010 _Py_IDENTIFIER(__builtins__);
Brett Cannon18fc4e72014-04-04 10:01:46 -04001011 PyObject *m, *d = NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001012
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001013 m = import_add_module(tstate, name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001014 if (m == NULL)
1015 return NULL;
1016 /* If the module is being reloaded, we get the old module back
1017 and re-use its dict to exec the new code. */
1018 d = PyModule_GetDict(m);
Serhiy Storchakaa24107b2019-02-25 17:59:46 +02001019 if (_PyDict_GetItemIdWithError(d, &PyId___builtins__) == NULL) {
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001020 if (_PyErr_Occurred(tstate) ||
Serhiy Storchakaa24107b2019-02-25 17:59:46 +02001021 _PyDict_SetItemId(d, &PyId___builtins__,
1022 PyEval_GetBuiltins()) != 0)
1023 {
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001024 remove_module(tstate, name);
Brett Cannon18fc4e72014-04-04 10:01:46 -04001025 return NULL;
1026 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001027 }
Brett Cannon18fc4e72014-04-04 10:01:46 -04001028
Eric Snow08197a42014-05-12 17:54:55 -06001029 return d; /* Return a borrowed reference. */
Brett Cannon18fc4e72014-04-04 10:01:46 -04001030}
1031
1032static PyObject *
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001033exec_code_in_module(PyThreadState *tstate, PyObject *name,
1034 PyObject *module_dict, PyObject *code_object)
Brett Cannon18fc4e72014-04-04 10:01:46 -04001035{
Brett Cannon18fc4e72014-04-04 10:01:46 -04001036 PyObject *v, *m;
1037
1038 v = PyEval_EvalCode(code_object, module_dict, module_dict);
1039 if (v == NULL) {
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001040 remove_module(tstate, name);
Brett Cannon18fc4e72014-04-04 10:01:46 -04001041 return NULL;
1042 }
1043 Py_DECREF(v);
1044
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001045 m = import_get_module(tstate, name);
1046 if (m == NULL && !_PyErr_Occurred(tstate)) {
1047 _PyErr_Format(tstate, PyExc_ImportError,
1048 "Loaded module %R not found in sys.modules",
1049 name);
Brett Cannon18fc4e72014-04-04 10:01:46 -04001050 }
1051
Brett Cannon18fc4e72014-04-04 10:01:46 -04001052 return m;
1053}
1054
1055PyObject*
1056PyImport_ExecCodeModuleObject(PyObject *name, PyObject *co, PyObject *pathname,
1057 PyObject *cpathname)
1058{
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001059 PyThreadState *tstate = _PyThreadState_GET();
Eric Snow32439d62015-05-02 19:15:18 -06001060 PyObject *d, *external, *res;
Eric Snow08197a42014-05-12 17:54:55 -06001061 _Py_IDENTIFIER(_fix_up_module);
Brett Cannon18fc4e72014-04-04 10:01:46 -04001062
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001063 d = module_dict_for_exec(tstate, name);
Brett Cannon18fc4e72014-04-04 10:01:46 -04001064 if (d == NULL) {
1065 return NULL;
1066 }
1067
Eric Snow08197a42014-05-12 17:54:55 -06001068 if (pathname == NULL) {
1069 pathname = ((PyCodeObject *)co)->co_filename;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001070 }
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001071 external = PyObject_GetAttrString(tstate->interp->importlib,
1072 "_bootstrap_external");
Eric Snow32439d62015-05-02 19:15:18 -06001073 if (external == NULL)
1074 return NULL;
1075 res = _PyObject_CallMethodIdObjArgs(external,
Eric Snow08197a42014-05-12 17:54:55 -06001076 &PyId__fix_up_module,
1077 d, name, pathname, cpathname, NULL);
Eric Snow32439d62015-05-02 19:15:18 -06001078 Py_DECREF(external);
Eric Snow08197a42014-05-12 17:54:55 -06001079 if (res != NULL) {
Eric Snow58cfdd82014-05-29 12:31:39 -06001080 Py_DECREF(res);
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001081 res = exec_code_in_module(tstate, name, d, co);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001082 }
Eric Snow08197a42014-05-12 17:54:55 -06001083 return res;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001084}
1085
1086
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001087static void
1088update_code_filenames(PyCodeObject *co, PyObject *oldname, PyObject *newname)
1089{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001090 PyObject *constants, *tmp;
1091 Py_ssize_t i, n;
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001092
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001093 if (PyUnicode_Compare(co->co_filename, oldname))
1094 return;
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001095
Serhiy Storchaka576f1322016-01-05 21:27:54 +02001096 Py_INCREF(newname);
Serhiy Storchakaec397562016-04-06 09:50:03 +03001097 Py_XSETREF(co->co_filename, newname);
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001098
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001099 constants = co->co_consts;
1100 n = PyTuple_GET_SIZE(constants);
1101 for (i = 0; i < n; i++) {
1102 tmp = PyTuple_GET_ITEM(constants, i);
1103 if (PyCode_Check(tmp))
1104 update_code_filenames((PyCodeObject *)tmp,
1105 oldname, newname);
1106 }
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001107}
1108
Victor Stinner2f42ae52011-03-20 00:41:24 +01001109static void
1110update_compiled_module(PyCodeObject *co, PyObject *newname)
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001111{
Victor Stinner2f42ae52011-03-20 00:41:24 +01001112 PyObject *oldname;
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001113
Victor Stinner2f42ae52011-03-20 00:41:24 +01001114 if (PyUnicode_Compare(co->co_filename, newname) == 0)
1115 return;
Hirokazu Yamamoto4f447fb2009-03-04 01:52:10 +00001116
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001117 oldname = co->co_filename;
1118 Py_INCREF(oldname);
1119 update_code_filenames(co, oldname, newname);
1120 Py_DECREF(oldname);
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001121}
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001122
Brett Cannon4caa61d2014-01-09 19:03:32 -05001123/*[clinic input]
1124_imp._fix_co_filename
1125
1126 code: object(type="PyCodeObject *", subclass_of="&PyCode_Type")
1127 Code object to change.
1128
1129 path: unicode
1130 File path to use.
1131 /
1132
1133Changes code.co_filename to specify the passed-in file path.
1134[clinic start generated code]*/
1135
Brett Cannon4caa61d2014-01-09 19:03:32 -05001136static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03001137_imp__fix_co_filename_impl(PyObject *module, PyCodeObject *code,
Larry Hastings89964c42015-04-14 18:07:59 -04001138 PyObject *path)
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03001139/*[clinic end generated code: output=1d002f100235587d input=895ba50e78b82f05]*/
Brett Cannon442c9b92011-03-23 16:14:42 -07001140
Brett Cannon4caa61d2014-01-09 19:03:32 -05001141{
Brett Cannona6dec2e2014-01-10 07:43:55 -05001142 update_compiled_module(code, path);
Brett Cannon442c9b92011-03-23 16:14:42 -07001143
1144 Py_RETURN_NONE;
1145}
1146
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001147
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001148/* Forward */
Benjamin Peterson6fba3db2013-03-18 23:13:31 -07001149static const struct _frozen * find_frozen(PyObject *);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001150
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001151
1152/* Helper to test for built-in module */
1153
1154static int
Victor Stinner95872862011-03-07 18:20:56 +01001155is_builtin(PyObject *name)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001156{
Serhiy Storchakaf4934ea2016-11-16 10:17:58 +02001157 int i;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001158 for (i = 0; PyImport_Inittab[i].name != NULL; i++) {
Serhiy Storchakaf4934ea2016-11-16 10:17:58 +02001159 if (_PyUnicode_EqualToASCIIString(name, PyImport_Inittab[i].name)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001160 if (PyImport_Inittab[i].initfunc == NULL)
1161 return -1;
1162 else
1163 return 1;
1164 }
1165 }
1166 return 0;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001167}
1168
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001169
Brett Cannonfdcdd9e2016-07-08 11:00:00 -07001170/* Return a finder object for a sys.path/pkg.__path__ item 'p',
Just van Rossum52e14d62002-12-30 22:08:05 +00001171 possibly by fetching it from the path_importer_cache dict. If it
Thomas Wouters89f507f2006-12-13 04:49:30 +00001172 wasn't yet cached, traverse path_hooks until a hook is found
Just van Rossum52e14d62002-12-30 22:08:05 +00001173 that can handle the path item. Return None if no hook could;
Brett Cannonfdcdd9e2016-07-08 11:00:00 -07001174 this tells our caller that the path based finder could not find
1175 a finder for this path item. Cache the result in
1176 path_importer_cache.
Just van Rossum52e14d62002-12-30 22:08:05 +00001177 Returns a borrowed reference. */
1178
1179static PyObject *
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001180get_path_importer(PyThreadState *tstate, PyObject *path_importer_cache,
1181 PyObject *path_hooks, PyObject *p)
Just van Rossum52e14d62002-12-30 22:08:05 +00001182{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001183 PyObject *importer;
1184 Py_ssize_t j, nhooks;
Just van Rossum52e14d62002-12-30 22:08:05 +00001185
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001186 /* These conditions are the caller's responsibility: */
1187 assert(PyList_Check(path_hooks));
1188 assert(PyDict_Check(path_importer_cache));
Just van Rossum52e14d62002-12-30 22:08:05 +00001189
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001190 nhooks = PyList_Size(path_hooks);
1191 if (nhooks < 0)
1192 return NULL; /* Shouldn't happen */
Just van Rossum52e14d62002-12-30 22:08:05 +00001193
Serhiy Storchakaa24107b2019-02-25 17:59:46 +02001194 importer = PyDict_GetItemWithError(path_importer_cache, p);
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001195 if (importer != NULL || _PyErr_Occurred(tstate))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001196 return importer;
Just van Rossum52e14d62002-12-30 22:08:05 +00001197
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001198 /* set path_importer_cache[p] to None to avoid recursion */
1199 if (PyDict_SetItem(path_importer_cache, p, Py_None) != 0)
1200 return NULL;
Just van Rossum52e14d62002-12-30 22:08:05 +00001201
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001202 for (j = 0; j < nhooks; j++) {
1203 PyObject *hook = PyList_GetItem(path_hooks, j);
1204 if (hook == NULL)
1205 return NULL;
Jeroen Demeyer196a5302019-07-04 12:31:34 +02001206 importer = _PyObject_CallOneArg(hook, p);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001207 if (importer != NULL)
1208 break;
Just van Rossum52e14d62002-12-30 22:08:05 +00001209
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001210 if (!_PyErr_ExceptionMatches(tstate, PyExc_ImportError)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001211 return NULL;
1212 }
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001213 _PyErr_Clear(tstate);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001214 }
1215 if (importer == NULL) {
Brett Cannonaa936422012-04-27 15:30:58 -04001216 return Py_None;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001217 }
1218 if (importer != NULL) {
1219 int err = PyDict_SetItem(path_importer_cache, p, importer);
1220 Py_DECREF(importer);
1221 if (err != 0)
1222 return NULL;
1223 }
1224 return importer;
Just van Rossum52e14d62002-12-30 22:08:05 +00001225}
1226
Benjamin Petersone5024512018-09-12 12:06:42 -07001227PyObject *
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001228PyImport_GetImporter(PyObject *path)
1229{
1230 PyThreadState *tstate = _PyThreadState_GET();
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001231 PyObject *importer=NULL, *path_importer_cache=NULL, *path_hooks=NULL;
Christian Heimes9cd17752007-11-18 19:35:23 +00001232
Victor Stinner1e53bba2013-07-16 22:26:05 +02001233 path_importer_cache = PySys_GetObject("path_importer_cache");
1234 path_hooks = PySys_GetObject("path_hooks");
1235 if (path_importer_cache != NULL && path_hooks != NULL) {
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001236 importer = get_path_importer(tstate, path_importer_cache,
Victor Stinner1e53bba2013-07-16 22:26:05 +02001237 path_hooks, path);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001238 }
1239 Py_XINCREF(importer); /* get_path_importer returns a borrowed reference */
1240 return importer;
Christian Heimes9cd17752007-11-18 19:35:23 +00001241}
1242
Nick Coghland5cacbb2015-05-23 22:24:10 +10001243/*[clinic input]
1244_imp.create_builtin
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001245
Nick Coghland5cacbb2015-05-23 22:24:10 +10001246 spec: object
1247 /
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001248
Nick Coghland5cacbb2015-05-23 22:24:10 +10001249Create an extension module.
1250[clinic start generated code]*/
Guido van Rossum7f133ed1991-02-19 12:23:57 +00001251
Nick Coghland5cacbb2015-05-23 22:24:10 +10001252static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03001253_imp_create_builtin(PyObject *module, PyObject *spec)
1254/*[clinic end generated code: output=ace7ff22271e6f39 input=37f966f890384e47]*/
Guido van Rossum7f133ed1991-02-19 12:23:57 +00001255{
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001256 PyThreadState *tstate = _PyThreadState_GET();
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001257 struct _inittab *p;
Nick Coghland5cacbb2015-05-23 22:24:10 +10001258 PyObject *name;
Serhiy Storchaka85b0f5b2016-11-20 10:16:47 +02001259 const char *namestr;
Victor Stinner5eb4f592013-11-14 22:38:52 +01001260 PyObject *mod;
Guido van Rossum25ce5661997-08-02 03:10:38 +00001261
Nick Coghland5cacbb2015-05-23 22:24:10 +10001262 name = PyObject_GetAttrString(spec, "name");
1263 if (name == NULL) {
1264 return NULL;
1265 }
1266
Victor Stinner5eb4f592013-11-14 22:38:52 +01001267 mod = _PyImport_FindExtensionObject(name, name);
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001268 if (mod || _PyErr_Occurred(tstate)) {
Nick Coghland5cacbb2015-05-23 22:24:10 +10001269 Py_DECREF(name);
Raymond Hettingerf0afe772016-08-31 08:44:11 -07001270 Py_XINCREF(mod);
Nick Coghland5cacbb2015-05-23 22:24:10 +10001271 return mod;
1272 }
1273
1274 namestr = PyUnicode_AsUTF8(name);
1275 if (namestr == NULL) {
1276 Py_DECREF(name);
1277 return NULL;
1278 }
Guido van Rossum25ce5661997-08-02 03:10:38 +00001279
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001280 PyObject *modules = tstate->interp->modules;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001281 for (p = PyImport_Inittab; p->name != NULL; p++) {
Antoine Pitrou6c40eb72012-01-18 20:16:09 +01001282 PyModuleDef *def;
Serhiy Storchakaf4934ea2016-11-16 10:17:58 +02001283 if (_PyUnicode_EqualToASCIIString(name, p->name)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001284 if (p->initfunc == NULL) {
Nick Coghland5cacbb2015-05-23 22:24:10 +10001285 /* Cannot re-init internal module ("sys" or "builtins") */
1286 mod = PyImport_AddModule(namestr);
1287 Py_DECREF(name);
1288 return mod;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001289 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001290 mod = (*p->initfunc)();
Nick Coghland5cacbb2015-05-23 22:24:10 +10001291 if (mod == NULL) {
1292 Py_DECREF(name);
1293 return NULL;
1294 }
1295 if (PyObject_TypeCheck(mod, &PyModuleDef_Type)) {
1296 Py_DECREF(name);
1297 return PyModule_FromDefAndSpec((PyModuleDef*)mod, spec);
1298 } else {
1299 /* Remember pointer to module init function. */
1300 def = PyModule_GetDef(mod);
Christian Heimesa78b6272016-09-09 00:25:03 +02001301 if (def == NULL) {
1302 Py_DECREF(name);
1303 return NULL;
1304 }
Nick Coghland5cacbb2015-05-23 22:24:10 +10001305 def->m_base.m_init = p->initfunc;
Eric Snowd393c1b2017-09-14 12:18:12 -06001306 if (_PyImport_FixupExtensionObject(mod, name, name,
1307 modules) < 0) {
Nick Coghland5cacbb2015-05-23 22:24:10 +10001308 Py_DECREF(name);
1309 return NULL;
1310 }
1311 Py_DECREF(name);
1312 return mod;
1313 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001314 }
1315 }
Nick Coghland5cacbb2015-05-23 22:24:10 +10001316 Py_DECREF(name);
1317 Py_RETURN_NONE;
Guido van Rossum7f133ed1991-02-19 12:23:57 +00001318}
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001319
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001320
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001321/* Frozen modules */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001322
Benjamin Peterson6fba3db2013-03-18 23:13:31 -07001323static const struct _frozen *
Victor Stinner53dc7352011-03-20 01:50:21 +01001324find_frozen(PyObject *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001325{
Benjamin Peterson6fba3db2013-03-18 23:13:31 -07001326 const struct _frozen *p;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001327
Victor Stinner53dc7352011-03-20 01:50:21 +01001328 if (name == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001329 return NULL;
Benjamin Petersond968e272008-11-05 22:48:33 +00001330
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001331 for (p = PyImport_FrozenModules; ; p++) {
1332 if (p->name == NULL)
1333 return NULL;
Serhiy Storchakaf4934ea2016-11-16 10:17:58 +02001334 if (_PyUnicode_EqualToASCIIString(name, p->name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001335 break;
1336 }
1337 return p;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001338}
1339
Guido van Rossum79f25d91997-04-29 20:08:16 +00001340static PyObject *
Victor Stinner53dc7352011-03-20 01:50:21 +01001341get_frozen_object(PyObject *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001342{
Benjamin Peterson6fba3db2013-03-18 23:13:31 -07001343 const struct _frozen *p = find_frozen(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001344 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001345
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001346 if (p == NULL) {
1347 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01001348 "No such frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001349 name);
1350 return NULL;
1351 }
1352 if (p->code == NULL) {
1353 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01001354 "Excluded frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001355 name);
1356 return NULL;
1357 }
1358 size = p->size;
1359 if (size < 0)
1360 size = -size;
Serhiy Storchakac6792272013-10-19 21:03:34 +03001361 return PyMarshal_ReadObjectFromString((const char *)p->code, size);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001362}
1363
Brett Cannon8d110132009-03-15 02:20:16 +00001364static PyObject *
Victor Stinner53dc7352011-03-20 01:50:21 +01001365is_frozen_package(PyObject *name)
Brett Cannon8d110132009-03-15 02:20:16 +00001366{
Benjamin Peterson6fba3db2013-03-18 23:13:31 -07001367 const struct _frozen *p = find_frozen(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001368 int size;
Brett Cannon8d110132009-03-15 02:20:16 +00001369
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001370 if (p == NULL) {
1371 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01001372 "No such frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001373 name);
1374 return NULL;
1375 }
Brett Cannon8d110132009-03-15 02:20:16 +00001376
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001377 size = p->size;
Brett Cannon8d110132009-03-15 02:20:16 +00001378
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001379 if (size < 0)
1380 Py_RETURN_TRUE;
1381 else
1382 Py_RETURN_FALSE;
Brett Cannon8d110132009-03-15 02:20:16 +00001383}
1384
1385
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001386/* Initialize a frozen module.
Brett Cannon3c2ac442009-03-08 20:49:47 +00001387 Return 1 for success, 0 if the module is not found, and -1 with
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001388 an exception set if the initialization failed.
1389 This function is also used from frozenmain.c */
Guido van Rossum0b344901995-02-07 15:35:27 +00001390
1391int
Victor Stinner53dc7352011-03-20 01:50:21 +01001392PyImport_ImportFrozenModuleObject(PyObject *name)
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001393{
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001394 PyThreadState *tstate = _PyThreadState_GET();
Benjamin Peterson6fba3db2013-03-18 23:13:31 -07001395 const struct _frozen *p;
Brett Cannon18fc4e72014-04-04 10:01:46 -04001396 PyObject *co, *m, *d;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001397 int ispackage;
1398 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001399
Victor Stinner53dc7352011-03-20 01:50:21 +01001400 p = find_frozen(name);
1401
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001402 if (p == NULL)
1403 return 0;
1404 if (p->code == NULL) {
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001405 _PyErr_Format(tstate, PyExc_ImportError,
1406 "Excluded frozen object named %R",
1407 name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001408 return -1;
1409 }
1410 size = p->size;
1411 ispackage = (size < 0);
1412 if (ispackage)
1413 size = -size;
Serhiy Storchakac6792272013-10-19 21:03:34 +03001414 co = PyMarshal_ReadObjectFromString((const char *)p->code, size);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001415 if (co == NULL)
1416 return -1;
1417 if (!PyCode_Check(co)) {
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001418 _PyErr_Format(tstate, PyExc_TypeError,
1419 "frozen object %R is not a code object",
1420 name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001421 goto err_return;
1422 }
1423 if (ispackage) {
Brett Cannon3e0651b2013-05-31 23:18:39 -04001424 /* Set __path__ to the empty list */
Brett Cannon18fc4e72014-04-04 10:01:46 -04001425 PyObject *l;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001426 int err;
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001427 m = import_add_module(tstate, name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001428 if (m == NULL)
1429 goto err_return;
1430 d = PyModule_GetDict(m);
Brett Cannon3e0651b2013-05-31 23:18:39 -04001431 l = PyList_New(0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001432 if (l == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001433 goto err_return;
1434 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001435 err = PyDict_SetItemString(d, "__path__", l);
1436 Py_DECREF(l);
1437 if (err != 0)
1438 goto err_return;
1439 }
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001440 d = module_dict_for_exec(tstate, name);
Brett Cannon18fc4e72014-04-04 10:01:46 -04001441 if (d == NULL) {
Victor Stinner53dc7352011-03-20 01:50:21 +01001442 goto err_return;
Brett Cannon18fc4e72014-04-04 10:01:46 -04001443 }
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001444 m = exec_code_in_module(tstate, name, d, co);
1445 if (m == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001446 goto err_return;
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001447 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001448 Py_DECREF(co);
1449 Py_DECREF(m);
1450 return 1;
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001451
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001452err_return:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001453 Py_DECREF(co);
1454 return -1;
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001455}
Guido van Rossum74e6a111994-08-29 12:54:38 +00001456
Victor Stinner53dc7352011-03-20 01:50:21 +01001457int
Serhiy Storchakac6792272013-10-19 21:03:34 +03001458PyImport_ImportFrozenModule(const char *name)
Victor Stinner53dc7352011-03-20 01:50:21 +01001459{
1460 PyObject *nameobj;
1461 int ret;
1462 nameobj = PyUnicode_InternFromString(name);
1463 if (nameobj == NULL)
1464 return -1;
1465 ret = PyImport_ImportFrozenModuleObject(nameobj);
1466 Py_DECREF(nameobj);
1467 return ret;
1468}
1469
Guido van Rossum74e6a111994-08-29 12:54:38 +00001470
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001471/* Import a module, either built-in, frozen, or external, and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001472 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum74e6a111994-08-29 12:54:38 +00001473
Guido van Rossum79f25d91997-04-29 20:08:16 +00001474PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001475PyImport_ImportModule(const char *name)
Guido van Rossum74e6a111994-08-29 12:54:38 +00001476{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001477 PyObject *pname;
1478 PyObject *result;
Marc-André Lemburg3c61c352001-02-09 19:40:15 +00001479
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001480 pname = PyUnicode_FromString(name);
1481 if (pname == NULL)
1482 return NULL;
1483 result = PyImport_Import(pname);
1484 Py_DECREF(pname);
1485 return result;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001486}
1487
Joannah Nanjekye37c22202019-09-11 13:47:39 +01001488
Christian Heimes072c0f12008-01-03 23:01:04 +00001489/* Import a module without blocking
1490 *
1491 * At first it tries to fetch the module from sys.modules. If the module was
1492 * never loaded before it loads it with PyImport_ImportModule() unless another
1493 * thread holds the import lock. In the latter case the function raises an
1494 * ImportError instead of blocking.
1495 *
1496 * Returns the module object with incremented ref count.
1497 */
1498PyObject *
1499PyImport_ImportModuleNoBlock(const char *name)
1500{
Antoine Pitrouea3eb882012-05-17 18:55:59 +02001501 return PyImport_ImportModule(name);
Christian Heimes072c0f12008-01-03 23:01:04 +00001502}
1503
Guido van Rossum17fc85f1997-09-06 18:52:03 +00001504
Antoine Pitroubc07a5c2012-07-08 12:01:27 +02001505/* Remove importlib frames from the traceback,
1506 * except in Verbose mode. */
1507static void
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001508remove_importlib_frames(PyThreadState *tstate)
Antoine Pitroubc07a5c2012-07-08 12:01:27 +02001509{
1510 const char *importlib_filename = "<frozen importlib._bootstrap>";
Eric Snow32439d62015-05-02 19:15:18 -06001511 const char *external_filename = "<frozen importlib._bootstrap_external>";
Nick Coghlan42c07662012-07-31 21:14:18 +10001512 const char *remove_frames = "_call_with_frames_removed";
Antoine Pitroubc07a5c2012-07-08 12:01:27 +02001513 int always_trim = 0;
Benjamin Petersonfa873702012-07-09 13:43:53 -07001514 int in_importlib = 0;
Antoine Pitroubc07a5c2012-07-08 12:01:27 +02001515 PyObject *exception, *value, *base_tb, *tb;
Benjamin Petersonfa873702012-07-09 13:43:53 -07001516 PyObject **prev_link, **outer_link = NULL;
Antoine Pitroubc07a5c2012-07-08 12:01:27 +02001517
1518 /* Synopsis: if it's an ImportError, we trim all importlib chunks
Nick Coghlan42c07662012-07-31 21:14:18 +10001519 from the traceback. We always trim chunks
1520 which end with a call to "_call_with_frames_removed". */
Antoine Pitroubc07a5c2012-07-08 12:01:27 +02001521
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001522 _PyErr_Fetch(tstate, &exception, &value, &base_tb);
1523 if (!exception || tstate->interp->config.verbose) {
Antoine Pitroubc07a5c2012-07-08 12:01:27 +02001524 goto done;
Victor Stinner410b85a2019-05-13 17:12:45 +02001525 }
1526
Antoine Pitroubc07a5c2012-07-08 12:01:27 +02001527 if (PyType_IsSubtype((PyTypeObject *) exception,
1528 (PyTypeObject *) PyExc_ImportError))
1529 always_trim = 1;
1530
1531 prev_link = &base_tb;
1532 tb = base_tb;
Antoine Pitroubc07a5c2012-07-08 12:01:27 +02001533 while (tb != NULL) {
1534 PyTracebackObject *traceback = (PyTracebackObject *)tb;
1535 PyObject *next = (PyObject *) traceback->tb_next;
1536 PyFrameObject *frame = traceback->tb_frame;
1537 PyCodeObject *code = frame->f_code;
1538 int now_in_importlib;
1539
1540 assert(PyTraceBack_Check(tb));
Serhiy Storchakaf4934ea2016-11-16 10:17:58 +02001541 now_in_importlib = _PyUnicode_EqualToASCIIString(code->co_filename, importlib_filename) ||
1542 _PyUnicode_EqualToASCIIString(code->co_filename, external_filename);
Antoine Pitroubc07a5c2012-07-08 12:01:27 +02001543 if (now_in_importlib && !in_importlib) {
1544 /* This is the link to this chunk of importlib tracebacks */
1545 outer_link = prev_link;
1546 }
1547 in_importlib = now_in_importlib;
1548
1549 if (in_importlib &&
1550 (always_trim ||
Serhiy Storchakaf4934ea2016-11-16 10:17:58 +02001551 _PyUnicode_EqualToASCIIString(code->co_name, remove_frames))) {
Antoine Pitroubc07a5c2012-07-08 12:01:27 +02001552 Py_XINCREF(next);
Serhiy Storchakaec397562016-04-06 09:50:03 +03001553 Py_XSETREF(*outer_link, next);
Antoine Pitroubc07a5c2012-07-08 12:01:27 +02001554 prev_link = outer_link;
1555 }
1556 else {
1557 prev_link = (PyObject **) &traceback->tb_next;
1558 }
1559 tb = next;
1560 }
1561done:
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001562 _PyErr_Restore(tstate, exception, value, base_tb);
Antoine Pitroubc07a5c2012-07-08 12:01:27 +02001563}
1564
1565
Serhiy Storchaka133138a2016-08-02 22:51:21 +03001566static PyObject *
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001567resolve_name(PyThreadState *tstate, PyObject *name, PyObject *globals, int level)
Thomas Woutersf7f438b2006-02-28 16:09:29 +00001568{
Eric Snowb523f842013-11-22 09:05:39 -07001569 _Py_IDENTIFIER(__spec__);
Brett Cannonfd074152012-04-14 14:10:13 -04001570 _Py_IDENTIFIER(__package__);
1571 _Py_IDENTIFIER(__path__);
1572 _Py_IDENTIFIER(__name__);
Serhiy Storchaka133138a2016-08-02 22:51:21 +03001573 _Py_IDENTIFIER(parent);
1574 PyObject *abs_name;
1575 PyObject *package = NULL;
1576 PyObject *spec;
Serhiy Storchaka133138a2016-08-02 22:51:21 +03001577 Py_ssize_t last_dot;
1578 PyObject *base;
1579 int level_up;
1580
1581 if (globals == NULL) {
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001582 _PyErr_SetString(tstate, PyExc_KeyError, "'__name__' not in globals");
Serhiy Storchaka133138a2016-08-02 22:51:21 +03001583 goto error;
1584 }
1585 if (!PyDict_Check(globals)) {
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001586 _PyErr_SetString(tstate, PyExc_TypeError, "globals must be a dict");
Serhiy Storchaka133138a2016-08-02 22:51:21 +03001587 goto error;
1588 }
Serhiy Storchakaa24107b2019-02-25 17:59:46 +02001589 package = _PyDict_GetItemIdWithError(globals, &PyId___package__);
Serhiy Storchaka133138a2016-08-02 22:51:21 +03001590 if (package == Py_None) {
1591 package = NULL;
1592 }
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001593 else if (package == NULL && _PyErr_Occurred(tstate)) {
Serhiy Storchakaa24107b2019-02-25 17:59:46 +02001594 goto error;
1595 }
1596 spec = _PyDict_GetItemIdWithError(globals, &PyId___spec__);
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001597 if (spec == NULL && _PyErr_Occurred(tstate)) {
Serhiy Storchakaa24107b2019-02-25 17:59:46 +02001598 goto error;
1599 }
Serhiy Storchaka133138a2016-08-02 22:51:21 +03001600
1601 if (package != NULL) {
1602 Py_INCREF(package);
1603 if (!PyUnicode_Check(package)) {
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001604 _PyErr_SetString(tstate, PyExc_TypeError,
1605 "package must be a string");
Serhiy Storchaka133138a2016-08-02 22:51:21 +03001606 goto error;
1607 }
1608 else if (spec != NULL && spec != Py_None) {
1609 int equal;
1610 PyObject *parent = _PyObject_GetAttrId(spec, &PyId_parent);
1611 if (parent == NULL) {
1612 goto error;
1613 }
1614
1615 equal = PyObject_RichCompareBool(package, parent, Py_EQ);
1616 Py_DECREF(parent);
1617 if (equal < 0) {
1618 goto error;
1619 }
1620 else if (equal == 0) {
1621 if (PyErr_WarnEx(PyExc_ImportWarning,
1622 "__package__ != __spec__.parent", 1) < 0) {
1623 goto error;
1624 }
1625 }
1626 }
1627 }
1628 else if (spec != NULL && spec != Py_None) {
1629 package = _PyObject_GetAttrId(spec, &PyId_parent);
1630 if (package == NULL) {
1631 goto error;
1632 }
1633 else if (!PyUnicode_Check(package)) {
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001634 _PyErr_SetString(tstate, PyExc_TypeError,
1635 "__spec__.parent must be a string");
Serhiy Storchaka133138a2016-08-02 22:51:21 +03001636 goto error;
1637 }
1638 }
1639 else {
1640 if (PyErr_WarnEx(PyExc_ImportWarning,
1641 "can't resolve package from __spec__ or __package__, "
1642 "falling back on __name__ and __path__", 1) < 0) {
1643 goto error;
1644 }
1645
Serhiy Storchakaa24107b2019-02-25 17:59:46 +02001646 package = _PyDict_GetItemIdWithError(globals, &PyId___name__);
Serhiy Storchaka133138a2016-08-02 22:51:21 +03001647 if (package == NULL) {
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001648 if (!_PyErr_Occurred(tstate)) {
1649 _PyErr_SetString(tstate, PyExc_KeyError,
1650 "'__name__' not in globals");
Serhiy Storchakaa24107b2019-02-25 17:59:46 +02001651 }
Serhiy Storchaka133138a2016-08-02 22:51:21 +03001652 goto error;
1653 }
1654
1655 Py_INCREF(package);
1656 if (!PyUnicode_Check(package)) {
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001657 _PyErr_SetString(tstate, PyExc_TypeError,
1658 "__name__ must be a string");
Serhiy Storchaka133138a2016-08-02 22:51:21 +03001659 goto error;
1660 }
1661
Serhiy Storchakaa24107b2019-02-25 17:59:46 +02001662 if (_PyDict_GetItemIdWithError(globals, &PyId___path__) == NULL) {
Serhiy Storchaka133138a2016-08-02 22:51:21 +03001663 Py_ssize_t dot;
1664
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001665 if (_PyErr_Occurred(tstate) || PyUnicode_READY(package) < 0) {
Serhiy Storchaka133138a2016-08-02 22:51:21 +03001666 goto error;
1667 }
1668
1669 dot = PyUnicode_FindChar(package, '.',
1670 0, PyUnicode_GET_LENGTH(package), -1);
1671 if (dot == -2) {
1672 goto error;
1673 }
Ben Lewis92420b32019-09-11 20:09:47 +10001674 else if (dot == -1) {
1675 goto no_parent_error;
Serhiy Storchaka133138a2016-08-02 22:51:21 +03001676 }
Ben Lewis92420b32019-09-11 20:09:47 +10001677 PyObject *substr = PyUnicode_Substring(package, 0, dot);
1678 if (substr == NULL) {
1679 goto error;
1680 }
1681 Py_SETREF(package, substr);
Serhiy Storchaka133138a2016-08-02 22:51:21 +03001682 }
1683 }
1684
1685 last_dot = PyUnicode_GET_LENGTH(package);
1686 if (last_dot == 0) {
Ben Lewis92420b32019-09-11 20:09:47 +10001687 goto no_parent_error;
Serhiy Storchaka133138a2016-08-02 22:51:21 +03001688 }
Serhiy Storchaka133138a2016-08-02 22:51:21 +03001689
1690 for (level_up = 1; level_up < level; level_up += 1) {
1691 last_dot = PyUnicode_FindChar(package, '.', 0, last_dot, -1);
1692 if (last_dot == -2) {
1693 goto error;
1694 }
1695 else if (last_dot == -1) {
Ngalim Siregarc5fa4492019-08-03 12:46:02 +07001696 _PyErr_SetString(tstate, PyExc_ImportError,
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001697 "attempted relative import beyond top-level "
1698 "package");
Serhiy Storchaka133138a2016-08-02 22:51:21 +03001699 goto error;
1700 }
1701 }
1702
1703 base = PyUnicode_Substring(package, 0, last_dot);
1704 Py_DECREF(package);
1705 if (base == NULL || PyUnicode_GET_LENGTH(name) == 0) {
1706 return base;
1707 }
1708
1709 abs_name = PyUnicode_FromFormat("%U.%U", base, name);
1710 Py_DECREF(base);
1711 return abs_name;
1712
Ben Lewis92420b32019-09-11 20:09:47 +10001713 no_parent_error:
1714 _PyErr_SetString(tstate, PyExc_ImportError,
1715 "attempted relative import "
1716 "with no known parent package");
1717
Serhiy Storchaka133138a2016-08-02 22:51:21 +03001718 error:
1719 Py_XDECREF(package);
1720 return NULL;
1721}
1722
Neil Schemenauereea3cc12017-12-03 09:26:03 -08001723static PyObject *
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001724import_find_and_load(PyThreadState *tstate, PyObject *abs_name)
Neil Schemenauereea3cc12017-12-03 09:26:03 -08001725{
1726 _Py_IDENTIFIER(_find_and_load);
1727 PyObject *mod = NULL;
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001728 PyInterpreterState *interp = tstate->interp;
Victor Stinner331a6a52019-05-27 16:39:22 +02001729 int import_time = interp->config.import_time;
Neil Schemenauereea3cc12017-12-03 09:26:03 -08001730 static int import_level;
1731 static _PyTime_t accumulated;
1732
1733 _PyTime_t t1 = 0, accumulated_copy = accumulated;
1734
Steve Dowerb82e17e2019-05-23 08:45:22 -07001735 PyObject *sys_path = PySys_GetObject("path");
1736 PyObject *sys_meta_path = PySys_GetObject("meta_path");
1737 PyObject *sys_path_hooks = PySys_GetObject("path_hooks");
1738 if (PySys_Audit("import", "OOOOO",
1739 abs_name, Py_None, sys_path ? sys_path : Py_None,
1740 sys_meta_path ? sys_meta_path : Py_None,
1741 sys_path_hooks ? sys_path_hooks : Py_None) < 0) {
1742 return NULL;
1743 }
1744
1745
Neil Schemenauereea3cc12017-12-03 09:26:03 -08001746 /* XOptions is initialized after first some imports.
1747 * So we can't have negative cache before completed initialization.
1748 * Anyway, importlib._find_and_load is much slower than
1749 * _PyDict_GetItemIdWithError().
1750 */
1751 if (import_time) {
1752 static int header = 1;
1753 if (header) {
1754 fputs("import time: self [us] | cumulative | imported package\n",
1755 stderr);
1756 header = 0;
1757 }
1758
1759 import_level++;
1760 t1 = _PyTime_GetPerfCounter();
1761 accumulated = 0;
1762 }
1763
1764 if (PyDTrace_IMPORT_FIND_LOAD_START_ENABLED())
1765 PyDTrace_IMPORT_FIND_LOAD_START(PyUnicode_AsUTF8(abs_name));
1766
1767 mod = _PyObject_CallMethodIdObjArgs(interp->importlib,
1768 &PyId__find_and_load, abs_name,
1769 interp->import_func, NULL);
1770
1771 if (PyDTrace_IMPORT_FIND_LOAD_DONE_ENABLED())
1772 PyDTrace_IMPORT_FIND_LOAD_DONE(PyUnicode_AsUTF8(abs_name),
1773 mod != NULL);
1774
1775 if (import_time) {
1776 _PyTime_t cum = _PyTime_GetPerfCounter() - t1;
1777
1778 import_level--;
1779 fprintf(stderr, "import time: %9ld | %10ld | %*s%s\n",
1780 (long)_PyTime_AsMicroseconds(cum - accumulated, _PyTime_ROUND_CEILING),
1781 (long)_PyTime_AsMicroseconds(cum, _PyTime_ROUND_CEILING),
1782 import_level*2, "", PyUnicode_AsUTF8(abs_name));
1783
1784 accumulated = accumulated_copy + cum;
1785 }
1786
1787 return mod;
1788}
1789
Serhiy Storchaka133138a2016-08-02 22:51:21 +03001790PyObject *
Joannah Nanjekye37c22202019-09-11 13:47:39 +01001791PyImport_GetModule(PyObject *name)
1792{
1793 PyThreadState *tstate = _PyThreadState_GET();
1794 PyObject *mod;
1795
1796 mod = import_get_module(tstate, name);
1797 if (mod != NULL && mod != Py_None) {
1798 if (import_ensure_initialized(tstate, mod, name) < 0) {
1799 Py_DECREF(mod);
1800 remove_importlib_frames(tstate);
1801 return NULL;
1802 }
1803 }
1804 return mod;
1805}
1806
1807PyObject *
Serhiy Storchaka133138a2016-08-02 22:51:21 +03001808PyImport_ImportModuleLevelObject(PyObject *name, PyObject *globals,
1809 PyObject *locals, PyObject *fromlist,
1810 int level)
1811{
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001812 PyThreadState *tstate = _PyThreadState_GET();
Brett Cannonfd074152012-04-14 14:10:13 -04001813 _Py_IDENTIFIER(_handle_fromlist);
Brett Cannonfd074152012-04-14 14:10:13 -04001814 PyObject *abs_name = NULL;
Brett Cannonfd074152012-04-14 14:10:13 -04001815 PyObject *final_mod = NULL;
1816 PyObject *mod = NULL;
1817 PyObject *package = NULL;
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001818 PyInterpreterState *interp = tstate->interp;
Serhiy Storchakafa494fd2015-05-30 17:45:22 +03001819 int has_from;
Brett Cannonfd074152012-04-14 14:10:13 -04001820
Brett Cannonfd074152012-04-14 14:10:13 -04001821 if (name == NULL) {
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001822 _PyErr_SetString(tstate, PyExc_ValueError, "Empty module name");
Brett Cannonfd074152012-04-14 14:10:13 -04001823 goto error;
1824 }
1825
1826 /* The below code is importlib.__import__() & _gcd_import(), ported to C
1827 for added performance. */
1828
1829 if (!PyUnicode_Check(name)) {
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001830 _PyErr_SetString(tstate, PyExc_TypeError,
1831 "module name must be a string");
Brett Cannonfd074152012-04-14 14:10:13 -04001832 goto error;
1833 }
Serhiy Storchaka133138a2016-08-02 22:51:21 +03001834 if (PyUnicode_READY(name) < 0) {
Brett Cannonfd074152012-04-14 14:10:13 -04001835 goto error;
1836 }
1837 if (level < 0) {
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001838 _PyErr_SetString(tstate, PyExc_ValueError, "level must be >= 0");
Brett Cannonfd074152012-04-14 14:10:13 -04001839 goto error;
1840 }
Brett Cannon849113a2016-01-22 15:25:50 -08001841
Serhiy Storchaka133138a2016-08-02 22:51:21 +03001842 if (level > 0) {
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001843 abs_name = resolve_name(tstate, name, globals, level);
Serhiy Storchaka133138a2016-08-02 22:51:21 +03001844 if (abs_name == NULL)
Brett Cannon9fa81262016-01-22 16:39:02 -08001845 goto error;
Brett Cannonfd074152012-04-14 14:10:13 -04001846 }
1847 else { /* level == 0 */
1848 if (PyUnicode_GET_LENGTH(name) == 0) {
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001849 _PyErr_SetString(tstate, PyExc_ValueError, "Empty module name");
Brett Cannonfd074152012-04-14 14:10:13 -04001850 goto error;
1851 }
Brett Cannonfd074152012-04-14 14:10:13 -04001852 abs_name = name;
1853 Py_INCREF(abs_name);
1854 }
1855
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001856 mod = import_get_module(tstate, abs_name);
1857 if (mod == NULL && _PyErr_Occurred(tstate)) {
Stefan Krah027b09c2019-03-25 21:50:58 +01001858 goto error;
1859 }
1860
Serhiy Storchakab4baace2017-07-06 08:09:03 +03001861 if (mod != NULL && mod != Py_None) {
Joannah Nanjekye37c22202019-09-11 13:47:39 +01001862 if (import_ensure_initialized(tstate, mod, name) < 0) {
1863 goto error;
Antoine Pitrouea3eb882012-05-17 18:55:59 +02001864 }
Brett Cannonfd074152012-04-14 14:10:13 -04001865 }
1866 else {
Neil Schemenauer11cc2892017-12-07 16:24:59 -08001867 Py_XDECREF(mod);
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001868 mod = import_find_and_load(tstate, abs_name);
Brett Cannonfd074152012-04-14 14:10:13 -04001869 if (mod == NULL) {
Antoine Pitrouea3eb882012-05-17 18:55:59 +02001870 goto error;
Brett Cannonfd074152012-04-14 14:10:13 -04001871 }
1872 }
1873
Serhiy Storchaka133138a2016-08-02 22:51:21 +03001874 has_from = 0;
1875 if (fromlist != NULL && fromlist != Py_None) {
1876 has_from = PyObject_IsTrue(fromlist);
1877 if (has_from < 0)
1878 goto error;
1879 }
Serhiy Storchakafa494fd2015-05-30 17:45:22 +03001880 if (!has_from) {
Victor Stinner744c34e2016-05-20 11:36:13 +02001881 Py_ssize_t len = PyUnicode_GET_LENGTH(name);
1882 if (level == 0 || len > 0) {
1883 Py_ssize_t dot;
Brett Cannonfd074152012-04-14 14:10:13 -04001884
Victor Stinner744c34e2016-05-20 11:36:13 +02001885 dot = PyUnicode_FindChar(name, '.', 0, len, 1);
1886 if (dot == -2) {
Antoine Pitrouea3eb882012-05-17 18:55:59 +02001887 goto error;
Brett Cannonfd074152012-04-14 14:10:13 -04001888 }
1889
Victor Stinner744c34e2016-05-20 11:36:13 +02001890 if (dot == -1) {
Antoine Pitrou6efa50a2012-05-07 21:41:59 +02001891 /* No dot in module name, simple exit */
Antoine Pitrou6efa50a2012-05-07 21:41:59 +02001892 final_mod = mod;
1893 Py_INCREF(mod);
Antoine Pitrouea3eb882012-05-17 18:55:59 +02001894 goto error;
Antoine Pitrou6efa50a2012-05-07 21:41:59 +02001895 }
1896
Brett Cannonfd074152012-04-14 14:10:13 -04001897 if (level == 0) {
Victor Stinner744c34e2016-05-20 11:36:13 +02001898 PyObject *front = PyUnicode_Substring(name, 0, dot);
1899 if (front == NULL) {
1900 goto error;
1901 }
1902
Serhiy Storchaka133138a2016-08-02 22:51:21 +03001903 final_mod = PyImport_ImportModuleLevelObject(front, NULL, NULL, NULL, 0);
Antoine Pitroub78174c2012-05-06 17:15:23 +02001904 Py_DECREF(front);
Brett Cannonfd074152012-04-14 14:10:13 -04001905 }
1906 else {
Victor Stinner744c34e2016-05-20 11:36:13 +02001907 Py_ssize_t cut_off = len - dot;
Antoine Pitrou22a1d172012-04-16 22:06:21 +02001908 Py_ssize_t abs_name_len = PyUnicode_GET_LENGTH(abs_name);
Brett Cannon49f8d8b2012-04-14 21:50:00 -04001909 PyObject *to_return = PyUnicode_Substring(abs_name, 0,
Brett Cannonfd074152012-04-14 14:10:13 -04001910 abs_name_len - cut_off);
Antoine Pitrou22a1d172012-04-16 22:06:21 +02001911 if (to_return == NULL) {
Antoine Pitrouea3eb882012-05-17 18:55:59 +02001912 goto error;
Antoine Pitrou22a1d172012-04-16 22:06:21 +02001913 }
Brett Cannonfd074152012-04-14 14:10:13 -04001914
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001915 final_mod = import_get_module(tstate, to_return);
Serhiy Storchaka133138a2016-08-02 22:51:21 +03001916 Py_DECREF(to_return);
Brett Cannon49f8d8b2012-04-14 21:50:00 -04001917 if (final_mod == NULL) {
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001918 if (!_PyErr_Occurred(tstate)) {
1919 _PyErr_Format(tstate, PyExc_KeyError,
1920 "%R not in sys.modules as expected",
1921 to_return);
Stefan Krah027b09c2019-03-25 21:50:58 +01001922 }
Serhiy Storchaka133138a2016-08-02 22:51:21 +03001923 goto error;
Brett Cannon49f8d8b2012-04-14 21:50:00 -04001924 }
Brett Cannonfd074152012-04-14 14:10:13 -04001925 }
1926 }
1927 else {
1928 final_mod = mod;
1929 Py_INCREF(mod);
1930 }
1931 }
1932 else {
Serhiy Storchaka4e244252018-03-11 10:52:37 +02001933 _Py_IDENTIFIER(__path__);
1934 PyObject *path;
1935 if (_PyObject_LookupAttrId(mod, &PyId___path__, &path) < 0) {
1936 goto error;
1937 }
1938 if (path) {
1939 Py_DECREF(path);
1940 final_mod = _PyObject_CallMethodIdObjArgs(
1941 interp->importlib, &PyId__handle_fromlist,
1942 mod, fromlist, interp->import_func, NULL);
1943 }
1944 else {
1945 final_mod = mod;
1946 Py_INCREF(mod);
1947 }
Brett Cannonfd074152012-04-14 14:10:13 -04001948 }
Antoine Pitrou6efa50a2012-05-07 21:41:59 +02001949
Brett Cannonfd074152012-04-14 14:10:13 -04001950 error:
1951 Py_XDECREF(abs_name);
Brett Cannonfd074152012-04-14 14:10:13 -04001952 Py_XDECREF(mod);
1953 Py_XDECREF(package);
Victor Stinner410b85a2019-05-13 17:12:45 +02001954 if (final_mod == NULL) {
Victor Stinner0a28f8d2019-06-19 02:54:39 +02001955 remove_importlib_frames(tstate);
Victor Stinner410b85a2019-05-13 17:12:45 +02001956 }
Brett Cannonfd074152012-04-14 14:10:13 -04001957 return final_mod;
Guido van Rossum75acc9c1998-03-03 22:26:50 +00001958}
1959
Victor Stinnerfe93faf2011-03-14 15:54:52 -04001960PyObject *
Benjamin Peterson04778a82011-05-25 09:29:00 -05001961PyImport_ImportModuleLevel(const char *name, PyObject *globals, PyObject *locals,
Victor Stinnerfe93faf2011-03-14 15:54:52 -04001962 PyObject *fromlist, int level)
1963{
1964 PyObject *nameobj, *mod;
1965 nameobj = PyUnicode_FromString(name);
1966 if (nameobj == NULL)
1967 return NULL;
1968 mod = PyImport_ImportModuleLevelObject(nameobj, globals, locals,
1969 fromlist, level);
1970 Py_DECREF(nameobj);
1971 return mod;
1972}
1973
1974
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001975/* Re-import a module of any kind and return its module object, WITH
1976 INCREMENTED REFERENCE COUNT */
1977
Guido van Rossum79f25d91997-04-29 20:08:16 +00001978PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001979PyImport_ReloadModule(PyObject *m)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001980{
Eric Snow3f9eee62017-09-15 16:35:20 -06001981 _Py_IDENTIFIER(imp);
Brett Cannon62228db2012-04-29 14:38:11 -04001982 _Py_IDENTIFIER(reload);
1983 PyObject *reloaded_module = NULL;
Eric Snow3f9eee62017-09-15 16:35:20 -06001984 PyObject *imp = _PyImport_GetModuleId(&PyId_imp);
Brett Cannon62228db2012-04-29 14:38:11 -04001985 if (imp == NULL) {
Stefan Krah027b09c2019-03-25 21:50:58 +01001986 if (PyErr_Occurred()) {
1987 return NULL;
1988 }
1989
Brett Cannon62228db2012-04-29 14:38:11 -04001990 imp = PyImport_ImportModule("imp");
1991 if (imp == NULL) {
1992 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001993 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001994 }
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001995
Jeroen Demeyer59ad1102019-07-11 10:59:05 +02001996 reloaded_module = _PyObject_CallMethodIdOneArg(imp, &PyId_reload, m);
Brett Cannon62228db2012-04-29 14:38:11 -04001997 Py_DECREF(imp);
1998 return reloaded_module;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001999}
2000
2001
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002002/* Higher-level import emulator which emulates the "import" statement
2003 more accurately -- it invokes the __import__() function from the
2004 builtins of the current globals. This means that the import is
2005 done using whatever import hooks are installed in the current
Brett Cannonbc2eff32010-09-19 21:39:02 +00002006 environment.
Guido van Rossum6058eb41998-12-21 19:51:00 +00002007 A dummy list ["__doc__"] is passed as the 4th argument so that
Neal Norwitz80e7f272007-08-26 06:45:23 +00002008 e.g. PyImport_Import(PyUnicode_FromString("win32com.client.gencache"))
Guido van Rossum6058eb41998-12-21 19:51:00 +00002009 will return <module "gencache"> instead of <module "win32com">. */
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002010
2011PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002012PyImport_Import(PyObject *module_name)
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002013{
Victor Stinner0a28f8d2019-06-19 02:54:39 +02002014 PyThreadState *tstate = _PyThreadState_GET();
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002015 static PyObject *silly_list = NULL;
2016 static PyObject *builtins_str = NULL;
2017 static PyObject *import_str = NULL;
2018 PyObject *globals = NULL;
2019 PyObject *import = NULL;
2020 PyObject *builtins = NULL;
2021 PyObject *r = NULL;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002022
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002023 /* Initialize constant string objects */
2024 if (silly_list == NULL) {
2025 import_str = PyUnicode_InternFromString("__import__");
2026 if (import_str == NULL)
2027 return NULL;
2028 builtins_str = PyUnicode_InternFromString("__builtins__");
2029 if (builtins_str == NULL)
2030 return NULL;
Brett Cannonbc2eff32010-09-19 21:39:02 +00002031 silly_list = PyList_New(0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002032 if (silly_list == NULL)
2033 return NULL;
2034 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002035
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002036 /* Get the builtins from current globals */
2037 globals = PyEval_GetGlobals();
2038 if (globals != NULL) {
2039 Py_INCREF(globals);
2040 builtins = PyObject_GetItem(globals, builtins_str);
2041 if (builtins == NULL)
2042 goto err;
2043 }
2044 else {
2045 /* No globals -- use standard builtins, and fake globals */
2046 builtins = PyImport_ImportModuleLevel("builtins",
2047 NULL, NULL, NULL, 0);
2048 if (builtins == NULL)
2049 return NULL;
2050 globals = Py_BuildValue("{OO}", builtins_str, builtins);
2051 if (globals == NULL)
2052 goto err;
2053 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002054
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002055 /* Get the __import__ function from the builtins */
2056 if (PyDict_Check(builtins)) {
2057 import = PyObject_GetItem(builtins, import_str);
Victor Stinner0a28f8d2019-06-19 02:54:39 +02002058 if (import == NULL) {
2059 _PyErr_SetObject(tstate, PyExc_KeyError, import_str);
2060 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002061 }
2062 else
2063 import = PyObject_GetAttr(builtins, import_str);
2064 if (import == NULL)
2065 goto err;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002066
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002067 /* Call the __import__ function with the proper argument list
Brett Cannonbc2eff32010-09-19 21:39:02 +00002068 Always use absolute import here.
2069 Calling for side-effect of import. */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002070 r = PyObject_CallFunction(import, "OOOOi", module_name, globals,
2071 globals, silly_list, 0, NULL);
Brett Cannonbc2eff32010-09-19 21:39:02 +00002072 if (r == NULL)
2073 goto err;
2074 Py_DECREF(r);
2075
Victor Stinner0a28f8d2019-06-19 02:54:39 +02002076 r = import_get_module(tstate, module_name);
2077 if (r == NULL && !_PyErr_Occurred(tstate)) {
2078 _PyErr_SetObject(tstate, PyExc_KeyError, module_name);
Serhiy Storchaka145541c2017-06-15 20:54:38 +03002079 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002080
2081 err:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002082 Py_XDECREF(globals);
2083 Py_XDECREF(builtins);
2084 Py_XDECREF(import);
Tim Peters50d8d372001-02-28 05:34:27 +00002085
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002086 return r;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002087}
2088
Brett Cannon4caa61d2014-01-09 19:03:32 -05002089/*[clinic input]
2090_imp.extension_suffixes
2091
2092Returns the list of file suffixes used to identify extension modules.
2093[clinic start generated code]*/
2094
Brett Cannon4caa61d2014-01-09 19:03:32 -05002095static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03002096_imp_extension_suffixes_impl(PyObject *module)
2097/*[clinic end generated code: output=0bf346e25a8f0cd3 input=ecdeeecfcb6f839e]*/
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002098{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002099 PyObject *list;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002100
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002101 list = PyList_New(0);
2102 if (list == NULL)
2103 return NULL;
Brett Cannon2657df42012-05-04 15:20:40 -04002104#ifdef HAVE_DYNAMIC_LOADING
Stéphane Wirtel0d765e32019-03-20 00:37:20 +01002105 const char *suffix;
2106 unsigned int index = 0;
2107
Brett Cannon2657df42012-05-04 15:20:40 -04002108 while ((suffix = _PyImport_DynLoadFiletab[index])) {
2109 PyObject *item = PyUnicode_FromString(suffix);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002110 if (item == NULL) {
2111 Py_DECREF(list);
2112 return NULL;
2113 }
2114 if (PyList_Append(list, item) < 0) {
2115 Py_DECREF(list);
2116 Py_DECREF(item);
2117 return NULL;
2118 }
2119 Py_DECREF(item);
Brett Cannon2657df42012-05-04 15:20:40 -04002120 index += 1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002121 }
Brett Cannon2657df42012-05-04 15:20:40 -04002122#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002123 return list;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002124}
2125
Brett Cannon4caa61d2014-01-09 19:03:32 -05002126/*[clinic input]
Brett Cannon4caa61d2014-01-09 19:03:32 -05002127_imp.init_frozen
2128
2129 name: unicode
2130 /
2131
2132Initializes a frozen module.
2133[clinic start generated code]*/
2134
Brett Cannon4caa61d2014-01-09 19:03:32 -05002135static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03002136_imp_init_frozen_impl(PyObject *module, PyObject *name)
2137/*[clinic end generated code: output=fc0511ed869fd69c input=13019adfc04f3fb3]*/
Brett Cannon4caa61d2014-01-09 19:03:32 -05002138{
Victor Stinner0a28f8d2019-06-19 02:54:39 +02002139 PyThreadState *tstate = _PyThreadState_GET();
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002140 int ret;
2141 PyObject *m;
Brett Cannon4caa61d2014-01-09 19:03:32 -05002142
Victor Stinner53dc7352011-03-20 01:50:21 +01002143 ret = PyImport_ImportFrozenModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002144 if (ret < 0)
2145 return NULL;
2146 if (ret == 0) {
Serhiy Storchaka228b12e2017-01-23 09:47:21 +02002147 Py_RETURN_NONE;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002148 }
Victor Stinner0a28f8d2019-06-19 02:54:39 +02002149 m = import_add_module(tstate, name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002150 Py_XINCREF(m);
2151 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002152}
2153
Brett Cannon4caa61d2014-01-09 19:03:32 -05002154/*[clinic input]
2155_imp.get_frozen_object
2156
2157 name: unicode
2158 /
2159
2160Create a code object for a frozen module.
2161[clinic start generated code]*/
2162
Brett Cannon4caa61d2014-01-09 19:03:32 -05002163static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03002164_imp_get_frozen_object_impl(PyObject *module, PyObject *name)
2165/*[clinic end generated code: output=2568cc5b7aa0da63 input=ed689bc05358fdbd]*/
Brett Cannon4caa61d2014-01-09 19:03:32 -05002166{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002167 return get_frozen_object(name);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002168}
2169
Brett Cannon4caa61d2014-01-09 19:03:32 -05002170/*[clinic input]
2171_imp.is_frozen_package
2172
2173 name: unicode
2174 /
2175
2176Returns True if the module name is of a frozen package.
2177[clinic start generated code]*/
2178
Brett Cannon4caa61d2014-01-09 19:03:32 -05002179static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03002180_imp_is_frozen_package_impl(PyObject *module, PyObject *name)
2181/*[clinic end generated code: output=e70cbdb45784a1c9 input=81b6cdecd080fbb8]*/
Brett Cannon4caa61d2014-01-09 19:03:32 -05002182{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002183 return is_frozen_package(name);
Brett Cannon8d110132009-03-15 02:20:16 +00002184}
2185
Brett Cannon4caa61d2014-01-09 19:03:32 -05002186/*[clinic input]
2187_imp.is_builtin
2188
2189 name: unicode
2190 /
2191
2192Returns True if the module name corresponds to a built-in module.
2193[clinic start generated code]*/
2194
Guido van Rossum79f25d91997-04-29 20:08:16 +00002195static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03002196_imp_is_builtin_impl(PyObject *module, PyObject *name)
2197/*[clinic end generated code: output=3bfd1162e2d3be82 input=86befdac021dd1c7]*/
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002198{
Brett Cannon4caa61d2014-01-09 19:03:32 -05002199 return PyLong_FromLong(is_builtin(name));
2200}
2201
2202/*[clinic input]
2203_imp.is_frozen
2204
2205 name: unicode
2206 /
2207
2208Returns True if the module name corresponds to a frozen module.
2209[clinic start generated code]*/
2210
Brett Cannon4caa61d2014-01-09 19:03:32 -05002211static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03002212_imp_is_frozen_impl(PyObject *module, PyObject *name)
2213/*[clinic end generated code: output=01f408f5ec0f2577 input=7301dbca1897d66b]*/
Brett Cannon4caa61d2014-01-09 19:03:32 -05002214{
Benjamin Peterson6fba3db2013-03-18 23:13:31 -07002215 const struct _frozen *p;
Brett Cannon4caa61d2014-01-09 19:03:32 -05002216
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002217 p = find_frozen(name);
2218 return PyBool_FromLong((long) (p == NULL ? 0 : p->size));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002219}
2220
Larry Hastings1df0b352015-08-24 19:53:56 -07002221/* Common implementation for _imp.exec_dynamic and _imp.exec_builtin */
2222static int
2223exec_builtin_or_dynamic(PyObject *mod) {
2224 PyModuleDef *def;
2225 void *state;
2226
2227 if (!PyModule_Check(mod)) {
2228 return 0;
2229 }
2230
2231 def = PyModule_GetDef(mod);
2232 if (def == NULL) {
Larry Hastings1df0b352015-08-24 19:53:56 -07002233 return 0;
2234 }
Brett Cannon52794db2016-09-07 17:00:43 -07002235
Larry Hastings1df0b352015-08-24 19:53:56 -07002236 state = PyModule_GetState(mod);
Larry Hastings1df0b352015-08-24 19:53:56 -07002237 if (state) {
2238 /* Already initialized; skip reload */
2239 return 0;
2240 }
Brett Cannon52794db2016-09-07 17:00:43 -07002241
Larry Hastings1df0b352015-08-24 19:53:56 -07002242 return PyModule_ExecDef(mod, def);
2243}
2244
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002245#ifdef HAVE_DYNAMIC_LOADING
2246
Brett Cannon4caa61d2014-01-09 19:03:32 -05002247/*[clinic input]
Nick Coghland5cacbb2015-05-23 22:24:10 +10002248_imp.create_dynamic
Brett Cannon4caa61d2014-01-09 19:03:32 -05002249
Nick Coghland5cacbb2015-05-23 22:24:10 +10002250 spec: object
Brett Cannon4caa61d2014-01-09 19:03:32 -05002251 file: object = NULL
2252 /
2253
Nick Coghland5cacbb2015-05-23 22:24:10 +10002254Create an extension module.
Brett Cannon4caa61d2014-01-09 19:03:32 -05002255[clinic start generated code]*/
2256
Brett Cannon4caa61d2014-01-09 19:03:32 -05002257static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03002258_imp_create_dynamic_impl(PyObject *module, PyObject *spec, PyObject *file)
2259/*[clinic end generated code: output=83249b827a4fde77 input=c31b954f4cf4e09d]*/
Brett Cannon4caa61d2014-01-09 19:03:32 -05002260{
Nick Coghland5cacbb2015-05-23 22:24:10 +10002261 PyObject *mod, *name, *path;
Victor Stinnerfefd70c2011-03-14 15:54:07 -04002262 FILE *fp;
2263
Nick Coghland5cacbb2015-05-23 22:24:10 +10002264 name = PyObject_GetAttrString(spec, "name");
2265 if (name == NULL) {
2266 return NULL;
2267 }
2268
2269 path = PyObject_GetAttrString(spec, "origin");
2270 if (path == NULL) {
2271 Py_DECREF(name);
2272 return NULL;
2273 }
2274
2275 mod = _PyImport_FindExtensionObject(name, path);
Serhiy Storchaka8905fcc2018-12-11 08:38:03 +02002276 if (mod != NULL || PyErr_Occurred()) {
Nick Coghland5cacbb2015-05-23 22:24:10 +10002277 Py_DECREF(name);
2278 Py_DECREF(path);
Serhiy Storchaka8905fcc2018-12-11 08:38:03 +02002279 Py_XINCREF(mod);
Nick Coghland5cacbb2015-05-23 22:24:10 +10002280 return mod;
2281 }
2282
Brett Cannon4caa61d2014-01-09 19:03:32 -05002283 if (file != NULL) {
2284 fp = _Py_fopen_obj(path, "r");
Victor Stinnere9ddbf62011-03-22 10:46:35 +01002285 if (fp == NULL) {
Nick Coghland5cacbb2015-05-23 22:24:10 +10002286 Py_DECREF(name);
Brett Cannon4caa61d2014-01-09 19:03:32 -05002287 Py_DECREF(path);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002288 return NULL;
Victor Stinnere9ddbf62011-03-22 10:46:35 +01002289 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002290 }
Victor Stinnerfefd70c2011-03-14 15:54:07 -04002291 else
2292 fp = NULL;
Nick Coghland5cacbb2015-05-23 22:24:10 +10002293
2294 mod = _PyImport_LoadDynamicModuleWithSpec(spec, fp);
2295
2296 Py_DECREF(name);
Brett Cannon4caa61d2014-01-09 19:03:32 -05002297 Py_DECREF(path);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002298 if (fp)
2299 fclose(fp);
Victor Stinnerfefd70c2011-03-14 15:54:07 -04002300 return mod;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002301}
2302
Nick Coghland5cacbb2015-05-23 22:24:10 +10002303/*[clinic input]
2304_imp.exec_dynamic -> int
2305
2306 mod: object
2307 /
2308
2309Initialize an extension module.
2310[clinic start generated code]*/
2311
2312static int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03002313_imp_exec_dynamic_impl(PyObject *module, PyObject *mod)
2314/*[clinic end generated code: output=f5720ac7b465877d input=9fdbfcb250280d3a]*/
Nick Coghland5cacbb2015-05-23 22:24:10 +10002315{
Larry Hastings1df0b352015-08-24 19:53:56 -07002316 return exec_builtin_or_dynamic(mod);
Nick Coghland5cacbb2015-05-23 22:24:10 +10002317}
2318
2319
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002320#endif /* HAVE_DYNAMIC_LOADING */
2321
Larry Hastings7726ac92014-01-31 22:03:12 -08002322/*[clinic input]
Larry Hastings1df0b352015-08-24 19:53:56 -07002323_imp.exec_builtin -> int
2324
2325 mod: object
2326 /
2327
2328Initialize a built-in module.
2329[clinic start generated code]*/
2330
2331static int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03002332_imp_exec_builtin_impl(PyObject *module, PyObject *mod)
2333/*[clinic end generated code: output=0262447b240c038e input=7beed5a2f12a60ca]*/
Larry Hastings1df0b352015-08-24 19:53:56 -07002334{
2335 return exec_builtin_or_dynamic(mod);
2336}
2337
Benjamin Peterson42aa93b2017-12-09 10:26:52 -08002338/*[clinic input]
2339_imp.source_hash
2340
2341 key: long
2342 source: Py_buffer
2343[clinic start generated code]*/
2344
2345static PyObject *
2346_imp_source_hash_impl(PyObject *module, long key, Py_buffer *source)
2347/*[clinic end generated code: output=edb292448cf399ea input=9aaad1e590089789]*/
2348{
Benjamin Peterson83620772017-12-09 12:18:56 -08002349 union {
2350 uint64_t x;
2351 char data[sizeof(uint64_t)];
2352 } hash;
2353 hash.x = _Py_KeyedHash((uint64_t)key, source->buf, source->len);
Benjamin Peterson42aa93b2017-12-09 10:26:52 -08002354#if !PY_LITTLE_ENDIAN
2355 // Force to little-endian. There really ought to be a succinct standard way
2356 // to do this.
Benjamin Peterson83620772017-12-09 12:18:56 -08002357 for (size_t i = 0; i < sizeof(hash.data)/2; i++) {
2358 char tmp = hash.data[i];
2359 hash.data[i] = hash.data[sizeof(hash.data) - i - 1];
2360 hash.data[sizeof(hash.data) - i - 1] = tmp;
Benjamin Peterson42aa93b2017-12-09 10:26:52 -08002361 }
Benjamin Peterson42aa93b2017-12-09 10:26:52 -08002362#endif
Benjamin Peterson83620772017-12-09 12:18:56 -08002363 return PyBytes_FromStringAndSize(hash.data, sizeof(hash.data));
Benjamin Peterson42aa93b2017-12-09 10:26:52 -08002364}
2365
Barry Warsaw28a691b2010-04-17 00:19:56 +00002366
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002367PyDoc_STRVAR(doc_imp,
Brett Cannon6f44d662012-04-15 16:08:47 -04002368"(Extremely) low-level import machinery bits as used by importlib and imp.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002369
Guido van Rossum79f25d91997-04-29 20:08:16 +00002370static PyMethodDef imp_methods[] = {
Brett Cannon4caa61d2014-01-09 19:03:32 -05002371 _IMP_EXTENSION_SUFFIXES_METHODDEF
2372 _IMP_LOCK_HELD_METHODDEF
2373 _IMP_ACQUIRE_LOCK_METHODDEF
2374 _IMP_RELEASE_LOCK_METHODDEF
2375 _IMP_GET_FROZEN_OBJECT_METHODDEF
2376 _IMP_IS_FROZEN_PACKAGE_METHODDEF
Nick Coghland5cacbb2015-05-23 22:24:10 +10002377 _IMP_CREATE_BUILTIN_METHODDEF
Brett Cannon4caa61d2014-01-09 19:03:32 -05002378 _IMP_INIT_FROZEN_METHODDEF
2379 _IMP_IS_BUILTIN_METHODDEF
2380 _IMP_IS_FROZEN_METHODDEF
Nick Coghland5cacbb2015-05-23 22:24:10 +10002381 _IMP_CREATE_DYNAMIC_METHODDEF
2382 _IMP_EXEC_DYNAMIC_METHODDEF
Larry Hastings1df0b352015-08-24 19:53:56 -07002383 _IMP_EXEC_BUILTIN_METHODDEF
Brett Cannon4caa61d2014-01-09 19:03:32 -05002384 _IMP__FIX_CO_FILENAME_METHODDEF
Benjamin Peterson42aa93b2017-12-09 10:26:52 -08002385 _IMP_SOURCE_HASH_METHODDEF
Brett Cannon4caa61d2014-01-09 19:03:32 -05002386 {NULL, NULL} /* sentinel */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002387};
2388
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002389
Martin v. Löwis1a214512008-06-11 05:26:20 +00002390static struct PyModuleDef impmodule = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002391 PyModuleDef_HEAD_INIT,
Brett Cannon6f44d662012-04-15 16:08:47 -04002392 "_imp",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002393 doc_imp,
2394 0,
2395 imp_methods,
2396 NULL,
2397 NULL,
2398 NULL,
2399 NULL
Martin v. Löwis1a214512008-06-11 05:26:20 +00002400};
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002401
Jason Tishler6bc06ec2003-09-04 11:59:50 +00002402PyMODINIT_FUNC
Benjamin Petersonc65ef772018-01-29 11:33:57 -08002403PyInit__imp(void)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002404{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002405 PyObject *m, *d;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002406
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002407 m = PyModule_Create(&impmodule);
Victor Stinner410b85a2019-05-13 17:12:45 +02002408 if (m == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002409 goto failure;
Victor Stinner410b85a2019-05-13 17:12:45 +02002410 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002411 d = PyModule_GetDict(m);
Victor Stinner410b85a2019-05-13 17:12:45 +02002412 if (d == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002413 goto failure;
Victor Stinner410b85a2019-05-13 17:12:45 +02002414 }
2415
Victor Stinner331a6a52019-05-27 16:39:22 +02002416 const wchar_t *mode = _PyInterpreterState_Get()->config.check_hash_pycs_mode;
Victor Stinner410b85a2019-05-13 17:12:45 +02002417 PyObject *pyc_mode = PyUnicode_FromWideChar(mode, -1);
Benjamin Peterson42aa93b2017-12-09 10:26:52 -08002418 if (pyc_mode == NULL) {
2419 goto failure;
2420 }
2421 if (PyDict_SetItemString(d, "check_hash_based_pycs", pyc_mode) < 0) {
2422 Py_DECREF(pyc_mode);
2423 goto failure;
2424 }
2425 Py_DECREF(pyc_mode);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002426
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002427 return m;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002428 failure:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002429 Py_XDECREF(m);
2430 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002431}
Guido van Rossum09cae1f1998-05-14 02:32:54 +00002432
2433
Guido van Rossumb18618d2000-05-03 23:44:39 +00002434/* API for embedding applications that want to add their own entries
2435 to the table of built-in modules. This should normally be called
2436 *before* Py_Initialize(). When the table resize fails, -1 is
2437 returned and the existing table is unchanged.
Guido van Rossum09cae1f1998-05-14 02:32:54 +00002438
2439 After a similar function by Just van Rossum. */
2440
2441int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002442PyImport_ExtendInittab(struct _inittab *newtab)
Guido van Rossum09cae1f1998-05-14 02:32:54 +00002443{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002444 struct _inittab *p;
Benjamin Peterson0c644fc2017-12-15 23:42:33 -08002445 size_t i, n;
Victor Stinner92a3c6f2017-12-06 18:12:59 +01002446 int res = 0;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00002447
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002448 /* Count the number of entries in both tables */
2449 for (n = 0; newtab[n].name != NULL; n++)
2450 ;
2451 if (n == 0)
2452 return 0; /* Nothing to do */
2453 for (i = 0; PyImport_Inittab[i].name != NULL; i++)
2454 ;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00002455
Victor Stinner92a3c6f2017-12-06 18:12:59 +01002456 /* Force default raw memory allocator to get a known allocator to be able
2457 to release the memory in _PyImport_Fini2() */
2458 PyMemAllocatorEx old_alloc;
2459 _PyMem_SetDefaultAllocator(PYMEM_DOMAIN_RAW, &old_alloc);
2460
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002461 /* Allocate new memory for the combined table */
Benjamin Peterson0c644fc2017-12-15 23:42:33 -08002462 p = NULL;
2463 if (i + n <= SIZE_MAX / sizeof(struct _inittab) - 1) {
Victor Stinner92a3c6f2017-12-06 18:12:59 +01002464 size_t size = sizeof(struct _inittab) * (i + n + 1);
2465 p = PyMem_RawRealloc(inittab_copy, size);
2466 }
Victor Stinner92a3c6f2017-12-06 18:12:59 +01002467 if (p == NULL) {
2468 res = -1;
2469 goto done;
2470 }
Guido van Rossum09cae1f1998-05-14 02:32:54 +00002471
Victor Stinner92a3c6f2017-12-06 18:12:59 +01002472 /* Copy the tables into the new memory at the first call
2473 to PyImport_ExtendInittab(). */
2474 if (inittab_copy != PyImport_Inittab) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002475 memcpy(p, PyImport_Inittab, (i+1) * sizeof(struct _inittab));
Victor Stinner92a3c6f2017-12-06 18:12:59 +01002476 }
2477 memcpy(p + i, newtab, (n + 1) * sizeof(struct _inittab));
2478 PyImport_Inittab = inittab_copy = p;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00002479
Victor Stinner92a3c6f2017-12-06 18:12:59 +01002480done:
2481 PyMem_SetAllocator(PYMEM_DOMAIN_RAW, &old_alloc);
2482 return res;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00002483}
2484
2485/* Shorthand to add a single entry given a name and a function */
2486
2487int
Brett Cannona826f322009-04-02 03:41:46 +00002488PyImport_AppendInittab(const char *name, PyObject* (*initfunc)(void))
Guido van Rossum09cae1f1998-05-14 02:32:54 +00002489{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002490 struct _inittab newtab[2];
Guido van Rossum09cae1f1998-05-14 02:32:54 +00002491
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002492 memset(newtab, '\0', sizeof newtab);
Guido van Rossum09cae1f1998-05-14 02:32:54 +00002493
Serhiy Storchaka20b39b22014-09-28 11:27:24 +03002494 newtab[0].name = name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002495 newtab[0].initfunc = initfunc;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00002496
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002497 return PyImport_ExtendInittab(newtab);
Guido van Rossum09cae1f1998-05-14 02:32:54 +00002498}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002499
2500#ifdef __cplusplus
2501}
2502#endif