blob: 979058e58309487c8b8f45482c3fa3c25033255a [file] [log] [blame]
Guido van Rossumf70e43a1991-02-19 12:39:46 +00001
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002/* Module definition and import implementation */
3
Guido van Rossum79f25d91997-04-29 20:08:16 +00004#include "Python.h"
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00005
Jeremy Hylton3e0055f2005-10-20 19:59:25 +00006#include "Python-ast.h"
Guido van Rossumd8faa362007-04-27 19:54:29 +00007#undef Yield /* undefine macro conflicting with winbase.h */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00008#include "errcode.h"
Guido van Rossumc405b7b1991-06-04 19:39:42 +00009#include "marshal.h"
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000010#include "code.h"
Guido van Rossumd8bac6d1992-02-26 15:19:13 +000011#include "osdefs.h"
Guido van Rossum1ae940a1995-01-02 19:04:15 +000012#include "importdl.h"
Guido van Rossumc405b7b1991-06-04 19:39:42 +000013
Guido van Rossum55a83382000-09-20 20:31:38 +000014#ifdef HAVE_FCNTL_H
15#include <fcntl.h>
16#endif
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000017#ifdef __cplusplus
Brett Cannon9a5b25a2010-03-01 02:09:17 +000018extern "C" {
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000019#endif
Guido van Rossum55a83382000-09-20 20:31:38 +000020
Christian Heimesd3eb5a152008-02-24 00:38:49 +000021#ifdef MS_WINDOWS
22/* for stat.st_mode */
23typedef unsigned short mode_t;
Daniel Stutzbachc7937792010-09-09 21:18:04 +000024/* for _mkdir */
25#include <direct.h>
Christian Heimesd3eb5a152008-02-24 00:38:49 +000026#endif
27
Guido van Rossum21d335e1993-10-15 13:01:11 +000028
Jeremy Hyltond4ceb312004-04-01 02:45:22 +000029/* Magic word to reject .pyc files generated by other Python versions.
30 It should change for each incompatible change to the bytecode.
31
32 The value of CR and LF is incorporated so if you ever read or write
Guido van Rossum7faeab31995-07-07 22:50:36 +000033 a .pyc file in text mode the magic number will be wrong; also, the
Tim Peters36515e22001-11-18 04:06:29 +000034 Apple MPW compiler swaps their values, botching string constants.
Marc-André Lemburgbd3be8f2002-02-07 11:33:49 +000035
Guido van Rossum45aecf42006-03-15 04:58:47 +000036 The magic numbers must be spaced apart at least 2 values, as the
Martin v. Löwisef82d2f2004-06-27 16:51:46 +000037 -U interpeter flag will cause MAGIC+1 being used. They have been
38 odd numbers for some time now.
Marc-André Lemburgbd3be8f2002-02-07 11:33:49 +000039
Jeremy Hyltond4ceb312004-04-01 02:45:22 +000040 There were a variety of old schemes for setting the magic number.
41 The current working scheme is to increment the previous value by
42 10.
Guido van Rossumf6894922002-08-31 15:16:14 +000043
Barry Warsaw28a691b2010-04-17 00:19:56 +000044 Starting with the adoption of PEP 3147 in Python 3.2, every bump in magic
45 number also includes a new "magic tag", i.e. a human readable string used
46 to represent the magic number in __pycache__ directories. When you change
47 the magic number, you must also set a new unique magic tag. Generally this
48 can be named after the Python major version of the magic number bump, but
49 it can really be anything, as long as it's different than anything else
50 that's come before. The tags are included in the following table, starting
51 with Python 3.2a0.
52
Marc-André Lemburgbd3be8f2002-02-07 11:33:49 +000053 Known values:
54 Python 1.5: 20121
55 Python 1.5.1: 20121
56 Python 1.5.2: 20121
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000057 Python 1.6: 50428
Marc-André Lemburgbd3be8f2002-02-07 11:33:49 +000058 Python 2.0: 50823
59 Python 2.0.1: 50823
60 Python 2.1: 60202
61 Python 2.1.1: 60202
62 Python 2.1.2: 60202
63 Python 2.2: 60717
Neal Norwitz7fdcb412002-06-14 01:07:39 +000064 Python 2.3a0: 62011
Michael W. Hudsondd32a912002-08-15 14:59:02 +000065 Python 2.3a0: 62021
Guido van Rossumf6894922002-08-31 15:16:14 +000066 Python 2.3a0: 62011 (!)
Martin v. Löwisef82d2f2004-06-27 16:51:46 +000067 Python 2.4a0: 62041
Raymond Hettingerfd2d1f72004-08-23 23:37:48 +000068 Python 2.4a3: 62051
Raymond Hettinger2c31a052004-09-22 18:44:21 +000069 Python 2.4b1: 62061
Michael W. Hudsondf888462005-06-03 14:41:55 +000070 Python 2.5a0: 62071
Michael W. Hudsonaee2e282005-10-21 11:32:20 +000071 Python 2.5a0: 62081 (ast-branch)
Guido van Rossumc2e20742006-02-27 22:32:47 +000072 Python 2.5a0: 62091 (with)
Guido van Rossumf6694362006-03-10 02:28:35 +000073 Python 2.5a0: 62092 (changed WITH_CLEANUP opcode)
Thomas Wouters0e3f5912006-08-11 14:57:12 +000074 Python 2.5b3: 62101 (fix wrong code: for x, in ...)
75 Python 2.5b3: 62111 (fix wrong code: x += yield)
76 Python 2.5c1: 62121 (fix wrong lnotab with for loops and
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000077 storing constants that should have been removed)
Thomas Wouters89f507f2006-12-13 04:49:30 +000078 Python 2.5c2: 62131 (fix wrong code: for x, in ... in listcomp/genexp)
Christian Heimes99170a52007-12-19 02:07:34 +000079 Python 2.6a0: 62151 (peephole optimizations and STORE_MAP opcode)
Christian Heimesdd15f6c2008-03-16 00:07:10 +000080 Python 2.6a1: 62161 (WITH_CLEANUP optimization)
Guido van Rossum45aecf42006-03-15 04:58:47 +000081 Python 3000: 3000
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000082 3010 (removed UNARY_CONVERT)
83 3020 (added BUILD_SET)
84 3030 (added keyword-only parameters)
85 3040 (added signature annotations)
86 3050 (print becomes a function)
87 3060 (PEP 3115 metaclass syntax)
88 3061 (string literals become unicode)
89 3071 (PEP 3109 raise changes)
90 3081 (PEP 3137 make __file__ and __name__ unicode)
91 3091 (kill str8 interning)
92 3101 (merge from 2.6a0, see 62151)
93 3103 (__file__ points to source file)
Benjamin Peterson0f6cae02009-12-10 02:09:08 +000094 Python 3.0a4: 3111 (WITH_CLEANUP optimization).
95 Python 3.0a5: 3131 (lexical exception stacking, including POP_EXCEPT)
96 Python 3.1a0: 3141 (optimize list, set and dict comprehensions:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000097 change LIST_APPEND and SET_ADD, add MAP_ADD)
Benjamin Peterson0f6cae02009-12-10 02:09:08 +000098 Python 3.1a0: 3151 (optimize conditional branches:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000099 introduce POP_JUMP_IF_FALSE and POP_JUMP_IF_TRUE)
Benjamin Peterson876b2f22009-06-28 03:18:59 +0000100 Python 3.2a0: 3160 (add SETUP_WITH)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000101 tag: cpython-32
Antoine Pitrou74a69fa2010-09-04 18:43:52 +0000102 Python 3.2a1: 3170 (add DUP_TOP_TWO, remove DUP_TOPX and ROT_FOUR)
103 tag: cpython-32
Benjamin Peterson6246d6d2010-09-10 21:51:44 +0000104 Python 3.2a2 3180 (add DELETE_DEREF)
Tim Peters36515e22001-11-18 04:06:29 +0000105*/
Guido van Rossum3ddee711991-12-16 13:06:34 +0000106
Nick Coghlancd419ab2010-09-11 00:39:25 +0000107/* MAGIC must change whenever the bytecode emitted by the compiler may no
108 longer be understood by older implementations of the eval loop (usually
109 due to the addition of new opcodes)
Victor Stinner2f42ae52011-03-20 00:41:24 +0100110 TAG and PYC_TAG_UNICODE must change for each major Python release. The magic
111 number will take care of any bytecode changes that occur during development.
Barry Warsaw28a691b2010-04-17 00:19:56 +0000112*/
Benjamin Peterson6246d6d2010-09-10 21:51:44 +0000113#define MAGIC (3180 | ((long)'\r'<<16) | ((long)'\n'<<24))
Barry Warsaw28a691b2010-04-17 00:19:56 +0000114#define TAG "cpython-32"
115#define CACHEDIR "__pycache__"
Victor Stinnerc9abda02011-03-14 13:33:46 -0400116static const Py_UNICODE CACHEDIR_UNICODE[] = {
117 '_', '_', 'p', 'y', 'c', 'a', 'c', 'h', 'e', '_', '_', '\0'};
Barry Warsaw28a691b2010-04-17 00:19:56 +0000118/* Current magic word and string tag as globals. */
Guido van Rossum96774c12000-05-01 20:19:08 +0000119static long pyc_magic = MAGIC;
Barry Warsaw28a691b2010-04-17 00:19:56 +0000120static const char *pyc_tag = TAG;
Victor Stinner2f42ae52011-03-20 00:41:24 +0100121static const Py_UNICODE PYC_TAG_UNICODE[] = {
122 'c', 'p', 'y', 't', 'h', 'o', 'n', '-', '3', '2', '\0'};
Guido van Rossum96774c12000-05-01 20:19:08 +0000123
Victor Stinner95872862011-03-07 18:20:56 +0100124/* See _PyImport_FixupExtensionObject() below */
Guido van Rossum25ce5661997-08-02 03:10:38 +0000125static PyObject *extensions = NULL;
Guido van Rossum3f5da241990-12-20 15:06:42 +0000126
Guido van Rossum771c6c81997-10-31 18:37:24 +0000127/* This table is defined in config.c: */
128extern struct _inittab _PyImport_Inittab[];
129
Guido van Rossumce3a72a2007-10-19 23:16:50 +0000130/* Method from Parser/tokenizer.c */
Guido van Rossum40d20bc2007-10-22 00:09:51 +0000131extern char * PyTokenizer_FindEncoding(int);
Guido van Rossumce3a72a2007-10-19 23:16:50 +0000132
Guido van Rossum771c6c81997-10-31 18:37:24 +0000133struct _inittab *PyImport_Inittab = _PyImport_Inittab;
Guido van Rossum66f1fa81991-04-03 19:03:52 +0000134
Guido van Rossumed1170e1999-12-20 21:23:41 +0000135/* these tables define the module suffixes that Python recognizes */
136struct filedescr * _PyImport_Filetab = NULL;
Guido van Rossum48a680c2001-03-02 06:34:14 +0000137
Guido van Rossumed1170e1999-12-20 21:23:41 +0000138static const struct filedescr _PyImport_StandardFiletab[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000139 {".py", "U", PY_SOURCE},
Martin v. Löwis6238d2b2002-06-30 15:26:10 +0000140#ifdef MS_WINDOWS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000141 {".pyw", "U", PY_SOURCE},
Tim Peters36515e22001-11-18 04:06:29 +0000142#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000143 {".pyc", "rb", PY_COMPILED},
144 {0, 0}
Guido van Rossumed1170e1999-12-20 21:23:41 +0000145};
146
Victor Stinnerd0296212011-03-14 14:04:10 -0400147static PyObject *initstr = NULL;
148
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000149
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000150/* Initialize things */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000151
152void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000153_PyImport_Init(void)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000154{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000155 const struct filedescr *scan;
156 struct filedescr *filetab;
157 int countD = 0;
158 int countS = 0;
Guido van Rossumed1170e1999-12-20 21:23:41 +0000159
Victor Stinnerd0296212011-03-14 14:04:10 -0400160 initstr = PyUnicode_InternFromString("__init__");
161 if (initstr == NULL)
162 Py_FatalError("Can't initialize import variables");
163
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000164 /* prepare _PyImport_Filetab: copy entries from
165 _PyImport_DynLoadFiletab and _PyImport_StandardFiletab.
166 */
Guido van Rossum04110fb2007-08-24 16:32:05 +0000167#ifdef HAVE_DYNAMIC_LOADING
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000168 for (scan = _PyImport_DynLoadFiletab; scan->suffix != NULL; ++scan)
169 ++countD;
Guido van Rossum04110fb2007-08-24 16:32:05 +0000170#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000171 for (scan = _PyImport_StandardFiletab; scan->suffix != NULL; ++scan)
172 ++countS;
173 filetab = PyMem_NEW(struct filedescr, countD + countS + 1);
174 if (filetab == NULL)
175 Py_FatalError("Can't initialize import file table.");
Guido van Rossum04110fb2007-08-24 16:32:05 +0000176#ifdef HAVE_DYNAMIC_LOADING
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000177 memcpy(filetab, _PyImport_DynLoadFiletab,
178 countD * sizeof(struct filedescr));
Guido van Rossum04110fb2007-08-24 16:32:05 +0000179#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000180 memcpy(filetab + countD, _PyImport_StandardFiletab,
181 countS * sizeof(struct filedescr));
182 filetab[countD + countS].suffix = NULL;
Guido van Rossumed1170e1999-12-20 21:23:41 +0000183
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000184 _PyImport_Filetab = filetab;
Guido van Rossumed1170e1999-12-20 21:23:41 +0000185
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000186 if (Py_OptimizeFlag) {
187 /* Replace ".pyc" with ".pyo" in _PyImport_Filetab */
188 for (; filetab->suffix != NULL; filetab++) {
189 if (strcmp(filetab->suffix, ".pyc") == 0)
190 filetab->suffix = ".pyo";
191 }
192 }
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000193}
194
Guido van Rossum25ce5661997-08-02 03:10:38 +0000195void
Just van Rossum52e14d62002-12-30 22:08:05 +0000196_PyImportHooks_Init(void)
197{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000198 PyObject *v, *path_hooks = NULL, *zimpimport;
199 int err = 0;
Just van Rossum52e14d62002-12-30 22:08:05 +0000200
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000201 /* adding sys.path_hooks and sys.path_importer_cache, setting up
202 zipimport */
203 if (PyType_Ready(&PyNullImporter_Type) < 0)
204 goto error;
Just van Rossum52e14d62002-12-30 22:08:05 +0000205
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000206 if (Py_VerboseFlag)
207 PySys_WriteStderr("# installing zipimport hook\n");
Just van Rossum52e14d62002-12-30 22:08:05 +0000208
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000209 v = PyList_New(0);
210 if (v == NULL)
211 goto error;
212 err = PySys_SetObject("meta_path", v);
213 Py_DECREF(v);
214 if (err)
215 goto error;
216 v = PyDict_New();
217 if (v == NULL)
218 goto error;
219 err = PySys_SetObject("path_importer_cache", v);
220 Py_DECREF(v);
221 if (err)
222 goto error;
223 path_hooks = PyList_New(0);
224 if (path_hooks == NULL)
225 goto error;
226 err = PySys_SetObject("path_hooks", path_hooks);
227 if (err) {
Just van Rossum52e14d62002-12-30 22:08:05 +0000228 error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000229 PyErr_Print();
230 Py_FatalError("initializing sys.meta_path, sys.path_hooks, "
231 "path_importer_cache, or NullImporter failed"
232 );
233 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000234
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000235 zimpimport = PyImport_ImportModule("zipimport");
236 if (zimpimport == NULL) {
237 PyErr_Clear(); /* No zip import module -- okay */
238 if (Py_VerboseFlag)
239 PySys_WriteStderr("# can't import zipimport\n");
240 }
241 else {
242 PyObject *zipimporter = PyObject_GetAttrString(zimpimport,
243 "zipimporter");
244 Py_DECREF(zimpimport);
245 if (zipimporter == NULL) {
246 PyErr_Clear(); /* No zipimporter object -- okay */
247 if (Py_VerboseFlag)
248 PySys_WriteStderr(
249 "# can't import zipimport.zipimporter\n");
250 }
251 else {
252 /* sys.path_hooks.append(zipimporter) */
253 err = PyList_Append(path_hooks, zipimporter);
254 Py_DECREF(zipimporter);
255 if (err)
256 goto error;
257 if (Py_VerboseFlag)
258 PySys_WriteStderr(
259 "# installed zipimport hook\n");
260 }
261 }
262 Py_DECREF(path_hooks);
Just van Rossum52e14d62002-12-30 22:08:05 +0000263}
264
265void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000266_PyImport_Fini(void)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000267{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000268 Py_XDECREF(extensions);
269 extensions = NULL;
270 PyMem_DEL(_PyImport_Filetab);
271 _PyImport_Filetab = NULL;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000272}
273
274
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000275/* Locking primitives to prevent parallel imports of the same module
276 in different threads to return with a partially loaded module.
277 These calls are serialized by the global interpreter lock. */
278
279#ifdef WITH_THREAD
280
Guido van Rossum49b56061998-10-01 20:42:43 +0000281#include "pythread.h"
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000282
Guido van Rossum65d5b571998-12-21 19:32:43 +0000283static PyThread_type_lock import_lock = 0;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000284static long import_lock_thread = -1;
285static int import_lock_level = 0;
286
Benjamin Peterson0df35a92009-10-04 20:32:25 +0000287void
288_PyImport_AcquireLock(void)
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000289{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000290 long me = PyThread_get_thread_ident();
291 if (me == -1)
292 return; /* Too bad */
293 if (import_lock == NULL) {
294 import_lock = PyThread_allocate_lock();
295 if (import_lock == NULL)
296 return; /* Nothing much we can do. */
297 }
298 if (import_lock_thread == me) {
299 import_lock_level++;
300 return;
301 }
302 if (import_lock_thread != -1 || !PyThread_acquire_lock(import_lock, 0))
303 {
304 PyThreadState *tstate = PyEval_SaveThread();
305 PyThread_acquire_lock(import_lock, 1);
306 PyEval_RestoreThread(tstate);
307 }
308 import_lock_thread = me;
309 import_lock_level = 1;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000310}
311
Benjamin Peterson0df35a92009-10-04 20:32:25 +0000312int
313_PyImport_ReleaseLock(void)
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000314{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000315 long me = PyThread_get_thread_ident();
316 if (me == -1 || import_lock == NULL)
317 return 0; /* Too bad */
318 if (import_lock_thread != me)
319 return -1;
320 import_lock_level--;
321 if (import_lock_level == 0) {
322 import_lock_thread = -1;
323 PyThread_release_lock(import_lock);
324 }
325 return 1;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000326}
327
Gregory P. Smith24cec9f2010-03-01 06:18:41 +0000328/* This function is called from PyOS_AfterFork to ensure that newly
329 created child processes do not share locks with the parent.
330 We now acquire the import lock around fork() calls but on some platforms
331 (Solaris 9 and earlier? see isue7242) that still left us with problems. */
Guido van Rossum8ee3e5a2005-09-14 18:09:42 +0000332
333void
334_PyImport_ReInitLock(void)
335{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000336 if (import_lock != NULL)
337 import_lock = PyThread_allocate_lock();
Nick Coghlanb2ddf792010-12-02 04:11:46 +0000338 if (import_lock_level > 1) {
339 /* Forked as a side effect of import */
340 long me = PyThread_get_thread_ident();
341 PyThread_acquire_lock(import_lock, 0);
Victor Stinner942003c2011-03-07 16:57:48 +0100342 /* XXX: can the previous line fail? */
Nick Coghlanb2ddf792010-12-02 04:11:46 +0000343 import_lock_thread = me;
344 import_lock_level--;
345 } else {
346 import_lock_thread = -1;
347 import_lock_level = 0;
348 }
Guido van Rossum8ee3e5a2005-09-14 18:09:42 +0000349}
350
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000351#endif
352
Tim Peters69232342001-08-30 05:16:13 +0000353static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000354imp_lock_held(PyObject *self, PyObject *noargs)
Tim Peters69232342001-08-30 05:16:13 +0000355{
Tim Peters69232342001-08-30 05:16:13 +0000356#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000357 return PyBool_FromLong(import_lock_thread != -1);
Tim Peters69232342001-08-30 05:16:13 +0000358#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000359 return PyBool_FromLong(0);
Tim Peters69232342001-08-30 05:16:13 +0000360#endif
361}
362
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000363static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000364imp_acquire_lock(PyObject *self, PyObject *noargs)
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000365{
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000366#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000367 _PyImport_AcquireLock();
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000368#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000369 Py_INCREF(Py_None);
370 return Py_None;
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000371}
372
373static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000374imp_release_lock(PyObject *self, PyObject *noargs)
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000375{
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000376#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000377 if (_PyImport_ReleaseLock() < 0) {
378 PyErr_SetString(PyExc_RuntimeError,
379 "not holding the import lock");
380 return NULL;
381 }
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000382#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000383 Py_INCREF(Py_None);
384 return Py_None;
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000385}
386
Guido van Rossumd8faa362007-04-27 19:54:29 +0000387static void
388imp_modules_reloading_clear(void)
389{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000390 PyInterpreterState *interp = PyThreadState_Get()->interp;
391 if (interp->modules_reloading != NULL)
392 PyDict_Clear(interp->modules_reloading);
Guido van Rossumd8faa362007-04-27 19:54:29 +0000393}
394
Guido van Rossum25ce5661997-08-02 03:10:38 +0000395/* Helper for sys */
396
397PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000398PyImport_GetModuleDict(void)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000399{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000400 PyInterpreterState *interp = PyThreadState_GET()->interp;
401 if (interp->modules == NULL)
402 Py_FatalError("PyImport_GetModuleDict: no module dictionary!");
403 return interp->modules;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000404}
405
Guido van Rossum3f5da241990-12-20 15:06:42 +0000406
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000407/* List of names to clear in sys */
408static char* sys_deletes[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000409 "path", "argv", "ps1", "ps2",
410 "last_type", "last_value", "last_traceback",
411 "path_hooks", "path_importer_cache", "meta_path",
412 /* misc stuff */
413 "flags", "float_info",
414 NULL
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000415};
416
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000417static char* sys_files[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000418 "stdin", "__stdin__",
419 "stdout", "__stdout__",
420 "stderr", "__stderr__",
421 NULL
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000422};
423
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000424
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000425/* Un-initialize things, as good as we can */
Guido van Rossum3f5da241990-12-20 15:06:42 +0000426
Guido van Rossum3f5da241990-12-20 15:06:42 +0000427void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000428PyImport_Cleanup(void)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000429{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000430 Py_ssize_t pos, ndone;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000431 PyObject *key, *value, *dict;
432 PyInterpreterState *interp = PyThreadState_GET()->interp;
433 PyObject *modules = interp->modules;
Guido van Rossum758eec01998-01-19 21:58:26 +0000434
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000435 if (modules == NULL)
436 return; /* Already done */
Guido van Rossum758eec01998-01-19 21:58:26 +0000437
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000438 /* Delete some special variables first. These are common
439 places where user values hide and people complain when their
440 destructors fail. Since the modules containing them are
441 deleted *last* of all, they would come too late in the normal
442 destruction order. Sigh. */
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000443
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000444 value = PyDict_GetItemString(modules, "builtins");
445 if (value != NULL && PyModule_Check(value)) {
446 dict = PyModule_GetDict(value);
447 if (Py_VerboseFlag)
448 PySys_WriteStderr("# clear builtins._\n");
449 PyDict_SetItemString(dict, "_", Py_None);
450 }
451 value = PyDict_GetItemString(modules, "sys");
452 if (value != NULL && PyModule_Check(value)) {
453 char **p;
454 PyObject *v;
455 dict = PyModule_GetDict(value);
456 for (p = sys_deletes; *p != NULL; p++) {
457 if (Py_VerboseFlag)
458 PySys_WriteStderr("# clear sys.%s\n", *p);
459 PyDict_SetItemString(dict, *p, Py_None);
460 }
461 for (p = sys_files; *p != NULL; p+=2) {
462 if (Py_VerboseFlag)
463 PySys_WriteStderr("# restore sys.%s\n", *p);
464 v = PyDict_GetItemString(dict, *(p+1));
465 if (v == NULL)
466 v = Py_None;
467 PyDict_SetItemString(dict, *p, v);
468 }
469 }
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000470
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000471 /* First, delete __main__ */
472 value = PyDict_GetItemString(modules, "__main__");
473 if (value != NULL && PyModule_Check(value)) {
474 if (Py_VerboseFlag)
475 PySys_WriteStderr("# cleanup __main__\n");
476 _PyModule_Clear(value);
477 PyDict_SetItemString(modules, "__main__", Py_None);
478 }
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000479
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000480 /* The special treatment of "builtins" here is because even
481 when it's not referenced as a module, its dictionary is
482 referenced by almost every module's __builtins__. Since
483 deleting a module clears its dictionary (even if there are
484 references left to it), we need to delete the "builtins"
485 module last. Likewise, we don't delete sys until the very
486 end because it is implicitly referenced (e.g. by print).
Guido van Rossum758eec01998-01-19 21:58:26 +0000487
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000488 Also note that we 'delete' modules by replacing their entry
489 in the modules dict with None, rather than really deleting
490 them; this avoids a rehash of the modules dictionary and
491 also marks them as "non existent" so they won't be
492 re-imported. */
Guido van Rossum758eec01998-01-19 21:58:26 +0000493
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000494 /* Next, repeatedly delete modules with a reference count of
495 one (skipping builtins and sys) and delete them */
496 do {
497 ndone = 0;
498 pos = 0;
499 while (PyDict_Next(modules, &pos, &key, &value)) {
500 if (value->ob_refcnt != 1)
501 continue;
502 if (PyUnicode_Check(key) && PyModule_Check(value)) {
Victor Stinner9464d612011-03-07 17:08:21 +0100503 if (PyUnicode_CompareWithASCIIString(key, "builtins") == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000504 continue;
Victor Stinner9464d612011-03-07 17:08:21 +0100505 if (PyUnicode_CompareWithASCIIString(key, "sys") == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000506 continue;
507 if (Py_VerboseFlag)
Victor Stinner9464d612011-03-07 17:08:21 +0100508 PySys_FormatStderr(
509 "# cleanup[1] %U\n", key);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000510 _PyModule_Clear(value);
511 PyDict_SetItem(modules, key, Py_None);
512 ndone++;
513 }
514 }
515 } while (ndone > 0);
Guido van Rossum758eec01998-01-19 21:58:26 +0000516
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000517 /* Next, delete all modules (still skipping builtins and sys) */
518 pos = 0;
519 while (PyDict_Next(modules, &pos, &key, &value)) {
520 if (PyUnicode_Check(key) && PyModule_Check(value)) {
Victor Stinner9464d612011-03-07 17:08:21 +0100521 if (PyUnicode_CompareWithASCIIString(key, "builtins") == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000522 continue;
Victor Stinner9464d612011-03-07 17:08:21 +0100523 if (PyUnicode_CompareWithASCIIString(key, "sys") == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000524 continue;
525 if (Py_VerboseFlag)
Victor Stinner9464d612011-03-07 17:08:21 +0100526 PySys_FormatStderr("# cleanup[2] %U\n", key);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000527 _PyModule_Clear(value);
528 PyDict_SetItem(modules, key, Py_None);
529 }
530 }
Guido van Rossum758eec01998-01-19 21:58:26 +0000531
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000532 /* Next, delete sys and builtins (in that order) */
533 value = PyDict_GetItemString(modules, "sys");
534 if (value != NULL && PyModule_Check(value)) {
535 if (Py_VerboseFlag)
536 PySys_WriteStderr("# cleanup sys\n");
537 _PyModule_Clear(value);
538 PyDict_SetItemString(modules, "sys", Py_None);
539 }
540 value = PyDict_GetItemString(modules, "builtins");
541 if (value != NULL && PyModule_Check(value)) {
542 if (Py_VerboseFlag)
543 PySys_WriteStderr("# cleanup builtins\n");
544 _PyModule_Clear(value);
545 PyDict_SetItemString(modules, "builtins", Py_None);
546 }
Guido van Rossum758eec01998-01-19 21:58:26 +0000547
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000548 /* Finally, clear and delete the modules directory */
549 PyDict_Clear(modules);
550 interp->modules = NULL;
551 Py_DECREF(modules);
552 Py_CLEAR(interp->modules_reloading);
Guido van Rossum8d15b5d1990-10-26 14:58:58 +0000553}
Guido van Rossum7f133ed1991-02-19 12:23:57 +0000554
555
Barry Warsaw28a691b2010-04-17 00:19:56 +0000556/* Helper for pythonrun.c -- return magic number and tag. */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000557
558long
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000559PyImport_GetMagicNumber(void)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000560{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000561 return pyc_magic;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000562}
563
564
Barry Warsaw28a691b2010-04-17 00:19:56 +0000565const char *
566PyImport_GetMagicTag(void)
567{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000568 return pyc_tag;
Barry Warsaw28a691b2010-04-17 00:19:56 +0000569}
570
Guido van Rossum25ce5661997-08-02 03:10:38 +0000571/* Magic for extension modules (built-in as well as dynamically
572 loaded). To prevent initializing an extension module more than
573 once, we keep a static dictionary 'extensions' keyed by module name
574 (for built-in modules) or by filename (for dynamically loaded
Barry Warsaw92883382001-08-13 23:05:44 +0000575 modules), containing these modules. A copy of the module's
Victor Stinner95872862011-03-07 18:20:56 +0100576 dictionary is stored by calling _PyImport_FixupExtensionObject()
Guido van Rossum25ce5661997-08-02 03:10:38 +0000577 immediately after the module initialization function succeeds. A
578 copy can be retrieved from there by calling
Victor Stinner95872862011-03-07 18:20:56 +0100579 _PyImport_FindExtensionObject().
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000580
Barry Warsaw7c9627b2010-06-17 18:38:20 +0000581 Modules which do support multiple initialization set their m_size
582 field to a non-negative number (indicating the size of the
583 module-specific state). They are still recorded in the extensions
584 dictionary, to avoid loading shared libraries twice.
Martin v. Löwis1a214512008-06-11 05:26:20 +0000585*/
586
587int
Victor Stinner95872862011-03-07 18:20:56 +0100588_PyImport_FixupExtensionObject(PyObject *mod, PyObject *name,
589 PyObject *filename)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000590{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000591 PyObject *modules, *dict;
592 struct PyModuleDef *def;
593 if (extensions == NULL) {
594 extensions = PyDict_New();
595 if (extensions == NULL)
596 return -1;
597 }
598 if (mod == NULL || !PyModule_Check(mod)) {
599 PyErr_BadInternalCall();
600 return -1;
601 }
602 def = PyModule_GetDef(mod);
603 if (!def) {
604 PyErr_BadInternalCall();
605 return -1;
606 }
607 modules = PyImport_GetModuleDict();
Victor Stinner95872862011-03-07 18:20:56 +0100608 if (PyDict_SetItem(modules, name, mod) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000609 return -1;
610 if (_PyState_AddModule(mod, def) < 0) {
Victor Stinner95872862011-03-07 18:20:56 +0100611 PyDict_DelItem(modules, name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000612 return -1;
613 }
614 if (def->m_size == -1) {
615 if (def->m_base.m_copy) {
616 /* Somebody already imported the module,
617 likely under a different name.
618 XXX this should really not happen. */
619 Py_DECREF(def->m_base.m_copy);
620 def->m_base.m_copy = NULL;
621 }
622 dict = PyModule_GetDict(mod);
623 if (dict == NULL)
624 return -1;
625 def->m_base.m_copy = PyDict_Copy(dict);
626 if (def->m_base.m_copy == NULL)
627 return -1;
628 }
Victor Stinner49d3f252010-10-17 01:24:53 +0000629 PyDict_SetItem(extensions, filename, (PyObject*)def);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000630 return 0;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000631}
632
Victor Stinner49d3f252010-10-17 01:24:53 +0000633int
634_PyImport_FixupBuiltin(PyObject *mod, char *name)
635{
636 int res;
Victor Stinner95872862011-03-07 18:20:56 +0100637 PyObject *nameobj;
Victor Stinner21fcd0c2011-03-07 18:28:15 +0100638 nameobj = PyUnicode_InternFromString(name);
Victor Stinner95872862011-03-07 18:20:56 +0100639 if (nameobj == NULL)
Victor Stinner49d3f252010-10-17 01:24:53 +0000640 return -1;
Victor Stinner95872862011-03-07 18:20:56 +0100641 res = _PyImport_FixupExtensionObject(mod, nameobj, nameobj);
642 Py_DECREF(nameobj);
Victor Stinner49d3f252010-10-17 01:24:53 +0000643 return res;
644}
645
Guido van Rossum25ce5661997-08-02 03:10:38 +0000646PyObject *
Victor Stinner95872862011-03-07 18:20:56 +0100647_PyImport_FindExtensionObject(PyObject *name, PyObject *filename)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000648{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000649 PyObject *mod, *mdict;
650 PyModuleDef* def;
651 if (extensions == NULL)
652 return NULL;
Victor Stinner49d3f252010-10-17 01:24:53 +0000653 def = (PyModuleDef*)PyDict_GetItem(extensions, filename);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000654 if (def == NULL)
655 return NULL;
656 if (def->m_size == -1) {
657 /* Module does not support repeated initialization */
658 if (def->m_base.m_copy == NULL)
659 return NULL;
Victor Stinner95872862011-03-07 18:20:56 +0100660 mod = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000661 if (mod == NULL)
662 return NULL;
663 mdict = PyModule_GetDict(mod);
664 if (mdict == NULL)
665 return NULL;
666 if (PyDict_Update(mdict, def->m_base.m_copy))
667 return NULL;
668 }
669 else {
670 if (def->m_base.m_init == NULL)
671 return NULL;
672 mod = def->m_base.m_init();
673 if (mod == NULL)
674 return NULL;
Victor Stinner95872862011-03-07 18:20:56 +0100675 PyDict_SetItem(PyImport_GetModuleDict(), name, mod);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000676 Py_DECREF(mod);
677 }
678 if (_PyState_AddModule(mod, def) < 0) {
Victor Stinner95872862011-03-07 18:20:56 +0100679 PyDict_DelItem(PyImport_GetModuleDict(), name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000680 Py_DECREF(mod);
681 return NULL;
682 }
683 if (Py_VerboseFlag)
Victor Stinner95872862011-03-07 18:20:56 +0100684 PySys_FormatStderr("import %U # previously loaded (%R)\n",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000685 name, filename);
686 return mod;
Brett Cannon9a5b25a2010-03-01 02:09:17 +0000687
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000688}
689
Victor Stinner49d3f252010-10-17 01:24:53 +0000690PyObject *
Victor Stinner501c09a2011-02-23 00:02:00 +0000691_PyImport_FindBuiltin(const char *name)
Victor Stinner49d3f252010-10-17 01:24:53 +0000692{
Victor Stinner95872862011-03-07 18:20:56 +0100693 PyObject *res, *nameobj;
Victor Stinner21fcd0c2011-03-07 18:28:15 +0100694 nameobj = PyUnicode_InternFromString(name);
Victor Stinner95872862011-03-07 18:20:56 +0100695 if (nameobj == NULL)
Victor Stinner49d3f252010-10-17 01:24:53 +0000696 return NULL;
Victor Stinner95872862011-03-07 18:20:56 +0100697 res = _PyImport_FindExtensionObject(nameobj, nameobj);
698 Py_DECREF(nameobj);
Victor Stinner49d3f252010-10-17 01:24:53 +0000699 return res;
700}
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000701
702/* Get the module object corresponding to a module name.
703 First check the modules dictionary if there's one there,
Walter Dörwaldf0dfc7a2003-10-20 14:01:56 +0000704 if not, create a new one and insert it in the modules dictionary.
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000705 Because the former action is most common, THIS DOES NOT RETURN A
706 'NEW' REFERENCE! */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000707
Guido van Rossum79f25d91997-04-29 20:08:16 +0000708PyObject *
Victor Stinner27ee0892011-03-04 12:57:09 +0000709PyImport_AddModuleObject(PyObject *name)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000710{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000711 PyObject *modules = PyImport_GetModuleDict();
712 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000713
Victor Stinner27ee0892011-03-04 12:57:09 +0000714 if ((m = PyDict_GetItem(modules, name)) != NULL &&
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000715 PyModule_Check(m))
716 return m;
Victor Stinner27ee0892011-03-04 12:57:09 +0000717 m = PyModule_NewObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000718 if (m == NULL)
719 return NULL;
Victor Stinner27ee0892011-03-04 12:57:09 +0000720 if (PyDict_SetItem(modules, name, m) != 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000721 Py_DECREF(m);
722 return NULL;
723 }
724 Py_DECREF(m); /* Yes, it still exists, in modules! */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000725
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000726 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000727}
728
Victor Stinner27ee0892011-03-04 12:57:09 +0000729PyObject *
730PyImport_AddModule(const char *name)
731{
732 PyObject *nameobj, *module;
733 nameobj = PyUnicode_FromString(name);
734 if (nameobj == NULL)
735 return NULL;
736 module = PyImport_AddModuleObject(nameobj);
737 Py_DECREF(nameobj);
738 return module;
739}
740
741
Tim Peters1cd70172004-08-02 03:52:12 +0000742/* Remove name from sys.modules, if it's there. */
743static void
Victor Stinner27ee0892011-03-04 12:57:09 +0000744remove_module(PyObject *name)
Tim Peters1cd70172004-08-02 03:52:12 +0000745{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000746 PyObject *modules = PyImport_GetModuleDict();
Victor Stinner27ee0892011-03-04 12:57:09 +0000747 if (PyDict_GetItem(modules, name) == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000748 return;
Victor Stinner27ee0892011-03-04 12:57:09 +0000749 if (PyDict_DelItem(modules, name) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000750 Py_FatalError("import: deleting existing key in"
751 "sys.modules failed");
Tim Peters1cd70172004-08-02 03:52:12 +0000752}
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000753
Victor Stinnerc9abda02011-03-14 13:33:46 -0400754static PyObject * get_sourcefile(PyObject *filename);
755static PyObject *make_source_pathname(PyObject *pathname);
Victor Stinner2f42ae52011-03-20 00:41:24 +0100756static PyObject* make_compiled_pathname(Py_UNICODE *pathname, int debug);
Christian Heimes3b06e532008-01-07 20:12:44 +0000757
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000758/* Execute a code object in a module and return the module object
Tim Peters1cd70172004-08-02 03:52:12 +0000759 * WITH INCREMENTED REFERENCE COUNT. If an error occurs, name is
760 * removed from sys.modules, to avoid leaving damaged module objects
761 * in sys.modules. The caller may wish to restore the original
762 * module object (if any) in this case; PyImport_ReloadModule is an
763 * example.
Barry Warsaw28a691b2010-04-17 00:19:56 +0000764 *
765 * Note that PyImport_ExecCodeModuleWithPathnames() is the preferred, richer
766 * interface. The other two exist primarily for backward compatibility.
Tim Peters1cd70172004-08-02 03:52:12 +0000767 */
Guido van Rossum79f25d91997-04-29 20:08:16 +0000768PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000769PyImport_ExecCodeModule(char *name, PyObject *co)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000770{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000771 return PyImport_ExecCodeModuleWithPathnames(
772 name, co, (char *)NULL, (char *)NULL);
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000773}
774
775PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000776PyImport_ExecCodeModuleEx(char *name, PyObject *co, char *pathname)
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000777{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000778 return PyImport_ExecCodeModuleWithPathnames(
779 name, co, pathname, (char *)NULL);
Barry Warsaw28a691b2010-04-17 00:19:56 +0000780}
781
782PyObject *
783PyImport_ExecCodeModuleWithPathnames(char *name, PyObject *co, char *pathname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000784 char *cpathname)
Barry Warsaw28a691b2010-04-17 00:19:56 +0000785{
Victor Stinner27ee0892011-03-04 12:57:09 +0000786 PyObject *m = NULL;
787 PyObject *nameobj, *pathobj = NULL, *cpathobj = NULL;
788
789 nameobj = PyUnicode_FromString(name);
790 if (nameobj == NULL)
791 return NULL;
792
793 if (pathname != NULL) {
794 pathobj = PyUnicode_DecodeFSDefault(pathname);
795 if (pathobj == NULL)
796 goto error;
797 } else
798 pathobj = NULL;
799 if (cpathname != NULL) {
800 cpathobj = PyUnicode_DecodeFSDefault(cpathname);
801 if (cpathobj == NULL)
802 goto error;
803 } else
804 cpathobj = NULL;
805 m = PyImport_ExecCodeModuleObject(nameobj, co, pathobj, cpathobj);
806error:
807 Py_DECREF(nameobj);
808 Py_XDECREF(pathobj);
809 Py_XDECREF(cpathobj);
810 return m;
811}
812
813PyObject*
814PyImport_ExecCodeModuleObject(PyObject *name, PyObject *co, PyObject *pathname,
815 PyObject *cpathname)
816{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000817 PyObject *modules = PyImport_GetModuleDict();
818 PyObject *m, *d, *v;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000819
Victor Stinner27ee0892011-03-04 12:57:09 +0000820 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000821 if (m == NULL)
822 return NULL;
823 /* If the module is being reloaded, we get the old module back
824 and re-use its dict to exec the new code. */
825 d = PyModule_GetDict(m);
826 if (PyDict_GetItemString(d, "__builtins__") == NULL) {
827 if (PyDict_SetItemString(d, "__builtins__",
828 PyEval_GetBuiltins()) != 0)
829 goto error;
830 }
831 /* Remember the filename as the __file__ attribute */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000832 if (pathname != NULL) {
Victor Stinnerc9abda02011-03-14 13:33:46 -0400833 v = get_sourcefile(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000834 if (v == NULL)
835 PyErr_Clear();
836 }
Victor Stinner27ee0892011-03-04 12:57:09 +0000837 else
838 v = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000839 if (v == NULL) {
840 v = ((PyCodeObject *)co)->co_filename;
841 Py_INCREF(v);
842 }
843 if (PyDict_SetItemString(d, "__file__", v) != 0)
844 PyErr_Clear(); /* Not important enough to report */
845 Py_DECREF(v);
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000846
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000847 /* Remember the pyc path name as the __cached__ attribute. */
Victor Stinner27ee0892011-03-04 12:57:09 +0000848 if (cpathname != NULL)
849 v = cpathname;
850 else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000851 v = Py_None;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000852 if (PyDict_SetItemString(d, "__cached__", v) != 0)
853 PyErr_Clear(); /* Not important enough to report */
Barry Warsaw28a691b2010-04-17 00:19:56 +0000854
Martin v. Löwis4d0d4712010-12-03 20:14:31 +0000855 v = PyEval_EvalCode(co, d, d);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000856 if (v == NULL)
857 goto error;
858 Py_DECREF(v);
Guido van Rossumb65e85c1997-07-10 18:00:45 +0000859
Victor Stinner27ee0892011-03-04 12:57:09 +0000860 if ((m = PyDict_GetItem(modules, name)) == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000861 PyErr_Format(PyExc_ImportError,
Victor Stinner27ee0892011-03-04 12:57:09 +0000862 "Loaded module %R not found in sys.modules",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000863 name);
864 return NULL;
865 }
Guido van Rossumb65e85c1997-07-10 18:00:45 +0000866
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000867 Py_INCREF(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000868
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000869 return m;
Tim Peters1cd70172004-08-02 03:52:12 +0000870
871 error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000872 remove_module(name);
873 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000874}
875
876
Barry Warsaw28a691b2010-04-17 00:19:56 +0000877/* Like strrchr(string, '/') but searches for the rightmost of either SEP
878 or ALTSEP, if the latter is defined.
879*/
Victor Stinnerc9abda02011-03-14 13:33:46 -0400880static Py_UNICODE*
Victor Stinner2f42ae52011-03-20 00:41:24 +0100881rightmost_sep(Py_UNICODE *s)
Victor Stinnerc9abda02011-03-14 13:33:46 -0400882{
883 Py_UNICODE *found, c;
884 for (found = NULL; (c = *s); s++) {
885 if (c == SEP
886#ifdef ALTSEP
887 || c == ALTSEP
888#endif
889 )
890 {
891 found = s;
892 }
893 }
894 return found;
895}
896
897
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000898/* Given a pathname for a Python source file, fill a buffer with the
899 pathname for the corresponding compiled file. Return the pathname
900 for the compiled file, or NULL if there's no space in the buffer.
Victor Stinner2f42ae52011-03-20 00:41:24 +0100901 Doesn't set an exception.
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000902
Victor Stinner2f42ae52011-03-20 00:41:24 +0100903 foo.py -> __pycache__/foo.<tag>.pyc */
904
905static PyObject*
906make_compiled_pathname(Py_UNICODE *pathname, int debug)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000907{
Victor Stinner2f42ae52011-03-20 00:41:24 +0100908 Py_UNICODE buf[MAXPATHLEN];
909 size_t buflen = (size_t)MAXPATHLEN;
910 size_t len = Py_UNICODE_strlen(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000911 size_t i, save;
Victor Stinner2f42ae52011-03-20 00:41:24 +0100912 Py_UNICODE *pos;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000913 int sep = SEP;
Barry Warsaw28a691b2010-04-17 00:19:56 +0000914
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000915 /* Sanity check that the buffer has roughly enough space to hold what
916 will eventually be the full path to the compiled file. The 5 extra
917 bytes include the slash afer __pycache__, the two extra dots, the
918 extra trailing character ('c' or 'o') and null. This isn't exact
919 because the contents of the buffer can affect how many actual
920 characters of the string get into the buffer. We'll do a final
921 sanity check before writing the extension to ensure we do not
922 overflow the buffer.
923 */
Victor Stinner2f42ae52011-03-20 00:41:24 +0100924 if (len + Py_UNICODE_strlen(CACHEDIR_UNICODE) + Py_UNICODE_strlen(PYC_TAG_UNICODE) + 5 > buflen)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000925 return NULL;
Tim Petersc1731372001-08-04 08:12:36 +0000926
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000927 /* Find the last path separator and copy everything from the start of
928 the source string up to and including the separator.
929 */
Victor Stinner2f42ae52011-03-20 00:41:24 +0100930 pos = rightmost_sep(pathname);
931 if (pos == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000932 i = 0;
933 }
934 else {
935 sep = *pos;
936 i = pos - pathname + 1;
Victor Stinner2f42ae52011-03-20 00:41:24 +0100937 Py_UNICODE_strncpy(buf, pathname, i);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000938 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000939
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000940 save = i;
941 buf[i++] = '\0';
942 /* Add __pycache__/ */
Victor Stinner2f42ae52011-03-20 00:41:24 +0100943 Py_UNICODE_strcat(buf, CACHEDIR_UNICODE);
944 i += Py_UNICODE_strlen(CACHEDIR_UNICODE) - 1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000945 buf[i++] = sep;
946 buf[i++] = '\0';
947 /* Add the base filename, but remove the .py or .pyw extension, since
948 the tag name must go before the extension.
949 */
Victor Stinner2f42ae52011-03-20 00:41:24 +0100950 Py_UNICODE_strcat(buf, pathname + save);
951 pos = Py_UNICODE_strrchr(buf, '.');
952 if (pos != NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000953 *++pos = '\0';
Victor Stinner2f42ae52011-03-20 00:41:24 +0100954 Py_UNICODE_strcat(buf, PYC_TAG_UNICODE);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000955 /* The length test above assumes that we're only adding one character
956 to the end of what would normally be the extension. What if there
957 is no extension, or the string ends in '.' or '.p', and otherwise
958 fills the buffer? By appending 4 more characters onto the string
959 here, we could overrun the buffer.
Barry Warsaw28a691b2010-04-17 00:19:56 +0000960
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000961 As a simple example, let's say buflen=32 and the input string is
962 'xxx.py'. strlen() would be 6 and the test above would yield:
Barry Warsaw28a691b2010-04-17 00:19:56 +0000963
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000964 (6 + 11 + 10 + 5 == 32) > 32
Barry Warsaw28a691b2010-04-17 00:19:56 +0000965
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000966 which is false and so the name mangling would continue. This would
967 be fine because we'd end up with this string in buf:
Barry Warsaw28a691b2010-04-17 00:19:56 +0000968
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000969 __pycache__/xxx.cpython-32.pyc\0
Barry Warsaw28a691b2010-04-17 00:19:56 +0000970
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000971 strlen(of that) == 30 + the nul fits inside a 32 character buffer.
972 We can even handle an input string of say 'xxxxx' above because
973 that's (5 + 11 + 10 + 5 == 31) > 32 which is also false. Name
974 mangling that yields:
Barry Warsaw28a691b2010-04-17 00:19:56 +0000975
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000976 __pycache__/xxxxxcpython-32.pyc\0
Barry Warsaw28a691b2010-04-17 00:19:56 +0000977
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000978 which is 32 characters including the nul, and thus fits in the
979 buffer. However, an input string of 'xxxxxx' would yield a result
980 string of:
Barry Warsaw28a691b2010-04-17 00:19:56 +0000981
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000982 __pycache__/xxxxxxcpython-32.pyc\0
Barry Warsaw28a691b2010-04-17 00:19:56 +0000983
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000984 which is 33 characters long (including the nul), thus overflowing
985 the buffer, even though the first test would fail, i.e.: the input
986 string is also 6 characters long, so 32 > 32 is false.
Barry Warsaw28a691b2010-04-17 00:19:56 +0000987
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000988 The reason the first test fails but we still overflow the buffer is
989 that the test above only expects to add one extra character to be
990 added to the extension, and here we're adding three (pyc). We
991 don't add the first dot, so that reclaims one of expected
992 positions, leaving us overflowing by 1 byte (3 extra - 1 reclaimed
993 dot - 1 expected extra == 1 overflowed).
Barry Warsaw28a691b2010-04-17 00:19:56 +0000994
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000995 The best we can do is ensure that we still have enough room in the
996 target buffer before we write the extension. Because it's always
997 only the extension that can cause the overflow, and never the other
998 path bytes we've written, it's sufficient to just do one more test
999 here. Still, the assertion that follows can't hurt.
1000 */
Barry Warsaw28a691b2010-04-17 00:19:56 +00001001#if 0
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001002 printf("strlen(buf): %d; buflen: %d\n", (int)strlen(buf), (int)buflen);
Barry Warsaw28a691b2010-04-17 00:19:56 +00001003#endif
Victor Stinner2f42ae52011-03-20 00:41:24 +01001004 len = Py_UNICODE_strlen(buf);
1005 if (len + 5 > buflen)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001006 return NULL;
Victor Stinner2f42ae52011-03-20 00:41:24 +01001007 buf[len] = '.'; len++;
1008 buf[len] = 'p'; len++;
1009 buf[len] = 'y'; len++;
1010 buf[len] = debug ? 'c' : 'o'; len++;
1011 assert(len <= buflen);
1012 return PyUnicode_FromUnicode(buf, len);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001013}
1014
1015
Barry Warsaw28a691b2010-04-17 00:19:56 +00001016/* Given a pathname to a Python byte compiled file, return the path to the
1017 source file, if the path matches the PEP 3147 format. This does not check
1018 for any file existence, however, if the pyc file name does not match PEP
1019 3147 style, NULL is returned. buf must be at least as big as pathname;
Victor Stinnerc9abda02011-03-14 13:33:46 -04001020 the resulting path will always be shorter.
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001021
Victor Stinnerc9abda02011-03-14 13:33:46 -04001022 (...)/__pycache__/foo.<tag>.pyc -> (...)/foo.py */
1023
1024static PyObject*
1025make_source_pathname(PyObject *pathobj)
Barry Warsaw28a691b2010-04-17 00:19:56 +00001026{
Victor Stinnerc9abda02011-03-14 13:33:46 -04001027 Py_UNICODE buf[MAXPATHLEN];
1028 Py_UNICODE *pathname;
1029 Py_UNICODE *left, *right, *dot0, *dot1, sep;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001030 size_t i, j;
Victor Stinnerc9abda02011-03-14 13:33:46 -04001031
1032 if (PyUnicode_GET_SIZE(pathobj) > MAXPATHLEN)
1033 return NULL;
1034 pathname = PyUnicode_AS_UNICODE(pathobj);
Barry Warsaw28a691b2010-04-17 00:19:56 +00001035
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001036 /* Look back two slashes from the end. In between these two slashes
1037 must be the string __pycache__ or this is not a PEP 3147 style
1038 path. It's possible for there to be only one slash.
1039 */
Victor Stinner2f42ae52011-03-20 00:41:24 +01001040 right = rightmost_sep(pathname);
Victor Stinnerc9abda02011-03-14 13:33:46 -04001041 if (right == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001042 return NULL;
1043 sep = *right;
1044 *right = '\0';
Victor Stinner2f42ae52011-03-20 00:41:24 +01001045 left = rightmost_sep(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001046 *right = sep;
1047 if (left == NULL)
1048 left = pathname;
1049 else
1050 left++;
Victor Stinnerc9abda02011-03-14 13:33:46 -04001051 if (right-left != Py_UNICODE_strlen(CACHEDIR_UNICODE) ||
1052 Py_UNICODE_strncmp(left, CACHEDIR_UNICODE, right-left) != 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001053 return NULL;
Barry Warsaw28a691b2010-04-17 00:19:56 +00001054
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001055 /* Now verify that the path component to the right of the last slash
1056 has two dots in it.
1057 */
Victor Stinnerc9abda02011-03-14 13:33:46 -04001058 if ((dot0 = Py_UNICODE_strchr(right + 1, '.')) == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001059 return NULL;
Victor Stinnerc9abda02011-03-14 13:33:46 -04001060 if ((dot1 = Py_UNICODE_strchr(dot0 + 1, '.')) == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001061 return NULL;
1062 /* Too many dots? */
Victor Stinnerc9abda02011-03-14 13:33:46 -04001063 if (Py_UNICODE_strchr(dot1 + 1, '.') != NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001064 return NULL;
Barry Warsaw28a691b2010-04-17 00:19:56 +00001065
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001066 /* This is a PEP 3147 path. Start by copying everything from the
1067 start of pathname up to and including the leftmost slash. Then
1068 copy the file's basename, removing the magic tag and adding a .py
1069 suffix.
1070 */
Victor Stinnerc9abda02011-03-14 13:33:46 -04001071 Py_UNICODE_strncpy(buf, pathname, (i=left-pathname));
1072 Py_UNICODE_strncpy(buf+i, right+1, (j=dot0-right));
1073 buf[i+j] = 'p';
1074 buf[i+j+1] = 'y';
1075 return PyUnicode_FromUnicode(buf, i+j+2);
Barry Warsaw28a691b2010-04-17 00:19:56 +00001076}
1077
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001078/* Given a pathname for a Python source file, its time of last
1079 modification, and a pathname for a compiled file, check whether the
1080 compiled file represents the same version of the source. If so,
1081 return a FILE pointer for the compiled file, positioned just after
1082 the header; if not, return NULL.
1083 Doesn't set an exception. */
1084
1085static FILE *
Victor Stinner2f42ae52011-03-20 00:41:24 +01001086check_compiled_module(PyObject *pathname, time_t mtime, PyObject *cpathname)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001087{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001088 FILE *fp;
1089 long magic;
1090 long pyc_mtime;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001091
Victor Stinner2f42ae52011-03-20 00:41:24 +01001092 fp = _Py_fopen(cpathname, "rb");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001093 if (fp == NULL)
1094 return NULL;
1095 magic = PyMarshal_ReadLongFromFile(fp);
1096 if (magic != pyc_magic) {
1097 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001098 PySys_FormatStderr("# %R has bad magic\n", cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001099 fclose(fp);
1100 return NULL;
1101 }
1102 pyc_mtime = PyMarshal_ReadLongFromFile(fp);
1103 if (pyc_mtime != mtime) {
1104 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001105 PySys_FormatStderr("# %R has bad mtime\n", cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001106 fclose(fp);
1107 return NULL;
1108 }
1109 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001110 PySys_FormatStderr("# %R matches %R\n", cpathname, pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001111 return fp;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001112}
1113
1114
1115/* Read a code object from a file and check it for validity */
1116
Guido van Rossum79f25d91997-04-29 20:08:16 +00001117static PyCodeObject *
Victor Stinner2f42ae52011-03-20 00:41:24 +01001118read_compiled_module(PyObject *cpathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001119{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001120 PyObject *co;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001121
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001122 co = PyMarshal_ReadLastObjectFromFile(fp);
1123 if (co == NULL)
1124 return NULL;
1125 if (!PyCode_Check(co)) {
1126 PyErr_Format(PyExc_ImportError,
Victor Stinner2f42ae52011-03-20 00:41:24 +01001127 "Non-code object in %R", cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001128 Py_DECREF(co);
1129 return NULL;
1130 }
1131 return (PyCodeObject *)co;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001132}
1133
1134
1135/* Load a module from a compiled file, execute it, and return its
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001136 module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001137
Guido van Rossum79f25d91997-04-29 20:08:16 +00001138static PyObject *
Victor Stinner2f42ae52011-03-20 00:41:24 +01001139load_compiled_module(PyObject *name, PyObject *cpathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001140{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001141 long magic;
1142 PyCodeObject *co;
1143 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001144
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001145 magic = PyMarshal_ReadLongFromFile(fp);
1146 if (magic != pyc_magic) {
1147 PyErr_Format(PyExc_ImportError,
Victor Stinner2f42ae52011-03-20 00:41:24 +01001148 "Bad magic number in %R", cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001149 return NULL;
1150 }
1151 (void) PyMarshal_ReadLongFromFile(fp);
1152 co = read_compiled_module(cpathname, fp);
1153 if (co == NULL)
1154 return NULL;
1155 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001156 PySys_FormatStderr("import %U # precompiled from %R\n",
1157 name, cpathname);
1158 m = PyImport_ExecCodeModuleObject(name, (PyObject *)co,
1159 cpathname, cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001160 Py_DECREF(co);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001161
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001162 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001163}
1164
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001165/* Parse a source file and return the corresponding code object */
1166
Guido van Rossum79f25d91997-04-29 20:08:16 +00001167static PyCodeObject *
Victor Stinner2f42ae52011-03-20 00:41:24 +01001168parse_source_module(PyObject *pathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001169{
Victor Stinner2f42ae52011-03-20 00:41:24 +01001170 PyCodeObject *co;
1171 PyObject *pathbytes;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001172 mod_ty mod;
1173 PyCompilerFlags flags;
Victor Stinner2f42ae52011-03-20 00:41:24 +01001174 PyArena *arena;
1175
1176 pathbytes = PyUnicode_EncodeFSDefault(pathname);
1177 if (pathbytes == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001178 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001179
Victor Stinner2f42ae52011-03-20 00:41:24 +01001180 arena = PyArena_New();
1181 if (arena == NULL) {
1182 Py_DECREF(pathbytes);
1183 return NULL;
1184 }
1185
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001186 flags.cf_flags = 0;
Victor Stinner2f42ae52011-03-20 00:41:24 +01001187 mod = PyParser_ASTFromFile(fp, PyBytes_AS_STRING(pathbytes), NULL,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001188 Py_file_input, 0, 0, &flags,
1189 NULL, arena);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001190 if (mod != NULL)
1191 co = PyAST_Compile(mod, PyBytes_AS_STRING(pathbytes), NULL, arena);
1192 else
1193 co = NULL;
1194 Py_DECREF(pathbytes);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001195 PyArena_Free(arena);
1196 return co;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001197}
1198
Guido van Rossum55a83382000-09-20 20:31:38 +00001199/* Helper to open a bytecode file for writing in exclusive mode */
1200
1201static FILE *
Christian Heimes05e8be12008-02-23 18:30:17 +00001202open_exclusive(char *filename, mode_t mode)
Guido van Rossum55a83382000-09-20 20:31:38 +00001203{
1204#if defined(O_EXCL)&&defined(O_CREAT)&&defined(O_WRONLY)&&defined(O_TRUNC)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001205 /* Use O_EXCL to avoid a race condition when another process tries to
1206 write the same file. When that happens, our open() call fails,
1207 which is just fine (since it's only a cache).
1208 XXX If the file exists and is writable but the directory is not
1209 writable, the file will never be written. Oh well.
1210 */
1211 int fd;
1212 (void) unlink(filename);
1213 fd = open(filename, O_EXCL|O_CREAT|O_WRONLY|O_TRUNC
Tim Peters42c83af2000-09-29 04:03:10 +00001214#ifdef O_BINARY
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001215 |O_BINARY /* necessary for Windows */
Tim Peters42c83af2000-09-29 04:03:10 +00001216#endif
Martin v. Löwis79acb9e2002-12-06 12:48:53 +00001217#ifdef __VMS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001218 , mode, "ctxt=bin", "shr=nil"
Martin v. Löwis79acb9e2002-12-06 12:48:53 +00001219#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001220 , mode
Martin v. Löwis79acb9e2002-12-06 12:48:53 +00001221#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001222 );
1223 if (fd < 0)
1224 return NULL;
1225 return fdopen(fd, "wb");
Guido van Rossum55a83382000-09-20 20:31:38 +00001226#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001227 /* Best we can do -- on Windows this can't happen anyway */
1228 return fopen(filename, "wb");
Guido van Rossum55a83382000-09-20 20:31:38 +00001229#endif
1230}
1231
1232
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001233/* Write a compiled module to a file, placing the time of last
1234 modification of its source into the header.
1235 Errors are ignored, if a write error occurs an attempt is made to
1236 remove the file. */
1237
1238static void
Victor Stinner2f42ae52011-03-20 00:41:24 +01001239write_compiled_module(PyCodeObject *co, PyObject *cpathname,
1240 struct stat *srcstat)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001241{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001242 FILE *fp;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001243 time_t mtime = srcstat->st_mtime;
Alexandre Vassalotti9d58e3e2009-07-17 10:55:50 +00001244#ifdef MS_WINDOWS /* since Windows uses different permissions */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001245 mode_t mode = srcstat->st_mode & ~S_IEXEC;
Alexandre Vassalotti9d58e3e2009-07-17 10:55:50 +00001246#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001247 mode_t mode = srcstat->st_mode & ~S_IXUSR & ~S_IXGRP & ~S_IXOTH;
1248 mode_t dirmode = (srcstat->st_mode |
1249 S_IXUSR | S_IXGRP | S_IXOTH |
1250 S_IWUSR | S_IWGRP | S_IWOTH);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001251 PyObject *dirbytes;
Brett Cannon9a5b25a2010-03-01 02:09:17 +00001252#endif
Victor Stinner2f42ae52011-03-20 00:41:24 +01001253 PyObject *cpathbytes, *dirname;
1254 Py_UNICODE *dirsep;
1255 int res, ok;
Barry Warsaw28a691b2010-04-17 00:19:56 +00001256
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001257 /* Ensure that the __pycache__ directory exists. */
Victor Stinner2f42ae52011-03-20 00:41:24 +01001258 dirsep = rightmost_sep(PyUnicode_AS_UNICODE(cpathname));
1259 if (dirsep == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001260 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001261 PySys_FormatStderr("# no %s path found %R\n", CACHEDIR, cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001262 return;
1263 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01001264 dirname = PyUnicode_FromUnicode(PyUnicode_AS_UNICODE(cpathname),
1265 dirsep - PyUnicode_AS_UNICODE(cpathname));
1266 if (dirname == NULL) {
1267 PyErr_Clear();
1268 return;
1269 }
Daniel Stutzbachc7937792010-09-09 21:18:04 +00001270
1271#ifdef MS_WINDOWS
Victor Stinner2f42ae52011-03-20 00:41:24 +01001272 res = CreateDirectoryW(PyUnicode_AS_UNICODE(dirname), NULL);
1273 ok = (res != 0);
1274 if (!ok && GetLastError() == ERROR_ALREADY_EXISTS)
1275 ok = 1;
Daniel Stutzbachc7937792010-09-09 21:18:04 +00001276#else
Victor Stinner2f42ae52011-03-20 00:41:24 +01001277 dirbytes = PyUnicode_EncodeFSDefault(dirname);
1278 if (dirbytes == NULL) {
1279 PyErr_Clear();
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001280 return;
1281 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01001282 res = mkdir(PyBytes_AS_STRING(dirbytes), dirmode);
1283 Py_DECREF(dirbytes);
1284 if (0 <= res)
1285 ok = 1;
1286 else
1287 ok = (errno == EEXIST);
1288#endif
1289 if (!ok) {
1290 if (Py_VerboseFlag)
1291 PySys_FormatStderr("# cannot create cache dir %R\n", dirname);
1292 Py_DECREF(dirname);
1293 return;
1294 }
1295 Py_DECREF(dirname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001296
Victor Stinner2f42ae52011-03-20 00:41:24 +01001297 cpathbytes = PyUnicode_EncodeFSDefault(cpathname);
1298 if (cpathbytes == NULL) {
1299 PyErr_Clear();
1300 return;
1301 }
1302
1303 fp = open_exclusive(PyBytes_AS_STRING(cpathbytes), mode);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001304 if (fp == NULL) {
1305 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001306 PySys_FormatStderr(
1307 "# can't create %R\n", cpathname);
1308 Py_DECREF(cpathbytes);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001309 return;
1310 }
1311 PyMarshal_WriteLongToFile(pyc_magic, fp, Py_MARSHAL_VERSION);
1312 /* First write a 0 for mtime */
1313 PyMarshal_WriteLongToFile(0L, fp, Py_MARSHAL_VERSION);
1314 PyMarshal_WriteObjectToFile((PyObject *)co, fp, Py_MARSHAL_VERSION);
1315 if (fflush(fp) != 0 || ferror(fp)) {
1316 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001317 PySys_FormatStderr("# can't write %R\n", cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001318 /* Don't keep partial file */
1319 fclose(fp);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001320#ifdef MS_WINDOWS
1321 (void)DeleteFileW(PyUnicode_AS_UNICODE(cpathname));
1322#else
1323 (void) unlink(PyBytes_AS_STRING(cpathbytes));
1324#endif
1325 Py_DECREF(cpathbytes);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001326 return;
1327 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01001328 Py_DECREF(cpathbytes);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001329 /* Now write the true mtime */
1330 fseek(fp, 4L, 0);
1331 assert(mtime < LONG_MAX);
1332 PyMarshal_WriteLongToFile((long)mtime, fp, Py_MARSHAL_VERSION);
1333 fflush(fp);
1334 fclose(fp);
1335 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001336 PySys_FormatStderr("# wrote %R\n", cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001337}
1338
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001339static void
1340update_code_filenames(PyCodeObject *co, PyObject *oldname, PyObject *newname)
1341{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001342 PyObject *constants, *tmp;
1343 Py_ssize_t i, n;
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001344
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001345 if (PyUnicode_Compare(co->co_filename, oldname))
1346 return;
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001347
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001348 tmp = co->co_filename;
1349 co->co_filename = newname;
1350 Py_INCREF(co->co_filename);
1351 Py_DECREF(tmp);
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001352
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001353 constants = co->co_consts;
1354 n = PyTuple_GET_SIZE(constants);
1355 for (i = 0; i < n; i++) {
1356 tmp = PyTuple_GET_ITEM(constants, i);
1357 if (PyCode_Check(tmp))
1358 update_code_filenames((PyCodeObject *)tmp,
1359 oldname, newname);
1360 }
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001361}
1362
Victor Stinner2f42ae52011-03-20 00:41:24 +01001363static void
1364update_compiled_module(PyCodeObject *co, PyObject *newname)
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001365{
Victor Stinner2f42ae52011-03-20 00:41:24 +01001366 PyObject *oldname;
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001367
Victor Stinner2f42ae52011-03-20 00:41:24 +01001368 if (PyUnicode_Compare(co->co_filename, newname) == 0)
1369 return;
Hirokazu Yamamoto4f447fb2009-03-04 01:52:10 +00001370
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001371 oldname = co->co_filename;
1372 Py_INCREF(oldname);
1373 update_code_filenames(co, oldname, newname);
1374 Py_DECREF(oldname);
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001375}
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001376
1377/* Load a source module from a given file and return its module
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001378 object WITH INCREMENTED REFERENCE COUNT. If there's a matching
1379 byte-compiled file, use that instead. */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001380
Guido van Rossum79f25d91997-04-29 20:08:16 +00001381static PyObject *
Victor Stinner2f42ae52011-03-20 00:41:24 +01001382load_source_module(PyObject *name, PyObject *pathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001383{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001384 struct stat st;
1385 FILE *fpc;
Victor Stinner2f42ae52011-03-20 00:41:24 +01001386 PyObject *cpathname = NULL, *cpathbytes = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001387 PyCodeObject *co;
Victor Stinner2f42ae52011-03-20 00:41:24 +01001388 PyObject *m = NULL;
Brett Cannon9a5b25a2010-03-01 02:09:17 +00001389
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001390 if (fstat(fileno(fp), &st) != 0) {
1391 PyErr_Format(PyExc_RuntimeError,
Victor Stinner2f42ae52011-03-20 00:41:24 +01001392 "unable to get file status from %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001393 pathname);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001394 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001395 }
Fred Drake4c82b232000-06-30 16:18:57 +00001396#if SIZEOF_TIME_T > 4
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001397 /* Python's .pyc timestamp handling presumes that the timestamp fits
1398 in 4 bytes. This will be fine until sometime in the year 2038,
1399 when a 4-byte signed time_t will overflow.
1400 */
1401 if (st.st_mtime >> 32) {
1402 PyErr_SetString(PyExc_OverflowError,
1403 "modification time overflows a 4 byte field");
Victor Stinner2f42ae52011-03-20 00:41:24 +01001404 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001405 }
Fred Drake4c82b232000-06-30 16:18:57 +00001406#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001407 cpathname = make_compiled_pathname(
Victor Stinner2f42ae52011-03-20 00:41:24 +01001408 PyUnicode_AS_UNICODE(pathname),
1409 !Py_OptimizeFlag);
1410
1411 if (cpathname != NULL)
1412 fpc = check_compiled_module(pathname, st.st_mtime, cpathname);
1413 else
1414 fpc = NULL;
1415
1416 if (fpc) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001417 co = read_compiled_module(cpathname, fpc);
1418 fclose(fpc);
1419 if (co == NULL)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001420 goto error;
1421 update_compiled_module(co, pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001422 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001423 PySys_FormatStderr("import %U # precompiled from %R\n",
1424 name, cpathname);
1425 m = PyImport_ExecCodeModuleObject(name, (PyObject *)co,
1426 cpathname, cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001427 }
1428 else {
1429 co = parse_source_module(pathname, fp);
1430 if (co == NULL)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001431 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001432 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001433 PySys_FormatStderr("import %U # from %R\n",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001434 name, pathname);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001435 if (cpathname != NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001436 PyObject *ro = PySys_GetObject("dont_write_bytecode");
1437 if (ro == NULL || !PyObject_IsTrue(ro))
1438 write_compiled_module(co, cpathname, &st);
1439 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01001440 m = PyImport_ExecCodeModuleObject(name, (PyObject *)co,
1441 pathname, cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001442 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001443 Py_DECREF(co);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001444
Victor Stinner2f42ae52011-03-20 00:41:24 +01001445error:
1446 Py_XDECREF(cpathbytes);
1447 Py_XDECREF(cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001448 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001449}
1450
Christian Heimes3b06e532008-01-07 20:12:44 +00001451/* Get source file -> unicode or None
1452 * Returns the path to the py file if available, else the given path
1453 */
1454static PyObject *
Victor Stinnerc9abda02011-03-14 13:33:46 -04001455get_sourcefile(PyObject *filename)
Christian Heimes3b06e532008-01-07 20:12:44 +00001456{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001457 Py_ssize_t len;
Victor Stinnerc9abda02011-03-14 13:33:46 -04001458 Py_UNICODE *fileuni;
1459 PyObject *py;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001460 struct stat statbuf;
Christian Heimes3b06e532008-01-07 20:12:44 +00001461
Victor Stinnerc9abda02011-03-14 13:33:46 -04001462 len = PyUnicode_GET_SIZE(filename);
1463 if (len == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001464 Py_RETURN_NONE;
Christian Heimes3b06e532008-01-07 20:12:44 +00001465
Victor Stinnerc9abda02011-03-14 13:33:46 -04001466 /* don't match *.pyc or *.pyo? */
1467 fileuni = PyUnicode_AS_UNICODE(filename);
1468 if (len < 5
1469 || fileuni[len-4] != '.'
1470 || (fileuni[len-3] != 'p' && fileuni[len-3] != 'P')
1471 || (fileuni[len-2] != 'y' && fileuni[len-2] != 'Y'))
1472 goto unchanged;
Christian Heimes3b06e532008-01-07 20:12:44 +00001473
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001474 /* Start by trying to turn PEP 3147 path into source path. If that
1475 * fails, just chop off the trailing character, i.e. legacy pyc path
1476 * to py.
1477 */
Victor Stinnerc9abda02011-03-14 13:33:46 -04001478 py = make_source_pathname(filename);
1479 if (py == NULL) {
1480 PyErr_Clear();
1481 py = PyUnicode_FromUnicode(fileuni, len - 1);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001482 }
Victor Stinnerc9abda02011-03-14 13:33:46 -04001483 if (py == NULL)
1484 goto error;
Barry Warsaw28a691b2010-04-17 00:19:56 +00001485
Victor Stinnerc9abda02011-03-14 13:33:46 -04001486 if (_Py_stat(py, &statbuf) == 0 && S_ISREG(statbuf.st_mode))
1487 return py;
1488 Py_DECREF(py);
1489 goto unchanged;
1490
1491error:
1492 PyErr_Clear();
1493unchanged:
1494 Py_INCREF(filename);
1495 return filename;
Christian Heimes3b06e532008-01-07 20:12:44 +00001496}
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001497
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001498/* Forward */
Victor Stinner41c5fec2011-03-13 21:46:30 -04001499static PyObject *load_module(PyObject *, FILE *, PyObject *, int, PyObject *);
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001500static struct filedescr *find_module(PyObject *, PyObject *, PyObject *,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001501 char *, size_t, FILE **, PyObject **);
Victor Stinner53dc7352011-03-20 01:50:21 +01001502static struct _frozen * find_frozen(PyObject *);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001503
1504/* Load a package and return its module object WITH INCREMENTED
1505 REFERENCE COUNT */
1506
1507static PyObject *
Victor Stinnerc9abda02011-03-14 13:33:46 -04001508load_package(PyObject *name, PyObject *pathname)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001509{
Victor Stinner41c5fec2011-03-13 21:46:30 -04001510 PyObject *m, *d, *bufobj;
Victor Stinnerc9abda02011-03-14 13:33:46 -04001511 PyObject *file = NULL, *path_list = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001512 int err;
1513 char buf[MAXPATHLEN+1];
Victor Stinnerc9abda02011-03-14 13:33:46 -04001514 FILE *fp = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001515 struct filedescr *fdp;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001516
Victor Stinnerc9abda02011-03-14 13:33:46 -04001517 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001518 if (m == NULL)
1519 return NULL;
1520 if (Py_VerboseFlag)
Victor Stinnerc9abda02011-03-14 13:33:46 -04001521 PySys_FormatStderr("import %U # directory %U\n",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001522 name, pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001523 file = get_sourcefile(pathname);
1524 if (file == NULL)
Victor Stinnerc9abda02011-03-14 13:33:46 -04001525 return NULL;
1526 path_list = Py_BuildValue("[O]", file);
1527 if (path_list == NULL) {
1528 Py_DECREF(file);
1529 return NULL;
1530 }
1531 d = PyModule_GetDict(m);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001532 err = PyDict_SetItemString(d, "__file__", file);
Victor Stinnerc9abda02011-03-14 13:33:46 -04001533 Py_DECREF(file);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001534 if (err == 0)
Victor Stinnerc9abda02011-03-14 13:33:46 -04001535 err = PyDict_SetItemString(d, "__path__", path_list);
1536 if (err != 0) {
1537 Py_DECREF(path_list);
1538 return NULL;
1539 }
Victor Stinner533d7832011-03-14 13:22:54 -04001540 fdp = find_module(name, initstr, path_list,
1541 buf, sizeof(buf), &fp, NULL);
Victor Stinnerc9abda02011-03-14 13:33:46 -04001542 Py_DECREF(path_list);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001543 if (fdp == NULL) {
1544 if (PyErr_ExceptionMatches(PyExc_ImportError)) {
1545 PyErr_Clear();
1546 Py_INCREF(m);
Victor Stinnerc9abda02011-03-14 13:33:46 -04001547 return m;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001548 }
1549 else
Victor Stinnerc9abda02011-03-14 13:33:46 -04001550 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001551 }
Victor Stinner41c5fec2011-03-13 21:46:30 -04001552 bufobj = PyUnicode_DecodeFSDefault(buf);
1553 if (bufobj != NULL) {
1554 m = load_module(name, fp, bufobj, fdp->type, NULL);
1555 Py_DECREF(bufobj);
1556 }
1557 else
1558 m = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001559 if (fp != NULL)
1560 fclose(fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001561 return m;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001562}
1563
1564
1565/* Helper to test for built-in module */
1566
1567static int
Victor Stinner95872862011-03-07 18:20:56 +01001568is_builtin(PyObject *name)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001569{
Victor Stinner95872862011-03-07 18:20:56 +01001570 int i, cmp;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001571 for (i = 0; PyImport_Inittab[i].name != NULL; i++) {
Victor Stinner95872862011-03-07 18:20:56 +01001572 cmp = PyUnicode_CompareWithASCIIString(name, PyImport_Inittab[i].name);
1573 if (cmp == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001574 if (PyImport_Inittab[i].initfunc == NULL)
1575 return -1;
1576 else
1577 return 1;
1578 }
1579 }
1580 return 0;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001581}
1582
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001583
Just van Rossum52e14d62002-12-30 22:08:05 +00001584/* Return an importer object for a sys.path/pkg.__path__ item 'p',
1585 possibly by fetching it from the path_importer_cache dict. If it
Thomas Wouters89f507f2006-12-13 04:49:30 +00001586 wasn't yet cached, traverse path_hooks until a hook is found
Just van Rossum52e14d62002-12-30 22:08:05 +00001587 that can handle the path item. Return None if no hook could;
1588 this tells our caller it should fall back to the builtin
1589 import mechanism. Cache the result in path_importer_cache.
1590 Returns a borrowed reference. */
1591
1592static PyObject *
1593get_path_importer(PyObject *path_importer_cache, PyObject *path_hooks,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001594 PyObject *p)
Just van Rossum52e14d62002-12-30 22:08:05 +00001595{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001596 PyObject *importer;
1597 Py_ssize_t j, nhooks;
Just van Rossum52e14d62002-12-30 22:08:05 +00001598
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001599 /* These conditions are the caller's responsibility: */
1600 assert(PyList_Check(path_hooks));
1601 assert(PyDict_Check(path_importer_cache));
Just van Rossum52e14d62002-12-30 22:08:05 +00001602
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001603 nhooks = PyList_Size(path_hooks);
1604 if (nhooks < 0)
1605 return NULL; /* Shouldn't happen */
Just van Rossum52e14d62002-12-30 22:08:05 +00001606
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001607 importer = PyDict_GetItem(path_importer_cache, p);
1608 if (importer != NULL)
1609 return importer;
Just van Rossum52e14d62002-12-30 22:08:05 +00001610
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001611 /* set path_importer_cache[p] to None to avoid recursion */
1612 if (PyDict_SetItem(path_importer_cache, p, Py_None) != 0)
1613 return NULL;
Just van Rossum52e14d62002-12-30 22:08:05 +00001614
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001615 for (j = 0; j < nhooks; j++) {
1616 PyObject *hook = PyList_GetItem(path_hooks, j);
1617 if (hook == NULL)
1618 return NULL;
1619 importer = PyObject_CallFunctionObjArgs(hook, p, NULL);
1620 if (importer != NULL)
1621 break;
Just van Rossum52e14d62002-12-30 22:08:05 +00001622
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001623 if (!PyErr_ExceptionMatches(PyExc_ImportError)) {
1624 return NULL;
1625 }
1626 PyErr_Clear();
1627 }
1628 if (importer == NULL) {
1629 importer = PyObject_CallFunctionObjArgs(
1630 (PyObject *)&PyNullImporter_Type, p, NULL
1631 );
1632 if (importer == NULL) {
1633 if (PyErr_ExceptionMatches(PyExc_ImportError)) {
1634 PyErr_Clear();
1635 return Py_None;
1636 }
1637 }
1638 }
1639 if (importer != NULL) {
1640 int err = PyDict_SetItem(path_importer_cache, p, importer);
1641 Py_DECREF(importer);
1642 if (err != 0)
1643 return NULL;
1644 }
1645 return importer;
Just van Rossum52e14d62002-12-30 22:08:05 +00001646}
1647
Christian Heimes9cd17752007-11-18 19:35:23 +00001648PyAPI_FUNC(PyObject *)
1649PyImport_GetImporter(PyObject *path) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001650 PyObject *importer=NULL, *path_importer_cache=NULL, *path_hooks=NULL;
Christian Heimes9cd17752007-11-18 19:35:23 +00001651
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001652 if ((path_importer_cache = PySys_GetObject("path_importer_cache"))) {
1653 if ((path_hooks = PySys_GetObject("path_hooks"))) {
1654 importer = get_path_importer(path_importer_cache,
1655 path_hooks, path);
1656 }
1657 }
1658 Py_XINCREF(importer); /* get_path_importer returns a borrowed reference */
1659 return importer;
Christian Heimes9cd17752007-11-18 19:35:23 +00001660}
1661
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001662/* Search the path (default sys.path) for a module. Return the
1663 corresponding filedescr struct, and (via return arguments) the
1664 pathname and an open file. Return NULL if the module is not found. */
1665
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001666#ifdef MS_COREDLL
Victor Stinner4d6c1c42011-03-08 23:49:04 +01001667extern FILE *_PyWin_FindRegisteredModule(PyObject *, struct filedescr **,
1668 PyObject **p_path);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001669#endif
1670
Victor Stinnerc6963162011-03-12 09:26:54 -05001671static int case_ok(char *, Py_ssize_t, Py_ssize_t, const char *);
Tim Petersdbd9ba62000-07-09 03:09:57 +00001672static int find_init_module(char *); /* Forward */
Just van Rossum52e14d62002-12-30 22:08:05 +00001673static struct filedescr importhookdescr = {"", "", IMP_HOOK};
Guido van Rossum197346f1997-10-31 18:38:52 +00001674
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001675/* Get the path of a module: get its importer and call importer.find_module()
1676 hook, or check if the module if a package (if path/__init__.py exists).
1677
1678 -1: error: a Python error occurred
1679 0: ignore: an error occurred because of invalid data, but the error is not
1680 important enough to be reported.
1681 1: get path: module not found, but *buf contains its path
1682 2: found: *p_fd is the file descriptor (IMP_HOOK or PKG_DIRECTORY)
1683 and *buf is the path */
1684
1685static int
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001686find_module_path(PyObject *fullname, PyObject *name, PyObject *path,
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001687 PyObject *path_hooks, PyObject *path_importer_cache,
1688 char *buf, size_t buflen,
1689 PyObject **p_loader, struct filedescr **p_fd)
1690{
1691 PyObject *path_bytes;
1692 const char *base;
1693 Py_ssize_t len;
1694 size_t namelen;
1695 struct stat statbuf;
1696 static struct filedescr fd_package = {"", "", PKG_DIRECTORY};
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001697 char *namestr;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001698
1699 if (PyUnicode_Check(path)) {
1700 path_bytes = PyUnicode_EncodeFSDefault(path);
1701 if (path_bytes == NULL)
1702 return -1;
1703 }
1704 else if (PyBytes_Check(path)) {
1705 Py_INCREF(path);
1706 path_bytes = path;
1707 }
1708 else
1709 return 0;
1710
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001711 namestr = _PyUnicode_AsString(name);
1712 namelen = strlen(namestr);
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001713 base = PyBytes_AS_STRING(path_bytes);
1714 len = PyBytes_GET_SIZE(path_bytes);
1715 if (len + 2 + namelen + MAXSUFFIXSIZE >= buflen) {
1716 Py_DECREF(path_bytes);
1717 return 0; /* Too long */
1718 }
1719 strcpy(buf, base);
1720 Py_DECREF(path_bytes);
1721
1722 if (strlen(buf) != len) {
1723 return 0; /* path_bytes contains '\0' */
1724 }
1725
1726 /* sys.path_hooks import hook */
1727 if (p_loader != NULL) {
1728 PyObject *importer;
1729
1730 importer = get_path_importer(path_importer_cache,
1731 path_hooks, path);
1732 if (importer == NULL) {
1733 return -1;
1734 }
1735 /* Note: importer is a borrowed reference */
1736 if (importer != Py_None) {
1737 PyObject *loader;
1738 loader = PyObject_CallMethod(importer,
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001739 "find_module", "O", fullname);
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001740 if (loader == NULL)
1741 return -1; /* error */
1742 if (loader != Py_None) {
1743 /* a loader was found */
1744 *p_loader = loader;
1745 *p_fd = &importhookdescr;
1746 return 2;
1747 }
1748 Py_DECREF(loader);
1749 return 0;
1750 }
1751 }
1752 /* no hook was found, use builtin import */
1753
1754 if (len > 0 && buf[len-1] != SEP
1755#ifdef ALTSEP
1756 && buf[len-1] != ALTSEP
1757#endif
1758 )
1759 buf[len++] = SEP;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001760 strcpy(buf+len, namestr);
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001761 len += namelen;
1762
1763 /* Check for package import (buf holds a directory name,
1764 and there's an __init__ module in that directory */
1765#ifdef HAVE_STAT
1766 if (stat(buf, &statbuf) == 0 && /* it exists */
Victor Stinnerd0296212011-03-14 14:04:10 -04001767 S_ISDIR(statbuf.st_mode)) /* it's a directory */
1768 {
1769 if (case_ok(buf, len, namelen, namestr)) { /* case matches */
1770 if (find_init_module(buf)) { /* and has __init__.py */
1771 *p_fd = &fd_package;
1772 return 2;
1773 }
1774 else {
1775 int err;
1776 PyObject *unicode = PyUnicode_DecodeFSDefault(buf);
1777 if (unicode == NULL)
1778 return -1;
1779 err = PyErr_WarnFormat(PyExc_ImportWarning, 1,
1780 "Not importing directory '%U': missing __init__.py",
1781 unicode);
1782 Py_DECREF(unicode);
1783 if (err)
1784 return -1;
1785 }
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001786 }
1787 }
1788#endif
1789 return 1;
1790}
1791
1792/* Find a module in search_path_list. For each path, try
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001793 find_module_path() or try each _PyImport_Filetab suffix.
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001794
1795 If the module is found, return a file descriptor, write the path in
1796 *p_filename, write the pointer to the file object into *p_fp, and (if
1797 p_loader is not NULL) the loader into *p_loader.
1798
1799 Otherwise, raise an exception and return NULL. */
1800
Victor Stinner37580282011-03-20 01:34:43 +01001801static struct filedescr*
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001802find_module_path_list(PyObject *fullname, PyObject *name,
Victor Stinner37580282011-03-20 01:34:43 +01001803 PyObject *search_path_list, PyObject *path_hooks,
1804 PyObject *path_importer_cache,
1805 char *buf, size_t buflen,
1806 FILE **p_fp, PyObject **p_loader)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001807{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001808 Py_ssize_t i, npath;
1809 size_t len, namelen;
1810 struct filedescr *fdp = NULL;
1811 char *filemode;
1812 FILE *fp = NULL;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001813 char *namestr;
Victor Stinner53dc7352011-03-20 01:50:21 +01001814
Victor Stinner37580282011-03-20 01:34:43 +01001815 npath = PyList_Size(search_path_list);
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001816 namestr = _PyUnicode_AsString(name);
1817 namelen = strlen(namestr);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001818 for (i = 0; i < npath; i++) {
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001819 PyObject *path;
1820 int ok;
1821
1822 path = PyList_GetItem(search_path_list, i);
1823 if (path == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001824 return NULL;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001825
1826 ok = find_module_path(fullname, name, path,
1827 path_hooks, path_importer_cache,
1828 buf, buflen,
1829 p_loader, &fdp);
1830 if (ok < 0)
1831 return NULL;
1832 if (ok == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001833 continue;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001834 if (ok == 2)
1835 return fdp;
Amaury Forgeot d'Arcf1ca0b12008-06-11 17:40:47 +00001836
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001837 len = strlen(buf);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001838 for (fdp = _PyImport_Filetab; fdp->suffix != NULL; fdp++) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001839 strcpy(buf+len, fdp->suffix);
1840 if (Py_VerboseFlag > 1)
1841 PySys_WriteStderr("# trying %s\n", buf);
1842 filemode = fdp->mode;
1843 if (filemode[0] == 'U')
1844 filemode = "r" PY_STDIOTEXTMODE;
1845 fp = fopen(buf, filemode);
Victor Stinnerd0296212011-03-14 14:04:10 -04001846 if (fp == NULL)
1847 continue;
1848
1849 if (case_ok(buf, len, namelen, namestr)) {
1850 *p_fp = fp;
1851 return fdp;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001852 }
Victor Stinnerd0296212011-03-14 14:04:10 -04001853
1854 fclose(fp);
1855 fp = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001856 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001857 }
Victor Stinnerd0296212011-03-14 14:04:10 -04001858 PyErr_Format(PyExc_ImportError,
1859 "No module named %U", name);
1860 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001861}
1862
Victor Stinner37580282011-03-20 01:34:43 +01001863/* Find a module:
1864
1865 - try find_module() of each sys.meta_path hook
1866 - try find_frozen()
1867 - try is_builtin()
1868 - try _PyWin_FindRegisteredModule() (Windows only)
1869 - otherwise, call find_module_path_list() with search_path_list (if not
1870 NULL) or sys.path
1871
1872 Return:
1873
1874 - &fd_builtin (C_BUILTIN) if it is a builtin
1875 - &fd_frozen (PY_FROZEN) if it is frozen
1876 - &fd_package (PKG_DIRECTORY) and write the filename into *buf
1877 if it is a package
1878 - &importhookdescr (IMP_HOOK) and write the loader into *p_loader if a
1879 importer loader was found
1880 - a file descriptor (PY_SOURCE, PY_COMPILED, C_EXTENSION, PY_RESOURCE or
1881 PY_CODERESOURCE: see _PyImport_Filetab), write the filename into
1882 *buf and the pointer to the open file into *p_fp
1883 - NULL on error
1884
1885 By default, write an empty string into *buf, and *p_fp and *p_loader (if
1886 set) are set to NULL. Eg. *buf is an empty string for a builtin package. */
1887
1888static struct filedescr *
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001889find_module(PyObject *fullname, PyObject *name, PyObject *search_path_list,
Victor Stinner37580282011-03-20 01:34:43 +01001890 char *buf, size_t buflen, FILE **p_fp, PyObject **p_loader)
1891{
1892 Py_ssize_t i, npath;
1893 static struct filedescr fd_frozen = {"", "", PY_FROZEN};
1894 static struct filedescr fd_builtin = {"", "", C_BUILTIN};
1895 PyObject *path_hooks, *path_importer_cache;
Victor Stinner37580282011-03-20 01:34:43 +01001896
1897 *buf = '\0';
1898 *p_fp = NULL;
1899 if (p_loader != NULL)
1900 *p_loader = NULL;
1901
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001902 if (PyUnicode_GET_SIZE(name) > MAXPATHLEN) {
Victor Stinner37580282011-03-20 01:34:43 +01001903 PyErr_SetString(PyExc_OverflowError,
1904 "module name is too long");
1905 return NULL;
1906 }
1907
1908 /* sys.meta_path import hook */
1909 if (p_loader != NULL) {
1910 PyObject *meta_path;
1911
1912 meta_path = PySys_GetObject("meta_path");
1913 if (meta_path == NULL || !PyList_Check(meta_path)) {
1914 PyErr_SetString(PyExc_ImportError,
1915 "sys.meta_path must be a list of "
1916 "import hooks");
1917 return NULL;
1918 }
1919 Py_INCREF(meta_path); /* zap guard */
1920 npath = PyList_Size(meta_path);
1921 for (i = 0; i < npath; i++) {
1922 PyObject *loader;
1923 PyObject *hook = PyList_GetItem(meta_path, i);
1924 loader = PyObject_CallMethod(hook, "find_module",
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001925 "OO", fullname,
Victor Stinner37580282011-03-20 01:34:43 +01001926 search_path_list != NULL ?
1927 search_path_list : Py_None);
1928 if (loader == NULL) {
1929 Py_DECREF(meta_path);
1930 return NULL; /* true error */
1931 }
1932 if (loader != Py_None) {
1933 /* a loader was found */
1934 *p_loader = loader;
1935 Py_DECREF(meta_path);
1936 return &importhookdescr;
1937 }
1938 Py_DECREF(loader);
1939 }
1940 Py_DECREF(meta_path);
1941 }
1942
Victor Stinnerdf75a022011-03-14 13:40:04 -04001943 if (find_frozen(fullname) != NULL)
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001944 return &fd_frozen;
Victor Stinner37580282011-03-20 01:34:43 +01001945
1946 if (search_path_list == NULL) {
1947#ifdef MS_COREDLL
1948 FILE *fp;
1949 struct filedescr *fdp;
1950 PyObject *filename, *filename_bytes;
1951#endif
Victor Stinnerdf75a022011-03-14 13:40:04 -04001952 if (is_builtin(name))
Victor Stinner37580282011-03-20 01:34:43 +01001953 return &fd_builtin;
Victor Stinner37580282011-03-20 01:34:43 +01001954#ifdef MS_COREDLL
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001955 fp = _PyWin_FindRegisteredModule(name, &fdp, &filename);
Victor Stinner37580282011-03-20 01:34:43 +01001956 if (fp != NULL) {
Victor Stinner37580282011-03-20 01:34:43 +01001957 filename_bytes = PyUnicode_EncodeFSDefault(filename);
1958 Py_DECREF(filename);
1959 if (filename_bytes == NULL)
1960 return NULL;
1961 strncpy(buf, PyBytes_AS_STRING(filename_bytes), buflen);
1962 buf[buflen-1] = '\0';
1963 Py_DECREF(filename_bytes);
1964 *p_fp = fp;
1965 return fdp;
1966 }
1967 else if (PyErr_Occurred())
1968 return NULL;
1969#endif
Victor Stinner37580282011-03-20 01:34:43 +01001970 search_path_list = PySys_GetObject("path");
1971 }
1972
1973 if (search_path_list == NULL || !PyList_Check(search_path_list)) {
1974 PyErr_SetString(PyExc_ImportError,
1975 "sys.path must be a list of directory names");
1976 return NULL;
1977 }
1978
1979 path_hooks = PySys_GetObject("path_hooks");
1980 if (path_hooks == NULL || !PyList_Check(path_hooks)) {
1981 PyErr_SetString(PyExc_ImportError,
1982 "sys.path_hooks must be a list of "
1983 "import hooks");
1984 return NULL;
1985 }
1986 path_importer_cache = PySys_GetObject("path_importer_cache");
1987 if (path_importer_cache == NULL ||
1988 !PyDict_Check(path_importer_cache)) {
1989 PyErr_SetString(PyExc_ImportError,
1990 "sys.path_importer_cache must be a dict");
1991 return NULL;
1992 }
1993
1994 return find_module_path_list(fullname, name,
1995 search_path_list, path_hooks,
1996 path_importer_cache,
1997 buf, buflen,
1998 p_fp, p_loader);
1999}
2000
Martin v. Löwis18e16552006-02-15 17:27:45 +00002001/* case_ok(char* buf, Py_ssize_t len, Py_ssize_t namelen, char* name)
Tim Petersd1e87a82001-03-01 18:12:00 +00002002 * The arguments here are tricky, best shown by example:
2003 * /a/b/c/d/e/f/g/h/i/j/k/some_long_module_name.py\0
2004 * ^ ^ ^ ^
2005 * |--------------------- buf ---------------------|
2006 * |------------------- len ------------------|
2007 * |------ name -------|
2008 * |----- namelen -----|
2009 * buf is the full path, but len only counts up to (& exclusive of) the
2010 * extension. name is the module name, also exclusive of extension.
2011 *
2012 * We've already done a successful stat() or fopen() on buf, so know that
2013 * there's some match, possibly case-insensitive.
2014 *
Tim Peters50d8d372001-02-28 05:34:27 +00002015 * case_ok() is to return 1 if there's a case-sensitive match for
2016 * name, else 0. case_ok() is also to return 1 if envar PYTHONCASEOK
2017 * exists.
Tim Petersd1e87a82001-03-01 18:12:00 +00002018 *
Tim Peters50d8d372001-02-28 05:34:27 +00002019 * case_ok() is used to implement case-sensitive import semantics even
2020 * on platforms with case-insensitive filesystems. It's trivial to implement
2021 * for case-sensitive filesystems. It's pretty much a cross-platform
2022 * nightmare for systems with case-insensitive filesystems.
2023 */
Guido van Rossum0980bd91998-02-13 17:18:36 +00002024
Tim Peters50d8d372001-02-28 05:34:27 +00002025/* First we may need a pile of platform-specific header files; the sequence
2026 * of #if's here should match the sequence in the body of case_ok().
2027 */
Jason Tishler7961aa62005-05-20 00:56:54 +00002028#if defined(MS_WINDOWS)
Guido van Rossum0980bd91998-02-13 17:18:36 +00002029#include <windows.h>
Guido van Rossum4c3f57c2001-01-10 20:40:46 +00002030
Tim Peters50d8d372001-02-28 05:34:27 +00002031#elif defined(DJGPP)
2032#include <dir.h>
2033
Jason Tishler7961aa62005-05-20 00:56:54 +00002034#elif (defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) && defined(HAVE_DIRENT_H)
Tim Peters430f5d42001-03-01 01:30:56 +00002035#include <sys/types.h>
2036#include <dirent.h>
2037
Andrew MacIntyred9400542002-02-26 11:41:34 +00002038#elif defined(PYOS_OS2)
2039#define INCL_DOS
2040#define INCL_DOSERRORS
2041#define INCL_NOPMAPI
2042#include <os2.h>
Tim Peters50d8d372001-02-28 05:34:27 +00002043#endif
2044
Guido van Rossum0980bd91998-02-13 17:18:36 +00002045static int
Victor Stinnerc6963162011-03-12 09:26:54 -05002046case_ok(char *buf, Py_ssize_t len, Py_ssize_t namelen, const char *name)
Guido van Rossum0980bd91998-02-13 17:18:36 +00002047{
Tim Peters50d8d372001-02-28 05:34:27 +00002048/* Pick a platform-specific implementation; the sequence of #if's here should
2049 * match the sequence just above.
2050 */
2051
Jason Tishler7961aa62005-05-20 00:56:54 +00002052/* MS_WINDOWS */
2053#if defined(MS_WINDOWS)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002054 WIN32_FIND_DATA data;
2055 HANDLE h;
Tim Peters50d8d372001-02-28 05:34:27 +00002056
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002057 if (Py_GETENV("PYTHONCASEOK") != NULL)
2058 return 1;
Tim Peters50d8d372001-02-28 05:34:27 +00002059
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002060 h = FindFirstFile(buf, &data);
2061 if (h == INVALID_HANDLE_VALUE) {
2062 PyErr_Format(PyExc_NameError,
2063 "Can't find file for module %.100s\n(filename %.300s)",
2064 name, buf);
2065 return 0;
2066 }
2067 FindClose(h);
2068 return strncmp(data.cFileName, name, namelen) == 0;
Tim Peters50d8d372001-02-28 05:34:27 +00002069
2070/* DJGPP */
2071#elif defined(DJGPP)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002072 struct ffblk ffblk;
2073 int done;
Tim Peters50d8d372001-02-28 05:34:27 +00002074
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002075 if (Py_GETENV("PYTHONCASEOK") != NULL)
2076 return 1;
Tim Peters50d8d372001-02-28 05:34:27 +00002077
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002078 done = findfirst(buf, &ffblk, FA_ARCH|FA_RDONLY|FA_HIDDEN|FA_DIREC);
2079 if (done) {
2080 PyErr_Format(PyExc_NameError,
2081 "Can't find file for module %.100s\n(filename %.300s)",
2082 name, buf);
2083 return 0;
2084 }
2085 return strncmp(ffblk.ff_name, name, namelen) == 0;
Guido van Rossum0980bd91998-02-13 17:18:36 +00002086
Jason Tishler7961aa62005-05-20 00:56:54 +00002087/* new-fangled macintosh (macosx) or Cygwin */
2088#elif (defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) && defined(HAVE_DIRENT_H)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002089 DIR *dirp;
2090 struct dirent *dp;
2091 char dirname[MAXPATHLEN + 1];
2092 const int dirlen = len - namelen - 1; /* don't want trailing SEP */
Tim Peters430f5d42001-03-01 01:30:56 +00002093
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002094 if (Py_GETENV("PYTHONCASEOK") != NULL)
2095 return 1;
Tim Petersdbe6ebb2001-03-01 08:47:29 +00002096
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002097 /* Copy the dir component into dirname; substitute "." if empty */
2098 if (dirlen <= 0) {
2099 dirname[0] = '.';
2100 dirname[1] = '\0';
2101 }
2102 else {
2103 assert(dirlen <= MAXPATHLEN);
2104 memcpy(dirname, buf, dirlen);
2105 dirname[dirlen] = '\0';
2106 }
2107 /* Open the directory and search the entries for an exact match. */
2108 dirp = opendir(dirname);
2109 if (dirp) {
2110 char *nameWithExt = buf + len - namelen;
2111 while ((dp = readdir(dirp)) != NULL) {
2112 const int thislen =
Tim Peters430f5d42001-03-01 01:30:56 +00002113#ifdef _DIRENT_HAVE_D_NAMELEN
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002114 dp->d_namlen;
Tim Peters430f5d42001-03-01 01:30:56 +00002115#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002116 strlen(dp->d_name);
Tim Peters430f5d42001-03-01 01:30:56 +00002117#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002118 if (thislen >= namelen &&
2119 strcmp(dp->d_name, nameWithExt) == 0) {
2120 (void)closedir(dirp);
2121 return 1; /* Found */
2122 }
2123 }
2124 (void)closedir(dirp);
2125 }
2126 return 0 ; /* Not found */
Tim Peters430f5d42001-03-01 01:30:56 +00002127
Andrew MacIntyred9400542002-02-26 11:41:34 +00002128/* OS/2 */
2129#elif defined(PYOS_OS2)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002130 HDIR hdir = 1;
2131 ULONG srchcnt = 1;
2132 FILEFINDBUF3 ffbuf;
2133 APIRET rc;
Andrew MacIntyred9400542002-02-26 11:41:34 +00002134
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002135 if (Py_GETENV("PYTHONCASEOK") != NULL)
2136 return 1;
Andrew MacIntyred9400542002-02-26 11:41:34 +00002137
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002138 rc = DosFindFirst(buf,
2139 &hdir,
2140 FILE_READONLY | FILE_HIDDEN | FILE_SYSTEM | FILE_DIRECTORY,
2141 &ffbuf, sizeof(ffbuf),
2142 &srchcnt,
2143 FIL_STANDARD);
2144 if (rc != NO_ERROR)
2145 return 0;
2146 return strncmp(ffbuf.achName, name, namelen) == 0;
Andrew MacIntyred9400542002-02-26 11:41:34 +00002147
Tim Peters50d8d372001-02-28 05:34:27 +00002148/* assuming it's a case-sensitive filesystem, so there's nothing to do! */
2149#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002150 return 1;
Guido van Rossum0980bd91998-02-13 17:18:36 +00002151
Guido van Rossum4d1b3b91998-02-13 23:27:59 +00002152#endif
Tim Peters50d8d372001-02-28 05:34:27 +00002153}
Guido van Rossum4d1b3b91998-02-13 23:27:59 +00002154
Guido van Rossum197346f1997-10-31 18:38:52 +00002155#ifdef HAVE_STAT
Victor Stinner4f4402c2010-08-14 14:50:26 +00002156
Guido van Rossum197346f1997-10-31 18:38:52 +00002157/* Helper to look for __init__.py or __init__.py[co] in potential package */
2158static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002159find_init_module(char *buf)
Guido van Rossum197346f1997-10-31 18:38:52 +00002160{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002161 const size_t save_len = strlen(buf);
2162 size_t i = save_len;
2163 char *pname; /* pointer to start of __init__ */
2164 struct stat statbuf;
Guido van Rossum197346f1997-10-31 18:38:52 +00002165
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002166/* For calling case_ok(buf, len, namelen, name):
2167 * /a/b/c/d/e/f/g/h/i/j/k/some_long_module_name.py\0
2168 * ^ ^ ^ ^
2169 * |--------------------- buf ---------------------|
2170 * |------------------- len ------------------|
2171 * |------ name -------|
2172 * |----- namelen -----|
Tim Peters0f9431f2001-07-05 03:47:53 +00002173 */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002174 if (save_len + 13 >= MAXPATHLEN)
2175 return 0;
2176 buf[i++] = SEP;
2177 pname = buf + i;
2178 strcpy(pname, "__init__.py");
2179 if (stat(buf, &statbuf) == 0) {
2180 if (case_ok(buf,
2181 save_len + 9, /* len("/__init__") */
2182 8, /* len("__init__") */
2183 pname)) {
2184 buf[save_len] = '\0';
2185 return 1;
2186 }
2187 }
2188 i += strlen(pname);
2189 strcpy(buf+i, Py_OptimizeFlag ? "o" : "c");
2190 if (stat(buf, &statbuf) == 0) {
2191 if (case_ok(buf,
2192 save_len + 9, /* len("/__init__") */
2193 8, /* len("__init__") */
2194 pname)) {
2195 buf[save_len] = '\0';
2196 return 1;
2197 }
2198 }
2199 buf[save_len] = '\0';
2200 return 0;
Guido van Rossum197346f1997-10-31 18:38:52 +00002201}
Guido van Rossum48a680c2001-03-02 06:34:14 +00002202
Guido van Rossum197346f1997-10-31 18:38:52 +00002203#endif /* HAVE_STAT */
2204
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002205
Victor Stinner95872862011-03-07 18:20:56 +01002206static int init_builtin(PyObject *); /* Forward */
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002207
Victor Stinner44c6c152010-08-09 00:59:10 +00002208static PyObject*
Victor Stinner95872862011-03-07 18:20:56 +01002209load_builtin(PyObject *name, int type)
Victor Stinner44c6c152010-08-09 00:59:10 +00002210{
2211 PyObject *m, *modules;
2212 int err;
2213
Victor Stinner44c6c152010-08-09 00:59:10 +00002214 if (type == C_BUILTIN)
2215 err = init_builtin(name);
2216 else
Victor Stinner95872862011-03-07 18:20:56 +01002217 err = PyImport_ImportFrozenModuleObject(name);
Victor Stinner44c6c152010-08-09 00:59:10 +00002218 if (err < 0)
2219 return NULL;
2220 if (err == 0) {
2221 PyErr_Format(PyExc_ImportError,
Victor Stinner95872862011-03-07 18:20:56 +01002222 "Purported %s module %R not found",
2223 type == C_BUILTIN ? "builtin" : "frozen",
Victor Stinner44c6c152010-08-09 00:59:10 +00002224 name);
2225 return NULL;
2226 }
2227
2228 modules = PyImport_GetModuleDict();
Victor Stinner95872862011-03-07 18:20:56 +01002229 m = PyDict_GetItem(modules, name);
Victor Stinner44c6c152010-08-09 00:59:10 +00002230 if (m == NULL) {
2231 PyErr_Format(
2232 PyExc_ImportError,
Victor Stinner95872862011-03-07 18:20:56 +01002233 "%s module %R not properly initialized",
2234 type == C_BUILTIN ? "builtin" : "frozen",
Victor Stinner44c6c152010-08-09 00:59:10 +00002235 name);
2236 return NULL;
2237 }
2238 Py_INCREF(m);
2239 return m;
2240}
2241
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002242/* Load an external module using the default search path and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00002243 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002244
Guido van Rossum79f25d91997-04-29 20:08:16 +00002245static PyObject *
Victor Stinner41c5fec2011-03-13 21:46:30 -04002246load_module(PyObject *name, FILE *fp, PyObject *pathname, int type, PyObject *loader)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002247{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002248 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002249
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002250 /* First check that there's an open file (if we need one) */
2251 switch (type) {
2252 case PY_SOURCE:
2253 case PY_COMPILED:
2254 if (fp == NULL) {
2255 PyErr_Format(PyExc_ValueError,
Victor Stinner41c5fec2011-03-13 21:46:30 -04002256 "file object required for import (type code %d)",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002257 type);
2258 return NULL;
2259 }
2260 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002261
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002262 switch (type) {
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002263
Victor Stinner41c5fec2011-03-13 21:46:30 -04002264 case PY_SOURCE:
2265 m = load_source_module(name, pathname, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002266 break;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002267
Victor Stinner41c5fec2011-03-13 21:46:30 -04002268 case PY_COMPILED:
2269 m = load_compiled_module(name, pathname, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002270 break;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002271
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002272#ifdef HAVE_DYNAMIC_LOADING
Victor Stinner41c5fec2011-03-13 21:46:30 -04002273 case C_EXTENSION:
2274 m = _PyImport_LoadDynamicModule(name, pathname, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002275 break;
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002276#endif
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002277
Victor Stinner41c5fec2011-03-13 21:46:30 -04002278 case PKG_DIRECTORY:
2279 m = load_package(name, pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002280 break;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002281
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002282 case C_BUILTIN:
Victor Stinner41c5fec2011-03-13 21:46:30 -04002283 case PY_FROZEN:
2284 m = load_builtin(name, type);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002285 break;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002286
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002287 case IMP_HOOK: {
2288 if (loader == NULL) {
2289 PyErr_SetString(PyExc_ImportError,
2290 "import hook without loader");
2291 return NULL;
2292 }
Victor Stinner41c5fec2011-03-13 21:46:30 -04002293 m = PyObject_CallMethod(loader, "load_module", "O", name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002294 break;
2295 }
Just van Rossum52e14d62002-12-30 22:08:05 +00002296
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002297 default:
2298 PyErr_Format(PyExc_ImportError,
Victor Stinner41c5fec2011-03-13 21:46:30 -04002299 "Don't know how to import %U (type code %d)",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002300 name, type);
2301 m = NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002302
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002303 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002304
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002305 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002306}
2307
2308
2309/* Initialize a built-in module.
Thomas Wouters89f507f2006-12-13 04:49:30 +00002310 Return 1 for success, 0 if the module is not found, and -1 with
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002311 an exception set if the initialization failed. */
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002312
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002313static int
Victor Stinner95872862011-03-07 18:20:56 +01002314init_builtin(PyObject *name)
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002315{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002316 struct _inittab *p;
Guido van Rossum25ce5661997-08-02 03:10:38 +00002317
Victor Stinner95872862011-03-07 18:20:56 +01002318 if (_PyImport_FindExtensionObject(name, name) != NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002319 return 1;
Guido van Rossum25ce5661997-08-02 03:10:38 +00002320
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002321 for (p = PyImport_Inittab; p->name != NULL; p++) {
2322 PyObject *mod;
Victor Stinner95872862011-03-07 18:20:56 +01002323 if (PyUnicode_CompareWithASCIIString(name, p->name) == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002324 if (p->initfunc == NULL) {
2325 PyErr_Format(PyExc_ImportError,
Victor Stinner95872862011-03-07 18:20:56 +01002326 "Cannot re-init internal module %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002327 name);
2328 return -1;
2329 }
2330 if (Py_VerboseFlag)
Victor Stinner95872862011-03-07 18:20:56 +01002331 PySys_FormatStderr("import %U # builtin\n", name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002332 mod = (*p->initfunc)();
2333 if (mod == 0)
2334 return -1;
Victor Stinner95872862011-03-07 18:20:56 +01002335 if (_PyImport_FixupExtensionObject(mod, name, name) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002336 return -1;
2337 /* FixupExtension has put the module into sys.modules,
2338 so we can release our own reference. */
2339 Py_DECREF(mod);
2340 return 1;
2341 }
2342 }
2343 return 0;
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002344}
Guido van Rossumf56e3db1993-04-01 20:59:32 +00002345
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002346
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002347/* Frozen modules */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002348
Guido van Rossumcfd0a221996-06-17 17:06:34 +00002349static struct _frozen *
Victor Stinner53dc7352011-03-20 01:50:21 +01002350find_frozen(PyObject *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002351{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002352 struct _frozen *p;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002353
Victor Stinner53dc7352011-03-20 01:50:21 +01002354 if (name == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002355 return NULL;
Benjamin Petersond968e272008-11-05 22:48:33 +00002356
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002357 for (p = PyImport_FrozenModules; ; p++) {
2358 if (p->name == NULL)
2359 return NULL;
Victor Stinner53dc7352011-03-20 01:50:21 +01002360 if (PyUnicode_CompareWithASCIIString(name, p->name) == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002361 break;
2362 }
2363 return p;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002364}
2365
Guido van Rossum79f25d91997-04-29 20:08:16 +00002366static PyObject *
Victor Stinner53dc7352011-03-20 01:50:21 +01002367get_frozen_object(PyObject *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002368{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002369 struct _frozen *p = find_frozen(name);
2370 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002371
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002372 if (p == NULL) {
2373 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002374 "No such frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002375 name);
2376 return NULL;
2377 }
2378 if (p->code == NULL) {
2379 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002380 "Excluded frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002381 name);
2382 return NULL;
2383 }
2384 size = p->size;
2385 if (size < 0)
2386 size = -size;
2387 return PyMarshal_ReadObjectFromString((char *)p->code, size);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002388}
2389
Brett Cannon8d110132009-03-15 02:20:16 +00002390static PyObject *
Victor Stinner53dc7352011-03-20 01:50:21 +01002391is_frozen_package(PyObject *name)
Brett Cannon8d110132009-03-15 02:20:16 +00002392{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002393 struct _frozen *p = find_frozen(name);
2394 int size;
Brett Cannon8d110132009-03-15 02:20:16 +00002395
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002396 if (p == NULL) {
2397 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002398 "No such frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002399 name);
2400 return NULL;
2401 }
Brett Cannon8d110132009-03-15 02:20:16 +00002402
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002403 size = p->size;
Brett Cannon8d110132009-03-15 02:20:16 +00002404
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002405 if (size < 0)
2406 Py_RETURN_TRUE;
2407 else
2408 Py_RETURN_FALSE;
Brett Cannon8d110132009-03-15 02:20:16 +00002409}
2410
2411
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002412/* Initialize a frozen module.
Brett Cannon3c2ac442009-03-08 20:49:47 +00002413 Return 1 for success, 0 if the module is not found, and -1 with
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002414 an exception set if the initialization failed.
2415 This function is also used from frozenmain.c */
Guido van Rossum0b344901995-02-07 15:35:27 +00002416
2417int
Victor Stinner53dc7352011-03-20 01:50:21 +01002418PyImport_ImportFrozenModuleObject(PyObject *name)
Guido van Rossumf56e3db1993-04-01 20:59:32 +00002419{
Victor Stinner53dc7352011-03-20 01:50:21 +01002420 struct _frozen *p;
2421 PyObject *co, *m, *path;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002422 int ispackage;
2423 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002424
Victor Stinner53dc7352011-03-20 01:50:21 +01002425 p = find_frozen(name);
2426
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002427 if (p == NULL)
2428 return 0;
2429 if (p->code == NULL) {
2430 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002431 "Excluded frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002432 name);
2433 return -1;
2434 }
2435 size = p->size;
2436 ispackage = (size < 0);
2437 if (ispackage)
2438 size = -size;
2439 if (Py_VerboseFlag)
Victor Stinner53dc7352011-03-20 01:50:21 +01002440 PySys_FormatStderr("import %U # frozen%s\n",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002441 name, ispackage ? " package" : "");
2442 co = PyMarshal_ReadObjectFromString((char *)p->code, size);
2443 if (co == NULL)
2444 return -1;
2445 if (!PyCode_Check(co)) {
2446 PyErr_Format(PyExc_TypeError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002447 "frozen object %R is not a code object",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002448 name);
2449 goto err_return;
2450 }
2451 if (ispackage) {
2452 /* Set __path__ to the package name */
Victor Stinner53dc7352011-03-20 01:50:21 +01002453 PyObject *d, *l;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002454 int err;
Victor Stinner53dc7352011-03-20 01:50:21 +01002455 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002456 if (m == NULL)
2457 goto err_return;
2458 d = PyModule_GetDict(m);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002459 l = PyList_New(1);
2460 if (l == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002461 goto err_return;
2462 }
Victor Stinner53dc7352011-03-20 01:50:21 +01002463 Py_INCREF(name);
2464 PyList_SET_ITEM(l, 0, name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002465 err = PyDict_SetItemString(d, "__path__", l);
2466 Py_DECREF(l);
2467 if (err != 0)
2468 goto err_return;
2469 }
Victor Stinner53dc7352011-03-20 01:50:21 +01002470 path = PyUnicode_FromString("<frozen>");
2471 if (path == NULL)
2472 goto err_return;
2473 m = PyImport_ExecCodeModuleObject(name, co, path, NULL);
2474 Py_DECREF(path);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002475 if (m == NULL)
2476 goto err_return;
2477 Py_DECREF(co);
2478 Py_DECREF(m);
2479 return 1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002480err_return:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002481 Py_DECREF(co);
2482 return -1;
Guido van Rossumf56e3db1993-04-01 20:59:32 +00002483}
Guido van Rossum74e6a111994-08-29 12:54:38 +00002484
Victor Stinner53dc7352011-03-20 01:50:21 +01002485int
2486PyImport_ImportFrozenModule(char *name)
2487{
2488 PyObject *nameobj;
2489 int ret;
2490 nameobj = PyUnicode_InternFromString(name);
2491 if (nameobj == NULL)
2492 return -1;
2493 ret = PyImport_ImportFrozenModuleObject(nameobj);
2494 Py_DECREF(nameobj);
2495 return ret;
2496}
2497
Guido van Rossum74e6a111994-08-29 12:54:38 +00002498
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002499/* Import a module, either built-in, frozen, or external, and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00002500 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum74e6a111994-08-29 12:54:38 +00002501
Guido van Rossum79f25d91997-04-29 20:08:16 +00002502PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00002503PyImport_ImportModule(const char *name)
Guido van Rossum74e6a111994-08-29 12:54:38 +00002504{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002505 PyObject *pname;
2506 PyObject *result;
Marc-André Lemburg3c61c352001-02-09 19:40:15 +00002507
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002508 pname = PyUnicode_FromString(name);
2509 if (pname == NULL)
2510 return NULL;
2511 result = PyImport_Import(pname);
2512 Py_DECREF(pname);
2513 return result;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002514}
2515
Christian Heimes072c0f12008-01-03 23:01:04 +00002516/* Import a module without blocking
2517 *
2518 * At first it tries to fetch the module from sys.modules. If the module was
2519 * never loaded before it loads it with PyImport_ImportModule() unless another
2520 * thread holds the import lock. In the latter case the function raises an
2521 * ImportError instead of blocking.
2522 *
2523 * Returns the module object with incremented ref count.
2524 */
2525PyObject *
2526PyImport_ImportModuleNoBlock(const char *name)
2527{
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002528 PyObject *nameobj, *modules, *result;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002529 long me;
Christian Heimes072c0f12008-01-03 23:01:04 +00002530
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002531 /* Try to get the module from sys.modules[name] */
2532 modules = PyImport_GetModuleDict();
2533 if (modules == NULL)
2534 return NULL;
Christian Heimes072c0f12008-01-03 23:01:04 +00002535
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002536 nameobj = PyUnicode_FromString(name);
2537 if (nameobj == NULL)
2538 return NULL;
2539 result = PyDict_GetItem(modules, nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002540 if (result != NULL) {
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002541 Py_DECREF(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002542 Py_INCREF(result);
2543 return result;
2544 }
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002545 PyErr_Clear();
Benjamin Peterson3e4f0552008-09-02 00:31:15 +00002546#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002547 /* check the import lock
2548 * me might be -1 but I ignore the error here, the lock function
2549 * takes care of the problem */
2550 me = PyThread_get_thread_ident();
2551 if (import_lock_thread == -1 || import_lock_thread == me) {
2552 /* no thread or me is holding the lock */
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002553 result = PyImport_Import(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002554 }
2555 else {
2556 PyErr_Format(PyExc_ImportError,
Victor Stinnerc24c8102011-03-13 22:38:06 -04002557 "Failed to import %R because the import lock"
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002558 "is held by another thread.",
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002559 nameobj);
2560 result = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002561 }
Benjamin Peterson3e4f0552008-09-02 00:31:15 +00002562#else
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002563 result = PyImport_Import(nameobj);
Benjamin Peterson3e4f0552008-09-02 00:31:15 +00002564#endif
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002565 Py_DECREF(nameobj);
2566 return result;
Christian Heimes072c0f12008-01-03 23:01:04 +00002567}
2568
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002569/* Forward declarations for helper routines */
Victor Stinner974389d2011-03-15 09:33:57 +01002570static PyObject *get_parent(PyObject *globals,
2571 PyObject **p_name,
2572 int level);
Tim Petersdbd9ba62000-07-09 03:09:57 +00002573static PyObject *load_next(PyObject *mod, PyObject *altmod,
Victor Stinner974389d2011-03-15 09:33:57 +01002574 PyObject *inputname, PyObject **p_outputname,
2575 Py_UNICODE *buf, Py_ssize_t *p_buflen,
2576 Py_ssize_t bufsize);
2577static int mark_miss(PyObject *name);
Tim Petersdbd9ba62000-07-09 03:09:57 +00002578static int ensure_fromlist(PyObject *mod, PyObject *fromlist,
Victor Stinner974389d2011-03-15 09:33:57 +01002579 PyObject *buf, int recursive);
2580static PyObject * import_submodule(PyObject *mod, PyObject *name,
2581 PyObject *fullname);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002582
2583/* The Magnum Opus of dotted-name import :-) */
2584
Guido van Rossum75acc9c1998-03-03 22:26:50 +00002585static PyObject *
Victor Stinner974389d2011-03-15 09:33:57 +01002586import_module_level(PyObject *name, PyObject *globals, PyObject *locals,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002587 PyObject *fromlist, int level)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002588{
Victor Stinner974389d2011-03-15 09:33:57 +01002589 Py_UNICODE buf[MAXPATHLEN+1];
2590 Py_ssize_t buflen;
2591 Py_ssize_t bufsize = MAXPATHLEN+1;
2592 PyObject *parent, *head, *next, *tail, *inputname, *outputname;
2593 PyObject *parent_name, *ensure_name;
2594 const Py_UNICODE *nameunicode;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002595
Victor Stinner974389d2011-03-15 09:33:57 +01002596 nameunicode = PyUnicode_AS_UNICODE(name);
2597
2598 if (Py_UNICODE_strchr(nameunicode, SEP) != NULL
2599#ifdef ALTSEP
2600 || Py_UNICODE_strchr(nameunicode, ALTSEP) != NULL
Christian Heimes454f37b2008-01-10 00:10:02 +00002601#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002602 ) {
2603 PyErr_SetString(PyExc_ImportError,
2604 "Import by filename is not supported.");
2605 return NULL;
2606 }
Christian Heimes454f37b2008-01-10 00:10:02 +00002607
Victor Stinner974389d2011-03-15 09:33:57 +01002608 parent = get_parent(globals, &parent_name, level);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002609 if (parent == NULL)
2610 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002611
Victor Stinner974389d2011-03-15 09:33:57 +01002612 buflen = PyUnicode_GET_SIZE(parent_name);
2613 if (buflen+1 > bufsize) {
2614 Py_DECREF(parent_name);
2615 PyErr_SetString(PyExc_ValueError,
2616 "Module name too long");
2617 return NULL;
2618 }
2619 Py_UNICODE_strcpy(buf, PyUnicode_AS_UNICODE(parent_name));
2620 Py_DECREF(parent_name);
2621
2622 head = load_next(parent, level < 0 ? Py_None : parent, name, &outputname,
2623 buf, &buflen, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002624 if (head == NULL)
2625 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002626
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002627 tail = head;
2628 Py_INCREF(tail);
Victor Stinner974389d2011-03-15 09:33:57 +01002629
2630 if (outputname != NULL) {
2631 while (1) {
2632 inputname = outputname;
2633 next = load_next(tail, tail, inputname, &outputname,
2634 buf, &buflen, bufsize);
2635 Py_DECREF(tail);
2636 Py_DECREF(inputname);
2637 if (next == NULL) {
2638 Py_DECREF(head);
2639 return NULL;
2640 }
2641 tail = next;
2642
2643 if (outputname == NULL) {
2644 break;
2645 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002646 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002647 }
2648 if (tail == Py_None) {
2649 /* If tail is Py_None, both get_parent and load_next found
2650 an empty module name: someone called __import__("") or
2651 doctored faulty bytecode */
2652 Py_DECREF(tail);
2653 Py_DECREF(head);
Victor Stinner974389d2011-03-15 09:33:57 +01002654 PyErr_SetString(PyExc_ValueError, "Empty module name");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002655 return NULL;
2656 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002657
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002658 if (fromlist != NULL) {
2659 if (fromlist == Py_None || !PyObject_IsTrue(fromlist))
2660 fromlist = NULL;
2661 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002662
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002663 if (fromlist == NULL) {
2664 Py_DECREF(tail);
2665 return head;
2666 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002667
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002668 Py_DECREF(head);
Victor Stinner974389d2011-03-15 09:33:57 +01002669
2670 ensure_name = PyUnicode_FromUnicode(buf, Py_UNICODE_strlen(buf));
2671 if (ensure_name == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002672 Py_DECREF(tail);
2673 return NULL;
2674 }
Victor Stinner974389d2011-03-15 09:33:57 +01002675 if (!ensure_fromlist(tail, fromlist, ensure_name, 0)) {
2676 Py_DECREF(tail);
2677 Py_DECREF(ensure_name);
2678 return NULL;
2679 }
2680 Py_DECREF(ensure_name);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002681
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002682 return tail;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002683}
2684
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002685PyObject *
2686PyImport_ImportModuleLevel(char *name, PyObject *globals, PyObject *locals,
Victor Stinner974389d2011-03-15 09:33:57 +01002687 PyObject *fromlist, int level)
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002688{
Victor Stinner974389d2011-03-15 09:33:57 +01002689 PyObject *nameobj, *result;
2690 nameobj = PyUnicode_FromString(name);
2691 if (nameobj == NULL)
2692 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002693 _PyImport_AcquireLock();
Victor Stinner974389d2011-03-15 09:33:57 +01002694 result = import_module_level(nameobj, globals, locals, fromlist, level);
2695 Py_DECREF(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002696 if (_PyImport_ReleaseLock() < 0) {
2697 Py_XDECREF(result);
2698 PyErr_SetString(PyExc_RuntimeError,
2699 "not holding the import lock");
2700 return NULL;
2701 }
2702 return result;
Guido van Rossum75acc9c1998-03-03 22:26:50 +00002703}
2704
Fred Drake87590902004-05-28 20:21:36 +00002705/* Return the package that an import is being performed in. If globals comes
2706 from the module foo.bar.bat (not itself a package), this returns the
2707 sys.modules entry for foo.bar. If globals is from a package's __init__.py,
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00002708 the package's entry in sys.modules is returned, as a borrowed reference.
Fred Drake87590902004-05-28 20:21:36 +00002709
Victor Stinner974389d2011-03-15 09:33:57 +01002710 The name of the returned package is returned in *p_name.
Fred Drake87590902004-05-28 20:21:36 +00002711
2712 If globals doesn't come from a package or a module in a package, or a
2713 corresponding entry is not found in sys.modules, Py_None is returned.
2714*/
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002715static PyObject *
Victor Stinner9599de52011-03-13 22:38:38 -04002716get_parent(PyObject *globals, PyObject **p_name, int level)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002717{
Victor Stinner974389d2011-03-15 09:33:57 +01002718 Py_UNICODE name[MAXPATHLEN+1];
2719 const Py_ssize_t bufsize = MAXPATHLEN+1;
2720 PyObject *nameobj;
2721
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002722 static PyObject *namestr = NULL;
2723 static PyObject *pathstr = NULL;
2724 static PyObject *pkgstr = NULL;
2725 PyObject *pkgname, *modname, *modpath, *modules, *parent;
2726 int orig_level = level;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002727
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002728 if (globals == NULL || !PyDict_Check(globals) || !level)
Victor Stinner974389d2011-03-15 09:33:57 +01002729 goto return_none;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002730
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002731 if (namestr == NULL) {
2732 namestr = PyUnicode_InternFromString("__name__");
2733 if (namestr == NULL)
2734 return NULL;
2735 }
2736 if (pathstr == NULL) {
2737 pathstr = PyUnicode_InternFromString("__path__");
2738 if (pathstr == NULL)
2739 return NULL;
2740 }
2741 if (pkgstr == NULL) {
2742 pkgstr = PyUnicode_InternFromString("__package__");
2743 if (pkgstr == NULL)
2744 return NULL;
2745 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002746
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002747 pkgname = PyDict_GetItem(globals, pkgstr);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002748
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002749 if ((pkgname != NULL) && (pkgname != Py_None)) {
2750 /* __package__ is set, so use it */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002751 if (!PyUnicode_Check(pkgname)) {
2752 PyErr_SetString(PyExc_ValueError,
2753 "__package__ set to non-string");
2754 return NULL;
2755 }
Victor Stinner974389d2011-03-15 09:33:57 +01002756 if (PyUnicode_GET_SIZE(pkgname) == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002757 if (level > 0) {
2758 PyErr_SetString(PyExc_ValueError,
2759 "Attempted relative import in non-package");
2760 return NULL;
2761 }
Victor Stinner974389d2011-03-15 09:33:57 +01002762 goto return_none;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002763 }
Victor Stinner974389d2011-03-15 09:33:57 +01002764 if (PyUnicode_GET_SIZE(pkgname)+1 > bufsize) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002765 PyErr_SetString(PyExc_ValueError,
2766 "Package name too long");
2767 return NULL;
2768 }
Victor Stinner974389d2011-03-15 09:33:57 +01002769 Py_UNICODE_strcpy(name, PyUnicode_AS_UNICODE(pkgname));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002770 } else {
2771 /* __package__ not set, so figure it out and set it */
2772 modname = PyDict_GetItem(globals, namestr);
2773 if (modname == NULL || !PyUnicode_Check(modname))
Victor Stinner974389d2011-03-15 09:33:57 +01002774 goto return_none;
Brett Cannon9a5b25a2010-03-01 02:09:17 +00002775
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002776 modpath = PyDict_GetItem(globals, pathstr);
2777 if (modpath != NULL) {
2778 /* __path__ is set, so modname is already the package name */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002779 int error;
Alexandre Vassalottia85998a2008-05-03 18:24:43 +00002780
Victor Stinner974389d2011-03-15 09:33:57 +01002781 if (PyUnicode_GET_SIZE(modname)+1 > bufsize) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002782 PyErr_SetString(PyExc_ValueError,
2783 "Module name too long");
2784 return NULL;
2785 }
Victor Stinner974389d2011-03-15 09:33:57 +01002786 Py_UNICODE_strcpy(name, PyUnicode_AS_UNICODE(modname));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002787 error = PyDict_SetItem(globals, pkgstr, modname);
2788 if (error) {
2789 PyErr_SetString(PyExc_ValueError,
2790 "Could not set __package__");
2791 return NULL;
2792 }
2793 } else {
2794 /* Normal module, so work out the package name if any */
Victor Stinner974389d2011-03-15 09:33:57 +01002795 Py_UNICODE *start = PyUnicode_AS_UNICODE(modname);
2796 Py_UNICODE *lastdot = Py_UNICODE_strrchr(start, '.');
2797 Py_ssize_t len;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002798 int error;
2799 if (lastdot == NULL && level > 0) {
2800 PyErr_SetString(PyExc_ValueError,
2801 "Attempted relative import in non-package");
2802 return NULL;
2803 }
2804 if (lastdot == NULL) {
2805 error = PyDict_SetItem(globals, pkgstr, Py_None);
2806 if (error) {
2807 PyErr_SetString(PyExc_ValueError,
2808 "Could not set __package__");
2809 return NULL;
2810 }
Victor Stinner974389d2011-03-15 09:33:57 +01002811 goto return_none;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002812 }
2813 len = lastdot - start;
Victor Stinner974389d2011-03-15 09:33:57 +01002814 if (len+1 > bufsize) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002815 PyErr_SetString(PyExc_ValueError,
2816 "Module name too long");
2817 return NULL;
2818 }
Victor Stinner974389d2011-03-15 09:33:57 +01002819 Py_UNICODE_strncpy(name, start, len);
2820 name[len] = '\0';
2821 pkgname = PyUnicode_FromUnicode(name, len);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002822 if (pkgname == NULL) {
2823 return NULL;
2824 }
2825 error = PyDict_SetItem(globals, pkgstr, pkgname);
2826 Py_DECREF(pkgname);
2827 if (error) {
2828 PyErr_SetString(PyExc_ValueError,
2829 "Could not set __package__");
2830 return NULL;
2831 }
2832 }
2833 }
2834 while (--level > 0) {
Victor Stinner974389d2011-03-15 09:33:57 +01002835 Py_UNICODE *dot = Py_UNICODE_strrchr(name, '.');
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002836 if (dot == NULL) {
2837 PyErr_SetString(PyExc_ValueError,
2838 "Attempted relative import beyond "
2839 "toplevel package");
2840 return NULL;
2841 }
2842 *dot = '\0';
2843 }
Victor Stinner974389d2011-03-15 09:33:57 +01002844
2845 nameobj = PyUnicode_FromUnicode(name, Py_UNICODE_strlen(name));
2846 if (nameobj == NULL)
2847 return NULL;
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002848
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002849 modules = PyImport_GetModuleDict();
Victor Stinner974389d2011-03-15 09:33:57 +01002850 parent = PyDict_GetItem(modules, nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002851 if (parent == NULL) {
Victor Stinner974389d2011-03-15 09:33:57 +01002852 int err;
2853
2854 if (orig_level >= 1) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002855 PyErr_Format(PyExc_SystemError,
Victor Stinner974389d2011-03-15 09:33:57 +01002856 "Parent module %R not loaded, "
2857 "cannot perform relative import", nameobj);
2858 Py_DECREF(nameobj);
2859 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002860 }
Victor Stinner974389d2011-03-15 09:33:57 +01002861
2862 err = PyErr_WarnFormat(
2863 PyExc_RuntimeWarning, 1,
2864 "Parent module %R not found while handling absolute import",
2865 nameobj);
2866 Py_DECREF(nameobj);
2867 if (err)
2868 return NULL;
2869
2870 goto return_none;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002871 }
Victor Stinner974389d2011-03-15 09:33:57 +01002872 *p_name = nameobj;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002873 return parent;
2874 /* We expect, but can't guarantee, if parent != None, that:
Victor Stinner974389d2011-03-15 09:33:57 +01002875 - parent.__name__ == name
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002876 - parent.__dict__ is globals
2877 If this is violated... Who cares? */
Victor Stinner974389d2011-03-15 09:33:57 +01002878
2879return_none:
2880 nameobj = PyUnicode_FromUnicode(NULL, 0);
2881 if (nameobj == NULL)
2882 return NULL;
2883 *p_name = nameobj;
2884 return Py_None;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002885}
2886
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002887/* altmod is either None or same as mod */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002888static PyObject *
Victor Stinner974389d2011-03-15 09:33:57 +01002889load_next(PyObject *mod, PyObject *altmod,
2890 PyObject *inputname, PyObject **p_outputname,
2891 Py_UNICODE *buf, Py_ssize_t *p_buflen, Py_ssize_t bufsize)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002892{
Victor Stinner974389d2011-03-15 09:33:57 +01002893 const Py_UNICODE *dot;
2894 Py_ssize_t len;
2895 Py_UNICODE *p;
2896 PyObject *fullname, *name, *result, *mark_name;
2897 const Py_UNICODE *nameuni;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002898
Victor Stinner974389d2011-03-15 09:33:57 +01002899 *p_outputname = NULL;
2900
2901 if (PyUnicode_GET_SIZE(inputname) == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002902 /* completely empty module name should only happen in
2903 'from . import' (or '__import__("")')*/
2904 Py_INCREF(mod);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002905 return mod;
2906 }
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002907
Victor Stinner974389d2011-03-15 09:33:57 +01002908 nameuni = PyUnicode_AS_UNICODE(inputname);
2909 if (nameuni == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002910 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002911
Victor Stinner974389d2011-03-15 09:33:57 +01002912 dot = Py_UNICODE_strchr(nameuni, '.');
2913 if (dot != NULL) {
2914 len = dot - nameuni;
2915 if (len == 0) {
2916 PyErr_SetString(PyExc_ValueError,
2917 "Empty module name");
2918 return NULL;
2919 }
2920 }
2921 else
2922 len = PyUnicode_GET_SIZE(inputname);
2923
2924 if (*p_buflen+len+1 >= bufsize) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002925 PyErr_SetString(PyExc_ValueError,
2926 "Module name too long");
2927 return NULL;
2928 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002929
Victor Stinner974389d2011-03-15 09:33:57 +01002930 p = buf + *p_buflen;
2931 if (p != buf) {
2932 *p++ = '.';
2933 *p_buflen += 1;
2934 }
2935 Py_UNICODE_strncpy(p, nameuni, len);
2936 p[len] = '\0';
2937 *p_buflen += len;
2938
2939 fullname = PyUnicode_FromUnicode(buf, *p_buflen);
2940 if (fullname == NULL)
2941 return NULL;
2942 name = PyUnicode_FromUnicode(p, len);
2943 if (name == NULL) {
2944 Py_DECREF(fullname);
2945 return NULL;
2946 }
2947 result = import_submodule(mod, name, fullname);
2948 Py_DECREF(fullname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002949 if (result == Py_None && altmod != mod) {
2950 Py_DECREF(result);
2951 /* Here, altmod must be None and mod must not be None */
Victor Stinner974389d2011-03-15 09:33:57 +01002952 result = import_submodule(altmod, name, name);
2953 Py_DECREF(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002954 if (result != NULL && result != Py_None) {
Victor Stinner974389d2011-03-15 09:33:57 +01002955 mark_name = PyUnicode_FromUnicode(buf, *p_buflen);
2956 if (mark_name == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002957 Py_DECREF(result);
2958 return NULL;
2959 }
Victor Stinner974389d2011-03-15 09:33:57 +01002960 if (mark_miss(mark_name) != 0) {
2961 Py_DECREF(result);
2962 Py_DECREF(mark_name);
2963 return NULL;
2964 }
2965 Py_DECREF(mark_name);
2966 Py_UNICODE_strncpy(buf, nameuni, len);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002967 buf[len] = '\0';
2968 *p_buflen = len;
2969 }
2970 }
Victor Stinner974389d2011-03-15 09:33:57 +01002971 else
2972 Py_DECREF(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002973 if (result == NULL)
2974 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002975
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002976 if (result == Py_None) {
2977 Py_DECREF(result);
2978 PyErr_Format(PyExc_ImportError,
Victor Stinner974389d2011-03-15 09:33:57 +01002979 "No module named %R", inputname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002980 return NULL;
2981 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002982
Victor Stinner974389d2011-03-15 09:33:57 +01002983 if (dot != NULL) {
2984 *p_outputname = PyUnicode_FromUnicode(dot+1, Py_UNICODE_strlen(dot+1));
2985 if (*p_outputname == NULL) {
2986 Py_DECREF(result);
2987 return NULL;
2988 }
2989 }
2990
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002991 return result;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002992}
2993
2994static int
Victor Stinner974389d2011-03-15 09:33:57 +01002995mark_miss(PyObject *name)
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00002996{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002997 PyObject *modules = PyImport_GetModuleDict();
Victor Stinner974389d2011-03-15 09:33:57 +01002998 return PyDict_SetItem(modules, name, Py_None);
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00002999}
3000
3001static int
Victor Stinner974389d2011-03-15 09:33:57 +01003002ensure_fromlist(PyObject *mod, PyObject *fromlist, PyObject *name,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003003 int recursive)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003004{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003005 int i;
Victor Stinner974389d2011-03-15 09:33:57 +01003006 PyObject *fullname;
3007 Py_ssize_t fromlist_len;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003008
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003009 if (!PyObject_HasAttrString(mod, "__path__"))
3010 return 1;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003011
Victor Stinner974389d2011-03-15 09:33:57 +01003012 fromlist_len = PySequence_Size(fromlist);
3013
3014 for (i = 0; i < fromlist_len; i++) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003015 PyObject *item = PySequence_GetItem(fromlist, i);
3016 int hasit;
Victor Stinner974389d2011-03-15 09:33:57 +01003017 if (item == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003018 return 0;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003019 if (!PyUnicode_Check(item)) {
3020 PyErr_SetString(PyExc_TypeError,
3021 "Item in ``from list'' not a string");
3022 Py_DECREF(item);
3023 return 0;
3024 }
3025 if (PyUnicode_AS_UNICODE(item)[0] == '*') {
3026 PyObject *all;
3027 Py_DECREF(item);
3028 /* See if the package defines __all__ */
3029 if (recursive)
3030 continue; /* Avoid endless recursion */
3031 all = PyObject_GetAttrString(mod, "__all__");
3032 if (all == NULL)
3033 PyErr_Clear();
3034 else {
Victor Stinner974389d2011-03-15 09:33:57 +01003035 int ret = ensure_fromlist(mod, all, name, 1);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003036 Py_DECREF(all);
3037 if (!ret)
3038 return 0;
3039 }
3040 continue;
3041 }
3042 hasit = PyObject_HasAttr(mod, item);
3043 if (!hasit) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003044 PyObject *submod;
Victor Stinner974389d2011-03-15 09:33:57 +01003045 fullname = PyUnicode_FromFormat("%U.%U", name, item);
3046 if (fullname != NULL) {
3047 submod = import_submodule(mod, item, fullname);
3048 Py_DECREF(fullname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003049 }
Victor Stinner974389d2011-03-15 09:33:57 +01003050 else
3051 submod = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003052 Py_XDECREF(submod);
3053 if (submod == NULL) {
3054 Py_DECREF(item);
3055 return 0;
3056 }
3057 }
3058 Py_DECREF(item);
3059 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003060
Victor Stinner974389d2011-03-15 09:33:57 +01003061 return 1;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003062}
3063
Neil Schemenauer00b09662003-06-16 21:03:07 +00003064static int
Victor Stinner974389d2011-03-15 09:33:57 +01003065add_submodule(PyObject *mod, PyObject *submod, PyObject *fullname,
3066 PyObject *subname, PyObject *modules)
Neil Schemenauer00b09662003-06-16 21:03:07 +00003067{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003068 if (mod == Py_None)
3069 return 1;
3070 /* Irrespective of the success of this load, make a
3071 reference to it in the parent package module. A copy gets
3072 saved in the modules dictionary under the full name, so get a
3073 reference from there, if need be. (The exception is when the
3074 load failed with a SyntaxError -- then there's no trace in
3075 sys.modules. In that case, of course, do nothing extra.) */
3076 if (submod == NULL) {
Victor Stinner974389d2011-03-15 09:33:57 +01003077 submod = PyDict_GetItem(modules, fullname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003078 if (submod == NULL)
3079 return 1;
3080 }
3081 if (PyModule_Check(mod)) {
3082 /* We can't use setattr here since it can give a
3083 * spurious warning if the submodule name shadows a
3084 * builtin name */
3085 PyObject *dict = PyModule_GetDict(mod);
3086 if (!dict)
3087 return 0;
Victor Stinner974389d2011-03-15 09:33:57 +01003088 if (PyDict_SetItem(dict, subname, submod) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003089 return 0;
3090 }
3091 else {
Victor Stinner974389d2011-03-15 09:33:57 +01003092 if (PyObject_SetAttr(mod, subname, submod) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003093 return 0;
3094 }
3095 return 1;
Neil Schemenauer00b09662003-06-16 21:03:07 +00003096}
3097
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003098static PyObject *
Victor Stinner974389d2011-03-15 09:33:57 +01003099import_submodule(PyObject *mod, PyObject *subname, PyObject *fullname)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003100{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003101 PyObject *modules = PyImport_GetModuleDict();
Victor Stinner533d7832011-03-14 13:22:54 -04003102 PyObject *m = NULL, *bufobj, *path_list, *loader;
Victor Stinner9599de52011-03-13 22:38:38 -04003103 char buf[MAXPATHLEN+1];
3104 struct filedescr *fdp;
3105 FILE *fp;
Guido van Rossum74e6a111994-08-29 12:54:38 +00003106
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003107 /* Require:
3108 if mod == None: subname == fullname
3109 else: mod.__name__ + "." + subname == fullname
3110 */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003111
Victor Stinner974389d2011-03-15 09:33:57 +01003112 if ((m = PyDict_GetItem(modules, fullname)) != NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003113 Py_INCREF(m);
Victor Stinner9599de52011-03-13 22:38:38 -04003114 return m;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003115 }
Victor Stinner9599de52011-03-13 22:38:38 -04003116
3117 if (mod == Py_None)
Victor Stinner533d7832011-03-14 13:22:54 -04003118 path_list = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003119 else {
Victor Stinner533d7832011-03-14 13:22:54 -04003120 path_list = PyObject_GetAttrString(mod, "__path__");
3121 if (path_list == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003122 PyErr_Clear();
3123 Py_INCREF(Py_None);
3124 return Py_None;
3125 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003126 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003127
Victor Stinner533d7832011-03-14 13:22:54 -04003128 fdp = find_module(fullname, subname, path_list,
3129 buf, MAXPATHLEN+1, &fp, &loader);
3130 Py_XDECREF(path_list);
Victor Stinner9599de52011-03-13 22:38:38 -04003131 if (fdp == NULL) {
3132 if (!PyErr_ExceptionMatches(PyExc_ImportError))
3133 return NULL;
3134 PyErr_Clear();
3135 Py_INCREF(Py_None);
3136 return Py_None;
3137 }
3138 bufobj = PyUnicode_DecodeFSDefault(buf);
3139 if (bufobj != NULL) {
3140 m = load_module(fullname, fp, bufobj, fdp->type, loader);
3141 Py_DECREF(bufobj);
3142 }
3143 else
3144 m = NULL;
3145 Py_XDECREF(loader);
3146 if (fp)
3147 fclose(fp);
3148 if (m == NULL)
3149 return NULL;
3150 if (!add_submodule(mod, m, fullname, subname, modules)) {
3151 Py_XDECREF(m);
3152 return NULL;
3153 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003154 return m;
Guido van Rossum74e6a111994-08-29 12:54:38 +00003155}
3156
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003157
3158/* Re-import a module of any kind and return its module object, WITH
3159 INCREMENTED REFERENCE COUNT */
3160
Guido van Rossum79f25d91997-04-29 20:08:16 +00003161PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003162PyImport_ReloadModule(PyObject *m)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003163{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003164 PyInterpreterState *interp = PyThreadState_Get()->interp;
3165 PyObject *modules_reloading = interp->modules_reloading;
3166 PyObject *modules = PyImport_GetModuleDict();
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003167 char buf[MAXPATHLEN+1];
Victor Stinner533d7832011-03-14 13:22:54 -04003168 PyObject *path_list = NULL, *loader = NULL, *existing_m = NULL;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003169 PyObject *nameobj, *bufobj, *subnameobj;
3170 Py_UNICODE *name, *subname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003171 struct filedescr *fdp;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003172 FILE *fp = NULL;
3173 PyObject *newm = NULL;
Brett Cannon9a5b25a2010-03-01 02:09:17 +00003174
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003175 if (modules_reloading == NULL) {
3176 Py_FatalError("PyImport_ReloadModule: "
3177 "no modules_reloading dictionary!");
3178 return NULL;
3179 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003180
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003181 if (m == NULL || !PyModule_Check(m)) {
3182 PyErr_SetString(PyExc_TypeError,
3183 "reload() argument must be module");
3184 return NULL;
3185 }
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003186 nameobj = PyModule_GetNameObject(m);
3187 if (nameobj == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003188 return NULL;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003189 if (m != PyDict_GetItem(modules, nameobj)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003190 PyErr_Format(PyExc_ImportError,
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003191 "reload(): module %U not in sys.modules",
3192 nameobj);
3193 Py_DECREF(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003194 return NULL;
3195 }
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003196 existing_m = PyDict_GetItem(modules_reloading, nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003197 if (existing_m != NULL) {
3198 /* Due to a recursive reload, this module is already
3199 being reloaded. */
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003200 Py_DECREF(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003201 Py_INCREF(existing_m);
3202 return existing_m;
3203 }
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003204 if (PyDict_SetItem(modules_reloading, nameobj, m) < 0) {
3205 Py_DECREF(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003206 return NULL;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003207 }
Guido van Rossumd8faa362007-04-27 19:54:29 +00003208
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003209 name = PyUnicode_AS_UNICODE(nameobj);
3210 subname = Py_UNICODE_strrchr(name, '.');
3211 if (subname == NULL) {
3212 Py_INCREF(nameobj);
3213 subnameobj = nameobj;
3214 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003215 else {
3216 PyObject *parentname, *parent;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003217 Py_ssize_t len;
3218 len = subname - name;
3219 parentname = PyUnicode_FromUnicode(name, len);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003220 if (parentname == NULL) {
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003221 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003222 }
3223 parent = PyDict_GetItem(modules, parentname);
3224 if (parent == NULL) {
3225 PyErr_Format(PyExc_ImportError,
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003226 "reload(): parent %U not in sys.modules",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003227 parentname);
3228 Py_DECREF(parentname);
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003229 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003230 }
3231 Py_DECREF(parentname);
Victor Stinner533d7832011-03-14 13:22:54 -04003232 path_list = PyObject_GetAttrString(parent, "__path__");
3233 if (path_list == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003234 PyErr_Clear();
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003235 subname++;
3236 len = PyUnicode_GET_SIZE(nameobj) - (len + 1);
3237 subnameobj = PyUnicode_FromUnicode(subname, len);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003238 }
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003239 if (subnameobj == NULL)
3240 goto error;
Victor Stinner533d7832011-03-14 13:22:54 -04003241 fdp = find_module(nameobj, subnameobj, path_list,
3242 buf, MAXPATHLEN+1, &fp, &loader);
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003243 Py_DECREF(subnameobj);
Victor Stinner533d7832011-03-14 13:22:54 -04003244 Py_XDECREF(path_list);
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00003245
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003246 if (fdp == NULL) {
3247 Py_XDECREF(loader);
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003248 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003249 }
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00003250
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003251 bufobj = PyUnicode_DecodeFSDefault(buf);
3252 if (bufobj != NULL) {
3253 newm = load_module(nameobj, fp, bufobj, fdp->type, loader);
3254 Py_DECREF(bufobj);
Victor Stinner41c5fec2011-03-13 21:46:30 -04003255 }
3256 else
3257 newm = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003258 Py_XDECREF(loader);
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00003259
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003260 if (fp)
3261 fclose(fp);
3262 if (newm == NULL) {
3263 /* load_module probably removed name from modules because of
3264 * the error. Put back the original module object. We're
3265 * going to return NULL in this case regardless of whether
3266 * replacing name succeeds, so the return value is ignored.
3267 */
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003268 PyDict_SetItem(modules, nameobj, m);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003269 }
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003270
3271error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003272 imp_modules_reloading_clear();
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003273 Py_DECREF(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003274 return newm;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003275}
3276
3277
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003278/* Higher-level import emulator which emulates the "import" statement
3279 more accurately -- it invokes the __import__() function from the
3280 builtins of the current globals. This means that the import is
3281 done using whatever import hooks are installed in the current
Brett Cannonbc2eff32010-09-19 21:39:02 +00003282 environment.
Guido van Rossum6058eb41998-12-21 19:51:00 +00003283 A dummy list ["__doc__"] is passed as the 4th argument so that
Neal Norwitz80e7f272007-08-26 06:45:23 +00003284 e.g. PyImport_Import(PyUnicode_FromString("win32com.client.gencache"))
Guido van Rossum6058eb41998-12-21 19:51:00 +00003285 will return <module "gencache"> instead of <module "win32com">. */
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003286
3287PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003288PyImport_Import(PyObject *module_name)
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003289{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003290 static PyObject *silly_list = NULL;
3291 static PyObject *builtins_str = NULL;
3292 static PyObject *import_str = NULL;
3293 PyObject *globals = NULL;
3294 PyObject *import = NULL;
3295 PyObject *builtins = NULL;
Brett Cannonbc2eff32010-09-19 21:39:02 +00003296 PyObject *modules = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003297 PyObject *r = NULL;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003298
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003299 /* Initialize constant string objects */
3300 if (silly_list == NULL) {
3301 import_str = PyUnicode_InternFromString("__import__");
3302 if (import_str == NULL)
3303 return NULL;
3304 builtins_str = PyUnicode_InternFromString("__builtins__");
3305 if (builtins_str == NULL)
3306 return NULL;
Brett Cannonbc2eff32010-09-19 21:39:02 +00003307 silly_list = PyList_New(0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003308 if (silly_list == NULL)
3309 return NULL;
3310 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003311
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003312 /* Get the builtins from current globals */
3313 globals = PyEval_GetGlobals();
3314 if (globals != NULL) {
3315 Py_INCREF(globals);
3316 builtins = PyObject_GetItem(globals, builtins_str);
3317 if (builtins == NULL)
3318 goto err;
3319 }
3320 else {
3321 /* No globals -- use standard builtins, and fake globals */
3322 builtins = PyImport_ImportModuleLevel("builtins",
3323 NULL, NULL, NULL, 0);
3324 if (builtins == NULL)
3325 return NULL;
3326 globals = Py_BuildValue("{OO}", builtins_str, builtins);
3327 if (globals == NULL)
3328 goto err;
3329 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003330
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003331 /* Get the __import__ function from the builtins */
3332 if (PyDict_Check(builtins)) {
3333 import = PyObject_GetItem(builtins, import_str);
3334 if (import == NULL)
3335 PyErr_SetObject(PyExc_KeyError, import_str);
3336 }
3337 else
3338 import = PyObject_GetAttr(builtins, import_str);
3339 if (import == NULL)
3340 goto err;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003341
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003342 /* Call the __import__ function with the proper argument list
Brett Cannonbc2eff32010-09-19 21:39:02 +00003343 Always use absolute import here.
3344 Calling for side-effect of import. */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003345 r = PyObject_CallFunction(import, "OOOOi", module_name, globals,
3346 globals, silly_list, 0, NULL);
Brett Cannonbc2eff32010-09-19 21:39:02 +00003347 if (r == NULL)
3348 goto err;
3349 Py_DECREF(r);
3350
3351 modules = PyImport_GetModuleDict();
3352 r = PyDict_GetItem(modules, module_name);
3353 if (r != NULL)
3354 Py_INCREF(r);
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003355
3356 err:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003357 Py_XDECREF(globals);
3358 Py_XDECREF(builtins);
3359 Py_XDECREF(import);
Tim Peters50d8d372001-02-28 05:34:27 +00003360
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003361 return r;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003362}
3363
3364
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003365/* Module 'imp' provides Python access to the primitives used for
3366 importing modules.
3367*/
3368
Guido van Rossum79f25d91997-04-29 20:08:16 +00003369static PyObject *
Barry Warsaw28a691b2010-04-17 00:19:56 +00003370imp_make_magic(long magic)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003371{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003372 char buf[4];
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003373
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003374 buf[0] = (char) ((magic >> 0) & 0xff);
3375 buf[1] = (char) ((magic >> 8) & 0xff);
3376 buf[2] = (char) ((magic >> 16) & 0xff);
3377 buf[3] = (char) ((magic >> 24) & 0xff);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003378
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003379 return PyBytes_FromStringAndSize(buf, 4);
Victor Stinner3e2b7172010-11-09 09:32:19 +00003380}
Barry Warsaw28a691b2010-04-17 00:19:56 +00003381
3382static PyObject *
3383imp_get_magic(PyObject *self, PyObject *noargs)
3384{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003385 return imp_make_magic(pyc_magic);
Barry Warsaw28a691b2010-04-17 00:19:56 +00003386}
3387
3388static PyObject *
3389imp_get_tag(PyObject *self, PyObject *noargs)
3390{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003391 return PyUnicode_FromString(pyc_tag);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003392}
3393
Guido van Rossum79f25d91997-04-29 20:08:16 +00003394static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +00003395imp_get_suffixes(PyObject *self, PyObject *noargs)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003396{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003397 PyObject *list;
3398 struct filedescr *fdp;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003399
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003400 list = PyList_New(0);
3401 if (list == NULL)
3402 return NULL;
3403 for (fdp = _PyImport_Filetab; fdp->suffix != NULL; fdp++) {
3404 PyObject *item = Py_BuildValue("ssi",
3405 fdp->suffix, fdp->mode, fdp->type);
3406 if (item == NULL) {
3407 Py_DECREF(list);
3408 return NULL;
3409 }
3410 if (PyList_Append(list, item) < 0) {
3411 Py_DECREF(list);
3412 Py_DECREF(item);
3413 return NULL;
3414 }
3415 Py_DECREF(item);
3416 }
3417 return list;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003418}
3419
Guido van Rossum79f25d91997-04-29 20:08:16 +00003420static PyObject *
Victor Stinner533d7832011-03-14 13:22:54 -04003421call_find_module(PyObject *name, PyObject *path_list)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003422{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003423 extern int fclose(FILE *);
3424 PyObject *fob, *ret;
3425 PyObject *pathobj;
3426 struct filedescr *fdp;
3427 char pathname[MAXPATHLEN+1];
Victor Stinner7d8b77c2011-03-12 08:45:02 -05003428 FILE *fp;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003429 int fd = -1;
3430 char *found_encoding = NULL;
3431 char *encoding = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003432
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003433 pathname[0] = '\0';
Victor Stinner533d7832011-03-14 13:22:54 -04003434 if (path_list == Py_None)
3435 path_list = NULL;
3436 fdp = find_module(NULL, name, path_list,
3437 pathname, MAXPATHLEN+1, &fp, NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003438 if (fdp == NULL)
3439 return NULL;
3440 if (fp != NULL) {
3441 fd = fileno(fp);
3442 if (fd != -1)
3443 fd = dup(fd);
3444 fclose(fp);
3445 fp = NULL;
3446 }
3447 if (fd != -1) {
3448 if (strchr(fdp->mode, 'b') == NULL) {
3449 /* PyTokenizer_FindEncoding() returns PyMem_MALLOC'ed
3450 memory. */
3451 found_encoding = PyTokenizer_FindEncoding(fd);
3452 lseek(fd, 0, 0); /* Reset position */
3453 if (found_encoding == NULL && PyErr_Occurred())
3454 return NULL;
3455 encoding = (found_encoding != NULL) ? found_encoding :
3456 (char*)PyUnicode_GetDefaultEncoding();
3457 }
3458 fob = PyFile_FromFd(fd, pathname, fdp->mode, -1,
3459 (char*)encoding, NULL, NULL, 1);
3460 if (fob == NULL) {
3461 close(fd);
3462 PyMem_FREE(found_encoding);
3463 return NULL;
3464 }
3465 }
3466 else {
3467 fob = Py_None;
3468 Py_INCREF(fob);
3469 }
3470 pathobj = PyUnicode_DecodeFSDefault(pathname);
3471 ret = Py_BuildValue("NN(ssi)",
3472 fob, pathobj, fdp->suffix, fdp->mode, fdp->type);
3473 PyMem_FREE(found_encoding);
Brett Cannon3bb42d92007-10-20 03:43:15 +00003474
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003475 return ret;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003476}
3477
Guido van Rossum79f25d91997-04-29 20:08:16 +00003478static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003479imp_find_module(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003480{
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003481 PyObject *name, *path_list = NULL;
3482 if (!PyArg_ParseTuple(args, "U|O:find_module",
3483 &name, &path_list))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003484 return NULL;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003485 return call_find_module(name, path_list);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003486}
3487
3488static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003489imp_init_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003490{
Victor Stinner95872862011-03-07 18:20:56 +01003491 PyObject *name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003492 int ret;
3493 PyObject *m;
Victor Stinner95872862011-03-07 18:20:56 +01003494 if (!PyArg_ParseTuple(args, "U:init_builtin", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003495 return NULL;
3496 ret = init_builtin(name);
3497 if (ret < 0)
3498 return NULL;
3499 if (ret == 0) {
3500 Py_INCREF(Py_None);
3501 return Py_None;
3502 }
Victor Stinner95872862011-03-07 18:20:56 +01003503 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003504 Py_XINCREF(m);
3505 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003506}
3507
Guido van Rossum79f25d91997-04-29 20:08:16 +00003508static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003509imp_init_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003510{
Victor Stinner53dc7352011-03-20 01:50:21 +01003511 PyObject *name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003512 int ret;
3513 PyObject *m;
Victor Stinner53dc7352011-03-20 01:50:21 +01003514 if (!PyArg_ParseTuple(args, "U:init_frozen", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003515 return NULL;
Victor Stinner53dc7352011-03-20 01:50:21 +01003516 ret = PyImport_ImportFrozenModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003517 if (ret < 0)
3518 return NULL;
3519 if (ret == 0) {
3520 Py_INCREF(Py_None);
3521 return Py_None;
3522 }
Victor Stinner53dc7352011-03-20 01:50:21 +01003523 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003524 Py_XINCREF(m);
3525 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003526}
3527
Guido van Rossum79f25d91997-04-29 20:08:16 +00003528static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003529imp_get_frozen_object(PyObject *self, PyObject *args)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00003530{
Victor Stinner53dc7352011-03-20 01:50:21 +01003531 PyObject *name;
Jack Jansen95ffa231995-10-03 14:38:41 +00003532
Victor Stinner53dc7352011-03-20 01:50:21 +01003533 if (!PyArg_ParseTuple(args, "U:get_frozen_object", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003534 return NULL;
3535 return get_frozen_object(name);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00003536}
3537
Guido van Rossum79f25d91997-04-29 20:08:16 +00003538static PyObject *
Brett Cannon8d110132009-03-15 02:20:16 +00003539imp_is_frozen_package(PyObject *self, PyObject *args)
3540{
Victor Stinner53dc7352011-03-20 01:50:21 +01003541 PyObject *name;
Brett Cannon8d110132009-03-15 02:20:16 +00003542
Victor Stinner53dc7352011-03-20 01:50:21 +01003543 if (!PyArg_ParseTuple(args, "U:is_frozen_package", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003544 return NULL;
3545 return is_frozen_package(name);
Brett Cannon8d110132009-03-15 02:20:16 +00003546}
3547
3548static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003549imp_is_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003550{
Victor Stinner95872862011-03-07 18:20:56 +01003551 PyObject *name;
3552 if (!PyArg_ParseTuple(args, "U:is_builtin", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003553 return NULL;
3554 return PyLong_FromLong(is_builtin(name));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003555}
3556
Guido van Rossum79f25d91997-04-29 20:08:16 +00003557static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003558imp_is_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003559{
Victor Stinner53dc7352011-03-20 01:50:21 +01003560 PyObject *name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003561 struct _frozen *p;
Victor Stinner53dc7352011-03-20 01:50:21 +01003562 if (!PyArg_ParseTuple(args, "U:is_frozen", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003563 return NULL;
3564 p = find_frozen(name);
3565 return PyBool_FromLong((long) (p == NULL ? 0 : p->size));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003566}
3567
3568static FILE *
Victor Stinner2f42ae52011-03-20 00:41:24 +01003569get_file(PyObject *pathname, PyObject *fob, char *mode)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003570{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003571 FILE *fp;
3572 if (mode[0] == 'U')
3573 mode = "r" PY_STDIOTEXTMODE;
3574 if (fob == NULL) {
Victor Stinner2f42ae52011-03-20 00:41:24 +01003575 fp = _Py_fopen(pathname, mode);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003576 }
3577 else {
3578 int fd = PyObject_AsFileDescriptor(fob);
3579 if (fd == -1)
3580 return NULL;
3581 if (!_PyVerify_fd(fd))
3582 goto error;
3583 /* the FILE struct gets a new fd, so that it can be closed
3584 * independently of the file descriptor given
3585 */
3586 fd = dup(fd);
3587 if (fd == -1)
3588 goto error;
3589 fp = fdopen(fd, mode);
3590 }
3591 if (fp)
3592 return fp;
Kristján Valur Jónssone1b04452009-03-31 17:43:39 +00003593error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003594 PyErr_SetFromErrno(PyExc_IOError);
3595 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003596}
3597
Guido van Rossum79f25d91997-04-29 20:08:16 +00003598static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003599imp_load_compiled(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003600{
Victor Stinner2f42ae52011-03-20 00:41:24 +01003601 PyObject *name, *pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003602 PyObject *fob = NULL;
3603 PyObject *m;
3604 FILE *fp;
Victor Stinner2f42ae52011-03-20 00:41:24 +01003605 if (!PyArg_ParseTuple(args, "UO&|O:load_compiled",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003606 &name,
Victor Stinner2f42ae52011-03-20 00:41:24 +01003607 PyUnicode_FSDecoder, &pathname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003608 &fob))
3609 return NULL;
Victor Stinner2f42ae52011-03-20 00:41:24 +01003610 fp = get_file(pathname, fob, "rb");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003611 if (fp == NULL) {
Victor Stinnerebc00522010-12-03 17:06:43 +00003612 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003613 return NULL;
3614 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01003615 m = load_compiled_module(name, pathname, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003616 fclose(fp);
Victor Stinnerebc00522010-12-03 17:06:43 +00003617 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003618 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003619}
3620
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003621#ifdef HAVE_DYNAMIC_LOADING
3622
Guido van Rossum79f25d91997-04-29 20:08:16 +00003623static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003624imp_load_dynamic(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003625{
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003626 PyObject *name, *pathname, *fob = NULL, *mod;
3627 FILE *fp;
3628
3629 if (!PyArg_ParseTuple(args, "UO&|O:load_dynamic",
3630 &name, PyUnicode_FSDecoder, &pathname, &fob))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003631 return NULL;
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003632 if (fob != NULL) {
3633 fp = get_file(NULL, fob, "r");
3634 if (fp == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003635 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003636 }
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003637 else
3638 fp = NULL;
3639 mod = _PyImport_LoadDynamicModule(name, pathname, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003640 if (fp)
3641 fclose(fp);
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003642 return mod;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003643}
3644
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003645#endif /* HAVE_DYNAMIC_LOADING */
3646
Guido van Rossum79f25d91997-04-29 20:08:16 +00003647static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003648imp_load_source(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003649{
Victor Stinner2f42ae52011-03-20 00:41:24 +01003650 PyObject *name, *pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003651 PyObject *fob = NULL;
3652 PyObject *m;
3653 FILE *fp;
Victor Stinner2f42ae52011-03-20 00:41:24 +01003654 if (!PyArg_ParseTuple(args, "UO&|O:load_source",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003655 &name,
Victor Stinner2f42ae52011-03-20 00:41:24 +01003656 PyUnicode_FSDecoder, &pathname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003657 &fob))
3658 return NULL;
Victor Stinner2f42ae52011-03-20 00:41:24 +01003659 fp = get_file(pathname, fob, "r");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003660 if (fp == NULL) {
Victor Stinnerebc00522010-12-03 17:06:43 +00003661 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003662 return NULL;
3663 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01003664 m = load_source_module(name, pathname, fp);
Victor Stinnerebc00522010-12-03 17:06:43 +00003665 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003666 fclose(fp);
3667 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003668}
3669
Guido van Rossum79f25d91997-04-29 20:08:16 +00003670static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003671imp_load_module(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003672{
Victor Stinner41c5fec2011-03-13 21:46:30 -04003673 PyObject *name, *fob, *pathname, *ret;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003674 char *suffix; /* Unused */
3675 char *mode;
3676 int type;
3677 FILE *fp;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003678
Victor Stinner41c5fec2011-03-13 21:46:30 -04003679 if (!PyArg_ParseTuple(args, "UOO&(ssi):load_module",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003680 &name, &fob,
Victor Stinner41c5fec2011-03-13 21:46:30 -04003681 PyUnicode_FSDecoder, &pathname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003682 &suffix, &mode, &type))
3683 return NULL;
3684 if (*mode) {
3685 /* Mode must start with 'r' or 'U' and must not contain '+'.
3686 Implicit in this test is the assumption that the mode
3687 may contain other modifiers like 'b' or 't'. */
Guido van Rossum5e2c5fa2002-05-30 17:33:07 +00003688
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003689 if (!(*mode == 'r' || *mode == 'U') || strchr(mode, '+')) {
3690 PyErr_Format(PyExc_ValueError,
3691 "invalid file open mode %.200s", mode);
Victor Stinner1a563032010-10-15 22:43:10 +00003692 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003693 return NULL;
3694 }
3695 }
3696 if (fob == Py_None)
3697 fp = NULL;
3698 else {
3699 fp = get_file(NULL, fob, mode);
3700 if (fp == NULL) {
Victor Stinner1a563032010-10-15 22:43:10 +00003701 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003702 return NULL;
3703 }
3704 }
Victor Stinner41c5fec2011-03-13 21:46:30 -04003705 ret = load_module(name, fp, pathname, type, NULL);
Victor Stinner1a563032010-10-15 22:43:10 +00003706 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003707 if (fp)
3708 fclose(fp);
3709 return ret;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003710}
3711
3712static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003713imp_load_package(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003714{
Victor Stinnerc9abda02011-03-14 13:33:46 -04003715 PyObject *name, *pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003716 PyObject * ret;
Victor Stinnerc9abda02011-03-14 13:33:46 -04003717 if (!PyArg_ParseTuple(args, "UO&:load_package",
3718 &name, PyUnicode_FSDecoder, &pathname))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003719 return NULL;
Victor Stinnerc9abda02011-03-14 13:33:46 -04003720 ret = load_package(name, pathname);
Victor Stinnerebc00522010-12-03 17:06:43 +00003721 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003722 return ret;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003723}
3724
3725static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003726imp_new_module(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003727{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003728 char *name;
3729 if (!PyArg_ParseTuple(args, "s:new_module", &name))
3730 return NULL;
3731 return PyModule_New(name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003732}
3733
Christian Heimes13a7a212008-01-07 17:13:09 +00003734static PyObject *
3735imp_reload(PyObject *self, PyObject *v)
3736{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003737 return PyImport_ReloadModule(v);
Christian Heimes13a7a212008-01-07 17:13:09 +00003738}
3739
3740PyDoc_STRVAR(doc_reload,
3741"reload(module) -> module\n\
3742\n\
3743Reload the module. The module must have been successfully imported before.");
3744
Barry Warsaw28a691b2010-04-17 00:19:56 +00003745static PyObject *
3746imp_cache_from_source(PyObject *self, PyObject *args, PyObject *kws)
3747{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003748 static char *kwlist[] = {"path", "debug_override", NULL};
Barry Warsaw28a691b2010-04-17 00:19:56 +00003749
Victor Stinner2f42ae52011-03-20 00:41:24 +01003750 PyObject *pathname, *cpathname;
Benjamin Peterson294a9fc2010-10-16 03:12:39 +00003751 PyObject *debug_override = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003752 int debug = !Py_OptimizeFlag;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003753
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003754 if (!PyArg_ParseTupleAndKeywords(
Victor Stinner3ea23dd2010-10-15 20:34:32 +00003755 args, kws, "O&|O", kwlist,
Victor Stinner2f42ae52011-03-20 00:41:24 +01003756 PyUnicode_FSDecoder, &pathname, &debug_override))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003757 return NULL;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003758
Benjamin Peterson294a9fc2010-10-16 03:12:39 +00003759 if (debug_override != NULL &&
3760 (debug = PyObject_IsTrue(debug_override)) < 0) {
Victor Stinner2f42ae52011-03-20 00:41:24 +01003761 Py_DECREF(pathname);
Benjamin Peterson294a9fc2010-10-16 03:12:39 +00003762 return NULL;
3763 }
Barry Warsaw28a691b2010-04-17 00:19:56 +00003764
Victor Stinner3ea23dd2010-10-15 20:34:32 +00003765 cpathname = make_compiled_pathname(
Victor Stinner2f42ae52011-03-20 00:41:24 +01003766 PyUnicode_AS_UNICODE(pathname),
3767 debug);
3768 Py_DECREF(pathname);
Barry Warsaw28a691b2010-04-17 00:19:56 +00003769
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003770 if (cpathname == NULL) {
3771 PyErr_Format(PyExc_SystemError, "path buffer too short");
3772 return NULL;
3773 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01003774 return cpathname;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003775}
3776
3777PyDoc_STRVAR(doc_cache_from_source,
3778"Given the path to a .py file, return the path to its .pyc/.pyo file.\n\
3779\n\
3780The .py file does not need to exist; this simply returns the path to the\n\
3781.pyc/.pyo file calculated as if the .py file were imported. The extension\n\
3782will be .pyc unless __debug__ is not defined, then it will be .pyo.\n\
3783\n\
3784If debug_override is not None, then it must be a boolean and is taken as\n\
3785the value of __debug__ instead.");
3786
3787static PyObject *
3788imp_source_from_cache(PyObject *self, PyObject *args, PyObject *kws)
3789{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003790 static char *kwlist[] = {"path", NULL};
Victor Stinnerc9abda02011-03-14 13:33:46 -04003791 PyObject *pathname, *source;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003792
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003793 if (!PyArg_ParseTupleAndKeywords(
Victor Stinnerebc00522010-12-03 17:06:43 +00003794 args, kws, "O&", kwlist,
Victor Stinnerc9abda02011-03-14 13:33:46 -04003795 PyUnicode_FSDecoder, &pathname))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003796 return NULL;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003797
Victor Stinnerc9abda02011-03-14 13:33:46 -04003798 source = make_source_pathname(pathname);
3799 if (source == NULL) {
3800 PyErr_Format(PyExc_ValueError, "Not a PEP 3147 pyc path: %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003801 pathname);
Victor Stinnerc9abda02011-03-14 13:33:46 -04003802 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003803 return NULL;
3804 }
Victor Stinnerc9abda02011-03-14 13:33:46 -04003805 Py_DECREF(pathname);
3806 return source;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003807}
3808
3809PyDoc_STRVAR(doc_source_from_cache,
3810"Given the path to a .pyc./.pyo file, return the path to its .py file.\n\
3811\n\
3812The .pyc/.pyo file does not need to exist; this simply returns the path to\n\
3813the .py file calculated to correspond to the .pyc/.pyo file. If path\n\
3814does not conform to PEP 3147 format, ValueError will be raised.");
3815
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003816/* Doc strings */
3817
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003818PyDoc_STRVAR(doc_imp,
3819"This module provides the components needed to build your own\n\
3820__import__ function. Undocumented functions are obsolete.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003821
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003822PyDoc_STRVAR(doc_find_module,
3823"find_module(name, [path]) -> (file, filename, (suffix, mode, type))\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003824Search for a module. If path is omitted or None, search for a\n\
3825built-in, frozen or special module and continue search in sys.path.\n\
3826The module name cannot contain '.'; to search for a submodule of a\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003827package, pass the submodule name and the package's __path__.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003828
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003829PyDoc_STRVAR(doc_load_module,
3830"load_module(name, file, filename, (suffix, mode, type)) -> module\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003831Load a module, given information returned by find_module().\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003832The module name must include the full package name, if any.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003833
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003834PyDoc_STRVAR(doc_get_magic,
3835"get_magic() -> string\n\
3836Return the magic number for .pyc or .pyo files.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003837
Barry Warsaw28a691b2010-04-17 00:19:56 +00003838PyDoc_STRVAR(doc_get_tag,
3839"get_tag() -> string\n\
3840Return the magic tag for .pyc or .pyo files.");
3841
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003842PyDoc_STRVAR(doc_get_suffixes,
3843"get_suffixes() -> [(suffix, mode, type), ...]\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003844Return a list of (suffix, mode, type) tuples describing the files\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003845that find_module() looks for.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003846
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003847PyDoc_STRVAR(doc_new_module,
3848"new_module(name) -> module\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003849Create a new module. Do not enter it in sys.modules.\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003850The module name must include the full package name, if any.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003851
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003852PyDoc_STRVAR(doc_lock_held,
Tim Petersa7c65092004-08-01 23:26:05 +00003853"lock_held() -> boolean\n\
3854Return True if the import lock is currently held, else False.\n\
3855On platforms without threads, return False.");
Tim Peters69232342001-08-30 05:16:13 +00003856
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00003857PyDoc_STRVAR(doc_acquire_lock,
3858"acquire_lock() -> None\n\
Neal Norwitz2294c0d2003-02-12 23:02:21 +00003859Acquires the interpreter's import lock for the current thread.\n\
3860This lock should be used by import hooks to ensure thread-safety\n\
3861when importing modules.\n\
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00003862On platforms without threads, this function does nothing.");
3863
3864PyDoc_STRVAR(doc_release_lock,
3865"release_lock() -> None\n\
3866Release the interpreter's import lock.\n\
3867On platforms without threads, this function does nothing.");
3868
Guido van Rossum79f25d91997-04-29 20:08:16 +00003869static PyMethodDef imp_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003870 {"find_module", imp_find_module, METH_VARARGS, doc_find_module},
3871 {"get_magic", imp_get_magic, METH_NOARGS, doc_get_magic},
3872 {"get_tag", imp_get_tag, METH_NOARGS, doc_get_tag},
3873 {"get_suffixes", imp_get_suffixes, METH_NOARGS, doc_get_suffixes},
3874 {"load_module", imp_load_module, METH_VARARGS, doc_load_module},
3875 {"new_module", imp_new_module, METH_VARARGS, doc_new_module},
3876 {"lock_held", imp_lock_held, METH_NOARGS, doc_lock_held},
3877 {"acquire_lock", imp_acquire_lock, METH_NOARGS, doc_acquire_lock},
3878 {"release_lock", imp_release_lock, METH_NOARGS, doc_release_lock},
3879 {"reload", imp_reload, METH_O, doc_reload},
3880 {"cache_from_source", (PyCFunction)imp_cache_from_source,
3881 METH_VARARGS | METH_KEYWORDS, doc_cache_from_source},
3882 {"source_from_cache", (PyCFunction)imp_source_from_cache,
3883 METH_VARARGS | METH_KEYWORDS, doc_source_from_cache},
3884 /* The rest are obsolete */
3885 {"get_frozen_object", imp_get_frozen_object, METH_VARARGS},
3886 {"is_frozen_package", imp_is_frozen_package, METH_VARARGS},
3887 {"init_builtin", imp_init_builtin, METH_VARARGS},
3888 {"init_frozen", imp_init_frozen, METH_VARARGS},
3889 {"is_builtin", imp_is_builtin, METH_VARARGS},
3890 {"is_frozen", imp_is_frozen, METH_VARARGS},
3891 {"load_compiled", imp_load_compiled, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003892#ifdef HAVE_DYNAMIC_LOADING
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003893 {"load_dynamic", imp_load_dynamic, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003894#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003895 {"load_package", imp_load_package, METH_VARARGS},
3896 {"load_source", imp_load_source, METH_VARARGS},
3897 {NULL, NULL} /* sentinel */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003898};
3899
Guido van Rossum1a8791e1998-08-04 22:46:29 +00003900static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003901setint(PyObject *d, char *name, int value)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003902{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003903 PyObject *v;
3904 int err;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003905
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003906 v = PyLong_FromLong((long)value);
3907 err = PyDict_SetItemString(d, name, v);
3908 Py_XDECREF(v);
3909 return err;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003910}
3911
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003912typedef struct {
3913 PyObject_HEAD
3914} NullImporter;
3915
3916static int
3917NullImporter_init(NullImporter *self, PyObject *args, PyObject *kwds)
3918{
Victor Stinner1a4d12d2010-08-13 13:07:29 +00003919#ifndef MS_WINDOWS
3920 PyObject *path;
3921 struct stat statbuf;
3922 int rv;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003923
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003924 if (!_PyArg_NoKeywords("NullImporter()", kwds))
3925 return -1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003926
Victor Stinner1a4d12d2010-08-13 13:07:29 +00003927 if (!PyArg_ParseTuple(args, "O&:NullImporter",
3928 PyUnicode_FSConverter, &path))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003929 return -1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003930
Victor Stinner1a4d12d2010-08-13 13:07:29 +00003931 if (PyBytes_GET_SIZE(path) == 0) {
3932 Py_DECREF(path);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003933 PyErr_SetString(PyExc_ImportError, "empty pathname");
3934 return -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003935 }
Victor Stinner1a4d12d2010-08-13 13:07:29 +00003936
3937 rv = stat(PyBytes_AS_STRING(path), &statbuf);
3938 Py_DECREF(path);
3939 if (rv == 0) {
3940 /* it exists */
3941 if (S_ISDIR(statbuf.st_mode)) {
3942 /* it's a directory */
3943 PyErr_SetString(PyExc_ImportError, "existing directory");
3944 return -1;
3945 }
3946 }
3947#else /* MS_WINDOWS */
3948 PyObject *pathobj;
3949 DWORD rv;
Victor Stinner255dfdb2010-09-29 10:28:51 +00003950 wchar_t *path;
Victor Stinner1a4d12d2010-08-13 13:07:29 +00003951
3952 if (!_PyArg_NoKeywords("NullImporter()", kwds))
3953 return -1;
3954
3955 if (!PyArg_ParseTuple(args, "U:NullImporter",
3956 &pathobj))
3957 return -1;
3958
3959 if (PyUnicode_GET_SIZE(pathobj) == 0) {
3960 PyErr_SetString(PyExc_ImportError, "empty pathname");
3961 return -1;
3962 }
3963
Victor Stinnerbeb4135b2010-10-07 01:02:42 +00003964 path = PyUnicode_AsWideCharString(pathobj, NULL);
Victor Stinner255dfdb2010-09-29 10:28:51 +00003965 if (path == NULL)
Victor Stinner1a4d12d2010-08-13 13:07:29 +00003966 return -1;
3967 /* see issue1293 and issue3677:
3968 * stat() on Windows doesn't recognise paths like
3969 * "e:\\shared\\" and "\\\\whiterab-c2znlh\\shared" as dirs.
3970 */
3971 rv = GetFileAttributesW(path);
Victor Stinner255dfdb2010-09-29 10:28:51 +00003972 PyMem_Free(path);
Victor Stinner1a4d12d2010-08-13 13:07:29 +00003973 if (rv != INVALID_FILE_ATTRIBUTES) {
3974 /* it exists */
3975 if (rv & FILE_ATTRIBUTE_DIRECTORY) {
3976 /* it's a directory */
3977 PyErr_SetString(PyExc_ImportError, "existing directory");
3978 return -1;
3979 }
3980 }
3981#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003982 return 0;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003983}
3984
3985static PyObject *
3986NullImporter_find_module(NullImporter *self, PyObject *args)
3987{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003988 Py_RETURN_NONE;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003989}
3990
3991static PyMethodDef NullImporter_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003992 {"find_module", (PyCFunction)NullImporter_find_module, METH_VARARGS,
3993 "Always return None"
3994 },
3995 {NULL} /* Sentinel */
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003996};
3997
3998
Christian Heimes9cd17752007-11-18 19:35:23 +00003999PyTypeObject PyNullImporter_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004000 PyVarObject_HEAD_INIT(NULL, 0)
4001 "imp.NullImporter", /*tp_name*/
4002 sizeof(NullImporter), /*tp_basicsize*/
4003 0, /*tp_itemsize*/
4004 0, /*tp_dealloc*/
4005 0, /*tp_print*/
4006 0, /*tp_getattr*/
4007 0, /*tp_setattr*/
4008 0, /*tp_reserved*/
4009 0, /*tp_repr*/
4010 0, /*tp_as_number*/
4011 0, /*tp_as_sequence*/
4012 0, /*tp_as_mapping*/
4013 0, /*tp_hash */
4014 0, /*tp_call*/
4015 0, /*tp_str*/
4016 0, /*tp_getattro*/
4017 0, /*tp_setattro*/
4018 0, /*tp_as_buffer*/
4019 Py_TPFLAGS_DEFAULT, /*tp_flags*/
4020 "Null importer object", /* tp_doc */
4021 0, /* tp_traverse */
4022 0, /* tp_clear */
4023 0, /* tp_richcompare */
4024 0, /* tp_weaklistoffset */
4025 0, /* tp_iter */
4026 0, /* tp_iternext */
4027 NullImporter_methods, /* tp_methods */
4028 0, /* tp_members */
4029 0, /* tp_getset */
4030 0, /* tp_base */
4031 0, /* tp_dict */
4032 0, /* tp_descr_get */
4033 0, /* tp_descr_set */
4034 0, /* tp_dictoffset */
4035 (initproc)NullImporter_init, /* tp_init */
4036 0, /* tp_alloc */
4037 PyType_GenericNew /* tp_new */
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004038};
4039
Martin v. Löwis1a214512008-06-11 05:26:20 +00004040static struct PyModuleDef impmodule = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004041 PyModuleDef_HEAD_INIT,
4042 "imp",
4043 doc_imp,
4044 0,
4045 imp_methods,
4046 NULL,
4047 NULL,
4048 NULL,
4049 NULL
Martin v. Löwis1a214512008-06-11 05:26:20 +00004050};
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004051
Jason Tishler6bc06ec2003-09-04 11:59:50 +00004052PyMODINIT_FUNC
Martin v. Löwis1a214512008-06-11 05:26:20 +00004053PyInit_imp(void)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004054{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004055 PyObject *m, *d;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004056
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004057 if (PyType_Ready(&PyNullImporter_Type) < 0)
4058 return NULL;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004059
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004060 m = PyModule_Create(&impmodule);
4061 if (m == NULL)
4062 goto failure;
4063 d = PyModule_GetDict(m);
4064 if (d == NULL)
4065 goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004066
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004067 if (setint(d, "SEARCH_ERROR", SEARCH_ERROR) < 0) goto failure;
4068 if (setint(d, "PY_SOURCE", PY_SOURCE) < 0) goto failure;
4069 if (setint(d, "PY_COMPILED", PY_COMPILED) < 0) goto failure;
4070 if (setint(d, "C_EXTENSION", C_EXTENSION) < 0) goto failure;
4071 if (setint(d, "PY_RESOURCE", PY_RESOURCE) < 0) goto failure;
4072 if (setint(d, "PKG_DIRECTORY", PKG_DIRECTORY) < 0) goto failure;
4073 if (setint(d, "C_BUILTIN", C_BUILTIN) < 0) goto failure;
4074 if (setint(d, "PY_FROZEN", PY_FROZEN) < 0) goto failure;
4075 if (setint(d, "PY_CODERESOURCE", PY_CODERESOURCE) < 0) goto failure;
4076 if (setint(d, "IMP_HOOK", IMP_HOOK) < 0) goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004077
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004078 Py_INCREF(&PyNullImporter_Type);
4079 PyModule_AddObject(m, "NullImporter", (PyObject *)&PyNullImporter_Type);
4080 return m;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00004081 failure:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004082 Py_XDECREF(m);
4083 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004084}
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004085
4086
Guido van Rossumb18618d2000-05-03 23:44:39 +00004087/* API for embedding applications that want to add their own entries
4088 to the table of built-in modules. This should normally be called
4089 *before* Py_Initialize(). When the table resize fails, -1 is
4090 returned and the existing table is unchanged.
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004091
4092 After a similar function by Just van Rossum. */
4093
4094int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00004095PyImport_ExtendInittab(struct _inittab *newtab)
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004096{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004097 static struct _inittab *our_copy = NULL;
4098 struct _inittab *p;
4099 int i, n;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004100
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004101 /* Count the number of entries in both tables */
4102 for (n = 0; newtab[n].name != NULL; n++)
4103 ;
4104 if (n == 0)
4105 return 0; /* Nothing to do */
4106 for (i = 0; PyImport_Inittab[i].name != NULL; i++)
4107 ;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004108
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004109 /* Allocate new memory for the combined table */
4110 p = our_copy;
4111 PyMem_RESIZE(p, struct _inittab, i+n+1);
4112 if (p == NULL)
4113 return -1;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004114
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004115 /* Copy the tables into the new memory */
4116 if (our_copy != PyImport_Inittab)
4117 memcpy(p, PyImport_Inittab, (i+1) * sizeof(struct _inittab));
4118 PyImport_Inittab = our_copy = p;
4119 memcpy(p+i, newtab, (n+1) * sizeof(struct _inittab));
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004120
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004121 return 0;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004122}
4123
4124/* Shorthand to add a single entry given a name and a function */
4125
4126int
Brett Cannona826f322009-04-02 03:41:46 +00004127PyImport_AppendInittab(const char *name, PyObject* (*initfunc)(void))
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004128{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004129 struct _inittab newtab[2];
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004130
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004131 memset(newtab, '\0', sizeof newtab);
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004132
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004133 newtab[0].name = (char *)name;
4134 newtab[0].initfunc = initfunc;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004135
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004136 return PyImport_ExtendInittab(newtab);
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004137}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00004138
4139#ifdef __cplusplus
4140}
4141#endif