blob: ecbec156e1d9f68fb26d5d22a836e23d062f084b [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. */
83static long pyc_magic = MAGIC;
84
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;
Neal Norwitz2a399b02006-09-11 04:28:16 +0000821 PyArena *arena = PyArena_New();
822 if (arena == NULL)
823 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000824
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000825 mod = PyParser_ASTFromFile(fp, pathname, Py_file_input, 0, 0, 0,
Neal Norwitzadb69fc2005-12-17 20:54:49 +0000826 NULL, arena);
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000827 if (mod) {
Neal Norwitzadb69fc2005-12-17 20:54:49 +0000828 co = PyAST_Compile(mod, pathname, NULL, arena);
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000829 }
Neal Norwitz2a399b02006-09-11 04:28:16 +0000830 PyArena_Free(arena);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000831 return co;
832}
833
834
Guido van Rossum55a83382000-09-20 20:31:38 +0000835/* Helper to open a bytecode file for writing in exclusive mode */
836
837static FILE *
Christian Heimes40346852008-02-23 17:52:07 +0000838open_exclusive(char *filename, mode_t mode)
Guido van Rossum55a83382000-09-20 20:31:38 +0000839{
840#if defined(O_EXCL)&&defined(O_CREAT)&&defined(O_WRONLY)&&defined(O_TRUNC)
841 /* Use O_EXCL to avoid a race condition when another process tries to
842 write the same file. When that happens, our open() call fails,
843 which is just fine (since it's only a cache).
844 XXX If the file exists and is writable but the directory is not
845 writable, the file will never be written. Oh well.
846 */
847 int fd;
848 (void) unlink(filename);
Tim Peters42c83af2000-09-29 04:03:10 +0000849 fd = open(filename, O_EXCL|O_CREAT|O_WRONLY|O_TRUNC
850#ifdef O_BINARY
851 |O_BINARY /* necessary for Windows */
852#endif
Martin v. Löwis79acb9e2002-12-06 12:48:53 +0000853#ifdef __VMS
Christian Heimes40346852008-02-23 17:52:07 +0000854 , mode, "ctxt=bin", "shr=nil"
Martin v. Löwis79acb9e2002-12-06 12:48:53 +0000855#else
Christian Heimes40346852008-02-23 17:52:07 +0000856 , mode
Martin v. Löwis79acb9e2002-12-06 12:48:53 +0000857#endif
Martin v. Löwis18e16552006-02-15 17:27:45 +0000858 );
Guido van Rossum55a83382000-09-20 20:31:38 +0000859 if (fd < 0)
860 return NULL;
861 return fdopen(fd, "wb");
862#else
863 /* Best we can do -- on Windows this can't happen anyway */
864 return fopen(filename, "wb");
865#endif
866}
867
868
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000869/* Write a compiled module to a file, placing the time of last
870 modification of its source into the header.
871 Errors are ignored, if a write error occurs an attempt is made to
872 remove the file. */
873
874static void
Christian Heimes40346852008-02-23 17:52:07 +0000875write_compiled_module(PyCodeObject *co, char *cpathname, struct stat *srcstat)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000876{
877 FILE *fp;
Christian Heimes40346852008-02-23 17:52:07 +0000878 time_t mtime = srcstat->st_mtime;
879 mode_t mode = srcstat->st_mode;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000880
Christian Heimes40346852008-02-23 17:52:07 +0000881 fp = open_exclusive(cpathname, mode);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000882 if (fp == NULL) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000883 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000884 PySys_WriteStderr(
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000885 "# can't create %s\n", cpathname);
886 return;
887 }
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000888 PyMarshal_WriteLongToFile(pyc_magic, fp, Py_MARSHAL_VERSION);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000889 /* First write a 0 for mtime */
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000890 PyMarshal_WriteLongToFile(0L, fp, Py_MARSHAL_VERSION);
891 PyMarshal_WriteObjectToFile((PyObject *)co, fp, Py_MARSHAL_VERSION);
Armin Rigo01ab2792004-03-26 15:09:27 +0000892 if (fflush(fp) != 0 || ferror(fp)) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000893 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000894 PySys_WriteStderr("# can't write %s\n", cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000895 /* Don't keep partial file */
896 fclose(fp);
897 (void) unlink(cpathname);
898 return;
899 }
900 /* Now write the true mtime */
901 fseek(fp, 4L, 0);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000902 assert(mtime < LONG_MAX);
Martin v. Löwis725507b2006-03-07 12:08:51 +0000903 PyMarshal_WriteLongToFile((long)mtime, fp, Py_MARSHAL_VERSION);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000904 fflush(fp);
905 fclose(fp);
Guido van Rossum79f25d91997-04-29 20:08:16 +0000906 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000907 PySys_WriteStderr("# wrote %s\n", cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000908}
909
910
911/* Load a source module from a given file and return its module
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000912 object WITH INCREMENTED REFERENCE COUNT. If there's a matching
913 byte-compiled file, use that instead. */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000914
Guido van Rossum79f25d91997-04-29 20:08:16 +0000915static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000916load_source_module(char *name, char *pathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000917{
Christian Heimes40346852008-02-23 17:52:07 +0000918 struct stat st;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000919 FILE *fpc;
920 char buf[MAXPATHLEN+1];
921 char *cpathname;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000922 PyCodeObject *co;
923 PyObject *m;
Christian Heimes40346852008-02-23 17:52:07 +0000924
925 if (fstat(fileno(fp), &st) != 0) {
Neal Norwitz708e51a2005-10-03 04:48:15 +0000926 PyErr_Format(PyExc_RuntimeError,
Christian Heimes40346852008-02-23 17:52:07 +0000927 "unable to get file status from '%s'",
Neal Norwitz708e51a2005-10-03 04:48:15 +0000928 pathname);
Fred Drake4c82b232000-06-30 16:18:57 +0000929 return NULL;
Neal Norwitz708e51a2005-10-03 04:48:15 +0000930 }
Fred Drake4c82b232000-06-30 16:18:57 +0000931#if SIZEOF_TIME_T > 4
932 /* Python's .pyc timestamp handling presumes that the timestamp fits
933 in 4 bytes. This will be fine until sometime in the year 2038,
934 when a 4-byte signed time_t will overflow.
935 */
Christian Heimes40346852008-02-23 17:52:07 +0000936 if (st.st_mtime >> 32) {
Fred Drake4c82b232000-06-30 16:18:57 +0000937 PyErr_SetString(PyExc_OverflowError,
Fred Drakec63d3e92001-03-01 06:33:32 +0000938 "modification time overflows a 4 byte field");
Fred Drake4c82b232000-06-30 16:18:57 +0000939 return NULL;
940 }
941#endif
Tim Peters36515e22001-11-18 04:06:29 +0000942 cpathname = make_compiled_pathname(pathname, buf,
Jeremy Hylton37832f02001-04-13 17:50:20 +0000943 (size_t)MAXPATHLEN + 1);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000944 if (cpathname != NULL &&
Christian Heimes40346852008-02-23 17:52:07 +0000945 (fpc = check_compiled_module(pathname, st.st_mtime, cpathname))) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000946 co = read_compiled_module(cpathname, fpc);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000947 fclose(fpc);
948 if (co == NULL)
949 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000950 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000951 PySys_WriteStderr("import %s # precompiled from %s\n",
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000952 name, cpathname);
Guido van Rossumafd3dae1998-08-25 18:44:34 +0000953 pathname = cpathname;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000954 }
955 else {
956 co = parse_source_module(pathname, fp);
957 if (co == NULL)
958 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000959 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000960 PySys_WriteStderr("import %s # from %s\n",
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000961 name, pathname);
Georg Brandl2da0fce2008-01-07 17:09:35 +0000962 if (cpathname) {
963 PyObject *ro = PySys_GetObject("dont_write_bytecode");
964 if (ro == NULL || !PyObject_IsTrue(ro))
Christian Heimes40346852008-02-23 17:52:07 +0000965 write_compiled_module(co, cpathname, &st);
Georg Brandl2da0fce2008-01-07 17:09:35 +0000966 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000967 }
Guido van Rossumafd3dae1998-08-25 18:44:34 +0000968 m = PyImport_ExecCodeModuleEx(name, (PyObject *)co, pathname);
Guido van Rossum79f25d91997-04-29 20:08:16 +0000969 Py_DECREF(co);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000970
971 return m;
972}
973
974
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000975/* Forward */
Just van Rossum52e14d62002-12-30 22:08:05 +0000976static PyObject *load_module(char *, FILE *, char *, int, PyObject *);
977static struct filedescr *find_module(char *, char *, PyObject *,
978 char *, size_t, FILE **, PyObject **);
Tim Petersdbd9ba62000-07-09 03:09:57 +0000979static struct _frozen *find_frozen(char *name);
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000980
981/* Load a package and return its module object WITH INCREMENTED
982 REFERENCE COUNT */
983
984static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000985load_package(char *name, char *pathname)
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000986{
Tim Peters1cd70172004-08-02 03:52:12 +0000987 PyObject *m, *d;
988 PyObject *file = NULL;
989 PyObject *path = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000990 int err;
991 char buf[MAXPATHLEN+1];
992 FILE *fp = NULL;
993 struct filedescr *fdp;
994
995 m = PyImport_AddModule(name);
996 if (m == NULL)
997 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +0000998 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000999 PySys_WriteStderr("import %s # directory %s\n",
Guido van Rossum17fc85f1997-09-06 18:52:03 +00001000 name, pathname);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001001 d = PyModule_GetDict(m);
1002 file = PyString_FromString(pathname);
1003 if (file == NULL)
Tim Peters1cd70172004-08-02 03:52:12 +00001004 goto error;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001005 path = Py_BuildValue("[O]", file);
Tim Peters1cd70172004-08-02 03:52:12 +00001006 if (path == NULL)
1007 goto error;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001008 err = PyDict_SetItemString(d, "__file__", file);
1009 if (err == 0)
1010 err = PyDict_SetItemString(d, "__path__", path);
Tim Peters1cd70172004-08-02 03:52:12 +00001011 if (err != 0)
1012 goto error;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001013 buf[0] = '\0';
Just van Rossum52e14d62002-12-30 22:08:05 +00001014 fdp = find_module(name, "__init__", path, buf, sizeof(buf), &fp, NULL);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001015 if (fdp == NULL) {
1016 if (PyErr_ExceptionMatches(PyExc_ImportError)) {
1017 PyErr_Clear();
Thomas Heller25653242004-06-07 15:04:10 +00001018 Py_INCREF(m);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001019 }
1020 else
1021 m = NULL;
1022 goto cleanup;
1023 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001024 m = load_module(name, fp, buf, fdp->type, NULL);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001025 if (fp != NULL)
1026 fclose(fp);
Tim Peters1cd70172004-08-02 03:52:12 +00001027 goto cleanup;
1028
1029 error:
1030 m = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001031 cleanup:
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001032 Py_XDECREF(path);
1033 Py_XDECREF(file);
1034 return m;
1035}
1036
1037
1038/* Helper to test for built-in module */
1039
1040static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001041is_builtin(char *name)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001042{
1043 int i;
Guido van Rossum771c6c81997-10-31 18:37:24 +00001044 for (i = 0; PyImport_Inittab[i].name != NULL; i++) {
1045 if (strcmp(name, PyImport_Inittab[i].name) == 0) {
1046 if (PyImport_Inittab[i].initfunc == NULL)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001047 return -1;
1048 else
1049 return 1;
1050 }
1051 }
1052 return 0;
1053}
1054
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001055
Just van Rossum52e14d62002-12-30 22:08:05 +00001056/* Return an importer object for a sys.path/pkg.__path__ item 'p',
1057 possibly by fetching it from the path_importer_cache dict. If it
Brett Cannon94b69f62006-09-28 22:10:14 +00001058 wasn't yet cached, traverse path_hooks until a hook is found
Just van Rossum52e14d62002-12-30 22:08:05 +00001059 that can handle the path item. Return None if no hook could;
1060 this tells our caller it should fall back to the builtin
1061 import mechanism. Cache the result in path_importer_cache.
1062 Returns a borrowed reference. */
1063
1064static PyObject *
1065get_path_importer(PyObject *path_importer_cache, PyObject *path_hooks,
1066 PyObject *p)
1067{
1068 PyObject *importer;
Martin v. Löwis725507b2006-03-07 12:08:51 +00001069 Py_ssize_t j, nhooks;
Just van Rossum52e14d62002-12-30 22:08:05 +00001070
1071 /* These conditions are the caller's responsibility: */
1072 assert(PyList_Check(path_hooks));
1073 assert(PyDict_Check(path_importer_cache));
1074
1075 nhooks = PyList_Size(path_hooks);
1076 if (nhooks < 0)
1077 return NULL; /* Shouldn't happen */
1078
1079 importer = PyDict_GetItem(path_importer_cache, p);
1080 if (importer != NULL)
1081 return importer;
1082
1083 /* set path_importer_cache[p] to None to avoid recursion */
1084 if (PyDict_SetItem(path_importer_cache, p, Py_None) != 0)
1085 return NULL;
1086
1087 for (j = 0; j < nhooks; j++) {
1088 PyObject *hook = PyList_GetItem(path_hooks, j);
1089 if (hook == NULL)
1090 return NULL;
Georg Brandl684fd0c2006-05-25 19:15:31 +00001091 importer = PyObject_CallFunctionObjArgs(hook, p, NULL);
Just van Rossum52e14d62002-12-30 22:08:05 +00001092 if (importer != NULL)
1093 break;
1094
1095 if (!PyErr_ExceptionMatches(PyExc_ImportError)) {
1096 return NULL;
1097 }
1098 PyErr_Clear();
1099 }
Phillip J. Ebyf7575d02006-07-28 21:12:07 +00001100 if (importer == NULL) {
1101 importer = PyObject_CallFunctionObjArgs(
Nick Coghlan327a39b2007-11-18 11:56:28 +00001102 (PyObject *)&PyNullImporter_Type, p, NULL
Phillip J. Ebyf7575d02006-07-28 21:12:07 +00001103 );
1104 if (importer == NULL) {
1105 if (PyErr_ExceptionMatches(PyExc_ImportError)) {
1106 PyErr_Clear();
1107 return Py_None;
1108 }
1109 }
1110 }
1111 if (importer != NULL) {
Just van Rossum52e14d62002-12-30 22:08:05 +00001112 int err = PyDict_SetItem(path_importer_cache, p, importer);
1113 Py_DECREF(importer);
1114 if (err != 0)
1115 return NULL;
1116 }
1117 return importer;
1118}
1119
Nick Coghlan327a39b2007-11-18 11:56:28 +00001120PyAPI_FUNC(PyObject *)
1121PyImport_GetImporter(PyObject *path) {
1122 PyObject *importer=NULL, *path_importer_cache=NULL, *path_hooks=NULL;
1123
1124 if ((path_importer_cache = PySys_GetObject("path_importer_cache"))) {
1125 if ((path_hooks = PySys_GetObject("path_hooks"))) {
1126 importer = get_path_importer(path_importer_cache,
1127 path_hooks, path);
1128 }
1129 }
1130 Py_XINCREF(importer); /* get_path_importer returns a borrowed reference */
1131 return importer;
1132}
1133
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001134/* Search the path (default sys.path) for a module. Return the
1135 corresponding filedescr struct, and (via return arguments) the
1136 pathname and an open file. Return NULL if the module is not found. */
1137
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001138#ifdef MS_COREDLL
Thomas Woutersb4bd21c2000-07-22 23:38:01 +00001139extern FILE *PyWin_FindRegisteredModule(const char *, struct filedescr **,
Martin v. Löwis18e16552006-02-15 17:27:45 +00001140 char *, Py_ssize_t);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001141#endif
1142
Martin v. Löwis18e16552006-02-15 17:27:45 +00001143static int case_ok(char *, Py_ssize_t, Py_ssize_t, char *);
Tim Petersdbd9ba62000-07-09 03:09:57 +00001144static int find_init_module(char *); /* Forward */
Just van Rossum52e14d62002-12-30 22:08:05 +00001145static struct filedescr importhookdescr = {"", "", IMP_HOOK};
Guido van Rossum197346f1997-10-31 18:38:52 +00001146
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001147static struct filedescr *
Just van Rossum52e14d62002-12-30 22:08:05 +00001148find_module(char *fullname, char *subname, PyObject *path, char *buf,
1149 size_t buflen, FILE **p_fp, PyObject **p_loader)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001150{
Martin v. Löwis725507b2006-03-07 12:08:51 +00001151 Py_ssize_t i, npath;
Fred Drake4c82b232000-06-30 16:18:57 +00001152 size_t len, namelen;
Guido van Rossum80bb9651996-12-05 23:27:02 +00001153 struct filedescr *fdp = NULL;
Jack Jansenc88da1f2002-05-28 10:58:19 +00001154 char *filemode;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001155 FILE *fp = NULL;
Just van Rossum52e14d62002-12-30 22:08:05 +00001156 PyObject *path_hooks, *path_importer_cache;
Guido van Rossum48a680c2001-03-02 06:34:14 +00001157#ifndef RISCOS
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001158 struct stat statbuf;
Guido van Rossum48a680c2001-03-02 06:34:14 +00001159#endif
Guido van Rossuma5568d31998-03-05 03:45:08 +00001160 static struct filedescr fd_frozen = {"", "", PY_FROZEN};
1161 static struct filedescr fd_builtin = {"", "", C_BUILTIN};
1162 static struct filedescr fd_package = {"", "", PKG_DIRECTORY};
Guido van Rossum0506a431998-08-11 15:07:39 +00001163 char name[MAXPATHLEN+1];
Andrew MacIntyred9400542002-02-26 11:41:34 +00001164#if defined(PYOS_OS2)
1165 size_t saved_len;
1166 size_t saved_namelen;
1167 char *saved_buf = NULL;
1168#endif
Just van Rossum52e14d62002-12-30 22:08:05 +00001169 if (p_loader != NULL)
1170 *p_loader = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001171
Just van Rossum52e14d62002-12-30 22:08:05 +00001172 if (strlen(subname) > MAXPATHLEN) {
Guido van Rossum8f4d3312001-10-18 18:54:11 +00001173 PyErr_SetString(PyExc_OverflowError,
1174 "module name is too long");
Fred Drake4c82b232000-06-30 16:18:57 +00001175 return NULL;
1176 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001177 strcpy(name, subname);
1178
1179 /* sys.meta_path import hook */
1180 if (p_loader != NULL) {
1181 PyObject *meta_path;
1182
1183 meta_path = PySys_GetObject("meta_path");
1184 if (meta_path == NULL || !PyList_Check(meta_path)) {
1185 PyErr_SetString(PyExc_ImportError,
1186 "sys.meta_path must be a list of "
1187 "import hooks");
1188 return NULL;
1189 }
1190 Py_INCREF(meta_path); /* zap guard */
1191 npath = PyList_Size(meta_path);
1192 for (i = 0; i < npath; i++) {
1193 PyObject *loader;
1194 PyObject *hook = PyList_GetItem(meta_path, i);
1195 loader = PyObject_CallMethod(hook, "find_module",
1196 "sO", fullname,
1197 path != NULL ?
1198 path : Py_None);
1199 if (loader == NULL) {
1200 Py_DECREF(meta_path);
1201 return NULL; /* true error */
1202 }
1203 if (loader != Py_None) {
1204 /* a loader was found */
1205 *p_loader = loader;
1206 Py_DECREF(meta_path);
1207 return &importhookdescr;
1208 }
1209 Py_DECREF(loader);
1210 }
1211 Py_DECREF(meta_path);
1212 }
Guido van Rossum0506a431998-08-11 15:07:39 +00001213
1214 if (path != NULL && PyString_Check(path)) {
Guido van Rossum8f4d3312001-10-18 18:54:11 +00001215 /* The only type of submodule allowed inside a "frozen"
1216 package are other frozen modules or packages. */
Guido van Rossum0506a431998-08-11 15:07:39 +00001217 if (PyString_Size(path) + 1 + strlen(name) >= (size_t)buflen) {
1218 PyErr_SetString(PyExc_ImportError,
1219 "full frozen module name too long");
1220 return NULL;
1221 }
1222 strcpy(buf, PyString_AsString(path));
1223 strcat(buf, ".");
1224 strcat(buf, name);
1225 strcpy(name, buf);
Guido van Rossum8f4d3312001-10-18 18:54:11 +00001226 if (find_frozen(name) != NULL) {
1227 strcpy(buf, name);
1228 return &fd_frozen;
1229 }
1230 PyErr_Format(PyExc_ImportError,
1231 "No frozen submodule named %.200s", name);
1232 return NULL;
Guido van Rossum0506a431998-08-11 15:07:39 +00001233 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001234 if (path == NULL) {
1235 if (is_builtin(name)) {
Guido van Rossuma5568d31998-03-05 03:45:08 +00001236 strcpy(buf, name);
1237 return &fd_builtin;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001238 }
Greg Ward201baee2001-10-04 14:52:06 +00001239 if ((find_frozen(name)) != NULL) {
Guido van Rossuma5568d31998-03-05 03:45:08 +00001240 strcpy(buf, name);
1241 return &fd_frozen;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001242 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001243
Guido van Rossumac279101996-08-22 23:10:58 +00001244#ifdef MS_COREDLL
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001245 fp = PyWin_FindRegisteredModule(name, &fdp, buf, buflen);
1246 if (fp != NULL) {
1247 *p_fp = fp;
1248 return fdp;
1249 }
Guido van Rossuma5a3db71996-04-09 02:39:59 +00001250#endif
Guido van Rossuma5568d31998-03-05 03:45:08 +00001251 path = PySys_GetObject("path");
1252 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00001253 if (path == NULL || !PyList_Check(path)) {
1254 PyErr_SetString(PyExc_ImportError,
Guido van Rossuma5568d31998-03-05 03:45:08 +00001255 "sys.path must be a list of directory names");
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001256 return NULL;
1257 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001258
1259 path_hooks = PySys_GetObject("path_hooks");
1260 if (path_hooks == NULL || !PyList_Check(path_hooks)) {
1261 PyErr_SetString(PyExc_ImportError,
1262 "sys.path_hooks must be a list of "
1263 "import hooks");
1264 return NULL;
1265 }
1266 path_importer_cache = PySys_GetObject("path_importer_cache");
1267 if (path_importer_cache == NULL ||
1268 !PyDict_Check(path_importer_cache)) {
1269 PyErr_SetString(PyExc_ImportError,
1270 "sys.path_importer_cache must be a dict");
1271 return NULL;
1272 }
1273
Guido van Rossum79f25d91997-04-29 20:08:16 +00001274 npath = PyList_Size(path);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001275 namelen = strlen(name);
1276 for (i = 0; i < npath; i++) {
Walter Dörwald3430d702002-06-17 10:43:59 +00001277 PyObject *copy = NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +00001278 PyObject *v = PyList_GetItem(path, i);
Neal Norwitz3cb31ac2006-08-13 18:10:47 +00001279 if (!v)
1280 return NULL;
Walter Dörwald3430d702002-06-17 10:43:59 +00001281#ifdef Py_USING_UNICODE
1282 if (PyUnicode_Check(v)) {
1283 copy = PyUnicode_Encode(PyUnicode_AS_UNICODE(v),
1284 PyUnicode_GET_SIZE(v), Py_FileSystemDefaultEncoding, NULL);
1285 if (copy == NULL)
1286 return NULL;
1287 v = copy;
1288 }
1289 else
1290#endif
Guido van Rossum79f25d91997-04-29 20:08:16 +00001291 if (!PyString_Check(v))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001292 continue;
Neal Norwitz2aa9a5d2006-03-20 01:53:23 +00001293 len = PyString_GET_SIZE(v);
Walter Dörwald3430d702002-06-17 10:43:59 +00001294 if (len + 2 + namelen + MAXSUFFIXSIZE >= buflen) {
1295 Py_XDECREF(copy);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001296 continue; /* Too long */
Walter Dörwald3430d702002-06-17 10:43:59 +00001297 }
Neal Norwitz2aa9a5d2006-03-20 01:53:23 +00001298 strcpy(buf, PyString_AS_STRING(v));
Walter Dörwald3430d702002-06-17 10:43:59 +00001299 if (strlen(buf) != len) {
1300 Py_XDECREF(copy);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001301 continue; /* v contains '\0' */
Walter Dörwald3430d702002-06-17 10:43:59 +00001302 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001303
1304 /* sys.path_hooks import hook */
1305 if (p_loader != NULL) {
1306 PyObject *importer;
1307
1308 importer = get_path_importer(path_importer_cache,
1309 path_hooks, v);
Neal Norwitza4df11d2006-07-06 04:28:59 +00001310 if (importer == NULL) {
1311 Py_XDECREF(copy);
Just van Rossum52e14d62002-12-30 22:08:05 +00001312 return NULL;
Neal Norwitza4df11d2006-07-06 04:28:59 +00001313 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001314 /* Note: importer is a borrowed reference */
Phillip J. Ebyf7575d02006-07-28 21:12:07 +00001315 if (importer != Py_None) {
Just van Rossum52e14d62002-12-30 22:08:05 +00001316 PyObject *loader;
1317 loader = PyObject_CallMethod(importer,
1318 "find_module",
1319 "s", fullname);
Neal Norwitza4df11d2006-07-06 04:28:59 +00001320 Py_XDECREF(copy);
Just van Rossum52e14d62002-12-30 22:08:05 +00001321 if (loader == NULL)
1322 return NULL; /* error */
1323 if (loader != Py_None) {
1324 /* a loader was found */
1325 *p_loader = loader;
1326 return &importhookdescr;
1327 }
1328 Py_DECREF(loader);
Georg Brandlf4ef1162006-05-26 18:03:31 +00001329 continue;
Just van Rossum52e14d62002-12-30 22:08:05 +00001330 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001331 }
Georg Brandlf4ef1162006-05-26 18:03:31 +00001332 /* no hook was found, use builtin import */
Just van Rossum52e14d62002-12-30 22:08:05 +00001333
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001334 if (len > 0 && buf[len-1] != SEP
1335#ifdef ALTSEP
1336 && buf[len-1] != ALTSEP
1337#endif
1338 )
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001339 buf[len++] = SEP;
Guido van Rossum215c3402000-11-13 17:26:32 +00001340 strcpy(buf+len, name);
1341 len += namelen;
Tim Peters50d8d372001-02-28 05:34:27 +00001342
1343 /* Check for package import (buf holds a directory name,
1344 and there's an __init__ module in that directory */
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001345#ifdef HAVE_STAT
Walter Dörwald3430d702002-06-17 10:43:59 +00001346 if (stat(buf, &statbuf) == 0 && /* it exists */
1347 S_ISDIR(statbuf.st_mode) && /* it's a directory */
Thomas Wouters9df4e6f2006-04-27 23:13:20 +00001348 case_ok(buf, len, namelen, name)) { /* case matches */
1349 if (find_init_module(buf)) { /* and has __init__.py */
1350 Py_XDECREF(copy);
1351 return &fd_package;
1352 }
1353 else {
1354 char warnstr[MAXPATHLEN+80];
1355 sprintf(warnstr, "Not importing directory "
1356 "'%.*s': missing __init__.py",
1357 MAXPATHLEN, buf);
1358 if (PyErr_Warn(PyExc_ImportWarning,
1359 warnstr)) {
1360 Py_XDECREF(copy);
1361 return NULL;
1362 }
1363 }
Walter Dörwald3430d702002-06-17 10:43:59 +00001364 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001365#else
1366 /* XXX How are you going to test for directories? */
Guido van Rossum48a680c2001-03-02 06:34:14 +00001367#ifdef RISCOS
Guido van Rossume2ae77b2001-10-24 20:42:55 +00001368 if (isdir(buf) &&
Walter Dörwald3430d702002-06-17 10:43:59 +00001369 case_ok(buf, len, namelen, name)) {
Thomas Wouters9df4e6f2006-04-27 23:13:20 +00001370 if (find_init_module(buf)) {
1371 Py_XDECREF(copy);
1372 return &fd_package;
1373 }
1374 else {
1375 char warnstr[MAXPATHLEN+80];
1376 sprintf(warnstr, "Not importing directory "
1377 "'%.*s': missing __init__.py",
1378 MAXPATHLEN, buf);
1379 if (PyErr_Warn(PyExc_ImportWarning,
1380 warnstr)) {
1381 Py_XDECREF(copy);
1382 return NULL;
1383 }
Walter Dörwald3430d702002-06-17 10:43:59 +00001384 }
Guido van Rossum48a680c2001-03-02 06:34:14 +00001385#endif
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001386#endif
Andrew MacIntyred9400542002-02-26 11:41:34 +00001387#if defined(PYOS_OS2)
1388 /* take a snapshot of the module spec for restoration
1389 * after the 8 character DLL hackery
1390 */
1391 saved_buf = strdup(buf);
1392 saved_len = len;
1393 saved_namelen = namelen;
1394#endif /* PYOS_OS2 */
Guido van Rossum79f25d91997-04-29 20:08:16 +00001395 for (fdp = _PyImport_Filetab; fdp->suffix != NULL; fdp++) {
Georg Brandladd36e52007-08-23 18:08:06 +00001396#if defined(PYOS_OS2) && defined(HAVE_DYNAMIC_LOADING)
Jeremy Hylton4ae6fae2002-05-30 17:15:25 +00001397 /* OS/2 limits DLLs to 8 character names (w/o
1398 extension)
Andrew MacIntyred9400542002-02-26 11:41:34 +00001399 * so if the name is longer than that and its a
1400 * dynamically loaded module we're going to try,
1401 * truncate the name before trying
1402 */
Just van Rossum52e14d62002-12-30 22:08:05 +00001403 if (strlen(subname) > 8) {
Andrew MacIntyred9400542002-02-26 11:41:34 +00001404 /* is this an attempt to load a C extension? */
Jeremy Hylton4ae6fae2002-05-30 17:15:25 +00001405 const struct filedescr *scan;
1406 scan = _PyImport_DynLoadFiletab;
Andrew MacIntyred9400542002-02-26 11:41:34 +00001407 while (scan->suffix != NULL) {
Jeremy Hylton4ae6fae2002-05-30 17:15:25 +00001408 if (!strcmp(scan->suffix, fdp->suffix))
Andrew MacIntyred9400542002-02-26 11:41:34 +00001409 break;
1410 else
1411 scan++;
1412 }
1413 if (scan->suffix != NULL) {
1414 /* yes, so truncate the name */
1415 namelen = 8;
Just van Rossum52e14d62002-12-30 22:08:05 +00001416 len -= strlen(subname) - namelen;
Andrew MacIntyred9400542002-02-26 11:41:34 +00001417 buf[len] = '\0';
1418 }
1419 }
1420#endif /* PYOS_OS2 */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001421 strcpy(buf+len, fdp->suffix);
Guido van Rossum79f25d91997-04-29 20:08:16 +00001422 if (Py_VerboseFlag > 1)
Guido van Rossum2f3667a1998-10-12 18:23:55 +00001423 PySys_WriteStderr("# trying %s\n", buf);
Jack Jansenc88da1f2002-05-28 10:58:19 +00001424 filemode = fdp->mode;
Tim Peters86c7d2f2004-08-01 23:24:21 +00001425 if (filemode[0] == 'U')
Jeremy Hylton4ae6fae2002-05-30 17:15:25 +00001426 filemode = "r" PY_STDIOTEXTMODE;
Jack Jansenc88da1f2002-05-28 10:58:19 +00001427 fp = fopen(buf, filemode);
Tim Peters50d8d372001-02-28 05:34:27 +00001428 if (fp != NULL) {
1429 if (case_ok(buf, len, namelen, name))
1430 break;
1431 else { /* continue search */
1432 fclose(fp);
1433 fp = NULL;
Barry Warsaw914a0b12001-02-02 19:12:16 +00001434 }
Barry Warsaw914a0b12001-02-02 19:12:16 +00001435 }
Andrew MacIntyred9400542002-02-26 11:41:34 +00001436#if defined(PYOS_OS2)
1437 /* restore the saved snapshot */
1438 strcpy(buf, saved_buf);
1439 len = saved_len;
1440 namelen = saved_namelen;
1441#endif
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001442 }
Andrew MacIntyred9400542002-02-26 11:41:34 +00001443#if defined(PYOS_OS2)
1444 /* don't need/want the module name snapshot anymore */
1445 if (saved_buf)
1446 {
1447 free(saved_buf);
1448 saved_buf = NULL;
1449 }
1450#endif
Walter Dörwald3430d702002-06-17 10:43:59 +00001451 Py_XDECREF(copy);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001452 if (fp != NULL)
1453 break;
1454 }
1455 if (fp == NULL) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001456 PyErr_Format(PyExc_ImportError,
1457 "No module named %.200s", name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001458 return NULL;
1459 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001460 *p_fp = fp;
1461 return fdp;
1462}
1463
Raymond Hettingerdb29e0f2004-10-07 06:46:25 +00001464/* Helpers for main.c
1465 * Find the source file corresponding to a named module
1466 */
1467struct filedescr *
1468_PyImport_FindModule(const char *name, PyObject *path, char *buf,
1469 size_t buflen, FILE **p_fp, PyObject **p_loader)
1470{
1471 return find_module((char *) name, (char *) name, path,
1472 buf, buflen, p_fp, p_loader);
1473}
1474
1475PyAPI_FUNC(int) _PyImport_IsScript(struct filedescr * fd)
1476{
1477 return fd->type == PY_SOURCE || fd->type == PY_COMPILED;
1478}
1479
Martin v. Löwis18e16552006-02-15 17:27:45 +00001480/* case_ok(char* buf, Py_ssize_t len, Py_ssize_t namelen, char* name)
Tim Petersd1e87a82001-03-01 18:12:00 +00001481 * The arguments here are tricky, best shown by example:
1482 * /a/b/c/d/e/f/g/h/i/j/k/some_long_module_name.py\0
1483 * ^ ^ ^ ^
1484 * |--------------------- buf ---------------------|
1485 * |------------------- len ------------------|
1486 * |------ name -------|
1487 * |----- namelen -----|
1488 * buf is the full path, but len only counts up to (& exclusive of) the
1489 * extension. name is the module name, also exclusive of extension.
1490 *
1491 * We've already done a successful stat() or fopen() on buf, so know that
1492 * there's some match, possibly case-insensitive.
1493 *
Tim Peters50d8d372001-02-28 05:34:27 +00001494 * case_ok() is to return 1 if there's a case-sensitive match for
1495 * name, else 0. case_ok() is also to return 1 if envar PYTHONCASEOK
1496 * exists.
Tim Petersd1e87a82001-03-01 18:12:00 +00001497 *
Tim Peters50d8d372001-02-28 05:34:27 +00001498 * case_ok() is used to implement case-sensitive import semantics even
1499 * on platforms with case-insensitive filesystems. It's trivial to implement
1500 * for case-sensitive filesystems. It's pretty much a cross-platform
1501 * nightmare for systems with case-insensitive filesystems.
1502 */
Guido van Rossum0980bd91998-02-13 17:18:36 +00001503
Tim Peters50d8d372001-02-28 05:34:27 +00001504/* First we may need a pile of platform-specific header files; the sequence
1505 * of #if's here should match the sequence in the body of case_ok().
1506 */
Jason Tishler7961aa62005-05-20 00:56:54 +00001507#if defined(MS_WINDOWS)
Guido van Rossum0980bd91998-02-13 17:18:36 +00001508#include <windows.h>
Guido van Rossum4c3f57c2001-01-10 20:40:46 +00001509
Tim Peters50d8d372001-02-28 05:34:27 +00001510#elif defined(DJGPP)
1511#include <dir.h>
1512
Jason Tishler7961aa62005-05-20 00:56:54 +00001513#elif (defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) && defined(HAVE_DIRENT_H)
Tim Peters430f5d42001-03-01 01:30:56 +00001514#include <sys/types.h>
1515#include <dirent.h>
1516
Andrew MacIntyred9400542002-02-26 11:41:34 +00001517#elif defined(PYOS_OS2)
1518#define INCL_DOS
1519#define INCL_DOSERRORS
1520#define INCL_NOPMAPI
1521#include <os2.h>
1522
Guido van Rossume2ae77b2001-10-24 20:42:55 +00001523#elif defined(RISCOS)
1524#include "oslib/osfscontrol.h"
Tim Peters50d8d372001-02-28 05:34:27 +00001525#endif
1526
Guido van Rossum0980bd91998-02-13 17:18:36 +00001527static int
Martin v. Löwis18e16552006-02-15 17:27:45 +00001528case_ok(char *buf, Py_ssize_t len, Py_ssize_t namelen, char *name)
Guido van Rossum0980bd91998-02-13 17:18:36 +00001529{
Tim Peters50d8d372001-02-28 05:34:27 +00001530/* Pick a platform-specific implementation; the sequence of #if's here should
1531 * match the sequence just above.
1532 */
1533
Jason Tishler7961aa62005-05-20 00:56:54 +00001534/* MS_WINDOWS */
1535#if defined(MS_WINDOWS)
Guido van Rossum0980bd91998-02-13 17:18:36 +00001536 WIN32_FIND_DATA data;
1537 HANDLE h;
Tim Peters50d8d372001-02-28 05:34:27 +00001538
Neil Schemenauer7d4bb9f2001-07-23 16:30:27 +00001539 if (Py_GETENV("PYTHONCASEOK") != NULL)
Guido van Rossum0980bd91998-02-13 17:18:36 +00001540 return 1;
Tim Peters50d8d372001-02-28 05:34:27 +00001541
Guido van Rossum0980bd91998-02-13 17:18:36 +00001542 h = FindFirstFile(buf, &data);
1543 if (h == INVALID_HANDLE_VALUE) {
1544 PyErr_Format(PyExc_NameError,
1545 "Can't find file for module %.100s\n(filename %.300s)",
1546 name, buf);
1547 return 0;
1548 }
1549 FindClose(h);
Tim Peters50d8d372001-02-28 05:34:27 +00001550 return strncmp(data.cFileName, name, namelen) == 0;
1551
1552/* DJGPP */
1553#elif defined(DJGPP)
1554 struct ffblk ffblk;
1555 int done;
1556
Neil Schemenauer7d4bb9f2001-07-23 16:30:27 +00001557 if (Py_GETENV("PYTHONCASEOK") != NULL)
Guido van Rossum323bf5e1998-06-24 03:54:06 +00001558 return 1;
Tim Peters50d8d372001-02-28 05:34:27 +00001559
1560 done = findfirst(buf, &ffblk, FA_ARCH|FA_RDONLY|FA_HIDDEN|FA_DIREC);
1561 if (done) {
Guido van Rossum0980bd91998-02-13 17:18:36 +00001562 PyErr_Format(PyExc_NameError,
Tim Peters50d8d372001-02-28 05:34:27 +00001563 "Can't find file for module %.100s\n(filename %.300s)",
Guido van Rossum0980bd91998-02-13 17:18:36 +00001564 name, buf);
1565 return 0;
1566 }
Tim Peters50d8d372001-02-28 05:34:27 +00001567 return strncmp(ffblk.ff_name, name, namelen) == 0;
Guido van Rossum0980bd91998-02-13 17:18:36 +00001568
Jason Tishler7961aa62005-05-20 00:56:54 +00001569/* new-fangled macintosh (macosx) or Cygwin */
1570#elif (defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) && defined(HAVE_DIRENT_H)
Tim Peters430f5d42001-03-01 01:30:56 +00001571 DIR *dirp;
1572 struct dirent *dp;
Tim Petersd1e87a82001-03-01 18:12:00 +00001573 char dirname[MAXPATHLEN + 1];
1574 const int dirlen = len - namelen - 1; /* don't want trailing SEP */
Tim Peters430f5d42001-03-01 01:30:56 +00001575
Neil Schemenauer7d4bb9f2001-07-23 16:30:27 +00001576 if (Py_GETENV("PYTHONCASEOK") != NULL)
Tim Petersdbe6ebb2001-03-01 08:47:29 +00001577 return 1;
1578
Tim Petersd1e87a82001-03-01 18:12:00 +00001579 /* Copy the dir component into dirname; substitute "." if empty */
1580 if (dirlen <= 0) {
1581 dirname[0] = '.';
1582 dirname[1] = '\0';
Tim Peters430f5d42001-03-01 01:30:56 +00001583 }
1584 else {
Tim Petersd1e87a82001-03-01 18:12:00 +00001585 assert(dirlen <= MAXPATHLEN);
1586 memcpy(dirname, buf, dirlen);
1587 dirname[dirlen] = '\0';
Tim Peters430f5d42001-03-01 01:30:56 +00001588 }
1589 /* Open the directory and search the entries for an exact match. */
Tim Petersd1e87a82001-03-01 18:12:00 +00001590 dirp = opendir(dirname);
Tim Peters430f5d42001-03-01 01:30:56 +00001591 if (dirp) {
Tim Peters677898a2001-03-02 03:28:03 +00001592 char *nameWithExt = buf + len - namelen;
Tim Peters430f5d42001-03-01 01:30:56 +00001593 while ((dp = readdir(dirp)) != NULL) {
Tim Petersdbe6ebb2001-03-01 08:47:29 +00001594 const int thislen =
Tim Peters430f5d42001-03-01 01:30:56 +00001595#ifdef _DIRENT_HAVE_D_NAMELEN
Tim Petersdbe6ebb2001-03-01 08:47:29 +00001596 dp->d_namlen;
Tim Peters430f5d42001-03-01 01:30:56 +00001597#else
Tim Petersdbe6ebb2001-03-01 08:47:29 +00001598 strlen(dp->d_name);
Tim Peters430f5d42001-03-01 01:30:56 +00001599#endif
Tim Petersd1e87a82001-03-01 18:12:00 +00001600 if (thislen >= namelen &&
Tim Peters677898a2001-03-02 03:28:03 +00001601 strcmp(dp->d_name, nameWithExt) == 0) {
Tim Peters430f5d42001-03-01 01:30:56 +00001602 (void)closedir(dirp);
1603 return 1; /* Found */
1604 }
1605 }
Tim Petersdbe6ebb2001-03-01 08:47:29 +00001606 (void)closedir(dirp);
Tim Peters430f5d42001-03-01 01:30:56 +00001607 }
Tim Peters430f5d42001-03-01 01:30:56 +00001608 return 0 ; /* Not found */
Tim Peters430f5d42001-03-01 01:30:56 +00001609
Guido van Rossume2ae77b2001-10-24 20:42:55 +00001610/* RISC OS */
1611#elif defined(RISCOS)
1612 char canon[MAXPATHLEN+1]; /* buffer for the canonical form of the path */
1613 char buf2[MAXPATHLEN+2];
1614 char *nameWithExt = buf+len-namelen;
1615 int canonlen;
1616 os_error *e;
1617
1618 if (Py_GETENV("PYTHONCASEOK") != NULL)
1619 return 1;
1620
1621 /* workaround:
1622 append wildcard, otherwise case of filename wouldn't be touched */
1623 strcpy(buf2, buf);
1624 strcat(buf2, "*");
1625
1626 e = xosfscontrol_canonicalise_path(buf2,canon,0,0,MAXPATHLEN+1,&canonlen);
1627 canonlen = MAXPATHLEN+1-canonlen;
1628 if (e || canonlen<=0 || canonlen>(MAXPATHLEN+1) )
1629 return 0;
1630 if (strcmp(nameWithExt, canon+canonlen-strlen(nameWithExt))==0)
1631 return 1; /* match */
1632
1633 return 0;
1634
Andrew MacIntyred9400542002-02-26 11:41:34 +00001635/* OS/2 */
1636#elif defined(PYOS_OS2)
1637 HDIR hdir = 1;
1638 ULONG srchcnt = 1;
1639 FILEFINDBUF3 ffbuf;
1640 APIRET rc;
1641
Georg Brandlaed6c662008-01-07 17:25:53 +00001642 if (Py_GETENV("PYTHONCASEOK") != NULL)
Andrew MacIntyred9400542002-02-26 11:41:34 +00001643 return 1;
1644
1645 rc = DosFindFirst(buf,
1646 &hdir,
1647 FILE_READONLY | FILE_HIDDEN | FILE_SYSTEM | FILE_DIRECTORY,
1648 &ffbuf, sizeof(ffbuf),
1649 &srchcnt,
1650 FIL_STANDARD);
1651 if (rc != NO_ERROR)
1652 return 0;
1653 return strncmp(ffbuf.achName, name, namelen) == 0;
1654
Tim Peters50d8d372001-02-28 05:34:27 +00001655/* assuming it's a case-sensitive filesystem, so there's nothing to do! */
1656#else
Guido van Rossum0980bd91998-02-13 17:18:36 +00001657 return 1;
Guido van Rossum0980bd91998-02-13 17:18:36 +00001658
Guido van Rossum4d1b3b91998-02-13 23:27:59 +00001659#endif
Tim Peters50d8d372001-02-28 05:34:27 +00001660}
Guido van Rossum4d1b3b91998-02-13 23:27:59 +00001661
Guido van Rossum0980bd91998-02-13 17:18:36 +00001662
Guido van Rossum197346f1997-10-31 18:38:52 +00001663#ifdef HAVE_STAT
1664/* Helper to look for __init__.py or __init__.py[co] in potential package */
1665static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001666find_init_module(char *buf)
Guido van Rossum197346f1997-10-31 18:38:52 +00001667{
Tim Peters0f9431f2001-07-05 03:47:53 +00001668 const size_t save_len = strlen(buf);
Fred Drake4c82b232000-06-30 16:18:57 +00001669 size_t i = save_len;
Tim Peters0f9431f2001-07-05 03:47:53 +00001670 char *pname; /* pointer to start of __init__ */
Guido van Rossum197346f1997-10-31 18:38:52 +00001671 struct stat statbuf;
1672
Tim Peters0f9431f2001-07-05 03:47:53 +00001673/* For calling case_ok(buf, len, namelen, name):
1674 * /a/b/c/d/e/f/g/h/i/j/k/some_long_module_name.py\0
1675 * ^ ^ ^ ^
1676 * |--------------------- buf ---------------------|
1677 * |------------------- len ------------------|
1678 * |------ name -------|
1679 * |----- namelen -----|
1680 */
Guido van Rossum197346f1997-10-31 18:38:52 +00001681 if (save_len + 13 >= MAXPATHLEN)
1682 return 0;
1683 buf[i++] = SEP;
Tim Peters0f9431f2001-07-05 03:47:53 +00001684 pname = buf + i;
1685 strcpy(pname, "__init__.py");
Guido van Rossum197346f1997-10-31 18:38:52 +00001686 if (stat(buf, &statbuf) == 0) {
Tim Peters0f9431f2001-07-05 03:47:53 +00001687 if (case_ok(buf,
1688 save_len + 9, /* len("/__init__") */
1689 8, /* len("__init__") */
1690 pname)) {
1691 buf[save_len] = '\0';
1692 return 1;
1693 }
Guido van Rossum197346f1997-10-31 18:38:52 +00001694 }
Tim Peters0f9431f2001-07-05 03:47:53 +00001695 i += strlen(pname);
1696 strcpy(buf+i, Py_OptimizeFlag ? "o" : "c");
Guido van Rossum197346f1997-10-31 18:38:52 +00001697 if (stat(buf, &statbuf) == 0) {
Tim Peters0f9431f2001-07-05 03:47:53 +00001698 if (case_ok(buf,
1699 save_len + 9, /* len("/__init__") */
1700 8, /* len("__init__") */
1701 pname)) {
1702 buf[save_len] = '\0';
1703 return 1;
1704 }
Guido van Rossum197346f1997-10-31 18:38:52 +00001705 }
1706 buf[save_len] = '\0';
1707 return 0;
1708}
Guido van Rossum48a680c2001-03-02 06:34:14 +00001709
1710#else
1711
1712#ifdef RISCOS
1713static int
1714find_init_module(buf)
1715 char *buf;
1716{
1717 int save_len = strlen(buf);
1718 int i = save_len;
1719
1720 if (save_len + 13 >= MAXPATHLEN)
1721 return 0;
1722 buf[i++] = SEP;
1723 strcpy(buf+i, "__init__/py");
1724 if (isfile(buf)) {
1725 buf[save_len] = '\0';
1726 return 1;
1727 }
1728
1729 if (Py_OptimizeFlag)
1730 strcpy(buf+i, "o");
1731 else
1732 strcpy(buf+i, "c");
1733 if (isfile(buf)) {
1734 buf[save_len] = '\0';
1735 return 1;
1736 }
1737 buf[save_len] = '\0';
1738 return 0;
1739}
1740#endif /*RISCOS*/
1741
Guido van Rossum197346f1997-10-31 18:38:52 +00001742#endif /* HAVE_STAT */
1743
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001744
Tim Petersdbd9ba62000-07-09 03:09:57 +00001745static int init_builtin(char *); /* Forward */
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001746
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001747/* Load an external module using the default search path and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001748 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001749
Guido van Rossum79f25d91997-04-29 20:08:16 +00001750static PyObject *
Just van Rossum52e14d62002-12-30 22:08:05 +00001751load_module(char *name, FILE *fp, char *buf, int type, PyObject *loader)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001752{
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001753 PyObject *modules;
Guido van Rossum79f25d91997-04-29 20:08:16 +00001754 PyObject *m;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001755 int err;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001756
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001757 /* First check that there's an open file (if we need one) */
1758 switch (type) {
1759 case PY_SOURCE:
1760 case PY_COMPILED:
1761 if (fp == NULL) {
1762 PyErr_Format(PyExc_ValueError,
1763 "file object required for import (type code %d)",
1764 type);
1765 return NULL;
1766 }
1767 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001768
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001769 switch (type) {
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001770
1771 case PY_SOURCE:
1772 m = load_source_module(name, buf, fp);
1773 break;
1774
1775 case PY_COMPILED:
1776 m = load_compiled_module(name, buf, fp);
1777 break;
1778
Guido van Rossum96a8fb71999-12-22 14:09:35 +00001779#ifdef HAVE_DYNAMIC_LOADING
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001780 case C_EXTENSION:
Guido van Rossum79f25d91997-04-29 20:08:16 +00001781 m = _PyImport_LoadDynamicModule(name, buf, fp);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001782 break;
Guido van Rossum96a8fb71999-12-22 14:09:35 +00001783#endif
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001784
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001785 case PKG_DIRECTORY:
1786 m = load_package(name, buf);
1787 break;
1788
1789 case C_BUILTIN:
1790 case PY_FROZEN:
Guido van Rossuma5568d31998-03-05 03:45:08 +00001791 if (buf != NULL && buf[0] != '\0')
1792 name = buf;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001793 if (type == C_BUILTIN)
1794 err = init_builtin(name);
1795 else
1796 err = PyImport_ImportFrozenModule(name);
1797 if (err < 0)
Guido van Rossuma86f77d1997-09-09 18:53:47 +00001798 return NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001799 if (err == 0) {
1800 PyErr_Format(PyExc_ImportError,
1801 "Purported %s module %.200s not found",
1802 type == C_BUILTIN ?
1803 "builtin" : "frozen",
1804 name);
Guido van Rossuma86f77d1997-09-09 18:53:47 +00001805 return NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001806 }
1807 modules = PyImport_GetModuleDict();
1808 m = PyDict_GetItemString(modules, name);
1809 if (m == NULL) {
1810 PyErr_Format(
1811 PyExc_ImportError,
1812 "%s module %.200s not properly initialized",
1813 type == C_BUILTIN ?
1814 "builtin" : "frozen",
1815 name);
Guido van Rossuma86f77d1997-09-09 18:53:47 +00001816 return NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001817 }
1818 Py_INCREF(m);
1819 break;
1820
Just van Rossum52e14d62002-12-30 22:08:05 +00001821 case IMP_HOOK: {
1822 if (loader == NULL) {
1823 PyErr_SetString(PyExc_ImportError,
1824 "import hook without loader");
1825 return NULL;
1826 }
1827 m = PyObject_CallMethod(loader, "load_module", "s", name);
1828 break;
1829 }
1830
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001831 default:
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001832 PyErr_Format(PyExc_ImportError,
1833 "Don't know how to import %.200s (type code %d)",
1834 name, type);
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001835 m = NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001836
1837 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001838
1839 return m;
1840}
1841
1842
1843/* Initialize a built-in module.
Brett Cannon5a9aa4f2006-10-03 21:58:55 +00001844 Return 1 for success, 0 if the module is not found, and -1 with
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001845 an exception set if the initialization failed. */
Guido van Rossum7f133ed1991-02-19 12:23:57 +00001846
Guido van Rossum7f133ed1991-02-19 12:23:57 +00001847static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001848init_builtin(char *name)
Guido van Rossum7f133ed1991-02-19 12:23:57 +00001849{
Guido van Rossum25ce5661997-08-02 03:10:38 +00001850 struct _inittab *p;
Guido van Rossum25ce5661997-08-02 03:10:38 +00001851
Greg Ward201baee2001-10-04 14:52:06 +00001852 if (_PyImport_FindExtension(name, name) != NULL)
Guido van Rossum25ce5661997-08-02 03:10:38 +00001853 return 1;
1854
Guido van Rossum771c6c81997-10-31 18:37:24 +00001855 for (p = PyImport_Inittab; p->name != NULL; p++) {
Guido van Rossum25ce5661997-08-02 03:10:38 +00001856 if (strcmp(name, p->name) == 0) {
1857 if (p->initfunc == NULL) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001858 PyErr_Format(PyExc_ImportError,
1859 "Cannot re-init internal module %.200s",
1860 name);
Guido van Rossum74e6a111994-08-29 12:54:38 +00001861 return -1;
1862 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00001863 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +00001864 PySys_WriteStderr("import %s # builtin\n", name);
Guido van Rossum25ce5661997-08-02 03:10:38 +00001865 (*p->initfunc)();
Guido van Rossum79f25d91997-04-29 20:08:16 +00001866 if (PyErr_Occurred())
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001867 return -1;
Guido van Rossum25ce5661997-08-02 03:10:38 +00001868 if (_PyImport_FixupExtension(name, name) == NULL)
1869 return -1;
Guido van Rossum7f133ed1991-02-19 12:23:57 +00001870 return 1;
1871 }
1872 }
1873 return 0;
1874}
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001875
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001876
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001877/* Frozen modules */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001878
Guido van Rossumcfd0a221996-06-17 17:06:34 +00001879static struct _frozen *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001880find_frozen(char *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001881{
Guido van Rossumcfd0a221996-06-17 17:06:34 +00001882 struct _frozen *p;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001883
Guido van Rossum79f25d91997-04-29 20:08:16 +00001884 for (p = PyImport_FrozenModules; ; p++) {
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001885 if (p->name == NULL)
1886 return NULL;
1887 if (strcmp(p->name, name) == 0)
1888 break;
1889 }
1890 return p;
1891}
1892
Guido van Rossum79f25d91997-04-29 20:08:16 +00001893static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001894get_frozen_object(char *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001895{
Guido van Rossumcfd0a221996-06-17 17:06:34 +00001896 struct _frozen *p = find_frozen(name);
Guido van Rossuma5568d31998-03-05 03:45:08 +00001897 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001898
1899 if (p == NULL) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001900 PyErr_Format(PyExc_ImportError,
1901 "No such frozen object named %.200s",
1902 name);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001903 return NULL;
1904 }
Guido van Rossum8f4d3312001-10-18 18:54:11 +00001905 if (p->code == NULL) {
1906 PyErr_Format(PyExc_ImportError,
1907 "Excluded frozen object named %.200s",
1908 name);
1909 return NULL;
1910 }
Guido van Rossuma5568d31998-03-05 03:45:08 +00001911 size = p->size;
1912 if (size < 0)
1913 size = -size;
1914 return PyMarshal_ReadObjectFromString((char *)p->code, size);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001915}
1916
1917/* Initialize a frozen module.
1918 Return 1 for succes, 0 if the module is not found, and -1 with
1919 an exception set if the initialization failed.
1920 This function is also used from frozenmain.c */
Guido van Rossum0b344901995-02-07 15:35:27 +00001921
1922int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001923PyImport_ImportFrozenModule(char *name)
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001924{
Guido van Rossumcfd0a221996-06-17 17:06:34 +00001925 struct _frozen *p = find_frozen(name);
Guido van Rossum79f25d91997-04-29 20:08:16 +00001926 PyObject *co;
1927 PyObject *m;
Guido van Rossuma5568d31998-03-05 03:45:08 +00001928 int ispackage;
1929 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001930
1931 if (p == NULL)
1932 return 0;
Guido van Rossum8f4d3312001-10-18 18:54:11 +00001933 if (p->code == NULL) {
1934 PyErr_Format(PyExc_ImportError,
1935 "Excluded frozen object named %.200s",
1936 name);
1937 return -1;
1938 }
Guido van Rossuma5568d31998-03-05 03:45:08 +00001939 size = p->size;
1940 ispackage = (size < 0);
1941 if (ispackage)
1942 size = -size;
Guido van Rossum79f25d91997-04-29 20:08:16 +00001943 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +00001944 PySys_WriteStderr("import %s # frozen%s\n",
Guido van Rossuma5568d31998-03-05 03:45:08 +00001945 name, ispackage ? " package" : "");
1946 co = PyMarshal_ReadObjectFromString((char *)p->code, size);
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001947 if (co == NULL)
1948 return -1;
Guido van Rossum79f25d91997-04-29 20:08:16 +00001949 if (!PyCode_Check(co)) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001950 PyErr_Format(PyExc_TypeError,
1951 "frozen object %.200s is not a code object",
1952 name);
Neal Norwitzc0cde4d2006-07-16 02:17:36 +00001953 goto err_return;
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001954 }
Guido van Rossuma5568d31998-03-05 03:45:08 +00001955 if (ispackage) {
1956 /* Set __path__ to the package name */
1957 PyObject *d, *s;
1958 int err;
1959 m = PyImport_AddModule(name);
1960 if (m == NULL)
Neal Norwitzc0cde4d2006-07-16 02:17:36 +00001961 goto err_return;
Guido van Rossuma5568d31998-03-05 03:45:08 +00001962 d = PyModule_GetDict(m);
1963 s = PyString_InternFromString(name);
1964 if (s == NULL)
Neal Norwitzc0cde4d2006-07-16 02:17:36 +00001965 goto err_return;
Guido van Rossuma5568d31998-03-05 03:45:08 +00001966 err = PyDict_SetItemString(d, "__path__", s);
1967 Py_DECREF(s);
1968 if (err != 0)
Neal Norwitzc0cde4d2006-07-16 02:17:36 +00001969 goto err_return;
Guido van Rossuma5568d31998-03-05 03:45:08 +00001970 }
Guido van Rossume32bf6e1998-02-11 05:53:02 +00001971 m = PyImport_ExecCodeModuleEx(name, co, "<frozen>");
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001972 if (m == NULL)
Neal Norwitzc0cde4d2006-07-16 02:17:36 +00001973 goto err_return;
1974 Py_DECREF(co);
Guido van Rossum79f25d91997-04-29 20:08:16 +00001975 Py_DECREF(m);
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001976 return 1;
Neal Norwitzc0cde4d2006-07-16 02:17:36 +00001977err_return:
1978 Py_DECREF(co);
1979 return -1;
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001980}
Guido van Rossum74e6a111994-08-29 12:54:38 +00001981
1982
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001983/* Import a module, either built-in, frozen, or external, and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001984 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum74e6a111994-08-29 12:54:38 +00001985
Guido van Rossum79f25d91997-04-29 20:08:16 +00001986PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001987PyImport_ImportModule(const char *name)
Guido van Rossum74e6a111994-08-29 12:54:38 +00001988{
Marc-André Lemburg3c61c352001-02-09 19:40:15 +00001989 PyObject *pname;
1990 PyObject *result;
1991
1992 pname = PyString_FromString(name);
Neal Norwitza11e4c12003-03-23 14:31:01 +00001993 if (pname == NULL)
1994 return NULL;
Marc-André Lemburg3c61c352001-02-09 19:40:15 +00001995 result = PyImport_Import(pname);
1996 Py_DECREF(pname);
1997 return result;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001998}
1999
Christian Heimes000a0742008-01-03 22:16:32 +00002000/* Import a module without blocking
2001 *
2002 * At first it tries to fetch the module from sys.modules. If the module was
2003 * never loaded before it loads it with PyImport_ImportModule() unless another
2004 * thread holds the import lock. In the latter case the function raises an
2005 * ImportError instead of blocking.
2006 *
2007 * Returns the module object with incremented ref count.
2008 */
2009PyObject *
2010PyImport_ImportModuleNoBlock(const char *name)
2011{
2012 PyObject *result;
2013 PyObject *modules;
2014 long me;
2015
2016 /* Try to get the module from sys.modules[name] */
2017 modules = PyImport_GetModuleDict();
2018 if (modules == NULL)
2019 return NULL;
2020
2021 result = PyDict_GetItemString(modules, name);
2022 if (result != NULL) {
2023 Py_INCREF(result);
2024 return result;
2025 }
2026 else {
2027 PyErr_Clear();
2028 }
2029
2030 /* check the import lock
2031 * me might be -1 but I ignore the error here, the lock function
2032 * takes care of the problem */
2033 me = PyThread_get_thread_ident();
2034 if (import_lock_thread == -1 || import_lock_thread == me) {
2035 /* no thread or me is holding the lock */
2036 return PyImport_ImportModule(name);
2037 }
2038 else {
2039 PyErr_Format(PyExc_ImportError,
2040 "Failed to import %.200s because the import lock"
2041 "is held by another thread.",
2042 name);
2043 return NULL;
2044 }
2045}
2046
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002047/* Forward declarations for helper routines */
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002048static PyObject *get_parent(PyObject *globals, char *buf,
2049 Py_ssize_t *p_buflen, int level);
Tim Petersdbd9ba62000-07-09 03:09:57 +00002050static PyObject *load_next(PyObject *mod, PyObject *altmod,
Martin v. Löwis18e16552006-02-15 17:27:45 +00002051 char **p_name, char *buf, Py_ssize_t *p_buflen);
Tim Petersdbd9ba62000-07-09 03:09:57 +00002052static int mark_miss(char *name);
2053static int ensure_fromlist(PyObject *mod, PyObject *fromlist,
Martin v. Löwis18e16552006-02-15 17:27:45 +00002054 char *buf, Py_ssize_t buflen, int recursive);
Tim Petersdbd9ba62000-07-09 03:09:57 +00002055static PyObject * import_submodule(PyObject *mod, char *name, char *fullname);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002056
2057/* The Magnum Opus of dotted-name import :-) */
2058
Guido van Rossum75acc9c1998-03-03 22:26:50 +00002059static PyObject *
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002060import_module_level(char *name, PyObject *globals, PyObject *locals,
2061 PyObject *fromlist, int level)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002062{
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002063 char buf[MAXPATHLEN+1];
Martin v. Löwis18e16552006-02-15 17:27:45 +00002064 Py_ssize_t buflen = 0;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002065 PyObject *parent, *head, *next, *tail;
2066
Christian Heimes3403f152008-01-09 19:56:33 +00002067 if (strchr(name, '/') != NULL
2068#ifdef MS_WINDOWS
2069 || strchr(name, '\\') != NULL
2070#endif
2071 ) {
2072 PyErr_SetString(PyExc_ImportError,
2073 "Import by filename is not supported.");
2074 return NULL;
2075 }
2076
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002077 parent = get_parent(globals, buf, &buflen, level);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002078 if (parent == NULL)
2079 return NULL;
2080
2081 head = load_next(parent, Py_None, &name, buf, &buflen);
2082 if (head == NULL)
2083 return NULL;
2084
2085 tail = head;
2086 Py_INCREF(tail);
2087 while (name) {
2088 next = load_next(tail, tail, &name, buf, &buflen);
2089 Py_DECREF(tail);
2090 if (next == NULL) {
2091 Py_DECREF(head);
2092 return NULL;
2093 }
2094 tail = next;
2095 }
Thomas Wouters8ddab272006-04-04 16:17:02 +00002096 if (tail == Py_None) {
2097 /* If tail is Py_None, both get_parent and load_next found
2098 an empty module name: someone called __import__("") or
2099 doctored faulty bytecode */
Thomas Wouters4bdaa272006-04-05 13:39:37 +00002100 Py_DECREF(tail);
2101 Py_DECREF(head);
Thomas Wouters8ddab272006-04-04 16:17:02 +00002102 PyErr_SetString(PyExc_ValueError,
2103 "Empty module name");
2104 return NULL;
2105 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002106
2107 if (fromlist != NULL) {
2108 if (fromlist == Py_None || !PyObject_IsTrue(fromlist))
2109 fromlist = NULL;
2110 }
2111
2112 if (fromlist == NULL) {
2113 Py_DECREF(tail);
2114 return head;
2115 }
2116
2117 Py_DECREF(head);
Guido van Rossum9905ef91997-09-08 16:07:11 +00002118 if (!ensure_fromlist(tail, fromlist, buf, buflen, 0)) {
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002119 Py_DECREF(tail);
2120 return NULL;
2121 }
2122
2123 return tail;
2124}
2125
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002126PyObject *
2127PyImport_ImportModuleLevel(char *name, PyObject *globals, PyObject *locals,
2128 PyObject *fromlist, int level)
2129{
2130 PyObject *result;
2131 lock_import();
2132 result = import_module_level(name, globals, locals, fromlist, level);
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00002133 if (unlock_import() < 0) {
2134 Py_XDECREF(result);
2135 PyErr_SetString(PyExc_RuntimeError,
2136 "not holding the import lock");
2137 return NULL;
2138 }
Guido van Rossum75acc9c1998-03-03 22:26:50 +00002139 return result;
2140}
2141
Fred Drake87590902004-05-28 20:21:36 +00002142/* Return the package that an import is being performed in. If globals comes
2143 from the module foo.bar.bat (not itself a package), this returns the
2144 sys.modules entry for foo.bar. If globals is from a package's __init__.py,
Georg Brandl5f6861d2006-05-28 21:57:35 +00002145 the package's entry in sys.modules is returned, as a borrowed reference.
Fred Drake87590902004-05-28 20:21:36 +00002146
2147 The *name* of the returned package is returned in buf, with the length of
2148 the name in *p_buflen.
2149
2150 If globals doesn't come from a package or a module in a package, or a
2151 corresponding entry is not found in sys.modules, Py_None is returned.
2152*/
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002153static PyObject *
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002154get_parent(PyObject *globals, char *buf, Py_ssize_t *p_buflen, int level)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002155{
2156 static PyObject *namestr = NULL;
2157 static PyObject *pathstr = NULL;
Nick Coghlanef01d822007-12-03 12:55:17 +00002158 static PyObject *pkgstr = NULL;
2159 PyObject *pkgname, *modname, *modpath, *modules, *parent;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002160
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002161 if (globals == NULL || !PyDict_Check(globals) || !level)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002162 return Py_None;
2163
2164 if (namestr == NULL) {
2165 namestr = PyString_InternFromString("__name__");
2166 if (namestr == NULL)
2167 return NULL;
2168 }
2169 if (pathstr == NULL) {
2170 pathstr = PyString_InternFromString("__path__");
2171 if (pathstr == NULL)
2172 return NULL;
2173 }
Nick Coghlanef01d822007-12-03 12:55:17 +00002174 if (pkgstr == NULL) {
2175 pkgstr = PyString_InternFromString("__package__");
2176 if (pkgstr == NULL)
2177 return NULL;
2178 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002179
2180 *buf = '\0';
2181 *p_buflen = 0;
Nick Coghlanef01d822007-12-03 12:55:17 +00002182 pkgname = PyDict_GetItem(globals, pkgstr);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002183
Nick Coghlanef01d822007-12-03 12:55:17 +00002184 if ((pkgname != NULL) && (pkgname != Py_None)) {
2185 /* __package__ is set, so use it */
2186 Py_ssize_t len;
2187 if (!PyString_Check(pkgname)) {
2188 PyErr_SetString(PyExc_ValueError,
2189 "__package__ set to non-string");
2190 return NULL;
2191 }
2192 len = PyString_GET_SIZE(pkgname);
2193 if (len == 0) {
2194 if (level > 0) {
2195 PyErr_SetString(PyExc_ValueError,
2196 "Attempted relative import in non-package");
2197 return NULL;
2198 }
2199 return Py_None;
2200 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002201 if (len > MAXPATHLEN) {
2202 PyErr_SetString(PyExc_ValueError,
Nick Coghlanef01d822007-12-03 12:55:17 +00002203 "Package name too long");
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002204 return NULL;
2205 }
Nick Coghlanef01d822007-12-03 12:55:17 +00002206 strcpy(buf, PyString_AS_STRING(pkgname));
2207 } else {
2208 /* __package__ not set, so figure it out and set it */
2209 modname = PyDict_GetItem(globals, namestr);
2210 if (modname == NULL || !PyString_Check(modname))
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002211 return Py_None;
Nick Coghlanef01d822007-12-03 12:55:17 +00002212
2213 modpath = PyDict_GetItem(globals, pathstr);
2214 if (modpath != NULL) {
2215 /* __path__ is set, so modname is already the package name */
2216 Py_ssize_t len = PyString_GET_SIZE(modname);
2217 int error;
2218 if (len > MAXPATHLEN) {
2219 PyErr_SetString(PyExc_ValueError,
2220 "Module name too long");
2221 return NULL;
2222 }
2223 strcpy(buf, PyString_AS_STRING(modname));
2224 error = PyDict_SetItem(globals, pkgstr, modname);
2225 if (error) {
2226 PyErr_SetString(PyExc_ValueError,
2227 "Could not set __package__");
2228 return NULL;
2229 }
2230 } else {
2231 /* Normal module, so work out the package name if any */
2232 char *start = PyString_AS_STRING(modname);
2233 char *lastdot = strrchr(start, '.');
2234 size_t len;
2235 int error;
2236 if (lastdot == NULL && level > 0) {
2237 PyErr_SetString(PyExc_ValueError,
2238 "Attempted relative import in non-package");
2239 return NULL;
2240 }
2241 if (lastdot == NULL) {
2242 error = PyDict_SetItem(globals, pkgstr, Py_None);
2243 if (error) {
2244 PyErr_SetString(PyExc_ValueError,
2245 "Could not set __package__");
2246 return NULL;
2247 }
2248 return Py_None;
2249 }
2250 len = lastdot - start;
2251 if (len >= MAXPATHLEN) {
2252 PyErr_SetString(PyExc_ValueError,
2253 "Module name too long");
2254 return NULL;
2255 }
2256 strncpy(buf, start, len);
2257 buf[len] = '\0';
2258 pkgname = PyString_FromString(buf);
2259 if (pkgname == NULL) {
2260 return NULL;
2261 }
2262 error = PyDict_SetItem(globals, pkgstr, pkgname);
2263 Py_DECREF(pkgname);
2264 if (error) {
2265 PyErr_SetString(PyExc_ValueError,
2266 "Could not set __package__");
2267 return NULL;
2268 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002269 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002270 }
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002271 while (--level > 0) {
2272 char *dot = strrchr(buf, '.');
2273 if (dot == NULL) {
2274 PyErr_SetString(PyExc_ValueError,
Georg Brandl98775df2006-09-06 06:09:31 +00002275 "Attempted relative import beyond "
2276 "toplevel package");
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002277 return NULL;
2278 }
2279 *dot = '\0';
2280 }
2281 *p_buflen = strlen(buf);
2282
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002283 modules = PyImport_GetModuleDict();
2284 parent = PyDict_GetItemString(modules, buf);
2285 if (parent == NULL)
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002286 PyErr_Format(PyExc_SystemError,
2287 "Parent module '%.200s' not loaded", buf);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002288 return parent;
2289 /* We expect, but can't guarantee, if parent != None, that:
2290 - parent.__name__ == buf
2291 - parent.__dict__ is globals
2292 If this is violated... Who cares? */
2293}
2294
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002295/* altmod is either None or same as mod */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002296static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002297load_next(PyObject *mod, PyObject *altmod, char **p_name, char *buf,
Martin v. Löwis18e16552006-02-15 17:27:45 +00002298 Py_ssize_t *p_buflen)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002299{
2300 char *name = *p_name;
2301 char *dot = strchr(name, '.');
Fred Drake4c82b232000-06-30 16:18:57 +00002302 size_t len;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002303 char *p;
2304 PyObject *result;
2305
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002306 if (strlen(name) == 0) {
Thomas Wouters8ddab272006-04-04 16:17:02 +00002307 /* completely empty module name should only happen in
2308 'from . import' (or '__import__("")')*/
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002309 Py_INCREF(mod);
2310 *p_name = NULL;
2311 return mod;
2312 }
2313
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002314 if (dot == NULL) {
2315 *p_name = NULL;
2316 len = strlen(name);
2317 }
2318 else {
2319 *p_name = dot+1;
2320 len = dot-name;
2321 }
Guido van Rossum111c20b1998-04-11 17:38:22 +00002322 if (len == 0) {
2323 PyErr_SetString(PyExc_ValueError,
2324 "Empty module name");
2325 return NULL;
2326 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002327
2328 p = buf + *p_buflen;
2329 if (p != buf)
2330 *p++ = '.';
2331 if (p+len-buf >= MAXPATHLEN) {
2332 PyErr_SetString(PyExc_ValueError,
2333 "Module name too long");
2334 return NULL;
2335 }
2336 strncpy(p, name, len);
2337 p[len] = '\0';
2338 *p_buflen = p+len-buf;
2339
2340 result = import_submodule(mod, p, buf);
2341 if (result == Py_None && altmod != mod) {
2342 Py_DECREF(result);
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00002343 /* Here, altmod must be None and mod must not be None */
Guido van Rossum0c819451997-09-07 06:16:57 +00002344 result = import_submodule(altmod, p, p);
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00002345 if (result != NULL && result != Py_None) {
2346 if (mark_miss(buf) != 0) {
2347 Py_DECREF(result);
2348 return NULL;
2349 }
2350 strncpy(buf, name, len);
2351 buf[len] = '\0';
2352 *p_buflen = len;
2353 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002354 }
2355 if (result == NULL)
2356 return NULL;
2357
2358 if (result == Py_None) {
2359 Py_DECREF(result);
2360 PyErr_Format(PyExc_ImportError,
2361 "No module named %.200s", name);
2362 return NULL;
2363 }
2364
2365 return result;
2366}
2367
2368static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002369mark_miss(char *name)
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00002370{
2371 PyObject *modules = PyImport_GetModuleDict();
2372 return PyDict_SetItemString(modules, name, Py_None);
2373}
2374
2375static int
Martin v. Löwis18e16552006-02-15 17:27:45 +00002376ensure_fromlist(PyObject *mod, PyObject *fromlist, char *buf, Py_ssize_t buflen,
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002377 int recursive)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002378{
2379 int i;
2380
2381 if (!PyObject_HasAttrString(mod, "__path__"))
2382 return 1;
2383
2384 for (i = 0; ; i++) {
2385 PyObject *item = PySequence_GetItem(fromlist, i);
2386 int hasit;
2387 if (item == NULL) {
2388 if (PyErr_ExceptionMatches(PyExc_IndexError)) {
2389 PyErr_Clear();
2390 return 1;
2391 }
2392 return 0;
2393 }
2394 if (!PyString_Check(item)) {
2395 PyErr_SetString(PyExc_TypeError,
2396 "Item in ``from list'' not a string");
2397 Py_DECREF(item);
2398 return 0;
2399 }
2400 if (PyString_AS_STRING(item)[0] == '*') {
Guido van Rossum9905ef91997-09-08 16:07:11 +00002401 PyObject *all;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002402 Py_DECREF(item);
Guido van Rossum9905ef91997-09-08 16:07:11 +00002403 /* See if the package defines __all__ */
2404 if (recursive)
2405 continue; /* Avoid endless recursion */
2406 all = PyObject_GetAttrString(mod, "__all__");
2407 if (all == NULL)
2408 PyErr_Clear();
2409 else {
Martin v. Löwis83969ee2004-03-23 16:28:13 +00002410 int ret = ensure_fromlist(mod, all, buf, buflen, 1);
Guido van Rossum9905ef91997-09-08 16:07:11 +00002411 Py_DECREF(all);
Martin v. Löwis83969ee2004-03-23 16:28:13 +00002412 if (!ret)
2413 return 0;
Guido van Rossum9905ef91997-09-08 16:07:11 +00002414 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002415 continue;
2416 }
2417 hasit = PyObject_HasAttr(mod, item);
2418 if (!hasit) {
2419 char *subname = PyString_AS_STRING(item);
2420 PyObject *submod;
2421 char *p;
2422 if (buflen + strlen(subname) >= MAXPATHLEN) {
2423 PyErr_SetString(PyExc_ValueError,
2424 "Module name too long");
2425 Py_DECREF(item);
2426 return 0;
2427 }
2428 p = buf + buflen;
2429 *p++ = '.';
2430 strcpy(p, subname);
2431 submod = import_submodule(mod, subname, buf);
2432 Py_XDECREF(submod);
2433 if (submod == NULL) {
2434 Py_DECREF(item);
2435 return 0;
2436 }
2437 }
2438 Py_DECREF(item);
2439 }
2440
Guido van Rossuma7f2e811997-10-03 15:33:32 +00002441 /* NOTREACHED */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002442}
2443
Neil Schemenauer00b09662003-06-16 21:03:07 +00002444static int
2445add_submodule(PyObject *mod, PyObject *submod, char *fullname, char *subname,
2446 PyObject *modules)
2447{
2448 if (mod == Py_None)
2449 return 1;
2450 /* Irrespective of the success of this load, make a
2451 reference to it in the parent package module. A copy gets
2452 saved in the modules dictionary under the full name, so get a
2453 reference from there, if need be. (The exception is when the
2454 load failed with a SyntaxError -- then there's no trace in
2455 sys.modules. In that case, of course, do nothing extra.) */
2456 if (submod == NULL) {
2457 submod = PyDict_GetItemString(modules, fullname);
2458 if (submod == NULL)
2459 return 1;
2460 }
2461 if (PyModule_Check(mod)) {
2462 /* We can't use setattr here since it can give a
2463 * spurious warning if the submodule name shadows a
2464 * builtin name */
2465 PyObject *dict = PyModule_GetDict(mod);
2466 if (!dict)
2467 return 0;
2468 if (PyDict_SetItemString(dict, subname, submod) < 0)
2469 return 0;
2470 }
2471 else {
2472 if (PyObject_SetAttrString(mod, subname, submod) < 0)
2473 return 0;
2474 }
2475 return 1;
2476}
2477
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002478static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002479import_submodule(PyObject *mod, char *subname, char *fullname)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002480{
Guido van Rossum25ce5661997-08-02 03:10:38 +00002481 PyObject *modules = PyImport_GetModuleDict();
Neil Schemenauer00b09662003-06-16 21:03:07 +00002482 PyObject *m = NULL;
Guido van Rossum74e6a111994-08-29 12:54:38 +00002483
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002484 /* Require:
2485 if mod == None: subname == fullname
2486 else: mod.__name__ + "." + subname == fullname
2487 */
2488
Tim Peters50d8d372001-02-28 05:34:27 +00002489 if ((m = PyDict_GetItemString(modules, fullname)) != NULL) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00002490 Py_INCREF(m);
Guido van Rossum7f9fa971995-01-20 16:53:12 +00002491 }
2492 else {
Just van Rossum52e14d62002-12-30 22:08:05 +00002493 PyObject *path, *loader = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002494 char buf[MAXPATHLEN+1];
2495 struct filedescr *fdp;
2496 FILE *fp = NULL;
2497
Guido van Rossum9c0afe51998-05-19 15:09:05 +00002498 if (mod == Py_None)
2499 path = NULL;
2500 else {
2501 path = PyObject_GetAttrString(mod, "__path__");
2502 if (path == NULL) {
2503 PyErr_Clear();
2504 Py_INCREF(Py_None);
2505 return Py_None;
2506 }
2507 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002508
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002509 buf[0] = '\0';
Just van Rossum52e14d62002-12-30 22:08:05 +00002510 fdp = find_module(fullname, subname, path, buf, MAXPATHLEN+1,
2511 &fp, &loader);
Guido van Rossumb68cd421998-07-01 17:36:26 +00002512 Py_XDECREF(path);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002513 if (fdp == NULL) {
2514 if (!PyErr_ExceptionMatches(PyExc_ImportError))
2515 return NULL;
2516 PyErr_Clear();
2517 Py_INCREF(Py_None);
2518 return Py_None;
2519 }
Just van Rossum52e14d62002-12-30 22:08:05 +00002520 m = load_module(fullname, fp, buf, fdp->type, loader);
2521 Py_XDECREF(loader);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002522 if (fp)
2523 fclose(fp);
Neil Schemenauer00b09662003-06-16 21:03:07 +00002524 if (!add_submodule(mod, m, fullname, subname, modules)) {
2525 Py_XDECREF(m);
2526 m = NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002527 }
Guido van Rossum74e6a111994-08-29 12:54:38 +00002528 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002529
2530 return m;
Guido van Rossum74e6a111994-08-29 12:54:38 +00002531}
2532
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002533
2534/* Re-import a module of any kind and return its module object, WITH
2535 INCREMENTED REFERENCE COUNT */
2536
Guido van Rossum79f25d91997-04-29 20:08:16 +00002537PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002538PyImport_ReloadModule(PyObject *m)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002539{
Collin Winter47c52a82007-03-13 23:02:15 +00002540 PyInterpreterState *interp = PyThreadState_Get()->interp;
2541 PyObject *modules_reloading = interp->modules_reloading;
Guido van Rossum25ce5661997-08-02 03:10:38 +00002542 PyObject *modules = PyImport_GetModuleDict();
Collin Winter276887b2007-03-12 16:11:39 +00002543 PyObject *path = NULL, *loader = NULL, *existing_m = NULL;
Guido van Rossum222ef561997-09-06 19:41:09 +00002544 char *name, *subname;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002545 char buf[MAXPATHLEN+1];
2546 struct filedescr *fdp;
2547 FILE *fp = NULL;
Tim Peters1cd70172004-08-02 03:52:12 +00002548 PyObject *newm;
Collin Winter47c52a82007-03-13 23:02:15 +00002549
2550 if (modules_reloading == NULL) {
2551 Py_FatalError("PyImport_ReloadModule: "
Neal Norwitz2fca81c2007-05-30 04:53:41 +00002552 "no modules_reloading dictionary!");
Collin Winter47c52a82007-03-13 23:02:15 +00002553 return NULL;
2554 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002555
Guido van Rossum79f25d91997-04-29 20:08:16 +00002556 if (m == NULL || !PyModule_Check(m)) {
2557 PyErr_SetString(PyExc_TypeError,
2558 "reload() argument must be module");
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002559 return NULL;
2560 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002561 name = PyModule_GetName(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002562 if (name == NULL)
2563 return NULL;
Guido van Rossum25ce5661997-08-02 03:10:38 +00002564 if (m != PyDict_GetItemString(modules, name)) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002565 PyErr_Format(PyExc_ImportError,
2566 "reload(): module %.200s not in sys.modules",
2567 name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002568 return NULL;
2569 }
Neal Norwitz75c7c802007-03-13 05:31:38 +00002570 existing_m = PyDict_GetItemString(modules_reloading, name);
2571 if (existing_m != NULL) {
2572 /* Due to a recursive reload, this module is already
2573 being reloaded. */
2574 Py_INCREF(existing_m);
2575 return existing_m;
Collin Winter276887b2007-03-12 16:11:39 +00002576 }
Neal Norwitz75c7c802007-03-13 05:31:38 +00002577 if (PyDict_SetItemString(modules_reloading, name, m) < 0)
2578 return NULL;
Collin Winter276887b2007-03-12 16:11:39 +00002579
Guido van Rossum222ef561997-09-06 19:41:09 +00002580 subname = strrchr(name, '.');
2581 if (subname == NULL)
2582 subname = name;
2583 else {
2584 PyObject *parentname, *parent;
2585 parentname = PyString_FromStringAndSize(name, (subname-name));
Collin Winter276887b2007-03-12 16:11:39 +00002586 if (parentname == NULL) {
2587 imp_modules_reloading_clear();
Guido van Rossum222ef561997-09-06 19:41:09 +00002588 return NULL;
Neal Norwitz75c7c802007-03-13 05:31:38 +00002589 }
Guido van Rossum222ef561997-09-06 19:41:09 +00002590 parent = PyDict_GetItem(modules, parentname);
2591 if (parent == NULL) {
2592 PyErr_Format(PyExc_ImportError,
2593 "reload(): parent %.200s not in sys.modules",
Georg Brandl0c55f292005-09-14 06:56:20 +00002594 PyString_AS_STRING(parentname));
2595 Py_DECREF(parentname);
Neal Norwitz2fca81c2007-05-30 04:53:41 +00002596 imp_modules_reloading_clear();
Guido van Rossum222ef561997-09-06 19:41:09 +00002597 return NULL;
2598 }
Georg Brandl0c55f292005-09-14 06:56:20 +00002599 Py_DECREF(parentname);
Guido van Rossum222ef561997-09-06 19:41:09 +00002600 subname++;
2601 path = PyObject_GetAttrString(parent, "__path__");
2602 if (path == NULL)
2603 PyErr_Clear();
2604 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002605 buf[0] = '\0';
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00002606 fdp = find_module(name, subname, path, buf, MAXPATHLEN+1, &fp, &loader);
Guido van Rossum222ef561997-09-06 19:41:09 +00002607 Py_XDECREF(path);
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00002608
2609 if (fdp == NULL) {
2610 Py_XDECREF(loader);
Collin Winter276887b2007-03-12 16:11:39 +00002611 imp_modules_reloading_clear();
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002612 return NULL;
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00002613 }
2614
2615 newm = load_module(name, fp, buf, fdp->type, loader);
2616 Py_XDECREF(loader);
2617
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002618 if (fp)
2619 fclose(fp);
Tim Peters1cd70172004-08-02 03:52:12 +00002620 if (newm == NULL) {
2621 /* load_module probably removed name from modules because of
2622 * the error. Put back the original module object. We're
2623 * going to return NULL in this case regardless of whether
2624 * replacing name succeeds, so the return value is ignored.
2625 */
2626 PyDict_SetItemString(modules, name, m);
2627 }
Neal Norwitz75c7c802007-03-13 05:31:38 +00002628 imp_modules_reloading_clear();
Tim Peters1cd70172004-08-02 03:52:12 +00002629 return newm;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002630}
2631
2632
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002633/* Higher-level import emulator which emulates the "import" statement
2634 more accurately -- it invokes the __import__() function from the
2635 builtins of the current globals. This means that the import is
2636 done using whatever import hooks are installed in the current
Guido van Rossum6058eb41998-12-21 19:51:00 +00002637 environment, e.g. by "rexec".
2638 A dummy list ["__doc__"] is passed as the 4th argument so that
2639 e.g. PyImport_Import(PyString_FromString("win32com.client.gencache"))
2640 will return <module "gencache"> instead of <module "win32com">. */
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002641
2642PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002643PyImport_Import(PyObject *module_name)
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002644{
2645 static PyObject *silly_list = NULL;
2646 static PyObject *builtins_str = NULL;
2647 static PyObject *import_str = NULL;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002648 PyObject *globals = NULL;
2649 PyObject *import = NULL;
2650 PyObject *builtins = NULL;
2651 PyObject *r = NULL;
2652
2653 /* Initialize constant string objects */
2654 if (silly_list == NULL) {
2655 import_str = PyString_InternFromString("__import__");
2656 if (import_str == NULL)
2657 return NULL;
2658 builtins_str = PyString_InternFromString("__builtins__");
2659 if (builtins_str == NULL)
2660 return NULL;
2661 silly_list = Py_BuildValue("[s]", "__doc__");
2662 if (silly_list == NULL)
2663 return NULL;
2664 }
2665
2666 /* Get the builtins from current globals */
2667 globals = PyEval_GetGlobals();
Guido van Rossum85cd1d62001-02-20 21:43:24 +00002668 if (globals != NULL) {
Guido van Rossum66468561998-10-22 15:46:50 +00002669 Py_INCREF(globals);
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002670 builtins = PyObject_GetItem(globals, builtins_str);
2671 if (builtins == NULL)
2672 goto err;
2673 }
2674 else {
2675 /* No globals -- use standard builtins, and fake globals */
2676 PyErr_Clear();
2677
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002678 builtins = PyImport_ImportModuleLevel("__builtin__",
2679 NULL, NULL, NULL, 0);
Guido van Rossum85cd1d62001-02-20 21:43:24 +00002680 if (builtins == NULL)
2681 return NULL;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002682 globals = Py_BuildValue("{OO}", builtins_str, builtins);
2683 if (globals == NULL)
2684 goto err;
2685 }
2686
2687 /* Get the __import__ function from the builtins */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002688 if (PyDict_Check(builtins)) {
Fred Drakea76ba6e2001-03-06 06:31:15 +00002689 import = PyObject_GetItem(builtins, import_str);
Tim Peters6d6c1a32001-08-02 04:15:00 +00002690 if (import == NULL)
2691 PyErr_SetObject(PyExc_KeyError, import_str);
2692 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002693 else
Fred Drakea76ba6e2001-03-06 06:31:15 +00002694 import = PyObject_GetAttr(builtins, import_str);
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002695 if (import == NULL)
2696 goto err;
2697
Christian Heimes000a0742008-01-03 22:16:32 +00002698 /* Call the __import__ function with the proper argument list
2699 * Always use absolute import here. */
2700 r = PyObject_CallFunction(import, "OOOOi", module_name, globals,
2701 globals, silly_list, 0, NULL);
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002702
2703 err:
2704 Py_XDECREF(globals);
2705 Py_XDECREF(builtins);
2706 Py_XDECREF(import);
Tim Peters50d8d372001-02-28 05:34:27 +00002707
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002708 return r;
2709}
2710
2711
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002712/* Module 'imp' provides Python access to the primitives used for
2713 importing modules.
2714*/
2715
Guido van Rossum79f25d91997-04-29 20:08:16 +00002716static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +00002717imp_get_magic(PyObject *self, PyObject *noargs)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002718{
2719 char buf[4];
2720
Guido van Rossum96774c12000-05-01 20:19:08 +00002721 buf[0] = (char) ((pyc_magic >> 0) & 0xff);
2722 buf[1] = (char) ((pyc_magic >> 8) & 0xff);
2723 buf[2] = (char) ((pyc_magic >> 16) & 0xff);
2724 buf[3] = (char) ((pyc_magic >> 24) & 0xff);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002725
Guido van Rossum79f25d91997-04-29 20:08:16 +00002726 return PyString_FromStringAndSize(buf, 4);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002727}
2728
Guido van Rossum79f25d91997-04-29 20:08:16 +00002729static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +00002730imp_get_suffixes(PyObject *self, PyObject *noargs)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002731{
Guido van Rossum79f25d91997-04-29 20:08:16 +00002732 PyObject *list;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002733 struct filedescr *fdp;
2734
Guido van Rossum79f25d91997-04-29 20:08:16 +00002735 list = PyList_New(0);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002736 if (list == NULL)
2737 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002738 for (fdp = _PyImport_Filetab; fdp->suffix != NULL; fdp++) {
2739 PyObject *item = Py_BuildValue("ssi",
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002740 fdp->suffix, fdp->mode, fdp->type);
2741 if (item == NULL) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00002742 Py_DECREF(list);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002743 return NULL;
2744 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002745 if (PyList_Append(list, item) < 0) {
2746 Py_DECREF(list);
2747 Py_DECREF(item);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002748 return NULL;
2749 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002750 Py_DECREF(item);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002751 }
2752 return list;
2753}
2754
Guido van Rossum79f25d91997-04-29 20:08:16 +00002755static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002756call_find_module(char *name, PyObject *path)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002757{
Tim Petersdbd9ba62000-07-09 03:09:57 +00002758 extern int fclose(FILE *);
Guido van Rossum79f25d91997-04-29 20:08:16 +00002759 PyObject *fob, *ret;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002760 struct filedescr *fdp;
2761 char pathname[MAXPATHLEN+1];
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002762 FILE *fp = NULL;
2763
2764 pathname[0] = '\0';
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002765 if (path == Py_None)
2766 path = NULL;
Just van Rossum52e14d62002-12-30 22:08:05 +00002767 fdp = find_module(NULL, name, path, pathname, MAXPATHLEN+1, &fp, NULL);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002768 if (fdp == NULL)
2769 return NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002770 if (fp != NULL) {
2771 fob = PyFile_FromFile(fp, pathname, fdp->mode, fclose);
2772 if (fob == NULL) {
2773 fclose(fp);
2774 return NULL;
2775 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002776 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002777 else {
2778 fob = Py_None;
2779 Py_INCREF(fob);
Tim Peters50d8d372001-02-28 05:34:27 +00002780 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002781 ret = Py_BuildValue("Os(ssi)",
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002782 fob, pathname, fdp->suffix, fdp->mode, fdp->type);
Guido van Rossum79f25d91997-04-29 20:08:16 +00002783 Py_DECREF(fob);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002784 return ret;
2785}
2786
Guido van Rossum79f25d91997-04-29 20:08:16 +00002787static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002788imp_find_module(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002789{
2790 char *name;
2791 PyObject *path = NULL;
Guido van Rossum43713e52000-02-29 13:59:29 +00002792 if (!PyArg_ParseTuple(args, "s|O:find_module", &name, &path))
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002793 return NULL;
2794 return call_find_module(name, path);
2795}
2796
2797static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002798imp_init_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002799{
2800 char *name;
2801 int ret;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002802 PyObject *m;
Guido van Rossum43713e52000-02-29 13:59:29 +00002803 if (!PyArg_ParseTuple(args, "s:init_builtin", &name))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002804 return NULL;
2805 ret = init_builtin(name);
2806 if (ret < 0)
2807 return NULL;
2808 if (ret == 0) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00002809 Py_INCREF(Py_None);
2810 return Py_None;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002811 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002812 m = PyImport_AddModule(name);
2813 Py_XINCREF(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002814 return m;
2815}
2816
Guido van Rossum79f25d91997-04-29 20:08:16 +00002817static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002818imp_init_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002819{
2820 char *name;
2821 int ret;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002822 PyObject *m;
Guido van Rossum43713e52000-02-29 13:59:29 +00002823 if (!PyArg_ParseTuple(args, "s:init_frozen", &name))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002824 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002825 ret = PyImport_ImportFrozenModule(name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002826 if (ret < 0)
2827 return NULL;
2828 if (ret == 0) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00002829 Py_INCREF(Py_None);
2830 return Py_None;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002831 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002832 m = PyImport_AddModule(name);
2833 Py_XINCREF(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002834 return m;
2835}
2836
Guido van Rossum79f25d91997-04-29 20:08:16 +00002837static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002838imp_get_frozen_object(PyObject *self, PyObject *args)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002839{
2840 char *name;
Jack Jansen95ffa231995-10-03 14:38:41 +00002841
Guido van Rossum43713e52000-02-29 13:59:29 +00002842 if (!PyArg_ParseTuple(args, "s:get_frozen_object", &name))
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002843 return NULL;
2844 return get_frozen_object(name);
2845}
2846
Guido van Rossum79f25d91997-04-29 20:08:16 +00002847static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002848imp_is_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002849{
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002850 char *name;
Guido van Rossum43713e52000-02-29 13:59:29 +00002851 if (!PyArg_ParseTuple(args, "s:is_builtin", &name))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002852 return NULL;
Guido van Rossum50ee94f2002-04-09 18:00:58 +00002853 return PyInt_FromLong(is_builtin(name));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002854}
2855
Guido van Rossum79f25d91997-04-29 20:08:16 +00002856static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002857imp_is_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002858{
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002859 char *name;
Guido van Rossum323bf5e1998-06-24 03:54:06 +00002860 struct _frozen *p;
Guido van Rossum43713e52000-02-29 13:59:29 +00002861 if (!PyArg_ParseTuple(args, "s:is_frozen", &name))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002862 return NULL;
Guido van Rossum323bf5e1998-06-24 03:54:06 +00002863 p = find_frozen(name);
Guido van Rossumb8bff3f2002-04-07 06:34:38 +00002864 return PyBool_FromLong((long) (p == NULL ? 0 : p->size));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002865}
2866
2867static FILE *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002868get_file(char *pathname, PyObject *fob, char *mode)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002869{
2870 FILE *fp;
2871 if (fob == NULL) {
Tim Peters86c7d2f2004-08-01 23:24:21 +00002872 if (mode[0] == 'U')
Jeremy Hylton4ae6fae2002-05-30 17:15:25 +00002873 mode = "r" PY_STDIOTEXTMODE;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002874 fp = fopen(pathname, mode);
2875 if (fp == NULL)
Guido van Rossum79f25d91997-04-29 20:08:16 +00002876 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002877 }
2878 else {
Guido van Rossum79f25d91997-04-29 20:08:16 +00002879 fp = PyFile_AsFile(fob);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002880 if (fp == NULL)
Guido van Rossum79f25d91997-04-29 20:08:16 +00002881 PyErr_SetString(PyExc_ValueError,
2882 "bad/closed file object");
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002883 }
2884 return fp;
2885}
2886
Guido van Rossum79f25d91997-04-29 20:08:16 +00002887static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002888imp_load_compiled(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002889{
2890 char *name;
2891 char *pathname;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002892 PyObject *fob = NULL;
2893 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002894 FILE *fp;
Guido van Rossum43713e52000-02-29 13:59:29 +00002895 if (!PyArg_ParseTuple(args, "ss|O!:load_compiled", &name, &pathname,
Guido van Rossum79f25d91997-04-29 20:08:16 +00002896 &PyFile_Type, &fob))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002897 return NULL;
2898 fp = get_file(pathname, fob, "rb");
2899 if (fp == NULL)
2900 return NULL;
2901 m = load_compiled_module(name, pathname, fp);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002902 if (fob == NULL)
2903 fclose(fp);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002904 return m;
2905}
2906
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002907#ifdef HAVE_DYNAMIC_LOADING
2908
Guido van Rossum79f25d91997-04-29 20:08:16 +00002909static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002910imp_load_dynamic(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002911{
2912 char *name;
2913 char *pathname;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002914 PyObject *fob = NULL;
2915 PyObject *m;
Guido van Rossum7faeab31995-07-07 22:50:36 +00002916 FILE *fp = NULL;
Guido van Rossum43713e52000-02-29 13:59:29 +00002917 if (!PyArg_ParseTuple(args, "ss|O!:load_dynamic", &name, &pathname,
Guido van Rossum79f25d91997-04-29 20:08:16 +00002918 &PyFile_Type, &fob))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002919 return NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002920 if (fob) {
Guido van Rossum7faeab31995-07-07 22:50:36 +00002921 fp = get_file(pathname, fob, "r");
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002922 if (fp == NULL)
2923 return NULL;
2924 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002925 m = _PyImport_LoadDynamicModule(name, pathname, fp);
Guido van Rossum7faeab31995-07-07 22:50:36 +00002926 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002927}
2928
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002929#endif /* HAVE_DYNAMIC_LOADING */
2930
Guido van Rossum79f25d91997-04-29 20:08:16 +00002931static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002932imp_load_source(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002933{
2934 char *name;
2935 char *pathname;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002936 PyObject *fob = NULL;
2937 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002938 FILE *fp;
Guido van Rossum43713e52000-02-29 13:59:29 +00002939 if (!PyArg_ParseTuple(args, "ss|O!:load_source", &name, &pathname,
Guido van Rossum79f25d91997-04-29 20:08:16 +00002940 &PyFile_Type, &fob))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002941 return NULL;
2942 fp = get_file(pathname, fob, "r");
2943 if (fp == NULL)
2944 return NULL;
2945 m = load_source_module(name, pathname, fp);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002946 if (fob == NULL)
2947 fclose(fp);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002948 return m;
2949}
2950
Guido van Rossum79f25d91997-04-29 20:08:16 +00002951static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002952imp_load_module(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002953{
2954 char *name;
2955 PyObject *fob;
2956 char *pathname;
2957 char *suffix; /* Unused */
2958 char *mode;
2959 int type;
2960 FILE *fp;
2961
Guido van Rossum43713e52000-02-29 13:59:29 +00002962 if (!PyArg_ParseTuple(args, "sOs(ssi):load_module",
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002963 &name, &fob, &pathname,
2964 &suffix, &mode, &type))
2965 return NULL;
Guido van Rossum5e2c5fa2002-05-30 17:33:07 +00002966 if (*mode) {
2967 /* Mode must start with 'r' or 'U' and must not contain '+'.
2968 Implicit in this test is the assumption that the mode
2969 may contain other modifiers like 'b' or 't'. */
2970
2971 if (!(*mode == 'r' || *mode == 'U') || strchr(mode, '+')) {
Jeremy Hylton4ae6fae2002-05-30 17:15:25 +00002972 PyErr_Format(PyExc_ValueError,
2973 "invalid file open mode %.200s", mode);
2974 return NULL;
Guido van Rossum5e2c5fa2002-05-30 17:33:07 +00002975 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002976 }
2977 if (fob == Py_None)
2978 fp = NULL;
2979 else {
2980 if (!PyFile_Check(fob)) {
2981 PyErr_SetString(PyExc_ValueError,
2982 "load_module arg#2 should be a file or None");
2983 return NULL;
2984 }
2985 fp = get_file(pathname, fob, mode);
2986 if (fp == NULL)
2987 return NULL;
2988 }
Just van Rossum52e14d62002-12-30 22:08:05 +00002989 return load_module(name, fp, pathname, type, NULL);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002990}
2991
2992static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002993imp_load_package(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002994{
2995 char *name;
2996 char *pathname;
Guido van Rossum43713e52000-02-29 13:59:29 +00002997 if (!PyArg_ParseTuple(args, "ss:load_package", &name, &pathname))
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002998 return NULL;
2999 return load_package(name, pathname);
3000}
3001
3002static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003003imp_new_module(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003004{
3005 char *name;
Guido van Rossum43713e52000-02-29 13:59:29 +00003006 if (!PyArg_ParseTuple(args, "s:new_module", &name))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003007 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +00003008 return PyModule_New(name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003009}
3010
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003011/* Doc strings */
3012
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003013PyDoc_STRVAR(doc_imp,
3014"This module provides the components needed to build your own\n\
3015__import__ function. Undocumented functions are obsolete.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003016
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003017PyDoc_STRVAR(doc_find_module,
3018"find_module(name, [path]) -> (file, filename, (suffix, mode, type))\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003019Search for a module. If path is omitted or None, search for a\n\
3020built-in, frozen or special module and continue search in sys.path.\n\
3021The module name cannot contain '.'; to search for a submodule of a\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003022package, pass the submodule name and the package's __path__.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003023
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003024PyDoc_STRVAR(doc_load_module,
3025"load_module(name, file, filename, (suffix, mode, type)) -> module\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003026Load a module, given information returned by find_module().\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003027The module name must include the full package name, if any.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003028
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003029PyDoc_STRVAR(doc_get_magic,
3030"get_magic() -> string\n\
3031Return the magic number for .pyc or .pyo files.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003032
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003033PyDoc_STRVAR(doc_get_suffixes,
3034"get_suffixes() -> [(suffix, mode, type), ...]\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003035Return a list of (suffix, mode, type) tuples describing the files\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003036that find_module() looks for.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003037
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003038PyDoc_STRVAR(doc_new_module,
3039"new_module(name) -> module\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003040Create a new module. Do not enter it in sys.modules.\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003041The module name must include the full package name, if any.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003042
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003043PyDoc_STRVAR(doc_lock_held,
Tim Petersa7c65092004-08-01 23:26:05 +00003044"lock_held() -> boolean\n\
3045Return True if the import lock is currently held, else False.\n\
3046On platforms without threads, return False.");
Tim Peters69232342001-08-30 05:16:13 +00003047
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00003048PyDoc_STRVAR(doc_acquire_lock,
3049"acquire_lock() -> None\n\
Neal Norwitz2294c0d2003-02-12 23:02:21 +00003050Acquires the interpreter's import lock for the current thread.\n\
3051This lock should be used by import hooks to ensure thread-safety\n\
3052when importing modules.\n\
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00003053On platforms without threads, this function does nothing.");
3054
3055PyDoc_STRVAR(doc_release_lock,
3056"release_lock() -> None\n\
3057Release the interpreter's import lock.\n\
3058On platforms without threads, this function does nothing.");
3059
Guido van Rossum79f25d91997-04-29 20:08:16 +00003060static PyMethodDef imp_methods[] = {
Neal Norwitz08ea61a2003-02-17 18:18:00 +00003061 {"find_module", imp_find_module, METH_VARARGS, doc_find_module},
3062 {"get_magic", imp_get_magic, METH_NOARGS, doc_get_magic},
3063 {"get_suffixes", imp_get_suffixes, METH_NOARGS, doc_get_suffixes},
3064 {"load_module", imp_load_module, METH_VARARGS, doc_load_module},
3065 {"new_module", imp_new_module, METH_VARARGS, doc_new_module},
3066 {"lock_held", imp_lock_held, METH_NOARGS, doc_lock_held},
3067 {"acquire_lock", imp_acquire_lock, METH_NOARGS, doc_acquire_lock},
3068 {"release_lock", imp_release_lock, METH_NOARGS, doc_release_lock},
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003069 /* The rest are obsolete */
Neal Norwitz031829d2002-03-31 14:37:44 +00003070 {"get_frozen_object", imp_get_frozen_object, METH_VARARGS},
3071 {"init_builtin", imp_init_builtin, METH_VARARGS},
3072 {"init_frozen", imp_init_frozen, METH_VARARGS},
3073 {"is_builtin", imp_is_builtin, METH_VARARGS},
3074 {"is_frozen", imp_is_frozen, METH_VARARGS},
3075 {"load_compiled", imp_load_compiled, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003076#ifdef HAVE_DYNAMIC_LOADING
Neal Norwitz031829d2002-03-31 14:37:44 +00003077 {"load_dynamic", imp_load_dynamic, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003078#endif
Neal Norwitz031829d2002-03-31 14:37:44 +00003079 {"load_package", imp_load_package, METH_VARARGS},
Neal Norwitz031829d2002-03-31 14:37:44 +00003080 {"load_source", imp_load_source, METH_VARARGS},
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003081 {NULL, NULL} /* sentinel */
3082};
3083
Guido van Rossum1a8791e1998-08-04 22:46:29 +00003084static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003085setint(PyObject *d, char *name, int value)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003086{
3087 PyObject *v;
3088 int err;
3089
3090 v = PyInt_FromLong((long)value);
3091 err = PyDict_SetItemString(d, name, v);
3092 Py_XDECREF(v);
3093 return err;
3094}
3095
Phillip J. Ebyf7575d02006-07-28 21:12:07 +00003096typedef struct {
3097 PyObject_HEAD
3098} NullImporter;
3099
3100static int
3101NullImporter_init(NullImporter *self, PyObject *args, PyObject *kwds)
3102{
3103 char *path;
Christian Heimescea681b2007-11-07 17:50:54 +00003104 Py_ssize_t pathlen;
Phillip J. Ebyf7575d02006-07-28 21:12:07 +00003105
3106 if (!_PyArg_NoKeywords("NullImporter()", kwds))
3107 return -1;
3108
3109 if (!PyArg_ParseTuple(args, "s:NullImporter",
3110 &path))
3111 return -1;
3112
Christian Heimescea681b2007-11-07 17:50:54 +00003113 pathlen = strlen(path);
3114 if (pathlen == 0) {
Phillip J. Ebyf7575d02006-07-28 21:12:07 +00003115 PyErr_SetString(PyExc_ImportError, "empty pathname");
3116 return -1;
3117 } else {
3118#ifndef RISCOS
3119 struct stat statbuf;
3120 int rv;
3121
3122 rv = stat(path, &statbuf);
Christian Heimes004c1c12007-11-07 18:30:22 +00003123#ifdef MS_WINDOWS
3124 /* MS Windows stat() chokes on paths like C:\path\. Try to
3125 * recover *one* time by stripping off a trailing slash or
3126 * backslash. http://bugs.python.org/issue1293
3127 */
Christian Heimescea681b2007-11-07 17:50:54 +00003128 if (rv != 0 && pathlen <= MAXPATHLEN &&
3129 (path[pathlen-1] == '/' || path[pathlen-1] == '\\')) {
3130 char mangled[MAXPATHLEN+1];
3131
3132 strcpy(mangled, path);
3133 mangled[pathlen-1] = '\0';
3134 rv = stat(mangled, &statbuf);
3135 }
Christian Heimescea681b2007-11-07 17:50:54 +00003136#endif
Phillip J. Ebyf7575d02006-07-28 21:12:07 +00003137 if (rv == 0) {
3138 /* it exists */
3139 if (S_ISDIR(statbuf.st_mode)) {
3140 /* it's a directory */
3141 PyErr_SetString(PyExc_ImportError,
3142 "existing directory");
3143 return -1;
3144 }
3145 }
3146#else
3147 if (object_exists(path)) {
3148 /* it exists */
3149 if (isdir(path)) {
3150 /* it's a directory */
3151 PyErr_SetString(PyExc_ImportError,
3152 "existing directory");
3153 return -1;
3154 }
3155 }
3156#endif
3157 }
3158 return 0;
3159}
3160
3161static PyObject *
3162NullImporter_find_module(NullImporter *self, PyObject *args)
3163{
3164 Py_RETURN_NONE;
3165}
3166
3167static PyMethodDef NullImporter_methods[] = {
3168 {"find_module", (PyCFunction)NullImporter_find_module, METH_VARARGS,
3169 "Always return None"
3170 },
3171 {NULL} /* Sentinel */
3172};
3173
3174
Nick Coghlan327a39b2007-11-18 11:56:28 +00003175PyTypeObject PyNullImporter_Type = {
Martin v. Löwis68192102007-07-21 06:55:02 +00003176 PyVarObject_HEAD_INIT(NULL, 0)
Phillip J. Ebyf7575d02006-07-28 21:12:07 +00003177 "imp.NullImporter", /*tp_name*/
3178 sizeof(NullImporter), /*tp_basicsize*/
3179 0, /*tp_itemsize*/
3180 0, /*tp_dealloc*/
3181 0, /*tp_print*/
3182 0, /*tp_getattr*/
3183 0, /*tp_setattr*/
3184 0, /*tp_compare*/
3185 0, /*tp_repr*/
3186 0, /*tp_as_number*/
3187 0, /*tp_as_sequence*/
3188 0, /*tp_as_mapping*/
3189 0, /*tp_hash */
3190 0, /*tp_call*/
3191 0, /*tp_str*/
3192 0, /*tp_getattro*/
3193 0, /*tp_setattro*/
3194 0, /*tp_as_buffer*/
3195 Py_TPFLAGS_DEFAULT, /*tp_flags*/
3196 "Null importer object", /* tp_doc */
3197 0, /* tp_traverse */
3198 0, /* tp_clear */
3199 0, /* tp_richcompare */
3200 0, /* tp_weaklistoffset */
3201 0, /* tp_iter */
3202 0, /* tp_iternext */
3203 NullImporter_methods, /* tp_methods */
3204 0, /* tp_members */
3205 0, /* tp_getset */
3206 0, /* tp_base */
3207 0, /* tp_dict */
3208 0, /* tp_descr_get */
3209 0, /* tp_descr_set */
3210 0, /* tp_dictoffset */
3211 (initproc)NullImporter_init, /* tp_init */
3212 0, /* tp_alloc */
3213 PyType_GenericNew /* tp_new */
3214};
3215
3216
Jason Tishler6bc06ec2003-09-04 11:59:50 +00003217PyMODINIT_FUNC
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003218initimp(void)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003219{
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003220 PyObject *m, *d;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003221
Nick Coghlan327a39b2007-11-18 11:56:28 +00003222 if (PyType_Ready(&PyNullImporter_Type) < 0)
Phillip J. Ebyf7575d02006-07-28 21:12:07 +00003223 goto failure;
3224
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003225 m = Py_InitModule4("imp", imp_methods, doc_imp,
3226 NULL, PYTHON_API_VERSION);
Neal Norwitz1ac754f2006-01-19 06:09:39 +00003227 if (m == NULL)
3228 goto failure;
Guido van Rossum79f25d91997-04-29 20:08:16 +00003229 d = PyModule_GetDict(m);
Neal Norwitz3cb31ac2006-08-13 18:10:47 +00003230 if (d == NULL)
3231 goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003232
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003233 if (setint(d, "SEARCH_ERROR", SEARCH_ERROR) < 0) goto failure;
3234 if (setint(d, "PY_SOURCE", PY_SOURCE) < 0) goto failure;
3235 if (setint(d, "PY_COMPILED", PY_COMPILED) < 0) goto failure;
3236 if (setint(d, "C_EXTENSION", C_EXTENSION) < 0) goto failure;
3237 if (setint(d, "PY_RESOURCE", PY_RESOURCE) < 0) goto failure;
3238 if (setint(d, "PKG_DIRECTORY", PKG_DIRECTORY) < 0) goto failure;
3239 if (setint(d, "C_BUILTIN", C_BUILTIN) < 0) goto failure;
3240 if (setint(d, "PY_FROZEN", PY_FROZEN) < 0) goto failure;
Guido van Rossum0f84a341998-08-06 13:36:01 +00003241 if (setint(d, "PY_CODERESOURCE", PY_CODERESOURCE) < 0) goto failure;
Just van Rossum52e14d62002-12-30 22:08:05 +00003242 if (setint(d, "IMP_HOOK", IMP_HOOK) < 0) goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003243
Nick Coghlan327a39b2007-11-18 11:56:28 +00003244 Py_INCREF(&PyNullImporter_Type);
3245 PyModule_AddObject(m, "NullImporter", (PyObject *)&PyNullImporter_Type);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003246 failure:
3247 ;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003248}
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003249
3250
Guido van Rossumb18618d2000-05-03 23:44:39 +00003251/* API for embedding applications that want to add their own entries
3252 to the table of built-in modules. This should normally be called
3253 *before* Py_Initialize(). When the table resize fails, -1 is
3254 returned and the existing table is unchanged.
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003255
3256 After a similar function by Just van Rossum. */
3257
3258int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003259PyImport_ExtendInittab(struct _inittab *newtab)
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003260{
3261 static struct _inittab *our_copy = NULL;
3262 struct _inittab *p;
3263 int i, n;
3264
3265 /* Count the number of entries in both tables */
3266 for (n = 0; newtab[n].name != NULL; n++)
3267 ;
3268 if (n == 0)
3269 return 0; /* Nothing to do */
3270 for (i = 0; PyImport_Inittab[i].name != NULL; i++)
3271 ;
3272
3273 /* Allocate new memory for the combined table */
Guido van Rossumb18618d2000-05-03 23:44:39 +00003274 p = our_copy;
3275 PyMem_RESIZE(p, struct _inittab, i+n+1);
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003276 if (p == NULL)
3277 return -1;
3278
3279 /* Copy the tables into the new memory */
3280 if (our_copy != PyImport_Inittab)
3281 memcpy(p, PyImport_Inittab, (i+1) * sizeof(struct _inittab));
3282 PyImport_Inittab = our_copy = p;
3283 memcpy(p+i, newtab, (n+1) * sizeof(struct _inittab));
3284
3285 return 0;
3286}
3287
3288/* Shorthand to add a single entry given a name and a function */
3289
3290int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003291PyImport_AppendInittab(char *name, void (*initfunc)(void))
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003292{
3293 struct _inittab newtab[2];
3294
3295 memset(newtab, '\0', sizeof newtab);
3296
3297 newtab[0].name = name;
3298 newtab[0].initfunc = initfunc;
3299
3300 return PyImport_ExtendInittab(newtab);
3301}
Anthony Baxterac6bd462006-04-13 02:06:09 +00003302
3303#ifdef __cplusplus
3304}
3305#endif