blob: b97b3eb8402add098325b5b925b691abec759006 [file] [log] [blame]
Guido van Rossumf70e43a1991-02-19 12:39:46 +00001
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002/* Module definition and import implementation */
3
Guido van Rossum79f25d91997-04-29 20:08:16 +00004#include "Python.h"
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00005
Jeremy Hylton3e0055f2005-10-20 19:59:25 +00006#include "Python-ast.h"
Guido van Rossumd8faa362007-04-27 19:54:29 +00007#undef Yield /* undefine macro conflicting with winbase.h */
Neal Norwitzadb69fc2005-12-17 20:54:49 +00008#include "pyarena.h"
Jeremy Hylton3e0055f2005-10-20 19:59:25 +00009#include "pythonrun.h"
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000010#include "errcode.h"
Guido van Rossumc405b7b1991-06-04 19:39:42 +000011#include "marshal.h"
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000012#include "code.h"
Guido van Rossumc405b7b1991-06-04 19:39:42 +000013#include "compile.h"
Guido van Rossumff4949e1992-08-05 19:58:53 +000014#include "eval.h"
Guido van Rossumd8bac6d1992-02-26 15:19:13 +000015#include "osdefs.h"
Guido van Rossum1ae940a1995-01-02 19:04:15 +000016#include "importdl.h"
Guido van Rossumc405b7b1991-06-04 19:39:42 +000017
Guido van Rossum55a83382000-09-20 20:31:38 +000018#ifdef HAVE_FCNTL_H
19#include <fcntl.h>
20#endif
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000021#ifdef __cplusplus
22extern "C" {
23#endif
Guido van Rossum55a83382000-09-20 20:31:38 +000024
Thomas Woutersf70ef4f2000-07-22 18:47:25 +000025extern time_t PyOS_GetLastModificationTime(char *, FILE *);
26 /* In getmtime.c */
Guido van Rossum21d335e1993-10-15 13:01:11 +000027
Jeremy Hyltond4ceb312004-04-01 02:45:22 +000028/* Magic word to reject .pyc files generated by other Python versions.
29 It should change for each incompatible change to the bytecode.
30
31 The value of CR and LF is incorporated so if you ever read or write
Guido van Rossum7faeab31995-07-07 22:50:36 +000032 a .pyc file in text mode the magic number will be wrong; also, the
Tim Peters36515e22001-11-18 04:06:29 +000033 Apple MPW compiler swaps their values, botching string constants.
Marc-André Lemburgbd3be8f2002-02-07 11:33:49 +000034
Guido van Rossum45aecf42006-03-15 04:58:47 +000035 The magic numbers must be spaced apart at least 2 values, as the
Martin v. Löwisef82d2f2004-06-27 16:51:46 +000036 -U interpeter flag will cause MAGIC+1 being used. They have been
37 odd numbers for some time now.
Marc-André Lemburgbd3be8f2002-02-07 11:33:49 +000038
Jeremy Hyltond4ceb312004-04-01 02:45:22 +000039 There were a variety of old schemes for setting the magic number.
40 The current working scheme is to increment the previous value by
41 10.
Guido van Rossumf6894922002-08-31 15:16:14 +000042
Marc-André Lemburgbd3be8f2002-02-07 11:33:49 +000043 Known values:
44 Python 1.5: 20121
45 Python 1.5.1: 20121
46 Python 1.5.2: 20121
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000047 Python 1.6: 50428
Marc-André Lemburgbd3be8f2002-02-07 11:33:49 +000048 Python 2.0: 50823
49 Python 2.0.1: 50823
50 Python 2.1: 60202
51 Python 2.1.1: 60202
52 Python 2.1.2: 60202
53 Python 2.2: 60717
Neal Norwitz7fdcb412002-06-14 01:07:39 +000054 Python 2.3a0: 62011
Michael W. Hudsondd32a912002-08-15 14:59:02 +000055 Python 2.3a0: 62021
Guido van Rossumf6894922002-08-31 15:16:14 +000056 Python 2.3a0: 62011 (!)
Martin v. Löwisef82d2f2004-06-27 16:51:46 +000057 Python 2.4a0: 62041
Raymond Hettingerfd2d1f72004-08-23 23:37:48 +000058 Python 2.4a3: 62051
Raymond Hettinger2c31a052004-09-22 18:44:21 +000059 Python 2.4b1: 62061
Michael W. Hudsondf888462005-06-03 14:41:55 +000060 Python 2.5a0: 62071
Michael W. Hudsonaee2e282005-10-21 11:32:20 +000061 Python 2.5a0: 62081 (ast-branch)
Guido van Rossumc2e20742006-02-27 22:32:47 +000062 Python 2.5a0: 62091 (with)
Guido van Rossumf6694362006-03-10 02:28:35 +000063 Python 2.5a0: 62092 (changed WITH_CLEANUP opcode)
Thomas Wouters0e3f5912006-08-11 14:57:12 +000064 Python 2.5b3: 62101 (fix wrong code: for x, in ...)
65 Python 2.5b3: 62111 (fix wrong code: x += yield)
66 Python 2.5c1: 62121 (fix wrong lnotab with for loops and
67 storing constants that should have been removed)
Thomas Wouters89f507f2006-12-13 04:49:30 +000068 Python 2.5c2: 62131 (fix wrong code: for x, in ... in listcomp/genexp)
69 Python 2.6a0: 62141 (peephole optimizations)
Guido van Rossum45aecf42006-03-15 04:58:47 +000070 Python 3000: 3000
Brett Cannone2e23ef2006-08-25 05:05:30 +000071 3010 (removed UNARY_CONVERT)
Guido van Rossum86e58e22006-08-28 15:27:34 +000072 3020 (added BUILD_SET)
Guido van Rossum4f72a782006-10-27 23:31:49 +000073 3030 (added keyword-only parameters)
Guido van Rossum3203bdc2006-12-28 21:03:31 +000074 3040 (added signature annotations)
Guido van Rossum452bf512007-02-09 05:32:43 +000075 3050 (print becomes a function)
Guido van Rossum52cc1d82007-03-18 15:41:51 +000076 3060 (PEP 3115 metaclass syntax)
Guido van Rossum00bc0e02007-10-15 02:52:41 +000077 3070 (PEP 3109 raise changes)
78 3080 (PEP 3137 make __file__ and __name__ unicode)
Guido van Rossum98297ee2007-11-06 21:34:58 +000079 3090 (kill str8 interning)
Michael W. Hudsonaee2e282005-10-21 11:32:20 +000080.
Tim Peters36515e22001-11-18 04:06:29 +000081*/
Guido van Rossum98297ee2007-11-06 21:34:58 +000082#define MAGIC (3090 | ((long)'\r'<<16) | ((long)'\n'<<24))
Guido van Rossum3ddee711991-12-16 13:06:34 +000083
Guido van Rossum96774c12000-05-01 20:19:08 +000084/* Magic word as global; note that _PyImport_Init() can change the
Jeremy Hylton9262b8a2000-06-30 04:59:17 +000085 value of this global to accommodate for alterations of how the
Guido van Rossum96774c12000-05-01 20:19:08 +000086 compiler works which are enabled by command line switches. */
87static long pyc_magic = MAGIC;
88
Guido van Rossum25ce5661997-08-02 03:10:38 +000089/* See _PyImport_FixupExtension() below */
90static PyObject *extensions = NULL;
Guido van Rossum3f5da241990-12-20 15:06:42 +000091
Guido van Rossum771c6c81997-10-31 18:37:24 +000092/* This table is defined in config.c: */
93extern struct _inittab _PyImport_Inittab[];
94
Guido van Rossumce3a72a2007-10-19 23:16:50 +000095/* Method from Parser/tokenizer.c */
Guido van Rossum40d20bc2007-10-22 00:09:51 +000096extern char * PyTokenizer_FindEncoding(int);
Guido van Rossumce3a72a2007-10-19 23:16:50 +000097
Guido van Rossum771c6c81997-10-31 18:37:24 +000098struct _inittab *PyImport_Inittab = _PyImport_Inittab;
Guido van Rossum66f1fa81991-04-03 19:03:52 +000099
Guido van Rossumed1170e1999-12-20 21:23:41 +0000100/* these tables define the module suffixes that Python recognizes */
101struct filedescr * _PyImport_Filetab = NULL;
Guido van Rossum48a680c2001-03-02 06:34:14 +0000102
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};
111
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000112static PyTypeObject NullImporterType; /* Forward reference */
113
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 */
Guido van Rossum04110fb2007-08-24 16:32:05 +0000127#ifdef HAVE_DYNAMIC_LOADING
Guido van Rossumed1170e1999-12-20 21:23:41 +0000128 for (scan = _PyImport_DynLoadFiletab; scan->suffix != NULL; ++scan)
129 ++countD;
Guido van Rossum04110fb2007-08-24 16:32:05 +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);
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000134 if (filetab == NULL)
135 Py_FatalError("Can't initialize import file table.");
Guido van Rossum04110fb2007-08-24 16:32:05 +0000136#ifdef HAVE_DYNAMIC_LOADING
Guido van Rossumed1170e1999-12-20 21:23:41 +0000137 memcpy(filetab, _PyImport_DynLoadFiletab,
138 countD * sizeof(struct filedescr));
Guido van Rossum04110fb2007-08-24 16:32:05 +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++) {
149 if (strcmp(filetab->suffix, ".pyc") == 0)
150 filetab->suffix = ".pyo";
Guido van Rossum0824f631997-03-11 18:37:35 +0000151 }
152 }
Guido van Rossum96774c12000-05-01 20:19:08 +0000153
Guido van Rossum572dbf82007-04-27 23:53:51 +0000154 {
Guido van Rossum96774c12000-05-01 20:19:08 +0000155 /* Fix the pyc_magic so that byte compiled code created
156 using the all-Unicode method doesn't interfere with
157 code created in normal operation mode. */
158 pyc_magic = MAGIC + 1;
159 }
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000160}
161
Guido van Rossum25ce5661997-08-02 03:10:38 +0000162void
Just van Rossum52e14d62002-12-30 22:08:05 +0000163_PyImportHooks_Init(void)
164{
165 PyObject *v, *path_hooks = NULL, *zimpimport;
166 int err = 0;
167
168 /* adding sys.path_hooks and sys.path_importer_cache, setting up
169 zipimport */
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000170 if (PyType_Ready(&NullImporterType) < 0)
171 goto error;
Just van Rossum52e14d62002-12-30 22:08:05 +0000172
173 if (Py_VerboseFlag)
174 PySys_WriteStderr("# installing zipimport hook\n");
175
176 v = PyList_New(0);
177 if (v == NULL)
178 goto error;
179 err = PySys_SetObject("meta_path", v);
180 Py_DECREF(v);
181 if (err)
182 goto error;
183 v = PyDict_New();
184 if (v == NULL)
185 goto error;
186 err = PySys_SetObject("path_importer_cache", v);
187 Py_DECREF(v);
188 if (err)
189 goto error;
190 path_hooks = PyList_New(0);
191 if (path_hooks == NULL)
192 goto error;
193 err = PySys_SetObject("path_hooks", path_hooks);
194 if (err) {
195 error:
196 PyErr_Print();
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000197 Py_FatalError("initializing sys.meta_path, sys.path_hooks, "
198 "path_importer_cache, or NullImporter failed"
199 );
Just van Rossum52e14d62002-12-30 22:08:05 +0000200 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000201
Just van Rossum52e14d62002-12-30 22:08:05 +0000202 zimpimport = PyImport_ImportModule("zipimport");
203 if (zimpimport == NULL) {
204 PyErr_Clear(); /* No zip import module -- okay */
205 if (Py_VerboseFlag)
206 PySys_WriteStderr("# can't import zipimport\n");
207 }
208 else {
209 PyObject *zipimporter = PyObject_GetAttrString(zimpimport,
210 "zipimporter");
211 Py_DECREF(zimpimport);
212 if (zipimporter == NULL) {
213 PyErr_Clear(); /* No zipimporter object -- okay */
214 if (Py_VerboseFlag)
215 PySys_WriteStderr(
Fred Drake1e5fc552003-07-11 15:01:02 +0000216 "# can't import zipimport.zipimporter\n");
Just van Rossum52e14d62002-12-30 22:08:05 +0000217 }
218 else {
219 /* sys.path_hooks.append(zipimporter) */
220 err = PyList_Append(path_hooks, zipimporter);
221 Py_DECREF(zipimporter);
222 if (err)
223 goto error;
224 if (Py_VerboseFlag)
225 PySys_WriteStderr(
226 "# installed zipimport hook\n");
227 }
228 }
229 Py_DECREF(path_hooks);
230}
231
232void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000233_PyImport_Fini(void)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000234{
235 Py_XDECREF(extensions);
236 extensions = NULL;
Barry Warsaw84294482000-10-03 16:02:05 +0000237 PyMem_DEL(_PyImport_Filetab);
238 _PyImport_Filetab = NULL;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000239}
240
241
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000242/* Locking primitives to prevent parallel imports of the same module
243 in different threads to return with a partially loaded module.
244 These calls are serialized by the global interpreter lock. */
245
246#ifdef WITH_THREAD
247
Guido van Rossum49b56061998-10-01 20:42:43 +0000248#include "pythread.h"
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000249
Guido van Rossum65d5b571998-12-21 19:32:43 +0000250static PyThread_type_lock import_lock = 0;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000251static long import_lock_thread = -1;
252static int import_lock_level = 0;
253
254static void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000255lock_import(void)
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000256{
Guido van Rossum65d5b571998-12-21 19:32:43 +0000257 long me = PyThread_get_thread_ident();
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000258 if (me == -1)
259 return; /* Too bad */
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000260 if (import_lock == NULL) {
Guido van Rossum65d5b571998-12-21 19:32:43 +0000261 import_lock = PyThread_allocate_lock();
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000262 if (import_lock == NULL)
263 return; /* Nothing much we can do. */
264 }
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000265 if (import_lock_thread == me) {
266 import_lock_level++;
267 return;
268 }
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000269 if (import_lock_thread != -1 || !PyThread_acquire_lock(import_lock, 0))
270 {
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000271 PyThreadState *tstate = PyEval_SaveThread();
Guido van Rossum65d5b571998-12-21 19:32:43 +0000272 PyThread_acquire_lock(import_lock, 1);
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000273 PyEval_RestoreThread(tstate);
274 }
275 import_lock_thread = me;
276 import_lock_level = 1;
277}
278
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000279static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000280unlock_import(void)
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000281{
Guido van Rossum65d5b571998-12-21 19:32:43 +0000282 long me = PyThread_get_thread_ident();
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000283 if (me == -1 || import_lock == NULL)
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000284 return 0; /* Too bad */
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000285 if (import_lock_thread != me)
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000286 return -1;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000287 import_lock_level--;
288 if (import_lock_level == 0) {
289 import_lock_thread = -1;
Guido van Rossum65d5b571998-12-21 19:32:43 +0000290 PyThread_release_lock(import_lock);
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000291 }
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000292 return 1;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000293}
294
Guido van Rossum8ee3e5a2005-09-14 18:09:42 +0000295/* This function is called from PyOS_AfterFork to ensure that newly
296 created child processes do not share locks with the parent. */
297
298void
299_PyImport_ReInitLock(void)
300{
301#ifdef _AIX
302 if (import_lock != NULL)
303 import_lock = PyThread_allocate_lock();
304#endif
305}
306
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000307#else
308
309#define lock_import()
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000310#define unlock_import() 0
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000311
312#endif
313
Tim Peters69232342001-08-30 05:16:13 +0000314static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000315imp_lock_held(PyObject *self, PyObject *noargs)
Tim Peters69232342001-08-30 05:16:13 +0000316{
Tim Peters69232342001-08-30 05:16:13 +0000317#ifdef WITH_THREAD
Guido van Rossumb8bff3f2002-04-07 06:34:38 +0000318 return PyBool_FromLong(import_lock_thread != -1);
Tim Peters69232342001-08-30 05:16:13 +0000319#else
Guido van Rossumb8bff3f2002-04-07 06:34:38 +0000320 return PyBool_FromLong(0);
Tim Peters69232342001-08-30 05:16:13 +0000321#endif
322}
323
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000324static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000325imp_acquire_lock(PyObject *self, PyObject *noargs)
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000326{
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000327#ifdef WITH_THREAD
328 lock_import();
329#endif
Neal Norwitz2294c0d2003-02-12 23:02:21 +0000330 Py_INCREF(Py_None);
331 return Py_None;
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000332}
333
334static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000335imp_release_lock(PyObject *self, PyObject *noargs)
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000336{
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000337#ifdef WITH_THREAD
338 if (unlock_import() < 0) {
339 PyErr_SetString(PyExc_RuntimeError,
340 "not holding the import lock");
341 return NULL;
342 }
343#endif
Neal Norwitz2294c0d2003-02-12 23:02:21 +0000344 Py_INCREF(Py_None);
345 return Py_None;
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000346}
347
Guido van Rossumd8faa362007-04-27 19:54:29 +0000348static void
349imp_modules_reloading_clear(void)
350{
351 PyInterpreterState *interp = PyThreadState_Get()->interp;
352 if (interp->modules_reloading != NULL)
353 PyDict_Clear(interp->modules_reloading);
354}
355
Guido van Rossum25ce5661997-08-02 03:10:38 +0000356/* Helper for sys */
357
358PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000359PyImport_GetModuleDict(void)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000360{
Nicholas Bastine5662ae2004-03-24 22:22:12 +0000361 PyInterpreterState *interp = PyThreadState_GET()->interp;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000362 if (interp->modules == NULL)
363 Py_FatalError("PyImport_GetModuleDict: no module dictionary!");
364 return interp->modules;
365}
366
Guido van Rossum3f5da241990-12-20 15:06:42 +0000367
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000368/* List of names to clear in sys */
369static char* sys_deletes[] = {
Collin Winter670e6922007-03-21 02:57:17 +0000370 "path", "argv", "ps1", "ps2",
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000371 "last_type", "last_value", "last_traceback",
Just van Rossum52e14d62002-12-30 22:08:05 +0000372 "path_hooks", "path_importer_cache", "meta_path",
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000373 NULL
374};
375
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000376static char* sys_files[] = {
377 "stdin", "__stdin__",
378 "stdout", "__stdout__",
379 "stderr", "__stderr__",
380 NULL
381};
382
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000383
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000384/* Un-initialize things, as good as we can */
Guido van Rossum3f5da241990-12-20 15:06:42 +0000385
Guido van Rossum3f5da241990-12-20 15:06:42 +0000386void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000387PyImport_Cleanup(void)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000388{
Martin v. Löwis18e16552006-02-15 17:27:45 +0000389 Py_ssize_t pos, ndone;
Guido van Rossum758eec01998-01-19 21:58:26 +0000390 char *name;
391 PyObject *key, *value, *dict;
Nicholas Bastine5662ae2004-03-24 22:22:12 +0000392 PyInterpreterState *interp = PyThreadState_GET()->interp;
Guido van Rossum758eec01998-01-19 21:58:26 +0000393 PyObject *modules = interp->modules;
394
395 if (modules == NULL)
396 return; /* Already done */
397
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000398 /* Delete some special variables first. These are common
399 places where user values hide and people complain when their
400 destructors fail. Since the modules containing them are
401 deleted *last* of all, they would come too late in the normal
402 destruction order. Sigh. */
403
404 value = PyDict_GetItemString(modules, "__builtin__");
405 if (value != NULL && PyModule_Check(value)) {
406 dict = PyModule_GetDict(value);
407 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000408 PySys_WriteStderr("# clear __builtin__._\n");
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000409 PyDict_SetItemString(dict, "_", Py_None);
410 }
411 value = PyDict_GetItemString(modules, "sys");
412 if (value != NULL && PyModule_Check(value)) {
413 char **p;
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000414 PyObject *v;
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000415 dict = PyModule_GetDict(value);
416 for (p = sys_deletes; *p != NULL; p++) {
417 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000418 PySys_WriteStderr("# clear sys.%s\n", *p);
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000419 PyDict_SetItemString(dict, *p, Py_None);
420 }
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000421 for (p = sys_files; *p != NULL; p+=2) {
422 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000423 PySys_WriteStderr("# restore sys.%s\n", *p);
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000424 v = PyDict_GetItemString(dict, *(p+1));
425 if (v == NULL)
426 v = Py_None;
427 PyDict_SetItemString(dict, *p, v);
428 }
429 }
430
431 /* First, delete __main__ */
432 value = PyDict_GetItemString(modules, "__main__");
433 if (value != NULL && PyModule_Check(value)) {
434 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000435 PySys_WriteStderr("# cleanup __main__\n");
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000436 _PyModule_Clear(value);
437 PyDict_SetItemString(modules, "__main__", Py_None);
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000438 }
439
Guido van Rossum758eec01998-01-19 21:58:26 +0000440 /* The special treatment of __builtin__ here is because even
441 when it's not referenced as a module, its dictionary is
442 referenced by almost every module's __builtins__. Since
443 deleting a module clears its dictionary (even if there are
444 references left to it), we need to delete the __builtin__
445 module last. Likewise, we don't delete sys until the very
446 end because it is implicitly referenced (e.g. by print).
447
448 Also note that we 'delete' modules by replacing their entry
449 in the modules dict with None, rather than really deleting
450 them; this avoids a rehash of the modules dictionary and
451 also marks them as "non existent" so they won't be
452 re-imported. */
453
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000454 /* Next, repeatedly delete modules with a reference count of
Guido van Rossum758eec01998-01-19 21:58:26 +0000455 one (skipping __builtin__ and sys) and delete them */
456 do {
457 ndone = 0;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000458 pos = 0;
Guido van Rossum758eec01998-01-19 21:58:26 +0000459 while (PyDict_Next(modules, &pos, &key, &value)) {
460 if (value->ob_refcnt != 1)
461 continue;
Neal Norwitz80e7f272007-08-26 06:45:23 +0000462 if (PyUnicode_Check(key) && PyModule_Check(value)) {
463 name = PyUnicode_AsString(key);
Guido van Rossum758eec01998-01-19 21:58:26 +0000464 if (strcmp(name, "__builtin__") == 0)
465 continue;
466 if (strcmp(name, "sys") == 0)
467 continue;
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000468 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000469 PySys_WriteStderr(
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000470 "# cleanup[1] %s\n", name);
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000471 _PyModule_Clear(value);
Guido van Rossum758eec01998-01-19 21:58:26 +0000472 PyDict_SetItem(modules, key, Py_None);
473 ndone++;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000474 }
475 }
Guido van Rossum758eec01998-01-19 21:58:26 +0000476 } while (ndone > 0);
477
Guido van Rossum758eec01998-01-19 21:58:26 +0000478 /* Next, delete all modules (still skipping __builtin__ and sys) */
479 pos = 0;
480 while (PyDict_Next(modules, &pos, &key, &value)) {
Neal Norwitz80e7f272007-08-26 06:45:23 +0000481 if (PyUnicode_Check(key) && PyModule_Check(value)) {
482 name = PyUnicode_AsString(key);
Guido van Rossum758eec01998-01-19 21:58:26 +0000483 if (strcmp(name, "__builtin__") == 0)
484 continue;
485 if (strcmp(name, "sys") == 0)
486 continue;
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000487 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000488 PySys_WriteStderr("# cleanup[2] %s\n", name);
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000489 _PyModule_Clear(value);
Guido van Rossum758eec01998-01-19 21:58:26 +0000490 PyDict_SetItem(modules, key, Py_None);
491 }
492 }
493
494 /* Next, delete sys and __builtin__ (in that order) */
495 value = PyDict_GetItemString(modules, "sys");
496 if (value != NULL && PyModule_Check(value)) {
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000497 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000498 PySys_WriteStderr("# cleanup sys\n");
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000499 _PyModule_Clear(value);
Guido van Rossum758eec01998-01-19 21:58:26 +0000500 PyDict_SetItemString(modules, "sys", Py_None);
501 }
502 value = PyDict_GetItemString(modules, "__builtin__");
503 if (value != NULL && PyModule_Check(value)) {
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000504 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000505 PySys_WriteStderr("# cleanup __builtin__\n");
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000506 _PyModule_Clear(value);
Guido van Rossum758eec01998-01-19 21:58:26 +0000507 PyDict_SetItemString(modules, "__builtin__", Py_None);
508 }
509
510 /* Finally, clear and delete the modules directory */
511 PyDict_Clear(modules);
512 interp->modules = NULL;
513 Py_DECREF(modules);
Guido van Rossumd8faa362007-04-27 19:54:29 +0000514 Py_CLEAR(interp->modules_reloading);
Guido van Rossum8d15b5d1990-10-26 14:58:58 +0000515}
Guido van Rossum7f133ed1991-02-19 12:23:57 +0000516
517
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000518/* Helper for pythonrun.c -- return magic number */
519
520long
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000521PyImport_GetMagicNumber(void)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000522{
Guido van Rossum96774c12000-05-01 20:19:08 +0000523 return pyc_magic;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000524}
525
526
Guido van Rossum25ce5661997-08-02 03:10:38 +0000527/* Magic for extension modules (built-in as well as dynamically
528 loaded). To prevent initializing an extension module more than
529 once, we keep a static dictionary 'extensions' keyed by module name
530 (for built-in modules) or by filename (for dynamically loaded
Barry Warsaw92883382001-08-13 23:05:44 +0000531 modules), containing these modules. A copy of the module's
Guido van Rossum25ce5661997-08-02 03:10:38 +0000532 dictionary is stored by calling _PyImport_FixupExtension()
533 immediately after the module initialization function succeeds. A
534 copy can be retrieved from there by calling
535 _PyImport_FindExtension(). */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000536
Guido van Rossum79f25d91997-04-29 20:08:16 +0000537PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000538_PyImport_FixupExtension(char *name, char *filename)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000539{
Guido van Rossum25ce5661997-08-02 03:10:38 +0000540 PyObject *modules, *mod, *dict, *copy;
541 if (extensions == NULL) {
542 extensions = PyDict_New();
543 if (extensions == NULL)
544 return NULL;
545 }
546 modules = PyImport_GetModuleDict();
547 mod = PyDict_GetItemString(modules, name);
548 if (mod == NULL || !PyModule_Check(mod)) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000549 PyErr_Format(PyExc_SystemError,
550 "_PyImport_FixupExtension: module %.200s not loaded", name);
Guido van Rossum25ce5661997-08-02 03:10:38 +0000551 return NULL;
552 }
553 dict = PyModule_GetDict(mod);
554 if (dict == NULL)
555 return NULL;
Fred Drake9cd0efc2001-10-25 21:38:59 +0000556 copy = PyDict_Copy(dict);
Guido van Rossum25ce5661997-08-02 03:10:38 +0000557 if (copy == NULL)
558 return NULL;
559 PyDict_SetItemString(extensions, filename, copy);
560 Py_DECREF(copy);
561 return copy;
562}
563
564PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000565_PyImport_FindExtension(char *name, char *filename)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000566{
Fred Drake9cd0efc2001-10-25 21:38:59 +0000567 PyObject *dict, *mod, *mdict;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000568 if (extensions == NULL)
569 return NULL;
570 dict = PyDict_GetItemString(extensions, filename);
571 if (dict == NULL)
572 return NULL;
573 mod = PyImport_AddModule(name);
574 if (mod == NULL)
575 return NULL;
576 mdict = PyModule_GetDict(mod);
577 if (mdict == NULL)
578 return NULL;
Fred Drake9cd0efc2001-10-25 21:38:59 +0000579 if (PyDict_Update(mdict, dict))
Guido van Rossum25ce5661997-08-02 03:10:38 +0000580 return NULL;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000581 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000582 PySys_WriteStderr("import %s # previously loaded (%s)\n",
Guido van Rossum25ce5661997-08-02 03:10:38 +0000583 name, filename);
584 return mod;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000585}
586
587
588/* Get the module object corresponding to a module name.
589 First check the modules dictionary if there's one there,
Walter Dörwaldf0dfc7a2003-10-20 14:01:56 +0000590 if not, create a new one and insert it in the modules dictionary.
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000591 Because the former action is most common, THIS DOES NOT RETURN A
592 'NEW' REFERENCE! */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000593
Guido van Rossum79f25d91997-04-29 20:08:16 +0000594PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000595PyImport_AddModule(const char *name)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000596{
Guido van Rossum25ce5661997-08-02 03:10:38 +0000597 PyObject *modules = PyImport_GetModuleDict();
Guido van Rossum79f25d91997-04-29 20:08:16 +0000598 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000599
Guido van Rossum25ce5661997-08-02 03:10:38 +0000600 if ((m = PyDict_GetItemString(modules, name)) != NULL &&
Guido van Rossum79f25d91997-04-29 20:08:16 +0000601 PyModule_Check(m))
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000602 return m;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000603 m = PyModule_New(name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000604 if (m == NULL)
605 return NULL;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000606 if (PyDict_SetItemString(modules, name, m) != 0) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000607 Py_DECREF(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000608 return NULL;
609 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000610 Py_DECREF(m); /* Yes, it still exists, in modules! */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000611
612 return m;
613}
614
Tim Peters1cd70172004-08-02 03:52:12 +0000615/* Remove name from sys.modules, if it's there. */
616static void
617_RemoveModule(const char *name)
618{
619 PyObject *modules = PyImport_GetModuleDict();
620 if (PyDict_GetItemString(modules, name) == NULL)
621 return;
622 if (PyDict_DelItemString(modules, name) < 0)
623 Py_FatalError("import: deleting existing key in"
624 "sys.modules failed");
625}
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000626
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000627/* Execute a code object in a module and return the module object
Tim Peters1cd70172004-08-02 03:52:12 +0000628 * WITH INCREMENTED REFERENCE COUNT. If an error occurs, name is
629 * removed from sys.modules, to avoid leaving damaged module objects
630 * in sys.modules. The caller may wish to restore the original
631 * module object (if any) in this case; PyImport_ReloadModule is an
632 * example.
633 */
Guido van Rossum79f25d91997-04-29 20:08:16 +0000634PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000635PyImport_ExecCodeModule(char *name, PyObject *co)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000636{
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000637 return PyImport_ExecCodeModuleEx(name, co, (char *)NULL);
638}
639
640PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000641PyImport_ExecCodeModuleEx(char *name, PyObject *co, char *pathname)
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000642{
Guido van Rossum25ce5661997-08-02 03:10:38 +0000643 PyObject *modules = PyImport_GetModuleDict();
Guido van Rossum79f25d91997-04-29 20:08:16 +0000644 PyObject *m, *d, *v;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000645
Guido van Rossum79f25d91997-04-29 20:08:16 +0000646 m = PyImport_AddModule(name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000647 if (m == NULL)
648 return NULL;
Jeremy Hyltonecd91292004-01-02 23:25:32 +0000649 /* If the module is being reloaded, we get the old module back
650 and re-use its dict to exec the new code. */
Guido van Rossum79f25d91997-04-29 20:08:16 +0000651 d = PyModule_GetDict(m);
652 if (PyDict_GetItemString(d, "__builtins__") == NULL) {
653 if (PyDict_SetItemString(d, "__builtins__",
654 PyEval_GetBuiltins()) != 0)
Tim Peters1cd70172004-08-02 03:52:12 +0000655 goto error;
Guido van Rossum6135a871995-01-09 17:53:26 +0000656 }
Guido van Rossum9c9a07c1996-05-16 20:43:40 +0000657 /* Remember the filename as the __file__ attribute */
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000658 v = NULL;
659 if (pathname != NULL) {
Guido van Rossum00bc0e02007-10-15 02:52:41 +0000660 v = PyUnicode_DecodeFSDefault(pathname);
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000661 if (v == NULL)
662 PyErr_Clear();
663 }
664 if (v == NULL) {
665 v = ((PyCodeObject *)co)->co_filename;
666 Py_INCREF(v);
667 }
668 if (PyDict_SetItemString(d, "__file__", v) != 0)
Guido van Rossum79f25d91997-04-29 20:08:16 +0000669 PyErr_Clear(); /* Not important enough to report */
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000670 Py_DECREF(v);
671
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000672 v = PyEval_EvalCode((PyCodeObject *)co, d, d);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000673 if (v == NULL)
Tim Peters1cd70172004-08-02 03:52:12 +0000674 goto error;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000675 Py_DECREF(v);
Guido van Rossumb65e85c1997-07-10 18:00:45 +0000676
Guido van Rossum25ce5661997-08-02 03:10:38 +0000677 if ((m = PyDict_GetItemString(modules, name)) == NULL) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000678 PyErr_Format(PyExc_ImportError,
679 "Loaded module %.200s not found in sys.modules",
680 name);
Guido van Rossumb65e85c1997-07-10 18:00:45 +0000681 return NULL;
682 }
683
Guido van Rossum79f25d91997-04-29 20:08:16 +0000684 Py_INCREF(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000685
686 return m;
Tim Peters1cd70172004-08-02 03:52:12 +0000687
688 error:
689 _RemoveModule(name);
690 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000691}
692
693
694/* Given a pathname for a Python source file, fill a buffer with the
695 pathname for the corresponding compiled file. Return the pathname
696 for the compiled file, or NULL if there's no space in the buffer.
697 Doesn't set an exception. */
698
699static char *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000700make_compiled_pathname(char *pathname, char *buf, size_t buflen)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000701{
Tim Petersc1731372001-08-04 08:12:36 +0000702 size_t len = strlen(pathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000703 if (len+2 > buflen)
704 return NULL;
Tim Petersc1731372001-08-04 08:12:36 +0000705
Martin v. Löwis6238d2b2002-06-30 15:26:10 +0000706#ifdef MS_WINDOWS
Tim Petersc1731372001-08-04 08:12:36 +0000707 /* Treat .pyw as if it were .py. The case of ".pyw" must match
708 that used in _PyImport_StandardFiletab. */
709 if (len >= 4 && strcmp(&pathname[len-4], ".pyw") == 0)
710 --len; /* pretend 'w' isn't there */
711#endif
712 memcpy(buf, pathname, len);
713 buf[len] = Py_OptimizeFlag ? 'o' : 'c';
714 buf[len+1] = '\0';
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000715
716 return buf;
717}
718
719
720/* Given a pathname for a Python source file, its time of last
721 modification, and a pathname for a compiled file, check whether the
722 compiled file represents the same version of the source. If so,
723 return a FILE pointer for the compiled file, positioned just after
724 the header; if not, return NULL.
725 Doesn't set an exception. */
726
727static FILE *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000728check_compiled_module(char *pathname, time_t mtime, char *cpathname)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000729{
730 FILE *fp;
731 long magic;
732 long pyc_mtime;
733
734 fp = fopen(cpathname, "rb");
735 if (fp == NULL)
736 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000737 magic = PyMarshal_ReadLongFromFile(fp);
Guido van Rossum96774c12000-05-01 20:19:08 +0000738 if (magic != pyc_magic) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000739 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000740 PySys_WriteStderr("# %s has bad magic\n", cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000741 fclose(fp);
742 return NULL;
743 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000744 pyc_mtime = PyMarshal_ReadLongFromFile(fp);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000745 if (pyc_mtime != mtime) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000746 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000747 PySys_WriteStderr("# %s has bad mtime\n", cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000748 fclose(fp);
749 return NULL;
750 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000751 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000752 PySys_WriteStderr("# %s matches %s\n", cpathname, pathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000753 return fp;
754}
755
756
757/* Read a code object from a file and check it for validity */
758
Guido van Rossum79f25d91997-04-29 20:08:16 +0000759static PyCodeObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000760read_compiled_module(char *cpathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000761{
Guido van Rossum79f25d91997-04-29 20:08:16 +0000762 PyObject *co;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000763
Tim Petersd9b9ac82001-01-28 00:27:39 +0000764 co = PyMarshal_ReadLastObjectFromFile(fp);
Armin Rigo01ab2792004-03-26 15:09:27 +0000765 if (co == NULL)
766 return NULL;
767 if (!PyCode_Check(co)) {
768 PyErr_Format(PyExc_ImportError,
769 "Non-code object in %.200s", cpathname);
770 Py_DECREF(co);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000771 return NULL;
772 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000773 return (PyCodeObject *)co;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000774}
775
776
777/* Load a module from a compiled file, execute it, and return its
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000778 module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000779
Guido van Rossum79f25d91997-04-29 20:08:16 +0000780static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000781load_compiled_module(char *name, char *cpathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000782{
783 long magic;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000784 PyCodeObject *co;
785 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000786
Guido van Rossum79f25d91997-04-29 20:08:16 +0000787 magic = PyMarshal_ReadLongFromFile(fp);
Guido van Rossum96774c12000-05-01 20:19:08 +0000788 if (magic != pyc_magic) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000789 PyErr_Format(PyExc_ImportError,
790 "Bad magic number in %.200s", cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000791 return NULL;
792 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000793 (void) PyMarshal_ReadLongFromFile(fp);
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000794 co = read_compiled_module(cpathname, fp);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000795 if (co == NULL)
796 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000797 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000798 PySys_WriteStderr("import %s # precompiled from %s\n",
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000799 name, cpathname);
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000800 m = PyImport_ExecCodeModuleEx(name, (PyObject *)co, cpathname);
Guido van Rossum79f25d91997-04-29 20:08:16 +0000801 Py_DECREF(co);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000802
803 return m;
804}
805
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000806/* Parse a source file and return the corresponding code object */
807
Guido van Rossum79f25d91997-04-29 20:08:16 +0000808static PyCodeObject *
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000809parse_source_module(const char *pathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000810{
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000811 PyCodeObject *co = NULL;
812 mod_ty mod;
Thomas Wouters89f507f2006-12-13 04:49:30 +0000813 PyArena *arena = PyArena_New();
814 if (arena == NULL)
815 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000816
Martin v. Löwis85bcc662007-09-04 09:18:06 +0000817 mod = PyParser_ASTFromFile(fp, pathname, NULL,
818 Py_file_input, 0, 0, 0,
Neal Norwitzadb69fc2005-12-17 20:54:49 +0000819 NULL, arena);
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000820 if (mod) {
Neal Norwitzadb69fc2005-12-17 20:54:49 +0000821 co = PyAST_Compile(mod, pathname, NULL, arena);
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000822 }
Thomas Wouters89f507f2006-12-13 04:49:30 +0000823 PyArena_Free(arena);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000824 return co;
825}
826
827
Guido van Rossum55a83382000-09-20 20:31:38 +0000828/* Helper to open a bytecode file for writing in exclusive mode */
829
830static FILE *
831open_exclusive(char *filename)
832{
833#if defined(O_EXCL)&&defined(O_CREAT)&&defined(O_WRONLY)&&defined(O_TRUNC)
834 /* Use O_EXCL to avoid a race condition when another process tries to
835 write the same file. When that happens, our open() call fails,
836 which is just fine (since it's only a cache).
837 XXX If the file exists and is writable but the directory is not
838 writable, the file will never be written. Oh well.
839 */
840 int fd;
841 (void) unlink(filename);
Tim Peters42c83af2000-09-29 04:03:10 +0000842 fd = open(filename, O_EXCL|O_CREAT|O_WRONLY|O_TRUNC
843#ifdef O_BINARY
844 |O_BINARY /* necessary for Windows */
845#endif
Martin v. Löwis79acb9e2002-12-06 12:48:53 +0000846#ifdef __VMS
Martin v. Löwis18e16552006-02-15 17:27:45 +0000847 , 0666, "ctxt=bin", "shr=nil"
Martin v. Löwis79acb9e2002-12-06 12:48:53 +0000848#else
Martin v. Löwis18e16552006-02-15 17:27:45 +0000849 , 0666
Martin v. Löwis79acb9e2002-12-06 12:48:53 +0000850#endif
Martin v. Löwis18e16552006-02-15 17:27:45 +0000851 );
Guido van Rossum55a83382000-09-20 20:31:38 +0000852 if (fd < 0)
853 return NULL;
854 return fdopen(fd, "wb");
855#else
856 /* Best we can do -- on Windows this can't happen anyway */
857 return fopen(filename, "wb");
858#endif
859}
860
861
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000862/* Write a compiled module to a file, placing the time of last
863 modification of its source into the header.
864 Errors are ignored, if a write error occurs an attempt is made to
865 remove the file. */
866
867static void
Martin v. Löwis18e16552006-02-15 17:27:45 +0000868write_compiled_module(PyCodeObject *co, char *cpathname, time_t mtime)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000869{
870 FILE *fp;
871
Guido van Rossum55a83382000-09-20 20:31:38 +0000872 fp = open_exclusive(cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000873 if (fp == NULL) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000874 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000875 PySys_WriteStderr(
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000876 "# can't create %s\n", cpathname);
877 return;
878 }
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000879 PyMarshal_WriteLongToFile(pyc_magic, fp, Py_MARSHAL_VERSION);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000880 /* First write a 0 for mtime */
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000881 PyMarshal_WriteLongToFile(0L, fp, Py_MARSHAL_VERSION);
882 PyMarshal_WriteObjectToFile((PyObject *)co, fp, Py_MARSHAL_VERSION);
Armin Rigo01ab2792004-03-26 15:09:27 +0000883 if (fflush(fp) != 0 || ferror(fp)) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000884 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000885 PySys_WriteStderr("# can't write %s\n", cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000886 /* Don't keep partial file */
887 fclose(fp);
888 (void) unlink(cpathname);
889 return;
890 }
891 /* Now write the true mtime */
892 fseek(fp, 4L, 0);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000893 assert(mtime < LONG_MAX);
Martin v. Löwis725507b2006-03-07 12:08:51 +0000894 PyMarshal_WriteLongToFile((long)mtime, fp, Py_MARSHAL_VERSION);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000895 fflush(fp);
896 fclose(fp);
Guido van Rossum79f25d91997-04-29 20:08:16 +0000897 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000898 PySys_WriteStderr("# wrote %s\n", cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000899}
900
901
902/* Load a source module from a given file and return its module
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000903 object WITH INCREMENTED REFERENCE COUNT. If there's a matching
904 byte-compiled file, use that instead. */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000905
Guido van Rossum79f25d91997-04-29 20:08:16 +0000906static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000907load_source_module(char *name, char *pathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000908{
Fred Drake4c82b232000-06-30 16:18:57 +0000909 time_t mtime;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000910 FILE *fpc;
911 char buf[MAXPATHLEN+1];
912 char *cpathname;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000913 PyCodeObject *co;
914 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000915
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000916 mtime = PyOS_GetLastModificationTime(pathname, fp);
Neal Norwitz708e51a2005-10-03 04:48:15 +0000917 if (mtime == (time_t)(-1)) {
918 PyErr_Format(PyExc_RuntimeError,
919 "unable to get modification time from '%s'",
920 pathname);
Fred Drake4c82b232000-06-30 16:18:57 +0000921 return NULL;
Neal Norwitz708e51a2005-10-03 04:48:15 +0000922 }
Fred Drake4c82b232000-06-30 16:18:57 +0000923#if SIZEOF_TIME_T > 4
924 /* Python's .pyc timestamp handling presumes that the timestamp fits
925 in 4 bytes. This will be fine until sometime in the year 2038,
926 when a 4-byte signed time_t will overflow.
927 */
928 if (mtime >> 32) {
929 PyErr_SetString(PyExc_OverflowError,
Fred Drakec63d3e92001-03-01 06:33:32 +0000930 "modification time overflows a 4 byte field");
Fred Drake4c82b232000-06-30 16:18:57 +0000931 return NULL;
932 }
933#endif
Tim Peters36515e22001-11-18 04:06:29 +0000934 cpathname = make_compiled_pathname(pathname, buf,
Jeremy Hylton37832f02001-04-13 17:50:20 +0000935 (size_t)MAXPATHLEN + 1);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000936 if (cpathname != NULL &&
937 (fpc = check_compiled_module(pathname, mtime, cpathname))) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000938 co = read_compiled_module(cpathname, fpc);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000939 fclose(fpc);
940 if (co == NULL)
941 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000942 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000943 PySys_WriteStderr("import %s # precompiled from %s\n",
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000944 name, cpathname);
Guido van Rossumafd3dae1998-08-25 18:44:34 +0000945 pathname = cpathname;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000946 }
947 else {
948 co = parse_source_module(pathname, fp);
949 if (co == NULL)
950 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000951 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000952 PySys_WriteStderr("import %s # from %s\n",
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000953 name, pathname);
Thomas Wouters00ee7ba2006-08-21 19:07:27 +0000954 if (cpathname)
955 write_compiled_module(co, cpathname, mtime);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000956 }
Guido van Rossumafd3dae1998-08-25 18:44:34 +0000957 m = PyImport_ExecCodeModuleEx(name, (PyObject *)co, pathname);
Guido van Rossum79f25d91997-04-29 20:08:16 +0000958 Py_DECREF(co);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000959
960 return m;
961}
962
963
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000964/* Forward */
Just van Rossum52e14d62002-12-30 22:08:05 +0000965static PyObject *load_module(char *, FILE *, char *, int, PyObject *);
966static struct filedescr *find_module(char *, char *, PyObject *,
967 char *, size_t, FILE **, PyObject **);
Tim Petersdbd9ba62000-07-09 03:09:57 +0000968static struct _frozen *find_frozen(char *name);
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000969
970/* Load a package and return its module object WITH INCREMENTED
971 REFERENCE COUNT */
972
973static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000974load_package(char *name, char *pathname)
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000975{
Tim Peters1cd70172004-08-02 03:52:12 +0000976 PyObject *m, *d;
977 PyObject *file = NULL;
978 PyObject *path = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000979 int err;
980 char buf[MAXPATHLEN+1];
981 FILE *fp = NULL;
982 struct filedescr *fdp;
983
984 m = PyImport_AddModule(name);
985 if (m == NULL)
986 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +0000987 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000988 PySys_WriteStderr("import %s # directory %s\n",
Guido van Rossum17fc85f1997-09-06 18:52:03 +0000989 name, pathname);
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000990 d = PyModule_GetDict(m);
Guido van Rossum00bc0e02007-10-15 02:52:41 +0000991 file = PyUnicode_DecodeFSDefault(pathname);
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000992 if (file == NULL)
Tim Peters1cd70172004-08-02 03:52:12 +0000993 goto error;
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000994 path = Py_BuildValue("[O]", file);
Tim Peters1cd70172004-08-02 03:52:12 +0000995 if (path == NULL)
996 goto error;
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000997 err = PyDict_SetItemString(d, "__file__", file);
998 if (err == 0)
999 err = PyDict_SetItemString(d, "__path__", path);
Tim Peters1cd70172004-08-02 03:52:12 +00001000 if (err != 0)
1001 goto error;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001002 buf[0] = '\0';
Just van Rossum52e14d62002-12-30 22:08:05 +00001003 fdp = find_module(name, "__init__", path, buf, sizeof(buf), &fp, NULL);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001004 if (fdp == NULL) {
1005 if (PyErr_ExceptionMatches(PyExc_ImportError)) {
1006 PyErr_Clear();
Thomas Heller25653242004-06-07 15:04:10 +00001007 Py_INCREF(m);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001008 }
1009 else
1010 m = NULL;
1011 goto cleanup;
1012 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001013 m = load_module(name, fp, buf, fdp->type, NULL);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001014 if (fp != NULL)
1015 fclose(fp);
Tim Peters1cd70172004-08-02 03:52:12 +00001016 goto cleanup;
1017
1018 error:
1019 m = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001020 cleanup:
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001021 Py_XDECREF(path);
1022 Py_XDECREF(file);
1023 return m;
1024}
1025
1026
1027/* Helper to test for built-in module */
1028
1029static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001030is_builtin(char *name)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001031{
1032 int i;
Guido van Rossum771c6c81997-10-31 18:37:24 +00001033 for (i = 0; PyImport_Inittab[i].name != NULL; i++) {
1034 if (strcmp(name, PyImport_Inittab[i].name) == 0) {
1035 if (PyImport_Inittab[i].initfunc == NULL)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001036 return -1;
1037 else
1038 return 1;
1039 }
1040 }
1041 return 0;
1042}
1043
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001044
Just van Rossum52e14d62002-12-30 22:08:05 +00001045/* Return an importer object for a sys.path/pkg.__path__ item 'p',
1046 possibly by fetching it from the path_importer_cache dict. If it
Thomas Wouters89f507f2006-12-13 04:49:30 +00001047 wasn't yet cached, traverse path_hooks until a hook is found
Just van Rossum52e14d62002-12-30 22:08:05 +00001048 that can handle the path item. Return None if no hook could;
1049 this tells our caller it should fall back to the builtin
1050 import mechanism. Cache the result in path_importer_cache.
1051 Returns a borrowed reference. */
1052
1053static PyObject *
1054get_path_importer(PyObject *path_importer_cache, PyObject *path_hooks,
1055 PyObject *p)
1056{
1057 PyObject *importer;
Martin v. Löwis725507b2006-03-07 12:08:51 +00001058 Py_ssize_t j, nhooks;
Just van Rossum52e14d62002-12-30 22:08:05 +00001059
1060 /* These conditions are the caller's responsibility: */
1061 assert(PyList_Check(path_hooks));
1062 assert(PyDict_Check(path_importer_cache));
1063
1064 nhooks = PyList_Size(path_hooks);
1065 if (nhooks < 0)
1066 return NULL; /* Shouldn't happen */
1067
1068 importer = PyDict_GetItem(path_importer_cache, p);
1069 if (importer != NULL)
1070 return importer;
1071
1072 /* set path_importer_cache[p] to None to avoid recursion */
1073 if (PyDict_SetItem(path_importer_cache, p, Py_None) != 0)
1074 return NULL;
1075
1076 for (j = 0; j < nhooks; j++) {
1077 PyObject *hook = PyList_GetItem(path_hooks, j);
1078 if (hook == NULL)
1079 return NULL;
Thomas Wouters477c8d52006-05-27 19:21:47 +00001080 importer = PyObject_CallFunctionObjArgs(hook, p, NULL);
Just van Rossum52e14d62002-12-30 22:08:05 +00001081 if (importer != NULL)
1082 break;
1083
1084 if (!PyErr_ExceptionMatches(PyExc_ImportError)) {
1085 return NULL;
1086 }
1087 PyErr_Clear();
1088 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001089 if (importer == NULL) {
1090 importer = PyObject_CallFunctionObjArgs(
1091 (PyObject *)&NullImporterType, p, NULL
1092 );
1093 if (importer == NULL) {
1094 if (PyErr_ExceptionMatches(PyExc_ImportError)) {
1095 PyErr_Clear();
1096 return Py_None;
1097 }
1098 }
1099 }
1100 if (importer != NULL) {
Just van Rossum52e14d62002-12-30 22:08:05 +00001101 int err = PyDict_SetItem(path_importer_cache, p, importer);
1102 Py_DECREF(importer);
1103 if (err != 0)
1104 return NULL;
1105 }
1106 return importer;
1107}
1108
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001109/* Search the path (default sys.path) for a module. Return the
1110 corresponding filedescr struct, and (via return arguments) the
1111 pathname and an open file. Return NULL if the module is not found. */
1112
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001113#ifdef MS_COREDLL
Thomas Woutersb4bd21c2000-07-22 23:38:01 +00001114extern FILE *PyWin_FindRegisteredModule(const char *, struct filedescr **,
Martin v. Löwis18e16552006-02-15 17:27:45 +00001115 char *, Py_ssize_t);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001116#endif
1117
Martin v. Löwis18e16552006-02-15 17:27:45 +00001118static int case_ok(char *, Py_ssize_t, Py_ssize_t, char *);
Tim Petersdbd9ba62000-07-09 03:09:57 +00001119static int find_init_module(char *); /* Forward */
Just van Rossum52e14d62002-12-30 22:08:05 +00001120static struct filedescr importhookdescr = {"", "", IMP_HOOK};
Guido van Rossum197346f1997-10-31 18:38:52 +00001121
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001122static struct filedescr *
Just van Rossum52e14d62002-12-30 22:08:05 +00001123find_module(char *fullname, char *subname, PyObject *path, char *buf,
1124 size_t buflen, FILE **p_fp, PyObject **p_loader)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001125{
Martin v. Löwis725507b2006-03-07 12:08:51 +00001126 Py_ssize_t i, npath;
Fred Drake4c82b232000-06-30 16:18:57 +00001127 size_t len, namelen;
Guido van Rossum80bb9651996-12-05 23:27:02 +00001128 struct filedescr *fdp = NULL;
Jack Jansenc88da1f2002-05-28 10:58:19 +00001129 char *filemode;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001130 FILE *fp = NULL;
Just van Rossum52e14d62002-12-30 22:08:05 +00001131 PyObject *path_hooks, *path_importer_cache;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001132 struct stat statbuf;
Guido van Rossuma5568d31998-03-05 03:45:08 +00001133 static struct filedescr fd_frozen = {"", "", PY_FROZEN};
1134 static struct filedescr fd_builtin = {"", "", C_BUILTIN};
1135 static struct filedescr fd_package = {"", "", PKG_DIRECTORY};
Guido van Rossum0506a431998-08-11 15:07:39 +00001136 char name[MAXPATHLEN+1];
Andrew MacIntyred9400542002-02-26 11:41:34 +00001137#if defined(PYOS_OS2)
1138 size_t saved_len;
1139 size_t saved_namelen;
1140 char *saved_buf = NULL;
1141#endif
Just van Rossum52e14d62002-12-30 22:08:05 +00001142 if (p_loader != NULL)
1143 *p_loader = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001144
Just van Rossum52e14d62002-12-30 22:08:05 +00001145 if (strlen(subname) > MAXPATHLEN) {
Guido van Rossum8f4d3312001-10-18 18:54:11 +00001146 PyErr_SetString(PyExc_OverflowError,
1147 "module name is too long");
Fred Drake4c82b232000-06-30 16:18:57 +00001148 return NULL;
1149 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001150 strcpy(name, subname);
1151
1152 /* sys.meta_path import hook */
1153 if (p_loader != NULL) {
1154 PyObject *meta_path;
1155
1156 meta_path = PySys_GetObject("meta_path");
1157 if (meta_path == NULL || !PyList_Check(meta_path)) {
1158 PyErr_SetString(PyExc_ImportError,
1159 "sys.meta_path must be a list of "
1160 "import hooks");
1161 return NULL;
1162 }
1163 Py_INCREF(meta_path); /* zap guard */
1164 npath = PyList_Size(meta_path);
1165 for (i = 0; i < npath; i++) {
1166 PyObject *loader;
1167 PyObject *hook = PyList_GetItem(meta_path, i);
1168 loader = PyObject_CallMethod(hook, "find_module",
1169 "sO", fullname,
1170 path != NULL ?
1171 path : Py_None);
1172 if (loader == NULL) {
1173 Py_DECREF(meta_path);
1174 return NULL; /* true error */
1175 }
1176 if (loader != Py_None) {
1177 /* a loader was found */
1178 *p_loader = loader;
1179 Py_DECREF(meta_path);
1180 return &importhookdescr;
1181 }
1182 Py_DECREF(loader);
1183 }
1184 Py_DECREF(meta_path);
1185 }
Guido van Rossum0506a431998-08-11 15:07:39 +00001186
Guido van Rossum13d77992007-07-23 03:16:50 +00001187 if (path != NULL && PyUnicode_Check(path)) {
Guido van Rossum8f4d3312001-10-18 18:54:11 +00001188 /* The only type of submodule allowed inside a "frozen"
1189 package are other frozen modules or packages. */
Guido van Rossum13d77992007-07-23 03:16:50 +00001190 char *p = PyUnicode_AsString(path);
1191 if (strlen(p) + 1 + strlen(name) >= (size_t)buflen) {
Guido van Rossum0506a431998-08-11 15:07:39 +00001192 PyErr_SetString(PyExc_ImportError,
1193 "full frozen module name too long");
1194 return NULL;
1195 }
Guido van Rossum13d77992007-07-23 03:16:50 +00001196 strcpy(buf, p);
Guido van Rossum0506a431998-08-11 15:07:39 +00001197 strcat(buf, ".");
1198 strcat(buf, name);
1199 strcpy(name, buf);
Guido van Rossum8f4d3312001-10-18 18:54:11 +00001200 if (find_frozen(name) != NULL) {
1201 strcpy(buf, name);
1202 return &fd_frozen;
1203 }
1204 PyErr_Format(PyExc_ImportError,
1205 "No frozen submodule named %.200s", name);
1206 return NULL;
Guido van Rossum0506a431998-08-11 15:07:39 +00001207 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001208 if (path == NULL) {
1209 if (is_builtin(name)) {
Guido van Rossuma5568d31998-03-05 03:45:08 +00001210 strcpy(buf, name);
1211 return &fd_builtin;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001212 }
Greg Ward201baee2001-10-04 14:52:06 +00001213 if ((find_frozen(name)) != NULL) {
Guido van Rossuma5568d31998-03-05 03:45:08 +00001214 strcpy(buf, name);
1215 return &fd_frozen;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001216 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001217
Guido van Rossumac279101996-08-22 23:10:58 +00001218#ifdef MS_COREDLL
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001219 fp = PyWin_FindRegisteredModule(name, &fdp, buf, buflen);
1220 if (fp != NULL) {
1221 *p_fp = fp;
1222 return fdp;
1223 }
Guido van Rossuma5a3db71996-04-09 02:39:59 +00001224#endif
Guido van Rossuma5568d31998-03-05 03:45:08 +00001225 path = PySys_GetObject("path");
1226 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00001227 if (path == NULL || !PyList_Check(path)) {
1228 PyErr_SetString(PyExc_ImportError,
Guido van Rossuma5568d31998-03-05 03:45:08 +00001229 "sys.path must be a list of directory names");
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001230 return NULL;
1231 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001232
1233 path_hooks = PySys_GetObject("path_hooks");
1234 if (path_hooks == NULL || !PyList_Check(path_hooks)) {
1235 PyErr_SetString(PyExc_ImportError,
1236 "sys.path_hooks must be a list of "
1237 "import hooks");
1238 return NULL;
1239 }
1240 path_importer_cache = PySys_GetObject("path_importer_cache");
1241 if (path_importer_cache == NULL ||
1242 !PyDict_Check(path_importer_cache)) {
1243 PyErr_SetString(PyExc_ImportError,
1244 "sys.path_importer_cache must be a dict");
1245 return NULL;
1246 }
1247
Guido van Rossum79f25d91997-04-29 20:08:16 +00001248 npath = PyList_Size(path);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001249 namelen = strlen(name);
1250 for (i = 0; i < npath; i++) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00001251 PyObject *v = PyList_GetItem(path, i);
Guido van Rossumf15a29f2007-05-04 00:41:39 +00001252 PyObject *origv = v;
Guido van Rossum6262cc72007-05-09 23:29:27 +00001253 const char *base;
Guido van Rossumf15a29f2007-05-04 00:41:39 +00001254 Py_ssize_t size;
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001255 if (!v)
1256 return NULL;
Guido van Rossuma4b8d1d2007-08-27 15:02:28 +00001257 if (PyUnicode_Check(v)) {
1258 v = _PyUnicode_AsDefaultEncodedString(v, NULL);
1259 if (v == NULL)
1260 return NULL;
1261 }
1262 if (!PyString_Check(v))
1263 continue;
1264 base = PyString_AS_STRING(v);
1265 size = PyString_GET_SIZE(v);
Guido van Rossumf15a29f2007-05-04 00:41:39 +00001266 len = size;
Walter Dörwald3430d702002-06-17 10:43:59 +00001267 if (len + 2 + namelen + MAXSUFFIXSIZE >= buflen) {
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001268 continue; /* Too long */
Walter Dörwald3430d702002-06-17 10:43:59 +00001269 }
Guido van Rossumf15a29f2007-05-04 00:41:39 +00001270 strcpy(buf, base);
Walter Dörwald3430d702002-06-17 10:43:59 +00001271 if (strlen(buf) != len) {
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001272 continue; /* v contains '\0' */
Walter Dörwald3430d702002-06-17 10:43:59 +00001273 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001274
1275 /* sys.path_hooks import hook */
1276 if (p_loader != NULL) {
1277 PyObject *importer;
1278
1279 importer = get_path_importer(path_importer_cache,
Guido van Rossumf15a29f2007-05-04 00:41:39 +00001280 path_hooks, origv);
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001281 if (importer == NULL) {
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001282 return NULL;
Thomas Wouters477c8d52006-05-27 19:21:47 +00001283 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001284 /* Note: importer is a borrowed reference */
1285 if (importer != Py_None) {
Just van Rossum52e14d62002-12-30 22:08:05 +00001286 PyObject *loader;
1287 loader = PyObject_CallMethod(importer,
1288 "find_module",
1289 "s", fullname);
1290 if (loader == NULL)
1291 return NULL; /* error */
1292 if (loader != Py_None) {
1293 /* a loader was found */
1294 *p_loader = loader;
1295 return &importhookdescr;
1296 }
1297 Py_DECREF(loader);
Thomas Wouters477c8d52006-05-27 19:21:47 +00001298 continue;
Just van Rossum52e14d62002-12-30 22:08:05 +00001299 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001300 }
Thomas Wouters477c8d52006-05-27 19:21:47 +00001301 /* no hook was found, use builtin import */
Just van Rossum52e14d62002-12-30 22:08:05 +00001302
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001303 if (len > 0 && buf[len-1] != SEP
1304#ifdef ALTSEP
1305 && buf[len-1] != ALTSEP
1306#endif
1307 )
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001308 buf[len++] = SEP;
Guido van Rossum215c3402000-11-13 17:26:32 +00001309 strcpy(buf+len, name);
1310 len += namelen;
Tim Peters50d8d372001-02-28 05:34:27 +00001311
1312 /* Check for package import (buf holds a directory name,
1313 and there's an __init__ module in that directory */
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001314#ifdef HAVE_STAT
Walter Dörwald3430d702002-06-17 10:43:59 +00001315 if (stat(buf, &statbuf) == 0 && /* it exists */
1316 S_ISDIR(statbuf.st_mode) && /* it's a directory */
Thomas Wouters477c8d52006-05-27 19:21:47 +00001317 case_ok(buf, len, namelen, name)) { /* case matches */
1318 if (find_init_module(buf)) { /* and has __init__.py */
Thomas Wouters477c8d52006-05-27 19:21:47 +00001319 return &fd_package;
1320 }
1321 else {
1322 char warnstr[MAXPATHLEN+80];
1323 sprintf(warnstr, "Not importing directory "
1324 "'%.*s': missing __init__.py",
1325 MAXPATHLEN, buf);
Skip Montanaro46fc3372007-08-12 11:44:53 +00001326 if (PyErr_WarnEx(PyExc_ImportWarning,
1327 warnstr, 1)) {
Thomas Wouters477c8d52006-05-27 19:21:47 +00001328 return NULL;
1329 }
1330 }
Walter Dörwald3430d702002-06-17 10:43:59 +00001331 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001332#endif
Andrew MacIntyred9400542002-02-26 11:41:34 +00001333#if defined(PYOS_OS2)
1334 /* take a snapshot of the module spec for restoration
1335 * after the 8 character DLL hackery
1336 */
1337 saved_buf = strdup(buf);
1338 saved_len = len;
1339 saved_namelen = namelen;
1340#endif /* PYOS_OS2 */
Guido van Rossum79f25d91997-04-29 20:08:16 +00001341 for (fdp = _PyImport_Filetab; fdp->suffix != NULL; fdp++) {
Guido van Rossum04110fb2007-08-24 16:32:05 +00001342#if defined(PYOS_OS2) && defined(HAVE_DYNAMIC_LOADING)
Jeremy Hylton4ae6fae2002-05-30 17:15:25 +00001343 /* OS/2 limits DLLs to 8 character names (w/o
1344 extension)
Andrew MacIntyred9400542002-02-26 11:41:34 +00001345 * so if the name is longer than that and its a
1346 * dynamically loaded module we're going to try,
1347 * truncate the name before trying
1348 */
Just van Rossum52e14d62002-12-30 22:08:05 +00001349 if (strlen(subname) > 8) {
Andrew MacIntyred9400542002-02-26 11:41:34 +00001350 /* is this an attempt to load a C extension? */
Jeremy Hylton4ae6fae2002-05-30 17:15:25 +00001351 const struct filedescr *scan;
1352 scan = _PyImport_DynLoadFiletab;
Andrew MacIntyred9400542002-02-26 11:41:34 +00001353 while (scan->suffix != NULL) {
Jeremy Hylton4ae6fae2002-05-30 17:15:25 +00001354 if (!strcmp(scan->suffix, fdp->suffix))
Andrew MacIntyred9400542002-02-26 11:41:34 +00001355 break;
1356 else
1357 scan++;
1358 }
1359 if (scan->suffix != NULL) {
1360 /* yes, so truncate the name */
1361 namelen = 8;
Just van Rossum52e14d62002-12-30 22:08:05 +00001362 len -= strlen(subname) - namelen;
Andrew MacIntyred9400542002-02-26 11:41:34 +00001363 buf[len] = '\0';
1364 }
1365 }
1366#endif /* PYOS_OS2 */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001367 strcpy(buf+len, fdp->suffix);
Guido van Rossum79f25d91997-04-29 20:08:16 +00001368 if (Py_VerboseFlag > 1)
Guido van Rossum2f3667a1998-10-12 18:23:55 +00001369 PySys_WriteStderr("# trying %s\n", buf);
Jack Jansenc88da1f2002-05-28 10:58:19 +00001370 filemode = fdp->mode;
Tim Peters86c7d2f2004-08-01 23:24:21 +00001371 if (filemode[0] == 'U')
Jeremy Hylton4ae6fae2002-05-30 17:15:25 +00001372 filemode = "r" PY_STDIOTEXTMODE;
Jack Jansenc88da1f2002-05-28 10:58:19 +00001373 fp = fopen(buf, filemode);
Tim Peters50d8d372001-02-28 05:34:27 +00001374 if (fp != NULL) {
1375 if (case_ok(buf, len, namelen, name))
1376 break;
1377 else { /* continue search */
1378 fclose(fp);
1379 fp = NULL;
Barry Warsaw914a0b12001-02-02 19:12:16 +00001380 }
Barry Warsaw914a0b12001-02-02 19:12:16 +00001381 }
Andrew MacIntyred9400542002-02-26 11:41:34 +00001382#if defined(PYOS_OS2)
1383 /* restore the saved snapshot */
1384 strcpy(buf, saved_buf);
1385 len = saved_len;
1386 namelen = saved_namelen;
1387#endif
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001388 }
Andrew MacIntyred9400542002-02-26 11:41:34 +00001389#if defined(PYOS_OS2)
1390 /* don't need/want the module name snapshot anymore */
1391 if (saved_buf)
1392 {
1393 free(saved_buf);
1394 saved_buf = NULL;
1395 }
1396#endif
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001397 if (fp != NULL)
1398 break;
1399 }
1400 if (fp == NULL) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001401 PyErr_Format(PyExc_ImportError,
1402 "No module named %.200s", name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001403 return NULL;
1404 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001405 *p_fp = fp;
1406 return fdp;
1407}
1408
Raymond Hettingerdb29e0f2004-10-07 06:46:25 +00001409/* Helpers for main.c
1410 * Find the source file corresponding to a named module
1411 */
1412struct filedescr *
1413_PyImport_FindModule(const char *name, PyObject *path, char *buf,
1414 size_t buflen, FILE **p_fp, PyObject **p_loader)
1415{
1416 return find_module((char *) name, (char *) name, path,
1417 buf, buflen, p_fp, p_loader);
1418}
1419
1420PyAPI_FUNC(int) _PyImport_IsScript(struct filedescr * fd)
1421{
1422 return fd->type == PY_SOURCE || fd->type == PY_COMPILED;
1423}
1424
Martin v. Löwis18e16552006-02-15 17:27:45 +00001425/* case_ok(char* buf, Py_ssize_t len, Py_ssize_t namelen, char* name)
Tim Petersd1e87a82001-03-01 18:12:00 +00001426 * The arguments here are tricky, best shown by example:
1427 * /a/b/c/d/e/f/g/h/i/j/k/some_long_module_name.py\0
1428 * ^ ^ ^ ^
1429 * |--------------------- buf ---------------------|
1430 * |------------------- len ------------------|
1431 * |------ name -------|
1432 * |----- namelen -----|
1433 * buf is the full path, but len only counts up to (& exclusive of) the
1434 * extension. name is the module name, also exclusive of extension.
1435 *
1436 * We've already done a successful stat() or fopen() on buf, so know that
1437 * there's some match, possibly case-insensitive.
1438 *
Tim Peters50d8d372001-02-28 05:34:27 +00001439 * case_ok() is to return 1 if there's a case-sensitive match for
1440 * name, else 0. case_ok() is also to return 1 if envar PYTHONCASEOK
1441 * exists.
Tim Petersd1e87a82001-03-01 18:12:00 +00001442 *
Tim Peters50d8d372001-02-28 05:34:27 +00001443 * case_ok() is used to implement case-sensitive import semantics even
1444 * on platforms with case-insensitive filesystems. It's trivial to implement
1445 * for case-sensitive filesystems. It's pretty much a cross-platform
1446 * nightmare for systems with case-insensitive filesystems.
1447 */
Guido van Rossum0980bd91998-02-13 17:18:36 +00001448
Tim Peters50d8d372001-02-28 05:34:27 +00001449/* First we may need a pile of platform-specific header files; the sequence
1450 * of #if's here should match the sequence in the body of case_ok().
1451 */
Jason Tishler7961aa62005-05-20 00:56:54 +00001452#if defined(MS_WINDOWS)
Guido van Rossum0980bd91998-02-13 17:18:36 +00001453#include <windows.h>
Guido van Rossum4c3f57c2001-01-10 20:40:46 +00001454
Tim Peters50d8d372001-02-28 05:34:27 +00001455#elif defined(DJGPP)
1456#include <dir.h>
1457
Jason Tishler7961aa62005-05-20 00:56:54 +00001458#elif (defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) && defined(HAVE_DIRENT_H)
Tim Peters430f5d42001-03-01 01:30:56 +00001459#include <sys/types.h>
1460#include <dirent.h>
1461
Andrew MacIntyred9400542002-02-26 11:41:34 +00001462#elif defined(PYOS_OS2)
1463#define INCL_DOS
1464#define INCL_DOSERRORS
1465#define INCL_NOPMAPI
1466#include <os2.h>
Tim Peters50d8d372001-02-28 05:34:27 +00001467#endif
1468
Guido van Rossum0980bd91998-02-13 17:18:36 +00001469static int
Martin v. Löwis18e16552006-02-15 17:27:45 +00001470case_ok(char *buf, Py_ssize_t len, Py_ssize_t namelen, char *name)
Guido van Rossum0980bd91998-02-13 17:18:36 +00001471{
Tim Peters50d8d372001-02-28 05:34:27 +00001472/* Pick a platform-specific implementation; the sequence of #if's here should
1473 * match the sequence just above.
1474 */
1475
Jason Tishler7961aa62005-05-20 00:56:54 +00001476/* MS_WINDOWS */
1477#if defined(MS_WINDOWS)
Guido van Rossum0980bd91998-02-13 17:18:36 +00001478 WIN32_FIND_DATA data;
1479 HANDLE h;
Tim Peters50d8d372001-02-28 05:34:27 +00001480
Neil Schemenauer7d4bb9f2001-07-23 16:30:27 +00001481 if (Py_GETENV("PYTHONCASEOK") != NULL)
Guido van Rossum0980bd91998-02-13 17:18:36 +00001482 return 1;
Tim Peters50d8d372001-02-28 05:34:27 +00001483
Guido van Rossum0980bd91998-02-13 17:18:36 +00001484 h = FindFirstFile(buf, &data);
1485 if (h == INVALID_HANDLE_VALUE) {
1486 PyErr_Format(PyExc_NameError,
1487 "Can't find file for module %.100s\n(filename %.300s)",
1488 name, buf);
1489 return 0;
1490 }
1491 FindClose(h);
Tim Peters50d8d372001-02-28 05:34:27 +00001492 return strncmp(data.cFileName, name, namelen) == 0;
1493
1494/* DJGPP */
1495#elif defined(DJGPP)
1496 struct ffblk ffblk;
1497 int done;
1498
Neil Schemenauer7d4bb9f2001-07-23 16:30:27 +00001499 if (Py_GETENV("PYTHONCASEOK") != NULL)
Guido van Rossum323bf5e1998-06-24 03:54:06 +00001500 return 1;
Tim Peters50d8d372001-02-28 05:34:27 +00001501
1502 done = findfirst(buf, &ffblk, FA_ARCH|FA_RDONLY|FA_HIDDEN|FA_DIREC);
1503 if (done) {
Guido van Rossum0980bd91998-02-13 17:18:36 +00001504 PyErr_Format(PyExc_NameError,
Tim Peters50d8d372001-02-28 05:34:27 +00001505 "Can't find file for module %.100s\n(filename %.300s)",
Guido van Rossum0980bd91998-02-13 17:18:36 +00001506 name, buf);
1507 return 0;
1508 }
Tim Peters50d8d372001-02-28 05:34:27 +00001509 return strncmp(ffblk.ff_name, name, namelen) == 0;
Guido van Rossum0980bd91998-02-13 17:18:36 +00001510
Jason Tishler7961aa62005-05-20 00:56:54 +00001511/* new-fangled macintosh (macosx) or Cygwin */
1512#elif (defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) && defined(HAVE_DIRENT_H)
Tim Peters430f5d42001-03-01 01:30:56 +00001513 DIR *dirp;
1514 struct dirent *dp;
Tim Petersd1e87a82001-03-01 18:12:00 +00001515 char dirname[MAXPATHLEN + 1];
1516 const int dirlen = len - namelen - 1; /* don't want trailing SEP */
Tim Peters430f5d42001-03-01 01:30:56 +00001517
Neil Schemenauer7d4bb9f2001-07-23 16:30:27 +00001518 if (Py_GETENV("PYTHONCASEOK") != NULL)
Tim Petersdbe6ebb2001-03-01 08:47:29 +00001519 return 1;
1520
Tim Petersd1e87a82001-03-01 18:12:00 +00001521 /* Copy the dir component into dirname; substitute "." if empty */
1522 if (dirlen <= 0) {
1523 dirname[0] = '.';
1524 dirname[1] = '\0';
Tim Peters430f5d42001-03-01 01:30:56 +00001525 }
1526 else {
Tim Petersd1e87a82001-03-01 18:12:00 +00001527 assert(dirlen <= MAXPATHLEN);
1528 memcpy(dirname, buf, dirlen);
1529 dirname[dirlen] = '\0';
Tim Peters430f5d42001-03-01 01:30:56 +00001530 }
1531 /* Open the directory and search the entries for an exact match. */
Tim Petersd1e87a82001-03-01 18:12:00 +00001532 dirp = opendir(dirname);
Tim Peters430f5d42001-03-01 01:30:56 +00001533 if (dirp) {
Tim Peters677898a2001-03-02 03:28:03 +00001534 char *nameWithExt = buf + len - namelen;
Tim Peters430f5d42001-03-01 01:30:56 +00001535 while ((dp = readdir(dirp)) != NULL) {
Tim Petersdbe6ebb2001-03-01 08:47:29 +00001536 const int thislen =
Tim Peters430f5d42001-03-01 01:30:56 +00001537#ifdef _DIRENT_HAVE_D_NAMELEN
Tim Petersdbe6ebb2001-03-01 08:47:29 +00001538 dp->d_namlen;
Tim Peters430f5d42001-03-01 01:30:56 +00001539#else
Tim Petersdbe6ebb2001-03-01 08:47:29 +00001540 strlen(dp->d_name);
Tim Peters430f5d42001-03-01 01:30:56 +00001541#endif
Tim Petersd1e87a82001-03-01 18:12:00 +00001542 if (thislen >= namelen &&
Tim Peters677898a2001-03-02 03:28:03 +00001543 strcmp(dp->d_name, nameWithExt) == 0) {
Tim Peters430f5d42001-03-01 01:30:56 +00001544 (void)closedir(dirp);
1545 return 1; /* Found */
1546 }
1547 }
Tim Petersdbe6ebb2001-03-01 08:47:29 +00001548 (void)closedir(dirp);
Tim Peters430f5d42001-03-01 01:30:56 +00001549 }
Tim Peters430f5d42001-03-01 01:30:56 +00001550 return 0 ; /* Not found */
Tim Peters430f5d42001-03-01 01:30:56 +00001551
Andrew MacIntyred9400542002-02-26 11:41:34 +00001552/* OS/2 */
1553#elif defined(PYOS_OS2)
1554 HDIR hdir = 1;
1555 ULONG srchcnt = 1;
1556 FILEFINDBUF3 ffbuf;
1557 APIRET rc;
1558
1559 if (getenv("PYTHONCASEOK") != NULL)
1560 return 1;
1561
1562 rc = DosFindFirst(buf,
1563 &hdir,
1564 FILE_READONLY | FILE_HIDDEN | FILE_SYSTEM | FILE_DIRECTORY,
1565 &ffbuf, sizeof(ffbuf),
1566 &srchcnt,
1567 FIL_STANDARD);
1568 if (rc != NO_ERROR)
1569 return 0;
1570 return strncmp(ffbuf.achName, name, namelen) == 0;
1571
Tim Peters50d8d372001-02-28 05:34:27 +00001572/* assuming it's a case-sensitive filesystem, so there's nothing to do! */
1573#else
Guido van Rossum0980bd91998-02-13 17:18:36 +00001574 return 1;
Guido van Rossum0980bd91998-02-13 17:18:36 +00001575
Guido van Rossum4d1b3b91998-02-13 23:27:59 +00001576#endif
Tim Peters50d8d372001-02-28 05:34:27 +00001577}
Guido van Rossum4d1b3b91998-02-13 23:27:59 +00001578
Guido van Rossum0980bd91998-02-13 17:18:36 +00001579
Guido van Rossum197346f1997-10-31 18:38:52 +00001580#ifdef HAVE_STAT
1581/* Helper to look for __init__.py or __init__.py[co] in potential package */
1582static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001583find_init_module(char *buf)
Guido van Rossum197346f1997-10-31 18:38:52 +00001584{
Tim Peters0f9431f2001-07-05 03:47:53 +00001585 const size_t save_len = strlen(buf);
Fred Drake4c82b232000-06-30 16:18:57 +00001586 size_t i = save_len;
Tim Peters0f9431f2001-07-05 03:47:53 +00001587 char *pname; /* pointer to start of __init__ */
Guido van Rossum197346f1997-10-31 18:38:52 +00001588 struct stat statbuf;
1589
Tim Peters0f9431f2001-07-05 03:47:53 +00001590/* For calling case_ok(buf, len, namelen, name):
1591 * /a/b/c/d/e/f/g/h/i/j/k/some_long_module_name.py\0
1592 * ^ ^ ^ ^
1593 * |--------------------- buf ---------------------|
1594 * |------------------- len ------------------|
1595 * |------ name -------|
1596 * |----- namelen -----|
1597 */
Guido van Rossum197346f1997-10-31 18:38:52 +00001598 if (save_len + 13 >= MAXPATHLEN)
1599 return 0;
1600 buf[i++] = SEP;
Tim Peters0f9431f2001-07-05 03:47:53 +00001601 pname = buf + i;
1602 strcpy(pname, "__init__.py");
Guido van Rossum197346f1997-10-31 18:38:52 +00001603 if (stat(buf, &statbuf) == 0) {
Tim Peters0f9431f2001-07-05 03:47:53 +00001604 if (case_ok(buf,
1605 save_len + 9, /* len("/__init__") */
1606 8, /* len("__init__") */
1607 pname)) {
1608 buf[save_len] = '\0';
1609 return 1;
1610 }
Guido van Rossum197346f1997-10-31 18:38:52 +00001611 }
Tim Peters0f9431f2001-07-05 03:47:53 +00001612 i += strlen(pname);
1613 strcpy(buf+i, Py_OptimizeFlag ? "o" : "c");
Guido van Rossum197346f1997-10-31 18:38:52 +00001614 if (stat(buf, &statbuf) == 0) {
Tim Peters0f9431f2001-07-05 03:47:53 +00001615 if (case_ok(buf,
1616 save_len + 9, /* len("/__init__") */
1617 8, /* len("__init__") */
1618 pname)) {
1619 buf[save_len] = '\0';
1620 return 1;
1621 }
Guido van Rossum197346f1997-10-31 18:38:52 +00001622 }
1623 buf[save_len] = '\0';
1624 return 0;
1625}
Guido van Rossum48a680c2001-03-02 06:34:14 +00001626
Guido van Rossum197346f1997-10-31 18:38:52 +00001627#endif /* HAVE_STAT */
1628
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001629
Tim Petersdbd9ba62000-07-09 03:09:57 +00001630static int init_builtin(char *); /* Forward */
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001631
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001632/* Load an external module using the default search path and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001633 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001634
Guido van Rossum79f25d91997-04-29 20:08:16 +00001635static PyObject *
Just van Rossum52e14d62002-12-30 22:08:05 +00001636load_module(char *name, FILE *fp, char *buf, int type, PyObject *loader)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001637{
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001638 PyObject *modules;
Guido van Rossum79f25d91997-04-29 20:08:16 +00001639 PyObject *m;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001640 int err;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001641
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001642 /* First check that there's an open file (if we need one) */
1643 switch (type) {
1644 case PY_SOURCE:
1645 case PY_COMPILED:
1646 if (fp == NULL) {
1647 PyErr_Format(PyExc_ValueError,
1648 "file object required for import (type code %d)",
1649 type);
1650 return NULL;
1651 }
1652 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001653
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001654 switch (type) {
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001655
1656 case PY_SOURCE:
1657 m = load_source_module(name, buf, fp);
1658 break;
1659
1660 case PY_COMPILED:
1661 m = load_compiled_module(name, buf, fp);
1662 break;
1663
Guido van Rossum96a8fb71999-12-22 14:09:35 +00001664#ifdef HAVE_DYNAMIC_LOADING
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001665 case C_EXTENSION:
Guido van Rossum79f25d91997-04-29 20:08:16 +00001666 m = _PyImport_LoadDynamicModule(name, buf, fp);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001667 break;
Guido van Rossum96a8fb71999-12-22 14:09:35 +00001668#endif
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001669
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001670 case PKG_DIRECTORY:
1671 m = load_package(name, buf);
1672 break;
1673
1674 case C_BUILTIN:
1675 case PY_FROZEN:
Guido van Rossuma5568d31998-03-05 03:45:08 +00001676 if (buf != NULL && buf[0] != '\0')
1677 name = buf;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001678 if (type == C_BUILTIN)
1679 err = init_builtin(name);
1680 else
1681 err = PyImport_ImportFrozenModule(name);
1682 if (err < 0)
Guido van Rossuma86f77d1997-09-09 18:53:47 +00001683 return NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001684 if (err == 0) {
1685 PyErr_Format(PyExc_ImportError,
1686 "Purported %s module %.200s not found",
1687 type == C_BUILTIN ?
1688 "builtin" : "frozen",
1689 name);
Guido van Rossuma86f77d1997-09-09 18:53:47 +00001690 return NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001691 }
1692 modules = PyImport_GetModuleDict();
1693 m = PyDict_GetItemString(modules, name);
1694 if (m == NULL) {
1695 PyErr_Format(
1696 PyExc_ImportError,
1697 "%s module %.200s not properly initialized",
1698 type == C_BUILTIN ?
1699 "builtin" : "frozen",
1700 name);
Guido van Rossuma86f77d1997-09-09 18:53:47 +00001701 return NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001702 }
1703 Py_INCREF(m);
1704 break;
1705
Just van Rossum52e14d62002-12-30 22:08:05 +00001706 case IMP_HOOK: {
1707 if (loader == NULL) {
1708 PyErr_SetString(PyExc_ImportError,
1709 "import hook without loader");
1710 return NULL;
1711 }
1712 m = PyObject_CallMethod(loader, "load_module", "s", name);
1713 break;
1714 }
1715
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001716 default:
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001717 PyErr_Format(PyExc_ImportError,
1718 "Don't know how to import %.200s (type code %d)",
1719 name, type);
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001720 m = NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001721
1722 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001723
1724 return m;
1725}
1726
1727
1728/* Initialize a built-in module.
Thomas Wouters89f507f2006-12-13 04:49:30 +00001729 Return 1 for success, 0 if the module is not found, and -1 with
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001730 an exception set if the initialization failed. */
Guido van Rossum7f133ed1991-02-19 12:23:57 +00001731
Guido van Rossum7f133ed1991-02-19 12:23:57 +00001732static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001733init_builtin(char *name)
Guido van Rossum7f133ed1991-02-19 12:23:57 +00001734{
Guido van Rossum25ce5661997-08-02 03:10:38 +00001735 struct _inittab *p;
Guido van Rossum25ce5661997-08-02 03:10:38 +00001736
Greg Ward201baee2001-10-04 14:52:06 +00001737 if (_PyImport_FindExtension(name, name) != NULL)
Guido van Rossum25ce5661997-08-02 03:10:38 +00001738 return 1;
1739
Guido van Rossum771c6c81997-10-31 18:37:24 +00001740 for (p = PyImport_Inittab; p->name != NULL; p++) {
Guido van Rossum25ce5661997-08-02 03:10:38 +00001741 if (strcmp(name, p->name) == 0) {
1742 if (p->initfunc == NULL) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001743 PyErr_Format(PyExc_ImportError,
1744 "Cannot re-init internal module %.200s",
1745 name);
Guido van Rossum74e6a111994-08-29 12:54:38 +00001746 return -1;
1747 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00001748 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +00001749 PySys_WriteStderr("import %s # builtin\n", name);
Guido van Rossum25ce5661997-08-02 03:10:38 +00001750 (*p->initfunc)();
Guido van Rossum79f25d91997-04-29 20:08:16 +00001751 if (PyErr_Occurred())
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001752 return -1;
Guido van Rossum25ce5661997-08-02 03:10:38 +00001753 if (_PyImport_FixupExtension(name, name) == NULL)
1754 return -1;
Guido van Rossum7f133ed1991-02-19 12:23:57 +00001755 return 1;
1756 }
1757 }
1758 return 0;
1759}
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001760
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001761
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001762/* Frozen modules */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001763
Guido van Rossumcfd0a221996-06-17 17:06:34 +00001764static struct _frozen *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001765find_frozen(char *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001766{
Guido van Rossumcfd0a221996-06-17 17:06:34 +00001767 struct _frozen *p;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001768
Guido van Rossum79f25d91997-04-29 20:08:16 +00001769 for (p = PyImport_FrozenModules; ; p++) {
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001770 if (p->name == NULL)
1771 return NULL;
1772 if (strcmp(p->name, name) == 0)
1773 break;
1774 }
1775 return p;
1776}
1777
Guido van Rossum79f25d91997-04-29 20:08:16 +00001778static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001779get_frozen_object(char *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001780{
Guido van Rossumcfd0a221996-06-17 17:06:34 +00001781 struct _frozen *p = find_frozen(name);
Guido van Rossuma5568d31998-03-05 03:45:08 +00001782 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001783
1784 if (p == NULL) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001785 PyErr_Format(PyExc_ImportError,
1786 "No such frozen object named %.200s",
1787 name);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001788 return NULL;
1789 }
Guido van Rossum8f4d3312001-10-18 18:54:11 +00001790 if (p->code == NULL) {
1791 PyErr_Format(PyExc_ImportError,
1792 "Excluded frozen object named %.200s",
1793 name);
1794 return NULL;
1795 }
Guido van Rossuma5568d31998-03-05 03:45:08 +00001796 size = p->size;
1797 if (size < 0)
1798 size = -size;
1799 return PyMarshal_ReadObjectFromString((char *)p->code, size);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001800}
1801
1802/* Initialize a frozen module.
1803 Return 1 for succes, 0 if the module is not found, and -1 with
1804 an exception set if the initialization failed.
1805 This function is also used from frozenmain.c */
Guido van Rossum0b344901995-02-07 15:35:27 +00001806
1807int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001808PyImport_ImportFrozenModule(char *name)
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001809{
Guido van Rossumcfd0a221996-06-17 17:06:34 +00001810 struct _frozen *p = find_frozen(name);
Guido van Rossum79f25d91997-04-29 20:08:16 +00001811 PyObject *co;
1812 PyObject *m;
Guido van Rossuma5568d31998-03-05 03:45:08 +00001813 int ispackage;
1814 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001815
1816 if (p == NULL)
1817 return 0;
Guido van Rossum8f4d3312001-10-18 18:54:11 +00001818 if (p->code == NULL) {
1819 PyErr_Format(PyExc_ImportError,
1820 "Excluded frozen object named %.200s",
1821 name);
1822 return -1;
1823 }
Guido van Rossuma5568d31998-03-05 03:45:08 +00001824 size = p->size;
1825 ispackage = (size < 0);
1826 if (ispackage)
1827 size = -size;
Guido van Rossum79f25d91997-04-29 20:08:16 +00001828 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +00001829 PySys_WriteStderr("import %s # frozen%s\n",
Guido van Rossuma5568d31998-03-05 03:45:08 +00001830 name, ispackage ? " package" : "");
1831 co = PyMarshal_ReadObjectFromString((char *)p->code, size);
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001832 if (co == NULL)
1833 return -1;
Guido van Rossum79f25d91997-04-29 20:08:16 +00001834 if (!PyCode_Check(co)) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001835 PyErr_Format(PyExc_TypeError,
1836 "frozen object %.200s is not a code object",
1837 name);
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001838 goto err_return;
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001839 }
Guido van Rossuma5568d31998-03-05 03:45:08 +00001840 if (ispackage) {
1841 /* Set __path__ to the package name */
1842 PyObject *d, *s;
1843 int err;
1844 m = PyImport_AddModule(name);
1845 if (m == NULL)
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001846 goto err_return;
Guido van Rossuma5568d31998-03-05 03:45:08 +00001847 d = PyModule_GetDict(m);
Martin v. Löwis5b222132007-06-10 09:51:05 +00001848 s = PyUnicode_InternFromString(name);
Guido van Rossuma5568d31998-03-05 03:45:08 +00001849 if (s == NULL)
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001850 goto err_return;
Guido van Rossuma5568d31998-03-05 03:45:08 +00001851 err = PyDict_SetItemString(d, "__path__", s);
1852 Py_DECREF(s);
1853 if (err != 0)
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001854 goto err_return;
Guido van Rossuma5568d31998-03-05 03:45:08 +00001855 }
Guido van Rossume32bf6e1998-02-11 05:53:02 +00001856 m = PyImport_ExecCodeModuleEx(name, co, "<frozen>");
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001857 if (m == NULL)
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001858 goto err_return;
1859 Py_DECREF(co);
Guido van Rossum79f25d91997-04-29 20:08:16 +00001860 Py_DECREF(m);
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001861 return 1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001862err_return:
1863 Py_DECREF(co);
1864 return -1;
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001865}
Guido van Rossum74e6a111994-08-29 12:54:38 +00001866
1867
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001868/* Import a module, either built-in, frozen, or external, and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001869 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum74e6a111994-08-29 12:54:38 +00001870
Guido van Rossum79f25d91997-04-29 20:08:16 +00001871PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001872PyImport_ImportModule(const char *name)
Guido van Rossum74e6a111994-08-29 12:54:38 +00001873{
Marc-André Lemburg3c61c352001-02-09 19:40:15 +00001874 PyObject *pname;
1875 PyObject *result;
1876
Martin v. Löwis5b222132007-06-10 09:51:05 +00001877 pname = PyUnicode_FromString(name);
Neal Norwitza11e4c12003-03-23 14:31:01 +00001878 if (pname == NULL)
1879 return NULL;
Marc-André Lemburg3c61c352001-02-09 19:40:15 +00001880 result = PyImport_Import(pname);
1881 Py_DECREF(pname);
1882 return result;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001883}
1884
Guido van Rossum17fc85f1997-09-06 18:52:03 +00001885/* Forward declarations for helper routines */
Thomas Woutersf7f438b2006-02-28 16:09:29 +00001886static PyObject *get_parent(PyObject *globals, char *buf,
1887 Py_ssize_t *p_buflen, int level);
Tim Petersdbd9ba62000-07-09 03:09:57 +00001888static PyObject *load_next(PyObject *mod, PyObject *altmod,
Martin v. Löwis18e16552006-02-15 17:27:45 +00001889 char **p_name, char *buf, Py_ssize_t *p_buflen);
Tim Petersdbd9ba62000-07-09 03:09:57 +00001890static int mark_miss(char *name);
1891static int ensure_fromlist(PyObject *mod, PyObject *fromlist,
Martin v. Löwis18e16552006-02-15 17:27:45 +00001892 char *buf, Py_ssize_t buflen, int recursive);
Tim Petersdbd9ba62000-07-09 03:09:57 +00001893static PyObject * import_submodule(PyObject *mod, char *name, char *fullname);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00001894
1895/* The Magnum Opus of dotted-name import :-) */
1896
Guido van Rossum75acc9c1998-03-03 22:26:50 +00001897static PyObject *
Thomas Woutersf7f438b2006-02-28 16:09:29 +00001898import_module_level(char *name, PyObject *globals, PyObject *locals,
1899 PyObject *fromlist, int level)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001900{
Guido van Rossum17fc85f1997-09-06 18:52:03 +00001901 char buf[MAXPATHLEN+1];
Martin v. Löwis18e16552006-02-15 17:27:45 +00001902 Py_ssize_t buflen = 0;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00001903 PyObject *parent, *head, *next, *tail;
1904
Thomas Woutersf7f438b2006-02-28 16:09:29 +00001905 parent = get_parent(globals, buf, &buflen, level);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00001906 if (parent == NULL)
1907 return NULL;
1908
1909 head = load_next(parent, Py_None, &name, buf, &buflen);
1910 if (head == NULL)
1911 return NULL;
1912
1913 tail = head;
1914 Py_INCREF(tail);
1915 while (name) {
1916 next = load_next(tail, tail, &name, buf, &buflen);
1917 Py_DECREF(tail);
1918 if (next == NULL) {
1919 Py_DECREF(head);
1920 return NULL;
1921 }
1922 tail = next;
1923 }
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001924 if (tail == Py_None) {
1925 /* If tail is Py_None, both get_parent and load_next found
1926 an empty module name: someone called __import__("") or
1927 doctored faulty bytecode */
1928 Py_DECREF(tail);
1929 Py_DECREF(head);
1930 PyErr_SetString(PyExc_ValueError,
1931 "Empty module name");
1932 return NULL;
1933 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00001934
1935 if (fromlist != NULL) {
1936 if (fromlist == Py_None || !PyObject_IsTrue(fromlist))
1937 fromlist = NULL;
1938 }
1939
1940 if (fromlist == NULL) {
1941 Py_DECREF(tail);
1942 return head;
1943 }
1944
1945 Py_DECREF(head);
Guido van Rossum9905ef91997-09-08 16:07:11 +00001946 if (!ensure_fromlist(tail, fromlist, buf, buflen, 0)) {
Guido van Rossum17fc85f1997-09-06 18:52:03 +00001947 Py_DECREF(tail);
1948 return NULL;
1949 }
1950
1951 return tail;
1952}
1953
Thomas Woutersf7f438b2006-02-28 16:09:29 +00001954/* For DLL compatibility */
1955#undef PyImport_ImportModuleEx
Guido van Rossum75acc9c1998-03-03 22:26:50 +00001956PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001957PyImport_ImportModuleEx(char *name, PyObject *globals, PyObject *locals,
1958 PyObject *fromlist)
Guido van Rossum75acc9c1998-03-03 22:26:50 +00001959{
1960 PyObject *result;
1961 lock_import();
Thomas Woutersf7f438b2006-02-28 16:09:29 +00001962 result = import_module_level(name, globals, locals, fromlist, -1);
1963 if (unlock_import() < 0) {
1964 Py_XDECREF(result);
1965 PyErr_SetString(PyExc_RuntimeError,
1966 "not holding the import lock");
1967 return NULL;
1968 }
1969 return result;
1970}
1971#define PyImport_ImportModuleEx(n, g, l, f) \
1972 PyImport_ImportModuleLevel(n, g, l, f, -1);
1973
1974PyObject *
1975PyImport_ImportModuleLevel(char *name, PyObject *globals, PyObject *locals,
1976 PyObject *fromlist, int level)
1977{
1978 PyObject *result;
1979 lock_import();
1980 result = import_module_level(name, globals, locals, fromlist, level);
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00001981 if (unlock_import() < 0) {
1982 Py_XDECREF(result);
1983 PyErr_SetString(PyExc_RuntimeError,
1984 "not holding the import lock");
1985 return NULL;
1986 }
Guido van Rossum75acc9c1998-03-03 22:26:50 +00001987 return result;
1988}
1989
Fred Drake87590902004-05-28 20:21:36 +00001990/* Return the package that an import is being performed in. If globals comes
1991 from the module foo.bar.bat (not itself a package), this returns the
1992 sys.modules entry for foo.bar. If globals is from a package's __init__.py,
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00001993 the package's entry in sys.modules is returned, as a borrowed reference.
Fred Drake87590902004-05-28 20:21:36 +00001994
1995 The *name* of the returned package is returned in buf, with the length of
1996 the name in *p_buflen.
1997
1998 If globals doesn't come from a package or a module in a package, or a
1999 corresponding entry is not found in sys.modules, Py_None is returned.
2000*/
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002001static PyObject *
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002002get_parent(PyObject *globals, char *buf, Py_ssize_t *p_buflen, int level)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002003{
2004 static PyObject *namestr = NULL;
2005 static PyObject *pathstr = NULL;
2006 PyObject *modname, *modpath, *modules, *parent;
2007
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002008 if (globals == NULL || !PyDict_Check(globals) || !level)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002009 return Py_None;
2010
2011 if (namestr == NULL) {
Martin v. Löwis5b222132007-06-10 09:51:05 +00002012 namestr = PyUnicode_InternFromString("__name__");
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002013 if (namestr == NULL)
2014 return NULL;
2015 }
2016 if (pathstr == NULL) {
Martin v. Löwis5b222132007-06-10 09:51:05 +00002017 pathstr = PyUnicode_InternFromString("__path__");
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002018 if (pathstr == NULL)
2019 return NULL;
2020 }
2021
2022 *buf = '\0';
2023 *p_buflen = 0;
2024 modname = PyDict_GetItem(globals, namestr);
Neal Norwitz80e7f272007-08-26 06:45:23 +00002025 if (modname == NULL || !PyUnicode_Check(modname))
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002026 return Py_None;
2027
2028 modpath = PyDict_GetItem(globals, pathstr);
2029 if (modpath != NULL) {
Neal Norwitz80e7f272007-08-26 06:45:23 +00002030 Py_ssize_t len = PyUnicode_GET_SIZE(modname);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002031 if (len > MAXPATHLEN) {
2032 PyErr_SetString(PyExc_ValueError,
2033 "Module name too long");
2034 return NULL;
2035 }
Neal Norwitz80e7f272007-08-26 06:45:23 +00002036 strcpy(buf, PyUnicode_AsString(modname));
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002037 }
2038 else {
Neal Norwitz80e7f272007-08-26 06:45:23 +00002039 char *start = PyUnicode_AsString(modname);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002040 char *lastdot = strrchr(start, '.');
Fred Drake4c82b232000-06-30 16:18:57 +00002041 size_t len;
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002042 if (lastdot == NULL && level > 0) {
2043 PyErr_SetString(PyExc_ValueError,
Thomas Wouters89f507f2006-12-13 04:49:30 +00002044 "Attempted relative import in non-package");
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002045 return NULL;
2046 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002047 if (lastdot == NULL)
2048 return Py_None;
2049 len = lastdot - start;
2050 if (len >= MAXPATHLEN) {
2051 PyErr_SetString(PyExc_ValueError,
2052 "Module name too long");
2053 return NULL;
2054 }
2055 strncpy(buf, start, len);
2056 buf[len] = '\0';
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002057 }
2058
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002059 while (--level > 0) {
2060 char *dot = strrchr(buf, '.');
2061 if (dot == NULL) {
2062 PyErr_SetString(PyExc_ValueError,
Thomas Wouters89f507f2006-12-13 04:49:30 +00002063 "Attempted relative import beyond "
2064 "toplevel package");
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002065 return NULL;
2066 }
2067 *dot = '\0';
2068 }
2069 *p_buflen = strlen(buf);
2070
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002071 modules = PyImport_GetModuleDict();
2072 parent = PyDict_GetItemString(modules, buf);
2073 if (parent == NULL)
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002074 PyErr_Format(PyExc_SystemError,
2075 "Parent module '%.200s' not loaded", buf);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002076 return parent;
2077 /* We expect, but can't guarantee, if parent != None, that:
2078 - parent.__name__ == buf
2079 - parent.__dict__ is globals
2080 If this is violated... Who cares? */
2081}
2082
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002083/* altmod is either None or same as mod */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002084static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002085load_next(PyObject *mod, PyObject *altmod, char **p_name, char *buf,
Martin v. Löwis18e16552006-02-15 17:27:45 +00002086 Py_ssize_t *p_buflen)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002087{
2088 char *name = *p_name;
2089 char *dot = strchr(name, '.');
Fred Drake4c82b232000-06-30 16:18:57 +00002090 size_t len;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002091 char *p;
2092 PyObject *result;
2093
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002094 if (strlen(name) == 0) {
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002095 /* completely empty module name should only happen in
2096 'from . import' (or '__import__("")')*/
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002097 Py_INCREF(mod);
2098 *p_name = NULL;
2099 return mod;
2100 }
2101
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002102 if (dot == NULL) {
2103 *p_name = NULL;
2104 len = strlen(name);
2105 }
2106 else {
2107 *p_name = dot+1;
2108 len = dot-name;
2109 }
Guido van Rossum111c20b1998-04-11 17:38:22 +00002110 if (len == 0) {
2111 PyErr_SetString(PyExc_ValueError,
2112 "Empty module name");
2113 return NULL;
2114 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002115
2116 p = buf + *p_buflen;
2117 if (p != buf)
2118 *p++ = '.';
2119 if (p+len-buf >= MAXPATHLEN) {
2120 PyErr_SetString(PyExc_ValueError,
2121 "Module name too long");
2122 return NULL;
2123 }
2124 strncpy(p, name, len);
2125 p[len] = '\0';
2126 *p_buflen = p+len-buf;
2127
2128 result = import_submodule(mod, p, buf);
2129 if (result == Py_None && altmod != mod) {
2130 Py_DECREF(result);
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00002131 /* Here, altmod must be None and mod must not be None */
Guido van Rossum0c819451997-09-07 06:16:57 +00002132 result = import_submodule(altmod, p, p);
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00002133 if (result != NULL && result != Py_None) {
2134 if (mark_miss(buf) != 0) {
2135 Py_DECREF(result);
2136 return NULL;
2137 }
2138 strncpy(buf, name, len);
2139 buf[len] = '\0';
2140 *p_buflen = len;
2141 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002142 }
2143 if (result == NULL)
2144 return NULL;
2145
2146 if (result == Py_None) {
2147 Py_DECREF(result);
2148 PyErr_Format(PyExc_ImportError,
2149 "No module named %.200s", name);
2150 return NULL;
2151 }
2152
2153 return result;
2154}
2155
2156static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002157mark_miss(char *name)
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00002158{
2159 PyObject *modules = PyImport_GetModuleDict();
2160 return PyDict_SetItemString(modules, name, Py_None);
2161}
2162
2163static int
Martin v. Löwis18e16552006-02-15 17:27:45 +00002164ensure_fromlist(PyObject *mod, PyObject *fromlist, char *buf, Py_ssize_t buflen,
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002165 int recursive)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002166{
2167 int i;
2168
2169 if (!PyObject_HasAttrString(mod, "__path__"))
2170 return 1;
2171
2172 for (i = 0; ; i++) {
2173 PyObject *item = PySequence_GetItem(fromlist, i);
2174 int hasit;
2175 if (item == NULL) {
2176 if (PyErr_ExceptionMatches(PyExc_IndexError)) {
2177 PyErr_Clear();
2178 return 1;
2179 }
2180 return 0;
2181 }
Martin v. Löwis5b222132007-06-10 09:51:05 +00002182 if (!PyUnicode_Check(item)) {
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002183 PyErr_SetString(PyExc_TypeError,
Neal Norwitz80e7f272007-08-26 06:45:23 +00002184 "Item in ``from list'' not a string");
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002185 Py_DECREF(item);
2186 return 0;
2187 }
Martin v. Löwis5b222132007-06-10 09:51:05 +00002188 if (PyUnicode_AS_UNICODE(item)[0] == '*') {
Guido van Rossum9905ef91997-09-08 16:07:11 +00002189 PyObject *all;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002190 Py_DECREF(item);
Guido van Rossum9905ef91997-09-08 16:07:11 +00002191 /* See if the package defines __all__ */
2192 if (recursive)
2193 continue; /* Avoid endless recursion */
2194 all = PyObject_GetAttrString(mod, "__all__");
2195 if (all == NULL)
2196 PyErr_Clear();
2197 else {
Martin v. Löwis83969ee2004-03-23 16:28:13 +00002198 int ret = ensure_fromlist(mod, all, buf, buflen, 1);
Guido van Rossum9905ef91997-09-08 16:07:11 +00002199 Py_DECREF(all);
Martin v. Löwis83969ee2004-03-23 16:28:13 +00002200 if (!ret)
2201 return 0;
Guido van Rossum9905ef91997-09-08 16:07:11 +00002202 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002203 continue;
2204 }
2205 hasit = PyObject_HasAttr(mod, item);
2206 if (!hasit) {
Martin v. Löwis5b222132007-06-10 09:51:05 +00002207 PyObject *item8;
2208 char *subname;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002209 PyObject *submod;
2210 char *p;
Martin v. Löwis5b222132007-06-10 09:51:05 +00002211 if (!Py_FileSystemDefaultEncoding) {
2212 item8 = PyUnicode_EncodeASCII(PyUnicode_AsUnicode(item),
2213 PyUnicode_GetSize(item),
Martin v. Löwis427dbff2007-06-12 05:53:00 +00002214 NULL);
Martin v. Löwis5b222132007-06-10 09:51:05 +00002215 } else {
Guido van Rossum98297ee2007-11-06 21:34:58 +00002216 item8 = PyUnicode_AsEncodedString(item,
2217 Py_FileSystemDefaultEncoding, NULL);
Martin v. Löwis5b222132007-06-10 09:51:05 +00002218 }
2219 if (!item8) {
2220 PyErr_SetString(PyExc_ValueError, "Cannot encode path item");
2221 return 0;
2222 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00002223 subname = PyString_AS_STRING(item8);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002224 if (buflen + strlen(subname) >= MAXPATHLEN) {
2225 PyErr_SetString(PyExc_ValueError,
2226 "Module name too long");
2227 Py_DECREF(item);
2228 return 0;
2229 }
2230 p = buf + buflen;
2231 *p++ = '.';
2232 strcpy(p, subname);
2233 submod = import_submodule(mod, subname, buf);
Martin v. Löwis5b222132007-06-10 09:51:05 +00002234 Py_DECREF(item8);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002235 Py_XDECREF(submod);
2236 if (submod == NULL) {
2237 Py_DECREF(item);
2238 return 0;
2239 }
2240 }
2241 Py_DECREF(item);
2242 }
2243
Guido van Rossuma7f2e811997-10-03 15:33:32 +00002244 /* NOTREACHED */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002245}
2246
Neil Schemenauer00b09662003-06-16 21:03:07 +00002247static int
2248add_submodule(PyObject *mod, PyObject *submod, char *fullname, char *subname,
2249 PyObject *modules)
2250{
2251 if (mod == Py_None)
2252 return 1;
2253 /* Irrespective of the success of this load, make a
2254 reference to it in the parent package module. A copy gets
2255 saved in the modules dictionary under the full name, so get a
2256 reference from there, if need be. (The exception is when the
2257 load failed with a SyntaxError -- then there's no trace in
2258 sys.modules. In that case, of course, do nothing extra.) */
2259 if (submod == NULL) {
2260 submod = PyDict_GetItemString(modules, fullname);
2261 if (submod == NULL)
2262 return 1;
2263 }
2264 if (PyModule_Check(mod)) {
2265 /* We can't use setattr here since it can give a
2266 * spurious warning if the submodule name shadows a
2267 * builtin name */
2268 PyObject *dict = PyModule_GetDict(mod);
2269 if (!dict)
2270 return 0;
2271 if (PyDict_SetItemString(dict, subname, submod) < 0)
2272 return 0;
2273 }
2274 else {
2275 if (PyObject_SetAttrString(mod, subname, submod) < 0)
2276 return 0;
2277 }
2278 return 1;
2279}
2280
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002281static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002282import_submodule(PyObject *mod, char *subname, char *fullname)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002283{
Guido van Rossum25ce5661997-08-02 03:10:38 +00002284 PyObject *modules = PyImport_GetModuleDict();
Neil Schemenauer00b09662003-06-16 21:03:07 +00002285 PyObject *m = NULL;
Guido van Rossum74e6a111994-08-29 12:54:38 +00002286
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002287 /* Require:
2288 if mod == None: subname == fullname
2289 else: mod.__name__ + "." + subname == fullname
2290 */
2291
Tim Peters50d8d372001-02-28 05:34:27 +00002292 if ((m = PyDict_GetItemString(modules, fullname)) != NULL) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00002293 Py_INCREF(m);
Guido van Rossum7f9fa971995-01-20 16:53:12 +00002294 }
2295 else {
Just van Rossum52e14d62002-12-30 22:08:05 +00002296 PyObject *path, *loader = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002297 char buf[MAXPATHLEN+1];
2298 struct filedescr *fdp;
2299 FILE *fp = NULL;
2300
Guido van Rossum9c0afe51998-05-19 15:09:05 +00002301 if (mod == Py_None)
2302 path = NULL;
2303 else {
2304 path = PyObject_GetAttrString(mod, "__path__");
2305 if (path == NULL) {
2306 PyErr_Clear();
2307 Py_INCREF(Py_None);
2308 return Py_None;
2309 }
2310 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002311
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002312 buf[0] = '\0';
Just van Rossum52e14d62002-12-30 22:08:05 +00002313 fdp = find_module(fullname, subname, path, buf, MAXPATHLEN+1,
2314 &fp, &loader);
Guido van Rossumb68cd421998-07-01 17:36:26 +00002315 Py_XDECREF(path);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002316 if (fdp == NULL) {
2317 if (!PyErr_ExceptionMatches(PyExc_ImportError))
2318 return NULL;
2319 PyErr_Clear();
2320 Py_INCREF(Py_None);
2321 return Py_None;
2322 }
Just van Rossum52e14d62002-12-30 22:08:05 +00002323 m = load_module(fullname, fp, buf, fdp->type, loader);
2324 Py_XDECREF(loader);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002325 if (fp)
2326 fclose(fp);
Neil Schemenauer00b09662003-06-16 21:03:07 +00002327 if (!add_submodule(mod, m, fullname, subname, modules)) {
2328 Py_XDECREF(m);
2329 m = NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002330 }
Guido van Rossum74e6a111994-08-29 12:54:38 +00002331 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002332
2333 return m;
Guido van Rossum74e6a111994-08-29 12:54:38 +00002334}
2335
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002336
2337/* Re-import a module of any kind and return its module object, WITH
2338 INCREMENTED REFERENCE COUNT */
2339
Guido van Rossum79f25d91997-04-29 20:08:16 +00002340PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002341PyImport_ReloadModule(PyObject *m)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002342{
Guido van Rossumd8faa362007-04-27 19:54:29 +00002343 PyInterpreterState *interp = PyThreadState_Get()->interp;
2344 PyObject *modules_reloading = interp->modules_reloading;
Guido van Rossum25ce5661997-08-02 03:10:38 +00002345 PyObject *modules = PyImport_GetModuleDict();
Guido van Rossumd8faa362007-04-27 19:54:29 +00002346 PyObject *path = NULL, *loader = NULL, *existing_m = NULL;
Guido van Rossum222ef561997-09-06 19:41:09 +00002347 char *name, *subname;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002348 char buf[MAXPATHLEN+1];
2349 struct filedescr *fdp;
2350 FILE *fp = NULL;
Tim Peters1cd70172004-08-02 03:52:12 +00002351 PyObject *newm;
Guido van Rossumd8faa362007-04-27 19:54:29 +00002352
2353 if (modules_reloading == NULL) {
2354 Py_FatalError("PyImport_ReloadModule: "
Guido van Rossume7ba4952007-06-06 23:52:48 +00002355 "no modules_reloading dictionary!");
Guido van Rossumd8faa362007-04-27 19:54:29 +00002356 return NULL;
2357 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002358
Guido van Rossum79f25d91997-04-29 20:08:16 +00002359 if (m == NULL || !PyModule_Check(m)) {
2360 PyErr_SetString(PyExc_TypeError,
2361 "reload() argument must be module");
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002362 return NULL;
2363 }
Neal Norwitz5616c6d2007-08-26 05:32:41 +00002364 name = (char*)PyModule_GetName(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002365 if (name == NULL)
2366 return NULL;
Guido van Rossum25ce5661997-08-02 03:10:38 +00002367 if (m != PyDict_GetItemString(modules, name)) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002368 PyErr_Format(PyExc_ImportError,
2369 "reload(): module %.200s not in sys.modules",
2370 name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002371 return NULL;
2372 }
Guido van Rossumd8faa362007-04-27 19:54:29 +00002373 existing_m = PyDict_GetItemString(modules_reloading, name);
2374 if (existing_m != NULL) {
2375 /* Due to a recursive reload, this module is already
2376 being reloaded. */
2377 Py_INCREF(existing_m);
2378 return existing_m;
2379 }
2380 if (PyDict_SetItemString(modules_reloading, name, m) < 0)
2381 return NULL;
2382
Guido van Rossum222ef561997-09-06 19:41:09 +00002383 subname = strrchr(name, '.');
2384 if (subname == NULL)
2385 subname = name;
2386 else {
2387 PyObject *parentname, *parent;
Christian Heimesc4cb3b82007-11-04 12:10:01 +00002388 parentname = PyUnicode_FromStringAndSize(name, (subname-name));
Guido van Rossumd8faa362007-04-27 19:54:29 +00002389 if (parentname == NULL) {
2390 imp_modules_reloading_clear();
Guido van Rossum222ef561997-09-06 19:41:09 +00002391 return NULL;
Guido van Rossumd8faa362007-04-27 19:54:29 +00002392 }
Guido van Rossum222ef561997-09-06 19:41:09 +00002393 parent = PyDict_GetItem(modules, parentname);
2394 if (parent == NULL) {
2395 PyErr_Format(PyExc_ImportError,
2396 "reload(): parent %.200s not in sys.modules",
Christian Heimesc4cb3b82007-11-04 12:10:01 +00002397 PyUnicode_AsString(parentname));
Georg Brandl0c55f292005-09-14 06:56:20 +00002398 Py_DECREF(parentname);
Guido van Rossume7ba4952007-06-06 23:52:48 +00002399 imp_modules_reloading_clear();
Guido van Rossum222ef561997-09-06 19:41:09 +00002400 return NULL;
2401 }
Georg Brandl0c55f292005-09-14 06:56:20 +00002402 Py_DECREF(parentname);
Guido van Rossum222ef561997-09-06 19:41:09 +00002403 subname++;
2404 path = PyObject_GetAttrString(parent, "__path__");
2405 if (path == NULL)
2406 PyErr_Clear();
2407 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002408 buf[0] = '\0';
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00002409 fdp = find_module(name, subname, path, buf, MAXPATHLEN+1, &fp, &loader);
Guido van Rossum222ef561997-09-06 19:41:09 +00002410 Py_XDECREF(path);
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00002411
2412 if (fdp == NULL) {
2413 Py_XDECREF(loader);
Guido van Rossumd8faa362007-04-27 19:54:29 +00002414 imp_modules_reloading_clear();
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002415 return NULL;
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00002416 }
2417
2418 newm = load_module(name, fp, buf, fdp->type, loader);
2419 Py_XDECREF(loader);
2420
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002421 if (fp)
2422 fclose(fp);
Tim Peters1cd70172004-08-02 03:52:12 +00002423 if (newm == NULL) {
2424 /* load_module probably removed name from modules because of
2425 * the error. Put back the original module object. We're
2426 * going to return NULL in this case regardless of whether
2427 * replacing name succeeds, so the return value is ignored.
2428 */
2429 PyDict_SetItemString(modules, name, m);
2430 }
Guido van Rossumd8faa362007-04-27 19:54:29 +00002431 imp_modules_reloading_clear();
Tim Peters1cd70172004-08-02 03:52:12 +00002432 return newm;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002433}
2434
2435
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002436/* Higher-level import emulator which emulates the "import" statement
2437 more accurately -- it invokes the __import__() function from the
2438 builtins of the current globals. This means that the import is
2439 done using whatever import hooks are installed in the current
Guido van Rossum6058eb41998-12-21 19:51:00 +00002440 environment, e.g. by "rexec".
2441 A dummy list ["__doc__"] is passed as the 4th argument so that
Neal Norwitz80e7f272007-08-26 06:45:23 +00002442 e.g. PyImport_Import(PyUnicode_FromString("win32com.client.gencache"))
Guido van Rossum6058eb41998-12-21 19:51:00 +00002443 will return <module "gencache"> instead of <module "win32com">. */
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002444
2445PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002446PyImport_Import(PyObject *module_name)
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002447{
2448 static PyObject *silly_list = NULL;
2449 static PyObject *builtins_str = NULL;
2450 static PyObject *import_str = NULL;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002451 PyObject *globals = NULL;
2452 PyObject *import = NULL;
2453 PyObject *builtins = NULL;
2454 PyObject *r = NULL;
2455
2456 /* Initialize constant string objects */
2457 if (silly_list == NULL) {
Martin v. Löwis5b222132007-06-10 09:51:05 +00002458 import_str = PyUnicode_InternFromString("__import__");
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002459 if (import_str == NULL)
2460 return NULL;
Martin v. Löwis5b222132007-06-10 09:51:05 +00002461 builtins_str = PyUnicode_InternFromString("__builtins__");
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002462 if (builtins_str == NULL)
2463 return NULL;
2464 silly_list = Py_BuildValue("[s]", "__doc__");
2465 if (silly_list == NULL)
2466 return NULL;
2467 }
2468
2469 /* Get the builtins from current globals */
2470 globals = PyEval_GetGlobals();
Guido van Rossum85cd1d62001-02-20 21:43:24 +00002471 if (globals != NULL) {
Guido van Rossum66468561998-10-22 15:46:50 +00002472 Py_INCREF(globals);
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002473 builtins = PyObject_GetItem(globals, builtins_str);
2474 if (builtins == NULL)
2475 goto err;
2476 }
2477 else {
2478 /* No globals -- use standard builtins, and fake globals */
2479 PyErr_Clear();
2480
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002481 builtins = PyImport_ImportModuleLevel("__builtin__",
2482 NULL, NULL, NULL, 0);
Guido van Rossum85cd1d62001-02-20 21:43:24 +00002483 if (builtins == NULL)
2484 return NULL;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002485 globals = Py_BuildValue("{OO}", builtins_str, builtins);
2486 if (globals == NULL)
2487 goto err;
2488 }
2489
2490 /* Get the __import__ function from the builtins */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002491 if (PyDict_Check(builtins)) {
Fred Drakea76ba6e2001-03-06 06:31:15 +00002492 import = PyObject_GetItem(builtins, import_str);
Tim Peters6d6c1a32001-08-02 04:15:00 +00002493 if (import == NULL)
2494 PyErr_SetObject(PyExc_KeyError, import_str);
2495 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002496 else
Fred Drakea76ba6e2001-03-06 06:31:15 +00002497 import = PyObject_GetAttr(builtins, import_str);
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002498 if (import == NULL)
2499 goto err;
2500
Guido van Rossumd8faa362007-04-27 19:54:29 +00002501 /* Call the __import__ function with the proper argument list */
Thomas Wouters477c8d52006-05-27 19:21:47 +00002502 r = PyObject_CallFunctionObjArgs(import, module_name, globals,
2503 globals, silly_list, NULL);
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002504
2505 err:
2506 Py_XDECREF(globals);
2507 Py_XDECREF(builtins);
2508 Py_XDECREF(import);
Tim Peters50d8d372001-02-28 05:34:27 +00002509
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002510 return r;
2511}
2512
2513
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002514/* Module 'imp' provides Python access to the primitives used for
2515 importing modules.
2516*/
2517
Guido van Rossum79f25d91997-04-29 20:08:16 +00002518static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +00002519imp_get_magic(PyObject *self, PyObject *noargs)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002520{
2521 char buf[4];
2522
Guido van Rossum96774c12000-05-01 20:19:08 +00002523 buf[0] = (char) ((pyc_magic >> 0) & 0xff);
2524 buf[1] = (char) ((pyc_magic >> 8) & 0xff);
2525 buf[2] = (char) ((pyc_magic >> 16) & 0xff);
2526 buf[3] = (char) ((pyc_magic >> 24) & 0xff);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002527
Guido van Rossumad8d3002007-08-03 18:40:49 +00002528 return PyBytes_FromStringAndSize(buf, 4);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002529}
2530
Guido van Rossum79f25d91997-04-29 20:08:16 +00002531static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +00002532imp_get_suffixes(PyObject *self, PyObject *noargs)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002533{
Guido van Rossum79f25d91997-04-29 20:08:16 +00002534 PyObject *list;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002535 struct filedescr *fdp;
2536
Guido van Rossum79f25d91997-04-29 20:08:16 +00002537 list = PyList_New(0);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002538 if (list == NULL)
2539 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002540 for (fdp = _PyImport_Filetab; fdp->suffix != NULL; fdp++) {
2541 PyObject *item = Py_BuildValue("ssi",
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002542 fdp->suffix, fdp->mode, fdp->type);
2543 if (item == NULL) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00002544 Py_DECREF(list);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002545 return NULL;
2546 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002547 if (PyList_Append(list, item) < 0) {
2548 Py_DECREF(list);
2549 Py_DECREF(item);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002550 return NULL;
2551 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002552 Py_DECREF(item);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002553 }
2554 return list;
2555}
2556
Guido van Rossum79f25d91997-04-29 20:08:16 +00002557static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002558call_find_module(char *name, PyObject *path)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002559{
Tim Petersdbd9ba62000-07-09 03:09:57 +00002560 extern int fclose(FILE *);
Guido van Rossum79f25d91997-04-29 20:08:16 +00002561 PyObject *fob, *ret;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002562 struct filedescr *fdp;
2563 char pathname[MAXPATHLEN+1];
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002564 FILE *fp = NULL;
Guido van Rossum40d20bc2007-10-22 00:09:51 +00002565 int fd = -1;
Brett Cannon3bb42d92007-10-20 03:43:15 +00002566 char *found_encoding = NULL;
Guido van Rossumce3a72a2007-10-19 23:16:50 +00002567 char *encoding = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002568
2569 pathname[0] = '\0';
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002570 if (path == Py_None)
2571 path = NULL;
Just van Rossum52e14d62002-12-30 22:08:05 +00002572 fdp = find_module(NULL, name, path, pathname, MAXPATHLEN+1, &fp, NULL);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002573 if (fdp == NULL)
2574 return NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002575 if (fp != NULL) {
Guido van Rossum40d20bc2007-10-22 00:09:51 +00002576 fd = fileno(fp);
2577 if (fd != -1)
2578 fd = dup(fd);
2579 fclose(fp);
2580 fp = NULL;
2581 }
2582 if (fd != -1) {
Guido van Rossumce3a72a2007-10-19 23:16:50 +00002583 if (strchr(fdp->mode, 'b') == NULL) {
Brett Cannon3bb42d92007-10-20 03:43:15 +00002584 /* PyTokenizer_FindEncoding() returns PyMem_MALLOC'ed
2585 memory. */
Guido van Rossum40d20bc2007-10-22 00:09:51 +00002586 found_encoding = PyTokenizer_FindEncoding(fd);
2587 lseek(fd, 0, 0); /* Reset position */
Brett Cannon3bb42d92007-10-20 03:43:15 +00002588 encoding = (found_encoding != NULL) ? found_encoding :
Guido van Rossumce3a72a2007-10-19 23:16:50 +00002589 (char*)PyUnicode_GetDefaultEncoding();
2590 }
Guido van Rossum40d20bc2007-10-22 00:09:51 +00002591 fob = PyFile_FromFd(fd, pathname, fdp->mode, -1,
Guido van Rossum2dced8b2007-10-30 17:27:30 +00002592 (char*)encoding, NULL, 1);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002593 if (fob == NULL) {
Guido van Rossum40d20bc2007-10-22 00:09:51 +00002594 close(fd);
Brett Cannon3bb42d92007-10-20 03:43:15 +00002595 PyMem_FREE(found_encoding);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002596 return NULL;
2597 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002598 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002599 else {
2600 fob = Py_None;
2601 Py_INCREF(fob);
Tim Peters50d8d372001-02-28 05:34:27 +00002602 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002603 ret = Py_BuildValue("Os(ssi)",
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002604 fob, pathname, fdp->suffix, fdp->mode, fdp->type);
Guido van Rossum79f25d91997-04-29 20:08:16 +00002605 Py_DECREF(fob);
Brett Cannon3bb42d92007-10-20 03:43:15 +00002606 PyMem_FREE(found_encoding);
2607
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002608 return ret;
2609}
2610
Guido van Rossum79f25d91997-04-29 20:08:16 +00002611static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002612imp_find_module(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002613{
2614 char *name;
2615 PyObject *path = NULL;
Guido van Rossum43713e52000-02-29 13:59:29 +00002616 if (!PyArg_ParseTuple(args, "s|O:find_module", &name, &path))
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002617 return NULL;
2618 return call_find_module(name, path);
2619}
2620
2621static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002622imp_init_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002623{
2624 char *name;
2625 int ret;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002626 PyObject *m;
Guido van Rossum43713e52000-02-29 13:59:29 +00002627 if (!PyArg_ParseTuple(args, "s:init_builtin", &name))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002628 return NULL;
2629 ret = init_builtin(name);
2630 if (ret < 0)
2631 return NULL;
2632 if (ret == 0) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00002633 Py_INCREF(Py_None);
2634 return Py_None;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002635 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002636 m = PyImport_AddModule(name);
2637 Py_XINCREF(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002638 return m;
2639}
2640
Guido van Rossum79f25d91997-04-29 20:08:16 +00002641static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002642imp_init_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002643{
2644 char *name;
2645 int ret;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002646 PyObject *m;
Guido van Rossum43713e52000-02-29 13:59:29 +00002647 if (!PyArg_ParseTuple(args, "s:init_frozen", &name))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002648 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002649 ret = PyImport_ImportFrozenModule(name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002650 if (ret < 0)
2651 return NULL;
2652 if (ret == 0) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00002653 Py_INCREF(Py_None);
2654 return Py_None;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002655 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002656 m = PyImport_AddModule(name);
2657 Py_XINCREF(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002658 return m;
2659}
2660
Guido van Rossum79f25d91997-04-29 20:08:16 +00002661static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002662imp_get_frozen_object(PyObject *self, PyObject *args)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002663{
2664 char *name;
Jack Jansen95ffa231995-10-03 14:38:41 +00002665
Guido van Rossum43713e52000-02-29 13:59:29 +00002666 if (!PyArg_ParseTuple(args, "s:get_frozen_object", &name))
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002667 return NULL;
2668 return get_frozen_object(name);
2669}
2670
Guido van Rossum79f25d91997-04-29 20:08:16 +00002671static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002672imp_is_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002673{
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002674 char *name;
Guido van Rossum43713e52000-02-29 13:59:29 +00002675 if (!PyArg_ParseTuple(args, "s:is_builtin", &name))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002676 return NULL;
Guido van Rossum50ee94f2002-04-09 18:00:58 +00002677 return PyInt_FromLong(is_builtin(name));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002678}
2679
Guido van Rossum79f25d91997-04-29 20:08:16 +00002680static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002681imp_is_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002682{
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002683 char *name;
Guido van Rossum323bf5e1998-06-24 03:54:06 +00002684 struct _frozen *p;
Guido van Rossum43713e52000-02-29 13:59:29 +00002685 if (!PyArg_ParseTuple(args, "s:is_frozen", &name))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002686 return NULL;
Guido van Rossum323bf5e1998-06-24 03:54:06 +00002687 p = find_frozen(name);
Guido van Rossumb8bff3f2002-04-07 06:34:38 +00002688 return PyBool_FromLong((long) (p == NULL ? 0 : p->size));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002689}
2690
2691static FILE *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002692get_file(char *pathname, PyObject *fob, char *mode)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002693{
2694 FILE *fp;
Guido van Rossumda5b8f22007-06-12 23:30:11 +00002695 if (mode[0] == 'U')
2696 mode = "r" PY_STDIOTEXTMODE;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002697 if (fob == NULL) {
2698 fp = fopen(pathname, mode);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002699 }
2700 else {
Guido van Rossumda5b8f22007-06-12 23:30:11 +00002701 int fd = PyObject_AsFileDescriptor(fob);
2702 if (fd == -1)
2703 return NULL;
2704 /* XXX This will leak a FILE struct. Fix this!!!!
2705 (But it doesn't leak a file descrioptor!) */
2706 fp = fdopen(fd, mode);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002707 }
Guido van Rossumda5b8f22007-06-12 23:30:11 +00002708 if (fp == NULL)
2709 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002710 return fp;
2711}
2712
Guido van Rossum79f25d91997-04-29 20:08:16 +00002713static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002714imp_load_compiled(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002715{
2716 char *name;
2717 char *pathname;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002718 PyObject *fob = NULL;
2719 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002720 FILE *fp;
Guido van Rossumda5b8f22007-06-12 23:30:11 +00002721 if (!PyArg_ParseTuple(args, "ss|O:load_compiled",
2722 &name, &pathname, &fob))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002723 return NULL;
2724 fp = get_file(pathname, fob, "rb");
2725 if (fp == NULL)
2726 return NULL;
2727 m = load_compiled_module(name, pathname, fp);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002728 if (fob == NULL)
2729 fclose(fp);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002730 return m;
2731}
2732
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002733#ifdef HAVE_DYNAMIC_LOADING
2734
Guido van Rossum79f25d91997-04-29 20:08:16 +00002735static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002736imp_load_dynamic(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002737{
2738 char *name;
2739 char *pathname;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002740 PyObject *fob = NULL;
2741 PyObject *m;
Guido van Rossum7faeab31995-07-07 22:50:36 +00002742 FILE *fp = NULL;
Guido van Rossumda5b8f22007-06-12 23:30:11 +00002743 if (!PyArg_ParseTuple(args, "ss|O:load_dynamic",
2744 &name, &pathname, &fob))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002745 return NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002746 if (fob) {
Guido van Rossum7faeab31995-07-07 22:50:36 +00002747 fp = get_file(pathname, fob, "r");
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002748 if (fp == NULL)
2749 return NULL;
2750 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002751 m = _PyImport_LoadDynamicModule(name, pathname, fp);
Guido van Rossum7faeab31995-07-07 22:50:36 +00002752 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002753}
2754
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002755#endif /* HAVE_DYNAMIC_LOADING */
2756
Guido van Rossum79f25d91997-04-29 20:08:16 +00002757static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002758imp_load_source(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002759{
2760 char *name;
2761 char *pathname;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002762 PyObject *fob = NULL;
2763 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002764 FILE *fp;
Guido van Rossumda5b8f22007-06-12 23:30:11 +00002765 if (!PyArg_ParseTuple(args, "ss|O:load_source",
2766 &name, &pathname, &fob))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002767 return NULL;
2768 fp = get_file(pathname, fob, "r");
2769 if (fp == NULL)
2770 return NULL;
2771 m = load_source_module(name, pathname, fp);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002772 if (fob == NULL)
2773 fclose(fp);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002774 return m;
2775}
2776
Guido van Rossum79f25d91997-04-29 20:08:16 +00002777static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002778imp_load_module(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002779{
2780 char *name;
2781 PyObject *fob;
2782 char *pathname;
2783 char *suffix; /* Unused */
2784 char *mode;
2785 int type;
2786 FILE *fp;
2787
Guido van Rossum43713e52000-02-29 13:59:29 +00002788 if (!PyArg_ParseTuple(args, "sOs(ssi):load_module",
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002789 &name, &fob, &pathname,
2790 &suffix, &mode, &type))
2791 return NULL;
Guido van Rossum5e2c5fa2002-05-30 17:33:07 +00002792 if (*mode) {
2793 /* Mode must start with 'r' or 'U' and must not contain '+'.
2794 Implicit in this test is the assumption that the mode
2795 may contain other modifiers like 'b' or 't'. */
2796
2797 if (!(*mode == 'r' || *mode == 'U') || strchr(mode, '+')) {
Jeremy Hylton4ae6fae2002-05-30 17:15:25 +00002798 PyErr_Format(PyExc_ValueError,
2799 "invalid file open mode %.200s", mode);
2800 return NULL;
Guido van Rossum5e2c5fa2002-05-30 17:33:07 +00002801 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002802 }
2803 if (fob == Py_None)
2804 fp = NULL;
2805 else {
Guido van Rossumda5b8f22007-06-12 23:30:11 +00002806 fp = get_file(NULL, fob, mode);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002807 if (fp == NULL)
2808 return NULL;
2809 }
Just van Rossum52e14d62002-12-30 22:08:05 +00002810 return load_module(name, fp, pathname, type, NULL);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002811}
2812
2813static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002814imp_load_package(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002815{
2816 char *name;
2817 char *pathname;
Guido van Rossum43713e52000-02-29 13:59:29 +00002818 if (!PyArg_ParseTuple(args, "ss:load_package", &name, &pathname))
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002819 return NULL;
2820 return load_package(name, pathname);
2821}
2822
2823static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002824imp_new_module(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002825{
2826 char *name;
Guido van Rossum43713e52000-02-29 13:59:29 +00002827 if (!PyArg_ParseTuple(args, "s:new_module", &name))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002828 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002829 return PyModule_New(name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002830}
2831
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002832/* Doc strings */
2833
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002834PyDoc_STRVAR(doc_imp,
2835"This module provides the components needed to build your own\n\
2836__import__ function. Undocumented functions are obsolete.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002837
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002838PyDoc_STRVAR(doc_find_module,
2839"find_module(name, [path]) -> (file, filename, (suffix, mode, type))\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002840Search for a module. If path is omitted or None, search for a\n\
2841built-in, frozen or special module and continue search in sys.path.\n\
2842The module name cannot contain '.'; to search for a submodule of a\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002843package, pass the submodule name and the package's __path__.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002844
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002845PyDoc_STRVAR(doc_load_module,
2846"load_module(name, file, filename, (suffix, mode, type)) -> module\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002847Load a module, given information returned by find_module().\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002848The module name must include the full package name, if any.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002849
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002850PyDoc_STRVAR(doc_get_magic,
2851"get_magic() -> string\n\
2852Return the magic number for .pyc or .pyo files.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002853
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002854PyDoc_STRVAR(doc_get_suffixes,
2855"get_suffixes() -> [(suffix, mode, type), ...]\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002856Return a list of (suffix, mode, type) tuples describing the files\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002857that find_module() looks for.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002858
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002859PyDoc_STRVAR(doc_new_module,
2860"new_module(name) -> module\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002861Create a new module. Do not enter it in sys.modules.\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002862The module name must include the full package name, if any.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002863
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002864PyDoc_STRVAR(doc_lock_held,
Tim Petersa7c65092004-08-01 23:26:05 +00002865"lock_held() -> boolean\n\
2866Return True if the import lock is currently held, else False.\n\
2867On platforms without threads, return False.");
Tim Peters69232342001-08-30 05:16:13 +00002868
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00002869PyDoc_STRVAR(doc_acquire_lock,
2870"acquire_lock() -> None\n\
Neal Norwitz2294c0d2003-02-12 23:02:21 +00002871Acquires the interpreter's import lock for the current thread.\n\
2872This lock should be used by import hooks to ensure thread-safety\n\
2873when importing modules.\n\
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00002874On platforms without threads, this function does nothing.");
2875
2876PyDoc_STRVAR(doc_release_lock,
2877"release_lock() -> None\n\
2878Release the interpreter's import lock.\n\
2879On platforms without threads, this function does nothing.");
2880
Guido van Rossum79f25d91997-04-29 20:08:16 +00002881static PyMethodDef imp_methods[] = {
Neal Norwitz08ea61a2003-02-17 18:18:00 +00002882 {"find_module", imp_find_module, METH_VARARGS, doc_find_module},
2883 {"get_magic", imp_get_magic, METH_NOARGS, doc_get_magic},
2884 {"get_suffixes", imp_get_suffixes, METH_NOARGS, doc_get_suffixes},
2885 {"load_module", imp_load_module, METH_VARARGS, doc_load_module},
2886 {"new_module", imp_new_module, METH_VARARGS, doc_new_module},
2887 {"lock_held", imp_lock_held, METH_NOARGS, doc_lock_held},
2888 {"acquire_lock", imp_acquire_lock, METH_NOARGS, doc_acquire_lock},
2889 {"release_lock", imp_release_lock, METH_NOARGS, doc_release_lock},
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002890 /* The rest are obsolete */
Neal Norwitz031829d2002-03-31 14:37:44 +00002891 {"get_frozen_object", imp_get_frozen_object, METH_VARARGS},
2892 {"init_builtin", imp_init_builtin, METH_VARARGS},
2893 {"init_frozen", imp_init_frozen, METH_VARARGS},
2894 {"is_builtin", imp_is_builtin, METH_VARARGS},
2895 {"is_frozen", imp_is_frozen, METH_VARARGS},
2896 {"load_compiled", imp_load_compiled, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002897#ifdef HAVE_DYNAMIC_LOADING
Neal Norwitz031829d2002-03-31 14:37:44 +00002898 {"load_dynamic", imp_load_dynamic, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002899#endif
Neal Norwitz031829d2002-03-31 14:37:44 +00002900 {"load_package", imp_load_package, METH_VARARGS},
Neal Norwitz031829d2002-03-31 14:37:44 +00002901 {"load_source", imp_load_source, METH_VARARGS},
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002902 {NULL, NULL} /* sentinel */
2903};
2904
Guido van Rossum1a8791e1998-08-04 22:46:29 +00002905static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002906setint(PyObject *d, char *name, int value)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002907{
2908 PyObject *v;
2909 int err;
2910
2911 v = PyInt_FromLong((long)value);
2912 err = PyDict_SetItemString(d, name, v);
2913 Py_XDECREF(v);
2914 return err;
2915}
2916
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002917typedef struct {
2918 PyObject_HEAD
2919} NullImporter;
2920
2921static int
2922NullImporter_init(NullImporter *self, PyObject *args, PyObject *kwds)
2923{
2924 char *path;
Christian Heimes7d3bc0a2007-11-07 17:26:16 +00002925 Py_ssize_t pathlen;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002926
2927 if (!_PyArg_NoKeywords("NullImporter()", kwds))
2928 return -1;
2929
2930 if (!PyArg_ParseTuple(args, "s:NullImporter",
2931 &path))
2932 return -1;
2933
Christian Heimes7d3bc0a2007-11-07 17:26:16 +00002934 pathlen = strlen(path);
2935 if (pathlen == 0) {
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002936 PyErr_SetString(PyExc_ImportError, "empty pathname");
2937 return -1;
2938 } else {
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002939 struct stat statbuf;
2940 int rv;
2941
2942 rv = stat(path, &statbuf);
Guido van Rossumc1bdbc32007-11-07 17:46:34 +00002943#ifdef MS_WINDOWS
2944 /* MS Windows stat() chokes on paths like C:\path\. Try to
2945 * recover *one* time by stripping off a trailing slash or
2946 * backslash. http://bugs.python.org/issue1293
2947 */
Christian Heimes7d3bc0a2007-11-07 17:26:16 +00002948 if (rv != 0 && pathlen <= MAXPATHLEN &&
2949 (path[pathlen-1] == '/' || path[pathlen-1] == '\\')) {
2950 char mangled[MAXPATHLEN+1];
2951
2952 strcpy(mangled, path);
2953 mangled[pathlen-1] = '\0';
2954 rv = stat(mangled, &statbuf);
2955 }
Christian Heimes7d3bc0a2007-11-07 17:26:16 +00002956#endif
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002957 if (rv == 0) {
2958 /* it exists */
2959 if (S_ISDIR(statbuf.st_mode)) {
2960 /* it's a directory */
2961 PyErr_SetString(PyExc_ImportError,
2962 "existing directory");
2963 return -1;
2964 }
2965 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002966 }
2967 return 0;
2968}
2969
2970static PyObject *
2971NullImporter_find_module(NullImporter *self, PyObject *args)
2972{
2973 Py_RETURN_NONE;
2974}
2975
2976static PyMethodDef NullImporter_methods[] = {
2977 {"find_module", (PyCFunction)NullImporter_find_module, METH_VARARGS,
2978 "Always return None"
2979 },
2980 {NULL} /* Sentinel */
2981};
2982
2983
2984static PyTypeObject NullImporterType = {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00002985 PyVarObject_HEAD_INIT(NULL, 0)
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002986 "imp.NullImporter", /*tp_name*/
2987 sizeof(NullImporter), /*tp_basicsize*/
2988 0, /*tp_itemsize*/
2989 0, /*tp_dealloc*/
2990 0, /*tp_print*/
2991 0, /*tp_getattr*/
2992 0, /*tp_setattr*/
2993 0, /*tp_compare*/
2994 0, /*tp_repr*/
2995 0, /*tp_as_number*/
2996 0, /*tp_as_sequence*/
2997 0, /*tp_as_mapping*/
2998 0, /*tp_hash */
2999 0, /*tp_call*/
3000 0, /*tp_str*/
3001 0, /*tp_getattro*/
3002 0, /*tp_setattro*/
3003 0, /*tp_as_buffer*/
3004 Py_TPFLAGS_DEFAULT, /*tp_flags*/
3005 "Null importer object", /* tp_doc */
3006 0, /* tp_traverse */
3007 0, /* tp_clear */
3008 0, /* tp_richcompare */
3009 0, /* tp_weaklistoffset */
3010 0, /* tp_iter */
3011 0, /* tp_iternext */
3012 NullImporter_methods, /* tp_methods */
3013 0, /* tp_members */
3014 0, /* tp_getset */
3015 0, /* tp_base */
3016 0, /* tp_dict */
3017 0, /* tp_descr_get */
3018 0, /* tp_descr_set */
3019 0, /* tp_dictoffset */
3020 (initproc)NullImporter_init, /* tp_init */
3021 0, /* tp_alloc */
3022 PyType_GenericNew /* tp_new */
3023};
3024
3025
Jason Tishler6bc06ec2003-09-04 11:59:50 +00003026PyMODINIT_FUNC
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003027initimp(void)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003028{
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003029 PyObject *m, *d;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003030
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003031 if (PyType_Ready(&NullImporterType) < 0)
3032 goto failure;
3033
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003034 m = Py_InitModule4("imp", imp_methods, doc_imp,
3035 NULL, PYTHON_API_VERSION);
Neal Norwitz1ac754f2006-01-19 06:09:39 +00003036 if (m == NULL)
3037 goto failure;
Guido van Rossum79f25d91997-04-29 20:08:16 +00003038 d = PyModule_GetDict(m);
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00003039 if (d == NULL)
3040 goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003041
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003042 if (setint(d, "SEARCH_ERROR", SEARCH_ERROR) < 0) goto failure;
3043 if (setint(d, "PY_SOURCE", PY_SOURCE) < 0) goto failure;
3044 if (setint(d, "PY_COMPILED", PY_COMPILED) < 0) goto failure;
3045 if (setint(d, "C_EXTENSION", C_EXTENSION) < 0) goto failure;
3046 if (setint(d, "PY_RESOURCE", PY_RESOURCE) < 0) goto failure;
3047 if (setint(d, "PKG_DIRECTORY", PKG_DIRECTORY) < 0) goto failure;
3048 if (setint(d, "C_BUILTIN", C_BUILTIN) < 0) goto failure;
3049 if (setint(d, "PY_FROZEN", PY_FROZEN) < 0) goto failure;
Guido van Rossum0f84a341998-08-06 13:36:01 +00003050 if (setint(d, "PY_CODERESOURCE", PY_CODERESOURCE) < 0) goto failure;
Just van Rossum52e14d62002-12-30 22:08:05 +00003051 if (setint(d, "IMP_HOOK", IMP_HOOK) < 0) goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003052
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003053 Py_INCREF(&NullImporterType);
3054 PyModule_AddObject(m, "NullImporter", (PyObject *)&NullImporterType);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003055 failure:
3056 ;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003057}
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003058
3059
Guido van Rossumb18618d2000-05-03 23:44:39 +00003060/* API for embedding applications that want to add their own entries
3061 to the table of built-in modules. This should normally be called
3062 *before* Py_Initialize(). When the table resize fails, -1 is
3063 returned and the existing table is unchanged.
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003064
3065 After a similar function by Just van Rossum. */
3066
3067int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003068PyImport_ExtendInittab(struct _inittab *newtab)
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003069{
3070 static struct _inittab *our_copy = NULL;
3071 struct _inittab *p;
3072 int i, n;
3073
3074 /* Count the number of entries in both tables */
3075 for (n = 0; newtab[n].name != NULL; n++)
3076 ;
3077 if (n == 0)
3078 return 0; /* Nothing to do */
3079 for (i = 0; PyImport_Inittab[i].name != NULL; i++)
3080 ;
3081
3082 /* Allocate new memory for the combined table */
Guido van Rossumb18618d2000-05-03 23:44:39 +00003083 p = our_copy;
3084 PyMem_RESIZE(p, struct _inittab, i+n+1);
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003085 if (p == NULL)
3086 return -1;
3087
3088 /* Copy the tables into the new memory */
3089 if (our_copy != PyImport_Inittab)
3090 memcpy(p, PyImport_Inittab, (i+1) * sizeof(struct _inittab));
3091 PyImport_Inittab = our_copy = p;
3092 memcpy(p+i, newtab, (n+1) * sizeof(struct _inittab));
3093
3094 return 0;
3095}
3096
3097/* Shorthand to add a single entry given a name and a function */
3098
3099int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003100PyImport_AppendInittab(char *name, void (*initfunc)(void))
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003101{
3102 struct _inittab newtab[2];
3103
3104 memset(newtab, '\0', sizeof newtab);
3105
3106 newtab[0].name = name;
3107 newtab[0].initfunc = initfunc;
3108
3109 return PyImport_ExtendInittab(newtab);
3110}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00003111
3112#ifdef __cplusplus
3113}
3114#endif