blob: 1f28d2233dc53a01885c9837deea4c27bb64e1d3 [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;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001736 Py_ssize_t len;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001737 struct stat statbuf;
1738 static struct filedescr fd_package = {"", "", PKG_DIRECTORY};
1739
1740 if (PyUnicode_Check(path)) {
Victor Stinner2fd76e42011-03-14 15:19:39 -04001741 Py_INCREF(path);
1742 path_unicode = path;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001743 }
1744 else if (PyBytes_Check(path)) {
Victor Stinner2fd76e42011-03-14 15:19:39 -04001745 path_unicode = PyUnicode_DecodeFSDefaultAndSize(
1746 PyBytes_AS_STRING(path), PyBytes_GET_SIZE(path));
1747 if (path_unicode == NULL)
1748 return -1;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001749 }
1750 else
1751 return 0;
1752
Victor Stinner2fd76e42011-03-14 15:19:39 -04001753 len = PyUnicode_GET_SIZE(path_unicode);
1754 if (len + 2 + PyUnicode_GET_SIZE(name) + MAXSUFFIXSIZE >= buflen) {
1755 Py_DECREF(path_unicode);
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001756 return 0; /* Too long */
1757 }
Victor Stinner2fd76e42011-03-14 15:19:39 -04001758 Py_UNICODE_strcpy(buf, PyUnicode_AS_UNICODE(path_unicode));
1759 Py_DECREF(path_unicode);
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001760
Victor Stinner2fd76e42011-03-14 15:19:39 -04001761 if (Py_UNICODE_strlen(buf) != len)
1762 return 0; /* path contains '\0' */
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001763
1764 /* sys.path_hooks import hook */
1765 if (p_loader != NULL) {
1766 PyObject *importer;
1767
1768 importer = get_path_importer(path_importer_cache,
1769 path_hooks, path);
1770 if (importer == NULL) {
1771 return -1;
1772 }
1773 /* Note: importer is a borrowed reference */
1774 if (importer != Py_None) {
1775 PyObject *loader;
1776 loader = PyObject_CallMethod(importer,
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001777 "find_module", "O", fullname);
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001778 if (loader == NULL)
1779 return -1; /* error */
1780 if (loader != Py_None) {
1781 /* a loader was found */
1782 *p_loader = loader;
1783 *p_fd = &importhookdescr;
1784 return 2;
1785 }
1786 Py_DECREF(loader);
1787 return 0;
1788 }
1789 }
1790 /* no hook was found, use builtin import */
1791
1792 if (len > 0 && buf[len-1] != SEP
1793#ifdef ALTSEP
1794 && buf[len-1] != ALTSEP
1795#endif
1796 )
1797 buf[len++] = SEP;
Victor Stinner2fd76e42011-03-14 15:19:39 -04001798 Py_UNICODE_strcpy(buf+len, PyUnicode_AS_UNICODE(name));
1799 len += PyUnicode_GET_SIZE(name);
1800
1801 filename = PyUnicode_FromUnicode(buf, len);
1802 if (filename == NULL)
1803 return -1;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001804
1805 /* Check for package import (buf holds a directory name,
1806 and there's an __init__ module in that directory */
1807#ifdef HAVE_STAT
Victor Stinner2fd76e42011-03-14 15:19:39 -04001808 if (_Py_stat(filename, &statbuf) == 0 && /* it exists */
Victor Stinnerd0296212011-03-14 14:04:10 -04001809 S_ISDIR(statbuf.st_mode)) /* it's a directory */
1810 {
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001811 int match;
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001812
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001813 match = case_ok(filename, 0, name);
1814 if (match < 0) {
1815 Py_DECREF(filename);
1816 return -1;
1817 }
1818 if (match) { /* case matches */
1819 if (find_init_module(filename)) { /* and has __init__.py */
Victor Stinner2fd76e42011-03-14 15:19:39 -04001820 *p_path = filename;
Victor Stinnerd0296212011-03-14 14:04:10 -04001821 *p_fd = &fd_package;
1822 return 2;
1823 }
1824 else {
1825 int err;
Victor Stinnerd0296212011-03-14 14:04:10 -04001826 err = PyErr_WarnFormat(PyExc_ImportWarning, 1,
Victor Stinner547a2a62011-03-20 03:07:28 +01001827 "Not importing directory %R: missing __init__.py",
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001828 filename);
Victor Stinner547a2a62011-03-20 03:07:28 +01001829 if (err) {
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001830 Py_DECREF(filename);
Victor Stinnerd0296212011-03-14 14:04:10 -04001831 return -1;
Victor Stinner547a2a62011-03-20 03:07:28 +01001832 }
Victor Stinnerd0296212011-03-14 14:04:10 -04001833 }
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001834 }
1835 }
1836#endif
Victor Stinner2fd76e42011-03-14 15:19:39 -04001837 *p_path = filename;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001838 return 1;
1839}
1840
1841/* Find a module in search_path_list. For each path, try
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001842 find_module_path() or try each _PyImport_Filetab suffix.
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001843
1844 If the module is found, return a file descriptor, write the path in
1845 *p_filename, write the pointer to the file object into *p_fp, and (if
1846 p_loader is not NULL) the loader into *p_loader.
1847
1848 Otherwise, raise an exception and return NULL. */
1849
Victor Stinner37580282011-03-20 01:34:43 +01001850static struct filedescr*
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001851find_module_path_list(PyObject *fullname, PyObject *name,
Victor Stinner37580282011-03-20 01:34:43 +01001852 PyObject *search_path_list, PyObject *path_hooks,
1853 PyObject *path_importer_cache,
Victor Stinner2fd76e42011-03-14 15:19:39 -04001854 PyObject **p_path, FILE **p_fp, PyObject **p_loader)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001855{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001856 Py_ssize_t i, npath;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001857 struct filedescr *fdp = NULL;
1858 char *filemode;
1859 FILE *fp = NULL;
Victor Stinner2fd76e42011-03-14 15:19:39 -04001860 PyObject *prefix, *filename;
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001861 int match;
Victor Stinner53dc7352011-03-20 01:50:21 +01001862
Victor Stinner37580282011-03-20 01:34:43 +01001863 npath = PyList_Size(search_path_list);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001864 for (i = 0; i < npath; i++) {
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001865 PyObject *path;
1866 int ok;
1867
1868 path = PyList_GetItem(search_path_list, i);
1869 if (path == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001870 return NULL;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001871
Victor Stinner2fd76e42011-03-14 15:19:39 -04001872 prefix = NULL;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001873 ok = find_module_path(fullname, name, path,
1874 path_hooks, path_importer_cache,
Victor Stinner2fd76e42011-03-14 15:19:39 -04001875 &prefix, p_loader, &fdp);
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001876 if (ok < 0)
1877 return NULL;
1878 if (ok == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001879 continue;
Victor Stinner2fd76e42011-03-14 15:19:39 -04001880 if (ok == 2) {
1881 *p_path = prefix;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001882 return fdp;
Victor Stinner2fd76e42011-03-14 15:19:39 -04001883 }
Amaury Forgeot d'Arcf1ca0b12008-06-11 17:40:47 +00001884
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001885 for (fdp = _PyImport_Filetab; fdp->suffix != NULL; fdp++) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001886 filemode = fdp->mode;
1887 if (filemode[0] == 'U')
1888 filemode = "r" PY_STDIOTEXTMODE;
Victor Stinnerd0296212011-03-14 14:04:10 -04001889
Victor Stinner2fd76e42011-03-14 15:19:39 -04001890 filename = PyUnicode_FromFormat("%U%s", prefix, fdp->suffix);
1891 if (filename == NULL) {
1892 Py_DECREF(prefix);
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001893 return NULL;
Victor Stinner2fd76e42011-03-14 15:19:39 -04001894 }
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001895
1896 if (Py_VerboseFlag > 1)
1897 PySys_FormatStderr("# trying %R\n", filename);
1898
1899 fp = _Py_fopen(filename, filemode);
1900 if (fp == NULL) {
1901 Py_DECREF(filename);
1902 continue;
1903 }
1904 match = case_ok(filename, -(Py_ssize_t)strlen(fdp->suffix), name);
1905 if (match < 0) {
Victor Stinner2fd76e42011-03-14 15:19:39 -04001906 Py_DECREF(prefix);
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001907 Py_DECREF(filename);
1908 return NULL;
1909 }
1910 if (match) {
Victor Stinner2fd76e42011-03-14 15:19:39 -04001911 Py_DECREF(prefix);
1912 *p_path = filename;
Victor Stinnerd0296212011-03-14 14:04:10 -04001913 *p_fp = fp;
1914 return fdp;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001915 }
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001916 Py_DECREF(filename);
Victor Stinnerd0296212011-03-14 14:04:10 -04001917
1918 fclose(fp);
1919 fp = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001920 }
Victor Stinner2fd76e42011-03-14 15:19:39 -04001921 Py_DECREF(prefix);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001922 }
Victor Stinnerd0296212011-03-14 14:04:10 -04001923 PyErr_Format(PyExc_ImportError,
Victor Stinner98dbba52011-03-14 15:15:47 -04001924 "No module named %R", name);
Victor Stinnerd0296212011-03-14 14:04:10 -04001925 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001926}
1927
Victor Stinner37580282011-03-20 01:34:43 +01001928/* Find a module:
1929
1930 - try find_module() of each sys.meta_path hook
1931 - try find_frozen()
1932 - try is_builtin()
1933 - try _PyWin_FindRegisteredModule() (Windows only)
1934 - otherwise, call find_module_path_list() with search_path_list (if not
1935 NULL) or sys.path
1936
Victor Stinner2fd76e42011-03-14 15:19:39 -04001937 fullname can be NULL, but only if p_loader is NULL.
1938
Victor Stinner37580282011-03-20 01:34:43 +01001939 Return:
1940
1941 - &fd_builtin (C_BUILTIN) if it is a builtin
1942 - &fd_frozen (PY_FROZEN) if it is frozen
Victor Stinner2fd76e42011-03-14 15:19:39 -04001943 - &fd_package (PKG_DIRECTORY) and write the filename into *p_path
Victor Stinner37580282011-03-20 01:34:43 +01001944 if it is a package
1945 - &importhookdescr (IMP_HOOK) and write the loader into *p_loader if a
1946 importer loader was found
1947 - a file descriptor (PY_SOURCE, PY_COMPILED, C_EXTENSION, PY_RESOURCE or
1948 PY_CODERESOURCE: see _PyImport_Filetab), write the filename into
Victor Stinner2fd76e42011-03-14 15:19:39 -04001949 *p_path and the pointer to the open file into *p_fp
Victor Stinner37580282011-03-20 01:34:43 +01001950 - NULL on error
1951
Victor Stinner2fd76e42011-03-14 15:19:39 -04001952 By default, *p_path, *p_fp and *p_loader (if set) are set to NULL.
1953 Eg. *p_path is set to NULL for a builtin package.
1954*/
Victor Stinner37580282011-03-20 01:34:43 +01001955
1956static struct filedescr *
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001957find_module(PyObject *fullname, PyObject *name, PyObject *search_path_list,
Victor Stinner2fd76e42011-03-14 15:19:39 -04001958 PyObject **p_path, FILE **p_fp, PyObject **p_loader)
Victor Stinner37580282011-03-20 01:34:43 +01001959{
1960 Py_ssize_t i, npath;
1961 static struct filedescr fd_frozen = {"", "", PY_FROZEN};
1962 static struct filedescr fd_builtin = {"", "", C_BUILTIN};
1963 PyObject *path_hooks, *path_importer_cache;
Victor Stinner37580282011-03-20 01:34:43 +01001964
Victor Stinner2fd76e42011-03-14 15:19:39 -04001965 *p_path = NULL;
Victor Stinner37580282011-03-20 01:34:43 +01001966 *p_fp = NULL;
1967 if (p_loader != NULL)
1968 *p_loader = NULL;
1969
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001970 if (PyUnicode_GET_SIZE(name) > MAXPATHLEN) {
Victor Stinner37580282011-03-20 01:34:43 +01001971 PyErr_SetString(PyExc_OverflowError,
1972 "module name is too long");
1973 return NULL;
1974 }
1975
1976 /* sys.meta_path import hook */
1977 if (p_loader != NULL) {
1978 PyObject *meta_path;
1979
1980 meta_path = PySys_GetObject("meta_path");
1981 if (meta_path == NULL || !PyList_Check(meta_path)) {
1982 PyErr_SetString(PyExc_ImportError,
1983 "sys.meta_path must be a list of "
1984 "import hooks");
1985 return NULL;
1986 }
1987 Py_INCREF(meta_path); /* zap guard */
1988 npath = PyList_Size(meta_path);
1989 for (i = 0; i < npath; i++) {
1990 PyObject *loader;
1991 PyObject *hook = PyList_GetItem(meta_path, i);
1992 loader = PyObject_CallMethod(hook, "find_module",
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001993 "OO", fullname,
Victor Stinner37580282011-03-20 01:34:43 +01001994 search_path_list != NULL ?
1995 search_path_list : Py_None);
1996 if (loader == NULL) {
1997 Py_DECREF(meta_path);
1998 return NULL; /* true error */
1999 }
2000 if (loader != Py_None) {
2001 /* a loader was found */
2002 *p_loader = loader;
2003 Py_DECREF(meta_path);
2004 return &importhookdescr;
2005 }
2006 Py_DECREF(loader);
2007 }
2008 Py_DECREF(meta_path);
2009 }
2010
Victor Stinnerdf75a022011-03-14 13:40:04 -04002011 if (find_frozen(fullname) != NULL)
Victor Stinnerad3c03b2011-03-14 09:21:33 -04002012 return &fd_frozen;
Victor Stinner37580282011-03-20 01:34:43 +01002013
2014 if (search_path_list == NULL) {
2015#ifdef MS_COREDLL
2016 FILE *fp;
2017 struct filedescr *fdp;
Victor Stinner37580282011-03-20 01:34:43 +01002018#endif
Victor Stinnerdf75a022011-03-14 13:40:04 -04002019 if (is_builtin(name))
Victor Stinner37580282011-03-20 01:34:43 +01002020 return &fd_builtin;
Victor Stinner37580282011-03-20 01:34:43 +01002021#ifdef MS_COREDLL
Victor Stinner2fd76e42011-03-14 15:19:39 -04002022 fp = _PyWin_FindRegisteredModule(name, &fdp, p_path);
Victor Stinner37580282011-03-20 01:34:43 +01002023 if (fp != NULL) {
Victor Stinner37580282011-03-20 01:34:43 +01002024 *p_fp = fp;
2025 return fdp;
2026 }
2027 else if (PyErr_Occurred())
2028 return NULL;
2029#endif
Victor Stinner37580282011-03-20 01:34:43 +01002030 search_path_list = PySys_GetObject("path");
2031 }
2032
2033 if (search_path_list == NULL || !PyList_Check(search_path_list)) {
2034 PyErr_SetString(PyExc_ImportError,
2035 "sys.path must be a list of directory names");
2036 return NULL;
2037 }
2038
2039 path_hooks = PySys_GetObject("path_hooks");
2040 if (path_hooks == NULL || !PyList_Check(path_hooks)) {
2041 PyErr_SetString(PyExc_ImportError,
2042 "sys.path_hooks must be a list of "
2043 "import hooks");
2044 return NULL;
2045 }
2046 path_importer_cache = PySys_GetObject("path_importer_cache");
2047 if (path_importer_cache == NULL ||
2048 !PyDict_Check(path_importer_cache)) {
2049 PyErr_SetString(PyExc_ImportError,
2050 "sys.path_importer_cache must be a dict");
2051 return NULL;
2052 }
2053
2054 return find_module_path_list(fullname, name,
2055 search_path_list, path_hooks,
2056 path_importer_cache,
Victor Stinner2fd76e42011-03-14 15:19:39 -04002057 p_path, p_fp, p_loader);
Victor Stinner37580282011-03-20 01:34:43 +01002058}
2059
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002060/* case_bytes(char* buf, Py_ssize_t len, Py_ssize_t namelen, char* name)
Tim Petersd1e87a82001-03-01 18:12:00 +00002061 * The arguments here are tricky, best shown by example:
2062 * /a/b/c/d/e/f/g/h/i/j/k/some_long_module_name.py\0
2063 * ^ ^ ^ ^
2064 * |--------------------- buf ---------------------|
2065 * |------------------- len ------------------|
2066 * |------ name -------|
2067 * |----- namelen -----|
2068 * buf is the full path, but len only counts up to (& exclusive of) the
2069 * extension. name is the module name, also exclusive of extension.
2070 *
2071 * We've already done a successful stat() or fopen() on buf, so know that
2072 * there's some match, possibly case-insensitive.
2073 *
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002074 * case_bytes() is to return 1 if there's a case-sensitive match for
2075 * name, else 0. case_bytes() is also to return 1 if envar PYTHONCASEOK
Tim Peters50d8d372001-02-28 05:34:27 +00002076 * exists.
Tim Petersd1e87a82001-03-01 18:12:00 +00002077 *
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002078 * case_bytes() is used to implement case-sensitive import semantics even
Tim Peters50d8d372001-02-28 05:34:27 +00002079 * on platforms with case-insensitive filesystems. It's trivial to implement
2080 * for case-sensitive filesystems. It's pretty much a cross-platform
2081 * nightmare for systems with case-insensitive filesystems.
2082 */
Guido van Rossum0980bd91998-02-13 17:18:36 +00002083
Tim Peters50d8d372001-02-28 05:34:27 +00002084/* First we may need a pile of platform-specific header files; the sequence
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002085 * of #if's here should match the sequence in the body of case_bytes().
Tim Peters50d8d372001-02-28 05:34:27 +00002086 */
Jason Tishler7961aa62005-05-20 00:56:54 +00002087#if defined(MS_WINDOWS)
Guido van Rossum0980bd91998-02-13 17:18:36 +00002088#include <windows.h>
Guido van Rossum4c3f57c2001-01-10 20:40:46 +00002089
Tim Peters50d8d372001-02-28 05:34:27 +00002090#elif defined(DJGPP)
2091#include <dir.h>
2092
Jason Tishler7961aa62005-05-20 00:56:54 +00002093#elif (defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) && defined(HAVE_DIRENT_H)
Tim Peters430f5d42001-03-01 01:30:56 +00002094#include <sys/types.h>
2095#include <dirent.h>
2096
Andrew MacIntyred9400542002-02-26 11:41:34 +00002097#elif defined(PYOS_OS2)
2098#define INCL_DOS
2099#define INCL_DOSERRORS
2100#define INCL_NOPMAPI
2101#include <os2.h>
Tim Peters50d8d372001-02-28 05:34:27 +00002102#endif
2103
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002104#if defined(DJGPP) \
2105 || ((defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) \
2106 && defined(HAVE_DIRENT_H)) \
2107 || defined(PYOS_OS2)
2108# define USE_CASE_OK_BYTES
2109#endif
2110
2111
2112#ifdef USE_CASE_OK_BYTES
Guido van Rossum0980bd91998-02-13 17:18:36 +00002113static int
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002114case_bytes(char *buf, Py_ssize_t len, Py_ssize_t namelen, const char *name)
Guido van Rossum0980bd91998-02-13 17:18:36 +00002115{
Tim Peters50d8d372001-02-28 05:34:27 +00002116/* Pick a platform-specific implementation; the sequence of #if's here should
2117 * match the sequence just above.
2118 */
2119
Tim Peters50d8d372001-02-28 05:34:27 +00002120/* DJGPP */
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002121#if defined(DJGPP)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002122 struct ffblk ffblk;
2123 int done;
Tim Peters50d8d372001-02-28 05:34:27 +00002124
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002125 if (Py_GETENV("PYTHONCASEOK") != NULL)
2126 return 1;
Tim Peters50d8d372001-02-28 05:34:27 +00002127
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002128 done = findfirst(buf, &ffblk, FA_ARCH|FA_RDONLY|FA_HIDDEN|FA_DIREC);
2129 if (done) {
2130 PyErr_Format(PyExc_NameError,
2131 "Can't find file for module %.100s\n(filename %.300s)",
2132 name, buf);
Victor Stinner9c61e242011-03-22 01:22:27 +01002133 return -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002134 }
2135 return strncmp(ffblk.ff_name, name, namelen) == 0;
Guido van Rossum0980bd91998-02-13 17:18:36 +00002136
Jason Tishler7961aa62005-05-20 00:56:54 +00002137/* new-fangled macintosh (macosx) or Cygwin */
2138#elif (defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) && defined(HAVE_DIRENT_H)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002139 DIR *dirp;
2140 struct dirent *dp;
2141 char dirname[MAXPATHLEN + 1];
2142 const int dirlen = len - namelen - 1; /* don't want trailing SEP */
Tim Peters430f5d42001-03-01 01:30:56 +00002143
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002144 if (Py_GETENV("PYTHONCASEOK") != NULL)
2145 return 1;
Tim Petersdbe6ebb2001-03-01 08:47:29 +00002146
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002147 /* Copy the dir component into dirname; substitute "." if empty */
2148 if (dirlen <= 0) {
2149 dirname[0] = '.';
2150 dirname[1] = '\0';
2151 }
2152 else {
2153 assert(dirlen <= MAXPATHLEN);
2154 memcpy(dirname, buf, dirlen);
2155 dirname[dirlen] = '\0';
2156 }
2157 /* Open the directory and search the entries for an exact match. */
2158 dirp = opendir(dirname);
2159 if (dirp) {
2160 char *nameWithExt = buf + len - namelen;
2161 while ((dp = readdir(dirp)) != NULL) {
2162 const int thislen =
Tim Peters430f5d42001-03-01 01:30:56 +00002163#ifdef _DIRENT_HAVE_D_NAMELEN
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002164 dp->d_namlen;
Tim Peters430f5d42001-03-01 01:30:56 +00002165#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002166 strlen(dp->d_name);
Tim Peters430f5d42001-03-01 01:30:56 +00002167#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002168 if (thislen >= namelen &&
2169 strcmp(dp->d_name, nameWithExt) == 0) {
2170 (void)closedir(dirp);
2171 return 1; /* Found */
2172 }
2173 }
2174 (void)closedir(dirp);
2175 }
2176 return 0 ; /* Not found */
Tim Peters430f5d42001-03-01 01:30:56 +00002177
Andrew MacIntyred9400542002-02-26 11:41:34 +00002178/* OS/2 */
2179#elif defined(PYOS_OS2)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002180 HDIR hdir = 1;
2181 ULONG srchcnt = 1;
2182 FILEFINDBUF3 ffbuf;
2183 APIRET rc;
Andrew MacIntyred9400542002-02-26 11:41:34 +00002184
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002185 if (Py_GETENV("PYTHONCASEOK") != NULL)
2186 return 1;
Andrew MacIntyred9400542002-02-26 11:41:34 +00002187
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002188 rc = DosFindFirst(buf,
2189 &hdir,
2190 FILE_READONLY | FILE_HIDDEN | FILE_SYSTEM | FILE_DIRECTORY,
2191 &ffbuf, sizeof(ffbuf),
2192 &srchcnt,
2193 FIL_STANDARD);
2194 if (rc != NO_ERROR)
2195 return 0;
2196 return strncmp(ffbuf.achName, name, namelen) == 0;
Andrew MacIntyred9400542002-02-26 11:41:34 +00002197
Tim Peters50d8d372001-02-28 05:34:27 +00002198/* assuming it's a case-sensitive filesystem, so there's nothing to do! */
2199#else
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002200# error "USE_CASE_OK_BYTES is not correctly defined"
2201#endif
2202}
2203#endif
2204
2205/*
2206 * Check if a filename case matchs the name case. We've already done a
2207 * successful stat() or fopen() on buf, so know that there's some match,
2208 * possibly case-insensitive.
2209 *
2210 * case_ok() is to return 1 if there's a case-sensitive match for name, 0 if it
2211 * the filename doesn't match, or -1 on error. case_ok() is also to return 1
2212 * if envar PYTHONCASEOK exists.
2213 *
2214 * case_ok() is used to implement case-sensitive import semantics even
2215 * on platforms with case-insensitive filesystems. It's trivial to implement
2216 * for case-sensitive filesystems. It's pretty much a cross-platform
2217 * nightmare for systems with case-insensitive filesystems.
2218 */
2219
2220static int
2221case_ok(PyObject *filename, Py_ssize_t prefix_delta, PyObject *name)
2222{
2223#ifdef MS_WINDOWS
2224 WIN32_FIND_DATAW data;
2225 HANDLE h;
2226 int cmp;
2227
2228 if (Py_GETENV("PYTHONCASEOK") != NULL)
2229 return 1;
2230
2231 h = FindFirstFileW(PyUnicode_AS_UNICODE(filename), &data);
2232 if (h == INVALID_HANDLE_VALUE) {
2233 PyErr_Format(PyExc_NameError,
2234 "Can't find file for module %R\n(filename %R)",
2235 name, filename);
2236 return 0;
2237 }
2238 FindClose(h);
2239 cmp = wcsncmp(data.cFileName,
2240 PyUnicode_AS_UNICODE(name),
2241 PyUnicode_GET_SIZE(name));
2242 return cmp == 0;
2243#elif defined(USE_CASE_OK_BYTES)
2244 int match;
2245 PyObject *filebytes, *namebytes;
2246 filebytes = PyUnicode_EncodeFSDefault(filename);
2247 if (filebytes == NULL)
2248 return -1;
2249 namebytes = PyUnicode_EncodeFSDefault(name);
2250 if (namebytes == NULL) {
2251 Py_DECREF(filebytes);
2252 return -1;
2253 }
2254 match = case_bytes(
2255 PyBytes_AS_STRING(filebytes),
2256 PyBytes_GET_SIZE(filebytes) + prefix_delta,
Victor Stinner1304f2d2011-03-20 04:28:55 +01002257 PyBytes_GET_SIZE(namebytes),
2258 PyBytes_AS_STRING(namebytes));
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002259 Py_DECREF(filebytes);
2260 Py_DECREF(namebytes);
2261 return match;
2262#else
2263 /* assuming it's a case-sensitive filesystem, so there's nothing to do! */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002264 return 1;
Guido van Rossum0980bd91998-02-13 17:18:36 +00002265
Guido van Rossum4d1b3b91998-02-13 23:27:59 +00002266#endif
Tim Peters50d8d372001-02-28 05:34:27 +00002267}
Guido van Rossum4d1b3b91998-02-13 23:27:59 +00002268
Guido van Rossum197346f1997-10-31 18:38:52 +00002269#ifdef HAVE_STAT
Victor Stinner4f4402c2010-08-14 14:50:26 +00002270
Victor Stinner547a2a62011-03-20 03:07:28 +01002271/* Helper to look for __init__.py or __init__.py[co] in potential package.
2272 Return 1 if __init__ was found, 0 if not, or -1 on error. */
Guido van Rossum197346f1997-10-31 18:38:52 +00002273static int
Victor Stinner547a2a62011-03-20 03:07:28 +01002274find_init_module(PyObject *directory)
Guido van Rossum197346f1997-10-31 18:38:52 +00002275{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002276 struct stat statbuf;
Victor Stinner547a2a62011-03-20 03:07:28 +01002277 PyObject *filename;
2278 int match;
Guido van Rossum197346f1997-10-31 18:38:52 +00002279
Victor Stinner547a2a62011-03-20 03:07:28 +01002280 filename = PyUnicode_FromFormat("%U%c__init__.py", directory, SEP);
2281 if (filename == NULL)
2282 return -1;
2283 if (_Py_stat(filename, &statbuf) == 0) {
Victor Stinnercc9564e2011-03-20 04:58:29 +01002284 /* 3=len(".py") */
2285 match = case_ok(filename, -3, initstr);
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002286 if (match < 0) {
2287 Py_DECREF(filename);
2288 return -1;
2289 }
2290 if (match) {
Victor Stinner547a2a62011-03-20 03:07:28 +01002291 Py_DECREF(filename);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002292 return 1;
2293 }
2294 }
Victor Stinner547a2a62011-03-20 03:07:28 +01002295 Py_DECREF(filename);
2296
2297 filename = PyUnicode_FromFormat("%U%c__init__.py%c",
2298 directory, SEP, Py_OptimizeFlag ? 'o' : 'c');
2299 if (filename == NULL)
2300 return -1;
2301 if (_Py_stat(filename, &statbuf) == 0) {
Victor Stinnercc9564e2011-03-20 04:58:29 +01002302 /* 4=len(".pyc") */
2303 match = case_ok(filename, -4, initstr);
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002304 if (match < 0) {
2305 Py_DECREF(filename);
2306 return -1;
2307 }
2308 if (match) {
Victor Stinner547a2a62011-03-20 03:07:28 +01002309 Py_DECREF(filename);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002310 return 1;
2311 }
2312 }
Victor Stinner547a2a62011-03-20 03:07:28 +01002313 Py_DECREF(filename);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002314 return 0;
Guido van Rossum197346f1997-10-31 18:38:52 +00002315}
Guido van Rossum48a680c2001-03-02 06:34:14 +00002316
Guido van Rossum197346f1997-10-31 18:38:52 +00002317#endif /* HAVE_STAT */
2318
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002319
Victor Stinner95872862011-03-07 18:20:56 +01002320static int init_builtin(PyObject *); /* Forward */
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002321
Victor Stinner44c6c152010-08-09 00:59:10 +00002322static PyObject*
Victor Stinner95872862011-03-07 18:20:56 +01002323load_builtin(PyObject *name, int type)
Victor Stinner44c6c152010-08-09 00:59:10 +00002324{
2325 PyObject *m, *modules;
2326 int err;
2327
Victor Stinner44c6c152010-08-09 00:59:10 +00002328 if (type == C_BUILTIN)
2329 err = init_builtin(name);
2330 else
Victor Stinner95872862011-03-07 18:20:56 +01002331 err = PyImport_ImportFrozenModuleObject(name);
Victor Stinner44c6c152010-08-09 00:59:10 +00002332 if (err < 0)
2333 return NULL;
2334 if (err == 0) {
2335 PyErr_Format(PyExc_ImportError,
Victor Stinner95872862011-03-07 18:20:56 +01002336 "Purported %s module %R not found",
2337 type == C_BUILTIN ? "builtin" : "frozen",
Victor Stinner44c6c152010-08-09 00:59:10 +00002338 name);
2339 return NULL;
2340 }
2341
2342 modules = PyImport_GetModuleDict();
Victor Stinner95872862011-03-07 18:20:56 +01002343 m = PyDict_GetItem(modules, name);
Victor Stinner44c6c152010-08-09 00:59:10 +00002344 if (m == NULL) {
2345 PyErr_Format(
2346 PyExc_ImportError,
Victor Stinner95872862011-03-07 18:20:56 +01002347 "%s module %R not properly initialized",
2348 type == C_BUILTIN ? "builtin" : "frozen",
Victor Stinner44c6c152010-08-09 00:59:10 +00002349 name);
2350 return NULL;
2351 }
2352 Py_INCREF(m);
2353 return m;
2354}
2355
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002356/* Load an external module using the default search path and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00002357 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002358
Guido van Rossum79f25d91997-04-29 20:08:16 +00002359static PyObject *
Victor Stinner41c5fec2011-03-13 21:46:30 -04002360load_module(PyObject *name, FILE *fp, PyObject *pathname, int type, PyObject *loader)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002361{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002362 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002363
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002364 /* First check that there's an open file (if we need one) */
2365 switch (type) {
2366 case PY_SOURCE:
2367 case PY_COMPILED:
2368 if (fp == NULL) {
2369 PyErr_Format(PyExc_ValueError,
Victor Stinner41c5fec2011-03-13 21:46:30 -04002370 "file object required for import (type code %d)",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002371 type);
2372 return NULL;
2373 }
2374 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002375
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002376 switch (type) {
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002377
Victor Stinner41c5fec2011-03-13 21:46:30 -04002378 case PY_SOURCE:
2379 m = load_source_module(name, pathname, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002380 break;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002381
Victor Stinner41c5fec2011-03-13 21:46:30 -04002382 case PY_COMPILED:
2383 m = load_compiled_module(name, pathname, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002384 break;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002385
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002386#ifdef HAVE_DYNAMIC_LOADING
Victor Stinner41c5fec2011-03-13 21:46:30 -04002387 case C_EXTENSION:
2388 m = _PyImport_LoadDynamicModule(name, pathname, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002389 break;
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002390#endif
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002391
Victor Stinner41c5fec2011-03-13 21:46:30 -04002392 case PKG_DIRECTORY:
2393 m = load_package(name, pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002394 break;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002395
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002396 case C_BUILTIN:
Victor Stinner41c5fec2011-03-13 21:46:30 -04002397 case PY_FROZEN:
2398 m = load_builtin(name, type);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002399 break;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002400
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002401 case IMP_HOOK: {
2402 if (loader == NULL) {
2403 PyErr_SetString(PyExc_ImportError,
2404 "import hook without loader");
2405 return NULL;
2406 }
Victor Stinner41c5fec2011-03-13 21:46:30 -04002407 m = PyObject_CallMethod(loader, "load_module", "O", name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002408 break;
2409 }
Just van Rossum52e14d62002-12-30 22:08:05 +00002410
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002411 default:
2412 PyErr_Format(PyExc_ImportError,
Victor Stinner98dbba52011-03-14 15:15:47 -04002413 "Don't know how to import %R (type code %d)",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002414 name, type);
2415 m = NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002416
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002417 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002418
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002419 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002420}
2421
2422
2423/* Initialize a built-in module.
Thomas Wouters89f507f2006-12-13 04:49:30 +00002424 Return 1 for success, 0 if the module is not found, and -1 with
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002425 an exception set if the initialization failed. */
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002426
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002427static int
Victor Stinner95872862011-03-07 18:20:56 +01002428init_builtin(PyObject *name)
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002429{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002430 struct _inittab *p;
Guido van Rossum25ce5661997-08-02 03:10:38 +00002431
Victor Stinner95872862011-03-07 18:20:56 +01002432 if (_PyImport_FindExtensionObject(name, name) != NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002433 return 1;
Guido van Rossum25ce5661997-08-02 03:10:38 +00002434
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002435 for (p = PyImport_Inittab; p->name != NULL; p++) {
2436 PyObject *mod;
Victor Stinner95872862011-03-07 18:20:56 +01002437 if (PyUnicode_CompareWithASCIIString(name, p->name) == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002438 if (p->initfunc == NULL) {
2439 PyErr_Format(PyExc_ImportError,
Victor Stinner95872862011-03-07 18:20:56 +01002440 "Cannot re-init internal module %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002441 name);
2442 return -1;
2443 }
2444 if (Py_VerboseFlag)
Victor Stinner95872862011-03-07 18:20:56 +01002445 PySys_FormatStderr("import %U # builtin\n", name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002446 mod = (*p->initfunc)();
2447 if (mod == 0)
2448 return -1;
Victor Stinner95872862011-03-07 18:20:56 +01002449 if (_PyImport_FixupExtensionObject(mod, name, name) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002450 return -1;
2451 /* FixupExtension has put the module into sys.modules,
2452 so we can release our own reference. */
2453 Py_DECREF(mod);
2454 return 1;
2455 }
2456 }
2457 return 0;
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002458}
Guido van Rossumf56e3db1993-04-01 20:59:32 +00002459
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002460
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002461/* Frozen modules */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002462
Guido van Rossumcfd0a221996-06-17 17:06:34 +00002463static struct _frozen *
Victor Stinner53dc7352011-03-20 01:50:21 +01002464find_frozen(PyObject *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002465{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002466 struct _frozen *p;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002467
Victor Stinner53dc7352011-03-20 01:50:21 +01002468 if (name == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002469 return NULL;
Benjamin Petersond968e272008-11-05 22:48:33 +00002470
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002471 for (p = PyImport_FrozenModules; ; p++) {
2472 if (p->name == NULL)
2473 return NULL;
Victor Stinner53dc7352011-03-20 01:50:21 +01002474 if (PyUnicode_CompareWithASCIIString(name, p->name) == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002475 break;
2476 }
2477 return p;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002478}
2479
Guido van Rossum79f25d91997-04-29 20:08:16 +00002480static PyObject *
Victor Stinner53dc7352011-03-20 01:50:21 +01002481get_frozen_object(PyObject *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002482{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002483 struct _frozen *p = find_frozen(name);
2484 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002485
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002486 if (p == NULL) {
2487 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002488 "No such frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002489 name);
2490 return NULL;
2491 }
2492 if (p->code == NULL) {
2493 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002494 "Excluded frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002495 name);
2496 return NULL;
2497 }
2498 size = p->size;
2499 if (size < 0)
2500 size = -size;
2501 return PyMarshal_ReadObjectFromString((char *)p->code, size);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002502}
2503
Brett Cannon8d110132009-03-15 02:20:16 +00002504static PyObject *
Victor Stinner53dc7352011-03-20 01:50:21 +01002505is_frozen_package(PyObject *name)
Brett Cannon8d110132009-03-15 02:20:16 +00002506{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002507 struct _frozen *p = find_frozen(name);
2508 int size;
Brett Cannon8d110132009-03-15 02:20:16 +00002509
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002510 if (p == NULL) {
2511 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002512 "No such frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002513 name);
2514 return NULL;
2515 }
Brett Cannon8d110132009-03-15 02:20:16 +00002516
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002517 size = p->size;
Brett Cannon8d110132009-03-15 02:20:16 +00002518
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002519 if (size < 0)
2520 Py_RETURN_TRUE;
2521 else
2522 Py_RETURN_FALSE;
Brett Cannon8d110132009-03-15 02:20:16 +00002523}
2524
2525
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002526/* Initialize a frozen module.
Brett Cannon3c2ac442009-03-08 20:49:47 +00002527 Return 1 for success, 0 if the module is not found, and -1 with
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002528 an exception set if the initialization failed.
2529 This function is also used from frozenmain.c */
Guido van Rossum0b344901995-02-07 15:35:27 +00002530
2531int
Victor Stinner53dc7352011-03-20 01:50:21 +01002532PyImport_ImportFrozenModuleObject(PyObject *name)
Guido van Rossumf56e3db1993-04-01 20:59:32 +00002533{
Victor Stinner53dc7352011-03-20 01:50:21 +01002534 struct _frozen *p;
2535 PyObject *co, *m, *path;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002536 int ispackage;
2537 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002538
Victor Stinner53dc7352011-03-20 01:50:21 +01002539 p = find_frozen(name);
2540
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002541 if (p == NULL)
2542 return 0;
2543 if (p->code == NULL) {
2544 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002545 "Excluded frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002546 name);
2547 return -1;
2548 }
2549 size = p->size;
2550 ispackage = (size < 0);
2551 if (ispackage)
2552 size = -size;
2553 if (Py_VerboseFlag)
Victor Stinner53dc7352011-03-20 01:50:21 +01002554 PySys_FormatStderr("import %U # frozen%s\n",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002555 name, ispackage ? " package" : "");
2556 co = PyMarshal_ReadObjectFromString((char *)p->code, size);
2557 if (co == NULL)
2558 return -1;
2559 if (!PyCode_Check(co)) {
2560 PyErr_Format(PyExc_TypeError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002561 "frozen object %R is not a code object",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002562 name);
2563 goto err_return;
2564 }
2565 if (ispackage) {
2566 /* Set __path__ to the package name */
Victor Stinner53dc7352011-03-20 01:50:21 +01002567 PyObject *d, *l;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002568 int err;
Victor Stinner53dc7352011-03-20 01:50:21 +01002569 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002570 if (m == NULL)
2571 goto err_return;
2572 d = PyModule_GetDict(m);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002573 l = PyList_New(1);
2574 if (l == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002575 goto err_return;
2576 }
Victor Stinner53dc7352011-03-20 01:50:21 +01002577 Py_INCREF(name);
2578 PyList_SET_ITEM(l, 0, name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002579 err = PyDict_SetItemString(d, "__path__", l);
2580 Py_DECREF(l);
2581 if (err != 0)
2582 goto err_return;
2583 }
Victor Stinner53dc7352011-03-20 01:50:21 +01002584 path = PyUnicode_FromString("<frozen>");
2585 if (path == NULL)
2586 goto err_return;
2587 m = PyImport_ExecCodeModuleObject(name, co, path, NULL);
2588 Py_DECREF(path);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002589 if (m == NULL)
2590 goto err_return;
2591 Py_DECREF(co);
2592 Py_DECREF(m);
2593 return 1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002594err_return:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002595 Py_DECREF(co);
2596 return -1;
Guido van Rossumf56e3db1993-04-01 20:59:32 +00002597}
Guido van Rossum74e6a111994-08-29 12:54:38 +00002598
Victor Stinner53dc7352011-03-20 01:50:21 +01002599int
2600PyImport_ImportFrozenModule(char *name)
2601{
2602 PyObject *nameobj;
2603 int ret;
2604 nameobj = PyUnicode_InternFromString(name);
2605 if (nameobj == NULL)
2606 return -1;
2607 ret = PyImport_ImportFrozenModuleObject(nameobj);
2608 Py_DECREF(nameobj);
2609 return ret;
2610}
2611
Guido van Rossum74e6a111994-08-29 12:54:38 +00002612
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002613/* Import a module, either built-in, frozen, or external, and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00002614 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum74e6a111994-08-29 12:54:38 +00002615
Guido van Rossum79f25d91997-04-29 20:08:16 +00002616PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00002617PyImport_ImportModule(const char *name)
Guido van Rossum74e6a111994-08-29 12:54:38 +00002618{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002619 PyObject *pname;
2620 PyObject *result;
Marc-André Lemburg3c61c352001-02-09 19:40:15 +00002621
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002622 pname = PyUnicode_FromString(name);
2623 if (pname == NULL)
2624 return NULL;
2625 result = PyImport_Import(pname);
2626 Py_DECREF(pname);
2627 return result;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002628}
2629
Christian Heimes072c0f12008-01-03 23:01:04 +00002630/* Import a module without blocking
2631 *
2632 * At first it tries to fetch the module from sys.modules. If the module was
2633 * never loaded before it loads it with PyImport_ImportModule() unless another
2634 * thread holds the import lock. In the latter case the function raises an
2635 * ImportError instead of blocking.
2636 *
2637 * Returns the module object with incremented ref count.
2638 */
2639PyObject *
2640PyImport_ImportModuleNoBlock(const char *name)
2641{
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002642 PyObject *nameobj, *modules, *result;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002643 long me;
Christian Heimes072c0f12008-01-03 23:01:04 +00002644
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002645 /* Try to get the module from sys.modules[name] */
2646 modules = PyImport_GetModuleDict();
2647 if (modules == NULL)
2648 return NULL;
Christian Heimes072c0f12008-01-03 23:01:04 +00002649
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002650 nameobj = PyUnicode_FromString(name);
2651 if (nameobj == NULL)
2652 return NULL;
2653 result = PyDict_GetItem(modules, nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002654 if (result != NULL) {
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002655 Py_DECREF(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002656 Py_INCREF(result);
2657 return result;
2658 }
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002659 PyErr_Clear();
Benjamin Peterson3e4f0552008-09-02 00:31:15 +00002660#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002661 /* check the import lock
2662 * me might be -1 but I ignore the error here, the lock function
2663 * takes care of the problem */
2664 me = PyThread_get_thread_ident();
2665 if (import_lock_thread == -1 || import_lock_thread == me) {
2666 /* no thread or me is holding the lock */
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002667 result = PyImport_Import(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002668 }
2669 else {
2670 PyErr_Format(PyExc_ImportError,
Victor Stinnerc24c8102011-03-13 22:38:06 -04002671 "Failed to import %R because the import lock"
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002672 "is held by another thread.",
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002673 nameobj);
2674 result = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002675 }
Benjamin Peterson3e4f0552008-09-02 00:31:15 +00002676#else
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002677 result = PyImport_Import(nameobj);
Benjamin Peterson3e4f0552008-09-02 00:31:15 +00002678#endif
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002679 Py_DECREF(nameobj);
2680 return result;
Christian Heimes072c0f12008-01-03 23:01:04 +00002681}
2682
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002683/* Forward declarations for helper routines */
Victor Stinner974389d2011-03-15 09:33:57 +01002684static PyObject *get_parent(PyObject *globals,
2685 PyObject **p_name,
2686 int level);
Tim Petersdbd9ba62000-07-09 03:09:57 +00002687static PyObject *load_next(PyObject *mod, PyObject *altmod,
Victor Stinner974389d2011-03-15 09:33:57 +01002688 PyObject *inputname, PyObject **p_outputname,
2689 Py_UNICODE *buf, Py_ssize_t *p_buflen,
2690 Py_ssize_t bufsize);
2691static int mark_miss(PyObject *name);
Tim Petersdbd9ba62000-07-09 03:09:57 +00002692static int ensure_fromlist(PyObject *mod, PyObject *fromlist,
Victor Stinner974389d2011-03-15 09:33:57 +01002693 PyObject *buf, int recursive);
2694static PyObject * import_submodule(PyObject *mod, PyObject *name,
2695 PyObject *fullname);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002696
2697/* The Magnum Opus of dotted-name import :-) */
2698
Guido van Rossum75acc9c1998-03-03 22:26:50 +00002699static PyObject *
Victor Stinner974389d2011-03-15 09:33:57 +01002700import_module_level(PyObject *name, PyObject *globals, PyObject *locals,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002701 PyObject *fromlist, int level)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002702{
Victor Stinner974389d2011-03-15 09:33:57 +01002703 Py_UNICODE buf[MAXPATHLEN+1];
2704 Py_ssize_t buflen;
2705 Py_ssize_t bufsize = MAXPATHLEN+1;
2706 PyObject *parent, *head, *next, *tail, *inputname, *outputname;
2707 PyObject *parent_name, *ensure_name;
2708 const Py_UNICODE *nameunicode;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002709
Victor Stinner974389d2011-03-15 09:33:57 +01002710 nameunicode = PyUnicode_AS_UNICODE(name);
2711
2712 if (Py_UNICODE_strchr(nameunicode, SEP) != NULL
2713#ifdef ALTSEP
2714 || Py_UNICODE_strchr(nameunicode, ALTSEP) != NULL
Christian Heimes454f37b2008-01-10 00:10:02 +00002715#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002716 ) {
2717 PyErr_SetString(PyExc_ImportError,
2718 "Import by filename is not supported.");
2719 return NULL;
2720 }
Christian Heimes454f37b2008-01-10 00:10:02 +00002721
Victor Stinner974389d2011-03-15 09:33:57 +01002722 parent = get_parent(globals, &parent_name, level);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002723 if (parent == NULL)
2724 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002725
Victor Stinner974389d2011-03-15 09:33:57 +01002726 buflen = PyUnicode_GET_SIZE(parent_name);
2727 if (buflen+1 > bufsize) {
2728 Py_DECREF(parent_name);
2729 PyErr_SetString(PyExc_ValueError,
2730 "Module name too long");
2731 return NULL;
2732 }
2733 Py_UNICODE_strcpy(buf, PyUnicode_AS_UNICODE(parent_name));
2734 Py_DECREF(parent_name);
2735
2736 head = load_next(parent, level < 0 ? Py_None : parent, name, &outputname,
2737 buf, &buflen, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002738 if (head == NULL)
2739 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002740
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002741 tail = head;
2742 Py_INCREF(tail);
Victor Stinner974389d2011-03-15 09:33:57 +01002743
2744 if (outputname != NULL) {
2745 while (1) {
2746 inputname = outputname;
2747 next = load_next(tail, tail, inputname, &outputname,
2748 buf, &buflen, bufsize);
2749 Py_DECREF(tail);
2750 Py_DECREF(inputname);
2751 if (next == NULL) {
2752 Py_DECREF(head);
2753 return NULL;
2754 }
2755 tail = next;
2756
2757 if (outputname == NULL) {
2758 break;
2759 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002760 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002761 }
2762 if (tail == Py_None) {
2763 /* If tail is Py_None, both get_parent and load_next found
2764 an empty module name: someone called __import__("") or
2765 doctored faulty bytecode */
2766 Py_DECREF(tail);
2767 Py_DECREF(head);
Victor Stinner974389d2011-03-15 09:33:57 +01002768 PyErr_SetString(PyExc_ValueError, "Empty module name");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002769 return NULL;
2770 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002771
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002772 if (fromlist != NULL) {
2773 if (fromlist == Py_None || !PyObject_IsTrue(fromlist))
2774 fromlist = NULL;
2775 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002776
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002777 if (fromlist == NULL) {
2778 Py_DECREF(tail);
2779 return head;
2780 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002781
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002782 Py_DECREF(head);
Victor Stinner974389d2011-03-15 09:33:57 +01002783
2784 ensure_name = PyUnicode_FromUnicode(buf, Py_UNICODE_strlen(buf));
2785 if (ensure_name == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002786 Py_DECREF(tail);
2787 return NULL;
2788 }
Victor Stinner974389d2011-03-15 09:33:57 +01002789 if (!ensure_fromlist(tail, fromlist, ensure_name, 0)) {
2790 Py_DECREF(tail);
2791 Py_DECREF(ensure_name);
2792 return NULL;
2793 }
2794 Py_DECREF(ensure_name);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002795
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002796 return tail;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002797}
2798
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002799PyObject *
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002800PyImport_ImportModuleLevelObject(PyObject *name, PyObject *globals,
2801 PyObject *locals, PyObject *fromlist,
2802 int level)
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002803{
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002804 PyObject *mod;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002805 _PyImport_AcquireLock();
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002806 mod = import_module_level(name, globals, locals, fromlist, level);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002807 if (_PyImport_ReleaseLock() < 0) {
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002808 Py_XDECREF(mod);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002809 PyErr_SetString(PyExc_RuntimeError,
2810 "not holding the import lock");
2811 return NULL;
2812 }
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002813 return mod;
Guido van Rossum75acc9c1998-03-03 22:26:50 +00002814}
2815
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002816PyObject *
Benjamin Peterson04778a82011-05-25 09:29:00 -05002817PyImport_ImportModuleLevel(const char *name, PyObject *globals, PyObject *locals,
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002818 PyObject *fromlist, int level)
2819{
2820 PyObject *nameobj, *mod;
2821 nameobj = PyUnicode_FromString(name);
2822 if (nameobj == NULL)
2823 return NULL;
2824 mod = PyImport_ImportModuleLevelObject(nameobj, globals, locals,
2825 fromlist, level);
2826 Py_DECREF(nameobj);
2827 return mod;
2828}
2829
2830
Fred Drake87590902004-05-28 20:21:36 +00002831/* Return the package that an import is being performed in. If globals comes
2832 from the module foo.bar.bat (not itself a package), this returns the
2833 sys.modules entry for foo.bar. If globals is from a package's __init__.py,
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00002834 the package's entry in sys.modules is returned, as a borrowed reference.
Fred Drake87590902004-05-28 20:21:36 +00002835
Victor Stinner974389d2011-03-15 09:33:57 +01002836 The name of the returned package is returned in *p_name.
Fred Drake87590902004-05-28 20:21:36 +00002837
2838 If globals doesn't come from a package or a module in a package, or a
2839 corresponding entry is not found in sys.modules, Py_None is returned.
2840*/
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002841static PyObject *
Victor Stinner9599de52011-03-13 22:38:38 -04002842get_parent(PyObject *globals, PyObject **p_name, int level)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002843{
Victor Stinner974389d2011-03-15 09:33:57 +01002844 Py_UNICODE name[MAXPATHLEN+1];
2845 const Py_ssize_t bufsize = MAXPATHLEN+1;
2846 PyObject *nameobj;
2847
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002848 static PyObject *namestr = NULL;
2849 static PyObject *pathstr = NULL;
2850 static PyObject *pkgstr = NULL;
2851 PyObject *pkgname, *modname, *modpath, *modules, *parent;
2852 int orig_level = level;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002853
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002854 if (globals == NULL || !PyDict_Check(globals) || !level)
Victor Stinner974389d2011-03-15 09:33:57 +01002855 goto return_none;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002856
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002857 if (namestr == NULL) {
2858 namestr = PyUnicode_InternFromString("__name__");
2859 if (namestr == NULL)
2860 return NULL;
2861 }
2862 if (pathstr == NULL) {
2863 pathstr = PyUnicode_InternFromString("__path__");
2864 if (pathstr == NULL)
2865 return NULL;
2866 }
2867 if (pkgstr == NULL) {
2868 pkgstr = PyUnicode_InternFromString("__package__");
2869 if (pkgstr == NULL)
2870 return NULL;
2871 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002872
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002873 pkgname = PyDict_GetItem(globals, pkgstr);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002874
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002875 if ((pkgname != NULL) && (pkgname != Py_None)) {
2876 /* __package__ is set, so use it */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002877 if (!PyUnicode_Check(pkgname)) {
2878 PyErr_SetString(PyExc_ValueError,
2879 "__package__ set to non-string");
2880 return NULL;
2881 }
Victor Stinner974389d2011-03-15 09:33:57 +01002882 if (PyUnicode_GET_SIZE(pkgname) == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002883 if (level > 0) {
2884 PyErr_SetString(PyExc_ValueError,
2885 "Attempted relative import in non-package");
2886 return NULL;
2887 }
Victor Stinner974389d2011-03-15 09:33:57 +01002888 goto return_none;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002889 }
Victor Stinner974389d2011-03-15 09:33:57 +01002890 if (PyUnicode_GET_SIZE(pkgname)+1 > bufsize) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002891 PyErr_SetString(PyExc_ValueError,
2892 "Package name too long");
2893 return NULL;
2894 }
Victor Stinner974389d2011-03-15 09:33:57 +01002895 Py_UNICODE_strcpy(name, PyUnicode_AS_UNICODE(pkgname));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002896 } else {
2897 /* __package__ not set, so figure it out and set it */
2898 modname = PyDict_GetItem(globals, namestr);
2899 if (modname == NULL || !PyUnicode_Check(modname))
Victor Stinner974389d2011-03-15 09:33:57 +01002900 goto return_none;
Brett Cannon9a5b25a2010-03-01 02:09:17 +00002901
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002902 modpath = PyDict_GetItem(globals, pathstr);
2903 if (modpath != NULL) {
2904 /* __path__ is set, so modname is already the package name */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002905 int error;
Alexandre Vassalottia85998a2008-05-03 18:24:43 +00002906
Victor Stinner974389d2011-03-15 09:33:57 +01002907 if (PyUnicode_GET_SIZE(modname)+1 > bufsize) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002908 PyErr_SetString(PyExc_ValueError,
2909 "Module name too long");
2910 return NULL;
2911 }
Victor Stinner974389d2011-03-15 09:33:57 +01002912 Py_UNICODE_strcpy(name, PyUnicode_AS_UNICODE(modname));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002913 error = PyDict_SetItem(globals, pkgstr, modname);
2914 if (error) {
2915 PyErr_SetString(PyExc_ValueError,
2916 "Could not set __package__");
2917 return NULL;
2918 }
2919 } else {
2920 /* Normal module, so work out the package name if any */
Victor Stinner974389d2011-03-15 09:33:57 +01002921 Py_UNICODE *start = PyUnicode_AS_UNICODE(modname);
2922 Py_UNICODE *lastdot = Py_UNICODE_strrchr(start, '.');
2923 Py_ssize_t len;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002924 int error;
2925 if (lastdot == NULL && level > 0) {
2926 PyErr_SetString(PyExc_ValueError,
2927 "Attempted relative import in non-package");
2928 return NULL;
2929 }
2930 if (lastdot == NULL) {
2931 error = PyDict_SetItem(globals, pkgstr, Py_None);
2932 if (error) {
2933 PyErr_SetString(PyExc_ValueError,
2934 "Could not set __package__");
2935 return NULL;
2936 }
Victor Stinner974389d2011-03-15 09:33:57 +01002937 goto return_none;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002938 }
2939 len = lastdot - start;
Victor Stinner974389d2011-03-15 09:33:57 +01002940 if (len+1 > bufsize) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002941 PyErr_SetString(PyExc_ValueError,
2942 "Module name too long");
2943 return NULL;
2944 }
Victor Stinner974389d2011-03-15 09:33:57 +01002945 Py_UNICODE_strncpy(name, start, len);
2946 name[len] = '\0';
2947 pkgname = PyUnicode_FromUnicode(name, len);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002948 if (pkgname == NULL) {
2949 return NULL;
2950 }
2951 error = PyDict_SetItem(globals, pkgstr, pkgname);
2952 Py_DECREF(pkgname);
2953 if (error) {
2954 PyErr_SetString(PyExc_ValueError,
2955 "Could not set __package__");
2956 return NULL;
2957 }
2958 }
2959 }
2960 while (--level > 0) {
Victor Stinner974389d2011-03-15 09:33:57 +01002961 Py_UNICODE *dot = Py_UNICODE_strrchr(name, '.');
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002962 if (dot == NULL) {
2963 PyErr_SetString(PyExc_ValueError,
2964 "Attempted relative import beyond "
2965 "toplevel package");
2966 return NULL;
2967 }
2968 *dot = '\0';
2969 }
Victor Stinner974389d2011-03-15 09:33:57 +01002970
2971 nameobj = PyUnicode_FromUnicode(name, Py_UNICODE_strlen(name));
2972 if (nameobj == NULL)
2973 return NULL;
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002974
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002975 modules = PyImport_GetModuleDict();
Victor Stinner974389d2011-03-15 09:33:57 +01002976 parent = PyDict_GetItem(modules, nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002977 if (parent == NULL) {
Victor Stinner974389d2011-03-15 09:33:57 +01002978 int err;
2979
2980 if (orig_level >= 1) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002981 PyErr_Format(PyExc_SystemError,
Victor Stinner974389d2011-03-15 09:33:57 +01002982 "Parent module %R not loaded, "
2983 "cannot perform relative import", nameobj);
2984 Py_DECREF(nameobj);
2985 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002986 }
Victor Stinner974389d2011-03-15 09:33:57 +01002987
2988 err = PyErr_WarnFormat(
2989 PyExc_RuntimeWarning, 1,
2990 "Parent module %R not found while handling absolute import",
2991 nameobj);
2992 Py_DECREF(nameobj);
2993 if (err)
2994 return NULL;
2995
2996 goto return_none;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002997 }
Victor Stinner974389d2011-03-15 09:33:57 +01002998 *p_name = nameobj;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002999 return parent;
3000 /* We expect, but can't guarantee, if parent != None, that:
Victor Stinner974389d2011-03-15 09:33:57 +01003001 - parent.__name__ == name
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003002 - parent.__dict__ is globals
3003 If this is violated... Who cares? */
Victor Stinner974389d2011-03-15 09:33:57 +01003004
3005return_none:
3006 nameobj = PyUnicode_FromUnicode(NULL, 0);
3007 if (nameobj == NULL)
3008 return NULL;
3009 *p_name = nameobj;
3010 return Py_None;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003011}
3012
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003013/* altmod is either None or same as mod */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003014static PyObject *
Victor Stinner974389d2011-03-15 09:33:57 +01003015load_next(PyObject *mod, PyObject *altmod,
3016 PyObject *inputname, PyObject **p_outputname,
3017 Py_UNICODE *buf, Py_ssize_t *p_buflen, Py_ssize_t bufsize)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003018{
Victor Stinner974389d2011-03-15 09:33:57 +01003019 const Py_UNICODE *dot;
3020 Py_ssize_t len;
3021 Py_UNICODE *p;
3022 PyObject *fullname, *name, *result, *mark_name;
3023 const Py_UNICODE *nameuni;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003024
Victor Stinner974389d2011-03-15 09:33:57 +01003025 *p_outputname = NULL;
3026
3027 if (PyUnicode_GET_SIZE(inputname) == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003028 /* completely empty module name should only happen in
3029 'from . import' (or '__import__("")')*/
3030 Py_INCREF(mod);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003031 return mod;
3032 }
Thomas Woutersf7f438b2006-02-28 16:09:29 +00003033
Victor Stinner974389d2011-03-15 09:33:57 +01003034 nameuni = PyUnicode_AS_UNICODE(inputname);
3035 if (nameuni == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003036 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003037
Victor Stinner974389d2011-03-15 09:33:57 +01003038 dot = Py_UNICODE_strchr(nameuni, '.');
3039 if (dot != NULL) {
3040 len = dot - nameuni;
3041 if (len == 0) {
3042 PyErr_SetString(PyExc_ValueError,
3043 "Empty module name");
3044 return NULL;
3045 }
3046 }
3047 else
3048 len = PyUnicode_GET_SIZE(inputname);
3049
3050 if (*p_buflen+len+1 >= bufsize) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003051 PyErr_SetString(PyExc_ValueError,
3052 "Module name too long");
3053 return NULL;
3054 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003055
Victor Stinner974389d2011-03-15 09:33:57 +01003056 p = buf + *p_buflen;
3057 if (p != buf) {
3058 *p++ = '.';
3059 *p_buflen += 1;
3060 }
3061 Py_UNICODE_strncpy(p, nameuni, len);
3062 p[len] = '\0';
3063 *p_buflen += len;
3064
3065 fullname = PyUnicode_FromUnicode(buf, *p_buflen);
3066 if (fullname == NULL)
3067 return NULL;
3068 name = PyUnicode_FromUnicode(p, len);
3069 if (name == NULL) {
3070 Py_DECREF(fullname);
3071 return NULL;
3072 }
3073 result = import_submodule(mod, name, fullname);
3074 Py_DECREF(fullname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003075 if (result == Py_None && altmod != mod) {
3076 Py_DECREF(result);
3077 /* Here, altmod must be None and mod must not be None */
Victor Stinner974389d2011-03-15 09:33:57 +01003078 result = import_submodule(altmod, name, name);
3079 Py_DECREF(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003080 if (result != NULL && result != Py_None) {
Victor Stinner974389d2011-03-15 09:33:57 +01003081 mark_name = PyUnicode_FromUnicode(buf, *p_buflen);
3082 if (mark_name == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003083 Py_DECREF(result);
3084 return NULL;
3085 }
Victor Stinner974389d2011-03-15 09:33:57 +01003086 if (mark_miss(mark_name) != 0) {
3087 Py_DECREF(result);
3088 Py_DECREF(mark_name);
3089 return NULL;
3090 }
3091 Py_DECREF(mark_name);
3092 Py_UNICODE_strncpy(buf, nameuni, len);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003093 buf[len] = '\0';
3094 *p_buflen = len;
3095 }
3096 }
Victor Stinner974389d2011-03-15 09:33:57 +01003097 else
3098 Py_DECREF(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003099 if (result == NULL)
3100 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003101
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003102 if (result == Py_None) {
3103 Py_DECREF(result);
3104 PyErr_Format(PyExc_ImportError,
Victor Stinner974389d2011-03-15 09:33:57 +01003105 "No module named %R", inputname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003106 return NULL;
3107 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003108
Victor Stinner974389d2011-03-15 09:33:57 +01003109 if (dot != NULL) {
3110 *p_outputname = PyUnicode_FromUnicode(dot+1, Py_UNICODE_strlen(dot+1));
3111 if (*p_outputname == NULL) {
3112 Py_DECREF(result);
3113 return NULL;
3114 }
3115 }
3116
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003117 return result;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003118}
3119
3120static int
Victor Stinner974389d2011-03-15 09:33:57 +01003121mark_miss(PyObject *name)
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00003122{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003123 PyObject *modules = PyImport_GetModuleDict();
Victor Stinner974389d2011-03-15 09:33:57 +01003124 return PyDict_SetItem(modules, name, Py_None);
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00003125}
3126
3127static int
Victor Stinner974389d2011-03-15 09:33:57 +01003128ensure_fromlist(PyObject *mod, PyObject *fromlist, PyObject *name,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003129 int recursive)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003130{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003131 int i;
Victor Stinner974389d2011-03-15 09:33:57 +01003132 PyObject *fullname;
3133 Py_ssize_t fromlist_len;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003134
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003135 if (!PyObject_HasAttrString(mod, "__path__"))
3136 return 1;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003137
Victor Stinner974389d2011-03-15 09:33:57 +01003138 fromlist_len = PySequence_Size(fromlist);
3139
3140 for (i = 0; i < fromlist_len; i++) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003141 PyObject *item = PySequence_GetItem(fromlist, i);
3142 int hasit;
Victor Stinner974389d2011-03-15 09:33:57 +01003143 if (item == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003144 return 0;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003145 if (!PyUnicode_Check(item)) {
3146 PyErr_SetString(PyExc_TypeError,
3147 "Item in ``from list'' not a string");
3148 Py_DECREF(item);
3149 return 0;
3150 }
3151 if (PyUnicode_AS_UNICODE(item)[0] == '*') {
3152 PyObject *all;
3153 Py_DECREF(item);
3154 /* See if the package defines __all__ */
3155 if (recursive)
3156 continue; /* Avoid endless recursion */
3157 all = PyObject_GetAttrString(mod, "__all__");
3158 if (all == NULL)
3159 PyErr_Clear();
3160 else {
Victor Stinner974389d2011-03-15 09:33:57 +01003161 int ret = ensure_fromlist(mod, all, name, 1);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003162 Py_DECREF(all);
3163 if (!ret)
3164 return 0;
3165 }
3166 continue;
3167 }
3168 hasit = PyObject_HasAttr(mod, item);
3169 if (!hasit) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003170 PyObject *submod;
Victor Stinner974389d2011-03-15 09:33:57 +01003171 fullname = PyUnicode_FromFormat("%U.%U", name, item);
3172 if (fullname != NULL) {
3173 submod = import_submodule(mod, item, fullname);
3174 Py_DECREF(fullname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003175 }
Victor Stinner974389d2011-03-15 09:33:57 +01003176 else
3177 submod = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003178 Py_XDECREF(submod);
3179 if (submod == NULL) {
3180 Py_DECREF(item);
3181 return 0;
3182 }
3183 }
3184 Py_DECREF(item);
3185 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003186
Victor Stinner974389d2011-03-15 09:33:57 +01003187 return 1;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003188}
3189
Neil Schemenauer00b09662003-06-16 21:03:07 +00003190static int
Victor Stinner974389d2011-03-15 09:33:57 +01003191add_submodule(PyObject *mod, PyObject *submod, PyObject *fullname,
3192 PyObject *subname, PyObject *modules)
Neil Schemenauer00b09662003-06-16 21:03:07 +00003193{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003194 if (mod == Py_None)
3195 return 1;
3196 /* Irrespective of the success of this load, make a
3197 reference to it in the parent package module. A copy gets
3198 saved in the modules dictionary under the full name, so get a
3199 reference from there, if need be. (The exception is when the
3200 load failed with a SyntaxError -- then there's no trace in
3201 sys.modules. In that case, of course, do nothing extra.) */
3202 if (submod == NULL) {
Victor Stinner974389d2011-03-15 09:33:57 +01003203 submod = PyDict_GetItem(modules, fullname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003204 if (submod == NULL)
3205 return 1;
3206 }
3207 if (PyModule_Check(mod)) {
3208 /* We can't use setattr here since it can give a
3209 * spurious warning if the submodule name shadows a
3210 * builtin name */
3211 PyObject *dict = PyModule_GetDict(mod);
3212 if (!dict)
3213 return 0;
Victor Stinner974389d2011-03-15 09:33:57 +01003214 if (PyDict_SetItem(dict, subname, submod) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003215 return 0;
3216 }
3217 else {
Victor Stinner974389d2011-03-15 09:33:57 +01003218 if (PyObject_SetAttr(mod, subname, submod) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003219 return 0;
3220 }
3221 return 1;
Neil Schemenauer00b09662003-06-16 21:03:07 +00003222}
3223
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003224static PyObject *
Victor Stinner974389d2011-03-15 09:33:57 +01003225import_submodule(PyObject *mod, PyObject *subname, PyObject *fullname)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003226{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003227 PyObject *modules = PyImport_GetModuleDict();
Victor Stinner533d7832011-03-14 13:22:54 -04003228 PyObject *m = NULL, *bufobj, *path_list, *loader;
Victor Stinner9599de52011-03-13 22:38:38 -04003229 struct filedescr *fdp;
3230 FILE *fp;
Guido van Rossum74e6a111994-08-29 12:54:38 +00003231
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003232 /* Require:
3233 if mod == None: subname == fullname
3234 else: mod.__name__ + "." + subname == fullname
3235 */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003236
Victor Stinner974389d2011-03-15 09:33:57 +01003237 if ((m = PyDict_GetItem(modules, fullname)) != NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003238 Py_INCREF(m);
Victor Stinner9599de52011-03-13 22:38:38 -04003239 return m;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003240 }
Victor Stinner9599de52011-03-13 22:38:38 -04003241
3242 if (mod == Py_None)
Victor Stinner533d7832011-03-14 13:22:54 -04003243 path_list = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003244 else {
Victor Stinner533d7832011-03-14 13:22:54 -04003245 path_list = PyObject_GetAttrString(mod, "__path__");
3246 if (path_list == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003247 PyErr_Clear();
3248 Py_INCREF(Py_None);
3249 return Py_None;
3250 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003251 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003252
Victor Stinner533d7832011-03-14 13:22:54 -04003253 fdp = find_module(fullname, subname, path_list,
Victor Stinner2fd76e42011-03-14 15:19:39 -04003254 &bufobj, &fp, &loader);
Victor Stinner533d7832011-03-14 13:22:54 -04003255 Py_XDECREF(path_list);
Victor Stinner9599de52011-03-13 22:38:38 -04003256 if (fdp == NULL) {
3257 if (!PyErr_ExceptionMatches(PyExc_ImportError))
3258 return NULL;
3259 PyErr_Clear();
3260 Py_INCREF(Py_None);
3261 return Py_None;
3262 }
Victor Stinner2fd76e42011-03-14 15:19:39 -04003263 m = load_module(fullname, fp, bufobj, fdp->type, loader);
3264 Py_XDECREF(bufobj);
Victor Stinner9599de52011-03-13 22:38:38 -04003265 Py_XDECREF(loader);
3266 if (fp)
3267 fclose(fp);
3268 if (m == NULL)
3269 return NULL;
3270 if (!add_submodule(mod, m, fullname, subname, modules)) {
3271 Py_XDECREF(m);
3272 return NULL;
3273 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003274 return m;
Guido van Rossum74e6a111994-08-29 12:54:38 +00003275}
3276
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003277
3278/* Re-import a module of any kind and return its module object, WITH
3279 INCREMENTED REFERENCE COUNT */
3280
Guido van Rossum79f25d91997-04-29 20:08:16 +00003281PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003282PyImport_ReloadModule(PyObject *m)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003283{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003284 PyInterpreterState *interp = PyThreadState_Get()->interp;
3285 PyObject *modules_reloading = interp->modules_reloading;
3286 PyObject *modules = PyImport_GetModuleDict();
Victor Stinner533d7832011-03-14 13:22:54 -04003287 PyObject *path_list = NULL, *loader = NULL, *existing_m = NULL;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003288 PyObject *nameobj, *bufobj, *subnameobj;
3289 Py_UNICODE *name, *subname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003290 struct filedescr *fdp;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003291 FILE *fp = NULL;
3292 PyObject *newm = NULL;
Brett Cannon9a5b25a2010-03-01 02:09:17 +00003293
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003294 if (modules_reloading == NULL) {
3295 Py_FatalError("PyImport_ReloadModule: "
3296 "no modules_reloading dictionary!");
3297 return NULL;
3298 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003299
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003300 if (m == NULL || !PyModule_Check(m)) {
3301 PyErr_SetString(PyExc_TypeError,
3302 "reload() argument must be module");
3303 return NULL;
3304 }
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003305 nameobj = PyModule_GetNameObject(m);
3306 if (nameobj == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003307 return NULL;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003308 if (m != PyDict_GetItem(modules, nameobj)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003309 PyErr_Format(PyExc_ImportError,
Victor Stinner98dbba52011-03-14 15:15:47 -04003310 "reload(): module %R not in sys.modules",
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003311 nameobj);
3312 Py_DECREF(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003313 return NULL;
3314 }
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003315 existing_m = PyDict_GetItem(modules_reloading, nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003316 if (existing_m != NULL) {
3317 /* Due to a recursive reload, this module is already
3318 being reloaded. */
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003319 Py_DECREF(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003320 Py_INCREF(existing_m);
3321 return existing_m;
3322 }
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003323 if (PyDict_SetItem(modules_reloading, nameobj, m) < 0) {
3324 Py_DECREF(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003325 return NULL;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003326 }
Guido van Rossumd8faa362007-04-27 19:54:29 +00003327
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003328 name = PyUnicode_AS_UNICODE(nameobj);
3329 subname = Py_UNICODE_strrchr(name, '.');
3330 if (subname == NULL) {
3331 Py_INCREF(nameobj);
3332 subnameobj = nameobj;
3333 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003334 else {
3335 PyObject *parentname, *parent;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003336 Py_ssize_t len;
3337 len = subname - name;
3338 parentname = PyUnicode_FromUnicode(name, len);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003339 if (parentname == NULL) {
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003340 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003341 }
3342 parent = PyDict_GetItem(modules, parentname);
3343 if (parent == NULL) {
3344 PyErr_Format(PyExc_ImportError,
Victor Stinner98dbba52011-03-14 15:15:47 -04003345 "reload(): parent %R not in sys.modules",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003346 parentname);
3347 Py_DECREF(parentname);
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003348 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003349 }
3350 Py_DECREF(parentname);
Victor Stinner533d7832011-03-14 13:22:54 -04003351 path_list = PyObject_GetAttrString(parent, "__path__");
3352 if (path_list == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003353 PyErr_Clear();
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003354 subname++;
3355 len = PyUnicode_GET_SIZE(nameobj) - (len + 1);
3356 subnameobj = PyUnicode_FromUnicode(subname, len);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003357 }
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003358 if (subnameobj == NULL)
3359 goto error;
Victor Stinner533d7832011-03-14 13:22:54 -04003360 fdp = find_module(nameobj, subnameobj, path_list,
Victor Stinner2fd76e42011-03-14 15:19:39 -04003361 &bufobj, &fp, &loader);
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003362 Py_DECREF(subnameobj);
Victor Stinner533d7832011-03-14 13:22:54 -04003363 Py_XDECREF(path_list);
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00003364
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003365 if (fdp == NULL) {
3366 Py_XDECREF(loader);
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003367 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003368 }
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00003369
Victor Stinner2fd76e42011-03-14 15:19:39 -04003370 newm = load_module(nameobj, fp, bufobj, fdp->type, loader);
3371 Py_XDECREF(bufobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003372 Py_XDECREF(loader);
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00003373
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003374 if (fp)
3375 fclose(fp);
3376 if (newm == NULL) {
3377 /* load_module probably removed name from modules because of
3378 * the error. Put back the original module object. We're
3379 * going to return NULL in this case regardless of whether
3380 * replacing name succeeds, so the return value is ignored.
3381 */
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003382 PyDict_SetItem(modules, nameobj, m);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003383 }
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003384
3385error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003386 imp_modules_reloading_clear();
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003387 Py_DECREF(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003388 return newm;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003389}
3390
3391
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003392/* Higher-level import emulator which emulates the "import" statement
3393 more accurately -- it invokes the __import__() function from the
3394 builtins of the current globals. This means that the import is
3395 done using whatever import hooks are installed in the current
Brett Cannonbc2eff32010-09-19 21:39:02 +00003396 environment.
Guido van Rossum6058eb41998-12-21 19:51:00 +00003397 A dummy list ["__doc__"] is passed as the 4th argument so that
Neal Norwitz80e7f272007-08-26 06:45:23 +00003398 e.g. PyImport_Import(PyUnicode_FromString("win32com.client.gencache"))
Guido van Rossum6058eb41998-12-21 19:51:00 +00003399 will return <module "gencache"> instead of <module "win32com">. */
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003400
3401PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003402PyImport_Import(PyObject *module_name)
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003403{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003404 static PyObject *silly_list = NULL;
3405 static PyObject *builtins_str = NULL;
3406 static PyObject *import_str = NULL;
3407 PyObject *globals = NULL;
3408 PyObject *import = NULL;
3409 PyObject *builtins = NULL;
Brett Cannonbc2eff32010-09-19 21:39:02 +00003410 PyObject *modules = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003411 PyObject *r = NULL;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003412
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003413 /* Initialize constant string objects */
3414 if (silly_list == NULL) {
3415 import_str = PyUnicode_InternFromString("__import__");
3416 if (import_str == NULL)
3417 return NULL;
3418 builtins_str = PyUnicode_InternFromString("__builtins__");
3419 if (builtins_str == NULL)
3420 return NULL;
Brett Cannonbc2eff32010-09-19 21:39:02 +00003421 silly_list = PyList_New(0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003422 if (silly_list == NULL)
3423 return NULL;
3424 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003425
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003426 /* Get the builtins from current globals */
3427 globals = PyEval_GetGlobals();
3428 if (globals != NULL) {
3429 Py_INCREF(globals);
3430 builtins = PyObject_GetItem(globals, builtins_str);
3431 if (builtins == NULL)
3432 goto err;
3433 }
3434 else {
3435 /* No globals -- use standard builtins, and fake globals */
3436 builtins = PyImport_ImportModuleLevel("builtins",
3437 NULL, NULL, NULL, 0);
3438 if (builtins == NULL)
3439 return NULL;
3440 globals = Py_BuildValue("{OO}", builtins_str, builtins);
3441 if (globals == NULL)
3442 goto err;
3443 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003444
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003445 /* Get the __import__ function from the builtins */
3446 if (PyDict_Check(builtins)) {
3447 import = PyObject_GetItem(builtins, import_str);
3448 if (import == NULL)
3449 PyErr_SetObject(PyExc_KeyError, import_str);
3450 }
3451 else
3452 import = PyObject_GetAttr(builtins, import_str);
3453 if (import == NULL)
3454 goto err;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003455
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003456 /* Call the __import__ function with the proper argument list
Brett Cannonbc2eff32010-09-19 21:39:02 +00003457 Always use absolute import here.
3458 Calling for side-effect of import. */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003459 r = PyObject_CallFunction(import, "OOOOi", module_name, globals,
3460 globals, silly_list, 0, NULL);
Brett Cannonbc2eff32010-09-19 21:39:02 +00003461 if (r == NULL)
3462 goto err;
3463 Py_DECREF(r);
3464
3465 modules = PyImport_GetModuleDict();
3466 r = PyDict_GetItem(modules, module_name);
3467 if (r != NULL)
3468 Py_INCREF(r);
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003469
3470 err:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003471 Py_XDECREF(globals);
3472 Py_XDECREF(builtins);
3473 Py_XDECREF(import);
Tim Peters50d8d372001-02-28 05:34:27 +00003474
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003475 return r;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003476}
3477
3478
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003479/* Module 'imp' provides Python access to the primitives used for
3480 importing modules.
3481*/
3482
Guido van Rossum79f25d91997-04-29 20:08:16 +00003483static PyObject *
Barry Warsaw28a691b2010-04-17 00:19:56 +00003484imp_make_magic(long magic)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003485{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003486 char buf[4];
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003487
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003488 buf[0] = (char) ((magic >> 0) & 0xff);
3489 buf[1] = (char) ((magic >> 8) & 0xff);
3490 buf[2] = (char) ((magic >> 16) & 0xff);
3491 buf[3] = (char) ((magic >> 24) & 0xff);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003492
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003493 return PyBytes_FromStringAndSize(buf, 4);
Victor Stinner3e2b7172010-11-09 09:32:19 +00003494}
Barry Warsaw28a691b2010-04-17 00:19:56 +00003495
3496static PyObject *
3497imp_get_magic(PyObject *self, PyObject *noargs)
3498{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003499 return imp_make_magic(pyc_magic);
Barry Warsaw28a691b2010-04-17 00:19:56 +00003500}
3501
3502static PyObject *
3503imp_get_tag(PyObject *self, PyObject *noargs)
3504{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003505 return PyUnicode_FromString(pyc_tag);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003506}
3507
Guido van Rossum79f25d91997-04-29 20:08:16 +00003508static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +00003509imp_get_suffixes(PyObject *self, PyObject *noargs)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003510{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003511 PyObject *list;
3512 struct filedescr *fdp;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003513
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003514 list = PyList_New(0);
3515 if (list == NULL)
3516 return NULL;
3517 for (fdp = _PyImport_Filetab; fdp->suffix != NULL; fdp++) {
3518 PyObject *item = Py_BuildValue("ssi",
3519 fdp->suffix, fdp->mode, fdp->type);
3520 if (item == NULL) {
3521 Py_DECREF(list);
3522 return NULL;
3523 }
3524 if (PyList_Append(list, item) < 0) {
3525 Py_DECREF(list);
3526 Py_DECREF(item);
3527 return NULL;
3528 }
3529 Py_DECREF(item);
3530 }
3531 return list;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003532}
3533
Guido van Rossum79f25d91997-04-29 20:08:16 +00003534static PyObject *
Victor Stinner533d7832011-03-14 13:22:54 -04003535call_find_module(PyObject *name, PyObject *path_list)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003536{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003537 extern int fclose(FILE *);
3538 PyObject *fob, *ret;
3539 PyObject *pathobj;
3540 struct filedescr *fdp;
Victor Stinner7d8b77c2011-03-12 08:45:02 -05003541 FILE *fp;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003542 int fd = -1;
3543 char *found_encoding = NULL;
3544 char *encoding = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003545
Victor Stinner533d7832011-03-14 13:22:54 -04003546 if (path_list == Py_None)
3547 path_list = NULL;
3548 fdp = find_module(NULL, name, path_list,
Victor Stinner2fd76e42011-03-14 15:19:39 -04003549 &pathobj, &fp, NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003550 if (fdp == NULL)
3551 return NULL;
3552 if (fp != NULL) {
3553 fd = fileno(fp);
3554 if (fd != -1)
3555 fd = dup(fd);
3556 fclose(fp);
3557 fp = NULL;
3558 }
3559 if (fd != -1) {
3560 if (strchr(fdp->mode, 'b') == NULL) {
Victor Stinnerfe7c5b52011-04-05 01:48:03 +02003561 /* PyTokenizer_FindEncodingFilename() returns PyMem_MALLOC'ed
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003562 memory. */
Victor Stinnerfe7c5b52011-04-05 01:48:03 +02003563 found_encoding = PyTokenizer_FindEncodingFilename(fd, pathobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003564 lseek(fd, 0, 0); /* Reset position */
Victor Stinner2fd76e42011-03-14 15:19:39 -04003565 if (found_encoding == NULL && PyErr_Occurred()) {
3566 Py_XDECREF(pathobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003567 return NULL;
Victor Stinner2fd76e42011-03-14 15:19:39 -04003568 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003569 encoding = (found_encoding != NULL) ? found_encoding :
3570 (char*)PyUnicode_GetDefaultEncoding();
3571 }
Victor Stinner2fd76e42011-03-14 15:19:39 -04003572 fob = PyFile_FromFd(fd, NULL, fdp->mode, -1,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003573 (char*)encoding, NULL, NULL, 1);
3574 if (fob == NULL) {
Victor Stinner2fd76e42011-03-14 15:19:39 -04003575 Py_XDECREF(pathobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003576 close(fd);
3577 PyMem_FREE(found_encoding);
3578 return NULL;
3579 }
3580 }
3581 else {
3582 fob = Py_None;
3583 Py_INCREF(fob);
3584 }
Victor Stinner2fd76e42011-03-14 15:19:39 -04003585 if (pathobj == NULL) {
3586 Py_INCREF(Py_None);
3587 pathobj = Py_None;
3588 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003589 ret = Py_BuildValue("NN(ssi)",
3590 fob, pathobj, fdp->suffix, fdp->mode, fdp->type);
3591 PyMem_FREE(found_encoding);
Brett Cannon3bb42d92007-10-20 03:43:15 +00003592
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003593 return ret;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003594}
3595
Guido van Rossum79f25d91997-04-29 20:08:16 +00003596static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003597imp_find_module(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003598{
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003599 PyObject *name, *path_list = NULL;
3600 if (!PyArg_ParseTuple(args, "U|O:find_module",
3601 &name, &path_list))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003602 return NULL;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003603 return call_find_module(name, path_list);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003604}
3605
3606static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003607imp_init_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003608{
Victor Stinner95872862011-03-07 18:20:56 +01003609 PyObject *name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003610 int ret;
3611 PyObject *m;
Victor Stinner95872862011-03-07 18:20:56 +01003612 if (!PyArg_ParseTuple(args, "U:init_builtin", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003613 return NULL;
3614 ret = init_builtin(name);
3615 if (ret < 0)
3616 return NULL;
3617 if (ret == 0) {
3618 Py_INCREF(Py_None);
3619 return Py_None;
3620 }
Victor Stinner95872862011-03-07 18:20:56 +01003621 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003622 Py_XINCREF(m);
3623 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003624}
3625
Guido van Rossum79f25d91997-04-29 20:08:16 +00003626static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003627imp_init_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003628{
Victor Stinner53dc7352011-03-20 01:50:21 +01003629 PyObject *name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003630 int ret;
3631 PyObject *m;
Victor Stinner53dc7352011-03-20 01:50:21 +01003632 if (!PyArg_ParseTuple(args, "U:init_frozen", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003633 return NULL;
Victor Stinner53dc7352011-03-20 01:50:21 +01003634 ret = PyImport_ImportFrozenModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003635 if (ret < 0)
3636 return NULL;
3637 if (ret == 0) {
3638 Py_INCREF(Py_None);
3639 return Py_None;
3640 }
Victor Stinner53dc7352011-03-20 01:50:21 +01003641 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003642 Py_XINCREF(m);
3643 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003644}
3645
Guido van Rossum79f25d91997-04-29 20:08:16 +00003646static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003647imp_get_frozen_object(PyObject *self, PyObject *args)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00003648{
Victor Stinner53dc7352011-03-20 01:50:21 +01003649 PyObject *name;
Jack Jansen95ffa231995-10-03 14:38:41 +00003650
Victor Stinner53dc7352011-03-20 01:50:21 +01003651 if (!PyArg_ParseTuple(args, "U:get_frozen_object", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003652 return NULL;
3653 return get_frozen_object(name);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00003654}
3655
Guido van Rossum79f25d91997-04-29 20:08:16 +00003656static PyObject *
Brett Cannon8d110132009-03-15 02:20:16 +00003657imp_is_frozen_package(PyObject *self, PyObject *args)
3658{
Victor Stinner53dc7352011-03-20 01:50:21 +01003659 PyObject *name;
Brett Cannon8d110132009-03-15 02:20:16 +00003660
Victor Stinner53dc7352011-03-20 01:50:21 +01003661 if (!PyArg_ParseTuple(args, "U:is_frozen_package", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003662 return NULL;
3663 return is_frozen_package(name);
Brett Cannon8d110132009-03-15 02:20:16 +00003664}
3665
3666static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003667imp_is_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003668{
Victor Stinner95872862011-03-07 18:20:56 +01003669 PyObject *name;
3670 if (!PyArg_ParseTuple(args, "U:is_builtin", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003671 return NULL;
3672 return PyLong_FromLong(is_builtin(name));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003673}
3674
Guido van Rossum79f25d91997-04-29 20:08:16 +00003675static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003676imp_is_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003677{
Victor Stinner53dc7352011-03-20 01:50:21 +01003678 PyObject *name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003679 struct _frozen *p;
Victor Stinner53dc7352011-03-20 01:50:21 +01003680 if (!PyArg_ParseTuple(args, "U:is_frozen", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003681 return NULL;
3682 p = find_frozen(name);
3683 return PyBool_FromLong((long) (p == NULL ? 0 : p->size));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003684}
3685
3686static FILE *
Victor Stinner2f42ae52011-03-20 00:41:24 +01003687get_file(PyObject *pathname, PyObject *fob, char *mode)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003688{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003689 FILE *fp;
3690 if (mode[0] == 'U')
3691 mode = "r" PY_STDIOTEXTMODE;
3692 if (fob == NULL) {
Victor Stinner2f42ae52011-03-20 00:41:24 +01003693 fp = _Py_fopen(pathname, mode);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003694 }
3695 else {
3696 int fd = PyObject_AsFileDescriptor(fob);
3697 if (fd == -1)
3698 return NULL;
3699 if (!_PyVerify_fd(fd))
3700 goto error;
3701 /* the FILE struct gets a new fd, so that it can be closed
3702 * independently of the file descriptor given
3703 */
3704 fd = dup(fd);
3705 if (fd == -1)
3706 goto error;
3707 fp = fdopen(fd, mode);
3708 }
3709 if (fp)
3710 return fp;
Kristján Valur Jónssone1b04452009-03-31 17:43:39 +00003711error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003712 PyErr_SetFromErrno(PyExc_IOError);
3713 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003714}
3715
Guido van Rossum79f25d91997-04-29 20:08:16 +00003716static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003717imp_load_compiled(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003718{
Victor Stinner2f42ae52011-03-20 00:41:24 +01003719 PyObject *name, *pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003720 PyObject *fob = NULL;
3721 PyObject *m;
3722 FILE *fp;
Victor Stinner2f42ae52011-03-20 00:41:24 +01003723 if (!PyArg_ParseTuple(args, "UO&|O:load_compiled",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003724 &name,
Victor Stinner2f42ae52011-03-20 00:41:24 +01003725 PyUnicode_FSDecoder, &pathname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003726 &fob))
3727 return NULL;
Victor Stinner2f42ae52011-03-20 00:41:24 +01003728 fp = get_file(pathname, fob, "rb");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003729 if (fp == NULL) {
Victor Stinnerebc00522010-12-03 17:06:43 +00003730 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003731 return NULL;
3732 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01003733 m = load_compiled_module(name, pathname, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003734 fclose(fp);
Victor Stinnerebc00522010-12-03 17:06:43 +00003735 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003736 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003737}
3738
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003739#ifdef HAVE_DYNAMIC_LOADING
3740
Guido van Rossum79f25d91997-04-29 20:08:16 +00003741static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003742imp_load_dynamic(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003743{
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003744 PyObject *name, *pathname, *fob = NULL, *mod;
3745 FILE *fp;
3746
3747 if (!PyArg_ParseTuple(args, "UO&|O:load_dynamic",
3748 &name, PyUnicode_FSDecoder, &pathname, &fob))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003749 return NULL;
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003750 if (fob != NULL) {
3751 fp = get_file(NULL, fob, "r");
Victor Stinnere9ddbf62011-03-22 10:46:35 +01003752 if (fp == NULL) {
3753 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003754 return NULL;
Victor Stinnere9ddbf62011-03-22 10:46:35 +01003755 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003756 }
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003757 else
3758 fp = NULL;
3759 mod = _PyImport_LoadDynamicModule(name, pathname, fp);
Victor Stinnere9ddbf62011-03-22 10:46:35 +01003760 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003761 if (fp)
3762 fclose(fp);
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003763 return mod;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003764}
3765
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003766#endif /* HAVE_DYNAMIC_LOADING */
3767
Guido van Rossum79f25d91997-04-29 20:08:16 +00003768static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003769imp_load_source(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003770{
Victor Stinner2f42ae52011-03-20 00:41:24 +01003771 PyObject *name, *pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003772 PyObject *fob = NULL;
3773 PyObject *m;
3774 FILE *fp;
Victor Stinner2f42ae52011-03-20 00:41:24 +01003775 if (!PyArg_ParseTuple(args, "UO&|O:load_source",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003776 &name,
Victor Stinner2f42ae52011-03-20 00:41:24 +01003777 PyUnicode_FSDecoder, &pathname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003778 &fob))
3779 return NULL;
Victor Stinner2f42ae52011-03-20 00:41:24 +01003780 fp = get_file(pathname, fob, "r");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003781 if (fp == NULL) {
Victor Stinnerebc00522010-12-03 17:06:43 +00003782 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003783 return NULL;
3784 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01003785 m = load_source_module(name, pathname, fp);
Victor Stinnerebc00522010-12-03 17:06:43 +00003786 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003787 fclose(fp);
3788 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003789}
3790
Guido van Rossum79f25d91997-04-29 20:08:16 +00003791static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003792imp_load_module(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003793{
Victor Stinner6ae1e7f2011-03-20 22:37:17 +01003794 PyObject *name, *fob, *pathname, *pathname_obj, *ret;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003795 char *suffix; /* Unused */
3796 char *mode;
3797 int type;
3798 FILE *fp;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003799
Victor Stinner6ae1e7f2011-03-20 22:37:17 +01003800 if (!PyArg_ParseTuple(args, "UOO(ssi):load_module",
3801 &name, &fob, &pathname_obj, &suffix, &mode, &type))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003802 return NULL;
Victor Stinner6ae1e7f2011-03-20 22:37:17 +01003803 if (pathname_obj != Py_None) {
3804 if (!PyUnicode_FSDecoder(pathname_obj, &pathname))
3805 return NULL;
3806 }
3807 else
3808 pathname = NULL;
3809
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003810 if (*mode) {
3811 /* Mode must start with 'r' or 'U' and must not contain '+'.
3812 Implicit in this test is the assumption that the mode
3813 may contain other modifiers like 'b' or 't'. */
Guido van Rossum5e2c5fa2002-05-30 17:33:07 +00003814
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003815 if (!(*mode == 'r' || *mode == 'U') || strchr(mode, '+')) {
3816 PyErr_Format(PyExc_ValueError,
3817 "invalid file open mode %.200s", mode);
Victor Stinner6ae1e7f2011-03-20 22:37:17 +01003818 Py_XDECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003819 return NULL;
3820 }
3821 }
3822 if (fob == Py_None)
3823 fp = NULL;
3824 else {
3825 fp = get_file(NULL, fob, mode);
3826 if (fp == NULL) {
Victor Stinner6ae1e7f2011-03-20 22:37:17 +01003827 Py_XDECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003828 return NULL;
3829 }
3830 }
Victor Stinner41c5fec2011-03-13 21:46:30 -04003831 ret = load_module(name, fp, pathname, type, NULL);
Victor Stinner6ae1e7f2011-03-20 22:37:17 +01003832 Py_XDECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003833 if (fp)
3834 fclose(fp);
3835 return ret;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003836}
3837
3838static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003839imp_load_package(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003840{
Victor Stinnerc9abda02011-03-14 13:33:46 -04003841 PyObject *name, *pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003842 PyObject * ret;
Victor Stinnerc9abda02011-03-14 13:33:46 -04003843 if (!PyArg_ParseTuple(args, "UO&:load_package",
3844 &name, PyUnicode_FSDecoder, &pathname))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003845 return NULL;
Victor Stinnerc9abda02011-03-14 13:33:46 -04003846 ret = load_package(name, pathname);
Victor Stinnerebc00522010-12-03 17:06:43 +00003847 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003848 return ret;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003849}
3850
3851static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003852imp_new_module(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003853{
Victor Stinnerfe19d212011-03-14 14:53:28 -04003854 PyObject *name;
3855 if (!PyArg_ParseTuple(args, "U:new_module", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003856 return NULL;
Victor Stinnerfe19d212011-03-14 14:53:28 -04003857 return PyModule_NewObject(name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003858}
3859
Christian Heimes13a7a212008-01-07 17:13:09 +00003860static PyObject *
3861imp_reload(PyObject *self, PyObject *v)
3862{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003863 return PyImport_ReloadModule(v);
Christian Heimes13a7a212008-01-07 17:13:09 +00003864}
3865
3866PyDoc_STRVAR(doc_reload,
3867"reload(module) -> module\n\
3868\n\
3869Reload the module. The module must have been successfully imported before.");
3870
Barry Warsaw28a691b2010-04-17 00:19:56 +00003871static PyObject *
3872imp_cache_from_source(PyObject *self, PyObject *args, PyObject *kws)
3873{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003874 static char *kwlist[] = {"path", "debug_override", NULL};
Barry Warsaw28a691b2010-04-17 00:19:56 +00003875
Victor Stinner2f42ae52011-03-20 00:41:24 +01003876 PyObject *pathname, *cpathname;
Benjamin Peterson294a9fc2010-10-16 03:12:39 +00003877 PyObject *debug_override = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003878 int debug = !Py_OptimizeFlag;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003879
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003880 if (!PyArg_ParseTupleAndKeywords(
Victor Stinner3ea23dd2010-10-15 20:34:32 +00003881 args, kws, "O&|O", kwlist,
Victor Stinner2f42ae52011-03-20 00:41:24 +01003882 PyUnicode_FSDecoder, &pathname, &debug_override))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003883 return NULL;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003884
Benjamin Peterson294a9fc2010-10-16 03:12:39 +00003885 if (debug_override != NULL &&
3886 (debug = PyObject_IsTrue(debug_override)) < 0) {
Victor Stinner2f42ae52011-03-20 00:41:24 +01003887 Py_DECREF(pathname);
Benjamin Peterson294a9fc2010-10-16 03:12:39 +00003888 return NULL;
3889 }
Barry Warsaw28a691b2010-04-17 00:19:56 +00003890
Victor Stinner3ea23dd2010-10-15 20:34:32 +00003891 cpathname = make_compiled_pathname(
Victor Stinner2f42ae52011-03-20 00:41:24 +01003892 PyUnicode_AS_UNICODE(pathname),
3893 debug);
3894 Py_DECREF(pathname);
Barry Warsaw28a691b2010-04-17 00:19:56 +00003895
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003896 if (cpathname == NULL) {
3897 PyErr_Format(PyExc_SystemError, "path buffer too short");
3898 return NULL;
3899 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01003900 return cpathname;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003901}
3902
3903PyDoc_STRVAR(doc_cache_from_source,
3904"Given the path to a .py file, return the path to its .pyc/.pyo file.\n\
3905\n\
3906The .py file does not need to exist; this simply returns the path to the\n\
3907.pyc/.pyo file calculated as if the .py file were imported. The extension\n\
3908will be .pyc unless __debug__ is not defined, then it will be .pyo.\n\
3909\n\
3910If debug_override is not None, then it must be a boolean and is taken as\n\
3911the value of __debug__ instead.");
3912
3913static PyObject *
3914imp_source_from_cache(PyObject *self, PyObject *args, PyObject *kws)
3915{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003916 static char *kwlist[] = {"path", NULL};
Victor Stinnerc9abda02011-03-14 13:33:46 -04003917 PyObject *pathname, *source;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003918
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003919 if (!PyArg_ParseTupleAndKeywords(
Victor Stinnerebc00522010-12-03 17:06:43 +00003920 args, kws, "O&", kwlist,
Victor Stinnerc9abda02011-03-14 13:33:46 -04003921 PyUnicode_FSDecoder, &pathname))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003922 return NULL;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003923
Victor Stinnerc9abda02011-03-14 13:33:46 -04003924 source = make_source_pathname(pathname);
3925 if (source == NULL) {
3926 PyErr_Format(PyExc_ValueError, "Not a PEP 3147 pyc path: %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003927 pathname);
Victor Stinnerc9abda02011-03-14 13:33:46 -04003928 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003929 return NULL;
3930 }
Victor Stinnerc9abda02011-03-14 13:33:46 -04003931 Py_DECREF(pathname);
3932 return source;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003933}
3934
3935PyDoc_STRVAR(doc_source_from_cache,
3936"Given the path to a .pyc./.pyo file, return the path to its .py file.\n\
3937\n\
3938The .pyc/.pyo file does not need to exist; this simply returns the path to\n\
3939the .py file calculated to correspond to the .pyc/.pyo file. If path\n\
3940does not conform to PEP 3147 format, ValueError will be raised.");
3941
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003942/* Doc strings */
3943
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003944PyDoc_STRVAR(doc_imp,
3945"This module provides the components needed to build your own\n\
3946__import__ function. Undocumented functions are obsolete.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003947
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003948PyDoc_STRVAR(doc_find_module,
3949"find_module(name, [path]) -> (file, filename, (suffix, mode, type))\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003950Search for a module. If path is omitted or None, search for a\n\
3951built-in, frozen or special module and continue search in sys.path.\n\
3952The module name cannot contain '.'; to search for a submodule of a\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003953package, pass the submodule name and the package's __path__.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003954
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003955PyDoc_STRVAR(doc_load_module,
3956"load_module(name, file, filename, (suffix, mode, type)) -> module\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003957Load a module, given information returned by find_module().\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003958The module name must include the full package name, if any.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003959
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003960PyDoc_STRVAR(doc_get_magic,
3961"get_magic() -> string\n\
3962Return the magic number for .pyc or .pyo files.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003963
Barry Warsaw28a691b2010-04-17 00:19:56 +00003964PyDoc_STRVAR(doc_get_tag,
3965"get_tag() -> string\n\
3966Return the magic tag for .pyc or .pyo files.");
3967
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003968PyDoc_STRVAR(doc_get_suffixes,
3969"get_suffixes() -> [(suffix, mode, type), ...]\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003970Return a list of (suffix, mode, type) tuples describing the files\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003971that find_module() looks for.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003972
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003973PyDoc_STRVAR(doc_new_module,
3974"new_module(name) -> module\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003975Create a new module. Do not enter it in sys.modules.\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003976The module name must include the full package name, if any.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003977
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003978PyDoc_STRVAR(doc_lock_held,
Tim Petersa7c65092004-08-01 23:26:05 +00003979"lock_held() -> boolean\n\
3980Return True if the import lock is currently held, else False.\n\
3981On platforms without threads, return False.");
Tim Peters69232342001-08-30 05:16:13 +00003982
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00003983PyDoc_STRVAR(doc_acquire_lock,
3984"acquire_lock() -> None\n\
Neal Norwitz2294c0d2003-02-12 23:02:21 +00003985Acquires the interpreter's import lock for the current thread.\n\
3986This lock should be used by import hooks to ensure thread-safety\n\
3987when importing modules.\n\
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00003988On platforms without threads, this function does nothing.");
3989
3990PyDoc_STRVAR(doc_release_lock,
3991"release_lock() -> None\n\
3992Release the interpreter's import lock.\n\
3993On platforms without threads, this function does nothing.");
3994
Guido van Rossum79f25d91997-04-29 20:08:16 +00003995static PyMethodDef imp_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003996 {"find_module", imp_find_module, METH_VARARGS, doc_find_module},
3997 {"get_magic", imp_get_magic, METH_NOARGS, doc_get_magic},
3998 {"get_tag", imp_get_tag, METH_NOARGS, doc_get_tag},
3999 {"get_suffixes", imp_get_suffixes, METH_NOARGS, doc_get_suffixes},
4000 {"load_module", imp_load_module, METH_VARARGS, doc_load_module},
4001 {"new_module", imp_new_module, METH_VARARGS, doc_new_module},
4002 {"lock_held", imp_lock_held, METH_NOARGS, doc_lock_held},
4003 {"acquire_lock", imp_acquire_lock, METH_NOARGS, doc_acquire_lock},
4004 {"release_lock", imp_release_lock, METH_NOARGS, doc_release_lock},
4005 {"reload", imp_reload, METH_O, doc_reload},
4006 {"cache_from_source", (PyCFunction)imp_cache_from_source,
4007 METH_VARARGS | METH_KEYWORDS, doc_cache_from_source},
4008 {"source_from_cache", (PyCFunction)imp_source_from_cache,
4009 METH_VARARGS | METH_KEYWORDS, doc_source_from_cache},
4010 /* The rest are obsolete */
4011 {"get_frozen_object", imp_get_frozen_object, METH_VARARGS},
4012 {"is_frozen_package", imp_is_frozen_package, METH_VARARGS},
4013 {"init_builtin", imp_init_builtin, METH_VARARGS},
4014 {"init_frozen", imp_init_frozen, METH_VARARGS},
4015 {"is_builtin", imp_is_builtin, METH_VARARGS},
4016 {"is_frozen", imp_is_frozen, METH_VARARGS},
4017 {"load_compiled", imp_load_compiled, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00004018#ifdef HAVE_DYNAMIC_LOADING
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004019 {"load_dynamic", imp_load_dynamic, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00004020#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004021 {"load_package", imp_load_package, METH_VARARGS},
4022 {"load_source", imp_load_source, METH_VARARGS},
Brett Cannon442c9b92011-03-23 16:14:42 -07004023 {"_fix_co_filename", imp_fix_co_filename, METH_VARARGS},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004024 {NULL, NULL} /* sentinel */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004025};
4026
Guido van Rossum1a8791e1998-08-04 22:46:29 +00004027static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00004028setint(PyObject *d, char *name, int value)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00004029{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004030 PyObject *v;
4031 int err;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00004032
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004033 v = PyLong_FromLong((long)value);
4034 err = PyDict_SetItemString(d, name, v);
4035 Py_XDECREF(v);
4036 return err;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00004037}
4038
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004039typedef struct {
4040 PyObject_HEAD
4041} NullImporter;
4042
4043static int
4044NullImporter_init(NullImporter *self, PyObject *args, PyObject *kwds)
4045{
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004046#ifndef MS_WINDOWS
4047 PyObject *path;
4048 struct stat statbuf;
4049 int rv;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004050
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004051 if (!_PyArg_NoKeywords("NullImporter()", kwds))
4052 return -1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004053
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004054 if (!PyArg_ParseTuple(args, "O&:NullImporter",
4055 PyUnicode_FSConverter, &path))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004056 return -1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004057
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004058 if (PyBytes_GET_SIZE(path) == 0) {
4059 Py_DECREF(path);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004060 PyErr_SetString(PyExc_ImportError, "empty pathname");
4061 return -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004062 }
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004063
4064 rv = stat(PyBytes_AS_STRING(path), &statbuf);
4065 Py_DECREF(path);
4066 if (rv == 0) {
4067 /* it exists */
4068 if (S_ISDIR(statbuf.st_mode)) {
4069 /* it's a directory */
4070 PyErr_SetString(PyExc_ImportError, "existing directory");
4071 return -1;
4072 }
4073 }
4074#else /* MS_WINDOWS */
4075 PyObject *pathobj;
4076 DWORD rv;
Victor Stinner255dfdb2010-09-29 10:28:51 +00004077 wchar_t *path;
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004078
4079 if (!_PyArg_NoKeywords("NullImporter()", kwds))
4080 return -1;
4081
4082 if (!PyArg_ParseTuple(args, "U:NullImporter",
4083 &pathobj))
4084 return -1;
4085
4086 if (PyUnicode_GET_SIZE(pathobj) == 0) {
4087 PyErr_SetString(PyExc_ImportError, "empty pathname");
4088 return -1;
4089 }
4090
Victor Stinnerbeb4135b2010-10-07 01:02:42 +00004091 path = PyUnicode_AsWideCharString(pathobj, NULL);
Victor Stinner255dfdb2010-09-29 10:28:51 +00004092 if (path == NULL)
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004093 return -1;
4094 /* see issue1293 and issue3677:
4095 * stat() on Windows doesn't recognise paths like
4096 * "e:\\shared\\" and "\\\\whiterab-c2znlh\\shared" as dirs.
4097 */
4098 rv = GetFileAttributesW(path);
Victor Stinner255dfdb2010-09-29 10:28:51 +00004099 PyMem_Free(path);
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004100 if (rv != INVALID_FILE_ATTRIBUTES) {
4101 /* it exists */
4102 if (rv & FILE_ATTRIBUTE_DIRECTORY) {
4103 /* it's a directory */
4104 PyErr_SetString(PyExc_ImportError, "existing directory");
4105 return -1;
4106 }
4107 }
4108#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004109 return 0;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004110}
4111
4112static PyObject *
4113NullImporter_find_module(NullImporter *self, PyObject *args)
4114{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004115 Py_RETURN_NONE;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004116}
4117
4118static PyMethodDef NullImporter_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004119 {"find_module", (PyCFunction)NullImporter_find_module, METH_VARARGS,
4120 "Always return None"
4121 },
4122 {NULL} /* Sentinel */
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004123};
4124
4125
Christian Heimes9cd17752007-11-18 19:35:23 +00004126PyTypeObject PyNullImporter_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004127 PyVarObject_HEAD_INIT(NULL, 0)
4128 "imp.NullImporter", /*tp_name*/
4129 sizeof(NullImporter), /*tp_basicsize*/
4130 0, /*tp_itemsize*/
4131 0, /*tp_dealloc*/
4132 0, /*tp_print*/
4133 0, /*tp_getattr*/
4134 0, /*tp_setattr*/
4135 0, /*tp_reserved*/
4136 0, /*tp_repr*/
4137 0, /*tp_as_number*/
4138 0, /*tp_as_sequence*/
4139 0, /*tp_as_mapping*/
4140 0, /*tp_hash */
4141 0, /*tp_call*/
4142 0, /*tp_str*/
4143 0, /*tp_getattro*/
4144 0, /*tp_setattro*/
4145 0, /*tp_as_buffer*/
4146 Py_TPFLAGS_DEFAULT, /*tp_flags*/
4147 "Null importer object", /* tp_doc */
4148 0, /* tp_traverse */
4149 0, /* tp_clear */
4150 0, /* tp_richcompare */
4151 0, /* tp_weaklistoffset */
4152 0, /* tp_iter */
4153 0, /* tp_iternext */
4154 NullImporter_methods, /* tp_methods */
4155 0, /* tp_members */
4156 0, /* tp_getset */
4157 0, /* tp_base */
4158 0, /* tp_dict */
4159 0, /* tp_descr_get */
4160 0, /* tp_descr_set */
4161 0, /* tp_dictoffset */
4162 (initproc)NullImporter_init, /* tp_init */
4163 0, /* tp_alloc */
4164 PyType_GenericNew /* tp_new */
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004165};
4166
Martin v. Löwis1a214512008-06-11 05:26:20 +00004167static struct PyModuleDef impmodule = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004168 PyModuleDef_HEAD_INIT,
4169 "imp",
4170 doc_imp,
4171 0,
4172 imp_methods,
4173 NULL,
4174 NULL,
4175 NULL,
4176 NULL
Martin v. Löwis1a214512008-06-11 05:26:20 +00004177};
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004178
Jason Tishler6bc06ec2003-09-04 11:59:50 +00004179PyMODINIT_FUNC
Martin v. Löwis1a214512008-06-11 05:26:20 +00004180PyInit_imp(void)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004181{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004182 PyObject *m, *d;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004183
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004184 if (PyType_Ready(&PyNullImporter_Type) < 0)
4185 return NULL;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004186
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004187 m = PyModule_Create(&impmodule);
4188 if (m == NULL)
4189 goto failure;
4190 d = PyModule_GetDict(m);
4191 if (d == NULL)
4192 goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004193
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004194 if (setint(d, "SEARCH_ERROR", SEARCH_ERROR) < 0) goto failure;
4195 if (setint(d, "PY_SOURCE", PY_SOURCE) < 0) goto failure;
4196 if (setint(d, "PY_COMPILED", PY_COMPILED) < 0) goto failure;
4197 if (setint(d, "C_EXTENSION", C_EXTENSION) < 0) goto failure;
4198 if (setint(d, "PY_RESOURCE", PY_RESOURCE) < 0) goto failure;
4199 if (setint(d, "PKG_DIRECTORY", PKG_DIRECTORY) < 0) goto failure;
4200 if (setint(d, "C_BUILTIN", C_BUILTIN) < 0) goto failure;
4201 if (setint(d, "PY_FROZEN", PY_FROZEN) < 0) goto failure;
4202 if (setint(d, "PY_CODERESOURCE", PY_CODERESOURCE) < 0) goto failure;
4203 if (setint(d, "IMP_HOOK", IMP_HOOK) < 0) goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004204
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004205 Py_INCREF(&PyNullImporter_Type);
4206 PyModule_AddObject(m, "NullImporter", (PyObject *)&PyNullImporter_Type);
4207 return m;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00004208 failure:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004209 Py_XDECREF(m);
4210 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004211}
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004212
4213
Guido van Rossumb18618d2000-05-03 23:44:39 +00004214/* API for embedding applications that want to add their own entries
4215 to the table of built-in modules. This should normally be called
4216 *before* Py_Initialize(). When the table resize fails, -1 is
4217 returned and the existing table is unchanged.
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004218
4219 After a similar function by Just van Rossum. */
4220
4221int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00004222PyImport_ExtendInittab(struct _inittab *newtab)
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004223{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004224 static struct _inittab *our_copy = NULL;
4225 struct _inittab *p;
4226 int i, n;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004227
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004228 /* Count the number of entries in both tables */
4229 for (n = 0; newtab[n].name != NULL; n++)
4230 ;
4231 if (n == 0)
4232 return 0; /* Nothing to do */
4233 for (i = 0; PyImport_Inittab[i].name != NULL; i++)
4234 ;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004235
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004236 /* Allocate new memory for the combined table */
4237 p = our_copy;
4238 PyMem_RESIZE(p, struct _inittab, i+n+1);
4239 if (p == NULL)
4240 return -1;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004241
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004242 /* Copy the tables into the new memory */
4243 if (our_copy != PyImport_Inittab)
4244 memcpy(p, PyImport_Inittab, (i+1) * sizeof(struct _inittab));
4245 PyImport_Inittab = our_copy = p;
4246 memcpy(p+i, newtab, (n+1) * sizeof(struct _inittab));
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004247
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004248 return 0;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004249}
4250
4251/* Shorthand to add a single entry given a name and a function */
4252
4253int
Brett Cannona826f322009-04-02 03:41:46 +00004254PyImport_AppendInittab(const char *name, PyObject* (*initfunc)(void))
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004255{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004256 struct _inittab newtab[2];
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004257
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004258 memset(newtab, '\0', sizeof newtab);
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004259
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004260 newtab[0].name = (char *)name;
4261 newtab[0].initfunc = initfunc;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004262
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004263 return PyImport_ExtendInittab(newtab);
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004264}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00004265
4266#ifdef __cplusplus
4267}
4268#endif