blob: d7f012ac1c31165f08a1bad73ac422b382c39aee [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"
Neal Norwitzadb69fc2005-12-17 20:54:49 +00007#include "pyarena.h"
Jeremy Hylton3e0055f2005-10-20 19:59:25 +00008#include "pythonrun.h"
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00009#include "errcode.h"
Guido van Rossumc405b7b1991-06-04 19:39:42 +000010#include "marshal.h"
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000011#include "code.h"
Guido van Rossumc405b7b1991-06-04 19:39:42 +000012#include "compile.h"
Guido van Rossumff4949e1992-08-05 19:58:53 +000013#include "eval.h"
Guido van Rossumd8bac6d1992-02-26 15:19:13 +000014#include "osdefs.h"
Guido van Rossum1ae940a1995-01-02 19:04:15 +000015#include "importdl.h"
Guido van Rossumc405b7b1991-06-04 19:39:42 +000016
Guido van Rossum55a83382000-09-20 20:31:38 +000017#ifdef HAVE_FCNTL_H
18#include <fcntl.h>
19#endif
Anthony Baxterac6bd462006-04-13 02:06:09 +000020#ifdef __cplusplus
21extern "C" {
22#endif
Guido van Rossum55a83382000-09-20 20:31:38 +000023
Thomas Woutersf70ef4f2000-07-22 18:47:25 +000024extern time_t PyOS_GetLastModificationTime(char *, FILE *);
25 /* In getmtime.c */
Guido van Rossum21d335e1993-10-15 13:01:11 +000026
Jeremy Hyltond4ceb312004-04-01 02:45:22 +000027/* Magic word to reject .pyc files generated by other Python versions.
28 It should change for each incompatible change to the bytecode.
29
30 The value of CR and LF is incorporated so if you ever read or write
Guido van Rossum7faeab31995-07-07 22:50:36 +000031 a .pyc file in text mode the magic number will be wrong; also, the
Tim Peters36515e22001-11-18 04:06:29 +000032 Apple MPW compiler swaps their values, botching string constants.
Marc-André Lemburgbd3be8f2002-02-07 11:33:49 +000033
Martin v. Löwisef82d2f2004-06-27 16:51:46 +000034 The magic numbers must be spaced apart atleast 2 values, as the
35 -U interpeter flag will cause MAGIC+1 being used. They have been
36 odd numbers for some time now.
Marc-André Lemburgbd3be8f2002-02-07 11:33:49 +000037
Jeremy Hyltond4ceb312004-04-01 02:45:22 +000038 There were a variety of old schemes for setting the magic number.
39 The current working scheme is to increment the previous value by
40 10.
Guido van Rossumf6894922002-08-31 15:16:14 +000041
Marc-André Lemburgbd3be8f2002-02-07 11:33:49 +000042 Known values:
43 Python 1.5: 20121
44 Python 1.5.1: 20121
45 Python 1.5.2: 20121
Skip Montanaro4ec3c262006-03-25 14:12:03 +000046 Python 1.6: 50428
Marc-André Lemburgbd3be8f2002-02-07 11:33:49 +000047 Python 2.0: 50823
48 Python 2.0.1: 50823
49 Python 2.1: 60202
50 Python 2.1.1: 60202
51 Python 2.1.2: 60202
52 Python 2.2: 60717
Neal Norwitz7fdcb412002-06-14 01:07:39 +000053 Python 2.3a0: 62011
Michael W. Hudsondd32a912002-08-15 14:59:02 +000054 Python 2.3a0: 62021
Guido van Rossumf6894922002-08-31 15:16:14 +000055 Python 2.3a0: 62011 (!)
Martin v. Löwisef82d2f2004-06-27 16:51:46 +000056 Python 2.4a0: 62041
Raymond Hettingerfd2d1f72004-08-23 23:37:48 +000057 Python 2.4a3: 62051
Raymond Hettinger2c31a052004-09-22 18:44:21 +000058 Python 2.4b1: 62061
Michael W. Hudsondf888462005-06-03 14:41:55 +000059 Python 2.5a0: 62071
Michael W. Hudsonaee2e282005-10-21 11:32:20 +000060 Python 2.5a0: 62081 (ast-branch)
Guido van Rossumc2e20742006-02-27 22:32:47 +000061 Python 2.5a0: 62091 (with)
Guido van Rossumf6694362006-03-10 02:28:35 +000062 Python 2.5a0: 62092 (changed WITH_CLEANUP opcode)
Neal Norwitz0d62a062006-07-30 06:53:31 +000063 Python 2.5b3: 62101 (fix wrong code: for x, in ...)
64 Python 2.5b3: 62111 (fix wrong code: x += yield)
Neal Norwitz9a70f952006-08-04 05:12:19 +000065 Python 2.5c1: 62121 (fix wrong lnotab with for loops and
66 storing constants that should have been removed)
Neal Norwitzdac090d2006-09-05 03:53:08 +000067 Python 2.5c2: 62131 (fix wrong code: for x, in ... in listcomp/genexp)
Neal Norwitzcbeb6872006-10-14 21:33:38 +000068 Python 2.6a0: 62141 (peephole optimizations)
Michael W. Hudsonaee2e282005-10-21 11:32:20 +000069.
Tim Peters36515e22001-11-18 04:06:29 +000070*/
Neal Norwitzcbeb6872006-10-14 21:33:38 +000071#define MAGIC (62141 | ((long)'\r'<<16) | ((long)'\n'<<24))
Guido van Rossum3ddee711991-12-16 13:06:34 +000072
Guido van Rossum96774c12000-05-01 20:19:08 +000073/* Magic word as global; note that _PyImport_Init() can change the
Jeremy Hylton9262b8a2000-06-30 04:59:17 +000074 value of this global to accommodate for alterations of how the
Guido van Rossum96774c12000-05-01 20:19:08 +000075 compiler works which are enabled by command line switches. */
76static long pyc_magic = MAGIC;
77
Guido van Rossum25ce5661997-08-02 03:10:38 +000078/* See _PyImport_FixupExtension() below */
79static PyObject *extensions = NULL;
Guido van Rossum3f5da241990-12-20 15:06:42 +000080
Guido van Rossum771c6c81997-10-31 18:37:24 +000081/* This table is defined in config.c: */
82extern struct _inittab _PyImport_Inittab[];
83
84struct _inittab *PyImport_Inittab = _PyImport_Inittab;
Guido van Rossum66f1fa81991-04-03 19:03:52 +000085
Guido van Rossumed1170e1999-12-20 21:23:41 +000086/* these tables define the module suffixes that Python recognizes */
87struct filedescr * _PyImport_Filetab = NULL;
Guido van Rossum48a680c2001-03-02 06:34:14 +000088
89#ifdef RISCOS
90static const struct filedescr _PyImport_StandardFiletab[] = {
Jack Jansenc88da1f2002-05-28 10:58:19 +000091 {"/py", "U", PY_SOURCE},
Guido van Rossum48a680c2001-03-02 06:34:14 +000092 {"/pyc", "rb", PY_COMPILED},
93 {0, 0}
94};
95#else
Guido van Rossumed1170e1999-12-20 21:23:41 +000096static const struct filedescr _PyImport_StandardFiletab[] = {
Jack Jansenc88da1f2002-05-28 10:58:19 +000097 {".py", "U", PY_SOURCE},
Martin v. Löwis6238d2b2002-06-30 15:26:10 +000098#ifdef MS_WINDOWS
Jack Jansenc88da1f2002-05-28 10:58:19 +000099 {".pyw", "U", PY_SOURCE},
Tim Peters36515e22001-11-18 04:06:29 +0000100#endif
Guido van Rossumed1170e1999-12-20 21:23:41 +0000101 {".pyc", "rb", PY_COMPILED},
102 {0, 0}
103};
Guido van Rossum48a680c2001-03-02 06:34:14 +0000104#endif
Guido van Rossumed1170e1999-12-20 21:23:41 +0000105
Phillip J. Ebyf7575d02006-07-28 21:12:07 +0000106static PyTypeObject NullImporterType; /* Forward reference */
107
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000108/* Initialize things */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000109
110void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000111_PyImport_Init(void)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000112{
Guido van Rossumed1170e1999-12-20 21:23:41 +0000113 const struct filedescr *scan;
114 struct filedescr *filetab;
115 int countD = 0;
116 int countS = 0;
117
118 /* prepare _PyImport_Filetab: copy entries from
119 _PyImport_DynLoadFiletab and _PyImport_StandardFiletab.
120 */
121 for (scan = _PyImport_DynLoadFiletab; scan->suffix != NULL; ++scan)
122 ++countD;
123 for (scan = _PyImport_StandardFiletab; scan->suffix != NULL; ++scan)
124 ++countS;
Guido van Rossumb18618d2000-05-03 23:44:39 +0000125 filetab = PyMem_NEW(struct filedescr, countD + countS + 1);
Neal Norwitze1fdb322006-07-21 05:32:28 +0000126 if (filetab == NULL)
Neal Norwitz33722ae2006-07-21 07:59:02 +0000127 Py_FatalError("Can't initialize import file table.");
Guido van Rossumed1170e1999-12-20 21:23:41 +0000128 memcpy(filetab, _PyImport_DynLoadFiletab,
129 countD * sizeof(struct filedescr));
130 memcpy(filetab + countD, _PyImport_StandardFiletab,
131 countS * sizeof(struct filedescr));
132 filetab[countD + countS].suffix = NULL;
133
134 _PyImport_Filetab = filetab;
135
Guido van Rossum0824f631997-03-11 18:37:35 +0000136 if (Py_OptimizeFlag) {
Guido van Rossumed1170e1999-12-20 21:23:41 +0000137 /* Replace ".pyc" with ".pyo" in _PyImport_Filetab */
138 for (; filetab->suffix != NULL; filetab++) {
Guido van Rossum48a680c2001-03-02 06:34:14 +0000139#ifndef RISCOS
Guido van Rossumed1170e1999-12-20 21:23:41 +0000140 if (strcmp(filetab->suffix, ".pyc") == 0)
141 filetab->suffix = ".pyo";
Guido van Rossum48a680c2001-03-02 06:34:14 +0000142#else
143 if (strcmp(filetab->suffix, "/pyc") == 0)
144 filetab->suffix = "/pyo";
145#endif
Guido van Rossum0824f631997-03-11 18:37:35 +0000146 }
147 }
Guido van Rossum96774c12000-05-01 20:19:08 +0000148
149 if (Py_UnicodeFlag) {
150 /* Fix the pyc_magic so that byte compiled code created
151 using the all-Unicode method doesn't interfere with
152 code created in normal operation mode. */
153 pyc_magic = MAGIC + 1;
154 }
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000155}
156
Guido van Rossum25ce5661997-08-02 03:10:38 +0000157void
Just van Rossum52e14d62002-12-30 22:08:05 +0000158_PyImportHooks_Init(void)
159{
160 PyObject *v, *path_hooks = NULL, *zimpimport;
161 int err = 0;
162
163 /* adding sys.path_hooks and sys.path_importer_cache, setting up
164 zipimport */
Phillip J. Ebyf7575d02006-07-28 21:12:07 +0000165 if (PyType_Ready(&NullImporterType) < 0)
166 goto error;
Just van Rossum52e14d62002-12-30 22:08:05 +0000167
168 if (Py_VerboseFlag)
169 PySys_WriteStderr("# installing zipimport hook\n");
170
171 v = PyList_New(0);
172 if (v == NULL)
173 goto error;
174 err = PySys_SetObject("meta_path", v);
175 Py_DECREF(v);
176 if (err)
177 goto error;
178 v = PyDict_New();
179 if (v == NULL)
180 goto error;
181 err = PySys_SetObject("path_importer_cache", v);
182 Py_DECREF(v);
183 if (err)
184 goto error;
185 path_hooks = PyList_New(0);
186 if (path_hooks == NULL)
187 goto error;
188 err = PySys_SetObject("path_hooks", path_hooks);
189 if (err) {
190 error:
191 PyErr_Print();
Phillip J. Ebyf7575d02006-07-28 21:12:07 +0000192 Py_FatalError("initializing sys.meta_path, sys.path_hooks, "
193 "path_importer_cache, or NullImporter failed"
194 );
Just van Rossum52e14d62002-12-30 22:08:05 +0000195 }
Phillip J. Ebyf7575d02006-07-28 21:12:07 +0000196
Just van Rossum52e14d62002-12-30 22:08:05 +0000197 zimpimport = PyImport_ImportModule("zipimport");
198 if (zimpimport == NULL) {
199 PyErr_Clear(); /* No zip import module -- okay */
200 if (Py_VerboseFlag)
201 PySys_WriteStderr("# can't import zipimport\n");
202 }
203 else {
204 PyObject *zipimporter = PyObject_GetAttrString(zimpimport,
205 "zipimporter");
206 Py_DECREF(zimpimport);
207 if (zipimporter == NULL) {
208 PyErr_Clear(); /* No zipimporter object -- okay */
209 if (Py_VerboseFlag)
210 PySys_WriteStderr(
Fred Drake1e5fc552003-07-11 15:01:02 +0000211 "# can't import zipimport.zipimporter\n");
Just van Rossum52e14d62002-12-30 22:08:05 +0000212 }
213 else {
214 /* sys.path_hooks.append(zipimporter) */
215 err = PyList_Append(path_hooks, zipimporter);
216 Py_DECREF(zipimporter);
217 if (err)
218 goto error;
219 if (Py_VerboseFlag)
220 PySys_WriteStderr(
221 "# installed zipimport hook\n");
222 }
223 }
224 Py_DECREF(path_hooks);
225}
226
227void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000228_PyImport_Fini(void)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000229{
230 Py_XDECREF(extensions);
231 extensions = NULL;
Barry Warsaw84294482000-10-03 16:02:05 +0000232 PyMem_DEL(_PyImport_Filetab);
233 _PyImport_Filetab = NULL;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000234}
235
236
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000237/* Locking primitives to prevent parallel imports of the same module
238 in different threads to return with a partially loaded module.
239 These calls are serialized by the global interpreter lock. */
240
241#ifdef WITH_THREAD
242
Guido van Rossum49b56061998-10-01 20:42:43 +0000243#include "pythread.h"
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000244
Guido van Rossum65d5b571998-12-21 19:32:43 +0000245static PyThread_type_lock import_lock = 0;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000246static long import_lock_thread = -1;
247static int import_lock_level = 0;
248
249static void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000250lock_import(void)
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000251{
Guido van Rossum65d5b571998-12-21 19:32:43 +0000252 long me = PyThread_get_thread_ident();
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000253 if (me == -1)
254 return; /* Too bad */
Neal Norwitze1fdb322006-07-21 05:32:28 +0000255 if (import_lock == NULL) {
Guido van Rossum65d5b571998-12-21 19:32:43 +0000256 import_lock = PyThread_allocate_lock();
Neal Norwitze1fdb322006-07-21 05:32:28 +0000257 if (import_lock == NULL)
258 return; /* Nothing much we can do. */
259 }
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000260 if (import_lock_thread == me) {
261 import_lock_level++;
262 return;
263 }
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000264 if (import_lock_thread != -1 || !PyThread_acquire_lock(import_lock, 0))
265 {
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000266 PyThreadState *tstate = PyEval_SaveThread();
Guido van Rossum65d5b571998-12-21 19:32:43 +0000267 PyThread_acquire_lock(import_lock, 1);
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000268 PyEval_RestoreThread(tstate);
269 }
270 import_lock_thread = me;
271 import_lock_level = 1;
272}
273
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000274static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000275unlock_import(void)
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000276{
Guido van Rossum65d5b571998-12-21 19:32:43 +0000277 long me = PyThread_get_thread_ident();
Neal Norwitze1fdb322006-07-21 05:32:28 +0000278 if (me == -1 || import_lock == NULL)
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000279 return 0; /* Too bad */
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000280 if (import_lock_thread != me)
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000281 return -1;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000282 import_lock_level--;
283 if (import_lock_level == 0) {
284 import_lock_thread = -1;
Guido van Rossum65d5b571998-12-21 19:32:43 +0000285 PyThread_release_lock(import_lock);
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000286 }
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000287 return 1;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000288}
289
Guido van Rossum8ee3e5a2005-09-14 18:09:42 +0000290/* This function is called from PyOS_AfterFork to ensure that newly
291 created child processes do not share locks with the parent. */
292
293void
294_PyImport_ReInitLock(void)
295{
296#ifdef _AIX
297 if (import_lock != NULL)
298 import_lock = PyThread_allocate_lock();
299#endif
300}
301
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000302#else
303
304#define lock_import()
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000305#define unlock_import() 0
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000306
307#endif
308
Tim Peters69232342001-08-30 05:16:13 +0000309static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000310imp_lock_held(PyObject *self, PyObject *noargs)
Tim Peters69232342001-08-30 05:16:13 +0000311{
Tim Peters69232342001-08-30 05:16:13 +0000312#ifdef WITH_THREAD
Guido van Rossumb8bff3f2002-04-07 06:34:38 +0000313 return PyBool_FromLong(import_lock_thread != -1);
Tim Peters69232342001-08-30 05:16:13 +0000314#else
Guido van Rossumb8bff3f2002-04-07 06:34:38 +0000315 return PyBool_FromLong(0);
Tim Peters69232342001-08-30 05:16:13 +0000316#endif
317}
318
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000319static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000320imp_acquire_lock(PyObject *self, PyObject *noargs)
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000321{
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000322#ifdef WITH_THREAD
323 lock_import();
324#endif
Neal Norwitz2294c0d2003-02-12 23:02:21 +0000325 Py_INCREF(Py_None);
326 return Py_None;
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000327}
328
329static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000330imp_release_lock(PyObject *self, PyObject *noargs)
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000331{
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000332#ifdef WITH_THREAD
333 if (unlock_import() < 0) {
334 PyErr_SetString(PyExc_RuntimeError,
335 "not holding the import lock");
336 return NULL;
337 }
338#endif
Neal Norwitz2294c0d2003-02-12 23:02:21 +0000339 Py_INCREF(Py_None);
340 return Py_None;
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000341}
342
Collin Winter276887b2007-03-12 16:11:39 +0000343PyObject *
344PyImport_GetModulesReloading(void)
345{
346 PyInterpreterState *interp = PyThreadState_Get()->interp;
347 if (interp->modules_reloading == NULL)
348 Py_FatalError("PyImport_GetModuleDict: no modules_reloading dictionary!");
349 return interp->modules_reloading;
350}
351
352static void
353imp_modules_reloading_clear (void)
354{
355 PyInterpreterState *interp = PyThreadState_Get()->interp;
356 if (interp->modules_reloading == NULL)
357 return;
358 PyDict_Clear(interp->modules_reloading);
359 return;
360}
361
Guido van Rossum25ce5661997-08-02 03:10:38 +0000362/* Helper for sys */
363
364PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000365PyImport_GetModuleDict(void)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000366{
Nicholas Bastine5662ae2004-03-24 22:22:12 +0000367 PyInterpreterState *interp = PyThreadState_GET()->interp;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000368 if (interp->modules == NULL)
369 Py_FatalError("PyImport_GetModuleDict: no module dictionary!");
370 return interp->modules;
371}
372
Guido van Rossum3f5da241990-12-20 15:06:42 +0000373
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000374/* List of names to clear in sys */
375static char* sys_deletes[] = {
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000376 "path", "argv", "ps1", "ps2", "exitfunc",
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000377 "exc_type", "exc_value", "exc_traceback",
378 "last_type", "last_value", "last_traceback",
Just van Rossum52e14d62002-12-30 22:08:05 +0000379 "path_hooks", "path_importer_cache", "meta_path",
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000380 NULL
381};
382
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000383static char* sys_files[] = {
384 "stdin", "__stdin__",
385 "stdout", "__stdout__",
386 "stderr", "__stderr__",
387 NULL
388};
389
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000390
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000391/* Un-initialize things, as good as we can */
Guido van Rossum3f5da241990-12-20 15:06:42 +0000392
Guido van Rossum3f5da241990-12-20 15:06:42 +0000393void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000394PyImport_Cleanup(void)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000395{
Martin v. Löwis18e16552006-02-15 17:27:45 +0000396 Py_ssize_t pos, ndone;
Guido van Rossum758eec01998-01-19 21:58:26 +0000397 char *name;
398 PyObject *key, *value, *dict;
Nicholas Bastine5662ae2004-03-24 22:22:12 +0000399 PyInterpreterState *interp = PyThreadState_GET()->interp;
Guido van Rossum758eec01998-01-19 21:58:26 +0000400 PyObject *modules = interp->modules;
401
402 if (modules == NULL)
403 return; /* Already done */
404
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000405 /* Delete some special variables first. These are common
406 places where user values hide and people complain when their
407 destructors fail. Since the modules containing them are
408 deleted *last* of all, they would come too late in the normal
409 destruction order. Sigh. */
410
411 value = PyDict_GetItemString(modules, "__builtin__");
412 if (value != NULL && PyModule_Check(value)) {
413 dict = PyModule_GetDict(value);
414 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000415 PySys_WriteStderr("# clear __builtin__._\n");
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000416 PyDict_SetItemString(dict, "_", Py_None);
417 }
418 value = PyDict_GetItemString(modules, "sys");
419 if (value != NULL && PyModule_Check(value)) {
420 char **p;
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000421 PyObject *v;
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000422 dict = PyModule_GetDict(value);
423 for (p = sys_deletes; *p != NULL; p++) {
424 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000425 PySys_WriteStderr("# clear sys.%s\n", *p);
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000426 PyDict_SetItemString(dict, *p, Py_None);
427 }
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000428 for (p = sys_files; *p != NULL; p+=2) {
429 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000430 PySys_WriteStderr("# restore sys.%s\n", *p);
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000431 v = PyDict_GetItemString(dict, *(p+1));
432 if (v == NULL)
433 v = Py_None;
434 PyDict_SetItemString(dict, *p, v);
435 }
436 }
437
438 /* First, delete __main__ */
439 value = PyDict_GetItemString(modules, "__main__");
440 if (value != NULL && PyModule_Check(value)) {
441 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000442 PySys_WriteStderr("# cleanup __main__\n");
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000443 _PyModule_Clear(value);
444 PyDict_SetItemString(modules, "__main__", Py_None);
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000445 }
446
Guido van Rossum758eec01998-01-19 21:58:26 +0000447 /* The special treatment of __builtin__ here is because even
448 when it's not referenced as a module, its dictionary is
449 referenced by almost every module's __builtins__. Since
450 deleting a module clears its dictionary (even if there are
451 references left to it), we need to delete the __builtin__
452 module last. Likewise, we don't delete sys until the very
453 end because it is implicitly referenced (e.g. by print).
454
455 Also note that we 'delete' modules by replacing their entry
456 in the modules dict with None, rather than really deleting
457 them; this avoids a rehash of the modules dictionary and
458 also marks them as "non existent" so they won't be
459 re-imported. */
460
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000461 /* Next, repeatedly delete modules with a reference count of
Guido van Rossum758eec01998-01-19 21:58:26 +0000462 one (skipping __builtin__ and sys) and delete them */
463 do {
464 ndone = 0;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000465 pos = 0;
Guido van Rossum758eec01998-01-19 21:58:26 +0000466 while (PyDict_Next(modules, &pos, &key, &value)) {
467 if (value->ob_refcnt != 1)
468 continue;
Guido van Rossum566373e1998-10-01 15:24:50 +0000469 if (PyString_Check(key) && PyModule_Check(value)) {
470 name = PyString_AS_STRING(key);
Guido van Rossum758eec01998-01-19 21:58:26 +0000471 if (strcmp(name, "__builtin__") == 0)
472 continue;
473 if (strcmp(name, "sys") == 0)
474 continue;
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000475 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000476 PySys_WriteStderr(
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000477 "# cleanup[1] %s\n", name);
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000478 _PyModule_Clear(value);
Guido van Rossum758eec01998-01-19 21:58:26 +0000479 PyDict_SetItem(modules, key, Py_None);
480 ndone++;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000481 }
482 }
Guido van Rossum758eec01998-01-19 21:58:26 +0000483 } while (ndone > 0);
484
Guido van Rossum758eec01998-01-19 21:58:26 +0000485 /* Next, delete all modules (still skipping __builtin__ and sys) */
486 pos = 0;
487 while (PyDict_Next(modules, &pos, &key, &value)) {
Guido van Rossum566373e1998-10-01 15:24:50 +0000488 if (PyString_Check(key) && PyModule_Check(value)) {
489 name = PyString_AS_STRING(key);
Guido van Rossum758eec01998-01-19 21:58:26 +0000490 if (strcmp(name, "__builtin__") == 0)
491 continue;
492 if (strcmp(name, "sys") == 0)
493 continue;
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000494 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000495 PySys_WriteStderr("# cleanup[2] %s\n", name);
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000496 _PyModule_Clear(value);
Guido van Rossum758eec01998-01-19 21:58:26 +0000497 PyDict_SetItem(modules, key, Py_None);
498 }
499 }
500
501 /* Next, delete sys and __builtin__ (in that order) */
502 value = PyDict_GetItemString(modules, "sys");
503 if (value != NULL && PyModule_Check(value)) {
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000504 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000505 PySys_WriteStderr("# cleanup sys\n");
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000506 _PyModule_Clear(value);
Guido van Rossum758eec01998-01-19 21:58:26 +0000507 PyDict_SetItemString(modules, "sys", Py_None);
508 }
509 value = PyDict_GetItemString(modules, "__builtin__");
510 if (value != NULL && PyModule_Check(value)) {
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000511 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000512 PySys_WriteStderr("# cleanup __builtin__\n");
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000513 _PyModule_Clear(value);
Guido van Rossum758eec01998-01-19 21:58:26 +0000514 PyDict_SetItemString(modules, "__builtin__", Py_None);
515 }
516
517 /* Finally, clear and delete the modules directory */
518 PyDict_Clear(modules);
519 interp->modules = NULL;
520 Py_DECREF(modules);
Collin Winter276887b2007-03-12 16:11:39 +0000521 Py_CLEAR(interp->modules_reloading);
Guido van Rossum8d15b5d1990-10-26 14:58:58 +0000522}
Guido van Rossum7f133ed1991-02-19 12:23:57 +0000523
524
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000525/* Helper for pythonrun.c -- return magic number */
526
527long
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000528PyImport_GetMagicNumber(void)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000529{
Guido van Rossum96774c12000-05-01 20:19:08 +0000530 return pyc_magic;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000531}
532
533
Guido van Rossum25ce5661997-08-02 03:10:38 +0000534/* Magic for extension modules (built-in as well as dynamically
535 loaded). To prevent initializing an extension module more than
536 once, we keep a static dictionary 'extensions' keyed by module name
537 (for built-in modules) or by filename (for dynamically loaded
Barry Warsaw92883382001-08-13 23:05:44 +0000538 modules), containing these modules. A copy of the module's
Guido van Rossum25ce5661997-08-02 03:10:38 +0000539 dictionary is stored by calling _PyImport_FixupExtension()
540 immediately after the module initialization function succeeds. A
541 copy can be retrieved from there by calling
542 _PyImport_FindExtension(). */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000543
Guido van Rossum79f25d91997-04-29 20:08:16 +0000544PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000545_PyImport_FixupExtension(char *name, char *filename)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000546{
Guido van Rossum25ce5661997-08-02 03:10:38 +0000547 PyObject *modules, *mod, *dict, *copy;
548 if (extensions == NULL) {
549 extensions = PyDict_New();
550 if (extensions == NULL)
551 return NULL;
552 }
553 modules = PyImport_GetModuleDict();
554 mod = PyDict_GetItemString(modules, name);
555 if (mod == NULL || !PyModule_Check(mod)) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000556 PyErr_Format(PyExc_SystemError,
557 "_PyImport_FixupExtension: module %.200s not loaded", name);
Guido van Rossum25ce5661997-08-02 03:10:38 +0000558 return NULL;
559 }
560 dict = PyModule_GetDict(mod);
561 if (dict == NULL)
562 return NULL;
Fred Drake9cd0efc2001-10-25 21:38:59 +0000563 copy = PyDict_Copy(dict);
Guido van Rossum25ce5661997-08-02 03:10:38 +0000564 if (copy == NULL)
565 return NULL;
566 PyDict_SetItemString(extensions, filename, copy);
567 Py_DECREF(copy);
568 return copy;
569}
570
571PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000572_PyImport_FindExtension(char *name, char *filename)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000573{
Fred Drake9cd0efc2001-10-25 21:38:59 +0000574 PyObject *dict, *mod, *mdict;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000575 if (extensions == NULL)
576 return NULL;
577 dict = PyDict_GetItemString(extensions, filename);
578 if (dict == NULL)
579 return NULL;
580 mod = PyImport_AddModule(name);
581 if (mod == NULL)
582 return NULL;
583 mdict = PyModule_GetDict(mod);
584 if (mdict == NULL)
585 return NULL;
Fred Drake9cd0efc2001-10-25 21:38:59 +0000586 if (PyDict_Update(mdict, dict))
Guido van Rossum25ce5661997-08-02 03:10:38 +0000587 return NULL;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000588 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000589 PySys_WriteStderr("import %s # previously loaded (%s)\n",
Guido van Rossum25ce5661997-08-02 03:10:38 +0000590 name, filename);
591 return mod;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000592}
593
594
595/* Get the module object corresponding to a module name.
596 First check the modules dictionary if there's one there,
Walter Dörwaldf0dfc7a2003-10-20 14:01:56 +0000597 if not, create a new one and insert it in the modules dictionary.
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000598 Because the former action is most common, THIS DOES NOT RETURN A
599 'NEW' REFERENCE! */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000600
Guido van Rossum79f25d91997-04-29 20:08:16 +0000601PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000602PyImport_AddModule(const char *name)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000603{
Guido van Rossum25ce5661997-08-02 03:10:38 +0000604 PyObject *modules = PyImport_GetModuleDict();
Guido van Rossum79f25d91997-04-29 20:08:16 +0000605 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000606
Guido van Rossum25ce5661997-08-02 03:10:38 +0000607 if ((m = PyDict_GetItemString(modules, name)) != NULL &&
Guido van Rossum79f25d91997-04-29 20:08:16 +0000608 PyModule_Check(m))
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000609 return m;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000610 m = PyModule_New(name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000611 if (m == NULL)
612 return NULL;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000613 if (PyDict_SetItemString(modules, name, m) != 0) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000614 Py_DECREF(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000615 return NULL;
616 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000617 Py_DECREF(m); /* Yes, it still exists, in modules! */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000618
619 return m;
620}
621
Tim Peters1cd70172004-08-02 03:52:12 +0000622/* Remove name from sys.modules, if it's there. */
623static void
624_RemoveModule(const char *name)
625{
626 PyObject *modules = PyImport_GetModuleDict();
627 if (PyDict_GetItemString(modules, name) == NULL)
628 return;
629 if (PyDict_DelItemString(modules, name) < 0)
630 Py_FatalError("import: deleting existing key in"
631 "sys.modules failed");
632}
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000633
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000634/* Execute a code object in a module and return the module object
Tim Peters1cd70172004-08-02 03:52:12 +0000635 * WITH INCREMENTED REFERENCE COUNT. If an error occurs, name is
636 * removed from sys.modules, to avoid leaving damaged module objects
637 * in sys.modules. The caller may wish to restore the original
638 * module object (if any) in this case; PyImport_ReloadModule is an
639 * example.
640 */
Guido van Rossum79f25d91997-04-29 20:08:16 +0000641PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000642PyImport_ExecCodeModule(char *name, PyObject *co)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000643{
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000644 return PyImport_ExecCodeModuleEx(name, co, (char *)NULL);
645}
646
647PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000648PyImport_ExecCodeModuleEx(char *name, PyObject *co, char *pathname)
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000649{
Guido van Rossum25ce5661997-08-02 03:10:38 +0000650 PyObject *modules = PyImport_GetModuleDict();
Guido van Rossum79f25d91997-04-29 20:08:16 +0000651 PyObject *m, *d, *v;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000652
Guido van Rossum79f25d91997-04-29 20:08:16 +0000653 m = PyImport_AddModule(name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000654 if (m == NULL)
655 return NULL;
Jeremy Hyltonecd91292004-01-02 23:25:32 +0000656 /* If the module is being reloaded, we get the old module back
657 and re-use its dict to exec the new code. */
Guido van Rossum79f25d91997-04-29 20:08:16 +0000658 d = PyModule_GetDict(m);
659 if (PyDict_GetItemString(d, "__builtins__") == NULL) {
660 if (PyDict_SetItemString(d, "__builtins__",
661 PyEval_GetBuiltins()) != 0)
Tim Peters1cd70172004-08-02 03:52:12 +0000662 goto error;
Guido van Rossum6135a871995-01-09 17:53:26 +0000663 }
Guido van Rossum9c9a07c1996-05-16 20:43:40 +0000664 /* Remember the filename as the __file__ attribute */
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000665 v = NULL;
666 if (pathname != NULL) {
667 v = PyString_FromString(pathname);
668 if (v == NULL)
669 PyErr_Clear();
670 }
671 if (v == NULL) {
672 v = ((PyCodeObject *)co)->co_filename;
673 Py_INCREF(v);
674 }
675 if (PyDict_SetItemString(d, "__file__", v) != 0)
Guido van Rossum79f25d91997-04-29 20:08:16 +0000676 PyErr_Clear(); /* Not important enough to report */
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000677 Py_DECREF(v);
678
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000679 v = PyEval_EvalCode((PyCodeObject *)co, d, d);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000680 if (v == NULL)
Tim Peters1cd70172004-08-02 03:52:12 +0000681 goto error;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000682 Py_DECREF(v);
Guido van Rossumb65e85c1997-07-10 18:00:45 +0000683
Guido van Rossum25ce5661997-08-02 03:10:38 +0000684 if ((m = PyDict_GetItemString(modules, name)) == NULL) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000685 PyErr_Format(PyExc_ImportError,
686 "Loaded module %.200s not found in sys.modules",
687 name);
Guido van Rossumb65e85c1997-07-10 18:00:45 +0000688 return NULL;
689 }
690
Guido van Rossum79f25d91997-04-29 20:08:16 +0000691 Py_INCREF(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000692
693 return m;
Tim Peters1cd70172004-08-02 03:52:12 +0000694
695 error:
696 _RemoveModule(name);
697 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000698}
699
700
701/* Given a pathname for a Python source file, fill a buffer with the
702 pathname for the corresponding compiled file. Return the pathname
703 for the compiled file, or NULL if there's no space in the buffer.
704 Doesn't set an exception. */
705
706static char *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000707make_compiled_pathname(char *pathname, char *buf, size_t buflen)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000708{
Tim Petersc1731372001-08-04 08:12:36 +0000709 size_t len = strlen(pathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000710 if (len+2 > buflen)
711 return NULL;
Tim Petersc1731372001-08-04 08:12:36 +0000712
Martin v. Löwis6238d2b2002-06-30 15:26:10 +0000713#ifdef MS_WINDOWS
Tim Petersc1731372001-08-04 08:12:36 +0000714 /* Treat .pyw as if it were .py. The case of ".pyw" must match
715 that used in _PyImport_StandardFiletab. */
716 if (len >= 4 && strcmp(&pathname[len-4], ".pyw") == 0)
717 --len; /* pretend 'w' isn't there */
718#endif
719 memcpy(buf, pathname, len);
720 buf[len] = Py_OptimizeFlag ? 'o' : 'c';
721 buf[len+1] = '\0';
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000722
723 return buf;
724}
725
726
727/* Given a pathname for a Python source file, its time of last
728 modification, and a pathname for a compiled file, check whether the
729 compiled file represents the same version of the source. If so,
730 return a FILE pointer for the compiled file, positioned just after
731 the header; if not, return NULL.
732 Doesn't set an exception. */
733
734static FILE *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000735check_compiled_module(char *pathname, time_t mtime, char *cpathname)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000736{
737 FILE *fp;
738 long magic;
739 long pyc_mtime;
740
741 fp = fopen(cpathname, "rb");
742 if (fp == NULL)
743 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000744 magic = PyMarshal_ReadLongFromFile(fp);
Guido van Rossum96774c12000-05-01 20:19:08 +0000745 if (magic != pyc_magic) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000746 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000747 PySys_WriteStderr("# %s has bad magic\n", cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000748 fclose(fp);
749 return NULL;
750 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000751 pyc_mtime = PyMarshal_ReadLongFromFile(fp);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000752 if (pyc_mtime != mtime) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000753 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000754 PySys_WriteStderr("# %s has bad mtime\n", cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000755 fclose(fp);
756 return NULL;
757 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000758 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000759 PySys_WriteStderr("# %s matches %s\n", cpathname, pathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000760 return fp;
761}
762
763
764/* Read a code object from a file and check it for validity */
765
Guido van Rossum79f25d91997-04-29 20:08:16 +0000766static PyCodeObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000767read_compiled_module(char *cpathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000768{
Guido van Rossum79f25d91997-04-29 20:08:16 +0000769 PyObject *co;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000770
Tim Petersd9b9ac82001-01-28 00:27:39 +0000771 co = PyMarshal_ReadLastObjectFromFile(fp);
Armin Rigo01ab2792004-03-26 15:09:27 +0000772 if (co == NULL)
773 return NULL;
774 if (!PyCode_Check(co)) {
775 PyErr_Format(PyExc_ImportError,
776 "Non-code object in %.200s", cpathname);
777 Py_DECREF(co);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000778 return NULL;
779 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000780 return (PyCodeObject *)co;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000781}
782
783
784/* Load a module from a compiled file, execute it, and return its
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000785 module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000786
Guido van Rossum79f25d91997-04-29 20:08:16 +0000787static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000788load_compiled_module(char *name, char *cpathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000789{
790 long magic;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000791 PyCodeObject *co;
792 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000793
Guido van Rossum79f25d91997-04-29 20:08:16 +0000794 magic = PyMarshal_ReadLongFromFile(fp);
Guido van Rossum96774c12000-05-01 20:19:08 +0000795 if (magic != pyc_magic) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000796 PyErr_Format(PyExc_ImportError,
797 "Bad magic number in %.200s", cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000798 return NULL;
799 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000800 (void) PyMarshal_ReadLongFromFile(fp);
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000801 co = read_compiled_module(cpathname, fp);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000802 if (co == NULL)
803 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000804 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000805 PySys_WriteStderr("import %s # precompiled from %s\n",
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000806 name, cpathname);
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000807 m = PyImport_ExecCodeModuleEx(name, (PyObject *)co, cpathname);
Guido van Rossum79f25d91997-04-29 20:08:16 +0000808 Py_DECREF(co);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000809
810 return m;
811}
812
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000813/* Parse a source file and return the corresponding code object */
814
Guido van Rossum79f25d91997-04-29 20:08:16 +0000815static PyCodeObject *
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000816parse_source_module(const char *pathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000817{
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000818 PyCodeObject *co = NULL;
819 mod_ty mod;
Neal Norwitz2a399b02006-09-11 04:28:16 +0000820 PyArena *arena = PyArena_New();
821 if (arena == NULL)
822 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000823
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000824 mod = PyParser_ASTFromFile(fp, pathname, Py_file_input, 0, 0, 0,
Neal Norwitzadb69fc2005-12-17 20:54:49 +0000825 NULL, arena);
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000826 if (mod) {
Neal Norwitzadb69fc2005-12-17 20:54:49 +0000827 co = PyAST_Compile(mod, pathname, NULL, arena);
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000828 }
Neal Norwitz2a399b02006-09-11 04:28:16 +0000829 PyArena_Free(arena);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000830 return co;
831}
832
833
Guido van Rossum55a83382000-09-20 20:31:38 +0000834/* Helper to open a bytecode file for writing in exclusive mode */
835
836static FILE *
837open_exclusive(char *filename)
838{
839#if defined(O_EXCL)&&defined(O_CREAT)&&defined(O_WRONLY)&&defined(O_TRUNC)
840 /* Use O_EXCL to avoid a race condition when another process tries to
841 write the same file. When that happens, our open() call fails,
842 which is just fine (since it's only a cache).
843 XXX If the file exists and is writable but the directory is not
844 writable, the file will never be written. Oh well.
845 */
846 int fd;
847 (void) unlink(filename);
Tim Peters42c83af2000-09-29 04:03:10 +0000848 fd = open(filename, O_EXCL|O_CREAT|O_WRONLY|O_TRUNC
849#ifdef O_BINARY
850 |O_BINARY /* necessary for Windows */
851#endif
Martin v. Löwis79acb9e2002-12-06 12:48:53 +0000852#ifdef __VMS
Martin v. Löwis18e16552006-02-15 17:27:45 +0000853 , 0666, "ctxt=bin", "shr=nil"
Martin v. Löwis79acb9e2002-12-06 12:48:53 +0000854#else
Martin v. Löwis18e16552006-02-15 17:27:45 +0000855 , 0666
Martin v. Löwis79acb9e2002-12-06 12:48:53 +0000856#endif
Martin v. Löwis18e16552006-02-15 17:27:45 +0000857 );
Guido van Rossum55a83382000-09-20 20:31:38 +0000858 if (fd < 0)
859 return NULL;
860 return fdopen(fd, "wb");
861#else
862 /* Best we can do -- on Windows this can't happen anyway */
863 return fopen(filename, "wb");
864#endif
865}
866
867
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000868/* Write a compiled module to a file, placing the time of last
869 modification of its source into the header.
870 Errors are ignored, if a write error occurs an attempt is made to
871 remove the file. */
872
873static void
Martin v. Löwis18e16552006-02-15 17:27:45 +0000874write_compiled_module(PyCodeObject *co, char *cpathname, time_t mtime)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000875{
876 FILE *fp;
877
Guido van Rossum55a83382000-09-20 20:31:38 +0000878 fp = open_exclusive(cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000879 if (fp == NULL) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000880 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000881 PySys_WriteStderr(
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000882 "# can't create %s\n", cpathname);
883 return;
884 }
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000885 PyMarshal_WriteLongToFile(pyc_magic, fp, Py_MARSHAL_VERSION);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000886 /* First write a 0 for mtime */
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000887 PyMarshal_WriteLongToFile(0L, fp, Py_MARSHAL_VERSION);
888 PyMarshal_WriteObjectToFile((PyObject *)co, fp, Py_MARSHAL_VERSION);
Armin Rigo01ab2792004-03-26 15:09:27 +0000889 if (fflush(fp) != 0 || ferror(fp)) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000890 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000891 PySys_WriteStderr("# can't write %s\n", cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000892 /* Don't keep partial file */
893 fclose(fp);
894 (void) unlink(cpathname);
895 return;
896 }
897 /* Now write the true mtime */
898 fseek(fp, 4L, 0);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000899 assert(mtime < LONG_MAX);
Martin v. Löwis725507b2006-03-07 12:08:51 +0000900 PyMarshal_WriteLongToFile((long)mtime, fp, Py_MARSHAL_VERSION);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000901 fflush(fp);
902 fclose(fp);
Guido van Rossum79f25d91997-04-29 20:08:16 +0000903 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000904 PySys_WriteStderr("# wrote %s\n", cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000905}
906
907
908/* Load a source module from a given file and return its module
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000909 object WITH INCREMENTED REFERENCE COUNT. If there's a matching
910 byte-compiled file, use that instead. */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000911
Guido van Rossum79f25d91997-04-29 20:08:16 +0000912static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000913load_source_module(char *name, char *pathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000914{
Fred Drake4c82b232000-06-30 16:18:57 +0000915 time_t mtime;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000916 FILE *fpc;
917 char buf[MAXPATHLEN+1];
918 char *cpathname;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000919 PyCodeObject *co;
920 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000921
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000922 mtime = PyOS_GetLastModificationTime(pathname, fp);
Neal Norwitz708e51a2005-10-03 04:48:15 +0000923 if (mtime == (time_t)(-1)) {
924 PyErr_Format(PyExc_RuntimeError,
925 "unable to get modification time from '%s'",
926 pathname);
Fred Drake4c82b232000-06-30 16:18:57 +0000927 return NULL;
Neal Norwitz708e51a2005-10-03 04:48:15 +0000928 }
Fred Drake4c82b232000-06-30 16:18:57 +0000929#if SIZEOF_TIME_T > 4
930 /* Python's .pyc timestamp handling presumes that the timestamp fits
931 in 4 bytes. This will be fine until sometime in the year 2038,
932 when a 4-byte signed time_t will overflow.
933 */
934 if (mtime >> 32) {
935 PyErr_SetString(PyExc_OverflowError,
Fred Drakec63d3e92001-03-01 06:33:32 +0000936 "modification time overflows a 4 byte field");
Fred Drake4c82b232000-06-30 16:18:57 +0000937 return NULL;
938 }
939#endif
Tim Peters36515e22001-11-18 04:06:29 +0000940 cpathname = make_compiled_pathname(pathname, buf,
Jeremy Hylton37832f02001-04-13 17:50:20 +0000941 (size_t)MAXPATHLEN + 1);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000942 if (cpathname != NULL &&
943 (fpc = check_compiled_module(pathname, mtime, cpathname))) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000944 co = read_compiled_module(cpathname, fpc);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000945 fclose(fpc);
946 if (co == NULL)
947 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000948 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000949 PySys_WriteStderr("import %s # precompiled from %s\n",
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000950 name, cpathname);
Guido van Rossumafd3dae1998-08-25 18:44:34 +0000951 pathname = cpathname;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000952 }
953 else {
954 co = parse_source_module(pathname, fp);
955 if (co == NULL)
956 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000957 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000958 PySys_WriteStderr("import %s # from %s\n",
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000959 name, pathname);
Neal Norwitz3cb31ac2006-08-13 18:10:47 +0000960 if (cpathname)
961 write_compiled_module(co, cpathname, mtime);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000962 }
Guido van Rossumafd3dae1998-08-25 18:44:34 +0000963 m = PyImport_ExecCodeModuleEx(name, (PyObject *)co, pathname);
Guido van Rossum79f25d91997-04-29 20:08:16 +0000964 Py_DECREF(co);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000965
966 return m;
967}
968
969
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000970/* Forward */
Just van Rossum52e14d62002-12-30 22:08:05 +0000971static PyObject *load_module(char *, FILE *, char *, int, PyObject *);
972static struct filedescr *find_module(char *, char *, PyObject *,
973 char *, size_t, FILE **, PyObject **);
Tim Petersdbd9ba62000-07-09 03:09:57 +0000974static struct _frozen *find_frozen(char *name);
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000975
976/* Load a package and return its module object WITH INCREMENTED
977 REFERENCE COUNT */
978
979static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000980load_package(char *name, char *pathname)
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000981{
Tim Peters1cd70172004-08-02 03:52:12 +0000982 PyObject *m, *d;
983 PyObject *file = NULL;
984 PyObject *path = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000985 int err;
986 char buf[MAXPATHLEN+1];
987 FILE *fp = NULL;
988 struct filedescr *fdp;
989
990 m = PyImport_AddModule(name);
991 if (m == NULL)
992 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +0000993 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000994 PySys_WriteStderr("import %s # directory %s\n",
Guido van Rossum17fc85f1997-09-06 18:52:03 +0000995 name, pathname);
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000996 d = PyModule_GetDict(m);
997 file = PyString_FromString(pathname);
998 if (file == NULL)
Tim Peters1cd70172004-08-02 03:52:12 +0000999 goto error;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001000 path = Py_BuildValue("[O]", file);
Tim Peters1cd70172004-08-02 03:52:12 +00001001 if (path == NULL)
1002 goto error;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001003 err = PyDict_SetItemString(d, "__file__", file);
1004 if (err == 0)
1005 err = PyDict_SetItemString(d, "__path__", path);
Tim Peters1cd70172004-08-02 03:52:12 +00001006 if (err != 0)
1007 goto error;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001008 buf[0] = '\0';
Just van Rossum52e14d62002-12-30 22:08:05 +00001009 fdp = find_module(name, "__init__", path, buf, sizeof(buf), &fp, NULL);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001010 if (fdp == NULL) {
1011 if (PyErr_ExceptionMatches(PyExc_ImportError)) {
1012 PyErr_Clear();
Thomas Heller25653242004-06-07 15:04:10 +00001013 Py_INCREF(m);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001014 }
1015 else
1016 m = NULL;
1017 goto cleanup;
1018 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001019 m = load_module(name, fp, buf, fdp->type, NULL);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001020 if (fp != NULL)
1021 fclose(fp);
Tim Peters1cd70172004-08-02 03:52:12 +00001022 goto cleanup;
1023
1024 error:
1025 m = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001026 cleanup:
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001027 Py_XDECREF(path);
1028 Py_XDECREF(file);
1029 return m;
1030}
1031
1032
1033/* Helper to test for built-in module */
1034
1035static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001036is_builtin(char *name)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001037{
1038 int i;
Guido van Rossum771c6c81997-10-31 18:37:24 +00001039 for (i = 0; PyImport_Inittab[i].name != NULL; i++) {
1040 if (strcmp(name, PyImport_Inittab[i].name) == 0) {
1041 if (PyImport_Inittab[i].initfunc == NULL)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001042 return -1;
1043 else
1044 return 1;
1045 }
1046 }
1047 return 0;
1048}
1049
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001050
Just van Rossum52e14d62002-12-30 22:08:05 +00001051/* Return an importer object for a sys.path/pkg.__path__ item 'p',
1052 possibly by fetching it from the path_importer_cache dict. If it
Brett Cannon94b69f62006-09-28 22:10:14 +00001053 wasn't yet cached, traverse path_hooks until a hook is found
Just van Rossum52e14d62002-12-30 22:08:05 +00001054 that can handle the path item. Return None if no hook could;
1055 this tells our caller it should fall back to the builtin
1056 import mechanism. Cache the result in path_importer_cache.
1057 Returns a borrowed reference. */
1058
1059static PyObject *
1060get_path_importer(PyObject *path_importer_cache, PyObject *path_hooks,
1061 PyObject *p)
1062{
1063 PyObject *importer;
Martin v. Löwis725507b2006-03-07 12:08:51 +00001064 Py_ssize_t j, nhooks;
Just van Rossum52e14d62002-12-30 22:08:05 +00001065
1066 /* These conditions are the caller's responsibility: */
1067 assert(PyList_Check(path_hooks));
1068 assert(PyDict_Check(path_importer_cache));
1069
1070 nhooks = PyList_Size(path_hooks);
1071 if (nhooks < 0)
1072 return NULL; /* Shouldn't happen */
1073
1074 importer = PyDict_GetItem(path_importer_cache, p);
1075 if (importer != NULL)
1076 return importer;
1077
1078 /* set path_importer_cache[p] to None to avoid recursion */
1079 if (PyDict_SetItem(path_importer_cache, p, Py_None) != 0)
1080 return NULL;
1081
1082 for (j = 0; j < nhooks; j++) {
1083 PyObject *hook = PyList_GetItem(path_hooks, j);
1084 if (hook == NULL)
1085 return NULL;
Georg Brandl684fd0c2006-05-25 19:15:31 +00001086 importer = PyObject_CallFunctionObjArgs(hook, p, NULL);
Just van Rossum52e14d62002-12-30 22:08:05 +00001087 if (importer != NULL)
1088 break;
1089
1090 if (!PyErr_ExceptionMatches(PyExc_ImportError)) {
1091 return NULL;
1092 }
1093 PyErr_Clear();
1094 }
Phillip J. Ebyf7575d02006-07-28 21:12:07 +00001095 if (importer == NULL) {
1096 importer = PyObject_CallFunctionObjArgs(
1097 (PyObject *)&NullImporterType, p, NULL
1098 );
1099 if (importer == NULL) {
1100 if (PyErr_ExceptionMatches(PyExc_ImportError)) {
1101 PyErr_Clear();
1102 return Py_None;
1103 }
1104 }
1105 }
1106 if (importer != NULL) {
Just van Rossum52e14d62002-12-30 22:08:05 +00001107 int err = PyDict_SetItem(path_importer_cache, p, importer);
1108 Py_DECREF(importer);
1109 if (err != 0)
1110 return NULL;
1111 }
1112 return importer;
1113}
1114
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001115/* Search the path (default sys.path) for a module. Return the
1116 corresponding filedescr struct, and (via return arguments) the
1117 pathname and an open file. Return NULL if the module is not found. */
1118
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001119#ifdef MS_COREDLL
Thomas Woutersb4bd21c2000-07-22 23:38:01 +00001120extern FILE *PyWin_FindRegisteredModule(const char *, struct filedescr **,
Martin v. Löwis18e16552006-02-15 17:27:45 +00001121 char *, Py_ssize_t);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001122#endif
1123
Martin v. Löwis18e16552006-02-15 17:27:45 +00001124static int case_ok(char *, Py_ssize_t, Py_ssize_t, char *);
Tim Petersdbd9ba62000-07-09 03:09:57 +00001125static int find_init_module(char *); /* Forward */
Just van Rossum52e14d62002-12-30 22:08:05 +00001126static struct filedescr importhookdescr = {"", "", IMP_HOOK};
Guido van Rossum197346f1997-10-31 18:38:52 +00001127
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001128static struct filedescr *
Just van Rossum52e14d62002-12-30 22:08:05 +00001129find_module(char *fullname, char *subname, PyObject *path, char *buf,
1130 size_t buflen, FILE **p_fp, PyObject **p_loader)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001131{
Martin v. Löwis725507b2006-03-07 12:08:51 +00001132 Py_ssize_t i, npath;
Fred Drake4c82b232000-06-30 16:18:57 +00001133 size_t len, namelen;
Guido van Rossum80bb9651996-12-05 23:27:02 +00001134 struct filedescr *fdp = NULL;
Jack Jansenc88da1f2002-05-28 10:58:19 +00001135 char *filemode;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001136 FILE *fp = NULL;
Just van Rossum52e14d62002-12-30 22:08:05 +00001137 PyObject *path_hooks, *path_importer_cache;
Guido van Rossum48a680c2001-03-02 06:34:14 +00001138#ifndef RISCOS
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001139 struct stat statbuf;
Guido van Rossum48a680c2001-03-02 06:34:14 +00001140#endif
Guido van Rossuma5568d31998-03-05 03:45:08 +00001141 static struct filedescr fd_frozen = {"", "", PY_FROZEN};
1142 static struct filedescr fd_builtin = {"", "", C_BUILTIN};
1143 static struct filedescr fd_package = {"", "", PKG_DIRECTORY};
Guido van Rossum0506a431998-08-11 15:07:39 +00001144 char name[MAXPATHLEN+1];
Andrew MacIntyred9400542002-02-26 11:41:34 +00001145#if defined(PYOS_OS2)
1146 size_t saved_len;
1147 size_t saved_namelen;
1148 char *saved_buf = NULL;
1149#endif
Just van Rossum52e14d62002-12-30 22:08:05 +00001150 if (p_loader != NULL)
1151 *p_loader = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001152
Just van Rossum52e14d62002-12-30 22:08:05 +00001153 if (strlen(subname) > MAXPATHLEN) {
Guido van Rossum8f4d3312001-10-18 18:54:11 +00001154 PyErr_SetString(PyExc_OverflowError,
1155 "module name is too long");
Fred Drake4c82b232000-06-30 16:18:57 +00001156 return NULL;
1157 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001158 strcpy(name, subname);
1159
1160 /* sys.meta_path import hook */
1161 if (p_loader != NULL) {
1162 PyObject *meta_path;
1163
1164 meta_path = PySys_GetObject("meta_path");
1165 if (meta_path == NULL || !PyList_Check(meta_path)) {
1166 PyErr_SetString(PyExc_ImportError,
1167 "sys.meta_path must be a list of "
1168 "import hooks");
1169 return NULL;
1170 }
1171 Py_INCREF(meta_path); /* zap guard */
1172 npath = PyList_Size(meta_path);
1173 for (i = 0; i < npath; i++) {
1174 PyObject *loader;
1175 PyObject *hook = PyList_GetItem(meta_path, i);
1176 loader = PyObject_CallMethod(hook, "find_module",
1177 "sO", fullname,
1178 path != NULL ?
1179 path : Py_None);
1180 if (loader == NULL) {
1181 Py_DECREF(meta_path);
1182 return NULL; /* true error */
1183 }
1184 if (loader != Py_None) {
1185 /* a loader was found */
1186 *p_loader = loader;
1187 Py_DECREF(meta_path);
1188 return &importhookdescr;
1189 }
1190 Py_DECREF(loader);
1191 }
1192 Py_DECREF(meta_path);
1193 }
Guido van Rossum0506a431998-08-11 15:07:39 +00001194
1195 if (path != NULL && PyString_Check(path)) {
Guido van Rossum8f4d3312001-10-18 18:54:11 +00001196 /* The only type of submodule allowed inside a "frozen"
1197 package are other frozen modules or packages. */
Guido van Rossum0506a431998-08-11 15:07:39 +00001198 if (PyString_Size(path) + 1 + strlen(name) >= (size_t)buflen) {
1199 PyErr_SetString(PyExc_ImportError,
1200 "full frozen module name too long");
1201 return NULL;
1202 }
1203 strcpy(buf, PyString_AsString(path));
1204 strcat(buf, ".");
1205 strcat(buf, name);
1206 strcpy(name, buf);
Guido van Rossum8f4d3312001-10-18 18:54:11 +00001207 if (find_frozen(name) != NULL) {
1208 strcpy(buf, name);
1209 return &fd_frozen;
1210 }
1211 PyErr_Format(PyExc_ImportError,
1212 "No frozen submodule named %.200s", name);
1213 return NULL;
Guido van Rossum0506a431998-08-11 15:07:39 +00001214 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001215 if (path == NULL) {
1216 if (is_builtin(name)) {
Guido van Rossuma5568d31998-03-05 03:45:08 +00001217 strcpy(buf, name);
1218 return &fd_builtin;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001219 }
Greg Ward201baee2001-10-04 14:52:06 +00001220 if ((find_frozen(name)) != NULL) {
Guido van Rossuma5568d31998-03-05 03:45:08 +00001221 strcpy(buf, name);
1222 return &fd_frozen;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001223 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001224
Guido van Rossumac279101996-08-22 23:10:58 +00001225#ifdef MS_COREDLL
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001226 fp = PyWin_FindRegisteredModule(name, &fdp, buf, buflen);
1227 if (fp != NULL) {
1228 *p_fp = fp;
1229 return fdp;
1230 }
Guido van Rossuma5a3db71996-04-09 02:39:59 +00001231#endif
Guido van Rossuma5568d31998-03-05 03:45:08 +00001232 path = PySys_GetObject("path");
1233 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00001234 if (path == NULL || !PyList_Check(path)) {
1235 PyErr_SetString(PyExc_ImportError,
Guido van Rossuma5568d31998-03-05 03:45:08 +00001236 "sys.path must be a list of directory names");
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001237 return NULL;
1238 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001239
1240 path_hooks = PySys_GetObject("path_hooks");
1241 if (path_hooks == NULL || !PyList_Check(path_hooks)) {
1242 PyErr_SetString(PyExc_ImportError,
1243 "sys.path_hooks must be a list of "
1244 "import hooks");
1245 return NULL;
1246 }
1247 path_importer_cache = PySys_GetObject("path_importer_cache");
1248 if (path_importer_cache == NULL ||
1249 !PyDict_Check(path_importer_cache)) {
1250 PyErr_SetString(PyExc_ImportError,
1251 "sys.path_importer_cache must be a dict");
1252 return NULL;
1253 }
1254
Guido van Rossum79f25d91997-04-29 20:08:16 +00001255 npath = PyList_Size(path);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001256 namelen = strlen(name);
1257 for (i = 0; i < npath; i++) {
Walter Dörwald3430d702002-06-17 10:43:59 +00001258 PyObject *copy = NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +00001259 PyObject *v = PyList_GetItem(path, i);
Neal Norwitz3cb31ac2006-08-13 18:10:47 +00001260 if (!v)
1261 return NULL;
Walter Dörwald3430d702002-06-17 10:43:59 +00001262#ifdef Py_USING_UNICODE
1263 if (PyUnicode_Check(v)) {
1264 copy = PyUnicode_Encode(PyUnicode_AS_UNICODE(v),
1265 PyUnicode_GET_SIZE(v), Py_FileSystemDefaultEncoding, NULL);
1266 if (copy == NULL)
1267 return NULL;
1268 v = copy;
1269 }
1270 else
1271#endif
Guido van Rossum79f25d91997-04-29 20:08:16 +00001272 if (!PyString_Check(v))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001273 continue;
Neal Norwitz2aa9a5d2006-03-20 01:53:23 +00001274 len = PyString_GET_SIZE(v);
Walter Dörwald3430d702002-06-17 10:43:59 +00001275 if (len + 2 + namelen + MAXSUFFIXSIZE >= buflen) {
1276 Py_XDECREF(copy);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001277 continue; /* Too long */
Walter Dörwald3430d702002-06-17 10:43:59 +00001278 }
Neal Norwitz2aa9a5d2006-03-20 01:53:23 +00001279 strcpy(buf, PyString_AS_STRING(v));
Walter Dörwald3430d702002-06-17 10:43:59 +00001280 if (strlen(buf) != len) {
1281 Py_XDECREF(copy);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001282 continue; /* v contains '\0' */
Walter Dörwald3430d702002-06-17 10:43:59 +00001283 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001284
1285 /* sys.path_hooks import hook */
1286 if (p_loader != NULL) {
1287 PyObject *importer;
1288
1289 importer = get_path_importer(path_importer_cache,
1290 path_hooks, v);
Neal Norwitza4df11d2006-07-06 04:28:59 +00001291 if (importer == NULL) {
1292 Py_XDECREF(copy);
Just van Rossum52e14d62002-12-30 22:08:05 +00001293 return NULL;
Neal Norwitza4df11d2006-07-06 04:28:59 +00001294 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001295 /* Note: importer is a borrowed reference */
Phillip J. Ebyf7575d02006-07-28 21:12:07 +00001296 if (importer != Py_None) {
Just van Rossum52e14d62002-12-30 22:08:05 +00001297 PyObject *loader;
1298 loader = PyObject_CallMethod(importer,
1299 "find_module",
1300 "s", fullname);
Neal Norwitza4df11d2006-07-06 04:28:59 +00001301 Py_XDECREF(copy);
Just van Rossum52e14d62002-12-30 22:08:05 +00001302 if (loader == NULL)
1303 return NULL; /* error */
1304 if (loader != Py_None) {
1305 /* a loader was found */
1306 *p_loader = loader;
1307 return &importhookdescr;
1308 }
1309 Py_DECREF(loader);
Georg Brandlf4ef1162006-05-26 18:03:31 +00001310 continue;
Just van Rossum52e14d62002-12-30 22:08:05 +00001311 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001312 }
Georg Brandlf4ef1162006-05-26 18:03:31 +00001313 /* no hook was found, use builtin import */
Just van Rossum52e14d62002-12-30 22:08:05 +00001314
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001315 if (len > 0 && buf[len-1] != SEP
1316#ifdef ALTSEP
1317 && buf[len-1] != ALTSEP
1318#endif
1319 )
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001320 buf[len++] = SEP;
Guido van Rossum215c3402000-11-13 17:26:32 +00001321 strcpy(buf+len, name);
1322 len += namelen;
Tim Peters50d8d372001-02-28 05:34:27 +00001323
1324 /* Check for package import (buf holds a directory name,
1325 and there's an __init__ module in that directory */
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001326#ifdef HAVE_STAT
Walter Dörwald3430d702002-06-17 10:43:59 +00001327 if (stat(buf, &statbuf) == 0 && /* it exists */
1328 S_ISDIR(statbuf.st_mode) && /* it's a directory */
Thomas Wouters9df4e6f2006-04-27 23:13:20 +00001329 case_ok(buf, len, namelen, name)) { /* case matches */
1330 if (find_init_module(buf)) { /* and has __init__.py */
1331 Py_XDECREF(copy);
1332 return &fd_package;
1333 }
1334 else {
1335 char warnstr[MAXPATHLEN+80];
1336 sprintf(warnstr, "Not importing directory "
1337 "'%.*s': missing __init__.py",
1338 MAXPATHLEN, buf);
1339 if (PyErr_Warn(PyExc_ImportWarning,
1340 warnstr)) {
1341 Py_XDECREF(copy);
1342 return NULL;
1343 }
1344 }
Walter Dörwald3430d702002-06-17 10:43:59 +00001345 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001346#else
1347 /* XXX How are you going to test for directories? */
Guido van Rossum48a680c2001-03-02 06:34:14 +00001348#ifdef RISCOS
Guido van Rossume2ae77b2001-10-24 20:42:55 +00001349 if (isdir(buf) &&
Walter Dörwald3430d702002-06-17 10:43:59 +00001350 case_ok(buf, len, namelen, name)) {
Thomas Wouters9df4e6f2006-04-27 23:13:20 +00001351 if (find_init_module(buf)) {
1352 Py_XDECREF(copy);
1353 return &fd_package;
1354 }
1355 else {
1356 char warnstr[MAXPATHLEN+80];
1357 sprintf(warnstr, "Not importing directory "
1358 "'%.*s': missing __init__.py",
1359 MAXPATHLEN, buf);
1360 if (PyErr_Warn(PyExc_ImportWarning,
1361 warnstr)) {
1362 Py_XDECREF(copy);
1363 return NULL;
1364 }
Walter Dörwald3430d702002-06-17 10:43:59 +00001365 }
Guido van Rossum48a680c2001-03-02 06:34:14 +00001366#endif
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001367#endif
Andrew MacIntyred9400542002-02-26 11:41:34 +00001368#if defined(PYOS_OS2)
1369 /* take a snapshot of the module spec for restoration
1370 * after the 8 character DLL hackery
1371 */
1372 saved_buf = strdup(buf);
1373 saved_len = len;
1374 saved_namelen = namelen;
1375#endif /* PYOS_OS2 */
Guido van Rossum79f25d91997-04-29 20:08:16 +00001376 for (fdp = _PyImport_Filetab; fdp->suffix != NULL; fdp++) {
Andrew MacIntyred9400542002-02-26 11:41:34 +00001377#if defined(PYOS_OS2)
Jeremy Hylton4ae6fae2002-05-30 17:15:25 +00001378 /* OS/2 limits DLLs to 8 character names (w/o
1379 extension)
Andrew MacIntyred9400542002-02-26 11:41:34 +00001380 * so if the name is longer than that and its a
1381 * dynamically loaded module we're going to try,
1382 * truncate the name before trying
1383 */
Just van Rossum52e14d62002-12-30 22:08:05 +00001384 if (strlen(subname) > 8) {
Andrew MacIntyred9400542002-02-26 11:41:34 +00001385 /* is this an attempt to load a C extension? */
Jeremy Hylton4ae6fae2002-05-30 17:15:25 +00001386 const struct filedescr *scan;
1387 scan = _PyImport_DynLoadFiletab;
Andrew MacIntyred9400542002-02-26 11:41:34 +00001388 while (scan->suffix != NULL) {
Jeremy Hylton4ae6fae2002-05-30 17:15:25 +00001389 if (!strcmp(scan->suffix, fdp->suffix))
Andrew MacIntyred9400542002-02-26 11:41:34 +00001390 break;
1391 else
1392 scan++;
1393 }
1394 if (scan->suffix != NULL) {
1395 /* yes, so truncate the name */
1396 namelen = 8;
Just van Rossum52e14d62002-12-30 22:08:05 +00001397 len -= strlen(subname) - namelen;
Andrew MacIntyred9400542002-02-26 11:41:34 +00001398 buf[len] = '\0';
1399 }
1400 }
1401#endif /* PYOS_OS2 */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001402 strcpy(buf+len, fdp->suffix);
Guido van Rossum79f25d91997-04-29 20:08:16 +00001403 if (Py_VerboseFlag > 1)
Guido van Rossum2f3667a1998-10-12 18:23:55 +00001404 PySys_WriteStderr("# trying %s\n", buf);
Jack Jansenc88da1f2002-05-28 10:58:19 +00001405 filemode = fdp->mode;
Tim Peters86c7d2f2004-08-01 23:24:21 +00001406 if (filemode[0] == 'U')
Jeremy Hylton4ae6fae2002-05-30 17:15:25 +00001407 filemode = "r" PY_STDIOTEXTMODE;
Jack Jansenc88da1f2002-05-28 10:58:19 +00001408 fp = fopen(buf, filemode);
Tim Peters50d8d372001-02-28 05:34:27 +00001409 if (fp != NULL) {
1410 if (case_ok(buf, len, namelen, name))
1411 break;
1412 else { /* continue search */
1413 fclose(fp);
1414 fp = NULL;
Barry Warsaw914a0b12001-02-02 19:12:16 +00001415 }
Barry Warsaw914a0b12001-02-02 19:12:16 +00001416 }
Andrew MacIntyred9400542002-02-26 11:41:34 +00001417#if defined(PYOS_OS2)
1418 /* restore the saved snapshot */
1419 strcpy(buf, saved_buf);
1420 len = saved_len;
1421 namelen = saved_namelen;
1422#endif
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001423 }
Andrew MacIntyred9400542002-02-26 11:41:34 +00001424#if defined(PYOS_OS2)
1425 /* don't need/want the module name snapshot anymore */
1426 if (saved_buf)
1427 {
1428 free(saved_buf);
1429 saved_buf = NULL;
1430 }
1431#endif
Walter Dörwald3430d702002-06-17 10:43:59 +00001432 Py_XDECREF(copy);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001433 if (fp != NULL)
1434 break;
1435 }
1436 if (fp == NULL) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001437 PyErr_Format(PyExc_ImportError,
1438 "No module named %.200s", name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001439 return NULL;
1440 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001441 *p_fp = fp;
1442 return fdp;
1443}
1444
Raymond Hettingerdb29e0f2004-10-07 06:46:25 +00001445/* Helpers for main.c
1446 * Find the source file corresponding to a named module
1447 */
1448struct filedescr *
1449_PyImport_FindModule(const char *name, PyObject *path, char *buf,
1450 size_t buflen, FILE **p_fp, PyObject **p_loader)
1451{
1452 return find_module((char *) name, (char *) name, path,
1453 buf, buflen, p_fp, p_loader);
1454}
1455
1456PyAPI_FUNC(int) _PyImport_IsScript(struct filedescr * fd)
1457{
1458 return fd->type == PY_SOURCE || fd->type == PY_COMPILED;
1459}
1460
Martin v. Löwis18e16552006-02-15 17:27:45 +00001461/* case_ok(char* buf, Py_ssize_t len, Py_ssize_t namelen, char* name)
Tim Petersd1e87a82001-03-01 18:12:00 +00001462 * The arguments here are tricky, best shown by example:
1463 * /a/b/c/d/e/f/g/h/i/j/k/some_long_module_name.py\0
1464 * ^ ^ ^ ^
1465 * |--------------------- buf ---------------------|
1466 * |------------------- len ------------------|
1467 * |------ name -------|
1468 * |----- namelen -----|
1469 * buf is the full path, but len only counts up to (& exclusive of) the
1470 * extension. name is the module name, also exclusive of extension.
1471 *
1472 * We've already done a successful stat() or fopen() on buf, so know that
1473 * there's some match, possibly case-insensitive.
1474 *
Tim Peters50d8d372001-02-28 05:34:27 +00001475 * case_ok() is to return 1 if there's a case-sensitive match for
1476 * name, else 0. case_ok() is also to return 1 if envar PYTHONCASEOK
1477 * exists.
Tim Petersd1e87a82001-03-01 18:12:00 +00001478 *
Tim Peters50d8d372001-02-28 05:34:27 +00001479 * case_ok() is used to implement case-sensitive import semantics even
1480 * on platforms with case-insensitive filesystems. It's trivial to implement
1481 * for case-sensitive filesystems. It's pretty much a cross-platform
1482 * nightmare for systems with case-insensitive filesystems.
1483 */
Guido van Rossum0980bd91998-02-13 17:18:36 +00001484
Tim Peters50d8d372001-02-28 05:34:27 +00001485/* First we may need a pile of platform-specific header files; the sequence
1486 * of #if's here should match the sequence in the body of case_ok().
1487 */
Jason Tishler7961aa62005-05-20 00:56:54 +00001488#if defined(MS_WINDOWS)
Guido van Rossum0980bd91998-02-13 17:18:36 +00001489#include <windows.h>
Guido van Rossum4c3f57c2001-01-10 20:40:46 +00001490
Tim Peters50d8d372001-02-28 05:34:27 +00001491#elif defined(DJGPP)
1492#include <dir.h>
1493
Jason Tishler7961aa62005-05-20 00:56:54 +00001494#elif (defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) && defined(HAVE_DIRENT_H)
Tim Peters430f5d42001-03-01 01:30:56 +00001495#include <sys/types.h>
1496#include <dirent.h>
1497
Andrew MacIntyred9400542002-02-26 11:41:34 +00001498#elif defined(PYOS_OS2)
1499#define INCL_DOS
1500#define INCL_DOSERRORS
1501#define INCL_NOPMAPI
1502#include <os2.h>
1503
Guido van Rossume2ae77b2001-10-24 20:42:55 +00001504#elif defined(RISCOS)
1505#include "oslib/osfscontrol.h"
Tim Peters50d8d372001-02-28 05:34:27 +00001506#endif
1507
Guido van Rossum0980bd91998-02-13 17:18:36 +00001508static int
Martin v. Löwis18e16552006-02-15 17:27:45 +00001509case_ok(char *buf, Py_ssize_t len, Py_ssize_t namelen, char *name)
Guido van Rossum0980bd91998-02-13 17:18:36 +00001510{
Tim Peters50d8d372001-02-28 05:34:27 +00001511/* Pick a platform-specific implementation; the sequence of #if's here should
1512 * match the sequence just above.
1513 */
1514
Jason Tishler7961aa62005-05-20 00:56:54 +00001515/* MS_WINDOWS */
1516#if defined(MS_WINDOWS)
Guido van Rossum0980bd91998-02-13 17:18:36 +00001517 WIN32_FIND_DATA data;
1518 HANDLE h;
Tim Peters50d8d372001-02-28 05:34:27 +00001519
Neil Schemenauer7d4bb9f2001-07-23 16:30:27 +00001520 if (Py_GETENV("PYTHONCASEOK") != NULL)
Guido van Rossum0980bd91998-02-13 17:18:36 +00001521 return 1;
Tim Peters50d8d372001-02-28 05:34:27 +00001522
Guido van Rossum0980bd91998-02-13 17:18:36 +00001523 h = FindFirstFile(buf, &data);
1524 if (h == INVALID_HANDLE_VALUE) {
1525 PyErr_Format(PyExc_NameError,
1526 "Can't find file for module %.100s\n(filename %.300s)",
1527 name, buf);
1528 return 0;
1529 }
1530 FindClose(h);
Tim Peters50d8d372001-02-28 05:34:27 +00001531 return strncmp(data.cFileName, name, namelen) == 0;
1532
1533/* DJGPP */
1534#elif defined(DJGPP)
1535 struct ffblk ffblk;
1536 int done;
1537
Neil Schemenauer7d4bb9f2001-07-23 16:30:27 +00001538 if (Py_GETENV("PYTHONCASEOK") != NULL)
Guido van Rossum323bf5e1998-06-24 03:54:06 +00001539 return 1;
Tim Peters50d8d372001-02-28 05:34:27 +00001540
1541 done = findfirst(buf, &ffblk, FA_ARCH|FA_RDONLY|FA_HIDDEN|FA_DIREC);
1542 if (done) {
Guido van Rossum0980bd91998-02-13 17:18:36 +00001543 PyErr_Format(PyExc_NameError,
Tim Peters50d8d372001-02-28 05:34:27 +00001544 "Can't find file for module %.100s\n(filename %.300s)",
Guido van Rossum0980bd91998-02-13 17:18:36 +00001545 name, buf);
1546 return 0;
1547 }
Tim Peters50d8d372001-02-28 05:34:27 +00001548 return strncmp(ffblk.ff_name, name, namelen) == 0;
Guido van Rossum0980bd91998-02-13 17:18:36 +00001549
Jason Tishler7961aa62005-05-20 00:56:54 +00001550/* new-fangled macintosh (macosx) or Cygwin */
1551#elif (defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) && defined(HAVE_DIRENT_H)
Tim Peters430f5d42001-03-01 01:30:56 +00001552 DIR *dirp;
1553 struct dirent *dp;
Tim Petersd1e87a82001-03-01 18:12:00 +00001554 char dirname[MAXPATHLEN + 1];
1555 const int dirlen = len - namelen - 1; /* don't want trailing SEP */
Tim Peters430f5d42001-03-01 01:30:56 +00001556
Neil Schemenauer7d4bb9f2001-07-23 16:30:27 +00001557 if (Py_GETENV("PYTHONCASEOK") != NULL)
Tim Petersdbe6ebb2001-03-01 08:47:29 +00001558 return 1;
1559
Tim Petersd1e87a82001-03-01 18:12:00 +00001560 /* Copy the dir component into dirname; substitute "." if empty */
1561 if (dirlen <= 0) {
1562 dirname[0] = '.';
1563 dirname[1] = '\0';
Tim Peters430f5d42001-03-01 01:30:56 +00001564 }
1565 else {
Tim Petersd1e87a82001-03-01 18:12:00 +00001566 assert(dirlen <= MAXPATHLEN);
1567 memcpy(dirname, buf, dirlen);
1568 dirname[dirlen] = '\0';
Tim Peters430f5d42001-03-01 01:30:56 +00001569 }
1570 /* Open the directory and search the entries for an exact match. */
Tim Petersd1e87a82001-03-01 18:12:00 +00001571 dirp = opendir(dirname);
Tim Peters430f5d42001-03-01 01:30:56 +00001572 if (dirp) {
Tim Peters677898a2001-03-02 03:28:03 +00001573 char *nameWithExt = buf + len - namelen;
Tim Peters430f5d42001-03-01 01:30:56 +00001574 while ((dp = readdir(dirp)) != NULL) {
Tim Petersdbe6ebb2001-03-01 08:47:29 +00001575 const int thislen =
Tim Peters430f5d42001-03-01 01:30:56 +00001576#ifdef _DIRENT_HAVE_D_NAMELEN
Tim Petersdbe6ebb2001-03-01 08:47:29 +00001577 dp->d_namlen;
Tim Peters430f5d42001-03-01 01:30:56 +00001578#else
Tim Petersdbe6ebb2001-03-01 08:47:29 +00001579 strlen(dp->d_name);
Tim Peters430f5d42001-03-01 01:30:56 +00001580#endif
Tim Petersd1e87a82001-03-01 18:12:00 +00001581 if (thislen >= namelen &&
Tim Peters677898a2001-03-02 03:28:03 +00001582 strcmp(dp->d_name, nameWithExt) == 0) {
Tim Peters430f5d42001-03-01 01:30:56 +00001583 (void)closedir(dirp);
1584 return 1; /* Found */
1585 }
1586 }
Tim Petersdbe6ebb2001-03-01 08:47:29 +00001587 (void)closedir(dirp);
Tim Peters430f5d42001-03-01 01:30:56 +00001588 }
Tim Peters430f5d42001-03-01 01:30:56 +00001589 return 0 ; /* Not found */
Tim Peters430f5d42001-03-01 01:30:56 +00001590
Guido van Rossume2ae77b2001-10-24 20:42:55 +00001591/* RISC OS */
1592#elif defined(RISCOS)
1593 char canon[MAXPATHLEN+1]; /* buffer for the canonical form of the path */
1594 char buf2[MAXPATHLEN+2];
1595 char *nameWithExt = buf+len-namelen;
1596 int canonlen;
1597 os_error *e;
1598
1599 if (Py_GETENV("PYTHONCASEOK") != NULL)
1600 return 1;
1601
1602 /* workaround:
1603 append wildcard, otherwise case of filename wouldn't be touched */
1604 strcpy(buf2, buf);
1605 strcat(buf2, "*");
1606
1607 e = xosfscontrol_canonicalise_path(buf2,canon,0,0,MAXPATHLEN+1,&canonlen);
1608 canonlen = MAXPATHLEN+1-canonlen;
1609 if (e || canonlen<=0 || canonlen>(MAXPATHLEN+1) )
1610 return 0;
1611 if (strcmp(nameWithExt, canon+canonlen-strlen(nameWithExt))==0)
1612 return 1; /* match */
1613
1614 return 0;
1615
Andrew MacIntyred9400542002-02-26 11:41:34 +00001616/* OS/2 */
1617#elif defined(PYOS_OS2)
1618 HDIR hdir = 1;
1619 ULONG srchcnt = 1;
1620 FILEFINDBUF3 ffbuf;
1621 APIRET rc;
1622
1623 if (getenv("PYTHONCASEOK") != NULL)
1624 return 1;
1625
1626 rc = DosFindFirst(buf,
1627 &hdir,
1628 FILE_READONLY | FILE_HIDDEN | FILE_SYSTEM | FILE_DIRECTORY,
1629 &ffbuf, sizeof(ffbuf),
1630 &srchcnt,
1631 FIL_STANDARD);
1632 if (rc != NO_ERROR)
1633 return 0;
1634 return strncmp(ffbuf.achName, name, namelen) == 0;
1635
Tim Peters50d8d372001-02-28 05:34:27 +00001636/* assuming it's a case-sensitive filesystem, so there's nothing to do! */
1637#else
Guido van Rossum0980bd91998-02-13 17:18:36 +00001638 return 1;
Guido van Rossum0980bd91998-02-13 17:18:36 +00001639
Guido van Rossum4d1b3b91998-02-13 23:27:59 +00001640#endif
Tim Peters50d8d372001-02-28 05:34:27 +00001641}
Guido van Rossum4d1b3b91998-02-13 23:27:59 +00001642
Guido van Rossum0980bd91998-02-13 17:18:36 +00001643
Guido van Rossum197346f1997-10-31 18:38:52 +00001644#ifdef HAVE_STAT
1645/* Helper to look for __init__.py or __init__.py[co] in potential package */
1646static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001647find_init_module(char *buf)
Guido van Rossum197346f1997-10-31 18:38:52 +00001648{
Tim Peters0f9431f2001-07-05 03:47:53 +00001649 const size_t save_len = strlen(buf);
Fred Drake4c82b232000-06-30 16:18:57 +00001650 size_t i = save_len;
Tim Peters0f9431f2001-07-05 03:47:53 +00001651 char *pname; /* pointer to start of __init__ */
Guido van Rossum197346f1997-10-31 18:38:52 +00001652 struct stat statbuf;
1653
Tim Peters0f9431f2001-07-05 03:47:53 +00001654/* For calling case_ok(buf, len, namelen, name):
1655 * /a/b/c/d/e/f/g/h/i/j/k/some_long_module_name.py\0
1656 * ^ ^ ^ ^
1657 * |--------------------- buf ---------------------|
1658 * |------------------- len ------------------|
1659 * |------ name -------|
1660 * |----- namelen -----|
1661 */
Guido van Rossum197346f1997-10-31 18:38:52 +00001662 if (save_len + 13 >= MAXPATHLEN)
1663 return 0;
1664 buf[i++] = SEP;
Tim Peters0f9431f2001-07-05 03:47:53 +00001665 pname = buf + i;
1666 strcpy(pname, "__init__.py");
Guido van Rossum197346f1997-10-31 18:38:52 +00001667 if (stat(buf, &statbuf) == 0) {
Tim Peters0f9431f2001-07-05 03:47:53 +00001668 if (case_ok(buf,
1669 save_len + 9, /* len("/__init__") */
1670 8, /* len("__init__") */
1671 pname)) {
1672 buf[save_len] = '\0';
1673 return 1;
1674 }
Guido van Rossum197346f1997-10-31 18:38:52 +00001675 }
Tim Peters0f9431f2001-07-05 03:47:53 +00001676 i += strlen(pname);
1677 strcpy(buf+i, Py_OptimizeFlag ? "o" : "c");
Guido van Rossum197346f1997-10-31 18:38:52 +00001678 if (stat(buf, &statbuf) == 0) {
Tim Peters0f9431f2001-07-05 03:47:53 +00001679 if (case_ok(buf,
1680 save_len + 9, /* len("/__init__") */
1681 8, /* len("__init__") */
1682 pname)) {
1683 buf[save_len] = '\0';
1684 return 1;
1685 }
Guido van Rossum197346f1997-10-31 18:38:52 +00001686 }
1687 buf[save_len] = '\0';
1688 return 0;
1689}
Guido van Rossum48a680c2001-03-02 06:34:14 +00001690
1691#else
1692
1693#ifdef RISCOS
1694static int
1695find_init_module(buf)
1696 char *buf;
1697{
1698 int save_len = strlen(buf);
1699 int i = save_len;
1700
1701 if (save_len + 13 >= MAXPATHLEN)
1702 return 0;
1703 buf[i++] = SEP;
1704 strcpy(buf+i, "__init__/py");
1705 if (isfile(buf)) {
1706 buf[save_len] = '\0';
1707 return 1;
1708 }
1709
1710 if (Py_OptimizeFlag)
1711 strcpy(buf+i, "o");
1712 else
1713 strcpy(buf+i, "c");
1714 if (isfile(buf)) {
1715 buf[save_len] = '\0';
1716 return 1;
1717 }
1718 buf[save_len] = '\0';
1719 return 0;
1720}
1721#endif /*RISCOS*/
1722
Guido van Rossum197346f1997-10-31 18:38:52 +00001723#endif /* HAVE_STAT */
1724
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001725
Tim Petersdbd9ba62000-07-09 03:09:57 +00001726static int init_builtin(char *); /* Forward */
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001727
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001728/* Load an external module using the default search path and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001729 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001730
Guido van Rossum79f25d91997-04-29 20:08:16 +00001731static PyObject *
Just van Rossum52e14d62002-12-30 22:08:05 +00001732load_module(char *name, FILE *fp, char *buf, int type, PyObject *loader)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001733{
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001734 PyObject *modules;
Guido van Rossum79f25d91997-04-29 20:08:16 +00001735 PyObject *m;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001736 int err;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001737
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001738 /* First check that there's an open file (if we need one) */
1739 switch (type) {
1740 case PY_SOURCE:
1741 case PY_COMPILED:
1742 if (fp == NULL) {
1743 PyErr_Format(PyExc_ValueError,
1744 "file object required for import (type code %d)",
1745 type);
1746 return NULL;
1747 }
1748 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001749
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001750 switch (type) {
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001751
1752 case PY_SOURCE:
1753 m = load_source_module(name, buf, fp);
1754 break;
1755
1756 case PY_COMPILED:
1757 m = load_compiled_module(name, buf, fp);
1758 break;
1759
Guido van Rossum96a8fb71999-12-22 14:09:35 +00001760#ifdef HAVE_DYNAMIC_LOADING
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001761 case C_EXTENSION:
Guido van Rossum79f25d91997-04-29 20:08:16 +00001762 m = _PyImport_LoadDynamicModule(name, buf, fp);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001763 break;
Guido van Rossum96a8fb71999-12-22 14:09:35 +00001764#endif
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001765
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001766 case PKG_DIRECTORY:
1767 m = load_package(name, buf);
1768 break;
1769
1770 case C_BUILTIN:
1771 case PY_FROZEN:
Guido van Rossuma5568d31998-03-05 03:45:08 +00001772 if (buf != NULL && buf[0] != '\0')
1773 name = buf;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001774 if (type == C_BUILTIN)
1775 err = init_builtin(name);
1776 else
1777 err = PyImport_ImportFrozenModule(name);
1778 if (err < 0)
Guido van Rossuma86f77d1997-09-09 18:53:47 +00001779 return NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001780 if (err == 0) {
1781 PyErr_Format(PyExc_ImportError,
1782 "Purported %s module %.200s not found",
1783 type == C_BUILTIN ?
1784 "builtin" : "frozen",
1785 name);
Guido van Rossuma86f77d1997-09-09 18:53:47 +00001786 return NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001787 }
1788 modules = PyImport_GetModuleDict();
1789 m = PyDict_GetItemString(modules, name);
1790 if (m == NULL) {
1791 PyErr_Format(
1792 PyExc_ImportError,
1793 "%s module %.200s not properly initialized",
1794 type == C_BUILTIN ?
1795 "builtin" : "frozen",
1796 name);
Guido van Rossuma86f77d1997-09-09 18:53:47 +00001797 return NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001798 }
1799 Py_INCREF(m);
1800 break;
1801
Just van Rossum52e14d62002-12-30 22:08:05 +00001802 case IMP_HOOK: {
1803 if (loader == NULL) {
1804 PyErr_SetString(PyExc_ImportError,
1805 "import hook without loader");
1806 return NULL;
1807 }
1808 m = PyObject_CallMethod(loader, "load_module", "s", name);
1809 break;
1810 }
1811
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001812 default:
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001813 PyErr_Format(PyExc_ImportError,
1814 "Don't know how to import %.200s (type code %d)",
1815 name, type);
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001816 m = NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001817
1818 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001819
1820 return m;
1821}
1822
1823
1824/* Initialize a built-in module.
Brett Cannon5a9aa4f2006-10-03 21:58:55 +00001825 Return 1 for success, 0 if the module is not found, and -1 with
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001826 an exception set if the initialization failed. */
Guido van Rossum7f133ed1991-02-19 12:23:57 +00001827
Guido van Rossum7f133ed1991-02-19 12:23:57 +00001828static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001829init_builtin(char *name)
Guido van Rossum7f133ed1991-02-19 12:23:57 +00001830{
Guido van Rossum25ce5661997-08-02 03:10:38 +00001831 struct _inittab *p;
Guido van Rossum25ce5661997-08-02 03:10:38 +00001832
Greg Ward201baee2001-10-04 14:52:06 +00001833 if (_PyImport_FindExtension(name, name) != NULL)
Guido van Rossum25ce5661997-08-02 03:10:38 +00001834 return 1;
1835
Guido van Rossum771c6c81997-10-31 18:37:24 +00001836 for (p = PyImport_Inittab; p->name != NULL; p++) {
Guido van Rossum25ce5661997-08-02 03:10:38 +00001837 if (strcmp(name, p->name) == 0) {
1838 if (p->initfunc == NULL) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001839 PyErr_Format(PyExc_ImportError,
1840 "Cannot re-init internal module %.200s",
1841 name);
Guido van Rossum74e6a111994-08-29 12:54:38 +00001842 return -1;
1843 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00001844 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +00001845 PySys_WriteStderr("import %s # builtin\n", name);
Guido van Rossum25ce5661997-08-02 03:10:38 +00001846 (*p->initfunc)();
Guido van Rossum79f25d91997-04-29 20:08:16 +00001847 if (PyErr_Occurred())
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001848 return -1;
Guido van Rossum25ce5661997-08-02 03:10:38 +00001849 if (_PyImport_FixupExtension(name, name) == NULL)
1850 return -1;
Guido van Rossum7f133ed1991-02-19 12:23:57 +00001851 return 1;
1852 }
1853 }
1854 return 0;
1855}
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001856
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001857
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001858/* Frozen modules */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001859
Guido van Rossumcfd0a221996-06-17 17:06:34 +00001860static struct _frozen *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001861find_frozen(char *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001862{
Guido van Rossumcfd0a221996-06-17 17:06:34 +00001863 struct _frozen *p;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001864
Guido van Rossum79f25d91997-04-29 20:08:16 +00001865 for (p = PyImport_FrozenModules; ; p++) {
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001866 if (p->name == NULL)
1867 return NULL;
1868 if (strcmp(p->name, name) == 0)
1869 break;
1870 }
1871 return p;
1872}
1873
Guido van Rossum79f25d91997-04-29 20:08:16 +00001874static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001875get_frozen_object(char *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001876{
Guido van Rossumcfd0a221996-06-17 17:06:34 +00001877 struct _frozen *p = find_frozen(name);
Guido van Rossuma5568d31998-03-05 03:45:08 +00001878 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001879
1880 if (p == NULL) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001881 PyErr_Format(PyExc_ImportError,
1882 "No such frozen object named %.200s",
1883 name);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001884 return NULL;
1885 }
Guido van Rossum8f4d3312001-10-18 18:54:11 +00001886 if (p->code == NULL) {
1887 PyErr_Format(PyExc_ImportError,
1888 "Excluded frozen object named %.200s",
1889 name);
1890 return NULL;
1891 }
Guido van Rossuma5568d31998-03-05 03:45:08 +00001892 size = p->size;
1893 if (size < 0)
1894 size = -size;
1895 return PyMarshal_ReadObjectFromString((char *)p->code, size);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001896}
1897
1898/* Initialize a frozen module.
1899 Return 1 for succes, 0 if the module is not found, and -1 with
1900 an exception set if the initialization failed.
1901 This function is also used from frozenmain.c */
Guido van Rossum0b344901995-02-07 15:35:27 +00001902
1903int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001904PyImport_ImportFrozenModule(char *name)
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001905{
Guido van Rossumcfd0a221996-06-17 17:06:34 +00001906 struct _frozen *p = find_frozen(name);
Guido van Rossum79f25d91997-04-29 20:08:16 +00001907 PyObject *co;
1908 PyObject *m;
Guido van Rossuma5568d31998-03-05 03:45:08 +00001909 int ispackage;
1910 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001911
1912 if (p == NULL)
1913 return 0;
Guido van Rossum8f4d3312001-10-18 18:54:11 +00001914 if (p->code == NULL) {
1915 PyErr_Format(PyExc_ImportError,
1916 "Excluded frozen object named %.200s",
1917 name);
1918 return -1;
1919 }
Guido van Rossuma5568d31998-03-05 03:45:08 +00001920 size = p->size;
1921 ispackage = (size < 0);
1922 if (ispackage)
1923 size = -size;
Guido van Rossum79f25d91997-04-29 20:08:16 +00001924 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +00001925 PySys_WriteStderr("import %s # frozen%s\n",
Guido van Rossuma5568d31998-03-05 03:45:08 +00001926 name, ispackage ? " package" : "");
1927 co = PyMarshal_ReadObjectFromString((char *)p->code, size);
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001928 if (co == NULL)
1929 return -1;
Guido van Rossum79f25d91997-04-29 20:08:16 +00001930 if (!PyCode_Check(co)) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001931 PyErr_Format(PyExc_TypeError,
1932 "frozen object %.200s is not a code object",
1933 name);
Neal Norwitzc0cde4d2006-07-16 02:17:36 +00001934 goto err_return;
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001935 }
Guido van Rossuma5568d31998-03-05 03:45:08 +00001936 if (ispackage) {
1937 /* Set __path__ to the package name */
1938 PyObject *d, *s;
1939 int err;
1940 m = PyImport_AddModule(name);
1941 if (m == NULL)
Neal Norwitzc0cde4d2006-07-16 02:17:36 +00001942 goto err_return;
Guido van Rossuma5568d31998-03-05 03:45:08 +00001943 d = PyModule_GetDict(m);
1944 s = PyString_InternFromString(name);
1945 if (s == NULL)
Neal Norwitzc0cde4d2006-07-16 02:17:36 +00001946 goto err_return;
Guido van Rossuma5568d31998-03-05 03:45:08 +00001947 err = PyDict_SetItemString(d, "__path__", s);
1948 Py_DECREF(s);
1949 if (err != 0)
Neal Norwitzc0cde4d2006-07-16 02:17:36 +00001950 goto err_return;
Guido van Rossuma5568d31998-03-05 03:45:08 +00001951 }
Guido van Rossume32bf6e1998-02-11 05:53:02 +00001952 m = PyImport_ExecCodeModuleEx(name, co, "<frozen>");
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001953 if (m == NULL)
Neal Norwitzc0cde4d2006-07-16 02:17:36 +00001954 goto err_return;
1955 Py_DECREF(co);
Guido van Rossum79f25d91997-04-29 20:08:16 +00001956 Py_DECREF(m);
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001957 return 1;
Neal Norwitzc0cde4d2006-07-16 02:17:36 +00001958err_return:
1959 Py_DECREF(co);
1960 return -1;
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001961}
Guido van Rossum74e6a111994-08-29 12:54:38 +00001962
1963
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001964/* Import a module, either built-in, frozen, or external, and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001965 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum74e6a111994-08-29 12:54:38 +00001966
Guido van Rossum79f25d91997-04-29 20:08:16 +00001967PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001968PyImport_ImportModule(const char *name)
Guido van Rossum74e6a111994-08-29 12:54:38 +00001969{
Marc-André Lemburg3c61c352001-02-09 19:40:15 +00001970 PyObject *pname;
1971 PyObject *result;
1972
1973 pname = PyString_FromString(name);
Neal Norwitza11e4c12003-03-23 14:31:01 +00001974 if (pname == NULL)
1975 return NULL;
Marc-André Lemburg3c61c352001-02-09 19:40:15 +00001976 result = PyImport_Import(pname);
1977 Py_DECREF(pname);
1978 return result;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001979}
1980
Guido van Rossum17fc85f1997-09-06 18:52:03 +00001981/* Forward declarations for helper routines */
Thomas Woutersf7f438b2006-02-28 16:09:29 +00001982static PyObject *get_parent(PyObject *globals, char *buf,
1983 Py_ssize_t *p_buflen, int level);
Tim Petersdbd9ba62000-07-09 03:09:57 +00001984static PyObject *load_next(PyObject *mod, PyObject *altmod,
Martin v. Löwis18e16552006-02-15 17:27:45 +00001985 char **p_name, char *buf, Py_ssize_t *p_buflen);
Tim Petersdbd9ba62000-07-09 03:09:57 +00001986static int mark_miss(char *name);
1987static int ensure_fromlist(PyObject *mod, PyObject *fromlist,
Martin v. Löwis18e16552006-02-15 17:27:45 +00001988 char *buf, Py_ssize_t buflen, int recursive);
Tim Petersdbd9ba62000-07-09 03:09:57 +00001989static PyObject * import_submodule(PyObject *mod, char *name, char *fullname);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00001990
1991/* The Magnum Opus of dotted-name import :-) */
1992
Guido van Rossum75acc9c1998-03-03 22:26:50 +00001993static PyObject *
Thomas Woutersf7f438b2006-02-28 16:09:29 +00001994import_module_level(char *name, PyObject *globals, PyObject *locals,
1995 PyObject *fromlist, int level)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001996{
Guido van Rossum17fc85f1997-09-06 18:52:03 +00001997 char buf[MAXPATHLEN+1];
Martin v. Löwis18e16552006-02-15 17:27:45 +00001998 Py_ssize_t buflen = 0;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00001999 PyObject *parent, *head, *next, *tail;
2000
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002001 parent = get_parent(globals, buf, &buflen, level);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002002 if (parent == NULL)
2003 return NULL;
2004
2005 head = load_next(parent, Py_None, &name, buf, &buflen);
2006 if (head == NULL)
2007 return NULL;
2008
2009 tail = head;
2010 Py_INCREF(tail);
2011 while (name) {
2012 next = load_next(tail, tail, &name, buf, &buflen);
2013 Py_DECREF(tail);
2014 if (next == NULL) {
2015 Py_DECREF(head);
2016 return NULL;
2017 }
2018 tail = next;
2019 }
Thomas Wouters8ddab272006-04-04 16:17:02 +00002020 if (tail == Py_None) {
2021 /* If tail is Py_None, both get_parent and load_next found
2022 an empty module name: someone called __import__("") or
2023 doctored faulty bytecode */
Thomas Wouters4bdaa272006-04-05 13:39:37 +00002024 Py_DECREF(tail);
2025 Py_DECREF(head);
Thomas Wouters8ddab272006-04-04 16:17:02 +00002026 PyErr_SetString(PyExc_ValueError,
2027 "Empty module name");
2028 return NULL;
2029 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002030
2031 if (fromlist != NULL) {
2032 if (fromlist == Py_None || !PyObject_IsTrue(fromlist))
2033 fromlist = NULL;
2034 }
2035
2036 if (fromlist == NULL) {
2037 Py_DECREF(tail);
2038 return head;
2039 }
2040
2041 Py_DECREF(head);
Guido van Rossum9905ef91997-09-08 16:07:11 +00002042 if (!ensure_fromlist(tail, fromlist, buf, buflen, 0)) {
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002043 Py_DECREF(tail);
2044 return NULL;
2045 }
2046
2047 return tail;
2048}
2049
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002050/* For DLL compatibility */
2051#undef PyImport_ImportModuleEx
Guido van Rossum75acc9c1998-03-03 22:26:50 +00002052PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002053PyImport_ImportModuleEx(char *name, PyObject *globals, PyObject *locals,
2054 PyObject *fromlist)
Guido van Rossum75acc9c1998-03-03 22:26:50 +00002055{
2056 PyObject *result;
2057 lock_import();
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002058 result = import_module_level(name, globals, locals, fromlist, -1);
2059 if (unlock_import() < 0) {
2060 Py_XDECREF(result);
2061 PyErr_SetString(PyExc_RuntimeError,
2062 "not holding the import lock");
2063 return NULL;
2064 }
2065 return result;
2066}
2067#define PyImport_ImportModuleEx(n, g, l, f) \
2068 PyImport_ImportModuleLevel(n, g, l, f, -1);
2069
2070PyObject *
2071PyImport_ImportModuleLevel(char *name, PyObject *globals, PyObject *locals,
2072 PyObject *fromlist, int level)
2073{
2074 PyObject *result;
2075 lock_import();
2076 result = import_module_level(name, globals, locals, fromlist, level);
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00002077 if (unlock_import() < 0) {
2078 Py_XDECREF(result);
2079 PyErr_SetString(PyExc_RuntimeError,
2080 "not holding the import lock");
2081 return NULL;
2082 }
Guido van Rossum75acc9c1998-03-03 22:26:50 +00002083 return result;
2084}
2085
Fred Drake87590902004-05-28 20:21:36 +00002086/* Return the package that an import is being performed in. If globals comes
2087 from the module foo.bar.bat (not itself a package), this returns the
2088 sys.modules entry for foo.bar. If globals is from a package's __init__.py,
Georg Brandl5f6861d2006-05-28 21:57:35 +00002089 the package's entry in sys.modules is returned, as a borrowed reference.
Fred Drake87590902004-05-28 20:21:36 +00002090
2091 The *name* of the returned package is returned in buf, with the length of
2092 the name in *p_buflen.
2093
2094 If globals doesn't come from a package or a module in a package, or a
2095 corresponding entry is not found in sys.modules, Py_None is returned.
2096*/
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002097static PyObject *
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002098get_parent(PyObject *globals, char *buf, Py_ssize_t *p_buflen, int level)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002099{
2100 static PyObject *namestr = NULL;
2101 static PyObject *pathstr = NULL;
2102 PyObject *modname, *modpath, *modules, *parent;
2103
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002104 if (globals == NULL || !PyDict_Check(globals) || !level)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002105 return Py_None;
2106
2107 if (namestr == NULL) {
2108 namestr = PyString_InternFromString("__name__");
2109 if (namestr == NULL)
2110 return NULL;
2111 }
2112 if (pathstr == NULL) {
2113 pathstr = PyString_InternFromString("__path__");
2114 if (pathstr == NULL)
2115 return NULL;
2116 }
2117
2118 *buf = '\0';
2119 *p_buflen = 0;
2120 modname = PyDict_GetItem(globals, namestr);
2121 if (modname == NULL || !PyString_Check(modname))
2122 return Py_None;
2123
2124 modpath = PyDict_GetItem(globals, pathstr);
2125 if (modpath != NULL) {
Martin v. Löwis725507b2006-03-07 12:08:51 +00002126 Py_ssize_t len = PyString_GET_SIZE(modname);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002127 if (len > MAXPATHLEN) {
2128 PyErr_SetString(PyExc_ValueError,
2129 "Module name too long");
2130 return NULL;
2131 }
2132 strcpy(buf, PyString_AS_STRING(modname));
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002133 }
2134 else {
2135 char *start = PyString_AS_STRING(modname);
2136 char *lastdot = strrchr(start, '.');
Fred Drake4c82b232000-06-30 16:18:57 +00002137 size_t len;
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002138 if (lastdot == NULL && level > 0) {
2139 PyErr_SetString(PyExc_ValueError,
Georg Brandl98775df2006-09-06 06:09:31 +00002140 "Attempted relative import in non-package");
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002141 return NULL;
2142 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002143 if (lastdot == NULL)
2144 return Py_None;
2145 len = lastdot - start;
2146 if (len >= MAXPATHLEN) {
2147 PyErr_SetString(PyExc_ValueError,
2148 "Module name too long");
2149 return NULL;
2150 }
2151 strncpy(buf, start, len);
2152 buf[len] = '\0';
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002153 }
2154
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002155 while (--level > 0) {
2156 char *dot = strrchr(buf, '.');
2157 if (dot == NULL) {
2158 PyErr_SetString(PyExc_ValueError,
Georg Brandl98775df2006-09-06 06:09:31 +00002159 "Attempted relative import beyond "
2160 "toplevel package");
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002161 return NULL;
2162 }
2163 *dot = '\0';
2164 }
2165 *p_buflen = strlen(buf);
2166
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002167 modules = PyImport_GetModuleDict();
2168 parent = PyDict_GetItemString(modules, buf);
2169 if (parent == NULL)
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002170 PyErr_Format(PyExc_SystemError,
2171 "Parent module '%.200s' not loaded", buf);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002172 return parent;
2173 /* We expect, but can't guarantee, if parent != None, that:
2174 - parent.__name__ == buf
2175 - parent.__dict__ is globals
2176 If this is violated... Who cares? */
2177}
2178
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002179/* altmod is either None or same as mod */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002180static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002181load_next(PyObject *mod, PyObject *altmod, char **p_name, char *buf,
Martin v. Löwis18e16552006-02-15 17:27:45 +00002182 Py_ssize_t *p_buflen)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002183{
2184 char *name = *p_name;
2185 char *dot = strchr(name, '.');
Fred Drake4c82b232000-06-30 16:18:57 +00002186 size_t len;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002187 char *p;
2188 PyObject *result;
2189
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002190 if (strlen(name) == 0) {
Thomas Wouters8ddab272006-04-04 16:17:02 +00002191 /* completely empty module name should only happen in
2192 'from . import' (or '__import__("")')*/
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002193 Py_INCREF(mod);
2194 *p_name = NULL;
2195 return mod;
2196 }
2197
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002198 if (dot == NULL) {
2199 *p_name = NULL;
2200 len = strlen(name);
2201 }
2202 else {
2203 *p_name = dot+1;
2204 len = dot-name;
2205 }
Guido van Rossum111c20b1998-04-11 17:38:22 +00002206 if (len == 0) {
2207 PyErr_SetString(PyExc_ValueError,
2208 "Empty module name");
2209 return NULL;
2210 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002211
2212 p = buf + *p_buflen;
2213 if (p != buf)
2214 *p++ = '.';
2215 if (p+len-buf >= MAXPATHLEN) {
2216 PyErr_SetString(PyExc_ValueError,
2217 "Module name too long");
2218 return NULL;
2219 }
2220 strncpy(p, name, len);
2221 p[len] = '\0';
2222 *p_buflen = p+len-buf;
2223
2224 result = import_submodule(mod, p, buf);
2225 if (result == Py_None && altmod != mod) {
2226 Py_DECREF(result);
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00002227 /* Here, altmod must be None and mod must not be None */
Guido van Rossum0c819451997-09-07 06:16:57 +00002228 result = import_submodule(altmod, p, p);
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00002229 if (result != NULL && result != Py_None) {
2230 if (mark_miss(buf) != 0) {
2231 Py_DECREF(result);
2232 return NULL;
2233 }
2234 strncpy(buf, name, len);
2235 buf[len] = '\0';
2236 *p_buflen = len;
2237 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002238 }
2239 if (result == NULL)
2240 return NULL;
2241
2242 if (result == Py_None) {
2243 Py_DECREF(result);
2244 PyErr_Format(PyExc_ImportError,
2245 "No module named %.200s", name);
2246 return NULL;
2247 }
2248
2249 return result;
2250}
2251
2252static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002253mark_miss(char *name)
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00002254{
2255 PyObject *modules = PyImport_GetModuleDict();
2256 return PyDict_SetItemString(modules, name, Py_None);
2257}
2258
2259static int
Martin v. Löwis18e16552006-02-15 17:27:45 +00002260ensure_fromlist(PyObject *mod, PyObject *fromlist, char *buf, Py_ssize_t buflen,
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002261 int recursive)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002262{
2263 int i;
2264
2265 if (!PyObject_HasAttrString(mod, "__path__"))
2266 return 1;
2267
2268 for (i = 0; ; i++) {
2269 PyObject *item = PySequence_GetItem(fromlist, i);
2270 int hasit;
2271 if (item == NULL) {
2272 if (PyErr_ExceptionMatches(PyExc_IndexError)) {
2273 PyErr_Clear();
2274 return 1;
2275 }
2276 return 0;
2277 }
2278 if (!PyString_Check(item)) {
2279 PyErr_SetString(PyExc_TypeError,
2280 "Item in ``from list'' not a string");
2281 Py_DECREF(item);
2282 return 0;
2283 }
2284 if (PyString_AS_STRING(item)[0] == '*') {
Guido van Rossum9905ef91997-09-08 16:07:11 +00002285 PyObject *all;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002286 Py_DECREF(item);
Guido van Rossum9905ef91997-09-08 16:07:11 +00002287 /* See if the package defines __all__ */
2288 if (recursive)
2289 continue; /* Avoid endless recursion */
2290 all = PyObject_GetAttrString(mod, "__all__");
2291 if (all == NULL)
2292 PyErr_Clear();
2293 else {
Martin v. Löwis83969ee2004-03-23 16:28:13 +00002294 int ret = ensure_fromlist(mod, all, buf, buflen, 1);
Guido van Rossum9905ef91997-09-08 16:07:11 +00002295 Py_DECREF(all);
Martin v. Löwis83969ee2004-03-23 16:28:13 +00002296 if (!ret)
2297 return 0;
Guido van Rossum9905ef91997-09-08 16:07:11 +00002298 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002299 continue;
2300 }
2301 hasit = PyObject_HasAttr(mod, item);
2302 if (!hasit) {
2303 char *subname = PyString_AS_STRING(item);
2304 PyObject *submod;
2305 char *p;
2306 if (buflen + strlen(subname) >= MAXPATHLEN) {
2307 PyErr_SetString(PyExc_ValueError,
2308 "Module name too long");
2309 Py_DECREF(item);
2310 return 0;
2311 }
2312 p = buf + buflen;
2313 *p++ = '.';
2314 strcpy(p, subname);
2315 submod = import_submodule(mod, subname, buf);
2316 Py_XDECREF(submod);
2317 if (submod == NULL) {
2318 Py_DECREF(item);
2319 return 0;
2320 }
2321 }
2322 Py_DECREF(item);
2323 }
2324
Guido van Rossuma7f2e811997-10-03 15:33:32 +00002325 /* NOTREACHED */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002326}
2327
Neil Schemenauer00b09662003-06-16 21:03:07 +00002328static int
2329add_submodule(PyObject *mod, PyObject *submod, char *fullname, char *subname,
2330 PyObject *modules)
2331{
2332 if (mod == Py_None)
2333 return 1;
2334 /* Irrespective of the success of this load, make a
2335 reference to it in the parent package module. A copy gets
2336 saved in the modules dictionary under the full name, so get a
2337 reference from there, if need be. (The exception is when the
2338 load failed with a SyntaxError -- then there's no trace in
2339 sys.modules. In that case, of course, do nothing extra.) */
2340 if (submod == NULL) {
2341 submod = PyDict_GetItemString(modules, fullname);
2342 if (submod == NULL)
2343 return 1;
2344 }
2345 if (PyModule_Check(mod)) {
2346 /* We can't use setattr here since it can give a
2347 * spurious warning if the submodule name shadows a
2348 * builtin name */
2349 PyObject *dict = PyModule_GetDict(mod);
2350 if (!dict)
2351 return 0;
2352 if (PyDict_SetItemString(dict, subname, submod) < 0)
2353 return 0;
2354 }
2355 else {
2356 if (PyObject_SetAttrString(mod, subname, submod) < 0)
2357 return 0;
2358 }
2359 return 1;
2360}
2361
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002362static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002363import_submodule(PyObject *mod, char *subname, char *fullname)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002364{
Guido van Rossum25ce5661997-08-02 03:10:38 +00002365 PyObject *modules = PyImport_GetModuleDict();
Neil Schemenauer00b09662003-06-16 21:03:07 +00002366 PyObject *m = NULL;
Guido van Rossum74e6a111994-08-29 12:54:38 +00002367
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002368 /* Require:
2369 if mod == None: subname == fullname
2370 else: mod.__name__ + "." + subname == fullname
2371 */
2372
Tim Peters50d8d372001-02-28 05:34:27 +00002373 if ((m = PyDict_GetItemString(modules, fullname)) != NULL) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00002374 Py_INCREF(m);
Guido van Rossum7f9fa971995-01-20 16:53:12 +00002375 }
2376 else {
Just van Rossum52e14d62002-12-30 22:08:05 +00002377 PyObject *path, *loader = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002378 char buf[MAXPATHLEN+1];
2379 struct filedescr *fdp;
2380 FILE *fp = NULL;
2381
Guido van Rossum9c0afe51998-05-19 15:09:05 +00002382 if (mod == Py_None)
2383 path = NULL;
2384 else {
2385 path = PyObject_GetAttrString(mod, "__path__");
2386 if (path == NULL) {
2387 PyErr_Clear();
2388 Py_INCREF(Py_None);
2389 return Py_None;
2390 }
2391 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002392
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002393 buf[0] = '\0';
Just van Rossum52e14d62002-12-30 22:08:05 +00002394 fdp = find_module(fullname, subname, path, buf, MAXPATHLEN+1,
2395 &fp, &loader);
Guido van Rossumb68cd421998-07-01 17:36:26 +00002396 Py_XDECREF(path);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002397 if (fdp == NULL) {
2398 if (!PyErr_ExceptionMatches(PyExc_ImportError))
2399 return NULL;
2400 PyErr_Clear();
2401 Py_INCREF(Py_None);
2402 return Py_None;
2403 }
Just van Rossum52e14d62002-12-30 22:08:05 +00002404 m = load_module(fullname, fp, buf, fdp->type, loader);
2405 Py_XDECREF(loader);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002406 if (fp)
2407 fclose(fp);
Neil Schemenauer00b09662003-06-16 21:03:07 +00002408 if (!add_submodule(mod, m, fullname, subname, modules)) {
2409 Py_XDECREF(m);
2410 m = NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002411 }
Guido van Rossum74e6a111994-08-29 12:54:38 +00002412 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002413
2414 return m;
Guido van Rossum74e6a111994-08-29 12:54:38 +00002415}
2416
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002417
2418/* Re-import a module of any kind and return its module object, WITH
2419 INCREMENTED REFERENCE COUNT */
2420
Guido van Rossum79f25d91997-04-29 20:08:16 +00002421PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002422PyImport_ReloadModule(PyObject *m)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002423{
Collin Winter276887b2007-03-12 16:11:39 +00002424 PyObject *modules_reloading = PyImport_GetModulesReloading();
Guido van Rossum25ce5661997-08-02 03:10:38 +00002425 PyObject *modules = PyImport_GetModuleDict();
Collin Winter276887b2007-03-12 16:11:39 +00002426 PyObject *path = NULL, *loader = NULL, *existing_m = NULL;
Guido van Rossum222ef561997-09-06 19:41:09 +00002427 char *name, *subname;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002428 char buf[MAXPATHLEN+1];
2429 struct filedescr *fdp;
2430 FILE *fp = NULL;
Tim Peters1cd70172004-08-02 03:52:12 +00002431 PyObject *newm;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002432
Guido van Rossum79f25d91997-04-29 20:08:16 +00002433 if (m == NULL || !PyModule_Check(m)) {
2434 PyErr_SetString(PyExc_TypeError,
2435 "reload() argument must be module");
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002436 return NULL;
2437 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002438 name = PyModule_GetName(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002439 if (name == NULL)
2440 return NULL;
Guido van Rossum25ce5661997-08-02 03:10:38 +00002441 if (m != PyDict_GetItemString(modules, name)) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002442 PyErr_Format(PyExc_ImportError,
2443 "reload(): module %.200s not in sys.modules",
2444 name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002445 return NULL;
2446 }
Collin Winter276887b2007-03-12 16:11:39 +00002447 if ((existing_m = PyDict_GetItemString(modules_reloading, name)) != NULL) {
2448 /* Due to a recursive reload, this module is already being reloaded. */
2449 Py_INCREF(existing_m);
2450 return existing_m;
2451 }
2452 PyDict_SetItemString(modules_reloading, name, m);
2453
Guido van Rossum222ef561997-09-06 19:41:09 +00002454 subname = strrchr(name, '.');
2455 if (subname == NULL)
2456 subname = name;
2457 else {
2458 PyObject *parentname, *parent;
2459 parentname = PyString_FromStringAndSize(name, (subname-name));
Collin Winter276887b2007-03-12 16:11:39 +00002460 if (parentname == NULL) {
2461 imp_modules_reloading_clear();
Guido van Rossum222ef561997-09-06 19:41:09 +00002462 return NULL;
Collin Winter276887b2007-03-12 16:11:39 +00002463 }
Guido van Rossum222ef561997-09-06 19:41:09 +00002464 parent = PyDict_GetItem(modules, parentname);
2465 if (parent == NULL) {
2466 PyErr_Format(PyExc_ImportError,
2467 "reload(): parent %.200s not in sys.modules",
Georg Brandl0c55f292005-09-14 06:56:20 +00002468 PyString_AS_STRING(parentname));
2469 Py_DECREF(parentname);
Collin Winter276887b2007-03-12 16:11:39 +00002470 imp_modules_reloading_clear();
Guido van Rossum222ef561997-09-06 19:41:09 +00002471 return NULL;
2472 }
Georg Brandl0c55f292005-09-14 06:56:20 +00002473 Py_DECREF(parentname);
Guido van Rossum222ef561997-09-06 19:41:09 +00002474 subname++;
2475 path = PyObject_GetAttrString(parent, "__path__");
2476 if (path == NULL)
2477 PyErr_Clear();
2478 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002479 buf[0] = '\0';
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00002480 fdp = find_module(name, subname, path, buf, MAXPATHLEN+1, &fp, &loader);
Guido van Rossum222ef561997-09-06 19:41:09 +00002481 Py_XDECREF(path);
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00002482
2483 if (fdp == NULL) {
2484 Py_XDECREF(loader);
Collin Winter276887b2007-03-12 16:11:39 +00002485 imp_modules_reloading_clear();
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002486 return NULL;
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00002487 }
2488
2489 newm = load_module(name, fp, buf, fdp->type, loader);
2490 Py_XDECREF(loader);
2491
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002492 if (fp)
2493 fclose(fp);
Tim Peters1cd70172004-08-02 03:52:12 +00002494 if (newm == NULL) {
2495 /* load_module probably removed name from modules because of
2496 * the error. Put back the original module object. We're
2497 * going to return NULL in this case regardless of whether
2498 * replacing name succeeds, so the return value is ignored.
2499 */
2500 PyDict_SetItemString(modules, name, m);
2501 }
Collin Winter276887b2007-03-12 16:11:39 +00002502 imp_modules_reloading_clear ();
Tim Peters1cd70172004-08-02 03:52:12 +00002503 return newm;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002504}
2505
2506
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002507/* Higher-level import emulator which emulates the "import" statement
2508 more accurately -- it invokes the __import__() function from the
2509 builtins of the current globals. This means that the import is
2510 done using whatever import hooks are installed in the current
Guido van Rossum6058eb41998-12-21 19:51:00 +00002511 environment, e.g. by "rexec".
2512 A dummy list ["__doc__"] is passed as the 4th argument so that
2513 e.g. PyImport_Import(PyString_FromString("win32com.client.gencache"))
2514 will return <module "gencache"> instead of <module "win32com">. */
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002515
2516PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002517PyImport_Import(PyObject *module_name)
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002518{
2519 static PyObject *silly_list = NULL;
2520 static PyObject *builtins_str = NULL;
2521 static PyObject *import_str = NULL;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002522 PyObject *globals = NULL;
2523 PyObject *import = NULL;
2524 PyObject *builtins = NULL;
2525 PyObject *r = NULL;
2526
2527 /* Initialize constant string objects */
2528 if (silly_list == NULL) {
2529 import_str = PyString_InternFromString("__import__");
2530 if (import_str == NULL)
2531 return NULL;
2532 builtins_str = PyString_InternFromString("__builtins__");
2533 if (builtins_str == NULL)
2534 return NULL;
2535 silly_list = Py_BuildValue("[s]", "__doc__");
2536 if (silly_list == NULL)
2537 return NULL;
2538 }
2539
2540 /* Get the builtins from current globals */
2541 globals = PyEval_GetGlobals();
Guido van Rossum85cd1d62001-02-20 21:43:24 +00002542 if (globals != NULL) {
Guido van Rossum66468561998-10-22 15:46:50 +00002543 Py_INCREF(globals);
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002544 builtins = PyObject_GetItem(globals, builtins_str);
2545 if (builtins == NULL)
2546 goto err;
2547 }
2548 else {
2549 /* No globals -- use standard builtins, and fake globals */
2550 PyErr_Clear();
2551
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002552 builtins = PyImport_ImportModuleLevel("__builtin__",
2553 NULL, NULL, NULL, 0);
Guido van Rossum85cd1d62001-02-20 21:43:24 +00002554 if (builtins == NULL)
2555 return NULL;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002556 globals = Py_BuildValue("{OO}", builtins_str, builtins);
2557 if (globals == NULL)
2558 goto err;
2559 }
2560
2561 /* Get the __import__ function from the builtins */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002562 if (PyDict_Check(builtins)) {
Fred Drakea76ba6e2001-03-06 06:31:15 +00002563 import = PyObject_GetItem(builtins, import_str);
Tim Peters6d6c1a32001-08-02 04:15:00 +00002564 if (import == NULL)
2565 PyErr_SetObject(PyExc_KeyError, import_str);
2566 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002567 else
Fred Drakea76ba6e2001-03-06 06:31:15 +00002568 import = PyObject_GetAttr(builtins, import_str);
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002569 if (import == NULL)
2570 goto err;
2571
Georg Brandl74780962007-03-10 07:38:14 +00002572 /* Call the __import__ function with the proper argument list */
Georg Brandl684fd0c2006-05-25 19:15:31 +00002573 r = PyObject_CallFunctionObjArgs(import, module_name, globals,
2574 globals, silly_list, NULL);
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002575
2576 err:
2577 Py_XDECREF(globals);
2578 Py_XDECREF(builtins);
2579 Py_XDECREF(import);
Tim Peters50d8d372001-02-28 05:34:27 +00002580
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002581 return r;
2582}
2583
2584
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002585/* Module 'imp' provides Python access to the primitives used for
2586 importing modules.
2587*/
2588
Guido van Rossum79f25d91997-04-29 20:08:16 +00002589static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +00002590imp_get_magic(PyObject *self, PyObject *noargs)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002591{
2592 char buf[4];
2593
Guido van Rossum96774c12000-05-01 20:19:08 +00002594 buf[0] = (char) ((pyc_magic >> 0) & 0xff);
2595 buf[1] = (char) ((pyc_magic >> 8) & 0xff);
2596 buf[2] = (char) ((pyc_magic >> 16) & 0xff);
2597 buf[3] = (char) ((pyc_magic >> 24) & 0xff);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002598
Guido van Rossum79f25d91997-04-29 20:08:16 +00002599 return PyString_FromStringAndSize(buf, 4);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002600}
2601
Guido van Rossum79f25d91997-04-29 20:08:16 +00002602static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +00002603imp_get_suffixes(PyObject *self, PyObject *noargs)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002604{
Guido van Rossum79f25d91997-04-29 20:08:16 +00002605 PyObject *list;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002606 struct filedescr *fdp;
2607
Guido van Rossum79f25d91997-04-29 20:08:16 +00002608 list = PyList_New(0);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002609 if (list == NULL)
2610 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002611 for (fdp = _PyImport_Filetab; fdp->suffix != NULL; fdp++) {
2612 PyObject *item = Py_BuildValue("ssi",
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002613 fdp->suffix, fdp->mode, fdp->type);
2614 if (item == NULL) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00002615 Py_DECREF(list);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002616 return NULL;
2617 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002618 if (PyList_Append(list, item) < 0) {
2619 Py_DECREF(list);
2620 Py_DECREF(item);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002621 return NULL;
2622 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002623 Py_DECREF(item);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002624 }
2625 return list;
2626}
2627
Guido van Rossum79f25d91997-04-29 20:08:16 +00002628static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002629call_find_module(char *name, PyObject *path)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002630{
Tim Petersdbd9ba62000-07-09 03:09:57 +00002631 extern int fclose(FILE *);
Guido van Rossum79f25d91997-04-29 20:08:16 +00002632 PyObject *fob, *ret;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002633 struct filedescr *fdp;
2634 char pathname[MAXPATHLEN+1];
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002635 FILE *fp = NULL;
2636
2637 pathname[0] = '\0';
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002638 if (path == Py_None)
2639 path = NULL;
Just van Rossum52e14d62002-12-30 22:08:05 +00002640 fdp = find_module(NULL, name, path, pathname, MAXPATHLEN+1, &fp, NULL);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002641 if (fdp == NULL)
2642 return NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002643 if (fp != NULL) {
2644 fob = PyFile_FromFile(fp, pathname, fdp->mode, fclose);
2645 if (fob == NULL) {
2646 fclose(fp);
2647 return NULL;
2648 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002649 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002650 else {
2651 fob = Py_None;
2652 Py_INCREF(fob);
Tim Peters50d8d372001-02-28 05:34:27 +00002653 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002654 ret = Py_BuildValue("Os(ssi)",
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002655 fob, pathname, fdp->suffix, fdp->mode, fdp->type);
Guido van Rossum79f25d91997-04-29 20:08:16 +00002656 Py_DECREF(fob);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002657 return ret;
2658}
2659
Guido van Rossum79f25d91997-04-29 20:08:16 +00002660static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002661imp_find_module(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002662{
2663 char *name;
2664 PyObject *path = NULL;
Guido van Rossum43713e52000-02-29 13:59:29 +00002665 if (!PyArg_ParseTuple(args, "s|O:find_module", &name, &path))
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002666 return NULL;
2667 return call_find_module(name, path);
2668}
2669
2670static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002671imp_init_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002672{
2673 char *name;
2674 int ret;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002675 PyObject *m;
Guido van Rossum43713e52000-02-29 13:59:29 +00002676 if (!PyArg_ParseTuple(args, "s:init_builtin", &name))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002677 return NULL;
2678 ret = init_builtin(name);
2679 if (ret < 0)
2680 return NULL;
2681 if (ret == 0) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00002682 Py_INCREF(Py_None);
2683 return Py_None;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002684 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002685 m = PyImport_AddModule(name);
2686 Py_XINCREF(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002687 return m;
2688}
2689
Guido van Rossum79f25d91997-04-29 20:08:16 +00002690static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002691imp_init_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002692{
2693 char *name;
2694 int ret;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002695 PyObject *m;
Guido van Rossum43713e52000-02-29 13:59:29 +00002696 if (!PyArg_ParseTuple(args, "s:init_frozen", &name))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002697 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002698 ret = PyImport_ImportFrozenModule(name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002699 if (ret < 0)
2700 return NULL;
2701 if (ret == 0) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00002702 Py_INCREF(Py_None);
2703 return Py_None;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002704 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002705 m = PyImport_AddModule(name);
2706 Py_XINCREF(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002707 return m;
2708}
2709
Guido van Rossum79f25d91997-04-29 20:08:16 +00002710static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002711imp_get_frozen_object(PyObject *self, PyObject *args)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002712{
2713 char *name;
Jack Jansen95ffa231995-10-03 14:38:41 +00002714
Guido van Rossum43713e52000-02-29 13:59:29 +00002715 if (!PyArg_ParseTuple(args, "s:get_frozen_object", &name))
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002716 return NULL;
2717 return get_frozen_object(name);
2718}
2719
Guido van Rossum79f25d91997-04-29 20:08:16 +00002720static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002721imp_is_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002722{
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002723 char *name;
Guido van Rossum43713e52000-02-29 13:59:29 +00002724 if (!PyArg_ParseTuple(args, "s:is_builtin", &name))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002725 return NULL;
Guido van Rossum50ee94f2002-04-09 18:00:58 +00002726 return PyInt_FromLong(is_builtin(name));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002727}
2728
Guido van Rossum79f25d91997-04-29 20:08:16 +00002729static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002730imp_is_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002731{
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002732 char *name;
Guido van Rossum323bf5e1998-06-24 03:54:06 +00002733 struct _frozen *p;
Guido van Rossum43713e52000-02-29 13:59:29 +00002734 if (!PyArg_ParseTuple(args, "s:is_frozen", &name))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002735 return NULL;
Guido van Rossum323bf5e1998-06-24 03:54:06 +00002736 p = find_frozen(name);
Guido van Rossumb8bff3f2002-04-07 06:34:38 +00002737 return PyBool_FromLong((long) (p == NULL ? 0 : p->size));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002738}
2739
2740static FILE *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002741get_file(char *pathname, PyObject *fob, char *mode)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002742{
2743 FILE *fp;
2744 if (fob == NULL) {
Tim Peters86c7d2f2004-08-01 23:24:21 +00002745 if (mode[0] == 'U')
Jeremy Hylton4ae6fae2002-05-30 17:15:25 +00002746 mode = "r" PY_STDIOTEXTMODE;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002747 fp = fopen(pathname, mode);
2748 if (fp == NULL)
Guido van Rossum79f25d91997-04-29 20:08:16 +00002749 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002750 }
2751 else {
Guido van Rossum79f25d91997-04-29 20:08:16 +00002752 fp = PyFile_AsFile(fob);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002753 if (fp == NULL)
Guido van Rossum79f25d91997-04-29 20:08:16 +00002754 PyErr_SetString(PyExc_ValueError,
2755 "bad/closed file object");
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002756 }
2757 return fp;
2758}
2759
Guido van Rossum79f25d91997-04-29 20:08:16 +00002760static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002761imp_load_compiled(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002762{
2763 char *name;
2764 char *pathname;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002765 PyObject *fob = NULL;
2766 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002767 FILE *fp;
Guido van Rossum43713e52000-02-29 13:59:29 +00002768 if (!PyArg_ParseTuple(args, "ss|O!:load_compiled", &name, &pathname,
Guido van Rossum79f25d91997-04-29 20:08:16 +00002769 &PyFile_Type, &fob))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002770 return NULL;
2771 fp = get_file(pathname, fob, "rb");
2772 if (fp == NULL)
2773 return NULL;
2774 m = load_compiled_module(name, pathname, fp);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002775 if (fob == NULL)
2776 fclose(fp);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002777 return m;
2778}
2779
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002780#ifdef HAVE_DYNAMIC_LOADING
2781
Guido van Rossum79f25d91997-04-29 20:08:16 +00002782static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002783imp_load_dynamic(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002784{
2785 char *name;
2786 char *pathname;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002787 PyObject *fob = NULL;
2788 PyObject *m;
Guido van Rossum7faeab31995-07-07 22:50:36 +00002789 FILE *fp = NULL;
Guido van Rossum43713e52000-02-29 13:59:29 +00002790 if (!PyArg_ParseTuple(args, "ss|O!:load_dynamic", &name, &pathname,
Guido van Rossum79f25d91997-04-29 20:08:16 +00002791 &PyFile_Type, &fob))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002792 return NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002793 if (fob) {
Guido van Rossum7faeab31995-07-07 22:50:36 +00002794 fp = get_file(pathname, fob, "r");
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002795 if (fp == NULL)
2796 return NULL;
2797 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002798 m = _PyImport_LoadDynamicModule(name, pathname, fp);
Guido van Rossum7faeab31995-07-07 22:50:36 +00002799 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002800}
2801
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002802#endif /* HAVE_DYNAMIC_LOADING */
2803
Guido van Rossum79f25d91997-04-29 20:08:16 +00002804static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002805imp_load_source(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002806{
2807 char *name;
2808 char *pathname;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002809 PyObject *fob = NULL;
2810 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002811 FILE *fp;
Guido van Rossum43713e52000-02-29 13:59:29 +00002812 if (!PyArg_ParseTuple(args, "ss|O!:load_source", &name, &pathname,
Guido van Rossum79f25d91997-04-29 20:08:16 +00002813 &PyFile_Type, &fob))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002814 return NULL;
2815 fp = get_file(pathname, fob, "r");
2816 if (fp == NULL)
2817 return NULL;
2818 m = load_source_module(name, pathname, fp);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002819 if (fob == NULL)
2820 fclose(fp);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002821 return m;
2822}
2823
Guido van Rossum79f25d91997-04-29 20:08:16 +00002824static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002825imp_load_module(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002826{
2827 char *name;
2828 PyObject *fob;
2829 char *pathname;
2830 char *suffix; /* Unused */
2831 char *mode;
2832 int type;
2833 FILE *fp;
2834
Guido van Rossum43713e52000-02-29 13:59:29 +00002835 if (!PyArg_ParseTuple(args, "sOs(ssi):load_module",
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002836 &name, &fob, &pathname,
2837 &suffix, &mode, &type))
2838 return NULL;
Guido van Rossum5e2c5fa2002-05-30 17:33:07 +00002839 if (*mode) {
2840 /* Mode must start with 'r' or 'U' and must not contain '+'.
2841 Implicit in this test is the assumption that the mode
2842 may contain other modifiers like 'b' or 't'. */
2843
2844 if (!(*mode == 'r' || *mode == 'U') || strchr(mode, '+')) {
Jeremy Hylton4ae6fae2002-05-30 17:15:25 +00002845 PyErr_Format(PyExc_ValueError,
2846 "invalid file open mode %.200s", mode);
2847 return NULL;
Guido van Rossum5e2c5fa2002-05-30 17:33:07 +00002848 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002849 }
2850 if (fob == Py_None)
2851 fp = NULL;
2852 else {
2853 if (!PyFile_Check(fob)) {
2854 PyErr_SetString(PyExc_ValueError,
2855 "load_module arg#2 should be a file or None");
2856 return NULL;
2857 }
2858 fp = get_file(pathname, fob, mode);
2859 if (fp == NULL)
2860 return NULL;
2861 }
Just van Rossum52e14d62002-12-30 22:08:05 +00002862 return load_module(name, fp, pathname, type, NULL);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002863}
2864
2865static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002866imp_load_package(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002867{
2868 char *name;
2869 char *pathname;
Guido van Rossum43713e52000-02-29 13:59:29 +00002870 if (!PyArg_ParseTuple(args, "ss:load_package", &name, &pathname))
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002871 return NULL;
2872 return load_package(name, pathname);
2873}
2874
2875static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002876imp_new_module(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002877{
2878 char *name;
Guido van Rossum43713e52000-02-29 13:59:29 +00002879 if (!PyArg_ParseTuple(args, "s:new_module", &name))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002880 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002881 return PyModule_New(name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002882}
2883
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002884/* Doc strings */
2885
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002886PyDoc_STRVAR(doc_imp,
2887"This module provides the components needed to build your own\n\
2888__import__ function. Undocumented functions are obsolete.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002889
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002890PyDoc_STRVAR(doc_find_module,
2891"find_module(name, [path]) -> (file, filename, (suffix, mode, type))\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002892Search for a module. If path is omitted or None, search for a\n\
2893built-in, frozen or special module and continue search in sys.path.\n\
2894The module name cannot contain '.'; to search for a submodule of a\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002895package, pass the submodule name and the package's __path__.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002896
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002897PyDoc_STRVAR(doc_load_module,
2898"load_module(name, file, filename, (suffix, mode, type)) -> module\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002899Load a module, given information returned by find_module().\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002900The module name must include the full package name, if any.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002901
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002902PyDoc_STRVAR(doc_get_magic,
2903"get_magic() -> string\n\
2904Return the magic number for .pyc or .pyo files.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002905
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002906PyDoc_STRVAR(doc_get_suffixes,
2907"get_suffixes() -> [(suffix, mode, type), ...]\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002908Return a list of (suffix, mode, type) tuples describing the files\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002909that find_module() looks for.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002910
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002911PyDoc_STRVAR(doc_new_module,
2912"new_module(name) -> module\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002913Create a new module. Do not enter it in sys.modules.\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002914The module name must include the full package name, if any.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002915
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002916PyDoc_STRVAR(doc_lock_held,
Tim Petersa7c65092004-08-01 23:26:05 +00002917"lock_held() -> boolean\n\
2918Return True if the import lock is currently held, else False.\n\
2919On platforms without threads, return False.");
Tim Peters69232342001-08-30 05:16:13 +00002920
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00002921PyDoc_STRVAR(doc_acquire_lock,
2922"acquire_lock() -> None\n\
Neal Norwitz2294c0d2003-02-12 23:02:21 +00002923Acquires the interpreter's import lock for the current thread.\n\
2924This lock should be used by import hooks to ensure thread-safety\n\
2925when importing modules.\n\
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00002926On platforms without threads, this function does nothing.");
2927
2928PyDoc_STRVAR(doc_release_lock,
2929"release_lock() -> None\n\
2930Release the interpreter's import lock.\n\
2931On platforms without threads, this function does nothing.");
2932
Guido van Rossum79f25d91997-04-29 20:08:16 +00002933static PyMethodDef imp_methods[] = {
Neal Norwitz08ea61a2003-02-17 18:18:00 +00002934 {"find_module", imp_find_module, METH_VARARGS, doc_find_module},
2935 {"get_magic", imp_get_magic, METH_NOARGS, doc_get_magic},
2936 {"get_suffixes", imp_get_suffixes, METH_NOARGS, doc_get_suffixes},
2937 {"load_module", imp_load_module, METH_VARARGS, doc_load_module},
2938 {"new_module", imp_new_module, METH_VARARGS, doc_new_module},
2939 {"lock_held", imp_lock_held, METH_NOARGS, doc_lock_held},
2940 {"acquire_lock", imp_acquire_lock, METH_NOARGS, doc_acquire_lock},
2941 {"release_lock", imp_release_lock, METH_NOARGS, doc_release_lock},
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002942 /* The rest are obsolete */
Neal Norwitz031829d2002-03-31 14:37:44 +00002943 {"get_frozen_object", imp_get_frozen_object, METH_VARARGS},
2944 {"init_builtin", imp_init_builtin, METH_VARARGS},
2945 {"init_frozen", imp_init_frozen, METH_VARARGS},
2946 {"is_builtin", imp_is_builtin, METH_VARARGS},
2947 {"is_frozen", imp_is_frozen, METH_VARARGS},
2948 {"load_compiled", imp_load_compiled, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002949#ifdef HAVE_DYNAMIC_LOADING
Neal Norwitz031829d2002-03-31 14:37:44 +00002950 {"load_dynamic", imp_load_dynamic, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002951#endif
Neal Norwitz031829d2002-03-31 14:37:44 +00002952 {"load_package", imp_load_package, METH_VARARGS},
Neal Norwitz031829d2002-03-31 14:37:44 +00002953 {"load_source", imp_load_source, METH_VARARGS},
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002954 {NULL, NULL} /* sentinel */
2955};
2956
Guido van Rossum1a8791e1998-08-04 22:46:29 +00002957static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002958setint(PyObject *d, char *name, int value)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002959{
2960 PyObject *v;
2961 int err;
2962
2963 v = PyInt_FromLong((long)value);
2964 err = PyDict_SetItemString(d, name, v);
2965 Py_XDECREF(v);
2966 return err;
2967}
2968
Phillip J. Ebyf7575d02006-07-28 21:12:07 +00002969typedef struct {
2970 PyObject_HEAD
2971} NullImporter;
2972
2973static int
2974NullImporter_init(NullImporter *self, PyObject *args, PyObject *kwds)
2975{
2976 char *path;
2977
2978 if (!_PyArg_NoKeywords("NullImporter()", kwds))
2979 return -1;
2980
2981 if (!PyArg_ParseTuple(args, "s:NullImporter",
2982 &path))
2983 return -1;
2984
2985 if (strlen(path) == 0) {
2986 PyErr_SetString(PyExc_ImportError, "empty pathname");
2987 return -1;
2988 } else {
2989#ifndef RISCOS
2990 struct stat statbuf;
2991 int rv;
2992
2993 rv = stat(path, &statbuf);
2994 if (rv == 0) {
2995 /* it exists */
2996 if (S_ISDIR(statbuf.st_mode)) {
2997 /* it's a directory */
2998 PyErr_SetString(PyExc_ImportError,
2999 "existing directory");
3000 return -1;
3001 }
3002 }
3003#else
3004 if (object_exists(path)) {
3005 /* it exists */
3006 if (isdir(path)) {
3007 /* it's a directory */
3008 PyErr_SetString(PyExc_ImportError,
3009 "existing directory");
3010 return -1;
3011 }
3012 }
3013#endif
3014 }
3015 return 0;
3016}
3017
3018static PyObject *
3019NullImporter_find_module(NullImporter *self, PyObject *args)
3020{
3021 Py_RETURN_NONE;
3022}
3023
3024static PyMethodDef NullImporter_methods[] = {
3025 {"find_module", (PyCFunction)NullImporter_find_module, METH_VARARGS,
3026 "Always return None"
3027 },
3028 {NULL} /* Sentinel */
3029};
3030
3031
3032static PyTypeObject NullImporterType = {
3033 PyObject_HEAD_INIT(NULL)
3034 0, /*ob_size*/
3035 "imp.NullImporter", /*tp_name*/
3036 sizeof(NullImporter), /*tp_basicsize*/
3037 0, /*tp_itemsize*/
3038 0, /*tp_dealloc*/
3039 0, /*tp_print*/
3040 0, /*tp_getattr*/
3041 0, /*tp_setattr*/
3042 0, /*tp_compare*/
3043 0, /*tp_repr*/
3044 0, /*tp_as_number*/
3045 0, /*tp_as_sequence*/
3046 0, /*tp_as_mapping*/
3047 0, /*tp_hash */
3048 0, /*tp_call*/
3049 0, /*tp_str*/
3050 0, /*tp_getattro*/
3051 0, /*tp_setattro*/
3052 0, /*tp_as_buffer*/
3053 Py_TPFLAGS_DEFAULT, /*tp_flags*/
3054 "Null importer object", /* tp_doc */
3055 0, /* tp_traverse */
3056 0, /* tp_clear */
3057 0, /* tp_richcompare */
3058 0, /* tp_weaklistoffset */
3059 0, /* tp_iter */
3060 0, /* tp_iternext */
3061 NullImporter_methods, /* tp_methods */
3062 0, /* tp_members */
3063 0, /* tp_getset */
3064 0, /* tp_base */
3065 0, /* tp_dict */
3066 0, /* tp_descr_get */
3067 0, /* tp_descr_set */
3068 0, /* tp_dictoffset */
3069 (initproc)NullImporter_init, /* tp_init */
3070 0, /* tp_alloc */
3071 PyType_GenericNew /* tp_new */
3072};
3073
3074
Jason Tishler6bc06ec2003-09-04 11:59:50 +00003075PyMODINIT_FUNC
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003076initimp(void)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003077{
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003078 PyObject *m, *d;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003079
Phillip J. Ebyf7575d02006-07-28 21:12:07 +00003080 if (PyType_Ready(&NullImporterType) < 0)
3081 goto failure;
3082
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003083 m = Py_InitModule4("imp", imp_methods, doc_imp,
3084 NULL, PYTHON_API_VERSION);
Neal Norwitz1ac754f2006-01-19 06:09:39 +00003085 if (m == NULL)
3086 goto failure;
Guido van Rossum79f25d91997-04-29 20:08:16 +00003087 d = PyModule_GetDict(m);
Neal Norwitz3cb31ac2006-08-13 18:10:47 +00003088 if (d == NULL)
3089 goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003090
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003091 if (setint(d, "SEARCH_ERROR", SEARCH_ERROR) < 0) goto failure;
3092 if (setint(d, "PY_SOURCE", PY_SOURCE) < 0) goto failure;
3093 if (setint(d, "PY_COMPILED", PY_COMPILED) < 0) goto failure;
3094 if (setint(d, "C_EXTENSION", C_EXTENSION) < 0) goto failure;
3095 if (setint(d, "PY_RESOURCE", PY_RESOURCE) < 0) goto failure;
3096 if (setint(d, "PKG_DIRECTORY", PKG_DIRECTORY) < 0) goto failure;
3097 if (setint(d, "C_BUILTIN", C_BUILTIN) < 0) goto failure;
3098 if (setint(d, "PY_FROZEN", PY_FROZEN) < 0) goto failure;
Guido van Rossum0f84a341998-08-06 13:36:01 +00003099 if (setint(d, "PY_CODERESOURCE", PY_CODERESOURCE) < 0) goto failure;
Just van Rossum52e14d62002-12-30 22:08:05 +00003100 if (setint(d, "IMP_HOOK", IMP_HOOK) < 0) goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003101
Phillip J. Ebyf7575d02006-07-28 21:12:07 +00003102 Py_INCREF(&NullImporterType);
3103 PyModule_AddObject(m, "NullImporter", (PyObject *)&NullImporterType);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003104 failure:
3105 ;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003106}
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003107
3108
Guido van Rossumb18618d2000-05-03 23:44:39 +00003109/* API for embedding applications that want to add their own entries
3110 to the table of built-in modules. This should normally be called
3111 *before* Py_Initialize(). When the table resize fails, -1 is
3112 returned and the existing table is unchanged.
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003113
3114 After a similar function by Just van Rossum. */
3115
3116int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003117PyImport_ExtendInittab(struct _inittab *newtab)
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003118{
3119 static struct _inittab *our_copy = NULL;
3120 struct _inittab *p;
3121 int i, n;
3122
3123 /* Count the number of entries in both tables */
3124 for (n = 0; newtab[n].name != NULL; n++)
3125 ;
3126 if (n == 0)
3127 return 0; /* Nothing to do */
3128 for (i = 0; PyImport_Inittab[i].name != NULL; i++)
3129 ;
3130
3131 /* Allocate new memory for the combined table */
Guido van Rossumb18618d2000-05-03 23:44:39 +00003132 p = our_copy;
3133 PyMem_RESIZE(p, struct _inittab, i+n+1);
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003134 if (p == NULL)
3135 return -1;
3136
3137 /* Copy the tables into the new memory */
3138 if (our_copy != PyImport_Inittab)
3139 memcpy(p, PyImport_Inittab, (i+1) * sizeof(struct _inittab));
3140 PyImport_Inittab = our_copy = p;
3141 memcpy(p+i, newtab, (n+1) * sizeof(struct _inittab));
3142
3143 return 0;
3144}
3145
3146/* Shorthand to add a single entry given a name and a function */
3147
3148int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003149PyImport_AppendInittab(char *name, void (*initfunc)(void))
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003150{
3151 struct _inittab newtab[2];
3152
3153 memset(newtab, '\0', sizeof newtab);
3154
3155 newtab[0].name = name;
3156 newtab[0].initfunc = initfunc;
3157
3158 return PyImport_ExtendInittab(newtab);
3159}
Anthony Baxterac6bd462006-04-13 02:06:09 +00003160
3161#ifdef __cplusplus
3162}
3163#endif