blob: 7e3d2f4695276181458e1e36117dda798b1f76bf [file] [log] [blame]
Guido van Rossumf70e43a1991-02-19 12:39:46 +00001
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002/* Module definition and import implementation */
3
Guido van Rossum79f25d91997-04-29 20:08:16 +00004#include "Python.h"
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00005
Jeremy Hylton3e0055f2005-10-20 19:59:25 +00006#include "Python-ast.h"
Guido van Rossumd8faa362007-04-27 19:54:29 +00007#undef Yield /* undefine macro conflicting with winbase.h */
Neal Norwitzadb69fc2005-12-17 20:54:49 +00008#include "pyarena.h"
Jeremy Hylton3e0055f2005-10-20 19:59:25 +00009#include "pythonrun.h"
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000010#include "errcode.h"
Guido van Rossumc405b7b1991-06-04 19:39:42 +000011#include "marshal.h"
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000012#include "code.h"
Guido van Rossumc405b7b1991-06-04 19:39:42 +000013#include "compile.h"
Guido van Rossumff4949e1992-08-05 19:58:53 +000014#include "eval.h"
Guido van Rossumd8bac6d1992-02-26 15:19:13 +000015#include "osdefs.h"
Guido van Rossum1ae940a1995-01-02 19:04:15 +000016#include "importdl.h"
Guido van Rossumc405b7b1991-06-04 19:39:42 +000017
Guido van Rossum55a83382000-09-20 20:31:38 +000018#ifdef HAVE_FCNTL_H
19#include <fcntl.h>
20#endif
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000021#ifdef __cplusplus
22extern "C" {
23#endif
Guido van Rossum55a83382000-09-20 20:31:38 +000024
Thomas Woutersf70ef4f2000-07-22 18:47:25 +000025extern time_t PyOS_GetLastModificationTime(char *, FILE *);
26 /* In getmtime.c */
Guido van Rossum21d335e1993-10-15 13:01:11 +000027
Jeremy Hyltond4ceb312004-04-01 02:45:22 +000028/* Magic word to reject .pyc files generated by other Python versions.
29 It should change for each incompatible change to the bytecode.
30
31 The value of CR and LF is incorporated so if you ever read or write
Guido van Rossum7faeab31995-07-07 22:50:36 +000032 a .pyc file in text mode the magic number will be wrong; also, the
Tim Peters36515e22001-11-18 04:06:29 +000033 Apple MPW compiler swaps their values, botching string constants.
Marc-André Lemburgbd3be8f2002-02-07 11:33:49 +000034
Guido van Rossum45aecf42006-03-15 04:58:47 +000035 The magic numbers must be spaced apart at least 2 values, as the
Martin v. Löwisef82d2f2004-06-27 16:51:46 +000036 -U interpeter flag will cause MAGIC+1 being used. They have been
37 odd numbers for some time now.
Marc-André Lemburgbd3be8f2002-02-07 11:33:49 +000038
Jeremy Hyltond4ceb312004-04-01 02:45:22 +000039 There were a variety of old schemes for setting the magic number.
40 The current working scheme is to increment the previous value by
41 10.
Guido van Rossumf6894922002-08-31 15:16:14 +000042
Marc-André Lemburgbd3be8f2002-02-07 11:33:49 +000043 Known values:
44 Python 1.5: 20121
45 Python 1.5.1: 20121
46 Python 1.5.2: 20121
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000047 Python 1.6: 50428
Marc-André Lemburgbd3be8f2002-02-07 11:33:49 +000048 Python 2.0: 50823
49 Python 2.0.1: 50823
50 Python 2.1: 60202
51 Python 2.1.1: 60202
52 Python 2.1.2: 60202
53 Python 2.2: 60717
Neal Norwitz7fdcb412002-06-14 01:07:39 +000054 Python 2.3a0: 62011
Michael W. Hudsondd32a912002-08-15 14:59:02 +000055 Python 2.3a0: 62021
Guido van Rossumf6894922002-08-31 15:16:14 +000056 Python 2.3a0: 62011 (!)
Martin v. Löwisef82d2f2004-06-27 16:51:46 +000057 Python 2.4a0: 62041
Raymond Hettingerfd2d1f72004-08-23 23:37:48 +000058 Python 2.4a3: 62051
Raymond Hettinger2c31a052004-09-22 18:44:21 +000059 Python 2.4b1: 62061
Michael W. Hudsondf888462005-06-03 14:41:55 +000060 Python 2.5a0: 62071
Michael W. Hudsonaee2e282005-10-21 11:32:20 +000061 Python 2.5a0: 62081 (ast-branch)
Guido van Rossumc2e20742006-02-27 22:32:47 +000062 Python 2.5a0: 62091 (with)
Guido van Rossumf6694362006-03-10 02:28:35 +000063 Python 2.5a0: 62092 (changed WITH_CLEANUP opcode)
Thomas Wouters0e3f5912006-08-11 14:57:12 +000064 Python 2.5b3: 62101 (fix wrong code: for x, in ...)
65 Python 2.5b3: 62111 (fix wrong code: x += yield)
66 Python 2.5c1: 62121 (fix wrong lnotab with for loops and
67 storing constants that should have been removed)
Thomas Wouters89f507f2006-12-13 04:49:30 +000068 Python 2.5c2: 62131 (fix wrong code: for x, in ... in listcomp/genexp)
69 Python 2.6a0: 62141 (peephole optimizations)
Guido van Rossum45aecf42006-03-15 04:58:47 +000070 Python 3000: 3000
Brett Cannone2e23ef2006-08-25 05:05:30 +000071 3010 (removed UNARY_CONVERT)
Guido van Rossum86e58e22006-08-28 15:27:34 +000072 3020 (added BUILD_SET)
Guido van Rossum4f72a782006-10-27 23:31:49 +000073 3030 (added keyword-only parameters)
Guido van Rossum3203bdc2006-12-28 21:03:31 +000074 3040 (added signature annotations)
Guido van Rossum452bf512007-02-09 05:32:43 +000075 3050 (print becomes a function)
Guido van Rossum52cc1d82007-03-18 15:41:51 +000076 3060 (PEP 3115 metaclass syntax)
Michael W. Hudsonaee2e282005-10-21 11:32:20 +000077.
Tim Peters36515e22001-11-18 04:06:29 +000078*/
Guido van Rossum52cc1d82007-03-18 15:41:51 +000079#define MAGIC (3060 | ((long)'\r'<<16) | ((long)'\n'<<24))
Guido van Rossum3ddee711991-12-16 13:06:34 +000080
Guido van Rossum96774c12000-05-01 20:19:08 +000081/* Magic word as global; note that _PyImport_Init() can change the
Jeremy Hylton9262b8a2000-06-30 04:59:17 +000082 value of this global to accommodate for alterations of how the
Guido van Rossum96774c12000-05-01 20:19:08 +000083 compiler works which are enabled by command line switches. */
84static long pyc_magic = MAGIC;
85
Guido van Rossum25ce5661997-08-02 03:10:38 +000086/* See _PyImport_FixupExtension() below */
87static PyObject *extensions = NULL;
Guido van Rossum3f5da241990-12-20 15:06:42 +000088
Guido van Rossum771c6c81997-10-31 18:37:24 +000089/* This table is defined in config.c: */
90extern struct _inittab _PyImport_Inittab[];
91
92struct _inittab *PyImport_Inittab = _PyImport_Inittab;
Guido van Rossum66f1fa81991-04-03 19:03:52 +000093
Guido van Rossumed1170e1999-12-20 21:23:41 +000094/* these tables define the module suffixes that Python recognizes */
95struct filedescr * _PyImport_Filetab = NULL;
Guido van Rossum48a680c2001-03-02 06:34:14 +000096
97#ifdef RISCOS
98static const struct filedescr _PyImport_StandardFiletab[] = {
Jack Jansenc88da1f2002-05-28 10:58:19 +000099 {"/py", "U", PY_SOURCE},
Guido van Rossum48a680c2001-03-02 06:34:14 +0000100 {"/pyc", "rb", PY_COMPILED},
101 {0, 0}
102};
103#else
Guido van Rossumed1170e1999-12-20 21:23:41 +0000104static const struct filedescr _PyImport_StandardFiletab[] = {
Jack Jansenc88da1f2002-05-28 10:58:19 +0000105 {".py", "U", PY_SOURCE},
Martin v. Löwis6238d2b2002-06-30 15:26:10 +0000106#ifdef MS_WINDOWS
Jack Jansenc88da1f2002-05-28 10:58:19 +0000107 {".pyw", "U", PY_SOURCE},
Tim Peters36515e22001-11-18 04:06:29 +0000108#endif
Guido van Rossumed1170e1999-12-20 21:23:41 +0000109 {".pyc", "rb", PY_COMPILED},
110 {0, 0}
111};
Guido van Rossum48a680c2001-03-02 06:34:14 +0000112#endif
Guido van Rossumed1170e1999-12-20 21:23:41 +0000113
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000114static PyTypeObject NullImporterType; /* Forward reference */
115
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000116/* Initialize things */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000117
118void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000119_PyImport_Init(void)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000120{
Guido van Rossumed1170e1999-12-20 21:23:41 +0000121 const struct filedescr *scan;
122 struct filedescr *filetab;
123 int countD = 0;
124 int countS = 0;
125
126 /* prepare _PyImport_Filetab: copy entries from
127 _PyImport_DynLoadFiletab and _PyImport_StandardFiletab.
128 */
129 for (scan = _PyImport_DynLoadFiletab; scan->suffix != NULL; ++scan)
130 ++countD;
131 for (scan = _PyImport_StandardFiletab; scan->suffix != NULL; ++scan)
132 ++countS;
Guido van Rossumb18618d2000-05-03 23:44:39 +0000133 filetab = PyMem_NEW(struct filedescr, countD + countS + 1);
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000134 if (filetab == NULL)
135 Py_FatalError("Can't initialize import file table.");
Guido van Rossumed1170e1999-12-20 21:23:41 +0000136 memcpy(filetab, _PyImport_DynLoadFiletab,
137 countD * sizeof(struct filedescr));
138 memcpy(filetab + countD, _PyImport_StandardFiletab,
139 countS * sizeof(struct filedescr));
140 filetab[countD + countS].suffix = NULL;
141
142 _PyImport_Filetab = filetab;
143
Guido van Rossum0824f631997-03-11 18:37:35 +0000144 if (Py_OptimizeFlag) {
Guido van Rossumed1170e1999-12-20 21:23:41 +0000145 /* Replace ".pyc" with ".pyo" in _PyImport_Filetab */
146 for (; filetab->suffix != NULL; filetab++) {
Guido van Rossum48a680c2001-03-02 06:34:14 +0000147#ifndef RISCOS
Guido van Rossumed1170e1999-12-20 21:23:41 +0000148 if (strcmp(filetab->suffix, ".pyc") == 0)
149 filetab->suffix = ".pyo";
Guido van Rossum48a680c2001-03-02 06:34:14 +0000150#else
151 if (strcmp(filetab->suffix, "/pyc") == 0)
152 filetab->suffix = "/pyo";
153#endif
Guido van Rossum0824f631997-03-11 18:37:35 +0000154 }
155 }
Guido van Rossum96774c12000-05-01 20:19:08 +0000156
Guido van Rossum572dbf82007-04-27 23:53:51 +0000157 {
Guido van Rossum96774c12000-05-01 20:19:08 +0000158 /* Fix the pyc_magic so that byte compiled code created
159 using the all-Unicode method doesn't interfere with
160 code created in normal operation mode. */
161 pyc_magic = MAGIC + 1;
162 }
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000163}
164
Guido van Rossum25ce5661997-08-02 03:10:38 +0000165void
Just van Rossum52e14d62002-12-30 22:08:05 +0000166_PyImportHooks_Init(void)
167{
168 PyObject *v, *path_hooks = NULL, *zimpimport;
169 int err = 0;
170
171 /* adding sys.path_hooks and sys.path_importer_cache, setting up
172 zipimport */
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000173 if (PyType_Ready(&NullImporterType) < 0)
174 goto error;
Just van Rossum52e14d62002-12-30 22:08:05 +0000175
176 if (Py_VerboseFlag)
177 PySys_WriteStderr("# installing zipimport hook\n");
178
179 v = PyList_New(0);
180 if (v == NULL)
181 goto error;
182 err = PySys_SetObject("meta_path", v);
183 Py_DECREF(v);
184 if (err)
185 goto error;
186 v = PyDict_New();
187 if (v == NULL)
188 goto error;
189 err = PySys_SetObject("path_importer_cache", v);
190 Py_DECREF(v);
191 if (err)
192 goto error;
193 path_hooks = PyList_New(0);
194 if (path_hooks == NULL)
195 goto error;
196 err = PySys_SetObject("path_hooks", path_hooks);
197 if (err) {
198 error:
199 PyErr_Print();
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000200 Py_FatalError("initializing sys.meta_path, sys.path_hooks, "
201 "path_importer_cache, or NullImporter failed"
202 );
Just van Rossum52e14d62002-12-30 22:08:05 +0000203 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000204
Just van Rossum52e14d62002-12-30 22:08:05 +0000205 zimpimport = PyImport_ImportModule("zipimport");
206 if (zimpimport == NULL) {
207 PyErr_Clear(); /* No zip import module -- okay */
208 if (Py_VerboseFlag)
209 PySys_WriteStderr("# can't import zipimport\n");
210 }
211 else {
212 PyObject *zipimporter = PyObject_GetAttrString(zimpimport,
213 "zipimporter");
214 Py_DECREF(zimpimport);
215 if (zipimporter == NULL) {
216 PyErr_Clear(); /* No zipimporter object -- okay */
217 if (Py_VerboseFlag)
218 PySys_WriteStderr(
Fred Drake1e5fc552003-07-11 15:01:02 +0000219 "# can't import zipimport.zipimporter\n");
Just van Rossum52e14d62002-12-30 22:08:05 +0000220 }
221 else {
222 /* sys.path_hooks.append(zipimporter) */
223 err = PyList_Append(path_hooks, zipimporter);
224 Py_DECREF(zipimporter);
225 if (err)
226 goto error;
227 if (Py_VerboseFlag)
228 PySys_WriteStderr(
229 "# installed zipimport hook\n");
230 }
231 }
232 Py_DECREF(path_hooks);
233}
234
235void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000236_PyImport_Fini(void)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000237{
238 Py_XDECREF(extensions);
239 extensions = NULL;
Barry Warsaw84294482000-10-03 16:02:05 +0000240 PyMem_DEL(_PyImport_Filetab);
241 _PyImport_Filetab = NULL;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000242}
243
244
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000245/* Locking primitives to prevent parallel imports of the same module
246 in different threads to return with a partially loaded module.
247 These calls are serialized by the global interpreter lock. */
248
249#ifdef WITH_THREAD
250
Guido van Rossum49b56061998-10-01 20:42:43 +0000251#include "pythread.h"
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000252
Guido van Rossum65d5b571998-12-21 19:32:43 +0000253static PyThread_type_lock import_lock = 0;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000254static long import_lock_thread = -1;
255static int import_lock_level = 0;
256
257static void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000258lock_import(void)
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000259{
Guido van Rossum65d5b571998-12-21 19:32:43 +0000260 long me = PyThread_get_thread_ident();
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000261 if (me == -1)
262 return; /* Too bad */
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000263 if (import_lock == NULL) {
Guido van Rossum65d5b571998-12-21 19:32:43 +0000264 import_lock = PyThread_allocate_lock();
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000265 if (import_lock == NULL)
266 return; /* Nothing much we can do. */
267 }
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000268 if (import_lock_thread == me) {
269 import_lock_level++;
270 return;
271 }
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000272 if (import_lock_thread != -1 || !PyThread_acquire_lock(import_lock, 0))
273 {
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000274 PyThreadState *tstate = PyEval_SaveThread();
Guido van Rossum65d5b571998-12-21 19:32:43 +0000275 PyThread_acquire_lock(import_lock, 1);
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000276 PyEval_RestoreThread(tstate);
277 }
278 import_lock_thread = me;
279 import_lock_level = 1;
280}
281
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000282static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000283unlock_import(void)
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000284{
Guido van Rossum65d5b571998-12-21 19:32:43 +0000285 long me = PyThread_get_thread_ident();
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000286 if (me == -1 || import_lock == NULL)
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000287 return 0; /* Too bad */
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000288 if (import_lock_thread != me)
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000289 return -1;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000290 import_lock_level--;
291 if (import_lock_level == 0) {
292 import_lock_thread = -1;
Guido van Rossum65d5b571998-12-21 19:32:43 +0000293 PyThread_release_lock(import_lock);
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000294 }
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000295 return 1;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000296}
297
Guido van Rossum8ee3e5a2005-09-14 18:09:42 +0000298/* This function is called from PyOS_AfterFork to ensure that newly
299 created child processes do not share locks with the parent. */
300
301void
302_PyImport_ReInitLock(void)
303{
304#ifdef _AIX
305 if (import_lock != NULL)
306 import_lock = PyThread_allocate_lock();
307#endif
308}
309
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000310#else
311
312#define lock_import()
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000313#define unlock_import() 0
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000314
315#endif
316
Tim Peters69232342001-08-30 05:16:13 +0000317static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000318imp_lock_held(PyObject *self, PyObject *noargs)
Tim Peters69232342001-08-30 05:16:13 +0000319{
Tim Peters69232342001-08-30 05:16:13 +0000320#ifdef WITH_THREAD
Guido van Rossumb8bff3f2002-04-07 06:34:38 +0000321 return PyBool_FromLong(import_lock_thread != -1);
Tim Peters69232342001-08-30 05:16:13 +0000322#else
Guido van Rossumb8bff3f2002-04-07 06:34:38 +0000323 return PyBool_FromLong(0);
Tim Peters69232342001-08-30 05:16:13 +0000324#endif
325}
326
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000327static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000328imp_acquire_lock(PyObject *self, PyObject *noargs)
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000329{
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000330#ifdef WITH_THREAD
331 lock_import();
332#endif
Neal Norwitz2294c0d2003-02-12 23:02:21 +0000333 Py_INCREF(Py_None);
334 return Py_None;
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000335}
336
337static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000338imp_release_lock(PyObject *self, PyObject *noargs)
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000339{
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000340#ifdef WITH_THREAD
341 if (unlock_import() < 0) {
342 PyErr_SetString(PyExc_RuntimeError,
343 "not holding the import lock");
344 return NULL;
345 }
346#endif
Neal Norwitz2294c0d2003-02-12 23:02:21 +0000347 Py_INCREF(Py_None);
348 return Py_None;
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000349}
350
Guido van Rossumd8faa362007-04-27 19:54:29 +0000351static void
352imp_modules_reloading_clear(void)
353{
354 PyInterpreterState *interp = PyThreadState_Get()->interp;
355 if (interp->modules_reloading != NULL)
356 PyDict_Clear(interp->modules_reloading);
357}
358
Guido van Rossum25ce5661997-08-02 03:10:38 +0000359/* Helper for sys */
360
361PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000362PyImport_GetModuleDict(void)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000363{
Nicholas Bastine5662ae2004-03-24 22:22:12 +0000364 PyInterpreterState *interp = PyThreadState_GET()->interp;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000365 if (interp->modules == NULL)
366 Py_FatalError("PyImport_GetModuleDict: no module dictionary!");
367 return interp->modules;
368}
369
Guido van Rossum3f5da241990-12-20 15:06:42 +0000370
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000371/* List of names to clear in sys */
372static char* sys_deletes[] = {
Collin Winter670e6922007-03-21 02:57:17 +0000373 "path", "argv", "ps1", "ps2",
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000374 "exc_type", "exc_value", "exc_traceback",
375 "last_type", "last_value", "last_traceback",
Just van Rossum52e14d62002-12-30 22:08:05 +0000376 "path_hooks", "path_importer_cache", "meta_path",
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000377 NULL
378};
379
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000380static char* sys_files[] = {
381 "stdin", "__stdin__",
382 "stdout", "__stdout__",
383 "stderr", "__stderr__",
384 NULL
385};
386
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000387
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000388/* Un-initialize things, as good as we can */
Guido van Rossum3f5da241990-12-20 15:06:42 +0000389
Guido van Rossum3f5da241990-12-20 15:06:42 +0000390void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000391PyImport_Cleanup(void)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000392{
Martin v. Löwis18e16552006-02-15 17:27:45 +0000393 Py_ssize_t pos, ndone;
Guido van Rossum758eec01998-01-19 21:58:26 +0000394 char *name;
395 PyObject *key, *value, *dict;
Nicholas Bastine5662ae2004-03-24 22:22:12 +0000396 PyInterpreterState *interp = PyThreadState_GET()->interp;
Guido van Rossum758eec01998-01-19 21:58:26 +0000397 PyObject *modules = interp->modules;
398
399 if (modules == NULL)
400 return; /* Already done */
401
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000402 /* Delete some special variables first. These are common
403 places where user values hide and people complain when their
404 destructors fail. Since the modules containing them are
405 deleted *last* of all, they would come too late in the normal
406 destruction order. Sigh. */
407
408 value = PyDict_GetItemString(modules, "__builtin__");
409 if (value != NULL && PyModule_Check(value)) {
410 dict = PyModule_GetDict(value);
411 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000412 PySys_WriteStderr("# clear __builtin__._\n");
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000413 PyDict_SetItemString(dict, "_", Py_None);
414 }
415 value = PyDict_GetItemString(modules, "sys");
416 if (value != NULL && PyModule_Check(value)) {
417 char **p;
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000418 PyObject *v;
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000419 dict = PyModule_GetDict(value);
420 for (p = sys_deletes; *p != NULL; p++) {
421 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000422 PySys_WriteStderr("# clear sys.%s\n", *p);
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000423 PyDict_SetItemString(dict, *p, Py_None);
424 }
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000425 for (p = sys_files; *p != NULL; p+=2) {
426 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000427 PySys_WriteStderr("# restore sys.%s\n", *p);
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000428 v = PyDict_GetItemString(dict, *(p+1));
429 if (v == NULL)
430 v = Py_None;
431 PyDict_SetItemString(dict, *p, v);
432 }
433 }
434
435 /* First, delete __main__ */
436 value = PyDict_GetItemString(modules, "__main__");
437 if (value != NULL && PyModule_Check(value)) {
438 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000439 PySys_WriteStderr("# cleanup __main__\n");
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000440 _PyModule_Clear(value);
441 PyDict_SetItemString(modules, "__main__", Py_None);
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000442 }
443
Guido van Rossum758eec01998-01-19 21:58:26 +0000444 /* The special treatment of __builtin__ here is because even
445 when it's not referenced as a module, its dictionary is
446 referenced by almost every module's __builtins__. Since
447 deleting a module clears its dictionary (even if there are
448 references left to it), we need to delete the __builtin__
449 module last. Likewise, we don't delete sys until the very
450 end because it is implicitly referenced (e.g. by print).
451
452 Also note that we 'delete' modules by replacing their entry
453 in the modules dict with None, rather than really deleting
454 them; this avoids a rehash of the modules dictionary and
455 also marks them as "non existent" so they won't be
456 re-imported. */
457
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000458 /* Next, repeatedly delete modules with a reference count of
Guido van Rossum758eec01998-01-19 21:58:26 +0000459 one (skipping __builtin__ and sys) and delete them */
460 do {
461 ndone = 0;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000462 pos = 0;
Guido van Rossum758eec01998-01-19 21:58:26 +0000463 while (PyDict_Next(modules, &pos, &key, &value)) {
464 if (value->ob_refcnt != 1)
465 continue;
Guido van Rossum566373e1998-10-01 15:24:50 +0000466 if (PyString_Check(key) && PyModule_Check(value)) {
467 name = PyString_AS_STRING(key);
Guido van Rossum758eec01998-01-19 21:58:26 +0000468 if (strcmp(name, "__builtin__") == 0)
469 continue;
470 if (strcmp(name, "sys") == 0)
471 continue;
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000472 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000473 PySys_WriteStderr(
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000474 "# cleanup[1] %s\n", name);
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000475 _PyModule_Clear(value);
Guido van Rossum758eec01998-01-19 21:58:26 +0000476 PyDict_SetItem(modules, key, Py_None);
477 ndone++;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000478 }
479 }
Guido van Rossum758eec01998-01-19 21:58:26 +0000480 } while (ndone > 0);
481
Guido van Rossum758eec01998-01-19 21:58:26 +0000482 /* Next, delete all modules (still skipping __builtin__ and sys) */
483 pos = 0;
484 while (PyDict_Next(modules, &pos, &key, &value)) {
Guido van Rossum566373e1998-10-01 15:24:50 +0000485 if (PyString_Check(key) && PyModule_Check(value)) {
486 name = PyString_AS_STRING(key);
Guido van Rossum758eec01998-01-19 21:58:26 +0000487 if (strcmp(name, "__builtin__") == 0)
488 continue;
489 if (strcmp(name, "sys") == 0)
490 continue;
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000491 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000492 PySys_WriteStderr("# cleanup[2] %s\n", name);
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000493 _PyModule_Clear(value);
Guido van Rossum758eec01998-01-19 21:58:26 +0000494 PyDict_SetItem(modules, key, Py_None);
495 }
496 }
497
498 /* Next, delete sys and __builtin__ (in that order) */
499 value = PyDict_GetItemString(modules, "sys");
500 if (value != NULL && PyModule_Check(value)) {
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000501 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000502 PySys_WriteStderr("# cleanup sys\n");
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000503 _PyModule_Clear(value);
Guido van Rossum758eec01998-01-19 21:58:26 +0000504 PyDict_SetItemString(modules, "sys", Py_None);
505 }
506 value = PyDict_GetItemString(modules, "__builtin__");
507 if (value != NULL && PyModule_Check(value)) {
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000508 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000509 PySys_WriteStderr("# cleanup __builtin__\n");
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000510 _PyModule_Clear(value);
Guido van Rossum758eec01998-01-19 21:58:26 +0000511 PyDict_SetItemString(modules, "__builtin__", Py_None);
512 }
513
514 /* Finally, clear and delete the modules directory */
515 PyDict_Clear(modules);
516 interp->modules = NULL;
517 Py_DECREF(modules);
Guido van Rossumd8faa362007-04-27 19:54:29 +0000518 Py_CLEAR(interp->modules_reloading);
Guido van Rossum8d15b5d1990-10-26 14:58:58 +0000519}
Guido van Rossum7f133ed1991-02-19 12:23:57 +0000520
521
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000522/* Helper for pythonrun.c -- return magic number */
523
524long
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000525PyImport_GetMagicNumber(void)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000526{
Guido van Rossum96774c12000-05-01 20:19:08 +0000527 return pyc_magic;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000528}
529
530
Guido van Rossum25ce5661997-08-02 03:10:38 +0000531/* Magic for extension modules (built-in as well as dynamically
532 loaded). To prevent initializing an extension module more than
533 once, we keep a static dictionary 'extensions' keyed by module name
534 (for built-in modules) or by filename (for dynamically loaded
Barry Warsaw92883382001-08-13 23:05:44 +0000535 modules), containing these modules. A copy of the module's
Guido van Rossum25ce5661997-08-02 03:10:38 +0000536 dictionary is stored by calling _PyImport_FixupExtension()
537 immediately after the module initialization function succeeds. A
538 copy can be retrieved from there by calling
539 _PyImport_FindExtension(). */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000540
Guido van Rossum79f25d91997-04-29 20:08:16 +0000541PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000542_PyImport_FixupExtension(char *name, char *filename)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000543{
Guido van Rossum25ce5661997-08-02 03:10:38 +0000544 PyObject *modules, *mod, *dict, *copy;
545 if (extensions == NULL) {
546 extensions = PyDict_New();
547 if (extensions == NULL)
548 return NULL;
549 }
550 modules = PyImport_GetModuleDict();
551 mod = PyDict_GetItemString(modules, name);
552 if (mod == NULL || !PyModule_Check(mod)) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000553 PyErr_Format(PyExc_SystemError,
554 "_PyImport_FixupExtension: module %.200s not loaded", name);
Guido van Rossum25ce5661997-08-02 03:10:38 +0000555 return NULL;
556 }
557 dict = PyModule_GetDict(mod);
558 if (dict == NULL)
559 return NULL;
Fred Drake9cd0efc2001-10-25 21:38:59 +0000560 copy = PyDict_Copy(dict);
Guido van Rossum25ce5661997-08-02 03:10:38 +0000561 if (copy == NULL)
562 return NULL;
563 PyDict_SetItemString(extensions, filename, copy);
564 Py_DECREF(copy);
565 return copy;
566}
567
568PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000569_PyImport_FindExtension(char *name, char *filename)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000570{
Fred Drake9cd0efc2001-10-25 21:38:59 +0000571 PyObject *dict, *mod, *mdict;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000572 if (extensions == NULL)
573 return NULL;
574 dict = PyDict_GetItemString(extensions, filename);
575 if (dict == NULL)
576 return NULL;
577 mod = PyImport_AddModule(name);
578 if (mod == NULL)
579 return NULL;
580 mdict = PyModule_GetDict(mod);
581 if (mdict == NULL)
582 return NULL;
Fred Drake9cd0efc2001-10-25 21:38:59 +0000583 if (PyDict_Update(mdict, dict))
Guido van Rossum25ce5661997-08-02 03:10:38 +0000584 return NULL;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000585 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000586 PySys_WriteStderr("import %s # previously loaded (%s)\n",
Guido van Rossum25ce5661997-08-02 03:10:38 +0000587 name, filename);
588 return mod;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000589}
590
591
592/* Get the module object corresponding to a module name.
593 First check the modules dictionary if there's one there,
Walter Dörwaldf0dfc7a2003-10-20 14:01:56 +0000594 if not, create a new one and insert it in the modules dictionary.
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000595 Because the former action is most common, THIS DOES NOT RETURN A
596 'NEW' REFERENCE! */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000597
Guido van Rossum79f25d91997-04-29 20:08:16 +0000598PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000599PyImport_AddModule(const char *name)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000600{
Guido van Rossum25ce5661997-08-02 03:10:38 +0000601 PyObject *modules = PyImport_GetModuleDict();
Guido van Rossum79f25d91997-04-29 20:08:16 +0000602 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000603
Guido van Rossum25ce5661997-08-02 03:10:38 +0000604 if ((m = PyDict_GetItemString(modules, name)) != NULL &&
Guido van Rossum79f25d91997-04-29 20:08:16 +0000605 PyModule_Check(m))
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000606 return m;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000607 m = PyModule_New(name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000608 if (m == NULL)
609 return NULL;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000610 if (PyDict_SetItemString(modules, name, m) != 0) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000611 Py_DECREF(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000612 return NULL;
613 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000614 Py_DECREF(m); /* Yes, it still exists, in modules! */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000615
616 return m;
617}
618
Tim Peters1cd70172004-08-02 03:52:12 +0000619/* Remove name from sys.modules, if it's there. */
620static void
621_RemoveModule(const char *name)
622{
623 PyObject *modules = PyImport_GetModuleDict();
624 if (PyDict_GetItemString(modules, name) == NULL)
625 return;
626 if (PyDict_DelItemString(modules, name) < 0)
627 Py_FatalError("import: deleting existing key in"
628 "sys.modules failed");
629}
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000630
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000631/* Execute a code object in a module and return the module object
Tim Peters1cd70172004-08-02 03:52:12 +0000632 * WITH INCREMENTED REFERENCE COUNT. If an error occurs, name is
633 * removed from sys.modules, to avoid leaving damaged module objects
634 * in sys.modules. The caller may wish to restore the original
635 * module object (if any) in this case; PyImport_ReloadModule is an
636 * example.
637 */
Guido van Rossum79f25d91997-04-29 20:08:16 +0000638PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000639PyImport_ExecCodeModule(char *name, PyObject *co)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000640{
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000641 return PyImport_ExecCodeModuleEx(name, co, (char *)NULL);
642}
643
644PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000645PyImport_ExecCodeModuleEx(char *name, PyObject *co, char *pathname)
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000646{
Guido van Rossum25ce5661997-08-02 03:10:38 +0000647 PyObject *modules = PyImport_GetModuleDict();
Guido van Rossum79f25d91997-04-29 20:08:16 +0000648 PyObject *m, *d, *v;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000649
Guido van Rossum79f25d91997-04-29 20:08:16 +0000650 m = PyImport_AddModule(name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000651 if (m == NULL)
652 return NULL;
Jeremy Hyltonecd91292004-01-02 23:25:32 +0000653 /* If the module is being reloaded, we get the old module back
654 and re-use its dict to exec the new code. */
Guido van Rossum79f25d91997-04-29 20:08:16 +0000655 d = PyModule_GetDict(m);
656 if (PyDict_GetItemString(d, "__builtins__") == NULL) {
657 if (PyDict_SetItemString(d, "__builtins__",
658 PyEval_GetBuiltins()) != 0)
Tim Peters1cd70172004-08-02 03:52:12 +0000659 goto error;
Guido van Rossum6135a871995-01-09 17:53:26 +0000660 }
Guido van Rossum9c9a07c1996-05-16 20:43:40 +0000661 /* Remember the filename as the __file__ attribute */
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000662 v = NULL;
663 if (pathname != NULL) {
664 v = PyString_FromString(pathname);
665 if (v == NULL)
666 PyErr_Clear();
667 }
668 if (v == NULL) {
669 v = ((PyCodeObject *)co)->co_filename;
670 Py_INCREF(v);
671 }
672 if (PyDict_SetItemString(d, "__file__", v) != 0)
Guido van Rossum79f25d91997-04-29 20:08:16 +0000673 PyErr_Clear(); /* Not important enough to report */
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000674 Py_DECREF(v);
675
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000676 v = PyEval_EvalCode((PyCodeObject *)co, d, d);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000677 if (v == NULL)
Tim Peters1cd70172004-08-02 03:52:12 +0000678 goto error;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000679 Py_DECREF(v);
Guido van Rossumb65e85c1997-07-10 18:00:45 +0000680
Guido van Rossum25ce5661997-08-02 03:10:38 +0000681 if ((m = PyDict_GetItemString(modules, name)) == NULL) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000682 PyErr_Format(PyExc_ImportError,
683 "Loaded module %.200s not found in sys.modules",
684 name);
Guido van Rossumb65e85c1997-07-10 18:00:45 +0000685 return NULL;
686 }
687
Guido van Rossum79f25d91997-04-29 20:08:16 +0000688 Py_INCREF(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000689
690 return m;
Tim Peters1cd70172004-08-02 03:52:12 +0000691
692 error:
693 _RemoveModule(name);
694 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000695}
696
697
698/* Given a pathname for a Python source file, fill a buffer with the
699 pathname for the corresponding compiled file. Return the pathname
700 for the compiled file, or NULL if there's no space in the buffer.
701 Doesn't set an exception. */
702
703static char *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000704make_compiled_pathname(char *pathname, char *buf, size_t buflen)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000705{
Tim Petersc1731372001-08-04 08:12:36 +0000706 size_t len = strlen(pathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000707 if (len+2 > buflen)
708 return NULL;
Tim Petersc1731372001-08-04 08:12:36 +0000709
Martin v. Löwis6238d2b2002-06-30 15:26:10 +0000710#ifdef MS_WINDOWS
Tim Petersc1731372001-08-04 08:12:36 +0000711 /* Treat .pyw as if it were .py. The case of ".pyw" must match
712 that used in _PyImport_StandardFiletab. */
713 if (len >= 4 && strcmp(&pathname[len-4], ".pyw") == 0)
714 --len; /* pretend 'w' isn't there */
715#endif
716 memcpy(buf, pathname, len);
717 buf[len] = Py_OptimizeFlag ? 'o' : 'c';
718 buf[len+1] = '\0';
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000719
720 return buf;
721}
722
723
724/* Given a pathname for a Python source file, its time of last
725 modification, and a pathname for a compiled file, check whether the
726 compiled file represents the same version of the source. If so,
727 return a FILE pointer for the compiled file, positioned just after
728 the header; if not, return NULL.
729 Doesn't set an exception. */
730
731static FILE *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000732check_compiled_module(char *pathname, time_t mtime, char *cpathname)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000733{
734 FILE *fp;
735 long magic;
736 long pyc_mtime;
737
738 fp = fopen(cpathname, "rb");
739 if (fp == NULL)
740 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000741 magic = PyMarshal_ReadLongFromFile(fp);
Guido van Rossum96774c12000-05-01 20:19:08 +0000742 if (magic != pyc_magic) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000743 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000744 PySys_WriteStderr("# %s has bad magic\n", cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000745 fclose(fp);
746 return NULL;
747 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000748 pyc_mtime = PyMarshal_ReadLongFromFile(fp);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000749 if (pyc_mtime != mtime) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000750 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000751 PySys_WriteStderr("# %s has bad mtime\n", cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000752 fclose(fp);
753 return NULL;
754 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000755 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000756 PySys_WriteStderr("# %s matches %s\n", cpathname, pathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000757 return fp;
758}
759
760
761/* Read a code object from a file and check it for validity */
762
Guido van Rossum79f25d91997-04-29 20:08:16 +0000763static PyCodeObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000764read_compiled_module(char *cpathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000765{
Guido van Rossum79f25d91997-04-29 20:08:16 +0000766 PyObject *co;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000767
Tim Petersd9b9ac82001-01-28 00:27:39 +0000768 co = PyMarshal_ReadLastObjectFromFile(fp);
Armin Rigo01ab2792004-03-26 15:09:27 +0000769 if (co == NULL)
770 return NULL;
771 if (!PyCode_Check(co)) {
772 PyErr_Format(PyExc_ImportError,
773 "Non-code object in %.200s", cpathname);
774 Py_DECREF(co);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000775 return NULL;
776 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000777 return (PyCodeObject *)co;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000778}
779
780
781/* Load a module from a compiled file, execute it, and return its
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000782 module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000783
Guido van Rossum79f25d91997-04-29 20:08:16 +0000784static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000785load_compiled_module(char *name, char *cpathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000786{
787 long magic;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000788 PyCodeObject *co;
789 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000790
Guido van Rossum79f25d91997-04-29 20:08:16 +0000791 magic = PyMarshal_ReadLongFromFile(fp);
Guido van Rossum96774c12000-05-01 20:19:08 +0000792 if (magic != pyc_magic) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000793 PyErr_Format(PyExc_ImportError,
794 "Bad magic number in %.200s", cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000795 return NULL;
796 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000797 (void) PyMarshal_ReadLongFromFile(fp);
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000798 co = read_compiled_module(cpathname, fp);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000799 if (co == NULL)
800 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000801 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000802 PySys_WriteStderr("import %s # precompiled from %s\n",
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000803 name, cpathname);
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000804 m = PyImport_ExecCodeModuleEx(name, (PyObject *)co, cpathname);
Guido van Rossum79f25d91997-04-29 20:08:16 +0000805 Py_DECREF(co);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000806
807 return m;
808}
809
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000810/* Parse a source file and return the corresponding code object */
811
Guido van Rossum79f25d91997-04-29 20:08:16 +0000812static PyCodeObject *
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000813parse_source_module(const char *pathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000814{
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000815 PyCodeObject *co = NULL;
816 mod_ty mod;
Thomas Wouters89f507f2006-12-13 04:49:30 +0000817 PyArena *arena = PyArena_New();
818 if (arena == NULL)
819 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000820
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000821 mod = PyParser_ASTFromFile(fp, pathname, Py_file_input, 0, 0, 0,
Neal Norwitzadb69fc2005-12-17 20:54:49 +0000822 NULL, arena);
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000823 if (mod) {
Neal Norwitzadb69fc2005-12-17 20:54:49 +0000824 co = PyAST_Compile(mod, pathname, NULL, arena);
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000825 }
Thomas Wouters89f507f2006-12-13 04:49:30 +0000826 PyArena_Free(arena);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000827 return co;
828}
829
830
Guido van Rossum55a83382000-09-20 20:31:38 +0000831/* Helper to open a bytecode file for writing in exclusive mode */
832
833static FILE *
834open_exclusive(char *filename)
835{
836#if defined(O_EXCL)&&defined(O_CREAT)&&defined(O_WRONLY)&&defined(O_TRUNC)
837 /* Use O_EXCL to avoid a race condition when another process tries to
838 write the same file. When that happens, our open() call fails,
839 which is just fine (since it's only a cache).
840 XXX If the file exists and is writable but the directory is not
841 writable, the file will never be written. Oh well.
842 */
843 int fd;
844 (void) unlink(filename);
Tim Peters42c83af2000-09-29 04:03:10 +0000845 fd = open(filename, O_EXCL|O_CREAT|O_WRONLY|O_TRUNC
846#ifdef O_BINARY
847 |O_BINARY /* necessary for Windows */
848#endif
Martin v. Löwis79acb9e2002-12-06 12:48:53 +0000849#ifdef __VMS
Martin v. Löwis18e16552006-02-15 17:27:45 +0000850 , 0666, "ctxt=bin", "shr=nil"
Martin v. Löwis79acb9e2002-12-06 12:48:53 +0000851#else
Martin v. Löwis18e16552006-02-15 17:27:45 +0000852 , 0666
Martin v. Löwis79acb9e2002-12-06 12:48:53 +0000853#endif
Martin v. Löwis18e16552006-02-15 17:27:45 +0000854 );
Guido van Rossum55a83382000-09-20 20:31:38 +0000855 if (fd < 0)
856 return NULL;
857 return fdopen(fd, "wb");
858#else
859 /* Best we can do -- on Windows this can't happen anyway */
860 return fopen(filename, "wb");
861#endif
862}
863
864
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000865/* Write a compiled module to a file, placing the time of last
866 modification of its source into the header.
867 Errors are ignored, if a write error occurs an attempt is made to
868 remove the file. */
869
870static void
Martin v. Löwis18e16552006-02-15 17:27:45 +0000871write_compiled_module(PyCodeObject *co, char *cpathname, time_t mtime)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000872{
873 FILE *fp;
874
Guido van Rossum55a83382000-09-20 20:31:38 +0000875 fp = open_exclusive(cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000876 if (fp == NULL) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000877 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000878 PySys_WriteStderr(
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000879 "# can't create %s\n", cpathname);
880 return;
881 }
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000882 PyMarshal_WriteLongToFile(pyc_magic, fp, Py_MARSHAL_VERSION);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000883 /* First write a 0 for mtime */
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000884 PyMarshal_WriteLongToFile(0L, fp, Py_MARSHAL_VERSION);
885 PyMarshal_WriteObjectToFile((PyObject *)co, fp, Py_MARSHAL_VERSION);
Armin Rigo01ab2792004-03-26 15:09:27 +0000886 if (fflush(fp) != 0 || ferror(fp)) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000887 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000888 PySys_WriteStderr("# can't write %s\n", cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000889 /* Don't keep partial file */
890 fclose(fp);
891 (void) unlink(cpathname);
892 return;
893 }
894 /* Now write the true mtime */
895 fseek(fp, 4L, 0);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000896 assert(mtime < LONG_MAX);
Martin v. Löwis725507b2006-03-07 12:08:51 +0000897 PyMarshal_WriteLongToFile((long)mtime, fp, Py_MARSHAL_VERSION);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000898 fflush(fp);
899 fclose(fp);
Guido van Rossum79f25d91997-04-29 20:08:16 +0000900 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000901 PySys_WriteStderr("# wrote %s\n", cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000902}
903
904
905/* Load a source module from a given file and return its module
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000906 object WITH INCREMENTED REFERENCE COUNT. If there's a matching
907 byte-compiled file, use that instead. */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000908
Guido van Rossum79f25d91997-04-29 20:08:16 +0000909static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000910load_source_module(char *name, char *pathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000911{
Fred Drake4c82b232000-06-30 16:18:57 +0000912 time_t mtime;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000913 FILE *fpc;
914 char buf[MAXPATHLEN+1];
915 char *cpathname;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000916 PyCodeObject *co;
917 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000918
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000919 mtime = PyOS_GetLastModificationTime(pathname, fp);
Neal Norwitz708e51a2005-10-03 04:48:15 +0000920 if (mtime == (time_t)(-1)) {
921 PyErr_Format(PyExc_RuntimeError,
922 "unable to get modification time from '%s'",
923 pathname);
Fred Drake4c82b232000-06-30 16:18:57 +0000924 return NULL;
Neal Norwitz708e51a2005-10-03 04:48:15 +0000925 }
Fred Drake4c82b232000-06-30 16:18:57 +0000926#if SIZEOF_TIME_T > 4
927 /* Python's .pyc timestamp handling presumes that the timestamp fits
928 in 4 bytes. This will be fine until sometime in the year 2038,
929 when a 4-byte signed time_t will overflow.
930 */
931 if (mtime >> 32) {
932 PyErr_SetString(PyExc_OverflowError,
Fred Drakec63d3e92001-03-01 06:33:32 +0000933 "modification time overflows a 4 byte field");
Fred Drake4c82b232000-06-30 16:18:57 +0000934 return NULL;
935 }
936#endif
Tim Peters36515e22001-11-18 04:06:29 +0000937 cpathname = make_compiled_pathname(pathname, buf,
Jeremy Hylton37832f02001-04-13 17:50:20 +0000938 (size_t)MAXPATHLEN + 1);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000939 if (cpathname != NULL &&
940 (fpc = check_compiled_module(pathname, mtime, cpathname))) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000941 co = read_compiled_module(cpathname, fpc);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000942 fclose(fpc);
943 if (co == NULL)
944 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000945 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000946 PySys_WriteStderr("import %s # precompiled from %s\n",
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000947 name, cpathname);
Guido van Rossumafd3dae1998-08-25 18:44:34 +0000948 pathname = cpathname;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000949 }
950 else {
951 co = parse_source_module(pathname, fp);
952 if (co == NULL)
953 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000954 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000955 PySys_WriteStderr("import %s # from %s\n",
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000956 name, pathname);
Thomas Wouters00ee7ba2006-08-21 19:07:27 +0000957 if (cpathname)
958 write_compiled_module(co, cpathname, mtime);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000959 }
Guido van Rossumafd3dae1998-08-25 18:44:34 +0000960 m = PyImport_ExecCodeModuleEx(name, (PyObject *)co, pathname);
Guido van Rossum79f25d91997-04-29 20:08:16 +0000961 Py_DECREF(co);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000962
963 return m;
964}
965
966
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000967/* Forward */
Just van Rossum52e14d62002-12-30 22:08:05 +0000968static PyObject *load_module(char *, FILE *, char *, int, PyObject *);
969static struct filedescr *find_module(char *, char *, PyObject *,
970 char *, size_t, FILE **, PyObject **);
Tim Petersdbd9ba62000-07-09 03:09:57 +0000971static struct _frozen *find_frozen(char *name);
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000972
973/* Load a package and return its module object WITH INCREMENTED
974 REFERENCE COUNT */
975
976static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000977load_package(char *name, char *pathname)
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000978{
Tim Peters1cd70172004-08-02 03:52:12 +0000979 PyObject *m, *d;
980 PyObject *file = NULL;
981 PyObject *path = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000982 int err;
983 char buf[MAXPATHLEN+1];
984 FILE *fp = NULL;
985 struct filedescr *fdp;
986
987 m = PyImport_AddModule(name);
988 if (m == NULL)
989 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +0000990 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000991 PySys_WriteStderr("import %s # directory %s\n",
Guido van Rossum17fc85f1997-09-06 18:52:03 +0000992 name, pathname);
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000993 d = PyModule_GetDict(m);
994 file = PyString_FromString(pathname);
995 if (file == NULL)
Tim Peters1cd70172004-08-02 03:52:12 +0000996 goto error;
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000997 path = Py_BuildValue("[O]", file);
Tim Peters1cd70172004-08-02 03:52:12 +0000998 if (path == NULL)
999 goto error;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001000 err = PyDict_SetItemString(d, "__file__", file);
1001 if (err == 0)
1002 err = PyDict_SetItemString(d, "__path__", path);
Tim Peters1cd70172004-08-02 03:52:12 +00001003 if (err != 0)
1004 goto error;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001005 buf[0] = '\0';
Just van Rossum52e14d62002-12-30 22:08:05 +00001006 fdp = find_module(name, "__init__", path, buf, sizeof(buf), &fp, NULL);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001007 if (fdp == NULL) {
1008 if (PyErr_ExceptionMatches(PyExc_ImportError)) {
1009 PyErr_Clear();
Thomas Heller25653242004-06-07 15:04:10 +00001010 Py_INCREF(m);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001011 }
1012 else
1013 m = NULL;
1014 goto cleanup;
1015 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001016 m = load_module(name, fp, buf, fdp->type, NULL);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001017 if (fp != NULL)
1018 fclose(fp);
Tim Peters1cd70172004-08-02 03:52:12 +00001019 goto cleanup;
1020
1021 error:
1022 m = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001023 cleanup:
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001024 Py_XDECREF(path);
1025 Py_XDECREF(file);
1026 return m;
1027}
1028
1029
1030/* Helper to test for built-in module */
1031
1032static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001033is_builtin(char *name)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001034{
1035 int i;
Guido van Rossum771c6c81997-10-31 18:37:24 +00001036 for (i = 0; PyImport_Inittab[i].name != NULL; i++) {
1037 if (strcmp(name, PyImport_Inittab[i].name) == 0) {
1038 if (PyImport_Inittab[i].initfunc == NULL)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001039 return -1;
1040 else
1041 return 1;
1042 }
1043 }
1044 return 0;
1045}
1046
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001047
Just van Rossum52e14d62002-12-30 22:08:05 +00001048/* Return an importer object for a sys.path/pkg.__path__ item 'p',
1049 possibly by fetching it from the path_importer_cache dict. If it
Thomas Wouters89f507f2006-12-13 04:49:30 +00001050 wasn't yet cached, traverse path_hooks until a hook is found
Just van Rossum52e14d62002-12-30 22:08:05 +00001051 that can handle the path item. Return None if no hook could;
1052 this tells our caller it should fall back to the builtin
1053 import mechanism. Cache the result in path_importer_cache.
1054 Returns a borrowed reference. */
1055
1056static PyObject *
1057get_path_importer(PyObject *path_importer_cache, PyObject *path_hooks,
1058 PyObject *p)
1059{
1060 PyObject *importer;
Martin v. Löwis725507b2006-03-07 12:08:51 +00001061 Py_ssize_t j, nhooks;
Just van Rossum52e14d62002-12-30 22:08:05 +00001062
1063 /* These conditions are the caller's responsibility: */
1064 assert(PyList_Check(path_hooks));
1065 assert(PyDict_Check(path_importer_cache));
1066
1067 nhooks = PyList_Size(path_hooks);
1068 if (nhooks < 0)
1069 return NULL; /* Shouldn't happen */
1070
1071 importer = PyDict_GetItem(path_importer_cache, p);
1072 if (importer != NULL)
1073 return importer;
1074
1075 /* set path_importer_cache[p] to None to avoid recursion */
1076 if (PyDict_SetItem(path_importer_cache, p, Py_None) != 0)
1077 return NULL;
1078
1079 for (j = 0; j < nhooks; j++) {
1080 PyObject *hook = PyList_GetItem(path_hooks, j);
1081 if (hook == NULL)
1082 return NULL;
Thomas Wouters477c8d52006-05-27 19:21:47 +00001083 importer = PyObject_CallFunctionObjArgs(hook, p, NULL);
Just van Rossum52e14d62002-12-30 22:08:05 +00001084 if (importer != NULL)
1085 break;
1086
1087 if (!PyErr_ExceptionMatches(PyExc_ImportError)) {
1088 return NULL;
1089 }
1090 PyErr_Clear();
1091 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001092 if (importer == NULL) {
1093 importer = PyObject_CallFunctionObjArgs(
1094 (PyObject *)&NullImporterType, p, NULL
1095 );
1096 if (importer == NULL) {
1097 if (PyErr_ExceptionMatches(PyExc_ImportError)) {
1098 PyErr_Clear();
1099 return Py_None;
1100 }
1101 }
1102 }
1103 if (importer != NULL) {
Just van Rossum52e14d62002-12-30 22:08:05 +00001104 int err = PyDict_SetItem(path_importer_cache, p, importer);
1105 Py_DECREF(importer);
1106 if (err != 0)
1107 return NULL;
1108 }
1109 return importer;
1110}
1111
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001112/* Search the path (default sys.path) for a module. Return the
1113 corresponding filedescr struct, and (via return arguments) the
1114 pathname and an open file. Return NULL if the module is not found. */
1115
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001116#ifdef MS_COREDLL
Thomas Woutersb4bd21c2000-07-22 23:38:01 +00001117extern FILE *PyWin_FindRegisteredModule(const char *, struct filedescr **,
Martin v. Löwis18e16552006-02-15 17:27:45 +00001118 char *, Py_ssize_t);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001119#endif
1120
Martin v. Löwis18e16552006-02-15 17:27:45 +00001121static int case_ok(char *, Py_ssize_t, Py_ssize_t, char *);
Tim Petersdbd9ba62000-07-09 03:09:57 +00001122static int find_init_module(char *); /* Forward */
Just van Rossum52e14d62002-12-30 22:08:05 +00001123static struct filedescr importhookdescr = {"", "", IMP_HOOK};
Guido van Rossum197346f1997-10-31 18:38:52 +00001124
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001125static struct filedescr *
Just van Rossum52e14d62002-12-30 22:08:05 +00001126find_module(char *fullname, char *subname, PyObject *path, char *buf,
1127 size_t buflen, FILE **p_fp, PyObject **p_loader)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001128{
Martin v. Löwis725507b2006-03-07 12:08:51 +00001129 Py_ssize_t i, npath;
Fred Drake4c82b232000-06-30 16:18:57 +00001130 size_t len, namelen;
Guido van Rossum80bb9651996-12-05 23:27:02 +00001131 struct filedescr *fdp = NULL;
Jack Jansenc88da1f2002-05-28 10:58:19 +00001132 char *filemode;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001133 FILE *fp = NULL;
Just van Rossum52e14d62002-12-30 22:08:05 +00001134 PyObject *path_hooks, *path_importer_cache;
Guido van Rossum48a680c2001-03-02 06:34:14 +00001135#ifndef RISCOS
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001136 struct stat statbuf;
Guido van Rossum48a680c2001-03-02 06:34:14 +00001137#endif
Guido van Rossuma5568d31998-03-05 03:45:08 +00001138 static struct filedescr fd_frozen = {"", "", PY_FROZEN};
1139 static struct filedescr fd_builtin = {"", "", C_BUILTIN};
1140 static struct filedescr fd_package = {"", "", PKG_DIRECTORY};
Guido van Rossum0506a431998-08-11 15:07:39 +00001141 char name[MAXPATHLEN+1];
Andrew MacIntyred9400542002-02-26 11:41:34 +00001142#if defined(PYOS_OS2)
1143 size_t saved_len;
1144 size_t saved_namelen;
1145 char *saved_buf = NULL;
1146#endif
Just van Rossum52e14d62002-12-30 22:08:05 +00001147 if (p_loader != NULL)
1148 *p_loader = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001149
Just van Rossum52e14d62002-12-30 22:08:05 +00001150 if (strlen(subname) > MAXPATHLEN) {
Guido van Rossum8f4d3312001-10-18 18:54:11 +00001151 PyErr_SetString(PyExc_OverflowError,
1152 "module name is too long");
Fred Drake4c82b232000-06-30 16:18:57 +00001153 return NULL;
1154 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001155 strcpy(name, subname);
1156
1157 /* sys.meta_path import hook */
1158 if (p_loader != NULL) {
1159 PyObject *meta_path;
1160
1161 meta_path = PySys_GetObject("meta_path");
1162 if (meta_path == NULL || !PyList_Check(meta_path)) {
1163 PyErr_SetString(PyExc_ImportError,
1164 "sys.meta_path must be a list of "
1165 "import hooks");
1166 return NULL;
1167 }
1168 Py_INCREF(meta_path); /* zap guard */
1169 npath = PyList_Size(meta_path);
1170 for (i = 0; i < npath; i++) {
1171 PyObject *loader;
1172 PyObject *hook = PyList_GetItem(meta_path, i);
1173 loader = PyObject_CallMethod(hook, "find_module",
1174 "sO", fullname,
1175 path != NULL ?
1176 path : Py_None);
1177 if (loader == NULL) {
1178 Py_DECREF(meta_path);
1179 return NULL; /* true error */
1180 }
1181 if (loader != Py_None) {
1182 /* a loader was found */
1183 *p_loader = loader;
1184 Py_DECREF(meta_path);
1185 return &importhookdescr;
1186 }
1187 Py_DECREF(loader);
1188 }
1189 Py_DECREF(meta_path);
1190 }
Guido van Rossum0506a431998-08-11 15:07:39 +00001191
1192 if (path != NULL && PyString_Check(path)) {
Guido van Rossum8f4d3312001-10-18 18:54:11 +00001193 /* The only type of submodule allowed inside a "frozen"
1194 package are other frozen modules or packages. */
Guido van Rossum0506a431998-08-11 15:07:39 +00001195 if (PyString_Size(path) + 1 + strlen(name) >= (size_t)buflen) {
1196 PyErr_SetString(PyExc_ImportError,
1197 "full frozen module name too long");
1198 return NULL;
1199 }
1200 strcpy(buf, PyString_AsString(path));
1201 strcat(buf, ".");
1202 strcat(buf, name);
1203 strcpy(name, buf);
Guido van Rossum8f4d3312001-10-18 18:54:11 +00001204 if (find_frozen(name) != NULL) {
1205 strcpy(buf, name);
1206 return &fd_frozen;
1207 }
1208 PyErr_Format(PyExc_ImportError,
1209 "No frozen submodule named %.200s", name);
1210 return NULL;
Guido van Rossum0506a431998-08-11 15:07:39 +00001211 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001212 if (path == NULL) {
1213 if (is_builtin(name)) {
Guido van Rossuma5568d31998-03-05 03:45:08 +00001214 strcpy(buf, name);
1215 return &fd_builtin;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001216 }
Greg Ward201baee2001-10-04 14:52:06 +00001217 if ((find_frozen(name)) != NULL) {
Guido van Rossuma5568d31998-03-05 03:45:08 +00001218 strcpy(buf, name);
1219 return &fd_frozen;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001220 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001221
Guido van Rossumac279101996-08-22 23:10:58 +00001222#ifdef MS_COREDLL
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001223 fp = PyWin_FindRegisteredModule(name, &fdp, buf, buflen);
1224 if (fp != NULL) {
1225 *p_fp = fp;
1226 return fdp;
1227 }
Guido van Rossuma5a3db71996-04-09 02:39:59 +00001228#endif
Guido van Rossuma5568d31998-03-05 03:45:08 +00001229 path = PySys_GetObject("path");
1230 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00001231 if (path == NULL || !PyList_Check(path)) {
1232 PyErr_SetString(PyExc_ImportError,
Guido van Rossuma5568d31998-03-05 03:45:08 +00001233 "sys.path must be a list of directory names");
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001234 return NULL;
1235 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001236
1237 path_hooks = PySys_GetObject("path_hooks");
1238 if (path_hooks == NULL || !PyList_Check(path_hooks)) {
1239 PyErr_SetString(PyExc_ImportError,
1240 "sys.path_hooks must be a list of "
1241 "import hooks");
1242 return NULL;
1243 }
1244 path_importer_cache = PySys_GetObject("path_importer_cache");
1245 if (path_importer_cache == NULL ||
1246 !PyDict_Check(path_importer_cache)) {
1247 PyErr_SetString(PyExc_ImportError,
1248 "sys.path_importer_cache must be a dict");
1249 return NULL;
1250 }
1251
Guido van Rossum79f25d91997-04-29 20:08:16 +00001252 npath = PyList_Size(path);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001253 namelen = strlen(name);
1254 for (i = 0; i < npath; i++) {
Walter Dörwald3430d702002-06-17 10:43:59 +00001255 PyObject *copy = NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +00001256 PyObject *v = PyList_GetItem(path, i);
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001257 if (!v)
1258 return NULL;
Walter Dörwald3430d702002-06-17 10:43:59 +00001259 if (PyUnicode_Check(v)) {
1260 copy = PyUnicode_Encode(PyUnicode_AS_UNICODE(v),
1261 PyUnicode_GET_SIZE(v), Py_FileSystemDefaultEncoding, NULL);
1262 if (copy == NULL)
1263 return NULL;
1264 v = copy;
1265 }
1266 else
Guido van Rossum79f25d91997-04-29 20:08:16 +00001267 if (!PyString_Check(v))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001268 continue;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001269 len = PyString_GET_SIZE(v);
Walter Dörwald3430d702002-06-17 10:43:59 +00001270 if (len + 2 + namelen + MAXSUFFIXSIZE >= buflen) {
1271 Py_XDECREF(copy);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001272 continue; /* Too long */
Walter Dörwald3430d702002-06-17 10:43:59 +00001273 }
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001274 strcpy(buf, PyString_AS_STRING(v));
Walter Dörwald3430d702002-06-17 10:43:59 +00001275 if (strlen(buf) != len) {
1276 Py_XDECREF(copy);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001277 continue; /* v contains '\0' */
Walter Dörwald3430d702002-06-17 10:43:59 +00001278 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001279
1280 /* sys.path_hooks import hook */
1281 if (p_loader != NULL) {
1282 PyObject *importer;
1283
1284 importer = get_path_importer(path_importer_cache,
1285 path_hooks, v);
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001286 if (importer == NULL) {
Thomas Wouters477c8d52006-05-27 19:21:47 +00001287 Py_XDECREF(copy);
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001288 return NULL;
Thomas Wouters477c8d52006-05-27 19:21:47 +00001289 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001290 /* Note: importer is a borrowed reference */
1291 if (importer != Py_None) {
Just van Rossum52e14d62002-12-30 22:08:05 +00001292 PyObject *loader;
1293 loader = PyObject_CallMethod(importer,
1294 "find_module",
1295 "s", fullname);
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001296 Py_XDECREF(copy);
Just van Rossum52e14d62002-12-30 22:08:05 +00001297 if (loader == NULL)
1298 return NULL; /* error */
1299 if (loader != Py_None) {
1300 /* a loader was found */
1301 *p_loader = loader;
1302 return &importhookdescr;
1303 }
1304 Py_DECREF(loader);
Thomas Wouters477c8d52006-05-27 19:21:47 +00001305 continue;
Just van Rossum52e14d62002-12-30 22:08:05 +00001306 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001307 }
Thomas Wouters477c8d52006-05-27 19:21:47 +00001308 /* no hook was found, use builtin import */
Just van Rossum52e14d62002-12-30 22:08:05 +00001309
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001310 if (len > 0 && buf[len-1] != SEP
1311#ifdef ALTSEP
1312 && buf[len-1] != ALTSEP
1313#endif
1314 )
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001315 buf[len++] = SEP;
Guido van Rossum215c3402000-11-13 17:26:32 +00001316 strcpy(buf+len, name);
1317 len += namelen;
Tim Peters50d8d372001-02-28 05:34:27 +00001318
1319 /* Check for package import (buf holds a directory name,
1320 and there's an __init__ module in that directory */
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001321#ifdef HAVE_STAT
Walter Dörwald3430d702002-06-17 10:43:59 +00001322 if (stat(buf, &statbuf) == 0 && /* it exists */
1323 S_ISDIR(statbuf.st_mode) && /* it's a directory */
Thomas Wouters477c8d52006-05-27 19:21:47 +00001324 case_ok(buf, len, namelen, name)) { /* case matches */
1325 if (find_init_module(buf)) { /* and has __init__.py */
1326 Py_XDECREF(copy);
1327 return &fd_package;
1328 }
1329 else {
1330 char warnstr[MAXPATHLEN+80];
1331 sprintf(warnstr, "Not importing directory "
1332 "'%.*s': missing __init__.py",
1333 MAXPATHLEN, buf);
1334 if (PyErr_Warn(PyExc_ImportWarning,
1335 warnstr)) {
1336 Py_XDECREF(copy);
1337 return NULL;
1338 }
1339 }
Walter Dörwald3430d702002-06-17 10:43:59 +00001340 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001341#else
1342 /* XXX How are you going to test for directories? */
Guido van Rossum48a680c2001-03-02 06:34:14 +00001343#ifdef RISCOS
Guido van Rossume2ae77b2001-10-24 20:42:55 +00001344 if (isdir(buf) &&
Walter Dörwald3430d702002-06-17 10:43:59 +00001345 case_ok(buf, len, namelen, name)) {
Thomas Wouters477c8d52006-05-27 19:21:47 +00001346 if (find_init_module(buf)) {
1347 Py_XDECREF(copy);
1348 return &fd_package;
1349 }
1350 else {
1351 char warnstr[MAXPATHLEN+80];
1352 sprintf(warnstr, "Not importing directory "
1353 "'%.*s': missing __init__.py",
1354 MAXPATHLEN, buf);
1355 if (PyErr_Warn(PyExc_ImportWarning,
1356 warnstr)) {
1357 Py_XDECREF(copy);
1358 return NULL;
1359 }
Walter Dörwald3430d702002-06-17 10:43:59 +00001360 }
Guido van Rossum48a680c2001-03-02 06:34:14 +00001361#endif
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001362#endif
Andrew MacIntyred9400542002-02-26 11:41:34 +00001363#if defined(PYOS_OS2)
1364 /* take a snapshot of the module spec for restoration
1365 * after the 8 character DLL hackery
1366 */
1367 saved_buf = strdup(buf);
1368 saved_len = len;
1369 saved_namelen = namelen;
1370#endif /* PYOS_OS2 */
Guido van Rossum79f25d91997-04-29 20:08:16 +00001371 for (fdp = _PyImport_Filetab; fdp->suffix != NULL; fdp++) {
Andrew MacIntyred9400542002-02-26 11:41:34 +00001372#if defined(PYOS_OS2)
Jeremy Hylton4ae6fae2002-05-30 17:15:25 +00001373 /* OS/2 limits DLLs to 8 character names (w/o
1374 extension)
Andrew MacIntyred9400542002-02-26 11:41:34 +00001375 * so if the name is longer than that and its a
1376 * dynamically loaded module we're going to try,
1377 * truncate the name before trying
1378 */
Just van Rossum52e14d62002-12-30 22:08:05 +00001379 if (strlen(subname) > 8) {
Andrew MacIntyred9400542002-02-26 11:41:34 +00001380 /* is this an attempt to load a C extension? */
Jeremy Hylton4ae6fae2002-05-30 17:15:25 +00001381 const struct filedescr *scan;
1382 scan = _PyImport_DynLoadFiletab;
Andrew MacIntyred9400542002-02-26 11:41:34 +00001383 while (scan->suffix != NULL) {
Jeremy Hylton4ae6fae2002-05-30 17:15:25 +00001384 if (!strcmp(scan->suffix, fdp->suffix))
Andrew MacIntyred9400542002-02-26 11:41:34 +00001385 break;
1386 else
1387 scan++;
1388 }
1389 if (scan->suffix != NULL) {
1390 /* yes, so truncate the name */
1391 namelen = 8;
Just van Rossum52e14d62002-12-30 22:08:05 +00001392 len -= strlen(subname) - namelen;
Andrew MacIntyred9400542002-02-26 11:41:34 +00001393 buf[len] = '\0';
1394 }
1395 }
1396#endif /* PYOS_OS2 */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001397 strcpy(buf+len, fdp->suffix);
Guido van Rossum79f25d91997-04-29 20:08:16 +00001398 if (Py_VerboseFlag > 1)
Guido van Rossum2f3667a1998-10-12 18:23:55 +00001399 PySys_WriteStderr("# trying %s\n", buf);
Jack Jansenc88da1f2002-05-28 10:58:19 +00001400 filemode = fdp->mode;
Tim Peters86c7d2f2004-08-01 23:24:21 +00001401 if (filemode[0] == 'U')
Jeremy Hylton4ae6fae2002-05-30 17:15:25 +00001402 filemode = "r" PY_STDIOTEXTMODE;
Jack Jansenc88da1f2002-05-28 10:58:19 +00001403 fp = fopen(buf, filemode);
Tim Peters50d8d372001-02-28 05:34:27 +00001404 if (fp != NULL) {
1405 if (case_ok(buf, len, namelen, name))
1406 break;
1407 else { /* continue search */
1408 fclose(fp);
1409 fp = NULL;
Barry Warsaw914a0b12001-02-02 19:12:16 +00001410 }
Barry Warsaw914a0b12001-02-02 19:12:16 +00001411 }
Andrew MacIntyred9400542002-02-26 11:41:34 +00001412#if defined(PYOS_OS2)
1413 /* restore the saved snapshot */
1414 strcpy(buf, saved_buf);
1415 len = saved_len;
1416 namelen = saved_namelen;
1417#endif
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001418 }
Andrew MacIntyred9400542002-02-26 11:41:34 +00001419#if defined(PYOS_OS2)
1420 /* don't need/want the module name snapshot anymore */
1421 if (saved_buf)
1422 {
1423 free(saved_buf);
1424 saved_buf = NULL;
1425 }
1426#endif
Walter Dörwald3430d702002-06-17 10:43:59 +00001427 Py_XDECREF(copy);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001428 if (fp != NULL)
1429 break;
1430 }
1431 if (fp == NULL) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001432 PyErr_Format(PyExc_ImportError,
1433 "No module named %.200s", name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001434 return NULL;
1435 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001436 *p_fp = fp;
1437 return fdp;
1438}
1439
Raymond Hettingerdb29e0f2004-10-07 06:46:25 +00001440/* Helpers for main.c
1441 * Find the source file corresponding to a named module
1442 */
1443struct filedescr *
1444_PyImport_FindModule(const char *name, PyObject *path, char *buf,
1445 size_t buflen, FILE **p_fp, PyObject **p_loader)
1446{
1447 return find_module((char *) name, (char *) name, path,
1448 buf, buflen, p_fp, p_loader);
1449}
1450
1451PyAPI_FUNC(int) _PyImport_IsScript(struct filedescr * fd)
1452{
1453 return fd->type == PY_SOURCE || fd->type == PY_COMPILED;
1454}
1455
Martin v. Löwis18e16552006-02-15 17:27:45 +00001456/* case_ok(char* buf, Py_ssize_t len, Py_ssize_t namelen, char* name)
Tim Petersd1e87a82001-03-01 18:12:00 +00001457 * The arguments here are tricky, best shown by example:
1458 * /a/b/c/d/e/f/g/h/i/j/k/some_long_module_name.py\0
1459 * ^ ^ ^ ^
1460 * |--------------------- buf ---------------------|
1461 * |------------------- len ------------------|
1462 * |------ name -------|
1463 * |----- namelen -----|
1464 * buf is the full path, but len only counts up to (& exclusive of) the
1465 * extension. name is the module name, also exclusive of extension.
1466 *
1467 * We've already done a successful stat() or fopen() on buf, so know that
1468 * there's some match, possibly case-insensitive.
1469 *
Tim Peters50d8d372001-02-28 05:34:27 +00001470 * case_ok() is to return 1 if there's a case-sensitive match for
1471 * name, else 0. case_ok() is also to return 1 if envar PYTHONCASEOK
1472 * exists.
Tim Petersd1e87a82001-03-01 18:12:00 +00001473 *
Tim Peters50d8d372001-02-28 05:34:27 +00001474 * case_ok() is used to implement case-sensitive import semantics even
1475 * on platforms with case-insensitive filesystems. It's trivial to implement
1476 * for case-sensitive filesystems. It's pretty much a cross-platform
1477 * nightmare for systems with case-insensitive filesystems.
1478 */
Guido van Rossum0980bd91998-02-13 17:18:36 +00001479
Tim Peters50d8d372001-02-28 05:34:27 +00001480/* First we may need a pile of platform-specific header files; the sequence
1481 * of #if's here should match the sequence in the body of case_ok().
1482 */
Jason Tishler7961aa62005-05-20 00:56:54 +00001483#if defined(MS_WINDOWS)
Guido van Rossum0980bd91998-02-13 17:18:36 +00001484#include <windows.h>
Guido van Rossum4c3f57c2001-01-10 20:40:46 +00001485
Tim Peters50d8d372001-02-28 05:34:27 +00001486#elif defined(DJGPP)
1487#include <dir.h>
1488
Jason Tishler7961aa62005-05-20 00:56:54 +00001489#elif (defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) && defined(HAVE_DIRENT_H)
Tim Peters430f5d42001-03-01 01:30:56 +00001490#include <sys/types.h>
1491#include <dirent.h>
1492
Andrew MacIntyred9400542002-02-26 11:41:34 +00001493#elif defined(PYOS_OS2)
1494#define INCL_DOS
1495#define INCL_DOSERRORS
1496#define INCL_NOPMAPI
1497#include <os2.h>
1498
Guido van Rossume2ae77b2001-10-24 20:42:55 +00001499#elif defined(RISCOS)
1500#include "oslib/osfscontrol.h"
Tim Peters50d8d372001-02-28 05:34:27 +00001501#endif
1502
Guido van Rossum0980bd91998-02-13 17:18:36 +00001503static int
Martin v. Löwis18e16552006-02-15 17:27:45 +00001504case_ok(char *buf, Py_ssize_t len, Py_ssize_t namelen, char *name)
Guido van Rossum0980bd91998-02-13 17:18:36 +00001505{
Tim Peters50d8d372001-02-28 05:34:27 +00001506/* Pick a platform-specific implementation; the sequence of #if's here should
1507 * match the sequence just above.
1508 */
1509
Jason Tishler7961aa62005-05-20 00:56:54 +00001510/* MS_WINDOWS */
1511#if defined(MS_WINDOWS)
Guido van Rossum0980bd91998-02-13 17:18:36 +00001512 WIN32_FIND_DATA data;
1513 HANDLE h;
Tim Peters50d8d372001-02-28 05:34:27 +00001514
Neil Schemenauer7d4bb9f2001-07-23 16:30:27 +00001515 if (Py_GETENV("PYTHONCASEOK") != NULL)
Guido van Rossum0980bd91998-02-13 17:18:36 +00001516 return 1;
Tim Peters50d8d372001-02-28 05:34:27 +00001517
Guido van Rossum0980bd91998-02-13 17:18:36 +00001518 h = FindFirstFile(buf, &data);
1519 if (h == INVALID_HANDLE_VALUE) {
1520 PyErr_Format(PyExc_NameError,
1521 "Can't find file for module %.100s\n(filename %.300s)",
1522 name, buf);
1523 return 0;
1524 }
1525 FindClose(h);
Tim Peters50d8d372001-02-28 05:34:27 +00001526 return strncmp(data.cFileName, name, namelen) == 0;
1527
1528/* DJGPP */
1529#elif defined(DJGPP)
1530 struct ffblk ffblk;
1531 int done;
1532
Neil Schemenauer7d4bb9f2001-07-23 16:30:27 +00001533 if (Py_GETENV("PYTHONCASEOK") != NULL)
Guido van Rossum323bf5e1998-06-24 03:54:06 +00001534 return 1;
Tim Peters50d8d372001-02-28 05:34:27 +00001535
1536 done = findfirst(buf, &ffblk, FA_ARCH|FA_RDONLY|FA_HIDDEN|FA_DIREC);
1537 if (done) {
Guido van Rossum0980bd91998-02-13 17:18:36 +00001538 PyErr_Format(PyExc_NameError,
Tim Peters50d8d372001-02-28 05:34:27 +00001539 "Can't find file for module %.100s\n(filename %.300s)",
Guido van Rossum0980bd91998-02-13 17:18:36 +00001540 name, buf);
1541 return 0;
1542 }
Tim Peters50d8d372001-02-28 05:34:27 +00001543 return strncmp(ffblk.ff_name, name, namelen) == 0;
Guido van Rossum0980bd91998-02-13 17:18:36 +00001544
Jason Tishler7961aa62005-05-20 00:56:54 +00001545/* new-fangled macintosh (macosx) or Cygwin */
1546#elif (defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) && defined(HAVE_DIRENT_H)
Tim Peters430f5d42001-03-01 01:30:56 +00001547 DIR *dirp;
1548 struct dirent *dp;
Tim Petersd1e87a82001-03-01 18:12:00 +00001549 char dirname[MAXPATHLEN + 1];
1550 const int dirlen = len - namelen - 1; /* don't want trailing SEP */
Tim Peters430f5d42001-03-01 01:30:56 +00001551
Neil Schemenauer7d4bb9f2001-07-23 16:30:27 +00001552 if (Py_GETENV("PYTHONCASEOK") != NULL)
Tim Petersdbe6ebb2001-03-01 08:47:29 +00001553 return 1;
1554
Tim Petersd1e87a82001-03-01 18:12:00 +00001555 /* Copy the dir component into dirname; substitute "." if empty */
1556 if (dirlen <= 0) {
1557 dirname[0] = '.';
1558 dirname[1] = '\0';
Tim Peters430f5d42001-03-01 01:30:56 +00001559 }
1560 else {
Tim Petersd1e87a82001-03-01 18:12:00 +00001561 assert(dirlen <= MAXPATHLEN);
1562 memcpy(dirname, buf, dirlen);
1563 dirname[dirlen] = '\0';
Tim Peters430f5d42001-03-01 01:30:56 +00001564 }
1565 /* Open the directory and search the entries for an exact match. */
Tim Petersd1e87a82001-03-01 18:12:00 +00001566 dirp = opendir(dirname);
Tim Peters430f5d42001-03-01 01:30:56 +00001567 if (dirp) {
Tim Peters677898a2001-03-02 03:28:03 +00001568 char *nameWithExt = buf + len - namelen;
Tim Peters430f5d42001-03-01 01:30:56 +00001569 while ((dp = readdir(dirp)) != NULL) {
Tim Petersdbe6ebb2001-03-01 08:47:29 +00001570 const int thislen =
Tim Peters430f5d42001-03-01 01:30:56 +00001571#ifdef _DIRENT_HAVE_D_NAMELEN
Tim Petersdbe6ebb2001-03-01 08:47:29 +00001572 dp->d_namlen;
Tim Peters430f5d42001-03-01 01:30:56 +00001573#else
Tim Petersdbe6ebb2001-03-01 08:47:29 +00001574 strlen(dp->d_name);
Tim Peters430f5d42001-03-01 01:30:56 +00001575#endif
Tim Petersd1e87a82001-03-01 18:12:00 +00001576 if (thislen >= namelen &&
Tim Peters677898a2001-03-02 03:28:03 +00001577 strcmp(dp->d_name, nameWithExt) == 0) {
Tim Peters430f5d42001-03-01 01:30:56 +00001578 (void)closedir(dirp);
1579 return 1; /* Found */
1580 }
1581 }
Tim Petersdbe6ebb2001-03-01 08:47:29 +00001582 (void)closedir(dirp);
Tim Peters430f5d42001-03-01 01:30:56 +00001583 }
Tim Peters430f5d42001-03-01 01:30:56 +00001584 return 0 ; /* Not found */
Tim Peters430f5d42001-03-01 01:30:56 +00001585
Guido van Rossume2ae77b2001-10-24 20:42:55 +00001586/* RISC OS */
1587#elif defined(RISCOS)
1588 char canon[MAXPATHLEN+1]; /* buffer for the canonical form of the path */
1589 char buf2[MAXPATHLEN+2];
1590 char *nameWithExt = buf+len-namelen;
1591 int canonlen;
1592 os_error *e;
1593
1594 if (Py_GETENV("PYTHONCASEOK") != NULL)
1595 return 1;
1596
1597 /* workaround:
1598 append wildcard, otherwise case of filename wouldn't be touched */
1599 strcpy(buf2, buf);
1600 strcat(buf2, "*");
1601
1602 e = xosfscontrol_canonicalise_path(buf2,canon,0,0,MAXPATHLEN+1,&canonlen);
1603 canonlen = MAXPATHLEN+1-canonlen;
1604 if (e || canonlen<=0 || canonlen>(MAXPATHLEN+1) )
1605 return 0;
1606 if (strcmp(nameWithExt, canon+canonlen-strlen(nameWithExt))==0)
1607 return 1; /* match */
1608
1609 return 0;
1610
Andrew MacIntyred9400542002-02-26 11:41:34 +00001611/* OS/2 */
1612#elif defined(PYOS_OS2)
1613 HDIR hdir = 1;
1614 ULONG srchcnt = 1;
1615 FILEFINDBUF3 ffbuf;
1616 APIRET rc;
1617
1618 if (getenv("PYTHONCASEOK") != NULL)
1619 return 1;
1620
1621 rc = DosFindFirst(buf,
1622 &hdir,
1623 FILE_READONLY | FILE_HIDDEN | FILE_SYSTEM | FILE_DIRECTORY,
1624 &ffbuf, sizeof(ffbuf),
1625 &srchcnt,
1626 FIL_STANDARD);
1627 if (rc != NO_ERROR)
1628 return 0;
1629 return strncmp(ffbuf.achName, name, namelen) == 0;
1630
Tim Peters50d8d372001-02-28 05:34:27 +00001631/* assuming it's a case-sensitive filesystem, so there's nothing to do! */
1632#else
Guido van Rossum0980bd91998-02-13 17:18:36 +00001633 return 1;
Guido van Rossum0980bd91998-02-13 17:18:36 +00001634
Guido van Rossum4d1b3b91998-02-13 23:27:59 +00001635#endif
Tim Peters50d8d372001-02-28 05:34:27 +00001636}
Guido van Rossum4d1b3b91998-02-13 23:27:59 +00001637
Guido van Rossum0980bd91998-02-13 17:18:36 +00001638
Guido van Rossum197346f1997-10-31 18:38:52 +00001639#ifdef HAVE_STAT
1640/* Helper to look for __init__.py or __init__.py[co] in potential package */
1641static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001642find_init_module(char *buf)
Guido van Rossum197346f1997-10-31 18:38:52 +00001643{
Tim Peters0f9431f2001-07-05 03:47:53 +00001644 const size_t save_len = strlen(buf);
Fred Drake4c82b232000-06-30 16:18:57 +00001645 size_t i = save_len;
Tim Peters0f9431f2001-07-05 03:47:53 +00001646 char *pname; /* pointer to start of __init__ */
Guido van Rossum197346f1997-10-31 18:38:52 +00001647 struct stat statbuf;
1648
Tim Peters0f9431f2001-07-05 03:47:53 +00001649/* For calling case_ok(buf, len, namelen, name):
1650 * /a/b/c/d/e/f/g/h/i/j/k/some_long_module_name.py\0
1651 * ^ ^ ^ ^
1652 * |--------------------- buf ---------------------|
1653 * |------------------- len ------------------|
1654 * |------ name -------|
1655 * |----- namelen -----|
1656 */
Guido van Rossum197346f1997-10-31 18:38:52 +00001657 if (save_len + 13 >= MAXPATHLEN)
1658 return 0;
1659 buf[i++] = SEP;
Tim Peters0f9431f2001-07-05 03:47:53 +00001660 pname = buf + i;
1661 strcpy(pname, "__init__.py");
Guido van Rossum197346f1997-10-31 18:38:52 +00001662 if (stat(buf, &statbuf) == 0) {
Tim Peters0f9431f2001-07-05 03:47:53 +00001663 if (case_ok(buf,
1664 save_len + 9, /* len("/__init__") */
1665 8, /* len("__init__") */
1666 pname)) {
1667 buf[save_len] = '\0';
1668 return 1;
1669 }
Guido van Rossum197346f1997-10-31 18:38:52 +00001670 }
Tim Peters0f9431f2001-07-05 03:47:53 +00001671 i += strlen(pname);
1672 strcpy(buf+i, Py_OptimizeFlag ? "o" : "c");
Guido van Rossum197346f1997-10-31 18:38:52 +00001673 if (stat(buf, &statbuf) == 0) {
Tim Peters0f9431f2001-07-05 03:47:53 +00001674 if (case_ok(buf,
1675 save_len + 9, /* len("/__init__") */
1676 8, /* len("__init__") */
1677 pname)) {
1678 buf[save_len] = '\0';
1679 return 1;
1680 }
Guido van Rossum197346f1997-10-31 18:38:52 +00001681 }
1682 buf[save_len] = '\0';
1683 return 0;
1684}
Guido van Rossum48a680c2001-03-02 06:34:14 +00001685
1686#else
1687
1688#ifdef RISCOS
1689static int
1690find_init_module(buf)
1691 char *buf;
1692{
1693 int save_len = strlen(buf);
1694 int i = save_len;
1695
1696 if (save_len + 13 >= MAXPATHLEN)
1697 return 0;
1698 buf[i++] = SEP;
1699 strcpy(buf+i, "__init__/py");
1700 if (isfile(buf)) {
1701 buf[save_len] = '\0';
1702 return 1;
1703 }
1704
1705 if (Py_OptimizeFlag)
1706 strcpy(buf+i, "o");
1707 else
1708 strcpy(buf+i, "c");
1709 if (isfile(buf)) {
1710 buf[save_len] = '\0';
1711 return 1;
1712 }
1713 buf[save_len] = '\0';
1714 return 0;
1715}
1716#endif /*RISCOS*/
1717
Guido van Rossum197346f1997-10-31 18:38:52 +00001718#endif /* HAVE_STAT */
1719
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001720
Tim Petersdbd9ba62000-07-09 03:09:57 +00001721static int init_builtin(char *); /* Forward */
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001722
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001723/* Load an external module using the default search path and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001724 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001725
Guido van Rossum79f25d91997-04-29 20:08:16 +00001726static PyObject *
Just van Rossum52e14d62002-12-30 22:08:05 +00001727load_module(char *name, FILE *fp, char *buf, int type, PyObject *loader)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001728{
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001729 PyObject *modules;
Guido van Rossum79f25d91997-04-29 20:08:16 +00001730 PyObject *m;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001731 int err;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001732
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001733 /* First check that there's an open file (if we need one) */
1734 switch (type) {
1735 case PY_SOURCE:
1736 case PY_COMPILED:
1737 if (fp == NULL) {
1738 PyErr_Format(PyExc_ValueError,
1739 "file object required for import (type code %d)",
1740 type);
1741 return NULL;
1742 }
1743 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001744
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001745 switch (type) {
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001746
1747 case PY_SOURCE:
1748 m = load_source_module(name, buf, fp);
1749 break;
1750
1751 case PY_COMPILED:
1752 m = load_compiled_module(name, buf, fp);
1753 break;
1754
Guido van Rossum96a8fb71999-12-22 14:09:35 +00001755#ifdef HAVE_DYNAMIC_LOADING
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001756 case C_EXTENSION:
Guido van Rossum79f25d91997-04-29 20:08:16 +00001757 m = _PyImport_LoadDynamicModule(name, buf, fp);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001758 break;
Guido van Rossum96a8fb71999-12-22 14:09:35 +00001759#endif
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001760
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001761 case PKG_DIRECTORY:
1762 m = load_package(name, buf);
1763 break;
1764
1765 case C_BUILTIN:
1766 case PY_FROZEN:
Guido van Rossuma5568d31998-03-05 03:45:08 +00001767 if (buf != NULL && buf[0] != '\0')
1768 name = buf;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001769 if (type == C_BUILTIN)
1770 err = init_builtin(name);
1771 else
1772 err = PyImport_ImportFrozenModule(name);
1773 if (err < 0)
Guido van Rossuma86f77d1997-09-09 18:53:47 +00001774 return NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001775 if (err == 0) {
1776 PyErr_Format(PyExc_ImportError,
1777 "Purported %s module %.200s not found",
1778 type == C_BUILTIN ?
1779 "builtin" : "frozen",
1780 name);
Guido van Rossuma86f77d1997-09-09 18:53:47 +00001781 return NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001782 }
1783 modules = PyImport_GetModuleDict();
1784 m = PyDict_GetItemString(modules, name);
1785 if (m == NULL) {
1786 PyErr_Format(
1787 PyExc_ImportError,
1788 "%s module %.200s not properly initialized",
1789 type == C_BUILTIN ?
1790 "builtin" : "frozen",
1791 name);
Guido van Rossuma86f77d1997-09-09 18:53:47 +00001792 return NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001793 }
1794 Py_INCREF(m);
1795 break;
1796
Just van Rossum52e14d62002-12-30 22:08:05 +00001797 case IMP_HOOK: {
1798 if (loader == NULL) {
1799 PyErr_SetString(PyExc_ImportError,
1800 "import hook without loader");
1801 return NULL;
1802 }
1803 m = PyObject_CallMethod(loader, "load_module", "s", name);
1804 break;
1805 }
1806
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001807 default:
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001808 PyErr_Format(PyExc_ImportError,
1809 "Don't know how to import %.200s (type code %d)",
1810 name, type);
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001811 m = NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001812
1813 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001814
1815 return m;
1816}
1817
1818
1819/* Initialize a built-in module.
Thomas Wouters89f507f2006-12-13 04:49:30 +00001820 Return 1 for success, 0 if the module is not found, and -1 with
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001821 an exception set if the initialization failed. */
Guido van Rossum7f133ed1991-02-19 12:23:57 +00001822
Guido van Rossum7f133ed1991-02-19 12:23:57 +00001823static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001824init_builtin(char *name)
Guido van Rossum7f133ed1991-02-19 12:23:57 +00001825{
Guido van Rossum25ce5661997-08-02 03:10:38 +00001826 struct _inittab *p;
Guido van Rossum25ce5661997-08-02 03:10:38 +00001827
Greg Ward201baee2001-10-04 14:52:06 +00001828 if (_PyImport_FindExtension(name, name) != NULL)
Guido van Rossum25ce5661997-08-02 03:10:38 +00001829 return 1;
1830
Guido van Rossum771c6c81997-10-31 18:37:24 +00001831 for (p = PyImport_Inittab; p->name != NULL; p++) {
Guido van Rossum25ce5661997-08-02 03:10:38 +00001832 if (strcmp(name, p->name) == 0) {
1833 if (p->initfunc == NULL) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001834 PyErr_Format(PyExc_ImportError,
1835 "Cannot re-init internal module %.200s",
1836 name);
Guido van Rossum74e6a111994-08-29 12:54:38 +00001837 return -1;
1838 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00001839 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +00001840 PySys_WriteStderr("import %s # builtin\n", name);
Guido van Rossum25ce5661997-08-02 03:10:38 +00001841 (*p->initfunc)();
Guido van Rossum79f25d91997-04-29 20:08:16 +00001842 if (PyErr_Occurred())
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001843 return -1;
Guido van Rossum25ce5661997-08-02 03:10:38 +00001844 if (_PyImport_FixupExtension(name, name) == NULL)
1845 return -1;
Guido van Rossum7f133ed1991-02-19 12:23:57 +00001846 return 1;
1847 }
1848 }
1849 return 0;
1850}
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001851
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001852
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001853/* Frozen modules */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001854
Guido van Rossumcfd0a221996-06-17 17:06:34 +00001855static struct _frozen *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001856find_frozen(char *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001857{
Guido van Rossumcfd0a221996-06-17 17:06:34 +00001858 struct _frozen *p;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001859
Guido van Rossum79f25d91997-04-29 20:08:16 +00001860 for (p = PyImport_FrozenModules; ; p++) {
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001861 if (p->name == NULL)
1862 return NULL;
1863 if (strcmp(p->name, name) == 0)
1864 break;
1865 }
1866 return p;
1867}
1868
Guido van Rossum79f25d91997-04-29 20:08:16 +00001869static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001870get_frozen_object(char *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001871{
Guido van Rossumcfd0a221996-06-17 17:06:34 +00001872 struct _frozen *p = find_frozen(name);
Guido van Rossuma5568d31998-03-05 03:45:08 +00001873 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001874
1875 if (p == NULL) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001876 PyErr_Format(PyExc_ImportError,
1877 "No such frozen object named %.200s",
1878 name);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001879 return NULL;
1880 }
Guido van Rossum8f4d3312001-10-18 18:54:11 +00001881 if (p->code == NULL) {
1882 PyErr_Format(PyExc_ImportError,
1883 "Excluded frozen object named %.200s",
1884 name);
1885 return NULL;
1886 }
Guido van Rossuma5568d31998-03-05 03:45:08 +00001887 size = p->size;
1888 if (size < 0)
1889 size = -size;
1890 return PyMarshal_ReadObjectFromString((char *)p->code, size);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001891}
1892
1893/* Initialize a frozen module.
1894 Return 1 for succes, 0 if the module is not found, and -1 with
1895 an exception set if the initialization failed.
1896 This function is also used from frozenmain.c */
Guido van Rossum0b344901995-02-07 15:35:27 +00001897
1898int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001899PyImport_ImportFrozenModule(char *name)
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001900{
Guido van Rossumcfd0a221996-06-17 17:06:34 +00001901 struct _frozen *p = find_frozen(name);
Guido van Rossum79f25d91997-04-29 20:08:16 +00001902 PyObject *co;
1903 PyObject *m;
Guido van Rossuma5568d31998-03-05 03:45:08 +00001904 int ispackage;
1905 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001906
1907 if (p == NULL)
1908 return 0;
Guido van Rossum8f4d3312001-10-18 18:54:11 +00001909 if (p->code == NULL) {
1910 PyErr_Format(PyExc_ImportError,
1911 "Excluded frozen object named %.200s",
1912 name);
1913 return -1;
1914 }
Guido van Rossuma5568d31998-03-05 03:45:08 +00001915 size = p->size;
1916 ispackage = (size < 0);
1917 if (ispackage)
1918 size = -size;
Guido van Rossum79f25d91997-04-29 20:08:16 +00001919 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +00001920 PySys_WriteStderr("import %s # frozen%s\n",
Guido van Rossuma5568d31998-03-05 03:45:08 +00001921 name, ispackage ? " package" : "");
1922 co = PyMarshal_ReadObjectFromString((char *)p->code, size);
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001923 if (co == NULL)
1924 return -1;
Guido van Rossum79f25d91997-04-29 20:08:16 +00001925 if (!PyCode_Check(co)) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001926 PyErr_Format(PyExc_TypeError,
1927 "frozen object %.200s is not a code object",
1928 name);
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001929 goto err_return;
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001930 }
Guido van Rossuma5568d31998-03-05 03:45:08 +00001931 if (ispackage) {
1932 /* Set __path__ to the package name */
1933 PyObject *d, *s;
1934 int err;
1935 m = PyImport_AddModule(name);
1936 if (m == NULL)
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001937 goto err_return;
Guido van Rossuma5568d31998-03-05 03:45:08 +00001938 d = PyModule_GetDict(m);
1939 s = PyString_InternFromString(name);
1940 if (s == NULL)
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001941 goto err_return;
Guido van Rossuma5568d31998-03-05 03:45:08 +00001942 err = PyDict_SetItemString(d, "__path__", s);
1943 Py_DECREF(s);
1944 if (err != 0)
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001945 goto err_return;
Guido van Rossuma5568d31998-03-05 03:45:08 +00001946 }
Guido van Rossume32bf6e1998-02-11 05:53:02 +00001947 m = PyImport_ExecCodeModuleEx(name, co, "<frozen>");
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001948 if (m == NULL)
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001949 goto err_return;
1950 Py_DECREF(co);
Guido van Rossum79f25d91997-04-29 20:08:16 +00001951 Py_DECREF(m);
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001952 return 1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001953err_return:
1954 Py_DECREF(co);
1955 return -1;
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001956}
Guido van Rossum74e6a111994-08-29 12:54:38 +00001957
1958
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001959/* Import a module, either built-in, frozen, or external, and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001960 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum74e6a111994-08-29 12:54:38 +00001961
Guido van Rossum79f25d91997-04-29 20:08:16 +00001962PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001963PyImport_ImportModule(const char *name)
Guido van Rossum74e6a111994-08-29 12:54:38 +00001964{
Marc-André Lemburg3c61c352001-02-09 19:40:15 +00001965 PyObject *pname;
1966 PyObject *result;
1967
1968 pname = PyString_FromString(name);
Neal Norwitza11e4c12003-03-23 14:31:01 +00001969 if (pname == NULL)
1970 return NULL;
Marc-André Lemburg3c61c352001-02-09 19:40:15 +00001971 result = PyImport_Import(pname);
1972 Py_DECREF(pname);
1973 return result;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001974}
1975
Guido van Rossum17fc85f1997-09-06 18:52:03 +00001976/* Forward declarations for helper routines */
Thomas Woutersf7f438b2006-02-28 16:09:29 +00001977static PyObject *get_parent(PyObject *globals, char *buf,
1978 Py_ssize_t *p_buflen, int level);
Tim Petersdbd9ba62000-07-09 03:09:57 +00001979static PyObject *load_next(PyObject *mod, PyObject *altmod,
Martin v. Löwis18e16552006-02-15 17:27:45 +00001980 char **p_name, char *buf, Py_ssize_t *p_buflen);
Tim Petersdbd9ba62000-07-09 03:09:57 +00001981static int mark_miss(char *name);
1982static int ensure_fromlist(PyObject *mod, PyObject *fromlist,
Martin v. Löwis18e16552006-02-15 17:27:45 +00001983 char *buf, Py_ssize_t buflen, int recursive);
Tim Petersdbd9ba62000-07-09 03:09:57 +00001984static PyObject * import_submodule(PyObject *mod, char *name, char *fullname);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00001985
1986/* The Magnum Opus of dotted-name import :-) */
1987
Guido van Rossum75acc9c1998-03-03 22:26:50 +00001988static PyObject *
Thomas Woutersf7f438b2006-02-28 16:09:29 +00001989import_module_level(char *name, PyObject *globals, PyObject *locals,
1990 PyObject *fromlist, int level)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001991{
Guido van Rossum17fc85f1997-09-06 18:52:03 +00001992 char buf[MAXPATHLEN+1];
Martin v. Löwis18e16552006-02-15 17:27:45 +00001993 Py_ssize_t buflen = 0;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00001994 PyObject *parent, *head, *next, *tail;
1995
Thomas Woutersf7f438b2006-02-28 16:09:29 +00001996 parent = get_parent(globals, buf, &buflen, level);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00001997 if (parent == NULL)
1998 return NULL;
1999
2000 head = load_next(parent, Py_None, &name, buf, &buflen);
2001 if (head == NULL)
2002 return NULL;
2003
2004 tail = head;
2005 Py_INCREF(tail);
2006 while (name) {
2007 next = load_next(tail, tail, &name, buf, &buflen);
2008 Py_DECREF(tail);
2009 if (next == NULL) {
2010 Py_DECREF(head);
2011 return NULL;
2012 }
2013 tail = next;
2014 }
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002015 if (tail == Py_None) {
2016 /* If tail is Py_None, both get_parent and load_next found
2017 an empty module name: someone called __import__("") or
2018 doctored faulty bytecode */
2019 Py_DECREF(tail);
2020 Py_DECREF(head);
2021 PyErr_SetString(PyExc_ValueError,
2022 "Empty module name");
2023 return NULL;
2024 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002025
2026 if (fromlist != NULL) {
2027 if (fromlist == Py_None || !PyObject_IsTrue(fromlist))
2028 fromlist = NULL;
2029 }
2030
2031 if (fromlist == NULL) {
2032 Py_DECREF(tail);
2033 return head;
2034 }
2035
2036 Py_DECREF(head);
Guido van Rossum9905ef91997-09-08 16:07:11 +00002037 if (!ensure_fromlist(tail, fromlist, buf, buflen, 0)) {
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002038 Py_DECREF(tail);
2039 return NULL;
2040 }
2041
2042 return tail;
2043}
2044
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002045/* For DLL compatibility */
2046#undef PyImport_ImportModuleEx
Guido van Rossum75acc9c1998-03-03 22:26:50 +00002047PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002048PyImport_ImportModuleEx(char *name, PyObject *globals, PyObject *locals,
2049 PyObject *fromlist)
Guido van Rossum75acc9c1998-03-03 22:26:50 +00002050{
2051 PyObject *result;
2052 lock_import();
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002053 result = import_module_level(name, globals, locals, fromlist, -1);
2054 if (unlock_import() < 0) {
2055 Py_XDECREF(result);
2056 PyErr_SetString(PyExc_RuntimeError,
2057 "not holding the import lock");
2058 return NULL;
2059 }
2060 return result;
2061}
2062#define PyImport_ImportModuleEx(n, g, l, f) \
2063 PyImport_ImportModuleLevel(n, g, l, f, -1);
2064
2065PyObject *
2066PyImport_ImportModuleLevel(char *name, PyObject *globals, PyObject *locals,
2067 PyObject *fromlist, int level)
2068{
2069 PyObject *result;
2070 lock_import();
2071 result = import_module_level(name, globals, locals, fromlist, level);
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00002072 if (unlock_import() < 0) {
2073 Py_XDECREF(result);
2074 PyErr_SetString(PyExc_RuntimeError,
2075 "not holding the import lock");
2076 return NULL;
2077 }
Guido van Rossum75acc9c1998-03-03 22:26:50 +00002078 return result;
2079}
2080
Fred Drake87590902004-05-28 20:21:36 +00002081/* Return the package that an import is being performed in. If globals comes
2082 from the module foo.bar.bat (not itself a package), this returns the
2083 sys.modules entry for foo.bar. If globals is from a package's __init__.py,
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00002084 the package's entry in sys.modules is returned, as a borrowed reference.
Fred Drake87590902004-05-28 20:21:36 +00002085
2086 The *name* of the returned package is returned in buf, with the length of
2087 the name in *p_buflen.
2088
2089 If globals doesn't come from a package or a module in a package, or a
2090 corresponding entry is not found in sys.modules, Py_None is returned.
2091*/
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002092static PyObject *
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002093get_parent(PyObject *globals, char *buf, Py_ssize_t *p_buflen, int level)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002094{
2095 static PyObject *namestr = NULL;
2096 static PyObject *pathstr = NULL;
2097 PyObject *modname, *modpath, *modules, *parent;
2098
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002099 if (globals == NULL || !PyDict_Check(globals) || !level)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002100 return Py_None;
2101
2102 if (namestr == NULL) {
2103 namestr = PyString_InternFromString("__name__");
2104 if (namestr == NULL)
2105 return NULL;
2106 }
2107 if (pathstr == NULL) {
2108 pathstr = PyString_InternFromString("__path__");
2109 if (pathstr == NULL)
2110 return NULL;
2111 }
2112
2113 *buf = '\0';
2114 *p_buflen = 0;
2115 modname = PyDict_GetItem(globals, namestr);
2116 if (modname == NULL || !PyString_Check(modname))
2117 return Py_None;
2118
2119 modpath = PyDict_GetItem(globals, pathstr);
2120 if (modpath != NULL) {
Martin v. Löwis725507b2006-03-07 12:08:51 +00002121 Py_ssize_t len = PyString_GET_SIZE(modname);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002122 if (len > MAXPATHLEN) {
2123 PyErr_SetString(PyExc_ValueError,
2124 "Module name too long");
2125 return NULL;
2126 }
2127 strcpy(buf, PyString_AS_STRING(modname));
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002128 }
2129 else {
2130 char *start = PyString_AS_STRING(modname);
2131 char *lastdot = strrchr(start, '.');
Fred Drake4c82b232000-06-30 16:18:57 +00002132 size_t len;
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002133 if (lastdot == NULL && level > 0) {
2134 PyErr_SetString(PyExc_ValueError,
Thomas Wouters89f507f2006-12-13 04:49:30 +00002135 "Attempted relative import in non-package");
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002136 return NULL;
2137 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002138 if (lastdot == NULL)
2139 return Py_None;
2140 len = lastdot - start;
2141 if (len >= MAXPATHLEN) {
2142 PyErr_SetString(PyExc_ValueError,
2143 "Module name too long");
2144 return NULL;
2145 }
2146 strncpy(buf, start, len);
2147 buf[len] = '\0';
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002148 }
2149
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002150 while (--level > 0) {
2151 char *dot = strrchr(buf, '.');
2152 if (dot == NULL) {
2153 PyErr_SetString(PyExc_ValueError,
Thomas Wouters89f507f2006-12-13 04:49:30 +00002154 "Attempted relative import beyond "
2155 "toplevel package");
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002156 return NULL;
2157 }
2158 *dot = '\0';
2159 }
2160 *p_buflen = strlen(buf);
2161
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002162 modules = PyImport_GetModuleDict();
2163 parent = PyDict_GetItemString(modules, buf);
2164 if (parent == NULL)
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002165 PyErr_Format(PyExc_SystemError,
2166 "Parent module '%.200s' not loaded", buf);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002167 return parent;
2168 /* We expect, but can't guarantee, if parent != None, that:
2169 - parent.__name__ == buf
2170 - parent.__dict__ is globals
2171 If this is violated... Who cares? */
2172}
2173
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002174/* altmod is either None or same as mod */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002175static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002176load_next(PyObject *mod, PyObject *altmod, char **p_name, char *buf,
Martin v. Löwis18e16552006-02-15 17:27:45 +00002177 Py_ssize_t *p_buflen)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002178{
2179 char *name = *p_name;
2180 char *dot = strchr(name, '.');
Fred Drake4c82b232000-06-30 16:18:57 +00002181 size_t len;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002182 char *p;
2183 PyObject *result;
2184
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002185 if (strlen(name) == 0) {
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002186 /* completely empty module name should only happen in
2187 'from . import' (or '__import__("")')*/
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002188 Py_INCREF(mod);
2189 *p_name = NULL;
2190 return mod;
2191 }
2192
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002193 if (dot == NULL) {
2194 *p_name = NULL;
2195 len = strlen(name);
2196 }
2197 else {
2198 *p_name = dot+1;
2199 len = dot-name;
2200 }
Guido van Rossum111c20b1998-04-11 17:38:22 +00002201 if (len == 0) {
2202 PyErr_SetString(PyExc_ValueError,
2203 "Empty module name");
2204 return NULL;
2205 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002206
2207 p = buf + *p_buflen;
2208 if (p != buf)
2209 *p++ = '.';
2210 if (p+len-buf >= MAXPATHLEN) {
2211 PyErr_SetString(PyExc_ValueError,
2212 "Module name too long");
2213 return NULL;
2214 }
2215 strncpy(p, name, len);
2216 p[len] = '\0';
2217 *p_buflen = p+len-buf;
2218
2219 result = import_submodule(mod, p, buf);
2220 if (result == Py_None && altmod != mod) {
2221 Py_DECREF(result);
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00002222 /* Here, altmod must be None and mod must not be None */
Guido van Rossum0c819451997-09-07 06:16:57 +00002223 result = import_submodule(altmod, p, p);
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00002224 if (result != NULL && result != Py_None) {
2225 if (mark_miss(buf) != 0) {
2226 Py_DECREF(result);
2227 return NULL;
2228 }
2229 strncpy(buf, name, len);
2230 buf[len] = '\0';
2231 *p_buflen = len;
2232 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002233 }
2234 if (result == NULL)
2235 return NULL;
2236
2237 if (result == Py_None) {
2238 Py_DECREF(result);
2239 PyErr_Format(PyExc_ImportError,
2240 "No module named %.200s", name);
2241 return NULL;
2242 }
2243
2244 return result;
2245}
2246
2247static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002248mark_miss(char *name)
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00002249{
2250 PyObject *modules = PyImport_GetModuleDict();
2251 return PyDict_SetItemString(modules, name, Py_None);
2252}
2253
2254static int
Martin v. Löwis18e16552006-02-15 17:27:45 +00002255ensure_fromlist(PyObject *mod, PyObject *fromlist, char *buf, Py_ssize_t buflen,
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002256 int recursive)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002257{
2258 int i;
2259
2260 if (!PyObject_HasAttrString(mod, "__path__"))
2261 return 1;
2262
2263 for (i = 0; ; i++) {
2264 PyObject *item = PySequence_GetItem(fromlist, i);
2265 int hasit;
2266 if (item == NULL) {
2267 if (PyErr_ExceptionMatches(PyExc_IndexError)) {
2268 PyErr_Clear();
2269 return 1;
2270 }
2271 return 0;
2272 }
2273 if (!PyString_Check(item)) {
2274 PyErr_SetString(PyExc_TypeError,
2275 "Item in ``from list'' not a string");
2276 Py_DECREF(item);
2277 return 0;
2278 }
2279 if (PyString_AS_STRING(item)[0] == '*') {
Guido van Rossum9905ef91997-09-08 16:07:11 +00002280 PyObject *all;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002281 Py_DECREF(item);
Guido van Rossum9905ef91997-09-08 16:07:11 +00002282 /* See if the package defines __all__ */
2283 if (recursive)
2284 continue; /* Avoid endless recursion */
2285 all = PyObject_GetAttrString(mod, "__all__");
2286 if (all == NULL)
2287 PyErr_Clear();
2288 else {
Martin v. Löwis83969ee2004-03-23 16:28:13 +00002289 int ret = ensure_fromlist(mod, all, buf, buflen, 1);
Guido van Rossum9905ef91997-09-08 16:07:11 +00002290 Py_DECREF(all);
Martin v. Löwis83969ee2004-03-23 16:28:13 +00002291 if (!ret)
2292 return 0;
Guido van Rossum9905ef91997-09-08 16:07:11 +00002293 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002294 continue;
2295 }
2296 hasit = PyObject_HasAttr(mod, item);
2297 if (!hasit) {
2298 char *subname = PyString_AS_STRING(item);
2299 PyObject *submod;
2300 char *p;
2301 if (buflen + strlen(subname) >= MAXPATHLEN) {
2302 PyErr_SetString(PyExc_ValueError,
2303 "Module name too long");
2304 Py_DECREF(item);
2305 return 0;
2306 }
2307 p = buf + buflen;
2308 *p++ = '.';
2309 strcpy(p, subname);
2310 submod = import_submodule(mod, subname, buf);
2311 Py_XDECREF(submod);
2312 if (submod == NULL) {
2313 Py_DECREF(item);
2314 return 0;
2315 }
2316 }
2317 Py_DECREF(item);
2318 }
2319
Guido van Rossuma7f2e811997-10-03 15:33:32 +00002320 /* NOTREACHED */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002321}
2322
Neil Schemenauer00b09662003-06-16 21:03:07 +00002323static int
2324add_submodule(PyObject *mod, PyObject *submod, char *fullname, char *subname,
2325 PyObject *modules)
2326{
2327 if (mod == Py_None)
2328 return 1;
2329 /* Irrespective of the success of this load, make a
2330 reference to it in the parent package module. A copy gets
2331 saved in the modules dictionary under the full name, so get a
2332 reference from there, if need be. (The exception is when the
2333 load failed with a SyntaxError -- then there's no trace in
2334 sys.modules. In that case, of course, do nothing extra.) */
2335 if (submod == NULL) {
2336 submod = PyDict_GetItemString(modules, fullname);
2337 if (submod == NULL)
2338 return 1;
2339 }
2340 if (PyModule_Check(mod)) {
2341 /* We can't use setattr here since it can give a
2342 * spurious warning if the submodule name shadows a
2343 * builtin name */
2344 PyObject *dict = PyModule_GetDict(mod);
2345 if (!dict)
2346 return 0;
2347 if (PyDict_SetItemString(dict, subname, submod) < 0)
2348 return 0;
2349 }
2350 else {
2351 if (PyObject_SetAttrString(mod, subname, submod) < 0)
2352 return 0;
2353 }
2354 return 1;
2355}
2356
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002357static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002358import_submodule(PyObject *mod, char *subname, char *fullname)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002359{
Guido van Rossum25ce5661997-08-02 03:10:38 +00002360 PyObject *modules = PyImport_GetModuleDict();
Neil Schemenauer00b09662003-06-16 21:03:07 +00002361 PyObject *m = NULL;
Guido van Rossum74e6a111994-08-29 12:54:38 +00002362
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002363 /* Require:
2364 if mod == None: subname == fullname
2365 else: mod.__name__ + "." + subname == fullname
2366 */
2367
Tim Peters50d8d372001-02-28 05:34:27 +00002368 if ((m = PyDict_GetItemString(modules, fullname)) != NULL) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00002369 Py_INCREF(m);
Guido van Rossum7f9fa971995-01-20 16:53:12 +00002370 }
2371 else {
Just van Rossum52e14d62002-12-30 22:08:05 +00002372 PyObject *path, *loader = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002373 char buf[MAXPATHLEN+1];
2374 struct filedescr *fdp;
2375 FILE *fp = NULL;
2376
Guido van Rossum9c0afe51998-05-19 15:09:05 +00002377 if (mod == Py_None)
2378 path = NULL;
2379 else {
2380 path = PyObject_GetAttrString(mod, "__path__");
2381 if (path == NULL) {
2382 PyErr_Clear();
2383 Py_INCREF(Py_None);
2384 return Py_None;
2385 }
2386 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002387
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002388 buf[0] = '\0';
Just van Rossum52e14d62002-12-30 22:08:05 +00002389 fdp = find_module(fullname, subname, path, buf, MAXPATHLEN+1,
2390 &fp, &loader);
Guido van Rossumb68cd421998-07-01 17:36:26 +00002391 Py_XDECREF(path);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002392 if (fdp == NULL) {
2393 if (!PyErr_ExceptionMatches(PyExc_ImportError))
2394 return NULL;
2395 PyErr_Clear();
2396 Py_INCREF(Py_None);
2397 return Py_None;
2398 }
Just van Rossum52e14d62002-12-30 22:08:05 +00002399 m = load_module(fullname, fp, buf, fdp->type, loader);
2400 Py_XDECREF(loader);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002401 if (fp)
2402 fclose(fp);
Neil Schemenauer00b09662003-06-16 21:03:07 +00002403 if (!add_submodule(mod, m, fullname, subname, modules)) {
2404 Py_XDECREF(m);
2405 m = NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002406 }
Guido van Rossum74e6a111994-08-29 12:54:38 +00002407 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002408
2409 return m;
Guido van Rossum74e6a111994-08-29 12:54:38 +00002410}
2411
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002412
2413/* Re-import a module of any kind and return its module object, WITH
2414 INCREMENTED REFERENCE COUNT */
2415
Guido van Rossum79f25d91997-04-29 20:08:16 +00002416PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002417PyImport_ReloadModule(PyObject *m)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002418{
Guido van Rossumd8faa362007-04-27 19:54:29 +00002419 PyInterpreterState *interp = PyThreadState_Get()->interp;
2420 PyObject *modules_reloading = interp->modules_reloading;
Guido van Rossum25ce5661997-08-02 03:10:38 +00002421 PyObject *modules = PyImport_GetModuleDict();
Guido van Rossumd8faa362007-04-27 19:54:29 +00002422 PyObject *path = NULL, *loader = NULL, *existing_m = NULL;
Guido van Rossum222ef561997-09-06 19:41:09 +00002423 char *name, *subname;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002424 char buf[MAXPATHLEN+1];
2425 struct filedescr *fdp;
2426 FILE *fp = NULL;
Tim Peters1cd70172004-08-02 03:52:12 +00002427 PyObject *newm;
Guido van Rossumd8faa362007-04-27 19:54:29 +00002428
2429 if (modules_reloading == NULL) {
2430 Py_FatalError("PyImport_ReloadModule: "
2431 "no modules_reloading dictionary!");
2432 return NULL;
2433 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002434
Guido van Rossum79f25d91997-04-29 20:08:16 +00002435 if (m == NULL || !PyModule_Check(m)) {
2436 PyErr_SetString(PyExc_TypeError,
2437 "reload() argument must be module");
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002438 return NULL;
2439 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002440 name = PyModule_GetName(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002441 if (name == NULL)
2442 return NULL;
Guido van Rossum25ce5661997-08-02 03:10:38 +00002443 if (m != PyDict_GetItemString(modules, name)) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002444 PyErr_Format(PyExc_ImportError,
2445 "reload(): module %.200s not in sys.modules",
2446 name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002447 return NULL;
2448 }
Guido van Rossumd8faa362007-04-27 19:54:29 +00002449 existing_m = PyDict_GetItemString(modules_reloading, name);
2450 if (existing_m != NULL) {
2451 /* Due to a recursive reload, this module is already
2452 being reloaded. */
2453 Py_INCREF(existing_m);
2454 return existing_m;
2455 }
2456 if (PyDict_SetItemString(modules_reloading, name, m) < 0)
2457 return NULL;
2458
Guido van Rossum222ef561997-09-06 19:41:09 +00002459 subname = strrchr(name, '.');
2460 if (subname == NULL)
2461 subname = name;
2462 else {
2463 PyObject *parentname, *parent;
2464 parentname = PyString_FromStringAndSize(name, (subname-name));
Guido van Rossumd8faa362007-04-27 19:54:29 +00002465 if (parentname == NULL) {
2466 imp_modules_reloading_clear();
Guido van Rossum222ef561997-09-06 19:41:09 +00002467 return NULL;
Guido van Rossumd8faa362007-04-27 19:54:29 +00002468 }
Guido van Rossum222ef561997-09-06 19:41:09 +00002469 parent = PyDict_GetItem(modules, parentname);
2470 if (parent == NULL) {
2471 PyErr_Format(PyExc_ImportError,
2472 "reload(): parent %.200s not in sys.modules",
Georg Brandl0c55f292005-09-14 06:56:20 +00002473 PyString_AS_STRING(parentname));
2474 Py_DECREF(parentname);
Guido van Rossumd8faa362007-04-27 19:54:29 +00002475 imp_modules_reloading_clear();
Guido van Rossum222ef561997-09-06 19:41:09 +00002476 return NULL;
2477 }
Georg Brandl0c55f292005-09-14 06:56:20 +00002478 Py_DECREF(parentname);
Guido van Rossum222ef561997-09-06 19:41:09 +00002479 subname++;
2480 path = PyObject_GetAttrString(parent, "__path__");
2481 if (path == NULL)
2482 PyErr_Clear();
2483 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002484 buf[0] = '\0';
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00002485 fdp = find_module(name, subname, path, buf, MAXPATHLEN+1, &fp, &loader);
Guido van Rossum222ef561997-09-06 19:41:09 +00002486 Py_XDECREF(path);
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00002487
2488 if (fdp == NULL) {
2489 Py_XDECREF(loader);
Guido van Rossumd8faa362007-04-27 19:54:29 +00002490 imp_modules_reloading_clear();
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002491 return NULL;
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00002492 }
2493
2494 newm = load_module(name, fp, buf, fdp->type, loader);
2495 Py_XDECREF(loader);
2496
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002497 if (fp)
2498 fclose(fp);
Tim Peters1cd70172004-08-02 03:52:12 +00002499 if (newm == NULL) {
2500 /* load_module probably removed name from modules because of
2501 * the error. Put back the original module object. We're
2502 * going to return NULL in this case regardless of whether
2503 * replacing name succeeds, so the return value is ignored.
2504 */
2505 PyDict_SetItemString(modules, name, m);
2506 }
Guido van Rossumd8faa362007-04-27 19:54:29 +00002507 imp_modules_reloading_clear();
Tim Peters1cd70172004-08-02 03:52:12 +00002508 return newm;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002509}
2510
2511
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002512/* Higher-level import emulator which emulates the "import" statement
2513 more accurately -- it invokes the __import__() function from the
2514 builtins of the current globals. This means that the import is
2515 done using whatever import hooks are installed in the current
Guido van Rossum6058eb41998-12-21 19:51:00 +00002516 environment, e.g. by "rexec".
2517 A dummy list ["__doc__"] is passed as the 4th argument so that
2518 e.g. PyImport_Import(PyString_FromString("win32com.client.gencache"))
2519 will return <module "gencache"> instead of <module "win32com">. */
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002520
2521PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002522PyImport_Import(PyObject *module_name)
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002523{
2524 static PyObject *silly_list = NULL;
2525 static PyObject *builtins_str = NULL;
2526 static PyObject *import_str = NULL;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002527 PyObject *globals = NULL;
2528 PyObject *import = NULL;
2529 PyObject *builtins = NULL;
2530 PyObject *r = NULL;
2531
2532 /* Initialize constant string objects */
2533 if (silly_list == NULL) {
2534 import_str = PyString_InternFromString("__import__");
2535 if (import_str == NULL)
2536 return NULL;
2537 builtins_str = PyString_InternFromString("__builtins__");
2538 if (builtins_str == NULL)
2539 return NULL;
2540 silly_list = Py_BuildValue("[s]", "__doc__");
2541 if (silly_list == NULL)
2542 return NULL;
2543 }
2544
2545 /* Get the builtins from current globals */
2546 globals = PyEval_GetGlobals();
Guido van Rossum85cd1d62001-02-20 21:43:24 +00002547 if (globals != NULL) {
Guido van Rossum66468561998-10-22 15:46:50 +00002548 Py_INCREF(globals);
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002549 builtins = PyObject_GetItem(globals, builtins_str);
2550 if (builtins == NULL)
2551 goto err;
2552 }
2553 else {
2554 /* No globals -- use standard builtins, and fake globals */
2555 PyErr_Clear();
2556
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002557 builtins = PyImport_ImportModuleLevel("__builtin__",
2558 NULL, NULL, NULL, 0);
Guido van Rossum85cd1d62001-02-20 21:43:24 +00002559 if (builtins == NULL)
2560 return NULL;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002561 globals = Py_BuildValue("{OO}", builtins_str, builtins);
2562 if (globals == NULL)
2563 goto err;
2564 }
2565
2566 /* Get the __import__ function from the builtins */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002567 if (PyDict_Check(builtins)) {
Fred Drakea76ba6e2001-03-06 06:31:15 +00002568 import = PyObject_GetItem(builtins, import_str);
Tim Peters6d6c1a32001-08-02 04:15:00 +00002569 if (import == NULL)
2570 PyErr_SetObject(PyExc_KeyError, import_str);
2571 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002572 else
Fred Drakea76ba6e2001-03-06 06:31:15 +00002573 import = PyObject_GetAttr(builtins, import_str);
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002574 if (import == NULL)
2575 goto err;
2576
Guido van Rossumd8faa362007-04-27 19:54:29 +00002577 /* Call the __import__ function with the proper argument list */
Thomas Wouters477c8d52006-05-27 19:21:47 +00002578 r = PyObject_CallFunctionObjArgs(import, module_name, globals,
2579 globals, silly_list, NULL);
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002580
2581 err:
2582 Py_XDECREF(globals);
2583 Py_XDECREF(builtins);
2584 Py_XDECREF(import);
Tim Peters50d8d372001-02-28 05:34:27 +00002585
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002586 return r;
2587}
2588
2589
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002590/* Module 'imp' provides Python access to the primitives used for
2591 importing modules.
2592*/
2593
Guido van Rossum79f25d91997-04-29 20:08:16 +00002594static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +00002595imp_get_magic(PyObject *self, PyObject *noargs)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002596{
2597 char buf[4];
2598
Guido van Rossum96774c12000-05-01 20:19:08 +00002599 buf[0] = (char) ((pyc_magic >> 0) & 0xff);
2600 buf[1] = (char) ((pyc_magic >> 8) & 0xff);
2601 buf[2] = (char) ((pyc_magic >> 16) & 0xff);
2602 buf[3] = (char) ((pyc_magic >> 24) & 0xff);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002603
Guido van Rossum79f25d91997-04-29 20:08:16 +00002604 return PyString_FromStringAndSize(buf, 4);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002605}
2606
Guido van Rossum79f25d91997-04-29 20:08:16 +00002607static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +00002608imp_get_suffixes(PyObject *self, PyObject *noargs)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002609{
Guido van Rossum79f25d91997-04-29 20:08:16 +00002610 PyObject *list;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002611 struct filedescr *fdp;
2612
Guido van Rossum79f25d91997-04-29 20:08:16 +00002613 list = PyList_New(0);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002614 if (list == NULL)
2615 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002616 for (fdp = _PyImport_Filetab; fdp->suffix != NULL; fdp++) {
2617 PyObject *item = Py_BuildValue("ssi",
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002618 fdp->suffix, fdp->mode, fdp->type);
2619 if (item == NULL) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00002620 Py_DECREF(list);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002621 return NULL;
2622 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002623 if (PyList_Append(list, item) < 0) {
2624 Py_DECREF(list);
2625 Py_DECREF(item);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002626 return NULL;
2627 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002628 Py_DECREF(item);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002629 }
2630 return list;
2631}
2632
Guido van Rossum79f25d91997-04-29 20:08:16 +00002633static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002634call_find_module(char *name, PyObject *path)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002635{
Tim Petersdbd9ba62000-07-09 03:09:57 +00002636 extern int fclose(FILE *);
Guido van Rossum79f25d91997-04-29 20:08:16 +00002637 PyObject *fob, *ret;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002638 struct filedescr *fdp;
2639 char pathname[MAXPATHLEN+1];
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002640 FILE *fp = NULL;
2641
2642 pathname[0] = '\0';
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002643 if (path == Py_None)
2644 path = NULL;
Just van Rossum52e14d62002-12-30 22:08:05 +00002645 fdp = find_module(NULL, name, path, pathname, MAXPATHLEN+1, &fp, NULL);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002646 if (fdp == NULL)
2647 return NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002648 if (fp != NULL) {
2649 fob = PyFile_FromFile(fp, pathname, fdp->mode, fclose);
2650 if (fob == NULL) {
2651 fclose(fp);
2652 return NULL;
2653 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002654 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002655 else {
2656 fob = Py_None;
2657 Py_INCREF(fob);
Tim Peters50d8d372001-02-28 05:34:27 +00002658 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002659 ret = Py_BuildValue("Os(ssi)",
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002660 fob, pathname, fdp->suffix, fdp->mode, fdp->type);
Guido van Rossum79f25d91997-04-29 20:08:16 +00002661 Py_DECREF(fob);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002662 return ret;
2663}
2664
Guido van Rossum79f25d91997-04-29 20:08:16 +00002665static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002666imp_find_module(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002667{
2668 char *name;
2669 PyObject *path = NULL;
Guido van Rossum43713e52000-02-29 13:59:29 +00002670 if (!PyArg_ParseTuple(args, "s|O:find_module", &name, &path))
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002671 return NULL;
2672 return call_find_module(name, path);
2673}
2674
2675static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002676imp_init_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002677{
2678 char *name;
2679 int ret;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002680 PyObject *m;
Guido van Rossum43713e52000-02-29 13:59:29 +00002681 if (!PyArg_ParseTuple(args, "s:init_builtin", &name))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002682 return NULL;
2683 ret = init_builtin(name);
2684 if (ret < 0)
2685 return NULL;
2686 if (ret == 0) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00002687 Py_INCREF(Py_None);
2688 return Py_None;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002689 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002690 m = PyImport_AddModule(name);
2691 Py_XINCREF(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002692 return m;
2693}
2694
Guido van Rossum79f25d91997-04-29 20:08:16 +00002695static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002696imp_init_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002697{
2698 char *name;
2699 int ret;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002700 PyObject *m;
Guido van Rossum43713e52000-02-29 13:59:29 +00002701 if (!PyArg_ParseTuple(args, "s:init_frozen", &name))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002702 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002703 ret = PyImport_ImportFrozenModule(name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002704 if (ret < 0)
2705 return NULL;
2706 if (ret == 0) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00002707 Py_INCREF(Py_None);
2708 return Py_None;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002709 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002710 m = PyImport_AddModule(name);
2711 Py_XINCREF(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002712 return m;
2713}
2714
Guido van Rossum79f25d91997-04-29 20:08:16 +00002715static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002716imp_get_frozen_object(PyObject *self, PyObject *args)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002717{
2718 char *name;
Jack Jansen95ffa231995-10-03 14:38:41 +00002719
Guido van Rossum43713e52000-02-29 13:59:29 +00002720 if (!PyArg_ParseTuple(args, "s:get_frozen_object", &name))
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002721 return NULL;
2722 return get_frozen_object(name);
2723}
2724
Guido van Rossum79f25d91997-04-29 20:08:16 +00002725static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002726imp_is_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002727{
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002728 char *name;
Guido van Rossum43713e52000-02-29 13:59:29 +00002729 if (!PyArg_ParseTuple(args, "s:is_builtin", &name))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002730 return NULL;
Guido van Rossum50ee94f2002-04-09 18:00:58 +00002731 return PyInt_FromLong(is_builtin(name));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002732}
2733
Guido van Rossum79f25d91997-04-29 20:08:16 +00002734static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002735imp_is_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002736{
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002737 char *name;
Guido van Rossum323bf5e1998-06-24 03:54:06 +00002738 struct _frozen *p;
Guido van Rossum43713e52000-02-29 13:59:29 +00002739 if (!PyArg_ParseTuple(args, "s:is_frozen", &name))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002740 return NULL;
Guido van Rossum323bf5e1998-06-24 03:54:06 +00002741 p = find_frozen(name);
Guido van Rossumb8bff3f2002-04-07 06:34:38 +00002742 return PyBool_FromLong((long) (p == NULL ? 0 : p->size));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002743}
2744
2745static FILE *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002746get_file(char *pathname, PyObject *fob, char *mode)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002747{
2748 FILE *fp;
2749 if (fob == NULL) {
Tim Peters86c7d2f2004-08-01 23:24:21 +00002750 if (mode[0] == 'U')
Jeremy Hylton4ae6fae2002-05-30 17:15:25 +00002751 mode = "r" PY_STDIOTEXTMODE;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002752 fp = fopen(pathname, mode);
2753 if (fp == NULL)
Guido van Rossum79f25d91997-04-29 20:08:16 +00002754 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002755 }
2756 else {
Guido van Rossum79f25d91997-04-29 20:08:16 +00002757 fp = PyFile_AsFile(fob);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002758 if (fp == NULL)
Guido van Rossum79f25d91997-04-29 20:08:16 +00002759 PyErr_SetString(PyExc_ValueError,
2760 "bad/closed file object");
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002761 }
2762 return fp;
2763}
2764
Guido van Rossum79f25d91997-04-29 20:08:16 +00002765static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002766imp_load_compiled(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002767{
2768 char *name;
2769 char *pathname;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002770 PyObject *fob = NULL;
2771 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002772 FILE *fp;
Guido van Rossum43713e52000-02-29 13:59:29 +00002773 if (!PyArg_ParseTuple(args, "ss|O!:load_compiled", &name, &pathname,
Guido van Rossum79f25d91997-04-29 20:08:16 +00002774 &PyFile_Type, &fob))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002775 return NULL;
2776 fp = get_file(pathname, fob, "rb");
2777 if (fp == NULL)
2778 return NULL;
2779 m = load_compiled_module(name, pathname, fp);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002780 if (fob == NULL)
2781 fclose(fp);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002782 return m;
2783}
2784
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002785#ifdef HAVE_DYNAMIC_LOADING
2786
Guido van Rossum79f25d91997-04-29 20:08:16 +00002787static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002788imp_load_dynamic(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002789{
2790 char *name;
2791 char *pathname;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002792 PyObject *fob = NULL;
2793 PyObject *m;
Guido van Rossum7faeab31995-07-07 22:50:36 +00002794 FILE *fp = NULL;
Guido van Rossum43713e52000-02-29 13:59:29 +00002795 if (!PyArg_ParseTuple(args, "ss|O!:load_dynamic", &name, &pathname,
Guido van Rossum79f25d91997-04-29 20:08:16 +00002796 &PyFile_Type, &fob))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002797 return NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002798 if (fob) {
Guido van Rossum7faeab31995-07-07 22:50:36 +00002799 fp = get_file(pathname, fob, "r");
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002800 if (fp == NULL)
2801 return NULL;
2802 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002803 m = _PyImport_LoadDynamicModule(name, pathname, fp);
Guido van Rossum7faeab31995-07-07 22:50:36 +00002804 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002805}
2806
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002807#endif /* HAVE_DYNAMIC_LOADING */
2808
Guido van Rossum79f25d91997-04-29 20:08:16 +00002809static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002810imp_load_source(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002811{
2812 char *name;
2813 char *pathname;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002814 PyObject *fob = NULL;
2815 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002816 FILE *fp;
Guido van Rossum43713e52000-02-29 13:59:29 +00002817 if (!PyArg_ParseTuple(args, "ss|O!:load_source", &name, &pathname,
Guido van Rossum79f25d91997-04-29 20:08:16 +00002818 &PyFile_Type, &fob))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002819 return NULL;
2820 fp = get_file(pathname, fob, "r");
2821 if (fp == NULL)
2822 return NULL;
2823 m = load_source_module(name, pathname, fp);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002824 if (fob == NULL)
2825 fclose(fp);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002826 return m;
2827}
2828
Guido van Rossum79f25d91997-04-29 20:08:16 +00002829static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002830imp_load_module(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002831{
2832 char *name;
2833 PyObject *fob;
2834 char *pathname;
2835 char *suffix; /* Unused */
2836 char *mode;
2837 int type;
2838 FILE *fp;
2839
Guido van Rossum43713e52000-02-29 13:59:29 +00002840 if (!PyArg_ParseTuple(args, "sOs(ssi):load_module",
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002841 &name, &fob, &pathname,
2842 &suffix, &mode, &type))
2843 return NULL;
Guido van Rossum5e2c5fa2002-05-30 17:33:07 +00002844 if (*mode) {
2845 /* Mode must start with 'r' or 'U' and must not contain '+'.
2846 Implicit in this test is the assumption that the mode
2847 may contain other modifiers like 'b' or 't'. */
2848
2849 if (!(*mode == 'r' || *mode == 'U') || strchr(mode, '+')) {
Jeremy Hylton4ae6fae2002-05-30 17:15:25 +00002850 PyErr_Format(PyExc_ValueError,
2851 "invalid file open mode %.200s", mode);
2852 return NULL;
Guido van Rossum5e2c5fa2002-05-30 17:33:07 +00002853 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002854 }
2855 if (fob == Py_None)
2856 fp = NULL;
2857 else {
2858 if (!PyFile_Check(fob)) {
2859 PyErr_SetString(PyExc_ValueError,
2860 "load_module arg#2 should be a file or None");
2861 return NULL;
2862 }
2863 fp = get_file(pathname, fob, mode);
2864 if (fp == NULL)
2865 return NULL;
2866 }
Just van Rossum52e14d62002-12-30 22:08:05 +00002867 return load_module(name, fp, pathname, type, NULL);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002868}
2869
2870static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002871imp_load_package(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002872{
2873 char *name;
2874 char *pathname;
Guido van Rossum43713e52000-02-29 13:59:29 +00002875 if (!PyArg_ParseTuple(args, "ss:load_package", &name, &pathname))
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002876 return NULL;
2877 return load_package(name, pathname);
2878}
2879
2880static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002881imp_new_module(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002882{
2883 char *name;
Guido van Rossum43713e52000-02-29 13:59:29 +00002884 if (!PyArg_ParseTuple(args, "s:new_module", &name))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002885 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002886 return PyModule_New(name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002887}
2888
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002889/* Doc strings */
2890
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002891PyDoc_STRVAR(doc_imp,
2892"This module provides the components needed to build your own\n\
2893__import__ function. Undocumented functions are obsolete.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002894
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002895PyDoc_STRVAR(doc_find_module,
2896"find_module(name, [path]) -> (file, filename, (suffix, mode, type))\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002897Search for a module. If path is omitted or None, search for a\n\
2898built-in, frozen or special module and continue search in sys.path.\n\
2899The module name cannot contain '.'; to search for a submodule of a\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002900package, pass the submodule name and the package's __path__.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002901
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002902PyDoc_STRVAR(doc_load_module,
2903"load_module(name, file, filename, (suffix, mode, type)) -> module\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002904Load a module, given information returned by find_module().\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002905The module name must include the full package name, if any.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002906
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002907PyDoc_STRVAR(doc_get_magic,
2908"get_magic() -> string\n\
2909Return the magic number for .pyc or .pyo files.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002910
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002911PyDoc_STRVAR(doc_get_suffixes,
2912"get_suffixes() -> [(suffix, mode, type), ...]\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002913Return a list of (suffix, mode, type) tuples describing the files\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002914that find_module() looks for.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002915
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002916PyDoc_STRVAR(doc_new_module,
2917"new_module(name) -> module\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002918Create a new module. Do not enter it in sys.modules.\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002919The module name must include the full package name, if any.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002920
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002921PyDoc_STRVAR(doc_lock_held,
Tim Petersa7c65092004-08-01 23:26:05 +00002922"lock_held() -> boolean\n\
2923Return True if the import lock is currently held, else False.\n\
2924On platforms without threads, return False.");
Tim Peters69232342001-08-30 05:16:13 +00002925
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00002926PyDoc_STRVAR(doc_acquire_lock,
2927"acquire_lock() -> None\n\
Neal Norwitz2294c0d2003-02-12 23:02:21 +00002928Acquires the interpreter's import lock for the current thread.\n\
2929This lock should be used by import hooks to ensure thread-safety\n\
2930when importing modules.\n\
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00002931On platforms without threads, this function does nothing.");
2932
2933PyDoc_STRVAR(doc_release_lock,
2934"release_lock() -> None\n\
2935Release the interpreter's import lock.\n\
2936On platforms without threads, this function does nothing.");
2937
Guido van Rossum79f25d91997-04-29 20:08:16 +00002938static PyMethodDef imp_methods[] = {
Neal Norwitz08ea61a2003-02-17 18:18:00 +00002939 {"find_module", imp_find_module, METH_VARARGS, doc_find_module},
2940 {"get_magic", imp_get_magic, METH_NOARGS, doc_get_magic},
2941 {"get_suffixes", imp_get_suffixes, METH_NOARGS, doc_get_suffixes},
2942 {"load_module", imp_load_module, METH_VARARGS, doc_load_module},
2943 {"new_module", imp_new_module, METH_VARARGS, doc_new_module},
2944 {"lock_held", imp_lock_held, METH_NOARGS, doc_lock_held},
2945 {"acquire_lock", imp_acquire_lock, METH_NOARGS, doc_acquire_lock},
2946 {"release_lock", imp_release_lock, METH_NOARGS, doc_release_lock},
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002947 /* The rest are obsolete */
Neal Norwitz031829d2002-03-31 14:37:44 +00002948 {"get_frozen_object", imp_get_frozen_object, METH_VARARGS},
2949 {"init_builtin", imp_init_builtin, METH_VARARGS},
2950 {"init_frozen", imp_init_frozen, METH_VARARGS},
2951 {"is_builtin", imp_is_builtin, METH_VARARGS},
2952 {"is_frozen", imp_is_frozen, METH_VARARGS},
2953 {"load_compiled", imp_load_compiled, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002954#ifdef HAVE_DYNAMIC_LOADING
Neal Norwitz031829d2002-03-31 14:37:44 +00002955 {"load_dynamic", imp_load_dynamic, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002956#endif
Neal Norwitz031829d2002-03-31 14:37:44 +00002957 {"load_package", imp_load_package, METH_VARARGS},
Neal Norwitz031829d2002-03-31 14:37:44 +00002958 {"load_source", imp_load_source, METH_VARARGS},
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002959 {NULL, NULL} /* sentinel */
2960};
2961
Guido van Rossum1a8791e1998-08-04 22:46:29 +00002962static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002963setint(PyObject *d, char *name, int value)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002964{
2965 PyObject *v;
2966 int err;
2967
2968 v = PyInt_FromLong((long)value);
2969 err = PyDict_SetItemString(d, name, v);
2970 Py_XDECREF(v);
2971 return err;
2972}
2973
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002974typedef struct {
2975 PyObject_HEAD
2976} NullImporter;
2977
2978static int
2979NullImporter_init(NullImporter *self, PyObject *args, PyObject *kwds)
2980{
2981 char *path;
2982
2983 if (!_PyArg_NoKeywords("NullImporter()", kwds))
2984 return -1;
2985
2986 if (!PyArg_ParseTuple(args, "s:NullImporter",
2987 &path))
2988 return -1;
2989
2990 if (strlen(path) == 0) {
2991 PyErr_SetString(PyExc_ImportError, "empty pathname");
2992 return -1;
2993 } else {
2994#ifndef RISCOS
2995 struct stat statbuf;
2996 int rv;
2997
2998 rv = stat(path, &statbuf);
2999 if (rv == 0) {
3000 /* it exists */
3001 if (S_ISDIR(statbuf.st_mode)) {
3002 /* it's a directory */
3003 PyErr_SetString(PyExc_ImportError,
3004 "existing directory");
3005 return -1;
3006 }
3007 }
3008#else
3009 if (object_exists(path)) {
3010 /* it exists */
3011 if (isdir(path)) {
3012 /* it's a directory */
3013 PyErr_SetString(PyExc_ImportError,
3014 "existing directory");
3015 return -1;
3016 }
3017 }
3018#endif
3019 }
3020 return 0;
3021}
3022
3023static PyObject *
3024NullImporter_find_module(NullImporter *self, PyObject *args)
3025{
3026 Py_RETURN_NONE;
3027}
3028
3029static PyMethodDef NullImporter_methods[] = {
3030 {"find_module", (PyCFunction)NullImporter_find_module, METH_VARARGS,
3031 "Always return None"
3032 },
3033 {NULL} /* Sentinel */
3034};
3035
3036
3037static PyTypeObject NullImporterType = {
3038 PyObject_HEAD_INIT(NULL)
3039 0, /*ob_size*/
3040 "imp.NullImporter", /*tp_name*/
3041 sizeof(NullImporter), /*tp_basicsize*/
3042 0, /*tp_itemsize*/
3043 0, /*tp_dealloc*/
3044 0, /*tp_print*/
3045 0, /*tp_getattr*/
3046 0, /*tp_setattr*/
3047 0, /*tp_compare*/
3048 0, /*tp_repr*/
3049 0, /*tp_as_number*/
3050 0, /*tp_as_sequence*/
3051 0, /*tp_as_mapping*/
3052 0, /*tp_hash */
3053 0, /*tp_call*/
3054 0, /*tp_str*/
3055 0, /*tp_getattro*/
3056 0, /*tp_setattro*/
3057 0, /*tp_as_buffer*/
3058 Py_TPFLAGS_DEFAULT, /*tp_flags*/
3059 "Null importer object", /* tp_doc */
3060 0, /* tp_traverse */
3061 0, /* tp_clear */
3062 0, /* tp_richcompare */
3063 0, /* tp_weaklistoffset */
3064 0, /* tp_iter */
3065 0, /* tp_iternext */
3066 NullImporter_methods, /* tp_methods */
3067 0, /* tp_members */
3068 0, /* tp_getset */
3069 0, /* tp_base */
3070 0, /* tp_dict */
3071 0, /* tp_descr_get */
3072 0, /* tp_descr_set */
3073 0, /* tp_dictoffset */
3074 (initproc)NullImporter_init, /* tp_init */
3075 0, /* tp_alloc */
3076 PyType_GenericNew /* tp_new */
3077};
3078
3079
Jason Tishler6bc06ec2003-09-04 11:59:50 +00003080PyMODINIT_FUNC
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003081initimp(void)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003082{
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003083 PyObject *m, *d;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003084
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003085 if (PyType_Ready(&NullImporterType) < 0)
3086 goto failure;
3087
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003088 m = Py_InitModule4("imp", imp_methods, doc_imp,
3089 NULL, PYTHON_API_VERSION);
Neal Norwitz1ac754f2006-01-19 06:09:39 +00003090 if (m == NULL)
3091 goto failure;
Guido van Rossum79f25d91997-04-29 20:08:16 +00003092 d = PyModule_GetDict(m);
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00003093 if (d == NULL)
3094 goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003095
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003096 if (setint(d, "SEARCH_ERROR", SEARCH_ERROR) < 0) goto failure;
3097 if (setint(d, "PY_SOURCE", PY_SOURCE) < 0) goto failure;
3098 if (setint(d, "PY_COMPILED", PY_COMPILED) < 0) goto failure;
3099 if (setint(d, "C_EXTENSION", C_EXTENSION) < 0) goto failure;
3100 if (setint(d, "PY_RESOURCE", PY_RESOURCE) < 0) goto failure;
3101 if (setint(d, "PKG_DIRECTORY", PKG_DIRECTORY) < 0) goto failure;
3102 if (setint(d, "C_BUILTIN", C_BUILTIN) < 0) goto failure;
3103 if (setint(d, "PY_FROZEN", PY_FROZEN) < 0) goto failure;
Guido van Rossum0f84a341998-08-06 13:36:01 +00003104 if (setint(d, "PY_CODERESOURCE", PY_CODERESOURCE) < 0) goto failure;
Just van Rossum52e14d62002-12-30 22:08:05 +00003105 if (setint(d, "IMP_HOOK", IMP_HOOK) < 0) goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003106
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003107 Py_INCREF(&NullImporterType);
3108 PyModule_AddObject(m, "NullImporter", (PyObject *)&NullImporterType);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003109 failure:
3110 ;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003111}
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003112
3113
Guido van Rossumb18618d2000-05-03 23:44:39 +00003114/* API for embedding applications that want to add their own entries
3115 to the table of built-in modules. This should normally be called
3116 *before* Py_Initialize(). When the table resize fails, -1 is
3117 returned and the existing table is unchanged.
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003118
3119 After a similar function by Just van Rossum. */
3120
3121int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003122PyImport_ExtendInittab(struct _inittab *newtab)
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003123{
3124 static struct _inittab *our_copy = NULL;
3125 struct _inittab *p;
3126 int i, n;
3127
3128 /* Count the number of entries in both tables */
3129 for (n = 0; newtab[n].name != NULL; n++)
3130 ;
3131 if (n == 0)
3132 return 0; /* Nothing to do */
3133 for (i = 0; PyImport_Inittab[i].name != NULL; i++)
3134 ;
3135
3136 /* Allocate new memory for the combined table */
Guido van Rossumb18618d2000-05-03 23:44:39 +00003137 p = our_copy;
3138 PyMem_RESIZE(p, struct _inittab, i+n+1);
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003139 if (p == NULL)
3140 return -1;
3141
3142 /* Copy the tables into the new memory */
3143 if (our_copy != PyImport_Inittab)
3144 memcpy(p, PyImport_Inittab, (i+1) * sizeof(struct _inittab));
3145 PyImport_Inittab = our_copy = p;
3146 memcpy(p+i, newtab, (n+1) * sizeof(struct _inittab));
3147
3148 return 0;
3149}
3150
3151/* Shorthand to add a single entry given a name and a function */
3152
3153int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003154PyImport_AppendInittab(char *name, void (*initfunc)(void))
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003155{
3156 struct _inittab newtab[2];
3157
3158 memset(newtab, '\0', sizeof newtab);
3159
3160 newtab[0].name = name;
3161 newtab[0].initfunc = initfunc;
3162
3163 return PyImport_ExtendInittab(newtab);
3164}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00003165
3166#ifdef __cplusplus
3167}
3168#endif