blob: 2c0468bf8e0b302e935971472aa823ad596014c3 [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"
Neal Norwitzadb69fc2005-12-17 20:54:49 +00007#include "pyarena.h"
Jeremy Hylton3e0055f2005-10-20 19:59:25 +00008#include "pythonrun.h"
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00009#include "errcode.h"
Guido van Rossumc405b7b1991-06-04 19:39:42 +000010#include "marshal.h"
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000011#include "code.h"
Guido van Rossumc405b7b1991-06-04 19:39:42 +000012#include "compile.h"
Guido van Rossumff4949e1992-08-05 19:58:53 +000013#include "eval.h"
Guido van Rossumd8bac6d1992-02-26 15:19:13 +000014#include "osdefs.h"
Guido van Rossum1ae940a1995-01-02 19:04:15 +000015#include "importdl.h"
Guido van Rossumc405b7b1991-06-04 19:39:42 +000016
Guido van Rossum55a83382000-09-20 20:31:38 +000017#ifdef HAVE_FCNTL_H
18#include <fcntl.h>
19#endif
Anthony Baxterac6bd462006-04-13 02:06:09 +000020#ifdef __cplusplus
21extern "C" {
22#endif
Guido van Rossum55a83382000-09-20 20:31:38 +000023
Thomas Woutersf70ef4f2000-07-22 18:47:25 +000024extern time_t PyOS_GetLastModificationTime(char *, FILE *);
25 /* In getmtime.c */
Guido van Rossum21d335e1993-10-15 13:01:11 +000026
Jeremy Hyltond4ceb312004-04-01 02:45:22 +000027/* Magic word to reject .pyc files generated by other Python versions.
28 It should change for each incompatible change to the bytecode.
29
30 The value of CR and LF is incorporated so if you ever read or write
Guido van Rossum7faeab31995-07-07 22:50:36 +000031 a .pyc file in text mode the magic number will be wrong; also, the
Tim Peters36515e22001-11-18 04:06:29 +000032 Apple MPW compiler swaps their values, botching string constants.
Marc-André Lemburgbd3be8f2002-02-07 11:33:49 +000033
Martin v. Löwisef82d2f2004-06-27 16:51:46 +000034 The magic numbers must be spaced apart atleast 2 values, as the
35 -U interpeter flag will cause MAGIC+1 being used. They have been
36 odd numbers for some time now.
Marc-André Lemburgbd3be8f2002-02-07 11:33:49 +000037
Jeremy Hyltond4ceb312004-04-01 02:45:22 +000038 There were a variety of old schemes for setting the magic number.
39 The current working scheme is to increment the previous value by
40 10.
Guido van Rossumf6894922002-08-31 15:16:14 +000041
Marc-André Lemburgbd3be8f2002-02-07 11:33:49 +000042 Known values:
43 Python 1.5: 20121
44 Python 1.5.1: 20121
45 Python 1.5.2: 20121
Skip Montanaro4ec3c262006-03-25 14:12:03 +000046 Python 1.6: 50428
Marc-André Lemburgbd3be8f2002-02-07 11:33:49 +000047 Python 2.0: 50823
48 Python 2.0.1: 50823
49 Python 2.1: 60202
50 Python 2.1.1: 60202
51 Python 2.1.2: 60202
52 Python 2.2: 60717
Neal Norwitz7fdcb412002-06-14 01:07:39 +000053 Python 2.3a0: 62011
Michael W. Hudsondd32a912002-08-15 14:59:02 +000054 Python 2.3a0: 62021
Guido van Rossumf6894922002-08-31 15:16:14 +000055 Python 2.3a0: 62011 (!)
Martin v. Löwisef82d2f2004-06-27 16:51:46 +000056 Python 2.4a0: 62041
Raymond Hettingerfd2d1f72004-08-23 23:37:48 +000057 Python 2.4a3: 62051
Raymond Hettinger2c31a052004-09-22 18:44:21 +000058 Python 2.4b1: 62061
Michael W. Hudsondf888462005-06-03 14:41:55 +000059 Python 2.5a0: 62071
Michael W. Hudsonaee2e282005-10-21 11:32:20 +000060 Python 2.5a0: 62081 (ast-branch)
Guido van Rossumc2e20742006-02-27 22:32:47 +000061 Python 2.5a0: 62091 (with)
Guido van Rossumf6694362006-03-10 02:28:35 +000062 Python 2.5a0: 62092 (changed WITH_CLEANUP opcode)
Neal Norwitzedef2be2006-07-12 05:26:17 +000063 Python 2.5c1: 62101 (fix wrong code: for x, in ...)
Michael W. Hudsonaee2e282005-10-21 11:32:20 +000064.
Tim Peters36515e22001-11-18 04:06:29 +000065*/
Neal Norwitza1f10902006-07-12 07:28:29 +000066#define MAGIC (62101 | ((long)'\r'<<16) | ((long)'\n'<<24))
Guido van Rossum3ddee711991-12-16 13:06:34 +000067
Guido van Rossum96774c12000-05-01 20:19:08 +000068/* Magic word as global; note that _PyImport_Init() can change the
Jeremy Hylton9262b8a2000-06-30 04:59:17 +000069 value of this global to accommodate for alterations of how the
Guido van Rossum96774c12000-05-01 20:19:08 +000070 compiler works which are enabled by command line switches. */
71static long pyc_magic = MAGIC;
72
Guido van Rossum25ce5661997-08-02 03:10:38 +000073/* See _PyImport_FixupExtension() below */
74static PyObject *extensions = NULL;
Guido van Rossum3f5da241990-12-20 15:06:42 +000075
Guido van Rossum771c6c81997-10-31 18:37:24 +000076/* This table is defined in config.c: */
77extern struct _inittab _PyImport_Inittab[];
78
79struct _inittab *PyImport_Inittab = _PyImport_Inittab;
Guido van Rossum66f1fa81991-04-03 19:03:52 +000080
Guido van Rossumed1170e1999-12-20 21:23:41 +000081/* these tables define the module suffixes that Python recognizes */
82struct filedescr * _PyImport_Filetab = NULL;
Guido van Rossum48a680c2001-03-02 06:34:14 +000083
84#ifdef RISCOS
85static const struct filedescr _PyImport_StandardFiletab[] = {
Jack Jansenc88da1f2002-05-28 10:58:19 +000086 {"/py", "U", PY_SOURCE},
Guido van Rossum48a680c2001-03-02 06:34:14 +000087 {"/pyc", "rb", PY_COMPILED},
88 {0, 0}
89};
90#else
Guido van Rossumed1170e1999-12-20 21:23:41 +000091static const struct filedescr _PyImport_StandardFiletab[] = {
Jack Jansenc88da1f2002-05-28 10:58:19 +000092 {".py", "U", PY_SOURCE},
Martin v. Löwis6238d2b2002-06-30 15:26:10 +000093#ifdef MS_WINDOWS
Jack Jansenc88da1f2002-05-28 10:58:19 +000094 {".pyw", "U", PY_SOURCE},
Tim Peters36515e22001-11-18 04:06:29 +000095#endif
Guido van Rossumed1170e1999-12-20 21:23:41 +000096 {".pyc", "rb", PY_COMPILED},
97 {0, 0}
98};
Guido van Rossum48a680c2001-03-02 06:34:14 +000099#endif
Guido van Rossumed1170e1999-12-20 21:23:41 +0000100
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000101/* Initialize things */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000102
103void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000104_PyImport_Init(void)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000105{
Guido van Rossumed1170e1999-12-20 21:23:41 +0000106 const struct filedescr *scan;
107 struct filedescr *filetab;
108 int countD = 0;
109 int countS = 0;
110
111 /* prepare _PyImport_Filetab: copy entries from
112 _PyImport_DynLoadFiletab and _PyImport_StandardFiletab.
113 */
114 for (scan = _PyImport_DynLoadFiletab; scan->suffix != NULL; ++scan)
115 ++countD;
116 for (scan = _PyImport_StandardFiletab; scan->suffix != NULL; ++scan)
117 ++countS;
Guido van Rossumb18618d2000-05-03 23:44:39 +0000118 filetab = PyMem_NEW(struct filedescr, countD + countS + 1);
Guido van Rossumed1170e1999-12-20 21:23:41 +0000119 memcpy(filetab, _PyImport_DynLoadFiletab,
120 countD * sizeof(struct filedescr));
121 memcpy(filetab + countD, _PyImport_StandardFiletab,
122 countS * sizeof(struct filedescr));
123 filetab[countD + countS].suffix = NULL;
124
125 _PyImport_Filetab = filetab;
126
Guido van Rossum0824f631997-03-11 18:37:35 +0000127 if (Py_OptimizeFlag) {
Guido van Rossumed1170e1999-12-20 21:23:41 +0000128 /* Replace ".pyc" with ".pyo" in _PyImport_Filetab */
129 for (; filetab->suffix != NULL; filetab++) {
Guido van Rossum48a680c2001-03-02 06:34:14 +0000130#ifndef RISCOS
Guido van Rossumed1170e1999-12-20 21:23:41 +0000131 if (strcmp(filetab->suffix, ".pyc") == 0)
132 filetab->suffix = ".pyo";
Guido van Rossum48a680c2001-03-02 06:34:14 +0000133#else
134 if (strcmp(filetab->suffix, "/pyc") == 0)
135 filetab->suffix = "/pyo";
136#endif
Guido van Rossum0824f631997-03-11 18:37:35 +0000137 }
138 }
Guido van Rossum96774c12000-05-01 20:19:08 +0000139
140 if (Py_UnicodeFlag) {
141 /* Fix the pyc_magic so that byte compiled code created
142 using the all-Unicode method doesn't interfere with
143 code created in normal operation mode. */
144 pyc_magic = MAGIC + 1;
145 }
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000146}
147
Guido van Rossum25ce5661997-08-02 03:10:38 +0000148void
Just van Rossum52e14d62002-12-30 22:08:05 +0000149_PyImportHooks_Init(void)
150{
151 PyObject *v, *path_hooks = NULL, *zimpimport;
152 int err = 0;
153
154 /* adding sys.path_hooks and sys.path_importer_cache, setting up
155 zipimport */
156
157 if (Py_VerboseFlag)
158 PySys_WriteStderr("# installing zipimport hook\n");
159
160 v = PyList_New(0);
161 if (v == NULL)
162 goto error;
163 err = PySys_SetObject("meta_path", v);
164 Py_DECREF(v);
165 if (err)
166 goto error;
167 v = PyDict_New();
168 if (v == NULL)
169 goto error;
170 err = PySys_SetObject("path_importer_cache", v);
171 Py_DECREF(v);
172 if (err)
173 goto error;
174 path_hooks = PyList_New(0);
175 if (path_hooks == NULL)
176 goto error;
177 err = PySys_SetObject("path_hooks", path_hooks);
178 if (err) {
179 error:
180 PyErr_Print();
181 Py_FatalError("initializing sys.meta_path, sys.path_hooks or "
182 "path_importer_cache failed");
183 }
184 zimpimport = PyImport_ImportModule("zipimport");
185 if (zimpimport == NULL) {
186 PyErr_Clear(); /* No zip import module -- okay */
187 if (Py_VerboseFlag)
188 PySys_WriteStderr("# can't import zipimport\n");
189 }
190 else {
191 PyObject *zipimporter = PyObject_GetAttrString(zimpimport,
192 "zipimporter");
193 Py_DECREF(zimpimport);
194 if (zipimporter == NULL) {
195 PyErr_Clear(); /* No zipimporter object -- okay */
196 if (Py_VerboseFlag)
197 PySys_WriteStderr(
Fred Drake1e5fc552003-07-11 15:01:02 +0000198 "# can't import zipimport.zipimporter\n");
Just van Rossum52e14d62002-12-30 22:08:05 +0000199 }
200 else {
201 /* sys.path_hooks.append(zipimporter) */
202 err = PyList_Append(path_hooks, zipimporter);
203 Py_DECREF(zipimporter);
204 if (err)
205 goto error;
206 if (Py_VerboseFlag)
207 PySys_WriteStderr(
208 "# installed zipimport hook\n");
209 }
210 }
211 Py_DECREF(path_hooks);
212}
213
214void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000215_PyImport_Fini(void)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000216{
217 Py_XDECREF(extensions);
218 extensions = NULL;
Barry Warsaw84294482000-10-03 16:02:05 +0000219 PyMem_DEL(_PyImport_Filetab);
220 _PyImport_Filetab = NULL;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000221}
222
223
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000224/* Locking primitives to prevent parallel imports of the same module
225 in different threads to return with a partially loaded module.
226 These calls are serialized by the global interpreter lock. */
227
228#ifdef WITH_THREAD
229
Guido van Rossum49b56061998-10-01 20:42:43 +0000230#include "pythread.h"
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000231
Guido van Rossum65d5b571998-12-21 19:32:43 +0000232static PyThread_type_lock import_lock = 0;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000233static long import_lock_thread = -1;
234static int import_lock_level = 0;
235
236static void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000237lock_import(void)
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000238{
Guido van Rossum65d5b571998-12-21 19:32:43 +0000239 long me = PyThread_get_thread_ident();
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000240 if (me == -1)
241 return; /* Too bad */
242 if (import_lock == NULL)
Guido van Rossum65d5b571998-12-21 19:32:43 +0000243 import_lock = PyThread_allocate_lock();
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000244 if (import_lock_thread == me) {
245 import_lock_level++;
246 return;
247 }
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000248 if (import_lock_thread != -1 || !PyThread_acquire_lock(import_lock, 0))
249 {
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000250 PyThreadState *tstate = PyEval_SaveThread();
Guido van Rossum65d5b571998-12-21 19:32:43 +0000251 PyThread_acquire_lock(import_lock, 1);
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000252 PyEval_RestoreThread(tstate);
253 }
254 import_lock_thread = me;
255 import_lock_level = 1;
256}
257
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000258static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000259unlock_import(void)
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000260{
Guido van Rossum65d5b571998-12-21 19:32:43 +0000261 long me = PyThread_get_thread_ident();
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000262 if (me == -1)
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000263 return 0; /* Too bad */
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000264 if (import_lock_thread != me)
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000265 return -1;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000266 import_lock_level--;
267 if (import_lock_level == 0) {
268 import_lock_thread = -1;
Guido van Rossum65d5b571998-12-21 19:32:43 +0000269 PyThread_release_lock(import_lock);
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000270 }
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000271 return 1;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000272}
273
Guido van Rossum8ee3e5a2005-09-14 18:09:42 +0000274/* This function is called from PyOS_AfterFork to ensure that newly
275 created child processes do not share locks with the parent. */
276
277void
278_PyImport_ReInitLock(void)
279{
280#ifdef _AIX
281 if (import_lock != NULL)
282 import_lock = PyThread_allocate_lock();
283#endif
284}
285
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000286#else
287
288#define lock_import()
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000289#define unlock_import() 0
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000290
291#endif
292
Tim Peters69232342001-08-30 05:16:13 +0000293static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000294imp_lock_held(PyObject *self, PyObject *noargs)
Tim Peters69232342001-08-30 05:16:13 +0000295{
Tim Peters69232342001-08-30 05:16:13 +0000296#ifdef WITH_THREAD
Guido van Rossumb8bff3f2002-04-07 06:34:38 +0000297 return PyBool_FromLong(import_lock_thread != -1);
Tim Peters69232342001-08-30 05:16:13 +0000298#else
Guido van Rossumb8bff3f2002-04-07 06:34:38 +0000299 return PyBool_FromLong(0);
Tim Peters69232342001-08-30 05:16:13 +0000300#endif
301}
302
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000303static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000304imp_acquire_lock(PyObject *self, PyObject *noargs)
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000305{
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000306#ifdef WITH_THREAD
307 lock_import();
308#endif
Neal Norwitz2294c0d2003-02-12 23:02:21 +0000309 Py_INCREF(Py_None);
310 return Py_None;
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000311}
312
313static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000314imp_release_lock(PyObject *self, PyObject *noargs)
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000315{
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000316#ifdef WITH_THREAD
317 if (unlock_import() < 0) {
318 PyErr_SetString(PyExc_RuntimeError,
319 "not holding the import lock");
320 return NULL;
321 }
322#endif
Neal Norwitz2294c0d2003-02-12 23:02:21 +0000323 Py_INCREF(Py_None);
324 return Py_None;
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000325}
326
Guido van Rossum25ce5661997-08-02 03:10:38 +0000327/* Helper for sys */
328
329PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000330PyImport_GetModuleDict(void)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000331{
Nicholas Bastine5662ae2004-03-24 22:22:12 +0000332 PyInterpreterState *interp = PyThreadState_GET()->interp;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000333 if (interp->modules == NULL)
334 Py_FatalError("PyImport_GetModuleDict: no module dictionary!");
335 return interp->modules;
336}
337
Guido van Rossum3f5da241990-12-20 15:06:42 +0000338
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000339/* List of names to clear in sys */
340static char* sys_deletes[] = {
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000341 "path", "argv", "ps1", "ps2", "exitfunc",
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000342 "exc_type", "exc_value", "exc_traceback",
343 "last_type", "last_value", "last_traceback",
Just van Rossum52e14d62002-12-30 22:08:05 +0000344 "path_hooks", "path_importer_cache", "meta_path",
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000345 NULL
346};
347
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000348static char* sys_files[] = {
349 "stdin", "__stdin__",
350 "stdout", "__stdout__",
351 "stderr", "__stderr__",
352 NULL
353};
354
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000355
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000356/* Un-initialize things, as good as we can */
Guido van Rossum3f5da241990-12-20 15:06:42 +0000357
Guido van Rossum3f5da241990-12-20 15:06:42 +0000358void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000359PyImport_Cleanup(void)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000360{
Martin v. Löwis18e16552006-02-15 17:27:45 +0000361 Py_ssize_t pos, ndone;
Guido van Rossum758eec01998-01-19 21:58:26 +0000362 char *name;
363 PyObject *key, *value, *dict;
Nicholas Bastine5662ae2004-03-24 22:22:12 +0000364 PyInterpreterState *interp = PyThreadState_GET()->interp;
Guido van Rossum758eec01998-01-19 21:58:26 +0000365 PyObject *modules = interp->modules;
366
367 if (modules == NULL)
368 return; /* Already done */
369
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000370 /* Delete some special variables first. These are common
371 places where user values hide and people complain when their
372 destructors fail. Since the modules containing them are
373 deleted *last* of all, they would come too late in the normal
374 destruction order. Sigh. */
375
376 value = PyDict_GetItemString(modules, "__builtin__");
377 if (value != NULL && PyModule_Check(value)) {
378 dict = PyModule_GetDict(value);
379 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000380 PySys_WriteStderr("# clear __builtin__._\n");
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000381 PyDict_SetItemString(dict, "_", Py_None);
382 }
383 value = PyDict_GetItemString(modules, "sys");
384 if (value != NULL && PyModule_Check(value)) {
385 char **p;
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000386 PyObject *v;
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000387 dict = PyModule_GetDict(value);
388 for (p = sys_deletes; *p != NULL; p++) {
389 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000390 PySys_WriteStderr("# clear sys.%s\n", *p);
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000391 PyDict_SetItemString(dict, *p, Py_None);
392 }
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000393 for (p = sys_files; *p != NULL; p+=2) {
394 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000395 PySys_WriteStderr("# restore sys.%s\n", *p);
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000396 v = PyDict_GetItemString(dict, *(p+1));
397 if (v == NULL)
398 v = Py_None;
399 PyDict_SetItemString(dict, *p, v);
400 }
401 }
402
403 /* First, delete __main__ */
404 value = PyDict_GetItemString(modules, "__main__");
405 if (value != NULL && PyModule_Check(value)) {
406 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000407 PySys_WriteStderr("# cleanup __main__\n");
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000408 _PyModule_Clear(value);
409 PyDict_SetItemString(modules, "__main__", Py_None);
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000410 }
411
Guido van Rossum758eec01998-01-19 21:58:26 +0000412 /* The special treatment of __builtin__ here is because even
413 when it's not referenced as a module, its dictionary is
414 referenced by almost every module's __builtins__. Since
415 deleting a module clears its dictionary (even if there are
416 references left to it), we need to delete the __builtin__
417 module last. Likewise, we don't delete sys until the very
418 end because it is implicitly referenced (e.g. by print).
419
420 Also note that we 'delete' modules by replacing their entry
421 in the modules dict with None, rather than really deleting
422 them; this avoids a rehash of the modules dictionary and
423 also marks them as "non existent" so they won't be
424 re-imported. */
425
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000426 /* Next, repeatedly delete modules with a reference count of
Guido van Rossum758eec01998-01-19 21:58:26 +0000427 one (skipping __builtin__ and sys) and delete them */
428 do {
429 ndone = 0;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000430 pos = 0;
Guido van Rossum758eec01998-01-19 21:58:26 +0000431 while (PyDict_Next(modules, &pos, &key, &value)) {
432 if (value->ob_refcnt != 1)
433 continue;
Guido van Rossum566373e1998-10-01 15:24:50 +0000434 if (PyString_Check(key) && PyModule_Check(value)) {
435 name = PyString_AS_STRING(key);
Guido van Rossum758eec01998-01-19 21:58:26 +0000436 if (strcmp(name, "__builtin__") == 0)
437 continue;
438 if (strcmp(name, "sys") == 0)
439 continue;
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000440 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000441 PySys_WriteStderr(
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000442 "# cleanup[1] %s\n", name);
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000443 _PyModule_Clear(value);
Guido van Rossum758eec01998-01-19 21:58:26 +0000444 PyDict_SetItem(modules, key, Py_None);
445 ndone++;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000446 }
447 }
Guido van Rossum758eec01998-01-19 21:58:26 +0000448 } while (ndone > 0);
449
Guido van Rossum758eec01998-01-19 21:58:26 +0000450 /* Next, delete all modules (still skipping __builtin__ and sys) */
451 pos = 0;
452 while (PyDict_Next(modules, &pos, &key, &value)) {
Guido van Rossum566373e1998-10-01 15:24:50 +0000453 if (PyString_Check(key) && PyModule_Check(value)) {
454 name = PyString_AS_STRING(key);
Guido van Rossum758eec01998-01-19 21:58:26 +0000455 if (strcmp(name, "__builtin__") == 0)
456 continue;
457 if (strcmp(name, "sys") == 0)
458 continue;
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000459 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000460 PySys_WriteStderr("# cleanup[2] %s\n", name);
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000461 _PyModule_Clear(value);
Guido van Rossum758eec01998-01-19 21:58:26 +0000462 PyDict_SetItem(modules, key, Py_None);
463 }
464 }
465
466 /* Next, delete sys and __builtin__ (in that order) */
467 value = PyDict_GetItemString(modules, "sys");
468 if (value != NULL && PyModule_Check(value)) {
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000469 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000470 PySys_WriteStderr("# cleanup sys\n");
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000471 _PyModule_Clear(value);
Guido van Rossum758eec01998-01-19 21:58:26 +0000472 PyDict_SetItemString(modules, "sys", Py_None);
473 }
474 value = PyDict_GetItemString(modules, "__builtin__");
475 if (value != NULL && PyModule_Check(value)) {
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000476 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000477 PySys_WriteStderr("# cleanup __builtin__\n");
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000478 _PyModule_Clear(value);
Guido van Rossum758eec01998-01-19 21:58:26 +0000479 PyDict_SetItemString(modules, "__builtin__", Py_None);
480 }
481
482 /* Finally, clear and delete the modules directory */
483 PyDict_Clear(modules);
484 interp->modules = NULL;
485 Py_DECREF(modules);
Guido van Rossum8d15b5d1990-10-26 14:58:58 +0000486}
Guido van Rossum7f133ed1991-02-19 12:23:57 +0000487
488
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000489/* Helper for pythonrun.c -- return magic number */
490
491long
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000492PyImport_GetMagicNumber(void)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000493{
Guido van Rossum96774c12000-05-01 20:19:08 +0000494 return pyc_magic;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000495}
496
497
Guido van Rossum25ce5661997-08-02 03:10:38 +0000498/* Magic for extension modules (built-in as well as dynamically
499 loaded). To prevent initializing an extension module more than
500 once, we keep a static dictionary 'extensions' keyed by module name
501 (for built-in modules) or by filename (for dynamically loaded
Barry Warsaw92883382001-08-13 23:05:44 +0000502 modules), containing these modules. A copy of the module's
Guido van Rossum25ce5661997-08-02 03:10:38 +0000503 dictionary is stored by calling _PyImport_FixupExtension()
504 immediately after the module initialization function succeeds. A
505 copy can be retrieved from there by calling
506 _PyImport_FindExtension(). */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000507
Guido van Rossum79f25d91997-04-29 20:08:16 +0000508PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000509_PyImport_FixupExtension(char *name, char *filename)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000510{
Guido van Rossum25ce5661997-08-02 03:10:38 +0000511 PyObject *modules, *mod, *dict, *copy;
512 if (extensions == NULL) {
513 extensions = PyDict_New();
514 if (extensions == NULL)
515 return NULL;
516 }
517 modules = PyImport_GetModuleDict();
518 mod = PyDict_GetItemString(modules, name);
519 if (mod == NULL || !PyModule_Check(mod)) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000520 PyErr_Format(PyExc_SystemError,
521 "_PyImport_FixupExtension: module %.200s not loaded", name);
Guido van Rossum25ce5661997-08-02 03:10:38 +0000522 return NULL;
523 }
524 dict = PyModule_GetDict(mod);
525 if (dict == NULL)
526 return NULL;
Fred Drake9cd0efc2001-10-25 21:38:59 +0000527 copy = PyDict_Copy(dict);
Guido van Rossum25ce5661997-08-02 03:10:38 +0000528 if (copy == NULL)
529 return NULL;
530 PyDict_SetItemString(extensions, filename, copy);
531 Py_DECREF(copy);
532 return copy;
533}
534
535PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000536_PyImport_FindExtension(char *name, char *filename)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000537{
Fred Drake9cd0efc2001-10-25 21:38:59 +0000538 PyObject *dict, *mod, *mdict;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000539 if (extensions == NULL)
540 return NULL;
541 dict = PyDict_GetItemString(extensions, filename);
542 if (dict == NULL)
543 return NULL;
544 mod = PyImport_AddModule(name);
545 if (mod == NULL)
546 return NULL;
547 mdict = PyModule_GetDict(mod);
548 if (mdict == NULL)
549 return NULL;
Fred Drake9cd0efc2001-10-25 21:38:59 +0000550 if (PyDict_Update(mdict, dict))
Guido van Rossum25ce5661997-08-02 03:10:38 +0000551 return NULL;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000552 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000553 PySys_WriteStderr("import %s # previously loaded (%s)\n",
Guido van Rossum25ce5661997-08-02 03:10:38 +0000554 name, filename);
555 return mod;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000556}
557
558
559/* Get the module object corresponding to a module name.
560 First check the modules dictionary if there's one there,
Walter Dörwaldf0dfc7a2003-10-20 14:01:56 +0000561 if not, create a new one and insert it in the modules dictionary.
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000562 Because the former action is most common, THIS DOES NOT RETURN A
563 'NEW' REFERENCE! */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000564
Guido van Rossum79f25d91997-04-29 20:08:16 +0000565PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000566PyImport_AddModule(const char *name)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000567{
Guido van Rossum25ce5661997-08-02 03:10:38 +0000568 PyObject *modules = PyImport_GetModuleDict();
Guido van Rossum79f25d91997-04-29 20:08:16 +0000569 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000570
Guido van Rossum25ce5661997-08-02 03:10:38 +0000571 if ((m = PyDict_GetItemString(modules, name)) != NULL &&
Guido van Rossum79f25d91997-04-29 20:08:16 +0000572 PyModule_Check(m))
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000573 return m;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000574 m = PyModule_New(name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000575 if (m == NULL)
576 return NULL;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000577 if (PyDict_SetItemString(modules, name, m) != 0) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000578 Py_DECREF(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000579 return NULL;
580 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000581 Py_DECREF(m); /* Yes, it still exists, in modules! */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000582
583 return m;
584}
585
Tim Peters1cd70172004-08-02 03:52:12 +0000586/* Remove name from sys.modules, if it's there. */
587static void
588_RemoveModule(const char *name)
589{
590 PyObject *modules = PyImport_GetModuleDict();
591 if (PyDict_GetItemString(modules, name) == NULL)
592 return;
593 if (PyDict_DelItemString(modules, name) < 0)
594 Py_FatalError("import: deleting existing key in"
595 "sys.modules failed");
596}
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000597
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000598/* Execute a code object in a module and return the module object
Tim Peters1cd70172004-08-02 03:52:12 +0000599 * WITH INCREMENTED REFERENCE COUNT. If an error occurs, name is
600 * removed from sys.modules, to avoid leaving damaged module objects
601 * in sys.modules. The caller may wish to restore the original
602 * module object (if any) in this case; PyImport_ReloadModule is an
603 * example.
604 */
Guido van Rossum79f25d91997-04-29 20:08:16 +0000605PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000606PyImport_ExecCodeModule(char *name, PyObject *co)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000607{
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000608 return PyImport_ExecCodeModuleEx(name, co, (char *)NULL);
609}
610
611PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000612PyImport_ExecCodeModuleEx(char *name, PyObject *co, char *pathname)
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000613{
Guido van Rossum25ce5661997-08-02 03:10:38 +0000614 PyObject *modules = PyImport_GetModuleDict();
Guido van Rossum79f25d91997-04-29 20:08:16 +0000615 PyObject *m, *d, *v;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000616
Guido van Rossum79f25d91997-04-29 20:08:16 +0000617 m = PyImport_AddModule(name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000618 if (m == NULL)
619 return NULL;
Jeremy Hyltonecd91292004-01-02 23:25:32 +0000620 /* If the module is being reloaded, we get the old module back
621 and re-use its dict to exec the new code. */
Guido van Rossum79f25d91997-04-29 20:08:16 +0000622 d = PyModule_GetDict(m);
623 if (PyDict_GetItemString(d, "__builtins__") == NULL) {
624 if (PyDict_SetItemString(d, "__builtins__",
625 PyEval_GetBuiltins()) != 0)
Tim Peters1cd70172004-08-02 03:52:12 +0000626 goto error;
Guido van Rossum6135a871995-01-09 17:53:26 +0000627 }
Guido van Rossum9c9a07c1996-05-16 20:43:40 +0000628 /* Remember the filename as the __file__ attribute */
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000629 v = NULL;
630 if (pathname != NULL) {
631 v = PyString_FromString(pathname);
632 if (v == NULL)
633 PyErr_Clear();
634 }
635 if (v == NULL) {
636 v = ((PyCodeObject *)co)->co_filename;
637 Py_INCREF(v);
638 }
639 if (PyDict_SetItemString(d, "__file__", v) != 0)
Guido van Rossum79f25d91997-04-29 20:08:16 +0000640 PyErr_Clear(); /* Not important enough to report */
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000641 Py_DECREF(v);
642
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000643 v = PyEval_EvalCode((PyCodeObject *)co, d, d);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000644 if (v == NULL)
Tim Peters1cd70172004-08-02 03:52:12 +0000645 goto error;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000646 Py_DECREF(v);
Guido van Rossumb65e85c1997-07-10 18:00:45 +0000647
Guido van Rossum25ce5661997-08-02 03:10:38 +0000648 if ((m = PyDict_GetItemString(modules, name)) == NULL) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000649 PyErr_Format(PyExc_ImportError,
650 "Loaded module %.200s not found in sys.modules",
651 name);
Guido van Rossumb65e85c1997-07-10 18:00:45 +0000652 return NULL;
653 }
654
Guido van Rossum79f25d91997-04-29 20:08:16 +0000655 Py_INCREF(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000656
657 return m;
Tim Peters1cd70172004-08-02 03:52:12 +0000658
659 error:
660 _RemoveModule(name);
661 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000662}
663
664
665/* Given a pathname for a Python source file, fill a buffer with the
666 pathname for the corresponding compiled file. Return the pathname
667 for the compiled file, or NULL if there's no space in the buffer.
668 Doesn't set an exception. */
669
670static char *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000671make_compiled_pathname(char *pathname, char *buf, size_t buflen)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000672{
Tim Petersc1731372001-08-04 08:12:36 +0000673 size_t len = strlen(pathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000674 if (len+2 > buflen)
675 return NULL;
Tim Petersc1731372001-08-04 08:12:36 +0000676
Martin v. Löwis6238d2b2002-06-30 15:26:10 +0000677#ifdef MS_WINDOWS
Tim Petersc1731372001-08-04 08:12:36 +0000678 /* Treat .pyw as if it were .py. The case of ".pyw" must match
679 that used in _PyImport_StandardFiletab. */
680 if (len >= 4 && strcmp(&pathname[len-4], ".pyw") == 0)
681 --len; /* pretend 'w' isn't there */
682#endif
683 memcpy(buf, pathname, len);
684 buf[len] = Py_OptimizeFlag ? 'o' : 'c';
685 buf[len+1] = '\0';
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000686
687 return buf;
688}
689
690
691/* Given a pathname for a Python source file, its time of last
692 modification, and a pathname for a compiled file, check whether the
693 compiled file represents the same version of the source. If so,
694 return a FILE pointer for the compiled file, positioned just after
695 the header; if not, return NULL.
696 Doesn't set an exception. */
697
698static FILE *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000699check_compiled_module(char *pathname, time_t mtime, char *cpathname)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000700{
701 FILE *fp;
702 long magic;
703 long pyc_mtime;
704
705 fp = fopen(cpathname, "rb");
706 if (fp == NULL)
707 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000708 magic = PyMarshal_ReadLongFromFile(fp);
Guido van Rossum96774c12000-05-01 20:19:08 +0000709 if (magic != pyc_magic) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000710 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000711 PySys_WriteStderr("# %s has bad magic\n", cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000712 fclose(fp);
713 return NULL;
714 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000715 pyc_mtime = PyMarshal_ReadLongFromFile(fp);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000716 if (pyc_mtime != mtime) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000717 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000718 PySys_WriteStderr("# %s has bad mtime\n", cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000719 fclose(fp);
720 return NULL;
721 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000722 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000723 PySys_WriteStderr("# %s matches %s\n", cpathname, pathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000724 return fp;
725}
726
727
728/* Read a code object from a file and check it for validity */
729
Guido van Rossum79f25d91997-04-29 20:08:16 +0000730static PyCodeObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000731read_compiled_module(char *cpathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000732{
Guido van Rossum79f25d91997-04-29 20:08:16 +0000733 PyObject *co;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000734
Tim Petersd9b9ac82001-01-28 00:27:39 +0000735 co = PyMarshal_ReadLastObjectFromFile(fp);
Armin Rigo01ab2792004-03-26 15:09:27 +0000736 if (co == NULL)
737 return NULL;
738 if (!PyCode_Check(co)) {
739 PyErr_Format(PyExc_ImportError,
740 "Non-code object in %.200s", cpathname);
741 Py_DECREF(co);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000742 return NULL;
743 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000744 return (PyCodeObject *)co;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000745}
746
747
748/* Load a module from a compiled file, execute it, and return its
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000749 module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000750
Guido van Rossum79f25d91997-04-29 20:08:16 +0000751static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000752load_compiled_module(char *name, char *cpathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000753{
754 long magic;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000755 PyCodeObject *co;
756 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000757
Guido van Rossum79f25d91997-04-29 20:08:16 +0000758 magic = PyMarshal_ReadLongFromFile(fp);
Guido van Rossum96774c12000-05-01 20:19:08 +0000759 if (magic != pyc_magic) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000760 PyErr_Format(PyExc_ImportError,
761 "Bad magic number in %.200s", cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000762 return NULL;
763 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000764 (void) PyMarshal_ReadLongFromFile(fp);
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000765 co = read_compiled_module(cpathname, fp);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000766 if (co == NULL)
767 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000768 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000769 PySys_WriteStderr("import %s # precompiled from %s\n",
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000770 name, cpathname);
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000771 m = PyImport_ExecCodeModuleEx(name, (PyObject *)co, cpathname);
Guido van Rossum79f25d91997-04-29 20:08:16 +0000772 Py_DECREF(co);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000773
774 return m;
775}
776
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000777/* Parse a source file and return the corresponding code object */
778
Guido van Rossum79f25d91997-04-29 20:08:16 +0000779static PyCodeObject *
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000780parse_source_module(const char *pathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000781{
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000782 PyCodeObject *co = NULL;
783 mod_ty mod;
Neal Norwitzadb69fc2005-12-17 20:54:49 +0000784 PyArena *arena = PyArena_New();
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000785
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000786 mod = PyParser_ASTFromFile(fp, pathname, Py_file_input, 0, 0, 0,
Neal Norwitzadb69fc2005-12-17 20:54:49 +0000787 NULL, arena);
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000788 if (mod) {
Neal Norwitzadb69fc2005-12-17 20:54:49 +0000789 co = PyAST_Compile(mod, pathname, NULL, arena);
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000790 }
Neal Norwitzadb69fc2005-12-17 20:54:49 +0000791 PyArena_Free(arena);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000792 return co;
793}
794
795
Guido van Rossum55a83382000-09-20 20:31:38 +0000796/* Helper to open a bytecode file for writing in exclusive mode */
797
798static FILE *
799open_exclusive(char *filename)
800{
801#if defined(O_EXCL)&&defined(O_CREAT)&&defined(O_WRONLY)&&defined(O_TRUNC)
802 /* Use O_EXCL to avoid a race condition when another process tries to
803 write the same file. When that happens, our open() call fails,
804 which is just fine (since it's only a cache).
805 XXX If the file exists and is writable but the directory is not
806 writable, the file will never be written. Oh well.
807 */
808 int fd;
809 (void) unlink(filename);
Tim Peters42c83af2000-09-29 04:03:10 +0000810 fd = open(filename, O_EXCL|O_CREAT|O_WRONLY|O_TRUNC
811#ifdef O_BINARY
812 |O_BINARY /* necessary for Windows */
813#endif
Martin v. Löwis79acb9e2002-12-06 12:48:53 +0000814#ifdef __VMS
Martin v. Löwis18e16552006-02-15 17:27:45 +0000815 , 0666, "ctxt=bin", "shr=nil"
Martin v. Löwis79acb9e2002-12-06 12:48:53 +0000816#else
Martin v. Löwis18e16552006-02-15 17:27:45 +0000817 , 0666
Martin v. Löwis79acb9e2002-12-06 12:48:53 +0000818#endif
Martin v. Löwis18e16552006-02-15 17:27:45 +0000819 );
Guido van Rossum55a83382000-09-20 20:31:38 +0000820 if (fd < 0)
821 return NULL;
822 return fdopen(fd, "wb");
823#else
824 /* Best we can do -- on Windows this can't happen anyway */
825 return fopen(filename, "wb");
826#endif
827}
828
829
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000830/* Write a compiled module to a file, placing the time of last
831 modification of its source into the header.
832 Errors are ignored, if a write error occurs an attempt is made to
833 remove the file. */
834
835static void
Martin v. Löwis18e16552006-02-15 17:27:45 +0000836write_compiled_module(PyCodeObject *co, char *cpathname, time_t mtime)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000837{
838 FILE *fp;
839
Guido van Rossum55a83382000-09-20 20:31:38 +0000840 fp = open_exclusive(cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000841 if (fp == NULL) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000842 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000843 PySys_WriteStderr(
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000844 "# can't create %s\n", cpathname);
845 return;
846 }
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000847 PyMarshal_WriteLongToFile(pyc_magic, fp, Py_MARSHAL_VERSION);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000848 /* First write a 0 for mtime */
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000849 PyMarshal_WriteLongToFile(0L, fp, Py_MARSHAL_VERSION);
850 PyMarshal_WriteObjectToFile((PyObject *)co, fp, Py_MARSHAL_VERSION);
Armin Rigo01ab2792004-03-26 15:09:27 +0000851 if (fflush(fp) != 0 || ferror(fp)) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000852 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000853 PySys_WriteStderr("# can't write %s\n", cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000854 /* Don't keep partial file */
855 fclose(fp);
856 (void) unlink(cpathname);
857 return;
858 }
859 /* Now write the true mtime */
860 fseek(fp, 4L, 0);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000861 assert(mtime < LONG_MAX);
Martin v. Löwis725507b2006-03-07 12:08:51 +0000862 PyMarshal_WriteLongToFile((long)mtime, fp, Py_MARSHAL_VERSION);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000863 fflush(fp);
864 fclose(fp);
Guido van Rossum79f25d91997-04-29 20:08:16 +0000865 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000866 PySys_WriteStderr("# wrote %s\n", cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000867}
868
869
870/* Load a source module from a given file and return its module
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000871 object WITH INCREMENTED REFERENCE COUNT. If there's a matching
872 byte-compiled file, use that instead. */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000873
Guido van Rossum79f25d91997-04-29 20:08:16 +0000874static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000875load_source_module(char *name, char *pathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000876{
Fred Drake4c82b232000-06-30 16:18:57 +0000877 time_t mtime;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000878 FILE *fpc;
879 char buf[MAXPATHLEN+1];
880 char *cpathname;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000881 PyCodeObject *co;
882 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000883
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000884 mtime = PyOS_GetLastModificationTime(pathname, fp);
Neal Norwitz708e51a2005-10-03 04:48:15 +0000885 if (mtime == (time_t)(-1)) {
886 PyErr_Format(PyExc_RuntimeError,
887 "unable to get modification time from '%s'",
888 pathname);
Fred Drake4c82b232000-06-30 16:18:57 +0000889 return NULL;
Neal Norwitz708e51a2005-10-03 04:48:15 +0000890 }
Fred Drake4c82b232000-06-30 16:18:57 +0000891#if SIZEOF_TIME_T > 4
892 /* Python's .pyc timestamp handling presumes that the timestamp fits
893 in 4 bytes. This will be fine until sometime in the year 2038,
894 when a 4-byte signed time_t will overflow.
895 */
896 if (mtime >> 32) {
897 PyErr_SetString(PyExc_OverflowError,
Fred Drakec63d3e92001-03-01 06:33:32 +0000898 "modification time overflows a 4 byte field");
Fred Drake4c82b232000-06-30 16:18:57 +0000899 return NULL;
900 }
901#endif
Tim Peters36515e22001-11-18 04:06:29 +0000902 cpathname = make_compiled_pathname(pathname, buf,
Jeremy Hylton37832f02001-04-13 17:50:20 +0000903 (size_t)MAXPATHLEN + 1);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000904 if (cpathname != NULL &&
905 (fpc = check_compiled_module(pathname, mtime, cpathname))) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000906 co = read_compiled_module(cpathname, fpc);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000907 fclose(fpc);
908 if (co == NULL)
909 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000910 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000911 PySys_WriteStderr("import %s # precompiled from %s\n",
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000912 name, cpathname);
Guido van Rossumafd3dae1998-08-25 18:44:34 +0000913 pathname = cpathname;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000914 }
915 else {
916 co = parse_source_module(pathname, fp);
917 if (co == NULL)
918 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000919 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000920 PySys_WriteStderr("import %s # from %s\n",
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000921 name, pathname);
922 write_compiled_module(co, cpathname, mtime);
923 }
Guido van Rossumafd3dae1998-08-25 18:44:34 +0000924 m = PyImport_ExecCodeModuleEx(name, (PyObject *)co, pathname);
Guido van Rossum79f25d91997-04-29 20:08:16 +0000925 Py_DECREF(co);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000926
927 return m;
928}
929
930
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000931/* Forward */
Just van Rossum52e14d62002-12-30 22:08:05 +0000932static PyObject *load_module(char *, FILE *, char *, int, PyObject *);
933static struct filedescr *find_module(char *, char *, PyObject *,
934 char *, size_t, FILE **, PyObject **);
Tim Petersdbd9ba62000-07-09 03:09:57 +0000935static struct _frozen *find_frozen(char *name);
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000936
937/* Load a package and return its module object WITH INCREMENTED
938 REFERENCE COUNT */
939
940static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000941load_package(char *name, char *pathname)
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000942{
Tim Peters1cd70172004-08-02 03:52:12 +0000943 PyObject *m, *d;
944 PyObject *file = NULL;
945 PyObject *path = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000946 int err;
947 char buf[MAXPATHLEN+1];
948 FILE *fp = NULL;
949 struct filedescr *fdp;
950
951 m = PyImport_AddModule(name);
952 if (m == NULL)
953 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +0000954 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000955 PySys_WriteStderr("import %s # directory %s\n",
Guido van Rossum17fc85f1997-09-06 18:52:03 +0000956 name, pathname);
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000957 d = PyModule_GetDict(m);
958 file = PyString_FromString(pathname);
959 if (file == NULL)
Tim Peters1cd70172004-08-02 03:52:12 +0000960 goto error;
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000961 path = Py_BuildValue("[O]", file);
Tim Peters1cd70172004-08-02 03:52:12 +0000962 if (path == NULL)
963 goto error;
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000964 err = PyDict_SetItemString(d, "__file__", file);
965 if (err == 0)
966 err = PyDict_SetItemString(d, "__path__", path);
Tim Peters1cd70172004-08-02 03:52:12 +0000967 if (err != 0)
968 goto error;
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000969 buf[0] = '\0';
Just van Rossum52e14d62002-12-30 22:08:05 +0000970 fdp = find_module(name, "__init__", path, buf, sizeof(buf), &fp, NULL);
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000971 if (fdp == NULL) {
972 if (PyErr_ExceptionMatches(PyExc_ImportError)) {
973 PyErr_Clear();
Thomas Heller25653242004-06-07 15:04:10 +0000974 Py_INCREF(m);
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000975 }
976 else
977 m = NULL;
978 goto cleanup;
979 }
Just van Rossum52e14d62002-12-30 22:08:05 +0000980 m = load_module(name, fp, buf, fdp->type, NULL);
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000981 if (fp != NULL)
982 fclose(fp);
Tim Peters1cd70172004-08-02 03:52:12 +0000983 goto cleanup;
984
985 error:
986 m = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000987 cleanup:
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000988 Py_XDECREF(path);
989 Py_XDECREF(file);
990 return m;
991}
992
993
994/* Helper to test for built-in module */
995
996static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000997is_builtin(char *name)
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000998{
999 int i;
Guido van Rossum771c6c81997-10-31 18:37:24 +00001000 for (i = 0; PyImport_Inittab[i].name != NULL; i++) {
1001 if (strcmp(name, PyImport_Inittab[i].name) == 0) {
1002 if (PyImport_Inittab[i].initfunc == NULL)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001003 return -1;
1004 else
1005 return 1;
1006 }
1007 }
1008 return 0;
1009}
1010
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001011
Just van Rossum52e14d62002-12-30 22:08:05 +00001012/* Return an importer object for a sys.path/pkg.__path__ item 'p',
1013 possibly by fetching it from the path_importer_cache dict. If it
1014 wasn't yet cached, traverse path_hooks until it a hook is found
1015 that can handle the path item. Return None if no hook could;
1016 this tells our caller it should fall back to the builtin
1017 import mechanism. Cache the result in path_importer_cache.
1018 Returns a borrowed reference. */
1019
1020static PyObject *
1021get_path_importer(PyObject *path_importer_cache, PyObject *path_hooks,
1022 PyObject *p)
1023{
1024 PyObject *importer;
Martin v. Löwis725507b2006-03-07 12:08:51 +00001025 Py_ssize_t j, nhooks;
Just van Rossum52e14d62002-12-30 22:08:05 +00001026
1027 /* These conditions are the caller's responsibility: */
1028 assert(PyList_Check(path_hooks));
1029 assert(PyDict_Check(path_importer_cache));
1030
1031 nhooks = PyList_Size(path_hooks);
1032 if (nhooks < 0)
1033 return NULL; /* Shouldn't happen */
1034
1035 importer = PyDict_GetItem(path_importer_cache, p);
1036 if (importer != NULL)
1037 return importer;
1038
1039 /* set path_importer_cache[p] to None to avoid recursion */
1040 if (PyDict_SetItem(path_importer_cache, p, Py_None) != 0)
1041 return NULL;
1042
1043 for (j = 0; j < nhooks; j++) {
1044 PyObject *hook = PyList_GetItem(path_hooks, j);
1045 if (hook == NULL)
1046 return NULL;
Georg Brandl684fd0c2006-05-25 19:15:31 +00001047 importer = PyObject_CallFunctionObjArgs(hook, p, NULL);
Just van Rossum52e14d62002-12-30 22:08:05 +00001048 if (importer != NULL)
1049 break;
1050
1051 if (!PyErr_ExceptionMatches(PyExc_ImportError)) {
1052 return NULL;
1053 }
1054 PyErr_Clear();
1055 }
1056 if (importer == NULL)
1057 importer = Py_None;
1058 else if (importer != Py_None) {
1059 int err = PyDict_SetItem(path_importer_cache, p, importer);
1060 Py_DECREF(importer);
1061 if (err != 0)
1062 return NULL;
1063 }
1064 return importer;
1065}
1066
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001067/* Search the path (default sys.path) for a module. Return the
1068 corresponding filedescr struct, and (via return arguments) the
1069 pathname and an open file. Return NULL if the module is not found. */
1070
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001071#ifdef MS_COREDLL
Thomas Woutersb4bd21c2000-07-22 23:38:01 +00001072extern FILE *PyWin_FindRegisteredModule(const char *, struct filedescr **,
Martin v. Löwis18e16552006-02-15 17:27:45 +00001073 char *, Py_ssize_t);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001074#endif
1075
Martin v. Löwis18e16552006-02-15 17:27:45 +00001076static int case_ok(char *, Py_ssize_t, Py_ssize_t, char *);
Tim Petersdbd9ba62000-07-09 03:09:57 +00001077static int find_init_module(char *); /* Forward */
Just van Rossum52e14d62002-12-30 22:08:05 +00001078static struct filedescr importhookdescr = {"", "", IMP_HOOK};
Guido van Rossum197346f1997-10-31 18:38:52 +00001079
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001080static struct filedescr *
Just van Rossum52e14d62002-12-30 22:08:05 +00001081find_module(char *fullname, char *subname, PyObject *path, char *buf,
1082 size_t buflen, FILE **p_fp, PyObject **p_loader)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001083{
Martin v. Löwis725507b2006-03-07 12:08:51 +00001084 Py_ssize_t i, npath;
Fred Drake4c82b232000-06-30 16:18:57 +00001085 size_t len, namelen;
Guido van Rossum80bb9651996-12-05 23:27:02 +00001086 struct filedescr *fdp = NULL;
Jack Jansenc88da1f2002-05-28 10:58:19 +00001087 char *filemode;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001088 FILE *fp = NULL;
Just van Rossum52e14d62002-12-30 22:08:05 +00001089 PyObject *path_hooks, *path_importer_cache;
Guido van Rossum48a680c2001-03-02 06:34:14 +00001090#ifndef RISCOS
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001091 struct stat statbuf;
Guido van Rossum48a680c2001-03-02 06:34:14 +00001092#endif
Guido van Rossuma5568d31998-03-05 03:45:08 +00001093 static struct filedescr fd_frozen = {"", "", PY_FROZEN};
1094 static struct filedescr fd_builtin = {"", "", C_BUILTIN};
1095 static struct filedescr fd_package = {"", "", PKG_DIRECTORY};
Guido van Rossum0506a431998-08-11 15:07:39 +00001096 char name[MAXPATHLEN+1];
Andrew MacIntyred9400542002-02-26 11:41:34 +00001097#if defined(PYOS_OS2)
1098 size_t saved_len;
1099 size_t saved_namelen;
1100 char *saved_buf = NULL;
1101#endif
Just van Rossum52e14d62002-12-30 22:08:05 +00001102 if (p_loader != NULL)
1103 *p_loader = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001104
Just van Rossum52e14d62002-12-30 22:08:05 +00001105 if (strlen(subname) > MAXPATHLEN) {
Guido van Rossum8f4d3312001-10-18 18:54:11 +00001106 PyErr_SetString(PyExc_OverflowError,
1107 "module name is too long");
Fred Drake4c82b232000-06-30 16:18:57 +00001108 return NULL;
1109 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001110 strcpy(name, subname);
1111
1112 /* sys.meta_path import hook */
1113 if (p_loader != NULL) {
1114 PyObject *meta_path;
1115
1116 meta_path = PySys_GetObject("meta_path");
1117 if (meta_path == NULL || !PyList_Check(meta_path)) {
1118 PyErr_SetString(PyExc_ImportError,
1119 "sys.meta_path must be a list of "
1120 "import hooks");
1121 return NULL;
1122 }
1123 Py_INCREF(meta_path); /* zap guard */
1124 npath = PyList_Size(meta_path);
1125 for (i = 0; i < npath; i++) {
1126 PyObject *loader;
1127 PyObject *hook = PyList_GetItem(meta_path, i);
1128 loader = PyObject_CallMethod(hook, "find_module",
1129 "sO", fullname,
1130 path != NULL ?
1131 path : Py_None);
1132 if (loader == NULL) {
1133 Py_DECREF(meta_path);
1134 return NULL; /* true error */
1135 }
1136 if (loader != Py_None) {
1137 /* a loader was found */
1138 *p_loader = loader;
1139 Py_DECREF(meta_path);
1140 return &importhookdescr;
1141 }
1142 Py_DECREF(loader);
1143 }
1144 Py_DECREF(meta_path);
1145 }
Guido van Rossum0506a431998-08-11 15:07:39 +00001146
1147 if (path != NULL && PyString_Check(path)) {
Guido van Rossum8f4d3312001-10-18 18:54:11 +00001148 /* The only type of submodule allowed inside a "frozen"
1149 package are other frozen modules or packages. */
Guido van Rossum0506a431998-08-11 15:07:39 +00001150 if (PyString_Size(path) + 1 + strlen(name) >= (size_t)buflen) {
1151 PyErr_SetString(PyExc_ImportError,
1152 "full frozen module name too long");
1153 return NULL;
1154 }
1155 strcpy(buf, PyString_AsString(path));
1156 strcat(buf, ".");
1157 strcat(buf, name);
1158 strcpy(name, buf);
Guido van Rossum8f4d3312001-10-18 18:54:11 +00001159 if (find_frozen(name) != NULL) {
1160 strcpy(buf, name);
1161 return &fd_frozen;
1162 }
1163 PyErr_Format(PyExc_ImportError,
1164 "No frozen submodule named %.200s", name);
1165 return NULL;
Guido van Rossum0506a431998-08-11 15:07:39 +00001166 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001167 if (path == NULL) {
1168 if (is_builtin(name)) {
Guido van Rossuma5568d31998-03-05 03:45:08 +00001169 strcpy(buf, name);
1170 return &fd_builtin;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001171 }
Greg Ward201baee2001-10-04 14:52:06 +00001172 if ((find_frozen(name)) != NULL) {
Guido van Rossuma5568d31998-03-05 03:45:08 +00001173 strcpy(buf, name);
1174 return &fd_frozen;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001175 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001176
Guido van Rossumac279101996-08-22 23:10:58 +00001177#ifdef MS_COREDLL
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001178 fp = PyWin_FindRegisteredModule(name, &fdp, buf, buflen);
1179 if (fp != NULL) {
1180 *p_fp = fp;
1181 return fdp;
1182 }
Guido van Rossuma5a3db71996-04-09 02:39:59 +00001183#endif
Guido van Rossuma5568d31998-03-05 03:45:08 +00001184 path = PySys_GetObject("path");
1185 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00001186 if (path == NULL || !PyList_Check(path)) {
1187 PyErr_SetString(PyExc_ImportError,
Guido van Rossuma5568d31998-03-05 03:45:08 +00001188 "sys.path must be a list of directory names");
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001189 return NULL;
1190 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001191
1192 path_hooks = PySys_GetObject("path_hooks");
1193 if (path_hooks == NULL || !PyList_Check(path_hooks)) {
1194 PyErr_SetString(PyExc_ImportError,
1195 "sys.path_hooks must be a list of "
1196 "import hooks");
1197 return NULL;
1198 }
1199 path_importer_cache = PySys_GetObject("path_importer_cache");
1200 if (path_importer_cache == NULL ||
1201 !PyDict_Check(path_importer_cache)) {
1202 PyErr_SetString(PyExc_ImportError,
1203 "sys.path_importer_cache must be a dict");
1204 return NULL;
1205 }
1206
Guido van Rossum79f25d91997-04-29 20:08:16 +00001207 npath = PyList_Size(path);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001208 namelen = strlen(name);
1209 for (i = 0; i < npath; i++) {
Walter Dörwald3430d702002-06-17 10:43:59 +00001210 PyObject *copy = NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +00001211 PyObject *v = PyList_GetItem(path, i);
Walter Dörwald3430d702002-06-17 10:43:59 +00001212#ifdef Py_USING_UNICODE
1213 if (PyUnicode_Check(v)) {
1214 copy = PyUnicode_Encode(PyUnicode_AS_UNICODE(v),
1215 PyUnicode_GET_SIZE(v), Py_FileSystemDefaultEncoding, NULL);
1216 if (copy == NULL)
1217 return NULL;
1218 v = copy;
1219 }
1220 else
1221#endif
Guido van Rossum79f25d91997-04-29 20:08:16 +00001222 if (!PyString_Check(v))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001223 continue;
Neal Norwitz2aa9a5d2006-03-20 01:53:23 +00001224 len = PyString_GET_SIZE(v);
Walter Dörwald3430d702002-06-17 10:43:59 +00001225 if (len + 2 + namelen + MAXSUFFIXSIZE >= buflen) {
1226 Py_XDECREF(copy);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001227 continue; /* Too long */
Walter Dörwald3430d702002-06-17 10:43:59 +00001228 }
Neal Norwitz2aa9a5d2006-03-20 01:53:23 +00001229 strcpy(buf, PyString_AS_STRING(v));
Walter Dörwald3430d702002-06-17 10:43:59 +00001230 if (strlen(buf) != len) {
1231 Py_XDECREF(copy);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001232 continue; /* v contains '\0' */
Walter Dörwald3430d702002-06-17 10:43:59 +00001233 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001234
1235 /* sys.path_hooks import hook */
1236 if (p_loader != NULL) {
1237 PyObject *importer;
1238
1239 importer = get_path_importer(path_importer_cache,
1240 path_hooks, v);
Neal Norwitza4df11d2006-07-06 04:28:59 +00001241 if (importer == NULL) {
1242 Py_XDECREF(copy);
Just van Rossum52e14d62002-12-30 22:08:05 +00001243 return NULL;
Neal Norwitza4df11d2006-07-06 04:28:59 +00001244 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001245 /* Note: importer is a borrowed reference */
Georg Brandlf4ef1162006-05-26 18:03:31 +00001246 if (importer == Py_False) {
1247 /* Cached as not being a valid dir. */
1248 Py_XDECREF(copy);
1249 continue;
1250 }
1251 else if (importer == Py_True) {
1252 /* Cached as being a valid dir, so just
1253 * continue below. */
1254 }
1255 else if (importer == Py_None) {
1256 /* No importer was found, so it has to be a file.
Georg Brandl0fd12912006-05-28 20:11:45 +00001257 * Check if the directory is valid.
1258 * Note that the empty string is a valid path, but
1259 * not stat'able, hence the check for len. */
Georg Brandlf4ef1162006-05-26 18:03:31 +00001260#ifdef HAVE_STAT
Georg Brandl0fd12912006-05-28 20:11:45 +00001261 if (len && stat(buf, &statbuf) != 0) {
Georg Brandlf4ef1162006-05-26 18:03:31 +00001262 /* Directory does not exist. */
1263 PyDict_SetItem(path_importer_cache,
1264 v, Py_False);
1265 Py_XDECREF(copy);
1266 continue;
1267 } else {
1268 PyDict_SetItem(path_importer_cache,
1269 v, Py_True);
1270 }
1271#endif
1272 }
1273 else {
1274 /* A real import hook importer was found. */
Just van Rossum52e14d62002-12-30 22:08:05 +00001275 PyObject *loader;
1276 loader = PyObject_CallMethod(importer,
1277 "find_module",
1278 "s", fullname);
Neal Norwitza4df11d2006-07-06 04:28:59 +00001279 Py_XDECREF(copy);
Just van Rossum52e14d62002-12-30 22:08:05 +00001280 if (loader == NULL)
1281 return NULL; /* error */
1282 if (loader != Py_None) {
1283 /* a loader was found */
1284 *p_loader = loader;
1285 return &importhookdescr;
1286 }
1287 Py_DECREF(loader);
Georg Brandlf4ef1162006-05-26 18:03:31 +00001288 continue;
Just van Rossum52e14d62002-12-30 22:08:05 +00001289 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001290 }
Georg Brandlf4ef1162006-05-26 18:03:31 +00001291 /* no hook was found, use builtin import */
Just van Rossum52e14d62002-12-30 22:08:05 +00001292
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001293 if (len > 0 && buf[len-1] != SEP
1294#ifdef ALTSEP
1295 && buf[len-1] != ALTSEP
1296#endif
1297 )
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001298 buf[len++] = SEP;
Guido van Rossum215c3402000-11-13 17:26:32 +00001299 strcpy(buf+len, name);
1300 len += namelen;
Tim Peters50d8d372001-02-28 05:34:27 +00001301
1302 /* Check for package import (buf holds a directory name,
1303 and there's an __init__ module in that directory */
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001304#ifdef HAVE_STAT
Walter Dörwald3430d702002-06-17 10:43:59 +00001305 if (stat(buf, &statbuf) == 0 && /* it exists */
1306 S_ISDIR(statbuf.st_mode) && /* it's a directory */
Thomas Wouters9df4e6f2006-04-27 23:13:20 +00001307 case_ok(buf, len, namelen, name)) { /* case matches */
1308 if (find_init_module(buf)) { /* and has __init__.py */
1309 Py_XDECREF(copy);
1310 return &fd_package;
1311 }
1312 else {
1313 char warnstr[MAXPATHLEN+80];
1314 sprintf(warnstr, "Not importing directory "
1315 "'%.*s': missing __init__.py",
1316 MAXPATHLEN, buf);
1317 if (PyErr_Warn(PyExc_ImportWarning,
1318 warnstr)) {
1319 Py_XDECREF(copy);
1320 return NULL;
1321 }
1322 }
Walter Dörwald3430d702002-06-17 10:43:59 +00001323 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001324#else
1325 /* XXX How are you going to test for directories? */
Guido van Rossum48a680c2001-03-02 06:34:14 +00001326#ifdef RISCOS
Guido van Rossume2ae77b2001-10-24 20:42:55 +00001327 if (isdir(buf) &&
Walter Dörwald3430d702002-06-17 10:43:59 +00001328 case_ok(buf, len, namelen, name)) {
Thomas Wouters9df4e6f2006-04-27 23:13:20 +00001329 if (find_init_module(buf)) {
1330 Py_XDECREF(copy);
1331 return &fd_package;
1332 }
1333 else {
1334 char warnstr[MAXPATHLEN+80];
1335 sprintf(warnstr, "Not importing directory "
1336 "'%.*s': missing __init__.py",
1337 MAXPATHLEN, buf);
1338 if (PyErr_Warn(PyExc_ImportWarning,
1339 warnstr)) {
1340 Py_XDECREF(copy);
1341 return NULL;
1342 }
Walter Dörwald3430d702002-06-17 10:43:59 +00001343 }
Guido van Rossum48a680c2001-03-02 06:34:14 +00001344#endif
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001345#endif
Andrew MacIntyred9400542002-02-26 11:41:34 +00001346#if defined(PYOS_OS2)
1347 /* take a snapshot of the module spec for restoration
1348 * after the 8 character DLL hackery
1349 */
1350 saved_buf = strdup(buf);
1351 saved_len = len;
1352 saved_namelen = namelen;
1353#endif /* PYOS_OS2 */
Guido van Rossum79f25d91997-04-29 20:08:16 +00001354 for (fdp = _PyImport_Filetab; fdp->suffix != NULL; fdp++) {
Andrew MacIntyred9400542002-02-26 11:41:34 +00001355#if defined(PYOS_OS2)
Jeremy Hylton4ae6fae2002-05-30 17:15:25 +00001356 /* OS/2 limits DLLs to 8 character names (w/o
1357 extension)
Andrew MacIntyred9400542002-02-26 11:41:34 +00001358 * so if the name is longer than that and its a
1359 * dynamically loaded module we're going to try,
1360 * truncate the name before trying
1361 */
Just van Rossum52e14d62002-12-30 22:08:05 +00001362 if (strlen(subname) > 8) {
Andrew MacIntyred9400542002-02-26 11:41:34 +00001363 /* is this an attempt to load a C extension? */
Jeremy Hylton4ae6fae2002-05-30 17:15:25 +00001364 const struct filedescr *scan;
1365 scan = _PyImport_DynLoadFiletab;
Andrew MacIntyred9400542002-02-26 11:41:34 +00001366 while (scan->suffix != NULL) {
Jeremy Hylton4ae6fae2002-05-30 17:15:25 +00001367 if (!strcmp(scan->suffix, fdp->suffix))
Andrew MacIntyred9400542002-02-26 11:41:34 +00001368 break;
1369 else
1370 scan++;
1371 }
1372 if (scan->suffix != NULL) {
1373 /* yes, so truncate the name */
1374 namelen = 8;
Just van Rossum52e14d62002-12-30 22:08:05 +00001375 len -= strlen(subname) - namelen;
Andrew MacIntyred9400542002-02-26 11:41:34 +00001376 buf[len] = '\0';
1377 }
1378 }
1379#endif /* PYOS_OS2 */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001380 strcpy(buf+len, fdp->suffix);
Guido van Rossum79f25d91997-04-29 20:08:16 +00001381 if (Py_VerboseFlag > 1)
Guido van Rossum2f3667a1998-10-12 18:23:55 +00001382 PySys_WriteStderr("# trying %s\n", buf);
Jack Jansenc88da1f2002-05-28 10:58:19 +00001383 filemode = fdp->mode;
Tim Peters86c7d2f2004-08-01 23:24:21 +00001384 if (filemode[0] == 'U')
Jeremy Hylton4ae6fae2002-05-30 17:15:25 +00001385 filemode = "r" PY_STDIOTEXTMODE;
Jack Jansenc88da1f2002-05-28 10:58:19 +00001386 fp = fopen(buf, filemode);
Tim Peters50d8d372001-02-28 05:34:27 +00001387 if (fp != NULL) {
1388 if (case_ok(buf, len, namelen, name))
1389 break;
1390 else { /* continue search */
1391 fclose(fp);
1392 fp = NULL;
Barry Warsaw914a0b12001-02-02 19:12:16 +00001393 }
Barry Warsaw914a0b12001-02-02 19:12:16 +00001394 }
Andrew MacIntyred9400542002-02-26 11:41:34 +00001395#if defined(PYOS_OS2)
1396 /* restore the saved snapshot */
1397 strcpy(buf, saved_buf);
1398 len = saved_len;
1399 namelen = saved_namelen;
1400#endif
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001401 }
Andrew MacIntyred9400542002-02-26 11:41:34 +00001402#if defined(PYOS_OS2)
1403 /* don't need/want the module name snapshot anymore */
1404 if (saved_buf)
1405 {
1406 free(saved_buf);
1407 saved_buf = NULL;
1408 }
1409#endif
Walter Dörwald3430d702002-06-17 10:43:59 +00001410 Py_XDECREF(copy);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001411 if (fp != NULL)
1412 break;
1413 }
1414 if (fp == NULL) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001415 PyErr_Format(PyExc_ImportError,
1416 "No module named %.200s", name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001417 return NULL;
1418 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001419 *p_fp = fp;
1420 return fdp;
1421}
1422
Raymond Hettingerdb29e0f2004-10-07 06:46:25 +00001423/* Helpers for main.c
1424 * Find the source file corresponding to a named module
1425 */
1426struct filedescr *
1427_PyImport_FindModule(const char *name, PyObject *path, char *buf,
1428 size_t buflen, FILE **p_fp, PyObject **p_loader)
1429{
1430 return find_module((char *) name, (char *) name, path,
1431 buf, buflen, p_fp, p_loader);
1432}
1433
1434PyAPI_FUNC(int) _PyImport_IsScript(struct filedescr * fd)
1435{
1436 return fd->type == PY_SOURCE || fd->type == PY_COMPILED;
1437}
1438
Martin v. Löwis18e16552006-02-15 17:27:45 +00001439/* case_ok(char* buf, Py_ssize_t len, Py_ssize_t namelen, char* name)
Tim Petersd1e87a82001-03-01 18:12:00 +00001440 * The arguments here are tricky, best shown by example:
1441 * /a/b/c/d/e/f/g/h/i/j/k/some_long_module_name.py\0
1442 * ^ ^ ^ ^
1443 * |--------------------- buf ---------------------|
1444 * |------------------- len ------------------|
1445 * |------ name -------|
1446 * |----- namelen -----|
1447 * buf is the full path, but len only counts up to (& exclusive of) the
1448 * extension. name is the module name, also exclusive of extension.
1449 *
1450 * We've already done a successful stat() or fopen() on buf, so know that
1451 * there's some match, possibly case-insensitive.
1452 *
Tim Peters50d8d372001-02-28 05:34:27 +00001453 * case_ok() is to return 1 if there's a case-sensitive match for
1454 * name, else 0. case_ok() is also to return 1 if envar PYTHONCASEOK
1455 * exists.
Tim Petersd1e87a82001-03-01 18:12:00 +00001456 *
Tim Peters50d8d372001-02-28 05:34:27 +00001457 * case_ok() is used to implement case-sensitive import semantics even
1458 * on platforms with case-insensitive filesystems. It's trivial to implement
1459 * for case-sensitive filesystems. It's pretty much a cross-platform
1460 * nightmare for systems with case-insensitive filesystems.
1461 */
Guido van Rossum0980bd91998-02-13 17:18:36 +00001462
Tim Peters50d8d372001-02-28 05:34:27 +00001463/* First we may need a pile of platform-specific header files; the sequence
1464 * of #if's here should match the sequence in the body of case_ok().
1465 */
Jason Tishler7961aa62005-05-20 00:56:54 +00001466#if defined(MS_WINDOWS)
Guido van Rossum0980bd91998-02-13 17:18:36 +00001467#include <windows.h>
Guido van Rossum4c3f57c2001-01-10 20:40:46 +00001468
Tim Peters50d8d372001-02-28 05:34:27 +00001469#elif defined(DJGPP)
1470#include <dir.h>
1471
Jason Tishler7961aa62005-05-20 00:56:54 +00001472#elif (defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) && defined(HAVE_DIRENT_H)
Tim Peters430f5d42001-03-01 01:30:56 +00001473#include <sys/types.h>
1474#include <dirent.h>
1475
Andrew MacIntyred9400542002-02-26 11:41:34 +00001476#elif defined(PYOS_OS2)
1477#define INCL_DOS
1478#define INCL_DOSERRORS
1479#define INCL_NOPMAPI
1480#include <os2.h>
1481
Guido van Rossume2ae77b2001-10-24 20:42:55 +00001482#elif defined(RISCOS)
1483#include "oslib/osfscontrol.h"
Tim Peters50d8d372001-02-28 05:34:27 +00001484#endif
1485
Guido van Rossum0980bd91998-02-13 17:18:36 +00001486static int
Martin v. Löwis18e16552006-02-15 17:27:45 +00001487case_ok(char *buf, Py_ssize_t len, Py_ssize_t namelen, char *name)
Guido van Rossum0980bd91998-02-13 17:18:36 +00001488{
Tim Peters50d8d372001-02-28 05:34:27 +00001489/* Pick a platform-specific implementation; the sequence of #if's here should
1490 * match the sequence just above.
1491 */
1492
Jason Tishler7961aa62005-05-20 00:56:54 +00001493/* MS_WINDOWS */
1494#if defined(MS_WINDOWS)
Guido van Rossum0980bd91998-02-13 17:18:36 +00001495 WIN32_FIND_DATA data;
1496 HANDLE h;
Tim Peters50d8d372001-02-28 05:34:27 +00001497
Neil Schemenauer7d4bb9f2001-07-23 16:30:27 +00001498 if (Py_GETENV("PYTHONCASEOK") != NULL)
Guido van Rossum0980bd91998-02-13 17:18:36 +00001499 return 1;
Tim Peters50d8d372001-02-28 05:34:27 +00001500
Guido van Rossum0980bd91998-02-13 17:18:36 +00001501 h = FindFirstFile(buf, &data);
1502 if (h == INVALID_HANDLE_VALUE) {
1503 PyErr_Format(PyExc_NameError,
1504 "Can't find file for module %.100s\n(filename %.300s)",
1505 name, buf);
1506 return 0;
1507 }
1508 FindClose(h);
Tim Peters50d8d372001-02-28 05:34:27 +00001509 return strncmp(data.cFileName, name, namelen) == 0;
1510
1511/* DJGPP */
1512#elif defined(DJGPP)
1513 struct ffblk ffblk;
1514 int done;
1515
Neil Schemenauer7d4bb9f2001-07-23 16:30:27 +00001516 if (Py_GETENV("PYTHONCASEOK") != NULL)
Guido van Rossum323bf5e1998-06-24 03:54:06 +00001517 return 1;
Tim Peters50d8d372001-02-28 05:34:27 +00001518
1519 done = findfirst(buf, &ffblk, FA_ARCH|FA_RDONLY|FA_HIDDEN|FA_DIREC);
1520 if (done) {
Guido van Rossum0980bd91998-02-13 17:18:36 +00001521 PyErr_Format(PyExc_NameError,
Tim Peters50d8d372001-02-28 05:34:27 +00001522 "Can't find file for module %.100s\n(filename %.300s)",
Guido van Rossum0980bd91998-02-13 17:18:36 +00001523 name, buf);
1524 return 0;
1525 }
Tim Peters50d8d372001-02-28 05:34:27 +00001526 return strncmp(ffblk.ff_name, name, namelen) == 0;
Guido van Rossum0980bd91998-02-13 17:18:36 +00001527
Jason Tishler7961aa62005-05-20 00:56:54 +00001528/* new-fangled macintosh (macosx) or Cygwin */
1529#elif (defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) && defined(HAVE_DIRENT_H)
Tim Peters430f5d42001-03-01 01:30:56 +00001530 DIR *dirp;
1531 struct dirent *dp;
Tim Petersd1e87a82001-03-01 18:12:00 +00001532 char dirname[MAXPATHLEN + 1];
1533 const int dirlen = len - namelen - 1; /* don't want trailing SEP */
Tim Peters430f5d42001-03-01 01:30:56 +00001534
Neil Schemenauer7d4bb9f2001-07-23 16:30:27 +00001535 if (Py_GETENV("PYTHONCASEOK") != NULL)
Tim Petersdbe6ebb2001-03-01 08:47:29 +00001536 return 1;
1537
Tim Petersd1e87a82001-03-01 18:12:00 +00001538 /* Copy the dir component into dirname; substitute "." if empty */
1539 if (dirlen <= 0) {
1540 dirname[0] = '.';
1541 dirname[1] = '\0';
Tim Peters430f5d42001-03-01 01:30:56 +00001542 }
1543 else {
Tim Petersd1e87a82001-03-01 18:12:00 +00001544 assert(dirlen <= MAXPATHLEN);
1545 memcpy(dirname, buf, dirlen);
1546 dirname[dirlen] = '\0';
Tim Peters430f5d42001-03-01 01:30:56 +00001547 }
1548 /* Open the directory and search the entries for an exact match. */
Tim Petersd1e87a82001-03-01 18:12:00 +00001549 dirp = opendir(dirname);
Tim Peters430f5d42001-03-01 01:30:56 +00001550 if (dirp) {
Tim Peters677898a2001-03-02 03:28:03 +00001551 char *nameWithExt = buf + len - namelen;
Tim Peters430f5d42001-03-01 01:30:56 +00001552 while ((dp = readdir(dirp)) != NULL) {
Tim Petersdbe6ebb2001-03-01 08:47:29 +00001553 const int thislen =
Tim Peters430f5d42001-03-01 01:30:56 +00001554#ifdef _DIRENT_HAVE_D_NAMELEN
Tim Petersdbe6ebb2001-03-01 08:47:29 +00001555 dp->d_namlen;
Tim Peters430f5d42001-03-01 01:30:56 +00001556#else
Tim Petersdbe6ebb2001-03-01 08:47:29 +00001557 strlen(dp->d_name);
Tim Peters430f5d42001-03-01 01:30:56 +00001558#endif
Tim Petersd1e87a82001-03-01 18:12:00 +00001559 if (thislen >= namelen &&
Tim Peters677898a2001-03-02 03:28:03 +00001560 strcmp(dp->d_name, nameWithExt) == 0) {
Tim Peters430f5d42001-03-01 01:30:56 +00001561 (void)closedir(dirp);
1562 return 1; /* Found */
1563 }
1564 }
Tim Petersdbe6ebb2001-03-01 08:47:29 +00001565 (void)closedir(dirp);
Tim Peters430f5d42001-03-01 01:30:56 +00001566 }
Tim Peters430f5d42001-03-01 01:30:56 +00001567 return 0 ; /* Not found */
Tim Peters430f5d42001-03-01 01:30:56 +00001568
Guido van Rossume2ae77b2001-10-24 20:42:55 +00001569/* RISC OS */
1570#elif defined(RISCOS)
1571 char canon[MAXPATHLEN+1]; /* buffer for the canonical form of the path */
1572 char buf2[MAXPATHLEN+2];
1573 char *nameWithExt = buf+len-namelen;
1574 int canonlen;
1575 os_error *e;
1576
1577 if (Py_GETENV("PYTHONCASEOK") != NULL)
1578 return 1;
1579
1580 /* workaround:
1581 append wildcard, otherwise case of filename wouldn't be touched */
1582 strcpy(buf2, buf);
1583 strcat(buf2, "*");
1584
1585 e = xosfscontrol_canonicalise_path(buf2,canon,0,0,MAXPATHLEN+1,&canonlen);
1586 canonlen = MAXPATHLEN+1-canonlen;
1587 if (e || canonlen<=0 || canonlen>(MAXPATHLEN+1) )
1588 return 0;
1589 if (strcmp(nameWithExt, canon+canonlen-strlen(nameWithExt))==0)
1590 return 1; /* match */
1591
1592 return 0;
1593
Andrew MacIntyred9400542002-02-26 11:41:34 +00001594/* OS/2 */
1595#elif defined(PYOS_OS2)
1596 HDIR hdir = 1;
1597 ULONG srchcnt = 1;
1598 FILEFINDBUF3 ffbuf;
1599 APIRET rc;
1600
1601 if (getenv("PYTHONCASEOK") != NULL)
1602 return 1;
1603
1604 rc = DosFindFirst(buf,
1605 &hdir,
1606 FILE_READONLY | FILE_HIDDEN | FILE_SYSTEM | FILE_DIRECTORY,
1607 &ffbuf, sizeof(ffbuf),
1608 &srchcnt,
1609 FIL_STANDARD);
1610 if (rc != NO_ERROR)
1611 return 0;
1612 return strncmp(ffbuf.achName, name, namelen) == 0;
1613
Tim Peters50d8d372001-02-28 05:34:27 +00001614/* assuming it's a case-sensitive filesystem, so there's nothing to do! */
1615#else
Guido van Rossum0980bd91998-02-13 17:18:36 +00001616 return 1;
Guido van Rossum0980bd91998-02-13 17:18:36 +00001617
Guido van Rossum4d1b3b91998-02-13 23:27:59 +00001618#endif
Tim Peters50d8d372001-02-28 05:34:27 +00001619}
Guido van Rossum4d1b3b91998-02-13 23:27:59 +00001620
Guido van Rossum0980bd91998-02-13 17:18:36 +00001621
Guido van Rossum197346f1997-10-31 18:38:52 +00001622#ifdef HAVE_STAT
1623/* Helper to look for __init__.py or __init__.py[co] in potential package */
1624static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001625find_init_module(char *buf)
Guido van Rossum197346f1997-10-31 18:38:52 +00001626{
Tim Peters0f9431f2001-07-05 03:47:53 +00001627 const size_t save_len = strlen(buf);
Fred Drake4c82b232000-06-30 16:18:57 +00001628 size_t i = save_len;
Tim Peters0f9431f2001-07-05 03:47:53 +00001629 char *pname; /* pointer to start of __init__ */
Guido van Rossum197346f1997-10-31 18:38:52 +00001630 struct stat statbuf;
1631
Tim Peters0f9431f2001-07-05 03:47:53 +00001632/* For calling case_ok(buf, len, namelen, name):
1633 * /a/b/c/d/e/f/g/h/i/j/k/some_long_module_name.py\0
1634 * ^ ^ ^ ^
1635 * |--------------------- buf ---------------------|
1636 * |------------------- len ------------------|
1637 * |------ name -------|
1638 * |----- namelen -----|
1639 */
Guido van Rossum197346f1997-10-31 18:38:52 +00001640 if (save_len + 13 >= MAXPATHLEN)
1641 return 0;
1642 buf[i++] = SEP;
Tim Peters0f9431f2001-07-05 03:47:53 +00001643 pname = buf + i;
1644 strcpy(pname, "__init__.py");
Guido van Rossum197346f1997-10-31 18:38:52 +00001645 if (stat(buf, &statbuf) == 0) {
Tim Peters0f9431f2001-07-05 03:47:53 +00001646 if (case_ok(buf,
1647 save_len + 9, /* len("/__init__") */
1648 8, /* len("__init__") */
1649 pname)) {
1650 buf[save_len] = '\0';
1651 return 1;
1652 }
Guido van Rossum197346f1997-10-31 18:38:52 +00001653 }
Tim Peters0f9431f2001-07-05 03:47:53 +00001654 i += strlen(pname);
1655 strcpy(buf+i, Py_OptimizeFlag ? "o" : "c");
Guido van Rossum197346f1997-10-31 18:38:52 +00001656 if (stat(buf, &statbuf) == 0) {
Tim Peters0f9431f2001-07-05 03:47:53 +00001657 if (case_ok(buf,
1658 save_len + 9, /* len("/__init__") */
1659 8, /* len("__init__") */
1660 pname)) {
1661 buf[save_len] = '\0';
1662 return 1;
1663 }
Guido van Rossum197346f1997-10-31 18:38:52 +00001664 }
1665 buf[save_len] = '\0';
1666 return 0;
1667}
Guido van Rossum48a680c2001-03-02 06:34:14 +00001668
1669#else
1670
1671#ifdef RISCOS
1672static int
1673find_init_module(buf)
1674 char *buf;
1675{
1676 int save_len = strlen(buf);
1677 int i = save_len;
1678
1679 if (save_len + 13 >= MAXPATHLEN)
1680 return 0;
1681 buf[i++] = SEP;
1682 strcpy(buf+i, "__init__/py");
1683 if (isfile(buf)) {
1684 buf[save_len] = '\0';
1685 return 1;
1686 }
1687
1688 if (Py_OptimizeFlag)
1689 strcpy(buf+i, "o");
1690 else
1691 strcpy(buf+i, "c");
1692 if (isfile(buf)) {
1693 buf[save_len] = '\0';
1694 return 1;
1695 }
1696 buf[save_len] = '\0';
1697 return 0;
1698}
1699#endif /*RISCOS*/
1700
Guido van Rossum197346f1997-10-31 18:38:52 +00001701#endif /* HAVE_STAT */
1702
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001703
Tim Petersdbd9ba62000-07-09 03:09:57 +00001704static int init_builtin(char *); /* Forward */
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001705
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001706/* Load an external module using the default search path and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001707 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001708
Guido van Rossum79f25d91997-04-29 20:08:16 +00001709static PyObject *
Just van Rossum52e14d62002-12-30 22:08:05 +00001710load_module(char *name, FILE *fp, char *buf, int type, PyObject *loader)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001711{
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001712 PyObject *modules;
Guido van Rossum79f25d91997-04-29 20:08:16 +00001713 PyObject *m;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001714 int err;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001715
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001716 /* First check that there's an open file (if we need one) */
1717 switch (type) {
1718 case PY_SOURCE:
1719 case PY_COMPILED:
1720 if (fp == NULL) {
1721 PyErr_Format(PyExc_ValueError,
1722 "file object required for import (type code %d)",
1723 type);
1724 return NULL;
1725 }
1726 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001727
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001728 switch (type) {
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001729
1730 case PY_SOURCE:
1731 m = load_source_module(name, buf, fp);
1732 break;
1733
1734 case PY_COMPILED:
1735 m = load_compiled_module(name, buf, fp);
1736 break;
1737
Guido van Rossum96a8fb71999-12-22 14:09:35 +00001738#ifdef HAVE_DYNAMIC_LOADING
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001739 case C_EXTENSION:
Guido van Rossum79f25d91997-04-29 20:08:16 +00001740 m = _PyImport_LoadDynamicModule(name, buf, fp);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001741 break;
Guido van Rossum96a8fb71999-12-22 14:09:35 +00001742#endif
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001743
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001744 case PKG_DIRECTORY:
1745 m = load_package(name, buf);
1746 break;
1747
1748 case C_BUILTIN:
1749 case PY_FROZEN:
Guido van Rossuma5568d31998-03-05 03:45:08 +00001750 if (buf != NULL && buf[0] != '\0')
1751 name = buf;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001752 if (type == C_BUILTIN)
1753 err = init_builtin(name);
1754 else
1755 err = PyImport_ImportFrozenModule(name);
1756 if (err < 0)
Guido van Rossuma86f77d1997-09-09 18:53:47 +00001757 return NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001758 if (err == 0) {
1759 PyErr_Format(PyExc_ImportError,
1760 "Purported %s module %.200s not found",
1761 type == C_BUILTIN ?
1762 "builtin" : "frozen",
1763 name);
Guido van Rossuma86f77d1997-09-09 18:53:47 +00001764 return NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001765 }
1766 modules = PyImport_GetModuleDict();
1767 m = PyDict_GetItemString(modules, name);
1768 if (m == NULL) {
1769 PyErr_Format(
1770 PyExc_ImportError,
1771 "%s module %.200s not properly initialized",
1772 type == C_BUILTIN ?
1773 "builtin" : "frozen",
1774 name);
Guido van Rossuma86f77d1997-09-09 18:53:47 +00001775 return NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001776 }
1777 Py_INCREF(m);
1778 break;
1779
Just van Rossum52e14d62002-12-30 22:08:05 +00001780 case IMP_HOOK: {
1781 if (loader == NULL) {
1782 PyErr_SetString(PyExc_ImportError,
1783 "import hook without loader");
1784 return NULL;
1785 }
1786 m = PyObject_CallMethod(loader, "load_module", "s", name);
1787 break;
1788 }
1789
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001790 default:
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001791 PyErr_Format(PyExc_ImportError,
1792 "Don't know how to import %.200s (type code %d)",
1793 name, type);
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001794 m = NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001795
1796 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001797
1798 return m;
1799}
1800
1801
1802/* Initialize a built-in module.
1803 Return 1 for succes, 0 if the module is not found, and -1 with
1804 an exception set if the initialization failed. */
Guido van Rossum7f133ed1991-02-19 12:23:57 +00001805
Guido van Rossum7f133ed1991-02-19 12:23:57 +00001806static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001807init_builtin(char *name)
Guido van Rossum7f133ed1991-02-19 12:23:57 +00001808{
Guido van Rossum25ce5661997-08-02 03:10:38 +00001809 struct _inittab *p;
Guido van Rossum25ce5661997-08-02 03:10:38 +00001810
Greg Ward201baee2001-10-04 14:52:06 +00001811 if (_PyImport_FindExtension(name, name) != NULL)
Guido van Rossum25ce5661997-08-02 03:10:38 +00001812 return 1;
1813
Guido van Rossum771c6c81997-10-31 18:37:24 +00001814 for (p = PyImport_Inittab; p->name != NULL; p++) {
Guido van Rossum25ce5661997-08-02 03:10:38 +00001815 if (strcmp(name, p->name) == 0) {
1816 if (p->initfunc == NULL) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001817 PyErr_Format(PyExc_ImportError,
1818 "Cannot re-init internal module %.200s",
1819 name);
Guido van Rossum74e6a111994-08-29 12:54:38 +00001820 return -1;
1821 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00001822 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +00001823 PySys_WriteStderr("import %s # builtin\n", name);
Guido van Rossum25ce5661997-08-02 03:10:38 +00001824 (*p->initfunc)();
Guido van Rossum79f25d91997-04-29 20:08:16 +00001825 if (PyErr_Occurred())
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001826 return -1;
Guido van Rossum25ce5661997-08-02 03:10:38 +00001827 if (_PyImport_FixupExtension(name, name) == NULL)
1828 return -1;
Guido van Rossum7f133ed1991-02-19 12:23:57 +00001829 return 1;
1830 }
1831 }
1832 return 0;
1833}
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001834
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001835
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001836/* Frozen modules */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001837
Guido van Rossumcfd0a221996-06-17 17:06:34 +00001838static struct _frozen *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001839find_frozen(char *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001840{
Guido van Rossumcfd0a221996-06-17 17:06:34 +00001841 struct _frozen *p;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001842
Guido van Rossum79f25d91997-04-29 20:08:16 +00001843 for (p = PyImport_FrozenModules; ; p++) {
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001844 if (p->name == NULL)
1845 return NULL;
1846 if (strcmp(p->name, name) == 0)
1847 break;
1848 }
1849 return p;
1850}
1851
Guido van Rossum79f25d91997-04-29 20:08:16 +00001852static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001853get_frozen_object(char *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001854{
Guido van Rossumcfd0a221996-06-17 17:06:34 +00001855 struct _frozen *p = find_frozen(name);
Guido van Rossuma5568d31998-03-05 03:45:08 +00001856 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001857
1858 if (p == NULL) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001859 PyErr_Format(PyExc_ImportError,
1860 "No such frozen object named %.200s",
1861 name);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001862 return NULL;
1863 }
Guido van Rossum8f4d3312001-10-18 18:54:11 +00001864 if (p->code == NULL) {
1865 PyErr_Format(PyExc_ImportError,
1866 "Excluded frozen object named %.200s",
1867 name);
1868 return NULL;
1869 }
Guido van Rossuma5568d31998-03-05 03:45:08 +00001870 size = p->size;
1871 if (size < 0)
1872 size = -size;
1873 return PyMarshal_ReadObjectFromString((char *)p->code, size);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001874}
1875
1876/* Initialize a frozen module.
1877 Return 1 for succes, 0 if the module is not found, and -1 with
1878 an exception set if the initialization failed.
1879 This function is also used from frozenmain.c */
Guido van Rossum0b344901995-02-07 15:35:27 +00001880
1881int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001882PyImport_ImportFrozenModule(char *name)
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001883{
Guido van Rossumcfd0a221996-06-17 17:06:34 +00001884 struct _frozen *p = find_frozen(name);
Guido van Rossum79f25d91997-04-29 20:08:16 +00001885 PyObject *co;
1886 PyObject *m;
Guido van Rossuma5568d31998-03-05 03:45:08 +00001887 int ispackage;
1888 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001889
1890 if (p == NULL)
1891 return 0;
Guido van Rossum8f4d3312001-10-18 18:54:11 +00001892 if (p->code == NULL) {
1893 PyErr_Format(PyExc_ImportError,
1894 "Excluded frozen object named %.200s",
1895 name);
1896 return -1;
1897 }
Guido van Rossuma5568d31998-03-05 03:45:08 +00001898 size = p->size;
1899 ispackage = (size < 0);
1900 if (ispackage)
1901 size = -size;
Guido van Rossum79f25d91997-04-29 20:08:16 +00001902 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +00001903 PySys_WriteStderr("import %s # frozen%s\n",
Guido van Rossuma5568d31998-03-05 03:45:08 +00001904 name, ispackage ? " package" : "");
1905 co = PyMarshal_ReadObjectFromString((char *)p->code, size);
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001906 if (co == NULL)
1907 return -1;
Guido van Rossum79f25d91997-04-29 20:08:16 +00001908 if (!PyCode_Check(co)) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001909 PyErr_Format(PyExc_TypeError,
1910 "frozen object %.200s is not a code object",
1911 name);
Neal Norwitzc0cde4d2006-07-16 02:17:36 +00001912 goto err_return;
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001913 }
Guido van Rossuma5568d31998-03-05 03:45:08 +00001914 if (ispackage) {
1915 /* Set __path__ to the package name */
1916 PyObject *d, *s;
1917 int err;
1918 m = PyImport_AddModule(name);
1919 if (m == NULL)
Neal Norwitzc0cde4d2006-07-16 02:17:36 +00001920 goto err_return;
Guido van Rossuma5568d31998-03-05 03:45:08 +00001921 d = PyModule_GetDict(m);
1922 s = PyString_InternFromString(name);
1923 if (s == NULL)
Neal Norwitzc0cde4d2006-07-16 02:17:36 +00001924 goto err_return;
Guido van Rossuma5568d31998-03-05 03:45:08 +00001925 err = PyDict_SetItemString(d, "__path__", s);
1926 Py_DECREF(s);
1927 if (err != 0)
Neal Norwitzc0cde4d2006-07-16 02:17:36 +00001928 goto err_return;
Guido van Rossuma5568d31998-03-05 03:45:08 +00001929 }
Guido van Rossume32bf6e1998-02-11 05:53:02 +00001930 m = PyImport_ExecCodeModuleEx(name, co, "<frozen>");
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001931 if (m == NULL)
Neal Norwitzc0cde4d2006-07-16 02:17:36 +00001932 goto err_return;
1933 Py_DECREF(co);
Guido van Rossum79f25d91997-04-29 20:08:16 +00001934 Py_DECREF(m);
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001935 return 1;
Neal Norwitzc0cde4d2006-07-16 02:17:36 +00001936err_return:
1937 Py_DECREF(co);
1938 return -1;
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001939}
Guido van Rossum74e6a111994-08-29 12:54:38 +00001940
1941
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001942/* Import a module, either built-in, frozen, or external, and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001943 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum74e6a111994-08-29 12:54:38 +00001944
Guido van Rossum79f25d91997-04-29 20:08:16 +00001945PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001946PyImport_ImportModule(const char *name)
Guido van Rossum74e6a111994-08-29 12:54:38 +00001947{
Marc-André Lemburg3c61c352001-02-09 19:40:15 +00001948 PyObject *pname;
1949 PyObject *result;
1950
1951 pname = PyString_FromString(name);
Neal Norwitza11e4c12003-03-23 14:31:01 +00001952 if (pname == NULL)
1953 return NULL;
Marc-André Lemburg3c61c352001-02-09 19:40:15 +00001954 result = PyImport_Import(pname);
1955 Py_DECREF(pname);
1956 return result;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001957}
1958
Guido van Rossum17fc85f1997-09-06 18:52:03 +00001959/* Forward declarations for helper routines */
Thomas Woutersf7f438b2006-02-28 16:09:29 +00001960static PyObject *get_parent(PyObject *globals, char *buf,
1961 Py_ssize_t *p_buflen, int level);
Tim Petersdbd9ba62000-07-09 03:09:57 +00001962static PyObject *load_next(PyObject *mod, PyObject *altmod,
Martin v. Löwis18e16552006-02-15 17:27:45 +00001963 char **p_name, char *buf, Py_ssize_t *p_buflen);
Tim Petersdbd9ba62000-07-09 03:09:57 +00001964static int mark_miss(char *name);
1965static int ensure_fromlist(PyObject *mod, PyObject *fromlist,
Martin v. Löwis18e16552006-02-15 17:27:45 +00001966 char *buf, Py_ssize_t buflen, int recursive);
Tim Petersdbd9ba62000-07-09 03:09:57 +00001967static PyObject * import_submodule(PyObject *mod, char *name, char *fullname);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00001968
1969/* The Magnum Opus of dotted-name import :-) */
1970
Guido van Rossum75acc9c1998-03-03 22:26:50 +00001971static PyObject *
Thomas Woutersf7f438b2006-02-28 16:09:29 +00001972import_module_level(char *name, PyObject *globals, PyObject *locals,
1973 PyObject *fromlist, int level)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001974{
Guido van Rossum17fc85f1997-09-06 18:52:03 +00001975 char buf[MAXPATHLEN+1];
Martin v. Löwis18e16552006-02-15 17:27:45 +00001976 Py_ssize_t buflen = 0;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00001977 PyObject *parent, *head, *next, *tail;
1978
Thomas Woutersf7f438b2006-02-28 16:09:29 +00001979 parent = get_parent(globals, buf, &buflen, level);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00001980 if (parent == NULL)
1981 return NULL;
1982
1983 head = load_next(parent, Py_None, &name, buf, &buflen);
1984 if (head == NULL)
1985 return NULL;
1986
1987 tail = head;
1988 Py_INCREF(tail);
1989 while (name) {
1990 next = load_next(tail, tail, &name, buf, &buflen);
1991 Py_DECREF(tail);
1992 if (next == NULL) {
1993 Py_DECREF(head);
1994 return NULL;
1995 }
1996 tail = next;
1997 }
Thomas Wouters8ddab272006-04-04 16:17:02 +00001998 if (tail == Py_None) {
1999 /* If tail is Py_None, both get_parent and load_next found
2000 an empty module name: someone called __import__("") or
2001 doctored faulty bytecode */
Thomas Wouters4bdaa272006-04-05 13:39:37 +00002002 Py_DECREF(tail);
2003 Py_DECREF(head);
Thomas Wouters8ddab272006-04-04 16:17:02 +00002004 PyErr_SetString(PyExc_ValueError,
2005 "Empty module name");
2006 return NULL;
2007 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002008
2009 if (fromlist != NULL) {
2010 if (fromlist == Py_None || !PyObject_IsTrue(fromlist))
2011 fromlist = NULL;
2012 }
2013
2014 if (fromlist == NULL) {
2015 Py_DECREF(tail);
2016 return head;
2017 }
2018
2019 Py_DECREF(head);
Guido van Rossum9905ef91997-09-08 16:07:11 +00002020 if (!ensure_fromlist(tail, fromlist, buf, buflen, 0)) {
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002021 Py_DECREF(tail);
2022 return NULL;
2023 }
2024
2025 return tail;
2026}
2027
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002028/* For DLL compatibility */
2029#undef PyImport_ImportModuleEx
Guido van Rossum75acc9c1998-03-03 22:26:50 +00002030PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002031PyImport_ImportModuleEx(char *name, PyObject *globals, PyObject *locals,
2032 PyObject *fromlist)
Guido van Rossum75acc9c1998-03-03 22:26:50 +00002033{
2034 PyObject *result;
2035 lock_import();
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002036 result = import_module_level(name, globals, locals, fromlist, -1);
2037 if (unlock_import() < 0) {
2038 Py_XDECREF(result);
2039 PyErr_SetString(PyExc_RuntimeError,
2040 "not holding the import lock");
2041 return NULL;
2042 }
2043 return result;
2044}
2045#define PyImport_ImportModuleEx(n, g, l, f) \
2046 PyImport_ImportModuleLevel(n, g, l, f, -1);
2047
2048PyObject *
2049PyImport_ImportModuleLevel(char *name, PyObject *globals, PyObject *locals,
2050 PyObject *fromlist, int level)
2051{
2052 PyObject *result;
2053 lock_import();
2054 result = import_module_level(name, globals, locals, fromlist, level);
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00002055 if (unlock_import() < 0) {
2056 Py_XDECREF(result);
2057 PyErr_SetString(PyExc_RuntimeError,
2058 "not holding the import lock");
2059 return NULL;
2060 }
Guido van Rossum75acc9c1998-03-03 22:26:50 +00002061 return result;
2062}
2063
Fred Drake87590902004-05-28 20:21:36 +00002064/* Return the package that an import is being performed in. If globals comes
2065 from the module foo.bar.bat (not itself a package), this returns the
2066 sys.modules entry for foo.bar. If globals is from a package's __init__.py,
Georg Brandl5f6861d2006-05-28 21:57:35 +00002067 the package's entry in sys.modules is returned, as a borrowed reference.
Fred Drake87590902004-05-28 20:21:36 +00002068
2069 The *name* of the returned package is returned in buf, with the length of
2070 the name in *p_buflen.
2071
2072 If globals doesn't come from a package or a module in a package, or a
2073 corresponding entry is not found in sys.modules, Py_None is returned.
2074*/
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002075static PyObject *
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002076get_parent(PyObject *globals, char *buf, Py_ssize_t *p_buflen, int level)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002077{
2078 static PyObject *namestr = NULL;
2079 static PyObject *pathstr = NULL;
2080 PyObject *modname, *modpath, *modules, *parent;
2081
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002082 if (globals == NULL || !PyDict_Check(globals) || !level)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002083 return Py_None;
2084
2085 if (namestr == NULL) {
2086 namestr = PyString_InternFromString("__name__");
2087 if (namestr == NULL)
2088 return NULL;
2089 }
2090 if (pathstr == NULL) {
2091 pathstr = PyString_InternFromString("__path__");
2092 if (pathstr == NULL)
2093 return NULL;
2094 }
2095
2096 *buf = '\0';
2097 *p_buflen = 0;
2098 modname = PyDict_GetItem(globals, namestr);
2099 if (modname == NULL || !PyString_Check(modname))
2100 return Py_None;
2101
2102 modpath = PyDict_GetItem(globals, pathstr);
2103 if (modpath != NULL) {
Martin v. Löwis725507b2006-03-07 12:08:51 +00002104 Py_ssize_t len = PyString_GET_SIZE(modname);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002105 if (len > MAXPATHLEN) {
2106 PyErr_SetString(PyExc_ValueError,
2107 "Module name too long");
2108 return NULL;
2109 }
2110 strcpy(buf, PyString_AS_STRING(modname));
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002111 }
2112 else {
2113 char *start = PyString_AS_STRING(modname);
2114 char *lastdot = strrchr(start, '.');
Fred Drake4c82b232000-06-30 16:18:57 +00002115 size_t len;
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002116 if (lastdot == NULL && level > 0) {
2117 PyErr_SetString(PyExc_ValueError,
2118 "Relative importpath too deep");
2119 return NULL;
2120 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002121 if (lastdot == NULL)
2122 return Py_None;
2123 len = lastdot - start;
2124 if (len >= MAXPATHLEN) {
2125 PyErr_SetString(PyExc_ValueError,
2126 "Module name too long");
2127 return NULL;
2128 }
2129 strncpy(buf, start, len);
2130 buf[len] = '\0';
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002131 }
2132
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002133 while (--level > 0) {
2134 char *dot = strrchr(buf, '.');
2135 if (dot == NULL) {
2136 PyErr_SetString(PyExc_ValueError,
2137 "Relative importpath too deep");
2138 return NULL;
2139 }
2140 *dot = '\0';
2141 }
2142 *p_buflen = strlen(buf);
2143
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002144 modules = PyImport_GetModuleDict();
2145 parent = PyDict_GetItemString(modules, buf);
2146 if (parent == NULL)
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002147 PyErr_Format(PyExc_SystemError,
2148 "Parent module '%.200s' not loaded", buf);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002149 return parent;
2150 /* We expect, but can't guarantee, if parent != None, that:
2151 - parent.__name__ == buf
2152 - parent.__dict__ is globals
2153 If this is violated... Who cares? */
2154}
2155
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002156/* altmod is either None or same as mod */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002157static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002158load_next(PyObject *mod, PyObject *altmod, char **p_name, char *buf,
Martin v. Löwis18e16552006-02-15 17:27:45 +00002159 Py_ssize_t *p_buflen)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002160{
2161 char *name = *p_name;
2162 char *dot = strchr(name, '.');
Fred Drake4c82b232000-06-30 16:18:57 +00002163 size_t len;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002164 char *p;
2165 PyObject *result;
2166
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002167 if (strlen(name) == 0) {
Thomas Wouters8ddab272006-04-04 16:17:02 +00002168 /* completely empty module name should only happen in
2169 'from . import' (or '__import__("")')*/
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002170 Py_INCREF(mod);
2171 *p_name = NULL;
2172 return mod;
2173 }
2174
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002175 if (dot == NULL) {
2176 *p_name = NULL;
2177 len = strlen(name);
2178 }
2179 else {
2180 *p_name = dot+1;
2181 len = dot-name;
2182 }
Guido van Rossum111c20b1998-04-11 17:38:22 +00002183 if (len == 0) {
2184 PyErr_SetString(PyExc_ValueError,
2185 "Empty module name");
2186 return NULL;
2187 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002188
2189 p = buf + *p_buflen;
2190 if (p != buf)
2191 *p++ = '.';
2192 if (p+len-buf >= MAXPATHLEN) {
2193 PyErr_SetString(PyExc_ValueError,
2194 "Module name too long");
2195 return NULL;
2196 }
2197 strncpy(p, name, len);
2198 p[len] = '\0';
2199 *p_buflen = p+len-buf;
2200
2201 result = import_submodule(mod, p, buf);
2202 if (result == Py_None && altmod != mod) {
2203 Py_DECREF(result);
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00002204 /* Here, altmod must be None and mod must not be None */
Guido van Rossum0c819451997-09-07 06:16:57 +00002205 result = import_submodule(altmod, p, p);
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00002206 if (result != NULL && result != Py_None) {
2207 if (mark_miss(buf) != 0) {
2208 Py_DECREF(result);
2209 return NULL;
2210 }
2211 strncpy(buf, name, len);
2212 buf[len] = '\0';
2213 *p_buflen = len;
2214 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002215 }
2216 if (result == NULL)
2217 return NULL;
2218
2219 if (result == Py_None) {
2220 Py_DECREF(result);
2221 PyErr_Format(PyExc_ImportError,
2222 "No module named %.200s", name);
2223 return NULL;
2224 }
2225
2226 return result;
2227}
2228
2229static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002230mark_miss(char *name)
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00002231{
2232 PyObject *modules = PyImport_GetModuleDict();
2233 return PyDict_SetItemString(modules, name, Py_None);
2234}
2235
2236static int
Martin v. Löwis18e16552006-02-15 17:27:45 +00002237ensure_fromlist(PyObject *mod, PyObject *fromlist, char *buf, Py_ssize_t buflen,
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002238 int recursive)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002239{
2240 int i;
2241
2242 if (!PyObject_HasAttrString(mod, "__path__"))
2243 return 1;
2244
2245 for (i = 0; ; i++) {
2246 PyObject *item = PySequence_GetItem(fromlist, i);
2247 int hasit;
2248 if (item == NULL) {
2249 if (PyErr_ExceptionMatches(PyExc_IndexError)) {
2250 PyErr_Clear();
2251 return 1;
2252 }
2253 return 0;
2254 }
2255 if (!PyString_Check(item)) {
2256 PyErr_SetString(PyExc_TypeError,
2257 "Item in ``from list'' not a string");
2258 Py_DECREF(item);
2259 return 0;
2260 }
2261 if (PyString_AS_STRING(item)[0] == '*') {
Guido van Rossum9905ef91997-09-08 16:07:11 +00002262 PyObject *all;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002263 Py_DECREF(item);
Guido van Rossum9905ef91997-09-08 16:07:11 +00002264 /* See if the package defines __all__ */
2265 if (recursive)
2266 continue; /* Avoid endless recursion */
2267 all = PyObject_GetAttrString(mod, "__all__");
2268 if (all == NULL)
2269 PyErr_Clear();
2270 else {
Martin v. Löwis83969ee2004-03-23 16:28:13 +00002271 int ret = ensure_fromlist(mod, all, buf, buflen, 1);
Guido van Rossum9905ef91997-09-08 16:07:11 +00002272 Py_DECREF(all);
Martin v. Löwis83969ee2004-03-23 16:28:13 +00002273 if (!ret)
2274 return 0;
Guido van Rossum9905ef91997-09-08 16:07:11 +00002275 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002276 continue;
2277 }
2278 hasit = PyObject_HasAttr(mod, item);
2279 if (!hasit) {
2280 char *subname = PyString_AS_STRING(item);
2281 PyObject *submod;
2282 char *p;
2283 if (buflen + strlen(subname) >= MAXPATHLEN) {
2284 PyErr_SetString(PyExc_ValueError,
2285 "Module name too long");
2286 Py_DECREF(item);
2287 return 0;
2288 }
2289 p = buf + buflen;
2290 *p++ = '.';
2291 strcpy(p, subname);
2292 submod = import_submodule(mod, subname, buf);
2293 Py_XDECREF(submod);
2294 if (submod == NULL) {
2295 Py_DECREF(item);
2296 return 0;
2297 }
2298 }
2299 Py_DECREF(item);
2300 }
2301
Guido van Rossuma7f2e811997-10-03 15:33:32 +00002302 /* NOTREACHED */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002303}
2304
Neil Schemenauer00b09662003-06-16 21:03:07 +00002305static int
2306add_submodule(PyObject *mod, PyObject *submod, char *fullname, char *subname,
2307 PyObject *modules)
2308{
2309 if (mod == Py_None)
2310 return 1;
2311 /* Irrespective of the success of this load, make a
2312 reference to it in the parent package module. A copy gets
2313 saved in the modules dictionary under the full name, so get a
2314 reference from there, if need be. (The exception is when the
2315 load failed with a SyntaxError -- then there's no trace in
2316 sys.modules. In that case, of course, do nothing extra.) */
2317 if (submod == NULL) {
2318 submod = PyDict_GetItemString(modules, fullname);
2319 if (submod == NULL)
2320 return 1;
2321 }
2322 if (PyModule_Check(mod)) {
2323 /* We can't use setattr here since it can give a
2324 * spurious warning if the submodule name shadows a
2325 * builtin name */
2326 PyObject *dict = PyModule_GetDict(mod);
2327 if (!dict)
2328 return 0;
2329 if (PyDict_SetItemString(dict, subname, submod) < 0)
2330 return 0;
2331 }
2332 else {
2333 if (PyObject_SetAttrString(mod, subname, submod) < 0)
2334 return 0;
2335 }
2336 return 1;
2337}
2338
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002339static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002340import_submodule(PyObject *mod, char *subname, char *fullname)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002341{
Guido van Rossum25ce5661997-08-02 03:10:38 +00002342 PyObject *modules = PyImport_GetModuleDict();
Neil Schemenauer00b09662003-06-16 21:03:07 +00002343 PyObject *m = NULL;
Guido van Rossum74e6a111994-08-29 12:54:38 +00002344
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002345 /* Require:
2346 if mod == None: subname == fullname
2347 else: mod.__name__ + "." + subname == fullname
2348 */
2349
Tim Peters50d8d372001-02-28 05:34:27 +00002350 if ((m = PyDict_GetItemString(modules, fullname)) != NULL) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00002351 Py_INCREF(m);
Guido van Rossum7f9fa971995-01-20 16:53:12 +00002352 }
2353 else {
Just van Rossum52e14d62002-12-30 22:08:05 +00002354 PyObject *path, *loader = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002355 char buf[MAXPATHLEN+1];
2356 struct filedescr *fdp;
2357 FILE *fp = NULL;
2358
Guido van Rossum9c0afe51998-05-19 15:09:05 +00002359 if (mod == Py_None)
2360 path = NULL;
2361 else {
2362 path = PyObject_GetAttrString(mod, "__path__");
2363 if (path == NULL) {
2364 PyErr_Clear();
2365 Py_INCREF(Py_None);
2366 return Py_None;
2367 }
2368 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002369
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002370 buf[0] = '\0';
Just van Rossum52e14d62002-12-30 22:08:05 +00002371 fdp = find_module(fullname, subname, path, buf, MAXPATHLEN+1,
2372 &fp, &loader);
Guido van Rossumb68cd421998-07-01 17:36:26 +00002373 Py_XDECREF(path);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002374 if (fdp == NULL) {
2375 if (!PyErr_ExceptionMatches(PyExc_ImportError))
2376 return NULL;
2377 PyErr_Clear();
2378 Py_INCREF(Py_None);
2379 return Py_None;
2380 }
Just van Rossum52e14d62002-12-30 22:08:05 +00002381 m = load_module(fullname, fp, buf, fdp->type, loader);
2382 Py_XDECREF(loader);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002383 if (fp)
2384 fclose(fp);
Neil Schemenauer00b09662003-06-16 21:03:07 +00002385 if (!add_submodule(mod, m, fullname, subname, modules)) {
2386 Py_XDECREF(m);
2387 m = NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002388 }
Guido van Rossum74e6a111994-08-29 12:54:38 +00002389 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002390
2391 return m;
Guido van Rossum74e6a111994-08-29 12:54:38 +00002392}
2393
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002394
2395/* Re-import a module of any kind and return its module object, WITH
2396 INCREMENTED REFERENCE COUNT */
2397
Guido van Rossum79f25d91997-04-29 20:08:16 +00002398PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002399PyImport_ReloadModule(PyObject *m)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002400{
Guido van Rossum25ce5661997-08-02 03:10:38 +00002401 PyObject *modules = PyImport_GetModuleDict();
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00002402 PyObject *path = NULL, *loader = NULL;
Guido van Rossum222ef561997-09-06 19:41:09 +00002403 char *name, *subname;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002404 char buf[MAXPATHLEN+1];
2405 struct filedescr *fdp;
2406 FILE *fp = NULL;
Tim Peters1cd70172004-08-02 03:52:12 +00002407 PyObject *newm;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002408
Guido van Rossum79f25d91997-04-29 20:08:16 +00002409 if (m == NULL || !PyModule_Check(m)) {
2410 PyErr_SetString(PyExc_TypeError,
2411 "reload() argument must be module");
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002412 return NULL;
2413 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002414 name = PyModule_GetName(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002415 if (name == NULL)
2416 return NULL;
Guido van Rossum25ce5661997-08-02 03:10:38 +00002417 if (m != PyDict_GetItemString(modules, name)) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002418 PyErr_Format(PyExc_ImportError,
2419 "reload(): module %.200s not in sys.modules",
2420 name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002421 return NULL;
2422 }
Guido van Rossum222ef561997-09-06 19:41:09 +00002423 subname = strrchr(name, '.');
2424 if (subname == NULL)
2425 subname = name;
2426 else {
2427 PyObject *parentname, *parent;
2428 parentname = PyString_FromStringAndSize(name, (subname-name));
2429 if (parentname == NULL)
2430 return NULL;
2431 parent = PyDict_GetItem(modules, parentname);
2432 if (parent == NULL) {
2433 PyErr_Format(PyExc_ImportError,
2434 "reload(): parent %.200s not in sys.modules",
Georg Brandl0c55f292005-09-14 06:56:20 +00002435 PyString_AS_STRING(parentname));
2436 Py_DECREF(parentname);
Guido van Rossum222ef561997-09-06 19:41:09 +00002437 return NULL;
2438 }
Georg Brandl0c55f292005-09-14 06:56:20 +00002439 Py_DECREF(parentname);
Guido van Rossum222ef561997-09-06 19:41:09 +00002440 subname++;
2441 path = PyObject_GetAttrString(parent, "__path__");
2442 if (path == NULL)
2443 PyErr_Clear();
2444 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002445 buf[0] = '\0';
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00002446 fdp = find_module(name, subname, path, buf, MAXPATHLEN+1, &fp, &loader);
Guido van Rossum222ef561997-09-06 19:41:09 +00002447 Py_XDECREF(path);
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00002448
2449 if (fdp == NULL) {
2450 Py_XDECREF(loader);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002451 return NULL;
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00002452 }
2453
2454 newm = load_module(name, fp, buf, fdp->type, loader);
2455 Py_XDECREF(loader);
2456
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002457 if (fp)
2458 fclose(fp);
Tim Peters1cd70172004-08-02 03:52:12 +00002459 if (newm == NULL) {
2460 /* load_module probably removed name from modules because of
2461 * the error. Put back the original module object. We're
2462 * going to return NULL in this case regardless of whether
2463 * replacing name succeeds, so the return value is ignored.
2464 */
2465 PyDict_SetItemString(modules, name, m);
2466 }
2467 return newm;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002468}
2469
2470
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002471/* Higher-level import emulator which emulates the "import" statement
2472 more accurately -- it invokes the __import__() function from the
2473 builtins of the current globals. This means that the import is
2474 done using whatever import hooks are installed in the current
Guido van Rossum6058eb41998-12-21 19:51:00 +00002475 environment, e.g. by "rexec".
2476 A dummy list ["__doc__"] is passed as the 4th argument so that
2477 e.g. PyImport_Import(PyString_FromString("win32com.client.gencache"))
2478 will return <module "gencache"> instead of <module "win32com">. */
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002479
2480PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002481PyImport_Import(PyObject *module_name)
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002482{
2483 static PyObject *silly_list = NULL;
2484 static PyObject *builtins_str = NULL;
2485 static PyObject *import_str = NULL;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002486 PyObject *globals = NULL;
2487 PyObject *import = NULL;
2488 PyObject *builtins = NULL;
2489 PyObject *r = NULL;
2490
2491 /* Initialize constant string objects */
2492 if (silly_list == NULL) {
2493 import_str = PyString_InternFromString("__import__");
2494 if (import_str == NULL)
2495 return NULL;
2496 builtins_str = PyString_InternFromString("__builtins__");
2497 if (builtins_str == NULL)
2498 return NULL;
2499 silly_list = Py_BuildValue("[s]", "__doc__");
2500 if (silly_list == NULL)
2501 return NULL;
2502 }
2503
2504 /* Get the builtins from current globals */
2505 globals = PyEval_GetGlobals();
Guido van Rossum85cd1d62001-02-20 21:43:24 +00002506 if (globals != NULL) {
Guido van Rossum66468561998-10-22 15:46:50 +00002507 Py_INCREF(globals);
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002508 builtins = PyObject_GetItem(globals, builtins_str);
2509 if (builtins == NULL)
2510 goto err;
2511 }
2512 else {
2513 /* No globals -- use standard builtins, and fake globals */
2514 PyErr_Clear();
2515
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002516 builtins = PyImport_ImportModuleLevel("__builtin__",
2517 NULL, NULL, NULL, 0);
Guido van Rossum85cd1d62001-02-20 21:43:24 +00002518 if (builtins == NULL)
2519 return NULL;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002520 globals = Py_BuildValue("{OO}", builtins_str, builtins);
2521 if (globals == NULL)
2522 goto err;
2523 }
2524
2525 /* Get the __import__ function from the builtins */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002526 if (PyDict_Check(builtins)) {
Fred Drakea76ba6e2001-03-06 06:31:15 +00002527 import = PyObject_GetItem(builtins, import_str);
Tim Peters6d6c1a32001-08-02 04:15:00 +00002528 if (import == NULL)
2529 PyErr_SetObject(PyExc_KeyError, import_str);
2530 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002531 else
Fred Drakea76ba6e2001-03-06 06:31:15 +00002532 import = PyObject_GetAttr(builtins, import_str);
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002533 if (import == NULL)
2534 goto err;
2535
2536 /* Call the _import__ function with the proper argument list */
Georg Brandl684fd0c2006-05-25 19:15:31 +00002537 r = PyObject_CallFunctionObjArgs(import, module_name, globals,
2538 globals, silly_list, NULL);
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002539
2540 err:
2541 Py_XDECREF(globals);
2542 Py_XDECREF(builtins);
2543 Py_XDECREF(import);
Tim Peters50d8d372001-02-28 05:34:27 +00002544
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002545 return r;
2546}
2547
2548
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002549/* Module 'imp' provides Python access to the primitives used for
2550 importing modules.
2551*/
2552
Guido van Rossum79f25d91997-04-29 20:08:16 +00002553static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +00002554imp_get_magic(PyObject *self, PyObject *noargs)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002555{
2556 char buf[4];
2557
Guido van Rossum96774c12000-05-01 20:19:08 +00002558 buf[0] = (char) ((pyc_magic >> 0) & 0xff);
2559 buf[1] = (char) ((pyc_magic >> 8) & 0xff);
2560 buf[2] = (char) ((pyc_magic >> 16) & 0xff);
2561 buf[3] = (char) ((pyc_magic >> 24) & 0xff);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002562
Guido van Rossum79f25d91997-04-29 20:08:16 +00002563 return PyString_FromStringAndSize(buf, 4);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002564}
2565
Guido van Rossum79f25d91997-04-29 20:08:16 +00002566static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +00002567imp_get_suffixes(PyObject *self, PyObject *noargs)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002568{
Guido van Rossum79f25d91997-04-29 20:08:16 +00002569 PyObject *list;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002570 struct filedescr *fdp;
2571
Guido van Rossum79f25d91997-04-29 20:08:16 +00002572 list = PyList_New(0);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002573 if (list == NULL)
2574 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002575 for (fdp = _PyImport_Filetab; fdp->suffix != NULL; fdp++) {
2576 PyObject *item = Py_BuildValue("ssi",
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002577 fdp->suffix, fdp->mode, fdp->type);
2578 if (item == NULL) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00002579 Py_DECREF(list);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002580 return NULL;
2581 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002582 if (PyList_Append(list, item) < 0) {
2583 Py_DECREF(list);
2584 Py_DECREF(item);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002585 return NULL;
2586 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002587 Py_DECREF(item);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002588 }
2589 return list;
2590}
2591
Guido van Rossum79f25d91997-04-29 20:08:16 +00002592static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002593call_find_module(char *name, PyObject *path)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002594{
Tim Petersdbd9ba62000-07-09 03:09:57 +00002595 extern int fclose(FILE *);
Guido van Rossum79f25d91997-04-29 20:08:16 +00002596 PyObject *fob, *ret;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002597 struct filedescr *fdp;
2598 char pathname[MAXPATHLEN+1];
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002599 FILE *fp = NULL;
2600
2601 pathname[0] = '\0';
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002602 if (path == Py_None)
2603 path = NULL;
Just van Rossum52e14d62002-12-30 22:08:05 +00002604 fdp = find_module(NULL, name, path, pathname, MAXPATHLEN+1, &fp, NULL);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002605 if (fdp == NULL)
2606 return NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002607 if (fp != NULL) {
2608 fob = PyFile_FromFile(fp, pathname, fdp->mode, fclose);
2609 if (fob == NULL) {
2610 fclose(fp);
2611 return NULL;
2612 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002613 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002614 else {
2615 fob = Py_None;
2616 Py_INCREF(fob);
Tim Peters50d8d372001-02-28 05:34:27 +00002617 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002618 ret = Py_BuildValue("Os(ssi)",
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002619 fob, pathname, fdp->suffix, fdp->mode, fdp->type);
Guido van Rossum79f25d91997-04-29 20:08:16 +00002620 Py_DECREF(fob);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002621 return ret;
2622}
2623
Guido van Rossum79f25d91997-04-29 20:08:16 +00002624static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002625imp_find_module(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002626{
2627 char *name;
2628 PyObject *path = NULL;
Guido van Rossum43713e52000-02-29 13:59:29 +00002629 if (!PyArg_ParseTuple(args, "s|O:find_module", &name, &path))
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002630 return NULL;
2631 return call_find_module(name, path);
2632}
2633
2634static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002635imp_init_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002636{
2637 char *name;
2638 int ret;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002639 PyObject *m;
Guido van Rossum43713e52000-02-29 13:59:29 +00002640 if (!PyArg_ParseTuple(args, "s:init_builtin", &name))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002641 return NULL;
2642 ret = init_builtin(name);
2643 if (ret < 0)
2644 return NULL;
2645 if (ret == 0) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00002646 Py_INCREF(Py_None);
2647 return Py_None;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002648 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002649 m = PyImport_AddModule(name);
2650 Py_XINCREF(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002651 return m;
2652}
2653
Guido van Rossum79f25d91997-04-29 20:08:16 +00002654static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002655imp_init_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002656{
2657 char *name;
2658 int ret;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002659 PyObject *m;
Guido van Rossum43713e52000-02-29 13:59:29 +00002660 if (!PyArg_ParseTuple(args, "s:init_frozen", &name))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002661 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002662 ret = PyImport_ImportFrozenModule(name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002663 if (ret < 0)
2664 return NULL;
2665 if (ret == 0) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00002666 Py_INCREF(Py_None);
2667 return Py_None;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002668 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002669 m = PyImport_AddModule(name);
2670 Py_XINCREF(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002671 return m;
2672}
2673
Guido van Rossum79f25d91997-04-29 20:08:16 +00002674static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002675imp_get_frozen_object(PyObject *self, PyObject *args)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002676{
2677 char *name;
Jack Jansen95ffa231995-10-03 14:38:41 +00002678
Guido van Rossum43713e52000-02-29 13:59:29 +00002679 if (!PyArg_ParseTuple(args, "s:get_frozen_object", &name))
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002680 return NULL;
2681 return get_frozen_object(name);
2682}
2683
Guido van Rossum79f25d91997-04-29 20:08:16 +00002684static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002685imp_is_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002686{
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002687 char *name;
Guido van Rossum43713e52000-02-29 13:59:29 +00002688 if (!PyArg_ParseTuple(args, "s:is_builtin", &name))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002689 return NULL;
Guido van Rossum50ee94f2002-04-09 18:00:58 +00002690 return PyInt_FromLong(is_builtin(name));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002691}
2692
Guido van Rossum79f25d91997-04-29 20:08:16 +00002693static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002694imp_is_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002695{
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002696 char *name;
Guido van Rossum323bf5e1998-06-24 03:54:06 +00002697 struct _frozen *p;
Guido van Rossum43713e52000-02-29 13:59:29 +00002698 if (!PyArg_ParseTuple(args, "s:is_frozen", &name))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002699 return NULL;
Guido van Rossum323bf5e1998-06-24 03:54:06 +00002700 p = find_frozen(name);
Guido van Rossumb8bff3f2002-04-07 06:34:38 +00002701 return PyBool_FromLong((long) (p == NULL ? 0 : p->size));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002702}
2703
2704static FILE *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002705get_file(char *pathname, PyObject *fob, char *mode)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002706{
2707 FILE *fp;
2708 if (fob == NULL) {
Tim Peters86c7d2f2004-08-01 23:24:21 +00002709 if (mode[0] == 'U')
Jeremy Hylton4ae6fae2002-05-30 17:15:25 +00002710 mode = "r" PY_STDIOTEXTMODE;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002711 fp = fopen(pathname, mode);
2712 if (fp == NULL)
Guido van Rossum79f25d91997-04-29 20:08:16 +00002713 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002714 }
2715 else {
Guido van Rossum79f25d91997-04-29 20:08:16 +00002716 fp = PyFile_AsFile(fob);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002717 if (fp == NULL)
Guido van Rossum79f25d91997-04-29 20:08:16 +00002718 PyErr_SetString(PyExc_ValueError,
2719 "bad/closed file object");
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002720 }
2721 return fp;
2722}
2723
Guido van Rossum79f25d91997-04-29 20:08:16 +00002724static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002725imp_load_compiled(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002726{
2727 char *name;
2728 char *pathname;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002729 PyObject *fob = NULL;
2730 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002731 FILE *fp;
Guido van Rossum43713e52000-02-29 13:59:29 +00002732 if (!PyArg_ParseTuple(args, "ss|O!:load_compiled", &name, &pathname,
Guido van Rossum79f25d91997-04-29 20:08:16 +00002733 &PyFile_Type, &fob))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002734 return NULL;
2735 fp = get_file(pathname, fob, "rb");
2736 if (fp == NULL)
2737 return NULL;
2738 m = load_compiled_module(name, pathname, fp);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002739 if (fob == NULL)
2740 fclose(fp);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002741 return m;
2742}
2743
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002744#ifdef HAVE_DYNAMIC_LOADING
2745
Guido van Rossum79f25d91997-04-29 20:08:16 +00002746static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002747imp_load_dynamic(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002748{
2749 char *name;
2750 char *pathname;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002751 PyObject *fob = NULL;
2752 PyObject *m;
Guido van Rossum7faeab31995-07-07 22:50:36 +00002753 FILE *fp = NULL;
Guido van Rossum43713e52000-02-29 13:59:29 +00002754 if (!PyArg_ParseTuple(args, "ss|O!:load_dynamic", &name, &pathname,
Guido van Rossum79f25d91997-04-29 20:08:16 +00002755 &PyFile_Type, &fob))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002756 return NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002757 if (fob) {
Guido van Rossum7faeab31995-07-07 22:50:36 +00002758 fp = get_file(pathname, fob, "r");
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002759 if (fp == NULL)
2760 return NULL;
2761 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002762 m = _PyImport_LoadDynamicModule(name, pathname, fp);
Guido van Rossum7faeab31995-07-07 22:50:36 +00002763 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002764}
2765
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002766#endif /* HAVE_DYNAMIC_LOADING */
2767
Guido van Rossum79f25d91997-04-29 20:08:16 +00002768static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002769imp_load_source(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002770{
2771 char *name;
2772 char *pathname;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002773 PyObject *fob = NULL;
2774 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002775 FILE *fp;
Guido van Rossum43713e52000-02-29 13:59:29 +00002776 if (!PyArg_ParseTuple(args, "ss|O!:load_source", &name, &pathname,
Guido van Rossum79f25d91997-04-29 20:08:16 +00002777 &PyFile_Type, &fob))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002778 return NULL;
2779 fp = get_file(pathname, fob, "r");
2780 if (fp == NULL)
2781 return NULL;
2782 m = load_source_module(name, pathname, fp);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002783 if (fob == NULL)
2784 fclose(fp);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002785 return m;
2786}
2787
Guido van Rossum79f25d91997-04-29 20:08:16 +00002788static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002789imp_load_module(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002790{
2791 char *name;
2792 PyObject *fob;
2793 char *pathname;
2794 char *suffix; /* Unused */
2795 char *mode;
2796 int type;
2797 FILE *fp;
2798
Guido van Rossum43713e52000-02-29 13:59:29 +00002799 if (!PyArg_ParseTuple(args, "sOs(ssi):load_module",
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002800 &name, &fob, &pathname,
2801 &suffix, &mode, &type))
2802 return NULL;
Guido van Rossum5e2c5fa2002-05-30 17:33:07 +00002803 if (*mode) {
2804 /* Mode must start with 'r' or 'U' and must not contain '+'.
2805 Implicit in this test is the assumption that the mode
2806 may contain other modifiers like 'b' or 't'. */
2807
2808 if (!(*mode == 'r' || *mode == 'U') || strchr(mode, '+')) {
Jeremy Hylton4ae6fae2002-05-30 17:15:25 +00002809 PyErr_Format(PyExc_ValueError,
2810 "invalid file open mode %.200s", mode);
2811 return NULL;
Guido van Rossum5e2c5fa2002-05-30 17:33:07 +00002812 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002813 }
2814 if (fob == Py_None)
2815 fp = NULL;
2816 else {
2817 if (!PyFile_Check(fob)) {
2818 PyErr_SetString(PyExc_ValueError,
2819 "load_module arg#2 should be a file or None");
2820 return NULL;
2821 }
2822 fp = get_file(pathname, fob, mode);
2823 if (fp == NULL)
2824 return NULL;
2825 }
Just van Rossum52e14d62002-12-30 22:08:05 +00002826 return load_module(name, fp, pathname, type, NULL);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002827}
2828
2829static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002830imp_load_package(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002831{
2832 char *name;
2833 char *pathname;
Guido van Rossum43713e52000-02-29 13:59:29 +00002834 if (!PyArg_ParseTuple(args, "ss:load_package", &name, &pathname))
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002835 return NULL;
2836 return load_package(name, pathname);
2837}
2838
2839static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002840imp_new_module(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002841{
2842 char *name;
Guido van Rossum43713e52000-02-29 13:59:29 +00002843 if (!PyArg_ParseTuple(args, "s:new_module", &name))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002844 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002845 return PyModule_New(name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002846}
2847
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002848/* Doc strings */
2849
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002850PyDoc_STRVAR(doc_imp,
2851"This module provides the components needed to build your own\n\
2852__import__ function. Undocumented functions are obsolete.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002853
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002854PyDoc_STRVAR(doc_find_module,
2855"find_module(name, [path]) -> (file, filename, (suffix, mode, type))\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002856Search for a module. If path is omitted or None, search for a\n\
2857built-in, frozen or special module and continue search in sys.path.\n\
2858The module name cannot contain '.'; to search for a submodule of a\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002859package, pass the submodule name and the package's __path__.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002860
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002861PyDoc_STRVAR(doc_load_module,
2862"load_module(name, file, filename, (suffix, mode, type)) -> module\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002863Load a module, given information returned by find_module().\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002864The module name must include the full package name, if any.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002865
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002866PyDoc_STRVAR(doc_get_magic,
2867"get_magic() -> string\n\
2868Return the magic number for .pyc or .pyo files.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002869
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002870PyDoc_STRVAR(doc_get_suffixes,
2871"get_suffixes() -> [(suffix, mode, type), ...]\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002872Return a list of (suffix, mode, type) tuples describing the files\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002873that find_module() looks for.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002874
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002875PyDoc_STRVAR(doc_new_module,
2876"new_module(name) -> module\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002877Create a new module. Do not enter it in sys.modules.\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002878The module name must include the full package name, if any.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002879
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002880PyDoc_STRVAR(doc_lock_held,
Tim Petersa7c65092004-08-01 23:26:05 +00002881"lock_held() -> boolean\n\
2882Return True if the import lock is currently held, else False.\n\
2883On platforms without threads, return False.");
Tim Peters69232342001-08-30 05:16:13 +00002884
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00002885PyDoc_STRVAR(doc_acquire_lock,
2886"acquire_lock() -> None\n\
Neal Norwitz2294c0d2003-02-12 23:02:21 +00002887Acquires the interpreter's import lock for the current thread.\n\
2888This lock should be used by import hooks to ensure thread-safety\n\
2889when importing modules.\n\
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00002890On platforms without threads, this function does nothing.");
2891
2892PyDoc_STRVAR(doc_release_lock,
2893"release_lock() -> None\n\
2894Release the interpreter's import lock.\n\
2895On platforms without threads, this function does nothing.");
2896
Guido van Rossum79f25d91997-04-29 20:08:16 +00002897static PyMethodDef imp_methods[] = {
Neal Norwitz08ea61a2003-02-17 18:18:00 +00002898 {"find_module", imp_find_module, METH_VARARGS, doc_find_module},
2899 {"get_magic", imp_get_magic, METH_NOARGS, doc_get_magic},
2900 {"get_suffixes", imp_get_suffixes, METH_NOARGS, doc_get_suffixes},
2901 {"load_module", imp_load_module, METH_VARARGS, doc_load_module},
2902 {"new_module", imp_new_module, METH_VARARGS, doc_new_module},
2903 {"lock_held", imp_lock_held, METH_NOARGS, doc_lock_held},
2904 {"acquire_lock", imp_acquire_lock, METH_NOARGS, doc_acquire_lock},
2905 {"release_lock", imp_release_lock, METH_NOARGS, doc_release_lock},
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002906 /* The rest are obsolete */
Neal Norwitz031829d2002-03-31 14:37:44 +00002907 {"get_frozen_object", imp_get_frozen_object, METH_VARARGS},
2908 {"init_builtin", imp_init_builtin, METH_VARARGS},
2909 {"init_frozen", imp_init_frozen, METH_VARARGS},
2910 {"is_builtin", imp_is_builtin, METH_VARARGS},
2911 {"is_frozen", imp_is_frozen, METH_VARARGS},
2912 {"load_compiled", imp_load_compiled, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002913#ifdef HAVE_DYNAMIC_LOADING
Neal Norwitz031829d2002-03-31 14:37:44 +00002914 {"load_dynamic", imp_load_dynamic, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002915#endif
Neal Norwitz031829d2002-03-31 14:37:44 +00002916 {"load_package", imp_load_package, METH_VARARGS},
Neal Norwitz031829d2002-03-31 14:37:44 +00002917 {"load_source", imp_load_source, METH_VARARGS},
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002918 {NULL, NULL} /* sentinel */
2919};
2920
Guido van Rossum1a8791e1998-08-04 22:46:29 +00002921static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002922setint(PyObject *d, char *name, int value)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002923{
2924 PyObject *v;
2925 int err;
2926
2927 v = PyInt_FromLong((long)value);
2928 err = PyDict_SetItemString(d, name, v);
2929 Py_XDECREF(v);
2930 return err;
2931}
2932
Jason Tishler6bc06ec2003-09-04 11:59:50 +00002933PyMODINIT_FUNC
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002934initimp(void)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002935{
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002936 PyObject *m, *d;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002937
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002938 m = Py_InitModule4("imp", imp_methods, doc_imp,
2939 NULL, PYTHON_API_VERSION);
Neal Norwitz1ac754f2006-01-19 06:09:39 +00002940 if (m == NULL)
2941 goto failure;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002942 d = PyModule_GetDict(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002943
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002944 if (setint(d, "SEARCH_ERROR", SEARCH_ERROR) < 0) goto failure;
2945 if (setint(d, "PY_SOURCE", PY_SOURCE) < 0) goto failure;
2946 if (setint(d, "PY_COMPILED", PY_COMPILED) < 0) goto failure;
2947 if (setint(d, "C_EXTENSION", C_EXTENSION) < 0) goto failure;
2948 if (setint(d, "PY_RESOURCE", PY_RESOURCE) < 0) goto failure;
2949 if (setint(d, "PKG_DIRECTORY", PKG_DIRECTORY) < 0) goto failure;
2950 if (setint(d, "C_BUILTIN", C_BUILTIN) < 0) goto failure;
2951 if (setint(d, "PY_FROZEN", PY_FROZEN) < 0) goto failure;
Guido van Rossum0f84a341998-08-06 13:36:01 +00002952 if (setint(d, "PY_CODERESOURCE", PY_CODERESOURCE) < 0) goto failure;
Just van Rossum52e14d62002-12-30 22:08:05 +00002953 if (setint(d, "IMP_HOOK", IMP_HOOK) < 0) goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002954
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002955 failure:
2956 ;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002957}
Guido van Rossum09cae1f1998-05-14 02:32:54 +00002958
2959
Guido van Rossumb18618d2000-05-03 23:44:39 +00002960/* API for embedding applications that want to add their own entries
2961 to the table of built-in modules. This should normally be called
2962 *before* Py_Initialize(). When the table resize fails, -1 is
2963 returned and the existing table is unchanged.
Guido van Rossum09cae1f1998-05-14 02:32:54 +00002964
2965 After a similar function by Just van Rossum. */
2966
2967int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002968PyImport_ExtendInittab(struct _inittab *newtab)
Guido van Rossum09cae1f1998-05-14 02:32:54 +00002969{
2970 static struct _inittab *our_copy = NULL;
2971 struct _inittab *p;
2972 int i, n;
2973
2974 /* Count the number of entries in both tables */
2975 for (n = 0; newtab[n].name != NULL; n++)
2976 ;
2977 if (n == 0)
2978 return 0; /* Nothing to do */
2979 for (i = 0; PyImport_Inittab[i].name != NULL; i++)
2980 ;
2981
2982 /* Allocate new memory for the combined table */
Guido van Rossumb18618d2000-05-03 23:44:39 +00002983 p = our_copy;
2984 PyMem_RESIZE(p, struct _inittab, i+n+1);
Guido van Rossum09cae1f1998-05-14 02:32:54 +00002985 if (p == NULL)
2986 return -1;
2987
2988 /* Copy the tables into the new memory */
2989 if (our_copy != PyImport_Inittab)
2990 memcpy(p, PyImport_Inittab, (i+1) * sizeof(struct _inittab));
2991 PyImport_Inittab = our_copy = p;
2992 memcpy(p+i, newtab, (n+1) * sizeof(struct _inittab));
2993
2994 return 0;
2995}
2996
2997/* Shorthand to add a single entry given a name and a function */
2998
2999int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003000PyImport_AppendInittab(char *name, void (*initfunc)(void))
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003001{
3002 struct _inittab newtab[2];
3003
3004 memset(newtab, '\0', sizeof newtab);
3005
3006 newtab[0].name = name;
3007 newtab[0].initfunc = initfunc;
3008
3009 return PyImport_ExtendInittab(newtab);
3010}
Anthony Baxterac6bd462006-04-13 02:06:09 +00003011
3012#ifdef __cplusplus
3013}
3014#endif