blob: a7f6a48d36a315bd0d4c13290fe90722d63693f7 [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)
Christian Heimes99170a52007-12-19 02:07:34 +000069 Python 2.6a0: 62151 (peephole optimizations and STORE_MAP opcode)
Guido van Rossum45aecf42006-03-15 04:58:47 +000070 Python 3000: 3000
Brett Cannone2e23ef2006-08-25 05:05:30 +000071 3010 (removed UNARY_CONVERT)
Guido van Rossum86e58e22006-08-28 15:27:34 +000072 3020 (added BUILD_SET)
Guido van Rossum4f72a782006-10-27 23:31:49 +000073 3030 (added keyword-only parameters)
Guido van Rossum3203bdc2006-12-28 21:03:31 +000074 3040 (added signature annotations)
Guido van Rossum452bf512007-02-09 05:32:43 +000075 3050 (print becomes a function)
Guido van Rossum52cc1d82007-03-18 15:41:51 +000076 3060 (PEP 3115 metaclass syntax)
Guido van Rossum00bc0e02007-10-15 02:52:41 +000077 3070 (PEP 3109 raise changes)
78 3080 (PEP 3137 make __file__ and __name__ unicode)
Guido van Rossum98297ee2007-11-06 21:34:58 +000079 3090 (kill str8 interning)
Christian Heimes99170a52007-12-19 02:07:34 +000080 3100 (merge from 2.6a0, see 62151)
Michael W. Hudsonaee2e282005-10-21 11:32:20 +000081.
Tim Peters36515e22001-11-18 04:06:29 +000082*/
Christian Heimes99170a52007-12-19 02:07:34 +000083#define MAGIC (3100 | ((long)'\r'<<16) | ((long)'\n'<<24))
Guido van Rossum3ddee711991-12-16 13:06:34 +000084
Guido van Rossum96774c12000-05-01 20:19:08 +000085/* Magic word as global; note that _PyImport_Init() can change the
Jeremy Hylton9262b8a2000-06-30 04:59:17 +000086 value of this global to accommodate for alterations of how the
Guido van Rossum96774c12000-05-01 20:19:08 +000087 compiler works which are enabled by command line switches. */
88static long pyc_magic = MAGIC;
89
Guido van Rossum25ce5661997-08-02 03:10:38 +000090/* See _PyImport_FixupExtension() below */
91static PyObject *extensions = NULL;
Guido van Rossum3f5da241990-12-20 15:06:42 +000092
Guido van Rossum771c6c81997-10-31 18:37:24 +000093/* This table is defined in config.c: */
94extern struct _inittab _PyImport_Inittab[];
95
Guido van Rossumce3a72a2007-10-19 23:16:50 +000096/* Method from Parser/tokenizer.c */
Guido van Rossum40d20bc2007-10-22 00:09:51 +000097extern char * PyTokenizer_FindEncoding(int);
Guido van Rossumce3a72a2007-10-19 23:16:50 +000098
Guido van Rossum771c6c81997-10-31 18:37:24 +000099struct _inittab *PyImport_Inittab = _PyImport_Inittab;
Guido van Rossum66f1fa81991-04-03 19:03:52 +0000100
Guido van Rossumed1170e1999-12-20 21:23:41 +0000101/* these tables define the module suffixes that Python recognizes */
102struct filedescr * _PyImport_Filetab = NULL;
Guido van Rossum48a680c2001-03-02 06:34:14 +0000103
Guido van Rossumed1170e1999-12-20 21:23:41 +0000104static const struct filedescr _PyImport_StandardFiletab[] = {
Jack Jansenc88da1f2002-05-28 10:58:19 +0000105 {".py", "U", PY_SOURCE},
Martin v. Löwis6238d2b2002-06-30 15:26:10 +0000106#ifdef MS_WINDOWS
Jack Jansenc88da1f2002-05-28 10:58:19 +0000107 {".pyw", "U", PY_SOURCE},
Tim Peters36515e22001-11-18 04:06:29 +0000108#endif
Guido van Rossumed1170e1999-12-20 21:23:41 +0000109 {".pyc", "rb", PY_COMPILED},
110 {0, 0}
111};
112
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000113
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000114/* Initialize things */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000115
116void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000117_PyImport_Init(void)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000118{
Guido van Rossumed1170e1999-12-20 21:23:41 +0000119 const struct filedescr *scan;
120 struct filedescr *filetab;
121 int countD = 0;
122 int countS = 0;
123
124 /* prepare _PyImport_Filetab: copy entries from
125 _PyImport_DynLoadFiletab and _PyImport_StandardFiletab.
126 */
Guido van Rossum04110fb2007-08-24 16:32:05 +0000127#ifdef HAVE_DYNAMIC_LOADING
Guido van Rossumed1170e1999-12-20 21:23:41 +0000128 for (scan = _PyImport_DynLoadFiletab; scan->suffix != NULL; ++scan)
129 ++countD;
Guido van Rossum04110fb2007-08-24 16:32:05 +0000130#endif
Guido van Rossumed1170e1999-12-20 21:23:41 +0000131 for (scan = _PyImport_StandardFiletab; scan->suffix != NULL; ++scan)
132 ++countS;
Guido van Rossumb18618d2000-05-03 23:44:39 +0000133 filetab = PyMem_NEW(struct filedescr, countD + countS + 1);
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000134 if (filetab == NULL)
135 Py_FatalError("Can't initialize import file table.");
Guido van Rossum04110fb2007-08-24 16:32:05 +0000136#ifdef HAVE_DYNAMIC_LOADING
Guido van Rossumed1170e1999-12-20 21:23:41 +0000137 memcpy(filetab, _PyImport_DynLoadFiletab,
138 countD * sizeof(struct filedescr));
Guido van Rossum04110fb2007-08-24 16:32:05 +0000139#endif
Guido van Rossumed1170e1999-12-20 21:23:41 +0000140 memcpy(filetab + countD, _PyImport_StandardFiletab,
141 countS * sizeof(struct filedescr));
142 filetab[countD + countS].suffix = NULL;
143
144 _PyImport_Filetab = filetab;
145
Guido van Rossum0824f631997-03-11 18:37:35 +0000146 if (Py_OptimizeFlag) {
Guido van Rossumed1170e1999-12-20 21:23:41 +0000147 /* Replace ".pyc" with ".pyo" in _PyImport_Filetab */
148 for (; filetab->suffix != NULL; filetab++) {
149 if (strcmp(filetab->suffix, ".pyc") == 0)
150 filetab->suffix = ".pyo";
Guido van Rossum0824f631997-03-11 18:37:35 +0000151 }
152 }
Guido van Rossum96774c12000-05-01 20:19:08 +0000153
Guido van Rossum572dbf82007-04-27 23:53:51 +0000154 {
Guido van Rossum96774c12000-05-01 20:19:08 +0000155 /* Fix the pyc_magic so that byte compiled code created
156 using the all-Unicode method doesn't interfere with
157 code created in normal operation mode. */
158 pyc_magic = MAGIC + 1;
159 }
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000160}
161
Guido van Rossum25ce5661997-08-02 03:10:38 +0000162void
Just van Rossum52e14d62002-12-30 22:08:05 +0000163_PyImportHooks_Init(void)
164{
165 PyObject *v, *path_hooks = NULL, *zimpimport;
166 int err = 0;
167
168 /* adding sys.path_hooks and sys.path_importer_cache, setting up
169 zipimport */
Christian Heimes9cd17752007-11-18 19:35:23 +0000170 if (PyType_Ready(&PyNullImporter_Type) < 0)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000171 goto error;
Just van Rossum52e14d62002-12-30 22:08:05 +0000172
173 if (Py_VerboseFlag)
174 PySys_WriteStderr("# installing zipimport hook\n");
175
176 v = PyList_New(0);
177 if (v == NULL)
178 goto error;
179 err = PySys_SetObject("meta_path", v);
180 Py_DECREF(v);
181 if (err)
182 goto error;
183 v = PyDict_New();
184 if (v == NULL)
185 goto error;
186 err = PySys_SetObject("path_importer_cache", v);
187 Py_DECREF(v);
188 if (err)
189 goto error;
190 path_hooks = PyList_New(0);
191 if (path_hooks == NULL)
192 goto error;
193 err = PySys_SetObject("path_hooks", path_hooks);
194 if (err) {
195 error:
196 PyErr_Print();
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000197 Py_FatalError("initializing sys.meta_path, sys.path_hooks, "
198 "path_importer_cache, or NullImporter failed"
199 );
Just van Rossum52e14d62002-12-30 22:08:05 +0000200 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000201
Just van Rossum52e14d62002-12-30 22:08:05 +0000202 zimpimport = PyImport_ImportModule("zipimport");
203 if (zimpimport == NULL) {
204 PyErr_Clear(); /* No zip import module -- okay */
205 if (Py_VerboseFlag)
206 PySys_WriteStderr("# can't import zipimport\n");
207 }
208 else {
209 PyObject *zipimporter = PyObject_GetAttrString(zimpimport,
210 "zipimporter");
211 Py_DECREF(zimpimport);
212 if (zipimporter == NULL) {
213 PyErr_Clear(); /* No zipimporter object -- okay */
214 if (Py_VerboseFlag)
215 PySys_WriteStderr(
Fred Drake1e5fc552003-07-11 15:01:02 +0000216 "# can't import zipimport.zipimporter\n");
Just van Rossum52e14d62002-12-30 22:08:05 +0000217 }
218 else {
219 /* sys.path_hooks.append(zipimporter) */
220 err = PyList_Append(path_hooks, zipimporter);
221 Py_DECREF(zipimporter);
222 if (err)
223 goto error;
224 if (Py_VerboseFlag)
225 PySys_WriteStderr(
226 "# installed zipimport hook\n");
227 }
228 }
229 Py_DECREF(path_hooks);
230}
231
232void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000233_PyImport_Fini(void)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000234{
235 Py_XDECREF(extensions);
236 extensions = NULL;
Barry Warsaw84294482000-10-03 16:02:05 +0000237 PyMem_DEL(_PyImport_Filetab);
238 _PyImport_Filetab = NULL;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000239}
240
241
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000242/* Locking primitives to prevent parallel imports of the same module
243 in different threads to return with a partially loaded module.
244 These calls are serialized by the global interpreter lock. */
245
246#ifdef WITH_THREAD
247
Guido van Rossum49b56061998-10-01 20:42:43 +0000248#include "pythread.h"
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000249
Guido van Rossum65d5b571998-12-21 19:32:43 +0000250static PyThread_type_lock import_lock = 0;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000251static long import_lock_thread = -1;
252static int import_lock_level = 0;
253
254static void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000255lock_import(void)
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000256{
Guido van Rossum65d5b571998-12-21 19:32:43 +0000257 long me = PyThread_get_thread_ident();
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000258 if (me == -1)
259 return; /* Too bad */
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000260 if (import_lock == NULL) {
Guido van Rossum65d5b571998-12-21 19:32:43 +0000261 import_lock = PyThread_allocate_lock();
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000262 if (import_lock == NULL)
263 return; /* Nothing much we can do. */
264 }
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000265 if (import_lock_thread == me) {
266 import_lock_level++;
267 return;
268 }
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000269 if (import_lock_thread != -1 || !PyThread_acquire_lock(import_lock, 0))
270 {
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000271 PyThreadState *tstate = PyEval_SaveThread();
Guido van Rossum65d5b571998-12-21 19:32:43 +0000272 PyThread_acquire_lock(import_lock, 1);
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000273 PyEval_RestoreThread(tstate);
274 }
275 import_lock_thread = me;
276 import_lock_level = 1;
277}
278
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000279static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000280unlock_import(void)
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000281{
Guido van Rossum65d5b571998-12-21 19:32:43 +0000282 long me = PyThread_get_thread_ident();
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000283 if (me == -1 || import_lock == NULL)
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000284 return 0; /* Too bad */
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000285 if (import_lock_thread != me)
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000286 return -1;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000287 import_lock_level--;
288 if (import_lock_level == 0) {
289 import_lock_thread = -1;
Guido van Rossum65d5b571998-12-21 19:32:43 +0000290 PyThread_release_lock(import_lock);
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000291 }
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000292 return 1;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000293}
294
Guido van Rossum8ee3e5a2005-09-14 18:09:42 +0000295/* This function is called from PyOS_AfterFork to ensure that newly
296 created child processes do not share locks with the parent. */
297
298void
299_PyImport_ReInitLock(void)
300{
301#ifdef _AIX
302 if (import_lock != NULL)
303 import_lock = PyThread_allocate_lock();
304#endif
305}
306
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000307#else
308
309#define lock_import()
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000310#define unlock_import() 0
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000311
312#endif
313
Tim Peters69232342001-08-30 05:16:13 +0000314static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000315imp_lock_held(PyObject *self, PyObject *noargs)
Tim Peters69232342001-08-30 05:16:13 +0000316{
Tim Peters69232342001-08-30 05:16:13 +0000317#ifdef WITH_THREAD
Guido van Rossumb8bff3f2002-04-07 06:34:38 +0000318 return PyBool_FromLong(import_lock_thread != -1);
Tim Peters69232342001-08-30 05:16:13 +0000319#else
Guido van Rossumb8bff3f2002-04-07 06:34:38 +0000320 return PyBool_FromLong(0);
Tim Peters69232342001-08-30 05:16:13 +0000321#endif
322}
323
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000324static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000325imp_acquire_lock(PyObject *self, PyObject *noargs)
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000326{
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000327#ifdef WITH_THREAD
328 lock_import();
329#endif
Neal Norwitz2294c0d2003-02-12 23:02:21 +0000330 Py_INCREF(Py_None);
331 return Py_None;
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000332}
333
334static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000335imp_release_lock(PyObject *self, PyObject *noargs)
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000336{
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000337#ifdef WITH_THREAD
338 if (unlock_import() < 0) {
339 PyErr_SetString(PyExc_RuntimeError,
340 "not holding the import lock");
341 return NULL;
342 }
343#endif
Neal Norwitz2294c0d2003-02-12 23:02:21 +0000344 Py_INCREF(Py_None);
345 return Py_None;
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000346}
347
Guido van Rossumd8faa362007-04-27 19:54:29 +0000348static void
349imp_modules_reloading_clear(void)
350{
351 PyInterpreterState *interp = PyThreadState_Get()->interp;
352 if (interp->modules_reloading != NULL)
353 PyDict_Clear(interp->modules_reloading);
354}
355
Guido van Rossum25ce5661997-08-02 03:10:38 +0000356/* Helper for sys */
357
358PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000359PyImport_GetModuleDict(void)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000360{
Nicholas Bastine5662ae2004-03-24 22:22:12 +0000361 PyInterpreterState *interp = PyThreadState_GET()->interp;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000362 if (interp->modules == NULL)
363 Py_FatalError("PyImport_GetModuleDict: no module dictionary!");
364 return interp->modules;
365}
366
Guido van Rossum3f5da241990-12-20 15:06:42 +0000367
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000368/* List of names to clear in sys */
369static char* sys_deletes[] = {
Collin Winter670e6922007-03-21 02:57:17 +0000370 "path", "argv", "ps1", "ps2",
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000371 "last_type", "last_value", "last_traceback",
Just van Rossum52e14d62002-12-30 22:08:05 +0000372 "path_hooks", "path_importer_cache", "meta_path",
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000373 NULL
374};
375
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000376static char* sys_files[] = {
377 "stdin", "__stdin__",
378 "stdout", "__stdout__",
379 "stderr", "__stderr__",
380 NULL
381};
382
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000383
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000384/* Un-initialize things, as good as we can */
Guido van Rossum3f5da241990-12-20 15:06:42 +0000385
Guido van Rossum3f5da241990-12-20 15:06:42 +0000386void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000387PyImport_Cleanup(void)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000388{
Martin v. Löwis18e16552006-02-15 17:27:45 +0000389 Py_ssize_t pos, ndone;
Guido van Rossum758eec01998-01-19 21:58:26 +0000390 char *name;
391 PyObject *key, *value, *dict;
Nicholas Bastine5662ae2004-03-24 22:22:12 +0000392 PyInterpreterState *interp = PyThreadState_GET()->interp;
Guido van Rossum758eec01998-01-19 21:58:26 +0000393 PyObject *modules = interp->modules;
394
395 if (modules == NULL)
396 return; /* Already done */
397
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000398 /* Delete some special variables first. These are common
399 places where user values hide and people complain when their
400 destructors fail. Since the modules containing them are
401 deleted *last* of all, they would come too late in the normal
402 destruction order. Sigh. */
403
Georg Brandl1a3284e2007-12-02 09:40:06 +0000404 value = PyDict_GetItemString(modules, "builtins");
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000405 if (value != NULL && PyModule_Check(value)) {
406 dict = PyModule_GetDict(value);
407 if (Py_VerboseFlag)
Georg Brandl1a3284e2007-12-02 09:40:06 +0000408 PySys_WriteStderr("# clear builtins._\n");
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000409 PyDict_SetItemString(dict, "_", Py_None);
410 }
411 value = PyDict_GetItemString(modules, "sys");
412 if (value != NULL && PyModule_Check(value)) {
413 char **p;
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000414 PyObject *v;
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000415 dict = PyModule_GetDict(value);
416 for (p = sys_deletes; *p != NULL; p++) {
417 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000418 PySys_WriteStderr("# clear sys.%s\n", *p);
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000419 PyDict_SetItemString(dict, *p, Py_None);
420 }
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000421 for (p = sys_files; *p != NULL; p+=2) {
422 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000423 PySys_WriteStderr("# restore sys.%s\n", *p);
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000424 v = PyDict_GetItemString(dict, *(p+1));
425 if (v == NULL)
426 v = Py_None;
427 PyDict_SetItemString(dict, *p, v);
428 }
429 }
430
431 /* First, delete __main__ */
432 value = PyDict_GetItemString(modules, "__main__");
433 if (value != NULL && PyModule_Check(value)) {
434 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000435 PySys_WriteStderr("# cleanup __main__\n");
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000436 _PyModule_Clear(value);
437 PyDict_SetItemString(modules, "__main__", Py_None);
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000438 }
439
Georg Brandl1a3284e2007-12-02 09:40:06 +0000440 /* The special treatment of "builtins" here is because even
Guido van Rossum758eec01998-01-19 21:58:26 +0000441 when it's not referenced as a module, its dictionary is
442 referenced by almost every module's __builtins__. Since
443 deleting a module clears its dictionary (even if there are
Georg Brandl1a3284e2007-12-02 09:40:06 +0000444 references left to it), we need to delete the "builtins"
Guido van Rossum758eec01998-01-19 21:58:26 +0000445 module last. Likewise, we don't delete sys until the very
446 end because it is implicitly referenced (e.g. by print).
447
448 Also note that we 'delete' modules by replacing their entry
449 in the modules dict with None, rather than really deleting
450 them; this avoids a rehash of the modules dictionary and
451 also marks them as "non existent" so they won't be
452 re-imported. */
453
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000454 /* Next, repeatedly delete modules with a reference count of
Georg Brandl1a3284e2007-12-02 09:40:06 +0000455 one (skipping builtins and sys) and delete them */
Guido van Rossum758eec01998-01-19 21:58:26 +0000456 do {
457 ndone = 0;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000458 pos = 0;
Guido van Rossum758eec01998-01-19 21:58:26 +0000459 while (PyDict_Next(modules, &pos, &key, &value)) {
460 if (value->ob_refcnt != 1)
461 continue;
Neal Norwitz80e7f272007-08-26 06:45:23 +0000462 if (PyUnicode_Check(key) && PyModule_Check(value)) {
463 name = PyUnicode_AsString(key);
Georg Brandl1a3284e2007-12-02 09:40:06 +0000464 if (strcmp(name, "builtins") == 0)
Guido van Rossum758eec01998-01-19 21:58:26 +0000465 continue;
466 if (strcmp(name, "sys") == 0)
467 continue;
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000468 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000469 PySys_WriteStderr(
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000470 "# cleanup[1] %s\n", name);
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000471 _PyModule_Clear(value);
Guido van Rossum758eec01998-01-19 21:58:26 +0000472 PyDict_SetItem(modules, key, Py_None);
473 ndone++;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000474 }
475 }
Guido van Rossum758eec01998-01-19 21:58:26 +0000476 } while (ndone > 0);
477
Georg Brandl1a3284e2007-12-02 09:40:06 +0000478 /* Next, delete all modules (still skipping builtins and sys) */
Guido van Rossum758eec01998-01-19 21:58:26 +0000479 pos = 0;
480 while (PyDict_Next(modules, &pos, &key, &value)) {
Neal Norwitz80e7f272007-08-26 06:45:23 +0000481 if (PyUnicode_Check(key) && PyModule_Check(value)) {
482 name = PyUnicode_AsString(key);
Georg Brandl1a3284e2007-12-02 09:40:06 +0000483 if (strcmp(name, "builtins") == 0)
Guido van Rossum758eec01998-01-19 21:58:26 +0000484 continue;
485 if (strcmp(name, "sys") == 0)
486 continue;
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000487 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000488 PySys_WriteStderr("# cleanup[2] %s\n", name);
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000489 _PyModule_Clear(value);
Guido van Rossum758eec01998-01-19 21:58:26 +0000490 PyDict_SetItem(modules, key, Py_None);
491 }
492 }
493
Georg Brandl1a3284e2007-12-02 09:40:06 +0000494 /* Next, delete sys and builtins (in that order) */
Guido van Rossum758eec01998-01-19 21:58:26 +0000495 value = PyDict_GetItemString(modules, "sys");
496 if (value != NULL && PyModule_Check(value)) {
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000497 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000498 PySys_WriteStderr("# cleanup sys\n");
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000499 _PyModule_Clear(value);
Guido van Rossum758eec01998-01-19 21:58:26 +0000500 PyDict_SetItemString(modules, "sys", Py_None);
501 }
Georg Brandl1a3284e2007-12-02 09:40:06 +0000502 value = PyDict_GetItemString(modules, "builtins");
Guido van Rossum758eec01998-01-19 21:58:26 +0000503 if (value != NULL && PyModule_Check(value)) {
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000504 if (Py_VerboseFlag)
Georg Brandl1a3284e2007-12-02 09:40:06 +0000505 PySys_WriteStderr("# cleanup builtins\n");
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000506 _PyModule_Clear(value);
Georg Brandl1a3284e2007-12-02 09:40:06 +0000507 PyDict_SetItemString(modules, "builtins", Py_None);
Guido van Rossum758eec01998-01-19 21:58:26 +0000508 }
509
510 /* Finally, clear and delete the modules directory */
511 PyDict_Clear(modules);
512 interp->modules = NULL;
513 Py_DECREF(modules);
Guido van Rossumd8faa362007-04-27 19:54:29 +0000514 Py_CLEAR(interp->modules_reloading);
Guido van Rossum8d15b5d1990-10-26 14:58:58 +0000515}
Guido van Rossum7f133ed1991-02-19 12:23:57 +0000516
517
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000518/* Helper for pythonrun.c -- return magic number */
519
520long
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000521PyImport_GetMagicNumber(void)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000522{
Guido van Rossum96774c12000-05-01 20:19:08 +0000523 return pyc_magic;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000524}
525
526
Guido van Rossum25ce5661997-08-02 03:10:38 +0000527/* Magic for extension modules (built-in as well as dynamically
528 loaded). To prevent initializing an extension module more than
529 once, we keep a static dictionary 'extensions' keyed by module name
530 (for built-in modules) or by filename (for dynamically loaded
Barry Warsaw92883382001-08-13 23:05:44 +0000531 modules), containing these modules. A copy of the module's
Guido van Rossum25ce5661997-08-02 03:10:38 +0000532 dictionary is stored by calling _PyImport_FixupExtension()
533 immediately after the module initialization function succeeds. A
534 copy can be retrieved from there by calling
535 _PyImport_FindExtension(). */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000536
Guido van Rossum79f25d91997-04-29 20:08:16 +0000537PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000538_PyImport_FixupExtension(char *name, char *filename)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000539{
Guido van Rossum25ce5661997-08-02 03:10:38 +0000540 PyObject *modules, *mod, *dict, *copy;
541 if (extensions == NULL) {
542 extensions = PyDict_New();
543 if (extensions == NULL)
544 return NULL;
545 }
546 modules = PyImport_GetModuleDict();
547 mod = PyDict_GetItemString(modules, name);
548 if (mod == NULL || !PyModule_Check(mod)) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000549 PyErr_Format(PyExc_SystemError,
550 "_PyImport_FixupExtension: module %.200s not loaded", name);
Guido van Rossum25ce5661997-08-02 03:10:38 +0000551 return NULL;
552 }
553 dict = PyModule_GetDict(mod);
554 if (dict == NULL)
555 return NULL;
Fred Drake9cd0efc2001-10-25 21:38:59 +0000556 copy = PyDict_Copy(dict);
Guido van Rossum25ce5661997-08-02 03:10:38 +0000557 if (copy == NULL)
558 return NULL;
559 PyDict_SetItemString(extensions, filename, copy);
560 Py_DECREF(copy);
561 return copy;
562}
563
564PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000565_PyImport_FindExtension(char *name, char *filename)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000566{
Fred Drake9cd0efc2001-10-25 21:38:59 +0000567 PyObject *dict, *mod, *mdict;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000568 if (extensions == NULL)
569 return NULL;
570 dict = PyDict_GetItemString(extensions, filename);
571 if (dict == NULL)
572 return NULL;
573 mod = PyImport_AddModule(name);
574 if (mod == NULL)
575 return NULL;
576 mdict = PyModule_GetDict(mod);
577 if (mdict == NULL)
578 return NULL;
Fred Drake9cd0efc2001-10-25 21:38:59 +0000579 if (PyDict_Update(mdict, dict))
Guido van Rossum25ce5661997-08-02 03:10:38 +0000580 return NULL;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000581 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000582 PySys_WriteStderr("import %s # previously loaded (%s)\n",
Guido van Rossum25ce5661997-08-02 03:10:38 +0000583 name, filename);
584 return mod;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000585}
586
587
588/* Get the module object corresponding to a module name.
589 First check the modules dictionary if there's one there,
Walter Dörwaldf0dfc7a2003-10-20 14:01:56 +0000590 if not, create a new one and insert it in the modules dictionary.
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000591 Because the former action is most common, THIS DOES NOT RETURN A
592 'NEW' REFERENCE! */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000593
Guido van Rossum79f25d91997-04-29 20:08:16 +0000594PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000595PyImport_AddModule(const char *name)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000596{
Guido van Rossum25ce5661997-08-02 03:10:38 +0000597 PyObject *modules = PyImport_GetModuleDict();
Guido van Rossum79f25d91997-04-29 20:08:16 +0000598 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000599
Guido van Rossum25ce5661997-08-02 03:10:38 +0000600 if ((m = PyDict_GetItemString(modules, name)) != NULL &&
Guido van Rossum79f25d91997-04-29 20:08:16 +0000601 PyModule_Check(m))
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000602 return m;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000603 m = PyModule_New(name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000604 if (m == NULL)
605 return NULL;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000606 if (PyDict_SetItemString(modules, name, m) != 0) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000607 Py_DECREF(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000608 return NULL;
609 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000610 Py_DECREF(m); /* Yes, it still exists, in modules! */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000611
612 return m;
613}
614
Tim Peters1cd70172004-08-02 03:52:12 +0000615/* Remove name from sys.modules, if it's there. */
616static void
617_RemoveModule(const char *name)
618{
619 PyObject *modules = PyImport_GetModuleDict();
620 if (PyDict_GetItemString(modules, name) == NULL)
621 return;
622 if (PyDict_DelItemString(modules, name) < 0)
623 Py_FatalError("import: deleting existing key in"
624 "sys.modules failed");
625}
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000626
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000627/* Execute a code object in a module and return the module object
Tim Peters1cd70172004-08-02 03:52:12 +0000628 * WITH INCREMENTED REFERENCE COUNT. If an error occurs, name is
629 * removed from sys.modules, to avoid leaving damaged module objects
630 * in sys.modules. The caller may wish to restore the original
631 * module object (if any) in this case; PyImport_ReloadModule is an
632 * example.
633 */
Guido van Rossum79f25d91997-04-29 20:08:16 +0000634PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000635PyImport_ExecCodeModule(char *name, PyObject *co)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000636{
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000637 return PyImport_ExecCodeModuleEx(name, co, (char *)NULL);
638}
639
640PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000641PyImport_ExecCodeModuleEx(char *name, PyObject *co, char *pathname)
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000642{
Guido van Rossum25ce5661997-08-02 03:10:38 +0000643 PyObject *modules = PyImport_GetModuleDict();
Guido van Rossum79f25d91997-04-29 20:08:16 +0000644 PyObject *m, *d, *v;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000645
Guido van Rossum79f25d91997-04-29 20:08:16 +0000646 m = PyImport_AddModule(name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000647 if (m == NULL)
648 return NULL;
Jeremy Hyltonecd91292004-01-02 23:25:32 +0000649 /* If the module is being reloaded, we get the old module back
650 and re-use its dict to exec the new code. */
Guido van Rossum79f25d91997-04-29 20:08:16 +0000651 d = PyModule_GetDict(m);
652 if (PyDict_GetItemString(d, "__builtins__") == NULL) {
653 if (PyDict_SetItemString(d, "__builtins__",
654 PyEval_GetBuiltins()) != 0)
Tim Peters1cd70172004-08-02 03:52:12 +0000655 goto error;
Guido van Rossum6135a871995-01-09 17:53:26 +0000656 }
Guido van Rossum9c9a07c1996-05-16 20:43:40 +0000657 /* Remember the filename as the __file__ attribute */
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000658 v = NULL;
659 if (pathname != NULL) {
Guido van Rossum00bc0e02007-10-15 02:52:41 +0000660 v = PyUnicode_DecodeFSDefault(pathname);
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000661 if (v == NULL)
662 PyErr_Clear();
663 }
664 if (v == NULL) {
665 v = ((PyCodeObject *)co)->co_filename;
666 Py_INCREF(v);
667 }
668 if (PyDict_SetItemString(d, "__file__", v) != 0)
Guido van Rossum79f25d91997-04-29 20:08:16 +0000669 PyErr_Clear(); /* Not important enough to report */
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000670 Py_DECREF(v);
671
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000672 v = PyEval_EvalCode((PyCodeObject *)co, d, d);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000673 if (v == NULL)
Tim Peters1cd70172004-08-02 03:52:12 +0000674 goto error;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000675 Py_DECREF(v);
Guido van Rossumb65e85c1997-07-10 18:00:45 +0000676
Guido van Rossum25ce5661997-08-02 03:10:38 +0000677 if ((m = PyDict_GetItemString(modules, name)) == NULL) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000678 PyErr_Format(PyExc_ImportError,
679 "Loaded module %.200s not found in sys.modules",
680 name);
Guido van Rossumb65e85c1997-07-10 18:00:45 +0000681 return NULL;
682 }
683
Guido van Rossum79f25d91997-04-29 20:08:16 +0000684 Py_INCREF(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000685
686 return m;
Tim Peters1cd70172004-08-02 03:52:12 +0000687
688 error:
689 _RemoveModule(name);
690 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000691}
692
693
694/* Given a pathname for a Python source file, fill a buffer with the
695 pathname for the corresponding compiled file. Return the pathname
696 for the compiled file, or NULL if there's no space in the buffer.
697 Doesn't set an exception. */
698
699static char *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000700make_compiled_pathname(char *pathname, char *buf, size_t buflen)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000701{
Tim Petersc1731372001-08-04 08:12:36 +0000702 size_t len = strlen(pathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000703 if (len+2 > buflen)
704 return NULL;
Tim Petersc1731372001-08-04 08:12:36 +0000705
Martin v. Löwis6238d2b2002-06-30 15:26:10 +0000706#ifdef MS_WINDOWS
Tim Petersc1731372001-08-04 08:12:36 +0000707 /* Treat .pyw as if it were .py. The case of ".pyw" must match
708 that used in _PyImport_StandardFiletab. */
709 if (len >= 4 && strcmp(&pathname[len-4], ".pyw") == 0)
710 --len; /* pretend 'w' isn't there */
711#endif
712 memcpy(buf, pathname, len);
713 buf[len] = Py_OptimizeFlag ? 'o' : 'c';
714 buf[len+1] = '\0';
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000715
716 return buf;
717}
718
719
720/* Given a pathname for a Python source file, its time of last
721 modification, and a pathname for a compiled file, check whether the
722 compiled file represents the same version of the source. If so,
723 return a FILE pointer for the compiled file, positioned just after
724 the header; if not, return NULL.
725 Doesn't set an exception. */
726
727static FILE *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000728check_compiled_module(char *pathname, time_t mtime, char *cpathname)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000729{
730 FILE *fp;
731 long magic;
732 long pyc_mtime;
733
734 fp = fopen(cpathname, "rb");
735 if (fp == NULL)
736 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000737 magic = PyMarshal_ReadLongFromFile(fp);
Guido van Rossum96774c12000-05-01 20:19:08 +0000738 if (magic != pyc_magic) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000739 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000740 PySys_WriteStderr("# %s has bad magic\n", cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000741 fclose(fp);
742 return NULL;
743 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000744 pyc_mtime = PyMarshal_ReadLongFromFile(fp);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000745 if (pyc_mtime != mtime) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000746 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000747 PySys_WriteStderr("# %s has bad mtime\n", cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000748 fclose(fp);
749 return NULL;
750 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000751 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000752 PySys_WriteStderr("# %s matches %s\n", cpathname, pathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000753 return fp;
754}
755
756
757/* Read a code object from a file and check it for validity */
758
Guido van Rossum79f25d91997-04-29 20:08:16 +0000759static PyCodeObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000760read_compiled_module(char *cpathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000761{
Guido van Rossum79f25d91997-04-29 20:08:16 +0000762 PyObject *co;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000763
Tim Petersd9b9ac82001-01-28 00:27:39 +0000764 co = PyMarshal_ReadLastObjectFromFile(fp);
Armin Rigo01ab2792004-03-26 15:09:27 +0000765 if (co == NULL)
766 return NULL;
767 if (!PyCode_Check(co)) {
768 PyErr_Format(PyExc_ImportError,
769 "Non-code object in %.200s", cpathname);
770 Py_DECREF(co);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000771 return NULL;
772 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000773 return (PyCodeObject *)co;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000774}
775
776
777/* Load a module from a compiled file, execute it, and return its
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000778 module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000779
Guido van Rossum79f25d91997-04-29 20:08:16 +0000780static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000781load_compiled_module(char *name, char *cpathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000782{
783 long magic;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000784 PyCodeObject *co;
785 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000786
Guido van Rossum79f25d91997-04-29 20:08:16 +0000787 magic = PyMarshal_ReadLongFromFile(fp);
Guido van Rossum96774c12000-05-01 20:19:08 +0000788 if (magic != pyc_magic) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000789 PyErr_Format(PyExc_ImportError,
790 "Bad magic number in %.200s", cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000791 return NULL;
792 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000793 (void) PyMarshal_ReadLongFromFile(fp);
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000794 co = read_compiled_module(cpathname, fp);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000795 if (co == NULL)
796 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000797 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000798 PySys_WriteStderr("import %s # precompiled from %s\n",
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000799 name, cpathname);
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000800 m = PyImport_ExecCodeModuleEx(name, (PyObject *)co, cpathname);
Guido van Rossum79f25d91997-04-29 20:08:16 +0000801 Py_DECREF(co);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000802
803 return m;
804}
805
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000806/* Parse a source file and return the corresponding code object */
807
Guido van Rossum79f25d91997-04-29 20:08:16 +0000808static PyCodeObject *
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000809parse_source_module(const char *pathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000810{
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000811 PyCodeObject *co = NULL;
812 mod_ty mod;
Thomas Wouters89f507f2006-12-13 04:49:30 +0000813 PyArena *arena = PyArena_New();
814 if (arena == NULL)
815 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000816
Martin v. Löwis85bcc662007-09-04 09:18:06 +0000817 mod = PyParser_ASTFromFile(fp, pathname, NULL,
818 Py_file_input, 0, 0, 0,
Neal Norwitzadb69fc2005-12-17 20:54:49 +0000819 NULL, arena);
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000820 if (mod) {
Neal Norwitzadb69fc2005-12-17 20:54:49 +0000821 co = PyAST_Compile(mod, pathname, NULL, arena);
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000822 }
Thomas Wouters89f507f2006-12-13 04:49:30 +0000823 PyArena_Free(arena);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000824 return co;
825}
826
827
Guido van Rossum55a83382000-09-20 20:31:38 +0000828/* Helper to open a bytecode file for writing in exclusive mode */
829
830static FILE *
831open_exclusive(char *filename)
832{
833#if defined(O_EXCL)&&defined(O_CREAT)&&defined(O_WRONLY)&&defined(O_TRUNC)
834 /* Use O_EXCL to avoid a race condition when another process tries to
835 write the same file. When that happens, our open() call fails,
836 which is just fine (since it's only a cache).
837 XXX If the file exists and is writable but the directory is not
838 writable, the file will never be written. Oh well.
839 */
840 int fd;
841 (void) unlink(filename);
Tim Peters42c83af2000-09-29 04:03:10 +0000842 fd = open(filename, O_EXCL|O_CREAT|O_WRONLY|O_TRUNC
843#ifdef O_BINARY
844 |O_BINARY /* necessary for Windows */
845#endif
Martin v. Löwis79acb9e2002-12-06 12:48:53 +0000846#ifdef __VMS
Martin v. Löwis18e16552006-02-15 17:27:45 +0000847 , 0666, "ctxt=bin", "shr=nil"
Martin v. Löwis79acb9e2002-12-06 12:48:53 +0000848#else
Martin v. Löwis18e16552006-02-15 17:27:45 +0000849 , 0666
Martin v. Löwis79acb9e2002-12-06 12:48:53 +0000850#endif
Martin v. Löwis18e16552006-02-15 17:27:45 +0000851 );
Guido van Rossum55a83382000-09-20 20:31:38 +0000852 if (fd < 0)
853 return NULL;
854 return fdopen(fd, "wb");
855#else
856 /* Best we can do -- on Windows this can't happen anyway */
857 return fopen(filename, "wb");
858#endif
859}
860
861
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000862/* Write a compiled module to a file, placing the time of last
863 modification of its source into the header.
864 Errors are ignored, if a write error occurs an attempt is made to
865 remove the file. */
866
867static void
Martin v. Löwis18e16552006-02-15 17:27:45 +0000868write_compiled_module(PyCodeObject *co, char *cpathname, time_t mtime)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000869{
870 FILE *fp;
871
Guido van Rossum55a83382000-09-20 20:31:38 +0000872 fp = open_exclusive(cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000873 if (fp == NULL) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000874 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000875 PySys_WriteStderr(
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000876 "# can't create %s\n", cpathname);
877 return;
878 }
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000879 PyMarshal_WriteLongToFile(pyc_magic, fp, Py_MARSHAL_VERSION);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000880 /* First write a 0 for mtime */
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000881 PyMarshal_WriteLongToFile(0L, fp, Py_MARSHAL_VERSION);
882 PyMarshal_WriteObjectToFile((PyObject *)co, fp, Py_MARSHAL_VERSION);
Armin Rigo01ab2792004-03-26 15:09:27 +0000883 if (fflush(fp) != 0 || ferror(fp)) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000884 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000885 PySys_WriteStderr("# can't write %s\n", cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000886 /* Don't keep partial file */
887 fclose(fp);
888 (void) unlink(cpathname);
889 return;
890 }
891 /* Now write the true mtime */
892 fseek(fp, 4L, 0);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000893 assert(mtime < LONG_MAX);
Martin v. Löwis725507b2006-03-07 12:08:51 +0000894 PyMarshal_WriteLongToFile((long)mtime, fp, Py_MARSHAL_VERSION);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000895 fflush(fp);
896 fclose(fp);
Guido van Rossum79f25d91997-04-29 20:08:16 +0000897 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000898 PySys_WriteStderr("# wrote %s\n", cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000899}
900
901
902/* Load a source module from a given file and return its module
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000903 object WITH INCREMENTED REFERENCE COUNT. If there's a matching
904 byte-compiled file, use that instead. */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000905
Guido van Rossum79f25d91997-04-29 20:08:16 +0000906static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000907load_source_module(char *name, char *pathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000908{
Fred Drake4c82b232000-06-30 16:18:57 +0000909 time_t mtime;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000910 FILE *fpc;
911 char buf[MAXPATHLEN+1];
912 char *cpathname;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000913 PyCodeObject *co;
914 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000915
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000916 mtime = PyOS_GetLastModificationTime(pathname, fp);
Neal Norwitz708e51a2005-10-03 04:48:15 +0000917 if (mtime == (time_t)(-1)) {
918 PyErr_Format(PyExc_RuntimeError,
919 "unable to get modification time from '%s'",
920 pathname);
Fred Drake4c82b232000-06-30 16:18:57 +0000921 return NULL;
Neal Norwitz708e51a2005-10-03 04:48:15 +0000922 }
Fred Drake4c82b232000-06-30 16:18:57 +0000923#if SIZEOF_TIME_T > 4
924 /* Python's .pyc timestamp handling presumes that the timestamp fits
925 in 4 bytes. This will be fine until sometime in the year 2038,
926 when a 4-byte signed time_t will overflow.
927 */
928 if (mtime >> 32) {
929 PyErr_SetString(PyExc_OverflowError,
Fred Drakec63d3e92001-03-01 06:33:32 +0000930 "modification time overflows a 4 byte field");
Fred Drake4c82b232000-06-30 16:18:57 +0000931 return NULL;
932 }
933#endif
Tim Peters36515e22001-11-18 04:06:29 +0000934 cpathname = make_compiled_pathname(pathname, buf,
Jeremy Hylton37832f02001-04-13 17:50:20 +0000935 (size_t)MAXPATHLEN + 1);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000936 if (cpathname != NULL &&
937 (fpc = check_compiled_module(pathname, mtime, cpathname))) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000938 co = read_compiled_module(cpathname, fpc);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000939 fclose(fpc);
940 if (co == NULL)
941 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000942 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000943 PySys_WriteStderr("import %s # precompiled from %s\n",
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000944 name, cpathname);
Guido van Rossumafd3dae1998-08-25 18:44:34 +0000945 pathname = cpathname;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000946 }
947 else {
948 co = parse_source_module(pathname, fp);
949 if (co == NULL)
950 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000951 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000952 PySys_WriteStderr("import %s # from %s\n",
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000953 name, pathname);
Thomas Wouters00ee7ba2006-08-21 19:07:27 +0000954 if (cpathname)
955 write_compiled_module(co, cpathname, mtime);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000956 }
Guido van Rossumafd3dae1998-08-25 18:44:34 +0000957 m = PyImport_ExecCodeModuleEx(name, (PyObject *)co, pathname);
Guido van Rossum79f25d91997-04-29 20:08:16 +0000958 Py_DECREF(co);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000959
960 return m;
961}
962
963
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000964/* Forward */
Just van Rossum52e14d62002-12-30 22:08:05 +0000965static PyObject *load_module(char *, FILE *, char *, int, PyObject *);
966static struct filedescr *find_module(char *, char *, PyObject *,
967 char *, size_t, FILE **, PyObject **);
Tim Petersdbd9ba62000-07-09 03:09:57 +0000968static struct _frozen *find_frozen(char *name);
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000969
970/* Load a package and return its module object WITH INCREMENTED
971 REFERENCE COUNT */
972
973static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000974load_package(char *name, char *pathname)
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000975{
Tim Peters1cd70172004-08-02 03:52:12 +0000976 PyObject *m, *d;
977 PyObject *file = NULL;
978 PyObject *path = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000979 int err;
980 char buf[MAXPATHLEN+1];
981 FILE *fp = NULL;
982 struct filedescr *fdp;
983
984 m = PyImport_AddModule(name);
985 if (m == NULL)
986 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +0000987 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000988 PySys_WriteStderr("import %s # directory %s\n",
Guido van Rossum17fc85f1997-09-06 18:52:03 +0000989 name, pathname);
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000990 d = PyModule_GetDict(m);
Guido van Rossum00bc0e02007-10-15 02:52:41 +0000991 file = PyUnicode_DecodeFSDefault(pathname);
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000992 if (file == NULL)
Tim Peters1cd70172004-08-02 03:52:12 +0000993 goto error;
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000994 path = Py_BuildValue("[O]", file);
Tim Peters1cd70172004-08-02 03:52:12 +0000995 if (path == NULL)
996 goto error;
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000997 err = PyDict_SetItemString(d, "__file__", file);
998 if (err == 0)
999 err = PyDict_SetItemString(d, "__path__", path);
Tim Peters1cd70172004-08-02 03:52:12 +00001000 if (err != 0)
1001 goto error;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001002 buf[0] = '\0';
Just van Rossum52e14d62002-12-30 22:08:05 +00001003 fdp = find_module(name, "__init__", path, buf, sizeof(buf), &fp, NULL);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001004 if (fdp == NULL) {
1005 if (PyErr_ExceptionMatches(PyExc_ImportError)) {
1006 PyErr_Clear();
Thomas Heller25653242004-06-07 15:04:10 +00001007 Py_INCREF(m);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001008 }
1009 else
1010 m = NULL;
1011 goto cleanup;
1012 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001013 m = load_module(name, fp, buf, fdp->type, NULL);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001014 if (fp != NULL)
1015 fclose(fp);
Tim Peters1cd70172004-08-02 03:52:12 +00001016 goto cleanup;
1017
1018 error:
1019 m = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001020 cleanup:
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001021 Py_XDECREF(path);
1022 Py_XDECREF(file);
1023 return m;
1024}
1025
1026
1027/* Helper to test for built-in module */
1028
1029static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001030is_builtin(char *name)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001031{
1032 int i;
Guido van Rossum771c6c81997-10-31 18:37:24 +00001033 for (i = 0; PyImport_Inittab[i].name != NULL; i++) {
1034 if (strcmp(name, PyImport_Inittab[i].name) == 0) {
1035 if (PyImport_Inittab[i].initfunc == NULL)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001036 return -1;
1037 else
1038 return 1;
1039 }
1040 }
1041 return 0;
1042}
1043
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001044
Just van Rossum52e14d62002-12-30 22:08:05 +00001045/* Return an importer object for a sys.path/pkg.__path__ item 'p',
1046 possibly by fetching it from the path_importer_cache dict. If it
Thomas Wouters89f507f2006-12-13 04:49:30 +00001047 wasn't yet cached, traverse path_hooks until a hook is found
Just van Rossum52e14d62002-12-30 22:08:05 +00001048 that can handle the path item. Return None if no hook could;
1049 this tells our caller it should fall back to the builtin
1050 import mechanism. Cache the result in path_importer_cache.
1051 Returns a borrowed reference. */
1052
1053static PyObject *
1054get_path_importer(PyObject *path_importer_cache, PyObject *path_hooks,
1055 PyObject *p)
1056{
1057 PyObject *importer;
Martin v. Löwis725507b2006-03-07 12:08:51 +00001058 Py_ssize_t j, nhooks;
Just van Rossum52e14d62002-12-30 22:08:05 +00001059
1060 /* These conditions are the caller's responsibility: */
1061 assert(PyList_Check(path_hooks));
1062 assert(PyDict_Check(path_importer_cache));
1063
1064 nhooks = PyList_Size(path_hooks);
1065 if (nhooks < 0)
1066 return NULL; /* Shouldn't happen */
1067
1068 importer = PyDict_GetItem(path_importer_cache, p);
1069 if (importer != NULL)
1070 return importer;
1071
1072 /* set path_importer_cache[p] to None to avoid recursion */
1073 if (PyDict_SetItem(path_importer_cache, p, Py_None) != 0)
1074 return NULL;
1075
1076 for (j = 0; j < nhooks; j++) {
1077 PyObject *hook = PyList_GetItem(path_hooks, j);
1078 if (hook == NULL)
1079 return NULL;
Thomas Wouters477c8d52006-05-27 19:21:47 +00001080 importer = PyObject_CallFunctionObjArgs(hook, p, NULL);
Just van Rossum52e14d62002-12-30 22:08:05 +00001081 if (importer != NULL)
1082 break;
1083
1084 if (!PyErr_ExceptionMatches(PyExc_ImportError)) {
1085 return NULL;
1086 }
1087 PyErr_Clear();
1088 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001089 if (importer == NULL) {
1090 importer = PyObject_CallFunctionObjArgs(
Christian Heimes9cd17752007-11-18 19:35:23 +00001091 (PyObject *)&PyNullImporter_Type, p, NULL
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001092 );
1093 if (importer == NULL) {
1094 if (PyErr_ExceptionMatches(PyExc_ImportError)) {
1095 PyErr_Clear();
1096 return Py_None;
1097 }
1098 }
1099 }
1100 if (importer != NULL) {
Just van Rossum52e14d62002-12-30 22:08:05 +00001101 int err = PyDict_SetItem(path_importer_cache, p, importer);
1102 Py_DECREF(importer);
1103 if (err != 0)
1104 return NULL;
1105 }
1106 return importer;
1107}
1108
Christian Heimes9cd17752007-11-18 19:35:23 +00001109PyAPI_FUNC(PyObject *)
1110PyImport_GetImporter(PyObject *path) {
1111 PyObject *importer=NULL, *path_importer_cache=NULL, *path_hooks=NULL;
1112
1113 if ((path_importer_cache = PySys_GetObject("path_importer_cache"))) {
1114 if ((path_hooks = PySys_GetObject("path_hooks"))) {
1115 importer = get_path_importer(path_importer_cache,
1116 path_hooks, path);
1117 }
1118 }
1119 Py_XINCREF(importer); /* get_path_importer returns a borrowed reference */
1120 return importer;
1121}
1122
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001123/* Search the path (default sys.path) for a module. Return the
1124 corresponding filedescr struct, and (via return arguments) the
1125 pathname and an open file. Return NULL if the module is not found. */
1126
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001127#ifdef MS_COREDLL
Thomas Woutersb4bd21c2000-07-22 23:38:01 +00001128extern FILE *PyWin_FindRegisteredModule(const char *, struct filedescr **,
Martin v. Löwis18e16552006-02-15 17:27:45 +00001129 char *, Py_ssize_t);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001130#endif
1131
Martin v. Löwis18e16552006-02-15 17:27:45 +00001132static int case_ok(char *, Py_ssize_t, Py_ssize_t, char *);
Tim Petersdbd9ba62000-07-09 03:09:57 +00001133static int find_init_module(char *); /* Forward */
Just van Rossum52e14d62002-12-30 22:08:05 +00001134static struct filedescr importhookdescr = {"", "", IMP_HOOK};
Guido van Rossum197346f1997-10-31 18:38:52 +00001135
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001136static struct filedescr *
Just van Rossum52e14d62002-12-30 22:08:05 +00001137find_module(char *fullname, char *subname, PyObject *path, char *buf,
1138 size_t buflen, FILE **p_fp, PyObject **p_loader)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001139{
Martin v. Löwis725507b2006-03-07 12:08:51 +00001140 Py_ssize_t i, npath;
Fred Drake4c82b232000-06-30 16:18:57 +00001141 size_t len, namelen;
Guido van Rossum80bb9651996-12-05 23:27:02 +00001142 struct filedescr *fdp = NULL;
Jack Jansenc88da1f2002-05-28 10:58:19 +00001143 char *filemode;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001144 FILE *fp = NULL;
Just van Rossum52e14d62002-12-30 22:08:05 +00001145 PyObject *path_hooks, *path_importer_cache;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001146 struct stat statbuf;
Guido van Rossuma5568d31998-03-05 03:45:08 +00001147 static struct filedescr fd_frozen = {"", "", PY_FROZEN};
1148 static struct filedescr fd_builtin = {"", "", C_BUILTIN};
1149 static struct filedescr fd_package = {"", "", PKG_DIRECTORY};
Guido van Rossum0506a431998-08-11 15:07:39 +00001150 char name[MAXPATHLEN+1];
Andrew MacIntyred9400542002-02-26 11:41:34 +00001151#if defined(PYOS_OS2)
1152 size_t saved_len;
1153 size_t saved_namelen;
1154 char *saved_buf = NULL;
1155#endif
Just van Rossum52e14d62002-12-30 22:08:05 +00001156 if (p_loader != NULL)
1157 *p_loader = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001158
Just van Rossum52e14d62002-12-30 22:08:05 +00001159 if (strlen(subname) > MAXPATHLEN) {
Guido van Rossum8f4d3312001-10-18 18:54:11 +00001160 PyErr_SetString(PyExc_OverflowError,
1161 "module name is too long");
Fred Drake4c82b232000-06-30 16:18:57 +00001162 return NULL;
1163 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001164 strcpy(name, subname);
1165
1166 /* sys.meta_path import hook */
1167 if (p_loader != NULL) {
1168 PyObject *meta_path;
1169
1170 meta_path = PySys_GetObject("meta_path");
1171 if (meta_path == NULL || !PyList_Check(meta_path)) {
1172 PyErr_SetString(PyExc_ImportError,
1173 "sys.meta_path must be a list of "
1174 "import hooks");
1175 return NULL;
1176 }
1177 Py_INCREF(meta_path); /* zap guard */
1178 npath = PyList_Size(meta_path);
1179 for (i = 0; i < npath; i++) {
1180 PyObject *loader;
1181 PyObject *hook = PyList_GetItem(meta_path, i);
1182 loader = PyObject_CallMethod(hook, "find_module",
1183 "sO", fullname,
1184 path != NULL ?
1185 path : Py_None);
1186 if (loader == NULL) {
1187 Py_DECREF(meta_path);
1188 return NULL; /* true error */
1189 }
1190 if (loader != Py_None) {
1191 /* a loader was found */
1192 *p_loader = loader;
1193 Py_DECREF(meta_path);
1194 return &importhookdescr;
1195 }
1196 Py_DECREF(loader);
1197 }
1198 Py_DECREF(meta_path);
1199 }
Guido van Rossum0506a431998-08-11 15:07:39 +00001200
Guido van Rossum13d77992007-07-23 03:16:50 +00001201 if (path != NULL && PyUnicode_Check(path)) {
Guido van Rossum8f4d3312001-10-18 18:54:11 +00001202 /* The only type of submodule allowed inside a "frozen"
1203 package are other frozen modules or packages. */
Guido van Rossum13d77992007-07-23 03:16:50 +00001204 char *p = PyUnicode_AsString(path);
1205 if (strlen(p) + 1 + strlen(name) >= (size_t)buflen) {
Guido van Rossum0506a431998-08-11 15:07:39 +00001206 PyErr_SetString(PyExc_ImportError,
1207 "full frozen module name too long");
1208 return NULL;
1209 }
Guido van Rossum13d77992007-07-23 03:16:50 +00001210 strcpy(buf, p);
Guido van Rossum0506a431998-08-11 15:07:39 +00001211 strcat(buf, ".");
1212 strcat(buf, name);
1213 strcpy(name, buf);
Guido van Rossum8f4d3312001-10-18 18:54:11 +00001214 if (find_frozen(name) != NULL) {
1215 strcpy(buf, name);
1216 return &fd_frozen;
1217 }
1218 PyErr_Format(PyExc_ImportError,
1219 "No frozen submodule named %.200s", name);
1220 return NULL;
Guido van Rossum0506a431998-08-11 15:07:39 +00001221 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001222 if (path == NULL) {
1223 if (is_builtin(name)) {
Guido van Rossuma5568d31998-03-05 03:45:08 +00001224 strcpy(buf, name);
1225 return &fd_builtin;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001226 }
Greg Ward201baee2001-10-04 14:52:06 +00001227 if ((find_frozen(name)) != NULL) {
Guido van Rossuma5568d31998-03-05 03:45:08 +00001228 strcpy(buf, name);
1229 return &fd_frozen;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001230 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001231
Guido van Rossumac279101996-08-22 23:10:58 +00001232#ifdef MS_COREDLL
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001233 fp = PyWin_FindRegisteredModule(name, &fdp, buf, buflen);
1234 if (fp != NULL) {
1235 *p_fp = fp;
1236 return fdp;
1237 }
Guido van Rossuma5a3db71996-04-09 02:39:59 +00001238#endif
Guido van Rossuma5568d31998-03-05 03:45:08 +00001239 path = PySys_GetObject("path");
1240 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00001241 if (path == NULL || !PyList_Check(path)) {
1242 PyErr_SetString(PyExc_ImportError,
Guido van Rossuma5568d31998-03-05 03:45:08 +00001243 "sys.path must be a list of directory names");
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001244 return NULL;
1245 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001246
1247 path_hooks = PySys_GetObject("path_hooks");
1248 if (path_hooks == NULL || !PyList_Check(path_hooks)) {
1249 PyErr_SetString(PyExc_ImportError,
1250 "sys.path_hooks must be a list of "
1251 "import hooks");
1252 return NULL;
1253 }
1254 path_importer_cache = PySys_GetObject("path_importer_cache");
1255 if (path_importer_cache == NULL ||
1256 !PyDict_Check(path_importer_cache)) {
1257 PyErr_SetString(PyExc_ImportError,
1258 "sys.path_importer_cache must be a dict");
1259 return NULL;
1260 }
1261
Guido van Rossum79f25d91997-04-29 20:08:16 +00001262 npath = PyList_Size(path);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001263 namelen = strlen(name);
1264 for (i = 0; i < npath; i++) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00001265 PyObject *v = PyList_GetItem(path, i);
Guido van Rossumf15a29f2007-05-04 00:41:39 +00001266 PyObject *origv = v;
Guido van Rossum6262cc72007-05-09 23:29:27 +00001267 const char *base;
Guido van Rossumf15a29f2007-05-04 00:41:39 +00001268 Py_ssize_t size;
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001269 if (!v)
1270 return NULL;
Guido van Rossuma4b8d1d2007-08-27 15:02:28 +00001271 if (PyUnicode_Check(v)) {
1272 v = _PyUnicode_AsDefaultEncodedString(v, NULL);
1273 if (v == NULL)
1274 return NULL;
1275 }
1276 if (!PyString_Check(v))
1277 continue;
1278 base = PyString_AS_STRING(v);
1279 size = PyString_GET_SIZE(v);
Guido van Rossumf15a29f2007-05-04 00:41:39 +00001280 len = size;
Walter Dörwald3430d702002-06-17 10:43:59 +00001281 if (len + 2 + namelen + MAXSUFFIXSIZE >= buflen) {
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001282 continue; /* Too long */
Walter Dörwald3430d702002-06-17 10:43:59 +00001283 }
Guido van Rossumf15a29f2007-05-04 00:41:39 +00001284 strcpy(buf, base);
Walter Dörwald3430d702002-06-17 10:43:59 +00001285 if (strlen(buf) != len) {
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001286 continue; /* v contains '\0' */
Walter Dörwald3430d702002-06-17 10:43:59 +00001287 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001288
1289 /* sys.path_hooks import hook */
1290 if (p_loader != NULL) {
1291 PyObject *importer;
1292
1293 importer = get_path_importer(path_importer_cache,
Guido van Rossumf15a29f2007-05-04 00:41:39 +00001294 path_hooks, origv);
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001295 if (importer == NULL) {
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001296 return NULL;
Thomas Wouters477c8d52006-05-27 19:21:47 +00001297 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001298 /* Note: importer is a borrowed reference */
1299 if (importer != Py_None) {
Just van Rossum52e14d62002-12-30 22:08:05 +00001300 PyObject *loader;
1301 loader = PyObject_CallMethod(importer,
1302 "find_module",
1303 "s", fullname);
1304 if (loader == NULL)
1305 return NULL; /* error */
1306 if (loader != Py_None) {
1307 /* a loader was found */
1308 *p_loader = loader;
1309 return &importhookdescr;
1310 }
1311 Py_DECREF(loader);
Thomas Wouters477c8d52006-05-27 19:21:47 +00001312 continue;
Just van Rossum52e14d62002-12-30 22:08:05 +00001313 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001314 }
Thomas Wouters477c8d52006-05-27 19:21:47 +00001315 /* no hook was found, use builtin import */
Just van Rossum52e14d62002-12-30 22:08:05 +00001316
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001317 if (len > 0 && buf[len-1] != SEP
1318#ifdef ALTSEP
1319 && buf[len-1] != ALTSEP
1320#endif
1321 )
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001322 buf[len++] = SEP;
Guido van Rossum215c3402000-11-13 17:26:32 +00001323 strcpy(buf+len, name);
1324 len += namelen;
Tim Peters50d8d372001-02-28 05:34:27 +00001325
1326 /* Check for package import (buf holds a directory name,
1327 and there's an __init__ module in that directory */
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001328#ifdef HAVE_STAT
Walter Dörwald3430d702002-06-17 10:43:59 +00001329 if (stat(buf, &statbuf) == 0 && /* it exists */
1330 S_ISDIR(statbuf.st_mode) && /* it's a directory */
Thomas Wouters477c8d52006-05-27 19:21:47 +00001331 case_ok(buf, len, namelen, name)) { /* case matches */
1332 if (find_init_module(buf)) { /* and has __init__.py */
Thomas Wouters477c8d52006-05-27 19:21:47 +00001333 return &fd_package;
1334 }
1335 else {
1336 char warnstr[MAXPATHLEN+80];
1337 sprintf(warnstr, "Not importing directory "
1338 "'%.*s': missing __init__.py",
1339 MAXPATHLEN, buf);
Skip Montanaro46fc3372007-08-12 11:44:53 +00001340 if (PyErr_WarnEx(PyExc_ImportWarning,
1341 warnstr, 1)) {
Thomas Wouters477c8d52006-05-27 19:21:47 +00001342 return NULL;
1343 }
1344 }
Walter Dörwald3430d702002-06-17 10:43:59 +00001345 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001346#endif
Andrew MacIntyred9400542002-02-26 11:41:34 +00001347#if defined(PYOS_OS2)
1348 /* take a snapshot of the module spec for restoration
1349 * after the 8 character DLL hackery
1350 */
1351 saved_buf = strdup(buf);
1352 saved_len = len;
1353 saved_namelen = namelen;
1354#endif /* PYOS_OS2 */
Guido van Rossum79f25d91997-04-29 20:08:16 +00001355 for (fdp = _PyImport_Filetab; fdp->suffix != NULL; fdp++) {
Guido van Rossum04110fb2007-08-24 16:32:05 +00001356#if defined(PYOS_OS2) && defined(HAVE_DYNAMIC_LOADING)
Jeremy Hylton4ae6fae2002-05-30 17:15:25 +00001357 /* OS/2 limits DLLs to 8 character names (w/o
1358 extension)
Andrew MacIntyred9400542002-02-26 11:41:34 +00001359 * so if the name is longer than that and its a
1360 * dynamically loaded module we're going to try,
1361 * truncate the name before trying
1362 */
Just van Rossum52e14d62002-12-30 22:08:05 +00001363 if (strlen(subname) > 8) {
Andrew MacIntyred9400542002-02-26 11:41:34 +00001364 /* is this an attempt to load a C extension? */
Jeremy Hylton4ae6fae2002-05-30 17:15:25 +00001365 const struct filedescr *scan;
1366 scan = _PyImport_DynLoadFiletab;
Andrew MacIntyred9400542002-02-26 11:41:34 +00001367 while (scan->suffix != NULL) {
Jeremy Hylton4ae6fae2002-05-30 17:15:25 +00001368 if (!strcmp(scan->suffix, fdp->suffix))
Andrew MacIntyred9400542002-02-26 11:41:34 +00001369 break;
1370 else
1371 scan++;
1372 }
1373 if (scan->suffix != NULL) {
1374 /* yes, so truncate the name */
1375 namelen = 8;
Just van Rossum52e14d62002-12-30 22:08:05 +00001376 len -= strlen(subname) - namelen;
Andrew MacIntyred9400542002-02-26 11:41:34 +00001377 buf[len] = '\0';
1378 }
1379 }
1380#endif /* PYOS_OS2 */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001381 strcpy(buf+len, fdp->suffix);
Guido van Rossum79f25d91997-04-29 20:08:16 +00001382 if (Py_VerboseFlag > 1)
Guido van Rossum2f3667a1998-10-12 18:23:55 +00001383 PySys_WriteStderr("# trying %s\n", buf);
Jack Jansenc88da1f2002-05-28 10:58:19 +00001384 filemode = fdp->mode;
Tim Peters86c7d2f2004-08-01 23:24:21 +00001385 if (filemode[0] == 'U')
Jeremy Hylton4ae6fae2002-05-30 17:15:25 +00001386 filemode = "r" PY_STDIOTEXTMODE;
Jack Jansenc88da1f2002-05-28 10:58:19 +00001387 fp = fopen(buf, filemode);
Tim Peters50d8d372001-02-28 05:34:27 +00001388 if (fp != NULL) {
1389 if (case_ok(buf, len, namelen, name))
1390 break;
1391 else { /* continue search */
1392 fclose(fp);
1393 fp = NULL;
Barry Warsaw914a0b12001-02-02 19:12:16 +00001394 }
Barry Warsaw914a0b12001-02-02 19:12:16 +00001395 }
Andrew MacIntyred9400542002-02-26 11:41:34 +00001396#if defined(PYOS_OS2)
1397 /* restore the saved snapshot */
1398 strcpy(buf, saved_buf);
1399 len = saved_len;
1400 namelen = saved_namelen;
1401#endif
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001402 }
Andrew MacIntyred9400542002-02-26 11:41:34 +00001403#if defined(PYOS_OS2)
1404 /* don't need/want the module name snapshot anymore */
1405 if (saved_buf)
1406 {
1407 free(saved_buf);
1408 saved_buf = NULL;
1409 }
1410#endif
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001411 if (fp != NULL)
1412 break;
1413 }
1414 if (fp == NULL) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001415 PyErr_Format(PyExc_ImportError,
1416 "No module named %.200s", name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001417 return NULL;
1418 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001419 *p_fp = fp;
1420 return fdp;
1421}
1422
Raymond Hettingerdb29e0f2004-10-07 06:46:25 +00001423/* Helpers for main.c
1424 * Find the source file corresponding to a named module
1425 */
1426struct filedescr *
1427_PyImport_FindModule(const char *name, PyObject *path, char *buf,
1428 size_t buflen, FILE **p_fp, PyObject **p_loader)
1429{
1430 return find_module((char *) name, (char *) name, path,
1431 buf, buflen, p_fp, p_loader);
1432}
1433
1434PyAPI_FUNC(int) _PyImport_IsScript(struct filedescr * fd)
1435{
1436 return fd->type == PY_SOURCE || fd->type == PY_COMPILED;
1437}
1438
Martin v. Löwis18e16552006-02-15 17:27:45 +00001439/* case_ok(char* buf, Py_ssize_t len, Py_ssize_t namelen, char* name)
Tim Petersd1e87a82001-03-01 18:12:00 +00001440 * The arguments here are tricky, best shown by example:
1441 * /a/b/c/d/e/f/g/h/i/j/k/some_long_module_name.py\0
1442 * ^ ^ ^ ^
1443 * |--------------------- buf ---------------------|
1444 * |------------------- len ------------------|
1445 * |------ name -------|
1446 * |----- namelen -----|
1447 * buf is the full path, but len only counts up to (& exclusive of) the
1448 * extension. name is the module name, also exclusive of extension.
1449 *
1450 * We've already done a successful stat() or fopen() on buf, so know that
1451 * there's some match, possibly case-insensitive.
1452 *
Tim Peters50d8d372001-02-28 05:34:27 +00001453 * case_ok() is to return 1 if there's a case-sensitive match for
1454 * name, else 0. case_ok() is also to return 1 if envar PYTHONCASEOK
1455 * exists.
Tim Petersd1e87a82001-03-01 18:12:00 +00001456 *
Tim Peters50d8d372001-02-28 05:34:27 +00001457 * case_ok() is used to implement case-sensitive import semantics even
1458 * on platforms with case-insensitive filesystems. It's trivial to implement
1459 * for case-sensitive filesystems. It's pretty much a cross-platform
1460 * nightmare for systems with case-insensitive filesystems.
1461 */
Guido van Rossum0980bd91998-02-13 17:18:36 +00001462
Tim Peters50d8d372001-02-28 05:34:27 +00001463/* First we may need a pile of platform-specific header files; the sequence
1464 * of #if's here should match the sequence in the body of case_ok().
1465 */
Jason Tishler7961aa62005-05-20 00:56:54 +00001466#if defined(MS_WINDOWS)
Guido van Rossum0980bd91998-02-13 17:18:36 +00001467#include <windows.h>
Guido van Rossum4c3f57c2001-01-10 20:40:46 +00001468
Tim Peters50d8d372001-02-28 05:34:27 +00001469#elif defined(DJGPP)
1470#include <dir.h>
1471
Jason Tishler7961aa62005-05-20 00:56:54 +00001472#elif (defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) && defined(HAVE_DIRENT_H)
Tim Peters430f5d42001-03-01 01:30:56 +00001473#include <sys/types.h>
1474#include <dirent.h>
1475
Andrew MacIntyred9400542002-02-26 11:41:34 +00001476#elif defined(PYOS_OS2)
1477#define INCL_DOS
1478#define INCL_DOSERRORS
1479#define INCL_NOPMAPI
1480#include <os2.h>
Tim Peters50d8d372001-02-28 05:34:27 +00001481#endif
1482
Guido van Rossum0980bd91998-02-13 17:18:36 +00001483static int
Martin v. Löwis18e16552006-02-15 17:27:45 +00001484case_ok(char *buf, Py_ssize_t len, Py_ssize_t namelen, char *name)
Guido van Rossum0980bd91998-02-13 17:18:36 +00001485{
Tim Peters50d8d372001-02-28 05:34:27 +00001486/* Pick a platform-specific implementation; the sequence of #if's here should
1487 * match the sequence just above.
1488 */
1489
Jason Tishler7961aa62005-05-20 00:56:54 +00001490/* MS_WINDOWS */
1491#if defined(MS_WINDOWS)
Guido van Rossum0980bd91998-02-13 17:18:36 +00001492 WIN32_FIND_DATA data;
1493 HANDLE h;
Tim Peters50d8d372001-02-28 05:34:27 +00001494
Neil Schemenauer7d4bb9f2001-07-23 16:30:27 +00001495 if (Py_GETENV("PYTHONCASEOK") != NULL)
Guido van Rossum0980bd91998-02-13 17:18:36 +00001496 return 1;
Tim Peters50d8d372001-02-28 05:34:27 +00001497
Guido van Rossum0980bd91998-02-13 17:18:36 +00001498 h = FindFirstFile(buf, &data);
1499 if (h == INVALID_HANDLE_VALUE) {
1500 PyErr_Format(PyExc_NameError,
1501 "Can't find file for module %.100s\n(filename %.300s)",
1502 name, buf);
1503 return 0;
1504 }
1505 FindClose(h);
Tim Peters50d8d372001-02-28 05:34:27 +00001506 return strncmp(data.cFileName, name, namelen) == 0;
1507
1508/* DJGPP */
1509#elif defined(DJGPP)
1510 struct ffblk ffblk;
1511 int done;
1512
Neil Schemenauer7d4bb9f2001-07-23 16:30:27 +00001513 if (Py_GETENV("PYTHONCASEOK") != NULL)
Guido van Rossum323bf5e1998-06-24 03:54:06 +00001514 return 1;
Tim Peters50d8d372001-02-28 05:34:27 +00001515
1516 done = findfirst(buf, &ffblk, FA_ARCH|FA_RDONLY|FA_HIDDEN|FA_DIREC);
1517 if (done) {
Guido van Rossum0980bd91998-02-13 17:18:36 +00001518 PyErr_Format(PyExc_NameError,
Tim Peters50d8d372001-02-28 05:34:27 +00001519 "Can't find file for module %.100s\n(filename %.300s)",
Guido van Rossum0980bd91998-02-13 17:18:36 +00001520 name, buf);
1521 return 0;
1522 }
Tim Peters50d8d372001-02-28 05:34:27 +00001523 return strncmp(ffblk.ff_name, name, namelen) == 0;
Guido van Rossum0980bd91998-02-13 17:18:36 +00001524
Jason Tishler7961aa62005-05-20 00:56:54 +00001525/* new-fangled macintosh (macosx) or Cygwin */
1526#elif (defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) && defined(HAVE_DIRENT_H)
Tim Peters430f5d42001-03-01 01:30:56 +00001527 DIR *dirp;
1528 struct dirent *dp;
Tim Petersd1e87a82001-03-01 18:12:00 +00001529 char dirname[MAXPATHLEN + 1];
1530 const int dirlen = len - namelen - 1; /* don't want trailing SEP */
Tim Peters430f5d42001-03-01 01:30:56 +00001531
Neil Schemenauer7d4bb9f2001-07-23 16:30:27 +00001532 if (Py_GETENV("PYTHONCASEOK") != NULL)
Tim Petersdbe6ebb2001-03-01 08:47:29 +00001533 return 1;
1534
Tim Petersd1e87a82001-03-01 18:12:00 +00001535 /* Copy the dir component into dirname; substitute "." if empty */
1536 if (dirlen <= 0) {
1537 dirname[0] = '.';
1538 dirname[1] = '\0';
Tim Peters430f5d42001-03-01 01:30:56 +00001539 }
1540 else {
Tim Petersd1e87a82001-03-01 18:12:00 +00001541 assert(dirlen <= MAXPATHLEN);
1542 memcpy(dirname, buf, dirlen);
1543 dirname[dirlen] = '\0';
Tim Peters430f5d42001-03-01 01:30:56 +00001544 }
1545 /* Open the directory and search the entries for an exact match. */
Tim Petersd1e87a82001-03-01 18:12:00 +00001546 dirp = opendir(dirname);
Tim Peters430f5d42001-03-01 01:30:56 +00001547 if (dirp) {
Tim Peters677898a2001-03-02 03:28:03 +00001548 char *nameWithExt = buf + len - namelen;
Tim Peters430f5d42001-03-01 01:30:56 +00001549 while ((dp = readdir(dirp)) != NULL) {
Tim Petersdbe6ebb2001-03-01 08:47:29 +00001550 const int thislen =
Tim Peters430f5d42001-03-01 01:30:56 +00001551#ifdef _DIRENT_HAVE_D_NAMELEN
Tim Petersdbe6ebb2001-03-01 08:47:29 +00001552 dp->d_namlen;
Tim Peters430f5d42001-03-01 01:30:56 +00001553#else
Tim Petersdbe6ebb2001-03-01 08:47:29 +00001554 strlen(dp->d_name);
Tim Peters430f5d42001-03-01 01:30:56 +00001555#endif
Tim Petersd1e87a82001-03-01 18:12:00 +00001556 if (thislen >= namelen &&
Tim Peters677898a2001-03-02 03:28:03 +00001557 strcmp(dp->d_name, nameWithExt) == 0) {
Tim Peters430f5d42001-03-01 01:30:56 +00001558 (void)closedir(dirp);
1559 return 1; /* Found */
1560 }
1561 }
Tim Petersdbe6ebb2001-03-01 08:47:29 +00001562 (void)closedir(dirp);
Tim Peters430f5d42001-03-01 01:30:56 +00001563 }
Tim Peters430f5d42001-03-01 01:30:56 +00001564 return 0 ; /* Not found */
Tim Peters430f5d42001-03-01 01:30:56 +00001565
Andrew MacIntyred9400542002-02-26 11:41:34 +00001566/* OS/2 */
1567#elif defined(PYOS_OS2)
1568 HDIR hdir = 1;
1569 ULONG srchcnt = 1;
1570 FILEFINDBUF3 ffbuf;
1571 APIRET rc;
1572
1573 if (getenv("PYTHONCASEOK") != NULL)
1574 return 1;
1575
1576 rc = DosFindFirst(buf,
1577 &hdir,
1578 FILE_READONLY | FILE_HIDDEN | FILE_SYSTEM | FILE_DIRECTORY,
1579 &ffbuf, sizeof(ffbuf),
1580 &srchcnt,
1581 FIL_STANDARD);
1582 if (rc != NO_ERROR)
1583 return 0;
1584 return strncmp(ffbuf.achName, name, namelen) == 0;
1585
Tim Peters50d8d372001-02-28 05:34:27 +00001586/* assuming it's a case-sensitive filesystem, so there's nothing to do! */
1587#else
Guido van Rossum0980bd91998-02-13 17:18:36 +00001588 return 1;
Guido van Rossum0980bd91998-02-13 17:18:36 +00001589
Guido van Rossum4d1b3b91998-02-13 23:27:59 +00001590#endif
Tim Peters50d8d372001-02-28 05:34:27 +00001591}
Guido van Rossum4d1b3b91998-02-13 23:27:59 +00001592
Guido van Rossum0980bd91998-02-13 17:18:36 +00001593
Guido van Rossum197346f1997-10-31 18:38:52 +00001594#ifdef HAVE_STAT
1595/* Helper to look for __init__.py or __init__.py[co] in potential package */
1596static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001597find_init_module(char *buf)
Guido van Rossum197346f1997-10-31 18:38:52 +00001598{
Tim Peters0f9431f2001-07-05 03:47:53 +00001599 const size_t save_len = strlen(buf);
Fred Drake4c82b232000-06-30 16:18:57 +00001600 size_t i = save_len;
Tim Peters0f9431f2001-07-05 03:47:53 +00001601 char *pname; /* pointer to start of __init__ */
Guido van Rossum197346f1997-10-31 18:38:52 +00001602 struct stat statbuf;
1603
Tim Peters0f9431f2001-07-05 03:47:53 +00001604/* For calling case_ok(buf, len, namelen, name):
1605 * /a/b/c/d/e/f/g/h/i/j/k/some_long_module_name.py\0
1606 * ^ ^ ^ ^
1607 * |--------------------- buf ---------------------|
1608 * |------------------- len ------------------|
1609 * |------ name -------|
1610 * |----- namelen -----|
1611 */
Guido van Rossum197346f1997-10-31 18:38:52 +00001612 if (save_len + 13 >= MAXPATHLEN)
1613 return 0;
1614 buf[i++] = SEP;
Tim Peters0f9431f2001-07-05 03:47:53 +00001615 pname = buf + i;
1616 strcpy(pname, "__init__.py");
Guido van Rossum197346f1997-10-31 18:38:52 +00001617 if (stat(buf, &statbuf) == 0) {
Tim Peters0f9431f2001-07-05 03:47:53 +00001618 if (case_ok(buf,
1619 save_len + 9, /* len("/__init__") */
1620 8, /* len("__init__") */
1621 pname)) {
1622 buf[save_len] = '\0';
1623 return 1;
1624 }
Guido van Rossum197346f1997-10-31 18:38:52 +00001625 }
Tim Peters0f9431f2001-07-05 03:47:53 +00001626 i += strlen(pname);
1627 strcpy(buf+i, Py_OptimizeFlag ? "o" : "c");
Guido van Rossum197346f1997-10-31 18:38:52 +00001628 if (stat(buf, &statbuf) == 0) {
Tim Peters0f9431f2001-07-05 03:47:53 +00001629 if (case_ok(buf,
1630 save_len + 9, /* len("/__init__") */
1631 8, /* len("__init__") */
1632 pname)) {
1633 buf[save_len] = '\0';
1634 return 1;
1635 }
Guido van Rossum197346f1997-10-31 18:38:52 +00001636 }
1637 buf[save_len] = '\0';
1638 return 0;
1639}
Guido van Rossum48a680c2001-03-02 06:34:14 +00001640
Guido van Rossum197346f1997-10-31 18:38:52 +00001641#endif /* HAVE_STAT */
1642
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001643
Tim Petersdbd9ba62000-07-09 03:09:57 +00001644static int init_builtin(char *); /* Forward */
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001645
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001646/* Load an external module using the default search path and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001647 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001648
Guido van Rossum79f25d91997-04-29 20:08:16 +00001649static PyObject *
Just van Rossum52e14d62002-12-30 22:08:05 +00001650load_module(char *name, FILE *fp, char *buf, int type, PyObject *loader)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001651{
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001652 PyObject *modules;
Guido van Rossum79f25d91997-04-29 20:08:16 +00001653 PyObject *m;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001654 int err;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001655
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001656 /* First check that there's an open file (if we need one) */
1657 switch (type) {
1658 case PY_SOURCE:
1659 case PY_COMPILED:
1660 if (fp == NULL) {
1661 PyErr_Format(PyExc_ValueError,
1662 "file object required for import (type code %d)",
1663 type);
1664 return NULL;
1665 }
1666 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001667
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001668 switch (type) {
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001669
1670 case PY_SOURCE:
1671 m = load_source_module(name, buf, fp);
1672 break;
1673
1674 case PY_COMPILED:
1675 m = load_compiled_module(name, buf, fp);
1676 break;
1677
Guido van Rossum96a8fb71999-12-22 14:09:35 +00001678#ifdef HAVE_DYNAMIC_LOADING
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001679 case C_EXTENSION:
Guido van Rossum79f25d91997-04-29 20:08:16 +00001680 m = _PyImport_LoadDynamicModule(name, buf, fp);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001681 break;
Guido van Rossum96a8fb71999-12-22 14:09:35 +00001682#endif
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001683
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001684 case PKG_DIRECTORY:
1685 m = load_package(name, buf);
1686 break;
1687
1688 case C_BUILTIN:
1689 case PY_FROZEN:
Guido van Rossuma5568d31998-03-05 03:45:08 +00001690 if (buf != NULL && buf[0] != '\0')
1691 name = buf;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001692 if (type == C_BUILTIN)
1693 err = init_builtin(name);
1694 else
1695 err = PyImport_ImportFrozenModule(name);
1696 if (err < 0)
Guido van Rossuma86f77d1997-09-09 18:53:47 +00001697 return NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001698 if (err == 0) {
1699 PyErr_Format(PyExc_ImportError,
1700 "Purported %s module %.200s not found",
1701 type == C_BUILTIN ?
1702 "builtin" : "frozen",
1703 name);
Guido van Rossuma86f77d1997-09-09 18:53:47 +00001704 return NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001705 }
1706 modules = PyImport_GetModuleDict();
1707 m = PyDict_GetItemString(modules, name);
1708 if (m == NULL) {
1709 PyErr_Format(
1710 PyExc_ImportError,
1711 "%s module %.200s not properly initialized",
1712 type == C_BUILTIN ?
1713 "builtin" : "frozen",
1714 name);
Guido van Rossuma86f77d1997-09-09 18:53:47 +00001715 return NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001716 }
1717 Py_INCREF(m);
1718 break;
1719
Just van Rossum52e14d62002-12-30 22:08:05 +00001720 case IMP_HOOK: {
1721 if (loader == NULL) {
1722 PyErr_SetString(PyExc_ImportError,
1723 "import hook without loader");
1724 return NULL;
1725 }
1726 m = PyObject_CallMethod(loader, "load_module", "s", name);
1727 break;
1728 }
1729
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001730 default:
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001731 PyErr_Format(PyExc_ImportError,
1732 "Don't know how to import %.200s (type code %d)",
1733 name, type);
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001734 m = NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001735
1736 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001737
1738 return m;
1739}
1740
1741
1742/* Initialize a built-in module.
Thomas Wouters89f507f2006-12-13 04:49:30 +00001743 Return 1 for success, 0 if the module is not found, and -1 with
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001744 an exception set if the initialization failed. */
Guido van Rossum7f133ed1991-02-19 12:23:57 +00001745
Guido van Rossum7f133ed1991-02-19 12:23:57 +00001746static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001747init_builtin(char *name)
Guido van Rossum7f133ed1991-02-19 12:23:57 +00001748{
Guido van Rossum25ce5661997-08-02 03:10:38 +00001749 struct _inittab *p;
Guido van Rossum25ce5661997-08-02 03:10:38 +00001750
Greg Ward201baee2001-10-04 14:52:06 +00001751 if (_PyImport_FindExtension(name, name) != NULL)
Guido van Rossum25ce5661997-08-02 03:10:38 +00001752 return 1;
1753
Guido van Rossum771c6c81997-10-31 18:37:24 +00001754 for (p = PyImport_Inittab; p->name != NULL; p++) {
Guido van Rossum25ce5661997-08-02 03:10:38 +00001755 if (strcmp(name, p->name) == 0) {
1756 if (p->initfunc == NULL) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001757 PyErr_Format(PyExc_ImportError,
1758 "Cannot re-init internal module %.200s",
1759 name);
Guido van Rossum74e6a111994-08-29 12:54:38 +00001760 return -1;
1761 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00001762 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +00001763 PySys_WriteStderr("import %s # builtin\n", name);
Guido van Rossum25ce5661997-08-02 03:10:38 +00001764 (*p->initfunc)();
Guido van Rossum79f25d91997-04-29 20:08:16 +00001765 if (PyErr_Occurred())
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001766 return -1;
Guido van Rossum25ce5661997-08-02 03:10:38 +00001767 if (_PyImport_FixupExtension(name, name) == NULL)
1768 return -1;
Guido van Rossum7f133ed1991-02-19 12:23:57 +00001769 return 1;
1770 }
1771 }
1772 return 0;
1773}
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001774
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001775
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001776/* Frozen modules */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001777
Guido van Rossumcfd0a221996-06-17 17:06:34 +00001778static struct _frozen *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001779find_frozen(char *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001780{
Guido van Rossumcfd0a221996-06-17 17:06:34 +00001781 struct _frozen *p;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001782
Guido van Rossum79f25d91997-04-29 20:08:16 +00001783 for (p = PyImport_FrozenModules; ; p++) {
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001784 if (p->name == NULL)
1785 return NULL;
1786 if (strcmp(p->name, name) == 0)
1787 break;
1788 }
1789 return p;
1790}
1791
Guido van Rossum79f25d91997-04-29 20:08:16 +00001792static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001793get_frozen_object(char *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001794{
Guido van Rossumcfd0a221996-06-17 17:06:34 +00001795 struct _frozen *p = find_frozen(name);
Guido van Rossuma5568d31998-03-05 03:45:08 +00001796 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001797
1798 if (p == NULL) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001799 PyErr_Format(PyExc_ImportError,
1800 "No such frozen object named %.200s",
1801 name);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001802 return NULL;
1803 }
Guido van Rossum8f4d3312001-10-18 18:54:11 +00001804 if (p->code == NULL) {
1805 PyErr_Format(PyExc_ImportError,
1806 "Excluded frozen object named %.200s",
1807 name);
1808 return NULL;
1809 }
Guido van Rossuma5568d31998-03-05 03:45:08 +00001810 size = p->size;
1811 if (size < 0)
1812 size = -size;
1813 return PyMarshal_ReadObjectFromString((char *)p->code, size);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001814}
1815
1816/* Initialize a frozen module.
1817 Return 1 for succes, 0 if the module is not found, and -1 with
1818 an exception set if the initialization failed.
1819 This function is also used from frozenmain.c */
Guido van Rossum0b344901995-02-07 15:35:27 +00001820
1821int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001822PyImport_ImportFrozenModule(char *name)
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001823{
Guido van Rossumcfd0a221996-06-17 17:06:34 +00001824 struct _frozen *p = find_frozen(name);
Guido van Rossum79f25d91997-04-29 20:08:16 +00001825 PyObject *co;
1826 PyObject *m;
Guido van Rossuma5568d31998-03-05 03:45:08 +00001827 int ispackage;
1828 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001829
1830 if (p == NULL)
1831 return 0;
Guido van Rossum8f4d3312001-10-18 18:54:11 +00001832 if (p->code == NULL) {
1833 PyErr_Format(PyExc_ImportError,
1834 "Excluded frozen object named %.200s",
1835 name);
1836 return -1;
1837 }
Guido van Rossuma5568d31998-03-05 03:45:08 +00001838 size = p->size;
1839 ispackage = (size < 0);
1840 if (ispackage)
1841 size = -size;
Guido van Rossum79f25d91997-04-29 20:08:16 +00001842 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +00001843 PySys_WriteStderr("import %s # frozen%s\n",
Guido van Rossuma5568d31998-03-05 03:45:08 +00001844 name, ispackage ? " package" : "");
1845 co = PyMarshal_ReadObjectFromString((char *)p->code, size);
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001846 if (co == NULL)
1847 return -1;
Guido van Rossum79f25d91997-04-29 20:08:16 +00001848 if (!PyCode_Check(co)) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001849 PyErr_Format(PyExc_TypeError,
1850 "frozen object %.200s is not a code object",
1851 name);
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001852 goto err_return;
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001853 }
Guido van Rossuma5568d31998-03-05 03:45:08 +00001854 if (ispackage) {
1855 /* Set __path__ to the package name */
1856 PyObject *d, *s;
1857 int err;
1858 m = PyImport_AddModule(name);
1859 if (m == NULL)
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001860 goto err_return;
Guido van Rossuma5568d31998-03-05 03:45:08 +00001861 d = PyModule_GetDict(m);
Martin v. Löwis5b222132007-06-10 09:51:05 +00001862 s = PyUnicode_InternFromString(name);
Guido van Rossuma5568d31998-03-05 03:45:08 +00001863 if (s == NULL)
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001864 goto err_return;
Guido van Rossuma5568d31998-03-05 03:45:08 +00001865 err = PyDict_SetItemString(d, "__path__", s);
1866 Py_DECREF(s);
1867 if (err != 0)
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001868 goto err_return;
Guido van Rossuma5568d31998-03-05 03:45:08 +00001869 }
Guido van Rossume32bf6e1998-02-11 05:53:02 +00001870 m = PyImport_ExecCodeModuleEx(name, co, "<frozen>");
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001871 if (m == NULL)
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001872 goto err_return;
1873 Py_DECREF(co);
Guido van Rossum79f25d91997-04-29 20:08:16 +00001874 Py_DECREF(m);
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001875 return 1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001876err_return:
1877 Py_DECREF(co);
1878 return -1;
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001879}
Guido van Rossum74e6a111994-08-29 12:54:38 +00001880
1881
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001882/* Import a module, either built-in, frozen, or external, and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001883 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum74e6a111994-08-29 12:54:38 +00001884
Guido van Rossum79f25d91997-04-29 20:08:16 +00001885PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001886PyImport_ImportModule(const char *name)
Guido van Rossum74e6a111994-08-29 12:54:38 +00001887{
Marc-André Lemburg3c61c352001-02-09 19:40:15 +00001888 PyObject *pname;
1889 PyObject *result;
1890
Martin v. Löwis5b222132007-06-10 09:51:05 +00001891 pname = PyUnicode_FromString(name);
Neal Norwitza11e4c12003-03-23 14:31:01 +00001892 if (pname == NULL)
1893 return NULL;
Marc-André Lemburg3c61c352001-02-09 19:40:15 +00001894 result = PyImport_Import(pname);
1895 Py_DECREF(pname);
1896 return result;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001897}
1898
Guido van Rossum17fc85f1997-09-06 18:52:03 +00001899/* Forward declarations for helper routines */
Thomas Woutersf7f438b2006-02-28 16:09:29 +00001900static PyObject *get_parent(PyObject *globals, char *buf,
1901 Py_ssize_t *p_buflen, int level);
Tim Petersdbd9ba62000-07-09 03:09:57 +00001902static PyObject *load_next(PyObject *mod, PyObject *altmod,
Martin v. Löwis18e16552006-02-15 17:27:45 +00001903 char **p_name, char *buf, Py_ssize_t *p_buflen);
Tim Petersdbd9ba62000-07-09 03:09:57 +00001904static int mark_miss(char *name);
1905static int ensure_fromlist(PyObject *mod, PyObject *fromlist,
Martin v. Löwis18e16552006-02-15 17:27:45 +00001906 char *buf, Py_ssize_t buflen, int recursive);
Tim Petersdbd9ba62000-07-09 03:09:57 +00001907static PyObject * import_submodule(PyObject *mod, char *name, char *fullname);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00001908
1909/* The Magnum Opus of dotted-name import :-) */
1910
Guido van Rossum75acc9c1998-03-03 22:26:50 +00001911static PyObject *
Thomas Woutersf7f438b2006-02-28 16:09:29 +00001912import_module_level(char *name, PyObject *globals, PyObject *locals,
1913 PyObject *fromlist, int level)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001914{
Guido van Rossum17fc85f1997-09-06 18:52:03 +00001915 char buf[MAXPATHLEN+1];
Martin v. Löwis18e16552006-02-15 17:27:45 +00001916 Py_ssize_t buflen = 0;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00001917 PyObject *parent, *head, *next, *tail;
1918
Thomas Woutersf7f438b2006-02-28 16:09:29 +00001919 parent = get_parent(globals, buf, &buflen, level);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00001920 if (parent == NULL)
1921 return NULL;
1922
1923 head = load_next(parent, Py_None, &name, buf, &buflen);
1924 if (head == NULL)
1925 return NULL;
1926
1927 tail = head;
1928 Py_INCREF(tail);
1929 while (name) {
1930 next = load_next(tail, tail, &name, buf, &buflen);
1931 Py_DECREF(tail);
1932 if (next == NULL) {
1933 Py_DECREF(head);
1934 return NULL;
1935 }
1936 tail = next;
1937 }
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001938 if (tail == Py_None) {
1939 /* If tail is Py_None, both get_parent and load_next found
1940 an empty module name: someone called __import__("") or
1941 doctored faulty bytecode */
1942 Py_DECREF(tail);
1943 Py_DECREF(head);
1944 PyErr_SetString(PyExc_ValueError,
1945 "Empty module name");
1946 return NULL;
1947 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00001948
1949 if (fromlist != NULL) {
1950 if (fromlist == Py_None || !PyObject_IsTrue(fromlist))
1951 fromlist = NULL;
1952 }
1953
1954 if (fromlist == NULL) {
1955 Py_DECREF(tail);
1956 return head;
1957 }
1958
1959 Py_DECREF(head);
Guido van Rossum9905ef91997-09-08 16:07:11 +00001960 if (!ensure_fromlist(tail, fromlist, buf, buflen, 0)) {
Guido van Rossum17fc85f1997-09-06 18:52:03 +00001961 Py_DECREF(tail);
1962 return NULL;
1963 }
1964
1965 return tail;
1966}
1967
Thomas Woutersf7f438b2006-02-28 16:09:29 +00001968/* For DLL compatibility */
1969#undef PyImport_ImportModuleEx
Guido van Rossum75acc9c1998-03-03 22:26:50 +00001970PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001971PyImport_ImportModuleEx(char *name, PyObject *globals, PyObject *locals,
1972 PyObject *fromlist)
Guido van Rossum75acc9c1998-03-03 22:26:50 +00001973{
1974 PyObject *result;
1975 lock_import();
Thomas Woutersf7f438b2006-02-28 16:09:29 +00001976 result = import_module_level(name, globals, locals, fromlist, -1);
1977 if (unlock_import() < 0) {
1978 Py_XDECREF(result);
1979 PyErr_SetString(PyExc_RuntimeError,
1980 "not holding the import lock");
1981 return NULL;
1982 }
1983 return result;
1984}
1985#define PyImport_ImportModuleEx(n, g, l, f) \
1986 PyImport_ImportModuleLevel(n, g, l, f, -1);
1987
1988PyObject *
1989PyImport_ImportModuleLevel(char *name, PyObject *globals, PyObject *locals,
1990 PyObject *fromlist, int level)
1991{
1992 PyObject *result;
1993 lock_import();
1994 result = import_module_level(name, globals, locals, fromlist, level);
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00001995 if (unlock_import() < 0) {
1996 Py_XDECREF(result);
1997 PyErr_SetString(PyExc_RuntimeError,
1998 "not holding the import lock");
1999 return NULL;
2000 }
Guido van Rossum75acc9c1998-03-03 22:26:50 +00002001 return result;
2002}
2003
Fred Drake87590902004-05-28 20:21:36 +00002004/* Return the package that an import is being performed in. If globals comes
2005 from the module foo.bar.bat (not itself a package), this returns the
2006 sys.modules entry for foo.bar. If globals is from a package's __init__.py,
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00002007 the package's entry in sys.modules is returned, as a borrowed reference.
Fred Drake87590902004-05-28 20:21:36 +00002008
2009 The *name* of the returned package is returned in buf, with the length of
2010 the name in *p_buflen.
2011
2012 If globals doesn't come from a package or a module in a package, or a
2013 corresponding entry is not found in sys.modules, Py_None is returned.
2014*/
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002015static PyObject *
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002016get_parent(PyObject *globals, char *buf, Py_ssize_t *p_buflen, int level)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002017{
2018 static PyObject *namestr = NULL;
2019 static PyObject *pathstr = NULL;
Nick Coghlande10c852007-12-04 12:22:52 +00002020 static PyObject *pkgstr = NULL;
2021 PyObject *pkgname, *modname, *modpath, *modules, *parent;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002022
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002023 if (globals == NULL || !PyDict_Check(globals) || !level)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002024 return Py_None;
2025
2026 if (namestr == NULL) {
Martin v. Löwis5b222132007-06-10 09:51:05 +00002027 namestr = PyUnicode_InternFromString("__name__");
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002028 if (namestr == NULL)
2029 return NULL;
2030 }
2031 if (pathstr == NULL) {
Martin v. Löwis5b222132007-06-10 09:51:05 +00002032 pathstr = PyUnicode_InternFromString("__path__");
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002033 if (pathstr == NULL)
2034 return NULL;
2035 }
Nick Coghlande10c852007-12-04 12:22:52 +00002036 if (pkgstr == NULL) {
2037 pkgstr = PyUnicode_InternFromString("__package__");
2038 if (pkgstr == NULL)
2039 return NULL;
2040 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002041
2042 *buf = '\0';
2043 *p_buflen = 0;
Nick Coghlande10c852007-12-04 12:22:52 +00002044 pkgname = PyDict_GetItem(globals, pkgstr);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002045
Nick Coghlande10c852007-12-04 12:22:52 +00002046 if ((pkgname != NULL) && (pkgname != Py_None)) {
2047 /* __package__ is set, so use it */
2048 Py_ssize_t len;
2049 if (!PyUnicode_Check(pkgname)) {
2050 PyErr_SetString(PyExc_ValueError,
2051 "__package__ set to non-string");
2052 return NULL;
2053 }
2054 len = PyUnicode_GET_SIZE(pkgname);
2055 if (len == 0) {
2056 if (level > 0) {
2057 PyErr_SetString(PyExc_ValueError,
2058 "Attempted relative import in non-package");
2059 return NULL;
2060 }
2061 return Py_None;
2062 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002063 if (len > MAXPATHLEN) {
2064 PyErr_SetString(PyExc_ValueError,
Nick Coghlande10c852007-12-04 12:22:52 +00002065 "Package name too long");
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002066 return NULL;
2067 }
Nick Coghlande10c852007-12-04 12:22:52 +00002068 strcpy(buf, PyUnicode_AsString(pkgname));
2069 } else {
2070 /* __package__ not set, so figure it out and set it */
2071 modname = PyDict_GetItem(globals, namestr);
2072 if (modname == NULL || !PyUnicode_Check(modname))
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002073 return Py_None;
Nick Coghlande10c852007-12-04 12:22:52 +00002074
2075 modpath = PyDict_GetItem(globals, pathstr);
2076 if (modpath != NULL) {
2077 /* __path__ is set, so modname is already the package name */
2078 Py_ssize_t len = PyUnicode_GET_SIZE(modname);
2079 int error;
2080 if (len > MAXPATHLEN) {
2081 PyErr_SetString(PyExc_ValueError,
2082 "Module name too long");
2083 return NULL;
2084 }
2085 strcpy(buf, PyUnicode_AsString(modname));
2086 error = PyDict_SetItem(globals, pkgstr, modname);
2087 if (error) {
2088 PyErr_SetString(PyExc_ValueError,
2089 "Could not set __package__");
2090 return NULL;
2091 }
2092 } else {
2093 /* Normal module, so work out the package name if any */
2094 char *start = PyUnicode_AsString(modname);
2095 char *lastdot = strrchr(start, '.');
2096 size_t len;
2097 int error;
2098 if (lastdot == NULL && level > 0) {
2099 PyErr_SetString(PyExc_ValueError,
2100 "Attempted relative import in non-package");
2101 return NULL;
2102 }
2103 if (lastdot == NULL) {
2104 error = PyDict_SetItem(globals, pkgstr, Py_None);
2105 if (error) {
2106 PyErr_SetString(PyExc_ValueError,
2107 "Could not set __package__");
2108 return NULL;
2109 }
2110 return Py_None;
2111 }
2112 len = lastdot - start;
2113 if (len >= MAXPATHLEN) {
2114 PyErr_SetString(PyExc_ValueError,
2115 "Module name too long");
2116 return NULL;
2117 }
2118 strncpy(buf, start, len);
2119 buf[len] = '\0';
2120 pkgname = PyUnicode_FromString(buf);
2121 if (pkgname == NULL) {
2122 return NULL;
2123 }
2124 error = PyDict_SetItem(globals, pkgstr, pkgname);
2125 Py_DECREF(pkgname);
2126 if (error) {
2127 PyErr_SetString(PyExc_ValueError,
2128 "Could not set __package__");
2129 return NULL;
2130 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002131 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002132 }
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002133 while (--level > 0) {
2134 char *dot = strrchr(buf, '.');
2135 if (dot == NULL) {
2136 PyErr_SetString(PyExc_ValueError,
Thomas Wouters89f507f2006-12-13 04:49:30 +00002137 "Attempted relative import beyond "
2138 "toplevel package");
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002139 return NULL;
2140 }
2141 *dot = '\0';
2142 }
2143 *p_buflen = strlen(buf);
2144
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002145 modules = PyImport_GetModuleDict();
2146 parent = PyDict_GetItemString(modules, buf);
2147 if (parent == NULL)
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002148 PyErr_Format(PyExc_SystemError,
2149 "Parent module '%.200s' not loaded", buf);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002150 return parent;
2151 /* We expect, but can't guarantee, if parent != None, that:
2152 - parent.__name__ == buf
2153 - parent.__dict__ is globals
2154 If this is violated... Who cares? */
2155}
2156
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002157/* altmod is either None or same as mod */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002158static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002159load_next(PyObject *mod, PyObject *altmod, char **p_name, char *buf,
Martin v. Löwis18e16552006-02-15 17:27:45 +00002160 Py_ssize_t *p_buflen)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002161{
2162 char *name = *p_name;
2163 char *dot = strchr(name, '.');
Fred Drake4c82b232000-06-30 16:18:57 +00002164 size_t len;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002165 char *p;
2166 PyObject *result;
2167
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002168 if (strlen(name) == 0) {
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002169 /* completely empty module name should only happen in
2170 'from . import' (or '__import__("")')*/
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002171 Py_INCREF(mod);
2172 *p_name = NULL;
2173 return mod;
2174 }
2175
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002176 if (dot == NULL) {
2177 *p_name = NULL;
2178 len = strlen(name);
2179 }
2180 else {
2181 *p_name = dot+1;
2182 len = dot-name;
2183 }
Guido van Rossum111c20b1998-04-11 17:38:22 +00002184 if (len == 0) {
2185 PyErr_SetString(PyExc_ValueError,
2186 "Empty module name");
2187 return NULL;
2188 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002189
2190 p = buf + *p_buflen;
2191 if (p != buf)
2192 *p++ = '.';
2193 if (p+len-buf >= MAXPATHLEN) {
2194 PyErr_SetString(PyExc_ValueError,
2195 "Module name too long");
2196 return NULL;
2197 }
2198 strncpy(p, name, len);
2199 p[len] = '\0';
2200 *p_buflen = p+len-buf;
2201
2202 result = import_submodule(mod, p, buf);
2203 if (result == Py_None && altmod != mod) {
2204 Py_DECREF(result);
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00002205 /* Here, altmod must be None and mod must not be None */
Guido van Rossum0c819451997-09-07 06:16:57 +00002206 result = import_submodule(altmod, p, p);
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00002207 if (result != NULL && result != Py_None) {
2208 if (mark_miss(buf) != 0) {
2209 Py_DECREF(result);
2210 return NULL;
2211 }
2212 strncpy(buf, name, len);
2213 buf[len] = '\0';
2214 *p_buflen = len;
2215 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002216 }
2217 if (result == NULL)
2218 return NULL;
2219
2220 if (result == Py_None) {
2221 Py_DECREF(result);
2222 PyErr_Format(PyExc_ImportError,
2223 "No module named %.200s", name);
2224 return NULL;
2225 }
2226
2227 return result;
2228}
2229
2230static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002231mark_miss(char *name)
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00002232{
2233 PyObject *modules = PyImport_GetModuleDict();
2234 return PyDict_SetItemString(modules, name, Py_None);
2235}
2236
2237static int
Martin v. Löwis18e16552006-02-15 17:27:45 +00002238ensure_fromlist(PyObject *mod, PyObject *fromlist, char *buf, Py_ssize_t buflen,
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002239 int recursive)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002240{
2241 int i;
2242
2243 if (!PyObject_HasAttrString(mod, "__path__"))
2244 return 1;
2245
2246 for (i = 0; ; i++) {
2247 PyObject *item = PySequence_GetItem(fromlist, i);
2248 int hasit;
2249 if (item == NULL) {
2250 if (PyErr_ExceptionMatches(PyExc_IndexError)) {
2251 PyErr_Clear();
2252 return 1;
2253 }
2254 return 0;
2255 }
Martin v. Löwis5b222132007-06-10 09:51:05 +00002256 if (!PyUnicode_Check(item)) {
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002257 PyErr_SetString(PyExc_TypeError,
Neal Norwitz80e7f272007-08-26 06:45:23 +00002258 "Item in ``from list'' not a string");
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002259 Py_DECREF(item);
2260 return 0;
2261 }
Martin v. Löwis5b222132007-06-10 09:51:05 +00002262 if (PyUnicode_AS_UNICODE(item)[0] == '*') {
Guido van Rossum9905ef91997-09-08 16:07:11 +00002263 PyObject *all;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002264 Py_DECREF(item);
Guido van Rossum9905ef91997-09-08 16:07:11 +00002265 /* See if the package defines __all__ */
2266 if (recursive)
2267 continue; /* Avoid endless recursion */
2268 all = PyObject_GetAttrString(mod, "__all__");
2269 if (all == NULL)
2270 PyErr_Clear();
2271 else {
Martin v. Löwis83969ee2004-03-23 16:28:13 +00002272 int ret = ensure_fromlist(mod, all, buf, buflen, 1);
Guido van Rossum9905ef91997-09-08 16:07:11 +00002273 Py_DECREF(all);
Martin v. Löwis83969ee2004-03-23 16:28:13 +00002274 if (!ret)
2275 return 0;
Guido van Rossum9905ef91997-09-08 16:07:11 +00002276 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002277 continue;
2278 }
2279 hasit = PyObject_HasAttr(mod, item);
2280 if (!hasit) {
Martin v. Löwis5b222132007-06-10 09:51:05 +00002281 PyObject *item8;
2282 char *subname;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002283 PyObject *submod;
2284 char *p;
Martin v. Löwis5b222132007-06-10 09:51:05 +00002285 if (!Py_FileSystemDefaultEncoding) {
2286 item8 = PyUnicode_EncodeASCII(PyUnicode_AsUnicode(item),
2287 PyUnicode_GetSize(item),
Martin v. Löwis427dbff2007-06-12 05:53:00 +00002288 NULL);
Martin v. Löwis5b222132007-06-10 09:51:05 +00002289 } else {
Guido van Rossum98297ee2007-11-06 21:34:58 +00002290 item8 = PyUnicode_AsEncodedString(item,
2291 Py_FileSystemDefaultEncoding, NULL);
Martin v. Löwis5b222132007-06-10 09:51:05 +00002292 }
2293 if (!item8) {
2294 PyErr_SetString(PyExc_ValueError, "Cannot encode path item");
2295 return 0;
2296 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00002297 subname = PyString_AS_STRING(item8);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002298 if (buflen + strlen(subname) >= MAXPATHLEN) {
2299 PyErr_SetString(PyExc_ValueError,
2300 "Module name too long");
2301 Py_DECREF(item);
2302 return 0;
2303 }
2304 p = buf + buflen;
2305 *p++ = '.';
2306 strcpy(p, subname);
2307 submod = import_submodule(mod, subname, buf);
Martin v. Löwis5b222132007-06-10 09:51:05 +00002308 Py_DECREF(item8);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002309 Py_XDECREF(submod);
2310 if (submod == NULL) {
2311 Py_DECREF(item);
2312 return 0;
2313 }
2314 }
2315 Py_DECREF(item);
2316 }
2317
Guido van Rossuma7f2e811997-10-03 15:33:32 +00002318 /* NOTREACHED */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002319}
2320
Neil Schemenauer00b09662003-06-16 21:03:07 +00002321static int
2322add_submodule(PyObject *mod, PyObject *submod, char *fullname, char *subname,
2323 PyObject *modules)
2324{
2325 if (mod == Py_None)
2326 return 1;
2327 /* Irrespective of the success of this load, make a
2328 reference to it in the parent package module. A copy gets
2329 saved in the modules dictionary under the full name, so get a
2330 reference from there, if need be. (The exception is when the
2331 load failed with a SyntaxError -- then there's no trace in
2332 sys.modules. In that case, of course, do nothing extra.) */
2333 if (submod == NULL) {
2334 submod = PyDict_GetItemString(modules, fullname);
2335 if (submod == NULL)
2336 return 1;
2337 }
2338 if (PyModule_Check(mod)) {
2339 /* We can't use setattr here since it can give a
2340 * spurious warning if the submodule name shadows a
2341 * builtin name */
2342 PyObject *dict = PyModule_GetDict(mod);
2343 if (!dict)
2344 return 0;
2345 if (PyDict_SetItemString(dict, subname, submod) < 0)
2346 return 0;
2347 }
2348 else {
2349 if (PyObject_SetAttrString(mod, subname, submod) < 0)
2350 return 0;
2351 }
2352 return 1;
2353}
2354
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002355static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002356import_submodule(PyObject *mod, char *subname, char *fullname)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002357{
Guido van Rossum25ce5661997-08-02 03:10:38 +00002358 PyObject *modules = PyImport_GetModuleDict();
Neil Schemenauer00b09662003-06-16 21:03:07 +00002359 PyObject *m = NULL;
Guido van Rossum74e6a111994-08-29 12:54:38 +00002360
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002361 /* Require:
2362 if mod == None: subname == fullname
2363 else: mod.__name__ + "." + subname == fullname
2364 */
2365
Tim Peters50d8d372001-02-28 05:34:27 +00002366 if ((m = PyDict_GetItemString(modules, fullname)) != NULL) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00002367 Py_INCREF(m);
Guido van Rossum7f9fa971995-01-20 16:53:12 +00002368 }
2369 else {
Just van Rossum52e14d62002-12-30 22:08:05 +00002370 PyObject *path, *loader = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002371 char buf[MAXPATHLEN+1];
2372 struct filedescr *fdp;
2373 FILE *fp = NULL;
2374
Guido van Rossum9c0afe51998-05-19 15:09:05 +00002375 if (mod == Py_None)
2376 path = NULL;
2377 else {
2378 path = PyObject_GetAttrString(mod, "__path__");
2379 if (path == NULL) {
2380 PyErr_Clear();
2381 Py_INCREF(Py_None);
2382 return Py_None;
2383 }
2384 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002385
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002386 buf[0] = '\0';
Just van Rossum52e14d62002-12-30 22:08:05 +00002387 fdp = find_module(fullname, subname, path, buf, MAXPATHLEN+1,
2388 &fp, &loader);
Guido van Rossumb68cd421998-07-01 17:36:26 +00002389 Py_XDECREF(path);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002390 if (fdp == NULL) {
2391 if (!PyErr_ExceptionMatches(PyExc_ImportError))
2392 return NULL;
2393 PyErr_Clear();
2394 Py_INCREF(Py_None);
2395 return Py_None;
2396 }
Just van Rossum52e14d62002-12-30 22:08:05 +00002397 m = load_module(fullname, fp, buf, fdp->type, loader);
2398 Py_XDECREF(loader);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002399 if (fp)
2400 fclose(fp);
Neil Schemenauer00b09662003-06-16 21:03:07 +00002401 if (!add_submodule(mod, m, fullname, subname, modules)) {
2402 Py_XDECREF(m);
2403 m = NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002404 }
Guido van Rossum74e6a111994-08-29 12:54:38 +00002405 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002406
2407 return m;
Guido van Rossum74e6a111994-08-29 12:54:38 +00002408}
2409
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002410
2411/* Re-import a module of any kind and return its module object, WITH
2412 INCREMENTED REFERENCE COUNT */
2413
Guido van Rossum79f25d91997-04-29 20:08:16 +00002414PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002415PyImport_ReloadModule(PyObject *m)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002416{
Guido van Rossumd8faa362007-04-27 19:54:29 +00002417 PyInterpreterState *interp = PyThreadState_Get()->interp;
2418 PyObject *modules_reloading = interp->modules_reloading;
Guido van Rossum25ce5661997-08-02 03:10:38 +00002419 PyObject *modules = PyImport_GetModuleDict();
Guido van Rossumd8faa362007-04-27 19:54:29 +00002420 PyObject *path = NULL, *loader = NULL, *existing_m = NULL;
Guido van Rossum222ef561997-09-06 19:41:09 +00002421 char *name, *subname;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002422 char buf[MAXPATHLEN+1];
2423 struct filedescr *fdp;
2424 FILE *fp = NULL;
Tim Peters1cd70172004-08-02 03:52:12 +00002425 PyObject *newm;
Guido van Rossumd8faa362007-04-27 19:54:29 +00002426
2427 if (modules_reloading == NULL) {
2428 Py_FatalError("PyImport_ReloadModule: "
Guido van Rossume7ba4952007-06-06 23:52:48 +00002429 "no modules_reloading dictionary!");
Guido van Rossumd8faa362007-04-27 19:54:29 +00002430 return NULL;
2431 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002432
Guido van Rossum79f25d91997-04-29 20:08:16 +00002433 if (m == NULL || !PyModule_Check(m)) {
2434 PyErr_SetString(PyExc_TypeError,
2435 "reload() argument must be module");
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002436 return NULL;
2437 }
Neal Norwitz5616c6d2007-08-26 05:32:41 +00002438 name = (char*)PyModule_GetName(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002439 if (name == NULL)
2440 return NULL;
Guido van Rossum25ce5661997-08-02 03:10:38 +00002441 if (m != PyDict_GetItemString(modules, name)) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002442 PyErr_Format(PyExc_ImportError,
2443 "reload(): module %.200s not in sys.modules",
2444 name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002445 return NULL;
2446 }
Guido van Rossumd8faa362007-04-27 19:54:29 +00002447 existing_m = PyDict_GetItemString(modules_reloading, name);
2448 if (existing_m != NULL) {
2449 /* Due to a recursive reload, this module is already
2450 being reloaded. */
2451 Py_INCREF(existing_m);
2452 return existing_m;
2453 }
2454 if (PyDict_SetItemString(modules_reloading, name, m) < 0)
2455 return NULL;
2456
Guido van Rossum222ef561997-09-06 19:41:09 +00002457 subname = strrchr(name, '.');
2458 if (subname == NULL)
2459 subname = name;
2460 else {
2461 PyObject *parentname, *parent;
Christian Heimesc4cb3b82007-11-04 12:10:01 +00002462 parentname = PyUnicode_FromStringAndSize(name, (subname-name));
Guido van Rossumd8faa362007-04-27 19:54:29 +00002463 if (parentname == NULL) {
2464 imp_modules_reloading_clear();
Guido van Rossum222ef561997-09-06 19:41:09 +00002465 return NULL;
Guido van Rossumd8faa362007-04-27 19:54:29 +00002466 }
Guido van Rossum222ef561997-09-06 19:41:09 +00002467 parent = PyDict_GetItem(modules, parentname);
2468 if (parent == NULL) {
2469 PyErr_Format(PyExc_ImportError,
2470 "reload(): parent %.200s not in sys.modules",
Christian Heimesc4cb3b82007-11-04 12:10:01 +00002471 PyUnicode_AsString(parentname));
Georg Brandl0c55f292005-09-14 06:56:20 +00002472 Py_DECREF(parentname);
Guido van Rossume7ba4952007-06-06 23:52:48 +00002473 imp_modules_reloading_clear();
Guido van Rossum222ef561997-09-06 19:41:09 +00002474 return NULL;
2475 }
Georg Brandl0c55f292005-09-14 06:56:20 +00002476 Py_DECREF(parentname);
Guido van Rossum222ef561997-09-06 19:41:09 +00002477 subname++;
2478 path = PyObject_GetAttrString(parent, "__path__");
2479 if (path == NULL)
2480 PyErr_Clear();
2481 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002482 buf[0] = '\0';
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00002483 fdp = find_module(name, subname, path, buf, MAXPATHLEN+1, &fp, &loader);
Guido van Rossum222ef561997-09-06 19:41:09 +00002484 Py_XDECREF(path);
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00002485
2486 if (fdp == NULL) {
2487 Py_XDECREF(loader);
Guido van Rossumd8faa362007-04-27 19:54:29 +00002488 imp_modules_reloading_clear();
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002489 return NULL;
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00002490 }
2491
2492 newm = load_module(name, fp, buf, fdp->type, loader);
2493 Py_XDECREF(loader);
2494
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002495 if (fp)
2496 fclose(fp);
Tim Peters1cd70172004-08-02 03:52:12 +00002497 if (newm == NULL) {
2498 /* load_module probably removed name from modules because of
2499 * the error. Put back the original module object. We're
2500 * going to return NULL in this case regardless of whether
2501 * replacing name succeeds, so the return value is ignored.
2502 */
2503 PyDict_SetItemString(modules, name, m);
2504 }
Guido van Rossumd8faa362007-04-27 19:54:29 +00002505 imp_modules_reloading_clear();
Tim Peters1cd70172004-08-02 03:52:12 +00002506 return newm;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002507}
2508
2509
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002510/* Higher-level import emulator which emulates the "import" statement
2511 more accurately -- it invokes the __import__() function from the
2512 builtins of the current globals. This means that the import is
2513 done using whatever import hooks are installed in the current
Guido van Rossum6058eb41998-12-21 19:51:00 +00002514 environment, e.g. by "rexec".
2515 A dummy list ["__doc__"] is passed as the 4th argument so that
Neal Norwitz80e7f272007-08-26 06:45:23 +00002516 e.g. PyImport_Import(PyUnicode_FromString("win32com.client.gencache"))
Guido van Rossum6058eb41998-12-21 19:51:00 +00002517 will return <module "gencache"> instead of <module "win32com">. */
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002518
2519PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002520PyImport_Import(PyObject *module_name)
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002521{
2522 static PyObject *silly_list = NULL;
2523 static PyObject *builtins_str = NULL;
2524 static PyObject *import_str = NULL;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002525 PyObject *globals = NULL;
2526 PyObject *import = NULL;
2527 PyObject *builtins = NULL;
2528 PyObject *r = NULL;
2529
2530 /* Initialize constant string objects */
2531 if (silly_list == NULL) {
Martin v. Löwis5b222132007-06-10 09:51:05 +00002532 import_str = PyUnicode_InternFromString("__import__");
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002533 if (import_str == NULL)
2534 return NULL;
Martin v. Löwis5b222132007-06-10 09:51:05 +00002535 builtins_str = PyUnicode_InternFromString("__builtins__");
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002536 if (builtins_str == NULL)
2537 return NULL;
2538 silly_list = Py_BuildValue("[s]", "__doc__");
2539 if (silly_list == NULL)
2540 return NULL;
2541 }
2542
2543 /* Get the builtins from current globals */
2544 globals = PyEval_GetGlobals();
Guido van Rossum85cd1d62001-02-20 21:43:24 +00002545 if (globals != NULL) {
Guido van Rossum66468561998-10-22 15:46:50 +00002546 Py_INCREF(globals);
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002547 builtins = PyObject_GetItem(globals, builtins_str);
2548 if (builtins == NULL)
2549 goto err;
2550 }
2551 else {
2552 /* No globals -- use standard builtins, and fake globals */
2553 PyErr_Clear();
2554
Georg Brandl1a3284e2007-12-02 09:40:06 +00002555 builtins = PyImport_ImportModuleLevel("builtins",
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002556 NULL, NULL, NULL, 0);
Guido van Rossum85cd1d62001-02-20 21:43:24 +00002557 if (builtins == NULL)
2558 return NULL;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002559 globals = Py_BuildValue("{OO}", builtins_str, builtins);
2560 if (globals == NULL)
2561 goto err;
2562 }
2563
2564 /* Get the __import__ function from the builtins */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002565 if (PyDict_Check(builtins)) {
Fred Drakea76ba6e2001-03-06 06:31:15 +00002566 import = PyObject_GetItem(builtins, import_str);
Tim Peters6d6c1a32001-08-02 04:15:00 +00002567 if (import == NULL)
2568 PyErr_SetObject(PyExc_KeyError, import_str);
2569 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002570 else
Fred Drakea76ba6e2001-03-06 06:31:15 +00002571 import = PyObject_GetAttr(builtins, import_str);
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002572 if (import == NULL)
2573 goto err;
2574
Guido van Rossumd8faa362007-04-27 19:54:29 +00002575 /* Call the __import__ function with the proper argument list */
Thomas Wouters477c8d52006-05-27 19:21:47 +00002576 r = PyObject_CallFunctionObjArgs(import, module_name, globals,
2577 globals, silly_list, NULL);
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002578
2579 err:
2580 Py_XDECREF(globals);
2581 Py_XDECREF(builtins);
2582 Py_XDECREF(import);
Tim Peters50d8d372001-02-28 05:34:27 +00002583
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002584 return r;
2585}
2586
2587
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002588/* Module 'imp' provides Python access to the primitives used for
2589 importing modules.
2590*/
2591
Guido van Rossum79f25d91997-04-29 20:08:16 +00002592static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +00002593imp_get_magic(PyObject *self, PyObject *noargs)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002594{
2595 char buf[4];
2596
Guido van Rossum96774c12000-05-01 20:19:08 +00002597 buf[0] = (char) ((pyc_magic >> 0) & 0xff);
2598 buf[1] = (char) ((pyc_magic >> 8) & 0xff);
2599 buf[2] = (char) ((pyc_magic >> 16) & 0xff);
2600 buf[3] = (char) ((pyc_magic >> 24) & 0xff);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002601
Guido van Rossumad8d3002007-08-03 18:40:49 +00002602 return PyBytes_FromStringAndSize(buf, 4);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002603}
2604
Guido van Rossum79f25d91997-04-29 20:08:16 +00002605static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +00002606imp_get_suffixes(PyObject *self, PyObject *noargs)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002607{
Guido van Rossum79f25d91997-04-29 20:08:16 +00002608 PyObject *list;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002609 struct filedescr *fdp;
2610
Guido van Rossum79f25d91997-04-29 20:08:16 +00002611 list = PyList_New(0);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002612 if (list == NULL)
2613 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002614 for (fdp = _PyImport_Filetab; fdp->suffix != NULL; fdp++) {
2615 PyObject *item = Py_BuildValue("ssi",
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002616 fdp->suffix, fdp->mode, fdp->type);
2617 if (item == NULL) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00002618 Py_DECREF(list);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002619 return NULL;
2620 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002621 if (PyList_Append(list, item) < 0) {
2622 Py_DECREF(list);
2623 Py_DECREF(item);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002624 return NULL;
2625 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002626 Py_DECREF(item);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002627 }
2628 return list;
2629}
2630
Guido van Rossum79f25d91997-04-29 20:08:16 +00002631static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002632call_find_module(char *name, PyObject *path)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002633{
Tim Petersdbd9ba62000-07-09 03:09:57 +00002634 extern int fclose(FILE *);
Guido van Rossum79f25d91997-04-29 20:08:16 +00002635 PyObject *fob, *ret;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002636 struct filedescr *fdp;
2637 char pathname[MAXPATHLEN+1];
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002638 FILE *fp = NULL;
Guido van Rossum40d20bc2007-10-22 00:09:51 +00002639 int fd = -1;
Brett Cannon3bb42d92007-10-20 03:43:15 +00002640 char *found_encoding = NULL;
Guido van Rossumce3a72a2007-10-19 23:16:50 +00002641 char *encoding = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002642
2643 pathname[0] = '\0';
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002644 if (path == Py_None)
2645 path = NULL;
Just van Rossum52e14d62002-12-30 22:08:05 +00002646 fdp = find_module(NULL, name, path, pathname, MAXPATHLEN+1, &fp, NULL);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002647 if (fdp == NULL)
2648 return NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002649 if (fp != NULL) {
Guido van Rossum40d20bc2007-10-22 00:09:51 +00002650 fd = fileno(fp);
2651 if (fd != -1)
2652 fd = dup(fd);
2653 fclose(fp);
2654 fp = NULL;
2655 }
2656 if (fd != -1) {
Guido van Rossumce3a72a2007-10-19 23:16:50 +00002657 if (strchr(fdp->mode, 'b') == NULL) {
Brett Cannon3bb42d92007-10-20 03:43:15 +00002658 /* PyTokenizer_FindEncoding() returns PyMem_MALLOC'ed
2659 memory. */
Guido van Rossum40d20bc2007-10-22 00:09:51 +00002660 found_encoding = PyTokenizer_FindEncoding(fd);
2661 lseek(fd, 0, 0); /* Reset position */
Brett Cannon3bb42d92007-10-20 03:43:15 +00002662 encoding = (found_encoding != NULL) ? found_encoding :
Guido van Rossumce3a72a2007-10-19 23:16:50 +00002663 (char*)PyUnicode_GetDefaultEncoding();
2664 }
Guido van Rossum40d20bc2007-10-22 00:09:51 +00002665 fob = PyFile_FromFd(fd, pathname, fdp->mode, -1,
Guido van Rossume7fc50f2007-12-03 22:54:21 +00002666 (char*)encoding, NULL, NULL, 1);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002667 if (fob == NULL) {
Guido van Rossum40d20bc2007-10-22 00:09:51 +00002668 close(fd);
Brett Cannon3bb42d92007-10-20 03:43:15 +00002669 PyMem_FREE(found_encoding);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002670 return NULL;
2671 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002672 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002673 else {
2674 fob = Py_None;
2675 Py_INCREF(fob);
Tim Peters50d8d372001-02-28 05:34:27 +00002676 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002677 ret = Py_BuildValue("Os(ssi)",
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002678 fob, pathname, fdp->suffix, fdp->mode, fdp->type);
Guido van Rossum79f25d91997-04-29 20:08:16 +00002679 Py_DECREF(fob);
Brett Cannon3bb42d92007-10-20 03:43:15 +00002680 PyMem_FREE(found_encoding);
2681
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002682 return ret;
2683}
2684
Guido van Rossum79f25d91997-04-29 20:08:16 +00002685static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002686imp_find_module(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002687{
2688 char *name;
2689 PyObject *path = NULL;
Guido van Rossum43713e52000-02-29 13:59:29 +00002690 if (!PyArg_ParseTuple(args, "s|O:find_module", &name, &path))
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002691 return NULL;
2692 return call_find_module(name, path);
2693}
2694
2695static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002696imp_init_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002697{
2698 char *name;
2699 int ret;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002700 PyObject *m;
Guido van Rossum43713e52000-02-29 13:59:29 +00002701 if (!PyArg_ParseTuple(args, "s:init_builtin", &name))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002702 return NULL;
2703 ret = init_builtin(name);
2704 if (ret < 0)
2705 return NULL;
2706 if (ret == 0) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00002707 Py_INCREF(Py_None);
2708 return Py_None;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002709 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002710 m = PyImport_AddModule(name);
2711 Py_XINCREF(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002712 return m;
2713}
2714
Guido van Rossum79f25d91997-04-29 20:08:16 +00002715static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002716imp_init_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002717{
2718 char *name;
2719 int ret;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002720 PyObject *m;
Guido van Rossum43713e52000-02-29 13:59:29 +00002721 if (!PyArg_ParseTuple(args, "s:init_frozen", &name))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002722 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002723 ret = PyImport_ImportFrozenModule(name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002724 if (ret < 0)
2725 return NULL;
2726 if (ret == 0) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00002727 Py_INCREF(Py_None);
2728 return Py_None;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002729 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002730 m = PyImport_AddModule(name);
2731 Py_XINCREF(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002732 return m;
2733}
2734
Guido van Rossum79f25d91997-04-29 20:08:16 +00002735static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002736imp_get_frozen_object(PyObject *self, PyObject *args)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002737{
2738 char *name;
Jack Jansen95ffa231995-10-03 14:38:41 +00002739
Guido van Rossum43713e52000-02-29 13:59:29 +00002740 if (!PyArg_ParseTuple(args, "s:get_frozen_object", &name))
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002741 return NULL;
2742 return get_frozen_object(name);
2743}
2744
Guido van Rossum79f25d91997-04-29 20:08:16 +00002745static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002746imp_is_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002747{
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002748 char *name;
Guido van Rossum43713e52000-02-29 13:59:29 +00002749 if (!PyArg_ParseTuple(args, "s:is_builtin", &name))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002750 return NULL;
Christian Heimes217cfd12007-12-02 14:31:20 +00002751 return PyLong_FromLong(is_builtin(name));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002752}
2753
Guido van Rossum79f25d91997-04-29 20:08:16 +00002754static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002755imp_is_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002756{
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002757 char *name;
Guido van Rossum323bf5e1998-06-24 03:54:06 +00002758 struct _frozen *p;
Guido van Rossum43713e52000-02-29 13:59:29 +00002759 if (!PyArg_ParseTuple(args, "s:is_frozen", &name))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002760 return NULL;
Guido van Rossum323bf5e1998-06-24 03:54:06 +00002761 p = find_frozen(name);
Guido van Rossumb8bff3f2002-04-07 06:34:38 +00002762 return PyBool_FromLong((long) (p == NULL ? 0 : p->size));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002763}
2764
2765static FILE *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002766get_file(char *pathname, PyObject *fob, char *mode)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002767{
2768 FILE *fp;
Guido van Rossumda5b8f22007-06-12 23:30:11 +00002769 if (mode[0] == 'U')
2770 mode = "r" PY_STDIOTEXTMODE;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002771 if (fob == NULL) {
2772 fp = fopen(pathname, mode);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002773 }
2774 else {
Guido van Rossumda5b8f22007-06-12 23:30:11 +00002775 int fd = PyObject_AsFileDescriptor(fob);
2776 if (fd == -1)
2777 return NULL;
2778 /* XXX This will leak a FILE struct. Fix this!!!!
2779 (But it doesn't leak a file descrioptor!) */
2780 fp = fdopen(fd, mode);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002781 }
Guido van Rossumda5b8f22007-06-12 23:30:11 +00002782 if (fp == NULL)
2783 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002784 return fp;
2785}
2786
Guido van Rossum79f25d91997-04-29 20:08:16 +00002787static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002788imp_load_compiled(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002789{
2790 char *name;
2791 char *pathname;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002792 PyObject *fob = NULL;
2793 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002794 FILE *fp;
Guido van Rossumda5b8f22007-06-12 23:30:11 +00002795 if (!PyArg_ParseTuple(args, "ss|O:load_compiled",
2796 &name, &pathname, &fob))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002797 return NULL;
2798 fp = get_file(pathname, fob, "rb");
2799 if (fp == NULL)
2800 return NULL;
2801 m = load_compiled_module(name, pathname, fp);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002802 if (fob == NULL)
2803 fclose(fp);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002804 return m;
2805}
2806
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002807#ifdef HAVE_DYNAMIC_LOADING
2808
Guido van Rossum79f25d91997-04-29 20:08:16 +00002809static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002810imp_load_dynamic(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002811{
2812 char *name;
2813 char *pathname;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002814 PyObject *fob = NULL;
2815 PyObject *m;
Guido van Rossum7faeab31995-07-07 22:50:36 +00002816 FILE *fp = NULL;
Guido van Rossumda5b8f22007-06-12 23:30:11 +00002817 if (!PyArg_ParseTuple(args, "ss|O:load_dynamic",
2818 &name, &pathname, &fob))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002819 return NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002820 if (fob) {
Guido van Rossum7faeab31995-07-07 22:50:36 +00002821 fp = get_file(pathname, fob, "r");
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002822 if (fp == NULL)
2823 return NULL;
2824 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002825 m = _PyImport_LoadDynamicModule(name, pathname, fp);
Guido van Rossum7faeab31995-07-07 22:50:36 +00002826 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002827}
2828
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002829#endif /* HAVE_DYNAMIC_LOADING */
2830
Guido van Rossum79f25d91997-04-29 20:08:16 +00002831static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002832imp_load_source(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002833{
2834 char *name;
2835 char *pathname;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002836 PyObject *fob = NULL;
2837 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002838 FILE *fp;
Guido van Rossumda5b8f22007-06-12 23:30:11 +00002839 if (!PyArg_ParseTuple(args, "ss|O:load_source",
2840 &name, &pathname, &fob))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002841 return NULL;
2842 fp = get_file(pathname, fob, "r");
2843 if (fp == NULL)
2844 return NULL;
2845 m = load_source_module(name, pathname, fp);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002846 if (fob == NULL)
2847 fclose(fp);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002848 return m;
2849}
2850
Guido van Rossum79f25d91997-04-29 20:08:16 +00002851static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002852imp_load_module(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002853{
2854 char *name;
2855 PyObject *fob;
2856 char *pathname;
2857 char *suffix; /* Unused */
2858 char *mode;
2859 int type;
2860 FILE *fp;
2861
Guido van Rossum43713e52000-02-29 13:59:29 +00002862 if (!PyArg_ParseTuple(args, "sOs(ssi):load_module",
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002863 &name, &fob, &pathname,
2864 &suffix, &mode, &type))
2865 return NULL;
Guido van Rossum5e2c5fa2002-05-30 17:33:07 +00002866 if (*mode) {
2867 /* Mode must start with 'r' or 'U' and must not contain '+'.
2868 Implicit in this test is the assumption that the mode
2869 may contain other modifiers like 'b' or 't'. */
2870
2871 if (!(*mode == 'r' || *mode == 'U') || strchr(mode, '+')) {
Jeremy Hylton4ae6fae2002-05-30 17:15:25 +00002872 PyErr_Format(PyExc_ValueError,
2873 "invalid file open mode %.200s", mode);
2874 return NULL;
Guido van Rossum5e2c5fa2002-05-30 17:33:07 +00002875 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002876 }
2877 if (fob == Py_None)
2878 fp = NULL;
2879 else {
Guido van Rossumda5b8f22007-06-12 23:30:11 +00002880 fp = get_file(NULL, fob, mode);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002881 if (fp == NULL)
2882 return NULL;
2883 }
Just van Rossum52e14d62002-12-30 22:08:05 +00002884 return load_module(name, fp, pathname, type, NULL);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002885}
2886
2887static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002888imp_load_package(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002889{
2890 char *name;
2891 char *pathname;
Guido van Rossum43713e52000-02-29 13:59:29 +00002892 if (!PyArg_ParseTuple(args, "ss:load_package", &name, &pathname))
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002893 return NULL;
2894 return load_package(name, pathname);
2895}
2896
2897static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002898imp_new_module(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002899{
2900 char *name;
Guido van Rossum43713e52000-02-29 13:59:29 +00002901 if (!PyArg_ParseTuple(args, "s:new_module", &name))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002902 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002903 return PyModule_New(name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002904}
2905
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002906/* Doc strings */
2907
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002908PyDoc_STRVAR(doc_imp,
2909"This module provides the components needed to build your own\n\
2910__import__ function. Undocumented functions are obsolete.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002911
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002912PyDoc_STRVAR(doc_find_module,
2913"find_module(name, [path]) -> (file, filename, (suffix, mode, type))\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002914Search for a module. If path is omitted or None, search for a\n\
2915built-in, frozen or special module and continue search in sys.path.\n\
2916The module name cannot contain '.'; to search for a submodule of a\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002917package, pass the submodule name and the package's __path__.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002918
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002919PyDoc_STRVAR(doc_load_module,
2920"load_module(name, file, filename, (suffix, mode, type)) -> module\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002921Load a module, given information returned by find_module().\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002922The module name must include the full package name, if any.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002923
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002924PyDoc_STRVAR(doc_get_magic,
2925"get_magic() -> string\n\
2926Return the magic number for .pyc or .pyo files.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002927
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002928PyDoc_STRVAR(doc_get_suffixes,
2929"get_suffixes() -> [(suffix, mode, type), ...]\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002930Return a list of (suffix, mode, type) tuples describing the files\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002931that find_module() looks for.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002932
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002933PyDoc_STRVAR(doc_new_module,
2934"new_module(name) -> module\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002935Create a new module. Do not enter it in sys.modules.\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002936The module name must include the full package name, if any.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002937
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002938PyDoc_STRVAR(doc_lock_held,
Tim Petersa7c65092004-08-01 23:26:05 +00002939"lock_held() -> boolean\n\
2940Return True if the import lock is currently held, else False.\n\
2941On platforms without threads, return False.");
Tim Peters69232342001-08-30 05:16:13 +00002942
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00002943PyDoc_STRVAR(doc_acquire_lock,
2944"acquire_lock() -> None\n\
Neal Norwitz2294c0d2003-02-12 23:02:21 +00002945Acquires the interpreter's import lock for the current thread.\n\
2946This lock should be used by import hooks to ensure thread-safety\n\
2947when importing modules.\n\
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00002948On platforms without threads, this function does nothing.");
2949
2950PyDoc_STRVAR(doc_release_lock,
2951"release_lock() -> None\n\
2952Release the interpreter's import lock.\n\
2953On platforms without threads, this function does nothing.");
2954
Guido van Rossum79f25d91997-04-29 20:08:16 +00002955static PyMethodDef imp_methods[] = {
Neal Norwitz08ea61a2003-02-17 18:18:00 +00002956 {"find_module", imp_find_module, METH_VARARGS, doc_find_module},
2957 {"get_magic", imp_get_magic, METH_NOARGS, doc_get_magic},
2958 {"get_suffixes", imp_get_suffixes, METH_NOARGS, doc_get_suffixes},
2959 {"load_module", imp_load_module, METH_VARARGS, doc_load_module},
2960 {"new_module", imp_new_module, METH_VARARGS, doc_new_module},
2961 {"lock_held", imp_lock_held, METH_NOARGS, doc_lock_held},
2962 {"acquire_lock", imp_acquire_lock, METH_NOARGS, doc_acquire_lock},
2963 {"release_lock", imp_release_lock, METH_NOARGS, doc_release_lock},
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002964 /* The rest are obsolete */
Neal Norwitz031829d2002-03-31 14:37:44 +00002965 {"get_frozen_object", imp_get_frozen_object, METH_VARARGS},
2966 {"init_builtin", imp_init_builtin, METH_VARARGS},
2967 {"init_frozen", imp_init_frozen, METH_VARARGS},
2968 {"is_builtin", imp_is_builtin, METH_VARARGS},
2969 {"is_frozen", imp_is_frozen, METH_VARARGS},
2970 {"load_compiled", imp_load_compiled, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002971#ifdef HAVE_DYNAMIC_LOADING
Neal Norwitz031829d2002-03-31 14:37:44 +00002972 {"load_dynamic", imp_load_dynamic, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002973#endif
Neal Norwitz031829d2002-03-31 14:37:44 +00002974 {"load_package", imp_load_package, METH_VARARGS},
Neal Norwitz031829d2002-03-31 14:37:44 +00002975 {"load_source", imp_load_source, METH_VARARGS},
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002976 {NULL, NULL} /* sentinel */
2977};
2978
Guido van Rossum1a8791e1998-08-04 22:46:29 +00002979static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002980setint(PyObject *d, char *name, int value)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002981{
2982 PyObject *v;
2983 int err;
2984
Christian Heimes217cfd12007-12-02 14:31:20 +00002985 v = PyLong_FromLong((long)value);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002986 err = PyDict_SetItemString(d, name, v);
2987 Py_XDECREF(v);
2988 return err;
2989}
2990
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002991typedef struct {
2992 PyObject_HEAD
2993} NullImporter;
2994
2995static int
2996NullImporter_init(NullImporter *self, PyObject *args, PyObject *kwds)
2997{
2998 char *path;
Christian Heimes7d3bc0a2007-11-07 17:26:16 +00002999 Py_ssize_t pathlen;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003000
3001 if (!_PyArg_NoKeywords("NullImporter()", kwds))
3002 return -1;
3003
3004 if (!PyArg_ParseTuple(args, "s:NullImporter",
3005 &path))
3006 return -1;
3007
Christian Heimes7d3bc0a2007-11-07 17:26:16 +00003008 pathlen = strlen(path);
3009 if (pathlen == 0) {
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003010 PyErr_SetString(PyExc_ImportError, "empty pathname");
3011 return -1;
3012 } else {
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003013 struct stat statbuf;
3014 int rv;
3015
3016 rv = stat(path, &statbuf);
Guido van Rossumc1bdbc32007-11-07 17:46:34 +00003017#ifdef MS_WINDOWS
3018 /* MS Windows stat() chokes on paths like C:\path\. Try to
3019 * recover *one* time by stripping off a trailing slash or
3020 * backslash. http://bugs.python.org/issue1293
3021 */
Christian Heimes7d3bc0a2007-11-07 17:26:16 +00003022 if (rv != 0 && pathlen <= MAXPATHLEN &&
3023 (path[pathlen-1] == '/' || path[pathlen-1] == '\\')) {
3024 char mangled[MAXPATHLEN+1];
3025
3026 strcpy(mangled, path);
3027 mangled[pathlen-1] = '\0';
3028 rv = stat(mangled, &statbuf);
3029 }
Christian Heimes7d3bc0a2007-11-07 17:26:16 +00003030#endif
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003031 if (rv == 0) {
3032 /* it exists */
3033 if (S_ISDIR(statbuf.st_mode)) {
3034 /* it's a directory */
3035 PyErr_SetString(PyExc_ImportError,
3036 "existing directory");
3037 return -1;
3038 }
3039 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003040 }
3041 return 0;
3042}
3043
3044static PyObject *
3045NullImporter_find_module(NullImporter *self, PyObject *args)
3046{
3047 Py_RETURN_NONE;
3048}
3049
3050static PyMethodDef NullImporter_methods[] = {
3051 {"find_module", (PyCFunction)NullImporter_find_module, METH_VARARGS,
3052 "Always return None"
3053 },
3054 {NULL} /* Sentinel */
3055};
3056
3057
Christian Heimes9cd17752007-11-18 19:35:23 +00003058PyTypeObject PyNullImporter_Type = {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00003059 PyVarObject_HEAD_INIT(NULL, 0)
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003060 "imp.NullImporter", /*tp_name*/
3061 sizeof(NullImporter), /*tp_basicsize*/
3062 0, /*tp_itemsize*/
3063 0, /*tp_dealloc*/
3064 0, /*tp_print*/
3065 0, /*tp_getattr*/
3066 0, /*tp_setattr*/
3067 0, /*tp_compare*/
3068 0, /*tp_repr*/
3069 0, /*tp_as_number*/
3070 0, /*tp_as_sequence*/
3071 0, /*tp_as_mapping*/
3072 0, /*tp_hash */
3073 0, /*tp_call*/
3074 0, /*tp_str*/
3075 0, /*tp_getattro*/
3076 0, /*tp_setattro*/
3077 0, /*tp_as_buffer*/
3078 Py_TPFLAGS_DEFAULT, /*tp_flags*/
3079 "Null importer object", /* tp_doc */
3080 0, /* tp_traverse */
3081 0, /* tp_clear */
3082 0, /* tp_richcompare */
3083 0, /* tp_weaklistoffset */
3084 0, /* tp_iter */
3085 0, /* tp_iternext */
3086 NullImporter_methods, /* tp_methods */
3087 0, /* tp_members */
3088 0, /* tp_getset */
3089 0, /* tp_base */
3090 0, /* tp_dict */
3091 0, /* tp_descr_get */
3092 0, /* tp_descr_set */
3093 0, /* tp_dictoffset */
3094 (initproc)NullImporter_init, /* tp_init */
3095 0, /* tp_alloc */
3096 PyType_GenericNew /* tp_new */
3097};
3098
3099
Jason Tishler6bc06ec2003-09-04 11:59:50 +00003100PyMODINIT_FUNC
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003101initimp(void)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003102{
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003103 PyObject *m, *d;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003104
Christian Heimes9cd17752007-11-18 19:35:23 +00003105 if (PyType_Ready(&PyNullImporter_Type) < 0)
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003106 goto failure;
3107
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003108 m = Py_InitModule4("imp", imp_methods, doc_imp,
3109 NULL, PYTHON_API_VERSION);
Neal Norwitz1ac754f2006-01-19 06:09:39 +00003110 if (m == NULL)
3111 goto failure;
Guido van Rossum79f25d91997-04-29 20:08:16 +00003112 d = PyModule_GetDict(m);
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00003113 if (d == NULL)
3114 goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003115
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003116 if (setint(d, "SEARCH_ERROR", SEARCH_ERROR) < 0) goto failure;
3117 if (setint(d, "PY_SOURCE", PY_SOURCE) < 0) goto failure;
3118 if (setint(d, "PY_COMPILED", PY_COMPILED) < 0) goto failure;
3119 if (setint(d, "C_EXTENSION", C_EXTENSION) < 0) goto failure;
3120 if (setint(d, "PY_RESOURCE", PY_RESOURCE) < 0) goto failure;
3121 if (setint(d, "PKG_DIRECTORY", PKG_DIRECTORY) < 0) goto failure;
3122 if (setint(d, "C_BUILTIN", C_BUILTIN) < 0) goto failure;
3123 if (setint(d, "PY_FROZEN", PY_FROZEN) < 0) goto failure;
Guido van Rossum0f84a341998-08-06 13:36:01 +00003124 if (setint(d, "PY_CODERESOURCE", PY_CODERESOURCE) < 0) goto failure;
Just van Rossum52e14d62002-12-30 22:08:05 +00003125 if (setint(d, "IMP_HOOK", IMP_HOOK) < 0) goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003126
Christian Heimes9cd17752007-11-18 19:35:23 +00003127 Py_INCREF(&PyNullImporter_Type);
3128 PyModule_AddObject(m, "NullImporter", (PyObject *)&PyNullImporter_Type);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003129 failure:
3130 ;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003131}
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003132
3133
Guido van Rossumb18618d2000-05-03 23:44:39 +00003134/* API for embedding applications that want to add their own entries
3135 to the table of built-in modules. This should normally be called
3136 *before* Py_Initialize(). When the table resize fails, -1 is
3137 returned and the existing table is unchanged.
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003138
3139 After a similar function by Just van Rossum. */
3140
3141int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003142PyImport_ExtendInittab(struct _inittab *newtab)
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003143{
3144 static struct _inittab *our_copy = NULL;
3145 struct _inittab *p;
3146 int i, n;
3147
3148 /* Count the number of entries in both tables */
3149 for (n = 0; newtab[n].name != NULL; n++)
3150 ;
3151 if (n == 0)
3152 return 0; /* Nothing to do */
3153 for (i = 0; PyImport_Inittab[i].name != NULL; i++)
3154 ;
3155
3156 /* Allocate new memory for the combined table */
Guido van Rossumb18618d2000-05-03 23:44:39 +00003157 p = our_copy;
3158 PyMem_RESIZE(p, struct _inittab, i+n+1);
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003159 if (p == NULL)
3160 return -1;
3161
3162 /* Copy the tables into the new memory */
3163 if (our_copy != PyImport_Inittab)
3164 memcpy(p, PyImport_Inittab, (i+1) * sizeof(struct _inittab));
3165 PyImport_Inittab = our_copy = p;
3166 memcpy(p+i, newtab, (n+1) * sizeof(struct _inittab));
3167
3168 return 0;
3169}
3170
3171/* Shorthand to add a single entry given a name and a function */
3172
3173int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003174PyImport_AppendInittab(char *name, void (*initfunc)(void))
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003175{
3176 struct _inittab newtab[2];
3177
3178 memset(newtab, '\0', sizeof newtab);
3179
3180 newtab[0].name = name;
3181 newtab[0].initfunc = initfunc;
3182
3183 return PyImport_ExtendInittab(newtab);
3184}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00003185
3186#ifdef __cplusplus
3187}
3188#endif