blob: dc979404de16a479640b56cad0836503746649f1 [file] [log] [blame]
Guido van Rossumf70e43a1991-02-19 12:39:46 +00001
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002/* Module definition and import implementation */
3
Guido van Rossum79f25d91997-04-29 20:08:16 +00004#include "Python.h"
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00005
Jeremy Hylton3e0055f2005-10-20 19:59:25 +00006#include "Python-ast.h"
Kristján Valur Jónsson67387fb2007-04-25 00:17:39 +00007#undef Yield /* undefine macro conflicting with winbase.h */
Neal Norwitzadb69fc2005-12-17 20:54:49 +00008#include "pyarena.h"
Jeremy Hylton3e0055f2005-10-20 19:59:25 +00009#include "pythonrun.h"
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000010#include "errcode.h"
Guido van Rossumc405b7b1991-06-04 19:39:42 +000011#include "marshal.h"
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000012#include "code.h"
Guido van Rossumc405b7b1991-06-04 19:39:42 +000013#include "compile.h"
Guido van Rossumff4949e1992-08-05 19:58:53 +000014#include "eval.h"
Guido van Rossumd8bac6d1992-02-26 15:19:13 +000015#include "osdefs.h"
Guido van Rossum1ae940a1995-01-02 19:04:15 +000016#include "importdl.h"
Guido van Rossumc405b7b1991-06-04 19:39:42 +000017
Guido van Rossum55a83382000-09-20 20:31:38 +000018#ifdef HAVE_FCNTL_H
19#include <fcntl.h>
20#endif
Anthony Baxterac6bd462006-04-13 02:06:09 +000021#ifdef __cplusplus
22extern "C" {
23#endif
Guido van Rossum55a83382000-09-20 20:31:38 +000024
Thomas Woutersf70ef4f2000-07-22 18:47:25 +000025extern time_t PyOS_GetLastModificationTime(char *, FILE *);
26 /* In getmtime.c */
Guido van Rossum21d335e1993-10-15 13:01:11 +000027
Jeremy Hyltond4ceb312004-04-01 02:45:22 +000028/* Magic word to reject .pyc files generated by other Python versions.
29 It should change for each incompatible change to the bytecode.
30
31 The value of CR and LF is incorporated so if you ever read or write
Guido van Rossum7faeab31995-07-07 22:50:36 +000032 a .pyc file in text mode the magic number will be wrong; also, the
Tim Peters36515e22001-11-18 04:06:29 +000033 Apple MPW compiler swaps their values, botching string constants.
Marc-André Lemburgbd3be8f2002-02-07 11:33:49 +000034
Martin v. Löwisef82d2f2004-06-27 16:51:46 +000035 The magic numbers must be spaced apart atleast 2 values, as the
36 -U interpeter flag will cause MAGIC+1 being used. They have been
37 odd numbers for some time now.
Marc-André Lemburgbd3be8f2002-02-07 11:33:49 +000038
Jeremy Hyltond4ceb312004-04-01 02:45:22 +000039 There were a variety of old schemes for setting the magic number.
40 The current working scheme is to increment the previous value by
41 10.
Guido van Rossumf6894922002-08-31 15:16:14 +000042
Marc-André Lemburgbd3be8f2002-02-07 11:33:49 +000043 Known values:
44 Python 1.5: 20121
45 Python 1.5.1: 20121
46 Python 1.5.2: 20121
Skip Montanaro4ec3c262006-03-25 14:12:03 +000047 Python 1.6: 50428
Marc-André Lemburgbd3be8f2002-02-07 11:33:49 +000048 Python 2.0: 50823
49 Python 2.0.1: 50823
50 Python 2.1: 60202
51 Python 2.1.1: 60202
52 Python 2.1.2: 60202
53 Python 2.2: 60717
Neal Norwitz7fdcb412002-06-14 01:07:39 +000054 Python 2.3a0: 62011
Michael W. Hudsondd32a912002-08-15 14:59:02 +000055 Python 2.3a0: 62021
Guido van Rossumf6894922002-08-31 15:16:14 +000056 Python 2.3a0: 62011 (!)
Martin v. Löwisef82d2f2004-06-27 16:51:46 +000057 Python 2.4a0: 62041
Raymond Hettingerfd2d1f72004-08-23 23:37:48 +000058 Python 2.4a3: 62051
Raymond Hettinger2c31a052004-09-22 18:44:21 +000059 Python 2.4b1: 62061
Michael W. Hudsondf888462005-06-03 14:41:55 +000060 Python 2.5a0: 62071
Michael W. Hudsonaee2e282005-10-21 11:32:20 +000061 Python 2.5a0: 62081 (ast-branch)
Guido van Rossumc2e20742006-02-27 22:32:47 +000062 Python 2.5a0: 62091 (with)
Guido van Rossumf6694362006-03-10 02:28:35 +000063 Python 2.5a0: 62092 (changed WITH_CLEANUP opcode)
Neal Norwitz0d62a062006-07-30 06:53:31 +000064 Python 2.5b3: 62101 (fix wrong code: for x, in ...)
65 Python 2.5b3: 62111 (fix wrong code: x += yield)
Neal Norwitz9a70f952006-08-04 05:12:19 +000066 Python 2.5c1: 62121 (fix wrong lnotab with for loops and
67 storing constants that should have been removed)
Neal Norwitzdac090d2006-09-05 03:53:08 +000068 Python 2.5c2: 62131 (fix wrong code: for x, in ... in listcomp/genexp)
Neal Norwitzcbeb6872006-10-14 21:33:38 +000069 Python 2.6a0: 62141 (peephole optimizations)
Michael W. Hudsonaee2e282005-10-21 11:32:20 +000070.
Tim Peters36515e22001-11-18 04:06:29 +000071*/
Neal Norwitzcbeb6872006-10-14 21:33:38 +000072#define MAGIC (62141 | ((long)'\r'<<16) | ((long)'\n'<<24))
Guido van Rossum3ddee711991-12-16 13:06:34 +000073
Guido van Rossum96774c12000-05-01 20:19:08 +000074/* Magic word as global; note that _PyImport_Init() can change the
Jeremy Hylton9262b8a2000-06-30 04:59:17 +000075 value of this global to accommodate for alterations of how the
Guido van Rossum96774c12000-05-01 20:19:08 +000076 compiler works which are enabled by command line switches. */
77static long pyc_magic = MAGIC;
78
Guido van Rossum25ce5661997-08-02 03:10:38 +000079/* See _PyImport_FixupExtension() below */
80static PyObject *extensions = NULL;
Guido van Rossum3f5da241990-12-20 15:06:42 +000081
Guido van Rossum771c6c81997-10-31 18:37:24 +000082/* This table is defined in config.c: */
83extern struct _inittab _PyImport_Inittab[];
84
85struct _inittab *PyImport_Inittab = _PyImport_Inittab;
Guido van Rossum66f1fa81991-04-03 19:03:52 +000086
Guido van Rossumed1170e1999-12-20 21:23:41 +000087/* these tables define the module suffixes that Python recognizes */
88struct filedescr * _PyImport_Filetab = NULL;
Guido van Rossum48a680c2001-03-02 06:34:14 +000089
90#ifdef RISCOS
91static const struct filedescr _PyImport_StandardFiletab[] = {
Jack Jansenc88da1f2002-05-28 10:58:19 +000092 {"/py", "U", PY_SOURCE},
Guido van Rossum48a680c2001-03-02 06:34:14 +000093 {"/pyc", "rb", PY_COMPILED},
94 {0, 0}
95};
96#else
Guido van Rossumed1170e1999-12-20 21:23:41 +000097static const struct filedescr _PyImport_StandardFiletab[] = {
Jack Jansenc88da1f2002-05-28 10:58:19 +000098 {".py", "U", PY_SOURCE},
Martin v. Löwis6238d2b2002-06-30 15:26:10 +000099#ifdef MS_WINDOWS
Jack Jansenc88da1f2002-05-28 10:58:19 +0000100 {".pyw", "U", PY_SOURCE},
Tim Peters36515e22001-11-18 04:06:29 +0000101#endif
Guido van Rossumed1170e1999-12-20 21:23:41 +0000102 {".pyc", "rb", PY_COMPILED},
103 {0, 0}
104};
Guido van Rossum48a680c2001-03-02 06:34:14 +0000105#endif
Guido van Rossumed1170e1999-12-20 21:23:41 +0000106
Phillip J. Ebyf7575d02006-07-28 21:12:07 +0000107static PyTypeObject NullImporterType; /* Forward reference */
108
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000109/* Initialize things */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000110
111void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000112_PyImport_Init(void)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000113{
Guido van Rossumed1170e1999-12-20 21:23:41 +0000114 const struct filedescr *scan;
115 struct filedescr *filetab;
116 int countD = 0;
117 int countS = 0;
118
119 /* prepare _PyImport_Filetab: copy entries from
120 _PyImport_DynLoadFiletab and _PyImport_StandardFiletab.
121 */
122 for (scan = _PyImport_DynLoadFiletab; scan->suffix != NULL; ++scan)
123 ++countD;
124 for (scan = _PyImport_StandardFiletab; scan->suffix != NULL; ++scan)
125 ++countS;
Guido van Rossumb18618d2000-05-03 23:44:39 +0000126 filetab = PyMem_NEW(struct filedescr, countD + countS + 1);
Neal Norwitze1fdb322006-07-21 05:32:28 +0000127 if (filetab == NULL)
Neal Norwitz33722ae2006-07-21 07:59:02 +0000128 Py_FatalError("Can't initialize import file table.");
Guido van Rossumed1170e1999-12-20 21:23:41 +0000129 memcpy(filetab, _PyImport_DynLoadFiletab,
130 countD * sizeof(struct filedescr));
131 memcpy(filetab + countD, _PyImport_StandardFiletab,
132 countS * sizeof(struct filedescr));
133 filetab[countD + countS].suffix = NULL;
134
135 _PyImport_Filetab = filetab;
136
Guido van Rossum0824f631997-03-11 18:37:35 +0000137 if (Py_OptimizeFlag) {
Guido van Rossumed1170e1999-12-20 21:23:41 +0000138 /* Replace ".pyc" with ".pyo" in _PyImport_Filetab */
139 for (; filetab->suffix != NULL; filetab++) {
Guido van Rossum48a680c2001-03-02 06:34:14 +0000140#ifndef RISCOS
Guido van Rossumed1170e1999-12-20 21:23:41 +0000141 if (strcmp(filetab->suffix, ".pyc") == 0)
142 filetab->suffix = ".pyo";
Guido van Rossum48a680c2001-03-02 06:34:14 +0000143#else
144 if (strcmp(filetab->suffix, "/pyc") == 0)
145 filetab->suffix = "/pyo";
146#endif
Guido van Rossum0824f631997-03-11 18:37:35 +0000147 }
148 }
Guido van Rossum96774c12000-05-01 20:19:08 +0000149
150 if (Py_UnicodeFlag) {
151 /* Fix the pyc_magic so that byte compiled code created
152 using the all-Unicode method doesn't interfere with
153 code created in normal operation mode. */
154 pyc_magic = MAGIC + 1;
155 }
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000156}
157
Guido van Rossum25ce5661997-08-02 03:10:38 +0000158void
Just van Rossum52e14d62002-12-30 22:08:05 +0000159_PyImportHooks_Init(void)
160{
161 PyObject *v, *path_hooks = NULL, *zimpimport;
162 int err = 0;
163
164 /* adding sys.path_hooks and sys.path_importer_cache, setting up
165 zipimport */
Phillip J. Ebyf7575d02006-07-28 21:12:07 +0000166 if (PyType_Ready(&NullImporterType) < 0)
167 goto error;
Just van Rossum52e14d62002-12-30 22:08:05 +0000168
169 if (Py_VerboseFlag)
170 PySys_WriteStderr("# installing zipimport hook\n");
171
172 v = PyList_New(0);
173 if (v == NULL)
174 goto error;
175 err = PySys_SetObject("meta_path", v);
176 Py_DECREF(v);
177 if (err)
178 goto error;
179 v = PyDict_New();
180 if (v == NULL)
181 goto error;
182 err = PySys_SetObject("path_importer_cache", v);
183 Py_DECREF(v);
184 if (err)
185 goto error;
186 path_hooks = PyList_New(0);
187 if (path_hooks == NULL)
188 goto error;
189 err = PySys_SetObject("path_hooks", path_hooks);
190 if (err) {
191 error:
192 PyErr_Print();
Phillip J. Ebyf7575d02006-07-28 21:12:07 +0000193 Py_FatalError("initializing sys.meta_path, sys.path_hooks, "
194 "path_importer_cache, or NullImporter failed"
195 );
Just van Rossum52e14d62002-12-30 22:08:05 +0000196 }
Phillip J. Ebyf7575d02006-07-28 21:12:07 +0000197
Just van Rossum52e14d62002-12-30 22:08:05 +0000198 zimpimport = PyImport_ImportModule("zipimport");
199 if (zimpimport == NULL) {
200 PyErr_Clear(); /* No zip import module -- okay */
201 if (Py_VerboseFlag)
202 PySys_WriteStderr("# can't import zipimport\n");
203 }
204 else {
205 PyObject *zipimporter = PyObject_GetAttrString(zimpimport,
206 "zipimporter");
207 Py_DECREF(zimpimport);
208 if (zipimporter == NULL) {
209 PyErr_Clear(); /* No zipimporter object -- okay */
210 if (Py_VerboseFlag)
211 PySys_WriteStderr(
Fred Drake1e5fc552003-07-11 15:01:02 +0000212 "# can't import zipimport.zipimporter\n");
Just van Rossum52e14d62002-12-30 22:08:05 +0000213 }
214 else {
215 /* sys.path_hooks.append(zipimporter) */
216 err = PyList_Append(path_hooks, zipimporter);
217 Py_DECREF(zipimporter);
218 if (err)
219 goto error;
220 if (Py_VerboseFlag)
221 PySys_WriteStderr(
222 "# installed zipimport hook\n");
223 }
224 }
225 Py_DECREF(path_hooks);
226}
227
228void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000229_PyImport_Fini(void)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000230{
231 Py_XDECREF(extensions);
232 extensions = NULL;
Barry Warsaw84294482000-10-03 16:02:05 +0000233 PyMem_DEL(_PyImport_Filetab);
234 _PyImport_Filetab = NULL;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000235}
236
237
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000238/* Locking primitives to prevent parallel imports of the same module
239 in different threads to return with a partially loaded module.
240 These calls are serialized by the global interpreter lock. */
241
242#ifdef WITH_THREAD
243
Guido van Rossum49b56061998-10-01 20:42:43 +0000244#include "pythread.h"
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000245
Guido van Rossum65d5b571998-12-21 19:32:43 +0000246static PyThread_type_lock import_lock = 0;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000247static long import_lock_thread = -1;
248static int import_lock_level = 0;
249
250static void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000251lock_import(void)
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000252{
Guido van Rossum65d5b571998-12-21 19:32:43 +0000253 long me = PyThread_get_thread_ident();
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000254 if (me == -1)
255 return; /* Too bad */
Neal Norwitze1fdb322006-07-21 05:32:28 +0000256 if (import_lock == NULL) {
Guido van Rossum65d5b571998-12-21 19:32:43 +0000257 import_lock = PyThread_allocate_lock();
Neal Norwitze1fdb322006-07-21 05:32:28 +0000258 if (import_lock == NULL)
259 return; /* Nothing much we can do. */
260 }
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000261 if (import_lock_thread == me) {
262 import_lock_level++;
263 return;
264 }
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000265 if (import_lock_thread != -1 || !PyThread_acquire_lock(import_lock, 0))
266 {
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000267 PyThreadState *tstate = PyEval_SaveThread();
Guido van Rossum65d5b571998-12-21 19:32:43 +0000268 PyThread_acquire_lock(import_lock, 1);
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000269 PyEval_RestoreThread(tstate);
270 }
271 import_lock_thread = me;
272 import_lock_level = 1;
273}
274
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000275static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000276unlock_import(void)
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000277{
Guido van Rossum65d5b571998-12-21 19:32:43 +0000278 long me = PyThread_get_thread_ident();
Neal Norwitze1fdb322006-07-21 05:32:28 +0000279 if (me == -1 || import_lock == NULL)
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000280 return 0; /* Too bad */
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000281 if (import_lock_thread != me)
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000282 return -1;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000283 import_lock_level--;
284 if (import_lock_level == 0) {
285 import_lock_thread = -1;
Guido van Rossum65d5b571998-12-21 19:32:43 +0000286 PyThread_release_lock(import_lock);
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000287 }
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000288 return 1;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000289}
290
Guido van Rossum8ee3e5a2005-09-14 18:09:42 +0000291/* This function is called from PyOS_AfterFork to ensure that newly
292 created child processes do not share locks with the parent. */
293
294void
295_PyImport_ReInitLock(void)
296{
297#ifdef _AIX
298 if (import_lock != NULL)
299 import_lock = PyThread_allocate_lock();
300#endif
301}
302
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000303#else
304
305#define lock_import()
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000306#define unlock_import() 0
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000307
308#endif
309
Tim Peters69232342001-08-30 05:16:13 +0000310static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000311imp_lock_held(PyObject *self, PyObject *noargs)
Tim Peters69232342001-08-30 05:16:13 +0000312{
Tim Peters69232342001-08-30 05:16:13 +0000313#ifdef WITH_THREAD
Guido van Rossumb8bff3f2002-04-07 06:34:38 +0000314 return PyBool_FromLong(import_lock_thread != -1);
Tim Peters69232342001-08-30 05:16:13 +0000315#else
Guido van Rossumb8bff3f2002-04-07 06:34:38 +0000316 return PyBool_FromLong(0);
Tim Peters69232342001-08-30 05:16:13 +0000317#endif
318}
319
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000320static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000321imp_acquire_lock(PyObject *self, PyObject *noargs)
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000322{
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000323#ifdef WITH_THREAD
324 lock_import();
325#endif
Neal Norwitz2294c0d2003-02-12 23:02:21 +0000326 Py_INCREF(Py_None);
327 return Py_None;
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000328}
329
330static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000331imp_release_lock(PyObject *self, PyObject *noargs)
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000332{
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000333#ifdef WITH_THREAD
334 if (unlock_import() < 0) {
335 PyErr_SetString(PyExc_RuntimeError,
336 "not holding the import lock");
337 return NULL;
338 }
339#endif
Neal Norwitz2294c0d2003-02-12 23:02:21 +0000340 Py_INCREF(Py_None);
341 return Py_None;
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000342}
343
Collin Winter276887b2007-03-12 16:11:39 +0000344static void
Neal Norwitz75c7c802007-03-13 05:31:38 +0000345imp_modules_reloading_clear(void)
Collin Winter276887b2007-03-12 16:11:39 +0000346{
347 PyInterpreterState *interp = PyThreadState_Get()->interp;
Neal Norwitz75c7c802007-03-13 05:31:38 +0000348 if (interp->modules_reloading != NULL)
349 PyDict_Clear(interp->modules_reloading);
Collin Winter276887b2007-03-12 16:11:39 +0000350}
351
Guido van Rossum25ce5661997-08-02 03:10:38 +0000352/* Helper for sys */
353
354PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000355PyImport_GetModuleDict(void)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000356{
Nicholas Bastine5662ae2004-03-24 22:22:12 +0000357 PyInterpreterState *interp = PyThreadState_GET()->interp;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000358 if (interp->modules == NULL)
359 Py_FatalError("PyImport_GetModuleDict: no module dictionary!");
360 return interp->modules;
361}
362
Guido van Rossum3f5da241990-12-20 15:06:42 +0000363
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000364/* List of names to clear in sys */
365static char* sys_deletes[] = {
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000366 "path", "argv", "ps1", "ps2", "exitfunc",
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000367 "exc_type", "exc_value", "exc_traceback",
368 "last_type", "last_value", "last_traceback",
Just van Rossum52e14d62002-12-30 22:08:05 +0000369 "path_hooks", "path_importer_cache", "meta_path",
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000370 NULL
371};
372
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000373static char* sys_files[] = {
374 "stdin", "__stdin__",
375 "stdout", "__stdout__",
376 "stderr", "__stderr__",
377 NULL
378};
379
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000380
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000381/* Un-initialize things, as good as we can */
Guido van Rossum3f5da241990-12-20 15:06:42 +0000382
Guido van Rossum3f5da241990-12-20 15:06:42 +0000383void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000384PyImport_Cleanup(void)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000385{
Martin v. Löwis18e16552006-02-15 17:27:45 +0000386 Py_ssize_t pos, ndone;
Guido van Rossum758eec01998-01-19 21:58:26 +0000387 char *name;
388 PyObject *key, *value, *dict;
Nicholas Bastine5662ae2004-03-24 22:22:12 +0000389 PyInterpreterState *interp = PyThreadState_GET()->interp;
Guido van Rossum758eec01998-01-19 21:58:26 +0000390 PyObject *modules = interp->modules;
391
392 if (modules == NULL)
393 return; /* Already done */
394
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000395 /* Delete some special variables first. These are common
396 places where user values hide and people complain when their
397 destructors fail. Since the modules containing them are
398 deleted *last* of all, they would come too late in the normal
399 destruction order. Sigh. */
400
401 value = PyDict_GetItemString(modules, "__builtin__");
402 if (value != NULL && PyModule_Check(value)) {
403 dict = PyModule_GetDict(value);
404 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000405 PySys_WriteStderr("# clear __builtin__._\n");
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000406 PyDict_SetItemString(dict, "_", Py_None);
407 }
408 value = PyDict_GetItemString(modules, "sys");
409 if (value != NULL && PyModule_Check(value)) {
410 char **p;
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000411 PyObject *v;
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000412 dict = PyModule_GetDict(value);
413 for (p = sys_deletes; *p != NULL; p++) {
414 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000415 PySys_WriteStderr("# clear sys.%s\n", *p);
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000416 PyDict_SetItemString(dict, *p, Py_None);
417 }
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000418 for (p = sys_files; *p != NULL; p+=2) {
419 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000420 PySys_WriteStderr("# restore sys.%s\n", *p);
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000421 v = PyDict_GetItemString(dict, *(p+1));
422 if (v == NULL)
423 v = Py_None;
424 PyDict_SetItemString(dict, *p, v);
425 }
426 }
427
428 /* First, delete __main__ */
429 value = PyDict_GetItemString(modules, "__main__");
430 if (value != NULL && PyModule_Check(value)) {
431 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000432 PySys_WriteStderr("# cleanup __main__\n");
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000433 _PyModule_Clear(value);
434 PyDict_SetItemString(modules, "__main__", Py_None);
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000435 }
436
Guido van Rossum758eec01998-01-19 21:58:26 +0000437 /* The special treatment of __builtin__ here is because even
438 when it's not referenced as a module, its dictionary is
439 referenced by almost every module's __builtins__. Since
440 deleting a module clears its dictionary (even if there are
441 references left to it), we need to delete the __builtin__
442 module last. Likewise, we don't delete sys until the very
443 end because it is implicitly referenced (e.g. by print).
444
445 Also note that we 'delete' modules by replacing their entry
446 in the modules dict with None, rather than really deleting
447 them; this avoids a rehash of the modules dictionary and
448 also marks them as "non existent" so they won't be
449 re-imported. */
450
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000451 /* Next, repeatedly delete modules with a reference count of
Guido van Rossum758eec01998-01-19 21:58:26 +0000452 one (skipping __builtin__ and sys) and delete them */
453 do {
454 ndone = 0;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000455 pos = 0;
Guido van Rossum758eec01998-01-19 21:58:26 +0000456 while (PyDict_Next(modules, &pos, &key, &value)) {
457 if (value->ob_refcnt != 1)
458 continue;
Guido van Rossum566373e1998-10-01 15:24:50 +0000459 if (PyString_Check(key) && PyModule_Check(value)) {
460 name = PyString_AS_STRING(key);
Guido van Rossum758eec01998-01-19 21:58:26 +0000461 if (strcmp(name, "__builtin__") == 0)
462 continue;
463 if (strcmp(name, "sys") == 0)
464 continue;
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000465 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000466 PySys_WriteStderr(
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000467 "# cleanup[1] %s\n", name);
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000468 _PyModule_Clear(value);
Guido van Rossum758eec01998-01-19 21:58:26 +0000469 PyDict_SetItem(modules, key, Py_None);
470 ndone++;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000471 }
472 }
Guido van Rossum758eec01998-01-19 21:58:26 +0000473 } while (ndone > 0);
474
Guido van Rossum758eec01998-01-19 21:58:26 +0000475 /* Next, delete all modules (still skipping __builtin__ and sys) */
476 pos = 0;
477 while (PyDict_Next(modules, &pos, &key, &value)) {
Guido van Rossum566373e1998-10-01 15:24:50 +0000478 if (PyString_Check(key) && PyModule_Check(value)) {
479 name = PyString_AS_STRING(key);
Guido van Rossum758eec01998-01-19 21:58:26 +0000480 if (strcmp(name, "__builtin__") == 0)
481 continue;
482 if (strcmp(name, "sys") == 0)
483 continue;
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000484 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000485 PySys_WriteStderr("# cleanup[2] %s\n", name);
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000486 _PyModule_Clear(value);
Guido van Rossum758eec01998-01-19 21:58:26 +0000487 PyDict_SetItem(modules, key, Py_None);
488 }
489 }
490
491 /* Next, delete sys and __builtin__ (in that order) */
492 value = PyDict_GetItemString(modules, "sys");
493 if (value != NULL && PyModule_Check(value)) {
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000494 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000495 PySys_WriteStderr("# cleanup sys\n");
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000496 _PyModule_Clear(value);
Guido van Rossum758eec01998-01-19 21:58:26 +0000497 PyDict_SetItemString(modules, "sys", Py_None);
498 }
499 value = PyDict_GetItemString(modules, "__builtin__");
500 if (value != NULL && PyModule_Check(value)) {
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000501 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000502 PySys_WriteStderr("# cleanup __builtin__\n");
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000503 _PyModule_Clear(value);
Guido van Rossum758eec01998-01-19 21:58:26 +0000504 PyDict_SetItemString(modules, "__builtin__", Py_None);
505 }
506
507 /* Finally, clear and delete the modules directory */
508 PyDict_Clear(modules);
509 interp->modules = NULL;
510 Py_DECREF(modules);
Collin Winter276887b2007-03-12 16:11:39 +0000511 Py_CLEAR(interp->modules_reloading);
Guido van Rossum8d15b5d1990-10-26 14:58:58 +0000512}
Guido van Rossum7f133ed1991-02-19 12:23:57 +0000513
514
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000515/* Helper for pythonrun.c -- return magic number */
516
517long
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000518PyImport_GetMagicNumber(void)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000519{
Guido van Rossum96774c12000-05-01 20:19:08 +0000520 return pyc_magic;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000521}
522
523
Guido van Rossum25ce5661997-08-02 03:10:38 +0000524/* Magic for extension modules (built-in as well as dynamically
525 loaded). To prevent initializing an extension module more than
526 once, we keep a static dictionary 'extensions' keyed by module name
527 (for built-in modules) or by filename (for dynamically loaded
Barry Warsaw92883382001-08-13 23:05:44 +0000528 modules), containing these modules. A copy of the module's
Guido van Rossum25ce5661997-08-02 03:10:38 +0000529 dictionary is stored by calling _PyImport_FixupExtension()
530 immediately after the module initialization function succeeds. A
531 copy can be retrieved from there by calling
532 _PyImport_FindExtension(). */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000533
Guido van Rossum79f25d91997-04-29 20:08:16 +0000534PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000535_PyImport_FixupExtension(char *name, char *filename)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000536{
Guido van Rossum25ce5661997-08-02 03:10:38 +0000537 PyObject *modules, *mod, *dict, *copy;
538 if (extensions == NULL) {
539 extensions = PyDict_New();
540 if (extensions == NULL)
541 return NULL;
542 }
543 modules = PyImport_GetModuleDict();
544 mod = PyDict_GetItemString(modules, name);
545 if (mod == NULL || !PyModule_Check(mod)) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000546 PyErr_Format(PyExc_SystemError,
547 "_PyImport_FixupExtension: module %.200s not loaded", name);
Guido van Rossum25ce5661997-08-02 03:10:38 +0000548 return NULL;
549 }
550 dict = PyModule_GetDict(mod);
551 if (dict == NULL)
552 return NULL;
Fred Drake9cd0efc2001-10-25 21:38:59 +0000553 copy = PyDict_Copy(dict);
Guido van Rossum25ce5661997-08-02 03:10:38 +0000554 if (copy == NULL)
555 return NULL;
556 PyDict_SetItemString(extensions, filename, copy);
557 Py_DECREF(copy);
558 return copy;
559}
560
561PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000562_PyImport_FindExtension(char *name, char *filename)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000563{
Fred Drake9cd0efc2001-10-25 21:38:59 +0000564 PyObject *dict, *mod, *mdict;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000565 if (extensions == NULL)
566 return NULL;
567 dict = PyDict_GetItemString(extensions, filename);
568 if (dict == NULL)
569 return NULL;
570 mod = PyImport_AddModule(name);
571 if (mod == NULL)
572 return NULL;
573 mdict = PyModule_GetDict(mod);
574 if (mdict == NULL)
575 return NULL;
Fred Drake9cd0efc2001-10-25 21:38:59 +0000576 if (PyDict_Update(mdict, dict))
Guido van Rossum25ce5661997-08-02 03:10:38 +0000577 return NULL;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000578 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000579 PySys_WriteStderr("import %s # previously loaded (%s)\n",
Guido van Rossum25ce5661997-08-02 03:10:38 +0000580 name, filename);
581 return mod;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000582}
583
584
585/* Get the module object corresponding to a module name.
586 First check the modules dictionary if there's one there,
Walter Dörwaldf0dfc7a2003-10-20 14:01:56 +0000587 if not, create a new one and insert it in the modules dictionary.
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000588 Because the former action is most common, THIS DOES NOT RETURN A
589 'NEW' REFERENCE! */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000590
Guido van Rossum79f25d91997-04-29 20:08:16 +0000591PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000592PyImport_AddModule(const char *name)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000593{
Guido van Rossum25ce5661997-08-02 03:10:38 +0000594 PyObject *modules = PyImport_GetModuleDict();
Guido van Rossum79f25d91997-04-29 20:08:16 +0000595 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000596
Guido van Rossum25ce5661997-08-02 03:10:38 +0000597 if ((m = PyDict_GetItemString(modules, name)) != NULL &&
Guido van Rossum79f25d91997-04-29 20:08:16 +0000598 PyModule_Check(m))
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000599 return m;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000600 m = PyModule_New(name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000601 if (m == NULL)
602 return NULL;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000603 if (PyDict_SetItemString(modules, name, m) != 0) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000604 Py_DECREF(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000605 return NULL;
606 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000607 Py_DECREF(m); /* Yes, it still exists, in modules! */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000608
609 return m;
610}
611
Tim Peters1cd70172004-08-02 03:52:12 +0000612/* Remove name from sys.modules, if it's there. */
613static void
614_RemoveModule(const char *name)
615{
616 PyObject *modules = PyImport_GetModuleDict();
617 if (PyDict_GetItemString(modules, name) == NULL)
618 return;
619 if (PyDict_DelItemString(modules, name) < 0)
620 Py_FatalError("import: deleting existing key in"
621 "sys.modules failed");
622}
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000623
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000624/* Execute a code object in a module and return the module object
Tim Peters1cd70172004-08-02 03:52:12 +0000625 * WITH INCREMENTED REFERENCE COUNT. If an error occurs, name is
626 * removed from sys.modules, to avoid leaving damaged module objects
627 * in sys.modules. The caller may wish to restore the original
628 * module object (if any) in this case; PyImport_ReloadModule is an
629 * example.
630 */
Guido van Rossum79f25d91997-04-29 20:08:16 +0000631PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000632PyImport_ExecCodeModule(char *name, PyObject *co)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000633{
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000634 return PyImport_ExecCodeModuleEx(name, co, (char *)NULL);
635}
636
637PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000638PyImport_ExecCodeModuleEx(char *name, PyObject *co, char *pathname)
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000639{
Guido van Rossum25ce5661997-08-02 03:10:38 +0000640 PyObject *modules = PyImport_GetModuleDict();
Guido van Rossum79f25d91997-04-29 20:08:16 +0000641 PyObject *m, *d, *v;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000642
Guido van Rossum79f25d91997-04-29 20:08:16 +0000643 m = PyImport_AddModule(name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000644 if (m == NULL)
645 return NULL;
Jeremy Hyltonecd91292004-01-02 23:25:32 +0000646 /* If the module is being reloaded, we get the old module back
647 and re-use its dict to exec the new code. */
Guido van Rossum79f25d91997-04-29 20:08:16 +0000648 d = PyModule_GetDict(m);
649 if (PyDict_GetItemString(d, "__builtins__") == NULL) {
650 if (PyDict_SetItemString(d, "__builtins__",
651 PyEval_GetBuiltins()) != 0)
Tim Peters1cd70172004-08-02 03:52:12 +0000652 goto error;
Guido van Rossum6135a871995-01-09 17:53:26 +0000653 }
Guido van Rossum9c9a07c1996-05-16 20:43:40 +0000654 /* Remember the filename as the __file__ attribute */
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000655 v = NULL;
656 if (pathname != NULL) {
657 v = PyString_FromString(pathname);
658 if (v == NULL)
659 PyErr_Clear();
660 }
661 if (v == NULL) {
662 v = ((PyCodeObject *)co)->co_filename;
663 Py_INCREF(v);
664 }
665 if (PyDict_SetItemString(d, "__file__", v) != 0)
Guido van Rossum79f25d91997-04-29 20:08:16 +0000666 PyErr_Clear(); /* Not important enough to report */
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000667 Py_DECREF(v);
668
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000669 v = PyEval_EvalCode((PyCodeObject *)co, d, d);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000670 if (v == NULL)
Tim Peters1cd70172004-08-02 03:52:12 +0000671 goto error;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000672 Py_DECREF(v);
Guido van Rossumb65e85c1997-07-10 18:00:45 +0000673
Guido van Rossum25ce5661997-08-02 03:10:38 +0000674 if ((m = PyDict_GetItemString(modules, name)) == NULL) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000675 PyErr_Format(PyExc_ImportError,
676 "Loaded module %.200s not found in sys.modules",
677 name);
Guido van Rossumb65e85c1997-07-10 18:00:45 +0000678 return NULL;
679 }
680
Guido van Rossum79f25d91997-04-29 20:08:16 +0000681 Py_INCREF(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000682
683 return m;
Tim Peters1cd70172004-08-02 03:52:12 +0000684
685 error:
686 _RemoveModule(name);
687 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000688}
689
690
691/* Given a pathname for a Python source file, fill a buffer with the
692 pathname for the corresponding compiled file. Return the pathname
693 for the compiled file, or NULL if there's no space in the buffer.
694 Doesn't set an exception. */
695
696static char *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000697make_compiled_pathname(char *pathname, char *buf, size_t buflen)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000698{
Tim Petersc1731372001-08-04 08:12:36 +0000699 size_t len = strlen(pathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000700 if (len+2 > buflen)
701 return NULL;
Tim Petersc1731372001-08-04 08:12:36 +0000702
Martin v. Löwis6238d2b2002-06-30 15:26:10 +0000703#ifdef MS_WINDOWS
Tim Petersc1731372001-08-04 08:12:36 +0000704 /* Treat .pyw as if it were .py. The case of ".pyw" must match
705 that used in _PyImport_StandardFiletab. */
706 if (len >= 4 && strcmp(&pathname[len-4], ".pyw") == 0)
707 --len; /* pretend 'w' isn't there */
708#endif
709 memcpy(buf, pathname, len);
710 buf[len] = Py_OptimizeFlag ? 'o' : 'c';
711 buf[len+1] = '\0';
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000712
713 return buf;
714}
715
716
717/* Given a pathname for a Python source file, its time of last
718 modification, and a pathname for a compiled file, check whether the
719 compiled file represents the same version of the source. If so,
720 return a FILE pointer for the compiled file, positioned just after
721 the header; if not, return NULL.
722 Doesn't set an exception. */
723
724static FILE *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000725check_compiled_module(char *pathname, time_t mtime, char *cpathname)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000726{
727 FILE *fp;
728 long magic;
729 long pyc_mtime;
730
731 fp = fopen(cpathname, "rb");
732 if (fp == NULL)
733 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000734 magic = PyMarshal_ReadLongFromFile(fp);
Guido van Rossum96774c12000-05-01 20:19:08 +0000735 if (magic != pyc_magic) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000736 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000737 PySys_WriteStderr("# %s has bad magic\n", cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000738 fclose(fp);
739 return NULL;
740 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000741 pyc_mtime = PyMarshal_ReadLongFromFile(fp);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000742 if (pyc_mtime != mtime) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000743 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000744 PySys_WriteStderr("# %s has bad mtime\n", cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000745 fclose(fp);
746 return NULL;
747 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000748 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000749 PySys_WriteStderr("# %s matches %s\n", cpathname, pathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000750 return fp;
751}
752
753
754/* Read a code object from a file and check it for validity */
755
Guido van Rossum79f25d91997-04-29 20:08:16 +0000756static PyCodeObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000757read_compiled_module(char *cpathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000758{
Guido van Rossum79f25d91997-04-29 20:08:16 +0000759 PyObject *co;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000760
Tim Petersd9b9ac82001-01-28 00:27:39 +0000761 co = PyMarshal_ReadLastObjectFromFile(fp);
Armin Rigo01ab2792004-03-26 15:09:27 +0000762 if (co == NULL)
763 return NULL;
764 if (!PyCode_Check(co)) {
765 PyErr_Format(PyExc_ImportError,
766 "Non-code object in %.200s", cpathname);
767 Py_DECREF(co);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000768 return NULL;
769 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000770 return (PyCodeObject *)co;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000771}
772
773
774/* Load a module from a compiled file, execute it, and return its
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000775 module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000776
Guido van Rossum79f25d91997-04-29 20:08:16 +0000777static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000778load_compiled_module(char *name, char *cpathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000779{
780 long magic;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000781 PyCodeObject *co;
782 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000783
Guido van Rossum79f25d91997-04-29 20:08:16 +0000784 magic = PyMarshal_ReadLongFromFile(fp);
Guido van Rossum96774c12000-05-01 20:19:08 +0000785 if (magic != pyc_magic) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000786 PyErr_Format(PyExc_ImportError,
787 "Bad magic number in %.200s", cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000788 return NULL;
789 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000790 (void) PyMarshal_ReadLongFromFile(fp);
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000791 co = read_compiled_module(cpathname, fp);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000792 if (co == NULL)
793 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000794 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000795 PySys_WriteStderr("import %s # precompiled from %s\n",
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000796 name, cpathname);
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000797 m = PyImport_ExecCodeModuleEx(name, (PyObject *)co, cpathname);
Guido van Rossum79f25d91997-04-29 20:08:16 +0000798 Py_DECREF(co);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000799
800 return m;
801}
802
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000803/* Parse a source file and return the corresponding code object */
804
Guido van Rossum79f25d91997-04-29 20:08:16 +0000805static PyCodeObject *
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000806parse_source_module(const char *pathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000807{
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000808 PyCodeObject *co = NULL;
809 mod_ty mod;
Neal Norwitz2a399b02006-09-11 04:28:16 +0000810 PyArena *arena = PyArena_New();
811 if (arena == NULL)
812 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000813
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000814 mod = PyParser_ASTFromFile(fp, pathname, Py_file_input, 0, 0, 0,
Neal Norwitzadb69fc2005-12-17 20:54:49 +0000815 NULL, arena);
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000816 if (mod) {
Neal Norwitzadb69fc2005-12-17 20:54:49 +0000817 co = PyAST_Compile(mod, pathname, NULL, arena);
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000818 }
Neal Norwitz2a399b02006-09-11 04:28:16 +0000819 PyArena_Free(arena);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000820 return co;
821}
822
823
Guido van Rossum55a83382000-09-20 20:31:38 +0000824/* Helper to open a bytecode file for writing in exclusive mode */
825
826static FILE *
827open_exclusive(char *filename)
828{
829#if defined(O_EXCL)&&defined(O_CREAT)&&defined(O_WRONLY)&&defined(O_TRUNC)
830 /* Use O_EXCL to avoid a race condition when another process tries to
831 write the same file. When that happens, our open() call fails,
832 which is just fine (since it's only a cache).
833 XXX If the file exists and is writable but the directory is not
834 writable, the file will never be written. Oh well.
835 */
836 int fd;
837 (void) unlink(filename);
Tim Peters42c83af2000-09-29 04:03:10 +0000838 fd = open(filename, O_EXCL|O_CREAT|O_WRONLY|O_TRUNC
839#ifdef O_BINARY
840 |O_BINARY /* necessary for Windows */
841#endif
Martin v. Löwis79acb9e2002-12-06 12:48:53 +0000842#ifdef __VMS
Martin v. Löwis18e16552006-02-15 17:27:45 +0000843 , 0666, "ctxt=bin", "shr=nil"
Martin v. Löwis79acb9e2002-12-06 12:48:53 +0000844#else
Martin v. Löwis18e16552006-02-15 17:27:45 +0000845 , 0666
Martin v. Löwis79acb9e2002-12-06 12:48:53 +0000846#endif
Martin v. Löwis18e16552006-02-15 17:27:45 +0000847 );
Guido van Rossum55a83382000-09-20 20:31:38 +0000848 if (fd < 0)
849 return NULL;
850 return fdopen(fd, "wb");
851#else
852 /* Best we can do -- on Windows this can't happen anyway */
853 return fopen(filename, "wb");
854#endif
855}
856
857
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000858/* Write a compiled module to a file, placing the time of last
859 modification of its source into the header.
860 Errors are ignored, if a write error occurs an attempt is made to
861 remove the file. */
862
863static void
Martin v. Löwis18e16552006-02-15 17:27:45 +0000864write_compiled_module(PyCodeObject *co, char *cpathname, time_t mtime)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000865{
866 FILE *fp;
867
Guido van Rossum55a83382000-09-20 20:31:38 +0000868 fp = open_exclusive(cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000869 if (fp == NULL) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000870 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000871 PySys_WriteStderr(
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000872 "# can't create %s\n", cpathname);
873 return;
874 }
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000875 PyMarshal_WriteLongToFile(pyc_magic, fp, Py_MARSHAL_VERSION);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000876 /* First write a 0 for mtime */
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000877 PyMarshal_WriteLongToFile(0L, fp, Py_MARSHAL_VERSION);
878 PyMarshal_WriteObjectToFile((PyObject *)co, fp, Py_MARSHAL_VERSION);
Armin Rigo01ab2792004-03-26 15:09:27 +0000879 if (fflush(fp) != 0 || ferror(fp)) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000880 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000881 PySys_WriteStderr("# can't write %s\n", cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000882 /* Don't keep partial file */
883 fclose(fp);
884 (void) unlink(cpathname);
885 return;
886 }
887 /* Now write the true mtime */
888 fseek(fp, 4L, 0);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000889 assert(mtime < LONG_MAX);
Martin v. Löwis725507b2006-03-07 12:08:51 +0000890 PyMarshal_WriteLongToFile((long)mtime, fp, Py_MARSHAL_VERSION);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000891 fflush(fp);
892 fclose(fp);
Guido van Rossum79f25d91997-04-29 20:08:16 +0000893 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000894 PySys_WriteStderr("# wrote %s\n", cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000895}
896
897
898/* Load a source module from a given file and return its module
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000899 object WITH INCREMENTED REFERENCE COUNT. If there's a matching
900 byte-compiled file, use that instead. */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000901
Guido van Rossum79f25d91997-04-29 20:08:16 +0000902static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000903load_source_module(char *name, char *pathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000904{
Fred Drake4c82b232000-06-30 16:18:57 +0000905 time_t mtime;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000906 FILE *fpc;
907 char buf[MAXPATHLEN+1];
908 char *cpathname;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000909 PyCodeObject *co;
910 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000911
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000912 mtime = PyOS_GetLastModificationTime(pathname, fp);
Neal Norwitz708e51a2005-10-03 04:48:15 +0000913 if (mtime == (time_t)(-1)) {
914 PyErr_Format(PyExc_RuntimeError,
915 "unable to get modification time from '%s'",
916 pathname);
Fred Drake4c82b232000-06-30 16:18:57 +0000917 return NULL;
Neal Norwitz708e51a2005-10-03 04:48:15 +0000918 }
Fred Drake4c82b232000-06-30 16:18:57 +0000919#if SIZEOF_TIME_T > 4
920 /* Python's .pyc timestamp handling presumes that the timestamp fits
921 in 4 bytes. This will be fine until sometime in the year 2038,
922 when a 4-byte signed time_t will overflow.
923 */
924 if (mtime >> 32) {
925 PyErr_SetString(PyExc_OverflowError,
Fred Drakec63d3e92001-03-01 06:33:32 +0000926 "modification time overflows a 4 byte field");
Fred Drake4c82b232000-06-30 16:18:57 +0000927 return NULL;
928 }
929#endif
Tim Peters36515e22001-11-18 04:06:29 +0000930 cpathname = make_compiled_pathname(pathname, buf,
Jeremy Hylton37832f02001-04-13 17:50:20 +0000931 (size_t)MAXPATHLEN + 1);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000932 if (cpathname != NULL &&
933 (fpc = check_compiled_module(pathname, mtime, cpathname))) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000934 co = read_compiled_module(cpathname, fpc);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000935 fclose(fpc);
936 if (co == NULL)
937 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000938 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000939 PySys_WriteStderr("import %s # precompiled from %s\n",
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000940 name, cpathname);
Guido van Rossumafd3dae1998-08-25 18:44:34 +0000941 pathname = cpathname;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000942 }
943 else {
944 co = parse_source_module(pathname, fp);
945 if (co == NULL)
946 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000947 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000948 PySys_WriteStderr("import %s # from %s\n",
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000949 name, pathname);
Neal Norwitz3cb31ac2006-08-13 18:10:47 +0000950 if (cpathname)
951 write_compiled_module(co, cpathname, mtime);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000952 }
Guido van Rossumafd3dae1998-08-25 18:44:34 +0000953 m = PyImport_ExecCodeModuleEx(name, (PyObject *)co, pathname);
Guido van Rossum79f25d91997-04-29 20:08:16 +0000954 Py_DECREF(co);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000955
956 return m;
957}
958
959
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000960/* Forward */
Just van Rossum52e14d62002-12-30 22:08:05 +0000961static PyObject *load_module(char *, FILE *, char *, int, PyObject *);
962static struct filedescr *find_module(char *, char *, PyObject *,
963 char *, size_t, FILE **, PyObject **);
Tim Petersdbd9ba62000-07-09 03:09:57 +0000964static struct _frozen *find_frozen(char *name);
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000965
966/* Load a package and return its module object WITH INCREMENTED
967 REFERENCE COUNT */
968
969static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000970load_package(char *name, char *pathname)
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000971{
Tim Peters1cd70172004-08-02 03:52:12 +0000972 PyObject *m, *d;
973 PyObject *file = NULL;
974 PyObject *path = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000975 int err;
976 char buf[MAXPATHLEN+1];
977 FILE *fp = NULL;
978 struct filedescr *fdp;
979
980 m = PyImport_AddModule(name);
981 if (m == NULL)
982 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +0000983 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000984 PySys_WriteStderr("import %s # directory %s\n",
Guido van Rossum17fc85f1997-09-06 18:52:03 +0000985 name, pathname);
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000986 d = PyModule_GetDict(m);
987 file = PyString_FromString(pathname);
988 if (file == NULL)
Tim Peters1cd70172004-08-02 03:52:12 +0000989 goto error;
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000990 path = Py_BuildValue("[O]", file);
Tim Peters1cd70172004-08-02 03:52:12 +0000991 if (path == NULL)
992 goto error;
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000993 err = PyDict_SetItemString(d, "__file__", file);
994 if (err == 0)
995 err = PyDict_SetItemString(d, "__path__", path);
Tim Peters1cd70172004-08-02 03:52:12 +0000996 if (err != 0)
997 goto error;
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000998 buf[0] = '\0';
Just van Rossum52e14d62002-12-30 22:08:05 +0000999 fdp = find_module(name, "__init__", path, buf, sizeof(buf), &fp, NULL);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001000 if (fdp == NULL) {
1001 if (PyErr_ExceptionMatches(PyExc_ImportError)) {
1002 PyErr_Clear();
Thomas Heller25653242004-06-07 15:04:10 +00001003 Py_INCREF(m);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001004 }
1005 else
1006 m = NULL;
1007 goto cleanup;
1008 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001009 m = load_module(name, fp, buf, fdp->type, NULL);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001010 if (fp != NULL)
1011 fclose(fp);
Tim Peters1cd70172004-08-02 03:52:12 +00001012 goto cleanup;
1013
1014 error:
1015 m = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001016 cleanup:
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001017 Py_XDECREF(path);
1018 Py_XDECREF(file);
1019 return m;
1020}
1021
1022
1023/* Helper to test for built-in module */
1024
1025static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001026is_builtin(char *name)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001027{
1028 int i;
Guido van Rossum771c6c81997-10-31 18:37:24 +00001029 for (i = 0; PyImport_Inittab[i].name != NULL; i++) {
1030 if (strcmp(name, PyImport_Inittab[i].name) == 0) {
1031 if (PyImport_Inittab[i].initfunc == NULL)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001032 return -1;
1033 else
1034 return 1;
1035 }
1036 }
1037 return 0;
1038}
1039
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001040
Just van Rossum52e14d62002-12-30 22:08:05 +00001041/* Return an importer object for a sys.path/pkg.__path__ item 'p',
1042 possibly by fetching it from the path_importer_cache dict. If it
Brett Cannon94b69f62006-09-28 22:10:14 +00001043 wasn't yet cached, traverse path_hooks until a hook is found
Just van Rossum52e14d62002-12-30 22:08:05 +00001044 that can handle the path item. Return None if no hook could;
1045 this tells our caller it should fall back to the builtin
1046 import mechanism. Cache the result in path_importer_cache.
1047 Returns a borrowed reference. */
1048
1049static PyObject *
1050get_path_importer(PyObject *path_importer_cache, PyObject *path_hooks,
1051 PyObject *p)
1052{
1053 PyObject *importer;
Martin v. Löwis725507b2006-03-07 12:08:51 +00001054 Py_ssize_t j, nhooks;
Just van Rossum52e14d62002-12-30 22:08:05 +00001055
1056 /* These conditions are the caller's responsibility: */
1057 assert(PyList_Check(path_hooks));
1058 assert(PyDict_Check(path_importer_cache));
1059
1060 nhooks = PyList_Size(path_hooks);
1061 if (nhooks < 0)
1062 return NULL; /* Shouldn't happen */
1063
1064 importer = PyDict_GetItem(path_importer_cache, p);
1065 if (importer != NULL)
1066 return importer;
1067
1068 /* set path_importer_cache[p] to None to avoid recursion */
1069 if (PyDict_SetItem(path_importer_cache, p, Py_None) != 0)
1070 return NULL;
1071
1072 for (j = 0; j < nhooks; j++) {
1073 PyObject *hook = PyList_GetItem(path_hooks, j);
1074 if (hook == NULL)
1075 return NULL;
Georg Brandl684fd0c2006-05-25 19:15:31 +00001076 importer = PyObject_CallFunctionObjArgs(hook, p, NULL);
Just van Rossum52e14d62002-12-30 22:08:05 +00001077 if (importer != NULL)
1078 break;
1079
1080 if (!PyErr_ExceptionMatches(PyExc_ImportError)) {
1081 return NULL;
1082 }
1083 PyErr_Clear();
1084 }
Phillip J. Ebyf7575d02006-07-28 21:12:07 +00001085 if (importer == NULL) {
1086 importer = PyObject_CallFunctionObjArgs(
1087 (PyObject *)&NullImporterType, p, NULL
1088 );
1089 if (importer == NULL) {
1090 if (PyErr_ExceptionMatches(PyExc_ImportError)) {
1091 PyErr_Clear();
1092 return Py_None;
1093 }
1094 }
1095 }
1096 if (importer != NULL) {
Just van Rossum52e14d62002-12-30 22:08:05 +00001097 int err = PyDict_SetItem(path_importer_cache, p, importer);
1098 Py_DECREF(importer);
1099 if (err != 0)
1100 return NULL;
1101 }
1102 return importer;
1103}
1104
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001105/* Search the path (default sys.path) for a module. Return the
1106 corresponding filedescr struct, and (via return arguments) the
1107 pathname and an open file. Return NULL if the module is not found. */
1108
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001109#ifdef MS_COREDLL
Thomas Woutersb4bd21c2000-07-22 23:38:01 +00001110extern FILE *PyWin_FindRegisteredModule(const char *, struct filedescr **,
Martin v. Löwis18e16552006-02-15 17:27:45 +00001111 char *, Py_ssize_t);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001112#endif
1113
Martin v. Löwis18e16552006-02-15 17:27:45 +00001114static int case_ok(char *, Py_ssize_t, Py_ssize_t, char *);
Tim Petersdbd9ba62000-07-09 03:09:57 +00001115static int find_init_module(char *); /* Forward */
Just van Rossum52e14d62002-12-30 22:08:05 +00001116static struct filedescr importhookdescr = {"", "", IMP_HOOK};
Guido van Rossum197346f1997-10-31 18:38:52 +00001117
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001118static struct filedescr *
Just van Rossum52e14d62002-12-30 22:08:05 +00001119find_module(char *fullname, char *subname, PyObject *path, char *buf,
1120 size_t buflen, FILE **p_fp, PyObject **p_loader)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001121{
Martin v. Löwis725507b2006-03-07 12:08:51 +00001122 Py_ssize_t i, npath;
Fred Drake4c82b232000-06-30 16:18:57 +00001123 size_t len, namelen;
Guido van Rossum80bb9651996-12-05 23:27:02 +00001124 struct filedescr *fdp = NULL;
Jack Jansenc88da1f2002-05-28 10:58:19 +00001125 char *filemode;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001126 FILE *fp = NULL;
Just van Rossum52e14d62002-12-30 22:08:05 +00001127 PyObject *path_hooks, *path_importer_cache;
Guido van Rossum48a680c2001-03-02 06:34:14 +00001128#ifndef RISCOS
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001129 struct stat statbuf;
Guido van Rossum48a680c2001-03-02 06:34:14 +00001130#endif
Guido van Rossuma5568d31998-03-05 03:45:08 +00001131 static struct filedescr fd_frozen = {"", "", PY_FROZEN};
1132 static struct filedescr fd_builtin = {"", "", C_BUILTIN};
1133 static struct filedescr fd_package = {"", "", PKG_DIRECTORY};
Guido van Rossum0506a431998-08-11 15:07:39 +00001134 char name[MAXPATHLEN+1];
Andrew MacIntyred9400542002-02-26 11:41:34 +00001135#if defined(PYOS_OS2)
1136 size_t saved_len;
1137 size_t saved_namelen;
1138 char *saved_buf = NULL;
1139#endif
Just van Rossum52e14d62002-12-30 22:08:05 +00001140 if (p_loader != NULL)
1141 *p_loader = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001142
Just van Rossum52e14d62002-12-30 22:08:05 +00001143 if (strlen(subname) > MAXPATHLEN) {
Guido van Rossum8f4d3312001-10-18 18:54:11 +00001144 PyErr_SetString(PyExc_OverflowError,
1145 "module name is too long");
Fred Drake4c82b232000-06-30 16:18:57 +00001146 return NULL;
1147 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001148 strcpy(name, subname);
1149
1150 /* sys.meta_path import hook */
1151 if (p_loader != NULL) {
1152 PyObject *meta_path;
1153
1154 meta_path = PySys_GetObject("meta_path");
1155 if (meta_path == NULL || !PyList_Check(meta_path)) {
1156 PyErr_SetString(PyExc_ImportError,
1157 "sys.meta_path must be a list of "
1158 "import hooks");
1159 return NULL;
1160 }
1161 Py_INCREF(meta_path); /* zap guard */
1162 npath = PyList_Size(meta_path);
1163 for (i = 0; i < npath; i++) {
1164 PyObject *loader;
1165 PyObject *hook = PyList_GetItem(meta_path, i);
1166 loader = PyObject_CallMethod(hook, "find_module",
1167 "sO", fullname,
1168 path != NULL ?
1169 path : Py_None);
1170 if (loader == NULL) {
1171 Py_DECREF(meta_path);
1172 return NULL; /* true error */
1173 }
1174 if (loader != Py_None) {
1175 /* a loader was found */
1176 *p_loader = loader;
1177 Py_DECREF(meta_path);
1178 return &importhookdescr;
1179 }
1180 Py_DECREF(loader);
1181 }
1182 Py_DECREF(meta_path);
1183 }
Guido van Rossum0506a431998-08-11 15:07:39 +00001184
1185 if (path != NULL && PyString_Check(path)) {
Guido van Rossum8f4d3312001-10-18 18:54:11 +00001186 /* The only type of submodule allowed inside a "frozen"
1187 package are other frozen modules or packages. */
Guido van Rossum0506a431998-08-11 15:07:39 +00001188 if (PyString_Size(path) + 1 + strlen(name) >= (size_t)buflen) {
1189 PyErr_SetString(PyExc_ImportError,
1190 "full frozen module name too long");
1191 return NULL;
1192 }
1193 strcpy(buf, PyString_AsString(path));
1194 strcat(buf, ".");
1195 strcat(buf, name);
1196 strcpy(name, buf);
Guido van Rossum8f4d3312001-10-18 18:54:11 +00001197 if (find_frozen(name) != NULL) {
1198 strcpy(buf, name);
1199 return &fd_frozen;
1200 }
1201 PyErr_Format(PyExc_ImportError,
1202 "No frozen submodule named %.200s", name);
1203 return NULL;
Guido van Rossum0506a431998-08-11 15:07:39 +00001204 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001205 if (path == NULL) {
1206 if (is_builtin(name)) {
Guido van Rossuma5568d31998-03-05 03:45:08 +00001207 strcpy(buf, name);
1208 return &fd_builtin;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001209 }
Greg Ward201baee2001-10-04 14:52:06 +00001210 if ((find_frozen(name)) != NULL) {
Guido van Rossuma5568d31998-03-05 03:45:08 +00001211 strcpy(buf, name);
1212 return &fd_frozen;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001213 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001214
Guido van Rossumac279101996-08-22 23:10:58 +00001215#ifdef MS_COREDLL
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001216 fp = PyWin_FindRegisteredModule(name, &fdp, buf, buflen);
1217 if (fp != NULL) {
1218 *p_fp = fp;
1219 return fdp;
1220 }
Guido van Rossuma5a3db71996-04-09 02:39:59 +00001221#endif
Guido van Rossuma5568d31998-03-05 03:45:08 +00001222 path = PySys_GetObject("path");
1223 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00001224 if (path == NULL || !PyList_Check(path)) {
1225 PyErr_SetString(PyExc_ImportError,
Guido van Rossuma5568d31998-03-05 03:45:08 +00001226 "sys.path must be a list of directory names");
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001227 return NULL;
1228 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001229
1230 path_hooks = PySys_GetObject("path_hooks");
1231 if (path_hooks == NULL || !PyList_Check(path_hooks)) {
1232 PyErr_SetString(PyExc_ImportError,
1233 "sys.path_hooks must be a list of "
1234 "import hooks");
1235 return NULL;
1236 }
1237 path_importer_cache = PySys_GetObject("path_importer_cache");
1238 if (path_importer_cache == NULL ||
1239 !PyDict_Check(path_importer_cache)) {
1240 PyErr_SetString(PyExc_ImportError,
1241 "sys.path_importer_cache must be a dict");
1242 return NULL;
1243 }
1244
Guido van Rossum79f25d91997-04-29 20:08:16 +00001245 npath = PyList_Size(path);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001246 namelen = strlen(name);
1247 for (i = 0; i < npath; i++) {
Walter Dörwald3430d702002-06-17 10:43:59 +00001248 PyObject *copy = NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +00001249 PyObject *v = PyList_GetItem(path, i);
Neal Norwitz3cb31ac2006-08-13 18:10:47 +00001250 if (!v)
1251 return NULL;
Walter Dörwald3430d702002-06-17 10:43:59 +00001252#ifdef Py_USING_UNICODE
1253 if (PyUnicode_Check(v)) {
1254 copy = PyUnicode_Encode(PyUnicode_AS_UNICODE(v),
1255 PyUnicode_GET_SIZE(v), Py_FileSystemDefaultEncoding, NULL);
1256 if (copy == NULL)
1257 return NULL;
1258 v = copy;
1259 }
1260 else
1261#endif
Guido van Rossum79f25d91997-04-29 20:08:16 +00001262 if (!PyString_Check(v))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001263 continue;
Neal Norwitz2aa9a5d2006-03-20 01:53:23 +00001264 len = PyString_GET_SIZE(v);
Walter Dörwald3430d702002-06-17 10:43:59 +00001265 if (len + 2 + namelen + MAXSUFFIXSIZE >= buflen) {
1266 Py_XDECREF(copy);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001267 continue; /* Too long */
Walter Dörwald3430d702002-06-17 10:43:59 +00001268 }
Neal Norwitz2aa9a5d2006-03-20 01:53:23 +00001269 strcpy(buf, PyString_AS_STRING(v));
Walter Dörwald3430d702002-06-17 10:43:59 +00001270 if (strlen(buf) != len) {
1271 Py_XDECREF(copy);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001272 continue; /* v contains '\0' */
Walter Dörwald3430d702002-06-17 10:43:59 +00001273 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001274
1275 /* sys.path_hooks import hook */
1276 if (p_loader != NULL) {
1277 PyObject *importer;
1278
1279 importer = get_path_importer(path_importer_cache,
1280 path_hooks, v);
Neal Norwitza4df11d2006-07-06 04:28:59 +00001281 if (importer == NULL) {
1282 Py_XDECREF(copy);
Just van Rossum52e14d62002-12-30 22:08:05 +00001283 return NULL;
Neal Norwitza4df11d2006-07-06 04:28:59 +00001284 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001285 /* Note: importer is a borrowed reference */
Phillip J. Ebyf7575d02006-07-28 21:12:07 +00001286 if (importer != Py_None) {
Just van Rossum52e14d62002-12-30 22:08:05 +00001287 PyObject *loader;
1288 loader = PyObject_CallMethod(importer,
1289 "find_module",
1290 "s", fullname);
Neal Norwitza4df11d2006-07-06 04:28:59 +00001291 Py_XDECREF(copy);
Just van Rossum52e14d62002-12-30 22:08:05 +00001292 if (loader == NULL)
1293 return NULL; /* error */
1294 if (loader != Py_None) {
1295 /* a loader was found */
1296 *p_loader = loader;
1297 return &importhookdescr;
1298 }
1299 Py_DECREF(loader);
Georg Brandlf4ef1162006-05-26 18:03:31 +00001300 continue;
Just van Rossum52e14d62002-12-30 22:08:05 +00001301 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001302 }
Georg Brandlf4ef1162006-05-26 18:03:31 +00001303 /* no hook was found, use builtin import */
Just van Rossum52e14d62002-12-30 22:08:05 +00001304
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001305 if (len > 0 && buf[len-1] != SEP
1306#ifdef ALTSEP
1307 && buf[len-1] != ALTSEP
1308#endif
1309 )
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001310 buf[len++] = SEP;
Guido van Rossum215c3402000-11-13 17:26:32 +00001311 strcpy(buf+len, name);
1312 len += namelen;
Tim Peters50d8d372001-02-28 05:34:27 +00001313
1314 /* Check for package import (buf holds a directory name,
1315 and there's an __init__ module in that directory */
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001316#ifdef HAVE_STAT
Walter Dörwald3430d702002-06-17 10:43:59 +00001317 if (stat(buf, &statbuf) == 0 && /* it exists */
1318 S_ISDIR(statbuf.st_mode) && /* it's a directory */
Thomas Wouters9df4e6f2006-04-27 23:13:20 +00001319 case_ok(buf, len, namelen, name)) { /* case matches */
1320 if (find_init_module(buf)) { /* and has __init__.py */
1321 Py_XDECREF(copy);
1322 return &fd_package;
1323 }
1324 else {
1325 char warnstr[MAXPATHLEN+80];
1326 sprintf(warnstr, "Not importing directory "
1327 "'%.*s': missing __init__.py",
1328 MAXPATHLEN, buf);
1329 if (PyErr_Warn(PyExc_ImportWarning,
1330 warnstr)) {
1331 Py_XDECREF(copy);
1332 return NULL;
1333 }
1334 }
Walter Dörwald3430d702002-06-17 10:43:59 +00001335 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001336#else
1337 /* XXX How are you going to test for directories? */
Guido van Rossum48a680c2001-03-02 06:34:14 +00001338#ifdef RISCOS
Guido van Rossume2ae77b2001-10-24 20:42:55 +00001339 if (isdir(buf) &&
Walter Dörwald3430d702002-06-17 10:43:59 +00001340 case_ok(buf, len, namelen, name)) {
Thomas Wouters9df4e6f2006-04-27 23:13:20 +00001341 if (find_init_module(buf)) {
1342 Py_XDECREF(copy);
1343 return &fd_package;
1344 }
1345 else {
1346 char warnstr[MAXPATHLEN+80];
1347 sprintf(warnstr, "Not importing directory "
1348 "'%.*s': missing __init__.py",
1349 MAXPATHLEN, buf);
1350 if (PyErr_Warn(PyExc_ImportWarning,
1351 warnstr)) {
1352 Py_XDECREF(copy);
1353 return NULL;
1354 }
Walter Dörwald3430d702002-06-17 10:43:59 +00001355 }
Guido van Rossum48a680c2001-03-02 06:34:14 +00001356#endif
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001357#endif
Andrew MacIntyred9400542002-02-26 11:41:34 +00001358#if defined(PYOS_OS2)
1359 /* take a snapshot of the module spec for restoration
1360 * after the 8 character DLL hackery
1361 */
1362 saved_buf = strdup(buf);
1363 saved_len = len;
1364 saved_namelen = namelen;
1365#endif /* PYOS_OS2 */
Guido van Rossum79f25d91997-04-29 20:08:16 +00001366 for (fdp = _PyImport_Filetab; fdp->suffix != NULL; fdp++) {
Andrew MacIntyred9400542002-02-26 11:41:34 +00001367#if defined(PYOS_OS2)
Jeremy Hylton4ae6fae2002-05-30 17:15:25 +00001368 /* OS/2 limits DLLs to 8 character names (w/o
1369 extension)
Andrew MacIntyred9400542002-02-26 11:41:34 +00001370 * so if the name is longer than that and its a
1371 * dynamically loaded module we're going to try,
1372 * truncate the name before trying
1373 */
Just van Rossum52e14d62002-12-30 22:08:05 +00001374 if (strlen(subname) > 8) {
Andrew MacIntyred9400542002-02-26 11:41:34 +00001375 /* is this an attempt to load a C extension? */
Jeremy Hylton4ae6fae2002-05-30 17:15:25 +00001376 const struct filedescr *scan;
1377 scan = _PyImport_DynLoadFiletab;
Andrew MacIntyred9400542002-02-26 11:41:34 +00001378 while (scan->suffix != NULL) {
Jeremy Hylton4ae6fae2002-05-30 17:15:25 +00001379 if (!strcmp(scan->suffix, fdp->suffix))
Andrew MacIntyred9400542002-02-26 11:41:34 +00001380 break;
1381 else
1382 scan++;
1383 }
1384 if (scan->suffix != NULL) {
1385 /* yes, so truncate the name */
1386 namelen = 8;
Just van Rossum52e14d62002-12-30 22:08:05 +00001387 len -= strlen(subname) - namelen;
Andrew MacIntyred9400542002-02-26 11:41:34 +00001388 buf[len] = '\0';
1389 }
1390 }
1391#endif /* PYOS_OS2 */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001392 strcpy(buf+len, fdp->suffix);
Guido van Rossum79f25d91997-04-29 20:08:16 +00001393 if (Py_VerboseFlag > 1)
Guido van Rossum2f3667a1998-10-12 18:23:55 +00001394 PySys_WriteStderr("# trying %s\n", buf);
Jack Jansenc88da1f2002-05-28 10:58:19 +00001395 filemode = fdp->mode;
Tim Peters86c7d2f2004-08-01 23:24:21 +00001396 if (filemode[0] == 'U')
Jeremy Hylton4ae6fae2002-05-30 17:15:25 +00001397 filemode = "r" PY_STDIOTEXTMODE;
Georg Brandlfdca6d82007-08-21 06:01:18 +00001398 errno = 0;
Jack Jansenc88da1f2002-05-28 10:58:19 +00001399 fp = fopen(buf, filemode);
Tim Peters50d8d372001-02-28 05:34:27 +00001400 if (fp != NULL) {
1401 if (case_ok(buf, len, namelen, name))
1402 break;
1403 else { /* continue search */
1404 fclose(fp);
1405 fp = NULL;
Barry Warsaw914a0b12001-02-02 19:12:16 +00001406 }
Barry Warsaw914a0b12001-02-02 19:12:16 +00001407 }
Georg Brandlfdca6d82007-08-21 06:01:18 +00001408 /* issue a warning if the file is there */
1409 /*if (errno != ENOENT) {
1410 char warnstr[MAXPATHLEN+80];
1411 sprintf(warnstr, "Not importing '%.*s': ");
1412
1413 if (PyErr_Warn(PyExc_ImportWarning,
1414 warnstr)) {
1415
1416 }*/
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 Winter47c52a82007-03-13 23:02:15 +00002424 PyInterpreterState *interp = PyThreadState_Get()->interp;
2425 PyObject *modules_reloading = interp->modules_reloading;
Guido van Rossum25ce5661997-08-02 03:10:38 +00002426 PyObject *modules = PyImport_GetModuleDict();
Collin Winter276887b2007-03-12 16:11:39 +00002427 PyObject *path = NULL, *loader = NULL, *existing_m = NULL;
Guido van Rossum222ef561997-09-06 19:41:09 +00002428 char *name, *subname;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002429 char buf[MAXPATHLEN+1];
2430 struct filedescr *fdp;
2431 FILE *fp = NULL;
Tim Peters1cd70172004-08-02 03:52:12 +00002432 PyObject *newm;
Collin Winter47c52a82007-03-13 23:02:15 +00002433
2434 if (modules_reloading == NULL) {
2435 Py_FatalError("PyImport_ReloadModule: "
Neal Norwitz2fca81c2007-05-30 04:53:41 +00002436 "no modules_reloading dictionary!");
Collin Winter47c52a82007-03-13 23:02:15 +00002437 return NULL;
2438 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002439
Guido van Rossum79f25d91997-04-29 20:08:16 +00002440 if (m == NULL || !PyModule_Check(m)) {
2441 PyErr_SetString(PyExc_TypeError,
2442 "reload() argument must be module");
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002443 return NULL;
2444 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002445 name = PyModule_GetName(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002446 if (name == NULL)
2447 return NULL;
Guido van Rossum25ce5661997-08-02 03:10:38 +00002448 if (m != PyDict_GetItemString(modules, name)) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002449 PyErr_Format(PyExc_ImportError,
2450 "reload(): module %.200s not in sys.modules",
2451 name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002452 return NULL;
2453 }
Neal Norwitz75c7c802007-03-13 05:31:38 +00002454 existing_m = PyDict_GetItemString(modules_reloading, name);
2455 if (existing_m != NULL) {
2456 /* Due to a recursive reload, this module is already
2457 being reloaded. */
2458 Py_INCREF(existing_m);
2459 return existing_m;
Collin Winter276887b2007-03-12 16:11:39 +00002460 }
Neal Norwitz75c7c802007-03-13 05:31:38 +00002461 if (PyDict_SetItemString(modules_reloading, name, m) < 0)
2462 return NULL;
Collin Winter276887b2007-03-12 16:11:39 +00002463
Guido van Rossum222ef561997-09-06 19:41:09 +00002464 subname = strrchr(name, '.');
2465 if (subname == NULL)
2466 subname = name;
2467 else {
2468 PyObject *parentname, *parent;
2469 parentname = PyString_FromStringAndSize(name, (subname-name));
Collin Winter276887b2007-03-12 16:11:39 +00002470 if (parentname == NULL) {
2471 imp_modules_reloading_clear();
Guido van Rossum222ef561997-09-06 19:41:09 +00002472 return NULL;
Neal Norwitz75c7c802007-03-13 05:31:38 +00002473 }
Guido van Rossum222ef561997-09-06 19:41:09 +00002474 parent = PyDict_GetItem(modules, parentname);
2475 if (parent == NULL) {
2476 PyErr_Format(PyExc_ImportError,
2477 "reload(): parent %.200s not in sys.modules",
Georg Brandl0c55f292005-09-14 06:56:20 +00002478 PyString_AS_STRING(parentname));
2479 Py_DECREF(parentname);
Neal Norwitz2fca81c2007-05-30 04:53:41 +00002480 imp_modules_reloading_clear();
Guido van Rossum222ef561997-09-06 19:41:09 +00002481 return NULL;
2482 }
Georg Brandl0c55f292005-09-14 06:56:20 +00002483 Py_DECREF(parentname);
Guido van Rossum222ef561997-09-06 19:41:09 +00002484 subname++;
2485 path = PyObject_GetAttrString(parent, "__path__");
2486 if (path == NULL)
2487 PyErr_Clear();
2488 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002489 buf[0] = '\0';
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00002490 fdp = find_module(name, subname, path, buf, MAXPATHLEN+1, &fp, &loader);
Guido van Rossum222ef561997-09-06 19:41:09 +00002491 Py_XDECREF(path);
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00002492
2493 if (fdp == NULL) {
2494 Py_XDECREF(loader);
Collin Winter276887b2007-03-12 16:11:39 +00002495 imp_modules_reloading_clear();
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002496 return NULL;
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00002497 }
2498
2499 newm = load_module(name, fp, buf, fdp->type, loader);
2500 Py_XDECREF(loader);
2501
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002502 if (fp)
2503 fclose(fp);
Tim Peters1cd70172004-08-02 03:52:12 +00002504 if (newm == NULL) {
2505 /* load_module probably removed name from modules because of
2506 * the error. Put back the original module object. We're
2507 * going to return NULL in this case regardless of whether
2508 * replacing name succeeds, so the return value is ignored.
2509 */
2510 PyDict_SetItemString(modules, name, m);
2511 }
Neal Norwitz75c7c802007-03-13 05:31:38 +00002512 imp_modules_reloading_clear();
Tim Peters1cd70172004-08-02 03:52:12 +00002513 return newm;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002514}
2515
2516
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002517/* Higher-level import emulator which emulates the "import" statement
2518 more accurately -- it invokes the __import__() function from the
2519 builtins of the current globals. This means that the import is
2520 done using whatever import hooks are installed in the current
Guido van Rossum6058eb41998-12-21 19:51:00 +00002521 environment, e.g. by "rexec".
2522 A dummy list ["__doc__"] is passed as the 4th argument so that
2523 e.g. PyImport_Import(PyString_FromString("win32com.client.gencache"))
2524 will return <module "gencache"> instead of <module "win32com">. */
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002525
2526PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002527PyImport_Import(PyObject *module_name)
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002528{
2529 static PyObject *silly_list = NULL;
2530 static PyObject *builtins_str = NULL;
2531 static PyObject *import_str = NULL;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002532 PyObject *globals = NULL;
2533 PyObject *import = NULL;
2534 PyObject *builtins = NULL;
2535 PyObject *r = NULL;
2536
2537 /* Initialize constant string objects */
2538 if (silly_list == NULL) {
2539 import_str = PyString_InternFromString("__import__");
2540 if (import_str == NULL)
2541 return NULL;
2542 builtins_str = PyString_InternFromString("__builtins__");
2543 if (builtins_str == NULL)
2544 return NULL;
2545 silly_list = Py_BuildValue("[s]", "__doc__");
2546 if (silly_list == NULL)
2547 return NULL;
2548 }
2549
2550 /* Get the builtins from current globals */
2551 globals = PyEval_GetGlobals();
Guido van Rossum85cd1d62001-02-20 21:43:24 +00002552 if (globals != NULL) {
Guido van Rossum66468561998-10-22 15:46:50 +00002553 Py_INCREF(globals);
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002554 builtins = PyObject_GetItem(globals, builtins_str);
2555 if (builtins == NULL)
2556 goto err;
2557 }
2558 else {
2559 /* No globals -- use standard builtins, and fake globals */
2560 PyErr_Clear();
2561
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002562 builtins = PyImport_ImportModuleLevel("__builtin__",
2563 NULL, NULL, NULL, 0);
Guido van Rossum85cd1d62001-02-20 21:43:24 +00002564 if (builtins == NULL)
2565 return NULL;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002566 globals = Py_BuildValue("{OO}", builtins_str, builtins);
2567 if (globals == NULL)
2568 goto err;
2569 }
2570
2571 /* Get the __import__ function from the builtins */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002572 if (PyDict_Check(builtins)) {
Fred Drakea76ba6e2001-03-06 06:31:15 +00002573 import = PyObject_GetItem(builtins, import_str);
Tim Peters6d6c1a32001-08-02 04:15:00 +00002574 if (import == NULL)
2575 PyErr_SetObject(PyExc_KeyError, import_str);
2576 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002577 else
Fred Drakea76ba6e2001-03-06 06:31:15 +00002578 import = PyObject_GetAttr(builtins, import_str);
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002579 if (import == NULL)
2580 goto err;
2581
Georg Brandl74780962007-03-10 07:38:14 +00002582 /* Call the __import__ function with the proper argument list */
Georg Brandl684fd0c2006-05-25 19:15:31 +00002583 r = PyObject_CallFunctionObjArgs(import, module_name, globals,
2584 globals, silly_list, NULL);
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002585
2586 err:
2587 Py_XDECREF(globals);
2588 Py_XDECREF(builtins);
2589 Py_XDECREF(import);
Tim Peters50d8d372001-02-28 05:34:27 +00002590
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002591 return r;
2592}
2593
2594
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002595/* Module 'imp' provides Python access to the primitives used for
2596 importing modules.
2597*/
2598
Guido van Rossum79f25d91997-04-29 20:08:16 +00002599static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +00002600imp_get_magic(PyObject *self, PyObject *noargs)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002601{
2602 char buf[4];
2603
Guido van Rossum96774c12000-05-01 20:19:08 +00002604 buf[0] = (char) ((pyc_magic >> 0) & 0xff);
2605 buf[1] = (char) ((pyc_magic >> 8) & 0xff);
2606 buf[2] = (char) ((pyc_magic >> 16) & 0xff);
2607 buf[3] = (char) ((pyc_magic >> 24) & 0xff);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002608
Guido van Rossum79f25d91997-04-29 20:08:16 +00002609 return PyString_FromStringAndSize(buf, 4);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002610}
2611
Guido van Rossum79f25d91997-04-29 20:08:16 +00002612static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +00002613imp_get_suffixes(PyObject *self, PyObject *noargs)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002614{
Guido van Rossum79f25d91997-04-29 20:08:16 +00002615 PyObject *list;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002616 struct filedescr *fdp;
2617
Guido van Rossum79f25d91997-04-29 20:08:16 +00002618 list = PyList_New(0);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002619 if (list == NULL)
2620 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002621 for (fdp = _PyImport_Filetab; fdp->suffix != NULL; fdp++) {
2622 PyObject *item = Py_BuildValue("ssi",
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002623 fdp->suffix, fdp->mode, fdp->type);
2624 if (item == NULL) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00002625 Py_DECREF(list);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002626 return NULL;
2627 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002628 if (PyList_Append(list, item) < 0) {
2629 Py_DECREF(list);
2630 Py_DECREF(item);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002631 return NULL;
2632 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002633 Py_DECREF(item);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002634 }
2635 return list;
2636}
2637
Guido van Rossum79f25d91997-04-29 20:08:16 +00002638static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002639call_find_module(char *name, PyObject *path)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002640{
Tim Petersdbd9ba62000-07-09 03:09:57 +00002641 extern int fclose(FILE *);
Guido van Rossum79f25d91997-04-29 20:08:16 +00002642 PyObject *fob, *ret;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002643 struct filedescr *fdp;
2644 char pathname[MAXPATHLEN+1];
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002645 FILE *fp = NULL;
2646
2647 pathname[0] = '\0';
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002648 if (path == Py_None)
2649 path = NULL;
Just van Rossum52e14d62002-12-30 22:08:05 +00002650 fdp = find_module(NULL, name, path, pathname, MAXPATHLEN+1, &fp, NULL);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002651 if (fdp == NULL)
2652 return NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002653 if (fp != NULL) {
2654 fob = PyFile_FromFile(fp, pathname, fdp->mode, fclose);
2655 if (fob == NULL) {
2656 fclose(fp);
2657 return NULL;
2658 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002659 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002660 else {
2661 fob = Py_None;
2662 Py_INCREF(fob);
Tim Peters50d8d372001-02-28 05:34:27 +00002663 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002664 ret = Py_BuildValue("Os(ssi)",
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002665 fob, pathname, fdp->suffix, fdp->mode, fdp->type);
Guido van Rossum79f25d91997-04-29 20:08:16 +00002666 Py_DECREF(fob);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002667 return ret;
2668}
2669
Guido van Rossum79f25d91997-04-29 20:08:16 +00002670static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002671imp_find_module(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002672{
2673 char *name;
2674 PyObject *path = NULL;
Guido van Rossum43713e52000-02-29 13:59:29 +00002675 if (!PyArg_ParseTuple(args, "s|O:find_module", &name, &path))
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002676 return NULL;
2677 return call_find_module(name, path);
2678}
2679
2680static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002681imp_init_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002682{
2683 char *name;
2684 int ret;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002685 PyObject *m;
Guido van Rossum43713e52000-02-29 13:59:29 +00002686 if (!PyArg_ParseTuple(args, "s:init_builtin", &name))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002687 return NULL;
2688 ret = init_builtin(name);
2689 if (ret < 0)
2690 return NULL;
2691 if (ret == 0) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00002692 Py_INCREF(Py_None);
2693 return Py_None;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002694 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002695 m = PyImport_AddModule(name);
2696 Py_XINCREF(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002697 return m;
2698}
2699
Guido van Rossum79f25d91997-04-29 20:08:16 +00002700static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002701imp_init_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002702{
2703 char *name;
2704 int ret;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002705 PyObject *m;
Guido van Rossum43713e52000-02-29 13:59:29 +00002706 if (!PyArg_ParseTuple(args, "s:init_frozen", &name))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002707 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002708 ret = PyImport_ImportFrozenModule(name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002709 if (ret < 0)
2710 return NULL;
2711 if (ret == 0) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00002712 Py_INCREF(Py_None);
2713 return Py_None;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002714 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002715 m = PyImport_AddModule(name);
2716 Py_XINCREF(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002717 return m;
2718}
2719
Guido van Rossum79f25d91997-04-29 20:08:16 +00002720static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002721imp_get_frozen_object(PyObject *self, PyObject *args)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002722{
2723 char *name;
Jack Jansen95ffa231995-10-03 14:38:41 +00002724
Guido van Rossum43713e52000-02-29 13:59:29 +00002725 if (!PyArg_ParseTuple(args, "s:get_frozen_object", &name))
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002726 return NULL;
2727 return get_frozen_object(name);
2728}
2729
Guido van Rossum79f25d91997-04-29 20:08:16 +00002730static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002731imp_is_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002732{
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002733 char *name;
Guido van Rossum43713e52000-02-29 13:59:29 +00002734 if (!PyArg_ParseTuple(args, "s:is_builtin", &name))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002735 return NULL;
Guido van Rossum50ee94f2002-04-09 18:00:58 +00002736 return PyInt_FromLong(is_builtin(name));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002737}
2738
Guido van Rossum79f25d91997-04-29 20:08:16 +00002739static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002740imp_is_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002741{
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002742 char *name;
Guido van Rossum323bf5e1998-06-24 03:54:06 +00002743 struct _frozen *p;
Guido van Rossum43713e52000-02-29 13:59:29 +00002744 if (!PyArg_ParseTuple(args, "s:is_frozen", &name))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002745 return NULL;
Guido van Rossum323bf5e1998-06-24 03:54:06 +00002746 p = find_frozen(name);
Guido van Rossumb8bff3f2002-04-07 06:34:38 +00002747 return PyBool_FromLong((long) (p == NULL ? 0 : p->size));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002748}
2749
2750static FILE *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002751get_file(char *pathname, PyObject *fob, char *mode)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002752{
2753 FILE *fp;
2754 if (fob == NULL) {
Tim Peters86c7d2f2004-08-01 23:24:21 +00002755 if (mode[0] == 'U')
Jeremy Hylton4ae6fae2002-05-30 17:15:25 +00002756 mode = "r" PY_STDIOTEXTMODE;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002757 fp = fopen(pathname, mode);
2758 if (fp == NULL)
Guido van Rossum79f25d91997-04-29 20:08:16 +00002759 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002760 }
2761 else {
Guido van Rossum79f25d91997-04-29 20:08:16 +00002762 fp = PyFile_AsFile(fob);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002763 if (fp == NULL)
Guido van Rossum79f25d91997-04-29 20:08:16 +00002764 PyErr_SetString(PyExc_ValueError,
2765 "bad/closed file object");
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002766 }
2767 return fp;
2768}
2769
Guido van Rossum79f25d91997-04-29 20:08:16 +00002770static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002771imp_load_compiled(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002772{
2773 char *name;
2774 char *pathname;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002775 PyObject *fob = NULL;
2776 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002777 FILE *fp;
Guido van Rossum43713e52000-02-29 13:59:29 +00002778 if (!PyArg_ParseTuple(args, "ss|O!:load_compiled", &name, &pathname,
Guido van Rossum79f25d91997-04-29 20:08:16 +00002779 &PyFile_Type, &fob))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002780 return NULL;
2781 fp = get_file(pathname, fob, "rb");
2782 if (fp == NULL)
2783 return NULL;
2784 m = load_compiled_module(name, pathname, fp);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002785 if (fob == NULL)
2786 fclose(fp);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002787 return m;
2788}
2789
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002790#ifdef HAVE_DYNAMIC_LOADING
2791
Guido van Rossum79f25d91997-04-29 20:08:16 +00002792static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002793imp_load_dynamic(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002794{
2795 char *name;
2796 char *pathname;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002797 PyObject *fob = NULL;
2798 PyObject *m;
Guido van Rossum7faeab31995-07-07 22:50:36 +00002799 FILE *fp = NULL;
Guido van Rossum43713e52000-02-29 13:59:29 +00002800 if (!PyArg_ParseTuple(args, "ss|O!:load_dynamic", &name, &pathname,
Guido van Rossum79f25d91997-04-29 20:08:16 +00002801 &PyFile_Type, &fob))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002802 return NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002803 if (fob) {
Guido van Rossum7faeab31995-07-07 22:50:36 +00002804 fp = get_file(pathname, fob, "r");
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002805 if (fp == NULL)
2806 return NULL;
2807 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002808 m = _PyImport_LoadDynamicModule(name, pathname, fp);
Guido van Rossum7faeab31995-07-07 22:50:36 +00002809 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002810}
2811
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002812#endif /* HAVE_DYNAMIC_LOADING */
2813
Guido van Rossum79f25d91997-04-29 20:08:16 +00002814static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002815imp_load_source(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002816{
2817 char *name;
2818 char *pathname;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002819 PyObject *fob = NULL;
2820 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002821 FILE *fp;
Guido van Rossum43713e52000-02-29 13:59:29 +00002822 if (!PyArg_ParseTuple(args, "ss|O!:load_source", &name, &pathname,
Guido van Rossum79f25d91997-04-29 20:08:16 +00002823 &PyFile_Type, &fob))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002824 return NULL;
2825 fp = get_file(pathname, fob, "r");
2826 if (fp == NULL)
2827 return NULL;
2828 m = load_source_module(name, pathname, fp);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002829 if (fob == NULL)
2830 fclose(fp);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002831 return m;
2832}
2833
Guido van Rossum79f25d91997-04-29 20:08:16 +00002834static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002835imp_load_module(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002836{
2837 char *name;
2838 PyObject *fob;
2839 char *pathname;
2840 char *suffix; /* Unused */
2841 char *mode;
2842 int type;
2843 FILE *fp;
2844
Guido van Rossum43713e52000-02-29 13:59:29 +00002845 if (!PyArg_ParseTuple(args, "sOs(ssi):load_module",
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002846 &name, &fob, &pathname,
2847 &suffix, &mode, &type))
2848 return NULL;
Guido van Rossum5e2c5fa2002-05-30 17:33:07 +00002849 if (*mode) {
2850 /* Mode must start with 'r' or 'U' and must not contain '+'.
2851 Implicit in this test is the assumption that the mode
2852 may contain other modifiers like 'b' or 't'. */
2853
2854 if (!(*mode == 'r' || *mode == 'U') || strchr(mode, '+')) {
Jeremy Hylton4ae6fae2002-05-30 17:15:25 +00002855 PyErr_Format(PyExc_ValueError,
2856 "invalid file open mode %.200s", mode);
2857 return NULL;
Guido van Rossum5e2c5fa2002-05-30 17:33:07 +00002858 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002859 }
2860 if (fob == Py_None)
2861 fp = NULL;
2862 else {
2863 if (!PyFile_Check(fob)) {
2864 PyErr_SetString(PyExc_ValueError,
2865 "load_module arg#2 should be a file or None");
2866 return NULL;
2867 }
2868 fp = get_file(pathname, fob, mode);
2869 if (fp == NULL)
2870 return NULL;
2871 }
Just van Rossum52e14d62002-12-30 22:08:05 +00002872 return load_module(name, fp, pathname, type, NULL);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002873}
2874
2875static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002876imp_load_package(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002877{
2878 char *name;
2879 char *pathname;
Guido van Rossum43713e52000-02-29 13:59:29 +00002880 if (!PyArg_ParseTuple(args, "ss:load_package", &name, &pathname))
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002881 return NULL;
2882 return load_package(name, pathname);
2883}
2884
2885static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002886imp_new_module(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002887{
2888 char *name;
Guido van Rossum43713e52000-02-29 13:59:29 +00002889 if (!PyArg_ParseTuple(args, "s:new_module", &name))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002890 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002891 return PyModule_New(name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002892}
2893
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002894/* Doc strings */
2895
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002896PyDoc_STRVAR(doc_imp,
2897"This module provides the components needed to build your own\n\
2898__import__ function. Undocumented functions are obsolete.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002899
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002900PyDoc_STRVAR(doc_find_module,
2901"find_module(name, [path]) -> (file, filename, (suffix, mode, type))\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002902Search for a module. If path is omitted or None, search for a\n\
2903built-in, frozen or special module and continue search in sys.path.\n\
2904The module name cannot contain '.'; to search for a submodule of a\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002905package, pass the submodule name and the package's __path__.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002906
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002907PyDoc_STRVAR(doc_load_module,
2908"load_module(name, file, filename, (suffix, mode, type)) -> module\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002909Load a module, given information returned by find_module().\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002910The module name must include the full package name, if any.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002911
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002912PyDoc_STRVAR(doc_get_magic,
2913"get_magic() -> string\n\
2914Return the magic number for .pyc or .pyo files.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002915
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002916PyDoc_STRVAR(doc_get_suffixes,
2917"get_suffixes() -> [(suffix, mode, type), ...]\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002918Return a list of (suffix, mode, type) tuples describing the files\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002919that find_module() looks for.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002920
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002921PyDoc_STRVAR(doc_new_module,
2922"new_module(name) -> module\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002923Create a new module. Do not enter it in sys.modules.\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002924The module name must include the full package name, if any.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002925
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002926PyDoc_STRVAR(doc_lock_held,
Tim Petersa7c65092004-08-01 23:26:05 +00002927"lock_held() -> boolean\n\
2928Return True if the import lock is currently held, else False.\n\
2929On platforms without threads, return False.");
Tim Peters69232342001-08-30 05:16:13 +00002930
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00002931PyDoc_STRVAR(doc_acquire_lock,
2932"acquire_lock() -> None\n\
Neal Norwitz2294c0d2003-02-12 23:02:21 +00002933Acquires the interpreter's import lock for the current thread.\n\
2934This lock should be used by import hooks to ensure thread-safety\n\
2935when importing modules.\n\
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00002936On platforms without threads, this function does nothing.");
2937
2938PyDoc_STRVAR(doc_release_lock,
2939"release_lock() -> None\n\
2940Release the interpreter's import lock.\n\
2941On platforms without threads, this function does nothing.");
2942
Guido van Rossum79f25d91997-04-29 20:08:16 +00002943static PyMethodDef imp_methods[] = {
Neal Norwitz08ea61a2003-02-17 18:18:00 +00002944 {"find_module", imp_find_module, METH_VARARGS, doc_find_module},
2945 {"get_magic", imp_get_magic, METH_NOARGS, doc_get_magic},
2946 {"get_suffixes", imp_get_suffixes, METH_NOARGS, doc_get_suffixes},
2947 {"load_module", imp_load_module, METH_VARARGS, doc_load_module},
2948 {"new_module", imp_new_module, METH_VARARGS, doc_new_module},
2949 {"lock_held", imp_lock_held, METH_NOARGS, doc_lock_held},
2950 {"acquire_lock", imp_acquire_lock, METH_NOARGS, doc_acquire_lock},
2951 {"release_lock", imp_release_lock, METH_NOARGS, doc_release_lock},
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002952 /* The rest are obsolete */
Neal Norwitz031829d2002-03-31 14:37:44 +00002953 {"get_frozen_object", imp_get_frozen_object, METH_VARARGS},
2954 {"init_builtin", imp_init_builtin, METH_VARARGS},
2955 {"init_frozen", imp_init_frozen, METH_VARARGS},
2956 {"is_builtin", imp_is_builtin, METH_VARARGS},
2957 {"is_frozen", imp_is_frozen, METH_VARARGS},
2958 {"load_compiled", imp_load_compiled, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002959#ifdef HAVE_DYNAMIC_LOADING
Neal Norwitz031829d2002-03-31 14:37:44 +00002960 {"load_dynamic", imp_load_dynamic, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002961#endif
Neal Norwitz031829d2002-03-31 14:37:44 +00002962 {"load_package", imp_load_package, METH_VARARGS},
Neal Norwitz031829d2002-03-31 14:37:44 +00002963 {"load_source", imp_load_source, METH_VARARGS},
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002964 {NULL, NULL} /* sentinel */
2965};
2966
Guido van Rossum1a8791e1998-08-04 22:46:29 +00002967static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002968setint(PyObject *d, char *name, int value)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002969{
2970 PyObject *v;
2971 int err;
2972
2973 v = PyInt_FromLong((long)value);
2974 err = PyDict_SetItemString(d, name, v);
2975 Py_XDECREF(v);
2976 return err;
2977}
2978
Phillip J. Ebyf7575d02006-07-28 21:12:07 +00002979typedef struct {
2980 PyObject_HEAD
2981} NullImporter;
2982
2983static int
2984NullImporter_init(NullImporter *self, PyObject *args, PyObject *kwds)
2985{
2986 char *path;
2987
2988 if (!_PyArg_NoKeywords("NullImporter()", kwds))
2989 return -1;
2990
2991 if (!PyArg_ParseTuple(args, "s:NullImporter",
2992 &path))
2993 return -1;
2994
2995 if (strlen(path) == 0) {
2996 PyErr_SetString(PyExc_ImportError, "empty pathname");
2997 return -1;
2998 } else {
2999#ifndef RISCOS
3000 struct stat statbuf;
3001 int rv;
3002
3003 rv = stat(path, &statbuf);
3004 if (rv == 0) {
3005 /* it exists */
3006 if (S_ISDIR(statbuf.st_mode)) {
3007 /* it's a directory */
3008 PyErr_SetString(PyExc_ImportError,
3009 "existing directory");
3010 return -1;
3011 }
3012 }
3013#else
3014 if (object_exists(path)) {
3015 /* it exists */
3016 if (isdir(path)) {
3017 /* it's a directory */
3018 PyErr_SetString(PyExc_ImportError,
3019 "existing directory");
3020 return -1;
3021 }
3022 }
3023#endif
3024 }
3025 return 0;
3026}
3027
3028static PyObject *
3029NullImporter_find_module(NullImporter *self, PyObject *args)
3030{
3031 Py_RETURN_NONE;
3032}
3033
3034static PyMethodDef NullImporter_methods[] = {
3035 {"find_module", (PyCFunction)NullImporter_find_module, METH_VARARGS,
3036 "Always return None"
3037 },
3038 {NULL} /* Sentinel */
3039};
3040
3041
3042static PyTypeObject NullImporterType = {
Martin v. Löwis68192102007-07-21 06:55:02 +00003043 PyVarObject_HEAD_INIT(NULL, 0)
Phillip J. Ebyf7575d02006-07-28 21:12:07 +00003044 "imp.NullImporter", /*tp_name*/
3045 sizeof(NullImporter), /*tp_basicsize*/
3046 0, /*tp_itemsize*/
3047 0, /*tp_dealloc*/
3048 0, /*tp_print*/
3049 0, /*tp_getattr*/
3050 0, /*tp_setattr*/
3051 0, /*tp_compare*/
3052 0, /*tp_repr*/
3053 0, /*tp_as_number*/
3054 0, /*tp_as_sequence*/
3055 0, /*tp_as_mapping*/
3056 0, /*tp_hash */
3057 0, /*tp_call*/
3058 0, /*tp_str*/
3059 0, /*tp_getattro*/
3060 0, /*tp_setattro*/
3061 0, /*tp_as_buffer*/
3062 Py_TPFLAGS_DEFAULT, /*tp_flags*/
3063 "Null importer object", /* tp_doc */
3064 0, /* tp_traverse */
3065 0, /* tp_clear */
3066 0, /* tp_richcompare */
3067 0, /* tp_weaklistoffset */
3068 0, /* tp_iter */
3069 0, /* tp_iternext */
3070 NullImporter_methods, /* tp_methods */
3071 0, /* tp_members */
3072 0, /* tp_getset */
3073 0, /* tp_base */
3074 0, /* tp_dict */
3075 0, /* tp_descr_get */
3076 0, /* tp_descr_set */
3077 0, /* tp_dictoffset */
3078 (initproc)NullImporter_init, /* tp_init */
3079 0, /* tp_alloc */
3080 PyType_GenericNew /* tp_new */
3081};
3082
3083
Jason Tishler6bc06ec2003-09-04 11:59:50 +00003084PyMODINIT_FUNC
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003085initimp(void)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003086{
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003087 PyObject *m, *d;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003088
Phillip J. Ebyf7575d02006-07-28 21:12:07 +00003089 if (PyType_Ready(&NullImporterType) < 0)
3090 goto failure;
3091
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003092 m = Py_InitModule4("imp", imp_methods, doc_imp,
3093 NULL, PYTHON_API_VERSION);
Neal Norwitz1ac754f2006-01-19 06:09:39 +00003094 if (m == NULL)
3095 goto failure;
Guido van Rossum79f25d91997-04-29 20:08:16 +00003096 d = PyModule_GetDict(m);
Neal Norwitz3cb31ac2006-08-13 18:10:47 +00003097 if (d == NULL)
3098 goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003099
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003100 if (setint(d, "SEARCH_ERROR", SEARCH_ERROR) < 0) goto failure;
3101 if (setint(d, "PY_SOURCE", PY_SOURCE) < 0) goto failure;
3102 if (setint(d, "PY_COMPILED", PY_COMPILED) < 0) goto failure;
3103 if (setint(d, "C_EXTENSION", C_EXTENSION) < 0) goto failure;
3104 if (setint(d, "PY_RESOURCE", PY_RESOURCE) < 0) goto failure;
3105 if (setint(d, "PKG_DIRECTORY", PKG_DIRECTORY) < 0) goto failure;
3106 if (setint(d, "C_BUILTIN", C_BUILTIN) < 0) goto failure;
3107 if (setint(d, "PY_FROZEN", PY_FROZEN) < 0) goto failure;
Guido van Rossum0f84a341998-08-06 13:36:01 +00003108 if (setint(d, "PY_CODERESOURCE", PY_CODERESOURCE) < 0) goto failure;
Just van Rossum52e14d62002-12-30 22:08:05 +00003109 if (setint(d, "IMP_HOOK", IMP_HOOK) < 0) goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003110
Phillip J. Ebyf7575d02006-07-28 21:12:07 +00003111 Py_INCREF(&NullImporterType);
3112 PyModule_AddObject(m, "NullImporter", (PyObject *)&NullImporterType);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003113 failure:
3114 ;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003115}
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003116
3117
Guido van Rossumb18618d2000-05-03 23:44:39 +00003118/* API for embedding applications that want to add their own entries
3119 to the table of built-in modules. This should normally be called
3120 *before* Py_Initialize(). When the table resize fails, -1 is
3121 returned and the existing table is unchanged.
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003122
3123 After a similar function by Just van Rossum. */
3124
3125int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003126PyImport_ExtendInittab(struct _inittab *newtab)
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003127{
3128 static struct _inittab *our_copy = NULL;
3129 struct _inittab *p;
3130 int i, n;
3131
3132 /* Count the number of entries in both tables */
3133 for (n = 0; newtab[n].name != NULL; n++)
3134 ;
3135 if (n == 0)
3136 return 0; /* Nothing to do */
3137 for (i = 0; PyImport_Inittab[i].name != NULL; i++)
3138 ;
3139
3140 /* Allocate new memory for the combined table */
Guido van Rossumb18618d2000-05-03 23:44:39 +00003141 p = our_copy;
3142 PyMem_RESIZE(p, struct _inittab, i+n+1);
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003143 if (p == NULL)
3144 return -1;
3145
3146 /* Copy the tables into the new memory */
3147 if (our_copy != PyImport_Inittab)
3148 memcpy(p, PyImport_Inittab, (i+1) * sizeof(struct _inittab));
3149 PyImport_Inittab = our_copy = p;
3150 memcpy(p+i, newtab, (n+1) * sizeof(struct _inittab));
3151
3152 return 0;
3153}
3154
3155/* Shorthand to add a single entry given a name and a function */
3156
3157int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003158PyImport_AppendInittab(char *name, void (*initfunc)(void))
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003159{
3160 struct _inittab newtab[2];
3161
3162 memset(newtab, '\0', sizeof newtab);
3163
3164 newtab[0].name = name;
3165 newtab[0].initfunc = initfunc;
3166
3167 return PyImport_ExtendInittab(newtab);
3168}
Anthony Baxterac6bd462006-04-13 02:06:09 +00003169
3170#ifdef __cplusplus
3171}
3172#endif