blob: b65ed0e86afac150956a7d952c1e0d555ecba686 [file] [log] [blame]
Guido van Rossumf70e43a1991-02-19 12:39:46 +00001
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002/* Module definition and import implementation */
3
Guido van Rossum79f25d91997-04-29 20:08:16 +00004#include "Python.h"
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00005
Jeremy Hylton3e0055f2005-10-20 19:59:25 +00006#include "Python-ast.h"
Kristján Valur Jónsson67387fb2007-04-25 00:17:39 +00007#undef Yield /* undefine macro conflicting with winbase.h */
Neal Norwitzadb69fc2005-12-17 20:54:49 +00008#include "pyarena.h"
Jeremy Hylton3e0055f2005-10-20 19:59:25 +00009#include "pythonrun.h"
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000010#include "errcode.h"
Guido van Rossumc405b7b1991-06-04 19:39:42 +000011#include "marshal.h"
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000012#include "code.h"
Guido van Rossumc405b7b1991-06-04 19:39:42 +000013#include "compile.h"
Guido van Rossumff4949e1992-08-05 19:58:53 +000014#include "eval.h"
Guido van Rossumd8bac6d1992-02-26 15:19:13 +000015#include "osdefs.h"
Guido van Rossum1ae940a1995-01-02 19:04:15 +000016#include "importdl.h"
Guido van Rossumc405b7b1991-06-04 19:39:42 +000017
Guido van Rossum55a83382000-09-20 20:31:38 +000018#ifdef HAVE_FCNTL_H
19#include <fcntl.h>
20#endif
Anthony Baxterac6bd462006-04-13 02:06:09 +000021#ifdef __cplusplus
22extern "C" {
23#endif
Guido van Rossum55a83382000-09-20 20:31:38 +000024
Christian Heimes5e8e6d22008-02-23 23:59:45 +000025#ifdef MS_WINDOWS
26/* for stat.st_mode */
27typedef unsigned short mode_t;
28#endif
29
Thomas Woutersf70ef4f2000-07-22 18:47:25 +000030extern time_t PyOS_GetLastModificationTime(char *, FILE *);
31 /* In getmtime.c */
Guido van Rossum21d335e1993-10-15 13:01:11 +000032
Jeremy Hyltond4ceb312004-04-01 02:45:22 +000033/* Magic word to reject .pyc files generated by other Python versions.
34 It should change for each incompatible change to the bytecode.
35
36 The value of CR and LF is incorporated so if you ever read or write
Guido van Rossum7faeab31995-07-07 22:50:36 +000037 a .pyc file in text mode the magic number will be wrong; also, the
Tim Peters36515e22001-11-18 04:06:29 +000038 Apple MPW compiler swaps their values, botching string constants.
Marc-André Lemburgbd3be8f2002-02-07 11:33:49 +000039
Martin v. Löwisef82d2f2004-06-27 16:51:46 +000040 The magic numbers must be spaced apart atleast 2 values, as the
41 -U interpeter flag will cause MAGIC+1 being used. They have been
42 odd numbers for some time now.
Marc-André Lemburgbd3be8f2002-02-07 11:33:49 +000043
Jeremy Hyltond4ceb312004-04-01 02:45:22 +000044 There were a variety of old schemes for setting the magic number.
45 The current working scheme is to increment the previous value by
46 10.
Guido van Rossumf6894922002-08-31 15:16:14 +000047
Marc-André Lemburgbd3be8f2002-02-07 11:33:49 +000048 Known values:
49 Python 1.5: 20121
50 Python 1.5.1: 20121
51 Python 1.5.2: 20121
Skip Montanaro4ec3c262006-03-25 14:12:03 +000052 Python 1.6: 50428
Marc-André Lemburgbd3be8f2002-02-07 11:33:49 +000053 Python 2.0: 50823
54 Python 2.0.1: 50823
55 Python 2.1: 60202
56 Python 2.1.1: 60202
57 Python 2.1.2: 60202
58 Python 2.2: 60717
Neal Norwitz7fdcb412002-06-14 01:07:39 +000059 Python 2.3a0: 62011
Michael W. Hudsondd32a912002-08-15 14:59:02 +000060 Python 2.3a0: 62021
Guido van Rossumf6894922002-08-31 15:16:14 +000061 Python 2.3a0: 62011 (!)
Martin v. Löwisef82d2f2004-06-27 16:51:46 +000062 Python 2.4a0: 62041
Raymond Hettingerfd2d1f72004-08-23 23:37:48 +000063 Python 2.4a3: 62051
Raymond Hettinger2c31a052004-09-22 18:44:21 +000064 Python 2.4b1: 62061
Michael W. Hudsondf888462005-06-03 14:41:55 +000065 Python 2.5a0: 62071
Michael W. Hudsonaee2e282005-10-21 11:32:20 +000066 Python 2.5a0: 62081 (ast-branch)
Guido van Rossumc2e20742006-02-27 22:32:47 +000067 Python 2.5a0: 62091 (with)
Guido van Rossumf6694362006-03-10 02:28:35 +000068 Python 2.5a0: 62092 (changed WITH_CLEANUP opcode)
Neal Norwitz0d62a062006-07-30 06:53:31 +000069 Python 2.5b3: 62101 (fix wrong code: for x, in ...)
70 Python 2.5b3: 62111 (fix wrong code: x += yield)
Neal Norwitz9a70f952006-08-04 05:12:19 +000071 Python 2.5c1: 62121 (fix wrong lnotab with for loops and
72 storing constants that should have been removed)
Neal Norwitzdac090d2006-09-05 03:53:08 +000073 Python 2.5c2: 62131 (fix wrong code: for x, in ... in listcomp/genexp)
Raymond Hettingereffde122007-12-18 18:26:18 +000074 Python 2.6a0: 62151 (peephole optimizations and STORE_MAP opcode)
Nick Coghlan7af53be2008-03-07 14:13:28 +000075 Python 2.6a1: 62161 (WITH_CLEANUP optimization)
Michael W. Hudsonaee2e282005-10-21 11:32:20 +000076.
Tim Peters36515e22001-11-18 04:06:29 +000077*/
Nick Coghlan7af53be2008-03-07 14:13:28 +000078#define MAGIC (62161 | ((long)'\r'<<16) | ((long)'\n'<<24))
Guido van Rossum3ddee711991-12-16 13:06:34 +000079
Guido van Rossum96774c12000-05-01 20:19:08 +000080/* Magic word as global; note that _PyImport_Init() can change the
Jeremy Hylton9262b8a2000-06-30 04:59:17 +000081 value of this global to accommodate for alterations of how the
Guido van Rossum96774c12000-05-01 20:19:08 +000082 compiler works which are enabled by command line switches. */
Christian Heimes61e45902008-03-27 10:35:52 +000083static long pyc_magic = MAGIC;
Guido van Rossum96774c12000-05-01 20:19:08 +000084
Guido van Rossum25ce5661997-08-02 03:10:38 +000085/* See _PyImport_FixupExtension() below */
86static PyObject *extensions = NULL;
Guido van Rossum3f5da241990-12-20 15:06:42 +000087
Guido van Rossum771c6c81997-10-31 18:37:24 +000088/* This table is defined in config.c: */
89extern struct _inittab _PyImport_Inittab[];
90
91struct _inittab *PyImport_Inittab = _PyImport_Inittab;
Guido van Rossum66f1fa81991-04-03 19:03:52 +000092
Guido van Rossumed1170e1999-12-20 21:23:41 +000093/* these tables define the module suffixes that Python recognizes */
94struct filedescr * _PyImport_Filetab = NULL;
Guido van Rossum48a680c2001-03-02 06:34:14 +000095
96#ifdef RISCOS
97static const struct filedescr _PyImport_StandardFiletab[] = {
Jack Jansenc88da1f2002-05-28 10:58:19 +000098 {"/py", "U", PY_SOURCE},
Guido van Rossum48a680c2001-03-02 06:34:14 +000099 {"/pyc", "rb", PY_COMPILED},
100 {0, 0}
101};
102#else
Guido van Rossumed1170e1999-12-20 21:23:41 +0000103static const struct filedescr _PyImport_StandardFiletab[] = {
Jack Jansenc88da1f2002-05-28 10:58:19 +0000104 {".py", "U", PY_SOURCE},
Martin v. Löwis6238d2b2002-06-30 15:26:10 +0000105#ifdef MS_WINDOWS
Jack Jansenc88da1f2002-05-28 10:58:19 +0000106 {".pyw", "U", PY_SOURCE},
Tim Peters36515e22001-11-18 04:06:29 +0000107#endif
Guido van Rossumed1170e1999-12-20 21:23:41 +0000108 {".pyc", "rb", PY_COMPILED},
109 {0, 0}
110};
Guido van Rossum48a680c2001-03-02 06:34:14 +0000111#endif
Guido van Rossumed1170e1999-12-20 21:23:41 +0000112
Phillip J. Ebyf7575d02006-07-28 21:12:07 +0000113
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000114/* Initialize things */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000115
116void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000117_PyImport_Init(void)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000118{
Guido van Rossumed1170e1999-12-20 21:23:41 +0000119 const struct filedescr *scan;
120 struct filedescr *filetab;
121 int countD = 0;
122 int countS = 0;
123
124 /* prepare _PyImport_Filetab: copy entries from
125 _PyImport_DynLoadFiletab and _PyImport_StandardFiletab.
126 */
Georg Brandladd36e52007-08-23 18:08:06 +0000127#ifdef HAVE_DYNAMIC_LOADING
Guido van Rossumed1170e1999-12-20 21:23:41 +0000128 for (scan = _PyImport_DynLoadFiletab; scan->suffix != NULL; ++scan)
129 ++countD;
Georg Brandladd36e52007-08-23 18:08:06 +0000130#endif
Guido van Rossumed1170e1999-12-20 21:23:41 +0000131 for (scan = _PyImport_StandardFiletab; scan->suffix != NULL; ++scan)
132 ++countS;
Guido van Rossumb18618d2000-05-03 23:44:39 +0000133 filetab = PyMem_NEW(struct filedescr, countD + countS + 1);
Neal Norwitze1fdb322006-07-21 05:32:28 +0000134 if (filetab == NULL)
Neal Norwitz33722ae2006-07-21 07:59:02 +0000135 Py_FatalError("Can't initialize import file table.");
Georg Brandladd36e52007-08-23 18:08:06 +0000136#ifdef HAVE_DYNAMIC_LOADING
Guido van Rossumed1170e1999-12-20 21:23:41 +0000137 memcpy(filetab, _PyImport_DynLoadFiletab,
138 countD * sizeof(struct filedescr));
Georg Brandladd36e52007-08-23 18:08:06 +0000139#endif
Guido van Rossumed1170e1999-12-20 21:23:41 +0000140 memcpy(filetab + countD, _PyImport_StandardFiletab,
141 countS * sizeof(struct filedescr));
142 filetab[countD + countS].suffix = NULL;
143
144 _PyImport_Filetab = filetab;
145
Guido van Rossum0824f631997-03-11 18:37:35 +0000146 if (Py_OptimizeFlag) {
Guido van Rossumed1170e1999-12-20 21:23:41 +0000147 /* Replace ".pyc" with ".pyo" in _PyImport_Filetab */
148 for (; filetab->suffix != NULL; filetab++) {
Guido van Rossum48a680c2001-03-02 06:34:14 +0000149#ifndef RISCOS
Guido van Rossumed1170e1999-12-20 21:23:41 +0000150 if (strcmp(filetab->suffix, ".pyc") == 0)
151 filetab->suffix = ".pyo";
Guido van Rossum48a680c2001-03-02 06:34:14 +0000152#else
153 if (strcmp(filetab->suffix, "/pyc") == 0)
154 filetab->suffix = "/pyo";
155#endif
Guido van Rossum0824f631997-03-11 18:37:35 +0000156 }
157 }
Guido van Rossum96774c12000-05-01 20:19:08 +0000158
159 if (Py_UnicodeFlag) {
160 /* Fix the pyc_magic so that byte compiled code created
161 using the all-Unicode method doesn't interfere with
162 code created in normal operation mode. */
163 pyc_magic = MAGIC + 1;
164 }
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000165}
166
Guido van Rossum25ce5661997-08-02 03:10:38 +0000167void
Just van Rossum52e14d62002-12-30 22:08:05 +0000168_PyImportHooks_Init(void)
169{
170 PyObject *v, *path_hooks = NULL, *zimpimport;
171 int err = 0;
172
173 /* adding sys.path_hooks and sys.path_importer_cache, setting up
174 zipimport */
Nick Coghlan327a39b2007-11-18 11:56:28 +0000175 if (PyType_Ready(&PyNullImporter_Type) < 0)
Phillip J. Ebyf7575d02006-07-28 21:12:07 +0000176 goto error;
Just van Rossum52e14d62002-12-30 22:08:05 +0000177
178 if (Py_VerboseFlag)
179 PySys_WriteStderr("# installing zipimport hook\n");
180
181 v = PyList_New(0);
182 if (v == NULL)
183 goto error;
184 err = PySys_SetObject("meta_path", v);
185 Py_DECREF(v);
186 if (err)
187 goto error;
188 v = PyDict_New();
189 if (v == NULL)
190 goto error;
191 err = PySys_SetObject("path_importer_cache", v);
192 Py_DECREF(v);
193 if (err)
194 goto error;
195 path_hooks = PyList_New(0);
196 if (path_hooks == NULL)
197 goto error;
198 err = PySys_SetObject("path_hooks", path_hooks);
199 if (err) {
200 error:
201 PyErr_Print();
Phillip J. Ebyf7575d02006-07-28 21:12:07 +0000202 Py_FatalError("initializing sys.meta_path, sys.path_hooks, "
203 "path_importer_cache, or NullImporter failed"
204 );
Just van Rossum52e14d62002-12-30 22:08:05 +0000205 }
Phillip J. Ebyf7575d02006-07-28 21:12:07 +0000206
Just van Rossum52e14d62002-12-30 22:08:05 +0000207 zimpimport = PyImport_ImportModule("zipimport");
208 if (zimpimport == NULL) {
209 PyErr_Clear(); /* No zip import module -- okay */
210 if (Py_VerboseFlag)
211 PySys_WriteStderr("# can't import zipimport\n");
212 }
213 else {
214 PyObject *zipimporter = PyObject_GetAttrString(zimpimport,
215 "zipimporter");
216 Py_DECREF(zimpimport);
217 if (zipimporter == NULL) {
218 PyErr_Clear(); /* No zipimporter object -- okay */
219 if (Py_VerboseFlag)
220 PySys_WriteStderr(
Fred Drake1e5fc552003-07-11 15:01:02 +0000221 "# can't import zipimport.zipimporter\n");
Just van Rossum52e14d62002-12-30 22:08:05 +0000222 }
223 else {
224 /* sys.path_hooks.append(zipimporter) */
225 err = PyList_Append(path_hooks, zipimporter);
226 Py_DECREF(zipimporter);
227 if (err)
228 goto error;
229 if (Py_VerboseFlag)
230 PySys_WriteStderr(
231 "# installed zipimport hook\n");
232 }
233 }
234 Py_DECREF(path_hooks);
235}
236
237void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000238_PyImport_Fini(void)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000239{
240 Py_XDECREF(extensions);
241 extensions = NULL;
Barry Warsaw84294482000-10-03 16:02:05 +0000242 PyMem_DEL(_PyImport_Filetab);
243 _PyImport_Filetab = NULL;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000244}
245
246
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000247/* Locking primitives to prevent parallel imports of the same module
248 in different threads to return with a partially loaded module.
249 These calls are serialized by the global interpreter lock. */
250
251#ifdef WITH_THREAD
252
Guido van Rossum49b56061998-10-01 20:42:43 +0000253#include "pythread.h"
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000254
Guido van Rossum65d5b571998-12-21 19:32:43 +0000255static PyThread_type_lock import_lock = 0;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000256static long import_lock_thread = -1;
257static int import_lock_level = 0;
258
259static void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000260lock_import(void)
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000261{
Guido van Rossum65d5b571998-12-21 19:32:43 +0000262 long me = PyThread_get_thread_ident();
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000263 if (me == -1)
264 return; /* Too bad */
Neal Norwitze1fdb322006-07-21 05:32:28 +0000265 if (import_lock == NULL) {
Guido van Rossum65d5b571998-12-21 19:32:43 +0000266 import_lock = PyThread_allocate_lock();
Neal Norwitze1fdb322006-07-21 05:32:28 +0000267 if (import_lock == NULL)
268 return; /* Nothing much we can do. */
269 }
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000270 if (import_lock_thread == me) {
271 import_lock_level++;
272 return;
273 }
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000274 if (import_lock_thread != -1 || !PyThread_acquire_lock(import_lock, 0))
275 {
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000276 PyThreadState *tstate = PyEval_SaveThread();
Guido van Rossum65d5b571998-12-21 19:32:43 +0000277 PyThread_acquire_lock(import_lock, 1);
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000278 PyEval_RestoreThread(tstate);
279 }
280 import_lock_thread = me;
281 import_lock_level = 1;
282}
283
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000284static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000285unlock_import(void)
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000286{
Guido van Rossum65d5b571998-12-21 19:32:43 +0000287 long me = PyThread_get_thread_ident();
Neal Norwitze1fdb322006-07-21 05:32:28 +0000288 if (me == -1 || import_lock == NULL)
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000289 return 0; /* Too bad */
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000290 if (import_lock_thread != me)
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000291 return -1;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000292 import_lock_level--;
293 if (import_lock_level == 0) {
294 import_lock_thread = -1;
Guido van Rossum65d5b571998-12-21 19:32:43 +0000295 PyThread_release_lock(import_lock);
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000296 }
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000297 return 1;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000298}
299
Guido van Rossum8ee3e5a2005-09-14 18:09:42 +0000300/* This function is called from PyOS_AfterFork to ensure that newly
301 created child processes do not share locks with the parent. */
302
303void
304_PyImport_ReInitLock(void)
305{
306#ifdef _AIX
307 if (import_lock != NULL)
308 import_lock = PyThread_allocate_lock();
309#endif
310}
311
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000312#else
313
314#define lock_import()
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000315#define unlock_import() 0
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000316
317#endif
318
Tim Peters69232342001-08-30 05:16:13 +0000319static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000320imp_lock_held(PyObject *self, PyObject *noargs)
Tim Peters69232342001-08-30 05:16:13 +0000321{
Tim Peters69232342001-08-30 05:16:13 +0000322#ifdef WITH_THREAD
Guido van Rossumb8bff3f2002-04-07 06:34:38 +0000323 return PyBool_FromLong(import_lock_thread != -1);
Tim Peters69232342001-08-30 05:16:13 +0000324#else
Guido van Rossumb8bff3f2002-04-07 06:34:38 +0000325 return PyBool_FromLong(0);
Tim Peters69232342001-08-30 05:16:13 +0000326#endif
327}
328
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000329static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000330imp_acquire_lock(PyObject *self, PyObject *noargs)
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000331{
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000332#ifdef WITH_THREAD
333 lock_import();
334#endif
Neal Norwitz2294c0d2003-02-12 23:02:21 +0000335 Py_INCREF(Py_None);
336 return Py_None;
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000337}
338
339static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000340imp_release_lock(PyObject *self, PyObject *noargs)
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000341{
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000342#ifdef WITH_THREAD
343 if (unlock_import() < 0) {
344 PyErr_SetString(PyExc_RuntimeError,
345 "not holding the import lock");
346 return NULL;
347 }
348#endif
Neal Norwitz2294c0d2003-02-12 23:02:21 +0000349 Py_INCREF(Py_None);
350 return Py_None;
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000351}
352
Collin Winter276887b2007-03-12 16:11:39 +0000353static void
Neal Norwitz75c7c802007-03-13 05:31:38 +0000354imp_modules_reloading_clear(void)
Collin Winter276887b2007-03-12 16:11:39 +0000355{
356 PyInterpreterState *interp = PyThreadState_Get()->interp;
Neal Norwitz75c7c802007-03-13 05:31:38 +0000357 if (interp->modules_reloading != NULL)
358 PyDict_Clear(interp->modules_reloading);
Collin Winter276887b2007-03-12 16:11:39 +0000359}
360
Guido van Rossum25ce5661997-08-02 03:10:38 +0000361/* Helper for sys */
362
363PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000364PyImport_GetModuleDict(void)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000365{
Nicholas Bastine5662ae2004-03-24 22:22:12 +0000366 PyInterpreterState *interp = PyThreadState_GET()->interp;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000367 if (interp->modules == NULL)
368 Py_FatalError("PyImport_GetModuleDict: no module dictionary!");
369 return interp->modules;
370}
371
Guido van Rossum3f5da241990-12-20 15:06:42 +0000372
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000373/* List of names to clear in sys */
374static char* sys_deletes[] = {
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000375 "path", "argv", "ps1", "ps2", "exitfunc",
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000376 "exc_type", "exc_value", "exc_traceback",
377 "last_type", "last_value", "last_traceback",
Just van Rossum52e14d62002-12-30 22:08:05 +0000378 "path_hooks", "path_importer_cache", "meta_path",
Christian Heimes0d924432008-01-30 17:21:22 +0000379 /* misc stuff */
380 "flags", "float_info",
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000381 NULL
382};
383
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000384static char* sys_files[] = {
385 "stdin", "__stdin__",
386 "stdout", "__stdout__",
387 "stderr", "__stderr__",
388 NULL
389};
390
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000391
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000392/* Un-initialize things, as good as we can */
Guido van Rossum3f5da241990-12-20 15:06:42 +0000393
Guido van Rossum3f5da241990-12-20 15:06:42 +0000394void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000395PyImport_Cleanup(void)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000396{
Martin v. Löwis18e16552006-02-15 17:27:45 +0000397 Py_ssize_t pos, ndone;
Guido van Rossum758eec01998-01-19 21:58:26 +0000398 char *name;
399 PyObject *key, *value, *dict;
Nicholas Bastine5662ae2004-03-24 22:22:12 +0000400 PyInterpreterState *interp = PyThreadState_GET()->interp;
Guido van Rossum758eec01998-01-19 21:58:26 +0000401 PyObject *modules = interp->modules;
402
403 if (modules == NULL)
404 return; /* Already done */
405
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000406 /* Delete some special variables first. These are common
407 places where user values hide and people complain when their
408 destructors fail. Since the modules containing them are
409 deleted *last* of all, they would come too late in the normal
410 destruction order. Sigh. */
411
412 value = PyDict_GetItemString(modules, "__builtin__");
413 if (value != NULL && PyModule_Check(value)) {
414 dict = PyModule_GetDict(value);
415 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000416 PySys_WriteStderr("# clear __builtin__._\n");
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000417 PyDict_SetItemString(dict, "_", Py_None);
418 }
419 value = PyDict_GetItemString(modules, "sys");
420 if (value != NULL && PyModule_Check(value)) {
421 char **p;
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000422 PyObject *v;
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000423 dict = PyModule_GetDict(value);
424 for (p = sys_deletes; *p != NULL; p++) {
425 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000426 PySys_WriteStderr("# clear sys.%s\n", *p);
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000427 PyDict_SetItemString(dict, *p, Py_None);
428 }
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000429 for (p = sys_files; *p != NULL; p+=2) {
430 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000431 PySys_WriteStderr("# restore sys.%s\n", *p);
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000432 v = PyDict_GetItemString(dict, *(p+1));
433 if (v == NULL)
434 v = Py_None;
435 PyDict_SetItemString(dict, *p, v);
436 }
437 }
438
439 /* First, delete __main__ */
440 value = PyDict_GetItemString(modules, "__main__");
441 if (value != NULL && PyModule_Check(value)) {
442 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000443 PySys_WriteStderr("# cleanup __main__\n");
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000444 _PyModule_Clear(value);
445 PyDict_SetItemString(modules, "__main__", Py_None);
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000446 }
447
Guido van Rossum758eec01998-01-19 21:58:26 +0000448 /* The special treatment of __builtin__ here is because even
449 when it's not referenced as a module, its dictionary is
450 referenced by almost every module's __builtins__. Since
451 deleting a module clears its dictionary (even if there are
452 references left to it), we need to delete the __builtin__
453 module last. Likewise, we don't delete sys until the very
454 end because it is implicitly referenced (e.g. by print).
455
456 Also note that we 'delete' modules by replacing their entry
457 in the modules dict with None, rather than really deleting
458 them; this avoids a rehash of the modules dictionary and
459 also marks them as "non existent" so they won't be
460 re-imported. */
461
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000462 /* Next, repeatedly delete modules with a reference count of
Guido van Rossum758eec01998-01-19 21:58:26 +0000463 one (skipping __builtin__ and sys) and delete them */
464 do {
465 ndone = 0;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000466 pos = 0;
Guido van Rossum758eec01998-01-19 21:58:26 +0000467 while (PyDict_Next(modules, &pos, &key, &value)) {
468 if (value->ob_refcnt != 1)
469 continue;
Guido van Rossum566373e1998-10-01 15:24:50 +0000470 if (PyString_Check(key) && PyModule_Check(value)) {
471 name = PyString_AS_STRING(key);
Guido van Rossum758eec01998-01-19 21:58:26 +0000472 if (strcmp(name, "__builtin__") == 0)
473 continue;
474 if (strcmp(name, "sys") == 0)
475 continue;
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000476 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000477 PySys_WriteStderr(
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000478 "# cleanup[1] %s\n", name);
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000479 _PyModule_Clear(value);
Guido van Rossum758eec01998-01-19 21:58:26 +0000480 PyDict_SetItem(modules, key, Py_None);
481 ndone++;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000482 }
483 }
Guido van Rossum758eec01998-01-19 21:58:26 +0000484 } while (ndone > 0);
485
Guido van Rossum758eec01998-01-19 21:58:26 +0000486 /* Next, delete all modules (still skipping __builtin__ and sys) */
487 pos = 0;
488 while (PyDict_Next(modules, &pos, &key, &value)) {
Guido van Rossum566373e1998-10-01 15:24:50 +0000489 if (PyString_Check(key) && PyModule_Check(value)) {
490 name = PyString_AS_STRING(key);
Guido van Rossum758eec01998-01-19 21:58:26 +0000491 if (strcmp(name, "__builtin__") == 0)
492 continue;
493 if (strcmp(name, "sys") == 0)
494 continue;
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000495 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000496 PySys_WriteStderr("# cleanup[2] %s\n", name);
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000497 _PyModule_Clear(value);
Guido van Rossum758eec01998-01-19 21:58:26 +0000498 PyDict_SetItem(modules, key, Py_None);
499 }
500 }
501
502 /* Next, delete sys and __builtin__ (in that order) */
503 value = PyDict_GetItemString(modules, "sys");
504 if (value != NULL && PyModule_Check(value)) {
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000505 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000506 PySys_WriteStderr("# cleanup sys\n");
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000507 _PyModule_Clear(value);
Guido van Rossum758eec01998-01-19 21:58:26 +0000508 PyDict_SetItemString(modules, "sys", Py_None);
509 }
510 value = PyDict_GetItemString(modules, "__builtin__");
511 if (value != NULL && PyModule_Check(value)) {
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000512 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000513 PySys_WriteStderr("# cleanup __builtin__\n");
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000514 _PyModule_Clear(value);
Guido van Rossum758eec01998-01-19 21:58:26 +0000515 PyDict_SetItemString(modules, "__builtin__", Py_None);
516 }
517
518 /* Finally, clear and delete the modules directory */
519 PyDict_Clear(modules);
520 interp->modules = NULL;
521 Py_DECREF(modules);
Collin Winter276887b2007-03-12 16:11:39 +0000522 Py_CLEAR(interp->modules_reloading);
Guido van Rossum8d15b5d1990-10-26 14:58:58 +0000523}
Guido van Rossum7f133ed1991-02-19 12:23:57 +0000524
525
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000526/* Helper for pythonrun.c -- return magic number */
527
528long
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000529PyImport_GetMagicNumber(void)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000530{
Guido van Rossum96774c12000-05-01 20:19:08 +0000531 return pyc_magic;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000532}
533
534
Guido van Rossum25ce5661997-08-02 03:10:38 +0000535/* Magic for extension modules (built-in as well as dynamically
536 loaded). To prevent initializing an extension module more than
537 once, we keep a static dictionary 'extensions' keyed by module name
538 (for built-in modules) or by filename (for dynamically loaded
Barry Warsaw92883382001-08-13 23:05:44 +0000539 modules), containing these modules. A copy of the module's
Guido van Rossum25ce5661997-08-02 03:10:38 +0000540 dictionary is stored by calling _PyImport_FixupExtension()
541 immediately after the module initialization function succeeds. A
542 copy can be retrieved from there by calling
543 _PyImport_FindExtension(). */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000544
Guido van Rossum79f25d91997-04-29 20:08:16 +0000545PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000546_PyImport_FixupExtension(char *name, char *filename)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000547{
Guido van Rossum25ce5661997-08-02 03:10:38 +0000548 PyObject *modules, *mod, *dict, *copy;
549 if (extensions == NULL) {
550 extensions = PyDict_New();
551 if (extensions == NULL)
552 return NULL;
553 }
554 modules = PyImport_GetModuleDict();
555 mod = PyDict_GetItemString(modules, name);
556 if (mod == NULL || !PyModule_Check(mod)) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000557 PyErr_Format(PyExc_SystemError,
558 "_PyImport_FixupExtension: module %.200s not loaded", name);
Guido van Rossum25ce5661997-08-02 03:10:38 +0000559 return NULL;
560 }
561 dict = PyModule_GetDict(mod);
562 if (dict == NULL)
563 return NULL;
Fred Drake9cd0efc2001-10-25 21:38:59 +0000564 copy = PyDict_Copy(dict);
Guido van Rossum25ce5661997-08-02 03:10:38 +0000565 if (copy == NULL)
566 return NULL;
567 PyDict_SetItemString(extensions, filename, copy);
568 Py_DECREF(copy);
569 return copy;
570}
571
572PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000573_PyImport_FindExtension(char *name, char *filename)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000574{
Fred Drake9cd0efc2001-10-25 21:38:59 +0000575 PyObject *dict, *mod, *mdict;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000576 if (extensions == NULL)
577 return NULL;
578 dict = PyDict_GetItemString(extensions, filename);
579 if (dict == NULL)
580 return NULL;
581 mod = PyImport_AddModule(name);
582 if (mod == NULL)
583 return NULL;
584 mdict = PyModule_GetDict(mod);
585 if (mdict == NULL)
586 return NULL;
Fred Drake9cd0efc2001-10-25 21:38:59 +0000587 if (PyDict_Update(mdict, dict))
Guido van Rossum25ce5661997-08-02 03:10:38 +0000588 return NULL;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000589 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000590 PySys_WriteStderr("import %s # previously loaded (%s)\n",
Guido van Rossum25ce5661997-08-02 03:10:38 +0000591 name, filename);
592 return mod;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000593}
594
595
596/* Get the module object corresponding to a module name.
597 First check the modules dictionary if there's one there,
Walter Dörwaldf0dfc7a2003-10-20 14:01:56 +0000598 if not, create a new one and insert it in the modules dictionary.
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000599 Because the former action is most common, THIS DOES NOT RETURN A
600 'NEW' REFERENCE! */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000601
Guido van Rossum79f25d91997-04-29 20:08:16 +0000602PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000603PyImport_AddModule(const char *name)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000604{
Guido van Rossum25ce5661997-08-02 03:10:38 +0000605 PyObject *modules = PyImport_GetModuleDict();
Guido van Rossum79f25d91997-04-29 20:08:16 +0000606 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000607
Guido van Rossum25ce5661997-08-02 03:10:38 +0000608 if ((m = PyDict_GetItemString(modules, name)) != NULL &&
Guido van Rossum79f25d91997-04-29 20:08:16 +0000609 PyModule_Check(m))
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000610 return m;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000611 m = PyModule_New(name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000612 if (m == NULL)
613 return NULL;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000614 if (PyDict_SetItemString(modules, name, m) != 0) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000615 Py_DECREF(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000616 return NULL;
617 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000618 Py_DECREF(m); /* Yes, it still exists, in modules! */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000619
620 return m;
621}
622
Tim Peters1cd70172004-08-02 03:52:12 +0000623/* Remove name from sys.modules, if it's there. */
624static void
625_RemoveModule(const char *name)
626{
627 PyObject *modules = PyImport_GetModuleDict();
628 if (PyDict_GetItemString(modules, name) == NULL)
629 return;
630 if (PyDict_DelItemString(modules, name) < 0)
631 Py_FatalError("import: deleting existing key in"
632 "sys.modules failed");
633}
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000634
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000635/* Execute a code object in a module and return the module object
Tim Peters1cd70172004-08-02 03:52:12 +0000636 * WITH INCREMENTED REFERENCE COUNT. If an error occurs, name is
637 * removed from sys.modules, to avoid leaving damaged module objects
638 * in sys.modules. The caller may wish to restore the original
639 * module object (if any) in this case; PyImport_ReloadModule is an
640 * example.
641 */
Guido van Rossum79f25d91997-04-29 20:08:16 +0000642PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000643PyImport_ExecCodeModule(char *name, PyObject *co)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000644{
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000645 return PyImport_ExecCodeModuleEx(name, co, (char *)NULL);
646}
647
648PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000649PyImport_ExecCodeModuleEx(char *name, PyObject *co, char *pathname)
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000650{
Guido van Rossum25ce5661997-08-02 03:10:38 +0000651 PyObject *modules = PyImport_GetModuleDict();
Guido van Rossum79f25d91997-04-29 20:08:16 +0000652 PyObject *m, *d, *v;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000653
Guido van Rossum79f25d91997-04-29 20:08:16 +0000654 m = PyImport_AddModule(name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000655 if (m == NULL)
656 return NULL;
Jeremy Hyltonecd91292004-01-02 23:25:32 +0000657 /* If the module is being reloaded, we get the old module back
658 and re-use its dict to exec the new code. */
Guido van Rossum79f25d91997-04-29 20:08:16 +0000659 d = PyModule_GetDict(m);
660 if (PyDict_GetItemString(d, "__builtins__") == NULL) {
661 if (PyDict_SetItemString(d, "__builtins__",
662 PyEval_GetBuiltins()) != 0)
Tim Peters1cd70172004-08-02 03:52:12 +0000663 goto error;
Guido van Rossum6135a871995-01-09 17:53:26 +0000664 }
Guido van Rossum9c9a07c1996-05-16 20:43:40 +0000665 /* Remember the filename as the __file__ attribute */
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000666 v = NULL;
667 if (pathname != NULL) {
668 v = PyString_FromString(pathname);
669 if (v == NULL)
670 PyErr_Clear();
671 }
672 if (v == NULL) {
673 v = ((PyCodeObject *)co)->co_filename;
674 Py_INCREF(v);
675 }
676 if (PyDict_SetItemString(d, "__file__", v) != 0)
Guido van Rossum79f25d91997-04-29 20:08:16 +0000677 PyErr_Clear(); /* Not important enough to report */
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000678 Py_DECREF(v);
679
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000680 v = PyEval_EvalCode((PyCodeObject *)co, d, d);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000681 if (v == NULL)
Tim Peters1cd70172004-08-02 03:52:12 +0000682 goto error;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000683 Py_DECREF(v);
Guido van Rossumb65e85c1997-07-10 18:00:45 +0000684
Guido van Rossum25ce5661997-08-02 03:10:38 +0000685 if ((m = PyDict_GetItemString(modules, name)) == NULL) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000686 PyErr_Format(PyExc_ImportError,
687 "Loaded module %.200s not found in sys.modules",
688 name);
Guido van Rossumb65e85c1997-07-10 18:00:45 +0000689 return NULL;
690 }
691
Guido van Rossum79f25d91997-04-29 20:08:16 +0000692 Py_INCREF(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000693
694 return m;
Tim Peters1cd70172004-08-02 03:52:12 +0000695
696 error:
697 _RemoveModule(name);
698 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000699}
700
701
702/* Given a pathname for a Python source file, fill a buffer with the
703 pathname for the corresponding compiled file. Return the pathname
704 for the compiled file, or NULL if there's no space in the buffer.
705 Doesn't set an exception. */
706
707static char *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000708make_compiled_pathname(char *pathname, char *buf, size_t buflen)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000709{
Tim Petersc1731372001-08-04 08:12:36 +0000710 size_t len = strlen(pathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000711 if (len+2 > buflen)
712 return NULL;
Tim Petersc1731372001-08-04 08:12:36 +0000713
Martin v. Löwis6238d2b2002-06-30 15:26:10 +0000714#ifdef MS_WINDOWS
Tim Petersc1731372001-08-04 08:12:36 +0000715 /* Treat .pyw as if it were .py. The case of ".pyw" must match
716 that used in _PyImport_StandardFiletab. */
717 if (len >= 4 && strcmp(&pathname[len-4], ".pyw") == 0)
718 --len; /* pretend 'w' isn't there */
719#endif
720 memcpy(buf, pathname, len);
721 buf[len] = Py_OptimizeFlag ? 'o' : 'c';
722 buf[len+1] = '\0';
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000723
724 return buf;
725}
726
727
728/* Given a pathname for a Python source file, its time of last
729 modification, and a pathname for a compiled file, check whether the
730 compiled file represents the same version of the source. If so,
731 return a FILE pointer for the compiled file, positioned just after
732 the header; if not, return NULL.
733 Doesn't set an exception. */
734
735static FILE *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000736check_compiled_module(char *pathname, time_t mtime, char *cpathname)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000737{
738 FILE *fp;
739 long magic;
740 long pyc_mtime;
741
742 fp = fopen(cpathname, "rb");
743 if (fp == NULL)
744 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000745 magic = PyMarshal_ReadLongFromFile(fp);
Guido van Rossum96774c12000-05-01 20:19:08 +0000746 if (magic != pyc_magic) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000747 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000748 PySys_WriteStderr("# %s has bad magic\n", cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000749 fclose(fp);
750 return NULL;
751 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000752 pyc_mtime = PyMarshal_ReadLongFromFile(fp);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000753 if (pyc_mtime != mtime) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000754 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000755 PySys_WriteStderr("# %s has bad mtime\n", cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000756 fclose(fp);
757 return NULL;
758 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000759 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000760 PySys_WriteStderr("# %s matches %s\n", cpathname, pathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000761 return fp;
762}
763
764
765/* Read a code object from a file and check it for validity */
766
Guido van Rossum79f25d91997-04-29 20:08:16 +0000767static PyCodeObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000768read_compiled_module(char *cpathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000769{
Guido van Rossum79f25d91997-04-29 20:08:16 +0000770 PyObject *co;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000771
Tim Petersd9b9ac82001-01-28 00:27:39 +0000772 co = PyMarshal_ReadLastObjectFromFile(fp);
Armin Rigo01ab2792004-03-26 15:09:27 +0000773 if (co == NULL)
774 return NULL;
775 if (!PyCode_Check(co)) {
776 PyErr_Format(PyExc_ImportError,
777 "Non-code object in %.200s", cpathname);
778 Py_DECREF(co);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000779 return NULL;
780 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000781 return (PyCodeObject *)co;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000782}
783
784
785/* Load a module from a compiled file, execute it, and return its
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000786 module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000787
Guido van Rossum79f25d91997-04-29 20:08:16 +0000788static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000789load_compiled_module(char *name, char *cpathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000790{
791 long magic;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000792 PyCodeObject *co;
793 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000794
Guido van Rossum79f25d91997-04-29 20:08:16 +0000795 magic = PyMarshal_ReadLongFromFile(fp);
Guido van Rossum96774c12000-05-01 20:19:08 +0000796 if (magic != pyc_magic) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000797 PyErr_Format(PyExc_ImportError,
798 "Bad magic number in %.200s", cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000799 return NULL;
800 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000801 (void) PyMarshal_ReadLongFromFile(fp);
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000802 co = read_compiled_module(cpathname, fp);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000803 if (co == NULL)
804 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000805 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000806 PySys_WriteStderr("import %s # precompiled from %s\n",
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000807 name, cpathname);
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000808 m = PyImport_ExecCodeModuleEx(name, (PyObject *)co, cpathname);
Guido van Rossum79f25d91997-04-29 20:08:16 +0000809 Py_DECREF(co);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000810
811 return m;
812}
813
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000814/* Parse a source file and return the corresponding code object */
815
Guido van Rossum79f25d91997-04-29 20:08:16 +0000816static PyCodeObject *
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000817parse_source_module(const char *pathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000818{
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000819 PyCodeObject *co = NULL;
820 mod_ty mod;
Christian Heimes3c608332008-03-26 22:01:37 +0000821 PyCompilerFlags flags;
Neal Norwitz2a399b02006-09-11 04:28:16 +0000822 PyArena *arena = PyArena_New();
823 if (arena == NULL)
824 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000825
Christian Heimes7f23d862008-03-26 22:51:58 +0000826 flags.cf_flags = 0;
827
Christian Heimes3c608332008-03-26 22:01:37 +0000828 mod = PyParser_ASTFromFile(fp, pathname, Py_file_input, 0, 0, &flags,
Neal Norwitzadb69fc2005-12-17 20:54:49 +0000829 NULL, arena);
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000830 if (mod) {
Neal Norwitzadb69fc2005-12-17 20:54:49 +0000831 co = PyAST_Compile(mod, pathname, NULL, arena);
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000832 }
Neal Norwitz2a399b02006-09-11 04:28:16 +0000833 PyArena_Free(arena);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000834 return co;
835}
836
837
Guido van Rossum55a83382000-09-20 20:31:38 +0000838/* Helper to open a bytecode file for writing in exclusive mode */
839
840static FILE *
Christian Heimes40346852008-02-23 17:52:07 +0000841open_exclusive(char *filename, mode_t mode)
Guido van Rossum55a83382000-09-20 20:31:38 +0000842{
843#if defined(O_EXCL)&&defined(O_CREAT)&&defined(O_WRONLY)&&defined(O_TRUNC)
844 /* Use O_EXCL to avoid a race condition when another process tries to
845 write the same file. When that happens, our open() call fails,
846 which is just fine (since it's only a cache).
847 XXX If the file exists and is writable but the directory is not
848 writable, the file will never be written. Oh well.
849 */
850 int fd;
851 (void) unlink(filename);
Tim Peters42c83af2000-09-29 04:03:10 +0000852 fd = open(filename, O_EXCL|O_CREAT|O_WRONLY|O_TRUNC
853#ifdef O_BINARY
854 |O_BINARY /* necessary for Windows */
855#endif
Martin v. Löwis79acb9e2002-12-06 12:48:53 +0000856#ifdef __VMS
Christian Heimes40346852008-02-23 17:52:07 +0000857 , mode, "ctxt=bin", "shr=nil"
Martin v. Löwis79acb9e2002-12-06 12:48:53 +0000858#else
Christian Heimes40346852008-02-23 17:52:07 +0000859 , mode
Martin v. Löwis79acb9e2002-12-06 12:48:53 +0000860#endif
Martin v. Löwis18e16552006-02-15 17:27:45 +0000861 );
Guido van Rossum55a83382000-09-20 20:31:38 +0000862 if (fd < 0)
863 return NULL;
864 return fdopen(fd, "wb");
865#else
866 /* Best we can do -- on Windows this can't happen anyway */
867 return fopen(filename, "wb");
868#endif
869}
870
871
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000872/* Write a compiled module to a file, placing the time of last
873 modification of its source into the header.
874 Errors are ignored, if a write error occurs an attempt is made to
875 remove the file. */
876
877static void
Christian Heimes40346852008-02-23 17:52:07 +0000878write_compiled_module(PyCodeObject *co, char *cpathname, struct stat *srcstat)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000879{
880 FILE *fp;
Christian Heimes40346852008-02-23 17:52:07 +0000881 time_t mtime = srcstat->st_mtime;
882 mode_t mode = srcstat->st_mode;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000883
Christian Heimes40346852008-02-23 17:52:07 +0000884 fp = open_exclusive(cpathname, mode);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000885 if (fp == NULL) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000886 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000887 PySys_WriteStderr(
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000888 "# can't create %s\n", cpathname);
889 return;
890 }
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000891 PyMarshal_WriteLongToFile(pyc_magic, fp, Py_MARSHAL_VERSION);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000892 /* First write a 0 for mtime */
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000893 PyMarshal_WriteLongToFile(0L, fp, Py_MARSHAL_VERSION);
894 PyMarshal_WriteObjectToFile((PyObject *)co, fp, Py_MARSHAL_VERSION);
Armin Rigo01ab2792004-03-26 15:09:27 +0000895 if (fflush(fp) != 0 || ferror(fp)) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000896 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000897 PySys_WriteStderr("# can't write %s\n", cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000898 /* Don't keep partial file */
899 fclose(fp);
900 (void) unlink(cpathname);
901 return;
902 }
903 /* Now write the true mtime */
904 fseek(fp, 4L, 0);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000905 assert(mtime < LONG_MAX);
Martin v. Löwis725507b2006-03-07 12:08:51 +0000906 PyMarshal_WriteLongToFile((long)mtime, fp, Py_MARSHAL_VERSION);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000907 fflush(fp);
908 fclose(fp);
Guido van Rossum79f25d91997-04-29 20:08:16 +0000909 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000910 PySys_WriteStderr("# wrote %s\n", cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000911}
912
913
914/* Load a source module from a given file and return its module
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000915 object WITH INCREMENTED REFERENCE COUNT. If there's a matching
916 byte-compiled file, use that instead. */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000917
Guido van Rossum79f25d91997-04-29 20:08:16 +0000918static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000919load_source_module(char *name, char *pathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000920{
Christian Heimes40346852008-02-23 17:52:07 +0000921 struct stat st;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000922 FILE *fpc;
923 char buf[MAXPATHLEN+1];
924 char *cpathname;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000925 PyCodeObject *co;
926 PyObject *m;
Christian Heimes40346852008-02-23 17:52:07 +0000927
928 if (fstat(fileno(fp), &st) != 0) {
Neal Norwitz708e51a2005-10-03 04:48:15 +0000929 PyErr_Format(PyExc_RuntimeError,
Christian Heimes40346852008-02-23 17:52:07 +0000930 "unable to get file status from '%s'",
Neal Norwitz708e51a2005-10-03 04:48:15 +0000931 pathname);
Fred Drake4c82b232000-06-30 16:18:57 +0000932 return NULL;
Neal Norwitz708e51a2005-10-03 04:48:15 +0000933 }
Fred Drake4c82b232000-06-30 16:18:57 +0000934#if SIZEOF_TIME_T > 4
935 /* Python's .pyc timestamp handling presumes that the timestamp fits
936 in 4 bytes. This will be fine until sometime in the year 2038,
937 when a 4-byte signed time_t will overflow.
938 */
Christian Heimes40346852008-02-23 17:52:07 +0000939 if (st.st_mtime >> 32) {
Fred Drake4c82b232000-06-30 16:18:57 +0000940 PyErr_SetString(PyExc_OverflowError,
Fred Drakec63d3e92001-03-01 06:33:32 +0000941 "modification time overflows a 4 byte field");
Fred Drake4c82b232000-06-30 16:18:57 +0000942 return NULL;
943 }
944#endif
Tim Peters36515e22001-11-18 04:06:29 +0000945 cpathname = make_compiled_pathname(pathname, buf,
Jeremy Hylton37832f02001-04-13 17:50:20 +0000946 (size_t)MAXPATHLEN + 1);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000947 if (cpathname != NULL &&
Christian Heimes40346852008-02-23 17:52:07 +0000948 (fpc = check_compiled_module(pathname, st.st_mtime, cpathname))) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000949 co = read_compiled_module(cpathname, fpc);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000950 fclose(fpc);
951 if (co == NULL)
952 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000953 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000954 PySys_WriteStderr("import %s # precompiled from %s\n",
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000955 name, cpathname);
Guido van Rossumafd3dae1998-08-25 18:44:34 +0000956 pathname = cpathname;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000957 }
958 else {
959 co = parse_source_module(pathname, fp);
960 if (co == NULL)
961 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000962 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000963 PySys_WriteStderr("import %s # from %s\n",
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000964 name, pathname);
Georg Brandl2da0fce2008-01-07 17:09:35 +0000965 if (cpathname) {
966 PyObject *ro = PySys_GetObject("dont_write_bytecode");
967 if (ro == NULL || !PyObject_IsTrue(ro))
Christian Heimes40346852008-02-23 17:52:07 +0000968 write_compiled_module(co, cpathname, &st);
Georg Brandl2da0fce2008-01-07 17:09:35 +0000969 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000970 }
Guido van Rossumafd3dae1998-08-25 18:44:34 +0000971 m = PyImport_ExecCodeModuleEx(name, (PyObject *)co, pathname);
Guido van Rossum79f25d91997-04-29 20:08:16 +0000972 Py_DECREF(co);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000973
974 return m;
975}
976
977
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000978/* Forward */
Just van Rossum52e14d62002-12-30 22:08:05 +0000979static PyObject *load_module(char *, FILE *, char *, int, PyObject *);
980static struct filedescr *find_module(char *, char *, PyObject *,
981 char *, size_t, FILE **, PyObject **);
Tim Petersdbd9ba62000-07-09 03:09:57 +0000982static struct _frozen *find_frozen(char *name);
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000983
984/* Load a package and return its module object WITH INCREMENTED
985 REFERENCE COUNT */
986
987static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000988load_package(char *name, char *pathname)
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000989{
Tim Peters1cd70172004-08-02 03:52:12 +0000990 PyObject *m, *d;
991 PyObject *file = NULL;
992 PyObject *path = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000993 int err;
994 char buf[MAXPATHLEN+1];
995 FILE *fp = NULL;
996 struct filedescr *fdp;
997
998 m = PyImport_AddModule(name);
999 if (m == NULL)
1000 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00001001 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +00001002 PySys_WriteStderr("import %s # directory %s\n",
Guido van Rossum17fc85f1997-09-06 18:52:03 +00001003 name, pathname);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001004 d = PyModule_GetDict(m);
1005 file = PyString_FromString(pathname);
1006 if (file == NULL)
Tim Peters1cd70172004-08-02 03:52:12 +00001007 goto error;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001008 path = Py_BuildValue("[O]", file);
Tim Peters1cd70172004-08-02 03:52:12 +00001009 if (path == NULL)
1010 goto error;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001011 err = PyDict_SetItemString(d, "__file__", file);
1012 if (err == 0)
1013 err = PyDict_SetItemString(d, "__path__", path);
Tim Peters1cd70172004-08-02 03:52:12 +00001014 if (err != 0)
1015 goto error;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001016 buf[0] = '\0';
Just van Rossum52e14d62002-12-30 22:08:05 +00001017 fdp = find_module(name, "__init__", path, buf, sizeof(buf), &fp, NULL);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001018 if (fdp == NULL) {
1019 if (PyErr_ExceptionMatches(PyExc_ImportError)) {
1020 PyErr_Clear();
Thomas Heller25653242004-06-07 15:04:10 +00001021 Py_INCREF(m);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001022 }
1023 else
1024 m = NULL;
1025 goto cleanup;
1026 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001027 m = load_module(name, fp, buf, fdp->type, NULL);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001028 if (fp != NULL)
1029 fclose(fp);
Tim Peters1cd70172004-08-02 03:52:12 +00001030 goto cleanup;
1031
1032 error:
1033 m = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001034 cleanup:
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001035 Py_XDECREF(path);
1036 Py_XDECREF(file);
1037 return m;
1038}
1039
1040
1041/* Helper to test for built-in module */
1042
1043static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001044is_builtin(char *name)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001045{
1046 int i;
Guido van Rossum771c6c81997-10-31 18:37:24 +00001047 for (i = 0; PyImport_Inittab[i].name != NULL; i++) {
1048 if (strcmp(name, PyImport_Inittab[i].name) == 0) {
1049 if (PyImport_Inittab[i].initfunc == NULL)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001050 return -1;
1051 else
1052 return 1;
1053 }
1054 }
1055 return 0;
1056}
1057
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001058
Just van Rossum52e14d62002-12-30 22:08:05 +00001059/* Return an importer object for a sys.path/pkg.__path__ item 'p',
1060 possibly by fetching it from the path_importer_cache dict. If it
Brett Cannon94b69f62006-09-28 22:10:14 +00001061 wasn't yet cached, traverse path_hooks until a hook is found
Just van Rossum52e14d62002-12-30 22:08:05 +00001062 that can handle the path item. Return None if no hook could;
1063 this tells our caller it should fall back to the builtin
1064 import mechanism. Cache the result in path_importer_cache.
1065 Returns a borrowed reference. */
1066
1067static PyObject *
1068get_path_importer(PyObject *path_importer_cache, PyObject *path_hooks,
1069 PyObject *p)
1070{
1071 PyObject *importer;
Martin v. Löwis725507b2006-03-07 12:08:51 +00001072 Py_ssize_t j, nhooks;
Just van Rossum52e14d62002-12-30 22:08:05 +00001073
1074 /* These conditions are the caller's responsibility: */
1075 assert(PyList_Check(path_hooks));
1076 assert(PyDict_Check(path_importer_cache));
1077
1078 nhooks = PyList_Size(path_hooks);
1079 if (nhooks < 0)
1080 return NULL; /* Shouldn't happen */
1081
1082 importer = PyDict_GetItem(path_importer_cache, p);
1083 if (importer != NULL)
1084 return importer;
1085
1086 /* set path_importer_cache[p] to None to avoid recursion */
1087 if (PyDict_SetItem(path_importer_cache, p, Py_None) != 0)
1088 return NULL;
1089
1090 for (j = 0; j < nhooks; j++) {
1091 PyObject *hook = PyList_GetItem(path_hooks, j);
1092 if (hook == NULL)
1093 return NULL;
Georg Brandl684fd0c2006-05-25 19:15:31 +00001094 importer = PyObject_CallFunctionObjArgs(hook, p, NULL);
Just van Rossum52e14d62002-12-30 22:08:05 +00001095 if (importer != NULL)
1096 break;
1097
1098 if (!PyErr_ExceptionMatches(PyExc_ImportError)) {
1099 return NULL;
1100 }
1101 PyErr_Clear();
1102 }
Phillip J. Ebyf7575d02006-07-28 21:12:07 +00001103 if (importer == NULL) {
1104 importer = PyObject_CallFunctionObjArgs(
Nick Coghlan327a39b2007-11-18 11:56:28 +00001105 (PyObject *)&PyNullImporter_Type, p, NULL
Phillip J. Ebyf7575d02006-07-28 21:12:07 +00001106 );
1107 if (importer == NULL) {
1108 if (PyErr_ExceptionMatches(PyExc_ImportError)) {
1109 PyErr_Clear();
1110 return Py_None;
1111 }
1112 }
1113 }
1114 if (importer != NULL) {
Just van Rossum52e14d62002-12-30 22:08:05 +00001115 int err = PyDict_SetItem(path_importer_cache, p, importer);
1116 Py_DECREF(importer);
1117 if (err != 0)
1118 return NULL;
1119 }
1120 return importer;
1121}
1122
Nick Coghlan327a39b2007-11-18 11:56:28 +00001123PyAPI_FUNC(PyObject *)
1124PyImport_GetImporter(PyObject *path) {
1125 PyObject *importer=NULL, *path_importer_cache=NULL, *path_hooks=NULL;
1126
1127 if ((path_importer_cache = PySys_GetObject("path_importer_cache"))) {
1128 if ((path_hooks = PySys_GetObject("path_hooks"))) {
1129 importer = get_path_importer(path_importer_cache,
1130 path_hooks, path);
1131 }
1132 }
1133 Py_XINCREF(importer); /* get_path_importer returns a borrowed reference */
1134 return importer;
1135}
1136
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001137/* Search the path (default sys.path) for a module. Return the
1138 corresponding filedescr struct, and (via return arguments) the
1139 pathname and an open file. Return NULL if the module is not found. */
1140
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001141#ifdef MS_COREDLL
Thomas Woutersb4bd21c2000-07-22 23:38:01 +00001142extern FILE *PyWin_FindRegisteredModule(const char *, struct filedescr **,
Martin v. Löwis18e16552006-02-15 17:27:45 +00001143 char *, Py_ssize_t);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001144#endif
1145
Martin v. Löwis18e16552006-02-15 17:27:45 +00001146static int case_ok(char *, Py_ssize_t, Py_ssize_t, char *);
Tim Petersdbd9ba62000-07-09 03:09:57 +00001147static int find_init_module(char *); /* Forward */
Just van Rossum52e14d62002-12-30 22:08:05 +00001148static struct filedescr importhookdescr = {"", "", IMP_HOOK};
Guido van Rossum197346f1997-10-31 18:38:52 +00001149
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001150static struct filedescr *
Just van Rossum52e14d62002-12-30 22:08:05 +00001151find_module(char *fullname, char *subname, PyObject *path, char *buf,
1152 size_t buflen, FILE **p_fp, PyObject **p_loader)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001153{
Martin v. Löwis725507b2006-03-07 12:08:51 +00001154 Py_ssize_t i, npath;
Fred Drake4c82b232000-06-30 16:18:57 +00001155 size_t len, namelen;
Guido van Rossum80bb9651996-12-05 23:27:02 +00001156 struct filedescr *fdp = NULL;
Jack Jansenc88da1f2002-05-28 10:58:19 +00001157 char *filemode;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001158 FILE *fp = NULL;
Just van Rossum52e14d62002-12-30 22:08:05 +00001159 PyObject *path_hooks, *path_importer_cache;
Guido van Rossum48a680c2001-03-02 06:34:14 +00001160#ifndef RISCOS
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001161 struct stat statbuf;
Guido van Rossum48a680c2001-03-02 06:34:14 +00001162#endif
Guido van Rossuma5568d31998-03-05 03:45:08 +00001163 static struct filedescr fd_frozen = {"", "", PY_FROZEN};
1164 static struct filedescr fd_builtin = {"", "", C_BUILTIN};
1165 static struct filedescr fd_package = {"", "", PKG_DIRECTORY};
Guido van Rossum0506a431998-08-11 15:07:39 +00001166 char name[MAXPATHLEN+1];
Andrew MacIntyred9400542002-02-26 11:41:34 +00001167#if defined(PYOS_OS2)
1168 size_t saved_len;
1169 size_t saved_namelen;
1170 char *saved_buf = NULL;
1171#endif
Just van Rossum52e14d62002-12-30 22:08:05 +00001172 if (p_loader != NULL)
1173 *p_loader = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001174
Just van Rossum52e14d62002-12-30 22:08:05 +00001175 if (strlen(subname) > MAXPATHLEN) {
Guido van Rossum8f4d3312001-10-18 18:54:11 +00001176 PyErr_SetString(PyExc_OverflowError,
1177 "module name is too long");
Fred Drake4c82b232000-06-30 16:18:57 +00001178 return NULL;
1179 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001180 strcpy(name, subname);
1181
1182 /* sys.meta_path import hook */
1183 if (p_loader != NULL) {
1184 PyObject *meta_path;
1185
1186 meta_path = PySys_GetObject("meta_path");
1187 if (meta_path == NULL || !PyList_Check(meta_path)) {
1188 PyErr_SetString(PyExc_ImportError,
1189 "sys.meta_path must be a list of "
1190 "import hooks");
1191 return NULL;
1192 }
1193 Py_INCREF(meta_path); /* zap guard */
1194 npath = PyList_Size(meta_path);
1195 for (i = 0; i < npath; i++) {
1196 PyObject *loader;
1197 PyObject *hook = PyList_GetItem(meta_path, i);
1198 loader = PyObject_CallMethod(hook, "find_module",
1199 "sO", fullname,
1200 path != NULL ?
1201 path : Py_None);
1202 if (loader == NULL) {
1203 Py_DECREF(meta_path);
1204 return NULL; /* true error */
1205 }
1206 if (loader != Py_None) {
1207 /* a loader was found */
1208 *p_loader = loader;
1209 Py_DECREF(meta_path);
1210 return &importhookdescr;
1211 }
1212 Py_DECREF(loader);
1213 }
1214 Py_DECREF(meta_path);
1215 }
Guido van Rossum0506a431998-08-11 15:07:39 +00001216
1217 if (path != NULL && PyString_Check(path)) {
Guido van Rossum8f4d3312001-10-18 18:54:11 +00001218 /* The only type of submodule allowed inside a "frozen"
1219 package are other frozen modules or packages. */
Guido van Rossum0506a431998-08-11 15:07:39 +00001220 if (PyString_Size(path) + 1 + strlen(name) >= (size_t)buflen) {
1221 PyErr_SetString(PyExc_ImportError,
1222 "full frozen module name too long");
1223 return NULL;
1224 }
1225 strcpy(buf, PyString_AsString(path));
1226 strcat(buf, ".");
1227 strcat(buf, name);
1228 strcpy(name, buf);
Guido van Rossum8f4d3312001-10-18 18:54:11 +00001229 if (find_frozen(name) != NULL) {
1230 strcpy(buf, name);
1231 return &fd_frozen;
1232 }
1233 PyErr_Format(PyExc_ImportError,
1234 "No frozen submodule named %.200s", name);
1235 return NULL;
Guido van Rossum0506a431998-08-11 15:07:39 +00001236 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001237 if (path == NULL) {
1238 if (is_builtin(name)) {
Guido van Rossuma5568d31998-03-05 03:45:08 +00001239 strcpy(buf, name);
1240 return &fd_builtin;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001241 }
Greg Ward201baee2001-10-04 14:52:06 +00001242 if ((find_frozen(name)) != NULL) {
Guido van Rossuma5568d31998-03-05 03:45:08 +00001243 strcpy(buf, name);
1244 return &fd_frozen;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001245 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001246
Guido van Rossumac279101996-08-22 23:10:58 +00001247#ifdef MS_COREDLL
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001248 fp = PyWin_FindRegisteredModule(name, &fdp, buf, buflen);
1249 if (fp != NULL) {
1250 *p_fp = fp;
1251 return fdp;
1252 }
Guido van Rossuma5a3db71996-04-09 02:39:59 +00001253#endif
Guido van Rossuma5568d31998-03-05 03:45:08 +00001254 path = PySys_GetObject("path");
1255 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00001256 if (path == NULL || !PyList_Check(path)) {
1257 PyErr_SetString(PyExc_ImportError,
Guido van Rossuma5568d31998-03-05 03:45:08 +00001258 "sys.path must be a list of directory names");
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001259 return NULL;
1260 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001261
1262 path_hooks = PySys_GetObject("path_hooks");
1263 if (path_hooks == NULL || !PyList_Check(path_hooks)) {
1264 PyErr_SetString(PyExc_ImportError,
1265 "sys.path_hooks must be a list of "
1266 "import hooks");
1267 return NULL;
1268 }
1269 path_importer_cache = PySys_GetObject("path_importer_cache");
1270 if (path_importer_cache == NULL ||
1271 !PyDict_Check(path_importer_cache)) {
1272 PyErr_SetString(PyExc_ImportError,
1273 "sys.path_importer_cache must be a dict");
1274 return NULL;
1275 }
1276
Guido van Rossum79f25d91997-04-29 20:08:16 +00001277 npath = PyList_Size(path);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001278 namelen = strlen(name);
1279 for (i = 0; i < npath; i++) {
Walter Dörwald3430d702002-06-17 10:43:59 +00001280 PyObject *copy = NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +00001281 PyObject *v = PyList_GetItem(path, i);
Neal Norwitz3cb31ac2006-08-13 18:10:47 +00001282 if (!v)
1283 return NULL;
Walter Dörwald3430d702002-06-17 10:43:59 +00001284#ifdef Py_USING_UNICODE
1285 if (PyUnicode_Check(v)) {
1286 copy = PyUnicode_Encode(PyUnicode_AS_UNICODE(v),
1287 PyUnicode_GET_SIZE(v), Py_FileSystemDefaultEncoding, NULL);
1288 if (copy == NULL)
1289 return NULL;
1290 v = copy;
1291 }
1292 else
1293#endif
Guido van Rossum79f25d91997-04-29 20:08:16 +00001294 if (!PyString_Check(v))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001295 continue;
Neal Norwitz2aa9a5d2006-03-20 01:53:23 +00001296 len = PyString_GET_SIZE(v);
Walter Dörwald3430d702002-06-17 10:43:59 +00001297 if (len + 2 + namelen + MAXSUFFIXSIZE >= buflen) {
1298 Py_XDECREF(copy);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001299 continue; /* Too long */
Walter Dörwald3430d702002-06-17 10:43:59 +00001300 }
Neal Norwitz2aa9a5d2006-03-20 01:53:23 +00001301 strcpy(buf, PyString_AS_STRING(v));
Walter Dörwald3430d702002-06-17 10:43:59 +00001302 if (strlen(buf) != len) {
1303 Py_XDECREF(copy);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001304 continue; /* v contains '\0' */
Walter Dörwald3430d702002-06-17 10:43:59 +00001305 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001306
1307 /* sys.path_hooks import hook */
1308 if (p_loader != NULL) {
1309 PyObject *importer;
1310
1311 importer = get_path_importer(path_importer_cache,
1312 path_hooks, v);
Neal Norwitza4df11d2006-07-06 04:28:59 +00001313 if (importer == NULL) {
1314 Py_XDECREF(copy);
Just van Rossum52e14d62002-12-30 22:08:05 +00001315 return NULL;
Neal Norwitza4df11d2006-07-06 04:28:59 +00001316 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001317 /* Note: importer is a borrowed reference */
Phillip J. Ebyf7575d02006-07-28 21:12:07 +00001318 if (importer != Py_None) {
Just van Rossum52e14d62002-12-30 22:08:05 +00001319 PyObject *loader;
1320 loader = PyObject_CallMethod(importer,
1321 "find_module",
1322 "s", fullname);
Neal Norwitza4df11d2006-07-06 04:28:59 +00001323 Py_XDECREF(copy);
Just van Rossum52e14d62002-12-30 22:08:05 +00001324 if (loader == NULL)
1325 return NULL; /* error */
1326 if (loader != Py_None) {
1327 /* a loader was found */
1328 *p_loader = loader;
1329 return &importhookdescr;
1330 }
1331 Py_DECREF(loader);
Georg Brandlf4ef1162006-05-26 18:03:31 +00001332 continue;
Just van Rossum52e14d62002-12-30 22:08:05 +00001333 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001334 }
Georg Brandlf4ef1162006-05-26 18:03:31 +00001335 /* no hook was found, use builtin import */
Just van Rossum52e14d62002-12-30 22:08:05 +00001336
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001337 if (len > 0 && buf[len-1] != SEP
1338#ifdef ALTSEP
1339 && buf[len-1] != ALTSEP
1340#endif
1341 )
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001342 buf[len++] = SEP;
Guido van Rossum215c3402000-11-13 17:26:32 +00001343 strcpy(buf+len, name);
1344 len += namelen;
Tim Peters50d8d372001-02-28 05:34:27 +00001345
1346 /* Check for package import (buf holds a directory name,
1347 and there's an __init__ module in that directory */
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001348#ifdef HAVE_STAT
Walter Dörwald3430d702002-06-17 10:43:59 +00001349 if (stat(buf, &statbuf) == 0 && /* it exists */
1350 S_ISDIR(statbuf.st_mode) && /* it's a directory */
Thomas Wouters9df4e6f2006-04-27 23:13:20 +00001351 case_ok(buf, len, namelen, name)) { /* case matches */
1352 if (find_init_module(buf)) { /* and has __init__.py */
1353 Py_XDECREF(copy);
1354 return &fd_package;
1355 }
1356 else {
1357 char warnstr[MAXPATHLEN+80];
1358 sprintf(warnstr, "Not importing directory "
1359 "'%.*s': missing __init__.py",
1360 MAXPATHLEN, buf);
1361 if (PyErr_Warn(PyExc_ImportWarning,
1362 warnstr)) {
1363 Py_XDECREF(copy);
1364 return NULL;
1365 }
1366 }
Walter Dörwald3430d702002-06-17 10:43:59 +00001367 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001368#else
1369 /* XXX How are you going to test for directories? */
Guido van Rossum48a680c2001-03-02 06:34:14 +00001370#ifdef RISCOS
Guido van Rossume2ae77b2001-10-24 20:42:55 +00001371 if (isdir(buf) &&
Walter Dörwald3430d702002-06-17 10:43:59 +00001372 case_ok(buf, len, namelen, name)) {
Thomas Wouters9df4e6f2006-04-27 23:13:20 +00001373 if (find_init_module(buf)) {
1374 Py_XDECREF(copy);
1375 return &fd_package;
1376 }
1377 else {
1378 char warnstr[MAXPATHLEN+80];
1379 sprintf(warnstr, "Not importing directory "
1380 "'%.*s': missing __init__.py",
1381 MAXPATHLEN, buf);
1382 if (PyErr_Warn(PyExc_ImportWarning,
1383 warnstr)) {
1384 Py_XDECREF(copy);
1385 return NULL;
1386 }
Walter Dörwald3430d702002-06-17 10:43:59 +00001387 }
Guido van Rossum48a680c2001-03-02 06:34:14 +00001388#endif
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001389#endif
Andrew MacIntyred9400542002-02-26 11:41:34 +00001390#if defined(PYOS_OS2)
1391 /* take a snapshot of the module spec for restoration
1392 * after the 8 character DLL hackery
1393 */
1394 saved_buf = strdup(buf);
1395 saved_len = len;
1396 saved_namelen = namelen;
1397#endif /* PYOS_OS2 */
Guido van Rossum79f25d91997-04-29 20:08:16 +00001398 for (fdp = _PyImport_Filetab; fdp->suffix != NULL; fdp++) {
Georg Brandladd36e52007-08-23 18:08:06 +00001399#if defined(PYOS_OS2) && defined(HAVE_DYNAMIC_LOADING)
Jeremy Hylton4ae6fae2002-05-30 17:15:25 +00001400 /* OS/2 limits DLLs to 8 character names (w/o
1401 extension)
Andrew MacIntyred9400542002-02-26 11:41:34 +00001402 * so if the name is longer than that and its a
1403 * dynamically loaded module we're going to try,
1404 * truncate the name before trying
1405 */
Just van Rossum52e14d62002-12-30 22:08:05 +00001406 if (strlen(subname) > 8) {
Andrew MacIntyred9400542002-02-26 11:41:34 +00001407 /* is this an attempt to load a C extension? */
Jeremy Hylton4ae6fae2002-05-30 17:15:25 +00001408 const struct filedescr *scan;
1409 scan = _PyImport_DynLoadFiletab;
Andrew MacIntyred9400542002-02-26 11:41:34 +00001410 while (scan->suffix != NULL) {
Jeremy Hylton4ae6fae2002-05-30 17:15:25 +00001411 if (!strcmp(scan->suffix, fdp->suffix))
Andrew MacIntyred9400542002-02-26 11:41:34 +00001412 break;
1413 else
1414 scan++;
1415 }
1416 if (scan->suffix != NULL) {
1417 /* yes, so truncate the name */
1418 namelen = 8;
Just van Rossum52e14d62002-12-30 22:08:05 +00001419 len -= strlen(subname) - namelen;
Andrew MacIntyred9400542002-02-26 11:41:34 +00001420 buf[len] = '\0';
1421 }
1422 }
1423#endif /* PYOS_OS2 */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001424 strcpy(buf+len, fdp->suffix);
Guido van Rossum79f25d91997-04-29 20:08:16 +00001425 if (Py_VerboseFlag > 1)
Guido van Rossum2f3667a1998-10-12 18:23:55 +00001426 PySys_WriteStderr("# trying %s\n", buf);
Jack Jansenc88da1f2002-05-28 10:58:19 +00001427 filemode = fdp->mode;
Tim Peters86c7d2f2004-08-01 23:24:21 +00001428 if (filemode[0] == 'U')
Jeremy Hylton4ae6fae2002-05-30 17:15:25 +00001429 filemode = "r" PY_STDIOTEXTMODE;
Jack Jansenc88da1f2002-05-28 10:58:19 +00001430 fp = fopen(buf, filemode);
Tim Peters50d8d372001-02-28 05:34:27 +00001431 if (fp != NULL) {
1432 if (case_ok(buf, len, namelen, name))
1433 break;
1434 else { /* continue search */
1435 fclose(fp);
1436 fp = NULL;
Barry Warsaw914a0b12001-02-02 19:12:16 +00001437 }
Barry Warsaw914a0b12001-02-02 19:12:16 +00001438 }
Andrew MacIntyred9400542002-02-26 11:41:34 +00001439#if defined(PYOS_OS2)
1440 /* restore the saved snapshot */
1441 strcpy(buf, saved_buf);
1442 len = saved_len;
1443 namelen = saved_namelen;
1444#endif
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001445 }
Andrew MacIntyred9400542002-02-26 11:41:34 +00001446#if defined(PYOS_OS2)
1447 /* don't need/want the module name snapshot anymore */
1448 if (saved_buf)
1449 {
1450 free(saved_buf);
1451 saved_buf = NULL;
1452 }
1453#endif
Walter Dörwald3430d702002-06-17 10:43:59 +00001454 Py_XDECREF(copy);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001455 if (fp != NULL)
1456 break;
1457 }
1458 if (fp == NULL) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001459 PyErr_Format(PyExc_ImportError,
1460 "No module named %.200s", name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001461 return NULL;
1462 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001463 *p_fp = fp;
1464 return fdp;
1465}
1466
Raymond Hettingerdb29e0f2004-10-07 06:46:25 +00001467/* Helpers for main.c
1468 * Find the source file corresponding to a named module
1469 */
1470struct filedescr *
1471_PyImport_FindModule(const char *name, PyObject *path, char *buf,
1472 size_t buflen, FILE **p_fp, PyObject **p_loader)
1473{
1474 return find_module((char *) name, (char *) name, path,
1475 buf, buflen, p_fp, p_loader);
1476}
1477
1478PyAPI_FUNC(int) _PyImport_IsScript(struct filedescr * fd)
1479{
1480 return fd->type == PY_SOURCE || fd->type == PY_COMPILED;
1481}
1482
Martin v. Löwis18e16552006-02-15 17:27:45 +00001483/* case_ok(char* buf, Py_ssize_t len, Py_ssize_t namelen, char* name)
Tim Petersd1e87a82001-03-01 18:12:00 +00001484 * The arguments here are tricky, best shown by example:
1485 * /a/b/c/d/e/f/g/h/i/j/k/some_long_module_name.py\0
1486 * ^ ^ ^ ^
1487 * |--------------------- buf ---------------------|
1488 * |------------------- len ------------------|
1489 * |------ name -------|
1490 * |----- namelen -----|
1491 * buf is the full path, but len only counts up to (& exclusive of) the
1492 * extension. name is the module name, also exclusive of extension.
1493 *
1494 * We've already done a successful stat() or fopen() on buf, so know that
1495 * there's some match, possibly case-insensitive.
1496 *
Tim Peters50d8d372001-02-28 05:34:27 +00001497 * case_ok() is to return 1 if there's a case-sensitive match for
1498 * name, else 0. case_ok() is also to return 1 if envar PYTHONCASEOK
1499 * exists.
Tim Petersd1e87a82001-03-01 18:12:00 +00001500 *
Tim Peters50d8d372001-02-28 05:34:27 +00001501 * case_ok() is used to implement case-sensitive import semantics even
1502 * on platforms with case-insensitive filesystems. It's trivial to implement
1503 * for case-sensitive filesystems. It's pretty much a cross-platform
1504 * nightmare for systems with case-insensitive filesystems.
1505 */
Guido van Rossum0980bd91998-02-13 17:18:36 +00001506
Tim Peters50d8d372001-02-28 05:34:27 +00001507/* First we may need a pile of platform-specific header files; the sequence
1508 * of #if's here should match the sequence in the body of case_ok().
1509 */
Jason Tishler7961aa62005-05-20 00:56:54 +00001510#if defined(MS_WINDOWS)
Guido van Rossum0980bd91998-02-13 17:18:36 +00001511#include <windows.h>
Guido van Rossum4c3f57c2001-01-10 20:40:46 +00001512
Tim Peters50d8d372001-02-28 05:34:27 +00001513#elif defined(DJGPP)
1514#include <dir.h>
1515
Jason Tishler7961aa62005-05-20 00:56:54 +00001516#elif (defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) && defined(HAVE_DIRENT_H)
Tim Peters430f5d42001-03-01 01:30:56 +00001517#include <sys/types.h>
1518#include <dirent.h>
1519
Andrew MacIntyred9400542002-02-26 11:41:34 +00001520#elif defined(PYOS_OS2)
1521#define INCL_DOS
1522#define INCL_DOSERRORS
1523#define INCL_NOPMAPI
1524#include <os2.h>
1525
Guido van Rossume2ae77b2001-10-24 20:42:55 +00001526#elif defined(RISCOS)
1527#include "oslib/osfscontrol.h"
Tim Peters50d8d372001-02-28 05:34:27 +00001528#endif
1529
Guido van Rossum0980bd91998-02-13 17:18:36 +00001530static int
Martin v. Löwis18e16552006-02-15 17:27:45 +00001531case_ok(char *buf, Py_ssize_t len, Py_ssize_t namelen, char *name)
Guido van Rossum0980bd91998-02-13 17:18:36 +00001532{
Tim Peters50d8d372001-02-28 05:34:27 +00001533/* Pick a platform-specific implementation; the sequence of #if's here should
1534 * match the sequence just above.
1535 */
1536
Jason Tishler7961aa62005-05-20 00:56:54 +00001537/* MS_WINDOWS */
1538#if defined(MS_WINDOWS)
Guido van Rossum0980bd91998-02-13 17:18:36 +00001539 WIN32_FIND_DATA data;
1540 HANDLE h;
Tim Peters50d8d372001-02-28 05:34:27 +00001541
Neil Schemenauer7d4bb9f2001-07-23 16:30:27 +00001542 if (Py_GETENV("PYTHONCASEOK") != NULL)
Guido van Rossum0980bd91998-02-13 17:18:36 +00001543 return 1;
Tim Peters50d8d372001-02-28 05:34:27 +00001544
Guido van Rossum0980bd91998-02-13 17:18:36 +00001545 h = FindFirstFile(buf, &data);
1546 if (h == INVALID_HANDLE_VALUE) {
1547 PyErr_Format(PyExc_NameError,
1548 "Can't find file for module %.100s\n(filename %.300s)",
1549 name, buf);
1550 return 0;
1551 }
1552 FindClose(h);
Tim Peters50d8d372001-02-28 05:34:27 +00001553 return strncmp(data.cFileName, name, namelen) == 0;
1554
1555/* DJGPP */
1556#elif defined(DJGPP)
1557 struct ffblk ffblk;
1558 int done;
1559
Neil Schemenauer7d4bb9f2001-07-23 16:30:27 +00001560 if (Py_GETENV("PYTHONCASEOK") != NULL)
Guido van Rossum323bf5e1998-06-24 03:54:06 +00001561 return 1;
Tim Peters50d8d372001-02-28 05:34:27 +00001562
1563 done = findfirst(buf, &ffblk, FA_ARCH|FA_RDONLY|FA_HIDDEN|FA_DIREC);
1564 if (done) {
Guido van Rossum0980bd91998-02-13 17:18:36 +00001565 PyErr_Format(PyExc_NameError,
Tim Peters50d8d372001-02-28 05:34:27 +00001566 "Can't find file for module %.100s\n(filename %.300s)",
Guido van Rossum0980bd91998-02-13 17:18:36 +00001567 name, buf);
1568 return 0;
1569 }
Tim Peters50d8d372001-02-28 05:34:27 +00001570 return strncmp(ffblk.ff_name, name, namelen) == 0;
Guido van Rossum0980bd91998-02-13 17:18:36 +00001571
Jason Tishler7961aa62005-05-20 00:56:54 +00001572/* new-fangled macintosh (macosx) or Cygwin */
1573#elif (defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) && defined(HAVE_DIRENT_H)
Tim Peters430f5d42001-03-01 01:30:56 +00001574 DIR *dirp;
1575 struct dirent *dp;
Tim Petersd1e87a82001-03-01 18:12:00 +00001576 char dirname[MAXPATHLEN + 1];
1577 const int dirlen = len - namelen - 1; /* don't want trailing SEP */
Tim Peters430f5d42001-03-01 01:30:56 +00001578
Neil Schemenauer7d4bb9f2001-07-23 16:30:27 +00001579 if (Py_GETENV("PYTHONCASEOK") != NULL)
Tim Petersdbe6ebb2001-03-01 08:47:29 +00001580 return 1;
1581
Tim Petersd1e87a82001-03-01 18:12:00 +00001582 /* Copy the dir component into dirname; substitute "." if empty */
1583 if (dirlen <= 0) {
1584 dirname[0] = '.';
1585 dirname[1] = '\0';
Tim Peters430f5d42001-03-01 01:30:56 +00001586 }
1587 else {
Tim Petersd1e87a82001-03-01 18:12:00 +00001588 assert(dirlen <= MAXPATHLEN);
1589 memcpy(dirname, buf, dirlen);
1590 dirname[dirlen] = '\0';
Tim Peters430f5d42001-03-01 01:30:56 +00001591 }
1592 /* Open the directory and search the entries for an exact match. */
Tim Petersd1e87a82001-03-01 18:12:00 +00001593 dirp = opendir(dirname);
Tim Peters430f5d42001-03-01 01:30:56 +00001594 if (dirp) {
Tim Peters677898a2001-03-02 03:28:03 +00001595 char *nameWithExt = buf + len - namelen;
Tim Peters430f5d42001-03-01 01:30:56 +00001596 while ((dp = readdir(dirp)) != NULL) {
Tim Petersdbe6ebb2001-03-01 08:47:29 +00001597 const int thislen =
Tim Peters430f5d42001-03-01 01:30:56 +00001598#ifdef _DIRENT_HAVE_D_NAMELEN
Tim Petersdbe6ebb2001-03-01 08:47:29 +00001599 dp->d_namlen;
Tim Peters430f5d42001-03-01 01:30:56 +00001600#else
Tim Petersdbe6ebb2001-03-01 08:47:29 +00001601 strlen(dp->d_name);
Tim Peters430f5d42001-03-01 01:30:56 +00001602#endif
Tim Petersd1e87a82001-03-01 18:12:00 +00001603 if (thislen >= namelen &&
Tim Peters677898a2001-03-02 03:28:03 +00001604 strcmp(dp->d_name, nameWithExt) == 0) {
Tim Peters430f5d42001-03-01 01:30:56 +00001605 (void)closedir(dirp);
1606 return 1; /* Found */
1607 }
1608 }
Tim Petersdbe6ebb2001-03-01 08:47:29 +00001609 (void)closedir(dirp);
Tim Peters430f5d42001-03-01 01:30:56 +00001610 }
Tim Peters430f5d42001-03-01 01:30:56 +00001611 return 0 ; /* Not found */
Tim Peters430f5d42001-03-01 01:30:56 +00001612
Guido van Rossume2ae77b2001-10-24 20:42:55 +00001613/* RISC OS */
1614#elif defined(RISCOS)
1615 char canon[MAXPATHLEN+1]; /* buffer for the canonical form of the path */
1616 char buf2[MAXPATHLEN+2];
1617 char *nameWithExt = buf+len-namelen;
1618 int canonlen;
1619 os_error *e;
1620
1621 if (Py_GETENV("PYTHONCASEOK") != NULL)
1622 return 1;
1623
1624 /* workaround:
1625 append wildcard, otherwise case of filename wouldn't be touched */
1626 strcpy(buf2, buf);
1627 strcat(buf2, "*");
1628
1629 e = xosfscontrol_canonicalise_path(buf2,canon,0,0,MAXPATHLEN+1,&canonlen);
1630 canonlen = MAXPATHLEN+1-canonlen;
1631 if (e || canonlen<=0 || canonlen>(MAXPATHLEN+1) )
1632 return 0;
1633 if (strcmp(nameWithExt, canon+canonlen-strlen(nameWithExt))==0)
1634 return 1; /* match */
1635
1636 return 0;
1637
Andrew MacIntyred9400542002-02-26 11:41:34 +00001638/* OS/2 */
1639#elif defined(PYOS_OS2)
1640 HDIR hdir = 1;
1641 ULONG srchcnt = 1;
1642 FILEFINDBUF3 ffbuf;
1643 APIRET rc;
1644
Georg Brandlaed6c662008-01-07 17:25:53 +00001645 if (Py_GETENV("PYTHONCASEOK") != NULL)
Andrew MacIntyred9400542002-02-26 11:41:34 +00001646 return 1;
1647
1648 rc = DosFindFirst(buf,
1649 &hdir,
1650 FILE_READONLY | FILE_HIDDEN | FILE_SYSTEM | FILE_DIRECTORY,
1651 &ffbuf, sizeof(ffbuf),
1652 &srchcnt,
1653 FIL_STANDARD);
1654 if (rc != NO_ERROR)
1655 return 0;
1656 return strncmp(ffbuf.achName, name, namelen) == 0;
1657
Tim Peters50d8d372001-02-28 05:34:27 +00001658/* assuming it's a case-sensitive filesystem, so there's nothing to do! */
1659#else
Guido van Rossum0980bd91998-02-13 17:18:36 +00001660 return 1;
Guido van Rossum0980bd91998-02-13 17:18:36 +00001661
Guido van Rossum4d1b3b91998-02-13 23:27:59 +00001662#endif
Tim Peters50d8d372001-02-28 05:34:27 +00001663}
Guido van Rossum4d1b3b91998-02-13 23:27:59 +00001664
Guido van Rossum0980bd91998-02-13 17:18:36 +00001665
Guido van Rossum197346f1997-10-31 18:38:52 +00001666#ifdef HAVE_STAT
1667/* Helper to look for __init__.py or __init__.py[co] in potential package */
1668static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001669find_init_module(char *buf)
Guido van Rossum197346f1997-10-31 18:38:52 +00001670{
Tim Peters0f9431f2001-07-05 03:47:53 +00001671 const size_t save_len = strlen(buf);
Fred Drake4c82b232000-06-30 16:18:57 +00001672 size_t i = save_len;
Tim Peters0f9431f2001-07-05 03:47:53 +00001673 char *pname; /* pointer to start of __init__ */
Guido van Rossum197346f1997-10-31 18:38:52 +00001674 struct stat statbuf;
1675
Tim Peters0f9431f2001-07-05 03:47:53 +00001676/* For calling case_ok(buf, len, namelen, name):
1677 * /a/b/c/d/e/f/g/h/i/j/k/some_long_module_name.py\0
1678 * ^ ^ ^ ^
1679 * |--------------------- buf ---------------------|
1680 * |------------------- len ------------------|
1681 * |------ name -------|
1682 * |----- namelen -----|
1683 */
Guido van Rossum197346f1997-10-31 18:38:52 +00001684 if (save_len + 13 >= MAXPATHLEN)
1685 return 0;
1686 buf[i++] = SEP;
Tim Peters0f9431f2001-07-05 03:47:53 +00001687 pname = buf + i;
1688 strcpy(pname, "__init__.py");
Guido van Rossum197346f1997-10-31 18:38:52 +00001689 if (stat(buf, &statbuf) == 0) {
Tim Peters0f9431f2001-07-05 03:47:53 +00001690 if (case_ok(buf,
1691 save_len + 9, /* len("/__init__") */
1692 8, /* len("__init__") */
1693 pname)) {
1694 buf[save_len] = '\0';
1695 return 1;
1696 }
Guido van Rossum197346f1997-10-31 18:38:52 +00001697 }
Tim Peters0f9431f2001-07-05 03:47:53 +00001698 i += strlen(pname);
1699 strcpy(buf+i, Py_OptimizeFlag ? "o" : "c");
Guido van Rossum197346f1997-10-31 18:38:52 +00001700 if (stat(buf, &statbuf) == 0) {
Tim Peters0f9431f2001-07-05 03:47:53 +00001701 if (case_ok(buf,
1702 save_len + 9, /* len("/__init__") */
1703 8, /* len("__init__") */
1704 pname)) {
1705 buf[save_len] = '\0';
1706 return 1;
1707 }
Guido van Rossum197346f1997-10-31 18:38:52 +00001708 }
1709 buf[save_len] = '\0';
1710 return 0;
1711}
Guido van Rossum48a680c2001-03-02 06:34:14 +00001712
1713#else
1714
1715#ifdef RISCOS
1716static int
1717find_init_module(buf)
1718 char *buf;
1719{
1720 int save_len = strlen(buf);
1721 int i = save_len;
1722
1723 if (save_len + 13 >= MAXPATHLEN)
1724 return 0;
1725 buf[i++] = SEP;
1726 strcpy(buf+i, "__init__/py");
1727 if (isfile(buf)) {
1728 buf[save_len] = '\0';
1729 return 1;
1730 }
1731
1732 if (Py_OptimizeFlag)
1733 strcpy(buf+i, "o");
1734 else
1735 strcpy(buf+i, "c");
1736 if (isfile(buf)) {
1737 buf[save_len] = '\0';
1738 return 1;
1739 }
1740 buf[save_len] = '\0';
1741 return 0;
1742}
1743#endif /*RISCOS*/
1744
Guido van Rossum197346f1997-10-31 18:38:52 +00001745#endif /* HAVE_STAT */
1746
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001747
Tim Petersdbd9ba62000-07-09 03:09:57 +00001748static int init_builtin(char *); /* Forward */
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001749
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001750/* Load an external module using the default search path and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001751 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001752
Guido van Rossum79f25d91997-04-29 20:08:16 +00001753static PyObject *
Just van Rossum52e14d62002-12-30 22:08:05 +00001754load_module(char *name, FILE *fp, char *buf, int type, PyObject *loader)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001755{
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001756 PyObject *modules;
Guido van Rossum79f25d91997-04-29 20:08:16 +00001757 PyObject *m;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001758 int err;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001759
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001760 /* First check that there's an open file (if we need one) */
1761 switch (type) {
1762 case PY_SOURCE:
1763 case PY_COMPILED:
1764 if (fp == NULL) {
1765 PyErr_Format(PyExc_ValueError,
1766 "file object required for import (type code %d)",
1767 type);
1768 return NULL;
1769 }
1770 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001771
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001772 switch (type) {
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001773
1774 case PY_SOURCE:
1775 m = load_source_module(name, buf, fp);
1776 break;
1777
1778 case PY_COMPILED:
1779 m = load_compiled_module(name, buf, fp);
1780 break;
1781
Guido van Rossum96a8fb71999-12-22 14:09:35 +00001782#ifdef HAVE_DYNAMIC_LOADING
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001783 case C_EXTENSION:
Guido van Rossum79f25d91997-04-29 20:08:16 +00001784 m = _PyImport_LoadDynamicModule(name, buf, fp);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001785 break;
Guido van Rossum96a8fb71999-12-22 14:09:35 +00001786#endif
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001787
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001788 case PKG_DIRECTORY:
1789 m = load_package(name, buf);
1790 break;
1791
1792 case C_BUILTIN:
1793 case PY_FROZEN:
Guido van Rossuma5568d31998-03-05 03:45:08 +00001794 if (buf != NULL && buf[0] != '\0')
1795 name = buf;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001796 if (type == C_BUILTIN)
1797 err = init_builtin(name);
1798 else
1799 err = PyImport_ImportFrozenModule(name);
1800 if (err < 0)
Guido van Rossuma86f77d1997-09-09 18:53:47 +00001801 return NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001802 if (err == 0) {
1803 PyErr_Format(PyExc_ImportError,
1804 "Purported %s module %.200s not found",
1805 type == C_BUILTIN ?
1806 "builtin" : "frozen",
1807 name);
Guido van Rossuma86f77d1997-09-09 18:53:47 +00001808 return NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001809 }
1810 modules = PyImport_GetModuleDict();
1811 m = PyDict_GetItemString(modules, name);
1812 if (m == NULL) {
1813 PyErr_Format(
1814 PyExc_ImportError,
1815 "%s module %.200s not properly initialized",
1816 type == C_BUILTIN ?
1817 "builtin" : "frozen",
1818 name);
Guido van Rossuma86f77d1997-09-09 18:53:47 +00001819 return NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001820 }
1821 Py_INCREF(m);
1822 break;
1823
Just van Rossum52e14d62002-12-30 22:08:05 +00001824 case IMP_HOOK: {
1825 if (loader == NULL) {
1826 PyErr_SetString(PyExc_ImportError,
1827 "import hook without loader");
1828 return NULL;
1829 }
1830 m = PyObject_CallMethod(loader, "load_module", "s", name);
1831 break;
1832 }
1833
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001834 default:
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001835 PyErr_Format(PyExc_ImportError,
1836 "Don't know how to import %.200s (type code %d)",
1837 name, type);
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001838 m = NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001839
1840 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001841
1842 return m;
1843}
1844
1845
1846/* Initialize a built-in module.
Brett Cannon5a9aa4f2006-10-03 21:58:55 +00001847 Return 1 for success, 0 if the module is not found, and -1 with
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001848 an exception set if the initialization failed. */
Guido van Rossum7f133ed1991-02-19 12:23:57 +00001849
Guido van Rossum7f133ed1991-02-19 12:23:57 +00001850static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001851init_builtin(char *name)
Guido van Rossum7f133ed1991-02-19 12:23:57 +00001852{
Guido van Rossum25ce5661997-08-02 03:10:38 +00001853 struct _inittab *p;
Guido van Rossum25ce5661997-08-02 03:10:38 +00001854
Greg Ward201baee2001-10-04 14:52:06 +00001855 if (_PyImport_FindExtension(name, name) != NULL)
Guido van Rossum25ce5661997-08-02 03:10:38 +00001856 return 1;
1857
Guido van Rossum771c6c81997-10-31 18:37:24 +00001858 for (p = PyImport_Inittab; p->name != NULL; p++) {
Guido van Rossum25ce5661997-08-02 03:10:38 +00001859 if (strcmp(name, p->name) == 0) {
1860 if (p->initfunc == NULL) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001861 PyErr_Format(PyExc_ImportError,
1862 "Cannot re-init internal module %.200s",
1863 name);
Guido van Rossum74e6a111994-08-29 12:54:38 +00001864 return -1;
1865 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00001866 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +00001867 PySys_WriteStderr("import %s # builtin\n", name);
Guido van Rossum25ce5661997-08-02 03:10:38 +00001868 (*p->initfunc)();
Guido van Rossum79f25d91997-04-29 20:08:16 +00001869 if (PyErr_Occurred())
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001870 return -1;
Guido van Rossum25ce5661997-08-02 03:10:38 +00001871 if (_PyImport_FixupExtension(name, name) == NULL)
1872 return -1;
Guido van Rossum7f133ed1991-02-19 12:23:57 +00001873 return 1;
1874 }
1875 }
1876 return 0;
1877}
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001878
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001879
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001880/* Frozen modules */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001881
Guido van Rossumcfd0a221996-06-17 17:06:34 +00001882static struct _frozen *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001883find_frozen(char *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001884{
Guido van Rossumcfd0a221996-06-17 17:06:34 +00001885 struct _frozen *p;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001886
Guido van Rossum79f25d91997-04-29 20:08:16 +00001887 for (p = PyImport_FrozenModules; ; p++) {
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001888 if (p->name == NULL)
1889 return NULL;
1890 if (strcmp(p->name, name) == 0)
1891 break;
1892 }
1893 return p;
1894}
1895
Guido van Rossum79f25d91997-04-29 20:08:16 +00001896static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001897get_frozen_object(char *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001898{
Guido van Rossumcfd0a221996-06-17 17:06:34 +00001899 struct _frozen *p = find_frozen(name);
Guido van Rossuma5568d31998-03-05 03:45:08 +00001900 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001901
1902 if (p == NULL) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001903 PyErr_Format(PyExc_ImportError,
1904 "No such frozen object named %.200s",
1905 name);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001906 return NULL;
1907 }
Guido van Rossum8f4d3312001-10-18 18:54:11 +00001908 if (p->code == NULL) {
1909 PyErr_Format(PyExc_ImportError,
1910 "Excluded frozen object named %.200s",
1911 name);
1912 return NULL;
1913 }
Guido van Rossuma5568d31998-03-05 03:45:08 +00001914 size = p->size;
1915 if (size < 0)
1916 size = -size;
1917 return PyMarshal_ReadObjectFromString((char *)p->code, size);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001918}
1919
1920/* Initialize a frozen module.
1921 Return 1 for succes, 0 if the module is not found, and -1 with
1922 an exception set if the initialization failed.
1923 This function is also used from frozenmain.c */
Guido van Rossum0b344901995-02-07 15:35:27 +00001924
1925int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001926PyImport_ImportFrozenModule(char *name)
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001927{
Guido van Rossumcfd0a221996-06-17 17:06:34 +00001928 struct _frozen *p = find_frozen(name);
Guido van Rossum79f25d91997-04-29 20:08:16 +00001929 PyObject *co;
1930 PyObject *m;
Guido van Rossuma5568d31998-03-05 03:45:08 +00001931 int ispackage;
1932 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001933
1934 if (p == NULL)
1935 return 0;
Guido van Rossum8f4d3312001-10-18 18:54:11 +00001936 if (p->code == NULL) {
1937 PyErr_Format(PyExc_ImportError,
1938 "Excluded frozen object named %.200s",
1939 name);
1940 return -1;
1941 }
Guido van Rossuma5568d31998-03-05 03:45:08 +00001942 size = p->size;
1943 ispackage = (size < 0);
1944 if (ispackage)
1945 size = -size;
Guido van Rossum79f25d91997-04-29 20:08:16 +00001946 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +00001947 PySys_WriteStderr("import %s # frozen%s\n",
Guido van Rossuma5568d31998-03-05 03:45:08 +00001948 name, ispackage ? " package" : "");
1949 co = PyMarshal_ReadObjectFromString((char *)p->code, size);
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001950 if (co == NULL)
1951 return -1;
Guido van Rossum79f25d91997-04-29 20:08:16 +00001952 if (!PyCode_Check(co)) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001953 PyErr_Format(PyExc_TypeError,
1954 "frozen object %.200s is not a code object",
1955 name);
Neal Norwitzc0cde4d2006-07-16 02:17:36 +00001956 goto err_return;
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001957 }
Guido van Rossuma5568d31998-03-05 03:45:08 +00001958 if (ispackage) {
1959 /* Set __path__ to the package name */
1960 PyObject *d, *s;
1961 int err;
1962 m = PyImport_AddModule(name);
1963 if (m == NULL)
Neal Norwitzc0cde4d2006-07-16 02:17:36 +00001964 goto err_return;
Guido van Rossuma5568d31998-03-05 03:45:08 +00001965 d = PyModule_GetDict(m);
1966 s = PyString_InternFromString(name);
1967 if (s == NULL)
Neal Norwitzc0cde4d2006-07-16 02:17:36 +00001968 goto err_return;
Guido van Rossuma5568d31998-03-05 03:45:08 +00001969 err = PyDict_SetItemString(d, "__path__", s);
1970 Py_DECREF(s);
1971 if (err != 0)
Neal Norwitzc0cde4d2006-07-16 02:17:36 +00001972 goto err_return;
Guido van Rossuma5568d31998-03-05 03:45:08 +00001973 }
Guido van Rossume32bf6e1998-02-11 05:53:02 +00001974 m = PyImport_ExecCodeModuleEx(name, co, "<frozen>");
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001975 if (m == NULL)
Neal Norwitzc0cde4d2006-07-16 02:17:36 +00001976 goto err_return;
1977 Py_DECREF(co);
Guido van Rossum79f25d91997-04-29 20:08:16 +00001978 Py_DECREF(m);
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001979 return 1;
Neal Norwitzc0cde4d2006-07-16 02:17:36 +00001980err_return:
1981 Py_DECREF(co);
1982 return -1;
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001983}
Guido van Rossum74e6a111994-08-29 12:54:38 +00001984
1985
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001986/* Import a module, either built-in, frozen, or external, and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001987 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum74e6a111994-08-29 12:54:38 +00001988
Guido van Rossum79f25d91997-04-29 20:08:16 +00001989PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001990PyImport_ImportModule(const char *name)
Guido van Rossum74e6a111994-08-29 12:54:38 +00001991{
Marc-André Lemburg3c61c352001-02-09 19:40:15 +00001992 PyObject *pname;
1993 PyObject *result;
1994
1995 pname = PyString_FromString(name);
Neal Norwitza11e4c12003-03-23 14:31:01 +00001996 if (pname == NULL)
1997 return NULL;
Marc-André Lemburg3c61c352001-02-09 19:40:15 +00001998 result = PyImport_Import(pname);
1999 Py_DECREF(pname);
2000 return result;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002001}
2002
Christian Heimes000a0742008-01-03 22:16:32 +00002003/* Import a module without blocking
2004 *
2005 * At first it tries to fetch the module from sys.modules. If the module was
2006 * never loaded before it loads it with PyImport_ImportModule() unless another
2007 * thread holds the import lock. In the latter case the function raises an
2008 * ImportError instead of blocking.
2009 *
2010 * Returns the module object with incremented ref count.
2011 */
2012PyObject *
2013PyImport_ImportModuleNoBlock(const char *name)
2014{
2015 PyObject *result;
2016 PyObject *modules;
2017 long me;
2018
2019 /* Try to get the module from sys.modules[name] */
2020 modules = PyImport_GetModuleDict();
2021 if (modules == NULL)
2022 return NULL;
2023
2024 result = PyDict_GetItemString(modules, name);
2025 if (result != NULL) {
2026 Py_INCREF(result);
2027 return result;
2028 }
2029 else {
2030 PyErr_Clear();
2031 }
2032
2033 /* check the import lock
2034 * me might be -1 but I ignore the error here, the lock function
2035 * takes care of the problem */
2036 me = PyThread_get_thread_ident();
2037 if (import_lock_thread == -1 || import_lock_thread == me) {
2038 /* no thread or me is holding the lock */
2039 return PyImport_ImportModule(name);
2040 }
2041 else {
2042 PyErr_Format(PyExc_ImportError,
2043 "Failed to import %.200s because the import lock"
2044 "is held by another thread.",
2045 name);
2046 return NULL;
2047 }
2048}
2049
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002050/* Forward declarations for helper routines */
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002051static PyObject *get_parent(PyObject *globals, char *buf,
2052 Py_ssize_t *p_buflen, int level);
Tim Petersdbd9ba62000-07-09 03:09:57 +00002053static PyObject *load_next(PyObject *mod, PyObject *altmod,
Martin v. Löwis18e16552006-02-15 17:27:45 +00002054 char **p_name, char *buf, Py_ssize_t *p_buflen);
Tim Petersdbd9ba62000-07-09 03:09:57 +00002055static int mark_miss(char *name);
2056static int ensure_fromlist(PyObject *mod, PyObject *fromlist,
Martin v. Löwis18e16552006-02-15 17:27:45 +00002057 char *buf, Py_ssize_t buflen, int recursive);
Tim Petersdbd9ba62000-07-09 03:09:57 +00002058static PyObject * import_submodule(PyObject *mod, char *name, char *fullname);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002059
2060/* The Magnum Opus of dotted-name import :-) */
2061
Guido van Rossum75acc9c1998-03-03 22:26:50 +00002062static PyObject *
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002063import_module_level(char *name, PyObject *globals, PyObject *locals,
2064 PyObject *fromlist, int level)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002065{
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002066 char buf[MAXPATHLEN+1];
Martin v. Löwis18e16552006-02-15 17:27:45 +00002067 Py_ssize_t buflen = 0;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002068 PyObject *parent, *head, *next, *tail;
2069
Christian Heimes3403f152008-01-09 19:56:33 +00002070 if (strchr(name, '/') != NULL
2071#ifdef MS_WINDOWS
2072 || strchr(name, '\\') != NULL
2073#endif
2074 ) {
2075 PyErr_SetString(PyExc_ImportError,
2076 "Import by filename is not supported.");
2077 return NULL;
2078 }
2079
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002080 parent = get_parent(globals, buf, &buflen, level);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002081 if (parent == NULL)
2082 return NULL;
2083
2084 head = load_next(parent, Py_None, &name, buf, &buflen);
2085 if (head == NULL)
2086 return NULL;
2087
2088 tail = head;
2089 Py_INCREF(tail);
2090 while (name) {
2091 next = load_next(tail, tail, &name, buf, &buflen);
2092 Py_DECREF(tail);
2093 if (next == NULL) {
2094 Py_DECREF(head);
2095 return NULL;
2096 }
2097 tail = next;
2098 }
Thomas Wouters8ddab272006-04-04 16:17:02 +00002099 if (tail == Py_None) {
2100 /* If tail is Py_None, both get_parent and load_next found
2101 an empty module name: someone called __import__("") or
2102 doctored faulty bytecode */
Thomas Wouters4bdaa272006-04-05 13:39:37 +00002103 Py_DECREF(tail);
2104 Py_DECREF(head);
Thomas Wouters8ddab272006-04-04 16:17:02 +00002105 PyErr_SetString(PyExc_ValueError,
2106 "Empty module name");
2107 return NULL;
2108 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002109
2110 if (fromlist != NULL) {
2111 if (fromlist == Py_None || !PyObject_IsTrue(fromlist))
2112 fromlist = NULL;
2113 }
2114
2115 if (fromlist == NULL) {
2116 Py_DECREF(tail);
2117 return head;
2118 }
2119
2120 Py_DECREF(head);
Guido van Rossum9905ef91997-09-08 16:07:11 +00002121 if (!ensure_fromlist(tail, fromlist, buf, buflen, 0)) {
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002122 Py_DECREF(tail);
2123 return NULL;
2124 }
2125
2126 return tail;
2127}
2128
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002129PyObject *
2130PyImport_ImportModuleLevel(char *name, PyObject *globals, PyObject *locals,
2131 PyObject *fromlist, int level)
2132{
2133 PyObject *result;
2134 lock_import();
2135 result = import_module_level(name, globals, locals, fromlist, level);
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00002136 if (unlock_import() < 0) {
2137 Py_XDECREF(result);
2138 PyErr_SetString(PyExc_RuntimeError,
2139 "not holding the import lock");
2140 return NULL;
2141 }
Guido van Rossum75acc9c1998-03-03 22:26:50 +00002142 return result;
2143}
2144
Fred Drake87590902004-05-28 20:21:36 +00002145/* Return the package that an import is being performed in. If globals comes
2146 from the module foo.bar.bat (not itself a package), this returns the
2147 sys.modules entry for foo.bar. If globals is from a package's __init__.py,
Georg Brandl5f6861d2006-05-28 21:57:35 +00002148 the package's entry in sys.modules is returned, as a borrowed reference.
Fred Drake87590902004-05-28 20:21:36 +00002149
2150 The *name* of the returned package is returned in buf, with the length of
2151 the name in *p_buflen.
2152
2153 If globals doesn't come from a package or a module in a package, or a
2154 corresponding entry is not found in sys.modules, Py_None is returned.
2155*/
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002156static PyObject *
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002157get_parent(PyObject *globals, char *buf, Py_ssize_t *p_buflen, int level)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002158{
2159 static PyObject *namestr = NULL;
2160 static PyObject *pathstr = NULL;
Nick Coghlanef01d822007-12-03 12:55:17 +00002161 static PyObject *pkgstr = NULL;
2162 PyObject *pkgname, *modname, *modpath, *modules, *parent;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002163
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002164 if (globals == NULL || !PyDict_Check(globals) || !level)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002165 return Py_None;
2166
2167 if (namestr == NULL) {
2168 namestr = PyString_InternFromString("__name__");
2169 if (namestr == NULL)
2170 return NULL;
2171 }
2172 if (pathstr == NULL) {
2173 pathstr = PyString_InternFromString("__path__");
2174 if (pathstr == NULL)
2175 return NULL;
2176 }
Nick Coghlanef01d822007-12-03 12:55:17 +00002177 if (pkgstr == NULL) {
2178 pkgstr = PyString_InternFromString("__package__");
2179 if (pkgstr == NULL)
2180 return NULL;
2181 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002182
2183 *buf = '\0';
2184 *p_buflen = 0;
Nick Coghlanef01d822007-12-03 12:55:17 +00002185 pkgname = PyDict_GetItem(globals, pkgstr);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002186
Nick Coghlanef01d822007-12-03 12:55:17 +00002187 if ((pkgname != NULL) && (pkgname != Py_None)) {
2188 /* __package__ is set, so use it */
2189 Py_ssize_t len;
2190 if (!PyString_Check(pkgname)) {
2191 PyErr_SetString(PyExc_ValueError,
2192 "__package__ set to non-string");
2193 return NULL;
2194 }
2195 len = PyString_GET_SIZE(pkgname);
2196 if (len == 0) {
2197 if (level > 0) {
2198 PyErr_SetString(PyExc_ValueError,
2199 "Attempted relative import in non-package");
2200 return NULL;
2201 }
2202 return Py_None;
2203 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002204 if (len > MAXPATHLEN) {
2205 PyErr_SetString(PyExc_ValueError,
Nick Coghlanef01d822007-12-03 12:55:17 +00002206 "Package name too long");
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002207 return NULL;
2208 }
Nick Coghlanef01d822007-12-03 12:55:17 +00002209 strcpy(buf, PyString_AS_STRING(pkgname));
2210 } else {
2211 /* __package__ not set, so figure it out and set it */
2212 modname = PyDict_GetItem(globals, namestr);
2213 if (modname == NULL || !PyString_Check(modname))
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002214 return Py_None;
Nick Coghlanef01d822007-12-03 12:55:17 +00002215
2216 modpath = PyDict_GetItem(globals, pathstr);
2217 if (modpath != NULL) {
2218 /* __path__ is set, so modname is already the package name */
2219 Py_ssize_t len = PyString_GET_SIZE(modname);
2220 int error;
2221 if (len > MAXPATHLEN) {
2222 PyErr_SetString(PyExc_ValueError,
2223 "Module name too long");
2224 return NULL;
2225 }
2226 strcpy(buf, PyString_AS_STRING(modname));
2227 error = PyDict_SetItem(globals, pkgstr, modname);
2228 if (error) {
2229 PyErr_SetString(PyExc_ValueError,
2230 "Could not set __package__");
2231 return NULL;
2232 }
2233 } else {
2234 /* Normal module, so work out the package name if any */
2235 char *start = PyString_AS_STRING(modname);
2236 char *lastdot = strrchr(start, '.');
2237 size_t len;
2238 int error;
2239 if (lastdot == NULL && level > 0) {
2240 PyErr_SetString(PyExc_ValueError,
2241 "Attempted relative import in non-package");
2242 return NULL;
2243 }
2244 if (lastdot == NULL) {
2245 error = PyDict_SetItem(globals, pkgstr, Py_None);
2246 if (error) {
2247 PyErr_SetString(PyExc_ValueError,
2248 "Could not set __package__");
2249 return NULL;
2250 }
2251 return Py_None;
2252 }
2253 len = lastdot - start;
2254 if (len >= MAXPATHLEN) {
2255 PyErr_SetString(PyExc_ValueError,
2256 "Module name too long");
2257 return NULL;
2258 }
2259 strncpy(buf, start, len);
2260 buf[len] = '\0';
2261 pkgname = PyString_FromString(buf);
2262 if (pkgname == NULL) {
2263 return NULL;
2264 }
2265 error = PyDict_SetItem(globals, pkgstr, pkgname);
2266 Py_DECREF(pkgname);
2267 if (error) {
2268 PyErr_SetString(PyExc_ValueError,
2269 "Could not set __package__");
2270 return NULL;
2271 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002272 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002273 }
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002274 while (--level > 0) {
2275 char *dot = strrchr(buf, '.');
2276 if (dot == NULL) {
2277 PyErr_SetString(PyExc_ValueError,
Georg Brandl98775df2006-09-06 06:09:31 +00002278 "Attempted relative import beyond "
2279 "toplevel package");
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002280 return NULL;
2281 }
2282 *dot = '\0';
2283 }
2284 *p_buflen = strlen(buf);
2285
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002286 modules = PyImport_GetModuleDict();
2287 parent = PyDict_GetItemString(modules, buf);
2288 if (parent == NULL)
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002289 PyErr_Format(PyExc_SystemError,
2290 "Parent module '%.200s' not loaded", buf);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002291 return parent;
2292 /* We expect, but can't guarantee, if parent != None, that:
2293 - parent.__name__ == buf
2294 - parent.__dict__ is globals
2295 If this is violated... Who cares? */
2296}
2297
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002298/* altmod is either None or same as mod */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002299static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002300load_next(PyObject *mod, PyObject *altmod, char **p_name, char *buf,
Martin v. Löwis18e16552006-02-15 17:27:45 +00002301 Py_ssize_t *p_buflen)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002302{
2303 char *name = *p_name;
2304 char *dot = strchr(name, '.');
Fred Drake4c82b232000-06-30 16:18:57 +00002305 size_t len;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002306 char *p;
2307 PyObject *result;
2308
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002309 if (strlen(name) == 0) {
Thomas Wouters8ddab272006-04-04 16:17:02 +00002310 /* completely empty module name should only happen in
2311 'from . import' (or '__import__("")')*/
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002312 Py_INCREF(mod);
2313 *p_name = NULL;
2314 return mod;
2315 }
2316
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002317 if (dot == NULL) {
2318 *p_name = NULL;
2319 len = strlen(name);
2320 }
2321 else {
2322 *p_name = dot+1;
2323 len = dot-name;
2324 }
Guido van Rossum111c20b1998-04-11 17:38:22 +00002325 if (len == 0) {
2326 PyErr_SetString(PyExc_ValueError,
2327 "Empty module name");
2328 return NULL;
2329 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002330
2331 p = buf + *p_buflen;
2332 if (p != buf)
2333 *p++ = '.';
2334 if (p+len-buf >= MAXPATHLEN) {
2335 PyErr_SetString(PyExc_ValueError,
2336 "Module name too long");
2337 return NULL;
2338 }
2339 strncpy(p, name, len);
2340 p[len] = '\0';
2341 *p_buflen = p+len-buf;
2342
2343 result = import_submodule(mod, p, buf);
2344 if (result == Py_None && altmod != mod) {
2345 Py_DECREF(result);
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00002346 /* Here, altmod must be None and mod must not be None */
Guido van Rossum0c819451997-09-07 06:16:57 +00002347 result = import_submodule(altmod, p, p);
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00002348 if (result != NULL && result != Py_None) {
2349 if (mark_miss(buf) != 0) {
2350 Py_DECREF(result);
2351 return NULL;
2352 }
2353 strncpy(buf, name, len);
2354 buf[len] = '\0';
2355 *p_buflen = len;
2356 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002357 }
2358 if (result == NULL)
2359 return NULL;
2360
2361 if (result == Py_None) {
2362 Py_DECREF(result);
2363 PyErr_Format(PyExc_ImportError,
2364 "No module named %.200s", name);
2365 return NULL;
2366 }
2367
2368 return result;
2369}
2370
2371static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002372mark_miss(char *name)
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00002373{
2374 PyObject *modules = PyImport_GetModuleDict();
2375 return PyDict_SetItemString(modules, name, Py_None);
2376}
2377
2378static int
Martin v. Löwis18e16552006-02-15 17:27:45 +00002379ensure_fromlist(PyObject *mod, PyObject *fromlist, char *buf, Py_ssize_t buflen,
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002380 int recursive)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002381{
2382 int i;
2383
2384 if (!PyObject_HasAttrString(mod, "__path__"))
2385 return 1;
2386
2387 for (i = 0; ; i++) {
2388 PyObject *item = PySequence_GetItem(fromlist, i);
2389 int hasit;
2390 if (item == NULL) {
2391 if (PyErr_ExceptionMatches(PyExc_IndexError)) {
2392 PyErr_Clear();
2393 return 1;
2394 }
2395 return 0;
2396 }
2397 if (!PyString_Check(item)) {
2398 PyErr_SetString(PyExc_TypeError,
2399 "Item in ``from list'' not a string");
2400 Py_DECREF(item);
2401 return 0;
2402 }
2403 if (PyString_AS_STRING(item)[0] == '*') {
Guido van Rossum9905ef91997-09-08 16:07:11 +00002404 PyObject *all;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002405 Py_DECREF(item);
Guido van Rossum9905ef91997-09-08 16:07:11 +00002406 /* See if the package defines __all__ */
2407 if (recursive)
2408 continue; /* Avoid endless recursion */
2409 all = PyObject_GetAttrString(mod, "__all__");
2410 if (all == NULL)
2411 PyErr_Clear();
2412 else {
Martin v. Löwis83969ee2004-03-23 16:28:13 +00002413 int ret = ensure_fromlist(mod, all, buf, buflen, 1);
Guido van Rossum9905ef91997-09-08 16:07:11 +00002414 Py_DECREF(all);
Martin v. Löwis83969ee2004-03-23 16:28:13 +00002415 if (!ret)
2416 return 0;
Guido van Rossum9905ef91997-09-08 16:07:11 +00002417 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002418 continue;
2419 }
2420 hasit = PyObject_HasAttr(mod, item);
2421 if (!hasit) {
2422 char *subname = PyString_AS_STRING(item);
2423 PyObject *submod;
2424 char *p;
2425 if (buflen + strlen(subname) >= MAXPATHLEN) {
2426 PyErr_SetString(PyExc_ValueError,
2427 "Module name too long");
2428 Py_DECREF(item);
2429 return 0;
2430 }
2431 p = buf + buflen;
2432 *p++ = '.';
2433 strcpy(p, subname);
2434 submod = import_submodule(mod, subname, buf);
2435 Py_XDECREF(submod);
2436 if (submod == NULL) {
2437 Py_DECREF(item);
2438 return 0;
2439 }
2440 }
2441 Py_DECREF(item);
2442 }
2443
Guido van Rossuma7f2e811997-10-03 15:33:32 +00002444 /* NOTREACHED */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002445}
2446
Neil Schemenauer00b09662003-06-16 21:03:07 +00002447static int
2448add_submodule(PyObject *mod, PyObject *submod, char *fullname, char *subname,
2449 PyObject *modules)
2450{
2451 if (mod == Py_None)
2452 return 1;
2453 /* Irrespective of the success of this load, make a
2454 reference to it in the parent package module. A copy gets
2455 saved in the modules dictionary under the full name, so get a
2456 reference from there, if need be. (The exception is when the
2457 load failed with a SyntaxError -- then there's no trace in
2458 sys.modules. In that case, of course, do nothing extra.) */
2459 if (submod == NULL) {
2460 submod = PyDict_GetItemString(modules, fullname);
2461 if (submod == NULL)
2462 return 1;
2463 }
2464 if (PyModule_Check(mod)) {
2465 /* We can't use setattr here since it can give a
2466 * spurious warning if the submodule name shadows a
2467 * builtin name */
2468 PyObject *dict = PyModule_GetDict(mod);
2469 if (!dict)
2470 return 0;
2471 if (PyDict_SetItemString(dict, subname, submod) < 0)
2472 return 0;
2473 }
2474 else {
2475 if (PyObject_SetAttrString(mod, subname, submod) < 0)
2476 return 0;
2477 }
2478 return 1;
2479}
2480
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002481static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002482import_submodule(PyObject *mod, char *subname, char *fullname)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002483{
Guido van Rossum25ce5661997-08-02 03:10:38 +00002484 PyObject *modules = PyImport_GetModuleDict();
Neil Schemenauer00b09662003-06-16 21:03:07 +00002485 PyObject *m = NULL;
Guido van Rossum74e6a111994-08-29 12:54:38 +00002486
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002487 /* Require:
2488 if mod == None: subname == fullname
2489 else: mod.__name__ + "." + subname == fullname
2490 */
2491
Tim Peters50d8d372001-02-28 05:34:27 +00002492 if ((m = PyDict_GetItemString(modules, fullname)) != NULL) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00002493 Py_INCREF(m);
Guido van Rossum7f9fa971995-01-20 16:53:12 +00002494 }
2495 else {
Just van Rossum52e14d62002-12-30 22:08:05 +00002496 PyObject *path, *loader = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002497 char buf[MAXPATHLEN+1];
2498 struct filedescr *fdp;
2499 FILE *fp = NULL;
2500
Guido van Rossum9c0afe51998-05-19 15:09:05 +00002501 if (mod == Py_None)
2502 path = NULL;
2503 else {
2504 path = PyObject_GetAttrString(mod, "__path__");
2505 if (path == NULL) {
2506 PyErr_Clear();
2507 Py_INCREF(Py_None);
2508 return Py_None;
2509 }
2510 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002511
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002512 buf[0] = '\0';
Just van Rossum52e14d62002-12-30 22:08:05 +00002513 fdp = find_module(fullname, subname, path, buf, MAXPATHLEN+1,
2514 &fp, &loader);
Guido van Rossumb68cd421998-07-01 17:36:26 +00002515 Py_XDECREF(path);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002516 if (fdp == NULL) {
2517 if (!PyErr_ExceptionMatches(PyExc_ImportError))
2518 return NULL;
2519 PyErr_Clear();
2520 Py_INCREF(Py_None);
2521 return Py_None;
2522 }
Just van Rossum52e14d62002-12-30 22:08:05 +00002523 m = load_module(fullname, fp, buf, fdp->type, loader);
2524 Py_XDECREF(loader);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002525 if (fp)
2526 fclose(fp);
Neil Schemenauer00b09662003-06-16 21:03:07 +00002527 if (!add_submodule(mod, m, fullname, subname, modules)) {
2528 Py_XDECREF(m);
2529 m = NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002530 }
Guido van Rossum74e6a111994-08-29 12:54:38 +00002531 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002532
2533 return m;
Guido van Rossum74e6a111994-08-29 12:54:38 +00002534}
2535
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002536
2537/* Re-import a module of any kind and return its module object, WITH
2538 INCREMENTED REFERENCE COUNT */
2539
Guido van Rossum79f25d91997-04-29 20:08:16 +00002540PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002541PyImport_ReloadModule(PyObject *m)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002542{
Collin Winter47c52a82007-03-13 23:02:15 +00002543 PyInterpreterState *interp = PyThreadState_Get()->interp;
2544 PyObject *modules_reloading = interp->modules_reloading;
Guido van Rossum25ce5661997-08-02 03:10:38 +00002545 PyObject *modules = PyImport_GetModuleDict();
Collin Winter276887b2007-03-12 16:11:39 +00002546 PyObject *path = NULL, *loader = NULL, *existing_m = NULL;
Guido van Rossum222ef561997-09-06 19:41:09 +00002547 char *name, *subname;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002548 char buf[MAXPATHLEN+1];
2549 struct filedescr *fdp;
2550 FILE *fp = NULL;
Tim Peters1cd70172004-08-02 03:52:12 +00002551 PyObject *newm;
Collin Winter47c52a82007-03-13 23:02:15 +00002552
2553 if (modules_reloading == NULL) {
2554 Py_FatalError("PyImport_ReloadModule: "
Neal Norwitz2fca81c2007-05-30 04:53:41 +00002555 "no modules_reloading dictionary!");
Collin Winter47c52a82007-03-13 23:02:15 +00002556 return NULL;
2557 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002558
Guido van Rossum79f25d91997-04-29 20:08:16 +00002559 if (m == NULL || !PyModule_Check(m)) {
2560 PyErr_SetString(PyExc_TypeError,
2561 "reload() argument must be module");
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002562 return NULL;
2563 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002564 name = PyModule_GetName(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002565 if (name == NULL)
2566 return NULL;
Guido van Rossum25ce5661997-08-02 03:10:38 +00002567 if (m != PyDict_GetItemString(modules, name)) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002568 PyErr_Format(PyExc_ImportError,
2569 "reload(): module %.200s not in sys.modules",
2570 name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002571 return NULL;
2572 }
Neal Norwitz75c7c802007-03-13 05:31:38 +00002573 existing_m = PyDict_GetItemString(modules_reloading, name);
2574 if (existing_m != NULL) {
2575 /* Due to a recursive reload, this module is already
2576 being reloaded. */
2577 Py_INCREF(existing_m);
2578 return existing_m;
Collin Winter276887b2007-03-12 16:11:39 +00002579 }
Neal Norwitz75c7c802007-03-13 05:31:38 +00002580 if (PyDict_SetItemString(modules_reloading, name, m) < 0)
2581 return NULL;
Collin Winter276887b2007-03-12 16:11:39 +00002582
Guido van Rossum222ef561997-09-06 19:41:09 +00002583 subname = strrchr(name, '.');
2584 if (subname == NULL)
2585 subname = name;
2586 else {
2587 PyObject *parentname, *parent;
2588 parentname = PyString_FromStringAndSize(name, (subname-name));
Collin Winter276887b2007-03-12 16:11:39 +00002589 if (parentname == NULL) {
2590 imp_modules_reloading_clear();
Guido van Rossum222ef561997-09-06 19:41:09 +00002591 return NULL;
Neal Norwitz75c7c802007-03-13 05:31:38 +00002592 }
Guido van Rossum222ef561997-09-06 19:41:09 +00002593 parent = PyDict_GetItem(modules, parentname);
2594 if (parent == NULL) {
2595 PyErr_Format(PyExc_ImportError,
2596 "reload(): parent %.200s not in sys.modules",
Georg Brandl0c55f292005-09-14 06:56:20 +00002597 PyString_AS_STRING(parentname));
2598 Py_DECREF(parentname);
Neal Norwitz2fca81c2007-05-30 04:53:41 +00002599 imp_modules_reloading_clear();
Guido van Rossum222ef561997-09-06 19:41:09 +00002600 return NULL;
2601 }
Georg Brandl0c55f292005-09-14 06:56:20 +00002602 Py_DECREF(parentname);
Guido van Rossum222ef561997-09-06 19:41:09 +00002603 subname++;
2604 path = PyObject_GetAttrString(parent, "__path__");
2605 if (path == NULL)
2606 PyErr_Clear();
2607 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002608 buf[0] = '\0';
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00002609 fdp = find_module(name, subname, path, buf, MAXPATHLEN+1, &fp, &loader);
Guido van Rossum222ef561997-09-06 19:41:09 +00002610 Py_XDECREF(path);
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00002611
2612 if (fdp == NULL) {
2613 Py_XDECREF(loader);
Collin Winter276887b2007-03-12 16:11:39 +00002614 imp_modules_reloading_clear();
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002615 return NULL;
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00002616 }
2617
2618 newm = load_module(name, fp, buf, fdp->type, loader);
2619 Py_XDECREF(loader);
2620
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002621 if (fp)
2622 fclose(fp);
Tim Peters1cd70172004-08-02 03:52:12 +00002623 if (newm == NULL) {
2624 /* load_module probably removed name from modules because of
2625 * the error. Put back the original module object. We're
2626 * going to return NULL in this case regardless of whether
2627 * replacing name succeeds, so the return value is ignored.
2628 */
2629 PyDict_SetItemString(modules, name, m);
2630 }
Neal Norwitz75c7c802007-03-13 05:31:38 +00002631 imp_modules_reloading_clear();
Tim Peters1cd70172004-08-02 03:52:12 +00002632 return newm;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002633}
2634
2635
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002636/* Higher-level import emulator which emulates the "import" statement
2637 more accurately -- it invokes the __import__() function from the
2638 builtins of the current globals. This means that the import is
2639 done using whatever import hooks are installed in the current
Guido van Rossum6058eb41998-12-21 19:51:00 +00002640 environment, e.g. by "rexec".
2641 A dummy list ["__doc__"] is passed as the 4th argument so that
2642 e.g. PyImport_Import(PyString_FromString("win32com.client.gencache"))
2643 will return <module "gencache"> instead of <module "win32com">. */
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002644
2645PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002646PyImport_Import(PyObject *module_name)
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002647{
2648 static PyObject *silly_list = NULL;
2649 static PyObject *builtins_str = NULL;
2650 static PyObject *import_str = NULL;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002651 PyObject *globals = NULL;
2652 PyObject *import = NULL;
2653 PyObject *builtins = NULL;
2654 PyObject *r = NULL;
2655
2656 /* Initialize constant string objects */
2657 if (silly_list == NULL) {
2658 import_str = PyString_InternFromString("__import__");
2659 if (import_str == NULL)
2660 return NULL;
2661 builtins_str = PyString_InternFromString("__builtins__");
2662 if (builtins_str == NULL)
2663 return NULL;
2664 silly_list = Py_BuildValue("[s]", "__doc__");
2665 if (silly_list == NULL)
2666 return NULL;
2667 }
2668
2669 /* Get the builtins from current globals */
2670 globals = PyEval_GetGlobals();
Guido van Rossum85cd1d62001-02-20 21:43:24 +00002671 if (globals != NULL) {
Guido van Rossum66468561998-10-22 15:46:50 +00002672 Py_INCREF(globals);
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002673 builtins = PyObject_GetItem(globals, builtins_str);
2674 if (builtins == NULL)
2675 goto err;
2676 }
2677 else {
2678 /* No globals -- use standard builtins, and fake globals */
2679 PyErr_Clear();
2680
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002681 builtins = PyImport_ImportModuleLevel("__builtin__",
2682 NULL, NULL, NULL, 0);
Guido van Rossum85cd1d62001-02-20 21:43:24 +00002683 if (builtins == NULL)
2684 return NULL;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002685 globals = Py_BuildValue("{OO}", builtins_str, builtins);
2686 if (globals == NULL)
2687 goto err;
2688 }
2689
2690 /* Get the __import__ function from the builtins */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002691 if (PyDict_Check(builtins)) {
Fred Drakea76ba6e2001-03-06 06:31:15 +00002692 import = PyObject_GetItem(builtins, import_str);
Tim Peters6d6c1a32001-08-02 04:15:00 +00002693 if (import == NULL)
2694 PyErr_SetObject(PyExc_KeyError, import_str);
2695 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002696 else
Fred Drakea76ba6e2001-03-06 06:31:15 +00002697 import = PyObject_GetAttr(builtins, import_str);
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002698 if (import == NULL)
2699 goto err;
2700
Christian Heimes000a0742008-01-03 22:16:32 +00002701 /* Call the __import__ function with the proper argument list
2702 * Always use absolute import here. */
2703 r = PyObject_CallFunction(import, "OOOOi", module_name, globals,
2704 globals, silly_list, 0, NULL);
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002705
2706 err:
2707 Py_XDECREF(globals);
2708 Py_XDECREF(builtins);
2709 Py_XDECREF(import);
Tim Peters50d8d372001-02-28 05:34:27 +00002710
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002711 return r;
2712}
2713
2714
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002715/* Module 'imp' provides Python access to the primitives used for
2716 importing modules.
2717*/
2718
Guido van Rossum79f25d91997-04-29 20:08:16 +00002719static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +00002720imp_get_magic(PyObject *self, PyObject *noargs)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002721{
2722 char buf[4];
2723
Guido van Rossum96774c12000-05-01 20:19:08 +00002724 buf[0] = (char) ((pyc_magic >> 0) & 0xff);
2725 buf[1] = (char) ((pyc_magic >> 8) & 0xff);
2726 buf[2] = (char) ((pyc_magic >> 16) & 0xff);
2727 buf[3] = (char) ((pyc_magic >> 24) & 0xff);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002728
Guido van Rossum79f25d91997-04-29 20:08:16 +00002729 return PyString_FromStringAndSize(buf, 4);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002730}
2731
Guido van Rossum79f25d91997-04-29 20:08:16 +00002732static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +00002733imp_get_suffixes(PyObject *self, PyObject *noargs)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002734{
Guido van Rossum79f25d91997-04-29 20:08:16 +00002735 PyObject *list;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002736 struct filedescr *fdp;
2737
Guido van Rossum79f25d91997-04-29 20:08:16 +00002738 list = PyList_New(0);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002739 if (list == NULL)
2740 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002741 for (fdp = _PyImport_Filetab; fdp->suffix != NULL; fdp++) {
2742 PyObject *item = Py_BuildValue("ssi",
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002743 fdp->suffix, fdp->mode, fdp->type);
2744 if (item == NULL) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00002745 Py_DECREF(list);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002746 return NULL;
2747 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002748 if (PyList_Append(list, item) < 0) {
2749 Py_DECREF(list);
2750 Py_DECREF(item);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002751 return NULL;
2752 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002753 Py_DECREF(item);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002754 }
2755 return list;
2756}
2757
Guido van Rossum79f25d91997-04-29 20:08:16 +00002758static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002759call_find_module(char *name, PyObject *path)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002760{
Tim Petersdbd9ba62000-07-09 03:09:57 +00002761 extern int fclose(FILE *);
Guido van Rossum79f25d91997-04-29 20:08:16 +00002762 PyObject *fob, *ret;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002763 struct filedescr *fdp;
2764 char pathname[MAXPATHLEN+1];
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002765 FILE *fp = NULL;
2766
2767 pathname[0] = '\0';
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002768 if (path == Py_None)
2769 path = NULL;
Just van Rossum52e14d62002-12-30 22:08:05 +00002770 fdp = find_module(NULL, name, path, pathname, MAXPATHLEN+1, &fp, NULL);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002771 if (fdp == NULL)
2772 return NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002773 if (fp != NULL) {
2774 fob = PyFile_FromFile(fp, pathname, fdp->mode, fclose);
2775 if (fob == NULL) {
2776 fclose(fp);
2777 return NULL;
2778 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002779 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002780 else {
2781 fob = Py_None;
2782 Py_INCREF(fob);
Tim Peters50d8d372001-02-28 05:34:27 +00002783 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002784 ret = Py_BuildValue("Os(ssi)",
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002785 fob, pathname, fdp->suffix, fdp->mode, fdp->type);
Guido van Rossum79f25d91997-04-29 20:08:16 +00002786 Py_DECREF(fob);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002787 return ret;
2788}
2789
Guido van Rossum79f25d91997-04-29 20:08:16 +00002790static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002791imp_find_module(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002792{
2793 char *name;
2794 PyObject *path = NULL;
Guido van Rossum43713e52000-02-29 13:59:29 +00002795 if (!PyArg_ParseTuple(args, "s|O:find_module", &name, &path))
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002796 return NULL;
2797 return call_find_module(name, path);
2798}
2799
2800static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002801imp_init_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002802{
2803 char *name;
2804 int ret;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002805 PyObject *m;
Guido van Rossum43713e52000-02-29 13:59:29 +00002806 if (!PyArg_ParseTuple(args, "s:init_builtin", &name))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002807 return NULL;
2808 ret = init_builtin(name);
2809 if (ret < 0)
2810 return NULL;
2811 if (ret == 0) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00002812 Py_INCREF(Py_None);
2813 return Py_None;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002814 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002815 m = PyImport_AddModule(name);
2816 Py_XINCREF(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002817 return m;
2818}
2819
Guido van Rossum79f25d91997-04-29 20:08:16 +00002820static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002821imp_init_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002822{
2823 char *name;
2824 int ret;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002825 PyObject *m;
Guido van Rossum43713e52000-02-29 13:59:29 +00002826 if (!PyArg_ParseTuple(args, "s:init_frozen", &name))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002827 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002828 ret = PyImport_ImportFrozenModule(name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002829 if (ret < 0)
2830 return NULL;
2831 if (ret == 0) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00002832 Py_INCREF(Py_None);
2833 return Py_None;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002834 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002835 m = PyImport_AddModule(name);
2836 Py_XINCREF(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002837 return m;
2838}
2839
Guido van Rossum79f25d91997-04-29 20:08:16 +00002840static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002841imp_get_frozen_object(PyObject *self, PyObject *args)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002842{
2843 char *name;
Jack Jansen95ffa231995-10-03 14:38:41 +00002844
Guido van Rossum43713e52000-02-29 13:59:29 +00002845 if (!PyArg_ParseTuple(args, "s:get_frozen_object", &name))
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002846 return NULL;
2847 return get_frozen_object(name);
2848}
2849
Guido van Rossum79f25d91997-04-29 20:08:16 +00002850static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002851imp_is_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002852{
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002853 char *name;
Guido van Rossum43713e52000-02-29 13:59:29 +00002854 if (!PyArg_ParseTuple(args, "s:is_builtin", &name))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002855 return NULL;
Guido van Rossum50ee94f2002-04-09 18:00:58 +00002856 return PyInt_FromLong(is_builtin(name));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002857}
2858
Guido van Rossum79f25d91997-04-29 20:08:16 +00002859static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002860imp_is_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002861{
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002862 char *name;
Guido van Rossum323bf5e1998-06-24 03:54:06 +00002863 struct _frozen *p;
Guido van Rossum43713e52000-02-29 13:59:29 +00002864 if (!PyArg_ParseTuple(args, "s:is_frozen", &name))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002865 return NULL;
Guido van Rossum323bf5e1998-06-24 03:54:06 +00002866 p = find_frozen(name);
Guido van Rossumb8bff3f2002-04-07 06:34:38 +00002867 return PyBool_FromLong((long) (p == NULL ? 0 : p->size));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002868}
2869
2870static FILE *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002871get_file(char *pathname, PyObject *fob, char *mode)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002872{
2873 FILE *fp;
2874 if (fob == NULL) {
Tim Peters86c7d2f2004-08-01 23:24:21 +00002875 if (mode[0] == 'U')
Jeremy Hylton4ae6fae2002-05-30 17:15:25 +00002876 mode = "r" PY_STDIOTEXTMODE;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002877 fp = fopen(pathname, mode);
2878 if (fp == NULL)
Guido van Rossum79f25d91997-04-29 20:08:16 +00002879 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002880 }
2881 else {
Guido van Rossum79f25d91997-04-29 20:08:16 +00002882 fp = PyFile_AsFile(fob);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002883 if (fp == NULL)
Guido van Rossum79f25d91997-04-29 20:08:16 +00002884 PyErr_SetString(PyExc_ValueError,
2885 "bad/closed file object");
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002886 }
2887 return fp;
2888}
2889
Guido van Rossum79f25d91997-04-29 20:08:16 +00002890static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002891imp_load_compiled(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002892{
2893 char *name;
2894 char *pathname;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002895 PyObject *fob = NULL;
2896 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002897 FILE *fp;
Guido van Rossum43713e52000-02-29 13:59:29 +00002898 if (!PyArg_ParseTuple(args, "ss|O!:load_compiled", &name, &pathname,
Guido van Rossum79f25d91997-04-29 20:08:16 +00002899 &PyFile_Type, &fob))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002900 return NULL;
2901 fp = get_file(pathname, fob, "rb");
2902 if (fp == NULL)
2903 return NULL;
2904 m = load_compiled_module(name, pathname, fp);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002905 if (fob == NULL)
2906 fclose(fp);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002907 return m;
2908}
2909
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002910#ifdef HAVE_DYNAMIC_LOADING
2911
Guido van Rossum79f25d91997-04-29 20:08:16 +00002912static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002913imp_load_dynamic(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002914{
2915 char *name;
2916 char *pathname;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002917 PyObject *fob = NULL;
2918 PyObject *m;
Guido van Rossum7faeab31995-07-07 22:50:36 +00002919 FILE *fp = NULL;
Guido van Rossum43713e52000-02-29 13:59:29 +00002920 if (!PyArg_ParseTuple(args, "ss|O!:load_dynamic", &name, &pathname,
Guido van Rossum79f25d91997-04-29 20:08:16 +00002921 &PyFile_Type, &fob))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002922 return NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002923 if (fob) {
Guido van Rossum7faeab31995-07-07 22:50:36 +00002924 fp = get_file(pathname, fob, "r");
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002925 if (fp == NULL)
2926 return NULL;
2927 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002928 m = _PyImport_LoadDynamicModule(name, pathname, fp);
Guido van Rossum7faeab31995-07-07 22:50:36 +00002929 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002930}
2931
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002932#endif /* HAVE_DYNAMIC_LOADING */
2933
Guido van Rossum79f25d91997-04-29 20:08:16 +00002934static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002935imp_load_source(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002936{
2937 char *name;
2938 char *pathname;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002939 PyObject *fob = NULL;
2940 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002941 FILE *fp;
Guido van Rossum43713e52000-02-29 13:59:29 +00002942 if (!PyArg_ParseTuple(args, "ss|O!:load_source", &name, &pathname,
Guido van Rossum79f25d91997-04-29 20:08:16 +00002943 &PyFile_Type, &fob))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002944 return NULL;
2945 fp = get_file(pathname, fob, "r");
2946 if (fp == NULL)
2947 return NULL;
2948 m = load_source_module(name, pathname, fp);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002949 if (fob == NULL)
2950 fclose(fp);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002951 return m;
2952}
2953
Guido van Rossum79f25d91997-04-29 20:08:16 +00002954static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002955imp_load_module(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002956{
2957 char *name;
2958 PyObject *fob;
2959 char *pathname;
2960 char *suffix; /* Unused */
2961 char *mode;
2962 int type;
2963 FILE *fp;
2964
Guido van Rossum43713e52000-02-29 13:59:29 +00002965 if (!PyArg_ParseTuple(args, "sOs(ssi):load_module",
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002966 &name, &fob, &pathname,
2967 &suffix, &mode, &type))
2968 return NULL;
Guido van Rossum5e2c5fa2002-05-30 17:33:07 +00002969 if (*mode) {
2970 /* Mode must start with 'r' or 'U' and must not contain '+'.
2971 Implicit in this test is the assumption that the mode
2972 may contain other modifiers like 'b' or 't'. */
2973
2974 if (!(*mode == 'r' || *mode == 'U') || strchr(mode, '+')) {
Jeremy Hylton4ae6fae2002-05-30 17:15:25 +00002975 PyErr_Format(PyExc_ValueError,
2976 "invalid file open mode %.200s", mode);
2977 return NULL;
Guido van Rossum5e2c5fa2002-05-30 17:33:07 +00002978 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002979 }
2980 if (fob == Py_None)
2981 fp = NULL;
2982 else {
2983 if (!PyFile_Check(fob)) {
2984 PyErr_SetString(PyExc_ValueError,
2985 "load_module arg#2 should be a file or None");
2986 return NULL;
2987 }
2988 fp = get_file(pathname, fob, mode);
2989 if (fp == NULL)
2990 return NULL;
2991 }
Just van Rossum52e14d62002-12-30 22:08:05 +00002992 return load_module(name, fp, pathname, type, NULL);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002993}
2994
2995static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002996imp_load_package(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002997{
2998 char *name;
2999 char *pathname;
Guido van Rossum43713e52000-02-29 13:59:29 +00003000 if (!PyArg_ParseTuple(args, "ss:load_package", &name, &pathname))
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003001 return NULL;
3002 return load_package(name, pathname);
3003}
3004
3005static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003006imp_new_module(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003007{
3008 char *name;
Guido van Rossum43713e52000-02-29 13:59:29 +00003009 if (!PyArg_ParseTuple(args, "s:new_module", &name))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003010 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +00003011 return PyModule_New(name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003012}
3013
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003014/* Doc strings */
3015
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003016PyDoc_STRVAR(doc_imp,
3017"This module provides the components needed to build your own\n\
3018__import__ function. Undocumented functions are obsolete.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003019
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003020PyDoc_STRVAR(doc_find_module,
3021"find_module(name, [path]) -> (file, filename, (suffix, mode, type))\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003022Search for a module. If path is omitted or None, search for a\n\
3023built-in, frozen or special module and continue search in sys.path.\n\
3024The module name cannot contain '.'; to search for a submodule of a\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003025package, pass the submodule name and the package's __path__.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003026
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003027PyDoc_STRVAR(doc_load_module,
3028"load_module(name, file, filename, (suffix, mode, type)) -> module\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003029Load a module, given information returned by find_module().\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003030The module name must include the full package name, if any.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003031
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003032PyDoc_STRVAR(doc_get_magic,
3033"get_magic() -> string\n\
3034Return the magic number for .pyc or .pyo files.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003035
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003036PyDoc_STRVAR(doc_get_suffixes,
3037"get_suffixes() -> [(suffix, mode, type), ...]\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003038Return a list of (suffix, mode, type) tuples describing the files\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003039that find_module() looks for.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003040
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003041PyDoc_STRVAR(doc_new_module,
3042"new_module(name) -> module\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003043Create a new module. Do not enter it in sys.modules.\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003044The module name must include the full package name, if any.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003045
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003046PyDoc_STRVAR(doc_lock_held,
Tim Petersa7c65092004-08-01 23:26:05 +00003047"lock_held() -> boolean\n\
3048Return True if the import lock is currently held, else False.\n\
3049On platforms without threads, return False.");
Tim Peters69232342001-08-30 05:16:13 +00003050
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00003051PyDoc_STRVAR(doc_acquire_lock,
3052"acquire_lock() -> None\n\
Neal Norwitz2294c0d2003-02-12 23:02:21 +00003053Acquires the interpreter's import lock for the current thread.\n\
3054This lock should be used by import hooks to ensure thread-safety\n\
3055when importing modules.\n\
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00003056On platforms without threads, this function does nothing.");
3057
3058PyDoc_STRVAR(doc_release_lock,
3059"release_lock() -> None\n\
3060Release the interpreter's import lock.\n\
3061On platforms without threads, this function does nothing.");
3062
Guido van Rossum79f25d91997-04-29 20:08:16 +00003063static PyMethodDef imp_methods[] = {
Neal Norwitz08ea61a2003-02-17 18:18:00 +00003064 {"find_module", imp_find_module, METH_VARARGS, doc_find_module},
3065 {"get_magic", imp_get_magic, METH_NOARGS, doc_get_magic},
3066 {"get_suffixes", imp_get_suffixes, METH_NOARGS, doc_get_suffixes},
3067 {"load_module", imp_load_module, METH_VARARGS, doc_load_module},
3068 {"new_module", imp_new_module, METH_VARARGS, doc_new_module},
3069 {"lock_held", imp_lock_held, METH_NOARGS, doc_lock_held},
3070 {"acquire_lock", imp_acquire_lock, METH_NOARGS, doc_acquire_lock},
3071 {"release_lock", imp_release_lock, METH_NOARGS, doc_release_lock},
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003072 /* The rest are obsolete */
Neal Norwitz031829d2002-03-31 14:37:44 +00003073 {"get_frozen_object", imp_get_frozen_object, METH_VARARGS},
3074 {"init_builtin", imp_init_builtin, METH_VARARGS},
3075 {"init_frozen", imp_init_frozen, METH_VARARGS},
3076 {"is_builtin", imp_is_builtin, METH_VARARGS},
3077 {"is_frozen", imp_is_frozen, METH_VARARGS},
3078 {"load_compiled", imp_load_compiled, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003079#ifdef HAVE_DYNAMIC_LOADING
Neal Norwitz031829d2002-03-31 14:37:44 +00003080 {"load_dynamic", imp_load_dynamic, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003081#endif
Neal Norwitz031829d2002-03-31 14:37:44 +00003082 {"load_package", imp_load_package, METH_VARARGS},
Neal Norwitz031829d2002-03-31 14:37:44 +00003083 {"load_source", imp_load_source, METH_VARARGS},
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003084 {NULL, NULL} /* sentinel */
3085};
3086
Guido van Rossum1a8791e1998-08-04 22:46:29 +00003087static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003088setint(PyObject *d, char *name, int value)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003089{
3090 PyObject *v;
3091 int err;
3092
3093 v = PyInt_FromLong((long)value);
3094 err = PyDict_SetItemString(d, name, v);
3095 Py_XDECREF(v);
3096 return err;
3097}
3098
Phillip J. Ebyf7575d02006-07-28 21:12:07 +00003099typedef struct {
3100 PyObject_HEAD
3101} NullImporter;
3102
3103static int
3104NullImporter_init(NullImporter *self, PyObject *args, PyObject *kwds)
3105{
3106 char *path;
Christian Heimescea681b2007-11-07 17:50:54 +00003107 Py_ssize_t pathlen;
Phillip J. Ebyf7575d02006-07-28 21:12:07 +00003108
3109 if (!_PyArg_NoKeywords("NullImporter()", kwds))
3110 return -1;
3111
3112 if (!PyArg_ParseTuple(args, "s:NullImporter",
3113 &path))
3114 return -1;
3115
Christian Heimescea681b2007-11-07 17:50:54 +00003116 pathlen = strlen(path);
3117 if (pathlen == 0) {
Phillip J. Ebyf7575d02006-07-28 21:12:07 +00003118 PyErr_SetString(PyExc_ImportError, "empty pathname");
3119 return -1;
3120 } else {
3121#ifndef RISCOS
3122 struct stat statbuf;
3123 int rv;
3124
3125 rv = stat(path, &statbuf);
Christian Heimes004c1c12007-11-07 18:30:22 +00003126#ifdef MS_WINDOWS
3127 /* MS Windows stat() chokes on paths like C:\path\. Try to
3128 * recover *one* time by stripping off a trailing slash or
3129 * backslash. http://bugs.python.org/issue1293
3130 */
Christian Heimescea681b2007-11-07 17:50:54 +00003131 if (rv != 0 && pathlen <= MAXPATHLEN &&
3132 (path[pathlen-1] == '/' || path[pathlen-1] == '\\')) {
3133 char mangled[MAXPATHLEN+1];
3134
3135 strcpy(mangled, path);
3136 mangled[pathlen-1] = '\0';
3137 rv = stat(mangled, &statbuf);
3138 }
Christian Heimescea681b2007-11-07 17:50:54 +00003139#endif
Phillip J. Ebyf7575d02006-07-28 21:12:07 +00003140 if (rv == 0) {
3141 /* it exists */
3142 if (S_ISDIR(statbuf.st_mode)) {
3143 /* it's a directory */
3144 PyErr_SetString(PyExc_ImportError,
3145 "existing directory");
3146 return -1;
3147 }
3148 }
3149#else
3150 if (object_exists(path)) {
3151 /* it exists */
3152 if (isdir(path)) {
3153 /* it's a directory */
3154 PyErr_SetString(PyExc_ImportError,
3155 "existing directory");
3156 return -1;
3157 }
3158 }
3159#endif
3160 }
3161 return 0;
3162}
3163
3164static PyObject *
3165NullImporter_find_module(NullImporter *self, PyObject *args)
3166{
3167 Py_RETURN_NONE;
3168}
3169
3170static PyMethodDef NullImporter_methods[] = {
3171 {"find_module", (PyCFunction)NullImporter_find_module, METH_VARARGS,
3172 "Always return None"
3173 },
3174 {NULL} /* Sentinel */
3175};
3176
3177
Nick Coghlan327a39b2007-11-18 11:56:28 +00003178PyTypeObject PyNullImporter_Type = {
Martin v. Löwis68192102007-07-21 06:55:02 +00003179 PyVarObject_HEAD_INIT(NULL, 0)
Phillip J. Ebyf7575d02006-07-28 21:12:07 +00003180 "imp.NullImporter", /*tp_name*/
3181 sizeof(NullImporter), /*tp_basicsize*/
3182 0, /*tp_itemsize*/
3183 0, /*tp_dealloc*/
3184 0, /*tp_print*/
3185 0, /*tp_getattr*/
3186 0, /*tp_setattr*/
3187 0, /*tp_compare*/
3188 0, /*tp_repr*/
3189 0, /*tp_as_number*/
3190 0, /*tp_as_sequence*/
3191 0, /*tp_as_mapping*/
3192 0, /*tp_hash */
3193 0, /*tp_call*/
3194 0, /*tp_str*/
3195 0, /*tp_getattro*/
3196 0, /*tp_setattro*/
3197 0, /*tp_as_buffer*/
3198 Py_TPFLAGS_DEFAULT, /*tp_flags*/
3199 "Null importer object", /* tp_doc */
3200 0, /* tp_traverse */
3201 0, /* tp_clear */
3202 0, /* tp_richcompare */
3203 0, /* tp_weaklistoffset */
3204 0, /* tp_iter */
3205 0, /* tp_iternext */
3206 NullImporter_methods, /* tp_methods */
3207 0, /* tp_members */
3208 0, /* tp_getset */
3209 0, /* tp_base */
3210 0, /* tp_dict */
3211 0, /* tp_descr_get */
3212 0, /* tp_descr_set */
3213 0, /* tp_dictoffset */
3214 (initproc)NullImporter_init, /* tp_init */
3215 0, /* tp_alloc */
3216 PyType_GenericNew /* tp_new */
3217};
3218
3219
Jason Tishler6bc06ec2003-09-04 11:59:50 +00003220PyMODINIT_FUNC
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003221initimp(void)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003222{
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003223 PyObject *m, *d;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003224
Nick Coghlan327a39b2007-11-18 11:56:28 +00003225 if (PyType_Ready(&PyNullImporter_Type) < 0)
Phillip J. Ebyf7575d02006-07-28 21:12:07 +00003226 goto failure;
3227
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003228 m = Py_InitModule4("imp", imp_methods, doc_imp,
3229 NULL, PYTHON_API_VERSION);
Neal Norwitz1ac754f2006-01-19 06:09:39 +00003230 if (m == NULL)
3231 goto failure;
Guido van Rossum79f25d91997-04-29 20:08:16 +00003232 d = PyModule_GetDict(m);
Neal Norwitz3cb31ac2006-08-13 18:10:47 +00003233 if (d == NULL)
3234 goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003235
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003236 if (setint(d, "SEARCH_ERROR", SEARCH_ERROR) < 0) goto failure;
3237 if (setint(d, "PY_SOURCE", PY_SOURCE) < 0) goto failure;
3238 if (setint(d, "PY_COMPILED", PY_COMPILED) < 0) goto failure;
3239 if (setint(d, "C_EXTENSION", C_EXTENSION) < 0) goto failure;
3240 if (setint(d, "PY_RESOURCE", PY_RESOURCE) < 0) goto failure;
3241 if (setint(d, "PKG_DIRECTORY", PKG_DIRECTORY) < 0) goto failure;
3242 if (setint(d, "C_BUILTIN", C_BUILTIN) < 0) goto failure;
3243 if (setint(d, "PY_FROZEN", PY_FROZEN) < 0) goto failure;
Guido van Rossum0f84a341998-08-06 13:36:01 +00003244 if (setint(d, "PY_CODERESOURCE", PY_CODERESOURCE) < 0) goto failure;
Just van Rossum52e14d62002-12-30 22:08:05 +00003245 if (setint(d, "IMP_HOOK", IMP_HOOK) < 0) goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003246
Nick Coghlan327a39b2007-11-18 11:56:28 +00003247 Py_INCREF(&PyNullImporter_Type);
3248 PyModule_AddObject(m, "NullImporter", (PyObject *)&PyNullImporter_Type);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003249 failure:
3250 ;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003251}
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003252
3253
Guido van Rossumb18618d2000-05-03 23:44:39 +00003254/* API for embedding applications that want to add their own entries
3255 to the table of built-in modules. This should normally be called
3256 *before* Py_Initialize(). When the table resize fails, -1 is
3257 returned and the existing table is unchanged.
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003258
3259 After a similar function by Just van Rossum. */
3260
3261int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003262PyImport_ExtendInittab(struct _inittab *newtab)
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003263{
3264 static struct _inittab *our_copy = NULL;
3265 struct _inittab *p;
3266 int i, n;
3267
3268 /* Count the number of entries in both tables */
3269 for (n = 0; newtab[n].name != NULL; n++)
3270 ;
3271 if (n == 0)
3272 return 0; /* Nothing to do */
3273 for (i = 0; PyImport_Inittab[i].name != NULL; i++)
3274 ;
3275
3276 /* Allocate new memory for the combined table */
Guido van Rossumb18618d2000-05-03 23:44:39 +00003277 p = our_copy;
3278 PyMem_RESIZE(p, struct _inittab, i+n+1);
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003279 if (p == NULL)
3280 return -1;
3281
3282 /* Copy the tables into the new memory */
3283 if (our_copy != PyImport_Inittab)
3284 memcpy(p, PyImport_Inittab, (i+1) * sizeof(struct _inittab));
3285 PyImport_Inittab = our_copy = p;
3286 memcpy(p+i, newtab, (n+1) * sizeof(struct _inittab));
3287
3288 return 0;
3289}
3290
3291/* Shorthand to add a single entry given a name and a function */
3292
3293int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003294PyImport_AppendInittab(char *name, void (*initfunc)(void))
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003295{
3296 struct _inittab newtab[2];
3297
3298 memset(newtab, '\0', sizeof newtab);
3299
3300 newtab[0].name = name;
3301 newtab[0].initfunc = initfunc;
3302
3303 return PyImport_ExtendInittab(newtab);
3304}
Anthony Baxterac6bd462006-04-13 02:06:09 +00003305
3306#ifdef __cplusplus
3307}
3308#endif