blob: bcdd68e0ef80ccdd208568e4f88c44c0d0a34691 [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
22extern "C" {
23#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
70 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:
76 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[] = {
Jack Jansenc88da1f2002-05-28 10:58:19 +0000102 {"/py", "U", PY_SOURCE},
Guido van Rossum48a680c2001-03-02 06:34:14 +0000103 {"/pyc", "rb", PY_COMPILED},
104 {0, 0}
105};
106#else
Guido van Rossumed1170e1999-12-20 21:23:41 +0000107static const struct filedescr _PyImport_StandardFiletab[] = {
Jack Jansenc88da1f2002-05-28 10:58:19 +0000108 {".py", "U", PY_SOURCE},
Martin v. Löwis6238d2b2002-06-30 15:26:10 +0000109#ifdef MS_WINDOWS
Jack Jansenc88da1f2002-05-28 10:58:19 +0000110 {".pyw", "U", PY_SOURCE},
Tim Peters36515e22001-11-18 04:06:29 +0000111#endif
Guido van Rossumed1170e1999-12-20 21:23:41 +0000112 {".pyc", "rb", PY_COMPILED},
113 {0, 0}
114};
Guido van Rossum48a680c2001-03-02 06:34:14 +0000115#endif
Guido van Rossumed1170e1999-12-20 21:23:41 +0000116
Phillip J. Ebyf7575d02006-07-28 21:12:07 +0000117
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000118/* Initialize things */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000119
120void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000121_PyImport_Init(void)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000122{
Guido van Rossumed1170e1999-12-20 21:23:41 +0000123 const struct filedescr *scan;
124 struct filedescr *filetab;
125 int countD = 0;
126 int countS = 0;
127
128 /* prepare _PyImport_Filetab: copy entries from
129 _PyImport_DynLoadFiletab and _PyImport_StandardFiletab.
130 */
Georg Brandladd36e52007-08-23 18:08:06 +0000131#ifdef HAVE_DYNAMIC_LOADING
Guido van Rossumed1170e1999-12-20 21:23:41 +0000132 for (scan = _PyImport_DynLoadFiletab; scan->suffix != NULL; ++scan)
133 ++countD;
Georg Brandladd36e52007-08-23 18:08:06 +0000134#endif
Guido van Rossumed1170e1999-12-20 21:23:41 +0000135 for (scan = _PyImport_StandardFiletab; scan->suffix != NULL; ++scan)
136 ++countS;
Guido van Rossumb18618d2000-05-03 23:44:39 +0000137 filetab = PyMem_NEW(struct filedescr, countD + countS + 1);
Neal Norwitze1fdb322006-07-21 05:32:28 +0000138 if (filetab == NULL)
Neal Norwitz33722ae2006-07-21 07:59:02 +0000139 Py_FatalError("Can't initialize import file table.");
Georg Brandladd36e52007-08-23 18:08:06 +0000140#ifdef HAVE_DYNAMIC_LOADING
Guido van Rossumed1170e1999-12-20 21:23:41 +0000141 memcpy(filetab, _PyImport_DynLoadFiletab,
142 countD * sizeof(struct filedescr));
Georg Brandladd36e52007-08-23 18:08:06 +0000143#endif
Guido van Rossumed1170e1999-12-20 21:23:41 +0000144 memcpy(filetab + countD, _PyImport_StandardFiletab,
145 countS * sizeof(struct filedescr));
146 filetab[countD + countS].suffix = NULL;
147
148 _PyImport_Filetab = filetab;
149
Guido van Rossum0824f631997-03-11 18:37:35 +0000150 if (Py_OptimizeFlag) {
Guido van Rossumed1170e1999-12-20 21:23:41 +0000151 /* Replace ".pyc" with ".pyo" in _PyImport_Filetab */
152 for (; filetab->suffix != NULL; filetab++) {
Guido van Rossum48a680c2001-03-02 06:34:14 +0000153#ifndef RISCOS
Guido van Rossumed1170e1999-12-20 21:23:41 +0000154 if (strcmp(filetab->suffix, ".pyc") == 0)
155 filetab->suffix = ".pyo";
Guido van Rossum48a680c2001-03-02 06:34:14 +0000156#else
157 if (strcmp(filetab->suffix, "/pyc") == 0)
158 filetab->suffix = "/pyo";
159#endif
Guido van Rossum0824f631997-03-11 18:37:35 +0000160 }
161 }
Guido van Rossum96774c12000-05-01 20:19:08 +0000162
163 if (Py_UnicodeFlag) {
164 /* Fix the pyc_magic so that byte compiled code created
165 using the all-Unicode method doesn't interfere with
166 code created in normal operation mode. */
167 pyc_magic = MAGIC + 1;
168 }
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000169}
170
Guido van Rossum25ce5661997-08-02 03:10:38 +0000171void
Just van Rossum52e14d62002-12-30 22:08:05 +0000172_PyImportHooks_Init(void)
173{
174 PyObject *v, *path_hooks = NULL, *zimpimport;
175 int err = 0;
176
177 /* adding sys.path_hooks and sys.path_importer_cache, setting up
178 zipimport */
Nick Coghlan327a39b2007-11-18 11:56:28 +0000179 if (PyType_Ready(&PyNullImporter_Type) < 0)
Phillip J. Ebyf7575d02006-07-28 21:12:07 +0000180 goto error;
Just van Rossum52e14d62002-12-30 22:08:05 +0000181
182 if (Py_VerboseFlag)
183 PySys_WriteStderr("# installing zipimport hook\n");
184
185 v = PyList_New(0);
186 if (v == NULL)
187 goto error;
188 err = PySys_SetObject("meta_path", v);
189 Py_DECREF(v);
190 if (err)
191 goto error;
192 v = PyDict_New();
193 if (v == NULL)
194 goto error;
195 err = PySys_SetObject("path_importer_cache", v);
196 Py_DECREF(v);
197 if (err)
198 goto error;
199 path_hooks = PyList_New(0);
200 if (path_hooks == NULL)
201 goto error;
202 err = PySys_SetObject("path_hooks", path_hooks);
203 if (err) {
204 error:
205 PyErr_Print();
Phillip J. Ebyf7575d02006-07-28 21:12:07 +0000206 Py_FatalError("initializing sys.meta_path, sys.path_hooks, "
207 "path_importer_cache, or NullImporter failed"
208 );
Just van Rossum52e14d62002-12-30 22:08:05 +0000209 }
Phillip J. Ebyf7575d02006-07-28 21:12:07 +0000210
Just van Rossum52e14d62002-12-30 22:08:05 +0000211 zimpimport = PyImport_ImportModule("zipimport");
212 if (zimpimport == NULL) {
213 PyErr_Clear(); /* No zip import module -- okay */
214 if (Py_VerboseFlag)
215 PySys_WriteStderr("# can't import zipimport\n");
216 }
217 else {
218 PyObject *zipimporter = PyObject_GetAttrString(zimpimport,
219 "zipimporter");
220 Py_DECREF(zimpimport);
221 if (zipimporter == NULL) {
222 PyErr_Clear(); /* No zipimporter object -- okay */
223 if (Py_VerboseFlag)
224 PySys_WriteStderr(
Fred Drake1e5fc552003-07-11 15:01:02 +0000225 "# can't import zipimport.zipimporter\n");
Just van Rossum52e14d62002-12-30 22:08:05 +0000226 }
227 else {
228 /* sys.path_hooks.append(zipimporter) */
229 err = PyList_Append(path_hooks, zipimporter);
230 Py_DECREF(zipimporter);
231 if (err)
232 goto error;
233 if (Py_VerboseFlag)
234 PySys_WriteStderr(
235 "# installed zipimport hook\n");
236 }
237 }
238 Py_DECREF(path_hooks);
239}
240
241void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000242_PyImport_Fini(void)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000243{
244 Py_XDECREF(extensions);
245 extensions = NULL;
Barry Warsaw84294482000-10-03 16:02:05 +0000246 PyMem_DEL(_PyImport_Filetab);
247 _PyImport_Filetab = NULL;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000248}
249
250
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000251/* Locking primitives to prevent parallel imports of the same module
252 in different threads to return with a partially loaded module.
253 These calls are serialized by the global interpreter lock. */
254
255#ifdef WITH_THREAD
256
Guido van Rossum49b56061998-10-01 20:42:43 +0000257#include "pythread.h"
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000258
Guido van Rossum65d5b571998-12-21 19:32:43 +0000259static PyThread_type_lock import_lock = 0;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000260static long import_lock_thread = -1;
261static int import_lock_level = 0;
262
Thomas Woutersc4dcb382009-09-16 19:55:54 +0000263void
264_PyImport_AcquireLock(void)
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000265{
Guido van Rossum65d5b571998-12-21 19:32:43 +0000266 long me = PyThread_get_thread_ident();
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000267 if (me == -1)
268 return; /* Too bad */
Neal Norwitze1fdb322006-07-21 05:32:28 +0000269 if (import_lock == NULL) {
Guido van Rossum65d5b571998-12-21 19:32:43 +0000270 import_lock = PyThread_allocate_lock();
Neal Norwitze1fdb322006-07-21 05:32:28 +0000271 if (import_lock == NULL)
272 return; /* Nothing much we can do. */
273 }
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000274 if (import_lock_thread == me) {
275 import_lock_level++;
276 return;
277 }
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000278 if (import_lock_thread != -1 || !PyThread_acquire_lock(import_lock, 0))
279 {
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000280 PyThreadState *tstate = PyEval_SaveThread();
Guido van Rossum65d5b571998-12-21 19:32:43 +0000281 PyThread_acquire_lock(import_lock, 1);
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000282 PyEval_RestoreThread(tstate);
283 }
284 import_lock_thread = me;
285 import_lock_level = 1;
286}
287
Thomas Woutersc4dcb382009-09-16 19:55:54 +0000288int
289_PyImport_ReleaseLock(void)
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000290{
Guido van Rossum65d5b571998-12-21 19:32:43 +0000291 long me = PyThread_get_thread_ident();
Neal Norwitze1fdb322006-07-21 05:32:28 +0000292 if (me == -1 || import_lock == NULL)
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000293 return 0; /* Too bad */
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000294 if (import_lock_thread != me)
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000295 return -1;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000296 import_lock_level--;
297 if (import_lock_level == 0) {
298 import_lock_thread = -1;
Guido van Rossum65d5b571998-12-21 19:32:43 +0000299 PyThread_release_lock(import_lock);
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000300 }
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000301 return 1;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000302}
303
Gregory P. Smith9e5d1322010-03-01 01:22:39 +0000304/* This function is called from PyOS_AfterFork to ensure that newly
305 created child processes do not share locks with the parent.
306 We now acquire the import lock around fork() calls but on some platforms
307 (Solaris 9 and earlier? see isue7242) that still left us with problems. */
Guido van Rossum8ee3e5a2005-09-14 18:09:42 +0000308
309void
310_PyImport_ReInitLock(void)
311{
Gregory P. Smith9e5d1322010-03-01 01:22:39 +0000312 if (import_lock != NULL)
313 import_lock = PyThread_allocate_lock();
314 import_lock_thread = -1;
315 import_lock_level = 0;
Guido van Rossum8ee3e5a2005-09-14 18:09:42 +0000316}
317
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000318#endif
319
Tim Peters69232342001-08-30 05:16:13 +0000320static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000321imp_lock_held(PyObject *self, PyObject *noargs)
Tim Peters69232342001-08-30 05:16:13 +0000322{
Tim Peters69232342001-08-30 05:16:13 +0000323#ifdef WITH_THREAD
Guido van Rossumb8bff3f2002-04-07 06:34:38 +0000324 return PyBool_FromLong(import_lock_thread != -1);
Tim Peters69232342001-08-30 05:16:13 +0000325#else
Guido van Rossumb8bff3f2002-04-07 06:34:38 +0000326 return PyBool_FromLong(0);
Tim Peters69232342001-08-30 05:16:13 +0000327#endif
328}
329
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000330static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000331imp_acquire_lock(PyObject *self, PyObject *noargs)
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000332{
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000333#ifdef WITH_THREAD
Thomas Woutersc4dcb382009-09-16 19:55:54 +0000334 _PyImport_AcquireLock();
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000335#endif
Neal Norwitz2294c0d2003-02-12 23:02:21 +0000336 Py_INCREF(Py_None);
337 return Py_None;
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000338}
339
340static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000341imp_release_lock(PyObject *self, PyObject *noargs)
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000342{
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000343#ifdef WITH_THREAD
Thomas Woutersc4dcb382009-09-16 19:55:54 +0000344 if (_PyImport_ReleaseLock() < 0) {
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000345 PyErr_SetString(PyExc_RuntimeError,
346 "not holding the import lock");
347 return NULL;
348 }
349#endif
Neal Norwitz2294c0d2003-02-12 23:02:21 +0000350 Py_INCREF(Py_None);
351 return Py_None;
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000352}
353
Collin Winter276887b2007-03-12 16:11:39 +0000354static void
Neal Norwitz75c7c802007-03-13 05:31:38 +0000355imp_modules_reloading_clear(void)
Collin Winter276887b2007-03-12 16:11:39 +0000356{
357 PyInterpreterState *interp = PyThreadState_Get()->interp;
Neal Norwitz75c7c802007-03-13 05:31:38 +0000358 if (interp->modules_reloading != NULL)
359 PyDict_Clear(interp->modules_reloading);
Collin Winter276887b2007-03-12 16:11:39 +0000360}
361
Guido van Rossum25ce5661997-08-02 03:10:38 +0000362/* Helper for sys */
363
364PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000365PyImport_GetModuleDict(void)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000366{
Nicholas Bastine5662ae2004-03-24 22:22:12 +0000367 PyInterpreterState *interp = PyThreadState_GET()->interp;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000368 if (interp->modules == NULL)
369 Py_FatalError("PyImport_GetModuleDict: no module dictionary!");
370 return interp->modules;
371}
372
Guido van Rossum3f5da241990-12-20 15:06:42 +0000373
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000374/* List of names to clear in sys */
375static char* sys_deletes[] = {
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000376 "path", "argv", "ps1", "ps2", "exitfunc",
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000377 "exc_type", "exc_value", "exc_traceback",
378 "last_type", "last_value", "last_traceback",
Just van Rossum52e14d62002-12-30 22:08:05 +0000379 "path_hooks", "path_importer_cache", "meta_path",
Christian Heimes0d924432008-01-30 17:21:22 +0000380 /* misc stuff */
381 "flags", "float_info",
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000382 NULL
383};
384
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000385static char* sys_files[] = {
386 "stdin", "__stdin__",
387 "stdout", "__stdout__",
388 "stderr", "__stderr__",
389 NULL
390};
391
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000392
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000393/* Un-initialize things, as good as we can */
Guido van Rossum3f5da241990-12-20 15:06:42 +0000394
Guido van Rossum3f5da241990-12-20 15:06:42 +0000395void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000396PyImport_Cleanup(void)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000397{
Martin v. Löwis18e16552006-02-15 17:27:45 +0000398 Py_ssize_t pos, ndone;
Guido van Rossum758eec01998-01-19 21:58:26 +0000399 char *name;
400 PyObject *key, *value, *dict;
Nicholas Bastine5662ae2004-03-24 22:22:12 +0000401 PyInterpreterState *interp = PyThreadState_GET()->interp;
Guido van Rossum758eec01998-01-19 21:58:26 +0000402 PyObject *modules = interp->modules;
403
404 if (modules == NULL)
405 return; /* Already done */
406
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000407 /* Delete some special variables first. These are common
408 places where user values hide and people complain when their
409 destructors fail. Since the modules containing them are
410 deleted *last* of all, they would come too late in the normal
411 destruction order. Sigh. */
412
413 value = PyDict_GetItemString(modules, "__builtin__");
414 if (value != NULL && PyModule_Check(value)) {
415 dict = PyModule_GetDict(value);
416 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000417 PySys_WriteStderr("# clear __builtin__._\n");
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000418 PyDict_SetItemString(dict, "_", Py_None);
419 }
420 value = PyDict_GetItemString(modules, "sys");
421 if (value != NULL && PyModule_Check(value)) {
422 char **p;
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000423 PyObject *v;
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000424 dict = PyModule_GetDict(value);
425 for (p = sys_deletes; *p != NULL; p++) {
426 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000427 PySys_WriteStderr("# clear sys.%s\n", *p);
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000428 PyDict_SetItemString(dict, *p, Py_None);
429 }
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000430 for (p = sys_files; *p != NULL; p+=2) {
431 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000432 PySys_WriteStderr("# restore sys.%s\n", *p);
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000433 v = PyDict_GetItemString(dict, *(p+1));
434 if (v == NULL)
435 v = Py_None;
436 PyDict_SetItemString(dict, *p, v);
437 }
438 }
439
440 /* First, delete __main__ */
441 value = PyDict_GetItemString(modules, "__main__");
442 if (value != NULL && PyModule_Check(value)) {
443 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000444 PySys_WriteStderr("# cleanup __main__\n");
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000445 _PyModule_Clear(value);
446 PyDict_SetItemString(modules, "__main__", Py_None);
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000447 }
448
Guido van Rossum758eec01998-01-19 21:58:26 +0000449 /* The special treatment of __builtin__ here is because even
450 when it's not referenced as a module, its dictionary is
451 referenced by almost every module's __builtins__. Since
452 deleting a module clears its dictionary (even if there are
453 references left to it), we need to delete the __builtin__
454 module last. Likewise, we don't delete sys until the very
455 end because it is implicitly referenced (e.g. by print).
456
457 Also note that we 'delete' modules by replacing their entry
458 in the modules dict with None, rather than really deleting
459 them; this avoids a rehash of the modules dictionary and
460 also marks them as "non existent" so they won't be
461 re-imported. */
462
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000463 /* Next, repeatedly delete modules with a reference count of
Guido van Rossum758eec01998-01-19 21:58:26 +0000464 one (skipping __builtin__ and sys) and delete them */
465 do {
466 ndone = 0;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000467 pos = 0;
Guido van Rossum758eec01998-01-19 21:58:26 +0000468 while (PyDict_Next(modules, &pos, &key, &value)) {
469 if (value->ob_refcnt != 1)
470 continue;
Gregory P. Smithdd96db62008-06-09 04:58:54 +0000471 if (PyString_Check(key) && PyModule_Check(value)) {
472 name = PyString_AS_STRING(key);
Guido van Rossum758eec01998-01-19 21:58:26 +0000473 if (strcmp(name, "__builtin__") == 0)
474 continue;
475 if (strcmp(name, "sys") == 0)
476 continue;
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000477 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000478 PySys_WriteStderr(
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000479 "# cleanup[1] %s\n", name);
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000480 _PyModule_Clear(value);
Guido van Rossum758eec01998-01-19 21:58:26 +0000481 PyDict_SetItem(modules, key, Py_None);
482 ndone++;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000483 }
484 }
Guido van Rossum758eec01998-01-19 21:58:26 +0000485 } while (ndone > 0);
486
Guido van Rossum758eec01998-01-19 21:58:26 +0000487 /* Next, delete all modules (still skipping __builtin__ and sys) */
488 pos = 0;
489 while (PyDict_Next(modules, &pos, &key, &value)) {
Gregory P. Smithdd96db62008-06-09 04:58:54 +0000490 if (PyString_Check(key) && PyModule_Check(value)) {
491 name = PyString_AS_STRING(key);
Guido van Rossum758eec01998-01-19 21:58:26 +0000492 if (strcmp(name, "__builtin__") == 0)
493 continue;
494 if (strcmp(name, "sys") == 0)
495 continue;
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000496 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000497 PySys_WriteStderr("# cleanup[2] %s\n", name);
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000498 _PyModule_Clear(value);
Guido van Rossum758eec01998-01-19 21:58:26 +0000499 PyDict_SetItem(modules, key, Py_None);
500 }
501 }
502
503 /* Next, delete sys and __builtin__ (in that order) */
504 value = PyDict_GetItemString(modules, "sys");
505 if (value != NULL && PyModule_Check(value)) {
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000506 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000507 PySys_WriteStderr("# cleanup sys\n");
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000508 _PyModule_Clear(value);
Guido van Rossum758eec01998-01-19 21:58:26 +0000509 PyDict_SetItemString(modules, "sys", Py_None);
510 }
511 value = PyDict_GetItemString(modules, "__builtin__");
512 if (value != NULL && PyModule_Check(value)) {
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000513 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000514 PySys_WriteStderr("# cleanup __builtin__\n");
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000515 _PyModule_Clear(value);
Guido van Rossum758eec01998-01-19 21:58:26 +0000516 PyDict_SetItemString(modules, "__builtin__", Py_None);
517 }
518
519 /* Finally, clear and delete the modules directory */
520 PyDict_Clear(modules);
521 interp->modules = NULL;
522 Py_DECREF(modules);
Collin Winter276887b2007-03-12 16:11:39 +0000523 Py_CLEAR(interp->modules_reloading);
Guido van Rossum8d15b5d1990-10-26 14:58:58 +0000524}
Guido van Rossum7f133ed1991-02-19 12:23:57 +0000525
526
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000527/* Helper for pythonrun.c -- return magic number */
528
529long
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000530PyImport_GetMagicNumber(void)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000531{
Guido van Rossum96774c12000-05-01 20:19:08 +0000532 return pyc_magic;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000533}
534
535
Guido van Rossum25ce5661997-08-02 03:10:38 +0000536/* Magic for extension modules (built-in as well as dynamically
537 loaded). To prevent initializing an extension module more than
538 once, we keep a static dictionary 'extensions' keyed by module name
539 (for built-in modules) or by filename (for dynamically loaded
Barry Warsaw92883382001-08-13 23:05:44 +0000540 modules), containing these modules. A copy of the module's
Guido van Rossum25ce5661997-08-02 03:10:38 +0000541 dictionary is stored by calling _PyImport_FixupExtension()
542 immediately after the module initialization function succeeds. A
543 copy can be retrieved from there by calling
544 _PyImport_FindExtension(). */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000545
Guido van Rossum79f25d91997-04-29 20:08:16 +0000546PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000547_PyImport_FixupExtension(char *name, char *filename)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000548{
Guido van Rossum25ce5661997-08-02 03:10:38 +0000549 PyObject *modules, *mod, *dict, *copy;
550 if (extensions == NULL) {
551 extensions = PyDict_New();
552 if (extensions == NULL)
553 return NULL;
554 }
555 modules = PyImport_GetModuleDict();
556 mod = PyDict_GetItemString(modules, name);
557 if (mod == NULL || !PyModule_Check(mod)) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000558 PyErr_Format(PyExc_SystemError,
559 "_PyImport_FixupExtension: module %.200s not loaded", name);
Guido van Rossum25ce5661997-08-02 03:10:38 +0000560 return NULL;
561 }
562 dict = PyModule_GetDict(mod);
563 if (dict == NULL)
564 return NULL;
Fred Drake9cd0efc2001-10-25 21:38:59 +0000565 copy = PyDict_Copy(dict);
Guido van Rossum25ce5661997-08-02 03:10:38 +0000566 if (copy == NULL)
567 return NULL;
568 PyDict_SetItemString(extensions, filename, copy);
569 Py_DECREF(copy);
570 return copy;
571}
572
573PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000574_PyImport_FindExtension(char *name, char *filename)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000575{
Fred Drake9cd0efc2001-10-25 21:38:59 +0000576 PyObject *dict, *mod, *mdict;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000577 if (extensions == NULL)
578 return NULL;
579 dict = PyDict_GetItemString(extensions, filename);
580 if (dict == NULL)
581 return NULL;
582 mod = PyImport_AddModule(name);
583 if (mod == NULL)
584 return NULL;
585 mdict = PyModule_GetDict(mod);
586 if (mdict == NULL)
587 return NULL;
Fred Drake9cd0efc2001-10-25 21:38:59 +0000588 if (PyDict_Update(mdict, dict))
Guido van Rossum25ce5661997-08-02 03:10:38 +0000589 return NULL;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000590 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000591 PySys_WriteStderr("import %s # previously loaded (%s)\n",
Guido van Rossum25ce5661997-08-02 03:10:38 +0000592 name, filename);
593 return mod;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000594}
595
596
597/* Get the module object corresponding to a module name.
598 First check the modules dictionary if there's one there,
Walter Dörwaldf0dfc7a2003-10-20 14:01:56 +0000599 if not, create a new one and insert it in the modules dictionary.
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000600 Because the former action is most common, THIS DOES NOT RETURN A
601 'NEW' REFERENCE! */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000602
Guido van Rossum79f25d91997-04-29 20:08:16 +0000603PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000604PyImport_AddModule(const char *name)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000605{
Guido van Rossum25ce5661997-08-02 03:10:38 +0000606 PyObject *modules = PyImport_GetModuleDict();
Guido van Rossum79f25d91997-04-29 20:08:16 +0000607 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000608
Guido van Rossum25ce5661997-08-02 03:10:38 +0000609 if ((m = PyDict_GetItemString(modules, name)) != NULL &&
Guido van Rossum79f25d91997-04-29 20:08:16 +0000610 PyModule_Check(m))
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000611 return m;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000612 m = PyModule_New(name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000613 if (m == NULL)
614 return NULL;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000615 if (PyDict_SetItemString(modules, name, m) != 0) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000616 Py_DECREF(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000617 return NULL;
618 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000619 Py_DECREF(m); /* Yes, it still exists, in modules! */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000620
621 return m;
622}
623
Tim Peters1cd70172004-08-02 03:52:12 +0000624/* Remove name from sys.modules, if it's there. */
625static void
626_RemoveModule(const char *name)
627{
628 PyObject *modules = PyImport_GetModuleDict();
629 if (PyDict_GetItemString(modules, name) == NULL)
630 return;
631 if (PyDict_DelItemString(modules, name) < 0)
632 Py_FatalError("import: deleting existing key in"
633 "sys.modules failed");
634}
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000635
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000636/* Execute a code object in a module and return the module object
Tim Peters1cd70172004-08-02 03:52:12 +0000637 * WITH INCREMENTED REFERENCE COUNT. If an error occurs, name is
638 * removed from sys.modules, to avoid leaving damaged module objects
639 * in sys.modules. The caller may wish to restore the original
640 * module object (if any) in this case; PyImport_ReloadModule is an
641 * example.
642 */
Guido van Rossum79f25d91997-04-29 20:08:16 +0000643PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000644PyImport_ExecCodeModule(char *name, PyObject *co)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000645{
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000646 return PyImport_ExecCodeModuleEx(name, co, (char *)NULL);
647}
648
649PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000650PyImport_ExecCodeModuleEx(char *name, PyObject *co, char *pathname)
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000651{
Guido van Rossum25ce5661997-08-02 03:10:38 +0000652 PyObject *modules = PyImport_GetModuleDict();
Guido van Rossum79f25d91997-04-29 20:08:16 +0000653 PyObject *m, *d, *v;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000654
Guido van Rossum79f25d91997-04-29 20:08:16 +0000655 m = PyImport_AddModule(name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000656 if (m == NULL)
657 return NULL;
Jeremy Hyltonecd91292004-01-02 23:25:32 +0000658 /* If the module is being reloaded, we get the old module back
659 and re-use its dict to exec the new code. */
Guido van Rossum79f25d91997-04-29 20:08:16 +0000660 d = PyModule_GetDict(m);
661 if (PyDict_GetItemString(d, "__builtins__") == NULL) {
662 if (PyDict_SetItemString(d, "__builtins__",
663 PyEval_GetBuiltins()) != 0)
Tim Peters1cd70172004-08-02 03:52:12 +0000664 goto error;
Guido van Rossum6135a871995-01-09 17:53:26 +0000665 }
Guido van Rossum9c9a07c1996-05-16 20:43:40 +0000666 /* Remember the filename as the __file__ attribute */
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000667 v = NULL;
668 if (pathname != NULL) {
Gregory P. Smithdd96db62008-06-09 04:58:54 +0000669 v = PyString_FromString(pathname);
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000670 if (v == NULL)
671 PyErr_Clear();
672 }
673 if (v == NULL) {
674 v = ((PyCodeObject *)co)->co_filename;
675 Py_INCREF(v);
676 }
677 if (PyDict_SetItemString(d, "__file__", v) != 0)
Guido van Rossum79f25d91997-04-29 20:08:16 +0000678 PyErr_Clear(); /* Not important enough to report */
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000679 Py_DECREF(v);
680
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000681 v = PyEval_EvalCode((PyCodeObject *)co, d, d);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000682 if (v == NULL)
Tim Peters1cd70172004-08-02 03:52:12 +0000683 goto error;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000684 Py_DECREF(v);
Guido van Rossumb65e85c1997-07-10 18:00:45 +0000685
Guido van Rossum25ce5661997-08-02 03:10:38 +0000686 if ((m = PyDict_GetItemString(modules, name)) == NULL) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000687 PyErr_Format(PyExc_ImportError,
688 "Loaded module %.200s not found in sys.modules",
689 name);
Guido van Rossumb65e85c1997-07-10 18:00:45 +0000690 return NULL;
691 }
692
Guido van Rossum79f25d91997-04-29 20:08:16 +0000693 Py_INCREF(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000694
695 return m;
Tim Peters1cd70172004-08-02 03:52:12 +0000696
697 error:
698 _RemoveModule(name);
699 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000700}
701
702
703/* Given a pathname for a Python source file, fill a buffer with the
704 pathname for the corresponding compiled file. Return the pathname
705 for the compiled file, or NULL if there's no space in the buffer.
706 Doesn't set an exception. */
707
708static char *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000709make_compiled_pathname(char *pathname, char *buf, size_t buflen)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000710{
Tim Petersc1731372001-08-04 08:12:36 +0000711 size_t len = strlen(pathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000712 if (len+2 > buflen)
713 return NULL;
Tim Petersc1731372001-08-04 08:12:36 +0000714
Martin v. Löwis6238d2b2002-06-30 15:26:10 +0000715#ifdef MS_WINDOWS
Tim Petersc1731372001-08-04 08:12:36 +0000716 /* Treat .pyw as if it were .py. The case of ".pyw" must match
717 that used in _PyImport_StandardFiletab. */
718 if (len >= 4 && strcmp(&pathname[len-4], ".pyw") == 0)
719 --len; /* pretend 'w' isn't there */
720#endif
721 memcpy(buf, pathname, len);
722 buf[len] = Py_OptimizeFlag ? 'o' : 'c';
723 buf[len+1] = '\0';
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000724
725 return buf;
726}
727
728
729/* Given a pathname for a Python source file, its time of last
730 modification, and a pathname for a compiled file, check whether the
731 compiled file represents the same version of the source. If so,
732 return a FILE pointer for the compiled file, positioned just after
733 the header; if not, return NULL.
734 Doesn't set an exception. */
735
736static FILE *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000737check_compiled_module(char *pathname, time_t mtime, char *cpathname)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000738{
739 FILE *fp;
740 long magic;
741 long pyc_mtime;
742
743 fp = fopen(cpathname, "rb");
744 if (fp == NULL)
745 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000746 magic = PyMarshal_ReadLongFromFile(fp);
Guido van Rossum96774c12000-05-01 20:19:08 +0000747 if (magic != pyc_magic) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000748 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000749 PySys_WriteStderr("# %s has bad magic\n", cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000750 fclose(fp);
751 return NULL;
752 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000753 pyc_mtime = PyMarshal_ReadLongFromFile(fp);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000754 if (pyc_mtime != mtime) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000755 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000756 PySys_WriteStderr("# %s has bad mtime\n", cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000757 fclose(fp);
758 return NULL;
759 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000760 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000761 PySys_WriteStderr("# %s matches %s\n", cpathname, pathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000762 return fp;
763}
764
765
766/* Read a code object from a file and check it for validity */
767
Guido van Rossum79f25d91997-04-29 20:08:16 +0000768static PyCodeObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000769read_compiled_module(char *cpathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000770{
Guido van Rossum79f25d91997-04-29 20:08:16 +0000771 PyObject *co;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000772
Tim Petersd9b9ac82001-01-28 00:27:39 +0000773 co = PyMarshal_ReadLastObjectFromFile(fp);
Armin Rigo01ab2792004-03-26 15:09:27 +0000774 if (co == NULL)
775 return NULL;
776 if (!PyCode_Check(co)) {
777 PyErr_Format(PyExc_ImportError,
778 "Non-code object in %.200s", cpathname);
779 Py_DECREF(co);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000780 return NULL;
781 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000782 return (PyCodeObject *)co;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000783}
784
785
786/* Load a module from a compiled file, execute it, and return its
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000787 module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000788
Guido van Rossum79f25d91997-04-29 20:08:16 +0000789static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000790load_compiled_module(char *name, char *cpathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000791{
792 long magic;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000793 PyCodeObject *co;
794 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000795
Guido van Rossum79f25d91997-04-29 20:08:16 +0000796 magic = PyMarshal_ReadLongFromFile(fp);
Guido van Rossum96774c12000-05-01 20:19:08 +0000797 if (magic != pyc_magic) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000798 PyErr_Format(PyExc_ImportError,
799 "Bad magic number in %.200s", cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000800 return NULL;
801 }
Guido van Rossum79f25d91997-04-29 20:08:16 +0000802 (void) PyMarshal_ReadLongFromFile(fp);
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000803 co = read_compiled_module(cpathname, fp);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000804 if (co == NULL)
805 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000806 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000807 PySys_WriteStderr("import %s # precompiled from %s\n",
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000808 name, cpathname);
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000809 m = PyImport_ExecCodeModuleEx(name, (PyObject *)co, cpathname);
Guido van Rossum79f25d91997-04-29 20:08:16 +0000810 Py_DECREF(co);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000811
812 return m;
813}
814
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000815/* Parse a source file and return the corresponding code object */
816
Guido van Rossum79f25d91997-04-29 20:08:16 +0000817static PyCodeObject *
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000818parse_source_module(const char *pathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000819{
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000820 PyCodeObject *co = NULL;
821 mod_ty mod;
Christian Heimes3c608332008-03-26 22:01:37 +0000822 PyCompilerFlags flags;
Neal Norwitz2a399b02006-09-11 04:28:16 +0000823 PyArena *arena = PyArena_New();
824 if (arena == NULL)
825 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000826
Christian Heimes7f23d862008-03-26 22:51:58 +0000827 flags.cf_flags = 0;
828
Christian Heimes3c608332008-03-26 22:01:37 +0000829 mod = PyParser_ASTFromFile(fp, pathname, Py_file_input, 0, 0, &flags,
Neal Norwitzadb69fc2005-12-17 20:54:49 +0000830 NULL, arena);
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000831 if (mod) {
Neal Norwitzadb69fc2005-12-17 20:54:49 +0000832 co = PyAST_Compile(mod, pathname, NULL, arena);
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000833 }
Neal Norwitz2a399b02006-09-11 04:28:16 +0000834 PyArena_Free(arena);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000835 return co;
836}
837
838
Guido van Rossum55a83382000-09-20 20:31:38 +0000839/* Helper to open a bytecode file for writing in exclusive mode */
840
841static FILE *
Christian Heimes40346852008-02-23 17:52:07 +0000842open_exclusive(char *filename, mode_t mode)
Guido van Rossum55a83382000-09-20 20:31:38 +0000843{
844#if defined(O_EXCL)&&defined(O_CREAT)&&defined(O_WRONLY)&&defined(O_TRUNC)
845 /* Use O_EXCL to avoid a race condition when another process tries to
846 write the same file. When that happens, our open() call fails,
847 which is just fine (since it's only a cache).
848 XXX If the file exists and is writable but the directory is not
849 writable, the file will never be written. Oh well.
850 */
851 int fd;
852 (void) unlink(filename);
Tim Peters42c83af2000-09-29 04:03:10 +0000853 fd = open(filename, O_EXCL|O_CREAT|O_WRONLY|O_TRUNC
854#ifdef O_BINARY
855 |O_BINARY /* necessary for Windows */
856#endif
Martin v. Löwis79acb9e2002-12-06 12:48:53 +0000857#ifdef __VMS
Christian Heimes40346852008-02-23 17:52:07 +0000858 , mode, "ctxt=bin", "shr=nil"
Martin v. Löwis79acb9e2002-12-06 12:48:53 +0000859#else
Christian Heimes40346852008-02-23 17:52:07 +0000860 , mode
Martin v. Löwis79acb9e2002-12-06 12:48:53 +0000861#endif
Martin v. Löwis18e16552006-02-15 17:27:45 +0000862 );
Guido van Rossum55a83382000-09-20 20:31:38 +0000863 if (fd < 0)
864 return NULL;
865 return fdopen(fd, "wb");
866#else
867 /* Best we can do -- on Windows this can't happen anyway */
868 return fopen(filename, "wb");
869#endif
870}
871
872
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000873/* Write a compiled module to a file, placing the time of last
874 modification of its source into the header.
875 Errors are ignored, if a write error occurs an attempt is made to
876 remove the file. */
877
878static void
Christian Heimes40346852008-02-23 17:52:07 +0000879write_compiled_module(PyCodeObject *co, char *cpathname, struct stat *srcstat)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000880{
881 FILE *fp;
Christian Heimes40346852008-02-23 17:52:07 +0000882 time_t mtime = srcstat->st_mtime;
R. David Murray3310a102009-07-07 09:54:16 +0000883#ifdef MS_WINDOWS /* since Windows uses different permissions */
884 mode_t mode = srcstat->st_mode & ~S_IEXEC;
885#else
R. David Murray23a736a2009-07-07 01:06:13 +0000886 mode_t mode = srcstat->st_mode & ~S_IXUSR & ~S_IXGRP & ~S_IXOTH;
887#endif
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000888
Christian Heimes40346852008-02-23 17:52:07 +0000889 fp = open_exclusive(cpathname, mode);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000890 if (fp == NULL) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000891 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000892 PySys_WriteStderr(
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000893 "# can't create %s\n", cpathname);
894 return;
895 }
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000896 PyMarshal_WriteLongToFile(pyc_magic, fp, Py_MARSHAL_VERSION);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000897 /* First write a 0 for mtime */
Martin v. Löwisef82d2f2004-06-27 16:51:46 +0000898 PyMarshal_WriteLongToFile(0L, fp, Py_MARSHAL_VERSION);
899 PyMarshal_WriteObjectToFile((PyObject *)co, fp, Py_MARSHAL_VERSION);
Armin Rigo01ab2792004-03-26 15:09:27 +0000900 if (fflush(fp) != 0 || ferror(fp)) {
Guido van Rossum79f25d91997-04-29 20:08:16 +0000901 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000902 PySys_WriteStderr("# can't write %s\n", cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000903 /* Don't keep partial file */
904 fclose(fp);
905 (void) unlink(cpathname);
906 return;
907 }
908 /* Now write the true mtime */
909 fseek(fp, 4L, 0);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000910 assert(mtime < LONG_MAX);
Martin v. Löwis725507b2006-03-07 12:08:51 +0000911 PyMarshal_WriteLongToFile((long)mtime, fp, Py_MARSHAL_VERSION);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000912 fflush(fp);
913 fclose(fp);
Guido van Rossum79f25d91997-04-29 20:08:16 +0000914 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +0000915 PySys_WriteStderr("# wrote %s\n", cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000916}
917
Antoine Pitroue96d4ea2009-01-06 18:10:47 +0000918static void
919update_code_filenames(PyCodeObject *co, PyObject *oldname, PyObject *newname)
920{
921 PyObject *constants, *tmp;
922 Py_ssize_t i, n;
923
924 if (!_PyString_Eq(co->co_filename, oldname))
925 return;
926
927 tmp = co->co_filename;
928 co->co_filename = newname;
929 Py_INCREF(co->co_filename);
930 Py_DECREF(tmp);
931
932 constants = co->co_consts;
933 n = PyTuple_GET_SIZE(constants);
934 for (i = 0; i < n; i++) {
935 tmp = PyTuple_GET_ITEM(constants, i);
936 if (PyCode_Check(tmp))
937 update_code_filenames((PyCodeObject *)tmp,
938 oldname, newname);
939 }
940}
941
942static int
943update_compiled_module(PyCodeObject *co, char *pathname)
944{
945 PyObject *oldname, *newname;
946
947 if (strcmp(PyString_AsString(co->co_filename), pathname) == 0)
948 return 0;
949
950 newname = PyString_FromString(pathname);
951 if (newname == NULL)
952 return -1;
953
954 oldname = co->co_filename;
955 Py_INCREF(oldname);
956 update_code_filenames(co, oldname, newname);
957 Py_DECREF(oldname);
958 Py_DECREF(newname);
959 return 1;
960}
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000961
962/* Load a source module from a given file and return its module
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000963 object WITH INCREMENTED REFERENCE COUNT. If there's a matching
964 byte-compiled file, use that instead. */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000965
Guido van Rossum79f25d91997-04-29 20:08:16 +0000966static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000967load_source_module(char *name, char *pathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000968{
Christian Heimes40346852008-02-23 17:52:07 +0000969 struct stat st;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000970 FILE *fpc;
971 char buf[MAXPATHLEN+1];
972 char *cpathname;
Guido van Rossum79f25d91997-04-29 20:08:16 +0000973 PyCodeObject *co;
974 PyObject *m;
Christian Heimes40346852008-02-23 17:52:07 +0000975
976 if (fstat(fileno(fp), &st) != 0) {
Neal Norwitz708e51a2005-10-03 04:48:15 +0000977 PyErr_Format(PyExc_RuntimeError,
Christian Heimes40346852008-02-23 17:52:07 +0000978 "unable to get file status from '%s'",
Neal Norwitz708e51a2005-10-03 04:48:15 +0000979 pathname);
Fred Drake4c82b232000-06-30 16:18:57 +0000980 return NULL;
Neal Norwitz708e51a2005-10-03 04:48:15 +0000981 }
Fred Drake4c82b232000-06-30 16:18:57 +0000982#if SIZEOF_TIME_T > 4
983 /* Python's .pyc timestamp handling presumes that the timestamp fits
984 in 4 bytes. This will be fine until sometime in the year 2038,
985 when a 4-byte signed time_t will overflow.
986 */
Christian Heimes40346852008-02-23 17:52:07 +0000987 if (st.st_mtime >> 32) {
Fred Drake4c82b232000-06-30 16:18:57 +0000988 PyErr_SetString(PyExc_OverflowError,
Fred Drakec63d3e92001-03-01 06:33:32 +0000989 "modification time overflows a 4 byte field");
Fred Drake4c82b232000-06-30 16:18:57 +0000990 return NULL;
991 }
992#endif
Tim Peters36515e22001-11-18 04:06:29 +0000993 cpathname = make_compiled_pathname(pathname, buf,
Jeremy Hylton37832f02001-04-13 17:50:20 +0000994 (size_t)MAXPATHLEN + 1);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000995 if (cpathname != NULL &&
Christian Heimes40346852008-02-23 17:52:07 +0000996 (fpc = check_compiled_module(pathname, st.st_mtime, cpathname))) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +0000997 co = read_compiled_module(cpathname, fpc);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000998 fclose(fpc);
999 if (co == NULL)
1000 return NULL;
Antoine Pitroue96d4ea2009-01-06 18:10:47 +00001001 if (update_compiled_module(co, pathname) < 0)
1002 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +00001003 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +00001004 PySys_WriteStderr("import %s # precompiled from %s\n",
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001005 name, cpathname);
Guido van Rossumafd3dae1998-08-25 18:44:34 +00001006 pathname = cpathname;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001007 }
1008 else {
1009 co = parse_source_module(pathname, fp);
1010 if (co == NULL)
1011 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +00001012 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +00001013 PySys_WriteStderr("import %s # from %s\n",
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001014 name, pathname);
Georg Brandl2da0fce2008-01-07 17:09:35 +00001015 if (cpathname) {
1016 PyObject *ro = PySys_GetObject("dont_write_bytecode");
1017 if (ro == NULL || !PyObject_IsTrue(ro))
Christian Heimes40346852008-02-23 17:52:07 +00001018 write_compiled_module(co, cpathname, &st);
Georg Brandl2da0fce2008-01-07 17:09:35 +00001019 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001020 }
Guido van Rossumafd3dae1998-08-25 18:44:34 +00001021 m = PyImport_ExecCodeModuleEx(name, (PyObject *)co, pathname);
Guido van Rossum79f25d91997-04-29 20:08:16 +00001022 Py_DECREF(co);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001023
1024 return m;
1025}
1026
1027
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001028/* Forward */
Just van Rossum52e14d62002-12-30 22:08:05 +00001029static PyObject *load_module(char *, FILE *, char *, int, PyObject *);
1030static struct filedescr *find_module(char *, char *, PyObject *,
1031 char *, size_t, FILE **, PyObject **);
Tim Petersdbd9ba62000-07-09 03:09:57 +00001032static struct _frozen *find_frozen(char *name);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001033
1034/* Load a package and return its module object WITH INCREMENTED
1035 REFERENCE COUNT */
1036
1037static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001038load_package(char *name, char *pathname)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001039{
Tim Peters1cd70172004-08-02 03:52:12 +00001040 PyObject *m, *d;
1041 PyObject *file = NULL;
1042 PyObject *path = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001043 int err;
1044 char buf[MAXPATHLEN+1];
1045 FILE *fp = NULL;
1046 struct filedescr *fdp;
1047
1048 m = PyImport_AddModule(name);
1049 if (m == NULL)
1050 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00001051 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +00001052 PySys_WriteStderr("import %s # directory %s\n",
Guido van Rossum17fc85f1997-09-06 18:52:03 +00001053 name, pathname);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001054 d = PyModule_GetDict(m);
Gregory P. Smithdd96db62008-06-09 04:58:54 +00001055 file = PyString_FromString(pathname);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001056 if (file == NULL)
Tim Peters1cd70172004-08-02 03:52:12 +00001057 goto error;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001058 path = Py_BuildValue("[O]", file);
Tim Peters1cd70172004-08-02 03:52:12 +00001059 if (path == NULL)
1060 goto error;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001061 err = PyDict_SetItemString(d, "__file__", file);
1062 if (err == 0)
1063 err = PyDict_SetItemString(d, "__path__", path);
Tim Peters1cd70172004-08-02 03:52:12 +00001064 if (err != 0)
1065 goto error;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001066 buf[0] = '\0';
Just van Rossum52e14d62002-12-30 22:08:05 +00001067 fdp = find_module(name, "__init__", path, buf, sizeof(buf), &fp, NULL);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001068 if (fdp == NULL) {
1069 if (PyErr_ExceptionMatches(PyExc_ImportError)) {
1070 PyErr_Clear();
Thomas Heller25653242004-06-07 15:04:10 +00001071 Py_INCREF(m);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001072 }
1073 else
1074 m = NULL;
1075 goto cleanup;
1076 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001077 m = load_module(name, fp, buf, fdp->type, NULL);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001078 if (fp != NULL)
1079 fclose(fp);
Tim Peters1cd70172004-08-02 03:52:12 +00001080 goto cleanup;
1081
1082 error:
1083 m = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001084 cleanup:
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001085 Py_XDECREF(path);
1086 Py_XDECREF(file);
1087 return m;
1088}
1089
1090
1091/* Helper to test for built-in module */
1092
1093static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001094is_builtin(char *name)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001095{
1096 int i;
Guido van Rossum771c6c81997-10-31 18:37:24 +00001097 for (i = 0; PyImport_Inittab[i].name != NULL; i++) {
1098 if (strcmp(name, PyImport_Inittab[i].name) == 0) {
1099 if (PyImport_Inittab[i].initfunc == NULL)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001100 return -1;
1101 else
1102 return 1;
1103 }
1104 }
1105 return 0;
1106}
1107
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001108
Just van Rossum52e14d62002-12-30 22:08:05 +00001109/* Return an importer object for a sys.path/pkg.__path__ item 'p',
1110 possibly by fetching it from the path_importer_cache dict. If it
Brett Cannon94b69f62006-09-28 22:10:14 +00001111 wasn't yet cached, traverse path_hooks until a hook is found
Just van Rossum52e14d62002-12-30 22:08:05 +00001112 that can handle the path item. Return None if no hook could;
1113 this tells our caller it should fall back to the builtin
1114 import mechanism. Cache the result in path_importer_cache.
1115 Returns a borrowed reference. */
1116
1117static PyObject *
1118get_path_importer(PyObject *path_importer_cache, PyObject *path_hooks,
1119 PyObject *p)
1120{
1121 PyObject *importer;
Martin v. Löwis725507b2006-03-07 12:08:51 +00001122 Py_ssize_t j, nhooks;
Just van Rossum52e14d62002-12-30 22:08:05 +00001123
1124 /* These conditions are the caller's responsibility: */
1125 assert(PyList_Check(path_hooks));
1126 assert(PyDict_Check(path_importer_cache));
1127
1128 nhooks = PyList_Size(path_hooks);
1129 if (nhooks < 0)
1130 return NULL; /* Shouldn't happen */
1131
1132 importer = PyDict_GetItem(path_importer_cache, p);
1133 if (importer != NULL)
1134 return importer;
1135
1136 /* set path_importer_cache[p] to None to avoid recursion */
1137 if (PyDict_SetItem(path_importer_cache, p, Py_None) != 0)
1138 return NULL;
1139
1140 for (j = 0; j < nhooks; j++) {
1141 PyObject *hook = PyList_GetItem(path_hooks, j);
1142 if (hook == NULL)
1143 return NULL;
Georg Brandl684fd0c2006-05-25 19:15:31 +00001144 importer = PyObject_CallFunctionObjArgs(hook, p, NULL);
Just van Rossum52e14d62002-12-30 22:08:05 +00001145 if (importer != NULL)
1146 break;
1147
1148 if (!PyErr_ExceptionMatches(PyExc_ImportError)) {
1149 return NULL;
1150 }
1151 PyErr_Clear();
1152 }
Phillip J. Ebyf7575d02006-07-28 21:12:07 +00001153 if (importer == NULL) {
1154 importer = PyObject_CallFunctionObjArgs(
Nick Coghlan327a39b2007-11-18 11:56:28 +00001155 (PyObject *)&PyNullImporter_Type, p, NULL
Phillip J. Ebyf7575d02006-07-28 21:12:07 +00001156 );
1157 if (importer == NULL) {
1158 if (PyErr_ExceptionMatches(PyExc_ImportError)) {
1159 PyErr_Clear();
1160 return Py_None;
1161 }
1162 }
1163 }
1164 if (importer != NULL) {
Just van Rossum52e14d62002-12-30 22:08:05 +00001165 int err = PyDict_SetItem(path_importer_cache, p, importer);
1166 Py_DECREF(importer);
1167 if (err != 0)
1168 return NULL;
1169 }
1170 return importer;
1171}
1172
Nick Coghlan327a39b2007-11-18 11:56:28 +00001173PyAPI_FUNC(PyObject *)
1174PyImport_GetImporter(PyObject *path) {
1175 PyObject *importer=NULL, *path_importer_cache=NULL, *path_hooks=NULL;
1176
1177 if ((path_importer_cache = PySys_GetObject("path_importer_cache"))) {
1178 if ((path_hooks = PySys_GetObject("path_hooks"))) {
1179 importer = get_path_importer(path_importer_cache,
1180 path_hooks, path);
1181 }
1182 }
1183 Py_XINCREF(importer); /* get_path_importer returns a borrowed reference */
1184 return importer;
1185}
1186
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001187/* Search the path (default sys.path) for a module. Return the
1188 corresponding filedescr struct, and (via return arguments) the
1189 pathname and an open file. Return NULL if the module is not found. */
1190
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001191#ifdef MS_COREDLL
Thomas Woutersb4bd21c2000-07-22 23:38:01 +00001192extern FILE *PyWin_FindRegisteredModule(const char *, struct filedescr **,
Martin v. Löwis18e16552006-02-15 17:27:45 +00001193 char *, Py_ssize_t);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001194#endif
1195
Martin v. Löwis18e16552006-02-15 17:27:45 +00001196static int case_ok(char *, Py_ssize_t, Py_ssize_t, char *);
Tim Petersdbd9ba62000-07-09 03:09:57 +00001197static int find_init_module(char *); /* Forward */
Just van Rossum52e14d62002-12-30 22:08:05 +00001198static struct filedescr importhookdescr = {"", "", IMP_HOOK};
Guido van Rossum197346f1997-10-31 18:38:52 +00001199
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001200static struct filedescr *
Just van Rossum52e14d62002-12-30 22:08:05 +00001201find_module(char *fullname, char *subname, PyObject *path, char *buf,
1202 size_t buflen, FILE **p_fp, PyObject **p_loader)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001203{
Martin v. Löwis725507b2006-03-07 12:08:51 +00001204 Py_ssize_t i, npath;
Fred Drake4c82b232000-06-30 16:18:57 +00001205 size_t len, namelen;
Guido van Rossum80bb9651996-12-05 23:27:02 +00001206 struct filedescr *fdp = NULL;
Jack Jansenc88da1f2002-05-28 10:58:19 +00001207 char *filemode;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001208 FILE *fp = NULL;
Just van Rossum52e14d62002-12-30 22:08:05 +00001209 PyObject *path_hooks, *path_importer_cache;
Guido van Rossum48a680c2001-03-02 06:34:14 +00001210#ifndef RISCOS
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001211 struct stat statbuf;
Guido van Rossum48a680c2001-03-02 06:34:14 +00001212#endif
Guido van Rossuma5568d31998-03-05 03:45:08 +00001213 static struct filedescr fd_frozen = {"", "", PY_FROZEN};
1214 static struct filedescr fd_builtin = {"", "", C_BUILTIN};
1215 static struct filedescr fd_package = {"", "", PKG_DIRECTORY};
Guido van Rossum0506a431998-08-11 15:07:39 +00001216 char name[MAXPATHLEN+1];
Andrew MacIntyred9400542002-02-26 11:41:34 +00001217#if defined(PYOS_OS2)
1218 size_t saved_len;
1219 size_t saved_namelen;
1220 char *saved_buf = NULL;
1221#endif
Just van Rossum52e14d62002-12-30 22:08:05 +00001222 if (p_loader != NULL)
1223 *p_loader = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001224
Just van Rossum52e14d62002-12-30 22:08:05 +00001225 if (strlen(subname) > MAXPATHLEN) {
Guido van Rossum8f4d3312001-10-18 18:54:11 +00001226 PyErr_SetString(PyExc_OverflowError,
1227 "module name is too long");
Fred Drake4c82b232000-06-30 16:18:57 +00001228 return NULL;
1229 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001230 strcpy(name, subname);
1231
1232 /* sys.meta_path import hook */
1233 if (p_loader != NULL) {
1234 PyObject *meta_path;
1235
1236 meta_path = PySys_GetObject("meta_path");
1237 if (meta_path == NULL || !PyList_Check(meta_path)) {
1238 PyErr_SetString(PyExc_ImportError,
1239 "sys.meta_path must be a list of "
1240 "import hooks");
1241 return NULL;
1242 }
1243 Py_INCREF(meta_path); /* zap guard */
1244 npath = PyList_Size(meta_path);
1245 for (i = 0; i < npath; i++) {
1246 PyObject *loader;
1247 PyObject *hook = PyList_GetItem(meta_path, i);
1248 loader = PyObject_CallMethod(hook, "find_module",
1249 "sO", fullname,
1250 path != NULL ?
1251 path : Py_None);
1252 if (loader == NULL) {
1253 Py_DECREF(meta_path);
1254 return NULL; /* true error */
1255 }
1256 if (loader != Py_None) {
1257 /* a loader was found */
1258 *p_loader = loader;
1259 Py_DECREF(meta_path);
1260 return &importhookdescr;
1261 }
1262 Py_DECREF(loader);
1263 }
1264 Py_DECREF(meta_path);
1265 }
Guido van Rossum0506a431998-08-11 15:07:39 +00001266
Gregory P. Smithdd96db62008-06-09 04:58:54 +00001267 if (path != NULL && PyString_Check(path)) {
Guido van Rossum8f4d3312001-10-18 18:54:11 +00001268 /* The only type of submodule allowed inside a "frozen"
1269 package are other frozen modules or packages. */
Gregory P. Smithdd96db62008-06-09 04:58:54 +00001270 if (PyString_Size(path) + 1 + strlen(name) >= (size_t)buflen) {
Guido van Rossum0506a431998-08-11 15:07:39 +00001271 PyErr_SetString(PyExc_ImportError,
1272 "full frozen module name too long");
1273 return NULL;
1274 }
Gregory P. Smithdd96db62008-06-09 04:58:54 +00001275 strcpy(buf, PyString_AsString(path));
Guido van Rossum0506a431998-08-11 15:07:39 +00001276 strcat(buf, ".");
1277 strcat(buf, name);
1278 strcpy(name, buf);
Guido van Rossum8f4d3312001-10-18 18:54:11 +00001279 if (find_frozen(name) != NULL) {
1280 strcpy(buf, name);
1281 return &fd_frozen;
1282 }
1283 PyErr_Format(PyExc_ImportError,
1284 "No frozen submodule named %.200s", name);
1285 return NULL;
Guido van Rossum0506a431998-08-11 15:07:39 +00001286 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001287 if (path == NULL) {
1288 if (is_builtin(name)) {
Guido van Rossuma5568d31998-03-05 03:45:08 +00001289 strcpy(buf, name);
1290 return &fd_builtin;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001291 }
Greg Ward201baee2001-10-04 14:52:06 +00001292 if ((find_frozen(name)) != NULL) {
Guido van Rossuma5568d31998-03-05 03:45:08 +00001293 strcpy(buf, name);
1294 return &fd_frozen;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001295 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001296
Guido van Rossumac279101996-08-22 23:10:58 +00001297#ifdef MS_COREDLL
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001298 fp = PyWin_FindRegisteredModule(name, &fdp, buf, buflen);
1299 if (fp != NULL) {
1300 *p_fp = fp;
1301 return fdp;
1302 }
Guido van Rossuma5a3db71996-04-09 02:39:59 +00001303#endif
Guido van Rossuma5568d31998-03-05 03:45:08 +00001304 path = PySys_GetObject("path");
1305 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00001306 if (path == NULL || !PyList_Check(path)) {
1307 PyErr_SetString(PyExc_ImportError,
Guido van Rossuma5568d31998-03-05 03:45:08 +00001308 "sys.path must be a list of directory names");
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001309 return NULL;
1310 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001311
1312 path_hooks = PySys_GetObject("path_hooks");
1313 if (path_hooks == NULL || !PyList_Check(path_hooks)) {
1314 PyErr_SetString(PyExc_ImportError,
1315 "sys.path_hooks must be a list of "
1316 "import hooks");
1317 return NULL;
1318 }
1319 path_importer_cache = PySys_GetObject("path_importer_cache");
1320 if (path_importer_cache == NULL ||
1321 !PyDict_Check(path_importer_cache)) {
1322 PyErr_SetString(PyExc_ImportError,
1323 "sys.path_importer_cache must be a dict");
1324 return NULL;
1325 }
1326
Guido van Rossum79f25d91997-04-29 20:08:16 +00001327 npath = PyList_Size(path);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001328 namelen = strlen(name);
1329 for (i = 0; i < npath; i++) {
Walter Dörwald3430d702002-06-17 10:43:59 +00001330 PyObject *copy = NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +00001331 PyObject *v = PyList_GetItem(path, i);
Neal Norwitz3cb31ac2006-08-13 18:10:47 +00001332 if (!v)
1333 return NULL;
Walter Dörwald3430d702002-06-17 10:43:59 +00001334#ifdef Py_USING_UNICODE
1335 if (PyUnicode_Check(v)) {
1336 copy = PyUnicode_Encode(PyUnicode_AS_UNICODE(v),
1337 PyUnicode_GET_SIZE(v), Py_FileSystemDefaultEncoding, NULL);
1338 if (copy == NULL)
1339 return NULL;
1340 v = copy;
1341 }
1342 else
1343#endif
Gregory P. Smithdd96db62008-06-09 04:58:54 +00001344 if (!PyString_Check(v))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001345 continue;
Gregory P. Smithdd96db62008-06-09 04:58:54 +00001346 len = PyString_GET_SIZE(v);
Walter Dörwald3430d702002-06-17 10:43:59 +00001347 if (len + 2 + namelen + MAXSUFFIXSIZE >= buflen) {
1348 Py_XDECREF(copy);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001349 continue; /* Too long */
Walter Dörwald3430d702002-06-17 10:43:59 +00001350 }
Gregory P. Smithdd96db62008-06-09 04:58:54 +00001351 strcpy(buf, PyString_AS_STRING(v));
Walter Dörwald3430d702002-06-17 10:43:59 +00001352 if (strlen(buf) != len) {
1353 Py_XDECREF(copy);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001354 continue; /* v contains '\0' */
Walter Dörwald3430d702002-06-17 10:43:59 +00001355 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001356
1357 /* sys.path_hooks import hook */
1358 if (p_loader != NULL) {
1359 PyObject *importer;
1360
1361 importer = get_path_importer(path_importer_cache,
1362 path_hooks, v);
Neal Norwitza4df11d2006-07-06 04:28:59 +00001363 if (importer == NULL) {
1364 Py_XDECREF(copy);
Just van Rossum52e14d62002-12-30 22:08:05 +00001365 return NULL;
Neal Norwitza4df11d2006-07-06 04:28:59 +00001366 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001367 /* Note: importer is a borrowed reference */
Phillip J. Ebyf7575d02006-07-28 21:12:07 +00001368 if (importer != Py_None) {
Just van Rossum52e14d62002-12-30 22:08:05 +00001369 PyObject *loader;
1370 loader = PyObject_CallMethod(importer,
1371 "find_module",
1372 "s", fullname);
Neal Norwitza4df11d2006-07-06 04:28:59 +00001373 Py_XDECREF(copy);
Just van Rossum52e14d62002-12-30 22:08:05 +00001374 if (loader == NULL)
1375 return NULL; /* error */
1376 if (loader != Py_None) {
1377 /* a loader was found */
1378 *p_loader = loader;
1379 return &importhookdescr;
1380 }
1381 Py_DECREF(loader);
Georg Brandlf4ef1162006-05-26 18:03:31 +00001382 continue;
Just van Rossum52e14d62002-12-30 22:08:05 +00001383 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001384 }
Georg Brandlf4ef1162006-05-26 18:03:31 +00001385 /* no hook was found, use builtin import */
Just van Rossum52e14d62002-12-30 22:08:05 +00001386
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001387 if (len > 0 && buf[len-1] != SEP
1388#ifdef ALTSEP
1389 && buf[len-1] != ALTSEP
1390#endif
1391 )
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001392 buf[len++] = SEP;
Guido van Rossum215c3402000-11-13 17:26:32 +00001393 strcpy(buf+len, name);
1394 len += namelen;
Tim Peters50d8d372001-02-28 05:34:27 +00001395
1396 /* Check for package import (buf holds a directory name,
1397 and there's an __init__ module in that directory */
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001398#ifdef HAVE_STAT
Walter Dörwald3430d702002-06-17 10:43:59 +00001399 if (stat(buf, &statbuf) == 0 && /* it exists */
1400 S_ISDIR(statbuf.st_mode) && /* it's a directory */
Thomas Wouters9df4e6f2006-04-27 23:13:20 +00001401 case_ok(buf, len, namelen, name)) { /* case matches */
1402 if (find_init_module(buf)) { /* and has __init__.py */
1403 Py_XDECREF(copy);
1404 return &fd_package;
1405 }
1406 else {
1407 char warnstr[MAXPATHLEN+80];
1408 sprintf(warnstr, "Not importing directory "
1409 "'%.*s': missing __init__.py",
1410 MAXPATHLEN, buf);
1411 if (PyErr_Warn(PyExc_ImportWarning,
1412 warnstr)) {
1413 Py_XDECREF(copy);
1414 return NULL;
1415 }
1416 }
Walter Dörwald3430d702002-06-17 10:43:59 +00001417 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001418#else
1419 /* XXX How are you going to test for directories? */
Guido van Rossum48a680c2001-03-02 06:34:14 +00001420#ifdef RISCOS
Guido van Rossume2ae77b2001-10-24 20:42:55 +00001421 if (isdir(buf) &&
Walter Dörwald3430d702002-06-17 10:43:59 +00001422 case_ok(buf, len, namelen, name)) {
Thomas Wouters9df4e6f2006-04-27 23:13:20 +00001423 if (find_init_module(buf)) {
1424 Py_XDECREF(copy);
1425 return &fd_package;
1426 }
1427 else {
1428 char warnstr[MAXPATHLEN+80];
1429 sprintf(warnstr, "Not importing directory "
1430 "'%.*s': missing __init__.py",
1431 MAXPATHLEN, buf);
1432 if (PyErr_Warn(PyExc_ImportWarning,
1433 warnstr)) {
1434 Py_XDECREF(copy);
1435 return NULL;
1436 }
Walter Dörwald3430d702002-06-17 10:43:59 +00001437 }
Guido van Rossum48a680c2001-03-02 06:34:14 +00001438#endif
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001439#endif
Andrew MacIntyred9400542002-02-26 11:41:34 +00001440#if defined(PYOS_OS2)
1441 /* take a snapshot of the module spec for restoration
1442 * after the 8 character DLL hackery
1443 */
1444 saved_buf = strdup(buf);
1445 saved_len = len;
1446 saved_namelen = namelen;
1447#endif /* PYOS_OS2 */
Guido van Rossum79f25d91997-04-29 20:08:16 +00001448 for (fdp = _PyImport_Filetab; fdp->suffix != NULL; fdp++) {
Georg Brandladd36e52007-08-23 18:08:06 +00001449#if defined(PYOS_OS2) && defined(HAVE_DYNAMIC_LOADING)
Jeremy Hylton4ae6fae2002-05-30 17:15:25 +00001450 /* OS/2 limits DLLs to 8 character names (w/o
1451 extension)
Andrew MacIntyred9400542002-02-26 11:41:34 +00001452 * so if the name is longer than that and its a
1453 * dynamically loaded module we're going to try,
1454 * truncate the name before trying
1455 */
Just van Rossum52e14d62002-12-30 22:08:05 +00001456 if (strlen(subname) > 8) {
Andrew MacIntyred9400542002-02-26 11:41:34 +00001457 /* is this an attempt to load a C extension? */
Jeremy Hylton4ae6fae2002-05-30 17:15:25 +00001458 const struct filedescr *scan;
1459 scan = _PyImport_DynLoadFiletab;
Andrew MacIntyred9400542002-02-26 11:41:34 +00001460 while (scan->suffix != NULL) {
Jeremy Hylton4ae6fae2002-05-30 17:15:25 +00001461 if (!strcmp(scan->suffix, fdp->suffix))
Andrew MacIntyred9400542002-02-26 11:41:34 +00001462 break;
1463 else
1464 scan++;
1465 }
1466 if (scan->suffix != NULL) {
1467 /* yes, so truncate the name */
1468 namelen = 8;
Just van Rossum52e14d62002-12-30 22:08:05 +00001469 len -= strlen(subname) - namelen;
Andrew MacIntyred9400542002-02-26 11:41:34 +00001470 buf[len] = '\0';
1471 }
1472 }
1473#endif /* PYOS_OS2 */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001474 strcpy(buf+len, fdp->suffix);
Guido van Rossum79f25d91997-04-29 20:08:16 +00001475 if (Py_VerboseFlag > 1)
Guido van Rossum2f3667a1998-10-12 18:23:55 +00001476 PySys_WriteStderr("# trying %s\n", buf);
Jack Jansenc88da1f2002-05-28 10:58:19 +00001477 filemode = fdp->mode;
Tim Peters86c7d2f2004-08-01 23:24:21 +00001478 if (filemode[0] == 'U')
Jeremy Hylton4ae6fae2002-05-30 17:15:25 +00001479 filemode = "r" PY_STDIOTEXTMODE;
Jack Jansenc88da1f2002-05-28 10:58:19 +00001480 fp = fopen(buf, filemode);
Tim Peters50d8d372001-02-28 05:34:27 +00001481 if (fp != NULL) {
1482 if (case_ok(buf, len, namelen, name))
1483 break;
1484 else { /* continue search */
1485 fclose(fp);
1486 fp = NULL;
Barry Warsaw914a0b12001-02-02 19:12:16 +00001487 }
Barry Warsaw914a0b12001-02-02 19:12:16 +00001488 }
Andrew MacIntyred9400542002-02-26 11:41:34 +00001489#if defined(PYOS_OS2)
1490 /* restore the saved snapshot */
1491 strcpy(buf, saved_buf);
1492 len = saved_len;
1493 namelen = saved_namelen;
1494#endif
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001495 }
Andrew MacIntyred9400542002-02-26 11:41:34 +00001496#if defined(PYOS_OS2)
1497 /* don't need/want the module name snapshot anymore */
1498 if (saved_buf)
1499 {
1500 free(saved_buf);
1501 saved_buf = NULL;
1502 }
1503#endif
Walter Dörwald3430d702002-06-17 10:43:59 +00001504 Py_XDECREF(copy);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001505 if (fp != NULL)
1506 break;
1507 }
1508 if (fp == NULL) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001509 PyErr_Format(PyExc_ImportError,
1510 "No module named %.200s", name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001511 return NULL;
1512 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001513 *p_fp = fp;
1514 return fdp;
1515}
1516
Raymond Hettingerdb29e0f2004-10-07 06:46:25 +00001517/* Helpers for main.c
1518 * Find the source file corresponding to a named module
1519 */
1520struct filedescr *
1521_PyImport_FindModule(const char *name, PyObject *path, char *buf,
1522 size_t buflen, FILE **p_fp, PyObject **p_loader)
1523{
1524 return find_module((char *) name, (char *) name, path,
1525 buf, buflen, p_fp, p_loader);
1526}
1527
1528PyAPI_FUNC(int) _PyImport_IsScript(struct filedescr * fd)
1529{
1530 return fd->type == PY_SOURCE || fd->type == PY_COMPILED;
1531}
1532
Martin v. Löwis18e16552006-02-15 17:27:45 +00001533/* case_ok(char* buf, Py_ssize_t len, Py_ssize_t namelen, char* name)
Tim Petersd1e87a82001-03-01 18:12:00 +00001534 * The arguments here are tricky, best shown by example:
1535 * /a/b/c/d/e/f/g/h/i/j/k/some_long_module_name.py\0
1536 * ^ ^ ^ ^
1537 * |--------------------- buf ---------------------|
1538 * |------------------- len ------------------|
1539 * |------ name -------|
1540 * |----- namelen -----|
1541 * buf is the full path, but len only counts up to (& exclusive of) the
1542 * extension. name is the module name, also exclusive of extension.
1543 *
1544 * We've already done a successful stat() or fopen() on buf, so know that
1545 * there's some match, possibly case-insensitive.
1546 *
Tim Peters50d8d372001-02-28 05:34:27 +00001547 * case_ok() is to return 1 if there's a case-sensitive match for
1548 * name, else 0. case_ok() is also to return 1 if envar PYTHONCASEOK
1549 * exists.
Tim Petersd1e87a82001-03-01 18:12:00 +00001550 *
Tim Peters50d8d372001-02-28 05:34:27 +00001551 * case_ok() is used to implement case-sensitive import semantics even
1552 * on platforms with case-insensitive filesystems. It's trivial to implement
1553 * for case-sensitive filesystems. It's pretty much a cross-platform
1554 * nightmare for systems with case-insensitive filesystems.
1555 */
Guido van Rossum0980bd91998-02-13 17:18:36 +00001556
Tim Peters50d8d372001-02-28 05:34:27 +00001557/* First we may need a pile of platform-specific header files; the sequence
1558 * of #if's here should match the sequence in the body of case_ok().
1559 */
Jason Tishler7961aa62005-05-20 00:56:54 +00001560#if defined(MS_WINDOWS)
Guido van Rossum0980bd91998-02-13 17:18:36 +00001561#include <windows.h>
Guido van Rossum4c3f57c2001-01-10 20:40:46 +00001562
Tim Peters50d8d372001-02-28 05:34:27 +00001563#elif defined(DJGPP)
1564#include <dir.h>
1565
Jason Tishler7961aa62005-05-20 00:56:54 +00001566#elif (defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) && defined(HAVE_DIRENT_H)
Tim Peters430f5d42001-03-01 01:30:56 +00001567#include <sys/types.h>
1568#include <dirent.h>
1569
Andrew MacIntyred9400542002-02-26 11:41:34 +00001570#elif defined(PYOS_OS2)
1571#define INCL_DOS
1572#define INCL_DOSERRORS
1573#define INCL_NOPMAPI
1574#include <os2.h>
1575
Guido van Rossume2ae77b2001-10-24 20:42:55 +00001576#elif defined(RISCOS)
1577#include "oslib/osfscontrol.h"
Tim Peters50d8d372001-02-28 05:34:27 +00001578#endif
1579
Guido van Rossum0980bd91998-02-13 17:18:36 +00001580static int
Martin v. Löwis18e16552006-02-15 17:27:45 +00001581case_ok(char *buf, Py_ssize_t len, Py_ssize_t namelen, char *name)
Guido van Rossum0980bd91998-02-13 17:18:36 +00001582{
Tim Peters50d8d372001-02-28 05:34:27 +00001583/* Pick a platform-specific implementation; the sequence of #if's here should
1584 * match the sequence just above.
1585 */
1586
Jason Tishler7961aa62005-05-20 00:56:54 +00001587/* MS_WINDOWS */
1588#if defined(MS_WINDOWS)
Guido van Rossum0980bd91998-02-13 17:18:36 +00001589 WIN32_FIND_DATA data;
1590 HANDLE h;
Tim Peters50d8d372001-02-28 05:34:27 +00001591
Neil Schemenauer7d4bb9f2001-07-23 16:30:27 +00001592 if (Py_GETENV("PYTHONCASEOK") != NULL)
Guido van Rossum0980bd91998-02-13 17:18:36 +00001593 return 1;
Tim Peters50d8d372001-02-28 05:34:27 +00001594
Guido van Rossum0980bd91998-02-13 17:18:36 +00001595 h = FindFirstFile(buf, &data);
1596 if (h == INVALID_HANDLE_VALUE) {
1597 PyErr_Format(PyExc_NameError,
1598 "Can't find file for module %.100s\n(filename %.300s)",
1599 name, buf);
1600 return 0;
1601 }
1602 FindClose(h);
Tim Peters50d8d372001-02-28 05:34:27 +00001603 return strncmp(data.cFileName, name, namelen) == 0;
1604
1605/* DJGPP */
1606#elif defined(DJGPP)
1607 struct ffblk ffblk;
1608 int done;
1609
Neil Schemenauer7d4bb9f2001-07-23 16:30:27 +00001610 if (Py_GETENV("PYTHONCASEOK") != NULL)
Guido van Rossum323bf5e1998-06-24 03:54:06 +00001611 return 1;
Tim Peters50d8d372001-02-28 05:34:27 +00001612
1613 done = findfirst(buf, &ffblk, FA_ARCH|FA_RDONLY|FA_HIDDEN|FA_DIREC);
1614 if (done) {
Guido van Rossum0980bd91998-02-13 17:18:36 +00001615 PyErr_Format(PyExc_NameError,
Tim Peters50d8d372001-02-28 05:34:27 +00001616 "Can't find file for module %.100s\n(filename %.300s)",
Guido van Rossum0980bd91998-02-13 17:18:36 +00001617 name, buf);
1618 return 0;
1619 }
Tim Peters50d8d372001-02-28 05:34:27 +00001620 return strncmp(ffblk.ff_name, name, namelen) == 0;
Guido van Rossum0980bd91998-02-13 17:18:36 +00001621
Jason Tishler7961aa62005-05-20 00:56:54 +00001622/* new-fangled macintosh (macosx) or Cygwin */
1623#elif (defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) && defined(HAVE_DIRENT_H)
Tim Peters430f5d42001-03-01 01:30:56 +00001624 DIR *dirp;
1625 struct dirent *dp;
Tim Petersd1e87a82001-03-01 18:12:00 +00001626 char dirname[MAXPATHLEN + 1];
1627 const int dirlen = len - namelen - 1; /* don't want trailing SEP */
Tim Peters430f5d42001-03-01 01:30:56 +00001628
Neil Schemenauer7d4bb9f2001-07-23 16:30:27 +00001629 if (Py_GETENV("PYTHONCASEOK") != NULL)
Tim Petersdbe6ebb2001-03-01 08:47:29 +00001630 return 1;
1631
Tim Petersd1e87a82001-03-01 18:12:00 +00001632 /* Copy the dir component into dirname; substitute "." if empty */
1633 if (dirlen <= 0) {
1634 dirname[0] = '.';
1635 dirname[1] = '\0';
Tim Peters430f5d42001-03-01 01:30:56 +00001636 }
1637 else {
Tim Petersd1e87a82001-03-01 18:12:00 +00001638 assert(dirlen <= MAXPATHLEN);
1639 memcpy(dirname, buf, dirlen);
1640 dirname[dirlen] = '\0';
Tim Peters430f5d42001-03-01 01:30:56 +00001641 }
1642 /* Open the directory and search the entries for an exact match. */
Tim Petersd1e87a82001-03-01 18:12:00 +00001643 dirp = opendir(dirname);
Tim Peters430f5d42001-03-01 01:30:56 +00001644 if (dirp) {
Tim Peters677898a2001-03-02 03:28:03 +00001645 char *nameWithExt = buf + len - namelen;
Tim Peters430f5d42001-03-01 01:30:56 +00001646 while ((dp = readdir(dirp)) != NULL) {
Tim Petersdbe6ebb2001-03-01 08:47:29 +00001647 const int thislen =
Tim Peters430f5d42001-03-01 01:30:56 +00001648#ifdef _DIRENT_HAVE_D_NAMELEN
Tim Petersdbe6ebb2001-03-01 08:47:29 +00001649 dp->d_namlen;
Tim Peters430f5d42001-03-01 01:30:56 +00001650#else
Tim Petersdbe6ebb2001-03-01 08:47:29 +00001651 strlen(dp->d_name);
Tim Peters430f5d42001-03-01 01:30:56 +00001652#endif
Tim Petersd1e87a82001-03-01 18:12:00 +00001653 if (thislen >= namelen &&
Tim Peters677898a2001-03-02 03:28:03 +00001654 strcmp(dp->d_name, nameWithExt) == 0) {
Tim Peters430f5d42001-03-01 01:30:56 +00001655 (void)closedir(dirp);
1656 return 1; /* Found */
1657 }
1658 }
Tim Petersdbe6ebb2001-03-01 08:47:29 +00001659 (void)closedir(dirp);
Tim Peters430f5d42001-03-01 01:30:56 +00001660 }
Tim Peters430f5d42001-03-01 01:30:56 +00001661 return 0 ; /* Not found */
Tim Peters430f5d42001-03-01 01:30:56 +00001662
Guido van Rossume2ae77b2001-10-24 20:42:55 +00001663/* RISC OS */
1664#elif defined(RISCOS)
1665 char canon[MAXPATHLEN+1]; /* buffer for the canonical form of the path */
1666 char buf2[MAXPATHLEN+2];
1667 char *nameWithExt = buf+len-namelen;
1668 int canonlen;
1669 os_error *e;
1670
1671 if (Py_GETENV("PYTHONCASEOK") != NULL)
1672 return 1;
1673
1674 /* workaround:
1675 append wildcard, otherwise case of filename wouldn't be touched */
1676 strcpy(buf2, buf);
1677 strcat(buf2, "*");
1678
1679 e = xosfscontrol_canonicalise_path(buf2,canon,0,0,MAXPATHLEN+1,&canonlen);
1680 canonlen = MAXPATHLEN+1-canonlen;
1681 if (e || canonlen<=0 || canonlen>(MAXPATHLEN+1) )
1682 return 0;
1683 if (strcmp(nameWithExt, canon+canonlen-strlen(nameWithExt))==0)
1684 return 1; /* match */
1685
1686 return 0;
1687
Andrew MacIntyred9400542002-02-26 11:41:34 +00001688/* OS/2 */
1689#elif defined(PYOS_OS2)
1690 HDIR hdir = 1;
1691 ULONG srchcnt = 1;
1692 FILEFINDBUF3 ffbuf;
1693 APIRET rc;
1694
Georg Brandlaed6c662008-01-07 17:25:53 +00001695 if (Py_GETENV("PYTHONCASEOK") != NULL)
Andrew MacIntyred9400542002-02-26 11:41:34 +00001696 return 1;
1697
1698 rc = DosFindFirst(buf,
1699 &hdir,
1700 FILE_READONLY | FILE_HIDDEN | FILE_SYSTEM | FILE_DIRECTORY,
1701 &ffbuf, sizeof(ffbuf),
1702 &srchcnt,
1703 FIL_STANDARD);
1704 if (rc != NO_ERROR)
1705 return 0;
1706 return strncmp(ffbuf.achName, name, namelen) == 0;
1707
Tim Peters50d8d372001-02-28 05:34:27 +00001708/* assuming it's a case-sensitive filesystem, so there's nothing to do! */
1709#else
Guido van Rossum0980bd91998-02-13 17:18:36 +00001710 return 1;
Guido van Rossum0980bd91998-02-13 17:18:36 +00001711
Guido van Rossum4d1b3b91998-02-13 23:27:59 +00001712#endif
Tim Peters50d8d372001-02-28 05:34:27 +00001713}
Guido van Rossum4d1b3b91998-02-13 23:27:59 +00001714
Guido van Rossum0980bd91998-02-13 17:18:36 +00001715
Guido van Rossum197346f1997-10-31 18:38:52 +00001716#ifdef HAVE_STAT
1717/* Helper to look for __init__.py or __init__.py[co] in potential package */
1718static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001719find_init_module(char *buf)
Guido van Rossum197346f1997-10-31 18:38:52 +00001720{
Tim Peters0f9431f2001-07-05 03:47:53 +00001721 const size_t save_len = strlen(buf);
Fred Drake4c82b232000-06-30 16:18:57 +00001722 size_t i = save_len;
Tim Peters0f9431f2001-07-05 03:47:53 +00001723 char *pname; /* pointer to start of __init__ */
Guido van Rossum197346f1997-10-31 18:38:52 +00001724 struct stat statbuf;
1725
Tim Peters0f9431f2001-07-05 03:47:53 +00001726/* For calling case_ok(buf, len, namelen, name):
1727 * /a/b/c/d/e/f/g/h/i/j/k/some_long_module_name.py\0
1728 * ^ ^ ^ ^
1729 * |--------------------- buf ---------------------|
1730 * |------------------- len ------------------|
1731 * |------ name -------|
1732 * |----- namelen -----|
1733 */
Guido van Rossum197346f1997-10-31 18:38:52 +00001734 if (save_len + 13 >= MAXPATHLEN)
1735 return 0;
1736 buf[i++] = SEP;
Tim Peters0f9431f2001-07-05 03:47:53 +00001737 pname = buf + i;
1738 strcpy(pname, "__init__.py");
Guido van Rossum197346f1997-10-31 18:38:52 +00001739 if (stat(buf, &statbuf) == 0) {
Tim Peters0f9431f2001-07-05 03:47:53 +00001740 if (case_ok(buf,
1741 save_len + 9, /* len("/__init__") */
1742 8, /* len("__init__") */
1743 pname)) {
1744 buf[save_len] = '\0';
1745 return 1;
1746 }
Guido van Rossum197346f1997-10-31 18:38:52 +00001747 }
Tim Peters0f9431f2001-07-05 03:47:53 +00001748 i += strlen(pname);
1749 strcpy(buf+i, Py_OptimizeFlag ? "o" : "c");
Guido van Rossum197346f1997-10-31 18:38:52 +00001750 if (stat(buf, &statbuf) == 0) {
Tim Peters0f9431f2001-07-05 03:47:53 +00001751 if (case_ok(buf,
1752 save_len + 9, /* len("/__init__") */
1753 8, /* len("__init__") */
1754 pname)) {
1755 buf[save_len] = '\0';
1756 return 1;
1757 }
Guido van Rossum197346f1997-10-31 18:38:52 +00001758 }
1759 buf[save_len] = '\0';
1760 return 0;
1761}
Guido van Rossum48a680c2001-03-02 06:34:14 +00001762
1763#else
1764
1765#ifdef RISCOS
1766static int
1767find_init_module(buf)
1768 char *buf;
1769{
1770 int save_len = strlen(buf);
1771 int i = save_len;
1772
1773 if (save_len + 13 >= MAXPATHLEN)
1774 return 0;
1775 buf[i++] = SEP;
1776 strcpy(buf+i, "__init__/py");
1777 if (isfile(buf)) {
1778 buf[save_len] = '\0';
1779 return 1;
1780 }
1781
1782 if (Py_OptimizeFlag)
1783 strcpy(buf+i, "o");
1784 else
1785 strcpy(buf+i, "c");
1786 if (isfile(buf)) {
1787 buf[save_len] = '\0';
1788 return 1;
1789 }
1790 buf[save_len] = '\0';
1791 return 0;
1792}
1793#endif /*RISCOS*/
1794
Guido van Rossum197346f1997-10-31 18:38:52 +00001795#endif /* HAVE_STAT */
1796
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001797
Tim Petersdbd9ba62000-07-09 03:09:57 +00001798static int init_builtin(char *); /* Forward */
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001799
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001800/* Load an external module using the default search path and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001801 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001802
Guido van Rossum79f25d91997-04-29 20:08:16 +00001803static PyObject *
Amaury Forgeot d'Arc982b2fa2009-07-25 16:22:06 +00001804load_module(char *name, FILE *fp, char *pathname, int type, PyObject *loader)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001805{
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001806 PyObject *modules;
Guido van Rossum79f25d91997-04-29 20:08:16 +00001807 PyObject *m;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001808 int err;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001809
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001810 /* First check that there's an open file (if we need one) */
1811 switch (type) {
1812 case PY_SOURCE:
1813 case PY_COMPILED:
1814 if (fp == NULL) {
1815 PyErr_Format(PyExc_ValueError,
1816 "file object required for import (type code %d)",
1817 type);
1818 return NULL;
1819 }
1820 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001821
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001822 switch (type) {
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001823
1824 case PY_SOURCE:
Amaury Forgeot d'Arc982b2fa2009-07-25 16:22:06 +00001825 m = load_source_module(name, pathname, fp);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001826 break;
1827
1828 case PY_COMPILED:
Amaury Forgeot d'Arc982b2fa2009-07-25 16:22:06 +00001829 m = load_compiled_module(name, pathname, fp);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001830 break;
1831
Guido van Rossum96a8fb71999-12-22 14:09:35 +00001832#ifdef HAVE_DYNAMIC_LOADING
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001833 case C_EXTENSION:
Amaury Forgeot d'Arc982b2fa2009-07-25 16:22:06 +00001834 m = _PyImport_LoadDynamicModule(name, pathname, fp);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001835 break;
Guido van Rossum96a8fb71999-12-22 14:09:35 +00001836#endif
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001837
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001838 case PKG_DIRECTORY:
Amaury Forgeot d'Arc982b2fa2009-07-25 16:22:06 +00001839 m = load_package(name, pathname);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001840 break;
1841
1842 case C_BUILTIN:
1843 case PY_FROZEN:
Amaury Forgeot d'Arc982b2fa2009-07-25 16:22:06 +00001844 if (pathname != NULL && pathname[0] != '\0')
1845 name = pathname;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001846 if (type == C_BUILTIN)
1847 err = init_builtin(name);
1848 else
1849 err = PyImport_ImportFrozenModule(name);
1850 if (err < 0)
Guido van Rossuma86f77d1997-09-09 18:53:47 +00001851 return NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001852 if (err == 0) {
1853 PyErr_Format(PyExc_ImportError,
1854 "Purported %s module %.200s not found",
1855 type == C_BUILTIN ?
1856 "builtin" : "frozen",
1857 name);
Guido van Rossuma86f77d1997-09-09 18:53:47 +00001858 return NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001859 }
1860 modules = PyImport_GetModuleDict();
1861 m = PyDict_GetItemString(modules, name);
1862 if (m == NULL) {
1863 PyErr_Format(
1864 PyExc_ImportError,
1865 "%s module %.200s not properly initialized",
1866 type == C_BUILTIN ?
1867 "builtin" : "frozen",
1868 name);
Guido van Rossuma86f77d1997-09-09 18:53:47 +00001869 return NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001870 }
1871 Py_INCREF(m);
1872 break;
1873
Just van Rossum52e14d62002-12-30 22:08:05 +00001874 case IMP_HOOK: {
1875 if (loader == NULL) {
1876 PyErr_SetString(PyExc_ImportError,
1877 "import hook without loader");
1878 return NULL;
1879 }
1880 m = PyObject_CallMethod(loader, "load_module", "s", name);
1881 break;
1882 }
1883
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001884 default:
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001885 PyErr_Format(PyExc_ImportError,
1886 "Don't know how to import %.200s (type code %d)",
1887 name, type);
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001888 m = NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001889
1890 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001891
1892 return m;
1893}
1894
1895
1896/* Initialize a built-in module.
Brett Cannon5a9aa4f2006-10-03 21:58:55 +00001897 Return 1 for success, 0 if the module is not found, and -1 with
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001898 an exception set if the initialization failed. */
Guido van Rossum7f133ed1991-02-19 12:23:57 +00001899
Guido van Rossum7f133ed1991-02-19 12:23:57 +00001900static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001901init_builtin(char *name)
Guido van Rossum7f133ed1991-02-19 12:23:57 +00001902{
Guido van Rossum25ce5661997-08-02 03:10:38 +00001903 struct _inittab *p;
Guido van Rossum25ce5661997-08-02 03:10:38 +00001904
Greg Ward201baee2001-10-04 14:52:06 +00001905 if (_PyImport_FindExtension(name, name) != NULL)
Guido van Rossum25ce5661997-08-02 03:10:38 +00001906 return 1;
1907
Guido van Rossum771c6c81997-10-31 18:37:24 +00001908 for (p = PyImport_Inittab; p->name != NULL; p++) {
Guido van Rossum25ce5661997-08-02 03:10:38 +00001909 if (strcmp(name, p->name) == 0) {
1910 if (p->initfunc == NULL) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001911 PyErr_Format(PyExc_ImportError,
1912 "Cannot re-init internal module %.200s",
1913 name);
Guido van Rossum74e6a111994-08-29 12:54:38 +00001914 return -1;
1915 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00001916 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +00001917 PySys_WriteStderr("import %s # builtin\n", name);
Guido van Rossum25ce5661997-08-02 03:10:38 +00001918 (*p->initfunc)();
Guido van Rossum79f25d91997-04-29 20:08:16 +00001919 if (PyErr_Occurred())
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001920 return -1;
Guido van Rossum25ce5661997-08-02 03:10:38 +00001921 if (_PyImport_FixupExtension(name, name) == NULL)
1922 return -1;
Guido van Rossum7f133ed1991-02-19 12:23:57 +00001923 return 1;
1924 }
1925 }
1926 return 0;
1927}
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001928
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001929
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001930/* Frozen modules */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001931
Guido van Rossumcfd0a221996-06-17 17:06:34 +00001932static struct _frozen *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001933find_frozen(char *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001934{
Guido van Rossumcfd0a221996-06-17 17:06:34 +00001935 struct _frozen *p;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001936
Guido van Rossum79f25d91997-04-29 20:08:16 +00001937 for (p = PyImport_FrozenModules; ; p++) {
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001938 if (p->name == NULL)
1939 return NULL;
1940 if (strcmp(p->name, name) == 0)
1941 break;
1942 }
1943 return p;
1944}
1945
Guido van Rossum79f25d91997-04-29 20:08:16 +00001946static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001947get_frozen_object(char *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001948{
Guido van Rossumcfd0a221996-06-17 17:06:34 +00001949 struct _frozen *p = find_frozen(name);
Guido van Rossuma5568d31998-03-05 03:45:08 +00001950 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001951
1952 if (p == NULL) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001953 PyErr_Format(PyExc_ImportError,
1954 "No such frozen object named %.200s",
1955 name);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001956 return NULL;
1957 }
Guido van Rossum8f4d3312001-10-18 18:54:11 +00001958 if (p->code == NULL) {
1959 PyErr_Format(PyExc_ImportError,
1960 "Excluded frozen object named %.200s",
1961 name);
1962 return NULL;
1963 }
Guido van Rossuma5568d31998-03-05 03:45:08 +00001964 size = p->size;
1965 if (size < 0)
1966 size = -size;
1967 return PyMarshal_ReadObjectFromString((char *)p->code, size);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001968}
1969
1970/* Initialize a frozen module.
1971 Return 1 for succes, 0 if the module is not found, and -1 with
1972 an exception set if the initialization failed.
1973 This function is also used from frozenmain.c */
Guido van Rossum0b344901995-02-07 15:35:27 +00001974
1975int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001976PyImport_ImportFrozenModule(char *name)
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001977{
Guido van Rossumcfd0a221996-06-17 17:06:34 +00001978 struct _frozen *p = find_frozen(name);
Guido van Rossum79f25d91997-04-29 20:08:16 +00001979 PyObject *co;
1980 PyObject *m;
Guido van Rossuma5568d31998-03-05 03:45:08 +00001981 int ispackage;
1982 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001983
1984 if (p == NULL)
1985 return 0;
Guido van Rossum8f4d3312001-10-18 18:54:11 +00001986 if (p->code == NULL) {
1987 PyErr_Format(PyExc_ImportError,
1988 "Excluded frozen object named %.200s",
1989 name);
1990 return -1;
1991 }
Guido van Rossuma5568d31998-03-05 03:45:08 +00001992 size = p->size;
1993 ispackage = (size < 0);
1994 if (ispackage)
1995 size = -size;
Guido van Rossum79f25d91997-04-29 20:08:16 +00001996 if (Py_VerboseFlag)
Guido van Rossum2f3667a1998-10-12 18:23:55 +00001997 PySys_WriteStderr("import %s # frozen%s\n",
Guido van Rossuma5568d31998-03-05 03:45:08 +00001998 name, ispackage ? " package" : "");
1999 co = PyMarshal_ReadObjectFromString((char *)p->code, size);
Guido van Rossumf56e3db1993-04-01 20:59:32 +00002000 if (co == NULL)
2001 return -1;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002002 if (!PyCode_Check(co)) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002003 PyErr_Format(PyExc_TypeError,
2004 "frozen object %.200s is not a code object",
2005 name);
Neal Norwitzc0cde4d2006-07-16 02:17:36 +00002006 goto err_return;
Guido van Rossumf56e3db1993-04-01 20:59:32 +00002007 }
Guido van Rossuma5568d31998-03-05 03:45:08 +00002008 if (ispackage) {
2009 /* Set __path__ to the package name */
2010 PyObject *d, *s;
2011 int err;
2012 m = PyImport_AddModule(name);
2013 if (m == NULL)
Neal Norwitzc0cde4d2006-07-16 02:17:36 +00002014 goto err_return;
Guido van Rossuma5568d31998-03-05 03:45:08 +00002015 d = PyModule_GetDict(m);
Gregory P. Smithdd96db62008-06-09 04:58:54 +00002016 s = PyString_InternFromString(name);
Guido van Rossuma5568d31998-03-05 03:45:08 +00002017 if (s == NULL)
Neal Norwitzc0cde4d2006-07-16 02:17:36 +00002018 goto err_return;
Guido van Rossuma5568d31998-03-05 03:45:08 +00002019 err = PyDict_SetItemString(d, "__path__", s);
2020 Py_DECREF(s);
2021 if (err != 0)
Neal Norwitzc0cde4d2006-07-16 02:17:36 +00002022 goto err_return;
Guido van Rossuma5568d31998-03-05 03:45:08 +00002023 }
Guido van Rossume32bf6e1998-02-11 05:53:02 +00002024 m = PyImport_ExecCodeModuleEx(name, co, "<frozen>");
Guido van Rossum7f9fa971995-01-20 16:53:12 +00002025 if (m == NULL)
Neal Norwitzc0cde4d2006-07-16 02:17:36 +00002026 goto err_return;
2027 Py_DECREF(co);
Guido van Rossum79f25d91997-04-29 20:08:16 +00002028 Py_DECREF(m);
Guido van Rossum7f9fa971995-01-20 16:53:12 +00002029 return 1;
Neal Norwitzc0cde4d2006-07-16 02:17:36 +00002030err_return:
2031 Py_DECREF(co);
2032 return -1;
Guido van Rossumf56e3db1993-04-01 20:59:32 +00002033}
Guido van Rossum74e6a111994-08-29 12:54:38 +00002034
2035
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002036/* Import a module, either built-in, frozen, or external, and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00002037 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum74e6a111994-08-29 12:54:38 +00002038
Guido van Rossum79f25d91997-04-29 20:08:16 +00002039PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00002040PyImport_ImportModule(const char *name)
Guido van Rossum74e6a111994-08-29 12:54:38 +00002041{
Marc-André Lemburg3c61c352001-02-09 19:40:15 +00002042 PyObject *pname;
2043 PyObject *result;
2044
Gregory P. Smithdd96db62008-06-09 04:58:54 +00002045 pname = PyString_FromString(name);
Neal Norwitza11e4c12003-03-23 14:31:01 +00002046 if (pname == NULL)
2047 return NULL;
Marc-André Lemburg3c61c352001-02-09 19:40:15 +00002048 result = PyImport_Import(pname);
2049 Py_DECREF(pname);
2050 return result;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002051}
2052
Christian Heimes000a0742008-01-03 22:16:32 +00002053/* Import a module without blocking
2054 *
2055 * At first it tries to fetch the module from sys.modules. If the module was
2056 * never loaded before it loads it with PyImport_ImportModule() unless another
2057 * thread holds the import lock. In the latter case the function raises an
2058 * ImportError instead of blocking.
2059 *
2060 * Returns the module object with incremented ref count.
2061 */
2062PyObject *
2063PyImport_ImportModuleNoBlock(const char *name)
2064{
2065 PyObject *result;
2066 PyObject *modules;
2067 long me;
2068
2069 /* Try to get the module from sys.modules[name] */
2070 modules = PyImport_GetModuleDict();
2071 if (modules == NULL)
2072 return NULL;
2073
2074 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
Christian Heimes000a0742008-01-03 22:16:32 +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
2099 return PyImport_ImportModule(name);
2100#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,
2105 Py_ssize_t *p_buflen, int level);
Tim Petersdbd9ba62000-07-09 03:09:57 +00002106static PyObject *load_next(PyObject *mod, PyObject *altmod,
Martin v. Löwis18e16552006-02-15 17:27:45 +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,
Martin v. Löwis18e16552006-02-15 17:27:45 +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,
2117 PyObject *fromlist, int level)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002118{
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002119 char buf[MAXPATHLEN+1];
Martin v. Löwis18e16552006-02-15 17:27:45 +00002120 Py_ssize_t buflen = 0;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002121 PyObject *parent, *head, *next, *tail;
2122
Christian Heimes3403f152008-01-09 19:56:33 +00002123 if (strchr(name, '/') != NULL
2124#ifdef MS_WINDOWS
2125 || strchr(name, '\\') != NULL
2126#endif
2127 ) {
2128 PyErr_SetString(PyExc_ImportError,
2129 "Import by filename is not supported.");
2130 return NULL;
2131 }
2132
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002133 parent = get_parent(globals, buf, &buflen, level);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002134 if (parent == NULL)
2135 return NULL;
2136
2137 head = load_next(parent, Py_None, &name, buf, &buflen);
2138 if (head == NULL)
2139 return NULL;
2140
2141 tail = head;
2142 Py_INCREF(tail);
2143 while (name) {
2144 next = load_next(tail, tail, &name, buf, &buflen);
2145 Py_DECREF(tail);
2146 if (next == NULL) {
2147 Py_DECREF(head);
2148 return NULL;
2149 }
2150 tail = next;
2151 }
Thomas Wouters8ddab272006-04-04 16:17:02 +00002152 if (tail == Py_None) {
2153 /* If tail is Py_None, both get_parent and load_next found
2154 an empty module name: someone called __import__("") or
2155 doctored faulty bytecode */
Thomas Wouters4bdaa272006-04-05 13:39:37 +00002156 Py_DECREF(tail);
2157 Py_DECREF(head);
Thomas Wouters8ddab272006-04-04 16:17:02 +00002158 PyErr_SetString(PyExc_ValueError,
2159 "Empty module name");
2160 return NULL;
2161 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002162
2163 if (fromlist != NULL) {
2164 if (fromlist == Py_None || !PyObject_IsTrue(fromlist))
2165 fromlist = NULL;
2166 }
2167
2168 if (fromlist == NULL) {
2169 Py_DECREF(tail);
2170 return head;
2171 }
2172
2173 Py_DECREF(head);
Guido van Rossum9905ef91997-09-08 16:07:11 +00002174 if (!ensure_fromlist(tail, fromlist, buf, buflen, 0)) {
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002175 Py_DECREF(tail);
2176 return NULL;
2177 }
2178
2179 return tail;
2180}
2181
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002182PyObject *
2183PyImport_ImportModuleLevel(char *name, PyObject *globals, PyObject *locals,
2184 PyObject *fromlist, int level)
2185{
2186 PyObject *result;
Thomas Woutersc4dcb382009-09-16 19:55:54 +00002187 _PyImport_AcquireLock();
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002188 result = import_module_level(name, globals, locals, fromlist, level);
Thomas Woutersc4dcb382009-09-16 19:55:54 +00002189 if (_PyImport_ReleaseLock() < 0) {
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00002190 Py_XDECREF(result);
2191 PyErr_SetString(PyExc_RuntimeError,
2192 "not holding the import lock");
2193 return NULL;
2194 }
Guido van Rossum75acc9c1998-03-03 22:26:50 +00002195 return result;
2196}
2197
Fred Drake87590902004-05-28 20:21:36 +00002198/* Return the package that an import is being performed in. If globals comes
2199 from the module foo.bar.bat (not itself a package), this returns the
2200 sys.modules entry for foo.bar. If globals is from a package's __init__.py,
Georg Brandl5f6861d2006-05-28 21:57:35 +00002201 the package's entry in sys.modules is returned, as a borrowed reference.
Fred Drake87590902004-05-28 20:21:36 +00002202
2203 The *name* of the returned package is returned in buf, with the length of
2204 the name in *p_buflen.
2205
2206 If globals doesn't come from a package or a module in a package, or a
2207 corresponding entry is not found in sys.modules, Py_None is returned.
2208*/
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002209static PyObject *
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002210get_parent(PyObject *globals, char *buf, Py_ssize_t *p_buflen, int level)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002211{
2212 static PyObject *namestr = NULL;
2213 static PyObject *pathstr = NULL;
Nick Coghlanef01d822007-12-03 12:55:17 +00002214 static PyObject *pkgstr = NULL;
2215 PyObject *pkgname, *modname, *modpath, *modules, *parent;
Nick Coghlanb028f502008-07-13 14:52:36 +00002216 int orig_level = level;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002217
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002218 if (globals == NULL || !PyDict_Check(globals) || !level)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002219 return Py_None;
2220
2221 if (namestr == NULL) {
Gregory P. Smithdd96db62008-06-09 04:58:54 +00002222 namestr = PyString_InternFromString("__name__");
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002223 if (namestr == NULL)
2224 return NULL;
2225 }
2226 if (pathstr == NULL) {
Gregory P. Smithdd96db62008-06-09 04:58:54 +00002227 pathstr = PyString_InternFromString("__path__");
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002228 if (pathstr == NULL)
2229 return NULL;
2230 }
Nick Coghlanef01d822007-12-03 12:55:17 +00002231 if (pkgstr == NULL) {
Gregory P. Smithdd96db62008-06-09 04:58:54 +00002232 pkgstr = PyString_InternFromString("__package__");
Nick Coghlanef01d822007-12-03 12:55:17 +00002233 if (pkgstr == NULL)
2234 return NULL;
2235 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002236
2237 *buf = '\0';
2238 *p_buflen = 0;
Nick Coghlanef01d822007-12-03 12:55:17 +00002239 pkgname = PyDict_GetItem(globals, pkgstr);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002240
Nick Coghlanef01d822007-12-03 12:55:17 +00002241 if ((pkgname != NULL) && (pkgname != Py_None)) {
2242 /* __package__ is set, so use it */
2243 Py_ssize_t len;
Gregory P. Smithdd96db62008-06-09 04:58:54 +00002244 if (!PyString_Check(pkgname)) {
Nick Coghlanef01d822007-12-03 12:55:17 +00002245 PyErr_SetString(PyExc_ValueError,
2246 "__package__ set to non-string");
2247 return NULL;
2248 }
Gregory P. Smithdd96db62008-06-09 04:58:54 +00002249 len = PyString_GET_SIZE(pkgname);
Nick Coghlanef01d822007-12-03 12:55:17 +00002250 if (len == 0) {
2251 if (level > 0) {
2252 PyErr_SetString(PyExc_ValueError,
2253 "Attempted relative import in non-package");
2254 return NULL;
2255 }
2256 return Py_None;
2257 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002258 if (len > MAXPATHLEN) {
2259 PyErr_SetString(PyExc_ValueError,
Nick Coghlanef01d822007-12-03 12:55:17 +00002260 "Package name too long");
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002261 return NULL;
2262 }
Gregory P. Smithdd96db62008-06-09 04:58:54 +00002263 strcpy(buf, PyString_AS_STRING(pkgname));
Nick Coghlanef01d822007-12-03 12:55:17 +00002264 } else {
2265 /* __package__ not set, so figure it out and set it */
2266 modname = PyDict_GetItem(globals, namestr);
Gregory P. Smithdd96db62008-06-09 04:58:54 +00002267 if (modname == NULL || !PyString_Check(modname))
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002268 return Py_None;
Nick Coghlanef01d822007-12-03 12:55:17 +00002269
2270 modpath = PyDict_GetItem(globals, pathstr);
2271 if (modpath != NULL) {
2272 /* __path__ is set, so modname is already the package name */
Gregory P. Smithdd96db62008-06-09 04:58:54 +00002273 Py_ssize_t len = PyString_GET_SIZE(modname);
Nick Coghlanef01d822007-12-03 12:55:17 +00002274 int error;
2275 if (len > MAXPATHLEN) {
2276 PyErr_SetString(PyExc_ValueError,
2277 "Module name too long");
2278 return NULL;
2279 }
Gregory P. Smithdd96db62008-06-09 04:58:54 +00002280 strcpy(buf, PyString_AS_STRING(modname));
Nick Coghlanef01d822007-12-03 12:55:17 +00002281 error = PyDict_SetItem(globals, pkgstr, modname);
2282 if (error) {
2283 PyErr_SetString(PyExc_ValueError,
2284 "Could not set __package__");
2285 return NULL;
2286 }
2287 } else {
2288 /* Normal module, so work out the package name if any */
Gregory P. Smithdd96db62008-06-09 04:58:54 +00002289 char *start = PyString_AS_STRING(modname);
Nick Coghlanef01d822007-12-03 12:55:17 +00002290 char *lastdot = strrchr(start, '.');
2291 size_t len;
2292 int error;
2293 if (lastdot == NULL && level > 0) {
2294 PyErr_SetString(PyExc_ValueError,
2295 "Attempted relative import in non-package");
2296 return NULL;
2297 }
2298 if (lastdot == NULL) {
2299 error = PyDict_SetItem(globals, pkgstr, Py_None);
2300 if (error) {
2301 PyErr_SetString(PyExc_ValueError,
2302 "Could not set __package__");
2303 return NULL;
2304 }
2305 return Py_None;
2306 }
2307 len = lastdot - start;
2308 if (len >= MAXPATHLEN) {
2309 PyErr_SetString(PyExc_ValueError,
2310 "Module name too long");
2311 return NULL;
2312 }
2313 strncpy(buf, start, len);
2314 buf[len] = '\0';
Gregory P. Smithdd96db62008-06-09 04:58:54 +00002315 pkgname = PyString_FromString(buf);
Nick Coghlanef01d822007-12-03 12:55:17 +00002316 if (pkgname == NULL) {
2317 return NULL;
2318 }
2319 error = PyDict_SetItem(globals, pkgstr, pkgname);
2320 Py_DECREF(pkgname);
2321 if (error) {
2322 PyErr_SetString(PyExc_ValueError,
2323 "Could not set __package__");
2324 return NULL;
2325 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002326 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002327 }
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002328 while (--level > 0) {
2329 char *dot = strrchr(buf, '.');
2330 if (dot == NULL) {
2331 PyErr_SetString(PyExc_ValueError,
Georg Brandl98775df2006-09-06 06:09:31 +00002332 "Attempted relative import beyond "
2333 "toplevel package");
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002334 return NULL;
2335 }
2336 *dot = '\0';
2337 }
2338 *p_buflen = strlen(buf);
2339
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002340 modules = PyImport_GetModuleDict();
2341 parent = PyDict_GetItemString(modules, buf);
Nick Coghlanb028f502008-07-13 14:52:36 +00002342 if (parent == NULL) {
2343 if (orig_level < 1) {
2344 PyObject *err_msg = PyString_FromFormat(
2345 "Parent module '%.200s' not found "
2346 "while handling absolute import", buf);
2347 if (err_msg == NULL) {
2348 return NULL;
2349 }
2350 if (!PyErr_WarnEx(PyExc_RuntimeWarning,
2351 PyString_AsString(err_msg), 1)) {
2352 *buf = '\0';
2353 *p_buflen = 0;
2354 parent = Py_None;
2355 }
2356 Py_DECREF(err_msg);
2357 } else {
2358 PyErr_Format(PyExc_SystemError,
2359 "Parent module '%.200s' not loaded, "
2360 "cannot perform relative import", buf);
2361 }
2362 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002363 return parent;
2364 /* We expect, but can't guarantee, if parent != None, that:
2365 - parent.__name__ == buf
2366 - parent.__dict__ is globals
2367 If this is violated... Who cares? */
2368}
2369
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002370/* altmod is either None or same as mod */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002371static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002372load_next(PyObject *mod, PyObject *altmod, char **p_name, char *buf,
Martin v. Löwis18e16552006-02-15 17:27:45 +00002373 Py_ssize_t *p_buflen)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002374{
2375 char *name = *p_name;
2376 char *dot = strchr(name, '.');
Fred Drake4c82b232000-06-30 16:18:57 +00002377 size_t len;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002378 char *p;
2379 PyObject *result;
2380
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002381 if (strlen(name) == 0) {
Thomas Wouters8ddab272006-04-04 16:17:02 +00002382 /* completely empty module name should only happen in
2383 'from . import' (or '__import__("")')*/
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002384 Py_INCREF(mod);
2385 *p_name = NULL;
2386 return mod;
2387 }
2388
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002389 if (dot == NULL) {
2390 *p_name = NULL;
2391 len = strlen(name);
2392 }
2393 else {
2394 *p_name = dot+1;
2395 len = dot-name;
2396 }
Guido van Rossum111c20b1998-04-11 17:38:22 +00002397 if (len == 0) {
2398 PyErr_SetString(PyExc_ValueError,
2399 "Empty module name");
2400 return NULL;
2401 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002402
2403 p = buf + *p_buflen;
2404 if (p != buf)
2405 *p++ = '.';
2406 if (p+len-buf >= MAXPATHLEN) {
2407 PyErr_SetString(PyExc_ValueError,
2408 "Module name too long");
2409 return NULL;
2410 }
2411 strncpy(p, name, len);
2412 p[len] = '\0';
2413 *p_buflen = p+len-buf;
2414
2415 result = import_submodule(mod, p, buf);
2416 if (result == Py_None && altmod != mod) {
2417 Py_DECREF(result);
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00002418 /* Here, altmod must be None and mod must not be None */
Guido van Rossum0c819451997-09-07 06:16:57 +00002419 result = import_submodule(altmod, p, p);
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00002420 if (result != NULL && result != Py_None) {
2421 if (mark_miss(buf) != 0) {
2422 Py_DECREF(result);
2423 return NULL;
2424 }
2425 strncpy(buf, name, len);
2426 buf[len] = '\0';
2427 *p_buflen = len;
2428 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002429 }
2430 if (result == NULL)
2431 return NULL;
2432
2433 if (result == Py_None) {
2434 Py_DECREF(result);
2435 PyErr_Format(PyExc_ImportError,
2436 "No module named %.200s", name);
2437 return NULL;
2438 }
2439
2440 return result;
2441}
2442
2443static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002444mark_miss(char *name)
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00002445{
2446 PyObject *modules = PyImport_GetModuleDict();
2447 return PyDict_SetItemString(modules, name, Py_None);
2448}
2449
2450static int
Martin v. Löwis18e16552006-02-15 17:27:45 +00002451ensure_fromlist(PyObject *mod, PyObject *fromlist, char *buf, Py_ssize_t buflen,
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002452 int recursive)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002453{
2454 int i;
2455
2456 if (!PyObject_HasAttrString(mod, "__path__"))
2457 return 1;
2458
2459 for (i = 0; ; i++) {
2460 PyObject *item = PySequence_GetItem(fromlist, i);
2461 int hasit;
2462 if (item == NULL) {
2463 if (PyErr_ExceptionMatches(PyExc_IndexError)) {
2464 PyErr_Clear();
2465 return 1;
2466 }
2467 return 0;
2468 }
Gregory P. Smithdd96db62008-06-09 04:58:54 +00002469 if (!PyString_Check(item)) {
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002470 PyErr_SetString(PyExc_TypeError,
2471 "Item in ``from list'' not a string");
2472 Py_DECREF(item);
2473 return 0;
2474 }
Gregory P. Smithdd96db62008-06-09 04:58:54 +00002475 if (PyString_AS_STRING(item)[0] == '*') {
Guido van Rossum9905ef91997-09-08 16:07:11 +00002476 PyObject *all;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002477 Py_DECREF(item);
Guido van Rossum9905ef91997-09-08 16:07:11 +00002478 /* See if the package defines __all__ */
2479 if (recursive)
2480 continue; /* Avoid endless recursion */
2481 all = PyObject_GetAttrString(mod, "__all__");
2482 if (all == NULL)
2483 PyErr_Clear();
2484 else {
Martin v. Löwis83969ee2004-03-23 16:28:13 +00002485 int ret = ensure_fromlist(mod, all, buf, buflen, 1);
Guido van Rossum9905ef91997-09-08 16:07:11 +00002486 Py_DECREF(all);
Martin v. Löwis83969ee2004-03-23 16:28:13 +00002487 if (!ret)
2488 return 0;
Guido van Rossum9905ef91997-09-08 16:07:11 +00002489 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002490 continue;
2491 }
2492 hasit = PyObject_HasAttr(mod, item);
2493 if (!hasit) {
Gregory P. Smithdd96db62008-06-09 04:58:54 +00002494 char *subname = PyString_AS_STRING(item);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002495 PyObject *submod;
2496 char *p;
2497 if (buflen + strlen(subname) >= MAXPATHLEN) {
2498 PyErr_SetString(PyExc_ValueError,
2499 "Module name too long");
2500 Py_DECREF(item);
2501 return 0;
2502 }
2503 p = buf + buflen;
2504 *p++ = '.';
2505 strcpy(p, subname);
2506 submod = import_submodule(mod, subname, buf);
2507 Py_XDECREF(submod);
2508 if (submod == NULL) {
2509 Py_DECREF(item);
2510 return 0;
2511 }
2512 }
2513 Py_DECREF(item);
2514 }
2515
Guido van Rossuma7f2e811997-10-03 15:33:32 +00002516 /* NOTREACHED */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002517}
2518
Neil Schemenauer00b09662003-06-16 21:03:07 +00002519static int
2520add_submodule(PyObject *mod, PyObject *submod, char *fullname, char *subname,
2521 PyObject *modules)
2522{
2523 if (mod == Py_None)
2524 return 1;
2525 /* Irrespective of the success of this load, make a
2526 reference to it in the parent package module. A copy gets
2527 saved in the modules dictionary under the full name, so get a
2528 reference from there, if need be. (The exception is when the
2529 load failed with a SyntaxError -- then there's no trace in
2530 sys.modules. In that case, of course, do nothing extra.) */
2531 if (submod == NULL) {
2532 submod = PyDict_GetItemString(modules, fullname);
2533 if (submod == NULL)
2534 return 1;
2535 }
2536 if (PyModule_Check(mod)) {
2537 /* We can't use setattr here since it can give a
2538 * spurious warning if the submodule name shadows a
2539 * builtin name */
2540 PyObject *dict = PyModule_GetDict(mod);
2541 if (!dict)
2542 return 0;
2543 if (PyDict_SetItemString(dict, subname, submod) < 0)
2544 return 0;
2545 }
2546 else {
2547 if (PyObject_SetAttrString(mod, subname, submod) < 0)
2548 return 0;
2549 }
2550 return 1;
2551}
2552
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002553static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002554import_submodule(PyObject *mod, char *subname, char *fullname)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002555{
Guido van Rossum25ce5661997-08-02 03:10:38 +00002556 PyObject *modules = PyImport_GetModuleDict();
Neil Schemenauer00b09662003-06-16 21:03:07 +00002557 PyObject *m = NULL;
Guido van Rossum74e6a111994-08-29 12:54:38 +00002558
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002559 /* Require:
2560 if mod == None: subname == fullname
2561 else: mod.__name__ + "." + subname == fullname
2562 */
2563
Tim Peters50d8d372001-02-28 05:34:27 +00002564 if ((m = PyDict_GetItemString(modules, fullname)) != NULL) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00002565 Py_INCREF(m);
Guido van Rossum7f9fa971995-01-20 16:53:12 +00002566 }
2567 else {
Just van Rossum52e14d62002-12-30 22:08:05 +00002568 PyObject *path, *loader = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002569 char buf[MAXPATHLEN+1];
2570 struct filedescr *fdp;
2571 FILE *fp = NULL;
2572
Guido van Rossum9c0afe51998-05-19 15:09:05 +00002573 if (mod == Py_None)
2574 path = NULL;
2575 else {
2576 path = PyObject_GetAttrString(mod, "__path__");
2577 if (path == NULL) {
2578 PyErr_Clear();
2579 Py_INCREF(Py_None);
2580 return Py_None;
2581 }
2582 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002583
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002584 buf[0] = '\0';
Just van Rossum52e14d62002-12-30 22:08:05 +00002585 fdp = find_module(fullname, subname, path, buf, MAXPATHLEN+1,
2586 &fp, &loader);
Guido van Rossumb68cd421998-07-01 17:36:26 +00002587 Py_XDECREF(path);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002588 if (fdp == NULL) {
2589 if (!PyErr_ExceptionMatches(PyExc_ImportError))
2590 return NULL;
2591 PyErr_Clear();
2592 Py_INCREF(Py_None);
2593 return Py_None;
2594 }
Just van Rossum52e14d62002-12-30 22:08:05 +00002595 m = load_module(fullname, fp, buf, fdp->type, loader);
2596 Py_XDECREF(loader);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002597 if (fp)
2598 fclose(fp);
Neil Schemenauer00b09662003-06-16 21:03:07 +00002599 if (!add_submodule(mod, m, fullname, subname, modules)) {
2600 Py_XDECREF(m);
2601 m = NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002602 }
Guido van Rossum74e6a111994-08-29 12:54:38 +00002603 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002604
2605 return m;
Guido van Rossum74e6a111994-08-29 12:54:38 +00002606}
2607
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002608
2609/* Re-import a module of any kind and return its module object, WITH
2610 INCREMENTED REFERENCE COUNT */
2611
Guido van Rossum79f25d91997-04-29 20:08:16 +00002612PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002613PyImport_ReloadModule(PyObject *m)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002614{
Collin Winter47c52a82007-03-13 23:02:15 +00002615 PyInterpreterState *interp = PyThreadState_Get()->interp;
2616 PyObject *modules_reloading = interp->modules_reloading;
Guido van Rossum25ce5661997-08-02 03:10:38 +00002617 PyObject *modules = PyImport_GetModuleDict();
Collin Winter276887b2007-03-12 16:11:39 +00002618 PyObject *path = NULL, *loader = NULL, *existing_m = NULL;
Guido van Rossum222ef561997-09-06 19:41:09 +00002619 char *name, *subname;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002620 char buf[MAXPATHLEN+1];
2621 struct filedescr *fdp;
2622 FILE *fp = NULL;
Tim Peters1cd70172004-08-02 03:52:12 +00002623 PyObject *newm;
Collin Winter47c52a82007-03-13 23:02:15 +00002624
2625 if (modules_reloading == NULL) {
2626 Py_FatalError("PyImport_ReloadModule: "
Neal Norwitz2fca81c2007-05-30 04:53:41 +00002627 "no modules_reloading dictionary!");
Collin Winter47c52a82007-03-13 23:02:15 +00002628 return NULL;
2629 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002630
Guido van Rossum79f25d91997-04-29 20:08:16 +00002631 if (m == NULL || !PyModule_Check(m)) {
2632 PyErr_SetString(PyExc_TypeError,
2633 "reload() argument must be module");
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002634 return NULL;
2635 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002636 name = PyModule_GetName(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002637 if (name == NULL)
2638 return NULL;
Guido van Rossum25ce5661997-08-02 03:10:38 +00002639 if (m != PyDict_GetItemString(modules, name)) {
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002640 PyErr_Format(PyExc_ImportError,
2641 "reload(): module %.200s not in sys.modules",
2642 name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002643 return NULL;
2644 }
Neal Norwitz75c7c802007-03-13 05:31:38 +00002645 existing_m = PyDict_GetItemString(modules_reloading, name);
2646 if (existing_m != NULL) {
2647 /* Due to a recursive reload, this module is already
2648 being reloaded. */
2649 Py_INCREF(existing_m);
2650 return existing_m;
Collin Winter276887b2007-03-12 16:11:39 +00002651 }
Neal Norwitz75c7c802007-03-13 05:31:38 +00002652 if (PyDict_SetItemString(modules_reloading, name, m) < 0)
2653 return NULL;
Collin Winter276887b2007-03-12 16:11:39 +00002654
Guido van Rossum222ef561997-09-06 19:41:09 +00002655 subname = strrchr(name, '.');
2656 if (subname == NULL)
2657 subname = name;
2658 else {
2659 PyObject *parentname, *parent;
Gregory P. Smithdd96db62008-06-09 04:58:54 +00002660 parentname = PyString_FromStringAndSize(name, (subname-name));
Collin Winter276887b2007-03-12 16:11:39 +00002661 if (parentname == NULL) {
2662 imp_modules_reloading_clear();
Guido van Rossum222ef561997-09-06 19:41:09 +00002663 return NULL;
Neal Norwitz75c7c802007-03-13 05:31:38 +00002664 }
Guido van Rossum222ef561997-09-06 19:41:09 +00002665 parent = PyDict_GetItem(modules, parentname);
2666 if (parent == NULL) {
2667 PyErr_Format(PyExc_ImportError,
2668 "reload(): parent %.200s not in sys.modules",
Gregory P. Smithdd96db62008-06-09 04:58:54 +00002669 PyString_AS_STRING(parentname));
Georg Brandl0c55f292005-09-14 06:56:20 +00002670 Py_DECREF(parentname);
Neal Norwitz2fca81c2007-05-30 04:53:41 +00002671 imp_modules_reloading_clear();
Guido van Rossum222ef561997-09-06 19:41:09 +00002672 return NULL;
2673 }
Georg Brandl0c55f292005-09-14 06:56:20 +00002674 Py_DECREF(parentname);
Guido van Rossum222ef561997-09-06 19:41:09 +00002675 subname++;
2676 path = PyObject_GetAttrString(parent, "__path__");
2677 if (path == NULL)
2678 PyErr_Clear();
2679 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002680 buf[0] = '\0';
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00002681 fdp = find_module(name, subname, path, buf, MAXPATHLEN+1, &fp, &loader);
Guido van Rossum222ef561997-09-06 19:41:09 +00002682 Py_XDECREF(path);
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00002683
2684 if (fdp == NULL) {
2685 Py_XDECREF(loader);
Collin Winter276887b2007-03-12 16:11:39 +00002686 imp_modules_reloading_clear();
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002687 return NULL;
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00002688 }
2689
2690 newm = load_module(name, fp, buf, fdp->type, loader);
2691 Py_XDECREF(loader);
2692
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002693 if (fp)
2694 fclose(fp);
Tim Peters1cd70172004-08-02 03:52:12 +00002695 if (newm == NULL) {
2696 /* load_module probably removed name from modules because of
2697 * the error. Put back the original module object. We're
2698 * going to return NULL in this case regardless of whether
2699 * replacing name succeeds, so the return value is ignored.
2700 */
2701 PyDict_SetItemString(modules, name, m);
2702 }
Neal Norwitz75c7c802007-03-13 05:31:38 +00002703 imp_modules_reloading_clear();
Tim Peters1cd70172004-08-02 03:52:12 +00002704 return newm;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002705}
2706
2707
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002708/* Higher-level import emulator which emulates the "import" statement
2709 more accurately -- it invokes the __import__() function from the
2710 builtins of the current globals. This means that the import is
2711 done using whatever import hooks are installed in the current
Guido van Rossum6058eb41998-12-21 19:51:00 +00002712 environment, e.g. by "rexec".
2713 A dummy list ["__doc__"] is passed as the 4th argument so that
Gregory P. Smithdd96db62008-06-09 04:58:54 +00002714 e.g. PyImport_Import(PyString_FromString("win32com.client.gencache"))
Guido van Rossum6058eb41998-12-21 19:51:00 +00002715 will return <module "gencache"> instead of <module "win32com">. */
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002716
2717PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002718PyImport_Import(PyObject *module_name)
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002719{
2720 static PyObject *silly_list = NULL;
2721 static PyObject *builtins_str = NULL;
2722 static PyObject *import_str = NULL;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002723 PyObject *globals = NULL;
2724 PyObject *import = NULL;
2725 PyObject *builtins = NULL;
2726 PyObject *r = NULL;
2727
2728 /* Initialize constant string objects */
2729 if (silly_list == NULL) {
Gregory P. Smithdd96db62008-06-09 04:58:54 +00002730 import_str = PyString_InternFromString("__import__");
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002731 if (import_str == NULL)
2732 return NULL;
Gregory P. Smithdd96db62008-06-09 04:58:54 +00002733 builtins_str = PyString_InternFromString("__builtins__");
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002734 if (builtins_str == NULL)
2735 return NULL;
2736 silly_list = Py_BuildValue("[s]", "__doc__");
2737 if (silly_list == NULL)
2738 return NULL;
2739 }
2740
2741 /* Get the builtins from current globals */
2742 globals = PyEval_GetGlobals();
Guido van Rossum85cd1d62001-02-20 21:43:24 +00002743 if (globals != NULL) {
Guido van Rossum66468561998-10-22 15:46:50 +00002744 Py_INCREF(globals);
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002745 builtins = PyObject_GetItem(globals, builtins_str);
2746 if (builtins == NULL)
2747 goto err;
2748 }
2749 else {
2750 /* No globals -- use standard builtins, and fake globals */
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002751 builtins = PyImport_ImportModuleLevel("__builtin__",
2752 NULL, NULL, NULL, 0);
Guido van Rossum85cd1d62001-02-20 21:43:24 +00002753 if (builtins == NULL)
2754 return NULL;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002755 globals = Py_BuildValue("{OO}", builtins_str, builtins);
2756 if (globals == NULL)
2757 goto err;
2758 }
2759
2760 /* Get the __import__ function from the builtins */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002761 if (PyDict_Check(builtins)) {
Fred Drakea76ba6e2001-03-06 06:31:15 +00002762 import = PyObject_GetItem(builtins, import_str);
Tim Peters6d6c1a32001-08-02 04:15:00 +00002763 if (import == NULL)
2764 PyErr_SetObject(PyExc_KeyError, import_str);
2765 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002766 else
Fred Drakea76ba6e2001-03-06 06:31:15 +00002767 import = PyObject_GetAttr(builtins, import_str);
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002768 if (import == NULL)
2769 goto err;
2770
Christian Heimes000a0742008-01-03 22:16:32 +00002771 /* Call the __import__ function with the proper argument list
2772 * Always use absolute import here. */
2773 r = PyObject_CallFunction(import, "OOOOi", module_name, globals,
2774 globals, silly_list, 0, NULL);
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002775
2776 err:
2777 Py_XDECREF(globals);
2778 Py_XDECREF(builtins);
2779 Py_XDECREF(import);
Tim Peters50d8d372001-02-28 05:34:27 +00002780
Guido van Rossumd47a0a81997-08-14 20:11:26 +00002781 return r;
2782}
2783
2784
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002785/* Module 'imp' provides Python access to the primitives used for
2786 importing modules.
2787*/
2788
Guido van Rossum79f25d91997-04-29 20:08:16 +00002789static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +00002790imp_get_magic(PyObject *self, PyObject *noargs)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002791{
2792 char buf[4];
2793
Guido van Rossum96774c12000-05-01 20:19:08 +00002794 buf[0] = (char) ((pyc_magic >> 0) & 0xff);
2795 buf[1] = (char) ((pyc_magic >> 8) & 0xff);
2796 buf[2] = (char) ((pyc_magic >> 16) & 0xff);
2797 buf[3] = (char) ((pyc_magic >> 24) & 0xff);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002798
Gregory P. Smithdd96db62008-06-09 04:58:54 +00002799 return PyString_FromStringAndSize(buf, 4);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002800}
2801
Guido van Rossum79f25d91997-04-29 20:08:16 +00002802static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +00002803imp_get_suffixes(PyObject *self, PyObject *noargs)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002804{
Guido van Rossum79f25d91997-04-29 20:08:16 +00002805 PyObject *list;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002806 struct filedescr *fdp;
2807
Guido van Rossum79f25d91997-04-29 20:08:16 +00002808 list = PyList_New(0);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002809 if (list == NULL)
2810 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002811 for (fdp = _PyImport_Filetab; fdp->suffix != NULL; fdp++) {
2812 PyObject *item = Py_BuildValue("ssi",
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002813 fdp->suffix, fdp->mode, fdp->type);
2814 if (item == NULL) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00002815 Py_DECREF(list);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002816 return NULL;
2817 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002818 if (PyList_Append(list, item) < 0) {
2819 Py_DECREF(list);
2820 Py_DECREF(item);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002821 return NULL;
2822 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002823 Py_DECREF(item);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002824 }
2825 return list;
2826}
2827
Guido van Rossum79f25d91997-04-29 20:08:16 +00002828static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002829call_find_module(char *name, PyObject *path)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002830{
Tim Petersdbd9ba62000-07-09 03:09:57 +00002831 extern int fclose(FILE *);
Guido van Rossum79f25d91997-04-29 20:08:16 +00002832 PyObject *fob, *ret;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002833 struct filedescr *fdp;
2834 char pathname[MAXPATHLEN+1];
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002835 FILE *fp = NULL;
2836
2837 pathname[0] = '\0';
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002838 if (path == Py_None)
2839 path = NULL;
Just van Rossum52e14d62002-12-30 22:08:05 +00002840 fdp = find_module(NULL, name, path, pathname, MAXPATHLEN+1, &fp, NULL);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002841 if (fdp == NULL)
2842 return NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002843 if (fp != NULL) {
2844 fob = PyFile_FromFile(fp, pathname, fdp->mode, fclose);
2845 if (fob == NULL) {
2846 fclose(fp);
2847 return NULL;
2848 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002849 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002850 else {
2851 fob = Py_None;
2852 Py_INCREF(fob);
Tim Peters50d8d372001-02-28 05:34:27 +00002853 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002854 ret = Py_BuildValue("Os(ssi)",
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002855 fob, pathname, fdp->suffix, fdp->mode, fdp->type);
Guido van Rossum79f25d91997-04-29 20:08:16 +00002856 Py_DECREF(fob);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002857 return ret;
2858}
2859
Guido van Rossum79f25d91997-04-29 20:08:16 +00002860static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002861imp_find_module(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002862{
2863 char *name;
2864 PyObject *path = NULL;
Guido van Rossum43713e52000-02-29 13:59:29 +00002865 if (!PyArg_ParseTuple(args, "s|O:find_module", &name, &path))
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002866 return NULL;
2867 return call_find_module(name, path);
2868}
2869
2870static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002871imp_init_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002872{
2873 char *name;
2874 int ret;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002875 PyObject *m;
Guido van Rossum43713e52000-02-29 13:59:29 +00002876 if (!PyArg_ParseTuple(args, "s:init_builtin", &name))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002877 return NULL;
2878 ret = init_builtin(name);
2879 if (ret < 0)
2880 return NULL;
2881 if (ret == 0) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00002882 Py_INCREF(Py_None);
2883 return Py_None;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002884 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002885 m = PyImport_AddModule(name);
2886 Py_XINCREF(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002887 return m;
2888}
2889
Guido van Rossum79f25d91997-04-29 20:08:16 +00002890static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002891imp_init_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002892{
2893 char *name;
2894 int ret;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002895 PyObject *m;
Guido van Rossum43713e52000-02-29 13:59:29 +00002896 if (!PyArg_ParseTuple(args, "s:init_frozen", &name))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002897 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002898 ret = PyImport_ImportFrozenModule(name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002899 if (ret < 0)
2900 return NULL;
2901 if (ret == 0) {
Guido van Rossum79f25d91997-04-29 20:08:16 +00002902 Py_INCREF(Py_None);
2903 return Py_None;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002904 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002905 m = PyImport_AddModule(name);
2906 Py_XINCREF(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002907 return m;
2908}
2909
Guido van Rossum79f25d91997-04-29 20:08:16 +00002910static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002911imp_get_frozen_object(PyObject *self, PyObject *args)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002912{
2913 char *name;
Jack Jansen95ffa231995-10-03 14:38:41 +00002914
Guido van Rossum43713e52000-02-29 13:59:29 +00002915 if (!PyArg_ParseTuple(args, "s:get_frozen_object", &name))
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002916 return NULL;
2917 return get_frozen_object(name);
2918}
2919
Guido van Rossum79f25d91997-04-29 20:08:16 +00002920static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002921imp_is_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002922{
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002923 char *name;
Guido van Rossum43713e52000-02-29 13:59:29 +00002924 if (!PyArg_ParseTuple(args, "s:is_builtin", &name))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002925 return NULL;
Guido van Rossum50ee94f2002-04-09 18:00:58 +00002926 return PyInt_FromLong(is_builtin(name));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002927}
2928
Guido van Rossum79f25d91997-04-29 20:08:16 +00002929static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002930imp_is_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002931{
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002932 char *name;
Guido van Rossum323bf5e1998-06-24 03:54:06 +00002933 struct _frozen *p;
Guido van Rossum43713e52000-02-29 13:59:29 +00002934 if (!PyArg_ParseTuple(args, "s:is_frozen", &name))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002935 return NULL;
Guido van Rossum323bf5e1998-06-24 03:54:06 +00002936 p = find_frozen(name);
Guido van Rossumb8bff3f2002-04-07 06:34:38 +00002937 return PyBool_FromLong((long) (p == NULL ? 0 : p->size));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002938}
2939
2940static FILE *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002941get_file(char *pathname, PyObject *fob, char *mode)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002942{
2943 FILE *fp;
2944 if (fob == NULL) {
Tim Peters86c7d2f2004-08-01 23:24:21 +00002945 if (mode[0] == 'U')
Jeremy Hylton4ae6fae2002-05-30 17:15:25 +00002946 mode = "r" PY_STDIOTEXTMODE;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002947 fp = fopen(pathname, mode);
2948 if (fp == NULL)
Guido van Rossum79f25d91997-04-29 20:08:16 +00002949 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002950 }
2951 else {
Guido van Rossum79f25d91997-04-29 20:08:16 +00002952 fp = PyFile_AsFile(fob);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002953 if (fp == NULL)
Guido van Rossum79f25d91997-04-29 20:08:16 +00002954 PyErr_SetString(PyExc_ValueError,
2955 "bad/closed file object");
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002956 }
2957 return fp;
2958}
2959
Guido van Rossum79f25d91997-04-29 20:08:16 +00002960static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002961imp_load_compiled(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002962{
2963 char *name;
2964 char *pathname;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002965 PyObject *fob = NULL;
2966 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002967 FILE *fp;
Guido van Rossum43713e52000-02-29 13:59:29 +00002968 if (!PyArg_ParseTuple(args, "ss|O!:load_compiled", &name, &pathname,
Guido van Rossum79f25d91997-04-29 20:08:16 +00002969 &PyFile_Type, &fob))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002970 return NULL;
2971 fp = get_file(pathname, fob, "rb");
2972 if (fp == NULL)
2973 return NULL;
2974 m = load_compiled_module(name, pathname, fp);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002975 if (fob == NULL)
2976 fclose(fp);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002977 return m;
2978}
2979
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002980#ifdef HAVE_DYNAMIC_LOADING
2981
Guido van Rossum79f25d91997-04-29 20:08:16 +00002982static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002983imp_load_dynamic(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002984{
2985 char *name;
2986 char *pathname;
Guido van Rossum79f25d91997-04-29 20:08:16 +00002987 PyObject *fob = NULL;
2988 PyObject *m;
Guido van Rossum7faeab31995-07-07 22:50:36 +00002989 FILE *fp = NULL;
Guido van Rossum43713e52000-02-29 13:59:29 +00002990 if (!PyArg_ParseTuple(args, "ss|O!:load_dynamic", &name, &pathname,
Guido van Rossum79f25d91997-04-29 20:08:16 +00002991 &PyFile_Type, &fob))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002992 return NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002993 if (fob) {
Guido van Rossum7faeab31995-07-07 22:50:36 +00002994 fp = get_file(pathname, fob, "r");
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002995 if (fp == NULL)
2996 return NULL;
2997 }
Guido van Rossum79f25d91997-04-29 20:08:16 +00002998 m = _PyImport_LoadDynamicModule(name, pathname, fp);
Guido van Rossum7faeab31995-07-07 22:50:36 +00002999 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003000}
3001
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003002#endif /* HAVE_DYNAMIC_LOADING */
3003
Guido van Rossum79f25d91997-04-29 20:08:16 +00003004static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003005imp_load_source(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003006{
3007 char *name;
3008 char *pathname;
Guido van Rossum79f25d91997-04-29 20:08:16 +00003009 PyObject *fob = NULL;
3010 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003011 FILE *fp;
Guido van Rossum43713e52000-02-29 13:59:29 +00003012 if (!PyArg_ParseTuple(args, "ss|O!:load_source", &name, &pathname,
Guido van Rossum79f25d91997-04-29 20:08:16 +00003013 &PyFile_Type, &fob))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003014 return NULL;
3015 fp = get_file(pathname, fob, "r");
3016 if (fp == NULL)
3017 return NULL;
3018 m = load_source_module(name, pathname, fp);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003019 if (fob == NULL)
3020 fclose(fp);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003021 return m;
3022}
3023
Guido van Rossum79f25d91997-04-29 20:08:16 +00003024static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003025imp_load_module(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003026{
3027 char *name;
3028 PyObject *fob;
3029 char *pathname;
3030 char *suffix; /* Unused */
3031 char *mode;
3032 int type;
3033 FILE *fp;
3034
Guido van Rossum43713e52000-02-29 13:59:29 +00003035 if (!PyArg_ParseTuple(args, "sOs(ssi):load_module",
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003036 &name, &fob, &pathname,
3037 &suffix, &mode, &type))
3038 return NULL;
Guido van Rossum5e2c5fa2002-05-30 17:33:07 +00003039 if (*mode) {
3040 /* Mode must start with 'r' or 'U' and must not contain '+'.
3041 Implicit in this test is the assumption that the mode
3042 may contain other modifiers like 'b' or 't'. */
3043
3044 if (!(*mode == 'r' || *mode == 'U') || strchr(mode, '+')) {
Jeremy Hylton4ae6fae2002-05-30 17:15:25 +00003045 PyErr_Format(PyExc_ValueError,
3046 "invalid file open mode %.200s", mode);
3047 return NULL;
Guido van Rossum5e2c5fa2002-05-30 17:33:07 +00003048 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003049 }
3050 if (fob == Py_None)
3051 fp = NULL;
3052 else {
3053 if (!PyFile_Check(fob)) {
3054 PyErr_SetString(PyExc_ValueError,
3055 "load_module arg#2 should be a file or None");
3056 return NULL;
3057 }
3058 fp = get_file(pathname, fob, mode);
3059 if (fp == NULL)
3060 return NULL;
3061 }
Just van Rossum52e14d62002-12-30 22:08:05 +00003062 return load_module(name, fp, pathname, type, NULL);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003063}
3064
3065static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003066imp_load_package(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003067{
3068 char *name;
3069 char *pathname;
Guido van Rossum43713e52000-02-29 13:59:29 +00003070 if (!PyArg_ParseTuple(args, "ss:load_package", &name, &pathname))
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003071 return NULL;
3072 return load_package(name, pathname);
3073}
3074
3075static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003076imp_new_module(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003077{
3078 char *name;
Guido van Rossum43713e52000-02-29 13:59:29 +00003079 if (!PyArg_ParseTuple(args, "s:new_module", &name))
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003080 return NULL;
Guido van Rossum79f25d91997-04-29 20:08:16 +00003081 return PyModule_New(name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003082}
3083
Brett Cannon3aa2a492008-08-06 22:28:09 +00003084static PyObject *
3085imp_reload(PyObject *self, PyObject *v)
3086{
3087 return PyImport_ReloadModule(v);
3088}
3089
3090
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003091/* Doc strings */
3092
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003093PyDoc_STRVAR(doc_imp,
3094"This module provides the components needed to build your own\n\
3095__import__ function. Undocumented functions are obsolete.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003096
Brett Cannon3aa2a492008-08-06 22:28:09 +00003097PyDoc_STRVAR(doc_reload,
3098"reload(module) -> module\n\
3099\n\
3100Reload the module. The module must have been successfully imported before.");
3101
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003102PyDoc_STRVAR(doc_find_module,
3103"find_module(name, [path]) -> (file, filename, (suffix, mode, type))\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003104Search for a module. If path is omitted or None, search for a\n\
3105built-in, frozen or special module and continue search in sys.path.\n\
3106The module name cannot contain '.'; to search for a submodule of a\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003107package, pass the submodule name and the package's __path__.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003108
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003109PyDoc_STRVAR(doc_load_module,
3110"load_module(name, file, filename, (suffix, mode, type)) -> module\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003111Load a module, given information returned by find_module().\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003112The module name must include the full package name, if any.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003113
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003114PyDoc_STRVAR(doc_get_magic,
3115"get_magic() -> string\n\
3116Return the magic number for .pyc or .pyo files.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003117
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003118PyDoc_STRVAR(doc_get_suffixes,
3119"get_suffixes() -> [(suffix, mode, type), ...]\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003120Return a list of (suffix, mode, type) tuples describing the files\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003121that find_module() looks for.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003122
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003123PyDoc_STRVAR(doc_new_module,
3124"new_module(name) -> module\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003125Create a new module. Do not enter it in sys.modules.\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003126The module name must include the full package name, if any.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003127
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003128PyDoc_STRVAR(doc_lock_held,
Tim Petersa7c65092004-08-01 23:26:05 +00003129"lock_held() -> boolean\n\
3130Return True if the import lock is currently held, else False.\n\
3131On platforms without threads, return False.");
Tim Peters69232342001-08-30 05:16:13 +00003132
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00003133PyDoc_STRVAR(doc_acquire_lock,
3134"acquire_lock() -> None\n\
Neal Norwitz2294c0d2003-02-12 23:02:21 +00003135Acquires the interpreter's import lock for the current thread.\n\
3136This lock should be used by import hooks to ensure thread-safety\n\
3137when importing modules.\n\
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00003138On platforms without threads, this function does nothing.");
3139
3140PyDoc_STRVAR(doc_release_lock,
3141"release_lock() -> None\n\
3142Release the interpreter's import lock.\n\
3143On platforms without threads, this function does nothing.");
3144
Guido van Rossum79f25d91997-04-29 20:08:16 +00003145static PyMethodDef imp_methods[] = {
Brett Cannon3aa2a492008-08-06 22:28:09 +00003146 {"reload", imp_reload, METH_O, doc_reload},
Neal Norwitz08ea61a2003-02-17 18:18:00 +00003147 {"find_module", imp_find_module, METH_VARARGS, doc_find_module},
3148 {"get_magic", imp_get_magic, METH_NOARGS, doc_get_magic},
3149 {"get_suffixes", imp_get_suffixes, METH_NOARGS, doc_get_suffixes},
3150 {"load_module", imp_load_module, METH_VARARGS, doc_load_module},
3151 {"new_module", imp_new_module, METH_VARARGS, doc_new_module},
3152 {"lock_held", imp_lock_held, METH_NOARGS, doc_lock_held},
3153 {"acquire_lock", imp_acquire_lock, METH_NOARGS, doc_acquire_lock},
3154 {"release_lock", imp_release_lock, METH_NOARGS, doc_release_lock},
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003155 /* The rest are obsolete */
Neal Norwitz031829d2002-03-31 14:37:44 +00003156 {"get_frozen_object", imp_get_frozen_object, METH_VARARGS},
3157 {"init_builtin", imp_init_builtin, METH_VARARGS},
3158 {"init_frozen", imp_init_frozen, METH_VARARGS},
3159 {"is_builtin", imp_is_builtin, METH_VARARGS},
3160 {"is_frozen", imp_is_frozen, METH_VARARGS},
3161 {"load_compiled", imp_load_compiled, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003162#ifdef HAVE_DYNAMIC_LOADING
Neal Norwitz031829d2002-03-31 14:37:44 +00003163 {"load_dynamic", imp_load_dynamic, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003164#endif
Neal Norwitz031829d2002-03-31 14:37:44 +00003165 {"load_package", imp_load_package, METH_VARARGS},
Neal Norwitz031829d2002-03-31 14:37:44 +00003166 {"load_source", imp_load_source, METH_VARARGS},
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003167 {NULL, NULL} /* sentinel */
3168};
3169
Guido van Rossum1a8791e1998-08-04 22:46:29 +00003170static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003171setint(PyObject *d, char *name, int value)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003172{
3173 PyObject *v;
3174 int err;
3175
3176 v = PyInt_FromLong((long)value);
3177 err = PyDict_SetItemString(d, name, v);
3178 Py_XDECREF(v);
3179 return err;
3180}
3181
Phillip J. Ebyf7575d02006-07-28 21:12:07 +00003182typedef struct {
3183 PyObject_HEAD
3184} NullImporter;
3185
3186static int
3187NullImporter_init(NullImporter *self, PyObject *args, PyObject *kwds)
3188{
3189 char *path;
Christian Heimescea681b2007-11-07 17:50:54 +00003190 Py_ssize_t pathlen;
Phillip J. Ebyf7575d02006-07-28 21:12:07 +00003191
3192 if (!_PyArg_NoKeywords("NullImporter()", kwds))
3193 return -1;
3194
3195 if (!PyArg_ParseTuple(args, "s:NullImporter",
3196 &path))
3197 return -1;
3198
Christian Heimescea681b2007-11-07 17:50:54 +00003199 pathlen = strlen(path);
3200 if (pathlen == 0) {
Phillip J. Ebyf7575d02006-07-28 21:12:07 +00003201 PyErr_SetString(PyExc_ImportError, "empty pathname");
3202 return -1;
3203 } else {
3204#ifndef RISCOS
Kristján Valur Jónsson3b2a6b82009-01-09 20:10:59 +00003205#ifndef MS_WINDOWS
Phillip J. Ebyf7575d02006-07-28 21:12:07 +00003206 struct stat statbuf;
3207 int rv;
3208
3209 rv = stat(path, &statbuf);
3210 if (rv == 0) {
3211 /* it exists */
3212 if (S_ISDIR(statbuf.st_mode)) {
3213 /* it's a directory */
3214 PyErr_SetString(PyExc_ImportError,
3215 "existing directory");
3216 return -1;
3217 }
3218 }
Kristján Valur Jónsson3b2a6b82009-01-09 20:10:59 +00003219#else /* MS_WINDOWS */
3220 DWORD rv;
3221 /* see issue1293 and issue3677:
3222 * stat() on Windows doesn't recognise paths like
3223 * "e:\\shared\\" and "\\\\whiterab-c2znlh\\shared" as dirs.
3224 */
3225 rv = GetFileAttributesA(path);
3226 if (rv != INVALID_FILE_ATTRIBUTES) {
3227 /* it exists */
3228 if (rv & FILE_ATTRIBUTE_DIRECTORY) {
3229 /* it's a directory */
3230 PyErr_SetString(PyExc_ImportError,
3231 "existing directory");
3232 return -1;
3233 }
3234 }
3235#endif
3236#else /* RISCOS */
Phillip J. Ebyf7575d02006-07-28 21:12:07 +00003237 if (object_exists(path)) {
3238 /* it exists */
3239 if (isdir(path)) {
3240 /* it's a directory */
3241 PyErr_SetString(PyExc_ImportError,
3242 "existing directory");
3243 return -1;
3244 }
3245 }
3246#endif
3247 }
3248 return 0;
3249}
3250
3251static PyObject *
3252NullImporter_find_module(NullImporter *self, PyObject *args)
3253{
3254 Py_RETURN_NONE;
3255}
3256
3257static PyMethodDef NullImporter_methods[] = {
3258 {"find_module", (PyCFunction)NullImporter_find_module, METH_VARARGS,
3259 "Always return None"
3260 },
3261 {NULL} /* Sentinel */
3262};
3263
3264
Nick Coghlan327a39b2007-11-18 11:56:28 +00003265PyTypeObject PyNullImporter_Type = {
Martin v. Löwis68192102007-07-21 06:55:02 +00003266 PyVarObject_HEAD_INIT(NULL, 0)
Phillip J. Ebyf7575d02006-07-28 21:12:07 +00003267 "imp.NullImporter", /*tp_name*/
3268 sizeof(NullImporter), /*tp_basicsize*/
3269 0, /*tp_itemsize*/
3270 0, /*tp_dealloc*/
3271 0, /*tp_print*/
3272 0, /*tp_getattr*/
3273 0, /*tp_setattr*/
3274 0, /*tp_compare*/
3275 0, /*tp_repr*/
3276 0, /*tp_as_number*/
3277 0, /*tp_as_sequence*/
3278 0, /*tp_as_mapping*/
3279 0, /*tp_hash */
3280 0, /*tp_call*/
3281 0, /*tp_str*/
3282 0, /*tp_getattro*/
3283 0, /*tp_setattro*/
3284 0, /*tp_as_buffer*/
3285 Py_TPFLAGS_DEFAULT, /*tp_flags*/
3286 "Null importer object", /* tp_doc */
3287 0, /* tp_traverse */
3288 0, /* tp_clear */
3289 0, /* tp_richcompare */
3290 0, /* tp_weaklistoffset */
3291 0, /* tp_iter */
3292 0, /* tp_iternext */
3293 NullImporter_methods, /* tp_methods */
3294 0, /* tp_members */
3295 0, /* tp_getset */
3296 0, /* tp_base */
3297 0, /* tp_dict */
3298 0, /* tp_descr_get */
3299 0, /* tp_descr_set */
3300 0, /* tp_dictoffset */
3301 (initproc)NullImporter_init, /* tp_init */
3302 0, /* tp_alloc */
3303 PyType_GenericNew /* tp_new */
3304};
3305
3306
Jason Tishler6bc06ec2003-09-04 11:59:50 +00003307PyMODINIT_FUNC
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003308initimp(void)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003309{
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003310 PyObject *m, *d;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003311
Nick Coghlan327a39b2007-11-18 11:56:28 +00003312 if (PyType_Ready(&PyNullImporter_Type) < 0)
Phillip J. Ebyf7575d02006-07-28 21:12:07 +00003313 goto failure;
3314
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003315 m = Py_InitModule4("imp", imp_methods, doc_imp,
3316 NULL, PYTHON_API_VERSION);
Neal Norwitz1ac754f2006-01-19 06:09:39 +00003317 if (m == NULL)
3318 goto failure;
Guido van Rossum79f25d91997-04-29 20:08:16 +00003319 d = PyModule_GetDict(m);
Neal Norwitz3cb31ac2006-08-13 18:10:47 +00003320 if (d == NULL)
3321 goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003322
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003323 if (setint(d, "SEARCH_ERROR", SEARCH_ERROR) < 0) goto failure;
3324 if (setint(d, "PY_SOURCE", PY_SOURCE) < 0) goto failure;
3325 if (setint(d, "PY_COMPILED", PY_COMPILED) < 0) goto failure;
3326 if (setint(d, "C_EXTENSION", C_EXTENSION) < 0) goto failure;
3327 if (setint(d, "PY_RESOURCE", PY_RESOURCE) < 0) goto failure;
3328 if (setint(d, "PKG_DIRECTORY", PKG_DIRECTORY) < 0) goto failure;
3329 if (setint(d, "C_BUILTIN", C_BUILTIN) < 0) goto failure;
3330 if (setint(d, "PY_FROZEN", PY_FROZEN) < 0) goto failure;
Guido van Rossum0f84a341998-08-06 13:36:01 +00003331 if (setint(d, "PY_CODERESOURCE", PY_CODERESOURCE) < 0) goto failure;
Just van Rossum52e14d62002-12-30 22:08:05 +00003332 if (setint(d, "IMP_HOOK", IMP_HOOK) < 0) goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003333
Nick Coghlan327a39b2007-11-18 11:56:28 +00003334 Py_INCREF(&PyNullImporter_Type);
3335 PyModule_AddObject(m, "NullImporter", (PyObject *)&PyNullImporter_Type);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003336 failure:
3337 ;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003338}
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003339
3340
Guido van Rossumb18618d2000-05-03 23:44:39 +00003341/* API for embedding applications that want to add their own entries
3342 to the table of built-in modules. This should normally be called
3343 *before* Py_Initialize(). When the table resize fails, -1 is
3344 returned and the existing table is unchanged.
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003345
3346 After a similar function by Just van Rossum. */
3347
3348int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003349PyImport_ExtendInittab(struct _inittab *newtab)
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003350{
3351 static struct _inittab *our_copy = NULL;
3352 struct _inittab *p;
3353 int i, n;
3354
3355 /* Count the number of entries in both tables */
3356 for (n = 0; newtab[n].name != NULL; n++)
3357 ;
3358 if (n == 0)
3359 return 0; /* Nothing to do */
3360 for (i = 0; PyImport_Inittab[i].name != NULL; i++)
3361 ;
3362
3363 /* Allocate new memory for the combined table */
Guido van Rossumb18618d2000-05-03 23:44:39 +00003364 p = our_copy;
3365 PyMem_RESIZE(p, struct _inittab, i+n+1);
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003366 if (p == NULL)
3367 return -1;
3368
3369 /* Copy the tables into the new memory */
3370 if (our_copy != PyImport_Inittab)
3371 memcpy(p, PyImport_Inittab, (i+1) * sizeof(struct _inittab));
3372 PyImport_Inittab = our_copy = p;
3373 memcpy(p+i, newtab, (n+1) * sizeof(struct _inittab));
3374
3375 return 0;
3376}
3377
3378/* Shorthand to add a single entry given a name and a function */
3379
3380int
Brett Cannonc4f90eb2009-04-02 03:17:39 +00003381PyImport_AppendInittab(const char *name, void (*initfunc)(void))
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003382{
3383 struct _inittab newtab[2];
3384
3385 memset(newtab, '\0', sizeof newtab);
3386
Brett Cannon238cedc2009-04-02 03:34:53 +00003387 newtab[0].name = (char *)name;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003388 newtab[0].initfunc = initfunc;
3389
3390 return PyImport_ExtendInittab(newtab);
3391}
Anthony Baxterac6bd462006-04-13 02:06:09 +00003392
3393#ifdef __cplusplus
3394}
3395#endif