blob: 127b8078401e2f451afb1b1f9d0e2bba14526681 [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"
Kristján Valur Jónsson67387fb2007-04-25 00:17:39 +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
Anthony Baxterac6bd462006-04-13 02:06:09 +000021#ifdef __cplusplus
Brett Cannonb166afc2010-05-05 20:25:47 +000022extern "C" {
Anthony Baxterac6bd462006-04-13 02:06:09 +000023#endif
Guido van Rossum55a83382000-09-20 20:31:38 +000024
Christian Heimes5e8e6d22008-02-23 23:59:45 +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
Martin v. Löwisef82d2f2004-06-27 16:51:46 +000038 The magic numbers must be spaced apart atleast 2 values, as the
39 -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
Skip Montanaro4ec3c262006-03-25 14:12:03 +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)
Neal Norwitz0d62a062006-07-30 06:53:31 +000067 Python 2.5b3: 62101 (fix wrong code: for x, in ...)
68 Python 2.5b3: 62111 (fix wrong code: x += yield)
Neal Norwitz9a70f952006-08-04 05:12:19 +000069 Python 2.5c1: 62121 (fix wrong lnotab with for loops and
Antoine Pitrouc83ea132010-05-09 14:46:46 +000070 storing constants that should have been removed)
Neal Norwitzdac090d2006-09-05 03:53:08 +000071 Python 2.5c2: 62131 (fix wrong code: for x, in ... in listcomp/genexp)
Raymond Hettingereffde122007-12-18 18:26:18 +000072 Python 2.6a0: 62151 (peephole optimizations and STORE_MAP opcode)
Nick Coghlan7af53be2008-03-07 14:13:28 +000073 Python 2.6a1: 62161 (WITH_CLEANUP optimization)
Antoine Pitroud0c35152008-12-17 00:38:28 +000074 Python 2.7a0: 62171 (optimize list comprehensions/change LIST_APPEND)
Jeffrey Yasskin68d68522009-02-28 19:03:21 +000075 Python 2.7a0: 62181 (optimize conditional branches:
Antoine Pitrouc83ea132010-05-09 14:46:46 +000076 introduce POP_JUMP_IF_FALSE and POP_JUMP_IF_TRUE)
Benjamin Peterson1880d8b2009-05-25 13:13:44 +000077 Python 2.7a0 62191 (introduce SETUP_WITH)
Alexandre Vassalottiee936a22010-01-09 23:35:54 +000078 Python 2.7a0 62201 (introduce BUILD_SET)
Alexandre Vassalottib6465472010-01-11 22:36:12 +000079 Python 2.7a0 62211 (introduce MAP_ADD and SET_ADD)
Michael W. Hudsonaee2e282005-10-21 11:32:20 +000080.
Tim Peters36515e22001-11-18 04:06:29 +000081*/
Alexandre Vassalottib6465472010-01-11 22:36:12 +000082#define MAGIC (62211 | ((long)'\r'<<16) | ((long)'\n'<<24))
Guido van Rossum3ddee711991-12-16 13:06:34 +000083
Guido van Rossum96774c12000-05-01 20:19:08 +000084/* Magic word as global; note that _PyImport_Init() can change the
Jeremy Hylton9262b8a2000-06-30 04:59:17 +000085 value of this global to accommodate for alterations of how the
Guido van Rossum96774c12000-05-01 20:19:08 +000086 compiler works which are enabled by command line switches. */
Christian Heimes61e45902008-03-27 10:35:52 +000087static long pyc_magic = MAGIC;
Guido van Rossum96774c12000-05-01 20:19:08 +000088
Guido van Rossum25ce5661997-08-02 03:10:38 +000089/* See _PyImport_FixupExtension() below */
90static PyObject *extensions = NULL;
Guido van Rossum3f5da241990-12-20 15:06:42 +000091
Guido van Rossum771c6c81997-10-31 18:37:24 +000092/* This table is defined in config.c: */
93extern struct _inittab _PyImport_Inittab[];
94
95struct _inittab *PyImport_Inittab = _PyImport_Inittab;
Guido van Rossum66f1fa81991-04-03 19:03:52 +000096
Guido van Rossumed1170e1999-12-20 21:23:41 +000097/* these tables define the module suffixes that Python recognizes */
98struct filedescr * _PyImport_Filetab = NULL;
Guido van Rossum48a680c2001-03-02 06:34:14 +000099
100#ifdef RISCOS
101static const struct filedescr _PyImport_StandardFiletab[] = {
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000102 {"/py", "U", PY_SOURCE},
103 {"/pyc", "rb", PY_COMPILED},
104 {0, 0}
Guido van Rossum48a680c2001-03-02 06:34:14 +0000105};
106#else
Guido van Rossumed1170e1999-12-20 21:23:41 +0000107static const struct filedescr _PyImport_StandardFiletab[] = {
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000108 {".py", "U", PY_SOURCE},
Martin v. Löwis6238d2b2002-06-30 15:26:10 +0000109#ifdef MS_WINDOWS
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000110 {".pyw", "U", PY_SOURCE},
Tim Peters36515e22001-11-18 04:06:29 +0000111#endif
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000112 {".pyc", "rb", PY_COMPILED},
113 {0, 0}
Guido van Rossumed1170e1999-12-20 21:23:41 +0000114};
Guido van Rossum48a680c2001-03-02 06:34:14 +0000115#endif
Guido van Rossumed1170e1999-12-20 21:23:41 +0000116
Jason R. Coombsfa93cf82012-01-13 17:37:18 -0500117#ifdef MS_WINDOWS
118int isdir(char *path) {
Jason R. Coombs0737b722012-01-13 17:59:05 -0500119 DWORD rv;
120 /* see issue1293 and issue3677:
121 * stat() on Windows doesn't recognise paths like
122 * "e:\\shared\\" and "\\\\whiterab-c2znlh\\shared" as dirs.
123 * Also reference issue6727:
124 * stat() on Windows is broken and doesn't resolve symlinks properly.
125 */
126 rv = GetFileAttributesA(path);
127 return rv != INVALID_FILE_ATTRIBUTES && rv & FILE_ATTRIBUTE_DIRECTORY;
Jason R. Coombsfa93cf82012-01-13 17:37:18 -0500128}
129#else
Jason R. Coombs0e17dfb2012-03-08 09:56:00 -0500130#ifdef HAVE_STAT
Jason R. Coombs925ff742012-01-13 17:12:25 -0500131int isdir(char *path) {
132 struct stat statbuf;
Jason R. Coombs0737b722012-01-13 17:59:05 -0500133 return stat(path, &statbuf) == 0 && S_ISDIR(statbuf.st_mode);
Jason R. Coombs925ff742012-01-13 17:12:25 -0500134}
135#else
Jason R. Coombsfa93cf82012-01-13 17:37:18 -0500136#ifdef RISCOS
Jason R. Coombs925ff742012-01-13 17:12:25 -0500137/* with RISCOS, isdir is in unixstuff */
Jason R. Coombsfa93cf82012-01-13 17:37:18 -0500138#else
Jason R. Coombs925ff742012-01-13 17:12:25 -0500139int isdir(char *path) {
Jason R. Coombs0737b722012-01-13 17:59:05 -0500140 return 0;
Jason R. Coombs925ff742012-01-13 17:12:25 -0500141}
Jason R. Coombsfa93cf82012-01-13 17:37:18 -0500142#endif /* RISCOS */
143#endif /* HAVE_STAT */
144#endif /* MS_WINDOWS */
Phillip J. Ebyf7575d02006-07-28 21:12:07 +0000145
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000146/* Initialize things */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000147
148void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000149_PyImport_Init(void)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000150{
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000151 const struct filedescr *scan;
152 struct filedescr *filetab;
153 int countD = 0;
154 int countS = 0;
Guido van Rossumed1170e1999-12-20 21:23:41 +0000155
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000156 /* prepare _PyImport_Filetab: copy entries from
157 _PyImport_DynLoadFiletab and _PyImport_StandardFiletab.
158 */
Georg Brandladd36e52007-08-23 18:08:06 +0000159#ifdef HAVE_DYNAMIC_LOADING
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000160 for (scan = _PyImport_DynLoadFiletab; scan->suffix != NULL; ++scan)
161 ++countD;
Georg Brandladd36e52007-08-23 18:08:06 +0000162#endif
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000163 for (scan = _PyImport_StandardFiletab; scan->suffix != NULL; ++scan)
164 ++countS;
165 filetab = PyMem_NEW(struct filedescr, countD + countS + 1);
166 if (filetab == NULL)
167 Py_FatalError("Can't initialize import file table.");
Georg Brandladd36e52007-08-23 18:08:06 +0000168#ifdef HAVE_DYNAMIC_LOADING
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000169 memcpy(filetab, _PyImport_DynLoadFiletab,
170 countD * sizeof(struct filedescr));
Georg Brandladd36e52007-08-23 18:08:06 +0000171#endif
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000172 memcpy(filetab + countD, _PyImport_StandardFiletab,
173 countS * sizeof(struct filedescr));
174 filetab[countD + countS].suffix = NULL;
Guido van Rossumed1170e1999-12-20 21:23:41 +0000175
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000176 _PyImport_Filetab = filetab;
Guido van Rossumed1170e1999-12-20 21:23:41 +0000177
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000178 if (Py_OptimizeFlag) {
179 /* Replace ".pyc" with ".pyo" in _PyImport_Filetab */
180 for (; filetab->suffix != NULL; filetab++) {
Guido van Rossum48a680c2001-03-02 06:34:14 +0000181#ifndef RISCOS
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000182 if (strcmp(filetab->suffix, ".pyc") == 0)
183 filetab->suffix = ".pyo";
Guido van Rossum48a680c2001-03-02 06:34:14 +0000184#else
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000185 if (strcmp(filetab->suffix, "/pyc") == 0)
186 filetab->suffix = "/pyo";
Guido van Rossum48a680c2001-03-02 06:34:14 +0000187#endif
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000188 }
189 }
Guido van Rossum96774c12000-05-01 20:19:08 +0000190
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000191 if (Py_UnicodeFlag) {
192 /* Fix the pyc_magic so that byte compiled code created
193 using the all-Unicode method doesn't interfere with
194 code created in normal operation mode. */
195 pyc_magic = MAGIC + 1;
196 }
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000197}
198
Guido van Rossum25ce5661997-08-02 03:10:38 +0000199void
Just van Rossum52e14d62002-12-30 22:08:05 +0000200_PyImportHooks_Init(void)
201{
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000202 PyObject *v, *path_hooks = NULL, *zimpimport;
203 int err = 0;
Just van Rossum52e14d62002-12-30 22:08:05 +0000204
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000205 /* adding sys.path_hooks and sys.path_importer_cache, setting up
206 zipimport */
207 if (PyType_Ready(&PyNullImporter_Type) < 0)
208 goto error;
Just van Rossum52e14d62002-12-30 22:08:05 +0000209
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000210 if (Py_VerboseFlag)
211 PySys_WriteStderr("# installing zipimport hook\n");
Just van Rossum52e14d62002-12-30 22:08:05 +0000212
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000213 v = PyList_New(0);
214 if (v == NULL)
215 goto error;
216 err = PySys_SetObject("meta_path", v);
217 Py_DECREF(v);
218 if (err)
219 goto error;
220 v = PyDict_New();
221 if (v == NULL)
222 goto error;
223 err = PySys_SetObject("path_importer_cache", v);
224 Py_DECREF(v);
225 if (err)
226 goto error;
227 path_hooks = PyList_New(0);
228 if (path_hooks == NULL)
229 goto error;
230 err = PySys_SetObject("path_hooks", path_hooks);
231 if (err) {
Just van Rossum52e14d62002-12-30 22:08:05 +0000232 error:
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000233 PyErr_Print();
234 Py_FatalError("initializing sys.meta_path, sys.path_hooks, "
235 "path_importer_cache, or NullImporter failed"
236 );
237 }
Phillip J. Ebyf7575d02006-07-28 21:12:07 +0000238
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000239 zimpimport = PyImport_ImportModule("zipimport");
240 if (zimpimport == NULL) {
241 PyErr_Clear(); /* No zip import module -- okay */
242 if (Py_VerboseFlag)
243 PySys_WriteStderr("# can't import zipimport\n");
244 }
245 else {
246 PyObject *zipimporter = PyObject_GetAttrString(zimpimport,
247 "zipimporter");
248 Py_DECREF(zimpimport);
249 if (zipimporter == NULL) {
250 PyErr_Clear(); /* No zipimporter object -- okay */
251 if (Py_VerboseFlag)
252 PySys_WriteStderr(
253 "# can't import zipimport.zipimporter\n");
254 }
255 else {
256 /* sys.path_hooks.append(zipimporter) */
257 err = PyList_Append(path_hooks, zipimporter);
258 Py_DECREF(zipimporter);
259 if (err)
260 goto error;
261 if (Py_VerboseFlag)
262 PySys_WriteStderr(
263 "# installed zipimport hook\n");
264 }
265 }
266 Py_DECREF(path_hooks);
Just van Rossum52e14d62002-12-30 22:08:05 +0000267}
268
269void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000270_PyImport_Fini(void)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000271{
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000272 Py_XDECREF(extensions);
273 extensions = NULL;
274 PyMem_DEL(_PyImport_Filetab);
275 _PyImport_Filetab = NULL;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000276}
277
278
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000279/* Locking primitives to prevent parallel imports of the same module
280 in different threads to return with a partially loaded module.
281 These calls are serialized by the global interpreter lock. */
282
283#ifdef WITH_THREAD
284
Guido van Rossum49b56061998-10-01 20:42:43 +0000285#include "pythread.h"
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000286
Guido van Rossum65d5b571998-12-21 19:32:43 +0000287static PyThread_type_lock import_lock = 0;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000288static long import_lock_thread = -1;
289static int import_lock_level = 0;
290
Thomas Woutersc4dcb382009-09-16 19:55:54 +0000291void
292_PyImport_AcquireLock(void)
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000293{
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000294 long me = PyThread_get_thread_ident();
295 if (me == -1)
296 return; /* Too bad */
297 if (import_lock == NULL) {
298 import_lock = PyThread_allocate_lock();
299 if (import_lock == NULL)
300 return; /* Nothing much we can do. */
301 }
302 if (import_lock_thread == me) {
303 import_lock_level++;
304 return;
305 }
306 if (import_lock_thread != -1 || !PyThread_acquire_lock(import_lock, 0))
307 {
308 PyThreadState *tstate = PyEval_SaveThread();
309 PyThread_acquire_lock(import_lock, 1);
310 PyEval_RestoreThread(tstate);
311 }
312 import_lock_thread = me;
313 import_lock_level = 1;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000314}
315
Thomas Woutersc4dcb382009-09-16 19:55:54 +0000316int
317_PyImport_ReleaseLock(void)
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000318{
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000319 long me = PyThread_get_thread_ident();
320 if (me == -1 || import_lock == NULL)
321 return 0; /* Too bad */
322 if (import_lock_thread != me)
323 return -1;
324 import_lock_level--;
325 if (import_lock_level == 0) {
326 import_lock_thread = -1;
327 PyThread_release_lock(import_lock);
328 }
329 return 1;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000330}
331
Gregory P. Smith9e5d1322010-03-01 01:22:39 +0000332/* This function is called from PyOS_AfterFork to ensure that newly
333 created child processes do not share locks with the parent.
334 We now acquire the import lock around fork() calls but on some platforms
335 (Solaris 9 and earlier? see isue7242) that still left us with problems. */
Guido van Rossum8ee3e5a2005-09-14 18:09:42 +0000336
337void
338_PyImport_ReInitLock(void)
339{
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000340 if (import_lock != NULL)
341 import_lock = PyThread_allocate_lock();
342 import_lock_thread = -1;
343 import_lock_level = 0;
Guido van Rossum8ee3e5a2005-09-14 18:09:42 +0000344}
345
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000346#endif
347
Tim Peters69232342001-08-30 05:16:13 +0000348static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000349imp_lock_held(PyObject *self, PyObject *noargs)
Tim Peters69232342001-08-30 05:16:13 +0000350{
Tim Peters69232342001-08-30 05:16:13 +0000351#ifdef WITH_THREAD
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000352 return PyBool_FromLong(import_lock_thread != -1);
Tim Peters69232342001-08-30 05:16:13 +0000353#else
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000354 return PyBool_FromLong(0);
Tim Peters69232342001-08-30 05:16:13 +0000355#endif
356}
357
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000358static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000359imp_acquire_lock(PyObject *self, PyObject *noargs)
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000360{
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000361#ifdef WITH_THREAD
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000362 _PyImport_AcquireLock();
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000363#endif
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000364 Py_INCREF(Py_None);
365 return Py_None;
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000366}
367
368static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000369imp_release_lock(PyObject *self, PyObject *noargs)
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000370{
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000371#ifdef WITH_THREAD
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000372 if (_PyImport_ReleaseLock() < 0) {
373 PyErr_SetString(PyExc_RuntimeError,
374 "not holding the import lock");
375 return NULL;
376 }
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000377#endif
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000378 Py_INCREF(Py_None);
379 return Py_None;
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000380}
381
Collin Winter276887b2007-03-12 16:11:39 +0000382static void
Neal Norwitz75c7c802007-03-13 05:31:38 +0000383imp_modules_reloading_clear(void)
Collin Winter276887b2007-03-12 16:11:39 +0000384{
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000385 PyInterpreterState *interp = PyThreadState_Get()->interp;
386 if (interp->modules_reloading != NULL)
387 PyDict_Clear(interp->modules_reloading);
Collin Winter276887b2007-03-12 16:11:39 +0000388}
389
Guido van Rossum25ce5661997-08-02 03:10:38 +0000390/* Helper for sys */
391
392PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000393PyImport_GetModuleDict(void)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000394{
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000395 PyInterpreterState *interp = PyThreadState_GET()->interp;
396 if (interp->modules == NULL)
397 Py_FatalError("PyImport_GetModuleDict: no module dictionary!");
398 return interp->modules;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000399}
400
Guido van Rossum3f5da241990-12-20 15:06:42 +0000401
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000402/* List of names to clear in sys */
403static char* sys_deletes[] = {
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000404 "path", "argv", "ps1", "ps2", "exitfunc",
405 "exc_type", "exc_value", "exc_traceback",
406 "last_type", "last_value", "last_traceback",
407 "path_hooks", "path_importer_cache", "meta_path",
408 /* misc stuff */
409 "flags", "float_info",
410 NULL
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000411};
412
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000413static char* sys_files[] = {
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000414 "stdin", "__stdin__",
415 "stdout", "__stdout__",
416 "stderr", "__stderr__",
417 NULL
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000418};
419
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000420
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000421/* Un-initialize things, as good as we can */
Guido van Rossum3f5da241990-12-20 15:06:42 +0000422
Guido van Rossum3f5da241990-12-20 15:06:42 +0000423void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000424PyImport_Cleanup(void)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000425{
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000426 Py_ssize_t pos, ndone;
427 char *name;
428 PyObject *key, *value, *dict;
429 PyInterpreterState *interp = PyThreadState_GET()->interp;
430 PyObject *modules = interp->modules;
Guido van Rossum758eec01998-01-19 21:58:26 +0000431
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000432 if (modules == NULL)
433 return; /* Already done */
Guido van Rossum758eec01998-01-19 21:58:26 +0000434
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000435 /* Delete some special variables first. These are common
436 places where user values hide and people complain when their
437 destructors fail. Since the modules containing them are
438 deleted *last* of all, they would come too late in the normal
439 destruction order. Sigh. */
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000440
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000441 value = PyDict_GetItemString(modules, "__builtin__");
442 if (value != NULL && PyModule_Check(value)) {
443 dict = PyModule_GetDict(value);
444 if (Py_VerboseFlag)
445 PySys_WriteStderr("# clear __builtin__._\n");
446 PyDict_SetItemString(dict, "_", Py_None);
447 }
448 value = PyDict_GetItemString(modules, "sys");
449 if (value != NULL && PyModule_Check(value)) {
450 char **p;
451 PyObject *v;
452 dict = PyModule_GetDict(value);
453 for (p = sys_deletes; *p != NULL; p++) {
454 if (Py_VerboseFlag)
455 PySys_WriteStderr("# clear sys.%s\n", *p);
456 PyDict_SetItemString(dict, *p, Py_None);
457 }
458 for (p = sys_files; *p != NULL; p+=2) {
459 if (Py_VerboseFlag)
460 PySys_WriteStderr("# restore sys.%s\n", *p);
461 v = PyDict_GetItemString(dict, *(p+1));
462 if (v == NULL)
463 v = Py_None;
464 PyDict_SetItemString(dict, *p, v);
465 }
466 }
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000467
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000468 /* First, delete __main__ */
469 value = PyDict_GetItemString(modules, "__main__");
470 if (value != NULL && PyModule_Check(value)) {
471 if (Py_VerboseFlag)
472 PySys_WriteStderr("# cleanup __main__\n");
473 _PyModule_Clear(value);
474 PyDict_SetItemString(modules, "__main__", Py_None);
475 }
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000476
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000477 /* The special treatment of __builtin__ here is because even
478 when it's not referenced as a module, its dictionary is
479 referenced by almost every module's __builtins__. Since
480 deleting a module clears its dictionary (even if there are
481 references left to it), we need to delete the __builtin__
482 module last. Likewise, we don't delete sys until the very
483 end because it is implicitly referenced (e.g. by print).
Guido van Rossum758eec01998-01-19 21:58:26 +0000484
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000485 Also note that we 'delete' modules by replacing their entry
486 in the modules dict with None, rather than really deleting
487 them; this avoids a rehash of the modules dictionary and
488 also marks them as "non existent" so they won't be
489 re-imported. */
Guido van Rossum758eec01998-01-19 21:58:26 +0000490
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000491 /* Next, repeatedly delete modules with a reference count of
492 one (skipping __builtin__ and sys) and delete them */
493 do {
494 ndone = 0;
495 pos = 0;
496 while (PyDict_Next(modules, &pos, &key, &value)) {
497 if (value->ob_refcnt != 1)
498 continue;
499 if (PyString_Check(key) && PyModule_Check(value)) {
500 name = PyString_AS_STRING(key);
501 if (strcmp(name, "__builtin__") == 0)
502 continue;
503 if (strcmp(name, "sys") == 0)
504 continue;
505 if (Py_VerboseFlag)
506 PySys_WriteStderr(
507 "# cleanup[1] %s\n", name);
508 _PyModule_Clear(value);
509 PyDict_SetItem(modules, key, Py_None);
510 ndone++;
511 }
512 }
513 } while (ndone > 0);
Guido van Rossum758eec01998-01-19 21:58:26 +0000514
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000515 /* Next, delete all modules (still skipping __builtin__ and sys) */
516 pos = 0;
517 while (PyDict_Next(modules, &pos, &key, &value)) {
518 if (PyString_Check(key) && PyModule_Check(value)) {
519 name = PyString_AS_STRING(key);
520 if (strcmp(name, "__builtin__") == 0)
521 continue;
522 if (strcmp(name, "sys") == 0)
523 continue;
524 if (Py_VerboseFlag)
525 PySys_WriteStderr("# cleanup[2] %s\n", name);
526 _PyModule_Clear(value);
527 PyDict_SetItem(modules, key, Py_None);
528 }
529 }
Guido van Rossum758eec01998-01-19 21:58:26 +0000530
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000531 /* Next, delete sys and __builtin__ (in that order) */
532 value = PyDict_GetItemString(modules, "sys");
533 if (value != NULL && PyModule_Check(value)) {
534 if (Py_VerboseFlag)
535 PySys_WriteStderr("# cleanup sys\n");
536 _PyModule_Clear(value);
537 PyDict_SetItemString(modules, "sys", Py_None);
538 }
539 value = PyDict_GetItemString(modules, "__builtin__");
540 if (value != NULL && PyModule_Check(value)) {
541 if (Py_VerboseFlag)
542 PySys_WriteStderr("# cleanup __builtin__\n");
543 _PyModule_Clear(value);
544 PyDict_SetItemString(modules, "__builtin__", Py_None);
545 }
Guido van Rossum758eec01998-01-19 21:58:26 +0000546
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000547 /* Finally, clear and delete the modules directory */
548 PyDict_Clear(modules);
549 interp->modules = NULL;
550 Py_DECREF(modules);
551 Py_CLEAR(interp->modules_reloading);
Guido van Rossum8d15b5d1990-10-26 14:58:58 +0000552}
Guido van Rossum7f133ed1991-02-19 12:23:57 +0000553
554
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000555/* Helper for pythonrun.c -- return magic number */
556
557long
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000558PyImport_GetMagicNumber(void)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000559{
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000560 return pyc_magic;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000561}
562
563
Guido van Rossum25ce5661997-08-02 03:10:38 +0000564/* Magic for extension modules (built-in as well as dynamically
565 loaded). To prevent initializing an extension module more than
566 once, we keep a static dictionary 'extensions' keyed by module name
567 (for built-in modules) or by filename (for dynamically loaded
Barry Warsaw92883382001-08-13 23:05:44 +0000568 modules), containing these modules. A copy of the module's
Guido van Rossum25ce5661997-08-02 03:10:38 +0000569 dictionary is stored by calling _PyImport_FixupExtension()
570 immediately after the module initialization function succeeds. A
571 copy can be retrieved from there by calling
572 _PyImport_FindExtension(). */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000573
Guido van Rossum79f25d91997-04-29 20:08:16 +0000574PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000575_PyImport_FixupExtension(char *name, char *filename)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000576{
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000577 PyObject *modules, *mod, *dict, *copy;
578 if (extensions == NULL) {
579 extensions = PyDict_New();
580 if (extensions == NULL)
581 return NULL;
582 }
583 modules = PyImport_GetModuleDict();
584 mod = PyDict_GetItemString(modules, name);
585 if (mod == NULL || !PyModule_Check(mod)) {
586 PyErr_Format(PyExc_SystemError,
587 "_PyImport_FixupExtension: module %.200s not loaded", name);
588 return NULL;
589 }
590 dict = PyModule_GetDict(mod);
591 if (dict == NULL)
592 return NULL;
593 copy = PyDict_Copy(dict);
594 if (copy == NULL)
595 return NULL;
596 PyDict_SetItemString(extensions, filename, copy);
597 Py_DECREF(copy);
598 return copy;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000599}
600
601PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000602_PyImport_FindExtension(char *name, char *filename)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000603{
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000604 PyObject *dict, *mod, *mdict;
605 if (extensions == NULL)
606 return NULL;
607 dict = PyDict_GetItemString(extensions, filename);
608 if (dict == NULL)
609 return NULL;
610 mod = PyImport_AddModule(name);
611 if (mod == NULL)
612 return NULL;
613 mdict = PyModule_GetDict(mod);
614 if (mdict == NULL)
615 return NULL;
616 if (PyDict_Update(mdict, dict))
617 return NULL;
618 if (Py_VerboseFlag)
619 PySys_WriteStderr("import %s # previously loaded (%s)\n",
620 name, filename);
621 return mod;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000622}
623
624
625/* Get the module object corresponding to a module name.
626 First check the modules dictionary if there's one there,
Walter Dörwaldf0dfc7a2003-10-20 14:01:56 +0000627 if not, create a new one and insert it in the modules dictionary.
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000628 Because the former action is most common, THIS DOES NOT RETURN A
629 'NEW' REFERENCE! */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000630
Guido van Rossum79f25d91997-04-29 20:08:16 +0000631PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000632PyImport_AddModule(const char *name)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000633{
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000634 PyObject *modules = PyImport_GetModuleDict();
635 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000636
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000637 if ((m = PyDict_GetItemString(modules, name)) != NULL &&
638 PyModule_Check(m))
639 return m;
640 m = PyModule_New(name);
641 if (m == NULL)
642 return NULL;
643 if (PyDict_SetItemString(modules, name, m) != 0) {
644 Py_DECREF(m);
645 return NULL;
646 }
647 Py_DECREF(m); /* Yes, it still exists, in modules! */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000648
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000649 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000650}
651
Tim Peters1cd70172004-08-02 03:52:12 +0000652/* Remove name from sys.modules, if it's there. */
653static void
Benjamin Peterson06638732010-03-25 23:27:16 +0000654remove_module(const char *name)
Tim Peters1cd70172004-08-02 03:52:12 +0000655{
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000656 PyObject *modules = PyImport_GetModuleDict();
657 if (PyDict_GetItemString(modules, name) == NULL)
658 return;
659 if (PyDict_DelItemString(modules, name) < 0)
660 Py_FatalError("import: deleting existing key in"
661 "sys.modules failed");
Tim Peters1cd70172004-08-02 03:52:12 +0000662}
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000663
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000664/* Execute a code object in a module and return the module object
Tim Peters1cd70172004-08-02 03:52:12 +0000665 * WITH INCREMENTED REFERENCE COUNT. If an error occurs, name is
666 * removed from sys.modules, to avoid leaving damaged module objects
667 * in sys.modules. The caller may wish to restore the original
668 * module object (if any) in this case; PyImport_ReloadModule is an
669 * example.
670 */
Guido van Rossum79f25d91997-04-29 20:08:16 +0000671PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000672PyImport_ExecCodeModule(char *name, PyObject *co)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000673{
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000674 return PyImport_ExecCodeModuleEx(name, co, (char *)NULL);
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000675}
676
677PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000678PyImport_ExecCodeModuleEx(char *name, PyObject *co, char *pathname)
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000679{
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000680 PyObject *modules = PyImport_GetModuleDict();
681 PyObject *m, *d, *v;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000682
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000683 m = PyImport_AddModule(name);
684 if (m == NULL)
685 return NULL;
686 /* If the module is being reloaded, we get the old module back
687 and re-use its dict to exec the new code. */
688 d = PyModule_GetDict(m);
689 if (PyDict_GetItemString(d, "__builtins__") == NULL) {
690 if (PyDict_SetItemString(d, "__builtins__",
691 PyEval_GetBuiltins()) != 0)
692 goto error;
693 }
694 /* Remember the filename as the __file__ attribute */
695 v = NULL;
696 if (pathname != NULL) {
697 v = PyString_FromString(pathname);
698 if (v == NULL)
699 PyErr_Clear();
700 }
701 if (v == NULL) {
702 v = ((PyCodeObject *)co)->co_filename;
703 Py_INCREF(v);
704 }
705 if (PyDict_SetItemString(d, "__file__", v) != 0)
706 PyErr_Clear(); /* Not important enough to report */
707 Py_DECREF(v);
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000708
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000709 v = PyEval_EvalCode((PyCodeObject *)co, d, d);
710 if (v == NULL)
711 goto error;
712 Py_DECREF(v);
Guido van Rossumb65e85c1997-07-10 18:00:45 +0000713
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000714 if ((m = PyDict_GetItemString(modules, name)) == NULL) {
715 PyErr_Format(PyExc_ImportError,
716 "Loaded module %.200s not found in sys.modules",
717 name);
718 return NULL;
719 }
Guido van Rossumb65e85c1997-07-10 18:00:45 +0000720
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000721 Py_INCREF(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000722
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000723 return m;
Tim Peters1cd70172004-08-02 03:52:12 +0000724
725 error:
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000726 remove_module(name);
727 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000728}
729
730
731/* Given a pathname for a Python source file, fill a buffer with the
732 pathname for the corresponding compiled file. Return the pathname
733 for the compiled file, or NULL if there's no space in the buffer.
734 Doesn't set an exception. */
735
736static char *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000737make_compiled_pathname(char *pathname, char *buf, size_t buflen)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000738{
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000739 size_t len = strlen(pathname);
740 if (len+2 > buflen)
741 return NULL;
Tim Petersc1731372001-08-04 08:12:36 +0000742
Martin v. Löwis6238d2b2002-06-30 15:26:10 +0000743#ifdef MS_WINDOWS
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000744 /* Treat .pyw as if it were .py. The case of ".pyw" must match
745 that used in _PyImport_StandardFiletab. */
746 if (len >= 4 && strcmp(&pathname[len-4], ".pyw") == 0)
747 --len; /* pretend 'w' isn't there */
Tim Petersc1731372001-08-04 08:12:36 +0000748#endif
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000749 memcpy(buf, pathname, len);
750 buf[len] = Py_OptimizeFlag ? 'o' : 'c';
751 buf[len+1] = '\0';
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000752
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000753 return buf;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000754}
755
756
757/* Given a pathname for a Python source file, its time of last
758 modification, and a pathname for a compiled file, check whether the
759 compiled file represents the same version of the source. If so,
760 return a FILE pointer for the compiled file, positioned just after
761 the header; if not, return NULL.
762 Doesn't set an exception. */
763
764static FILE *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000765check_compiled_module(char *pathname, time_t mtime, char *cpathname)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000766{
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000767 FILE *fp;
768 long magic;
769 long pyc_mtime;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000770
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000771 fp = fopen(cpathname, "rb");
772 if (fp == NULL)
773 return NULL;
774 magic = PyMarshal_ReadLongFromFile(fp);
775 if (magic != pyc_magic) {
776 if (Py_VerboseFlag)
777 PySys_WriteStderr("# %s has bad magic\n", cpathname);
778 fclose(fp);
779 return NULL;
780 }
781 pyc_mtime = PyMarshal_ReadLongFromFile(fp);
782 if (pyc_mtime != mtime) {
783 if (Py_VerboseFlag)
784 PySys_WriteStderr("# %s has bad mtime\n", cpathname);
785 fclose(fp);
786 return NULL;
787 }
788 if (Py_VerboseFlag)
789 PySys_WriteStderr("# %s matches %s\n", cpathname, pathname);
790 return fp;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000791}
792
793
794/* Read a code object from a file and check it for validity */
795
Guido van Rossum79f25d91997-04-29 20:08:16 +0000796static PyCodeObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000797read_compiled_module(char *cpathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000798{
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000799 PyObject *co;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000800
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000801 co = PyMarshal_ReadLastObjectFromFile(fp);
802 if (co == NULL)
803 return NULL;
804 if (!PyCode_Check(co)) {
805 PyErr_Format(PyExc_ImportError,
806 "Non-code object in %.200s", cpathname);
807 Py_DECREF(co);
808 return NULL;
809 }
810 return (PyCodeObject *)co;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000811}
812
813
814/* Load a module from a compiled file, execute it, and return its
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000815 module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000816
Guido van Rossum79f25d91997-04-29 20:08:16 +0000817static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000818load_compiled_module(char *name, char *cpathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000819{
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000820 long magic;
821 PyCodeObject *co;
822 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000823
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000824 magic = PyMarshal_ReadLongFromFile(fp);
825 if (magic != pyc_magic) {
826 PyErr_Format(PyExc_ImportError,
827 "Bad magic number in %.200s", cpathname);
828 return NULL;
829 }
830 (void) PyMarshal_ReadLongFromFile(fp);
831 co = read_compiled_module(cpathname, fp);
832 if (co == NULL)
833 return NULL;
834 if (Py_VerboseFlag)
835 PySys_WriteStderr("import %s # precompiled from %s\n",
836 name, cpathname);
837 m = PyImport_ExecCodeModuleEx(name, (PyObject *)co, cpathname);
838 Py_DECREF(co);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000839
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000840 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000841}
842
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000843/* Parse a source file and return the corresponding code object */
844
Guido van Rossum79f25d91997-04-29 20:08:16 +0000845static PyCodeObject *
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000846parse_source_module(const char *pathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000847{
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000848 PyCodeObject *co = NULL;
849 mod_ty mod;
850 PyCompilerFlags flags;
851 PyArena *arena = PyArena_New();
852 if (arena == NULL)
853 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000854
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000855 flags.cf_flags = 0;
Christian Heimes7f23d862008-03-26 22:51:58 +0000856
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000857 mod = PyParser_ASTFromFile(fp, pathname, Py_file_input, 0, 0, &flags,
858 NULL, arena);
859 if (mod) {
860 co = PyAST_Compile(mod, pathname, NULL, arena);
861 }
862 PyArena_Free(arena);
863 return co;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000864}
865
866
Guido van Rossum55a83382000-09-20 20:31:38 +0000867/* Helper to open a bytecode file for writing in exclusive mode */
868
869static FILE *
Christian Heimes40346852008-02-23 17:52:07 +0000870open_exclusive(char *filename, mode_t mode)
Guido van Rossum55a83382000-09-20 20:31:38 +0000871{
872#if defined(O_EXCL)&&defined(O_CREAT)&&defined(O_WRONLY)&&defined(O_TRUNC)
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000873 /* Use O_EXCL to avoid a race condition when another process tries to
874 write the same file. When that happens, our open() call fails,
875 which is just fine (since it's only a cache).
876 XXX If the file exists and is writable but the directory is not
877 writable, the file will never be written. Oh well.
878 */
879 int fd;
880 (void) unlink(filename);
881 fd = open(filename, O_EXCL|O_CREAT|O_WRONLY|O_TRUNC
Tim Peters42c83af2000-09-29 04:03:10 +0000882#ifdef O_BINARY
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000883 |O_BINARY /* necessary for Windows */
Tim Peters42c83af2000-09-29 04:03:10 +0000884#endif
Martin v. Löwis79acb9e2002-12-06 12:48:53 +0000885#ifdef __VMS
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000886 , mode, "ctxt=bin", "shr=nil"
Martin v. Löwis79acb9e2002-12-06 12:48:53 +0000887#else
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000888 , mode
Martin v. Löwis79acb9e2002-12-06 12:48:53 +0000889#endif
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000890 );
891 if (fd < 0)
892 return NULL;
893 return fdopen(fd, "wb");
Guido van Rossum55a83382000-09-20 20:31:38 +0000894#else
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000895 /* Best we can do -- on Windows this can't happen anyway */
896 return fopen(filename, "wb");
Guido van Rossum55a83382000-09-20 20:31:38 +0000897#endif
898}
899
900
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000901/* Write a compiled module to a file, placing the time of last
902 modification of its source into the header.
903 Errors are ignored, if a write error occurs an attempt is made to
904 remove the file. */
905
906static void
Christian Heimes40346852008-02-23 17:52:07 +0000907write_compiled_module(PyCodeObject *co, char *cpathname, struct stat *srcstat)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000908{
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000909 FILE *fp;
910 time_t mtime = srcstat->st_mtime;
R. David Murray3310a102009-07-07 09:54:16 +0000911#ifdef MS_WINDOWS /* since Windows uses different permissions */
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000912 mode_t mode = srcstat->st_mode & ~S_IEXEC;
R. David Murray3310a102009-07-07 09:54:16 +0000913#else
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000914 mode_t mode = srcstat->st_mode & ~S_IXUSR & ~S_IXGRP & ~S_IXOTH;
Brett Cannonb166afc2010-05-05 20:25:47 +0000915#endif
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000916
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000917 fp = open_exclusive(cpathname, mode);
918 if (fp == NULL) {
919 if (Py_VerboseFlag)
920 PySys_WriteStderr(
921 "# can't create %s\n", cpathname);
922 return;
923 }
924 PyMarshal_WriteLongToFile(pyc_magic, fp, Py_MARSHAL_VERSION);
925 /* First write a 0 for mtime */
926 PyMarshal_WriteLongToFile(0L, fp, Py_MARSHAL_VERSION);
927 PyMarshal_WriteObjectToFile((PyObject *)co, fp, Py_MARSHAL_VERSION);
928 if (fflush(fp) != 0 || ferror(fp)) {
929 if (Py_VerboseFlag)
930 PySys_WriteStderr("# can't write %s\n", cpathname);
931 /* Don't keep partial file */
932 fclose(fp);
933 (void) unlink(cpathname);
934 return;
935 }
Antoine Pitrou6f25d752012-01-25 15:38:32 +0100936 /* Now write the true mtime (as a 32-bit field) */
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000937 fseek(fp, 4L, 0);
Antoine Pitrou6f25d752012-01-25 15:38:32 +0100938 assert(mtime <= 0xFFFFFFFF);
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000939 PyMarshal_WriteLongToFile((long)mtime, fp, Py_MARSHAL_VERSION);
940 fflush(fp);
941 fclose(fp);
942 if (Py_VerboseFlag)
943 PySys_WriteStderr("# wrote %s\n", cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000944}
945
Antoine Pitroue96d4ea2009-01-06 18:10:47 +0000946static void
947update_code_filenames(PyCodeObject *co, PyObject *oldname, PyObject *newname)
948{
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000949 PyObject *constants, *tmp;
950 Py_ssize_t i, n;
Antoine Pitroue96d4ea2009-01-06 18:10:47 +0000951
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000952 if (!_PyString_Eq(co->co_filename, oldname))
953 return;
Antoine Pitroue96d4ea2009-01-06 18:10:47 +0000954
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000955 tmp = co->co_filename;
956 co->co_filename = newname;
957 Py_INCREF(co->co_filename);
958 Py_DECREF(tmp);
Antoine Pitroue96d4ea2009-01-06 18:10:47 +0000959
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000960 constants = co->co_consts;
961 n = PyTuple_GET_SIZE(constants);
962 for (i = 0; i < n; i++) {
963 tmp = PyTuple_GET_ITEM(constants, i);
964 if (PyCode_Check(tmp))
965 update_code_filenames((PyCodeObject *)tmp,
966 oldname, newname);
967 }
Antoine Pitroue96d4ea2009-01-06 18:10:47 +0000968}
969
970static int
971update_compiled_module(PyCodeObject *co, char *pathname)
972{
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000973 PyObject *oldname, *newname;
Antoine Pitroue96d4ea2009-01-06 18:10:47 +0000974
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000975 if (strcmp(PyString_AsString(co->co_filename), pathname) == 0)
976 return 0;
Antoine Pitroue96d4ea2009-01-06 18:10:47 +0000977
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000978 newname = PyString_FromString(pathname);
979 if (newname == NULL)
980 return -1;
Antoine Pitroue96d4ea2009-01-06 18:10:47 +0000981
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000982 oldname = co->co_filename;
983 Py_INCREF(oldname);
984 update_code_filenames(co, oldname, newname);
985 Py_DECREF(oldname);
986 Py_DECREF(newname);
987 return 1;
Antoine Pitroue96d4ea2009-01-06 18:10:47 +0000988}
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000989
990/* Load a source module from a given file and return its module
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000991 object WITH INCREMENTED REFERENCE COUNT. If there's a matching
992 byte-compiled file, use that instead. */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000993
Guido van Rossum79f25d91997-04-29 20:08:16 +0000994static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000995load_source_module(char *name, char *pathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000996{
Antoine Pitrouc83ea132010-05-09 14:46:46 +0000997 struct stat st;
998 FILE *fpc;
999 char buf[MAXPATHLEN+1];
1000 char *cpathname;
1001 PyCodeObject *co;
1002 PyObject *m;
Brett Cannonb166afc2010-05-05 20:25:47 +00001003
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001004 if (fstat(fileno(fp), &st) != 0) {
1005 PyErr_Format(PyExc_RuntimeError,
1006 "unable to get file status from '%s'",
1007 pathname);
1008 return NULL;
1009 }
Antoine Pitrou0e5fd592012-01-25 03:31:39 +01001010 if (sizeof st.st_mtime > 4) {
1011 /* Python's .pyc timestamp handling presumes that the timestamp fits
1012 in 4 bytes. Since the code only does an equality comparison,
1013 ordering is not important and we can safely ignore the higher bits
1014 (collisions are extremely unlikely).
1015 */
1016 st.st_mtime &= 0xFFFFFFFF;
1017 }
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001018 cpathname = make_compiled_pathname(pathname, buf,
1019 (size_t)MAXPATHLEN + 1);
1020 if (cpathname != NULL &&
1021 (fpc = check_compiled_module(pathname, st.st_mtime, cpathname))) {
1022 co = read_compiled_module(cpathname, fpc);
1023 fclose(fpc);
1024 if (co == NULL)
1025 return NULL;
1026 if (update_compiled_module(co, pathname) < 0)
1027 return NULL;
1028 if (Py_VerboseFlag)
1029 PySys_WriteStderr("import %s # precompiled from %s\n",
1030 name, cpathname);
1031 pathname = cpathname;
1032 }
1033 else {
1034 co = parse_source_module(pathname, fp);
1035 if (co == NULL)
1036 return NULL;
1037 if (Py_VerboseFlag)
1038 PySys_WriteStderr("import %s # from %s\n",
1039 name, pathname);
1040 if (cpathname) {
1041 PyObject *ro = PySys_GetObject("dont_write_bytecode");
1042 if (ro == NULL || !PyObject_IsTrue(ro))
1043 write_compiled_module(co, cpathname, &st);
1044 }
1045 }
1046 m = PyImport_ExecCodeModuleEx(name, (PyObject *)co, pathname);
1047 Py_DECREF(co);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001048
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001049 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001050}
1051
1052
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001053/* Forward */
Just van Rossum52e14d62002-12-30 22:08:05 +00001054static PyObject *load_module(char *, FILE *, char *, int, PyObject *);
1055static struct filedescr *find_module(char *, char *, PyObject *,
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001056 char *, size_t, FILE **, PyObject **);
Tim Petersdbd9ba62000-07-09 03:09:57 +00001057static struct _frozen *find_frozen(char *name);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001058
1059/* Load a package and return its module object WITH INCREMENTED
1060 REFERENCE COUNT */
1061
1062static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001063load_package(char *name, char *pathname)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001064{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001065 PyObject *m, *d;
1066 PyObject *file = NULL;
1067 PyObject *path = NULL;
1068 int err;
1069 char buf[MAXPATHLEN+1];
1070 FILE *fp = NULL;
1071 struct filedescr *fdp;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001072
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001073 m = PyImport_AddModule(name);
1074 if (m == NULL)
1075 return NULL;
1076 if (Py_VerboseFlag)
1077 PySys_WriteStderr("import %s # directory %s\n",
1078 name, pathname);
1079 d = PyModule_GetDict(m);
1080 file = PyString_FromString(pathname);
1081 if (file == NULL)
1082 goto error;
1083 path = Py_BuildValue("[O]", file);
1084 if (path == NULL)
1085 goto error;
1086 err = PyDict_SetItemString(d, "__file__", file);
1087 if (err == 0)
1088 err = PyDict_SetItemString(d, "__path__", path);
1089 if (err != 0)
1090 goto error;
1091 buf[0] = '\0';
1092 fdp = find_module(name, "__init__", path, buf, sizeof(buf), &fp, NULL);
1093 if (fdp == NULL) {
1094 if (PyErr_ExceptionMatches(PyExc_ImportError)) {
1095 PyErr_Clear();
1096 Py_INCREF(m);
1097 }
1098 else
1099 m = NULL;
1100 goto cleanup;
1101 }
1102 m = load_module(name, fp, buf, fdp->type, NULL);
1103 if (fp != NULL)
1104 fclose(fp);
1105 goto cleanup;
Tim Peters1cd70172004-08-02 03:52:12 +00001106
1107 error:
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001108 m = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001109 cleanup:
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001110 Py_XDECREF(path);
1111 Py_XDECREF(file);
1112 return m;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001113}
1114
1115
1116/* Helper to test for built-in module */
1117
1118static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001119is_builtin(char *name)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001120{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001121 int i;
1122 for (i = 0; PyImport_Inittab[i].name != NULL; i++) {
1123 if (strcmp(name, PyImport_Inittab[i].name) == 0) {
1124 if (PyImport_Inittab[i].initfunc == NULL)
1125 return -1;
1126 else
1127 return 1;
1128 }
1129 }
1130 return 0;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001131}
1132
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001133
Just van Rossum52e14d62002-12-30 22:08:05 +00001134/* Return an importer object for a sys.path/pkg.__path__ item 'p',
1135 possibly by fetching it from the path_importer_cache dict. If it
Brett Cannon94b69f62006-09-28 22:10:14 +00001136 wasn't yet cached, traverse path_hooks until a hook is found
Just van Rossum52e14d62002-12-30 22:08:05 +00001137 that can handle the path item. Return None if no hook could;
1138 this tells our caller it should fall back to the builtin
1139 import mechanism. Cache the result in path_importer_cache.
1140 Returns a borrowed reference. */
1141
1142static PyObject *
1143get_path_importer(PyObject *path_importer_cache, PyObject *path_hooks,
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001144 PyObject *p)
Just van Rossum52e14d62002-12-30 22:08:05 +00001145{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001146 PyObject *importer;
1147 Py_ssize_t j, nhooks;
Just van Rossum52e14d62002-12-30 22:08:05 +00001148
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001149 /* These conditions are the caller's responsibility: */
1150 assert(PyList_Check(path_hooks));
1151 assert(PyDict_Check(path_importer_cache));
Just van Rossum52e14d62002-12-30 22:08:05 +00001152
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001153 nhooks = PyList_Size(path_hooks);
1154 if (nhooks < 0)
1155 return NULL; /* Shouldn't happen */
Just van Rossum52e14d62002-12-30 22:08:05 +00001156
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001157 importer = PyDict_GetItem(path_importer_cache, p);
1158 if (importer != NULL)
1159 return importer;
Just van Rossum52e14d62002-12-30 22:08:05 +00001160
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001161 /* set path_importer_cache[p] to None to avoid recursion */
1162 if (PyDict_SetItem(path_importer_cache, p, Py_None) != 0)
1163 return NULL;
Just van Rossum52e14d62002-12-30 22:08:05 +00001164
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001165 for (j = 0; j < nhooks; j++) {
1166 PyObject *hook = PyList_GetItem(path_hooks, j);
1167 if (hook == NULL)
1168 return NULL;
1169 importer = PyObject_CallFunctionObjArgs(hook, p, NULL);
1170 if (importer != NULL)
1171 break;
Just van Rossum52e14d62002-12-30 22:08:05 +00001172
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001173 if (!PyErr_ExceptionMatches(PyExc_ImportError)) {
1174 return NULL;
1175 }
1176 PyErr_Clear();
1177 }
1178 if (importer == NULL) {
1179 importer = PyObject_CallFunctionObjArgs(
1180 (PyObject *)&PyNullImporter_Type, p, NULL
1181 );
1182 if (importer == NULL) {
1183 if (PyErr_ExceptionMatches(PyExc_ImportError)) {
1184 PyErr_Clear();
1185 return Py_None;
1186 }
1187 }
1188 }
1189 if (importer != NULL) {
1190 int err = PyDict_SetItem(path_importer_cache, p, importer);
1191 Py_DECREF(importer);
1192 if (err != 0)
1193 return NULL;
1194 }
1195 return importer;
Just van Rossum52e14d62002-12-30 22:08:05 +00001196}
1197
Nick Coghlan327a39b2007-11-18 11:56:28 +00001198PyAPI_FUNC(PyObject *)
1199PyImport_GetImporter(PyObject *path) {
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001200 PyObject *importer=NULL, *path_importer_cache=NULL, *path_hooks=NULL;
Nick Coghlan327a39b2007-11-18 11:56:28 +00001201
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001202 if ((path_importer_cache = PySys_GetObject("path_importer_cache"))) {
1203 if ((path_hooks = PySys_GetObject("path_hooks"))) {
1204 importer = get_path_importer(path_importer_cache,
1205 path_hooks, path);
1206 }
1207 }
1208 Py_XINCREF(importer); /* get_path_importer returns a borrowed reference */
1209 return importer;
Nick Coghlan327a39b2007-11-18 11:56:28 +00001210}
1211
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001212/* Search the path (default sys.path) for a module. Return the
1213 corresponding filedescr struct, and (via return arguments) the
1214 pathname and an open file. Return NULL if the module is not found. */
1215
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001216#ifdef MS_COREDLL
Thomas Woutersb4bd21c2000-07-22 23:38:01 +00001217extern FILE *PyWin_FindRegisteredModule(const char *, struct filedescr **,
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001218 char *, Py_ssize_t);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001219#endif
1220
Martin v. Löwis18e16552006-02-15 17:27:45 +00001221static int case_ok(char *, Py_ssize_t, Py_ssize_t, char *);
Tim Petersdbd9ba62000-07-09 03:09:57 +00001222static int find_init_module(char *); /* Forward */
Just van Rossum52e14d62002-12-30 22:08:05 +00001223static struct filedescr importhookdescr = {"", "", IMP_HOOK};
Guido van Rossum197346f1997-10-31 18:38:52 +00001224
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001225static struct filedescr *
Just van Rossum52e14d62002-12-30 22:08:05 +00001226find_module(char *fullname, char *subname, PyObject *path, char *buf,
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001227 size_t buflen, FILE **p_fp, PyObject **p_loader)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001228{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001229 Py_ssize_t i, npath;
1230 size_t len, namelen;
1231 struct filedescr *fdp = NULL;
1232 char *filemode;
1233 FILE *fp = NULL;
1234 PyObject *path_hooks, *path_importer_cache;
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001235 static struct filedescr fd_frozen = {"", "", PY_FROZEN};
1236 static struct filedescr fd_builtin = {"", "", C_BUILTIN};
1237 static struct filedescr fd_package = {"", "", PKG_DIRECTORY};
1238 char name[MAXPATHLEN+1];
Andrew MacIntyred9400542002-02-26 11:41:34 +00001239#if defined(PYOS_OS2)
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001240 size_t saved_len;
1241 size_t saved_namelen;
1242 char *saved_buf = NULL;
Andrew MacIntyred9400542002-02-26 11:41:34 +00001243#endif
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001244 if (p_loader != NULL)
1245 *p_loader = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001246
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001247 if (strlen(subname) > MAXPATHLEN) {
1248 PyErr_SetString(PyExc_OverflowError,
1249 "module name is too long");
1250 return NULL;
1251 }
1252 strcpy(name, subname);
Just van Rossum52e14d62002-12-30 22:08:05 +00001253
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001254 /* sys.meta_path import hook */
1255 if (p_loader != NULL) {
1256 PyObject *meta_path;
Just van Rossum52e14d62002-12-30 22:08:05 +00001257
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001258 meta_path = PySys_GetObject("meta_path");
1259 if (meta_path == NULL || !PyList_Check(meta_path)) {
Victor Stinnered36c062011-09-15 19:45:53 +02001260 PyErr_SetString(PyExc_RuntimeError,
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001261 "sys.meta_path must be a list of "
1262 "import hooks");
1263 return NULL;
1264 }
1265 Py_INCREF(meta_path); /* zap guard */
1266 npath = PyList_Size(meta_path);
1267 for (i = 0; i < npath; i++) {
1268 PyObject *loader;
1269 PyObject *hook = PyList_GetItem(meta_path, i);
1270 loader = PyObject_CallMethod(hook, "find_module",
1271 "sO", fullname,
1272 path != NULL ?
1273 path : Py_None);
1274 if (loader == NULL) {
1275 Py_DECREF(meta_path);
1276 return NULL; /* true error */
1277 }
1278 if (loader != Py_None) {
1279 /* a loader was found */
1280 *p_loader = loader;
1281 Py_DECREF(meta_path);
1282 return &importhookdescr;
1283 }
1284 Py_DECREF(loader);
1285 }
1286 Py_DECREF(meta_path);
1287 }
Guido van Rossum0506a431998-08-11 15:07:39 +00001288
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001289 if (path != NULL && PyString_Check(path)) {
1290 /* The only type of submodule allowed inside a "frozen"
1291 package are other frozen modules or packages. */
1292 if (PyString_Size(path) + 1 + strlen(name) >= (size_t)buflen) {
1293 PyErr_SetString(PyExc_ImportError,
1294 "full frozen module name too long");
1295 return NULL;
1296 }
1297 strcpy(buf, PyString_AsString(path));
1298 strcat(buf, ".");
1299 strcat(buf, name);
1300 strcpy(name, buf);
1301 if (find_frozen(name) != NULL) {
1302 strcpy(buf, name);
1303 return &fd_frozen;
1304 }
1305 PyErr_Format(PyExc_ImportError,
1306 "No frozen submodule named %.200s", name);
1307 return NULL;
1308 }
1309 if (path == NULL) {
1310 if (is_builtin(name)) {
1311 strcpy(buf, name);
1312 return &fd_builtin;
1313 }
1314 if ((find_frozen(name)) != NULL) {
1315 strcpy(buf, name);
1316 return &fd_frozen;
1317 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001318
Guido van Rossumac279101996-08-22 23:10:58 +00001319#ifdef MS_COREDLL
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001320 fp = PyWin_FindRegisteredModule(name, &fdp, buf, buflen);
1321 if (fp != NULL) {
1322 *p_fp = fp;
1323 return fdp;
1324 }
Guido van Rossuma5a3db71996-04-09 02:39:59 +00001325#endif
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001326 path = PySys_GetObject("path");
1327 }
1328 if (path == NULL || !PyList_Check(path)) {
Victor Stinnered36c062011-09-15 19:45:53 +02001329 PyErr_SetString(PyExc_RuntimeError,
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001330 "sys.path must be a list of directory names");
1331 return NULL;
1332 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001333
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001334 path_hooks = PySys_GetObject("path_hooks");
1335 if (path_hooks == NULL || !PyList_Check(path_hooks)) {
Victor Stinnered36c062011-09-15 19:45:53 +02001336 PyErr_SetString(PyExc_RuntimeError,
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001337 "sys.path_hooks must be a list of "
1338 "import hooks");
1339 return NULL;
1340 }
1341 path_importer_cache = PySys_GetObject("path_importer_cache");
1342 if (path_importer_cache == NULL ||
1343 !PyDict_Check(path_importer_cache)) {
Victor Stinnered36c062011-09-15 19:45:53 +02001344 PyErr_SetString(PyExc_RuntimeError,
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001345 "sys.path_importer_cache must be a dict");
1346 return NULL;
1347 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001348
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001349 npath = PyList_Size(path);
1350 namelen = strlen(name);
1351 for (i = 0; i < npath; i++) {
1352 PyObject *copy = NULL;
1353 PyObject *v = PyList_GetItem(path, i);
1354 if (!v)
1355 return NULL;
Walter Dörwald3430d702002-06-17 10:43:59 +00001356#ifdef Py_USING_UNICODE
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001357 if (PyUnicode_Check(v)) {
1358 copy = PyUnicode_Encode(PyUnicode_AS_UNICODE(v),
1359 PyUnicode_GET_SIZE(v), Py_FileSystemDefaultEncoding, NULL);
1360 if (copy == NULL)
1361 return NULL;
1362 v = copy;
1363 }
1364 else
Walter Dörwald3430d702002-06-17 10:43:59 +00001365#endif
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001366 if (!PyString_Check(v))
1367 continue;
1368 len = PyString_GET_SIZE(v);
1369 if (len + 2 + namelen + MAXSUFFIXSIZE >= buflen) {
1370 Py_XDECREF(copy);
1371 continue; /* Too long */
1372 }
1373 strcpy(buf, PyString_AS_STRING(v));
1374 if (strlen(buf) != len) {
1375 Py_XDECREF(copy);
1376 continue; /* v contains '\0' */
1377 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001378
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001379 /* sys.path_hooks import hook */
1380 if (p_loader != NULL) {
1381 PyObject *importer;
Just van Rossum52e14d62002-12-30 22:08:05 +00001382
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001383 importer = get_path_importer(path_importer_cache,
1384 path_hooks, v);
1385 if (importer == NULL) {
1386 Py_XDECREF(copy);
1387 return NULL;
1388 }
1389 /* Note: importer is a borrowed reference */
1390 if (importer != Py_None) {
1391 PyObject *loader;
1392 loader = PyObject_CallMethod(importer,
1393 "find_module",
1394 "s", fullname);
1395 Py_XDECREF(copy);
1396 if (loader == NULL)
1397 return NULL; /* error */
1398 if (loader != Py_None) {
1399 /* a loader was found */
1400 *p_loader = loader;
1401 return &importhookdescr;
1402 }
1403 Py_DECREF(loader);
1404 continue;
1405 }
1406 }
1407 /* no hook was found, use builtin import */
Just van Rossum52e14d62002-12-30 22:08:05 +00001408
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001409 if (len > 0 && buf[len-1] != SEP
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001410#ifdef ALTSEP
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001411 && buf[len-1] != ALTSEP
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001412#endif
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001413 )
1414 buf[len++] = SEP;
1415 strcpy(buf+len, name);
1416 len += namelen;
Tim Peters50d8d372001-02-28 05:34:27 +00001417
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001418 /* Check for package import (buf holds a directory name,
1419 and there's an __init__ module in that directory */
Jason R. Coombs925ff742012-01-13 17:12:25 -05001420 if (isdir(buf) && /* it's an existing directory */
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001421 case_ok(buf, len, namelen, name)) { /* case matches */
1422 if (find_init_module(buf)) { /* and has __init__.py */
1423 Py_XDECREF(copy);
1424 return &fd_package;
1425 }
1426 else {
1427 char warnstr[MAXPATHLEN+80];
1428 sprintf(warnstr, "Not importing directory "
1429 "'%.*s': missing __init__.py",
1430 MAXPATHLEN, buf);
1431 if (PyErr_Warn(PyExc_ImportWarning,
1432 warnstr)) {
1433 Py_XDECREF(copy);
1434 return NULL;
1435 }
1436 }
1437 }
Andrew MacIntyred9400542002-02-26 11:41:34 +00001438#if defined(PYOS_OS2)
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001439 /* take a snapshot of the module spec for restoration
1440 * after the 8 character DLL hackery
1441 */
1442 saved_buf = strdup(buf);
1443 saved_len = len;
1444 saved_namelen = namelen;
Andrew MacIntyred9400542002-02-26 11:41:34 +00001445#endif /* PYOS_OS2 */
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001446 for (fdp = _PyImport_Filetab; fdp->suffix != NULL; fdp++) {
Georg Brandladd36e52007-08-23 18:08:06 +00001447#if defined(PYOS_OS2) && defined(HAVE_DYNAMIC_LOADING)
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001448 /* OS/2 limits DLLs to 8 character names (w/o
1449 extension)
1450 * so if the name is longer than that and its a
1451 * dynamically loaded module we're going to try,
1452 * truncate the name before trying
1453 */
1454 if (strlen(subname) > 8) {
1455 /* is this an attempt to load a C extension? */
1456 const struct filedescr *scan;
1457 scan = _PyImport_DynLoadFiletab;
1458 while (scan->suffix != NULL) {
1459 if (!strcmp(scan->suffix, fdp->suffix))
1460 break;
1461 else
1462 scan++;
1463 }
1464 if (scan->suffix != NULL) {
1465 /* yes, so truncate the name */
1466 namelen = 8;
1467 len -= strlen(subname) - namelen;
1468 buf[len] = '\0';
1469 }
1470 }
Andrew MacIntyred9400542002-02-26 11:41:34 +00001471#endif /* PYOS_OS2 */
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001472 strcpy(buf+len, fdp->suffix);
1473 if (Py_VerboseFlag > 1)
1474 PySys_WriteStderr("# trying %s\n", buf);
1475 filemode = fdp->mode;
1476 if (filemode[0] == 'U')
1477 filemode = "r" PY_STDIOTEXTMODE;
1478 fp = fopen(buf, filemode);
1479 if (fp != NULL) {
1480 if (case_ok(buf, len, namelen, name))
1481 break;
1482 else { /* continue search */
1483 fclose(fp);
1484 fp = NULL;
1485 }
1486 }
Andrew MacIntyred9400542002-02-26 11:41:34 +00001487#if defined(PYOS_OS2)
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001488 /* restore the saved snapshot */
1489 strcpy(buf, saved_buf);
1490 len = saved_len;
1491 namelen = saved_namelen;
Andrew MacIntyred9400542002-02-26 11:41:34 +00001492#endif
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001493 }
Andrew MacIntyred9400542002-02-26 11:41:34 +00001494#if defined(PYOS_OS2)
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001495 /* don't need/want the module name snapshot anymore */
1496 if (saved_buf)
1497 {
1498 free(saved_buf);
1499 saved_buf = NULL;
1500 }
Andrew MacIntyred9400542002-02-26 11:41:34 +00001501#endif
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001502 Py_XDECREF(copy);
1503 if (fp != NULL)
1504 break;
1505 }
1506 if (fp == NULL) {
1507 PyErr_Format(PyExc_ImportError,
1508 "No module named %.200s", name);
1509 return NULL;
1510 }
1511 *p_fp = fp;
1512 return fdp;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001513}
1514
Raymond Hettingerdb29e0f2004-10-07 06:46:25 +00001515/* Helpers for main.c
1516 * Find the source file corresponding to a named module
1517 */
1518struct filedescr *
1519_PyImport_FindModule(const char *name, PyObject *path, char *buf,
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001520 size_t buflen, FILE **p_fp, PyObject **p_loader)
Raymond Hettingerdb29e0f2004-10-07 06:46:25 +00001521{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001522 return find_module((char *) name, (char *) name, path,
1523 buf, buflen, p_fp, p_loader);
Raymond Hettingerdb29e0f2004-10-07 06:46:25 +00001524}
1525
1526PyAPI_FUNC(int) _PyImport_IsScript(struct filedescr * fd)
1527{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001528 return fd->type == PY_SOURCE || fd->type == PY_COMPILED;
Raymond Hettingerdb29e0f2004-10-07 06:46:25 +00001529}
1530
Martin v. Löwis18e16552006-02-15 17:27:45 +00001531/* case_ok(char* buf, Py_ssize_t len, Py_ssize_t namelen, char* name)
Tim Petersd1e87a82001-03-01 18:12:00 +00001532 * The arguments here are tricky, best shown by example:
1533 * /a/b/c/d/e/f/g/h/i/j/k/some_long_module_name.py\0
1534 * ^ ^ ^ ^
1535 * |--------------------- buf ---------------------|
1536 * |------------------- len ------------------|
1537 * |------ name -------|
1538 * |----- namelen -----|
1539 * buf is the full path, but len only counts up to (& exclusive of) the
1540 * extension. name is the module name, also exclusive of extension.
1541 *
1542 * We've already done a successful stat() or fopen() on buf, so know that
1543 * there's some match, possibly case-insensitive.
1544 *
Tim Peters50d8d372001-02-28 05:34:27 +00001545 * case_ok() is to return 1 if there's a case-sensitive match for
1546 * name, else 0. case_ok() is also to return 1 if envar PYTHONCASEOK
1547 * exists.
Tim Petersd1e87a82001-03-01 18:12:00 +00001548 *
Tim Peters50d8d372001-02-28 05:34:27 +00001549 * case_ok() is used to implement case-sensitive import semantics even
1550 * on platforms with case-insensitive filesystems. It's trivial to implement
1551 * for case-sensitive filesystems. It's pretty much a cross-platform
1552 * nightmare for systems with case-insensitive filesystems.
1553 */
Guido van Rossum0980bd91998-02-13 17:18:36 +00001554
Tim Peters50d8d372001-02-28 05:34:27 +00001555/* First we may need a pile of platform-specific header files; the sequence
1556 * of #if's here should match the sequence in the body of case_ok().
1557 */
Jason Tishler7961aa62005-05-20 00:56:54 +00001558#if defined(MS_WINDOWS)
Guido van Rossum0980bd91998-02-13 17:18:36 +00001559#include <windows.h>
Guido van Rossum4c3f57c2001-01-10 20:40:46 +00001560
Tim Peters50d8d372001-02-28 05:34:27 +00001561#elif defined(DJGPP)
1562#include <dir.h>
1563
Jason Tishler7961aa62005-05-20 00:56:54 +00001564#elif (defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) && defined(HAVE_DIRENT_H)
Tim Peters430f5d42001-03-01 01:30:56 +00001565#include <sys/types.h>
1566#include <dirent.h>
1567
Andrew MacIntyred9400542002-02-26 11:41:34 +00001568#elif defined(PYOS_OS2)
1569#define INCL_DOS
1570#define INCL_DOSERRORS
1571#define INCL_NOPMAPI
1572#include <os2.h>
1573
Guido van Rossume2ae77b2001-10-24 20:42:55 +00001574#elif defined(RISCOS)
1575#include "oslib/osfscontrol.h"
Tim Peters50d8d372001-02-28 05:34:27 +00001576#endif
1577
Guido van Rossum0980bd91998-02-13 17:18:36 +00001578static int
Martin v. Löwis18e16552006-02-15 17:27:45 +00001579case_ok(char *buf, Py_ssize_t len, Py_ssize_t namelen, char *name)
Guido van Rossum0980bd91998-02-13 17:18:36 +00001580{
Tim Peters50d8d372001-02-28 05:34:27 +00001581/* Pick a platform-specific implementation; the sequence of #if's here should
1582 * match the sequence just above.
1583 */
1584
Jason Tishler7961aa62005-05-20 00:56:54 +00001585/* MS_WINDOWS */
1586#if defined(MS_WINDOWS)
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001587 WIN32_FIND_DATA data;
1588 HANDLE h;
Tim Peters50d8d372001-02-28 05:34:27 +00001589
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001590 if (Py_GETENV("PYTHONCASEOK") != NULL)
1591 return 1;
Tim Peters50d8d372001-02-28 05:34:27 +00001592
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001593 h = FindFirstFile(buf, &data);
1594 if (h == INVALID_HANDLE_VALUE) {
1595 PyErr_Format(PyExc_NameError,
1596 "Can't find file for module %.100s\n(filename %.300s)",
1597 name, buf);
1598 return 0;
1599 }
1600 FindClose(h);
1601 return strncmp(data.cFileName, name, namelen) == 0;
Tim Peters50d8d372001-02-28 05:34:27 +00001602
1603/* DJGPP */
1604#elif defined(DJGPP)
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001605 struct ffblk ffblk;
1606 int done;
Tim Peters50d8d372001-02-28 05:34:27 +00001607
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001608 if (Py_GETENV("PYTHONCASEOK") != NULL)
1609 return 1;
Tim Peters50d8d372001-02-28 05:34:27 +00001610
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001611 done = findfirst(buf, &ffblk, FA_ARCH|FA_RDONLY|FA_HIDDEN|FA_DIREC);
1612 if (done) {
1613 PyErr_Format(PyExc_NameError,
1614 "Can't find file for module %.100s\n(filename %.300s)",
1615 name, buf);
1616 return 0;
1617 }
1618 return strncmp(ffblk.ff_name, name, namelen) == 0;
Guido van Rossum0980bd91998-02-13 17:18:36 +00001619
Jason Tishler7961aa62005-05-20 00:56:54 +00001620/* new-fangled macintosh (macosx) or Cygwin */
1621#elif (defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) && defined(HAVE_DIRENT_H)
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001622 DIR *dirp;
1623 struct dirent *dp;
1624 char dirname[MAXPATHLEN + 1];
1625 const int dirlen = len - namelen - 1; /* don't want trailing SEP */
Tim Peters430f5d42001-03-01 01:30:56 +00001626
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001627 if (Py_GETENV("PYTHONCASEOK") != NULL)
1628 return 1;
Tim Petersdbe6ebb2001-03-01 08:47:29 +00001629
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001630 /* Copy the dir component into dirname; substitute "." if empty */
1631 if (dirlen <= 0) {
1632 dirname[0] = '.';
1633 dirname[1] = '\0';
1634 }
1635 else {
1636 assert(dirlen <= MAXPATHLEN);
1637 memcpy(dirname, buf, dirlen);
1638 dirname[dirlen] = '\0';
1639 }
1640 /* Open the directory and search the entries for an exact match. */
1641 dirp = opendir(dirname);
1642 if (dirp) {
1643 char *nameWithExt = buf + len - namelen;
1644 while ((dp = readdir(dirp)) != NULL) {
1645 const int thislen =
Tim Peters430f5d42001-03-01 01:30:56 +00001646#ifdef _DIRENT_HAVE_D_NAMELEN
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001647 dp->d_namlen;
Tim Peters430f5d42001-03-01 01:30:56 +00001648#else
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001649 strlen(dp->d_name);
Tim Peters430f5d42001-03-01 01:30:56 +00001650#endif
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001651 if (thislen >= namelen &&
1652 strcmp(dp->d_name, nameWithExt) == 0) {
1653 (void)closedir(dirp);
1654 return 1; /* Found */
1655 }
1656 }
1657 (void)closedir(dirp);
1658 }
1659 return 0 ; /* Not found */
Tim Peters430f5d42001-03-01 01:30:56 +00001660
Guido van Rossume2ae77b2001-10-24 20:42:55 +00001661/* RISC OS */
1662#elif defined(RISCOS)
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001663 char canon[MAXPATHLEN+1]; /* buffer for the canonical form of the path */
1664 char buf2[MAXPATHLEN+2];
1665 char *nameWithExt = buf+len-namelen;
1666 int canonlen;
1667 os_error *e;
Guido van Rossume2ae77b2001-10-24 20:42:55 +00001668
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001669 if (Py_GETENV("PYTHONCASEOK") != NULL)
1670 return 1;
Guido van Rossume2ae77b2001-10-24 20:42:55 +00001671
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001672 /* workaround:
1673 append wildcard, otherwise case of filename wouldn't be touched */
1674 strcpy(buf2, buf);
1675 strcat(buf2, "*");
Guido van Rossume2ae77b2001-10-24 20:42:55 +00001676
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001677 e = xosfscontrol_canonicalise_path(buf2,canon,0,0,MAXPATHLEN+1,&canonlen);
1678 canonlen = MAXPATHLEN+1-canonlen;
1679 if (e || canonlen<=0 || canonlen>(MAXPATHLEN+1) )
1680 return 0;
1681 if (strcmp(nameWithExt, canon+canonlen-strlen(nameWithExt))==0)
1682 return 1; /* match */
Guido van Rossume2ae77b2001-10-24 20:42:55 +00001683
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001684 return 0;
Guido van Rossume2ae77b2001-10-24 20:42:55 +00001685
Andrew MacIntyred9400542002-02-26 11:41:34 +00001686/* OS/2 */
1687#elif defined(PYOS_OS2)
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001688 HDIR hdir = 1;
1689 ULONG srchcnt = 1;
1690 FILEFINDBUF3 ffbuf;
1691 APIRET rc;
Andrew MacIntyred9400542002-02-26 11:41:34 +00001692
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001693 if (Py_GETENV("PYTHONCASEOK") != NULL)
1694 return 1;
Andrew MacIntyred9400542002-02-26 11:41:34 +00001695
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001696 rc = DosFindFirst(buf,
1697 &hdir,
1698 FILE_READONLY | FILE_HIDDEN | FILE_SYSTEM | FILE_DIRECTORY,
1699 &ffbuf, sizeof(ffbuf),
1700 &srchcnt,
1701 FIL_STANDARD);
1702 if (rc != NO_ERROR)
1703 return 0;
1704 return strncmp(ffbuf.achName, name, namelen) == 0;
Andrew MacIntyred9400542002-02-26 11:41:34 +00001705
Tim Peters50d8d372001-02-28 05:34:27 +00001706/* assuming it's a case-sensitive filesystem, so there's nothing to do! */
1707#else
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001708 return 1;
Guido van Rossum0980bd91998-02-13 17:18:36 +00001709
Guido van Rossum4d1b3b91998-02-13 23:27:59 +00001710#endif
Tim Peters50d8d372001-02-28 05:34:27 +00001711}
Guido van Rossum4d1b3b91998-02-13 23:27:59 +00001712
Guido van Rossum0980bd91998-02-13 17:18:36 +00001713
Guido van Rossum197346f1997-10-31 18:38:52 +00001714#ifdef HAVE_STAT
1715/* Helper to look for __init__.py or __init__.py[co] in potential package */
1716static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001717find_init_module(char *buf)
Guido van Rossum197346f1997-10-31 18:38:52 +00001718{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001719 const size_t save_len = strlen(buf);
1720 size_t i = save_len;
1721 char *pname; /* pointer to start of __init__ */
1722 struct stat statbuf;
Guido van Rossum197346f1997-10-31 18:38:52 +00001723
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001724/* For calling case_ok(buf, len, namelen, name):
1725 * /a/b/c/d/e/f/g/h/i/j/k/some_long_module_name.py\0
1726 * ^ ^ ^ ^
1727 * |--------------------- buf ---------------------|
1728 * |------------------- len ------------------|
1729 * |------ name -------|
1730 * |----- namelen -----|
Tim Peters0f9431f2001-07-05 03:47:53 +00001731 */
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001732 if (save_len + 13 >= MAXPATHLEN)
1733 return 0;
1734 buf[i++] = SEP;
1735 pname = buf + i;
1736 strcpy(pname, "__init__.py");
1737 if (stat(buf, &statbuf) == 0) {
1738 if (case_ok(buf,
1739 save_len + 9, /* len("/__init__") */
1740 8, /* len("__init__") */
1741 pname)) {
1742 buf[save_len] = '\0';
1743 return 1;
1744 }
1745 }
1746 i += strlen(pname);
1747 strcpy(buf+i, Py_OptimizeFlag ? "o" : "c");
1748 if (stat(buf, &statbuf) == 0) {
1749 if (case_ok(buf,
1750 save_len + 9, /* len("/__init__") */
1751 8, /* len("__init__") */
1752 pname)) {
1753 buf[save_len] = '\0';
1754 return 1;
1755 }
1756 }
1757 buf[save_len] = '\0';
1758 return 0;
Guido van Rossum197346f1997-10-31 18:38:52 +00001759}
Guido van Rossum48a680c2001-03-02 06:34:14 +00001760
1761#else
1762
1763#ifdef RISCOS
1764static int
1765find_init_module(buf)
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001766 char *buf;
Guido van Rossum48a680c2001-03-02 06:34:14 +00001767{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001768 int save_len = strlen(buf);
1769 int i = save_len;
Guido van Rossum48a680c2001-03-02 06:34:14 +00001770
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001771 if (save_len + 13 >= MAXPATHLEN)
1772 return 0;
1773 buf[i++] = SEP;
1774 strcpy(buf+i, "__init__/py");
1775 if (isfile(buf)) {
1776 buf[save_len] = '\0';
1777 return 1;
1778 }
Guido van Rossum48a680c2001-03-02 06:34:14 +00001779
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001780 if (Py_OptimizeFlag)
1781 strcpy(buf+i, "o");
1782 else
1783 strcpy(buf+i, "c");
1784 if (isfile(buf)) {
1785 buf[save_len] = '\0';
1786 return 1;
1787 }
1788 buf[save_len] = '\0';
1789 return 0;
Guido van Rossum48a680c2001-03-02 06:34:14 +00001790}
1791#endif /*RISCOS*/
1792
Guido van Rossum197346f1997-10-31 18:38:52 +00001793#endif /* HAVE_STAT */
1794
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001795
Tim Petersdbd9ba62000-07-09 03:09:57 +00001796static int init_builtin(char *); /* Forward */
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001797
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001798/* Load an external module using the default search path and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001799 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001800
Guido van Rossum79f25d91997-04-29 20:08:16 +00001801static PyObject *
Amaury Forgeot d'Arc982b2fa2009-07-25 16:22:06 +00001802load_module(char *name, FILE *fp, char *pathname, int type, PyObject *loader)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001803{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001804 PyObject *modules;
1805 PyObject *m;
1806 int err;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001807
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001808 /* First check that there's an open file (if we need one) */
1809 switch (type) {
1810 case PY_SOURCE:
1811 case PY_COMPILED:
1812 if (fp == NULL) {
1813 PyErr_Format(PyExc_ValueError,
1814 "file object required for import (type code %d)",
1815 type);
1816 return NULL;
1817 }
1818 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001819
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001820 switch (type) {
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001821
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001822 case PY_SOURCE:
1823 m = load_source_module(name, pathname, fp);
1824 break;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001825
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001826 case PY_COMPILED:
1827 m = load_compiled_module(name, pathname, fp);
1828 break;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001829
Guido van Rossum96a8fb71999-12-22 14:09:35 +00001830#ifdef HAVE_DYNAMIC_LOADING
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001831 case C_EXTENSION:
1832 m = _PyImport_LoadDynamicModule(name, pathname, fp);
1833 break;
Guido van Rossum96a8fb71999-12-22 14:09:35 +00001834#endif
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001835
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001836 case PKG_DIRECTORY:
1837 m = load_package(name, pathname);
1838 break;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001839
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001840 case C_BUILTIN:
1841 case PY_FROZEN:
1842 if (pathname != NULL && pathname[0] != '\0')
1843 name = pathname;
1844 if (type == C_BUILTIN)
1845 err = init_builtin(name);
1846 else
1847 err = PyImport_ImportFrozenModule(name);
1848 if (err < 0)
1849 return NULL;
1850 if (err == 0) {
1851 PyErr_Format(PyExc_ImportError,
1852 "Purported %s module %.200s not found",
1853 type == C_BUILTIN ?
1854 "builtin" : "frozen",
1855 name);
1856 return NULL;
1857 }
1858 modules = PyImport_GetModuleDict();
1859 m = PyDict_GetItemString(modules, name);
1860 if (m == NULL) {
1861 PyErr_Format(
1862 PyExc_ImportError,
1863 "%s module %.200s not properly initialized",
1864 type == C_BUILTIN ?
1865 "builtin" : "frozen",
1866 name);
1867 return NULL;
1868 }
1869 Py_INCREF(m);
1870 break;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001871
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001872 case IMP_HOOK: {
1873 if (loader == NULL) {
1874 PyErr_SetString(PyExc_ImportError,
1875 "import hook without loader");
1876 return NULL;
1877 }
1878 m = PyObject_CallMethod(loader, "load_module", "s", name);
1879 break;
1880 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001881
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001882 default:
1883 PyErr_Format(PyExc_ImportError,
1884 "Don't know how to import %.200s (type code %d)",
1885 name, type);
1886 m = NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001887
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001888 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001889
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001890 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001891}
1892
1893
1894/* Initialize a built-in module.
Brett Cannon5a9aa4f2006-10-03 21:58:55 +00001895 Return 1 for success, 0 if the module is not found, and -1 with
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001896 an exception set if the initialization failed. */
Guido van Rossum7f133ed1991-02-19 12:23:57 +00001897
Guido van Rossum7f133ed1991-02-19 12:23:57 +00001898static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001899init_builtin(char *name)
Guido van Rossum7f133ed1991-02-19 12:23:57 +00001900{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001901 struct _inittab *p;
Guido van Rossum25ce5661997-08-02 03:10:38 +00001902
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001903 if (_PyImport_FindExtension(name, name) != NULL)
1904 return 1;
Guido van Rossum25ce5661997-08-02 03:10:38 +00001905
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001906 for (p = PyImport_Inittab; p->name != NULL; p++) {
1907 if (strcmp(name, p->name) == 0) {
1908 if (p->initfunc == NULL) {
1909 PyErr_Format(PyExc_ImportError,
1910 "Cannot re-init internal module %.200s",
1911 name);
1912 return -1;
1913 }
1914 if (Py_VerboseFlag)
1915 PySys_WriteStderr("import %s # builtin\n", name);
1916 (*p->initfunc)();
1917 if (PyErr_Occurred())
1918 return -1;
1919 if (_PyImport_FixupExtension(name, name) == NULL)
1920 return -1;
1921 return 1;
1922 }
1923 }
1924 return 0;
Guido van Rossum7f133ed1991-02-19 12:23:57 +00001925}
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001926
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001927
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001928/* Frozen modules */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001929
Guido van Rossumcfd0a221996-06-17 17:06:34 +00001930static struct _frozen *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001931find_frozen(char *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001932{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001933 struct _frozen *p;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001934
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001935 for (p = PyImport_FrozenModules; ; p++) {
1936 if (p->name == NULL)
1937 return NULL;
1938 if (strcmp(p->name, name) == 0)
1939 break;
1940 }
1941 return p;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001942}
1943
Guido van Rossum79f25d91997-04-29 20:08:16 +00001944static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001945get_frozen_object(char *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001946{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001947 struct _frozen *p = find_frozen(name);
1948 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001949
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001950 if (p == NULL) {
1951 PyErr_Format(PyExc_ImportError,
1952 "No such frozen object named %.200s",
1953 name);
1954 return NULL;
1955 }
1956 if (p->code == NULL) {
1957 PyErr_Format(PyExc_ImportError,
1958 "Excluded frozen object named %.200s",
1959 name);
1960 return NULL;
1961 }
1962 size = p->size;
1963 if (size < 0)
1964 size = -size;
1965 return PyMarshal_ReadObjectFromString((char *)p->code, size);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001966}
1967
1968/* Initialize a frozen module.
1969 Return 1 for succes, 0 if the module is not found, and -1 with
1970 an exception set if the initialization failed.
1971 This function is also used from frozenmain.c */
Guido van Rossum0b344901995-02-07 15:35:27 +00001972
1973int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001974PyImport_ImportFrozenModule(char *name)
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001975{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001976 struct _frozen *p = find_frozen(name);
1977 PyObject *co;
1978 PyObject *m;
1979 int ispackage;
1980 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001981
Antoine Pitrouc83ea132010-05-09 14:46:46 +00001982 if (p == NULL)
1983 return 0;
1984 if (p->code == NULL) {
1985 PyErr_Format(PyExc_ImportError,
1986 "Excluded frozen object named %.200s",
1987 name);
1988 return -1;
1989 }
1990 size = p->size;
1991 ispackage = (size < 0);
1992 if (ispackage)
1993 size = -size;
1994 if (Py_VerboseFlag)
1995 PySys_WriteStderr("import %s # frozen%s\n",
1996 name, ispackage ? " package" : "");
1997 co = PyMarshal_ReadObjectFromString((char *)p->code, size);
1998 if (co == NULL)
1999 return -1;
2000 if (!PyCode_Check(co)) {
2001 PyErr_Format(PyExc_TypeError,
2002 "frozen object %.200s is not a code object",
2003 name);
2004 goto err_return;
2005 }
2006 if (ispackage) {
2007 /* Set __path__ to the package name */
2008 PyObject *d, *s;
2009 int err;
2010 m = PyImport_AddModule(name);
2011 if (m == NULL)
2012 goto err_return;
2013 d = PyModule_GetDict(m);
2014 s = PyString_InternFromString(name);
2015 if (s == NULL)
2016 goto err_return;
2017 err = PyDict_SetItemString(d, "__path__", s);
2018 Py_DECREF(s);
2019 if (err != 0)
2020 goto err_return;
2021 }
2022 m = PyImport_ExecCodeModuleEx(name, co, "<frozen>");
2023 if (m == NULL)
2024 goto err_return;
2025 Py_DECREF(co);
2026 Py_DECREF(m);
2027 return 1;
Neal Norwitzc0cde4d2006-07-16 02:17:36 +00002028err_return:
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002029 Py_DECREF(co);
2030 return -1;
Guido van Rossumf56e3db1993-04-01 20:59:32 +00002031}
Guido van Rossum74e6a111994-08-29 12:54:38 +00002032
2033
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002034/* Import a module, either built-in, frozen, or external, and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00002035 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum74e6a111994-08-29 12:54:38 +00002036
Guido van Rossum79f25d91997-04-29 20:08:16 +00002037PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00002038PyImport_ImportModule(const char *name)
Guido van Rossum74e6a111994-08-29 12:54:38 +00002039{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002040 PyObject *pname;
2041 PyObject *result;
Marc-André Lemburg3c61c352001-02-09 19:40:15 +00002042
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002043 pname = PyString_FromString(name);
2044 if (pname == NULL)
2045 return NULL;
2046 result = PyImport_Import(pname);
2047 Py_DECREF(pname);
2048 return result;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002049}
2050
Christian Heimes000a0742008-01-03 22:16:32 +00002051/* Import a module without blocking
2052 *
2053 * At first it tries to fetch the module from sys.modules. If the module was
2054 * never loaded before it loads it with PyImport_ImportModule() unless another
2055 * thread holds the import lock. In the latter case the function raises an
2056 * ImportError instead of blocking.
2057 *
2058 * Returns the module object with incremented ref count.
2059 */
2060PyObject *
2061PyImport_ImportModuleNoBlock(const char *name)
2062{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002063 PyObject *result;
2064 PyObject *modules;
Victor Stinner871a0fb2011-09-02 00:21:36 +02002065#ifdef WITH_THREAD
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002066 long me;
Victor Stinner871a0fb2011-09-02 00:21:36 +02002067#endif
Christian Heimes000a0742008-01-03 22:16:32 +00002068
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002069 /* Try to get the module from sys.modules[name] */
2070 modules = PyImport_GetModuleDict();
2071 if (modules == NULL)
2072 return NULL;
Christian Heimes000a0742008-01-03 22:16:32 +00002073
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002074 result = PyDict_GetItemString(modules, name);
2075 if (result != NULL) {
2076 Py_INCREF(result);
2077 return result;
2078 }
2079 else {
2080 PyErr_Clear();
2081 }
Benjamin Peterson17f03ca2008-09-01 14:18:30 +00002082#ifdef WITH_THREAD
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002083 /* check the import lock
2084 * me might be -1 but I ignore the error here, the lock function
2085 * takes care of the problem */
2086 me = PyThread_get_thread_ident();
2087 if (import_lock_thread == -1 || import_lock_thread == me) {
2088 /* no thread or me is holding the lock */
2089 return PyImport_ImportModule(name);
2090 }
2091 else {
2092 PyErr_Format(PyExc_ImportError,
2093 "Failed to import %.200s because the import lock"
2094 "is held by another thread.",
2095 name);
2096 return NULL;
2097 }
Benjamin Peterson17f03ca2008-09-01 14:18:30 +00002098#else
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002099 return PyImport_ImportModule(name);
Benjamin Peterson17f03ca2008-09-01 14:18:30 +00002100#endif
Christian Heimes000a0742008-01-03 22:16:32 +00002101}
2102
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002103/* Forward declarations for helper routines */
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002104static PyObject *get_parent(PyObject *globals, char *buf,
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002105 Py_ssize_t *p_buflen, int level);
Tim Petersdbd9ba62000-07-09 03:09:57 +00002106static PyObject *load_next(PyObject *mod, PyObject *altmod,
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002107 char **p_name, char *buf, Py_ssize_t *p_buflen);
Tim Petersdbd9ba62000-07-09 03:09:57 +00002108static int mark_miss(char *name);
2109static int ensure_fromlist(PyObject *mod, PyObject *fromlist,
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002110 char *buf, Py_ssize_t buflen, int recursive);
Tim Petersdbd9ba62000-07-09 03:09:57 +00002111static PyObject * import_submodule(PyObject *mod, char *name, char *fullname);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002112
2113/* The Magnum Opus of dotted-name import :-) */
2114
Guido van Rossum75acc9c1998-03-03 22:26:50 +00002115static PyObject *
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002116import_module_level(char *name, PyObject *globals, PyObject *locals,
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002117 PyObject *fromlist, int level)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002118{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002119 char buf[MAXPATHLEN+1];
2120 Py_ssize_t buflen = 0;
2121 PyObject *parent, *head, *next, *tail;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002122
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002123 if (strchr(name, '/') != NULL
Christian Heimes3403f152008-01-09 19:56:33 +00002124#ifdef MS_WINDOWS
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002125 || strchr(name, '\\') != NULL
Christian Heimes3403f152008-01-09 19:56:33 +00002126#endif
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002127 ) {
2128 PyErr_SetString(PyExc_ImportError,
2129 "Import by filename is not supported.");
2130 return NULL;
2131 }
Christian Heimes3403f152008-01-09 19:56:33 +00002132
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002133 parent = get_parent(globals, buf, &buflen, level);
2134 if (parent == NULL)
2135 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002136
Brett Cannoneb3cd302010-05-20 18:37:55 +00002137 head = load_next(parent, level < 0 ? Py_None : parent, &name, buf,
2138 &buflen);
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002139 if (head == NULL)
2140 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002141
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002142 tail = head;
2143 Py_INCREF(tail);
2144 while (name) {
2145 next = load_next(tail, tail, &name, buf, &buflen);
2146 Py_DECREF(tail);
2147 if (next == NULL) {
2148 Py_DECREF(head);
2149 return NULL;
2150 }
2151 tail = next;
2152 }
2153 if (tail == Py_None) {
2154 /* If tail is Py_None, both get_parent and load_next found
2155 an empty module name: someone called __import__("") or
2156 doctored faulty bytecode */
2157 Py_DECREF(tail);
2158 Py_DECREF(head);
2159 PyErr_SetString(PyExc_ValueError,
2160 "Empty module name");
2161 return NULL;
2162 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002163
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002164 if (fromlist != NULL) {
2165 if (fromlist == Py_None || !PyObject_IsTrue(fromlist))
2166 fromlist = NULL;
2167 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002168
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002169 if (fromlist == NULL) {
2170 Py_DECREF(tail);
2171 return head;
2172 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002173
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002174 Py_DECREF(head);
2175 if (!ensure_fromlist(tail, fromlist, buf, buflen, 0)) {
2176 Py_DECREF(tail);
2177 return NULL;
2178 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002179
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002180 return tail;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002181}
2182
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002183PyObject *
2184PyImport_ImportModuleLevel(char *name, PyObject *globals, PyObject *locals,
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002185 PyObject *fromlist, int level)
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002186{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002187 PyObject *result;
2188 _PyImport_AcquireLock();
2189 result = import_module_level(name, globals, locals, fromlist, level);
2190 if (_PyImport_ReleaseLock() < 0) {
2191 Py_XDECREF(result);
2192 PyErr_SetString(PyExc_RuntimeError,
2193 "not holding the import lock");
2194 return NULL;
2195 }
2196 return result;
Guido van Rossum75acc9c1998-03-03 22:26:50 +00002197}
2198
Fred Drake87590902004-05-28 20:21:36 +00002199/* Return the package that an import is being performed in. If globals comes
2200 from the module foo.bar.bat (not itself a package), this returns the
2201 sys.modules entry for foo.bar. If globals is from a package's __init__.py,
Georg Brandl5f6861d2006-05-28 21:57:35 +00002202 the package's entry in sys.modules is returned, as a borrowed reference.
Fred Drake87590902004-05-28 20:21:36 +00002203
2204 The *name* of the returned package is returned in buf, with the length of
2205 the name in *p_buflen.
2206
2207 If globals doesn't come from a package or a module in a package, or a
2208 corresponding entry is not found in sys.modules, Py_None is returned.
2209*/
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002210static PyObject *
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002211get_parent(PyObject *globals, char *buf, Py_ssize_t *p_buflen, int level)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002212{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002213 static PyObject *namestr = NULL;
2214 static PyObject *pathstr = NULL;
2215 static PyObject *pkgstr = NULL;
2216 PyObject *pkgname, *modname, *modpath, *modules, *parent;
2217 int orig_level = level;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002218
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002219 if (globals == NULL || !PyDict_Check(globals) || !level)
2220 return Py_None;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002221
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002222 if (namestr == NULL) {
2223 namestr = PyString_InternFromString("__name__");
2224 if (namestr == NULL)
2225 return NULL;
2226 }
2227 if (pathstr == NULL) {
2228 pathstr = PyString_InternFromString("__path__");
2229 if (pathstr == NULL)
2230 return NULL;
2231 }
2232 if (pkgstr == NULL) {
2233 pkgstr = PyString_InternFromString("__package__");
2234 if (pkgstr == NULL)
2235 return NULL;
2236 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002237
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002238 *buf = '\0';
2239 *p_buflen = 0;
2240 pkgname = PyDict_GetItem(globals, pkgstr);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002241
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002242 if ((pkgname != NULL) && (pkgname != Py_None)) {
2243 /* __package__ is set, so use it */
2244 Py_ssize_t len;
2245 if (!PyString_Check(pkgname)) {
2246 PyErr_SetString(PyExc_ValueError,
2247 "__package__ set to non-string");
2248 return NULL;
2249 }
2250 len = PyString_GET_SIZE(pkgname);
2251 if (len == 0) {
2252 if (level > 0) {
2253 PyErr_SetString(PyExc_ValueError,
2254 "Attempted relative import in non-package");
2255 return NULL;
2256 }
2257 return Py_None;
2258 }
2259 if (len > MAXPATHLEN) {
2260 PyErr_SetString(PyExc_ValueError,
2261 "Package name too long");
2262 return NULL;
2263 }
2264 strcpy(buf, PyString_AS_STRING(pkgname));
2265 } else {
2266 /* __package__ not set, so figure it out and set it */
2267 modname = PyDict_GetItem(globals, namestr);
2268 if (modname == NULL || !PyString_Check(modname))
2269 return Py_None;
Brett Cannonb166afc2010-05-05 20:25:47 +00002270
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002271 modpath = PyDict_GetItem(globals, pathstr);
2272 if (modpath != NULL) {
2273 /* __path__ is set, so modname is already the package name */
2274 Py_ssize_t len = PyString_GET_SIZE(modname);
2275 int error;
2276 if (len > MAXPATHLEN) {
2277 PyErr_SetString(PyExc_ValueError,
2278 "Module name too long");
2279 return NULL;
2280 }
2281 strcpy(buf, PyString_AS_STRING(modname));
2282 error = PyDict_SetItem(globals, pkgstr, modname);
2283 if (error) {
2284 PyErr_SetString(PyExc_ValueError,
2285 "Could not set __package__");
2286 return NULL;
2287 }
2288 } else {
2289 /* Normal module, so work out the package name if any */
2290 char *start = PyString_AS_STRING(modname);
2291 char *lastdot = strrchr(start, '.');
2292 size_t len;
2293 int error;
2294 if (lastdot == NULL && level > 0) {
2295 PyErr_SetString(PyExc_ValueError,
2296 "Attempted relative import in non-package");
2297 return NULL;
2298 }
2299 if (lastdot == NULL) {
2300 error = PyDict_SetItem(globals, pkgstr, Py_None);
2301 if (error) {
2302 PyErr_SetString(PyExc_ValueError,
2303 "Could not set __package__");
2304 return NULL;
2305 }
2306 return Py_None;
2307 }
2308 len = lastdot - start;
2309 if (len >= MAXPATHLEN) {
2310 PyErr_SetString(PyExc_ValueError,
2311 "Module name too long");
2312 return NULL;
2313 }
2314 strncpy(buf, start, len);
2315 buf[len] = '\0';
2316 pkgname = PyString_FromString(buf);
2317 if (pkgname == NULL) {
2318 return NULL;
2319 }
2320 error = PyDict_SetItem(globals, pkgstr, pkgname);
2321 Py_DECREF(pkgname);
2322 if (error) {
2323 PyErr_SetString(PyExc_ValueError,
2324 "Could not set __package__");
2325 return NULL;
2326 }
2327 }
2328 }
2329 while (--level > 0) {
2330 char *dot = strrchr(buf, '.');
2331 if (dot == NULL) {
2332 PyErr_SetString(PyExc_ValueError,
2333 "Attempted relative import beyond "
2334 "toplevel package");
2335 return NULL;
2336 }
2337 *dot = '\0';
2338 }
2339 *p_buflen = strlen(buf);
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002340
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002341 modules = PyImport_GetModuleDict();
2342 parent = PyDict_GetItemString(modules, buf);
2343 if (parent == NULL) {
2344 if (orig_level < 1) {
2345 PyObject *err_msg = PyString_FromFormat(
2346 "Parent module '%.200s' not found "
2347 "while handling absolute import", buf);
2348 if (err_msg == NULL) {
2349 return NULL;
2350 }
2351 if (!PyErr_WarnEx(PyExc_RuntimeWarning,
2352 PyString_AsString(err_msg), 1)) {
2353 *buf = '\0';
2354 *p_buflen = 0;
2355 parent = Py_None;
2356 }
2357 Py_DECREF(err_msg);
2358 } else {
2359 PyErr_Format(PyExc_SystemError,
2360 "Parent module '%.200s' not loaded, "
2361 "cannot perform relative import", buf);
2362 }
2363 }
2364 return parent;
2365 /* We expect, but can't guarantee, if parent != None, that:
2366 - parent.__name__ == buf
2367 - parent.__dict__ is globals
2368 If this is violated... Who cares? */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002369}
2370
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002371/* altmod is either None or same as mod */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002372static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002373load_next(PyObject *mod, PyObject *altmod, char **p_name, char *buf,
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002374 Py_ssize_t *p_buflen)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002375{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002376 char *name = *p_name;
2377 char *dot = strchr(name, '.');
2378 size_t len;
2379 char *p;
2380 PyObject *result;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002381
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002382 if (strlen(name) == 0) {
2383 /* completely empty module name should only happen in
2384 'from . import' (or '__import__("")')*/
2385 Py_INCREF(mod);
2386 *p_name = NULL;
2387 return mod;
2388 }
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002389
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002390 if (dot == NULL) {
2391 *p_name = NULL;
2392 len = strlen(name);
2393 }
2394 else {
2395 *p_name = dot+1;
2396 len = dot-name;
2397 }
2398 if (len == 0) {
2399 PyErr_SetString(PyExc_ValueError,
2400 "Empty module name");
2401 return NULL;
2402 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002403
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002404 p = buf + *p_buflen;
2405 if (p != buf)
2406 *p++ = '.';
2407 if (p+len-buf >= MAXPATHLEN) {
2408 PyErr_SetString(PyExc_ValueError,
2409 "Module name too long");
2410 return NULL;
2411 }
2412 strncpy(p, name, len);
2413 p[len] = '\0';
2414 *p_buflen = p+len-buf;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002415
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002416 result = import_submodule(mod, p, buf);
2417 if (result == Py_None && altmod != mod) {
2418 Py_DECREF(result);
2419 /* Here, altmod must be None and mod must not be None */
2420 result = import_submodule(altmod, p, p);
2421 if (result != NULL && result != Py_None) {
2422 if (mark_miss(buf) != 0) {
2423 Py_DECREF(result);
2424 return NULL;
2425 }
2426 strncpy(buf, name, len);
2427 buf[len] = '\0';
2428 *p_buflen = len;
2429 }
2430 }
2431 if (result == NULL)
2432 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002433
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002434 if (result == Py_None) {
2435 Py_DECREF(result);
2436 PyErr_Format(PyExc_ImportError,
2437 "No module named %.200s", name);
2438 return NULL;
2439 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002440
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002441 return result;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002442}
2443
2444static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002445mark_miss(char *name)
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00002446{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002447 PyObject *modules = PyImport_GetModuleDict();
2448 return PyDict_SetItemString(modules, name, Py_None);
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00002449}
2450
2451static int
Martin v. Löwis18e16552006-02-15 17:27:45 +00002452ensure_fromlist(PyObject *mod, PyObject *fromlist, char *buf, Py_ssize_t buflen,
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002453 int recursive)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002454{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002455 int i;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002456
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002457 if (!PyObject_HasAttrString(mod, "__path__"))
2458 return 1;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002459
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002460 for (i = 0; ; i++) {
2461 PyObject *item = PySequence_GetItem(fromlist, i);
2462 int hasit;
2463 if (item == NULL) {
2464 if (PyErr_ExceptionMatches(PyExc_IndexError)) {
2465 PyErr_Clear();
2466 return 1;
2467 }
2468 return 0;
2469 }
2470 if (!PyString_Check(item)) {
2471 PyErr_SetString(PyExc_TypeError,
2472 "Item in ``from list'' not a string");
2473 Py_DECREF(item);
2474 return 0;
2475 }
2476 if (PyString_AS_STRING(item)[0] == '*') {
2477 PyObject *all;
2478 Py_DECREF(item);
2479 /* See if the package defines __all__ */
2480 if (recursive)
2481 continue; /* Avoid endless recursion */
2482 all = PyObject_GetAttrString(mod, "__all__");
2483 if (all == NULL)
2484 PyErr_Clear();
2485 else {
2486 int ret = ensure_fromlist(mod, all, buf, buflen, 1);
2487 Py_DECREF(all);
2488 if (!ret)
2489 return 0;
2490 }
2491 continue;
2492 }
2493 hasit = PyObject_HasAttr(mod, item);
2494 if (!hasit) {
2495 char *subname = PyString_AS_STRING(item);
2496 PyObject *submod;
2497 char *p;
2498 if (buflen + strlen(subname) >= MAXPATHLEN) {
2499 PyErr_SetString(PyExc_ValueError,
2500 "Module name too long");
2501 Py_DECREF(item);
2502 return 0;
2503 }
2504 p = buf + buflen;
2505 *p++ = '.';
2506 strcpy(p, subname);
2507 submod = import_submodule(mod, subname, buf);
2508 Py_XDECREF(submod);
2509 if (submod == NULL) {
2510 Py_DECREF(item);
2511 return 0;
2512 }
2513 }
2514 Py_DECREF(item);
2515 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002516
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002517 /* NOTREACHED */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002518}
2519
Neil Schemenauer00b09662003-06-16 21:03:07 +00002520static int
2521add_submodule(PyObject *mod, PyObject *submod, char *fullname, char *subname,
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002522 PyObject *modules)
Neil Schemenauer00b09662003-06-16 21:03:07 +00002523{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002524 if (mod == Py_None)
2525 return 1;
2526 /* Irrespective of the success of this load, make a
2527 reference to it in the parent package module. A copy gets
2528 saved in the modules dictionary under the full name, so get a
2529 reference from there, if need be. (The exception is when the
2530 load failed with a SyntaxError -- then there's no trace in
2531 sys.modules. In that case, of course, do nothing extra.) */
2532 if (submod == NULL) {
2533 submod = PyDict_GetItemString(modules, fullname);
2534 if (submod == NULL)
2535 return 1;
2536 }
2537 if (PyModule_Check(mod)) {
2538 /* We can't use setattr here since it can give a
2539 * spurious warning if the submodule name shadows a
2540 * builtin name */
2541 PyObject *dict = PyModule_GetDict(mod);
2542 if (!dict)
2543 return 0;
2544 if (PyDict_SetItemString(dict, subname, submod) < 0)
2545 return 0;
2546 }
2547 else {
2548 if (PyObject_SetAttrString(mod, subname, submod) < 0)
2549 return 0;
2550 }
2551 return 1;
Neil Schemenauer00b09662003-06-16 21:03:07 +00002552}
2553
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002554static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002555import_submodule(PyObject *mod, char *subname, char *fullname)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002556{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002557 PyObject *modules = PyImport_GetModuleDict();
2558 PyObject *m = NULL;
Guido van Rossum74e6a111994-08-29 12:54:38 +00002559
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002560 /* Require:
2561 if mod == None: subname == fullname
2562 else: mod.__name__ + "." + subname == fullname
2563 */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002564
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002565 if ((m = PyDict_GetItemString(modules, fullname)) != NULL) {
2566 Py_INCREF(m);
2567 }
2568 else {
2569 PyObject *path, *loader = NULL;
2570 char buf[MAXPATHLEN+1];
2571 struct filedescr *fdp;
2572 FILE *fp = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002573
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002574 if (mod == Py_None)
2575 path = NULL;
2576 else {
2577 path = PyObject_GetAttrString(mod, "__path__");
2578 if (path == NULL) {
2579 PyErr_Clear();
2580 Py_INCREF(Py_None);
2581 return Py_None;
2582 }
2583 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002584
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002585 buf[0] = '\0';
2586 fdp = find_module(fullname, subname, path, buf, MAXPATHLEN+1,
2587 &fp, &loader);
2588 Py_XDECREF(path);
2589 if (fdp == NULL) {
2590 if (!PyErr_ExceptionMatches(PyExc_ImportError))
2591 return NULL;
2592 PyErr_Clear();
2593 Py_INCREF(Py_None);
2594 return Py_None;
2595 }
2596 m = load_module(fullname, fp, buf, fdp->type, loader);
2597 Py_XDECREF(loader);
2598 if (fp)
2599 fclose(fp);
2600 if (!add_submodule(mod, m, fullname, subname, modules)) {
2601 Py_XDECREF(m);
2602 m = NULL;
2603 }
2604 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002605
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002606 return m;
Guido van Rossum74e6a111994-08-29 12:54:38 +00002607}
2608
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002609
2610/* Re-import a module of any kind and return its module object, WITH
2611 INCREMENTED REFERENCE COUNT */
2612
Guido van Rossum79f25d91997-04-29 20:08:16 +00002613PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002614PyImport_ReloadModule(PyObject *m)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002615{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002616 PyInterpreterState *interp = PyThreadState_Get()->interp;
2617 PyObject *modules_reloading = interp->modules_reloading;
2618 PyObject *modules = PyImport_GetModuleDict();
2619 PyObject *path = NULL, *loader = NULL, *existing_m = NULL;
2620 char *name, *subname;
2621 char buf[MAXPATHLEN+1];
2622 struct filedescr *fdp;
2623 FILE *fp = NULL;
2624 PyObject *newm;
Brett Cannonb166afc2010-05-05 20:25:47 +00002625
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002626 if (modules_reloading == NULL) {
2627 Py_FatalError("PyImport_ReloadModule: "
2628 "no modules_reloading dictionary!");
2629 return NULL;
2630 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002631
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002632 if (m == NULL || !PyModule_Check(m)) {
2633 PyErr_SetString(PyExc_TypeError,
2634 "reload() argument must be module");
2635 return NULL;
2636 }
2637 name = PyModule_GetName(m);
2638 if (name == NULL)
2639 return NULL;
2640 if (m != PyDict_GetItemString(modules, name)) {
2641 PyErr_Format(PyExc_ImportError,
2642 "reload(): module %.200s not in sys.modules",
2643 name);
2644 return NULL;
2645 }
2646 existing_m = PyDict_GetItemString(modules_reloading, name);
2647 if (existing_m != NULL) {
2648 /* Due to a recursive reload, this module is already
2649 being reloaded. */
2650 Py_INCREF(existing_m);
2651 return existing_m;
2652 }
2653 if (PyDict_SetItemString(modules_reloading, name, m) < 0)
2654 return NULL;
Collin Winter276887b2007-03-12 16:11:39 +00002655
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002656 subname = strrchr(name, '.');
2657 if (subname == NULL)
2658 subname = name;
2659 else {
2660 PyObject *parentname, *parent;
2661 parentname = PyString_FromStringAndSize(name, (subname-name));
2662 if (parentname == NULL) {
2663 imp_modules_reloading_clear();
2664 return NULL;
2665 }
2666 parent = PyDict_GetItem(modules, parentname);
2667 if (parent == NULL) {
2668 PyErr_Format(PyExc_ImportError,
2669 "reload(): parent %.200s not in sys.modules",
2670 PyString_AS_STRING(parentname));
2671 Py_DECREF(parentname);
2672 imp_modules_reloading_clear();
2673 return NULL;
2674 }
2675 Py_DECREF(parentname);
2676 subname++;
2677 path = PyObject_GetAttrString(parent, "__path__");
2678 if (path == NULL)
2679 PyErr_Clear();
2680 }
2681 buf[0] = '\0';
2682 fdp = find_module(name, subname, path, buf, MAXPATHLEN+1, &fp, &loader);
2683 Py_XDECREF(path);
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00002684
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002685 if (fdp == NULL) {
2686 Py_XDECREF(loader);
2687 imp_modules_reloading_clear();
2688 return NULL;
2689 }
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00002690
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002691 newm = load_module(name, fp, buf, fdp->type, loader);
2692 Py_XDECREF(loader);
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00002693
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002694 if (fp)
2695 fclose(fp);
2696 if (newm == NULL) {
2697 /* load_module probably removed name from modules because of
2698 * the error. Put back the original module object. We're
2699 * going to return NULL in this case regardless of whether
2700 * replacing name succeeds, so the return value is ignored.
2701 */
2702 PyDict_SetItemString(modules, name, m);
2703 }
2704 imp_modules_reloading_clear();
2705 return newm;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002706}
2707
2708
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002709/* Higher-level import emulator which emulates the "import" statement
2710 more accurately -- it invokes the __import__() function from the
2711 builtins of the current globals. This means that the import is
2712 done using whatever import hooks are installed in the current
Guido van Rossum6058eb41998-12-21 19:51:00 +00002713 environment, e.g. by "rexec".
2714 A dummy list ["__doc__"] is passed as the 4th argument so that
Gregory P. Smithdd96db62008-06-09 04:58:54 +00002715 e.g. PyImport_Import(PyString_FromString("win32com.client.gencache"))
Guido van Rossum6058eb41998-12-21 19:51:00 +00002716 will return <module "gencache"> instead of <module "win32com">. */
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002717
2718PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002719PyImport_Import(PyObject *module_name)
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002720{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002721 static PyObject *silly_list = NULL;
2722 static PyObject *builtins_str = NULL;
2723 static PyObject *import_str = NULL;
2724 PyObject *globals = NULL;
2725 PyObject *import = NULL;
2726 PyObject *builtins = NULL;
2727 PyObject *r = NULL;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002728
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002729 /* Initialize constant string objects */
2730 if (silly_list == NULL) {
2731 import_str = PyString_InternFromString("__import__");
2732 if (import_str == NULL)
2733 return NULL;
2734 builtins_str = PyString_InternFromString("__builtins__");
2735 if (builtins_str == NULL)
2736 return NULL;
2737 silly_list = Py_BuildValue("[s]", "__doc__");
2738 if (silly_list == NULL)
2739 return NULL;
2740 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002741
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002742 /* Get the builtins from current globals */
2743 globals = PyEval_GetGlobals();
2744 if (globals != NULL) {
2745 Py_INCREF(globals);
2746 builtins = PyObject_GetItem(globals, builtins_str);
2747 if (builtins == NULL)
2748 goto err;
2749 }
2750 else {
2751 /* No globals -- use standard builtins, and fake globals */
2752 builtins = PyImport_ImportModuleLevel("__builtin__",
2753 NULL, NULL, NULL, 0);
2754 if (builtins == NULL)
2755 return NULL;
2756 globals = Py_BuildValue("{OO}", builtins_str, builtins);
2757 if (globals == NULL)
2758 goto err;
2759 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002760
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002761 /* Get the __import__ function from the builtins */
2762 if (PyDict_Check(builtins)) {
2763 import = PyObject_GetItem(builtins, import_str);
2764 if (import == NULL)
2765 PyErr_SetObject(PyExc_KeyError, import_str);
2766 }
2767 else
2768 import = PyObject_GetAttr(builtins, import_str);
2769 if (import == NULL)
2770 goto err;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002771
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002772 /* Call the __import__ function with the proper argument list
2773 * Always use absolute import here. */
2774 r = PyObject_CallFunction(import, "OOOOi", module_name, globals,
2775 globals, silly_list, 0, NULL);
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002776
2777 err:
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002778 Py_XDECREF(globals);
2779 Py_XDECREF(builtins);
2780 Py_XDECREF(import);
Tim Peters50d8d372001-02-28 05:34:27 +00002781
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002782 return r;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002783}
2784
2785
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002786/* Module 'imp' provides Python access to the primitives used for
2787 importing modules.
2788*/
2789
Guido van Rossum79f25d91997-04-29 20:08:16 +00002790static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +00002791imp_get_magic(PyObject *self, PyObject *noargs)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002792{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002793 char buf[4];
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002794
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002795 buf[0] = (char) ((pyc_magic >> 0) & 0xff);
2796 buf[1] = (char) ((pyc_magic >> 8) & 0xff);
2797 buf[2] = (char) ((pyc_magic >> 16) & 0xff);
2798 buf[3] = (char) ((pyc_magic >> 24) & 0xff);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002799
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002800 return PyString_FromStringAndSize(buf, 4);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002801}
2802
Guido van Rossum79f25d91997-04-29 20:08:16 +00002803static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +00002804imp_get_suffixes(PyObject *self, PyObject *noargs)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002805{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002806 PyObject *list;
2807 struct filedescr *fdp;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002808
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002809 list = PyList_New(0);
2810 if (list == NULL)
2811 return NULL;
2812 for (fdp = _PyImport_Filetab; fdp->suffix != NULL; fdp++) {
2813 PyObject *item = Py_BuildValue("ssi",
2814 fdp->suffix, fdp->mode, fdp->type);
2815 if (item == NULL) {
2816 Py_DECREF(list);
2817 return NULL;
2818 }
2819 if (PyList_Append(list, item) < 0) {
2820 Py_DECREF(list);
2821 Py_DECREF(item);
2822 return NULL;
2823 }
2824 Py_DECREF(item);
2825 }
2826 return list;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002827}
2828
Guido van Rossum79f25d91997-04-29 20:08:16 +00002829static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002830call_find_module(char *name, PyObject *path)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002831{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002832 extern int fclose(FILE *);
2833 PyObject *fob, *ret;
2834 struct filedescr *fdp;
2835 char pathname[MAXPATHLEN+1];
2836 FILE *fp = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002837
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002838 pathname[0] = '\0';
2839 if (path == Py_None)
2840 path = NULL;
2841 fdp = find_module(NULL, name, path, pathname, MAXPATHLEN+1, &fp, NULL);
2842 if (fdp == NULL)
2843 return NULL;
2844 if (fp != NULL) {
2845 fob = PyFile_FromFile(fp, pathname, fdp->mode, fclose);
Victor Stinner63c22fa2011-09-23 19:37:03 +02002846 if (fob == NULL)
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002847 return NULL;
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002848 }
2849 else {
2850 fob = Py_None;
2851 Py_INCREF(fob);
2852 }
2853 ret = Py_BuildValue("Os(ssi)",
2854 fob, pathname, fdp->suffix, fdp->mode, fdp->type);
2855 Py_DECREF(fob);
2856 return ret;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002857}
2858
Guido van Rossum79f25d91997-04-29 20:08:16 +00002859static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002860imp_find_module(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002861{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002862 char *name;
2863 PyObject *path = NULL;
2864 if (!PyArg_ParseTuple(args, "s|O:find_module", &name, &path))
2865 return NULL;
2866 return call_find_module(name, path);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002867}
2868
2869static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002870imp_init_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002871{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002872 char *name;
2873 int ret;
2874 PyObject *m;
2875 if (!PyArg_ParseTuple(args, "s:init_builtin", &name))
2876 return NULL;
2877 ret = init_builtin(name);
2878 if (ret < 0)
2879 return NULL;
2880 if (ret == 0) {
2881 Py_INCREF(Py_None);
2882 return Py_None;
2883 }
2884 m = PyImport_AddModule(name);
2885 Py_XINCREF(m);
2886 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002887}
2888
Guido van Rossum79f25d91997-04-29 20:08:16 +00002889static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002890imp_init_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002891{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002892 char *name;
2893 int ret;
2894 PyObject *m;
2895 if (!PyArg_ParseTuple(args, "s:init_frozen", &name))
2896 return NULL;
2897 ret = PyImport_ImportFrozenModule(name);
2898 if (ret < 0)
2899 return NULL;
2900 if (ret == 0) {
2901 Py_INCREF(Py_None);
2902 return Py_None;
2903 }
2904 m = PyImport_AddModule(name);
2905 Py_XINCREF(m);
2906 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002907}
2908
Guido van Rossum79f25d91997-04-29 20:08:16 +00002909static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002910imp_get_frozen_object(PyObject *self, PyObject *args)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002911{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002912 char *name;
Jack Jansen95ffa231995-10-03 14:38:41 +00002913
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002914 if (!PyArg_ParseTuple(args, "s:get_frozen_object", &name))
2915 return NULL;
2916 return get_frozen_object(name);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002917}
2918
Guido van Rossum79f25d91997-04-29 20:08:16 +00002919static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002920imp_is_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002921{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002922 char *name;
2923 if (!PyArg_ParseTuple(args, "s:is_builtin", &name))
2924 return NULL;
2925 return PyInt_FromLong(is_builtin(name));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002926}
2927
Guido van Rossum79f25d91997-04-29 20:08:16 +00002928static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002929imp_is_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002930{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002931 char *name;
2932 struct _frozen *p;
2933 if (!PyArg_ParseTuple(args, "s:is_frozen", &name))
2934 return NULL;
2935 p = find_frozen(name);
2936 return PyBool_FromLong((long) (p == NULL ? 0 : p->size));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002937}
2938
2939static FILE *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002940get_file(char *pathname, PyObject *fob, char *mode)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002941{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002942 FILE *fp;
2943 if (fob == NULL) {
2944 if (mode[0] == 'U')
2945 mode = "r" PY_STDIOTEXTMODE;
2946 fp = fopen(pathname, mode);
2947 if (fp == NULL)
2948 PyErr_SetFromErrno(PyExc_IOError);
2949 }
2950 else {
2951 fp = PyFile_AsFile(fob);
2952 if (fp == NULL)
2953 PyErr_SetString(PyExc_ValueError,
2954 "bad/closed file object");
2955 }
2956 return fp;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002957}
2958
Guido van Rossum79f25d91997-04-29 20:08:16 +00002959static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002960imp_load_compiled(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002961{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002962 char *name;
2963 char *pathname;
2964 PyObject *fob = NULL;
2965 PyObject *m;
2966 FILE *fp;
2967 if (!PyArg_ParseTuple(args, "ss|O!:load_compiled", &name, &pathname,
2968 &PyFile_Type, &fob))
2969 return NULL;
2970 fp = get_file(pathname, fob, "rb");
2971 if (fp == NULL)
2972 return NULL;
2973 m = load_compiled_module(name, pathname, fp);
2974 if (fob == NULL)
2975 fclose(fp);
2976 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002977}
2978
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002979#ifdef HAVE_DYNAMIC_LOADING
2980
Guido van Rossum79f25d91997-04-29 20:08:16 +00002981static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002982imp_load_dynamic(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002983{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00002984 char *name;
2985 char *pathname;
2986 PyObject *fob = NULL;
2987 PyObject *m;
2988 FILE *fp = NULL;
2989 if (!PyArg_ParseTuple(args, "ss|O!:load_dynamic", &name, &pathname,
2990 &PyFile_Type, &fob))
2991 return NULL;
2992 if (fob) {
2993 fp = get_file(pathname, fob, "r");
2994 if (fp == NULL)
2995 return NULL;
2996 }
2997 m = _PyImport_LoadDynamicModule(name, pathname, fp);
2998 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002999}
3000
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003001#endif /* HAVE_DYNAMIC_LOADING */
3002
Guido van Rossum79f25d91997-04-29 20:08:16 +00003003static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003004imp_load_source(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003005{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00003006 char *name;
3007 char *pathname;
3008 PyObject *fob = NULL;
3009 PyObject *m;
3010 FILE *fp;
3011 if (!PyArg_ParseTuple(args, "ss|O!:load_source", &name, &pathname,
3012 &PyFile_Type, &fob))
3013 return NULL;
3014 fp = get_file(pathname, fob, "r");
3015 if (fp == NULL)
3016 return NULL;
3017 m = load_source_module(name, pathname, fp);
3018 if (fob == NULL)
3019 fclose(fp);
3020 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003021}
3022
Guido van Rossum79f25d91997-04-29 20:08:16 +00003023static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003024imp_load_module(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003025{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00003026 char *name;
3027 PyObject *fob;
3028 char *pathname;
3029 char *suffix; /* Unused */
3030 char *mode;
3031 int type;
3032 FILE *fp;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003033
Antoine Pitrouc83ea132010-05-09 14:46:46 +00003034 if (!PyArg_ParseTuple(args, "sOs(ssi):load_module",
3035 &name, &fob, &pathname,
3036 &suffix, &mode, &type))
3037 return NULL;
3038 if (*mode) {
3039 /* Mode must start with 'r' or 'U' and must not contain '+'.
3040 Implicit in this test is the assumption that the mode
3041 may contain other modifiers like 'b' or 't'. */
Guido van Rossum5e2c5fa2002-05-30 17:33:07 +00003042
Antoine Pitrouc83ea132010-05-09 14:46:46 +00003043 if (!(*mode == 'r' || *mode == 'U') || strchr(mode, '+')) {
3044 PyErr_Format(PyExc_ValueError,
3045 "invalid file open mode %.200s", mode);
3046 return NULL;
3047 }
3048 }
3049 if (fob == Py_None)
3050 fp = NULL;
3051 else {
3052 if (!PyFile_Check(fob)) {
3053 PyErr_SetString(PyExc_ValueError,
3054 "load_module arg#2 should be a file or None");
3055 return NULL;
3056 }
3057 fp = get_file(pathname, fob, mode);
3058 if (fp == NULL)
3059 return NULL;
3060 }
3061 return load_module(name, fp, pathname, type, NULL);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003062}
3063
3064static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003065imp_load_package(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003066{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00003067 char *name;
3068 char *pathname;
3069 if (!PyArg_ParseTuple(args, "ss:load_package", &name, &pathname))
3070 return NULL;
3071 return load_package(name, pathname);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003072}
3073
3074static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003075imp_new_module(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003076{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00003077 char *name;
3078 if (!PyArg_ParseTuple(args, "s:new_module", &name))
3079 return NULL;
3080 return PyModule_New(name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003081}
3082
Brett Cannon3aa2a492008-08-06 22:28:09 +00003083static PyObject *
3084imp_reload(PyObject *self, PyObject *v)
3085{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00003086 return PyImport_ReloadModule(v);
Brett Cannon3aa2a492008-08-06 22:28:09 +00003087}
3088
3089
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003090/* Doc strings */
3091
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003092PyDoc_STRVAR(doc_imp,
3093"This module provides the components needed to build your own\n\
3094__import__ function. Undocumented functions are obsolete.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003095
Brett Cannon3aa2a492008-08-06 22:28:09 +00003096PyDoc_STRVAR(doc_reload,
3097"reload(module) -> module\n\
3098\n\
3099Reload the module. The module must have been successfully imported before.");
3100
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003101PyDoc_STRVAR(doc_find_module,
3102"find_module(name, [path]) -> (file, filename, (suffix, mode, type))\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003103Search for a module. If path is omitted or None, search for a\n\
3104built-in, frozen or special module and continue search in sys.path.\n\
3105The module name cannot contain '.'; to search for a submodule of a\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003106package, pass the submodule name and the package's __path__.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003107
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003108PyDoc_STRVAR(doc_load_module,
3109"load_module(name, file, filename, (suffix, mode, type)) -> module\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003110Load a module, given information returned by find_module().\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003111The module name must include the full package name, if any.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003112
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003113PyDoc_STRVAR(doc_get_magic,
3114"get_magic() -> string\n\
3115Return the magic number for .pyc or .pyo files.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003116
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003117PyDoc_STRVAR(doc_get_suffixes,
3118"get_suffixes() -> [(suffix, mode, type), ...]\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003119Return a list of (suffix, mode, type) tuples describing the files\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003120that find_module() looks for.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003121
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003122PyDoc_STRVAR(doc_new_module,
3123"new_module(name) -> module\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003124Create a new module. Do not enter it in sys.modules.\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003125The module name must include the full package name, if any.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003126
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003127PyDoc_STRVAR(doc_lock_held,
Tim Petersa7c65092004-08-01 23:26:05 +00003128"lock_held() -> boolean\n\
3129Return True if the import lock is currently held, else False.\n\
3130On platforms without threads, return False.");
Tim Peters69232342001-08-30 05:16:13 +00003131
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00003132PyDoc_STRVAR(doc_acquire_lock,
3133"acquire_lock() -> None\n\
Neal Norwitz2294c0d2003-02-12 23:02:21 +00003134Acquires the interpreter's import lock for the current thread.\n\
3135This lock should be used by import hooks to ensure thread-safety\n\
3136when importing modules.\n\
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00003137On platforms without threads, this function does nothing.");
3138
3139PyDoc_STRVAR(doc_release_lock,
3140"release_lock() -> None\n\
3141Release the interpreter's import lock.\n\
3142On platforms without threads, this function does nothing.");
3143
Guido van Rossum79f25d91997-04-29 20:08:16 +00003144static PyMethodDef imp_methods[] = {
Antoine Pitrouc83ea132010-05-09 14:46:46 +00003145 {"reload", imp_reload, METH_O, doc_reload},
3146 {"find_module", imp_find_module, METH_VARARGS, doc_find_module},
3147 {"get_magic", imp_get_magic, METH_NOARGS, doc_get_magic},
3148 {"get_suffixes", imp_get_suffixes, METH_NOARGS, doc_get_suffixes},
3149 {"load_module", imp_load_module, METH_VARARGS, doc_load_module},
3150 {"new_module", imp_new_module, METH_VARARGS, doc_new_module},
3151 {"lock_held", imp_lock_held, METH_NOARGS, doc_lock_held},
3152 {"acquire_lock", imp_acquire_lock, METH_NOARGS, doc_acquire_lock},
3153 {"release_lock", imp_release_lock, METH_NOARGS, doc_release_lock},
3154 /* The rest are obsolete */
3155 {"get_frozen_object", imp_get_frozen_object, METH_VARARGS},
3156 {"init_builtin", imp_init_builtin, METH_VARARGS},
3157 {"init_frozen", imp_init_frozen, METH_VARARGS},
3158 {"is_builtin", imp_is_builtin, METH_VARARGS},
3159 {"is_frozen", imp_is_frozen, METH_VARARGS},
3160 {"load_compiled", imp_load_compiled, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003161#ifdef HAVE_DYNAMIC_LOADING
Antoine Pitrouc83ea132010-05-09 14:46:46 +00003162 {"load_dynamic", imp_load_dynamic, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003163#endif
Antoine Pitrouc83ea132010-05-09 14:46:46 +00003164 {"load_package", imp_load_package, METH_VARARGS},
3165 {"load_source", imp_load_source, METH_VARARGS},
3166 {NULL, NULL} /* sentinel */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003167};
3168
Guido van Rossum1a8791e1998-08-04 22:46:29 +00003169static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003170setint(PyObject *d, char *name, int value)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003171{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00003172 PyObject *v;
3173 int err;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003174
Antoine Pitrouc83ea132010-05-09 14:46:46 +00003175 v = PyInt_FromLong((long)value);
3176 err = PyDict_SetItemString(d, name, v);
3177 Py_XDECREF(v);
3178 return err;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003179}
3180
Phillip J. Ebyf7575d02006-07-28 21:12:07 +00003181typedef struct {
3182 PyObject_HEAD
3183} NullImporter;
3184
3185static int
3186NullImporter_init(NullImporter *self, PyObject *args, PyObject *kwds)
3187{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00003188 char *path;
3189 Py_ssize_t pathlen;
Phillip J. Ebyf7575d02006-07-28 21:12:07 +00003190
Antoine Pitrouc83ea132010-05-09 14:46:46 +00003191 if (!_PyArg_NoKeywords("NullImporter()", kwds))
3192 return -1;
Phillip J. Ebyf7575d02006-07-28 21:12:07 +00003193
Antoine Pitrouc83ea132010-05-09 14:46:46 +00003194 if (!PyArg_ParseTuple(args, "s:NullImporter",
3195 &path))
3196 return -1;
Phillip J. Ebyf7575d02006-07-28 21:12:07 +00003197
Antoine Pitrouc83ea132010-05-09 14:46:46 +00003198 pathlen = strlen(path);
3199 if (pathlen == 0) {
3200 PyErr_SetString(PyExc_ImportError, "empty pathname");
3201 return -1;
3202 } else {
Jason R. Coombs0737b722012-01-13 17:59:05 -05003203 if(isdir(path)) {
3204 PyErr_SetString(PyExc_ImportError,
3205 "existing directory");
3206 return -1;
3207 }
Antoine Pitrouc83ea132010-05-09 14:46:46 +00003208 }
3209 return 0;
Phillip J. Ebyf7575d02006-07-28 21:12:07 +00003210}
3211
3212static PyObject *
3213NullImporter_find_module(NullImporter *self, PyObject *args)
3214{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00003215 Py_RETURN_NONE;
Phillip J. Ebyf7575d02006-07-28 21:12:07 +00003216}
3217
3218static PyMethodDef NullImporter_methods[] = {
Antoine Pitrouc83ea132010-05-09 14:46:46 +00003219 {"find_module", (PyCFunction)NullImporter_find_module, METH_VARARGS,
3220 "Always return None"
3221 },
3222 {NULL} /* Sentinel */
Phillip J. Ebyf7575d02006-07-28 21:12:07 +00003223};
3224
3225
Nick Coghlan327a39b2007-11-18 11:56:28 +00003226PyTypeObject PyNullImporter_Type = {
Antoine Pitrouc83ea132010-05-09 14:46:46 +00003227 PyVarObject_HEAD_INIT(NULL, 0)
3228 "imp.NullImporter", /*tp_name*/
3229 sizeof(NullImporter), /*tp_basicsize*/
3230 0, /*tp_itemsize*/
3231 0, /*tp_dealloc*/
3232 0, /*tp_print*/
3233 0, /*tp_getattr*/
3234 0, /*tp_setattr*/
3235 0, /*tp_compare*/
3236 0, /*tp_repr*/
3237 0, /*tp_as_number*/
3238 0, /*tp_as_sequence*/
3239 0, /*tp_as_mapping*/
3240 0, /*tp_hash */
3241 0, /*tp_call*/
3242 0, /*tp_str*/
3243 0, /*tp_getattro*/
3244 0, /*tp_setattro*/
3245 0, /*tp_as_buffer*/
3246 Py_TPFLAGS_DEFAULT, /*tp_flags*/
3247 "Null importer object", /* tp_doc */
3248 0, /* tp_traverse */
3249 0, /* tp_clear */
3250 0, /* tp_richcompare */
3251 0, /* tp_weaklistoffset */
3252 0, /* tp_iter */
3253 0, /* tp_iternext */
3254 NullImporter_methods, /* tp_methods */
3255 0, /* tp_members */
3256 0, /* tp_getset */
3257 0, /* tp_base */
3258 0, /* tp_dict */
3259 0, /* tp_descr_get */
3260 0, /* tp_descr_set */
3261 0, /* tp_dictoffset */
3262 (initproc)NullImporter_init, /* tp_init */
3263 0, /* tp_alloc */
3264 PyType_GenericNew /* tp_new */
Phillip J. Ebyf7575d02006-07-28 21:12:07 +00003265};
3266
3267
Jason Tishler6bc06ec2003-09-04 11:59:50 +00003268PyMODINIT_FUNC
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003269initimp(void)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003270{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00003271 PyObject *m, *d;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003272
Antoine Pitrouc83ea132010-05-09 14:46:46 +00003273 if (PyType_Ready(&PyNullImporter_Type) < 0)
3274 goto failure;
Phillip J. Ebyf7575d02006-07-28 21:12:07 +00003275
Antoine Pitrouc83ea132010-05-09 14:46:46 +00003276 m = Py_InitModule4("imp", imp_methods, doc_imp,
3277 NULL, PYTHON_API_VERSION);
3278 if (m == NULL)
3279 goto failure;
3280 d = PyModule_GetDict(m);
3281 if (d == NULL)
3282 goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003283
Antoine Pitrouc83ea132010-05-09 14:46:46 +00003284 if (setint(d, "SEARCH_ERROR", SEARCH_ERROR) < 0) goto failure;
3285 if (setint(d, "PY_SOURCE", PY_SOURCE) < 0) goto failure;
3286 if (setint(d, "PY_COMPILED", PY_COMPILED) < 0) goto failure;
3287 if (setint(d, "C_EXTENSION", C_EXTENSION) < 0) goto failure;
3288 if (setint(d, "PY_RESOURCE", PY_RESOURCE) < 0) goto failure;
3289 if (setint(d, "PKG_DIRECTORY", PKG_DIRECTORY) < 0) goto failure;
3290 if (setint(d, "C_BUILTIN", C_BUILTIN) < 0) goto failure;
3291 if (setint(d, "PY_FROZEN", PY_FROZEN) < 0) goto failure;
3292 if (setint(d, "PY_CODERESOURCE", PY_CODERESOURCE) < 0) goto failure;
3293 if (setint(d, "IMP_HOOK", IMP_HOOK) < 0) goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003294
Antoine Pitrouc83ea132010-05-09 14:46:46 +00003295 Py_INCREF(&PyNullImporter_Type);
3296 PyModule_AddObject(m, "NullImporter", (PyObject *)&PyNullImporter_Type);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003297 failure:
Antoine Pitrouc83ea132010-05-09 14:46:46 +00003298 ;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003299}
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003300
3301
Guido van Rossumb18618d2000-05-03 23:44:39 +00003302/* API for embedding applications that want to add their own entries
3303 to the table of built-in modules. This should normally be called
3304 *before* Py_Initialize(). When the table resize fails, -1 is
3305 returned and the existing table is unchanged.
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003306
3307 After a similar function by Just van Rossum. */
3308
3309int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003310PyImport_ExtendInittab(struct _inittab *newtab)
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003311{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00003312 static struct _inittab *our_copy = NULL;
3313 struct _inittab *p;
3314 int i, n;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003315
Antoine Pitrouc83ea132010-05-09 14:46:46 +00003316 /* Count the number of entries in both tables */
3317 for (n = 0; newtab[n].name != NULL; n++)
3318 ;
3319 if (n == 0)
3320 return 0; /* Nothing to do */
3321 for (i = 0; PyImport_Inittab[i].name != NULL; i++)
3322 ;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003323
Antoine Pitrouc83ea132010-05-09 14:46:46 +00003324 /* Allocate new memory for the combined table */
3325 p = our_copy;
3326 PyMem_RESIZE(p, struct _inittab, i+n+1);
3327 if (p == NULL)
3328 return -1;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003329
Antoine Pitrouc83ea132010-05-09 14:46:46 +00003330 /* Copy the tables into the new memory */
3331 if (our_copy != PyImport_Inittab)
3332 memcpy(p, PyImport_Inittab, (i+1) * sizeof(struct _inittab));
3333 PyImport_Inittab = our_copy = p;
3334 memcpy(p+i, newtab, (n+1) * sizeof(struct _inittab));
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003335
Antoine Pitrouc83ea132010-05-09 14:46:46 +00003336 return 0;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003337}
3338
3339/* Shorthand to add a single entry given a name and a function */
3340
3341int
Brett Cannonc4f90eb2009-04-02 03:17:39 +00003342PyImport_AppendInittab(const char *name, void (*initfunc)(void))
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003343{
Antoine Pitrouc83ea132010-05-09 14:46:46 +00003344 struct _inittab newtab[2];
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003345
Antoine Pitrouc83ea132010-05-09 14:46:46 +00003346 memset(newtab, '\0', sizeof newtab);
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003347
Antoine Pitrouc83ea132010-05-09 14:46:46 +00003348 newtab[0].name = (char *)name;
3349 newtab[0].initfunc = initfunc;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003350
Antoine Pitrouc83ea132010-05-09 14:46:46 +00003351 return PyImport_ExtendInittab(newtab);
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003352}
Anthony Baxterac6bd462006-04-13 02:06:09 +00003353
3354#ifdef __cplusplus
3355}
3356#endif