blob: 72138c2ea8bc6b8db29281fc2d7c12d4d95b80b5 [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
Guido van Rossumed1170e1999-12-20 21:23:41 +000097static const struct filedescr _PyImport_StandardFiletab[] = {
Jack Jansenc88da1f2002-05-28 10:58:19 +000098 {".py", "U", PY_SOURCE},
Martin v. Löwis6238d2b2002-06-30 15:26:10 +000099#ifdef MS_WINDOWS
Jack Jansenc88da1f2002-05-28 10:58:19 +0000100 {".pyw", "U", PY_SOURCE},
Tim Peters36515e22001-11-18 04:06:29 +0000101#endif
Guido van Rossumed1170e1999-12-20 21:23:41 +0000102 {".pyc", "rb", PY_COMPILED},
103 {0, 0}
104};
105
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000106static PyTypeObject NullImporterType; /* Forward reference */
107
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000108/* Initialize things */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000109
110void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000111_PyImport_Init(void)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000112{
Guido van Rossumed1170e1999-12-20 21:23:41 +0000113 const struct filedescr *scan;
114 struct filedescr *filetab;
115 int countD = 0;
116 int countS = 0;
117
118 /* prepare _PyImport_Filetab: copy entries from
119 _PyImport_DynLoadFiletab and _PyImport_StandardFiletab.
120 */
Guido van Rossum04110fb2007-08-24 16:32:05 +0000121#ifdef HAVE_DYNAMIC_LOADING
Guido van Rossumed1170e1999-12-20 21:23:41 +0000122 for (scan = _PyImport_DynLoadFiletab; scan->suffix != NULL; ++scan)
123 ++countD;
Guido van Rossum04110fb2007-08-24 16:32:05 +0000124#endif
Guido van Rossumed1170e1999-12-20 21:23:41 +0000125 for (scan = _PyImport_StandardFiletab; scan->suffix != NULL; ++scan)
126 ++countS;
Guido van Rossumb18618d2000-05-03 23:44:39 +0000127 filetab = PyMem_NEW(struct filedescr, countD + countS + 1);
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000128 if (filetab == NULL)
129 Py_FatalError("Can't initialize import file table.");
Guido van Rossum04110fb2007-08-24 16:32:05 +0000130#ifdef HAVE_DYNAMIC_LOADING
Guido van Rossumed1170e1999-12-20 21:23:41 +0000131 memcpy(filetab, _PyImport_DynLoadFiletab,
132 countD * sizeof(struct filedescr));
Guido van Rossum04110fb2007-08-24 16:32:05 +0000133#endif
Guido van Rossumed1170e1999-12-20 21:23:41 +0000134 memcpy(filetab + countD, _PyImport_StandardFiletab,
135 countS * sizeof(struct filedescr));
136 filetab[countD + countS].suffix = NULL;
137
138 _PyImport_Filetab = filetab;
139
Guido van Rossum0824f631997-03-11 18:37:35 +0000140 if (Py_OptimizeFlag) {
Guido van Rossumed1170e1999-12-20 21:23:41 +0000141 /* Replace ".pyc" with ".pyo" in _PyImport_Filetab */
142 for (; filetab->suffix != NULL; filetab++) {
143 if (strcmp(filetab->suffix, ".pyc") == 0)
144 filetab->suffix = ".pyo";
Guido van Rossum0824f631997-03-11 18:37:35 +0000145 }
146 }
Guido van Rossum96774c12000-05-01 20:19:08 +0000147
Guido van Rossum572dbf82007-04-27 23:53:51 +0000148 {
Guido van Rossum96774c12000-05-01 20:19:08 +0000149 /* Fix the pyc_magic so that byte compiled code created
150 using the all-Unicode method doesn't interfere with
151 code created in normal operation mode. */
152 pyc_magic = MAGIC + 1;
153 }
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000154}
155
Guido van Rossum25ce5661997-08-02 03:10:38 +0000156void
Just van Rossum52e14d62002-12-30 22:08:05 +0000157_PyImportHooks_Init(void)
158{
159 PyObject *v, *path_hooks = NULL, *zimpimport;
160 int err = 0;
161
162 /* adding sys.path_hooks and sys.path_importer_cache, setting up
163 zipimport */
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000164 if (PyType_Ready(&NullImporterType) < 0)
165 goto error;
Just van Rossum52e14d62002-12-30 22:08:05 +0000166
167 if (Py_VerboseFlag)
168 PySys_WriteStderr("# installing zipimport hook\n");
169
170 v = PyList_New(0);
171 if (v == NULL)
172 goto error;
173 err = PySys_SetObject("meta_path", v);
174 Py_DECREF(v);
175 if (err)
176 goto error;
177 v = PyDict_New();
178 if (v == NULL)
179 goto error;
180 err = PySys_SetObject("path_importer_cache", v);
181 Py_DECREF(v);
182 if (err)
183 goto error;
184 path_hooks = PyList_New(0);
185 if (path_hooks == NULL)
186 goto error;
187 err = PySys_SetObject("path_hooks", path_hooks);
188 if (err) {
189 error:
190 PyErr_Print();
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000191 Py_FatalError("initializing sys.meta_path, sys.path_hooks, "
192 "path_importer_cache, or NullImporter failed"
193 );
Just van Rossum52e14d62002-12-30 22:08:05 +0000194 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000195
Just van Rossum52e14d62002-12-30 22:08:05 +0000196 zimpimport = PyImport_ImportModule("zipimport");
197 if (zimpimport == NULL) {
198 PyErr_Clear(); /* No zip import module -- okay */
199 if (Py_VerboseFlag)
200 PySys_WriteStderr("# can't import zipimport\n");
201 }
202 else {
203 PyObject *zipimporter = PyObject_GetAttrString(zimpimport,
204 "zipimporter");
205 Py_DECREF(zimpimport);
206 if (zipimporter == NULL) {
207 PyErr_Clear(); /* No zipimporter object -- okay */
208 if (Py_VerboseFlag)
209 PySys_WriteStderr(
Fred Drake1e5fc552003-07-11 15:01:02 +0000210 "# can't import zipimport.zipimporter\n");
Just van Rossum52e14d62002-12-30 22:08:05 +0000211 }
212 else {
213 /* sys.path_hooks.append(zipimporter) */
214 err = PyList_Append(path_hooks, zipimporter);
215 Py_DECREF(zipimporter);
216 if (err)
217 goto error;
218 if (Py_VerboseFlag)
219 PySys_WriteStderr(
220 "# installed zipimport hook\n");
221 }
222 }
223 Py_DECREF(path_hooks);
224}
225
226void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000227_PyImport_Fini(void)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000228{
229 Py_XDECREF(extensions);
230 extensions = NULL;
Barry Warsaw84294482000-10-03 16:02:05 +0000231 PyMem_DEL(_PyImport_Filetab);
232 _PyImport_Filetab = NULL;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000233}
234
235
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000236/* Locking primitives to prevent parallel imports of the same module
237 in different threads to return with a partially loaded module.
238 These calls are serialized by the global interpreter lock. */
239
240#ifdef WITH_THREAD
241
Guido van Rossum49b56061998-10-01 20:42:43 +0000242#include "pythread.h"
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000243
Guido van Rossum65d5b571998-12-21 19:32:43 +0000244static PyThread_type_lock import_lock = 0;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000245static long import_lock_thread = -1;
246static int import_lock_level = 0;
247
248static void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000249lock_import(void)
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000250{
Guido van Rossum65d5b571998-12-21 19:32:43 +0000251 long me = PyThread_get_thread_ident();
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000252 if (me == -1)
253 return; /* Too bad */
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000254 if (import_lock == NULL) {
Guido van Rossum65d5b571998-12-21 19:32:43 +0000255 import_lock = PyThread_allocate_lock();
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000256 if (import_lock == NULL)
257 return; /* Nothing much we can do. */
258 }
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000259 if (import_lock_thread == me) {
260 import_lock_level++;
261 return;
262 }
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000263 if (import_lock_thread != -1 || !PyThread_acquire_lock(import_lock, 0))
264 {
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000265 PyThreadState *tstate = PyEval_SaveThread();
Guido van Rossum65d5b571998-12-21 19:32:43 +0000266 PyThread_acquire_lock(import_lock, 1);
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000267 PyEval_RestoreThread(tstate);
268 }
269 import_lock_thread = me;
270 import_lock_level = 1;
271}
272
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000273static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000274unlock_import(void)
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000275{
Guido van Rossum65d5b571998-12-21 19:32:43 +0000276 long me = PyThread_get_thread_ident();
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000277 if (me == -1 || import_lock == NULL)
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000278 return 0; /* Too bad */
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000279 if (import_lock_thread != me)
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000280 return -1;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000281 import_lock_level--;
282 if (import_lock_level == 0) {
283 import_lock_thread = -1;
Guido van Rossum65d5b571998-12-21 19:32:43 +0000284 PyThread_release_lock(import_lock);
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000285 }
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000286 return 1;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000287}
288
Guido van Rossum8ee3e5a2005-09-14 18:09:42 +0000289/* This function is called from PyOS_AfterFork to ensure that newly
290 created child processes do not share locks with the parent. */
291
292void
293_PyImport_ReInitLock(void)
294{
295#ifdef _AIX
296 if (import_lock != NULL)
297 import_lock = PyThread_allocate_lock();
298#endif
299}
300
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000301#else
302
303#define lock_import()
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000304#define unlock_import() 0
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000305
306#endif
307
Tim Peters69232342001-08-30 05:16:13 +0000308static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000309imp_lock_held(PyObject *self, PyObject *noargs)
Tim Peters69232342001-08-30 05:16:13 +0000310{
Tim Peters69232342001-08-30 05:16:13 +0000311#ifdef WITH_THREAD
Guido van Rossumb8bff3f2002-04-07 06:34:38 +0000312 return PyBool_FromLong(import_lock_thread != -1);
Tim Peters69232342001-08-30 05:16:13 +0000313#else
Guido van Rossumb8bff3f2002-04-07 06:34:38 +0000314 return PyBool_FromLong(0);
Tim Peters69232342001-08-30 05:16:13 +0000315#endif
316}
317
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000318static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000319imp_acquire_lock(PyObject *self, PyObject *noargs)
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000320{
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000321#ifdef WITH_THREAD
322 lock_import();
323#endif
Neal Norwitz2294c0d2003-02-12 23:02:21 +0000324 Py_INCREF(Py_None);
325 return Py_None;
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000326}
327
328static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000329imp_release_lock(PyObject *self, PyObject *noargs)
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000330{
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000331#ifdef WITH_THREAD
332 if (unlock_import() < 0) {
333 PyErr_SetString(PyExc_RuntimeError,
334 "not holding the import lock");
335 return NULL;
336 }
337#endif
Neal Norwitz2294c0d2003-02-12 23:02:21 +0000338 Py_INCREF(Py_None);
339 return Py_None;
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000340}
341
Guido van Rossumd8faa362007-04-27 19:54:29 +0000342static void
343imp_modules_reloading_clear(void)
344{
345 PyInterpreterState *interp = PyThreadState_Get()->interp;
346 if (interp->modules_reloading != NULL)
347 PyDict_Clear(interp->modules_reloading);
348}
349
Guido van Rossum25ce5661997-08-02 03:10:38 +0000350/* Helper for sys */
351
352PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000353PyImport_GetModuleDict(void)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000354{
Nicholas Bastine5662ae2004-03-24 22:22:12 +0000355 PyInterpreterState *interp = PyThreadState_GET()->interp;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000356 if (interp->modules == NULL)
357 Py_FatalError("PyImport_GetModuleDict: no module dictionary!");
358 return interp->modules;
359}
360
Guido van Rossum3f5da241990-12-20 15:06:42 +0000361
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000362/* List of names to clear in sys */
363static char* sys_deletes[] = {
Collin Winter670e6922007-03-21 02:57:17 +0000364 "path", "argv", "ps1", "ps2",
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000365 "last_type", "last_value", "last_traceback",
Just van Rossum52e14d62002-12-30 22:08:05 +0000366 "path_hooks", "path_importer_cache", "meta_path",
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000367 NULL
368};
369
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000370static char* sys_files[] = {
371 "stdin", "__stdin__",
372 "stdout", "__stdout__",
373 "stderr", "__stderr__",
374 NULL
375};
376
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000377
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000378/* Un-initialize things, as good as we can */
Guido van Rossum3f5da241990-12-20 15:06:42 +0000379
Guido van Rossum3f5da241990-12-20 15:06:42 +0000380void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000381PyImport_Cleanup(void)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000382{
Martin v. Löwis18e16552006-02-15 17:27:45 +0000383 Py_ssize_t pos, ndone;
Guido van Rossum758eec01998-01-19 21:58:26 +0000384 char *name;
385 PyObject *key, *value, *dict;
Nicholas Bastine5662ae2004-03-24 22:22:12 +0000386 PyInterpreterState *interp = PyThreadState_GET()->interp;
Guido van Rossum758eec01998-01-19 21:58:26 +0000387 PyObject *modules = interp->modules;
388
389 if (modules == NULL)
390 return; /* Already done */
391
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000392 /* Delete some special variables first. These are common
393 places where user values hide and people complain when their
394 destructors fail. Since the modules containing them are
395 deleted *last* of all, they would come too late in the normal
396 destruction order. Sigh. */
397
398 value = PyDict_GetItemString(modules, "__builtin__");
399 if (value != NULL && PyModule_Check(value)) {
400 dict = PyModule_GetDict(value);
401 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000402 PySys_WriteStderr("# clear __builtin__._\n");
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000403 PyDict_SetItemString(dict, "_", Py_None);
404 }
405 value = PyDict_GetItemString(modules, "sys");
406 if (value != NULL && PyModule_Check(value)) {
407 char **p;
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000408 PyObject *v;
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000409 dict = PyModule_GetDict(value);
410 for (p = sys_deletes; *p != NULL; p++) {
411 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000412 PySys_WriteStderr("# clear sys.%s\n", *p);
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000413 PyDict_SetItemString(dict, *p, Py_None);
414 }
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000415 for (p = sys_files; *p != NULL; p+=2) {
416 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000417 PySys_WriteStderr("# restore sys.%s\n", *p);
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000418 v = PyDict_GetItemString(dict, *(p+1));
419 if (v == NULL)
420 v = Py_None;
421 PyDict_SetItemString(dict, *p, v);
422 }
423 }
424
425 /* First, delete __main__ */
426 value = PyDict_GetItemString(modules, "__main__");
427 if (value != NULL && PyModule_Check(value)) {
428 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000429 PySys_WriteStderr("# cleanup __main__\n");
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000430 _PyModule_Clear(value);
431 PyDict_SetItemString(modules, "__main__", Py_None);
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000432 }
433
Guido van Rossum758eec01998-01-19 21:58:26 +0000434 /* The special treatment of __builtin__ here is because even
435 when it's not referenced as a module, its dictionary is
436 referenced by almost every module's __builtins__. Since
437 deleting a module clears its dictionary (even if there are
438 references left to it), we need to delete the __builtin__
439 module last. Likewise, we don't delete sys until the very
440 end because it is implicitly referenced (e.g. by print).
441
442 Also note that we 'delete' modules by replacing their entry
443 in the modules dict with None, rather than really deleting
444 them; this avoids a rehash of the modules dictionary and
445 also marks them as "non existent" so they won't be
446 re-imported. */
447
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000448 /* Next, repeatedly delete modules with a reference count of
Guido van Rossum758eec01998-01-19 21:58:26 +0000449 one (skipping __builtin__ and sys) and delete them */
450 do {
451 ndone = 0;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000452 pos = 0;
Guido van Rossum758eec01998-01-19 21:58:26 +0000453 while (PyDict_Next(modules, &pos, &key, &value)) {
454 if (value->ob_refcnt != 1)
455 continue;
Guido van Rossum566373e1998-10-01 15:24:50 +0000456 if (PyString_Check(key) && PyModule_Check(value)) {
457 name = PyString_AS_STRING(key);
Guido van Rossum758eec01998-01-19 21:58:26 +0000458 if (strcmp(name, "__builtin__") == 0)
459 continue;
460 if (strcmp(name, "sys") == 0)
461 continue;
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000462 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000463 PySys_WriteStderr(
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000464 "# cleanup[1] %s\n", name);
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000465 _PyModule_Clear(value);
Guido van Rossum758eec01998-01-19 21:58:26 +0000466 PyDict_SetItem(modules, key, Py_None);
467 ndone++;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000468 }
469 }
Guido van Rossum758eec01998-01-19 21:58:26 +0000470 } while (ndone > 0);
471
Guido van Rossum758eec01998-01-19 21:58:26 +0000472 /* Next, delete all modules (still skipping __builtin__ and sys) */
473 pos = 0;
474 while (PyDict_Next(modules, &pos, &key, &value)) {
Guido van Rossum566373e1998-10-01 15:24:50 +0000475 if (PyString_Check(key) && PyModule_Check(value)) {
476 name = PyString_AS_STRING(key);
Guido van Rossum758eec01998-01-19 21:58:26 +0000477 if (strcmp(name, "__builtin__") == 0)
478 continue;
479 if (strcmp(name, "sys") == 0)
480 continue;
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000481 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000482 PySys_WriteStderr("# cleanup[2] %s\n", name);
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000483 _PyModule_Clear(value);
Guido van Rossum758eec01998-01-19 21:58:26 +0000484 PyDict_SetItem(modules, key, Py_None);
485 }
486 }
487
488 /* Next, delete sys and __builtin__ (in that order) */
489 value = PyDict_GetItemString(modules, "sys");
490 if (value != NULL && PyModule_Check(value)) {
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000491 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000492 PySys_WriteStderr("# cleanup sys\n");
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000493 _PyModule_Clear(value);
Guido van Rossum758eec01998-01-19 21:58:26 +0000494 PyDict_SetItemString(modules, "sys", Py_None);
495 }
496 value = PyDict_GetItemString(modules, "__builtin__");
497 if (value != NULL && PyModule_Check(value)) {
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000498 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000499 PySys_WriteStderr("# cleanup __builtin__\n");
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000500 _PyModule_Clear(value);
Guido van Rossum758eec01998-01-19 21:58:26 +0000501 PyDict_SetItemString(modules, "__builtin__", Py_None);
502 }
503
504 /* Finally, clear and delete the modules directory */
505 PyDict_Clear(modules);
506 interp->modules = NULL;
507 Py_DECREF(modules);
Guido van Rossumd8faa362007-04-27 19:54:29 +0000508 Py_CLEAR(interp->modules_reloading);
Guido van Rossum8d15b5d1990-10-26 14:58:58 +0000509}
Guido van Rossum7f133ed1991-02-19 12:23:57 +0000510
511
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000512/* Helper for pythonrun.c -- return magic number */
513
514long
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000515PyImport_GetMagicNumber(void)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000516{
Guido van Rossum96774c12000-05-01 20:19:08 +0000517 return pyc_magic;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000518}
519
520
Guido van Rossum25ce5661997-08-02 03:10:38 +0000521/* Magic for extension modules (built-in as well as dynamically
522 loaded). To prevent initializing an extension module more than
523 once, we keep a static dictionary 'extensions' keyed by module name
524 (for built-in modules) or by filename (for dynamically loaded
Barry Warsaw92883382001-08-13 23:05:44 +0000525 modules), containing these modules. A copy of the module's
Guido van Rossum25ce5661997-08-02 03:10:38 +0000526 dictionary is stored by calling _PyImport_FixupExtension()
527 immediately after the module initialization function succeeds. A
528 copy can be retrieved from there by calling
529 _PyImport_FindExtension(). */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000530
Guido van Rossum79f25d91997-04-29 20:08:16 +0000531PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000532_PyImport_FixupExtension(char *name, char *filename)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000533{
Guido van Rossum25ce5661997-08-02 03:10:38 +0000534 PyObject *modules, *mod, *dict, *copy;
535 if (extensions == NULL) {
536 extensions = PyDict_New();
537 if (extensions == NULL)
538 return NULL;
539 }
540 modules = PyImport_GetModuleDict();
541 mod = PyDict_GetItemString(modules, name);
542 if (mod == NULL || !PyModule_Check(mod)) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000543 PyErr_Format(PyExc_SystemError,
544 "_PyImport_FixupExtension: module %.200s not loaded", name);
Guido van Rossum25ce5661997-08-02 03:10:38 +0000545 return NULL;
546 }
547 dict = PyModule_GetDict(mod);
548 if (dict == NULL)
549 return NULL;
Fred Drake9cd0efc2001-10-25 21:38:59 +0000550 copy = PyDict_Copy(dict);
Guido van Rossum25ce5661997-08-02 03:10:38 +0000551 if (copy == NULL)
552 return NULL;
553 PyDict_SetItemString(extensions, filename, copy);
554 Py_DECREF(copy);
555 return copy;
556}
557
558PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000559_PyImport_FindExtension(char *name, char *filename)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000560{
Fred Drake9cd0efc2001-10-25 21:38:59 +0000561 PyObject *dict, *mod, *mdict;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000562 if (extensions == NULL)
563 return NULL;
564 dict = PyDict_GetItemString(extensions, filename);
565 if (dict == NULL)
566 return NULL;
567 mod = PyImport_AddModule(name);
568 if (mod == NULL)
569 return NULL;
570 mdict = PyModule_GetDict(mod);
571 if (mdict == NULL)
572 return NULL;
Fred Drake9cd0efc2001-10-25 21:38:59 +0000573 if (PyDict_Update(mdict, dict))
Guido van Rossum25ce5661997-08-02 03:10:38 +0000574 return NULL;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000575 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000576 PySys_WriteStderr("import %s # previously loaded (%s)\n",
Guido van Rossum25ce5661997-08-02 03:10:38 +0000577 name, filename);
578 return mod;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000579}
580
581
582/* Get the module object corresponding to a module name.
583 First check the modules dictionary if there's one there,
Walter Dörwaldf0dfc7a2003-10-20 14:01:56 +0000584 if not, create a new one and insert it in the modules dictionary.
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000585 Because the former action is most common, THIS DOES NOT RETURN A
586 'NEW' REFERENCE! */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000587
Guido van Rossum79f25d91997-04-29 20:08:16 +0000588PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000589PyImport_AddModule(const char *name)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000590{
Guido van Rossum25ce5661997-08-02 03:10:38 +0000591 PyObject *modules = PyImport_GetModuleDict();
Guido van Rossum79f25d91997-04-29 20:08:16 +0000592 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000593
Guido van Rossum25ce5661997-08-02 03:10:38 +0000594 if ((m = PyDict_GetItemString(modules, name)) != NULL &&
Guido van Rossum79f25d91997-04-29 20:08:16 +0000595 PyModule_Check(m))
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000596 return m;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000597 m = PyModule_New(name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000598 if (m == NULL)
599 return NULL;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000600 if (PyDict_SetItemString(modules, name, m) != 0) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000601 Py_DECREF(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000602 return NULL;
603 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000604 Py_DECREF(m); /* Yes, it still exists, in modules! */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000605
606 return m;
607}
608
Tim Peters1cd70172004-08-02 03:52:12 +0000609/* Remove name from sys.modules, if it's there. */
610static void
611_RemoveModule(const char *name)
612{
613 PyObject *modules = PyImport_GetModuleDict();
614 if (PyDict_GetItemString(modules, name) == NULL)
615 return;
616 if (PyDict_DelItemString(modules, name) < 0)
617 Py_FatalError("import: deleting existing key in"
618 "sys.modules failed");
619}
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000620
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000621/* Execute a code object in a module and return the module object
Tim Peters1cd70172004-08-02 03:52:12 +0000622 * WITH INCREMENTED REFERENCE COUNT. If an error occurs, name is
623 * removed from sys.modules, to avoid leaving damaged module objects
624 * in sys.modules. The caller may wish to restore the original
625 * module object (if any) in this case; PyImport_ReloadModule is an
626 * example.
627 */
Guido van Rossum79f25d91997-04-29 20:08:16 +0000628PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000629PyImport_ExecCodeModule(char *name, PyObject *co)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000630{
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000631 return PyImport_ExecCodeModuleEx(name, co, (char *)NULL);
632}
633
634PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000635PyImport_ExecCodeModuleEx(char *name, PyObject *co, char *pathname)
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000636{
Guido van Rossum25ce5661997-08-02 03:10:38 +0000637 PyObject *modules = PyImport_GetModuleDict();
Guido van Rossum79f25d91997-04-29 20:08:16 +0000638 PyObject *m, *d, *v;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000639
Guido van Rossum79f25d91997-04-29 20:08:16 +0000640 m = PyImport_AddModule(name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000641 if (m == NULL)
642 return NULL;
Jeremy Hyltonecd91292004-01-02 23:25:32 +0000643 /* If the module is being reloaded, we get the old module back
644 and re-use its dict to exec the new code. */
Guido van Rossum79f25d91997-04-29 20:08:16 +0000645 d = PyModule_GetDict(m);
646 if (PyDict_GetItemString(d, "__builtins__") == NULL) {
647 if (PyDict_SetItemString(d, "__builtins__",
648 PyEval_GetBuiltins()) != 0)
Tim Peters1cd70172004-08-02 03:52:12 +0000649 goto error;
Guido van Rossum6135a871995-01-09 17:53:26 +0000650 }
Guido van Rossum9c9a07c1996-05-16 20:43:40 +0000651 /* Remember the filename as the __file__ attribute */
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000652 v = NULL;
653 if (pathname != NULL) {
654 v = PyString_FromString(pathname);
655 if (v == NULL)
656 PyErr_Clear();
657 }
658 if (v == NULL) {
659 v = ((PyCodeObject *)co)->co_filename;
660 Py_INCREF(v);
661 }
662 if (PyDict_SetItemString(d, "__file__", v) != 0)
Guido van Rossum79f25d91997-04-29 20:08:16 +0000663 PyErr_Clear(); /* Not important enough to report */
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000664 Py_DECREF(v);
665
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000666 v = PyEval_EvalCode((PyCodeObject *)co, d, d);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000667 if (v == NULL)
Tim Peters1cd70172004-08-02 03:52:12 +0000668 goto error;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000669 Py_DECREF(v);
Guido van Rossumb65e85c1997-07-10 18:00:45 +0000670
Guido van Rossum25ce5661997-08-02 03:10:38 +0000671 if ((m = PyDict_GetItemString(modules, name)) == NULL) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000672 PyErr_Format(PyExc_ImportError,
673 "Loaded module %.200s not found in sys.modules",
674 name);
Guido van Rossumb65e85c1997-07-10 18:00:45 +0000675 return NULL;
676 }
677
Guido van Rossum79f25d91997-04-29 20:08:16 +0000678 Py_INCREF(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000679
680 return m;
Tim Peters1cd70172004-08-02 03:52:12 +0000681
682 error:
683 _RemoveModule(name);
684 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000685}
686
687
688/* Given a pathname for a Python source file, fill a buffer with the
689 pathname for the corresponding compiled file. Return the pathname
690 for the compiled file, or NULL if there's no space in the buffer.
691 Doesn't set an exception. */
692
693static char *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000694make_compiled_pathname(char *pathname, char *buf, size_t buflen)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000695{
Tim Petersc1731372001-08-04 08:12:36 +0000696 size_t len = strlen(pathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000697 if (len+2 > buflen)
698 return NULL;
Tim Petersc1731372001-08-04 08:12:36 +0000699
Martin v. Löwis6238d2b2002-06-30 15:26:10 +0000700#ifdef MS_WINDOWS
Tim Petersc1731372001-08-04 08:12:36 +0000701 /* Treat .pyw as if it were .py. The case of ".pyw" must match
702 that used in _PyImport_StandardFiletab. */
703 if (len >= 4 && strcmp(&pathname[len-4], ".pyw") == 0)
704 --len; /* pretend 'w' isn't there */
705#endif
706 memcpy(buf, pathname, len);
707 buf[len] = Py_OptimizeFlag ? 'o' : 'c';
708 buf[len+1] = '\0';
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000709
710 return buf;
711}
712
713
714/* Given a pathname for a Python source file, its time of last
715 modification, and a pathname for a compiled file, check whether the
716 compiled file represents the same version of the source. If so,
717 return a FILE pointer for the compiled file, positioned just after
718 the header; if not, return NULL.
719 Doesn't set an exception. */
720
721static FILE *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000722check_compiled_module(char *pathname, time_t mtime, char *cpathname)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000723{
724 FILE *fp;
725 long magic;
726 long pyc_mtime;
727
728 fp = fopen(cpathname, "rb");
729 if (fp == NULL)
730 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000731 magic = PyMarshal_ReadLongFromFile(fp);
Guido van Rossum96774c12000-05-01 20:19:08 +0000732 if (magic != pyc_magic) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000733 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000734 PySys_WriteStderr("# %s has bad magic\n", cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000735 fclose(fp);
736 return NULL;
737 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000738 pyc_mtime = PyMarshal_ReadLongFromFile(fp);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000739 if (pyc_mtime != mtime) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000740 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000741 PySys_WriteStderr("# %s has bad mtime\n", cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000742 fclose(fp);
743 return NULL;
744 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000745 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000746 PySys_WriteStderr("# %s matches %s\n", cpathname, pathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000747 return fp;
748}
749
750
751/* Read a code object from a file and check it for validity */
752
Guido van Rossum79f25d91997-04-29 20:08:16 +0000753static PyCodeObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000754read_compiled_module(char *cpathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000755{
Guido van Rossum79f25d91997-04-29 20:08:16 +0000756 PyObject *co;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000757
Tim Petersd9b9ac82001-01-28 00:27:39 +0000758 co = PyMarshal_ReadLastObjectFromFile(fp);
Armin Rigo01ab2792004-03-26 15:09:27 +0000759 if (co == NULL)
760 return NULL;
761 if (!PyCode_Check(co)) {
762 PyErr_Format(PyExc_ImportError,
763 "Non-code object in %.200s", cpathname);
764 Py_DECREF(co);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000765 return NULL;
766 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000767 return (PyCodeObject *)co;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000768}
769
770
771/* Load a module from a compiled file, execute it, and return its
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000772 module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000773
Guido van Rossum79f25d91997-04-29 20:08:16 +0000774static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000775load_compiled_module(char *name, char *cpathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000776{
777 long magic;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000778 PyCodeObject *co;
779 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000780
Guido van Rossum79f25d91997-04-29 20:08:16 +0000781 magic = PyMarshal_ReadLongFromFile(fp);
Guido van Rossum96774c12000-05-01 20:19:08 +0000782 if (magic != pyc_magic) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000783 PyErr_Format(PyExc_ImportError,
784 "Bad magic number in %.200s", cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000785 return NULL;
786 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000787 (void) PyMarshal_ReadLongFromFile(fp);
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000788 co = read_compiled_module(cpathname, fp);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000789 if (co == NULL)
790 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000791 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000792 PySys_WriteStderr("import %s # precompiled from %s\n",
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000793 name, cpathname);
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000794 m = PyImport_ExecCodeModuleEx(name, (PyObject *)co, cpathname);
Guido van Rossum79f25d91997-04-29 20:08:16 +0000795 Py_DECREF(co);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000796
797 return m;
798}
799
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000800/* Parse a source file and return the corresponding code object */
801
Guido van Rossum79f25d91997-04-29 20:08:16 +0000802static PyCodeObject *
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000803parse_source_module(const char *pathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000804{
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000805 PyCodeObject *co = NULL;
806 mod_ty mod;
Thomas Wouters89f507f2006-12-13 04:49:30 +0000807 PyArena *arena = PyArena_New();
808 if (arena == NULL)
809 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000810
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000811 mod = PyParser_ASTFromFile(fp, pathname, Py_file_input, 0, 0, 0,
Neal Norwitzadb69fc2005-12-17 20:54:49 +0000812 NULL, arena);
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000813 if (mod) {
Neal Norwitzadb69fc2005-12-17 20:54:49 +0000814 co = PyAST_Compile(mod, pathname, NULL, arena);
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000815 }
Thomas Wouters89f507f2006-12-13 04:49:30 +0000816 PyArena_Free(arena);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000817 return co;
818}
819
820
Guido van Rossum55a83382000-09-20 20:31:38 +0000821/* Helper to open a bytecode file for writing in exclusive mode */
822
823static FILE *
824open_exclusive(char *filename)
825{
826#if defined(O_EXCL)&&defined(O_CREAT)&&defined(O_WRONLY)&&defined(O_TRUNC)
827 /* Use O_EXCL to avoid a race condition when another process tries to
828 write the same file. When that happens, our open() call fails,
829 which is just fine (since it's only a cache).
830 XXX If the file exists and is writable but the directory is not
831 writable, the file will never be written. Oh well.
832 */
833 int fd;
834 (void) unlink(filename);
Tim Peters42c83af2000-09-29 04:03:10 +0000835 fd = open(filename, O_EXCL|O_CREAT|O_WRONLY|O_TRUNC
836#ifdef O_BINARY
837 |O_BINARY /* necessary for Windows */
838#endif
Martin v. Löwis79acb9e2002-12-06 12:48:53 +0000839#ifdef __VMS
Martin v. Löwis18e16552006-02-15 17:27:45 +0000840 , 0666, "ctxt=bin", "shr=nil"
Martin v. Löwis79acb9e2002-12-06 12:48:53 +0000841#else
Martin v. Löwis18e16552006-02-15 17:27:45 +0000842 , 0666
Martin v. Löwis79acb9e2002-12-06 12:48:53 +0000843#endif
Martin v. Löwis18e16552006-02-15 17:27:45 +0000844 );
Guido van Rossum55a83382000-09-20 20:31:38 +0000845 if (fd < 0)
846 return NULL;
847 return fdopen(fd, "wb");
848#else
849 /* Best we can do -- on Windows this can't happen anyway */
850 return fopen(filename, "wb");
851#endif
852}
853
854
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000855/* Write a compiled module to a file, placing the time of last
856 modification of its source into the header.
857 Errors are ignored, if a write error occurs an attempt is made to
858 remove the file. */
859
860static void
Martin v. Löwis18e16552006-02-15 17:27:45 +0000861write_compiled_module(PyCodeObject *co, char *cpathname, time_t mtime)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000862{
863 FILE *fp;
864
Guido van Rossum55a83382000-09-20 20:31:38 +0000865 fp = open_exclusive(cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000866 if (fp == NULL) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000867 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000868 PySys_WriteStderr(
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000869 "# can't create %s\n", cpathname);
870 return;
871 }
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000872 PyMarshal_WriteLongToFile(pyc_magic, fp, Py_MARSHAL_VERSION);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000873 /* First write a 0 for mtime */
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000874 PyMarshal_WriteLongToFile(0L, fp, Py_MARSHAL_VERSION);
875 PyMarshal_WriteObjectToFile((PyObject *)co, fp, Py_MARSHAL_VERSION);
Armin Rigo01ab2792004-03-26 15:09:27 +0000876 if (fflush(fp) != 0 || ferror(fp)) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000877 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000878 PySys_WriteStderr("# can't write %s\n", cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000879 /* Don't keep partial file */
880 fclose(fp);
881 (void) unlink(cpathname);
882 return;
883 }
884 /* Now write the true mtime */
885 fseek(fp, 4L, 0);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000886 assert(mtime < LONG_MAX);
Martin v. Löwis725507b2006-03-07 12:08:51 +0000887 PyMarshal_WriteLongToFile((long)mtime, fp, Py_MARSHAL_VERSION);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000888 fflush(fp);
889 fclose(fp);
Guido van Rossum79f25d91997-04-29 20:08:16 +0000890 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000891 PySys_WriteStderr("# wrote %s\n", cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000892}
893
894
895/* Load a source module from a given file and return its module
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000896 object WITH INCREMENTED REFERENCE COUNT. If there's a matching
897 byte-compiled file, use that instead. */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000898
Guido van Rossum79f25d91997-04-29 20:08:16 +0000899static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000900load_source_module(char *name, char *pathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000901{
Fred Drake4c82b232000-06-30 16:18:57 +0000902 time_t mtime;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000903 FILE *fpc;
904 char buf[MAXPATHLEN+1];
905 char *cpathname;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000906 PyCodeObject *co;
907 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000908
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000909 mtime = PyOS_GetLastModificationTime(pathname, fp);
Neal Norwitz708e51a2005-10-03 04:48:15 +0000910 if (mtime == (time_t)(-1)) {
911 PyErr_Format(PyExc_RuntimeError,
912 "unable to get modification time from '%s'",
913 pathname);
Fred Drake4c82b232000-06-30 16:18:57 +0000914 return NULL;
Neal Norwitz708e51a2005-10-03 04:48:15 +0000915 }
Fred Drake4c82b232000-06-30 16:18:57 +0000916#if SIZEOF_TIME_T > 4
917 /* Python's .pyc timestamp handling presumes that the timestamp fits
918 in 4 bytes. This will be fine until sometime in the year 2038,
919 when a 4-byte signed time_t will overflow.
920 */
921 if (mtime >> 32) {
922 PyErr_SetString(PyExc_OverflowError,
Fred Drakec63d3e92001-03-01 06:33:32 +0000923 "modification time overflows a 4 byte field");
Fred Drake4c82b232000-06-30 16:18:57 +0000924 return NULL;
925 }
926#endif
Tim Peters36515e22001-11-18 04:06:29 +0000927 cpathname = make_compiled_pathname(pathname, buf,
Jeremy Hylton37832f02001-04-13 17:50:20 +0000928 (size_t)MAXPATHLEN + 1);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000929 if (cpathname != NULL &&
930 (fpc = check_compiled_module(pathname, mtime, cpathname))) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000931 co = read_compiled_module(cpathname, fpc);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000932 fclose(fpc);
933 if (co == NULL)
934 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000935 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000936 PySys_WriteStderr("import %s # precompiled from %s\n",
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000937 name, cpathname);
Guido van Rossumafd3dae1998-08-25 18:44:34 +0000938 pathname = cpathname;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000939 }
940 else {
941 co = parse_source_module(pathname, fp);
942 if (co == NULL)
943 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000944 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000945 PySys_WriteStderr("import %s # from %s\n",
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000946 name, pathname);
Thomas Wouters00ee7ba2006-08-21 19:07:27 +0000947 if (cpathname)
948 write_compiled_module(co, cpathname, mtime);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000949 }
Guido van Rossumafd3dae1998-08-25 18:44:34 +0000950 m = PyImport_ExecCodeModuleEx(name, (PyObject *)co, pathname);
Guido van Rossum79f25d91997-04-29 20:08:16 +0000951 Py_DECREF(co);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000952
953 return m;
954}
955
956
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000957/* Forward */
Just van Rossum52e14d62002-12-30 22:08:05 +0000958static PyObject *load_module(char *, FILE *, char *, int, PyObject *);
959static struct filedescr *find_module(char *, char *, PyObject *,
960 char *, size_t, FILE **, PyObject **);
Tim Petersdbd9ba62000-07-09 03:09:57 +0000961static struct _frozen *find_frozen(char *name);
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000962
963/* Load a package and return its module object WITH INCREMENTED
964 REFERENCE COUNT */
965
966static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000967load_package(char *name, char *pathname)
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000968{
Tim Peters1cd70172004-08-02 03:52:12 +0000969 PyObject *m, *d;
970 PyObject *file = NULL;
971 PyObject *path = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000972 int err;
973 char buf[MAXPATHLEN+1];
974 FILE *fp = NULL;
975 struct filedescr *fdp;
976
977 m = PyImport_AddModule(name);
978 if (m == NULL)
979 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +0000980 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000981 PySys_WriteStderr("import %s # directory %s\n",
Guido van Rossum17fc85f1997-09-06 18:52:03 +0000982 name, pathname);
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000983 d = PyModule_GetDict(m);
984 file = PyString_FromString(pathname);
985 if (file == NULL)
Tim Peters1cd70172004-08-02 03:52:12 +0000986 goto error;
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000987 path = Py_BuildValue("[O]", file);
Tim Peters1cd70172004-08-02 03:52:12 +0000988 if (path == NULL)
989 goto error;
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000990 err = PyDict_SetItemString(d, "__file__", file);
991 if (err == 0)
992 err = PyDict_SetItemString(d, "__path__", path);
Tim Peters1cd70172004-08-02 03:52:12 +0000993 if (err != 0)
994 goto error;
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000995 buf[0] = '\0';
Just van Rossum52e14d62002-12-30 22:08:05 +0000996 fdp = find_module(name, "__init__", path, buf, sizeof(buf), &fp, NULL);
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000997 if (fdp == NULL) {
998 if (PyErr_ExceptionMatches(PyExc_ImportError)) {
999 PyErr_Clear();
Thomas Heller25653242004-06-07 15:04:10 +00001000 Py_INCREF(m);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001001 }
1002 else
1003 m = NULL;
1004 goto cleanup;
1005 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001006 m = load_module(name, fp, buf, fdp->type, NULL);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001007 if (fp != NULL)
1008 fclose(fp);
Tim Peters1cd70172004-08-02 03:52:12 +00001009 goto cleanup;
1010
1011 error:
1012 m = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001013 cleanup:
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001014 Py_XDECREF(path);
1015 Py_XDECREF(file);
1016 return m;
1017}
1018
1019
1020/* Helper to test for built-in module */
1021
1022static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001023is_builtin(char *name)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001024{
1025 int i;
Guido van Rossum771c6c81997-10-31 18:37:24 +00001026 for (i = 0; PyImport_Inittab[i].name != NULL; i++) {
1027 if (strcmp(name, PyImport_Inittab[i].name) == 0) {
1028 if (PyImport_Inittab[i].initfunc == NULL)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001029 return -1;
1030 else
1031 return 1;
1032 }
1033 }
1034 return 0;
1035}
1036
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001037
Just van Rossum52e14d62002-12-30 22:08:05 +00001038/* Return an importer object for a sys.path/pkg.__path__ item 'p',
1039 possibly by fetching it from the path_importer_cache dict. If it
Thomas Wouters89f507f2006-12-13 04:49:30 +00001040 wasn't yet cached, traverse path_hooks until a hook is found
Just van Rossum52e14d62002-12-30 22:08:05 +00001041 that can handle the path item. Return None if no hook could;
1042 this tells our caller it should fall back to the builtin
1043 import mechanism. Cache the result in path_importer_cache.
1044 Returns a borrowed reference. */
1045
1046static PyObject *
1047get_path_importer(PyObject *path_importer_cache, PyObject *path_hooks,
1048 PyObject *p)
1049{
1050 PyObject *importer;
Martin v. Löwis725507b2006-03-07 12:08:51 +00001051 Py_ssize_t j, nhooks;
Just van Rossum52e14d62002-12-30 22:08:05 +00001052
1053 /* These conditions are the caller's responsibility: */
1054 assert(PyList_Check(path_hooks));
1055 assert(PyDict_Check(path_importer_cache));
1056
1057 nhooks = PyList_Size(path_hooks);
1058 if (nhooks < 0)
1059 return NULL; /* Shouldn't happen */
1060
1061 importer = PyDict_GetItem(path_importer_cache, p);
1062 if (importer != NULL)
1063 return importer;
1064
1065 /* set path_importer_cache[p] to None to avoid recursion */
1066 if (PyDict_SetItem(path_importer_cache, p, Py_None) != 0)
1067 return NULL;
1068
1069 for (j = 0; j < nhooks; j++) {
1070 PyObject *hook = PyList_GetItem(path_hooks, j);
1071 if (hook == NULL)
1072 return NULL;
Thomas Wouters477c8d52006-05-27 19:21:47 +00001073 importer = PyObject_CallFunctionObjArgs(hook, p, NULL);
Just van Rossum52e14d62002-12-30 22:08:05 +00001074 if (importer != NULL)
1075 break;
1076
1077 if (!PyErr_ExceptionMatches(PyExc_ImportError)) {
1078 return NULL;
1079 }
1080 PyErr_Clear();
1081 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001082 if (importer == NULL) {
1083 importer = PyObject_CallFunctionObjArgs(
1084 (PyObject *)&NullImporterType, p, NULL
1085 );
1086 if (importer == NULL) {
1087 if (PyErr_ExceptionMatches(PyExc_ImportError)) {
1088 PyErr_Clear();
1089 return Py_None;
1090 }
1091 }
1092 }
1093 if (importer != NULL) {
Just van Rossum52e14d62002-12-30 22:08:05 +00001094 int err = PyDict_SetItem(path_importer_cache, p, importer);
1095 Py_DECREF(importer);
1096 if (err != 0)
1097 return NULL;
1098 }
1099 return importer;
1100}
1101
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001102/* Search the path (default sys.path) for a module. Return the
1103 corresponding filedescr struct, and (via return arguments) the
1104 pathname and an open file. Return NULL if the module is not found. */
1105
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001106#ifdef MS_COREDLL
Thomas Woutersb4bd21c2000-07-22 23:38:01 +00001107extern FILE *PyWin_FindRegisteredModule(const char *, struct filedescr **,
Martin v. Löwis18e16552006-02-15 17:27:45 +00001108 char *, Py_ssize_t);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001109#endif
1110
Martin v. Löwis18e16552006-02-15 17:27:45 +00001111static int case_ok(char *, Py_ssize_t, Py_ssize_t, char *);
Tim Petersdbd9ba62000-07-09 03:09:57 +00001112static int find_init_module(char *); /* Forward */
Just van Rossum52e14d62002-12-30 22:08:05 +00001113static struct filedescr importhookdescr = {"", "", IMP_HOOK};
Guido van Rossum197346f1997-10-31 18:38:52 +00001114
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001115static struct filedescr *
Just van Rossum52e14d62002-12-30 22:08:05 +00001116find_module(char *fullname, char *subname, PyObject *path, char *buf,
1117 size_t buflen, FILE **p_fp, PyObject **p_loader)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001118{
Martin v. Löwis725507b2006-03-07 12:08:51 +00001119 Py_ssize_t i, npath;
Fred Drake4c82b232000-06-30 16:18:57 +00001120 size_t len, namelen;
Guido van Rossum80bb9651996-12-05 23:27:02 +00001121 struct filedescr *fdp = NULL;
Jack Jansenc88da1f2002-05-28 10:58:19 +00001122 char *filemode;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001123 FILE *fp = NULL;
Just van Rossum52e14d62002-12-30 22:08:05 +00001124 PyObject *path_hooks, *path_importer_cache;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001125 struct stat statbuf;
Guido van Rossuma5568d31998-03-05 03:45:08 +00001126 static struct filedescr fd_frozen = {"", "", PY_FROZEN};
1127 static struct filedescr fd_builtin = {"", "", C_BUILTIN};
1128 static struct filedescr fd_package = {"", "", PKG_DIRECTORY};
Guido van Rossum0506a431998-08-11 15:07:39 +00001129 char name[MAXPATHLEN+1];
Andrew MacIntyred9400542002-02-26 11:41:34 +00001130#if defined(PYOS_OS2)
1131 size_t saved_len;
1132 size_t saved_namelen;
1133 char *saved_buf = NULL;
1134#endif
Just van Rossum52e14d62002-12-30 22:08:05 +00001135 if (p_loader != NULL)
1136 *p_loader = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001137
Just van Rossum52e14d62002-12-30 22:08:05 +00001138 if (strlen(subname) > MAXPATHLEN) {
Guido van Rossum8f4d3312001-10-18 18:54:11 +00001139 PyErr_SetString(PyExc_OverflowError,
1140 "module name is too long");
Fred Drake4c82b232000-06-30 16:18:57 +00001141 return NULL;
1142 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001143 strcpy(name, subname);
1144
1145 /* sys.meta_path import hook */
1146 if (p_loader != NULL) {
1147 PyObject *meta_path;
1148
1149 meta_path = PySys_GetObject("meta_path");
1150 if (meta_path == NULL || !PyList_Check(meta_path)) {
1151 PyErr_SetString(PyExc_ImportError,
1152 "sys.meta_path must be a list of "
1153 "import hooks");
1154 return NULL;
1155 }
1156 Py_INCREF(meta_path); /* zap guard */
1157 npath = PyList_Size(meta_path);
1158 for (i = 0; i < npath; i++) {
1159 PyObject *loader;
1160 PyObject *hook = PyList_GetItem(meta_path, i);
1161 loader = PyObject_CallMethod(hook, "find_module",
1162 "sO", fullname,
1163 path != NULL ?
1164 path : Py_None);
1165 if (loader == NULL) {
1166 Py_DECREF(meta_path);
1167 return NULL; /* true error */
1168 }
1169 if (loader != Py_None) {
1170 /* a loader was found */
1171 *p_loader = loader;
1172 Py_DECREF(meta_path);
1173 return &importhookdescr;
1174 }
1175 Py_DECREF(loader);
1176 }
1177 Py_DECREF(meta_path);
1178 }
Guido van Rossum0506a431998-08-11 15:07:39 +00001179
Guido van Rossum13d77992007-07-23 03:16:50 +00001180 if (path != NULL && PyUnicode_Check(path)) {
Guido van Rossum8f4d3312001-10-18 18:54:11 +00001181 /* The only type of submodule allowed inside a "frozen"
1182 package are other frozen modules or packages. */
Guido van Rossum13d77992007-07-23 03:16:50 +00001183 char *p = PyUnicode_AsString(path);
1184 if (strlen(p) + 1 + strlen(name) >= (size_t)buflen) {
Guido van Rossum0506a431998-08-11 15:07:39 +00001185 PyErr_SetString(PyExc_ImportError,
1186 "full frozen module name too long");
1187 return NULL;
1188 }
Guido van Rossum13d77992007-07-23 03:16:50 +00001189 strcpy(buf, p);
Guido van Rossum0506a431998-08-11 15:07:39 +00001190 strcat(buf, ".");
1191 strcat(buf, name);
1192 strcpy(name, buf);
Guido van Rossum8f4d3312001-10-18 18:54:11 +00001193 if (find_frozen(name) != NULL) {
1194 strcpy(buf, name);
1195 return &fd_frozen;
1196 }
1197 PyErr_Format(PyExc_ImportError,
1198 "No frozen submodule named %.200s", name);
1199 return NULL;
Guido van Rossum0506a431998-08-11 15:07:39 +00001200 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001201 if (path == NULL) {
1202 if (is_builtin(name)) {
Guido van Rossuma5568d31998-03-05 03:45:08 +00001203 strcpy(buf, name);
1204 return &fd_builtin;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001205 }
Greg Ward201baee2001-10-04 14:52:06 +00001206 if ((find_frozen(name)) != NULL) {
Guido van Rossuma5568d31998-03-05 03:45:08 +00001207 strcpy(buf, name);
1208 return &fd_frozen;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001209 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001210
Guido van Rossumac279101996-08-22 23:10:58 +00001211#ifdef MS_COREDLL
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001212 fp = PyWin_FindRegisteredModule(name, &fdp, buf, buflen);
1213 if (fp != NULL) {
1214 *p_fp = fp;
1215 return fdp;
1216 }
Guido van Rossuma5a3db71996-04-09 02:39:59 +00001217#endif
Guido van Rossuma5568d31998-03-05 03:45:08 +00001218 path = PySys_GetObject("path");
1219 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00001220 if (path == NULL || !PyList_Check(path)) {
1221 PyErr_SetString(PyExc_ImportError,
Guido van Rossuma5568d31998-03-05 03:45:08 +00001222 "sys.path must be a list of directory names");
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001223 return NULL;
1224 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001225
1226 path_hooks = PySys_GetObject("path_hooks");
1227 if (path_hooks == NULL || !PyList_Check(path_hooks)) {
1228 PyErr_SetString(PyExc_ImportError,
1229 "sys.path_hooks must be a list of "
1230 "import hooks");
1231 return NULL;
1232 }
1233 path_importer_cache = PySys_GetObject("path_importer_cache");
1234 if (path_importer_cache == NULL ||
1235 !PyDict_Check(path_importer_cache)) {
1236 PyErr_SetString(PyExc_ImportError,
1237 "sys.path_importer_cache must be a dict");
1238 return NULL;
1239 }
1240
Guido van Rossum79f25d91997-04-29 20:08:16 +00001241 npath = PyList_Size(path);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001242 namelen = strlen(name);
1243 for (i = 0; i < npath; i++) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00001244 PyObject *v = PyList_GetItem(path, i);
Guido van Rossumf15a29f2007-05-04 00:41:39 +00001245 PyObject *origv = v;
Guido van Rossum6262cc72007-05-09 23:29:27 +00001246 const char *base;
Guido van Rossumf15a29f2007-05-04 00:41:39 +00001247 Py_ssize_t size;
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001248 if (!v)
1249 return NULL;
Guido van Rossum6262cc72007-05-09 23:29:27 +00001250 if (PyObject_AsCharBuffer(v, &base, &size) < 0)
1251 return NULL;
Guido van Rossumf15a29f2007-05-04 00:41:39 +00001252 len = size;
Walter Dörwald3430d702002-06-17 10:43:59 +00001253 if (len + 2 + namelen + MAXSUFFIXSIZE >= buflen) {
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001254 continue; /* Too long */
Walter Dörwald3430d702002-06-17 10:43:59 +00001255 }
Guido van Rossumf15a29f2007-05-04 00:41:39 +00001256 strcpy(buf, base);
Walter Dörwald3430d702002-06-17 10:43:59 +00001257 if (strlen(buf) != len) {
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001258 continue; /* v contains '\0' */
Walter Dörwald3430d702002-06-17 10:43:59 +00001259 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001260
1261 /* sys.path_hooks import hook */
1262 if (p_loader != NULL) {
1263 PyObject *importer;
1264
1265 importer = get_path_importer(path_importer_cache,
Guido van Rossumf15a29f2007-05-04 00:41:39 +00001266 path_hooks, origv);
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001267 if (importer == NULL) {
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001268 return NULL;
Thomas Wouters477c8d52006-05-27 19:21:47 +00001269 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001270 /* Note: importer is a borrowed reference */
1271 if (importer != Py_None) {
Just van Rossum52e14d62002-12-30 22:08:05 +00001272 PyObject *loader;
1273 loader = PyObject_CallMethod(importer,
1274 "find_module",
1275 "s", fullname);
1276 if (loader == NULL)
1277 return NULL; /* error */
1278 if (loader != Py_None) {
1279 /* a loader was found */
1280 *p_loader = loader;
1281 return &importhookdescr;
1282 }
1283 Py_DECREF(loader);
Thomas Wouters477c8d52006-05-27 19:21:47 +00001284 continue;
Just van Rossum52e14d62002-12-30 22:08:05 +00001285 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001286 }
Thomas Wouters477c8d52006-05-27 19:21:47 +00001287 /* no hook was found, use builtin import */
Just van Rossum52e14d62002-12-30 22:08:05 +00001288
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001289 if (len > 0 && buf[len-1] != SEP
1290#ifdef ALTSEP
1291 && buf[len-1] != ALTSEP
1292#endif
1293 )
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001294 buf[len++] = SEP;
Guido van Rossum215c3402000-11-13 17:26:32 +00001295 strcpy(buf+len, name);
1296 len += namelen;
Tim Peters50d8d372001-02-28 05:34:27 +00001297
1298 /* Check for package import (buf holds a directory name,
1299 and there's an __init__ module in that directory */
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001300#ifdef HAVE_STAT
Walter Dörwald3430d702002-06-17 10:43:59 +00001301 if (stat(buf, &statbuf) == 0 && /* it exists */
1302 S_ISDIR(statbuf.st_mode) && /* it's a directory */
Thomas Wouters477c8d52006-05-27 19:21:47 +00001303 case_ok(buf, len, namelen, name)) { /* case matches */
1304 if (find_init_module(buf)) { /* and has __init__.py */
Thomas Wouters477c8d52006-05-27 19:21:47 +00001305 return &fd_package;
1306 }
1307 else {
1308 char warnstr[MAXPATHLEN+80];
1309 sprintf(warnstr, "Not importing directory "
1310 "'%.*s': missing __init__.py",
1311 MAXPATHLEN, buf);
Skip Montanaro46fc3372007-08-12 11:44:53 +00001312 if (PyErr_WarnEx(PyExc_ImportWarning,
1313 warnstr, 1)) {
Thomas Wouters477c8d52006-05-27 19:21:47 +00001314 return NULL;
1315 }
1316 }
Walter Dörwald3430d702002-06-17 10:43:59 +00001317 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001318#endif
Andrew MacIntyred9400542002-02-26 11:41:34 +00001319#if defined(PYOS_OS2)
1320 /* take a snapshot of the module spec for restoration
1321 * after the 8 character DLL hackery
1322 */
1323 saved_buf = strdup(buf);
1324 saved_len = len;
1325 saved_namelen = namelen;
1326#endif /* PYOS_OS2 */
Guido van Rossum79f25d91997-04-29 20:08:16 +00001327 for (fdp = _PyImport_Filetab; fdp->suffix != NULL; fdp++) {
Guido van Rossum04110fb2007-08-24 16:32:05 +00001328#if defined(PYOS_OS2) && defined(HAVE_DYNAMIC_LOADING)
Jeremy Hylton4ae6fae2002-05-30 17:15:25 +00001329 /* OS/2 limits DLLs to 8 character names (w/o
1330 extension)
Andrew MacIntyred9400542002-02-26 11:41:34 +00001331 * so if the name is longer than that and its a
1332 * dynamically loaded module we're going to try,
1333 * truncate the name before trying
1334 */
Just van Rossum52e14d62002-12-30 22:08:05 +00001335 if (strlen(subname) > 8) {
Andrew MacIntyred9400542002-02-26 11:41:34 +00001336 /* is this an attempt to load a C extension? */
Jeremy Hylton4ae6fae2002-05-30 17:15:25 +00001337 const struct filedescr *scan;
1338 scan = _PyImport_DynLoadFiletab;
Andrew MacIntyred9400542002-02-26 11:41:34 +00001339 while (scan->suffix != NULL) {
Jeremy Hylton4ae6fae2002-05-30 17:15:25 +00001340 if (!strcmp(scan->suffix, fdp->suffix))
Andrew MacIntyred9400542002-02-26 11:41:34 +00001341 break;
1342 else
1343 scan++;
1344 }
1345 if (scan->suffix != NULL) {
1346 /* yes, so truncate the name */
1347 namelen = 8;
Just van Rossum52e14d62002-12-30 22:08:05 +00001348 len -= strlen(subname) - namelen;
Andrew MacIntyred9400542002-02-26 11:41:34 +00001349 buf[len] = '\0';
1350 }
1351 }
1352#endif /* PYOS_OS2 */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001353 strcpy(buf+len, fdp->suffix);
Guido van Rossum79f25d91997-04-29 20:08:16 +00001354 if (Py_VerboseFlag > 1)
Guido van Rossum2f3667a1998-10-12 18:23:55 +00001355 PySys_WriteStderr("# trying %s\n", buf);
Jack Jansenc88da1f2002-05-28 10:58:19 +00001356 filemode = fdp->mode;
Tim Peters86c7d2f2004-08-01 23:24:21 +00001357 if (filemode[0] == 'U')
Jeremy Hylton4ae6fae2002-05-30 17:15:25 +00001358 filemode = "r" PY_STDIOTEXTMODE;
Jack Jansenc88da1f2002-05-28 10:58:19 +00001359 fp = fopen(buf, filemode);
Tim Peters50d8d372001-02-28 05:34:27 +00001360 if (fp != NULL) {
1361 if (case_ok(buf, len, namelen, name))
1362 break;
1363 else { /* continue search */
1364 fclose(fp);
1365 fp = NULL;
Barry Warsaw914a0b12001-02-02 19:12:16 +00001366 }
Barry Warsaw914a0b12001-02-02 19:12:16 +00001367 }
Andrew MacIntyred9400542002-02-26 11:41:34 +00001368#if defined(PYOS_OS2)
1369 /* restore the saved snapshot */
1370 strcpy(buf, saved_buf);
1371 len = saved_len;
1372 namelen = saved_namelen;
1373#endif
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001374 }
Andrew MacIntyred9400542002-02-26 11:41:34 +00001375#if defined(PYOS_OS2)
1376 /* don't need/want the module name snapshot anymore */
1377 if (saved_buf)
1378 {
1379 free(saved_buf);
1380 saved_buf = NULL;
1381 }
1382#endif
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001383 if (fp != NULL)
1384 break;
1385 }
1386 if (fp == NULL) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001387 PyErr_Format(PyExc_ImportError,
1388 "No module named %.200s", name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001389 return NULL;
1390 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001391 *p_fp = fp;
1392 return fdp;
1393}
1394
Raymond Hettingerdb29e0f2004-10-07 06:46:25 +00001395/* Helpers for main.c
1396 * Find the source file corresponding to a named module
1397 */
1398struct filedescr *
1399_PyImport_FindModule(const char *name, PyObject *path, char *buf,
1400 size_t buflen, FILE **p_fp, PyObject **p_loader)
1401{
1402 return find_module((char *) name, (char *) name, path,
1403 buf, buflen, p_fp, p_loader);
1404}
1405
1406PyAPI_FUNC(int) _PyImport_IsScript(struct filedescr * fd)
1407{
1408 return fd->type == PY_SOURCE || fd->type == PY_COMPILED;
1409}
1410
Martin v. Löwis18e16552006-02-15 17:27:45 +00001411/* case_ok(char* buf, Py_ssize_t len, Py_ssize_t namelen, char* name)
Tim Petersd1e87a82001-03-01 18:12:00 +00001412 * The arguments here are tricky, best shown by example:
1413 * /a/b/c/d/e/f/g/h/i/j/k/some_long_module_name.py\0
1414 * ^ ^ ^ ^
1415 * |--------------------- buf ---------------------|
1416 * |------------------- len ------------------|
1417 * |------ name -------|
1418 * |----- namelen -----|
1419 * buf is the full path, but len only counts up to (& exclusive of) the
1420 * extension. name is the module name, also exclusive of extension.
1421 *
1422 * We've already done a successful stat() or fopen() on buf, so know that
1423 * there's some match, possibly case-insensitive.
1424 *
Tim Peters50d8d372001-02-28 05:34:27 +00001425 * case_ok() is to return 1 if there's a case-sensitive match for
1426 * name, else 0. case_ok() is also to return 1 if envar PYTHONCASEOK
1427 * exists.
Tim Petersd1e87a82001-03-01 18:12:00 +00001428 *
Tim Peters50d8d372001-02-28 05:34:27 +00001429 * case_ok() is used to implement case-sensitive import semantics even
1430 * on platforms with case-insensitive filesystems. It's trivial to implement
1431 * for case-sensitive filesystems. It's pretty much a cross-platform
1432 * nightmare for systems with case-insensitive filesystems.
1433 */
Guido van Rossum0980bd91998-02-13 17:18:36 +00001434
Tim Peters50d8d372001-02-28 05:34:27 +00001435/* First we may need a pile of platform-specific header files; the sequence
1436 * of #if's here should match the sequence in the body of case_ok().
1437 */
Jason Tishler7961aa62005-05-20 00:56:54 +00001438#if defined(MS_WINDOWS)
Guido van Rossum0980bd91998-02-13 17:18:36 +00001439#include <windows.h>
Guido van Rossum4c3f57c2001-01-10 20:40:46 +00001440
Tim Peters50d8d372001-02-28 05:34:27 +00001441#elif defined(DJGPP)
1442#include <dir.h>
1443
Jason Tishler7961aa62005-05-20 00:56:54 +00001444#elif (defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) && defined(HAVE_DIRENT_H)
Tim Peters430f5d42001-03-01 01:30:56 +00001445#include <sys/types.h>
1446#include <dirent.h>
1447
Andrew MacIntyred9400542002-02-26 11:41:34 +00001448#elif defined(PYOS_OS2)
1449#define INCL_DOS
1450#define INCL_DOSERRORS
1451#define INCL_NOPMAPI
1452#include <os2.h>
Tim Peters50d8d372001-02-28 05:34:27 +00001453#endif
1454
Guido van Rossum0980bd91998-02-13 17:18:36 +00001455static int
Martin v. Löwis18e16552006-02-15 17:27:45 +00001456case_ok(char *buf, Py_ssize_t len, Py_ssize_t namelen, char *name)
Guido van Rossum0980bd91998-02-13 17:18:36 +00001457{
Tim Peters50d8d372001-02-28 05:34:27 +00001458/* Pick a platform-specific implementation; the sequence of #if's here should
1459 * match the sequence just above.
1460 */
1461
Jason Tishler7961aa62005-05-20 00:56:54 +00001462/* MS_WINDOWS */
1463#if defined(MS_WINDOWS)
Guido van Rossum0980bd91998-02-13 17:18:36 +00001464 WIN32_FIND_DATA data;
1465 HANDLE h;
Tim Peters50d8d372001-02-28 05:34:27 +00001466
Neil Schemenauer7d4bb9f2001-07-23 16:30:27 +00001467 if (Py_GETENV("PYTHONCASEOK") != NULL)
Guido van Rossum0980bd91998-02-13 17:18:36 +00001468 return 1;
Tim Peters50d8d372001-02-28 05:34:27 +00001469
Guido van Rossum0980bd91998-02-13 17:18:36 +00001470 h = FindFirstFile(buf, &data);
1471 if (h == INVALID_HANDLE_VALUE) {
1472 PyErr_Format(PyExc_NameError,
1473 "Can't find file for module %.100s\n(filename %.300s)",
1474 name, buf);
1475 return 0;
1476 }
1477 FindClose(h);
Tim Peters50d8d372001-02-28 05:34:27 +00001478 return strncmp(data.cFileName, name, namelen) == 0;
1479
1480/* DJGPP */
1481#elif defined(DJGPP)
1482 struct ffblk ffblk;
1483 int done;
1484
Neil Schemenauer7d4bb9f2001-07-23 16:30:27 +00001485 if (Py_GETENV("PYTHONCASEOK") != NULL)
Guido van Rossum323bf5e1998-06-24 03:54:06 +00001486 return 1;
Tim Peters50d8d372001-02-28 05:34:27 +00001487
1488 done = findfirst(buf, &ffblk, FA_ARCH|FA_RDONLY|FA_HIDDEN|FA_DIREC);
1489 if (done) {
Guido van Rossum0980bd91998-02-13 17:18:36 +00001490 PyErr_Format(PyExc_NameError,
Tim Peters50d8d372001-02-28 05:34:27 +00001491 "Can't find file for module %.100s\n(filename %.300s)",
Guido van Rossum0980bd91998-02-13 17:18:36 +00001492 name, buf);
1493 return 0;
1494 }
Tim Peters50d8d372001-02-28 05:34:27 +00001495 return strncmp(ffblk.ff_name, name, namelen) == 0;
Guido van Rossum0980bd91998-02-13 17:18:36 +00001496
Jason Tishler7961aa62005-05-20 00:56:54 +00001497/* new-fangled macintosh (macosx) or Cygwin */
1498#elif (defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) && defined(HAVE_DIRENT_H)
Tim Peters430f5d42001-03-01 01:30:56 +00001499 DIR *dirp;
1500 struct dirent *dp;
Tim Petersd1e87a82001-03-01 18:12:00 +00001501 char dirname[MAXPATHLEN + 1];
1502 const int dirlen = len - namelen - 1; /* don't want trailing SEP */
Tim Peters430f5d42001-03-01 01:30:56 +00001503
Neil Schemenauer7d4bb9f2001-07-23 16:30:27 +00001504 if (Py_GETENV("PYTHONCASEOK") != NULL)
Tim Petersdbe6ebb2001-03-01 08:47:29 +00001505 return 1;
1506
Tim Petersd1e87a82001-03-01 18:12:00 +00001507 /* Copy the dir component into dirname; substitute "." if empty */
1508 if (dirlen <= 0) {
1509 dirname[0] = '.';
1510 dirname[1] = '\0';
Tim Peters430f5d42001-03-01 01:30:56 +00001511 }
1512 else {
Tim Petersd1e87a82001-03-01 18:12:00 +00001513 assert(dirlen <= MAXPATHLEN);
1514 memcpy(dirname, buf, dirlen);
1515 dirname[dirlen] = '\0';
Tim Peters430f5d42001-03-01 01:30:56 +00001516 }
1517 /* Open the directory and search the entries for an exact match. */
Tim Petersd1e87a82001-03-01 18:12:00 +00001518 dirp = opendir(dirname);
Tim Peters430f5d42001-03-01 01:30:56 +00001519 if (dirp) {
Tim Peters677898a2001-03-02 03:28:03 +00001520 char *nameWithExt = buf + len - namelen;
Tim Peters430f5d42001-03-01 01:30:56 +00001521 while ((dp = readdir(dirp)) != NULL) {
Tim Petersdbe6ebb2001-03-01 08:47:29 +00001522 const int thislen =
Tim Peters430f5d42001-03-01 01:30:56 +00001523#ifdef _DIRENT_HAVE_D_NAMELEN
Tim Petersdbe6ebb2001-03-01 08:47:29 +00001524 dp->d_namlen;
Tim Peters430f5d42001-03-01 01:30:56 +00001525#else
Tim Petersdbe6ebb2001-03-01 08:47:29 +00001526 strlen(dp->d_name);
Tim Peters430f5d42001-03-01 01:30:56 +00001527#endif
Tim Petersd1e87a82001-03-01 18:12:00 +00001528 if (thislen >= namelen &&
Tim Peters677898a2001-03-02 03:28:03 +00001529 strcmp(dp->d_name, nameWithExt) == 0) {
Tim Peters430f5d42001-03-01 01:30:56 +00001530 (void)closedir(dirp);
1531 return 1; /* Found */
1532 }
1533 }
Tim Petersdbe6ebb2001-03-01 08:47:29 +00001534 (void)closedir(dirp);
Tim Peters430f5d42001-03-01 01:30:56 +00001535 }
Tim Peters430f5d42001-03-01 01:30:56 +00001536 return 0 ; /* Not found */
Tim Peters430f5d42001-03-01 01:30:56 +00001537
Andrew MacIntyred9400542002-02-26 11:41:34 +00001538/* OS/2 */
1539#elif defined(PYOS_OS2)
1540 HDIR hdir = 1;
1541 ULONG srchcnt = 1;
1542 FILEFINDBUF3 ffbuf;
1543 APIRET rc;
1544
1545 if (getenv("PYTHONCASEOK") != NULL)
1546 return 1;
1547
1548 rc = DosFindFirst(buf,
1549 &hdir,
1550 FILE_READONLY | FILE_HIDDEN | FILE_SYSTEM | FILE_DIRECTORY,
1551 &ffbuf, sizeof(ffbuf),
1552 &srchcnt,
1553 FIL_STANDARD);
1554 if (rc != NO_ERROR)
1555 return 0;
1556 return strncmp(ffbuf.achName, name, namelen) == 0;
1557
Tim Peters50d8d372001-02-28 05:34:27 +00001558/* assuming it's a case-sensitive filesystem, so there's nothing to do! */
1559#else
Guido van Rossum0980bd91998-02-13 17:18:36 +00001560 return 1;
Guido van Rossum0980bd91998-02-13 17:18:36 +00001561
Guido van Rossum4d1b3b91998-02-13 23:27:59 +00001562#endif
Tim Peters50d8d372001-02-28 05:34:27 +00001563}
Guido van Rossum4d1b3b91998-02-13 23:27:59 +00001564
Guido van Rossum0980bd91998-02-13 17:18:36 +00001565
Guido van Rossum197346f1997-10-31 18:38:52 +00001566#ifdef HAVE_STAT
1567/* Helper to look for __init__.py or __init__.py[co] in potential package */
1568static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001569find_init_module(char *buf)
Guido van Rossum197346f1997-10-31 18:38:52 +00001570{
Tim Peters0f9431f2001-07-05 03:47:53 +00001571 const size_t save_len = strlen(buf);
Fred Drake4c82b232000-06-30 16:18:57 +00001572 size_t i = save_len;
Tim Peters0f9431f2001-07-05 03:47:53 +00001573 char *pname; /* pointer to start of __init__ */
Guido van Rossum197346f1997-10-31 18:38:52 +00001574 struct stat statbuf;
1575
Tim Peters0f9431f2001-07-05 03:47:53 +00001576/* For calling case_ok(buf, len, namelen, name):
1577 * /a/b/c/d/e/f/g/h/i/j/k/some_long_module_name.py\0
1578 * ^ ^ ^ ^
1579 * |--------------------- buf ---------------------|
1580 * |------------------- len ------------------|
1581 * |------ name -------|
1582 * |----- namelen -----|
1583 */
Guido van Rossum197346f1997-10-31 18:38:52 +00001584 if (save_len + 13 >= MAXPATHLEN)
1585 return 0;
1586 buf[i++] = SEP;
Tim Peters0f9431f2001-07-05 03:47:53 +00001587 pname = buf + i;
1588 strcpy(pname, "__init__.py");
Guido van Rossum197346f1997-10-31 18:38:52 +00001589 if (stat(buf, &statbuf) == 0) {
Tim Peters0f9431f2001-07-05 03:47:53 +00001590 if (case_ok(buf,
1591 save_len + 9, /* len("/__init__") */
1592 8, /* len("__init__") */
1593 pname)) {
1594 buf[save_len] = '\0';
1595 return 1;
1596 }
Guido van Rossum197346f1997-10-31 18:38:52 +00001597 }
Tim Peters0f9431f2001-07-05 03:47:53 +00001598 i += strlen(pname);
1599 strcpy(buf+i, Py_OptimizeFlag ? "o" : "c");
Guido van Rossum197346f1997-10-31 18:38:52 +00001600 if (stat(buf, &statbuf) == 0) {
Tim Peters0f9431f2001-07-05 03:47:53 +00001601 if (case_ok(buf,
1602 save_len + 9, /* len("/__init__") */
1603 8, /* len("__init__") */
1604 pname)) {
1605 buf[save_len] = '\0';
1606 return 1;
1607 }
Guido van Rossum197346f1997-10-31 18:38:52 +00001608 }
1609 buf[save_len] = '\0';
1610 return 0;
1611}
Guido van Rossum48a680c2001-03-02 06:34:14 +00001612
Guido van Rossum197346f1997-10-31 18:38:52 +00001613#endif /* HAVE_STAT */
1614
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001615
Tim Petersdbd9ba62000-07-09 03:09:57 +00001616static int init_builtin(char *); /* Forward */
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001617
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001618/* Load an external module using the default search path and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001619 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001620
Guido van Rossum79f25d91997-04-29 20:08:16 +00001621static PyObject *
Just van Rossum52e14d62002-12-30 22:08:05 +00001622load_module(char *name, FILE *fp, char *buf, int type, PyObject *loader)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001623{
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001624 PyObject *modules;
Guido van Rossum79f25d91997-04-29 20:08:16 +00001625 PyObject *m;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001626 int err;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001627
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001628 /* First check that there's an open file (if we need one) */
1629 switch (type) {
1630 case PY_SOURCE:
1631 case PY_COMPILED:
1632 if (fp == NULL) {
1633 PyErr_Format(PyExc_ValueError,
1634 "file object required for import (type code %d)",
1635 type);
1636 return NULL;
1637 }
1638 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001639
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001640 switch (type) {
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001641
1642 case PY_SOURCE:
1643 m = load_source_module(name, buf, fp);
1644 break;
1645
1646 case PY_COMPILED:
1647 m = load_compiled_module(name, buf, fp);
1648 break;
1649
Guido van Rossum96a8fb71999-12-22 14:09:35 +00001650#ifdef HAVE_DYNAMIC_LOADING
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001651 case C_EXTENSION:
Guido van Rossum79f25d91997-04-29 20:08:16 +00001652 m = _PyImport_LoadDynamicModule(name, buf, fp);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001653 break;
Guido van Rossum96a8fb71999-12-22 14:09:35 +00001654#endif
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001655
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001656 case PKG_DIRECTORY:
1657 m = load_package(name, buf);
1658 break;
1659
1660 case C_BUILTIN:
1661 case PY_FROZEN:
Guido van Rossuma5568d31998-03-05 03:45:08 +00001662 if (buf != NULL && buf[0] != '\0')
1663 name = buf;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001664 if (type == C_BUILTIN)
1665 err = init_builtin(name);
1666 else
1667 err = PyImport_ImportFrozenModule(name);
1668 if (err < 0)
Guido van Rossuma86f77d1997-09-09 18:53:47 +00001669 return NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001670 if (err == 0) {
1671 PyErr_Format(PyExc_ImportError,
1672 "Purported %s module %.200s not found",
1673 type == C_BUILTIN ?
1674 "builtin" : "frozen",
1675 name);
Guido van Rossuma86f77d1997-09-09 18:53:47 +00001676 return NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001677 }
1678 modules = PyImport_GetModuleDict();
1679 m = PyDict_GetItemString(modules, name);
1680 if (m == NULL) {
1681 PyErr_Format(
1682 PyExc_ImportError,
1683 "%s module %.200s not properly initialized",
1684 type == C_BUILTIN ?
1685 "builtin" : "frozen",
1686 name);
Guido van Rossuma86f77d1997-09-09 18:53:47 +00001687 return NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001688 }
1689 Py_INCREF(m);
1690 break;
1691
Just van Rossum52e14d62002-12-30 22:08:05 +00001692 case IMP_HOOK: {
1693 if (loader == NULL) {
1694 PyErr_SetString(PyExc_ImportError,
1695 "import hook without loader");
1696 return NULL;
1697 }
1698 m = PyObject_CallMethod(loader, "load_module", "s", name);
1699 break;
1700 }
1701
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001702 default:
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001703 PyErr_Format(PyExc_ImportError,
1704 "Don't know how to import %.200s (type code %d)",
1705 name, type);
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001706 m = NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001707
1708 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001709
1710 return m;
1711}
1712
1713
1714/* Initialize a built-in module.
Thomas Wouters89f507f2006-12-13 04:49:30 +00001715 Return 1 for success, 0 if the module is not found, and -1 with
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001716 an exception set if the initialization failed. */
Guido van Rossum7f133ed1991-02-19 12:23:57 +00001717
Guido van Rossum7f133ed1991-02-19 12:23:57 +00001718static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001719init_builtin(char *name)
Guido van Rossum7f133ed1991-02-19 12:23:57 +00001720{
Guido van Rossum25ce5661997-08-02 03:10:38 +00001721 struct _inittab *p;
Guido van Rossum25ce5661997-08-02 03:10:38 +00001722
Greg Ward201baee2001-10-04 14:52:06 +00001723 if (_PyImport_FindExtension(name, name) != NULL)
Guido van Rossum25ce5661997-08-02 03:10:38 +00001724 return 1;
1725
Guido van Rossum771c6c81997-10-31 18:37:24 +00001726 for (p = PyImport_Inittab; p->name != NULL; p++) {
Guido van Rossum25ce5661997-08-02 03:10:38 +00001727 if (strcmp(name, p->name) == 0) {
1728 if (p->initfunc == NULL) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001729 PyErr_Format(PyExc_ImportError,
1730 "Cannot re-init internal module %.200s",
1731 name);
Guido van Rossum74e6a111994-08-29 12:54:38 +00001732 return -1;
1733 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00001734 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +00001735 PySys_WriteStderr("import %s # builtin\n", name);
Guido van Rossum25ce5661997-08-02 03:10:38 +00001736 (*p->initfunc)();
Guido van Rossum79f25d91997-04-29 20:08:16 +00001737 if (PyErr_Occurred())
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001738 return -1;
Guido van Rossum25ce5661997-08-02 03:10:38 +00001739 if (_PyImport_FixupExtension(name, name) == NULL)
1740 return -1;
Guido van Rossum7f133ed1991-02-19 12:23:57 +00001741 return 1;
1742 }
1743 }
1744 return 0;
1745}
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001746
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001747
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001748/* Frozen modules */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001749
Guido van Rossumcfd0a221996-06-17 17:06:34 +00001750static struct _frozen *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001751find_frozen(char *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001752{
Guido van Rossumcfd0a221996-06-17 17:06:34 +00001753 struct _frozen *p;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001754
Guido van Rossum79f25d91997-04-29 20:08:16 +00001755 for (p = PyImport_FrozenModules; ; p++) {
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001756 if (p->name == NULL)
1757 return NULL;
1758 if (strcmp(p->name, name) == 0)
1759 break;
1760 }
1761 return p;
1762}
1763
Guido van Rossum79f25d91997-04-29 20:08:16 +00001764static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001765get_frozen_object(char *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001766{
Guido van Rossumcfd0a221996-06-17 17:06:34 +00001767 struct _frozen *p = find_frozen(name);
Guido van Rossuma5568d31998-03-05 03:45:08 +00001768 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001769
1770 if (p == NULL) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001771 PyErr_Format(PyExc_ImportError,
1772 "No such frozen object named %.200s",
1773 name);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001774 return NULL;
1775 }
Guido van Rossum8f4d3312001-10-18 18:54:11 +00001776 if (p->code == NULL) {
1777 PyErr_Format(PyExc_ImportError,
1778 "Excluded frozen object named %.200s",
1779 name);
1780 return NULL;
1781 }
Guido van Rossuma5568d31998-03-05 03:45:08 +00001782 size = p->size;
1783 if (size < 0)
1784 size = -size;
1785 return PyMarshal_ReadObjectFromString((char *)p->code, size);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001786}
1787
1788/* Initialize a frozen module.
1789 Return 1 for succes, 0 if the module is not found, and -1 with
1790 an exception set if the initialization failed.
1791 This function is also used from frozenmain.c */
Guido van Rossum0b344901995-02-07 15:35:27 +00001792
1793int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001794PyImport_ImportFrozenModule(char *name)
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001795{
Guido van Rossumcfd0a221996-06-17 17:06:34 +00001796 struct _frozen *p = find_frozen(name);
Guido van Rossum79f25d91997-04-29 20:08:16 +00001797 PyObject *co;
1798 PyObject *m;
Guido van Rossuma5568d31998-03-05 03:45:08 +00001799 int ispackage;
1800 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001801
1802 if (p == NULL)
1803 return 0;
Guido van Rossum8f4d3312001-10-18 18:54:11 +00001804 if (p->code == NULL) {
1805 PyErr_Format(PyExc_ImportError,
1806 "Excluded frozen object named %.200s",
1807 name);
1808 return -1;
1809 }
Guido van Rossuma5568d31998-03-05 03:45:08 +00001810 size = p->size;
1811 ispackage = (size < 0);
1812 if (ispackage)
1813 size = -size;
Guido van Rossum79f25d91997-04-29 20:08:16 +00001814 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +00001815 PySys_WriteStderr("import %s # frozen%s\n",
Guido van Rossuma5568d31998-03-05 03:45:08 +00001816 name, ispackage ? " package" : "");
1817 co = PyMarshal_ReadObjectFromString((char *)p->code, size);
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001818 if (co == NULL)
1819 return -1;
Guido van Rossum79f25d91997-04-29 20:08:16 +00001820 if (!PyCode_Check(co)) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001821 PyErr_Format(PyExc_TypeError,
1822 "frozen object %.200s is not a code object",
1823 name);
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001824 goto err_return;
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001825 }
Guido van Rossuma5568d31998-03-05 03:45:08 +00001826 if (ispackage) {
1827 /* Set __path__ to the package name */
1828 PyObject *d, *s;
1829 int err;
1830 m = PyImport_AddModule(name);
1831 if (m == NULL)
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001832 goto err_return;
Guido van Rossuma5568d31998-03-05 03:45:08 +00001833 d = PyModule_GetDict(m);
Martin v. Löwis5b222132007-06-10 09:51:05 +00001834 s = PyUnicode_InternFromString(name);
Guido van Rossuma5568d31998-03-05 03:45:08 +00001835 if (s == NULL)
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001836 goto err_return;
Guido van Rossuma5568d31998-03-05 03:45:08 +00001837 err = PyDict_SetItemString(d, "__path__", s);
1838 Py_DECREF(s);
1839 if (err != 0)
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001840 goto err_return;
Guido van Rossuma5568d31998-03-05 03:45:08 +00001841 }
Guido van Rossume32bf6e1998-02-11 05:53:02 +00001842 m = PyImport_ExecCodeModuleEx(name, co, "<frozen>");
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001843 if (m == NULL)
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001844 goto err_return;
1845 Py_DECREF(co);
Guido van Rossum79f25d91997-04-29 20:08:16 +00001846 Py_DECREF(m);
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001847 return 1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001848err_return:
1849 Py_DECREF(co);
1850 return -1;
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001851}
Guido van Rossum74e6a111994-08-29 12:54:38 +00001852
1853
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001854/* Import a module, either built-in, frozen, or external, and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001855 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum74e6a111994-08-29 12:54:38 +00001856
Guido van Rossum79f25d91997-04-29 20:08:16 +00001857PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001858PyImport_ImportModule(const char *name)
Guido van Rossum74e6a111994-08-29 12:54:38 +00001859{
Marc-André Lemburg3c61c352001-02-09 19:40:15 +00001860 PyObject *pname;
1861 PyObject *result;
1862
Martin v. Löwis5b222132007-06-10 09:51:05 +00001863 pname = PyUnicode_FromString(name);
Neal Norwitza11e4c12003-03-23 14:31:01 +00001864 if (pname == NULL)
1865 return NULL;
Marc-André Lemburg3c61c352001-02-09 19:40:15 +00001866 result = PyImport_Import(pname);
1867 Py_DECREF(pname);
1868 return result;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001869}
1870
Guido van Rossum17fc85f1997-09-06 18:52:03 +00001871/* Forward declarations for helper routines */
Thomas Woutersf7f438b2006-02-28 16:09:29 +00001872static PyObject *get_parent(PyObject *globals, char *buf,
1873 Py_ssize_t *p_buflen, int level);
Tim Petersdbd9ba62000-07-09 03:09:57 +00001874static PyObject *load_next(PyObject *mod, PyObject *altmod,
Martin v. Löwis18e16552006-02-15 17:27:45 +00001875 char **p_name, char *buf, Py_ssize_t *p_buflen);
Tim Petersdbd9ba62000-07-09 03:09:57 +00001876static int mark_miss(char *name);
1877static int ensure_fromlist(PyObject *mod, PyObject *fromlist,
Martin v. Löwis18e16552006-02-15 17:27:45 +00001878 char *buf, Py_ssize_t buflen, int recursive);
Tim Petersdbd9ba62000-07-09 03:09:57 +00001879static PyObject * import_submodule(PyObject *mod, char *name, char *fullname);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00001880
1881/* The Magnum Opus of dotted-name import :-) */
1882
Guido van Rossum75acc9c1998-03-03 22:26:50 +00001883static PyObject *
Thomas Woutersf7f438b2006-02-28 16:09:29 +00001884import_module_level(char *name, PyObject *globals, PyObject *locals,
1885 PyObject *fromlist, int level)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001886{
Guido van Rossum17fc85f1997-09-06 18:52:03 +00001887 char buf[MAXPATHLEN+1];
Martin v. Löwis18e16552006-02-15 17:27:45 +00001888 Py_ssize_t buflen = 0;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00001889 PyObject *parent, *head, *next, *tail;
1890
Thomas Woutersf7f438b2006-02-28 16:09:29 +00001891 parent = get_parent(globals, buf, &buflen, level);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00001892 if (parent == NULL)
1893 return NULL;
1894
1895 head = load_next(parent, Py_None, &name, buf, &buflen);
1896 if (head == NULL)
1897 return NULL;
1898
1899 tail = head;
1900 Py_INCREF(tail);
1901 while (name) {
1902 next = load_next(tail, tail, &name, buf, &buflen);
1903 Py_DECREF(tail);
1904 if (next == NULL) {
1905 Py_DECREF(head);
1906 return NULL;
1907 }
1908 tail = next;
1909 }
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001910 if (tail == Py_None) {
1911 /* If tail is Py_None, both get_parent and load_next found
1912 an empty module name: someone called __import__("") or
1913 doctored faulty bytecode */
1914 Py_DECREF(tail);
1915 Py_DECREF(head);
1916 PyErr_SetString(PyExc_ValueError,
1917 "Empty module name");
1918 return NULL;
1919 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00001920
1921 if (fromlist != NULL) {
1922 if (fromlist == Py_None || !PyObject_IsTrue(fromlist))
1923 fromlist = NULL;
1924 }
1925
1926 if (fromlist == NULL) {
1927 Py_DECREF(tail);
1928 return head;
1929 }
1930
1931 Py_DECREF(head);
Guido van Rossum9905ef91997-09-08 16:07:11 +00001932 if (!ensure_fromlist(tail, fromlist, buf, buflen, 0)) {
Guido van Rossum17fc85f1997-09-06 18:52:03 +00001933 Py_DECREF(tail);
1934 return NULL;
1935 }
1936
1937 return tail;
1938}
1939
Thomas Woutersf7f438b2006-02-28 16:09:29 +00001940/* For DLL compatibility */
1941#undef PyImport_ImportModuleEx
Guido van Rossum75acc9c1998-03-03 22:26:50 +00001942PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001943PyImport_ImportModuleEx(char *name, PyObject *globals, PyObject *locals,
1944 PyObject *fromlist)
Guido van Rossum75acc9c1998-03-03 22:26:50 +00001945{
1946 PyObject *result;
1947 lock_import();
Thomas Woutersf7f438b2006-02-28 16:09:29 +00001948 result = import_module_level(name, globals, locals, fromlist, -1);
1949 if (unlock_import() < 0) {
1950 Py_XDECREF(result);
1951 PyErr_SetString(PyExc_RuntimeError,
1952 "not holding the import lock");
1953 return NULL;
1954 }
1955 return result;
1956}
1957#define PyImport_ImportModuleEx(n, g, l, f) \
1958 PyImport_ImportModuleLevel(n, g, l, f, -1);
1959
1960PyObject *
1961PyImport_ImportModuleLevel(char *name, PyObject *globals, PyObject *locals,
1962 PyObject *fromlist, int level)
1963{
1964 PyObject *result;
1965 lock_import();
1966 result = import_module_level(name, globals, locals, fromlist, level);
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00001967 if (unlock_import() < 0) {
1968 Py_XDECREF(result);
1969 PyErr_SetString(PyExc_RuntimeError,
1970 "not holding the import lock");
1971 return NULL;
1972 }
Guido van Rossum75acc9c1998-03-03 22:26:50 +00001973 return result;
1974}
1975
Fred Drake87590902004-05-28 20:21:36 +00001976/* Return the package that an import is being performed in. If globals comes
1977 from the module foo.bar.bat (not itself a package), this returns the
1978 sys.modules entry for foo.bar. If globals is from a package's __init__.py,
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00001979 the package's entry in sys.modules is returned, as a borrowed reference.
Fred Drake87590902004-05-28 20:21:36 +00001980
1981 The *name* of the returned package is returned in buf, with the length of
1982 the name in *p_buflen.
1983
1984 If globals doesn't come from a package or a module in a package, or a
1985 corresponding entry is not found in sys.modules, Py_None is returned.
1986*/
Guido van Rossum17fc85f1997-09-06 18:52:03 +00001987static PyObject *
Thomas Woutersf7f438b2006-02-28 16:09:29 +00001988get_parent(PyObject *globals, char *buf, Py_ssize_t *p_buflen, int level)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00001989{
1990 static PyObject *namestr = NULL;
1991 static PyObject *pathstr = NULL;
1992 PyObject *modname, *modpath, *modules, *parent;
1993
Thomas Woutersf7f438b2006-02-28 16:09:29 +00001994 if (globals == NULL || !PyDict_Check(globals) || !level)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00001995 return Py_None;
1996
1997 if (namestr == NULL) {
Martin v. Löwis5b222132007-06-10 09:51:05 +00001998 namestr = PyUnicode_InternFromString("__name__");
Guido van Rossum17fc85f1997-09-06 18:52:03 +00001999 if (namestr == NULL)
2000 return NULL;
2001 }
2002 if (pathstr == NULL) {
Martin v. Löwis5b222132007-06-10 09:51:05 +00002003 pathstr = PyUnicode_InternFromString("__path__");
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002004 if (pathstr == NULL)
2005 return NULL;
2006 }
2007
2008 *buf = '\0';
2009 *p_buflen = 0;
2010 modname = PyDict_GetItem(globals, namestr);
Martin v. Löwis5b222132007-06-10 09:51:05 +00002011 if (modname == NULL || (!PyString_Check(modname) && !PyUnicode_Check(modname)))
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002012 return Py_None;
2013
Martin v. Löwis5b222132007-06-10 09:51:05 +00002014 if (PyUnicode_Check(modname)) {
2015 /* XXX need to support Unicode better */
2016 modname = _PyUnicode_AsDefaultEncodedString(modname, NULL);
2017 if (!modname) {
2018 PyErr_Clear();
2019 return NULL;
2020 }
2021 }
2022
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002023 modpath = PyDict_GetItem(globals, pathstr);
2024 if (modpath != NULL) {
Martin v. Löwis725507b2006-03-07 12:08:51 +00002025 Py_ssize_t len = PyString_GET_SIZE(modname);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002026 if (len > MAXPATHLEN) {
2027 PyErr_SetString(PyExc_ValueError,
2028 "Module name too long");
2029 return NULL;
2030 }
2031 strcpy(buf, PyString_AS_STRING(modname));
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002032 }
2033 else {
2034 char *start = PyString_AS_STRING(modname);
2035 char *lastdot = strrchr(start, '.');
Fred Drake4c82b232000-06-30 16:18:57 +00002036 size_t len;
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002037 if (lastdot == NULL && level > 0) {
2038 PyErr_SetString(PyExc_ValueError,
Thomas Wouters89f507f2006-12-13 04:49:30 +00002039 "Attempted relative import in non-package");
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002040 return NULL;
2041 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002042 if (lastdot == NULL)
2043 return Py_None;
2044 len = lastdot - start;
2045 if (len >= MAXPATHLEN) {
2046 PyErr_SetString(PyExc_ValueError,
2047 "Module name too long");
2048 return NULL;
2049 }
2050 strncpy(buf, start, len);
2051 buf[len] = '\0';
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002052 }
2053
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002054 while (--level > 0) {
2055 char *dot = strrchr(buf, '.');
2056 if (dot == NULL) {
2057 PyErr_SetString(PyExc_ValueError,
Thomas Wouters89f507f2006-12-13 04:49:30 +00002058 "Attempted relative import beyond "
2059 "toplevel package");
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002060 return NULL;
2061 }
2062 *dot = '\0';
2063 }
2064 *p_buflen = strlen(buf);
2065
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002066 modules = PyImport_GetModuleDict();
2067 parent = PyDict_GetItemString(modules, buf);
2068 if (parent == NULL)
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002069 PyErr_Format(PyExc_SystemError,
2070 "Parent module '%.200s' not loaded", buf);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002071 return parent;
2072 /* We expect, but can't guarantee, if parent != None, that:
2073 - parent.__name__ == buf
2074 - parent.__dict__ is globals
2075 If this is violated... Who cares? */
2076}
2077
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002078/* altmod is either None or same as mod */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002079static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002080load_next(PyObject *mod, PyObject *altmod, char **p_name, char *buf,
Martin v. Löwis18e16552006-02-15 17:27:45 +00002081 Py_ssize_t *p_buflen)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002082{
2083 char *name = *p_name;
2084 char *dot = strchr(name, '.');
Fred Drake4c82b232000-06-30 16:18:57 +00002085 size_t len;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002086 char *p;
2087 PyObject *result;
2088
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002089 if (strlen(name) == 0) {
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002090 /* completely empty module name should only happen in
2091 'from . import' (or '__import__("")')*/
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002092 Py_INCREF(mod);
2093 *p_name = NULL;
2094 return mod;
2095 }
2096
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002097 if (dot == NULL) {
2098 *p_name = NULL;
2099 len = strlen(name);
2100 }
2101 else {
2102 *p_name = dot+1;
2103 len = dot-name;
2104 }
Guido van Rossum111c20b1998-04-11 17:38:22 +00002105 if (len == 0) {
2106 PyErr_SetString(PyExc_ValueError,
2107 "Empty module name");
2108 return NULL;
2109 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002110
2111 p = buf + *p_buflen;
2112 if (p != buf)
2113 *p++ = '.';
2114 if (p+len-buf >= MAXPATHLEN) {
2115 PyErr_SetString(PyExc_ValueError,
2116 "Module name too long");
2117 return NULL;
2118 }
2119 strncpy(p, name, len);
2120 p[len] = '\0';
2121 *p_buflen = p+len-buf;
2122
2123 result = import_submodule(mod, p, buf);
2124 if (result == Py_None && altmod != mod) {
2125 Py_DECREF(result);
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00002126 /* Here, altmod must be None and mod must not be None */
Guido van Rossum0c819451997-09-07 06:16:57 +00002127 result = import_submodule(altmod, p, p);
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00002128 if (result != NULL && result != Py_None) {
2129 if (mark_miss(buf) != 0) {
2130 Py_DECREF(result);
2131 return NULL;
2132 }
2133 strncpy(buf, name, len);
2134 buf[len] = '\0';
2135 *p_buflen = len;
2136 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002137 }
2138 if (result == NULL)
2139 return NULL;
2140
2141 if (result == Py_None) {
2142 Py_DECREF(result);
2143 PyErr_Format(PyExc_ImportError,
2144 "No module named %.200s", name);
2145 return NULL;
2146 }
2147
2148 return result;
2149}
2150
2151static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002152mark_miss(char *name)
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00002153{
2154 PyObject *modules = PyImport_GetModuleDict();
2155 return PyDict_SetItemString(modules, name, Py_None);
2156}
2157
2158static int
Martin v. Löwis18e16552006-02-15 17:27:45 +00002159ensure_fromlist(PyObject *mod, PyObject *fromlist, char *buf, Py_ssize_t buflen,
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002160 int recursive)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002161{
2162 int i;
2163
2164 if (!PyObject_HasAttrString(mod, "__path__"))
2165 return 1;
2166
2167 for (i = 0; ; i++) {
2168 PyObject *item = PySequence_GetItem(fromlist, i);
2169 int hasit;
2170 if (item == NULL) {
2171 if (PyErr_ExceptionMatches(PyExc_IndexError)) {
2172 PyErr_Clear();
2173 return 1;
2174 }
2175 return 0;
2176 }
Martin v. Löwis5b222132007-06-10 09:51:05 +00002177 if (PyString_Check(item)) {
2178 /* XXX there shouldn't be any str8 objects here */
2179 PyObject *uni = PyUnicode_DecodeASCII(PyString_AsString(item),
2180 PyString_Size(item),
2181 "strict");
2182 Py_DECREF(item);
2183 if (!uni)
2184 return 0;
2185 item = uni;
2186 }
2187 if (!PyUnicode_Check(item)) {
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002188 PyErr_SetString(PyExc_TypeError,
Martin v. Löwis5b222132007-06-10 09:51:05 +00002189 "Item in ``from list'' not a unicode string");
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002190 Py_DECREF(item);
2191 return 0;
2192 }
Martin v. Löwis5b222132007-06-10 09:51:05 +00002193 if (PyUnicode_AS_UNICODE(item)[0] == '*') {
Guido van Rossum9905ef91997-09-08 16:07:11 +00002194 PyObject *all;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002195 Py_DECREF(item);
Guido van Rossum9905ef91997-09-08 16:07:11 +00002196 /* See if the package defines __all__ */
2197 if (recursive)
2198 continue; /* Avoid endless recursion */
2199 all = PyObject_GetAttrString(mod, "__all__");
2200 if (all == NULL)
2201 PyErr_Clear();
2202 else {
Martin v. Löwis83969ee2004-03-23 16:28:13 +00002203 int ret = ensure_fromlist(mod, all, buf, buflen, 1);
Guido van Rossum9905ef91997-09-08 16:07:11 +00002204 Py_DECREF(all);
Martin v. Löwis83969ee2004-03-23 16:28:13 +00002205 if (!ret)
2206 return 0;
Guido van Rossum9905ef91997-09-08 16:07:11 +00002207 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002208 continue;
2209 }
2210 hasit = PyObject_HasAttr(mod, item);
2211 if (!hasit) {
Martin v. Löwis5b222132007-06-10 09:51:05 +00002212 PyObject *item8;
2213 char *subname;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002214 PyObject *submod;
2215 char *p;
Martin v. Löwis5b222132007-06-10 09:51:05 +00002216 if (!Py_FileSystemDefaultEncoding) {
2217 item8 = PyUnicode_EncodeASCII(PyUnicode_AsUnicode(item),
2218 PyUnicode_GetSize(item),
Martin v. Löwis427dbff2007-06-12 05:53:00 +00002219 NULL);
Martin v. Löwis5b222132007-06-10 09:51:05 +00002220 } else {
Martin v. Löwis427dbff2007-06-12 05:53:00 +00002221 item8 = PyUnicode_AsEncodedString(item,
2222 Py_FileSystemDefaultEncoding, NULL);
Martin v. Löwis5b222132007-06-10 09:51:05 +00002223 }
2224 if (!item8) {
2225 PyErr_SetString(PyExc_ValueError, "Cannot encode path item");
2226 return 0;
2227 }
2228 subname = PyBytes_AsString(item8);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002229 if (buflen + strlen(subname) >= MAXPATHLEN) {
2230 PyErr_SetString(PyExc_ValueError,
2231 "Module name too long");
2232 Py_DECREF(item);
2233 return 0;
2234 }
2235 p = buf + buflen;
2236 *p++ = '.';
2237 strcpy(p, subname);
2238 submod = import_submodule(mod, subname, buf);
Martin v. Löwis5b222132007-06-10 09:51:05 +00002239 Py_DECREF(item8);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002240 Py_XDECREF(submod);
2241 if (submod == NULL) {
2242 Py_DECREF(item);
2243 return 0;
2244 }
2245 }
2246 Py_DECREF(item);
2247 }
2248
Guido van Rossuma7f2e811997-10-03 15:33:32 +00002249 /* NOTREACHED */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002250}
2251
Neil Schemenauer00b09662003-06-16 21:03:07 +00002252static int
2253add_submodule(PyObject *mod, PyObject *submod, char *fullname, char *subname,
2254 PyObject *modules)
2255{
2256 if (mod == Py_None)
2257 return 1;
2258 /* Irrespective of the success of this load, make a
2259 reference to it in the parent package module. A copy gets
2260 saved in the modules dictionary under the full name, so get a
2261 reference from there, if need be. (The exception is when the
2262 load failed with a SyntaxError -- then there's no trace in
2263 sys.modules. In that case, of course, do nothing extra.) */
2264 if (submod == NULL) {
2265 submod = PyDict_GetItemString(modules, fullname);
2266 if (submod == NULL)
2267 return 1;
2268 }
2269 if (PyModule_Check(mod)) {
2270 /* We can't use setattr here since it can give a
2271 * spurious warning if the submodule name shadows a
2272 * builtin name */
2273 PyObject *dict = PyModule_GetDict(mod);
2274 if (!dict)
2275 return 0;
2276 if (PyDict_SetItemString(dict, subname, submod) < 0)
2277 return 0;
2278 }
2279 else {
2280 if (PyObject_SetAttrString(mod, subname, submod) < 0)
2281 return 0;
2282 }
2283 return 1;
2284}
2285
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002286static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002287import_submodule(PyObject *mod, char *subname, char *fullname)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002288{
Guido van Rossum25ce5661997-08-02 03:10:38 +00002289 PyObject *modules = PyImport_GetModuleDict();
Neil Schemenauer00b09662003-06-16 21:03:07 +00002290 PyObject *m = NULL;
Guido van Rossum74e6a111994-08-29 12:54:38 +00002291
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002292 /* Require:
2293 if mod == None: subname == fullname
2294 else: mod.__name__ + "." + subname == fullname
2295 */
2296
Tim Peters50d8d372001-02-28 05:34:27 +00002297 if ((m = PyDict_GetItemString(modules, fullname)) != NULL) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00002298 Py_INCREF(m);
Guido van Rossum7f9fa971995-01-20 16:53:12 +00002299 }
2300 else {
Just van Rossum52e14d62002-12-30 22:08:05 +00002301 PyObject *path, *loader = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002302 char buf[MAXPATHLEN+1];
2303 struct filedescr *fdp;
2304 FILE *fp = NULL;
2305
Guido van Rossum9c0afe51998-05-19 15:09:05 +00002306 if (mod == Py_None)
2307 path = NULL;
2308 else {
2309 path = PyObject_GetAttrString(mod, "__path__");
2310 if (path == NULL) {
2311 PyErr_Clear();
2312 Py_INCREF(Py_None);
2313 return Py_None;
2314 }
2315 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002316
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002317 buf[0] = '\0';
Just van Rossum52e14d62002-12-30 22:08:05 +00002318 fdp = find_module(fullname, subname, path, buf, MAXPATHLEN+1,
2319 &fp, &loader);
Guido van Rossumb68cd421998-07-01 17:36:26 +00002320 Py_XDECREF(path);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002321 if (fdp == NULL) {
2322 if (!PyErr_ExceptionMatches(PyExc_ImportError))
2323 return NULL;
2324 PyErr_Clear();
2325 Py_INCREF(Py_None);
2326 return Py_None;
2327 }
Just van Rossum52e14d62002-12-30 22:08:05 +00002328 m = load_module(fullname, fp, buf, fdp->type, loader);
2329 Py_XDECREF(loader);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002330 if (fp)
2331 fclose(fp);
Neil Schemenauer00b09662003-06-16 21:03:07 +00002332 if (!add_submodule(mod, m, fullname, subname, modules)) {
2333 Py_XDECREF(m);
2334 m = NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002335 }
Guido van Rossum74e6a111994-08-29 12:54:38 +00002336 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002337
2338 return m;
Guido van Rossum74e6a111994-08-29 12:54:38 +00002339}
2340
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002341
2342/* Re-import a module of any kind and return its module object, WITH
2343 INCREMENTED REFERENCE COUNT */
2344
Guido van Rossum79f25d91997-04-29 20:08:16 +00002345PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002346PyImport_ReloadModule(PyObject *m)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002347{
Guido van Rossumd8faa362007-04-27 19:54:29 +00002348 PyInterpreterState *interp = PyThreadState_Get()->interp;
2349 PyObject *modules_reloading = interp->modules_reloading;
Guido van Rossum25ce5661997-08-02 03:10:38 +00002350 PyObject *modules = PyImport_GetModuleDict();
Guido van Rossumd8faa362007-04-27 19:54:29 +00002351 PyObject *path = NULL, *loader = NULL, *existing_m = NULL;
Guido van Rossum222ef561997-09-06 19:41:09 +00002352 char *name, *subname;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002353 char buf[MAXPATHLEN+1];
2354 struct filedescr *fdp;
2355 FILE *fp = NULL;
Tim Peters1cd70172004-08-02 03:52:12 +00002356 PyObject *newm;
Guido van Rossumd8faa362007-04-27 19:54:29 +00002357
2358 if (modules_reloading == NULL) {
2359 Py_FatalError("PyImport_ReloadModule: "
Guido van Rossume7ba4952007-06-06 23:52:48 +00002360 "no modules_reloading dictionary!");
Guido van Rossumd8faa362007-04-27 19:54:29 +00002361 return NULL;
2362 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002363
Guido van Rossum79f25d91997-04-29 20:08:16 +00002364 if (m == NULL || !PyModule_Check(m)) {
2365 PyErr_SetString(PyExc_TypeError,
2366 "reload() argument must be module");
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002367 return NULL;
2368 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002369 name = PyModule_GetName(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002370 if (name == NULL)
2371 return NULL;
Guido van Rossum25ce5661997-08-02 03:10:38 +00002372 if (m != PyDict_GetItemString(modules, name)) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002373 PyErr_Format(PyExc_ImportError,
2374 "reload(): module %.200s not in sys.modules",
2375 name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002376 return NULL;
2377 }
Guido van Rossumd8faa362007-04-27 19:54:29 +00002378 existing_m = PyDict_GetItemString(modules_reloading, name);
2379 if (existing_m != NULL) {
2380 /* Due to a recursive reload, this module is already
2381 being reloaded. */
2382 Py_INCREF(existing_m);
2383 return existing_m;
2384 }
2385 if (PyDict_SetItemString(modules_reloading, name, m) < 0)
2386 return NULL;
2387
Guido van Rossum222ef561997-09-06 19:41:09 +00002388 subname = strrchr(name, '.');
2389 if (subname == NULL)
2390 subname = name;
2391 else {
2392 PyObject *parentname, *parent;
2393 parentname = PyString_FromStringAndSize(name, (subname-name));
Guido van Rossumd8faa362007-04-27 19:54:29 +00002394 if (parentname == NULL) {
2395 imp_modules_reloading_clear();
Guido van Rossum222ef561997-09-06 19:41:09 +00002396 return NULL;
Guido van Rossumd8faa362007-04-27 19:54:29 +00002397 }
Guido van Rossum222ef561997-09-06 19:41:09 +00002398 parent = PyDict_GetItem(modules, parentname);
2399 if (parent == NULL) {
2400 PyErr_Format(PyExc_ImportError,
2401 "reload(): parent %.200s not in sys.modules",
Georg Brandl0c55f292005-09-14 06:56:20 +00002402 PyString_AS_STRING(parentname));
2403 Py_DECREF(parentname);
Guido van Rossume7ba4952007-06-06 23:52:48 +00002404 imp_modules_reloading_clear();
Guido van Rossum222ef561997-09-06 19:41:09 +00002405 return NULL;
2406 }
Georg Brandl0c55f292005-09-14 06:56:20 +00002407 Py_DECREF(parentname);
Guido van Rossum222ef561997-09-06 19:41:09 +00002408 subname++;
2409 path = PyObject_GetAttrString(parent, "__path__");
2410 if (path == NULL)
2411 PyErr_Clear();
2412 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002413 buf[0] = '\0';
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00002414 fdp = find_module(name, subname, path, buf, MAXPATHLEN+1, &fp, &loader);
Guido van Rossum222ef561997-09-06 19:41:09 +00002415 Py_XDECREF(path);
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00002416
2417 if (fdp == NULL) {
2418 Py_XDECREF(loader);
Guido van Rossumd8faa362007-04-27 19:54:29 +00002419 imp_modules_reloading_clear();
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002420 return NULL;
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00002421 }
2422
2423 newm = load_module(name, fp, buf, fdp->type, loader);
2424 Py_XDECREF(loader);
2425
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002426 if (fp)
2427 fclose(fp);
Tim Peters1cd70172004-08-02 03:52:12 +00002428 if (newm == NULL) {
2429 /* load_module probably removed name from modules because of
2430 * the error. Put back the original module object. We're
2431 * going to return NULL in this case regardless of whether
2432 * replacing name succeeds, so the return value is ignored.
2433 */
2434 PyDict_SetItemString(modules, name, m);
2435 }
Guido van Rossumd8faa362007-04-27 19:54:29 +00002436 imp_modules_reloading_clear();
Tim Peters1cd70172004-08-02 03:52:12 +00002437 return newm;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002438}
2439
2440
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002441/* Higher-level import emulator which emulates the "import" statement
2442 more accurately -- it invokes the __import__() function from the
2443 builtins of the current globals. This means that the import is
2444 done using whatever import hooks are installed in the current
Guido van Rossum6058eb41998-12-21 19:51:00 +00002445 environment, e.g. by "rexec".
2446 A dummy list ["__doc__"] is passed as the 4th argument so that
2447 e.g. PyImport_Import(PyString_FromString("win32com.client.gencache"))
2448 will return <module "gencache"> instead of <module "win32com">. */
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002449
2450PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002451PyImport_Import(PyObject *module_name)
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002452{
2453 static PyObject *silly_list = NULL;
2454 static PyObject *builtins_str = NULL;
2455 static PyObject *import_str = NULL;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002456 PyObject *globals = NULL;
2457 PyObject *import = NULL;
2458 PyObject *builtins = NULL;
2459 PyObject *r = NULL;
2460
2461 /* Initialize constant string objects */
2462 if (silly_list == NULL) {
Martin v. Löwis5b222132007-06-10 09:51:05 +00002463 import_str = PyUnicode_InternFromString("__import__");
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002464 if (import_str == NULL)
2465 return NULL;
Martin v. Löwis5b222132007-06-10 09:51:05 +00002466 builtins_str = PyUnicode_InternFromString("__builtins__");
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002467 if (builtins_str == NULL)
2468 return NULL;
2469 silly_list = Py_BuildValue("[s]", "__doc__");
2470 if (silly_list == NULL)
2471 return NULL;
2472 }
2473
2474 /* Get the builtins from current globals */
2475 globals = PyEval_GetGlobals();
Guido van Rossum85cd1d62001-02-20 21:43:24 +00002476 if (globals != NULL) {
Guido van Rossum66468561998-10-22 15:46:50 +00002477 Py_INCREF(globals);
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002478 builtins = PyObject_GetItem(globals, builtins_str);
2479 if (builtins == NULL)
2480 goto err;
2481 }
2482 else {
2483 /* No globals -- use standard builtins, and fake globals */
2484 PyErr_Clear();
2485
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002486 builtins = PyImport_ImportModuleLevel("__builtin__",
2487 NULL, NULL, NULL, 0);
Guido van Rossum85cd1d62001-02-20 21:43:24 +00002488 if (builtins == NULL)
2489 return NULL;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002490 globals = Py_BuildValue("{OO}", builtins_str, builtins);
2491 if (globals == NULL)
2492 goto err;
2493 }
2494
2495 /* Get the __import__ function from the builtins */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002496 if (PyDict_Check(builtins)) {
Fred Drakea76ba6e2001-03-06 06:31:15 +00002497 import = PyObject_GetItem(builtins, import_str);
Tim Peters6d6c1a32001-08-02 04:15:00 +00002498 if (import == NULL)
2499 PyErr_SetObject(PyExc_KeyError, import_str);
2500 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002501 else
Fred Drakea76ba6e2001-03-06 06:31:15 +00002502 import = PyObject_GetAttr(builtins, import_str);
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002503 if (import == NULL)
2504 goto err;
2505
Guido van Rossumd8faa362007-04-27 19:54:29 +00002506 /* Call the __import__ function with the proper argument list */
Thomas Wouters477c8d52006-05-27 19:21:47 +00002507 r = PyObject_CallFunctionObjArgs(import, module_name, globals,
2508 globals, silly_list, NULL);
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002509
2510 err:
2511 Py_XDECREF(globals);
2512 Py_XDECREF(builtins);
2513 Py_XDECREF(import);
Tim Peters50d8d372001-02-28 05:34:27 +00002514
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002515 return r;
2516}
2517
2518
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002519/* Module 'imp' provides Python access to the primitives used for
2520 importing modules.
2521*/
2522
Guido van Rossum79f25d91997-04-29 20:08:16 +00002523static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +00002524imp_get_magic(PyObject *self, PyObject *noargs)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002525{
2526 char buf[4];
2527
Guido van Rossum96774c12000-05-01 20:19:08 +00002528 buf[0] = (char) ((pyc_magic >> 0) & 0xff);
2529 buf[1] = (char) ((pyc_magic >> 8) & 0xff);
2530 buf[2] = (char) ((pyc_magic >> 16) & 0xff);
2531 buf[3] = (char) ((pyc_magic >> 24) & 0xff);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002532
Guido van Rossumad8d3002007-08-03 18:40:49 +00002533 return PyBytes_FromStringAndSize(buf, 4);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002534}
2535
Guido van Rossum79f25d91997-04-29 20:08:16 +00002536static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +00002537imp_get_suffixes(PyObject *self, PyObject *noargs)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002538{
Guido van Rossum79f25d91997-04-29 20:08:16 +00002539 PyObject *list;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002540 struct filedescr *fdp;
2541
Guido van Rossum79f25d91997-04-29 20:08:16 +00002542 list = PyList_New(0);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002543 if (list == NULL)
2544 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002545 for (fdp = _PyImport_Filetab; fdp->suffix != NULL; fdp++) {
2546 PyObject *item = Py_BuildValue("ssi",
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002547 fdp->suffix, fdp->mode, fdp->type);
2548 if (item == NULL) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00002549 Py_DECREF(list);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002550 return NULL;
2551 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002552 if (PyList_Append(list, item) < 0) {
2553 Py_DECREF(list);
2554 Py_DECREF(item);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002555 return NULL;
2556 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002557 Py_DECREF(item);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002558 }
2559 return list;
2560}
2561
Guido van Rossum79f25d91997-04-29 20:08:16 +00002562static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002563call_find_module(char *name, PyObject *path)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002564{
Tim Petersdbd9ba62000-07-09 03:09:57 +00002565 extern int fclose(FILE *);
Guido van Rossum79f25d91997-04-29 20:08:16 +00002566 PyObject *fob, *ret;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002567 struct filedescr *fdp;
2568 char pathname[MAXPATHLEN+1];
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002569 FILE *fp = NULL;
2570
2571 pathname[0] = '\0';
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002572 if (path == Py_None)
2573 path = NULL;
Just van Rossum52e14d62002-12-30 22:08:05 +00002574 fdp = find_module(NULL, name, path, pathname, MAXPATHLEN+1, &fp, NULL);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002575 if (fdp == NULL)
2576 return NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002577 if (fp != NULL) {
2578 fob = PyFile_FromFile(fp, pathname, fdp->mode, fclose);
2579 if (fob == NULL) {
2580 fclose(fp);
2581 return NULL;
2582 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002583 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002584 else {
2585 fob = Py_None;
2586 Py_INCREF(fob);
Tim Peters50d8d372001-02-28 05:34:27 +00002587 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002588 ret = Py_BuildValue("Os(ssi)",
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002589 fob, pathname, fdp->suffix, fdp->mode, fdp->type);
Guido van Rossum79f25d91997-04-29 20:08:16 +00002590 Py_DECREF(fob);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002591 return ret;
2592}
2593
Guido van Rossum79f25d91997-04-29 20:08:16 +00002594static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002595imp_find_module(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002596{
2597 char *name;
2598 PyObject *path = NULL;
Guido van Rossum43713e52000-02-29 13:59:29 +00002599 if (!PyArg_ParseTuple(args, "s|O:find_module", &name, &path))
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002600 return NULL;
2601 return call_find_module(name, path);
2602}
2603
2604static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002605imp_init_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002606{
2607 char *name;
2608 int ret;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002609 PyObject *m;
Guido van Rossum43713e52000-02-29 13:59:29 +00002610 if (!PyArg_ParseTuple(args, "s:init_builtin", &name))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002611 return NULL;
2612 ret = init_builtin(name);
2613 if (ret < 0)
2614 return NULL;
2615 if (ret == 0) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00002616 Py_INCREF(Py_None);
2617 return Py_None;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002618 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002619 m = PyImport_AddModule(name);
2620 Py_XINCREF(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002621 return m;
2622}
2623
Guido van Rossum79f25d91997-04-29 20:08:16 +00002624static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002625imp_init_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002626{
2627 char *name;
2628 int ret;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002629 PyObject *m;
Guido van Rossum43713e52000-02-29 13:59:29 +00002630 if (!PyArg_ParseTuple(args, "s:init_frozen", &name))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002631 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002632 ret = PyImport_ImportFrozenModule(name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002633 if (ret < 0)
2634 return NULL;
2635 if (ret == 0) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00002636 Py_INCREF(Py_None);
2637 return Py_None;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002638 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002639 m = PyImport_AddModule(name);
2640 Py_XINCREF(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002641 return m;
2642}
2643
Guido van Rossum79f25d91997-04-29 20:08:16 +00002644static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002645imp_get_frozen_object(PyObject *self, PyObject *args)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002646{
2647 char *name;
Jack Jansen95ffa231995-10-03 14:38:41 +00002648
Guido van Rossum43713e52000-02-29 13:59:29 +00002649 if (!PyArg_ParseTuple(args, "s:get_frozen_object", &name))
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002650 return NULL;
2651 return get_frozen_object(name);
2652}
2653
Guido van Rossum79f25d91997-04-29 20:08:16 +00002654static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002655imp_is_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002656{
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002657 char *name;
Guido van Rossum43713e52000-02-29 13:59:29 +00002658 if (!PyArg_ParseTuple(args, "s:is_builtin", &name))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002659 return NULL;
Guido van Rossum50ee94f2002-04-09 18:00:58 +00002660 return PyInt_FromLong(is_builtin(name));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002661}
2662
Guido van Rossum79f25d91997-04-29 20:08:16 +00002663static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002664imp_is_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002665{
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002666 char *name;
Guido van Rossum323bf5e1998-06-24 03:54:06 +00002667 struct _frozen *p;
Guido van Rossum43713e52000-02-29 13:59:29 +00002668 if (!PyArg_ParseTuple(args, "s:is_frozen", &name))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002669 return NULL;
Guido van Rossum323bf5e1998-06-24 03:54:06 +00002670 p = find_frozen(name);
Guido van Rossumb8bff3f2002-04-07 06:34:38 +00002671 return PyBool_FromLong((long) (p == NULL ? 0 : p->size));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002672}
2673
2674static FILE *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002675get_file(char *pathname, PyObject *fob, char *mode)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002676{
2677 FILE *fp;
Guido van Rossumda5b8f22007-06-12 23:30:11 +00002678 if (mode[0] == 'U')
2679 mode = "r" PY_STDIOTEXTMODE;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002680 if (fob == NULL) {
2681 fp = fopen(pathname, mode);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002682 }
2683 else {
Guido van Rossumda5b8f22007-06-12 23:30:11 +00002684 int fd = PyObject_AsFileDescriptor(fob);
2685 if (fd == -1)
2686 return NULL;
2687 /* XXX This will leak a FILE struct. Fix this!!!!
2688 (But it doesn't leak a file descrioptor!) */
2689 fp = fdopen(fd, mode);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002690 }
Guido van Rossumda5b8f22007-06-12 23:30:11 +00002691 if (fp == NULL)
2692 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002693 return fp;
2694}
2695
Guido van Rossum79f25d91997-04-29 20:08:16 +00002696static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002697imp_load_compiled(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002698{
2699 char *name;
2700 char *pathname;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002701 PyObject *fob = NULL;
2702 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002703 FILE *fp;
Guido van Rossumda5b8f22007-06-12 23:30:11 +00002704 if (!PyArg_ParseTuple(args, "ss|O:load_compiled",
2705 &name, &pathname, &fob))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002706 return NULL;
2707 fp = get_file(pathname, fob, "rb");
2708 if (fp == NULL)
2709 return NULL;
2710 m = load_compiled_module(name, pathname, fp);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002711 if (fob == NULL)
2712 fclose(fp);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002713 return m;
2714}
2715
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002716#ifdef HAVE_DYNAMIC_LOADING
2717
Guido van Rossum79f25d91997-04-29 20:08:16 +00002718static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002719imp_load_dynamic(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002720{
2721 char *name;
2722 char *pathname;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002723 PyObject *fob = NULL;
2724 PyObject *m;
Guido van Rossum7faeab31995-07-07 22:50:36 +00002725 FILE *fp = NULL;
Guido van Rossumda5b8f22007-06-12 23:30:11 +00002726 if (!PyArg_ParseTuple(args, "ss|O:load_dynamic",
2727 &name, &pathname, &fob))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002728 return NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002729 if (fob) {
Guido van Rossum7faeab31995-07-07 22:50:36 +00002730 fp = get_file(pathname, fob, "r");
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002731 if (fp == NULL)
2732 return NULL;
2733 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002734 m = _PyImport_LoadDynamicModule(name, pathname, fp);
Guido van Rossum7faeab31995-07-07 22:50:36 +00002735 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002736}
2737
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002738#endif /* HAVE_DYNAMIC_LOADING */
2739
Guido van Rossum79f25d91997-04-29 20:08:16 +00002740static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002741imp_load_source(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002742{
2743 char *name;
2744 char *pathname;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002745 PyObject *fob = NULL;
2746 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002747 FILE *fp;
Guido van Rossumda5b8f22007-06-12 23:30:11 +00002748 if (!PyArg_ParseTuple(args, "ss|O:load_source",
2749 &name, &pathname, &fob))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002750 return NULL;
2751 fp = get_file(pathname, fob, "r");
2752 if (fp == NULL)
2753 return NULL;
2754 m = load_source_module(name, pathname, fp);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002755 if (fob == NULL)
2756 fclose(fp);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002757 return m;
2758}
2759
Guido van Rossum79f25d91997-04-29 20:08:16 +00002760static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002761imp_load_module(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002762{
2763 char *name;
2764 PyObject *fob;
2765 char *pathname;
2766 char *suffix; /* Unused */
2767 char *mode;
2768 int type;
2769 FILE *fp;
2770
Guido van Rossum43713e52000-02-29 13:59:29 +00002771 if (!PyArg_ParseTuple(args, "sOs(ssi):load_module",
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002772 &name, &fob, &pathname,
2773 &suffix, &mode, &type))
2774 return NULL;
Guido van Rossum5e2c5fa2002-05-30 17:33:07 +00002775 if (*mode) {
2776 /* Mode must start with 'r' or 'U' and must not contain '+'.
2777 Implicit in this test is the assumption that the mode
2778 may contain other modifiers like 'b' or 't'. */
2779
2780 if (!(*mode == 'r' || *mode == 'U') || strchr(mode, '+')) {
Jeremy Hylton4ae6fae2002-05-30 17:15:25 +00002781 PyErr_Format(PyExc_ValueError,
2782 "invalid file open mode %.200s", mode);
2783 return NULL;
Guido van Rossum5e2c5fa2002-05-30 17:33:07 +00002784 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002785 }
2786 if (fob == Py_None)
2787 fp = NULL;
2788 else {
Guido van Rossumda5b8f22007-06-12 23:30:11 +00002789 fp = get_file(NULL, fob, mode);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002790 if (fp == NULL)
2791 return NULL;
2792 }
Just van Rossum52e14d62002-12-30 22:08:05 +00002793 return load_module(name, fp, pathname, type, NULL);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002794}
2795
2796static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002797imp_load_package(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002798{
2799 char *name;
2800 char *pathname;
Guido van Rossum43713e52000-02-29 13:59:29 +00002801 if (!PyArg_ParseTuple(args, "ss:load_package", &name, &pathname))
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002802 return NULL;
2803 return load_package(name, pathname);
2804}
2805
2806static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002807imp_new_module(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002808{
2809 char *name;
Guido van Rossum43713e52000-02-29 13:59:29 +00002810 if (!PyArg_ParseTuple(args, "s:new_module", &name))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002811 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002812 return PyModule_New(name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002813}
2814
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002815/* Doc strings */
2816
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002817PyDoc_STRVAR(doc_imp,
2818"This module provides the components needed to build your own\n\
2819__import__ function. Undocumented functions are obsolete.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002820
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002821PyDoc_STRVAR(doc_find_module,
2822"find_module(name, [path]) -> (file, filename, (suffix, mode, type))\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002823Search for a module. If path is omitted or None, search for a\n\
2824built-in, frozen or special module and continue search in sys.path.\n\
2825The module name cannot contain '.'; to search for a submodule of a\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002826package, pass the submodule name and the package's __path__.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002827
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002828PyDoc_STRVAR(doc_load_module,
2829"load_module(name, file, filename, (suffix, mode, type)) -> module\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002830Load a module, given information returned by find_module().\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002831The module name must include the full package name, if any.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002832
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002833PyDoc_STRVAR(doc_get_magic,
2834"get_magic() -> string\n\
2835Return the magic number for .pyc or .pyo files.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002836
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002837PyDoc_STRVAR(doc_get_suffixes,
2838"get_suffixes() -> [(suffix, mode, type), ...]\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002839Return a list of (suffix, mode, type) tuples describing the files\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002840that find_module() looks for.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002841
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002842PyDoc_STRVAR(doc_new_module,
2843"new_module(name) -> module\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002844Create a new module. Do not enter it in sys.modules.\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002845The module name must include the full package name, if any.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002846
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002847PyDoc_STRVAR(doc_lock_held,
Tim Petersa7c65092004-08-01 23:26:05 +00002848"lock_held() -> boolean\n\
2849Return True if the import lock is currently held, else False.\n\
2850On platforms without threads, return False.");
Tim Peters69232342001-08-30 05:16:13 +00002851
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00002852PyDoc_STRVAR(doc_acquire_lock,
2853"acquire_lock() -> None\n\
Neal Norwitz2294c0d2003-02-12 23:02:21 +00002854Acquires the interpreter's import lock for the current thread.\n\
2855This lock should be used by import hooks to ensure thread-safety\n\
2856when importing modules.\n\
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00002857On platforms without threads, this function does nothing.");
2858
2859PyDoc_STRVAR(doc_release_lock,
2860"release_lock() -> None\n\
2861Release the interpreter's import lock.\n\
2862On platforms without threads, this function does nothing.");
2863
Guido van Rossum79f25d91997-04-29 20:08:16 +00002864static PyMethodDef imp_methods[] = {
Neal Norwitz08ea61a2003-02-17 18:18:00 +00002865 {"find_module", imp_find_module, METH_VARARGS, doc_find_module},
2866 {"get_magic", imp_get_magic, METH_NOARGS, doc_get_magic},
2867 {"get_suffixes", imp_get_suffixes, METH_NOARGS, doc_get_suffixes},
2868 {"load_module", imp_load_module, METH_VARARGS, doc_load_module},
2869 {"new_module", imp_new_module, METH_VARARGS, doc_new_module},
2870 {"lock_held", imp_lock_held, METH_NOARGS, doc_lock_held},
2871 {"acquire_lock", imp_acquire_lock, METH_NOARGS, doc_acquire_lock},
2872 {"release_lock", imp_release_lock, METH_NOARGS, doc_release_lock},
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002873 /* The rest are obsolete */
Neal Norwitz031829d2002-03-31 14:37:44 +00002874 {"get_frozen_object", imp_get_frozen_object, METH_VARARGS},
2875 {"init_builtin", imp_init_builtin, METH_VARARGS},
2876 {"init_frozen", imp_init_frozen, METH_VARARGS},
2877 {"is_builtin", imp_is_builtin, METH_VARARGS},
2878 {"is_frozen", imp_is_frozen, METH_VARARGS},
2879 {"load_compiled", imp_load_compiled, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002880#ifdef HAVE_DYNAMIC_LOADING
Neal Norwitz031829d2002-03-31 14:37:44 +00002881 {"load_dynamic", imp_load_dynamic, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002882#endif
Neal Norwitz031829d2002-03-31 14:37:44 +00002883 {"load_package", imp_load_package, METH_VARARGS},
Neal Norwitz031829d2002-03-31 14:37:44 +00002884 {"load_source", imp_load_source, METH_VARARGS},
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002885 {NULL, NULL} /* sentinel */
2886};
2887
Guido van Rossum1a8791e1998-08-04 22:46:29 +00002888static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002889setint(PyObject *d, char *name, int value)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002890{
2891 PyObject *v;
2892 int err;
2893
2894 v = PyInt_FromLong((long)value);
2895 err = PyDict_SetItemString(d, name, v);
2896 Py_XDECREF(v);
2897 return err;
2898}
2899
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002900typedef struct {
2901 PyObject_HEAD
2902} NullImporter;
2903
2904static int
2905NullImporter_init(NullImporter *self, PyObject *args, PyObject *kwds)
2906{
2907 char *path;
2908
2909 if (!_PyArg_NoKeywords("NullImporter()", kwds))
2910 return -1;
2911
2912 if (!PyArg_ParseTuple(args, "s:NullImporter",
2913 &path))
2914 return -1;
2915
2916 if (strlen(path) == 0) {
2917 PyErr_SetString(PyExc_ImportError, "empty pathname");
2918 return -1;
2919 } else {
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002920 struct stat statbuf;
2921 int rv;
2922
2923 rv = stat(path, &statbuf);
2924 if (rv == 0) {
2925 /* it exists */
2926 if (S_ISDIR(statbuf.st_mode)) {
2927 /* it's a directory */
2928 PyErr_SetString(PyExc_ImportError,
2929 "existing directory");
2930 return -1;
2931 }
2932 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002933 }
2934 return 0;
2935}
2936
2937static PyObject *
2938NullImporter_find_module(NullImporter *self, PyObject *args)
2939{
2940 Py_RETURN_NONE;
2941}
2942
2943static PyMethodDef NullImporter_methods[] = {
2944 {"find_module", (PyCFunction)NullImporter_find_module, METH_VARARGS,
2945 "Always return None"
2946 },
2947 {NULL} /* Sentinel */
2948};
2949
2950
2951static PyTypeObject NullImporterType = {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00002952 PyVarObject_HEAD_INIT(NULL, 0)
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002953 "imp.NullImporter", /*tp_name*/
2954 sizeof(NullImporter), /*tp_basicsize*/
2955 0, /*tp_itemsize*/
2956 0, /*tp_dealloc*/
2957 0, /*tp_print*/
2958 0, /*tp_getattr*/
2959 0, /*tp_setattr*/
2960 0, /*tp_compare*/
2961 0, /*tp_repr*/
2962 0, /*tp_as_number*/
2963 0, /*tp_as_sequence*/
2964 0, /*tp_as_mapping*/
2965 0, /*tp_hash */
2966 0, /*tp_call*/
2967 0, /*tp_str*/
2968 0, /*tp_getattro*/
2969 0, /*tp_setattro*/
2970 0, /*tp_as_buffer*/
2971 Py_TPFLAGS_DEFAULT, /*tp_flags*/
2972 "Null importer object", /* tp_doc */
2973 0, /* tp_traverse */
2974 0, /* tp_clear */
2975 0, /* tp_richcompare */
2976 0, /* tp_weaklistoffset */
2977 0, /* tp_iter */
2978 0, /* tp_iternext */
2979 NullImporter_methods, /* tp_methods */
2980 0, /* tp_members */
2981 0, /* tp_getset */
2982 0, /* tp_base */
2983 0, /* tp_dict */
2984 0, /* tp_descr_get */
2985 0, /* tp_descr_set */
2986 0, /* tp_dictoffset */
2987 (initproc)NullImporter_init, /* tp_init */
2988 0, /* tp_alloc */
2989 PyType_GenericNew /* tp_new */
2990};
2991
2992
Jason Tishler6bc06ec2003-09-04 11:59:50 +00002993PyMODINIT_FUNC
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002994initimp(void)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002995{
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002996 PyObject *m, *d;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002997
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002998 if (PyType_Ready(&NullImporterType) < 0)
2999 goto failure;
3000
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003001 m = Py_InitModule4("imp", imp_methods, doc_imp,
3002 NULL, PYTHON_API_VERSION);
Neal Norwitz1ac754f2006-01-19 06:09:39 +00003003 if (m == NULL)
3004 goto failure;
Guido van Rossum79f25d91997-04-29 20:08:16 +00003005 d = PyModule_GetDict(m);
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00003006 if (d == NULL)
3007 goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003008
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003009 if (setint(d, "SEARCH_ERROR", SEARCH_ERROR) < 0) goto failure;
3010 if (setint(d, "PY_SOURCE", PY_SOURCE) < 0) goto failure;
3011 if (setint(d, "PY_COMPILED", PY_COMPILED) < 0) goto failure;
3012 if (setint(d, "C_EXTENSION", C_EXTENSION) < 0) goto failure;
3013 if (setint(d, "PY_RESOURCE", PY_RESOURCE) < 0) goto failure;
3014 if (setint(d, "PKG_DIRECTORY", PKG_DIRECTORY) < 0) goto failure;
3015 if (setint(d, "C_BUILTIN", C_BUILTIN) < 0) goto failure;
3016 if (setint(d, "PY_FROZEN", PY_FROZEN) < 0) goto failure;
Guido van Rossum0f84a341998-08-06 13:36:01 +00003017 if (setint(d, "PY_CODERESOURCE", PY_CODERESOURCE) < 0) goto failure;
Just van Rossum52e14d62002-12-30 22:08:05 +00003018 if (setint(d, "IMP_HOOK", IMP_HOOK) < 0) goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003019
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003020 Py_INCREF(&NullImporterType);
3021 PyModule_AddObject(m, "NullImporter", (PyObject *)&NullImporterType);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003022 failure:
3023 ;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003024}
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003025
3026
Guido van Rossumb18618d2000-05-03 23:44:39 +00003027/* API for embedding applications that want to add their own entries
3028 to the table of built-in modules. This should normally be called
3029 *before* Py_Initialize(). When the table resize fails, -1 is
3030 returned and the existing table is unchanged.
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003031
3032 After a similar function by Just van Rossum. */
3033
3034int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003035PyImport_ExtendInittab(struct _inittab *newtab)
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003036{
3037 static struct _inittab *our_copy = NULL;
3038 struct _inittab *p;
3039 int i, n;
3040
3041 /* Count the number of entries in both tables */
3042 for (n = 0; newtab[n].name != NULL; n++)
3043 ;
3044 if (n == 0)
3045 return 0; /* Nothing to do */
3046 for (i = 0; PyImport_Inittab[i].name != NULL; i++)
3047 ;
3048
3049 /* Allocate new memory for the combined table */
Guido van Rossumb18618d2000-05-03 23:44:39 +00003050 p = our_copy;
3051 PyMem_RESIZE(p, struct _inittab, i+n+1);
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003052 if (p == NULL)
3053 return -1;
3054
3055 /* Copy the tables into the new memory */
3056 if (our_copy != PyImport_Inittab)
3057 memcpy(p, PyImport_Inittab, (i+1) * sizeof(struct _inittab));
3058 PyImport_Inittab = our_copy = p;
3059 memcpy(p+i, newtab, (n+1) * sizeof(struct _inittab));
3060
3061 return 0;
3062}
3063
3064/* Shorthand to add a single entry given a name and a function */
3065
3066int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003067PyImport_AppendInittab(char *name, void (*initfunc)(void))
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003068{
3069 struct _inittab newtab[2];
3070
3071 memset(newtab, '\0', sizeof newtab);
3072
3073 newtab[0].name = name;
3074 newtab[0].initfunc = initfunc;
3075
3076 return PyImport_ExtendInittab(newtab);
3077}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00003078
3079#ifdef __cplusplus
3080}
3081#endif