blob: 2ef6aec9416e80f13bba419c8e07b63118996a86 [file] [log] [blame]
Guido van Rossumf70e43a1991-02-19 12:39:46 +00001
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002/* Module definition and import implementation */
3
Guido van Rossum79f25d91997-04-29 20:08:16 +00004#include "Python.h"
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00005
Jeremy Hylton3e0055f2005-10-20 19:59:25 +00006#include "Python-ast.h"
Guido van Rossumd8faa362007-04-27 19:54:29 +00007#undef Yield /* undefine macro conflicting with winbase.h */
Neal Norwitzadb69fc2005-12-17 20:54:49 +00008#include "pyarena.h"
Jeremy Hylton3e0055f2005-10-20 19:59:25 +00009#include "pythonrun.h"
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000010#include "errcode.h"
Guido van Rossumc405b7b1991-06-04 19:39:42 +000011#include "marshal.h"
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000012#include "code.h"
Guido van Rossumc405b7b1991-06-04 19:39:42 +000013#include "compile.h"
Guido van Rossumff4949e1992-08-05 19:58:53 +000014#include "eval.h"
Guido van Rossumd8bac6d1992-02-26 15:19:13 +000015#include "osdefs.h"
Guido van Rossum1ae940a1995-01-02 19:04:15 +000016#include "importdl.h"
Guido van Rossumc405b7b1991-06-04 19:39:42 +000017
Guido van Rossum55a83382000-09-20 20:31:38 +000018#ifdef HAVE_FCNTL_H
19#include <fcntl.h>
20#endif
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000021#ifdef __cplusplus
22extern "C" {
23#endif
Guido van Rossum55a83382000-09-20 20:31:38 +000024
Thomas Woutersf70ef4f2000-07-22 18:47:25 +000025extern time_t PyOS_GetLastModificationTime(char *, FILE *);
26 /* In getmtime.c */
Guido van Rossum21d335e1993-10-15 13:01:11 +000027
Jeremy Hyltond4ceb312004-04-01 02:45:22 +000028/* Magic word to reject .pyc files generated by other Python versions.
29 It should change for each incompatible change to the bytecode.
30
31 The value of CR and LF is incorporated so if you ever read or write
Guido van Rossum7faeab31995-07-07 22:50:36 +000032 a .pyc file in text mode the magic number will be wrong; also, the
Tim Peters36515e22001-11-18 04:06:29 +000033 Apple MPW compiler swaps their values, botching string constants.
Marc-André Lemburgbd3be8f2002-02-07 11:33:49 +000034
Guido van Rossum45aecf42006-03-15 04:58:47 +000035 The magic numbers must be spaced apart at least 2 values, as the
Martin v. Löwisef82d2f2004-06-27 16:51:46 +000036 -U interpeter flag will cause MAGIC+1 being used. They have been
37 odd numbers for some time now.
Marc-André Lemburgbd3be8f2002-02-07 11:33:49 +000038
Jeremy Hyltond4ceb312004-04-01 02:45:22 +000039 There were a variety of old schemes for setting the magic number.
40 The current working scheme is to increment the previous value by
41 10.
Guido van Rossumf6894922002-08-31 15:16:14 +000042
Marc-André Lemburgbd3be8f2002-02-07 11:33:49 +000043 Known values:
44 Python 1.5: 20121
45 Python 1.5.1: 20121
46 Python 1.5.2: 20121
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000047 Python 1.6: 50428
Marc-André Lemburgbd3be8f2002-02-07 11:33:49 +000048 Python 2.0: 50823
49 Python 2.0.1: 50823
50 Python 2.1: 60202
51 Python 2.1.1: 60202
52 Python 2.1.2: 60202
53 Python 2.2: 60717
Neal Norwitz7fdcb412002-06-14 01:07:39 +000054 Python 2.3a0: 62011
Michael W. Hudsondd32a912002-08-15 14:59:02 +000055 Python 2.3a0: 62021
Guido van Rossumf6894922002-08-31 15:16:14 +000056 Python 2.3a0: 62011 (!)
Martin v. Löwisef82d2f2004-06-27 16:51:46 +000057 Python 2.4a0: 62041
Raymond Hettingerfd2d1f72004-08-23 23:37:48 +000058 Python 2.4a3: 62051
Raymond Hettinger2c31a052004-09-22 18:44:21 +000059 Python 2.4b1: 62061
Michael W. Hudsondf888462005-06-03 14:41:55 +000060 Python 2.5a0: 62071
Michael W. Hudsonaee2e282005-10-21 11:32:20 +000061 Python 2.5a0: 62081 (ast-branch)
Guido van Rossumc2e20742006-02-27 22:32:47 +000062 Python 2.5a0: 62091 (with)
Guido van Rossumf6694362006-03-10 02:28:35 +000063 Python 2.5a0: 62092 (changed WITH_CLEANUP opcode)
Thomas Wouters0e3f5912006-08-11 14:57:12 +000064 Python 2.5b3: 62101 (fix wrong code: for x, in ...)
65 Python 2.5b3: 62111 (fix wrong code: x += yield)
66 Python 2.5c1: 62121 (fix wrong lnotab with for loops and
67 storing constants that should have been removed)
Thomas Wouters89f507f2006-12-13 04:49:30 +000068 Python 2.5c2: 62131 (fix wrong code: for x, in ... in listcomp/genexp)
69 Python 2.6a0: 62141 (peephole optimizations)
Guido van Rossum45aecf42006-03-15 04:58:47 +000070 Python 3000: 3000
Brett Cannone2e23ef2006-08-25 05:05:30 +000071 3010 (removed UNARY_CONVERT)
Guido van Rossum86e58e22006-08-28 15:27:34 +000072 3020 (added BUILD_SET)
Guido van Rossum4f72a782006-10-27 23:31:49 +000073 3030 (added keyword-only parameters)
Guido van Rossum3203bdc2006-12-28 21:03:31 +000074 3040 (added signature annotations)
Guido van Rossum452bf512007-02-09 05:32:43 +000075 3050 (print becomes a function)
Guido van Rossum52cc1d82007-03-18 15:41:51 +000076 3060 (PEP 3115 metaclass syntax)
Michael W. Hudsonaee2e282005-10-21 11:32:20 +000077.
Tim Peters36515e22001-11-18 04:06:29 +000078*/
Guido van Rossum52cc1d82007-03-18 15:41:51 +000079#define MAGIC (3060 | ((long)'\r'<<16) | ((long)'\n'<<24))
Guido van Rossum3ddee711991-12-16 13:06:34 +000080
Guido van Rossum96774c12000-05-01 20:19:08 +000081/* Magic word as global; note that _PyImport_Init() can change the
Jeremy Hylton9262b8a2000-06-30 04:59:17 +000082 value of this global to accommodate for alterations of how the
Guido van Rossum96774c12000-05-01 20:19:08 +000083 compiler works which are enabled by command line switches. */
84static long pyc_magic = MAGIC;
85
Guido van Rossum25ce5661997-08-02 03:10:38 +000086/* See _PyImport_FixupExtension() below */
87static PyObject *extensions = NULL;
Guido van Rossum3f5da241990-12-20 15:06:42 +000088
Guido van Rossum771c6c81997-10-31 18:37:24 +000089/* This table is defined in config.c: */
90extern struct _inittab _PyImport_Inittab[];
91
92struct _inittab *PyImport_Inittab = _PyImport_Inittab;
Guido van Rossum66f1fa81991-04-03 19:03:52 +000093
Guido van Rossumed1170e1999-12-20 21:23:41 +000094/* these tables define the module suffixes that Python recognizes */
95struct filedescr * _PyImport_Filetab = NULL;
Guido van Rossum48a680c2001-03-02 06:34:14 +000096
Guido van Rossumed1170e1999-12-20 21:23:41 +000097static const struct filedescr _PyImport_StandardFiletab[] = {
Jack Jansenc88da1f2002-05-28 10:58:19 +000098 {".py", "U", PY_SOURCE},
Martin v. Löwis6238d2b2002-06-30 15:26:10 +000099#ifdef MS_WINDOWS
Jack Jansenc88da1f2002-05-28 10:58:19 +0000100 {".pyw", "U", PY_SOURCE},
Tim Peters36515e22001-11-18 04:06:29 +0000101#endif
Guido van Rossumed1170e1999-12-20 21:23:41 +0000102 {".pyc", "rb", PY_COMPILED},
103 {0, 0}
104};
105
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000106static PyTypeObject NullImporterType; /* Forward reference */
107
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000108/* Initialize things */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000109
110void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000111_PyImport_Init(void)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000112{
Guido van Rossumed1170e1999-12-20 21:23:41 +0000113 const struct filedescr *scan;
114 struct filedescr *filetab;
115 int countD = 0;
116 int countS = 0;
117
118 /* prepare _PyImport_Filetab: copy entries from
119 _PyImport_DynLoadFiletab and _PyImport_StandardFiletab.
120 */
Guido van Rossum04110fb2007-08-24 16:32:05 +0000121#ifdef HAVE_DYNAMIC_LOADING
Guido van Rossumed1170e1999-12-20 21:23:41 +0000122 for (scan = _PyImport_DynLoadFiletab; scan->suffix != NULL; ++scan)
123 ++countD;
Guido van Rossum04110fb2007-08-24 16:32:05 +0000124#endif
Guido van Rossumed1170e1999-12-20 21:23:41 +0000125 for (scan = _PyImport_StandardFiletab; scan->suffix != NULL; ++scan)
126 ++countS;
Guido van Rossumb18618d2000-05-03 23:44:39 +0000127 filetab = PyMem_NEW(struct filedescr, countD + countS + 1);
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000128 if (filetab == NULL)
129 Py_FatalError("Can't initialize import file table.");
Guido van Rossum04110fb2007-08-24 16:32:05 +0000130#ifdef HAVE_DYNAMIC_LOADING
Guido van Rossumed1170e1999-12-20 21:23:41 +0000131 memcpy(filetab, _PyImport_DynLoadFiletab,
132 countD * sizeof(struct filedescr));
Guido van Rossum04110fb2007-08-24 16:32:05 +0000133#endif
Guido van Rossumed1170e1999-12-20 21:23:41 +0000134 memcpy(filetab + countD, _PyImport_StandardFiletab,
135 countS * sizeof(struct filedescr));
136 filetab[countD + countS].suffix = NULL;
137
138 _PyImport_Filetab = filetab;
139
Guido van Rossum0824f631997-03-11 18:37:35 +0000140 if (Py_OptimizeFlag) {
Guido van Rossumed1170e1999-12-20 21:23:41 +0000141 /* Replace ".pyc" with ".pyo" in _PyImport_Filetab */
142 for (; filetab->suffix != NULL; filetab++) {
143 if (strcmp(filetab->suffix, ".pyc") == 0)
144 filetab->suffix = ".pyo";
Guido van Rossum0824f631997-03-11 18:37:35 +0000145 }
146 }
Guido van Rossum96774c12000-05-01 20:19:08 +0000147
Guido van Rossum572dbf82007-04-27 23:53:51 +0000148 {
Guido van Rossum96774c12000-05-01 20:19:08 +0000149 /* Fix the pyc_magic so that byte compiled code created
150 using the all-Unicode method doesn't interfere with
151 code created in normal operation mode. */
152 pyc_magic = MAGIC + 1;
153 }
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000154}
155
Guido van Rossum25ce5661997-08-02 03:10:38 +0000156void
Just van Rossum52e14d62002-12-30 22:08:05 +0000157_PyImportHooks_Init(void)
158{
159 PyObject *v, *path_hooks = NULL, *zimpimport;
160 int err = 0;
161
162 /* adding sys.path_hooks and sys.path_importer_cache, setting up
163 zipimport */
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000164 if (PyType_Ready(&NullImporterType) < 0)
165 goto error;
Just van Rossum52e14d62002-12-30 22:08:05 +0000166
167 if (Py_VerboseFlag)
168 PySys_WriteStderr("# installing zipimport hook\n");
169
170 v = PyList_New(0);
171 if (v == NULL)
172 goto error;
173 err = PySys_SetObject("meta_path", v);
174 Py_DECREF(v);
175 if (err)
176 goto error;
177 v = PyDict_New();
178 if (v == NULL)
179 goto error;
180 err = PySys_SetObject("path_importer_cache", v);
181 Py_DECREF(v);
182 if (err)
183 goto error;
184 path_hooks = PyList_New(0);
185 if (path_hooks == NULL)
186 goto error;
187 err = PySys_SetObject("path_hooks", path_hooks);
188 if (err) {
189 error:
190 PyErr_Print();
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000191 Py_FatalError("initializing sys.meta_path, sys.path_hooks, "
192 "path_importer_cache, or NullImporter failed"
193 );
Just van Rossum52e14d62002-12-30 22:08:05 +0000194 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000195
Just van Rossum52e14d62002-12-30 22:08:05 +0000196 zimpimport = PyImport_ImportModule("zipimport");
197 if (zimpimport == NULL) {
198 PyErr_Clear(); /* No zip import module -- okay */
199 if (Py_VerboseFlag)
200 PySys_WriteStderr("# can't import zipimport\n");
201 }
202 else {
203 PyObject *zipimporter = PyObject_GetAttrString(zimpimport,
204 "zipimporter");
205 Py_DECREF(zimpimport);
206 if (zipimporter == NULL) {
207 PyErr_Clear(); /* No zipimporter object -- okay */
208 if (Py_VerboseFlag)
209 PySys_WriteStderr(
Fred Drake1e5fc552003-07-11 15:01:02 +0000210 "# can't import zipimport.zipimporter\n");
Just van Rossum52e14d62002-12-30 22:08:05 +0000211 }
212 else {
213 /* sys.path_hooks.append(zipimporter) */
214 err = PyList_Append(path_hooks, zipimporter);
215 Py_DECREF(zipimporter);
216 if (err)
217 goto error;
218 if (Py_VerboseFlag)
219 PySys_WriteStderr(
220 "# installed zipimport hook\n");
221 }
222 }
223 Py_DECREF(path_hooks);
224}
225
226void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000227_PyImport_Fini(void)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000228{
229 Py_XDECREF(extensions);
230 extensions = NULL;
Barry Warsaw84294482000-10-03 16:02:05 +0000231 PyMem_DEL(_PyImport_Filetab);
232 _PyImport_Filetab = NULL;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000233}
234
235
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000236/* Locking primitives to prevent parallel imports of the same module
237 in different threads to return with a partially loaded module.
238 These calls are serialized by the global interpreter lock. */
239
240#ifdef WITH_THREAD
241
Guido van Rossum49b56061998-10-01 20:42:43 +0000242#include "pythread.h"
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000243
Guido van Rossum65d5b571998-12-21 19:32:43 +0000244static PyThread_type_lock import_lock = 0;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000245static long import_lock_thread = -1;
246static int import_lock_level = 0;
247
248static void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000249lock_import(void)
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000250{
Guido van Rossum65d5b571998-12-21 19:32:43 +0000251 long me = PyThread_get_thread_ident();
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000252 if (me == -1)
253 return; /* Too bad */
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000254 if (import_lock == NULL) {
Guido van Rossum65d5b571998-12-21 19:32:43 +0000255 import_lock = PyThread_allocate_lock();
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000256 if (import_lock == NULL)
257 return; /* Nothing much we can do. */
258 }
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000259 if (import_lock_thread == me) {
260 import_lock_level++;
261 return;
262 }
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000263 if (import_lock_thread != -1 || !PyThread_acquire_lock(import_lock, 0))
264 {
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000265 PyThreadState *tstate = PyEval_SaveThread();
Guido van Rossum65d5b571998-12-21 19:32:43 +0000266 PyThread_acquire_lock(import_lock, 1);
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000267 PyEval_RestoreThread(tstate);
268 }
269 import_lock_thread = me;
270 import_lock_level = 1;
271}
272
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000273static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000274unlock_import(void)
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000275{
Guido van Rossum65d5b571998-12-21 19:32:43 +0000276 long me = PyThread_get_thread_ident();
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000277 if (me == -1 || import_lock == NULL)
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000278 return 0; /* Too bad */
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000279 if (import_lock_thread != me)
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000280 return -1;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000281 import_lock_level--;
282 if (import_lock_level == 0) {
283 import_lock_thread = -1;
Guido van Rossum65d5b571998-12-21 19:32:43 +0000284 PyThread_release_lock(import_lock);
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000285 }
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000286 return 1;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000287}
288
Guido van Rossum8ee3e5a2005-09-14 18:09:42 +0000289/* This function is called from PyOS_AfterFork to ensure that newly
290 created child processes do not share locks with the parent. */
291
292void
293_PyImport_ReInitLock(void)
294{
295#ifdef _AIX
296 if (import_lock != NULL)
297 import_lock = PyThread_allocate_lock();
298#endif
299}
300
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000301#else
302
303#define lock_import()
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000304#define unlock_import() 0
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000305
306#endif
307
Tim Peters69232342001-08-30 05:16:13 +0000308static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000309imp_lock_held(PyObject *self, PyObject *noargs)
Tim Peters69232342001-08-30 05:16:13 +0000310{
Tim Peters69232342001-08-30 05:16:13 +0000311#ifdef WITH_THREAD
Guido van Rossumb8bff3f2002-04-07 06:34:38 +0000312 return PyBool_FromLong(import_lock_thread != -1);
Tim Peters69232342001-08-30 05:16:13 +0000313#else
Guido van Rossumb8bff3f2002-04-07 06:34:38 +0000314 return PyBool_FromLong(0);
Tim Peters69232342001-08-30 05:16:13 +0000315#endif
316}
317
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000318static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000319imp_acquire_lock(PyObject *self, PyObject *noargs)
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000320{
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000321#ifdef WITH_THREAD
322 lock_import();
323#endif
Neal Norwitz2294c0d2003-02-12 23:02:21 +0000324 Py_INCREF(Py_None);
325 return Py_None;
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000326}
327
328static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000329imp_release_lock(PyObject *self, PyObject *noargs)
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000330{
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000331#ifdef WITH_THREAD
332 if (unlock_import() < 0) {
333 PyErr_SetString(PyExc_RuntimeError,
334 "not holding the import lock");
335 return NULL;
336 }
337#endif
Neal Norwitz2294c0d2003-02-12 23:02:21 +0000338 Py_INCREF(Py_None);
339 return Py_None;
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000340}
341
Guido van Rossumd8faa362007-04-27 19:54:29 +0000342static void
343imp_modules_reloading_clear(void)
344{
345 PyInterpreterState *interp = PyThreadState_Get()->interp;
346 if (interp->modules_reloading != NULL)
347 PyDict_Clear(interp->modules_reloading);
348}
349
Guido van Rossum25ce5661997-08-02 03:10:38 +0000350/* Helper for sys */
351
352PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000353PyImport_GetModuleDict(void)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000354{
Nicholas Bastine5662ae2004-03-24 22:22:12 +0000355 PyInterpreterState *interp = PyThreadState_GET()->interp;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000356 if (interp->modules == NULL)
357 Py_FatalError("PyImport_GetModuleDict: no module dictionary!");
358 return interp->modules;
359}
360
Guido van Rossum3f5da241990-12-20 15:06:42 +0000361
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000362/* List of names to clear in sys */
363static char* sys_deletes[] = {
Collin Winter670e6922007-03-21 02:57:17 +0000364 "path", "argv", "ps1", "ps2",
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000365 "last_type", "last_value", "last_traceback",
Just van Rossum52e14d62002-12-30 22:08:05 +0000366 "path_hooks", "path_importer_cache", "meta_path",
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000367 NULL
368};
369
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000370static char* sys_files[] = {
371 "stdin", "__stdin__",
372 "stdout", "__stdout__",
373 "stderr", "__stderr__",
374 NULL
375};
376
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000377
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000378/* Un-initialize things, as good as we can */
Guido van Rossum3f5da241990-12-20 15:06:42 +0000379
Guido van Rossum3f5da241990-12-20 15:06:42 +0000380void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000381PyImport_Cleanup(void)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000382{
Martin v. Löwis18e16552006-02-15 17:27:45 +0000383 Py_ssize_t pos, ndone;
Guido van Rossum758eec01998-01-19 21:58:26 +0000384 char *name;
385 PyObject *key, *value, *dict;
Nicholas Bastine5662ae2004-03-24 22:22:12 +0000386 PyInterpreterState *interp = PyThreadState_GET()->interp;
Guido van Rossum758eec01998-01-19 21:58:26 +0000387 PyObject *modules = interp->modules;
388
389 if (modules == NULL)
390 return; /* Already done */
391
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000392 /* Delete some special variables first. These are common
393 places where user values hide and people complain when their
394 destructors fail. Since the modules containing them are
395 deleted *last* of all, they would come too late in the normal
396 destruction order. Sigh. */
397
398 value = PyDict_GetItemString(modules, "__builtin__");
399 if (value != NULL && PyModule_Check(value)) {
400 dict = PyModule_GetDict(value);
401 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000402 PySys_WriteStderr("# clear __builtin__._\n");
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000403 PyDict_SetItemString(dict, "_", Py_None);
404 }
405 value = PyDict_GetItemString(modules, "sys");
406 if (value != NULL && PyModule_Check(value)) {
407 char **p;
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000408 PyObject *v;
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000409 dict = PyModule_GetDict(value);
410 for (p = sys_deletes; *p != NULL; p++) {
411 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000412 PySys_WriteStderr("# clear sys.%s\n", *p);
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000413 PyDict_SetItemString(dict, *p, Py_None);
414 }
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000415 for (p = sys_files; *p != NULL; p+=2) {
416 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000417 PySys_WriteStderr("# restore sys.%s\n", *p);
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000418 v = PyDict_GetItemString(dict, *(p+1));
419 if (v == NULL)
420 v = Py_None;
421 PyDict_SetItemString(dict, *p, v);
422 }
423 }
424
425 /* First, delete __main__ */
426 value = PyDict_GetItemString(modules, "__main__");
427 if (value != NULL && PyModule_Check(value)) {
428 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000429 PySys_WriteStderr("# cleanup __main__\n");
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000430 _PyModule_Clear(value);
431 PyDict_SetItemString(modules, "__main__", Py_None);
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000432 }
433
Guido van Rossum758eec01998-01-19 21:58:26 +0000434 /* The special treatment of __builtin__ here is because even
435 when it's not referenced as a module, its dictionary is
436 referenced by almost every module's __builtins__. Since
437 deleting a module clears its dictionary (even if there are
438 references left to it), we need to delete the __builtin__
439 module last. Likewise, we don't delete sys until the very
440 end because it is implicitly referenced (e.g. by print).
441
442 Also note that we 'delete' modules by replacing their entry
443 in the modules dict with None, rather than really deleting
444 them; this avoids a rehash of the modules dictionary and
445 also marks them as "non existent" so they won't be
446 re-imported. */
447
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000448 /* Next, repeatedly delete modules with a reference count of
Guido van Rossum758eec01998-01-19 21:58:26 +0000449 one (skipping __builtin__ and sys) and delete them */
450 do {
451 ndone = 0;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000452 pos = 0;
Guido van Rossum758eec01998-01-19 21:58:26 +0000453 while (PyDict_Next(modules, &pos, &key, &value)) {
454 if (value->ob_refcnt != 1)
455 continue;
Neal Norwitz80e7f272007-08-26 06:45:23 +0000456 if (PyUnicode_Check(key) && PyModule_Check(value)) {
457 name = PyUnicode_AsString(key);
Guido van Rossum758eec01998-01-19 21:58:26 +0000458 if (strcmp(name, "__builtin__") == 0)
459 continue;
460 if (strcmp(name, "sys") == 0)
461 continue;
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000462 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000463 PySys_WriteStderr(
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000464 "# cleanup[1] %s\n", name);
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000465 _PyModule_Clear(value);
Guido van Rossum758eec01998-01-19 21:58:26 +0000466 PyDict_SetItem(modules, key, Py_None);
467 ndone++;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000468 }
469 }
Guido van Rossum758eec01998-01-19 21:58:26 +0000470 } while (ndone > 0);
471
Guido van Rossum758eec01998-01-19 21:58:26 +0000472 /* Next, delete all modules (still skipping __builtin__ and sys) */
473 pos = 0;
474 while (PyDict_Next(modules, &pos, &key, &value)) {
Neal Norwitz80e7f272007-08-26 06:45:23 +0000475 if (PyUnicode_Check(key) && PyModule_Check(value)) {
476 name = PyUnicode_AsString(key);
Guido van Rossum758eec01998-01-19 21:58:26 +0000477 if (strcmp(name, "__builtin__") == 0)
478 continue;
479 if (strcmp(name, "sys") == 0)
480 continue;
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000481 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000482 PySys_WriteStderr("# cleanup[2] %s\n", name);
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000483 _PyModule_Clear(value);
Guido van Rossum758eec01998-01-19 21:58:26 +0000484 PyDict_SetItem(modules, key, Py_None);
485 }
486 }
487
488 /* Next, delete sys and __builtin__ (in that order) */
489 value = PyDict_GetItemString(modules, "sys");
490 if (value != NULL && PyModule_Check(value)) {
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000491 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000492 PySys_WriteStderr("# cleanup sys\n");
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000493 _PyModule_Clear(value);
Guido van Rossum758eec01998-01-19 21:58:26 +0000494 PyDict_SetItemString(modules, "sys", Py_None);
495 }
496 value = PyDict_GetItemString(modules, "__builtin__");
497 if (value != NULL && PyModule_Check(value)) {
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000498 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000499 PySys_WriteStderr("# cleanup __builtin__\n");
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000500 _PyModule_Clear(value);
Guido van Rossum758eec01998-01-19 21:58:26 +0000501 PyDict_SetItemString(modules, "__builtin__", Py_None);
502 }
503
504 /* Finally, clear and delete the modules directory */
505 PyDict_Clear(modules);
506 interp->modules = NULL;
507 Py_DECREF(modules);
Guido van Rossumd8faa362007-04-27 19:54:29 +0000508 Py_CLEAR(interp->modules_reloading);
Guido van Rossum8d15b5d1990-10-26 14:58:58 +0000509}
Guido van Rossum7f133ed1991-02-19 12:23:57 +0000510
511
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000512/* Helper for pythonrun.c -- return magic number */
513
514long
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000515PyImport_GetMagicNumber(void)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000516{
Guido van Rossum96774c12000-05-01 20:19:08 +0000517 return pyc_magic;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000518}
519
520
Guido van Rossum25ce5661997-08-02 03:10:38 +0000521/* Magic for extension modules (built-in as well as dynamically
522 loaded). To prevent initializing an extension module more than
523 once, we keep a static dictionary 'extensions' keyed by module name
524 (for built-in modules) or by filename (for dynamically loaded
Barry Warsaw92883382001-08-13 23:05:44 +0000525 modules), containing these modules. A copy of the module's
Guido van Rossum25ce5661997-08-02 03:10:38 +0000526 dictionary is stored by calling _PyImport_FixupExtension()
527 immediately after the module initialization function succeeds. A
528 copy can be retrieved from there by calling
529 _PyImport_FindExtension(). */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000530
Guido van Rossum79f25d91997-04-29 20:08:16 +0000531PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000532_PyImport_FixupExtension(char *name, char *filename)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000533{
Guido van Rossum25ce5661997-08-02 03:10:38 +0000534 PyObject *modules, *mod, *dict, *copy;
535 if (extensions == NULL) {
536 extensions = PyDict_New();
537 if (extensions == NULL)
538 return NULL;
539 }
540 modules = PyImport_GetModuleDict();
541 mod = PyDict_GetItemString(modules, name);
542 if (mod == NULL || !PyModule_Check(mod)) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000543 PyErr_Format(PyExc_SystemError,
544 "_PyImport_FixupExtension: module %.200s not loaded", name);
Guido van Rossum25ce5661997-08-02 03:10:38 +0000545 return NULL;
546 }
547 dict = PyModule_GetDict(mod);
548 if (dict == NULL)
549 return NULL;
Fred Drake9cd0efc2001-10-25 21:38:59 +0000550 copy = PyDict_Copy(dict);
Guido van Rossum25ce5661997-08-02 03:10:38 +0000551 if (copy == NULL)
552 return NULL;
553 PyDict_SetItemString(extensions, filename, copy);
554 Py_DECREF(copy);
555 return copy;
556}
557
558PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000559_PyImport_FindExtension(char *name, char *filename)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000560{
Fred Drake9cd0efc2001-10-25 21:38:59 +0000561 PyObject *dict, *mod, *mdict;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000562 if (extensions == NULL)
563 return NULL;
564 dict = PyDict_GetItemString(extensions, filename);
565 if (dict == NULL)
566 return NULL;
567 mod = PyImport_AddModule(name);
568 if (mod == NULL)
569 return NULL;
570 mdict = PyModule_GetDict(mod);
571 if (mdict == NULL)
572 return NULL;
Fred Drake9cd0efc2001-10-25 21:38:59 +0000573 if (PyDict_Update(mdict, dict))
Guido van Rossum25ce5661997-08-02 03:10:38 +0000574 return NULL;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000575 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000576 PySys_WriteStderr("import %s # previously loaded (%s)\n",
Guido van Rossum25ce5661997-08-02 03:10:38 +0000577 name, filename);
578 return mod;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000579}
580
581
582/* Get the module object corresponding to a module name.
583 First check the modules dictionary if there's one there,
Walter Dörwaldf0dfc7a2003-10-20 14:01:56 +0000584 if not, create a new one and insert it in the modules dictionary.
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000585 Because the former action is most common, THIS DOES NOT RETURN A
586 'NEW' REFERENCE! */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000587
Guido van Rossum79f25d91997-04-29 20:08:16 +0000588PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000589PyImport_AddModule(const char *name)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000590{
Guido van Rossum25ce5661997-08-02 03:10:38 +0000591 PyObject *modules = PyImport_GetModuleDict();
Guido van Rossum79f25d91997-04-29 20:08:16 +0000592 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000593
Guido van Rossum25ce5661997-08-02 03:10:38 +0000594 if ((m = PyDict_GetItemString(modules, name)) != NULL &&
Guido van Rossum79f25d91997-04-29 20:08:16 +0000595 PyModule_Check(m))
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000596 return m;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000597 m = PyModule_New(name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000598 if (m == NULL)
599 return NULL;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000600 if (PyDict_SetItemString(modules, name, m) != 0) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000601 Py_DECREF(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000602 return NULL;
603 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000604 Py_DECREF(m); /* Yes, it still exists, in modules! */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000605
606 return m;
607}
608
Tim Peters1cd70172004-08-02 03:52:12 +0000609/* Remove name from sys.modules, if it's there. */
610static void
611_RemoveModule(const char *name)
612{
613 PyObject *modules = PyImport_GetModuleDict();
614 if (PyDict_GetItemString(modules, name) == NULL)
615 return;
616 if (PyDict_DelItemString(modules, name) < 0)
617 Py_FatalError("import: deleting existing key in"
618 "sys.modules failed");
619}
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000620
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000621/* Execute a code object in a module and return the module object
Tim Peters1cd70172004-08-02 03:52:12 +0000622 * WITH INCREMENTED REFERENCE COUNT. If an error occurs, name is
623 * removed from sys.modules, to avoid leaving damaged module objects
624 * in sys.modules. The caller may wish to restore the original
625 * module object (if any) in this case; PyImport_ReloadModule is an
626 * example.
627 */
Guido van Rossum79f25d91997-04-29 20:08:16 +0000628PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000629PyImport_ExecCodeModule(char *name, PyObject *co)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000630{
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000631 return PyImport_ExecCodeModuleEx(name, co, (char *)NULL);
632}
633
634PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000635PyImport_ExecCodeModuleEx(char *name, PyObject *co, char *pathname)
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000636{
Guido van Rossum25ce5661997-08-02 03:10:38 +0000637 PyObject *modules = PyImport_GetModuleDict();
Guido van Rossum79f25d91997-04-29 20:08:16 +0000638 PyObject *m, *d, *v;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000639
Guido van Rossum79f25d91997-04-29 20:08:16 +0000640 m = PyImport_AddModule(name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000641 if (m == NULL)
642 return NULL;
Jeremy Hyltonecd91292004-01-02 23:25:32 +0000643 /* If the module is being reloaded, we get the old module back
644 and re-use its dict to exec the new code. */
Guido van Rossum79f25d91997-04-29 20:08:16 +0000645 d = PyModule_GetDict(m);
646 if (PyDict_GetItemString(d, "__builtins__") == NULL) {
647 if (PyDict_SetItemString(d, "__builtins__",
648 PyEval_GetBuiltins()) != 0)
Tim Peters1cd70172004-08-02 03:52:12 +0000649 goto error;
Guido van Rossum6135a871995-01-09 17:53:26 +0000650 }
Guido van Rossum9c9a07c1996-05-16 20:43:40 +0000651 /* Remember the filename as the __file__ attribute */
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000652 v = NULL;
653 if (pathname != NULL) {
654 v = PyString_FromString(pathname);
655 if (v == NULL)
656 PyErr_Clear();
657 }
658 if (v == NULL) {
659 v = ((PyCodeObject *)co)->co_filename;
660 Py_INCREF(v);
661 }
662 if (PyDict_SetItemString(d, "__file__", v) != 0)
Guido van Rossum79f25d91997-04-29 20:08:16 +0000663 PyErr_Clear(); /* Not important enough to report */
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000664 Py_DECREF(v);
665
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000666 v = PyEval_EvalCode((PyCodeObject *)co, d, d);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000667 if (v == NULL)
Tim Peters1cd70172004-08-02 03:52:12 +0000668 goto error;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000669 Py_DECREF(v);
Guido van Rossumb65e85c1997-07-10 18:00:45 +0000670
Guido van Rossum25ce5661997-08-02 03:10:38 +0000671 if ((m = PyDict_GetItemString(modules, name)) == NULL) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000672 PyErr_Format(PyExc_ImportError,
673 "Loaded module %.200s not found in sys.modules",
674 name);
Guido van Rossumb65e85c1997-07-10 18:00:45 +0000675 return NULL;
676 }
677
Guido van Rossum79f25d91997-04-29 20:08:16 +0000678 Py_INCREF(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000679
680 return m;
Tim Peters1cd70172004-08-02 03:52:12 +0000681
682 error:
683 _RemoveModule(name);
684 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000685}
686
687
688/* Given a pathname for a Python source file, fill a buffer with the
689 pathname for the corresponding compiled file. Return the pathname
690 for the compiled file, or NULL if there's no space in the buffer.
691 Doesn't set an exception. */
692
693static char *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000694make_compiled_pathname(char *pathname, char *buf, size_t buflen)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000695{
Tim Petersc1731372001-08-04 08:12:36 +0000696 size_t len = strlen(pathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000697 if (len+2 > buflen)
698 return NULL;
Tim Petersc1731372001-08-04 08:12:36 +0000699
Martin v. Löwis6238d2b2002-06-30 15:26:10 +0000700#ifdef MS_WINDOWS
Tim Petersc1731372001-08-04 08:12:36 +0000701 /* Treat .pyw as if it were .py. The case of ".pyw" must match
702 that used in _PyImport_StandardFiletab. */
703 if (len >= 4 && strcmp(&pathname[len-4], ".pyw") == 0)
704 --len; /* pretend 'w' isn't there */
705#endif
706 memcpy(buf, pathname, len);
707 buf[len] = Py_OptimizeFlag ? 'o' : 'c';
708 buf[len+1] = '\0';
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000709
710 return buf;
711}
712
713
714/* Given a pathname for a Python source file, its time of last
715 modification, and a pathname for a compiled file, check whether the
716 compiled file represents the same version of the source. If so,
717 return a FILE pointer for the compiled file, positioned just after
718 the header; if not, return NULL.
719 Doesn't set an exception. */
720
721static FILE *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000722check_compiled_module(char *pathname, time_t mtime, char *cpathname)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000723{
724 FILE *fp;
725 long magic;
726 long pyc_mtime;
727
728 fp = fopen(cpathname, "rb");
729 if (fp == NULL)
730 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000731 magic = PyMarshal_ReadLongFromFile(fp);
Guido van Rossum96774c12000-05-01 20:19:08 +0000732 if (magic != pyc_magic) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000733 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000734 PySys_WriteStderr("# %s has bad magic\n", cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000735 fclose(fp);
736 return NULL;
737 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000738 pyc_mtime = PyMarshal_ReadLongFromFile(fp);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000739 if (pyc_mtime != mtime) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000740 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000741 PySys_WriteStderr("# %s has bad mtime\n", cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000742 fclose(fp);
743 return NULL;
744 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000745 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000746 PySys_WriteStderr("# %s matches %s\n", cpathname, pathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000747 return fp;
748}
749
750
751/* Read a code object from a file and check it for validity */
752
Guido van Rossum79f25d91997-04-29 20:08:16 +0000753static PyCodeObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000754read_compiled_module(char *cpathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000755{
Guido van Rossum79f25d91997-04-29 20:08:16 +0000756 PyObject *co;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000757
Tim Petersd9b9ac82001-01-28 00:27:39 +0000758 co = PyMarshal_ReadLastObjectFromFile(fp);
Armin Rigo01ab2792004-03-26 15:09:27 +0000759 if (co == NULL)
760 return NULL;
761 if (!PyCode_Check(co)) {
762 PyErr_Format(PyExc_ImportError,
763 "Non-code object in %.200s", cpathname);
764 Py_DECREF(co);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000765 return NULL;
766 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000767 return (PyCodeObject *)co;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000768}
769
770
771/* Load a module from a compiled file, execute it, and return its
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000772 module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000773
Guido van Rossum79f25d91997-04-29 20:08:16 +0000774static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000775load_compiled_module(char *name, char *cpathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000776{
777 long magic;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000778 PyCodeObject *co;
779 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000780
Guido van Rossum79f25d91997-04-29 20:08:16 +0000781 magic = PyMarshal_ReadLongFromFile(fp);
Guido van Rossum96774c12000-05-01 20:19:08 +0000782 if (magic != pyc_magic) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000783 PyErr_Format(PyExc_ImportError,
784 "Bad magic number in %.200s", cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000785 return NULL;
786 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000787 (void) PyMarshal_ReadLongFromFile(fp);
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000788 co = read_compiled_module(cpathname, fp);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000789 if (co == NULL)
790 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000791 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000792 PySys_WriteStderr("import %s # precompiled from %s\n",
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000793 name, cpathname);
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000794 m = PyImport_ExecCodeModuleEx(name, (PyObject *)co, cpathname);
Guido van Rossum79f25d91997-04-29 20:08:16 +0000795 Py_DECREF(co);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000796
797 return m;
798}
799
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000800/* Parse a source file and return the corresponding code object */
801
Guido van Rossum79f25d91997-04-29 20:08:16 +0000802static PyCodeObject *
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000803parse_source_module(const char *pathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000804{
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000805 PyCodeObject *co = NULL;
806 mod_ty mod;
Thomas Wouters89f507f2006-12-13 04:49:30 +0000807 PyArena *arena = PyArena_New();
808 if (arena == NULL)
809 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000810
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000811 mod = PyParser_ASTFromFile(fp, pathname, Py_file_input, 0, 0, 0,
Neal Norwitzadb69fc2005-12-17 20:54:49 +0000812 NULL, arena);
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000813 if (mod) {
Neal Norwitzadb69fc2005-12-17 20:54:49 +0000814 co = PyAST_Compile(mod, pathname, NULL, arena);
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000815 }
Thomas Wouters89f507f2006-12-13 04:49:30 +0000816 PyArena_Free(arena);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000817 return co;
818}
819
820
Guido van Rossum55a83382000-09-20 20:31:38 +0000821/* Helper to open a bytecode file for writing in exclusive mode */
822
823static FILE *
824open_exclusive(char *filename)
825{
826#if defined(O_EXCL)&&defined(O_CREAT)&&defined(O_WRONLY)&&defined(O_TRUNC)
827 /* Use O_EXCL to avoid a race condition when another process tries to
828 write the same file. When that happens, our open() call fails,
829 which is just fine (since it's only a cache).
830 XXX If the file exists and is writable but the directory is not
831 writable, the file will never be written. Oh well.
832 */
833 int fd;
834 (void) unlink(filename);
Tim Peters42c83af2000-09-29 04:03:10 +0000835 fd = open(filename, O_EXCL|O_CREAT|O_WRONLY|O_TRUNC
836#ifdef O_BINARY
837 |O_BINARY /* necessary for Windows */
838#endif
Martin v. Löwis79acb9e2002-12-06 12:48:53 +0000839#ifdef __VMS
Martin v. Löwis18e16552006-02-15 17:27:45 +0000840 , 0666, "ctxt=bin", "shr=nil"
Martin v. Löwis79acb9e2002-12-06 12:48:53 +0000841#else
Martin v. Löwis18e16552006-02-15 17:27:45 +0000842 , 0666
Martin v. Löwis79acb9e2002-12-06 12:48:53 +0000843#endif
Martin v. Löwis18e16552006-02-15 17:27:45 +0000844 );
Guido van Rossum55a83382000-09-20 20:31:38 +0000845 if (fd < 0)
846 return NULL;
847 return fdopen(fd, "wb");
848#else
849 /* Best we can do -- on Windows this can't happen anyway */
850 return fopen(filename, "wb");
851#endif
852}
853
854
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000855/* Write a compiled module to a file, placing the time of last
856 modification of its source into the header.
857 Errors are ignored, if a write error occurs an attempt is made to
858 remove the file. */
859
860static void
Martin v. Löwis18e16552006-02-15 17:27:45 +0000861write_compiled_module(PyCodeObject *co, char *cpathname, time_t mtime)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000862{
863 FILE *fp;
864
Guido van Rossum55a83382000-09-20 20:31:38 +0000865 fp = open_exclusive(cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000866 if (fp == NULL) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000867 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000868 PySys_WriteStderr(
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000869 "# can't create %s\n", cpathname);
870 return;
871 }
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000872 PyMarshal_WriteLongToFile(pyc_magic, fp, Py_MARSHAL_VERSION);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000873 /* First write a 0 for mtime */
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000874 PyMarshal_WriteLongToFile(0L, fp, Py_MARSHAL_VERSION);
875 PyMarshal_WriteObjectToFile((PyObject *)co, fp, Py_MARSHAL_VERSION);
Armin Rigo01ab2792004-03-26 15:09:27 +0000876 if (fflush(fp) != 0 || ferror(fp)) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000877 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000878 PySys_WriteStderr("# can't write %s\n", cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000879 /* Don't keep partial file */
880 fclose(fp);
881 (void) unlink(cpathname);
882 return;
883 }
884 /* Now write the true mtime */
885 fseek(fp, 4L, 0);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000886 assert(mtime < LONG_MAX);
Martin v. Löwis725507b2006-03-07 12:08:51 +0000887 PyMarshal_WriteLongToFile((long)mtime, fp, Py_MARSHAL_VERSION);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000888 fflush(fp);
889 fclose(fp);
Guido van Rossum79f25d91997-04-29 20:08:16 +0000890 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000891 PySys_WriteStderr("# wrote %s\n", cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000892}
893
894
895/* Load a source module from a given file and return its module
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000896 object WITH INCREMENTED REFERENCE COUNT. If there's a matching
897 byte-compiled file, use that instead. */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000898
Guido van Rossum79f25d91997-04-29 20:08:16 +0000899static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000900load_source_module(char *name, char *pathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000901{
Fred Drake4c82b232000-06-30 16:18:57 +0000902 time_t mtime;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000903 FILE *fpc;
904 char buf[MAXPATHLEN+1];
905 char *cpathname;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000906 PyCodeObject *co;
907 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000908
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000909 mtime = PyOS_GetLastModificationTime(pathname, fp);
Neal Norwitz708e51a2005-10-03 04:48:15 +0000910 if (mtime == (time_t)(-1)) {
911 PyErr_Format(PyExc_RuntimeError,
912 "unable to get modification time from '%s'",
913 pathname);
Fred Drake4c82b232000-06-30 16:18:57 +0000914 return NULL;
Neal Norwitz708e51a2005-10-03 04:48:15 +0000915 }
Fred Drake4c82b232000-06-30 16:18:57 +0000916#if SIZEOF_TIME_T > 4
917 /* Python's .pyc timestamp handling presumes that the timestamp fits
918 in 4 bytes. This will be fine until sometime in the year 2038,
919 when a 4-byte signed time_t will overflow.
920 */
921 if (mtime >> 32) {
922 PyErr_SetString(PyExc_OverflowError,
Fred Drakec63d3e92001-03-01 06:33:32 +0000923 "modification time overflows a 4 byte field");
Fred Drake4c82b232000-06-30 16:18:57 +0000924 return NULL;
925 }
926#endif
Tim Peters36515e22001-11-18 04:06:29 +0000927 cpathname = make_compiled_pathname(pathname, buf,
Jeremy Hylton37832f02001-04-13 17:50:20 +0000928 (size_t)MAXPATHLEN + 1);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000929 if (cpathname != NULL &&
930 (fpc = check_compiled_module(pathname, mtime, cpathname))) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000931 co = read_compiled_module(cpathname, fpc);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000932 fclose(fpc);
933 if (co == NULL)
934 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000935 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000936 PySys_WriteStderr("import %s # precompiled from %s\n",
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000937 name, cpathname);
Guido van Rossumafd3dae1998-08-25 18:44:34 +0000938 pathname = cpathname;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000939 }
940 else {
941 co = parse_source_module(pathname, fp);
942 if (co == NULL)
943 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000944 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000945 PySys_WriteStderr("import %s # from %s\n",
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000946 name, pathname);
Thomas Wouters00ee7ba2006-08-21 19:07:27 +0000947 if (cpathname)
948 write_compiled_module(co, cpathname, mtime);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000949 }
Guido van Rossumafd3dae1998-08-25 18:44:34 +0000950 m = PyImport_ExecCodeModuleEx(name, (PyObject *)co, pathname);
Guido van Rossum79f25d91997-04-29 20:08:16 +0000951 Py_DECREF(co);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000952
953 return m;
954}
955
956
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000957/* Forward */
Just van Rossum52e14d62002-12-30 22:08:05 +0000958static PyObject *load_module(char *, FILE *, char *, int, PyObject *);
959static struct filedescr *find_module(char *, char *, PyObject *,
960 char *, size_t, FILE **, PyObject **);
Tim Petersdbd9ba62000-07-09 03:09:57 +0000961static struct _frozen *find_frozen(char *name);
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000962
963/* Load a package and return its module object WITH INCREMENTED
964 REFERENCE COUNT */
965
966static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000967load_package(char *name, char *pathname)
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000968{
Tim Peters1cd70172004-08-02 03:52:12 +0000969 PyObject *m, *d;
970 PyObject *file = NULL;
971 PyObject *path = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000972 int err;
973 char buf[MAXPATHLEN+1];
974 FILE *fp = NULL;
975 struct filedescr *fdp;
976
977 m = PyImport_AddModule(name);
978 if (m == NULL)
979 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +0000980 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000981 PySys_WriteStderr("import %s # directory %s\n",
Guido van Rossum17fc85f1997-09-06 18:52:03 +0000982 name, pathname);
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000983 d = PyModule_GetDict(m);
984 file = PyString_FromString(pathname);
985 if (file == NULL)
Tim Peters1cd70172004-08-02 03:52:12 +0000986 goto error;
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000987 path = Py_BuildValue("[O]", file);
Tim Peters1cd70172004-08-02 03:52:12 +0000988 if (path == NULL)
989 goto error;
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000990 err = PyDict_SetItemString(d, "__file__", file);
991 if (err == 0)
992 err = PyDict_SetItemString(d, "__path__", path);
Tim Peters1cd70172004-08-02 03:52:12 +0000993 if (err != 0)
994 goto error;
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000995 buf[0] = '\0';
Just van Rossum52e14d62002-12-30 22:08:05 +0000996 fdp = find_module(name, "__init__", path, buf, sizeof(buf), &fp, NULL);
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000997 if (fdp == NULL) {
998 if (PyErr_ExceptionMatches(PyExc_ImportError)) {
999 PyErr_Clear();
Thomas Heller25653242004-06-07 15:04:10 +00001000 Py_INCREF(m);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001001 }
1002 else
1003 m = NULL;
1004 goto cleanup;
1005 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001006 m = load_module(name, fp, buf, fdp->type, NULL);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001007 if (fp != NULL)
1008 fclose(fp);
Tim Peters1cd70172004-08-02 03:52:12 +00001009 goto cleanup;
1010
1011 error:
1012 m = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001013 cleanup:
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001014 Py_XDECREF(path);
1015 Py_XDECREF(file);
1016 return m;
1017}
1018
1019
1020/* Helper to test for built-in module */
1021
1022static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001023is_builtin(char *name)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001024{
1025 int i;
Guido van Rossum771c6c81997-10-31 18:37:24 +00001026 for (i = 0; PyImport_Inittab[i].name != NULL; i++) {
1027 if (strcmp(name, PyImport_Inittab[i].name) == 0) {
1028 if (PyImport_Inittab[i].initfunc == NULL)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001029 return -1;
1030 else
1031 return 1;
1032 }
1033 }
1034 return 0;
1035}
1036
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001037
Just van Rossum52e14d62002-12-30 22:08:05 +00001038/* Return an importer object for a sys.path/pkg.__path__ item 'p',
1039 possibly by fetching it from the path_importer_cache dict. If it
Thomas Wouters89f507f2006-12-13 04:49:30 +00001040 wasn't yet cached, traverse path_hooks until a hook is found
Just van Rossum52e14d62002-12-30 22:08:05 +00001041 that can handle the path item. Return None if no hook could;
1042 this tells our caller it should fall back to the builtin
1043 import mechanism. Cache the result in path_importer_cache.
1044 Returns a borrowed reference. */
1045
1046static PyObject *
1047get_path_importer(PyObject *path_importer_cache, PyObject *path_hooks,
1048 PyObject *p)
1049{
1050 PyObject *importer;
Martin v. Löwis725507b2006-03-07 12:08:51 +00001051 Py_ssize_t j, nhooks;
Just van Rossum52e14d62002-12-30 22:08:05 +00001052
1053 /* These conditions are the caller's responsibility: */
1054 assert(PyList_Check(path_hooks));
1055 assert(PyDict_Check(path_importer_cache));
1056
1057 nhooks = PyList_Size(path_hooks);
1058 if (nhooks < 0)
1059 return NULL; /* Shouldn't happen */
1060
1061 importer = PyDict_GetItem(path_importer_cache, p);
1062 if (importer != NULL)
1063 return importer;
1064
1065 /* set path_importer_cache[p] to None to avoid recursion */
1066 if (PyDict_SetItem(path_importer_cache, p, Py_None) != 0)
1067 return NULL;
1068
1069 for (j = 0; j < nhooks; j++) {
1070 PyObject *hook = PyList_GetItem(path_hooks, j);
1071 if (hook == NULL)
1072 return NULL;
Thomas Wouters477c8d52006-05-27 19:21:47 +00001073 importer = PyObject_CallFunctionObjArgs(hook, p, NULL);
Just van Rossum52e14d62002-12-30 22:08:05 +00001074 if (importer != NULL)
1075 break;
1076
1077 if (!PyErr_ExceptionMatches(PyExc_ImportError)) {
1078 return NULL;
1079 }
1080 PyErr_Clear();
1081 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001082 if (importer == NULL) {
1083 importer = PyObject_CallFunctionObjArgs(
1084 (PyObject *)&NullImporterType, p, NULL
1085 );
1086 if (importer == NULL) {
1087 if (PyErr_ExceptionMatches(PyExc_ImportError)) {
1088 PyErr_Clear();
1089 return Py_None;
1090 }
1091 }
1092 }
1093 if (importer != NULL) {
Just van Rossum52e14d62002-12-30 22:08:05 +00001094 int err = PyDict_SetItem(path_importer_cache, p, importer);
1095 Py_DECREF(importer);
1096 if (err != 0)
1097 return NULL;
1098 }
1099 return importer;
1100}
1101
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001102/* Search the path (default sys.path) for a module. Return the
1103 corresponding filedescr struct, and (via return arguments) the
1104 pathname and an open file. Return NULL if the module is not found. */
1105
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001106#ifdef MS_COREDLL
Thomas Woutersb4bd21c2000-07-22 23:38:01 +00001107extern FILE *PyWin_FindRegisteredModule(const char *, struct filedescr **,
Martin v. Löwis18e16552006-02-15 17:27:45 +00001108 char *, Py_ssize_t);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001109#endif
1110
Martin v. Löwis18e16552006-02-15 17:27:45 +00001111static int case_ok(char *, Py_ssize_t, Py_ssize_t, char *);
Tim Petersdbd9ba62000-07-09 03:09:57 +00001112static int find_init_module(char *); /* Forward */
Just van Rossum52e14d62002-12-30 22:08:05 +00001113static struct filedescr importhookdescr = {"", "", IMP_HOOK};
Guido van Rossum197346f1997-10-31 18:38:52 +00001114
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001115static struct filedescr *
Just van Rossum52e14d62002-12-30 22:08:05 +00001116find_module(char *fullname, char *subname, PyObject *path, char *buf,
1117 size_t buflen, FILE **p_fp, PyObject **p_loader)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001118{
Martin v. Löwis725507b2006-03-07 12:08:51 +00001119 Py_ssize_t i, npath;
Fred Drake4c82b232000-06-30 16:18:57 +00001120 size_t len, namelen;
Guido van Rossum80bb9651996-12-05 23:27:02 +00001121 struct filedescr *fdp = NULL;
Jack Jansenc88da1f2002-05-28 10:58:19 +00001122 char *filemode;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001123 FILE *fp = NULL;
Just van Rossum52e14d62002-12-30 22:08:05 +00001124 PyObject *path_hooks, *path_importer_cache;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001125 struct stat statbuf;
Guido van Rossuma5568d31998-03-05 03:45:08 +00001126 static struct filedescr fd_frozen = {"", "", PY_FROZEN};
1127 static struct filedescr fd_builtin = {"", "", C_BUILTIN};
1128 static struct filedescr fd_package = {"", "", PKG_DIRECTORY};
Guido van Rossum0506a431998-08-11 15:07:39 +00001129 char name[MAXPATHLEN+1];
Andrew MacIntyred9400542002-02-26 11:41:34 +00001130#if defined(PYOS_OS2)
1131 size_t saved_len;
1132 size_t saved_namelen;
1133 char *saved_buf = NULL;
1134#endif
Just van Rossum52e14d62002-12-30 22:08:05 +00001135 if (p_loader != NULL)
1136 *p_loader = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001137
Just van Rossum52e14d62002-12-30 22:08:05 +00001138 if (strlen(subname) > MAXPATHLEN) {
Guido van Rossum8f4d3312001-10-18 18:54:11 +00001139 PyErr_SetString(PyExc_OverflowError,
1140 "module name is too long");
Fred Drake4c82b232000-06-30 16:18:57 +00001141 return NULL;
1142 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001143 strcpy(name, subname);
1144
1145 /* sys.meta_path import hook */
1146 if (p_loader != NULL) {
1147 PyObject *meta_path;
1148
1149 meta_path = PySys_GetObject("meta_path");
1150 if (meta_path == NULL || !PyList_Check(meta_path)) {
1151 PyErr_SetString(PyExc_ImportError,
1152 "sys.meta_path must be a list of "
1153 "import hooks");
1154 return NULL;
1155 }
1156 Py_INCREF(meta_path); /* zap guard */
1157 npath = PyList_Size(meta_path);
1158 for (i = 0; i < npath; i++) {
1159 PyObject *loader;
1160 PyObject *hook = PyList_GetItem(meta_path, i);
1161 loader = PyObject_CallMethod(hook, "find_module",
1162 "sO", fullname,
1163 path != NULL ?
1164 path : Py_None);
1165 if (loader == NULL) {
1166 Py_DECREF(meta_path);
1167 return NULL; /* true error */
1168 }
1169 if (loader != Py_None) {
1170 /* a loader was found */
1171 *p_loader = loader;
1172 Py_DECREF(meta_path);
1173 return &importhookdescr;
1174 }
1175 Py_DECREF(loader);
1176 }
1177 Py_DECREF(meta_path);
1178 }
Guido van Rossum0506a431998-08-11 15:07:39 +00001179
Guido van Rossum13d77992007-07-23 03:16:50 +00001180 if (path != NULL && PyUnicode_Check(path)) {
Guido van Rossum8f4d3312001-10-18 18:54:11 +00001181 /* The only type of submodule allowed inside a "frozen"
1182 package are other frozen modules or packages. */
Guido van Rossum13d77992007-07-23 03:16:50 +00001183 char *p = PyUnicode_AsString(path);
1184 if (strlen(p) + 1 + strlen(name) >= (size_t)buflen) {
Guido van Rossum0506a431998-08-11 15:07:39 +00001185 PyErr_SetString(PyExc_ImportError,
1186 "full frozen module name too long");
1187 return NULL;
1188 }
Guido van Rossum13d77992007-07-23 03:16:50 +00001189 strcpy(buf, p);
Guido van Rossum0506a431998-08-11 15:07:39 +00001190 strcat(buf, ".");
1191 strcat(buf, name);
1192 strcpy(name, buf);
Guido van Rossum8f4d3312001-10-18 18:54:11 +00001193 if (find_frozen(name) != NULL) {
1194 strcpy(buf, name);
1195 return &fd_frozen;
1196 }
1197 PyErr_Format(PyExc_ImportError,
1198 "No frozen submodule named %.200s", name);
1199 return NULL;
Guido van Rossum0506a431998-08-11 15:07:39 +00001200 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001201 if (path == NULL) {
1202 if (is_builtin(name)) {
Guido van Rossuma5568d31998-03-05 03:45:08 +00001203 strcpy(buf, name);
1204 return &fd_builtin;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001205 }
Greg Ward201baee2001-10-04 14:52:06 +00001206 if ((find_frozen(name)) != NULL) {
Guido van Rossuma5568d31998-03-05 03:45:08 +00001207 strcpy(buf, name);
1208 return &fd_frozen;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001209 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001210
Guido van Rossumac279101996-08-22 23:10:58 +00001211#ifdef MS_COREDLL
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001212 fp = PyWin_FindRegisteredModule(name, &fdp, buf, buflen);
1213 if (fp != NULL) {
1214 *p_fp = fp;
1215 return fdp;
1216 }
Guido van Rossuma5a3db71996-04-09 02:39:59 +00001217#endif
Guido van Rossuma5568d31998-03-05 03:45:08 +00001218 path = PySys_GetObject("path");
1219 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00001220 if (path == NULL || !PyList_Check(path)) {
1221 PyErr_SetString(PyExc_ImportError,
Guido van Rossuma5568d31998-03-05 03:45:08 +00001222 "sys.path must be a list of directory names");
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001223 return NULL;
1224 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001225
1226 path_hooks = PySys_GetObject("path_hooks");
1227 if (path_hooks == NULL || !PyList_Check(path_hooks)) {
1228 PyErr_SetString(PyExc_ImportError,
1229 "sys.path_hooks must be a list of "
1230 "import hooks");
1231 return NULL;
1232 }
1233 path_importer_cache = PySys_GetObject("path_importer_cache");
1234 if (path_importer_cache == NULL ||
1235 !PyDict_Check(path_importer_cache)) {
1236 PyErr_SetString(PyExc_ImportError,
1237 "sys.path_importer_cache must be a dict");
1238 return NULL;
1239 }
1240
Guido van Rossum79f25d91997-04-29 20:08:16 +00001241 npath = PyList_Size(path);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001242 namelen = strlen(name);
1243 for (i = 0; i < npath; i++) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00001244 PyObject *v = PyList_GetItem(path, i);
Guido van Rossumf15a29f2007-05-04 00:41:39 +00001245 PyObject *origv = v;
Guido van Rossum6262cc72007-05-09 23:29:27 +00001246 const char *base;
Guido van Rossumf15a29f2007-05-04 00:41:39 +00001247 Py_ssize_t size;
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001248 if (!v)
1249 return NULL;
Guido van Rossuma4b8d1d2007-08-27 15:02:28 +00001250 if (PyUnicode_Check(v)) {
1251 v = _PyUnicode_AsDefaultEncodedString(v, NULL);
1252 if (v == NULL)
1253 return NULL;
1254 }
1255 if (!PyString_Check(v))
1256 continue;
1257 base = PyString_AS_STRING(v);
1258 size = PyString_GET_SIZE(v);
Guido van Rossumf15a29f2007-05-04 00:41:39 +00001259 len = size;
Walter Dörwald3430d702002-06-17 10:43:59 +00001260 if (len + 2 + namelen + MAXSUFFIXSIZE >= buflen) {
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001261 continue; /* Too long */
Walter Dörwald3430d702002-06-17 10:43:59 +00001262 }
Guido van Rossumf15a29f2007-05-04 00:41:39 +00001263 strcpy(buf, base);
Walter Dörwald3430d702002-06-17 10:43:59 +00001264 if (strlen(buf) != len) {
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001265 continue; /* v contains '\0' */
Walter Dörwald3430d702002-06-17 10:43:59 +00001266 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001267
1268 /* sys.path_hooks import hook */
1269 if (p_loader != NULL) {
1270 PyObject *importer;
1271
1272 importer = get_path_importer(path_importer_cache,
Guido van Rossumf15a29f2007-05-04 00:41:39 +00001273 path_hooks, origv);
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001274 if (importer == NULL) {
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001275 return NULL;
Thomas Wouters477c8d52006-05-27 19:21:47 +00001276 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001277 /* Note: importer is a borrowed reference */
1278 if (importer != Py_None) {
Just van Rossum52e14d62002-12-30 22:08:05 +00001279 PyObject *loader;
1280 loader = PyObject_CallMethod(importer,
1281 "find_module",
1282 "s", fullname);
1283 if (loader == NULL)
1284 return NULL; /* error */
1285 if (loader != Py_None) {
1286 /* a loader was found */
1287 *p_loader = loader;
1288 return &importhookdescr;
1289 }
1290 Py_DECREF(loader);
Thomas Wouters477c8d52006-05-27 19:21:47 +00001291 continue;
Just van Rossum52e14d62002-12-30 22:08:05 +00001292 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001293 }
Thomas Wouters477c8d52006-05-27 19:21:47 +00001294 /* no hook was found, use builtin import */
Just van Rossum52e14d62002-12-30 22:08:05 +00001295
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001296 if (len > 0 && buf[len-1] != SEP
1297#ifdef ALTSEP
1298 && buf[len-1] != ALTSEP
1299#endif
1300 )
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001301 buf[len++] = SEP;
Guido van Rossum215c3402000-11-13 17:26:32 +00001302 strcpy(buf+len, name);
1303 len += namelen;
Tim Peters50d8d372001-02-28 05:34:27 +00001304
1305 /* Check for package import (buf holds a directory name,
1306 and there's an __init__ module in that directory */
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001307#ifdef HAVE_STAT
Walter Dörwald3430d702002-06-17 10:43:59 +00001308 if (stat(buf, &statbuf) == 0 && /* it exists */
1309 S_ISDIR(statbuf.st_mode) && /* it's a directory */
Thomas Wouters477c8d52006-05-27 19:21:47 +00001310 case_ok(buf, len, namelen, name)) { /* case matches */
1311 if (find_init_module(buf)) { /* and has __init__.py */
Thomas Wouters477c8d52006-05-27 19:21:47 +00001312 return &fd_package;
1313 }
1314 else {
1315 char warnstr[MAXPATHLEN+80];
1316 sprintf(warnstr, "Not importing directory "
1317 "'%.*s': missing __init__.py",
1318 MAXPATHLEN, buf);
Skip Montanaro46fc3372007-08-12 11:44:53 +00001319 if (PyErr_WarnEx(PyExc_ImportWarning,
1320 warnstr, 1)) {
Thomas Wouters477c8d52006-05-27 19:21:47 +00001321 return NULL;
1322 }
1323 }
Walter Dörwald3430d702002-06-17 10:43:59 +00001324 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001325#endif
Andrew MacIntyred9400542002-02-26 11:41:34 +00001326#if defined(PYOS_OS2)
1327 /* take a snapshot of the module spec for restoration
1328 * after the 8 character DLL hackery
1329 */
1330 saved_buf = strdup(buf);
1331 saved_len = len;
1332 saved_namelen = namelen;
1333#endif /* PYOS_OS2 */
Guido van Rossum79f25d91997-04-29 20:08:16 +00001334 for (fdp = _PyImport_Filetab; fdp->suffix != NULL; fdp++) {
Guido van Rossum04110fb2007-08-24 16:32:05 +00001335#if defined(PYOS_OS2) && defined(HAVE_DYNAMIC_LOADING)
Jeremy Hylton4ae6fae2002-05-30 17:15:25 +00001336 /* OS/2 limits DLLs to 8 character names (w/o
1337 extension)
Andrew MacIntyred9400542002-02-26 11:41:34 +00001338 * so if the name is longer than that and its a
1339 * dynamically loaded module we're going to try,
1340 * truncate the name before trying
1341 */
Just van Rossum52e14d62002-12-30 22:08:05 +00001342 if (strlen(subname) > 8) {
Andrew MacIntyred9400542002-02-26 11:41:34 +00001343 /* is this an attempt to load a C extension? */
Jeremy Hylton4ae6fae2002-05-30 17:15:25 +00001344 const struct filedescr *scan;
1345 scan = _PyImport_DynLoadFiletab;
Andrew MacIntyred9400542002-02-26 11:41:34 +00001346 while (scan->suffix != NULL) {
Jeremy Hylton4ae6fae2002-05-30 17:15:25 +00001347 if (!strcmp(scan->suffix, fdp->suffix))
Andrew MacIntyred9400542002-02-26 11:41:34 +00001348 break;
1349 else
1350 scan++;
1351 }
1352 if (scan->suffix != NULL) {
1353 /* yes, so truncate the name */
1354 namelen = 8;
Just van Rossum52e14d62002-12-30 22:08:05 +00001355 len -= strlen(subname) - namelen;
Andrew MacIntyred9400542002-02-26 11:41:34 +00001356 buf[len] = '\0';
1357 }
1358 }
1359#endif /* PYOS_OS2 */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001360 strcpy(buf+len, fdp->suffix);
Guido van Rossum79f25d91997-04-29 20:08:16 +00001361 if (Py_VerboseFlag > 1)
Guido van Rossum2f3667a1998-10-12 18:23:55 +00001362 PySys_WriteStderr("# trying %s\n", buf);
Jack Jansenc88da1f2002-05-28 10:58:19 +00001363 filemode = fdp->mode;
Tim Peters86c7d2f2004-08-01 23:24:21 +00001364 if (filemode[0] == 'U')
Jeremy Hylton4ae6fae2002-05-30 17:15:25 +00001365 filemode = "r" PY_STDIOTEXTMODE;
Jack Jansenc88da1f2002-05-28 10:58:19 +00001366 fp = fopen(buf, filemode);
Tim Peters50d8d372001-02-28 05:34:27 +00001367 if (fp != NULL) {
1368 if (case_ok(buf, len, namelen, name))
1369 break;
1370 else { /* continue search */
1371 fclose(fp);
1372 fp = NULL;
Barry Warsaw914a0b12001-02-02 19:12:16 +00001373 }
Barry Warsaw914a0b12001-02-02 19:12:16 +00001374 }
Andrew MacIntyred9400542002-02-26 11:41:34 +00001375#if defined(PYOS_OS2)
1376 /* restore the saved snapshot */
1377 strcpy(buf, saved_buf);
1378 len = saved_len;
1379 namelen = saved_namelen;
1380#endif
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001381 }
Andrew MacIntyred9400542002-02-26 11:41:34 +00001382#if defined(PYOS_OS2)
1383 /* don't need/want the module name snapshot anymore */
1384 if (saved_buf)
1385 {
1386 free(saved_buf);
1387 saved_buf = NULL;
1388 }
1389#endif
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001390 if (fp != NULL)
1391 break;
1392 }
1393 if (fp == NULL) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001394 PyErr_Format(PyExc_ImportError,
1395 "No module named %.200s", name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001396 return NULL;
1397 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001398 *p_fp = fp;
1399 return fdp;
1400}
1401
Raymond Hettingerdb29e0f2004-10-07 06:46:25 +00001402/* Helpers for main.c
1403 * Find the source file corresponding to a named module
1404 */
1405struct filedescr *
1406_PyImport_FindModule(const char *name, PyObject *path, char *buf,
1407 size_t buflen, FILE **p_fp, PyObject **p_loader)
1408{
1409 return find_module((char *) name, (char *) name, path,
1410 buf, buflen, p_fp, p_loader);
1411}
1412
1413PyAPI_FUNC(int) _PyImport_IsScript(struct filedescr * fd)
1414{
1415 return fd->type == PY_SOURCE || fd->type == PY_COMPILED;
1416}
1417
Martin v. Löwis18e16552006-02-15 17:27:45 +00001418/* case_ok(char* buf, Py_ssize_t len, Py_ssize_t namelen, char* name)
Tim Petersd1e87a82001-03-01 18:12:00 +00001419 * The arguments here are tricky, best shown by example:
1420 * /a/b/c/d/e/f/g/h/i/j/k/some_long_module_name.py\0
1421 * ^ ^ ^ ^
1422 * |--------------------- buf ---------------------|
1423 * |------------------- len ------------------|
1424 * |------ name -------|
1425 * |----- namelen -----|
1426 * buf is the full path, but len only counts up to (& exclusive of) the
1427 * extension. name is the module name, also exclusive of extension.
1428 *
1429 * We've already done a successful stat() or fopen() on buf, so know that
1430 * there's some match, possibly case-insensitive.
1431 *
Tim Peters50d8d372001-02-28 05:34:27 +00001432 * case_ok() is to return 1 if there's a case-sensitive match for
1433 * name, else 0. case_ok() is also to return 1 if envar PYTHONCASEOK
1434 * exists.
Tim Petersd1e87a82001-03-01 18:12:00 +00001435 *
Tim Peters50d8d372001-02-28 05:34:27 +00001436 * case_ok() is used to implement case-sensitive import semantics even
1437 * on platforms with case-insensitive filesystems. It's trivial to implement
1438 * for case-sensitive filesystems. It's pretty much a cross-platform
1439 * nightmare for systems with case-insensitive filesystems.
1440 */
Guido van Rossum0980bd91998-02-13 17:18:36 +00001441
Tim Peters50d8d372001-02-28 05:34:27 +00001442/* First we may need a pile of platform-specific header files; the sequence
1443 * of #if's here should match the sequence in the body of case_ok().
1444 */
Jason Tishler7961aa62005-05-20 00:56:54 +00001445#if defined(MS_WINDOWS)
Guido van Rossum0980bd91998-02-13 17:18:36 +00001446#include <windows.h>
Guido van Rossum4c3f57c2001-01-10 20:40:46 +00001447
Tim Peters50d8d372001-02-28 05:34:27 +00001448#elif defined(DJGPP)
1449#include <dir.h>
1450
Jason Tishler7961aa62005-05-20 00:56:54 +00001451#elif (defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) && defined(HAVE_DIRENT_H)
Tim Peters430f5d42001-03-01 01:30:56 +00001452#include <sys/types.h>
1453#include <dirent.h>
1454
Andrew MacIntyred9400542002-02-26 11:41:34 +00001455#elif defined(PYOS_OS2)
1456#define INCL_DOS
1457#define INCL_DOSERRORS
1458#define INCL_NOPMAPI
1459#include <os2.h>
Tim Peters50d8d372001-02-28 05:34:27 +00001460#endif
1461
Guido van Rossum0980bd91998-02-13 17:18:36 +00001462static int
Martin v. Löwis18e16552006-02-15 17:27:45 +00001463case_ok(char *buf, Py_ssize_t len, Py_ssize_t namelen, char *name)
Guido van Rossum0980bd91998-02-13 17:18:36 +00001464{
Tim Peters50d8d372001-02-28 05:34:27 +00001465/* Pick a platform-specific implementation; the sequence of #if's here should
1466 * match the sequence just above.
1467 */
1468
Jason Tishler7961aa62005-05-20 00:56:54 +00001469/* MS_WINDOWS */
1470#if defined(MS_WINDOWS)
Guido van Rossum0980bd91998-02-13 17:18:36 +00001471 WIN32_FIND_DATA data;
1472 HANDLE h;
Tim Peters50d8d372001-02-28 05:34:27 +00001473
Neil Schemenauer7d4bb9f2001-07-23 16:30:27 +00001474 if (Py_GETENV("PYTHONCASEOK") != NULL)
Guido van Rossum0980bd91998-02-13 17:18:36 +00001475 return 1;
Tim Peters50d8d372001-02-28 05:34:27 +00001476
Guido van Rossum0980bd91998-02-13 17:18:36 +00001477 h = FindFirstFile(buf, &data);
1478 if (h == INVALID_HANDLE_VALUE) {
1479 PyErr_Format(PyExc_NameError,
1480 "Can't find file for module %.100s\n(filename %.300s)",
1481 name, buf);
1482 return 0;
1483 }
1484 FindClose(h);
Tim Peters50d8d372001-02-28 05:34:27 +00001485 return strncmp(data.cFileName, name, namelen) == 0;
1486
1487/* DJGPP */
1488#elif defined(DJGPP)
1489 struct ffblk ffblk;
1490 int done;
1491
Neil Schemenauer7d4bb9f2001-07-23 16:30:27 +00001492 if (Py_GETENV("PYTHONCASEOK") != NULL)
Guido van Rossum323bf5e1998-06-24 03:54:06 +00001493 return 1;
Tim Peters50d8d372001-02-28 05:34:27 +00001494
1495 done = findfirst(buf, &ffblk, FA_ARCH|FA_RDONLY|FA_HIDDEN|FA_DIREC);
1496 if (done) {
Guido van Rossum0980bd91998-02-13 17:18:36 +00001497 PyErr_Format(PyExc_NameError,
Tim Peters50d8d372001-02-28 05:34:27 +00001498 "Can't find file for module %.100s\n(filename %.300s)",
Guido van Rossum0980bd91998-02-13 17:18:36 +00001499 name, buf);
1500 return 0;
1501 }
Tim Peters50d8d372001-02-28 05:34:27 +00001502 return strncmp(ffblk.ff_name, name, namelen) == 0;
Guido van Rossum0980bd91998-02-13 17:18:36 +00001503
Jason Tishler7961aa62005-05-20 00:56:54 +00001504/* new-fangled macintosh (macosx) or Cygwin */
1505#elif (defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) && defined(HAVE_DIRENT_H)
Tim Peters430f5d42001-03-01 01:30:56 +00001506 DIR *dirp;
1507 struct dirent *dp;
Tim Petersd1e87a82001-03-01 18:12:00 +00001508 char dirname[MAXPATHLEN + 1];
1509 const int dirlen = len - namelen - 1; /* don't want trailing SEP */
Tim Peters430f5d42001-03-01 01:30:56 +00001510
Neil Schemenauer7d4bb9f2001-07-23 16:30:27 +00001511 if (Py_GETENV("PYTHONCASEOK") != NULL)
Tim Petersdbe6ebb2001-03-01 08:47:29 +00001512 return 1;
1513
Tim Petersd1e87a82001-03-01 18:12:00 +00001514 /* Copy the dir component into dirname; substitute "." if empty */
1515 if (dirlen <= 0) {
1516 dirname[0] = '.';
1517 dirname[1] = '\0';
Tim Peters430f5d42001-03-01 01:30:56 +00001518 }
1519 else {
Tim Petersd1e87a82001-03-01 18:12:00 +00001520 assert(dirlen <= MAXPATHLEN);
1521 memcpy(dirname, buf, dirlen);
1522 dirname[dirlen] = '\0';
Tim Peters430f5d42001-03-01 01:30:56 +00001523 }
1524 /* Open the directory and search the entries for an exact match. */
Tim Petersd1e87a82001-03-01 18:12:00 +00001525 dirp = opendir(dirname);
Tim Peters430f5d42001-03-01 01:30:56 +00001526 if (dirp) {
Tim Peters677898a2001-03-02 03:28:03 +00001527 char *nameWithExt = buf + len - namelen;
Tim Peters430f5d42001-03-01 01:30:56 +00001528 while ((dp = readdir(dirp)) != NULL) {
Tim Petersdbe6ebb2001-03-01 08:47:29 +00001529 const int thislen =
Tim Peters430f5d42001-03-01 01:30:56 +00001530#ifdef _DIRENT_HAVE_D_NAMELEN
Tim Petersdbe6ebb2001-03-01 08:47:29 +00001531 dp->d_namlen;
Tim Peters430f5d42001-03-01 01:30:56 +00001532#else
Tim Petersdbe6ebb2001-03-01 08:47:29 +00001533 strlen(dp->d_name);
Tim Peters430f5d42001-03-01 01:30:56 +00001534#endif
Tim Petersd1e87a82001-03-01 18:12:00 +00001535 if (thislen >= namelen &&
Tim Peters677898a2001-03-02 03:28:03 +00001536 strcmp(dp->d_name, nameWithExt) == 0) {
Tim Peters430f5d42001-03-01 01:30:56 +00001537 (void)closedir(dirp);
1538 return 1; /* Found */
1539 }
1540 }
Tim Petersdbe6ebb2001-03-01 08:47:29 +00001541 (void)closedir(dirp);
Tim Peters430f5d42001-03-01 01:30:56 +00001542 }
Tim Peters430f5d42001-03-01 01:30:56 +00001543 return 0 ; /* Not found */
Tim Peters430f5d42001-03-01 01:30:56 +00001544
Andrew MacIntyred9400542002-02-26 11:41:34 +00001545/* OS/2 */
1546#elif defined(PYOS_OS2)
1547 HDIR hdir = 1;
1548 ULONG srchcnt = 1;
1549 FILEFINDBUF3 ffbuf;
1550 APIRET rc;
1551
1552 if (getenv("PYTHONCASEOK") != NULL)
1553 return 1;
1554
1555 rc = DosFindFirst(buf,
1556 &hdir,
1557 FILE_READONLY | FILE_HIDDEN | FILE_SYSTEM | FILE_DIRECTORY,
1558 &ffbuf, sizeof(ffbuf),
1559 &srchcnt,
1560 FIL_STANDARD);
1561 if (rc != NO_ERROR)
1562 return 0;
1563 return strncmp(ffbuf.achName, name, namelen) == 0;
1564
Tim Peters50d8d372001-02-28 05:34:27 +00001565/* assuming it's a case-sensitive filesystem, so there's nothing to do! */
1566#else
Guido van Rossum0980bd91998-02-13 17:18:36 +00001567 return 1;
Guido van Rossum0980bd91998-02-13 17:18:36 +00001568
Guido van Rossum4d1b3b91998-02-13 23:27:59 +00001569#endif
Tim Peters50d8d372001-02-28 05:34:27 +00001570}
Guido van Rossum4d1b3b91998-02-13 23:27:59 +00001571
Guido van Rossum0980bd91998-02-13 17:18:36 +00001572
Guido van Rossum197346f1997-10-31 18:38:52 +00001573#ifdef HAVE_STAT
1574/* Helper to look for __init__.py or __init__.py[co] in potential package */
1575static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001576find_init_module(char *buf)
Guido van Rossum197346f1997-10-31 18:38:52 +00001577{
Tim Peters0f9431f2001-07-05 03:47:53 +00001578 const size_t save_len = strlen(buf);
Fred Drake4c82b232000-06-30 16:18:57 +00001579 size_t i = save_len;
Tim Peters0f9431f2001-07-05 03:47:53 +00001580 char *pname; /* pointer to start of __init__ */
Guido van Rossum197346f1997-10-31 18:38:52 +00001581 struct stat statbuf;
1582
Tim Peters0f9431f2001-07-05 03:47:53 +00001583/* For calling case_ok(buf, len, namelen, name):
1584 * /a/b/c/d/e/f/g/h/i/j/k/some_long_module_name.py\0
1585 * ^ ^ ^ ^
1586 * |--------------------- buf ---------------------|
1587 * |------------------- len ------------------|
1588 * |------ name -------|
1589 * |----- namelen -----|
1590 */
Guido van Rossum197346f1997-10-31 18:38:52 +00001591 if (save_len + 13 >= MAXPATHLEN)
1592 return 0;
1593 buf[i++] = SEP;
Tim Peters0f9431f2001-07-05 03:47:53 +00001594 pname = buf + i;
1595 strcpy(pname, "__init__.py");
Guido van Rossum197346f1997-10-31 18:38:52 +00001596 if (stat(buf, &statbuf) == 0) {
Tim Peters0f9431f2001-07-05 03:47:53 +00001597 if (case_ok(buf,
1598 save_len + 9, /* len("/__init__") */
1599 8, /* len("__init__") */
1600 pname)) {
1601 buf[save_len] = '\0';
1602 return 1;
1603 }
Guido van Rossum197346f1997-10-31 18:38:52 +00001604 }
Tim Peters0f9431f2001-07-05 03:47:53 +00001605 i += strlen(pname);
1606 strcpy(buf+i, Py_OptimizeFlag ? "o" : "c");
Guido van Rossum197346f1997-10-31 18:38:52 +00001607 if (stat(buf, &statbuf) == 0) {
Tim Peters0f9431f2001-07-05 03:47:53 +00001608 if (case_ok(buf,
1609 save_len + 9, /* len("/__init__") */
1610 8, /* len("__init__") */
1611 pname)) {
1612 buf[save_len] = '\0';
1613 return 1;
1614 }
Guido van Rossum197346f1997-10-31 18:38:52 +00001615 }
1616 buf[save_len] = '\0';
1617 return 0;
1618}
Guido van Rossum48a680c2001-03-02 06:34:14 +00001619
Guido van Rossum197346f1997-10-31 18:38:52 +00001620#endif /* HAVE_STAT */
1621
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001622
Tim Petersdbd9ba62000-07-09 03:09:57 +00001623static int init_builtin(char *); /* Forward */
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001624
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001625/* Load an external module using the default search path and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001626 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001627
Guido van Rossum79f25d91997-04-29 20:08:16 +00001628static PyObject *
Just van Rossum52e14d62002-12-30 22:08:05 +00001629load_module(char *name, FILE *fp, char *buf, int type, PyObject *loader)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001630{
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001631 PyObject *modules;
Guido van Rossum79f25d91997-04-29 20:08:16 +00001632 PyObject *m;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001633 int err;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001634
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001635 /* First check that there's an open file (if we need one) */
1636 switch (type) {
1637 case PY_SOURCE:
1638 case PY_COMPILED:
1639 if (fp == NULL) {
1640 PyErr_Format(PyExc_ValueError,
1641 "file object required for import (type code %d)",
1642 type);
1643 return NULL;
1644 }
1645 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001646
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001647 switch (type) {
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001648
1649 case PY_SOURCE:
1650 m = load_source_module(name, buf, fp);
1651 break;
1652
1653 case PY_COMPILED:
1654 m = load_compiled_module(name, buf, fp);
1655 break;
1656
Guido van Rossum96a8fb71999-12-22 14:09:35 +00001657#ifdef HAVE_DYNAMIC_LOADING
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001658 case C_EXTENSION:
Guido van Rossum79f25d91997-04-29 20:08:16 +00001659 m = _PyImport_LoadDynamicModule(name, buf, fp);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001660 break;
Guido van Rossum96a8fb71999-12-22 14:09:35 +00001661#endif
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001662
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001663 case PKG_DIRECTORY:
1664 m = load_package(name, buf);
1665 break;
1666
1667 case C_BUILTIN:
1668 case PY_FROZEN:
Guido van Rossuma5568d31998-03-05 03:45:08 +00001669 if (buf != NULL && buf[0] != '\0')
1670 name = buf;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001671 if (type == C_BUILTIN)
1672 err = init_builtin(name);
1673 else
1674 err = PyImport_ImportFrozenModule(name);
1675 if (err < 0)
Guido van Rossuma86f77d1997-09-09 18:53:47 +00001676 return NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001677 if (err == 0) {
1678 PyErr_Format(PyExc_ImportError,
1679 "Purported %s module %.200s not found",
1680 type == C_BUILTIN ?
1681 "builtin" : "frozen",
1682 name);
Guido van Rossuma86f77d1997-09-09 18:53:47 +00001683 return NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001684 }
1685 modules = PyImport_GetModuleDict();
1686 m = PyDict_GetItemString(modules, name);
1687 if (m == NULL) {
1688 PyErr_Format(
1689 PyExc_ImportError,
1690 "%s module %.200s not properly initialized",
1691 type == C_BUILTIN ?
1692 "builtin" : "frozen",
1693 name);
Guido van Rossuma86f77d1997-09-09 18:53:47 +00001694 return NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001695 }
1696 Py_INCREF(m);
1697 break;
1698
Just van Rossum52e14d62002-12-30 22:08:05 +00001699 case IMP_HOOK: {
1700 if (loader == NULL) {
1701 PyErr_SetString(PyExc_ImportError,
1702 "import hook without loader");
1703 return NULL;
1704 }
1705 m = PyObject_CallMethod(loader, "load_module", "s", name);
1706 break;
1707 }
1708
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001709 default:
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001710 PyErr_Format(PyExc_ImportError,
1711 "Don't know how to import %.200s (type code %d)",
1712 name, type);
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001713 m = NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001714
1715 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001716
1717 return m;
1718}
1719
1720
1721/* Initialize a built-in module.
Thomas Wouters89f507f2006-12-13 04:49:30 +00001722 Return 1 for success, 0 if the module is not found, and -1 with
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001723 an exception set if the initialization failed. */
Guido van Rossum7f133ed1991-02-19 12:23:57 +00001724
Guido van Rossum7f133ed1991-02-19 12:23:57 +00001725static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001726init_builtin(char *name)
Guido van Rossum7f133ed1991-02-19 12:23:57 +00001727{
Guido van Rossum25ce5661997-08-02 03:10:38 +00001728 struct _inittab *p;
Guido van Rossum25ce5661997-08-02 03:10:38 +00001729
Greg Ward201baee2001-10-04 14:52:06 +00001730 if (_PyImport_FindExtension(name, name) != NULL)
Guido van Rossum25ce5661997-08-02 03:10:38 +00001731 return 1;
1732
Guido van Rossum771c6c81997-10-31 18:37:24 +00001733 for (p = PyImport_Inittab; p->name != NULL; p++) {
Guido van Rossum25ce5661997-08-02 03:10:38 +00001734 if (strcmp(name, p->name) == 0) {
1735 if (p->initfunc == NULL) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001736 PyErr_Format(PyExc_ImportError,
1737 "Cannot re-init internal module %.200s",
1738 name);
Guido van Rossum74e6a111994-08-29 12:54:38 +00001739 return -1;
1740 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00001741 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +00001742 PySys_WriteStderr("import %s # builtin\n", name);
Guido van Rossum25ce5661997-08-02 03:10:38 +00001743 (*p->initfunc)();
Guido van Rossum79f25d91997-04-29 20:08:16 +00001744 if (PyErr_Occurred())
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001745 return -1;
Guido van Rossum25ce5661997-08-02 03:10:38 +00001746 if (_PyImport_FixupExtension(name, name) == NULL)
1747 return -1;
Guido van Rossum7f133ed1991-02-19 12:23:57 +00001748 return 1;
1749 }
1750 }
1751 return 0;
1752}
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001753
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001754
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001755/* Frozen modules */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001756
Guido van Rossumcfd0a221996-06-17 17:06:34 +00001757static struct _frozen *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001758find_frozen(char *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001759{
Guido van Rossumcfd0a221996-06-17 17:06:34 +00001760 struct _frozen *p;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001761
Guido van Rossum79f25d91997-04-29 20:08:16 +00001762 for (p = PyImport_FrozenModules; ; p++) {
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001763 if (p->name == NULL)
1764 return NULL;
1765 if (strcmp(p->name, name) == 0)
1766 break;
1767 }
1768 return p;
1769}
1770
Guido van Rossum79f25d91997-04-29 20:08:16 +00001771static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001772get_frozen_object(char *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001773{
Guido van Rossumcfd0a221996-06-17 17:06:34 +00001774 struct _frozen *p = find_frozen(name);
Guido van Rossuma5568d31998-03-05 03:45:08 +00001775 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001776
1777 if (p == NULL) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001778 PyErr_Format(PyExc_ImportError,
1779 "No such frozen object named %.200s",
1780 name);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001781 return NULL;
1782 }
Guido van Rossum8f4d3312001-10-18 18:54:11 +00001783 if (p->code == NULL) {
1784 PyErr_Format(PyExc_ImportError,
1785 "Excluded frozen object named %.200s",
1786 name);
1787 return NULL;
1788 }
Guido van Rossuma5568d31998-03-05 03:45:08 +00001789 size = p->size;
1790 if (size < 0)
1791 size = -size;
1792 return PyMarshal_ReadObjectFromString((char *)p->code, size);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001793}
1794
1795/* Initialize a frozen module.
1796 Return 1 for succes, 0 if the module is not found, and -1 with
1797 an exception set if the initialization failed.
1798 This function is also used from frozenmain.c */
Guido van Rossum0b344901995-02-07 15:35:27 +00001799
1800int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001801PyImport_ImportFrozenModule(char *name)
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001802{
Guido van Rossumcfd0a221996-06-17 17:06:34 +00001803 struct _frozen *p = find_frozen(name);
Guido van Rossum79f25d91997-04-29 20:08:16 +00001804 PyObject *co;
1805 PyObject *m;
Guido van Rossuma5568d31998-03-05 03:45:08 +00001806 int ispackage;
1807 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001808
1809 if (p == NULL)
1810 return 0;
Guido van Rossum8f4d3312001-10-18 18:54:11 +00001811 if (p->code == NULL) {
1812 PyErr_Format(PyExc_ImportError,
1813 "Excluded frozen object named %.200s",
1814 name);
1815 return -1;
1816 }
Guido van Rossuma5568d31998-03-05 03:45:08 +00001817 size = p->size;
1818 ispackage = (size < 0);
1819 if (ispackage)
1820 size = -size;
Guido van Rossum79f25d91997-04-29 20:08:16 +00001821 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +00001822 PySys_WriteStderr("import %s # frozen%s\n",
Guido van Rossuma5568d31998-03-05 03:45:08 +00001823 name, ispackage ? " package" : "");
1824 co = PyMarshal_ReadObjectFromString((char *)p->code, size);
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001825 if (co == NULL)
1826 return -1;
Guido van Rossum79f25d91997-04-29 20:08:16 +00001827 if (!PyCode_Check(co)) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001828 PyErr_Format(PyExc_TypeError,
1829 "frozen object %.200s is not a code object",
1830 name);
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001831 goto err_return;
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001832 }
Guido van Rossuma5568d31998-03-05 03:45:08 +00001833 if (ispackage) {
1834 /* Set __path__ to the package name */
1835 PyObject *d, *s;
1836 int err;
1837 m = PyImport_AddModule(name);
1838 if (m == NULL)
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001839 goto err_return;
Guido van Rossuma5568d31998-03-05 03:45:08 +00001840 d = PyModule_GetDict(m);
Martin v. Löwis5b222132007-06-10 09:51:05 +00001841 s = PyUnicode_InternFromString(name);
Guido van Rossuma5568d31998-03-05 03:45:08 +00001842 if (s == NULL)
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001843 goto err_return;
Guido van Rossuma5568d31998-03-05 03:45:08 +00001844 err = PyDict_SetItemString(d, "__path__", s);
1845 Py_DECREF(s);
1846 if (err != 0)
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001847 goto err_return;
Guido van Rossuma5568d31998-03-05 03:45:08 +00001848 }
Guido van Rossume32bf6e1998-02-11 05:53:02 +00001849 m = PyImport_ExecCodeModuleEx(name, co, "<frozen>");
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001850 if (m == NULL)
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001851 goto err_return;
1852 Py_DECREF(co);
Guido van Rossum79f25d91997-04-29 20:08:16 +00001853 Py_DECREF(m);
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001854 return 1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001855err_return:
1856 Py_DECREF(co);
1857 return -1;
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001858}
Guido van Rossum74e6a111994-08-29 12:54:38 +00001859
1860
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001861/* Import a module, either built-in, frozen, or external, and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001862 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum74e6a111994-08-29 12:54:38 +00001863
Guido van Rossum79f25d91997-04-29 20:08:16 +00001864PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001865PyImport_ImportModule(const char *name)
Guido van Rossum74e6a111994-08-29 12:54:38 +00001866{
Marc-André Lemburg3c61c352001-02-09 19:40:15 +00001867 PyObject *pname;
1868 PyObject *result;
1869
Martin v. Löwis5b222132007-06-10 09:51:05 +00001870 pname = PyUnicode_FromString(name);
Neal Norwitza11e4c12003-03-23 14:31:01 +00001871 if (pname == NULL)
1872 return NULL;
Marc-André Lemburg3c61c352001-02-09 19:40:15 +00001873 result = PyImport_Import(pname);
1874 Py_DECREF(pname);
1875 return result;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001876}
1877
Guido van Rossum17fc85f1997-09-06 18:52:03 +00001878/* Forward declarations for helper routines */
Thomas Woutersf7f438b2006-02-28 16:09:29 +00001879static PyObject *get_parent(PyObject *globals, char *buf,
1880 Py_ssize_t *p_buflen, int level);
Tim Petersdbd9ba62000-07-09 03:09:57 +00001881static PyObject *load_next(PyObject *mod, PyObject *altmod,
Martin v. Löwis18e16552006-02-15 17:27:45 +00001882 char **p_name, char *buf, Py_ssize_t *p_buflen);
Tim Petersdbd9ba62000-07-09 03:09:57 +00001883static int mark_miss(char *name);
1884static int ensure_fromlist(PyObject *mod, PyObject *fromlist,
Martin v. Löwis18e16552006-02-15 17:27:45 +00001885 char *buf, Py_ssize_t buflen, int recursive);
Tim Petersdbd9ba62000-07-09 03:09:57 +00001886static PyObject * import_submodule(PyObject *mod, char *name, char *fullname);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00001887
1888/* The Magnum Opus of dotted-name import :-) */
1889
Guido van Rossum75acc9c1998-03-03 22:26:50 +00001890static PyObject *
Thomas Woutersf7f438b2006-02-28 16:09:29 +00001891import_module_level(char *name, PyObject *globals, PyObject *locals,
1892 PyObject *fromlist, int level)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001893{
Guido van Rossum17fc85f1997-09-06 18:52:03 +00001894 char buf[MAXPATHLEN+1];
Martin v. Löwis18e16552006-02-15 17:27:45 +00001895 Py_ssize_t buflen = 0;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00001896 PyObject *parent, *head, *next, *tail;
1897
Thomas Woutersf7f438b2006-02-28 16:09:29 +00001898 parent = get_parent(globals, buf, &buflen, level);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00001899 if (parent == NULL)
1900 return NULL;
1901
1902 head = load_next(parent, Py_None, &name, buf, &buflen);
1903 if (head == NULL)
1904 return NULL;
1905
1906 tail = head;
1907 Py_INCREF(tail);
1908 while (name) {
1909 next = load_next(tail, tail, &name, buf, &buflen);
1910 Py_DECREF(tail);
1911 if (next == NULL) {
1912 Py_DECREF(head);
1913 return NULL;
1914 }
1915 tail = next;
1916 }
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001917 if (tail == Py_None) {
1918 /* If tail is Py_None, both get_parent and load_next found
1919 an empty module name: someone called __import__("") or
1920 doctored faulty bytecode */
1921 Py_DECREF(tail);
1922 Py_DECREF(head);
1923 PyErr_SetString(PyExc_ValueError,
1924 "Empty module name");
1925 return NULL;
1926 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00001927
1928 if (fromlist != NULL) {
1929 if (fromlist == Py_None || !PyObject_IsTrue(fromlist))
1930 fromlist = NULL;
1931 }
1932
1933 if (fromlist == NULL) {
1934 Py_DECREF(tail);
1935 return head;
1936 }
1937
1938 Py_DECREF(head);
Guido van Rossum9905ef91997-09-08 16:07:11 +00001939 if (!ensure_fromlist(tail, fromlist, buf, buflen, 0)) {
Guido van Rossum17fc85f1997-09-06 18:52:03 +00001940 Py_DECREF(tail);
1941 return NULL;
1942 }
1943
1944 return tail;
1945}
1946
Thomas Woutersf7f438b2006-02-28 16:09:29 +00001947/* For DLL compatibility */
1948#undef PyImport_ImportModuleEx
Guido van Rossum75acc9c1998-03-03 22:26:50 +00001949PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001950PyImport_ImportModuleEx(char *name, PyObject *globals, PyObject *locals,
1951 PyObject *fromlist)
Guido van Rossum75acc9c1998-03-03 22:26:50 +00001952{
1953 PyObject *result;
1954 lock_import();
Thomas Woutersf7f438b2006-02-28 16:09:29 +00001955 result = import_module_level(name, globals, locals, fromlist, -1);
1956 if (unlock_import() < 0) {
1957 Py_XDECREF(result);
1958 PyErr_SetString(PyExc_RuntimeError,
1959 "not holding the import lock");
1960 return NULL;
1961 }
1962 return result;
1963}
1964#define PyImport_ImportModuleEx(n, g, l, f) \
1965 PyImport_ImportModuleLevel(n, g, l, f, -1);
1966
1967PyObject *
1968PyImport_ImportModuleLevel(char *name, PyObject *globals, PyObject *locals,
1969 PyObject *fromlist, int level)
1970{
1971 PyObject *result;
1972 lock_import();
1973 result = import_module_level(name, globals, locals, fromlist, level);
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00001974 if (unlock_import() < 0) {
1975 Py_XDECREF(result);
1976 PyErr_SetString(PyExc_RuntimeError,
1977 "not holding the import lock");
1978 return NULL;
1979 }
Guido van Rossum75acc9c1998-03-03 22:26:50 +00001980 return result;
1981}
1982
Fred Drake87590902004-05-28 20:21:36 +00001983/* Return the package that an import is being performed in. If globals comes
1984 from the module foo.bar.bat (not itself a package), this returns the
1985 sys.modules entry for foo.bar. If globals is from a package's __init__.py,
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00001986 the package's entry in sys.modules is returned, as a borrowed reference.
Fred Drake87590902004-05-28 20:21:36 +00001987
1988 The *name* of the returned package is returned in buf, with the length of
1989 the name in *p_buflen.
1990
1991 If globals doesn't come from a package or a module in a package, or a
1992 corresponding entry is not found in sys.modules, Py_None is returned.
1993*/
Guido van Rossum17fc85f1997-09-06 18:52:03 +00001994static PyObject *
Thomas Woutersf7f438b2006-02-28 16:09:29 +00001995get_parent(PyObject *globals, char *buf, Py_ssize_t *p_buflen, int level)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00001996{
1997 static PyObject *namestr = NULL;
1998 static PyObject *pathstr = NULL;
1999 PyObject *modname, *modpath, *modules, *parent;
2000
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002001 if (globals == NULL || !PyDict_Check(globals) || !level)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002002 return Py_None;
2003
2004 if (namestr == NULL) {
Martin v. Löwis5b222132007-06-10 09:51:05 +00002005 namestr = PyUnicode_InternFromString("__name__");
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002006 if (namestr == NULL)
2007 return NULL;
2008 }
2009 if (pathstr == NULL) {
Martin v. Löwis5b222132007-06-10 09:51:05 +00002010 pathstr = PyUnicode_InternFromString("__path__");
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002011 if (pathstr == NULL)
2012 return NULL;
2013 }
2014
2015 *buf = '\0';
2016 *p_buflen = 0;
2017 modname = PyDict_GetItem(globals, namestr);
Neal Norwitz80e7f272007-08-26 06:45:23 +00002018 if (modname == NULL || !PyUnicode_Check(modname))
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002019 return Py_None;
2020
2021 modpath = PyDict_GetItem(globals, pathstr);
2022 if (modpath != NULL) {
Neal Norwitz80e7f272007-08-26 06:45:23 +00002023 Py_ssize_t len = PyUnicode_GET_SIZE(modname);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002024 if (len > MAXPATHLEN) {
2025 PyErr_SetString(PyExc_ValueError,
2026 "Module name too long");
2027 return NULL;
2028 }
Neal Norwitz80e7f272007-08-26 06:45:23 +00002029 strcpy(buf, PyUnicode_AsString(modname));
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002030 }
2031 else {
Neal Norwitz80e7f272007-08-26 06:45:23 +00002032 char *start = PyUnicode_AsString(modname);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002033 char *lastdot = strrchr(start, '.');
Fred Drake4c82b232000-06-30 16:18:57 +00002034 size_t len;
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002035 if (lastdot == NULL && level > 0) {
2036 PyErr_SetString(PyExc_ValueError,
Thomas Wouters89f507f2006-12-13 04:49:30 +00002037 "Attempted relative import in non-package");
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002038 return NULL;
2039 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002040 if (lastdot == NULL)
2041 return Py_None;
2042 len = lastdot - start;
2043 if (len >= MAXPATHLEN) {
2044 PyErr_SetString(PyExc_ValueError,
2045 "Module name too long");
2046 return NULL;
2047 }
2048 strncpy(buf, start, len);
2049 buf[len] = '\0';
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002050 }
2051
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002052 while (--level > 0) {
2053 char *dot = strrchr(buf, '.');
2054 if (dot == NULL) {
2055 PyErr_SetString(PyExc_ValueError,
Thomas Wouters89f507f2006-12-13 04:49:30 +00002056 "Attempted relative import beyond "
2057 "toplevel package");
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002058 return NULL;
2059 }
2060 *dot = '\0';
2061 }
2062 *p_buflen = strlen(buf);
2063
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002064 modules = PyImport_GetModuleDict();
2065 parent = PyDict_GetItemString(modules, buf);
2066 if (parent == NULL)
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002067 PyErr_Format(PyExc_SystemError,
2068 "Parent module '%.200s' not loaded", buf);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002069 return parent;
2070 /* We expect, but can't guarantee, if parent != None, that:
2071 - parent.__name__ == buf
2072 - parent.__dict__ is globals
2073 If this is violated... Who cares? */
2074}
2075
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002076/* altmod is either None or same as mod */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002077static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002078load_next(PyObject *mod, PyObject *altmod, char **p_name, char *buf,
Martin v. Löwis18e16552006-02-15 17:27:45 +00002079 Py_ssize_t *p_buflen)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002080{
2081 char *name = *p_name;
2082 char *dot = strchr(name, '.');
Fred Drake4c82b232000-06-30 16:18:57 +00002083 size_t len;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002084 char *p;
2085 PyObject *result;
2086
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002087 if (strlen(name) == 0) {
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002088 /* completely empty module name should only happen in
2089 'from . import' (or '__import__("")')*/
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002090 Py_INCREF(mod);
2091 *p_name = NULL;
2092 return mod;
2093 }
2094
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002095 if (dot == NULL) {
2096 *p_name = NULL;
2097 len = strlen(name);
2098 }
2099 else {
2100 *p_name = dot+1;
2101 len = dot-name;
2102 }
Guido van Rossum111c20b1998-04-11 17:38:22 +00002103 if (len == 0) {
2104 PyErr_SetString(PyExc_ValueError,
2105 "Empty module name");
2106 return NULL;
2107 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002108
2109 p = buf + *p_buflen;
2110 if (p != buf)
2111 *p++ = '.';
2112 if (p+len-buf >= MAXPATHLEN) {
2113 PyErr_SetString(PyExc_ValueError,
2114 "Module name too long");
2115 return NULL;
2116 }
2117 strncpy(p, name, len);
2118 p[len] = '\0';
2119 *p_buflen = p+len-buf;
2120
2121 result = import_submodule(mod, p, buf);
2122 if (result == Py_None && altmod != mod) {
2123 Py_DECREF(result);
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00002124 /* Here, altmod must be None and mod must not be None */
Guido van Rossum0c819451997-09-07 06:16:57 +00002125 result = import_submodule(altmod, p, p);
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00002126 if (result != NULL && result != Py_None) {
2127 if (mark_miss(buf) != 0) {
2128 Py_DECREF(result);
2129 return NULL;
2130 }
2131 strncpy(buf, name, len);
2132 buf[len] = '\0';
2133 *p_buflen = len;
2134 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002135 }
2136 if (result == NULL)
2137 return NULL;
2138
2139 if (result == Py_None) {
2140 Py_DECREF(result);
2141 PyErr_Format(PyExc_ImportError,
2142 "No module named %.200s", name);
2143 return NULL;
2144 }
2145
2146 return result;
2147}
2148
2149static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002150mark_miss(char *name)
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00002151{
2152 PyObject *modules = PyImport_GetModuleDict();
2153 return PyDict_SetItemString(modules, name, Py_None);
2154}
2155
2156static int
Martin v. Löwis18e16552006-02-15 17:27:45 +00002157ensure_fromlist(PyObject *mod, PyObject *fromlist, char *buf, Py_ssize_t buflen,
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002158 int recursive)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002159{
2160 int i;
2161
2162 if (!PyObject_HasAttrString(mod, "__path__"))
2163 return 1;
2164
2165 for (i = 0; ; i++) {
2166 PyObject *item = PySequence_GetItem(fromlist, i);
2167 int hasit;
2168 if (item == NULL) {
2169 if (PyErr_ExceptionMatches(PyExc_IndexError)) {
2170 PyErr_Clear();
2171 return 1;
2172 }
2173 return 0;
2174 }
Martin v. Löwis5b222132007-06-10 09:51:05 +00002175 if (!PyUnicode_Check(item)) {
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002176 PyErr_SetString(PyExc_TypeError,
Neal Norwitz80e7f272007-08-26 06:45:23 +00002177 "Item in ``from list'' not a string");
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002178 Py_DECREF(item);
2179 return 0;
2180 }
Martin v. Löwis5b222132007-06-10 09:51:05 +00002181 if (PyUnicode_AS_UNICODE(item)[0] == '*') {
Guido van Rossum9905ef91997-09-08 16:07:11 +00002182 PyObject *all;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002183 Py_DECREF(item);
Guido van Rossum9905ef91997-09-08 16:07:11 +00002184 /* See if the package defines __all__ */
2185 if (recursive)
2186 continue; /* Avoid endless recursion */
2187 all = PyObject_GetAttrString(mod, "__all__");
2188 if (all == NULL)
2189 PyErr_Clear();
2190 else {
Martin v. Löwis83969ee2004-03-23 16:28:13 +00002191 int ret = ensure_fromlist(mod, all, buf, buflen, 1);
Guido van Rossum9905ef91997-09-08 16:07:11 +00002192 Py_DECREF(all);
Martin v. Löwis83969ee2004-03-23 16:28:13 +00002193 if (!ret)
2194 return 0;
Guido van Rossum9905ef91997-09-08 16:07:11 +00002195 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002196 continue;
2197 }
2198 hasit = PyObject_HasAttr(mod, item);
2199 if (!hasit) {
Martin v. Löwis5b222132007-06-10 09:51:05 +00002200 PyObject *item8;
2201 char *subname;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002202 PyObject *submod;
2203 char *p;
Martin v. Löwis5b222132007-06-10 09:51:05 +00002204 if (!Py_FileSystemDefaultEncoding) {
2205 item8 = PyUnicode_EncodeASCII(PyUnicode_AsUnicode(item),
2206 PyUnicode_GetSize(item),
Martin v. Löwis427dbff2007-06-12 05:53:00 +00002207 NULL);
Martin v. Löwis5b222132007-06-10 09:51:05 +00002208 } else {
Martin v. Löwis427dbff2007-06-12 05:53:00 +00002209 item8 = PyUnicode_AsEncodedString(item,
2210 Py_FileSystemDefaultEncoding, NULL);
Martin v. Löwis5b222132007-06-10 09:51:05 +00002211 }
2212 if (!item8) {
2213 PyErr_SetString(PyExc_ValueError, "Cannot encode path item");
2214 return 0;
2215 }
2216 subname = PyBytes_AsString(item8);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002217 if (buflen + strlen(subname) >= MAXPATHLEN) {
2218 PyErr_SetString(PyExc_ValueError,
2219 "Module name too long");
2220 Py_DECREF(item);
2221 return 0;
2222 }
2223 p = buf + buflen;
2224 *p++ = '.';
2225 strcpy(p, subname);
2226 submod = import_submodule(mod, subname, buf);
Martin v. Löwis5b222132007-06-10 09:51:05 +00002227 Py_DECREF(item8);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002228 Py_XDECREF(submod);
2229 if (submod == NULL) {
2230 Py_DECREF(item);
2231 return 0;
2232 }
2233 }
2234 Py_DECREF(item);
2235 }
2236
Guido van Rossuma7f2e811997-10-03 15:33:32 +00002237 /* NOTREACHED */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002238}
2239
Neil Schemenauer00b09662003-06-16 21:03:07 +00002240static int
2241add_submodule(PyObject *mod, PyObject *submod, char *fullname, char *subname,
2242 PyObject *modules)
2243{
2244 if (mod == Py_None)
2245 return 1;
2246 /* Irrespective of the success of this load, make a
2247 reference to it in the parent package module. A copy gets
2248 saved in the modules dictionary under the full name, so get a
2249 reference from there, if need be. (The exception is when the
2250 load failed with a SyntaxError -- then there's no trace in
2251 sys.modules. In that case, of course, do nothing extra.) */
2252 if (submod == NULL) {
2253 submod = PyDict_GetItemString(modules, fullname);
2254 if (submod == NULL)
2255 return 1;
2256 }
2257 if (PyModule_Check(mod)) {
2258 /* We can't use setattr here since it can give a
2259 * spurious warning if the submodule name shadows a
2260 * builtin name */
2261 PyObject *dict = PyModule_GetDict(mod);
2262 if (!dict)
2263 return 0;
2264 if (PyDict_SetItemString(dict, subname, submod) < 0)
2265 return 0;
2266 }
2267 else {
2268 if (PyObject_SetAttrString(mod, subname, submod) < 0)
2269 return 0;
2270 }
2271 return 1;
2272}
2273
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002274static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002275import_submodule(PyObject *mod, char *subname, char *fullname)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002276{
Guido van Rossum25ce5661997-08-02 03:10:38 +00002277 PyObject *modules = PyImport_GetModuleDict();
Neil Schemenauer00b09662003-06-16 21:03:07 +00002278 PyObject *m = NULL;
Guido van Rossum74e6a111994-08-29 12:54:38 +00002279
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002280 /* Require:
2281 if mod == None: subname == fullname
2282 else: mod.__name__ + "." + subname == fullname
2283 */
2284
Tim Peters50d8d372001-02-28 05:34:27 +00002285 if ((m = PyDict_GetItemString(modules, fullname)) != NULL) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00002286 Py_INCREF(m);
Guido van Rossum7f9fa971995-01-20 16:53:12 +00002287 }
2288 else {
Just van Rossum52e14d62002-12-30 22:08:05 +00002289 PyObject *path, *loader = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002290 char buf[MAXPATHLEN+1];
2291 struct filedescr *fdp;
2292 FILE *fp = NULL;
2293
Guido van Rossum9c0afe51998-05-19 15:09:05 +00002294 if (mod == Py_None)
2295 path = NULL;
2296 else {
2297 path = PyObject_GetAttrString(mod, "__path__");
2298 if (path == NULL) {
2299 PyErr_Clear();
2300 Py_INCREF(Py_None);
2301 return Py_None;
2302 }
2303 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002304
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002305 buf[0] = '\0';
Just van Rossum52e14d62002-12-30 22:08:05 +00002306 fdp = find_module(fullname, subname, path, buf, MAXPATHLEN+1,
2307 &fp, &loader);
Guido van Rossumb68cd421998-07-01 17:36:26 +00002308 Py_XDECREF(path);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002309 if (fdp == NULL) {
2310 if (!PyErr_ExceptionMatches(PyExc_ImportError))
2311 return NULL;
2312 PyErr_Clear();
2313 Py_INCREF(Py_None);
2314 return Py_None;
2315 }
Just van Rossum52e14d62002-12-30 22:08:05 +00002316 m = load_module(fullname, fp, buf, fdp->type, loader);
2317 Py_XDECREF(loader);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002318 if (fp)
2319 fclose(fp);
Neil Schemenauer00b09662003-06-16 21:03:07 +00002320 if (!add_submodule(mod, m, fullname, subname, modules)) {
2321 Py_XDECREF(m);
2322 m = NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002323 }
Guido van Rossum74e6a111994-08-29 12:54:38 +00002324 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002325
2326 return m;
Guido van Rossum74e6a111994-08-29 12:54:38 +00002327}
2328
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002329
2330/* Re-import a module of any kind and return its module object, WITH
2331 INCREMENTED REFERENCE COUNT */
2332
Guido van Rossum79f25d91997-04-29 20:08:16 +00002333PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002334PyImport_ReloadModule(PyObject *m)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002335{
Guido van Rossumd8faa362007-04-27 19:54:29 +00002336 PyInterpreterState *interp = PyThreadState_Get()->interp;
2337 PyObject *modules_reloading = interp->modules_reloading;
Guido van Rossum25ce5661997-08-02 03:10:38 +00002338 PyObject *modules = PyImport_GetModuleDict();
Guido van Rossumd8faa362007-04-27 19:54:29 +00002339 PyObject *path = NULL, *loader = NULL, *existing_m = NULL;
Guido van Rossum222ef561997-09-06 19:41:09 +00002340 char *name, *subname;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002341 char buf[MAXPATHLEN+1];
2342 struct filedescr *fdp;
2343 FILE *fp = NULL;
Tim Peters1cd70172004-08-02 03:52:12 +00002344 PyObject *newm;
Guido van Rossumd8faa362007-04-27 19:54:29 +00002345
2346 if (modules_reloading == NULL) {
2347 Py_FatalError("PyImport_ReloadModule: "
Guido van Rossume7ba4952007-06-06 23:52:48 +00002348 "no modules_reloading dictionary!");
Guido van Rossumd8faa362007-04-27 19:54:29 +00002349 return NULL;
2350 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002351
Guido van Rossum79f25d91997-04-29 20:08:16 +00002352 if (m == NULL || !PyModule_Check(m)) {
2353 PyErr_SetString(PyExc_TypeError,
2354 "reload() argument must be module");
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002355 return NULL;
2356 }
Neal Norwitz5616c6d2007-08-26 05:32:41 +00002357 name = (char*)PyModule_GetName(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002358 if (name == NULL)
2359 return NULL;
Guido van Rossum25ce5661997-08-02 03:10:38 +00002360 if (m != PyDict_GetItemString(modules, name)) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002361 PyErr_Format(PyExc_ImportError,
2362 "reload(): module %.200s not in sys.modules",
2363 name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002364 return NULL;
2365 }
Guido van Rossumd8faa362007-04-27 19:54:29 +00002366 existing_m = PyDict_GetItemString(modules_reloading, name);
2367 if (existing_m != NULL) {
2368 /* Due to a recursive reload, this module is already
2369 being reloaded. */
2370 Py_INCREF(existing_m);
2371 return existing_m;
2372 }
2373 if (PyDict_SetItemString(modules_reloading, name, m) < 0)
2374 return NULL;
2375
Guido van Rossum222ef561997-09-06 19:41:09 +00002376 subname = strrchr(name, '.');
2377 if (subname == NULL)
2378 subname = name;
2379 else {
2380 PyObject *parentname, *parent;
2381 parentname = PyString_FromStringAndSize(name, (subname-name));
Guido van Rossumd8faa362007-04-27 19:54:29 +00002382 if (parentname == NULL) {
2383 imp_modules_reloading_clear();
Guido van Rossum222ef561997-09-06 19:41:09 +00002384 return NULL;
Guido van Rossumd8faa362007-04-27 19:54:29 +00002385 }
Guido van Rossum222ef561997-09-06 19:41:09 +00002386 parent = PyDict_GetItem(modules, parentname);
2387 if (parent == NULL) {
2388 PyErr_Format(PyExc_ImportError,
2389 "reload(): parent %.200s not in sys.modules",
Georg Brandl0c55f292005-09-14 06:56:20 +00002390 PyString_AS_STRING(parentname));
2391 Py_DECREF(parentname);
Guido van Rossume7ba4952007-06-06 23:52:48 +00002392 imp_modules_reloading_clear();
Guido van Rossum222ef561997-09-06 19:41:09 +00002393 return NULL;
2394 }
Georg Brandl0c55f292005-09-14 06:56:20 +00002395 Py_DECREF(parentname);
Guido van Rossum222ef561997-09-06 19:41:09 +00002396 subname++;
2397 path = PyObject_GetAttrString(parent, "__path__");
2398 if (path == NULL)
2399 PyErr_Clear();
2400 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002401 buf[0] = '\0';
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00002402 fdp = find_module(name, subname, path, buf, MAXPATHLEN+1, &fp, &loader);
Guido van Rossum222ef561997-09-06 19:41:09 +00002403 Py_XDECREF(path);
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00002404
2405 if (fdp == NULL) {
2406 Py_XDECREF(loader);
Guido van Rossumd8faa362007-04-27 19:54:29 +00002407 imp_modules_reloading_clear();
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002408 return NULL;
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00002409 }
2410
2411 newm = load_module(name, fp, buf, fdp->type, loader);
2412 Py_XDECREF(loader);
2413
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002414 if (fp)
2415 fclose(fp);
Tim Peters1cd70172004-08-02 03:52:12 +00002416 if (newm == NULL) {
2417 /* load_module probably removed name from modules because of
2418 * the error. Put back the original module object. We're
2419 * going to return NULL in this case regardless of whether
2420 * replacing name succeeds, so the return value is ignored.
2421 */
2422 PyDict_SetItemString(modules, name, m);
2423 }
Guido van Rossumd8faa362007-04-27 19:54:29 +00002424 imp_modules_reloading_clear();
Tim Peters1cd70172004-08-02 03:52:12 +00002425 return newm;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002426}
2427
2428
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002429/* Higher-level import emulator which emulates the "import" statement
2430 more accurately -- it invokes the __import__() function from the
2431 builtins of the current globals. This means that the import is
2432 done using whatever import hooks are installed in the current
Guido van Rossum6058eb41998-12-21 19:51:00 +00002433 environment, e.g. by "rexec".
2434 A dummy list ["__doc__"] is passed as the 4th argument so that
Neal Norwitz80e7f272007-08-26 06:45:23 +00002435 e.g. PyImport_Import(PyUnicode_FromString("win32com.client.gencache"))
Guido van Rossum6058eb41998-12-21 19:51:00 +00002436 will return <module "gencache"> instead of <module "win32com">. */
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002437
2438PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002439PyImport_Import(PyObject *module_name)
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002440{
2441 static PyObject *silly_list = NULL;
2442 static PyObject *builtins_str = NULL;
2443 static PyObject *import_str = NULL;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002444 PyObject *globals = NULL;
2445 PyObject *import = NULL;
2446 PyObject *builtins = NULL;
2447 PyObject *r = NULL;
2448
2449 /* Initialize constant string objects */
2450 if (silly_list == NULL) {
Martin v. Löwis5b222132007-06-10 09:51:05 +00002451 import_str = PyUnicode_InternFromString("__import__");
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002452 if (import_str == NULL)
2453 return NULL;
Martin v. Löwis5b222132007-06-10 09:51:05 +00002454 builtins_str = PyUnicode_InternFromString("__builtins__");
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002455 if (builtins_str == NULL)
2456 return NULL;
2457 silly_list = Py_BuildValue("[s]", "__doc__");
2458 if (silly_list == NULL)
2459 return NULL;
2460 }
2461
2462 /* Get the builtins from current globals */
2463 globals = PyEval_GetGlobals();
Guido van Rossum85cd1d62001-02-20 21:43:24 +00002464 if (globals != NULL) {
Guido van Rossum66468561998-10-22 15:46:50 +00002465 Py_INCREF(globals);
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002466 builtins = PyObject_GetItem(globals, builtins_str);
2467 if (builtins == NULL)
2468 goto err;
2469 }
2470 else {
2471 /* No globals -- use standard builtins, and fake globals */
2472 PyErr_Clear();
2473
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002474 builtins = PyImport_ImportModuleLevel("__builtin__",
2475 NULL, NULL, NULL, 0);
Guido van Rossum85cd1d62001-02-20 21:43:24 +00002476 if (builtins == NULL)
2477 return NULL;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002478 globals = Py_BuildValue("{OO}", builtins_str, builtins);
2479 if (globals == NULL)
2480 goto err;
2481 }
2482
2483 /* Get the __import__ function from the builtins */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002484 if (PyDict_Check(builtins)) {
Fred Drakea76ba6e2001-03-06 06:31:15 +00002485 import = PyObject_GetItem(builtins, import_str);
Tim Peters6d6c1a32001-08-02 04:15:00 +00002486 if (import == NULL)
2487 PyErr_SetObject(PyExc_KeyError, import_str);
2488 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002489 else
Fred Drakea76ba6e2001-03-06 06:31:15 +00002490 import = PyObject_GetAttr(builtins, import_str);
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002491 if (import == NULL)
2492 goto err;
2493
Guido van Rossumd8faa362007-04-27 19:54:29 +00002494 /* Call the __import__ function with the proper argument list */
Thomas Wouters477c8d52006-05-27 19:21:47 +00002495 r = PyObject_CallFunctionObjArgs(import, module_name, globals,
2496 globals, silly_list, NULL);
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002497
2498 err:
2499 Py_XDECREF(globals);
2500 Py_XDECREF(builtins);
2501 Py_XDECREF(import);
Tim Peters50d8d372001-02-28 05:34:27 +00002502
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002503 return r;
2504}
2505
2506
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002507/* Module 'imp' provides Python access to the primitives used for
2508 importing modules.
2509*/
2510
Guido van Rossum79f25d91997-04-29 20:08:16 +00002511static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +00002512imp_get_magic(PyObject *self, PyObject *noargs)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002513{
2514 char buf[4];
2515
Guido van Rossum96774c12000-05-01 20:19:08 +00002516 buf[0] = (char) ((pyc_magic >> 0) & 0xff);
2517 buf[1] = (char) ((pyc_magic >> 8) & 0xff);
2518 buf[2] = (char) ((pyc_magic >> 16) & 0xff);
2519 buf[3] = (char) ((pyc_magic >> 24) & 0xff);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002520
Guido van Rossumad8d3002007-08-03 18:40:49 +00002521 return PyBytes_FromStringAndSize(buf, 4);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002522}
2523
Guido van Rossum79f25d91997-04-29 20:08:16 +00002524static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +00002525imp_get_suffixes(PyObject *self, PyObject *noargs)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002526{
Guido van Rossum79f25d91997-04-29 20:08:16 +00002527 PyObject *list;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002528 struct filedescr *fdp;
2529
Guido van Rossum79f25d91997-04-29 20:08:16 +00002530 list = PyList_New(0);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002531 if (list == NULL)
2532 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002533 for (fdp = _PyImport_Filetab; fdp->suffix != NULL; fdp++) {
2534 PyObject *item = Py_BuildValue("ssi",
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002535 fdp->suffix, fdp->mode, fdp->type);
2536 if (item == NULL) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00002537 Py_DECREF(list);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002538 return NULL;
2539 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002540 if (PyList_Append(list, item) < 0) {
2541 Py_DECREF(list);
2542 Py_DECREF(item);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002543 return NULL;
2544 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002545 Py_DECREF(item);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002546 }
2547 return list;
2548}
2549
Guido van Rossum79f25d91997-04-29 20:08:16 +00002550static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002551call_find_module(char *name, PyObject *path)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002552{
Tim Petersdbd9ba62000-07-09 03:09:57 +00002553 extern int fclose(FILE *);
Guido van Rossum79f25d91997-04-29 20:08:16 +00002554 PyObject *fob, *ret;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002555 struct filedescr *fdp;
2556 char pathname[MAXPATHLEN+1];
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002557 FILE *fp = NULL;
2558
2559 pathname[0] = '\0';
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002560 if (path == Py_None)
2561 path = NULL;
Just van Rossum52e14d62002-12-30 22:08:05 +00002562 fdp = find_module(NULL, name, path, pathname, MAXPATHLEN+1, &fp, NULL);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002563 if (fdp == NULL)
2564 return NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002565 if (fp != NULL) {
2566 fob = PyFile_FromFile(fp, pathname, fdp->mode, fclose);
2567 if (fob == NULL) {
2568 fclose(fp);
2569 return NULL;
2570 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002571 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002572 else {
2573 fob = Py_None;
2574 Py_INCREF(fob);
Tim Peters50d8d372001-02-28 05:34:27 +00002575 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002576 ret = Py_BuildValue("Os(ssi)",
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002577 fob, pathname, fdp->suffix, fdp->mode, fdp->type);
Guido van Rossum79f25d91997-04-29 20:08:16 +00002578 Py_DECREF(fob);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002579 return ret;
2580}
2581
Guido van Rossum79f25d91997-04-29 20:08:16 +00002582static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002583imp_find_module(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002584{
2585 char *name;
2586 PyObject *path = NULL;
Guido van Rossum43713e52000-02-29 13:59:29 +00002587 if (!PyArg_ParseTuple(args, "s|O:find_module", &name, &path))
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002588 return NULL;
2589 return call_find_module(name, path);
2590}
2591
2592static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002593imp_init_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002594{
2595 char *name;
2596 int ret;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002597 PyObject *m;
Guido van Rossum43713e52000-02-29 13:59:29 +00002598 if (!PyArg_ParseTuple(args, "s:init_builtin", &name))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002599 return NULL;
2600 ret = init_builtin(name);
2601 if (ret < 0)
2602 return NULL;
2603 if (ret == 0) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00002604 Py_INCREF(Py_None);
2605 return Py_None;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002606 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002607 m = PyImport_AddModule(name);
2608 Py_XINCREF(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002609 return m;
2610}
2611
Guido van Rossum79f25d91997-04-29 20:08:16 +00002612static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002613imp_init_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002614{
2615 char *name;
2616 int ret;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002617 PyObject *m;
Guido van Rossum43713e52000-02-29 13:59:29 +00002618 if (!PyArg_ParseTuple(args, "s:init_frozen", &name))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002619 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002620 ret = PyImport_ImportFrozenModule(name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002621 if (ret < 0)
2622 return NULL;
2623 if (ret == 0) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00002624 Py_INCREF(Py_None);
2625 return Py_None;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002626 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002627 m = PyImport_AddModule(name);
2628 Py_XINCREF(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002629 return m;
2630}
2631
Guido van Rossum79f25d91997-04-29 20:08:16 +00002632static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002633imp_get_frozen_object(PyObject *self, PyObject *args)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002634{
2635 char *name;
Jack Jansen95ffa231995-10-03 14:38:41 +00002636
Guido van Rossum43713e52000-02-29 13:59:29 +00002637 if (!PyArg_ParseTuple(args, "s:get_frozen_object", &name))
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002638 return NULL;
2639 return get_frozen_object(name);
2640}
2641
Guido van Rossum79f25d91997-04-29 20:08:16 +00002642static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002643imp_is_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002644{
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002645 char *name;
Guido van Rossum43713e52000-02-29 13:59:29 +00002646 if (!PyArg_ParseTuple(args, "s:is_builtin", &name))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002647 return NULL;
Guido van Rossum50ee94f2002-04-09 18:00:58 +00002648 return PyInt_FromLong(is_builtin(name));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002649}
2650
Guido van Rossum79f25d91997-04-29 20:08:16 +00002651static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002652imp_is_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002653{
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002654 char *name;
Guido van Rossum323bf5e1998-06-24 03:54:06 +00002655 struct _frozen *p;
Guido van Rossum43713e52000-02-29 13:59:29 +00002656 if (!PyArg_ParseTuple(args, "s:is_frozen", &name))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002657 return NULL;
Guido van Rossum323bf5e1998-06-24 03:54:06 +00002658 p = find_frozen(name);
Guido van Rossumb8bff3f2002-04-07 06:34:38 +00002659 return PyBool_FromLong((long) (p == NULL ? 0 : p->size));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002660}
2661
2662static FILE *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002663get_file(char *pathname, PyObject *fob, char *mode)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002664{
2665 FILE *fp;
Guido van Rossumda5b8f22007-06-12 23:30:11 +00002666 if (mode[0] == 'U')
2667 mode = "r" PY_STDIOTEXTMODE;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002668 if (fob == NULL) {
2669 fp = fopen(pathname, mode);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002670 }
2671 else {
Guido van Rossumda5b8f22007-06-12 23:30:11 +00002672 int fd = PyObject_AsFileDescriptor(fob);
2673 if (fd == -1)
2674 return NULL;
2675 /* XXX This will leak a FILE struct. Fix this!!!!
2676 (But it doesn't leak a file descrioptor!) */
2677 fp = fdopen(fd, mode);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002678 }
Guido van Rossumda5b8f22007-06-12 23:30:11 +00002679 if (fp == NULL)
2680 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002681 return fp;
2682}
2683
Guido van Rossum79f25d91997-04-29 20:08:16 +00002684static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002685imp_load_compiled(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002686{
2687 char *name;
2688 char *pathname;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002689 PyObject *fob = NULL;
2690 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002691 FILE *fp;
Guido van Rossumda5b8f22007-06-12 23:30:11 +00002692 if (!PyArg_ParseTuple(args, "ss|O:load_compiled",
2693 &name, &pathname, &fob))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002694 return NULL;
2695 fp = get_file(pathname, fob, "rb");
2696 if (fp == NULL)
2697 return NULL;
2698 m = load_compiled_module(name, pathname, fp);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002699 if (fob == NULL)
2700 fclose(fp);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002701 return m;
2702}
2703
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002704#ifdef HAVE_DYNAMIC_LOADING
2705
Guido van Rossum79f25d91997-04-29 20:08:16 +00002706static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002707imp_load_dynamic(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002708{
2709 char *name;
2710 char *pathname;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002711 PyObject *fob = NULL;
2712 PyObject *m;
Guido van Rossum7faeab31995-07-07 22:50:36 +00002713 FILE *fp = NULL;
Guido van Rossumda5b8f22007-06-12 23:30:11 +00002714 if (!PyArg_ParseTuple(args, "ss|O:load_dynamic",
2715 &name, &pathname, &fob))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002716 return NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002717 if (fob) {
Guido van Rossum7faeab31995-07-07 22:50:36 +00002718 fp = get_file(pathname, fob, "r");
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002719 if (fp == NULL)
2720 return NULL;
2721 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002722 m = _PyImport_LoadDynamicModule(name, pathname, fp);
Guido van Rossum7faeab31995-07-07 22:50:36 +00002723 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002724}
2725
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002726#endif /* HAVE_DYNAMIC_LOADING */
2727
Guido van Rossum79f25d91997-04-29 20:08:16 +00002728static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002729imp_load_source(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002730{
2731 char *name;
2732 char *pathname;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002733 PyObject *fob = NULL;
2734 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002735 FILE *fp;
Guido van Rossumda5b8f22007-06-12 23:30:11 +00002736 if (!PyArg_ParseTuple(args, "ss|O:load_source",
2737 &name, &pathname, &fob))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002738 return NULL;
2739 fp = get_file(pathname, fob, "r");
2740 if (fp == NULL)
2741 return NULL;
2742 m = load_source_module(name, pathname, fp);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002743 if (fob == NULL)
2744 fclose(fp);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002745 return m;
2746}
2747
Guido van Rossum79f25d91997-04-29 20:08:16 +00002748static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002749imp_load_module(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002750{
2751 char *name;
2752 PyObject *fob;
2753 char *pathname;
2754 char *suffix; /* Unused */
2755 char *mode;
2756 int type;
2757 FILE *fp;
2758
Guido van Rossum43713e52000-02-29 13:59:29 +00002759 if (!PyArg_ParseTuple(args, "sOs(ssi):load_module",
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002760 &name, &fob, &pathname,
2761 &suffix, &mode, &type))
2762 return NULL;
Guido van Rossum5e2c5fa2002-05-30 17:33:07 +00002763 if (*mode) {
2764 /* Mode must start with 'r' or 'U' and must not contain '+'.
2765 Implicit in this test is the assumption that the mode
2766 may contain other modifiers like 'b' or 't'. */
2767
2768 if (!(*mode == 'r' || *mode == 'U') || strchr(mode, '+')) {
Jeremy Hylton4ae6fae2002-05-30 17:15:25 +00002769 PyErr_Format(PyExc_ValueError,
2770 "invalid file open mode %.200s", mode);
2771 return NULL;
Guido van Rossum5e2c5fa2002-05-30 17:33:07 +00002772 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002773 }
2774 if (fob == Py_None)
2775 fp = NULL;
2776 else {
Guido van Rossumda5b8f22007-06-12 23:30:11 +00002777 fp = get_file(NULL, fob, mode);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002778 if (fp == NULL)
2779 return NULL;
2780 }
Just van Rossum52e14d62002-12-30 22:08:05 +00002781 return load_module(name, fp, pathname, type, NULL);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002782}
2783
2784static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002785imp_load_package(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002786{
2787 char *name;
2788 char *pathname;
Guido van Rossum43713e52000-02-29 13:59:29 +00002789 if (!PyArg_ParseTuple(args, "ss:load_package", &name, &pathname))
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002790 return NULL;
2791 return load_package(name, pathname);
2792}
2793
2794static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002795imp_new_module(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002796{
2797 char *name;
Guido van Rossum43713e52000-02-29 13:59:29 +00002798 if (!PyArg_ParseTuple(args, "s:new_module", &name))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002799 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002800 return PyModule_New(name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002801}
2802
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002803/* Doc strings */
2804
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002805PyDoc_STRVAR(doc_imp,
2806"This module provides the components needed to build your own\n\
2807__import__ function. Undocumented functions are obsolete.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002808
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002809PyDoc_STRVAR(doc_find_module,
2810"find_module(name, [path]) -> (file, filename, (suffix, mode, type))\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002811Search for a module. If path is omitted or None, search for a\n\
2812built-in, frozen or special module and continue search in sys.path.\n\
2813The module name cannot contain '.'; to search for a submodule of a\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002814package, pass the submodule name and the package's __path__.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002815
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002816PyDoc_STRVAR(doc_load_module,
2817"load_module(name, file, filename, (suffix, mode, type)) -> module\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002818Load a module, given information returned by find_module().\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002819The module name must include the full package name, if any.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002820
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002821PyDoc_STRVAR(doc_get_magic,
2822"get_magic() -> string\n\
2823Return the magic number for .pyc or .pyo files.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002824
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002825PyDoc_STRVAR(doc_get_suffixes,
2826"get_suffixes() -> [(suffix, mode, type), ...]\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002827Return a list of (suffix, mode, type) tuples describing the files\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002828that find_module() looks for.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002829
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002830PyDoc_STRVAR(doc_new_module,
2831"new_module(name) -> module\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002832Create a new module. Do not enter it in sys.modules.\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002833The module name must include the full package name, if any.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002834
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002835PyDoc_STRVAR(doc_lock_held,
Tim Petersa7c65092004-08-01 23:26:05 +00002836"lock_held() -> boolean\n\
2837Return True if the import lock is currently held, else False.\n\
2838On platforms without threads, return False.");
Tim Peters69232342001-08-30 05:16:13 +00002839
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00002840PyDoc_STRVAR(doc_acquire_lock,
2841"acquire_lock() -> None\n\
Neal Norwitz2294c0d2003-02-12 23:02:21 +00002842Acquires the interpreter's import lock for the current thread.\n\
2843This lock should be used by import hooks to ensure thread-safety\n\
2844when importing modules.\n\
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00002845On platforms without threads, this function does nothing.");
2846
2847PyDoc_STRVAR(doc_release_lock,
2848"release_lock() -> None\n\
2849Release the interpreter's import lock.\n\
2850On platforms without threads, this function does nothing.");
2851
Guido van Rossum79f25d91997-04-29 20:08:16 +00002852static PyMethodDef imp_methods[] = {
Neal Norwitz08ea61a2003-02-17 18:18:00 +00002853 {"find_module", imp_find_module, METH_VARARGS, doc_find_module},
2854 {"get_magic", imp_get_magic, METH_NOARGS, doc_get_magic},
2855 {"get_suffixes", imp_get_suffixes, METH_NOARGS, doc_get_suffixes},
2856 {"load_module", imp_load_module, METH_VARARGS, doc_load_module},
2857 {"new_module", imp_new_module, METH_VARARGS, doc_new_module},
2858 {"lock_held", imp_lock_held, METH_NOARGS, doc_lock_held},
2859 {"acquire_lock", imp_acquire_lock, METH_NOARGS, doc_acquire_lock},
2860 {"release_lock", imp_release_lock, METH_NOARGS, doc_release_lock},
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002861 /* The rest are obsolete */
Neal Norwitz031829d2002-03-31 14:37:44 +00002862 {"get_frozen_object", imp_get_frozen_object, METH_VARARGS},
2863 {"init_builtin", imp_init_builtin, METH_VARARGS},
2864 {"init_frozen", imp_init_frozen, METH_VARARGS},
2865 {"is_builtin", imp_is_builtin, METH_VARARGS},
2866 {"is_frozen", imp_is_frozen, METH_VARARGS},
2867 {"load_compiled", imp_load_compiled, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002868#ifdef HAVE_DYNAMIC_LOADING
Neal Norwitz031829d2002-03-31 14:37:44 +00002869 {"load_dynamic", imp_load_dynamic, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002870#endif
Neal Norwitz031829d2002-03-31 14:37:44 +00002871 {"load_package", imp_load_package, METH_VARARGS},
Neal Norwitz031829d2002-03-31 14:37:44 +00002872 {"load_source", imp_load_source, METH_VARARGS},
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002873 {NULL, NULL} /* sentinel */
2874};
2875
Guido van Rossum1a8791e1998-08-04 22:46:29 +00002876static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002877setint(PyObject *d, char *name, int value)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002878{
2879 PyObject *v;
2880 int err;
2881
2882 v = PyInt_FromLong((long)value);
2883 err = PyDict_SetItemString(d, name, v);
2884 Py_XDECREF(v);
2885 return err;
2886}
2887
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002888typedef struct {
2889 PyObject_HEAD
2890} NullImporter;
2891
2892static int
2893NullImporter_init(NullImporter *self, PyObject *args, PyObject *kwds)
2894{
2895 char *path;
2896
2897 if (!_PyArg_NoKeywords("NullImporter()", kwds))
2898 return -1;
2899
2900 if (!PyArg_ParseTuple(args, "s:NullImporter",
2901 &path))
2902 return -1;
2903
2904 if (strlen(path) == 0) {
2905 PyErr_SetString(PyExc_ImportError, "empty pathname");
2906 return -1;
2907 } else {
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002908 struct stat statbuf;
2909 int rv;
2910
2911 rv = stat(path, &statbuf);
2912 if (rv == 0) {
2913 /* it exists */
2914 if (S_ISDIR(statbuf.st_mode)) {
2915 /* it's a directory */
2916 PyErr_SetString(PyExc_ImportError,
2917 "existing directory");
2918 return -1;
2919 }
2920 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002921 }
2922 return 0;
2923}
2924
2925static PyObject *
2926NullImporter_find_module(NullImporter *self, PyObject *args)
2927{
2928 Py_RETURN_NONE;
2929}
2930
2931static PyMethodDef NullImporter_methods[] = {
2932 {"find_module", (PyCFunction)NullImporter_find_module, METH_VARARGS,
2933 "Always return None"
2934 },
2935 {NULL} /* Sentinel */
2936};
2937
2938
2939static PyTypeObject NullImporterType = {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00002940 PyVarObject_HEAD_INIT(NULL, 0)
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002941 "imp.NullImporter", /*tp_name*/
2942 sizeof(NullImporter), /*tp_basicsize*/
2943 0, /*tp_itemsize*/
2944 0, /*tp_dealloc*/
2945 0, /*tp_print*/
2946 0, /*tp_getattr*/
2947 0, /*tp_setattr*/
2948 0, /*tp_compare*/
2949 0, /*tp_repr*/
2950 0, /*tp_as_number*/
2951 0, /*tp_as_sequence*/
2952 0, /*tp_as_mapping*/
2953 0, /*tp_hash */
2954 0, /*tp_call*/
2955 0, /*tp_str*/
2956 0, /*tp_getattro*/
2957 0, /*tp_setattro*/
2958 0, /*tp_as_buffer*/
2959 Py_TPFLAGS_DEFAULT, /*tp_flags*/
2960 "Null importer object", /* tp_doc */
2961 0, /* tp_traverse */
2962 0, /* tp_clear */
2963 0, /* tp_richcompare */
2964 0, /* tp_weaklistoffset */
2965 0, /* tp_iter */
2966 0, /* tp_iternext */
2967 NullImporter_methods, /* tp_methods */
2968 0, /* tp_members */
2969 0, /* tp_getset */
2970 0, /* tp_base */
2971 0, /* tp_dict */
2972 0, /* tp_descr_get */
2973 0, /* tp_descr_set */
2974 0, /* tp_dictoffset */
2975 (initproc)NullImporter_init, /* tp_init */
2976 0, /* tp_alloc */
2977 PyType_GenericNew /* tp_new */
2978};
2979
2980
Jason Tishler6bc06ec2003-09-04 11:59:50 +00002981PyMODINIT_FUNC
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002982initimp(void)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002983{
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002984 PyObject *m, *d;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002985
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002986 if (PyType_Ready(&NullImporterType) < 0)
2987 goto failure;
2988
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002989 m = Py_InitModule4("imp", imp_methods, doc_imp,
2990 NULL, PYTHON_API_VERSION);
Neal Norwitz1ac754f2006-01-19 06:09:39 +00002991 if (m == NULL)
2992 goto failure;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002993 d = PyModule_GetDict(m);
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00002994 if (d == NULL)
2995 goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002996
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002997 if (setint(d, "SEARCH_ERROR", SEARCH_ERROR) < 0) goto failure;
2998 if (setint(d, "PY_SOURCE", PY_SOURCE) < 0) goto failure;
2999 if (setint(d, "PY_COMPILED", PY_COMPILED) < 0) goto failure;
3000 if (setint(d, "C_EXTENSION", C_EXTENSION) < 0) goto failure;
3001 if (setint(d, "PY_RESOURCE", PY_RESOURCE) < 0) goto failure;
3002 if (setint(d, "PKG_DIRECTORY", PKG_DIRECTORY) < 0) goto failure;
3003 if (setint(d, "C_BUILTIN", C_BUILTIN) < 0) goto failure;
3004 if (setint(d, "PY_FROZEN", PY_FROZEN) < 0) goto failure;
Guido van Rossum0f84a341998-08-06 13:36:01 +00003005 if (setint(d, "PY_CODERESOURCE", PY_CODERESOURCE) < 0) goto failure;
Just van Rossum52e14d62002-12-30 22:08:05 +00003006 if (setint(d, "IMP_HOOK", IMP_HOOK) < 0) goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003007
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003008 Py_INCREF(&NullImporterType);
3009 PyModule_AddObject(m, "NullImporter", (PyObject *)&NullImporterType);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003010 failure:
3011 ;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003012}
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003013
3014
Guido van Rossumb18618d2000-05-03 23:44:39 +00003015/* API for embedding applications that want to add their own entries
3016 to the table of built-in modules. This should normally be called
3017 *before* Py_Initialize(). When the table resize fails, -1 is
3018 returned and the existing table is unchanged.
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003019
3020 After a similar function by Just van Rossum. */
3021
3022int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003023PyImport_ExtendInittab(struct _inittab *newtab)
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003024{
3025 static struct _inittab *our_copy = NULL;
3026 struct _inittab *p;
3027 int i, n;
3028
3029 /* Count the number of entries in both tables */
3030 for (n = 0; newtab[n].name != NULL; n++)
3031 ;
3032 if (n == 0)
3033 return 0; /* Nothing to do */
3034 for (i = 0; PyImport_Inittab[i].name != NULL; i++)
3035 ;
3036
3037 /* Allocate new memory for the combined table */
Guido van Rossumb18618d2000-05-03 23:44:39 +00003038 p = our_copy;
3039 PyMem_RESIZE(p, struct _inittab, i+n+1);
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003040 if (p == NULL)
3041 return -1;
3042
3043 /* Copy the tables into the new memory */
3044 if (our_copy != PyImport_Inittab)
3045 memcpy(p, PyImport_Inittab, (i+1) * sizeof(struct _inittab));
3046 PyImport_Inittab = our_copy = p;
3047 memcpy(p+i, newtab, (n+1) * sizeof(struct _inittab));
3048
3049 return 0;
3050}
3051
3052/* Shorthand to add a single entry given a name and a function */
3053
3054int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003055PyImport_AppendInittab(char *name, void (*initfunc)(void))
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003056{
3057 struct _inittab newtab[2];
3058
3059 memset(newtab, '\0', sizeof newtab);
3060
3061 newtab[0].name = name;
3062 newtab[0].initfunc = initfunc;
3063
3064 return PyImport_ExtendInittab(newtab);
3065}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00003066
3067#ifdef __cplusplus
3068}
3069#endif