blob: 2b825876b5ba309c7764b8ae98fcb592bcdb8e4a [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
Guido van Rossum21d335e1993-10-15 13:01:11 +000030
Jeremy Hyltond4ceb312004-04-01 02:45:22 +000031/* Magic word to reject .pyc files generated by other Python versions.
32 It should change for each incompatible change to the bytecode.
33
34 The value of CR and LF is incorporated so if you ever read or write
Guido van Rossum7faeab31995-07-07 22:50:36 +000035 a .pyc file in text mode the magic number will be wrong; also, the
Tim Peters36515e22001-11-18 04:06:29 +000036 Apple MPW compiler swaps their values, botching string constants.
Marc-André Lemburgbd3be8f2002-02-07 11:33:49 +000037
Guido van Rossum45aecf42006-03-15 04:58:47 +000038 The magic numbers must be spaced apart at least 2 values, as the
Martin v. Löwisef82d2f2004-06-27 16:51:46 +000039 -U interpeter flag will cause MAGIC+1 being used. They have been
40 odd numbers for some time now.
Marc-André Lemburgbd3be8f2002-02-07 11:33:49 +000041
Jeremy Hyltond4ceb312004-04-01 02:45:22 +000042 There were a variety of old schemes for setting the magic number.
43 The current working scheme is to increment the previous value by
44 10.
Guido van Rossumf6894922002-08-31 15:16:14 +000045
Marc-André Lemburgbd3be8f2002-02-07 11:33:49 +000046 Known values:
47 Python 1.5: 20121
48 Python 1.5.1: 20121
49 Python 1.5.2: 20121
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000050 Python 1.6: 50428
Marc-André Lemburgbd3be8f2002-02-07 11:33:49 +000051 Python 2.0: 50823
52 Python 2.0.1: 50823
53 Python 2.1: 60202
54 Python 2.1.1: 60202
55 Python 2.1.2: 60202
56 Python 2.2: 60717
Neal Norwitz7fdcb412002-06-14 01:07:39 +000057 Python 2.3a0: 62011
Michael W. Hudsondd32a912002-08-15 14:59:02 +000058 Python 2.3a0: 62021
Guido van Rossumf6894922002-08-31 15:16:14 +000059 Python 2.3a0: 62011 (!)
Martin v. Löwisef82d2f2004-06-27 16:51:46 +000060 Python 2.4a0: 62041
Raymond Hettingerfd2d1f72004-08-23 23:37:48 +000061 Python 2.4a3: 62051
Raymond Hettinger2c31a052004-09-22 18:44:21 +000062 Python 2.4b1: 62061
Michael W. Hudsondf888462005-06-03 14:41:55 +000063 Python 2.5a0: 62071
Michael W. Hudsonaee2e282005-10-21 11:32:20 +000064 Python 2.5a0: 62081 (ast-branch)
Guido van Rossumc2e20742006-02-27 22:32:47 +000065 Python 2.5a0: 62091 (with)
Guido van Rossumf6694362006-03-10 02:28:35 +000066 Python 2.5a0: 62092 (changed WITH_CLEANUP opcode)
Thomas Wouters0e3f5912006-08-11 14:57:12 +000067 Python 2.5b3: 62101 (fix wrong code: for x, in ...)
68 Python 2.5b3: 62111 (fix wrong code: x += yield)
69 Python 2.5c1: 62121 (fix wrong lnotab with for loops and
70 storing constants that should have been removed)
Thomas Wouters89f507f2006-12-13 04:49:30 +000071 Python 2.5c2: 62131 (fix wrong code: for x, in ... in listcomp/genexp)
Christian Heimes99170a52007-12-19 02:07:34 +000072 Python 2.6a0: 62151 (peephole optimizations and STORE_MAP opcode)
Christian Heimesdd15f6c2008-03-16 00:07:10 +000073 Python 2.6a1: 62161 (WITH_CLEANUP optimization)
Guido van Rossum45aecf42006-03-15 04:58:47 +000074 Python 3000: 3000
Brett Cannone2e23ef2006-08-25 05:05:30 +000075 3010 (removed UNARY_CONVERT)
Guido van Rossum86e58e22006-08-28 15:27:34 +000076 3020 (added BUILD_SET)
Guido van Rossum4f72a782006-10-27 23:31:49 +000077 3030 (added keyword-only parameters)
Guido van Rossum3203bdc2006-12-28 21:03:31 +000078 3040 (added signature annotations)
Guido van Rossum452bf512007-02-09 05:32:43 +000079 3050 (print becomes a function)
Guido van Rossum52cc1d82007-03-18 15:41:51 +000080 3060 (PEP 3115 metaclass syntax)
Guido van Rossum00bc0e02007-10-15 02:52:41 +000081 3070 (PEP 3109 raise changes)
82 3080 (PEP 3137 make __file__ and __name__ unicode)
Guido van Rossum98297ee2007-11-06 21:34:58 +000083 3090 (kill str8 interning)
Christian Heimes99170a52007-12-19 02:07:34 +000084 3100 (merge from 2.6a0, see 62151)
Christian Heimes3b06e532008-01-07 20:12:44 +000085 3102 (__file__ points to source file)
Christian Heimesdd15f6c2008-03-16 00:07:10 +000086 Python 3.0a4: 3110 (WITH_CLEANUP optimization).
Benjamin Petersoneec3d712008-06-11 15:59:43 +000087 Python 3.0a5: 3130 (lexical exception stacking, including POP_EXCEPT)
Antoine Pitrouf289ae62008-12-18 11:06:25 +000088 Python 3.1a0: 3140 (optimize list, set and dict comprehensions:
89 change LIST_APPEND and SET_ADD, add MAP_ADD)
Jeffrey Yasskin9de7ec72009-02-25 02:25:04 +000090 Python 3.1a0: 3150 (optimize conditional branches:
91 introduce POP_JUMP_IF_FALSE and POP_JUMP_IF_TRUE)
Tim Peters36515e22001-11-18 04:06:29 +000092*/
Jeffrey Yasskin9de7ec72009-02-25 02:25:04 +000093#define MAGIC (3150 | ((long)'\r'<<16) | ((long)'\n'<<24))
Guido van Rossum3ddee711991-12-16 13:06:34 +000094
Guido van Rossum96774c12000-05-01 20:19:08 +000095/* Magic word as global; note that _PyImport_Init() can change the
Jeremy Hylton9262b8a2000-06-30 04:59:17 +000096 value of this global to accommodate for alterations of how the
Guido van Rossum96774c12000-05-01 20:19:08 +000097 compiler works which are enabled by command line switches. */
98static long pyc_magic = MAGIC;
99
Guido van Rossum25ce5661997-08-02 03:10:38 +0000100/* See _PyImport_FixupExtension() below */
101static PyObject *extensions = NULL;
Guido van Rossum3f5da241990-12-20 15:06:42 +0000102
Guido van Rossum771c6c81997-10-31 18:37:24 +0000103/* This table is defined in config.c: */
104extern struct _inittab _PyImport_Inittab[];
105
Guido van Rossumce3a72a2007-10-19 23:16:50 +0000106/* Method from Parser/tokenizer.c */
Guido van Rossum40d20bc2007-10-22 00:09:51 +0000107extern char * PyTokenizer_FindEncoding(int);
Guido van Rossumce3a72a2007-10-19 23:16:50 +0000108
Guido van Rossum771c6c81997-10-31 18:37:24 +0000109struct _inittab *PyImport_Inittab = _PyImport_Inittab;
Guido van Rossum66f1fa81991-04-03 19:03:52 +0000110
Guido van Rossumed1170e1999-12-20 21:23:41 +0000111/* these tables define the module suffixes that Python recognizes */
112struct filedescr * _PyImport_Filetab = NULL;
Guido van Rossum48a680c2001-03-02 06:34:14 +0000113
Guido van Rossumed1170e1999-12-20 21:23:41 +0000114static const struct filedescr _PyImport_StandardFiletab[] = {
Jack Jansenc88da1f2002-05-28 10:58:19 +0000115 {".py", "U", PY_SOURCE},
Martin v. Löwis6238d2b2002-06-30 15:26:10 +0000116#ifdef MS_WINDOWS
Jack Jansenc88da1f2002-05-28 10:58:19 +0000117 {".pyw", "U", PY_SOURCE},
Tim Peters36515e22001-11-18 04:06:29 +0000118#endif
Guido van Rossumed1170e1999-12-20 21:23:41 +0000119 {".pyc", "rb", PY_COMPILED},
120 {0, 0}
121};
122
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000123
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000124/* Initialize things */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000125
126void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000127_PyImport_Init(void)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000128{
Guido van Rossumed1170e1999-12-20 21:23:41 +0000129 const struct filedescr *scan;
130 struct filedescr *filetab;
131 int countD = 0;
132 int countS = 0;
133
134 /* prepare _PyImport_Filetab: copy entries from
135 _PyImport_DynLoadFiletab and _PyImport_StandardFiletab.
136 */
Guido van Rossum04110fb2007-08-24 16:32:05 +0000137#ifdef HAVE_DYNAMIC_LOADING
Guido van Rossumed1170e1999-12-20 21:23:41 +0000138 for (scan = _PyImport_DynLoadFiletab; scan->suffix != NULL; ++scan)
139 ++countD;
Guido van Rossum04110fb2007-08-24 16:32:05 +0000140#endif
Guido van Rossumed1170e1999-12-20 21:23:41 +0000141 for (scan = _PyImport_StandardFiletab; scan->suffix != NULL; ++scan)
142 ++countS;
Guido van Rossumb18618d2000-05-03 23:44:39 +0000143 filetab = PyMem_NEW(struct filedescr, countD + countS + 1);
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000144 if (filetab == NULL)
145 Py_FatalError("Can't initialize import file table.");
Guido van Rossum04110fb2007-08-24 16:32:05 +0000146#ifdef HAVE_DYNAMIC_LOADING
Guido van Rossumed1170e1999-12-20 21:23:41 +0000147 memcpy(filetab, _PyImport_DynLoadFiletab,
148 countD * sizeof(struct filedescr));
Guido van Rossum04110fb2007-08-24 16:32:05 +0000149#endif
Guido van Rossumed1170e1999-12-20 21:23:41 +0000150 memcpy(filetab + countD, _PyImport_StandardFiletab,
151 countS * sizeof(struct filedescr));
152 filetab[countD + countS].suffix = NULL;
153
154 _PyImport_Filetab = filetab;
155
Guido van Rossum0824f631997-03-11 18:37:35 +0000156 if (Py_OptimizeFlag) {
Guido van Rossumed1170e1999-12-20 21:23:41 +0000157 /* Replace ".pyc" with ".pyo" in _PyImport_Filetab */
158 for (; filetab->suffix != NULL; filetab++) {
159 if (strcmp(filetab->suffix, ".pyc") == 0)
160 filetab->suffix = ".pyo";
Guido van Rossum0824f631997-03-11 18:37:35 +0000161 }
162 }
Guido van Rossum96774c12000-05-01 20:19:08 +0000163
Guido van Rossum572dbf82007-04-27 23:53:51 +0000164 {
Guido van Rossum96774c12000-05-01 20:19:08 +0000165 /* Fix the pyc_magic so that byte compiled code created
166 using the all-Unicode method doesn't interfere with
167 code created in normal operation mode. */
168 pyc_magic = MAGIC + 1;
169 }
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000170}
171
Guido van Rossum25ce5661997-08-02 03:10:38 +0000172void
Just van Rossum52e14d62002-12-30 22:08:05 +0000173_PyImportHooks_Init(void)
174{
175 PyObject *v, *path_hooks = NULL, *zimpimport;
176 int err = 0;
177
178 /* adding sys.path_hooks and sys.path_importer_cache, setting up
179 zipimport */
Christian Heimes9cd17752007-11-18 19:35:23 +0000180 if (PyType_Ready(&PyNullImporter_Type) < 0)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000181 goto error;
Just van Rossum52e14d62002-12-30 22:08:05 +0000182
183 if (Py_VerboseFlag)
184 PySys_WriteStderr("# installing zipimport hook\n");
185
186 v = PyList_New(0);
187 if (v == NULL)
188 goto error;
189 err = PySys_SetObject("meta_path", v);
190 Py_DECREF(v);
191 if (err)
192 goto error;
193 v = PyDict_New();
194 if (v == NULL)
195 goto error;
196 err = PySys_SetObject("path_importer_cache", v);
197 Py_DECREF(v);
198 if (err)
199 goto error;
200 path_hooks = PyList_New(0);
201 if (path_hooks == NULL)
202 goto error;
203 err = PySys_SetObject("path_hooks", path_hooks);
204 if (err) {
205 error:
206 PyErr_Print();
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000207 Py_FatalError("initializing sys.meta_path, sys.path_hooks, "
208 "path_importer_cache, or NullImporter failed"
209 );
Just van Rossum52e14d62002-12-30 22:08:05 +0000210 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000211
Just van Rossum52e14d62002-12-30 22:08:05 +0000212 zimpimport = PyImport_ImportModule("zipimport");
213 if (zimpimport == NULL) {
214 PyErr_Clear(); /* No zip import module -- okay */
215 if (Py_VerboseFlag)
216 PySys_WriteStderr("# can't import zipimport\n");
217 }
218 else {
219 PyObject *zipimporter = PyObject_GetAttrString(zimpimport,
220 "zipimporter");
221 Py_DECREF(zimpimport);
222 if (zipimporter == NULL) {
223 PyErr_Clear(); /* No zipimporter object -- okay */
224 if (Py_VerboseFlag)
225 PySys_WriteStderr(
Fred Drake1e5fc552003-07-11 15:01:02 +0000226 "# can't import zipimport.zipimporter\n");
Just van Rossum52e14d62002-12-30 22:08:05 +0000227 }
228 else {
229 /* sys.path_hooks.append(zipimporter) */
230 err = PyList_Append(path_hooks, zipimporter);
231 Py_DECREF(zipimporter);
232 if (err)
233 goto error;
234 if (Py_VerboseFlag)
235 PySys_WriteStderr(
236 "# installed zipimport hook\n");
237 }
238 }
239 Py_DECREF(path_hooks);
240}
241
242void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000243_PyImport_Fini(void)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000244{
245 Py_XDECREF(extensions);
246 extensions = NULL;
Barry Warsaw84294482000-10-03 16:02:05 +0000247 PyMem_DEL(_PyImport_Filetab);
248 _PyImport_Filetab = NULL;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000249}
250
251
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000252/* Locking primitives to prevent parallel imports of the same module
253 in different threads to return with a partially loaded module.
254 These calls are serialized by the global interpreter lock. */
255
256#ifdef WITH_THREAD
257
Guido van Rossum49b56061998-10-01 20:42:43 +0000258#include "pythread.h"
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000259
Guido van Rossum65d5b571998-12-21 19:32:43 +0000260static PyThread_type_lock import_lock = 0;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000261static long import_lock_thread = -1;
262static int import_lock_level = 0;
263
264static void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000265lock_import(void)
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000266{
Guido van Rossum65d5b571998-12-21 19:32:43 +0000267 long me = PyThread_get_thread_ident();
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000268 if (me == -1)
269 return; /* Too bad */
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000270 if (import_lock == NULL) {
Guido van Rossum65d5b571998-12-21 19:32:43 +0000271 import_lock = PyThread_allocate_lock();
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000272 if (import_lock == NULL)
273 return; /* Nothing much we can do. */
274 }
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000275 if (import_lock_thread == me) {
276 import_lock_level++;
277 return;
278 }
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000279 if (import_lock_thread != -1 || !PyThread_acquire_lock(import_lock, 0))
280 {
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000281 PyThreadState *tstate = PyEval_SaveThread();
Guido van Rossum65d5b571998-12-21 19:32:43 +0000282 PyThread_acquire_lock(import_lock, 1);
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000283 PyEval_RestoreThread(tstate);
284 }
285 import_lock_thread = me;
286 import_lock_level = 1;
287}
288
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000289static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000290unlock_import(void)
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000291{
Guido van Rossum65d5b571998-12-21 19:32:43 +0000292 long me = PyThread_get_thread_ident();
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000293 if (me == -1 || import_lock == NULL)
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000294 return 0; /* Too bad */
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000295 if (import_lock_thread != me)
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000296 return -1;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000297 import_lock_level--;
298 if (import_lock_level == 0) {
299 import_lock_thread = -1;
Guido van Rossum65d5b571998-12-21 19:32:43 +0000300 PyThread_release_lock(import_lock);
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000301 }
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000302 return 1;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000303}
304
Guido van Rossum8ee3e5a2005-09-14 18:09:42 +0000305/* This function is called from PyOS_AfterFork to ensure that newly
306 created child processes do not share locks with the parent. */
307
308void
309_PyImport_ReInitLock(void)
310{
311#ifdef _AIX
312 if (import_lock != NULL)
313 import_lock = PyThread_allocate_lock();
314#endif
315}
316
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000317#else
318
319#define lock_import()
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000320#define unlock_import() 0
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000321
322#endif
323
Tim Peters69232342001-08-30 05:16:13 +0000324static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000325imp_lock_held(PyObject *self, PyObject *noargs)
Tim Peters69232342001-08-30 05:16:13 +0000326{
Tim Peters69232342001-08-30 05:16:13 +0000327#ifdef WITH_THREAD
Guido van Rossumb8bff3f2002-04-07 06:34:38 +0000328 return PyBool_FromLong(import_lock_thread != -1);
Tim Peters69232342001-08-30 05:16:13 +0000329#else
Guido van Rossumb8bff3f2002-04-07 06:34:38 +0000330 return PyBool_FromLong(0);
Tim Peters69232342001-08-30 05:16:13 +0000331#endif
332}
333
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000334static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000335imp_acquire_lock(PyObject *self, PyObject *noargs)
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000336{
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000337#ifdef WITH_THREAD
338 lock_import();
339#endif
Neal Norwitz2294c0d2003-02-12 23:02:21 +0000340 Py_INCREF(Py_None);
341 return Py_None;
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000342}
343
344static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000345imp_release_lock(PyObject *self, PyObject *noargs)
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000346{
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000347#ifdef WITH_THREAD
348 if (unlock_import() < 0) {
349 PyErr_SetString(PyExc_RuntimeError,
350 "not holding the import lock");
351 return NULL;
352 }
353#endif
Neal Norwitz2294c0d2003-02-12 23:02:21 +0000354 Py_INCREF(Py_None);
355 return Py_None;
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000356}
357
Guido van Rossumd8faa362007-04-27 19:54:29 +0000358static void
359imp_modules_reloading_clear(void)
360{
361 PyInterpreterState *interp = PyThreadState_Get()->interp;
362 if (interp->modules_reloading != NULL)
363 PyDict_Clear(interp->modules_reloading);
364}
365
Guido van Rossum25ce5661997-08-02 03:10:38 +0000366/* Helper for sys */
367
368PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000369PyImport_GetModuleDict(void)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000370{
Nicholas Bastine5662ae2004-03-24 22:22:12 +0000371 PyInterpreterState *interp = PyThreadState_GET()->interp;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000372 if (interp->modules == NULL)
373 Py_FatalError("PyImport_GetModuleDict: no module dictionary!");
374 return interp->modules;
375}
376
Guido van Rossum3f5da241990-12-20 15:06:42 +0000377
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000378/* List of names to clear in sys */
379static char* sys_deletes[] = {
Collin Winter670e6922007-03-21 02:57:17 +0000380 "path", "argv", "ps1", "ps2",
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000381 "last_type", "last_value", "last_traceback",
Just van Rossum52e14d62002-12-30 22:08:05 +0000382 "path_hooks", "path_importer_cache", "meta_path",
Christian Heimes7b3ce6a2008-01-31 14:31:45 +0000383 /* misc stuff */
384 "flags", "float_info",
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000385 NULL
386};
387
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000388static char* sys_files[] = {
389 "stdin", "__stdin__",
390 "stdout", "__stdout__",
391 "stderr", "__stderr__",
392 NULL
393};
394
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000395
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000396/* Un-initialize things, as good as we can */
Guido van Rossum3f5da241990-12-20 15:06:42 +0000397
Guido van Rossum3f5da241990-12-20 15:06:42 +0000398void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000399PyImport_Cleanup(void)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000400{
Martin v. Löwis18e16552006-02-15 17:27:45 +0000401 Py_ssize_t pos, ndone;
Guido van Rossum758eec01998-01-19 21:58:26 +0000402 char *name;
403 PyObject *key, *value, *dict;
Nicholas Bastine5662ae2004-03-24 22:22:12 +0000404 PyInterpreterState *interp = PyThreadState_GET()->interp;
Guido van Rossum758eec01998-01-19 21:58:26 +0000405 PyObject *modules = interp->modules;
406
407 if (modules == NULL)
408 return; /* Already done */
409
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000410 /* Delete some special variables first. These are common
411 places where user values hide and people complain when their
412 destructors fail. Since the modules containing them are
413 deleted *last* of all, they would come too late in the normal
414 destruction order. Sigh. */
415
Georg Brandl1a3284e2007-12-02 09:40:06 +0000416 value = PyDict_GetItemString(modules, "builtins");
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000417 if (value != NULL && PyModule_Check(value)) {
418 dict = PyModule_GetDict(value);
419 if (Py_VerboseFlag)
Georg Brandl1a3284e2007-12-02 09:40:06 +0000420 PySys_WriteStderr("# clear builtins._\n");
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000421 PyDict_SetItemString(dict, "_", Py_None);
422 }
423 value = PyDict_GetItemString(modules, "sys");
424 if (value != NULL && PyModule_Check(value)) {
425 char **p;
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000426 PyObject *v;
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000427 dict = PyModule_GetDict(value);
428 for (p = sys_deletes; *p != NULL; p++) {
429 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000430 PySys_WriteStderr("# clear sys.%s\n", *p);
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000431 PyDict_SetItemString(dict, *p, Py_None);
432 }
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000433 for (p = sys_files; *p != NULL; p+=2) {
434 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000435 PySys_WriteStderr("# restore sys.%s\n", *p);
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000436 v = PyDict_GetItemString(dict, *(p+1));
437 if (v == NULL)
438 v = Py_None;
439 PyDict_SetItemString(dict, *p, v);
440 }
441 }
442
443 /* First, delete __main__ */
444 value = PyDict_GetItemString(modules, "__main__");
445 if (value != NULL && PyModule_Check(value)) {
446 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000447 PySys_WriteStderr("# cleanup __main__\n");
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000448 _PyModule_Clear(value);
449 PyDict_SetItemString(modules, "__main__", Py_None);
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000450 }
451
Georg Brandl1a3284e2007-12-02 09:40:06 +0000452 /* The special treatment of "builtins" here is because even
Guido van Rossum758eec01998-01-19 21:58:26 +0000453 when it's not referenced as a module, its dictionary is
454 referenced by almost every module's __builtins__. Since
455 deleting a module clears its dictionary (even if there are
Georg Brandl1a3284e2007-12-02 09:40:06 +0000456 references left to it), we need to delete the "builtins"
Guido van Rossum758eec01998-01-19 21:58:26 +0000457 module last. Likewise, we don't delete sys until the very
458 end because it is implicitly referenced (e.g. by print).
459
460 Also note that we 'delete' modules by replacing their entry
461 in the modules dict with None, rather than really deleting
462 them; this avoids a rehash of the modules dictionary and
463 also marks them as "non existent" so they won't be
464 re-imported. */
465
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000466 /* Next, repeatedly delete modules with a reference count of
Georg Brandl1a3284e2007-12-02 09:40:06 +0000467 one (skipping builtins and sys) and delete them */
Guido van Rossum758eec01998-01-19 21:58:26 +0000468 do {
469 ndone = 0;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000470 pos = 0;
Guido van Rossum758eec01998-01-19 21:58:26 +0000471 while (PyDict_Next(modules, &pos, &key, &value)) {
472 if (value->ob_refcnt != 1)
473 continue;
Neal Norwitz80e7f272007-08-26 06:45:23 +0000474 if (PyUnicode_Check(key) && PyModule_Check(value)) {
Marc-André Lemburg4cc0f242008-08-07 18:54:33 +0000475 name = _PyUnicode_AsString(key);
Georg Brandl1a3284e2007-12-02 09:40:06 +0000476 if (strcmp(name, "builtins") == 0)
Guido van Rossum758eec01998-01-19 21:58:26 +0000477 continue;
478 if (strcmp(name, "sys") == 0)
479 continue;
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000480 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000481 PySys_WriteStderr(
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000482 "# cleanup[1] %s\n", name);
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000483 _PyModule_Clear(value);
Guido van Rossum758eec01998-01-19 21:58:26 +0000484 PyDict_SetItem(modules, key, Py_None);
485 ndone++;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000486 }
487 }
Guido van Rossum758eec01998-01-19 21:58:26 +0000488 } while (ndone > 0);
489
Georg Brandl1a3284e2007-12-02 09:40:06 +0000490 /* Next, delete all modules (still skipping builtins and sys) */
Guido van Rossum758eec01998-01-19 21:58:26 +0000491 pos = 0;
492 while (PyDict_Next(modules, &pos, &key, &value)) {
Neal Norwitz80e7f272007-08-26 06:45:23 +0000493 if (PyUnicode_Check(key) && PyModule_Check(value)) {
Marc-André Lemburg4cc0f242008-08-07 18:54:33 +0000494 name = _PyUnicode_AsString(key);
Georg Brandl1a3284e2007-12-02 09:40:06 +0000495 if (strcmp(name, "builtins") == 0)
Guido van Rossum758eec01998-01-19 21:58:26 +0000496 continue;
497 if (strcmp(name, "sys") == 0)
498 continue;
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000499 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000500 PySys_WriteStderr("# cleanup[2] %s\n", name);
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000501 _PyModule_Clear(value);
Guido van Rossum758eec01998-01-19 21:58:26 +0000502 PyDict_SetItem(modules, key, Py_None);
503 }
504 }
505
Georg Brandl1a3284e2007-12-02 09:40:06 +0000506 /* Next, delete sys and builtins (in that order) */
Guido van Rossum758eec01998-01-19 21:58:26 +0000507 value = PyDict_GetItemString(modules, "sys");
508 if (value != NULL && PyModule_Check(value)) {
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000509 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000510 PySys_WriteStderr("# cleanup sys\n");
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000511 _PyModule_Clear(value);
Guido van Rossum758eec01998-01-19 21:58:26 +0000512 PyDict_SetItemString(modules, "sys", Py_None);
513 }
Georg Brandl1a3284e2007-12-02 09:40:06 +0000514 value = PyDict_GetItemString(modules, "builtins");
Guido van Rossum758eec01998-01-19 21:58:26 +0000515 if (value != NULL && PyModule_Check(value)) {
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000516 if (Py_VerboseFlag)
Georg Brandl1a3284e2007-12-02 09:40:06 +0000517 PySys_WriteStderr("# cleanup builtins\n");
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000518 _PyModule_Clear(value);
Georg Brandl1a3284e2007-12-02 09:40:06 +0000519 PyDict_SetItemString(modules, "builtins", Py_None);
Guido van Rossum758eec01998-01-19 21:58:26 +0000520 }
521
522 /* Finally, clear and delete the modules directory */
523 PyDict_Clear(modules);
524 interp->modules = NULL;
525 Py_DECREF(modules);
Guido van Rossumd8faa362007-04-27 19:54:29 +0000526 Py_CLEAR(interp->modules_reloading);
Guido van Rossum8d15b5d1990-10-26 14:58:58 +0000527}
Guido van Rossum7f133ed1991-02-19 12:23:57 +0000528
529
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000530/* Helper for pythonrun.c -- return magic number */
531
532long
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000533PyImport_GetMagicNumber(void)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000534{
Guido van Rossum96774c12000-05-01 20:19:08 +0000535 return pyc_magic;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000536}
537
538
Guido van Rossum25ce5661997-08-02 03:10:38 +0000539/* Magic for extension modules (built-in as well as dynamically
540 loaded). To prevent initializing an extension module more than
541 once, we keep a static dictionary 'extensions' keyed by module name
542 (for built-in modules) or by filename (for dynamically loaded
Barry Warsaw92883382001-08-13 23:05:44 +0000543 modules), containing these modules. A copy of the module's
Guido van Rossum25ce5661997-08-02 03:10:38 +0000544 dictionary is stored by calling _PyImport_FixupExtension()
545 immediately after the module initialization function succeeds. A
546 copy can be retrieved from there by calling
Martin v. Löwis1a214512008-06-11 05:26:20 +0000547 _PyImport_FindExtension().
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000548
Martin v. Löwis1a214512008-06-11 05:26:20 +0000549 Modules which do support multiple multiple initialization set
550 their m_size field to a non-negative number (indicating the size
551 of the module-specific state). They are still recorded in the
552 extensions dictionary, to avoid loading shared libraries twice.
553*/
554
555int
556_PyImport_FixupExtension(PyObject *mod, char *name, char *filename)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000557{
Martin v. Löwis1a214512008-06-11 05:26:20 +0000558 PyObject *modules, *dict;
559 struct PyModuleDef *def;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000560 if (extensions == NULL) {
561 extensions = PyDict_New();
562 if (extensions == NULL)
Martin v. Löwis1a214512008-06-11 05:26:20 +0000563 return -1;
564 }
565 if (mod == NULL || !PyModule_Check(mod)) {
566 PyErr_BadInternalCall();
567 return -1;
568 }
569 def = PyModule_GetDef(mod);
570 if (!def) {
571 PyErr_BadInternalCall();
572 return -1;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000573 }
574 modules = PyImport_GetModuleDict();
Martin v. Löwis1a214512008-06-11 05:26:20 +0000575 if (PyDict_SetItemString(modules, name, mod) < 0)
576 return -1;
577 if (_PyState_AddModule(mod, def) < 0) {
578 PyDict_DelItemString(modules, name);
579 return -1;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000580 }
Martin v. Löwis1a214512008-06-11 05:26:20 +0000581 if (def->m_size == -1) {
582 if (def->m_base.m_copy) {
583 /* Somebody already imported the module,
584 likely under a different name.
585 XXX this should really not happen. */
586 Py_DECREF(def->m_base.m_copy);
587 def->m_base.m_copy = NULL;
588 }
589 dict = PyModule_GetDict(mod);
590 if (dict == NULL)
591 return -1;
592 def->m_base.m_copy = PyDict_Copy(dict);
593 if (def->m_base.m_copy == NULL)
594 return -1;
595 }
596 PyDict_SetItemString(extensions, filename, (PyObject*)def);
597 return 0;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000598}
599
600PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000601_PyImport_FindExtension(char *name, char *filename)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000602{
Martin v. Löwis1a214512008-06-11 05:26:20 +0000603 PyObject *mod, *mdict;
604 PyModuleDef* def;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000605 if (extensions == NULL)
606 return NULL;
Martin v. Löwis1a214512008-06-11 05:26:20 +0000607 def = (PyModuleDef*)PyDict_GetItemString(extensions, filename);
608 if (def == NULL)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000609 return NULL;
Martin v. Löwis1a214512008-06-11 05:26:20 +0000610 if (def->m_size == -1) {
611 /* Module does not support repeated initialization */
612 if (def->m_base.m_copy == NULL)
613 return NULL;
614 mod = PyImport_AddModule(name);
615 if (mod == NULL)
616 return NULL;
Martin v. Löwis1a214512008-06-11 05:26:20 +0000617 mdict = PyModule_GetDict(mod);
618 if (mdict == NULL)
619 return NULL;
620 if (PyDict_Update(mdict, def->m_base.m_copy))
621 return NULL;
622 }
623 else {
624 if (def->m_base.m_init == NULL)
625 return NULL;
626 mod = def->m_base.m_init();
627 if (mod == NULL)
628 return NULL;
629 PyDict_SetItemString(PyImport_GetModuleDict(), name, mod);
Benjamin Petersonad956532008-09-04 02:28:15 +0000630 Py_DECREF(mod);
Martin v. Löwis1a214512008-06-11 05:26:20 +0000631 }
632 if (_PyState_AddModule(mod, def) < 0) {
633 PyDict_DelItemString(PyImport_GetModuleDict(), name);
634 Py_DECREF(mod);
Guido van Rossum25ce5661997-08-02 03:10:38 +0000635 return NULL;
Martin v. Löwis1a214512008-06-11 05:26:20 +0000636 }
Guido van Rossum25ce5661997-08-02 03:10:38 +0000637 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000638 PySys_WriteStderr("import %s # previously loaded (%s)\n",
Martin v. Löwis1a214512008-06-11 05:26:20 +0000639 name, filename);
Guido van Rossum25ce5661997-08-02 03:10:38 +0000640 return mod;
Martin v. Löwis1a214512008-06-11 05:26:20 +0000641
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000642}
643
644
645/* Get the module object corresponding to a module name.
646 First check the modules dictionary if there's one there,
Walter Dörwaldf0dfc7a2003-10-20 14:01:56 +0000647 if not, create a new one and insert it in the modules dictionary.
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000648 Because the former action is most common, THIS DOES NOT RETURN A
649 'NEW' REFERENCE! */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000650
Guido van Rossum79f25d91997-04-29 20:08:16 +0000651PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000652PyImport_AddModule(const char *name)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000653{
Guido van Rossum25ce5661997-08-02 03:10:38 +0000654 PyObject *modules = PyImport_GetModuleDict();
Guido van Rossum79f25d91997-04-29 20:08:16 +0000655 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000656
Guido van Rossum25ce5661997-08-02 03:10:38 +0000657 if ((m = PyDict_GetItemString(modules, name)) != NULL &&
Guido van Rossum79f25d91997-04-29 20:08:16 +0000658 PyModule_Check(m))
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000659 return m;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000660 m = PyModule_New(name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000661 if (m == NULL)
662 return NULL;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000663 if (PyDict_SetItemString(modules, name, m) != 0) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000664 Py_DECREF(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000665 return NULL;
666 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000667 Py_DECREF(m); /* Yes, it still exists, in modules! */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000668
669 return m;
670}
671
Tim Peters1cd70172004-08-02 03:52:12 +0000672/* Remove name from sys.modules, if it's there. */
673static void
674_RemoveModule(const char *name)
675{
676 PyObject *modules = PyImport_GetModuleDict();
677 if (PyDict_GetItemString(modules, name) == NULL)
678 return;
679 if (PyDict_DelItemString(modules, name) < 0)
680 Py_FatalError("import: deleting existing key in"
681 "sys.modules failed");
682}
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000683
Christian Heimes3b06e532008-01-07 20:12:44 +0000684static PyObject * get_sourcefile(const char *file);
685
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000686/* Execute a code object in a module and return the module object
Tim Peters1cd70172004-08-02 03:52:12 +0000687 * WITH INCREMENTED REFERENCE COUNT. If an error occurs, name is
688 * removed from sys.modules, to avoid leaving damaged module objects
689 * in sys.modules. The caller may wish to restore the original
690 * module object (if any) in this case; PyImport_ReloadModule is an
691 * example.
692 */
Guido van Rossum79f25d91997-04-29 20:08:16 +0000693PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000694PyImport_ExecCodeModule(char *name, PyObject *co)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000695{
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000696 return PyImport_ExecCodeModuleEx(name, co, (char *)NULL);
697}
698
699PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000700PyImport_ExecCodeModuleEx(char *name, PyObject *co, char *pathname)
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000701{
Guido van Rossum25ce5661997-08-02 03:10:38 +0000702 PyObject *modules = PyImport_GetModuleDict();
Guido van Rossum79f25d91997-04-29 20:08:16 +0000703 PyObject *m, *d, *v;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000704
Guido van Rossum79f25d91997-04-29 20:08:16 +0000705 m = PyImport_AddModule(name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000706 if (m == NULL)
707 return NULL;
Jeremy Hyltonecd91292004-01-02 23:25:32 +0000708 /* If the module is being reloaded, we get the old module back
709 and re-use its dict to exec the new code. */
Guido van Rossum79f25d91997-04-29 20:08:16 +0000710 d = PyModule_GetDict(m);
711 if (PyDict_GetItemString(d, "__builtins__") == NULL) {
712 if (PyDict_SetItemString(d, "__builtins__",
713 PyEval_GetBuiltins()) != 0)
Tim Peters1cd70172004-08-02 03:52:12 +0000714 goto error;
Guido van Rossum6135a871995-01-09 17:53:26 +0000715 }
Guido van Rossum9c9a07c1996-05-16 20:43:40 +0000716 /* Remember the filename as the __file__ attribute */
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000717 v = NULL;
718 if (pathname != NULL) {
Christian Heimes3b06e532008-01-07 20:12:44 +0000719 v = get_sourcefile(pathname);
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000720 if (v == NULL)
721 PyErr_Clear();
722 }
723 if (v == NULL) {
724 v = ((PyCodeObject *)co)->co_filename;
725 Py_INCREF(v);
726 }
727 if (PyDict_SetItemString(d, "__file__", v) != 0)
Guido van Rossum79f25d91997-04-29 20:08:16 +0000728 PyErr_Clear(); /* Not important enough to report */
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000729 Py_DECREF(v);
730
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000731 v = PyEval_EvalCode((PyCodeObject *)co, d, d);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000732 if (v == NULL)
Tim Peters1cd70172004-08-02 03:52:12 +0000733 goto error;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000734 Py_DECREF(v);
Guido van Rossumb65e85c1997-07-10 18:00:45 +0000735
Guido van Rossum25ce5661997-08-02 03:10:38 +0000736 if ((m = PyDict_GetItemString(modules, name)) == NULL) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000737 PyErr_Format(PyExc_ImportError,
738 "Loaded module %.200s not found in sys.modules",
739 name);
Guido van Rossumb65e85c1997-07-10 18:00:45 +0000740 return NULL;
741 }
742
Guido van Rossum79f25d91997-04-29 20:08:16 +0000743 Py_INCREF(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000744
745 return m;
Tim Peters1cd70172004-08-02 03:52:12 +0000746
747 error:
748 _RemoveModule(name);
749 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000750}
751
752
753/* Given a pathname for a Python source file, fill a buffer with the
754 pathname for the corresponding compiled file. Return the pathname
755 for the compiled file, or NULL if there's no space in the buffer.
756 Doesn't set an exception. */
757
758static char *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000759make_compiled_pathname(char *pathname, char *buf, size_t buflen)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000760{
Tim Petersc1731372001-08-04 08:12:36 +0000761 size_t len = strlen(pathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000762 if (len+2 > buflen)
763 return NULL;
Tim Petersc1731372001-08-04 08:12:36 +0000764
Martin v. Löwis6238d2b2002-06-30 15:26:10 +0000765#ifdef MS_WINDOWS
Tim Petersc1731372001-08-04 08:12:36 +0000766 /* Treat .pyw as if it were .py. The case of ".pyw" must match
767 that used in _PyImport_StandardFiletab. */
768 if (len >= 4 && strcmp(&pathname[len-4], ".pyw") == 0)
769 --len; /* pretend 'w' isn't there */
770#endif
771 memcpy(buf, pathname, len);
772 buf[len] = Py_OptimizeFlag ? 'o' : 'c';
773 buf[len+1] = '\0';
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000774
775 return buf;
776}
777
778
779/* Given a pathname for a Python source file, its time of last
780 modification, and a pathname for a compiled file, check whether the
781 compiled file represents the same version of the source. If so,
782 return a FILE pointer for the compiled file, positioned just after
783 the header; if not, return NULL.
784 Doesn't set an exception. */
785
786static FILE *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000787check_compiled_module(char *pathname, time_t mtime, char *cpathname)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000788{
789 FILE *fp;
790 long magic;
791 long pyc_mtime;
792
793 fp = fopen(cpathname, "rb");
794 if (fp == NULL)
795 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000796 magic = PyMarshal_ReadLongFromFile(fp);
Guido van Rossum96774c12000-05-01 20:19:08 +0000797 if (magic != pyc_magic) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000798 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000799 PySys_WriteStderr("# %s has bad magic\n", cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000800 fclose(fp);
801 return NULL;
802 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000803 pyc_mtime = PyMarshal_ReadLongFromFile(fp);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000804 if (pyc_mtime != mtime) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000805 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000806 PySys_WriteStderr("# %s has bad mtime\n", cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000807 fclose(fp);
808 return NULL;
809 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000810 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000811 PySys_WriteStderr("# %s matches %s\n", cpathname, pathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000812 return fp;
813}
814
815
816/* Read a code object from a file and check it for validity */
817
Guido van Rossum79f25d91997-04-29 20:08:16 +0000818static PyCodeObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000819read_compiled_module(char *cpathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000820{
Guido van Rossum79f25d91997-04-29 20:08:16 +0000821 PyObject *co;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000822
Tim Petersd9b9ac82001-01-28 00:27:39 +0000823 co = PyMarshal_ReadLastObjectFromFile(fp);
Armin Rigo01ab2792004-03-26 15:09:27 +0000824 if (co == NULL)
825 return NULL;
826 if (!PyCode_Check(co)) {
827 PyErr_Format(PyExc_ImportError,
828 "Non-code object in %.200s", cpathname);
829 Py_DECREF(co);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000830 return NULL;
831 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000832 return (PyCodeObject *)co;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000833}
834
835
836/* Load a module from a compiled file, execute it, and return its
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000837 module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000838
Guido van Rossum79f25d91997-04-29 20:08:16 +0000839static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000840load_compiled_module(char *name, char *cpathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000841{
842 long magic;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000843 PyCodeObject *co;
844 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000845
Guido van Rossum79f25d91997-04-29 20:08:16 +0000846 magic = PyMarshal_ReadLongFromFile(fp);
Guido van Rossum96774c12000-05-01 20:19:08 +0000847 if (magic != pyc_magic) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000848 PyErr_Format(PyExc_ImportError,
849 "Bad magic number in %.200s", cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000850 return NULL;
851 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000852 (void) PyMarshal_ReadLongFromFile(fp);
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000853 co = read_compiled_module(cpathname, fp);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000854 if (co == NULL)
855 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000856 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000857 PySys_WriteStderr("import %s # precompiled from %s\n",
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000858 name, cpathname);
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000859 m = PyImport_ExecCodeModuleEx(name, (PyObject *)co, cpathname);
Guido van Rossum79f25d91997-04-29 20:08:16 +0000860 Py_DECREF(co);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000861
862 return m;
863}
864
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000865/* Parse a source file and return the corresponding code object */
866
Guido van Rossum79f25d91997-04-29 20:08:16 +0000867static PyCodeObject *
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000868parse_source_module(const char *pathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000869{
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000870 PyCodeObject *co = NULL;
871 mod_ty mod;
Christian Heimes4d6ec852008-03-26 22:34:47 +0000872 PyCompilerFlags flags;
Thomas Wouters89f507f2006-12-13 04:49:30 +0000873 PyArena *arena = PyArena_New();
874 if (arena == NULL)
875 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000876
Christian Heimesb1b3efc2008-03-26 23:24:27 +0000877 flags.cf_flags = 0;
Martin v. Löwis85bcc662007-09-04 09:18:06 +0000878 mod = PyParser_ASTFromFile(fp, pathname, NULL,
Christian Heimes4d6ec852008-03-26 22:34:47 +0000879 Py_file_input, 0, 0, &flags,
Neal Norwitzadb69fc2005-12-17 20:54:49 +0000880 NULL, arena);
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000881 if (mod) {
Neal Norwitzadb69fc2005-12-17 20:54:49 +0000882 co = PyAST_Compile(mod, pathname, NULL, arena);
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000883 }
Thomas Wouters89f507f2006-12-13 04:49:30 +0000884 PyArena_Free(arena);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000885 return co;
886}
887
888
Guido van Rossum55a83382000-09-20 20:31:38 +0000889/* Helper to open a bytecode file for writing in exclusive mode */
890
891static FILE *
Christian Heimes05e8be12008-02-23 18:30:17 +0000892open_exclusive(char *filename, mode_t mode)
Guido van Rossum55a83382000-09-20 20:31:38 +0000893{
894#if defined(O_EXCL)&&defined(O_CREAT)&&defined(O_WRONLY)&&defined(O_TRUNC)
895 /* Use O_EXCL to avoid a race condition when another process tries to
896 write the same file. When that happens, our open() call fails,
897 which is just fine (since it's only a cache).
898 XXX If the file exists and is writable but the directory is not
899 writable, the file will never be written. Oh well.
900 */
901 int fd;
902 (void) unlink(filename);
Tim Peters42c83af2000-09-29 04:03:10 +0000903 fd = open(filename, O_EXCL|O_CREAT|O_WRONLY|O_TRUNC
904#ifdef O_BINARY
905 |O_BINARY /* necessary for Windows */
906#endif
Martin v. Löwis79acb9e2002-12-06 12:48:53 +0000907#ifdef __VMS
Christian Heimes05e8be12008-02-23 18:30:17 +0000908 , mode, "ctxt=bin", "shr=nil"
Martin v. Löwis79acb9e2002-12-06 12:48:53 +0000909#else
Christian Heimes05e8be12008-02-23 18:30:17 +0000910 , mode
Martin v. Löwis79acb9e2002-12-06 12:48:53 +0000911#endif
Martin v. Löwis18e16552006-02-15 17:27:45 +0000912 );
Guido van Rossum55a83382000-09-20 20:31:38 +0000913 if (fd < 0)
914 return NULL;
915 return fdopen(fd, "wb");
916#else
917 /* Best we can do -- on Windows this can't happen anyway */
918 return fopen(filename, "wb");
919#endif
920}
921
922
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000923/* Write a compiled module to a file, placing the time of last
924 modification of its source into the header.
925 Errors are ignored, if a write error occurs an attempt is made to
926 remove the file. */
927
928static void
Christian Heimes05e8be12008-02-23 18:30:17 +0000929write_compiled_module(PyCodeObject *co, char *cpathname, struct stat *srcstat)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000930{
931 FILE *fp;
Christian Heimes05e8be12008-02-23 18:30:17 +0000932 time_t mtime = srcstat->st_mtime;
R. David Murray07fc01f2009-07-19 01:59:05 +0000933#ifdef MS_WINDOWS /* since Windows uses different permissions */
934 mode_t mode = srcstat->st_mode & ~S_IEXEC;
935#else
936 mode_t mode = srcstat->st_mode & ~S_IXUSR & ~S_IXGRP & ~S_IXOTH;
937#endif
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000938
Christian Heimes05e8be12008-02-23 18:30:17 +0000939 fp = open_exclusive(cpathname, mode);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000940 if (fp == NULL) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000941 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000942 PySys_WriteStderr(
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000943 "# can't create %s\n", cpathname);
944 return;
945 }
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000946 PyMarshal_WriteLongToFile(pyc_magic, fp, Py_MARSHAL_VERSION);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000947 /* First write a 0 for mtime */
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000948 PyMarshal_WriteLongToFile(0L, fp, Py_MARSHAL_VERSION);
949 PyMarshal_WriteObjectToFile((PyObject *)co, fp, Py_MARSHAL_VERSION);
Armin Rigo01ab2792004-03-26 15:09:27 +0000950 if (fflush(fp) != 0 || ferror(fp)) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000951 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000952 PySys_WriteStderr("# can't write %s\n", cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000953 /* Don't keep partial file */
954 fclose(fp);
955 (void) unlink(cpathname);
956 return;
957 }
958 /* Now write the true mtime */
959 fseek(fp, 4L, 0);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000960 assert(mtime < LONG_MAX);
Martin v. Löwis725507b2006-03-07 12:08:51 +0000961 PyMarshal_WriteLongToFile((long)mtime, fp, Py_MARSHAL_VERSION);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000962 fflush(fp);
963 fclose(fp);
Guido van Rossum79f25d91997-04-29 20:08:16 +0000964 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000965 PySys_WriteStderr("# wrote %s\n", cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000966}
967
Antoine Pitroud35cbf62009-01-06 19:02:24 +0000968static void
969update_code_filenames(PyCodeObject *co, PyObject *oldname, PyObject *newname)
970{
971 PyObject *constants, *tmp;
972 Py_ssize_t i, n;
973
974 if (PyUnicode_Compare(co->co_filename, oldname))
975 return;
976
977 tmp = co->co_filename;
978 co->co_filename = newname;
979 Py_INCREF(co->co_filename);
980 Py_DECREF(tmp);
981
982 constants = co->co_consts;
983 n = PyTuple_GET_SIZE(constants);
984 for (i = 0; i < n; i++) {
985 tmp = PyTuple_GET_ITEM(constants, i);
986 if (PyCode_Check(tmp))
987 update_code_filenames((PyCodeObject *)tmp,
988 oldname, newname);
989 }
990}
991
992static int
993update_compiled_module(PyCodeObject *co, char *pathname)
994{
995 PyObject *oldname, *newname;
996
Hirokazu Yamamoto4f447fb2009-03-04 01:52:10 +0000997 newname = PyUnicode_DecodeFSDefault(pathname);
Antoine Pitroud35cbf62009-01-06 19:02:24 +0000998 if (newname == NULL)
999 return -1;
1000
Hirokazu Yamamoto4f447fb2009-03-04 01:52:10 +00001001 if (!PyUnicode_Compare(co->co_filename, newname)) {
1002 Py_DECREF(newname);
1003 return 0;
1004 }
1005
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001006 oldname = co->co_filename;
1007 Py_INCREF(oldname);
1008 update_code_filenames(co, oldname, newname);
1009 Py_DECREF(oldname);
1010 Py_DECREF(newname);
1011 return 1;
1012}
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001013
1014/* Load a source module from a given file and return its module
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001015 object WITH INCREMENTED REFERENCE COUNT. If there's a matching
1016 byte-compiled file, use that instead. */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001017
Guido van Rossum79f25d91997-04-29 20:08:16 +00001018static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001019load_source_module(char *name, char *pathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001020{
Christian Heimes05e8be12008-02-23 18:30:17 +00001021 struct stat st;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001022 FILE *fpc;
1023 char buf[MAXPATHLEN+1];
1024 char *cpathname;
Guido van Rossum79f25d91997-04-29 20:08:16 +00001025 PyCodeObject *co;
1026 PyObject *m;
Christian Heimes05e8be12008-02-23 18:30:17 +00001027
1028 if (fstat(fileno(fp), &st) != 0) {
Neal Norwitz708e51a2005-10-03 04:48:15 +00001029 PyErr_Format(PyExc_RuntimeError,
Christian Heimes05e8be12008-02-23 18:30:17 +00001030 "unable to get file status from '%s'",
Neal Norwitz708e51a2005-10-03 04:48:15 +00001031 pathname);
Fred Drake4c82b232000-06-30 16:18:57 +00001032 return NULL;
Neal Norwitz708e51a2005-10-03 04:48:15 +00001033 }
Fred Drake4c82b232000-06-30 16:18:57 +00001034#if SIZEOF_TIME_T > 4
1035 /* Python's .pyc timestamp handling presumes that the timestamp fits
1036 in 4 bytes. This will be fine until sometime in the year 2038,
1037 when a 4-byte signed time_t will overflow.
1038 */
Christian Heimes05e8be12008-02-23 18:30:17 +00001039 if (st.st_mtime >> 32) {
Fred Drake4c82b232000-06-30 16:18:57 +00001040 PyErr_SetString(PyExc_OverflowError,
Fred Drakec63d3e92001-03-01 06:33:32 +00001041 "modification time overflows a 4 byte field");
Fred Drake4c82b232000-06-30 16:18:57 +00001042 return NULL;
1043 }
1044#endif
Tim Peters36515e22001-11-18 04:06:29 +00001045 cpathname = make_compiled_pathname(pathname, buf,
Jeremy Hylton37832f02001-04-13 17:50:20 +00001046 (size_t)MAXPATHLEN + 1);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001047 if (cpathname != NULL &&
Christian Heimes05e8be12008-02-23 18:30:17 +00001048 (fpc = check_compiled_module(pathname, st.st_mtime, cpathname))) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001049 co = read_compiled_module(cpathname, fpc);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001050 fclose(fpc);
1051 if (co == NULL)
1052 return NULL;
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001053 if (update_compiled_module(co, pathname) < 0)
1054 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +00001055 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +00001056 PySys_WriteStderr("import %s # precompiled from %s\n",
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001057 name, cpathname);
Guido van Rossumafd3dae1998-08-25 18:44:34 +00001058 pathname = cpathname;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001059 }
1060 else {
1061 co = parse_source_module(pathname, fp);
1062 if (co == NULL)
1063 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +00001064 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +00001065 PySys_WriteStderr("import %s # from %s\n",
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001066 name, pathname);
Christian Heimes790c8232008-01-07 21:14:23 +00001067 if (cpathname) {
1068 PyObject *ro = PySys_GetObject("dont_write_bytecode");
1069 if (ro == NULL || !PyObject_IsTrue(ro))
Christian Heimes05e8be12008-02-23 18:30:17 +00001070 write_compiled_module(co, cpathname, &st);
Christian Heimes790c8232008-01-07 21:14:23 +00001071 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001072 }
Guido van Rossumafd3dae1998-08-25 18:44:34 +00001073 m = PyImport_ExecCodeModuleEx(name, (PyObject *)co, pathname);
Guido van Rossum79f25d91997-04-29 20:08:16 +00001074 Py_DECREF(co);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001075
1076 return m;
1077}
1078
Christian Heimes3b06e532008-01-07 20:12:44 +00001079/* Get source file -> unicode or None
1080 * Returns the path to the py file if available, else the given path
1081 */
1082static PyObject *
1083get_sourcefile(const char *file)
1084{
1085 char py[MAXPATHLEN + 1];
1086 Py_ssize_t len;
1087 PyObject *u;
1088 struct stat statbuf;
1089
1090 if (!file || !*file) {
1091 Py_RETURN_NONE;
1092 }
1093
1094 len = strlen(file);
Christian Heimes3540b502008-01-11 07:03:05 +00001095 /* match '*.py?' */
1096 if (len > MAXPATHLEN || PyOS_strnicmp(&file[len-4], ".py", 3) != 0) {
Christian Heimes3b06e532008-01-07 20:12:44 +00001097 return PyUnicode_DecodeFSDefault(file);
1098 }
1099
1100 strncpy(py, file, len-1);
Martin v. Löwis5021ebc2008-03-22 22:07:13 +00001101 py[len-1] = '\0';
Christian Heimes3b06e532008-01-07 20:12:44 +00001102 if (stat(py, &statbuf) == 0 &&
1103 S_ISREG(statbuf.st_mode)) {
1104 u = PyUnicode_DecodeFSDefault(py);
1105 }
1106 else {
1107 u = PyUnicode_DecodeFSDefault(file);
1108 }
1109 return u;
1110}
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001111
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001112/* Forward */
Just van Rossum52e14d62002-12-30 22:08:05 +00001113static PyObject *load_module(char *, FILE *, char *, int, PyObject *);
1114static struct filedescr *find_module(char *, char *, PyObject *,
1115 char *, size_t, FILE **, PyObject **);
Christian Heimes3b06e532008-01-07 20:12:44 +00001116static struct _frozen * find_frozen(char *);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001117
1118/* Load a package and return its module object WITH INCREMENTED
1119 REFERENCE COUNT */
1120
1121static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001122load_package(char *name, char *pathname)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001123{
Tim Peters1cd70172004-08-02 03:52:12 +00001124 PyObject *m, *d;
1125 PyObject *file = NULL;
1126 PyObject *path = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001127 int err;
1128 char buf[MAXPATHLEN+1];
1129 FILE *fp = NULL;
1130 struct filedescr *fdp;
1131
1132 m = PyImport_AddModule(name);
1133 if (m == NULL)
1134 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00001135 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +00001136 PySys_WriteStderr("import %s # directory %s\n",
Guido van Rossum17fc85f1997-09-06 18:52:03 +00001137 name, pathname);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001138 d = PyModule_GetDict(m);
Christian Heimes3b06e532008-01-07 20:12:44 +00001139 file = get_sourcefile(pathname);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001140 if (file == NULL)
Tim Peters1cd70172004-08-02 03:52:12 +00001141 goto error;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001142 path = Py_BuildValue("[O]", file);
Tim Peters1cd70172004-08-02 03:52:12 +00001143 if (path == NULL)
1144 goto error;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001145 err = PyDict_SetItemString(d, "__file__", file);
1146 if (err == 0)
1147 err = PyDict_SetItemString(d, "__path__", path);
Tim Peters1cd70172004-08-02 03:52:12 +00001148 if (err != 0)
1149 goto error;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001150 buf[0] = '\0';
Just van Rossum52e14d62002-12-30 22:08:05 +00001151 fdp = find_module(name, "__init__", path, buf, sizeof(buf), &fp, NULL);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001152 if (fdp == NULL) {
1153 if (PyErr_ExceptionMatches(PyExc_ImportError)) {
1154 PyErr_Clear();
Thomas Heller25653242004-06-07 15:04:10 +00001155 Py_INCREF(m);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001156 }
1157 else
1158 m = NULL;
1159 goto cleanup;
1160 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001161 m = load_module(name, fp, buf, fdp->type, NULL);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001162 if (fp != NULL)
1163 fclose(fp);
Tim Peters1cd70172004-08-02 03:52:12 +00001164 goto cleanup;
1165
1166 error:
1167 m = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001168 cleanup:
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001169 Py_XDECREF(path);
1170 Py_XDECREF(file);
1171 return m;
1172}
1173
1174
1175/* Helper to test for built-in module */
1176
1177static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001178is_builtin(char *name)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001179{
1180 int i;
Guido van Rossum771c6c81997-10-31 18:37:24 +00001181 for (i = 0; PyImport_Inittab[i].name != NULL; i++) {
1182 if (strcmp(name, PyImport_Inittab[i].name) == 0) {
1183 if (PyImport_Inittab[i].initfunc == NULL)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001184 return -1;
1185 else
1186 return 1;
1187 }
1188 }
1189 return 0;
1190}
1191
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001192
Just van Rossum52e14d62002-12-30 22:08:05 +00001193/* Return an importer object for a sys.path/pkg.__path__ item 'p',
1194 possibly by fetching it from the path_importer_cache dict. If it
Thomas Wouters89f507f2006-12-13 04:49:30 +00001195 wasn't yet cached, traverse path_hooks until a hook is found
Just van Rossum52e14d62002-12-30 22:08:05 +00001196 that can handle the path item. Return None if no hook could;
1197 this tells our caller it should fall back to the builtin
1198 import mechanism. Cache the result in path_importer_cache.
1199 Returns a borrowed reference. */
1200
1201static PyObject *
1202get_path_importer(PyObject *path_importer_cache, PyObject *path_hooks,
1203 PyObject *p)
1204{
1205 PyObject *importer;
Martin v. Löwis725507b2006-03-07 12:08:51 +00001206 Py_ssize_t j, nhooks;
Just van Rossum52e14d62002-12-30 22:08:05 +00001207
1208 /* These conditions are the caller's responsibility: */
1209 assert(PyList_Check(path_hooks));
1210 assert(PyDict_Check(path_importer_cache));
1211
1212 nhooks = PyList_Size(path_hooks);
1213 if (nhooks < 0)
1214 return NULL; /* Shouldn't happen */
1215
1216 importer = PyDict_GetItem(path_importer_cache, p);
1217 if (importer != NULL)
1218 return importer;
1219
1220 /* set path_importer_cache[p] to None to avoid recursion */
1221 if (PyDict_SetItem(path_importer_cache, p, Py_None) != 0)
1222 return NULL;
1223
1224 for (j = 0; j < nhooks; j++) {
1225 PyObject *hook = PyList_GetItem(path_hooks, j);
1226 if (hook == NULL)
1227 return NULL;
Thomas Wouters477c8d52006-05-27 19:21:47 +00001228 importer = PyObject_CallFunctionObjArgs(hook, p, NULL);
Just van Rossum52e14d62002-12-30 22:08:05 +00001229 if (importer != NULL)
1230 break;
1231
1232 if (!PyErr_ExceptionMatches(PyExc_ImportError)) {
1233 return NULL;
1234 }
1235 PyErr_Clear();
1236 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001237 if (importer == NULL) {
1238 importer = PyObject_CallFunctionObjArgs(
Christian Heimes9cd17752007-11-18 19:35:23 +00001239 (PyObject *)&PyNullImporter_Type, p, NULL
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001240 );
1241 if (importer == NULL) {
1242 if (PyErr_ExceptionMatches(PyExc_ImportError)) {
1243 PyErr_Clear();
1244 return Py_None;
1245 }
1246 }
1247 }
1248 if (importer != NULL) {
Just van Rossum52e14d62002-12-30 22:08:05 +00001249 int err = PyDict_SetItem(path_importer_cache, p, importer);
1250 Py_DECREF(importer);
1251 if (err != 0)
1252 return NULL;
1253 }
1254 return importer;
1255}
1256
Christian Heimes9cd17752007-11-18 19:35:23 +00001257PyAPI_FUNC(PyObject *)
1258PyImport_GetImporter(PyObject *path) {
1259 PyObject *importer=NULL, *path_importer_cache=NULL, *path_hooks=NULL;
1260
1261 if ((path_importer_cache = PySys_GetObject("path_importer_cache"))) {
1262 if ((path_hooks = PySys_GetObject("path_hooks"))) {
1263 importer = get_path_importer(path_importer_cache,
1264 path_hooks, path);
1265 }
1266 }
1267 Py_XINCREF(importer); /* get_path_importer returns a borrowed reference */
1268 return importer;
1269}
1270
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001271/* Search the path (default sys.path) for a module. Return the
1272 corresponding filedescr struct, and (via return arguments) the
1273 pathname and an open file. Return NULL if the module is not found. */
1274
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001275#ifdef MS_COREDLL
Thomas Woutersb4bd21c2000-07-22 23:38:01 +00001276extern FILE *PyWin_FindRegisteredModule(const char *, struct filedescr **,
Martin v. Löwis18e16552006-02-15 17:27:45 +00001277 char *, Py_ssize_t);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001278#endif
1279
Martin v. Löwis18e16552006-02-15 17:27:45 +00001280static int case_ok(char *, Py_ssize_t, Py_ssize_t, char *);
Tim Petersdbd9ba62000-07-09 03:09:57 +00001281static int find_init_module(char *); /* Forward */
Just van Rossum52e14d62002-12-30 22:08:05 +00001282static struct filedescr importhookdescr = {"", "", IMP_HOOK};
Guido van Rossum197346f1997-10-31 18:38:52 +00001283
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001284static struct filedescr *
Just van Rossum52e14d62002-12-30 22:08:05 +00001285find_module(char *fullname, char *subname, PyObject *path, char *buf,
1286 size_t buflen, FILE **p_fp, PyObject **p_loader)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001287{
Martin v. Löwis725507b2006-03-07 12:08:51 +00001288 Py_ssize_t i, npath;
Fred Drake4c82b232000-06-30 16:18:57 +00001289 size_t len, namelen;
Guido van Rossum80bb9651996-12-05 23:27:02 +00001290 struct filedescr *fdp = NULL;
Jack Jansenc88da1f2002-05-28 10:58:19 +00001291 char *filemode;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001292 FILE *fp = NULL;
Just van Rossum52e14d62002-12-30 22:08:05 +00001293 PyObject *path_hooks, *path_importer_cache;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001294 struct stat statbuf;
Guido van Rossuma5568d31998-03-05 03:45:08 +00001295 static struct filedescr fd_frozen = {"", "", PY_FROZEN};
1296 static struct filedescr fd_builtin = {"", "", C_BUILTIN};
1297 static struct filedescr fd_package = {"", "", PKG_DIRECTORY};
Guido van Rossum0506a431998-08-11 15:07:39 +00001298 char name[MAXPATHLEN+1];
Andrew MacIntyred9400542002-02-26 11:41:34 +00001299#if defined(PYOS_OS2)
1300 size_t saved_len;
1301 size_t saved_namelen;
1302 char *saved_buf = NULL;
1303#endif
Just van Rossum52e14d62002-12-30 22:08:05 +00001304 if (p_loader != NULL)
1305 *p_loader = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001306
Just van Rossum52e14d62002-12-30 22:08:05 +00001307 if (strlen(subname) > MAXPATHLEN) {
Guido van Rossum8f4d3312001-10-18 18:54:11 +00001308 PyErr_SetString(PyExc_OverflowError,
1309 "module name is too long");
Fred Drake4c82b232000-06-30 16:18:57 +00001310 return NULL;
1311 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001312 strcpy(name, subname);
1313
1314 /* sys.meta_path import hook */
1315 if (p_loader != NULL) {
1316 PyObject *meta_path;
1317
1318 meta_path = PySys_GetObject("meta_path");
1319 if (meta_path == NULL || !PyList_Check(meta_path)) {
1320 PyErr_SetString(PyExc_ImportError,
1321 "sys.meta_path must be a list of "
1322 "import hooks");
1323 return NULL;
1324 }
1325 Py_INCREF(meta_path); /* zap guard */
1326 npath = PyList_Size(meta_path);
1327 for (i = 0; i < npath; i++) {
1328 PyObject *loader;
1329 PyObject *hook = PyList_GetItem(meta_path, i);
1330 loader = PyObject_CallMethod(hook, "find_module",
1331 "sO", fullname,
1332 path != NULL ?
1333 path : Py_None);
1334 if (loader == NULL) {
1335 Py_DECREF(meta_path);
1336 return NULL; /* true error */
1337 }
1338 if (loader != Py_None) {
1339 /* a loader was found */
1340 *p_loader = loader;
1341 Py_DECREF(meta_path);
1342 return &importhookdescr;
1343 }
1344 Py_DECREF(loader);
1345 }
1346 Py_DECREF(meta_path);
1347 }
Guido van Rossum0506a431998-08-11 15:07:39 +00001348
Benjamin Petersond968e272008-11-05 22:48:33 +00001349 if (find_frozen(fullname) != NULL) {
1350 strcpy(buf, fullname);
1351 return &fd_frozen;
Guido van Rossum0506a431998-08-11 15:07:39 +00001352 }
Benjamin Petersond968e272008-11-05 22:48:33 +00001353
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001354 if (path == NULL) {
1355 if (is_builtin(name)) {
Guido van Rossuma5568d31998-03-05 03:45:08 +00001356 strcpy(buf, name);
1357 return &fd_builtin;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001358 }
Guido van Rossumac279101996-08-22 23:10:58 +00001359#ifdef MS_COREDLL
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001360 fp = PyWin_FindRegisteredModule(name, &fdp, buf, buflen);
1361 if (fp != NULL) {
1362 *p_fp = fp;
1363 return fdp;
1364 }
Guido van Rossuma5a3db71996-04-09 02:39:59 +00001365#endif
Guido van Rossuma5568d31998-03-05 03:45:08 +00001366 path = PySys_GetObject("path");
1367 }
Benjamin Petersond968e272008-11-05 22:48:33 +00001368
Guido van Rossum79f25d91997-04-29 20:08:16 +00001369 if (path == NULL || !PyList_Check(path)) {
1370 PyErr_SetString(PyExc_ImportError,
Guido van Rossuma5568d31998-03-05 03:45:08 +00001371 "sys.path must be a list of directory names");
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001372 return NULL;
1373 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001374
1375 path_hooks = PySys_GetObject("path_hooks");
1376 if (path_hooks == NULL || !PyList_Check(path_hooks)) {
1377 PyErr_SetString(PyExc_ImportError,
1378 "sys.path_hooks must be a list of "
1379 "import hooks");
1380 return NULL;
1381 }
1382 path_importer_cache = PySys_GetObject("path_importer_cache");
1383 if (path_importer_cache == NULL ||
1384 !PyDict_Check(path_importer_cache)) {
1385 PyErr_SetString(PyExc_ImportError,
1386 "sys.path_importer_cache must be a dict");
1387 return NULL;
1388 }
1389
Guido van Rossum79f25d91997-04-29 20:08:16 +00001390 npath = PyList_Size(path);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001391 namelen = strlen(name);
1392 for (i = 0; i < npath; i++) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00001393 PyObject *v = PyList_GetItem(path, i);
Guido van Rossumf15a29f2007-05-04 00:41:39 +00001394 PyObject *origv = v;
Guido van Rossum6262cc72007-05-09 23:29:27 +00001395 const char *base;
Guido van Rossumf15a29f2007-05-04 00:41:39 +00001396 Py_ssize_t size;
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001397 if (!v)
1398 return NULL;
Guido van Rossuma4b8d1d2007-08-27 15:02:28 +00001399 if (PyUnicode_Check(v)) {
Amaury Forgeot d'Arcf1ca0b12008-06-11 17:40:47 +00001400 v = PyUnicode_AsEncodedString(v,
1401 Py_FileSystemDefaultEncoding, NULL);
Guido van Rossuma4b8d1d2007-08-27 15:02:28 +00001402 if (v == NULL)
1403 return NULL;
1404 }
Amaury Forgeot d'Arcf1ca0b12008-06-11 17:40:47 +00001405 else if (!PyBytes_Check(v))
Guido van Rossuma4b8d1d2007-08-27 15:02:28 +00001406 continue;
Amaury Forgeot d'Arcf1ca0b12008-06-11 17:40:47 +00001407 else
1408 Py_INCREF(v);
1409
Christian Heimes72b710a2008-05-26 13:28:38 +00001410 base = PyBytes_AS_STRING(v);
1411 size = PyBytes_GET_SIZE(v);
Guido van Rossumf15a29f2007-05-04 00:41:39 +00001412 len = size;
Walter Dörwald3430d702002-06-17 10:43:59 +00001413 if (len + 2 + namelen + MAXSUFFIXSIZE >= buflen) {
Amaury Forgeot d'Arcf1ca0b12008-06-11 17:40:47 +00001414 Py_DECREF(v);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001415 continue; /* Too long */
Walter Dörwald3430d702002-06-17 10:43:59 +00001416 }
Guido van Rossumf15a29f2007-05-04 00:41:39 +00001417 strcpy(buf, base);
Amaury Forgeot d'Arcf1ca0b12008-06-11 17:40:47 +00001418 Py_DECREF(v);
1419
Walter Dörwald3430d702002-06-17 10:43:59 +00001420 if (strlen(buf) != len) {
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001421 continue; /* v contains '\0' */
Walter Dörwald3430d702002-06-17 10:43:59 +00001422 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001423
1424 /* sys.path_hooks import hook */
1425 if (p_loader != NULL) {
1426 PyObject *importer;
1427
1428 importer = get_path_importer(path_importer_cache,
Guido van Rossumf15a29f2007-05-04 00:41:39 +00001429 path_hooks, origv);
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001430 if (importer == NULL) {
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001431 return NULL;
Thomas Wouters477c8d52006-05-27 19:21:47 +00001432 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001433 /* Note: importer is a borrowed reference */
1434 if (importer != Py_None) {
Just van Rossum52e14d62002-12-30 22:08:05 +00001435 PyObject *loader;
1436 loader = PyObject_CallMethod(importer,
1437 "find_module",
1438 "s", fullname);
1439 if (loader == NULL)
1440 return NULL; /* error */
1441 if (loader != Py_None) {
1442 /* a loader was found */
1443 *p_loader = loader;
1444 return &importhookdescr;
1445 }
1446 Py_DECREF(loader);
Thomas Wouters477c8d52006-05-27 19:21:47 +00001447 continue;
Just van Rossum52e14d62002-12-30 22:08:05 +00001448 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001449 }
Thomas Wouters477c8d52006-05-27 19:21:47 +00001450 /* no hook was found, use builtin import */
Just van Rossum52e14d62002-12-30 22:08:05 +00001451
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001452 if (len > 0 && buf[len-1] != SEP
1453#ifdef ALTSEP
1454 && buf[len-1] != ALTSEP
1455#endif
1456 )
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001457 buf[len++] = SEP;
Guido van Rossum215c3402000-11-13 17:26:32 +00001458 strcpy(buf+len, name);
1459 len += namelen;
Tim Peters50d8d372001-02-28 05:34:27 +00001460
1461 /* Check for package import (buf holds a directory name,
1462 and there's an __init__ module in that directory */
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001463#ifdef HAVE_STAT
Walter Dörwald3430d702002-06-17 10:43:59 +00001464 if (stat(buf, &statbuf) == 0 && /* it exists */
1465 S_ISDIR(statbuf.st_mode) && /* it's a directory */
Thomas Wouters477c8d52006-05-27 19:21:47 +00001466 case_ok(buf, len, namelen, name)) { /* case matches */
1467 if (find_init_module(buf)) { /* and has __init__.py */
Thomas Wouters477c8d52006-05-27 19:21:47 +00001468 return &fd_package;
1469 }
1470 else {
1471 char warnstr[MAXPATHLEN+80];
1472 sprintf(warnstr, "Not importing directory "
1473 "'%.*s': missing __init__.py",
1474 MAXPATHLEN, buf);
Skip Montanaro46fc3372007-08-12 11:44:53 +00001475 if (PyErr_WarnEx(PyExc_ImportWarning,
1476 warnstr, 1)) {
Thomas Wouters477c8d52006-05-27 19:21:47 +00001477 return NULL;
1478 }
1479 }
Walter Dörwald3430d702002-06-17 10:43:59 +00001480 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001481#endif
Andrew MacIntyred9400542002-02-26 11:41:34 +00001482#if defined(PYOS_OS2)
1483 /* take a snapshot of the module spec for restoration
1484 * after the 8 character DLL hackery
1485 */
1486 saved_buf = strdup(buf);
1487 saved_len = len;
1488 saved_namelen = namelen;
1489#endif /* PYOS_OS2 */
Guido van Rossum79f25d91997-04-29 20:08:16 +00001490 for (fdp = _PyImport_Filetab; fdp->suffix != NULL; fdp++) {
Guido van Rossum04110fb2007-08-24 16:32:05 +00001491#if defined(PYOS_OS2) && defined(HAVE_DYNAMIC_LOADING)
Jeremy Hylton4ae6fae2002-05-30 17:15:25 +00001492 /* OS/2 limits DLLs to 8 character names (w/o
1493 extension)
Andrew MacIntyred9400542002-02-26 11:41:34 +00001494 * so if the name is longer than that and its a
1495 * dynamically loaded module we're going to try,
1496 * truncate the name before trying
1497 */
Just van Rossum52e14d62002-12-30 22:08:05 +00001498 if (strlen(subname) > 8) {
Andrew MacIntyred9400542002-02-26 11:41:34 +00001499 /* is this an attempt to load a C extension? */
Jeremy Hylton4ae6fae2002-05-30 17:15:25 +00001500 const struct filedescr *scan;
1501 scan = _PyImport_DynLoadFiletab;
Andrew MacIntyred9400542002-02-26 11:41:34 +00001502 while (scan->suffix != NULL) {
Jeremy Hylton4ae6fae2002-05-30 17:15:25 +00001503 if (!strcmp(scan->suffix, fdp->suffix))
Andrew MacIntyred9400542002-02-26 11:41:34 +00001504 break;
1505 else
1506 scan++;
1507 }
1508 if (scan->suffix != NULL) {
1509 /* yes, so truncate the name */
1510 namelen = 8;
Just van Rossum52e14d62002-12-30 22:08:05 +00001511 len -= strlen(subname) - namelen;
Andrew MacIntyred9400542002-02-26 11:41:34 +00001512 buf[len] = '\0';
1513 }
1514 }
1515#endif /* PYOS_OS2 */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001516 strcpy(buf+len, fdp->suffix);
Guido van Rossum79f25d91997-04-29 20:08:16 +00001517 if (Py_VerboseFlag > 1)
Guido van Rossum2f3667a1998-10-12 18:23:55 +00001518 PySys_WriteStderr("# trying %s\n", buf);
Jack Jansenc88da1f2002-05-28 10:58:19 +00001519 filemode = fdp->mode;
Tim Peters86c7d2f2004-08-01 23:24:21 +00001520 if (filemode[0] == 'U')
Jeremy Hylton4ae6fae2002-05-30 17:15:25 +00001521 filemode = "r" PY_STDIOTEXTMODE;
Jack Jansenc88da1f2002-05-28 10:58:19 +00001522 fp = fopen(buf, filemode);
Tim Peters50d8d372001-02-28 05:34:27 +00001523 if (fp != NULL) {
1524 if (case_ok(buf, len, namelen, name))
1525 break;
1526 else { /* continue search */
1527 fclose(fp);
1528 fp = NULL;
Barry Warsaw914a0b12001-02-02 19:12:16 +00001529 }
Barry Warsaw914a0b12001-02-02 19:12:16 +00001530 }
Andrew MacIntyred9400542002-02-26 11:41:34 +00001531#if defined(PYOS_OS2)
1532 /* restore the saved snapshot */
1533 strcpy(buf, saved_buf);
1534 len = saved_len;
1535 namelen = saved_namelen;
1536#endif
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001537 }
Andrew MacIntyred9400542002-02-26 11:41:34 +00001538#if defined(PYOS_OS2)
1539 /* don't need/want the module name snapshot anymore */
1540 if (saved_buf)
1541 {
1542 free(saved_buf);
1543 saved_buf = NULL;
1544 }
1545#endif
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001546 if (fp != NULL)
1547 break;
1548 }
1549 if (fp == NULL) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001550 PyErr_Format(PyExc_ImportError,
1551 "No module named %.200s", name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001552 return NULL;
1553 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001554 *p_fp = fp;
1555 return fdp;
1556}
1557
Raymond Hettingerdb29e0f2004-10-07 06:46:25 +00001558/* Helpers for main.c
1559 * Find the source file corresponding to a named module
1560 */
1561struct filedescr *
1562_PyImport_FindModule(const char *name, PyObject *path, char *buf,
1563 size_t buflen, FILE **p_fp, PyObject **p_loader)
1564{
1565 return find_module((char *) name, (char *) name, path,
1566 buf, buflen, p_fp, p_loader);
1567}
1568
1569PyAPI_FUNC(int) _PyImport_IsScript(struct filedescr * fd)
1570{
1571 return fd->type == PY_SOURCE || fd->type == PY_COMPILED;
1572}
1573
Martin v. Löwis18e16552006-02-15 17:27:45 +00001574/* case_ok(char* buf, Py_ssize_t len, Py_ssize_t namelen, char* name)
Tim Petersd1e87a82001-03-01 18:12:00 +00001575 * The arguments here are tricky, best shown by example:
1576 * /a/b/c/d/e/f/g/h/i/j/k/some_long_module_name.py\0
1577 * ^ ^ ^ ^
1578 * |--------------------- buf ---------------------|
1579 * |------------------- len ------------------|
1580 * |------ name -------|
1581 * |----- namelen -----|
1582 * buf is the full path, but len only counts up to (& exclusive of) the
1583 * extension. name is the module name, also exclusive of extension.
1584 *
1585 * We've already done a successful stat() or fopen() on buf, so know that
1586 * there's some match, possibly case-insensitive.
1587 *
Tim Peters50d8d372001-02-28 05:34:27 +00001588 * case_ok() is to return 1 if there's a case-sensitive match for
1589 * name, else 0. case_ok() is also to return 1 if envar PYTHONCASEOK
1590 * exists.
Tim Petersd1e87a82001-03-01 18:12:00 +00001591 *
Tim Peters50d8d372001-02-28 05:34:27 +00001592 * case_ok() is used to implement case-sensitive import semantics even
1593 * on platforms with case-insensitive filesystems. It's trivial to implement
1594 * for case-sensitive filesystems. It's pretty much a cross-platform
1595 * nightmare for systems with case-insensitive filesystems.
1596 */
Guido van Rossum0980bd91998-02-13 17:18:36 +00001597
Tim Peters50d8d372001-02-28 05:34:27 +00001598/* First we may need a pile of platform-specific header files; the sequence
1599 * of #if's here should match the sequence in the body of case_ok().
1600 */
Jason Tishler7961aa62005-05-20 00:56:54 +00001601#if defined(MS_WINDOWS)
Guido van Rossum0980bd91998-02-13 17:18:36 +00001602#include <windows.h>
Guido van Rossum4c3f57c2001-01-10 20:40:46 +00001603
Tim Peters50d8d372001-02-28 05:34:27 +00001604#elif defined(DJGPP)
1605#include <dir.h>
1606
Jason Tishler7961aa62005-05-20 00:56:54 +00001607#elif (defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) && defined(HAVE_DIRENT_H)
Tim Peters430f5d42001-03-01 01:30:56 +00001608#include <sys/types.h>
1609#include <dirent.h>
1610
Andrew MacIntyred9400542002-02-26 11:41:34 +00001611#elif defined(PYOS_OS2)
1612#define INCL_DOS
1613#define INCL_DOSERRORS
1614#define INCL_NOPMAPI
1615#include <os2.h>
Tim Peters50d8d372001-02-28 05:34:27 +00001616#endif
1617
Guido van Rossum0980bd91998-02-13 17:18:36 +00001618static int
Martin v. Löwis18e16552006-02-15 17:27:45 +00001619case_ok(char *buf, Py_ssize_t len, Py_ssize_t namelen, char *name)
Guido van Rossum0980bd91998-02-13 17:18:36 +00001620{
Tim Peters50d8d372001-02-28 05:34:27 +00001621/* Pick a platform-specific implementation; the sequence of #if's here should
1622 * match the sequence just above.
1623 */
1624
Jason Tishler7961aa62005-05-20 00:56:54 +00001625/* MS_WINDOWS */
1626#if defined(MS_WINDOWS)
Guido van Rossum0980bd91998-02-13 17:18:36 +00001627 WIN32_FIND_DATA data;
1628 HANDLE h;
Tim Peters50d8d372001-02-28 05:34:27 +00001629
Neil Schemenauer7d4bb9f2001-07-23 16:30:27 +00001630 if (Py_GETENV("PYTHONCASEOK") != NULL)
Guido van Rossum0980bd91998-02-13 17:18:36 +00001631 return 1;
Tim Peters50d8d372001-02-28 05:34:27 +00001632
Guido van Rossum0980bd91998-02-13 17:18:36 +00001633 h = FindFirstFile(buf, &data);
1634 if (h == INVALID_HANDLE_VALUE) {
1635 PyErr_Format(PyExc_NameError,
1636 "Can't find file for module %.100s\n(filename %.300s)",
1637 name, buf);
1638 return 0;
1639 }
1640 FindClose(h);
Tim Peters50d8d372001-02-28 05:34:27 +00001641 return strncmp(data.cFileName, name, namelen) == 0;
1642
1643/* DJGPP */
1644#elif defined(DJGPP)
1645 struct ffblk ffblk;
1646 int done;
1647
Neil Schemenauer7d4bb9f2001-07-23 16:30:27 +00001648 if (Py_GETENV("PYTHONCASEOK") != NULL)
Guido van Rossum323bf5e1998-06-24 03:54:06 +00001649 return 1;
Tim Peters50d8d372001-02-28 05:34:27 +00001650
1651 done = findfirst(buf, &ffblk, FA_ARCH|FA_RDONLY|FA_HIDDEN|FA_DIREC);
1652 if (done) {
Guido van Rossum0980bd91998-02-13 17:18:36 +00001653 PyErr_Format(PyExc_NameError,
Tim Peters50d8d372001-02-28 05:34:27 +00001654 "Can't find file for module %.100s\n(filename %.300s)",
Guido van Rossum0980bd91998-02-13 17:18:36 +00001655 name, buf);
1656 return 0;
1657 }
Tim Peters50d8d372001-02-28 05:34:27 +00001658 return strncmp(ffblk.ff_name, name, namelen) == 0;
Guido van Rossum0980bd91998-02-13 17:18:36 +00001659
Jason Tishler7961aa62005-05-20 00:56:54 +00001660/* new-fangled macintosh (macosx) or Cygwin */
1661#elif (defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) && defined(HAVE_DIRENT_H)
Tim Peters430f5d42001-03-01 01:30:56 +00001662 DIR *dirp;
1663 struct dirent *dp;
Tim Petersd1e87a82001-03-01 18:12:00 +00001664 char dirname[MAXPATHLEN + 1];
1665 const int dirlen = len - namelen - 1; /* don't want trailing SEP */
Tim Peters430f5d42001-03-01 01:30:56 +00001666
Neil Schemenauer7d4bb9f2001-07-23 16:30:27 +00001667 if (Py_GETENV("PYTHONCASEOK") != NULL)
Tim Petersdbe6ebb2001-03-01 08:47:29 +00001668 return 1;
1669
Tim Petersd1e87a82001-03-01 18:12:00 +00001670 /* Copy the dir component into dirname; substitute "." if empty */
1671 if (dirlen <= 0) {
1672 dirname[0] = '.';
1673 dirname[1] = '\0';
Tim Peters430f5d42001-03-01 01:30:56 +00001674 }
1675 else {
Tim Petersd1e87a82001-03-01 18:12:00 +00001676 assert(dirlen <= MAXPATHLEN);
1677 memcpy(dirname, buf, dirlen);
1678 dirname[dirlen] = '\0';
Tim Peters430f5d42001-03-01 01:30:56 +00001679 }
1680 /* Open the directory and search the entries for an exact match. */
Tim Petersd1e87a82001-03-01 18:12:00 +00001681 dirp = opendir(dirname);
Tim Peters430f5d42001-03-01 01:30:56 +00001682 if (dirp) {
Tim Peters677898a2001-03-02 03:28:03 +00001683 char *nameWithExt = buf + len - namelen;
Tim Peters430f5d42001-03-01 01:30:56 +00001684 while ((dp = readdir(dirp)) != NULL) {
Tim Petersdbe6ebb2001-03-01 08:47:29 +00001685 const int thislen =
Tim Peters430f5d42001-03-01 01:30:56 +00001686#ifdef _DIRENT_HAVE_D_NAMELEN
Tim Petersdbe6ebb2001-03-01 08:47:29 +00001687 dp->d_namlen;
Tim Peters430f5d42001-03-01 01:30:56 +00001688#else
Tim Petersdbe6ebb2001-03-01 08:47:29 +00001689 strlen(dp->d_name);
Tim Peters430f5d42001-03-01 01:30:56 +00001690#endif
Tim Petersd1e87a82001-03-01 18:12:00 +00001691 if (thislen >= namelen &&
Tim Peters677898a2001-03-02 03:28:03 +00001692 strcmp(dp->d_name, nameWithExt) == 0) {
Tim Peters430f5d42001-03-01 01:30:56 +00001693 (void)closedir(dirp);
1694 return 1; /* Found */
1695 }
1696 }
Tim Petersdbe6ebb2001-03-01 08:47:29 +00001697 (void)closedir(dirp);
Tim Peters430f5d42001-03-01 01:30:56 +00001698 }
Tim Peters430f5d42001-03-01 01:30:56 +00001699 return 0 ; /* Not found */
Tim Peters430f5d42001-03-01 01:30:56 +00001700
Andrew MacIntyred9400542002-02-26 11:41:34 +00001701/* OS/2 */
1702#elif defined(PYOS_OS2)
1703 HDIR hdir = 1;
1704 ULONG srchcnt = 1;
1705 FILEFINDBUF3 ffbuf;
1706 APIRET rc;
1707
Christian Heimes790c8232008-01-07 21:14:23 +00001708 if (Py_GETENV("PYTHONCASEOK") != NULL)
Andrew MacIntyred9400542002-02-26 11:41:34 +00001709 return 1;
1710
1711 rc = DosFindFirst(buf,
1712 &hdir,
1713 FILE_READONLY | FILE_HIDDEN | FILE_SYSTEM | FILE_DIRECTORY,
1714 &ffbuf, sizeof(ffbuf),
1715 &srchcnt,
1716 FIL_STANDARD);
1717 if (rc != NO_ERROR)
1718 return 0;
1719 return strncmp(ffbuf.achName, name, namelen) == 0;
1720
Tim Peters50d8d372001-02-28 05:34:27 +00001721/* assuming it's a case-sensitive filesystem, so there's nothing to do! */
1722#else
Guido van Rossum0980bd91998-02-13 17:18:36 +00001723 return 1;
Guido van Rossum0980bd91998-02-13 17:18:36 +00001724
Guido van Rossum4d1b3b91998-02-13 23:27:59 +00001725#endif
Tim Peters50d8d372001-02-28 05:34:27 +00001726}
Guido van Rossum4d1b3b91998-02-13 23:27:59 +00001727
Guido van Rossum0980bd91998-02-13 17:18:36 +00001728
Guido van Rossum197346f1997-10-31 18:38:52 +00001729#ifdef HAVE_STAT
1730/* Helper to look for __init__.py or __init__.py[co] in potential package */
1731static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001732find_init_module(char *buf)
Guido van Rossum197346f1997-10-31 18:38:52 +00001733{
Tim Peters0f9431f2001-07-05 03:47:53 +00001734 const size_t save_len = strlen(buf);
Fred Drake4c82b232000-06-30 16:18:57 +00001735 size_t i = save_len;
Tim Peters0f9431f2001-07-05 03:47:53 +00001736 char *pname; /* pointer to start of __init__ */
Guido van Rossum197346f1997-10-31 18:38:52 +00001737 struct stat statbuf;
1738
Tim Peters0f9431f2001-07-05 03:47:53 +00001739/* For calling case_ok(buf, len, namelen, name):
1740 * /a/b/c/d/e/f/g/h/i/j/k/some_long_module_name.py\0
1741 * ^ ^ ^ ^
1742 * |--------------------- buf ---------------------|
1743 * |------------------- len ------------------|
1744 * |------ name -------|
1745 * |----- namelen -----|
1746 */
Guido van Rossum197346f1997-10-31 18:38:52 +00001747 if (save_len + 13 >= MAXPATHLEN)
1748 return 0;
1749 buf[i++] = SEP;
Tim Peters0f9431f2001-07-05 03:47:53 +00001750 pname = buf + i;
1751 strcpy(pname, "__init__.py");
Guido van Rossum197346f1997-10-31 18:38:52 +00001752 if (stat(buf, &statbuf) == 0) {
Tim Peters0f9431f2001-07-05 03:47:53 +00001753 if (case_ok(buf,
1754 save_len + 9, /* len("/__init__") */
1755 8, /* len("__init__") */
1756 pname)) {
1757 buf[save_len] = '\0';
1758 return 1;
1759 }
Guido van Rossum197346f1997-10-31 18:38:52 +00001760 }
Tim Peters0f9431f2001-07-05 03:47:53 +00001761 i += strlen(pname);
1762 strcpy(buf+i, Py_OptimizeFlag ? "o" : "c");
Guido van Rossum197346f1997-10-31 18:38:52 +00001763 if (stat(buf, &statbuf) == 0) {
Tim Peters0f9431f2001-07-05 03:47:53 +00001764 if (case_ok(buf,
1765 save_len + 9, /* len("/__init__") */
1766 8, /* len("__init__") */
1767 pname)) {
1768 buf[save_len] = '\0';
1769 return 1;
1770 }
Guido van Rossum197346f1997-10-31 18:38:52 +00001771 }
1772 buf[save_len] = '\0';
1773 return 0;
1774}
Guido van Rossum48a680c2001-03-02 06:34:14 +00001775
Guido van Rossum197346f1997-10-31 18:38:52 +00001776#endif /* HAVE_STAT */
1777
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001778
Tim Petersdbd9ba62000-07-09 03:09:57 +00001779static int init_builtin(char *); /* Forward */
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001780
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001781/* Load an external module using the default search path and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001782 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001783
Guido van Rossum79f25d91997-04-29 20:08:16 +00001784static PyObject *
Just van Rossum52e14d62002-12-30 22:08:05 +00001785load_module(char *name, FILE *fp, char *buf, int type, PyObject *loader)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001786{
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001787 PyObject *modules;
Guido van Rossum79f25d91997-04-29 20:08:16 +00001788 PyObject *m;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001789 int err;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001790
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001791 /* First check that there's an open file (if we need one) */
1792 switch (type) {
1793 case PY_SOURCE:
1794 case PY_COMPILED:
1795 if (fp == NULL) {
1796 PyErr_Format(PyExc_ValueError,
1797 "file object required for import (type code %d)",
1798 type);
1799 return NULL;
1800 }
1801 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001802
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001803 switch (type) {
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001804
1805 case PY_SOURCE:
1806 m = load_source_module(name, buf, fp);
1807 break;
1808
1809 case PY_COMPILED:
1810 m = load_compiled_module(name, buf, fp);
1811 break;
1812
Guido van Rossum96a8fb71999-12-22 14:09:35 +00001813#ifdef HAVE_DYNAMIC_LOADING
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001814 case C_EXTENSION:
Guido van Rossum79f25d91997-04-29 20:08:16 +00001815 m = _PyImport_LoadDynamicModule(name, buf, fp);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001816 break;
Guido van Rossum96a8fb71999-12-22 14:09:35 +00001817#endif
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001818
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001819 case PKG_DIRECTORY:
1820 m = load_package(name, buf);
1821 break;
1822
1823 case C_BUILTIN:
1824 case PY_FROZEN:
Guido van Rossuma5568d31998-03-05 03:45:08 +00001825 if (buf != NULL && buf[0] != '\0')
1826 name = buf;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001827 if (type == C_BUILTIN)
1828 err = init_builtin(name);
1829 else
1830 err = PyImport_ImportFrozenModule(name);
1831 if (err < 0)
Guido van Rossuma86f77d1997-09-09 18:53:47 +00001832 return NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001833 if (err == 0) {
1834 PyErr_Format(PyExc_ImportError,
1835 "Purported %s module %.200s not found",
1836 type == C_BUILTIN ?
1837 "builtin" : "frozen",
1838 name);
Guido van Rossuma86f77d1997-09-09 18:53:47 +00001839 return NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001840 }
1841 modules = PyImport_GetModuleDict();
1842 m = PyDict_GetItemString(modules, name);
1843 if (m == NULL) {
1844 PyErr_Format(
1845 PyExc_ImportError,
1846 "%s module %.200s not properly initialized",
1847 type == C_BUILTIN ?
1848 "builtin" : "frozen",
1849 name);
Guido van Rossuma86f77d1997-09-09 18:53:47 +00001850 return NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001851 }
1852 Py_INCREF(m);
1853 break;
1854
Just van Rossum52e14d62002-12-30 22:08:05 +00001855 case IMP_HOOK: {
1856 if (loader == NULL) {
1857 PyErr_SetString(PyExc_ImportError,
1858 "import hook without loader");
1859 return NULL;
1860 }
1861 m = PyObject_CallMethod(loader, "load_module", "s", name);
1862 break;
1863 }
1864
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001865 default:
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001866 PyErr_Format(PyExc_ImportError,
1867 "Don't know how to import %.200s (type code %d)",
1868 name, type);
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001869 m = NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001870
1871 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001872
1873 return m;
1874}
1875
1876
1877/* Initialize a built-in module.
Thomas Wouters89f507f2006-12-13 04:49:30 +00001878 Return 1 for success, 0 if the module is not found, and -1 with
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001879 an exception set if the initialization failed. */
Guido van Rossum7f133ed1991-02-19 12:23:57 +00001880
Guido van Rossum7f133ed1991-02-19 12:23:57 +00001881static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001882init_builtin(char *name)
Guido van Rossum7f133ed1991-02-19 12:23:57 +00001883{
Guido van Rossum25ce5661997-08-02 03:10:38 +00001884 struct _inittab *p;
Guido van Rossum25ce5661997-08-02 03:10:38 +00001885
Greg Ward201baee2001-10-04 14:52:06 +00001886 if (_PyImport_FindExtension(name, name) != NULL)
Guido van Rossum25ce5661997-08-02 03:10:38 +00001887 return 1;
1888
Guido van Rossum771c6c81997-10-31 18:37:24 +00001889 for (p = PyImport_Inittab; p->name != NULL; p++) {
Martin v. Löwis1a214512008-06-11 05:26:20 +00001890 PyObject *mod;
Guido van Rossum25ce5661997-08-02 03:10:38 +00001891 if (strcmp(name, p->name) == 0) {
1892 if (p->initfunc == NULL) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001893 PyErr_Format(PyExc_ImportError,
1894 "Cannot re-init internal module %.200s",
1895 name);
Guido van Rossum74e6a111994-08-29 12:54:38 +00001896 return -1;
1897 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00001898 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +00001899 PySys_WriteStderr("import %s # builtin\n", name);
Martin v. Löwis1a214512008-06-11 05:26:20 +00001900 mod = (*p->initfunc)();
1901 if (mod == 0)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001902 return -1;
Martin v. Löwis1a214512008-06-11 05:26:20 +00001903 if (_PyImport_FixupExtension(mod, name, name) < 0)
Guido van Rossum25ce5661997-08-02 03:10:38 +00001904 return -1;
Martin v. Löwis1a214512008-06-11 05:26:20 +00001905 /* FixupExtension has put the module into sys.modules,
1906 so we can release our own reference. */
1907 Py_DECREF(mod);
Guido van Rossum7f133ed1991-02-19 12:23:57 +00001908 return 1;
1909 }
1910 }
1911 return 0;
1912}
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001913
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001914
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001915/* Frozen modules */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001916
Guido van Rossumcfd0a221996-06-17 17:06:34 +00001917static struct _frozen *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001918find_frozen(char *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001919{
Guido van Rossumcfd0a221996-06-17 17:06:34 +00001920 struct _frozen *p;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001921
Benjamin Petersond968e272008-11-05 22:48:33 +00001922 if (!name)
1923 return NULL;
1924
Guido van Rossum79f25d91997-04-29 20:08:16 +00001925 for (p = PyImport_FrozenModules; ; p++) {
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001926 if (p->name == NULL)
1927 return NULL;
1928 if (strcmp(p->name, name) == 0)
1929 break;
1930 }
1931 return p;
1932}
1933
Guido van Rossum79f25d91997-04-29 20:08:16 +00001934static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001935get_frozen_object(char *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001936{
Guido van Rossumcfd0a221996-06-17 17:06:34 +00001937 struct _frozen *p = find_frozen(name);
Guido van Rossuma5568d31998-03-05 03:45:08 +00001938 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001939
1940 if (p == NULL) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001941 PyErr_Format(PyExc_ImportError,
1942 "No such frozen object named %.200s",
1943 name);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001944 return NULL;
1945 }
Guido van Rossum8f4d3312001-10-18 18:54:11 +00001946 if (p->code == NULL) {
1947 PyErr_Format(PyExc_ImportError,
1948 "Excluded frozen object named %.200s",
1949 name);
1950 return NULL;
1951 }
Guido van Rossuma5568d31998-03-05 03:45:08 +00001952 size = p->size;
1953 if (size < 0)
1954 size = -size;
1955 return PyMarshal_ReadObjectFromString((char *)p->code, size);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001956}
1957
Brett Cannon8d110132009-03-15 02:20:16 +00001958static PyObject *
1959is_frozen_package(char *name)
1960{
1961 struct _frozen *p = find_frozen(name);
1962 int size;
1963
1964 if (p == NULL) {
1965 PyErr_Format(PyExc_ImportError,
1966 "No such frozen object named %.200s",
1967 name);
1968 return NULL;
1969 }
1970
1971 size = p->size;
1972
1973 if (size < 0)
1974 Py_RETURN_TRUE;
1975 else
1976 Py_RETURN_FALSE;
1977}
1978
1979
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001980/* Initialize a frozen module.
Brett Cannon3c2ac442009-03-08 20:49:47 +00001981 Return 1 for success, 0 if the module is not found, and -1 with
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001982 an exception set if the initialization failed.
1983 This function is also used from frozenmain.c */
Guido van Rossum0b344901995-02-07 15:35:27 +00001984
1985int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001986PyImport_ImportFrozenModule(char *name)
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001987{
Guido van Rossumcfd0a221996-06-17 17:06:34 +00001988 struct _frozen *p = find_frozen(name);
Guido van Rossum79f25d91997-04-29 20:08:16 +00001989 PyObject *co;
1990 PyObject *m;
Guido van Rossuma5568d31998-03-05 03:45:08 +00001991 int ispackage;
1992 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001993
1994 if (p == NULL)
1995 return 0;
Guido van Rossum8f4d3312001-10-18 18:54:11 +00001996 if (p->code == NULL) {
1997 PyErr_Format(PyExc_ImportError,
1998 "Excluded frozen object named %.200s",
1999 name);
2000 return -1;
2001 }
Guido van Rossuma5568d31998-03-05 03:45:08 +00002002 size = p->size;
2003 ispackage = (size < 0);
2004 if (ispackage)
2005 size = -size;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002006 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +00002007 PySys_WriteStderr("import %s # frozen%s\n",
Guido van Rossuma5568d31998-03-05 03:45:08 +00002008 name, ispackage ? " package" : "");
2009 co = PyMarshal_ReadObjectFromString((char *)p->code, size);
Guido van Rossumf56e3db1993-04-01 20:59:32 +00002010 if (co == NULL)
2011 return -1;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002012 if (!PyCode_Check(co)) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002013 PyErr_Format(PyExc_TypeError,
2014 "frozen object %.200s is not a code object",
2015 name);
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002016 goto err_return;
Guido van Rossumf56e3db1993-04-01 20:59:32 +00002017 }
Guido van Rossuma5568d31998-03-05 03:45:08 +00002018 if (ispackage) {
2019 /* Set __path__ to the package name */
Benjamin Petersond968e272008-11-05 22:48:33 +00002020 PyObject *d, *s, *l;
Guido van Rossuma5568d31998-03-05 03:45:08 +00002021 int err;
2022 m = PyImport_AddModule(name);
2023 if (m == NULL)
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002024 goto err_return;
Guido van Rossuma5568d31998-03-05 03:45:08 +00002025 d = PyModule_GetDict(m);
Martin v. Löwis5b222132007-06-10 09:51:05 +00002026 s = PyUnicode_InternFromString(name);
Guido van Rossuma5568d31998-03-05 03:45:08 +00002027 if (s == NULL)
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002028 goto err_return;
Benjamin Petersond968e272008-11-05 22:48:33 +00002029 l = PyList_New(1);
2030 if (l == NULL) {
2031 Py_DECREF(s);
2032 goto err_return;
2033 }
2034 PyList_SET_ITEM(l, 0, s);
2035 err = PyDict_SetItemString(d, "__path__", l);
2036 Py_DECREF(l);
Guido van Rossuma5568d31998-03-05 03:45:08 +00002037 if (err != 0)
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002038 goto err_return;
Guido van Rossuma5568d31998-03-05 03:45:08 +00002039 }
Guido van Rossume32bf6e1998-02-11 05:53:02 +00002040 m = PyImport_ExecCodeModuleEx(name, co, "<frozen>");
Guido van Rossum7f9fa971995-01-20 16:53:12 +00002041 if (m == NULL)
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002042 goto err_return;
2043 Py_DECREF(co);
Guido van Rossum79f25d91997-04-29 20:08:16 +00002044 Py_DECREF(m);
Guido van Rossum7f9fa971995-01-20 16:53:12 +00002045 return 1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002046err_return:
2047 Py_DECREF(co);
2048 return -1;
Guido van Rossumf56e3db1993-04-01 20:59:32 +00002049}
Guido van Rossum74e6a111994-08-29 12:54:38 +00002050
2051
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002052/* Import a module, either built-in, frozen, or external, and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00002053 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum74e6a111994-08-29 12:54:38 +00002054
Guido van Rossum79f25d91997-04-29 20:08:16 +00002055PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00002056PyImport_ImportModule(const char *name)
Guido van Rossum74e6a111994-08-29 12:54:38 +00002057{
Marc-André Lemburg3c61c352001-02-09 19:40:15 +00002058 PyObject *pname;
2059 PyObject *result;
2060
Martin v. Löwis5b222132007-06-10 09:51:05 +00002061 pname = PyUnicode_FromString(name);
Neal Norwitza11e4c12003-03-23 14:31:01 +00002062 if (pname == NULL)
2063 return NULL;
Marc-André Lemburg3c61c352001-02-09 19:40:15 +00002064 result = PyImport_Import(pname);
2065 Py_DECREF(pname);
2066 return result;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002067}
2068
Christian Heimes072c0f12008-01-03 23:01:04 +00002069/* Import a module without blocking
2070 *
2071 * At first it tries to fetch the module from sys.modules. If the module was
2072 * never loaded before it loads it with PyImport_ImportModule() unless another
2073 * thread holds the import lock. In the latter case the function raises an
2074 * ImportError instead of blocking.
2075 *
2076 * Returns the module object with incremented ref count.
2077 */
2078PyObject *
2079PyImport_ImportModuleNoBlock(const char *name)
2080{
2081 PyObject *result;
2082 PyObject *modules;
2083 long me;
2084
2085 /* Try to get the module from sys.modules[name] */
2086 modules = PyImport_GetModuleDict();
2087 if (modules == NULL)
2088 return NULL;
2089
2090 result = PyDict_GetItemString(modules, name);
2091 if (result != NULL) {
2092 Py_INCREF(result);
2093 return result;
2094 }
2095 else {
2096 PyErr_Clear();
2097 }
Benjamin Peterson3e4f0552008-09-02 00:31:15 +00002098#ifdef WITH_THREAD
Christian Heimes072c0f12008-01-03 23:01:04 +00002099 /* check the import lock
2100 * me might be -1 but I ignore the error here, the lock function
2101 * takes care of the problem */
2102 me = PyThread_get_thread_ident();
2103 if (import_lock_thread == -1 || import_lock_thread == me) {
2104 /* no thread or me is holding the lock */
2105 return PyImport_ImportModule(name);
2106 }
2107 else {
2108 PyErr_Format(PyExc_ImportError,
2109 "Failed to import %.200s because the import lock"
2110 "is held by another thread.",
2111 name);
2112 return NULL;
2113 }
Benjamin Peterson3e4f0552008-09-02 00:31:15 +00002114#else
2115 return PyImport_ImportModule(name);
2116#endif
Christian Heimes072c0f12008-01-03 23:01:04 +00002117}
2118
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002119/* Forward declarations for helper routines */
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002120static PyObject *get_parent(PyObject *globals, char *buf,
2121 Py_ssize_t *p_buflen, int level);
Tim Petersdbd9ba62000-07-09 03:09:57 +00002122static PyObject *load_next(PyObject *mod, PyObject *altmod,
Martin v. Löwis18e16552006-02-15 17:27:45 +00002123 char **p_name, char *buf, Py_ssize_t *p_buflen);
Tim Petersdbd9ba62000-07-09 03:09:57 +00002124static int mark_miss(char *name);
2125static int ensure_fromlist(PyObject *mod, PyObject *fromlist,
Martin v. Löwis18e16552006-02-15 17:27:45 +00002126 char *buf, Py_ssize_t buflen, int recursive);
Tim Petersdbd9ba62000-07-09 03:09:57 +00002127static PyObject * import_submodule(PyObject *mod, char *name, char *fullname);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002128
2129/* The Magnum Opus of dotted-name import :-) */
2130
Guido van Rossum75acc9c1998-03-03 22:26:50 +00002131static PyObject *
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002132import_module_level(char *name, PyObject *globals, PyObject *locals,
2133 PyObject *fromlist, int level)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002134{
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002135 char buf[MAXPATHLEN+1];
Martin v. Löwis18e16552006-02-15 17:27:45 +00002136 Py_ssize_t buflen = 0;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002137 PyObject *parent, *head, *next, *tail;
2138
Christian Heimes454f37b2008-01-10 00:10:02 +00002139 if (strchr(name, '/') != NULL
2140#ifdef MS_WINDOWS
2141 || strchr(name, '\\') != NULL
2142#endif
2143 ) {
2144 PyErr_SetString(PyExc_ImportError,
2145 "Import by filename is not supported.");
2146 return NULL;
2147 }
2148
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002149 parent = get_parent(globals, buf, &buflen, level);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002150 if (parent == NULL)
2151 return NULL;
2152
2153 head = load_next(parent, Py_None, &name, buf, &buflen);
2154 if (head == NULL)
2155 return NULL;
2156
2157 tail = head;
2158 Py_INCREF(tail);
2159 while (name) {
2160 next = load_next(tail, tail, &name, buf, &buflen);
2161 Py_DECREF(tail);
2162 if (next == NULL) {
2163 Py_DECREF(head);
2164 return NULL;
2165 }
2166 tail = next;
2167 }
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002168 if (tail == Py_None) {
2169 /* If tail is Py_None, both get_parent and load_next found
2170 an empty module name: someone called __import__("") or
2171 doctored faulty bytecode */
2172 Py_DECREF(tail);
2173 Py_DECREF(head);
2174 PyErr_SetString(PyExc_ValueError,
2175 "Empty module name");
2176 return NULL;
2177 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002178
2179 if (fromlist != NULL) {
2180 if (fromlist == Py_None || !PyObject_IsTrue(fromlist))
2181 fromlist = NULL;
2182 }
2183
2184 if (fromlist == NULL) {
2185 Py_DECREF(tail);
2186 return head;
2187 }
2188
2189 Py_DECREF(head);
Guido van Rossum9905ef91997-09-08 16:07:11 +00002190 if (!ensure_fromlist(tail, fromlist, buf, buflen, 0)) {
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002191 Py_DECREF(tail);
2192 return NULL;
2193 }
2194
2195 return tail;
2196}
2197
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002198PyObject *
2199PyImport_ImportModuleLevel(char *name, PyObject *globals, PyObject *locals,
2200 PyObject *fromlist, int level)
2201{
2202 PyObject *result;
2203 lock_import();
2204 result = import_module_level(name, globals, locals, fromlist, level);
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00002205 if (unlock_import() < 0) {
2206 Py_XDECREF(result);
2207 PyErr_SetString(PyExc_RuntimeError,
2208 "not holding the import lock");
2209 return NULL;
2210 }
Guido van Rossum75acc9c1998-03-03 22:26:50 +00002211 return result;
2212}
2213
Fred Drake87590902004-05-28 20:21:36 +00002214/* Return the package that an import is being performed in. If globals comes
2215 from the module foo.bar.bat (not itself a package), this returns the
2216 sys.modules entry for foo.bar. If globals is from a package's __init__.py,
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00002217 the package's entry in sys.modules is returned, as a borrowed reference.
Fred Drake87590902004-05-28 20:21:36 +00002218
2219 The *name* of the returned package is returned in buf, with the length of
2220 the name in *p_buflen.
2221
2222 If globals doesn't come from a package or a module in a package, or a
2223 corresponding entry is not found in sys.modules, Py_None is returned.
2224*/
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002225static PyObject *
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002226get_parent(PyObject *globals, char *buf, Py_ssize_t *p_buflen, int level)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002227{
2228 static PyObject *namestr = NULL;
2229 static PyObject *pathstr = NULL;
Nick Coghlande10c852007-12-04 12:22:52 +00002230 static PyObject *pkgstr = NULL;
2231 PyObject *pkgname, *modname, *modpath, *modules, *parent;
Georg Brandl2ee470f2008-07-16 12:55:28 +00002232 int orig_level = level;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002233
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002234 if (globals == NULL || !PyDict_Check(globals) || !level)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002235 return Py_None;
2236
2237 if (namestr == NULL) {
Martin v. Löwis5b222132007-06-10 09:51:05 +00002238 namestr = PyUnicode_InternFromString("__name__");
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002239 if (namestr == NULL)
2240 return NULL;
2241 }
2242 if (pathstr == NULL) {
Martin v. Löwis5b222132007-06-10 09:51:05 +00002243 pathstr = PyUnicode_InternFromString("__path__");
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002244 if (pathstr == NULL)
2245 return NULL;
2246 }
Nick Coghlande10c852007-12-04 12:22:52 +00002247 if (pkgstr == NULL) {
2248 pkgstr = PyUnicode_InternFromString("__package__");
2249 if (pkgstr == NULL)
2250 return NULL;
2251 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002252
2253 *buf = '\0';
2254 *p_buflen = 0;
Nick Coghlande10c852007-12-04 12:22:52 +00002255 pkgname = PyDict_GetItem(globals, pkgstr);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002256
Nick Coghlande10c852007-12-04 12:22:52 +00002257 if ((pkgname != NULL) && (pkgname != Py_None)) {
2258 /* __package__ is set, so use it */
Alexandre Vassalottia85998a2008-05-03 18:24:43 +00002259 char *pkgname_str;
Nick Coghlande10c852007-12-04 12:22:52 +00002260 Py_ssize_t len;
Alexandre Vassalottia85998a2008-05-03 18:24:43 +00002261
Nick Coghlande10c852007-12-04 12:22:52 +00002262 if (!PyUnicode_Check(pkgname)) {
2263 PyErr_SetString(PyExc_ValueError,
2264 "__package__ set to non-string");
2265 return NULL;
2266 }
Marc-André Lemburg4cc0f242008-08-07 18:54:33 +00002267 pkgname_str = _PyUnicode_AsStringAndSize(pkgname, &len);
Nick Coghlande10c852007-12-04 12:22:52 +00002268 if (len == 0) {
2269 if (level > 0) {
2270 PyErr_SetString(PyExc_ValueError,
2271 "Attempted relative import in non-package");
2272 return NULL;
2273 }
2274 return Py_None;
2275 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002276 if (len > MAXPATHLEN) {
2277 PyErr_SetString(PyExc_ValueError,
Nick Coghlande10c852007-12-04 12:22:52 +00002278 "Package name too long");
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002279 return NULL;
2280 }
Alexandre Vassalottia85998a2008-05-03 18:24:43 +00002281 strcpy(buf, pkgname_str);
Nick Coghlande10c852007-12-04 12:22:52 +00002282 } else {
2283 /* __package__ not set, so figure it out and set it */
2284 modname = PyDict_GetItem(globals, namestr);
2285 if (modname == NULL || !PyUnicode_Check(modname))
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002286 return Py_None;
Nick Coghlande10c852007-12-04 12:22:52 +00002287
2288 modpath = PyDict_GetItem(globals, pathstr);
2289 if (modpath != NULL) {
2290 /* __path__ is set, so modname is already the package name */
Alexandre Vassalottia85998a2008-05-03 18:24:43 +00002291 char *modname_str;
2292 Py_ssize_t len;
Nick Coghlande10c852007-12-04 12:22:52 +00002293 int error;
Alexandre Vassalottia85998a2008-05-03 18:24:43 +00002294
Marc-André Lemburg4cc0f242008-08-07 18:54:33 +00002295 modname_str = _PyUnicode_AsStringAndSize(modname, &len);
Nick Coghlande10c852007-12-04 12:22:52 +00002296 if (len > MAXPATHLEN) {
2297 PyErr_SetString(PyExc_ValueError,
2298 "Module name too long");
2299 return NULL;
2300 }
Alexandre Vassalottia85998a2008-05-03 18:24:43 +00002301 strcpy(buf, modname_str);
Nick Coghlande10c852007-12-04 12:22:52 +00002302 error = PyDict_SetItem(globals, pkgstr, modname);
2303 if (error) {
2304 PyErr_SetString(PyExc_ValueError,
2305 "Could not set __package__");
2306 return NULL;
2307 }
2308 } else {
2309 /* Normal module, so work out the package name if any */
Marc-André Lemburg4cc0f242008-08-07 18:54:33 +00002310 char *start = _PyUnicode_AsString(modname);
Nick Coghlande10c852007-12-04 12:22:52 +00002311 char *lastdot = strrchr(start, '.');
2312 size_t len;
2313 int error;
2314 if (lastdot == NULL && level > 0) {
2315 PyErr_SetString(PyExc_ValueError,
2316 "Attempted relative import in non-package");
2317 return NULL;
2318 }
2319 if (lastdot == NULL) {
2320 error = PyDict_SetItem(globals, pkgstr, Py_None);
2321 if (error) {
2322 PyErr_SetString(PyExc_ValueError,
2323 "Could not set __package__");
2324 return NULL;
2325 }
2326 return Py_None;
2327 }
2328 len = lastdot - start;
2329 if (len >= MAXPATHLEN) {
2330 PyErr_SetString(PyExc_ValueError,
2331 "Module name too long");
2332 return NULL;
2333 }
2334 strncpy(buf, start, len);
2335 buf[len] = '\0';
2336 pkgname = PyUnicode_FromString(buf);
2337 if (pkgname == NULL) {
2338 return NULL;
2339 }
2340 error = PyDict_SetItem(globals, pkgstr, pkgname);
2341 Py_DECREF(pkgname);
2342 if (error) {
2343 PyErr_SetString(PyExc_ValueError,
2344 "Could not set __package__");
2345 return NULL;
2346 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002347 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002348 }
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002349 while (--level > 0) {
2350 char *dot = strrchr(buf, '.');
2351 if (dot == NULL) {
2352 PyErr_SetString(PyExc_ValueError,
Thomas Wouters89f507f2006-12-13 04:49:30 +00002353 "Attempted relative import beyond "
2354 "toplevel package");
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002355 return NULL;
2356 }
2357 *dot = '\0';
2358 }
2359 *p_buflen = strlen(buf);
2360
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002361 modules = PyImport_GetModuleDict();
2362 parent = PyDict_GetItemString(modules, buf);
Georg Brandl2ee470f2008-07-16 12:55:28 +00002363 if (parent == NULL) {
2364 if (orig_level < 1) {
2365 PyObject *err_msg = PyBytes_FromFormat(
2366 "Parent module '%.200s' not found "
2367 "while handling absolute import", buf);
2368 if (err_msg == NULL) {
2369 return NULL;
2370 }
2371 if (!PyErr_WarnEx(PyExc_RuntimeWarning,
2372 PyBytes_AsString(err_msg), 1)) {
2373 *buf = '\0';
2374 *p_buflen = 0;
2375 parent = Py_None;
2376 }
2377 Py_DECREF(err_msg);
2378 } else {
2379 PyErr_Format(PyExc_SystemError,
2380 "Parent module '%.200s' not loaded, "
2381 "cannot perform relative import", buf);
2382 }
2383 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002384 return parent;
2385 /* We expect, but can't guarantee, if parent != None, that:
2386 - parent.__name__ == buf
2387 - parent.__dict__ is globals
2388 If this is violated... Who cares? */
2389}
2390
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002391/* altmod is either None or same as mod */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002392static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002393load_next(PyObject *mod, PyObject *altmod, char **p_name, char *buf,
Martin v. Löwis18e16552006-02-15 17:27:45 +00002394 Py_ssize_t *p_buflen)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002395{
2396 char *name = *p_name;
2397 char *dot = strchr(name, '.');
Fred Drake4c82b232000-06-30 16:18:57 +00002398 size_t len;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002399 char *p;
2400 PyObject *result;
2401
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002402 if (strlen(name) == 0) {
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002403 /* completely empty module name should only happen in
2404 'from . import' (or '__import__("")')*/
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002405 Py_INCREF(mod);
2406 *p_name = NULL;
2407 return mod;
2408 }
2409
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002410 if (dot == NULL) {
2411 *p_name = NULL;
2412 len = strlen(name);
2413 }
2414 else {
2415 *p_name = dot+1;
2416 len = dot-name;
2417 }
Guido van Rossum111c20b1998-04-11 17:38:22 +00002418 if (len == 0) {
2419 PyErr_SetString(PyExc_ValueError,
2420 "Empty module name");
2421 return NULL;
2422 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002423
2424 p = buf + *p_buflen;
2425 if (p != buf)
2426 *p++ = '.';
2427 if (p+len-buf >= MAXPATHLEN) {
2428 PyErr_SetString(PyExc_ValueError,
2429 "Module name too long");
2430 return NULL;
2431 }
2432 strncpy(p, name, len);
2433 p[len] = '\0';
2434 *p_buflen = p+len-buf;
2435
2436 result = import_submodule(mod, p, buf);
2437 if (result == Py_None && altmod != mod) {
2438 Py_DECREF(result);
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00002439 /* Here, altmod must be None and mod must not be None */
Guido van Rossum0c819451997-09-07 06:16:57 +00002440 result = import_submodule(altmod, p, p);
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00002441 if (result != NULL && result != Py_None) {
2442 if (mark_miss(buf) != 0) {
2443 Py_DECREF(result);
2444 return NULL;
2445 }
2446 strncpy(buf, name, len);
2447 buf[len] = '\0';
2448 *p_buflen = len;
2449 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002450 }
2451 if (result == NULL)
2452 return NULL;
2453
2454 if (result == Py_None) {
2455 Py_DECREF(result);
2456 PyErr_Format(PyExc_ImportError,
2457 "No module named %.200s", name);
2458 return NULL;
2459 }
2460
2461 return result;
2462}
2463
2464static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002465mark_miss(char *name)
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00002466{
2467 PyObject *modules = PyImport_GetModuleDict();
2468 return PyDict_SetItemString(modules, name, Py_None);
2469}
2470
2471static int
Martin v. Löwis18e16552006-02-15 17:27:45 +00002472ensure_fromlist(PyObject *mod, PyObject *fromlist, char *buf, Py_ssize_t buflen,
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002473 int recursive)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002474{
2475 int i;
2476
2477 if (!PyObject_HasAttrString(mod, "__path__"))
2478 return 1;
2479
2480 for (i = 0; ; i++) {
2481 PyObject *item = PySequence_GetItem(fromlist, i);
2482 int hasit;
2483 if (item == NULL) {
2484 if (PyErr_ExceptionMatches(PyExc_IndexError)) {
2485 PyErr_Clear();
2486 return 1;
2487 }
2488 return 0;
2489 }
Martin v. Löwis5b222132007-06-10 09:51:05 +00002490 if (!PyUnicode_Check(item)) {
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002491 PyErr_SetString(PyExc_TypeError,
Neal Norwitz80e7f272007-08-26 06:45:23 +00002492 "Item in ``from list'' not a string");
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002493 Py_DECREF(item);
2494 return 0;
2495 }
Martin v. Löwis5b222132007-06-10 09:51:05 +00002496 if (PyUnicode_AS_UNICODE(item)[0] == '*') {
Guido van Rossum9905ef91997-09-08 16:07:11 +00002497 PyObject *all;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002498 Py_DECREF(item);
Guido van Rossum9905ef91997-09-08 16:07:11 +00002499 /* See if the package defines __all__ */
2500 if (recursive)
2501 continue; /* Avoid endless recursion */
2502 all = PyObject_GetAttrString(mod, "__all__");
2503 if (all == NULL)
2504 PyErr_Clear();
2505 else {
Martin v. Löwis83969ee2004-03-23 16:28:13 +00002506 int ret = ensure_fromlist(mod, all, buf, buflen, 1);
Guido van Rossum9905ef91997-09-08 16:07:11 +00002507 Py_DECREF(all);
Martin v. Löwis83969ee2004-03-23 16:28:13 +00002508 if (!ret)
2509 return 0;
Guido van Rossum9905ef91997-09-08 16:07:11 +00002510 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002511 continue;
2512 }
2513 hasit = PyObject_HasAttr(mod, item);
2514 if (!hasit) {
Martin v. Löwis5b222132007-06-10 09:51:05 +00002515 PyObject *item8;
2516 char *subname;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002517 PyObject *submod;
2518 char *p;
Martin v. Löwis5b222132007-06-10 09:51:05 +00002519 if (!Py_FileSystemDefaultEncoding) {
2520 item8 = PyUnicode_EncodeASCII(PyUnicode_AsUnicode(item),
2521 PyUnicode_GetSize(item),
Martin v. Löwis427dbff2007-06-12 05:53:00 +00002522 NULL);
Martin v. Löwis5b222132007-06-10 09:51:05 +00002523 } else {
Guido van Rossum98297ee2007-11-06 21:34:58 +00002524 item8 = PyUnicode_AsEncodedString(item,
2525 Py_FileSystemDefaultEncoding, NULL);
Martin v. Löwis5b222132007-06-10 09:51:05 +00002526 }
2527 if (!item8) {
2528 PyErr_SetString(PyExc_ValueError, "Cannot encode path item");
2529 return 0;
2530 }
Christian Heimes72b710a2008-05-26 13:28:38 +00002531 subname = PyBytes_AS_STRING(item8);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002532 if (buflen + strlen(subname) >= MAXPATHLEN) {
2533 PyErr_SetString(PyExc_ValueError,
2534 "Module name too long");
2535 Py_DECREF(item);
2536 return 0;
2537 }
2538 p = buf + buflen;
2539 *p++ = '.';
2540 strcpy(p, subname);
2541 submod = import_submodule(mod, subname, buf);
Martin v. Löwis5b222132007-06-10 09:51:05 +00002542 Py_DECREF(item8);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002543 Py_XDECREF(submod);
2544 if (submod == NULL) {
2545 Py_DECREF(item);
2546 return 0;
2547 }
2548 }
2549 Py_DECREF(item);
2550 }
2551
Guido van Rossuma7f2e811997-10-03 15:33:32 +00002552 /* NOTREACHED */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002553}
2554
Neil Schemenauer00b09662003-06-16 21:03:07 +00002555static int
2556add_submodule(PyObject *mod, PyObject *submod, char *fullname, char *subname,
2557 PyObject *modules)
2558{
2559 if (mod == Py_None)
2560 return 1;
2561 /* Irrespective of the success of this load, make a
2562 reference to it in the parent package module. A copy gets
2563 saved in the modules dictionary under the full name, so get a
2564 reference from there, if need be. (The exception is when the
2565 load failed with a SyntaxError -- then there's no trace in
2566 sys.modules. In that case, of course, do nothing extra.) */
2567 if (submod == NULL) {
2568 submod = PyDict_GetItemString(modules, fullname);
2569 if (submod == NULL)
2570 return 1;
2571 }
2572 if (PyModule_Check(mod)) {
2573 /* We can't use setattr here since it can give a
2574 * spurious warning if the submodule name shadows a
2575 * builtin name */
2576 PyObject *dict = PyModule_GetDict(mod);
2577 if (!dict)
2578 return 0;
2579 if (PyDict_SetItemString(dict, subname, submod) < 0)
2580 return 0;
2581 }
2582 else {
2583 if (PyObject_SetAttrString(mod, subname, submod) < 0)
2584 return 0;
2585 }
2586 return 1;
2587}
2588
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002589static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002590import_submodule(PyObject *mod, char *subname, char *fullname)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002591{
Guido van Rossum25ce5661997-08-02 03:10:38 +00002592 PyObject *modules = PyImport_GetModuleDict();
Neil Schemenauer00b09662003-06-16 21:03:07 +00002593 PyObject *m = NULL;
Guido van Rossum74e6a111994-08-29 12:54:38 +00002594
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002595 /* Require:
2596 if mod == None: subname == fullname
2597 else: mod.__name__ + "." + subname == fullname
2598 */
2599
Tim Peters50d8d372001-02-28 05:34:27 +00002600 if ((m = PyDict_GetItemString(modules, fullname)) != NULL) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00002601 Py_INCREF(m);
Guido van Rossum7f9fa971995-01-20 16:53:12 +00002602 }
2603 else {
Just van Rossum52e14d62002-12-30 22:08:05 +00002604 PyObject *path, *loader = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002605 char buf[MAXPATHLEN+1];
2606 struct filedescr *fdp;
2607 FILE *fp = NULL;
2608
Guido van Rossum9c0afe51998-05-19 15:09:05 +00002609 if (mod == Py_None)
2610 path = NULL;
2611 else {
2612 path = PyObject_GetAttrString(mod, "__path__");
2613 if (path == NULL) {
2614 PyErr_Clear();
2615 Py_INCREF(Py_None);
2616 return Py_None;
2617 }
2618 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002619
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002620 buf[0] = '\0';
Just van Rossum52e14d62002-12-30 22:08:05 +00002621 fdp = find_module(fullname, subname, path, buf, MAXPATHLEN+1,
2622 &fp, &loader);
Guido van Rossumb68cd421998-07-01 17:36:26 +00002623 Py_XDECREF(path);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002624 if (fdp == NULL) {
2625 if (!PyErr_ExceptionMatches(PyExc_ImportError))
2626 return NULL;
2627 PyErr_Clear();
2628 Py_INCREF(Py_None);
2629 return Py_None;
2630 }
Just van Rossum52e14d62002-12-30 22:08:05 +00002631 m = load_module(fullname, fp, buf, fdp->type, loader);
2632 Py_XDECREF(loader);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002633 if (fp)
2634 fclose(fp);
Neil Schemenauer00b09662003-06-16 21:03:07 +00002635 if (!add_submodule(mod, m, fullname, subname, modules)) {
2636 Py_XDECREF(m);
2637 m = NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002638 }
Guido van Rossum74e6a111994-08-29 12:54:38 +00002639 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002640
2641 return m;
Guido van Rossum74e6a111994-08-29 12:54:38 +00002642}
2643
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002644
2645/* Re-import a module of any kind and return its module object, WITH
2646 INCREMENTED REFERENCE COUNT */
2647
Guido van Rossum79f25d91997-04-29 20:08:16 +00002648PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002649PyImport_ReloadModule(PyObject *m)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002650{
Guido van Rossumd8faa362007-04-27 19:54:29 +00002651 PyInterpreterState *interp = PyThreadState_Get()->interp;
2652 PyObject *modules_reloading = interp->modules_reloading;
Guido van Rossum25ce5661997-08-02 03:10:38 +00002653 PyObject *modules = PyImport_GetModuleDict();
Guido van Rossumd8faa362007-04-27 19:54:29 +00002654 PyObject *path = NULL, *loader = NULL, *existing_m = NULL;
Guido van Rossum222ef561997-09-06 19:41:09 +00002655 char *name, *subname;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002656 char buf[MAXPATHLEN+1];
2657 struct filedescr *fdp;
2658 FILE *fp = NULL;
Tim Peters1cd70172004-08-02 03:52:12 +00002659 PyObject *newm;
Guido van Rossumd8faa362007-04-27 19:54:29 +00002660
2661 if (modules_reloading == NULL) {
2662 Py_FatalError("PyImport_ReloadModule: "
Guido van Rossume7ba4952007-06-06 23:52:48 +00002663 "no modules_reloading dictionary!");
Guido van Rossumd8faa362007-04-27 19:54:29 +00002664 return NULL;
2665 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002666
Guido van Rossum79f25d91997-04-29 20:08:16 +00002667 if (m == NULL || !PyModule_Check(m)) {
2668 PyErr_SetString(PyExc_TypeError,
2669 "reload() argument must be module");
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002670 return NULL;
2671 }
Neal Norwitz5616c6d2007-08-26 05:32:41 +00002672 name = (char*)PyModule_GetName(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002673 if (name == NULL)
2674 return NULL;
Guido van Rossum25ce5661997-08-02 03:10:38 +00002675 if (m != PyDict_GetItemString(modules, name)) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002676 PyErr_Format(PyExc_ImportError,
2677 "reload(): module %.200s not in sys.modules",
2678 name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002679 return NULL;
2680 }
Guido van Rossumd8faa362007-04-27 19:54:29 +00002681 existing_m = PyDict_GetItemString(modules_reloading, name);
2682 if (existing_m != NULL) {
2683 /* Due to a recursive reload, this module is already
2684 being reloaded. */
2685 Py_INCREF(existing_m);
2686 return existing_m;
2687 }
2688 if (PyDict_SetItemString(modules_reloading, name, m) < 0)
2689 return NULL;
2690
Guido van Rossum222ef561997-09-06 19:41:09 +00002691 subname = strrchr(name, '.');
2692 if (subname == NULL)
2693 subname = name;
2694 else {
2695 PyObject *parentname, *parent;
Christian Heimesc4cb3b82007-11-04 12:10:01 +00002696 parentname = PyUnicode_FromStringAndSize(name, (subname-name));
Guido van Rossumd8faa362007-04-27 19:54:29 +00002697 if (parentname == NULL) {
2698 imp_modules_reloading_clear();
Guido van Rossum222ef561997-09-06 19:41:09 +00002699 return NULL;
Guido van Rossumd8faa362007-04-27 19:54:29 +00002700 }
Guido van Rossum222ef561997-09-06 19:41:09 +00002701 parent = PyDict_GetItem(modules, parentname);
2702 if (parent == NULL) {
2703 PyErr_Format(PyExc_ImportError,
2704 "reload(): parent %.200s not in sys.modules",
Marc-André Lemburg4cc0f242008-08-07 18:54:33 +00002705 _PyUnicode_AsString(parentname));
Georg Brandl0c55f292005-09-14 06:56:20 +00002706 Py_DECREF(parentname);
Guido van Rossume7ba4952007-06-06 23:52:48 +00002707 imp_modules_reloading_clear();
Guido van Rossum222ef561997-09-06 19:41:09 +00002708 return NULL;
2709 }
Georg Brandl0c55f292005-09-14 06:56:20 +00002710 Py_DECREF(parentname);
Guido van Rossum222ef561997-09-06 19:41:09 +00002711 subname++;
2712 path = PyObject_GetAttrString(parent, "__path__");
2713 if (path == NULL)
2714 PyErr_Clear();
2715 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002716 buf[0] = '\0';
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00002717 fdp = find_module(name, subname, path, buf, MAXPATHLEN+1, &fp, &loader);
Guido van Rossum222ef561997-09-06 19:41:09 +00002718 Py_XDECREF(path);
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00002719
2720 if (fdp == NULL) {
2721 Py_XDECREF(loader);
Guido van Rossumd8faa362007-04-27 19:54:29 +00002722 imp_modules_reloading_clear();
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002723 return NULL;
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00002724 }
2725
2726 newm = load_module(name, fp, buf, fdp->type, loader);
2727 Py_XDECREF(loader);
2728
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002729 if (fp)
2730 fclose(fp);
Tim Peters1cd70172004-08-02 03:52:12 +00002731 if (newm == NULL) {
2732 /* load_module probably removed name from modules because of
2733 * the error. Put back the original module object. We're
2734 * going to return NULL in this case regardless of whether
2735 * replacing name succeeds, so the return value is ignored.
2736 */
2737 PyDict_SetItemString(modules, name, m);
2738 }
Guido van Rossumd8faa362007-04-27 19:54:29 +00002739 imp_modules_reloading_clear();
Tim Peters1cd70172004-08-02 03:52:12 +00002740 return newm;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002741}
2742
2743
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002744/* Higher-level import emulator which emulates the "import" statement
2745 more accurately -- it invokes the __import__() function from the
2746 builtins of the current globals. This means that the import is
2747 done using whatever import hooks are installed in the current
Guido van Rossum6058eb41998-12-21 19:51:00 +00002748 environment, e.g. by "rexec".
2749 A dummy list ["__doc__"] is passed as the 4th argument so that
Neal Norwitz80e7f272007-08-26 06:45:23 +00002750 e.g. PyImport_Import(PyUnicode_FromString("win32com.client.gencache"))
Guido van Rossum6058eb41998-12-21 19:51:00 +00002751 will return <module "gencache"> instead of <module "win32com">. */
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002752
2753PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002754PyImport_Import(PyObject *module_name)
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002755{
2756 static PyObject *silly_list = NULL;
2757 static PyObject *builtins_str = NULL;
2758 static PyObject *import_str = NULL;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002759 PyObject *globals = NULL;
2760 PyObject *import = NULL;
2761 PyObject *builtins = NULL;
2762 PyObject *r = NULL;
2763
2764 /* Initialize constant string objects */
2765 if (silly_list == NULL) {
Martin v. Löwis5b222132007-06-10 09:51:05 +00002766 import_str = PyUnicode_InternFromString("__import__");
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002767 if (import_str == NULL)
2768 return NULL;
Martin v. Löwis5b222132007-06-10 09:51:05 +00002769 builtins_str = PyUnicode_InternFromString("__builtins__");
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002770 if (builtins_str == NULL)
2771 return NULL;
2772 silly_list = Py_BuildValue("[s]", "__doc__");
2773 if (silly_list == NULL)
2774 return NULL;
2775 }
2776
2777 /* Get the builtins from current globals */
2778 globals = PyEval_GetGlobals();
Guido van Rossum85cd1d62001-02-20 21:43:24 +00002779 if (globals != NULL) {
Guido van Rossum66468561998-10-22 15:46:50 +00002780 Py_INCREF(globals);
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002781 builtins = PyObject_GetItem(globals, builtins_str);
2782 if (builtins == NULL)
2783 goto err;
2784 }
2785 else {
2786 /* No globals -- use standard builtins, and fake globals */
2787 PyErr_Clear();
2788
Georg Brandl1a3284e2007-12-02 09:40:06 +00002789 builtins = PyImport_ImportModuleLevel("builtins",
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002790 NULL, NULL, NULL, 0);
Guido van Rossum85cd1d62001-02-20 21:43:24 +00002791 if (builtins == NULL)
2792 return NULL;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002793 globals = Py_BuildValue("{OO}", builtins_str, builtins);
2794 if (globals == NULL)
2795 goto err;
2796 }
2797
2798 /* Get the __import__ function from the builtins */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002799 if (PyDict_Check(builtins)) {
Fred Drakea76ba6e2001-03-06 06:31:15 +00002800 import = PyObject_GetItem(builtins, import_str);
Tim Peters6d6c1a32001-08-02 04:15:00 +00002801 if (import == NULL)
2802 PyErr_SetObject(PyExc_KeyError, import_str);
2803 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002804 else
Fred Drakea76ba6e2001-03-06 06:31:15 +00002805 import = PyObject_GetAttr(builtins, import_str);
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002806 if (import == NULL)
2807 goto err;
2808
Christian Heimes072c0f12008-01-03 23:01:04 +00002809 /* Call the __import__ function with the proper argument list
2810 * Always use absolute import here. */
2811 r = PyObject_CallFunction(import, "OOOOi", module_name, globals,
2812 globals, silly_list, 0, NULL);
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002813
2814 err:
2815 Py_XDECREF(globals);
2816 Py_XDECREF(builtins);
2817 Py_XDECREF(import);
Tim Peters50d8d372001-02-28 05:34:27 +00002818
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002819 return r;
2820}
2821
2822
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002823/* Module 'imp' provides Python access to the primitives used for
2824 importing modules.
2825*/
2826
Guido van Rossum79f25d91997-04-29 20:08:16 +00002827static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +00002828imp_get_magic(PyObject *self, PyObject *noargs)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002829{
2830 char buf[4];
2831
Guido van Rossum96774c12000-05-01 20:19:08 +00002832 buf[0] = (char) ((pyc_magic >> 0) & 0xff);
2833 buf[1] = (char) ((pyc_magic >> 8) & 0xff);
2834 buf[2] = (char) ((pyc_magic >> 16) & 0xff);
2835 buf[3] = (char) ((pyc_magic >> 24) & 0xff);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002836
Christian Heimes72b710a2008-05-26 13:28:38 +00002837 return PyBytes_FromStringAndSize(buf, 4);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002838}
2839
Guido van Rossum79f25d91997-04-29 20:08:16 +00002840static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +00002841imp_get_suffixes(PyObject *self, PyObject *noargs)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002842{
Guido van Rossum79f25d91997-04-29 20:08:16 +00002843 PyObject *list;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002844 struct filedescr *fdp;
2845
Guido van Rossum79f25d91997-04-29 20:08:16 +00002846 list = PyList_New(0);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002847 if (list == NULL)
2848 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002849 for (fdp = _PyImport_Filetab; fdp->suffix != NULL; fdp++) {
2850 PyObject *item = Py_BuildValue("ssi",
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002851 fdp->suffix, fdp->mode, fdp->type);
2852 if (item == NULL) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00002853 Py_DECREF(list);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002854 return NULL;
2855 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002856 if (PyList_Append(list, item) < 0) {
2857 Py_DECREF(list);
2858 Py_DECREF(item);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002859 return NULL;
2860 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002861 Py_DECREF(item);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002862 }
2863 return list;
2864}
2865
Guido van Rossum79f25d91997-04-29 20:08:16 +00002866static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002867call_find_module(char *name, PyObject *path)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002868{
Tim Petersdbd9ba62000-07-09 03:09:57 +00002869 extern int fclose(FILE *);
Guido van Rossum79f25d91997-04-29 20:08:16 +00002870 PyObject *fob, *ret;
Amaury Forgeot d'Arc9a5499b2008-11-11 23:04:59 +00002871 PyObject *pathobj;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002872 struct filedescr *fdp;
2873 char pathname[MAXPATHLEN+1];
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002874 FILE *fp = NULL;
Guido van Rossum40d20bc2007-10-22 00:09:51 +00002875 int fd = -1;
Brett Cannon3bb42d92007-10-20 03:43:15 +00002876 char *found_encoding = NULL;
Guido van Rossumce3a72a2007-10-19 23:16:50 +00002877 char *encoding = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002878
2879 pathname[0] = '\0';
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002880 if (path == Py_None)
2881 path = NULL;
Just van Rossum52e14d62002-12-30 22:08:05 +00002882 fdp = find_module(NULL, name, path, pathname, MAXPATHLEN+1, &fp, NULL);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002883 if (fdp == NULL)
2884 return NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002885 if (fp != NULL) {
Guido van Rossum40d20bc2007-10-22 00:09:51 +00002886 fd = fileno(fp);
2887 if (fd != -1)
2888 fd = dup(fd);
2889 fclose(fp);
2890 fp = NULL;
2891 }
2892 if (fd != -1) {
Guido van Rossumce3a72a2007-10-19 23:16:50 +00002893 if (strchr(fdp->mode, 'b') == NULL) {
Brett Cannon3bb42d92007-10-20 03:43:15 +00002894 /* PyTokenizer_FindEncoding() returns PyMem_MALLOC'ed
2895 memory. */
Guido van Rossum40d20bc2007-10-22 00:09:51 +00002896 found_encoding = PyTokenizer_FindEncoding(fd);
2897 lseek(fd, 0, 0); /* Reset position */
Amaury Forgeot d'Arc1b933ed2008-09-04 22:34:09 +00002898 if (found_encoding == NULL && PyErr_Occurred())
2899 return NULL;
Brett Cannon3bb42d92007-10-20 03:43:15 +00002900 encoding = (found_encoding != NULL) ? found_encoding :
Guido van Rossumce3a72a2007-10-19 23:16:50 +00002901 (char*)PyUnicode_GetDefaultEncoding();
2902 }
Guido van Rossum40d20bc2007-10-22 00:09:51 +00002903 fob = PyFile_FromFd(fd, pathname, fdp->mode, -1,
Guido van Rossume7fc50f2007-12-03 22:54:21 +00002904 (char*)encoding, NULL, NULL, 1);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002905 if (fob == NULL) {
Guido van Rossum40d20bc2007-10-22 00:09:51 +00002906 close(fd);
Brett Cannon3bb42d92007-10-20 03:43:15 +00002907 PyMem_FREE(found_encoding);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002908 return NULL;
2909 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002910 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002911 else {
2912 fob = Py_None;
2913 Py_INCREF(fob);
Tim Peters50d8d372001-02-28 05:34:27 +00002914 }
Amaury Forgeot d'Arc9a5499b2008-11-11 23:04:59 +00002915 pathobj = PyUnicode_DecodeFSDefault(pathname);
2916 ret = Py_BuildValue("NN(ssi)",
2917 fob, pathobj, fdp->suffix, fdp->mode, fdp->type);
Brett Cannon3bb42d92007-10-20 03:43:15 +00002918 PyMem_FREE(found_encoding);
2919
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002920 return ret;
2921}
2922
Guido van Rossum79f25d91997-04-29 20:08:16 +00002923static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002924imp_find_module(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002925{
2926 char *name;
Hirokazu Yamamoto90eaaf62009-01-30 03:15:05 +00002927 PyObject *ret, *path = NULL;
Amaury Forgeot d'Arc9a5499b2008-11-11 23:04:59 +00002928 if (!PyArg_ParseTuple(args, "es|O:find_module",
2929 Py_FileSystemDefaultEncoding, &name,
2930 &path))
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002931 return NULL;
Hirokazu Yamamoto90eaaf62009-01-30 03:15:05 +00002932 ret = call_find_module(name, path);
2933 PyMem_Free(name);
2934 return ret;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002935}
2936
2937static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002938imp_init_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002939{
2940 char *name;
2941 int ret;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002942 PyObject *m;
Guido van Rossum43713e52000-02-29 13:59:29 +00002943 if (!PyArg_ParseTuple(args, "s:init_builtin", &name))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002944 return NULL;
2945 ret = init_builtin(name);
2946 if (ret < 0)
2947 return NULL;
2948 if (ret == 0) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00002949 Py_INCREF(Py_None);
2950 return Py_None;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002951 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002952 m = PyImport_AddModule(name);
2953 Py_XINCREF(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002954 return m;
2955}
2956
Guido van Rossum79f25d91997-04-29 20:08:16 +00002957static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002958imp_init_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002959{
2960 char *name;
2961 int ret;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002962 PyObject *m;
Guido van Rossum43713e52000-02-29 13:59:29 +00002963 if (!PyArg_ParseTuple(args, "s:init_frozen", &name))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002964 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002965 ret = PyImport_ImportFrozenModule(name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002966 if (ret < 0)
2967 return NULL;
2968 if (ret == 0) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00002969 Py_INCREF(Py_None);
2970 return Py_None;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002971 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002972 m = PyImport_AddModule(name);
2973 Py_XINCREF(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002974 return m;
2975}
2976
Guido van Rossum79f25d91997-04-29 20:08:16 +00002977static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002978imp_get_frozen_object(PyObject *self, PyObject *args)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002979{
2980 char *name;
Jack Jansen95ffa231995-10-03 14:38:41 +00002981
Guido van Rossum43713e52000-02-29 13:59:29 +00002982 if (!PyArg_ParseTuple(args, "s:get_frozen_object", &name))
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002983 return NULL;
2984 return get_frozen_object(name);
2985}
2986
Guido van Rossum79f25d91997-04-29 20:08:16 +00002987static PyObject *
Brett Cannon8d110132009-03-15 02:20:16 +00002988imp_is_frozen_package(PyObject *self, PyObject *args)
2989{
2990 char *name;
2991
2992 if (!PyArg_ParseTuple(args, "s:is_frozen_package", &name))
2993 return NULL;
2994 return is_frozen_package(name);
2995}
2996
2997static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002998imp_is_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002999{
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003000 char *name;
Guido van Rossum43713e52000-02-29 13:59:29 +00003001 if (!PyArg_ParseTuple(args, "s:is_builtin", &name))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003002 return NULL;
Christian Heimes217cfd12007-12-02 14:31:20 +00003003 return PyLong_FromLong(is_builtin(name));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003004}
3005
Guido van Rossum79f25d91997-04-29 20:08:16 +00003006static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003007imp_is_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003008{
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003009 char *name;
Guido van Rossum323bf5e1998-06-24 03:54:06 +00003010 struct _frozen *p;
Guido van Rossum43713e52000-02-29 13:59:29 +00003011 if (!PyArg_ParseTuple(args, "s:is_frozen", &name))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003012 return NULL;
Guido van Rossum323bf5e1998-06-24 03:54:06 +00003013 p = find_frozen(name);
Guido van Rossumb8bff3f2002-04-07 06:34:38 +00003014 return PyBool_FromLong((long) (p == NULL ? 0 : p->size));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003015}
3016
3017static FILE *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003018get_file(char *pathname, PyObject *fob, char *mode)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003019{
3020 FILE *fp;
Guido van Rossumda5b8f22007-06-12 23:30:11 +00003021 if (mode[0] == 'U')
3022 mode = "r" PY_STDIOTEXTMODE;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003023 if (fob == NULL) {
3024 fp = fopen(pathname, mode);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003025 }
3026 else {
Guido van Rossumda5b8f22007-06-12 23:30:11 +00003027 int fd = PyObject_AsFileDescriptor(fob);
3028 if (fd == -1)
3029 return NULL;
Kristján Valur Jónssone1b04452009-03-31 17:43:39 +00003030 if (!_PyVerify_fd(fd))
3031 goto error;
3032 /* the FILE struct gets a new fd, so that it can be closed
3033 * independently of the file descriptor given
3034 */
3035 fd = dup(fd);
3036 if (fd == -1)
3037 goto error;
Guido van Rossumda5b8f22007-06-12 23:30:11 +00003038 fp = fdopen(fd, mode);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003039 }
Kristján Valur Jónssone1b04452009-03-31 17:43:39 +00003040 if (fp)
3041 return fp;
3042error:
3043 PyErr_SetFromErrno(PyExc_IOError);
3044 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003045}
3046
Guido van Rossum79f25d91997-04-29 20:08:16 +00003047static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003048imp_load_compiled(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003049{
3050 char *name;
3051 char *pathname;
Guido van Rossum79f25d91997-04-29 20:08:16 +00003052 PyObject *fob = NULL;
3053 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003054 FILE *fp;
Guido van Rossum0ad59d42009-03-30 22:01:35 +00003055 if (!PyArg_ParseTuple(args, "ses|O:load_compiled",
3056 &name,
3057 Py_FileSystemDefaultEncoding, &pathname,
3058 &fob))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003059 return NULL;
3060 fp = get_file(pathname, fob, "rb");
Guido van Rossum0ad59d42009-03-30 22:01:35 +00003061 if (fp == NULL) {
3062 PyMem_Free(pathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003063 return NULL;
Guido van Rossum0ad59d42009-03-30 22:01:35 +00003064 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003065 m = load_compiled_module(name, pathname, fp);
Kristján Valur Jónssone1b04452009-03-31 17:43:39 +00003066 fclose(fp);
Guido van Rossum0ad59d42009-03-30 22:01:35 +00003067 PyMem_Free(pathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003068 return m;
3069}
3070
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003071#ifdef HAVE_DYNAMIC_LOADING
3072
Guido van Rossum79f25d91997-04-29 20:08:16 +00003073static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003074imp_load_dynamic(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003075{
3076 char *name;
3077 char *pathname;
Guido van Rossum79f25d91997-04-29 20:08:16 +00003078 PyObject *fob = NULL;
3079 PyObject *m;
Guido van Rossum7faeab31995-07-07 22:50:36 +00003080 FILE *fp = NULL;
Guido van Rossum0ad59d42009-03-30 22:01:35 +00003081 if (!PyArg_ParseTuple(args, "ses|O:load_dynamic",
3082 &name,
3083 Py_FileSystemDefaultEncoding, &pathname,
3084 &fob))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003085 return NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003086 if (fob) {
Guido van Rossum7faeab31995-07-07 22:50:36 +00003087 fp = get_file(pathname, fob, "r");
Guido van Rossum0ad59d42009-03-30 22:01:35 +00003088 if (fp == NULL) {
3089 PyMem_Free(pathname);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003090 return NULL;
Guido van Rossum0ad59d42009-03-30 22:01:35 +00003091 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003092 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00003093 m = _PyImport_LoadDynamicModule(name, pathname, fp);
Guido van Rossum0ad59d42009-03-30 22:01:35 +00003094 PyMem_Free(pathname);
Kristján Valur Jónssone1b04452009-03-31 17:43:39 +00003095 if (fp)
3096 fclose(fp);
Guido van Rossum7faeab31995-07-07 22:50:36 +00003097 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003098}
3099
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003100#endif /* HAVE_DYNAMIC_LOADING */
3101
Guido van Rossum79f25d91997-04-29 20:08:16 +00003102static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003103imp_load_source(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003104{
3105 char *name;
3106 char *pathname;
Guido van Rossum79f25d91997-04-29 20:08:16 +00003107 PyObject *fob = NULL;
3108 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003109 FILE *fp;
Guido van Rossum0ad59d42009-03-30 22:01:35 +00003110 if (!PyArg_ParseTuple(args, "ses|O:load_source",
3111 &name,
3112 Py_FileSystemDefaultEncoding, &pathname,
3113 &fob))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003114 return NULL;
3115 fp = get_file(pathname, fob, "r");
Guido van Rossum0ad59d42009-03-30 22:01:35 +00003116 if (fp == NULL) {
3117 PyMem_Free(pathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003118 return NULL;
Guido van Rossum0ad59d42009-03-30 22:01:35 +00003119 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003120 m = load_source_module(name, pathname, fp);
Kristján Valur Jónsson92af5d92009-03-31 17:47:50 +00003121 PyMem_Free(pathname);
Kristján Valur Jónssone1b04452009-03-31 17:43:39 +00003122 fclose(fp);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003123 return m;
3124}
3125
Guido van Rossum79f25d91997-04-29 20:08:16 +00003126static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003127imp_load_module(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003128{
3129 char *name;
3130 PyObject *fob;
3131 char *pathname;
Guido van Rossum0ad59d42009-03-30 22:01:35 +00003132 PyObject * ret;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003133 char *suffix; /* Unused */
3134 char *mode;
3135 int type;
3136 FILE *fp;
3137
Guido van Rossum0ad59d42009-03-30 22:01:35 +00003138 if (!PyArg_ParseTuple(args, "sOes(ssi):load_module",
3139 &name, &fob,
3140 Py_FileSystemDefaultEncoding, &pathname,
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003141 &suffix, &mode, &type))
3142 return NULL;
Guido van Rossum5e2c5fa2002-05-30 17:33:07 +00003143 if (*mode) {
3144 /* Mode must start with 'r' or 'U' and must not contain '+'.
3145 Implicit in this test is the assumption that the mode
3146 may contain other modifiers like 'b' or 't'. */
3147
3148 if (!(*mode == 'r' || *mode == 'U') || strchr(mode, '+')) {
Jeremy Hylton4ae6fae2002-05-30 17:15:25 +00003149 PyErr_Format(PyExc_ValueError,
3150 "invalid file open mode %.200s", mode);
Guido van Rossum0ad59d42009-03-30 22:01:35 +00003151 PyMem_Free(pathname);
Jeremy Hylton4ae6fae2002-05-30 17:15:25 +00003152 return NULL;
Guido van Rossum5e2c5fa2002-05-30 17:33:07 +00003153 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003154 }
3155 if (fob == Py_None)
3156 fp = NULL;
3157 else {
Guido van Rossumda5b8f22007-06-12 23:30:11 +00003158 fp = get_file(NULL, fob, mode);
Guido van Rossum0ad59d42009-03-30 22:01:35 +00003159 if (fp == NULL) {
3160 PyMem_Free(pathname);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003161 return NULL;
Guido van Rossum0ad59d42009-03-30 22:01:35 +00003162 }
3163 }
3164 ret = load_module(name, fp, pathname, type, NULL);
3165 PyMem_Free(pathname);
Kristján Valur Jónssone1b04452009-03-31 17:43:39 +00003166 if (fp)
3167 fclose(fp);
Guido van Rossum0ad59d42009-03-30 22:01:35 +00003168 return ret;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003169}
3170
3171static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003172imp_load_package(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003173{
3174 char *name;
3175 char *pathname;
Guido van Rossum0ad59d42009-03-30 22:01:35 +00003176 PyObject * ret;
3177 if (!PyArg_ParseTuple(args, "ses:load_package",
3178 &name, Py_FileSystemDefaultEncoding, &pathname))
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003179 return NULL;
Guido van Rossum0ad59d42009-03-30 22:01:35 +00003180 ret = load_package(name, pathname);
3181 PyMem_Free(pathname);
3182 return ret;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003183}
3184
3185static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003186imp_new_module(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003187{
3188 char *name;
Guido van Rossum43713e52000-02-29 13:59:29 +00003189 if (!PyArg_ParseTuple(args, "s:new_module", &name))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003190 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +00003191 return PyModule_New(name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003192}
3193
Christian Heimes13a7a212008-01-07 17:13:09 +00003194static PyObject *
3195imp_reload(PyObject *self, PyObject *v)
3196{
3197 return PyImport_ReloadModule(v);
3198}
3199
3200PyDoc_STRVAR(doc_reload,
3201"reload(module) -> module\n\
3202\n\
3203Reload the module. The module must have been successfully imported before.");
3204
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003205/* Doc strings */
3206
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003207PyDoc_STRVAR(doc_imp,
3208"This module provides the components needed to build your own\n\
3209__import__ function. Undocumented functions are obsolete.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003210
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003211PyDoc_STRVAR(doc_find_module,
3212"find_module(name, [path]) -> (file, filename, (suffix, mode, type))\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003213Search for a module. If path is omitted or None, search for a\n\
3214built-in, frozen or special module and continue search in sys.path.\n\
3215The module name cannot contain '.'; to search for a submodule of a\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003216package, pass the submodule name and the package's __path__.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003217
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003218PyDoc_STRVAR(doc_load_module,
3219"load_module(name, file, filename, (suffix, mode, type)) -> module\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003220Load a module, given information returned by find_module().\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003221The module name must include the full package name, if any.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003222
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003223PyDoc_STRVAR(doc_get_magic,
3224"get_magic() -> string\n\
3225Return the magic number for .pyc or .pyo files.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003226
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003227PyDoc_STRVAR(doc_get_suffixes,
3228"get_suffixes() -> [(suffix, mode, type), ...]\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003229Return a list of (suffix, mode, type) tuples describing the files\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003230that find_module() looks for.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003231
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003232PyDoc_STRVAR(doc_new_module,
3233"new_module(name) -> module\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003234Create a new module. Do not enter it in sys.modules.\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003235The module name must include the full package name, if any.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003236
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003237PyDoc_STRVAR(doc_lock_held,
Tim Petersa7c65092004-08-01 23:26:05 +00003238"lock_held() -> boolean\n\
3239Return True if the import lock is currently held, else False.\n\
3240On platforms without threads, return False.");
Tim Peters69232342001-08-30 05:16:13 +00003241
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00003242PyDoc_STRVAR(doc_acquire_lock,
3243"acquire_lock() -> None\n\
Neal Norwitz2294c0d2003-02-12 23:02:21 +00003244Acquires the interpreter's import lock for the current thread.\n\
3245This lock should be used by import hooks to ensure thread-safety\n\
3246when importing modules.\n\
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00003247On platforms without threads, this function does nothing.");
3248
3249PyDoc_STRVAR(doc_release_lock,
3250"release_lock() -> None\n\
3251Release the interpreter's import lock.\n\
3252On platforms without threads, this function does nothing.");
3253
Guido van Rossum79f25d91997-04-29 20:08:16 +00003254static PyMethodDef imp_methods[] = {
Neal Norwitz08ea61a2003-02-17 18:18:00 +00003255 {"find_module", imp_find_module, METH_VARARGS, doc_find_module},
3256 {"get_magic", imp_get_magic, METH_NOARGS, doc_get_magic},
3257 {"get_suffixes", imp_get_suffixes, METH_NOARGS, doc_get_suffixes},
3258 {"load_module", imp_load_module, METH_VARARGS, doc_load_module},
3259 {"new_module", imp_new_module, METH_VARARGS, doc_new_module},
3260 {"lock_held", imp_lock_held, METH_NOARGS, doc_lock_held},
3261 {"acquire_lock", imp_acquire_lock, METH_NOARGS, doc_acquire_lock},
3262 {"release_lock", imp_release_lock, METH_NOARGS, doc_release_lock},
Christian Heimes13a7a212008-01-07 17:13:09 +00003263 {"reload", imp_reload, METH_O, doc_reload},
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003264 /* The rest are obsolete */
Neal Norwitz031829d2002-03-31 14:37:44 +00003265 {"get_frozen_object", imp_get_frozen_object, METH_VARARGS},
Brett Cannon8d110132009-03-15 02:20:16 +00003266 {"is_frozen_package", imp_is_frozen_package, METH_VARARGS},
Neal Norwitz031829d2002-03-31 14:37:44 +00003267 {"init_builtin", imp_init_builtin, METH_VARARGS},
3268 {"init_frozen", imp_init_frozen, METH_VARARGS},
3269 {"is_builtin", imp_is_builtin, METH_VARARGS},
3270 {"is_frozen", imp_is_frozen, METH_VARARGS},
3271 {"load_compiled", imp_load_compiled, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003272#ifdef HAVE_DYNAMIC_LOADING
Neal Norwitz031829d2002-03-31 14:37:44 +00003273 {"load_dynamic", imp_load_dynamic, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003274#endif
Neal Norwitz031829d2002-03-31 14:37:44 +00003275 {"load_package", imp_load_package, METH_VARARGS},
Neal Norwitz031829d2002-03-31 14:37:44 +00003276 {"load_source", imp_load_source, METH_VARARGS},
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003277 {NULL, NULL} /* sentinel */
3278};
3279
Guido van Rossum1a8791e1998-08-04 22:46:29 +00003280static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003281setint(PyObject *d, char *name, int value)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003282{
3283 PyObject *v;
3284 int err;
3285
Christian Heimes217cfd12007-12-02 14:31:20 +00003286 v = PyLong_FromLong((long)value);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003287 err = PyDict_SetItemString(d, name, v);
3288 Py_XDECREF(v);
3289 return err;
3290}
3291
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003292typedef struct {
3293 PyObject_HEAD
3294} NullImporter;
3295
3296static int
3297NullImporter_init(NullImporter *self, PyObject *args, PyObject *kwds)
3298{
3299 char *path;
Christian Heimes7d3bc0a2007-11-07 17:26:16 +00003300 Py_ssize_t pathlen;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003301
3302 if (!_PyArg_NoKeywords("NullImporter()", kwds))
3303 return -1;
3304
Amaury Forgeot d'Arcf1ca0b12008-06-11 17:40:47 +00003305 if (!PyArg_ParseTuple(args, "es:NullImporter",
3306 Py_FileSystemDefaultEncoding, &path))
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003307 return -1;
3308
Christian Heimes7d3bc0a2007-11-07 17:26:16 +00003309 pathlen = strlen(path);
3310 if (pathlen == 0) {
Georg Brandl8494d572008-07-19 10:13:15 +00003311 PyMem_Free(path);
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003312 PyErr_SetString(PyExc_ImportError, "empty pathname");
3313 return -1;
3314 } else {
Hirokazu Yamamoto21cbf5f2009-01-23 07:23:03 +00003315#ifndef MS_WINDOWS
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003316 struct stat statbuf;
3317 int rv;
3318
3319 rv = stat(path, &statbuf);
Georg Brandl8494d572008-07-19 10:13:15 +00003320 PyMem_Free(path);
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003321 if (rv == 0) {
3322 /* it exists */
3323 if (S_ISDIR(statbuf.st_mode)) {
3324 /* it's a directory */
3325 PyErr_SetString(PyExc_ImportError,
3326 "existing directory");
3327 return -1;
3328 }
3329 }
Hirokazu Yamamoto21cbf5f2009-01-23 07:23:03 +00003330#else /* MS_WINDOWS */
3331 DWORD rv;
3332 /* see issue1293 and issue3677:
3333 * stat() on Windows doesn't recognise paths like
3334 * "e:\\shared\\" and "\\\\whiterab-c2znlh\\shared" as dirs.
3335 */
3336 rv = GetFileAttributesA(path);
Kristján Valur Jónsson92cb4382009-01-24 10:33:25 +00003337 PyMem_Free(path);
Hirokazu Yamamoto21cbf5f2009-01-23 07:23:03 +00003338 if (rv != INVALID_FILE_ATTRIBUTES) {
3339 /* it exists */
3340 if (rv & FILE_ATTRIBUTE_DIRECTORY) {
3341 /* it's a directory */
3342 PyErr_SetString(PyExc_ImportError,
3343 "existing directory");
3344 return -1;
3345 }
3346 }
3347#endif
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003348 }
3349 return 0;
3350}
3351
3352static PyObject *
3353NullImporter_find_module(NullImporter *self, PyObject *args)
3354{
3355 Py_RETURN_NONE;
3356}
3357
3358static PyMethodDef NullImporter_methods[] = {
3359 {"find_module", (PyCFunction)NullImporter_find_module, METH_VARARGS,
3360 "Always return None"
3361 },
3362 {NULL} /* Sentinel */
3363};
3364
3365
Christian Heimes9cd17752007-11-18 19:35:23 +00003366PyTypeObject PyNullImporter_Type = {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +00003367 PyVarObject_HEAD_INIT(NULL, 0)
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003368 "imp.NullImporter", /*tp_name*/
3369 sizeof(NullImporter), /*tp_basicsize*/
3370 0, /*tp_itemsize*/
3371 0, /*tp_dealloc*/
3372 0, /*tp_print*/
3373 0, /*tp_getattr*/
3374 0, /*tp_setattr*/
Mark Dickinsone94c6792009-02-02 20:36:42 +00003375 0, /*tp_reserved*/
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003376 0, /*tp_repr*/
3377 0, /*tp_as_number*/
3378 0, /*tp_as_sequence*/
3379 0, /*tp_as_mapping*/
3380 0, /*tp_hash */
3381 0, /*tp_call*/
3382 0, /*tp_str*/
3383 0, /*tp_getattro*/
3384 0, /*tp_setattro*/
3385 0, /*tp_as_buffer*/
3386 Py_TPFLAGS_DEFAULT, /*tp_flags*/
3387 "Null importer object", /* tp_doc */
3388 0, /* tp_traverse */
3389 0, /* tp_clear */
3390 0, /* tp_richcompare */
3391 0, /* tp_weaklistoffset */
3392 0, /* tp_iter */
3393 0, /* tp_iternext */
3394 NullImporter_methods, /* tp_methods */
3395 0, /* tp_members */
3396 0, /* tp_getset */
3397 0, /* tp_base */
3398 0, /* tp_dict */
3399 0, /* tp_descr_get */
3400 0, /* tp_descr_set */
3401 0, /* tp_dictoffset */
3402 (initproc)NullImporter_init, /* tp_init */
3403 0, /* tp_alloc */
3404 PyType_GenericNew /* tp_new */
3405};
3406
Martin v. Löwis1a214512008-06-11 05:26:20 +00003407static struct PyModuleDef impmodule = {
3408 PyModuleDef_HEAD_INIT,
3409 "imp",
3410 doc_imp,
3411 0,
3412 imp_methods,
3413 NULL,
3414 NULL,
3415 NULL,
3416 NULL
3417};
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003418
Jason Tishler6bc06ec2003-09-04 11:59:50 +00003419PyMODINIT_FUNC
Martin v. Löwis1a214512008-06-11 05:26:20 +00003420PyInit_imp(void)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003421{
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003422 PyObject *m, *d;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003423
Christian Heimes9cd17752007-11-18 19:35:23 +00003424 if (PyType_Ready(&PyNullImporter_Type) < 0)
Martin v. Löwis1a214512008-06-11 05:26:20 +00003425 return NULL;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003426
Martin v. Löwis1a214512008-06-11 05:26:20 +00003427 m = PyModule_Create(&impmodule);
Neal Norwitz1ac754f2006-01-19 06:09:39 +00003428 if (m == NULL)
3429 goto failure;
Guido van Rossum79f25d91997-04-29 20:08:16 +00003430 d = PyModule_GetDict(m);
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00003431 if (d == NULL)
3432 goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003433
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003434 if (setint(d, "SEARCH_ERROR", SEARCH_ERROR) < 0) goto failure;
3435 if (setint(d, "PY_SOURCE", PY_SOURCE) < 0) goto failure;
3436 if (setint(d, "PY_COMPILED", PY_COMPILED) < 0) goto failure;
3437 if (setint(d, "C_EXTENSION", C_EXTENSION) < 0) goto failure;
3438 if (setint(d, "PY_RESOURCE", PY_RESOURCE) < 0) goto failure;
3439 if (setint(d, "PKG_DIRECTORY", PKG_DIRECTORY) < 0) goto failure;
3440 if (setint(d, "C_BUILTIN", C_BUILTIN) < 0) goto failure;
3441 if (setint(d, "PY_FROZEN", PY_FROZEN) < 0) goto failure;
Guido van Rossum0f84a341998-08-06 13:36:01 +00003442 if (setint(d, "PY_CODERESOURCE", PY_CODERESOURCE) < 0) goto failure;
Just van Rossum52e14d62002-12-30 22:08:05 +00003443 if (setint(d, "IMP_HOOK", IMP_HOOK) < 0) goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003444
Christian Heimes9cd17752007-11-18 19:35:23 +00003445 Py_INCREF(&PyNullImporter_Type);
3446 PyModule_AddObject(m, "NullImporter", (PyObject *)&PyNullImporter_Type);
Martin v. Löwis1a214512008-06-11 05:26:20 +00003447 return m;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003448 failure:
Martin v. Löwis1a214512008-06-11 05:26:20 +00003449 Py_XDECREF(m);
3450 return NULL;
3451
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003452}
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003453
3454
Guido van Rossumb18618d2000-05-03 23:44:39 +00003455/* API for embedding applications that want to add their own entries
3456 to the table of built-in modules. This should normally be called
3457 *before* Py_Initialize(). When the table resize fails, -1 is
3458 returned and the existing table is unchanged.
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003459
3460 After a similar function by Just van Rossum. */
3461
3462int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003463PyImport_ExtendInittab(struct _inittab *newtab)
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003464{
3465 static struct _inittab *our_copy = NULL;
3466 struct _inittab *p;
3467 int i, n;
3468
3469 /* Count the number of entries in both tables */
3470 for (n = 0; newtab[n].name != NULL; n++)
3471 ;
3472 if (n == 0)
3473 return 0; /* Nothing to do */
3474 for (i = 0; PyImport_Inittab[i].name != NULL; i++)
3475 ;
3476
3477 /* Allocate new memory for the combined table */
Guido van Rossumb18618d2000-05-03 23:44:39 +00003478 p = our_copy;
3479 PyMem_RESIZE(p, struct _inittab, i+n+1);
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003480 if (p == NULL)
3481 return -1;
3482
3483 /* Copy the tables into the new memory */
3484 if (our_copy != PyImport_Inittab)
3485 memcpy(p, PyImport_Inittab, (i+1) * sizeof(struct _inittab));
3486 PyImport_Inittab = our_copy = p;
3487 memcpy(p+i, newtab, (n+1) * sizeof(struct _inittab));
3488
3489 return 0;
3490}
3491
3492/* Shorthand to add a single entry given a name and a function */
3493
3494int
Brett Cannona826f322009-04-02 03:41:46 +00003495PyImport_AppendInittab(const char *name, PyObject* (*initfunc)(void))
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003496{
3497 struct _inittab newtab[2];
3498
3499 memset(newtab, '\0', sizeof newtab);
3500
Brett Cannona826f322009-04-02 03:41:46 +00003501 newtab[0].name = (char *)name;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003502 newtab[0].initfunc = initfunc;
3503
3504 return PyImport_ExtendInittab(newtab);
3505}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00003506
3507#ifdef __cplusplus
3508}
3509#endif