blob: 5360d57c511037f409a3041b9dc3522c46384309 [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
Victor Stinnerfe7c5b52011-04-05 01:48:03 +0200127/* Function from Parser/tokenizer.c */
128extern char * PyTokenizer_FindEncodingFilename(int, PyObject *);
129
Guido van Rossum771c6c81997-10-31 18:37:24 +0000130/* This table is defined in config.c: */
131extern struct _inittab _PyImport_Inittab[];
132
133struct _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;
Victor Stinnerccbf4752011-03-14 15:05:12 -0400946 buf[i] = '\0';
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000947 /* 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);
Victor Stinnerccbf4752011-03-14 15:05:12 -0400951 pos = Py_UNICODE_strrchr(buf + i, '.');
Victor Stinner2f42ae52011-03-20 00:41:24 +0100952 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
Victor Stinner783c82c2011-04-20 03:27:51 +02001201#ifndef MS_WINDOWS
Guido van Rossum55a83382000-09-20 20:31:38 +00001202static FILE *
Christian Heimes05e8be12008-02-23 18:30:17 +00001203open_exclusive(char *filename, mode_t mode)
Guido van Rossum55a83382000-09-20 20:31:38 +00001204{
1205#if defined(O_EXCL)&&defined(O_CREAT)&&defined(O_WRONLY)&&defined(O_TRUNC)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001206 /* Use O_EXCL to avoid a race condition when another process tries to
1207 write the same file. When that happens, our open() call fails,
1208 which is just fine (since it's only a cache).
1209 XXX If the file exists and is writable but the directory is not
1210 writable, the file will never be written. Oh well.
1211 */
1212 int fd;
1213 (void) unlink(filename);
1214 fd = open(filename, O_EXCL|O_CREAT|O_WRONLY|O_TRUNC
Tim Peters42c83af2000-09-29 04:03:10 +00001215#ifdef O_BINARY
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001216 |O_BINARY /* necessary for Windows */
Tim Peters42c83af2000-09-29 04:03:10 +00001217#endif
Martin v. Löwis79acb9e2002-12-06 12:48:53 +00001218#ifdef __VMS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001219 , mode, "ctxt=bin", "shr=nil"
Martin v. Löwis79acb9e2002-12-06 12:48:53 +00001220#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001221 , mode
Martin v. Löwis79acb9e2002-12-06 12:48:53 +00001222#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001223 );
1224 if (fd < 0)
1225 return NULL;
1226 return fdopen(fd, "wb");
Guido van Rossum55a83382000-09-20 20:31:38 +00001227#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001228 /* Best we can do -- on Windows this can't happen anyway */
1229 return fopen(filename, "wb");
Guido van Rossum55a83382000-09-20 20:31:38 +00001230#endif
1231}
Victor Stinner783c82c2011-04-20 03:27:51 +02001232#endif
Guido van Rossum55a83382000-09-20 20:31:38 +00001233
1234
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001235/* Write a compiled module to a file, placing the time of last
1236 modification of its source into the header.
1237 Errors are ignored, if a write error occurs an attempt is made to
1238 remove the file. */
1239
1240static void
Victor Stinner2f42ae52011-03-20 00:41:24 +01001241write_compiled_module(PyCodeObject *co, PyObject *cpathname,
1242 struct stat *srcstat)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001243{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001244 FILE *fp;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001245 time_t mtime = srcstat->st_mtime;
Alexandre Vassalotti9d58e3e2009-07-17 10:55:50 +00001246#ifdef MS_WINDOWS /* since Windows uses different permissions */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001247 mode_t mode = srcstat->st_mode & ~S_IEXEC;
Alexandre Vassalotti9d58e3e2009-07-17 10:55:50 +00001248#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001249 mode_t mode = srcstat->st_mode & ~S_IXUSR & ~S_IXGRP & ~S_IXOTH;
1250 mode_t dirmode = (srcstat->st_mode |
1251 S_IXUSR | S_IXGRP | S_IXOTH |
1252 S_IWUSR | S_IWGRP | S_IWOTH);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001253 PyObject *dirbytes;
Brett Cannon9a5b25a2010-03-01 02:09:17 +00001254#endif
Victor Stinner783c82c2011-04-20 03:27:51 +02001255#ifdef MS_WINDOWS
1256 int fd;
1257#else
1258 PyObject *cpathbytes;
1259#endif
1260 PyObject *dirname;
Victor Stinner2f42ae52011-03-20 00:41:24 +01001261 Py_UNICODE *dirsep;
1262 int res, ok;
Barry Warsaw28a691b2010-04-17 00:19:56 +00001263
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001264 /* Ensure that the __pycache__ directory exists. */
Victor Stinner2f42ae52011-03-20 00:41:24 +01001265 dirsep = rightmost_sep(PyUnicode_AS_UNICODE(cpathname));
1266 if (dirsep == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001267 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001268 PySys_FormatStderr("# no %s path found %R\n", CACHEDIR, cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001269 return;
1270 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01001271 dirname = PyUnicode_FromUnicode(PyUnicode_AS_UNICODE(cpathname),
1272 dirsep - PyUnicode_AS_UNICODE(cpathname));
1273 if (dirname == NULL) {
1274 PyErr_Clear();
1275 return;
1276 }
Daniel Stutzbachc7937792010-09-09 21:18:04 +00001277
1278#ifdef MS_WINDOWS
Victor Stinner2f42ae52011-03-20 00:41:24 +01001279 res = CreateDirectoryW(PyUnicode_AS_UNICODE(dirname), NULL);
1280 ok = (res != 0);
1281 if (!ok && GetLastError() == ERROR_ALREADY_EXISTS)
1282 ok = 1;
Daniel Stutzbachc7937792010-09-09 21:18:04 +00001283#else
Victor Stinner2f42ae52011-03-20 00:41:24 +01001284 dirbytes = PyUnicode_EncodeFSDefault(dirname);
1285 if (dirbytes == NULL) {
1286 PyErr_Clear();
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001287 return;
1288 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01001289 res = mkdir(PyBytes_AS_STRING(dirbytes), dirmode);
1290 Py_DECREF(dirbytes);
1291 if (0 <= res)
1292 ok = 1;
1293 else
1294 ok = (errno == EEXIST);
1295#endif
1296 if (!ok) {
1297 if (Py_VerboseFlag)
1298 PySys_FormatStderr("# cannot create cache dir %R\n", dirname);
1299 Py_DECREF(dirname);
1300 return;
1301 }
1302 Py_DECREF(dirname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001303
Victor Stinner783c82c2011-04-20 03:27:51 +02001304#ifdef MS_WINDOWS
1305 (void)DeleteFileW(PyUnicode_AS_UNICODE(cpathname));
1306 fd = _wopen(PyUnicode_AS_UNICODE(cpathname),
1307 O_EXCL | O_CREAT | O_WRONLY | O_TRUNC | O_BINARY,
1308 mode);
1309 if (0 <= fd)
1310 fp = fdopen(fd, "wb");
1311 else
1312 fp = NULL;
1313#else
Victor Stinner2f42ae52011-03-20 00:41:24 +01001314 cpathbytes = PyUnicode_EncodeFSDefault(cpathname);
1315 if (cpathbytes == NULL) {
1316 PyErr_Clear();
1317 return;
1318 }
1319
1320 fp = open_exclusive(PyBytes_AS_STRING(cpathbytes), mode);
Victor Stinner783c82c2011-04-20 03:27:51 +02001321#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001322 if (fp == NULL) {
1323 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001324 PySys_FormatStderr(
1325 "# can't create %R\n", cpathname);
Victor Stinner783c82c2011-04-20 03:27:51 +02001326#ifndef MS_WINDOWS
Victor Stinner2f42ae52011-03-20 00:41:24 +01001327 Py_DECREF(cpathbytes);
Victor Stinner783c82c2011-04-20 03:27:51 +02001328#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001329 return;
1330 }
1331 PyMarshal_WriteLongToFile(pyc_magic, fp, Py_MARSHAL_VERSION);
1332 /* First write a 0 for mtime */
1333 PyMarshal_WriteLongToFile(0L, fp, Py_MARSHAL_VERSION);
1334 PyMarshal_WriteObjectToFile((PyObject *)co, fp, Py_MARSHAL_VERSION);
1335 if (fflush(fp) != 0 || ferror(fp)) {
1336 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001337 PySys_FormatStderr("# can't write %R\n", cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001338 /* Don't keep partial file */
1339 fclose(fp);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001340#ifdef MS_WINDOWS
1341 (void)DeleteFileW(PyUnicode_AS_UNICODE(cpathname));
1342#else
1343 (void) unlink(PyBytes_AS_STRING(cpathbytes));
Victor Stinner2f42ae52011-03-20 00:41:24 +01001344 Py_DECREF(cpathbytes);
Victor Stinner783c82c2011-04-20 03:27:51 +02001345#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001346 return;
1347 }
Victor Stinner783c82c2011-04-20 03:27:51 +02001348#ifndef MS_WINDOWS
Victor Stinner2f42ae52011-03-20 00:41:24 +01001349 Py_DECREF(cpathbytes);
Victor Stinner783c82c2011-04-20 03:27:51 +02001350#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001351 /* Now write the true mtime */
1352 fseek(fp, 4L, 0);
1353 assert(mtime < LONG_MAX);
1354 PyMarshal_WriteLongToFile((long)mtime, fp, Py_MARSHAL_VERSION);
1355 fflush(fp);
1356 fclose(fp);
1357 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001358 PySys_FormatStderr("# wrote %R\n", cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001359}
1360
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001361static void
1362update_code_filenames(PyCodeObject *co, PyObject *oldname, PyObject *newname)
1363{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001364 PyObject *constants, *tmp;
1365 Py_ssize_t i, n;
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001366
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001367 if (PyUnicode_Compare(co->co_filename, oldname))
1368 return;
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001369
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001370 tmp = co->co_filename;
1371 co->co_filename = newname;
1372 Py_INCREF(co->co_filename);
1373 Py_DECREF(tmp);
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001374
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001375 constants = co->co_consts;
1376 n = PyTuple_GET_SIZE(constants);
1377 for (i = 0; i < n; i++) {
1378 tmp = PyTuple_GET_ITEM(constants, i);
1379 if (PyCode_Check(tmp))
1380 update_code_filenames((PyCodeObject *)tmp,
1381 oldname, newname);
1382 }
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001383}
1384
Victor Stinner2f42ae52011-03-20 00:41:24 +01001385static void
1386update_compiled_module(PyCodeObject *co, PyObject *newname)
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001387{
Victor Stinner2f42ae52011-03-20 00:41:24 +01001388 PyObject *oldname;
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001389
Victor Stinner2f42ae52011-03-20 00:41:24 +01001390 if (PyUnicode_Compare(co->co_filename, newname) == 0)
1391 return;
Hirokazu Yamamoto4f447fb2009-03-04 01:52:10 +00001392
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001393 oldname = co->co_filename;
1394 Py_INCREF(oldname);
1395 update_code_filenames(co, oldname, newname);
1396 Py_DECREF(oldname);
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001397}
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001398
Brett Cannon442c9b92011-03-23 16:14:42 -07001399static PyObject *
1400imp_fix_co_filename(PyObject *self, PyObject *args)
1401{
1402 PyObject *co;
1403 PyObject *file_path;
1404
1405 if (!PyArg_ParseTuple(args, "OO:_fix_co_filename", &co, &file_path))
1406 return NULL;
1407
1408 if (!PyCode_Check(co)) {
1409 PyErr_SetString(PyExc_TypeError,
1410 "first argument must be a code object");
1411 return NULL;
1412 }
1413
1414 if (!PyUnicode_Check(file_path)) {
1415 PyErr_SetString(PyExc_TypeError,
1416 "second argument must be a string");
1417 return NULL;
1418 }
1419
1420 update_compiled_module((PyCodeObject*)co, file_path);
1421
1422 Py_RETURN_NONE;
1423}
1424
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001425/* Load a source module from a given file and return its module
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001426 object WITH INCREMENTED REFERENCE COUNT. If there's a matching
1427 byte-compiled file, use that instead. */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001428
Guido van Rossum79f25d91997-04-29 20:08:16 +00001429static PyObject *
Victor Stinner2f42ae52011-03-20 00:41:24 +01001430load_source_module(PyObject *name, PyObject *pathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001431{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001432 struct stat st;
1433 FILE *fpc;
Victor Stinner2f42ae52011-03-20 00:41:24 +01001434 PyObject *cpathname = NULL, *cpathbytes = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001435 PyCodeObject *co;
Victor Stinner2f42ae52011-03-20 00:41:24 +01001436 PyObject *m = NULL;
Brett Cannon9a5b25a2010-03-01 02:09:17 +00001437
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001438 if (fstat(fileno(fp), &st) != 0) {
1439 PyErr_Format(PyExc_RuntimeError,
Victor Stinner2f42ae52011-03-20 00:41:24 +01001440 "unable to get file status from %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001441 pathname);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001442 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001443 }
Fred Drake4c82b232000-06-30 16:18:57 +00001444#if SIZEOF_TIME_T > 4
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001445 /* Python's .pyc timestamp handling presumes that the timestamp fits
1446 in 4 bytes. This will be fine until sometime in the year 2038,
1447 when a 4-byte signed time_t will overflow.
1448 */
1449 if (st.st_mtime >> 32) {
1450 PyErr_SetString(PyExc_OverflowError,
1451 "modification time overflows a 4 byte field");
Victor Stinner2f42ae52011-03-20 00:41:24 +01001452 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001453 }
Fred Drake4c82b232000-06-30 16:18:57 +00001454#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001455 cpathname = make_compiled_pathname(
Victor Stinner2f42ae52011-03-20 00:41:24 +01001456 PyUnicode_AS_UNICODE(pathname),
1457 !Py_OptimizeFlag);
1458
1459 if (cpathname != NULL)
1460 fpc = check_compiled_module(pathname, st.st_mtime, cpathname);
1461 else
1462 fpc = NULL;
1463
1464 if (fpc) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001465 co = read_compiled_module(cpathname, fpc);
1466 fclose(fpc);
1467 if (co == NULL)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001468 goto error;
1469 update_compiled_module(co, pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001470 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001471 PySys_FormatStderr("import %U # precompiled from %R\n",
1472 name, cpathname);
1473 m = PyImport_ExecCodeModuleObject(name, (PyObject *)co,
1474 cpathname, cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001475 }
1476 else {
1477 co = parse_source_module(pathname, fp);
1478 if (co == NULL)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001479 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001480 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001481 PySys_FormatStderr("import %U # from %R\n",
Victor Stinner98dbba52011-03-14 15:15:47 -04001482 name, pathname);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001483 if (cpathname != NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001484 PyObject *ro = PySys_GetObject("dont_write_bytecode");
1485 if (ro == NULL || !PyObject_IsTrue(ro))
1486 write_compiled_module(co, cpathname, &st);
1487 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01001488 m = PyImport_ExecCodeModuleObject(name, (PyObject *)co,
1489 pathname, cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001490 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001491 Py_DECREF(co);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001492
Victor Stinner2f42ae52011-03-20 00:41:24 +01001493error:
1494 Py_XDECREF(cpathbytes);
1495 Py_XDECREF(cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001496 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001497}
1498
Christian Heimes3b06e532008-01-07 20:12:44 +00001499/* Get source file -> unicode or None
1500 * Returns the path to the py file if available, else the given path
1501 */
1502static PyObject *
Victor Stinnerc9abda02011-03-14 13:33:46 -04001503get_sourcefile(PyObject *filename)
Christian Heimes3b06e532008-01-07 20:12:44 +00001504{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001505 Py_ssize_t len;
Victor Stinnerc9abda02011-03-14 13:33:46 -04001506 Py_UNICODE *fileuni;
1507 PyObject *py;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001508 struct stat statbuf;
Christian Heimes3b06e532008-01-07 20:12:44 +00001509
Victor Stinnerc9abda02011-03-14 13:33:46 -04001510 len = PyUnicode_GET_SIZE(filename);
1511 if (len == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001512 Py_RETURN_NONE;
Christian Heimes3b06e532008-01-07 20:12:44 +00001513
Victor Stinnerc9abda02011-03-14 13:33:46 -04001514 /* don't match *.pyc or *.pyo? */
1515 fileuni = PyUnicode_AS_UNICODE(filename);
1516 if (len < 5
1517 || fileuni[len-4] != '.'
1518 || (fileuni[len-3] != 'p' && fileuni[len-3] != 'P')
1519 || (fileuni[len-2] != 'y' && fileuni[len-2] != 'Y'))
1520 goto unchanged;
Christian Heimes3b06e532008-01-07 20:12:44 +00001521
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001522 /* Start by trying to turn PEP 3147 path into source path. If that
1523 * fails, just chop off the trailing character, i.e. legacy pyc path
1524 * to py.
1525 */
Victor Stinnerc9abda02011-03-14 13:33:46 -04001526 py = make_source_pathname(filename);
1527 if (py == NULL) {
1528 PyErr_Clear();
1529 py = PyUnicode_FromUnicode(fileuni, len - 1);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001530 }
Victor Stinnerc9abda02011-03-14 13:33:46 -04001531 if (py == NULL)
1532 goto error;
Barry Warsaw28a691b2010-04-17 00:19:56 +00001533
Victor Stinnerc9abda02011-03-14 13:33:46 -04001534 if (_Py_stat(py, &statbuf) == 0 && S_ISREG(statbuf.st_mode))
1535 return py;
1536 Py_DECREF(py);
1537 goto unchanged;
1538
1539error:
1540 PyErr_Clear();
1541unchanged:
1542 Py_INCREF(filename);
1543 return filename;
Christian Heimes3b06e532008-01-07 20:12:44 +00001544}
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001545
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001546/* Forward */
Victor Stinner41c5fec2011-03-13 21:46:30 -04001547static PyObject *load_module(PyObject *, FILE *, PyObject *, int, PyObject *);
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001548static struct filedescr *find_module(PyObject *, PyObject *, PyObject *,
Victor Stinner2fd76e42011-03-14 15:19:39 -04001549 PyObject **, FILE **, PyObject **);
Victor Stinner53dc7352011-03-20 01:50:21 +01001550static struct _frozen * find_frozen(PyObject *);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001551
1552/* Load a package and return its module object WITH INCREMENTED
1553 REFERENCE COUNT */
1554
1555static PyObject *
Victor Stinnerc9abda02011-03-14 13:33:46 -04001556load_package(PyObject *name, PyObject *pathname)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001557{
Victor Stinner41c5fec2011-03-13 21:46:30 -04001558 PyObject *m, *d, *bufobj;
Victor Stinnerc9abda02011-03-14 13:33:46 -04001559 PyObject *file = NULL, *path_list = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001560 int err;
Victor Stinnerc9abda02011-03-14 13:33:46 -04001561 FILE *fp = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001562 struct filedescr *fdp;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001563
Victor Stinnerc9abda02011-03-14 13:33:46 -04001564 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001565 if (m == NULL)
1566 return NULL;
1567 if (Py_VerboseFlag)
Victor Stinner98dbba52011-03-14 15:15:47 -04001568 PySys_FormatStderr("import %U # directory %R\n",
1569 name, pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001570 file = get_sourcefile(pathname);
1571 if (file == NULL)
Victor Stinnerc9abda02011-03-14 13:33:46 -04001572 return NULL;
1573 path_list = Py_BuildValue("[O]", file);
1574 if (path_list == NULL) {
1575 Py_DECREF(file);
1576 return NULL;
1577 }
1578 d = PyModule_GetDict(m);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001579 err = PyDict_SetItemString(d, "__file__", file);
Victor Stinnerc9abda02011-03-14 13:33:46 -04001580 Py_DECREF(file);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001581 if (err == 0)
Victor Stinnerc9abda02011-03-14 13:33:46 -04001582 err = PyDict_SetItemString(d, "__path__", path_list);
1583 if (err != 0) {
1584 Py_DECREF(path_list);
1585 return NULL;
1586 }
Victor Stinner533d7832011-03-14 13:22:54 -04001587 fdp = find_module(name, initstr, path_list,
Victor Stinner2fd76e42011-03-14 15:19:39 -04001588 &bufobj, &fp, NULL);
Victor Stinnerc9abda02011-03-14 13:33:46 -04001589 Py_DECREF(path_list);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001590 if (fdp == NULL) {
1591 if (PyErr_ExceptionMatches(PyExc_ImportError)) {
1592 PyErr_Clear();
1593 Py_INCREF(m);
Victor Stinnerc9abda02011-03-14 13:33:46 -04001594 return m;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001595 }
1596 else
Victor Stinnerc9abda02011-03-14 13:33:46 -04001597 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001598 }
Victor Stinner2fd76e42011-03-14 15:19:39 -04001599 m = load_module(name, fp, bufobj, fdp->type, NULL);
1600 Py_XDECREF(bufobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001601 if (fp != NULL)
1602 fclose(fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001603 return m;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001604}
1605
1606
1607/* Helper to test for built-in module */
1608
1609static int
Victor Stinner95872862011-03-07 18:20:56 +01001610is_builtin(PyObject *name)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001611{
Victor Stinner95872862011-03-07 18:20:56 +01001612 int i, cmp;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001613 for (i = 0; PyImport_Inittab[i].name != NULL; i++) {
Victor Stinner95872862011-03-07 18:20:56 +01001614 cmp = PyUnicode_CompareWithASCIIString(name, PyImport_Inittab[i].name);
1615 if (cmp == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001616 if (PyImport_Inittab[i].initfunc == NULL)
1617 return -1;
1618 else
1619 return 1;
1620 }
1621 }
1622 return 0;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001623}
1624
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001625
Just van Rossum52e14d62002-12-30 22:08:05 +00001626/* Return an importer object for a sys.path/pkg.__path__ item 'p',
1627 possibly by fetching it from the path_importer_cache dict. If it
Thomas Wouters89f507f2006-12-13 04:49:30 +00001628 wasn't yet cached, traverse path_hooks until a hook is found
Just van Rossum52e14d62002-12-30 22:08:05 +00001629 that can handle the path item. Return None if no hook could;
1630 this tells our caller it should fall back to the builtin
1631 import mechanism. Cache the result in path_importer_cache.
1632 Returns a borrowed reference. */
1633
1634static PyObject *
1635get_path_importer(PyObject *path_importer_cache, PyObject *path_hooks,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001636 PyObject *p)
Just van Rossum52e14d62002-12-30 22:08:05 +00001637{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001638 PyObject *importer;
1639 Py_ssize_t j, nhooks;
Just van Rossum52e14d62002-12-30 22:08:05 +00001640
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001641 /* These conditions are the caller's responsibility: */
1642 assert(PyList_Check(path_hooks));
1643 assert(PyDict_Check(path_importer_cache));
Just van Rossum52e14d62002-12-30 22:08:05 +00001644
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001645 nhooks = PyList_Size(path_hooks);
1646 if (nhooks < 0)
1647 return NULL; /* Shouldn't happen */
Just van Rossum52e14d62002-12-30 22:08:05 +00001648
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001649 importer = PyDict_GetItem(path_importer_cache, p);
1650 if (importer != NULL)
1651 return importer;
Just van Rossum52e14d62002-12-30 22:08:05 +00001652
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001653 /* set path_importer_cache[p] to None to avoid recursion */
1654 if (PyDict_SetItem(path_importer_cache, p, Py_None) != 0)
1655 return NULL;
Just van Rossum52e14d62002-12-30 22:08:05 +00001656
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001657 for (j = 0; j < nhooks; j++) {
1658 PyObject *hook = PyList_GetItem(path_hooks, j);
1659 if (hook == NULL)
1660 return NULL;
1661 importer = PyObject_CallFunctionObjArgs(hook, p, NULL);
1662 if (importer != NULL)
1663 break;
Just van Rossum52e14d62002-12-30 22:08:05 +00001664
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001665 if (!PyErr_ExceptionMatches(PyExc_ImportError)) {
1666 return NULL;
1667 }
1668 PyErr_Clear();
1669 }
1670 if (importer == NULL) {
1671 importer = PyObject_CallFunctionObjArgs(
1672 (PyObject *)&PyNullImporter_Type, p, NULL
1673 );
1674 if (importer == NULL) {
1675 if (PyErr_ExceptionMatches(PyExc_ImportError)) {
1676 PyErr_Clear();
1677 return Py_None;
1678 }
1679 }
1680 }
1681 if (importer != NULL) {
1682 int err = PyDict_SetItem(path_importer_cache, p, importer);
1683 Py_DECREF(importer);
1684 if (err != 0)
1685 return NULL;
1686 }
1687 return importer;
Just van Rossum52e14d62002-12-30 22:08:05 +00001688}
1689
Christian Heimes9cd17752007-11-18 19:35:23 +00001690PyAPI_FUNC(PyObject *)
1691PyImport_GetImporter(PyObject *path) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001692 PyObject *importer=NULL, *path_importer_cache=NULL, *path_hooks=NULL;
Christian Heimes9cd17752007-11-18 19:35:23 +00001693
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001694 if ((path_importer_cache = PySys_GetObject("path_importer_cache"))) {
1695 if ((path_hooks = PySys_GetObject("path_hooks"))) {
1696 importer = get_path_importer(path_importer_cache,
1697 path_hooks, path);
1698 }
1699 }
1700 Py_XINCREF(importer); /* get_path_importer returns a borrowed reference */
1701 return importer;
Christian Heimes9cd17752007-11-18 19:35:23 +00001702}
1703
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001704/* Search the path (default sys.path) for a module. Return the
1705 corresponding filedescr struct, and (via return arguments) the
1706 pathname and an open file. Return NULL if the module is not found. */
1707
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001708#ifdef MS_COREDLL
Victor Stinner4d6c1c42011-03-08 23:49:04 +01001709extern FILE *_PyWin_FindRegisteredModule(PyObject *, struct filedescr **,
1710 PyObject **p_path);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001711#endif
1712
Victor Stinner547a2a62011-03-20 03:07:28 +01001713/* Forward */
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001714static int case_ok(PyObject *, Py_ssize_t, PyObject *);
Victor Stinner547a2a62011-03-20 03:07:28 +01001715static int find_init_module(PyObject *);
Just van Rossum52e14d62002-12-30 22:08:05 +00001716static struct filedescr importhookdescr = {"", "", IMP_HOOK};
Guido van Rossum197346f1997-10-31 18:38:52 +00001717
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001718/* Get the path of a module: get its importer and call importer.find_module()
1719 hook, or check if the module if a package (if path/__init__.py exists).
1720
1721 -1: error: a Python error occurred
1722 0: ignore: an error occurred because of invalid data, but the error is not
1723 important enough to be reported.
1724 1: get path: module not found, but *buf contains its path
1725 2: found: *p_fd is the file descriptor (IMP_HOOK or PKG_DIRECTORY)
1726 and *buf is the path */
1727
1728static int
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001729find_module_path(PyObject *fullname, PyObject *name, PyObject *path,
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001730 PyObject *path_hooks, PyObject *path_importer_cache,
Victor Stinner2fd76e42011-03-14 15:19:39 -04001731 PyObject **p_path, PyObject **p_loader, struct filedescr **p_fd)
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001732{
Victor Stinner2fd76e42011-03-14 15:19:39 -04001733 Py_UNICODE buf[MAXPATHLEN+1];
1734 Py_ssize_t buflen = MAXPATHLEN+1;
1735 PyObject *path_unicode, *filename;
1736 const Py_UNICODE *base;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001737 Py_ssize_t len;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001738 struct stat statbuf;
1739 static struct filedescr fd_package = {"", "", PKG_DIRECTORY};
1740
1741 if (PyUnicode_Check(path)) {
Victor Stinner2fd76e42011-03-14 15:19:39 -04001742 Py_INCREF(path);
1743 path_unicode = path;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001744 }
1745 else if (PyBytes_Check(path)) {
Victor Stinner2fd76e42011-03-14 15:19:39 -04001746 path_unicode = PyUnicode_DecodeFSDefaultAndSize(
1747 PyBytes_AS_STRING(path), PyBytes_GET_SIZE(path));
1748 if (path_unicode == NULL)
1749 return -1;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001750 }
1751 else
1752 return 0;
1753
Victor Stinner2fd76e42011-03-14 15:19:39 -04001754 base = PyUnicode_AS_UNICODE(path_unicode);
1755 len = PyUnicode_GET_SIZE(path_unicode);
1756 if (len + 2 + PyUnicode_GET_SIZE(name) + MAXSUFFIXSIZE >= buflen) {
1757 Py_DECREF(path_unicode);
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001758 return 0; /* Too long */
1759 }
Victor Stinner2fd76e42011-03-14 15:19:39 -04001760 Py_UNICODE_strcpy(buf, PyUnicode_AS_UNICODE(path_unicode));
1761 Py_DECREF(path_unicode);
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001762
Victor Stinner2fd76e42011-03-14 15:19:39 -04001763 if (Py_UNICODE_strlen(buf) != len)
1764 return 0; /* path contains '\0' */
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001765
1766 /* sys.path_hooks import hook */
1767 if (p_loader != NULL) {
1768 PyObject *importer;
1769
1770 importer = get_path_importer(path_importer_cache,
1771 path_hooks, path);
1772 if (importer == NULL) {
1773 return -1;
1774 }
1775 /* Note: importer is a borrowed reference */
1776 if (importer != Py_None) {
1777 PyObject *loader;
1778 loader = PyObject_CallMethod(importer,
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001779 "find_module", "O", fullname);
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001780 if (loader == NULL)
1781 return -1; /* error */
1782 if (loader != Py_None) {
1783 /* a loader was found */
1784 *p_loader = loader;
1785 *p_fd = &importhookdescr;
1786 return 2;
1787 }
1788 Py_DECREF(loader);
1789 return 0;
1790 }
1791 }
1792 /* no hook was found, use builtin import */
1793
1794 if (len > 0 && buf[len-1] != SEP
1795#ifdef ALTSEP
1796 && buf[len-1] != ALTSEP
1797#endif
1798 )
1799 buf[len++] = SEP;
Victor Stinner2fd76e42011-03-14 15:19:39 -04001800 Py_UNICODE_strcpy(buf+len, PyUnicode_AS_UNICODE(name));
1801 len += PyUnicode_GET_SIZE(name);
1802
1803 filename = PyUnicode_FromUnicode(buf, len);
1804 if (filename == NULL)
1805 return -1;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001806
1807 /* Check for package import (buf holds a directory name,
1808 and there's an __init__ module in that directory */
1809#ifdef HAVE_STAT
Victor Stinner2fd76e42011-03-14 15:19:39 -04001810 if (_Py_stat(filename, &statbuf) == 0 && /* it exists */
Victor Stinnerd0296212011-03-14 14:04:10 -04001811 S_ISDIR(statbuf.st_mode)) /* it's a directory */
1812 {
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001813 int match;
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001814
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001815 match = case_ok(filename, 0, name);
1816 if (match < 0) {
1817 Py_DECREF(filename);
1818 return -1;
1819 }
1820 if (match) { /* case matches */
1821 if (find_init_module(filename)) { /* and has __init__.py */
Victor Stinner2fd76e42011-03-14 15:19:39 -04001822 *p_path = filename;
Victor Stinnerd0296212011-03-14 14:04:10 -04001823 *p_fd = &fd_package;
1824 return 2;
1825 }
1826 else {
1827 int err;
Victor Stinnerd0296212011-03-14 14:04:10 -04001828 err = PyErr_WarnFormat(PyExc_ImportWarning, 1,
Victor Stinner547a2a62011-03-20 03:07:28 +01001829 "Not importing directory %R: missing __init__.py",
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001830 filename);
Victor Stinner547a2a62011-03-20 03:07:28 +01001831 if (err) {
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001832 Py_DECREF(filename);
Victor Stinnerd0296212011-03-14 14:04:10 -04001833 return -1;
Victor Stinner547a2a62011-03-20 03:07:28 +01001834 }
Victor Stinnerd0296212011-03-14 14:04:10 -04001835 }
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001836 }
1837 }
1838#endif
Victor Stinner2fd76e42011-03-14 15:19:39 -04001839 *p_path = filename;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001840 return 1;
1841}
1842
1843/* Find a module in search_path_list. For each path, try
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001844 find_module_path() or try each _PyImport_Filetab suffix.
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001845
1846 If the module is found, return a file descriptor, write the path in
1847 *p_filename, write the pointer to the file object into *p_fp, and (if
1848 p_loader is not NULL) the loader into *p_loader.
1849
1850 Otherwise, raise an exception and return NULL. */
1851
Victor Stinner37580282011-03-20 01:34:43 +01001852static struct filedescr*
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001853find_module_path_list(PyObject *fullname, PyObject *name,
Victor Stinner37580282011-03-20 01:34:43 +01001854 PyObject *search_path_list, PyObject *path_hooks,
1855 PyObject *path_importer_cache,
Victor Stinner2fd76e42011-03-14 15:19:39 -04001856 PyObject **p_path, FILE **p_fp, PyObject **p_loader)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001857{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001858 Py_ssize_t i, npath;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001859 struct filedescr *fdp = NULL;
1860 char *filemode;
1861 FILE *fp = NULL;
Victor Stinner2fd76e42011-03-14 15:19:39 -04001862 PyObject *prefix, *filename;
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001863 int match;
Victor Stinner53dc7352011-03-20 01:50:21 +01001864
Victor Stinner37580282011-03-20 01:34:43 +01001865 npath = PyList_Size(search_path_list);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001866 for (i = 0; i < npath; i++) {
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001867 PyObject *path;
1868 int ok;
1869
1870 path = PyList_GetItem(search_path_list, i);
1871 if (path == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001872 return NULL;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001873
Victor Stinner2fd76e42011-03-14 15:19:39 -04001874 prefix = NULL;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001875 ok = find_module_path(fullname, name, path,
1876 path_hooks, path_importer_cache,
Victor Stinner2fd76e42011-03-14 15:19:39 -04001877 &prefix, p_loader, &fdp);
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001878 if (ok < 0)
1879 return NULL;
1880 if (ok == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001881 continue;
Victor Stinner2fd76e42011-03-14 15:19:39 -04001882 if (ok == 2) {
1883 *p_path = prefix;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001884 return fdp;
Victor Stinner2fd76e42011-03-14 15:19:39 -04001885 }
Amaury Forgeot d'Arcf1ca0b12008-06-11 17:40:47 +00001886
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001887 for (fdp = _PyImport_Filetab; fdp->suffix != NULL; fdp++) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001888 filemode = fdp->mode;
1889 if (filemode[0] == 'U')
1890 filemode = "r" PY_STDIOTEXTMODE;
Victor Stinnerd0296212011-03-14 14:04:10 -04001891
Victor Stinner2fd76e42011-03-14 15:19:39 -04001892 filename = PyUnicode_FromFormat("%U%s", prefix, fdp->suffix);
1893 if (filename == NULL) {
1894 Py_DECREF(prefix);
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001895 return NULL;
Victor Stinner2fd76e42011-03-14 15:19:39 -04001896 }
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001897
1898 if (Py_VerboseFlag > 1)
1899 PySys_FormatStderr("# trying %R\n", filename);
1900
1901 fp = _Py_fopen(filename, filemode);
1902 if (fp == NULL) {
1903 Py_DECREF(filename);
1904 continue;
1905 }
1906 match = case_ok(filename, -(Py_ssize_t)strlen(fdp->suffix), name);
1907 if (match < 0) {
Victor Stinner2fd76e42011-03-14 15:19:39 -04001908 Py_DECREF(prefix);
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001909 Py_DECREF(filename);
1910 return NULL;
1911 }
1912 if (match) {
Victor Stinner2fd76e42011-03-14 15:19:39 -04001913 Py_DECREF(prefix);
1914 *p_path = filename;
Victor Stinnerd0296212011-03-14 14:04:10 -04001915 *p_fp = fp;
1916 return fdp;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001917 }
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001918 Py_DECREF(filename);
Victor Stinnerd0296212011-03-14 14:04:10 -04001919
1920 fclose(fp);
1921 fp = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001922 }
Victor Stinner2fd76e42011-03-14 15:19:39 -04001923 Py_DECREF(prefix);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001924 }
Victor Stinnerd0296212011-03-14 14:04:10 -04001925 PyErr_Format(PyExc_ImportError,
Victor Stinner98dbba52011-03-14 15:15:47 -04001926 "No module named %R", name);
Victor Stinnerd0296212011-03-14 14:04:10 -04001927 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001928}
1929
Victor Stinner37580282011-03-20 01:34:43 +01001930/* Find a module:
1931
1932 - try find_module() of each sys.meta_path hook
1933 - try find_frozen()
1934 - try is_builtin()
1935 - try _PyWin_FindRegisteredModule() (Windows only)
1936 - otherwise, call find_module_path_list() with search_path_list (if not
1937 NULL) or sys.path
1938
Victor Stinner2fd76e42011-03-14 15:19:39 -04001939 fullname can be NULL, but only if p_loader is NULL.
1940
Victor Stinner37580282011-03-20 01:34:43 +01001941 Return:
1942
1943 - &fd_builtin (C_BUILTIN) if it is a builtin
1944 - &fd_frozen (PY_FROZEN) if it is frozen
Victor Stinner2fd76e42011-03-14 15:19:39 -04001945 - &fd_package (PKG_DIRECTORY) and write the filename into *p_path
Victor Stinner37580282011-03-20 01:34:43 +01001946 if it is a package
1947 - &importhookdescr (IMP_HOOK) and write the loader into *p_loader if a
1948 importer loader was found
1949 - a file descriptor (PY_SOURCE, PY_COMPILED, C_EXTENSION, PY_RESOURCE or
1950 PY_CODERESOURCE: see _PyImport_Filetab), write the filename into
Victor Stinner2fd76e42011-03-14 15:19:39 -04001951 *p_path and the pointer to the open file into *p_fp
Victor Stinner37580282011-03-20 01:34:43 +01001952 - NULL on error
1953
Victor Stinner2fd76e42011-03-14 15:19:39 -04001954 By default, *p_path, *p_fp and *p_loader (if set) are set to NULL.
1955 Eg. *p_path is set to NULL for a builtin package.
1956*/
Victor Stinner37580282011-03-20 01:34:43 +01001957
1958static struct filedescr *
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001959find_module(PyObject *fullname, PyObject *name, PyObject *search_path_list,
Victor Stinner2fd76e42011-03-14 15:19:39 -04001960 PyObject **p_path, FILE **p_fp, PyObject **p_loader)
Victor Stinner37580282011-03-20 01:34:43 +01001961{
1962 Py_ssize_t i, npath;
1963 static struct filedescr fd_frozen = {"", "", PY_FROZEN};
1964 static struct filedescr fd_builtin = {"", "", C_BUILTIN};
1965 PyObject *path_hooks, *path_importer_cache;
Victor Stinner37580282011-03-20 01:34:43 +01001966
Victor Stinner2fd76e42011-03-14 15:19:39 -04001967 *p_path = NULL;
Victor Stinner37580282011-03-20 01:34:43 +01001968 *p_fp = NULL;
1969 if (p_loader != NULL)
1970 *p_loader = NULL;
1971
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001972 if (PyUnicode_GET_SIZE(name) > MAXPATHLEN) {
Victor Stinner37580282011-03-20 01:34:43 +01001973 PyErr_SetString(PyExc_OverflowError,
1974 "module name is too long");
1975 return NULL;
1976 }
1977
1978 /* sys.meta_path import hook */
1979 if (p_loader != NULL) {
1980 PyObject *meta_path;
1981
1982 meta_path = PySys_GetObject("meta_path");
1983 if (meta_path == NULL || !PyList_Check(meta_path)) {
1984 PyErr_SetString(PyExc_ImportError,
1985 "sys.meta_path must be a list of "
1986 "import hooks");
1987 return NULL;
1988 }
1989 Py_INCREF(meta_path); /* zap guard */
1990 npath = PyList_Size(meta_path);
1991 for (i = 0; i < npath; i++) {
1992 PyObject *loader;
1993 PyObject *hook = PyList_GetItem(meta_path, i);
1994 loader = PyObject_CallMethod(hook, "find_module",
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001995 "OO", fullname,
Victor Stinner37580282011-03-20 01:34:43 +01001996 search_path_list != NULL ?
1997 search_path_list : Py_None);
1998 if (loader == NULL) {
1999 Py_DECREF(meta_path);
2000 return NULL; /* true error */
2001 }
2002 if (loader != Py_None) {
2003 /* a loader was found */
2004 *p_loader = loader;
2005 Py_DECREF(meta_path);
2006 return &importhookdescr;
2007 }
2008 Py_DECREF(loader);
2009 }
2010 Py_DECREF(meta_path);
2011 }
2012
Victor Stinnerdf75a022011-03-14 13:40:04 -04002013 if (find_frozen(fullname) != NULL)
Victor Stinnerad3c03b2011-03-14 09:21:33 -04002014 return &fd_frozen;
Victor Stinner37580282011-03-20 01:34:43 +01002015
2016 if (search_path_list == NULL) {
2017#ifdef MS_COREDLL
2018 FILE *fp;
2019 struct filedescr *fdp;
Victor Stinner37580282011-03-20 01:34:43 +01002020#endif
Victor Stinnerdf75a022011-03-14 13:40:04 -04002021 if (is_builtin(name))
Victor Stinner37580282011-03-20 01:34:43 +01002022 return &fd_builtin;
Victor Stinner37580282011-03-20 01:34:43 +01002023#ifdef MS_COREDLL
Victor Stinner2fd76e42011-03-14 15:19:39 -04002024 fp = _PyWin_FindRegisteredModule(name, &fdp, p_path);
Victor Stinner37580282011-03-20 01:34:43 +01002025 if (fp != NULL) {
Victor Stinner37580282011-03-20 01:34:43 +01002026 *p_fp = fp;
2027 return fdp;
2028 }
2029 else if (PyErr_Occurred())
2030 return NULL;
2031#endif
Victor Stinner37580282011-03-20 01:34:43 +01002032 search_path_list = PySys_GetObject("path");
2033 }
2034
2035 if (search_path_list == NULL || !PyList_Check(search_path_list)) {
2036 PyErr_SetString(PyExc_ImportError,
2037 "sys.path must be a list of directory names");
2038 return NULL;
2039 }
2040
2041 path_hooks = PySys_GetObject("path_hooks");
2042 if (path_hooks == NULL || !PyList_Check(path_hooks)) {
2043 PyErr_SetString(PyExc_ImportError,
2044 "sys.path_hooks must be a list of "
2045 "import hooks");
2046 return NULL;
2047 }
2048 path_importer_cache = PySys_GetObject("path_importer_cache");
2049 if (path_importer_cache == NULL ||
2050 !PyDict_Check(path_importer_cache)) {
2051 PyErr_SetString(PyExc_ImportError,
2052 "sys.path_importer_cache must be a dict");
2053 return NULL;
2054 }
2055
2056 return find_module_path_list(fullname, name,
2057 search_path_list, path_hooks,
2058 path_importer_cache,
Victor Stinner2fd76e42011-03-14 15:19:39 -04002059 p_path, p_fp, p_loader);
Victor Stinner37580282011-03-20 01:34:43 +01002060}
2061
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002062/* case_bytes(char* buf, Py_ssize_t len, Py_ssize_t namelen, char* name)
Tim Petersd1e87a82001-03-01 18:12:00 +00002063 * The arguments here are tricky, best shown by example:
2064 * /a/b/c/d/e/f/g/h/i/j/k/some_long_module_name.py\0
2065 * ^ ^ ^ ^
2066 * |--------------------- buf ---------------------|
2067 * |------------------- len ------------------|
2068 * |------ name -------|
2069 * |----- namelen -----|
2070 * buf is the full path, but len only counts up to (& exclusive of) the
2071 * extension. name is the module name, also exclusive of extension.
2072 *
2073 * We've already done a successful stat() or fopen() on buf, so know that
2074 * there's some match, possibly case-insensitive.
2075 *
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002076 * case_bytes() is to return 1 if there's a case-sensitive match for
2077 * name, else 0. case_bytes() is also to return 1 if envar PYTHONCASEOK
Tim Peters50d8d372001-02-28 05:34:27 +00002078 * exists.
Tim Petersd1e87a82001-03-01 18:12:00 +00002079 *
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002080 * case_bytes() is used to implement case-sensitive import semantics even
Tim Peters50d8d372001-02-28 05:34:27 +00002081 * on platforms with case-insensitive filesystems. It's trivial to implement
2082 * for case-sensitive filesystems. It's pretty much a cross-platform
2083 * nightmare for systems with case-insensitive filesystems.
2084 */
Guido van Rossum0980bd91998-02-13 17:18:36 +00002085
Tim Peters50d8d372001-02-28 05:34:27 +00002086/* First we may need a pile of platform-specific header files; the sequence
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002087 * of #if's here should match the sequence in the body of case_bytes().
Tim Peters50d8d372001-02-28 05:34:27 +00002088 */
Jason Tishler7961aa62005-05-20 00:56:54 +00002089#if defined(MS_WINDOWS)
Guido van Rossum0980bd91998-02-13 17:18:36 +00002090#include <windows.h>
Guido van Rossum4c3f57c2001-01-10 20:40:46 +00002091
Tim Peters50d8d372001-02-28 05:34:27 +00002092#elif defined(DJGPP)
2093#include <dir.h>
2094
Jason Tishler7961aa62005-05-20 00:56:54 +00002095#elif (defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) && defined(HAVE_DIRENT_H)
Tim Peters430f5d42001-03-01 01:30:56 +00002096#include <sys/types.h>
2097#include <dirent.h>
2098
Andrew MacIntyred9400542002-02-26 11:41:34 +00002099#elif defined(PYOS_OS2)
2100#define INCL_DOS
2101#define INCL_DOSERRORS
2102#define INCL_NOPMAPI
2103#include <os2.h>
Tim Peters50d8d372001-02-28 05:34:27 +00002104#endif
2105
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002106#if defined(DJGPP) \
2107 || ((defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) \
2108 && defined(HAVE_DIRENT_H)) \
2109 || defined(PYOS_OS2)
2110# define USE_CASE_OK_BYTES
2111#endif
2112
2113
2114#ifdef USE_CASE_OK_BYTES
Guido van Rossum0980bd91998-02-13 17:18:36 +00002115static int
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002116case_bytes(char *buf, Py_ssize_t len, Py_ssize_t namelen, const char *name)
Guido van Rossum0980bd91998-02-13 17:18:36 +00002117{
Tim Peters50d8d372001-02-28 05:34:27 +00002118/* Pick a platform-specific implementation; the sequence of #if's here should
2119 * match the sequence just above.
2120 */
2121
Tim Peters50d8d372001-02-28 05:34:27 +00002122/* DJGPP */
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002123#if defined(DJGPP)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002124 struct ffblk ffblk;
2125 int done;
Tim Peters50d8d372001-02-28 05:34:27 +00002126
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002127 if (Py_GETENV("PYTHONCASEOK") != NULL)
2128 return 1;
Tim Peters50d8d372001-02-28 05:34:27 +00002129
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002130 done = findfirst(buf, &ffblk, FA_ARCH|FA_RDONLY|FA_HIDDEN|FA_DIREC);
2131 if (done) {
2132 PyErr_Format(PyExc_NameError,
2133 "Can't find file for module %.100s\n(filename %.300s)",
2134 name, buf);
Victor Stinner9c61e242011-03-22 01:22:27 +01002135 return -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002136 }
2137 return strncmp(ffblk.ff_name, name, namelen) == 0;
Guido van Rossum0980bd91998-02-13 17:18:36 +00002138
Jason Tishler7961aa62005-05-20 00:56:54 +00002139/* new-fangled macintosh (macosx) or Cygwin */
2140#elif (defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) && defined(HAVE_DIRENT_H)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002141 DIR *dirp;
2142 struct dirent *dp;
2143 char dirname[MAXPATHLEN + 1];
2144 const int dirlen = len - namelen - 1; /* don't want trailing SEP */
Tim Peters430f5d42001-03-01 01:30:56 +00002145
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002146 if (Py_GETENV("PYTHONCASEOK") != NULL)
2147 return 1;
Tim Petersdbe6ebb2001-03-01 08:47:29 +00002148
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002149 /* Copy the dir component into dirname; substitute "." if empty */
2150 if (dirlen <= 0) {
2151 dirname[0] = '.';
2152 dirname[1] = '\0';
2153 }
2154 else {
2155 assert(dirlen <= MAXPATHLEN);
2156 memcpy(dirname, buf, dirlen);
2157 dirname[dirlen] = '\0';
2158 }
2159 /* Open the directory and search the entries for an exact match. */
2160 dirp = opendir(dirname);
2161 if (dirp) {
2162 char *nameWithExt = buf + len - namelen;
2163 while ((dp = readdir(dirp)) != NULL) {
2164 const int thislen =
Tim Peters430f5d42001-03-01 01:30:56 +00002165#ifdef _DIRENT_HAVE_D_NAMELEN
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002166 dp->d_namlen;
Tim Peters430f5d42001-03-01 01:30:56 +00002167#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002168 strlen(dp->d_name);
Tim Peters430f5d42001-03-01 01:30:56 +00002169#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002170 if (thislen >= namelen &&
2171 strcmp(dp->d_name, nameWithExt) == 0) {
2172 (void)closedir(dirp);
2173 return 1; /* Found */
2174 }
2175 }
2176 (void)closedir(dirp);
2177 }
2178 return 0 ; /* Not found */
Tim Peters430f5d42001-03-01 01:30:56 +00002179
Andrew MacIntyred9400542002-02-26 11:41:34 +00002180/* OS/2 */
2181#elif defined(PYOS_OS2)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002182 HDIR hdir = 1;
2183 ULONG srchcnt = 1;
2184 FILEFINDBUF3 ffbuf;
2185 APIRET rc;
Andrew MacIntyred9400542002-02-26 11:41:34 +00002186
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002187 if (Py_GETENV("PYTHONCASEOK") != NULL)
2188 return 1;
Andrew MacIntyred9400542002-02-26 11:41:34 +00002189
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002190 rc = DosFindFirst(buf,
2191 &hdir,
2192 FILE_READONLY | FILE_HIDDEN | FILE_SYSTEM | FILE_DIRECTORY,
2193 &ffbuf, sizeof(ffbuf),
2194 &srchcnt,
2195 FIL_STANDARD);
2196 if (rc != NO_ERROR)
2197 return 0;
2198 return strncmp(ffbuf.achName, name, namelen) == 0;
Andrew MacIntyred9400542002-02-26 11:41:34 +00002199
Tim Peters50d8d372001-02-28 05:34:27 +00002200/* assuming it's a case-sensitive filesystem, so there's nothing to do! */
2201#else
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002202# error "USE_CASE_OK_BYTES is not correctly defined"
2203#endif
2204}
2205#endif
2206
2207/*
2208 * Check if a filename case matchs the name case. We've already done a
2209 * successful stat() or fopen() on buf, so know that there's some match,
2210 * possibly case-insensitive.
2211 *
2212 * case_ok() is to return 1 if there's a case-sensitive match for name, 0 if it
2213 * the filename doesn't match, or -1 on error. case_ok() is also to return 1
2214 * if envar PYTHONCASEOK exists.
2215 *
2216 * case_ok() is used to implement case-sensitive import semantics even
2217 * on platforms with case-insensitive filesystems. It's trivial to implement
2218 * for case-sensitive filesystems. It's pretty much a cross-platform
2219 * nightmare for systems with case-insensitive filesystems.
2220 */
2221
2222static int
2223case_ok(PyObject *filename, Py_ssize_t prefix_delta, PyObject *name)
2224{
2225#ifdef MS_WINDOWS
2226 WIN32_FIND_DATAW data;
2227 HANDLE h;
2228 int cmp;
2229
2230 if (Py_GETENV("PYTHONCASEOK") != NULL)
2231 return 1;
2232
2233 h = FindFirstFileW(PyUnicode_AS_UNICODE(filename), &data);
2234 if (h == INVALID_HANDLE_VALUE) {
2235 PyErr_Format(PyExc_NameError,
2236 "Can't find file for module %R\n(filename %R)",
2237 name, filename);
2238 return 0;
2239 }
2240 FindClose(h);
2241 cmp = wcsncmp(data.cFileName,
2242 PyUnicode_AS_UNICODE(name),
2243 PyUnicode_GET_SIZE(name));
2244 return cmp == 0;
2245#elif defined(USE_CASE_OK_BYTES)
2246 int match;
2247 PyObject *filebytes, *namebytes;
2248 filebytes = PyUnicode_EncodeFSDefault(filename);
2249 if (filebytes == NULL)
2250 return -1;
2251 namebytes = PyUnicode_EncodeFSDefault(name);
2252 if (namebytes == NULL) {
2253 Py_DECREF(filebytes);
2254 return -1;
2255 }
2256 match = case_bytes(
2257 PyBytes_AS_STRING(filebytes),
2258 PyBytes_GET_SIZE(filebytes) + prefix_delta,
Victor Stinner1304f2d2011-03-20 04:28:55 +01002259 PyBytes_GET_SIZE(namebytes),
2260 PyBytes_AS_STRING(namebytes));
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002261 Py_DECREF(filebytes);
2262 Py_DECREF(namebytes);
2263 return match;
2264#else
2265 /* assuming it's a case-sensitive filesystem, so there's nothing to do! */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002266 return 1;
Guido van Rossum0980bd91998-02-13 17:18:36 +00002267
Guido van Rossum4d1b3b91998-02-13 23:27:59 +00002268#endif
Tim Peters50d8d372001-02-28 05:34:27 +00002269}
Guido van Rossum4d1b3b91998-02-13 23:27:59 +00002270
Guido van Rossum197346f1997-10-31 18:38:52 +00002271#ifdef HAVE_STAT
Victor Stinner4f4402c2010-08-14 14:50:26 +00002272
Victor Stinner547a2a62011-03-20 03:07:28 +01002273/* Helper to look for __init__.py or __init__.py[co] in potential package.
2274 Return 1 if __init__ was found, 0 if not, or -1 on error. */
Guido van Rossum197346f1997-10-31 18:38:52 +00002275static int
Victor Stinner547a2a62011-03-20 03:07:28 +01002276find_init_module(PyObject *directory)
Guido van Rossum197346f1997-10-31 18:38:52 +00002277{
Victor Stinner547a2a62011-03-20 03:07:28 +01002278 size_t len;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002279 struct stat statbuf;
Victor Stinner547a2a62011-03-20 03:07:28 +01002280 PyObject *filename;
2281 int match;
Guido van Rossum197346f1997-10-31 18:38:52 +00002282
Victor Stinner547a2a62011-03-20 03:07:28 +01002283 len = PyUnicode_GET_SIZE(directory);
2284 filename = PyUnicode_FromFormat("%U%c__init__.py", directory, SEP);
2285 if (filename == NULL)
2286 return -1;
2287 if (_Py_stat(filename, &statbuf) == 0) {
Victor Stinnercc9564e2011-03-20 04:58:29 +01002288 /* 3=len(".py") */
2289 match = case_ok(filename, -3, initstr);
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002290 if (match < 0) {
2291 Py_DECREF(filename);
2292 return -1;
2293 }
2294 if (match) {
Victor Stinner547a2a62011-03-20 03:07:28 +01002295 Py_DECREF(filename);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002296 return 1;
2297 }
2298 }
Victor Stinner547a2a62011-03-20 03:07:28 +01002299 Py_DECREF(filename);
2300
2301 filename = PyUnicode_FromFormat("%U%c__init__.py%c",
2302 directory, SEP, Py_OptimizeFlag ? 'o' : 'c');
2303 if (filename == NULL)
2304 return -1;
2305 if (_Py_stat(filename, &statbuf) == 0) {
Victor Stinnercc9564e2011-03-20 04:58:29 +01002306 /* 4=len(".pyc") */
2307 match = case_ok(filename, -4, initstr);
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002308 if (match < 0) {
2309 Py_DECREF(filename);
2310 return -1;
2311 }
2312 if (match) {
Victor Stinner547a2a62011-03-20 03:07:28 +01002313 Py_DECREF(filename);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002314 return 1;
2315 }
2316 }
Victor Stinner547a2a62011-03-20 03:07:28 +01002317 Py_DECREF(filename);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002318 return 0;
Guido van Rossum197346f1997-10-31 18:38:52 +00002319}
Guido van Rossum48a680c2001-03-02 06:34:14 +00002320
Guido van Rossum197346f1997-10-31 18:38:52 +00002321#endif /* HAVE_STAT */
2322
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002323
Victor Stinner95872862011-03-07 18:20:56 +01002324static int init_builtin(PyObject *); /* Forward */
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002325
Victor Stinner44c6c152010-08-09 00:59:10 +00002326static PyObject*
Victor Stinner95872862011-03-07 18:20:56 +01002327load_builtin(PyObject *name, int type)
Victor Stinner44c6c152010-08-09 00:59:10 +00002328{
2329 PyObject *m, *modules;
2330 int err;
2331
Victor Stinner44c6c152010-08-09 00:59:10 +00002332 if (type == C_BUILTIN)
2333 err = init_builtin(name);
2334 else
Victor Stinner95872862011-03-07 18:20:56 +01002335 err = PyImport_ImportFrozenModuleObject(name);
Victor Stinner44c6c152010-08-09 00:59:10 +00002336 if (err < 0)
2337 return NULL;
2338 if (err == 0) {
2339 PyErr_Format(PyExc_ImportError,
Victor Stinner95872862011-03-07 18:20:56 +01002340 "Purported %s module %R not found",
2341 type == C_BUILTIN ? "builtin" : "frozen",
Victor Stinner44c6c152010-08-09 00:59:10 +00002342 name);
2343 return NULL;
2344 }
2345
2346 modules = PyImport_GetModuleDict();
Victor Stinner95872862011-03-07 18:20:56 +01002347 m = PyDict_GetItem(modules, name);
Victor Stinner44c6c152010-08-09 00:59:10 +00002348 if (m == NULL) {
2349 PyErr_Format(
2350 PyExc_ImportError,
Victor Stinner95872862011-03-07 18:20:56 +01002351 "%s module %R not properly initialized",
2352 type == C_BUILTIN ? "builtin" : "frozen",
Victor Stinner44c6c152010-08-09 00:59:10 +00002353 name);
2354 return NULL;
2355 }
2356 Py_INCREF(m);
2357 return m;
2358}
2359
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002360/* Load an external module using the default search path and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00002361 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002362
Guido van Rossum79f25d91997-04-29 20:08:16 +00002363static PyObject *
Victor Stinner41c5fec2011-03-13 21:46:30 -04002364load_module(PyObject *name, FILE *fp, PyObject *pathname, int type, PyObject *loader)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002365{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002366 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002367
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002368 /* First check that there's an open file (if we need one) */
2369 switch (type) {
2370 case PY_SOURCE:
2371 case PY_COMPILED:
2372 if (fp == NULL) {
2373 PyErr_Format(PyExc_ValueError,
Victor Stinner41c5fec2011-03-13 21:46:30 -04002374 "file object required for import (type code %d)",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002375 type);
2376 return NULL;
2377 }
2378 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002379
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002380 switch (type) {
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002381
Victor Stinner41c5fec2011-03-13 21:46:30 -04002382 case PY_SOURCE:
2383 m = load_source_module(name, pathname, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002384 break;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002385
Victor Stinner41c5fec2011-03-13 21:46:30 -04002386 case PY_COMPILED:
2387 m = load_compiled_module(name, pathname, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002388 break;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002389
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002390#ifdef HAVE_DYNAMIC_LOADING
Victor Stinner41c5fec2011-03-13 21:46:30 -04002391 case C_EXTENSION:
2392 m = _PyImport_LoadDynamicModule(name, pathname, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002393 break;
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002394#endif
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002395
Victor Stinner41c5fec2011-03-13 21:46:30 -04002396 case PKG_DIRECTORY:
2397 m = load_package(name, pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002398 break;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002399
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002400 case C_BUILTIN:
Victor Stinner41c5fec2011-03-13 21:46:30 -04002401 case PY_FROZEN:
2402 m = load_builtin(name, type);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002403 break;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002404
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002405 case IMP_HOOK: {
2406 if (loader == NULL) {
2407 PyErr_SetString(PyExc_ImportError,
2408 "import hook without loader");
2409 return NULL;
2410 }
Victor Stinner41c5fec2011-03-13 21:46:30 -04002411 m = PyObject_CallMethod(loader, "load_module", "O", name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002412 break;
2413 }
Just van Rossum52e14d62002-12-30 22:08:05 +00002414
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002415 default:
2416 PyErr_Format(PyExc_ImportError,
Victor Stinner98dbba52011-03-14 15:15:47 -04002417 "Don't know how to import %R (type code %d)",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002418 name, type);
2419 m = NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002420
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002421 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002422
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002423 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002424}
2425
2426
2427/* Initialize a built-in module.
Thomas Wouters89f507f2006-12-13 04:49:30 +00002428 Return 1 for success, 0 if the module is not found, and -1 with
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002429 an exception set if the initialization failed. */
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002430
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002431static int
Victor Stinner95872862011-03-07 18:20:56 +01002432init_builtin(PyObject *name)
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002433{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002434 struct _inittab *p;
Guido van Rossum25ce5661997-08-02 03:10:38 +00002435
Victor Stinner95872862011-03-07 18:20:56 +01002436 if (_PyImport_FindExtensionObject(name, name) != NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002437 return 1;
Guido van Rossum25ce5661997-08-02 03:10:38 +00002438
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002439 for (p = PyImport_Inittab; p->name != NULL; p++) {
2440 PyObject *mod;
Victor Stinner95872862011-03-07 18:20:56 +01002441 if (PyUnicode_CompareWithASCIIString(name, p->name) == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002442 if (p->initfunc == NULL) {
2443 PyErr_Format(PyExc_ImportError,
Victor Stinner95872862011-03-07 18:20:56 +01002444 "Cannot re-init internal module %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002445 name);
2446 return -1;
2447 }
2448 if (Py_VerboseFlag)
Victor Stinner95872862011-03-07 18:20:56 +01002449 PySys_FormatStderr("import %U # builtin\n", name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002450 mod = (*p->initfunc)();
2451 if (mod == 0)
2452 return -1;
Victor Stinner95872862011-03-07 18:20:56 +01002453 if (_PyImport_FixupExtensionObject(mod, name, name) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002454 return -1;
2455 /* FixupExtension has put the module into sys.modules,
2456 so we can release our own reference. */
2457 Py_DECREF(mod);
2458 return 1;
2459 }
2460 }
2461 return 0;
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002462}
Guido van Rossumf56e3db1993-04-01 20:59:32 +00002463
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002464
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002465/* Frozen modules */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002466
Guido van Rossumcfd0a221996-06-17 17:06:34 +00002467static struct _frozen *
Victor Stinner53dc7352011-03-20 01:50:21 +01002468find_frozen(PyObject *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002469{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002470 struct _frozen *p;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002471
Victor Stinner53dc7352011-03-20 01:50:21 +01002472 if (name == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002473 return NULL;
Benjamin Petersond968e272008-11-05 22:48:33 +00002474
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002475 for (p = PyImport_FrozenModules; ; p++) {
2476 if (p->name == NULL)
2477 return NULL;
Victor Stinner53dc7352011-03-20 01:50:21 +01002478 if (PyUnicode_CompareWithASCIIString(name, p->name) == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002479 break;
2480 }
2481 return p;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002482}
2483
Guido van Rossum79f25d91997-04-29 20:08:16 +00002484static PyObject *
Victor Stinner53dc7352011-03-20 01:50:21 +01002485get_frozen_object(PyObject *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002486{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002487 struct _frozen *p = find_frozen(name);
2488 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002489
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002490 if (p == NULL) {
2491 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002492 "No such frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002493 name);
2494 return NULL;
2495 }
2496 if (p->code == NULL) {
2497 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002498 "Excluded frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002499 name);
2500 return NULL;
2501 }
2502 size = p->size;
2503 if (size < 0)
2504 size = -size;
2505 return PyMarshal_ReadObjectFromString((char *)p->code, size);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002506}
2507
Brett Cannon8d110132009-03-15 02:20:16 +00002508static PyObject *
Victor Stinner53dc7352011-03-20 01:50:21 +01002509is_frozen_package(PyObject *name)
Brett Cannon8d110132009-03-15 02:20:16 +00002510{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002511 struct _frozen *p = find_frozen(name);
2512 int size;
Brett Cannon8d110132009-03-15 02:20:16 +00002513
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002514 if (p == NULL) {
2515 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002516 "No such frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002517 name);
2518 return NULL;
2519 }
Brett Cannon8d110132009-03-15 02:20:16 +00002520
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002521 size = p->size;
Brett Cannon8d110132009-03-15 02:20:16 +00002522
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002523 if (size < 0)
2524 Py_RETURN_TRUE;
2525 else
2526 Py_RETURN_FALSE;
Brett Cannon8d110132009-03-15 02:20:16 +00002527}
2528
2529
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002530/* Initialize a frozen module.
Brett Cannon3c2ac442009-03-08 20:49:47 +00002531 Return 1 for success, 0 if the module is not found, and -1 with
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002532 an exception set if the initialization failed.
2533 This function is also used from frozenmain.c */
Guido van Rossum0b344901995-02-07 15:35:27 +00002534
2535int
Victor Stinner53dc7352011-03-20 01:50:21 +01002536PyImport_ImportFrozenModuleObject(PyObject *name)
Guido van Rossumf56e3db1993-04-01 20:59:32 +00002537{
Victor Stinner53dc7352011-03-20 01:50:21 +01002538 struct _frozen *p;
2539 PyObject *co, *m, *path;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002540 int ispackage;
2541 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002542
Victor Stinner53dc7352011-03-20 01:50:21 +01002543 p = find_frozen(name);
2544
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002545 if (p == NULL)
2546 return 0;
2547 if (p->code == NULL) {
2548 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002549 "Excluded frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002550 name);
2551 return -1;
2552 }
2553 size = p->size;
2554 ispackage = (size < 0);
2555 if (ispackage)
2556 size = -size;
2557 if (Py_VerboseFlag)
Victor Stinner53dc7352011-03-20 01:50:21 +01002558 PySys_FormatStderr("import %U # frozen%s\n",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002559 name, ispackage ? " package" : "");
2560 co = PyMarshal_ReadObjectFromString((char *)p->code, size);
2561 if (co == NULL)
2562 return -1;
2563 if (!PyCode_Check(co)) {
2564 PyErr_Format(PyExc_TypeError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002565 "frozen object %R is not a code object",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002566 name);
2567 goto err_return;
2568 }
2569 if (ispackage) {
2570 /* Set __path__ to the package name */
Victor Stinner53dc7352011-03-20 01:50:21 +01002571 PyObject *d, *l;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002572 int err;
Victor Stinner53dc7352011-03-20 01:50:21 +01002573 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002574 if (m == NULL)
2575 goto err_return;
2576 d = PyModule_GetDict(m);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002577 l = PyList_New(1);
2578 if (l == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002579 goto err_return;
2580 }
Victor Stinner53dc7352011-03-20 01:50:21 +01002581 Py_INCREF(name);
2582 PyList_SET_ITEM(l, 0, name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002583 err = PyDict_SetItemString(d, "__path__", l);
2584 Py_DECREF(l);
2585 if (err != 0)
2586 goto err_return;
2587 }
Victor Stinner53dc7352011-03-20 01:50:21 +01002588 path = PyUnicode_FromString("<frozen>");
2589 if (path == NULL)
2590 goto err_return;
2591 m = PyImport_ExecCodeModuleObject(name, co, path, NULL);
2592 Py_DECREF(path);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002593 if (m == NULL)
2594 goto err_return;
2595 Py_DECREF(co);
2596 Py_DECREF(m);
2597 return 1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002598err_return:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002599 Py_DECREF(co);
2600 return -1;
Guido van Rossumf56e3db1993-04-01 20:59:32 +00002601}
Guido van Rossum74e6a111994-08-29 12:54:38 +00002602
Victor Stinner53dc7352011-03-20 01:50:21 +01002603int
2604PyImport_ImportFrozenModule(char *name)
2605{
2606 PyObject *nameobj;
2607 int ret;
2608 nameobj = PyUnicode_InternFromString(name);
2609 if (nameobj == NULL)
2610 return -1;
2611 ret = PyImport_ImportFrozenModuleObject(nameobj);
2612 Py_DECREF(nameobj);
2613 return ret;
2614}
2615
Guido van Rossum74e6a111994-08-29 12:54:38 +00002616
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002617/* Import a module, either built-in, frozen, or external, and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00002618 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum74e6a111994-08-29 12:54:38 +00002619
Guido van Rossum79f25d91997-04-29 20:08:16 +00002620PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00002621PyImport_ImportModule(const char *name)
Guido van Rossum74e6a111994-08-29 12:54:38 +00002622{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002623 PyObject *pname;
2624 PyObject *result;
Marc-André Lemburg3c61c352001-02-09 19:40:15 +00002625
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002626 pname = PyUnicode_FromString(name);
2627 if (pname == NULL)
2628 return NULL;
2629 result = PyImport_Import(pname);
2630 Py_DECREF(pname);
2631 return result;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002632}
2633
Christian Heimes072c0f12008-01-03 23:01:04 +00002634/* Import a module without blocking
2635 *
2636 * At first it tries to fetch the module from sys.modules. If the module was
2637 * never loaded before it loads it with PyImport_ImportModule() unless another
2638 * thread holds the import lock. In the latter case the function raises an
2639 * ImportError instead of blocking.
2640 *
2641 * Returns the module object with incremented ref count.
2642 */
2643PyObject *
2644PyImport_ImportModuleNoBlock(const char *name)
2645{
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002646 PyObject *nameobj, *modules, *result;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002647 long me;
Christian Heimes072c0f12008-01-03 23:01:04 +00002648
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002649 /* Try to get the module from sys.modules[name] */
2650 modules = PyImport_GetModuleDict();
2651 if (modules == NULL)
2652 return NULL;
Christian Heimes072c0f12008-01-03 23:01:04 +00002653
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002654 nameobj = PyUnicode_FromString(name);
2655 if (nameobj == NULL)
2656 return NULL;
2657 result = PyDict_GetItem(modules, nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002658 if (result != NULL) {
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002659 Py_DECREF(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002660 Py_INCREF(result);
2661 return result;
2662 }
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002663 PyErr_Clear();
Benjamin Peterson3e4f0552008-09-02 00:31:15 +00002664#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002665 /* check the import lock
2666 * me might be -1 but I ignore the error here, the lock function
2667 * takes care of the problem */
2668 me = PyThread_get_thread_ident();
2669 if (import_lock_thread == -1 || import_lock_thread == me) {
2670 /* no thread or me is holding the lock */
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002671 result = PyImport_Import(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002672 }
2673 else {
2674 PyErr_Format(PyExc_ImportError,
Victor Stinnerc24c8102011-03-13 22:38:06 -04002675 "Failed to import %R because the import lock"
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002676 "is held by another thread.",
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002677 nameobj);
2678 result = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002679 }
Benjamin Peterson3e4f0552008-09-02 00:31:15 +00002680#else
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002681 result = PyImport_Import(nameobj);
Benjamin Peterson3e4f0552008-09-02 00:31:15 +00002682#endif
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002683 Py_DECREF(nameobj);
2684 return result;
Christian Heimes072c0f12008-01-03 23:01:04 +00002685}
2686
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002687/* Forward declarations for helper routines */
Victor Stinner974389d2011-03-15 09:33:57 +01002688static PyObject *get_parent(PyObject *globals,
2689 PyObject **p_name,
2690 int level);
Tim Petersdbd9ba62000-07-09 03:09:57 +00002691static PyObject *load_next(PyObject *mod, PyObject *altmod,
Victor Stinner974389d2011-03-15 09:33:57 +01002692 PyObject *inputname, PyObject **p_outputname,
2693 Py_UNICODE *buf, Py_ssize_t *p_buflen,
2694 Py_ssize_t bufsize);
2695static int mark_miss(PyObject *name);
Tim Petersdbd9ba62000-07-09 03:09:57 +00002696static int ensure_fromlist(PyObject *mod, PyObject *fromlist,
Victor Stinner974389d2011-03-15 09:33:57 +01002697 PyObject *buf, int recursive);
2698static PyObject * import_submodule(PyObject *mod, PyObject *name,
2699 PyObject *fullname);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002700
2701/* The Magnum Opus of dotted-name import :-) */
2702
Guido van Rossum75acc9c1998-03-03 22:26:50 +00002703static PyObject *
Victor Stinner974389d2011-03-15 09:33:57 +01002704import_module_level(PyObject *name, PyObject *globals, PyObject *locals,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002705 PyObject *fromlist, int level)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002706{
Victor Stinner974389d2011-03-15 09:33:57 +01002707 Py_UNICODE buf[MAXPATHLEN+1];
2708 Py_ssize_t buflen;
2709 Py_ssize_t bufsize = MAXPATHLEN+1;
2710 PyObject *parent, *head, *next, *tail, *inputname, *outputname;
2711 PyObject *parent_name, *ensure_name;
2712 const Py_UNICODE *nameunicode;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002713
Victor Stinner974389d2011-03-15 09:33:57 +01002714 nameunicode = PyUnicode_AS_UNICODE(name);
2715
2716 if (Py_UNICODE_strchr(nameunicode, SEP) != NULL
2717#ifdef ALTSEP
2718 || Py_UNICODE_strchr(nameunicode, ALTSEP) != NULL
Christian Heimes454f37b2008-01-10 00:10:02 +00002719#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002720 ) {
2721 PyErr_SetString(PyExc_ImportError,
2722 "Import by filename is not supported.");
2723 return NULL;
2724 }
Christian Heimes454f37b2008-01-10 00:10:02 +00002725
Victor Stinner974389d2011-03-15 09:33:57 +01002726 parent = get_parent(globals, &parent_name, level);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002727 if (parent == NULL)
2728 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002729
Victor Stinner974389d2011-03-15 09:33:57 +01002730 buflen = PyUnicode_GET_SIZE(parent_name);
2731 if (buflen+1 > bufsize) {
2732 Py_DECREF(parent_name);
2733 PyErr_SetString(PyExc_ValueError,
2734 "Module name too long");
2735 return NULL;
2736 }
2737 Py_UNICODE_strcpy(buf, PyUnicode_AS_UNICODE(parent_name));
2738 Py_DECREF(parent_name);
2739
2740 head = load_next(parent, level < 0 ? Py_None : parent, name, &outputname,
2741 buf, &buflen, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002742 if (head == NULL)
2743 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002744
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002745 tail = head;
2746 Py_INCREF(tail);
Victor Stinner974389d2011-03-15 09:33:57 +01002747
2748 if (outputname != NULL) {
2749 while (1) {
2750 inputname = outputname;
2751 next = load_next(tail, tail, inputname, &outputname,
2752 buf, &buflen, bufsize);
2753 Py_DECREF(tail);
2754 Py_DECREF(inputname);
2755 if (next == NULL) {
2756 Py_DECREF(head);
2757 return NULL;
2758 }
2759 tail = next;
2760
2761 if (outputname == NULL) {
2762 break;
2763 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002764 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002765 }
2766 if (tail == Py_None) {
2767 /* If tail is Py_None, both get_parent and load_next found
2768 an empty module name: someone called __import__("") or
2769 doctored faulty bytecode */
2770 Py_DECREF(tail);
2771 Py_DECREF(head);
Victor Stinner974389d2011-03-15 09:33:57 +01002772 PyErr_SetString(PyExc_ValueError, "Empty module name");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002773 return NULL;
2774 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002775
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002776 if (fromlist != NULL) {
2777 if (fromlist == Py_None || !PyObject_IsTrue(fromlist))
2778 fromlist = NULL;
2779 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002780
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002781 if (fromlist == NULL) {
2782 Py_DECREF(tail);
2783 return head;
2784 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002785
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002786 Py_DECREF(head);
Victor Stinner974389d2011-03-15 09:33:57 +01002787
2788 ensure_name = PyUnicode_FromUnicode(buf, Py_UNICODE_strlen(buf));
2789 if (ensure_name == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002790 Py_DECREF(tail);
2791 return NULL;
2792 }
Victor Stinner974389d2011-03-15 09:33:57 +01002793 if (!ensure_fromlist(tail, fromlist, ensure_name, 0)) {
2794 Py_DECREF(tail);
2795 Py_DECREF(ensure_name);
2796 return NULL;
2797 }
2798 Py_DECREF(ensure_name);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002799
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002800 return tail;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002801}
2802
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002803PyObject *
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002804PyImport_ImportModuleLevelObject(PyObject *name, PyObject *globals,
2805 PyObject *locals, PyObject *fromlist,
2806 int level)
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002807{
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002808 PyObject *mod;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002809 _PyImport_AcquireLock();
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002810 mod = import_module_level(name, globals, locals, fromlist, level);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002811 if (_PyImport_ReleaseLock() < 0) {
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002812 Py_XDECREF(mod);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002813 PyErr_SetString(PyExc_RuntimeError,
2814 "not holding the import lock");
2815 return NULL;
2816 }
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002817 return mod;
Guido van Rossum75acc9c1998-03-03 22:26:50 +00002818}
2819
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002820PyObject *
2821PyImport_ImportModuleLevel(char *name, PyObject *globals, PyObject *locals,
2822 PyObject *fromlist, int level)
2823{
2824 PyObject *nameobj, *mod;
2825 nameobj = PyUnicode_FromString(name);
2826 if (nameobj == NULL)
2827 return NULL;
2828 mod = PyImport_ImportModuleLevelObject(nameobj, globals, locals,
2829 fromlist, level);
2830 Py_DECREF(nameobj);
2831 return mod;
2832}
2833
2834
Fred Drake87590902004-05-28 20:21:36 +00002835/* Return the package that an import is being performed in. If globals comes
2836 from the module foo.bar.bat (not itself a package), this returns the
2837 sys.modules entry for foo.bar. If globals is from a package's __init__.py,
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00002838 the package's entry in sys.modules is returned, as a borrowed reference.
Fred Drake87590902004-05-28 20:21:36 +00002839
Victor Stinner974389d2011-03-15 09:33:57 +01002840 The name of the returned package is returned in *p_name.
Fred Drake87590902004-05-28 20:21:36 +00002841
2842 If globals doesn't come from a package or a module in a package, or a
2843 corresponding entry is not found in sys.modules, Py_None is returned.
2844*/
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002845static PyObject *
Victor Stinner9599de52011-03-13 22:38:38 -04002846get_parent(PyObject *globals, PyObject **p_name, int level)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002847{
Victor Stinner974389d2011-03-15 09:33:57 +01002848 Py_UNICODE name[MAXPATHLEN+1];
2849 const Py_ssize_t bufsize = MAXPATHLEN+1;
2850 PyObject *nameobj;
2851
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002852 static PyObject *namestr = NULL;
2853 static PyObject *pathstr = NULL;
2854 static PyObject *pkgstr = NULL;
2855 PyObject *pkgname, *modname, *modpath, *modules, *parent;
2856 int orig_level = level;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002857
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002858 if (globals == NULL || !PyDict_Check(globals) || !level)
Victor Stinner974389d2011-03-15 09:33:57 +01002859 goto return_none;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002860
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002861 if (namestr == NULL) {
2862 namestr = PyUnicode_InternFromString("__name__");
2863 if (namestr == NULL)
2864 return NULL;
2865 }
2866 if (pathstr == NULL) {
2867 pathstr = PyUnicode_InternFromString("__path__");
2868 if (pathstr == NULL)
2869 return NULL;
2870 }
2871 if (pkgstr == NULL) {
2872 pkgstr = PyUnicode_InternFromString("__package__");
2873 if (pkgstr == NULL)
2874 return NULL;
2875 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002876
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002877 pkgname = PyDict_GetItem(globals, pkgstr);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002878
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002879 if ((pkgname != NULL) && (pkgname != Py_None)) {
2880 /* __package__ is set, so use it */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002881 if (!PyUnicode_Check(pkgname)) {
2882 PyErr_SetString(PyExc_ValueError,
2883 "__package__ set to non-string");
2884 return NULL;
2885 }
Victor Stinner974389d2011-03-15 09:33:57 +01002886 if (PyUnicode_GET_SIZE(pkgname) == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002887 if (level > 0) {
2888 PyErr_SetString(PyExc_ValueError,
2889 "Attempted relative import in non-package");
2890 return NULL;
2891 }
Victor Stinner974389d2011-03-15 09:33:57 +01002892 goto return_none;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002893 }
Victor Stinner974389d2011-03-15 09:33:57 +01002894 if (PyUnicode_GET_SIZE(pkgname)+1 > bufsize) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002895 PyErr_SetString(PyExc_ValueError,
2896 "Package name too long");
2897 return NULL;
2898 }
Victor Stinner974389d2011-03-15 09:33:57 +01002899 Py_UNICODE_strcpy(name, PyUnicode_AS_UNICODE(pkgname));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002900 } else {
2901 /* __package__ not set, so figure it out and set it */
2902 modname = PyDict_GetItem(globals, namestr);
2903 if (modname == NULL || !PyUnicode_Check(modname))
Victor Stinner974389d2011-03-15 09:33:57 +01002904 goto return_none;
Brett Cannon9a5b25a2010-03-01 02:09:17 +00002905
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002906 modpath = PyDict_GetItem(globals, pathstr);
2907 if (modpath != NULL) {
2908 /* __path__ is set, so modname is already the package name */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002909 int error;
Alexandre Vassalottia85998a2008-05-03 18:24:43 +00002910
Victor Stinner974389d2011-03-15 09:33:57 +01002911 if (PyUnicode_GET_SIZE(modname)+1 > bufsize) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002912 PyErr_SetString(PyExc_ValueError,
2913 "Module name too long");
2914 return NULL;
2915 }
Victor Stinner974389d2011-03-15 09:33:57 +01002916 Py_UNICODE_strcpy(name, PyUnicode_AS_UNICODE(modname));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002917 error = PyDict_SetItem(globals, pkgstr, modname);
2918 if (error) {
2919 PyErr_SetString(PyExc_ValueError,
2920 "Could not set __package__");
2921 return NULL;
2922 }
2923 } else {
2924 /* Normal module, so work out the package name if any */
Victor Stinner974389d2011-03-15 09:33:57 +01002925 Py_UNICODE *start = PyUnicode_AS_UNICODE(modname);
2926 Py_UNICODE *lastdot = Py_UNICODE_strrchr(start, '.');
2927 Py_ssize_t len;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002928 int error;
2929 if (lastdot == NULL && level > 0) {
2930 PyErr_SetString(PyExc_ValueError,
2931 "Attempted relative import in non-package");
2932 return NULL;
2933 }
2934 if (lastdot == NULL) {
2935 error = PyDict_SetItem(globals, pkgstr, Py_None);
2936 if (error) {
2937 PyErr_SetString(PyExc_ValueError,
2938 "Could not set __package__");
2939 return NULL;
2940 }
Victor Stinner974389d2011-03-15 09:33:57 +01002941 goto return_none;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002942 }
2943 len = lastdot - start;
Victor Stinner974389d2011-03-15 09:33:57 +01002944 if (len+1 > bufsize) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002945 PyErr_SetString(PyExc_ValueError,
2946 "Module name too long");
2947 return NULL;
2948 }
Victor Stinner974389d2011-03-15 09:33:57 +01002949 Py_UNICODE_strncpy(name, start, len);
2950 name[len] = '\0';
2951 pkgname = PyUnicode_FromUnicode(name, len);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002952 if (pkgname == NULL) {
2953 return NULL;
2954 }
2955 error = PyDict_SetItem(globals, pkgstr, pkgname);
2956 Py_DECREF(pkgname);
2957 if (error) {
2958 PyErr_SetString(PyExc_ValueError,
2959 "Could not set __package__");
2960 return NULL;
2961 }
2962 }
2963 }
2964 while (--level > 0) {
Victor Stinner974389d2011-03-15 09:33:57 +01002965 Py_UNICODE *dot = Py_UNICODE_strrchr(name, '.');
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002966 if (dot == NULL) {
2967 PyErr_SetString(PyExc_ValueError,
2968 "Attempted relative import beyond "
2969 "toplevel package");
2970 return NULL;
2971 }
2972 *dot = '\0';
2973 }
Victor Stinner974389d2011-03-15 09:33:57 +01002974
2975 nameobj = PyUnicode_FromUnicode(name, Py_UNICODE_strlen(name));
2976 if (nameobj == NULL)
2977 return NULL;
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002978
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002979 modules = PyImport_GetModuleDict();
Victor Stinner974389d2011-03-15 09:33:57 +01002980 parent = PyDict_GetItem(modules, nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002981 if (parent == NULL) {
Victor Stinner974389d2011-03-15 09:33:57 +01002982 int err;
2983
2984 if (orig_level >= 1) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002985 PyErr_Format(PyExc_SystemError,
Victor Stinner974389d2011-03-15 09:33:57 +01002986 "Parent module %R not loaded, "
2987 "cannot perform relative import", nameobj);
2988 Py_DECREF(nameobj);
2989 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002990 }
Victor Stinner974389d2011-03-15 09:33:57 +01002991
2992 err = PyErr_WarnFormat(
2993 PyExc_RuntimeWarning, 1,
2994 "Parent module %R not found while handling absolute import",
2995 nameobj);
2996 Py_DECREF(nameobj);
2997 if (err)
2998 return NULL;
2999
3000 goto return_none;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003001 }
Victor Stinner974389d2011-03-15 09:33:57 +01003002 *p_name = nameobj;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003003 return parent;
3004 /* We expect, but can't guarantee, if parent != None, that:
Victor Stinner974389d2011-03-15 09:33:57 +01003005 - parent.__name__ == name
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003006 - parent.__dict__ is globals
3007 If this is violated... Who cares? */
Victor Stinner974389d2011-03-15 09:33:57 +01003008
3009return_none:
3010 nameobj = PyUnicode_FromUnicode(NULL, 0);
3011 if (nameobj == NULL)
3012 return NULL;
3013 *p_name = nameobj;
3014 return Py_None;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003015}
3016
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003017/* altmod is either None or same as mod */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003018static PyObject *
Victor Stinner974389d2011-03-15 09:33:57 +01003019load_next(PyObject *mod, PyObject *altmod,
3020 PyObject *inputname, PyObject **p_outputname,
3021 Py_UNICODE *buf, Py_ssize_t *p_buflen, Py_ssize_t bufsize)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003022{
Victor Stinner974389d2011-03-15 09:33:57 +01003023 const Py_UNICODE *dot;
3024 Py_ssize_t len;
3025 Py_UNICODE *p;
3026 PyObject *fullname, *name, *result, *mark_name;
3027 const Py_UNICODE *nameuni;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003028
Victor Stinner974389d2011-03-15 09:33:57 +01003029 *p_outputname = NULL;
3030
3031 if (PyUnicode_GET_SIZE(inputname) == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003032 /* completely empty module name should only happen in
3033 'from . import' (or '__import__("")')*/
3034 Py_INCREF(mod);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003035 return mod;
3036 }
Thomas Woutersf7f438b2006-02-28 16:09:29 +00003037
Victor Stinner974389d2011-03-15 09:33:57 +01003038 nameuni = PyUnicode_AS_UNICODE(inputname);
3039 if (nameuni == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003040 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003041
Victor Stinner974389d2011-03-15 09:33:57 +01003042 dot = Py_UNICODE_strchr(nameuni, '.');
3043 if (dot != NULL) {
3044 len = dot - nameuni;
3045 if (len == 0) {
3046 PyErr_SetString(PyExc_ValueError,
3047 "Empty module name");
3048 return NULL;
3049 }
3050 }
3051 else
3052 len = PyUnicode_GET_SIZE(inputname);
3053
3054 if (*p_buflen+len+1 >= bufsize) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003055 PyErr_SetString(PyExc_ValueError,
3056 "Module name too long");
3057 return NULL;
3058 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003059
Victor Stinner974389d2011-03-15 09:33:57 +01003060 p = buf + *p_buflen;
3061 if (p != buf) {
3062 *p++ = '.';
3063 *p_buflen += 1;
3064 }
3065 Py_UNICODE_strncpy(p, nameuni, len);
3066 p[len] = '\0';
3067 *p_buflen += len;
3068
3069 fullname = PyUnicode_FromUnicode(buf, *p_buflen);
3070 if (fullname == NULL)
3071 return NULL;
3072 name = PyUnicode_FromUnicode(p, len);
3073 if (name == NULL) {
3074 Py_DECREF(fullname);
3075 return NULL;
3076 }
3077 result = import_submodule(mod, name, fullname);
3078 Py_DECREF(fullname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003079 if (result == Py_None && altmod != mod) {
3080 Py_DECREF(result);
3081 /* Here, altmod must be None and mod must not be None */
Victor Stinner974389d2011-03-15 09:33:57 +01003082 result = import_submodule(altmod, name, name);
3083 Py_DECREF(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003084 if (result != NULL && result != Py_None) {
Victor Stinner974389d2011-03-15 09:33:57 +01003085 mark_name = PyUnicode_FromUnicode(buf, *p_buflen);
3086 if (mark_name == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003087 Py_DECREF(result);
3088 return NULL;
3089 }
Victor Stinner974389d2011-03-15 09:33:57 +01003090 if (mark_miss(mark_name) != 0) {
3091 Py_DECREF(result);
3092 Py_DECREF(mark_name);
3093 return NULL;
3094 }
3095 Py_DECREF(mark_name);
3096 Py_UNICODE_strncpy(buf, nameuni, len);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003097 buf[len] = '\0';
3098 *p_buflen = len;
3099 }
3100 }
Victor Stinner974389d2011-03-15 09:33:57 +01003101 else
3102 Py_DECREF(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003103 if (result == NULL)
3104 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003105
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003106 if (result == Py_None) {
3107 Py_DECREF(result);
3108 PyErr_Format(PyExc_ImportError,
Victor Stinner974389d2011-03-15 09:33:57 +01003109 "No module named %R", inputname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003110 return NULL;
3111 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003112
Victor Stinner974389d2011-03-15 09:33:57 +01003113 if (dot != NULL) {
3114 *p_outputname = PyUnicode_FromUnicode(dot+1, Py_UNICODE_strlen(dot+1));
3115 if (*p_outputname == NULL) {
3116 Py_DECREF(result);
3117 return NULL;
3118 }
3119 }
3120
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003121 return result;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003122}
3123
3124static int
Victor Stinner974389d2011-03-15 09:33:57 +01003125mark_miss(PyObject *name)
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00003126{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003127 PyObject *modules = PyImport_GetModuleDict();
Victor Stinner974389d2011-03-15 09:33:57 +01003128 return PyDict_SetItem(modules, name, Py_None);
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00003129}
3130
3131static int
Victor Stinner974389d2011-03-15 09:33:57 +01003132ensure_fromlist(PyObject *mod, PyObject *fromlist, PyObject *name,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003133 int recursive)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003134{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003135 int i;
Victor Stinner974389d2011-03-15 09:33:57 +01003136 PyObject *fullname;
3137 Py_ssize_t fromlist_len;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003138
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003139 if (!PyObject_HasAttrString(mod, "__path__"))
3140 return 1;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003141
Victor Stinner974389d2011-03-15 09:33:57 +01003142 fromlist_len = PySequence_Size(fromlist);
3143
3144 for (i = 0; i < fromlist_len; i++) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003145 PyObject *item = PySequence_GetItem(fromlist, i);
3146 int hasit;
Victor Stinner974389d2011-03-15 09:33:57 +01003147 if (item == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003148 return 0;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003149 if (!PyUnicode_Check(item)) {
3150 PyErr_SetString(PyExc_TypeError,
3151 "Item in ``from list'' not a string");
3152 Py_DECREF(item);
3153 return 0;
3154 }
3155 if (PyUnicode_AS_UNICODE(item)[0] == '*') {
3156 PyObject *all;
3157 Py_DECREF(item);
3158 /* See if the package defines __all__ */
3159 if (recursive)
3160 continue; /* Avoid endless recursion */
3161 all = PyObject_GetAttrString(mod, "__all__");
3162 if (all == NULL)
3163 PyErr_Clear();
3164 else {
Victor Stinner974389d2011-03-15 09:33:57 +01003165 int ret = ensure_fromlist(mod, all, name, 1);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003166 Py_DECREF(all);
3167 if (!ret)
3168 return 0;
3169 }
3170 continue;
3171 }
3172 hasit = PyObject_HasAttr(mod, item);
3173 if (!hasit) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003174 PyObject *submod;
Victor Stinner974389d2011-03-15 09:33:57 +01003175 fullname = PyUnicode_FromFormat("%U.%U", name, item);
3176 if (fullname != NULL) {
3177 submod = import_submodule(mod, item, fullname);
3178 Py_DECREF(fullname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003179 }
Victor Stinner974389d2011-03-15 09:33:57 +01003180 else
3181 submod = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003182 Py_XDECREF(submod);
3183 if (submod == NULL) {
3184 Py_DECREF(item);
3185 return 0;
3186 }
3187 }
3188 Py_DECREF(item);
3189 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003190
Victor Stinner974389d2011-03-15 09:33:57 +01003191 return 1;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003192}
3193
Neil Schemenauer00b09662003-06-16 21:03:07 +00003194static int
Victor Stinner974389d2011-03-15 09:33:57 +01003195add_submodule(PyObject *mod, PyObject *submod, PyObject *fullname,
3196 PyObject *subname, PyObject *modules)
Neil Schemenauer00b09662003-06-16 21:03:07 +00003197{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003198 if (mod == Py_None)
3199 return 1;
3200 /* Irrespective of the success of this load, make a
3201 reference to it in the parent package module. A copy gets
3202 saved in the modules dictionary under the full name, so get a
3203 reference from there, if need be. (The exception is when the
3204 load failed with a SyntaxError -- then there's no trace in
3205 sys.modules. In that case, of course, do nothing extra.) */
3206 if (submod == NULL) {
Victor Stinner974389d2011-03-15 09:33:57 +01003207 submod = PyDict_GetItem(modules, fullname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003208 if (submod == NULL)
3209 return 1;
3210 }
3211 if (PyModule_Check(mod)) {
3212 /* We can't use setattr here since it can give a
3213 * spurious warning if the submodule name shadows a
3214 * builtin name */
3215 PyObject *dict = PyModule_GetDict(mod);
3216 if (!dict)
3217 return 0;
Victor Stinner974389d2011-03-15 09:33:57 +01003218 if (PyDict_SetItem(dict, subname, submod) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003219 return 0;
3220 }
3221 else {
Victor Stinner974389d2011-03-15 09:33:57 +01003222 if (PyObject_SetAttr(mod, subname, submod) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003223 return 0;
3224 }
3225 return 1;
Neil Schemenauer00b09662003-06-16 21:03:07 +00003226}
3227
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003228static PyObject *
Victor Stinner974389d2011-03-15 09:33:57 +01003229import_submodule(PyObject *mod, PyObject *subname, PyObject *fullname)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003230{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003231 PyObject *modules = PyImport_GetModuleDict();
Victor Stinner533d7832011-03-14 13:22:54 -04003232 PyObject *m = NULL, *bufobj, *path_list, *loader;
Victor Stinner9599de52011-03-13 22:38:38 -04003233 struct filedescr *fdp;
3234 FILE *fp;
Guido van Rossum74e6a111994-08-29 12:54:38 +00003235
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003236 /* Require:
3237 if mod == None: subname == fullname
3238 else: mod.__name__ + "." + subname == fullname
3239 */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003240
Victor Stinner974389d2011-03-15 09:33:57 +01003241 if ((m = PyDict_GetItem(modules, fullname)) != NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003242 Py_INCREF(m);
Victor Stinner9599de52011-03-13 22:38:38 -04003243 return m;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003244 }
Victor Stinner9599de52011-03-13 22:38:38 -04003245
3246 if (mod == Py_None)
Victor Stinner533d7832011-03-14 13:22:54 -04003247 path_list = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003248 else {
Victor Stinner533d7832011-03-14 13:22:54 -04003249 path_list = PyObject_GetAttrString(mod, "__path__");
3250 if (path_list == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003251 PyErr_Clear();
3252 Py_INCREF(Py_None);
3253 return Py_None;
3254 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003255 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003256
Victor Stinner533d7832011-03-14 13:22:54 -04003257 fdp = find_module(fullname, subname, path_list,
Victor Stinner2fd76e42011-03-14 15:19:39 -04003258 &bufobj, &fp, &loader);
Victor Stinner533d7832011-03-14 13:22:54 -04003259 Py_XDECREF(path_list);
Victor Stinner9599de52011-03-13 22:38:38 -04003260 if (fdp == NULL) {
3261 if (!PyErr_ExceptionMatches(PyExc_ImportError))
3262 return NULL;
3263 PyErr_Clear();
3264 Py_INCREF(Py_None);
3265 return Py_None;
3266 }
Victor Stinner2fd76e42011-03-14 15:19:39 -04003267 m = load_module(fullname, fp, bufobj, fdp->type, loader);
3268 Py_XDECREF(bufobj);
Victor Stinner9599de52011-03-13 22:38:38 -04003269 Py_XDECREF(loader);
3270 if (fp)
3271 fclose(fp);
3272 if (m == NULL)
3273 return NULL;
3274 if (!add_submodule(mod, m, fullname, subname, modules)) {
3275 Py_XDECREF(m);
3276 return NULL;
3277 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003278 return m;
Guido van Rossum74e6a111994-08-29 12:54:38 +00003279}
3280
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003281
3282/* Re-import a module of any kind and return its module object, WITH
3283 INCREMENTED REFERENCE COUNT */
3284
Guido van Rossum79f25d91997-04-29 20:08:16 +00003285PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003286PyImport_ReloadModule(PyObject *m)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003287{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003288 PyInterpreterState *interp = PyThreadState_Get()->interp;
3289 PyObject *modules_reloading = interp->modules_reloading;
3290 PyObject *modules = PyImport_GetModuleDict();
Victor Stinner533d7832011-03-14 13:22:54 -04003291 PyObject *path_list = NULL, *loader = NULL, *existing_m = NULL;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003292 PyObject *nameobj, *bufobj, *subnameobj;
3293 Py_UNICODE *name, *subname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003294 struct filedescr *fdp;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003295 FILE *fp = NULL;
3296 PyObject *newm = NULL;
Brett Cannon9a5b25a2010-03-01 02:09:17 +00003297
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003298 if (modules_reloading == NULL) {
3299 Py_FatalError("PyImport_ReloadModule: "
3300 "no modules_reloading dictionary!");
3301 return NULL;
3302 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003303
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003304 if (m == NULL || !PyModule_Check(m)) {
3305 PyErr_SetString(PyExc_TypeError,
3306 "reload() argument must be module");
3307 return NULL;
3308 }
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003309 nameobj = PyModule_GetNameObject(m);
3310 if (nameobj == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003311 return NULL;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003312 if (m != PyDict_GetItem(modules, nameobj)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003313 PyErr_Format(PyExc_ImportError,
Victor Stinner98dbba52011-03-14 15:15:47 -04003314 "reload(): module %R not in sys.modules",
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003315 nameobj);
3316 Py_DECREF(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003317 return NULL;
3318 }
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003319 existing_m = PyDict_GetItem(modules_reloading, nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003320 if (existing_m != NULL) {
3321 /* Due to a recursive reload, this module is already
3322 being reloaded. */
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003323 Py_DECREF(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003324 Py_INCREF(existing_m);
3325 return existing_m;
3326 }
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003327 if (PyDict_SetItem(modules_reloading, nameobj, m) < 0) {
3328 Py_DECREF(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003329 return NULL;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003330 }
Guido van Rossumd8faa362007-04-27 19:54:29 +00003331
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003332 name = PyUnicode_AS_UNICODE(nameobj);
3333 subname = Py_UNICODE_strrchr(name, '.');
3334 if (subname == NULL) {
3335 Py_INCREF(nameobj);
3336 subnameobj = nameobj;
3337 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003338 else {
3339 PyObject *parentname, *parent;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003340 Py_ssize_t len;
3341 len = subname - name;
3342 parentname = PyUnicode_FromUnicode(name, len);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003343 if (parentname == NULL) {
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003344 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003345 }
3346 parent = PyDict_GetItem(modules, parentname);
3347 if (parent == NULL) {
3348 PyErr_Format(PyExc_ImportError,
Victor Stinner98dbba52011-03-14 15:15:47 -04003349 "reload(): parent %R not in sys.modules",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003350 parentname);
3351 Py_DECREF(parentname);
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003352 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003353 }
3354 Py_DECREF(parentname);
Victor Stinner533d7832011-03-14 13:22:54 -04003355 path_list = PyObject_GetAttrString(parent, "__path__");
3356 if (path_list == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003357 PyErr_Clear();
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003358 subname++;
3359 len = PyUnicode_GET_SIZE(nameobj) - (len + 1);
3360 subnameobj = PyUnicode_FromUnicode(subname, len);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003361 }
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003362 if (subnameobj == NULL)
3363 goto error;
Victor Stinner533d7832011-03-14 13:22:54 -04003364 fdp = find_module(nameobj, subnameobj, path_list,
Victor Stinner2fd76e42011-03-14 15:19:39 -04003365 &bufobj, &fp, &loader);
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003366 Py_DECREF(subnameobj);
Victor Stinner533d7832011-03-14 13:22:54 -04003367 Py_XDECREF(path_list);
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00003368
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003369 if (fdp == NULL) {
3370 Py_XDECREF(loader);
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003371 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003372 }
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00003373
Victor Stinner2fd76e42011-03-14 15:19:39 -04003374 newm = load_module(nameobj, fp, bufobj, fdp->type, loader);
3375 Py_XDECREF(bufobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003376 Py_XDECREF(loader);
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00003377
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003378 if (fp)
3379 fclose(fp);
3380 if (newm == NULL) {
3381 /* load_module probably removed name from modules because of
3382 * the error. Put back the original module object. We're
3383 * going to return NULL in this case regardless of whether
3384 * replacing name succeeds, so the return value is ignored.
3385 */
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003386 PyDict_SetItem(modules, nameobj, m);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003387 }
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003388
3389error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003390 imp_modules_reloading_clear();
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003391 Py_DECREF(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003392 return newm;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003393}
3394
3395
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003396/* Higher-level import emulator which emulates the "import" statement
3397 more accurately -- it invokes the __import__() function from the
3398 builtins of the current globals. This means that the import is
3399 done using whatever import hooks are installed in the current
Brett Cannonbc2eff32010-09-19 21:39:02 +00003400 environment.
Guido van Rossum6058eb41998-12-21 19:51:00 +00003401 A dummy list ["__doc__"] is passed as the 4th argument so that
Neal Norwitz80e7f272007-08-26 06:45:23 +00003402 e.g. PyImport_Import(PyUnicode_FromString("win32com.client.gencache"))
Guido van Rossum6058eb41998-12-21 19:51:00 +00003403 will return <module "gencache"> instead of <module "win32com">. */
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003404
3405PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003406PyImport_Import(PyObject *module_name)
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003407{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003408 static PyObject *silly_list = NULL;
3409 static PyObject *builtins_str = NULL;
3410 static PyObject *import_str = NULL;
3411 PyObject *globals = NULL;
3412 PyObject *import = NULL;
3413 PyObject *builtins = NULL;
Brett Cannonbc2eff32010-09-19 21:39:02 +00003414 PyObject *modules = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003415 PyObject *r = NULL;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003416
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003417 /* Initialize constant string objects */
3418 if (silly_list == NULL) {
3419 import_str = PyUnicode_InternFromString("__import__");
3420 if (import_str == NULL)
3421 return NULL;
3422 builtins_str = PyUnicode_InternFromString("__builtins__");
3423 if (builtins_str == NULL)
3424 return NULL;
Brett Cannonbc2eff32010-09-19 21:39:02 +00003425 silly_list = PyList_New(0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003426 if (silly_list == NULL)
3427 return NULL;
3428 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003429
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003430 /* Get the builtins from current globals */
3431 globals = PyEval_GetGlobals();
3432 if (globals != NULL) {
3433 Py_INCREF(globals);
3434 builtins = PyObject_GetItem(globals, builtins_str);
3435 if (builtins == NULL)
3436 goto err;
3437 }
3438 else {
3439 /* No globals -- use standard builtins, and fake globals */
3440 builtins = PyImport_ImportModuleLevel("builtins",
3441 NULL, NULL, NULL, 0);
3442 if (builtins == NULL)
3443 return NULL;
3444 globals = Py_BuildValue("{OO}", builtins_str, builtins);
3445 if (globals == NULL)
3446 goto err;
3447 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003448
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003449 /* Get the __import__ function from the builtins */
3450 if (PyDict_Check(builtins)) {
3451 import = PyObject_GetItem(builtins, import_str);
3452 if (import == NULL)
3453 PyErr_SetObject(PyExc_KeyError, import_str);
3454 }
3455 else
3456 import = PyObject_GetAttr(builtins, import_str);
3457 if (import == NULL)
3458 goto err;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003459
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003460 /* Call the __import__ function with the proper argument list
Brett Cannonbc2eff32010-09-19 21:39:02 +00003461 Always use absolute import here.
3462 Calling for side-effect of import. */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003463 r = PyObject_CallFunction(import, "OOOOi", module_name, globals,
3464 globals, silly_list, 0, NULL);
Brett Cannonbc2eff32010-09-19 21:39:02 +00003465 if (r == NULL)
3466 goto err;
3467 Py_DECREF(r);
3468
3469 modules = PyImport_GetModuleDict();
3470 r = PyDict_GetItem(modules, module_name);
3471 if (r != NULL)
3472 Py_INCREF(r);
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003473
3474 err:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003475 Py_XDECREF(globals);
3476 Py_XDECREF(builtins);
3477 Py_XDECREF(import);
Tim Peters50d8d372001-02-28 05:34:27 +00003478
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003479 return r;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003480}
3481
3482
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003483/* Module 'imp' provides Python access to the primitives used for
3484 importing modules.
3485*/
3486
Guido van Rossum79f25d91997-04-29 20:08:16 +00003487static PyObject *
Barry Warsaw28a691b2010-04-17 00:19:56 +00003488imp_make_magic(long magic)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003489{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003490 char buf[4];
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003491
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003492 buf[0] = (char) ((magic >> 0) & 0xff);
3493 buf[1] = (char) ((magic >> 8) & 0xff);
3494 buf[2] = (char) ((magic >> 16) & 0xff);
3495 buf[3] = (char) ((magic >> 24) & 0xff);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003496
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003497 return PyBytes_FromStringAndSize(buf, 4);
Victor Stinner3e2b7172010-11-09 09:32:19 +00003498}
Barry Warsaw28a691b2010-04-17 00:19:56 +00003499
3500static PyObject *
3501imp_get_magic(PyObject *self, PyObject *noargs)
3502{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003503 return imp_make_magic(pyc_magic);
Barry Warsaw28a691b2010-04-17 00:19:56 +00003504}
3505
3506static PyObject *
3507imp_get_tag(PyObject *self, PyObject *noargs)
3508{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003509 return PyUnicode_FromString(pyc_tag);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003510}
3511
Guido van Rossum79f25d91997-04-29 20:08:16 +00003512static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +00003513imp_get_suffixes(PyObject *self, PyObject *noargs)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003514{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003515 PyObject *list;
3516 struct filedescr *fdp;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003517
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003518 list = PyList_New(0);
3519 if (list == NULL)
3520 return NULL;
3521 for (fdp = _PyImport_Filetab; fdp->suffix != NULL; fdp++) {
3522 PyObject *item = Py_BuildValue("ssi",
3523 fdp->suffix, fdp->mode, fdp->type);
3524 if (item == NULL) {
3525 Py_DECREF(list);
3526 return NULL;
3527 }
3528 if (PyList_Append(list, item) < 0) {
3529 Py_DECREF(list);
3530 Py_DECREF(item);
3531 return NULL;
3532 }
3533 Py_DECREF(item);
3534 }
3535 return list;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003536}
3537
Guido van Rossum79f25d91997-04-29 20:08:16 +00003538static PyObject *
Victor Stinner533d7832011-03-14 13:22:54 -04003539call_find_module(PyObject *name, PyObject *path_list)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003540{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003541 extern int fclose(FILE *);
3542 PyObject *fob, *ret;
3543 PyObject *pathobj;
3544 struct filedescr *fdp;
Victor Stinner7d8b77c2011-03-12 08:45:02 -05003545 FILE *fp;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003546 int fd = -1;
3547 char *found_encoding = NULL;
3548 char *encoding = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003549
Victor Stinner533d7832011-03-14 13:22:54 -04003550 if (path_list == Py_None)
3551 path_list = NULL;
3552 fdp = find_module(NULL, name, path_list,
Victor Stinner2fd76e42011-03-14 15:19:39 -04003553 &pathobj, &fp, NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003554 if (fdp == NULL)
3555 return NULL;
3556 if (fp != NULL) {
3557 fd = fileno(fp);
3558 if (fd != -1)
3559 fd = dup(fd);
3560 fclose(fp);
3561 fp = NULL;
3562 }
3563 if (fd != -1) {
3564 if (strchr(fdp->mode, 'b') == NULL) {
Victor Stinnerfe7c5b52011-04-05 01:48:03 +02003565 /* PyTokenizer_FindEncodingFilename() returns PyMem_MALLOC'ed
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003566 memory. */
Victor Stinnerfe7c5b52011-04-05 01:48:03 +02003567 found_encoding = PyTokenizer_FindEncodingFilename(fd, pathobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003568 lseek(fd, 0, 0); /* Reset position */
Victor Stinner2fd76e42011-03-14 15:19:39 -04003569 if (found_encoding == NULL && PyErr_Occurred()) {
3570 Py_XDECREF(pathobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003571 return NULL;
Victor Stinner2fd76e42011-03-14 15:19:39 -04003572 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003573 encoding = (found_encoding != NULL) ? found_encoding :
3574 (char*)PyUnicode_GetDefaultEncoding();
3575 }
Victor Stinner2fd76e42011-03-14 15:19:39 -04003576 fob = PyFile_FromFd(fd, NULL, fdp->mode, -1,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003577 (char*)encoding, NULL, NULL, 1);
3578 if (fob == NULL) {
Victor Stinner2fd76e42011-03-14 15:19:39 -04003579 Py_XDECREF(pathobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003580 close(fd);
3581 PyMem_FREE(found_encoding);
3582 return NULL;
3583 }
3584 }
3585 else {
3586 fob = Py_None;
3587 Py_INCREF(fob);
3588 }
Victor Stinner2fd76e42011-03-14 15:19:39 -04003589 if (pathobj == NULL) {
3590 Py_INCREF(Py_None);
3591 pathobj = Py_None;
3592 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003593 ret = Py_BuildValue("NN(ssi)",
3594 fob, pathobj, fdp->suffix, fdp->mode, fdp->type);
3595 PyMem_FREE(found_encoding);
Brett Cannon3bb42d92007-10-20 03:43:15 +00003596
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003597 return ret;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003598}
3599
Guido van Rossum79f25d91997-04-29 20:08:16 +00003600static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003601imp_find_module(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003602{
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003603 PyObject *name, *path_list = NULL;
3604 if (!PyArg_ParseTuple(args, "U|O:find_module",
3605 &name, &path_list))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003606 return NULL;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003607 return call_find_module(name, path_list);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003608}
3609
3610static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003611imp_init_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003612{
Victor Stinner95872862011-03-07 18:20:56 +01003613 PyObject *name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003614 int ret;
3615 PyObject *m;
Victor Stinner95872862011-03-07 18:20:56 +01003616 if (!PyArg_ParseTuple(args, "U:init_builtin", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003617 return NULL;
3618 ret = init_builtin(name);
3619 if (ret < 0)
3620 return NULL;
3621 if (ret == 0) {
3622 Py_INCREF(Py_None);
3623 return Py_None;
3624 }
Victor Stinner95872862011-03-07 18:20:56 +01003625 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003626 Py_XINCREF(m);
3627 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003628}
3629
Guido van Rossum79f25d91997-04-29 20:08:16 +00003630static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003631imp_init_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003632{
Victor Stinner53dc7352011-03-20 01:50:21 +01003633 PyObject *name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003634 int ret;
3635 PyObject *m;
Victor Stinner53dc7352011-03-20 01:50:21 +01003636 if (!PyArg_ParseTuple(args, "U:init_frozen", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003637 return NULL;
Victor Stinner53dc7352011-03-20 01:50:21 +01003638 ret = PyImport_ImportFrozenModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003639 if (ret < 0)
3640 return NULL;
3641 if (ret == 0) {
3642 Py_INCREF(Py_None);
3643 return Py_None;
3644 }
Victor Stinner53dc7352011-03-20 01:50:21 +01003645 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003646 Py_XINCREF(m);
3647 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003648}
3649
Guido van Rossum79f25d91997-04-29 20:08:16 +00003650static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003651imp_get_frozen_object(PyObject *self, PyObject *args)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00003652{
Victor Stinner53dc7352011-03-20 01:50:21 +01003653 PyObject *name;
Jack Jansen95ffa231995-10-03 14:38:41 +00003654
Victor Stinner53dc7352011-03-20 01:50:21 +01003655 if (!PyArg_ParseTuple(args, "U:get_frozen_object", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003656 return NULL;
3657 return get_frozen_object(name);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00003658}
3659
Guido van Rossum79f25d91997-04-29 20:08:16 +00003660static PyObject *
Brett Cannon8d110132009-03-15 02:20:16 +00003661imp_is_frozen_package(PyObject *self, PyObject *args)
3662{
Victor Stinner53dc7352011-03-20 01:50:21 +01003663 PyObject *name;
Brett Cannon8d110132009-03-15 02:20:16 +00003664
Victor Stinner53dc7352011-03-20 01:50:21 +01003665 if (!PyArg_ParseTuple(args, "U:is_frozen_package", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003666 return NULL;
3667 return is_frozen_package(name);
Brett Cannon8d110132009-03-15 02:20:16 +00003668}
3669
3670static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003671imp_is_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003672{
Victor Stinner95872862011-03-07 18:20:56 +01003673 PyObject *name;
3674 if (!PyArg_ParseTuple(args, "U:is_builtin", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003675 return NULL;
3676 return PyLong_FromLong(is_builtin(name));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003677}
3678
Guido van Rossum79f25d91997-04-29 20:08:16 +00003679static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003680imp_is_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003681{
Victor Stinner53dc7352011-03-20 01:50:21 +01003682 PyObject *name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003683 struct _frozen *p;
Victor Stinner53dc7352011-03-20 01:50:21 +01003684 if (!PyArg_ParseTuple(args, "U:is_frozen", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003685 return NULL;
3686 p = find_frozen(name);
3687 return PyBool_FromLong((long) (p == NULL ? 0 : p->size));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003688}
3689
3690static FILE *
Victor Stinner2f42ae52011-03-20 00:41:24 +01003691get_file(PyObject *pathname, PyObject *fob, char *mode)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003692{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003693 FILE *fp;
3694 if (mode[0] == 'U')
3695 mode = "r" PY_STDIOTEXTMODE;
3696 if (fob == NULL) {
Victor Stinner2f42ae52011-03-20 00:41:24 +01003697 fp = _Py_fopen(pathname, mode);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003698 }
3699 else {
3700 int fd = PyObject_AsFileDescriptor(fob);
3701 if (fd == -1)
3702 return NULL;
3703 if (!_PyVerify_fd(fd))
3704 goto error;
3705 /* the FILE struct gets a new fd, so that it can be closed
3706 * independently of the file descriptor given
3707 */
3708 fd = dup(fd);
3709 if (fd == -1)
3710 goto error;
3711 fp = fdopen(fd, mode);
3712 }
3713 if (fp)
3714 return fp;
Kristján Valur Jónssone1b04452009-03-31 17:43:39 +00003715error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003716 PyErr_SetFromErrno(PyExc_IOError);
3717 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003718}
3719
Guido van Rossum79f25d91997-04-29 20:08:16 +00003720static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003721imp_load_compiled(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003722{
Victor Stinner2f42ae52011-03-20 00:41:24 +01003723 PyObject *name, *pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003724 PyObject *fob = NULL;
3725 PyObject *m;
3726 FILE *fp;
Victor Stinner2f42ae52011-03-20 00:41:24 +01003727 if (!PyArg_ParseTuple(args, "UO&|O:load_compiled",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003728 &name,
Victor Stinner2f42ae52011-03-20 00:41:24 +01003729 PyUnicode_FSDecoder, &pathname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003730 &fob))
3731 return NULL;
Victor Stinner2f42ae52011-03-20 00:41:24 +01003732 fp = get_file(pathname, fob, "rb");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003733 if (fp == NULL) {
Victor Stinnerebc00522010-12-03 17:06:43 +00003734 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003735 return NULL;
3736 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01003737 m = load_compiled_module(name, pathname, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003738 fclose(fp);
Victor Stinnerebc00522010-12-03 17:06:43 +00003739 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003740 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003741}
3742
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003743#ifdef HAVE_DYNAMIC_LOADING
3744
Guido van Rossum79f25d91997-04-29 20:08:16 +00003745static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003746imp_load_dynamic(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003747{
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003748 PyObject *name, *pathname, *fob = NULL, *mod;
3749 FILE *fp;
3750
3751 if (!PyArg_ParseTuple(args, "UO&|O:load_dynamic",
3752 &name, PyUnicode_FSDecoder, &pathname, &fob))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003753 return NULL;
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003754 if (fob != NULL) {
3755 fp = get_file(NULL, fob, "r");
Victor Stinnere9ddbf62011-03-22 10:46:35 +01003756 if (fp == NULL) {
3757 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003758 return NULL;
Victor Stinnere9ddbf62011-03-22 10:46:35 +01003759 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003760 }
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003761 else
3762 fp = NULL;
3763 mod = _PyImport_LoadDynamicModule(name, pathname, fp);
Victor Stinnere9ddbf62011-03-22 10:46:35 +01003764 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003765 if (fp)
3766 fclose(fp);
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003767 return mod;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003768}
3769
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003770#endif /* HAVE_DYNAMIC_LOADING */
3771
Guido van Rossum79f25d91997-04-29 20:08:16 +00003772static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003773imp_load_source(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003774{
Victor Stinner2f42ae52011-03-20 00:41:24 +01003775 PyObject *name, *pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003776 PyObject *fob = NULL;
3777 PyObject *m;
3778 FILE *fp;
Victor Stinner2f42ae52011-03-20 00:41:24 +01003779 if (!PyArg_ParseTuple(args, "UO&|O:load_source",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003780 &name,
Victor Stinner2f42ae52011-03-20 00:41:24 +01003781 PyUnicode_FSDecoder, &pathname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003782 &fob))
3783 return NULL;
Victor Stinner2f42ae52011-03-20 00:41:24 +01003784 fp = get_file(pathname, fob, "r");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003785 if (fp == NULL) {
Victor Stinnerebc00522010-12-03 17:06:43 +00003786 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003787 return NULL;
3788 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01003789 m = load_source_module(name, pathname, fp);
Victor Stinnerebc00522010-12-03 17:06:43 +00003790 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003791 fclose(fp);
3792 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003793}
3794
Guido van Rossum79f25d91997-04-29 20:08:16 +00003795static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003796imp_load_module(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003797{
Victor Stinner6ae1e7f2011-03-20 22:37:17 +01003798 PyObject *name, *fob, *pathname, *pathname_obj, *ret;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003799 char *suffix; /* Unused */
3800 char *mode;
3801 int type;
3802 FILE *fp;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003803
Victor Stinner6ae1e7f2011-03-20 22:37:17 +01003804 if (!PyArg_ParseTuple(args, "UOO(ssi):load_module",
3805 &name, &fob, &pathname_obj, &suffix, &mode, &type))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003806 return NULL;
Victor Stinner6ae1e7f2011-03-20 22:37:17 +01003807 if (pathname_obj != Py_None) {
3808 if (!PyUnicode_FSDecoder(pathname_obj, &pathname))
3809 return NULL;
3810 }
3811 else
3812 pathname = NULL;
3813
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003814 if (*mode) {
3815 /* Mode must start with 'r' or 'U' and must not contain '+'.
3816 Implicit in this test is the assumption that the mode
3817 may contain other modifiers like 'b' or 't'. */
Guido van Rossum5e2c5fa2002-05-30 17:33:07 +00003818
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003819 if (!(*mode == 'r' || *mode == 'U') || strchr(mode, '+')) {
3820 PyErr_Format(PyExc_ValueError,
3821 "invalid file open mode %.200s", mode);
Victor Stinner6ae1e7f2011-03-20 22:37:17 +01003822 Py_XDECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003823 return NULL;
3824 }
3825 }
3826 if (fob == Py_None)
3827 fp = NULL;
3828 else {
3829 fp = get_file(NULL, fob, mode);
3830 if (fp == NULL) {
Victor Stinner6ae1e7f2011-03-20 22:37:17 +01003831 Py_XDECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003832 return NULL;
3833 }
3834 }
Victor Stinner41c5fec2011-03-13 21:46:30 -04003835 ret = load_module(name, fp, pathname, type, NULL);
Victor Stinner6ae1e7f2011-03-20 22:37:17 +01003836 Py_XDECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003837 if (fp)
3838 fclose(fp);
3839 return ret;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003840}
3841
3842static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003843imp_load_package(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003844{
Victor Stinnerc9abda02011-03-14 13:33:46 -04003845 PyObject *name, *pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003846 PyObject * ret;
Victor Stinnerc9abda02011-03-14 13:33:46 -04003847 if (!PyArg_ParseTuple(args, "UO&:load_package",
3848 &name, PyUnicode_FSDecoder, &pathname))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003849 return NULL;
Victor Stinnerc9abda02011-03-14 13:33:46 -04003850 ret = load_package(name, pathname);
Victor Stinnerebc00522010-12-03 17:06:43 +00003851 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003852 return ret;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003853}
3854
3855static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003856imp_new_module(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003857{
Victor Stinnerfe19d212011-03-14 14:53:28 -04003858 PyObject *name;
3859 if (!PyArg_ParseTuple(args, "U:new_module", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003860 return NULL;
Victor Stinnerfe19d212011-03-14 14:53:28 -04003861 return PyModule_NewObject(name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003862}
3863
Christian Heimes13a7a212008-01-07 17:13:09 +00003864static PyObject *
3865imp_reload(PyObject *self, PyObject *v)
3866{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003867 return PyImport_ReloadModule(v);
Christian Heimes13a7a212008-01-07 17:13:09 +00003868}
3869
3870PyDoc_STRVAR(doc_reload,
3871"reload(module) -> module\n\
3872\n\
3873Reload the module. The module must have been successfully imported before.");
3874
Barry Warsaw28a691b2010-04-17 00:19:56 +00003875static PyObject *
3876imp_cache_from_source(PyObject *self, PyObject *args, PyObject *kws)
3877{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003878 static char *kwlist[] = {"path", "debug_override", NULL};
Barry Warsaw28a691b2010-04-17 00:19:56 +00003879
Victor Stinner2f42ae52011-03-20 00:41:24 +01003880 PyObject *pathname, *cpathname;
Benjamin Peterson294a9fc2010-10-16 03:12:39 +00003881 PyObject *debug_override = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003882 int debug = !Py_OptimizeFlag;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003883
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003884 if (!PyArg_ParseTupleAndKeywords(
Victor Stinner3ea23dd2010-10-15 20:34:32 +00003885 args, kws, "O&|O", kwlist,
Victor Stinner2f42ae52011-03-20 00:41:24 +01003886 PyUnicode_FSDecoder, &pathname, &debug_override))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003887 return NULL;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003888
Benjamin Peterson294a9fc2010-10-16 03:12:39 +00003889 if (debug_override != NULL &&
3890 (debug = PyObject_IsTrue(debug_override)) < 0) {
Victor Stinner2f42ae52011-03-20 00:41:24 +01003891 Py_DECREF(pathname);
Benjamin Peterson294a9fc2010-10-16 03:12:39 +00003892 return NULL;
3893 }
Barry Warsaw28a691b2010-04-17 00:19:56 +00003894
Victor Stinner3ea23dd2010-10-15 20:34:32 +00003895 cpathname = make_compiled_pathname(
Victor Stinner2f42ae52011-03-20 00:41:24 +01003896 PyUnicode_AS_UNICODE(pathname),
3897 debug);
3898 Py_DECREF(pathname);
Barry Warsaw28a691b2010-04-17 00:19:56 +00003899
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003900 if (cpathname == NULL) {
3901 PyErr_Format(PyExc_SystemError, "path buffer too short");
3902 return NULL;
3903 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01003904 return cpathname;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003905}
3906
3907PyDoc_STRVAR(doc_cache_from_source,
3908"Given the path to a .py file, return the path to its .pyc/.pyo file.\n\
3909\n\
3910The .py file does not need to exist; this simply returns the path to the\n\
3911.pyc/.pyo file calculated as if the .py file were imported. The extension\n\
3912will be .pyc unless __debug__ is not defined, then it will be .pyo.\n\
3913\n\
3914If debug_override is not None, then it must be a boolean and is taken as\n\
3915the value of __debug__ instead.");
3916
3917static PyObject *
3918imp_source_from_cache(PyObject *self, PyObject *args, PyObject *kws)
3919{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003920 static char *kwlist[] = {"path", NULL};
Victor Stinnerc9abda02011-03-14 13:33:46 -04003921 PyObject *pathname, *source;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003922
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003923 if (!PyArg_ParseTupleAndKeywords(
Victor Stinnerebc00522010-12-03 17:06:43 +00003924 args, kws, "O&", kwlist,
Victor Stinnerc9abda02011-03-14 13:33:46 -04003925 PyUnicode_FSDecoder, &pathname))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003926 return NULL;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003927
Victor Stinnerc9abda02011-03-14 13:33:46 -04003928 source = make_source_pathname(pathname);
3929 if (source == NULL) {
3930 PyErr_Format(PyExc_ValueError, "Not a PEP 3147 pyc path: %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003931 pathname);
Victor Stinnerc9abda02011-03-14 13:33:46 -04003932 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003933 return NULL;
3934 }
Victor Stinnerc9abda02011-03-14 13:33:46 -04003935 Py_DECREF(pathname);
3936 return source;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003937}
3938
3939PyDoc_STRVAR(doc_source_from_cache,
3940"Given the path to a .pyc./.pyo file, return the path to its .py file.\n\
3941\n\
3942The .pyc/.pyo file does not need to exist; this simply returns the path to\n\
3943the .py file calculated to correspond to the .pyc/.pyo file. If path\n\
3944does not conform to PEP 3147 format, ValueError will be raised.");
3945
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003946/* Doc strings */
3947
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003948PyDoc_STRVAR(doc_imp,
3949"This module provides the components needed to build your own\n\
3950__import__ function. Undocumented functions are obsolete.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003951
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003952PyDoc_STRVAR(doc_find_module,
3953"find_module(name, [path]) -> (file, filename, (suffix, mode, type))\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003954Search for a module. If path is omitted or None, search for a\n\
3955built-in, frozen or special module and continue search in sys.path.\n\
3956The module name cannot contain '.'; to search for a submodule of a\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003957package, pass the submodule name and the package's __path__.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003958
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003959PyDoc_STRVAR(doc_load_module,
3960"load_module(name, file, filename, (suffix, mode, type)) -> module\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003961Load a module, given information returned by find_module().\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003962The module name must include the full package name, if any.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003963
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003964PyDoc_STRVAR(doc_get_magic,
3965"get_magic() -> string\n\
3966Return the magic number for .pyc or .pyo files.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003967
Barry Warsaw28a691b2010-04-17 00:19:56 +00003968PyDoc_STRVAR(doc_get_tag,
3969"get_tag() -> string\n\
3970Return the magic tag for .pyc or .pyo files.");
3971
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003972PyDoc_STRVAR(doc_get_suffixes,
3973"get_suffixes() -> [(suffix, mode, type), ...]\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003974Return a list of (suffix, mode, type) tuples describing the files\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003975that find_module() looks for.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003976
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003977PyDoc_STRVAR(doc_new_module,
3978"new_module(name) -> module\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003979Create a new module. Do not enter it in sys.modules.\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003980The module name must include the full package name, if any.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003981
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003982PyDoc_STRVAR(doc_lock_held,
Tim Petersa7c65092004-08-01 23:26:05 +00003983"lock_held() -> boolean\n\
3984Return True if the import lock is currently held, else False.\n\
3985On platforms without threads, return False.");
Tim Peters69232342001-08-30 05:16:13 +00003986
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00003987PyDoc_STRVAR(doc_acquire_lock,
3988"acquire_lock() -> None\n\
Neal Norwitz2294c0d2003-02-12 23:02:21 +00003989Acquires the interpreter's import lock for the current thread.\n\
3990This lock should be used by import hooks to ensure thread-safety\n\
3991when importing modules.\n\
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00003992On platforms without threads, this function does nothing.");
3993
3994PyDoc_STRVAR(doc_release_lock,
3995"release_lock() -> None\n\
3996Release the interpreter's import lock.\n\
3997On platforms without threads, this function does nothing.");
3998
Guido van Rossum79f25d91997-04-29 20:08:16 +00003999static PyMethodDef imp_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004000 {"find_module", imp_find_module, METH_VARARGS, doc_find_module},
4001 {"get_magic", imp_get_magic, METH_NOARGS, doc_get_magic},
4002 {"get_tag", imp_get_tag, METH_NOARGS, doc_get_tag},
4003 {"get_suffixes", imp_get_suffixes, METH_NOARGS, doc_get_suffixes},
4004 {"load_module", imp_load_module, METH_VARARGS, doc_load_module},
4005 {"new_module", imp_new_module, METH_VARARGS, doc_new_module},
4006 {"lock_held", imp_lock_held, METH_NOARGS, doc_lock_held},
4007 {"acquire_lock", imp_acquire_lock, METH_NOARGS, doc_acquire_lock},
4008 {"release_lock", imp_release_lock, METH_NOARGS, doc_release_lock},
4009 {"reload", imp_reload, METH_O, doc_reload},
4010 {"cache_from_source", (PyCFunction)imp_cache_from_source,
4011 METH_VARARGS | METH_KEYWORDS, doc_cache_from_source},
4012 {"source_from_cache", (PyCFunction)imp_source_from_cache,
4013 METH_VARARGS | METH_KEYWORDS, doc_source_from_cache},
4014 /* The rest are obsolete */
4015 {"get_frozen_object", imp_get_frozen_object, METH_VARARGS},
4016 {"is_frozen_package", imp_is_frozen_package, METH_VARARGS},
4017 {"init_builtin", imp_init_builtin, METH_VARARGS},
4018 {"init_frozen", imp_init_frozen, METH_VARARGS},
4019 {"is_builtin", imp_is_builtin, METH_VARARGS},
4020 {"is_frozen", imp_is_frozen, METH_VARARGS},
4021 {"load_compiled", imp_load_compiled, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00004022#ifdef HAVE_DYNAMIC_LOADING
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004023 {"load_dynamic", imp_load_dynamic, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00004024#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004025 {"load_package", imp_load_package, METH_VARARGS},
4026 {"load_source", imp_load_source, METH_VARARGS},
Brett Cannon442c9b92011-03-23 16:14:42 -07004027 {"_fix_co_filename", imp_fix_co_filename, METH_VARARGS},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004028 {NULL, NULL} /* sentinel */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004029};
4030
Guido van Rossum1a8791e1998-08-04 22:46:29 +00004031static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00004032setint(PyObject *d, char *name, int value)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00004033{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004034 PyObject *v;
4035 int err;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00004036
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004037 v = PyLong_FromLong((long)value);
4038 err = PyDict_SetItemString(d, name, v);
4039 Py_XDECREF(v);
4040 return err;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00004041}
4042
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004043typedef struct {
4044 PyObject_HEAD
4045} NullImporter;
4046
4047static int
4048NullImporter_init(NullImporter *self, PyObject *args, PyObject *kwds)
4049{
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004050#ifndef MS_WINDOWS
4051 PyObject *path;
4052 struct stat statbuf;
4053 int rv;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004054
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004055 if (!_PyArg_NoKeywords("NullImporter()", kwds))
4056 return -1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004057
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004058 if (!PyArg_ParseTuple(args, "O&:NullImporter",
4059 PyUnicode_FSConverter, &path))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004060 return -1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004061
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004062 if (PyBytes_GET_SIZE(path) == 0) {
4063 Py_DECREF(path);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004064 PyErr_SetString(PyExc_ImportError, "empty pathname");
4065 return -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004066 }
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004067
4068 rv = stat(PyBytes_AS_STRING(path), &statbuf);
4069 Py_DECREF(path);
4070 if (rv == 0) {
4071 /* it exists */
4072 if (S_ISDIR(statbuf.st_mode)) {
4073 /* it's a directory */
4074 PyErr_SetString(PyExc_ImportError, "existing directory");
4075 return -1;
4076 }
4077 }
4078#else /* MS_WINDOWS */
4079 PyObject *pathobj;
4080 DWORD rv;
Victor Stinner255dfdb2010-09-29 10:28:51 +00004081 wchar_t *path;
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004082
4083 if (!_PyArg_NoKeywords("NullImporter()", kwds))
4084 return -1;
4085
4086 if (!PyArg_ParseTuple(args, "U:NullImporter",
4087 &pathobj))
4088 return -1;
4089
4090 if (PyUnicode_GET_SIZE(pathobj) == 0) {
4091 PyErr_SetString(PyExc_ImportError, "empty pathname");
4092 return -1;
4093 }
4094
Victor Stinnerbeb4135b2010-10-07 01:02:42 +00004095 path = PyUnicode_AsWideCharString(pathobj, NULL);
Victor Stinner255dfdb2010-09-29 10:28:51 +00004096 if (path == NULL)
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004097 return -1;
4098 /* see issue1293 and issue3677:
4099 * stat() on Windows doesn't recognise paths like
4100 * "e:\\shared\\" and "\\\\whiterab-c2znlh\\shared" as dirs.
4101 */
4102 rv = GetFileAttributesW(path);
Victor Stinner255dfdb2010-09-29 10:28:51 +00004103 PyMem_Free(path);
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004104 if (rv != INVALID_FILE_ATTRIBUTES) {
4105 /* it exists */
4106 if (rv & FILE_ATTRIBUTE_DIRECTORY) {
4107 /* it's a directory */
4108 PyErr_SetString(PyExc_ImportError, "existing directory");
4109 return -1;
4110 }
4111 }
4112#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004113 return 0;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004114}
4115
4116static PyObject *
4117NullImporter_find_module(NullImporter *self, PyObject *args)
4118{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004119 Py_RETURN_NONE;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004120}
4121
4122static PyMethodDef NullImporter_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004123 {"find_module", (PyCFunction)NullImporter_find_module, METH_VARARGS,
4124 "Always return None"
4125 },
4126 {NULL} /* Sentinel */
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004127};
4128
4129
Christian Heimes9cd17752007-11-18 19:35:23 +00004130PyTypeObject PyNullImporter_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004131 PyVarObject_HEAD_INIT(NULL, 0)
4132 "imp.NullImporter", /*tp_name*/
4133 sizeof(NullImporter), /*tp_basicsize*/
4134 0, /*tp_itemsize*/
4135 0, /*tp_dealloc*/
4136 0, /*tp_print*/
4137 0, /*tp_getattr*/
4138 0, /*tp_setattr*/
4139 0, /*tp_reserved*/
4140 0, /*tp_repr*/
4141 0, /*tp_as_number*/
4142 0, /*tp_as_sequence*/
4143 0, /*tp_as_mapping*/
4144 0, /*tp_hash */
4145 0, /*tp_call*/
4146 0, /*tp_str*/
4147 0, /*tp_getattro*/
4148 0, /*tp_setattro*/
4149 0, /*tp_as_buffer*/
4150 Py_TPFLAGS_DEFAULT, /*tp_flags*/
4151 "Null importer object", /* tp_doc */
4152 0, /* tp_traverse */
4153 0, /* tp_clear */
4154 0, /* tp_richcompare */
4155 0, /* tp_weaklistoffset */
4156 0, /* tp_iter */
4157 0, /* tp_iternext */
4158 NullImporter_methods, /* tp_methods */
4159 0, /* tp_members */
4160 0, /* tp_getset */
4161 0, /* tp_base */
4162 0, /* tp_dict */
4163 0, /* tp_descr_get */
4164 0, /* tp_descr_set */
4165 0, /* tp_dictoffset */
4166 (initproc)NullImporter_init, /* tp_init */
4167 0, /* tp_alloc */
4168 PyType_GenericNew /* tp_new */
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004169};
4170
Martin v. Löwis1a214512008-06-11 05:26:20 +00004171static struct PyModuleDef impmodule = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004172 PyModuleDef_HEAD_INIT,
4173 "imp",
4174 doc_imp,
4175 0,
4176 imp_methods,
4177 NULL,
4178 NULL,
4179 NULL,
4180 NULL
Martin v. Löwis1a214512008-06-11 05:26:20 +00004181};
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004182
Jason Tishler6bc06ec2003-09-04 11:59:50 +00004183PyMODINIT_FUNC
Martin v. Löwis1a214512008-06-11 05:26:20 +00004184PyInit_imp(void)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004185{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004186 PyObject *m, *d;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004187
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004188 if (PyType_Ready(&PyNullImporter_Type) < 0)
4189 return NULL;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004190
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004191 m = PyModule_Create(&impmodule);
4192 if (m == NULL)
4193 goto failure;
4194 d = PyModule_GetDict(m);
4195 if (d == NULL)
4196 goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004197
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004198 if (setint(d, "SEARCH_ERROR", SEARCH_ERROR) < 0) goto failure;
4199 if (setint(d, "PY_SOURCE", PY_SOURCE) < 0) goto failure;
4200 if (setint(d, "PY_COMPILED", PY_COMPILED) < 0) goto failure;
4201 if (setint(d, "C_EXTENSION", C_EXTENSION) < 0) goto failure;
4202 if (setint(d, "PY_RESOURCE", PY_RESOURCE) < 0) goto failure;
4203 if (setint(d, "PKG_DIRECTORY", PKG_DIRECTORY) < 0) goto failure;
4204 if (setint(d, "C_BUILTIN", C_BUILTIN) < 0) goto failure;
4205 if (setint(d, "PY_FROZEN", PY_FROZEN) < 0) goto failure;
4206 if (setint(d, "PY_CODERESOURCE", PY_CODERESOURCE) < 0) goto failure;
4207 if (setint(d, "IMP_HOOK", IMP_HOOK) < 0) goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004208
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004209 Py_INCREF(&PyNullImporter_Type);
4210 PyModule_AddObject(m, "NullImporter", (PyObject *)&PyNullImporter_Type);
4211 return m;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00004212 failure:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004213 Py_XDECREF(m);
4214 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004215}
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004216
4217
Guido van Rossumb18618d2000-05-03 23:44:39 +00004218/* API for embedding applications that want to add their own entries
4219 to the table of built-in modules. This should normally be called
4220 *before* Py_Initialize(). When the table resize fails, -1 is
4221 returned and the existing table is unchanged.
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004222
4223 After a similar function by Just van Rossum. */
4224
4225int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00004226PyImport_ExtendInittab(struct _inittab *newtab)
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004227{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004228 static struct _inittab *our_copy = NULL;
4229 struct _inittab *p;
4230 int i, n;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004231
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004232 /* Count the number of entries in both tables */
4233 for (n = 0; newtab[n].name != NULL; n++)
4234 ;
4235 if (n == 0)
4236 return 0; /* Nothing to do */
4237 for (i = 0; PyImport_Inittab[i].name != NULL; i++)
4238 ;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004239
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004240 /* Allocate new memory for the combined table */
4241 p = our_copy;
4242 PyMem_RESIZE(p, struct _inittab, i+n+1);
4243 if (p == NULL)
4244 return -1;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004245
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004246 /* Copy the tables into the new memory */
4247 if (our_copy != PyImport_Inittab)
4248 memcpy(p, PyImport_Inittab, (i+1) * sizeof(struct _inittab));
4249 PyImport_Inittab = our_copy = p;
4250 memcpy(p+i, newtab, (n+1) * sizeof(struct _inittab));
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004251
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004252 return 0;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004253}
4254
4255/* Shorthand to add a single entry given a name and a function */
4256
4257int
Brett Cannona826f322009-04-02 03:41:46 +00004258PyImport_AppendInittab(const char *name, PyObject* (*initfunc)(void))
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004259{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004260 struct _inittab newtab[2];
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004261
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004262 memset(newtab, '\0', sizeof newtab);
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004263
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004264 newtab[0].name = (char *)name;
4265 newtab[0].initfunc = initfunc;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004266
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004267 return PyImport_ExtendInittab(newtab);
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004268}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00004269
4270#ifdef __cplusplus
4271}
4272#endif