blob: e1a80f48d5e6c71473c2775f1b22c31e357aec9d [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++) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00001255 PyObject *v = PyList_GetItem(path, i);
Guido van Rossumf15a29f2007-05-04 00:41:39 +00001256 PyObject *origv = v;
Guido van Rossum6262cc72007-05-09 23:29:27 +00001257 const char *base;
Guido van Rossumf15a29f2007-05-04 00:41:39 +00001258 Py_ssize_t size;
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001259 if (!v)
1260 return NULL;
Guido van Rossum6262cc72007-05-09 23:29:27 +00001261 if (PyObject_AsCharBuffer(v, &base, &size) < 0)
1262 return NULL;
Guido van Rossumf15a29f2007-05-04 00:41:39 +00001263 len = size;
Walter Dörwald3430d702002-06-17 10:43:59 +00001264 if (len + 2 + namelen + MAXSUFFIXSIZE >= buflen) {
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001265 continue; /* Too long */
Walter Dörwald3430d702002-06-17 10:43:59 +00001266 }
Guido van Rossumf15a29f2007-05-04 00:41:39 +00001267 strcpy(buf, base);
Walter Dörwald3430d702002-06-17 10:43:59 +00001268 if (strlen(buf) != len) {
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001269 continue; /* v contains '\0' */
Walter Dörwald3430d702002-06-17 10:43:59 +00001270 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001271
1272 /* sys.path_hooks import hook */
1273 if (p_loader != NULL) {
1274 PyObject *importer;
1275
1276 importer = get_path_importer(path_importer_cache,
Guido van Rossumf15a29f2007-05-04 00:41:39 +00001277 path_hooks, origv);
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001278 if (importer == NULL) {
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001279 return NULL;
Thomas Wouters477c8d52006-05-27 19:21:47 +00001280 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001281 /* Note: importer is a borrowed reference */
1282 if (importer != Py_None) {
Just van Rossum52e14d62002-12-30 22:08:05 +00001283 PyObject *loader;
1284 loader = PyObject_CallMethod(importer,
1285 "find_module",
1286 "s", fullname);
1287 if (loader == NULL)
1288 return NULL; /* error */
1289 if (loader != Py_None) {
1290 /* a loader was found */
1291 *p_loader = loader;
1292 return &importhookdescr;
1293 }
1294 Py_DECREF(loader);
Thomas Wouters477c8d52006-05-27 19:21:47 +00001295 continue;
Just van Rossum52e14d62002-12-30 22:08:05 +00001296 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001297 }
Thomas Wouters477c8d52006-05-27 19:21:47 +00001298 /* no hook was found, use builtin import */
Just van Rossum52e14d62002-12-30 22:08:05 +00001299
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001300 if (len > 0 && buf[len-1] != SEP
1301#ifdef ALTSEP
1302 && buf[len-1] != ALTSEP
1303#endif
1304 )
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001305 buf[len++] = SEP;
Guido van Rossum215c3402000-11-13 17:26:32 +00001306 strcpy(buf+len, name);
1307 len += namelen;
Tim Peters50d8d372001-02-28 05:34:27 +00001308
1309 /* Check for package import (buf holds a directory name,
1310 and there's an __init__ module in that directory */
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001311#ifdef HAVE_STAT
Walter Dörwald3430d702002-06-17 10:43:59 +00001312 if (stat(buf, &statbuf) == 0 && /* it exists */
1313 S_ISDIR(statbuf.st_mode) && /* it's a directory */
Thomas Wouters477c8d52006-05-27 19:21:47 +00001314 case_ok(buf, len, namelen, name)) { /* case matches */
1315 if (find_init_module(buf)) { /* and has __init__.py */
Thomas Wouters477c8d52006-05-27 19:21:47 +00001316 return &fd_package;
1317 }
1318 else {
1319 char warnstr[MAXPATHLEN+80];
1320 sprintf(warnstr, "Not importing directory "
1321 "'%.*s': missing __init__.py",
1322 MAXPATHLEN, buf);
1323 if (PyErr_Warn(PyExc_ImportWarning,
1324 warnstr)) {
Thomas Wouters477c8d52006-05-27 19:21:47 +00001325 return NULL;
1326 }
1327 }
Walter Dörwald3430d702002-06-17 10:43:59 +00001328 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001329#else
1330 /* XXX How are you going to test for directories? */
Guido van Rossum48a680c2001-03-02 06:34:14 +00001331#ifdef RISCOS
Guido van Rossume2ae77b2001-10-24 20:42:55 +00001332 if (isdir(buf) &&
Walter Dörwald3430d702002-06-17 10:43:59 +00001333 case_ok(buf, len, namelen, name)) {
Thomas Wouters477c8d52006-05-27 19:21:47 +00001334 if (find_init_module(buf)) {
Thomas Wouters477c8d52006-05-27 19:21:47 +00001335 return &fd_package;
1336 }
1337 else {
1338 char warnstr[MAXPATHLEN+80];
1339 sprintf(warnstr, "Not importing directory "
1340 "'%.*s': missing __init__.py",
1341 MAXPATHLEN, buf);
1342 if (PyErr_Warn(PyExc_ImportWarning,
1343 warnstr)) {
Thomas Wouters477c8d52006-05-27 19:21:47 +00001344 return NULL;
1345 }
Walter Dörwald3430d702002-06-17 10:43:59 +00001346 }
Guido van Rossum48a680c2001-03-02 06:34:14 +00001347#endif
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001348#endif
Andrew MacIntyred9400542002-02-26 11:41:34 +00001349#if defined(PYOS_OS2)
1350 /* take a snapshot of the module spec for restoration
1351 * after the 8 character DLL hackery
1352 */
1353 saved_buf = strdup(buf);
1354 saved_len = len;
1355 saved_namelen = namelen;
1356#endif /* PYOS_OS2 */
Guido van Rossum79f25d91997-04-29 20:08:16 +00001357 for (fdp = _PyImport_Filetab; fdp->suffix != NULL; fdp++) {
Andrew MacIntyred9400542002-02-26 11:41:34 +00001358#if defined(PYOS_OS2)
Jeremy Hylton4ae6fae2002-05-30 17:15:25 +00001359 /* OS/2 limits DLLs to 8 character names (w/o
1360 extension)
Andrew MacIntyred9400542002-02-26 11:41:34 +00001361 * so if the name is longer than that and its a
1362 * dynamically loaded module we're going to try,
1363 * truncate the name before trying
1364 */
Just van Rossum52e14d62002-12-30 22:08:05 +00001365 if (strlen(subname) > 8) {
Andrew MacIntyred9400542002-02-26 11:41:34 +00001366 /* is this an attempt to load a C extension? */
Jeremy Hylton4ae6fae2002-05-30 17:15:25 +00001367 const struct filedescr *scan;
1368 scan = _PyImport_DynLoadFiletab;
Andrew MacIntyred9400542002-02-26 11:41:34 +00001369 while (scan->suffix != NULL) {
Jeremy Hylton4ae6fae2002-05-30 17:15:25 +00001370 if (!strcmp(scan->suffix, fdp->suffix))
Andrew MacIntyred9400542002-02-26 11:41:34 +00001371 break;
1372 else
1373 scan++;
1374 }
1375 if (scan->suffix != NULL) {
1376 /* yes, so truncate the name */
1377 namelen = 8;
Just van Rossum52e14d62002-12-30 22:08:05 +00001378 len -= strlen(subname) - namelen;
Andrew MacIntyred9400542002-02-26 11:41:34 +00001379 buf[len] = '\0';
1380 }
1381 }
1382#endif /* PYOS_OS2 */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001383 strcpy(buf+len, fdp->suffix);
Guido van Rossum79f25d91997-04-29 20:08:16 +00001384 if (Py_VerboseFlag > 1)
Guido van Rossum2f3667a1998-10-12 18:23:55 +00001385 PySys_WriteStderr("# trying %s\n", buf);
Jack Jansenc88da1f2002-05-28 10:58:19 +00001386 filemode = fdp->mode;
Tim Peters86c7d2f2004-08-01 23:24:21 +00001387 if (filemode[0] == 'U')
Jeremy Hylton4ae6fae2002-05-30 17:15:25 +00001388 filemode = "r" PY_STDIOTEXTMODE;
Jack Jansenc88da1f2002-05-28 10:58:19 +00001389 fp = fopen(buf, filemode);
Tim Peters50d8d372001-02-28 05:34:27 +00001390 if (fp != NULL) {
1391 if (case_ok(buf, len, namelen, name))
1392 break;
1393 else { /* continue search */
1394 fclose(fp);
1395 fp = NULL;
Barry Warsaw914a0b12001-02-02 19:12:16 +00001396 }
Barry Warsaw914a0b12001-02-02 19:12:16 +00001397 }
Andrew MacIntyred9400542002-02-26 11:41:34 +00001398#if defined(PYOS_OS2)
1399 /* restore the saved snapshot */
1400 strcpy(buf, saved_buf);
1401 len = saved_len;
1402 namelen = saved_namelen;
1403#endif
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001404 }
Andrew MacIntyred9400542002-02-26 11:41:34 +00001405#if defined(PYOS_OS2)
1406 /* don't need/want the module name snapshot anymore */
1407 if (saved_buf)
1408 {
1409 free(saved_buf);
1410 saved_buf = NULL;
1411 }
1412#endif
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001413 if (fp != NULL)
1414 break;
1415 }
1416 if (fp == NULL) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001417 PyErr_Format(PyExc_ImportError,
1418 "No module named %.200s", name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001419 return NULL;
1420 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001421 *p_fp = fp;
1422 return fdp;
1423}
1424
Raymond Hettingerdb29e0f2004-10-07 06:46:25 +00001425/* Helpers for main.c
1426 * Find the source file corresponding to a named module
1427 */
1428struct filedescr *
1429_PyImport_FindModule(const char *name, PyObject *path, char *buf,
1430 size_t buflen, FILE **p_fp, PyObject **p_loader)
1431{
1432 return find_module((char *) name, (char *) name, path,
1433 buf, buflen, p_fp, p_loader);
1434}
1435
1436PyAPI_FUNC(int) _PyImport_IsScript(struct filedescr * fd)
1437{
1438 return fd->type == PY_SOURCE || fd->type == PY_COMPILED;
1439}
1440
Martin v. Löwis18e16552006-02-15 17:27:45 +00001441/* case_ok(char* buf, Py_ssize_t len, Py_ssize_t namelen, char* name)
Tim Petersd1e87a82001-03-01 18:12:00 +00001442 * The arguments here are tricky, best shown by example:
1443 * /a/b/c/d/e/f/g/h/i/j/k/some_long_module_name.py\0
1444 * ^ ^ ^ ^
1445 * |--------------------- buf ---------------------|
1446 * |------------------- len ------------------|
1447 * |------ name -------|
1448 * |----- namelen -----|
1449 * buf is the full path, but len only counts up to (& exclusive of) the
1450 * extension. name is the module name, also exclusive of extension.
1451 *
1452 * We've already done a successful stat() or fopen() on buf, so know that
1453 * there's some match, possibly case-insensitive.
1454 *
Tim Peters50d8d372001-02-28 05:34:27 +00001455 * case_ok() is to return 1 if there's a case-sensitive match for
1456 * name, else 0. case_ok() is also to return 1 if envar PYTHONCASEOK
1457 * exists.
Tim Petersd1e87a82001-03-01 18:12:00 +00001458 *
Tim Peters50d8d372001-02-28 05:34:27 +00001459 * case_ok() is used to implement case-sensitive import semantics even
1460 * on platforms with case-insensitive filesystems. It's trivial to implement
1461 * for case-sensitive filesystems. It's pretty much a cross-platform
1462 * nightmare for systems with case-insensitive filesystems.
1463 */
Guido van Rossum0980bd91998-02-13 17:18:36 +00001464
Tim Peters50d8d372001-02-28 05:34:27 +00001465/* First we may need a pile of platform-specific header files; the sequence
1466 * of #if's here should match the sequence in the body of case_ok().
1467 */
Jason Tishler7961aa62005-05-20 00:56:54 +00001468#if defined(MS_WINDOWS)
Guido van Rossum0980bd91998-02-13 17:18:36 +00001469#include <windows.h>
Guido van Rossum4c3f57c2001-01-10 20:40:46 +00001470
Tim Peters50d8d372001-02-28 05:34:27 +00001471#elif defined(DJGPP)
1472#include <dir.h>
1473
Jason Tishler7961aa62005-05-20 00:56:54 +00001474#elif (defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) && defined(HAVE_DIRENT_H)
Tim Peters430f5d42001-03-01 01:30:56 +00001475#include <sys/types.h>
1476#include <dirent.h>
1477
Andrew MacIntyred9400542002-02-26 11:41:34 +00001478#elif defined(PYOS_OS2)
1479#define INCL_DOS
1480#define INCL_DOSERRORS
1481#define INCL_NOPMAPI
1482#include <os2.h>
1483
Guido van Rossume2ae77b2001-10-24 20:42:55 +00001484#elif defined(RISCOS)
1485#include "oslib/osfscontrol.h"
Tim Peters50d8d372001-02-28 05:34:27 +00001486#endif
1487
Guido van Rossum0980bd91998-02-13 17:18:36 +00001488static int
Martin v. Löwis18e16552006-02-15 17:27:45 +00001489case_ok(char *buf, Py_ssize_t len, Py_ssize_t namelen, char *name)
Guido van Rossum0980bd91998-02-13 17:18:36 +00001490{
Tim Peters50d8d372001-02-28 05:34:27 +00001491/* Pick a platform-specific implementation; the sequence of #if's here should
1492 * match the sequence just above.
1493 */
1494
Jason Tishler7961aa62005-05-20 00:56:54 +00001495/* MS_WINDOWS */
1496#if defined(MS_WINDOWS)
Guido van Rossum0980bd91998-02-13 17:18:36 +00001497 WIN32_FIND_DATA data;
1498 HANDLE h;
Tim Peters50d8d372001-02-28 05:34:27 +00001499
Neil Schemenauer7d4bb9f2001-07-23 16:30:27 +00001500 if (Py_GETENV("PYTHONCASEOK") != NULL)
Guido van Rossum0980bd91998-02-13 17:18:36 +00001501 return 1;
Tim Peters50d8d372001-02-28 05:34:27 +00001502
Guido van Rossum0980bd91998-02-13 17:18:36 +00001503 h = FindFirstFile(buf, &data);
1504 if (h == INVALID_HANDLE_VALUE) {
1505 PyErr_Format(PyExc_NameError,
1506 "Can't find file for module %.100s\n(filename %.300s)",
1507 name, buf);
1508 return 0;
1509 }
1510 FindClose(h);
Tim Peters50d8d372001-02-28 05:34:27 +00001511 return strncmp(data.cFileName, name, namelen) == 0;
1512
1513/* DJGPP */
1514#elif defined(DJGPP)
1515 struct ffblk ffblk;
1516 int done;
1517
Neil Schemenauer7d4bb9f2001-07-23 16:30:27 +00001518 if (Py_GETENV("PYTHONCASEOK") != NULL)
Guido van Rossum323bf5e1998-06-24 03:54:06 +00001519 return 1;
Tim Peters50d8d372001-02-28 05:34:27 +00001520
1521 done = findfirst(buf, &ffblk, FA_ARCH|FA_RDONLY|FA_HIDDEN|FA_DIREC);
1522 if (done) {
Guido van Rossum0980bd91998-02-13 17:18:36 +00001523 PyErr_Format(PyExc_NameError,
Tim Peters50d8d372001-02-28 05:34:27 +00001524 "Can't find file for module %.100s\n(filename %.300s)",
Guido van Rossum0980bd91998-02-13 17:18:36 +00001525 name, buf);
1526 return 0;
1527 }
Tim Peters50d8d372001-02-28 05:34:27 +00001528 return strncmp(ffblk.ff_name, name, namelen) == 0;
Guido van Rossum0980bd91998-02-13 17:18:36 +00001529
Jason Tishler7961aa62005-05-20 00:56:54 +00001530/* new-fangled macintosh (macosx) or Cygwin */
1531#elif (defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) && defined(HAVE_DIRENT_H)
Tim Peters430f5d42001-03-01 01:30:56 +00001532 DIR *dirp;
1533 struct dirent *dp;
Tim Petersd1e87a82001-03-01 18:12:00 +00001534 char dirname[MAXPATHLEN + 1];
1535 const int dirlen = len - namelen - 1; /* don't want trailing SEP */
Tim Peters430f5d42001-03-01 01:30:56 +00001536
Neil Schemenauer7d4bb9f2001-07-23 16:30:27 +00001537 if (Py_GETENV("PYTHONCASEOK") != NULL)
Tim Petersdbe6ebb2001-03-01 08:47:29 +00001538 return 1;
1539
Tim Petersd1e87a82001-03-01 18:12:00 +00001540 /* Copy the dir component into dirname; substitute "." if empty */
1541 if (dirlen <= 0) {
1542 dirname[0] = '.';
1543 dirname[1] = '\0';
Tim Peters430f5d42001-03-01 01:30:56 +00001544 }
1545 else {
Tim Petersd1e87a82001-03-01 18:12:00 +00001546 assert(dirlen <= MAXPATHLEN);
1547 memcpy(dirname, buf, dirlen);
1548 dirname[dirlen] = '\0';
Tim Peters430f5d42001-03-01 01:30:56 +00001549 }
1550 /* Open the directory and search the entries for an exact match. */
Tim Petersd1e87a82001-03-01 18:12:00 +00001551 dirp = opendir(dirname);
Tim Peters430f5d42001-03-01 01:30:56 +00001552 if (dirp) {
Tim Peters677898a2001-03-02 03:28:03 +00001553 char *nameWithExt = buf + len - namelen;
Tim Peters430f5d42001-03-01 01:30:56 +00001554 while ((dp = readdir(dirp)) != NULL) {
Tim Petersdbe6ebb2001-03-01 08:47:29 +00001555 const int thislen =
Tim Peters430f5d42001-03-01 01:30:56 +00001556#ifdef _DIRENT_HAVE_D_NAMELEN
Tim Petersdbe6ebb2001-03-01 08:47:29 +00001557 dp->d_namlen;
Tim Peters430f5d42001-03-01 01:30:56 +00001558#else
Tim Petersdbe6ebb2001-03-01 08:47:29 +00001559 strlen(dp->d_name);
Tim Peters430f5d42001-03-01 01:30:56 +00001560#endif
Tim Petersd1e87a82001-03-01 18:12:00 +00001561 if (thislen >= namelen &&
Tim Peters677898a2001-03-02 03:28:03 +00001562 strcmp(dp->d_name, nameWithExt) == 0) {
Tim Peters430f5d42001-03-01 01:30:56 +00001563 (void)closedir(dirp);
1564 return 1; /* Found */
1565 }
1566 }
Tim Petersdbe6ebb2001-03-01 08:47:29 +00001567 (void)closedir(dirp);
Tim Peters430f5d42001-03-01 01:30:56 +00001568 }
Tim Peters430f5d42001-03-01 01:30:56 +00001569 return 0 ; /* Not found */
Tim Peters430f5d42001-03-01 01:30:56 +00001570
Guido van Rossume2ae77b2001-10-24 20:42:55 +00001571/* RISC OS */
1572#elif defined(RISCOS)
1573 char canon[MAXPATHLEN+1]; /* buffer for the canonical form of the path */
1574 char buf2[MAXPATHLEN+2];
1575 char *nameWithExt = buf+len-namelen;
1576 int canonlen;
1577 os_error *e;
1578
1579 if (Py_GETENV("PYTHONCASEOK") != NULL)
1580 return 1;
1581
1582 /* workaround:
1583 append wildcard, otherwise case of filename wouldn't be touched */
1584 strcpy(buf2, buf);
1585 strcat(buf2, "*");
1586
1587 e = xosfscontrol_canonicalise_path(buf2,canon,0,0,MAXPATHLEN+1,&canonlen);
1588 canonlen = MAXPATHLEN+1-canonlen;
1589 if (e || canonlen<=0 || canonlen>(MAXPATHLEN+1) )
1590 return 0;
1591 if (strcmp(nameWithExt, canon+canonlen-strlen(nameWithExt))==0)
1592 return 1; /* match */
1593
1594 return 0;
1595
Andrew MacIntyred9400542002-02-26 11:41:34 +00001596/* OS/2 */
1597#elif defined(PYOS_OS2)
1598 HDIR hdir = 1;
1599 ULONG srchcnt = 1;
1600 FILEFINDBUF3 ffbuf;
1601 APIRET rc;
1602
1603 if (getenv("PYTHONCASEOK") != NULL)
1604 return 1;
1605
1606 rc = DosFindFirst(buf,
1607 &hdir,
1608 FILE_READONLY | FILE_HIDDEN | FILE_SYSTEM | FILE_DIRECTORY,
1609 &ffbuf, sizeof(ffbuf),
1610 &srchcnt,
1611 FIL_STANDARD);
1612 if (rc != NO_ERROR)
1613 return 0;
1614 return strncmp(ffbuf.achName, name, namelen) == 0;
1615
Tim Peters50d8d372001-02-28 05:34:27 +00001616/* assuming it's a case-sensitive filesystem, so there's nothing to do! */
1617#else
Guido van Rossum0980bd91998-02-13 17:18:36 +00001618 return 1;
Guido van Rossum0980bd91998-02-13 17:18:36 +00001619
Guido van Rossum4d1b3b91998-02-13 23:27:59 +00001620#endif
Tim Peters50d8d372001-02-28 05:34:27 +00001621}
Guido van Rossum4d1b3b91998-02-13 23:27:59 +00001622
Guido van Rossum0980bd91998-02-13 17:18:36 +00001623
Guido van Rossum197346f1997-10-31 18:38:52 +00001624#ifdef HAVE_STAT
1625/* Helper to look for __init__.py or __init__.py[co] in potential package */
1626static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001627find_init_module(char *buf)
Guido van Rossum197346f1997-10-31 18:38:52 +00001628{
Tim Peters0f9431f2001-07-05 03:47:53 +00001629 const size_t save_len = strlen(buf);
Fred Drake4c82b232000-06-30 16:18:57 +00001630 size_t i = save_len;
Tim Peters0f9431f2001-07-05 03:47:53 +00001631 char *pname; /* pointer to start of __init__ */
Guido van Rossum197346f1997-10-31 18:38:52 +00001632 struct stat statbuf;
1633
Tim Peters0f9431f2001-07-05 03:47:53 +00001634/* For calling case_ok(buf, len, namelen, name):
1635 * /a/b/c/d/e/f/g/h/i/j/k/some_long_module_name.py\0
1636 * ^ ^ ^ ^
1637 * |--------------------- buf ---------------------|
1638 * |------------------- len ------------------|
1639 * |------ name -------|
1640 * |----- namelen -----|
1641 */
Guido van Rossum197346f1997-10-31 18:38:52 +00001642 if (save_len + 13 >= MAXPATHLEN)
1643 return 0;
1644 buf[i++] = SEP;
Tim Peters0f9431f2001-07-05 03:47:53 +00001645 pname = buf + i;
1646 strcpy(pname, "__init__.py");
Guido van Rossum197346f1997-10-31 18:38:52 +00001647 if (stat(buf, &statbuf) == 0) {
Tim Peters0f9431f2001-07-05 03:47:53 +00001648 if (case_ok(buf,
1649 save_len + 9, /* len("/__init__") */
1650 8, /* len("__init__") */
1651 pname)) {
1652 buf[save_len] = '\0';
1653 return 1;
1654 }
Guido van Rossum197346f1997-10-31 18:38:52 +00001655 }
Tim Peters0f9431f2001-07-05 03:47:53 +00001656 i += strlen(pname);
1657 strcpy(buf+i, Py_OptimizeFlag ? "o" : "c");
Guido van Rossum197346f1997-10-31 18:38:52 +00001658 if (stat(buf, &statbuf) == 0) {
Tim Peters0f9431f2001-07-05 03:47:53 +00001659 if (case_ok(buf,
1660 save_len + 9, /* len("/__init__") */
1661 8, /* len("__init__") */
1662 pname)) {
1663 buf[save_len] = '\0';
1664 return 1;
1665 }
Guido van Rossum197346f1997-10-31 18:38:52 +00001666 }
1667 buf[save_len] = '\0';
1668 return 0;
1669}
Guido van Rossum48a680c2001-03-02 06:34:14 +00001670
1671#else
1672
1673#ifdef RISCOS
1674static int
1675find_init_module(buf)
1676 char *buf;
1677{
1678 int save_len = strlen(buf);
1679 int i = save_len;
1680
1681 if (save_len + 13 >= MAXPATHLEN)
1682 return 0;
1683 buf[i++] = SEP;
1684 strcpy(buf+i, "__init__/py");
1685 if (isfile(buf)) {
1686 buf[save_len] = '\0';
1687 return 1;
1688 }
1689
1690 if (Py_OptimizeFlag)
1691 strcpy(buf+i, "o");
1692 else
1693 strcpy(buf+i, "c");
1694 if (isfile(buf)) {
1695 buf[save_len] = '\0';
1696 return 1;
1697 }
1698 buf[save_len] = '\0';
1699 return 0;
1700}
1701#endif /*RISCOS*/
1702
Guido van Rossum197346f1997-10-31 18:38:52 +00001703#endif /* HAVE_STAT */
1704
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001705
Tim Petersdbd9ba62000-07-09 03:09:57 +00001706static int init_builtin(char *); /* Forward */
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001707
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001708/* Load an external module using the default search path and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001709 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001710
Guido van Rossum79f25d91997-04-29 20:08:16 +00001711static PyObject *
Just van Rossum52e14d62002-12-30 22:08:05 +00001712load_module(char *name, FILE *fp, char *buf, int type, PyObject *loader)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001713{
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001714 PyObject *modules;
Guido van Rossum79f25d91997-04-29 20:08:16 +00001715 PyObject *m;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001716 int err;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001717
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001718 /* First check that there's an open file (if we need one) */
1719 switch (type) {
1720 case PY_SOURCE:
1721 case PY_COMPILED:
1722 if (fp == NULL) {
1723 PyErr_Format(PyExc_ValueError,
1724 "file object required for import (type code %d)",
1725 type);
1726 return NULL;
1727 }
1728 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001729
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001730 switch (type) {
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001731
1732 case PY_SOURCE:
1733 m = load_source_module(name, buf, fp);
1734 break;
1735
1736 case PY_COMPILED:
1737 m = load_compiled_module(name, buf, fp);
1738 break;
1739
Guido van Rossum96a8fb71999-12-22 14:09:35 +00001740#ifdef HAVE_DYNAMIC_LOADING
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001741 case C_EXTENSION:
Guido van Rossum79f25d91997-04-29 20:08:16 +00001742 m = _PyImport_LoadDynamicModule(name, buf, fp);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001743 break;
Guido van Rossum96a8fb71999-12-22 14:09:35 +00001744#endif
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001745
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001746 case PKG_DIRECTORY:
1747 m = load_package(name, buf);
1748 break;
1749
1750 case C_BUILTIN:
1751 case PY_FROZEN:
Guido van Rossuma5568d31998-03-05 03:45:08 +00001752 if (buf != NULL && buf[0] != '\0')
1753 name = buf;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001754 if (type == C_BUILTIN)
1755 err = init_builtin(name);
1756 else
1757 err = PyImport_ImportFrozenModule(name);
1758 if (err < 0)
Guido van Rossuma86f77d1997-09-09 18:53:47 +00001759 return NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001760 if (err == 0) {
1761 PyErr_Format(PyExc_ImportError,
1762 "Purported %s module %.200s not found",
1763 type == C_BUILTIN ?
1764 "builtin" : "frozen",
1765 name);
Guido van Rossuma86f77d1997-09-09 18:53:47 +00001766 return NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001767 }
1768 modules = PyImport_GetModuleDict();
1769 m = PyDict_GetItemString(modules, name);
1770 if (m == NULL) {
1771 PyErr_Format(
1772 PyExc_ImportError,
1773 "%s module %.200s not properly initialized",
1774 type == C_BUILTIN ?
1775 "builtin" : "frozen",
1776 name);
Guido van Rossuma86f77d1997-09-09 18:53:47 +00001777 return NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001778 }
1779 Py_INCREF(m);
1780 break;
1781
Just van Rossum52e14d62002-12-30 22:08:05 +00001782 case IMP_HOOK: {
1783 if (loader == NULL) {
1784 PyErr_SetString(PyExc_ImportError,
1785 "import hook without loader");
1786 return NULL;
1787 }
1788 m = PyObject_CallMethod(loader, "load_module", "s", name);
1789 break;
1790 }
1791
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001792 default:
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001793 PyErr_Format(PyExc_ImportError,
1794 "Don't know how to import %.200s (type code %d)",
1795 name, type);
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001796 m = NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001797
1798 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001799
1800 return m;
1801}
1802
1803
1804/* Initialize a built-in module.
Thomas Wouters89f507f2006-12-13 04:49:30 +00001805 Return 1 for success, 0 if the module is not found, and -1 with
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001806 an exception set if the initialization failed. */
Guido van Rossum7f133ed1991-02-19 12:23:57 +00001807
Guido van Rossum7f133ed1991-02-19 12:23:57 +00001808static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001809init_builtin(char *name)
Guido van Rossum7f133ed1991-02-19 12:23:57 +00001810{
Guido van Rossum25ce5661997-08-02 03:10:38 +00001811 struct _inittab *p;
Guido van Rossum25ce5661997-08-02 03:10:38 +00001812
Greg Ward201baee2001-10-04 14:52:06 +00001813 if (_PyImport_FindExtension(name, name) != NULL)
Guido van Rossum25ce5661997-08-02 03:10:38 +00001814 return 1;
1815
Guido van Rossum771c6c81997-10-31 18:37:24 +00001816 for (p = PyImport_Inittab; p->name != NULL; p++) {
Guido van Rossum25ce5661997-08-02 03:10:38 +00001817 if (strcmp(name, p->name) == 0) {
1818 if (p->initfunc == NULL) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001819 PyErr_Format(PyExc_ImportError,
1820 "Cannot re-init internal module %.200s",
1821 name);
Guido van Rossum74e6a111994-08-29 12:54:38 +00001822 return -1;
1823 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00001824 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +00001825 PySys_WriteStderr("import %s # builtin\n", name);
Guido van Rossum25ce5661997-08-02 03:10:38 +00001826 (*p->initfunc)();
Guido van Rossum79f25d91997-04-29 20:08:16 +00001827 if (PyErr_Occurred())
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001828 return -1;
Guido van Rossum25ce5661997-08-02 03:10:38 +00001829 if (_PyImport_FixupExtension(name, name) == NULL)
1830 return -1;
Guido van Rossum7f133ed1991-02-19 12:23:57 +00001831 return 1;
1832 }
1833 }
1834 return 0;
1835}
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001836
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001837
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001838/* Frozen modules */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001839
Guido van Rossumcfd0a221996-06-17 17:06:34 +00001840static struct _frozen *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001841find_frozen(char *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001842{
Guido van Rossumcfd0a221996-06-17 17:06:34 +00001843 struct _frozen *p;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001844
Guido van Rossum79f25d91997-04-29 20:08:16 +00001845 for (p = PyImport_FrozenModules; ; p++) {
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001846 if (p->name == NULL)
1847 return NULL;
1848 if (strcmp(p->name, name) == 0)
1849 break;
1850 }
1851 return p;
1852}
1853
Guido van Rossum79f25d91997-04-29 20:08:16 +00001854static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001855get_frozen_object(char *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001856{
Guido van Rossumcfd0a221996-06-17 17:06:34 +00001857 struct _frozen *p = find_frozen(name);
Guido van Rossuma5568d31998-03-05 03:45:08 +00001858 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001859
1860 if (p == NULL) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001861 PyErr_Format(PyExc_ImportError,
1862 "No such frozen object named %.200s",
1863 name);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001864 return NULL;
1865 }
Guido van Rossum8f4d3312001-10-18 18:54:11 +00001866 if (p->code == NULL) {
1867 PyErr_Format(PyExc_ImportError,
1868 "Excluded frozen object named %.200s",
1869 name);
1870 return NULL;
1871 }
Guido van Rossuma5568d31998-03-05 03:45:08 +00001872 size = p->size;
1873 if (size < 0)
1874 size = -size;
1875 return PyMarshal_ReadObjectFromString((char *)p->code, size);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001876}
1877
1878/* Initialize a frozen module.
1879 Return 1 for succes, 0 if the module is not found, and -1 with
1880 an exception set if the initialization failed.
1881 This function is also used from frozenmain.c */
Guido van Rossum0b344901995-02-07 15:35:27 +00001882
1883int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001884PyImport_ImportFrozenModule(char *name)
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001885{
Guido van Rossumcfd0a221996-06-17 17:06:34 +00001886 struct _frozen *p = find_frozen(name);
Guido van Rossum79f25d91997-04-29 20:08:16 +00001887 PyObject *co;
1888 PyObject *m;
Guido van Rossuma5568d31998-03-05 03:45:08 +00001889 int ispackage;
1890 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001891
1892 if (p == NULL)
1893 return 0;
Guido van Rossum8f4d3312001-10-18 18:54:11 +00001894 if (p->code == NULL) {
1895 PyErr_Format(PyExc_ImportError,
1896 "Excluded frozen object named %.200s",
1897 name);
1898 return -1;
1899 }
Guido van Rossuma5568d31998-03-05 03:45:08 +00001900 size = p->size;
1901 ispackage = (size < 0);
1902 if (ispackage)
1903 size = -size;
Guido van Rossum79f25d91997-04-29 20:08:16 +00001904 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +00001905 PySys_WriteStderr("import %s # frozen%s\n",
Guido van Rossuma5568d31998-03-05 03:45:08 +00001906 name, ispackage ? " package" : "");
1907 co = PyMarshal_ReadObjectFromString((char *)p->code, size);
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001908 if (co == NULL)
1909 return -1;
Guido van Rossum79f25d91997-04-29 20:08:16 +00001910 if (!PyCode_Check(co)) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001911 PyErr_Format(PyExc_TypeError,
1912 "frozen object %.200s is not a code object",
1913 name);
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001914 goto err_return;
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001915 }
Guido van Rossuma5568d31998-03-05 03:45:08 +00001916 if (ispackage) {
1917 /* Set __path__ to the package name */
1918 PyObject *d, *s;
1919 int err;
1920 m = PyImport_AddModule(name);
1921 if (m == NULL)
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001922 goto err_return;
Guido van Rossuma5568d31998-03-05 03:45:08 +00001923 d = PyModule_GetDict(m);
1924 s = PyString_InternFromString(name);
1925 if (s == NULL)
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001926 goto err_return;
Guido van Rossuma5568d31998-03-05 03:45:08 +00001927 err = PyDict_SetItemString(d, "__path__", s);
1928 Py_DECREF(s);
1929 if (err != 0)
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001930 goto err_return;
Guido van Rossuma5568d31998-03-05 03:45:08 +00001931 }
Guido van Rossume32bf6e1998-02-11 05:53:02 +00001932 m = PyImport_ExecCodeModuleEx(name, co, "<frozen>");
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001933 if (m == NULL)
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001934 goto err_return;
1935 Py_DECREF(co);
Guido van Rossum79f25d91997-04-29 20:08:16 +00001936 Py_DECREF(m);
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001937 return 1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001938err_return:
1939 Py_DECREF(co);
1940 return -1;
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001941}
Guido van Rossum74e6a111994-08-29 12:54:38 +00001942
1943
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001944/* Import a module, either built-in, frozen, or external, and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001945 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum74e6a111994-08-29 12:54:38 +00001946
Guido van Rossum79f25d91997-04-29 20:08:16 +00001947PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001948PyImport_ImportModule(const char *name)
Guido van Rossum74e6a111994-08-29 12:54:38 +00001949{
Marc-André Lemburg3c61c352001-02-09 19:40:15 +00001950 PyObject *pname;
1951 PyObject *result;
1952
1953 pname = PyString_FromString(name);
Neal Norwitza11e4c12003-03-23 14:31:01 +00001954 if (pname == NULL)
1955 return NULL;
Marc-André Lemburg3c61c352001-02-09 19:40:15 +00001956 result = PyImport_Import(pname);
1957 Py_DECREF(pname);
1958 return result;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001959}
1960
Guido van Rossum17fc85f1997-09-06 18:52:03 +00001961/* Forward declarations for helper routines */
Thomas Woutersf7f438b2006-02-28 16:09:29 +00001962static PyObject *get_parent(PyObject *globals, char *buf,
1963 Py_ssize_t *p_buflen, int level);
Tim Petersdbd9ba62000-07-09 03:09:57 +00001964static PyObject *load_next(PyObject *mod, PyObject *altmod,
Martin v. Löwis18e16552006-02-15 17:27:45 +00001965 char **p_name, char *buf, Py_ssize_t *p_buflen);
Tim Petersdbd9ba62000-07-09 03:09:57 +00001966static int mark_miss(char *name);
1967static int ensure_fromlist(PyObject *mod, PyObject *fromlist,
Martin v. Löwis18e16552006-02-15 17:27:45 +00001968 char *buf, Py_ssize_t buflen, int recursive);
Tim Petersdbd9ba62000-07-09 03:09:57 +00001969static PyObject * import_submodule(PyObject *mod, char *name, char *fullname);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00001970
1971/* The Magnum Opus of dotted-name import :-) */
1972
Guido van Rossum75acc9c1998-03-03 22:26:50 +00001973static PyObject *
Thomas Woutersf7f438b2006-02-28 16:09:29 +00001974import_module_level(char *name, PyObject *globals, PyObject *locals,
1975 PyObject *fromlist, int level)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001976{
Guido van Rossum17fc85f1997-09-06 18:52:03 +00001977 char buf[MAXPATHLEN+1];
Martin v. Löwis18e16552006-02-15 17:27:45 +00001978 Py_ssize_t buflen = 0;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00001979 PyObject *parent, *head, *next, *tail;
1980
Thomas Woutersf7f438b2006-02-28 16:09:29 +00001981 parent = get_parent(globals, buf, &buflen, level);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00001982 if (parent == NULL)
1983 return NULL;
1984
1985 head = load_next(parent, Py_None, &name, buf, &buflen);
1986 if (head == NULL)
1987 return NULL;
1988
1989 tail = head;
1990 Py_INCREF(tail);
1991 while (name) {
1992 next = load_next(tail, tail, &name, buf, &buflen);
1993 Py_DECREF(tail);
1994 if (next == NULL) {
1995 Py_DECREF(head);
1996 return NULL;
1997 }
1998 tail = next;
1999 }
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002000 if (tail == Py_None) {
2001 /* If tail is Py_None, both get_parent and load_next found
2002 an empty module name: someone called __import__("") or
2003 doctored faulty bytecode */
2004 Py_DECREF(tail);
2005 Py_DECREF(head);
2006 PyErr_SetString(PyExc_ValueError,
2007 "Empty module name");
2008 return NULL;
2009 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002010
2011 if (fromlist != NULL) {
2012 if (fromlist == Py_None || !PyObject_IsTrue(fromlist))
2013 fromlist = NULL;
2014 }
2015
2016 if (fromlist == NULL) {
2017 Py_DECREF(tail);
2018 return head;
2019 }
2020
2021 Py_DECREF(head);
Guido van Rossum9905ef91997-09-08 16:07:11 +00002022 if (!ensure_fromlist(tail, fromlist, buf, buflen, 0)) {
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002023 Py_DECREF(tail);
2024 return NULL;
2025 }
2026
2027 return tail;
2028}
2029
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002030/* For DLL compatibility */
2031#undef PyImport_ImportModuleEx
Guido van Rossum75acc9c1998-03-03 22:26:50 +00002032PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002033PyImport_ImportModuleEx(char *name, PyObject *globals, PyObject *locals,
2034 PyObject *fromlist)
Guido van Rossum75acc9c1998-03-03 22:26:50 +00002035{
2036 PyObject *result;
2037 lock_import();
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002038 result = import_module_level(name, globals, locals, fromlist, -1);
2039 if (unlock_import() < 0) {
2040 Py_XDECREF(result);
2041 PyErr_SetString(PyExc_RuntimeError,
2042 "not holding the import lock");
2043 return NULL;
2044 }
2045 return result;
2046}
2047#define PyImport_ImportModuleEx(n, g, l, f) \
2048 PyImport_ImportModuleLevel(n, g, l, f, -1);
2049
2050PyObject *
2051PyImport_ImportModuleLevel(char *name, PyObject *globals, PyObject *locals,
2052 PyObject *fromlist, int level)
2053{
2054 PyObject *result;
2055 lock_import();
2056 result = import_module_level(name, globals, locals, fromlist, level);
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00002057 if (unlock_import() < 0) {
2058 Py_XDECREF(result);
2059 PyErr_SetString(PyExc_RuntimeError,
2060 "not holding the import lock");
2061 return NULL;
2062 }
Guido van Rossum75acc9c1998-03-03 22:26:50 +00002063 return result;
2064}
2065
Fred Drake87590902004-05-28 20:21:36 +00002066/* Return the package that an import is being performed in. If globals comes
2067 from the module foo.bar.bat (not itself a package), this returns the
2068 sys.modules entry for foo.bar. If globals is from a package's __init__.py,
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00002069 the package's entry in sys.modules is returned, as a borrowed reference.
Fred Drake87590902004-05-28 20:21:36 +00002070
2071 The *name* of the returned package is returned in buf, with the length of
2072 the name in *p_buflen.
2073
2074 If globals doesn't come from a package or a module in a package, or a
2075 corresponding entry is not found in sys.modules, Py_None is returned.
2076*/
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002077static PyObject *
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002078get_parent(PyObject *globals, char *buf, Py_ssize_t *p_buflen, int level)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002079{
2080 static PyObject *namestr = NULL;
2081 static PyObject *pathstr = NULL;
2082 PyObject *modname, *modpath, *modules, *parent;
2083
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002084 if (globals == NULL || !PyDict_Check(globals) || !level)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002085 return Py_None;
2086
2087 if (namestr == NULL) {
2088 namestr = PyString_InternFromString("__name__");
2089 if (namestr == NULL)
2090 return NULL;
2091 }
2092 if (pathstr == NULL) {
2093 pathstr = PyString_InternFromString("__path__");
2094 if (pathstr == NULL)
2095 return NULL;
2096 }
2097
2098 *buf = '\0';
2099 *p_buflen = 0;
2100 modname = PyDict_GetItem(globals, namestr);
2101 if (modname == NULL || !PyString_Check(modname))
2102 return Py_None;
2103
2104 modpath = PyDict_GetItem(globals, pathstr);
2105 if (modpath != NULL) {
Martin v. Löwis725507b2006-03-07 12:08:51 +00002106 Py_ssize_t len = PyString_GET_SIZE(modname);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002107 if (len > MAXPATHLEN) {
2108 PyErr_SetString(PyExc_ValueError,
2109 "Module name too long");
2110 return NULL;
2111 }
2112 strcpy(buf, PyString_AS_STRING(modname));
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002113 }
2114 else {
2115 char *start = PyString_AS_STRING(modname);
2116 char *lastdot = strrchr(start, '.');
Fred Drake4c82b232000-06-30 16:18:57 +00002117 size_t len;
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002118 if (lastdot == NULL && level > 0) {
2119 PyErr_SetString(PyExc_ValueError,
Thomas Wouters89f507f2006-12-13 04:49:30 +00002120 "Attempted relative import in non-package");
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002121 return NULL;
2122 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002123 if (lastdot == NULL)
2124 return Py_None;
2125 len = lastdot - start;
2126 if (len >= MAXPATHLEN) {
2127 PyErr_SetString(PyExc_ValueError,
2128 "Module name too long");
2129 return NULL;
2130 }
2131 strncpy(buf, start, len);
2132 buf[len] = '\0';
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002133 }
2134
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002135 while (--level > 0) {
2136 char *dot = strrchr(buf, '.');
2137 if (dot == NULL) {
2138 PyErr_SetString(PyExc_ValueError,
Thomas Wouters89f507f2006-12-13 04:49:30 +00002139 "Attempted relative import beyond "
2140 "toplevel package");
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002141 return NULL;
2142 }
2143 *dot = '\0';
2144 }
2145 *p_buflen = strlen(buf);
2146
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002147 modules = PyImport_GetModuleDict();
2148 parent = PyDict_GetItemString(modules, buf);
2149 if (parent == NULL)
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002150 PyErr_Format(PyExc_SystemError,
2151 "Parent module '%.200s' not loaded", buf);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002152 return parent;
2153 /* We expect, but can't guarantee, if parent != None, that:
2154 - parent.__name__ == buf
2155 - parent.__dict__ is globals
2156 If this is violated... Who cares? */
2157}
2158
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002159/* altmod is either None or same as mod */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002160static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002161load_next(PyObject *mod, PyObject *altmod, char **p_name, char *buf,
Martin v. Löwis18e16552006-02-15 17:27:45 +00002162 Py_ssize_t *p_buflen)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002163{
2164 char *name = *p_name;
2165 char *dot = strchr(name, '.');
Fred Drake4c82b232000-06-30 16:18:57 +00002166 size_t len;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002167 char *p;
2168 PyObject *result;
2169
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002170 if (strlen(name) == 0) {
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002171 /* completely empty module name should only happen in
2172 'from . import' (or '__import__("")')*/
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002173 Py_INCREF(mod);
2174 *p_name = NULL;
2175 return mod;
2176 }
2177
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002178 if (dot == NULL) {
2179 *p_name = NULL;
2180 len = strlen(name);
2181 }
2182 else {
2183 *p_name = dot+1;
2184 len = dot-name;
2185 }
Guido van Rossum111c20b1998-04-11 17:38:22 +00002186 if (len == 0) {
2187 PyErr_SetString(PyExc_ValueError,
2188 "Empty module name");
2189 return NULL;
2190 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002191
2192 p = buf + *p_buflen;
2193 if (p != buf)
2194 *p++ = '.';
2195 if (p+len-buf >= MAXPATHLEN) {
2196 PyErr_SetString(PyExc_ValueError,
2197 "Module name too long");
2198 return NULL;
2199 }
2200 strncpy(p, name, len);
2201 p[len] = '\0';
2202 *p_buflen = p+len-buf;
2203
2204 result = import_submodule(mod, p, buf);
2205 if (result == Py_None && altmod != mod) {
2206 Py_DECREF(result);
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00002207 /* Here, altmod must be None and mod must not be None */
Guido van Rossum0c819451997-09-07 06:16:57 +00002208 result = import_submodule(altmod, p, p);
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00002209 if (result != NULL && result != Py_None) {
2210 if (mark_miss(buf) != 0) {
2211 Py_DECREF(result);
2212 return NULL;
2213 }
2214 strncpy(buf, name, len);
2215 buf[len] = '\0';
2216 *p_buflen = len;
2217 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002218 }
2219 if (result == NULL)
2220 return NULL;
2221
2222 if (result == Py_None) {
2223 Py_DECREF(result);
2224 PyErr_Format(PyExc_ImportError,
2225 "No module named %.200s", name);
2226 return NULL;
2227 }
2228
2229 return result;
2230}
2231
2232static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002233mark_miss(char *name)
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00002234{
2235 PyObject *modules = PyImport_GetModuleDict();
2236 return PyDict_SetItemString(modules, name, Py_None);
2237}
2238
2239static int
Martin v. Löwis18e16552006-02-15 17:27:45 +00002240ensure_fromlist(PyObject *mod, PyObject *fromlist, char *buf, Py_ssize_t buflen,
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002241 int recursive)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002242{
2243 int i;
2244
2245 if (!PyObject_HasAttrString(mod, "__path__"))
2246 return 1;
2247
2248 for (i = 0; ; i++) {
2249 PyObject *item = PySequence_GetItem(fromlist, i);
2250 int hasit;
2251 if (item == NULL) {
2252 if (PyErr_ExceptionMatches(PyExc_IndexError)) {
2253 PyErr_Clear();
2254 return 1;
2255 }
2256 return 0;
2257 }
2258 if (!PyString_Check(item)) {
2259 PyErr_SetString(PyExc_TypeError,
2260 "Item in ``from list'' not a string");
2261 Py_DECREF(item);
2262 return 0;
2263 }
2264 if (PyString_AS_STRING(item)[0] == '*') {
Guido van Rossum9905ef91997-09-08 16:07:11 +00002265 PyObject *all;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002266 Py_DECREF(item);
Guido van Rossum9905ef91997-09-08 16:07:11 +00002267 /* See if the package defines __all__ */
2268 if (recursive)
2269 continue; /* Avoid endless recursion */
2270 all = PyObject_GetAttrString(mod, "__all__");
2271 if (all == NULL)
2272 PyErr_Clear();
2273 else {
Martin v. Löwis83969ee2004-03-23 16:28:13 +00002274 int ret = ensure_fromlist(mod, all, buf, buflen, 1);
Guido van Rossum9905ef91997-09-08 16:07:11 +00002275 Py_DECREF(all);
Martin v. Löwis83969ee2004-03-23 16:28:13 +00002276 if (!ret)
2277 return 0;
Guido van Rossum9905ef91997-09-08 16:07:11 +00002278 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002279 continue;
2280 }
2281 hasit = PyObject_HasAttr(mod, item);
2282 if (!hasit) {
2283 char *subname = PyString_AS_STRING(item);
2284 PyObject *submod;
2285 char *p;
2286 if (buflen + strlen(subname) >= MAXPATHLEN) {
2287 PyErr_SetString(PyExc_ValueError,
2288 "Module name too long");
2289 Py_DECREF(item);
2290 return 0;
2291 }
2292 p = buf + buflen;
2293 *p++ = '.';
2294 strcpy(p, subname);
2295 submod = import_submodule(mod, subname, buf);
2296 Py_XDECREF(submod);
2297 if (submod == NULL) {
2298 Py_DECREF(item);
2299 return 0;
2300 }
2301 }
2302 Py_DECREF(item);
2303 }
2304
Guido van Rossuma7f2e811997-10-03 15:33:32 +00002305 /* NOTREACHED */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002306}
2307
Neil Schemenauer00b09662003-06-16 21:03:07 +00002308static int
2309add_submodule(PyObject *mod, PyObject *submod, char *fullname, char *subname,
2310 PyObject *modules)
2311{
2312 if (mod == Py_None)
2313 return 1;
2314 /* Irrespective of the success of this load, make a
2315 reference to it in the parent package module. A copy gets
2316 saved in the modules dictionary under the full name, so get a
2317 reference from there, if need be. (The exception is when the
2318 load failed with a SyntaxError -- then there's no trace in
2319 sys.modules. In that case, of course, do nothing extra.) */
2320 if (submod == NULL) {
2321 submod = PyDict_GetItemString(modules, fullname);
2322 if (submod == NULL)
2323 return 1;
2324 }
2325 if (PyModule_Check(mod)) {
2326 /* We can't use setattr here since it can give a
2327 * spurious warning if the submodule name shadows a
2328 * builtin name */
2329 PyObject *dict = PyModule_GetDict(mod);
2330 if (!dict)
2331 return 0;
2332 if (PyDict_SetItemString(dict, subname, submod) < 0)
2333 return 0;
2334 }
2335 else {
2336 if (PyObject_SetAttrString(mod, subname, submod) < 0)
2337 return 0;
2338 }
2339 return 1;
2340}
2341
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002342static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002343import_submodule(PyObject *mod, char *subname, char *fullname)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002344{
Guido van Rossum25ce5661997-08-02 03:10:38 +00002345 PyObject *modules = PyImport_GetModuleDict();
Neil Schemenauer00b09662003-06-16 21:03:07 +00002346 PyObject *m = NULL;
Guido van Rossum74e6a111994-08-29 12:54:38 +00002347
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002348 /* Require:
2349 if mod == None: subname == fullname
2350 else: mod.__name__ + "." + subname == fullname
2351 */
2352
Tim Peters50d8d372001-02-28 05:34:27 +00002353 if ((m = PyDict_GetItemString(modules, fullname)) != NULL) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00002354 Py_INCREF(m);
Guido van Rossum7f9fa971995-01-20 16:53:12 +00002355 }
2356 else {
Just van Rossum52e14d62002-12-30 22:08:05 +00002357 PyObject *path, *loader = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002358 char buf[MAXPATHLEN+1];
2359 struct filedescr *fdp;
2360 FILE *fp = NULL;
2361
Guido van Rossum9c0afe51998-05-19 15:09:05 +00002362 if (mod == Py_None)
2363 path = NULL;
2364 else {
2365 path = PyObject_GetAttrString(mod, "__path__");
2366 if (path == NULL) {
2367 PyErr_Clear();
2368 Py_INCREF(Py_None);
2369 return Py_None;
2370 }
2371 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002372
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002373 buf[0] = '\0';
Just van Rossum52e14d62002-12-30 22:08:05 +00002374 fdp = find_module(fullname, subname, path, buf, MAXPATHLEN+1,
2375 &fp, &loader);
Guido van Rossumb68cd421998-07-01 17:36:26 +00002376 Py_XDECREF(path);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002377 if (fdp == NULL) {
2378 if (!PyErr_ExceptionMatches(PyExc_ImportError))
2379 return NULL;
2380 PyErr_Clear();
2381 Py_INCREF(Py_None);
2382 return Py_None;
2383 }
Just van Rossum52e14d62002-12-30 22:08:05 +00002384 m = load_module(fullname, fp, buf, fdp->type, loader);
2385 Py_XDECREF(loader);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002386 if (fp)
2387 fclose(fp);
Neil Schemenauer00b09662003-06-16 21:03:07 +00002388 if (!add_submodule(mod, m, fullname, subname, modules)) {
2389 Py_XDECREF(m);
2390 m = NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002391 }
Guido van Rossum74e6a111994-08-29 12:54:38 +00002392 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002393
2394 return m;
Guido van Rossum74e6a111994-08-29 12:54:38 +00002395}
2396
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002397
2398/* Re-import a module of any kind and return its module object, WITH
2399 INCREMENTED REFERENCE COUNT */
2400
Guido van Rossum79f25d91997-04-29 20:08:16 +00002401PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002402PyImport_ReloadModule(PyObject *m)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002403{
Guido van Rossumd8faa362007-04-27 19:54:29 +00002404 PyInterpreterState *interp = PyThreadState_Get()->interp;
2405 PyObject *modules_reloading = interp->modules_reloading;
Guido van Rossum25ce5661997-08-02 03:10:38 +00002406 PyObject *modules = PyImport_GetModuleDict();
Guido van Rossumd8faa362007-04-27 19:54:29 +00002407 PyObject *path = NULL, *loader = NULL, *existing_m = NULL;
Guido van Rossum222ef561997-09-06 19:41:09 +00002408 char *name, *subname;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002409 char buf[MAXPATHLEN+1];
2410 struct filedescr *fdp;
2411 FILE *fp = NULL;
Tim Peters1cd70172004-08-02 03:52:12 +00002412 PyObject *newm;
Guido van Rossumd8faa362007-04-27 19:54:29 +00002413
2414 if (modules_reloading == NULL) {
2415 Py_FatalError("PyImport_ReloadModule: "
2416 "no modules_reloading dictionary!");
2417 return NULL;
2418 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002419
Guido van Rossum79f25d91997-04-29 20:08:16 +00002420 if (m == NULL || !PyModule_Check(m)) {
2421 PyErr_SetString(PyExc_TypeError,
2422 "reload() argument must be module");
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002423 return NULL;
2424 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002425 name = PyModule_GetName(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002426 if (name == NULL)
2427 return NULL;
Guido van Rossum25ce5661997-08-02 03:10:38 +00002428 if (m != PyDict_GetItemString(modules, name)) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002429 PyErr_Format(PyExc_ImportError,
2430 "reload(): module %.200s not in sys.modules",
2431 name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002432 return NULL;
2433 }
Guido van Rossumd8faa362007-04-27 19:54:29 +00002434 existing_m = PyDict_GetItemString(modules_reloading, name);
2435 if (existing_m != NULL) {
2436 /* Due to a recursive reload, this module is already
2437 being reloaded. */
2438 Py_INCREF(existing_m);
2439 return existing_m;
2440 }
2441 if (PyDict_SetItemString(modules_reloading, name, m) < 0)
2442 return NULL;
2443
Guido van Rossum222ef561997-09-06 19:41:09 +00002444 subname = strrchr(name, '.');
2445 if (subname == NULL)
2446 subname = name;
2447 else {
2448 PyObject *parentname, *parent;
2449 parentname = PyString_FromStringAndSize(name, (subname-name));
Guido van Rossumd8faa362007-04-27 19:54:29 +00002450 if (parentname == NULL) {
2451 imp_modules_reloading_clear();
Guido van Rossum222ef561997-09-06 19:41:09 +00002452 return NULL;
Guido van Rossumd8faa362007-04-27 19:54:29 +00002453 }
Guido van Rossum222ef561997-09-06 19:41:09 +00002454 parent = PyDict_GetItem(modules, parentname);
2455 if (parent == NULL) {
2456 PyErr_Format(PyExc_ImportError,
2457 "reload(): parent %.200s not in sys.modules",
Georg Brandl0c55f292005-09-14 06:56:20 +00002458 PyString_AS_STRING(parentname));
2459 Py_DECREF(parentname);
Guido van Rossumd8faa362007-04-27 19:54:29 +00002460 imp_modules_reloading_clear();
Guido van Rossum222ef561997-09-06 19:41:09 +00002461 return NULL;
2462 }
Georg Brandl0c55f292005-09-14 06:56:20 +00002463 Py_DECREF(parentname);
Guido van Rossum222ef561997-09-06 19:41:09 +00002464 subname++;
2465 path = PyObject_GetAttrString(parent, "__path__");
2466 if (path == NULL)
2467 PyErr_Clear();
2468 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002469 buf[0] = '\0';
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00002470 fdp = find_module(name, subname, path, buf, MAXPATHLEN+1, &fp, &loader);
Guido van Rossum222ef561997-09-06 19:41:09 +00002471 Py_XDECREF(path);
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00002472
2473 if (fdp == NULL) {
2474 Py_XDECREF(loader);
Guido van Rossumd8faa362007-04-27 19:54:29 +00002475 imp_modules_reloading_clear();
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002476 return NULL;
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00002477 }
2478
2479 newm = load_module(name, fp, buf, fdp->type, loader);
2480 Py_XDECREF(loader);
2481
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002482 if (fp)
2483 fclose(fp);
Tim Peters1cd70172004-08-02 03:52:12 +00002484 if (newm == NULL) {
2485 /* load_module probably removed name from modules because of
2486 * the error. Put back the original module object. We're
2487 * going to return NULL in this case regardless of whether
2488 * replacing name succeeds, so the return value is ignored.
2489 */
2490 PyDict_SetItemString(modules, name, m);
2491 }
Guido van Rossumd8faa362007-04-27 19:54:29 +00002492 imp_modules_reloading_clear();
Tim Peters1cd70172004-08-02 03:52:12 +00002493 return newm;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002494}
2495
2496
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002497/* Higher-level import emulator which emulates the "import" statement
2498 more accurately -- it invokes the __import__() function from the
2499 builtins of the current globals. This means that the import is
2500 done using whatever import hooks are installed in the current
Guido van Rossum6058eb41998-12-21 19:51:00 +00002501 environment, e.g. by "rexec".
2502 A dummy list ["__doc__"] is passed as the 4th argument so that
2503 e.g. PyImport_Import(PyString_FromString("win32com.client.gencache"))
2504 will return <module "gencache"> instead of <module "win32com">. */
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002505
2506PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002507PyImport_Import(PyObject *module_name)
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002508{
2509 static PyObject *silly_list = NULL;
2510 static PyObject *builtins_str = NULL;
2511 static PyObject *import_str = NULL;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002512 PyObject *globals = NULL;
2513 PyObject *import = NULL;
2514 PyObject *builtins = NULL;
2515 PyObject *r = NULL;
2516
2517 /* Initialize constant string objects */
2518 if (silly_list == NULL) {
2519 import_str = PyString_InternFromString("__import__");
2520 if (import_str == NULL)
2521 return NULL;
2522 builtins_str = PyString_InternFromString("__builtins__");
2523 if (builtins_str == NULL)
2524 return NULL;
2525 silly_list = Py_BuildValue("[s]", "__doc__");
2526 if (silly_list == NULL)
2527 return NULL;
2528 }
2529
2530 /* Get the builtins from current globals */
2531 globals = PyEval_GetGlobals();
Guido van Rossum85cd1d62001-02-20 21:43:24 +00002532 if (globals != NULL) {
Guido van Rossum66468561998-10-22 15:46:50 +00002533 Py_INCREF(globals);
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002534 builtins = PyObject_GetItem(globals, builtins_str);
2535 if (builtins == NULL)
2536 goto err;
2537 }
2538 else {
2539 /* No globals -- use standard builtins, and fake globals */
2540 PyErr_Clear();
2541
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002542 builtins = PyImport_ImportModuleLevel("__builtin__",
2543 NULL, NULL, NULL, 0);
Guido van Rossum85cd1d62001-02-20 21:43:24 +00002544 if (builtins == NULL)
2545 return NULL;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002546 globals = Py_BuildValue("{OO}", builtins_str, builtins);
2547 if (globals == NULL)
2548 goto err;
2549 }
2550
2551 /* Get the __import__ function from the builtins */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002552 if (PyDict_Check(builtins)) {
Fred Drakea76ba6e2001-03-06 06:31:15 +00002553 import = PyObject_GetItem(builtins, import_str);
Tim Peters6d6c1a32001-08-02 04:15:00 +00002554 if (import == NULL)
2555 PyErr_SetObject(PyExc_KeyError, import_str);
2556 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002557 else
Fred Drakea76ba6e2001-03-06 06:31:15 +00002558 import = PyObject_GetAttr(builtins, import_str);
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002559 if (import == NULL)
2560 goto err;
2561
Guido van Rossumd8faa362007-04-27 19:54:29 +00002562 /* Call the __import__ function with the proper argument list */
Thomas Wouters477c8d52006-05-27 19:21:47 +00002563 r = PyObject_CallFunctionObjArgs(import, module_name, globals,
2564 globals, silly_list, NULL);
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002565
2566 err:
2567 Py_XDECREF(globals);
2568 Py_XDECREF(builtins);
2569 Py_XDECREF(import);
Tim Peters50d8d372001-02-28 05:34:27 +00002570
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002571 return r;
2572}
2573
2574
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002575/* Module 'imp' provides Python access to the primitives used for
2576 importing modules.
2577*/
2578
Guido van Rossum79f25d91997-04-29 20:08:16 +00002579static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +00002580imp_get_magic(PyObject *self, PyObject *noargs)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002581{
2582 char buf[4];
2583
Guido van Rossum96774c12000-05-01 20:19:08 +00002584 buf[0] = (char) ((pyc_magic >> 0) & 0xff);
2585 buf[1] = (char) ((pyc_magic >> 8) & 0xff);
2586 buf[2] = (char) ((pyc_magic >> 16) & 0xff);
2587 buf[3] = (char) ((pyc_magic >> 24) & 0xff);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002588
Guido van Rossum79f25d91997-04-29 20:08:16 +00002589 return PyString_FromStringAndSize(buf, 4);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002590}
2591
Guido van Rossum79f25d91997-04-29 20:08:16 +00002592static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +00002593imp_get_suffixes(PyObject *self, PyObject *noargs)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002594{
Guido van Rossum79f25d91997-04-29 20:08:16 +00002595 PyObject *list;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002596 struct filedescr *fdp;
2597
Guido van Rossum79f25d91997-04-29 20:08:16 +00002598 list = PyList_New(0);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002599 if (list == NULL)
2600 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002601 for (fdp = _PyImport_Filetab; fdp->suffix != NULL; fdp++) {
2602 PyObject *item = Py_BuildValue("ssi",
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002603 fdp->suffix, fdp->mode, fdp->type);
2604 if (item == NULL) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00002605 Py_DECREF(list);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002606 return NULL;
2607 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002608 if (PyList_Append(list, item) < 0) {
2609 Py_DECREF(list);
2610 Py_DECREF(item);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002611 return NULL;
2612 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002613 Py_DECREF(item);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002614 }
2615 return list;
2616}
2617
Guido van Rossum79f25d91997-04-29 20:08:16 +00002618static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002619call_find_module(char *name, PyObject *path)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002620{
Tim Petersdbd9ba62000-07-09 03:09:57 +00002621 extern int fclose(FILE *);
Guido van Rossum79f25d91997-04-29 20:08:16 +00002622 PyObject *fob, *ret;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002623 struct filedescr *fdp;
2624 char pathname[MAXPATHLEN+1];
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002625 FILE *fp = NULL;
2626
2627 pathname[0] = '\0';
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002628 if (path == Py_None)
2629 path = NULL;
Just van Rossum52e14d62002-12-30 22:08:05 +00002630 fdp = find_module(NULL, name, path, pathname, MAXPATHLEN+1, &fp, NULL);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002631 if (fdp == NULL)
2632 return NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002633 if (fp != NULL) {
2634 fob = PyFile_FromFile(fp, pathname, fdp->mode, fclose);
2635 if (fob == NULL) {
2636 fclose(fp);
2637 return NULL;
2638 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002639 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002640 else {
2641 fob = Py_None;
2642 Py_INCREF(fob);
Tim Peters50d8d372001-02-28 05:34:27 +00002643 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002644 ret = Py_BuildValue("Os(ssi)",
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002645 fob, pathname, fdp->suffix, fdp->mode, fdp->type);
Guido van Rossum79f25d91997-04-29 20:08:16 +00002646 Py_DECREF(fob);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002647 return ret;
2648}
2649
Guido van Rossum79f25d91997-04-29 20:08:16 +00002650static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002651imp_find_module(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002652{
2653 char *name;
2654 PyObject *path = NULL;
Guido van Rossum43713e52000-02-29 13:59:29 +00002655 if (!PyArg_ParseTuple(args, "s|O:find_module", &name, &path))
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002656 return NULL;
2657 return call_find_module(name, path);
2658}
2659
2660static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002661imp_init_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002662{
2663 char *name;
2664 int ret;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002665 PyObject *m;
Guido van Rossum43713e52000-02-29 13:59:29 +00002666 if (!PyArg_ParseTuple(args, "s:init_builtin", &name))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002667 return NULL;
2668 ret = init_builtin(name);
2669 if (ret < 0)
2670 return NULL;
2671 if (ret == 0) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00002672 Py_INCREF(Py_None);
2673 return Py_None;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002674 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002675 m = PyImport_AddModule(name);
2676 Py_XINCREF(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002677 return m;
2678}
2679
Guido van Rossum79f25d91997-04-29 20:08:16 +00002680static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002681imp_init_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002682{
2683 char *name;
2684 int ret;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002685 PyObject *m;
Guido van Rossum43713e52000-02-29 13:59:29 +00002686 if (!PyArg_ParseTuple(args, "s:init_frozen", &name))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002687 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002688 ret = PyImport_ImportFrozenModule(name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002689 if (ret < 0)
2690 return NULL;
2691 if (ret == 0) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00002692 Py_INCREF(Py_None);
2693 return Py_None;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002694 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002695 m = PyImport_AddModule(name);
2696 Py_XINCREF(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002697 return m;
2698}
2699
Guido van Rossum79f25d91997-04-29 20:08:16 +00002700static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002701imp_get_frozen_object(PyObject *self, PyObject *args)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002702{
2703 char *name;
Jack Jansen95ffa231995-10-03 14:38:41 +00002704
Guido van Rossum43713e52000-02-29 13:59:29 +00002705 if (!PyArg_ParseTuple(args, "s:get_frozen_object", &name))
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002706 return NULL;
2707 return get_frozen_object(name);
2708}
2709
Guido van Rossum79f25d91997-04-29 20:08:16 +00002710static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002711imp_is_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002712{
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002713 char *name;
Guido van Rossum43713e52000-02-29 13:59:29 +00002714 if (!PyArg_ParseTuple(args, "s:is_builtin", &name))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002715 return NULL;
Guido van Rossum50ee94f2002-04-09 18:00:58 +00002716 return PyInt_FromLong(is_builtin(name));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002717}
2718
Guido van Rossum79f25d91997-04-29 20:08:16 +00002719static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002720imp_is_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002721{
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002722 char *name;
Guido van Rossum323bf5e1998-06-24 03:54:06 +00002723 struct _frozen *p;
Guido van Rossum43713e52000-02-29 13:59:29 +00002724 if (!PyArg_ParseTuple(args, "s:is_frozen", &name))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002725 return NULL;
Guido van Rossum323bf5e1998-06-24 03:54:06 +00002726 p = find_frozen(name);
Guido van Rossumb8bff3f2002-04-07 06:34:38 +00002727 return PyBool_FromLong((long) (p == NULL ? 0 : p->size));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002728}
2729
2730static FILE *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002731get_file(char *pathname, PyObject *fob, char *mode)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002732{
2733 FILE *fp;
2734 if (fob == NULL) {
Tim Peters86c7d2f2004-08-01 23:24:21 +00002735 if (mode[0] == 'U')
Jeremy Hylton4ae6fae2002-05-30 17:15:25 +00002736 mode = "r" PY_STDIOTEXTMODE;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002737 fp = fopen(pathname, mode);
2738 if (fp == NULL)
Guido van Rossum79f25d91997-04-29 20:08:16 +00002739 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002740 }
2741 else {
Guido van Rossum79f25d91997-04-29 20:08:16 +00002742 fp = PyFile_AsFile(fob);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002743 if (fp == NULL)
Guido van Rossum79f25d91997-04-29 20:08:16 +00002744 PyErr_SetString(PyExc_ValueError,
2745 "bad/closed file object");
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002746 }
2747 return fp;
2748}
2749
Guido van Rossum79f25d91997-04-29 20:08:16 +00002750static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002751imp_load_compiled(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002752{
2753 char *name;
2754 char *pathname;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002755 PyObject *fob = NULL;
2756 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002757 FILE *fp;
Guido van Rossum43713e52000-02-29 13:59:29 +00002758 if (!PyArg_ParseTuple(args, "ss|O!:load_compiled", &name, &pathname,
Guido van Rossum79f25d91997-04-29 20:08:16 +00002759 &PyFile_Type, &fob))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002760 return NULL;
2761 fp = get_file(pathname, fob, "rb");
2762 if (fp == NULL)
2763 return NULL;
2764 m = load_compiled_module(name, pathname, fp);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002765 if (fob == NULL)
2766 fclose(fp);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002767 return m;
2768}
2769
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002770#ifdef HAVE_DYNAMIC_LOADING
2771
Guido van Rossum79f25d91997-04-29 20:08:16 +00002772static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002773imp_load_dynamic(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002774{
2775 char *name;
2776 char *pathname;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002777 PyObject *fob = NULL;
2778 PyObject *m;
Guido van Rossum7faeab31995-07-07 22:50:36 +00002779 FILE *fp = NULL;
Guido van Rossum43713e52000-02-29 13:59:29 +00002780 if (!PyArg_ParseTuple(args, "ss|O!:load_dynamic", &name, &pathname,
Guido van Rossum79f25d91997-04-29 20:08:16 +00002781 &PyFile_Type, &fob))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002782 return NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002783 if (fob) {
Guido van Rossum7faeab31995-07-07 22:50:36 +00002784 fp = get_file(pathname, fob, "r");
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002785 if (fp == NULL)
2786 return NULL;
2787 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002788 m = _PyImport_LoadDynamicModule(name, pathname, fp);
Guido van Rossum7faeab31995-07-07 22:50:36 +00002789 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002790}
2791
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002792#endif /* HAVE_DYNAMIC_LOADING */
2793
Guido van Rossum79f25d91997-04-29 20:08:16 +00002794static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002795imp_load_source(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002796{
2797 char *name;
2798 char *pathname;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002799 PyObject *fob = NULL;
2800 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002801 FILE *fp;
Guido van Rossum43713e52000-02-29 13:59:29 +00002802 if (!PyArg_ParseTuple(args, "ss|O!:load_source", &name, &pathname,
Guido van Rossum79f25d91997-04-29 20:08:16 +00002803 &PyFile_Type, &fob))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002804 return NULL;
2805 fp = get_file(pathname, fob, "r");
2806 if (fp == NULL)
2807 return NULL;
2808 m = load_source_module(name, pathname, fp);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002809 if (fob == NULL)
2810 fclose(fp);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002811 return m;
2812}
2813
Guido van Rossum79f25d91997-04-29 20:08:16 +00002814static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002815imp_load_module(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002816{
2817 char *name;
2818 PyObject *fob;
2819 char *pathname;
2820 char *suffix; /* Unused */
2821 char *mode;
2822 int type;
2823 FILE *fp;
2824
Guido van Rossum43713e52000-02-29 13:59:29 +00002825 if (!PyArg_ParseTuple(args, "sOs(ssi):load_module",
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002826 &name, &fob, &pathname,
2827 &suffix, &mode, &type))
2828 return NULL;
Guido van Rossum5e2c5fa2002-05-30 17:33:07 +00002829 if (*mode) {
2830 /* Mode must start with 'r' or 'U' and must not contain '+'.
2831 Implicit in this test is the assumption that the mode
2832 may contain other modifiers like 'b' or 't'. */
2833
2834 if (!(*mode == 'r' || *mode == 'U') || strchr(mode, '+')) {
Jeremy Hylton4ae6fae2002-05-30 17:15:25 +00002835 PyErr_Format(PyExc_ValueError,
2836 "invalid file open mode %.200s", mode);
2837 return NULL;
Guido van Rossum5e2c5fa2002-05-30 17:33:07 +00002838 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002839 }
2840 if (fob == Py_None)
2841 fp = NULL;
2842 else {
2843 if (!PyFile_Check(fob)) {
2844 PyErr_SetString(PyExc_ValueError,
2845 "load_module arg#2 should be a file or None");
2846 return NULL;
2847 }
2848 fp = get_file(pathname, fob, mode);
2849 if (fp == NULL)
2850 return NULL;
2851 }
Just van Rossum52e14d62002-12-30 22:08:05 +00002852 return load_module(name, fp, pathname, type, NULL);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002853}
2854
2855static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002856imp_load_package(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002857{
2858 char *name;
2859 char *pathname;
Guido van Rossum43713e52000-02-29 13:59:29 +00002860 if (!PyArg_ParseTuple(args, "ss:load_package", &name, &pathname))
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002861 return NULL;
2862 return load_package(name, pathname);
2863}
2864
2865static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002866imp_new_module(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002867{
2868 char *name;
Guido van Rossum43713e52000-02-29 13:59:29 +00002869 if (!PyArg_ParseTuple(args, "s:new_module", &name))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002870 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002871 return PyModule_New(name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002872}
2873
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002874/* Doc strings */
2875
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002876PyDoc_STRVAR(doc_imp,
2877"This module provides the components needed to build your own\n\
2878__import__ function. Undocumented functions are obsolete.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002879
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002880PyDoc_STRVAR(doc_find_module,
2881"find_module(name, [path]) -> (file, filename, (suffix, mode, type))\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002882Search for a module. If path is omitted or None, search for a\n\
2883built-in, frozen or special module and continue search in sys.path.\n\
2884The module name cannot contain '.'; to search for a submodule of a\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002885package, pass the submodule name and the package's __path__.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002886
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002887PyDoc_STRVAR(doc_load_module,
2888"load_module(name, file, filename, (suffix, mode, type)) -> module\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002889Load a module, given information returned by find_module().\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002890The module name must include the full package name, if any.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002891
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002892PyDoc_STRVAR(doc_get_magic,
2893"get_magic() -> string\n\
2894Return the magic number for .pyc or .pyo files.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002895
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002896PyDoc_STRVAR(doc_get_suffixes,
2897"get_suffixes() -> [(suffix, mode, type), ...]\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002898Return a list of (suffix, mode, type) tuples describing the files\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002899that find_module() looks for.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002900
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002901PyDoc_STRVAR(doc_new_module,
2902"new_module(name) -> module\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002903Create a new module. Do not enter it in sys.modules.\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002904The module name must include the full package name, if any.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002905
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002906PyDoc_STRVAR(doc_lock_held,
Tim Petersa7c65092004-08-01 23:26:05 +00002907"lock_held() -> boolean\n\
2908Return True if the import lock is currently held, else False.\n\
2909On platforms without threads, return False.");
Tim Peters69232342001-08-30 05:16:13 +00002910
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00002911PyDoc_STRVAR(doc_acquire_lock,
2912"acquire_lock() -> None\n\
Neal Norwitz2294c0d2003-02-12 23:02:21 +00002913Acquires the interpreter's import lock for the current thread.\n\
2914This lock should be used by import hooks to ensure thread-safety\n\
2915when importing modules.\n\
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00002916On platforms without threads, this function does nothing.");
2917
2918PyDoc_STRVAR(doc_release_lock,
2919"release_lock() -> None\n\
2920Release the interpreter's import lock.\n\
2921On platforms without threads, this function does nothing.");
2922
Guido van Rossum79f25d91997-04-29 20:08:16 +00002923static PyMethodDef imp_methods[] = {
Neal Norwitz08ea61a2003-02-17 18:18:00 +00002924 {"find_module", imp_find_module, METH_VARARGS, doc_find_module},
2925 {"get_magic", imp_get_magic, METH_NOARGS, doc_get_magic},
2926 {"get_suffixes", imp_get_suffixes, METH_NOARGS, doc_get_suffixes},
2927 {"load_module", imp_load_module, METH_VARARGS, doc_load_module},
2928 {"new_module", imp_new_module, METH_VARARGS, doc_new_module},
2929 {"lock_held", imp_lock_held, METH_NOARGS, doc_lock_held},
2930 {"acquire_lock", imp_acquire_lock, METH_NOARGS, doc_acquire_lock},
2931 {"release_lock", imp_release_lock, METH_NOARGS, doc_release_lock},
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002932 /* The rest are obsolete */
Neal Norwitz031829d2002-03-31 14:37:44 +00002933 {"get_frozen_object", imp_get_frozen_object, METH_VARARGS},
2934 {"init_builtin", imp_init_builtin, METH_VARARGS},
2935 {"init_frozen", imp_init_frozen, METH_VARARGS},
2936 {"is_builtin", imp_is_builtin, METH_VARARGS},
2937 {"is_frozen", imp_is_frozen, METH_VARARGS},
2938 {"load_compiled", imp_load_compiled, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002939#ifdef HAVE_DYNAMIC_LOADING
Neal Norwitz031829d2002-03-31 14:37:44 +00002940 {"load_dynamic", imp_load_dynamic, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002941#endif
Neal Norwitz031829d2002-03-31 14:37:44 +00002942 {"load_package", imp_load_package, METH_VARARGS},
Neal Norwitz031829d2002-03-31 14:37:44 +00002943 {"load_source", imp_load_source, METH_VARARGS},
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002944 {NULL, NULL} /* sentinel */
2945};
2946
Guido van Rossum1a8791e1998-08-04 22:46:29 +00002947static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002948setint(PyObject *d, char *name, int value)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002949{
2950 PyObject *v;
2951 int err;
2952
2953 v = PyInt_FromLong((long)value);
2954 err = PyDict_SetItemString(d, name, v);
2955 Py_XDECREF(v);
2956 return err;
2957}
2958
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002959typedef struct {
2960 PyObject_HEAD
2961} NullImporter;
2962
2963static int
2964NullImporter_init(NullImporter *self, PyObject *args, PyObject *kwds)
2965{
2966 char *path;
2967
2968 if (!_PyArg_NoKeywords("NullImporter()", kwds))
2969 return -1;
2970
2971 if (!PyArg_ParseTuple(args, "s:NullImporter",
2972 &path))
2973 return -1;
2974
2975 if (strlen(path) == 0) {
2976 PyErr_SetString(PyExc_ImportError, "empty pathname");
2977 return -1;
2978 } else {
2979#ifndef RISCOS
2980 struct stat statbuf;
2981 int rv;
2982
2983 rv = stat(path, &statbuf);
2984 if (rv == 0) {
2985 /* it exists */
2986 if (S_ISDIR(statbuf.st_mode)) {
2987 /* it's a directory */
2988 PyErr_SetString(PyExc_ImportError,
2989 "existing directory");
2990 return -1;
2991 }
2992 }
2993#else
2994 if (object_exists(path)) {
2995 /* it exists */
2996 if (isdir(path)) {
2997 /* it's a directory */
2998 PyErr_SetString(PyExc_ImportError,
2999 "existing directory");
3000 return -1;
3001 }
3002 }
3003#endif
3004 }
3005 return 0;
3006}
3007
3008static PyObject *
3009NullImporter_find_module(NullImporter *self, PyObject *args)
3010{
3011 Py_RETURN_NONE;
3012}
3013
3014static PyMethodDef NullImporter_methods[] = {
3015 {"find_module", (PyCFunction)NullImporter_find_module, METH_VARARGS,
3016 "Always return None"
3017 },
3018 {NULL} /* Sentinel */
3019};
3020
3021
3022static PyTypeObject NullImporterType = {
3023 PyObject_HEAD_INIT(NULL)
3024 0, /*ob_size*/
3025 "imp.NullImporter", /*tp_name*/
3026 sizeof(NullImporter), /*tp_basicsize*/
3027 0, /*tp_itemsize*/
3028 0, /*tp_dealloc*/
3029 0, /*tp_print*/
3030 0, /*tp_getattr*/
3031 0, /*tp_setattr*/
3032 0, /*tp_compare*/
3033 0, /*tp_repr*/
3034 0, /*tp_as_number*/
3035 0, /*tp_as_sequence*/
3036 0, /*tp_as_mapping*/
3037 0, /*tp_hash */
3038 0, /*tp_call*/
3039 0, /*tp_str*/
3040 0, /*tp_getattro*/
3041 0, /*tp_setattro*/
3042 0, /*tp_as_buffer*/
3043 Py_TPFLAGS_DEFAULT, /*tp_flags*/
3044 "Null importer object", /* tp_doc */
3045 0, /* tp_traverse */
3046 0, /* tp_clear */
3047 0, /* tp_richcompare */
3048 0, /* tp_weaklistoffset */
3049 0, /* tp_iter */
3050 0, /* tp_iternext */
3051 NullImporter_methods, /* tp_methods */
3052 0, /* tp_members */
3053 0, /* tp_getset */
3054 0, /* tp_base */
3055 0, /* tp_dict */
3056 0, /* tp_descr_get */
3057 0, /* tp_descr_set */
3058 0, /* tp_dictoffset */
3059 (initproc)NullImporter_init, /* tp_init */
3060 0, /* tp_alloc */
3061 PyType_GenericNew /* tp_new */
3062};
3063
3064
Jason Tishler6bc06ec2003-09-04 11:59:50 +00003065PyMODINIT_FUNC
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003066initimp(void)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003067{
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003068 PyObject *m, *d;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003069
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003070 if (PyType_Ready(&NullImporterType) < 0)
3071 goto failure;
3072
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003073 m = Py_InitModule4("imp", imp_methods, doc_imp,
3074 NULL, PYTHON_API_VERSION);
Neal Norwitz1ac754f2006-01-19 06:09:39 +00003075 if (m == NULL)
3076 goto failure;
Guido van Rossum79f25d91997-04-29 20:08:16 +00003077 d = PyModule_GetDict(m);
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00003078 if (d == NULL)
3079 goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003080
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003081 if (setint(d, "SEARCH_ERROR", SEARCH_ERROR) < 0) goto failure;
3082 if (setint(d, "PY_SOURCE", PY_SOURCE) < 0) goto failure;
3083 if (setint(d, "PY_COMPILED", PY_COMPILED) < 0) goto failure;
3084 if (setint(d, "C_EXTENSION", C_EXTENSION) < 0) goto failure;
3085 if (setint(d, "PY_RESOURCE", PY_RESOURCE) < 0) goto failure;
3086 if (setint(d, "PKG_DIRECTORY", PKG_DIRECTORY) < 0) goto failure;
3087 if (setint(d, "C_BUILTIN", C_BUILTIN) < 0) goto failure;
3088 if (setint(d, "PY_FROZEN", PY_FROZEN) < 0) goto failure;
Guido van Rossum0f84a341998-08-06 13:36:01 +00003089 if (setint(d, "PY_CODERESOURCE", PY_CODERESOURCE) < 0) goto failure;
Just van Rossum52e14d62002-12-30 22:08:05 +00003090 if (setint(d, "IMP_HOOK", IMP_HOOK) < 0) goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003091
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003092 Py_INCREF(&NullImporterType);
3093 PyModule_AddObject(m, "NullImporter", (PyObject *)&NullImporterType);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003094 failure:
3095 ;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003096}
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003097
3098
Guido van Rossumb18618d2000-05-03 23:44:39 +00003099/* API for embedding applications that want to add their own entries
3100 to the table of built-in modules. This should normally be called
3101 *before* Py_Initialize(). When the table resize fails, -1 is
3102 returned and the existing table is unchanged.
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003103
3104 After a similar function by Just van Rossum. */
3105
3106int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003107PyImport_ExtendInittab(struct _inittab *newtab)
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003108{
3109 static struct _inittab *our_copy = NULL;
3110 struct _inittab *p;
3111 int i, n;
3112
3113 /* Count the number of entries in both tables */
3114 for (n = 0; newtab[n].name != NULL; n++)
3115 ;
3116 if (n == 0)
3117 return 0; /* Nothing to do */
3118 for (i = 0; PyImport_Inittab[i].name != NULL; i++)
3119 ;
3120
3121 /* Allocate new memory for the combined table */
Guido van Rossumb18618d2000-05-03 23:44:39 +00003122 p = our_copy;
3123 PyMem_RESIZE(p, struct _inittab, i+n+1);
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003124 if (p == NULL)
3125 return -1;
3126
3127 /* Copy the tables into the new memory */
3128 if (our_copy != PyImport_Inittab)
3129 memcpy(p, PyImport_Inittab, (i+1) * sizeof(struct _inittab));
3130 PyImport_Inittab = our_copy = p;
3131 memcpy(p+i, newtab, (n+1) * sizeof(struct _inittab));
3132
3133 return 0;
3134}
3135
3136/* Shorthand to add a single entry given a name and a function */
3137
3138int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003139PyImport_AppendInittab(char *name, void (*initfunc)(void))
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003140{
3141 struct _inittab newtab[2];
3142
3143 memset(newtab, '\0', sizeof newtab);
3144
3145 newtab[0].name = name;
3146 newtab[0].initfunc = initfunc;
3147
3148 return PyImport_ExtendInittab(newtab);
3149}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00003150
3151#ifdef __cplusplus
3152}
3153#endif