blob: c2f42e995b885913f5ce23bc010af5600661d8f9 [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
Martin v. Löwis85bcc662007-09-04 09:18:06 +0000812 mod = PyParser_ASTFromFile(fp, pathname, NULL,
813 Py_file_input, 0, 0, 0,
Neal Norwitzadb69fc2005-12-17 20:54:49 +0000814 NULL, arena);
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000815 if (mod) {
Neal Norwitzadb69fc2005-12-17 20:54:49 +0000816 co = PyAST_Compile(mod, pathname, NULL, arena);
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000817 }
Thomas Wouters89f507f2006-12-13 04:49:30 +0000818 PyArena_Free(arena);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000819 return co;
820}
821
822
Guido van Rossum55a83382000-09-20 20:31:38 +0000823/* Helper to open a bytecode file for writing in exclusive mode */
824
825static FILE *
826open_exclusive(char *filename)
827{
828#if defined(O_EXCL)&&defined(O_CREAT)&&defined(O_WRONLY)&&defined(O_TRUNC)
829 /* Use O_EXCL to avoid a race condition when another process tries to
830 write the same file. When that happens, our open() call fails,
831 which is just fine (since it's only a cache).
832 XXX If the file exists and is writable but the directory is not
833 writable, the file will never be written. Oh well.
834 */
835 int fd;
836 (void) unlink(filename);
Tim Peters42c83af2000-09-29 04:03:10 +0000837 fd = open(filename, O_EXCL|O_CREAT|O_WRONLY|O_TRUNC
838#ifdef O_BINARY
839 |O_BINARY /* necessary for Windows */
840#endif
Martin v. Löwis79acb9e2002-12-06 12:48:53 +0000841#ifdef __VMS
Martin v. Löwis18e16552006-02-15 17:27:45 +0000842 , 0666, "ctxt=bin", "shr=nil"
Martin v. Löwis79acb9e2002-12-06 12:48:53 +0000843#else
Martin v. Löwis18e16552006-02-15 17:27:45 +0000844 , 0666
Martin v. Löwis79acb9e2002-12-06 12:48:53 +0000845#endif
Martin v. Löwis18e16552006-02-15 17:27:45 +0000846 );
Guido van Rossum55a83382000-09-20 20:31:38 +0000847 if (fd < 0)
848 return NULL;
849 return fdopen(fd, "wb");
850#else
851 /* Best we can do -- on Windows this can't happen anyway */
852 return fopen(filename, "wb");
853#endif
854}
855
856
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000857/* Write a compiled module to a file, placing the time of last
858 modification of its source into the header.
859 Errors are ignored, if a write error occurs an attempt is made to
860 remove the file. */
861
862static void
Martin v. Löwis18e16552006-02-15 17:27:45 +0000863write_compiled_module(PyCodeObject *co, char *cpathname, time_t mtime)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000864{
865 FILE *fp;
866
Guido van Rossum55a83382000-09-20 20:31:38 +0000867 fp = open_exclusive(cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000868 if (fp == NULL) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000869 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000870 PySys_WriteStderr(
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000871 "# can't create %s\n", cpathname);
872 return;
873 }
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000874 PyMarshal_WriteLongToFile(pyc_magic, fp, Py_MARSHAL_VERSION);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000875 /* First write a 0 for mtime */
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000876 PyMarshal_WriteLongToFile(0L, fp, Py_MARSHAL_VERSION);
877 PyMarshal_WriteObjectToFile((PyObject *)co, fp, Py_MARSHAL_VERSION);
Armin Rigo01ab2792004-03-26 15:09:27 +0000878 if (fflush(fp) != 0 || ferror(fp)) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000879 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000880 PySys_WriteStderr("# can't write %s\n", cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000881 /* Don't keep partial file */
882 fclose(fp);
883 (void) unlink(cpathname);
884 return;
885 }
886 /* Now write the true mtime */
887 fseek(fp, 4L, 0);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000888 assert(mtime < LONG_MAX);
Martin v. Löwis725507b2006-03-07 12:08:51 +0000889 PyMarshal_WriteLongToFile((long)mtime, fp, Py_MARSHAL_VERSION);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000890 fflush(fp);
891 fclose(fp);
Guido van Rossum79f25d91997-04-29 20:08:16 +0000892 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000893 PySys_WriteStderr("# wrote %s\n", cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000894}
895
896
897/* Load a source module from a given file and return its module
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000898 object WITH INCREMENTED REFERENCE COUNT. If there's a matching
899 byte-compiled file, use that instead. */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000900
Guido van Rossum79f25d91997-04-29 20:08:16 +0000901static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000902load_source_module(char *name, char *pathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000903{
Fred Drake4c82b232000-06-30 16:18:57 +0000904 time_t mtime;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000905 FILE *fpc;
906 char buf[MAXPATHLEN+1];
907 char *cpathname;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000908 PyCodeObject *co;
909 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000910
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000911 mtime = PyOS_GetLastModificationTime(pathname, fp);
Neal Norwitz708e51a2005-10-03 04:48:15 +0000912 if (mtime == (time_t)(-1)) {
913 PyErr_Format(PyExc_RuntimeError,
914 "unable to get modification time from '%s'",
915 pathname);
Fred Drake4c82b232000-06-30 16:18:57 +0000916 return NULL;
Neal Norwitz708e51a2005-10-03 04:48:15 +0000917 }
Fred Drake4c82b232000-06-30 16:18:57 +0000918#if SIZEOF_TIME_T > 4
919 /* Python's .pyc timestamp handling presumes that the timestamp fits
920 in 4 bytes. This will be fine until sometime in the year 2038,
921 when a 4-byte signed time_t will overflow.
922 */
923 if (mtime >> 32) {
924 PyErr_SetString(PyExc_OverflowError,
Fred Drakec63d3e92001-03-01 06:33:32 +0000925 "modification time overflows a 4 byte field");
Fred Drake4c82b232000-06-30 16:18:57 +0000926 return NULL;
927 }
928#endif
Tim Peters36515e22001-11-18 04:06:29 +0000929 cpathname = make_compiled_pathname(pathname, buf,
Jeremy Hylton37832f02001-04-13 17:50:20 +0000930 (size_t)MAXPATHLEN + 1);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000931 if (cpathname != NULL &&
932 (fpc = check_compiled_module(pathname, mtime, cpathname))) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000933 co = read_compiled_module(cpathname, fpc);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000934 fclose(fpc);
935 if (co == NULL)
936 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000937 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000938 PySys_WriteStderr("import %s # precompiled from %s\n",
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000939 name, cpathname);
Guido van Rossumafd3dae1998-08-25 18:44:34 +0000940 pathname = cpathname;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000941 }
942 else {
943 co = parse_source_module(pathname, fp);
944 if (co == NULL)
945 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000946 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000947 PySys_WriteStderr("import %s # from %s\n",
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000948 name, pathname);
Thomas Wouters00ee7ba2006-08-21 19:07:27 +0000949 if (cpathname)
950 write_compiled_module(co, cpathname, mtime);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000951 }
Guido van Rossumafd3dae1998-08-25 18:44:34 +0000952 m = PyImport_ExecCodeModuleEx(name, (PyObject *)co, pathname);
Guido van Rossum79f25d91997-04-29 20:08:16 +0000953 Py_DECREF(co);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000954
955 return m;
956}
957
958
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000959/* Forward */
Just van Rossum52e14d62002-12-30 22:08:05 +0000960static PyObject *load_module(char *, FILE *, char *, int, PyObject *);
961static struct filedescr *find_module(char *, char *, PyObject *,
962 char *, size_t, FILE **, PyObject **);
Tim Petersdbd9ba62000-07-09 03:09:57 +0000963static struct _frozen *find_frozen(char *name);
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000964
965/* Load a package and return its module object WITH INCREMENTED
966 REFERENCE COUNT */
967
968static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000969load_package(char *name, char *pathname)
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000970{
Tim Peters1cd70172004-08-02 03:52:12 +0000971 PyObject *m, *d;
972 PyObject *file = NULL;
973 PyObject *path = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000974 int err;
975 char buf[MAXPATHLEN+1];
976 FILE *fp = NULL;
977 struct filedescr *fdp;
978
979 m = PyImport_AddModule(name);
980 if (m == NULL)
981 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +0000982 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000983 PySys_WriteStderr("import %s # directory %s\n",
Guido van Rossum17fc85f1997-09-06 18:52:03 +0000984 name, pathname);
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000985 d = PyModule_GetDict(m);
986 file = PyString_FromString(pathname);
987 if (file == NULL)
Tim Peters1cd70172004-08-02 03:52:12 +0000988 goto error;
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000989 path = Py_BuildValue("[O]", file);
Tim Peters1cd70172004-08-02 03:52:12 +0000990 if (path == NULL)
991 goto error;
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000992 err = PyDict_SetItemString(d, "__file__", file);
993 if (err == 0)
994 err = PyDict_SetItemString(d, "__path__", path);
Tim Peters1cd70172004-08-02 03:52:12 +0000995 if (err != 0)
996 goto error;
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000997 buf[0] = '\0';
Just van Rossum52e14d62002-12-30 22:08:05 +0000998 fdp = find_module(name, "__init__", path, buf, sizeof(buf), &fp, NULL);
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000999 if (fdp == NULL) {
1000 if (PyErr_ExceptionMatches(PyExc_ImportError)) {
1001 PyErr_Clear();
Thomas Heller25653242004-06-07 15:04:10 +00001002 Py_INCREF(m);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001003 }
1004 else
1005 m = NULL;
1006 goto cleanup;
1007 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001008 m = load_module(name, fp, buf, fdp->type, NULL);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001009 if (fp != NULL)
1010 fclose(fp);
Tim Peters1cd70172004-08-02 03:52:12 +00001011 goto cleanup;
1012
1013 error:
1014 m = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001015 cleanup:
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001016 Py_XDECREF(path);
1017 Py_XDECREF(file);
1018 return m;
1019}
1020
1021
1022/* Helper to test for built-in module */
1023
1024static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001025is_builtin(char *name)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001026{
1027 int i;
Guido van Rossum771c6c81997-10-31 18:37:24 +00001028 for (i = 0; PyImport_Inittab[i].name != NULL; i++) {
1029 if (strcmp(name, PyImport_Inittab[i].name) == 0) {
1030 if (PyImport_Inittab[i].initfunc == NULL)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001031 return -1;
1032 else
1033 return 1;
1034 }
1035 }
1036 return 0;
1037}
1038
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001039
Just van Rossum52e14d62002-12-30 22:08:05 +00001040/* Return an importer object for a sys.path/pkg.__path__ item 'p',
1041 possibly by fetching it from the path_importer_cache dict. If it
Thomas Wouters89f507f2006-12-13 04:49:30 +00001042 wasn't yet cached, traverse path_hooks until a hook is found
Just van Rossum52e14d62002-12-30 22:08:05 +00001043 that can handle the path item. Return None if no hook could;
1044 this tells our caller it should fall back to the builtin
1045 import mechanism. Cache the result in path_importer_cache.
1046 Returns a borrowed reference. */
1047
1048static PyObject *
1049get_path_importer(PyObject *path_importer_cache, PyObject *path_hooks,
1050 PyObject *p)
1051{
1052 PyObject *importer;
Martin v. Löwis725507b2006-03-07 12:08:51 +00001053 Py_ssize_t j, nhooks;
Just van Rossum52e14d62002-12-30 22:08:05 +00001054
1055 /* These conditions are the caller's responsibility: */
1056 assert(PyList_Check(path_hooks));
1057 assert(PyDict_Check(path_importer_cache));
1058
1059 nhooks = PyList_Size(path_hooks);
1060 if (nhooks < 0)
1061 return NULL; /* Shouldn't happen */
1062
1063 importer = PyDict_GetItem(path_importer_cache, p);
1064 if (importer != NULL)
1065 return importer;
1066
1067 /* set path_importer_cache[p] to None to avoid recursion */
1068 if (PyDict_SetItem(path_importer_cache, p, Py_None) != 0)
1069 return NULL;
1070
1071 for (j = 0; j < nhooks; j++) {
1072 PyObject *hook = PyList_GetItem(path_hooks, j);
1073 if (hook == NULL)
1074 return NULL;
Thomas Wouters477c8d52006-05-27 19:21:47 +00001075 importer = PyObject_CallFunctionObjArgs(hook, p, NULL);
Just van Rossum52e14d62002-12-30 22:08:05 +00001076 if (importer != NULL)
1077 break;
1078
1079 if (!PyErr_ExceptionMatches(PyExc_ImportError)) {
1080 return NULL;
1081 }
1082 PyErr_Clear();
1083 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001084 if (importer == NULL) {
1085 importer = PyObject_CallFunctionObjArgs(
1086 (PyObject *)&NullImporterType, p, NULL
1087 );
1088 if (importer == NULL) {
1089 if (PyErr_ExceptionMatches(PyExc_ImportError)) {
1090 PyErr_Clear();
1091 return Py_None;
1092 }
1093 }
1094 }
1095 if (importer != NULL) {
Just van Rossum52e14d62002-12-30 22:08:05 +00001096 int err = PyDict_SetItem(path_importer_cache, p, importer);
1097 Py_DECREF(importer);
1098 if (err != 0)
1099 return NULL;
1100 }
1101 return importer;
1102}
1103
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001104/* Search the path (default sys.path) for a module. Return the
1105 corresponding filedescr struct, and (via return arguments) the
1106 pathname and an open file. Return NULL if the module is not found. */
1107
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001108#ifdef MS_COREDLL
Thomas Woutersb4bd21c2000-07-22 23:38:01 +00001109extern FILE *PyWin_FindRegisteredModule(const char *, struct filedescr **,
Martin v. Löwis18e16552006-02-15 17:27:45 +00001110 char *, Py_ssize_t);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001111#endif
1112
Martin v. Löwis18e16552006-02-15 17:27:45 +00001113static int case_ok(char *, Py_ssize_t, Py_ssize_t, char *);
Tim Petersdbd9ba62000-07-09 03:09:57 +00001114static int find_init_module(char *); /* Forward */
Just van Rossum52e14d62002-12-30 22:08:05 +00001115static struct filedescr importhookdescr = {"", "", IMP_HOOK};
Guido van Rossum197346f1997-10-31 18:38:52 +00001116
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001117static struct filedescr *
Just van Rossum52e14d62002-12-30 22:08:05 +00001118find_module(char *fullname, char *subname, PyObject *path, char *buf,
1119 size_t buflen, FILE **p_fp, PyObject **p_loader)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001120{
Martin v. Löwis725507b2006-03-07 12:08:51 +00001121 Py_ssize_t i, npath;
Fred Drake4c82b232000-06-30 16:18:57 +00001122 size_t len, namelen;
Guido van Rossum80bb9651996-12-05 23:27:02 +00001123 struct filedescr *fdp = NULL;
Jack Jansenc88da1f2002-05-28 10:58:19 +00001124 char *filemode;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001125 FILE *fp = NULL;
Just van Rossum52e14d62002-12-30 22:08:05 +00001126 PyObject *path_hooks, *path_importer_cache;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001127 struct stat statbuf;
Guido van Rossuma5568d31998-03-05 03:45:08 +00001128 static struct filedescr fd_frozen = {"", "", PY_FROZEN};
1129 static struct filedescr fd_builtin = {"", "", C_BUILTIN};
1130 static struct filedescr fd_package = {"", "", PKG_DIRECTORY};
Guido van Rossum0506a431998-08-11 15:07:39 +00001131 char name[MAXPATHLEN+1];
Andrew MacIntyred9400542002-02-26 11:41:34 +00001132#if defined(PYOS_OS2)
1133 size_t saved_len;
1134 size_t saved_namelen;
1135 char *saved_buf = NULL;
1136#endif
Just van Rossum52e14d62002-12-30 22:08:05 +00001137 if (p_loader != NULL)
1138 *p_loader = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001139
Just van Rossum52e14d62002-12-30 22:08:05 +00001140 if (strlen(subname) > MAXPATHLEN) {
Guido van Rossum8f4d3312001-10-18 18:54:11 +00001141 PyErr_SetString(PyExc_OverflowError,
1142 "module name is too long");
Fred Drake4c82b232000-06-30 16:18:57 +00001143 return NULL;
1144 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001145 strcpy(name, subname);
1146
1147 /* sys.meta_path import hook */
1148 if (p_loader != NULL) {
1149 PyObject *meta_path;
1150
1151 meta_path = PySys_GetObject("meta_path");
1152 if (meta_path == NULL || !PyList_Check(meta_path)) {
1153 PyErr_SetString(PyExc_ImportError,
1154 "sys.meta_path must be a list of "
1155 "import hooks");
1156 return NULL;
1157 }
1158 Py_INCREF(meta_path); /* zap guard */
1159 npath = PyList_Size(meta_path);
1160 for (i = 0; i < npath; i++) {
1161 PyObject *loader;
1162 PyObject *hook = PyList_GetItem(meta_path, i);
1163 loader = PyObject_CallMethod(hook, "find_module",
1164 "sO", fullname,
1165 path != NULL ?
1166 path : Py_None);
1167 if (loader == NULL) {
1168 Py_DECREF(meta_path);
1169 return NULL; /* true error */
1170 }
1171 if (loader != Py_None) {
1172 /* a loader was found */
1173 *p_loader = loader;
1174 Py_DECREF(meta_path);
1175 return &importhookdescr;
1176 }
1177 Py_DECREF(loader);
1178 }
1179 Py_DECREF(meta_path);
1180 }
Guido van Rossum0506a431998-08-11 15:07:39 +00001181
Guido van Rossum13d77992007-07-23 03:16:50 +00001182 if (path != NULL && PyUnicode_Check(path)) {
Guido van Rossum8f4d3312001-10-18 18:54:11 +00001183 /* The only type of submodule allowed inside a "frozen"
1184 package are other frozen modules or packages. */
Guido van Rossum13d77992007-07-23 03:16:50 +00001185 char *p = PyUnicode_AsString(path);
1186 if (strlen(p) + 1 + strlen(name) >= (size_t)buflen) {
Guido van Rossum0506a431998-08-11 15:07:39 +00001187 PyErr_SetString(PyExc_ImportError,
1188 "full frozen module name too long");
1189 return NULL;
1190 }
Guido van Rossum13d77992007-07-23 03:16:50 +00001191 strcpy(buf, p);
Guido van Rossum0506a431998-08-11 15:07:39 +00001192 strcat(buf, ".");
1193 strcat(buf, name);
1194 strcpy(name, buf);
Guido van Rossum8f4d3312001-10-18 18:54:11 +00001195 if (find_frozen(name) != NULL) {
1196 strcpy(buf, name);
1197 return &fd_frozen;
1198 }
1199 PyErr_Format(PyExc_ImportError,
1200 "No frozen submodule named %.200s", name);
1201 return NULL;
Guido van Rossum0506a431998-08-11 15:07:39 +00001202 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001203 if (path == NULL) {
1204 if (is_builtin(name)) {
Guido van Rossuma5568d31998-03-05 03:45:08 +00001205 strcpy(buf, name);
1206 return &fd_builtin;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001207 }
Greg Ward201baee2001-10-04 14:52:06 +00001208 if ((find_frozen(name)) != NULL) {
Guido van Rossuma5568d31998-03-05 03:45:08 +00001209 strcpy(buf, name);
1210 return &fd_frozen;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001211 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001212
Guido van Rossumac279101996-08-22 23:10:58 +00001213#ifdef MS_COREDLL
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001214 fp = PyWin_FindRegisteredModule(name, &fdp, buf, buflen);
1215 if (fp != NULL) {
1216 *p_fp = fp;
1217 return fdp;
1218 }
Guido van Rossuma5a3db71996-04-09 02:39:59 +00001219#endif
Guido van Rossuma5568d31998-03-05 03:45:08 +00001220 path = PySys_GetObject("path");
1221 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00001222 if (path == NULL || !PyList_Check(path)) {
1223 PyErr_SetString(PyExc_ImportError,
Guido van Rossuma5568d31998-03-05 03:45:08 +00001224 "sys.path must be a list of directory names");
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001225 return NULL;
1226 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001227
1228 path_hooks = PySys_GetObject("path_hooks");
1229 if (path_hooks == NULL || !PyList_Check(path_hooks)) {
1230 PyErr_SetString(PyExc_ImportError,
1231 "sys.path_hooks must be a list of "
1232 "import hooks");
1233 return NULL;
1234 }
1235 path_importer_cache = PySys_GetObject("path_importer_cache");
1236 if (path_importer_cache == NULL ||
1237 !PyDict_Check(path_importer_cache)) {
1238 PyErr_SetString(PyExc_ImportError,
1239 "sys.path_importer_cache must be a dict");
1240 return NULL;
1241 }
1242
Guido van Rossum79f25d91997-04-29 20:08:16 +00001243 npath = PyList_Size(path);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001244 namelen = strlen(name);
1245 for (i = 0; i < npath; i++) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00001246 PyObject *v = PyList_GetItem(path, i);
Guido van Rossumf15a29f2007-05-04 00:41:39 +00001247 PyObject *origv = v;
Guido van Rossum6262cc72007-05-09 23:29:27 +00001248 const char *base;
Guido van Rossumf15a29f2007-05-04 00:41:39 +00001249 Py_ssize_t size;
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001250 if (!v)
1251 return NULL;
Guido van Rossuma4b8d1d2007-08-27 15:02:28 +00001252 if (PyUnicode_Check(v)) {
1253 v = _PyUnicode_AsDefaultEncodedString(v, NULL);
1254 if (v == NULL)
1255 return NULL;
1256 }
1257 if (!PyString_Check(v))
1258 continue;
1259 base = PyString_AS_STRING(v);
1260 size = PyString_GET_SIZE(v);
Guido van Rossumf15a29f2007-05-04 00:41:39 +00001261 len = size;
Walter Dörwald3430d702002-06-17 10:43:59 +00001262 if (len + 2 + namelen + MAXSUFFIXSIZE >= buflen) {
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001263 continue; /* Too long */
Walter Dörwald3430d702002-06-17 10:43:59 +00001264 }
Guido van Rossumf15a29f2007-05-04 00:41:39 +00001265 strcpy(buf, base);
Walter Dörwald3430d702002-06-17 10:43:59 +00001266 if (strlen(buf) != len) {
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001267 continue; /* v contains '\0' */
Walter Dörwald3430d702002-06-17 10:43:59 +00001268 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001269
1270 /* sys.path_hooks import hook */
1271 if (p_loader != NULL) {
1272 PyObject *importer;
1273
1274 importer = get_path_importer(path_importer_cache,
Guido van Rossumf15a29f2007-05-04 00:41:39 +00001275 path_hooks, origv);
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001276 if (importer == NULL) {
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001277 return NULL;
Thomas Wouters477c8d52006-05-27 19:21:47 +00001278 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001279 /* Note: importer is a borrowed reference */
1280 if (importer != Py_None) {
Just van Rossum52e14d62002-12-30 22:08:05 +00001281 PyObject *loader;
1282 loader = PyObject_CallMethod(importer,
1283 "find_module",
1284 "s", fullname);
1285 if (loader == NULL)
1286 return NULL; /* error */
1287 if (loader != Py_None) {
1288 /* a loader was found */
1289 *p_loader = loader;
1290 return &importhookdescr;
1291 }
1292 Py_DECREF(loader);
Thomas Wouters477c8d52006-05-27 19:21:47 +00001293 continue;
Just van Rossum52e14d62002-12-30 22:08:05 +00001294 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001295 }
Thomas Wouters477c8d52006-05-27 19:21:47 +00001296 /* no hook was found, use builtin import */
Just van Rossum52e14d62002-12-30 22:08:05 +00001297
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001298 if (len > 0 && buf[len-1] != SEP
1299#ifdef ALTSEP
1300 && buf[len-1] != ALTSEP
1301#endif
1302 )
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001303 buf[len++] = SEP;
Guido van Rossum215c3402000-11-13 17:26:32 +00001304 strcpy(buf+len, name);
1305 len += namelen;
Tim Peters50d8d372001-02-28 05:34:27 +00001306
1307 /* Check for package import (buf holds a directory name,
1308 and there's an __init__ module in that directory */
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001309#ifdef HAVE_STAT
Walter Dörwald3430d702002-06-17 10:43:59 +00001310 if (stat(buf, &statbuf) == 0 && /* it exists */
1311 S_ISDIR(statbuf.st_mode) && /* it's a directory */
Thomas Wouters477c8d52006-05-27 19:21:47 +00001312 case_ok(buf, len, namelen, name)) { /* case matches */
1313 if (find_init_module(buf)) { /* and has __init__.py */
Thomas Wouters477c8d52006-05-27 19:21:47 +00001314 return &fd_package;
1315 }
1316 else {
1317 char warnstr[MAXPATHLEN+80];
1318 sprintf(warnstr, "Not importing directory "
1319 "'%.*s': missing __init__.py",
1320 MAXPATHLEN, buf);
Skip Montanaro46fc3372007-08-12 11:44:53 +00001321 if (PyErr_WarnEx(PyExc_ImportWarning,
1322 warnstr, 1)) {
Thomas Wouters477c8d52006-05-27 19:21:47 +00001323 return NULL;
1324 }
1325 }
Walter Dörwald3430d702002-06-17 10:43:59 +00001326 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001327#endif
Andrew MacIntyred9400542002-02-26 11:41:34 +00001328#if defined(PYOS_OS2)
1329 /* take a snapshot of the module spec for restoration
1330 * after the 8 character DLL hackery
1331 */
1332 saved_buf = strdup(buf);
1333 saved_len = len;
1334 saved_namelen = namelen;
1335#endif /* PYOS_OS2 */
Guido van Rossum79f25d91997-04-29 20:08:16 +00001336 for (fdp = _PyImport_Filetab; fdp->suffix != NULL; fdp++) {
Guido van Rossum04110fb2007-08-24 16:32:05 +00001337#if defined(PYOS_OS2) && defined(HAVE_DYNAMIC_LOADING)
Jeremy Hylton4ae6fae2002-05-30 17:15:25 +00001338 /* OS/2 limits DLLs to 8 character names (w/o
1339 extension)
Andrew MacIntyred9400542002-02-26 11:41:34 +00001340 * so if the name is longer than that and its a
1341 * dynamically loaded module we're going to try,
1342 * truncate the name before trying
1343 */
Just van Rossum52e14d62002-12-30 22:08:05 +00001344 if (strlen(subname) > 8) {
Andrew MacIntyred9400542002-02-26 11:41:34 +00001345 /* is this an attempt to load a C extension? */
Jeremy Hylton4ae6fae2002-05-30 17:15:25 +00001346 const struct filedescr *scan;
1347 scan = _PyImport_DynLoadFiletab;
Andrew MacIntyred9400542002-02-26 11:41:34 +00001348 while (scan->suffix != NULL) {
Jeremy Hylton4ae6fae2002-05-30 17:15:25 +00001349 if (!strcmp(scan->suffix, fdp->suffix))
Andrew MacIntyred9400542002-02-26 11:41:34 +00001350 break;
1351 else
1352 scan++;
1353 }
1354 if (scan->suffix != NULL) {
1355 /* yes, so truncate the name */
1356 namelen = 8;
Just van Rossum52e14d62002-12-30 22:08:05 +00001357 len -= strlen(subname) - namelen;
Andrew MacIntyred9400542002-02-26 11:41:34 +00001358 buf[len] = '\0';
1359 }
1360 }
1361#endif /* PYOS_OS2 */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001362 strcpy(buf+len, fdp->suffix);
Guido van Rossum79f25d91997-04-29 20:08:16 +00001363 if (Py_VerboseFlag > 1)
Guido van Rossum2f3667a1998-10-12 18:23:55 +00001364 PySys_WriteStderr("# trying %s\n", buf);
Jack Jansenc88da1f2002-05-28 10:58:19 +00001365 filemode = fdp->mode;
Tim Peters86c7d2f2004-08-01 23:24:21 +00001366 if (filemode[0] == 'U')
Jeremy Hylton4ae6fae2002-05-30 17:15:25 +00001367 filemode = "r" PY_STDIOTEXTMODE;
Jack Jansenc88da1f2002-05-28 10:58:19 +00001368 fp = fopen(buf, filemode);
Tim Peters50d8d372001-02-28 05:34:27 +00001369 if (fp != NULL) {
1370 if (case_ok(buf, len, namelen, name))
1371 break;
1372 else { /* continue search */
1373 fclose(fp);
1374 fp = NULL;
Barry Warsaw914a0b12001-02-02 19:12:16 +00001375 }
Barry Warsaw914a0b12001-02-02 19:12:16 +00001376 }
Andrew MacIntyred9400542002-02-26 11:41:34 +00001377#if defined(PYOS_OS2)
1378 /* restore the saved snapshot */
1379 strcpy(buf, saved_buf);
1380 len = saved_len;
1381 namelen = saved_namelen;
1382#endif
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001383 }
Andrew MacIntyred9400542002-02-26 11:41:34 +00001384#if defined(PYOS_OS2)
1385 /* don't need/want the module name snapshot anymore */
1386 if (saved_buf)
1387 {
1388 free(saved_buf);
1389 saved_buf = NULL;
1390 }
1391#endif
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001392 if (fp != NULL)
1393 break;
1394 }
1395 if (fp == NULL) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001396 PyErr_Format(PyExc_ImportError,
1397 "No module named %.200s", name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001398 return NULL;
1399 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001400 *p_fp = fp;
1401 return fdp;
1402}
1403
Raymond Hettingerdb29e0f2004-10-07 06:46:25 +00001404/* Helpers for main.c
1405 * Find the source file corresponding to a named module
1406 */
1407struct filedescr *
1408_PyImport_FindModule(const char *name, PyObject *path, char *buf,
1409 size_t buflen, FILE **p_fp, PyObject **p_loader)
1410{
1411 return find_module((char *) name, (char *) name, path,
1412 buf, buflen, p_fp, p_loader);
1413}
1414
1415PyAPI_FUNC(int) _PyImport_IsScript(struct filedescr * fd)
1416{
1417 return fd->type == PY_SOURCE || fd->type == PY_COMPILED;
1418}
1419
Martin v. Löwis18e16552006-02-15 17:27:45 +00001420/* case_ok(char* buf, Py_ssize_t len, Py_ssize_t namelen, char* name)
Tim Petersd1e87a82001-03-01 18:12:00 +00001421 * The arguments here are tricky, best shown by example:
1422 * /a/b/c/d/e/f/g/h/i/j/k/some_long_module_name.py\0
1423 * ^ ^ ^ ^
1424 * |--------------------- buf ---------------------|
1425 * |------------------- len ------------------|
1426 * |------ name -------|
1427 * |----- namelen -----|
1428 * buf is the full path, but len only counts up to (& exclusive of) the
1429 * extension. name is the module name, also exclusive of extension.
1430 *
1431 * We've already done a successful stat() or fopen() on buf, so know that
1432 * there's some match, possibly case-insensitive.
1433 *
Tim Peters50d8d372001-02-28 05:34:27 +00001434 * case_ok() is to return 1 if there's a case-sensitive match for
1435 * name, else 0. case_ok() is also to return 1 if envar PYTHONCASEOK
1436 * exists.
Tim Petersd1e87a82001-03-01 18:12:00 +00001437 *
Tim Peters50d8d372001-02-28 05:34:27 +00001438 * case_ok() is used to implement case-sensitive import semantics even
1439 * on platforms with case-insensitive filesystems. It's trivial to implement
1440 * for case-sensitive filesystems. It's pretty much a cross-platform
1441 * nightmare for systems with case-insensitive filesystems.
1442 */
Guido van Rossum0980bd91998-02-13 17:18:36 +00001443
Tim Peters50d8d372001-02-28 05:34:27 +00001444/* First we may need a pile of platform-specific header files; the sequence
1445 * of #if's here should match the sequence in the body of case_ok().
1446 */
Jason Tishler7961aa62005-05-20 00:56:54 +00001447#if defined(MS_WINDOWS)
Guido van Rossum0980bd91998-02-13 17:18:36 +00001448#include <windows.h>
Guido van Rossum4c3f57c2001-01-10 20:40:46 +00001449
Tim Peters50d8d372001-02-28 05:34:27 +00001450#elif defined(DJGPP)
1451#include <dir.h>
1452
Jason Tishler7961aa62005-05-20 00:56:54 +00001453#elif (defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) && defined(HAVE_DIRENT_H)
Tim Peters430f5d42001-03-01 01:30:56 +00001454#include <sys/types.h>
1455#include <dirent.h>
1456
Andrew MacIntyred9400542002-02-26 11:41:34 +00001457#elif defined(PYOS_OS2)
1458#define INCL_DOS
1459#define INCL_DOSERRORS
1460#define INCL_NOPMAPI
1461#include <os2.h>
Tim Peters50d8d372001-02-28 05:34:27 +00001462#endif
1463
Guido van Rossum0980bd91998-02-13 17:18:36 +00001464static int
Martin v. Löwis18e16552006-02-15 17:27:45 +00001465case_ok(char *buf, Py_ssize_t len, Py_ssize_t namelen, char *name)
Guido van Rossum0980bd91998-02-13 17:18:36 +00001466{
Tim Peters50d8d372001-02-28 05:34:27 +00001467/* Pick a platform-specific implementation; the sequence of #if's here should
1468 * match the sequence just above.
1469 */
1470
Jason Tishler7961aa62005-05-20 00:56:54 +00001471/* MS_WINDOWS */
1472#if defined(MS_WINDOWS)
Guido van Rossum0980bd91998-02-13 17:18:36 +00001473 WIN32_FIND_DATA data;
1474 HANDLE h;
Tim Peters50d8d372001-02-28 05:34:27 +00001475
Neil Schemenauer7d4bb9f2001-07-23 16:30:27 +00001476 if (Py_GETENV("PYTHONCASEOK") != NULL)
Guido van Rossum0980bd91998-02-13 17:18:36 +00001477 return 1;
Tim Peters50d8d372001-02-28 05:34:27 +00001478
Guido van Rossum0980bd91998-02-13 17:18:36 +00001479 h = FindFirstFile(buf, &data);
1480 if (h == INVALID_HANDLE_VALUE) {
1481 PyErr_Format(PyExc_NameError,
1482 "Can't find file for module %.100s\n(filename %.300s)",
1483 name, buf);
1484 return 0;
1485 }
1486 FindClose(h);
Tim Peters50d8d372001-02-28 05:34:27 +00001487 return strncmp(data.cFileName, name, namelen) == 0;
1488
1489/* DJGPP */
1490#elif defined(DJGPP)
1491 struct ffblk ffblk;
1492 int done;
1493
Neil Schemenauer7d4bb9f2001-07-23 16:30:27 +00001494 if (Py_GETENV("PYTHONCASEOK") != NULL)
Guido van Rossum323bf5e1998-06-24 03:54:06 +00001495 return 1;
Tim Peters50d8d372001-02-28 05:34:27 +00001496
1497 done = findfirst(buf, &ffblk, FA_ARCH|FA_RDONLY|FA_HIDDEN|FA_DIREC);
1498 if (done) {
Guido van Rossum0980bd91998-02-13 17:18:36 +00001499 PyErr_Format(PyExc_NameError,
Tim Peters50d8d372001-02-28 05:34:27 +00001500 "Can't find file for module %.100s\n(filename %.300s)",
Guido van Rossum0980bd91998-02-13 17:18:36 +00001501 name, buf);
1502 return 0;
1503 }
Tim Peters50d8d372001-02-28 05:34:27 +00001504 return strncmp(ffblk.ff_name, name, namelen) == 0;
Guido van Rossum0980bd91998-02-13 17:18:36 +00001505
Jason Tishler7961aa62005-05-20 00:56:54 +00001506/* new-fangled macintosh (macosx) or Cygwin */
1507#elif (defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) && defined(HAVE_DIRENT_H)
Tim Peters430f5d42001-03-01 01:30:56 +00001508 DIR *dirp;
1509 struct dirent *dp;
Tim Petersd1e87a82001-03-01 18:12:00 +00001510 char dirname[MAXPATHLEN + 1];
1511 const int dirlen = len - namelen - 1; /* don't want trailing SEP */
Tim Peters430f5d42001-03-01 01:30:56 +00001512
Neil Schemenauer7d4bb9f2001-07-23 16:30:27 +00001513 if (Py_GETENV("PYTHONCASEOK") != NULL)
Tim Petersdbe6ebb2001-03-01 08:47:29 +00001514 return 1;
1515
Tim Petersd1e87a82001-03-01 18:12:00 +00001516 /* Copy the dir component into dirname; substitute "." if empty */
1517 if (dirlen <= 0) {
1518 dirname[0] = '.';
1519 dirname[1] = '\0';
Tim Peters430f5d42001-03-01 01:30:56 +00001520 }
1521 else {
Tim Petersd1e87a82001-03-01 18:12:00 +00001522 assert(dirlen <= MAXPATHLEN);
1523 memcpy(dirname, buf, dirlen);
1524 dirname[dirlen] = '\0';
Tim Peters430f5d42001-03-01 01:30:56 +00001525 }
1526 /* Open the directory and search the entries for an exact match. */
Tim Petersd1e87a82001-03-01 18:12:00 +00001527 dirp = opendir(dirname);
Tim Peters430f5d42001-03-01 01:30:56 +00001528 if (dirp) {
Tim Peters677898a2001-03-02 03:28:03 +00001529 char *nameWithExt = buf + len - namelen;
Tim Peters430f5d42001-03-01 01:30:56 +00001530 while ((dp = readdir(dirp)) != NULL) {
Tim Petersdbe6ebb2001-03-01 08:47:29 +00001531 const int thislen =
Tim Peters430f5d42001-03-01 01:30:56 +00001532#ifdef _DIRENT_HAVE_D_NAMELEN
Tim Petersdbe6ebb2001-03-01 08:47:29 +00001533 dp->d_namlen;
Tim Peters430f5d42001-03-01 01:30:56 +00001534#else
Tim Petersdbe6ebb2001-03-01 08:47:29 +00001535 strlen(dp->d_name);
Tim Peters430f5d42001-03-01 01:30:56 +00001536#endif
Tim Petersd1e87a82001-03-01 18:12:00 +00001537 if (thislen >= namelen &&
Tim Peters677898a2001-03-02 03:28:03 +00001538 strcmp(dp->d_name, nameWithExt) == 0) {
Tim Peters430f5d42001-03-01 01:30:56 +00001539 (void)closedir(dirp);
1540 return 1; /* Found */
1541 }
1542 }
Tim Petersdbe6ebb2001-03-01 08:47:29 +00001543 (void)closedir(dirp);
Tim Peters430f5d42001-03-01 01:30:56 +00001544 }
Tim Peters430f5d42001-03-01 01:30:56 +00001545 return 0 ; /* Not found */
Tim Peters430f5d42001-03-01 01:30:56 +00001546
Andrew MacIntyred9400542002-02-26 11:41:34 +00001547/* OS/2 */
1548#elif defined(PYOS_OS2)
1549 HDIR hdir = 1;
1550 ULONG srchcnt = 1;
1551 FILEFINDBUF3 ffbuf;
1552 APIRET rc;
1553
1554 if (getenv("PYTHONCASEOK") != NULL)
1555 return 1;
1556
1557 rc = DosFindFirst(buf,
1558 &hdir,
1559 FILE_READONLY | FILE_HIDDEN | FILE_SYSTEM | FILE_DIRECTORY,
1560 &ffbuf, sizeof(ffbuf),
1561 &srchcnt,
1562 FIL_STANDARD);
1563 if (rc != NO_ERROR)
1564 return 0;
1565 return strncmp(ffbuf.achName, name, namelen) == 0;
1566
Tim Peters50d8d372001-02-28 05:34:27 +00001567/* assuming it's a case-sensitive filesystem, so there's nothing to do! */
1568#else
Guido van Rossum0980bd91998-02-13 17:18:36 +00001569 return 1;
Guido van Rossum0980bd91998-02-13 17:18:36 +00001570
Guido van Rossum4d1b3b91998-02-13 23:27:59 +00001571#endif
Tim Peters50d8d372001-02-28 05:34:27 +00001572}
Guido van Rossum4d1b3b91998-02-13 23:27:59 +00001573
Guido van Rossum0980bd91998-02-13 17:18:36 +00001574
Guido van Rossum197346f1997-10-31 18:38:52 +00001575#ifdef HAVE_STAT
1576/* Helper to look for __init__.py or __init__.py[co] in potential package */
1577static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001578find_init_module(char *buf)
Guido van Rossum197346f1997-10-31 18:38:52 +00001579{
Tim Peters0f9431f2001-07-05 03:47:53 +00001580 const size_t save_len = strlen(buf);
Fred Drake4c82b232000-06-30 16:18:57 +00001581 size_t i = save_len;
Tim Peters0f9431f2001-07-05 03:47:53 +00001582 char *pname; /* pointer to start of __init__ */
Guido van Rossum197346f1997-10-31 18:38:52 +00001583 struct stat statbuf;
1584
Tim Peters0f9431f2001-07-05 03:47:53 +00001585/* For calling case_ok(buf, len, namelen, name):
1586 * /a/b/c/d/e/f/g/h/i/j/k/some_long_module_name.py\0
1587 * ^ ^ ^ ^
1588 * |--------------------- buf ---------------------|
1589 * |------------------- len ------------------|
1590 * |------ name -------|
1591 * |----- namelen -----|
1592 */
Guido van Rossum197346f1997-10-31 18:38:52 +00001593 if (save_len + 13 >= MAXPATHLEN)
1594 return 0;
1595 buf[i++] = SEP;
Tim Peters0f9431f2001-07-05 03:47:53 +00001596 pname = buf + i;
1597 strcpy(pname, "__init__.py");
Guido van Rossum197346f1997-10-31 18:38:52 +00001598 if (stat(buf, &statbuf) == 0) {
Tim Peters0f9431f2001-07-05 03:47:53 +00001599 if (case_ok(buf,
1600 save_len + 9, /* len("/__init__") */
1601 8, /* len("__init__") */
1602 pname)) {
1603 buf[save_len] = '\0';
1604 return 1;
1605 }
Guido van Rossum197346f1997-10-31 18:38:52 +00001606 }
Tim Peters0f9431f2001-07-05 03:47:53 +00001607 i += strlen(pname);
1608 strcpy(buf+i, Py_OptimizeFlag ? "o" : "c");
Guido van Rossum197346f1997-10-31 18:38:52 +00001609 if (stat(buf, &statbuf) == 0) {
Tim Peters0f9431f2001-07-05 03:47:53 +00001610 if (case_ok(buf,
1611 save_len + 9, /* len("/__init__") */
1612 8, /* len("__init__") */
1613 pname)) {
1614 buf[save_len] = '\0';
1615 return 1;
1616 }
Guido van Rossum197346f1997-10-31 18:38:52 +00001617 }
1618 buf[save_len] = '\0';
1619 return 0;
1620}
Guido van Rossum48a680c2001-03-02 06:34:14 +00001621
Guido van Rossum197346f1997-10-31 18:38:52 +00001622#endif /* HAVE_STAT */
1623
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001624
Tim Petersdbd9ba62000-07-09 03:09:57 +00001625static int init_builtin(char *); /* Forward */
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001626
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001627/* Load an external module using the default search path and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001628 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001629
Guido van Rossum79f25d91997-04-29 20:08:16 +00001630static PyObject *
Just van Rossum52e14d62002-12-30 22:08:05 +00001631load_module(char *name, FILE *fp, char *buf, int type, PyObject *loader)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001632{
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001633 PyObject *modules;
Guido van Rossum79f25d91997-04-29 20:08:16 +00001634 PyObject *m;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001635 int err;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001636
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001637 /* First check that there's an open file (if we need one) */
1638 switch (type) {
1639 case PY_SOURCE:
1640 case PY_COMPILED:
1641 if (fp == NULL) {
1642 PyErr_Format(PyExc_ValueError,
1643 "file object required for import (type code %d)",
1644 type);
1645 return NULL;
1646 }
1647 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001648
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001649 switch (type) {
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001650
1651 case PY_SOURCE:
1652 m = load_source_module(name, buf, fp);
1653 break;
1654
1655 case PY_COMPILED:
1656 m = load_compiled_module(name, buf, fp);
1657 break;
1658
Guido van Rossum96a8fb71999-12-22 14:09:35 +00001659#ifdef HAVE_DYNAMIC_LOADING
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001660 case C_EXTENSION:
Guido van Rossum79f25d91997-04-29 20:08:16 +00001661 m = _PyImport_LoadDynamicModule(name, buf, fp);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001662 break;
Guido van Rossum96a8fb71999-12-22 14:09:35 +00001663#endif
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001664
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001665 case PKG_DIRECTORY:
1666 m = load_package(name, buf);
1667 break;
1668
1669 case C_BUILTIN:
1670 case PY_FROZEN:
Guido van Rossuma5568d31998-03-05 03:45:08 +00001671 if (buf != NULL && buf[0] != '\0')
1672 name = buf;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001673 if (type == C_BUILTIN)
1674 err = init_builtin(name);
1675 else
1676 err = PyImport_ImportFrozenModule(name);
1677 if (err < 0)
Guido van Rossuma86f77d1997-09-09 18:53:47 +00001678 return NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001679 if (err == 0) {
1680 PyErr_Format(PyExc_ImportError,
1681 "Purported %s module %.200s not found",
1682 type == C_BUILTIN ?
1683 "builtin" : "frozen",
1684 name);
Guido van Rossuma86f77d1997-09-09 18:53:47 +00001685 return NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001686 }
1687 modules = PyImport_GetModuleDict();
1688 m = PyDict_GetItemString(modules, name);
1689 if (m == NULL) {
1690 PyErr_Format(
1691 PyExc_ImportError,
1692 "%s module %.200s not properly initialized",
1693 type == C_BUILTIN ?
1694 "builtin" : "frozen",
1695 name);
Guido van Rossuma86f77d1997-09-09 18:53:47 +00001696 return NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001697 }
1698 Py_INCREF(m);
1699 break;
1700
Just van Rossum52e14d62002-12-30 22:08:05 +00001701 case IMP_HOOK: {
1702 if (loader == NULL) {
1703 PyErr_SetString(PyExc_ImportError,
1704 "import hook without loader");
1705 return NULL;
1706 }
1707 m = PyObject_CallMethod(loader, "load_module", "s", name);
1708 break;
1709 }
1710
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001711 default:
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001712 PyErr_Format(PyExc_ImportError,
1713 "Don't know how to import %.200s (type code %d)",
1714 name, type);
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001715 m = NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001716
1717 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001718
1719 return m;
1720}
1721
1722
1723/* Initialize a built-in module.
Thomas Wouters89f507f2006-12-13 04:49:30 +00001724 Return 1 for success, 0 if the module is not found, and -1 with
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001725 an exception set if the initialization failed. */
Guido van Rossum7f133ed1991-02-19 12:23:57 +00001726
Guido van Rossum7f133ed1991-02-19 12:23:57 +00001727static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001728init_builtin(char *name)
Guido van Rossum7f133ed1991-02-19 12:23:57 +00001729{
Guido van Rossum25ce5661997-08-02 03:10:38 +00001730 struct _inittab *p;
Guido van Rossum25ce5661997-08-02 03:10:38 +00001731
Greg Ward201baee2001-10-04 14:52:06 +00001732 if (_PyImport_FindExtension(name, name) != NULL)
Guido van Rossum25ce5661997-08-02 03:10:38 +00001733 return 1;
1734
Guido van Rossum771c6c81997-10-31 18:37:24 +00001735 for (p = PyImport_Inittab; p->name != NULL; p++) {
Guido van Rossum25ce5661997-08-02 03:10:38 +00001736 if (strcmp(name, p->name) == 0) {
1737 if (p->initfunc == NULL) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001738 PyErr_Format(PyExc_ImportError,
1739 "Cannot re-init internal module %.200s",
1740 name);
Guido van Rossum74e6a111994-08-29 12:54:38 +00001741 return -1;
1742 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00001743 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +00001744 PySys_WriteStderr("import %s # builtin\n", name);
Guido van Rossum25ce5661997-08-02 03:10:38 +00001745 (*p->initfunc)();
Guido van Rossum79f25d91997-04-29 20:08:16 +00001746 if (PyErr_Occurred())
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001747 return -1;
Guido van Rossum25ce5661997-08-02 03:10:38 +00001748 if (_PyImport_FixupExtension(name, name) == NULL)
1749 return -1;
Guido van Rossum7f133ed1991-02-19 12:23:57 +00001750 return 1;
1751 }
1752 }
1753 return 0;
1754}
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001755
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001756
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001757/* Frozen modules */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001758
Guido van Rossumcfd0a221996-06-17 17:06:34 +00001759static struct _frozen *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001760find_frozen(char *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001761{
Guido van Rossumcfd0a221996-06-17 17:06:34 +00001762 struct _frozen *p;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001763
Guido van Rossum79f25d91997-04-29 20:08:16 +00001764 for (p = PyImport_FrozenModules; ; p++) {
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001765 if (p->name == NULL)
1766 return NULL;
1767 if (strcmp(p->name, name) == 0)
1768 break;
1769 }
1770 return p;
1771}
1772
Guido van Rossum79f25d91997-04-29 20:08:16 +00001773static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001774get_frozen_object(char *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001775{
Guido van Rossumcfd0a221996-06-17 17:06:34 +00001776 struct _frozen *p = find_frozen(name);
Guido van Rossuma5568d31998-03-05 03:45:08 +00001777 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001778
1779 if (p == NULL) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001780 PyErr_Format(PyExc_ImportError,
1781 "No such frozen object named %.200s",
1782 name);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001783 return NULL;
1784 }
Guido van Rossum8f4d3312001-10-18 18:54:11 +00001785 if (p->code == NULL) {
1786 PyErr_Format(PyExc_ImportError,
1787 "Excluded frozen object named %.200s",
1788 name);
1789 return NULL;
1790 }
Guido van Rossuma5568d31998-03-05 03:45:08 +00001791 size = p->size;
1792 if (size < 0)
1793 size = -size;
1794 return PyMarshal_ReadObjectFromString((char *)p->code, size);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001795}
1796
1797/* Initialize a frozen module.
1798 Return 1 for succes, 0 if the module is not found, and -1 with
1799 an exception set if the initialization failed.
1800 This function is also used from frozenmain.c */
Guido van Rossum0b344901995-02-07 15:35:27 +00001801
1802int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001803PyImport_ImportFrozenModule(char *name)
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001804{
Guido van Rossumcfd0a221996-06-17 17:06:34 +00001805 struct _frozen *p = find_frozen(name);
Guido van Rossum79f25d91997-04-29 20:08:16 +00001806 PyObject *co;
1807 PyObject *m;
Guido van Rossuma5568d31998-03-05 03:45:08 +00001808 int ispackage;
1809 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001810
1811 if (p == NULL)
1812 return 0;
Guido van Rossum8f4d3312001-10-18 18:54:11 +00001813 if (p->code == NULL) {
1814 PyErr_Format(PyExc_ImportError,
1815 "Excluded frozen object named %.200s",
1816 name);
1817 return -1;
1818 }
Guido van Rossuma5568d31998-03-05 03:45:08 +00001819 size = p->size;
1820 ispackage = (size < 0);
1821 if (ispackage)
1822 size = -size;
Guido van Rossum79f25d91997-04-29 20:08:16 +00001823 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +00001824 PySys_WriteStderr("import %s # frozen%s\n",
Guido van Rossuma5568d31998-03-05 03:45:08 +00001825 name, ispackage ? " package" : "");
1826 co = PyMarshal_ReadObjectFromString((char *)p->code, size);
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001827 if (co == NULL)
1828 return -1;
Guido van Rossum79f25d91997-04-29 20:08:16 +00001829 if (!PyCode_Check(co)) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001830 PyErr_Format(PyExc_TypeError,
1831 "frozen object %.200s is not a code object",
1832 name);
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001833 goto err_return;
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001834 }
Guido van Rossuma5568d31998-03-05 03:45:08 +00001835 if (ispackage) {
1836 /* Set __path__ to the package name */
1837 PyObject *d, *s;
1838 int err;
1839 m = PyImport_AddModule(name);
1840 if (m == NULL)
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001841 goto err_return;
Guido van Rossuma5568d31998-03-05 03:45:08 +00001842 d = PyModule_GetDict(m);
Martin v. Löwis5b222132007-06-10 09:51:05 +00001843 s = PyUnicode_InternFromString(name);
Guido van Rossuma5568d31998-03-05 03:45:08 +00001844 if (s == NULL)
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001845 goto err_return;
Guido van Rossuma5568d31998-03-05 03:45:08 +00001846 err = PyDict_SetItemString(d, "__path__", s);
1847 Py_DECREF(s);
1848 if (err != 0)
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001849 goto err_return;
Guido van Rossuma5568d31998-03-05 03:45:08 +00001850 }
Guido van Rossume32bf6e1998-02-11 05:53:02 +00001851 m = PyImport_ExecCodeModuleEx(name, co, "<frozen>");
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001852 if (m == NULL)
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001853 goto err_return;
1854 Py_DECREF(co);
Guido van Rossum79f25d91997-04-29 20:08:16 +00001855 Py_DECREF(m);
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001856 return 1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001857err_return:
1858 Py_DECREF(co);
1859 return -1;
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001860}
Guido van Rossum74e6a111994-08-29 12:54:38 +00001861
1862
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001863/* Import a module, either built-in, frozen, or external, and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001864 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum74e6a111994-08-29 12:54:38 +00001865
Guido van Rossum79f25d91997-04-29 20:08:16 +00001866PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001867PyImport_ImportModule(const char *name)
Guido van Rossum74e6a111994-08-29 12:54:38 +00001868{
Marc-André Lemburg3c61c352001-02-09 19:40:15 +00001869 PyObject *pname;
1870 PyObject *result;
1871
Martin v. Löwis5b222132007-06-10 09:51:05 +00001872 pname = PyUnicode_FromString(name);
Neal Norwitza11e4c12003-03-23 14:31:01 +00001873 if (pname == NULL)
1874 return NULL;
Marc-André Lemburg3c61c352001-02-09 19:40:15 +00001875 result = PyImport_Import(pname);
1876 Py_DECREF(pname);
1877 return result;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001878}
1879
Guido van Rossum17fc85f1997-09-06 18:52:03 +00001880/* Forward declarations for helper routines */
Thomas Woutersf7f438b2006-02-28 16:09:29 +00001881static PyObject *get_parent(PyObject *globals, char *buf,
1882 Py_ssize_t *p_buflen, int level);
Tim Petersdbd9ba62000-07-09 03:09:57 +00001883static PyObject *load_next(PyObject *mod, PyObject *altmod,
Martin v. Löwis18e16552006-02-15 17:27:45 +00001884 char **p_name, char *buf, Py_ssize_t *p_buflen);
Tim Petersdbd9ba62000-07-09 03:09:57 +00001885static int mark_miss(char *name);
1886static int ensure_fromlist(PyObject *mod, PyObject *fromlist,
Martin v. Löwis18e16552006-02-15 17:27:45 +00001887 char *buf, Py_ssize_t buflen, int recursive);
Tim Petersdbd9ba62000-07-09 03:09:57 +00001888static PyObject * import_submodule(PyObject *mod, char *name, char *fullname);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00001889
1890/* The Magnum Opus of dotted-name import :-) */
1891
Guido van Rossum75acc9c1998-03-03 22:26:50 +00001892static PyObject *
Thomas Woutersf7f438b2006-02-28 16:09:29 +00001893import_module_level(char *name, PyObject *globals, PyObject *locals,
1894 PyObject *fromlist, int level)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001895{
Guido van Rossum17fc85f1997-09-06 18:52:03 +00001896 char buf[MAXPATHLEN+1];
Martin v. Löwis18e16552006-02-15 17:27:45 +00001897 Py_ssize_t buflen = 0;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00001898 PyObject *parent, *head, *next, *tail;
1899
Thomas Woutersf7f438b2006-02-28 16:09:29 +00001900 parent = get_parent(globals, buf, &buflen, level);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00001901 if (parent == NULL)
1902 return NULL;
1903
1904 head = load_next(parent, Py_None, &name, buf, &buflen);
1905 if (head == NULL)
1906 return NULL;
1907
1908 tail = head;
1909 Py_INCREF(tail);
1910 while (name) {
1911 next = load_next(tail, tail, &name, buf, &buflen);
1912 Py_DECREF(tail);
1913 if (next == NULL) {
1914 Py_DECREF(head);
1915 return NULL;
1916 }
1917 tail = next;
1918 }
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001919 if (tail == Py_None) {
1920 /* If tail is Py_None, both get_parent and load_next found
1921 an empty module name: someone called __import__("") or
1922 doctored faulty bytecode */
1923 Py_DECREF(tail);
1924 Py_DECREF(head);
1925 PyErr_SetString(PyExc_ValueError,
1926 "Empty module name");
1927 return NULL;
1928 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00001929
1930 if (fromlist != NULL) {
1931 if (fromlist == Py_None || !PyObject_IsTrue(fromlist))
1932 fromlist = NULL;
1933 }
1934
1935 if (fromlist == NULL) {
1936 Py_DECREF(tail);
1937 return head;
1938 }
1939
1940 Py_DECREF(head);
Guido van Rossum9905ef91997-09-08 16:07:11 +00001941 if (!ensure_fromlist(tail, fromlist, buf, buflen, 0)) {
Guido van Rossum17fc85f1997-09-06 18:52:03 +00001942 Py_DECREF(tail);
1943 return NULL;
1944 }
1945
1946 return tail;
1947}
1948
Thomas Woutersf7f438b2006-02-28 16:09:29 +00001949/* For DLL compatibility */
1950#undef PyImport_ImportModuleEx
Guido van Rossum75acc9c1998-03-03 22:26:50 +00001951PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001952PyImport_ImportModuleEx(char *name, PyObject *globals, PyObject *locals,
1953 PyObject *fromlist)
Guido van Rossum75acc9c1998-03-03 22:26:50 +00001954{
1955 PyObject *result;
1956 lock_import();
Thomas Woutersf7f438b2006-02-28 16:09:29 +00001957 result = import_module_level(name, globals, locals, fromlist, -1);
1958 if (unlock_import() < 0) {
1959 Py_XDECREF(result);
1960 PyErr_SetString(PyExc_RuntimeError,
1961 "not holding the import lock");
1962 return NULL;
1963 }
1964 return result;
1965}
1966#define PyImport_ImportModuleEx(n, g, l, f) \
1967 PyImport_ImportModuleLevel(n, g, l, f, -1);
1968
1969PyObject *
1970PyImport_ImportModuleLevel(char *name, PyObject *globals, PyObject *locals,
1971 PyObject *fromlist, int level)
1972{
1973 PyObject *result;
1974 lock_import();
1975 result = import_module_level(name, globals, locals, fromlist, level);
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00001976 if (unlock_import() < 0) {
1977 Py_XDECREF(result);
1978 PyErr_SetString(PyExc_RuntimeError,
1979 "not holding the import lock");
1980 return NULL;
1981 }
Guido van Rossum75acc9c1998-03-03 22:26:50 +00001982 return result;
1983}
1984
Fred Drake87590902004-05-28 20:21:36 +00001985/* Return the package that an import is being performed in. If globals comes
1986 from the module foo.bar.bat (not itself a package), this returns the
1987 sys.modules entry for foo.bar. If globals is from a package's __init__.py,
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00001988 the package's entry in sys.modules is returned, as a borrowed reference.
Fred Drake87590902004-05-28 20:21:36 +00001989
1990 The *name* of the returned package is returned in buf, with the length of
1991 the name in *p_buflen.
1992
1993 If globals doesn't come from a package or a module in a package, or a
1994 corresponding entry is not found in sys.modules, Py_None is returned.
1995*/
Guido van Rossum17fc85f1997-09-06 18:52:03 +00001996static PyObject *
Thomas Woutersf7f438b2006-02-28 16:09:29 +00001997get_parent(PyObject *globals, char *buf, Py_ssize_t *p_buflen, int level)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00001998{
1999 static PyObject *namestr = NULL;
2000 static PyObject *pathstr = NULL;
2001 PyObject *modname, *modpath, *modules, *parent;
2002
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002003 if (globals == NULL || !PyDict_Check(globals) || !level)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002004 return Py_None;
2005
2006 if (namestr == NULL) {
Martin v. Löwis5b222132007-06-10 09:51:05 +00002007 namestr = PyUnicode_InternFromString("__name__");
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002008 if (namestr == NULL)
2009 return NULL;
2010 }
2011 if (pathstr == NULL) {
Martin v. Löwis5b222132007-06-10 09:51:05 +00002012 pathstr = PyUnicode_InternFromString("__path__");
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002013 if (pathstr == NULL)
2014 return NULL;
2015 }
2016
2017 *buf = '\0';
2018 *p_buflen = 0;
2019 modname = PyDict_GetItem(globals, namestr);
Neal Norwitz80e7f272007-08-26 06:45:23 +00002020 if (modname == NULL || !PyUnicode_Check(modname))
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002021 return Py_None;
2022
2023 modpath = PyDict_GetItem(globals, pathstr);
2024 if (modpath != NULL) {
Neal Norwitz80e7f272007-08-26 06:45:23 +00002025 Py_ssize_t len = PyUnicode_GET_SIZE(modname);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002026 if (len > MAXPATHLEN) {
2027 PyErr_SetString(PyExc_ValueError,
2028 "Module name too long");
2029 return NULL;
2030 }
Neal Norwitz80e7f272007-08-26 06:45:23 +00002031 strcpy(buf, PyUnicode_AsString(modname));
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002032 }
2033 else {
Neal Norwitz80e7f272007-08-26 06:45:23 +00002034 char *start = PyUnicode_AsString(modname);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002035 char *lastdot = strrchr(start, '.');
Fred Drake4c82b232000-06-30 16:18:57 +00002036 size_t len;
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002037 if (lastdot == NULL && level > 0) {
2038 PyErr_SetString(PyExc_ValueError,
Thomas Wouters89f507f2006-12-13 04:49:30 +00002039 "Attempted relative import in non-package");
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002040 return NULL;
2041 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002042 if (lastdot == NULL)
2043 return Py_None;
2044 len = lastdot - start;
2045 if (len >= MAXPATHLEN) {
2046 PyErr_SetString(PyExc_ValueError,
2047 "Module name too long");
2048 return NULL;
2049 }
2050 strncpy(buf, start, len);
2051 buf[len] = '\0';
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002052 }
2053
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002054 while (--level > 0) {
2055 char *dot = strrchr(buf, '.');
2056 if (dot == NULL) {
2057 PyErr_SetString(PyExc_ValueError,
Thomas Wouters89f507f2006-12-13 04:49:30 +00002058 "Attempted relative import beyond "
2059 "toplevel package");
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002060 return NULL;
2061 }
2062 *dot = '\0';
2063 }
2064 *p_buflen = strlen(buf);
2065
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002066 modules = PyImport_GetModuleDict();
2067 parent = PyDict_GetItemString(modules, buf);
2068 if (parent == NULL)
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002069 PyErr_Format(PyExc_SystemError,
2070 "Parent module '%.200s' not loaded", buf);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002071 return parent;
2072 /* We expect, but can't guarantee, if parent != None, that:
2073 - parent.__name__ == buf
2074 - parent.__dict__ is globals
2075 If this is violated... Who cares? */
2076}
2077
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002078/* altmod is either None or same as mod */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002079static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002080load_next(PyObject *mod, PyObject *altmod, char **p_name, char *buf,
Martin v. Löwis18e16552006-02-15 17:27:45 +00002081 Py_ssize_t *p_buflen)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002082{
2083 char *name = *p_name;
2084 char *dot = strchr(name, '.');
Fred Drake4c82b232000-06-30 16:18:57 +00002085 size_t len;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002086 char *p;
2087 PyObject *result;
2088
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002089 if (strlen(name) == 0) {
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002090 /* completely empty module name should only happen in
2091 'from . import' (or '__import__("")')*/
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002092 Py_INCREF(mod);
2093 *p_name = NULL;
2094 return mod;
2095 }
2096
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002097 if (dot == NULL) {
2098 *p_name = NULL;
2099 len = strlen(name);
2100 }
2101 else {
2102 *p_name = dot+1;
2103 len = dot-name;
2104 }
Guido van Rossum111c20b1998-04-11 17:38:22 +00002105 if (len == 0) {
2106 PyErr_SetString(PyExc_ValueError,
2107 "Empty module name");
2108 return NULL;
2109 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002110
2111 p = buf + *p_buflen;
2112 if (p != buf)
2113 *p++ = '.';
2114 if (p+len-buf >= MAXPATHLEN) {
2115 PyErr_SetString(PyExc_ValueError,
2116 "Module name too long");
2117 return NULL;
2118 }
2119 strncpy(p, name, len);
2120 p[len] = '\0';
2121 *p_buflen = p+len-buf;
2122
2123 result = import_submodule(mod, p, buf);
2124 if (result == Py_None && altmod != mod) {
2125 Py_DECREF(result);
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00002126 /* Here, altmod must be None and mod must not be None */
Guido van Rossum0c819451997-09-07 06:16:57 +00002127 result = import_submodule(altmod, p, p);
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00002128 if (result != NULL && result != Py_None) {
2129 if (mark_miss(buf) != 0) {
2130 Py_DECREF(result);
2131 return NULL;
2132 }
2133 strncpy(buf, name, len);
2134 buf[len] = '\0';
2135 *p_buflen = len;
2136 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002137 }
2138 if (result == NULL)
2139 return NULL;
2140
2141 if (result == Py_None) {
2142 Py_DECREF(result);
2143 PyErr_Format(PyExc_ImportError,
2144 "No module named %.200s", name);
2145 return NULL;
2146 }
2147
2148 return result;
2149}
2150
2151static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002152mark_miss(char *name)
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00002153{
2154 PyObject *modules = PyImport_GetModuleDict();
2155 return PyDict_SetItemString(modules, name, Py_None);
2156}
2157
2158static int
Martin v. Löwis18e16552006-02-15 17:27:45 +00002159ensure_fromlist(PyObject *mod, PyObject *fromlist, char *buf, Py_ssize_t buflen,
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002160 int recursive)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002161{
2162 int i;
2163
2164 if (!PyObject_HasAttrString(mod, "__path__"))
2165 return 1;
2166
2167 for (i = 0; ; i++) {
2168 PyObject *item = PySequence_GetItem(fromlist, i);
2169 int hasit;
2170 if (item == NULL) {
2171 if (PyErr_ExceptionMatches(PyExc_IndexError)) {
2172 PyErr_Clear();
2173 return 1;
2174 }
2175 return 0;
2176 }
Martin v. Löwis5b222132007-06-10 09:51:05 +00002177 if (!PyUnicode_Check(item)) {
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002178 PyErr_SetString(PyExc_TypeError,
Neal Norwitz80e7f272007-08-26 06:45:23 +00002179 "Item in ``from list'' not a string");
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002180 Py_DECREF(item);
2181 return 0;
2182 }
Martin v. Löwis5b222132007-06-10 09:51:05 +00002183 if (PyUnicode_AS_UNICODE(item)[0] == '*') {
Guido van Rossum9905ef91997-09-08 16:07:11 +00002184 PyObject *all;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002185 Py_DECREF(item);
Guido van Rossum9905ef91997-09-08 16:07:11 +00002186 /* See if the package defines __all__ */
2187 if (recursive)
2188 continue; /* Avoid endless recursion */
2189 all = PyObject_GetAttrString(mod, "__all__");
2190 if (all == NULL)
2191 PyErr_Clear();
2192 else {
Martin v. Löwis83969ee2004-03-23 16:28:13 +00002193 int ret = ensure_fromlist(mod, all, buf, buflen, 1);
Guido van Rossum9905ef91997-09-08 16:07:11 +00002194 Py_DECREF(all);
Martin v. Löwis83969ee2004-03-23 16:28:13 +00002195 if (!ret)
2196 return 0;
Guido van Rossum9905ef91997-09-08 16:07:11 +00002197 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002198 continue;
2199 }
2200 hasit = PyObject_HasAttr(mod, item);
2201 if (!hasit) {
Martin v. Löwis5b222132007-06-10 09:51:05 +00002202 PyObject *item8;
2203 char *subname;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002204 PyObject *submod;
2205 char *p;
Martin v. Löwis5b222132007-06-10 09:51:05 +00002206 if (!Py_FileSystemDefaultEncoding) {
2207 item8 = PyUnicode_EncodeASCII(PyUnicode_AsUnicode(item),
2208 PyUnicode_GetSize(item),
Martin v. Löwis427dbff2007-06-12 05:53:00 +00002209 NULL);
Martin v. Löwis5b222132007-06-10 09:51:05 +00002210 } else {
Martin v. Löwis427dbff2007-06-12 05:53:00 +00002211 item8 = PyUnicode_AsEncodedString(item,
2212 Py_FileSystemDefaultEncoding, NULL);
Martin v. Löwis5b222132007-06-10 09:51:05 +00002213 }
2214 if (!item8) {
2215 PyErr_SetString(PyExc_ValueError, "Cannot encode path item");
2216 return 0;
2217 }
2218 subname = PyBytes_AsString(item8);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002219 if (buflen + strlen(subname) >= MAXPATHLEN) {
2220 PyErr_SetString(PyExc_ValueError,
2221 "Module name too long");
2222 Py_DECREF(item);
2223 return 0;
2224 }
2225 p = buf + buflen;
2226 *p++ = '.';
2227 strcpy(p, subname);
2228 submod = import_submodule(mod, subname, buf);
Martin v. Löwis5b222132007-06-10 09:51:05 +00002229 Py_DECREF(item8);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002230 Py_XDECREF(submod);
2231 if (submod == NULL) {
2232 Py_DECREF(item);
2233 return 0;
2234 }
2235 }
2236 Py_DECREF(item);
2237 }
2238
Guido van Rossuma7f2e811997-10-03 15:33:32 +00002239 /* NOTREACHED */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002240}
2241
Neil Schemenauer00b09662003-06-16 21:03:07 +00002242static int
2243add_submodule(PyObject *mod, PyObject *submod, char *fullname, char *subname,
2244 PyObject *modules)
2245{
2246 if (mod == Py_None)
2247 return 1;
2248 /* Irrespective of the success of this load, make a
2249 reference to it in the parent package module. A copy gets
2250 saved in the modules dictionary under the full name, so get a
2251 reference from there, if need be. (The exception is when the
2252 load failed with a SyntaxError -- then there's no trace in
2253 sys.modules. In that case, of course, do nothing extra.) */
2254 if (submod == NULL) {
2255 submod = PyDict_GetItemString(modules, fullname);
2256 if (submod == NULL)
2257 return 1;
2258 }
2259 if (PyModule_Check(mod)) {
2260 /* We can't use setattr here since it can give a
2261 * spurious warning if the submodule name shadows a
2262 * builtin name */
2263 PyObject *dict = PyModule_GetDict(mod);
2264 if (!dict)
2265 return 0;
2266 if (PyDict_SetItemString(dict, subname, submod) < 0)
2267 return 0;
2268 }
2269 else {
2270 if (PyObject_SetAttrString(mod, subname, submod) < 0)
2271 return 0;
2272 }
2273 return 1;
2274}
2275
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002276static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002277import_submodule(PyObject *mod, char *subname, char *fullname)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002278{
Guido van Rossum25ce5661997-08-02 03:10:38 +00002279 PyObject *modules = PyImport_GetModuleDict();
Neil Schemenauer00b09662003-06-16 21:03:07 +00002280 PyObject *m = NULL;
Guido van Rossum74e6a111994-08-29 12:54:38 +00002281
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002282 /* Require:
2283 if mod == None: subname == fullname
2284 else: mod.__name__ + "." + subname == fullname
2285 */
2286
Tim Peters50d8d372001-02-28 05:34:27 +00002287 if ((m = PyDict_GetItemString(modules, fullname)) != NULL) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00002288 Py_INCREF(m);
Guido van Rossum7f9fa971995-01-20 16:53:12 +00002289 }
2290 else {
Just van Rossum52e14d62002-12-30 22:08:05 +00002291 PyObject *path, *loader = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002292 char buf[MAXPATHLEN+1];
2293 struct filedescr *fdp;
2294 FILE *fp = NULL;
2295
Guido van Rossum9c0afe51998-05-19 15:09:05 +00002296 if (mod == Py_None)
2297 path = NULL;
2298 else {
2299 path = PyObject_GetAttrString(mod, "__path__");
2300 if (path == NULL) {
2301 PyErr_Clear();
2302 Py_INCREF(Py_None);
2303 return Py_None;
2304 }
2305 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002306
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002307 buf[0] = '\0';
Just van Rossum52e14d62002-12-30 22:08:05 +00002308 fdp = find_module(fullname, subname, path, buf, MAXPATHLEN+1,
2309 &fp, &loader);
Guido van Rossumb68cd421998-07-01 17:36:26 +00002310 Py_XDECREF(path);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002311 if (fdp == NULL) {
2312 if (!PyErr_ExceptionMatches(PyExc_ImportError))
2313 return NULL;
2314 PyErr_Clear();
2315 Py_INCREF(Py_None);
2316 return Py_None;
2317 }
Just van Rossum52e14d62002-12-30 22:08:05 +00002318 m = load_module(fullname, fp, buf, fdp->type, loader);
2319 Py_XDECREF(loader);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002320 if (fp)
2321 fclose(fp);
Neil Schemenauer00b09662003-06-16 21:03:07 +00002322 if (!add_submodule(mod, m, fullname, subname, modules)) {
2323 Py_XDECREF(m);
2324 m = NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002325 }
Guido van Rossum74e6a111994-08-29 12:54:38 +00002326 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002327
2328 return m;
Guido van Rossum74e6a111994-08-29 12:54:38 +00002329}
2330
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002331
2332/* Re-import a module of any kind and return its module object, WITH
2333 INCREMENTED REFERENCE COUNT */
2334
Guido van Rossum79f25d91997-04-29 20:08:16 +00002335PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002336PyImport_ReloadModule(PyObject *m)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002337{
Guido van Rossumd8faa362007-04-27 19:54:29 +00002338 PyInterpreterState *interp = PyThreadState_Get()->interp;
2339 PyObject *modules_reloading = interp->modules_reloading;
Guido van Rossum25ce5661997-08-02 03:10:38 +00002340 PyObject *modules = PyImport_GetModuleDict();
Guido van Rossumd8faa362007-04-27 19:54:29 +00002341 PyObject *path = NULL, *loader = NULL, *existing_m = NULL;
Guido van Rossum222ef561997-09-06 19:41:09 +00002342 char *name, *subname;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002343 char buf[MAXPATHLEN+1];
2344 struct filedescr *fdp;
2345 FILE *fp = NULL;
Tim Peters1cd70172004-08-02 03:52:12 +00002346 PyObject *newm;
Guido van Rossumd8faa362007-04-27 19:54:29 +00002347
2348 if (modules_reloading == NULL) {
2349 Py_FatalError("PyImport_ReloadModule: "
Guido van Rossume7ba4952007-06-06 23:52:48 +00002350 "no modules_reloading dictionary!");
Guido van Rossumd8faa362007-04-27 19:54:29 +00002351 return NULL;
2352 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002353
Guido van Rossum79f25d91997-04-29 20:08:16 +00002354 if (m == NULL || !PyModule_Check(m)) {
2355 PyErr_SetString(PyExc_TypeError,
2356 "reload() argument must be module");
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002357 return NULL;
2358 }
Neal Norwitz5616c6d2007-08-26 05:32:41 +00002359 name = (char*)PyModule_GetName(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002360 if (name == NULL)
2361 return NULL;
Guido van Rossum25ce5661997-08-02 03:10:38 +00002362 if (m != PyDict_GetItemString(modules, name)) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002363 PyErr_Format(PyExc_ImportError,
2364 "reload(): module %.200s not in sys.modules",
2365 name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002366 return NULL;
2367 }
Guido van Rossumd8faa362007-04-27 19:54:29 +00002368 existing_m = PyDict_GetItemString(modules_reloading, name);
2369 if (existing_m != NULL) {
2370 /* Due to a recursive reload, this module is already
2371 being reloaded. */
2372 Py_INCREF(existing_m);
2373 return existing_m;
2374 }
2375 if (PyDict_SetItemString(modules_reloading, name, m) < 0)
2376 return NULL;
2377
Guido van Rossum222ef561997-09-06 19:41:09 +00002378 subname = strrchr(name, '.');
2379 if (subname == NULL)
2380 subname = name;
2381 else {
2382 PyObject *parentname, *parent;
2383 parentname = PyString_FromStringAndSize(name, (subname-name));
Guido van Rossumd8faa362007-04-27 19:54:29 +00002384 if (parentname == NULL) {
2385 imp_modules_reloading_clear();
Guido van Rossum222ef561997-09-06 19:41:09 +00002386 return NULL;
Guido van Rossumd8faa362007-04-27 19:54:29 +00002387 }
Guido van Rossum222ef561997-09-06 19:41:09 +00002388 parent = PyDict_GetItem(modules, parentname);
2389 if (parent == NULL) {
2390 PyErr_Format(PyExc_ImportError,
2391 "reload(): parent %.200s not in sys.modules",
Georg Brandl0c55f292005-09-14 06:56:20 +00002392 PyString_AS_STRING(parentname));
2393 Py_DECREF(parentname);
Guido van Rossume7ba4952007-06-06 23:52:48 +00002394 imp_modules_reloading_clear();
Guido van Rossum222ef561997-09-06 19:41:09 +00002395 return NULL;
2396 }
Georg Brandl0c55f292005-09-14 06:56:20 +00002397 Py_DECREF(parentname);
Guido van Rossum222ef561997-09-06 19:41:09 +00002398 subname++;
2399 path = PyObject_GetAttrString(parent, "__path__");
2400 if (path == NULL)
2401 PyErr_Clear();
2402 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002403 buf[0] = '\0';
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00002404 fdp = find_module(name, subname, path, buf, MAXPATHLEN+1, &fp, &loader);
Guido van Rossum222ef561997-09-06 19:41:09 +00002405 Py_XDECREF(path);
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00002406
2407 if (fdp == NULL) {
2408 Py_XDECREF(loader);
Guido van Rossumd8faa362007-04-27 19:54:29 +00002409 imp_modules_reloading_clear();
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002410 return NULL;
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00002411 }
2412
2413 newm = load_module(name, fp, buf, fdp->type, loader);
2414 Py_XDECREF(loader);
2415
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002416 if (fp)
2417 fclose(fp);
Tim Peters1cd70172004-08-02 03:52:12 +00002418 if (newm == NULL) {
2419 /* load_module probably removed name from modules because of
2420 * the error. Put back the original module object. We're
2421 * going to return NULL in this case regardless of whether
2422 * replacing name succeeds, so the return value is ignored.
2423 */
2424 PyDict_SetItemString(modules, name, m);
2425 }
Guido van Rossumd8faa362007-04-27 19:54:29 +00002426 imp_modules_reloading_clear();
Tim Peters1cd70172004-08-02 03:52:12 +00002427 return newm;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002428}
2429
2430
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002431/* Higher-level import emulator which emulates the "import" statement
2432 more accurately -- it invokes the __import__() function from the
2433 builtins of the current globals. This means that the import is
2434 done using whatever import hooks are installed in the current
Guido van Rossum6058eb41998-12-21 19:51:00 +00002435 environment, e.g. by "rexec".
2436 A dummy list ["__doc__"] is passed as the 4th argument so that
Neal Norwitz80e7f272007-08-26 06:45:23 +00002437 e.g. PyImport_Import(PyUnicode_FromString("win32com.client.gencache"))
Guido van Rossum6058eb41998-12-21 19:51:00 +00002438 will return <module "gencache"> instead of <module "win32com">. */
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002439
2440PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002441PyImport_Import(PyObject *module_name)
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002442{
2443 static PyObject *silly_list = NULL;
2444 static PyObject *builtins_str = NULL;
2445 static PyObject *import_str = NULL;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002446 PyObject *globals = NULL;
2447 PyObject *import = NULL;
2448 PyObject *builtins = NULL;
2449 PyObject *r = NULL;
2450
2451 /* Initialize constant string objects */
2452 if (silly_list == NULL) {
Martin v. Löwis5b222132007-06-10 09:51:05 +00002453 import_str = PyUnicode_InternFromString("__import__");
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002454 if (import_str == NULL)
2455 return NULL;
Martin v. Löwis5b222132007-06-10 09:51:05 +00002456 builtins_str = PyUnicode_InternFromString("__builtins__");
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002457 if (builtins_str == NULL)
2458 return NULL;
2459 silly_list = Py_BuildValue("[s]", "__doc__");
2460 if (silly_list == NULL)
2461 return NULL;
2462 }
2463
2464 /* Get the builtins from current globals */
2465 globals = PyEval_GetGlobals();
Guido van Rossum85cd1d62001-02-20 21:43:24 +00002466 if (globals != NULL) {
Guido van Rossum66468561998-10-22 15:46:50 +00002467 Py_INCREF(globals);
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002468 builtins = PyObject_GetItem(globals, builtins_str);
2469 if (builtins == NULL)
2470 goto err;
2471 }
2472 else {
2473 /* No globals -- use standard builtins, and fake globals */
2474 PyErr_Clear();
2475
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002476 builtins = PyImport_ImportModuleLevel("__builtin__",
2477 NULL, NULL, NULL, 0);
Guido van Rossum85cd1d62001-02-20 21:43:24 +00002478 if (builtins == NULL)
2479 return NULL;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002480 globals = Py_BuildValue("{OO}", builtins_str, builtins);
2481 if (globals == NULL)
2482 goto err;
2483 }
2484
2485 /* Get the __import__ function from the builtins */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002486 if (PyDict_Check(builtins)) {
Fred Drakea76ba6e2001-03-06 06:31:15 +00002487 import = PyObject_GetItem(builtins, import_str);
Tim Peters6d6c1a32001-08-02 04:15:00 +00002488 if (import == NULL)
2489 PyErr_SetObject(PyExc_KeyError, import_str);
2490 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002491 else
Fred Drakea76ba6e2001-03-06 06:31:15 +00002492 import = PyObject_GetAttr(builtins, import_str);
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002493 if (import == NULL)
2494 goto err;
2495
Guido van Rossumd8faa362007-04-27 19:54:29 +00002496 /* Call the __import__ function with the proper argument list */
Thomas Wouters477c8d52006-05-27 19:21:47 +00002497 r = PyObject_CallFunctionObjArgs(import, module_name, globals,
2498 globals, silly_list, NULL);
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002499
2500 err:
2501 Py_XDECREF(globals);
2502 Py_XDECREF(builtins);
2503 Py_XDECREF(import);
Tim Peters50d8d372001-02-28 05:34:27 +00002504
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002505 return r;
2506}
2507
2508
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002509/* Module 'imp' provides Python access to the primitives used for
2510 importing modules.
2511*/
2512
Guido van Rossum79f25d91997-04-29 20:08:16 +00002513static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +00002514imp_get_magic(PyObject *self, PyObject *noargs)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002515{
2516 char buf[4];
2517
Guido van Rossum96774c12000-05-01 20:19:08 +00002518 buf[0] = (char) ((pyc_magic >> 0) & 0xff);
2519 buf[1] = (char) ((pyc_magic >> 8) & 0xff);
2520 buf[2] = (char) ((pyc_magic >> 16) & 0xff);
2521 buf[3] = (char) ((pyc_magic >> 24) & 0xff);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002522
Guido van Rossumad8d3002007-08-03 18:40:49 +00002523 return PyBytes_FromStringAndSize(buf, 4);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002524}
2525
Guido van Rossum79f25d91997-04-29 20:08:16 +00002526static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +00002527imp_get_suffixes(PyObject *self, PyObject *noargs)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002528{
Guido van Rossum79f25d91997-04-29 20:08:16 +00002529 PyObject *list;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002530 struct filedescr *fdp;
2531
Guido van Rossum79f25d91997-04-29 20:08:16 +00002532 list = PyList_New(0);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002533 if (list == NULL)
2534 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002535 for (fdp = _PyImport_Filetab; fdp->suffix != NULL; fdp++) {
2536 PyObject *item = Py_BuildValue("ssi",
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002537 fdp->suffix, fdp->mode, fdp->type);
2538 if (item == NULL) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00002539 Py_DECREF(list);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002540 return NULL;
2541 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002542 if (PyList_Append(list, item) < 0) {
2543 Py_DECREF(list);
2544 Py_DECREF(item);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002545 return NULL;
2546 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002547 Py_DECREF(item);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002548 }
2549 return list;
2550}
2551
Guido van Rossum79f25d91997-04-29 20:08:16 +00002552static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002553call_find_module(char *name, PyObject *path)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002554{
Tim Petersdbd9ba62000-07-09 03:09:57 +00002555 extern int fclose(FILE *);
Guido van Rossum79f25d91997-04-29 20:08:16 +00002556 PyObject *fob, *ret;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002557 struct filedescr *fdp;
2558 char pathname[MAXPATHLEN+1];
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002559 FILE *fp = NULL;
2560
2561 pathname[0] = '\0';
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002562 if (path == Py_None)
2563 path = NULL;
Just van Rossum52e14d62002-12-30 22:08:05 +00002564 fdp = find_module(NULL, name, path, pathname, MAXPATHLEN+1, &fp, NULL);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002565 if (fdp == NULL)
2566 return NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002567 if (fp != NULL) {
2568 fob = PyFile_FromFile(fp, pathname, fdp->mode, fclose);
2569 if (fob == NULL) {
2570 fclose(fp);
2571 return NULL;
2572 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002573 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002574 else {
2575 fob = Py_None;
2576 Py_INCREF(fob);
Tim Peters50d8d372001-02-28 05:34:27 +00002577 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002578 ret = Py_BuildValue("Os(ssi)",
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002579 fob, pathname, fdp->suffix, fdp->mode, fdp->type);
Guido van Rossum79f25d91997-04-29 20:08:16 +00002580 Py_DECREF(fob);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002581 return ret;
2582}
2583
Guido van Rossum79f25d91997-04-29 20:08:16 +00002584static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002585imp_find_module(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002586{
2587 char *name;
2588 PyObject *path = NULL;
Guido van Rossum43713e52000-02-29 13:59:29 +00002589 if (!PyArg_ParseTuple(args, "s|O:find_module", &name, &path))
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002590 return NULL;
2591 return call_find_module(name, path);
2592}
2593
2594static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002595imp_init_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002596{
2597 char *name;
2598 int ret;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002599 PyObject *m;
Guido van Rossum43713e52000-02-29 13:59:29 +00002600 if (!PyArg_ParseTuple(args, "s:init_builtin", &name))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002601 return NULL;
2602 ret = init_builtin(name);
2603 if (ret < 0)
2604 return NULL;
2605 if (ret == 0) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00002606 Py_INCREF(Py_None);
2607 return Py_None;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002608 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002609 m = PyImport_AddModule(name);
2610 Py_XINCREF(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002611 return m;
2612}
2613
Guido van Rossum79f25d91997-04-29 20:08:16 +00002614static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002615imp_init_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002616{
2617 char *name;
2618 int ret;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002619 PyObject *m;
Guido van Rossum43713e52000-02-29 13:59:29 +00002620 if (!PyArg_ParseTuple(args, "s:init_frozen", &name))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002621 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002622 ret = PyImport_ImportFrozenModule(name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002623 if (ret < 0)
2624 return NULL;
2625 if (ret == 0) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00002626 Py_INCREF(Py_None);
2627 return Py_None;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002628 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002629 m = PyImport_AddModule(name);
2630 Py_XINCREF(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002631 return m;
2632}
2633
Guido van Rossum79f25d91997-04-29 20:08:16 +00002634static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002635imp_get_frozen_object(PyObject *self, PyObject *args)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002636{
2637 char *name;
Jack Jansen95ffa231995-10-03 14:38:41 +00002638
Guido van Rossum43713e52000-02-29 13:59:29 +00002639 if (!PyArg_ParseTuple(args, "s:get_frozen_object", &name))
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002640 return NULL;
2641 return get_frozen_object(name);
2642}
2643
Guido van Rossum79f25d91997-04-29 20:08:16 +00002644static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002645imp_is_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002646{
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002647 char *name;
Guido van Rossum43713e52000-02-29 13:59:29 +00002648 if (!PyArg_ParseTuple(args, "s:is_builtin", &name))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002649 return NULL;
Guido van Rossum50ee94f2002-04-09 18:00:58 +00002650 return PyInt_FromLong(is_builtin(name));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002651}
2652
Guido van Rossum79f25d91997-04-29 20:08:16 +00002653static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002654imp_is_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002655{
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002656 char *name;
Guido van Rossum323bf5e1998-06-24 03:54:06 +00002657 struct _frozen *p;
Guido van Rossum43713e52000-02-29 13:59:29 +00002658 if (!PyArg_ParseTuple(args, "s:is_frozen", &name))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002659 return NULL;
Guido van Rossum323bf5e1998-06-24 03:54:06 +00002660 p = find_frozen(name);
Guido van Rossumb8bff3f2002-04-07 06:34:38 +00002661 return PyBool_FromLong((long) (p == NULL ? 0 : p->size));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002662}
2663
2664static FILE *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002665get_file(char *pathname, PyObject *fob, char *mode)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002666{
2667 FILE *fp;
Guido van Rossumda5b8f22007-06-12 23:30:11 +00002668 if (mode[0] == 'U')
2669 mode = "r" PY_STDIOTEXTMODE;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002670 if (fob == NULL) {
2671 fp = fopen(pathname, mode);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002672 }
2673 else {
Guido van Rossumda5b8f22007-06-12 23:30:11 +00002674 int fd = PyObject_AsFileDescriptor(fob);
2675 if (fd == -1)
2676 return NULL;
2677 /* XXX This will leak a FILE struct. Fix this!!!!
2678 (But it doesn't leak a file descrioptor!) */
2679 fp = fdopen(fd, mode);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002680 }
Guido van Rossumda5b8f22007-06-12 23:30:11 +00002681 if (fp == NULL)
2682 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002683 return fp;
2684}
2685
Guido van Rossum79f25d91997-04-29 20:08:16 +00002686static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002687imp_load_compiled(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002688{
2689 char *name;
2690 char *pathname;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002691 PyObject *fob = NULL;
2692 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002693 FILE *fp;
Guido van Rossumda5b8f22007-06-12 23:30:11 +00002694 if (!PyArg_ParseTuple(args, "ss|O:load_compiled",
2695 &name, &pathname, &fob))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002696 return NULL;
2697 fp = get_file(pathname, fob, "rb");
2698 if (fp == NULL)
2699 return NULL;
2700 m = load_compiled_module(name, pathname, fp);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002701 if (fob == NULL)
2702 fclose(fp);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002703 return m;
2704}
2705
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002706#ifdef HAVE_DYNAMIC_LOADING
2707
Guido van Rossum79f25d91997-04-29 20:08:16 +00002708static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002709imp_load_dynamic(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002710{
2711 char *name;
2712 char *pathname;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002713 PyObject *fob = NULL;
2714 PyObject *m;
Guido van Rossum7faeab31995-07-07 22:50:36 +00002715 FILE *fp = NULL;
Guido van Rossumda5b8f22007-06-12 23:30:11 +00002716 if (!PyArg_ParseTuple(args, "ss|O:load_dynamic",
2717 &name, &pathname, &fob))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002718 return NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002719 if (fob) {
Guido van Rossum7faeab31995-07-07 22:50:36 +00002720 fp = get_file(pathname, fob, "r");
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002721 if (fp == NULL)
2722 return NULL;
2723 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002724 m = _PyImport_LoadDynamicModule(name, pathname, fp);
Guido van Rossum7faeab31995-07-07 22:50:36 +00002725 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002726}
2727
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002728#endif /* HAVE_DYNAMIC_LOADING */
2729
Guido van Rossum79f25d91997-04-29 20:08:16 +00002730static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002731imp_load_source(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002732{
2733 char *name;
2734 char *pathname;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002735 PyObject *fob = NULL;
2736 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002737 FILE *fp;
Guido van Rossumda5b8f22007-06-12 23:30:11 +00002738 if (!PyArg_ParseTuple(args, "ss|O:load_source",
2739 &name, &pathname, &fob))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002740 return NULL;
2741 fp = get_file(pathname, fob, "r");
2742 if (fp == NULL)
2743 return NULL;
2744 m = load_source_module(name, pathname, fp);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002745 if (fob == NULL)
2746 fclose(fp);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002747 return m;
2748}
2749
Guido van Rossum79f25d91997-04-29 20:08:16 +00002750static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002751imp_load_module(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002752{
2753 char *name;
2754 PyObject *fob;
2755 char *pathname;
2756 char *suffix; /* Unused */
2757 char *mode;
2758 int type;
2759 FILE *fp;
2760
Guido van Rossum43713e52000-02-29 13:59:29 +00002761 if (!PyArg_ParseTuple(args, "sOs(ssi):load_module",
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002762 &name, &fob, &pathname,
2763 &suffix, &mode, &type))
2764 return NULL;
Guido van Rossum5e2c5fa2002-05-30 17:33:07 +00002765 if (*mode) {
2766 /* Mode must start with 'r' or 'U' and must not contain '+'.
2767 Implicit in this test is the assumption that the mode
2768 may contain other modifiers like 'b' or 't'. */
2769
2770 if (!(*mode == 'r' || *mode == 'U') || strchr(mode, '+')) {
Jeremy Hylton4ae6fae2002-05-30 17:15:25 +00002771 PyErr_Format(PyExc_ValueError,
2772 "invalid file open mode %.200s", mode);
2773 return NULL;
Guido van Rossum5e2c5fa2002-05-30 17:33:07 +00002774 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002775 }
2776 if (fob == Py_None)
2777 fp = NULL;
2778 else {
Guido van Rossumda5b8f22007-06-12 23:30:11 +00002779 fp = get_file(NULL, fob, mode);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002780 if (fp == NULL)
2781 return NULL;
2782 }
Just van Rossum52e14d62002-12-30 22:08:05 +00002783 return load_module(name, fp, pathname, type, NULL);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002784}
2785
2786static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002787imp_load_package(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002788{
2789 char *name;
2790 char *pathname;
Guido van Rossum43713e52000-02-29 13:59:29 +00002791 if (!PyArg_ParseTuple(args, "ss:load_package", &name, &pathname))
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002792 return NULL;
2793 return load_package(name, pathname);
2794}
2795
2796static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002797imp_new_module(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002798{
2799 char *name;
Guido van Rossum43713e52000-02-29 13:59:29 +00002800 if (!PyArg_ParseTuple(args, "s:new_module", &name))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002801 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002802 return PyModule_New(name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002803}
2804
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002805/* Doc strings */
2806
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002807PyDoc_STRVAR(doc_imp,
2808"This module provides the components needed to build your own\n\
2809__import__ function. Undocumented functions are obsolete.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002810
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002811PyDoc_STRVAR(doc_find_module,
2812"find_module(name, [path]) -> (file, filename, (suffix, mode, type))\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002813Search for a module. If path is omitted or None, search for a\n\
2814built-in, frozen or special module and continue search in sys.path.\n\
2815The module name cannot contain '.'; to search for a submodule of a\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002816package, pass the submodule name and the package's __path__.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002817
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002818PyDoc_STRVAR(doc_load_module,
2819"load_module(name, file, filename, (suffix, mode, type)) -> module\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002820Load a module, given information returned by find_module().\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002821The module name must include the full package name, if any.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002822
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002823PyDoc_STRVAR(doc_get_magic,
2824"get_magic() -> string\n\
2825Return the magic number for .pyc or .pyo files.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002826
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002827PyDoc_STRVAR(doc_get_suffixes,
2828"get_suffixes() -> [(suffix, mode, type), ...]\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002829Return a list of (suffix, mode, type) tuples describing the files\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002830that find_module() looks for.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002831
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002832PyDoc_STRVAR(doc_new_module,
2833"new_module(name) -> module\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002834Create a new module. Do not enter it in sys.modules.\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002835The module name must include the full package name, if any.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002836
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002837PyDoc_STRVAR(doc_lock_held,
Tim Petersa7c65092004-08-01 23:26:05 +00002838"lock_held() -> boolean\n\
2839Return True if the import lock is currently held, else False.\n\
2840On platforms without threads, return False.");
Tim Peters69232342001-08-30 05:16:13 +00002841
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00002842PyDoc_STRVAR(doc_acquire_lock,
2843"acquire_lock() -> None\n\
Neal Norwitz2294c0d2003-02-12 23:02:21 +00002844Acquires the interpreter's import lock for the current thread.\n\
2845This lock should be used by import hooks to ensure thread-safety\n\
2846when importing modules.\n\
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00002847On platforms without threads, this function does nothing.");
2848
2849PyDoc_STRVAR(doc_release_lock,
2850"release_lock() -> None\n\
2851Release the interpreter's import lock.\n\
2852On platforms without threads, this function does nothing.");
2853
Guido van Rossum79f25d91997-04-29 20:08:16 +00002854static PyMethodDef imp_methods[] = {
Neal Norwitz08ea61a2003-02-17 18:18:00 +00002855 {"find_module", imp_find_module, METH_VARARGS, doc_find_module},
2856 {"get_magic", imp_get_magic, METH_NOARGS, doc_get_magic},
2857 {"get_suffixes", imp_get_suffixes, METH_NOARGS, doc_get_suffixes},
2858 {"load_module", imp_load_module, METH_VARARGS, doc_load_module},
2859 {"new_module", imp_new_module, METH_VARARGS, doc_new_module},
2860 {"lock_held", imp_lock_held, METH_NOARGS, doc_lock_held},
2861 {"acquire_lock", imp_acquire_lock, METH_NOARGS, doc_acquire_lock},
2862 {"release_lock", imp_release_lock, METH_NOARGS, doc_release_lock},
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002863 /* The rest are obsolete */
Neal Norwitz031829d2002-03-31 14:37:44 +00002864 {"get_frozen_object", imp_get_frozen_object, METH_VARARGS},
2865 {"init_builtin", imp_init_builtin, METH_VARARGS},
2866 {"init_frozen", imp_init_frozen, METH_VARARGS},
2867 {"is_builtin", imp_is_builtin, METH_VARARGS},
2868 {"is_frozen", imp_is_frozen, METH_VARARGS},
2869 {"load_compiled", imp_load_compiled, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002870#ifdef HAVE_DYNAMIC_LOADING
Neal Norwitz031829d2002-03-31 14:37:44 +00002871 {"load_dynamic", imp_load_dynamic, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002872#endif
Neal Norwitz031829d2002-03-31 14:37:44 +00002873 {"load_package", imp_load_package, METH_VARARGS},
Neal Norwitz031829d2002-03-31 14:37:44 +00002874 {"load_source", imp_load_source, METH_VARARGS},
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002875 {NULL, NULL} /* sentinel */
2876};
2877
Guido van Rossum1a8791e1998-08-04 22:46:29 +00002878static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002879setint(PyObject *d, char *name, int value)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002880{
2881 PyObject *v;
2882 int err;
2883
2884 v = PyInt_FromLong((long)value);
2885 err = PyDict_SetItemString(d, name, v);
2886 Py_XDECREF(v);
2887 return err;
2888}
2889
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002890typedef struct {
2891 PyObject_HEAD
2892} NullImporter;
2893
2894static int
2895NullImporter_init(NullImporter *self, PyObject *args, PyObject *kwds)
2896{
2897 char *path;
2898
2899 if (!_PyArg_NoKeywords("NullImporter()", kwds))
2900 return -1;
2901
2902 if (!PyArg_ParseTuple(args, "s:NullImporter",
2903 &path))
2904 return -1;
2905
2906 if (strlen(path) == 0) {
2907 PyErr_SetString(PyExc_ImportError, "empty pathname");
2908 return -1;
2909 } else {
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002910 struct stat statbuf;
2911 int rv;
2912
2913 rv = stat(path, &statbuf);
2914 if (rv == 0) {
2915 /* it exists */
2916 if (S_ISDIR(statbuf.st_mode)) {
2917 /* it's a directory */
2918 PyErr_SetString(PyExc_ImportError,
2919 "existing directory");
2920 return -1;
2921 }
2922 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002923 }
2924 return 0;
2925}
2926
2927static PyObject *
2928NullImporter_find_module(NullImporter *self, PyObject *args)
2929{
2930 Py_RETURN_NONE;
2931}
2932
2933static PyMethodDef NullImporter_methods[] = {
2934 {"find_module", (PyCFunction)NullImporter_find_module, METH_VARARGS,
2935 "Always return None"
2936 },
2937 {NULL} /* Sentinel */
2938};
2939
2940
2941static PyTypeObject NullImporterType = {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00002942 PyVarObject_HEAD_INIT(NULL, 0)
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002943 "imp.NullImporter", /*tp_name*/
2944 sizeof(NullImporter), /*tp_basicsize*/
2945 0, /*tp_itemsize*/
2946 0, /*tp_dealloc*/
2947 0, /*tp_print*/
2948 0, /*tp_getattr*/
2949 0, /*tp_setattr*/
2950 0, /*tp_compare*/
2951 0, /*tp_repr*/
2952 0, /*tp_as_number*/
2953 0, /*tp_as_sequence*/
2954 0, /*tp_as_mapping*/
2955 0, /*tp_hash */
2956 0, /*tp_call*/
2957 0, /*tp_str*/
2958 0, /*tp_getattro*/
2959 0, /*tp_setattro*/
2960 0, /*tp_as_buffer*/
2961 Py_TPFLAGS_DEFAULT, /*tp_flags*/
2962 "Null importer object", /* tp_doc */
2963 0, /* tp_traverse */
2964 0, /* tp_clear */
2965 0, /* tp_richcompare */
2966 0, /* tp_weaklistoffset */
2967 0, /* tp_iter */
2968 0, /* tp_iternext */
2969 NullImporter_methods, /* tp_methods */
2970 0, /* tp_members */
2971 0, /* tp_getset */
2972 0, /* tp_base */
2973 0, /* tp_dict */
2974 0, /* tp_descr_get */
2975 0, /* tp_descr_set */
2976 0, /* tp_dictoffset */
2977 (initproc)NullImporter_init, /* tp_init */
2978 0, /* tp_alloc */
2979 PyType_GenericNew /* tp_new */
2980};
2981
2982
Jason Tishler6bc06ec2003-09-04 11:59:50 +00002983PyMODINIT_FUNC
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002984initimp(void)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002985{
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002986 PyObject *m, *d;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002987
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002988 if (PyType_Ready(&NullImporterType) < 0)
2989 goto failure;
2990
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002991 m = Py_InitModule4("imp", imp_methods, doc_imp,
2992 NULL, PYTHON_API_VERSION);
Neal Norwitz1ac754f2006-01-19 06:09:39 +00002993 if (m == NULL)
2994 goto failure;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002995 d = PyModule_GetDict(m);
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00002996 if (d == NULL)
2997 goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002998
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002999 if (setint(d, "SEARCH_ERROR", SEARCH_ERROR) < 0) goto failure;
3000 if (setint(d, "PY_SOURCE", PY_SOURCE) < 0) goto failure;
3001 if (setint(d, "PY_COMPILED", PY_COMPILED) < 0) goto failure;
3002 if (setint(d, "C_EXTENSION", C_EXTENSION) < 0) goto failure;
3003 if (setint(d, "PY_RESOURCE", PY_RESOURCE) < 0) goto failure;
3004 if (setint(d, "PKG_DIRECTORY", PKG_DIRECTORY) < 0) goto failure;
3005 if (setint(d, "C_BUILTIN", C_BUILTIN) < 0) goto failure;
3006 if (setint(d, "PY_FROZEN", PY_FROZEN) < 0) goto failure;
Guido van Rossum0f84a341998-08-06 13:36:01 +00003007 if (setint(d, "PY_CODERESOURCE", PY_CODERESOURCE) < 0) goto failure;
Just van Rossum52e14d62002-12-30 22:08:05 +00003008 if (setint(d, "IMP_HOOK", IMP_HOOK) < 0) goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003009
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003010 Py_INCREF(&NullImporterType);
3011 PyModule_AddObject(m, "NullImporter", (PyObject *)&NullImporterType);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003012 failure:
3013 ;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003014}
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003015
3016
Guido van Rossumb18618d2000-05-03 23:44:39 +00003017/* API for embedding applications that want to add their own entries
3018 to the table of built-in modules. This should normally be called
3019 *before* Py_Initialize(). When the table resize fails, -1 is
3020 returned and the existing table is unchanged.
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003021
3022 After a similar function by Just van Rossum. */
3023
3024int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003025PyImport_ExtendInittab(struct _inittab *newtab)
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003026{
3027 static struct _inittab *our_copy = NULL;
3028 struct _inittab *p;
3029 int i, n;
3030
3031 /* Count the number of entries in both tables */
3032 for (n = 0; newtab[n].name != NULL; n++)
3033 ;
3034 if (n == 0)
3035 return 0; /* Nothing to do */
3036 for (i = 0; PyImport_Inittab[i].name != NULL; i++)
3037 ;
3038
3039 /* Allocate new memory for the combined table */
Guido van Rossumb18618d2000-05-03 23:44:39 +00003040 p = our_copy;
3041 PyMem_RESIZE(p, struct _inittab, i+n+1);
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003042 if (p == NULL)
3043 return -1;
3044
3045 /* Copy the tables into the new memory */
3046 if (our_copy != PyImport_Inittab)
3047 memcpy(p, PyImport_Inittab, (i+1) * sizeof(struct _inittab));
3048 PyImport_Inittab = our_copy = p;
3049 memcpy(p+i, newtab, (n+1) * sizeof(struct _inittab));
3050
3051 return 0;
3052}
3053
3054/* Shorthand to add a single entry given a name and a function */
3055
3056int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003057PyImport_AppendInittab(char *name, void (*initfunc)(void))
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003058{
3059 struct _inittab newtab[2];
3060
3061 memset(newtab, '\0', sizeof newtab);
3062
3063 newtab[0].name = name;
3064 newtab[0].initfunc = initfunc;
3065
3066 return PyImport_ExtendInittab(newtab);
3067}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00003068
3069#ifdef __cplusplus
3070}
3071#endif