blob: 4311352c1f9d7c6fc73ed4048b3f9beeb2a6a3c9 [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"
Kristján Valur Jónsson00b0a9e2007-05-02 16:02:48 +00007#undef Yield /* to avoid conflict with winbase.h */
8
Neal Norwitzadb69fc2005-12-17 20:54:49 +00009#include "pyarena.h"
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000010#include "pythonrun.h"
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000011#include "errcode.h"
Guido van Rossumc405b7b1991-06-04 19:39:42 +000012#include "marshal.h"
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000013#include "code.h"
Guido van Rossumc405b7b1991-06-04 19:39:42 +000014#include "compile.h"
Guido van Rossumff4949e1992-08-05 19:58:53 +000015#include "eval.h"
Guido van Rossumd8bac6d1992-02-26 15:19:13 +000016#include "osdefs.h"
Guido van Rossum1ae940a1995-01-02 19:04:15 +000017#include "importdl.h"
Guido van Rossumc405b7b1991-06-04 19:39:42 +000018
Guido van Rossum55a83382000-09-20 20:31:38 +000019#ifdef HAVE_FCNTL_H
20#include <fcntl.h>
21#endif
Anthony Baxterac6bd462006-04-13 02:06:09 +000022#ifdef __cplusplus
23extern "C" {
24#endif
Guido van Rossum55a83382000-09-20 20:31:38 +000025
Thomas Woutersf70ef4f2000-07-22 18:47:25 +000026extern time_t PyOS_GetLastModificationTime(char *, FILE *);
27 /* In getmtime.c */
Guido van Rossum21d335e1993-10-15 13:01:11 +000028
Jeremy Hyltond4ceb312004-04-01 02:45:22 +000029/* Magic word to reject .pyc files generated by other Python versions.
30 It should change for each incompatible change to the bytecode.
31
32 The value of CR and LF is incorporated so if you ever read or write
Guido van Rossum7faeab31995-07-07 22:50:36 +000033 a .pyc file in text mode the magic number will be wrong; also, the
Tim Peters36515e22001-11-18 04:06:29 +000034 Apple MPW compiler swaps their values, botching string constants.
Marc-André Lemburgbd3be8f2002-02-07 11:33:49 +000035
Martin v. Löwisef82d2f2004-06-27 16:51:46 +000036 The magic numbers must be spaced apart atleast 2 values, as the
37 -U interpeter flag will cause MAGIC+1 being used. They have been
38 odd numbers for some time now.
Marc-André Lemburgbd3be8f2002-02-07 11:33:49 +000039
Jeremy Hyltond4ceb312004-04-01 02:45:22 +000040 There were a variety of old schemes for setting the magic number.
41 The current working scheme is to increment the previous value by
42 10.
Guido van Rossumf6894922002-08-31 15:16:14 +000043
Marc-André Lemburgbd3be8f2002-02-07 11:33:49 +000044 Known values:
45 Python 1.5: 20121
46 Python 1.5.1: 20121
47 Python 1.5.2: 20121
Skip Montanaro4ec3c262006-03-25 14:12:03 +000048 Python 1.6: 50428
Marc-André Lemburgbd3be8f2002-02-07 11:33:49 +000049 Python 2.0: 50823
50 Python 2.0.1: 50823
51 Python 2.1: 60202
52 Python 2.1.1: 60202
53 Python 2.1.2: 60202
54 Python 2.2: 60717
Neal Norwitz7fdcb412002-06-14 01:07:39 +000055 Python 2.3a0: 62011
Michael W. Hudsondd32a912002-08-15 14:59:02 +000056 Python 2.3a0: 62021
Guido van Rossumf6894922002-08-31 15:16:14 +000057 Python 2.3a0: 62011 (!)
Martin v. Löwisef82d2f2004-06-27 16:51:46 +000058 Python 2.4a0: 62041
Raymond Hettingerfd2d1f72004-08-23 23:37:48 +000059 Python 2.4a3: 62051
Raymond Hettinger2c31a052004-09-22 18:44:21 +000060 Python 2.4b1: 62061
Michael W. Hudsondf888462005-06-03 14:41:55 +000061 Python 2.5a0: 62071
Michael W. Hudsonaee2e282005-10-21 11:32:20 +000062 Python 2.5a0: 62081 (ast-branch)
Guido van Rossumc2e20742006-02-27 22:32:47 +000063 Python 2.5a0: 62091 (with)
Guido van Rossumf6694362006-03-10 02:28:35 +000064 Python 2.5a0: 62092 (changed WITH_CLEANUP opcode)
Neal Norwitz0d62a062006-07-30 06:53:31 +000065 Python 2.5b3: 62101 (fix wrong code: for x, in ...)
66 Python 2.5b3: 62111 (fix wrong code: x += yield)
Neal Norwitz9a70f952006-08-04 05:12:19 +000067 Python 2.5c1: 62121 (fix wrong lnotab with for loops and
68 storing constants that should have been removed)
Neal Norwitz3b3aae02006-09-05 03:56:01 +000069 Python 2.5c2: 62131 (fix wrong code: for x, in ... in listcomp/genexp)
Michael W. Hudsonaee2e282005-10-21 11:32:20 +000070.
Tim Peters36515e22001-11-18 04:06:29 +000071*/
Neal Norwitz3b3aae02006-09-05 03:56:01 +000072#define MAGIC (62131 | ((long)'\r'<<16) | ((long)'\n'<<24))
Guido van Rossum3ddee711991-12-16 13:06:34 +000073
Guido van Rossum96774c12000-05-01 20:19:08 +000074/* Magic word as global; note that _PyImport_Init() can change the
Jeremy Hylton9262b8a2000-06-30 04:59:17 +000075 value of this global to accommodate for alterations of how the
Guido van Rossum96774c12000-05-01 20:19:08 +000076 compiler works which are enabled by command line switches. */
77static long pyc_magic = MAGIC;
78
Guido van Rossum25ce5661997-08-02 03:10:38 +000079/* See _PyImport_FixupExtension() below */
80static PyObject *extensions = NULL;
Guido van Rossum3f5da241990-12-20 15:06:42 +000081
Guido van Rossum771c6c81997-10-31 18:37:24 +000082/* This table is defined in config.c: */
83extern struct _inittab _PyImport_Inittab[];
84
85struct _inittab *PyImport_Inittab = _PyImport_Inittab;
Guido van Rossum66f1fa81991-04-03 19:03:52 +000086
Guido van Rossumed1170e1999-12-20 21:23:41 +000087/* these tables define the module suffixes that Python recognizes */
88struct filedescr * _PyImport_Filetab = NULL;
Guido van Rossum48a680c2001-03-02 06:34:14 +000089
90#ifdef RISCOS
91static const struct filedescr _PyImport_StandardFiletab[] = {
Jack Jansenc88da1f2002-05-28 10:58:19 +000092 {"/py", "U", PY_SOURCE},
Guido van Rossum48a680c2001-03-02 06:34:14 +000093 {"/pyc", "rb", PY_COMPILED},
94 {0, 0}
95};
96#else
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};
Guido van Rossum48a680c2001-03-02 06:34:14 +0000105#endif
Guido van Rossumed1170e1999-12-20 21:23:41 +0000106
Phillip J. Ebyf7575d02006-07-28 21:12:07 +0000107static PyTypeObject NullImporterType; /* Forward reference */
108
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000109/* Initialize things */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000110
111void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000112_PyImport_Init(void)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000113{
Guido van Rossumed1170e1999-12-20 21:23:41 +0000114 const struct filedescr *scan;
115 struct filedescr *filetab;
116 int countD = 0;
117 int countS = 0;
118
119 /* prepare _PyImport_Filetab: copy entries from
120 _PyImport_DynLoadFiletab and _PyImport_StandardFiletab.
121 */
Georg Brandleec47f32007-08-23 18:08:33 +0000122#ifdef HAVE_DYNAMIC_LOADING
Guido van Rossumed1170e1999-12-20 21:23:41 +0000123 for (scan = _PyImport_DynLoadFiletab; scan->suffix != NULL; ++scan)
124 ++countD;
Georg Brandleec47f32007-08-23 18:08:33 +0000125#endif
Guido van Rossumed1170e1999-12-20 21:23:41 +0000126 for (scan = _PyImport_StandardFiletab; scan->suffix != NULL; ++scan)
127 ++countS;
Guido van Rossumb18618d2000-05-03 23:44:39 +0000128 filetab = PyMem_NEW(struct filedescr, countD + countS + 1);
Neal Norwitze1fdb322006-07-21 05:32:28 +0000129 if (filetab == NULL)
Neal Norwitz33722ae2006-07-21 07:59:02 +0000130 Py_FatalError("Can't initialize import file table.");
Georg Brandleec47f32007-08-23 18:08:33 +0000131#ifdef HAVE_DYNAMIC_LOADING
Guido van Rossumed1170e1999-12-20 21:23:41 +0000132 memcpy(filetab, _PyImport_DynLoadFiletab,
133 countD * sizeof(struct filedescr));
Georg Brandleec47f32007-08-23 18:08:33 +0000134#endif
Guido van Rossumed1170e1999-12-20 21:23:41 +0000135 memcpy(filetab + countD, _PyImport_StandardFiletab,
136 countS * sizeof(struct filedescr));
137 filetab[countD + countS].suffix = NULL;
138
139 _PyImport_Filetab = filetab;
140
Guido van Rossum0824f631997-03-11 18:37:35 +0000141 if (Py_OptimizeFlag) {
Guido van Rossumed1170e1999-12-20 21:23:41 +0000142 /* Replace ".pyc" with ".pyo" in _PyImport_Filetab */
143 for (; filetab->suffix != NULL; filetab++) {
Guido van Rossum48a680c2001-03-02 06:34:14 +0000144#ifndef RISCOS
Guido van Rossumed1170e1999-12-20 21:23:41 +0000145 if (strcmp(filetab->suffix, ".pyc") == 0)
146 filetab->suffix = ".pyo";
Guido van Rossum48a680c2001-03-02 06:34:14 +0000147#else
148 if (strcmp(filetab->suffix, "/pyc") == 0)
149 filetab->suffix = "/pyo";
150#endif
Guido van Rossum0824f631997-03-11 18:37:35 +0000151 }
152 }
Guido van Rossum96774c12000-05-01 20:19:08 +0000153
154 if (Py_UnicodeFlag) {
155 /* Fix the pyc_magic so that byte compiled code created
156 using the all-Unicode method doesn't interfere with
157 code created in normal operation mode. */
158 pyc_magic = MAGIC + 1;
159 }
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000160}
161
Guido van Rossum25ce5661997-08-02 03:10:38 +0000162void
Just van Rossum52e14d62002-12-30 22:08:05 +0000163_PyImportHooks_Init(void)
164{
165 PyObject *v, *path_hooks = NULL, *zimpimport;
166 int err = 0;
167
168 /* adding sys.path_hooks and sys.path_importer_cache, setting up
169 zipimport */
Phillip J. Ebyf7575d02006-07-28 21:12:07 +0000170 if (PyType_Ready(&NullImporterType) < 0)
171 goto error;
Just van Rossum52e14d62002-12-30 22:08:05 +0000172
173 if (Py_VerboseFlag)
174 PySys_WriteStderr("# installing zipimport hook\n");
175
176 v = PyList_New(0);
177 if (v == NULL)
178 goto error;
179 err = PySys_SetObject("meta_path", v);
180 Py_DECREF(v);
181 if (err)
182 goto error;
183 v = PyDict_New();
184 if (v == NULL)
185 goto error;
186 err = PySys_SetObject("path_importer_cache", v);
187 Py_DECREF(v);
188 if (err)
189 goto error;
190 path_hooks = PyList_New(0);
191 if (path_hooks == NULL)
192 goto error;
193 err = PySys_SetObject("path_hooks", path_hooks);
194 if (err) {
195 error:
196 PyErr_Print();
Phillip J. Ebyf7575d02006-07-28 21:12:07 +0000197 Py_FatalError("initializing sys.meta_path, sys.path_hooks, "
198 "path_importer_cache, or NullImporter failed"
199 );
Just van Rossum52e14d62002-12-30 22:08:05 +0000200 }
Phillip J. Ebyf7575d02006-07-28 21:12:07 +0000201
Just van Rossum52e14d62002-12-30 22:08:05 +0000202 zimpimport = PyImport_ImportModule("zipimport");
203 if (zimpimport == NULL) {
204 PyErr_Clear(); /* No zip import module -- okay */
205 if (Py_VerboseFlag)
206 PySys_WriteStderr("# can't import zipimport\n");
207 }
208 else {
209 PyObject *zipimporter = PyObject_GetAttrString(zimpimport,
210 "zipimporter");
211 Py_DECREF(zimpimport);
212 if (zipimporter == NULL) {
213 PyErr_Clear(); /* No zipimporter object -- okay */
214 if (Py_VerboseFlag)
215 PySys_WriteStderr(
Fred Drake1e5fc552003-07-11 15:01:02 +0000216 "# can't import zipimport.zipimporter\n");
Just van Rossum52e14d62002-12-30 22:08:05 +0000217 }
218 else {
219 /* sys.path_hooks.append(zipimporter) */
220 err = PyList_Append(path_hooks, zipimporter);
221 Py_DECREF(zipimporter);
222 if (err)
223 goto error;
224 if (Py_VerboseFlag)
225 PySys_WriteStderr(
226 "# installed zipimport hook\n");
227 }
228 }
229 Py_DECREF(path_hooks);
230}
231
232void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000233_PyImport_Fini(void)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000234{
235 Py_XDECREF(extensions);
236 extensions = NULL;
Barry Warsaw84294482000-10-03 16:02:05 +0000237 PyMem_DEL(_PyImport_Filetab);
238 _PyImport_Filetab = NULL;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000239}
240
241
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000242/* Locking primitives to prevent parallel imports of the same module
243 in different threads to return with a partially loaded module.
244 These calls are serialized by the global interpreter lock. */
245
246#ifdef WITH_THREAD
247
Guido van Rossum49b56061998-10-01 20:42:43 +0000248#include "pythread.h"
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000249
Guido van Rossum65d5b571998-12-21 19:32:43 +0000250static PyThread_type_lock import_lock = 0;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000251static long import_lock_thread = -1;
252static int import_lock_level = 0;
253
254static void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000255lock_import(void)
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000256{
Guido van Rossum65d5b571998-12-21 19:32:43 +0000257 long me = PyThread_get_thread_ident();
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000258 if (me == -1)
259 return; /* Too bad */
Neal Norwitze1fdb322006-07-21 05:32:28 +0000260 if (import_lock == NULL) {
Guido van Rossum65d5b571998-12-21 19:32:43 +0000261 import_lock = PyThread_allocate_lock();
Neal Norwitze1fdb322006-07-21 05:32:28 +0000262 if (import_lock == NULL)
263 return; /* Nothing much we can do. */
264 }
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000265 if (import_lock_thread == me) {
266 import_lock_level++;
267 return;
268 }
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000269 if (import_lock_thread != -1 || !PyThread_acquire_lock(import_lock, 0))
270 {
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000271 PyThreadState *tstate = PyEval_SaveThread();
Guido van Rossum65d5b571998-12-21 19:32:43 +0000272 PyThread_acquire_lock(import_lock, 1);
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000273 PyEval_RestoreThread(tstate);
274 }
275 import_lock_thread = me;
276 import_lock_level = 1;
277}
278
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000279static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000280unlock_import(void)
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000281{
Guido van Rossum65d5b571998-12-21 19:32:43 +0000282 long me = PyThread_get_thread_ident();
Neal Norwitze1fdb322006-07-21 05:32:28 +0000283 if (me == -1 || import_lock == NULL)
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000284 return 0; /* Too bad */
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000285 if (import_lock_thread != me)
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000286 return -1;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000287 import_lock_level--;
288 if (import_lock_level == 0) {
289 import_lock_thread = -1;
Guido van Rossum65d5b571998-12-21 19:32:43 +0000290 PyThread_release_lock(import_lock);
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000291 }
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000292 return 1;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000293}
294
Guido van Rossum8ee3e5a2005-09-14 18:09:42 +0000295/* This function is called from PyOS_AfterFork to ensure that newly
296 created child processes do not share locks with the parent. */
297
298void
299_PyImport_ReInitLock(void)
300{
301#ifdef _AIX
302 if (import_lock != NULL)
303 import_lock = PyThread_allocate_lock();
304#endif
305}
306
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000307#else
308
309#define lock_import()
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000310#define unlock_import() 0
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000311
312#endif
313
Tim Peters69232342001-08-30 05:16:13 +0000314static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000315imp_lock_held(PyObject *self, PyObject *noargs)
Tim Peters69232342001-08-30 05:16:13 +0000316{
Tim Peters69232342001-08-30 05:16:13 +0000317#ifdef WITH_THREAD
Guido van Rossumb8bff3f2002-04-07 06:34:38 +0000318 return PyBool_FromLong(import_lock_thread != -1);
Tim Peters69232342001-08-30 05:16:13 +0000319#else
Guido van Rossumb8bff3f2002-04-07 06:34:38 +0000320 return PyBool_FromLong(0);
Tim Peters69232342001-08-30 05:16:13 +0000321#endif
322}
323
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000324static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000325imp_acquire_lock(PyObject *self, PyObject *noargs)
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000326{
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000327#ifdef WITH_THREAD
328 lock_import();
329#endif
Neal Norwitz2294c0d2003-02-12 23:02:21 +0000330 Py_INCREF(Py_None);
331 return Py_None;
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000332}
333
334static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000335imp_release_lock(PyObject *self, PyObject *noargs)
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000336{
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000337#ifdef WITH_THREAD
338 if (unlock_import() < 0) {
339 PyErr_SetString(PyExc_RuntimeError,
340 "not holding the import lock");
341 return NULL;
342 }
343#endif
Neal Norwitz2294c0d2003-02-12 23:02:21 +0000344 Py_INCREF(Py_None);
345 return Py_None;
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000346}
347
Collin Wintere19d7a32007-03-12 16:49:23 +0000348static void
349imp_modules_reloading_clear (void)
350{
351 PyInterpreterState *interp = PyThreadState_Get()->interp;
352 if (interp->modules_reloading == NULL)
353 return;
354 PyDict_Clear(interp->modules_reloading);
355 return;
356}
357
Guido van Rossum25ce5661997-08-02 03:10:38 +0000358/* Helper for sys */
359
360PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000361PyImport_GetModuleDict(void)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000362{
Nicholas Bastine5662ae2004-03-24 22:22:12 +0000363 PyInterpreterState *interp = PyThreadState_GET()->interp;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000364 if (interp->modules == NULL)
365 Py_FatalError("PyImport_GetModuleDict: no module dictionary!");
366 return interp->modules;
367}
368
Guido van Rossum3f5da241990-12-20 15:06:42 +0000369
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000370/* List of names to clear in sys */
371static char* sys_deletes[] = {
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000372 "path", "argv", "ps1", "ps2", "exitfunc",
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000373 "exc_type", "exc_value", "exc_traceback",
374 "last_type", "last_value", "last_traceback",
Just van Rossum52e14d62002-12-30 22:08:05 +0000375 "path_hooks", "path_importer_cache", "meta_path",
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000376 NULL
377};
378
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000379static char* sys_files[] = {
380 "stdin", "__stdin__",
381 "stdout", "__stdout__",
382 "stderr", "__stderr__",
383 NULL
384};
385
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000386
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000387/* Un-initialize things, as good as we can */
Guido van Rossum3f5da241990-12-20 15:06:42 +0000388
Guido van Rossum3f5da241990-12-20 15:06:42 +0000389void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000390PyImport_Cleanup(void)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000391{
Martin v. Löwis18e16552006-02-15 17:27:45 +0000392 Py_ssize_t pos, ndone;
Guido van Rossum758eec01998-01-19 21:58:26 +0000393 char *name;
394 PyObject *key, *value, *dict;
Nicholas Bastine5662ae2004-03-24 22:22:12 +0000395 PyInterpreterState *interp = PyThreadState_GET()->interp;
Guido van Rossum758eec01998-01-19 21:58:26 +0000396 PyObject *modules = interp->modules;
397
398 if (modules == NULL)
399 return; /* Already done */
400
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000401 /* Delete some special variables first. These are common
402 places where user values hide and people complain when their
403 destructors fail. Since the modules containing them are
404 deleted *last* of all, they would come too late in the normal
405 destruction order. Sigh. */
406
407 value = PyDict_GetItemString(modules, "__builtin__");
408 if (value != NULL && PyModule_Check(value)) {
409 dict = PyModule_GetDict(value);
410 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000411 PySys_WriteStderr("# clear __builtin__._\n");
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000412 PyDict_SetItemString(dict, "_", Py_None);
413 }
414 value = PyDict_GetItemString(modules, "sys");
415 if (value != NULL && PyModule_Check(value)) {
416 char **p;
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000417 PyObject *v;
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000418 dict = PyModule_GetDict(value);
419 for (p = sys_deletes; *p != NULL; p++) {
420 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000421 PySys_WriteStderr("# clear sys.%s\n", *p);
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000422 PyDict_SetItemString(dict, *p, Py_None);
423 }
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000424 for (p = sys_files; *p != NULL; p+=2) {
425 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000426 PySys_WriteStderr("# restore sys.%s\n", *p);
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000427 v = PyDict_GetItemString(dict, *(p+1));
428 if (v == NULL)
429 v = Py_None;
430 PyDict_SetItemString(dict, *p, v);
431 }
432 }
433
434 /* First, delete __main__ */
435 value = PyDict_GetItemString(modules, "__main__");
436 if (value != NULL && PyModule_Check(value)) {
437 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000438 PySys_WriteStderr("# cleanup __main__\n");
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000439 _PyModule_Clear(value);
440 PyDict_SetItemString(modules, "__main__", Py_None);
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000441 }
442
Guido van Rossum758eec01998-01-19 21:58:26 +0000443 /* The special treatment of __builtin__ here is because even
444 when it's not referenced as a module, its dictionary is
445 referenced by almost every module's __builtins__. Since
446 deleting a module clears its dictionary (even if there are
447 references left to it), we need to delete the __builtin__
448 module last. Likewise, we don't delete sys until the very
449 end because it is implicitly referenced (e.g. by print).
450
451 Also note that we 'delete' modules by replacing their entry
452 in the modules dict with None, rather than really deleting
453 them; this avoids a rehash of the modules dictionary and
454 also marks them as "non existent" so they won't be
455 re-imported. */
456
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000457 /* Next, repeatedly delete modules with a reference count of
Guido van Rossum758eec01998-01-19 21:58:26 +0000458 one (skipping __builtin__ and sys) and delete them */
459 do {
460 ndone = 0;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000461 pos = 0;
Guido van Rossum758eec01998-01-19 21:58:26 +0000462 while (PyDict_Next(modules, &pos, &key, &value)) {
463 if (value->ob_refcnt != 1)
464 continue;
Guido van Rossum566373e1998-10-01 15:24:50 +0000465 if (PyString_Check(key) && PyModule_Check(value)) {
466 name = PyString_AS_STRING(key);
Guido van Rossum758eec01998-01-19 21:58:26 +0000467 if (strcmp(name, "__builtin__") == 0)
468 continue;
469 if (strcmp(name, "sys") == 0)
470 continue;
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000471 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000472 PySys_WriteStderr(
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000473 "# cleanup[1] %s\n", name);
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000474 _PyModule_Clear(value);
Guido van Rossum758eec01998-01-19 21:58:26 +0000475 PyDict_SetItem(modules, key, Py_None);
476 ndone++;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000477 }
478 }
Guido van Rossum758eec01998-01-19 21:58:26 +0000479 } while (ndone > 0);
480
Guido van Rossum758eec01998-01-19 21:58:26 +0000481 /* Next, delete all modules (still skipping __builtin__ and sys) */
482 pos = 0;
483 while (PyDict_Next(modules, &pos, &key, &value)) {
Guido van Rossum566373e1998-10-01 15:24:50 +0000484 if (PyString_Check(key) && PyModule_Check(value)) {
485 name = PyString_AS_STRING(key);
Guido van Rossum758eec01998-01-19 21:58:26 +0000486 if (strcmp(name, "__builtin__") == 0)
487 continue;
488 if (strcmp(name, "sys") == 0)
489 continue;
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000490 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000491 PySys_WriteStderr("# cleanup[2] %s\n", name);
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000492 _PyModule_Clear(value);
Guido van Rossum758eec01998-01-19 21:58:26 +0000493 PyDict_SetItem(modules, key, Py_None);
494 }
495 }
496
497 /* Next, delete sys and __builtin__ (in that order) */
498 value = PyDict_GetItemString(modules, "sys");
499 if (value != NULL && PyModule_Check(value)) {
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000500 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000501 PySys_WriteStderr("# cleanup sys\n");
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000502 _PyModule_Clear(value);
Guido van Rossum758eec01998-01-19 21:58:26 +0000503 PyDict_SetItemString(modules, "sys", Py_None);
504 }
505 value = PyDict_GetItemString(modules, "__builtin__");
506 if (value != NULL && PyModule_Check(value)) {
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000507 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000508 PySys_WriteStderr("# cleanup __builtin__\n");
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000509 _PyModule_Clear(value);
Guido van Rossum758eec01998-01-19 21:58:26 +0000510 PyDict_SetItemString(modules, "__builtin__", Py_None);
511 }
512
513 /* Finally, clear and delete the modules directory */
514 PyDict_Clear(modules);
515 interp->modules = NULL;
516 Py_DECREF(modules);
Collin Wintere19d7a32007-03-12 16:49:23 +0000517 Py_CLEAR(interp->modules_reloading);
Guido van Rossum8d15b5d1990-10-26 14:58:58 +0000518}
Guido van Rossum7f133ed1991-02-19 12:23:57 +0000519
520
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000521/* Helper for pythonrun.c -- return magic number */
522
523long
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000524PyImport_GetMagicNumber(void)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000525{
Guido van Rossum96774c12000-05-01 20:19:08 +0000526 return pyc_magic;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000527}
528
529
Guido van Rossum25ce5661997-08-02 03:10:38 +0000530/* Magic for extension modules (built-in as well as dynamically
531 loaded). To prevent initializing an extension module more than
532 once, we keep a static dictionary 'extensions' keyed by module name
533 (for built-in modules) or by filename (for dynamically loaded
Barry Warsaw92883382001-08-13 23:05:44 +0000534 modules), containing these modules. A copy of the module's
Guido van Rossum25ce5661997-08-02 03:10:38 +0000535 dictionary is stored by calling _PyImport_FixupExtension()
536 immediately after the module initialization function succeeds. A
537 copy can be retrieved from there by calling
538 _PyImport_FindExtension(). */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000539
Guido van Rossum79f25d91997-04-29 20:08:16 +0000540PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000541_PyImport_FixupExtension(char *name, char *filename)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000542{
Guido van Rossum25ce5661997-08-02 03:10:38 +0000543 PyObject *modules, *mod, *dict, *copy;
544 if (extensions == NULL) {
545 extensions = PyDict_New();
546 if (extensions == NULL)
547 return NULL;
548 }
549 modules = PyImport_GetModuleDict();
550 mod = PyDict_GetItemString(modules, name);
551 if (mod == NULL || !PyModule_Check(mod)) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000552 PyErr_Format(PyExc_SystemError,
553 "_PyImport_FixupExtension: module %.200s not loaded", name);
Guido van Rossum25ce5661997-08-02 03:10:38 +0000554 return NULL;
555 }
556 dict = PyModule_GetDict(mod);
557 if (dict == NULL)
558 return NULL;
Fred Drake9cd0efc2001-10-25 21:38:59 +0000559 copy = PyDict_Copy(dict);
Guido van Rossum25ce5661997-08-02 03:10:38 +0000560 if (copy == NULL)
561 return NULL;
562 PyDict_SetItemString(extensions, filename, copy);
563 Py_DECREF(copy);
564 return copy;
565}
566
567PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000568_PyImport_FindExtension(char *name, char *filename)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000569{
Fred Drake9cd0efc2001-10-25 21:38:59 +0000570 PyObject *dict, *mod, *mdict;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000571 if (extensions == NULL)
572 return NULL;
573 dict = PyDict_GetItemString(extensions, filename);
574 if (dict == NULL)
575 return NULL;
576 mod = PyImport_AddModule(name);
577 if (mod == NULL)
578 return NULL;
579 mdict = PyModule_GetDict(mod);
580 if (mdict == NULL)
581 return NULL;
Fred Drake9cd0efc2001-10-25 21:38:59 +0000582 if (PyDict_Update(mdict, dict))
Guido van Rossum25ce5661997-08-02 03:10:38 +0000583 return NULL;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000584 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000585 PySys_WriteStderr("import %s # previously loaded (%s)\n",
Guido van Rossum25ce5661997-08-02 03:10:38 +0000586 name, filename);
587 return mod;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000588}
589
590
591/* Get the module object corresponding to a module name.
592 First check the modules dictionary if there's one there,
Walter Dörwaldf0dfc7a2003-10-20 14:01:56 +0000593 if not, create a new one and insert it in the modules dictionary.
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000594 Because the former action is most common, THIS DOES NOT RETURN A
595 'NEW' REFERENCE! */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000596
Guido van Rossum79f25d91997-04-29 20:08:16 +0000597PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000598PyImport_AddModule(const char *name)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000599{
Guido van Rossum25ce5661997-08-02 03:10:38 +0000600 PyObject *modules = PyImport_GetModuleDict();
Guido van Rossum79f25d91997-04-29 20:08:16 +0000601 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000602
Guido van Rossum25ce5661997-08-02 03:10:38 +0000603 if ((m = PyDict_GetItemString(modules, name)) != NULL &&
Guido van Rossum79f25d91997-04-29 20:08:16 +0000604 PyModule_Check(m))
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000605 return m;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000606 m = PyModule_New(name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000607 if (m == NULL)
608 return NULL;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000609 if (PyDict_SetItemString(modules, name, m) != 0) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000610 Py_DECREF(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000611 return NULL;
612 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000613 Py_DECREF(m); /* Yes, it still exists, in modules! */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000614
615 return m;
616}
617
Tim Peters1cd70172004-08-02 03:52:12 +0000618/* Remove name from sys.modules, if it's there. */
619static void
620_RemoveModule(const char *name)
621{
622 PyObject *modules = PyImport_GetModuleDict();
623 if (PyDict_GetItemString(modules, name) == NULL)
624 return;
625 if (PyDict_DelItemString(modules, name) < 0)
626 Py_FatalError("import: deleting existing key in"
627 "sys.modules failed");
628}
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000629
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000630/* Execute a code object in a module and return the module object
Tim Peters1cd70172004-08-02 03:52:12 +0000631 * WITH INCREMENTED REFERENCE COUNT. If an error occurs, name is
632 * removed from sys.modules, to avoid leaving damaged module objects
633 * in sys.modules. The caller may wish to restore the original
634 * module object (if any) in this case; PyImport_ReloadModule is an
635 * example.
636 */
Guido van Rossum79f25d91997-04-29 20:08:16 +0000637PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000638PyImport_ExecCodeModule(char *name, PyObject *co)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000639{
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000640 return PyImport_ExecCodeModuleEx(name, co, (char *)NULL);
641}
642
643PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000644PyImport_ExecCodeModuleEx(char *name, PyObject *co, char *pathname)
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000645{
Guido van Rossum25ce5661997-08-02 03:10:38 +0000646 PyObject *modules = PyImport_GetModuleDict();
Guido van Rossum79f25d91997-04-29 20:08:16 +0000647 PyObject *m, *d, *v;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000648
Guido van Rossum79f25d91997-04-29 20:08:16 +0000649 m = PyImport_AddModule(name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000650 if (m == NULL)
651 return NULL;
Jeremy Hyltonecd91292004-01-02 23:25:32 +0000652 /* If the module is being reloaded, we get the old module back
653 and re-use its dict to exec the new code. */
Guido van Rossum79f25d91997-04-29 20:08:16 +0000654 d = PyModule_GetDict(m);
655 if (PyDict_GetItemString(d, "__builtins__") == NULL) {
656 if (PyDict_SetItemString(d, "__builtins__",
657 PyEval_GetBuiltins()) != 0)
Tim Peters1cd70172004-08-02 03:52:12 +0000658 goto error;
Guido van Rossum6135a871995-01-09 17:53:26 +0000659 }
Guido van Rossum9c9a07c1996-05-16 20:43:40 +0000660 /* Remember the filename as the __file__ attribute */
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000661 v = NULL;
662 if (pathname != NULL) {
663 v = PyString_FromString(pathname);
664 if (v == NULL)
665 PyErr_Clear();
666 }
667 if (v == NULL) {
668 v = ((PyCodeObject *)co)->co_filename;
669 Py_INCREF(v);
670 }
671 if (PyDict_SetItemString(d, "__file__", v) != 0)
Guido van Rossum79f25d91997-04-29 20:08:16 +0000672 PyErr_Clear(); /* Not important enough to report */
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000673 Py_DECREF(v);
674
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000675 v = PyEval_EvalCode((PyCodeObject *)co, d, d);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000676 if (v == NULL)
Tim Peters1cd70172004-08-02 03:52:12 +0000677 goto error;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000678 Py_DECREF(v);
Guido van Rossumb65e85c1997-07-10 18:00:45 +0000679
Guido van Rossum25ce5661997-08-02 03:10:38 +0000680 if ((m = PyDict_GetItemString(modules, name)) == NULL) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000681 PyErr_Format(PyExc_ImportError,
682 "Loaded module %.200s not found in sys.modules",
683 name);
Guido van Rossumb65e85c1997-07-10 18:00:45 +0000684 return NULL;
685 }
686
Guido van Rossum79f25d91997-04-29 20:08:16 +0000687 Py_INCREF(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000688
689 return m;
Tim Peters1cd70172004-08-02 03:52:12 +0000690
691 error:
692 _RemoveModule(name);
693 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000694}
695
696
697/* Given a pathname for a Python source file, fill a buffer with the
698 pathname for the corresponding compiled file. Return the pathname
699 for the compiled file, or NULL if there's no space in the buffer.
700 Doesn't set an exception. */
701
702static char *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000703make_compiled_pathname(char *pathname, char *buf, size_t buflen)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000704{
Tim Petersc1731372001-08-04 08:12:36 +0000705 size_t len = strlen(pathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000706 if (len+2 > buflen)
707 return NULL;
Tim Petersc1731372001-08-04 08:12:36 +0000708
Martin v. Löwis6238d2b2002-06-30 15:26:10 +0000709#ifdef MS_WINDOWS
Tim Petersc1731372001-08-04 08:12:36 +0000710 /* Treat .pyw as if it were .py. The case of ".pyw" must match
711 that used in _PyImport_StandardFiletab. */
712 if (len >= 4 && strcmp(&pathname[len-4], ".pyw") == 0)
713 --len; /* pretend 'w' isn't there */
714#endif
715 memcpy(buf, pathname, len);
716 buf[len] = Py_OptimizeFlag ? 'o' : 'c';
717 buf[len+1] = '\0';
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000718
719 return buf;
720}
721
722
723/* Given a pathname for a Python source file, its time of last
724 modification, and a pathname for a compiled file, check whether the
725 compiled file represents the same version of the source. If so,
726 return a FILE pointer for the compiled file, positioned just after
727 the header; if not, return NULL.
728 Doesn't set an exception. */
729
730static FILE *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000731check_compiled_module(char *pathname, time_t mtime, char *cpathname)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000732{
733 FILE *fp;
734 long magic;
735 long pyc_mtime;
736
737 fp = fopen(cpathname, "rb");
738 if (fp == NULL)
739 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000740 magic = PyMarshal_ReadLongFromFile(fp);
Guido van Rossum96774c12000-05-01 20:19:08 +0000741 if (magic != pyc_magic) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000742 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000743 PySys_WriteStderr("# %s has bad magic\n", cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000744 fclose(fp);
745 return NULL;
746 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000747 pyc_mtime = PyMarshal_ReadLongFromFile(fp);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000748 if (pyc_mtime != mtime) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000749 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000750 PySys_WriteStderr("# %s has bad mtime\n", cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000751 fclose(fp);
752 return NULL;
753 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000754 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000755 PySys_WriteStderr("# %s matches %s\n", cpathname, pathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000756 return fp;
757}
758
759
760/* Read a code object from a file and check it for validity */
761
Guido van Rossum79f25d91997-04-29 20:08:16 +0000762static PyCodeObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000763read_compiled_module(char *cpathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000764{
Guido van Rossum79f25d91997-04-29 20:08:16 +0000765 PyObject *co;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000766
Tim Petersd9b9ac82001-01-28 00:27:39 +0000767 co = PyMarshal_ReadLastObjectFromFile(fp);
Armin Rigo01ab2792004-03-26 15:09:27 +0000768 if (co == NULL)
769 return NULL;
770 if (!PyCode_Check(co)) {
771 PyErr_Format(PyExc_ImportError,
772 "Non-code object in %.200s", cpathname);
773 Py_DECREF(co);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000774 return NULL;
775 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000776 return (PyCodeObject *)co;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000777}
778
779
780/* Load a module from a compiled file, execute it, and return its
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000781 module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000782
Guido van Rossum79f25d91997-04-29 20:08:16 +0000783static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000784load_compiled_module(char *name, char *cpathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000785{
786 long magic;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000787 PyCodeObject *co;
788 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000789
Guido van Rossum79f25d91997-04-29 20:08:16 +0000790 magic = PyMarshal_ReadLongFromFile(fp);
Guido van Rossum96774c12000-05-01 20:19:08 +0000791 if (magic != pyc_magic) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000792 PyErr_Format(PyExc_ImportError,
793 "Bad magic number in %.200s", cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000794 return NULL;
795 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000796 (void) PyMarshal_ReadLongFromFile(fp);
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000797 co = read_compiled_module(cpathname, fp);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000798 if (co == NULL)
799 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000800 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000801 PySys_WriteStderr("import %s # precompiled from %s\n",
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000802 name, cpathname);
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000803 m = PyImport_ExecCodeModuleEx(name, (PyObject *)co, cpathname);
Guido van Rossum79f25d91997-04-29 20:08:16 +0000804 Py_DECREF(co);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000805
806 return m;
807}
808
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000809/* Parse a source file and return the corresponding code object */
810
Guido van Rossum79f25d91997-04-29 20:08:16 +0000811static PyCodeObject *
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000812parse_source_module(const char *pathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000813{
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000814 PyCodeObject *co = NULL;
815 mod_ty mod;
Neal Norwitzece448e2006-09-11 04:06:23 +0000816 PyArena *arena = PyArena_New();
817 if (arena == NULL)
818 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000819
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000820 mod = PyParser_ASTFromFile(fp, pathname, Py_file_input, 0, 0, 0,
Neal Norwitzadb69fc2005-12-17 20:54:49 +0000821 NULL, arena);
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000822 if (mod) {
Neal Norwitzadb69fc2005-12-17 20:54:49 +0000823 co = PyAST_Compile(mod, pathname, NULL, arena);
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000824 }
Neal Norwitzece448e2006-09-11 04:06:23 +0000825 PyArena_Free(arena);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000826 return co;
827}
828
829
Guido van Rossum55a83382000-09-20 20:31:38 +0000830/* Helper to open a bytecode file for writing in exclusive mode */
831
832static FILE *
833open_exclusive(char *filename)
834{
835#if defined(O_EXCL)&&defined(O_CREAT)&&defined(O_WRONLY)&&defined(O_TRUNC)
836 /* Use O_EXCL to avoid a race condition when another process tries to
837 write the same file. When that happens, our open() call fails,
838 which is just fine (since it's only a cache).
839 XXX If the file exists and is writable but the directory is not
840 writable, the file will never be written. Oh well.
841 */
842 int fd;
843 (void) unlink(filename);
Tim Peters42c83af2000-09-29 04:03:10 +0000844 fd = open(filename, O_EXCL|O_CREAT|O_WRONLY|O_TRUNC
845#ifdef O_BINARY
846 |O_BINARY /* necessary for Windows */
847#endif
Martin v. Löwis79acb9e2002-12-06 12:48:53 +0000848#ifdef __VMS
Martin v. Löwis18e16552006-02-15 17:27:45 +0000849 , 0666, "ctxt=bin", "shr=nil"
Martin v. Löwis79acb9e2002-12-06 12:48:53 +0000850#else
Martin v. Löwis18e16552006-02-15 17:27:45 +0000851 , 0666
Martin v. Löwis79acb9e2002-12-06 12:48:53 +0000852#endif
Martin v. Löwis18e16552006-02-15 17:27:45 +0000853 );
Guido van Rossum55a83382000-09-20 20:31:38 +0000854 if (fd < 0)
855 return NULL;
856 return fdopen(fd, "wb");
857#else
858 /* Best we can do -- on Windows this can't happen anyway */
859 return fopen(filename, "wb");
860#endif
861}
862
863
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000864/* Write a compiled module to a file, placing the time of last
865 modification of its source into the header.
866 Errors are ignored, if a write error occurs an attempt is made to
867 remove the file. */
868
869static void
Martin v. Löwis18e16552006-02-15 17:27:45 +0000870write_compiled_module(PyCodeObject *co, char *cpathname, time_t mtime)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000871{
872 FILE *fp;
873
Guido van Rossum55a83382000-09-20 20:31:38 +0000874 fp = open_exclusive(cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000875 if (fp == NULL) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000876 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000877 PySys_WriteStderr(
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000878 "# can't create %s\n", cpathname);
879 return;
880 }
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000881 PyMarshal_WriteLongToFile(pyc_magic, fp, Py_MARSHAL_VERSION);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000882 /* First write a 0 for mtime */
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000883 PyMarshal_WriteLongToFile(0L, fp, Py_MARSHAL_VERSION);
884 PyMarshal_WriteObjectToFile((PyObject *)co, fp, Py_MARSHAL_VERSION);
Armin Rigo01ab2792004-03-26 15:09:27 +0000885 if (fflush(fp) != 0 || ferror(fp)) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000886 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000887 PySys_WriteStderr("# can't write %s\n", cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000888 /* Don't keep partial file */
889 fclose(fp);
890 (void) unlink(cpathname);
891 return;
892 }
893 /* Now write the true mtime */
894 fseek(fp, 4L, 0);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000895 assert(mtime < LONG_MAX);
Martin v. Löwis725507b2006-03-07 12:08:51 +0000896 PyMarshal_WriteLongToFile((long)mtime, fp, Py_MARSHAL_VERSION);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000897 fflush(fp);
898 fclose(fp);
Guido van Rossum79f25d91997-04-29 20:08:16 +0000899 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000900 PySys_WriteStderr("# wrote %s\n", cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000901}
902
903
904/* Load a source module from a given file and return its module
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000905 object WITH INCREMENTED REFERENCE COUNT. If there's a matching
906 byte-compiled file, use that instead. */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000907
Guido van Rossum79f25d91997-04-29 20:08:16 +0000908static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000909load_source_module(char *name, char *pathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000910{
Fred Drake4c82b232000-06-30 16:18:57 +0000911 time_t mtime;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000912 FILE *fpc;
913 char buf[MAXPATHLEN+1];
914 char *cpathname;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000915 PyCodeObject *co;
916 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000917
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000918 mtime = PyOS_GetLastModificationTime(pathname, fp);
Neal Norwitz708e51a2005-10-03 04:48:15 +0000919 if (mtime == (time_t)(-1)) {
920 PyErr_Format(PyExc_RuntimeError,
921 "unable to get modification time from '%s'",
922 pathname);
Fred Drake4c82b232000-06-30 16:18:57 +0000923 return NULL;
Neal Norwitz708e51a2005-10-03 04:48:15 +0000924 }
Fred Drake4c82b232000-06-30 16:18:57 +0000925#if SIZEOF_TIME_T > 4
926 /* Python's .pyc timestamp handling presumes that the timestamp fits
927 in 4 bytes. This will be fine until sometime in the year 2038,
928 when a 4-byte signed time_t will overflow.
929 */
930 if (mtime >> 32) {
931 PyErr_SetString(PyExc_OverflowError,
Fred Drakec63d3e92001-03-01 06:33:32 +0000932 "modification time overflows a 4 byte field");
Fred Drake4c82b232000-06-30 16:18:57 +0000933 return NULL;
934 }
935#endif
Tim Peters36515e22001-11-18 04:06:29 +0000936 cpathname = make_compiled_pathname(pathname, buf,
Jeremy Hylton37832f02001-04-13 17:50:20 +0000937 (size_t)MAXPATHLEN + 1);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000938 if (cpathname != NULL &&
939 (fpc = check_compiled_module(pathname, mtime, cpathname))) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000940 co = read_compiled_module(cpathname, fpc);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000941 fclose(fpc);
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 # precompiled from %s\n",
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000946 name, cpathname);
Guido van Rossumafd3dae1998-08-25 18:44:34 +0000947 pathname = cpathname;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000948 }
949 else {
950 co = parse_source_module(pathname, fp);
951 if (co == NULL)
952 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000953 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000954 PySys_WriteStderr("import %s # from %s\n",
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000955 name, pathname);
Neal Norwitz3cb31ac2006-08-13 18:10:47 +0000956 if (cpathname)
957 write_compiled_module(co, cpathname, mtime);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000958 }
Guido van Rossumafd3dae1998-08-25 18:44:34 +0000959 m = PyImport_ExecCodeModuleEx(name, (PyObject *)co, pathname);
Guido van Rossum79f25d91997-04-29 20:08:16 +0000960 Py_DECREF(co);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000961
962 return m;
963}
964
965
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000966/* Forward */
Just van Rossum52e14d62002-12-30 22:08:05 +0000967static PyObject *load_module(char *, FILE *, char *, int, PyObject *);
968static struct filedescr *find_module(char *, char *, PyObject *,
969 char *, size_t, FILE **, PyObject **);
Tim Petersdbd9ba62000-07-09 03:09:57 +0000970static struct _frozen *find_frozen(char *name);
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000971
972/* Load a package and return its module object WITH INCREMENTED
973 REFERENCE COUNT */
974
975static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000976load_package(char *name, char *pathname)
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000977{
Tim Peters1cd70172004-08-02 03:52:12 +0000978 PyObject *m, *d;
979 PyObject *file = NULL;
980 PyObject *path = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000981 int err;
982 char buf[MAXPATHLEN+1];
983 FILE *fp = NULL;
984 struct filedescr *fdp;
985
986 m = PyImport_AddModule(name);
987 if (m == NULL)
988 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +0000989 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000990 PySys_WriteStderr("import %s # directory %s\n",
Guido van Rossum17fc85f1997-09-06 18:52:03 +0000991 name, pathname);
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000992 d = PyModule_GetDict(m);
993 file = PyString_FromString(pathname);
994 if (file == NULL)
Tim Peters1cd70172004-08-02 03:52:12 +0000995 goto error;
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000996 path = Py_BuildValue("[O]", file);
Tim Peters1cd70172004-08-02 03:52:12 +0000997 if (path == NULL)
998 goto error;
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000999 err = PyDict_SetItemString(d, "__file__", file);
1000 if (err == 0)
1001 err = PyDict_SetItemString(d, "__path__", path);
Tim Peters1cd70172004-08-02 03:52:12 +00001002 if (err != 0)
1003 goto error;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001004 buf[0] = '\0';
Just van Rossum52e14d62002-12-30 22:08:05 +00001005 fdp = find_module(name, "__init__", path, buf, sizeof(buf), &fp, NULL);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001006 if (fdp == NULL) {
1007 if (PyErr_ExceptionMatches(PyExc_ImportError)) {
1008 PyErr_Clear();
Thomas Heller25653242004-06-07 15:04:10 +00001009 Py_INCREF(m);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001010 }
1011 else
1012 m = NULL;
1013 goto cleanup;
1014 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001015 m = load_module(name, fp, buf, fdp->type, NULL);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001016 if (fp != NULL)
1017 fclose(fp);
Tim Peters1cd70172004-08-02 03:52:12 +00001018 goto cleanup;
1019
1020 error:
1021 m = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001022 cleanup:
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001023 Py_XDECREF(path);
1024 Py_XDECREF(file);
1025 return m;
1026}
1027
1028
1029/* Helper to test for built-in module */
1030
1031static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001032is_builtin(char *name)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001033{
1034 int i;
Guido van Rossum771c6c81997-10-31 18:37:24 +00001035 for (i = 0; PyImport_Inittab[i].name != NULL; i++) {
1036 if (strcmp(name, PyImport_Inittab[i].name) == 0) {
1037 if (PyImport_Inittab[i].initfunc == NULL)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001038 return -1;
1039 else
1040 return 1;
1041 }
1042 }
1043 return 0;
1044}
1045
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001046
Just van Rossum52e14d62002-12-30 22:08:05 +00001047/* Return an importer object for a sys.path/pkg.__path__ item 'p',
1048 possibly by fetching it from the path_importer_cache dict. If it
1049 wasn't yet cached, traverse path_hooks until it a hook is found
1050 that can handle the path item. Return None if no hook could;
1051 this tells our caller it should fall back to the builtin
1052 import mechanism. Cache the result in path_importer_cache.
1053 Returns a borrowed reference. */
1054
1055static PyObject *
1056get_path_importer(PyObject *path_importer_cache, PyObject *path_hooks,
1057 PyObject *p)
1058{
1059 PyObject *importer;
Martin v. Löwis725507b2006-03-07 12:08:51 +00001060 Py_ssize_t j, nhooks;
Just van Rossum52e14d62002-12-30 22:08:05 +00001061
1062 /* These conditions are the caller's responsibility: */
1063 assert(PyList_Check(path_hooks));
1064 assert(PyDict_Check(path_importer_cache));
1065
1066 nhooks = PyList_Size(path_hooks);
1067 if (nhooks < 0)
1068 return NULL; /* Shouldn't happen */
1069
1070 importer = PyDict_GetItem(path_importer_cache, p);
1071 if (importer != NULL)
1072 return importer;
1073
1074 /* set path_importer_cache[p] to None to avoid recursion */
1075 if (PyDict_SetItem(path_importer_cache, p, Py_None) != 0)
1076 return NULL;
1077
1078 for (j = 0; j < nhooks; j++) {
1079 PyObject *hook = PyList_GetItem(path_hooks, j);
1080 if (hook == NULL)
1081 return NULL;
Georg Brandl684fd0c2006-05-25 19:15:31 +00001082 importer = PyObject_CallFunctionObjArgs(hook, p, NULL);
Just van Rossum52e14d62002-12-30 22:08:05 +00001083 if (importer != NULL)
1084 break;
1085
1086 if (!PyErr_ExceptionMatches(PyExc_ImportError)) {
1087 return NULL;
1088 }
1089 PyErr_Clear();
1090 }
Phillip J. Ebyf7575d02006-07-28 21:12:07 +00001091 if (importer == NULL) {
1092 importer = PyObject_CallFunctionObjArgs(
1093 (PyObject *)&NullImporterType, p, NULL
1094 );
1095 if (importer == NULL) {
1096 if (PyErr_ExceptionMatches(PyExc_ImportError)) {
1097 PyErr_Clear();
1098 return Py_None;
1099 }
1100 }
1101 }
1102 if (importer != NULL) {
Just van Rossum52e14d62002-12-30 22:08:05 +00001103 int err = PyDict_SetItem(path_importer_cache, p, importer);
1104 Py_DECREF(importer);
1105 if (err != 0)
1106 return NULL;
1107 }
1108 return importer;
1109}
1110
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001111/* Search the path (default sys.path) for a module. Return the
1112 corresponding filedescr struct, and (via return arguments) the
1113 pathname and an open file. Return NULL if the module is not found. */
1114
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001115#ifdef MS_COREDLL
Thomas Woutersb4bd21c2000-07-22 23:38:01 +00001116extern FILE *PyWin_FindRegisteredModule(const char *, struct filedescr **,
Martin v. Löwis18e16552006-02-15 17:27:45 +00001117 char *, Py_ssize_t);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001118#endif
1119
Martin v. Löwis18e16552006-02-15 17:27:45 +00001120static int case_ok(char *, Py_ssize_t, Py_ssize_t, char *);
Tim Petersdbd9ba62000-07-09 03:09:57 +00001121static int find_init_module(char *); /* Forward */
Just van Rossum52e14d62002-12-30 22:08:05 +00001122static struct filedescr importhookdescr = {"", "", IMP_HOOK};
Guido van Rossum197346f1997-10-31 18:38:52 +00001123
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001124static struct filedescr *
Just van Rossum52e14d62002-12-30 22:08:05 +00001125find_module(char *fullname, char *subname, PyObject *path, char *buf,
1126 size_t buflen, FILE **p_fp, PyObject **p_loader)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001127{
Martin v. Löwis725507b2006-03-07 12:08:51 +00001128 Py_ssize_t i, npath;
Fred Drake4c82b232000-06-30 16:18:57 +00001129 size_t len, namelen;
Guido van Rossum80bb9651996-12-05 23:27:02 +00001130 struct filedescr *fdp = NULL;
Jack Jansenc88da1f2002-05-28 10:58:19 +00001131 char *filemode;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001132 FILE *fp = NULL;
Just van Rossum52e14d62002-12-30 22:08:05 +00001133 PyObject *path_hooks, *path_importer_cache;
Guido van Rossum48a680c2001-03-02 06:34:14 +00001134#ifndef RISCOS
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001135 struct stat statbuf;
Guido van Rossum48a680c2001-03-02 06:34:14 +00001136#endif
Guido van Rossuma5568d31998-03-05 03:45:08 +00001137 static struct filedescr fd_frozen = {"", "", PY_FROZEN};
1138 static struct filedescr fd_builtin = {"", "", C_BUILTIN};
1139 static struct filedescr fd_package = {"", "", PKG_DIRECTORY};
Guido van Rossum0506a431998-08-11 15:07:39 +00001140 char name[MAXPATHLEN+1];
Andrew MacIntyred9400542002-02-26 11:41:34 +00001141#if defined(PYOS_OS2)
1142 size_t saved_len;
1143 size_t saved_namelen;
1144 char *saved_buf = NULL;
1145#endif
Just van Rossum52e14d62002-12-30 22:08:05 +00001146 if (p_loader != NULL)
1147 *p_loader = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001148
Just van Rossum52e14d62002-12-30 22:08:05 +00001149 if (strlen(subname) > MAXPATHLEN) {
Guido van Rossum8f4d3312001-10-18 18:54:11 +00001150 PyErr_SetString(PyExc_OverflowError,
1151 "module name is too long");
Fred Drake4c82b232000-06-30 16:18:57 +00001152 return NULL;
1153 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001154 strcpy(name, subname);
1155
1156 /* sys.meta_path import hook */
1157 if (p_loader != NULL) {
1158 PyObject *meta_path;
1159
1160 meta_path = PySys_GetObject("meta_path");
1161 if (meta_path == NULL || !PyList_Check(meta_path)) {
1162 PyErr_SetString(PyExc_ImportError,
1163 "sys.meta_path must be a list of "
1164 "import hooks");
1165 return NULL;
1166 }
1167 Py_INCREF(meta_path); /* zap guard */
1168 npath = PyList_Size(meta_path);
1169 for (i = 0; i < npath; i++) {
1170 PyObject *loader;
1171 PyObject *hook = PyList_GetItem(meta_path, i);
1172 loader = PyObject_CallMethod(hook, "find_module",
1173 "sO", fullname,
1174 path != NULL ?
1175 path : Py_None);
1176 if (loader == NULL) {
1177 Py_DECREF(meta_path);
1178 return NULL; /* true error */
1179 }
1180 if (loader != Py_None) {
1181 /* a loader was found */
1182 *p_loader = loader;
1183 Py_DECREF(meta_path);
1184 return &importhookdescr;
1185 }
1186 Py_DECREF(loader);
1187 }
1188 Py_DECREF(meta_path);
1189 }
Guido van Rossum0506a431998-08-11 15:07:39 +00001190
1191 if (path != NULL && PyString_Check(path)) {
Guido van Rossum8f4d3312001-10-18 18:54:11 +00001192 /* The only type of submodule allowed inside a "frozen"
1193 package are other frozen modules or packages. */
Guido van Rossum0506a431998-08-11 15:07:39 +00001194 if (PyString_Size(path) + 1 + strlen(name) >= (size_t)buflen) {
1195 PyErr_SetString(PyExc_ImportError,
1196 "full frozen module name too long");
1197 return NULL;
1198 }
1199 strcpy(buf, PyString_AsString(path));
1200 strcat(buf, ".");
1201 strcat(buf, name);
1202 strcpy(name, buf);
Guido van Rossum8f4d3312001-10-18 18:54:11 +00001203 if (find_frozen(name) != NULL) {
1204 strcpy(buf, name);
1205 return &fd_frozen;
1206 }
1207 PyErr_Format(PyExc_ImportError,
1208 "No frozen submodule named %.200s", name);
1209 return NULL;
Guido van Rossum0506a431998-08-11 15:07:39 +00001210 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001211 if (path == NULL) {
1212 if (is_builtin(name)) {
Guido van Rossuma5568d31998-03-05 03:45:08 +00001213 strcpy(buf, name);
1214 return &fd_builtin;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001215 }
Greg Ward201baee2001-10-04 14:52:06 +00001216 if ((find_frozen(name)) != NULL) {
Guido van Rossuma5568d31998-03-05 03:45:08 +00001217 strcpy(buf, name);
1218 return &fd_frozen;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001219 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001220
Guido van Rossumac279101996-08-22 23:10:58 +00001221#ifdef MS_COREDLL
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001222 fp = PyWin_FindRegisteredModule(name, &fdp, buf, buflen);
1223 if (fp != NULL) {
1224 *p_fp = fp;
1225 return fdp;
1226 }
Guido van Rossuma5a3db71996-04-09 02:39:59 +00001227#endif
Guido van Rossuma5568d31998-03-05 03:45:08 +00001228 path = PySys_GetObject("path");
1229 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00001230 if (path == NULL || !PyList_Check(path)) {
1231 PyErr_SetString(PyExc_ImportError,
Guido van Rossuma5568d31998-03-05 03:45:08 +00001232 "sys.path must be a list of directory names");
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001233 return NULL;
1234 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001235
1236 path_hooks = PySys_GetObject("path_hooks");
1237 if (path_hooks == NULL || !PyList_Check(path_hooks)) {
1238 PyErr_SetString(PyExc_ImportError,
1239 "sys.path_hooks must be a list of "
1240 "import hooks");
1241 return NULL;
1242 }
1243 path_importer_cache = PySys_GetObject("path_importer_cache");
1244 if (path_importer_cache == NULL ||
1245 !PyDict_Check(path_importer_cache)) {
1246 PyErr_SetString(PyExc_ImportError,
1247 "sys.path_importer_cache must be a dict");
1248 return NULL;
1249 }
1250
Guido van Rossum79f25d91997-04-29 20:08:16 +00001251 npath = PyList_Size(path);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001252 namelen = strlen(name);
1253 for (i = 0; i < npath; i++) {
Walter Dörwald3430d702002-06-17 10:43:59 +00001254 PyObject *copy = NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +00001255 PyObject *v = PyList_GetItem(path, i);
Neal Norwitz3cb31ac2006-08-13 18:10:47 +00001256 if (!v)
1257 return NULL;
Walter Dörwald3430d702002-06-17 10:43:59 +00001258#ifdef Py_USING_UNICODE
1259 if (PyUnicode_Check(v)) {
1260 copy = PyUnicode_Encode(PyUnicode_AS_UNICODE(v),
1261 PyUnicode_GET_SIZE(v), Py_FileSystemDefaultEncoding, NULL);
1262 if (copy == NULL)
1263 return NULL;
1264 v = copy;
1265 }
1266 else
1267#endif
Guido van Rossum79f25d91997-04-29 20:08:16 +00001268 if (!PyString_Check(v))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001269 continue;
Neal Norwitz2aa9a5d2006-03-20 01:53:23 +00001270 len = PyString_GET_SIZE(v);
Walter Dörwald3430d702002-06-17 10:43:59 +00001271 if (len + 2 + namelen + MAXSUFFIXSIZE >= buflen) {
1272 Py_XDECREF(copy);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001273 continue; /* Too long */
Walter Dörwald3430d702002-06-17 10:43:59 +00001274 }
Neal Norwitz2aa9a5d2006-03-20 01:53:23 +00001275 strcpy(buf, PyString_AS_STRING(v));
Walter Dörwald3430d702002-06-17 10:43:59 +00001276 if (strlen(buf) != len) {
1277 Py_XDECREF(copy);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001278 continue; /* v contains '\0' */
Walter Dörwald3430d702002-06-17 10:43:59 +00001279 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001280
1281 /* sys.path_hooks import hook */
1282 if (p_loader != NULL) {
1283 PyObject *importer;
1284
1285 importer = get_path_importer(path_importer_cache,
1286 path_hooks, v);
Neal Norwitza4df11d2006-07-06 04:28:59 +00001287 if (importer == NULL) {
1288 Py_XDECREF(copy);
Just van Rossum52e14d62002-12-30 22:08:05 +00001289 return NULL;
Neal Norwitza4df11d2006-07-06 04:28:59 +00001290 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001291 /* Note: importer is a borrowed reference */
Phillip J. Ebyf7575d02006-07-28 21:12:07 +00001292 if (importer != Py_None) {
Just van Rossum52e14d62002-12-30 22:08:05 +00001293 PyObject *loader;
1294 loader = PyObject_CallMethod(importer,
1295 "find_module",
1296 "s", fullname);
Neal Norwitza4df11d2006-07-06 04:28:59 +00001297 Py_XDECREF(copy);
Just van Rossum52e14d62002-12-30 22:08:05 +00001298 if (loader == NULL)
1299 return NULL; /* error */
1300 if (loader != Py_None) {
1301 /* a loader was found */
1302 *p_loader = loader;
1303 return &importhookdescr;
1304 }
1305 Py_DECREF(loader);
Georg Brandlf4ef1162006-05-26 18:03:31 +00001306 continue;
Just van Rossum52e14d62002-12-30 22:08:05 +00001307 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001308 }
Georg Brandlf4ef1162006-05-26 18:03:31 +00001309 /* no hook was found, use builtin import */
Just van Rossum52e14d62002-12-30 22:08:05 +00001310
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001311 if (len > 0 && buf[len-1] != SEP
1312#ifdef ALTSEP
1313 && buf[len-1] != ALTSEP
1314#endif
1315 )
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001316 buf[len++] = SEP;
Guido van Rossum215c3402000-11-13 17:26:32 +00001317 strcpy(buf+len, name);
1318 len += namelen;
Tim Peters50d8d372001-02-28 05:34:27 +00001319
1320 /* Check for package import (buf holds a directory name,
1321 and there's an __init__ module in that directory */
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001322#ifdef HAVE_STAT
Walter Dörwald3430d702002-06-17 10:43:59 +00001323 if (stat(buf, &statbuf) == 0 && /* it exists */
1324 S_ISDIR(statbuf.st_mode) && /* it's a directory */
Thomas Wouters9df4e6f2006-04-27 23:13:20 +00001325 case_ok(buf, len, namelen, name)) { /* case matches */
1326 if (find_init_module(buf)) { /* and has __init__.py */
1327 Py_XDECREF(copy);
1328 return &fd_package;
1329 }
1330 else {
1331 char warnstr[MAXPATHLEN+80];
1332 sprintf(warnstr, "Not importing directory "
1333 "'%.*s': missing __init__.py",
1334 MAXPATHLEN, buf);
1335 if (PyErr_Warn(PyExc_ImportWarning,
1336 warnstr)) {
1337 Py_XDECREF(copy);
1338 return NULL;
1339 }
1340 }
Walter Dörwald3430d702002-06-17 10:43:59 +00001341 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001342#else
1343 /* XXX How are you going to test for directories? */
Guido van Rossum48a680c2001-03-02 06:34:14 +00001344#ifdef RISCOS
Guido van Rossume2ae77b2001-10-24 20:42:55 +00001345 if (isdir(buf) &&
Walter Dörwald3430d702002-06-17 10:43:59 +00001346 case_ok(buf, len, namelen, name)) {
Thomas Wouters9df4e6f2006-04-27 23:13:20 +00001347 if (find_init_module(buf)) {
1348 Py_XDECREF(copy);
1349 return &fd_package;
1350 }
1351 else {
1352 char warnstr[MAXPATHLEN+80];
1353 sprintf(warnstr, "Not importing directory "
1354 "'%.*s': missing __init__.py",
1355 MAXPATHLEN, buf);
1356 if (PyErr_Warn(PyExc_ImportWarning,
1357 warnstr)) {
1358 Py_XDECREF(copy);
1359 return NULL;
1360 }
Walter Dörwald3430d702002-06-17 10:43:59 +00001361 }
Guido van Rossum48a680c2001-03-02 06:34:14 +00001362#endif
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001363#endif
Andrew MacIntyred9400542002-02-26 11:41:34 +00001364#if defined(PYOS_OS2)
1365 /* take a snapshot of the module spec for restoration
1366 * after the 8 character DLL hackery
1367 */
1368 saved_buf = strdup(buf);
1369 saved_len = len;
1370 saved_namelen = namelen;
1371#endif /* PYOS_OS2 */
Guido van Rossum79f25d91997-04-29 20:08:16 +00001372 for (fdp = _PyImport_Filetab; fdp->suffix != NULL; fdp++) {
Georg Brandleec47f32007-08-23 18:08:33 +00001373#if defined(PYOS_OS2) && defined(HAVE_DYNAMIC_LOADING)
Jeremy Hylton4ae6fae2002-05-30 17:15:25 +00001374 /* OS/2 limits DLLs to 8 character names (w/o
1375 extension)
Andrew MacIntyred9400542002-02-26 11:41:34 +00001376 * so if the name is longer than that and its a
1377 * dynamically loaded module we're going to try,
1378 * truncate the name before trying
1379 */
Just van Rossum52e14d62002-12-30 22:08:05 +00001380 if (strlen(subname) > 8) {
Andrew MacIntyred9400542002-02-26 11:41:34 +00001381 /* is this an attempt to load a C extension? */
Jeremy Hylton4ae6fae2002-05-30 17:15:25 +00001382 const struct filedescr *scan;
1383 scan = _PyImport_DynLoadFiletab;
Andrew MacIntyred9400542002-02-26 11:41:34 +00001384 while (scan->suffix != NULL) {
Jeremy Hylton4ae6fae2002-05-30 17:15:25 +00001385 if (!strcmp(scan->suffix, fdp->suffix))
Andrew MacIntyred9400542002-02-26 11:41:34 +00001386 break;
1387 else
1388 scan++;
1389 }
1390 if (scan->suffix != NULL) {
1391 /* yes, so truncate the name */
1392 namelen = 8;
Just van Rossum52e14d62002-12-30 22:08:05 +00001393 len -= strlen(subname) - namelen;
Andrew MacIntyred9400542002-02-26 11:41:34 +00001394 buf[len] = '\0';
1395 }
1396 }
1397#endif /* PYOS_OS2 */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001398 strcpy(buf+len, fdp->suffix);
Guido van Rossum79f25d91997-04-29 20:08:16 +00001399 if (Py_VerboseFlag > 1)
Guido van Rossum2f3667a1998-10-12 18:23:55 +00001400 PySys_WriteStderr("# trying %s\n", buf);
Jack Jansenc88da1f2002-05-28 10:58:19 +00001401 filemode = fdp->mode;
Tim Peters86c7d2f2004-08-01 23:24:21 +00001402 if (filemode[0] == 'U')
Jeremy Hylton4ae6fae2002-05-30 17:15:25 +00001403 filemode = "r" PY_STDIOTEXTMODE;
Jack Jansenc88da1f2002-05-28 10:58:19 +00001404 fp = fopen(buf, filemode);
Tim Peters50d8d372001-02-28 05:34:27 +00001405 if (fp != NULL) {
1406 if (case_ok(buf, len, namelen, name))
1407 break;
1408 else { /* continue search */
1409 fclose(fp);
1410 fp = NULL;
Barry Warsaw914a0b12001-02-02 19:12:16 +00001411 }
Barry Warsaw914a0b12001-02-02 19:12:16 +00001412 }
Andrew MacIntyred9400542002-02-26 11:41:34 +00001413#if defined(PYOS_OS2)
1414 /* restore the saved snapshot */
1415 strcpy(buf, saved_buf);
1416 len = saved_len;
1417 namelen = saved_namelen;
1418#endif
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001419 }
Andrew MacIntyred9400542002-02-26 11:41:34 +00001420#if defined(PYOS_OS2)
1421 /* don't need/want the module name snapshot anymore */
1422 if (saved_buf)
1423 {
1424 free(saved_buf);
1425 saved_buf = NULL;
1426 }
1427#endif
Walter Dörwald3430d702002-06-17 10:43:59 +00001428 Py_XDECREF(copy);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001429 if (fp != NULL)
1430 break;
1431 }
1432 if (fp == NULL) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001433 PyErr_Format(PyExc_ImportError,
1434 "No module named %.200s", name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001435 return NULL;
1436 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001437 *p_fp = fp;
1438 return fdp;
1439}
1440
Raymond Hettingerdb29e0f2004-10-07 06:46:25 +00001441/* Helpers for main.c
1442 * Find the source file corresponding to a named module
1443 */
1444struct filedescr *
1445_PyImport_FindModule(const char *name, PyObject *path, char *buf,
1446 size_t buflen, FILE **p_fp, PyObject **p_loader)
1447{
1448 return find_module((char *) name, (char *) name, path,
1449 buf, buflen, p_fp, p_loader);
1450}
1451
1452PyAPI_FUNC(int) _PyImport_IsScript(struct filedescr * fd)
1453{
1454 return fd->type == PY_SOURCE || fd->type == PY_COMPILED;
1455}
1456
Martin v. Löwis18e16552006-02-15 17:27:45 +00001457/* case_ok(char* buf, Py_ssize_t len, Py_ssize_t namelen, char* name)
Tim Petersd1e87a82001-03-01 18:12:00 +00001458 * The arguments here are tricky, best shown by example:
1459 * /a/b/c/d/e/f/g/h/i/j/k/some_long_module_name.py\0
1460 * ^ ^ ^ ^
1461 * |--------------------- buf ---------------------|
1462 * |------------------- len ------------------|
1463 * |------ name -------|
1464 * |----- namelen -----|
1465 * buf is the full path, but len only counts up to (& exclusive of) the
1466 * extension. name is the module name, also exclusive of extension.
1467 *
1468 * We've already done a successful stat() or fopen() on buf, so know that
1469 * there's some match, possibly case-insensitive.
1470 *
Tim Peters50d8d372001-02-28 05:34:27 +00001471 * case_ok() is to return 1 if there's a case-sensitive match for
1472 * name, else 0. case_ok() is also to return 1 if envar PYTHONCASEOK
1473 * exists.
Tim Petersd1e87a82001-03-01 18:12:00 +00001474 *
Tim Peters50d8d372001-02-28 05:34:27 +00001475 * case_ok() is used to implement case-sensitive import semantics even
1476 * on platforms with case-insensitive filesystems. It's trivial to implement
1477 * for case-sensitive filesystems. It's pretty much a cross-platform
1478 * nightmare for systems with case-insensitive filesystems.
1479 */
Guido van Rossum0980bd91998-02-13 17:18:36 +00001480
Tim Peters50d8d372001-02-28 05:34:27 +00001481/* First we may need a pile of platform-specific header files; the sequence
1482 * of #if's here should match the sequence in the body of case_ok().
1483 */
Jason Tishler7961aa62005-05-20 00:56:54 +00001484#if defined(MS_WINDOWS)
Guido van Rossum0980bd91998-02-13 17:18:36 +00001485#include <windows.h>
Guido van Rossum4c3f57c2001-01-10 20:40:46 +00001486
Tim Peters50d8d372001-02-28 05:34:27 +00001487#elif defined(DJGPP)
1488#include <dir.h>
1489
Jason Tishler7961aa62005-05-20 00:56:54 +00001490#elif (defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) && defined(HAVE_DIRENT_H)
Tim Peters430f5d42001-03-01 01:30:56 +00001491#include <sys/types.h>
1492#include <dirent.h>
1493
Andrew MacIntyred9400542002-02-26 11:41:34 +00001494#elif defined(PYOS_OS2)
1495#define INCL_DOS
1496#define INCL_DOSERRORS
1497#define INCL_NOPMAPI
1498#include <os2.h>
1499
Guido van Rossume2ae77b2001-10-24 20:42:55 +00001500#elif defined(RISCOS)
1501#include "oslib/osfscontrol.h"
Tim Peters50d8d372001-02-28 05:34:27 +00001502#endif
1503
Guido van Rossum0980bd91998-02-13 17:18:36 +00001504static int
Martin v. Löwis18e16552006-02-15 17:27:45 +00001505case_ok(char *buf, Py_ssize_t len, Py_ssize_t namelen, char *name)
Guido van Rossum0980bd91998-02-13 17:18:36 +00001506{
Tim Peters50d8d372001-02-28 05:34:27 +00001507/* Pick a platform-specific implementation; the sequence of #if's here should
1508 * match the sequence just above.
1509 */
1510
Jason Tishler7961aa62005-05-20 00:56:54 +00001511/* MS_WINDOWS */
1512#if defined(MS_WINDOWS)
Guido van Rossum0980bd91998-02-13 17:18:36 +00001513 WIN32_FIND_DATA data;
1514 HANDLE h;
Tim Peters50d8d372001-02-28 05:34:27 +00001515
Neil Schemenauer7d4bb9f2001-07-23 16:30:27 +00001516 if (Py_GETENV("PYTHONCASEOK") != NULL)
Guido van Rossum0980bd91998-02-13 17:18:36 +00001517 return 1;
Tim Peters50d8d372001-02-28 05:34:27 +00001518
Guido van Rossum0980bd91998-02-13 17:18:36 +00001519 h = FindFirstFile(buf, &data);
1520 if (h == INVALID_HANDLE_VALUE) {
1521 PyErr_Format(PyExc_NameError,
1522 "Can't find file for module %.100s\n(filename %.300s)",
1523 name, buf);
1524 return 0;
1525 }
1526 FindClose(h);
Tim Peters50d8d372001-02-28 05:34:27 +00001527 return strncmp(data.cFileName, name, namelen) == 0;
1528
1529/* DJGPP */
1530#elif defined(DJGPP)
1531 struct ffblk ffblk;
1532 int done;
1533
Neil Schemenauer7d4bb9f2001-07-23 16:30:27 +00001534 if (Py_GETENV("PYTHONCASEOK") != NULL)
Guido van Rossum323bf5e1998-06-24 03:54:06 +00001535 return 1;
Tim Peters50d8d372001-02-28 05:34:27 +00001536
1537 done = findfirst(buf, &ffblk, FA_ARCH|FA_RDONLY|FA_HIDDEN|FA_DIREC);
1538 if (done) {
Guido van Rossum0980bd91998-02-13 17:18:36 +00001539 PyErr_Format(PyExc_NameError,
Tim Peters50d8d372001-02-28 05:34:27 +00001540 "Can't find file for module %.100s\n(filename %.300s)",
Guido van Rossum0980bd91998-02-13 17:18:36 +00001541 name, buf);
1542 return 0;
1543 }
Tim Peters50d8d372001-02-28 05:34:27 +00001544 return strncmp(ffblk.ff_name, name, namelen) == 0;
Guido van Rossum0980bd91998-02-13 17:18:36 +00001545
Jason Tishler7961aa62005-05-20 00:56:54 +00001546/* new-fangled macintosh (macosx) or Cygwin */
1547#elif (defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) && defined(HAVE_DIRENT_H)
Tim Peters430f5d42001-03-01 01:30:56 +00001548 DIR *dirp;
1549 struct dirent *dp;
Tim Petersd1e87a82001-03-01 18:12:00 +00001550 char dirname[MAXPATHLEN + 1];
1551 const int dirlen = len - namelen - 1; /* don't want trailing SEP */
Tim Peters430f5d42001-03-01 01:30:56 +00001552
Neil Schemenauer7d4bb9f2001-07-23 16:30:27 +00001553 if (Py_GETENV("PYTHONCASEOK") != NULL)
Tim Petersdbe6ebb2001-03-01 08:47:29 +00001554 return 1;
1555
Tim Petersd1e87a82001-03-01 18:12:00 +00001556 /* Copy the dir component into dirname; substitute "." if empty */
1557 if (dirlen <= 0) {
1558 dirname[0] = '.';
1559 dirname[1] = '\0';
Tim Peters430f5d42001-03-01 01:30:56 +00001560 }
1561 else {
Tim Petersd1e87a82001-03-01 18:12:00 +00001562 assert(dirlen <= MAXPATHLEN);
1563 memcpy(dirname, buf, dirlen);
1564 dirname[dirlen] = '\0';
Tim Peters430f5d42001-03-01 01:30:56 +00001565 }
1566 /* Open the directory and search the entries for an exact match. */
Tim Petersd1e87a82001-03-01 18:12:00 +00001567 dirp = opendir(dirname);
Tim Peters430f5d42001-03-01 01:30:56 +00001568 if (dirp) {
Tim Peters677898a2001-03-02 03:28:03 +00001569 char *nameWithExt = buf + len - namelen;
Tim Peters430f5d42001-03-01 01:30:56 +00001570 while ((dp = readdir(dirp)) != NULL) {
Tim Petersdbe6ebb2001-03-01 08:47:29 +00001571 const int thislen =
Tim Peters430f5d42001-03-01 01:30:56 +00001572#ifdef _DIRENT_HAVE_D_NAMELEN
Tim Petersdbe6ebb2001-03-01 08:47:29 +00001573 dp->d_namlen;
Tim Peters430f5d42001-03-01 01:30:56 +00001574#else
Tim Petersdbe6ebb2001-03-01 08:47:29 +00001575 strlen(dp->d_name);
Tim Peters430f5d42001-03-01 01:30:56 +00001576#endif
Tim Petersd1e87a82001-03-01 18:12:00 +00001577 if (thislen >= namelen &&
Tim Peters677898a2001-03-02 03:28:03 +00001578 strcmp(dp->d_name, nameWithExt) == 0) {
Tim Peters430f5d42001-03-01 01:30:56 +00001579 (void)closedir(dirp);
1580 return 1; /* Found */
1581 }
1582 }
Tim Petersdbe6ebb2001-03-01 08:47:29 +00001583 (void)closedir(dirp);
Tim Peters430f5d42001-03-01 01:30:56 +00001584 }
Tim Peters430f5d42001-03-01 01:30:56 +00001585 return 0 ; /* Not found */
Tim Peters430f5d42001-03-01 01:30:56 +00001586
Guido van Rossume2ae77b2001-10-24 20:42:55 +00001587/* RISC OS */
1588#elif defined(RISCOS)
1589 char canon[MAXPATHLEN+1]; /* buffer for the canonical form of the path */
1590 char buf2[MAXPATHLEN+2];
1591 char *nameWithExt = buf+len-namelen;
1592 int canonlen;
1593 os_error *e;
1594
1595 if (Py_GETENV("PYTHONCASEOK") != NULL)
1596 return 1;
1597
1598 /* workaround:
1599 append wildcard, otherwise case of filename wouldn't be touched */
1600 strcpy(buf2, buf);
1601 strcat(buf2, "*");
1602
1603 e = xosfscontrol_canonicalise_path(buf2,canon,0,0,MAXPATHLEN+1,&canonlen);
1604 canonlen = MAXPATHLEN+1-canonlen;
1605 if (e || canonlen<=0 || canonlen>(MAXPATHLEN+1) )
1606 return 0;
1607 if (strcmp(nameWithExt, canon+canonlen-strlen(nameWithExt))==0)
1608 return 1; /* match */
1609
1610 return 0;
1611
Andrew MacIntyred9400542002-02-26 11:41:34 +00001612/* OS/2 */
1613#elif defined(PYOS_OS2)
1614 HDIR hdir = 1;
1615 ULONG srchcnt = 1;
1616 FILEFINDBUF3 ffbuf;
1617 APIRET rc;
1618
1619 if (getenv("PYTHONCASEOK") != NULL)
1620 return 1;
1621
1622 rc = DosFindFirst(buf,
1623 &hdir,
1624 FILE_READONLY | FILE_HIDDEN | FILE_SYSTEM | FILE_DIRECTORY,
1625 &ffbuf, sizeof(ffbuf),
1626 &srchcnt,
1627 FIL_STANDARD);
1628 if (rc != NO_ERROR)
1629 return 0;
1630 return strncmp(ffbuf.achName, name, namelen) == 0;
1631
Tim Peters50d8d372001-02-28 05:34:27 +00001632/* assuming it's a case-sensitive filesystem, so there's nothing to do! */
1633#else
Guido van Rossum0980bd91998-02-13 17:18:36 +00001634 return 1;
Guido van Rossum0980bd91998-02-13 17:18:36 +00001635
Guido van Rossum4d1b3b91998-02-13 23:27:59 +00001636#endif
Tim Peters50d8d372001-02-28 05:34:27 +00001637}
Guido van Rossum4d1b3b91998-02-13 23:27:59 +00001638
Guido van Rossum0980bd91998-02-13 17:18:36 +00001639
Guido van Rossum197346f1997-10-31 18:38:52 +00001640#ifdef HAVE_STAT
1641/* Helper to look for __init__.py or __init__.py[co] in potential package */
1642static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001643find_init_module(char *buf)
Guido van Rossum197346f1997-10-31 18:38:52 +00001644{
Tim Peters0f9431f2001-07-05 03:47:53 +00001645 const size_t save_len = strlen(buf);
Fred Drake4c82b232000-06-30 16:18:57 +00001646 size_t i = save_len;
Tim Peters0f9431f2001-07-05 03:47:53 +00001647 char *pname; /* pointer to start of __init__ */
Guido van Rossum197346f1997-10-31 18:38:52 +00001648 struct stat statbuf;
1649
Tim Peters0f9431f2001-07-05 03:47:53 +00001650/* For calling case_ok(buf, len, namelen, name):
1651 * /a/b/c/d/e/f/g/h/i/j/k/some_long_module_name.py\0
1652 * ^ ^ ^ ^
1653 * |--------------------- buf ---------------------|
1654 * |------------------- len ------------------|
1655 * |------ name -------|
1656 * |----- namelen -----|
1657 */
Guido van Rossum197346f1997-10-31 18:38:52 +00001658 if (save_len + 13 >= MAXPATHLEN)
1659 return 0;
1660 buf[i++] = SEP;
Tim Peters0f9431f2001-07-05 03:47:53 +00001661 pname = buf + i;
1662 strcpy(pname, "__init__.py");
Guido van Rossum197346f1997-10-31 18:38:52 +00001663 if (stat(buf, &statbuf) == 0) {
Tim Peters0f9431f2001-07-05 03:47:53 +00001664 if (case_ok(buf,
1665 save_len + 9, /* len("/__init__") */
1666 8, /* len("__init__") */
1667 pname)) {
1668 buf[save_len] = '\0';
1669 return 1;
1670 }
Guido van Rossum197346f1997-10-31 18:38:52 +00001671 }
Tim Peters0f9431f2001-07-05 03:47:53 +00001672 i += strlen(pname);
1673 strcpy(buf+i, Py_OptimizeFlag ? "o" : "c");
Guido van Rossum197346f1997-10-31 18:38:52 +00001674 if (stat(buf, &statbuf) == 0) {
Tim Peters0f9431f2001-07-05 03:47:53 +00001675 if (case_ok(buf,
1676 save_len + 9, /* len("/__init__") */
1677 8, /* len("__init__") */
1678 pname)) {
1679 buf[save_len] = '\0';
1680 return 1;
1681 }
Guido van Rossum197346f1997-10-31 18:38:52 +00001682 }
1683 buf[save_len] = '\0';
1684 return 0;
1685}
Guido van Rossum48a680c2001-03-02 06:34:14 +00001686
1687#else
1688
1689#ifdef RISCOS
1690static int
1691find_init_module(buf)
1692 char *buf;
1693{
1694 int save_len = strlen(buf);
1695 int i = save_len;
1696
1697 if (save_len + 13 >= MAXPATHLEN)
1698 return 0;
1699 buf[i++] = SEP;
1700 strcpy(buf+i, "__init__/py");
1701 if (isfile(buf)) {
1702 buf[save_len] = '\0';
1703 return 1;
1704 }
1705
1706 if (Py_OptimizeFlag)
1707 strcpy(buf+i, "o");
1708 else
1709 strcpy(buf+i, "c");
1710 if (isfile(buf)) {
1711 buf[save_len] = '\0';
1712 return 1;
1713 }
1714 buf[save_len] = '\0';
1715 return 0;
1716}
1717#endif /*RISCOS*/
1718
Guido van Rossum197346f1997-10-31 18:38:52 +00001719#endif /* HAVE_STAT */
1720
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001721
Tim Petersdbd9ba62000-07-09 03:09:57 +00001722static int init_builtin(char *); /* Forward */
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001723
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001724/* Load an external module using the default search path and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001725 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001726
Guido van Rossum79f25d91997-04-29 20:08:16 +00001727static PyObject *
Just van Rossum52e14d62002-12-30 22:08:05 +00001728load_module(char *name, FILE *fp, char *buf, int type, PyObject *loader)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001729{
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001730 PyObject *modules;
Guido van Rossum79f25d91997-04-29 20:08:16 +00001731 PyObject *m;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001732 int err;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001733
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001734 /* First check that there's an open file (if we need one) */
1735 switch (type) {
1736 case PY_SOURCE:
1737 case PY_COMPILED:
1738 if (fp == NULL) {
1739 PyErr_Format(PyExc_ValueError,
1740 "file object required for import (type code %d)",
1741 type);
1742 return NULL;
1743 }
1744 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001745
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001746 switch (type) {
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001747
1748 case PY_SOURCE:
1749 m = load_source_module(name, buf, fp);
1750 break;
1751
1752 case PY_COMPILED:
1753 m = load_compiled_module(name, buf, fp);
1754 break;
1755
Guido van Rossum96a8fb71999-12-22 14:09:35 +00001756#ifdef HAVE_DYNAMIC_LOADING
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001757 case C_EXTENSION:
Guido van Rossum79f25d91997-04-29 20:08:16 +00001758 m = _PyImport_LoadDynamicModule(name, buf, fp);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001759 break;
Guido van Rossum96a8fb71999-12-22 14:09:35 +00001760#endif
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001761
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001762 case PKG_DIRECTORY:
1763 m = load_package(name, buf);
1764 break;
1765
1766 case C_BUILTIN:
1767 case PY_FROZEN:
Guido van Rossuma5568d31998-03-05 03:45:08 +00001768 if (buf != NULL && buf[0] != '\0')
1769 name = buf;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001770 if (type == C_BUILTIN)
1771 err = init_builtin(name);
1772 else
1773 err = PyImport_ImportFrozenModule(name);
1774 if (err < 0)
Guido van Rossuma86f77d1997-09-09 18:53:47 +00001775 return NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001776 if (err == 0) {
1777 PyErr_Format(PyExc_ImportError,
1778 "Purported %s module %.200s not found",
1779 type == C_BUILTIN ?
1780 "builtin" : "frozen",
1781 name);
Guido van Rossuma86f77d1997-09-09 18:53:47 +00001782 return NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001783 }
1784 modules = PyImport_GetModuleDict();
1785 m = PyDict_GetItemString(modules, name);
1786 if (m == NULL) {
1787 PyErr_Format(
1788 PyExc_ImportError,
1789 "%s module %.200s not properly initialized",
1790 type == C_BUILTIN ?
1791 "builtin" : "frozen",
1792 name);
Guido van Rossuma86f77d1997-09-09 18:53:47 +00001793 return NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001794 }
1795 Py_INCREF(m);
1796 break;
1797
Just van Rossum52e14d62002-12-30 22:08:05 +00001798 case IMP_HOOK: {
1799 if (loader == NULL) {
1800 PyErr_SetString(PyExc_ImportError,
1801 "import hook without loader");
1802 return NULL;
1803 }
1804 m = PyObject_CallMethod(loader, "load_module", "s", name);
1805 break;
1806 }
1807
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001808 default:
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001809 PyErr_Format(PyExc_ImportError,
1810 "Don't know how to import %.200s (type code %d)",
1811 name, type);
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001812 m = NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001813
1814 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001815
1816 return m;
1817}
1818
1819
1820/* Initialize a built-in module.
1821 Return 1 for succes, 0 if the module is not found, and -1 with
1822 an exception set if the initialization failed. */
Guido van Rossum7f133ed1991-02-19 12:23:57 +00001823
Guido van Rossum7f133ed1991-02-19 12:23:57 +00001824static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001825init_builtin(char *name)
Guido van Rossum7f133ed1991-02-19 12:23:57 +00001826{
Guido van Rossum25ce5661997-08-02 03:10:38 +00001827 struct _inittab *p;
Guido van Rossum25ce5661997-08-02 03:10:38 +00001828
Greg Ward201baee2001-10-04 14:52:06 +00001829 if (_PyImport_FindExtension(name, name) != NULL)
Guido van Rossum25ce5661997-08-02 03:10:38 +00001830 return 1;
1831
Guido van Rossum771c6c81997-10-31 18:37:24 +00001832 for (p = PyImport_Inittab; p->name != NULL; p++) {
Guido van Rossum25ce5661997-08-02 03:10:38 +00001833 if (strcmp(name, p->name) == 0) {
1834 if (p->initfunc == NULL) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001835 PyErr_Format(PyExc_ImportError,
1836 "Cannot re-init internal module %.200s",
1837 name);
Guido van Rossum74e6a111994-08-29 12:54:38 +00001838 return -1;
1839 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00001840 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +00001841 PySys_WriteStderr("import %s # builtin\n", name);
Guido van Rossum25ce5661997-08-02 03:10:38 +00001842 (*p->initfunc)();
Guido van Rossum79f25d91997-04-29 20:08:16 +00001843 if (PyErr_Occurred())
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001844 return -1;
Guido van Rossum25ce5661997-08-02 03:10:38 +00001845 if (_PyImport_FixupExtension(name, name) == NULL)
1846 return -1;
Guido van Rossum7f133ed1991-02-19 12:23:57 +00001847 return 1;
1848 }
1849 }
1850 return 0;
1851}
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001852
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001853
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001854/* Frozen modules */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001855
Guido van Rossumcfd0a221996-06-17 17:06:34 +00001856static struct _frozen *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001857find_frozen(char *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001858{
Guido van Rossumcfd0a221996-06-17 17:06:34 +00001859 struct _frozen *p;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001860
Guido van Rossum79f25d91997-04-29 20:08:16 +00001861 for (p = PyImport_FrozenModules; ; p++) {
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001862 if (p->name == NULL)
1863 return NULL;
1864 if (strcmp(p->name, name) == 0)
1865 break;
1866 }
1867 return p;
1868}
1869
Guido van Rossum79f25d91997-04-29 20:08:16 +00001870static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001871get_frozen_object(char *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001872{
Guido van Rossumcfd0a221996-06-17 17:06:34 +00001873 struct _frozen *p = find_frozen(name);
Guido van Rossuma5568d31998-03-05 03:45:08 +00001874 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001875
1876 if (p == NULL) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001877 PyErr_Format(PyExc_ImportError,
1878 "No such frozen object named %.200s",
1879 name);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001880 return NULL;
1881 }
Guido van Rossum8f4d3312001-10-18 18:54:11 +00001882 if (p->code == NULL) {
1883 PyErr_Format(PyExc_ImportError,
1884 "Excluded frozen object named %.200s",
1885 name);
1886 return NULL;
1887 }
Guido van Rossuma5568d31998-03-05 03:45:08 +00001888 size = p->size;
1889 if (size < 0)
1890 size = -size;
1891 return PyMarshal_ReadObjectFromString((char *)p->code, size);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001892}
1893
1894/* Initialize a frozen module.
1895 Return 1 for succes, 0 if the module is not found, and -1 with
1896 an exception set if the initialization failed.
1897 This function is also used from frozenmain.c */
Guido van Rossum0b344901995-02-07 15:35:27 +00001898
1899int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001900PyImport_ImportFrozenModule(char *name)
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001901{
Guido van Rossumcfd0a221996-06-17 17:06:34 +00001902 struct _frozen *p = find_frozen(name);
Guido van Rossum79f25d91997-04-29 20:08:16 +00001903 PyObject *co;
1904 PyObject *m;
Guido van Rossuma5568d31998-03-05 03:45:08 +00001905 int ispackage;
1906 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001907
1908 if (p == NULL)
1909 return 0;
Guido van Rossum8f4d3312001-10-18 18:54:11 +00001910 if (p->code == NULL) {
1911 PyErr_Format(PyExc_ImportError,
1912 "Excluded frozen object named %.200s",
1913 name);
1914 return -1;
1915 }
Guido van Rossuma5568d31998-03-05 03:45:08 +00001916 size = p->size;
1917 ispackage = (size < 0);
1918 if (ispackage)
1919 size = -size;
Guido van Rossum79f25d91997-04-29 20:08:16 +00001920 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +00001921 PySys_WriteStderr("import %s # frozen%s\n",
Guido van Rossuma5568d31998-03-05 03:45:08 +00001922 name, ispackage ? " package" : "");
1923 co = PyMarshal_ReadObjectFromString((char *)p->code, size);
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001924 if (co == NULL)
1925 return -1;
Guido van Rossum79f25d91997-04-29 20:08:16 +00001926 if (!PyCode_Check(co)) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001927 PyErr_Format(PyExc_TypeError,
1928 "frozen object %.200s is not a code object",
1929 name);
Neal Norwitzc0cde4d2006-07-16 02:17:36 +00001930 goto err_return;
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001931 }
Guido van Rossuma5568d31998-03-05 03:45:08 +00001932 if (ispackage) {
1933 /* Set __path__ to the package name */
1934 PyObject *d, *s;
1935 int err;
1936 m = PyImport_AddModule(name);
1937 if (m == NULL)
Neal Norwitzc0cde4d2006-07-16 02:17:36 +00001938 goto err_return;
Guido van Rossuma5568d31998-03-05 03:45:08 +00001939 d = PyModule_GetDict(m);
1940 s = PyString_InternFromString(name);
1941 if (s == NULL)
Neal Norwitzc0cde4d2006-07-16 02:17:36 +00001942 goto err_return;
Guido van Rossuma5568d31998-03-05 03:45:08 +00001943 err = PyDict_SetItemString(d, "__path__", s);
1944 Py_DECREF(s);
1945 if (err != 0)
Neal Norwitzc0cde4d2006-07-16 02:17:36 +00001946 goto err_return;
Guido van Rossuma5568d31998-03-05 03:45:08 +00001947 }
Guido van Rossume32bf6e1998-02-11 05:53:02 +00001948 m = PyImport_ExecCodeModuleEx(name, co, "<frozen>");
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001949 if (m == NULL)
Neal Norwitzc0cde4d2006-07-16 02:17:36 +00001950 goto err_return;
1951 Py_DECREF(co);
Guido van Rossum79f25d91997-04-29 20:08:16 +00001952 Py_DECREF(m);
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001953 return 1;
Neal Norwitzc0cde4d2006-07-16 02:17:36 +00001954err_return:
1955 Py_DECREF(co);
1956 return -1;
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001957}
Guido van Rossum74e6a111994-08-29 12:54:38 +00001958
1959
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001960/* Import a module, either built-in, frozen, or external, and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001961 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum74e6a111994-08-29 12:54:38 +00001962
Guido van Rossum79f25d91997-04-29 20:08:16 +00001963PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001964PyImport_ImportModule(const char *name)
Guido van Rossum74e6a111994-08-29 12:54:38 +00001965{
Marc-André Lemburg3c61c352001-02-09 19:40:15 +00001966 PyObject *pname;
1967 PyObject *result;
1968
1969 pname = PyString_FromString(name);
Neal Norwitza11e4c12003-03-23 14:31:01 +00001970 if (pname == NULL)
1971 return NULL;
Marc-André Lemburg3c61c352001-02-09 19:40:15 +00001972 result = PyImport_Import(pname);
1973 Py_DECREF(pname);
1974 return result;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001975}
1976
Guido van Rossum17fc85f1997-09-06 18:52:03 +00001977/* Forward declarations for helper routines */
Thomas Woutersf7f438b2006-02-28 16:09:29 +00001978static PyObject *get_parent(PyObject *globals, char *buf,
1979 Py_ssize_t *p_buflen, int level);
Tim Petersdbd9ba62000-07-09 03:09:57 +00001980static PyObject *load_next(PyObject *mod, PyObject *altmod,
Martin v. Löwis18e16552006-02-15 17:27:45 +00001981 char **p_name, char *buf, Py_ssize_t *p_buflen);
Tim Petersdbd9ba62000-07-09 03:09:57 +00001982static int mark_miss(char *name);
1983static int ensure_fromlist(PyObject *mod, PyObject *fromlist,
Martin v. Löwis18e16552006-02-15 17:27:45 +00001984 char *buf, Py_ssize_t buflen, int recursive);
Tim Petersdbd9ba62000-07-09 03:09:57 +00001985static PyObject * import_submodule(PyObject *mod, char *name, char *fullname);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00001986
1987/* The Magnum Opus of dotted-name import :-) */
1988
Guido van Rossum75acc9c1998-03-03 22:26:50 +00001989static PyObject *
Thomas Woutersf7f438b2006-02-28 16:09:29 +00001990import_module_level(char *name, PyObject *globals, PyObject *locals,
1991 PyObject *fromlist, int level)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001992{
Guido van Rossum17fc85f1997-09-06 18:52:03 +00001993 char buf[MAXPATHLEN+1];
Martin v. Löwis18e16552006-02-15 17:27:45 +00001994 Py_ssize_t buflen = 0;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00001995 PyObject *parent, *head, *next, *tail;
1996
Thomas Woutersf7f438b2006-02-28 16:09:29 +00001997 parent = get_parent(globals, buf, &buflen, level);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00001998 if (parent == NULL)
1999 return NULL;
2000
2001 head = load_next(parent, Py_None, &name, buf, &buflen);
2002 if (head == NULL)
2003 return NULL;
2004
2005 tail = head;
2006 Py_INCREF(tail);
2007 while (name) {
2008 next = load_next(tail, tail, &name, buf, &buflen);
2009 Py_DECREF(tail);
2010 if (next == NULL) {
2011 Py_DECREF(head);
2012 return NULL;
2013 }
2014 tail = next;
2015 }
Thomas Wouters8ddab272006-04-04 16:17:02 +00002016 if (tail == Py_None) {
2017 /* If tail is Py_None, both get_parent and load_next found
2018 an empty module name: someone called __import__("") or
2019 doctored faulty bytecode */
Thomas Wouters4bdaa272006-04-05 13:39:37 +00002020 Py_DECREF(tail);
2021 Py_DECREF(head);
Thomas Wouters8ddab272006-04-04 16:17:02 +00002022 PyErr_SetString(PyExc_ValueError,
2023 "Empty module name");
2024 return NULL;
2025 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002026
2027 if (fromlist != NULL) {
2028 if (fromlist == Py_None || !PyObject_IsTrue(fromlist))
2029 fromlist = NULL;
2030 }
2031
2032 if (fromlist == NULL) {
2033 Py_DECREF(tail);
2034 return head;
2035 }
2036
2037 Py_DECREF(head);
Guido van Rossum9905ef91997-09-08 16:07:11 +00002038 if (!ensure_fromlist(tail, fromlist, buf, buflen, 0)) {
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002039 Py_DECREF(tail);
2040 return NULL;
2041 }
2042
2043 return tail;
2044}
2045
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002046/* For DLL compatibility */
2047#undef PyImport_ImportModuleEx
Guido van Rossum75acc9c1998-03-03 22:26:50 +00002048PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002049PyImport_ImportModuleEx(char *name, PyObject *globals, PyObject *locals,
2050 PyObject *fromlist)
Guido van Rossum75acc9c1998-03-03 22:26:50 +00002051{
2052 PyObject *result;
2053 lock_import();
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002054 result = import_module_level(name, globals, locals, fromlist, -1);
2055 if (unlock_import() < 0) {
2056 Py_XDECREF(result);
2057 PyErr_SetString(PyExc_RuntimeError,
2058 "not holding the import lock");
2059 return NULL;
2060 }
2061 return result;
2062}
2063#define PyImport_ImportModuleEx(n, g, l, f) \
2064 PyImport_ImportModuleLevel(n, g, l, f, -1);
2065
2066PyObject *
2067PyImport_ImportModuleLevel(char *name, PyObject *globals, PyObject *locals,
2068 PyObject *fromlist, int level)
2069{
2070 PyObject *result;
2071 lock_import();
2072 result = import_module_level(name, globals, locals, fromlist, level);
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00002073 if (unlock_import() < 0) {
2074 Py_XDECREF(result);
2075 PyErr_SetString(PyExc_RuntimeError,
2076 "not holding the import lock");
2077 return NULL;
2078 }
Guido van Rossum75acc9c1998-03-03 22:26:50 +00002079 return result;
2080}
2081
Fred Drake87590902004-05-28 20:21:36 +00002082/* Return the package that an import is being performed in. If globals comes
2083 from the module foo.bar.bat (not itself a package), this returns the
2084 sys.modules entry for foo.bar. If globals is from a package's __init__.py,
Georg Brandl5f6861d2006-05-28 21:57:35 +00002085 the package's entry in sys.modules is returned, as a borrowed reference.
Fred Drake87590902004-05-28 20:21:36 +00002086
2087 The *name* of the returned package is returned in buf, with the length of
2088 the name in *p_buflen.
2089
2090 If globals doesn't come from a package or a module in a package, or a
2091 corresponding entry is not found in sys.modules, Py_None is returned.
2092*/
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002093static PyObject *
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002094get_parent(PyObject *globals, char *buf, Py_ssize_t *p_buflen, int level)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002095{
2096 static PyObject *namestr = NULL;
2097 static PyObject *pathstr = NULL;
2098 PyObject *modname, *modpath, *modules, *parent;
2099
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002100 if (globals == NULL || !PyDict_Check(globals) || !level)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002101 return Py_None;
2102
2103 if (namestr == NULL) {
2104 namestr = PyString_InternFromString("__name__");
2105 if (namestr == NULL)
2106 return NULL;
2107 }
2108 if (pathstr == NULL) {
2109 pathstr = PyString_InternFromString("__path__");
2110 if (pathstr == NULL)
2111 return NULL;
2112 }
2113
2114 *buf = '\0';
2115 *p_buflen = 0;
2116 modname = PyDict_GetItem(globals, namestr);
2117 if (modname == NULL || !PyString_Check(modname))
2118 return Py_None;
2119
2120 modpath = PyDict_GetItem(globals, pathstr);
2121 if (modpath != NULL) {
Martin v. Löwis725507b2006-03-07 12:08:51 +00002122 Py_ssize_t len = PyString_GET_SIZE(modname);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002123 if (len > MAXPATHLEN) {
2124 PyErr_SetString(PyExc_ValueError,
2125 "Module name too long");
2126 return NULL;
2127 }
2128 strcpy(buf, PyString_AS_STRING(modname));
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002129 }
2130 else {
2131 char *start = PyString_AS_STRING(modname);
2132 char *lastdot = strrchr(start, '.');
Fred Drake4c82b232000-06-30 16:18:57 +00002133 size_t len;
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002134 if (lastdot == NULL && level > 0) {
2135 PyErr_SetString(PyExc_ValueError,
Georg Brandl37a9e572006-09-06 06:09:34 +00002136 "Attempted relative import in non-package");
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002137 return NULL;
2138 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002139 if (lastdot == NULL)
2140 return Py_None;
2141 len = lastdot - start;
2142 if (len >= MAXPATHLEN) {
2143 PyErr_SetString(PyExc_ValueError,
2144 "Module name too long");
2145 return NULL;
2146 }
2147 strncpy(buf, start, len);
2148 buf[len] = '\0';
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002149 }
2150
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002151 while (--level > 0) {
2152 char *dot = strrchr(buf, '.');
2153 if (dot == NULL) {
2154 PyErr_SetString(PyExc_ValueError,
Georg Brandl37a9e572006-09-06 06:09:34 +00002155 "Attempted relative import beyond "
2156 "toplevel package");
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002157 return NULL;
2158 }
2159 *dot = '\0';
2160 }
2161 *p_buflen = strlen(buf);
2162
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002163 modules = PyImport_GetModuleDict();
2164 parent = PyDict_GetItemString(modules, buf);
2165 if (parent == NULL)
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002166 PyErr_Format(PyExc_SystemError,
2167 "Parent module '%.200s' not loaded", buf);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002168 return parent;
2169 /* We expect, but can't guarantee, if parent != None, that:
2170 - parent.__name__ == buf
2171 - parent.__dict__ is globals
2172 If this is violated... Who cares? */
2173}
2174
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002175/* altmod is either None or same as mod */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002176static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002177load_next(PyObject *mod, PyObject *altmod, char **p_name, char *buf,
Martin v. Löwis18e16552006-02-15 17:27:45 +00002178 Py_ssize_t *p_buflen)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002179{
2180 char *name = *p_name;
2181 char *dot = strchr(name, '.');
Fred Drake4c82b232000-06-30 16:18:57 +00002182 size_t len;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002183 char *p;
2184 PyObject *result;
2185
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002186 if (strlen(name) == 0) {
Thomas Wouters8ddab272006-04-04 16:17:02 +00002187 /* completely empty module name should only happen in
2188 'from . import' (or '__import__("")')*/
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002189 Py_INCREF(mod);
2190 *p_name = NULL;
2191 return mod;
2192 }
2193
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002194 if (dot == NULL) {
2195 *p_name = NULL;
2196 len = strlen(name);
2197 }
2198 else {
2199 *p_name = dot+1;
2200 len = dot-name;
2201 }
Guido van Rossum111c20b1998-04-11 17:38:22 +00002202 if (len == 0) {
2203 PyErr_SetString(PyExc_ValueError,
2204 "Empty module name");
2205 return NULL;
2206 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002207
2208 p = buf + *p_buflen;
2209 if (p != buf)
2210 *p++ = '.';
2211 if (p+len-buf >= MAXPATHLEN) {
2212 PyErr_SetString(PyExc_ValueError,
2213 "Module name too long");
2214 return NULL;
2215 }
2216 strncpy(p, name, len);
2217 p[len] = '\0';
2218 *p_buflen = p+len-buf;
2219
2220 result = import_submodule(mod, p, buf);
2221 if (result == Py_None && altmod != mod) {
2222 Py_DECREF(result);
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00002223 /* Here, altmod must be None and mod must not be None */
Guido van Rossum0c819451997-09-07 06:16:57 +00002224 result = import_submodule(altmod, p, p);
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00002225 if (result != NULL && result != Py_None) {
2226 if (mark_miss(buf) != 0) {
2227 Py_DECREF(result);
2228 return NULL;
2229 }
2230 strncpy(buf, name, len);
2231 buf[len] = '\0';
2232 *p_buflen = len;
2233 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002234 }
2235 if (result == NULL)
2236 return NULL;
2237
2238 if (result == Py_None) {
2239 Py_DECREF(result);
2240 PyErr_Format(PyExc_ImportError,
2241 "No module named %.200s", name);
2242 return NULL;
2243 }
2244
2245 return result;
2246}
2247
2248static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002249mark_miss(char *name)
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00002250{
2251 PyObject *modules = PyImport_GetModuleDict();
2252 return PyDict_SetItemString(modules, name, Py_None);
2253}
2254
2255static int
Martin v. Löwis18e16552006-02-15 17:27:45 +00002256ensure_fromlist(PyObject *mod, PyObject *fromlist, char *buf, Py_ssize_t buflen,
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002257 int recursive)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002258{
2259 int i;
2260
2261 if (!PyObject_HasAttrString(mod, "__path__"))
2262 return 1;
2263
2264 for (i = 0; ; i++) {
2265 PyObject *item = PySequence_GetItem(fromlist, i);
2266 int hasit;
2267 if (item == NULL) {
2268 if (PyErr_ExceptionMatches(PyExc_IndexError)) {
2269 PyErr_Clear();
2270 return 1;
2271 }
2272 return 0;
2273 }
2274 if (!PyString_Check(item)) {
2275 PyErr_SetString(PyExc_TypeError,
2276 "Item in ``from list'' not a string");
2277 Py_DECREF(item);
2278 return 0;
2279 }
2280 if (PyString_AS_STRING(item)[0] == '*') {
Guido van Rossum9905ef91997-09-08 16:07:11 +00002281 PyObject *all;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002282 Py_DECREF(item);
Guido van Rossum9905ef91997-09-08 16:07:11 +00002283 /* See if the package defines __all__ */
2284 if (recursive)
2285 continue; /* Avoid endless recursion */
2286 all = PyObject_GetAttrString(mod, "__all__");
2287 if (all == NULL)
2288 PyErr_Clear();
2289 else {
Martin v. Löwis83969ee2004-03-23 16:28:13 +00002290 int ret = ensure_fromlist(mod, all, buf, buflen, 1);
Guido van Rossum9905ef91997-09-08 16:07:11 +00002291 Py_DECREF(all);
Martin v. Löwis83969ee2004-03-23 16:28:13 +00002292 if (!ret)
2293 return 0;
Guido van Rossum9905ef91997-09-08 16:07:11 +00002294 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002295 continue;
2296 }
2297 hasit = PyObject_HasAttr(mod, item);
2298 if (!hasit) {
2299 char *subname = PyString_AS_STRING(item);
2300 PyObject *submod;
2301 char *p;
2302 if (buflen + strlen(subname) >= MAXPATHLEN) {
2303 PyErr_SetString(PyExc_ValueError,
2304 "Module name too long");
2305 Py_DECREF(item);
2306 return 0;
2307 }
2308 p = buf + buflen;
2309 *p++ = '.';
2310 strcpy(p, subname);
2311 submod = import_submodule(mod, subname, buf);
2312 Py_XDECREF(submod);
2313 if (submod == NULL) {
2314 Py_DECREF(item);
2315 return 0;
2316 }
2317 }
2318 Py_DECREF(item);
2319 }
2320
Guido van Rossuma7f2e811997-10-03 15:33:32 +00002321 /* NOTREACHED */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002322}
2323
Neil Schemenauer00b09662003-06-16 21:03:07 +00002324static int
2325add_submodule(PyObject *mod, PyObject *submod, char *fullname, char *subname,
2326 PyObject *modules)
2327{
2328 if (mod == Py_None)
2329 return 1;
2330 /* Irrespective of the success of this load, make a
2331 reference to it in the parent package module. A copy gets
2332 saved in the modules dictionary under the full name, so get a
2333 reference from there, if need be. (The exception is when the
2334 load failed with a SyntaxError -- then there's no trace in
2335 sys.modules. In that case, of course, do nothing extra.) */
2336 if (submod == NULL) {
2337 submod = PyDict_GetItemString(modules, fullname);
2338 if (submod == NULL)
2339 return 1;
2340 }
2341 if (PyModule_Check(mod)) {
2342 /* We can't use setattr here since it can give a
2343 * spurious warning if the submodule name shadows a
2344 * builtin name */
2345 PyObject *dict = PyModule_GetDict(mod);
2346 if (!dict)
2347 return 0;
2348 if (PyDict_SetItemString(dict, subname, submod) < 0)
2349 return 0;
2350 }
2351 else {
2352 if (PyObject_SetAttrString(mod, subname, submod) < 0)
2353 return 0;
2354 }
2355 return 1;
2356}
2357
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002358static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002359import_submodule(PyObject *mod, char *subname, char *fullname)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002360{
Guido van Rossum25ce5661997-08-02 03:10:38 +00002361 PyObject *modules = PyImport_GetModuleDict();
Neil Schemenauer00b09662003-06-16 21:03:07 +00002362 PyObject *m = NULL;
Guido van Rossum74e6a111994-08-29 12:54:38 +00002363
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002364 /* Require:
2365 if mod == None: subname == fullname
2366 else: mod.__name__ + "." + subname == fullname
2367 */
2368
Tim Peters50d8d372001-02-28 05:34:27 +00002369 if ((m = PyDict_GetItemString(modules, fullname)) != NULL) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00002370 Py_INCREF(m);
Guido van Rossum7f9fa971995-01-20 16:53:12 +00002371 }
2372 else {
Just van Rossum52e14d62002-12-30 22:08:05 +00002373 PyObject *path, *loader = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002374 char buf[MAXPATHLEN+1];
2375 struct filedescr *fdp;
2376 FILE *fp = NULL;
2377
Guido van Rossum9c0afe51998-05-19 15:09:05 +00002378 if (mod == Py_None)
2379 path = NULL;
2380 else {
2381 path = PyObject_GetAttrString(mod, "__path__");
2382 if (path == NULL) {
2383 PyErr_Clear();
2384 Py_INCREF(Py_None);
2385 return Py_None;
2386 }
2387 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002388
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002389 buf[0] = '\0';
Just van Rossum52e14d62002-12-30 22:08:05 +00002390 fdp = find_module(fullname, subname, path, buf, MAXPATHLEN+1,
2391 &fp, &loader);
Guido van Rossumb68cd421998-07-01 17:36:26 +00002392 Py_XDECREF(path);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002393 if (fdp == NULL) {
2394 if (!PyErr_ExceptionMatches(PyExc_ImportError))
2395 return NULL;
2396 PyErr_Clear();
2397 Py_INCREF(Py_None);
2398 return Py_None;
2399 }
Just van Rossum52e14d62002-12-30 22:08:05 +00002400 m = load_module(fullname, fp, buf, fdp->type, loader);
2401 Py_XDECREF(loader);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002402 if (fp)
2403 fclose(fp);
Neil Schemenauer00b09662003-06-16 21:03:07 +00002404 if (!add_submodule(mod, m, fullname, subname, modules)) {
2405 Py_XDECREF(m);
2406 m = NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002407 }
Guido van Rossum74e6a111994-08-29 12:54:38 +00002408 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002409
2410 return m;
Guido van Rossum74e6a111994-08-29 12:54:38 +00002411}
2412
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002413
2414/* Re-import a module of any kind and return its module object, WITH
2415 INCREMENTED REFERENCE COUNT */
2416
Guido van Rossum79f25d91997-04-29 20:08:16 +00002417PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002418PyImport_ReloadModule(PyObject *m)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002419{
Collin Winter2a98ff82007-03-13 23:04:29 +00002420 PyInterpreterState *interp = PyThreadState_Get()->interp;
2421 PyObject *modules_reloading = interp->modules_reloading;
Guido van Rossum25ce5661997-08-02 03:10:38 +00002422 PyObject *modules = PyImport_GetModuleDict();
Collin Wintere19d7a32007-03-12 16:49:23 +00002423 PyObject *path = NULL, *loader = NULL, *existing_m = NULL;
Guido van Rossum222ef561997-09-06 19:41:09 +00002424 char *name, *subname;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002425 char buf[MAXPATHLEN+1];
2426 struct filedescr *fdp;
2427 FILE *fp = NULL;
Tim Peters1cd70172004-08-02 03:52:12 +00002428 PyObject *newm;
Collin Winter2a98ff82007-03-13 23:04:29 +00002429
2430 if (modules_reloading == NULL) {
2431 Py_FatalError("PyImport_ReloadModule: "
2432 "no modules_reloading dictionary!");
2433 return NULL;
2434 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002435
Guido van Rossum79f25d91997-04-29 20:08:16 +00002436 if (m == NULL || !PyModule_Check(m)) {
2437 PyErr_SetString(PyExc_TypeError,
2438 "reload() argument must be module");
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002439 return NULL;
2440 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002441 name = PyModule_GetName(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002442 if (name == NULL)
2443 return NULL;
Guido van Rossum25ce5661997-08-02 03:10:38 +00002444 if (m != PyDict_GetItemString(modules, name)) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002445 PyErr_Format(PyExc_ImportError,
2446 "reload(): module %.200s not in sys.modules",
2447 name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002448 return NULL;
2449 }
Collin Wintere19d7a32007-03-12 16:49:23 +00002450 if ((existing_m = PyDict_GetItemString(modules_reloading, name)) != NULL) {
2451 /* Due to a recursive reload, this module is already being reloaded. */
2452 Py_INCREF(existing_m);
2453 return existing_m;
2454 }
2455 PyDict_SetItemString(modules_reloading, name, m);
2456
Guido van Rossum222ef561997-09-06 19:41:09 +00002457 subname = strrchr(name, '.');
2458 if (subname == NULL)
2459 subname = name;
2460 else {
2461 PyObject *parentname, *parent;
2462 parentname = PyString_FromStringAndSize(name, (subname-name));
Collin Wintere19d7a32007-03-12 16:49:23 +00002463 if (parentname == NULL) {
2464 imp_modules_reloading_clear();
Guido van Rossum222ef561997-09-06 19:41:09 +00002465 return NULL;
Collin Wintere19d7a32007-03-12 16:49:23 +00002466 }
Guido van Rossum222ef561997-09-06 19:41:09 +00002467 parent = PyDict_GetItem(modules, parentname);
2468 if (parent == NULL) {
2469 PyErr_Format(PyExc_ImportError,
2470 "reload(): parent %.200s not in sys.modules",
Georg Brandl0c55f292005-09-14 06:56:20 +00002471 PyString_AS_STRING(parentname));
2472 Py_DECREF(parentname);
Collin Wintere19d7a32007-03-12 16:49:23 +00002473 imp_modules_reloading_clear();
Guido van Rossum222ef561997-09-06 19:41:09 +00002474 return NULL;
2475 }
Georg Brandl0c55f292005-09-14 06:56:20 +00002476 Py_DECREF(parentname);
Guido van Rossum222ef561997-09-06 19:41:09 +00002477 subname++;
2478 path = PyObject_GetAttrString(parent, "__path__");
2479 if (path == NULL)
2480 PyErr_Clear();
2481 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002482 buf[0] = '\0';
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00002483 fdp = find_module(name, subname, path, buf, MAXPATHLEN+1, &fp, &loader);
Guido van Rossum222ef561997-09-06 19:41:09 +00002484 Py_XDECREF(path);
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00002485
2486 if (fdp == NULL) {
2487 Py_XDECREF(loader);
Collin Wintere19d7a32007-03-12 16:49:23 +00002488 imp_modules_reloading_clear();
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002489 return NULL;
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00002490 }
2491
2492 newm = load_module(name, fp, buf, fdp->type, loader);
2493 Py_XDECREF(loader);
2494
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002495 if (fp)
2496 fclose(fp);
Tim Peters1cd70172004-08-02 03:52:12 +00002497 if (newm == NULL) {
2498 /* load_module probably removed name from modules because of
2499 * the error. Put back the original module object. We're
2500 * going to return NULL in this case regardless of whether
2501 * replacing name succeeds, so the return value is ignored.
2502 */
2503 PyDict_SetItemString(modules, name, m);
2504 }
Collin Wintere19d7a32007-03-12 16:49:23 +00002505 imp_modules_reloading_clear();
Tim Peters1cd70172004-08-02 03:52:12 +00002506 return newm;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002507}
2508
2509
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002510/* Higher-level import emulator which emulates the "import" statement
2511 more accurately -- it invokes the __import__() function from the
2512 builtins of the current globals. This means that the import is
2513 done using whatever import hooks are installed in the current
Guido van Rossum6058eb41998-12-21 19:51:00 +00002514 environment, e.g. by "rexec".
2515 A dummy list ["__doc__"] is passed as the 4th argument so that
2516 e.g. PyImport_Import(PyString_FromString("win32com.client.gencache"))
2517 will return <module "gencache"> instead of <module "win32com">. */
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002518
2519PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002520PyImport_Import(PyObject *module_name)
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002521{
2522 static PyObject *silly_list = NULL;
2523 static PyObject *builtins_str = NULL;
2524 static PyObject *import_str = NULL;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002525 PyObject *globals = NULL;
2526 PyObject *import = NULL;
2527 PyObject *builtins = NULL;
2528 PyObject *r = NULL;
2529
2530 /* Initialize constant string objects */
2531 if (silly_list == NULL) {
2532 import_str = PyString_InternFromString("__import__");
2533 if (import_str == NULL)
2534 return NULL;
2535 builtins_str = PyString_InternFromString("__builtins__");
2536 if (builtins_str == NULL)
2537 return NULL;
2538 silly_list = Py_BuildValue("[s]", "__doc__");
2539 if (silly_list == NULL)
2540 return NULL;
2541 }
2542
2543 /* Get the builtins from current globals */
2544 globals = PyEval_GetGlobals();
Guido van Rossum85cd1d62001-02-20 21:43:24 +00002545 if (globals != NULL) {
Guido van Rossum66468561998-10-22 15:46:50 +00002546 Py_INCREF(globals);
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002547 builtins = PyObject_GetItem(globals, builtins_str);
2548 if (builtins == NULL)
2549 goto err;
2550 }
2551 else {
2552 /* No globals -- use standard builtins, and fake globals */
2553 PyErr_Clear();
2554
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002555 builtins = PyImport_ImportModuleLevel("__builtin__",
2556 NULL, NULL, NULL, 0);
Guido van Rossum85cd1d62001-02-20 21:43:24 +00002557 if (builtins == NULL)
2558 return NULL;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002559 globals = Py_BuildValue("{OO}", builtins_str, builtins);
2560 if (globals == NULL)
2561 goto err;
2562 }
2563
2564 /* Get the __import__ function from the builtins */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002565 if (PyDict_Check(builtins)) {
Fred Drakea76ba6e2001-03-06 06:31:15 +00002566 import = PyObject_GetItem(builtins, import_str);
Tim Peters6d6c1a32001-08-02 04:15:00 +00002567 if (import == NULL)
2568 PyErr_SetObject(PyExc_KeyError, import_str);
2569 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002570 else
Fred Drakea76ba6e2001-03-06 06:31:15 +00002571 import = PyObject_GetAttr(builtins, import_str);
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002572 if (import == NULL)
2573 goto err;
2574
2575 /* Call the _import__ function with the proper argument list */
Georg Brandl684fd0c2006-05-25 19:15:31 +00002576 r = PyObject_CallFunctionObjArgs(import, module_name, globals,
2577 globals, silly_list, NULL);
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002578
2579 err:
2580 Py_XDECREF(globals);
2581 Py_XDECREF(builtins);
2582 Py_XDECREF(import);
Tim Peters50d8d372001-02-28 05:34:27 +00002583
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002584 return r;
2585}
2586
2587
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002588/* Module 'imp' provides Python access to the primitives used for
2589 importing modules.
2590*/
2591
Guido van Rossum79f25d91997-04-29 20:08:16 +00002592static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +00002593imp_get_magic(PyObject *self, PyObject *noargs)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002594{
2595 char buf[4];
2596
Guido van Rossum96774c12000-05-01 20:19:08 +00002597 buf[0] = (char) ((pyc_magic >> 0) & 0xff);
2598 buf[1] = (char) ((pyc_magic >> 8) & 0xff);
2599 buf[2] = (char) ((pyc_magic >> 16) & 0xff);
2600 buf[3] = (char) ((pyc_magic >> 24) & 0xff);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002601
Guido van Rossum79f25d91997-04-29 20:08:16 +00002602 return PyString_FromStringAndSize(buf, 4);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002603}
2604
Guido van Rossum79f25d91997-04-29 20:08:16 +00002605static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +00002606imp_get_suffixes(PyObject *self, PyObject *noargs)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002607{
Guido van Rossum79f25d91997-04-29 20:08:16 +00002608 PyObject *list;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002609 struct filedescr *fdp;
2610
Guido van Rossum79f25d91997-04-29 20:08:16 +00002611 list = PyList_New(0);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002612 if (list == NULL)
2613 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002614 for (fdp = _PyImport_Filetab; fdp->suffix != NULL; fdp++) {
2615 PyObject *item = Py_BuildValue("ssi",
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002616 fdp->suffix, fdp->mode, fdp->type);
2617 if (item == NULL) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00002618 Py_DECREF(list);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002619 return NULL;
2620 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002621 if (PyList_Append(list, item) < 0) {
2622 Py_DECREF(list);
2623 Py_DECREF(item);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002624 return NULL;
2625 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002626 Py_DECREF(item);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002627 }
2628 return list;
2629}
2630
Guido van Rossum79f25d91997-04-29 20:08:16 +00002631static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002632call_find_module(char *name, PyObject *path)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002633{
Tim Petersdbd9ba62000-07-09 03:09:57 +00002634 extern int fclose(FILE *);
Guido van Rossum79f25d91997-04-29 20:08:16 +00002635 PyObject *fob, *ret;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002636 struct filedescr *fdp;
2637 char pathname[MAXPATHLEN+1];
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002638 FILE *fp = NULL;
2639
2640 pathname[0] = '\0';
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002641 if (path == Py_None)
2642 path = NULL;
Just van Rossum52e14d62002-12-30 22:08:05 +00002643 fdp = find_module(NULL, name, path, pathname, MAXPATHLEN+1, &fp, NULL);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002644 if (fdp == NULL)
2645 return NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002646 if (fp != NULL) {
2647 fob = PyFile_FromFile(fp, pathname, fdp->mode, fclose);
2648 if (fob == NULL) {
2649 fclose(fp);
2650 return NULL;
2651 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002652 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002653 else {
2654 fob = Py_None;
2655 Py_INCREF(fob);
Tim Peters50d8d372001-02-28 05:34:27 +00002656 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002657 ret = Py_BuildValue("Os(ssi)",
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002658 fob, pathname, fdp->suffix, fdp->mode, fdp->type);
Guido van Rossum79f25d91997-04-29 20:08:16 +00002659 Py_DECREF(fob);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002660 return ret;
2661}
2662
Guido van Rossum79f25d91997-04-29 20:08:16 +00002663static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002664imp_find_module(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002665{
2666 char *name;
2667 PyObject *path = NULL;
Guido van Rossum43713e52000-02-29 13:59:29 +00002668 if (!PyArg_ParseTuple(args, "s|O:find_module", &name, &path))
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002669 return NULL;
2670 return call_find_module(name, path);
2671}
2672
2673static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002674imp_init_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002675{
2676 char *name;
2677 int ret;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002678 PyObject *m;
Guido van Rossum43713e52000-02-29 13:59:29 +00002679 if (!PyArg_ParseTuple(args, "s:init_builtin", &name))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002680 return NULL;
2681 ret = init_builtin(name);
2682 if (ret < 0)
2683 return NULL;
2684 if (ret == 0) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00002685 Py_INCREF(Py_None);
2686 return Py_None;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002687 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002688 m = PyImport_AddModule(name);
2689 Py_XINCREF(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002690 return m;
2691}
2692
Guido van Rossum79f25d91997-04-29 20:08:16 +00002693static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002694imp_init_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002695{
2696 char *name;
2697 int ret;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002698 PyObject *m;
Guido van Rossum43713e52000-02-29 13:59:29 +00002699 if (!PyArg_ParseTuple(args, "s:init_frozen", &name))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002700 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002701 ret = PyImport_ImportFrozenModule(name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002702 if (ret < 0)
2703 return NULL;
2704 if (ret == 0) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00002705 Py_INCREF(Py_None);
2706 return Py_None;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002707 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002708 m = PyImport_AddModule(name);
2709 Py_XINCREF(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002710 return m;
2711}
2712
Guido van Rossum79f25d91997-04-29 20:08:16 +00002713static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002714imp_get_frozen_object(PyObject *self, PyObject *args)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002715{
2716 char *name;
Jack Jansen95ffa231995-10-03 14:38:41 +00002717
Guido van Rossum43713e52000-02-29 13:59:29 +00002718 if (!PyArg_ParseTuple(args, "s:get_frozen_object", &name))
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002719 return NULL;
2720 return get_frozen_object(name);
2721}
2722
Guido van Rossum79f25d91997-04-29 20:08:16 +00002723static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002724imp_is_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002725{
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002726 char *name;
Guido van Rossum43713e52000-02-29 13:59:29 +00002727 if (!PyArg_ParseTuple(args, "s:is_builtin", &name))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002728 return NULL;
Guido van Rossum50ee94f2002-04-09 18:00:58 +00002729 return PyInt_FromLong(is_builtin(name));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002730}
2731
Guido van Rossum79f25d91997-04-29 20:08:16 +00002732static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002733imp_is_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002734{
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002735 char *name;
Guido van Rossum323bf5e1998-06-24 03:54:06 +00002736 struct _frozen *p;
Guido van Rossum43713e52000-02-29 13:59:29 +00002737 if (!PyArg_ParseTuple(args, "s:is_frozen", &name))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002738 return NULL;
Guido van Rossum323bf5e1998-06-24 03:54:06 +00002739 p = find_frozen(name);
Guido van Rossumb8bff3f2002-04-07 06:34:38 +00002740 return PyBool_FromLong((long) (p == NULL ? 0 : p->size));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002741}
2742
2743static FILE *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002744get_file(char *pathname, PyObject *fob, char *mode)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002745{
2746 FILE *fp;
2747 if (fob == NULL) {
Tim Peters86c7d2f2004-08-01 23:24:21 +00002748 if (mode[0] == 'U')
Jeremy Hylton4ae6fae2002-05-30 17:15:25 +00002749 mode = "r" PY_STDIOTEXTMODE;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002750 fp = fopen(pathname, mode);
2751 if (fp == NULL)
Guido van Rossum79f25d91997-04-29 20:08:16 +00002752 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002753 }
2754 else {
Guido van Rossum79f25d91997-04-29 20:08:16 +00002755 fp = PyFile_AsFile(fob);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002756 if (fp == NULL)
Guido van Rossum79f25d91997-04-29 20:08:16 +00002757 PyErr_SetString(PyExc_ValueError,
2758 "bad/closed file object");
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002759 }
2760 return fp;
2761}
2762
Guido van Rossum79f25d91997-04-29 20:08:16 +00002763static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002764imp_load_compiled(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002765{
2766 char *name;
2767 char *pathname;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002768 PyObject *fob = NULL;
2769 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002770 FILE *fp;
Guido van Rossum43713e52000-02-29 13:59:29 +00002771 if (!PyArg_ParseTuple(args, "ss|O!:load_compiled", &name, &pathname,
Guido van Rossum79f25d91997-04-29 20:08:16 +00002772 &PyFile_Type, &fob))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002773 return NULL;
2774 fp = get_file(pathname, fob, "rb");
2775 if (fp == NULL)
2776 return NULL;
2777 m = load_compiled_module(name, pathname, fp);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002778 if (fob == NULL)
2779 fclose(fp);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002780 return m;
2781}
2782
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002783#ifdef HAVE_DYNAMIC_LOADING
2784
Guido van Rossum79f25d91997-04-29 20:08:16 +00002785static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002786imp_load_dynamic(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002787{
2788 char *name;
2789 char *pathname;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002790 PyObject *fob = NULL;
2791 PyObject *m;
Guido van Rossum7faeab31995-07-07 22:50:36 +00002792 FILE *fp = NULL;
Guido van Rossum43713e52000-02-29 13:59:29 +00002793 if (!PyArg_ParseTuple(args, "ss|O!:load_dynamic", &name, &pathname,
Guido van Rossum79f25d91997-04-29 20:08:16 +00002794 &PyFile_Type, &fob))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002795 return NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002796 if (fob) {
Guido van Rossum7faeab31995-07-07 22:50:36 +00002797 fp = get_file(pathname, fob, "r");
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002798 if (fp == NULL)
2799 return NULL;
2800 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002801 m = _PyImport_LoadDynamicModule(name, pathname, fp);
Guido van Rossum7faeab31995-07-07 22:50:36 +00002802 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002803}
2804
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002805#endif /* HAVE_DYNAMIC_LOADING */
2806
Guido van Rossum79f25d91997-04-29 20:08:16 +00002807static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002808imp_load_source(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002809{
2810 char *name;
2811 char *pathname;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002812 PyObject *fob = NULL;
2813 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002814 FILE *fp;
Guido van Rossum43713e52000-02-29 13:59:29 +00002815 if (!PyArg_ParseTuple(args, "ss|O!:load_source", &name, &pathname,
Guido van Rossum79f25d91997-04-29 20:08:16 +00002816 &PyFile_Type, &fob))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002817 return NULL;
2818 fp = get_file(pathname, fob, "r");
2819 if (fp == NULL)
2820 return NULL;
2821 m = load_source_module(name, pathname, fp);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002822 if (fob == NULL)
2823 fclose(fp);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002824 return m;
2825}
2826
Guido van Rossum79f25d91997-04-29 20:08:16 +00002827static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002828imp_load_module(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002829{
2830 char *name;
2831 PyObject *fob;
2832 char *pathname;
2833 char *suffix; /* Unused */
2834 char *mode;
2835 int type;
2836 FILE *fp;
2837
Guido van Rossum43713e52000-02-29 13:59:29 +00002838 if (!PyArg_ParseTuple(args, "sOs(ssi):load_module",
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002839 &name, &fob, &pathname,
2840 &suffix, &mode, &type))
2841 return NULL;
Guido van Rossum5e2c5fa2002-05-30 17:33:07 +00002842 if (*mode) {
2843 /* Mode must start with 'r' or 'U' and must not contain '+'.
2844 Implicit in this test is the assumption that the mode
2845 may contain other modifiers like 'b' or 't'. */
2846
2847 if (!(*mode == 'r' || *mode == 'U') || strchr(mode, '+')) {
Jeremy Hylton4ae6fae2002-05-30 17:15:25 +00002848 PyErr_Format(PyExc_ValueError,
2849 "invalid file open mode %.200s", mode);
2850 return NULL;
Guido van Rossum5e2c5fa2002-05-30 17:33:07 +00002851 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002852 }
2853 if (fob == Py_None)
2854 fp = NULL;
2855 else {
2856 if (!PyFile_Check(fob)) {
2857 PyErr_SetString(PyExc_ValueError,
2858 "load_module arg#2 should be a file or None");
2859 return NULL;
2860 }
2861 fp = get_file(pathname, fob, mode);
2862 if (fp == NULL)
2863 return NULL;
2864 }
Just van Rossum52e14d62002-12-30 22:08:05 +00002865 return load_module(name, fp, pathname, type, NULL);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002866}
2867
2868static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002869imp_load_package(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002870{
2871 char *name;
2872 char *pathname;
Guido van Rossum43713e52000-02-29 13:59:29 +00002873 if (!PyArg_ParseTuple(args, "ss:load_package", &name, &pathname))
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002874 return NULL;
2875 return load_package(name, pathname);
2876}
2877
2878static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002879imp_new_module(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002880{
2881 char *name;
Guido van Rossum43713e52000-02-29 13:59:29 +00002882 if (!PyArg_ParseTuple(args, "s:new_module", &name))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002883 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002884 return PyModule_New(name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002885}
2886
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002887/* Doc strings */
2888
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002889PyDoc_STRVAR(doc_imp,
2890"This module provides the components needed to build your own\n\
2891__import__ function. Undocumented functions are obsolete.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002892
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002893PyDoc_STRVAR(doc_find_module,
2894"find_module(name, [path]) -> (file, filename, (suffix, mode, type))\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002895Search for a module. If path is omitted or None, search for a\n\
2896built-in, frozen or special module and continue search in sys.path.\n\
2897The module name cannot contain '.'; to search for a submodule of a\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002898package, pass the submodule name and the package's __path__.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002899
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002900PyDoc_STRVAR(doc_load_module,
2901"load_module(name, file, filename, (suffix, mode, type)) -> module\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002902Load a module, given information returned by find_module().\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002903The module name must include the full package name, if any.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002904
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002905PyDoc_STRVAR(doc_get_magic,
2906"get_magic() -> string\n\
2907Return the magic number for .pyc or .pyo files.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002908
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002909PyDoc_STRVAR(doc_get_suffixes,
2910"get_suffixes() -> [(suffix, mode, type), ...]\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002911Return a list of (suffix, mode, type) tuples describing the files\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002912that find_module() looks for.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002913
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002914PyDoc_STRVAR(doc_new_module,
2915"new_module(name) -> module\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002916Create a new module. Do not enter it in sys.modules.\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002917The module name must include the full package name, if any.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002918
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002919PyDoc_STRVAR(doc_lock_held,
Tim Petersa7c65092004-08-01 23:26:05 +00002920"lock_held() -> boolean\n\
2921Return True if the import lock is currently held, else False.\n\
2922On platforms without threads, return False.");
Tim Peters69232342001-08-30 05:16:13 +00002923
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00002924PyDoc_STRVAR(doc_acquire_lock,
2925"acquire_lock() -> None\n\
Neal Norwitz2294c0d2003-02-12 23:02:21 +00002926Acquires the interpreter's import lock for the current thread.\n\
2927This lock should be used by import hooks to ensure thread-safety\n\
2928when importing modules.\n\
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00002929On platforms without threads, this function does nothing.");
2930
2931PyDoc_STRVAR(doc_release_lock,
2932"release_lock() -> None\n\
2933Release the interpreter's import lock.\n\
2934On platforms without threads, this function does nothing.");
2935
Guido van Rossum79f25d91997-04-29 20:08:16 +00002936static PyMethodDef imp_methods[] = {
Neal Norwitz08ea61a2003-02-17 18:18:00 +00002937 {"find_module", imp_find_module, METH_VARARGS, doc_find_module},
2938 {"get_magic", imp_get_magic, METH_NOARGS, doc_get_magic},
2939 {"get_suffixes", imp_get_suffixes, METH_NOARGS, doc_get_suffixes},
2940 {"load_module", imp_load_module, METH_VARARGS, doc_load_module},
2941 {"new_module", imp_new_module, METH_VARARGS, doc_new_module},
2942 {"lock_held", imp_lock_held, METH_NOARGS, doc_lock_held},
2943 {"acquire_lock", imp_acquire_lock, METH_NOARGS, doc_acquire_lock},
2944 {"release_lock", imp_release_lock, METH_NOARGS, doc_release_lock},
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002945 /* The rest are obsolete */
Neal Norwitz031829d2002-03-31 14:37:44 +00002946 {"get_frozen_object", imp_get_frozen_object, METH_VARARGS},
2947 {"init_builtin", imp_init_builtin, METH_VARARGS},
2948 {"init_frozen", imp_init_frozen, METH_VARARGS},
2949 {"is_builtin", imp_is_builtin, METH_VARARGS},
2950 {"is_frozen", imp_is_frozen, METH_VARARGS},
2951 {"load_compiled", imp_load_compiled, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002952#ifdef HAVE_DYNAMIC_LOADING
Neal Norwitz031829d2002-03-31 14:37:44 +00002953 {"load_dynamic", imp_load_dynamic, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002954#endif
Neal Norwitz031829d2002-03-31 14:37:44 +00002955 {"load_package", imp_load_package, METH_VARARGS},
Neal Norwitz031829d2002-03-31 14:37:44 +00002956 {"load_source", imp_load_source, METH_VARARGS},
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002957 {NULL, NULL} /* sentinel */
2958};
2959
Guido van Rossum1a8791e1998-08-04 22:46:29 +00002960static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002961setint(PyObject *d, char *name, int value)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002962{
2963 PyObject *v;
2964 int err;
2965
2966 v = PyInt_FromLong((long)value);
2967 err = PyDict_SetItemString(d, name, v);
2968 Py_XDECREF(v);
2969 return err;
2970}
2971
Phillip J. Ebyf7575d02006-07-28 21:12:07 +00002972typedef struct {
2973 PyObject_HEAD
2974} NullImporter;
2975
2976static int
2977NullImporter_init(NullImporter *self, PyObject *args, PyObject *kwds)
2978{
2979 char *path;
2980
2981 if (!_PyArg_NoKeywords("NullImporter()", kwds))
2982 return -1;
2983
2984 if (!PyArg_ParseTuple(args, "s:NullImporter",
2985 &path))
2986 return -1;
2987
2988 if (strlen(path) == 0) {
2989 PyErr_SetString(PyExc_ImportError, "empty pathname");
2990 return -1;
2991 } else {
2992#ifndef RISCOS
2993 struct stat statbuf;
2994 int rv;
2995
2996 rv = stat(path, &statbuf);
2997 if (rv == 0) {
2998 /* it exists */
2999 if (S_ISDIR(statbuf.st_mode)) {
3000 /* it's a directory */
3001 PyErr_SetString(PyExc_ImportError,
3002 "existing directory");
3003 return -1;
3004 }
3005 }
3006#else
3007 if (object_exists(path)) {
3008 /* it exists */
3009 if (isdir(path)) {
3010 /* it's a directory */
3011 PyErr_SetString(PyExc_ImportError,
3012 "existing directory");
3013 return -1;
3014 }
3015 }
3016#endif
3017 }
3018 return 0;
3019}
3020
3021static PyObject *
3022NullImporter_find_module(NullImporter *self, PyObject *args)
3023{
3024 Py_RETURN_NONE;
3025}
3026
3027static PyMethodDef NullImporter_methods[] = {
3028 {"find_module", (PyCFunction)NullImporter_find_module, METH_VARARGS,
3029 "Always return None"
3030 },
3031 {NULL} /* Sentinel */
3032};
3033
3034
3035static PyTypeObject NullImporterType = {
3036 PyObject_HEAD_INIT(NULL)
3037 0, /*ob_size*/
3038 "imp.NullImporter", /*tp_name*/
3039 sizeof(NullImporter), /*tp_basicsize*/
3040 0, /*tp_itemsize*/
3041 0, /*tp_dealloc*/
3042 0, /*tp_print*/
3043 0, /*tp_getattr*/
3044 0, /*tp_setattr*/
3045 0, /*tp_compare*/
3046 0, /*tp_repr*/
3047 0, /*tp_as_number*/
3048 0, /*tp_as_sequence*/
3049 0, /*tp_as_mapping*/
3050 0, /*tp_hash */
3051 0, /*tp_call*/
3052 0, /*tp_str*/
3053 0, /*tp_getattro*/
3054 0, /*tp_setattro*/
3055 0, /*tp_as_buffer*/
3056 Py_TPFLAGS_DEFAULT, /*tp_flags*/
3057 "Null importer object", /* tp_doc */
3058 0, /* tp_traverse */
3059 0, /* tp_clear */
3060 0, /* tp_richcompare */
3061 0, /* tp_weaklistoffset */
3062 0, /* tp_iter */
3063 0, /* tp_iternext */
3064 NullImporter_methods, /* tp_methods */
3065 0, /* tp_members */
3066 0, /* tp_getset */
3067 0, /* tp_base */
3068 0, /* tp_dict */
3069 0, /* tp_descr_get */
3070 0, /* tp_descr_set */
3071 0, /* tp_dictoffset */
3072 (initproc)NullImporter_init, /* tp_init */
3073 0, /* tp_alloc */
3074 PyType_GenericNew /* tp_new */
3075};
3076
3077
Jason Tishler6bc06ec2003-09-04 11:59:50 +00003078PyMODINIT_FUNC
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003079initimp(void)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003080{
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003081 PyObject *m, *d;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003082
Phillip J. Ebyf7575d02006-07-28 21:12:07 +00003083 if (PyType_Ready(&NullImporterType) < 0)
3084 goto failure;
3085
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003086 m = Py_InitModule4("imp", imp_methods, doc_imp,
3087 NULL, PYTHON_API_VERSION);
Neal Norwitz1ac754f2006-01-19 06:09:39 +00003088 if (m == NULL)
3089 goto failure;
Guido van Rossum79f25d91997-04-29 20:08:16 +00003090 d = PyModule_GetDict(m);
Neal Norwitz3cb31ac2006-08-13 18:10:47 +00003091 if (d == NULL)
3092 goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003093
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003094 if (setint(d, "SEARCH_ERROR", SEARCH_ERROR) < 0) goto failure;
3095 if (setint(d, "PY_SOURCE", PY_SOURCE) < 0) goto failure;
3096 if (setint(d, "PY_COMPILED", PY_COMPILED) < 0) goto failure;
3097 if (setint(d, "C_EXTENSION", C_EXTENSION) < 0) goto failure;
3098 if (setint(d, "PY_RESOURCE", PY_RESOURCE) < 0) goto failure;
3099 if (setint(d, "PKG_DIRECTORY", PKG_DIRECTORY) < 0) goto failure;
3100 if (setint(d, "C_BUILTIN", C_BUILTIN) < 0) goto failure;
3101 if (setint(d, "PY_FROZEN", PY_FROZEN) < 0) goto failure;
Guido van Rossum0f84a341998-08-06 13:36:01 +00003102 if (setint(d, "PY_CODERESOURCE", PY_CODERESOURCE) < 0) goto failure;
Just van Rossum52e14d62002-12-30 22:08:05 +00003103 if (setint(d, "IMP_HOOK", IMP_HOOK) < 0) goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003104
Phillip J. Ebyf7575d02006-07-28 21:12:07 +00003105 Py_INCREF(&NullImporterType);
3106 PyModule_AddObject(m, "NullImporter", (PyObject *)&NullImporterType);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003107 failure:
3108 ;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003109}
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003110
3111
Guido van Rossumb18618d2000-05-03 23:44:39 +00003112/* API for embedding applications that want to add their own entries
3113 to the table of built-in modules. This should normally be called
3114 *before* Py_Initialize(). When the table resize fails, -1 is
3115 returned and the existing table is unchanged.
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003116
3117 After a similar function by Just van Rossum. */
3118
3119int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003120PyImport_ExtendInittab(struct _inittab *newtab)
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003121{
3122 static struct _inittab *our_copy = NULL;
3123 struct _inittab *p;
3124 int i, n;
3125
3126 /* Count the number of entries in both tables */
3127 for (n = 0; newtab[n].name != NULL; n++)
3128 ;
3129 if (n == 0)
3130 return 0; /* Nothing to do */
3131 for (i = 0; PyImport_Inittab[i].name != NULL; i++)
3132 ;
3133
3134 /* Allocate new memory for the combined table */
Guido van Rossumb18618d2000-05-03 23:44:39 +00003135 p = our_copy;
3136 PyMem_RESIZE(p, struct _inittab, i+n+1);
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003137 if (p == NULL)
3138 return -1;
3139
3140 /* Copy the tables into the new memory */
3141 if (our_copy != PyImport_Inittab)
3142 memcpy(p, PyImport_Inittab, (i+1) * sizeof(struct _inittab));
3143 PyImport_Inittab = our_copy = p;
3144 memcpy(p+i, newtab, (n+1) * sizeof(struct _inittab));
3145
3146 return 0;
3147}
3148
3149/* Shorthand to add a single entry given a name and a function */
3150
3151int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003152PyImport_AppendInittab(char *name, void (*initfunc)(void))
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003153{
3154 struct _inittab newtab[2];
3155
3156 memset(newtab, '\0', sizeof newtab);
3157
3158 newtab[0].name = name;
3159 newtab[0].initfunc = initfunc;
3160
3161 return PyImport_ExtendInittab(newtab);
3162}
Anthony Baxterac6bd462006-04-13 02:06:09 +00003163
3164#ifdef __cplusplus
3165}
3166#endif