blob: 72837836bc035ff64a351f4ebe09f60bcb7cfb9d [file] [log] [blame]
Guido van Rossumf70e43a1991-02-19 12:39:46 +00001
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002/* Module definition and import implementation */
3
Guido van Rossum79f25d91997-04-29 20:08:16 +00004#include "Python.h"
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00005
Jeremy Hylton3e0055f2005-10-20 19:59:25 +00006#include "Python-ast.h"
Guido van Rossumd8faa362007-04-27 19:54:29 +00007#undef Yield /* undefine macro conflicting with winbase.h */
Neal Norwitzadb69fc2005-12-17 20:54:49 +00008#include "pyarena.h"
Jeremy Hylton3e0055f2005-10-20 19:59:25 +00009#include "pythonrun.h"
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000010#include "errcode.h"
Guido van Rossumc405b7b1991-06-04 19:39:42 +000011#include "marshal.h"
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000012#include "code.h"
Guido van Rossumc405b7b1991-06-04 19:39:42 +000013#include "compile.h"
Guido van Rossumff4949e1992-08-05 19:58:53 +000014#include "eval.h"
Guido van Rossumd8bac6d1992-02-26 15:19:13 +000015#include "osdefs.h"
Guido van Rossum1ae940a1995-01-02 19:04:15 +000016#include "importdl.h"
Guido van Rossumc405b7b1991-06-04 19:39:42 +000017
Guido van Rossum55a83382000-09-20 20:31:38 +000018#ifdef HAVE_FCNTL_H
19#include <fcntl.h>
20#endif
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000021#ifdef __cplusplus
22extern "C" {
23#endif
Guido van Rossum55a83382000-09-20 20:31:38 +000024
Thomas Woutersf70ef4f2000-07-22 18:47:25 +000025extern time_t PyOS_GetLastModificationTime(char *, FILE *);
26 /* In getmtime.c */
Guido van Rossum21d335e1993-10-15 13:01:11 +000027
Jeremy Hyltond4ceb312004-04-01 02:45:22 +000028/* Magic word to reject .pyc files generated by other Python versions.
29 It should change for each incompatible change to the bytecode.
30
31 The value of CR and LF is incorporated so if you ever read or write
Guido van Rossum7faeab31995-07-07 22:50:36 +000032 a .pyc file in text mode the magic number will be wrong; also, the
Tim Peters36515e22001-11-18 04:06:29 +000033 Apple MPW compiler swaps their values, botching string constants.
Marc-André Lemburgbd3be8f2002-02-07 11:33:49 +000034
Guido van Rossum45aecf42006-03-15 04:58:47 +000035 The magic numbers must be spaced apart at least 2 values, as the
Martin v. Löwisef82d2f2004-06-27 16:51:46 +000036 -U interpeter flag will cause MAGIC+1 being used. They have been
37 odd numbers for some time now.
Marc-André Lemburgbd3be8f2002-02-07 11:33:49 +000038
Jeremy Hyltond4ceb312004-04-01 02:45:22 +000039 There were a variety of old schemes for setting the magic number.
40 The current working scheme is to increment the previous value by
41 10.
Guido van Rossumf6894922002-08-31 15:16:14 +000042
Marc-André Lemburgbd3be8f2002-02-07 11:33:49 +000043 Known values:
44 Python 1.5: 20121
45 Python 1.5.1: 20121
46 Python 1.5.2: 20121
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000047 Python 1.6: 50428
Marc-André Lemburgbd3be8f2002-02-07 11:33:49 +000048 Python 2.0: 50823
49 Python 2.0.1: 50823
50 Python 2.1: 60202
51 Python 2.1.1: 60202
52 Python 2.1.2: 60202
53 Python 2.2: 60717
Neal Norwitz7fdcb412002-06-14 01:07:39 +000054 Python 2.3a0: 62011
Michael W. Hudsondd32a912002-08-15 14:59:02 +000055 Python 2.3a0: 62021
Guido van Rossumf6894922002-08-31 15:16:14 +000056 Python 2.3a0: 62011 (!)
Martin v. Löwisef82d2f2004-06-27 16:51:46 +000057 Python 2.4a0: 62041
Raymond Hettingerfd2d1f72004-08-23 23:37:48 +000058 Python 2.4a3: 62051
Raymond Hettinger2c31a052004-09-22 18:44:21 +000059 Python 2.4b1: 62061
Michael W. Hudsondf888462005-06-03 14:41:55 +000060 Python 2.5a0: 62071
Michael W. Hudsonaee2e282005-10-21 11:32:20 +000061 Python 2.5a0: 62081 (ast-branch)
Guido van Rossumc2e20742006-02-27 22:32:47 +000062 Python 2.5a0: 62091 (with)
Guido van Rossumf6694362006-03-10 02:28:35 +000063 Python 2.5a0: 62092 (changed WITH_CLEANUP opcode)
Thomas Wouters0e3f5912006-08-11 14:57:12 +000064 Python 2.5b3: 62101 (fix wrong code: for x, in ...)
65 Python 2.5b3: 62111 (fix wrong code: x += yield)
66 Python 2.5c1: 62121 (fix wrong lnotab with for loops and
67 storing constants that should have been removed)
Thomas Wouters89f507f2006-12-13 04:49:30 +000068 Python 2.5c2: 62131 (fix wrong code: for x, in ... in listcomp/genexp)
69 Python 2.6a0: 62141 (peephole optimizations)
Guido van Rossum45aecf42006-03-15 04:58:47 +000070 Python 3000: 3000
Brett Cannone2e23ef2006-08-25 05:05:30 +000071 3010 (removed UNARY_CONVERT)
Guido van Rossum86e58e22006-08-28 15:27:34 +000072 3020 (added BUILD_SET)
Guido van Rossum4f72a782006-10-27 23:31:49 +000073 3030 (added keyword-only parameters)
Guido van Rossum3203bdc2006-12-28 21:03:31 +000074 3040 (added signature annotations)
Guido van Rossum452bf512007-02-09 05:32:43 +000075 3050 (print becomes a function)
Guido van Rossum52cc1d82007-03-18 15:41:51 +000076 3060 (PEP 3115 metaclass syntax)
Collin Winter828f04a2007-08-31 00:04:24 +000077 3070 (PEP 3109 raise changes)
Michael W. Hudsonaee2e282005-10-21 11:32:20 +000078.
Tim Peters36515e22001-11-18 04:06:29 +000079*/
Collin Winter32347fb2007-08-31 00:42:15 +000080#define MAGIC (3070 | ((long)'\r'<<16) | ((long)'\n'<<24))
Guido van Rossum3ddee711991-12-16 13:06:34 +000081
Guido van Rossum96774c12000-05-01 20:19:08 +000082/* Magic word as global; note that _PyImport_Init() can change the
Jeremy Hylton9262b8a2000-06-30 04:59:17 +000083 value of this global to accommodate for alterations of how the
Guido van Rossum96774c12000-05-01 20:19:08 +000084 compiler works which are enabled by command line switches. */
85static long pyc_magic = MAGIC;
86
Guido van Rossum25ce5661997-08-02 03:10:38 +000087/* See _PyImport_FixupExtension() below */
88static PyObject *extensions = NULL;
Guido van Rossum3f5da241990-12-20 15:06:42 +000089
Guido van Rossum771c6c81997-10-31 18:37:24 +000090/* This table is defined in config.c: */
91extern struct _inittab _PyImport_Inittab[];
92
93struct _inittab *PyImport_Inittab = _PyImport_Inittab;
Guido van Rossum66f1fa81991-04-03 19:03:52 +000094
Guido van Rossumed1170e1999-12-20 21:23:41 +000095/* these tables define the module suffixes that Python recognizes */
96struct filedescr * _PyImport_Filetab = NULL;
Guido van Rossum48a680c2001-03-02 06:34:14 +000097
Guido van Rossumed1170e1999-12-20 21:23:41 +000098static const struct filedescr _PyImport_StandardFiletab[] = {
Jack Jansenc88da1f2002-05-28 10:58:19 +000099 {".py", "U", PY_SOURCE},
Martin v. Löwis6238d2b2002-06-30 15:26:10 +0000100#ifdef MS_WINDOWS
Jack Jansenc88da1f2002-05-28 10:58:19 +0000101 {".pyw", "U", PY_SOURCE},
Tim Peters36515e22001-11-18 04:06:29 +0000102#endif
Guido van Rossumed1170e1999-12-20 21:23:41 +0000103 {".pyc", "rb", PY_COMPILED},
104 {0, 0}
105};
106
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000107static PyTypeObject NullImporterType; /* Forward reference */
108
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000109/* Initialize things */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000110
111void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000112_PyImport_Init(void)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000113{
Guido van Rossumed1170e1999-12-20 21:23:41 +0000114 const struct filedescr *scan;
115 struct filedescr *filetab;
116 int countD = 0;
117 int countS = 0;
118
119 /* prepare _PyImport_Filetab: copy entries from
120 _PyImport_DynLoadFiletab and _PyImport_StandardFiletab.
121 */
Guido van Rossum04110fb2007-08-24 16:32:05 +0000122#ifdef HAVE_DYNAMIC_LOADING
Guido van Rossumed1170e1999-12-20 21:23:41 +0000123 for (scan = _PyImport_DynLoadFiletab; scan->suffix != NULL; ++scan)
124 ++countD;
Guido van Rossum04110fb2007-08-24 16:32:05 +0000125#endif
Guido van Rossumed1170e1999-12-20 21:23:41 +0000126 for (scan = _PyImport_StandardFiletab; scan->suffix != NULL; ++scan)
127 ++countS;
Guido van Rossumb18618d2000-05-03 23:44:39 +0000128 filetab = PyMem_NEW(struct filedescr, countD + countS + 1);
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000129 if (filetab == NULL)
130 Py_FatalError("Can't initialize import file table.");
Guido van Rossum04110fb2007-08-24 16:32:05 +0000131#ifdef HAVE_DYNAMIC_LOADING
Guido van Rossumed1170e1999-12-20 21:23:41 +0000132 memcpy(filetab, _PyImport_DynLoadFiletab,
133 countD * sizeof(struct filedescr));
Guido van Rossum04110fb2007-08-24 16:32:05 +0000134#endif
Guido van Rossumed1170e1999-12-20 21:23:41 +0000135 memcpy(filetab + countD, _PyImport_StandardFiletab,
136 countS * sizeof(struct filedescr));
137 filetab[countD + countS].suffix = NULL;
138
139 _PyImport_Filetab = filetab;
140
Guido van Rossum0824f631997-03-11 18:37:35 +0000141 if (Py_OptimizeFlag) {
Guido van Rossumed1170e1999-12-20 21:23:41 +0000142 /* Replace ".pyc" with ".pyo" in _PyImport_Filetab */
143 for (; filetab->suffix != NULL; filetab++) {
144 if (strcmp(filetab->suffix, ".pyc") == 0)
145 filetab->suffix = ".pyo";
Guido van Rossum0824f631997-03-11 18:37:35 +0000146 }
147 }
Guido van Rossum96774c12000-05-01 20:19:08 +0000148
Guido van Rossum572dbf82007-04-27 23:53:51 +0000149 {
Guido van Rossum96774c12000-05-01 20:19:08 +0000150 /* Fix the pyc_magic so that byte compiled code created
151 using the all-Unicode method doesn't interfere with
152 code created in normal operation mode. */
153 pyc_magic = MAGIC + 1;
154 }
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000155}
156
Guido van Rossum25ce5661997-08-02 03:10:38 +0000157void
Just van Rossum52e14d62002-12-30 22:08:05 +0000158_PyImportHooks_Init(void)
159{
160 PyObject *v, *path_hooks = NULL, *zimpimport;
161 int err = 0;
162
163 /* adding sys.path_hooks and sys.path_importer_cache, setting up
164 zipimport */
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000165 if (PyType_Ready(&NullImporterType) < 0)
166 goto error;
Just van Rossum52e14d62002-12-30 22:08:05 +0000167
168 if (Py_VerboseFlag)
169 PySys_WriteStderr("# installing zipimport hook\n");
170
171 v = PyList_New(0);
172 if (v == NULL)
173 goto error;
174 err = PySys_SetObject("meta_path", v);
175 Py_DECREF(v);
176 if (err)
177 goto error;
178 v = PyDict_New();
179 if (v == NULL)
180 goto error;
181 err = PySys_SetObject("path_importer_cache", v);
182 Py_DECREF(v);
183 if (err)
184 goto error;
185 path_hooks = PyList_New(0);
186 if (path_hooks == NULL)
187 goto error;
188 err = PySys_SetObject("path_hooks", path_hooks);
189 if (err) {
190 error:
191 PyErr_Print();
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000192 Py_FatalError("initializing sys.meta_path, sys.path_hooks, "
193 "path_importer_cache, or NullImporter failed"
194 );
Just van Rossum52e14d62002-12-30 22:08:05 +0000195 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000196
Just van Rossum52e14d62002-12-30 22:08:05 +0000197 zimpimport = PyImport_ImportModule("zipimport");
198 if (zimpimport == NULL) {
199 PyErr_Clear(); /* No zip import module -- okay */
200 if (Py_VerboseFlag)
201 PySys_WriteStderr("# can't import zipimport\n");
202 }
203 else {
204 PyObject *zipimporter = PyObject_GetAttrString(zimpimport,
205 "zipimporter");
206 Py_DECREF(zimpimport);
207 if (zipimporter == NULL) {
208 PyErr_Clear(); /* No zipimporter object -- okay */
209 if (Py_VerboseFlag)
210 PySys_WriteStderr(
Fred Drake1e5fc552003-07-11 15:01:02 +0000211 "# can't import zipimport.zipimporter\n");
Just van Rossum52e14d62002-12-30 22:08:05 +0000212 }
213 else {
214 /* sys.path_hooks.append(zipimporter) */
215 err = PyList_Append(path_hooks, zipimporter);
216 Py_DECREF(zipimporter);
217 if (err)
218 goto error;
219 if (Py_VerboseFlag)
220 PySys_WriteStderr(
221 "# installed zipimport hook\n");
222 }
223 }
224 Py_DECREF(path_hooks);
225}
226
227void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000228_PyImport_Fini(void)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000229{
230 Py_XDECREF(extensions);
231 extensions = NULL;
Barry Warsaw84294482000-10-03 16:02:05 +0000232 PyMem_DEL(_PyImport_Filetab);
233 _PyImport_Filetab = NULL;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000234}
235
236
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000237/* Locking primitives to prevent parallel imports of the same module
238 in different threads to return with a partially loaded module.
239 These calls are serialized by the global interpreter lock. */
240
241#ifdef WITH_THREAD
242
Guido van Rossum49b56061998-10-01 20:42:43 +0000243#include "pythread.h"
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000244
Guido van Rossum65d5b571998-12-21 19:32:43 +0000245static PyThread_type_lock import_lock = 0;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000246static long import_lock_thread = -1;
247static int import_lock_level = 0;
248
249static void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000250lock_import(void)
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000251{
Guido van Rossum65d5b571998-12-21 19:32:43 +0000252 long me = PyThread_get_thread_ident();
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000253 if (me == -1)
254 return; /* Too bad */
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000255 if (import_lock == NULL) {
Guido van Rossum65d5b571998-12-21 19:32:43 +0000256 import_lock = PyThread_allocate_lock();
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000257 if (import_lock == NULL)
258 return; /* Nothing much we can do. */
259 }
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000260 if (import_lock_thread == me) {
261 import_lock_level++;
262 return;
263 }
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000264 if (import_lock_thread != -1 || !PyThread_acquire_lock(import_lock, 0))
265 {
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000266 PyThreadState *tstate = PyEval_SaveThread();
Guido van Rossum65d5b571998-12-21 19:32:43 +0000267 PyThread_acquire_lock(import_lock, 1);
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000268 PyEval_RestoreThread(tstate);
269 }
270 import_lock_thread = me;
271 import_lock_level = 1;
272}
273
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000274static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000275unlock_import(void)
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000276{
Guido van Rossum65d5b571998-12-21 19:32:43 +0000277 long me = PyThread_get_thread_ident();
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000278 if (me == -1 || import_lock == NULL)
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000279 return 0; /* Too bad */
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000280 if (import_lock_thread != me)
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000281 return -1;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000282 import_lock_level--;
283 if (import_lock_level == 0) {
284 import_lock_thread = -1;
Guido van Rossum65d5b571998-12-21 19:32:43 +0000285 PyThread_release_lock(import_lock);
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000286 }
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000287 return 1;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000288}
289
Guido van Rossum8ee3e5a2005-09-14 18:09:42 +0000290/* This function is called from PyOS_AfterFork to ensure that newly
291 created child processes do not share locks with the parent. */
292
293void
294_PyImport_ReInitLock(void)
295{
296#ifdef _AIX
297 if (import_lock != NULL)
298 import_lock = PyThread_allocate_lock();
299#endif
300}
301
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000302#else
303
304#define lock_import()
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000305#define unlock_import() 0
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000306
307#endif
308
Tim Peters69232342001-08-30 05:16:13 +0000309static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000310imp_lock_held(PyObject *self, PyObject *noargs)
Tim Peters69232342001-08-30 05:16:13 +0000311{
Tim Peters69232342001-08-30 05:16:13 +0000312#ifdef WITH_THREAD
Guido van Rossumb8bff3f2002-04-07 06:34:38 +0000313 return PyBool_FromLong(import_lock_thread != -1);
Tim Peters69232342001-08-30 05:16:13 +0000314#else
Guido van Rossumb8bff3f2002-04-07 06:34:38 +0000315 return PyBool_FromLong(0);
Tim Peters69232342001-08-30 05:16:13 +0000316#endif
317}
318
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000319static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000320imp_acquire_lock(PyObject *self, PyObject *noargs)
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000321{
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000322#ifdef WITH_THREAD
323 lock_import();
324#endif
Neal Norwitz2294c0d2003-02-12 23:02:21 +0000325 Py_INCREF(Py_None);
326 return Py_None;
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000327}
328
329static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000330imp_release_lock(PyObject *self, PyObject *noargs)
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000331{
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000332#ifdef WITH_THREAD
333 if (unlock_import() < 0) {
334 PyErr_SetString(PyExc_RuntimeError,
335 "not holding the import lock");
336 return NULL;
337 }
338#endif
Neal Norwitz2294c0d2003-02-12 23:02:21 +0000339 Py_INCREF(Py_None);
340 return Py_None;
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000341}
342
Guido van Rossumd8faa362007-04-27 19:54:29 +0000343static void
344imp_modules_reloading_clear(void)
345{
346 PyInterpreterState *interp = PyThreadState_Get()->interp;
347 if (interp->modules_reloading != NULL)
348 PyDict_Clear(interp->modules_reloading);
349}
350
Guido van Rossum25ce5661997-08-02 03:10:38 +0000351/* Helper for sys */
352
353PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000354PyImport_GetModuleDict(void)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000355{
Nicholas Bastine5662ae2004-03-24 22:22:12 +0000356 PyInterpreterState *interp = PyThreadState_GET()->interp;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000357 if (interp->modules == NULL)
358 Py_FatalError("PyImport_GetModuleDict: no module dictionary!");
359 return interp->modules;
360}
361
Guido van Rossum3f5da241990-12-20 15:06:42 +0000362
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000363/* List of names to clear in sys */
364static char* sys_deletes[] = {
Collin Winter670e6922007-03-21 02:57:17 +0000365 "path", "argv", "ps1", "ps2",
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000366 "last_type", "last_value", "last_traceback",
Just van Rossum52e14d62002-12-30 22:08:05 +0000367 "path_hooks", "path_importer_cache", "meta_path",
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000368 NULL
369};
370
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000371static char* sys_files[] = {
372 "stdin", "__stdin__",
373 "stdout", "__stdout__",
374 "stderr", "__stderr__",
375 NULL
376};
377
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000378
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000379/* Un-initialize things, as good as we can */
Guido van Rossum3f5da241990-12-20 15:06:42 +0000380
Guido van Rossum3f5da241990-12-20 15:06:42 +0000381void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000382PyImport_Cleanup(void)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000383{
Martin v. Löwis18e16552006-02-15 17:27:45 +0000384 Py_ssize_t pos, ndone;
Guido van Rossum758eec01998-01-19 21:58:26 +0000385 char *name;
386 PyObject *key, *value, *dict;
Nicholas Bastine5662ae2004-03-24 22:22:12 +0000387 PyInterpreterState *interp = PyThreadState_GET()->interp;
Guido van Rossum758eec01998-01-19 21:58:26 +0000388 PyObject *modules = interp->modules;
389
390 if (modules == NULL)
391 return; /* Already done */
392
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000393 /* Delete some special variables first. These are common
394 places where user values hide and people complain when their
395 destructors fail. Since the modules containing them are
396 deleted *last* of all, they would come too late in the normal
397 destruction order. Sigh. */
398
399 value = PyDict_GetItemString(modules, "__builtin__");
400 if (value != NULL && PyModule_Check(value)) {
401 dict = PyModule_GetDict(value);
402 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000403 PySys_WriteStderr("# clear __builtin__._\n");
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000404 PyDict_SetItemString(dict, "_", Py_None);
405 }
406 value = PyDict_GetItemString(modules, "sys");
407 if (value != NULL && PyModule_Check(value)) {
408 char **p;
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000409 PyObject *v;
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000410 dict = PyModule_GetDict(value);
411 for (p = sys_deletes; *p != NULL; p++) {
412 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000413 PySys_WriteStderr("# clear sys.%s\n", *p);
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000414 PyDict_SetItemString(dict, *p, Py_None);
415 }
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000416 for (p = sys_files; *p != NULL; p+=2) {
417 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000418 PySys_WriteStderr("# restore sys.%s\n", *p);
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000419 v = PyDict_GetItemString(dict, *(p+1));
420 if (v == NULL)
421 v = Py_None;
422 PyDict_SetItemString(dict, *p, v);
423 }
424 }
425
426 /* First, delete __main__ */
427 value = PyDict_GetItemString(modules, "__main__");
428 if (value != NULL && PyModule_Check(value)) {
429 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000430 PySys_WriteStderr("# cleanup __main__\n");
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000431 _PyModule_Clear(value);
432 PyDict_SetItemString(modules, "__main__", Py_None);
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000433 }
434
Guido van Rossum758eec01998-01-19 21:58:26 +0000435 /* The special treatment of __builtin__ here is because even
436 when it's not referenced as a module, its dictionary is
437 referenced by almost every module's __builtins__. Since
438 deleting a module clears its dictionary (even if there are
439 references left to it), we need to delete the __builtin__
440 module last. Likewise, we don't delete sys until the very
441 end because it is implicitly referenced (e.g. by print).
442
443 Also note that we 'delete' modules by replacing their entry
444 in the modules dict with None, rather than really deleting
445 them; this avoids a rehash of the modules dictionary and
446 also marks them as "non existent" so they won't be
447 re-imported. */
448
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000449 /* Next, repeatedly delete modules with a reference count of
Guido van Rossum758eec01998-01-19 21:58:26 +0000450 one (skipping __builtin__ and sys) and delete them */
451 do {
452 ndone = 0;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000453 pos = 0;
Guido van Rossum758eec01998-01-19 21:58:26 +0000454 while (PyDict_Next(modules, &pos, &key, &value)) {
455 if (value->ob_refcnt != 1)
456 continue;
Neal Norwitz80e7f272007-08-26 06:45:23 +0000457 if (PyUnicode_Check(key) && PyModule_Check(value)) {
458 name = PyUnicode_AsString(key);
Guido van Rossum758eec01998-01-19 21:58:26 +0000459 if (strcmp(name, "__builtin__") == 0)
460 continue;
461 if (strcmp(name, "sys") == 0)
462 continue;
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000463 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000464 PySys_WriteStderr(
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000465 "# cleanup[1] %s\n", name);
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000466 _PyModule_Clear(value);
Guido van Rossum758eec01998-01-19 21:58:26 +0000467 PyDict_SetItem(modules, key, Py_None);
468 ndone++;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000469 }
470 }
Guido van Rossum758eec01998-01-19 21:58:26 +0000471 } while (ndone > 0);
472
Guido van Rossum758eec01998-01-19 21:58:26 +0000473 /* Next, delete all modules (still skipping __builtin__ and sys) */
474 pos = 0;
475 while (PyDict_Next(modules, &pos, &key, &value)) {
Neal Norwitz80e7f272007-08-26 06:45:23 +0000476 if (PyUnicode_Check(key) && PyModule_Check(value)) {
477 name = PyUnicode_AsString(key);
Guido van Rossum758eec01998-01-19 21:58:26 +0000478 if (strcmp(name, "__builtin__") == 0)
479 continue;
480 if (strcmp(name, "sys") == 0)
481 continue;
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000482 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000483 PySys_WriteStderr("# cleanup[2] %s\n", name);
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000484 _PyModule_Clear(value);
Guido van Rossum758eec01998-01-19 21:58:26 +0000485 PyDict_SetItem(modules, key, Py_None);
486 }
487 }
488
489 /* Next, delete sys and __builtin__ (in that order) */
490 value = PyDict_GetItemString(modules, "sys");
491 if (value != NULL && PyModule_Check(value)) {
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000492 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000493 PySys_WriteStderr("# cleanup sys\n");
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000494 _PyModule_Clear(value);
Guido van Rossum758eec01998-01-19 21:58:26 +0000495 PyDict_SetItemString(modules, "sys", Py_None);
496 }
497 value = PyDict_GetItemString(modules, "__builtin__");
498 if (value != NULL && PyModule_Check(value)) {
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000499 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000500 PySys_WriteStderr("# cleanup __builtin__\n");
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000501 _PyModule_Clear(value);
Guido van Rossum758eec01998-01-19 21:58:26 +0000502 PyDict_SetItemString(modules, "__builtin__", Py_None);
503 }
504
505 /* Finally, clear and delete the modules directory */
506 PyDict_Clear(modules);
507 interp->modules = NULL;
508 Py_DECREF(modules);
Guido van Rossumd8faa362007-04-27 19:54:29 +0000509 Py_CLEAR(interp->modules_reloading);
Guido van Rossum8d15b5d1990-10-26 14:58:58 +0000510}
Guido van Rossum7f133ed1991-02-19 12:23:57 +0000511
512
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000513/* Helper for pythonrun.c -- return magic number */
514
515long
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000516PyImport_GetMagicNumber(void)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000517{
Guido van Rossum96774c12000-05-01 20:19:08 +0000518 return pyc_magic;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000519}
520
521
Guido van Rossum25ce5661997-08-02 03:10:38 +0000522/* Magic for extension modules (built-in as well as dynamically
523 loaded). To prevent initializing an extension module more than
524 once, we keep a static dictionary 'extensions' keyed by module name
525 (for built-in modules) or by filename (for dynamically loaded
Barry Warsaw92883382001-08-13 23:05:44 +0000526 modules), containing these modules. A copy of the module's
Guido van Rossum25ce5661997-08-02 03:10:38 +0000527 dictionary is stored by calling _PyImport_FixupExtension()
528 immediately after the module initialization function succeeds. A
529 copy can be retrieved from there by calling
530 _PyImport_FindExtension(). */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000531
Guido van Rossum79f25d91997-04-29 20:08:16 +0000532PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000533_PyImport_FixupExtension(char *name, char *filename)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000534{
Guido van Rossum25ce5661997-08-02 03:10:38 +0000535 PyObject *modules, *mod, *dict, *copy;
536 if (extensions == NULL) {
537 extensions = PyDict_New();
538 if (extensions == NULL)
539 return NULL;
540 }
541 modules = PyImport_GetModuleDict();
542 mod = PyDict_GetItemString(modules, name);
543 if (mod == NULL || !PyModule_Check(mod)) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000544 PyErr_Format(PyExc_SystemError,
545 "_PyImport_FixupExtension: module %.200s not loaded", name);
Guido van Rossum25ce5661997-08-02 03:10:38 +0000546 return NULL;
547 }
548 dict = PyModule_GetDict(mod);
549 if (dict == NULL)
550 return NULL;
Fred Drake9cd0efc2001-10-25 21:38:59 +0000551 copy = PyDict_Copy(dict);
Guido van Rossum25ce5661997-08-02 03:10:38 +0000552 if (copy == NULL)
553 return NULL;
554 PyDict_SetItemString(extensions, filename, copy);
555 Py_DECREF(copy);
556 return copy;
557}
558
559PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000560_PyImport_FindExtension(char *name, char *filename)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000561{
Fred Drake9cd0efc2001-10-25 21:38:59 +0000562 PyObject *dict, *mod, *mdict;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000563 if (extensions == NULL)
564 return NULL;
565 dict = PyDict_GetItemString(extensions, filename);
566 if (dict == NULL)
567 return NULL;
568 mod = PyImport_AddModule(name);
569 if (mod == NULL)
570 return NULL;
571 mdict = PyModule_GetDict(mod);
572 if (mdict == NULL)
573 return NULL;
Fred Drake9cd0efc2001-10-25 21:38:59 +0000574 if (PyDict_Update(mdict, dict))
Guido van Rossum25ce5661997-08-02 03:10:38 +0000575 return NULL;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000576 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000577 PySys_WriteStderr("import %s # previously loaded (%s)\n",
Guido van Rossum25ce5661997-08-02 03:10:38 +0000578 name, filename);
579 return mod;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000580}
581
582
583/* Get the module object corresponding to a module name.
584 First check the modules dictionary if there's one there,
Walter Dörwaldf0dfc7a2003-10-20 14:01:56 +0000585 if not, create a new one and insert it in the modules dictionary.
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000586 Because the former action is most common, THIS DOES NOT RETURN A
587 'NEW' REFERENCE! */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000588
Guido van Rossum79f25d91997-04-29 20:08:16 +0000589PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000590PyImport_AddModule(const char *name)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000591{
Guido van Rossum25ce5661997-08-02 03:10:38 +0000592 PyObject *modules = PyImport_GetModuleDict();
Guido van Rossum79f25d91997-04-29 20:08:16 +0000593 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000594
Guido van Rossum25ce5661997-08-02 03:10:38 +0000595 if ((m = PyDict_GetItemString(modules, name)) != NULL &&
Guido van Rossum79f25d91997-04-29 20:08:16 +0000596 PyModule_Check(m))
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000597 return m;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000598 m = PyModule_New(name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000599 if (m == NULL)
600 return NULL;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000601 if (PyDict_SetItemString(modules, name, m) != 0) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000602 Py_DECREF(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000603 return NULL;
604 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000605 Py_DECREF(m); /* Yes, it still exists, in modules! */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000606
607 return m;
608}
609
Tim Peters1cd70172004-08-02 03:52:12 +0000610/* Remove name from sys.modules, if it's there. */
611static void
612_RemoveModule(const char *name)
613{
614 PyObject *modules = PyImport_GetModuleDict();
615 if (PyDict_GetItemString(modules, name) == NULL)
616 return;
617 if (PyDict_DelItemString(modules, name) < 0)
618 Py_FatalError("import: deleting existing key in"
619 "sys.modules failed");
620}
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000621
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000622/* Execute a code object in a module and return the module object
Tim Peters1cd70172004-08-02 03:52:12 +0000623 * WITH INCREMENTED REFERENCE COUNT. If an error occurs, name is
624 * removed from sys.modules, to avoid leaving damaged module objects
625 * in sys.modules. The caller may wish to restore the original
626 * module object (if any) in this case; PyImport_ReloadModule is an
627 * example.
628 */
Guido van Rossum79f25d91997-04-29 20:08:16 +0000629PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000630PyImport_ExecCodeModule(char *name, PyObject *co)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000631{
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000632 return PyImport_ExecCodeModuleEx(name, co, (char *)NULL);
633}
634
635PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000636PyImport_ExecCodeModuleEx(char *name, PyObject *co, char *pathname)
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000637{
Guido van Rossum25ce5661997-08-02 03:10:38 +0000638 PyObject *modules = PyImport_GetModuleDict();
Guido van Rossum79f25d91997-04-29 20:08:16 +0000639 PyObject *m, *d, *v;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000640
Guido van Rossum79f25d91997-04-29 20:08:16 +0000641 m = PyImport_AddModule(name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000642 if (m == NULL)
643 return NULL;
Jeremy Hyltonecd91292004-01-02 23:25:32 +0000644 /* If the module is being reloaded, we get the old module back
645 and re-use its dict to exec the new code. */
Guido van Rossum79f25d91997-04-29 20:08:16 +0000646 d = PyModule_GetDict(m);
647 if (PyDict_GetItemString(d, "__builtins__") == NULL) {
648 if (PyDict_SetItemString(d, "__builtins__",
649 PyEval_GetBuiltins()) != 0)
Tim Peters1cd70172004-08-02 03:52:12 +0000650 goto error;
Guido van Rossum6135a871995-01-09 17:53:26 +0000651 }
Guido van Rossum9c9a07c1996-05-16 20:43:40 +0000652 /* Remember the filename as the __file__ attribute */
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000653 v = NULL;
654 if (pathname != NULL) {
655 v = PyString_FromString(pathname);
656 if (v == NULL)
657 PyErr_Clear();
658 }
659 if (v == NULL) {
660 v = ((PyCodeObject *)co)->co_filename;
661 Py_INCREF(v);
662 }
663 if (PyDict_SetItemString(d, "__file__", v) != 0)
Guido van Rossum79f25d91997-04-29 20:08:16 +0000664 PyErr_Clear(); /* Not important enough to report */
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000665 Py_DECREF(v);
666
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000667 v = PyEval_EvalCode((PyCodeObject *)co, d, d);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000668 if (v == NULL)
Tim Peters1cd70172004-08-02 03:52:12 +0000669 goto error;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000670 Py_DECREF(v);
Guido van Rossumb65e85c1997-07-10 18:00:45 +0000671
Guido van Rossum25ce5661997-08-02 03:10:38 +0000672 if ((m = PyDict_GetItemString(modules, name)) == NULL) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000673 PyErr_Format(PyExc_ImportError,
674 "Loaded module %.200s not found in sys.modules",
675 name);
Guido van Rossumb65e85c1997-07-10 18:00:45 +0000676 return NULL;
677 }
678
Guido van Rossum79f25d91997-04-29 20:08:16 +0000679 Py_INCREF(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000680
681 return m;
Tim Peters1cd70172004-08-02 03:52:12 +0000682
683 error:
684 _RemoveModule(name);
685 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000686}
687
688
689/* Given a pathname for a Python source file, fill a buffer with the
690 pathname for the corresponding compiled file. Return the pathname
691 for the compiled file, or NULL if there's no space in the buffer.
692 Doesn't set an exception. */
693
694static char *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000695make_compiled_pathname(char *pathname, char *buf, size_t buflen)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000696{
Tim Petersc1731372001-08-04 08:12:36 +0000697 size_t len = strlen(pathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000698 if (len+2 > buflen)
699 return NULL;
Tim Petersc1731372001-08-04 08:12:36 +0000700
Martin v. Löwis6238d2b2002-06-30 15:26:10 +0000701#ifdef MS_WINDOWS
Tim Petersc1731372001-08-04 08:12:36 +0000702 /* Treat .pyw as if it were .py. The case of ".pyw" must match
703 that used in _PyImport_StandardFiletab. */
704 if (len >= 4 && strcmp(&pathname[len-4], ".pyw") == 0)
705 --len; /* pretend 'w' isn't there */
706#endif
707 memcpy(buf, pathname, len);
708 buf[len] = Py_OptimizeFlag ? 'o' : 'c';
709 buf[len+1] = '\0';
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000710
711 return buf;
712}
713
714
715/* Given a pathname for a Python source file, its time of last
716 modification, and a pathname for a compiled file, check whether the
717 compiled file represents the same version of the source. If so,
718 return a FILE pointer for the compiled file, positioned just after
719 the header; if not, return NULL.
720 Doesn't set an exception. */
721
722static FILE *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000723check_compiled_module(char *pathname, time_t mtime, char *cpathname)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000724{
725 FILE *fp;
726 long magic;
727 long pyc_mtime;
728
729 fp = fopen(cpathname, "rb");
730 if (fp == NULL)
731 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000732 magic = PyMarshal_ReadLongFromFile(fp);
Guido van Rossum96774c12000-05-01 20:19:08 +0000733 if (magic != pyc_magic) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000734 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000735 PySys_WriteStderr("# %s has bad magic\n", cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000736 fclose(fp);
737 return NULL;
738 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000739 pyc_mtime = PyMarshal_ReadLongFromFile(fp);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000740 if (pyc_mtime != mtime) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000741 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000742 PySys_WriteStderr("# %s has bad mtime\n", cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000743 fclose(fp);
744 return NULL;
745 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000746 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000747 PySys_WriteStderr("# %s matches %s\n", cpathname, pathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000748 return fp;
749}
750
751
752/* Read a code object from a file and check it for validity */
753
Guido van Rossum79f25d91997-04-29 20:08:16 +0000754static PyCodeObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000755read_compiled_module(char *cpathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000756{
Guido van Rossum79f25d91997-04-29 20:08:16 +0000757 PyObject *co;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000758
Tim Petersd9b9ac82001-01-28 00:27:39 +0000759 co = PyMarshal_ReadLastObjectFromFile(fp);
Armin Rigo01ab2792004-03-26 15:09:27 +0000760 if (co == NULL)
761 return NULL;
762 if (!PyCode_Check(co)) {
763 PyErr_Format(PyExc_ImportError,
764 "Non-code object in %.200s", cpathname);
765 Py_DECREF(co);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000766 return NULL;
767 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000768 return (PyCodeObject *)co;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000769}
770
771
772/* Load a module from a compiled file, execute it, and return its
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000773 module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000774
Guido van Rossum79f25d91997-04-29 20:08:16 +0000775static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000776load_compiled_module(char *name, char *cpathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000777{
778 long magic;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000779 PyCodeObject *co;
780 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000781
Guido van Rossum79f25d91997-04-29 20:08:16 +0000782 magic = PyMarshal_ReadLongFromFile(fp);
Guido van Rossum96774c12000-05-01 20:19:08 +0000783 if (magic != pyc_magic) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000784 PyErr_Format(PyExc_ImportError,
785 "Bad magic number in %.200s", cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000786 return NULL;
787 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000788 (void) PyMarshal_ReadLongFromFile(fp);
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000789 co = read_compiled_module(cpathname, fp);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000790 if (co == NULL)
791 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000792 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000793 PySys_WriteStderr("import %s # precompiled from %s\n",
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000794 name, cpathname);
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000795 m = PyImport_ExecCodeModuleEx(name, (PyObject *)co, cpathname);
Guido van Rossum79f25d91997-04-29 20:08:16 +0000796 Py_DECREF(co);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000797
798 return m;
799}
800
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000801/* Parse a source file and return the corresponding code object */
802
Guido van Rossum79f25d91997-04-29 20:08:16 +0000803static PyCodeObject *
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000804parse_source_module(const char *pathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000805{
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000806 PyCodeObject *co = NULL;
807 mod_ty mod;
Thomas Wouters89f507f2006-12-13 04:49:30 +0000808 PyArena *arena = PyArena_New();
809 if (arena == NULL)
810 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000811
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000812 mod = PyParser_ASTFromFile(fp, pathname, Py_file_input, 0, 0, 0,
Neal Norwitzadb69fc2005-12-17 20:54:49 +0000813 NULL, arena);
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000814 if (mod) {
Neal Norwitzadb69fc2005-12-17 20:54:49 +0000815 co = PyAST_Compile(mod, pathname, NULL, arena);
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000816 }
Thomas Wouters89f507f2006-12-13 04:49:30 +0000817 PyArena_Free(arena);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000818 return co;
819}
820
821
Guido van Rossum55a83382000-09-20 20:31:38 +0000822/* Helper to open a bytecode file for writing in exclusive mode */
823
824static FILE *
825open_exclusive(char *filename)
826{
827#if defined(O_EXCL)&&defined(O_CREAT)&&defined(O_WRONLY)&&defined(O_TRUNC)
828 /* Use O_EXCL to avoid a race condition when another process tries to
829 write the same file. When that happens, our open() call fails,
830 which is just fine (since it's only a cache).
831 XXX If the file exists and is writable but the directory is not
832 writable, the file will never be written. Oh well.
833 */
834 int fd;
835 (void) unlink(filename);
Tim Peters42c83af2000-09-29 04:03:10 +0000836 fd = open(filename, O_EXCL|O_CREAT|O_WRONLY|O_TRUNC
837#ifdef O_BINARY
838 |O_BINARY /* necessary for Windows */
839#endif
Martin v. Löwis79acb9e2002-12-06 12:48:53 +0000840#ifdef __VMS
Martin v. Löwis18e16552006-02-15 17:27:45 +0000841 , 0666, "ctxt=bin", "shr=nil"
Martin v. Löwis79acb9e2002-12-06 12:48:53 +0000842#else
Martin v. Löwis18e16552006-02-15 17:27:45 +0000843 , 0666
Martin v. Löwis79acb9e2002-12-06 12:48:53 +0000844#endif
Martin v. Löwis18e16552006-02-15 17:27:45 +0000845 );
Guido van Rossum55a83382000-09-20 20:31:38 +0000846 if (fd < 0)
847 return NULL;
848 return fdopen(fd, "wb");
849#else
850 /* Best we can do -- on Windows this can't happen anyway */
851 return fopen(filename, "wb");
852#endif
853}
854
855
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000856/* Write a compiled module to a file, placing the time of last
857 modification of its source into the header.
858 Errors are ignored, if a write error occurs an attempt is made to
859 remove the file. */
860
861static void
Martin v. Löwis18e16552006-02-15 17:27:45 +0000862write_compiled_module(PyCodeObject *co, char *cpathname, time_t mtime)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000863{
864 FILE *fp;
865
Guido van Rossum55a83382000-09-20 20:31:38 +0000866 fp = open_exclusive(cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000867 if (fp == NULL) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000868 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000869 PySys_WriteStderr(
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000870 "# can't create %s\n", cpathname);
871 return;
872 }
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000873 PyMarshal_WriteLongToFile(pyc_magic, fp, Py_MARSHAL_VERSION);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000874 /* First write a 0 for mtime */
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000875 PyMarshal_WriteLongToFile(0L, fp, Py_MARSHAL_VERSION);
876 PyMarshal_WriteObjectToFile((PyObject *)co, fp, Py_MARSHAL_VERSION);
Armin Rigo01ab2792004-03-26 15:09:27 +0000877 if (fflush(fp) != 0 || ferror(fp)) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000878 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000879 PySys_WriteStderr("# can't write %s\n", cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000880 /* Don't keep partial file */
881 fclose(fp);
882 (void) unlink(cpathname);
883 return;
884 }
885 /* Now write the true mtime */
886 fseek(fp, 4L, 0);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000887 assert(mtime < LONG_MAX);
Martin v. Löwis725507b2006-03-07 12:08:51 +0000888 PyMarshal_WriteLongToFile((long)mtime, fp, Py_MARSHAL_VERSION);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000889 fflush(fp);
890 fclose(fp);
Guido van Rossum79f25d91997-04-29 20:08:16 +0000891 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000892 PySys_WriteStderr("# wrote %s\n", cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000893}
894
895
896/* Load a source module from a given file and return its module
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000897 object WITH INCREMENTED REFERENCE COUNT. If there's a matching
898 byte-compiled file, use that instead. */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000899
Guido van Rossum79f25d91997-04-29 20:08:16 +0000900static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000901load_source_module(char *name, char *pathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000902{
Fred Drake4c82b232000-06-30 16:18:57 +0000903 time_t mtime;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000904 FILE *fpc;
905 char buf[MAXPATHLEN+1];
906 char *cpathname;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000907 PyCodeObject *co;
908 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000909
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000910 mtime = PyOS_GetLastModificationTime(pathname, fp);
Neal Norwitz708e51a2005-10-03 04:48:15 +0000911 if (mtime == (time_t)(-1)) {
912 PyErr_Format(PyExc_RuntimeError,
913 "unable to get modification time from '%s'",
914 pathname);
Fred Drake4c82b232000-06-30 16:18:57 +0000915 return NULL;
Neal Norwitz708e51a2005-10-03 04:48:15 +0000916 }
Fred Drake4c82b232000-06-30 16:18:57 +0000917#if SIZEOF_TIME_T > 4
918 /* Python's .pyc timestamp handling presumes that the timestamp fits
919 in 4 bytes. This will be fine until sometime in the year 2038,
920 when a 4-byte signed time_t will overflow.
921 */
922 if (mtime >> 32) {
923 PyErr_SetString(PyExc_OverflowError,
Fred Drakec63d3e92001-03-01 06:33:32 +0000924 "modification time overflows a 4 byte field");
Fred Drake4c82b232000-06-30 16:18:57 +0000925 return NULL;
926 }
927#endif
Tim Peters36515e22001-11-18 04:06:29 +0000928 cpathname = make_compiled_pathname(pathname, buf,
Jeremy Hylton37832f02001-04-13 17:50:20 +0000929 (size_t)MAXPATHLEN + 1);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000930 if (cpathname != NULL &&
931 (fpc = check_compiled_module(pathname, mtime, cpathname))) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000932 co = read_compiled_module(cpathname, fpc);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000933 fclose(fpc);
934 if (co == NULL)
935 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000936 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000937 PySys_WriteStderr("import %s # precompiled from %s\n",
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000938 name, cpathname);
Guido van Rossumafd3dae1998-08-25 18:44:34 +0000939 pathname = cpathname;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000940 }
941 else {
942 co = parse_source_module(pathname, fp);
943 if (co == NULL)
944 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000945 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000946 PySys_WriteStderr("import %s # from %s\n",
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000947 name, pathname);
Thomas Wouters00ee7ba2006-08-21 19:07:27 +0000948 if (cpathname)
949 write_compiled_module(co, cpathname, mtime);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000950 }
Guido van Rossumafd3dae1998-08-25 18:44:34 +0000951 m = PyImport_ExecCodeModuleEx(name, (PyObject *)co, pathname);
Guido van Rossum79f25d91997-04-29 20:08:16 +0000952 Py_DECREF(co);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000953
954 return m;
955}
956
957
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000958/* Forward */
Just van Rossum52e14d62002-12-30 22:08:05 +0000959static PyObject *load_module(char *, FILE *, char *, int, PyObject *);
960static struct filedescr *find_module(char *, char *, PyObject *,
961 char *, size_t, FILE **, PyObject **);
Tim Petersdbd9ba62000-07-09 03:09:57 +0000962static struct _frozen *find_frozen(char *name);
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000963
964/* Load a package and return its module object WITH INCREMENTED
965 REFERENCE COUNT */
966
967static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000968load_package(char *name, char *pathname)
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000969{
Tim Peters1cd70172004-08-02 03:52:12 +0000970 PyObject *m, *d;
971 PyObject *file = NULL;
972 PyObject *path = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000973 int err;
974 char buf[MAXPATHLEN+1];
975 FILE *fp = NULL;
976 struct filedescr *fdp;
977
978 m = PyImport_AddModule(name);
979 if (m == NULL)
980 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +0000981 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000982 PySys_WriteStderr("import %s # directory %s\n",
Guido van Rossum17fc85f1997-09-06 18:52:03 +0000983 name, pathname);
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000984 d = PyModule_GetDict(m);
985 file = PyString_FromString(pathname);
986 if (file == NULL)
Tim Peters1cd70172004-08-02 03:52:12 +0000987 goto error;
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000988 path = Py_BuildValue("[O]", file);
Tim Peters1cd70172004-08-02 03:52:12 +0000989 if (path == NULL)
990 goto error;
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000991 err = PyDict_SetItemString(d, "__file__", file);
992 if (err == 0)
993 err = PyDict_SetItemString(d, "__path__", path);
Tim Peters1cd70172004-08-02 03:52:12 +0000994 if (err != 0)
995 goto error;
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000996 buf[0] = '\0';
Just van Rossum52e14d62002-12-30 22:08:05 +0000997 fdp = find_module(name, "__init__", path, buf, sizeof(buf), &fp, NULL);
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000998 if (fdp == NULL) {
999 if (PyErr_ExceptionMatches(PyExc_ImportError)) {
1000 PyErr_Clear();
Thomas Heller25653242004-06-07 15:04:10 +00001001 Py_INCREF(m);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001002 }
1003 else
1004 m = NULL;
1005 goto cleanup;
1006 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001007 m = load_module(name, fp, buf, fdp->type, NULL);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001008 if (fp != NULL)
1009 fclose(fp);
Tim Peters1cd70172004-08-02 03:52:12 +00001010 goto cleanup;
1011
1012 error:
1013 m = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001014 cleanup:
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001015 Py_XDECREF(path);
1016 Py_XDECREF(file);
1017 return m;
1018}
1019
1020
1021/* Helper to test for built-in module */
1022
1023static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001024is_builtin(char *name)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001025{
1026 int i;
Guido van Rossum771c6c81997-10-31 18:37:24 +00001027 for (i = 0; PyImport_Inittab[i].name != NULL; i++) {
1028 if (strcmp(name, PyImport_Inittab[i].name) == 0) {
1029 if (PyImport_Inittab[i].initfunc == NULL)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001030 return -1;
1031 else
1032 return 1;
1033 }
1034 }
1035 return 0;
1036}
1037
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001038
Just van Rossum52e14d62002-12-30 22:08:05 +00001039/* Return an importer object for a sys.path/pkg.__path__ item 'p',
1040 possibly by fetching it from the path_importer_cache dict. If it
Thomas Wouters89f507f2006-12-13 04:49:30 +00001041 wasn't yet cached, traverse path_hooks until a hook is found
Just van Rossum52e14d62002-12-30 22:08:05 +00001042 that can handle the path item. Return None if no hook could;
1043 this tells our caller it should fall back to the builtin
1044 import mechanism. Cache the result in path_importer_cache.
1045 Returns a borrowed reference. */
1046
1047static PyObject *
1048get_path_importer(PyObject *path_importer_cache, PyObject *path_hooks,
1049 PyObject *p)
1050{
1051 PyObject *importer;
Martin v. Löwis725507b2006-03-07 12:08:51 +00001052 Py_ssize_t j, nhooks;
Just van Rossum52e14d62002-12-30 22:08:05 +00001053
1054 /* These conditions are the caller's responsibility: */
1055 assert(PyList_Check(path_hooks));
1056 assert(PyDict_Check(path_importer_cache));
1057
1058 nhooks = PyList_Size(path_hooks);
1059 if (nhooks < 0)
1060 return NULL; /* Shouldn't happen */
1061
1062 importer = PyDict_GetItem(path_importer_cache, p);
1063 if (importer != NULL)
1064 return importer;
1065
1066 /* set path_importer_cache[p] to None to avoid recursion */
1067 if (PyDict_SetItem(path_importer_cache, p, Py_None) != 0)
1068 return NULL;
1069
1070 for (j = 0; j < nhooks; j++) {
1071 PyObject *hook = PyList_GetItem(path_hooks, j);
1072 if (hook == NULL)
1073 return NULL;
Thomas Wouters477c8d52006-05-27 19:21:47 +00001074 importer = PyObject_CallFunctionObjArgs(hook, p, NULL);
Just van Rossum52e14d62002-12-30 22:08:05 +00001075 if (importer != NULL)
1076 break;
1077
1078 if (!PyErr_ExceptionMatches(PyExc_ImportError)) {
1079 return NULL;
1080 }
1081 PyErr_Clear();
1082 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001083 if (importer == NULL) {
1084 importer = PyObject_CallFunctionObjArgs(
1085 (PyObject *)&NullImporterType, p, NULL
1086 );
1087 if (importer == NULL) {
1088 if (PyErr_ExceptionMatches(PyExc_ImportError)) {
1089 PyErr_Clear();
1090 return Py_None;
1091 }
1092 }
1093 }
1094 if (importer != NULL) {
Just van Rossum52e14d62002-12-30 22:08:05 +00001095 int err = PyDict_SetItem(path_importer_cache, p, importer);
1096 Py_DECREF(importer);
1097 if (err != 0)
1098 return NULL;
1099 }
1100 return importer;
1101}
1102
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001103/* Search the path (default sys.path) for a module. Return the
1104 corresponding filedescr struct, and (via return arguments) the
1105 pathname and an open file. Return NULL if the module is not found. */
1106
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001107#ifdef MS_COREDLL
Thomas Woutersb4bd21c2000-07-22 23:38:01 +00001108extern FILE *PyWin_FindRegisteredModule(const char *, struct filedescr **,
Martin v. Löwis18e16552006-02-15 17:27:45 +00001109 char *, Py_ssize_t);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001110#endif
1111
Martin v. Löwis18e16552006-02-15 17:27:45 +00001112static int case_ok(char *, Py_ssize_t, Py_ssize_t, char *);
Tim Petersdbd9ba62000-07-09 03:09:57 +00001113static int find_init_module(char *); /* Forward */
Just van Rossum52e14d62002-12-30 22:08:05 +00001114static struct filedescr importhookdescr = {"", "", IMP_HOOK};
Guido van Rossum197346f1997-10-31 18:38:52 +00001115
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001116static struct filedescr *
Just van Rossum52e14d62002-12-30 22:08:05 +00001117find_module(char *fullname, char *subname, PyObject *path, char *buf,
1118 size_t buflen, FILE **p_fp, PyObject **p_loader)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001119{
Martin v. Löwis725507b2006-03-07 12:08:51 +00001120 Py_ssize_t i, npath;
Fred Drake4c82b232000-06-30 16:18:57 +00001121 size_t len, namelen;
Guido van Rossum80bb9651996-12-05 23:27:02 +00001122 struct filedescr *fdp = NULL;
Jack Jansenc88da1f2002-05-28 10:58:19 +00001123 char *filemode;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001124 FILE *fp = NULL;
Just van Rossum52e14d62002-12-30 22:08:05 +00001125 PyObject *path_hooks, *path_importer_cache;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001126 struct stat statbuf;
Guido van Rossuma5568d31998-03-05 03:45:08 +00001127 static struct filedescr fd_frozen = {"", "", PY_FROZEN};
1128 static struct filedescr fd_builtin = {"", "", C_BUILTIN};
1129 static struct filedescr fd_package = {"", "", PKG_DIRECTORY};
Guido van Rossum0506a431998-08-11 15:07:39 +00001130 char name[MAXPATHLEN+1];
Andrew MacIntyred9400542002-02-26 11:41:34 +00001131#if defined(PYOS_OS2)
1132 size_t saved_len;
1133 size_t saved_namelen;
1134 char *saved_buf = NULL;
1135#endif
Just van Rossum52e14d62002-12-30 22:08:05 +00001136 if (p_loader != NULL)
1137 *p_loader = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001138
Just van Rossum52e14d62002-12-30 22:08:05 +00001139 if (strlen(subname) > MAXPATHLEN) {
Guido van Rossum8f4d3312001-10-18 18:54:11 +00001140 PyErr_SetString(PyExc_OverflowError,
1141 "module name is too long");
Fred Drake4c82b232000-06-30 16:18:57 +00001142 return NULL;
1143 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001144 strcpy(name, subname);
1145
1146 /* sys.meta_path import hook */
1147 if (p_loader != NULL) {
1148 PyObject *meta_path;
1149
1150 meta_path = PySys_GetObject("meta_path");
1151 if (meta_path == NULL || !PyList_Check(meta_path)) {
1152 PyErr_SetString(PyExc_ImportError,
1153 "sys.meta_path must be a list of "
1154 "import hooks");
1155 return NULL;
1156 }
1157 Py_INCREF(meta_path); /* zap guard */
1158 npath = PyList_Size(meta_path);
1159 for (i = 0; i < npath; i++) {
1160 PyObject *loader;
1161 PyObject *hook = PyList_GetItem(meta_path, i);
1162 loader = PyObject_CallMethod(hook, "find_module",
1163 "sO", fullname,
1164 path != NULL ?
1165 path : Py_None);
1166 if (loader == NULL) {
1167 Py_DECREF(meta_path);
1168 return NULL; /* true error */
1169 }
1170 if (loader != Py_None) {
1171 /* a loader was found */
1172 *p_loader = loader;
1173 Py_DECREF(meta_path);
1174 return &importhookdescr;
1175 }
1176 Py_DECREF(loader);
1177 }
1178 Py_DECREF(meta_path);
1179 }
Guido van Rossum0506a431998-08-11 15:07:39 +00001180
Guido van Rossum13d77992007-07-23 03:16:50 +00001181 if (path != NULL && PyUnicode_Check(path)) {
Guido van Rossum8f4d3312001-10-18 18:54:11 +00001182 /* The only type of submodule allowed inside a "frozen"
1183 package are other frozen modules or packages. */
Guido van Rossum13d77992007-07-23 03:16:50 +00001184 char *p = PyUnicode_AsString(path);
1185 if (strlen(p) + 1 + strlen(name) >= (size_t)buflen) {
Guido van Rossum0506a431998-08-11 15:07:39 +00001186 PyErr_SetString(PyExc_ImportError,
1187 "full frozen module name too long");
1188 return NULL;
1189 }
Guido van Rossum13d77992007-07-23 03:16:50 +00001190 strcpy(buf, p);
Guido van Rossum0506a431998-08-11 15:07:39 +00001191 strcat(buf, ".");
1192 strcat(buf, name);
1193 strcpy(name, buf);
Guido van Rossum8f4d3312001-10-18 18:54:11 +00001194 if (find_frozen(name) != NULL) {
1195 strcpy(buf, name);
1196 return &fd_frozen;
1197 }
1198 PyErr_Format(PyExc_ImportError,
1199 "No frozen submodule named %.200s", name);
1200 return NULL;
Guido van Rossum0506a431998-08-11 15:07:39 +00001201 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001202 if (path == NULL) {
1203 if (is_builtin(name)) {
Guido van Rossuma5568d31998-03-05 03:45:08 +00001204 strcpy(buf, name);
1205 return &fd_builtin;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001206 }
Greg Ward201baee2001-10-04 14:52:06 +00001207 if ((find_frozen(name)) != NULL) {
Guido van Rossuma5568d31998-03-05 03:45:08 +00001208 strcpy(buf, name);
1209 return &fd_frozen;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001210 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001211
Guido van Rossumac279101996-08-22 23:10:58 +00001212#ifdef MS_COREDLL
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001213 fp = PyWin_FindRegisteredModule(name, &fdp, buf, buflen);
1214 if (fp != NULL) {
1215 *p_fp = fp;
1216 return fdp;
1217 }
Guido van Rossuma5a3db71996-04-09 02:39:59 +00001218#endif
Guido van Rossuma5568d31998-03-05 03:45:08 +00001219 path = PySys_GetObject("path");
1220 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00001221 if (path == NULL || !PyList_Check(path)) {
1222 PyErr_SetString(PyExc_ImportError,
Guido van Rossuma5568d31998-03-05 03:45:08 +00001223 "sys.path must be a list of directory names");
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001224 return NULL;
1225 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001226
1227 path_hooks = PySys_GetObject("path_hooks");
1228 if (path_hooks == NULL || !PyList_Check(path_hooks)) {
1229 PyErr_SetString(PyExc_ImportError,
1230 "sys.path_hooks must be a list of "
1231 "import hooks");
1232 return NULL;
1233 }
1234 path_importer_cache = PySys_GetObject("path_importer_cache");
1235 if (path_importer_cache == NULL ||
1236 !PyDict_Check(path_importer_cache)) {
1237 PyErr_SetString(PyExc_ImportError,
1238 "sys.path_importer_cache must be a dict");
1239 return NULL;
1240 }
1241
Guido van Rossum79f25d91997-04-29 20:08:16 +00001242 npath = PyList_Size(path);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001243 namelen = strlen(name);
1244 for (i = 0; i < npath; i++) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00001245 PyObject *v = PyList_GetItem(path, i);
Guido van Rossumf15a29f2007-05-04 00:41:39 +00001246 PyObject *origv = v;
Guido van Rossum6262cc72007-05-09 23:29:27 +00001247 const char *base;
Guido van Rossumf15a29f2007-05-04 00:41:39 +00001248 Py_ssize_t size;
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001249 if (!v)
1250 return NULL;
Guido van Rossuma4b8d1d2007-08-27 15:02:28 +00001251 if (PyUnicode_Check(v)) {
1252 v = _PyUnicode_AsDefaultEncodedString(v, NULL);
1253 if (v == NULL)
1254 return NULL;
1255 }
1256 if (!PyString_Check(v))
1257 continue;
1258 base = PyString_AS_STRING(v);
1259 size = PyString_GET_SIZE(v);
Guido van Rossumf15a29f2007-05-04 00:41:39 +00001260 len = size;
Walter Dörwald3430d702002-06-17 10:43:59 +00001261 if (len + 2 + namelen + MAXSUFFIXSIZE >= buflen) {
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001262 continue; /* Too long */
Walter Dörwald3430d702002-06-17 10:43:59 +00001263 }
Guido van Rossumf15a29f2007-05-04 00:41:39 +00001264 strcpy(buf, base);
Walter Dörwald3430d702002-06-17 10:43:59 +00001265 if (strlen(buf) != len) {
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001266 continue; /* v contains '\0' */
Walter Dörwald3430d702002-06-17 10:43:59 +00001267 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001268
1269 /* sys.path_hooks import hook */
1270 if (p_loader != NULL) {
1271 PyObject *importer;
1272
1273 importer = get_path_importer(path_importer_cache,
Guido van Rossumf15a29f2007-05-04 00:41:39 +00001274 path_hooks, origv);
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001275 if (importer == NULL) {
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001276 return NULL;
Thomas Wouters477c8d52006-05-27 19:21:47 +00001277 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001278 /* Note: importer is a borrowed reference */
1279 if (importer != Py_None) {
Just van Rossum52e14d62002-12-30 22:08:05 +00001280 PyObject *loader;
1281 loader = PyObject_CallMethod(importer,
1282 "find_module",
1283 "s", fullname);
1284 if (loader == NULL)
1285 return NULL; /* error */
1286 if (loader != Py_None) {
1287 /* a loader was found */
1288 *p_loader = loader;
1289 return &importhookdescr;
1290 }
1291 Py_DECREF(loader);
Thomas Wouters477c8d52006-05-27 19:21:47 +00001292 continue;
Just van Rossum52e14d62002-12-30 22:08:05 +00001293 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001294 }
Thomas Wouters477c8d52006-05-27 19:21:47 +00001295 /* no hook was found, use builtin import */
Just van Rossum52e14d62002-12-30 22:08:05 +00001296
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001297 if (len > 0 && buf[len-1] != SEP
1298#ifdef ALTSEP
1299 && buf[len-1] != ALTSEP
1300#endif
1301 )
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001302 buf[len++] = SEP;
Guido van Rossum215c3402000-11-13 17:26:32 +00001303 strcpy(buf+len, name);
1304 len += namelen;
Tim Peters50d8d372001-02-28 05:34:27 +00001305
1306 /* Check for package import (buf holds a directory name,
1307 and there's an __init__ module in that directory */
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001308#ifdef HAVE_STAT
Walter Dörwald3430d702002-06-17 10:43:59 +00001309 if (stat(buf, &statbuf) == 0 && /* it exists */
1310 S_ISDIR(statbuf.st_mode) && /* it's a directory */
Thomas Wouters477c8d52006-05-27 19:21:47 +00001311 case_ok(buf, len, namelen, name)) { /* case matches */
1312 if (find_init_module(buf)) { /* and has __init__.py */
Thomas Wouters477c8d52006-05-27 19:21:47 +00001313 return &fd_package;
1314 }
1315 else {
1316 char warnstr[MAXPATHLEN+80];
1317 sprintf(warnstr, "Not importing directory "
1318 "'%.*s': missing __init__.py",
1319 MAXPATHLEN, buf);
Skip Montanaro46fc3372007-08-12 11:44:53 +00001320 if (PyErr_WarnEx(PyExc_ImportWarning,
1321 warnstr, 1)) {
Thomas Wouters477c8d52006-05-27 19:21:47 +00001322 return NULL;
1323 }
1324 }
Walter Dörwald3430d702002-06-17 10:43:59 +00001325 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001326#endif
Andrew MacIntyred9400542002-02-26 11:41:34 +00001327#if defined(PYOS_OS2)
1328 /* take a snapshot of the module spec for restoration
1329 * after the 8 character DLL hackery
1330 */
1331 saved_buf = strdup(buf);
1332 saved_len = len;
1333 saved_namelen = namelen;
1334#endif /* PYOS_OS2 */
Guido van Rossum79f25d91997-04-29 20:08:16 +00001335 for (fdp = _PyImport_Filetab; fdp->suffix != NULL; fdp++) {
Guido van Rossum04110fb2007-08-24 16:32:05 +00001336#if defined(PYOS_OS2) && defined(HAVE_DYNAMIC_LOADING)
Jeremy Hylton4ae6fae2002-05-30 17:15:25 +00001337 /* OS/2 limits DLLs to 8 character names (w/o
1338 extension)
Andrew MacIntyred9400542002-02-26 11:41:34 +00001339 * so if the name is longer than that and its a
1340 * dynamically loaded module we're going to try,
1341 * truncate the name before trying
1342 */
Just van Rossum52e14d62002-12-30 22:08:05 +00001343 if (strlen(subname) > 8) {
Andrew MacIntyred9400542002-02-26 11:41:34 +00001344 /* is this an attempt to load a C extension? */
Jeremy Hylton4ae6fae2002-05-30 17:15:25 +00001345 const struct filedescr *scan;
1346 scan = _PyImport_DynLoadFiletab;
Andrew MacIntyred9400542002-02-26 11:41:34 +00001347 while (scan->suffix != NULL) {
Jeremy Hylton4ae6fae2002-05-30 17:15:25 +00001348 if (!strcmp(scan->suffix, fdp->suffix))
Andrew MacIntyred9400542002-02-26 11:41:34 +00001349 break;
1350 else
1351 scan++;
1352 }
1353 if (scan->suffix != NULL) {
1354 /* yes, so truncate the name */
1355 namelen = 8;
Just van Rossum52e14d62002-12-30 22:08:05 +00001356 len -= strlen(subname) - namelen;
Andrew MacIntyred9400542002-02-26 11:41:34 +00001357 buf[len] = '\0';
1358 }
1359 }
1360#endif /* PYOS_OS2 */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001361 strcpy(buf+len, fdp->suffix);
Guido van Rossum79f25d91997-04-29 20:08:16 +00001362 if (Py_VerboseFlag > 1)
Guido van Rossum2f3667a1998-10-12 18:23:55 +00001363 PySys_WriteStderr("# trying %s\n", buf);
Jack Jansenc88da1f2002-05-28 10:58:19 +00001364 filemode = fdp->mode;
Tim Peters86c7d2f2004-08-01 23:24:21 +00001365 if (filemode[0] == 'U')
Jeremy Hylton4ae6fae2002-05-30 17:15:25 +00001366 filemode = "r" PY_STDIOTEXTMODE;
Jack Jansenc88da1f2002-05-28 10:58:19 +00001367 fp = fopen(buf, filemode);
Tim Peters50d8d372001-02-28 05:34:27 +00001368 if (fp != NULL) {
1369 if (case_ok(buf, len, namelen, name))
1370 break;
1371 else { /* continue search */
1372 fclose(fp);
1373 fp = NULL;
Barry Warsaw914a0b12001-02-02 19:12:16 +00001374 }
Barry Warsaw914a0b12001-02-02 19:12:16 +00001375 }
Andrew MacIntyred9400542002-02-26 11:41:34 +00001376#if defined(PYOS_OS2)
1377 /* restore the saved snapshot */
1378 strcpy(buf, saved_buf);
1379 len = saved_len;
1380 namelen = saved_namelen;
1381#endif
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001382 }
Andrew MacIntyred9400542002-02-26 11:41:34 +00001383#if defined(PYOS_OS2)
1384 /* don't need/want the module name snapshot anymore */
1385 if (saved_buf)
1386 {
1387 free(saved_buf);
1388 saved_buf = NULL;
1389 }
1390#endif
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001391 if (fp != NULL)
1392 break;
1393 }
1394 if (fp == NULL) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001395 PyErr_Format(PyExc_ImportError,
1396 "No module named %.200s", name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001397 return NULL;
1398 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001399 *p_fp = fp;
1400 return fdp;
1401}
1402
Raymond Hettingerdb29e0f2004-10-07 06:46:25 +00001403/* Helpers for main.c
1404 * Find the source file corresponding to a named module
1405 */
1406struct filedescr *
1407_PyImport_FindModule(const char *name, PyObject *path, char *buf,
1408 size_t buflen, FILE **p_fp, PyObject **p_loader)
1409{
1410 return find_module((char *) name, (char *) name, path,
1411 buf, buflen, p_fp, p_loader);
1412}
1413
1414PyAPI_FUNC(int) _PyImport_IsScript(struct filedescr * fd)
1415{
1416 return fd->type == PY_SOURCE || fd->type == PY_COMPILED;
1417}
1418
Martin v. Löwis18e16552006-02-15 17:27:45 +00001419/* case_ok(char* buf, Py_ssize_t len, Py_ssize_t namelen, char* name)
Tim Petersd1e87a82001-03-01 18:12:00 +00001420 * The arguments here are tricky, best shown by example:
1421 * /a/b/c/d/e/f/g/h/i/j/k/some_long_module_name.py\0
1422 * ^ ^ ^ ^
1423 * |--------------------- buf ---------------------|
1424 * |------------------- len ------------------|
1425 * |------ name -------|
1426 * |----- namelen -----|
1427 * buf is the full path, but len only counts up to (& exclusive of) the
1428 * extension. name is the module name, also exclusive of extension.
1429 *
1430 * We've already done a successful stat() or fopen() on buf, so know that
1431 * there's some match, possibly case-insensitive.
1432 *
Tim Peters50d8d372001-02-28 05:34:27 +00001433 * case_ok() is to return 1 if there's a case-sensitive match for
1434 * name, else 0. case_ok() is also to return 1 if envar PYTHONCASEOK
1435 * exists.
Tim Petersd1e87a82001-03-01 18:12:00 +00001436 *
Tim Peters50d8d372001-02-28 05:34:27 +00001437 * case_ok() is used to implement case-sensitive import semantics even
1438 * on platforms with case-insensitive filesystems. It's trivial to implement
1439 * for case-sensitive filesystems. It's pretty much a cross-platform
1440 * nightmare for systems with case-insensitive filesystems.
1441 */
Guido van Rossum0980bd91998-02-13 17:18:36 +00001442
Tim Peters50d8d372001-02-28 05:34:27 +00001443/* First we may need a pile of platform-specific header files; the sequence
1444 * of #if's here should match the sequence in the body of case_ok().
1445 */
Jason Tishler7961aa62005-05-20 00:56:54 +00001446#if defined(MS_WINDOWS)
Guido van Rossum0980bd91998-02-13 17:18:36 +00001447#include <windows.h>
Guido van Rossum4c3f57c2001-01-10 20:40:46 +00001448
Tim Peters50d8d372001-02-28 05:34:27 +00001449#elif defined(DJGPP)
1450#include <dir.h>
1451
Jason Tishler7961aa62005-05-20 00:56:54 +00001452#elif (defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) && defined(HAVE_DIRENT_H)
Tim Peters430f5d42001-03-01 01:30:56 +00001453#include <sys/types.h>
1454#include <dirent.h>
1455
Andrew MacIntyred9400542002-02-26 11:41:34 +00001456#elif defined(PYOS_OS2)
1457#define INCL_DOS
1458#define INCL_DOSERRORS
1459#define INCL_NOPMAPI
1460#include <os2.h>
Tim Peters50d8d372001-02-28 05:34:27 +00001461#endif
1462
Guido van Rossum0980bd91998-02-13 17:18:36 +00001463static int
Martin v. Löwis18e16552006-02-15 17:27:45 +00001464case_ok(char *buf, Py_ssize_t len, Py_ssize_t namelen, char *name)
Guido van Rossum0980bd91998-02-13 17:18:36 +00001465{
Tim Peters50d8d372001-02-28 05:34:27 +00001466/* Pick a platform-specific implementation; the sequence of #if's here should
1467 * match the sequence just above.
1468 */
1469
Jason Tishler7961aa62005-05-20 00:56:54 +00001470/* MS_WINDOWS */
1471#if defined(MS_WINDOWS)
Guido van Rossum0980bd91998-02-13 17:18:36 +00001472 WIN32_FIND_DATA data;
1473 HANDLE h;
Tim Peters50d8d372001-02-28 05:34:27 +00001474
Neil Schemenauer7d4bb9f2001-07-23 16:30:27 +00001475 if (Py_GETENV("PYTHONCASEOK") != NULL)
Guido van Rossum0980bd91998-02-13 17:18:36 +00001476 return 1;
Tim Peters50d8d372001-02-28 05:34:27 +00001477
Guido van Rossum0980bd91998-02-13 17:18:36 +00001478 h = FindFirstFile(buf, &data);
1479 if (h == INVALID_HANDLE_VALUE) {
1480 PyErr_Format(PyExc_NameError,
1481 "Can't find file for module %.100s\n(filename %.300s)",
1482 name, buf);
1483 return 0;
1484 }
1485 FindClose(h);
Tim Peters50d8d372001-02-28 05:34:27 +00001486 return strncmp(data.cFileName, name, namelen) == 0;
1487
1488/* DJGPP */
1489#elif defined(DJGPP)
1490 struct ffblk ffblk;
1491 int done;
1492
Neil Schemenauer7d4bb9f2001-07-23 16:30:27 +00001493 if (Py_GETENV("PYTHONCASEOK") != NULL)
Guido van Rossum323bf5e1998-06-24 03:54:06 +00001494 return 1;
Tim Peters50d8d372001-02-28 05:34:27 +00001495
1496 done = findfirst(buf, &ffblk, FA_ARCH|FA_RDONLY|FA_HIDDEN|FA_DIREC);
1497 if (done) {
Guido van Rossum0980bd91998-02-13 17:18:36 +00001498 PyErr_Format(PyExc_NameError,
Tim Peters50d8d372001-02-28 05:34:27 +00001499 "Can't find file for module %.100s\n(filename %.300s)",
Guido van Rossum0980bd91998-02-13 17:18:36 +00001500 name, buf);
1501 return 0;
1502 }
Tim Peters50d8d372001-02-28 05:34:27 +00001503 return strncmp(ffblk.ff_name, name, namelen) == 0;
Guido van Rossum0980bd91998-02-13 17:18:36 +00001504
Jason Tishler7961aa62005-05-20 00:56:54 +00001505/* new-fangled macintosh (macosx) or Cygwin */
1506#elif (defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) && defined(HAVE_DIRENT_H)
Tim Peters430f5d42001-03-01 01:30:56 +00001507 DIR *dirp;
1508 struct dirent *dp;
Tim Petersd1e87a82001-03-01 18:12:00 +00001509 char dirname[MAXPATHLEN + 1];
1510 const int dirlen = len - namelen - 1; /* don't want trailing SEP */
Tim Peters430f5d42001-03-01 01:30:56 +00001511
Neil Schemenauer7d4bb9f2001-07-23 16:30:27 +00001512 if (Py_GETENV("PYTHONCASEOK") != NULL)
Tim Petersdbe6ebb2001-03-01 08:47:29 +00001513 return 1;
1514
Tim Petersd1e87a82001-03-01 18:12:00 +00001515 /* Copy the dir component into dirname; substitute "." if empty */
1516 if (dirlen <= 0) {
1517 dirname[0] = '.';
1518 dirname[1] = '\0';
Tim Peters430f5d42001-03-01 01:30:56 +00001519 }
1520 else {
Tim Petersd1e87a82001-03-01 18:12:00 +00001521 assert(dirlen <= MAXPATHLEN);
1522 memcpy(dirname, buf, dirlen);
1523 dirname[dirlen] = '\0';
Tim Peters430f5d42001-03-01 01:30:56 +00001524 }
1525 /* Open the directory and search the entries for an exact match. */
Tim Petersd1e87a82001-03-01 18:12:00 +00001526 dirp = opendir(dirname);
Tim Peters430f5d42001-03-01 01:30:56 +00001527 if (dirp) {
Tim Peters677898a2001-03-02 03:28:03 +00001528 char *nameWithExt = buf + len - namelen;
Tim Peters430f5d42001-03-01 01:30:56 +00001529 while ((dp = readdir(dirp)) != NULL) {
Tim Petersdbe6ebb2001-03-01 08:47:29 +00001530 const int thislen =
Tim Peters430f5d42001-03-01 01:30:56 +00001531#ifdef _DIRENT_HAVE_D_NAMELEN
Tim Petersdbe6ebb2001-03-01 08:47:29 +00001532 dp->d_namlen;
Tim Peters430f5d42001-03-01 01:30:56 +00001533#else
Tim Petersdbe6ebb2001-03-01 08:47:29 +00001534 strlen(dp->d_name);
Tim Peters430f5d42001-03-01 01:30:56 +00001535#endif
Tim Petersd1e87a82001-03-01 18:12:00 +00001536 if (thislen >= namelen &&
Tim Peters677898a2001-03-02 03:28:03 +00001537 strcmp(dp->d_name, nameWithExt) == 0) {
Tim Peters430f5d42001-03-01 01:30:56 +00001538 (void)closedir(dirp);
1539 return 1; /* Found */
1540 }
1541 }
Tim Petersdbe6ebb2001-03-01 08:47:29 +00001542 (void)closedir(dirp);
Tim Peters430f5d42001-03-01 01:30:56 +00001543 }
Tim Peters430f5d42001-03-01 01:30:56 +00001544 return 0 ; /* Not found */
Tim Peters430f5d42001-03-01 01:30:56 +00001545
Andrew MacIntyred9400542002-02-26 11:41:34 +00001546/* OS/2 */
1547#elif defined(PYOS_OS2)
1548 HDIR hdir = 1;
1549 ULONG srchcnt = 1;
1550 FILEFINDBUF3 ffbuf;
1551 APIRET rc;
1552
1553 if (getenv("PYTHONCASEOK") != NULL)
1554 return 1;
1555
1556 rc = DosFindFirst(buf,
1557 &hdir,
1558 FILE_READONLY | FILE_HIDDEN | FILE_SYSTEM | FILE_DIRECTORY,
1559 &ffbuf, sizeof(ffbuf),
1560 &srchcnt,
1561 FIL_STANDARD);
1562 if (rc != NO_ERROR)
1563 return 0;
1564 return strncmp(ffbuf.achName, name, namelen) == 0;
1565
Tim Peters50d8d372001-02-28 05:34:27 +00001566/* assuming it's a case-sensitive filesystem, so there's nothing to do! */
1567#else
Guido van Rossum0980bd91998-02-13 17:18:36 +00001568 return 1;
Guido van Rossum0980bd91998-02-13 17:18:36 +00001569
Guido van Rossum4d1b3b91998-02-13 23:27:59 +00001570#endif
Tim Peters50d8d372001-02-28 05:34:27 +00001571}
Guido van Rossum4d1b3b91998-02-13 23:27:59 +00001572
Guido van Rossum0980bd91998-02-13 17:18:36 +00001573
Guido van Rossum197346f1997-10-31 18:38:52 +00001574#ifdef HAVE_STAT
1575/* Helper to look for __init__.py or __init__.py[co] in potential package */
1576static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001577find_init_module(char *buf)
Guido van Rossum197346f1997-10-31 18:38:52 +00001578{
Tim Peters0f9431f2001-07-05 03:47:53 +00001579 const size_t save_len = strlen(buf);
Fred Drake4c82b232000-06-30 16:18:57 +00001580 size_t i = save_len;
Tim Peters0f9431f2001-07-05 03:47:53 +00001581 char *pname; /* pointer to start of __init__ */
Guido van Rossum197346f1997-10-31 18:38:52 +00001582 struct stat statbuf;
1583
Tim Peters0f9431f2001-07-05 03:47:53 +00001584/* For calling case_ok(buf, len, namelen, name):
1585 * /a/b/c/d/e/f/g/h/i/j/k/some_long_module_name.py\0
1586 * ^ ^ ^ ^
1587 * |--------------------- buf ---------------------|
1588 * |------------------- len ------------------|
1589 * |------ name -------|
1590 * |----- namelen -----|
1591 */
Guido van Rossum197346f1997-10-31 18:38:52 +00001592 if (save_len + 13 >= MAXPATHLEN)
1593 return 0;
1594 buf[i++] = SEP;
Tim Peters0f9431f2001-07-05 03:47:53 +00001595 pname = buf + i;
1596 strcpy(pname, "__init__.py");
Guido van Rossum197346f1997-10-31 18:38:52 +00001597 if (stat(buf, &statbuf) == 0) {
Tim Peters0f9431f2001-07-05 03:47:53 +00001598 if (case_ok(buf,
1599 save_len + 9, /* len("/__init__") */
1600 8, /* len("__init__") */
1601 pname)) {
1602 buf[save_len] = '\0';
1603 return 1;
1604 }
Guido van Rossum197346f1997-10-31 18:38:52 +00001605 }
Tim Peters0f9431f2001-07-05 03:47:53 +00001606 i += strlen(pname);
1607 strcpy(buf+i, Py_OptimizeFlag ? "o" : "c");
Guido van Rossum197346f1997-10-31 18:38:52 +00001608 if (stat(buf, &statbuf) == 0) {
Tim Peters0f9431f2001-07-05 03:47:53 +00001609 if (case_ok(buf,
1610 save_len + 9, /* len("/__init__") */
1611 8, /* len("__init__") */
1612 pname)) {
1613 buf[save_len] = '\0';
1614 return 1;
1615 }
Guido van Rossum197346f1997-10-31 18:38:52 +00001616 }
1617 buf[save_len] = '\0';
1618 return 0;
1619}
Guido van Rossum48a680c2001-03-02 06:34:14 +00001620
Guido van Rossum197346f1997-10-31 18:38:52 +00001621#endif /* HAVE_STAT */
1622
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001623
Tim Petersdbd9ba62000-07-09 03:09:57 +00001624static int init_builtin(char *); /* Forward */
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001625
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001626/* Load an external module using the default search path and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001627 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001628
Guido van Rossum79f25d91997-04-29 20:08:16 +00001629static PyObject *
Just van Rossum52e14d62002-12-30 22:08:05 +00001630load_module(char *name, FILE *fp, char *buf, int type, PyObject *loader)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001631{
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001632 PyObject *modules;
Guido van Rossum79f25d91997-04-29 20:08:16 +00001633 PyObject *m;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001634 int err;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001635
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001636 /* First check that there's an open file (if we need one) */
1637 switch (type) {
1638 case PY_SOURCE:
1639 case PY_COMPILED:
1640 if (fp == NULL) {
1641 PyErr_Format(PyExc_ValueError,
1642 "file object required for import (type code %d)",
1643 type);
1644 return NULL;
1645 }
1646 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001647
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001648 switch (type) {
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001649
1650 case PY_SOURCE:
1651 m = load_source_module(name, buf, fp);
1652 break;
1653
1654 case PY_COMPILED:
1655 m = load_compiled_module(name, buf, fp);
1656 break;
1657
Guido van Rossum96a8fb71999-12-22 14:09:35 +00001658#ifdef HAVE_DYNAMIC_LOADING
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001659 case C_EXTENSION:
Guido van Rossum79f25d91997-04-29 20:08:16 +00001660 m = _PyImport_LoadDynamicModule(name, buf, fp);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001661 break;
Guido van Rossum96a8fb71999-12-22 14:09:35 +00001662#endif
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001663
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001664 case PKG_DIRECTORY:
1665 m = load_package(name, buf);
1666 break;
1667
1668 case C_BUILTIN:
1669 case PY_FROZEN:
Guido van Rossuma5568d31998-03-05 03:45:08 +00001670 if (buf != NULL && buf[0] != '\0')
1671 name = buf;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001672 if (type == C_BUILTIN)
1673 err = init_builtin(name);
1674 else
1675 err = PyImport_ImportFrozenModule(name);
1676 if (err < 0)
Guido van Rossuma86f77d1997-09-09 18:53:47 +00001677 return NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001678 if (err == 0) {
1679 PyErr_Format(PyExc_ImportError,
1680 "Purported %s module %.200s not found",
1681 type == C_BUILTIN ?
1682 "builtin" : "frozen",
1683 name);
Guido van Rossuma86f77d1997-09-09 18:53:47 +00001684 return NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001685 }
1686 modules = PyImport_GetModuleDict();
1687 m = PyDict_GetItemString(modules, name);
1688 if (m == NULL) {
1689 PyErr_Format(
1690 PyExc_ImportError,
1691 "%s module %.200s not properly initialized",
1692 type == C_BUILTIN ?
1693 "builtin" : "frozen",
1694 name);
Guido van Rossuma86f77d1997-09-09 18:53:47 +00001695 return NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001696 }
1697 Py_INCREF(m);
1698 break;
1699
Just van Rossum52e14d62002-12-30 22:08:05 +00001700 case IMP_HOOK: {
1701 if (loader == NULL) {
1702 PyErr_SetString(PyExc_ImportError,
1703 "import hook without loader");
1704 return NULL;
1705 }
1706 m = PyObject_CallMethod(loader, "load_module", "s", name);
1707 break;
1708 }
1709
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001710 default:
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001711 PyErr_Format(PyExc_ImportError,
1712 "Don't know how to import %.200s (type code %d)",
1713 name, type);
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001714 m = NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001715
1716 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001717
1718 return m;
1719}
1720
1721
1722/* Initialize a built-in module.
Thomas Wouters89f507f2006-12-13 04:49:30 +00001723 Return 1 for success, 0 if the module is not found, and -1 with
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001724 an exception set if the initialization failed. */
Guido van Rossum7f133ed1991-02-19 12:23:57 +00001725
Guido van Rossum7f133ed1991-02-19 12:23:57 +00001726static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001727init_builtin(char *name)
Guido van Rossum7f133ed1991-02-19 12:23:57 +00001728{
Guido van Rossum25ce5661997-08-02 03:10:38 +00001729 struct _inittab *p;
Guido van Rossum25ce5661997-08-02 03:10:38 +00001730
Greg Ward201baee2001-10-04 14:52:06 +00001731 if (_PyImport_FindExtension(name, name) != NULL)
Guido van Rossum25ce5661997-08-02 03:10:38 +00001732 return 1;
1733
Guido van Rossum771c6c81997-10-31 18:37:24 +00001734 for (p = PyImport_Inittab; p->name != NULL; p++) {
Guido van Rossum25ce5661997-08-02 03:10:38 +00001735 if (strcmp(name, p->name) == 0) {
1736 if (p->initfunc == NULL) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001737 PyErr_Format(PyExc_ImportError,
1738 "Cannot re-init internal module %.200s",
1739 name);
Guido van Rossum74e6a111994-08-29 12:54:38 +00001740 return -1;
1741 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00001742 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +00001743 PySys_WriteStderr("import %s # builtin\n", name);
Guido van Rossum25ce5661997-08-02 03:10:38 +00001744 (*p->initfunc)();
Guido van Rossum79f25d91997-04-29 20:08:16 +00001745 if (PyErr_Occurred())
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001746 return -1;
Guido van Rossum25ce5661997-08-02 03:10:38 +00001747 if (_PyImport_FixupExtension(name, name) == NULL)
1748 return -1;
Guido van Rossum7f133ed1991-02-19 12:23:57 +00001749 return 1;
1750 }
1751 }
1752 return 0;
1753}
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001754
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001755
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001756/* Frozen modules */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001757
Guido van Rossumcfd0a221996-06-17 17:06:34 +00001758static struct _frozen *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001759find_frozen(char *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001760{
Guido van Rossumcfd0a221996-06-17 17:06:34 +00001761 struct _frozen *p;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001762
Guido van Rossum79f25d91997-04-29 20:08:16 +00001763 for (p = PyImport_FrozenModules; ; p++) {
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001764 if (p->name == NULL)
1765 return NULL;
1766 if (strcmp(p->name, name) == 0)
1767 break;
1768 }
1769 return p;
1770}
1771
Guido van Rossum79f25d91997-04-29 20:08:16 +00001772static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001773get_frozen_object(char *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001774{
Guido van Rossumcfd0a221996-06-17 17:06:34 +00001775 struct _frozen *p = find_frozen(name);
Guido van Rossuma5568d31998-03-05 03:45:08 +00001776 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001777
1778 if (p == NULL) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001779 PyErr_Format(PyExc_ImportError,
1780 "No such frozen object named %.200s",
1781 name);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001782 return NULL;
1783 }
Guido van Rossum8f4d3312001-10-18 18:54:11 +00001784 if (p->code == NULL) {
1785 PyErr_Format(PyExc_ImportError,
1786 "Excluded frozen object named %.200s",
1787 name);
1788 return NULL;
1789 }
Guido van Rossuma5568d31998-03-05 03:45:08 +00001790 size = p->size;
1791 if (size < 0)
1792 size = -size;
1793 return PyMarshal_ReadObjectFromString((char *)p->code, size);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001794}
1795
1796/* Initialize a frozen module.
1797 Return 1 for succes, 0 if the module is not found, and -1 with
1798 an exception set if the initialization failed.
1799 This function is also used from frozenmain.c */
Guido van Rossum0b344901995-02-07 15:35:27 +00001800
1801int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001802PyImport_ImportFrozenModule(char *name)
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001803{
Guido van Rossumcfd0a221996-06-17 17:06:34 +00001804 struct _frozen *p = find_frozen(name);
Guido van Rossum79f25d91997-04-29 20:08:16 +00001805 PyObject *co;
1806 PyObject *m;
Guido van Rossuma5568d31998-03-05 03:45:08 +00001807 int ispackage;
1808 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001809
1810 if (p == NULL)
1811 return 0;
Guido van Rossum8f4d3312001-10-18 18:54:11 +00001812 if (p->code == NULL) {
1813 PyErr_Format(PyExc_ImportError,
1814 "Excluded frozen object named %.200s",
1815 name);
1816 return -1;
1817 }
Guido van Rossuma5568d31998-03-05 03:45:08 +00001818 size = p->size;
1819 ispackage = (size < 0);
1820 if (ispackage)
1821 size = -size;
Guido van Rossum79f25d91997-04-29 20:08:16 +00001822 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +00001823 PySys_WriteStderr("import %s # frozen%s\n",
Guido van Rossuma5568d31998-03-05 03:45:08 +00001824 name, ispackage ? " package" : "");
1825 co = PyMarshal_ReadObjectFromString((char *)p->code, size);
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001826 if (co == NULL)
1827 return -1;
Guido van Rossum79f25d91997-04-29 20:08:16 +00001828 if (!PyCode_Check(co)) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001829 PyErr_Format(PyExc_TypeError,
1830 "frozen object %.200s is not a code object",
1831 name);
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001832 goto err_return;
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001833 }
Guido van Rossuma5568d31998-03-05 03:45:08 +00001834 if (ispackage) {
1835 /* Set __path__ to the package name */
1836 PyObject *d, *s;
1837 int err;
1838 m = PyImport_AddModule(name);
1839 if (m == NULL)
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001840 goto err_return;
Guido van Rossuma5568d31998-03-05 03:45:08 +00001841 d = PyModule_GetDict(m);
Martin v. Löwis5b222132007-06-10 09:51:05 +00001842 s = PyUnicode_InternFromString(name);
Guido van Rossuma5568d31998-03-05 03:45:08 +00001843 if (s == NULL)
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001844 goto err_return;
Guido van Rossuma5568d31998-03-05 03:45:08 +00001845 err = PyDict_SetItemString(d, "__path__", s);
1846 Py_DECREF(s);
1847 if (err != 0)
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001848 goto err_return;
Guido van Rossuma5568d31998-03-05 03:45:08 +00001849 }
Guido van Rossume32bf6e1998-02-11 05:53:02 +00001850 m = PyImport_ExecCodeModuleEx(name, co, "<frozen>");
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001851 if (m == NULL)
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001852 goto err_return;
1853 Py_DECREF(co);
Guido van Rossum79f25d91997-04-29 20:08:16 +00001854 Py_DECREF(m);
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001855 return 1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001856err_return:
1857 Py_DECREF(co);
1858 return -1;
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001859}
Guido van Rossum74e6a111994-08-29 12:54:38 +00001860
1861
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001862/* Import a module, either built-in, frozen, or external, and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001863 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum74e6a111994-08-29 12:54:38 +00001864
Guido van Rossum79f25d91997-04-29 20:08:16 +00001865PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001866PyImport_ImportModule(const char *name)
Guido van Rossum74e6a111994-08-29 12:54:38 +00001867{
Marc-André Lemburg3c61c352001-02-09 19:40:15 +00001868 PyObject *pname;
1869 PyObject *result;
1870
Martin v. Löwis5b222132007-06-10 09:51:05 +00001871 pname = PyUnicode_FromString(name);
Neal Norwitza11e4c12003-03-23 14:31:01 +00001872 if (pname == NULL)
1873 return NULL;
Marc-André Lemburg3c61c352001-02-09 19:40:15 +00001874 result = PyImport_Import(pname);
1875 Py_DECREF(pname);
1876 return result;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001877}
1878
Guido van Rossum17fc85f1997-09-06 18:52:03 +00001879/* Forward declarations for helper routines */
Thomas Woutersf7f438b2006-02-28 16:09:29 +00001880static PyObject *get_parent(PyObject *globals, char *buf,
1881 Py_ssize_t *p_buflen, int level);
Tim Petersdbd9ba62000-07-09 03:09:57 +00001882static PyObject *load_next(PyObject *mod, PyObject *altmod,
Martin v. Löwis18e16552006-02-15 17:27:45 +00001883 char **p_name, char *buf, Py_ssize_t *p_buflen);
Tim Petersdbd9ba62000-07-09 03:09:57 +00001884static int mark_miss(char *name);
1885static int ensure_fromlist(PyObject *mod, PyObject *fromlist,
Martin v. Löwis18e16552006-02-15 17:27:45 +00001886 char *buf, Py_ssize_t buflen, int recursive);
Tim Petersdbd9ba62000-07-09 03:09:57 +00001887static PyObject * import_submodule(PyObject *mod, char *name, char *fullname);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00001888
1889/* The Magnum Opus of dotted-name import :-) */
1890
Guido van Rossum75acc9c1998-03-03 22:26:50 +00001891static PyObject *
Thomas Woutersf7f438b2006-02-28 16:09:29 +00001892import_module_level(char *name, PyObject *globals, PyObject *locals,
1893 PyObject *fromlist, int level)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001894{
Guido van Rossum17fc85f1997-09-06 18:52:03 +00001895 char buf[MAXPATHLEN+1];
Martin v. Löwis18e16552006-02-15 17:27:45 +00001896 Py_ssize_t buflen = 0;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00001897 PyObject *parent, *head, *next, *tail;
1898
Thomas Woutersf7f438b2006-02-28 16:09:29 +00001899 parent = get_parent(globals, buf, &buflen, level);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00001900 if (parent == NULL)
1901 return NULL;
1902
1903 head = load_next(parent, Py_None, &name, buf, &buflen);
1904 if (head == NULL)
1905 return NULL;
1906
1907 tail = head;
1908 Py_INCREF(tail);
1909 while (name) {
1910 next = load_next(tail, tail, &name, buf, &buflen);
1911 Py_DECREF(tail);
1912 if (next == NULL) {
1913 Py_DECREF(head);
1914 return NULL;
1915 }
1916 tail = next;
1917 }
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001918 if (tail == Py_None) {
1919 /* If tail is Py_None, both get_parent and load_next found
1920 an empty module name: someone called __import__("") or
1921 doctored faulty bytecode */
1922 Py_DECREF(tail);
1923 Py_DECREF(head);
1924 PyErr_SetString(PyExc_ValueError,
1925 "Empty module name");
1926 return NULL;
1927 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00001928
1929 if (fromlist != NULL) {
1930 if (fromlist == Py_None || !PyObject_IsTrue(fromlist))
1931 fromlist = NULL;
1932 }
1933
1934 if (fromlist == NULL) {
1935 Py_DECREF(tail);
1936 return head;
1937 }
1938
1939 Py_DECREF(head);
Guido van Rossum9905ef91997-09-08 16:07:11 +00001940 if (!ensure_fromlist(tail, fromlist, buf, buflen, 0)) {
Guido van Rossum17fc85f1997-09-06 18:52:03 +00001941 Py_DECREF(tail);
1942 return NULL;
1943 }
1944
1945 return tail;
1946}
1947
Thomas Woutersf7f438b2006-02-28 16:09:29 +00001948/* For DLL compatibility */
1949#undef PyImport_ImportModuleEx
Guido van Rossum75acc9c1998-03-03 22:26:50 +00001950PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001951PyImport_ImportModuleEx(char *name, PyObject *globals, PyObject *locals,
1952 PyObject *fromlist)
Guido van Rossum75acc9c1998-03-03 22:26:50 +00001953{
1954 PyObject *result;
1955 lock_import();
Thomas Woutersf7f438b2006-02-28 16:09:29 +00001956 result = import_module_level(name, globals, locals, fromlist, -1);
1957 if (unlock_import() < 0) {
1958 Py_XDECREF(result);
1959 PyErr_SetString(PyExc_RuntimeError,
1960 "not holding the import lock");
1961 return NULL;
1962 }
1963 return result;
1964}
1965#define PyImport_ImportModuleEx(n, g, l, f) \
1966 PyImport_ImportModuleLevel(n, g, l, f, -1);
1967
1968PyObject *
1969PyImport_ImportModuleLevel(char *name, PyObject *globals, PyObject *locals,
1970 PyObject *fromlist, int level)
1971{
1972 PyObject *result;
1973 lock_import();
1974 result = import_module_level(name, globals, locals, fromlist, level);
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00001975 if (unlock_import() < 0) {
1976 Py_XDECREF(result);
1977 PyErr_SetString(PyExc_RuntimeError,
1978 "not holding the import lock");
1979 return NULL;
1980 }
Guido van Rossum75acc9c1998-03-03 22:26:50 +00001981 return result;
1982}
1983
Fred Drake87590902004-05-28 20:21:36 +00001984/* Return the package that an import is being performed in. If globals comes
1985 from the module foo.bar.bat (not itself a package), this returns the
1986 sys.modules entry for foo.bar. If globals is from a package's __init__.py,
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00001987 the package's entry in sys.modules is returned, as a borrowed reference.
Fred Drake87590902004-05-28 20:21:36 +00001988
1989 The *name* of the returned package is returned in buf, with the length of
1990 the name in *p_buflen.
1991
1992 If globals doesn't come from a package or a module in a package, or a
1993 corresponding entry is not found in sys.modules, Py_None is returned.
1994*/
Guido van Rossum17fc85f1997-09-06 18:52:03 +00001995static PyObject *
Thomas Woutersf7f438b2006-02-28 16:09:29 +00001996get_parent(PyObject *globals, char *buf, Py_ssize_t *p_buflen, int level)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00001997{
1998 static PyObject *namestr = NULL;
1999 static PyObject *pathstr = NULL;
2000 PyObject *modname, *modpath, *modules, *parent;
2001
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002002 if (globals == NULL || !PyDict_Check(globals) || !level)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002003 return Py_None;
2004
2005 if (namestr == NULL) {
Martin v. Löwis5b222132007-06-10 09:51:05 +00002006 namestr = PyUnicode_InternFromString("__name__");
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002007 if (namestr == NULL)
2008 return NULL;
2009 }
2010 if (pathstr == NULL) {
Martin v. Löwis5b222132007-06-10 09:51:05 +00002011 pathstr = PyUnicode_InternFromString("__path__");
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002012 if (pathstr == NULL)
2013 return NULL;
2014 }
2015
2016 *buf = '\0';
2017 *p_buflen = 0;
2018 modname = PyDict_GetItem(globals, namestr);
Neal Norwitz80e7f272007-08-26 06:45:23 +00002019 if (modname == NULL || !PyUnicode_Check(modname))
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002020 return Py_None;
2021
2022 modpath = PyDict_GetItem(globals, pathstr);
2023 if (modpath != NULL) {
Neal Norwitz80e7f272007-08-26 06:45:23 +00002024 Py_ssize_t len = PyUnicode_GET_SIZE(modname);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002025 if (len > MAXPATHLEN) {
2026 PyErr_SetString(PyExc_ValueError,
2027 "Module name too long");
2028 return NULL;
2029 }
Neal Norwitz80e7f272007-08-26 06:45:23 +00002030 strcpy(buf, PyUnicode_AsString(modname));
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002031 }
2032 else {
Neal Norwitz80e7f272007-08-26 06:45:23 +00002033 char *start = PyUnicode_AsString(modname);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002034 char *lastdot = strrchr(start, '.');
Fred Drake4c82b232000-06-30 16:18:57 +00002035 size_t len;
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002036 if (lastdot == NULL && level > 0) {
2037 PyErr_SetString(PyExc_ValueError,
Thomas Wouters89f507f2006-12-13 04:49:30 +00002038 "Attempted relative import in non-package");
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002039 return NULL;
2040 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002041 if (lastdot == NULL)
2042 return Py_None;
2043 len = lastdot - start;
2044 if (len >= MAXPATHLEN) {
2045 PyErr_SetString(PyExc_ValueError,
2046 "Module name too long");
2047 return NULL;
2048 }
2049 strncpy(buf, start, len);
2050 buf[len] = '\0';
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002051 }
2052
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002053 while (--level > 0) {
2054 char *dot = strrchr(buf, '.');
2055 if (dot == NULL) {
2056 PyErr_SetString(PyExc_ValueError,
Thomas Wouters89f507f2006-12-13 04:49:30 +00002057 "Attempted relative import beyond "
2058 "toplevel package");
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002059 return NULL;
2060 }
2061 *dot = '\0';
2062 }
2063 *p_buflen = strlen(buf);
2064
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002065 modules = PyImport_GetModuleDict();
2066 parent = PyDict_GetItemString(modules, buf);
2067 if (parent == NULL)
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002068 PyErr_Format(PyExc_SystemError,
2069 "Parent module '%.200s' not loaded", buf);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002070 return parent;
2071 /* We expect, but can't guarantee, if parent != None, that:
2072 - parent.__name__ == buf
2073 - parent.__dict__ is globals
2074 If this is violated... Who cares? */
2075}
2076
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002077/* altmod is either None or same as mod */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002078static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002079load_next(PyObject *mod, PyObject *altmod, char **p_name, char *buf,
Martin v. Löwis18e16552006-02-15 17:27:45 +00002080 Py_ssize_t *p_buflen)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002081{
2082 char *name = *p_name;
2083 char *dot = strchr(name, '.');
Fred Drake4c82b232000-06-30 16:18:57 +00002084 size_t len;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002085 char *p;
2086 PyObject *result;
2087
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002088 if (strlen(name) == 0) {
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002089 /* completely empty module name should only happen in
2090 'from . import' (or '__import__("")')*/
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002091 Py_INCREF(mod);
2092 *p_name = NULL;
2093 return mod;
2094 }
2095
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002096 if (dot == NULL) {
2097 *p_name = NULL;
2098 len = strlen(name);
2099 }
2100 else {
2101 *p_name = dot+1;
2102 len = dot-name;
2103 }
Guido van Rossum111c20b1998-04-11 17:38:22 +00002104 if (len == 0) {
2105 PyErr_SetString(PyExc_ValueError,
2106 "Empty module name");
2107 return NULL;
2108 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002109
2110 p = buf + *p_buflen;
2111 if (p != buf)
2112 *p++ = '.';
2113 if (p+len-buf >= MAXPATHLEN) {
2114 PyErr_SetString(PyExc_ValueError,
2115 "Module name too long");
2116 return NULL;
2117 }
2118 strncpy(p, name, len);
2119 p[len] = '\0';
2120 *p_buflen = p+len-buf;
2121
2122 result = import_submodule(mod, p, buf);
2123 if (result == Py_None && altmod != mod) {
2124 Py_DECREF(result);
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00002125 /* Here, altmod must be None and mod must not be None */
Guido van Rossum0c819451997-09-07 06:16:57 +00002126 result = import_submodule(altmod, p, p);
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00002127 if (result != NULL && result != Py_None) {
2128 if (mark_miss(buf) != 0) {
2129 Py_DECREF(result);
2130 return NULL;
2131 }
2132 strncpy(buf, name, len);
2133 buf[len] = '\0';
2134 *p_buflen = len;
2135 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002136 }
2137 if (result == NULL)
2138 return NULL;
2139
2140 if (result == Py_None) {
2141 Py_DECREF(result);
2142 PyErr_Format(PyExc_ImportError,
2143 "No module named %.200s", name);
2144 return NULL;
2145 }
2146
2147 return result;
2148}
2149
2150static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002151mark_miss(char *name)
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00002152{
2153 PyObject *modules = PyImport_GetModuleDict();
2154 return PyDict_SetItemString(modules, name, Py_None);
2155}
2156
2157static int
Martin v. Löwis18e16552006-02-15 17:27:45 +00002158ensure_fromlist(PyObject *mod, PyObject *fromlist, char *buf, Py_ssize_t buflen,
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002159 int recursive)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002160{
2161 int i;
2162
2163 if (!PyObject_HasAttrString(mod, "__path__"))
2164 return 1;
2165
2166 for (i = 0; ; i++) {
2167 PyObject *item = PySequence_GetItem(fromlist, i);
2168 int hasit;
2169 if (item == NULL) {
2170 if (PyErr_ExceptionMatches(PyExc_IndexError)) {
2171 PyErr_Clear();
2172 return 1;
2173 }
2174 return 0;
2175 }
Martin v. Löwis5b222132007-06-10 09:51:05 +00002176 if (!PyUnicode_Check(item)) {
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002177 PyErr_SetString(PyExc_TypeError,
Neal Norwitz80e7f272007-08-26 06:45:23 +00002178 "Item in ``from list'' not a string");
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002179 Py_DECREF(item);
2180 return 0;
2181 }
Martin v. Löwis5b222132007-06-10 09:51:05 +00002182 if (PyUnicode_AS_UNICODE(item)[0] == '*') {
Guido van Rossum9905ef91997-09-08 16:07:11 +00002183 PyObject *all;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002184 Py_DECREF(item);
Guido van Rossum9905ef91997-09-08 16:07:11 +00002185 /* See if the package defines __all__ */
2186 if (recursive)
2187 continue; /* Avoid endless recursion */
2188 all = PyObject_GetAttrString(mod, "__all__");
2189 if (all == NULL)
2190 PyErr_Clear();
2191 else {
Martin v. Löwis83969ee2004-03-23 16:28:13 +00002192 int ret = ensure_fromlist(mod, all, buf, buflen, 1);
Guido van Rossum9905ef91997-09-08 16:07:11 +00002193 Py_DECREF(all);
Martin v. Löwis83969ee2004-03-23 16:28:13 +00002194 if (!ret)
2195 return 0;
Guido van Rossum9905ef91997-09-08 16:07:11 +00002196 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002197 continue;
2198 }
2199 hasit = PyObject_HasAttr(mod, item);
2200 if (!hasit) {
Martin v. Löwis5b222132007-06-10 09:51:05 +00002201 PyObject *item8;
2202 char *subname;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002203 PyObject *submod;
2204 char *p;
Martin v. Löwis5b222132007-06-10 09:51:05 +00002205 if (!Py_FileSystemDefaultEncoding) {
2206 item8 = PyUnicode_EncodeASCII(PyUnicode_AsUnicode(item),
2207 PyUnicode_GetSize(item),
Martin v. Löwis427dbff2007-06-12 05:53:00 +00002208 NULL);
Martin v. Löwis5b222132007-06-10 09:51:05 +00002209 } else {
Martin v. Löwis427dbff2007-06-12 05:53:00 +00002210 item8 = PyUnicode_AsEncodedString(item,
2211 Py_FileSystemDefaultEncoding, NULL);
Martin v. Löwis5b222132007-06-10 09:51:05 +00002212 }
2213 if (!item8) {
2214 PyErr_SetString(PyExc_ValueError, "Cannot encode path item");
2215 return 0;
2216 }
2217 subname = PyBytes_AsString(item8);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002218 if (buflen + strlen(subname) >= MAXPATHLEN) {
2219 PyErr_SetString(PyExc_ValueError,
2220 "Module name too long");
2221 Py_DECREF(item);
2222 return 0;
2223 }
2224 p = buf + buflen;
2225 *p++ = '.';
2226 strcpy(p, subname);
2227 submod = import_submodule(mod, subname, buf);
Martin v. Löwis5b222132007-06-10 09:51:05 +00002228 Py_DECREF(item8);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002229 Py_XDECREF(submod);
2230 if (submod == NULL) {
2231 Py_DECREF(item);
2232 return 0;
2233 }
2234 }
2235 Py_DECREF(item);
2236 }
2237
Guido van Rossuma7f2e811997-10-03 15:33:32 +00002238 /* NOTREACHED */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002239}
2240
Neil Schemenauer00b09662003-06-16 21:03:07 +00002241static int
2242add_submodule(PyObject *mod, PyObject *submod, char *fullname, char *subname,
2243 PyObject *modules)
2244{
2245 if (mod == Py_None)
2246 return 1;
2247 /* Irrespective of the success of this load, make a
2248 reference to it in the parent package module. A copy gets
2249 saved in the modules dictionary under the full name, so get a
2250 reference from there, if need be. (The exception is when the
2251 load failed with a SyntaxError -- then there's no trace in
2252 sys.modules. In that case, of course, do nothing extra.) */
2253 if (submod == NULL) {
2254 submod = PyDict_GetItemString(modules, fullname);
2255 if (submod == NULL)
2256 return 1;
2257 }
2258 if (PyModule_Check(mod)) {
2259 /* We can't use setattr here since it can give a
2260 * spurious warning if the submodule name shadows a
2261 * builtin name */
2262 PyObject *dict = PyModule_GetDict(mod);
2263 if (!dict)
2264 return 0;
2265 if (PyDict_SetItemString(dict, subname, submod) < 0)
2266 return 0;
2267 }
2268 else {
2269 if (PyObject_SetAttrString(mod, subname, submod) < 0)
2270 return 0;
2271 }
2272 return 1;
2273}
2274
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002275static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002276import_submodule(PyObject *mod, char *subname, char *fullname)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002277{
Guido van Rossum25ce5661997-08-02 03:10:38 +00002278 PyObject *modules = PyImport_GetModuleDict();
Neil Schemenauer00b09662003-06-16 21:03:07 +00002279 PyObject *m = NULL;
Guido van Rossum74e6a111994-08-29 12:54:38 +00002280
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002281 /* Require:
2282 if mod == None: subname == fullname
2283 else: mod.__name__ + "." + subname == fullname
2284 */
2285
Tim Peters50d8d372001-02-28 05:34:27 +00002286 if ((m = PyDict_GetItemString(modules, fullname)) != NULL) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00002287 Py_INCREF(m);
Guido van Rossum7f9fa971995-01-20 16:53:12 +00002288 }
2289 else {
Just van Rossum52e14d62002-12-30 22:08:05 +00002290 PyObject *path, *loader = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002291 char buf[MAXPATHLEN+1];
2292 struct filedescr *fdp;
2293 FILE *fp = NULL;
2294
Guido van Rossum9c0afe51998-05-19 15:09:05 +00002295 if (mod == Py_None)
2296 path = NULL;
2297 else {
2298 path = PyObject_GetAttrString(mod, "__path__");
2299 if (path == NULL) {
2300 PyErr_Clear();
2301 Py_INCREF(Py_None);
2302 return Py_None;
2303 }
2304 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002305
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002306 buf[0] = '\0';
Just van Rossum52e14d62002-12-30 22:08:05 +00002307 fdp = find_module(fullname, subname, path, buf, MAXPATHLEN+1,
2308 &fp, &loader);
Guido van Rossumb68cd421998-07-01 17:36:26 +00002309 Py_XDECREF(path);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002310 if (fdp == NULL) {
2311 if (!PyErr_ExceptionMatches(PyExc_ImportError))
2312 return NULL;
2313 PyErr_Clear();
2314 Py_INCREF(Py_None);
2315 return Py_None;
2316 }
Just van Rossum52e14d62002-12-30 22:08:05 +00002317 m = load_module(fullname, fp, buf, fdp->type, loader);
2318 Py_XDECREF(loader);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002319 if (fp)
2320 fclose(fp);
Neil Schemenauer00b09662003-06-16 21:03:07 +00002321 if (!add_submodule(mod, m, fullname, subname, modules)) {
2322 Py_XDECREF(m);
2323 m = NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002324 }
Guido van Rossum74e6a111994-08-29 12:54:38 +00002325 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002326
2327 return m;
Guido van Rossum74e6a111994-08-29 12:54:38 +00002328}
2329
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002330
2331/* Re-import a module of any kind and return its module object, WITH
2332 INCREMENTED REFERENCE COUNT */
2333
Guido van Rossum79f25d91997-04-29 20:08:16 +00002334PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002335PyImport_ReloadModule(PyObject *m)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002336{
Guido van Rossumd8faa362007-04-27 19:54:29 +00002337 PyInterpreterState *interp = PyThreadState_Get()->interp;
2338 PyObject *modules_reloading = interp->modules_reloading;
Guido van Rossum25ce5661997-08-02 03:10:38 +00002339 PyObject *modules = PyImport_GetModuleDict();
Guido van Rossumd8faa362007-04-27 19:54:29 +00002340 PyObject *path = NULL, *loader = NULL, *existing_m = NULL;
Guido van Rossum222ef561997-09-06 19:41:09 +00002341 char *name, *subname;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002342 char buf[MAXPATHLEN+1];
2343 struct filedescr *fdp;
2344 FILE *fp = NULL;
Tim Peters1cd70172004-08-02 03:52:12 +00002345 PyObject *newm;
Guido van Rossumd8faa362007-04-27 19:54:29 +00002346
2347 if (modules_reloading == NULL) {
2348 Py_FatalError("PyImport_ReloadModule: "
Guido van Rossume7ba4952007-06-06 23:52:48 +00002349 "no modules_reloading dictionary!");
Guido van Rossumd8faa362007-04-27 19:54:29 +00002350 return NULL;
2351 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002352
Guido van Rossum79f25d91997-04-29 20:08:16 +00002353 if (m == NULL || !PyModule_Check(m)) {
2354 PyErr_SetString(PyExc_TypeError,
2355 "reload() argument must be module");
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002356 return NULL;
2357 }
Neal Norwitz5616c6d2007-08-26 05:32:41 +00002358 name = (char*)PyModule_GetName(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002359 if (name == NULL)
2360 return NULL;
Guido van Rossum25ce5661997-08-02 03:10:38 +00002361 if (m != PyDict_GetItemString(modules, name)) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002362 PyErr_Format(PyExc_ImportError,
2363 "reload(): module %.200s not in sys.modules",
2364 name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002365 return NULL;
2366 }
Guido van Rossumd8faa362007-04-27 19:54:29 +00002367 existing_m = PyDict_GetItemString(modules_reloading, name);
2368 if (existing_m != NULL) {
2369 /* Due to a recursive reload, this module is already
2370 being reloaded. */
2371 Py_INCREF(existing_m);
2372 return existing_m;
2373 }
2374 if (PyDict_SetItemString(modules_reloading, name, m) < 0)
2375 return NULL;
2376
Guido van Rossum222ef561997-09-06 19:41:09 +00002377 subname = strrchr(name, '.');
2378 if (subname == NULL)
2379 subname = name;
2380 else {
2381 PyObject *parentname, *parent;
2382 parentname = PyString_FromStringAndSize(name, (subname-name));
Guido van Rossumd8faa362007-04-27 19:54:29 +00002383 if (parentname == NULL) {
2384 imp_modules_reloading_clear();
Guido van Rossum222ef561997-09-06 19:41:09 +00002385 return NULL;
Guido van Rossumd8faa362007-04-27 19:54:29 +00002386 }
Guido van Rossum222ef561997-09-06 19:41:09 +00002387 parent = PyDict_GetItem(modules, parentname);
2388 if (parent == NULL) {
2389 PyErr_Format(PyExc_ImportError,
2390 "reload(): parent %.200s not in sys.modules",
Georg Brandl0c55f292005-09-14 06:56:20 +00002391 PyString_AS_STRING(parentname));
2392 Py_DECREF(parentname);
Guido van Rossume7ba4952007-06-06 23:52:48 +00002393 imp_modules_reloading_clear();
Guido van Rossum222ef561997-09-06 19:41:09 +00002394 return NULL;
2395 }
Georg Brandl0c55f292005-09-14 06:56:20 +00002396 Py_DECREF(parentname);
Guido van Rossum222ef561997-09-06 19:41:09 +00002397 subname++;
2398 path = PyObject_GetAttrString(parent, "__path__");
2399 if (path == NULL)
2400 PyErr_Clear();
2401 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002402 buf[0] = '\0';
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00002403 fdp = find_module(name, subname, path, buf, MAXPATHLEN+1, &fp, &loader);
Guido van Rossum222ef561997-09-06 19:41:09 +00002404 Py_XDECREF(path);
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00002405
2406 if (fdp == NULL) {
2407 Py_XDECREF(loader);
Guido van Rossumd8faa362007-04-27 19:54:29 +00002408 imp_modules_reloading_clear();
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002409 return NULL;
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00002410 }
2411
2412 newm = load_module(name, fp, buf, fdp->type, loader);
2413 Py_XDECREF(loader);
2414
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002415 if (fp)
2416 fclose(fp);
Tim Peters1cd70172004-08-02 03:52:12 +00002417 if (newm == NULL) {
2418 /* load_module probably removed name from modules because of
2419 * the error. Put back the original module object. We're
2420 * going to return NULL in this case regardless of whether
2421 * replacing name succeeds, so the return value is ignored.
2422 */
2423 PyDict_SetItemString(modules, name, m);
2424 }
Guido van Rossumd8faa362007-04-27 19:54:29 +00002425 imp_modules_reloading_clear();
Tim Peters1cd70172004-08-02 03:52:12 +00002426 return newm;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002427}
2428
2429
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002430/* Higher-level import emulator which emulates the "import" statement
2431 more accurately -- it invokes the __import__() function from the
2432 builtins of the current globals. This means that the import is
2433 done using whatever import hooks are installed in the current
Guido van Rossum6058eb41998-12-21 19:51:00 +00002434 environment, e.g. by "rexec".
2435 A dummy list ["__doc__"] is passed as the 4th argument so that
Neal Norwitz80e7f272007-08-26 06:45:23 +00002436 e.g. PyImport_Import(PyUnicode_FromString("win32com.client.gencache"))
Guido van Rossum6058eb41998-12-21 19:51:00 +00002437 will return <module "gencache"> instead of <module "win32com">. */
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002438
2439PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002440PyImport_Import(PyObject *module_name)
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002441{
2442 static PyObject *silly_list = NULL;
2443 static PyObject *builtins_str = NULL;
2444 static PyObject *import_str = NULL;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002445 PyObject *globals = NULL;
2446 PyObject *import = NULL;
2447 PyObject *builtins = NULL;
2448 PyObject *r = NULL;
2449
2450 /* Initialize constant string objects */
2451 if (silly_list == NULL) {
Martin v. Löwis5b222132007-06-10 09:51:05 +00002452 import_str = PyUnicode_InternFromString("__import__");
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002453 if (import_str == NULL)
2454 return NULL;
Martin v. Löwis5b222132007-06-10 09:51:05 +00002455 builtins_str = PyUnicode_InternFromString("__builtins__");
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002456 if (builtins_str == NULL)
2457 return NULL;
2458 silly_list = Py_BuildValue("[s]", "__doc__");
2459 if (silly_list == NULL)
2460 return NULL;
2461 }
2462
2463 /* Get the builtins from current globals */
2464 globals = PyEval_GetGlobals();
Guido van Rossum85cd1d62001-02-20 21:43:24 +00002465 if (globals != NULL) {
Guido van Rossum66468561998-10-22 15:46:50 +00002466 Py_INCREF(globals);
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002467 builtins = PyObject_GetItem(globals, builtins_str);
2468 if (builtins == NULL)
2469 goto err;
2470 }
2471 else {
2472 /* No globals -- use standard builtins, and fake globals */
2473 PyErr_Clear();
2474
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002475 builtins = PyImport_ImportModuleLevel("__builtin__",
2476 NULL, NULL, NULL, 0);
Guido van Rossum85cd1d62001-02-20 21:43:24 +00002477 if (builtins == NULL)
2478 return NULL;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002479 globals = Py_BuildValue("{OO}", builtins_str, builtins);
2480 if (globals == NULL)
2481 goto err;
2482 }
2483
2484 /* Get the __import__ function from the builtins */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002485 if (PyDict_Check(builtins)) {
Fred Drakea76ba6e2001-03-06 06:31:15 +00002486 import = PyObject_GetItem(builtins, import_str);
Tim Peters6d6c1a32001-08-02 04:15:00 +00002487 if (import == NULL)
2488 PyErr_SetObject(PyExc_KeyError, import_str);
2489 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002490 else
Fred Drakea76ba6e2001-03-06 06:31:15 +00002491 import = PyObject_GetAttr(builtins, import_str);
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002492 if (import == NULL)
2493 goto err;
2494
Guido van Rossumd8faa362007-04-27 19:54:29 +00002495 /* Call the __import__ function with the proper argument list */
Thomas Wouters477c8d52006-05-27 19:21:47 +00002496 r = PyObject_CallFunctionObjArgs(import, module_name, globals,
2497 globals, silly_list, NULL);
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002498
2499 err:
2500 Py_XDECREF(globals);
2501 Py_XDECREF(builtins);
2502 Py_XDECREF(import);
Tim Peters50d8d372001-02-28 05:34:27 +00002503
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002504 return r;
2505}
2506
2507
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002508/* Module 'imp' provides Python access to the primitives used for
2509 importing modules.
2510*/
2511
Guido van Rossum79f25d91997-04-29 20:08:16 +00002512static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +00002513imp_get_magic(PyObject *self, PyObject *noargs)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002514{
2515 char buf[4];
2516
Guido van Rossum96774c12000-05-01 20:19:08 +00002517 buf[0] = (char) ((pyc_magic >> 0) & 0xff);
2518 buf[1] = (char) ((pyc_magic >> 8) & 0xff);
2519 buf[2] = (char) ((pyc_magic >> 16) & 0xff);
2520 buf[3] = (char) ((pyc_magic >> 24) & 0xff);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002521
Guido van Rossumad8d3002007-08-03 18:40:49 +00002522 return PyBytes_FromStringAndSize(buf, 4);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002523}
2524
Guido van Rossum79f25d91997-04-29 20:08:16 +00002525static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +00002526imp_get_suffixes(PyObject *self, PyObject *noargs)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002527{
Guido van Rossum79f25d91997-04-29 20:08:16 +00002528 PyObject *list;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002529 struct filedescr *fdp;
2530
Guido van Rossum79f25d91997-04-29 20:08:16 +00002531 list = PyList_New(0);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002532 if (list == NULL)
2533 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002534 for (fdp = _PyImport_Filetab; fdp->suffix != NULL; fdp++) {
2535 PyObject *item = Py_BuildValue("ssi",
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002536 fdp->suffix, fdp->mode, fdp->type);
2537 if (item == NULL) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00002538 Py_DECREF(list);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002539 return NULL;
2540 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002541 if (PyList_Append(list, item) < 0) {
2542 Py_DECREF(list);
2543 Py_DECREF(item);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002544 return NULL;
2545 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002546 Py_DECREF(item);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002547 }
2548 return list;
2549}
2550
Guido van Rossum79f25d91997-04-29 20:08:16 +00002551static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002552call_find_module(char *name, PyObject *path)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002553{
Tim Petersdbd9ba62000-07-09 03:09:57 +00002554 extern int fclose(FILE *);
Guido van Rossum79f25d91997-04-29 20:08:16 +00002555 PyObject *fob, *ret;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002556 struct filedescr *fdp;
2557 char pathname[MAXPATHLEN+1];
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002558 FILE *fp = NULL;
2559
2560 pathname[0] = '\0';
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002561 if (path == Py_None)
2562 path = NULL;
Just van Rossum52e14d62002-12-30 22:08:05 +00002563 fdp = find_module(NULL, name, path, pathname, MAXPATHLEN+1, &fp, NULL);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002564 if (fdp == NULL)
2565 return NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002566 if (fp != NULL) {
2567 fob = PyFile_FromFile(fp, pathname, fdp->mode, fclose);
2568 if (fob == NULL) {
2569 fclose(fp);
2570 return NULL;
2571 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002572 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002573 else {
2574 fob = Py_None;
2575 Py_INCREF(fob);
Tim Peters50d8d372001-02-28 05:34:27 +00002576 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002577 ret = Py_BuildValue("Os(ssi)",
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002578 fob, pathname, fdp->suffix, fdp->mode, fdp->type);
Guido van Rossum79f25d91997-04-29 20:08:16 +00002579 Py_DECREF(fob);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002580 return ret;
2581}
2582
Guido van Rossum79f25d91997-04-29 20:08:16 +00002583static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002584imp_find_module(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002585{
2586 char *name;
2587 PyObject *path = NULL;
Guido van Rossum43713e52000-02-29 13:59:29 +00002588 if (!PyArg_ParseTuple(args, "s|O:find_module", &name, &path))
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002589 return NULL;
2590 return call_find_module(name, path);
2591}
2592
2593static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002594imp_init_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002595{
2596 char *name;
2597 int ret;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002598 PyObject *m;
Guido van Rossum43713e52000-02-29 13:59:29 +00002599 if (!PyArg_ParseTuple(args, "s:init_builtin", &name))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002600 return NULL;
2601 ret = init_builtin(name);
2602 if (ret < 0)
2603 return NULL;
2604 if (ret == 0) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00002605 Py_INCREF(Py_None);
2606 return Py_None;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002607 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002608 m = PyImport_AddModule(name);
2609 Py_XINCREF(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002610 return m;
2611}
2612
Guido van Rossum79f25d91997-04-29 20:08:16 +00002613static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002614imp_init_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002615{
2616 char *name;
2617 int ret;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002618 PyObject *m;
Guido van Rossum43713e52000-02-29 13:59:29 +00002619 if (!PyArg_ParseTuple(args, "s:init_frozen", &name))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002620 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002621 ret = PyImport_ImportFrozenModule(name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002622 if (ret < 0)
2623 return NULL;
2624 if (ret == 0) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00002625 Py_INCREF(Py_None);
2626 return Py_None;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002627 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002628 m = PyImport_AddModule(name);
2629 Py_XINCREF(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002630 return m;
2631}
2632
Guido van Rossum79f25d91997-04-29 20:08:16 +00002633static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002634imp_get_frozen_object(PyObject *self, PyObject *args)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002635{
2636 char *name;
Jack Jansen95ffa231995-10-03 14:38:41 +00002637
Guido van Rossum43713e52000-02-29 13:59:29 +00002638 if (!PyArg_ParseTuple(args, "s:get_frozen_object", &name))
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002639 return NULL;
2640 return get_frozen_object(name);
2641}
2642
Guido van Rossum79f25d91997-04-29 20:08:16 +00002643static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002644imp_is_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002645{
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002646 char *name;
Guido van Rossum43713e52000-02-29 13:59:29 +00002647 if (!PyArg_ParseTuple(args, "s:is_builtin", &name))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002648 return NULL;
Guido van Rossum50ee94f2002-04-09 18:00:58 +00002649 return PyInt_FromLong(is_builtin(name));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002650}
2651
Guido van Rossum79f25d91997-04-29 20:08:16 +00002652static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002653imp_is_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002654{
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002655 char *name;
Guido van Rossum323bf5e1998-06-24 03:54:06 +00002656 struct _frozen *p;
Guido van Rossum43713e52000-02-29 13:59:29 +00002657 if (!PyArg_ParseTuple(args, "s:is_frozen", &name))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002658 return NULL;
Guido van Rossum323bf5e1998-06-24 03:54:06 +00002659 p = find_frozen(name);
Guido van Rossumb8bff3f2002-04-07 06:34:38 +00002660 return PyBool_FromLong((long) (p == NULL ? 0 : p->size));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002661}
2662
2663static FILE *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002664get_file(char *pathname, PyObject *fob, char *mode)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002665{
2666 FILE *fp;
Guido van Rossumda5b8f22007-06-12 23:30:11 +00002667 if (mode[0] == 'U')
2668 mode = "r" PY_STDIOTEXTMODE;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002669 if (fob == NULL) {
2670 fp = fopen(pathname, mode);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002671 }
2672 else {
Guido van Rossumda5b8f22007-06-12 23:30:11 +00002673 int fd = PyObject_AsFileDescriptor(fob);
2674 if (fd == -1)
2675 return NULL;
2676 /* XXX This will leak a FILE struct. Fix this!!!!
2677 (But it doesn't leak a file descrioptor!) */
2678 fp = fdopen(fd, mode);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002679 }
Guido van Rossumda5b8f22007-06-12 23:30:11 +00002680 if (fp == NULL)
2681 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002682 return fp;
2683}
2684
Guido van Rossum79f25d91997-04-29 20:08:16 +00002685static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002686imp_load_compiled(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002687{
2688 char *name;
2689 char *pathname;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002690 PyObject *fob = NULL;
2691 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002692 FILE *fp;
Guido van Rossumda5b8f22007-06-12 23:30:11 +00002693 if (!PyArg_ParseTuple(args, "ss|O:load_compiled",
2694 &name, &pathname, &fob))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002695 return NULL;
2696 fp = get_file(pathname, fob, "rb");
2697 if (fp == NULL)
2698 return NULL;
2699 m = load_compiled_module(name, pathname, fp);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002700 if (fob == NULL)
2701 fclose(fp);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002702 return m;
2703}
2704
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002705#ifdef HAVE_DYNAMIC_LOADING
2706
Guido van Rossum79f25d91997-04-29 20:08:16 +00002707static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002708imp_load_dynamic(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002709{
2710 char *name;
2711 char *pathname;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002712 PyObject *fob = NULL;
2713 PyObject *m;
Guido van Rossum7faeab31995-07-07 22:50:36 +00002714 FILE *fp = NULL;
Guido van Rossumda5b8f22007-06-12 23:30:11 +00002715 if (!PyArg_ParseTuple(args, "ss|O:load_dynamic",
2716 &name, &pathname, &fob))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002717 return NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002718 if (fob) {
Guido van Rossum7faeab31995-07-07 22:50:36 +00002719 fp = get_file(pathname, fob, "r");
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002720 if (fp == NULL)
2721 return NULL;
2722 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002723 m = _PyImport_LoadDynamicModule(name, pathname, fp);
Guido van Rossum7faeab31995-07-07 22:50:36 +00002724 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002725}
2726
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002727#endif /* HAVE_DYNAMIC_LOADING */
2728
Guido van Rossum79f25d91997-04-29 20:08:16 +00002729static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002730imp_load_source(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002731{
2732 char *name;
2733 char *pathname;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002734 PyObject *fob = NULL;
2735 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002736 FILE *fp;
Guido van Rossumda5b8f22007-06-12 23:30:11 +00002737 if (!PyArg_ParseTuple(args, "ss|O:load_source",
2738 &name, &pathname, &fob))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002739 return NULL;
2740 fp = get_file(pathname, fob, "r");
2741 if (fp == NULL)
2742 return NULL;
2743 m = load_source_module(name, pathname, fp);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002744 if (fob == NULL)
2745 fclose(fp);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002746 return m;
2747}
2748
Guido van Rossum79f25d91997-04-29 20:08:16 +00002749static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002750imp_load_module(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002751{
2752 char *name;
2753 PyObject *fob;
2754 char *pathname;
2755 char *suffix; /* Unused */
2756 char *mode;
2757 int type;
2758 FILE *fp;
2759
Guido van Rossum43713e52000-02-29 13:59:29 +00002760 if (!PyArg_ParseTuple(args, "sOs(ssi):load_module",
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002761 &name, &fob, &pathname,
2762 &suffix, &mode, &type))
2763 return NULL;
Guido van Rossum5e2c5fa2002-05-30 17:33:07 +00002764 if (*mode) {
2765 /* Mode must start with 'r' or 'U' and must not contain '+'.
2766 Implicit in this test is the assumption that the mode
2767 may contain other modifiers like 'b' or 't'. */
2768
2769 if (!(*mode == 'r' || *mode == 'U') || strchr(mode, '+')) {
Jeremy Hylton4ae6fae2002-05-30 17:15:25 +00002770 PyErr_Format(PyExc_ValueError,
2771 "invalid file open mode %.200s", mode);
2772 return NULL;
Guido van Rossum5e2c5fa2002-05-30 17:33:07 +00002773 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002774 }
2775 if (fob == Py_None)
2776 fp = NULL;
2777 else {
Guido van Rossumda5b8f22007-06-12 23:30:11 +00002778 fp = get_file(NULL, fob, mode);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002779 if (fp == NULL)
2780 return NULL;
2781 }
Just van Rossum52e14d62002-12-30 22:08:05 +00002782 return load_module(name, fp, pathname, type, NULL);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002783}
2784
2785static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002786imp_load_package(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002787{
2788 char *name;
2789 char *pathname;
Guido van Rossum43713e52000-02-29 13:59:29 +00002790 if (!PyArg_ParseTuple(args, "ss:load_package", &name, &pathname))
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002791 return NULL;
2792 return load_package(name, pathname);
2793}
2794
2795static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002796imp_new_module(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002797{
2798 char *name;
Guido van Rossum43713e52000-02-29 13:59:29 +00002799 if (!PyArg_ParseTuple(args, "s:new_module", &name))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002800 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002801 return PyModule_New(name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002802}
2803
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002804/* Doc strings */
2805
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002806PyDoc_STRVAR(doc_imp,
2807"This module provides the components needed to build your own\n\
2808__import__ function. Undocumented functions are obsolete.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002809
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002810PyDoc_STRVAR(doc_find_module,
2811"find_module(name, [path]) -> (file, filename, (suffix, mode, type))\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002812Search for a module. If path is omitted or None, search for a\n\
2813built-in, frozen or special module and continue search in sys.path.\n\
2814The module name cannot contain '.'; to search for a submodule of a\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002815package, pass the submodule name and the package's __path__.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002816
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002817PyDoc_STRVAR(doc_load_module,
2818"load_module(name, file, filename, (suffix, mode, type)) -> module\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002819Load a module, given information returned by find_module().\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002820The module name must include the full package name, if any.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002821
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002822PyDoc_STRVAR(doc_get_magic,
2823"get_magic() -> string\n\
2824Return the magic number for .pyc or .pyo files.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002825
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002826PyDoc_STRVAR(doc_get_suffixes,
2827"get_suffixes() -> [(suffix, mode, type), ...]\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002828Return a list of (suffix, mode, type) tuples describing the files\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002829that find_module() looks for.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002830
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002831PyDoc_STRVAR(doc_new_module,
2832"new_module(name) -> module\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002833Create a new module. Do not enter it in sys.modules.\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002834The module name must include the full package name, if any.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002835
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002836PyDoc_STRVAR(doc_lock_held,
Tim Petersa7c65092004-08-01 23:26:05 +00002837"lock_held() -> boolean\n\
2838Return True if the import lock is currently held, else False.\n\
2839On platforms without threads, return False.");
Tim Peters69232342001-08-30 05:16:13 +00002840
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00002841PyDoc_STRVAR(doc_acquire_lock,
2842"acquire_lock() -> None\n\
Neal Norwitz2294c0d2003-02-12 23:02:21 +00002843Acquires the interpreter's import lock for the current thread.\n\
2844This lock should be used by import hooks to ensure thread-safety\n\
2845when importing modules.\n\
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00002846On platforms without threads, this function does nothing.");
2847
2848PyDoc_STRVAR(doc_release_lock,
2849"release_lock() -> None\n\
2850Release the interpreter's import lock.\n\
2851On platforms without threads, this function does nothing.");
2852
Guido van Rossum79f25d91997-04-29 20:08:16 +00002853static PyMethodDef imp_methods[] = {
Neal Norwitz08ea61a2003-02-17 18:18:00 +00002854 {"find_module", imp_find_module, METH_VARARGS, doc_find_module},
2855 {"get_magic", imp_get_magic, METH_NOARGS, doc_get_magic},
2856 {"get_suffixes", imp_get_suffixes, METH_NOARGS, doc_get_suffixes},
2857 {"load_module", imp_load_module, METH_VARARGS, doc_load_module},
2858 {"new_module", imp_new_module, METH_VARARGS, doc_new_module},
2859 {"lock_held", imp_lock_held, METH_NOARGS, doc_lock_held},
2860 {"acquire_lock", imp_acquire_lock, METH_NOARGS, doc_acquire_lock},
2861 {"release_lock", imp_release_lock, METH_NOARGS, doc_release_lock},
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002862 /* The rest are obsolete */
Neal Norwitz031829d2002-03-31 14:37:44 +00002863 {"get_frozen_object", imp_get_frozen_object, METH_VARARGS},
2864 {"init_builtin", imp_init_builtin, METH_VARARGS},
2865 {"init_frozen", imp_init_frozen, METH_VARARGS},
2866 {"is_builtin", imp_is_builtin, METH_VARARGS},
2867 {"is_frozen", imp_is_frozen, METH_VARARGS},
2868 {"load_compiled", imp_load_compiled, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002869#ifdef HAVE_DYNAMIC_LOADING
Neal Norwitz031829d2002-03-31 14:37:44 +00002870 {"load_dynamic", imp_load_dynamic, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002871#endif
Neal Norwitz031829d2002-03-31 14:37:44 +00002872 {"load_package", imp_load_package, METH_VARARGS},
Neal Norwitz031829d2002-03-31 14:37:44 +00002873 {"load_source", imp_load_source, METH_VARARGS},
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002874 {NULL, NULL} /* sentinel */
2875};
2876
Guido van Rossum1a8791e1998-08-04 22:46:29 +00002877static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002878setint(PyObject *d, char *name, int value)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002879{
2880 PyObject *v;
2881 int err;
2882
2883 v = PyInt_FromLong((long)value);
2884 err = PyDict_SetItemString(d, name, v);
2885 Py_XDECREF(v);
2886 return err;
2887}
2888
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002889typedef struct {
2890 PyObject_HEAD
2891} NullImporter;
2892
2893static int
2894NullImporter_init(NullImporter *self, PyObject *args, PyObject *kwds)
2895{
2896 char *path;
2897
2898 if (!_PyArg_NoKeywords("NullImporter()", kwds))
2899 return -1;
2900
2901 if (!PyArg_ParseTuple(args, "s:NullImporter",
2902 &path))
2903 return -1;
2904
2905 if (strlen(path) == 0) {
2906 PyErr_SetString(PyExc_ImportError, "empty pathname");
2907 return -1;
2908 } else {
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002909 struct stat statbuf;
2910 int rv;
2911
2912 rv = stat(path, &statbuf);
2913 if (rv == 0) {
2914 /* it exists */
2915 if (S_ISDIR(statbuf.st_mode)) {
2916 /* it's a directory */
2917 PyErr_SetString(PyExc_ImportError,
2918 "existing directory");
2919 return -1;
2920 }
2921 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002922 }
2923 return 0;
2924}
2925
2926static PyObject *
2927NullImporter_find_module(NullImporter *self, PyObject *args)
2928{
2929 Py_RETURN_NONE;
2930}
2931
2932static PyMethodDef NullImporter_methods[] = {
2933 {"find_module", (PyCFunction)NullImporter_find_module, METH_VARARGS,
2934 "Always return None"
2935 },
2936 {NULL} /* Sentinel */
2937};
2938
2939
2940static PyTypeObject NullImporterType = {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00002941 PyVarObject_HEAD_INIT(NULL, 0)
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002942 "imp.NullImporter", /*tp_name*/
2943 sizeof(NullImporter), /*tp_basicsize*/
2944 0, /*tp_itemsize*/
2945 0, /*tp_dealloc*/
2946 0, /*tp_print*/
2947 0, /*tp_getattr*/
2948 0, /*tp_setattr*/
2949 0, /*tp_compare*/
2950 0, /*tp_repr*/
2951 0, /*tp_as_number*/
2952 0, /*tp_as_sequence*/
2953 0, /*tp_as_mapping*/
2954 0, /*tp_hash */
2955 0, /*tp_call*/
2956 0, /*tp_str*/
2957 0, /*tp_getattro*/
2958 0, /*tp_setattro*/
2959 0, /*tp_as_buffer*/
2960 Py_TPFLAGS_DEFAULT, /*tp_flags*/
2961 "Null importer object", /* tp_doc */
2962 0, /* tp_traverse */
2963 0, /* tp_clear */
2964 0, /* tp_richcompare */
2965 0, /* tp_weaklistoffset */
2966 0, /* tp_iter */
2967 0, /* tp_iternext */
2968 NullImporter_methods, /* tp_methods */
2969 0, /* tp_members */
2970 0, /* tp_getset */
2971 0, /* tp_base */
2972 0, /* tp_dict */
2973 0, /* tp_descr_get */
2974 0, /* tp_descr_set */
2975 0, /* tp_dictoffset */
2976 (initproc)NullImporter_init, /* tp_init */
2977 0, /* tp_alloc */
2978 PyType_GenericNew /* tp_new */
2979};
2980
2981
Jason Tishler6bc06ec2003-09-04 11:59:50 +00002982PyMODINIT_FUNC
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002983initimp(void)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002984{
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002985 PyObject *m, *d;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002986
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002987 if (PyType_Ready(&NullImporterType) < 0)
2988 goto failure;
2989
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002990 m = Py_InitModule4("imp", imp_methods, doc_imp,
2991 NULL, PYTHON_API_VERSION);
Neal Norwitz1ac754f2006-01-19 06:09:39 +00002992 if (m == NULL)
2993 goto failure;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002994 d = PyModule_GetDict(m);
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00002995 if (d == NULL)
2996 goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002997
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002998 if (setint(d, "SEARCH_ERROR", SEARCH_ERROR) < 0) goto failure;
2999 if (setint(d, "PY_SOURCE", PY_SOURCE) < 0) goto failure;
3000 if (setint(d, "PY_COMPILED", PY_COMPILED) < 0) goto failure;
3001 if (setint(d, "C_EXTENSION", C_EXTENSION) < 0) goto failure;
3002 if (setint(d, "PY_RESOURCE", PY_RESOURCE) < 0) goto failure;
3003 if (setint(d, "PKG_DIRECTORY", PKG_DIRECTORY) < 0) goto failure;
3004 if (setint(d, "C_BUILTIN", C_BUILTIN) < 0) goto failure;
3005 if (setint(d, "PY_FROZEN", PY_FROZEN) < 0) goto failure;
Guido van Rossum0f84a341998-08-06 13:36:01 +00003006 if (setint(d, "PY_CODERESOURCE", PY_CODERESOURCE) < 0) goto failure;
Just van Rossum52e14d62002-12-30 22:08:05 +00003007 if (setint(d, "IMP_HOOK", IMP_HOOK) < 0) goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003008
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003009 Py_INCREF(&NullImporterType);
3010 PyModule_AddObject(m, "NullImporter", (PyObject *)&NullImporterType);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003011 failure:
3012 ;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003013}
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003014
3015
Guido van Rossumb18618d2000-05-03 23:44:39 +00003016/* API for embedding applications that want to add their own entries
3017 to the table of built-in modules. This should normally be called
3018 *before* Py_Initialize(). When the table resize fails, -1 is
3019 returned and the existing table is unchanged.
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003020
3021 After a similar function by Just van Rossum. */
3022
3023int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003024PyImport_ExtendInittab(struct _inittab *newtab)
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003025{
3026 static struct _inittab *our_copy = NULL;
3027 struct _inittab *p;
3028 int i, n;
3029
3030 /* Count the number of entries in both tables */
3031 for (n = 0; newtab[n].name != NULL; n++)
3032 ;
3033 if (n == 0)
3034 return 0; /* Nothing to do */
3035 for (i = 0; PyImport_Inittab[i].name != NULL; i++)
3036 ;
3037
3038 /* Allocate new memory for the combined table */
Guido van Rossumb18618d2000-05-03 23:44:39 +00003039 p = our_copy;
3040 PyMem_RESIZE(p, struct _inittab, i+n+1);
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003041 if (p == NULL)
3042 return -1;
3043
3044 /* Copy the tables into the new memory */
3045 if (our_copy != PyImport_Inittab)
3046 memcpy(p, PyImport_Inittab, (i+1) * sizeof(struct _inittab));
3047 PyImport_Inittab = our_copy = p;
3048 memcpy(p+i, newtab, (n+1) * sizeof(struct _inittab));
3049
3050 return 0;
3051}
3052
3053/* Shorthand to add a single entry given a name and a function */
3054
3055int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003056PyImport_AppendInittab(char *name, void (*initfunc)(void))
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003057{
3058 struct _inittab newtab[2];
3059
3060 memset(newtab, '\0', sizeof newtab);
3061
3062 newtab[0].name = name;
3063 newtab[0].initfunc = initfunc;
3064
3065 return PyImport_ExtendInittab(newtab);
3066}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00003067
3068#ifdef __cplusplus
3069}
3070#endif