blob: 14cda6e2728ce6d98ebc2cc707227b91a3d64741 [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
Christian Heimesd3eb5a152008-02-24 00:38:49 +000025#ifdef MS_WINDOWS
26/* for stat.st_mode */
27typedef unsigned short mode_t;
28#endif
29
Thomas Woutersf70ef4f2000-07-22 18:47:25 +000030extern time_t PyOS_GetLastModificationTime(char *, FILE *);
31 /* In getmtime.c */
Guido van Rossum21d335e1993-10-15 13:01:11 +000032
Jeremy Hyltond4ceb312004-04-01 02:45:22 +000033/* Magic word to reject .pyc files generated by other Python versions.
34 It should change for each incompatible change to the bytecode.
35
36 The value of CR and LF is incorporated so if you ever read or write
Guido van Rossum7faeab31995-07-07 22:50:36 +000037 a .pyc file in text mode the magic number will be wrong; also, the
Tim Peters36515e22001-11-18 04:06:29 +000038 Apple MPW compiler swaps their values, botching string constants.
Marc-André Lemburgbd3be8f2002-02-07 11:33:49 +000039
Guido van Rossum45aecf42006-03-15 04:58:47 +000040 The magic numbers must be spaced apart at least 2 values, as the
Martin v. Löwisef82d2f2004-06-27 16:51:46 +000041 -U interpeter flag will cause MAGIC+1 being used. They have been
42 odd numbers for some time now.
Marc-André Lemburgbd3be8f2002-02-07 11:33:49 +000043
Jeremy Hyltond4ceb312004-04-01 02:45:22 +000044 There were a variety of old schemes for setting the magic number.
45 The current working scheme is to increment the previous value by
46 10.
Guido van Rossumf6894922002-08-31 15:16:14 +000047
Marc-André Lemburgbd3be8f2002-02-07 11:33:49 +000048 Known values:
49 Python 1.5: 20121
50 Python 1.5.1: 20121
51 Python 1.5.2: 20121
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000052 Python 1.6: 50428
Marc-André Lemburgbd3be8f2002-02-07 11:33:49 +000053 Python 2.0: 50823
54 Python 2.0.1: 50823
55 Python 2.1: 60202
56 Python 2.1.1: 60202
57 Python 2.1.2: 60202
58 Python 2.2: 60717
Neal Norwitz7fdcb412002-06-14 01:07:39 +000059 Python 2.3a0: 62011
Michael W. Hudsondd32a912002-08-15 14:59:02 +000060 Python 2.3a0: 62021
Guido van Rossumf6894922002-08-31 15:16:14 +000061 Python 2.3a0: 62011 (!)
Martin v. Löwisef82d2f2004-06-27 16:51:46 +000062 Python 2.4a0: 62041
Raymond Hettingerfd2d1f72004-08-23 23:37:48 +000063 Python 2.4a3: 62051
Raymond Hettinger2c31a052004-09-22 18:44:21 +000064 Python 2.4b1: 62061
Michael W. Hudsondf888462005-06-03 14:41:55 +000065 Python 2.5a0: 62071
Michael W. Hudsonaee2e282005-10-21 11:32:20 +000066 Python 2.5a0: 62081 (ast-branch)
Guido van Rossumc2e20742006-02-27 22:32:47 +000067 Python 2.5a0: 62091 (with)
Guido van Rossumf6694362006-03-10 02:28:35 +000068 Python 2.5a0: 62092 (changed WITH_CLEANUP opcode)
Thomas Wouters0e3f5912006-08-11 14:57:12 +000069 Python 2.5b3: 62101 (fix wrong code: for x, in ...)
70 Python 2.5b3: 62111 (fix wrong code: x += yield)
71 Python 2.5c1: 62121 (fix wrong lnotab with for loops and
72 storing constants that should have been removed)
Thomas Wouters89f507f2006-12-13 04:49:30 +000073 Python 2.5c2: 62131 (fix wrong code: for x, in ... in listcomp/genexp)
Christian Heimes99170a52007-12-19 02:07:34 +000074 Python 2.6a0: 62151 (peephole optimizations and STORE_MAP opcode)
Christian Heimesdd15f6c2008-03-16 00:07:10 +000075 Python 2.6a1: 62161 (WITH_CLEANUP optimization)
Guido van Rossum45aecf42006-03-15 04:58:47 +000076 Python 3000: 3000
Brett Cannone2e23ef2006-08-25 05:05:30 +000077 3010 (removed UNARY_CONVERT)
Guido van Rossum86e58e22006-08-28 15:27:34 +000078 3020 (added BUILD_SET)
Guido van Rossum4f72a782006-10-27 23:31:49 +000079 3030 (added keyword-only parameters)
Guido van Rossum3203bdc2006-12-28 21:03:31 +000080 3040 (added signature annotations)
Guido van Rossum452bf512007-02-09 05:32:43 +000081 3050 (print becomes a function)
Guido van Rossum52cc1d82007-03-18 15:41:51 +000082 3060 (PEP 3115 metaclass syntax)
Guido van Rossum00bc0e02007-10-15 02:52:41 +000083 3070 (PEP 3109 raise changes)
84 3080 (PEP 3137 make __file__ and __name__ unicode)
Guido van Rossum98297ee2007-11-06 21:34:58 +000085 3090 (kill str8 interning)
Christian Heimes99170a52007-12-19 02:07:34 +000086 3100 (merge from 2.6a0, see 62151)
Christian Heimes3b06e532008-01-07 20:12:44 +000087 3102 (__file__ points to source file)
Christian Heimesdd15f6c2008-03-16 00:07:10 +000088 Python 3.0a4: 3110 (WITH_CLEANUP optimization).
Benjamin Petersoneec3d712008-06-11 15:59:43 +000089 Python 3.0a5: 3130 (lexical exception stacking, including POP_EXCEPT)
Tim Peters36515e22001-11-18 04:06:29 +000090*/
Benjamin Petersoneec3d712008-06-11 15:59:43 +000091#define MAGIC (3130 | ((long)'\r'<<16) | ((long)'\n'<<24))
Guido van Rossum3ddee711991-12-16 13:06:34 +000092
Guido van Rossum96774c12000-05-01 20:19:08 +000093/* Magic word as global; note that _PyImport_Init() can change the
Jeremy Hylton9262b8a2000-06-30 04:59:17 +000094 value of this global to accommodate for alterations of how the
Guido van Rossum96774c12000-05-01 20:19:08 +000095 compiler works which are enabled by command line switches. */
96static long pyc_magic = MAGIC;
97
Guido van Rossum25ce5661997-08-02 03:10:38 +000098/* See _PyImport_FixupExtension() below */
99static PyObject *extensions = NULL;
Guido van Rossum3f5da241990-12-20 15:06:42 +0000100
Guido van Rossum771c6c81997-10-31 18:37:24 +0000101/* This table is defined in config.c: */
102extern struct _inittab _PyImport_Inittab[];
103
Guido van Rossumce3a72a2007-10-19 23:16:50 +0000104/* Method from Parser/tokenizer.c */
Guido van Rossum40d20bc2007-10-22 00:09:51 +0000105extern char * PyTokenizer_FindEncoding(int);
Guido van Rossumce3a72a2007-10-19 23:16:50 +0000106
Guido van Rossum771c6c81997-10-31 18:37:24 +0000107struct _inittab *PyImport_Inittab = _PyImport_Inittab;
Guido van Rossum66f1fa81991-04-03 19:03:52 +0000108
Guido van Rossumed1170e1999-12-20 21:23:41 +0000109/* these tables define the module suffixes that Python recognizes */
110struct filedescr * _PyImport_Filetab = NULL;
Guido van Rossum48a680c2001-03-02 06:34:14 +0000111
Guido van Rossumed1170e1999-12-20 21:23:41 +0000112static const struct filedescr _PyImport_StandardFiletab[] = {
Jack Jansenc88da1f2002-05-28 10:58:19 +0000113 {".py", "U", PY_SOURCE},
Martin v. Löwis6238d2b2002-06-30 15:26:10 +0000114#ifdef MS_WINDOWS
Jack Jansenc88da1f2002-05-28 10:58:19 +0000115 {".pyw", "U", PY_SOURCE},
Tim Peters36515e22001-11-18 04:06:29 +0000116#endif
Guido van Rossumed1170e1999-12-20 21:23:41 +0000117 {".pyc", "rb", PY_COMPILED},
118 {0, 0}
119};
120
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000121
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000122/* Initialize things */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000123
124void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000125_PyImport_Init(void)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000126{
Guido van Rossumed1170e1999-12-20 21:23:41 +0000127 const struct filedescr *scan;
128 struct filedescr *filetab;
129 int countD = 0;
130 int countS = 0;
131
132 /* prepare _PyImport_Filetab: copy entries from
133 _PyImport_DynLoadFiletab and _PyImport_StandardFiletab.
134 */
Guido van Rossum04110fb2007-08-24 16:32:05 +0000135#ifdef HAVE_DYNAMIC_LOADING
Guido van Rossumed1170e1999-12-20 21:23:41 +0000136 for (scan = _PyImport_DynLoadFiletab; scan->suffix != NULL; ++scan)
137 ++countD;
Guido van Rossum04110fb2007-08-24 16:32:05 +0000138#endif
Guido van Rossumed1170e1999-12-20 21:23:41 +0000139 for (scan = _PyImport_StandardFiletab; scan->suffix != NULL; ++scan)
140 ++countS;
Guido van Rossumb18618d2000-05-03 23:44:39 +0000141 filetab = PyMem_NEW(struct filedescr, countD + countS + 1);
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000142 if (filetab == NULL)
143 Py_FatalError("Can't initialize import file table.");
Guido van Rossum04110fb2007-08-24 16:32:05 +0000144#ifdef HAVE_DYNAMIC_LOADING
Guido van Rossumed1170e1999-12-20 21:23:41 +0000145 memcpy(filetab, _PyImport_DynLoadFiletab,
146 countD * sizeof(struct filedescr));
Guido van Rossum04110fb2007-08-24 16:32:05 +0000147#endif
Guido van Rossumed1170e1999-12-20 21:23:41 +0000148 memcpy(filetab + countD, _PyImport_StandardFiletab,
149 countS * sizeof(struct filedescr));
150 filetab[countD + countS].suffix = NULL;
151
152 _PyImport_Filetab = filetab;
153
Guido van Rossum0824f631997-03-11 18:37:35 +0000154 if (Py_OptimizeFlag) {
Guido van Rossumed1170e1999-12-20 21:23:41 +0000155 /* Replace ".pyc" with ".pyo" in _PyImport_Filetab */
156 for (; filetab->suffix != NULL; filetab++) {
157 if (strcmp(filetab->suffix, ".pyc") == 0)
158 filetab->suffix = ".pyo";
Guido van Rossum0824f631997-03-11 18:37:35 +0000159 }
160 }
Guido van Rossum96774c12000-05-01 20:19:08 +0000161
Guido van Rossum572dbf82007-04-27 23:53:51 +0000162 {
Guido van Rossum96774c12000-05-01 20:19:08 +0000163 /* Fix the pyc_magic so that byte compiled code created
164 using the all-Unicode method doesn't interfere with
165 code created in normal operation mode. */
166 pyc_magic = MAGIC + 1;
167 }
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000168}
169
Guido van Rossum25ce5661997-08-02 03:10:38 +0000170void
Just van Rossum52e14d62002-12-30 22:08:05 +0000171_PyImportHooks_Init(void)
172{
173 PyObject *v, *path_hooks = NULL, *zimpimport;
174 int err = 0;
175
176 /* adding sys.path_hooks and sys.path_importer_cache, setting up
177 zipimport */
Christian Heimes9cd17752007-11-18 19:35:23 +0000178 if (PyType_Ready(&PyNullImporter_Type) < 0)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000179 goto error;
Just van Rossum52e14d62002-12-30 22:08:05 +0000180
181 if (Py_VerboseFlag)
182 PySys_WriteStderr("# installing zipimport hook\n");
183
184 v = PyList_New(0);
185 if (v == NULL)
186 goto error;
187 err = PySys_SetObject("meta_path", v);
188 Py_DECREF(v);
189 if (err)
190 goto error;
191 v = PyDict_New();
192 if (v == NULL)
193 goto error;
194 err = PySys_SetObject("path_importer_cache", v);
195 Py_DECREF(v);
196 if (err)
197 goto error;
198 path_hooks = PyList_New(0);
199 if (path_hooks == NULL)
200 goto error;
201 err = PySys_SetObject("path_hooks", path_hooks);
202 if (err) {
203 error:
204 PyErr_Print();
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000205 Py_FatalError("initializing sys.meta_path, sys.path_hooks, "
206 "path_importer_cache, or NullImporter failed"
207 );
Just van Rossum52e14d62002-12-30 22:08:05 +0000208 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000209
Just van Rossum52e14d62002-12-30 22:08:05 +0000210 zimpimport = PyImport_ImportModule("zipimport");
211 if (zimpimport == NULL) {
212 PyErr_Clear(); /* No zip import module -- okay */
213 if (Py_VerboseFlag)
214 PySys_WriteStderr("# can't import zipimport\n");
215 }
216 else {
217 PyObject *zipimporter = PyObject_GetAttrString(zimpimport,
218 "zipimporter");
219 Py_DECREF(zimpimport);
220 if (zipimporter == NULL) {
221 PyErr_Clear(); /* No zipimporter object -- okay */
222 if (Py_VerboseFlag)
223 PySys_WriteStderr(
Fred Drake1e5fc552003-07-11 15:01:02 +0000224 "# can't import zipimport.zipimporter\n");
Just van Rossum52e14d62002-12-30 22:08:05 +0000225 }
226 else {
227 /* sys.path_hooks.append(zipimporter) */
228 err = PyList_Append(path_hooks, zipimporter);
229 Py_DECREF(zipimporter);
230 if (err)
231 goto error;
232 if (Py_VerboseFlag)
233 PySys_WriteStderr(
234 "# installed zipimport hook\n");
235 }
236 }
237 Py_DECREF(path_hooks);
238}
239
240void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000241_PyImport_Fini(void)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000242{
243 Py_XDECREF(extensions);
244 extensions = NULL;
Barry Warsaw84294482000-10-03 16:02:05 +0000245 PyMem_DEL(_PyImport_Filetab);
246 _PyImport_Filetab = NULL;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000247}
248
249
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000250/* Locking primitives to prevent parallel imports of the same module
251 in different threads to return with a partially loaded module.
252 These calls are serialized by the global interpreter lock. */
253
254#ifdef WITH_THREAD
255
Guido van Rossum49b56061998-10-01 20:42:43 +0000256#include "pythread.h"
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000257
Guido van Rossum65d5b571998-12-21 19:32:43 +0000258static PyThread_type_lock import_lock = 0;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000259static long import_lock_thread = -1;
260static int import_lock_level = 0;
261
262static void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000263lock_import(void)
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000264{
Guido van Rossum65d5b571998-12-21 19:32:43 +0000265 long me = PyThread_get_thread_ident();
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000266 if (me == -1)
267 return; /* Too bad */
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000268 if (import_lock == NULL) {
Guido van Rossum65d5b571998-12-21 19:32:43 +0000269 import_lock = PyThread_allocate_lock();
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000270 if (import_lock == NULL)
271 return; /* Nothing much we can do. */
272 }
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000273 if (import_lock_thread == me) {
274 import_lock_level++;
275 return;
276 }
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000277 if (import_lock_thread != -1 || !PyThread_acquire_lock(import_lock, 0))
278 {
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000279 PyThreadState *tstate = PyEval_SaveThread();
Guido van Rossum65d5b571998-12-21 19:32:43 +0000280 PyThread_acquire_lock(import_lock, 1);
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000281 PyEval_RestoreThread(tstate);
282 }
283 import_lock_thread = me;
284 import_lock_level = 1;
285}
286
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000287static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000288unlock_import(void)
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000289{
Guido van Rossum65d5b571998-12-21 19:32:43 +0000290 long me = PyThread_get_thread_ident();
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000291 if (me == -1 || import_lock == NULL)
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000292 return 0; /* Too bad */
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000293 if (import_lock_thread != me)
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000294 return -1;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000295 import_lock_level--;
296 if (import_lock_level == 0) {
297 import_lock_thread = -1;
Guido van Rossum65d5b571998-12-21 19:32:43 +0000298 PyThread_release_lock(import_lock);
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000299 }
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000300 return 1;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000301}
302
Guido van Rossum8ee3e5a2005-09-14 18:09:42 +0000303/* This function is called from PyOS_AfterFork to ensure that newly
304 created child processes do not share locks with the parent. */
305
306void
307_PyImport_ReInitLock(void)
308{
309#ifdef _AIX
310 if (import_lock != NULL)
311 import_lock = PyThread_allocate_lock();
312#endif
313}
314
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000315#else
316
317#define lock_import()
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000318#define unlock_import() 0
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000319
320#endif
321
Tim Peters69232342001-08-30 05:16:13 +0000322static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000323imp_lock_held(PyObject *self, PyObject *noargs)
Tim Peters69232342001-08-30 05:16:13 +0000324{
Tim Peters69232342001-08-30 05:16:13 +0000325#ifdef WITH_THREAD
Guido van Rossumb8bff3f2002-04-07 06:34:38 +0000326 return PyBool_FromLong(import_lock_thread != -1);
Tim Peters69232342001-08-30 05:16:13 +0000327#else
Guido van Rossumb8bff3f2002-04-07 06:34:38 +0000328 return PyBool_FromLong(0);
Tim Peters69232342001-08-30 05:16:13 +0000329#endif
330}
331
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000332static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000333imp_acquire_lock(PyObject *self, PyObject *noargs)
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000334{
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000335#ifdef WITH_THREAD
336 lock_import();
337#endif
Neal Norwitz2294c0d2003-02-12 23:02:21 +0000338 Py_INCREF(Py_None);
339 return Py_None;
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000340}
341
342static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000343imp_release_lock(PyObject *self, PyObject *noargs)
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000344{
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000345#ifdef WITH_THREAD
346 if (unlock_import() < 0) {
347 PyErr_SetString(PyExc_RuntimeError,
348 "not holding the import lock");
349 return NULL;
350 }
351#endif
Neal Norwitz2294c0d2003-02-12 23:02:21 +0000352 Py_INCREF(Py_None);
353 return Py_None;
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000354}
355
Guido van Rossumd8faa362007-04-27 19:54:29 +0000356static void
357imp_modules_reloading_clear(void)
358{
359 PyInterpreterState *interp = PyThreadState_Get()->interp;
360 if (interp->modules_reloading != NULL)
361 PyDict_Clear(interp->modules_reloading);
362}
363
Guido van Rossum25ce5661997-08-02 03:10:38 +0000364/* Helper for sys */
365
366PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000367PyImport_GetModuleDict(void)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000368{
Nicholas Bastine5662ae2004-03-24 22:22:12 +0000369 PyInterpreterState *interp = PyThreadState_GET()->interp;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000370 if (interp->modules == NULL)
371 Py_FatalError("PyImport_GetModuleDict: no module dictionary!");
372 return interp->modules;
373}
374
Guido van Rossum3f5da241990-12-20 15:06:42 +0000375
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000376/* List of names to clear in sys */
377static char* sys_deletes[] = {
Collin Winter670e6922007-03-21 02:57:17 +0000378 "path", "argv", "ps1", "ps2",
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000379 "last_type", "last_value", "last_traceback",
Just van Rossum52e14d62002-12-30 22:08:05 +0000380 "path_hooks", "path_importer_cache", "meta_path",
Christian Heimes7b3ce6a2008-01-31 14:31:45 +0000381 /* misc stuff */
382 "flags", "float_info",
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000383 NULL
384};
385
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000386static char* sys_files[] = {
387 "stdin", "__stdin__",
388 "stdout", "__stdout__",
389 "stderr", "__stderr__",
390 NULL
391};
392
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000393
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000394/* Un-initialize things, as good as we can */
Guido van Rossum3f5da241990-12-20 15:06:42 +0000395
Guido van Rossum3f5da241990-12-20 15:06:42 +0000396void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000397PyImport_Cleanup(void)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000398{
Martin v. Löwis18e16552006-02-15 17:27:45 +0000399 Py_ssize_t pos, ndone;
Guido van Rossum758eec01998-01-19 21:58:26 +0000400 char *name;
401 PyObject *key, *value, *dict;
Nicholas Bastine5662ae2004-03-24 22:22:12 +0000402 PyInterpreterState *interp = PyThreadState_GET()->interp;
Guido van Rossum758eec01998-01-19 21:58:26 +0000403 PyObject *modules = interp->modules;
404
405 if (modules == NULL)
406 return; /* Already done */
407
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000408 /* Delete some special variables first. These are common
409 places where user values hide and people complain when their
410 destructors fail. Since the modules containing them are
411 deleted *last* of all, they would come too late in the normal
412 destruction order. Sigh. */
413
Georg Brandl1a3284e2007-12-02 09:40:06 +0000414 value = PyDict_GetItemString(modules, "builtins");
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000415 if (value != NULL && PyModule_Check(value)) {
416 dict = PyModule_GetDict(value);
417 if (Py_VerboseFlag)
Georg Brandl1a3284e2007-12-02 09:40:06 +0000418 PySys_WriteStderr("# clear builtins._\n");
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000419 PyDict_SetItemString(dict, "_", Py_None);
420 }
421 value = PyDict_GetItemString(modules, "sys");
422 if (value != NULL && PyModule_Check(value)) {
423 char **p;
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000424 PyObject *v;
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000425 dict = PyModule_GetDict(value);
426 for (p = sys_deletes; *p != NULL; p++) {
427 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000428 PySys_WriteStderr("# clear sys.%s\n", *p);
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000429 PyDict_SetItemString(dict, *p, Py_None);
430 }
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000431 for (p = sys_files; *p != NULL; p+=2) {
432 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000433 PySys_WriteStderr("# restore sys.%s\n", *p);
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000434 v = PyDict_GetItemString(dict, *(p+1));
435 if (v == NULL)
436 v = Py_None;
437 PyDict_SetItemString(dict, *p, v);
438 }
439 }
440
441 /* First, delete __main__ */
442 value = PyDict_GetItemString(modules, "__main__");
443 if (value != NULL && PyModule_Check(value)) {
444 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000445 PySys_WriteStderr("# cleanup __main__\n");
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000446 _PyModule_Clear(value);
447 PyDict_SetItemString(modules, "__main__", Py_None);
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000448 }
449
Georg Brandl1a3284e2007-12-02 09:40:06 +0000450 /* The special treatment of "builtins" here is because even
Guido van Rossum758eec01998-01-19 21:58:26 +0000451 when it's not referenced as a module, its dictionary is
452 referenced by almost every module's __builtins__. Since
453 deleting a module clears its dictionary (even if there are
Georg Brandl1a3284e2007-12-02 09:40:06 +0000454 references left to it), we need to delete the "builtins"
Guido van Rossum758eec01998-01-19 21:58:26 +0000455 module last. Likewise, we don't delete sys until the very
456 end because it is implicitly referenced (e.g. by print).
457
458 Also note that we 'delete' modules by replacing their entry
459 in the modules dict with None, rather than really deleting
460 them; this avoids a rehash of the modules dictionary and
461 also marks them as "non existent" so they won't be
462 re-imported. */
463
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000464 /* Next, repeatedly delete modules with a reference count of
Georg Brandl1a3284e2007-12-02 09:40:06 +0000465 one (skipping builtins and sys) and delete them */
Guido van Rossum758eec01998-01-19 21:58:26 +0000466 do {
467 ndone = 0;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000468 pos = 0;
Guido van Rossum758eec01998-01-19 21:58:26 +0000469 while (PyDict_Next(modules, &pos, &key, &value)) {
470 if (value->ob_refcnt != 1)
471 continue;
Neal Norwitz80e7f272007-08-26 06:45:23 +0000472 if (PyUnicode_Check(key) && PyModule_Check(value)) {
473 name = PyUnicode_AsString(key);
Georg Brandl1a3284e2007-12-02 09:40:06 +0000474 if (strcmp(name, "builtins") == 0)
Guido van Rossum758eec01998-01-19 21:58:26 +0000475 continue;
476 if (strcmp(name, "sys") == 0)
477 continue;
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000478 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000479 PySys_WriteStderr(
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000480 "# cleanup[1] %s\n", name);
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000481 _PyModule_Clear(value);
Guido van Rossum758eec01998-01-19 21:58:26 +0000482 PyDict_SetItem(modules, key, Py_None);
483 ndone++;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000484 }
485 }
Guido van Rossum758eec01998-01-19 21:58:26 +0000486 } while (ndone > 0);
487
Georg Brandl1a3284e2007-12-02 09:40:06 +0000488 /* Next, delete all modules (still skipping builtins and sys) */
Guido van Rossum758eec01998-01-19 21:58:26 +0000489 pos = 0;
490 while (PyDict_Next(modules, &pos, &key, &value)) {
Neal Norwitz80e7f272007-08-26 06:45:23 +0000491 if (PyUnicode_Check(key) && PyModule_Check(value)) {
492 name = PyUnicode_AsString(key);
Georg Brandl1a3284e2007-12-02 09:40:06 +0000493 if (strcmp(name, "builtins") == 0)
Guido van Rossum758eec01998-01-19 21:58:26 +0000494 continue;
495 if (strcmp(name, "sys") == 0)
496 continue;
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000497 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000498 PySys_WriteStderr("# cleanup[2] %s\n", name);
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000499 _PyModule_Clear(value);
Guido van Rossum758eec01998-01-19 21:58:26 +0000500 PyDict_SetItem(modules, key, Py_None);
501 }
502 }
503
Georg Brandl1a3284e2007-12-02 09:40:06 +0000504 /* Next, delete sys and builtins (in that order) */
Guido van Rossum758eec01998-01-19 21:58:26 +0000505 value = PyDict_GetItemString(modules, "sys");
506 if (value != NULL && PyModule_Check(value)) {
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000507 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000508 PySys_WriteStderr("# cleanup sys\n");
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000509 _PyModule_Clear(value);
Guido van Rossum758eec01998-01-19 21:58:26 +0000510 PyDict_SetItemString(modules, "sys", Py_None);
511 }
Georg Brandl1a3284e2007-12-02 09:40:06 +0000512 value = PyDict_GetItemString(modules, "builtins");
Guido van Rossum758eec01998-01-19 21:58:26 +0000513 if (value != NULL && PyModule_Check(value)) {
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000514 if (Py_VerboseFlag)
Georg Brandl1a3284e2007-12-02 09:40:06 +0000515 PySys_WriteStderr("# cleanup builtins\n");
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000516 _PyModule_Clear(value);
Georg Brandl1a3284e2007-12-02 09:40:06 +0000517 PyDict_SetItemString(modules, "builtins", Py_None);
Guido van Rossum758eec01998-01-19 21:58:26 +0000518 }
519
520 /* Finally, clear and delete the modules directory */
521 PyDict_Clear(modules);
522 interp->modules = NULL;
523 Py_DECREF(modules);
Guido van Rossumd8faa362007-04-27 19:54:29 +0000524 Py_CLEAR(interp->modules_reloading);
Guido van Rossum8d15b5d1990-10-26 14:58:58 +0000525}
Guido van Rossum7f133ed1991-02-19 12:23:57 +0000526
527
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000528/* Helper for pythonrun.c -- return magic number */
529
530long
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000531PyImport_GetMagicNumber(void)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000532{
Guido van Rossum96774c12000-05-01 20:19:08 +0000533 return pyc_magic;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000534}
535
536
Guido van Rossum25ce5661997-08-02 03:10:38 +0000537/* Magic for extension modules (built-in as well as dynamically
538 loaded). To prevent initializing an extension module more than
539 once, we keep a static dictionary 'extensions' keyed by module name
540 (for built-in modules) or by filename (for dynamically loaded
Barry Warsaw92883382001-08-13 23:05:44 +0000541 modules), containing these modules. A copy of the module's
Guido van Rossum25ce5661997-08-02 03:10:38 +0000542 dictionary is stored by calling _PyImport_FixupExtension()
543 immediately after the module initialization function succeeds. A
544 copy can be retrieved from there by calling
Martin v. Löwis1a214512008-06-11 05:26:20 +0000545 _PyImport_FindExtension().
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000546
Martin v. Löwis1a214512008-06-11 05:26:20 +0000547 Modules which do support multiple multiple initialization set
548 their m_size field to a non-negative number (indicating the size
549 of the module-specific state). They are still recorded in the
550 extensions dictionary, to avoid loading shared libraries twice.
551*/
552
553int
554_PyImport_FixupExtension(PyObject *mod, char *name, char *filename)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000555{
Martin v. Löwis1a214512008-06-11 05:26:20 +0000556 PyObject *modules, *dict;
557 struct PyModuleDef *def;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000558 if (extensions == NULL) {
559 extensions = PyDict_New();
560 if (extensions == NULL)
Martin v. Löwis1a214512008-06-11 05:26:20 +0000561 return -1;
562 }
563 if (mod == NULL || !PyModule_Check(mod)) {
564 PyErr_BadInternalCall();
565 return -1;
566 }
567 def = PyModule_GetDef(mod);
568 if (!def) {
569 PyErr_BadInternalCall();
570 return -1;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000571 }
572 modules = PyImport_GetModuleDict();
Martin v. Löwis1a214512008-06-11 05:26:20 +0000573 if (PyDict_SetItemString(modules, name, mod) < 0)
574 return -1;
575 if (_PyState_AddModule(mod, def) < 0) {
576 PyDict_DelItemString(modules, name);
577 return -1;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000578 }
Martin v. Löwis1a214512008-06-11 05:26:20 +0000579 if (def->m_size == -1) {
580 if (def->m_base.m_copy) {
581 /* Somebody already imported the module,
582 likely under a different name.
583 XXX this should really not happen. */
584 Py_DECREF(def->m_base.m_copy);
585 def->m_base.m_copy = NULL;
586 }
587 dict = PyModule_GetDict(mod);
588 if (dict == NULL)
589 return -1;
590 def->m_base.m_copy = PyDict_Copy(dict);
591 if (def->m_base.m_copy == NULL)
592 return -1;
593 }
594 PyDict_SetItemString(extensions, filename, (PyObject*)def);
595 return 0;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000596}
597
598PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000599_PyImport_FindExtension(char *name, char *filename)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000600{
Martin v. Löwis1a214512008-06-11 05:26:20 +0000601 PyObject *mod, *mdict;
602 PyModuleDef* def;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000603 if (extensions == NULL)
604 return NULL;
Martin v. Löwis1a214512008-06-11 05:26:20 +0000605 def = (PyModuleDef*)PyDict_GetItemString(extensions, filename);
606 if (def == NULL)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000607 return NULL;
Martin v. Löwis1a214512008-06-11 05:26:20 +0000608 if (def->m_size == -1) {
609 /* Module does not support repeated initialization */
610 if (def->m_base.m_copy == NULL)
611 return NULL;
612 mod = PyImport_AddModule(name);
613 if (mod == NULL)
614 return NULL;
615 Py_INCREF(mod);
616 mdict = PyModule_GetDict(mod);
617 if (mdict == NULL)
618 return NULL;
619 if (PyDict_Update(mdict, def->m_base.m_copy))
620 return NULL;
621 }
622 else {
623 if (def->m_base.m_init == NULL)
624 return NULL;
625 mod = def->m_base.m_init();
626 if (mod == NULL)
627 return NULL;
628 PyDict_SetItemString(PyImport_GetModuleDict(), name, mod);
629 }
630 if (_PyState_AddModule(mod, def) < 0) {
631 PyDict_DelItemString(PyImport_GetModuleDict(), name);
632 Py_DECREF(mod);
Guido van Rossum25ce5661997-08-02 03:10:38 +0000633 return NULL;
Martin v. Löwis1a214512008-06-11 05:26:20 +0000634 }
Guido van Rossum25ce5661997-08-02 03:10:38 +0000635 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000636 PySys_WriteStderr("import %s # previously loaded (%s)\n",
Martin v. Löwis1a214512008-06-11 05:26:20 +0000637 name, filename);
Guido van Rossum25ce5661997-08-02 03:10:38 +0000638 return mod;
Martin v. Löwis1a214512008-06-11 05:26:20 +0000639
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000640}
641
642
643/* Get the module object corresponding to a module name.
644 First check the modules dictionary if there's one there,
Walter Dörwaldf0dfc7a2003-10-20 14:01:56 +0000645 if not, create a new one and insert it in the modules dictionary.
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000646 Because the former action is most common, THIS DOES NOT RETURN A
647 'NEW' REFERENCE! */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000648
Guido van Rossum79f25d91997-04-29 20:08:16 +0000649PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000650PyImport_AddModule(const char *name)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000651{
Guido van Rossum25ce5661997-08-02 03:10:38 +0000652 PyObject *modules = PyImport_GetModuleDict();
Guido van Rossum79f25d91997-04-29 20:08:16 +0000653 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000654
Guido van Rossum25ce5661997-08-02 03:10:38 +0000655 if ((m = PyDict_GetItemString(modules, name)) != NULL &&
Guido van Rossum79f25d91997-04-29 20:08:16 +0000656 PyModule_Check(m))
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000657 return m;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000658 m = PyModule_New(name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000659 if (m == NULL)
660 return NULL;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000661 if (PyDict_SetItemString(modules, name, m) != 0) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000662 Py_DECREF(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000663 return NULL;
664 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000665 Py_DECREF(m); /* Yes, it still exists, in modules! */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000666
667 return m;
668}
669
Tim Peters1cd70172004-08-02 03:52:12 +0000670/* Remove name from sys.modules, if it's there. */
671static void
672_RemoveModule(const char *name)
673{
674 PyObject *modules = PyImport_GetModuleDict();
675 if (PyDict_GetItemString(modules, name) == NULL)
676 return;
677 if (PyDict_DelItemString(modules, name) < 0)
678 Py_FatalError("import: deleting existing key in"
679 "sys.modules failed");
680}
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000681
Christian Heimes3b06e532008-01-07 20:12:44 +0000682static PyObject * get_sourcefile(const char *file);
683
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000684/* Execute a code object in a module and return the module object
Tim Peters1cd70172004-08-02 03:52:12 +0000685 * WITH INCREMENTED REFERENCE COUNT. If an error occurs, name is
686 * removed from sys.modules, to avoid leaving damaged module objects
687 * in sys.modules. The caller may wish to restore the original
688 * module object (if any) in this case; PyImport_ReloadModule is an
689 * example.
690 */
Guido van Rossum79f25d91997-04-29 20:08:16 +0000691PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000692PyImport_ExecCodeModule(char *name, PyObject *co)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000693{
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000694 return PyImport_ExecCodeModuleEx(name, co, (char *)NULL);
695}
696
697PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000698PyImport_ExecCodeModuleEx(char *name, PyObject *co, char *pathname)
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000699{
Guido van Rossum25ce5661997-08-02 03:10:38 +0000700 PyObject *modules = PyImport_GetModuleDict();
Guido van Rossum79f25d91997-04-29 20:08:16 +0000701 PyObject *m, *d, *v;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000702
Guido van Rossum79f25d91997-04-29 20:08:16 +0000703 m = PyImport_AddModule(name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000704 if (m == NULL)
705 return NULL;
Jeremy Hyltonecd91292004-01-02 23:25:32 +0000706 /* If the module is being reloaded, we get the old module back
707 and re-use its dict to exec the new code. */
Guido van Rossum79f25d91997-04-29 20:08:16 +0000708 d = PyModule_GetDict(m);
709 if (PyDict_GetItemString(d, "__builtins__") == NULL) {
710 if (PyDict_SetItemString(d, "__builtins__",
711 PyEval_GetBuiltins()) != 0)
Tim Peters1cd70172004-08-02 03:52:12 +0000712 goto error;
Guido van Rossum6135a871995-01-09 17:53:26 +0000713 }
Guido van Rossum9c9a07c1996-05-16 20:43:40 +0000714 /* Remember the filename as the __file__ attribute */
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000715 v = NULL;
716 if (pathname != NULL) {
Christian Heimes3b06e532008-01-07 20:12:44 +0000717 v = get_sourcefile(pathname);
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000718 if (v == NULL)
719 PyErr_Clear();
720 }
721 if (v == NULL) {
722 v = ((PyCodeObject *)co)->co_filename;
723 Py_INCREF(v);
724 }
725 if (PyDict_SetItemString(d, "__file__", v) != 0)
Guido van Rossum79f25d91997-04-29 20:08:16 +0000726 PyErr_Clear(); /* Not important enough to report */
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000727 Py_DECREF(v);
728
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000729 v = PyEval_EvalCode((PyCodeObject *)co, d, d);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000730 if (v == NULL)
Tim Peters1cd70172004-08-02 03:52:12 +0000731 goto error;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000732 Py_DECREF(v);
Guido van Rossumb65e85c1997-07-10 18:00:45 +0000733
Guido van Rossum25ce5661997-08-02 03:10:38 +0000734 if ((m = PyDict_GetItemString(modules, name)) == NULL) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000735 PyErr_Format(PyExc_ImportError,
736 "Loaded module %.200s not found in sys.modules",
737 name);
Guido van Rossumb65e85c1997-07-10 18:00:45 +0000738 return NULL;
739 }
740
Guido van Rossum79f25d91997-04-29 20:08:16 +0000741 Py_INCREF(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000742
743 return m;
Tim Peters1cd70172004-08-02 03:52:12 +0000744
745 error:
746 _RemoveModule(name);
747 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000748}
749
750
751/* Given a pathname for a Python source file, fill a buffer with the
752 pathname for the corresponding compiled file. Return the pathname
753 for the compiled file, or NULL if there's no space in the buffer.
754 Doesn't set an exception. */
755
756static char *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000757make_compiled_pathname(char *pathname, char *buf, size_t buflen)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000758{
Tim Petersc1731372001-08-04 08:12:36 +0000759 size_t len = strlen(pathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000760 if (len+2 > buflen)
761 return NULL;
Tim Petersc1731372001-08-04 08:12:36 +0000762
Martin v. Löwis6238d2b2002-06-30 15:26:10 +0000763#ifdef MS_WINDOWS
Tim Petersc1731372001-08-04 08:12:36 +0000764 /* Treat .pyw as if it were .py. The case of ".pyw" must match
765 that used in _PyImport_StandardFiletab. */
766 if (len >= 4 && strcmp(&pathname[len-4], ".pyw") == 0)
767 --len; /* pretend 'w' isn't there */
768#endif
769 memcpy(buf, pathname, len);
770 buf[len] = Py_OptimizeFlag ? 'o' : 'c';
771 buf[len+1] = '\0';
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000772
773 return buf;
774}
775
776
777/* Given a pathname for a Python source file, its time of last
778 modification, and a pathname for a compiled file, check whether the
779 compiled file represents the same version of the source. If so,
780 return a FILE pointer for the compiled file, positioned just after
781 the header; if not, return NULL.
782 Doesn't set an exception. */
783
784static FILE *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000785check_compiled_module(char *pathname, time_t mtime, char *cpathname)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000786{
787 FILE *fp;
788 long magic;
789 long pyc_mtime;
790
791 fp = fopen(cpathname, "rb");
792 if (fp == NULL)
793 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000794 magic = PyMarshal_ReadLongFromFile(fp);
Guido van Rossum96774c12000-05-01 20:19:08 +0000795 if (magic != pyc_magic) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000796 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000797 PySys_WriteStderr("# %s has bad magic\n", cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000798 fclose(fp);
799 return NULL;
800 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000801 pyc_mtime = PyMarshal_ReadLongFromFile(fp);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000802 if (pyc_mtime != mtime) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000803 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000804 PySys_WriteStderr("# %s has bad mtime\n", cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000805 fclose(fp);
806 return NULL;
807 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000808 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000809 PySys_WriteStderr("# %s matches %s\n", cpathname, pathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000810 return fp;
811}
812
813
814/* Read a code object from a file and check it for validity */
815
Guido van Rossum79f25d91997-04-29 20:08:16 +0000816static PyCodeObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000817read_compiled_module(char *cpathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000818{
Guido van Rossum79f25d91997-04-29 20:08:16 +0000819 PyObject *co;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000820
Tim Petersd9b9ac82001-01-28 00:27:39 +0000821 co = PyMarshal_ReadLastObjectFromFile(fp);
Armin Rigo01ab2792004-03-26 15:09:27 +0000822 if (co == NULL)
823 return NULL;
824 if (!PyCode_Check(co)) {
825 PyErr_Format(PyExc_ImportError,
826 "Non-code object in %.200s", cpathname);
827 Py_DECREF(co);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000828 return NULL;
829 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000830 return (PyCodeObject *)co;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000831}
832
833
834/* Load a module from a compiled file, execute it, and return its
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000835 module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000836
Guido van Rossum79f25d91997-04-29 20:08:16 +0000837static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000838load_compiled_module(char *name, char *cpathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000839{
840 long magic;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000841 PyCodeObject *co;
842 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000843
Guido van Rossum79f25d91997-04-29 20:08:16 +0000844 magic = PyMarshal_ReadLongFromFile(fp);
Guido van Rossum96774c12000-05-01 20:19:08 +0000845 if (magic != pyc_magic) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000846 PyErr_Format(PyExc_ImportError,
847 "Bad magic number in %.200s", cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000848 return NULL;
849 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000850 (void) PyMarshal_ReadLongFromFile(fp);
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000851 co = read_compiled_module(cpathname, fp);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000852 if (co == NULL)
853 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000854 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000855 PySys_WriteStderr("import %s # precompiled from %s\n",
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000856 name, cpathname);
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000857 m = PyImport_ExecCodeModuleEx(name, (PyObject *)co, cpathname);
Guido van Rossum79f25d91997-04-29 20:08:16 +0000858 Py_DECREF(co);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000859
860 return m;
861}
862
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000863/* Parse a source file and return the corresponding code object */
864
Guido van Rossum79f25d91997-04-29 20:08:16 +0000865static PyCodeObject *
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000866parse_source_module(const char *pathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000867{
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000868 PyCodeObject *co = NULL;
869 mod_ty mod;
Christian Heimes4d6ec852008-03-26 22:34:47 +0000870 PyCompilerFlags flags;
Thomas Wouters89f507f2006-12-13 04:49:30 +0000871 PyArena *arena = PyArena_New();
872 if (arena == NULL)
873 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000874
Christian Heimesb1b3efc2008-03-26 23:24:27 +0000875 flags.cf_flags = 0;
Martin v. Löwis85bcc662007-09-04 09:18:06 +0000876 mod = PyParser_ASTFromFile(fp, pathname, NULL,
Christian Heimes4d6ec852008-03-26 22:34:47 +0000877 Py_file_input, 0, 0, &flags,
Neal Norwitzadb69fc2005-12-17 20:54:49 +0000878 NULL, arena);
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000879 if (mod) {
Neal Norwitzadb69fc2005-12-17 20:54:49 +0000880 co = PyAST_Compile(mod, pathname, NULL, arena);
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000881 }
Thomas Wouters89f507f2006-12-13 04:49:30 +0000882 PyArena_Free(arena);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000883 return co;
884}
885
886
Guido van Rossum55a83382000-09-20 20:31:38 +0000887/* Helper to open a bytecode file for writing in exclusive mode */
888
889static FILE *
Christian Heimes05e8be12008-02-23 18:30:17 +0000890open_exclusive(char *filename, mode_t mode)
Guido van Rossum55a83382000-09-20 20:31:38 +0000891{
892#if defined(O_EXCL)&&defined(O_CREAT)&&defined(O_WRONLY)&&defined(O_TRUNC)
893 /* Use O_EXCL to avoid a race condition when another process tries to
894 write the same file. When that happens, our open() call fails,
895 which is just fine (since it's only a cache).
896 XXX If the file exists and is writable but the directory is not
897 writable, the file will never be written. Oh well.
898 */
899 int fd;
900 (void) unlink(filename);
Tim Peters42c83af2000-09-29 04:03:10 +0000901 fd = open(filename, O_EXCL|O_CREAT|O_WRONLY|O_TRUNC
902#ifdef O_BINARY
903 |O_BINARY /* necessary for Windows */
904#endif
Martin v. Löwis79acb9e2002-12-06 12:48:53 +0000905#ifdef __VMS
Christian Heimes05e8be12008-02-23 18:30:17 +0000906 , mode, "ctxt=bin", "shr=nil"
Martin v. Löwis79acb9e2002-12-06 12:48:53 +0000907#else
Christian Heimes05e8be12008-02-23 18:30:17 +0000908 , mode
Martin v. Löwis79acb9e2002-12-06 12:48:53 +0000909#endif
Martin v. Löwis18e16552006-02-15 17:27:45 +0000910 );
Guido van Rossum55a83382000-09-20 20:31:38 +0000911 if (fd < 0)
912 return NULL;
913 return fdopen(fd, "wb");
914#else
915 /* Best we can do -- on Windows this can't happen anyway */
916 return fopen(filename, "wb");
917#endif
918}
919
920
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000921/* Write a compiled module to a file, placing the time of last
922 modification of its source into the header.
923 Errors are ignored, if a write error occurs an attempt is made to
924 remove the file. */
925
926static void
Christian Heimes05e8be12008-02-23 18:30:17 +0000927write_compiled_module(PyCodeObject *co, char *cpathname, struct stat *srcstat)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000928{
929 FILE *fp;
Christian Heimes05e8be12008-02-23 18:30:17 +0000930 time_t mtime = srcstat->st_mtime;
931 mode_t mode = srcstat->st_mode;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000932
Christian Heimes05e8be12008-02-23 18:30:17 +0000933 fp = open_exclusive(cpathname, mode);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000934 if (fp == NULL) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000935 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000936 PySys_WriteStderr(
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000937 "# can't create %s\n", cpathname);
938 return;
939 }
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000940 PyMarshal_WriteLongToFile(pyc_magic, fp, Py_MARSHAL_VERSION);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000941 /* First write a 0 for mtime */
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000942 PyMarshal_WriteLongToFile(0L, fp, Py_MARSHAL_VERSION);
943 PyMarshal_WriteObjectToFile((PyObject *)co, fp, Py_MARSHAL_VERSION);
Armin Rigo01ab2792004-03-26 15:09:27 +0000944 if (fflush(fp) != 0 || ferror(fp)) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000945 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000946 PySys_WriteStderr("# can't write %s\n", cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000947 /* Don't keep partial file */
948 fclose(fp);
949 (void) unlink(cpathname);
950 return;
951 }
952 /* Now write the true mtime */
953 fseek(fp, 4L, 0);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000954 assert(mtime < LONG_MAX);
Martin v. Löwis725507b2006-03-07 12:08:51 +0000955 PyMarshal_WriteLongToFile((long)mtime, fp, Py_MARSHAL_VERSION);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000956 fflush(fp);
957 fclose(fp);
Guido van Rossum79f25d91997-04-29 20:08:16 +0000958 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000959 PySys_WriteStderr("# wrote %s\n", cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000960}
961
962
963/* Load a source module from a given file and return its module
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000964 object WITH INCREMENTED REFERENCE COUNT. If there's a matching
965 byte-compiled file, use that instead. */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000966
Guido van Rossum79f25d91997-04-29 20:08:16 +0000967static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000968load_source_module(char *name, char *pathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000969{
Christian Heimes05e8be12008-02-23 18:30:17 +0000970 struct stat st;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000971 FILE *fpc;
972 char buf[MAXPATHLEN+1];
973 char *cpathname;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000974 PyCodeObject *co;
975 PyObject *m;
Christian Heimes05e8be12008-02-23 18:30:17 +0000976
977 if (fstat(fileno(fp), &st) != 0) {
Neal Norwitz708e51a2005-10-03 04:48:15 +0000978 PyErr_Format(PyExc_RuntimeError,
Christian Heimes05e8be12008-02-23 18:30:17 +0000979 "unable to get file status from '%s'",
Neal Norwitz708e51a2005-10-03 04:48:15 +0000980 pathname);
Fred Drake4c82b232000-06-30 16:18:57 +0000981 return NULL;
Neal Norwitz708e51a2005-10-03 04:48:15 +0000982 }
Fred Drake4c82b232000-06-30 16:18:57 +0000983#if SIZEOF_TIME_T > 4
984 /* Python's .pyc timestamp handling presumes that the timestamp fits
985 in 4 bytes. This will be fine until sometime in the year 2038,
986 when a 4-byte signed time_t will overflow.
987 */
Christian Heimes05e8be12008-02-23 18:30:17 +0000988 if (st.st_mtime >> 32) {
Fred Drake4c82b232000-06-30 16:18:57 +0000989 PyErr_SetString(PyExc_OverflowError,
Fred Drakec63d3e92001-03-01 06:33:32 +0000990 "modification time overflows a 4 byte field");
Fred Drake4c82b232000-06-30 16:18:57 +0000991 return NULL;
992 }
993#endif
Tim Peters36515e22001-11-18 04:06:29 +0000994 cpathname = make_compiled_pathname(pathname, buf,
Jeremy Hylton37832f02001-04-13 17:50:20 +0000995 (size_t)MAXPATHLEN + 1);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000996 if (cpathname != NULL &&
Christian Heimes05e8be12008-02-23 18:30:17 +0000997 (fpc = check_compiled_module(pathname, st.st_mtime, cpathname))) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000998 co = read_compiled_module(cpathname, fpc);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000999 fclose(fpc);
1000 if (co == NULL)
1001 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +00001002 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +00001003 PySys_WriteStderr("import %s # precompiled from %s\n",
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001004 name, cpathname);
Guido van Rossumafd3dae1998-08-25 18:44:34 +00001005 pathname = cpathname;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001006 }
1007 else {
1008 co = parse_source_module(pathname, fp);
1009 if (co == NULL)
1010 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +00001011 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +00001012 PySys_WriteStderr("import %s # from %s\n",
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001013 name, pathname);
Christian Heimes790c8232008-01-07 21:14:23 +00001014 if (cpathname) {
1015 PyObject *ro = PySys_GetObject("dont_write_bytecode");
1016 if (ro == NULL || !PyObject_IsTrue(ro))
Christian Heimes05e8be12008-02-23 18:30:17 +00001017 write_compiled_module(co, cpathname, &st);
Christian Heimes790c8232008-01-07 21:14:23 +00001018 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001019 }
Guido van Rossumafd3dae1998-08-25 18:44:34 +00001020 m = PyImport_ExecCodeModuleEx(name, (PyObject *)co, pathname);
Guido van Rossum79f25d91997-04-29 20:08:16 +00001021 Py_DECREF(co);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001022
1023 return m;
1024}
1025
Christian Heimes3b06e532008-01-07 20:12:44 +00001026/* Get source file -> unicode or None
1027 * Returns the path to the py file if available, else the given path
1028 */
1029static PyObject *
1030get_sourcefile(const char *file)
1031{
1032 char py[MAXPATHLEN + 1];
1033 Py_ssize_t len;
1034 PyObject *u;
1035 struct stat statbuf;
1036
1037 if (!file || !*file) {
1038 Py_RETURN_NONE;
1039 }
1040
1041 len = strlen(file);
Christian Heimes3540b502008-01-11 07:03:05 +00001042 /* match '*.py?' */
1043 if (len > MAXPATHLEN || PyOS_strnicmp(&file[len-4], ".py", 3) != 0) {
Christian Heimes3b06e532008-01-07 20:12:44 +00001044 return PyUnicode_DecodeFSDefault(file);
1045 }
1046
1047 strncpy(py, file, len-1);
Martin v. Löwis5021ebc2008-03-22 22:07:13 +00001048 py[len-1] = '\0';
Christian Heimes3b06e532008-01-07 20:12:44 +00001049 if (stat(py, &statbuf) == 0 &&
1050 S_ISREG(statbuf.st_mode)) {
1051 u = PyUnicode_DecodeFSDefault(py);
1052 }
1053 else {
1054 u = PyUnicode_DecodeFSDefault(file);
1055 }
1056 return u;
1057}
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001058
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001059/* Forward */
Just van Rossum52e14d62002-12-30 22:08:05 +00001060static PyObject *load_module(char *, FILE *, char *, int, PyObject *);
1061static struct filedescr *find_module(char *, char *, PyObject *,
1062 char *, size_t, FILE **, PyObject **);
Christian Heimes3b06e532008-01-07 20:12:44 +00001063static struct _frozen * find_frozen(char *);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001064
1065/* Load a package and return its module object WITH INCREMENTED
1066 REFERENCE COUNT */
1067
1068static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001069load_package(char *name, char *pathname)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001070{
Tim Peters1cd70172004-08-02 03:52:12 +00001071 PyObject *m, *d;
1072 PyObject *file = NULL;
1073 PyObject *path = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001074 int err;
1075 char buf[MAXPATHLEN+1];
1076 FILE *fp = NULL;
1077 struct filedescr *fdp;
1078
1079 m = PyImport_AddModule(name);
1080 if (m == NULL)
1081 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00001082 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +00001083 PySys_WriteStderr("import %s # directory %s\n",
Guido van Rossum17fc85f1997-09-06 18:52:03 +00001084 name, pathname);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001085 d = PyModule_GetDict(m);
Christian Heimes3b06e532008-01-07 20:12:44 +00001086 file = get_sourcefile(pathname);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001087 if (file == NULL)
Tim Peters1cd70172004-08-02 03:52:12 +00001088 goto error;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001089 path = Py_BuildValue("[O]", file);
Tim Peters1cd70172004-08-02 03:52:12 +00001090 if (path == NULL)
1091 goto error;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001092 err = PyDict_SetItemString(d, "__file__", file);
1093 if (err == 0)
1094 err = PyDict_SetItemString(d, "__path__", path);
Tim Peters1cd70172004-08-02 03:52:12 +00001095 if (err != 0)
1096 goto error;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001097 buf[0] = '\0';
Just van Rossum52e14d62002-12-30 22:08:05 +00001098 fdp = find_module(name, "__init__", path, buf, sizeof(buf), &fp, NULL);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001099 if (fdp == NULL) {
1100 if (PyErr_ExceptionMatches(PyExc_ImportError)) {
1101 PyErr_Clear();
Thomas Heller25653242004-06-07 15:04:10 +00001102 Py_INCREF(m);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001103 }
1104 else
1105 m = NULL;
1106 goto cleanup;
1107 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001108 m = load_module(name, fp, buf, fdp->type, NULL);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001109 if (fp != NULL)
1110 fclose(fp);
Tim Peters1cd70172004-08-02 03:52:12 +00001111 goto cleanup;
1112
1113 error:
1114 m = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001115 cleanup:
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001116 Py_XDECREF(path);
1117 Py_XDECREF(file);
1118 return m;
1119}
1120
1121
1122/* Helper to test for built-in module */
1123
1124static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001125is_builtin(char *name)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001126{
1127 int i;
Guido van Rossum771c6c81997-10-31 18:37:24 +00001128 for (i = 0; PyImport_Inittab[i].name != NULL; i++) {
1129 if (strcmp(name, PyImport_Inittab[i].name) == 0) {
1130 if (PyImport_Inittab[i].initfunc == NULL)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001131 return -1;
1132 else
1133 return 1;
1134 }
1135 }
1136 return 0;
1137}
1138
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001139
Just van Rossum52e14d62002-12-30 22:08:05 +00001140/* Return an importer object for a sys.path/pkg.__path__ item 'p',
1141 possibly by fetching it from the path_importer_cache dict. If it
Thomas Wouters89f507f2006-12-13 04:49:30 +00001142 wasn't yet cached, traverse path_hooks until a hook is found
Just van Rossum52e14d62002-12-30 22:08:05 +00001143 that can handle the path item. Return None if no hook could;
1144 this tells our caller it should fall back to the builtin
1145 import mechanism. Cache the result in path_importer_cache.
1146 Returns a borrowed reference. */
1147
1148static PyObject *
1149get_path_importer(PyObject *path_importer_cache, PyObject *path_hooks,
1150 PyObject *p)
1151{
1152 PyObject *importer;
Martin v. Löwis725507b2006-03-07 12:08:51 +00001153 Py_ssize_t j, nhooks;
Just van Rossum52e14d62002-12-30 22:08:05 +00001154
1155 /* These conditions are the caller's responsibility: */
1156 assert(PyList_Check(path_hooks));
1157 assert(PyDict_Check(path_importer_cache));
1158
1159 nhooks = PyList_Size(path_hooks);
1160 if (nhooks < 0)
1161 return NULL; /* Shouldn't happen */
1162
1163 importer = PyDict_GetItem(path_importer_cache, p);
1164 if (importer != NULL)
1165 return importer;
1166
1167 /* set path_importer_cache[p] to None to avoid recursion */
1168 if (PyDict_SetItem(path_importer_cache, p, Py_None) != 0)
1169 return NULL;
1170
1171 for (j = 0; j < nhooks; j++) {
1172 PyObject *hook = PyList_GetItem(path_hooks, j);
1173 if (hook == NULL)
1174 return NULL;
Thomas Wouters477c8d52006-05-27 19:21:47 +00001175 importer = PyObject_CallFunctionObjArgs(hook, p, NULL);
Just van Rossum52e14d62002-12-30 22:08:05 +00001176 if (importer != NULL)
1177 break;
1178
1179 if (!PyErr_ExceptionMatches(PyExc_ImportError)) {
1180 return NULL;
1181 }
1182 PyErr_Clear();
1183 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001184 if (importer == NULL) {
1185 importer = PyObject_CallFunctionObjArgs(
Christian Heimes9cd17752007-11-18 19:35:23 +00001186 (PyObject *)&PyNullImporter_Type, p, NULL
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001187 );
1188 if (importer == NULL) {
1189 if (PyErr_ExceptionMatches(PyExc_ImportError)) {
1190 PyErr_Clear();
1191 return Py_None;
1192 }
1193 }
1194 }
1195 if (importer != NULL) {
Just van Rossum52e14d62002-12-30 22:08:05 +00001196 int err = PyDict_SetItem(path_importer_cache, p, importer);
1197 Py_DECREF(importer);
1198 if (err != 0)
1199 return NULL;
1200 }
1201 return importer;
1202}
1203
Christian Heimes9cd17752007-11-18 19:35:23 +00001204PyAPI_FUNC(PyObject *)
1205PyImport_GetImporter(PyObject *path) {
1206 PyObject *importer=NULL, *path_importer_cache=NULL, *path_hooks=NULL;
1207
1208 if ((path_importer_cache = PySys_GetObject("path_importer_cache"))) {
1209 if ((path_hooks = PySys_GetObject("path_hooks"))) {
1210 importer = get_path_importer(path_importer_cache,
1211 path_hooks, path);
1212 }
1213 }
1214 Py_XINCREF(importer); /* get_path_importer returns a borrowed reference */
1215 return importer;
1216}
1217
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001218/* Search the path (default sys.path) for a module. Return the
1219 corresponding filedescr struct, and (via return arguments) the
1220 pathname and an open file. Return NULL if the module is not found. */
1221
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001222#ifdef MS_COREDLL
Thomas Woutersb4bd21c2000-07-22 23:38:01 +00001223extern FILE *PyWin_FindRegisteredModule(const char *, struct filedescr **,
Martin v. Löwis18e16552006-02-15 17:27:45 +00001224 char *, Py_ssize_t);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001225#endif
1226
Martin v. Löwis18e16552006-02-15 17:27:45 +00001227static int case_ok(char *, Py_ssize_t, Py_ssize_t, char *);
Tim Petersdbd9ba62000-07-09 03:09:57 +00001228static int find_init_module(char *); /* Forward */
Just van Rossum52e14d62002-12-30 22:08:05 +00001229static struct filedescr importhookdescr = {"", "", IMP_HOOK};
Guido van Rossum197346f1997-10-31 18:38:52 +00001230
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001231static struct filedescr *
Just van Rossum52e14d62002-12-30 22:08:05 +00001232find_module(char *fullname, char *subname, PyObject *path, char *buf,
1233 size_t buflen, FILE **p_fp, PyObject **p_loader)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001234{
Martin v. Löwis725507b2006-03-07 12:08:51 +00001235 Py_ssize_t i, npath;
Fred Drake4c82b232000-06-30 16:18:57 +00001236 size_t len, namelen;
Guido van Rossum80bb9651996-12-05 23:27:02 +00001237 struct filedescr *fdp = NULL;
Jack Jansenc88da1f2002-05-28 10:58:19 +00001238 char *filemode;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001239 FILE *fp = NULL;
Just van Rossum52e14d62002-12-30 22:08:05 +00001240 PyObject *path_hooks, *path_importer_cache;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001241 struct stat statbuf;
Guido van Rossuma5568d31998-03-05 03:45:08 +00001242 static struct filedescr fd_frozen = {"", "", PY_FROZEN};
1243 static struct filedescr fd_builtin = {"", "", C_BUILTIN};
1244 static struct filedescr fd_package = {"", "", PKG_DIRECTORY};
Guido van Rossum0506a431998-08-11 15:07:39 +00001245 char name[MAXPATHLEN+1];
Andrew MacIntyred9400542002-02-26 11:41:34 +00001246#if defined(PYOS_OS2)
1247 size_t saved_len;
1248 size_t saved_namelen;
1249 char *saved_buf = NULL;
1250#endif
Just van Rossum52e14d62002-12-30 22:08:05 +00001251 if (p_loader != NULL)
1252 *p_loader = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001253
Just van Rossum52e14d62002-12-30 22:08:05 +00001254 if (strlen(subname) > MAXPATHLEN) {
Guido van Rossum8f4d3312001-10-18 18:54:11 +00001255 PyErr_SetString(PyExc_OverflowError,
1256 "module name is too long");
Fred Drake4c82b232000-06-30 16:18:57 +00001257 return NULL;
1258 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001259 strcpy(name, subname);
1260
1261 /* sys.meta_path import hook */
1262 if (p_loader != NULL) {
1263 PyObject *meta_path;
1264
1265 meta_path = PySys_GetObject("meta_path");
1266 if (meta_path == NULL || !PyList_Check(meta_path)) {
1267 PyErr_SetString(PyExc_ImportError,
1268 "sys.meta_path must be a list of "
1269 "import hooks");
1270 return NULL;
1271 }
1272 Py_INCREF(meta_path); /* zap guard */
1273 npath = PyList_Size(meta_path);
1274 for (i = 0; i < npath; i++) {
1275 PyObject *loader;
1276 PyObject *hook = PyList_GetItem(meta_path, i);
1277 loader = PyObject_CallMethod(hook, "find_module",
1278 "sO", fullname,
1279 path != NULL ?
1280 path : Py_None);
1281 if (loader == NULL) {
1282 Py_DECREF(meta_path);
1283 return NULL; /* true error */
1284 }
1285 if (loader != Py_None) {
1286 /* a loader was found */
1287 *p_loader = loader;
1288 Py_DECREF(meta_path);
1289 return &importhookdescr;
1290 }
1291 Py_DECREF(loader);
1292 }
1293 Py_DECREF(meta_path);
1294 }
Guido van Rossum0506a431998-08-11 15:07:39 +00001295
Guido van Rossum13d77992007-07-23 03:16:50 +00001296 if (path != NULL && PyUnicode_Check(path)) {
Guido van Rossum8f4d3312001-10-18 18:54:11 +00001297 /* The only type of submodule allowed inside a "frozen"
1298 package are other frozen modules or packages. */
Guido van Rossum13d77992007-07-23 03:16:50 +00001299 char *p = PyUnicode_AsString(path);
1300 if (strlen(p) + 1 + strlen(name) >= (size_t)buflen) {
Guido van Rossum0506a431998-08-11 15:07:39 +00001301 PyErr_SetString(PyExc_ImportError,
1302 "full frozen module name too long");
1303 return NULL;
1304 }
Guido van Rossum13d77992007-07-23 03:16:50 +00001305 strcpy(buf, p);
Guido van Rossum0506a431998-08-11 15:07:39 +00001306 strcat(buf, ".");
1307 strcat(buf, name);
1308 strcpy(name, buf);
Guido van Rossum8f4d3312001-10-18 18:54:11 +00001309 if (find_frozen(name) != NULL) {
1310 strcpy(buf, name);
1311 return &fd_frozen;
1312 }
1313 PyErr_Format(PyExc_ImportError,
1314 "No frozen submodule named %.200s", name);
1315 return NULL;
Guido van Rossum0506a431998-08-11 15:07:39 +00001316 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001317 if (path == NULL) {
1318 if (is_builtin(name)) {
Guido van Rossuma5568d31998-03-05 03:45:08 +00001319 strcpy(buf, name);
1320 return &fd_builtin;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001321 }
Greg Ward201baee2001-10-04 14:52:06 +00001322 if ((find_frozen(name)) != NULL) {
Guido van Rossuma5568d31998-03-05 03:45:08 +00001323 strcpy(buf, name);
1324 return &fd_frozen;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001325 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001326
Guido van Rossumac279101996-08-22 23:10:58 +00001327#ifdef MS_COREDLL
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001328 fp = PyWin_FindRegisteredModule(name, &fdp, buf, buflen);
1329 if (fp != NULL) {
1330 *p_fp = fp;
1331 return fdp;
1332 }
Guido van Rossuma5a3db71996-04-09 02:39:59 +00001333#endif
Guido van Rossuma5568d31998-03-05 03:45:08 +00001334 path = PySys_GetObject("path");
1335 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00001336 if (path == NULL || !PyList_Check(path)) {
1337 PyErr_SetString(PyExc_ImportError,
Guido van Rossuma5568d31998-03-05 03:45:08 +00001338 "sys.path must be a list of directory names");
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001339 return NULL;
1340 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001341
1342 path_hooks = PySys_GetObject("path_hooks");
1343 if (path_hooks == NULL || !PyList_Check(path_hooks)) {
1344 PyErr_SetString(PyExc_ImportError,
1345 "sys.path_hooks must be a list of "
1346 "import hooks");
1347 return NULL;
1348 }
1349 path_importer_cache = PySys_GetObject("path_importer_cache");
1350 if (path_importer_cache == NULL ||
1351 !PyDict_Check(path_importer_cache)) {
1352 PyErr_SetString(PyExc_ImportError,
1353 "sys.path_importer_cache must be a dict");
1354 return NULL;
1355 }
1356
Guido van Rossum79f25d91997-04-29 20:08:16 +00001357 npath = PyList_Size(path);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001358 namelen = strlen(name);
1359 for (i = 0; i < npath; i++) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00001360 PyObject *v = PyList_GetItem(path, i);
Guido van Rossumf15a29f2007-05-04 00:41:39 +00001361 PyObject *origv = v;
Guido van Rossum6262cc72007-05-09 23:29:27 +00001362 const char *base;
Guido van Rossumf15a29f2007-05-04 00:41:39 +00001363 Py_ssize_t size;
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001364 if (!v)
1365 return NULL;
Guido van Rossuma4b8d1d2007-08-27 15:02:28 +00001366 if (PyUnicode_Check(v)) {
Amaury Forgeot d'Arcf1ca0b12008-06-11 17:40:47 +00001367 v = PyUnicode_AsEncodedString(v,
1368 Py_FileSystemDefaultEncoding, NULL);
Guido van Rossuma4b8d1d2007-08-27 15:02:28 +00001369 if (v == NULL)
1370 return NULL;
1371 }
Amaury Forgeot d'Arcf1ca0b12008-06-11 17:40:47 +00001372 else if (!PyBytes_Check(v))
Guido van Rossuma4b8d1d2007-08-27 15:02:28 +00001373 continue;
Amaury Forgeot d'Arcf1ca0b12008-06-11 17:40:47 +00001374 else
1375 Py_INCREF(v);
1376
Christian Heimes72b710a2008-05-26 13:28:38 +00001377 base = PyBytes_AS_STRING(v);
1378 size = PyBytes_GET_SIZE(v);
Guido van Rossumf15a29f2007-05-04 00:41:39 +00001379 len = size;
Walter Dörwald3430d702002-06-17 10:43:59 +00001380 if (len + 2 + namelen + MAXSUFFIXSIZE >= buflen) {
Amaury Forgeot d'Arcf1ca0b12008-06-11 17:40:47 +00001381 Py_DECREF(v);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001382 continue; /* Too long */
Walter Dörwald3430d702002-06-17 10:43:59 +00001383 }
Guido van Rossumf15a29f2007-05-04 00:41:39 +00001384 strcpy(buf, base);
Amaury Forgeot d'Arcf1ca0b12008-06-11 17:40:47 +00001385 Py_DECREF(v);
1386
Walter Dörwald3430d702002-06-17 10:43:59 +00001387 if (strlen(buf) != len) {
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001388 continue; /* v contains '\0' */
Walter Dörwald3430d702002-06-17 10:43:59 +00001389 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001390
1391 /* sys.path_hooks import hook */
1392 if (p_loader != NULL) {
1393 PyObject *importer;
1394
1395 importer = get_path_importer(path_importer_cache,
Guido van Rossumf15a29f2007-05-04 00:41:39 +00001396 path_hooks, origv);
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001397 if (importer == NULL) {
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001398 return NULL;
Thomas Wouters477c8d52006-05-27 19:21:47 +00001399 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001400 /* Note: importer is a borrowed reference */
1401 if (importer != Py_None) {
Just van Rossum52e14d62002-12-30 22:08:05 +00001402 PyObject *loader;
1403 loader = PyObject_CallMethod(importer,
1404 "find_module",
1405 "s", fullname);
1406 if (loader == NULL)
1407 return NULL; /* error */
1408 if (loader != Py_None) {
1409 /* a loader was found */
1410 *p_loader = loader;
1411 return &importhookdescr;
1412 }
1413 Py_DECREF(loader);
Thomas Wouters477c8d52006-05-27 19:21:47 +00001414 continue;
Just van Rossum52e14d62002-12-30 22:08:05 +00001415 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001416 }
Thomas Wouters477c8d52006-05-27 19:21:47 +00001417 /* no hook was found, use builtin import */
Just van Rossum52e14d62002-12-30 22:08:05 +00001418
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001419 if (len > 0 && buf[len-1] != SEP
1420#ifdef ALTSEP
1421 && buf[len-1] != ALTSEP
1422#endif
1423 )
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001424 buf[len++] = SEP;
Guido van Rossum215c3402000-11-13 17:26:32 +00001425 strcpy(buf+len, name);
1426 len += namelen;
Tim Peters50d8d372001-02-28 05:34:27 +00001427
1428 /* Check for package import (buf holds a directory name,
1429 and there's an __init__ module in that directory */
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001430#ifdef HAVE_STAT
Walter Dörwald3430d702002-06-17 10:43:59 +00001431 if (stat(buf, &statbuf) == 0 && /* it exists */
1432 S_ISDIR(statbuf.st_mode) && /* it's a directory */
Thomas Wouters477c8d52006-05-27 19:21:47 +00001433 case_ok(buf, len, namelen, name)) { /* case matches */
1434 if (find_init_module(buf)) { /* and has __init__.py */
Thomas Wouters477c8d52006-05-27 19:21:47 +00001435 return &fd_package;
1436 }
1437 else {
1438 char warnstr[MAXPATHLEN+80];
1439 sprintf(warnstr, "Not importing directory "
1440 "'%.*s': missing __init__.py",
1441 MAXPATHLEN, buf);
Skip Montanaro46fc3372007-08-12 11:44:53 +00001442 if (PyErr_WarnEx(PyExc_ImportWarning,
1443 warnstr, 1)) {
Thomas Wouters477c8d52006-05-27 19:21:47 +00001444 return NULL;
1445 }
1446 }
Walter Dörwald3430d702002-06-17 10:43:59 +00001447 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001448#endif
Andrew MacIntyred9400542002-02-26 11:41:34 +00001449#if defined(PYOS_OS2)
1450 /* take a snapshot of the module spec for restoration
1451 * after the 8 character DLL hackery
1452 */
1453 saved_buf = strdup(buf);
1454 saved_len = len;
1455 saved_namelen = namelen;
1456#endif /* PYOS_OS2 */
Guido van Rossum79f25d91997-04-29 20:08:16 +00001457 for (fdp = _PyImport_Filetab; fdp->suffix != NULL; fdp++) {
Guido van Rossum04110fb2007-08-24 16:32:05 +00001458#if defined(PYOS_OS2) && defined(HAVE_DYNAMIC_LOADING)
Jeremy Hylton4ae6fae2002-05-30 17:15:25 +00001459 /* OS/2 limits DLLs to 8 character names (w/o
1460 extension)
Andrew MacIntyred9400542002-02-26 11:41:34 +00001461 * so if the name is longer than that and its a
1462 * dynamically loaded module we're going to try,
1463 * truncate the name before trying
1464 */
Just van Rossum52e14d62002-12-30 22:08:05 +00001465 if (strlen(subname) > 8) {
Andrew MacIntyred9400542002-02-26 11:41:34 +00001466 /* is this an attempt to load a C extension? */
Jeremy Hylton4ae6fae2002-05-30 17:15:25 +00001467 const struct filedescr *scan;
1468 scan = _PyImport_DynLoadFiletab;
Andrew MacIntyred9400542002-02-26 11:41:34 +00001469 while (scan->suffix != NULL) {
Jeremy Hylton4ae6fae2002-05-30 17:15:25 +00001470 if (!strcmp(scan->suffix, fdp->suffix))
Andrew MacIntyred9400542002-02-26 11:41:34 +00001471 break;
1472 else
1473 scan++;
1474 }
1475 if (scan->suffix != NULL) {
1476 /* yes, so truncate the name */
1477 namelen = 8;
Just van Rossum52e14d62002-12-30 22:08:05 +00001478 len -= strlen(subname) - namelen;
Andrew MacIntyred9400542002-02-26 11:41:34 +00001479 buf[len] = '\0';
1480 }
1481 }
1482#endif /* PYOS_OS2 */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001483 strcpy(buf+len, fdp->suffix);
Guido van Rossum79f25d91997-04-29 20:08:16 +00001484 if (Py_VerboseFlag > 1)
Guido van Rossum2f3667a1998-10-12 18:23:55 +00001485 PySys_WriteStderr("# trying %s\n", buf);
Jack Jansenc88da1f2002-05-28 10:58:19 +00001486 filemode = fdp->mode;
Tim Peters86c7d2f2004-08-01 23:24:21 +00001487 if (filemode[0] == 'U')
Jeremy Hylton4ae6fae2002-05-30 17:15:25 +00001488 filemode = "r" PY_STDIOTEXTMODE;
Jack Jansenc88da1f2002-05-28 10:58:19 +00001489 fp = fopen(buf, filemode);
Tim Peters50d8d372001-02-28 05:34:27 +00001490 if (fp != NULL) {
1491 if (case_ok(buf, len, namelen, name))
1492 break;
1493 else { /* continue search */
1494 fclose(fp);
1495 fp = NULL;
Barry Warsaw914a0b12001-02-02 19:12:16 +00001496 }
Barry Warsaw914a0b12001-02-02 19:12:16 +00001497 }
Andrew MacIntyred9400542002-02-26 11:41:34 +00001498#if defined(PYOS_OS2)
1499 /* restore the saved snapshot */
1500 strcpy(buf, saved_buf);
1501 len = saved_len;
1502 namelen = saved_namelen;
1503#endif
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001504 }
Andrew MacIntyred9400542002-02-26 11:41:34 +00001505#if defined(PYOS_OS2)
1506 /* don't need/want the module name snapshot anymore */
1507 if (saved_buf)
1508 {
1509 free(saved_buf);
1510 saved_buf = NULL;
1511 }
1512#endif
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001513 if (fp != NULL)
1514 break;
1515 }
1516 if (fp == NULL) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001517 PyErr_Format(PyExc_ImportError,
1518 "No module named %.200s", name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001519 return NULL;
1520 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001521 *p_fp = fp;
1522 return fdp;
1523}
1524
Raymond Hettingerdb29e0f2004-10-07 06:46:25 +00001525/* Helpers for main.c
1526 * Find the source file corresponding to a named module
1527 */
1528struct filedescr *
1529_PyImport_FindModule(const char *name, PyObject *path, char *buf,
1530 size_t buflen, FILE **p_fp, PyObject **p_loader)
1531{
1532 return find_module((char *) name, (char *) name, path,
1533 buf, buflen, p_fp, p_loader);
1534}
1535
1536PyAPI_FUNC(int) _PyImport_IsScript(struct filedescr * fd)
1537{
1538 return fd->type == PY_SOURCE || fd->type == PY_COMPILED;
1539}
1540
Martin v. Löwis18e16552006-02-15 17:27:45 +00001541/* case_ok(char* buf, Py_ssize_t len, Py_ssize_t namelen, char* name)
Tim Petersd1e87a82001-03-01 18:12:00 +00001542 * The arguments here are tricky, best shown by example:
1543 * /a/b/c/d/e/f/g/h/i/j/k/some_long_module_name.py\0
1544 * ^ ^ ^ ^
1545 * |--------------------- buf ---------------------|
1546 * |------------------- len ------------------|
1547 * |------ name -------|
1548 * |----- namelen -----|
1549 * buf is the full path, but len only counts up to (& exclusive of) the
1550 * extension. name is the module name, also exclusive of extension.
1551 *
1552 * We've already done a successful stat() or fopen() on buf, so know that
1553 * there's some match, possibly case-insensitive.
1554 *
Tim Peters50d8d372001-02-28 05:34:27 +00001555 * case_ok() is to return 1 if there's a case-sensitive match for
1556 * name, else 0. case_ok() is also to return 1 if envar PYTHONCASEOK
1557 * exists.
Tim Petersd1e87a82001-03-01 18:12:00 +00001558 *
Tim Peters50d8d372001-02-28 05:34:27 +00001559 * case_ok() is used to implement case-sensitive import semantics even
1560 * on platforms with case-insensitive filesystems. It's trivial to implement
1561 * for case-sensitive filesystems. It's pretty much a cross-platform
1562 * nightmare for systems with case-insensitive filesystems.
1563 */
Guido van Rossum0980bd91998-02-13 17:18:36 +00001564
Tim Peters50d8d372001-02-28 05:34:27 +00001565/* First we may need a pile of platform-specific header files; the sequence
1566 * of #if's here should match the sequence in the body of case_ok().
1567 */
Jason Tishler7961aa62005-05-20 00:56:54 +00001568#if defined(MS_WINDOWS)
Guido van Rossum0980bd91998-02-13 17:18:36 +00001569#include <windows.h>
Guido van Rossum4c3f57c2001-01-10 20:40:46 +00001570
Tim Peters50d8d372001-02-28 05:34:27 +00001571#elif defined(DJGPP)
1572#include <dir.h>
1573
Jason Tishler7961aa62005-05-20 00:56:54 +00001574#elif (defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) && defined(HAVE_DIRENT_H)
Tim Peters430f5d42001-03-01 01:30:56 +00001575#include <sys/types.h>
1576#include <dirent.h>
1577
Andrew MacIntyred9400542002-02-26 11:41:34 +00001578#elif defined(PYOS_OS2)
1579#define INCL_DOS
1580#define INCL_DOSERRORS
1581#define INCL_NOPMAPI
1582#include <os2.h>
Tim Peters50d8d372001-02-28 05:34:27 +00001583#endif
1584
Guido van Rossum0980bd91998-02-13 17:18:36 +00001585static int
Martin v. Löwis18e16552006-02-15 17:27:45 +00001586case_ok(char *buf, Py_ssize_t len, Py_ssize_t namelen, char *name)
Guido van Rossum0980bd91998-02-13 17:18:36 +00001587{
Tim Peters50d8d372001-02-28 05:34:27 +00001588/* Pick a platform-specific implementation; the sequence of #if's here should
1589 * match the sequence just above.
1590 */
1591
Jason Tishler7961aa62005-05-20 00:56:54 +00001592/* MS_WINDOWS */
1593#if defined(MS_WINDOWS)
Guido van Rossum0980bd91998-02-13 17:18:36 +00001594 WIN32_FIND_DATA data;
1595 HANDLE h;
Tim Peters50d8d372001-02-28 05:34:27 +00001596
Neil Schemenauer7d4bb9f2001-07-23 16:30:27 +00001597 if (Py_GETENV("PYTHONCASEOK") != NULL)
Guido van Rossum0980bd91998-02-13 17:18:36 +00001598 return 1;
Tim Peters50d8d372001-02-28 05:34:27 +00001599
Guido van Rossum0980bd91998-02-13 17:18:36 +00001600 h = FindFirstFile(buf, &data);
1601 if (h == INVALID_HANDLE_VALUE) {
1602 PyErr_Format(PyExc_NameError,
1603 "Can't find file for module %.100s\n(filename %.300s)",
1604 name, buf);
1605 return 0;
1606 }
1607 FindClose(h);
Tim Peters50d8d372001-02-28 05:34:27 +00001608 return strncmp(data.cFileName, name, namelen) == 0;
1609
1610/* DJGPP */
1611#elif defined(DJGPP)
1612 struct ffblk ffblk;
1613 int done;
1614
Neil Schemenauer7d4bb9f2001-07-23 16:30:27 +00001615 if (Py_GETENV("PYTHONCASEOK") != NULL)
Guido van Rossum323bf5e1998-06-24 03:54:06 +00001616 return 1;
Tim Peters50d8d372001-02-28 05:34:27 +00001617
1618 done = findfirst(buf, &ffblk, FA_ARCH|FA_RDONLY|FA_HIDDEN|FA_DIREC);
1619 if (done) {
Guido van Rossum0980bd91998-02-13 17:18:36 +00001620 PyErr_Format(PyExc_NameError,
Tim Peters50d8d372001-02-28 05:34:27 +00001621 "Can't find file for module %.100s\n(filename %.300s)",
Guido van Rossum0980bd91998-02-13 17:18:36 +00001622 name, buf);
1623 return 0;
1624 }
Tim Peters50d8d372001-02-28 05:34:27 +00001625 return strncmp(ffblk.ff_name, name, namelen) == 0;
Guido van Rossum0980bd91998-02-13 17:18:36 +00001626
Jason Tishler7961aa62005-05-20 00:56:54 +00001627/* new-fangled macintosh (macosx) or Cygwin */
1628#elif (defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) && defined(HAVE_DIRENT_H)
Tim Peters430f5d42001-03-01 01:30:56 +00001629 DIR *dirp;
1630 struct dirent *dp;
Tim Petersd1e87a82001-03-01 18:12:00 +00001631 char dirname[MAXPATHLEN + 1];
1632 const int dirlen = len - namelen - 1; /* don't want trailing SEP */
Tim Peters430f5d42001-03-01 01:30:56 +00001633
Neil Schemenauer7d4bb9f2001-07-23 16:30:27 +00001634 if (Py_GETENV("PYTHONCASEOK") != NULL)
Tim Petersdbe6ebb2001-03-01 08:47:29 +00001635 return 1;
1636
Tim Petersd1e87a82001-03-01 18:12:00 +00001637 /* Copy the dir component into dirname; substitute "." if empty */
1638 if (dirlen <= 0) {
1639 dirname[0] = '.';
1640 dirname[1] = '\0';
Tim Peters430f5d42001-03-01 01:30:56 +00001641 }
1642 else {
Tim Petersd1e87a82001-03-01 18:12:00 +00001643 assert(dirlen <= MAXPATHLEN);
1644 memcpy(dirname, buf, dirlen);
1645 dirname[dirlen] = '\0';
Tim Peters430f5d42001-03-01 01:30:56 +00001646 }
1647 /* Open the directory and search the entries for an exact match. */
Tim Petersd1e87a82001-03-01 18:12:00 +00001648 dirp = opendir(dirname);
Tim Peters430f5d42001-03-01 01:30:56 +00001649 if (dirp) {
Tim Peters677898a2001-03-02 03:28:03 +00001650 char *nameWithExt = buf + len - namelen;
Tim Peters430f5d42001-03-01 01:30:56 +00001651 while ((dp = readdir(dirp)) != NULL) {
Tim Petersdbe6ebb2001-03-01 08:47:29 +00001652 const int thislen =
Tim Peters430f5d42001-03-01 01:30:56 +00001653#ifdef _DIRENT_HAVE_D_NAMELEN
Tim Petersdbe6ebb2001-03-01 08:47:29 +00001654 dp->d_namlen;
Tim Peters430f5d42001-03-01 01:30:56 +00001655#else
Tim Petersdbe6ebb2001-03-01 08:47:29 +00001656 strlen(dp->d_name);
Tim Peters430f5d42001-03-01 01:30:56 +00001657#endif
Tim Petersd1e87a82001-03-01 18:12:00 +00001658 if (thislen >= namelen &&
Tim Peters677898a2001-03-02 03:28:03 +00001659 strcmp(dp->d_name, nameWithExt) == 0) {
Tim Peters430f5d42001-03-01 01:30:56 +00001660 (void)closedir(dirp);
1661 return 1; /* Found */
1662 }
1663 }
Tim Petersdbe6ebb2001-03-01 08:47:29 +00001664 (void)closedir(dirp);
Tim Peters430f5d42001-03-01 01:30:56 +00001665 }
Tim Peters430f5d42001-03-01 01:30:56 +00001666 return 0 ; /* Not found */
Tim Peters430f5d42001-03-01 01:30:56 +00001667
Andrew MacIntyred9400542002-02-26 11:41:34 +00001668/* OS/2 */
1669#elif defined(PYOS_OS2)
1670 HDIR hdir = 1;
1671 ULONG srchcnt = 1;
1672 FILEFINDBUF3 ffbuf;
1673 APIRET rc;
1674
Christian Heimes790c8232008-01-07 21:14:23 +00001675 if (Py_GETENV("PYTHONCASEOK") != NULL)
Andrew MacIntyred9400542002-02-26 11:41:34 +00001676 return 1;
1677
1678 rc = DosFindFirst(buf,
1679 &hdir,
1680 FILE_READONLY | FILE_HIDDEN | FILE_SYSTEM | FILE_DIRECTORY,
1681 &ffbuf, sizeof(ffbuf),
1682 &srchcnt,
1683 FIL_STANDARD);
1684 if (rc != NO_ERROR)
1685 return 0;
1686 return strncmp(ffbuf.achName, name, namelen) == 0;
1687
Tim Peters50d8d372001-02-28 05:34:27 +00001688/* assuming it's a case-sensitive filesystem, so there's nothing to do! */
1689#else
Guido van Rossum0980bd91998-02-13 17:18:36 +00001690 return 1;
Guido van Rossum0980bd91998-02-13 17:18:36 +00001691
Guido van Rossum4d1b3b91998-02-13 23:27:59 +00001692#endif
Tim Peters50d8d372001-02-28 05:34:27 +00001693}
Guido van Rossum4d1b3b91998-02-13 23:27:59 +00001694
Guido van Rossum0980bd91998-02-13 17:18:36 +00001695
Guido van Rossum197346f1997-10-31 18:38:52 +00001696#ifdef HAVE_STAT
1697/* Helper to look for __init__.py or __init__.py[co] in potential package */
1698static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001699find_init_module(char *buf)
Guido van Rossum197346f1997-10-31 18:38:52 +00001700{
Tim Peters0f9431f2001-07-05 03:47:53 +00001701 const size_t save_len = strlen(buf);
Fred Drake4c82b232000-06-30 16:18:57 +00001702 size_t i = save_len;
Tim Peters0f9431f2001-07-05 03:47:53 +00001703 char *pname; /* pointer to start of __init__ */
Guido van Rossum197346f1997-10-31 18:38:52 +00001704 struct stat statbuf;
1705
Tim Peters0f9431f2001-07-05 03:47:53 +00001706/* For calling case_ok(buf, len, namelen, name):
1707 * /a/b/c/d/e/f/g/h/i/j/k/some_long_module_name.py\0
1708 * ^ ^ ^ ^
1709 * |--------------------- buf ---------------------|
1710 * |------------------- len ------------------|
1711 * |------ name -------|
1712 * |----- namelen -----|
1713 */
Guido van Rossum197346f1997-10-31 18:38:52 +00001714 if (save_len + 13 >= MAXPATHLEN)
1715 return 0;
1716 buf[i++] = SEP;
Tim Peters0f9431f2001-07-05 03:47:53 +00001717 pname = buf + i;
1718 strcpy(pname, "__init__.py");
Guido van Rossum197346f1997-10-31 18:38:52 +00001719 if (stat(buf, &statbuf) == 0) {
Tim Peters0f9431f2001-07-05 03:47:53 +00001720 if (case_ok(buf,
1721 save_len + 9, /* len("/__init__") */
1722 8, /* len("__init__") */
1723 pname)) {
1724 buf[save_len] = '\0';
1725 return 1;
1726 }
Guido van Rossum197346f1997-10-31 18:38:52 +00001727 }
Tim Peters0f9431f2001-07-05 03:47:53 +00001728 i += strlen(pname);
1729 strcpy(buf+i, Py_OptimizeFlag ? "o" : "c");
Guido van Rossum197346f1997-10-31 18:38:52 +00001730 if (stat(buf, &statbuf) == 0) {
Tim Peters0f9431f2001-07-05 03:47:53 +00001731 if (case_ok(buf,
1732 save_len + 9, /* len("/__init__") */
1733 8, /* len("__init__") */
1734 pname)) {
1735 buf[save_len] = '\0';
1736 return 1;
1737 }
Guido van Rossum197346f1997-10-31 18:38:52 +00001738 }
1739 buf[save_len] = '\0';
1740 return 0;
1741}
Guido van Rossum48a680c2001-03-02 06:34:14 +00001742
Guido van Rossum197346f1997-10-31 18:38:52 +00001743#endif /* HAVE_STAT */
1744
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001745
Tim Petersdbd9ba62000-07-09 03:09:57 +00001746static int init_builtin(char *); /* Forward */
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001747
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001748/* Load an external module using the default search path and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001749 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001750
Guido van Rossum79f25d91997-04-29 20:08:16 +00001751static PyObject *
Just van Rossum52e14d62002-12-30 22:08:05 +00001752load_module(char *name, FILE *fp, char *buf, int type, PyObject *loader)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001753{
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001754 PyObject *modules;
Guido van Rossum79f25d91997-04-29 20:08:16 +00001755 PyObject *m;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001756 int err;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001757
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001758 /* First check that there's an open file (if we need one) */
1759 switch (type) {
1760 case PY_SOURCE:
1761 case PY_COMPILED:
1762 if (fp == NULL) {
1763 PyErr_Format(PyExc_ValueError,
1764 "file object required for import (type code %d)",
1765 type);
1766 return NULL;
1767 }
1768 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001769
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001770 switch (type) {
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001771
1772 case PY_SOURCE:
1773 m = load_source_module(name, buf, fp);
1774 break;
1775
1776 case PY_COMPILED:
1777 m = load_compiled_module(name, buf, fp);
1778 break;
1779
Guido van Rossum96a8fb71999-12-22 14:09:35 +00001780#ifdef HAVE_DYNAMIC_LOADING
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001781 case C_EXTENSION:
Guido van Rossum79f25d91997-04-29 20:08:16 +00001782 m = _PyImport_LoadDynamicModule(name, buf, fp);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001783 break;
Guido van Rossum96a8fb71999-12-22 14:09:35 +00001784#endif
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001785
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001786 case PKG_DIRECTORY:
1787 m = load_package(name, buf);
1788 break;
1789
1790 case C_BUILTIN:
1791 case PY_FROZEN:
Guido van Rossuma5568d31998-03-05 03:45:08 +00001792 if (buf != NULL && buf[0] != '\0')
1793 name = buf;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001794 if (type == C_BUILTIN)
1795 err = init_builtin(name);
1796 else
1797 err = PyImport_ImportFrozenModule(name);
1798 if (err < 0)
Guido van Rossuma86f77d1997-09-09 18:53:47 +00001799 return NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001800 if (err == 0) {
1801 PyErr_Format(PyExc_ImportError,
1802 "Purported %s module %.200s not found",
1803 type == C_BUILTIN ?
1804 "builtin" : "frozen",
1805 name);
Guido van Rossuma86f77d1997-09-09 18:53:47 +00001806 return NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001807 }
1808 modules = PyImport_GetModuleDict();
1809 m = PyDict_GetItemString(modules, name);
1810 if (m == NULL) {
1811 PyErr_Format(
1812 PyExc_ImportError,
1813 "%s module %.200s not properly initialized",
1814 type == C_BUILTIN ?
1815 "builtin" : "frozen",
1816 name);
Guido van Rossuma86f77d1997-09-09 18:53:47 +00001817 return NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001818 }
1819 Py_INCREF(m);
1820 break;
1821
Just van Rossum52e14d62002-12-30 22:08:05 +00001822 case IMP_HOOK: {
1823 if (loader == NULL) {
1824 PyErr_SetString(PyExc_ImportError,
1825 "import hook without loader");
1826 return NULL;
1827 }
1828 m = PyObject_CallMethod(loader, "load_module", "s", name);
1829 break;
1830 }
1831
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001832 default:
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001833 PyErr_Format(PyExc_ImportError,
1834 "Don't know how to import %.200s (type code %d)",
1835 name, type);
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001836 m = NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001837
1838 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001839
1840 return m;
1841}
1842
1843
1844/* Initialize a built-in module.
Thomas Wouters89f507f2006-12-13 04:49:30 +00001845 Return 1 for success, 0 if the module is not found, and -1 with
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001846 an exception set if the initialization failed. */
Guido van Rossum7f133ed1991-02-19 12:23:57 +00001847
Guido van Rossum7f133ed1991-02-19 12:23:57 +00001848static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001849init_builtin(char *name)
Guido van Rossum7f133ed1991-02-19 12:23:57 +00001850{
Guido van Rossum25ce5661997-08-02 03:10:38 +00001851 struct _inittab *p;
Guido van Rossum25ce5661997-08-02 03:10:38 +00001852
Greg Ward201baee2001-10-04 14:52:06 +00001853 if (_PyImport_FindExtension(name, name) != NULL)
Guido van Rossum25ce5661997-08-02 03:10:38 +00001854 return 1;
1855
Guido van Rossum771c6c81997-10-31 18:37:24 +00001856 for (p = PyImport_Inittab; p->name != NULL; p++) {
Martin v. Löwis1a214512008-06-11 05:26:20 +00001857 PyObject *mod;
Guido van Rossum25ce5661997-08-02 03:10:38 +00001858 if (strcmp(name, p->name) == 0) {
1859 if (p->initfunc == NULL) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001860 PyErr_Format(PyExc_ImportError,
1861 "Cannot re-init internal module %.200s",
1862 name);
Guido van Rossum74e6a111994-08-29 12:54:38 +00001863 return -1;
1864 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00001865 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +00001866 PySys_WriteStderr("import %s # builtin\n", name);
Martin v. Löwis1a214512008-06-11 05:26:20 +00001867 mod = (*p->initfunc)();
1868 if (mod == 0)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001869 return -1;
Martin v. Löwis1a214512008-06-11 05:26:20 +00001870 if (_PyImport_FixupExtension(mod, name, name) < 0)
Guido van Rossum25ce5661997-08-02 03:10:38 +00001871 return -1;
Martin v. Löwis1a214512008-06-11 05:26:20 +00001872 /* FixupExtension has put the module into sys.modules,
1873 so we can release our own reference. */
1874 Py_DECREF(mod);
Guido van Rossum7f133ed1991-02-19 12:23:57 +00001875 return 1;
1876 }
1877 }
1878 return 0;
1879}
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001880
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001881
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001882/* Frozen modules */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001883
Guido van Rossumcfd0a221996-06-17 17:06:34 +00001884static struct _frozen *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001885find_frozen(char *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001886{
Guido van Rossumcfd0a221996-06-17 17:06:34 +00001887 struct _frozen *p;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001888
Guido van Rossum79f25d91997-04-29 20:08:16 +00001889 for (p = PyImport_FrozenModules; ; p++) {
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001890 if (p->name == NULL)
1891 return NULL;
1892 if (strcmp(p->name, name) == 0)
1893 break;
1894 }
1895 return p;
1896}
1897
Guido van Rossum79f25d91997-04-29 20:08:16 +00001898static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001899get_frozen_object(char *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001900{
Guido van Rossumcfd0a221996-06-17 17:06:34 +00001901 struct _frozen *p = find_frozen(name);
Guido van Rossuma5568d31998-03-05 03:45:08 +00001902 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001903
1904 if (p == NULL) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001905 PyErr_Format(PyExc_ImportError,
1906 "No such frozen object named %.200s",
1907 name);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001908 return NULL;
1909 }
Guido van Rossum8f4d3312001-10-18 18:54:11 +00001910 if (p->code == NULL) {
1911 PyErr_Format(PyExc_ImportError,
1912 "Excluded frozen object named %.200s",
1913 name);
1914 return NULL;
1915 }
Guido van Rossuma5568d31998-03-05 03:45:08 +00001916 size = p->size;
1917 if (size < 0)
1918 size = -size;
1919 return PyMarshal_ReadObjectFromString((char *)p->code, size);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001920}
1921
1922/* Initialize a frozen module.
1923 Return 1 for succes, 0 if the module is not found, and -1 with
1924 an exception set if the initialization failed.
1925 This function is also used from frozenmain.c */
Guido van Rossum0b344901995-02-07 15:35:27 +00001926
1927int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001928PyImport_ImportFrozenModule(char *name)
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001929{
Guido van Rossumcfd0a221996-06-17 17:06:34 +00001930 struct _frozen *p = find_frozen(name);
Guido van Rossum79f25d91997-04-29 20:08:16 +00001931 PyObject *co;
1932 PyObject *m;
Guido van Rossuma5568d31998-03-05 03:45:08 +00001933 int ispackage;
1934 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001935
1936 if (p == NULL)
1937 return 0;
Guido van Rossum8f4d3312001-10-18 18:54:11 +00001938 if (p->code == NULL) {
1939 PyErr_Format(PyExc_ImportError,
1940 "Excluded frozen object named %.200s",
1941 name);
1942 return -1;
1943 }
Guido van Rossuma5568d31998-03-05 03:45:08 +00001944 size = p->size;
1945 ispackage = (size < 0);
1946 if (ispackage)
1947 size = -size;
Guido van Rossum79f25d91997-04-29 20:08:16 +00001948 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +00001949 PySys_WriteStderr("import %s # frozen%s\n",
Guido van Rossuma5568d31998-03-05 03:45:08 +00001950 name, ispackage ? " package" : "");
1951 co = PyMarshal_ReadObjectFromString((char *)p->code, size);
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001952 if (co == NULL)
1953 return -1;
Guido van Rossum79f25d91997-04-29 20:08:16 +00001954 if (!PyCode_Check(co)) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001955 PyErr_Format(PyExc_TypeError,
1956 "frozen object %.200s is not a code object",
1957 name);
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001958 goto err_return;
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001959 }
Guido van Rossuma5568d31998-03-05 03:45:08 +00001960 if (ispackage) {
1961 /* Set __path__ to the package name */
1962 PyObject *d, *s;
1963 int err;
1964 m = PyImport_AddModule(name);
1965 if (m == NULL)
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001966 goto err_return;
Guido van Rossuma5568d31998-03-05 03:45:08 +00001967 d = PyModule_GetDict(m);
Martin v. Löwis5b222132007-06-10 09:51:05 +00001968 s = PyUnicode_InternFromString(name);
Guido van Rossuma5568d31998-03-05 03:45:08 +00001969 if (s == NULL)
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001970 goto err_return;
Guido van Rossuma5568d31998-03-05 03:45:08 +00001971 err = PyDict_SetItemString(d, "__path__", s);
1972 Py_DECREF(s);
1973 if (err != 0)
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001974 goto err_return;
Guido van Rossuma5568d31998-03-05 03:45:08 +00001975 }
Guido van Rossume32bf6e1998-02-11 05:53:02 +00001976 m = PyImport_ExecCodeModuleEx(name, co, "<frozen>");
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001977 if (m == NULL)
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001978 goto err_return;
1979 Py_DECREF(co);
Guido van Rossum79f25d91997-04-29 20:08:16 +00001980 Py_DECREF(m);
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001981 return 1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001982err_return:
1983 Py_DECREF(co);
1984 return -1;
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001985}
Guido van Rossum74e6a111994-08-29 12:54:38 +00001986
1987
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001988/* Import a module, either built-in, frozen, or external, and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001989 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum74e6a111994-08-29 12:54:38 +00001990
Guido van Rossum79f25d91997-04-29 20:08:16 +00001991PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001992PyImport_ImportModule(const char *name)
Guido van Rossum74e6a111994-08-29 12:54:38 +00001993{
Marc-André Lemburg3c61c352001-02-09 19:40:15 +00001994 PyObject *pname;
1995 PyObject *result;
1996
Martin v. Löwis5b222132007-06-10 09:51:05 +00001997 pname = PyUnicode_FromString(name);
Neal Norwitza11e4c12003-03-23 14:31:01 +00001998 if (pname == NULL)
1999 return NULL;
Marc-André Lemburg3c61c352001-02-09 19:40:15 +00002000 result = PyImport_Import(pname);
2001 Py_DECREF(pname);
2002 return result;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002003}
2004
Christian Heimes072c0f12008-01-03 23:01:04 +00002005/* Import a module without blocking
2006 *
2007 * At first it tries to fetch the module from sys.modules. If the module was
2008 * never loaded before it loads it with PyImport_ImportModule() unless another
2009 * thread holds the import lock. In the latter case the function raises an
2010 * ImportError instead of blocking.
2011 *
2012 * Returns the module object with incremented ref count.
2013 */
2014PyObject *
2015PyImport_ImportModuleNoBlock(const char *name)
2016{
2017 PyObject *result;
2018 PyObject *modules;
2019 long me;
2020
2021 /* Try to get the module from sys.modules[name] */
2022 modules = PyImport_GetModuleDict();
2023 if (modules == NULL)
2024 return NULL;
2025
2026 result = PyDict_GetItemString(modules, name);
2027 if (result != NULL) {
2028 Py_INCREF(result);
2029 return result;
2030 }
2031 else {
2032 PyErr_Clear();
2033 }
2034
2035 /* check the import lock
2036 * me might be -1 but I ignore the error here, the lock function
2037 * takes care of the problem */
2038 me = PyThread_get_thread_ident();
2039 if (import_lock_thread == -1 || import_lock_thread == me) {
2040 /* no thread or me is holding the lock */
2041 return PyImport_ImportModule(name);
2042 }
2043 else {
2044 PyErr_Format(PyExc_ImportError,
2045 "Failed to import %.200s because the import lock"
2046 "is held by another thread.",
2047 name);
2048 return NULL;
2049 }
2050}
2051
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002052/* Forward declarations for helper routines */
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002053static PyObject *get_parent(PyObject *globals, char *buf,
2054 Py_ssize_t *p_buflen, int level);
Tim Petersdbd9ba62000-07-09 03:09:57 +00002055static PyObject *load_next(PyObject *mod, PyObject *altmod,
Martin v. Löwis18e16552006-02-15 17:27:45 +00002056 char **p_name, char *buf, Py_ssize_t *p_buflen);
Tim Petersdbd9ba62000-07-09 03:09:57 +00002057static int mark_miss(char *name);
2058static int ensure_fromlist(PyObject *mod, PyObject *fromlist,
Martin v. Löwis18e16552006-02-15 17:27:45 +00002059 char *buf, Py_ssize_t buflen, int recursive);
Tim Petersdbd9ba62000-07-09 03:09:57 +00002060static PyObject * import_submodule(PyObject *mod, char *name, char *fullname);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002061
2062/* The Magnum Opus of dotted-name import :-) */
2063
Guido van Rossum75acc9c1998-03-03 22:26:50 +00002064static PyObject *
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002065import_module_level(char *name, PyObject *globals, PyObject *locals,
2066 PyObject *fromlist, int level)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002067{
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002068 char buf[MAXPATHLEN+1];
Martin v. Löwis18e16552006-02-15 17:27:45 +00002069 Py_ssize_t buflen = 0;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002070 PyObject *parent, *head, *next, *tail;
2071
Christian Heimes454f37b2008-01-10 00:10:02 +00002072 if (strchr(name, '/') != NULL
2073#ifdef MS_WINDOWS
2074 || strchr(name, '\\') != NULL
2075#endif
2076 ) {
2077 PyErr_SetString(PyExc_ImportError,
2078 "Import by filename is not supported.");
2079 return NULL;
2080 }
2081
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002082 parent = get_parent(globals, buf, &buflen, level);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002083 if (parent == NULL)
2084 return NULL;
2085
2086 head = load_next(parent, Py_None, &name, buf, &buflen);
2087 if (head == NULL)
2088 return NULL;
2089
2090 tail = head;
2091 Py_INCREF(tail);
2092 while (name) {
2093 next = load_next(tail, tail, &name, buf, &buflen);
2094 Py_DECREF(tail);
2095 if (next == NULL) {
2096 Py_DECREF(head);
2097 return NULL;
2098 }
2099 tail = next;
2100 }
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002101 if (tail == Py_None) {
2102 /* If tail is Py_None, both get_parent and load_next found
2103 an empty module name: someone called __import__("") or
2104 doctored faulty bytecode */
2105 Py_DECREF(tail);
2106 Py_DECREF(head);
2107 PyErr_SetString(PyExc_ValueError,
2108 "Empty module name");
2109 return NULL;
2110 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002111
2112 if (fromlist != NULL) {
2113 if (fromlist == Py_None || !PyObject_IsTrue(fromlist))
2114 fromlist = NULL;
2115 }
2116
2117 if (fromlist == NULL) {
2118 Py_DECREF(tail);
2119 return head;
2120 }
2121
2122 Py_DECREF(head);
Guido van Rossum9905ef91997-09-08 16:07:11 +00002123 if (!ensure_fromlist(tail, fromlist, buf, buflen, 0)) {
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002124 Py_DECREF(tail);
2125 return NULL;
2126 }
2127
2128 return tail;
2129}
2130
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002131PyObject *
2132PyImport_ImportModuleLevel(char *name, PyObject *globals, PyObject *locals,
2133 PyObject *fromlist, int level)
2134{
2135 PyObject *result;
2136 lock_import();
2137 result = import_module_level(name, globals, locals, fromlist, level);
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00002138 if (unlock_import() < 0) {
2139 Py_XDECREF(result);
2140 PyErr_SetString(PyExc_RuntimeError,
2141 "not holding the import lock");
2142 return NULL;
2143 }
Guido van Rossum75acc9c1998-03-03 22:26:50 +00002144 return result;
2145}
2146
Fred Drake87590902004-05-28 20:21:36 +00002147/* Return the package that an import is being performed in. If globals comes
2148 from the module foo.bar.bat (not itself a package), this returns the
2149 sys.modules entry for foo.bar. If globals is from a package's __init__.py,
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00002150 the package's entry in sys.modules is returned, as a borrowed reference.
Fred Drake87590902004-05-28 20:21:36 +00002151
2152 The *name* of the returned package is returned in buf, with the length of
2153 the name in *p_buflen.
2154
2155 If globals doesn't come from a package or a module in a package, or a
2156 corresponding entry is not found in sys.modules, Py_None is returned.
2157*/
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002158static PyObject *
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002159get_parent(PyObject *globals, char *buf, Py_ssize_t *p_buflen, int level)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002160{
2161 static PyObject *namestr = NULL;
2162 static PyObject *pathstr = NULL;
Nick Coghlande10c852007-12-04 12:22:52 +00002163 static PyObject *pkgstr = NULL;
2164 PyObject *pkgname, *modname, *modpath, *modules, *parent;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002165
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002166 if (globals == NULL || !PyDict_Check(globals) || !level)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002167 return Py_None;
2168
2169 if (namestr == NULL) {
Martin v. Löwis5b222132007-06-10 09:51:05 +00002170 namestr = PyUnicode_InternFromString("__name__");
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002171 if (namestr == NULL)
2172 return NULL;
2173 }
2174 if (pathstr == NULL) {
Martin v. Löwis5b222132007-06-10 09:51:05 +00002175 pathstr = PyUnicode_InternFromString("__path__");
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002176 if (pathstr == NULL)
2177 return NULL;
2178 }
Nick Coghlande10c852007-12-04 12:22:52 +00002179 if (pkgstr == NULL) {
2180 pkgstr = PyUnicode_InternFromString("__package__");
2181 if (pkgstr == NULL)
2182 return NULL;
2183 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002184
2185 *buf = '\0';
2186 *p_buflen = 0;
Nick Coghlande10c852007-12-04 12:22:52 +00002187 pkgname = PyDict_GetItem(globals, pkgstr);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002188
Nick Coghlande10c852007-12-04 12:22:52 +00002189 if ((pkgname != NULL) && (pkgname != Py_None)) {
2190 /* __package__ is set, so use it */
Alexandre Vassalottia85998a2008-05-03 18:24:43 +00002191 char *pkgname_str;
Nick Coghlande10c852007-12-04 12:22:52 +00002192 Py_ssize_t len;
Alexandre Vassalottia85998a2008-05-03 18:24:43 +00002193
Nick Coghlande10c852007-12-04 12:22:52 +00002194 if (!PyUnicode_Check(pkgname)) {
2195 PyErr_SetString(PyExc_ValueError,
2196 "__package__ set to non-string");
2197 return NULL;
2198 }
Alexandre Vassalottia85998a2008-05-03 18:24:43 +00002199 pkgname_str = PyUnicode_AsStringAndSize(pkgname, &len);
Nick Coghlande10c852007-12-04 12:22:52 +00002200 if (len == 0) {
2201 if (level > 0) {
2202 PyErr_SetString(PyExc_ValueError,
2203 "Attempted relative import in non-package");
2204 return NULL;
2205 }
2206 return Py_None;
2207 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002208 if (len > MAXPATHLEN) {
2209 PyErr_SetString(PyExc_ValueError,
Nick Coghlande10c852007-12-04 12:22:52 +00002210 "Package name too long");
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002211 return NULL;
2212 }
Alexandre Vassalottia85998a2008-05-03 18:24:43 +00002213 strcpy(buf, pkgname_str);
Nick Coghlande10c852007-12-04 12:22:52 +00002214 } else {
2215 /* __package__ not set, so figure it out and set it */
2216 modname = PyDict_GetItem(globals, namestr);
2217 if (modname == NULL || !PyUnicode_Check(modname))
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002218 return Py_None;
Nick Coghlande10c852007-12-04 12:22:52 +00002219
2220 modpath = PyDict_GetItem(globals, pathstr);
2221 if (modpath != NULL) {
2222 /* __path__ is set, so modname is already the package name */
Alexandre Vassalottia85998a2008-05-03 18:24:43 +00002223 char *modname_str;
2224 Py_ssize_t len;
Nick Coghlande10c852007-12-04 12:22:52 +00002225 int error;
Alexandre Vassalottia85998a2008-05-03 18:24:43 +00002226
2227 modname_str = PyUnicode_AsStringAndSize(modname, &len);
Nick Coghlande10c852007-12-04 12:22:52 +00002228 if (len > MAXPATHLEN) {
2229 PyErr_SetString(PyExc_ValueError,
2230 "Module name too long");
2231 return NULL;
2232 }
Alexandre Vassalottia85998a2008-05-03 18:24:43 +00002233 strcpy(buf, modname_str);
Nick Coghlande10c852007-12-04 12:22:52 +00002234 error = PyDict_SetItem(globals, pkgstr, modname);
2235 if (error) {
2236 PyErr_SetString(PyExc_ValueError,
2237 "Could not set __package__");
2238 return NULL;
2239 }
2240 } else {
2241 /* Normal module, so work out the package name if any */
2242 char *start = PyUnicode_AsString(modname);
2243 char *lastdot = strrchr(start, '.');
2244 size_t len;
2245 int error;
2246 if (lastdot == NULL && level > 0) {
2247 PyErr_SetString(PyExc_ValueError,
2248 "Attempted relative import in non-package");
2249 return NULL;
2250 }
2251 if (lastdot == NULL) {
2252 error = PyDict_SetItem(globals, pkgstr, Py_None);
2253 if (error) {
2254 PyErr_SetString(PyExc_ValueError,
2255 "Could not set __package__");
2256 return NULL;
2257 }
2258 return Py_None;
2259 }
2260 len = lastdot - start;
2261 if (len >= MAXPATHLEN) {
2262 PyErr_SetString(PyExc_ValueError,
2263 "Module name too long");
2264 return NULL;
2265 }
2266 strncpy(buf, start, len);
2267 buf[len] = '\0';
2268 pkgname = PyUnicode_FromString(buf);
2269 if (pkgname == NULL) {
2270 return NULL;
2271 }
2272 error = PyDict_SetItem(globals, pkgstr, pkgname);
2273 Py_DECREF(pkgname);
2274 if (error) {
2275 PyErr_SetString(PyExc_ValueError,
2276 "Could not set __package__");
2277 return NULL;
2278 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002279 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002280 }
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002281 while (--level > 0) {
2282 char *dot = strrchr(buf, '.');
2283 if (dot == NULL) {
2284 PyErr_SetString(PyExc_ValueError,
Thomas Wouters89f507f2006-12-13 04:49:30 +00002285 "Attempted relative import beyond "
2286 "toplevel package");
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002287 return NULL;
2288 }
2289 *dot = '\0';
2290 }
2291 *p_buflen = strlen(buf);
2292
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002293 modules = PyImport_GetModuleDict();
2294 parent = PyDict_GetItemString(modules, buf);
2295 if (parent == NULL)
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002296 PyErr_Format(PyExc_SystemError,
2297 "Parent module '%.200s' not loaded", buf);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002298 return parent;
2299 /* We expect, but can't guarantee, if parent != None, that:
2300 - parent.__name__ == buf
2301 - parent.__dict__ is globals
2302 If this is violated... Who cares? */
2303}
2304
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002305/* altmod is either None or same as mod */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002306static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002307load_next(PyObject *mod, PyObject *altmod, char **p_name, char *buf,
Martin v. Löwis18e16552006-02-15 17:27:45 +00002308 Py_ssize_t *p_buflen)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002309{
2310 char *name = *p_name;
2311 char *dot = strchr(name, '.');
Fred Drake4c82b232000-06-30 16:18:57 +00002312 size_t len;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002313 char *p;
2314 PyObject *result;
2315
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002316 if (strlen(name) == 0) {
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002317 /* completely empty module name should only happen in
2318 'from . import' (or '__import__("")')*/
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002319 Py_INCREF(mod);
2320 *p_name = NULL;
2321 return mod;
2322 }
2323
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002324 if (dot == NULL) {
2325 *p_name = NULL;
2326 len = strlen(name);
2327 }
2328 else {
2329 *p_name = dot+1;
2330 len = dot-name;
2331 }
Guido van Rossum111c20b1998-04-11 17:38:22 +00002332 if (len == 0) {
2333 PyErr_SetString(PyExc_ValueError,
2334 "Empty module name");
2335 return NULL;
2336 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002337
2338 p = buf + *p_buflen;
2339 if (p != buf)
2340 *p++ = '.';
2341 if (p+len-buf >= MAXPATHLEN) {
2342 PyErr_SetString(PyExc_ValueError,
2343 "Module name too long");
2344 return NULL;
2345 }
2346 strncpy(p, name, len);
2347 p[len] = '\0';
2348 *p_buflen = p+len-buf;
2349
2350 result = import_submodule(mod, p, buf);
2351 if (result == Py_None && altmod != mod) {
2352 Py_DECREF(result);
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00002353 /* Here, altmod must be None and mod must not be None */
Guido van Rossum0c819451997-09-07 06:16:57 +00002354 result = import_submodule(altmod, p, p);
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00002355 if (result != NULL && result != Py_None) {
2356 if (mark_miss(buf) != 0) {
2357 Py_DECREF(result);
2358 return NULL;
2359 }
2360 strncpy(buf, name, len);
2361 buf[len] = '\0';
2362 *p_buflen = len;
2363 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002364 }
2365 if (result == NULL)
2366 return NULL;
2367
2368 if (result == Py_None) {
2369 Py_DECREF(result);
2370 PyErr_Format(PyExc_ImportError,
2371 "No module named %.200s", name);
2372 return NULL;
2373 }
2374
2375 return result;
2376}
2377
2378static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002379mark_miss(char *name)
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00002380{
2381 PyObject *modules = PyImport_GetModuleDict();
2382 return PyDict_SetItemString(modules, name, Py_None);
2383}
2384
2385static int
Martin v. Löwis18e16552006-02-15 17:27:45 +00002386ensure_fromlist(PyObject *mod, PyObject *fromlist, char *buf, Py_ssize_t buflen,
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002387 int recursive)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002388{
2389 int i;
2390
2391 if (!PyObject_HasAttrString(mod, "__path__"))
2392 return 1;
2393
2394 for (i = 0; ; i++) {
2395 PyObject *item = PySequence_GetItem(fromlist, i);
2396 int hasit;
2397 if (item == NULL) {
2398 if (PyErr_ExceptionMatches(PyExc_IndexError)) {
2399 PyErr_Clear();
2400 return 1;
2401 }
2402 return 0;
2403 }
Martin v. Löwis5b222132007-06-10 09:51:05 +00002404 if (!PyUnicode_Check(item)) {
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002405 PyErr_SetString(PyExc_TypeError,
Neal Norwitz80e7f272007-08-26 06:45:23 +00002406 "Item in ``from list'' not a string");
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002407 Py_DECREF(item);
2408 return 0;
2409 }
Martin v. Löwis5b222132007-06-10 09:51:05 +00002410 if (PyUnicode_AS_UNICODE(item)[0] == '*') {
Guido van Rossum9905ef91997-09-08 16:07:11 +00002411 PyObject *all;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002412 Py_DECREF(item);
Guido van Rossum9905ef91997-09-08 16:07:11 +00002413 /* See if the package defines __all__ */
2414 if (recursive)
2415 continue; /* Avoid endless recursion */
2416 all = PyObject_GetAttrString(mod, "__all__");
2417 if (all == NULL)
2418 PyErr_Clear();
2419 else {
Martin v. Löwis83969ee2004-03-23 16:28:13 +00002420 int ret = ensure_fromlist(mod, all, buf, buflen, 1);
Guido van Rossum9905ef91997-09-08 16:07:11 +00002421 Py_DECREF(all);
Martin v. Löwis83969ee2004-03-23 16:28:13 +00002422 if (!ret)
2423 return 0;
Guido van Rossum9905ef91997-09-08 16:07:11 +00002424 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002425 continue;
2426 }
2427 hasit = PyObject_HasAttr(mod, item);
2428 if (!hasit) {
Martin v. Löwis5b222132007-06-10 09:51:05 +00002429 PyObject *item8;
2430 char *subname;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002431 PyObject *submod;
2432 char *p;
Martin v. Löwis5b222132007-06-10 09:51:05 +00002433 if (!Py_FileSystemDefaultEncoding) {
2434 item8 = PyUnicode_EncodeASCII(PyUnicode_AsUnicode(item),
2435 PyUnicode_GetSize(item),
Martin v. Löwis427dbff2007-06-12 05:53:00 +00002436 NULL);
Martin v. Löwis5b222132007-06-10 09:51:05 +00002437 } else {
Guido van Rossum98297ee2007-11-06 21:34:58 +00002438 item8 = PyUnicode_AsEncodedString(item,
2439 Py_FileSystemDefaultEncoding, NULL);
Martin v. Löwis5b222132007-06-10 09:51:05 +00002440 }
2441 if (!item8) {
2442 PyErr_SetString(PyExc_ValueError, "Cannot encode path item");
2443 return 0;
2444 }
Christian Heimes72b710a2008-05-26 13:28:38 +00002445 subname = PyBytes_AS_STRING(item8);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002446 if (buflen + strlen(subname) >= MAXPATHLEN) {
2447 PyErr_SetString(PyExc_ValueError,
2448 "Module name too long");
2449 Py_DECREF(item);
2450 return 0;
2451 }
2452 p = buf + buflen;
2453 *p++ = '.';
2454 strcpy(p, subname);
2455 submod = import_submodule(mod, subname, buf);
Martin v. Löwis5b222132007-06-10 09:51:05 +00002456 Py_DECREF(item8);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002457 Py_XDECREF(submod);
2458 if (submod == NULL) {
2459 Py_DECREF(item);
2460 return 0;
2461 }
2462 }
2463 Py_DECREF(item);
2464 }
2465
Guido van Rossuma7f2e811997-10-03 15:33:32 +00002466 /* NOTREACHED */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002467}
2468
Neil Schemenauer00b09662003-06-16 21:03:07 +00002469static int
2470add_submodule(PyObject *mod, PyObject *submod, char *fullname, char *subname,
2471 PyObject *modules)
2472{
2473 if (mod == Py_None)
2474 return 1;
2475 /* Irrespective of the success of this load, make a
2476 reference to it in the parent package module. A copy gets
2477 saved in the modules dictionary under the full name, so get a
2478 reference from there, if need be. (The exception is when the
2479 load failed with a SyntaxError -- then there's no trace in
2480 sys.modules. In that case, of course, do nothing extra.) */
2481 if (submod == NULL) {
2482 submod = PyDict_GetItemString(modules, fullname);
2483 if (submod == NULL)
2484 return 1;
2485 }
2486 if (PyModule_Check(mod)) {
2487 /* We can't use setattr here since it can give a
2488 * spurious warning if the submodule name shadows a
2489 * builtin name */
2490 PyObject *dict = PyModule_GetDict(mod);
2491 if (!dict)
2492 return 0;
2493 if (PyDict_SetItemString(dict, subname, submod) < 0)
2494 return 0;
2495 }
2496 else {
2497 if (PyObject_SetAttrString(mod, subname, submod) < 0)
2498 return 0;
2499 }
2500 return 1;
2501}
2502
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002503static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002504import_submodule(PyObject *mod, char *subname, char *fullname)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002505{
Guido van Rossum25ce5661997-08-02 03:10:38 +00002506 PyObject *modules = PyImport_GetModuleDict();
Neil Schemenauer00b09662003-06-16 21:03:07 +00002507 PyObject *m = NULL;
Guido van Rossum74e6a111994-08-29 12:54:38 +00002508
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002509 /* Require:
2510 if mod == None: subname == fullname
2511 else: mod.__name__ + "." + subname == fullname
2512 */
2513
Tim Peters50d8d372001-02-28 05:34:27 +00002514 if ((m = PyDict_GetItemString(modules, fullname)) != NULL) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00002515 Py_INCREF(m);
Guido van Rossum7f9fa971995-01-20 16:53:12 +00002516 }
2517 else {
Just van Rossum52e14d62002-12-30 22:08:05 +00002518 PyObject *path, *loader = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002519 char buf[MAXPATHLEN+1];
2520 struct filedescr *fdp;
2521 FILE *fp = NULL;
2522
Guido van Rossum9c0afe51998-05-19 15:09:05 +00002523 if (mod == Py_None)
2524 path = NULL;
2525 else {
2526 path = PyObject_GetAttrString(mod, "__path__");
2527 if (path == NULL) {
2528 PyErr_Clear();
2529 Py_INCREF(Py_None);
2530 return Py_None;
2531 }
2532 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002533
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002534 buf[0] = '\0';
Just van Rossum52e14d62002-12-30 22:08:05 +00002535 fdp = find_module(fullname, subname, path, buf, MAXPATHLEN+1,
2536 &fp, &loader);
Guido van Rossumb68cd421998-07-01 17:36:26 +00002537 Py_XDECREF(path);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002538 if (fdp == NULL) {
2539 if (!PyErr_ExceptionMatches(PyExc_ImportError))
2540 return NULL;
2541 PyErr_Clear();
2542 Py_INCREF(Py_None);
2543 return Py_None;
2544 }
Just van Rossum52e14d62002-12-30 22:08:05 +00002545 m = load_module(fullname, fp, buf, fdp->type, loader);
2546 Py_XDECREF(loader);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002547 if (fp)
2548 fclose(fp);
Neil Schemenauer00b09662003-06-16 21:03:07 +00002549 if (!add_submodule(mod, m, fullname, subname, modules)) {
2550 Py_XDECREF(m);
2551 m = NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002552 }
Guido van Rossum74e6a111994-08-29 12:54:38 +00002553 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002554
2555 return m;
Guido van Rossum74e6a111994-08-29 12:54:38 +00002556}
2557
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002558
2559/* Re-import a module of any kind and return its module object, WITH
2560 INCREMENTED REFERENCE COUNT */
2561
Guido van Rossum79f25d91997-04-29 20:08:16 +00002562PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002563PyImport_ReloadModule(PyObject *m)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002564{
Guido van Rossumd8faa362007-04-27 19:54:29 +00002565 PyInterpreterState *interp = PyThreadState_Get()->interp;
2566 PyObject *modules_reloading = interp->modules_reloading;
Guido van Rossum25ce5661997-08-02 03:10:38 +00002567 PyObject *modules = PyImport_GetModuleDict();
Guido van Rossumd8faa362007-04-27 19:54:29 +00002568 PyObject *path = NULL, *loader = NULL, *existing_m = NULL;
Guido van Rossum222ef561997-09-06 19:41:09 +00002569 char *name, *subname;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002570 char buf[MAXPATHLEN+1];
2571 struct filedescr *fdp;
2572 FILE *fp = NULL;
Tim Peters1cd70172004-08-02 03:52:12 +00002573 PyObject *newm;
Guido van Rossumd8faa362007-04-27 19:54:29 +00002574
2575 if (modules_reloading == NULL) {
2576 Py_FatalError("PyImport_ReloadModule: "
Guido van Rossume7ba4952007-06-06 23:52:48 +00002577 "no modules_reloading dictionary!");
Guido van Rossumd8faa362007-04-27 19:54:29 +00002578 return NULL;
2579 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002580
Guido van Rossum79f25d91997-04-29 20:08:16 +00002581 if (m == NULL || !PyModule_Check(m)) {
2582 PyErr_SetString(PyExc_TypeError,
2583 "reload() argument must be module");
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002584 return NULL;
2585 }
Neal Norwitz5616c6d2007-08-26 05:32:41 +00002586 name = (char*)PyModule_GetName(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002587 if (name == NULL)
2588 return NULL;
Guido van Rossum25ce5661997-08-02 03:10:38 +00002589 if (m != PyDict_GetItemString(modules, name)) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002590 PyErr_Format(PyExc_ImportError,
2591 "reload(): module %.200s not in sys.modules",
2592 name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002593 return NULL;
2594 }
Guido van Rossumd8faa362007-04-27 19:54:29 +00002595 existing_m = PyDict_GetItemString(modules_reloading, name);
2596 if (existing_m != NULL) {
2597 /* Due to a recursive reload, this module is already
2598 being reloaded. */
2599 Py_INCREF(existing_m);
2600 return existing_m;
2601 }
2602 if (PyDict_SetItemString(modules_reloading, name, m) < 0)
2603 return NULL;
2604
Guido van Rossum222ef561997-09-06 19:41:09 +00002605 subname = strrchr(name, '.');
2606 if (subname == NULL)
2607 subname = name;
2608 else {
2609 PyObject *parentname, *parent;
Christian Heimesc4cb3b82007-11-04 12:10:01 +00002610 parentname = PyUnicode_FromStringAndSize(name, (subname-name));
Guido van Rossumd8faa362007-04-27 19:54:29 +00002611 if (parentname == NULL) {
2612 imp_modules_reloading_clear();
Guido van Rossum222ef561997-09-06 19:41:09 +00002613 return NULL;
Guido van Rossumd8faa362007-04-27 19:54:29 +00002614 }
Guido van Rossum222ef561997-09-06 19:41:09 +00002615 parent = PyDict_GetItem(modules, parentname);
2616 if (parent == NULL) {
2617 PyErr_Format(PyExc_ImportError,
2618 "reload(): parent %.200s not in sys.modules",
Christian Heimesc4cb3b82007-11-04 12:10:01 +00002619 PyUnicode_AsString(parentname));
Georg Brandl0c55f292005-09-14 06:56:20 +00002620 Py_DECREF(parentname);
Guido van Rossume7ba4952007-06-06 23:52:48 +00002621 imp_modules_reloading_clear();
Guido van Rossum222ef561997-09-06 19:41:09 +00002622 return NULL;
2623 }
Georg Brandl0c55f292005-09-14 06:56:20 +00002624 Py_DECREF(parentname);
Guido van Rossum222ef561997-09-06 19:41:09 +00002625 subname++;
2626 path = PyObject_GetAttrString(parent, "__path__");
2627 if (path == NULL)
2628 PyErr_Clear();
2629 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002630 buf[0] = '\0';
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00002631 fdp = find_module(name, subname, path, buf, MAXPATHLEN+1, &fp, &loader);
Guido van Rossum222ef561997-09-06 19:41:09 +00002632 Py_XDECREF(path);
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00002633
2634 if (fdp == NULL) {
2635 Py_XDECREF(loader);
Guido van Rossumd8faa362007-04-27 19:54:29 +00002636 imp_modules_reloading_clear();
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002637 return NULL;
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00002638 }
2639
2640 newm = load_module(name, fp, buf, fdp->type, loader);
2641 Py_XDECREF(loader);
2642
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002643 if (fp)
2644 fclose(fp);
Tim Peters1cd70172004-08-02 03:52:12 +00002645 if (newm == NULL) {
2646 /* load_module probably removed name from modules because of
2647 * the error. Put back the original module object. We're
2648 * going to return NULL in this case regardless of whether
2649 * replacing name succeeds, so the return value is ignored.
2650 */
2651 PyDict_SetItemString(modules, name, m);
2652 }
Guido van Rossumd8faa362007-04-27 19:54:29 +00002653 imp_modules_reloading_clear();
Tim Peters1cd70172004-08-02 03:52:12 +00002654 return newm;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002655}
2656
2657
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002658/* Higher-level import emulator which emulates the "import" statement
2659 more accurately -- it invokes the __import__() function from the
2660 builtins of the current globals. This means that the import is
2661 done using whatever import hooks are installed in the current
Guido van Rossum6058eb41998-12-21 19:51:00 +00002662 environment, e.g. by "rexec".
2663 A dummy list ["__doc__"] is passed as the 4th argument so that
Neal Norwitz80e7f272007-08-26 06:45:23 +00002664 e.g. PyImport_Import(PyUnicode_FromString("win32com.client.gencache"))
Guido van Rossum6058eb41998-12-21 19:51:00 +00002665 will return <module "gencache"> instead of <module "win32com">. */
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002666
2667PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002668PyImport_Import(PyObject *module_name)
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002669{
2670 static PyObject *silly_list = NULL;
2671 static PyObject *builtins_str = NULL;
2672 static PyObject *import_str = NULL;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002673 PyObject *globals = NULL;
2674 PyObject *import = NULL;
2675 PyObject *builtins = NULL;
2676 PyObject *r = NULL;
2677
2678 /* Initialize constant string objects */
2679 if (silly_list == NULL) {
Martin v. Löwis5b222132007-06-10 09:51:05 +00002680 import_str = PyUnicode_InternFromString("__import__");
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002681 if (import_str == NULL)
2682 return NULL;
Martin v. Löwis5b222132007-06-10 09:51:05 +00002683 builtins_str = PyUnicode_InternFromString("__builtins__");
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002684 if (builtins_str == NULL)
2685 return NULL;
2686 silly_list = Py_BuildValue("[s]", "__doc__");
2687 if (silly_list == NULL)
2688 return NULL;
2689 }
2690
2691 /* Get the builtins from current globals */
2692 globals = PyEval_GetGlobals();
Guido van Rossum85cd1d62001-02-20 21:43:24 +00002693 if (globals != NULL) {
Guido van Rossum66468561998-10-22 15:46:50 +00002694 Py_INCREF(globals);
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002695 builtins = PyObject_GetItem(globals, builtins_str);
2696 if (builtins == NULL)
2697 goto err;
2698 }
2699 else {
2700 /* No globals -- use standard builtins, and fake globals */
2701 PyErr_Clear();
2702
Georg Brandl1a3284e2007-12-02 09:40:06 +00002703 builtins = PyImport_ImportModuleLevel("builtins",
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002704 NULL, NULL, NULL, 0);
Guido van Rossum85cd1d62001-02-20 21:43:24 +00002705 if (builtins == NULL)
2706 return NULL;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002707 globals = Py_BuildValue("{OO}", builtins_str, builtins);
2708 if (globals == NULL)
2709 goto err;
2710 }
2711
2712 /* Get the __import__ function from the builtins */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002713 if (PyDict_Check(builtins)) {
Fred Drakea76ba6e2001-03-06 06:31:15 +00002714 import = PyObject_GetItem(builtins, import_str);
Tim Peters6d6c1a32001-08-02 04:15:00 +00002715 if (import == NULL)
2716 PyErr_SetObject(PyExc_KeyError, import_str);
2717 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002718 else
Fred Drakea76ba6e2001-03-06 06:31:15 +00002719 import = PyObject_GetAttr(builtins, import_str);
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002720 if (import == NULL)
2721 goto err;
2722
Christian Heimes072c0f12008-01-03 23:01:04 +00002723 /* Call the __import__ function with the proper argument list
2724 * Always use absolute import here. */
2725 r = PyObject_CallFunction(import, "OOOOi", module_name, globals,
2726 globals, silly_list, 0, NULL);
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002727
2728 err:
2729 Py_XDECREF(globals);
2730 Py_XDECREF(builtins);
2731 Py_XDECREF(import);
Tim Peters50d8d372001-02-28 05:34:27 +00002732
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002733 return r;
2734}
2735
2736
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002737/* Module 'imp' provides Python access to the primitives used for
2738 importing modules.
2739*/
2740
Guido van Rossum79f25d91997-04-29 20:08:16 +00002741static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +00002742imp_get_magic(PyObject *self, PyObject *noargs)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002743{
2744 char buf[4];
2745
Guido van Rossum96774c12000-05-01 20:19:08 +00002746 buf[0] = (char) ((pyc_magic >> 0) & 0xff);
2747 buf[1] = (char) ((pyc_magic >> 8) & 0xff);
2748 buf[2] = (char) ((pyc_magic >> 16) & 0xff);
2749 buf[3] = (char) ((pyc_magic >> 24) & 0xff);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002750
Christian Heimes72b710a2008-05-26 13:28:38 +00002751 return PyBytes_FromStringAndSize(buf, 4);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002752}
2753
Guido van Rossum79f25d91997-04-29 20:08:16 +00002754static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +00002755imp_get_suffixes(PyObject *self, PyObject *noargs)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002756{
Guido van Rossum79f25d91997-04-29 20:08:16 +00002757 PyObject *list;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002758 struct filedescr *fdp;
2759
Guido van Rossum79f25d91997-04-29 20:08:16 +00002760 list = PyList_New(0);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002761 if (list == NULL)
2762 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002763 for (fdp = _PyImport_Filetab; fdp->suffix != NULL; fdp++) {
2764 PyObject *item = Py_BuildValue("ssi",
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002765 fdp->suffix, fdp->mode, fdp->type);
2766 if (item == NULL) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00002767 Py_DECREF(list);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002768 return NULL;
2769 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002770 if (PyList_Append(list, item) < 0) {
2771 Py_DECREF(list);
2772 Py_DECREF(item);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002773 return NULL;
2774 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002775 Py_DECREF(item);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002776 }
2777 return list;
2778}
2779
Guido van Rossum79f25d91997-04-29 20:08:16 +00002780static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002781call_find_module(char *name, PyObject *path)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002782{
Tim Petersdbd9ba62000-07-09 03:09:57 +00002783 extern int fclose(FILE *);
Guido van Rossum79f25d91997-04-29 20:08:16 +00002784 PyObject *fob, *ret;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002785 struct filedescr *fdp;
2786 char pathname[MAXPATHLEN+1];
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002787 FILE *fp = NULL;
Guido van Rossum40d20bc2007-10-22 00:09:51 +00002788 int fd = -1;
Brett Cannon3bb42d92007-10-20 03:43:15 +00002789 char *found_encoding = NULL;
Guido van Rossumce3a72a2007-10-19 23:16:50 +00002790 char *encoding = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002791
2792 pathname[0] = '\0';
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002793 if (path == Py_None)
2794 path = NULL;
Just van Rossum52e14d62002-12-30 22:08:05 +00002795 fdp = find_module(NULL, name, path, pathname, MAXPATHLEN+1, &fp, NULL);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002796 if (fdp == NULL)
2797 return NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002798 if (fp != NULL) {
Guido van Rossum40d20bc2007-10-22 00:09:51 +00002799 fd = fileno(fp);
2800 if (fd != -1)
2801 fd = dup(fd);
2802 fclose(fp);
2803 fp = NULL;
2804 }
2805 if (fd != -1) {
Guido van Rossumce3a72a2007-10-19 23:16:50 +00002806 if (strchr(fdp->mode, 'b') == NULL) {
Brett Cannon3bb42d92007-10-20 03:43:15 +00002807 /* PyTokenizer_FindEncoding() returns PyMem_MALLOC'ed
2808 memory. */
Guido van Rossum40d20bc2007-10-22 00:09:51 +00002809 found_encoding = PyTokenizer_FindEncoding(fd);
2810 lseek(fd, 0, 0); /* Reset position */
Brett Cannon3bb42d92007-10-20 03:43:15 +00002811 encoding = (found_encoding != NULL) ? found_encoding :
Guido van Rossumce3a72a2007-10-19 23:16:50 +00002812 (char*)PyUnicode_GetDefaultEncoding();
2813 }
Guido van Rossum40d20bc2007-10-22 00:09:51 +00002814 fob = PyFile_FromFd(fd, pathname, fdp->mode, -1,
Guido van Rossume7fc50f2007-12-03 22:54:21 +00002815 (char*)encoding, NULL, NULL, 1);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002816 if (fob == NULL) {
Guido van Rossum40d20bc2007-10-22 00:09:51 +00002817 close(fd);
Brett Cannon3bb42d92007-10-20 03:43:15 +00002818 PyMem_FREE(found_encoding);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002819 return NULL;
2820 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002821 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002822 else {
2823 fob = Py_None;
2824 Py_INCREF(fob);
Tim Peters50d8d372001-02-28 05:34:27 +00002825 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002826 ret = Py_BuildValue("Os(ssi)",
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002827 fob, pathname, fdp->suffix, fdp->mode, fdp->type);
Guido van Rossum79f25d91997-04-29 20:08:16 +00002828 Py_DECREF(fob);
Brett Cannon3bb42d92007-10-20 03:43:15 +00002829 PyMem_FREE(found_encoding);
2830
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002831 return ret;
2832}
2833
Guido van Rossum79f25d91997-04-29 20:08:16 +00002834static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002835imp_find_module(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002836{
2837 char *name;
2838 PyObject *path = NULL;
Guido van Rossum43713e52000-02-29 13:59:29 +00002839 if (!PyArg_ParseTuple(args, "s|O:find_module", &name, &path))
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002840 return NULL;
2841 return call_find_module(name, path);
2842}
2843
2844static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002845imp_init_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002846{
2847 char *name;
2848 int ret;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002849 PyObject *m;
Guido van Rossum43713e52000-02-29 13:59:29 +00002850 if (!PyArg_ParseTuple(args, "s:init_builtin", &name))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002851 return NULL;
2852 ret = init_builtin(name);
2853 if (ret < 0)
2854 return NULL;
2855 if (ret == 0) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00002856 Py_INCREF(Py_None);
2857 return Py_None;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002858 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002859 m = PyImport_AddModule(name);
2860 Py_XINCREF(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002861 return m;
2862}
2863
Guido van Rossum79f25d91997-04-29 20:08:16 +00002864static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002865imp_init_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002866{
2867 char *name;
2868 int ret;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002869 PyObject *m;
Guido van Rossum43713e52000-02-29 13:59:29 +00002870 if (!PyArg_ParseTuple(args, "s:init_frozen", &name))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002871 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002872 ret = PyImport_ImportFrozenModule(name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002873 if (ret < 0)
2874 return NULL;
2875 if (ret == 0) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00002876 Py_INCREF(Py_None);
2877 return Py_None;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002878 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002879 m = PyImport_AddModule(name);
2880 Py_XINCREF(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002881 return m;
2882}
2883
Guido van Rossum79f25d91997-04-29 20:08:16 +00002884static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002885imp_get_frozen_object(PyObject *self, PyObject *args)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002886{
2887 char *name;
Jack Jansen95ffa231995-10-03 14:38:41 +00002888
Guido van Rossum43713e52000-02-29 13:59:29 +00002889 if (!PyArg_ParseTuple(args, "s:get_frozen_object", &name))
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002890 return NULL;
2891 return get_frozen_object(name);
2892}
2893
Guido van Rossum79f25d91997-04-29 20:08:16 +00002894static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002895imp_is_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002896{
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002897 char *name;
Guido van Rossum43713e52000-02-29 13:59:29 +00002898 if (!PyArg_ParseTuple(args, "s:is_builtin", &name))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002899 return NULL;
Christian Heimes217cfd12007-12-02 14:31:20 +00002900 return PyLong_FromLong(is_builtin(name));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002901}
2902
Guido van Rossum79f25d91997-04-29 20:08:16 +00002903static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002904imp_is_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002905{
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002906 char *name;
Guido van Rossum323bf5e1998-06-24 03:54:06 +00002907 struct _frozen *p;
Guido van Rossum43713e52000-02-29 13:59:29 +00002908 if (!PyArg_ParseTuple(args, "s:is_frozen", &name))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002909 return NULL;
Guido van Rossum323bf5e1998-06-24 03:54:06 +00002910 p = find_frozen(name);
Guido van Rossumb8bff3f2002-04-07 06:34:38 +00002911 return PyBool_FromLong((long) (p == NULL ? 0 : p->size));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002912}
2913
2914static FILE *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002915get_file(char *pathname, PyObject *fob, char *mode)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002916{
2917 FILE *fp;
Guido van Rossumda5b8f22007-06-12 23:30:11 +00002918 if (mode[0] == 'U')
2919 mode = "r" PY_STDIOTEXTMODE;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002920 if (fob == NULL) {
2921 fp = fopen(pathname, mode);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002922 }
2923 else {
Guido van Rossumda5b8f22007-06-12 23:30:11 +00002924 int fd = PyObject_AsFileDescriptor(fob);
2925 if (fd == -1)
2926 return NULL;
2927 /* XXX This will leak a FILE struct. Fix this!!!!
2928 (But it doesn't leak a file descrioptor!) */
2929 fp = fdopen(fd, mode);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002930 }
Guido van Rossumda5b8f22007-06-12 23:30:11 +00002931 if (fp == NULL)
2932 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002933 return fp;
2934}
2935
Guido van Rossum79f25d91997-04-29 20:08:16 +00002936static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002937imp_load_compiled(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002938{
2939 char *name;
2940 char *pathname;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002941 PyObject *fob = NULL;
2942 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002943 FILE *fp;
Guido van Rossumda5b8f22007-06-12 23:30:11 +00002944 if (!PyArg_ParseTuple(args, "ss|O:load_compiled",
2945 &name, &pathname, &fob))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002946 return NULL;
2947 fp = get_file(pathname, fob, "rb");
2948 if (fp == NULL)
2949 return NULL;
2950 m = load_compiled_module(name, pathname, fp);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002951 if (fob == NULL)
2952 fclose(fp);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002953 return m;
2954}
2955
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002956#ifdef HAVE_DYNAMIC_LOADING
2957
Guido van Rossum79f25d91997-04-29 20:08:16 +00002958static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002959imp_load_dynamic(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002960{
2961 char *name;
2962 char *pathname;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002963 PyObject *fob = NULL;
2964 PyObject *m;
Guido van Rossum7faeab31995-07-07 22:50:36 +00002965 FILE *fp = NULL;
Guido van Rossumda5b8f22007-06-12 23:30:11 +00002966 if (!PyArg_ParseTuple(args, "ss|O:load_dynamic",
2967 &name, &pathname, &fob))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002968 return NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002969 if (fob) {
Guido van Rossum7faeab31995-07-07 22:50:36 +00002970 fp = get_file(pathname, fob, "r");
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002971 if (fp == NULL)
2972 return NULL;
2973 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002974 m = _PyImport_LoadDynamicModule(name, pathname, fp);
Guido van Rossum7faeab31995-07-07 22:50:36 +00002975 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002976}
2977
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002978#endif /* HAVE_DYNAMIC_LOADING */
2979
Guido van Rossum79f25d91997-04-29 20:08:16 +00002980static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002981imp_load_source(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002982{
2983 char *name;
2984 char *pathname;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002985 PyObject *fob = NULL;
2986 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002987 FILE *fp;
Guido van Rossumda5b8f22007-06-12 23:30:11 +00002988 if (!PyArg_ParseTuple(args, "ss|O:load_source",
2989 &name, &pathname, &fob))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002990 return NULL;
2991 fp = get_file(pathname, fob, "r");
2992 if (fp == NULL)
2993 return NULL;
2994 m = load_source_module(name, pathname, fp);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002995 if (fob == NULL)
2996 fclose(fp);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002997 return m;
2998}
2999
Guido van Rossum79f25d91997-04-29 20:08:16 +00003000static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003001imp_load_module(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003002{
3003 char *name;
3004 PyObject *fob;
3005 char *pathname;
3006 char *suffix; /* Unused */
3007 char *mode;
3008 int type;
3009 FILE *fp;
3010
Guido van Rossum43713e52000-02-29 13:59:29 +00003011 if (!PyArg_ParseTuple(args, "sOs(ssi):load_module",
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003012 &name, &fob, &pathname,
3013 &suffix, &mode, &type))
3014 return NULL;
Guido van Rossum5e2c5fa2002-05-30 17:33:07 +00003015 if (*mode) {
3016 /* Mode must start with 'r' or 'U' and must not contain '+'.
3017 Implicit in this test is the assumption that the mode
3018 may contain other modifiers like 'b' or 't'. */
3019
3020 if (!(*mode == 'r' || *mode == 'U') || strchr(mode, '+')) {
Jeremy Hylton4ae6fae2002-05-30 17:15:25 +00003021 PyErr_Format(PyExc_ValueError,
3022 "invalid file open mode %.200s", mode);
3023 return NULL;
Guido van Rossum5e2c5fa2002-05-30 17:33:07 +00003024 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003025 }
3026 if (fob == Py_None)
3027 fp = NULL;
3028 else {
Guido van Rossumda5b8f22007-06-12 23:30:11 +00003029 fp = get_file(NULL, fob, mode);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003030 if (fp == NULL)
3031 return NULL;
3032 }
Just van Rossum52e14d62002-12-30 22:08:05 +00003033 return load_module(name, fp, pathname, type, NULL);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003034}
3035
3036static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003037imp_load_package(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003038{
3039 char *name;
3040 char *pathname;
Guido van Rossum43713e52000-02-29 13:59:29 +00003041 if (!PyArg_ParseTuple(args, "ss:load_package", &name, &pathname))
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003042 return NULL;
3043 return load_package(name, pathname);
3044}
3045
3046static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003047imp_new_module(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003048{
3049 char *name;
Guido van Rossum43713e52000-02-29 13:59:29 +00003050 if (!PyArg_ParseTuple(args, "s:new_module", &name))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003051 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +00003052 return PyModule_New(name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003053}
3054
Christian Heimes13a7a212008-01-07 17:13:09 +00003055static PyObject *
3056imp_reload(PyObject *self, PyObject *v)
3057{
3058 return PyImport_ReloadModule(v);
3059}
3060
3061PyDoc_STRVAR(doc_reload,
3062"reload(module) -> module\n\
3063\n\
3064Reload the module. The module must have been successfully imported before.");
3065
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003066/* Doc strings */
3067
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003068PyDoc_STRVAR(doc_imp,
3069"This module provides the components needed to build your own\n\
3070__import__ function. Undocumented functions are obsolete.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003071
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003072PyDoc_STRVAR(doc_find_module,
3073"find_module(name, [path]) -> (file, filename, (suffix, mode, type))\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003074Search for a module. If path is omitted or None, search for a\n\
3075built-in, frozen or special module and continue search in sys.path.\n\
3076The module name cannot contain '.'; to search for a submodule of a\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003077package, pass the submodule name and the package's __path__.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003078
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003079PyDoc_STRVAR(doc_load_module,
3080"load_module(name, file, filename, (suffix, mode, type)) -> module\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003081Load a module, given information returned by find_module().\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003082The module name must include the full package name, if any.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003083
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003084PyDoc_STRVAR(doc_get_magic,
3085"get_magic() -> string\n\
3086Return the magic number for .pyc or .pyo files.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003087
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003088PyDoc_STRVAR(doc_get_suffixes,
3089"get_suffixes() -> [(suffix, mode, type), ...]\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003090Return a list of (suffix, mode, type) tuples describing the files\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003091that find_module() looks for.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003092
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003093PyDoc_STRVAR(doc_new_module,
3094"new_module(name) -> module\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003095Create a new module. Do not enter it in sys.modules.\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003096The module name must include the full package name, if any.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003097
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003098PyDoc_STRVAR(doc_lock_held,
Tim Petersa7c65092004-08-01 23:26:05 +00003099"lock_held() -> boolean\n\
3100Return True if the import lock is currently held, else False.\n\
3101On platforms without threads, return False.");
Tim Peters69232342001-08-30 05:16:13 +00003102
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00003103PyDoc_STRVAR(doc_acquire_lock,
3104"acquire_lock() -> None\n\
Neal Norwitz2294c0d2003-02-12 23:02:21 +00003105Acquires the interpreter's import lock for the current thread.\n\
3106This lock should be used by import hooks to ensure thread-safety\n\
3107when importing modules.\n\
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00003108On platforms without threads, this function does nothing.");
3109
3110PyDoc_STRVAR(doc_release_lock,
3111"release_lock() -> None\n\
3112Release the interpreter's import lock.\n\
3113On platforms without threads, this function does nothing.");
3114
Guido van Rossum79f25d91997-04-29 20:08:16 +00003115static PyMethodDef imp_methods[] = {
Neal Norwitz08ea61a2003-02-17 18:18:00 +00003116 {"find_module", imp_find_module, METH_VARARGS, doc_find_module},
3117 {"get_magic", imp_get_magic, METH_NOARGS, doc_get_magic},
3118 {"get_suffixes", imp_get_suffixes, METH_NOARGS, doc_get_suffixes},
3119 {"load_module", imp_load_module, METH_VARARGS, doc_load_module},
3120 {"new_module", imp_new_module, METH_VARARGS, doc_new_module},
3121 {"lock_held", imp_lock_held, METH_NOARGS, doc_lock_held},
3122 {"acquire_lock", imp_acquire_lock, METH_NOARGS, doc_acquire_lock},
3123 {"release_lock", imp_release_lock, METH_NOARGS, doc_release_lock},
Christian Heimes13a7a212008-01-07 17:13:09 +00003124 {"reload", imp_reload, METH_O, doc_reload},
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003125 /* The rest are obsolete */
Neal Norwitz031829d2002-03-31 14:37:44 +00003126 {"get_frozen_object", imp_get_frozen_object, METH_VARARGS},
3127 {"init_builtin", imp_init_builtin, METH_VARARGS},
3128 {"init_frozen", imp_init_frozen, METH_VARARGS},
3129 {"is_builtin", imp_is_builtin, METH_VARARGS},
3130 {"is_frozen", imp_is_frozen, METH_VARARGS},
3131 {"load_compiled", imp_load_compiled, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003132#ifdef HAVE_DYNAMIC_LOADING
Neal Norwitz031829d2002-03-31 14:37:44 +00003133 {"load_dynamic", imp_load_dynamic, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003134#endif
Neal Norwitz031829d2002-03-31 14:37:44 +00003135 {"load_package", imp_load_package, METH_VARARGS},
Neal Norwitz031829d2002-03-31 14:37:44 +00003136 {"load_source", imp_load_source, METH_VARARGS},
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003137 {NULL, NULL} /* sentinel */
3138};
3139
Guido van Rossum1a8791e1998-08-04 22:46:29 +00003140static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003141setint(PyObject *d, char *name, int value)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003142{
3143 PyObject *v;
3144 int err;
3145
Christian Heimes217cfd12007-12-02 14:31:20 +00003146 v = PyLong_FromLong((long)value);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003147 err = PyDict_SetItemString(d, name, v);
3148 Py_XDECREF(v);
3149 return err;
3150}
3151
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003152typedef struct {
3153 PyObject_HEAD
3154} NullImporter;
3155
3156static int
3157NullImporter_init(NullImporter *self, PyObject *args, PyObject *kwds)
3158{
3159 char *path;
Christian Heimes7d3bc0a2007-11-07 17:26:16 +00003160 Py_ssize_t pathlen;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003161
3162 if (!_PyArg_NoKeywords("NullImporter()", kwds))
3163 return -1;
3164
Amaury Forgeot d'Arcf1ca0b12008-06-11 17:40:47 +00003165 if (!PyArg_ParseTuple(args, "es:NullImporter",
3166 Py_FileSystemDefaultEncoding, &path))
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003167 return -1;
3168
Christian Heimes7d3bc0a2007-11-07 17:26:16 +00003169 pathlen = strlen(path);
3170 if (pathlen == 0) {
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003171 PyErr_SetString(PyExc_ImportError, "empty pathname");
3172 return -1;
3173 } else {
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003174 struct stat statbuf;
3175 int rv;
3176
3177 rv = stat(path, &statbuf);
Guido van Rossumc1bdbc32007-11-07 17:46:34 +00003178#ifdef MS_WINDOWS
3179 /* MS Windows stat() chokes on paths like C:\path\. Try to
3180 * recover *one* time by stripping off a trailing slash or
3181 * backslash. http://bugs.python.org/issue1293
3182 */
Christian Heimes7d3bc0a2007-11-07 17:26:16 +00003183 if (rv != 0 && pathlen <= MAXPATHLEN &&
3184 (path[pathlen-1] == '/' || path[pathlen-1] == '\\')) {
3185 char mangled[MAXPATHLEN+1];
3186
3187 strcpy(mangled, path);
3188 mangled[pathlen-1] = '\0';
3189 rv = stat(mangled, &statbuf);
3190 }
Christian Heimes7d3bc0a2007-11-07 17:26:16 +00003191#endif
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003192 if (rv == 0) {
3193 /* it exists */
3194 if (S_ISDIR(statbuf.st_mode)) {
3195 /* it's a directory */
3196 PyErr_SetString(PyExc_ImportError,
3197 "existing directory");
3198 return -1;
3199 }
3200 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003201 }
3202 return 0;
3203}
3204
3205static PyObject *
3206NullImporter_find_module(NullImporter *self, PyObject *args)
3207{
3208 Py_RETURN_NONE;
3209}
3210
3211static PyMethodDef NullImporter_methods[] = {
3212 {"find_module", (PyCFunction)NullImporter_find_module, METH_VARARGS,
3213 "Always return None"
3214 },
3215 {NULL} /* Sentinel */
3216};
3217
3218
Christian Heimes9cd17752007-11-18 19:35:23 +00003219PyTypeObject PyNullImporter_Type = {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00003220 PyVarObject_HEAD_INIT(NULL, 0)
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003221 "imp.NullImporter", /*tp_name*/
3222 sizeof(NullImporter), /*tp_basicsize*/
3223 0, /*tp_itemsize*/
3224 0, /*tp_dealloc*/
3225 0, /*tp_print*/
3226 0, /*tp_getattr*/
3227 0, /*tp_setattr*/
3228 0, /*tp_compare*/
3229 0, /*tp_repr*/
3230 0, /*tp_as_number*/
3231 0, /*tp_as_sequence*/
3232 0, /*tp_as_mapping*/
3233 0, /*tp_hash */
3234 0, /*tp_call*/
3235 0, /*tp_str*/
3236 0, /*tp_getattro*/
3237 0, /*tp_setattro*/
3238 0, /*tp_as_buffer*/
3239 Py_TPFLAGS_DEFAULT, /*tp_flags*/
3240 "Null importer object", /* tp_doc */
3241 0, /* tp_traverse */
3242 0, /* tp_clear */
3243 0, /* tp_richcompare */
3244 0, /* tp_weaklistoffset */
3245 0, /* tp_iter */
3246 0, /* tp_iternext */
3247 NullImporter_methods, /* tp_methods */
3248 0, /* tp_members */
3249 0, /* tp_getset */
3250 0, /* tp_base */
3251 0, /* tp_dict */
3252 0, /* tp_descr_get */
3253 0, /* tp_descr_set */
3254 0, /* tp_dictoffset */
3255 (initproc)NullImporter_init, /* tp_init */
3256 0, /* tp_alloc */
3257 PyType_GenericNew /* tp_new */
3258};
3259
Martin v. Löwis1a214512008-06-11 05:26:20 +00003260static struct PyModuleDef impmodule = {
3261 PyModuleDef_HEAD_INIT,
3262 "imp",
3263 doc_imp,
3264 0,
3265 imp_methods,
3266 NULL,
3267 NULL,
3268 NULL,
3269 NULL
3270};
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003271
Jason Tishler6bc06ec2003-09-04 11:59:50 +00003272PyMODINIT_FUNC
Martin v. Löwis1a214512008-06-11 05:26:20 +00003273PyInit_imp(void)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003274{
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003275 PyObject *m, *d;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003276
Christian Heimes9cd17752007-11-18 19:35:23 +00003277 if (PyType_Ready(&PyNullImporter_Type) < 0)
Martin v. Löwis1a214512008-06-11 05:26:20 +00003278 return NULL;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003279
Martin v. Löwis1a214512008-06-11 05:26:20 +00003280 m = PyModule_Create(&impmodule);
Neal Norwitz1ac754f2006-01-19 06:09:39 +00003281 if (m == NULL)
3282 goto failure;
Guido van Rossum79f25d91997-04-29 20:08:16 +00003283 d = PyModule_GetDict(m);
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00003284 if (d == NULL)
3285 goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003286
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003287 if (setint(d, "SEARCH_ERROR", SEARCH_ERROR) < 0) goto failure;
3288 if (setint(d, "PY_SOURCE", PY_SOURCE) < 0) goto failure;
3289 if (setint(d, "PY_COMPILED", PY_COMPILED) < 0) goto failure;
3290 if (setint(d, "C_EXTENSION", C_EXTENSION) < 0) goto failure;
3291 if (setint(d, "PY_RESOURCE", PY_RESOURCE) < 0) goto failure;
3292 if (setint(d, "PKG_DIRECTORY", PKG_DIRECTORY) < 0) goto failure;
3293 if (setint(d, "C_BUILTIN", C_BUILTIN) < 0) goto failure;
3294 if (setint(d, "PY_FROZEN", PY_FROZEN) < 0) goto failure;
Guido van Rossum0f84a341998-08-06 13:36:01 +00003295 if (setint(d, "PY_CODERESOURCE", PY_CODERESOURCE) < 0) goto failure;
Just van Rossum52e14d62002-12-30 22:08:05 +00003296 if (setint(d, "IMP_HOOK", IMP_HOOK) < 0) goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003297
Christian Heimes9cd17752007-11-18 19:35:23 +00003298 Py_INCREF(&PyNullImporter_Type);
3299 PyModule_AddObject(m, "NullImporter", (PyObject *)&PyNullImporter_Type);
Martin v. Löwis1a214512008-06-11 05:26:20 +00003300 return m;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003301 failure:
Martin v. Löwis1a214512008-06-11 05:26:20 +00003302 Py_XDECREF(m);
3303 return NULL;
3304
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003305}
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003306
3307
Guido van Rossumb18618d2000-05-03 23:44:39 +00003308/* API for embedding applications that want to add their own entries
3309 to the table of built-in modules. This should normally be called
3310 *before* Py_Initialize(). When the table resize fails, -1 is
3311 returned and the existing table is unchanged.
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003312
3313 After a similar function by Just van Rossum. */
3314
3315int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003316PyImport_ExtendInittab(struct _inittab *newtab)
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003317{
3318 static struct _inittab *our_copy = NULL;
3319 struct _inittab *p;
3320 int i, n;
3321
3322 /* Count the number of entries in both tables */
3323 for (n = 0; newtab[n].name != NULL; n++)
3324 ;
3325 if (n == 0)
3326 return 0; /* Nothing to do */
3327 for (i = 0; PyImport_Inittab[i].name != NULL; i++)
3328 ;
3329
3330 /* Allocate new memory for the combined table */
Guido van Rossumb18618d2000-05-03 23:44:39 +00003331 p = our_copy;
3332 PyMem_RESIZE(p, struct _inittab, i+n+1);
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003333 if (p == NULL)
3334 return -1;
3335
3336 /* Copy the tables into the new memory */
3337 if (our_copy != PyImport_Inittab)
3338 memcpy(p, PyImport_Inittab, (i+1) * sizeof(struct _inittab));
3339 PyImport_Inittab = our_copy = p;
3340 memcpy(p+i, newtab, (n+1) * sizeof(struct _inittab));
3341
3342 return 0;
3343}
3344
3345/* Shorthand to add a single entry given a name and a function */
3346
3347int
Martin v. Löwis1a214512008-06-11 05:26:20 +00003348PyImport_AppendInittab(char *name, PyObject* (*initfunc)(void))
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003349{
3350 struct _inittab newtab[2];
3351
3352 memset(newtab, '\0', sizeof newtab);
3353
3354 newtab[0].name = name;
3355 newtab[0].initfunc = initfunc;
3356
3357 return PyImport_ExtendInittab(newtab);
3358}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00003359
3360#ifdef __cplusplus
3361}
3362#endif