blob: e191bd576a82f77424c603f55fb933f03fd16bb2 [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)
Raymond Hettingereffde122007-12-18 18:26:18 +000069 Python 2.6a0: 62151 (peephole optimizations and STORE_MAP opcode)
Michael W. Hudsonaee2e282005-10-21 11:32:20 +000070.
Tim Peters36515e22001-11-18 04:06:29 +000071*/
Raymond Hettingereffde122007-12-18 18:26:18 +000072#define MAGIC (62151 | ((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 +0000107
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000108/* Initialize things */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000109
110void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000111_PyImport_Init(void)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000112{
Guido van Rossumed1170e1999-12-20 21:23:41 +0000113 const struct filedescr *scan;
114 struct filedescr *filetab;
115 int countD = 0;
116 int countS = 0;
117
118 /* prepare _PyImport_Filetab: copy entries from
119 _PyImport_DynLoadFiletab and _PyImport_StandardFiletab.
120 */
Georg Brandladd36e52007-08-23 18:08:06 +0000121#ifdef HAVE_DYNAMIC_LOADING
Guido van Rossumed1170e1999-12-20 21:23:41 +0000122 for (scan = _PyImport_DynLoadFiletab; scan->suffix != NULL; ++scan)
123 ++countD;
Georg Brandladd36e52007-08-23 18:08:06 +0000124#endif
Guido van Rossumed1170e1999-12-20 21:23:41 +0000125 for (scan = _PyImport_StandardFiletab; scan->suffix != NULL; ++scan)
126 ++countS;
Guido van Rossumb18618d2000-05-03 23:44:39 +0000127 filetab = PyMem_NEW(struct filedescr, countD + countS + 1);
Neal Norwitze1fdb322006-07-21 05:32:28 +0000128 if (filetab == NULL)
Neal Norwitz33722ae2006-07-21 07:59:02 +0000129 Py_FatalError("Can't initialize import file table.");
Georg Brandladd36e52007-08-23 18:08:06 +0000130#ifdef HAVE_DYNAMIC_LOADING
Guido van Rossumed1170e1999-12-20 21:23:41 +0000131 memcpy(filetab, _PyImport_DynLoadFiletab,
132 countD * sizeof(struct filedescr));
Georg Brandladd36e52007-08-23 18:08:06 +0000133#endif
Guido van Rossumed1170e1999-12-20 21:23:41 +0000134 memcpy(filetab + countD, _PyImport_StandardFiletab,
135 countS * sizeof(struct filedescr));
136 filetab[countD + countS].suffix = NULL;
137
138 _PyImport_Filetab = filetab;
139
Guido van Rossum0824f631997-03-11 18:37:35 +0000140 if (Py_OptimizeFlag) {
Guido van Rossumed1170e1999-12-20 21:23:41 +0000141 /* Replace ".pyc" with ".pyo" in _PyImport_Filetab */
142 for (; filetab->suffix != NULL; filetab++) {
Guido van Rossum48a680c2001-03-02 06:34:14 +0000143#ifndef RISCOS
Guido van Rossumed1170e1999-12-20 21:23:41 +0000144 if (strcmp(filetab->suffix, ".pyc") == 0)
145 filetab->suffix = ".pyo";
Guido van Rossum48a680c2001-03-02 06:34:14 +0000146#else
147 if (strcmp(filetab->suffix, "/pyc") == 0)
148 filetab->suffix = "/pyo";
149#endif
Guido van Rossum0824f631997-03-11 18:37:35 +0000150 }
151 }
Guido van Rossum96774c12000-05-01 20:19:08 +0000152
153 if (Py_UnicodeFlag) {
154 /* Fix the pyc_magic so that byte compiled code created
155 using the all-Unicode method doesn't interfere with
156 code created in normal operation mode. */
157 pyc_magic = MAGIC + 1;
158 }
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000159}
160
Guido van Rossum25ce5661997-08-02 03:10:38 +0000161void
Just van Rossum52e14d62002-12-30 22:08:05 +0000162_PyImportHooks_Init(void)
163{
164 PyObject *v, *path_hooks = NULL, *zimpimport;
165 int err = 0;
166
167 /* adding sys.path_hooks and sys.path_importer_cache, setting up
168 zipimport */
Nick Coghlan327a39b2007-11-18 11:56:28 +0000169 if (PyType_Ready(&PyNullImporter_Type) < 0)
Phillip J. Ebyf7575d02006-07-28 21:12:07 +0000170 goto error;
Just van Rossum52e14d62002-12-30 22:08:05 +0000171
172 if (Py_VerboseFlag)
173 PySys_WriteStderr("# installing zipimport hook\n");
174
175 v = PyList_New(0);
176 if (v == NULL)
177 goto error;
178 err = PySys_SetObject("meta_path", v);
179 Py_DECREF(v);
180 if (err)
181 goto error;
182 v = PyDict_New();
183 if (v == NULL)
184 goto error;
185 err = PySys_SetObject("path_importer_cache", v);
186 Py_DECREF(v);
187 if (err)
188 goto error;
189 path_hooks = PyList_New(0);
190 if (path_hooks == NULL)
191 goto error;
192 err = PySys_SetObject("path_hooks", path_hooks);
193 if (err) {
194 error:
195 PyErr_Print();
Phillip J. Ebyf7575d02006-07-28 21:12:07 +0000196 Py_FatalError("initializing sys.meta_path, sys.path_hooks, "
197 "path_importer_cache, or NullImporter failed"
198 );
Just van Rossum52e14d62002-12-30 22:08:05 +0000199 }
Phillip J. Ebyf7575d02006-07-28 21:12:07 +0000200
Just van Rossum52e14d62002-12-30 22:08:05 +0000201 zimpimport = PyImport_ImportModule("zipimport");
202 if (zimpimport == NULL) {
203 PyErr_Clear(); /* No zip import module -- okay */
204 if (Py_VerboseFlag)
205 PySys_WriteStderr("# can't import zipimport\n");
206 }
207 else {
208 PyObject *zipimporter = PyObject_GetAttrString(zimpimport,
209 "zipimporter");
210 Py_DECREF(zimpimport);
211 if (zipimporter == NULL) {
212 PyErr_Clear(); /* No zipimporter object -- okay */
213 if (Py_VerboseFlag)
214 PySys_WriteStderr(
Fred Drake1e5fc552003-07-11 15:01:02 +0000215 "# can't import zipimport.zipimporter\n");
Just van Rossum52e14d62002-12-30 22:08:05 +0000216 }
217 else {
218 /* sys.path_hooks.append(zipimporter) */
219 err = PyList_Append(path_hooks, zipimporter);
220 Py_DECREF(zipimporter);
221 if (err)
222 goto error;
223 if (Py_VerboseFlag)
224 PySys_WriteStderr(
225 "# installed zipimport hook\n");
226 }
227 }
228 Py_DECREF(path_hooks);
229}
230
231void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000232_PyImport_Fini(void)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000233{
234 Py_XDECREF(extensions);
235 extensions = NULL;
Barry Warsaw84294482000-10-03 16:02:05 +0000236 PyMem_DEL(_PyImport_Filetab);
237 _PyImport_Filetab = NULL;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000238}
239
240
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000241/* Locking primitives to prevent parallel imports of the same module
242 in different threads to return with a partially loaded module.
243 These calls are serialized by the global interpreter lock. */
244
245#ifdef WITH_THREAD
246
Guido van Rossum49b56061998-10-01 20:42:43 +0000247#include "pythread.h"
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000248
Guido van Rossum65d5b571998-12-21 19:32:43 +0000249static PyThread_type_lock import_lock = 0;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000250static long import_lock_thread = -1;
251static int import_lock_level = 0;
252
253static void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000254lock_import(void)
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000255{
Guido van Rossum65d5b571998-12-21 19:32:43 +0000256 long me = PyThread_get_thread_ident();
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000257 if (me == -1)
258 return; /* Too bad */
Neal Norwitze1fdb322006-07-21 05:32:28 +0000259 if (import_lock == NULL) {
Guido van Rossum65d5b571998-12-21 19:32:43 +0000260 import_lock = PyThread_allocate_lock();
Neal Norwitze1fdb322006-07-21 05:32:28 +0000261 if (import_lock == NULL)
262 return; /* Nothing much we can do. */
263 }
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000264 if (import_lock_thread == me) {
265 import_lock_level++;
266 return;
267 }
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000268 if (import_lock_thread != -1 || !PyThread_acquire_lock(import_lock, 0))
269 {
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000270 PyThreadState *tstate = PyEval_SaveThread();
Guido van Rossum65d5b571998-12-21 19:32:43 +0000271 PyThread_acquire_lock(import_lock, 1);
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000272 PyEval_RestoreThread(tstate);
273 }
274 import_lock_thread = me;
275 import_lock_level = 1;
276}
277
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000278static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000279unlock_import(void)
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000280{
Guido van Rossum65d5b571998-12-21 19:32:43 +0000281 long me = PyThread_get_thread_ident();
Neal Norwitze1fdb322006-07-21 05:32:28 +0000282 if (me == -1 || import_lock == NULL)
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000283 return 0; /* Too bad */
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000284 if (import_lock_thread != me)
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000285 return -1;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000286 import_lock_level--;
287 if (import_lock_level == 0) {
288 import_lock_thread = -1;
Guido van Rossum65d5b571998-12-21 19:32:43 +0000289 PyThread_release_lock(import_lock);
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000290 }
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000291 return 1;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000292}
293
Guido van Rossum8ee3e5a2005-09-14 18:09:42 +0000294/* This function is called from PyOS_AfterFork to ensure that newly
295 created child processes do not share locks with the parent. */
296
297void
298_PyImport_ReInitLock(void)
299{
300#ifdef _AIX
301 if (import_lock != NULL)
302 import_lock = PyThread_allocate_lock();
303#endif
304}
305
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000306#else
307
308#define lock_import()
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000309#define unlock_import() 0
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000310
311#endif
312
Tim Peters69232342001-08-30 05:16:13 +0000313static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000314imp_lock_held(PyObject *self, PyObject *noargs)
Tim Peters69232342001-08-30 05:16:13 +0000315{
Tim Peters69232342001-08-30 05:16:13 +0000316#ifdef WITH_THREAD
Guido van Rossumb8bff3f2002-04-07 06:34:38 +0000317 return PyBool_FromLong(import_lock_thread != -1);
Tim Peters69232342001-08-30 05:16:13 +0000318#else
Guido van Rossumb8bff3f2002-04-07 06:34:38 +0000319 return PyBool_FromLong(0);
Tim Peters69232342001-08-30 05:16:13 +0000320#endif
321}
322
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000323static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000324imp_acquire_lock(PyObject *self, PyObject *noargs)
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000325{
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000326#ifdef WITH_THREAD
327 lock_import();
328#endif
Neal Norwitz2294c0d2003-02-12 23:02:21 +0000329 Py_INCREF(Py_None);
330 return Py_None;
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000331}
332
333static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000334imp_release_lock(PyObject *self, PyObject *noargs)
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000335{
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000336#ifdef WITH_THREAD
337 if (unlock_import() < 0) {
338 PyErr_SetString(PyExc_RuntimeError,
339 "not holding the import lock");
340 return NULL;
341 }
342#endif
Neal Norwitz2294c0d2003-02-12 23:02:21 +0000343 Py_INCREF(Py_None);
344 return Py_None;
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000345}
346
Collin Winter276887b2007-03-12 16:11:39 +0000347static void
Neal Norwitz75c7c802007-03-13 05:31:38 +0000348imp_modules_reloading_clear(void)
Collin Winter276887b2007-03-12 16:11:39 +0000349{
350 PyInterpreterState *interp = PyThreadState_Get()->interp;
Neal Norwitz75c7c802007-03-13 05:31:38 +0000351 if (interp->modules_reloading != NULL)
352 PyDict_Clear(interp->modules_reloading);
Collin Winter276887b2007-03-12 16:11:39 +0000353}
354
Guido van Rossum25ce5661997-08-02 03:10:38 +0000355/* Helper for sys */
356
357PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000358PyImport_GetModuleDict(void)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000359{
Nicholas Bastine5662ae2004-03-24 22:22:12 +0000360 PyInterpreterState *interp = PyThreadState_GET()->interp;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000361 if (interp->modules == NULL)
362 Py_FatalError("PyImport_GetModuleDict: no module dictionary!");
363 return interp->modules;
364}
365
Guido van Rossum3f5da241990-12-20 15:06:42 +0000366
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000367/* List of names to clear in sys */
368static char* sys_deletes[] = {
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000369 "path", "argv", "ps1", "ps2", "exitfunc",
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000370 "exc_type", "exc_value", "exc_traceback",
371 "last_type", "last_value", "last_traceback",
Just van Rossum52e14d62002-12-30 22:08:05 +0000372 "path_hooks", "path_importer_cache", "meta_path",
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000373 NULL
374};
375
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000376static char* sys_files[] = {
377 "stdin", "__stdin__",
378 "stdout", "__stdout__",
379 "stderr", "__stderr__",
380 NULL
381};
382
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000383
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000384/* Un-initialize things, as good as we can */
Guido van Rossum3f5da241990-12-20 15:06:42 +0000385
Guido van Rossum3f5da241990-12-20 15:06:42 +0000386void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000387PyImport_Cleanup(void)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000388{
Martin v. Löwis18e16552006-02-15 17:27:45 +0000389 Py_ssize_t pos, ndone;
Guido van Rossum758eec01998-01-19 21:58:26 +0000390 char *name;
391 PyObject *key, *value, *dict;
Nicholas Bastine5662ae2004-03-24 22:22:12 +0000392 PyInterpreterState *interp = PyThreadState_GET()->interp;
Guido van Rossum758eec01998-01-19 21:58:26 +0000393 PyObject *modules = interp->modules;
394
395 if (modules == NULL)
396 return; /* Already done */
397
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000398 /* Delete some special variables first. These are common
399 places where user values hide and people complain when their
400 destructors fail. Since the modules containing them are
401 deleted *last* of all, they would come too late in the normal
402 destruction order. Sigh. */
403
404 value = PyDict_GetItemString(modules, "__builtin__");
405 if (value != NULL && PyModule_Check(value)) {
406 dict = PyModule_GetDict(value);
407 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000408 PySys_WriteStderr("# clear __builtin__._\n");
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000409 PyDict_SetItemString(dict, "_", Py_None);
410 }
411 value = PyDict_GetItemString(modules, "sys");
412 if (value != NULL && PyModule_Check(value)) {
413 char **p;
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000414 PyObject *v;
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000415 dict = PyModule_GetDict(value);
416 for (p = sys_deletes; *p != NULL; p++) {
417 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000418 PySys_WriteStderr("# clear sys.%s\n", *p);
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000419 PyDict_SetItemString(dict, *p, Py_None);
420 }
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000421 for (p = sys_files; *p != NULL; p+=2) {
422 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000423 PySys_WriteStderr("# restore sys.%s\n", *p);
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000424 v = PyDict_GetItemString(dict, *(p+1));
425 if (v == NULL)
426 v = Py_None;
427 PyDict_SetItemString(dict, *p, v);
428 }
429 }
430
431 /* First, delete __main__ */
432 value = PyDict_GetItemString(modules, "__main__");
433 if (value != NULL && PyModule_Check(value)) {
434 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000435 PySys_WriteStderr("# cleanup __main__\n");
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000436 _PyModule_Clear(value);
437 PyDict_SetItemString(modules, "__main__", Py_None);
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000438 }
439
Guido van Rossum758eec01998-01-19 21:58:26 +0000440 /* The special treatment of __builtin__ here is because even
441 when it's not referenced as a module, its dictionary is
442 referenced by almost every module's __builtins__. Since
443 deleting a module clears its dictionary (even if there are
444 references left to it), we need to delete the __builtin__
445 module last. Likewise, we don't delete sys until the very
446 end because it is implicitly referenced (e.g. by print).
447
448 Also note that we 'delete' modules by replacing their entry
449 in the modules dict with None, rather than really deleting
450 them; this avoids a rehash of the modules dictionary and
451 also marks them as "non existent" so they won't be
452 re-imported. */
453
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000454 /* Next, repeatedly delete modules with a reference count of
Guido van Rossum758eec01998-01-19 21:58:26 +0000455 one (skipping __builtin__ and sys) and delete them */
456 do {
457 ndone = 0;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000458 pos = 0;
Guido van Rossum758eec01998-01-19 21:58:26 +0000459 while (PyDict_Next(modules, &pos, &key, &value)) {
460 if (value->ob_refcnt != 1)
461 continue;
Guido van Rossum566373e1998-10-01 15:24:50 +0000462 if (PyString_Check(key) && PyModule_Check(value)) {
463 name = PyString_AS_STRING(key);
Guido van Rossum758eec01998-01-19 21:58:26 +0000464 if (strcmp(name, "__builtin__") == 0)
465 continue;
466 if (strcmp(name, "sys") == 0)
467 continue;
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000468 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000469 PySys_WriteStderr(
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000470 "# cleanup[1] %s\n", name);
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000471 _PyModule_Clear(value);
Guido van Rossum758eec01998-01-19 21:58:26 +0000472 PyDict_SetItem(modules, key, Py_None);
473 ndone++;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000474 }
475 }
Guido van Rossum758eec01998-01-19 21:58:26 +0000476 } while (ndone > 0);
477
Guido van Rossum758eec01998-01-19 21:58:26 +0000478 /* Next, delete all modules (still skipping __builtin__ and sys) */
479 pos = 0;
480 while (PyDict_Next(modules, &pos, &key, &value)) {
Guido van Rossum566373e1998-10-01 15:24:50 +0000481 if (PyString_Check(key) && PyModule_Check(value)) {
482 name = PyString_AS_STRING(key);
Guido van Rossum758eec01998-01-19 21:58:26 +0000483 if (strcmp(name, "__builtin__") == 0)
484 continue;
485 if (strcmp(name, "sys") == 0)
486 continue;
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000487 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000488 PySys_WriteStderr("# cleanup[2] %s\n", name);
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000489 _PyModule_Clear(value);
Guido van Rossum758eec01998-01-19 21:58:26 +0000490 PyDict_SetItem(modules, key, Py_None);
491 }
492 }
493
494 /* Next, delete sys and __builtin__ (in that order) */
495 value = PyDict_GetItemString(modules, "sys");
496 if (value != NULL && PyModule_Check(value)) {
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000497 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000498 PySys_WriteStderr("# cleanup sys\n");
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000499 _PyModule_Clear(value);
Guido van Rossum758eec01998-01-19 21:58:26 +0000500 PyDict_SetItemString(modules, "sys", Py_None);
501 }
502 value = PyDict_GetItemString(modules, "__builtin__");
503 if (value != NULL && PyModule_Check(value)) {
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000504 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000505 PySys_WriteStderr("# cleanup __builtin__\n");
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000506 _PyModule_Clear(value);
Guido van Rossum758eec01998-01-19 21:58:26 +0000507 PyDict_SetItemString(modules, "__builtin__", Py_None);
508 }
509
510 /* Finally, clear and delete the modules directory */
511 PyDict_Clear(modules);
512 interp->modules = NULL;
513 Py_DECREF(modules);
Collin Winter276887b2007-03-12 16:11:39 +0000514 Py_CLEAR(interp->modules_reloading);
Guido van Rossum8d15b5d1990-10-26 14:58:58 +0000515}
Guido van Rossum7f133ed1991-02-19 12:23:57 +0000516
517
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000518/* Helper for pythonrun.c -- return magic number */
519
520long
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000521PyImport_GetMagicNumber(void)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000522{
Guido van Rossum96774c12000-05-01 20:19:08 +0000523 return pyc_magic;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000524}
525
526
Guido van Rossum25ce5661997-08-02 03:10:38 +0000527/* Magic for extension modules (built-in as well as dynamically
528 loaded). To prevent initializing an extension module more than
529 once, we keep a static dictionary 'extensions' keyed by module name
530 (for built-in modules) or by filename (for dynamically loaded
Barry Warsaw92883382001-08-13 23:05:44 +0000531 modules), containing these modules. A copy of the module's
Guido van Rossum25ce5661997-08-02 03:10:38 +0000532 dictionary is stored by calling _PyImport_FixupExtension()
533 immediately after the module initialization function succeeds. A
534 copy can be retrieved from there by calling
535 _PyImport_FindExtension(). */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000536
Guido van Rossum79f25d91997-04-29 20:08:16 +0000537PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000538_PyImport_FixupExtension(char *name, char *filename)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000539{
Guido van Rossum25ce5661997-08-02 03:10:38 +0000540 PyObject *modules, *mod, *dict, *copy;
541 if (extensions == NULL) {
542 extensions = PyDict_New();
543 if (extensions == NULL)
544 return NULL;
545 }
546 modules = PyImport_GetModuleDict();
547 mod = PyDict_GetItemString(modules, name);
548 if (mod == NULL || !PyModule_Check(mod)) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000549 PyErr_Format(PyExc_SystemError,
550 "_PyImport_FixupExtension: module %.200s not loaded", name);
Guido van Rossum25ce5661997-08-02 03:10:38 +0000551 return NULL;
552 }
553 dict = PyModule_GetDict(mod);
554 if (dict == NULL)
555 return NULL;
Fred Drake9cd0efc2001-10-25 21:38:59 +0000556 copy = PyDict_Copy(dict);
Guido van Rossum25ce5661997-08-02 03:10:38 +0000557 if (copy == NULL)
558 return NULL;
559 PyDict_SetItemString(extensions, filename, copy);
560 Py_DECREF(copy);
561 return copy;
562}
563
564PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000565_PyImport_FindExtension(char *name, char *filename)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000566{
Fred Drake9cd0efc2001-10-25 21:38:59 +0000567 PyObject *dict, *mod, *mdict;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000568 if (extensions == NULL)
569 return NULL;
570 dict = PyDict_GetItemString(extensions, filename);
571 if (dict == NULL)
572 return NULL;
573 mod = PyImport_AddModule(name);
574 if (mod == NULL)
575 return NULL;
576 mdict = PyModule_GetDict(mod);
577 if (mdict == NULL)
578 return NULL;
Fred Drake9cd0efc2001-10-25 21:38:59 +0000579 if (PyDict_Update(mdict, dict))
Guido van Rossum25ce5661997-08-02 03:10:38 +0000580 return NULL;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000581 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000582 PySys_WriteStderr("import %s # previously loaded (%s)\n",
Guido van Rossum25ce5661997-08-02 03:10:38 +0000583 name, filename);
584 return mod;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000585}
586
587
588/* Get the module object corresponding to a module name.
589 First check the modules dictionary if there's one there,
Walter Dörwaldf0dfc7a2003-10-20 14:01:56 +0000590 if not, create a new one and insert it in the modules dictionary.
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000591 Because the former action is most common, THIS DOES NOT RETURN A
592 'NEW' REFERENCE! */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000593
Guido van Rossum79f25d91997-04-29 20:08:16 +0000594PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000595PyImport_AddModule(const char *name)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000596{
Guido van Rossum25ce5661997-08-02 03:10:38 +0000597 PyObject *modules = PyImport_GetModuleDict();
Guido van Rossum79f25d91997-04-29 20:08:16 +0000598 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000599
Guido van Rossum25ce5661997-08-02 03:10:38 +0000600 if ((m = PyDict_GetItemString(modules, name)) != NULL &&
Guido van Rossum79f25d91997-04-29 20:08:16 +0000601 PyModule_Check(m))
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000602 return m;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000603 m = PyModule_New(name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000604 if (m == NULL)
605 return NULL;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000606 if (PyDict_SetItemString(modules, name, m) != 0) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000607 Py_DECREF(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000608 return NULL;
609 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000610 Py_DECREF(m); /* Yes, it still exists, in modules! */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000611
612 return m;
613}
614
Tim Peters1cd70172004-08-02 03:52:12 +0000615/* Remove name from sys.modules, if it's there. */
616static void
617_RemoveModule(const char *name)
618{
619 PyObject *modules = PyImport_GetModuleDict();
620 if (PyDict_GetItemString(modules, name) == NULL)
621 return;
622 if (PyDict_DelItemString(modules, name) < 0)
623 Py_FatalError("import: deleting existing key in"
624 "sys.modules failed");
625}
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000626
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000627/* Execute a code object in a module and return the module object
Tim Peters1cd70172004-08-02 03:52:12 +0000628 * WITH INCREMENTED REFERENCE COUNT. If an error occurs, name is
629 * removed from sys.modules, to avoid leaving damaged module objects
630 * in sys.modules. The caller may wish to restore the original
631 * module object (if any) in this case; PyImport_ReloadModule is an
632 * example.
633 */
Guido van Rossum79f25d91997-04-29 20:08:16 +0000634PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000635PyImport_ExecCodeModule(char *name, PyObject *co)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000636{
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000637 return PyImport_ExecCodeModuleEx(name, co, (char *)NULL);
638}
639
640PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000641PyImport_ExecCodeModuleEx(char *name, PyObject *co, char *pathname)
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000642{
Guido van Rossum25ce5661997-08-02 03:10:38 +0000643 PyObject *modules = PyImport_GetModuleDict();
Guido van Rossum79f25d91997-04-29 20:08:16 +0000644 PyObject *m, *d, *v;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000645
Guido van Rossum79f25d91997-04-29 20:08:16 +0000646 m = PyImport_AddModule(name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000647 if (m == NULL)
648 return NULL;
Jeremy Hyltonecd91292004-01-02 23:25:32 +0000649 /* If the module is being reloaded, we get the old module back
650 and re-use its dict to exec the new code. */
Guido van Rossum79f25d91997-04-29 20:08:16 +0000651 d = PyModule_GetDict(m);
652 if (PyDict_GetItemString(d, "__builtins__") == NULL) {
653 if (PyDict_SetItemString(d, "__builtins__",
654 PyEval_GetBuiltins()) != 0)
Tim Peters1cd70172004-08-02 03:52:12 +0000655 goto error;
Guido van Rossum6135a871995-01-09 17:53:26 +0000656 }
Guido van Rossum9c9a07c1996-05-16 20:43:40 +0000657 /* Remember the filename as the __file__ attribute */
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000658 v = NULL;
659 if (pathname != NULL) {
660 v = PyString_FromString(pathname);
661 if (v == NULL)
662 PyErr_Clear();
663 }
664 if (v == NULL) {
665 v = ((PyCodeObject *)co)->co_filename;
666 Py_INCREF(v);
667 }
668 if (PyDict_SetItemString(d, "__file__", v) != 0)
Guido van Rossum79f25d91997-04-29 20:08:16 +0000669 PyErr_Clear(); /* Not important enough to report */
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000670 Py_DECREF(v);
671
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000672 v = PyEval_EvalCode((PyCodeObject *)co, d, d);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000673 if (v == NULL)
Tim Peters1cd70172004-08-02 03:52:12 +0000674 goto error;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000675 Py_DECREF(v);
Guido van Rossumb65e85c1997-07-10 18:00:45 +0000676
Guido van Rossum25ce5661997-08-02 03:10:38 +0000677 if ((m = PyDict_GetItemString(modules, name)) == NULL) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000678 PyErr_Format(PyExc_ImportError,
679 "Loaded module %.200s not found in sys.modules",
680 name);
Guido van Rossumb65e85c1997-07-10 18:00:45 +0000681 return NULL;
682 }
683
Guido van Rossum79f25d91997-04-29 20:08:16 +0000684 Py_INCREF(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000685
686 return m;
Tim Peters1cd70172004-08-02 03:52:12 +0000687
688 error:
689 _RemoveModule(name);
690 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000691}
692
693
694/* Given a pathname for a Python source file, fill a buffer with the
695 pathname for the corresponding compiled file. Return the pathname
696 for the compiled file, or NULL if there's no space in the buffer.
697 Doesn't set an exception. */
698
699static char *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000700make_compiled_pathname(char *pathname, char *buf, size_t buflen)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000701{
Tim Petersc1731372001-08-04 08:12:36 +0000702 size_t len = strlen(pathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000703 if (len+2 > buflen)
704 return NULL;
Tim Petersc1731372001-08-04 08:12:36 +0000705
Martin v. Löwis6238d2b2002-06-30 15:26:10 +0000706#ifdef MS_WINDOWS
Tim Petersc1731372001-08-04 08:12:36 +0000707 /* Treat .pyw as if it were .py. The case of ".pyw" must match
708 that used in _PyImport_StandardFiletab. */
709 if (len >= 4 && strcmp(&pathname[len-4], ".pyw") == 0)
710 --len; /* pretend 'w' isn't there */
711#endif
712 memcpy(buf, pathname, len);
713 buf[len] = Py_OptimizeFlag ? 'o' : 'c';
714 buf[len+1] = '\0';
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000715
716 return buf;
717}
718
719
720/* Given a pathname for a Python source file, its time of last
721 modification, and a pathname for a compiled file, check whether the
722 compiled file represents the same version of the source. If so,
723 return a FILE pointer for the compiled file, positioned just after
724 the header; if not, return NULL.
725 Doesn't set an exception. */
726
727static FILE *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000728check_compiled_module(char *pathname, time_t mtime, char *cpathname)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000729{
730 FILE *fp;
731 long magic;
732 long pyc_mtime;
733
734 fp = fopen(cpathname, "rb");
735 if (fp == NULL)
736 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000737 magic = PyMarshal_ReadLongFromFile(fp);
Guido van Rossum96774c12000-05-01 20:19:08 +0000738 if (magic != pyc_magic) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000739 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000740 PySys_WriteStderr("# %s has bad magic\n", cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000741 fclose(fp);
742 return NULL;
743 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000744 pyc_mtime = PyMarshal_ReadLongFromFile(fp);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000745 if (pyc_mtime != mtime) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000746 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000747 PySys_WriteStderr("# %s has bad mtime\n", cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000748 fclose(fp);
749 return NULL;
750 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000751 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000752 PySys_WriteStderr("# %s matches %s\n", cpathname, pathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000753 return fp;
754}
755
756
757/* Read a code object from a file and check it for validity */
758
Guido van Rossum79f25d91997-04-29 20:08:16 +0000759static PyCodeObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000760read_compiled_module(char *cpathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000761{
Guido van Rossum79f25d91997-04-29 20:08:16 +0000762 PyObject *co;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000763
Tim Petersd9b9ac82001-01-28 00:27:39 +0000764 co = PyMarshal_ReadLastObjectFromFile(fp);
Armin Rigo01ab2792004-03-26 15:09:27 +0000765 if (co == NULL)
766 return NULL;
767 if (!PyCode_Check(co)) {
768 PyErr_Format(PyExc_ImportError,
769 "Non-code object in %.200s", cpathname);
770 Py_DECREF(co);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000771 return NULL;
772 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000773 return (PyCodeObject *)co;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000774}
775
776
777/* Load a module from a compiled file, execute it, and return its
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000778 module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000779
Guido van Rossum79f25d91997-04-29 20:08:16 +0000780static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000781load_compiled_module(char *name, char *cpathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000782{
783 long magic;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000784 PyCodeObject *co;
785 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000786
Guido van Rossum79f25d91997-04-29 20:08:16 +0000787 magic = PyMarshal_ReadLongFromFile(fp);
Guido van Rossum96774c12000-05-01 20:19:08 +0000788 if (magic != pyc_magic) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000789 PyErr_Format(PyExc_ImportError,
790 "Bad magic number in %.200s", cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000791 return NULL;
792 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000793 (void) PyMarshal_ReadLongFromFile(fp);
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000794 co = read_compiled_module(cpathname, fp);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000795 if (co == NULL)
796 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000797 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000798 PySys_WriteStderr("import %s # precompiled from %s\n",
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000799 name, cpathname);
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000800 m = PyImport_ExecCodeModuleEx(name, (PyObject *)co, cpathname);
Guido van Rossum79f25d91997-04-29 20:08:16 +0000801 Py_DECREF(co);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000802
803 return m;
804}
805
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000806/* Parse a source file and return the corresponding code object */
807
Guido van Rossum79f25d91997-04-29 20:08:16 +0000808static PyCodeObject *
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000809parse_source_module(const char *pathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000810{
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000811 PyCodeObject *co = NULL;
812 mod_ty mod;
Neal Norwitz2a399b02006-09-11 04:28:16 +0000813 PyArena *arena = PyArena_New();
814 if (arena == NULL)
815 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000816
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000817 mod = PyParser_ASTFromFile(fp, pathname, Py_file_input, 0, 0, 0,
Neal Norwitzadb69fc2005-12-17 20:54:49 +0000818 NULL, arena);
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000819 if (mod) {
Neal Norwitzadb69fc2005-12-17 20:54:49 +0000820 co = PyAST_Compile(mod, pathname, NULL, arena);
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000821 }
Neal Norwitz2a399b02006-09-11 04:28:16 +0000822 PyArena_Free(arena);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000823 return co;
824}
825
826
Guido van Rossum55a83382000-09-20 20:31:38 +0000827/* Helper to open a bytecode file for writing in exclusive mode */
828
829static FILE *
830open_exclusive(char *filename)
831{
832#if defined(O_EXCL)&&defined(O_CREAT)&&defined(O_WRONLY)&&defined(O_TRUNC)
833 /* Use O_EXCL to avoid a race condition when another process tries to
834 write the same file. When that happens, our open() call fails,
835 which is just fine (since it's only a cache).
836 XXX If the file exists and is writable but the directory is not
837 writable, the file will never be written. Oh well.
838 */
839 int fd;
840 (void) unlink(filename);
Tim Peters42c83af2000-09-29 04:03:10 +0000841 fd = open(filename, O_EXCL|O_CREAT|O_WRONLY|O_TRUNC
842#ifdef O_BINARY
843 |O_BINARY /* necessary for Windows */
844#endif
Martin v. Löwis79acb9e2002-12-06 12:48:53 +0000845#ifdef __VMS
Martin v. Löwis18e16552006-02-15 17:27:45 +0000846 , 0666, "ctxt=bin", "shr=nil"
Martin v. Löwis79acb9e2002-12-06 12:48:53 +0000847#else
Martin v. Löwis18e16552006-02-15 17:27:45 +0000848 , 0666
Martin v. Löwis79acb9e2002-12-06 12:48:53 +0000849#endif
Martin v. Löwis18e16552006-02-15 17:27:45 +0000850 );
Guido van Rossum55a83382000-09-20 20:31:38 +0000851 if (fd < 0)
852 return NULL;
853 return fdopen(fd, "wb");
854#else
855 /* Best we can do -- on Windows this can't happen anyway */
856 return fopen(filename, "wb");
857#endif
858}
859
860
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000861/* Write a compiled module to a file, placing the time of last
862 modification of its source into the header.
863 Errors are ignored, if a write error occurs an attempt is made to
864 remove the file. */
865
866static void
Martin v. Löwis18e16552006-02-15 17:27:45 +0000867write_compiled_module(PyCodeObject *co, char *cpathname, time_t mtime)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000868{
869 FILE *fp;
870
Guido van Rossum55a83382000-09-20 20:31:38 +0000871 fp = open_exclusive(cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000872 if (fp == NULL) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000873 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000874 PySys_WriteStderr(
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000875 "# can't create %s\n", cpathname);
876 return;
877 }
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000878 PyMarshal_WriteLongToFile(pyc_magic, fp, Py_MARSHAL_VERSION);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000879 /* First write a 0 for mtime */
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000880 PyMarshal_WriteLongToFile(0L, fp, Py_MARSHAL_VERSION);
881 PyMarshal_WriteObjectToFile((PyObject *)co, fp, Py_MARSHAL_VERSION);
Armin Rigo01ab2792004-03-26 15:09:27 +0000882 if (fflush(fp) != 0 || ferror(fp)) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000883 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000884 PySys_WriteStderr("# can't write %s\n", cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000885 /* Don't keep partial file */
886 fclose(fp);
887 (void) unlink(cpathname);
888 return;
889 }
890 /* Now write the true mtime */
891 fseek(fp, 4L, 0);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000892 assert(mtime < LONG_MAX);
Martin v. Löwis725507b2006-03-07 12:08:51 +0000893 PyMarshal_WriteLongToFile((long)mtime, fp, Py_MARSHAL_VERSION);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000894 fflush(fp);
895 fclose(fp);
Guido van Rossum79f25d91997-04-29 20:08:16 +0000896 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000897 PySys_WriteStderr("# wrote %s\n", cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000898}
899
900
901/* Load a source module from a given file and return its module
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000902 object WITH INCREMENTED REFERENCE COUNT. If there's a matching
903 byte-compiled file, use that instead. */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000904
Guido van Rossum79f25d91997-04-29 20:08:16 +0000905static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000906load_source_module(char *name, char *pathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000907{
Fred Drake4c82b232000-06-30 16:18:57 +0000908 time_t mtime;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000909 FILE *fpc;
910 char buf[MAXPATHLEN+1];
911 char *cpathname;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000912 PyCodeObject *co;
913 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000914
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000915 mtime = PyOS_GetLastModificationTime(pathname, fp);
Neal Norwitz708e51a2005-10-03 04:48:15 +0000916 if (mtime == (time_t)(-1)) {
917 PyErr_Format(PyExc_RuntimeError,
918 "unable to get modification time from '%s'",
919 pathname);
Fred Drake4c82b232000-06-30 16:18:57 +0000920 return NULL;
Neal Norwitz708e51a2005-10-03 04:48:15 +0000921 }
Fred Drake4c82b232000-06-30 16:18:57 +0000922#if SIZEOF_TIME_T > 4
923 /* Python's .pyc timestamp handling presumes that the timestamp fits
924 in 4 bytes. This will be fine until sometime in the year 2038,
925 when a 4-byte signed time_t will overflow.
926 */
927 if (mtime >> 32) {
928 PyErr_SetString(PyExc_OverflowError,
Fred Drakec63d3e92001-03-01 06:33:32 +0000929 "modification time overflows a 4 byte field");
Fred Drake4c82b232000-06-30 16:18:57 +0000930 return NULL;
931 }
932#endif
Tim Peters36515e22001-11-18 04:06:29 +0000933 cpathname = make_compiled_pathname(pathname, buf,
Jeremy Hylton37832f02001-04-13 17:50:20 +0000934 (size_t)MAXPATHLEN + 1);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000935 if (cpathname != NULL &&
936 (fpc = check_compiled_module(pathname, mtime, cpathname))) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000937 co = read_compiled_module(cpathname, fpc);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000938 fclose(fpc);
939 if (co == NULL)
940 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000941 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000942 PySys_WriteStderr("import %s # precompiled from %s\n",
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000943 name, cpathname);
Guido van Rossumafd3dae1998-08-25 18:44:34 +0000944 pathname = cpathname;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000945 }
946 else {
947 co = parse_source_module(pathname, fp);
948 if (co == NULL)
949 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000950 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000951 PySys_WriteStderr("import %s # from %s\n",
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000952 name, pathname);
Neal Norwitz3cb31ac2006-08-13 18:10:47 +0000953 if (cpathname)
954 write_compiled_module(co, cpathname, mtime);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000955 }
Guido van Rossumafd3dae1998-08-25 18:44:34 +0000956 m = PyImport_ExecCodeModuleEx(name, (PyObject *)co, pathname);
Guido van Rossum79f25d91997-04-29 20:08:16 +0000957 Py_DECREF(co);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000958
959 return m;
960}
961
962
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000963/* Forward */
Just van Rossum52e14d62002-12-30 22:08:05 +0000964static PyObject *load_module(char *, FILE *, char *, int, PyObject *);
965static struct filedescr *find_module(char *, char *, PyObject *,
966 char *, size_t, FILE **, PyObject **);
Tim Petersdbd9ba62000-07-09 03:09:57 +0000967static struct _frozen *find_frozen(char *name);
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000968
969/* Load a package and return its module object WITH INCREMENTED
970 REFERENCE COUNT */
971
972static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000973load_package(char *name, char *pathname)
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000974{
Tim Peters1cd70172004-08-02 03:52:12 +0000975 PyObject *m, *d;
976 PyObject *file = NULL;
977 PyObject *path = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000978 int err;
979 char buf[MAXPATHLEN+1];
980 FILE *fp = NULL;
981 struct filedescr *fdp;
982
983 m = PyImport_AddModule(name);
984 if (m == NULL)
985 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +0000986 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000987 PySys_WriteStderr("import %s # directory %s\n",
Guido van Rossum17fc85f1997-09-06 18:52:03 +0000988 name, pathname);
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000989 d = PyModule_GetDict(m);
990 file = PyString_FromString(pathname);
991 if (file == NULL)
Tim Peters1cd70172004-08-02 03:52:12 +0000992 goto error;
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000993 path = Py_BuildValue("[O]", file);
Tim Peters1cd70172004-08-02 03:52:12 +0000994 if (path == NULL)
995 goto error;
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000996 err = PyDict_SetItemString(d, "__file__", file);
997 if (err == 0)
998 err = PyDict_SetItemString(d, "__path__", path);
Tim Peters1cd70172004-08-02 03:52:12 +0000999 if (err != 0)
1000 goto error;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001001 buf[0] = '\0';
Just van Rossum52e14d62002-12-30 22:08:05 +00001002 fdp = find_module(name, "__init__", path, buf, sizeof(buf), &fp, NULL);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001003 if (fdp == NULL) {
1004 if (PyErr_ExceptionMatches(PyExc_ImportError)) {
1005 PyErr_Clear();
Thomas Heller25653242004-06-07 15:04:10 +00001006 Py_INCREF(m);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001007 }
1008 else
1009 m = NULL;
1010 goto cleanup;
1011 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001012 m = load_module(name, fp, buf, fdp->type, NULL);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001013 if (fp != NULL)
1014 fclose(fp);
Tim Peters1cd70172004-08-02 03:52:12 +00001015 goto cleanup;
1016
1017 error:
1018 m = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001019 cleanup:
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001020 Py_XDECREF(path);
1021 Py_XDECREF(file);
1022 return m;
1023}
1024
1025
1026/* Helper to test for built-in module */
1027
1028static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001029is_builtin(char *name)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001030{
1031 int i;
Guido van Rossum771c6c81997-10-31 18:37:24 +00001032 for (i = 0; PyImport_Inittab[i].name != NULL; i++) {
1033 if (strcmp(name, PyImport_Inittab[i].name) == 0) {
1034 if (PyImport_Inittab[i].initfunc == NULL)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001035 return -1;
1036 else
1037 return 1;
1038 }
1039 }
1040 return 0;
1041}
1042
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001043
Just van Rossum52e14d62002-12-30 22:08:05 +00001044/* Return an importer object for a sys.path/pkg.__path__ item 'p',
1045 possibly by fetching it from the path_importer_cache dict. If it
Brett Cannon94b69f62006-09-28 22:10:14 +00001046 wasn't yet cached, traverse path_hooks until a hook is found
Just van Rossum52e14d62002-12-30 22:08:05 +00001047 that can handle the path item. Return None if no hook could;
1048 this tells our caller it should fall back to the builtin
1049 import mechanism. Cache the result in path_importer_cache.
1050 Returns a borrowed reference. */
1051
1052static PyObject *
1053get_path_importer(PyObject *path_importer_cache, PyObject *path_hooks,
1054 PyObject *p)
1055{
1056 PyObject *importer;
Martin v. Löwis725507b2006-03-07 12:08:51 +00001057 Py_ssize_t j, nhooks;
Just van Rossum52e14d62002-12-30 22:08:05 +00001058
1059 /* These conditions are the caller's responsibility: */
1060 assert(PyList_Check(path_hooks));
1061 assert(PyDict_Check(path_importer_cache));
1062
1063 nhooks = PyList_Size(path_hooks);
1064 if (nhooks < 0)
1065 return NULL; /* Shouldn't happen */
1066
1067 importer = PyDict_GetItem(path_importer_cache, p);
1068 if (importer != NULL)
1069 return importer;
1070
1071 /* set path_importer_cache[p] to None to avoid recursion */
1072 if (PyDict_SetItem(path_importer_cache, p, Py_None) != 0)
1073 return NULL;
1074
1075 for (j = 0; j < nhooks; j++) {
1076 PyObject *hook = PyList_GetItem(path_hooks, j);
1077 if (hook == NULL)
1078 return NULL;
Georg Brandl684fd0c2006-05-25 19:15:31 +00001079 importer = PyObject_CallFunctionObjArgs(hook, p, NULL);
Just van Rossum52e14d62002-12-30 22:08:05 +00001080 if (importer != NULL)
1081 break;
1082
1083 if (!PyErr_ExceptionMatches(PyExc_ImportError)) {
1084 return NULL;
1085 }
1086 PyErr_Clear();
1087 }
Phillip J. Ebyf7575d02006-07-28 21:12:07 +00001088 if (importer == NULL) {
1089 importer = PyObject_CallFunctionObjArgs(
Nick Coghlan327a39b2007-11-18 11:56:28 +00001090 (PyObject *)&PyNullImporter_Type, p, NULL
Phillip J. Ebyf7575d02006-07-28 21:12:07 +00001091 );
1092 if (importer == NULL) {
1093 if (PyErr_ExceptionMatches(PyExc_ImportError)) {
1094 PyErr_Clear();
1095 return Py_None;
1096 }
1097 }
1098 }
1099 if (importer != NULL) {
Just van Rossum52e14d62002-12-30 22:08:05 +00001100 int err = PyDict_SetItem(path_importer_cache, p, importer);
1101 Py_DECREF(importer);
1102 if (err != 0)
1103 return NULL;
1104 }
1105 return importer;
1106}
1107
Nick Coghlan327a39b2007-11-18 11:56:28 +00001108PyAPI_FUNC(PyObject *)
1109PyImport_GetImporter(PyObject *path) {
1110 PyObject *importer=NULL, *path_importer_cache=NULL, *path_hooks=NULL;
1111
1112 if ((path_importer_cache = PySys_GetObject("path_importer_cache"))) {
1113 if ((path_hooks = PySys_GetObject("path_hooks"))) {
1114 importer = get_path_importer(path_importer_cache,
1115 path_hooks, path);
1116 }
1117 }
1118 Py_XINCREF(importer); /* get_path_importer returns a borrowed reference */
1119 return importer;
1120}
1121
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001122/* Search the path (default sys.path) for a module. Return the
1123 corresponding filedescr struct, and (via return arguments) the
1124 pathname and an open file. Return NULL if the module is not found. */
1125
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001126#ifdef MS_COREDLL
Thomas Woutersb4bd21c2000-07-22 23:38:01 +00001127extern FILE *PyWin_FindRegisteredModule(const char *, struct filedescr **,
Martin v. Löwis18e16552006-02-15 17:27:45 +00001128 char *, Py_ssize_t);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001129#endif
1130
Martin v. Löwis18e16552006-02-15 17:27:45 +00001131static int case_ok(char *, Py_ssize_t, Py_ssize_t, char *);
Tim Petersdbd9ba62000-07-09 03:09:57 +00001132static int find_init_module(char *); /* Forward */
Just van Rossum52e14d62002-12-30 22:08:05 +00001133static struct filedescr importhookdescr = {"", "", IMP_HOOK};
Guido van Rossum197346f1997-10-31 18:38:52 +00001134
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001135static struct filedescr *
Just van Rossum52e14d62002-12-30 22:08:05 +00001136find_module(char *fullname, char *subname, PyObject *path, char *buf,
1137 size_t buflen, FILE **p_fp, PyObject **p_loader)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001138{
Martin v. Löwis725507b2006-03-07 12:08:51 +00001139 Py_ssize_t i, npath;
Fred Drake4c82b232000-06-30 16:18:57 +00001140 size_t len, namelen;
Guido van Rossum80bb9651996-12-05 23:27:02 +00001141 struct filedescr *fdp = NULL;
Jack Jansenc88da1f2002-05-28 10:58:19 +00001142 char *filemode;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001143 FILE *fp = NULL;
Just van Rossum52e14d62002-12-30 22:08:05 +00001144 PyObject *path_hooks, *path_importer_cache;
Guido van Rossum48a680c2001-03-02 06:34:14 +00001145#ifndef RISCOS
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001146 struct stat statbuf;
Guido van Rossum48a680c2001-03-02 06:34:14 +00001147#endif
Guido van Rossuma5568d31998-03-05 03:45:08 +00001148 static struct filedescr fd_frozen = {"", "", PY_FROZEN};
1149 static struct filedescr fd_builtin = {"", "", C_BUILTIN};
1150 static struct filedescr fd_package = {"", "", PKG_DIRECTORY};
Guido van Rossum0506a431998-08-11 15:07:39 +00001151 char name[MAXPATHLEN+1];
Andrew MacIntyred9400542002-02-26 11:41:34 +00001152#if defined(PYOS_OS2)
1153 size_t saved_len;
1154 size_t saved_namelen;
1155 char *saved_buf = NULL;
1156#endif
Just van Rossum52e14d62002-12-30 22:08:05 +00001157 if (p_loader != NULL)
1158 *p_loader = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001159
Just van Rossum52e14d62002-12-30 22:08:05 +00001160 if (strlen(subname) > MAXPATHLEN) {
Guido van Rossum8f4d3312001-10-18 18:54:11 +00001161 PyErr_SetString(PyExc_OverflowError,
1162 "module name is too long");
Fred Drake4c82b232000-06-30 16:18:57 +00001163 return NULL;
1164 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001165 strcpy(name, subname);
1166
1167 /* sys.meta_path import hook */
1168 if (p_loader != NULL) {
1169 PyObject *meta_path;
1170
1171 meta_path = PySys_GetObject("meta_path");
1172 if (meta_path == NULL || !PyList_Check(meta_path)) {
1173 PyErr_SetString(PyExc_ImportError,
1174 "sys.meta_path must be a list of "
1175 "import hooks");
1176 return NULL;
1177 }
1178 Py_INCREF(meta_path); /* zap guard */
1179 npath = PyList_Size(meta_path);
1180 for (i = 0; i < npath; i++) {
1181 PyObject *loader;
1182 PyObject *hook = PyList_GetItem(meta_path, i);
1183 loader = PyObject_CallMethod(hook, "find_module",
1184 "sO", fullname,
1185 path != NULL ?
1186 path : Py_None);
1187 if (loader == NULL) {
1188 Py_DECREF(meta_path);
1189 return NULL; /* true error */
1190 }
1191 if (loader != Py_None) {
1192 /* a loader was found */
1193 *p_loader = loader;
1194 Py_DECREF(meta_path);
1195 return &importhookdescr;
1196 }
1197 Py_DECREF(loader);
1198 }
1199 Py_DECREF(meta_path);
1200 }
Guido van Rossum0506a431998-08-11 15:07:39 +00001201
1202 if (path != NULL && PyString_Check(path)) {
Guido van Rossum8f4d3312001-10-18 18:54:11 +00001203 /* The only type of submodule allowed inside a "frozen"
1204 package are other frozen modules or packages. */
Guido van Rossum0506a431998-08-11 15:07:39 +00001205 if (PyString_Size(path) + 1 + strlen(name) >= (size_t)buflen) {
1206 PyErr_SetString(PyExc_ImportError,
1207 "full frozen module name too long");
1208 return NULL;
1209 }
1210 strcpy(buf, PyString_AsString(path));
1211 strcat(buf, ".");
1212 strcat(buf, name);
1213 strcpy(name, buf);
Guido van Rossum8f4d3312001-10-18 18:54:11 +00001214 if (find_frozen(name) != NULL) {
1215 strcpy(buf, name);
1216 return &fd_frozen;
1217 }
1218 PyErr_Format(PyExc_ImportError,
1219 "No frozen submodule named %.200s", name);
1220 return NULL;
Guido van Rossum0506a431998-08-11 15:07:39 +00001221 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001222 if (path == NULL) {
1223 if (is_builtin(name)) {
Guido van Rossuma5568d31998-03-05 03:45:08 +00001224 strcpy(buf, name);
1225 return &fd_builtin;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001226 }
Greg Ward201baee2001-10-04 14:52:06 +00001227 if ((find_frozen(name)) != NULL) {
Guido van Rossuma5568d31998-03-05 03:45:08 +00001228 strcpy(buf, name);
1229 return &fd_frozen;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001230 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001231
Guido van Rossumac279101996-08-22 23:10:58 +00001232#ifdef MS_COREDLL
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001233 fp = PyWin_FindRegisteredModule(name, &fdp, buf, buflen);
1234 if (fp != NULL) {
1235 *p_fp = fp;
1236 return fdp;
1237 }
Guido van Rossuma5a3db71996-04-09 02:39:59 +00001238#endif
Guido van Rossuma5568d31998-03-05 03:45:08 +00001239 path = PySys_GetObject("path");
1240 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00001241 if (path == NULL || !PyList_Check(path)) {
1242 PyErr_SetString(PyExc_ImportError,
Guido van Rossuma5568d31998-03-05 03:45:08 +00001243 "sys.path must be a list of directory names");
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001244 return NULL;
1245 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001246
1247 path_hooks = PySys_GetObject("path_hooks");
1248 if (path_hooks == NULL || !PyList_Check(path_hooks)) {
1249 PyErr_SetString(PyExc_ImportError,
1250 "sys.path_hooks must be a list of "
1251 "import hooks");
1252 return NULL;
1253 }
1254 path_importer_cache = PySys_GetObject("path_importer_cache");
1255 if (path_importer_cache == NULL ||
1256 !PyDict_Check(path_importer_cache)) {
1257 PyErr_SetString(PyExc_ImportError,
1258 "sys.path_importer_cache must be a dict");
1259 return NULL;
1260 }
1261
Guido van Rossum79f25d91997-04-29 20:08:16 +00001262 npath = PyList_Size(path);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001263 namelen = strlen(name);
1264 for (i = 0; i < npath; i++) {
Walter Dörwald3430d702002-06-17 10:43:59 +00001265 PyObject *copy = NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +00001266 PyObject *v = PyList_GetItem(path, i);
Neal Norwitz3cb31ac2006-08-13 18:10:47 +00001267 if (!v)
1268 return NULL;
Walter Dörwald3430d702002-06-17 10:43:59 +00001269#ifdef Py_USING_UNICODE
1270 if (PyUnicode_Check(v)) {
1271 copy = PyUnicode_Encode(PyUnicode_AS_UNICODE(v),
1272 PyUnicode_GET_SIZE(v), Py_FileSystemDefaultEncoding, NULL);
1273 if (copy == NULL)
1274 return NULL;
1275 v = copy;
1276 }
1277 else
1278#endif
Guido van Rossum79f25d91997-04-29 20:08:16 +00001279 if (!PyString_Check(v))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001280 continue;
Neal Norwitz2aa9a5d2006-03-20 01:53:23 +00001281 len = PyString_GET_SIZE(v);
Walter Dörwald3430d702002-06-17 10:43:59 +00001282 if (len + 2 + namelen + MAXSUFFIXSIZE >= buflen) {
1283 Py_XDECREF(copy);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001284 continue; /* Too long */
Walter Dörwald3430d702002-06-17 10:43:59 +00001285 }
Neal Norwitz2aa9a5d2006-03-20 01:53:23 +00001286 strcpy(buf, PyString_AS_STRING(v));
Walter Dörwald3430d702002-06-17 10:43:59 +00001287 if (strlen(buf) != len) {
1288 Py_XDECREF(copy);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001289 continue; /* v contains '\0' */
Walter Dörwald3430d702002-06-17 10:43:59 +00001290 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001291
1292 /* sys.path_hooks import hook */
1293 if (p_loader != NULL) {
1294 PyObject *importer;
1295
1296 importer = get_path_importer(path_importer_cache,
1297 path_hooks, v);
Neal Norwitza4df11d2006-07-06 04:28:59 +00001298 if (importer == NULL) {
1299 Py_XDECREF(copy);
Just van Rossum52e14d62002-12-30 22:08:05 +00001300 return NULL;
Neal Norwitza4df11d2006-07-06 04:28:59 +00001301 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001302 /* Note: importer is a borrowed reference */
Phillip J. Ebyf7575d02006-07-28 21:12:07 +00001303 if (importer != Py_None) {
Just van Rossum52e14d62002-12-30 22:08:05 +00001304 PyObject *loader;
1305 loader = PyObject_CallMethod(importer,
1306 "find_module",
1307 "s", fullname);
Neal Norwitza4df11d2006-07-06 04:28:59 +00001308 Py_XDECREF(copy);
Just van Rossum52e14d62002-12-30 22:08:05 +00001309 if (loader == NULL)
1310 return NULL; /* error */
1311 if (loader != Py_None) {
1312 /* a loader was found */
1313 *p_loader = loader;
1314 return &importhookdescr;
1315 }
1316 Py_DECREF(loader);
Georg Brandlf4ef1162006-05-26 18:03:31 +00001317 continue;
Just van Rossum52e14d62002-12-30 22:08:05 +00001318 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001319 }
Georg Brandlf4ef1162006-05-26 18:03:31 +00001320 /* no hook was found, use builtin import */
Just van Rossum52e14d62002-12-30 22:08:05 +00001321
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001322 if (len > 0 && buf[len-1] != SEP
1323#ifdef ALTSEP
1324 && buf[len-1] != ALTSEP
1325#endif
1326 )
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001327 buf[len++] = SEP;
Guido van Rossum215c3402000-11-13 17:26:32 +00001328 strcpy(buf+len, name);
1329 len += namelen;
Tim Peters50d8d372001-02-28 05:34:27 +00001330
1331 /* Check for package import (buf holds a directory name,
1332 and there's an __init__ module in that directory */
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001333#ifdef HAVE_STAT
Walter Dörwald3430d702002-06-17 10:43:59 +00001334 if (stat(buf, &statbuf) == 0 && /* it exists */
1335 S_ISDIR(statbuf.st_mode) && /* it's a directory */
Thomas Wouters9df4e6f2006-04-27 23:13:20 +00001336 case_ok(buf, len, namelen, name)) { /* case matches */
1337 if (find_init_module(buf)) { /* and has __init__.py */
1338 Py_XDECREF(copy);
1339 return &fd_package;
1340 }
1341 else {
1342 char warnstr[MAXPATHLEN+80];
1343 sprintf(warnstr, "Not importing directory "
1344 "'%.*s': missing __init__.py",
1345 MAXPATHLEN, buf);
1346 if (PyErr_Warn(PyExc_ImportWarning,
1347 warnstr)) {
1348 Py_XDECREF(copy);
1349 return NULL;
1350 }
1351 }
Walter Dörwald3430d702002-06-17 10:43:59 +00001352 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001353#else
1354 /* XXX How are you going to test for directories? */
Guido van Rossum48a680c2001-03-02 06:34:14 +00001355#ifdef RISCOS
Guido van Rossume2ae77b2001-10-24 20:42:55 +00001356 if (isdir(buf) &&
Walter Dörwald3430d702002-06-17 10:43:59 +00001357 case_ok(buf, len, namelen, name)) {
Thomas Wouters9df4e6f2006-04-27 23:13:20 +00001358 if (find_init_module(buf)) {
1359 Py_XDECREF(copy);
1360 return &fd_package;
1361 }
1362 else {
1363 char warnstr[MAXPATHLEN+80];
1364 sprintf(warnstr, "Not importing directory "
1365 "'%.*s': missing __init__.py",
1366 MAXPATHLEN, buf);
1367 if (PyErr_Warn(PyExc_ImportWarning,
1368 warnstr)) {
1369 Py_XDECREF(copy);
1370 return NULL;
1371 }
Walter Dörwald3430d702002-06-17 10:43:59 +00001372 }
Guido van Rossum48a680c2001-03-02 06:34:14 +00001373#endif
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001374#endif
Andrew MacIntyred9400542002-02-26 11:41:34 +00001375#if defined(PYOS_OS2)
1376 /* take a snapshot of the module spec for restoration
1377 * after the 8 character DLL hackery
1378 */
1379 saved_buf = strdup(buf);
1380 saved_len = len;
1381 saved_namelen = namelen;
1382#endif /* PYOS_OS2 */
Guido van Rossum79f25d91997-04-29 20:08:16 +00001383 for (fdp = _PyImport_Filetab; fdp->suffix != NULL; fdp++) {
Georg Brandladd36e52007-08-23 18:08:06 +00001384#if defined(PYOS_OS2) && defined(HAVE_DYNAMIC_LOADING)
Jeremy Hylton4ae6fae2002-05-30 17:15:25 +00001385 /* OS/2 limits DLLs to 8 character names (w/o
1386 extension)
Andrew MacIntyred9400542002-02-26 11:41:34 +00001387 * so if the name is longer than that and its a
1388 * dynamically loaded module we're going to try,
1389 * truncate the name before trying
1390 */
Just van Rossum52e14d62002-12-30 22:08:05 +00001391 if (strlen(subname) > 8) {
Andrew MacIntyred9400542002-02-26 11:41:34 +00001392 /* is this an attempt to load a C extension? */
Jeremy Hylton4ae6fae2002-05-30 17:15:25 +00001393 const struct filedescr *scan;
1394 scan = _PyImport_DynLoadFiletab;
Andrew MacIntyred9400542002-02-26 11:41:34 +00001395 while (scan->suffix != NULL) {
Jeremy Hylton4ae6fae2002-05-30 17:15:25 +00001396 if (!strcmp(scan->suffix, fdp->suffix))
Andrew MacIntyred9400542002-02-26 11:41:34 +00001397 break;
1398 else
1399 scan++;
1400 }
1401 if (scan->suffix != NULL) {
1402 /* yes, so truncate the name */
1403 namelen = 8;
Just van Rossum52e14d62002-12-30 22:08:05 +00001404 len -= strlen(subname) - namelen;
Andrew MacIntyred9400542002-02-26 11:41:34 +00001405 buf[len] = '\0';
1406 }
1407 }
1408#endif /* PYOS_OS2 */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001409 strcpy(buf+len, fdp->suffix);
Guido van Rossum79f25d91997-04-29 20:08:16 +00001410 if (Py_VerboseFlag > 1)
Guido van Rossum2f3667a1998-10-12 18:23:55 +00001411 PySys_WriteStderr("# trying %s\n", buf);
Jack Jansenc88da1f2002-05-28 10:58:19 +00001412 filemode = fdp->mode;
Tim Peters86c7d2f2004-08-01 23:24:21 +00001413 if (filemode[0] == 'U')
Jeremy Hylton4ae6fae2002-05-30 17:15:25 +00001414 filemode = "r" PY_STDIOTEXTMODE;
Jack Jansenc88da1f2002-05-28 10:58:19 +00001415 fp = fopen(buf, filemode);
Tim Peters50d8d372001-02-28 05:34:27 +00001416 if (fp != NULL) {
1417 if (case_ok(buf, len, namelen, name))
1418 break;
1419 else { /* continue search */
1420 fclose(fp);
1421 fp = NULL;
Barry Warsaw914a0b12001-02-02 19:12:16 +00001422 }
Barry Warsaw914a0b12001-02-02 19:12:16 +00001423 }
Andrew MacIntyred9400542002-02-26 11:41:34 +00001424#if defined(PYOS_OS2)
1425 /* restore the saved snapshot */
1426 strcpy(buf, saved_buf);
1427 len = saved_len;
1428 namelen = saved_namelen;
1429#endif
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001430 }
Andrew MacIntyred9400542002-02-26 11:41:34 +00001431#if defined(PYOS_OS2)
1432 /* don't need/want the module name snapshot anymore */
1433 if (saved_buf)
1434 {
1435 free(saved_buf);
1436 saved_buf = NULL;
1437 }
1438#endif
Walter Dörwald3430d702002-06-17 10:43:59 +00001439 Py_XDECREF(copy);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001440 if (fp != NULL)
1441 break;
1442 }
1443 if (fp == NULL) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001444 PyErr_Format(PyExc_ImportError,
1445 "No module named %.200s", name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001446 return NULL;
1447 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001448 *p_fp = fp;
1449 return fdp;
1450}
1451
Raymond Hettingerdb29e0f2004-10-07 06:46:25 +00001452/* Helpers for main.c
1453 * Find the source file corresponding to a named module
1454 */
1455struct filedescr *
1456_PyImport_FindModule(const char *name, PyObject *path, char *buf,
1457 size_t buflen, FILE **p_fp, PyObject **p_loader)
1458{
1459 return find_module((char *) name, (char *) name, path,
1460 buf, buflen, p_fp, p_loader);
1461}
1462
1463PyAPI_FUNC(int) _PyImport_IsScript(struct filedescr * fd)
1464{
1465 return fd->type == PY_SOURCE || fd->type == PY_COMPILED;
1466}
1467
Martin v. Löwis18e16552006-02-15 17:27:45 +00001468/* case_ok(char* buf, Py_ssize_t len, Py_ssize_t namelen, char* name)
Tim Petersd1e87a82001-03-01 18:12:00 +00001469 * The arguments here are tricky, best shown by example:
1470 * /a/b/c/d/e/f/g/h/i/j/k/some_long_module_name.py\0
1471 * ^ ^ ^ ^
1472 * |--------------------- buf ---------------------|
1473 * |------------------- len ------------------|
1474 * |------ name -------|
1475 * |----- namelen -----|
1476 * buf is the full path, but len only counts up to (& exclusive of) the
1477 * extension. name is the module name, also exclusive of extension.
1478 *
1479 * We've already done a successful stat() or fopen() on buf, so know that
1480 * there's some match, possibly case-insensitive.
1481 *
Tim Peters50d8d372001-02-28 05:34:27 +00001482 * case_ok() is to return 1 if there's a case-sensitive match for
1483 * name, else 0. case_ok() is also to return 1 if envar PYTHONCASEOK
1484 * exists.
Tim Petersd1e87a82001-03-01 18:12:00 +00001485 *
Tim Peters50d8d372001-02-28 05:34:27 +00001486 * case_ok() is used to implement case-sensitive import semantics even
1487 * on platforms with case-insensitive filesystems. It's trivial to implement
1488 * for case-sensitive filesystems. It's pretty much a cross-platform
1489 * nightmare for systems with case-insensitive filesystems.
1490 */
Guido van Rossum0980bd91998-02-13 17:18:36 +00001491
Tim Peters50d8d372001-02-28 05:34:27 +00001492/* First we may need a pile of platform-specific header files; the sequence
1493 * of #if's here should match the sequence in the body of case_ok().
1494 */
Jason Tishler7961aa62005-05-20 00:56:54 +00001495#if defined(MS_WINDOWS)
Guido van Rossum0980bd91998-02-13 17:18:36 +00001496#include <windows.h>
Guido van Rossum4c3f57c2001-01-10 20:40:46 +00001497
Tim Peters50d8d372001-02-28 05:34:27 +00001498#elif defined(DJGPP)
1499#include <dir.h>
1500
Jason Tishler7961aa62005-05-20 00:56:54 +00001501#elif (defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) && defined(HAVE_DIRENT_H)
Tim Peters430f5d42001-03-01 01:30:56 +00001502#include <sys/types.h>
1503#include <dirent.h>
1504
Andrew MacIntyred9400542002-02-26 11:41:34 +00001505#elif defined(PYOS_OS2)
1506#define INCL_DOS
1507#define INCL_DOSERRORS
1508#define INCL_NOPMAPI
1509#include <os2.h>
1510
Guido van Rossume2ae77b2001-10-24 20:42:55 +00001511#elif defined(RISCOS)
1512#include "oslib/osfscontrol.h"
Tim Peters50d8d372001-02-28 05:34:27 +00001513#endif
1514
Guido van Rossum0980bd91998-02-13 17:18:36 +00001515static int
Martin v. Löwis18e16552006-02-15 17:27:45 +00001516case_ok(char *buf, Py_ssize_t len, Py_ssize_t namelen, char *name)
Guido van Rossum0980bd91998-02-13 17:18:36 +00001517{
Tim Peters50d8d372001-02-28 05:34:27 +00001518/* Pick a platform-specific implementation; the sequence of #if's here should
1519 * match the sequence just above.
1520 */
1521
Jason Tishler7961aa62005-05-20 00:56:54 +00001522/* MS_WINDOWS */
1523#if defined(MS_WINDOWS)
Guido van Rossum0980bd91998-02-13 17:18:36 +00001524 WIN32_FIND_DATA data;
1525 HANDLE h;
Tim Peters50d8d372001-02-28 05:34:27 +00001526
Neil Schemenauer7d4bb9f2001-07-23 16:30:27 +00001527 if (Py_GETENV("PYTHONCASEOK") != NULL)
Guido van Rossum0980bd91998-02-13 17:18:36 +00001528 return 1;
Tim Peters50d8d372001-02-28 05:34:27 +00001529
Guido van Rossum0980bd91998-02-13 17:18:36 +00001530 h = FindFirstFile(buf, &data);
1531 if (h == INVALID_HANDLE_VALUE) {
1532 PyErr_Format(PyExc_NameError,
1533 "Can't find file for module %.100s\n(filename %.300s)",
1534 name, buf);
1535 return 0;
1536 }
1537 FindClose(h);
Tim Peters50d8d372001-02-28 05:34:27 +00001538 return strncmp(data.cFileName, name, namelen) == 0;
1539
1540/* DJGPP */
1541#elif defined(DJGPP)
1542 struct ffblk ffblk;
1543 int done;
1544
Neil Schemenauer7d4bb9f2001-07-23 16:30:27 +00001545 if (Py_GETENV("PYTHONCASEOK") != NULL)
Guido van Rossum323bf5e1998-06-24 03:54:06 +00001546 return 1;
Tim Peters50d8d372001-02-28 05:34:27 +00001547
1548 done = findfirst(buf, &ffblk, FA_ARCH|FA_RDONLY|FA_HIDDEN|FA_DIREC);
1549 if (done) {
Guido van Rossum0980bd91998-02-13 17:18:36 +00001550 PyErr_Format(PyExc_NameError,
Tim Peters50d8d372001-02-28 05:34:27 +00001551 "Can't find file for module %.100s\n(filename %.300s)",
Guido van Rossum0980bd91998-02-13 17:18:36 +00001552 name, buf);
1553 return 0;
1554 }
Tim Peters50d8d372001-02-28 05:34:27 +00001555 return strncmp(ffblk.ff_name, name, namelen) == 0;
Guido van Rossum0980bd91998-02-13 17:18:36 +00001556
Jason Tishler7961aa62005-05-20 00:56:54 +00001557/* new-fangled macintosh (macosx) or Cygwin */
1558#elif (defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) && defined(HAVE_DIRENT_H)
Tim Peters430f5d42001-03-01 01:30:56 +00001559 DIR *dirp;
1560 struct dirent *dp;
Tim Petersd1e87a82001-03-01 18:12:00 +00001561 char dirname[MAXPATHLEN + 1];
1562 const int dirlen = len - namelen - 1; /* don't want trailing SEP */
Tim Peters430f5d42001-03-01 01:30:56 +00001563
Neil Schemenauer7d4bb9f2001-07-23 16:30:27 +00001564 if (Py_GETENV("PYTHONCASEOK") != NULL)
Tim Petersdbe6ebb2001-03-01 08:47:29 +00001565 return 1;
1566
Tim Petersd1e87a82001-03-01 18:12:00 +00001567 /* Copy the dir component into dirname; substitute "." if empty */
1568 if (dirlen <= 0) {
1569 dirname[0] = '.';
1570 dirname[1] = '\0';
Tim Peters430f5d42001-03-01 01:30:56 +00001571 }
1572 else {
Tim Petersd1e87a82001-03-01 18:12:00 +00001573 assert(dirlen <= MAXPATHLEN);
1574 memcpy(dirname, buf, dirlen);
1575 dirname[dirlen] = '\0';
Tim Peters430f5d42001-03-01 01:30:56 +00001576 }
1577 /* Open the directory and search the entries for an exact match. */
Tim Petersd1e87a82001-03-01 18:12:00 +00001578 dirp = opendir(dirname);
Tim Peters430f5d42001-03-01 01:30:56 +00001579 if (dirp) {
Tim Peters677898a2001-03-02 03:28:03 +00001580 char *nameWithExt = buf + len - namelen;
Tim Peters430f5d42001-03-01 01:30:56 +00001581 while ((dp = readdir(dirp)) != NULL) {
Tim Petersdbe6ebb2001-03-01 08:47:29 +00001582 const int thislen =
Tim Peters430f5d42001-03-01 01:30:56 +00001583#ifdef _DIRENT_HAVE_D_NAMELEN
Tim Petersdbe6ebb2001-03-01 08:47:29 +00001584 dp->d_namlen;
Tim Peters430f5d42001-03-01 01:30:56 +00001585#else
Tim Petersdbe6ebb2001-03-01 08:47:29 +00001586 strlen(dp->d_name);
Tim Peters430f5d42001-03-01 01:30:56 +00001587#endif
Tim Petersd1e87a82001-03-01 18:12:00 +00001588 if (thislen >= namelen &&
Tim Peters677898a2001-03-02 03:28:03 +00001589 strcmp(dp->d_name, nameWithExt) == 0) {
Tim Peters430f5d42001-03-01 01:30:56 +00001590 (void)closedir(dirp);
1591 return 1; /* Found */
1592 }
1593 }
Tim Petersdbe6ebb2001-03-01 08:47:29 +00001594 (void)closedir(dirp);
Tim Peters430f5d42001-03-01 01:30:56 +00001595 }
Tim Peters430f5d42001-03-01 01:30:56 +00001596 return 0 ; /* Not found */
Tim Peters430f5d42001-03-01 01:30:56 +00001597
Guido van Rossume2ae77b2001-10-24 20:42:55 +00001598/* RISC OS */
1599#elif defined(RISCOS)
1600 char canon[MAXPATHLEN+1]; /* buffer for the canonical form of the path */
1601 char buf2[MAXPATHLEN+2];
1602 char *nameWithExt = buf+len-namelen;
1603 int canonlen;
1604 os_error *e;
1605
1606 if (Py_GETENV("PYTHONCASEOK") != NULL)
1607 return 1;
1608
1609 /* workaround:
1610 append wildcard, otherwise case of filename wouldn't be touched */
1611 strcpy(buf2, buf);
1612 strcat(buf2, "*");
1613
1614 e = xosfscontrol_canonicalise_path(buf2,canon,0,0,MAXPATHLEN+1,&canonlen);
1615 canonlen = MAXPATHLEN+1-canonlen;
1616 if (e || canonlen<=0 || canonlen>(MAXPATHLEN+1) )
1617 return 0;
1618 if (strcmp(nameWithExt, canon+canonlen-strlen(nameWithExt))==0)
1619 return 1; /* match */
1620
1621 return 0;
1622
Andrew MacIntyred9400542002-02-26 11:41:34 +00001623/* OS/2 */
1624#elif defined(PYOS_OS2)
1625 HDIR hdir = 1;
1626 ULONG srchcnt = 1;
1627 FILEFINDBUF3 ffbuf;
1628 APIRET rc;
1629
1630 if (getenv("PYTHONCASEOK") != NULL)
1631 return 1;
1632
1633 rc = DosFindFirst(buf,
1634 &hdir,
1635 FILE_READONLY | FILE_HIDDEN | FILE_SYSTEM | FILE_DIRECTORY,
1636 &ffbuf, sizeof(ffbuf),
1637 &srchcnt,
1638 FIL_STANDARD);
1639 if (rc != NO_ERROR)
1640 return 0;
1641 return strncmp(ffbuf.achName, name, namelen) == 0;
1642
Tim Peters50d8d372001-02-28 05:34:27 +00001643/* assuming it's a case-sensitive filesystem, so there's nothing to do! */
1644#else
Guido van Rossum0980bd91998-02-13 17:18:36 +00001645 return 1;
Guido van Rossum0980bd91998-02-13 17:18:36 +00001646
Guido van Rossum4d1b3b91998-02-13 23:27:59 +00001647#endif
Tim Peters50d8d372001-02-28 05:34:27 +00001648}
Guido van Rossum4d1b3b91998-02-13 23:27:59 +00001649
Guido van Rossum0980bd91998-02-13 17:18:36 +00001650
Guido van Rossum197346f1997-10-31 18:38:52 +00001651#ifdef HAVE_STAT
1652/* Helper to look for __init__.py or __init__.py[co] in potential package */
1653static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001654find_init_module(char *buf)
Guido van Rossum197346f1997-10-31 18:38:52 +00001655{
Tim Peters0f9431f2001-07-05 03:47:53 +00001656 const size_t save_len = strlen(buf);
Fred Drake4c82b232000-06-30 16:18:57 +00001657 size_t i = save_len;
Tim Peters0f9431f2001-07-05 03:47:53 +00001658 char *pname; /* pointer to start of __init__ */
Guido van Rossum197346f1997-10-31 18:38:52 +00001659 struct stat statbuf;
1660
Tim Peters0f9431f2001-07-05 03:47:53 +00001661/* For calling case_ok(buf, len, namelen, name):
1662 * /a/b/c/d/e/f/g/h/i/j/k/some_long_module_name.py\0
1663 * ^ ^ ^ ^
1664 * |--------------------- buf ---------------------|
1665 * |------------------- len ------------------|
1666 * |------ name -------|
1667 * |----- namelen -----|
1668 */
Guido van Rossum197346f1997-10-31 18:38:52 +00001669 if (save_len + 13 >= MAXPATHLEN)
1670 return 0;
1671 buf[i++] = SEP;
Tim Peters0f9431f2001-07-05 03:47:53 +00001672 pname = buf + i;
1673 strcpy(pname, "__init__.py");
Guido van Rossum197346f1997-10-31 18:38:52 +00001674 if (stat(buf, &statbuf) == 0) {
Tim Peters0f9431f2001-07-05 03:47:53 +00001675 if (case_ok(buf,
1676 save_len + 9, /* len("/__init__") */
1677 8, /* len("__init__") */
1678 pname)) {
1679 buf[save_len] = '\0';
1680 return 1;
1681 }
Guido van Rossum197346f1997-10-31 18:38:52 +00001682 }
Tim Peters0f9431f2001-07-05 03:47:53 +00001683 i += strlen(pname);
1684 strcpy(buf+i, Py_OptimizeFlag ? "o" : "c");
Guido van Rossum197346f1997-10-31 18:38:52 +00001685 if (stat(buf, &statbuf) == 0) {
Tim Peters0f9431f2001-07-05 03:47:53 +00001686 if (case_ok(buf,
1687 save_len + 9, /* len("/__init__") */
1688 8, /* len("__init__") */
1689 pname)) {
1690 buf[save_len] = '\0';
1691 return 1;
1692 }
Guido van Rossum197346f1997-10-31 18:38:52 +00001693 }
1694 buf[save_len] = '\0';
1695 return 0;
1696}
Guido van Rossum48a680c2001-03-02 06:34:14 +00001697
1698#else
1699
1700#ifdef RISCOS
1701static int
1702find_init_module(buf)
1703 char *buf;
1704{
1705 int save_len = strlen(buf);
1706 int i = save_len;
1707
1708 if (save_len + 13 >= MAXPATHLEN)
1709 return 0;
1710 buf[i++] = SEP;
1711 strcpy(buf+i, "__init__/py");
1712 if (isfile(buf)) {
1713 buf[save_len] = '\0';
1714 return 1;
1715 }
1716
1717 if (Py_OptimizeFlag)
1718 strcpy(buf+i, "o");
1719 else
1720 strcpy(buf+i, "c");
1721 if (isfile(buf)) {
1722 buf[save_len] = '\0';
1723 return 1;
1724 }
1725 buf[save_len] = '\0';
1726 return 0;
1727}
1728#endif /*RISCOS*/
1729
Guido van Rossum197346f1997-10-31 18:38:52 +00001730#endif /* HAVE_STAT */
1731
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001732
Tim Petersdbd9ba62000-07-09 03:09:57 +00001733static int init_builtin(char *); /* Forward */
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001734
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001735/* Load an external module using the default search path and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001736 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001737
Guido van Rossum79f25d91997-04-29 20:08:16 +00001738static PyObject *
Just van Rossum52e14d62002-12-30 22:08:05 +00001739load_module(char *name, FILE *fp, char *buf, int type, PyObject *loader)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001740{
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001741 PyObject *modules;
Guido van Rossum79f25d91997-04-29 20:08:16 +00001742 PyObject *m;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001743 int err;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001744
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001745 /* First check that there's an open file (if we need one) */
1746 switch (type) {
1747 case PY_SOURCE:
1748 case PY_COMPILED:
1749 if (fp == NULL) {
1750 PyErr_Format(PyExc_ValueError,
1751 "file object required for import (type code %d)",
1752 type);
1753 return NULL;
1754 }
1755 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001756
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001757 switch (type) {
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001758
1759 case PY_SOURCE:
1760 m = load_source_module(name, buf, fp);
1761 break;
1762
1763 case PY_COMPILED:
1764 m = load_compiled_module(name, buf, fp);
1765 break;
1766
Guido van Rossum96a8fb71999-12-22 14:09:35 +00001767#ifdef HAVE_DYNAMIC_LOADING
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001768 case C_EXTENSION:
Guido van Rossum79f25d91997-04-29 20:08:16 +00001769 m = _PyImport_LoadDynamicModule(name, buf, fp);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001770 break;
Guido van Rossum96a8fb71999-12-22 14:09:35 +00001771#endif
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001772
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001773 case PKG_DIRECTORY:
1774 m = load_package(name, buf);
1775 break;
1776
1777 case C_BUILTIN:
1778 case PY_FROZEN:
Guido van Rossuma5568d31998-03-05 03:45:08 +00001779 if (buf != NULL && buf[0] != '\0')
1780 name = buf;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001781 if (type == C_BUILTIN)
1782 err = init_builtin(name);
1783 else
1784 err = PyImport_ImportFrozenModule(name);
1785 if (err < 0)
Guido van Rossuma86f77d1997-09-09 18:53:47 +00001786 return NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001787 if (err == 0) {
1788 PyErr_Format(PyExc_ImportError,
1789 "Purported %s module %.200s not found",
1790 type == C_BUILTIN ?
1791 "builtin" : "frozen",
1792 name);
Guido van Rossuma86f77d1997-09-09 18:53:47 +00001793 return NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001794 }
1795 modules = PyImport_GetModuleDict();
1796 m = PyDict_GetItemString(modules, name);
1797 if (m == NULL) {
1798 PyErr_Format(
1799 PyExc_ImportError,
1800 "%s module %.200s not properly initialized",
1801 type == C_BUILTIN ?
1802 "builtin" : "frozen",
1803 name);
Guido van Rossuma86f77d1997-09-09 18:53:47 +00001804 return NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001805 }
1806 Py_INCREF(m);
1807 break;
1808
Just van Rossum52e14d62002-12-30 22:08:05 +00001809 case IMP_HOOK: {
1810 if (loader == NULL) {
1811 PyErr_SetString(PyExc_ImportError,
1812 "import hook without loader");
1813 return NULL;
1814 }
1815 m = PyObject_CallMethod(loader, "load_module", "s", name);
1816 break;
1817 }
1818
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001819 default:
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001820 PyErr_Format(PyExc_ImportError,
1821 "Don't know how to import %.200s (type code %d)",
1822 name, type);
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001823 m = NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001824
1825 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001826
1827 return m;
1828}
1829
1830
1831/* Initialize a built-in module.
Brett Cannon5a9aa4f2006-10-03 21:58:55 +00001832 Return 1 for success, 0 if the module is not found, and -1 with
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001833 an exception set if the initialization failed. */
Guido van Rossum7f133ed1991-02-19 12:23:57 +00001834
Guido van Rossum7f133ed1991-02-19 12:23:57 +00001835static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001836init_builtin(char *name)
Guido van Rossum7f133ed1991-02-19 12:23:57 +00001837{
Guido van Rossum25ce5661997-08-02 03:10:38 +00001838 struct _inittab *p;
Guido van Rossum25ce5661997-08-02 03:10:38 +00001839
Greg Ward201baee2001-10-04 14:52:06 +00001840 if (_PyImport_FindExtension(name, name) != NULL)
Guido van Rossum25ce5661997-08-02 03:10:38 +00001841 return 1;
1842
Guido van Rossum771c6c81997-10-31 18:37:24 +00001843 for (p = PyImport_Inittab; p->name != NULL; p++) {
Guido van Rossum25ce5661997-08-02 03:10:38 +00001844 if (strcmp(name, p->name) == 0) {
1845 if (p->initfunc == NULL) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001846 PyErr_Format(PyExc_ImportError,
1847 "Cannot re-init internal module %.200s",
1848 name);
Guido van Rossum74e6a111994-08-29 12:54:38 +00001849 return -1;
1850 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00001851 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +00001852 PySys_WriteStderr("import %s # builtin\n", name);
Guido van Rossum25ce5661997-08-02 03:10:38 +00001853 (*p->initfunc)();
Guido van Rossum79f25d91997-04-29 20:08:16 +00001854 if (PyErr_Occurred())
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001855 return -1;
Guido van Rossum25ce5661997-08-02 03:10:38 +00001856 if (_PyImport_FixupExtension(name, name) == NULL)
1857 return -1;
Guido van Rossum7f133ed1991-02-19 12:23:57 +00001858 return 1;
1859 }
1860 }
1861 return 0;
1862}
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001863
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001864
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001865/* Frozen modules */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001866
Guido van Rossumcfd0a221996-06-17 17:06:34 +00001867static struct _frozen *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001868find_frozen(char *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001869{
Guido van Rossumcfd0a221996-06-17 17:06:34 +00001870 struct _frozen *p;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001871
Guido van Rossum79f25d91997-04-29 20:08:16 +00001872 for (p = PyImport_FrozenModules; ; p++) {
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001873 if (p->name == NULL)
1874 return NULL;
1875 if (strcmp(p->name, name) == 0)
1876 break;
1877 }
1878 return p;
1879}
1880
Guido van Rossum79f25d91997-04-29 20:08:16 +00001881static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001882get_frozen_object(char *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001883{
Guido van Rossumcfd0a221996-06-17 17:06:34 +00001884 struct _frozen *p = find_frozen(name);
Guido van Rossuma5568d31998-03-05 03:45:08 +00001885 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001886
1887 if (p == NULL) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001888 PyErr_Format(PyExc_ImportError,
1889 "No such frozen object named %.200s",
1890 name);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001891 return NULL;
1892 }
Guido van Rossum8f4d3312001-10-18 18:54:11 +00001893 if (p->code == NULL) {
1894 PyErr_Format(PyExc_ImportError,
1895 "Excluded frozen object named %.200s",
1896 name);
1897 return NULL;
1898 }
Guido van Rossuma5568d31998-03-05 03:45:08 +00001899 size = p->size;
1900 if (size < 0)
1901 size = -size;
1902 return PyMarshal_ReadObjectFromString((char *)p->code, size);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001903}
1904
1905/* Initialize a frozen module.
1906 Return 1 for succes, 0 if the module is not found, and -1 with
1907 an exception set if the initialization failed.
1908 This function is also used from frozenmain.c */
Guido van Rossum0b344901995-02-07 15:35:27 +00001909
1910int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001911PyImport_ImportFrozenModule(char *name)
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001912{
Guido van Rossumcfd0a221996-06-17 17:06:34 +00001913 struct _frozen *p = find_frozen(name);
Guido van Rossum79f25d91997-04-29 20:08:16 +00001914 PyObject *co;
1915 PyObject *m;
Guido van Rossuma5568d31998-03-05 03:45:08 +00001916 int ispackage;
1917 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001918
1919 if (p == NULL)
1920 return 0;
Guido van Rossum8f4d3312001-10-18 18:54:11 +00001921 if (p->code == NULL) {
1922 PyErr_Format(PyExc_ImportError,
1923 "Excluded frozen object named %.200s",
1924 name);
1925 return -1;
1926 }
Guido van Rossuma5568d31998-03-05 03:45:08 +00001927 size = p->size;
1928 ispackage = (size < 0);
1929 if (ispackage)
1930 size = -size;
Guido van Rossum79f25d91997-04-29 20:08:16 +00001931 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +00001932 PySys_WriteStderr("import %s # frozen%s\n",
Guido van Rossuma5568d31998-03-05 03:45:08 +00001933 name, ispackage ? " package" : "");
1934 co = PyMarshal_ReadObjectFromString((char *)p->code, size);
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001935 if (co == NULL)
1936 return -1;
Guido van Rossum79f25d91997-04-29 20:08:16 +00001937 if (!PyCode_Check(co)) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001938 PyErr_Format(PyExc_TypeError,
1939 "frozen object %.200s is not a code object",
1940 name);
Neal Norwitzc0cde4d2006-07-16 02:17:36 +00001941 goto err_return;
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001942 }
Guido van Rossuma5568d31998-03-05 03:45:08 +00001943 if (ispackage) {
1944 /* Set __path__ to the package name */
1945 PyObject *d, *s;
1946 int err;
1947 m = PyImport_AddModule(name);
1948 if (m == NULL)
Neal Norwitzc0cde4d2006-07-16 02:17:36 +00001949 goto err_return;
Guido van Rossuma5568d31998-03-05 03:45:08 +00001950 d = PyModule_GetDict(m);
1951 s = PyString_InternFromString(name);
1952 if (s == NULL)
Neal Norwitzc0cde4d2006-07-16 02:17:36 +00001953 goto err_return;
Guido van Rossuma5568d31998-03-05 03:45:08 +00001954 err = PyDict_SetItemString(d, "__path__", s);
1955 Py_DECREF(s);
1956 if (err != 0)
Neal Norwitzc0cde4d2006-07-16 02:17:36 +00001957 goto err_return;
Guido van Rossuma5568d31998-03-05 03:45:08 +00001958 }
Guido van Rossume32bf6e1998-02-11 05:53:02 +00001959 m = PyImport_ExecCodeModuleEx(name, co, "<frozen>");
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001960 if (m == NULL)
Neal Norwitzc0cde4d2006-07-16 02:17:36 +00001961 goto err_return;
1962 Py_DECREF(co);
Guido van Rossum79f25d91997-04-29 20:08:16 +00001963 Py_DECREF(m);
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001964 return 1;
Neal Norwitzc0cde4d2006-07-16 02:17:36 +00001965err_return:
1966 Py_DECREF(co);
1967 return -1;
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001968}
Guido van Rossum74e6a111994-08-29 12:54:38 +00001969
1970
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001971/* Import a module, either built-in, frozen, or external, and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001972 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum74e6a111994-08-29 12:54:38 +00001973
Guido van Rossum79f25d91997-04-29 20:08:16 +00001974PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001975PyImport_ImportModule(const char *name)
Guido van Rossum74e6a111994-08-29 12:54:38 +00001976{
Marc-André Lemburg3c61c352001-02-09 19:40:15 +00001977 PyObject *pname;
1978 PyObject *result;
1979
1980 pname = PyString_FromString(name);
Neal Norwitza11e4c12003-03-23 14:31:01 +00001981 if (pname == NULL)
1982 return NULL;
Marc-André Lemburg3c61c352001-02-09 19:40:15 +00001983 result = PyImport_Import(pname);
1984 Py_DECREF(pname);
1985 return result;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001986}
1987
Christian Heimes000a0742008-01-03 22:16:32 +00001988/* Import a module without blocking
1989 *
1990 * At first it tries to fetch the module from sys.modules. If the module was
1991 * never loaded before it loads it with PyImport_ImportModule() unless another
1992 * thread holds the import lock. In the latter case the function raises an
1993 * ImportError instead of blocking.
1994 *
1995 * Returns the module object with incremented ref count.
1996 */
1997PyObject *
1998PyImport_ImportModuleNoBlock(const char *name)
1999{
2000 PyObject *result;
2001 PyObject *modules;
2002 long me;
2003
2004 /* Try to get the module from sys.modules[name] */
2005 modules = PyImport_GetModuleDict();
2006 if (modules == NULL)
2007 return NULL;
2008
2009 result = PyDict_GetItemString(modules, name);
2010 if (result != NULL) {
2011 Py_INCREF(result);
2012 return result;
2013 }
2014 else {
2015 PyErr_Clear();
2016 }
2017
2018 /* check the import lock
2019 * me might be -1 but I ignore the error here, the lock function
2020 * takes care of the problem */
2021 me = PyThread_get_thread_ident();
2022 if (import_lock_thread == -1 || import_lock_thread == me) {
2023 /* no thread or me is holding the lock */
2024 return PyImport_ImportModule(name);
2025 }
2026 else {
2027 PyErr_Format(PyExc_ImportError,
2028 "Failed to import %.200s because the import lock"
2029 "is held by another thread.",
2030 name);
2031 return NULL;
2032 }
2033}
2034
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002035/* Forward declarations for helper routines */
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002036static PyObject *get_parent(PyObject *globals, char *buf,
2037 Py_ssize_t *p_buflen, int level);
Tim Petersdbd9ba62000-07-09 03:09:57 +00002038static PyObject *load_next(PyObject *mod, PyObject *altmod,
Martin v. Löwis18e16552006-02-15 17:27:45 +00002039 char **p_name, char *buf, Py_ssize_t *p_buflen);
Tim Petersdbd9ba62000-07-09 03:09:57 +00002040static int mark_miss(char *name);
2041static int ensure_fromlist(PyObject *mod, PyObject *fromlist,
Martin v. Löwis18e16552006-02-15 17:27:45 +00002042 char *buf, Py_ssize_t buflen, int recursive);
Tim Petersdbd9ba62000-07-09 03:09:57 +00002043static PyObject * import_submodule(PyObject *mod, char *name, char *fullname);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002044
2045/* The Magnum Opus of dotted-name import :-) */
2046
Guido van Rossum75acc9c1998-03-03 22:26:50 +00002047static PyObject *
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002048import_module_level(char *name, PyObject *globals, PyObject *locals,
2049 PyObject *fromlist, int level)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002050{
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002051 char buf[MAXPATHLEN+1];
Martin v. Löwis18e16552006-02-15 17:27:45 +00002052 Py_ssize_t buflen = 0;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002053 PyObject *parent, *head, *next, *tail;
2054
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002055 parent = get_parent(globals, buf, &buflen, level);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002056 if (parent == NULL)
2057 return NULL;
2058
2059 head = load_next(parent, Py_None, &name, buf, &buflen);
2060 if (head == NULL)
2061 return NULL;
2062
2063 tail = head;
2064 Py_INCREF(tail);
2065 while (name) {
2066 next = load_next(tail, tail, &name, buf, &buflen);
2067 Py_DECREF(tail);
2068 if (next == NULL) {
2069 Py_DECREF(head);
2070 return NULL;
2071 }
2072 tail = next;
2073 }
Thomas Wouters8ddab272006-04-04 16:17:02 +00002074 if (tail == Py_None) {
2075 /* If tail is Py_None, both get_parent and load_next found
2076 an empty module name: someone called __import__("") or
2077 doctored faulty bytecode */
Thomas Wouters4bdaa272006-04-05 13:39:37 +00002078 Py_DECREF(tail);
2079 Py_DECREF(head);
Thomas Wouters8ddab272006-04-04 16:17:02 +00002080 PyErr_SetString(PyExc_ValueError,
2081 "Empty module name");
2082 return NULL;
2083 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002084
2085 if (fromlist != NULL) {
2086 if (fromlist == Py_None || !PyObject_IsTrue(fromlist))
2087 fromlist = NULL;
2088 }
2089
2090 if (fromlist == NULL) {
2091 Py_DECREF(tail);
2092 return head;
2093 }
2094
2095 Py_DECREF(head);
Guido van Rossum9905ef91997-09-08 16:07:11 +00002096 if (!ensure_fromlist(tail, fromlist, buf, buflen, 0)) {
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002097 Py_DECREF(tail);
2098 return NULL;
2099 }
2100
2101 return tail;
2102}
2103
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002104PyObject *
2105PyImport_ImportModuleLevel(char *name, PyObject *globals, PyObject *locals,
2106 PyObject *fromlist, int level)
2107{
2108 PyObject *result;
2109 lock_import();
2110 result = import_module_level(name, globals, locals, fromlist, level);
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00002111 if (unlock_import() < 0) {
2112 Py_XDECREF(result);
2113 PyErr_SetString(PyExc_RuntimeError,
2114 "not holding the import lock");
2115 return NULL;
2116 }
Guido van Rossum75acc9c1998-03-03 22:26:50 +00002117 return result;
2118}
2119
Fred Drake87590902004-05-28 20:21:36 +00002120/* Return the package that an import is being performed in. If globals comes
2121 from the module foo.bar.bat (not itself a package), this returns the
2122 sys.modules entry for foo.bar. If globals is from a package's __init__.py,
Georg Brandl5f6861d2006-05-28 21:57:35 +00002123 the package's entry in sys.modules is returned, as a borrowed reference.
Fred Drake87590902004-05-28 20:21:36 +00002124
2125 The *name* of the returned package is returned in buf, with the length of
2126 the name in *p_buflen.
2127
2128 If globals doesn't come from a package or a module in a package, or a
2129 corresponding entry is not found in sys.modules, Py_None is returned.
2130*/
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002131static PyObject *
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002132get_parent(PyObject *globals, char *buf, Py_ssize_t *p_buflen, int level)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002133{
2134 static PyObject *namestr = NULL;
2135 static PyObject *pathstr = NULL;
Nick Coghlanef01d822007-12-03 12:55:17 +00002136 static PyObject *pkgstr = NULL;
2137 PyObject *pkgname, *modname, *modpath, *modules, *parent;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002138
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002139 if (globals == NULL || !PyDict_Check(globals) || !level)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002140 return Py_None;
2141
2142 if (namestr == NULL) {
2143 namestr = PyString_InternFromString("__name__");
2144 if (namestr == NULL)
2145 return NULL;
2146 }
2147 if (pathstr == NULL) {
2148 pathstr = PyString_InternFromString("__path__");
2149 if (pathstr == NULL)
2150 return NULL;
2151 }
Nick Coghlanef01d822007-12-03 12:55:17 +00002152 if (pkgstr == NULL) {
2153 pkgstr = PyString_InternFromString("__package__");
2154 if (pkgstr == NULL)
2155 return NULL;
2156 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002157
2158 *buf = '\0';
2159 *p_buflen = 0;
Nick Coghlanef01d822007-12-03 12:55:17 +00002160 pkgname = PyDict_GetItem(globals, pkgstr);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002161
Nick Coghlanef01d822007-12-03 12:55:17 +00002162 if ((pkgname != NULL) && (pkgname != Py_None)) {
2163 /* __package__ is set, so use it */
2164 Py_ssize_t len;
2165 if (!PyString_Check(pkgname)) {
2166 PyErr_SetString(PyExc_ValueError,
2167 "__package__ set to non-string");
2168 return NULL;
2169 }
2170 len = PyString_GET_SIZE(pkgname);
2171 if (len == 0) {
2172 if (level > 0) {
2173 PyErr_SetString(PyExc_ValueError,
2174 "Attempted relative import in non-package");
2175 return NULL;
2176 }
2177 return Py_None;
2178 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002179 if (len > MAXPATHLEN) {
2180 PyErr_SetString(PyExc_ValueError,
Nick Coghlanef01d822007-12-03 12:55:17 +00002181 "Package name too long");
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002182 return NULL;
2183 }
Nick Coghlanef01d822007-12-03 12:55:17 +00002184 strcpy(buf, PyString_AS_STRING(pkgname));
2185 } else {
2186 /* __package__ not set, so figure it out and set it */
2187 modname = PyDict_GetItem(globals, namestr);
2188 if (modname == NULL || !PyString_Check(modname))
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002189 return Py_None;
Nick Coghlanef01d822007-12-03 12:55:17 +00002190
2191 modpath = PyDict_GetItem(globals, pathstr);
2192 if (modpath != NULL) {
2193 /* __path__ is set, so modname is already the package name */
2194 Py_ssize_t len = PyString_GET_SIZE(modname);
2195 int error;
2196 if (len > MAXPATHLEN) {
2197 PyErr_SetString(PyExc_ValueError,
2198 "Module name too long");
2199 return NULL;
2200 }
2201 strcpy(buf, PyString_AS_STRING(modname));
2202 error = PyDict_SetItem(globals, pkgstr, modname);
2203 if (error) {
2204 PyErr_SetString(PyExc_ValueError,
2205 "Could not set __package__");
2206 return NULL;
2207 }
2208 } else {
2209 /* Normal module, so work out the package name if any */
2210 char *start = PyString_AS_STRING(modname);
2211 char *lastdot = strrchr(start, '.');
2212 size_t len;
2213 int error;
2214 if (lastdot == NULL && level > 0) {
2215 PyErr_SetString(PyExc_ValueError,
2216 "Attempted relative import in non-package");
2217 return NULL;
2218 }
2219 if (lastdot == NULL) {
2220 error = PyDict_SetItem(globals, pkgstr, Py_None);
2221 if (error) {
2222 PyErr_SetString(PyExc_ValueError,
2223 "Could not set __package__");
2224 return NULL;
2225 }
2226 return Py_None;
2227 }
2228 len = lastdot - start;
2229 if (len >= MAXPATHLEN) {
2230 PyErr_SetString(PyExc_ValueError,
2231 "Module name too long");
2232 return NULL;
2233 }
2234 strncpy(buf, start, len);
2235 buf[len] = '\0';
2236 pkgname = PyString_FromString(buf);
2237 if (pkgname == NULL) {
2238 return NULL;
2239 }
2240 error = PyDict_SetItem(globals, pkgstr, pkgname);
2241 Py_DECREF(pkgname);
2242 if (error) {
2243 PyErr_SetString(PyExc_ValueError,
2244 "Could not set __package__");
2245 return NULL;
2246 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002247 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002248 }
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002249 while (--level > 0) {
2250 char *dot = strrchr(buf, '.');
2251 if (dot == NULL) {
2252 PyErr_SetString(PyExc_ValueError,
Georg Brandl98775df2006-09-06 06:09:31 +00002253 "Attempted relative import beyond "
2254 "toplevel package");
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002255 return NULL;
2256 }
2257 *dot = '\0';
2258 }
2259 *p_buflen = strlen(buf);
2260
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002261 modules = PyImport_GetModuleDict();
2262 parent = PyDict_GetItemString(modules, buf);
2263 if (parent == NULL)
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002264 PyErr_Format(PyExc_SystemError,
2265 "Parent module '%.200s' not loaded", buf);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002266 return parent;
2267 /* We expect, but can't guarantee, if parent != None, that:
2268 - parent.__name__ == buf
2269 - parent.__dict__ is globals
2270 If this is violated... Who cares? */
2271}
2272
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002273/* altmod is either None or same as mod */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002274static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002275load_next(PyObject *mod, PyObject *altmod, char **p_name, char *buf,
Martin v. Löwis18e16552006-02-15 17:27:45 +00002276 Py_ssize_t *p_buflen)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002277{
2278 char *name = *p_name;
2279 char *dot = strchr(name, '.');
Fred Drake4c82b232000-06-30 16:18:57 +00002280 size_t len;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002281 char *p;
2282 PyObject *result;
2283
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002284 if (strlen(name) == 0) {
Thomas Wouters8ddab272006-04-04 16:17:02 +00002285 /* completely empty module name should only happen in
2286 'from . import' (or '__import__("")')*/
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002287 Py_INCREF(mod);
2288 *p_name = NULL;
2289 return mod;
2290 }
2291
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002292 if (dot == NULL) {
2293 *p_name = NULL;
2294 len = strlen(name);
2295 }
2296 else {
2297 *p_name = dot+1;
2298 len = dot-name;
2299 }
Guido van Rossum111c20b1998-04-11 17:38:22 +00002300 if (len == 0) {
2301 PyErr_SetString(PyExc_ValueError,
2302 "Empty module name");
2303 return NULL;
2304 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002305
2306 p = buf + *p_buflen;
2307 if (p != buf)
2308 *p++ = '.';
2309 if (p+len-buf >= MAXPATHLEN) {
2310 PyErr_SetString(PyExc_ValueError,
2311 "Module name too long");
2312 return NULL;
2313 }
2314 strncpy(p, name, len);
2315 p[len] = '\0';
2316 *p_buflen = p+len-buf;
2317
2318 result = import_submodule(mod, p, buf);
2319 if (result == Py_None && altmod != mod) {
2320 Py_DECREF(result);
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00002321 /* Here, altmod must be None and mod must not be None */
Guido van Rossum0c819451997-09-07 06:16:57 +00002322 result = import_submodule(altmod, p, p);
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00002323 if (result != NULL && result != Py_None) {
2324 if (mark_miss(buf) != 0) {
2325 Py_DECREF(result);
2326 return NULL;
2327 }
2328 strncpy(buf, name, len);
2329 buf[len] = '\0';
2330 *p_buflen = len;
2331 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002332 }
2333 if (result == NULL)
2334 return NULL;
2335
2336 if (result == Py_None) {
2337 Py_DECREF(result);
2338 PyErr_Format(PyExc_ImportError,
2339 "No module named %.200s", name);
2340 return NULL;
2341 }
2342
2343 return result;
2344}
2345
2346static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002347mark_miss(char *name)
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00002348{
2349 PyObject *modules = PyImport_GetModuleDict();
2350 return PyDict_SetItemString(modules, name, Py_None);
2351}
2352
2353static int
Martin v. Löwis18e16552006-02-15 17:27:45 +00002354ensure_fromlist(PyObject *mod, PyObject *fromlist, char *buf, Py_ssize_t buflen,
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002355 int recursive)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002356{
2357 int i;
2358
2359 if (!PyObject_HasAttrString(mod, "__path__"))
2360 return 1;
2361
2362 for (i = 0; ; i++) {
2363 PyObject *item = PySequence_GetItem(fromlist, i);
2364 int hasit;
2365 if (item == NULL) {
2366 if (PyErr_ExceptionMatches(PyExc_IndexError)) {
2367 PyErr_Clear();
2368 return 1;
2369 }
2370 return 0;
2371 }
2372 if (!PyString_Check(item)) {
2373 PyErr_SetString(PyExc_TypeError,
2374 "Item in ``from list'' not a string");
2375 Py_DECREF(item);
2376 return 0;
2377 }
2378 if (PyString_AS_STRING(item)[0] == '*') {
Guido van Rossum9905ef91997-09-08 16:07:11 +00002379 PyObject *all;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002380 Py_DECREF(item);
Guido van Rossum9905ef91997-09-08 16:07:11 +00002381 /* See if the package defines __all__ */
2382 if (recursive)
2383 continue; /* Avoid endless recursion */
2384 all = PyObject_GetAttrString(mod, "__all__");
2385 if (all == NULL)
2386 PyErr_Clear();
2387 else {
Martin v. Löwis83969ee2004-03-23 16:28:13 +00002388 int ret = ensure_fromlist(mod, all, buf, buflen, 1);
Guido van Rossum9905ef91997-09-08 16:07:11 +00002389 Py_DECREF(all);
Martin v. Löwis83969ee2004-03-23 16:28:13 +00002390 if (!ret)
2391 return 0;
Guido van Rossum9905ef91997-09-08 16:07:11 +00002392 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002393 continue;
2394 }
2395 hasit = PyObject_HasAttr(mod, item);
2396 if (!hasit) {
2397 char *subname = PyString_AS_STRING(item);
2398 PyObject *submod;
2399 char *p;
2400 if (buflen + strlen(subname) >= MAXPATHLEN) {
2401 PyErr_SetString(PyExc_ValueError,
2402 "Module name too long");
2403 Py_DECREF(item);
2404 return 0;
2405 }
2406 p = buf + buflen;
2407 *p++ = '.';
2408 strcpy(p, subname);
2409 submod = import_submodule(mod, subname, buf);
2410 Py_XDECREF(submod);
2411 if (submod == NULL) {
2412 Py_DECREF(item);
2413 return 0;
2414 }
2415 }
2416 Py_DECREF(item);
2417 }
2418
Guido van Rossuma7f2e811997-10-03 15:33:32 +00002419 /* NOTREACHED */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002420}
2421
Neil Schemenauer00b09662003-06-16 21:03:07 +00002422static int
2423add_submodule(PyObject *mod, PyObject *submod, char *fullname, char *subname,
2424 PyObject *modules)
2425{
2426 if (mod == Py_None)
2427 return 1;
2428 /* Irrespective of the success of this load, make a
2429 reference to it in the parent package module. A copy gets
2430 saved in the modules dictionary under the full name, so get a
2431 reference from there, if need be. (The exception is when the
2432 load failed with a SyntaxError -- then there's no trace in
2433 sys.modules. In that case, of course, do nothing extra.) */
2434 if (submod == NULL) {
2435 submod = PyDict_GetItemString(modules, fullname);
2436 if (submod == NULL)
2437 return 1;
2438 }
2439 if (PyModule_Check(mod)) {
2440 /* We can't use setattr here since it can give a
2441 * spurious warning if the submodule name shadows a
2442 * builtin name */
2443 PyObject *dict = PyModule_GetDict(mod);
2444 if (!dict)
2445 return 0;
2446 if (PyDict_SetItemString(dict, subname, submod) < 0)
2447 return 0;
2448 }
2449 else {
2450 if (PyObject_SetAttrString(mod, subname, submod) < 0)
2451 return 0;
2452 }
2453 return 1;
2454}
2455
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002456static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002457import_submodule(PyObject *mod, char *subname, char *fullname)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002458{
Guido van Rossum25ce5661997-08-02 03:10:38 +00002459 PyObject *modules = PyImport_GetModuleDict();
Neil Schemenauer00b09662003-06-16 21:03:07 +00002460 PyObject *m = NULL;
Guido van Rossum74e6a111994-08-29 12:54:38 +00002461
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002462 /* Require:
2463 if mod == None: subname == fullname
2464 else: mod.__name__ + "." + subname == fullname
2465 */
2466
Tim Peters50d8d372001-02-28 05:34:27 +00002467 if ((m = PyDict_GetItemString(modules, fullname)) != NULL) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00002468 Py_INCREF(m);
Guido van Rossum7f9fa971995-01-20 16:53:12 +00002469 }
2470 else {
Just van Rossum52e14d62002-12-30 22:08:05 +00002471 PyObject *path, *loader = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002472 char buf[MAXPATHLEN+1];
2473 struct filedescr *fdp;
2474 FILE *fp = NULL;
2475
Guido van Rossum9c0afe51998-05-19 15:09:05 +00002476 if (mod == Py_None)
2477 path = NULL;
2478 else {
2479 path = PyObject_GetAttrString(mod, "__path__");
2480 if (path == NULL) {
2481 PyErr_Clear();
2482 Py_INCREF(Py_None);
2483 return Py_None;
2484 }
2485 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002486
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002487 buf[0] = '\0';
Just van Rossum52e14d62002-12-30 22:08:05 +00002488 fdp = find_module(fullname, subname, path, buf, MAXPATHLEN+1,
2489 &fp, &loader);
Guido van Rossumb68cd421998-07-01 17:36:26 +00002490 Py_XDECREF(path);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002491 if (fdp == NULL) {
2492 if (!PyErr_ExceptionMatches(PyExc_ImportError))
2493 return NULL;
2494 PyErr_Clear();
2495 Py_INCREF(Py_None);
2496 return Py_None;
2497 }
Just van Rossum52e14d62002-12-30 22:08:05 +00002498 m = load_module(fullname, fp, buf, fdp->type, loader);
2499 Py_XDECREF(loader);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002500 if (fp)
2501 fclose(fp);
Neil Schemenauer00b09662003-06-16 21:03:07 +00002502 if (!add_submodule(mod, m, fullname, subname, modules)) {
2503 Py_XDECREF(m);
2504 m = NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002505 }
Guido van Rossum74e6a111994-08-29 12:54:38 +00002506 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002507
2508 return m;
Guido van Rossum74e6a111994-08-29 12:54:38 +00002509}
2510
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002511
2512/* Re-import a module of any kind and return its module object, WITH
2513 INCREMENTED REFERENCE COUNT */
2514
Guido van Rossum79f25d91997-04-29 20:08:16 +00002515PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002516PyImport_ReloadModule(PyObject *m)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002517{
Collin Winter47c52a82007-03-13 23:02:15 +00002518 PyInterpreterState *interp = PyThreadState_Get()->interp;
2519 PyObject *modules_reloading = interp->modules_reloading;
Guido van Rossum25ce5661997-08-02 03:10:38 +00002520 PyObject *modules = PyImport_GetModuleDict();
Collin Winter276887b2007-03-12 16:11:39 +00002521 PyObject *path = NULL, *loader = NULL, *existing_m = NULL;
Guido van Rossum222ef561997-09-06 19:41:09 +00002522 char *name, *subname;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002523 char buf[MAXPATHLEN+1];
2524 struct filedescr *fdp;
2525 FILE *fp = NULL;
Tim Peters1cd70172004-08-02 03:52:12 +00002526 PyObject *newm;
Collin Winter47c52a82007-03-13 23:02:15 +00002527
2528 if (modules_reloading == NULL) {
2529 Py_FatalError("PyImport_ReloadModule: "
Neal Norwitz2fca81c2007-05-30 04:53:41 +00002530 "no modules_reloading dictionary!");
Collin Winter47c52a82007-03-13 23:02:15 +00002531 return NULL;
2532 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002533
Guido van Rossum79f25d91997-04-29 20:08:16 +00002534 if (m == NULL || !PyModule_Check(m)) {
2535 PyErr_SetString(PyExc_TypeError,
2536 "reload() argument must be module");
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002537 return NULL;
2538 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002539 name = PyModule_GetName(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002540 if (name == NULL)
2541 return NULL;
Guido van Rossum25ce5661997-08-02 03:10:38 +00002542 if (m != PyDict_GetItemString(modules, name)) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002543 PyErr_Format(PyExc_ImportError,
2544 "reload(): module %.200s not in sys.modules",
2545 name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002546 return NULL;
2547 }
Neal Norwitz75c7c802007-03-13 05:31:38 +00002548 existing_m = PyDict_GetItemString(modules_reloading, name);
2549 if (existing_m != NULL) {
2550 /* Due to a recursive reload, this module is already
2551 being reloaded. */
2552 Py_INCREF(existing_m);
2553 return existing_m;
Collin Winter276887b2007-03-12 16:11:39 +00002554 }
Neal Norwitz75c7c802007-03-13 05:31:38 +00002555 if (PyDict_SetItemString(modules_reloading, name, m) < 0)
2556 return NULL;
Collin Winter276887b2007-03-12 16:11:39 +00002557
Guido van Rossum222ef561997-09-06 19:41:09 +00002558 subname = strrchr(name, '.');
2559 if (subname == NULL)
2560 subname = name;
2561 else {
2562 PyObject *parentname, *parent;
2563 parentname = PyString_FromStringAndSize(name, (subname-name));
Collin Winter276887b2007-03-12 16:11:39 +00002564 if (parentname == NULL) {
2565 imp_modules_reloading_clear();
Guido van Rossum222ef561997-09-06 19:41:09 +00002566 return NULL;
Neal Norwitz75c7c802007-03-13 05:31:38 +00002567 }
Guido van Rossum222ef561997-09-06 19:41:09 +00002568 parent = PyDict_GetItem(modules, parentname);
2569 if (parent == NULL) {
2570 PyErr_Format(PyExc_ImportError,
2571 "reload(): parent %.200s not in sys.modules",
Georg Brandl0c55f292005-09-14 06:56:20 +00002572 PyString_AS_STRING(parentname));
2573 Py_DECREF(parentname);
Neal Norwitz2fca81c2007-05-30 04:53:41 +00002574 imp_modules_reloading_clear();
Guido van Rossum222ef561997-09-06 19:41:09 +00002575 return NULL;
2576 }
Georg Brandl0c55f292005-09-14 06:56:20 +00002577 Py_DECREF(parentname);
Guido van Rossum222ef561997-09-06 19:41:09 +00002578 subname++;
2579 path = PyObject_GetAttrString(parent, "__path__");
2580 if (path == NULL)
2581 PyErr_Clear();
2582 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002583 buf[0] = '\0';
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00002584 fdp = find_module(name, subname, path, buf, MAXPATHLEN+1, &fp, &loader);
Guido van Rossum222ef561997-09-06 19:41:09 +00002585 Py_XDECREF(path);
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00002586
2587 if (fdp == NULL) {
2588 Py_XDECREF(loader);
Collin Winter276887b2007-03-12 16:11:39 +00002589 imp_modules_reloading_clear();
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002590 return NULL;
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00002591 }
2592
2593 newm = load_module(name, fp, buf, fdp->type, loader);
2594 Py_XDECREF(loader);
2595
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002596 if (fp)
2597 fclose(fp);
Tim Peters1cd70172004-08-02 03:52:12 +00002598 if (newm == NULL) {
2599 /* load_module probably removed name from modules because of
2600 * the error. Put back the original module object. We're
2601 * going to return NULL in this case regardless of whether
2602 * replacing name succeeds, so the return value is ignored.
2603 */
2604 PyDict_SetItemString(modules, name, m);
2605 }
Neal Norwitz75c7c802007-03-13 05:31:38 +00002606 imp_modules_reloading_clear();
Tim Peters1cd70172004-08-02 03:52:12 +00002607 return newm;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002608}
2609
2610
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002611/* Higher-level import emulator which emulates the "import" statement
2612 more accurately -- it invokes the __import__() function from the
2613 builtins of the current globals. This means that the import is
2614 done using whatever import hooks are installed in the current
Guido van Rossum6058eb41998-12-21 19:51:00 +00002615 environment, e.g. by "rexec".
2616 A dummy list ["__doc__"] is passed as the 4th argument so that
2617 e.g. PyImport_Import(PyString_FromString("win32com.client.gencache"))
2618 will return <module "gencache"> instead of <module "win32com">. */
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002619
2620PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002621PyImport_Import(PyObject *module_name)
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002622{
2623 static PyObject *silly_list = NULL;
2624 static PyObject *builtins_str = NULL;
2625 static PyObject *import_str = NULL;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002626 PyObject *globals = NULL;
2627 PyObject *import = NULL;
2628 PyObject *builtins = NULL;
2629 PyObject *r = NULL;
2630
2631 /* Initialize constant string objects */
2632 if (silly_list == NULL) {
2633 import_str = PyString_InternFromString("__import__");
2634 if (import_str == NULL)
2635 return NULL;
2636 builtins_str = PyString_InternFromString("__builtins__");
2637 if (builtins_str == NULL)
2638 return NULL;
2639 silly_list = Py_BuildValue("[s]", "__doc__");
2640 if (silly_list == NULL)
2641 return NULL;
2642 }
2643
2644 /* Get the builtins from current globals */
2645 globals = PyEval_GetGlobals();
Guido van Rossum85cd1d62001-02-20 21:43:24 +00002646 if (globals != NULL) {
Guido van Rossum66468561998-10-22 15:46:50 +00002647 Py_INCREF(globals);
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002648 builtins = PyObject_GetItem(globals, builtins_str);
2649 if (builtins == NULL)
2650 goto err;
2651 }
2652 else {
2653 /* No globals -- use standard builtins, and fake globals */
2654 PyErr_Clear();
2655
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002656 builtins = PyImport_ImportModuleLevel("__builtin__",
2657 NULL, NULL, NULL, 0);
Guido van Rossum85cd1d62001-02-20 21:43:24 +00002658 if (builtins == NULL)
2659 return NULL;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002660 globals = Py_BuildValue("{OO}", builtins_str, builtins);
2661 if (globals == NULL)
2662 goto err;
2663 }
2664
2665 /* Get the __import__ function from the builtins */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002666 if (PyDict_Check(builtins)) {
Fred Drakea76ba6e2001-03-06 06:31:15 +00002667 import = PyObject_GetItem(builtins, import_str);
Tim Peters6d6c1a32001-08-02 04:15:00 +00002668 if (import == NULL)
2669 PyErr_SetObject(PyExc_KeyError, import_str);
2670 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002671 else
Fred Drakea76ba6e2001-03-06 06:31:15 +00002672 import = PyObject_GetAttr(builtins, import_str);
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002673 if (import == NULL)
2674 goto err;
2675
Christian Heimes000a0742008-01-03 22:16:32 +00002676 /* Call the __import__ function with the proper argument list
2677 * Always use absolute import here. */
2678 r = PyObject_CallFunction(import, "OOOOi", module_name, globals,
2679 globals, silly_list, 0, NULL);
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002680
2681 err:
2682 Py_XDECREF(globals);
2683 Py_XDECREF(builtins);
2684 Py_XDECREF(import);
Tim Peters50d8d372001-02-28 05:34:27 +00002685
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002686 return r;
2687}
2688
2689
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002690/* Module 'imp' provides Python access to the primitives used for
2691 importing modules.
2692*/
2693
Guido van Rossum79f25d91997-04-29 20:08:16 +00002694static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +00002695imp_get_magic(PyObject *self, PyObject *noargs)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002696{
2697 char buf[4];
2698
Guido van Rossum96774c12000-05-01 20:19:08 +00002699 buf[0] = (char) ((pyc_magic >> 0) & 0xff);
2700 buf[1] = (char) ((pyc_magic >> 8) & 0xff);
2701 buf[2] = (char) ((pyc_magic >> 16) & 0xff);
2702 buf[3] = (char) ((pyc_magic >> 24) & 0xff);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002703
Guido van Rossum79f25d91997-04-29 20:08:16 +00002704 return PyString_FromStringAndSize(buf, 4);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002705}
2706
Guido van Rossum79f25d91997-04-29 20:08:16 +00002707static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +00002708imp_get_suffixes(PyObject *self, PyObject *noargs)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002709{
Guido van Rossum79f25d91997-04-29 20:08:16 +00002710 PyObject *list;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002711 struct filedescr *fdp;
2712
Guido van Rossum79f25d91997-04-29 20:08:16 +00002713 list = PyList_New(0);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002714 if (list == NULL)
2715 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002716 for (fdp = _PyImport_Filetab; fdp->suffix != NULL; fdp++) {
2717 PyObject *item = Py_BuildValue("ssi",
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002718 fdp->suffix, fdp->mode, fdp->type);
2719 if (item == NULL) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00002720 Py_DECREF(list);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002721 return NULL;
2722 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002723 if (PyList_Append(list, item) < 0) {
2724 Py_DECREF(list);
2725 Py_DECREF(item);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002726 return NULL;
2727 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002728 Py_DECREF(item);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002729 }
2730 return list;
2731}
2732
Guido van Rossum79f25d91997-04-29 20:08:16 +00002733static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002734call_find_module(char *name, PyObject *path)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002735{
Tim Petersdbd9ba62000-07-09 03:09:57 +00002736 extern int fclose(FILE *);
Guido van Rossum79f25d91997-04-29 20:08:16 +00002737 PyObject *fob, *ret;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002738 struct filedescr *fdp;
2739 char pathname[MAXPATHLEN+1];
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002740 FILE *fp = NULL;
2741
2742 pathname[0] = '\0';
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002743 if (path == Py_None)
2744 path = NULL;
Just van Rossum52e14d62002-12-30 22:08:05 +00002745 fdp = find_module(NULL, name, path, pathname, MAXPATHLEN+1, &fp, NULL);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002746 if (fdp == NULL)
2747 return NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002748 if (fp != NULL) {
2749 fob = PyFile_FromFile(fp, pathname, fdp->mode, fclose);
2750 if (fob == NULL) {
2751 fclose(fp);
2752 return NULL;
2753 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002754 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002755 else {
2756 fob = Py_None;
2757 Py_INCREF(fob);
Tim Peters50d8d372001-02-28 05:34:27 +00002758 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002759 ret = Py_BuildValue("Os(ssi)",
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002760 fob, pathname, fdp->suffix, fdp->mode, fdp->type);
Guido van Rossum79f25d91997-04-29 20:08:16 +00002761 Py_DECREF(fob);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002762 return ret;
2763}
2764
Guido van Rossum79f25d91997-04-29 20:08:16 +00002765static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002766imp_find_module(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002767{
2768 char *name;
2769 PyObject *path = NULL;
Guido van Rossum43713e52000-02-29 13:59:29 +00002770 if (!PyArg_ParseTuple(args, "s|O:find_module", &name, &path))
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002771 return NULL;
2772 return call_find_module(name, path);
2773}
2774
2775static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002776imp_init_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002777{
2778 char *name;
2779 int ret;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002780 PyObject *m;
Guido van Rossum43713e52000-02-29 13:59:29 +00002781 if (!PyArg_ParseTuple(args, "s:init_builtin", &name))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002782 return NULL;
2783 ret = init_builtin(name);
2784 if (ret < 0)
2785 return NULL;
2786 if (ret == 0) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00002787 Py_INCREF(Py_None);
2788 return Py_None;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002789 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002790 m = PyImport_AddModule(name);
2791 Py_XINCREF(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002792 return m;
2793}
2794
Guido van Rossum79f25d91997-04-29 20:08:16 +00002795static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002796imp_init_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002797{
2798 char *name;
2799 int ret;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002800 PyObject *m;
Guido van Rossum43713e52000-02-29 13:59:29 +00002801 if (!PyArg_ParseTuple(args, "s:init_frozen", &name))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002802 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002803 ret = PyImport_ImportFrozenModule(name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002804 if (ret < 0)
2805 return NULL;
2806 if (ret == 0) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00002807 Py_INCREF(Py_None);
2808 return Py_None;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002809 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002810 m = PyImport_AddModule(name);
2811 Py_XINCREF(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002812 return m;
2813}
2814
Guido van Rossum79f25d91997-04-29 20:08:16 +00002815static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002816imp_get_frozen_object(PyObject *self, PyObject *args)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002817{
2818 char *name;
Jack Jansen95ffa231995-10-03 14:38:41 +00002819
Guido van Rossum43713e52000-02-29 13:59:29 +00002820 if (!PyArg_ParseTuple(args, "s:get_frozen_object", &name))
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002821 return NULL;
2822 return get_frozen_object(name);
2823}
2824
Guido van Rossum79f25d91997-04-29 20:08:16 +00002825static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002826imp_is_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002827{
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002828 char *name;
Guido van Rossum43713e52000-02-29 13:59:29 +00002829 if (!PyArg_ParseTuple(args, "s:is_builtin", &name))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002830 return NULL;
Guido van Rossum50ee94f2002-04-09 18:00:58 +00002831 return PyInt_FromLong(is_builtin(name));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002832}
2833
Guido van Rossum79f25d91997-04-29 20:08:16 +00002834static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002835imp_is_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002836{
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002837 char *name;
Guido van Rossum323bf5e1998-06-24 03:54:06 +00002838 struct _frozen *p;
Guido van Rossum43713e52000-02-29 13:59:29 +00002839 if (!PyArg_ParseTuple(args, "s:is_frozen", &name))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002840 return NULL;
Guido van Rossum323bf5e1998-06-24 03:54:06 +00002841 p = find_frozen(name);
Guido van Rossumb8bff3f2002-04-07 06:34:38 +00002842 return PyBool_FromLong((long) (p == NULL ? 0 : p->size));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002843}
2844
2845static FILE *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002846get_file(char *pathname, PyObject *fob, char *mode)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002847{
2848 FILE *fp;
2849 if (fob == NULL) {
Tim Peters86c7d2f2004-08-01 23:24:21 +00002850 if (mode[0] == 'U')
Jeremy Hylton4ae6fae2002-05-30 17:15:25 +00002851 mode = "r" PY_STDIOTEXTMODE;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002852 fp = fopen(pathname, mode);
2853 if (fp == NULL)
Guido van Rossum79f25d91997-04-29 20:08:16 +00002854 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002855 }
2856 else {
Guido van Rossum79f25d91997-04-29 20:08:16 +00002857 fp = PyFile_AsFile(fob);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002858 if (fp == NULL)
Guido van Rossum79f25d91997-04-29 20:08:16 +00002859 PyErr_SetString(PyExc_ValueError,
2860 "bad/closed file object");
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002861 }
2862 return fp;
2863}
2864
Guido van Rossum79f25d91997-04-29 20:08:16 +00002865static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002866imp_load_compiled(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002867{
2868 char *name;
2869 char *pathname;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002870 PyObject *fob = NULL;
2871 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002872 FILE *fp;
Guido van Rossum43713e52000-02-29 13:59:29 +00002873 if (!PyArg_ParseTuple(args, "ss|O!:load_compiled", &name, &pathname,
Guido van Rossum79f25d91997-04-29 20:08:16 +00002874 &PyFile_Type, &fob))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002875 return NULL;
2876 fp = get_file(pathname, fob, "rb");
2877 if (fp == NULL)
2878 return NULL;
2879 m = load_compiled_module(name, pathname, fp);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002880 if (fob == NULL)
2881 fclose(fp);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002882 return m;
2883}
2884
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002885#ifdef HAVE_DYNAMIC_LOADING
2886
Guido van Rossum79f25d91997-04-29 20:08:16 +00002887static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002888imp_load_dynamic(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002889{
2890 char *name;
2891 char *pathname;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002892 PyObject *fob = NULL;
2893 PyObject *m;
Guido van Rossum7faeab31995-07-07 22:50:36 +00002894 FILE *fp = NULL;
Guido van Rossum43713e52000-02-29 13:59:29 +00002895 if (!PyArg_ParseTuple(args, "ss|O!:load_dynamic", &name, &pathname,
Guido van Rossum79f25d91997-04-29 20:08:16 +00002896 &PyFile_Type, &fob))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002897 return NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002898 if (fob) {
Guido van Rossum7faeab31995-07-07 22:50:36 +00002899 fp = get_file(pathname, fob, "r");
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002900 if (fp == NULL)
2901 return NULL;
2902 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002903 m = _PyImport_LoadDynamicModule(name, pathname, fp);
Guido van Rossum7faeab31995-07-07 22:50:36 +00002904 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002905}
2906
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002907#endif /* HAVE_DYNAMIC_LOADING */
2908
Guido van Rossum79f25d91997-04-29 20:08:16 +00002909static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002910imp_load_source(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002911{
2912 char *name;
2913 char *pathname;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002914 PyObject *fob = NULL;
2915 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002916 FILE *fp;
Guido van Rossum43713e52000-02-29 13:59:29 +00002917 if (!PyArg_ParseTuple(args, "ss|O!:load_source", &name, &pathname,
Guido van Rossum79f25d91997-04-29 20:08:16 +00002918 &PyFile_Type, &fob))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002919 return NULL;
2920 fp = get_file(pathname, fob, "r");
2921 if (fp == NULL)
2922 return NULL;
2923 m = load_source_module(name, pathname, fp);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002924 if (fob == NULL)
2925 fclose(fp);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002926 return m;
2927}
2928
Guido van Rossum79f25d91997-04-29 20:08:16 +00002929static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002930imp_load_module(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002931{
2932 char *name;
2933 PyObject *fob;
2934 char *pathname;
2935 char *suffix; /* Unused */
2936 char *mode;
2937 int type;
2938 FILE *fp;
2939
Guido van Rossum43713e52000-02-29 13:59:29 +00002940 if (!PyArg_ParseTuple(args, "sOs(ssi):load_module",
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002941 &name, &fob, &pathname,
2942 &suffix, &mode, &type))
2943 return NULL;
Guido van Rossum5e2c5fa2002-05-30 17:33:07 +00002944 if (*mode) {
2945 /* Mode must start with 'r' or 'U' and must not contain '+'.
2946 Implicit in this test is the assumption that the mode
2947 may contain other modifiers like 'b' or 't'. */
2948
2949 if (!(*mode == 'r' || *mode == 'U') || strchr(mode, '+')) {
Jeremy Hylton4ae6fae2002-05-30 17:15:25 +00002950 PyErr_Format(PyExc_ValueError,
2951 "invalid file open mode %.200s", mode);
2952 return NULL;
Guido van Rossum5e2c5fa2002-05-30 17:33:07 +00002953 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002954 }
2955 if (fob == Py_None)
2956 fp = NULL;
2957 else {
2958 if (!PyFile_Check(fob)) {
2959 PyErr_SetString(PyExc_ValueError,
2960 "load_module arg#2 should be a file or None");
2961 return NULL;
2962 }
2963 fp = get_file(pathname, fob, mode);
2964 if (fp == NULL)
2965 return NULL;
2966 }
Just van Rossum52e14d62002-12-30 22:08:05 +00002967 return load_module(name, fp, pathname, type, NULL);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002968}
2969
2970static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002971imp_load_package(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002972{
2973 char *name;
2974 char *pathname;
Guido van Rossum43713e52000-02-29 13:59:29 +00002975 if (!PyArg_ParseTuple(args, "ss:load_package", &name, &pathname))
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002976 return NULL;
2977 return load_package(name, pathname);
2978}
2979
2980static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002981imp_new_module(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002982{
2983 char *name;
Guido van Rossum43713e52000-02-29 13:59:29 +00002984 if (!PyArg_ParseTuple(args, "s:new_module", &name))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002985 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002986 return PyModule_New(name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002987}
2988
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002989/* Doc strings */
2990
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002991PyDoc_STRVAR(doc_imp,
2992"This module provides the components needed to build your own\n\
2993__import__ function. Undocumented functions are obsolete.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002994
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002995PyDoc_STRVAR(doc_find_module,
2996"find_module(name, [path]) -> (file, filename, (suffix, mode, type))\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002997Search for a module. If path is omitted or None, search for a\n\
2998built-in, frozen or special module and continue search in sys.path.\n\
2999The module name cannot contain '.'; to search for a submodule of a\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003000package, pass the submodule name and the package's __path__.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003001
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003002PyDoc_STRVAR(doc_load_module,
3003"load_module(name, file, filename, (suffix, mode, type)) -> module\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003004Load a module, given information returned by find_module().\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003005The module name must include the full package name, if any.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003006
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003007PyDoc_STRVAR(doc_get_magic,
3008"get_magic() -> string\n\
3009Return the magic number for .pyc or .pyo files.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003010
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003011PyDoc_STRVAR(doc_get_suffixes,
3012"get_suffixes() -> [(suffix, mode, type), ...]\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003013Return a list of (suffix, mode, type) tuples describing the files\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003014that find_module() looks for.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003015
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003016PyDoc_STRVAR(doc_new_module,
3017"new_module(name) -> module\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003018Create a new module. Do not enter it in sys.modules.\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003019The module name must include the full package name, if any.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003020
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003021PyDoc_STRVAR(doc_lock_held,
Tim Petersa7c65092004-08-01 23:26:05 +00003022"lock_held() -> boolean\n\
3023Return True if the import lock is currently held, else False.\n\
3024On platforms without threads, return False.");
Tim Peters69232342001-08-30 05:16:13 +00003025
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00003026PyDoc_STRVAR(doc_acquire_lock,
3027"acquire_lock() -> None\n\
Neal Norwitz2294c0d2003-02-12 23:02:21 +00003028Acquires the interpreter's import lock for the current thread.\n\
3029This lock should be used by import hooks to ensure thread-safety\n\
3030when importing modules.\n\
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00003031On platforms without threads, this function does nothing.");
3032
3033PyDoc_STRVAR(doc_release_lock,
3034"release_lock() -> None\n\
3035Release the interpreter's import lock.\n\
3036On platforms without threads, this function does nothing.");
3037
Guido van Rossum79f25d91997-04-29 20:08:16 +00003038static PyMethodDef imp_methods[] = {
Neal Norwitz08ea61a2003-02-17 18:18:00 +00003039 {"find_module", imp_find_module, METH_VARARGS, doc_find_module},
3040 {"get_magic", imp_get_magic, METH_NOARGS, doc_get_magic},
3041 {"get_suffixes", imp_get_suffixes, METH_NOARGS, doc_get_suffixes},
3042 {"load_module", imp_load_module, METH_VARARGS, doc_load_module},
3043 {"new_module", imp_new_module, METH_VARARGS, doc_new_module},
3044 {"lock_held", imp_lock_held, METH_NOARGS, doc_lock_held},
3045 {"acquire_lock", imp_acquire_lock, METH_NOARGS, doc_acquire_lock},
3046 {"release_lock", imp_release_lock, METH_NOARGS, doc_release_lock},
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003047 /* The rest are obsolete */
Neal Norwitz031829d2002-03-31 14:37:44 +00003048 {"get_frozen_object", imp_get_frozen_object, METH_VARARGS},
3049 {"init_builtin", imp_init_builtin, METH_VARARGS},
3050 {"init_frozen", imp_init_frozen, METH_VARARGS},
3051 {"is_builtin", imp_is_builtin, METH_VARARGS},
3052 {"is_frozen", imp_is_frozen, METH_VARARGS},
3053 {"load_compiled", imp_load_compiled, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003054#ifdef HAVE_DYNAMIC_LOADING
Neal Norwitz031829d2002-03-31 14:37:44 +00003055 {"load_dynamic", imp_load_dynamic, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003056#endif
Neal Norwitz031829d2002-03-31 14:37:44 +00003057 {"load_package", imp_load_package, METH_VARARGS},
Neal Norwitz031829d2002-03-31 14:37:44 +00003058 {"load_source", imp_load_source, METH_VARARGS},
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003059 {NULL, NULL} /* sentinel */
3060};
3061
Guido van Rossum1a8791e1998-08-04 22:46:29 +00003062static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003063setint(PyObject *d, char *name, int value)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003064{
3065 PyObject *v;
3066 int err;
3067
3068 v = PyInt_FromLong((long)value);
3069 err = PyDict_SetItemString(d, name, v);
3070 Py_XDECREF(v);
3071 return err;
3072}
3073
Phillip J. Ebyf7575d02006-07-28 21:12:07 +00003074typedef struct {
3075 PyObject_HEAD
3076} NullImporter;
3077
3078static int
3079NullImporter_init(NullImporter *self, PyObject *args, PyObject *kwds)
3080{
3081 char *path;
Christian Heimescea681b2007-11-07 17:50:54 +00003082 Py_ssize_t pathlen;
Phillip J. Ebyf7575d02006-07-28 21:12:07 +00003083
3084 if (!_PyArg_NoKeywords("NullImporter()", kwds))
3085 return -1;
3086
3087 if (!PyArg_ParseTuple(args, "s:NullImporter",
3088 &path))
3089 return -1;
3090
Christian Heimescea681b2007-11-07 17:50:54 +00003091 pathlen = strlen(path);
3092 if (pathlen == 0) {
Phillip J. Ebyf7575d02006-07-28 21:12:07 +00003093 PyErr_SetString(PyExc_ImportError, "empty pathname");
3094 return -1;
3095 } else {
3096#ifndef RISCOS
3097 struct stat statbuf;
3098 int rv;
3099
3100 rv = stat(path, &statbuf);
Christian Heimes004c1c12007-11-07 18:30:22 +00003101#ifdef MS_WINDOWS
3102 /* MS Windows stat() chokes on paths like C:\path\. Try to
3103 * recover *one* time by stripping off a trailing slash or
3104 * backslash. http://bugs.python.org/issue1293
3105 */
Christian Heimescea681b2007-11-07 17:50:54 +00003106 if (rv != 0 && pathlen <= MAXPATHLEN &&
3107 (path[pathlen-1] == '/' || path[pathlen-1] == '\\')) {
3108 char mangled[MAXPATHLEN+1];
3109
3110 strcpy(mangled, path);
3111 mangled[pathlen-1] = '\0';
3112 rv = stat(mangled, &statbuf);
3113 }
Christian Heimescea681b2007-11-07 17:50:54 +00003114#endif
Phillip J. Ebyf7575d02006-07-28 21:12:07 +00003115 if (rv == 0) {
3116 /* it exists */
3117 if (S_ISDIR(statbuf.st_mode)) {
3118 /* it's a directory */
3119 PyErr_SetString(PyExc_ImportError,
3120 "existing directory");
3121 return -1;
3122 }
3123 }
3124#else
3125 if (object_exists(path)) {
3126 /* it exists */
3127 if (isdir(path)) {
3128 /* it's a directory */
3129 PyErr_SetString(PyExc_ImportError,
3130 "existing directory");
3131 return -1;
3132 }
3133 }
3134#endif
3135 }
3136 return 0;
3137}
3138
3139static PyObject *
3140NullImporter_find_module(NullImporter *self, PyObject *args)
3141{
3142 Py_RETURN_NONE;
3143}
3144
3145static PyMethodDef NullImporter_methods[] = {
3146 {"find_module", (PyCFunction)NullImporter_find_module, METH_VARARGS,
3147 "Always return None"
3148 },
3149 {NULL} /* Sentinel */
3150};
3151
3152
Nick Coghlan327a39b2007-11-18 11:56:28 +00003153PyTypeObject PyNullImporter_Type = {
Martin v. Löwis68192102007-07-21 06:55:02 +00003154 PyVarObject_HEAD_INIT(NULL, 0)
Phillip J. Ebyf7575d02006-07-28 21:12:07 +00003155 "imp.NullImporter", /*tp_name*/
3156 sizeof(NullImporter), /*tp_basicsize*/
3157 0, /*tp_itemsize*/
3158 0, /*tp_dealloc*/
3159 0, /*tp_print*/
3160 0, /*tp_getattr*/
3161 0, /*tp_setattr*/
3162 0, /*tp_compare*/
3163 0, /*tp_repr*/
3164 0, /*tp_as_number*/
3165 0, /*tp_as_sequence*/
3166 0, /*tp_as_mapping*/
3167 0, /*tp_hash */
3168 0, /*tp_call*/
3169 0, /*tp_str*/
3170 0, /*tp_getattro*/
3171 0, /*tp_setattro*/
3172 0, /*tp_as_buffer*/
3173 Py_TPFLAGS_DEFAULT, /*tp_flags*/
3174 "Null importer object", /* tp_doc */
3175 0, /* tp_traverse */
3176 0, /* tp_clear */
3177 0, /* tp_richcompare */
3178 0, /* tp_weaklistoffset */
3179 0, /* tp_iter */
3180 0, /* tp_iternext */
3181 NullImporter_methods, /* tp_methods */
3182 0, /* tp_members */
3183 0, /* tp_getset */
3184 0, /* tp_base */
3185 0, /* tp_dict */
3186 0, /* tp_descr_get */
3187 0, /* tp_descr_set */
3188 0, /* tp_dictoffset */
3189 (initproc)NullImporter_init, /* tp_init */
3190 0, /* tp_alloc */
3191 PyType_GenericNew /* tp_new */
3192};
3193
3194
Jason Tishler6bc06ec2003-09-04 11:59:50 +00003195PyMODINIT_FUNC
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003196initimp(void)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003197{
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003198 PyObject *m, *d;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003199
Nick Coghlan327a39b2007-11-18 11:56:28 +00003200 if (PyType_Ready(&PyNullImporter_Type) < 0)
Phillip J. Ebyf7575d02006-07-28 21:12:07 +00003201 goto failure;
3202
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003203 m = Py_InitModule4("imp", imp_methods, doc_imp,
3204 NULL, PYTHON_API_VERSION);
Neal Norwitz1ac754f2006-01-19 06:09:39 +00003205 if (m == NULL)
3206 goto failure;
Guido van Rossum79f25d91997-04-29 20:08:16 +00003207 d = PyModule_GetDict(m);
Neal Norwitz3cb31ac2006-08-13 18:10:47 +00003208 if (d == NULL)
3209 goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003210
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003211 if (setint(d, "SEARCH_ERROR", SEARCH_ERROR) < 0) goto failure;
3212 if (setint(d, "PY_SOURCE", PY_SOURCE) < 0) goto failure;
3213 if (setint(d, "PY_COMPILED", PY_COMPILED) < 0) goto failure;
3214 if (setint(d, "C_EXTENSION", C_EXTENSION) < 0) goto failure;
3215 if (setint(d, "PY_RESOURCE", PY_RESOURCE) < 0) goto failure;
3216 if (setint(d, "PKG_DIRECTORY", PKG_DIRECTORY) < 0) goto failure;
3217 if (setint(d, "C_BUILTIN", C_BUILTIN) < 0) goto failure;
3218 if (setint(d, "PY_FROZEN", PY_FROZEN) < 0) goto failure;
Guido van Rossum0f84a341998-08-06 13:36:01 +00003219 if (setint(d, "PY_CODERESOURCE", PY_CODERESOURCE) < 0) goto failure;
Just van Rossum52e14d62002-12-30 22:08:05 +00003220 if (setint(d, "IMP_HOOK", IMP_HOOK) < 0) goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003221
Nick Coghlan327a39b2007-11-18 11:56:28 +00003222 Py_INCREF(&PyNullImporter_Type);
3223 PyModule_AddObject(m, "NullImporter", (PyObject *)&PyNullImporter_Type);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003224 failure:
3225 ;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003226}
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003227
3228
Guido van Rossumb18618d2000-05-03 23:44:39 +00003229/* API for embedding applications that want to add their own entries
3230 to the table of built-in modules. This should normally be called
3231 *before* Py_Initialize(). When the table resize fails, -1 is
3232 returned and the existing table is unchanged.
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003233
3234 After a similar function by Just van Rossum. */
3235
3236int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003237PyImport_ExtendInittab(struct _inittab *newtab)
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003238{
3239 static struct _inittab *our_copy = NULL;
3240 struct _inittab *p;
3241 int i, n;
3242
3243 /* Count the number of entries in both tables */
3244 for (n = 0; newtab[n].name != NULL; n++)
3245 ;
3246 if (n == 0)
3247 return 0; /* Nothing to do */
3248 for (i = 0; PyImport_Inittab[i].name != NULL; i++)
3249 ;
3250
3251 /* Allocate new memory for the combined table */
Guido van Rossumb18618d2000-05-03 23:44:39 +00003252 p = our_copy;
3253 PyMem_RESIZE(p, struct _inittab, i+n+1);
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003254 if (p == NULL)
3255 return -1;
3256
3257 /* Copy the tables into the new memory */
3258 if (our_copy != PyImport_Inittab)
3259 memcpy(p, PyImport_Inittab, (i+1) * sizeof(struct _inittab));
3260 PyImport_Inittab = our_copy = p;
3261 memcpy(p+i, newtab, (n+1) * sizeof(struct _inittab));
3262
3263 return 0;
3264}
3265
3266/* Shorthand to add a single entry given a name and a function */
3267
3268int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003269PyImport_AppendInittab(char *name, void (*initfunc)(void))
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003270{
3271 struct _inittab newtab[2];
3272
3273 memset(newtab, '\0', sizeof newtab);
3274
3275 newtab[0].name = name;
3276 newtab[0].initfunc = initfunc;
3277
3278 return PyImport_ExtendInittab(newtab);
3279}
Anthony Baxterac6bd462006-04-13 02:06:09 +00003280
3281#ifdef __cplusplus
3282}
3283#endif