blob: 323b55a540e1e1ebf05915f2aedc08365d705b71 [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)
Michael W. Hudsonaee2e282005-10-21 11:32:20 +000079.
Tim Peters36515e22001-11-18 04:06:29 +000080*/
Guido van Rossum00bc0e02007-10-15 02:52:41 +000081#define MAGIC (3080 | ((long)'\r'<<16) | ((long)'\n'<<24))
Guido van Rossum3ddee711991-12-16 13:06:34 +000082
Guido van Rossum96774c12000-05-01 20:19:08 +000083/* Magic word as global; note that _PyImport_Init() can change the
Jeremy Hylton9262b8a2000-06-30 04:59:17 +000084 value of this global to accommodate for alterations of how the
Guido van Rossum96774c12000-05-01 20:19:08 +000085 compiler works which are enabled by command line switches. */
86static long pyc_magic = MAGIC;
87
Guido van Rossum25ce5661997-08-02 03:10:38 +000088/* See _PyImport_FixupExtension() below */
89static PyObject *extensions = NULL;
Guido van Rossum3f5da241990-12-20 15:06:42 +000090
Guido van Rossum771c6c81997-10-31 18:37:24 +000091/* This table is defined in config.c: */
92extern struct _inittab _PyImport_Inittab[];
93
Guido van Rossumce3a72a2007-10-19 23:16:50 +000094/* Method from Parser/tokenizer.c */
95extern char * PyTokenizer_FindEncoding(FILE *fp);
96
Guido van Rossum771c6c81997-10-31 18:37:24 +000097struct _inittab *PyImport_Inittab = _PyImport_Inittab;
Guido van Rossum66f1fa81991-04-03 19:03:52 +000098
Guido van Rossumed1170e1999-12-20 21:23:41 +000099/* these tables define the module suffixes that Python recognizes */
100struct filedescr * _PyImport_Filetab = NULL;
Guido van Rossum48a680c2001-03-02 06:34:14 +0000101
Guido van Rossumed1170e1999-12-20 21:23:41 +0000102static const struct filedescr _PyImport_StandardFiletab[] = {
Jack Jansenc88da1f2002-05-28 10:58:19 +0000103 {".py", "U", PY_SOURCE},
Martin v. Löwis6238d2b2002-06-30 15:26:10 +0000104#ifdef MS_WINDOWS
Jack Jansenc88da1f2002-05-28 10:58:19 +0000105 {".pyw", "U", PY_SOURCE},
Tim Peters36515e22001-11-18 04:06:29 +0000106#endif
Guido van Rossumed1170e1999-12-20 21:23:41 +0000107 {".pyc", "rb", PY_COMPILED},
108 {0, 0}
109};
110
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000111static PyTypeObject NullImporterType; /* Forward reference */
112
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000113/* Initialize things */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000114
115void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000116_PyImport_Init(void)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000117{
Guido van Rossumed1170e1999-12-20 21:23:41 +0000118 const struct filedescr *scan;
119 struct filedescr *filetab;
120 int countD = 0;
121 int countS = 0;
122
123 /* prepare _PyImport_Filetab: copy entries from
124 _PyImport_DynLoadFiletab and _PyImport_StandardFiletab.
125 */
Guido van Rossum04110fb2007-08-24 16:32:05 +0000126#ifdef HAVE_DYNAMIC_LOADING
Guido van Rossumed1170e1999-12-20 21:23:41 +0000127 for (scan = _PyImport_DynLoadFiletab; scan->suffix != NULL; ++scan)
128 ++countD;
Guido van Rossum04110fb2007-08-24 16:32:05 +0000129#endif
Guido van Rossumed1170e1999-12-20 21:23:41 +0000130 for (scan = _PyImport_StandardFiletab; scan->suffix != NULL; ++scan)
131 ++countS;
Guido van Rossumb18618d2000-05-03 23:44:39 +0000132 filetab = PyMem_NEW(struct filedescr, countD + countS + 1);
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000133 if (filetab == NULL)
134 Py_FatalError("Can't initialize import file table.");
Guido van Rossum04110fb2007-08-24 16:32:05 +0000135#ifdef HAVE_DYNAMIC_LOADING
Guido van Rossumed1170e1999-12-20 21:23:41 +0000136 memcpy(filetab, _PyImport_DynLoadFiletab,
137 countD * sizeof(struct filedescr));
Guido van Rossum04110fb2007-08-24 16:32:05 +0000138#endif
Guido van Rossumed1170e1999-12-20 21:23:41 +0000139 memcpy(filetab + countD, _PyImport_StandardFiletab,
140 countS * sizeof(struct filedescr));
141 filetab[countD + countS].suffix = NULL;
142
143 _PyImport_Filetab = filetab;
144
Guido van Rossum0824f631997-03-11 18:37:35 +0000145 if (Py_OptimizeFlag) {
Guido van Rossumed1170e1999-12-20 21:23:41 +0000146 /* Replace ".pyc" with ".pyo" in _PyImport_Filetab */
147 for (; filetab->suffix != NULL; filetab++) {
148 if (strcmp(filetab->suffix, ".pyc") == 0)
149 filetab->suffix = ".pyo";
Guido van Rossum0824f631997-03-11 18:37:35 +0000150 }
151 }
Guido van Rossum96774c12000-05-01 20:19:08 +0000152
Guido van Rossum572dbf82007-04-27 23:53:51 +0000153 {
Guido van Rossum96774c12000-05-01 20:19:08 +0000154 /* Fix the pyc_magic so that byte compiled code created
155 using the all-Unicode method doesn't interfere with
156 code created in normal operation mode. */
157 pyc_magic = MAGIC + 1;
158 }
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000159}
160
Guido van Rossum25ce5661997-08-02 03:10:38 +0000161void
Just van Rossum52e14d62002-12-30 22:08:05 +0000162_PyImportHooks_Init(void)
163{
164 PyObject *v, *path_hooks = NULL, *zimpimport;
165 int err = 0;
166
167 /* adding sys.path_hooks and sys.path_importer_cache, setting up
168 zipimport */
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000169 if (PyType_Ready(&NullImporterType) < 0)
170 goto error;
Just van Rossum52e14d62002-12-30 22:08:05 +0000171
172 if (Py_VerboseFlag)
173 PySys_WriteStderr("# installing zipimport hook\n");
174
175 v = PyList_New(0);
176 if (v == NULL)
177 goto error;
178 err = PySys_SetObject("meta_path", v);
179 Py_DECREF(v);
180 if (err)
181 goto error;
182 v = PyDict_New();
183 if (v == NULL)
184 goto error;
185 err = PySys_SetObject("path_importer_cache", v);
186 Py_DECREF(v);
187 if (err)
188 goto error;
189 path_hooks = PyList_New(0);
190 if (path_hooks == NULL)
191 goto error;
192 err = PySys_SetObject("path_hooks", path_hooks);
193 if (err) {
194 error:
195 PyErr_Print();
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000196 Py_FatalError("initializing sys.meta_path, sys.path_hooks, "
197 "path_importer_cache, or NullImporter failed"
198 );
Just van Rossum52e14d62002-12-30 22:08:05 +0000199 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000200
Just van Rossum52e14d62002-12-30 22:08:05 +0000201 zimpimport = PyImport_ImportModule("zipimport");
202 if (zimpimport == NULL) {
203 PyErr_Clear(); /* No zip import module -- okay */
204 if (Py_VerboseFlag)
205 PySys_WriteStderr("# can't import zipimport\n");
206 }
207 else {
208 PyObject *zipimporter = PyObject_GetAttrString(zimpimport,
209 "zipimporter");
210 Py_DECREF(zimpimport);
211 if (zipimporter == NULL) {
212 PyErr_Clear(); /* No zipimporter object -- okay */
213 if (Py_VerboseFlag)
214 PySys_WriteStderr(
Fred Drake1e5fc552003-07-11 15:01:02 +0000215 "# can't import zipimport.zipimporter\n");
Just van Rossum52e14d62002-12-30 22:08:05 +0000216 }
217 else {
218 /* sys.path_hooks.append(zipimporter) */
219 err = PyList_Append(path_hooks, zipimporter);
220 Py_DECREF(zipimporter);
221 if (err)
222 goto error;
223 if (Py_VerboseFlag)
224 PySys_WriteStderr(
225 "# installed zipimport hook\n");
226 }
227 }
228 Py_DECREF(path_hooks);
229}
230
231void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000232_PyImport_Fini(void)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000233{
234 Py_XDECREF(extensions);
235 extensions = NULL;
Barry Warsaw84294482000-10-03 16:02:05 +0000236 PyMem_DEL(_PyImport_Filetab);
237 _PyImport_Filetab = NULL;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000238}
239
240
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000241/* Locking primitives to prevent parallel imports of the same module
242 in different threads to return with a partially loaded module.
243 These calls are serialized by the global interpreter lock. */
244
245#ifdef WITH_THREAD
246
Guido van Rossum49b56061998-10-01 20:42:43 +0000247#include "pythread.h"
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000248
Guido van Rossum65d5b571998-12-21 19:32:43 +0000249static PyThread_type_lock import_lock = 0;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000250static long import_lock_thread = -1;
251static int import_lock_level = 0;
252
253static void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000254lock_import(void)
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000255{
Guido van Rossum65d5b571998-12-21 19:32:43 +0000256 long me = PyThread_get_thread_ident();
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000257 if (me == -1)
258 return; /* Too bad */
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000259 if (import_lock == NULL) {
Guido van Rossum65d5b571998-12-21 19:32:43 +0000260 import_lock = PyThread_allocate_lock();
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000261 if (import_lock == NULL)
262 return; /* Nothing much we can do. */
263 }
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000264 if (import_lock_thread == me) {
265 import_lock_level++;
266 return;
267 }
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000268 if (import_lock_thread != -1 || !PyThread_acquire_lock(import_lock, 0))
269 {
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000270 PyThreadState *tstate = PyEval_SaveThread();
Guido van Rossum65d5b571998-12-21 19:32:43 +0000271 PyThread_acquire_lock(import_lock, 1);
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000272 PyEval_RestoreThread(tstate);
273 }
274 import_lock_thread = me;
275 import_lock_level = 1;
276}
277
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000278static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000279unlock_import(void)
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000280{
Guido van Rossum65d5b571998-12-21 19:32:43 +0000281 long me = PyThread_get_thread_ident();
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000282 if (me == -1 || import_lock == NULL)
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000283 return 0; /* Too bad */
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000284 if (import_lock_thread != me)
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000285 return -1;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000286 import_lock_level--;
287 if (import_lock_level == 0) {
288 import_lock_thread = -1;
Guido van Rossum65d5b571998-12-21 19:32:43 +0000289 PyThread_release_lock(import_lock);
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000290 }
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000291 return 1;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000292}
293
Guido van Rossum8ee3e5a2005-09-14 18:09:42 +0000294/* This function is called from PyOS_AfterFork to ensure that newly
295 created child processes do not share locks with the parent. */
296
297void
298_PyImport_ReInitLock(void)
299{
300#ifdef _AIX
301 if (import_lock != NULL)
302 import_lock = PyThread_allocate_lock();
303#endif
304}
305
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000306#else
307
308#define lock_import()
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000309#define unlock_import() 0
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000310
311#endif
312
Tim Peters69232342001-08-30 05:16:13 +0000313static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000314imp_lock_held(PyObject *self, PyObject *noargs)
Tim Peters69232342001-08-30 05:16:13 +0000315{
Tim Peters69232342001-08-30 05:16:13 +0000316#ifdef WITH_THREAD
Guido van Rossumb8bff3f2002-04-07 06:34:38 +0000317 return PyBool_FromLong(import_lock_thread != -1);
Tim Peters69232342001-08-30 05:16:13 +0000318#else
Guido van Rossumb8bff3f2002-04-07 06:34:38 +0000319 return PyBool_FromLong(0);
Tim Peters69232342001-08-30 05:16:13 +0000320#endif
321}
322
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000323static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000324imp_acquire_lock(PyObject *self, PyObject *noargs)
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000325{
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000326#ifdef WITH_THREAD
327 lock_import();
328#endif
Neal Norwitz2294c0d2003-02-12 23:02:21 +0000329 Py_INCREF(Py_None);
330 return Py_None;
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000331}
332
333static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000334imp_release_lock(PyObject *self, PyObject *noargs)
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000335{
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000336#ifdef WITH_THREAD
337 if (unlock_import() < 0) {
338 PyErr_SetString(PyExc_RuntimeError,
339 "not holding the import lock");
340 return NULL;
341 }
342#endif
Neal Norwitz2294c0d2003-02-12 23:02:21 +0000343 Py_INCREF(Py_None);
344 return Py_None;
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000345}
346
Guido van Rossumd8faa362007-04-27 19:54:29 +0000347static void
348imp_modules_reloading_clear(void)
349{
350 PyInterpreterState *interp = PyThreadState_Get()->interp;
351 if (interp->modules_reloading != NULL)
352 PyDict_Clear(interp->modules_reloading);
353}
354
Guido van Rossum25ce5661997-08-02 03:10:38 +0000355/* Helper for sys */
356
357PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000358PyImport_GetModuleDict(void)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000359{
Nicholas Bastine5662ae2004-03-24 22:22:12 +0000360 PyInterpreterState *interp = PyThreadState_GET()->interp;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000361 if (interp->modules == NULL)
362 Py_FatalError("PyImport_GetModuleDict: no module dictionary!");
363 return interp->modules;
364}
365
Guido van Rossum3f5da241990-12-20 15:06:42 +0000366
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000367/* List of names to clear in sys */
368static char* sys_deletes[] = {
Collin Winter670e6922007-03-21 02:57:17 +0000369 "path", "argv", "ps1", "ps2",
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000370 "last_type", "last_value", "last_traceback",
Just van Rossum52e14d62002-12-30 22:08:05 +0000371 "path_hooks", "path_importer_cache", "meta_path",
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000372 NULL
373};
374
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000375static char* sys_files[] = {
376 "stdin", "__stdin__",
377 "stdout", "__stdout__",
378 "stderr", "__stderr__",
379 NULL
380};
381
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000382
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000383/* Un-initialize things, as good as we can */
Guido van Rossum3f5da241990-12-20 15:06:42 +0000384
Guido van Rossum3f5da241990-12-20 15:06:42 +0000385void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000386PyImport_Cleanup(void)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000387{
Martin v. Löwis18e16552006-02-15 17:27:45 +0000388 Py_ssize_t pos, ndone;
Guido van Rossum758eec01998-01-19 21:58:26 +0000389 char *name;
390 PyObject *key, *value, *dict;
Nicholas Bastine5662ae2004-03-24 22:22:12 +0000391 PyInterpreterState *interp = PyThreadState_GET()->interp;
Guido van Rossum758eec01998-01-19 21:58:26 +0000392 PyObject *modules = interp->modules;
393
394 if (modules == NULL)
395 return; /* Already done */
396
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000397 /* Delete some special variables first. These are common
398 places where user values hide and people complain when their
399 destructors fail. Since the modules containing them are
400 deleted *last* of all, they would come too late in the normal
401 destruction order. Sigh. */
402
403 value = PyDict_GetItemString(modules, "__builtin__");
404 if (value != NULL && PyModule_Check(value)) {
405 dict = PyModule_GetDict(value);
406 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000407 PySys_WriteStderr("# clear __builtin__._\n");
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000408 PyDict_SetItemString(dict, "_", Py_None);
409 }
410 value = PyDict_GetItemString(modules, "sys");
411 if (value != NULL && PyModule_Check(value)) {
412 char **p;
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000413 PyObject *v;
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000414 dict = PyModule_GetDict(value);
415 for (p = sys_deletes; *p != NULL; p++) {
416 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000417 PySys_WriteStderr("# clear sys.%s\n", *p);
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000418 PyDict_SetItemString(dict, *p, Py_None);
419 }
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000420 for (p = sys_files; *p != NULL; p+=2) {
421 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000422 PySys_WriteStderr("# restore sys.%s\n", *p);
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000423 v = PyDict_GetItemString(dict, *(p+1));
424 if (v == NULL)
425 v = Py_None;
426 PyDict_SetItemString(dict, *p, v);
427 }
428 }
429
430 /* First, delete __main__ */
431 value = PyDict_GetItemString(modules, "__main__");
432 if (value != NULL && PyModule_Check(value)) {
433 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000434 PySys_WriteStderr("# cleanup __main__\n");
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000435 _PyModule_Clear(value);
436 PyDict_SetItemString(modules, "__main__", Py_None);
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000437 }
438
Guido van Rossum758eec01998-01-19 21:58:26 +0000439 /* The special treatment of __builtin__ here is because even
440 when it's not referenced as a module, its dictionary is
441 referenced by almost every module's __builtins__. Since
442 deleting a module clears its dictionary (even if there are
443 references left to it), we need to delete the __builtin__
444 module last. Likewise, we don't delete sys until the very
445 end because it is implicitly referenced (e.g. by print).
446
447 Also note that we 'delete' modules by replacing their entry
448 in the modules dict with None, rather than really deleting
449 them; this avoids a rehash of the modules dictionary and
450 also marks them as "non existent" so they won't be
451 re-imported. */
452
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000453 /* Next, repeatedly delete modules with a reference count of
Guido van Rossum758eec01998-01-19 21:58:26 +0000454 one (skipping __builtin__ and sys) and delete them */
455 do {
456 ndone = 0;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000457 pos = 0;
Guido van Rossum758eec01998-01-19 21:58:26 +0000458 while (PyDict_Next(modules, &pos, &key, &value)) {
459 if (value->ob_refcnt != 1)
460 continue;
Neal Norwitz80e7f272007-08-26 06:45:23 +0000461 if (PyUnicode_Check(key) && PyModule_Check(value)) {
462 name = PyUnicode_AsString(key);
Guido van Rossum758eec01998-01-19 21:58:26 +0000463 if (strcmp(name, "__builtin__") == 0)
464 continue;
465 if (strcmp(name, "sys") == 0)
466 continue;
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000467 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000468 PySys_WriteStderr(
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000469 "# cleanup[1] %s\n", name);
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000470 _PyModule_Clear(value);
Guido van Rossum758eec01998-01-19 21:58:26 +0000471 PyDict_SetItem(modules, key, Py_None);
472 ndone++;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000473 }
474 }
Guido van Rossum758eec01998-01-19 21:58:26 +0000475 } while (ndone > 0);
476
Guido van Rossum758eec01998-01-19 21:58:26 +0000477 /* Next, delete all modules (still skipping __builtin__ and sys) */
478 pos = 0;
479 while (PyDict_Next(modules, &pos, &key, &value)) {
Neal Norwitz80e7f272007-08-26 06:45:23 +0000480 if (PyUnicode_Check(key) && PyModule_Check(value)) {
481 name = PyUnicode_AsString(key);
Guido van Rossum758eec01998-01-19 21:58:26 +0000482 if (strcmp(name, "__builtin__") == 0)
483 continue;
484 if (strcmp(name, "sys") == 0)
485 continue;
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000486 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000487 PySys_WriteStderr("# cleanup[2] %s\n", name);
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000488 _PyModule_Clear(value);
Guido van Rossum758eec01998-01-19 21:58:26 +0000489 PyDict_SetItem(modules, key, Py_None);
490 }
491 }
492
493 /* Next, delete sys and __builtin__ (in that order) */
494 value = PyDict_GetItemString(modules, "sys");
495 if (value != NULL && PyModule_Check(value)) {
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000496 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000497 PySys_WriteStderr("# cleanup sys\n");
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000498 _PyModule_Clear(value);
Guido van Rossum758eec01998-01-19 21:58:26 +0000499 PyDict_SetItemString(modules, "sys", Py_None);
500 }
501 value = PyDict_GetItemString(modules, "__builtin__");
502 if (value != NULL && PyModule_Check(value)) {
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000503 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000504 PySys_WriteStderr("# cleanup __builtin__\n");
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000505 _PyModule_Clear(value);
Guido van Rossum758eec01998-01-19 21:58:26 +0000506 PyDict_SetItemString(modules, "__builtin__", Py_None);
507 }
508
509 /* Finally, clear and delete the modules directory */
510 PyDict_Clear(modules);
511 interp->modules = NULL;
512 Py_DECREF(modules);
Guido van Rossumd8faa362007-04-27 19:54:29 +0000513 Py_CLEAR(interp->modules_reloading);
Guido van Rossum8d15b5d1990-10-26 14:58:58 +0000514}
Guido van Rossum7f133ed1991-02-19 12:23:57 +0000515
516
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000517/* Helper for pythonrun.c -- return magic number */
518
519long
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000520PyImport_GetMagicNumber(void)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000521{
Guido van Rossum96774c12000-05-01 20:19:08 +0000522 return pyc_magic;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000523}
524
525
Guido van Rossum25ce5661997-08-02 03:10:38 +0000526/* Magic for extension modules (built-in as well as dynamically
527 loaded). To prevent initializing an extension module more than
528 once, we keep a static dictionary 'extensions' keyed by module name
529 (for built-in modules) or by filename (for dynamically loaded
Barry Warsaw92883382001-08-13 23:05:44 +0000530 modules), containing these modules. A copy of the module's
Guido van Rossum25ce5661997-08-02 03:10:38 +0000531 dictionary is stored by calling _PyImport_FixupExtension()
532 immediately after the module initialization function succeeds. A
533 copy can be retrieved from there by calling
534 _PyImport_FindExtension(). */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000535
Guido van Rossum79f25d91997-04-29 20:08:16 +0000536PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000537_PyImport_FixupExtension(char *name, char *filename)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000538{
Guido van Rossum25ce5661997-08-02 03:10:38 +0000539 PyObject *modules, *mod, *dict, *copy;
540 if (extensions == NULL) {
541 extensions = PyDict_New();
542 if (extensions == NULL)
543 return NULL;
544 }
545 modules = PyImport_GetModuleDict();
546 mod = PyDict_GetItemString(modules, name);
547 if (mod == NULL || !PyModule_Check(mod)) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000548 PyErr_Format(PyExc_SystemError,
549 "_PyImport_FixupExtension: module %.200s not loaded", name);
Guido van Rossum25ce5661997-08-02 03:10:38 +0000550 return NULL;
551 }
552 dict = PyModule_GetDict(mod);
553 if (dict == NULL)
554 return NULL;
Fred Drake9cd0efc2001-10-25 21:38:59 +0000555 copy = PyDict_Copy(dict);
Guido van Rossum25ce5661997-08-02 03:10:38 +0000556 if (copy == NULL)
557 return NULL;
558 PyDict_SetItemString(extensions, filename, copy);
559 Py_DECREF(copy);
560 return copy;
561}
562
563PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000564_PyImport_FindExtension(char *name, char *filename)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000565{
Fred Drake9cd0efc2001-10-25 21:38:59 +0000566 PyObject *dict, *mod, *mdict;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000567 if (extensions == NULL)
568 return NULL;
569 dict = PyDict_GetItemString(extensions, filename);
570 if (dict == NULL)
571 return NULL;
572 mod = PyImport_AddModule(name);
573 if (mod == NULL)
574 return NULL;
575 mdict = PyModule_GetDict(mod);
576 if (mdict == NULL)
577 return NULL;
Fred Drake9cd0efc2001-10-25 21:38:59 +0000578 if (PyDict_Update(mdict, dict))
Guido van Rossum25ce5661997-08-02 03:10:38 +0000579 return NULL;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000580 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000581 PySys_WriteStderr("import %s # previously loaded (%s)\n",
Guido van Rossum25ce5661997-08-02 03:10:38 +0000582 name, filename);
583 return mod;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000584}
585
586
587/* Get the module object corresponding to a module name.
588 First check the modules dictionary if there's one there,
Walter Dörwaldf0dfc7a2003-10-20 14:01:56 +0000589 if not, create a new one and insert it in the modules dictionary.
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000590 Because the former action is most common, THIS DOES NOT RETURN A
591 'NEW' REFERENCE! */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000592
Guido van Rossum79f25d91997-04-29 20:08:16 +0000593PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000594PyImport_AddModule(const char *name)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000595{
Guido van Rossum25ce5661997-08-02 03:10:38 +0000596 PyObject *modules = PyImport_GetModuleDict();
Guido van Rossum79f25d91997-04-29 20:08:16 +0000597 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000598
Guido van Rossum25ce5661997-08-02 03:10:38 +0000599 if ((m = PyDict_GetItemString(modules, name)) != NULL &&
Guido van Rossum79f25d91997-04-29 20:08:16 +0000600 PyModule_Check(m))
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000601 return m;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000602 m = PyModule_New(name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000603 if (m == NULL)
604 return NULL;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000605 if (PyDict_SetItemString(modules, name, m) != 0) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000606 Py_DECREF(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000607 return NULL;
608 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000609 Py_DECREF(m); /* Yes, it still exists, in modules! */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000610
611 return m;
612}
613
Tim Peters1cd70172004-08-02 03:52:12 +0000614/* Remove name from sys.modules, if it's there. */
615static void
616_RemoveModule(const char *name)
617{
618 PyObject *modules = PyImport_GetModuleDict();
619 if (PyDict_GetItemString(modules, name) == NULL)
620 return;
621 if (PyDict_DelItemString(modules, name) < 0)
622 Py_FatalError("import: deleting existing key in"
623 "sys.modules failed");
624}
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000625
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000626/* Execute a code object in a module and return the module object
Tim Peters1cd70172004-08-02 03:52:12 +0000627 * WITH INCREMENTED REFERENCE COUNT. If an error occurs, name is
628 * removed from sys.modules, to avoid leaving damaged module objects
629 * in sys.modules. The caller may wish to restore the original
630 * module object (if any) in this case; PyImport_ReloadModule is an
631 * example.
632 */
Guido van Rossum79f25d91997-04-29 20:08:16 +0000633PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000634PyImport_ExecCodeModule(char *name, PyObject *co)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000635{
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000636 return PyImport_ExecCodeModuleEx(name, co, (char *)NULL);
637}
638
639PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000640PyImport_ExecCodeModuleEx(char *name, PyObject *co, char *pathname)
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000641{
Guido van Rossum25ce5661997-08-02 03:10:38 +0000642 PyObject *modules = PyImport_GetModuleDict();
Guido van Rossum79f25d91997-04-29 20:08:16 +0000643 PyObject *m, *d, *v;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000644
Guido van Rossum79f25d91997-04-29 20:08:16 +0000645 m = PyImport_AddModule(name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000646 if (m == NULL)
647 return NULL;
Jeremy Hyltonecd91292004-01-02 23:25:32 +0000648 /* If the module is being reloaded, we get the old module back
649 and re-use its dict to exec the new code. */
Guido van Rossum79f25d91997-04-29 20:08:16 +0000650 d = PyModule_GetDict(m);
651 if (PyDict_GetItemString(d, "__builtins__") == NULL) {
652 if (PyDict_SetItemString(d, "__builtins__",
653 PyEval_GetBuiltins()) != 0)
Tim Peters1cd70172004-08-02 03:52:12 +0000654 goto error;
Guido van Rossum6135a871995-01-09 17:53:26 +0000655 }
Guido van Rossum9c9a07c1996-05-16 20:43:40 +0000656 /* Remember the filename as the __file__ attribute */
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000657 v = NULL;
658 if (pathname != NULL) {
Guido van Rossum00bc0e02007-10-15 02:52:41 +0000659 v = PyUnicode_DecodeFSDefault(pathname);
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000660 if (v == NULL)
661 PyErr_Clear();
662 }
663 if (v == NULL) {
664 v = ((PyCodeObject *)co)->co_filename;
665 Py_INCREF(v);
666 }
667 if (PyDict_SetItemString(d, "__file__", v) != 0)
Guido van Rossum79f25d91997-04-29 20:08:16 +0000668 PyErr_Clear(); /* Not important enough to report */
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000669 Py_DECREF(v);
670
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000671 v = PyEval_EvalCode((PyCodeObject *)co, d, d);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000672 if (v == NULL)
Tim Peters1cd70172004-08-02 03:52:12 +0000673 goto error;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000674 Py_DECREF(v);
Guido van Rossumb65e85c1997-07-10 18:00:45 +0000675
Guido van Rossum25ce5661997-08-02 03:10:38 +0000676 if ((m = PyDict_GetItemString(modules, name)) == NULL) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000677 PyErr_Format(PyExc_ImportError,
678 "Loaded module %.200s not found in sys.modules",
679 name);
Guido van Rossumb65e85c1997-07-10 18:00:45 +0000680 return NULL;
681 }
682
Guido van Rossum79f25d91997-04-29 20:08:16 +0000683 Py_INCREF(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000684
685 return m;
Tim Peters1cd70172004-08-02 03:52:12 +0000686
687 error:
688 _RemoveModule(name);
689 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000690}
691
692
693/* Given a pathname for a Python source file, fill a buffer with the
694 pathname for the corresponding compiled file. Return the pathname
695 for the compiled file, or NULL if there's no space in the buffer.
696 Doesn't set an exception. */
697
698static char *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000699make_compiled_pathname(char *pathname, char *buf, size_t buflen)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000700{
Tim Petersc1731372001-08-04 08:12:36 +0000701 size_t len = strlen(pathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000702 if (len+2 > buflen)
703 return NULL;
Tim Petersc1731372001-08-04 08:12:36 +0000704
Martin v. Löwis6238d2b2002-06-30 15:26:10 +0000705#ifdef MS_WINDOWS
Tim Petersc1731372001-08-04 08:12:36 +0000706 /* Treat .pyw as if it were .py. The case of ".pyw" must match
707 that used in _PyImport_StandardFiletab. */
708 if (len >= 4 && strcmp(&pathname[len-4], ".pyw") == 0)
709 --len; /* pretend 'w' isn't there */
710#endif
711 memcpy(buf, pathname, len);
712 buf[len] = Py_OptimizeFlag ? 'o' : 'c';
713 buf[len+1] = '\0';
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000714
715 return buf;
716}
717
718
719/* Given a pathname for a Python source file, its time of last
720 modification, and a pathname for a compiled file, check whether the
721 compiled file represents the same version of the source. If so,
722 return a FILE pointer for the compiled file, positioned just after
723 the header; if not, return NULL.
724 Doesn't set an exception. */
725
726static FILE *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000727check_compiled_module(char *pathname, time_t mtime, char *cpathname)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000728{
729 FILE *fp;
730 long magic;
731 long pyc_mtime;
732
733 fp = fopen(cpathname, "rb");
734 if (fp == NULL)
735 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000736 magic = PyMarshal_ReadLongFromFile(fp);
Guido van Rossum96774c12000-05-01 20:19:08 +0000737 if (magic != pyc_magic) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000738 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000739 PySys_WriteStderr("# %s has bad magic\n", cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000740 fclose(fp);
741 return NULL;
742 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000743 pyc_mtime = PyMarshal_ReadLongFromFile(fp);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000744 if (pyc_mtime != mtime) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000745 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000746 PySys_WriteStderr("# %s has bad mtime\n", cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000747 fclose(fp);
748 return NULL;
749 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000750 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000751 PySys_WriteStderr("# %s matches %s\n", cpathname, pathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000752 return fp;
753}
754
755
756/* Read a code object from a file and check it for validity */
757
Guido van Rossum79f25d91997-04-29 20:08:16 +0000758static PyCodeObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000759read_compiled_module(char *cpathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000760{
Guido van Rossum79f25d91997-04-29 20:08:16 +0000761 PyObject *co;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000762
Tim Petersd9b9ac82001-01-28 00:27:39 +0000763 co = PyMarshal_ReadLastObjectFromFile(fp);
Armin Rigo01ab2792004-03-26 15:09:27 +0000764 if (co == NULL)
765 return NULL;
766 if (!PyCode_Check(co)) {
767 PyErr_Format(PyExc_ImportError,
768 "Non-code object in %.200s", cpathname);
769 Py_DECREF(co);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000770 return NULL;
771 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000772 return (PyCodeObject *)co;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000773}
774
775
776/* Load a module from a compiled file, execute it, and return its
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000777 module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000778
Guido van Rossum79f25d91997-04-29 20:08:16 +0000779static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000780load_compiled_module(char *name, char *cpathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000781{
782 long magic;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000783 PyCodeObject *co;
784 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000785
Guido van Rossum79f25d91997-04-29 20:08:16 +0000786 magic = PyMarshal_ReadLongFromFile(fp);
Guido van Rossum96774c12000-05-01 20:19:08 +0000787 if (magic != pyc_magic) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000788 PyErr_Format(PyExc_ImportError,
789 "Bad magic number in %.200s", cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000790 return NULL;
791 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000792 (void) PyMarshal_ReadLongFromFile(fp);
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000793 co = read_compiled_module(cpathname, fp);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000794 if (co == NULL)
795 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000796 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000797 PySys_WriteStderr("import %s # precompiled from %s\n",
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000798 name, cpathname);
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000799 m = PyImport_ExecCodeModuleEx(name, (PyObject *)co, cpathname);
Guido van Rossum79f25d91997-04-29 20:08:16 +0000800 Py_DECREF(co);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000801
802 return m;
803}
804
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000805/* Parse a source file and return the corresponding code object */
806
Guido van Rossum79f25d91997-04-29 20:08:16 +0000807static PyCodeObject *
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000808parse_source_module(const char *pathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000809{
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000810 PyCodeObject *co = NULL;
811 mod_ty mod;
Thomas Wouters89f507f2006-12-13 04:49:30 +0000812 PyArena *arena = PyArena_New();
813 if (arena == NULL)
814 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000815
Martin v. Löwis85bcc662007-09-04 09:18:06 +0000816 mod = PyParser_ASTFromFile(fp, pathname, NULL,
817 Py_file_input, 0, 0, 0,
Neal Norwitzadb69fc2005-12-17 20:54:49 +0000818 NULL, arena);
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000819 if (mod) {
Neal Norwitzadb69fc2005-12-17 20:54:49 +0000820 co = PyAST_Compile(mod, pathname, NULL, arena);
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000821 }
Thomas Wouters89f507f2006-12-13 04:49:30 +0000822 PyArena_Free(arena);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000823 return co;
824}
825
826
Guido van Rossum55a83382000-09-20 20:31:38 +0000827/* Helper to open a bytecode file for writing in exclusive mode */
828
829static FILE *
830open_exclusive(char *filename)
831{
832#if defined(O_EXCL)&&defined(O_CREAT)&&defined(O_WRONLY)&&defined(O_TRUNC)
833 /* Use O_EXCL to avoid a race condition when another process tries to
834 write the same file. When that happens, our open() call fails,
835 which is just fine (since it's only a cache).
836 XXX If the file exists and is writable but the directory is not
837 writable, the file will never be written. Oh well.
838 */
839 int fd;
840 (void) unlink(filename);
Tim Peters42c83af2000-09-29 04:03:10 +0000841 fd = open(filename, O_EXCL|O_CREAT|O_WRONLY|O_TRUNC
842#ifdef O_BINARY
843 |O_BINARY /* necessary for Windows */
844#endif
Martin v. Löwis79acb9e2002-12-06 12:48:53 +0000845#ifdef __VMS
Martin v. Löwis18e16552006-02-15 17:27:45 +0000846 , 0666, "ctxt=bin", "shr=nil"
Martin v. Löwis79acb9e2002-12-06 12:48:53 +0000847#else
Martin v. Löwis18e16552006-02-15 17:27:45 +0000848 , 0666
Martin v. Löwis79acb9e2002-12-06 12:48:53 +0000849#endif
Martin v. Löwis18e16552006-02-15 17:27:45 +0000850 );
Guido van Rossum55a83382000-09-20 20:31:38 +0000851 if (fd < 0)
852 return NULL;
853 return fdopen(fd, "wb");
854#else
855 /* Best we can do -- on Windows this can't happen anyway */
856 return fopen(filename, "wb");
857#endif
858}
859
860
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000861/* Write a compiled module to a file, placing the time of last
862 modification of its source into the header.
863 Errors are ignored, if a write error occurs an attempt is made to
864 remove the file. */
865
866static void
Martin v. Löwis18e16552006-02-15 17:27:45 +0000867write_compiled_module(PyCodeObject *co, char *cpathname, time_t mtime)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000868{
869 FILE *fp;
870
Guido van Rossum55a83382000-09-20 20:31:38 +0000871 fp = open_exclusive(cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000872 if (fp == NULL) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000873 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000874 PySys_WriteStderr(
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000875 "# can't create %s\n", cpathname);
876 return;
877 }
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000878 PyMarshal_WriteLongToFile(pyc_magic, fp, Py_MARSHAL_VERSION);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000879 /* First write a 0 for mtime */
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000880 PyMarshal_WriteLongToFile(0L, fp, Py_MARSHAL_VERSION);
881 PyMarshal_WriteObjectToFile((PyObject *)co, fp, Py_MARSHAL_VERSION);
Armin Rigo01ab2792004-03-26 15:09:27 +0000882 if (fflush(fp) != 0 || ferror(fp)) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000883 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000884 PySys_WriteStderr("# can't write %s\n", cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000885 /* Don't keep partial file */
886 fclose(fp);
887 (void) unlink(cpathname);
888 return;
889 }
890 /* Now write the true mtime */
891 fseek(fp, 4L, 0);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000892 assert(mtime < LONG_MAX);
Martin v. Löwis725507b2006-03-07 12:08:51 +0000893 PyMarshal_WriteLongToFile((long)mtime, fp, Py_MARSHAL_VERSION);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000894 fflush(fp);
895 fclose(fp);
Guido van Rossum79f25d91997-04-29 20:08:16 +0000896 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000897 PySys_WriteStderr("# wrote %s\n", cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000898}
899
900
901/* Load a source module from a given file and return its module
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000902 object WITH INCREMENTED REFERENCE COUNT. If there's a matching
903 byte-compiled file, use that instead. */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000904
Guido van Rossum79f25d91997-04-29 20:08:16 +0000905static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000906load_source_module(char *name, char *pathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000907{
Fred Drake4c82b232000-06-30 16:18:57 +0000908 time_t mtime;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000909 FILE *fpc;
910 char buf[MAXPATHLEN+1];
911 char *cpathname;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000912 PyCodeObject *co;
913 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000914
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000915 mtime = PyOS_GetLastModificationTime(pathname, fp);
Neal Norwitz708e51a2005-10-03 04:48:15 +0000916 if (mtime == (time_t)(-1)) {
917 PyErr_Format(PyExc_RuntimeError,
918 "unable to get modification time from '%s'",
919 pathname);
Fred Drake4c82b232000-06-30 16:18:57 +0000920 return NULL;
Neal Norwitz708e51a2005-10-03 04:48:15 +0000921 }
Fred Drake4c82b232000-06-30 16:18:57 +0000922#if SIZEOF_TIME_T > 4
923 /* Python's .pyc timestamp handling presumes that the timestamp fits
924 in 4 bytes. This will be fine until sometime in the year 2038,
925 when a 4-byte signed time_t will overflow.
926 */
927 if (mtime >> 32) {
928 PyErr_SetString(PyExc_OverflowError,
Fred Drakec63d3e92001-03-01 06:33:32 +0000929 "modification time overflows a 4 byte field");
Fred Drake4c82b232000-06-30 16:18:57 +0000930 return NULL;
931 }
932#endif
Tim Peters36515e22001-11-18 04:06:29 +0000933 cpathname = make_compiled_pathname(pathname, buf,
Jeremy Hylton37832f02001-04-13 17:50:20 +0000934 (size_t)MAXPATHLEN + 1);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000935 if (cpathname != NULL &&
936 (fpc = check_compiled_module(pathname, mtime, cpathname))) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000937 co = read_compiled_module(cpathname, fpc);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000938 fclose(fpc);
939 if (co == NULL)
940 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000941 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000942 PySys_WriteStderr("import %s # precompiled from %s\n",
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000943 name, cpathname);
Guido van Rossumafd3dae1998-08-25 18:44:34 +0000944 pathname = cpathname;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000945 }
946 else {
947 co = parse_source_module(pathname, fp);
948 if (co == NULL)
949 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000950 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000951 PySys_WriteStderr("import %s # from %s\n",
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000952 name, pathname);
Thomas Wouters00ee7ba2006-08-21 19:07:27 +0000953 if (cpathname)
954 write_compiled_module(co, cpathname, mtime);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000955 }
Guido van Rossumafd3dae1998-08-25 18:44:34 +0000956 m = PyImport_ExecCodeModuleEx(name, (PyObject *)co, pathname);
Guido van Rossum79f25d91997-04-29 20:08:16 +0000957 Py_DECREF(co);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000958
959 return m;
960}
961
962
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000963/* Forward */
Just van Rossum52e14d62002-12-30 22:08:05 +0000964static PyObject *load_module(char *, FILE *, char *, int, PyObject *);
965static struct filedescr *find_module(char *, char *, PyObject *,
966 char *, size_t, FILE **, PyObject **);
Tim Petersdbd9ba62000-07-09 03:09:57 +0000967static struct _frozen *find_frozen(char *name);
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000968
969/* Load a package and return its module object WITH INCREMENTED
970 REFERENCE COUNT */
971
972static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000973load_package(char *name, char *pathname)
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000974{
Tim Peters1cd70172004-08-02 03:52:12 +0000975 PyObject *m, *d;
976 PyObject *file = NULL;
977 PyObject *path = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000978 int err;
979 char buf[MAXPATHLEN+1];
980 FILE *fp = NULL;
981 struct filedescr *fdp;
982
983 m = PyImport_AddModule(name);
984 if (m == NULL)
985 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +0000986 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000987 PySys_WriteStderr("import %s # directory %s\n",
Guido van Rossum17fc85f1997-09-06 18:52:03 +0000988 name, pathname);
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000989 d = PyModule_GetDict(m);
Guido van Rossum00bc0e02007-10-15 02:52:41 +0000990 file = PyUnicode_DecodeFSDefault(pathname);
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000991 if (file == NULL)
Tim Peters1cd70172004-08-02 03:52:12 +0000992 goto error;
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000993 path = Py_BuildValue("[O]", file);
Tim Peters1cd70172004-08-02 03:52:12 +0000994 if (path == NULL)
995 goto error;
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000996 err = PyDict_SetItemString(d, "__file__", file);
997 if (err == 0)
998 err = PyDict_SetItemString(d, "__path__", path);
Tim Peters1cd70172004-08-02 03:52:12 +0000999 if (err != 0)
1000 goto error;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001001 buf[0] = '\0';
Just van Rossum52e14d62002-12-30 22:08:05 +00001002 fdp = find_module(name, "__init__", path, buf, sizeof(buf), &fp, NULL);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001003 if (fdp == NULL) {
1004 if (PyErr_ExceptionMatches(PyExc_ImportError)) {
1005 PyErr_Clear();
Thomas Heller25653242004-06-07 15:04:10 +00001006 Py_INCREF(m);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001007 }
1008 else
1009 m = NULL;
1010 goto cleanup;
1011 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001012 m = load_module(name, fp, buf, fdp->type, NULL);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001013 if (fp != NULL)
1014 fclose(fp);
Tim Peters1cd70172004-08-02 03:52:12 +00001015 goto cleanup;
1016
1017 error:
1018 m = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001019 cleanup:
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001020 Py_XDECREF(path);
1021 Py_XDECREF(file);
1022 return m;
1023}
1024
1025
1026/* Helper to test for built-in module */
1027
1028static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001029is_builtin(char *name)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001030{
1031 int i;
Guido van Rossum771c6c81997-10-31 18:37:24 +00001032 for (i = 0; PyImport_Inittab[i].name != NULL; i++) {
1033 if (strcmp(name, PyImport_Inittab[i].name) == 0) {
1034 if (PyImport_Inittab[i].initfunc == NULL)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001035 return -1;
1036 else
1037 return 1;
1038 }
1039 }
1040 return 0;
1041}
1042
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001043
Just van Rossum52e14d62002-12-30 22:08:05 +00001044/* Return an importer object for a sys.path/pkg.__path__ item 'p',
1045 possibly by fetching it from the path_importer_cache dict. If it
Thomas Wouters89f507f2006-12-13 04:49:30 +00001046 wasn't yet cached, traverse path_hooks until a hook is found
Just van Rossum52e14d62002-12-30 22:08:05 +00001047 that can handle the path item. Return None if no hook could;
1048 this tells our caller it should fall back to the builtin
1049 import mechanism. Cache the result in path_importer_cache.
1050 Returns a borrowed reference. */
1051
1052static PyObject *
1053get_path_importer(PyObject *path_importer_cache, PyObject *path_hooks,
1054 PyObject *p)
1055{
1056 PyObject *importer;
Martin v. Löwis725507b2006-03-07 12:08:51 +00001057 Py_ssize_t j, nhooks;
Just van Rossum52e14d62002-12-30 22:08:05 +00001058
1059 /* These conditions are the caller's responsibility: */
1060 assert(PyList_Check(path_hooks));
1061 assert(PyDict_Check(path_importer_cache));
1062
1063 nhooks = PyList_Size(path_hooks);
1064 if (nhooks < 0)
1065 return NULL; /* Shouldn't happen */
1066
1067 importer = PyDict_GetItem(path_importer_cache, p);
1068 if (importer != NULL)
1069 return importer;
1070
1071 /* set path_importer_cache[p] to None to avoid recursion */
1072 if (PyDict_SetItem(path_importer_cache, p, Py_None) != 0)
1073 return NULL;
1074
1075 for (j = 0; j < nhooks; j++) {
1076 PyObject *hook = PyList_GetItem(path_hooks, j);
1077 if (hook == NULL)
1078 return NULL;
Thomas Wouters477c8d52006-05-27 19:21:47 +00001079 importer = PyObject_CallFunctionObjArgs(hook, p, NULL);
Just van Rossum52e14d62002-12-30 22:08:05 +00001080 if (importer != NULL)
1081 break;
1082
1083 if (!PyErr_ExceptionMatches(PyExc_ImportError)) {
1084 return NULL;
1085 }
1086 PyErr_Clear();
1087 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001088 if (importer == NULL) {
1089 importer = PyObject_CallFunctionObjArgs(
1090 (PyObject *)&NullImporterType, p, NULL
1091 );
1092 if (importer == NULL) {
1093 if (PyErr_ExceptionMatches(PyExc_ImportError)) {
1094 PyErr_Clear();
1095 return Py_None;
1096 }
1097 }
1098 }
1099 if (importer != NULL) {
Just van Rossum52e14d62002-12-30 22:08:05 +00001100 int err = PyDict_SetItem(path_importer_cache, p, importer);
1101 Py_DECREF(importer);
1102 if (err != 0)
1103 return NULL;
1104 }
1105 return importer;
1106}
1107
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001108/* Search the path (default sys.path) for a module. Return the
1109 corresponding filedescr struct, and (via return arguments) the
1110 pathname and an open file. Return NULL if the module is not found. */
1111
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001112#ifdef MS_COREDLL
Thomas Woutersb4bd21c2000-07-22 23:38:01 +00001113extern FILE *PyWin_FindRegisteredModule(const char *, struct filedescr **,
Martin v. Löwis18e16552006-02-15 17:27:45 +00001114 char *, Py_ssize_t);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001115#endif
1116
Martin v. Löwis18e16552006-02-15 17:27:45 +00001117static int case_ok(char *, Py_ssize_t, Py_ssize_t, char *);
Tim Petersdbd9ba62000-07-09 03:09:57 +00001118static int find_init_module(char *); /* Forward */
Just van Rossum52e14d62002-12-30 22:08:05 +00001119static struct filedescr importhookdescr = {"", "", IMP_HOOK};
Guido van Rossum197346f1997-10-31 18:38:52 +00001120
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001121static struct filedescr *
Just van Rossum52e14d62002-12-30 22:08:05 +00001122find_module(char *fullname, char *subname, PyObject *path, char *buf,
1123 size_t buflen, FILE **p_fp, PyObject **p_loader)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001124{
Martin v. Löwis725507b2006-03-07 12:08:51 +00001125 Py_ssize_t i, npath;
Fred Drake4c82b232000-06-30 16:18:57 +00001126 size_t len, namelen;
Guido van Rossum80bb9651996-12-05 23:27:02 +00001127 struct filedescr *fdp = NULL;
Jack Jansenc88da1f2002-05-28 10:58:19 +00001128 char *filemode;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001129 FILE *fp = NULL;
Just van Rossum52e14d62002-12-30 22:08:05 +00001130 PyObject *path_hooks, *path_importer_cache;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001131 struct stat statbuf;
Guido van Rossuma5568d31998-03-05 03:45:08 +00001132 static struct filedescr fd_frozen = {"", "", PY_FROZEN};
1133 static struct filedescr fd_builtin = {"", "", C_BUILTIN};
1134 static struct filedescr fd_package = {"", "", PKG_DIRECTORY};
Guido van Rossum0506a431998-08-11 15:07:39 +00001135 char name[MAXPATHLEN+1];
Andrew MacIntyred9400542002-02-26 11:41:34 +00001136#if defined(PYOS_OS2)
1137 size_t saved_len;
1138 size_t saved_namelen;
1139 char *saved_buf = NULL;
1140#endif
Just van Rossum52e14d62002-12-30 22:08:05 +00001141 if (p_loader != NULL)
1142 *p_loader = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001143
Just van Rossum52e14d62002-12-30 22:08:05 +00001144 if (strlen(subname) > MAXPATHLEN) {
Guido van Rossum8f4d3312001-10-18 18:54:11 +00001145 PyErr_SetString(PyExc_OverflowError,
1146 "module name is too long");
Fred Drake4c82b232000-06-30 16:18:57 +00001147 return NULL;
1148 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001149 strcpy(name, subname);
1150
1151 /* sys.meta_path import hook */
1152 if (p_loader != NULL) {
1153 PyObject *meta_path;
1154
1155 meta_path = PySys_GetObject("meta_path");
1156 if (meta_path == NULL || !PyList_Check(meta_path)) {
1157 PyErr_SetString(PyExc_ImportError,
1158 "sys.meta_path must be a list of "
1159 "import hooks");
1160 return NULL;
1161 }
1162 Py_INCREF(meta_path); /* zap guard */
1163 npath = PyList_Size(meta_path);
1164 for (i = 0; i < npath; i++) {
1165 PyObject *loader;
1166 PyObject *hook = PyList_GetItem(meta_path, i);
1167 loader = PyObject_CallMethod(hook, "find_module",
1168 "sO", fullname,
1169 path != NULL ?
1170 path : Py_None);
1171 if (loader == NULL) {
1172 Py_DECREF(meta_path);
1173 return NULL; /* true error */
1174 }
1175 if (loader != Py_None) {
1176 /* a loader was found */
1177 *p_loader = loader;
1178 Py_DECREF(meta_path);
1179 return &importhookdescr;
1180 }
1181 Py_DECREF(loader);
1182 }
1183 Py_DECREF(meta_path);
1184 }
Guido van Rossum0506a431998-08-11 15:07:39 +00001185
Guido van Rossum13d77992007-07-23 03:16:50 +00001186 if (path != NULL && PyUnicode_Check(path)) {
Guido van Rossum8f4d3312001-10-18 18:54:11 +00001187 /* The only type of submodule allowed inside a "frozen"
1188 package are other frozen modules or packages. */
Guido van Rossum13d77992007-07-23 03:16:50 +00001189 char *p = PyUnicode_AsString(path);
1190 if (strlen(p) + 1 + strlen(name) >= (size_t)buflen) {
Guido van Rossum0506a431998-08-11 15:07:39 +00001191 PyErr_SetString(PyExc_ImportError,
1192 "full frozen module name too long");
1193 return NULL;
1194 }
Guido van Rossum13d77992007-07-23 03:16:50 +00001195 strcpy(buf, p);
Guido van Rossum0506a431998-08-11 15:07:39 +00001196 strcat(buf, ".");
1197 strcat(buf, name);
1198 strcpy(name, buf);
Guido van Rossum8f4d3312001-10-18 18:54:11 +00001199 if (find_frozen(name) != NULL) {
1200 strcpy(buf, name);
1201 return &fd_frozen;
1202 }
1203 PyErr_Format(PyExc_ImportError,
1204 "No frozen submodule named %.200s", name);
1205 return NULL;
Guido van Rossum0506a431998-08-11 15:07:39 +00001206 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001207 if (path == NULL) {
1208 if (is_builtin(name)) {
Guido van Rossuma5568d31998-03-05 03:45:08 +00001209 strcpy(buf, name);
1210 return &fd_builtin;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001211 }
Greg Ward201baee2001-10-04 14:52:06 +00001212 if ((find_frozen(name)) != NULL) {
Guido van Rossuma5568d31998-03-05 03:45:08 +00001213 strcpy(buf, name);
1214 return &fd_frozen;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001215 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001216
Guido van Rossumac279101996-08-22 23:10:58 +00001217#ifdef MS_COREDLL
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001218 fp = PyWin_FindRegisteredModule(name, &fdp, buf, buflen);
1219 if (fp != NULL) {
1220 *p_fp = fp;
1221 return fdp;
1222 }
Guido van Rossuma5a3db71996-04-09 02:39:59 +00001223#endif
Guido van Rossuma5568d31998-03-05 03:45:08 +00001224 path = PySys_GetObject("path");
1225 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00001226 if (path == NULL || !PyList_Check(path)) {
1227 PyErr_SetString(PyExc_ImportError,
Guido van Rossuma5568d31998-03-05 03:45:08 +00001228 "sys.path must be a list of directory names");
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001229 return NULL;
1230 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001231
1232 path_hooks = PySys_GetObject("path_hooks");
1233 if (path_hooks == NULL || !PyList_Check(path_hooks)) {
1234 PyErr_SetString(PyExc_ImportError,
1235 "sys.path_hooks must be a list of "
1236 "import hooks");
1237 return NULL;
1238 }
1239 path_importer_cache = PySys_GetObject("path_importer_cache");
1240 if (path_importer_cache == NULL ||
1241 !PyDict_Check(path_importer_cache)) {
1242 PyErr_SetString(PyExc_ImportError,
1243 "sys.path_importer_cache must be a dict");
1244 return NULL;
1245 }
1246
Guido van Rossum79f25d91997-04-29 20:08:16 +00001247 npath = PyList_Size(path);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001248 namelen = strlen(name);
1249 for (i = 0; i < npath; i++) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00001250 PyObject *v = PyList_GetItem(path, i);
Guido van Rossumf15a29f2007-05-04 00:41:39 +00001251 PyObject *origv = v;
Guido van Rossum6262cc72007-05-09 23:29:27 +00001252 const char *base;
Guido van Rossumf15a29f2007-05-04 00:41:39 +00001253 Py_ssize_t size;
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001254 if (!v)
1255 return NULL;
Guido van Rossuma4b8d1d2007-08-27 15:02:28 +00001256 if (PyUnicode_Check(v)) {
1257 v = _PyUnicode_AsDefaultEncodedString(v, NULL);
1258 if (v == NULL)
1259 return NULL;
1260 }
1261 if (!PyString_Check(v))
1262 continue;
1263 base = PyString_AS_STRING(v);
1264 size = PyString_GET_SIZE(v);
Guido van Rossumf15a29f2007-05-04 00:41:39 +00001265 len = size;
Walter Dörwald3430d702002-06-17 10:43:59 +00001266 if (len + 2 + namelen + MAXSUFFIXSIZE >= buflen) {
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001267 continue; /* Too long */
Walter Dörwald3430d702002-06-17 10:43:59 +00001268 }
Guido van Rossumf15a29f2007-05-04 00:41:39 +00001269 strcpy(buf, base);
Walter Dörwald3430d702002-06-17 10:43:59 +00001270 if (strlen(buf) != len) {
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001271 continue; /* v contains '\0' */
Walter Dörwald3430d702002-06-17 10:43:59 +00001272 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001273
1274 /* sys.path_hooks import hook */
1275 if (p_loader != NULL) {
1276 PyObject *importer;
1277
1278 importer = get_path_importer(path_importer_cache,
Guido van Rossumf15a29f2007-05-04 00:41:39 +00001279 path_hooks, origv);
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001280 if (importer == NULL) {
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001281 return NULL;
Thomas Wouters477c8d52006-05-27 19:21:47 +00001282 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001283 /* Note: importer is a borrowed reference */
1284 if (importer != Py_None) {
Just van Rossum52e14d62002-12-30 22:08:05 +00001285 PyObject *loader;
1286 loader = PyObject_CallMethod(importer,
1287 "find_module",
1288 "s", fullname);
1289 if (loader == NULL)
1290 return NULL; /* error */
1291 if (loader != Py_None) {
1292 /* a loader was found */
1293 *p_loader = loader;
1294 return &importhookdescr;
1295 }
1296 Py_DECREF(loader);
Thomas Wouters477c8d52006-05-27 19:21:47 +00001297 continue;
Just van Rossum52e14d62002-12-30 22:08:05 +00001298 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001299 }
Thomas Wouters477c8d52006-05-27 19:21:47 +00001300 /* no hook was found, use builtin import */
Just van Rossum52e14d62002-12-30 22:08:05 +00001301
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001302 if (len > 0 && buf[len-1] != SEP
1303#ifdef ALTSEP
1304 && buf[len-1] != ALTSEP
1305#endif
1306 )
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001307 buf[len++] = SEP;
Guido van Rossum215c3402000-11-13 17:26:32 +00001308 strcpy(buf+len, name);
1309 len += namelen;
Tim Peters50d8d372001-02-28 05:34:27 +00001310
1311 /* Check for package import (buf holds a directory name,
1312 and there's an __init__ module in that directory */
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001313#ifdef HAVE_STAT
Walter Dörwald3430d702002-06-17 10:43:59 +00001314 if (stat(buf, &statbuf) == 0 && /* it exists */
1315 S_ISDIR(statbuf.st_mode) && /* it's a directory */
Thomas Wouters477c8d52006-05-27 19:21:47 +00001316 case_ok(buf, len, namelen, name)) { /* case matches */
1317 if (find_init_module(buf)) { /* and has __init__.py */
Thomas Wouters477c8d52006-05-27 19:21:47 +00001318 return &fd_package;
1319 }
1320 else {
1321 char warnstr[MAXPATHLEN+80];
1322 sprintf(warnstr, "Not importing directory "
1323 "'%.*s': missing __init__.py",
1324 MAXPATHLEN, buf);
Skip Montanaro46fc3372007-08-12 11:44:53 +00001325 if (PyErr_WarnEx(PyExc_ImportWarning,
1326 warnstr, 1)) {
Thomas Wouters477c8d52006-05-27 19:21:47 +00001327 return NULL;
1328 }
1329 }
Walter Dörwald3430d702002-06-17 10:43:59 +00001330 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001331#endif
Andrew MacIntyred9400542002-02-26 11:41:34 +00001332#if defined(PYOS_OS2)
1333 /* take a snapshot of the module spec for restoration
1334 * after the 8 character DLL hackery
1335 */
1336 saved_buf = strdup(buf);
1337 saved_len = len;
1338 saved_namelen = namelen;
1339#endif /* PYOS_OS2 */
Guido van Rossum79f25d91997-04-29 20:08:16 +00001340 for (fdp = _PyImport_Filetab; fdp->suffix != NULL; fdp++) {
Guido van Rossum04110fb2007-08-24 16:32:05 +00001341#if defined(PYOS_OS2) && defined(HAVE_DYNAMIC_LOADING)
Jeremy Hylton4ae6fae2002-05-30 17:15:25 +00001342 /* OS/2 limits DLLs to 8 character names (w/o
1343 extension)
Andrew MacIntyred9400542002-02-26 11:41:34 +00001344 * so if the name is longer than that and its a
1345 * dynamically loaded module we're going to try,
1346 * truncate the name before trying
1347 */
Just van Rossum52e14d62002-12-30 22:08:05 +00001348 if (strlen(subname) > 8) {
Andrew MacIntyred9400542002-02-26 11:41:34 +00001349 /* is this an attempt to load a C extension? */
Jeremy Hylton4ae6fae2002-05-30 17:15:25 +00001350 const struct filedescr *scan;
1351 scan = _PyImport_DynLoadFiletab;
Andrew MacIntyred9400542002-02-26 11:41:34 +00001352 while (scan->suffix != NULL) {
Jeremy Hylton4ae6fae2002-05-30 17:15:25 +00001353 if (!strcmp(scan->suffix, fdp->suffix))
Andrew MacIntyred9400542002-02-26 11:41:34 +00001354 break;
1355 else
1356 scan++;
1357 }
1358 if (scan->suffix != NULL) {
1359 /* yes, so truncate the name */
1360 namelen = 8;
Just van Rossum52e14d62002-12-30 22:08:05 +00001361 len -= strlen(subname) - namelen;
Andrew MacIntyred9400542002-02-26 11:41:34 +00001362 buf[len] = '\0';
1363 }
1364 }
1365#endif /* PYOS_OS2 */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001366 strcpy(buf+len, fdp->suffix);
Guido van Rossum79f25d91997-04-29 20:08:16 +00001367 if (Py_VerboseFlag > 1)
Guido van Rossum2f3667a1998-10-12 18:23:55 +00001368 PySys_WriteStderr("# trying %s\n", buf);
Jack Jansenc88da1f2002-05-28 10:58:19 +00001369 filemode = fdp->mode;
Tim Peters86c7d2f2004-08-01 23:24:21 +00001370 if (filemode[0] == 'U')
Jeremy Hylton4ae6fae2002-05-30 17:15:25 +00001371 filemode = "r" PY_STDIOTEXTMODE;
Jack Jansenc88da1f2002-05-28 10:58:19 +00001372 fp = fopen(buf, filemode);
Tim Peters50d8d372001-02-28 05:34:27 +00001373 if (fp != NULL) {
1374 if (case_ok(buf, len, namelen, name))
1375 break;
1376 else { /* continue search */
1377 fclose(fp);
1378 fp = NULL;
Barry Warsaw914a0b12001-02-02 19:12:16 +00001379 }
Barry Warsaw914a0b12001-02-02 19:12:16 +00001380 }
Andrew MacIntyred9400542002-02-26 11:41:34 +00001381#if defined(PYOS_OS2)
1382 /* restore the saved snapshot */
1383 strcpy(buf, saved_buf);
1384 len = saved_len;
1385 namelen = saved_namelen;
1386#endif
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001387 }
Andrew MacIntyred9400542002-02-26 11:41:34 +00001388#if defined(PYOS_OS2)
1389 /* don't need/want the module name snapshot anymore */
1390 if (saved_buf)
1391 {
1392 free(saved_buf);
1393 saved_buf = NULL;
1394 }
1395#endif
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001396 if (fp != NULL)
1397 break;
1398 }
1399 if (fp == NULL) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001400 PyErr_Format(PyExc_ImportError,
1401 "No module named %.200s", name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001402 return NULL;
1403 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001404 *p_fp = fp;
1405 return fdp;
1406}
1407
Raymond Hettingerdb29e0f2004-10-07 06:46:25 +00001408/* Helpers for main.c
1409 * Find the source file corresponding to a named module
1410 */
1411struct filedescr *
1412_PyImport_FindModule(const char *name, PyObject *path, char *buf,
1413 size_t buflen, FILE **p_fp, PyObject **p_loader)
1414{
1415 return find_module((char *) name, (char *) name, path,
1416 buf, buflen, p_fp, p_loader);
1417}
1418
1419PyAPI_FUNC(int) _PyImport_IsScript(struct filedescr * fd)
1420{
1421 return fd->type == PY_SOURCE || fd->type == PY_COMPILED;
1422}
1423
Martin v. Löwis18e16552006-02-15 17:27:45 +00001424/* case_ok(char* buf, Py_ssize_t len, Py_ssize_t namelen, char* name)
Tim Petersd1e87a82001-03-01 18:12:00 +00001425 * The arguments here are tricky, best shown by example:
1426 * /a/b/c/d/e/f/g/h/i/j/k/some_long_module_name.py\0
1427 * ^ ^ ^ ^
1428 * |--------------------- buf ---------------------|
1429 * |------------------- len ------------------|
1430 * |------ name -------|
1431 * |----- namelen -----|
1432 * buf is the full path, but len only counts up to (& exclusive of) the
1433 * extension. name is the module name, also exclusive of extension.
1434 *
1435 * We've already done a successful stat() or fopen() on buf, so know that
1436 * there's some match, possibly case-insensitive.
1437 *
Tim Peters50d8d372001-02-28 05:34:27 +00001438 * case_ok() is to return 1 if there's a case-sensitive match for
1439 * name, else 0. case_ok() is also to return 1 if envar PYTHONCASEOK
1440 * exists.
Tim Petersd1e87a82001-03-01 18:12:00 +00001441 *
Tim Peters50d8d372001-02-28 05:34:27 +00001442 * case_ok() is used to implement case-sensitive import semantics even
1443 * on platforms with case-insensitive filesystems. It's trivial to implement
1444 * for case-sensitive filesystems. It's pretty much a cross-platform
1445 * nightmare for systems with case-insensitive filesystems.
1446 */
Guido van Rossum0980bd91998-02-13 17:18:36 +00001447
Tim Peters50d8d372001-02-28 05:34:27 +00001448/* First we may need a pile of platform-specific header files; the sequence
1449 * of #if's here should match the sequence in the body of case_ok().
1450 */
Jason Tishler7961aa62005-05-20 00:56:54 +00001451#if defined(MS_WINDOWS)
Guido van Rossum0980bd91998-02-13 17:18:36 +00001452#include <windows.h>
Guido van Rossum4c3f57c2001-01-10 20:40:46 +00001453
Tim Peters50d8d372001-02-28 05:34:27 +00001454#elif defined(DJGPP)
1455#include <dir.h>
1456
Jason Tishler7961aa62005-05-20 00:56:54 +00001457#elif (defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) && defined(HAVE_DIRENT_H)
Tim Peters430f5d42001-03-01 01:30:56 +00001458#include <sys/types.h>
1459#include <dirent.h>
1460
Andrew MacIntyred9400542002-02-26 11:41:34 +00001461#elif defined(PYOS_OS2)
1462#define INCL_DOS
1463#define INCL_DOSERRORS
1464#define INCL_NOPMAPI
1465#include <os2.h>
Tim Peters50d8d372001-02-28 05:34:27 +00001466#endif
1467
Guido van Rossum0980bd91998-02-13 17:18:36 +00001468static int
Martin v. Löwis18e16552006-02-15 17:27:45 +00001469case_ok(char *buf, Py_ssize_t len, Py_ssize_t namelen, char *name)
Guido van Rossum0980bd91998-02-13 17:18:36 +00001470{
Tim Peters50d8d372001-02-28 05:34:27 +00001471/* Pick a platform-specific implementation; the sequence of #if's here should
1472 * match the sequence just above.
1473 */
1474
Jason Tishler7961aa62005-05-20 00:56:54 +00001475/* MS_WINDOWS */
1476#if defined(MS_WINDOWS)
Guido van Rossum0980bd91998-02-13 17:18:36 +00001477 WIN32_FIND_DATA data;
1478 HANDLE h;
Tim Peters50d8d372001-02-28 05:34:27 +00001479
Neil Schemenauer7d4bb9f2001-07-23 16:30:27 +00001480 if (Py_GETENV("PYTHONCASEOK") != NULL)
Guido van Rossum0980bd91998-02-13 17:18:36 +00001481 return 1;
Tim Peters50d8d372001-02-28 05:34:27 +00001482
Guido van Rossum0980bd91998-02-13 17:18:36 +00001483 h = FindFirstFile(buf, &data);
1484 if (h == INVALID_HANDLE_VALUE) {
1485 PyErr_Format(PyExc_NameError,
1486 "Can't find file for module %.100s\n(filename %.300s)",
1487 name, buf);
1488 return 0;
1489 }
1490 FindClose(h);
Tim Peters50d8d372001-02-28 05:34:27 +00001491 return strncmp(data.cFileName, name, namelen) == 0;
1492
1493/* DJGPP */
1494#elif defined(DJGPP)
1495 struct ffblk ffblk;
1496 int done;
1497
Neil Schemenauer7d4bb9f2001-07-23 16:30:27 +00001498 if (Py_GETENV("PYTHONCASEOK") != NULL)
Guido van Rossum323bf5e1998-06-24 03:54:06 +00001499 return 1;
Tim Peters50d8d372001-02-28 05:34:27 +00001500
1501 done = findfirst(buf, &ffblk, FA_ARCH|FA_RDONLY|FA_HIDDEN|FA_DIREC);
1502 if (done) {
Guido van Rossum0980bd91998-02-13 17:18:36 +00001503 PyErr_Format(PyExc_NameError,
Tim Peters50d8d372001-02-28 05:34:27 +00001504 "Can't find file for module %.100s\n(filename %.300s)",
Guido van Rossum0980bd91998-02-13 17:18:36 +00001505 name, buf);
1506 return 0;
1507 }
Tim Peters50d8d372001-02-28 05:34:27 +00001508 return strncmp(ffblk.ff_name, name, namelen) == 0;
Guido van Rossum0980bd91998-02-13 17:18:36 +00001509
Jason Tishler7961aa62005-05-20 00:56:54 +00001510/* new-fangled macintosh (macosx) or Cygwin */
1511#elif (defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) && defined(HAVE_DIRENT_H)
Tim Peters430f5d42001-03-01 01:30:56 +00001512 DIR *dirp;
1513 struct dirent *dp;
Tim Petersd1e87a82001-03-01 18:12:00 +00001514 char dirname[MAXPATHLEN + 1];
1515 const int dirlen = len - namelen - 1; /* don't want trailing SEP */
Tim Peters430f5d42001-03-01 01:30:56 +00001516
Neil Schemenauer7d4bb9f2001-07-23 16:30:27 +00001517 if (Py_GETENV("PYTHONCASEOK") != NULL)
Tim Petersdbe6ebb2001-03-01 08:47:29 +00001518 return 1;
1519
Tim Petersd1e87a82001-03-01 18:12:00 +00001520 /* Copy the dir component into dirname; substitute "." if empty */
1521 if (dirlen <= 0) {
1522 dirname[0] = '.';
1523 dirname[1] = '\0';
Tim Peters430f5d42001-03-01 01:30:56 +00001524 }
1525 else {
Tim Petersd1e87a82001-03-01 18:12:00 +00001526 assert(dirlen <= MAXPATHLEN);
1527 memcpy(dirname, buf, dirlen);
1528 dirname[dirlen] = '\0';
Tim Peters430f5d42001-03-01 01:30:56 +00001529 }
1530 /* Open the directory and search the entries for an exact match. */
Tim Petersd1e87a82001-03-01 18:12:00 +00001531 dirp = opendir(dirname);
Tim Peters430f5d42001-03-01 01:30:56 +00001532 if (dirp) {
Tim Peters677898a2001-03-02 03:28:03 +00001533 char *nameWithExt = buf + len - namelen;
Tim Peters430f5d42001-03-01 01:30:56 +00001534 while ((dp = readdir(dirp)) != NULL) {
Tim Petersdbe6ebb2001-03-01 08:47:29 +00001535 const int thislen =
Tim Peters430f5d42001-03-01 01:30:56 +00001536#ifdef _DIRENT_HAVE_D_NAMELEN
Tim Petersdbe6ebb2001-03-01 08:47:29 +00001537 dp->d_namlen;
Tim Peters430f5d42001-03-01 01:30:56 +00001538#else
Tim Petersdbe6ebb2001-03-01 08:47:29 +00001539 strlen(dp->d_name);
Tim Peters430f5d42001-03-01 01:30:56 +00001540#endif
Tim Petersd1e87a82001-03-01 18:12:00 +00001541 if (thislen >= namelen &&
Tim Peters677898a2001-03-02 03:28:03 +00001542 strcmp(dp->d_name, nameWithExt) == 0) {
Tim Peters430f5d42001-03-01 01:30:56 +00001543 (void)closedir(dirp);
1544 return 1; /* Found */
1545 }
1546 }
Tim Petersdbe6ebb2001-03-01 08:47:29 +00001547 (void)closedir(dirp);
Tim Peters430f5d42001-03-01 01:30:56 +00001548 }
Tim Peters430f5d42001-03-01 01:30:56 +00001549 return 0 ; /* Not found */
Tim Peters430f5d42001-03-01 01:30:56 +00001550
Andrew MacIntyred9400542002-02-26 11:41:34 +00001551/* OS/2 */
1552#elif defined(PYOS_OS2)
1553 HDIR hdir = 1;
1554 ULONG srchcnt = 1;
1555 FILEFINDBUF3 ffbuf;
1556 APIRET rc;
1557
1558 if (getenv("PYTHONCASEOK") != NULL)
1559 return 1;
1560
1561 rc = DosFindFirst(buf,
1562 &hdir,
1563 FILE_READONLY | FILE_HIDDEN | FILE_SYSTEM | FILE_DIRECTORY,
1564 &ffbuf, sizeof(ffbuf),
1565 &srchcnt,
1566 FIL_STANDARD);
1567 if (rc != NO_ERROR)
1568 return 0;
1569 return strncmp(ffbuf.achName, name, namelen) == 0;
1570
Tim Peters50d8d372001-02-28 05:34:27 +00001571/* assuming it's a case-sensitive filesystem, so there's nothing to do! */
1572#else
Guido van Rossum0980bd91998-02-13 17:18:36 +00001573 return 1;
Guido van Rossum0980bd91998-02-13 17:18:36 +00001574
Guido van Rossum4d1b3b91998-02-13 23:27:59 +00001575#endif
Tim Peters50d8d372001-02-28 05:34:27 +00001576}
Guido van Rossum4d1b3b91998-02-13 23:27:59 +00001577
Guido van Rossum0980bd91998-02-13 17:18:36 +00001578
Guido van Rossum197346f1997-10-31 18:38:52 +00001579#ifdef HAVE_STAT
1580/* Helper to look for __init__.py or __init__.py[co] in potential package */
1581static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001582find_init_module(char *buf)
Guido van Rossum197346f1997-10-31 18:38:52 +00001583{
Tim Peters0f9431f2001-07-05 03:47:53 +00001584 const size_t save_len = strlen(buf);
Fred Drake4c82b232000-06-30 16:18:57 +00001585 size_t i = save_len;
Tim Peters0f9431f2001-07-05 03:47:53 +00001586 char *pname; /* pointer to start of __init__ */
Guido van Rossum197346f1997-10-31 18:38:52 +00001587 struct stat statbuf;
1588
Tim Peters0f9431f2001-07-05 03:47:53 +00001589/* For calling case_ok(buf, len, namelen, name):
1590 * /a/b/c/d/e/f/g/h/i/j/k/some_long_module_name.py\0
1591 * ^ ^ ^ ^
1592 * |--------------------- buf ---------------------|
1593 * |------------------- len ------------------|
1594 * |------ name -------|
1595 * |----- namelen -----|
1596 */
Guido van Rossum197346f1997-10-31 18:38:52 +00001597 if (save_len + 13 >= MAXPATHLEN)
1598 return 0;
1599 buf[i++] = SEP;
Tim Peters0f9431f2001-07-05 03:47:53 +00001600 pname = buf + i;
1601 strcpy(pname, "__init__.py");
Guido van Rossum197346f1997-10-31 18:38:52 +00001602 if (stat(buf, &statbuf) == 0) {
Tim Peters0f9431f2001-07-05 03:47:53 +00001603 if (case_ok(buf,
1604 save_len + 9, /* len("/__init__") */
1605 8, /* len("__init__") */
1606 pname)) {
1607 buf[save_len] = '\0';
1608 return 1;
1609 }
Guido van Rossum197346f1997-10-31 18:38:52 +00001610 }
Tim Peters0f9431f2001-07-05 03:47:53 +00001611 i += strlen(pname);
1612 strcpy(buf+i, Py_OptimizeFlag ? "o" : "c");
Guido van Rossum197346f1997-10-31 18:38:52 +00001613 if (stat(buf, &statbuf) == 0) {
Tim Peters0f9431f2001-07-05 03:47:53 +00001614 if (case_ok(buf,
1615 save_len + 9, /* len("/__init__") */
1616 8, /* len("__init__") */
1617 pname)) {
1618 buf[save_len] = '\0';
1619 return 1;
1620 }
Guido van Rossum197346f1997-10-31 18:38:52 +00001621 }
1622 buf[save_len] = '\0';
1623 return 0;
1624}
Guido van Rossum48a680c2001-03-02 06:34:14 +00001625
Guido van Rossum197346f1997-10-31 18:38:52 +00001626#endif /* HAVE_STAT */
1627
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001628
Tim Petersdbd9ba62000-07-09 03:09:57 +00001629static int init_builtin(char *); /* Forward */
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001630
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001631/* Load an external module using the default search path and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001632 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001633
Guido van Rossum79f25d91997-04-29 20:08:16 +00001634static PyObject *
Just van Rossum52e14d62002-12-30 22:08:05 +00001635load_module(char *name, FILE *fp, char *buf, int type, PyObject *loader)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001636{
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001637 PyObject *modules;
Guido van Rossum79f25d91997-04-29 20:08:16 +00001638 PyObject *m;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001639 int err;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001640
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001641 /* First check that there's an open file (if we need one) */
1642 switch (type) {
1643 case PY_SOURCE:
1644 case PY_COMPILED:
1645 if (fp == NULL) {
1646 PyErr_Format(PyExc_ValueError,
1647 "file object required for import (type code %d)",
1648 type);
1649 return NULL;
1650 }
1651 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001652
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001653 switch (type) {
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001654
1655 case PY_SOURCE:
1656 m = load_source_module(name, buf, fp);
1657 break;
1658
1659 case PY_COMPILED:
1660 m = load_compiled_module(name, buf, fp);
1661 break;
1662
Guido van Rossum96a8fb71999-12-22 14:09:35 +00001663#ifdef HAVE_DYNAMIC_LOADING
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001664 case C_EXTENSION:
Guido van Rossum79f25d91997-04-29 20:08:16 +00001665 m = _PyImport_LoadDynamicModule(name, buf, fp);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001666 break;
Guido van Rossum96a8fb71999-12-22 14:09:35 +00001667#endif
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001668
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001669 case PKG_DIRECTORY:
1670 m = load_package(name, buf);
1671 break;
1672
1673 case C_BUILTIN:
1674 case PY_FROZEN:
Guido van Rossuma5568d31998-03-05 03:45:08 +00001675 if (buf != NULL && buf[0] != '\0')
1676 name = buf;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001677 if (type == C_BUILTIN)
1678 err = init_builtin(name);
1679 else
1680 err = PyImport_ImportFrozenModule(name);
1681 if (err < 0)
Guido van Rossuma86f77d1997-09-09 18:53:47 +00001682 return NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001683 if (err == 0) {
1684 PyErr_Format(PyExc_ImportError,
1685 "Purported %s module %.200s not found",
1686 type == C_BUILTIN ?
1687 "builtin" : "frozen",
1688 name);
Guido van Rossuma86f77d1997-09-09 18:53:47 +00001689 return NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001690 }
1691 modules = PyImport_GetModuleDict();
1692 m = PyDict_GetItemString(modules, name);
1693 if (m == NULL) {
1694 PyErr_Format(
1695 PyExc_ImportError,
1696 "%s module %.200s not properly initialized",
1697 type == C_BUILTIN ?
1698 "builtin" : "frozen",
1699 name);
Guido van Rossuma86f77d1997-09-09 18:53:47 +00001700 return NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001701 }
1702 Py_INCREF(m);
1703 break;
1704
Just van Rossum52e14d62002-12-30 22:08:05 +00001705 case IMP_HOOK: {
1706 if (loader == NULL) {
1707 PyErr_SetString(PyExc_ImportError,
1708 "import hook without loader");
1709 return NULL;
1710 }
1711 m = PyObject_CallMethod(loader, "load_module", "s", name);
1712 break;
1713 }
1714
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001715 default:
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001716 PyErr_Format(PyExc_ImportError,
1717 "Don't know how to import %.200s (type code %d)",
1718 name, type);
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001719 m = NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001720
1721 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001722
1723 return m;
1724}
1725
1726
1727/* Initialize a built-in module.
Thomas Wouters89f507f2006-12-13 04:49:30 +00001728 Return 1 for success, 0 if the module is not found, and -1 with
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001729 an exception set if the initialization failed. */
Guido van Rossum7f133ed1991-02-19 12:23:57 +00001730
Guido van Rossum7f133ed1991-02-19 12:23:57 +00001731static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001732init_builtin(char *name)
Guido van Rossum7f133ed1991-02-19 12:23:57 +00001733{
Guido van Rossum25ce5661997-08-02 03:10:38 +00001734 struct _inittab *p;
Guido van Rossum25ce5661997-08-02 03:10:38 +00001735
Greg Ward201baee2001-10-04 14:52:06 +00001736 if (_PyImport_FindExtension(name, name) != NULL)
Guido van Rossum25ce5661997-08-02 03:10:38 +00001737 return 1;
1738
Guido van Rossum771c6c81997-10-31 18:37:24 +00001739 for (p = PyImport_Inittab; p->name != NULL; p++) {
Guido van Rossum25ce5661997-08-02 03:10:38 +00001740 if (strcmp(name, p->name) == 0) {
1741 if (p->initfunc == NULL) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001742 PyErr_Format(PyExc_ImportError,
1743 "Cannot re-init internal module %.200s",
1744 name);
Guido van Rossum74e6a111994-08-29 12:54:38 +00001745 return -1;
1746 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00001747 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +00001748 PySys_WriteStderr("import %s # builtin\n", name);
Guido van Rossum25ce5661997-08-02 03:10:38 +00001749 (*p->initfunc)();
Guido van Rossum79f25d91997-04-29 20:08:16 +00001750 if (PyErr_Occurred())
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001751 return -1;
Guido van Rossum25ce5661997-08-02 03:10:38 +00001752 if (_PyImport_FixupExtension(name, name) == NULL)
1753 return -1;
Guido van Rossum7f133ed1991-02-19 12:23:57 +00001754 return 1;
1755 }
1756 }
1757 return 0;
1758}
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001759
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001760
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001761/* Frozen modules */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001762
Guido van Rossumcfd0a221996-06-17 17:06:34 +00001763static struct _frozen *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001764find_frozen(char *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001765{
Guido van Rossumcfd0a221996-06-17 17:06:34 +00001766 struct _frozen *p;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001767
Guido van Rossum79f25d91997-04-29 20:08:16 +00001768 for (p = PyImport_FrozenModules; ; p++) {
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001769 if (p->name == NULL)
1770 return NULL;
1771 if (strcmp(p->name, name) == 0)
1772 break;
1773 }
1774 return p;
1775}
1776
Guido van Rossum79f25d91997-04-29 20:08:16 +00001777static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001778get_frozen_object(char *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001779{
Guido van Rossumcfd0a221996-06-17 17:06:34 +00001780 struct _frozen *p = find_frozen(name);
Guido van Rossuma5568d31998-03-05 03:45:08 +00001781 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001782
1783 if (p == NULL) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001784 PyErr_Format(PyExc_ImportError,
1785 "No such frozen object named %.200s",
1786 name);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001787 return NULL;
1788 }
Guido van Rossum8f4d3312001-10-18 18:54:11 +00001789 if (p->code == NULL) {
1790 PyErr_Format(PyExc_ImportError,
1791 "Excluded frozen object named %.200s",
1792 name);
1793 return NULL;
1794 }
Guido van Rossuma5568d31998-03-05 03:45:08 +00001795 size = p->size;
1796 if (size < 0)
1797 size = -size;
1798 return PyMarshal_ReadObjectFromString((char *)p->code, size);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001799}
1800
1801/* Initialize a frozen module.
1802 Return 1 for succes, 0 if the module is not found, and -1 with
1803 an exception set if the initialization failed.
1804 This function is also used from frozenmain.c */
Guido van Rossum0b344901995-02-07 15:35:27 +00001805
1806int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001807PyImport_ImportFrozenModule(char *name)
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001808{
Guido van Rossumcfd0a221996-06-17 17:06:34 +00001809 struct _frozen *p = find_frozen(name);
Guido van Rossum79f25d91997-04-29 20:08:16 +00001810 PyObject *co;
1811 PyObject *m;
Guido van Rossuma5568d31998-03-05 03:45:08 +00001812 int ispackage;
1813 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001814
1815 if (p == NULL)
1816 return 0;
Guido van Rossum8f4d3312001-10-18 18:54:11 +00001817 if (p->code == NULL) {
1818 PyErr_Format(PyExc_ImportError,
1819 "Excluded frozen object named %.200s",
1820 name);
1821 return -1;
1822 }
Guido van Rossuma5568d31998-03-05 03:45:08 +00001823 size = p->size;
1824 ispackage = (size < 0);
1825 if (ispackage)
1826 size = -size;
Guido van Rossum79f25d91997-04-29 20:08:16 +00001827 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +00001828 PySys_WriteStderr("import %s # frozen%s\n",
Guido van Rossuma5568d31998-03-05 03:45:08 +00001829 name, ispackage ? " package" : "");
1830 co = PyMarshal_ReadObjectFromString((char *)p->code, size);
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001831 if (co == NULL)
1832 return -1;
Guido van Rossum79f25d91997-04-29 20:08:16 +00001833 if (!PyCode_Check(co)) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001834 PyErr_Format(PyExc_TypeError,
1835 "frozen object %.200s is not a code object",
1836 name);
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001837 goto err_return;
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001838 }
Guido van Rossuma5568d31998-03-05 03:45:08 +00001839 if (ispackage) {
1840 /* Set __path__ to the package name */
1841 PyObject *d, *s;
1842 int err;
1843 m = PyImport_AddModule(name);
1844 if (m == NULL)
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001845 goto err_return;
Guido van Rossuma5568d31998-03-05 03:45:08 +00001846 d = PyModule_GetDict(m);
Martin v. Löwis5b222132007-06-10 09:51:05 +00001847 s = PyUnicode_InternFromString(name);
Guido van Rossuma5568d31998-03-05 03:45:08 +00001848 if (s == NULL)
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001849 goto err_return;
Guido van Rossuma5568d31998-03-05 03:45:08 +00001850 err = PyDict_SetItemString(d, "__path__", s);
1851 Py_DECREF(s);
1852 if (err != 0)
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001853 goto err_return;
Guido van Rossuma5568d31998-03-05 03:45:08 +00001854 }
Guido van Rossume32bf6e1998-02-11 05:53:02 +00001855 m = PyImport_ExecCodeModuleEx(name, co, "<frozen>");
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001856 if (m == NULL)
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001857 goto err_return;
1858 Py_DECREF(co);
Guido van Rossum79f25d91997-04-29 20:08:16 +00001859 Py_DECREF(m);
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001860 return 1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001861err_return:
1862 Py_DECREF(co);
1863 return -1;
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001864}
Guido van Rossum74e6a111994-08-29 12:54:38 +00001865
1866
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001867/* Import a module, either built-in, frozen, or external, and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001868 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum74e6a111994-08-29 12:54:38 +00001869
Guido van Rossum79f25d91997-04-29 20:08:16 +00001870PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001871PyImport_ImportModule(const char *name)
Guido van Rossum74e6a111994-08-29 12:54:38 +00001872{
Marc-André Lemburg3c61c352001-02-09 19:40:15 +00001873 PyObject *pname;
1874 PyObject *result;
1875
Martin v. Löwis5b222132007-06-10 09:51:05 +00001876 pname = PyUnicode_FromString(name);
Neal Norwitza11e4c12003-03-23 14:31:01 +00001877 if (pname == NULL)
1878 return NULL;
Marc-André Lemburg3c61c352001-02-09 19:40:15 +00001879 result = PyImport_Import(pname);
1880 Py_DECREF(pname);
1881 return result;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001882}
1883
Guido van Rossum17fc85f1997-09-06 18:52:03 +00001884/* Forward declarations for helper routines */
Thomas Woutersf7f438b2006-02-28 16:09:29 +00001885static PyObject *get_parent(PyObject *globals, char *buf,
1886 Py_ssize_t *p_buflen, int level);
Tim Petersdbd9ba62000-07-09 03:09:57 +00001887static PyObject *load_next(PyObject *mod, PyObject *altmod,
Martin v. Löwis18e16552006-02-15 17:27:45 +00001888 char **p_name, char *buf, Py_ssize_t *p_buflen);
Tim Petersdbd9ba62000-07-09 03:09:57 +00001889static int mark_miss(char *name);
1890static int ensure_fromlist(PyObject *mod, PyObject *fromlist,
Martin v. Löwis18e16552006-02-15 17:27:45 +00001891 char *buf, Py_ssize_t buflen, int recursive);
Tim Petersdbd9ba62000-07-09 03:09:57 +00001892static PyObject * import_submodule(PyObject *mod, char *name, char *fullname);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00001893
1894/* The Magnum Opus of dotted-name import :-) */
1895
Guido van Rossum75acc9c1998-03-03 22:26:50 +00001896static PyObject *
Thomas Woutersf7f438b2006-02-28 16:09:29 +00001897import_module_level(char *name, PyObject *globals, PyObject *locals,
1898 PyObject *fromlist, int level)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001899{
Guido van Rossum17fc85f1997-09-06 18:52:03 +00001900 char buf[MAXPATHLEN+1];
Martin v. Löwis18e16552006-02-15 17:27:45 +00001901 Py_ssize_t buflen = 0;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00001902 PyObject *parent, *head, *next, *tail;
1903
Thomas Woutersf7f438b2006-02-28 16:09:29 +00001904 parent = get_parent(globals, buf, &buflen, level);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00001905 if (parent == NULL)
1906 return NULL;
1907
1908 head = load_next(parent, Py_None, &name, buf, &buflen);
1909 if (head == NULL)
1910 return NULL;
1911
1912 tail = head;
1913 Py_INCREF(tail);
1914 while (name) {
1915 next = load_next(tail, tail, &name, buf, &buflen);
1916 Py_DECREF(tail);
1917 if (next == NULL) {
1918 Py_DECREF(head);
1919 return NULL;
1920 }
1921 tail = next;
1922 }
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001923 if (tail == Py_None) {
1924 /* If tail is Py_None, both get_parent and load_next found
1925 an empty module name: someone called __import__("") or
1926 doctored faulty bytecode */
1927 Py_DECREF(tail);
1928 Py_DECREF(head);
1929 PyErr_SetString(PyExc_ValueError,
1930 "Empty module name");
1931 return NULL;
1932 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00001933
1934 if (fromlist != NULL) {
1935 if (fromlist == Py_None || !PyObject_IsTrue(fromlist))
1936 fromlist = NULL;
1937 }
1938
1939 if (fromlist == NULL) {
1940 Py_DECREF(tail);
1941 return head;
1942 }
1943
1944 Py_DECREF(head);
Guido van Rossum9905ef91997-09-08 16:07:11 +00001945 if (!ensure_fromlist(tail, fromlist, buf, buflen, 0)) {
Guido van Rossum17fc85f1997-09-06 18:52:03 +00001946 Py_DECREF(tail);
1947 return NULL;
1948 }
1949
1950 return tail;
1951}
1952
Thomas Woutersf7f438b2006-02-28 16:09:29 +00001953/* For DLL compatibility */
1954#undef PyImport_ImportModuleEx
Guido van Rossum75acc9c1998-03-03 22:26:50 +00001955PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001956PyImport_ImportModuleEx(char *name, PyObject *globals, PyObject *locals,
1957 PyObject *fromlist)
Guido van Rossum75acc9c1998-03-03 22:26:50 +00001958{
1959 PyObject *result;
1960 lock_import();
Thomas Woutersf7f438b2006-02-28 16:09:29 +00001961 result = import_module_level(name, globals, locals, fromlist, -1);
1962 if (unlock_import() < 0) {
1963 Py_XDECREF(result);
1964 PyErr_SetString(PyExc_RuntimeError,
1965 "not holding the import lock");
1966 return NULL;
1967 }
1968 return result;
1969}
1970#define PyImport_ImportModuleEx(n, g, l, f) \
1971 PyImport_ImportModuleLevel(n, g, l, f, -1);
1972
1973PyObject *
1974PyImport_ImportModuleLevel(char *name, PyObject *globals, PyObject *locals,
1975 PyObject *fromlist, int level)
1976{
1977 PyObject *result;
1978 lock_import();
1979 result = import_module_level(name, globals, locals, fromlist, level);
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00001980 if (unlock_import() < 0) {
1981 Py_XDECREF(result);
1982 PyErr_SetString(PyExc_RuntimeError,
1983 "not holding the import lock");
1984 return NULL;
1985 }
Guido van Rossum75acc9c1998-03-03 22:26:50 +00001986 return result;
1987}
1988
Fred Drake87590902004-05-28 20:21:36 +00001989/* Return the package that an import is being performed in. If globals comes
1990 from the module foo.bar.bat (not itself a package), this returns the
1991 sys.modules entry for foo.bar. If globals is from a package's __init__.py,
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00001992 the package's entry in sys.modules is returned, as a borrowed reference.
Fred Drake87590902004-05-28 20:21:36 +00001993
1994 The *name* of the returned package is returned in buf, with the length of
1995 the name in *p_buflen.
1996
1997 If globals doesn't come from a package or a module in a package, or a
1998 corresponding entry is not found in sys.modules, Py_None is returned.
1999*/
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002000static PyObject *
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002001get_parent(PyObject *globals, char *buf, Py_ssize_t *p_buflen, int level)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002002{
2003 static PyObject *namestr = NULL;
2004 static PyObject *pathstr = NULL;
2005 PyObject *modname, *modpath, *modules, *parent;
2006
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002007 if (globals == NULL || !PyDict_Check(globals) || !level)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002008 return Py_None;
2009
2010 if (namestr == NULL) {
Martin v. Löwis5b222132007-06-10 09:51:05 +00002011 namestr = PyUnicode_InternFromString("__name__");
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002012 if (namestr == NULL)
2013 return NULL;
2014 }
2015 if (pathstr == NULL) {
Martin v. Löwis5b222132007-06-10 09:51:05 +00002016 pathstr = PyUnicode_InternFromString("__path__");
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002017 if (pathstr == NULL)
2018 return NULL;
2019 }
2020
2021 *buf = '\0';
2022 *p_buflen = 0;
2023 modname = PyDict_GetItem(globals, namestr);
Neal Norwitz80e7f272007-08-26 06:45:23 +00002024 if (modname == NULL || !PyUnicode_Check(modname))
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002025 return Py_None;
2026
2027 modpath = PyDict_GetItem(globals, pathstr);
2028 if (modpath != NULL) {
Neal Norwitz80e7f272007-08-26 06:45:23 +00002029 Py_ssize_t len = PyUnicode_GET_SIZE(modname);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002030 if (len > MAXPATHLEN) {
2031 PyErr_SetString(PyExc_ValueError,
2032 "Module name too long");
2033 return NULL;
2034 }
Neal Norwitz80e7f272007-08-26 06:45:23 +00002035 strcpy(buf, PyUnicode_AsString(modname));
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002036 }
2037 else {
Neal Norwitz80e7f272007-08-26 06:45:23 +00002038 char *start = PyUnicode_AsString(modname);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002039 char *lastdot = strrchr(start, '.');
Fred Drake4c82b232000-06-30 16:18:57 +00002040 size_t len;
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002041 if (lastdot == NULL && level > 0) {
2042 PyErr_SetString(PyExc_ValueError,
Thomas Wouters89f507f2006-12-13 04:49:30 +00002043 "Attempted relative import in non-package");
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002044 return NULL;
2045 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002046 if (lastdot == NULL)
2047 return Py_None;
2048 len = lastdot - start;
2049 if (len >= MAXPATHLEN) {
2050 PyErr_SetString(PyExc_ValueError,
2051 "Module name too long");
2052 return NULL;
2053 }
2054 strncpy(buf, start, len);
2055 buf[len] = '\0';
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002056 }
2057
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002058 while (--level > 0) {
2059 char *dot = strrchr(buf, '.');
2060 if (dot == NULL) {
2061 PyErr_SetString(PyExc_ValueError,
Thomas Wouters89f507f2006-12-13 04:49:30 +00002062 "Attempted relative import beyond "
2063 "toplevel package");
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002064 return NULL;
2065 }
2066 *dot = '\0';
2067 }
2068 *p_buflen = strlen(buf);
2069
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002070 modules = PyImport_GetModuleDict();
2071 parent = PyDict_GetItemString(modules, buf);
2072 if (parent == NULL)
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002073 PyErr_Format(PyExc_SystemError,
2074 "Parent module '%.200s' not loaded", buf);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002075 return parent;
2076 /* We expect, but can't guarantee, if parent != None, that:
2077 - parent.__name__ == buf
2078 - parent.__dict__ is globals
2079 If this is violated... Who cares? */
2080}
2081
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002082/* altmod is either None or same as mod */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002083static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002084load_next(PyObject *mod, PyObject *altmod, char **p_name, char *buf,
Martin v. Löwis18e16552006-02-15 17:27:45 +00002085 Py_ssize_t *p_buflen)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002086{
2087 char *name = *p_name;
2088 char *dot = strchr(name, '.');
Fred Drake4c82b232000-06-30 16:18:57 +00002089 size_t len;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002090 char *p;
2091 PyObject *result;
2092
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002093 if (strlen(name) == 0) {
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002094 /* completely empty module name should only happen in
2095 'from . import' (or '__import__("")')*/
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002096 Py_INCREF(mod);
2097 *p_name = NULL;
2098 return mod;
2099 }
2100
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002101 if (dot == NULL) {
2102 *p_name = NULL;
2103 len = strlen(name);
2104 }
2105 else {
2106 *p_name = dot+1;
2107 len = dot-name;
2108 }
Guido van Rossum111c20b1998-04-11 17:38:22 +00002109 if (len == 0) {
2110 PyErr_SetString(PyExc_ValueError,
2111 "Empty module name");
2112 return NULL;
2113 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002114
2115 p = buf + *p_buflen;
2116 if (p != buf)
2117 *p++ = '.';
2118 if (p+len-buf >= MAXPATHLEN) {
2119 PyErr_SetString(PyExc_ValueError,
2120 "Module name too long");
2121 return NULL;
2122 }
2123 strncpy(p, name, len);
2124 p[len] = '\0';
2125 *p_buflen = p+len-buf;
2126
2127 result = import_submodule(mod, p, buf);
2128 if (result == Py_None && altmod != mod) {
2129 Py_DECREF(result);
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00002130 /* Here, altmod must be None and mod must not be None */
Guido van Rossum0c819451997-09-07 06:16:57 +00002131 result = import_submodule(altmod, p, p);
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00002132 if (result != NULL && result != Py_None) {
2133 if (mark_miss(buf) != 0) {
2134 Py_DECREF(result);
2135 return NULL;
2136 }
2137 strncpy(buf, name, len);
2138 buf[len] = '\0';
2139 *p_buflen = len;
2140 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002141 }
2142 if (result == NULL)
2143 return NULL;
2144
2145 if (result == Py_None) {
2146 Py_DECREF(result);
2147 PyErr_Format(PyExc_ImportError,
2148 "No module named %.200s", name);
2149 return NULL;
2150 }
2151
2152 return result;
2153}
2154
2155static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002156mark_miss(char *name)
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00002157{
2158 PyObject *modules = PyImport_GetModuleDict();
2159 return PyDict_SetItemString(modules, name, Py_None);
2160}
2161
2162static int
Martin v. Löwis18e16552006-02-15 17:27:45 +00002163ensure_fromlist(PyObject *mod, PyObject *fromlist, char *buf, Py_ssize_t buflen,
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002164 int recursive)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002165{
2166 int i;
2167
2168 if (!PyObject_HasAttrString(mod, "__path__"))
2169 return 1;
2170
2171 for (i = 0; ; i++) {
2172 PyObject *item = PySequence_GetItem(fromlist, i);
2173 int hasit;
2174 if (item == NULL) {
2175 if (PyErr_ExceptionMatches(PyExc_IndexError)) {
2176 PyErr_Clear();
2177 return 1;
2178 }
2179 return 0;
2180 }
Martin v. Löwis5b222132007-06-10 09:51:05 +00002181 if (!PyUnicode_Check(item)) {
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002182 PyErr_SetString(PyExc_TypeError,
Neal Norwitz80e7f272007-08-26 06:45:23 +00002183 "Item in ``from list'' not a string");
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002184 Py_DECREF(item);
2185 return 0;
2186 }
Martin v. Löwis5b222132007-06-10 09:51:05 +00002187 if (PyUnicode_AS_UNICODE(item)[0] == '*') {
Guido van Rossum9905ef91997-09-08 16:07:11 +00002188 PyObject *all;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002189 Py_DECREF(item);
Guido van Rossum9905ef91997-09-08 16:07:11 +00002190 /* See if the package defines __all__ */
2191 if (recursive)
2192 continue; /* Avoid endless recursion */
2193 all = PyObject_GetAttrString(mod, "__all__");
2194 if (all == NULL)
2195 PyErr_Clear();
2196 else {
Martin v. Löwis83969ee2004-03-23 16:28:13 +00002197 int ret = ensure_fromlist(mod, all, buf, buflen, 1);
Guido van Rossum9905ef91997-09-08 16:07:11 +00002198 Py_DECREF(all);
Martin v. Löwis83969ee2004-03-23 16:28:13 +00002199 if (!ret)
2200 return 0;
Guido van Rossum9905ef91997-09-08 16:07:11 +00002201 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002202 continue;
2203 }
2204 hasit = PyObject_HasAttr(mod, item);
2205 if (!hasit) {
Martin v. Löwis5b222132007-06-10 09:51:05 +00002206 PyObject *item8;
2207 char *subname;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002208 PyObject *submod;
2209 char *p;
Martin v. Löwis5b222132007-06-10 09:51:05 +00002210 if (!Py_FileSystemDefaultEncoding) {
2211 item8 = PyUnicode_EncodeASCII(PyUnicode_AsUnicode(item),
2212 PyUnicode_GetSize(item),
Martin v. Löwis427dbff2007-06-12 05:53:00 +00002213 NULL);
Martin v. Löwis5b222132007-06-10 09:51:05 +00002214 } else {
Martin v. Löwis427dbff2007-06-12 05:53:00 +00002215 item8 = PyUnicode_AsEncodedString(item,
2216 Py_FileSystemDefaultEncoding, NULL);
Martin v. Löwis5b222132007-06-10 09:51:05 +00002217 }
2218 if (!item8) {
2219 PyErr_SetString(PyExc_ValueError, "Cannot encode path item");
2220 return 0;
2221 }
2222 subname = PyBytes_AsString(item8);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002223 if (buflen + strlen(subname) >= MAXPATHLEN) {
2224 PyErr_SetString(PyExc_ValueError,
2225 "Module name too long");
2226 Py_DECREF(item);
2227 return 0;
2228 }
2229 p = buf + buflen;
2230 *p++ = '.';
2231 strcpy(p, subname);
2232 submod = import_submodule(mod, subname, buf);
Martin v. Löwis5b222132007-06-10 09:51:05 +00002233 Py_DECREF(item8);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002234 Py_XDECREF(submod);
2235 if (submod == NULL) {
2236 Py_DECREF(item);
2237 return 0;
2238 }
2239 }
2240 Py_DECREF(item);
2241 }
2242
Guido van Rossuma7f2e811997-10-03 15:33:32 +00002243 /* NOTREACHED */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002244}
2245
Neil Schemenauer00b09662003-06-16 21:03:07 +00002246static int
2247add_submodule(PyObject *mod, PyObject *submod, char *fullname, char *subname,
2248 PyObject *modules)
2249{
2250 if (mod == Py_None)
2251 return 1;
2252 /* Irrespective of the success of this load, make a
2253 reference to it in the parent package module. A copy gets
2254 saved in the modules dictionary under the full name, so get a
2255 reference from there, if need be. (The exception is when the
2256 load failed with a SyntaxError -- then there's no trace in
2257 sys.modules. In that case, of course, do nothing extra.) */
2258 if (submod == NULL) {
2259 submod = PyDict_GetItemString(modules, fullname);
2260 if (submod == NULL)
2261 return 1;
2262 }
2263 if (PyModule_Check(mod)) {
2264 /* We can't use setattr here since it can give a
2265 * spurious warning if the submodule name shadows a
2266 * builtin name */
2267 PyObject *dict = PyModule_GetDict(mod);
2268 if (!dict)
2269 return 0;
2270 if (PyDict_SetItemString(dict, subname, submod) < 0)
2271 return 0;
2272 }
2273 else {
2274 if (PyObject_SetAttrString(mod, subname, submod) < 0)
2275 return 0;
2276 }
2277 return 1;
2278}
2279
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002280static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002281import_submodule(PyObject *mod, char *subname, char *fullname)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002282{
Guido van Rossum25ce5661997-08-02 03:10:38 +00002283 PyObject *modules = PyImport_GetModuleDict();
Neil Schemenauer00b09662003-06-16 21:03:07 +00002284 PyObject *m = NULL;
Guido van Rossum74e6a111994-08-29 12:54:38 +00002285
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002286 /* Require:
2287 if mod == None: subname == fullname
2288 else: mod.__name__ + "." + subname == fullname
2289 */
2290
Tim Peters50d8d372001-02-28 05:34:27 +00002291 if ((m = PyDict_GetItemString(modules, fullname)) != NULL) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00002292 Py_INCREF(m);
Guido van Rossum7f9fa971995-01-20 16:53:12 +00002293 }
2294 else {
Just van Rossum52e14d62002-12-30 22:08:05 +00002295 PyObject *path, *loader = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002296 char buf[MAXPATHLEN+1];
2297 struct filedescr *fdp;
2298 FILE *fp = NULL;
2299
Guido van Rossum9c0afe51998-05-19 15:09:05 +00002300 if (mod == Py_None)
2301 path = NULL;
2302 else {
2303 path = PyObject_GetAttrString(mod, "__path__");
2304 if (path == NULL) {
2305 PyErr_Clear();
2306 Py_INCREF(Py_None);
2307 return Py_None;
2308 }
2309 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002310
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002311 buf[0] = '\0';
Just van Rossum52e14d62002-12-30 22:08:05 +00002312 fdp = find_module(fullname, subname, path, buf, MAXPATHLEN+1,
2313 &fp, &loader);
Guido van Rossumb68cd421998-07-01 17:36:26 +00002314 Py_XDECREF(path);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002315 if (fdp == NULL) {
2316 if (!PyErr_ExceptionMatches(PyExc_ImportError))
2317 return NULL;
2318 PyErr_Clear();
2319 Py_INCREF(Py_None);
2320 return Py_None;
2321 }
Just van Rossum52e14d62002-12-30 22:08:05 +00002322 m = load_module(fullname, fp, buf, fdp->type, loader);
2323 Py_XDECREF(loader);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002324 if (fp)
2325 fclose(fp);
Neil Schemenauer00b09662003-06-16 21:03:07 +00002326 if (!add_submodule(mod, m, fullname, subname, modules)) {
2327 Py_XDECREF(m);
2328 m = NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002329 }
Guido van Rossum74e6a111994-08-29 12:54:38 +00002330 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002331
2332 return m;
Guido van Rossum74e6a111994-08-29 12:54:38 +00002333}
2334
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002335
2336/* Re-import a module of any kind and return its module object, WITH
2337 INCREMENTED REFERENCE COUNT */
2338
Guido van Rossum79f25d91997-04-29 20:08:16 +00002339PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002340PyImport_ReloadModule(PyObject *m)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002341{
Guido van Rossumd8faa362007-04-27 19:54:29 +00002342 PyInterpreterState *interp = PyThreadState_Get()->interp;
2343 PyObject *modules_reloading = interp->modules_reloading;
Guido van Rossum25ce5661997-08-02 03:10:38 +00002344 PyObject *modules = PyImport_GetModuleDict();
Guido van Rossumd8faa362007-04-27 19:54:29 +00002345 PyObject *path = NULL, *loader = NULL, *existing_m = NULL;
Guido van Rossum222ef561997-09-06 19:41:09 +00002346 char *name, *subname;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002347 char buf[MAXPATHLEN+1];
2348 struct filedescr *fdp;
2349 FILE *fp = NULL;
Tim Peters1cd70172004-08-02 03:52:12 +00002350 PyObject *newm;
Guido van Rossumd8faa362007-04-27 19:54:29 +00002351
2352 if (modules_reloading == NULL) {
2353 Py_FatalError("PyImport_ReloadModule: "
Guido van Rossume7ba4952007-06-06 23:52:48 +00002354 "no modules_reloading dictionary!");
Guido van Rossumd8faa362007-04-27 19:54:29 +00002355 return NULL;
2356 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002357
Guido van Rossum79f25d91997-04-29 20:08:16 +00002358 if (m == NULL || !PyModule_Check(m)) {
2359 PyErr_SetString(PyExc_TypeError,
2360 "reload() argument must be module");
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002361 return NULL;
2362 }
Neal Norwitz5616c6d2007-08-26 05:32:41 +00002363 name = (char*)PyModule_GetName(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002364 if (name == NULL)
2365 return NULL;
Guido van Rossum25ce5661997-08-02 03:10:38 +00002366 if (m != PyDict_GetItemString(modules, name)) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002367 PyErr_Format(PyExc_ImportError,
2368 "reload(): module %.200s not in sys.modules",
2369 name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002370 return NULL;
2371 }
Guido van Rossumd8faa362007-04-27 19:54:29 +00002372 existing_m = PyDict_GetItemString(modules_reloading, name);
2373 if (existing_m != NULL) {
2374 /* Due to a recursive reload, this module is already
2375 being reloaded. */
2376 Py_INCREF(existing_m);
2377 return existing_m;
2378 }
2379 if (PyDict_SetItemString(modules_reloading, name, m) < 0)
2380 return NULL;
2381
Guido van Rossum222ef561997-09-06 19:41:09 +00002382 subname = strrchr(name, '.');
2383 if (subname == NULL)
2384 subname = name;
2385 else {
2386 PyObject *parentname, *parent;
2387 parentname = PyString_FromStringAndSize(name, (subname-name));
Guido van Rossumd8faa362007-04-27 19:54:29 +00002388 if (parentname == NULL) {
2389 imp_modules_reloading_clear();
Guido van Rossum222ef561997-09-06 19:41:09 +00002390 return NULL;
Guido van Rossumd8faa362007-04-27 19:54:29 +00002391 }
Guido van Rossum222ef561997-09-06 19:41:09 +00002392 parent = PyDict_GetItem(modules, parentname);
2393 if (parent == NULL) {
2394 PyErr_Format(PyExc_ImportError,
2395 "reload(): parent %.200s not in sys.modules",
Georg Brandl0c55f292005-09-14 06:56:20 +00002396 PyString_AS_STRING(parentname));
2397 Py_DECREF(parentname);
Guido van Rossume7ba4952007-06-06 23:52:48 +00002398 imp_modules_reloading_clear();
Guido van Rossum222ef561997-09-06 19:41:09 +00002399 return NULL;
2400 }
Georg Brandl0c55f292005-09-14 06:56:20 +00002401 Py_DECREF(parentname);
Guido van Rossum222ef561997-09-06 19:41:09 +00002402 subname++;
2403 path = PyObject_GetAttrString(parent, "__path__");
2404 if (path == NULL)
2405 PyErr_Clear();
2406 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002407 buf[0] = '\0';
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00002408 fdp = find_module(name, subname, path, buf, MAXPATHLEN+1, &fp, &loader);
Guido van Rossum222ef561997-09-06 19:41:09 +00002409 Py_XDECREF(path);
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00002410
2411 if (fdp == NULL) {
2412 Py_XDECREF(loader);
Guido van Rossumd8faa362007-04-27 19:54:29 +00002413 imp_modules_reloading_clear();
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002414 return NULL;
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00002415 }
2416
2417 newm = load_module(name, fp, buf, fdp->type, loader);
2418 Py_XDECREF(loader);
2419
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002420 if (fp)
2421 fclose(fp);
Tim Peters1cd70172004-08-02 03:52:12 +00002422 if (newm == NULL) {
2423 /* load_module probably removed name from modules because of
2424 * the error. Put back the original module object. We're
2425 * going to return NULL in this case regardless of whether
2426 * replacing name succeeds, so the return value is ignored.
2427 */
2428 PyDict_SetItemString(modules, name, m);
2429 }
Guido van Rossumd8faa362007-04-27 19:54:29 +00002430 imp_modules_reloading_clear();
Tim Peters1cd70172004-08-02 03:52:12 +00002431 return newm;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002432}
2433
2434
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002435/* Higher-level import emulator which emulates the "import" statement
2436 more accurately -- it invokes the __import__() function from the
2437 builtins of the current globals. This means that the import is
2438 done using whatever import hooks are installed in the current
Guido van Rossum6058eb41998-12-21 19:51:00 +00002439 environment, e.g. by "rexec".
2440 A dummy list ["__doc__"] is passed as the 4th argument so that
Neal Norwitz80e7f272007-08-26 06:45:23 +00002441 e.g. PyImport_Import(PyUnicode_FromString("win32com.client.gencache"))
Guido van Rossum6058eb41998-12-21 19:51:00 +00002442 will return <module "gencache"> instead of <module "win32com">. */
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002443
2444PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002445PyImport_Import(PyObject *module_name)
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002446{
2447 static PyObject *silly_list = NULL;
2448 static PyObject *builtins_str = NULL;
2449 static PyObject *import_str = NULL;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002450 PyObject *globals = NULL;
2451 PyObject *import = NULL;
2452 PyObject *builtins = NULL;
2453 PyObject *r = NULL;
2454
2455 /* Initialize constant string objects */
2456 if (silly_list == NULL) {
Martin v. Löwis5b222132007-06-10 09:51:05 +00002457 import_str = PyUnicode_InternFromString("__import__");
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002458 if (import_str == NULL)
2459 return NULL;
Martin v. Löwis5b222132007-06-10 09:51:05 +00002460 builtins_str = PyUnicode_InternFromString("__builtins__");
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002461 if (builtins_str == NULL)
2462 return NULL;
2463 silly_list = Py_BuildValue("[s]", "__doc__");
2464 if (silly_list == NULL)
2465 return NULL;
2466 }
2467
2468 /* Get the builtins from current globals */
2469 globals = PyEval_GetGlobals();
Guido van Rossum85cd1d62001-02-20 21:43:24 +00002470 if (globals != NULL) {
Guido van Rossum66468561998-10-22 15:46:50 +00002471 Py_INCREF(globals);
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002472 builtins = PyObject_GetItem(globals, builtins_str);
2473 if (builtins == NULL)
2474 goto err;
2475 }
2476 else {
2477 /* No globals -- use standard builtins, and fake globals */
2478 PyErr_Clear();
2479
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002480 builtins = PyImport_ImportModuleLevel("__builtin__",
2481 NULL, NULL, NULL, 0);
Guido van Rossum85cd1d62001-02-20 21:43:24 +00002482 if (builtins == NULL)
2483 return NULL;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002484 globals = Py_BuildValue("{OO}", builtins_str, builtins);
2485 if (globals == NULL)
2486 goto err;
2487 }
2488
2489 /* Get the __import__ function from the builtins */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002490 if (PyDict_Check(builtins)) {
Fred Drakea76ba6e2001-03-06 06:31:15 +00002491 import = PyObject_GetItem(builtins, import_str);
Tim Peters6d6c1a32001-08-02 04:15:00 +00002492 if (import == NULL)
2493 PyErr_SetObject(PyExc_KeyError, import_str);
2494 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002495 else
Fred Drakea76ba6e2001-03-06 06:31:15 +00002496 import = PyObject_GetAttr(builtins, import_str);
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002497 if (import == NULL)
2498 goto err;
2499
Guido van Rossumd8faa362007-04-27 19:54:29 +00002500 /* Call the __import__ function with the proper argument list */
Thomas Wouters477c8d52006-05-27 19:21:47 +00002501 r = PyObject_CallFunctionObjArgs(import, module_name, globals,
2502 globals, silly_list, NULL);
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002503
2504 err:
2505 Py_XDECREF(globals);
2506 Py_XDECREF(builtins);
2507 Py_XDECREF(import);
Tim Peters50d8d372001-02-28 05:34:27 +00002508
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002509 return r;
2510}
2511
2512
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002513/* Module 'imp' provides Python access to the primitives used for
2514 importing modules.
2515*/
2516
Guido van Rossum79f25d91997-04-29 20:08:16 +00002517static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +00002518imp_get_magic(PyObject *self, PyObject *noargs)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002519{
2520 char buf[4];
2521
Guido van Rossum96774c12000-05-01 20:19:08 +00002522 buf[0] = (char) ((pyc_magic >> 0) & 0xff);
2523 buf[1] = (char) ((pyc_magic >> 8) & 0xff);
2524 buf[2] = (char) ((pyc_magic >> 16) & 0xff);
2525 buf[3] = (char) ((pyc_magic >> 24) & 0xff);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002526
Guido van Rossumad8d3002007-08-03 18:40:49 +00002527 return PyBytes_FromStringAndSize(buf, 4);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002528}
2529
Guido van Rossum79f25d91997-04-29 20:08:16 +00002530static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +00002531imp_get_suffixes(PyObject *self, PyObject *noargs)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002532{
Guido van Rossum79f25d91997-04-29 20:08:16 +00002533 PyObject *list;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002534 struct filedescr *fdp;
2535
Guido van Rossum79f25d91997-04-29 20:08:16 +00002536 list = PyList_New(0);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002537 if (list == NULL)
2538 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002539 for (fdp = _PyImport_Filetab; fdp->suffix != NULL; fdp++) {
2540 PyObject *item = Py_BuildValue("ssi",
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002541 fdp->suffix, fdp->mode, fdp->type);
2542 if (item == NULL) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00002543 Py_DECREF(list);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002544 return NULL;
2545 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002546 if (PyList_Append(list, item) < 0) {
2547 Py_DECREF(list);
2548 Py_DECREF(item);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002549 return NULL;
2550 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002551 Py_DECREF(item);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002552 }
2553 return list;
2554}
2555
Guido van Rossum79f25d91997-04-29 20:08:16 +00002556static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002557call_find_module(char *name, PyObject *path)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002558{
Tim Petersdbd9ba62000-07-09 03:09:57 +00002559 extern int fclose(FILE *);
Guido van Rossum79f25d91997-04-29 20:08:16 +00002560 PyObject *fob, *ret;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002561 struct filedescr *fdp;
2562 char pathname[MAXPATHLEN+1];
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002563 FILE *fp = NULL;
Guido van Rossumce3a72a2007-10-19 23:16:50 +00002564 char *encoding = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002565
2566 pathname[0] = '\0';
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002567 if (path == Py_None)
2568 path = NULL;
Just van Rossum52e14d62002-12-30 22:08:05 +00002569 fdp = find_module(NULL, name, path, pathname, MAXPATHLEN+1, &fp, NULL);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002570 if (fdp == NULL)
2571 return NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002572 if (fp != NULL) {
Guido van Rossumce3a72a2007-10-19 23:16:50 +00002573 if (strchr(fdp->mode, 'b') == NULL) {
2574 /* Python text file, get encoding from tokenizer */
2575 encoding = PyTokenizer_FindEncoding(fp);
2576 encoding = (encoding != NULL) ? encoding :
2577 (char*)PyUnicode_GetDefaultEncoding();
2578 }
2579 fob = PyFile_FromFileEx(fp, pathname, fdp->mode, fclose, -1,
2580 (char*)encoding, NULL);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002581 if (fob == NULL) {
2582 fclose(fp);
2583 return NULL;
2584 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002585 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002586 else {
2587 fob = Py_None;
2588 Py_INCREF(fob);
Tim Peters50d8d372001-02-28 05:34:27 +00002589 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002590 ret = Py_BuildValue("Os(ssi)",
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002591 fob, pathname, fdp->suffix, fdp->mode, fdp->type);
Guido van Rossum79f25d91997-04-29 20:08:16 +00002592 Py_DECREF(fob);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002593 return ret;
2594}
2595
Guido van Rossum79f25d91997-04-29 20:08:16 +00002596static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002597imp_find_module(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002598{
2599 char *name;
2600 PyObject *path = NULL;
Guido van Rossum43713e52000-02-29 13:59:29 +00002601 if (!PyArg_ParseTuple(args, "s|O:find_module", &name, &path))
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002602 return NULL;
2603 return call_find_module(name, path);
2604}
2605
2606static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002607imp_init_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002608{
2609 char *name;
2610 int ret;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002611 PyObject *m;
Guido van Rossum43713e52000-02-29 13:59:29 +00002612 if (!PyArg_ParseTuple(args, "s:init_builtin", &name))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002613 return NULL;
2614 ret = init_builtin(name);
2615 if (ret < 0)
2616 return NULL;
2617 if (ret == 0) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00002618 Py_INCREF(Py_None);
2619 return Py_None;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002620 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002621 m = PyImport_AddModule(name);
2622 Py_XINCREF(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002623 return m;
2624}
2625
Guido van Rossum79f25d91997-04-29 20:08:16 +00002626static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002627imp_init_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002628{
2629 char *name;
2630 int ret;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002631 PyObject *m;
Guido van Rossum43713e52000-02-29 13:59:29 +00002632 if (!PyArg_ParseTuple(args, "s:init_frozen", &name))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002633 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002634 ret = PyImport_ImportFrozenModule(name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002635 if (ret < 0)
2636 return NULL;
2637 if (ret == 0) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00002638 Py_INCREF(Py_None);
2639 return Py_None;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002640 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002641 m = PyImport_AddModule(name);
2642 Py_XINCREF(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002643 return m;
2644}
2645
Guido van Rossum79f25d91997-04-29 20:08:16 +00002646static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002647imp_get_frozen_object(PyObject *self, PyObject *args)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002648{
2649 char *name;
Jack Jansen95ffa231995-10-03 14:38:41 +00002650
Guido van Rossum43713e52000-02-29 13:59:29 +00002651 if (!PyArg_ParseTuple(args, "s:get_frozen_object", &name))
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002652 return NULL;
2653 return get_frozen_object(name);
2654}
2655
Guido van Rossum79f25d91997-04-29 20:08:16 +00002656static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002657imp_is_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002658{
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002659 char *name;
Guido van Rossum43713e52000-02-29 13:59:29 +00002660 if (!PyArg_ParseTuple(args, "s:is_builtin", &name))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002661 return NULL;
Guido van Rossum50ee94f2002-04-09 18:00:58 +00002662 return PyInt_FromLong(is_builtin(name));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002663}
2664
Guido van Rossum79f25d91997-04-29 20:08:16 +00002665static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002666imp_is_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002667{
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002668 char *name;
Guido van Rossum323bf5e1998-06-24 03:54:06 +00002669 struct _frozen *p;
Guido van Rossum43713e52000-02-29 13:59:29 +00002670 if (!PyArg_ParseTuple(args, "s:is_frozen", &name))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002671 return NULL;
Guido van Rossum323bf5e1998-06-24 03:54:06 +00002672 p = find_frozen(name);
Guido van Rossumb8bff3f2002-04-07 06:34:38 +00002673 return PyBool_FromLong((long) (p == NULL ? 0 : p->size));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002674}
2675
2676static FILE *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002677get_file(char *pathname, PyObject *fob, char *mode)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002678{
2679 FILE *fp;
Guido van Rossumda5b8f22007-06-12 23:30:11 +00002680 if (mode[0] == 'U')
2681 mode = "r" PY_STDIOTEXTMODE;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002682 if (fob == NULL) {
2683 fp = fopen(pathname, mode);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002684 }
2685 else {
Guido van Rossumda5b8f22007-06-12 23:30:11 +00002686 int fd = PyObject_AsFileDescriptor(fob);
2687 if (fd == -1)
2688 return NULL;
2689 /* XXX This will leak a FILE struct. Fix this!!!!
2690 (But it doesn't leak a file descrioptor!) */
2691 fp = fdopen(fd, mode);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002692 }
Guido van Rossumda5b8f22007-06-12 23:30:11 +00002693 if (fp == NULL)
2694 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002695 return fp;
2696}
2697
Guido van Rossum79f25d91997-04-29 20:08:16 +00002698static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002699imp_load_compiled(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002700{
2701 char *name;
2702 char *pathname;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002703 PyObject *fob = NULL;
2704 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002705 FILE *fp;
Guido van Rossumda5b8f22007-06-12 23:30:11 +00002706 if (!PyArg_ParseTuple(args, "ss|O:load_compiled",
2707 &name, &pathname, &fob))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002708 return NULL;
2709 fp = get_file(pathname, fob, "rb");
2710 if (fp == NULL)
2711 return NULL;
2712 m = load_compiled_module(name, pathname, fp);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002713 if (fob == NULL)
2714 fclose(fp);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002715 return m;
2716}
2717
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002718#ifdef HAVE_DYNAMIC_LOADING
2719
Guido van Rossum79f25d91997-04-29 20:08:16 +00002720static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002721imp_load_dynamic(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002722{
2723 char *name;
2724 char *pathname;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002725 PyObject *fob = NULL;
2726 PyObject *m;
Guido van Rossum7faeab31995-07-07 22:50:36 +00002727 FILE *fp = NULL;
Guido van Rossumda5b8f22007-06-12 23:30:11 +00002728 if (!PyArg_ParseTuple(args, "ss|O:load_dynamic",
2729 &name, &pathname, &fob))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002730 return NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002731 if (fob) {
Guido van Rossum7faeab31995-07-07 22:50:36 +00002732 fp = get_file(pathname, fob, "r");
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002733 if (fp == NULL)
2734 return NULL;
2735 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002736 m = _PyImport_LoadDynamicModule(name, pathname, fp);
Guido van Rossum7faeab31995-07-07 22:50:36 +00002737 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002738}
2739
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002740#endif /* HAVE_DYNAMIC_LOADING */
2741
Guido van Rossum79f25d91997-04-29 20:08:16 +00002742static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002743imp_load_source(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002744{
2745 char *name;
2746 char *pathname;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002747 PyObject *fob = NULL;
2748 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002749 FILE *fp;
Guido van Rossumda5b8f22007-06-12 23:30:11 +00002750 if (!PyArg_ParseTuple(args, "ss|O:load_source",
2751 &name, &pathname, &fob))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002752 return NULL;
2753 fp = get_file(pathname, fob, "r");
2754 if (fp == NULL)
2755 return NULL;
2756 m = load_source_module(name, pathname, fp);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002757 if (fob == NULL)
2758 fclose(fp);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002759 return m;
2760}
2761
Guido van Rossum79f25d91997-04-29 20:08:16 +00002762static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002763imp_load_module(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002764{
2765 char *name;
2766 PyObject *fob;
2767 char *pathname;
2768 char *suffix; /* Unused */
2769 char *mode;
2770 int type;
2771 FILE *fp;
2772
Guido van Rossum43713e52000-02-29 13:59:29 +00002773 if (!PyArg_ParseTuple(args, "sOs(ssi):load_module",
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002774 &name, &fob, &pathname,
2775 &suffix, &mode, &type))
2776 return NULL;
Guido van Rossum5e2c5fa2002-05-30 17:33:07 +00002777 if (*mode) {
2778 /* Mode must start with 'r' or 'U' and must not contain '+'.
2779 Implicit in this test is the assumption that the mode
2780 may contain other modifiers like 'b' or 't'. */
2781
2782 if (!(*mode == 'r' || *mode == 'U') || strchr(mode, '+')) {
Jeremy Hylton4ae6fae2002-05-30 17:15:25 +00002783 PyErr_Format(PyExc_ValueError,
2784 "invalid file open mode %.200s", mode);
2785 return NULL;
Guido van Rossum5e2c5fa2002-05-30 17:33:07 +00002786 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002787 }
2788 if (fob == Py_None)
2789 fp = NULL;
2790 else {
Guido van Rossumda5b8f22007-06-12 23:30:11 +00002791 fp = get_file(NULL, fob, mode);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002792 if (fp == NULL)
2793 return NULL;
2794 }
Just van Rossum52e14d62002-12-30 22:08:05 +00002795 return load_module(name, fp, pathname, type, NULL);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002796}
2797
2798static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002799imp_load_package(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002800{
2801 char *name;
2802 char *pathname;
Guido van Rossum43713e52000-02-29 13:59:29 +00002803 if (!PyArg_ParseTuple(args, "ss:load_package", &name, &pathname))
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002804 return NULL;
2805 return load_package(name, pathname);
2806}
2807
2808static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002809imp_new_module(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002810{
2811 char *name;
Guido van Rossum43713e52000-02-29 13:59:29 +00002812 if (!PyArg_ParseTuple(args, "s:new_module", &name))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002813 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002814 return PyModule_New(name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002815}
2816
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002817/* Doc strings */
2818
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002819PyDoc_STRVAR(doc_imp,
2820"This module provides the components needed to build your own\n\
2821__import__ function. Undocumented functions are obsolete.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002822
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002823PyDoc_STRVAR(doc_find_module,
2824"find_module(name, [path]) -> (file, filename, (suffix, mode, type))\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002825Search for a module. If path is omitted or None, search for a\n\
2826built-in, frozen or special module and continue search in sys.path.\n\
2827The module name cannot contain '.'; to search for a submodule of a\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002828package, pass the submodule name and the package's __path__.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002829
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002830PyDoc_STRVAR(doc_load_module,
2831"load_module(name, file, filename, (suffix, mode, type)) -> module\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002832Load a module, given information returned by find_module().\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002833The module name must include the full package name, if any.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002834
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002835PyDoc_STRVAR(doc_get_magic,
2836"get_magic() -> string\n\
2837Return the magic number for .pyc or .pyo files.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002838
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002839PyDoc_STRVAR(doc_get_suffixes,
2840"get_suffixes() -> [(suffix, mode, type), ...]\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002841Return a list of (suffix, mode, type) tuples describing the files\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002842that find_module() looks for.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002843
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002844PyDoc_STRVAR(doc_new_module,
2845"new_module(name) -> module\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002846Create a new module. Do not enter it in sys.modules.\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002847The module name must include the full package name, if any.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002848
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002849PyDoc_STRVAR(doc_lock_held,
Tim Petersa7c65092004-08-01 23:26:05 +00002850"lock_held() -> boolean\n\
2851Return True if the import lock is currently held, else False.\n\
2852On platforms without threads, return False.");
Tim Peters69232342001-08-30 05:16:13 +00002853
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00002854PyDoc_STRVAR(doc_acquire_lock,
2855"acquire_lock() -> None\n\
Neal Norwitz2294c0d2003-02-12 23:02:21 +00002856Acquires the interpreter's import lock for the current thread.\n\
2857This lock should be used by import hooks to ensure thread-safety\n\
2858when importing modules.\n\
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00002859On platforms without threads, this function does nothing.");
2860
2861PyDoc_STRVAR(doc_release_lock,
2862"release_lock() -> None\n\
2863Release the interpreter's import lock.\n\
2864On platforms without threads, this function does nothing.");
2865
Guido van Rossum79f25d91997-04-29 20:08:16 +00002866static PyMethodDef imp_methods[] = {
Neal Norwitz08ea61a2003-02-17 18:18:00 +00002867 {"find_module", imp_find_module, METH_VARARGS, doc_find_module},
2868 {"get_magic", imp_get_magic, METH_NOARGS, doc_get_magic},
2869 {"get_suffixes", imp_get_suffixes, METH_NOARGS, doc_get_suffixes},
2870 {"load_module", imp_load_module, METH_VARARGS, doc_load_module},
2871 {"new_module", imp_new_module, METH_VARARGS, doc_new_module},
2872 {"lock_held", imp_lock_held, METH_NOARGS, doc_lock_held},
2873 {"acquire_lock", imp_acquire_lock, METH_NOARGS, doc_acquire_lock},
2874 {"release_lock", imp_release_lock, METH_NOARGS, doc_release_lock},
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002875 /* The rest are obsolete */
Neal Norwitz031829d2002-03-31 14:37:44 +00002876 {"get_frozen_object", imp_get_frozen_object, METH_VARARGS},
2877 {"init_builtin", imp_init_builtin, METH_VARARGS},
2878 {"init_frozen", imp_init_frozen, METH_VARARGS},
2879 {"is_builtin", imp_is_builtin, METH_VARARGS},
2880 {"is_frozen", imp_is_frozen, METH_VARARGS},
2881 {"load_compiled", imp_load_compiled, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002882#ifdef HAVE_DYNAMIC_LOADING
Neal Norwitz031829d2002-03-31 14:37:44 +00002883 {"load_dynamic", imp_load_dynamic, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002884#endif
Neal Norwitz031829d2002-03-31 14:37:44 +00002885 {"load_package", imp_load_package, METH_VARARGS},
Neal Norwitz031829d2002-03-31 14:37:44 +00002886 {"load_source", imp_load_source, METH_VARARGS},
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002887 {NULL, NULL} /* sentinel */
2888};
2889
Guido van Rossum1a8791e1998-08-04 22:46:29 +00002890static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002891setint(PyObject *d, char *name, int value)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002892{
2893 PyObject *v;
2894 int err;
2895
2896 v = PyInt_FromLong((long)value);
2897 err = PyDict_SetItemString(d, name, v);
2898 Py_XDECREF(v);
2899 return err;
2900}
2901
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002902typedef struct {
2903 PyObject_HEAD
2904} NullImporter;
2905
2906static int
2907NullImporter_init(NullImporter *self, PyObject *args, PyObject *kwds)
2908{
2909 char *path;
2910
2911 if (!_PyArg_NoKeywords("NullImporter()", kwds))
2912 return -1;
2913
2914 if (!PyArg_ParseTuple(args, "s:NullImporter",
2915 &path))
2916 return -1;
2917
2918 if (strlen(path) == 0) {
2919 PyErr_SetString(PyExc_ImportError, "empty pathname");
2920 return -1;
2921 } else {
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002922 struct stat statbuf;
2923 int rv;
2924
2925 rv = stat(path, &statbuf);
2926 if (rv == 0) {
2927 /* it exists */
2928 if (S_ISDIR(statbuf.st_mode)) {
2929 /* it's a directory */
2930 PyErr_SetString(PyExc_ImportError,
2931 "existing directory");
2932 return -1;
2933 }
2934 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002935 }
2936 return 0;
2937}
2938
2939static PyObject *
2940NullImporter_find_module(NullImporter *self, PyObject *args)
2941{
2942 Py_RETURN_NONE;
2943}
2944
2945static PyMethodDef NullImporter_methods[] = {
2946 {"find_module", (PyCFunction)NullImporter_find_module, METH_VARARGS,
2947 "Always return None"
2948 },
2949 {NULL} /* Sentinel */
2950};
2951
2952
2953static PyTypeObject NullImporterType = {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00002954 PyVarObject_HEAD_INIT(NULL, 0)
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002955 "imp.NullImporter", /*tp_name*/
2956 sizeof(NullImporter), /*tp_basicsize*/
2957 0, /*tp_itemsize*/
2958 0, /*tp_dealloc*/
2959 0, /*tp_print*/
2960 0, /*tp_getattr*/
2961 0, /*tp_setattr*/
2962 0, /*tp_compare*/
2963 0, /*tp_repr*/
2964 0, /*tp_as_number*/
2965 0, /*tp_as_sequence*/
2966 0, /*tp_as_mapping*/
2967 0, /*tp_hash */
2968 0, /*tp_call*/
2969 0, /*tp_str*/
2970 0, /*tp_getattro*/
2971 0, /*tp_setattro*/
2972 0, /*tp_as_buffer*/
2973 Py_TPFLAGS_DEFAULT, /*tp_flags*/
2974 "Null importer object", /* tp_doc */
2975 0, /* tp_traverse */
2976 0, /* tp_clear */
2977 0, /* tp_richcompare */
2978 0, /* tp_weaklistoffset */
2979 0, /* tp_iter */
2980 0, /* tp_iternext */
2981 NullImporter_methods, /* tp_methods */
2982 0, /* tp_members */
2983 0, /* tp_getset */
2984 0, /* tp_base */
2985 0, /* tp_dict */
2986 0, /* tp_descr_get */
2987 0, /* tp_descr_set */
2988 0, /* tp_dictoffset */
2989 (initproc)NullImporter_init, /* tp_init */
2990 0, /* tp_alloc */
2991 PyType_GenericNew /* tp_new */
2992};
2993
2994
Jason Tishler6bc06ec2003-09-04 11:59:50 +00002995PyMODINIT_FUNC
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002996initimp(void)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002997{
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002998 PyObject *m, *d;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002999
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003000 if (PyType_Ready(&NullImporterType) < 0)
3001 goto failure;
3002
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003003 m = Py_InitModule4("imp", imp_methods, doc_imp,
3004 NULL, PYTHON_API_VERSION);
Neal Norwitz1ac754f2006-01-19 06:09:39 +00003005 if (m == NULL)
3006 goto failure;
Guido van Rossum79f25d91997-04-29 20:08:16 +00003007 d = PyModule_GetDict(m);
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00003008 if (d == NULL)
3009 goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003010
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003011 if (setint(d, "SEARCH_ERROR", SEARCH_ERROR) < 0) goto failure;
3012 if (setint(d, "PY_SOURCE", PY_SOURCE) < 0) goto failure;
3013 if (setint(d, "PY_COMPILED", PY_COMPILED) < 0) goto failure;
3014 if (setint(d, "C_EXTENSION", C_EXTENSION) < 0) goto failure;
3015 if (setint(d, "PY_RESOURCE", PY_RESOURCE) < 0) goto failure;
3016 if (setint(d, "PKG_DIRECTORY", PKG_DIRECTORY) < 0) goto failure;
3017 if (setint(d, "C_BUILTIN", C_BUILTIN) < 0) goto failure;
3018 if (setint(d, "PY_FROZEN", PY_FROZEN) < 0) goto failure;
Guido van Rossum0f84a341998-08-06 13:36:01 +00003019 if (setint(d, "PY_CODERESOURCE", PY_CODERESOURCE) < 0) goto failure;
Just van Rossum52e14d62002-12-30 22:08:05 +00003020 if (setint(d, "IMP_HOOK", IMP_HOOK) < 0) goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003021
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003022 Py_INCREF(&NullImporterType);
3023 PyModule_AddObject(m, "NullImporter", (PyObject *)&NullImporterType);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003024 failure:
3025 ;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003026}
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003027
3028
Guido van Rossumb18618d2000-05-03 23:44:39 +00003029/* API for embedding applications that want to add their own entries
3030 to the table of built-in modules. This should normally be called
3031 *before* Py_Initialize(). When the table resize fails, -1 is
3032 returned and the existing table is unchanged.
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003033
3034 After a similar function by Just van Rossum. */
3035
3036int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003037PyImport_ExtendInittab(struct _inittab *newtab)
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003038{
3039 static struct _inittab *our_copy = NULL;
3040 struct _inittab *p;
3041 int i, n;
3042
3043 /* Count the number of entries in both tables */
3044 for (n = 0; newtab[n].name != NULL; n++)
3045 ;
3046 if (n == 0)
3047 return 0; /* Nothing to do */
3048 for (i = 0; PyImport_Inittab[i].name != NULL; i++)
3049 ;
3050
3051 /* Allocate new memory for the combined table */
Guido van Rossumb18618d2000-05-03 23:44:39 +00003052 p = our_copy;
3053 PyMem_RESIZE(p, struct _inittab, i+n+1);
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003054 if (p == NULL)
3055 return -1;
3056
3057 /* Copy the tables into the new memory */
3058 if (our_copy != PyImport_Inittab)
3059 memcpy(p, PyImport_Inittab, (i+1) * sizeof(struct _inittab));
3060 PyImport_Inittab = our_copy = p;
3061 memcpy(p+i, newtab, (n+1) * sizeof(struct _inittab));
3062
3063 return 0;
3064}
3065
3066/* Shorthand to add a single entry given a name and a function */
3067
3068int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003069PyImport_AppendInittab(char *name, void (*initfunc)(void))
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003070{
3071 struct _inittab newtab[2];
3072
3073 memset(newtab, '\0', sizeof newtab);
3074
3075 newtab[0].name = name;
3076 newtab[0].initfunc = initfunc;
3077
3078 return PyImport_ExtendInittab(newtab);
3079}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00003080
3081#ifdef __cplusplus
3082}
3083#endif