blob: b074b834e90d9450addb5d1749f8cdb95f0d8638 [file] [log] [blame]
Guido van Rossumf70e43a1991-02-19 12:39:46 +00001
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002/* Module definition and import implementation */
3
Guido van Rossum79f25d91997-04-29 20:08:16 +00004#include "Python.h"
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00005
Jeremy Hylton3e0055f2005-10-20 19:59:25 +00006#include "Python-ast.h"
Guido van Rossumd8faa362007-04-27 19:54:29 +00007#undef Yield /* undefine macro conflicting with winbase.h */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00008#include "errcode.h"
Guido van Rossumc405b7b1991-06-04 19:39:42 +00009#include "marshal.h"
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000010#include "code.h"
Guido van Rossumd8bac6d1992-02-26 15:19:13 +000011#include "osdefs.h"
Guido van Rossum1ae940a1995-01-02 19:04:15 +000012#include "importdl.h"
Guido van Rossumc405b7b1991-06-04 19:39:42 +000013
Guido van Rossum55a83382000-09-20 20:31:38 +000014#ifdef HAVE_FCNTL_H
15#include <fcntl.h>
16#endif
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000017#ifdef __cplusplus
Brett Cannon9a5b25a2010-03-01 02:09:17 +000018extern "C" {
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000019#endif
Guido van Rossum55a83382000-09-20 20:31:38 +000020
Christian Heimesd3eb5a152008-02-24 00:38:49 +000021#ifdef MS_WINDOWS
22/* for stat.st_mode */
23typedef unsigned short mode_t;
Daniel Stutzbachc7937792010-09-09 21:18:04 +000024/* for _mkdir */
25#include <direct.h>
Christian Heimesd3eb5a152008-02-24 00:38:49 +000026#endif
27
Guido van Rossum21d335e1993-10-15 13:01:11 +000028
Jeremy Hyltond4ceb312004-04-01 02:45:22 +000029/* Magic word to reject .pyc files generated by other Python versions.
30 It should change for each incompatible change to the bytecode.
31
32 The value of CR and LF is incorporated so if you ever read or write
Guido van Rossum7faeab31995-07-07 22:50:36 +000033 a .pyc file in text mode the magic number will be wrong; also, the
Tim Peters36515e22001-11-18 04:06:29 +000034 Apple MPW compiler swaps their values, botching string constants.
Marc-André Lemburgbd3be8f2002-02-07 11:33:49 +000035
Guido van Rossum45aecf42006-03-15 04:58:47 +000036 The magic numbers must be spaced apart at least 2 values, as the
Martin v. Löwisef82d2f2004-06-27 16:51:46 +000037 -U interpeter flag will cause MAGIC+1 being used. They have been
38 odd numbers for some time now.
Marc-André Lemburgbd3be8f2002-02-07 11:33:49 +000039
Jeremy Hyltond4ceb312004-04-01 02:45:22 +000040 There were a variety of old schemes for setting the magic number.
41 The current working scheme is to increment the previous value by
42 10.
Guido van Rossumf6894922002-08-31 15:16:14 +000043
Barry Warsaw28a691b2010-04-17 00:19:56 +000044 Starting with the adoption of PEP 3147 in Python 3.2, every bump in magic
45 number also includes a new "magic tag", i.e. a human readable string used
46 to represent the magic number in __pycache__ directories. When you change
47 the magic number, you must also set a new unique magic tag. Generally this
48 can be named after the Python major version of the magic number bump, but
49 it can really be anything, as long as it's different than anything else
50 that's come before. The tags are included in the following table, starting
51 with Python 3.2a0.
52
Marc-André Lemburgbd3be8f2002-02-07 11:33:49 +000053 Known values:
54 Python 1.5: 20121
55 Python 1.5.1: 20121
56 Python 1.5.2: 20121
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000057 Python 1.6: 50428
Marc-André Lemburgbd3be8f2002-02-07 11:33:49 +000058 Python 2.0: 50823
59 Python 2.0.1: 50823
60 Python 2.1: 60202
61 Python 2.1.1: 60202
62 Python 2.1.2: 60202
63 Python 2.2: 60717
Neal Norwitz7fdcb412002-06-14 01:07:39 +000064 Python 2.3a0: 62011
Michael W. Hudsondd32a912002-08-15 14:59:02 +000065 Python 2.3a0: 62021
Guido van Rossumf6894922002-08-31 15:16:14 +000066 Python 2.3a0: 62011 (!)
Martin v. Löwisef82d2f2004-06-27 16:51:46 +000067 Python 2.4a0: 62041
Raymond Hettingerfd2d1f72004-08-23 23:37:48 +000068 Python 2.4a3: 62051
Raymond Hettinger2c31a052004-09-22 18:44:21 +000069 Python 2.4b1: 62061
Michael W. Hudsondf888462005-06-03 14:41:55 +000070 Python 2.5a0: 62071
Michael W. Hudsonaee2e282005-10-21 11:32:20 +000071 Python 2.5a0: 62081 (ast-branch)
Guido van Rossumc2e20742006-02-27 22:32:47 +000072 Python 2.5a0: 62091 (with)
Guido van Rossumf6694362006-03-10 02:28:35 +000073 Python 2.5a0: 62092 (changed WITH_CLEANUP opcode)
Thomas Wouters0e3f5912006-08-11 14:57:12 +000074 Python 2.5b3: 62101 (fix wrong code: for x, in ...)
75 Python 2.5b3: 62111 (fix wrong code: x += yield)
76 Python 2.5c1: 62121 (fix wrong lnotab with for loops and
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000077 storing constants that should have been removed)
Thomas Wouters89f507f2006-12-13 04:49:30 +000078 Python 2.5c2: 62131 (fix wrong code: for x, in ... in listcomp/genexp)
Christian Heimes99170a52007-12-19 02:07:34 +000079 Python 2.6a0: 62151 (peephole optimizations and STORE_MAP opcode)
Christian Heimesdd15f6c2008-03-16 00:07:10 +000080 Python 2.6a1: 62161 (WITH_CLEANUP optimization)
Guido van Rossum45aecf42006-03-15 04:58:47 +000081 Python 3000: 3000
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000082 3010 (removed UNARY_CONVERT)
83 3020 (added BUILD_SET)
84 3030 (added keyword-only parameters)
85 3040 (added signature annotations)
86 3050 (print becomes a function)
87 3060 (PEP 3115 metaclass syntax)
88 3061 (string literals become unicode)
89 3071 (PEP 3109 raise changes)
90 3081 (PEP 3137 make __file__ and __name__ unicode)
91 3091 (kill str8 interning)
92 3101 (merge from 2.6a0, see 62151)
93 3103 (__file__ points to source file)
Benjamin Peterson0f6cae02009-12-10 02:09:08 +000094 Python 3.0a4: 3111 (WITH_CLEANUP optimization).
95 Python 3.0a5: 3131 (lexical exception stacking, including POP_EXCEPT)
96 Python 3.1a0: 3141 (optimize list, set and dict comprehensions:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000097 change LIST_APPEND and SET_ADD, add MAP_ADD)
Benjamin Peterson0f6cae02009-12-10 02:09:08 +000098 Python 3.1a0: 3151 (optimize conditional branches:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000099 introduce POP_JUMP_IF_FALSE and POP_JUMP_IF_TRUE)
Benjamin Peterson876b2f22009-06-28 03:18:59 +0000100 Python 3.2a0: 3160 (add SETUP_WITH)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000101 tag: cpython-32
Antoine Pitrou74a69fa2010-09-04 18:43:52 +0000102 Python 3.2a1: 3170 (add DUP_TOP_TWO, remove DUP_TOPX and ROT_FOUR)
103 tag: cpython-32
Benjamin Peterson6246d6d2010-09-10 21:51:44 +0000104 Python 3.2a2 3180 (add DELETE_DEREF)
Tim Peters36515e22001-11-18 04:06:29 +0000105*/
Guido van Rossum3ddee711991-12-16 13:06:34 +0000106
Nick Coghlancd419ab2010-09-11 00:39:25 +0000107/* MAGIC must change whenever the bytecode emitted by the compiler may no
108 longer be understood by older implementations of the eval loop (usually
109 due to the addition of new opcodes)
Victor Stinner2f42ae52011-03-20 00:41:24 +0100110 TAG and PYC_TAG_UNICODE must change for each major Python release. The magic
111 number will take care of any bytecode changes that occur during development.
Barry Warsaw28a691b2010-04-17 00:19:56 +0000112*/
Benjamin Peterson6246d6d2010-09-10 21:51:44 +0000113#define MAGIC (3180 | ((long)'\r'<<16) | ((long)'\n'<<24))
Barry Warsaw28a691b2010-04-17 00:19:56 +0000114#define TAG "cpython-32"
115#define CACHEDIR "__pycache__"
Victor Stinnerc9abda02011-03-14 13:33:46 -0400116static const Py_UNICODE CACHEDIR_UNICODE[] = {
117 '_', '_', 'p', 'y', 'c', 'a', 'c', 'h', 'e', '_', '_', '\0'};
Barry Warsaw28a691b2010-04-17 00:19:56 +0000118/* Current magic word and string tag as globals. */
Guido van Rossum96774c12000-05-01 20:19:08 +0000119static long pyc_magic = MAGIC;
Barry Warsaw28a691b2010-04-17 00:19:56 +0000120static const char *pyc_tag = TAG;
Victor Stinner2f42ae52011-03-20 00:41:24 +0100121static const Py_UNICODE PYC_TAG_UNICODE[] = {
122 'c', 'p', 'y', 't', 'h', 'o', 'n', '-', '3', '2', '\0'};
Guido van Rossum96774c12000-05-01 20:19:08 +0000123
Victor Stinner95872862011-03-07 18:20:56 +0100124/* See _PyImport_FixupExtensionObject() below */
Guido van Rossum25ce5661997-08-02 03:10:38 +0000125static PyObject *extensions = NULL;
Guido van Rossum3f5da241990-12-20 15:06:42 +0000126
Guido van Rossum771c6c81997-10-31 18:37:24 +0000127/* This table is defined in config.c: */
128extern struct _inittab _PyImport_Inittab[];
129
Guido van Rossumce3a72a2007-10-19 23:16:50 +0000130/* Method from Parser/tokenizer.c */
Guido van Rossum40d20bc2007-10-22 00:09:51 +0000131extern char * PyTokenizer_FindEncoding(int);
Guido van Rossumce3a72a2007-10-19 23:16:50 +0000132
Guido van Rossum771c6c81997-10-31 18:37:24 +0000133struct _inittab *PyImport_Inittab = _PyImport_Inittab;
Guido van Rossum66f1fa81991-04-03 19:03:52 +0000134
Guido van Rossumed1170e1999-12-20 21:23:41 +0000135/* these tables define the module suffixes that Python recognizes */
136struct filedescr * _PyImport_Filetab = NULL;
Guido van Rossum48a680c2001-03-02 06:34:14 +0000137
Guido van Rossumed1170e1999-12-20 21:23:41 +0000138static const struct filedescr _PyImport_StandardFiletab[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000139 {".py", "U", PY_SOURCE},
Martin v. Löwis6238d2b2002-06-30 15:26:10 +0000140#ifdef MS_WINDOWS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000141 {".pyw", "U", PY_SOURCE},
Tim Peters36515e22001-11-18 04:06:29 +0000142#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000143 {".pyc", "rb", PY_COMPILED},
144 {0, 0}
Guido van Rossumed1170e1999-12-20 21:23:41 +0000145};
146
Victor Stinnerd0296212011-03-14 14:04:10 -0400147static PyObject *initstr = NULL;
148
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000149
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000150/* Initialize things */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000151
152void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000153_PyImport_Init(void)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000154{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000155 const struct filedescr *scan;
156 struct filedescr *filetab;
157 int countD = 0;
158 int countS = 0;
Guido van Rossumed1170e1999-12-20 21:23:41 +0000159
Victor Stinnerd0296212011-03-14 14:04:10 -0400160 initstr = PyUnicode_InternFromString("__init__");
161 if (initstr == NULL)
162 Py_FatalError("Can't initialize import variables");
163
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000164 /* prepare _PyImport_Filetab: copy entries from
165 _PyImport_DynLoadFiletab and _PyImport_StandardFiletab.
166 */
Guido van Rossum04110fb2007-08-24 16:32:05 +0000167#ifdef HAVE_DYNAMIC_LOADING
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000168 for (scan = _PyImport_DynLoadFiletab; scan->suffix != NULL; ++scan)
169 ++countD;
Guido van Rossum04110fb2007-08-24 16:32:05 +0000170#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000171 for (scan = _PyImport_StandardFiletab; scan->suffix != NULL; ++scan)
172 ++countS;
173 filetab = PyMem_NEW(struct filedescr, countD + countS + 1);
174 if (filetab == NULL)
175 Py_FatalError("Can't initialize import file table.");
Guido van Rossum04110fb2007-08-24 16:32:05 +0000176#ifdef HAVE_DYNAMIC_LOADING
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000177 memcpy(filetab, _PyImport_DynLoadFiletab,
178 countD * sizeof(struct filedescr));
Guido van Rossum04110fb2007-08-24 16:32:05 +0000179#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000180 memcpy(filetab + countD, _PyImport_StandardFiletab,
181 countS * sizeof(struct filedescr));
182 filetab[countD + countS].suffix = NULL;
Guido van Rossumed1170e1999-12-20 21:23:41 +0000183
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000184 _PyImport_Filetab = filetab;
Guido van Rossumed1170e1999-12-20 21:23:41 +0000185
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000186 if (Py_OptimizeFlag) {
187 /* Replace ".pyc" with ".pyo" in _PyImport_Filetab */
188 for (; filetab->suffix != NULL; filetab++) {
189 if (strcmp(filetab->suffix, ".pyc") == 0)
190 filetab->suffix = ".pyo";
191 }
192 }
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000193}
194
Guido van Rossum25ce5661997-08-02 03:10:38 +0000195void
Just van Rossum52e14d62002-12-30 22:08:05 +0000196_PyImportHooks_Init(void)
197{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000198 PyObject *v, *path_hooks = NULL, *zimpimport;
199 int err = 0;
Just van Rossum52e14d62002-12-30 22:08:05 +0000200
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000201 /* adding sys.path_hooks and sys.path_importer_cache, setting up
202 zipimport */
203 if (PyType_Ready(&PyNullImporter_Type) < 0)
204 goto error;
Just van Rossum52e14d62002-12-30 22:08:05 +0000205
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000206 if (Py_VerboseFlag)
207 PySys_WriteStderr("# installing zipimport hook\n");
Just van Rossum52e14d62002-12-30 22:08:05 +0000208
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000209 v = PyList_New(0);
210 if (v == NULL)
211 goto error;
212 err = PySys_SetObject("meta_path", v);
213 Py_DECREF(v);
214 if (err)
215 goto error;
216 v = PyDict_New();
217 if (v == NULL)
218 goto error;
219 err = PySys_SetObject("path_importer_cache", v);
220 Py_DECREF(v);
221 if (err)
222 goto error;
223 path_hooks = PyList_New(0);
224 if (path_hooks == NULL)
225 goto error;
226 err = PySys_SetObject("path_hooks", path_hooks);
227 if (err) {
Just van Rossum52e14d62002-12-30 22:08:05 +0000228 error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000229 PyErr_Print();
230 Py_FatalError("initializing sys.meta_path, sys.path_hooks, "
231 "path_importer_cache, or NullImporter failed"
232 );
233 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000234
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000235 zimpimport = PyImport_ImportModule("zipimport");
236 if (zimpimport == NULL) {
237 PyErr_Clear(); /* No zip import module -- okay */
238 if (Py_VerboseFlag)
239 PySys_WriteStderr("# can't import zipimport\n");
240 }
241 else {
242 PyObject *zipimporter = PyObject_GetAttrString(zimpimport,
243 "zipimporter");
244 Py_DECREF(zimpimport);
245 if (zipimporter == NULL) {
246 PyErr_Clear(); /* No zipimporter object -- okay */
247 if (Py_VerboseFlag)
248 PySys_WriteStderr(
249 "# can't import zipimport.zipimporter\n");
250 }
251 else {
252 /* sys.path_hooks.append(zipimporter) */
253 err = PyList_Append(path_hooks, zipimporter);
254 Py_DECREF(zipimporter);
255 if (err)
256 goto error;
257 if (Py_VerboseFlag)
258 PySys_WriteStderr(
259 "# installed zipimport hook\n");
260 }
261 }
262 Py_DECREF(path_hooks);
Just van Rossum52e14d62002-12-30 22:08:05 +0000263}
264
265void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000266_PyImport_Fini(void)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000267{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000268 Py_XDECREF(extensions);
269 extensions = NULL;
270 PyMem_DEL(_PyImport_Filetab);
271 _PyImport_Filetab = NULL;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000272}
273
274
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000275/* Locking primitives to prevent parallel imports of the same module
276 in different threads to return with a partially loaded module.
277 These calls are serialized by the global interpreter lock. */
278
279#ifdef WITH_THREAD
280
Guido van Rossum49b56061998-10-01 20:42:43 +0000281#include "pythread.h"
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000282
Guido van Rossum65d5b571998-12-21 19:32:43 +0000283static PyThread_type_lock import_lock = 0;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000284static long import_lock_thread = -1;
285static int import_lock_level = 0;
286
Benjamin Peterson0df35a92009-10-04 20:32:25 +0000287void
288_PyImport_AcquireLock(void)
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000289{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000290 long me = PyThread_get_thread_ident();
291 if (me == -1)
292 return; /* Too bad */
293 if (import_lock == NULL) {
294 import_lock = PyThread_allocate_lock();
295 if (import_lock == NULL)
296 return; /* Nothing much we can do. */
297 }
298 if (import_lock_thread == me) {
299 import_lock_level++;
300 return;
301 }
302 if (import_lock_thread != -1 || !PyThread_acquire_lock(import_lock, 0))
303 {
304 PyThreadState *tstate = PyEval_SaveThread();
305 PyThread_acquire_lock(import_lock, 1);
306 PyEval_RestoreThread(tstate);
307 }
308 import_lock_thread = me;
309 import_lock_level = 1;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000310}
311
Benjamin Peterson0df35a92009-10-04 20:32:25 +0000312int
313_PyImport_ReleaseLock(void)
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000314{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000315 long me = PyThread_get_thread_ident();
316 if (me == -1 || import_lock == NULL)
317 return 0; /* Too bad */
318 if (import_lock_thread != me)
319 return -1;
320 import_lock_level--;
321 if (import_lock_level == 0) {
322 import_lock_thread = -1;
323 PyThread_release_lock(import_lock);
324 }
325 return 1;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000326}
327
Gregory P. Smith24cec9f2010-03-01 06:18:41 +0000328/* This function is called from PyOS_AfterFork to ensure that newly
329 created child processes do not share locks with the parent.
330 We now acquire the import lock around fork() calls but on some platforms
331 (Solaris 9 and earlier? see isue7242) that still left us with problems. */
Guido van Rossum8ee3e5a2005-09-14 18:09:42 +0000332
333void
334_PyImport_ReInitLock(void)
335{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000336 if (import_lock != NULL)
337 import_lock = PyThread_allocate_lock();
Nick Coghlanb2ddf792010-12-02 04:11:46 +0000338 if (import_lock_level > 1) {
339 /* Forked as a side effect of import */
340 long me = PyThread_get_thread_ident();
341 PyThread_acquire_lock(import_lock, 0);
Victor Stinner942003c2011-03-07 16:57:48 +0100342 /* XXX: can the previous line fail? */
Nick Coghlanb2ddf792010-12-02 04:11:46 +0000343 import_lock_thread = me;
344 import_lock_level--;
345 } else {
346 import_lock_thread = -1;
347 import_lock_level = 0;
348 }
Guido van Rossum8ee3e5a2005-09-14 18:09:42 +0000349}
350
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000351#endif
352
Tim Peters69232342001-08-30 05:16:13 +0000353static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000354imp_lock_held(PyObject *self, PyObject *noargs)
Tim Peters69232342001-08-30 05:16:13 +0000355{
Tim Peters69232342001-08-30 05:16:13 +0000356#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000357 return PyBool_FromLong(import_lock_thread != -1);
Tim Peters69232342001-08-30 05:16:13 +0000358#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000359 return PyBool_FromLong(0);
Tim Peters69232342001-08-30 05:16:13 +0000360#endif
361}
362
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000363static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000364imp_acquire_lock(PyObject *self, PyObject *noargs)
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000365{
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000366#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000367 _PyImport_AcquireLock();
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000368#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000369 Py_INCREF(Py_None);
370 return Py_None;
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000371}
372
373static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000374imp_release_lock(PyObject *self, PyObject *noargs)
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000375{
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000376#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000377 if (_PyImport_ReleaseLock() < 0) {
378 PyErr_SetString(PyExc_RuntimeError,
379 "not holding the import lock");
380 return NULL;
381 }
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000382#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000383 Py_INCREF(Py_None);
384 return Py_None;
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000385}
386
Guido van Rossumd8faa362007-04-27 19:54:29 +0000387static void
388imp_modules_reloading_clear(void)
389{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000390 PyInterpreterState *interp = PyThreadState_Get()->interp;
391 if (interp->modules_reloading != NULL)
392 PyDict_Clear(interp->modules_reloading);
Guido van Rossumd8faa362007-04-27 19:54:29 +0000393}
394
Guido van Rossum25ce5661997-08-02 03:10:38 +0000395/* Helper for sys */
396
397PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000398PyImport_GetModuleDict(void)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000399{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000400 PyInterpreterState *interp = PyThreadState_GET()->interp;
401 if (interp->modules == NULL)
402 Py_FatalError("PyImport_GetModuleDict: no module dictionary!");
403 return interp->modules;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000404}
405
Guido van Rossum3f5da241990-12-20 15:06:42 +0000406
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000407/* List of names to clear in sys */
408static char* sys_deletes[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000409 "path", "argv", "ps1", "ps2",
410 "last_type", "last_value", "last_traceback",
411 "path_hooks", "path_importer_cache", "meta_path",
412 /* misc stuff */
413 "flags", "float_info",
414 NULL
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000415};
416
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000417static char* sys_files[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000418 "stdin", "__stdin__",
419 "stdout", "__stdout__",
420 "stderr", "__stderr__",
421 NULL
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000422};
423
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000424
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000425/* Un-initialize things, as good as we can */
Guido van Rossum3f5da241990-12-20 15:06:42 +0000426
Guido van Rossum3f5da241990-12-20 15:06:42 +0000427void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000428PyImport_Cleanup(void)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000429{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000430 Py_ssize_t pos, ndone;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000431 PyObject *key, *value, *dict;
432 PyInterpreterState *interp = PyThreadState_GET()->interp;
433 PyObject *modules = interp->modules;
Guido van Rossum758eec01998-01-19 21:58:26 +0000434
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000435 if (modules == NULL)
436 return; /* Already done */
Guido van Rossum758eec01998-01-19 21:58:26 +0000437
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000438 /* Delete some special variables first. These are common
439 places where user values hide and people complain when their
440 destructors fail. Since the modules containing them are
441 deleted *last* of all, they would come too late in the normal
442 destruction order. Sigh. */
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000443
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000444 value = PyDict_GetItemString(modules, "builtins");
445 if (value != NULL && PyModule_Check(value)) {
446 dict = PyModule_GetDict(value);
447 if (Py_VerboseFlag)
448 PySys_WriteStderr("# clear builtins._\n");
449 PyDict_SetItemString(dict, "_", Py_None);
450 }
451 value = PyDict_GetItemString(modules, "sys");
452 if (value != NULL && PyModule_Check(value)) {
453 char **p;
454 PyObject *v;
455 dict = PyModule_GetDict(value);
456 for (p = sys_deletes; *p != NULL; p++) {
457 if (Py_VerboseFlag)
458 PySys_WriteStderr("# clear sys.%s\n", *p);
459 PyDict_SetItemString(dict, *p, Py_None);
460 }
461 for (p = sys_files; *p != NULL; p+=2) {
462 if (Py_VerboseFlag)
463 PySys_WriteStderr("# restore sys.%s\n", *p);
464 v = PyDict_GetItemString(dict, *(p+1));
465 if (v == NULL)
466 v = Py_None;
467 PyDict_SetItemString(dict, *p, v);
468 }
469 }
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000470
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000471 /* First, delete __main__ */
472 value = PyDict_GetItemString(modules, "__main__");
473 if (value != NULL && PyModule_Check(value)) {
474 if (Py_VerboseFlag)
475 PySys_WriteStderr("# cleanup __main__\n");
476 _PyModule_Clear(value);
477 PyDict_SetItemString(modules, "__main__", Py_None);
478 }
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000479
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000480 /* The special treatment of "builtins" here is because even
481 when it's not referenced as a module, its dictionary is
482 referenced by almost every module's __builtins__. Since
483 deleting a module clears its dictionary (even if there are
484 references left to it), we need to delete the "builtins"
485 module last. Likewise, we don't delete sys until the very
486 end because it is implicitly referenced (e.g. by print).
Guido van Rossum758eec01998-01-19 21:58:26 +0000487
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000488 Also note that we 'delete' modules by replacing their entry
489 in the modules dict with None, rather than really deleting
490 them; this avoids a rehash of the modules dictionary and
491 also marks them as "non existent" so they won't be
492 re-imported. */
Guido van Rossum758eec01998-01-19 21:58:26 +0000493
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000494 /* Next, repeatedly delete modules with a reference count of
495 one (skipping builtins and sys) and delete them */
496 do {
497 ndone = 0;
498 pos = 0;
499 while (PyDict_Next(modules, &pos, &key, &value)) {
500 if (value->ob_refcnt != 1)
501 continue;
502 if (PyUnicode_Check(key) && PyModule_Check(value)) {
Victor Stinner9464d612011-03-07 17:08:21 +0100503 if (PyUnicode_CompareWithASCIIString(key, "builtins") == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000504 continue;
Victor Stinner9464d612011-03-07 17:08:21 +0100505 if (PyUnicode_CompareWithASCIIString(key, "sys") == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000506 continue;
507 if (Py_VerboseFlag)
Victor Stinner9464d612011-03-07 17:08:21 +0100508 PySys_FormatStderr(
509 "# cleanup[1] %U\n", key);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000510 _PyModule_Clear(value);
511 PyDict_SetItem(modules, key, Py_None);
512 ndone++;
513 }
514 }
515 } while (ndone > 0);
Guido van Rossum758eec01998-01-19 21:58:26 +0000516
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000517 /* Next, delete all modules (still skipping builtins and sys) */
518 pos = 0;
519 while (PyDict_Next(modules, &pos, &key, &value)) {
520 if (PyUnicode_Check(key) && PyModule_Check(value)) {
Victor Stinner9464d612011-03-07 17:08:21 +0100521 if (PyUnicode_CompareWithASCIIString(key, "builtins") == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000522 continue;
Victor Stinner9464d612011-03-07 17:08:21 +0100523 if (PyUnicode_CompareWithASCIIString(key, "sys") == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000524 continue;
525 if (Py_VerboseFlag)
Victor Stinner9464d612011-03-07 17:08:21 +0100526 PySys_FormatStderr("# cleanup[2] %U\n", key);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000527 _PyModule_Clear(value);
528 PyDict_SetItem(modules, key, Py_None);
529 }
530 }
Guido van Rossum758eec01998-01-19 21:58:26 +0000531
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000532 /* Next, delete sys and builtins (in that order) */
533 value = PyDict_GetItemString(modules, "sys");
534 if (value != NULL && PyModule_Check(value)) {
535 if (Py_VerboseFlag)
536 PySys_WriteStderr("# cleanup sys\n");
537 _PyModule_Clear(value);
538 PyDict_SetItemString(modules, "sys", Py_None);
539 }
540 value = PyDict_GetItemString(modules, "builtins");
541 if (value != NULL && PyModule_Check(value)) {
542 if (Py_VerboseFlag)
543 PySys_WriteStderr("# cleanup builtins\n");
544 _PyModule_Clear(value);
545 PyDict_SetItemString(modules, "builtins", Py_None);
546 }
Guido van Rossum758eec01998-01-19 21:58:26 +0000547
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000548 /* Finally, clear and delete the modules directory */
549 PyDict_Clear(modules);
550 interp->modules = NULL;
551 Py_DECREF(modules);
552 Py_CLEAR(interp->modules_reloading);
Guido van Rossum8d15b5d1990-10-26 14:58:58 +0000553}
Guido van Rossum7f133ed1991-02-19 12:23:57 +0000554
555
Barry Warsaw28a691b2010-04-17 00:19:56 +0000556/* Helper for pythonrun.c -- return magic number and tag. */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000557
558long
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000559PyImport_GetMagicNumber(void)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000560{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000561 return pyc_magic;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000562}
563
564
Barry Warsaw28a691b2010-04-17 00:19:56 +0000565const char *
566PyImport_GetMagicTag(void)
567{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000568 return pyc_tag;
Barry Warsaw28a691b2010-04-17 00:19:56 +0000569}
570
Guido van Rossum25ce5661997-08-02 03:10:38 +0000571/* Magic for extension modules (built-in as well as dynamically
572 loaded). To prevent initializing an extension module more than
573 once, we keep a static dictionary 'extensions' keyed by module name
574 (for built-in modules) or by filename (for dynamically loaded
Barry Warsaw92883382001-08-13 23:05:44 +0000575 modules), containing these modules. A copy of the module's
Victor Stinner95872862011-03-07 18:20:56 +0100576 dictionary is stored by calling _PyImport_FixupExtensionObject()
Guido van Rossum25ce5661997-08-02 03:10:38 +0000577 immediately after the module initialization function succeeds. A
578 copy can be retrieved from there by calling
Victor Stinner95872862011-03-07 18:20:56 +0100579 _PyImport_FindExtensionObject().
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000580
Barry Warsaw7c9627b2010-06-17 18:38:20 +0000581 Modules which do support multiple initialization set their m_size
582 field to a non-negative number (indicating the size of the
583 module-specific state). They are still recorded in the extensions
584 dictionary, to avoid loading shared libraries twice.
Martin v. Löwis1a214512008-06-11 05:26:20 +0000585*/
586
587int
Victor Stinner95872862011-03-07 18:20:56 +0100588_PyImport_FixupExtensionObject(PyObject *mod, PyObject *name,
589 PyObject *filename)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000590{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000591 PyObject *modules, *dict;
592 struct PyModuleDef *def;
593 if (extensions == NULL) {
594 extensions = PyDict_New();
595 if (extensions == NULL)
596 return -1;
597 }
598 if (mod == NULL || !PyModule_Check(mod)) {
599 PyErr_BadInternalCall();
600 return -1;
601 }
602 def = PyModule_GetDef(mod);
603 if (!def) {
604 PyErr_BadInternalCall();
605 return -1;
606 }
607 modules = PyImport_GetModuleDict();
Victor Stinner95872862011-03-07 18:20:56 +0100608 if (PyDict_SetItem(modules, name, mod) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000609 return -1;
610 if (_PyState_AddModule(mod, def) < 0) {
Victor Stinner95872862011-03-07 18:20:56 +0100611 PyDict_DelItem(modules, name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000612 return -1;
613 }
614 if (def->m_size == -1) {
615 if (def->m_base.m_copy) {
616 /* Somebody already imported the module,
617 likely under a different name.
618 XXX this should really not happen. */
619 Py_DECREF(def->m_base.m_copy);
620 def->m_base.m_copy = NULL;
621 }
622 dict = PyModule_GetDict(mod);
623 if (dict == NULL)
624 return -1;
625 def->m_base.m_copy = PyDict_Copy(dict);
626 if (def->m_base.m_copy == NULL)
627 return -1;
628 }
Victor Stinner49d3f252010-10-17 01:24:53 +0000629 PyDict_SetItem(extensions, filename, (PyObject*)def);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000630 return 0;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000631}
632
Victor Stinner49d3f252010-10-17 01:24:53 +0000633int
634_PyImport_FixupBuiltin(PyObject *mod, char *name)
635{
636 int res;
Victor Stinner95872862011-03-07 18:20:56 +0100637 PyObject *nameobj;
Victor Stinner21fcd0c2011-03-07 18:28:15 +0100638 nameobj = PyUnicode_InternFromString(name);
Victor Stinner95872862011-03-07 18:20:56 +0100639 if (nameobj == NULL)
Victor Stinner49d3f252010-10-17 01:24:53 +0000640 return -1;
Victor Stinner95872862011-03-07 18:20:56 +0100641 res = _PyImport_FixupExtensionObject(mod, nameobj, nameobj);
642 Py_DECREF(nameobj);
Victor Stinner49d3f252010-10-17 01:24:53 +0000643 return res;
644}
645
Guido van Rossum25ce5661997-08-02 03:10:38 +0000646PyObject *
Victor Stinner95872862011-03-07 18:20:56 +0100647_PyImport_FindExtensionObject(PyObject *name, PyObject *filename)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000648{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000649 PyObject *mod, *mdict;
650 PyModuleDef* def;
651 if (extensions == NULL)
652 return NULL;
Victor Stinner49d3f252010-10-17 01:24:53 +0000653 def = (PyModuleDef*)PyDict_GetItem(extensions, filename);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000654 if (def == NULL)
655 return NULL;
656 if (def->m_size == -1) {
657 /* Module does not support repeated initialization */
658 if (def->m_base.m_copy == NULL)
659 return NULL;
Victor Stinner95872862011-03-07 18:20:56 +0100660 mod = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000661 if (mod == NULL)
662 return NULL;
663 mdict = PyModule_GetDict(mod);
664 if (mdict == NULL)
665 return NULL;
666 if (PyDict_Update(mdict, def->m_base.m_copy))
667 return NULL;
668 }
669 else {
670 if (def->m_base.m_init == NULL)
671 return NULL;
672 mod = def->m_base.m_init();
673 if (mod == NULL)
674 return NULL;
Victor Stinner95872862011-03-07 18:20:56 +0100675 PyDict_SetItem(PyImport_GetModuleDict(), name, mod);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000676 Py_DECREF(mod);
677 }
678 if (_PyState_AddModule(mod, def) < 0) {
Victor Stinner95872862011-03-07 18:20:56 +0100679 PyDict_DelItem(PyImport_GetModuleDict(), name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000680 Py_DECREF(mod);
681 return NULL;
682 }
683 if (Py_VerboseFlag)
Victor Stinner95872862011-03-07 18:20:56 +0100684 PySys_FormatStderr("import %U # previously loaded (%R)\n",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000685 name, filename);
686 return mod;
Brett Cannon9a5b25a2010-03-01 02:09:17 +0000687
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000688}
689
Victor Stinner49d3f252010-10-17 01:24:53 +0000690PyObject *
Victor Stinner501c09a2011-02-23 00:02:00 +0000691_PyImport_FindBuiltin(const char *name)
Victor Stinner49d3f252010-10-17 01:24:53 +0000692{
Victor Stinner95872862011-03-07 18:20:56 +0100693 PyObject *res, *nameobj;
Victor Stinner21fcd0c2011-03-07 18:28:15 +0100694 nameobj = PyUnicode_InternFromString(name);
Victor Stinner95872862011-03-07 18:20:56 +0100695 if (nameobj == NULL)
Victor Stinner49d3f252010-10-17 01:24:53 +0000696 return NULL;
Victor Stinner95872862011-03-07 18:20:56 +0100697 res = _PyImport_FindExtensionObject(nameobj, nameobj);
698 Py_DECREF(nameobj);
Victor Stinner49d3f252010-10-17 01:24:53 +0000699 return res;
700}
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000701
702/* Get the module object corresponding to a module name.
703 First check the modules dictionary if there's one there,
Walter Dörwaldf0dfc7a2003-10-20 14:01:56 +0000704 if not, create a new one and insert it in the modules dictionary.
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000705 Because the former action is most common, THIS DOES NOT RETURN A
706 'NEW' REFERENCE! */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000707
Guido van Rossum79f25d91997-04-29 20:08:16 +0000708PyObject *
Victor Stinner27ee0892011-03-04 12:57:09 +0000709PyImport_AddModuleObject(PyObject *name)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000710{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000711 PyObject *modules = PyImport_GetModuleDict();
712 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000713
Victor Stinner27ee0892011-03-04 12:57:09 +0000714 if ((m = PyDict_GetItem(modules, name)) != NULL &&
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000715 PyModule_Check(m))
716 return m;
Victor Stinner27ee0892011-03-04 12:57:09 +0000717 m = PyModule_NewObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000718 if (m == NULL)
719 return NULL;
Victor Stinner27ee0892011-03-04 12:57:09 +0000720 if (PyDict_SetItem(modules, name, m) != 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000721 Py_DECREF(m);
722 return NULL;
723 }
724 Py_DECREF(m); /* Yes, it still exists, in modules! */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000725
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000726 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000727}
728
Victor Stinner27ee0892011-03-04 12:57:09 +0000729PyObject *
730PyImport_AddModule(const char *name)
731{
732 PyObject *nameobj, *module;
733 nameobj = PyUnicode_FromString(name);
734 if (nameobj == NULL)
735 return NULL;
736 module = PyImport_AddModuleObject(nameobj);
737 Py_DECREF(nameobj);
738 return module;
739}
740
741
Tim Peters1cd70172004-08-02 03:52:12 +0000742/* Remove name from sys.modules, if it's there. */
743static void
Victor Stinner27ee0892011-03-04 12:57:09 +0000744remove_module(PyObject *name)
Tim Peters1cd70172004-08-02 03:52:12 +0000745{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000746 PyObject *modules = PyImport_GetModuleDict();
Victor Stinner27ee0892011-03-04 12:57:09 +0000747 if (PyDict_GetItem(modules, name) == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000748 return;
Victor Stinner27ee0892011-03-04 12:57:09 +0000749 if (PyDict_DelItem(modules, name) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000750 Py_FatalError("import: deleting existing key in"
751 "sys.modules failed");
Tim Peters1cd70172004-08-02 03:52:12 +0000752}
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000753
Victor Stinnerc9abda02011-03-14 13:33:46 -0400754static PyObject * get_sourcefile(PyObject *filename);
755static PyObject *make_source_pathname(PyObject *pathname);
Victor Stinner2f42ae52011-03-20 00:41:24 +0100756static PyObject* make_compiled_pathname(Py_UNICODE *pathname, int debug);
Christian Heimes3b06e532008-01-07 20:12:44 +0000757
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000758/* Execute a code object in a module and return the module object
Tim Peters1cd70172004-08-02 03:52:12 +0000759 * WITH INCREMENTED REFERENCE COUNT. If an error occurs, name is
760 * removed from sys.modules, to avoid leaving damaged module objects
761 * in sys.modules. The caller may wish to restore the original
762 * module object (if any) in this case; PyImport_ReloadModule is an
763 * example.
Barry Warsaw28a691b2010-04-17 00:19:56 +0000764 *
765 * Note that PyImport_ExecCodeModuleWithPathnames() is the preferred, richer
766 * interface. The other two exist primarily for backward compatibility.
Tim Peters1cd70172004-08-02 03:52:12 +0000767 */
Guido van Rossum79f25d91997-04-29 20:08:16 +0000768PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000769PyImport_ExecCodeModule(char *name, PyObject *co)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000770{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000771 return PyImport_ExecCodeModuleWithPathnames(
772 name, co, (char *)NULL, (char *)NULL);
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000773}
774
775PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000776PyImport_ExecCodeModuleEx(char *name, PyObject *co, char *pathname)
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000777{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000778 return PyImport_ExecCodeModuleWithPathnames(
779 name, co, pathname, (char *)NULL);
Barry Warsaw28a691b2010-04-17 00:19:56 +0000780}
781
782PyObject *
783PyImport_ExecCodeModuleWithPathnames(char *name, PyObject *co, char *pathname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000784 char *cpathname)
Barry Warsaw28a691b2010-04-17 00:19:56 +0000785{
Victor Stinner27ee0892011-03-04 12:57:09 +0000786 PyObject *m = NULL;
787 PyObject *nameobj, *pathobj = NULL, *cpathobj = NULL;
788
789 nameobj = PyUnicode_FromString(name);
790 if (nameobj == NULL)
791 return NULL;
792
793 if (pathname != NULL) {
794 pathobj = PyUnicode_DecodeFSDefault(pathname);
795 if (pathobj == NULL)
796 goto error;
797 } else
798 pathobj = NULL;
799 if (cpathname != NULL) {
800 cpathobj = PyUnicode_DecodeFSDefault(cpathname);
801 if (cpathobj == NULL)
802 goto error;
803 } else
804 cpathobj = NULL;
805 m = PyImport_ExecCodeModuleObject(nameobj, co, pathobj, cpathobj);
806error:
807 Py_DECREF(nameobj);
808 Py_XDECREF(pathobj);
809 Py_XDECREF(cpathobj);
810 return m;
811}
812
813PyObject*
814PyImport_ExecCodeModuleObject(PyObject *name, PyObject *co, PyObject *pathname,
815 PyObject *cpathname)
816{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000817 PyObject *modules = PyImport_GetModuleDict();
818 PyObject *m, *d, *v;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000819
Victor Stinner27ee0892011-03-04 12:57:09 +0000820 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000821 if (m == NULL)
822 return NULL;
823 /* If the module is being reloaded, we get the old module back
824 and re-use its dict to exec the new code. */
825 d = PyModule_GetDict(m);
826 if (PyDict_GetItemString(d, "__builtins__") == NULL) {
827 if (PyDict_SetItemString(d, "__builtins__",
828 PyEval_GetBuiltins()) != 0)
829 goto error;
830 }
831 /* Remember the filename as the __file__ attribute */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000832 if (pathname != NULL) {
Victor Stinnerc9abda02011-03-14 13:33:46 -0400833 v = get_sourcefile(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000834 if (v == NULL)
835 PyErr_Clear();
836 }
Victor Stinner27ee0892011-03-04 12:57:09 +0000837 else
838 v = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000839 if (v == NULL) {
840 v = ((PyCodeObject *)co)->co_filename;
841 Py_INCREF(v);
842 }
843 if (PyDict_SetItemString(d, "__file__", v) != 0)
844 PyErr_Clear(); /* Not important enough to report */
845 Py_DECREF(v);
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000846
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000847 /* Remember the pyc path name as the __cached__ attribute. */
Victor Stinner27ee0892011-03-04 12:57:09 +0000848 if (cpathname != NULL)
849 v = cpathname;
850 else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000851 v = Py_None;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000852 if (PyDict_SetItemString(d, "__cached__", v) != 0)
853 PyErr_Clear(); /* Not important enough to report */
Barry Warsaw28a691b2010-04-17 00:19:56 +0000854
Martin v. Löwis4d0d4712010-12-03 20:14:31 +0000855 v = PyEval_EvalCode(co, d, d);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000856 if (v == NULL)
857 goto error;
858 Py_DECREF(v);
Guido van Rossumb65e85c1997-07-10 18:00:45 +0000859
Victor Stinner27ee0892011-03-04 12:57:09 +0000860 if ((m = PyDict_GetItem(modules, name)) == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000861 PyErr_Format(PyExc_ImportError,
Victor Stinner27ee0892011-03-04 12:57:09 +0000862 "Loaded module %R not found in sys.modules",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000863 name);
864 return NULL;
865 }
Guido van Rossumb65e85c1997-07-10 18:00:45 +0000866
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000867 Py_INCREF(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000868
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000869 return m;
Tim Peters1cd70172004-08-02 03:52:12 +0000870
871 error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000872 remove_module(name);
873 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000874}
875
876
Barry Warsaw28a691b2010-04-17 00:19:56 +0000877/* Like strrchr(string, '/') but searches for the rightmost of either SEP
878 or ALTSEP, if the latter is defined.
879*/
Victor Stinnerc9abda02011-03-14 13:33:46 -0400880static Py_UNICODE*
Victor Stinner2f42ae52011-03-20 00:41:24 +0100881rightmost_sep(Py_UNICODE *s)
Victor Stinnerc9abda02011-03-14 13:33:46 -0400882{
883 Py_UNICODE *found, c;
884 for (found = NULL; (c = *s); s++) {
885 if (c == SEP
886#ifdef ALTSEP
887 || c == ALTSEP
888#endif
889 )
890 {
891 found = s;
892 }
893 }
894 return found;
895}
896
897
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000898/* Given a pathname for a Python source file, fill a buffer with the
899 pathname for the corresponding compiled file. Return the pathname
900 for the compiled file, or NULL if there's no space in the buffer.
Victor Stinner2f42ae52011-03-20 00:41:24 +0100901 Doesn't set an exception.
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000902
Victor Stinner2f42ae52011-03-20 00:41:24 +0100903 foo.py -> __pycache__/foo.<tag>.pyc */
904
905static PyObject*
906make_compiled_pathname(Py_UNICODE *pathname, int debug)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000907{
Victor Stinner2f42ae52011-03-20 00:41:24 +0100908 Py_UNICODE buf[MAXPATHLEN];
909 size_t buflen = (size_t)MAXPATHLEN;
910 size_t len = Py_UNICODE_strlen(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000911 size_t i, save;
Victor Stinner2f42ae52011-03-20 00:41:24 +0100912 Py_UNICODE *pos;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000913 int sep = SEP;
Barry Warsaw28a691b2010-04-17 00:19:56 +0000914
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000915 /* Sanity check that the buffer has roughly enough space to hold what
916 will eventually be the full path to the compiled file. The 5 extra
917 bytes include the slash afer __pycache__, the two extra dots, the
918 extra trailing character ('c' or 'o') and null. This isn't exact
919 because the contents of the buffer can affect how many actual
920 characters of the string get into the buffer. We'll do a final
921 sanity check before writing the extension to ensure we do not
922 overflow the buffer.
923 */
Victor Stinner2f42ae52011-03-20 00:41:24 +0100924 if (len + Py_UNICODE_strlen(CACHEDIR_UNICODE) + Py_UNICODE_strlen(PYC_TAG_UNICODE) + 5 > buflen)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000925 return NULL;
Tim Petersc1731372001-08-04 08:12:36 +0000926
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000927 /* Find the last path separator and copy everything from the start of
928 the source string up to and including the separator.
929 */
Victor Stinner2f42ae52011-03-20 00:41:24 +0100930 pos = rightmost_sep(pathname);
931 if (pos == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000932 i = 0;
933 }
934 else {
935 sep = *pos;
936 i = pos - pathname + 1;
Victor Stinner2f42ae52011-03-20 00:41:24 +0100937 Py_UNICODE_strncpy(buf, pathname, i);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000938 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000939
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000940 save = i;
941 buf[i++] = '\0';
942 /* Add __pycache__/ */
Victor Stinner2f42ae52011-03-20 00:41:24 +0100943 Py_UNICODE_strcat(buf, CACHEDIR_UNICODE);
944 i += Py_UNICODE_strlen(CACHEDIR_UNICODE) - 1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000945 buf[i++] = sep;
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
1201static FILE *
Christian Heimes05e8be12008-02-23 18:30:17 +00001202open_exclusive(char *filename, mode_t mode)
Guido van Rossum55a83382000-09-20 20:31:38 +00001203{
1204#if defined(O_EXCL)&&defined(O_CREAT)&&defined(O_WRONLY)&&defined(O_TRUNC)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001205 /* Use O_EXCL to avoid a race condition when another process tries to
1206 write the same file. When that happens, our open() call fails,
1207 which is just fine (since it's only a cache).
1208 XXX If the file exists and is writable but the directory is not
1209 writable, the file will never be written. Oh well.
1210 */
1211 int fd;
1212 (void) unlink(filename);
1213 fd = open(filename, O_EXCL|O_CREAT|O_WRONLY|O_TRUNC
Tim Peters42c83af2000-09-29 04:03:10 +00001214#ifdef O_BINARY
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001215 |O_BINARY /* necessary for Windows */
Tim Peters42c83af2000-09-29 04:03:10 +00001216#endif
Martin v. Löwis79acb9e2002-12-06 12:48:53 +00001217#ifdef __VMS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001218 , mode, "ctxt=bin", "shr=nil"
Martin v. Löwis79acb9e2002-12-06 12:48:53 +00001219#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001220 , mode
Martin v. Löwis79acb9e2002-12-06 12:48:53 +00001221#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001222 );
1223 if (fd < 0)
1224 return NULL;
1225 return fdopen(fd, "wb");
Guido van Rossum55a83382000-09-20 20:31:38 +00001226#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001227 /* Best we can do -- on Windows this can't happen anyway */
1228 return fopen(filename, "wb");
Guido van Rossum55a83382000-09-20 20:31:38 +00001229#endif
1230}
1231
1232
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001233/* Write a compiled module to a file, placing the time of last
1234 modification of its source into the header.
1235 Errors are ignored, if a write error occurs an attempt is made to
1236 remove the file. */
1237
1238static void
Victor Stinner2f42ae52011-03-20 00:41:24 +01001239write_compiled_module(PyCodeObject *co, PyObject *cpathname,
1240 struct stat *srcstat)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001241{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001242 FILE *fp;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001243 time_t mtime = srcstat->st_mtime;
Alexandre Vassalotti9d58e3e2009-07-17 10:55:50 +00001244#ifdef MS_WINDOWS /* since Windows uses different permissions */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001245 mode_t mode = srcstat->st_mode & ~S_IEXEC;
Alexandre Vassalotti9d58e3e2009-07-17 10:55:50 +00001246#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001247 mode_t mode = srcstat->st_mode & ~S_IXUSR & ~S_IXGRP & ~S_IXOTH;
1248 mode_t dirmode = (srcstat->st_mode |
1249 S_IXUSR | S_IXGRP | S_IXOTH |
1250 S_IWUSR | S_IWGRP | S_IWOTH);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001251 PyObject *dirbytes;
Brett Cannon9a5b25a2010-03-01 02:09:17 +00001252#endif
Victor Stinner2f42ae52011-03-20 00:41:24 +01001253 PyObject *cpathbytes, *dirname;
1254 Py_UNICODE *dirsep;
1255 int res, ok;
Barry Warsaw28a691b2010-04-17 00:19:56 +00001256
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001257 /* Ensure that the __pycache__ directory exists. */
Victor Stinner2f42ae52011-03-20 00:41:24 +01001258 dirsep = rightmost_sep(PyUnicode_AS_UNICODE(cpathname));
1259 if (dirsep == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001260 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001261 PySys_FormatStderr("# no %s path found %R\n", CACHEDIR, cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001262 return;
1263 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01001264 dirname = PyUnicode_FromUnicode(PyUnicode_AS_UNICODE(cpathname),
1265 dirsep - PyUnicode_AS_UNICODE(cpathname));
1266 if (dirname == NULL) {
1267 PyErr_Clear();
1268 return;
1269 }
Daniel Stutzbachc7937792010-09-09 21:18:04 +00001270
1271#ifdef MS_WINDOWS
Victor Stinner2f42ae52011-03-20 00:41:24 +01001272 res = CreateDirectoryW(PyUnicode_AS_UNICODE(dirname), NULL);
1273 ok = (res != 0);
1274 if (!ok && GetLastError() == ERROR_ALREADY_EXISTS)
1275 ok = 1;
Daniel Stutzbachc7937792010-09-09 21:18:04 +00001276#else
Victor Stinner2f42ae52011-03-20 00:41:24 +01001277 dirbytes = PyUnicode_EncodeFSDefault(dirname);
1278 if (dirbytes == NULL) {
1279 PyErr_Clear();
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001280 return;
1281 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01001282 res = mkdir(PyBytes_AS_STRING(dirbytes), dirmode);
1283 Py_DECREF(dirbytes);
1284 if (0 <= res)
1285 ok = 1;
1286 else
1287 ok = (errno == EEXIST);
1288#endif
1289 if (!ok) {
1290 if (Py_VerboseFlag)
1291 PySys_FormatStderr("# cannot create cache dir %R\n", dirname);
1292 Py_DECREF(dirname);
1293 return;
1294 }
1295 Py_DECREF(dirname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001296
Victor Stinner2f42ae52011-03-20 00:41:24 +01001297 cpathbytes = PyUnicode_EncodeFSDefault(cpathname);
1298 if (cpathbytes == NULL) {
1299 PyErr_Clear();
1300 return;
1301 }
1302
1303 fp = open_exclusive(PyBytes_AS_STRING(cpathbytes), mode);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001304 if (fp == NULL) {
1305 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001306 PySys_FormatStderr(
1307 "# can't create %R\n", cpathname);
1308 Py_DECREF(cpathbytes);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001309 return;
1310 }
1311 PyMarshal_WriteLongToFile(pyc_magic, fp, Py_MARSHAL_VERSION);
1312 /* First write a 0 for mtime */
1313 PyMarshal_WriteLongToFile(0L, fp, Py_MARSHAL_VERSION);
1314 PyMarshal_WriteObjectToFile((PyObject *)co, fp, Py_MARSHAL_VERSION);
1315 if (fflush(fp) != 0 || ferror(fp)) {
1316 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001317 PySys_FormatStderr("# can't write %R\n", cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001318 /* Don't keep partial file */
1319 fclose(fp);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001320#ifdef MS_WINDOWS
1321 (void)DeleteFileW(PyUnicode_AS_UNICODE(cpathname));
1322#else
1323 (void) unlink(PyBytes_AS_STRING(cpathbytes));
1324#endif
1325 Py_DECREF(cpathbytes);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001326 return;
1327 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01001328 Py_DECREF(cpathbytes);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001329 /* Now write the true mtime */
1330 fseek(fp, 4L, 0);
1331 assert(mtime < LONG_MAX);
1332 PyMarshal_WriteLongToFile((long)mtime, fp, Py_MARSHAL_VERSION);
1333 fflush(fp);
1334 fclose(fp);
1335 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001336 PySys_FormatStderr("# wrote %R\n", cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001337}
1338
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001339static void
1340update_code_filenames(PyCodeObject *co, PyObject *oldname, PyObject *newname)
1341{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001342 PyObject *constants, *tmp;
1343 Py_ssize_t i, n;
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001344
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001345 if (PyUnicode_Compare(co->co_filename, oldname))
1346 return;
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001347
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001348 tmp = co->co_filename;
1349 co->co_filename = newname;
1350 Py_INCREF(co->co_filename);
1351 Py_DECREF(tmp);
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001352
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001353 constants = co->co_consts;
1354 n = PyTuple_GET_SIZE(constants);
1355 for (i = 0; i < n; i++) {
1356 tmp = PyTuple_GET_ITEM(constants, i);
1357 if (PyCode_Check(tmp))
1358 update_code_filenames((PyCodeObject *)tmp,
1359 oldname, newname);
1360 }
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001361}
1362
Victor Stinner2f42ae52011-03-20 00:41:24 +01001363static void
1364update_compiled_module(PyCodeObject *co, PyObject *newname)
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001365{
Victor Stinner2f42ae52011-03-20 00:41:24 +01001366 PyObject *oldname;
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001367
Victor Stinner2f42ae52011-03-20 00:41:24 +01001368 if (PyUnicode_Compare(co->co_filename, newname) == 0)
1369 return;
Hirokazu Yamamoto4f447fb2009-03-04 01:52:10 +00001370
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001371 oldname = co->co_filename;
1372 Py_INCREF(oldname);
1373 update_code_filenames(co, oldname, newname);
1374 Py_DECREF(oldname);
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001375}
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001376
Brett Cannon442c9b92011-03-23 16:14:42 -07001377static PyObject *
1378imp_fix_co_filename(PyObject *self, PyObject *args)
1379{
1380 PyObject *co;
1381 PyObject *file_path;
1382
1383 if (!PyArg_ParseTuple(args, "OO:_fix_co_filename", &co, &file_path))
1384 return NULL;
1385
1386 if (!PyCode_Check(co)) {
1387 PyErr_SetString(PyExc_TypeError,
1388 "first argument must be a code object");
1389 return NULL;
1390 }
1391
1392 if (!PyUnicode_Check(file_path)) {
1393 PyErr_SetString(PyExc_TypeError,
1394 "second argument must be a string");
1395 return NULL;
1396 }
1397
1398 update_compiled_module((PyCodeObject*)co, file_path);
1399
1400 Py_RETURN_NONE;
1401}
1402
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001403/* Load a source module from a given file and return its module
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001404 object WITH INCREMENTED REFERENCE COUNT. If there's a matching
1405 byte-compiled file, use that instead. */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001406
Guido van Rossum79f25d91997-04-29 20:08:16 +00001407static PyObject *
Victor Stinner2f42ae52011-03-20 00:41:24 +01001408load_source_module(PyObject *name, PyObject *pathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001409{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001410 struct stat st;
1411 FILE *fpc;
Victor Stinner2f42ae52011-03-20 00:41:24 +01001412 PyObject *cpathname = NULL, *cpathbytes = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001413 PyCodeObject *co;
Victor Stinner2f42ae52011-03-20 00:41:24 +01001414 PyObject *m = NULL;
Brett Cannon9a5b25a2010-03-01 02:09:17 +00001415
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001416 if (fstat(fileno(fp), &st) != 0) {
1417 PyErr_Format(PyExc_RuntimeError,
Victor Stinner2f42ae52011-03-20 00:41:24 +01001418 "unable to get file status from %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001419 pathname);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001420 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001421 }
Fred Drake4c82b232000-06-30 16:18:57 +00001422#if SIZEOF_TIME_T > 4
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001423 /* Python's .pyc timestamp handling presumes that the timestamp fits
1424 in 4 bytes. This will be fine until sometime in the year 2038,
1425 when a 4-byte signed time_t will overflow.
1426 */
1427 if (st.st_mtime >> 32) {
1428 PyErr_SetString(PyExc_OverflowError,
1429 "modification time overflows a 4 byte field");
Victor Stinner2f42ae52011-03-20 00:41:24 +01001430 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001431 }
Fred Drake4c82b232000-06-30 16:18:57 +00001432#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001433 cpathname = make_compiled_pathname(
Victor Stinner2f42ae52011-03-20 00:41:24 +01001434 PyUnicode_AS_UNICODE(pathname),
1435 !Py_OptimizeFlag);
1436
1437 if (cpathname != NULL)
1438 fpc = check_compiled_module(pathname, st.st_mtime, cpathname);
1439 else
1440 fpc = NULL;
1441
1442 if (fpc) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001443 co = read_compiled_module(cpathname, fpc);
1444 fclose(fpc);
1445 if (co == NULL)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001446 goto error;
1447 update_compiled_module(co, pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001448 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001449 PySys_FormatStderr("import %U # precompiled from %R\n",
1450 name, cpathname);
1451 m = PyImport_ExecCodeModuleObject(name, (PyObject *)co,
1452 cpathname, cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001453 }
1454 else {
1455 co = parse_source_module(pathname, fp);
1456 if (co == NULL)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001457 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001458 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001459 PySys_FormatStderr("import %U # from %R\n",
Victor Stinner98dbba52011-03-14 15:15:47 -04001460 name, pathname);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001461 if (cpathname != NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001462 PyObject *ro = PySys_GetObject("dont_write_bytecode");
1463 if (ro == NULL || !PyObject_IsTrue(ro))
1464 write_compiled_module(co, cpathname, &st);
1465 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01001466 m = PyImport_ExecCodeModuleObject(name, (PyObject *)co,
1467 pathname, cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001468 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001469 Py_DECREF(co);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001470
Victor Stinner2f42ae52011-03-20 00:41:24 +01001471error:
1472 Py_XDECREF(cpathbytes);
1473 Py_XDECREF(cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001474 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001475}
1476
Christian Heimes3b06e532008-01-07 20:12:44 +00001477/* Get source file -> unicode or None
1478 * Returns the path to the py file if available, else the given path
1479 */
1480static PyObject *
Victor Stinnerc9abda02011-03-14 13:33:46 -04001481get_sourcefile(PyObject *filename)
Christian Heimes3b06e532008-01-07 20:12:44 +00001482{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001483 Py_ssize_t len;
Victor Stinnerc9abda02011-03-14 13:33:46 -04001484 Py_UNICODE *fileuni;
1485 PyObject *py;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001486 struct stat statbuf;
Christian Heimes3b06e532008-01-07 20:12:44 +00001487
Victor Stinnerc9abda02011-03-14 13:33:46 -04001488 len = PyUnicode_GET_SIZE(filename);
1489 if (len == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001490 Py_RETURN_NONE;
Christian Heimes3b06e532008-01-07 20:12:44 +00001491
Victor Stinnerc9abda02011-03-14 13:33:46 -04001492 /* don't match *.pyc or *.pyo? */
1493 fileuni = PyUnicode_AS_UNICODE(filename);
1494 if (len < 5
1495 || fileuni[len-4] != '.'
1496 || (fileuni[len-3] != 'p' && fileuni[len-3] != 'P')
1497 || (fileuni[len-2] != 'y' && fileuni[len-2] != 'Y'))
1498 goto unchanged;
Christian Heimes3b06e532008-01-07 20:12:44 +00001499
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001500 /* Start by trying to turn PEP 3147 path into source path. If that
1501 * fails, just chop off the trailing character, i.e. legacy pyc path
1502 * to py.
1503 */
Victor Stinnerc9abda02011-03-14 13:33:46 -04001504 py = make_source_pathname(filename);
1505 if (py == NULL) {
1506 PyErr_Clear();
1507 py = PyUnicode_FromUnicode(fileuni, len - 1);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001508 }
Victor Stinnerc9abda02011-03-14 13:33:46 -04001509 if (py == NULL)
1510 goto error;
Barry Warsaw28a691b2010-04-17 00:19:56 +00001511
Victor Stinnerc9abda02011-03-14 13:33:46 -04001512 if (_Py_stat(py, &statbuf) == 0 && S_ISREG(statbuf.st_mode))
1513 return py;
1514 Py_DECREF(py);
1515 goto unchanged;
1516
1517error:
1518 PyErr_Clear();
1519unchanged:
1520 Py_INCREF(filename);
1521 return filename;
Christian Heimes3b06e532008-01-07 20:12:44 +00001522}
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001523
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001524/* Forward */
Victor Stinner41c5fec2011-03-13 21:46:30 -04001525static PyObject *load_module(PyObject *, FILE *, PyObject *, int, PyObject *);
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001526static struct filedescr *find_module(PyObject *, PyObject *, PyObject *,
Victor Stinner2fd76e42011-03-14 15:19:39 -04001527 PyObject **, FILE **, PyObject **);
Victor Stinner53dc7352011-03-20 01:50:21 +01001528static struct _frozen * find_frozen(PyObject *);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001529
1530/* Load a package and return its module object WITH INCREMENTED
1531 REFERENCE COUNT */
1532
1533static PyObject *
Victor Stinnerc9abda02011-03-14 13:33:46 -04001534load_package(PyObject *name, PyObject *pathname)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001535{
Victor Stinner41c5fec2011-03-13 21:46:30 -04001536 PyObject *m, *d, *bufobj;
Victor Stinnerc9abda02011-03-14 13:33:46 -04001537 PyObject *file = NULL, *path_list = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001538 int err;
Victor Stinnerc9abda02011-03-14 13:33:46 -04001539 FILE *fp = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001540 struct filedescr *fdp;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001541
Victor Stinnerc9abda02011-03-14 13:33:46 -04001542 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001543 if (m == NULL)
1544 return NULL;
1545 if (Py_VerboseFlag)
Victor Stinner98dbba52011-03-14 15:15:47 -04001546 PySys_FormatStderr("import %U # directory %R\n",
1547 name, pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001548 file = get_sourcefile(pathname);
1549 if (file == NULL)
Victor Stinnerc9abda02011-03-14 13:33:46 -04001550 return NULL;
1551 path_list = Py_BuildValue("[O]", file);
1552 if (path_list == NULL) {
1553 Py_DECREF(file);
1554 return NULL;
1555 }
1556 d = PyModule_GetDict(m);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001557 err = PyDict_SetItemString(d, "__file__", file);
Victor Stinnerc9abda02011-03-14 13:33:46 -04001558 Py_DECREF(file);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001559 if (err == 0)
Victor Stinnerc9abda02011-03-14 13:33:46 -04001560 err = PyDict_SetItemString(d, "__path__", path_list);
1561 if (err != 0) {
1562 Py_DECREF(path_list);
1563 return NULL;
1564 }
Victor Stinner533d7832011-03-14 13:22:54 -04001565 fdp = find_module(name, initstr, path_list,
Victor Stinner2fd76e42011-03-14 15:19:39 -04001566 &bufobj, &fp, NULL);
Victor Stinnerc9abda02011-03-14 13:33:46 -04001567 Py_DECREF(path_list);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001568 if (fdp == NULL) {
1569 if (PyErr_ExceptionMatches(PyExc_ImportError)) {
1570 PyErr_Clear();
1571 Py_INCREF(m);
Victor Stinnerc9abda02011-03-14 13:33:46 -04001572 return m;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001573 }
1574 else
Victor Stinnerc9abda02011-03-14 13:33:46 -04001575 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001576 }
Victor Stinner2fd76e42011-03-14 15:19:39 -04001577 m = load_module(name, fp, bufobj, fdp->type, NULL);
1578 Py_XDECREF(bufobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001579 if (fp != NULL)
1580 fclose(fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001581 return m;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001582}
1583
1584
1585/* Helper to test for built-in module */
1586
1587static int
Victor Stinner95872862011-03-07 18:20:56 +01001588is_builtin(PyObject *name)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001589{
Victor Stinner95872862011-03-07 18:20:56 +01001590 int i, cmp;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001591 for (i = 0; PyImport_Inittab[i].name != NULL; i++) {
Victor Stinner95872862011-03-07 18:20:56 +01001592 cmp = PyUnicode_CompareWithASCIIString(name, PyImport_Inittab[i].name);
1593 if (cmp == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001594 if (PyImport_Inittab[i].initfunc == NULL)
1595 return -1;
1596 else
1597 return 1;
1598 }
1599 }
1600 return 0;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001601}
1602
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001603
Just van Rossum52e14d62002-12-30 22:08:05 +00001604/* Return an importer object for a sys.path/pkg.__path__ item 'p',
1605 possibly by fetching it from the path_importer_cache dict. If it
Thomas Wouters89f507f2006-12-13 04:49:30 +00001606 wasn't yet cached, traverse path_hooks until a hook is found
Just van Rossum52e14d62002-12-30 22:08:05 +00001607 that can handle the path item. Return None if no hook could;
1608 this tells our caller it should fall back to the builtin
1609 import mechanism. Cache the result in path_importer_cache.
1610 Returns a borrowed reference. */
1611
1612static PyObject *
1613get_path_importer(PyObject *path_importer_cache, PyObject *path_hooks,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001614 PyObject *p)
Just van Rossum52e14d62002-12-30 22:08:05 +00001615{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001616 PyObject *importer;
1617 Py_ssize_t j, nhooks;
Just van Rossum52e14d62002-12-30 22:08:05 +00001618
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001619 /* These conditions are the caller's responsibility: */
1620 assert(PyList_Check(path_hooks));
1621 assert(PyDict_Check(path_importer_cache));
Just van Rossum52e14d62002-12-30 22:08:05 +00001622
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001623 nhooks = PyList_Size(path_hooks);
1624 if (nhooks < 0)
1625 return NULL; /* Shouldn't happen */
Just van Rossum52e14d62002-12-30 22:08:05 +00001626
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001627 importer = PyDict_GetItem(path_importer_cache, p);
1628 if (importer != NULL)
1629 return importer;
Just van Rossum52e14d62002-12-30 22:08:05 +00001630
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001631 /* set path_importer_cache[p] to None to avoid recursion */
1632 if (PyDict_SetItem(path_importer_cache, p, Py_None) != 0)
1633 return NULL;
Just van Rossum52e14d62002-12-30 22:08:05 +00001634
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001635 for (j = 0; j < nhooks; j++) {
1636 PyObject *hook = PyList_GetItem(path_hooks, j);
1637 if (hook == NULL)
1638 return NULL;
1639 importer = PyObject_CallFunctionObjArgs(hook, p, NULL);
1640 if (importer != NULL)
1641 break;
Just van Rossum52e14d62002-12-30 22:08:05 +00001642
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001643 if (!PyErr_ExceptionMatches(PyExc_ImportError)) {
1644 return NULL;
1645 }
1646 PyErr_Clear();
1647 }
1648 if (importer == NULL) {
1649 importer = PyObject_CallFunctionObjArgs(
1650 (PyObject *)&PyNullImporter_Type, p, NULL
1651 );
1652 if (importer == NULL) {
1653 if (PyErr_ExceptionMatches(PyExc_ImportError)) {
1654 PyErr_Clear();
1655 return Py_None;
1656 }
1657 }
1658 }
1659 if (importer != NULL) {
1660 int err = PyDict_SetItem(path_importer_cache, p, importer);
1661 Py_DECREF(importer);
1662 if (err != 0)
1663 return NULL;
1664 }
1665 return importer;
Just van Rossum52e14d62002-12-30 22:08:05 +00001666}
1667
Christian Heimes9cd17752007-11-18 19:35:23 +00001668PyAPI_FUNC(PyObject *)
1669PyImport_GetImporter(PyObject *path) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001670 PyObject *importer=NULL, *path_importer_cache=NULL, *path_hooks=NULL;
Christian Heimes9cd17752007-11-18 19:35:23 +00001671
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001672 if ((path_importer_cache = PySys_GetObject("path_importer_cache"))) {
1673 if ((path_hooks = PySys_GetObject("path_hooks"))) {
1674 importer = get_path_importer(path_importer_cache,
1675 path_hooks, path);
1676 }
1677 }
1678 Py_XINCREF(importer); /* get_path_importer returns a borrowed reference */
1679 return importer;
Christian Heimes9cd17752007-11-18 19:35:23 +00001680}
1681
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001682/* Search the path (default sys.path) for a module. Return the
1683 corresponding filedescr struct, and (via return arguments) the
1684 pathname and an open file. Return NULL if the module is not found. */
1685
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001686#ifdef MS_COREDLL
Victor Stinner4d6c1c42011-03-08 23:49:04 +01001687extern FILE *_PyWin_FindRegisteredModule(PyObject *, struct filedescr **,
1688 PyObject **p_path);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001689#endif
1690
Victor Stinner547a2a62011-03-20 03:07:28 +01001691/* Forward */
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001692static int case_ok(PyObject *, Py_ssize_t, PyObject *);
Victor Stinner547a2a62011-03-20 03:07:28 +01001693static int find_init_module(PyObject *);
Just van Rossum52e14d62002-12-30 22:08:05 +00001694static struct filedescr importhookdescr = {"", "", IMP_HOOK};
Guido van Rossum197346f1997-10-31 18:38:52 +00001695
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001696/* Get the path of a module: get its importer and call importer.find_module()
1697 hook, or check if the module if a package (if path/__init__.py exists).
1698
1699 -1: error: a Python error occurred
1700 0: ignore: an error occurred because of invalid data, but the error is not
1701 important enough to be reported.
1702 1: get path: module not found, but *buf contains its path
1703 2: found: *p_fd is the file descriptor (IMP_HOOK or PKG_DIRECTORY)
1704 and *buf is the path */
1705
1706static int
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001707find_module_path(PyObject *fullname, PyObject *name, PyObject *path,
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001708 PyObject *path_hooks, PyObject *path_importer_cache,
Victor Stinner2fd76e42011-03-14 15:19:39 -04001709 PyObject **p_path, PyObject **p_loader, struct filedescr **p_fd)
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001710{
Victor Stinner2fd76e42011-03-14 15:19:39 -04001711 Py_UNICODE buf[MAXPATHLEN+1];
1712 Py_ssize_t buflen = MAXPATHLEN+1;
1713 PyObject *path_unicode, *filename;
1714 const Py_UNICODE *base;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001715 Py_ssize_t len;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001716 struct stat statbuf;
1717 static struct filedescr fd_package = {"", "", PKG_DIRECTORY};
1718
1719 if (PyUnicode_Check(path)) {
Victor Stinner2fd76e42011-03-14 15:19:39 -04001720 Py_INCREF(path);
1721 path_unicode = path;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001722 }
1723 else if (PyBytes_Check(path)) {
Victor Stinner2fd76e42011-03-14 15:19:39 -04001724 path_unicode = PyUnicode_DecodeFSDefaultAndSize(
1725 PyBytes_AS_STRING(path), PyBytes_GET_SIZE(path));
1726 if (path_unicode == NULL)
1727 return -1;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001728 }
1729 else
1730 return 0;
1731
Victor Stinner2fd76e42011-03-14 15:19:39 -04001732 base = PyUnicode_AS_UNICODE(path_unicode);
1733 len = PyUnicode_GET_SIZE(path_unicode);
1734 if (len + 2 + PyUnicode_GET_SIZE(name) + MAXSUFFIXSIZE >= buflen) {
1735 Py_DECREF(path_unicode);
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001736 return 0; /* Too long */
1737 }
Victor Stinner2fd76e42011-03-14 15:19:39 -04001738 Py_UNICODE_strcpy(buf, PyUnicode_AS_UNICODE(path_unicode));
1739 Py_DECREF(path_unicode);
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001740
Victor Stinner2fd76e42011-03-14 15:19:39 -04001741 if (Py_UNICODE_strlen(buf) != len)
1742 return 0; /* path contains '\0' */
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001743
1744 /* sys.path_hooks import hook */
1745 if (p_loader != NULL) {
1746 PyObject *importer;
1747
1748 importer = get_path_importer(path_importer_cache,
1749 path_hooks, path);
1750 if (importer == NULL) {
1751 return -1;
1752 }
1753 /* Note: importer is a borrowed reference */
1754 if (importer != Py_None) {
1755 PyObject *loader;
1756 loader = PyObject_CallMethod(importer,
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001757 "find_module", "O", fullname);
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001758 if (loader == NULL)
1759 return -1; /* error */
1760 if (loader != Py_None) {
1761 /* a loader was found */
1762 *p_loader = loader;
1763 *p_fd = &importhookdescr;
1764 return 2;
1765 }
1766 Py_DECREF(loader);
1767 return 0;
1768 }
1769 }
1770 /* no hook was found, use builtin import */
1771
1772 if (len > 0 && buf[len-1] != SEP
1773#ifdef ALTSEP
1774 && buf[len-1] != ALTSEP
1775#endif
1776 )
1777 buf[len++] = SEP;
Victor Stinner2fd76e42011-03-14 15:19:39 -04001778 Py_UNICODE_strcpy(buf+len, PyUnicode_AS_UNICODE(name));
1779 len += PyUnicode_GET_SIZE(name);
1780
1781 filename = PyUnicode_FromUnicode(buf, len);
1782 if (filename == NULL)
1783 return -1;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001784
1785 /* Check for package import (buf holds a directory name,
1786 and there's an __init__ module in that directory */
1787#ifdef HAVE_STAT
Victor Stinner2fd76e42011-03-14 15:19:39 -04001788 if (_Py_stat(filename, &statbuf) == 0 && /* it exists */
Victor Stinnerd0296212011-03-14 14:04:10 -04001789 S_ISDIR(statbuf.st_mode)) /* it's a directory */
1790 {
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001791 int match;
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001792
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001793 match = case_ok(filename, 0, name);
1794 if (match < 0) {
1795 Py_DECREF(filename);
1796 return -1;
1797 }
1798 if (match) { /* case matches */
1799 if (find_init_module(filename)) { /* and has __init__.py */
Victor Stinner2fd76e42011-03-14 15:19:39 -04001800 *p_path = filename;
Victor Stinnerd0296212011-03-14 14:04:10 -04001801 *p_fd = &fd_package;
1802 return 2;
1803 }
1804 else {
1805 int err;
Victor Stinnerd0296212011-03-14 14:04:10 -04001806 err = PyErr_WarnFormat(PyExc_ImportWarning, 1,
Victor Stinner547a2a62011-03-20 03:07:28 +01001807 "Not importing directory %R: missing __init__.py",
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001808 filename);
Victor Stinner547a2a62011-03-20 03:07:28 +01001809 if (err) {
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001810 Py_DECREF(filename);
Victor Stinnerd0296212011-03-14 14:04:10 -04001811 return -1;
Victor Stinner547a2a62011-03-20 03:07:28 +01001812 }
Victor Stinnerd0296212011-03-14 14:04:10 -04001813 }
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001814 }
1815 }
1816#endif
Victor Stinner2fd76e42011-03-14 15:19:39 -04001817 *p_path = filename;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001818 return 1;
1819}
1820
1821/* Find a module in search_path_list. For each path, try
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001822 find_module_path() or try each _PyImport_Filetab suffix.
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001823
1824 If the module is found, return a file descriptor, write the path in
1825 *p_filename, write the pointer to the file object into *p_fp, and (if
1826 p_loader is not NULL) the loader into *p_loader.
1827
1828 Otherwise, raise an exception and return NULL. */
1829
Victor Stinner37580282011-03-20 01:34:43 +01001830static struct filedescr*
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001831find_module_path_list(PyObject *fullname, PyObject *name,
Victor Stinner37580282011-03-20 01:34:43 +01001832 PyObject *search_path_list, PyObject *path_hooks,
1833 PyObject *path_importer_cache,
Victor Stinner2fd76e42011-03-14 15:19:39 -04001834 PyObject **p_path, FILE **p_fp, PyObject **p_loader)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001835{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001836 Py_ssize_t i, npath;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001837 struct filedescr *fdp = NULL;
1838 char *filemode;
1839 FILE *fp = NULL;
Victor Stinner2fd76e42011-03-14 15:19:39 -04001840 PyObject *prefix, *filename;
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001841 int match;
Victor Stinner53dc7352011-03-20 01:50:21 +01001842
Victor Stinner37580282011-03-20 01:34:43 +01001843 npath = PyList_Size(search_path_list);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001844 for (i = 0; i < npath; i++) {
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001845 PyObject *path;
1846 int ok;
1847
1848 path = PyList_GetItem(search_path_list, i);
1849 if (path == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001850 return NULL;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001851
Victor Stinner2fd76e42011-03-14 15:19:39 -04001852 prefix = NULL;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001853 ok = find_module_path(fullname, name, path,
1854 path_hooks, path_importer_cache,
Victor Stinner2fd76e42011-03-14 15:19:39 -04001855 &prefix, p_loader, &fdp);
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001856 if (ok < 0)
1857 return NULL;
1858 if (ok == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001859 continue;
Victor Stinner2fd76e42011-03-14 15:19:39 -04001860 if (ok == 2) {
1861 *p_path = prefix;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001862 return fdp;
Victor Stinner2fd76e42011-03-14 15:19:39 -04001863 }
Amaury Forgeot d'Arcf1ca0b12008-06-11 17:40:47 +00001864
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001865 for (fdp = _PyImport_Filetab; fdp->suffix != NULL; fdp++) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001866 filemode = fdp->mode;
1867 if (filemode[0] == 'U')
1868 filemode = "r" PY_STDIOTEXTMODE;
Victor Stinnerd0296212011-03-14 14:04:10 -04001869
Victor Stinner2fd76e42011-03-14 15:19:39 -04001870 filename = PyUnicode_FromFormat("%U%s", prefix, fdp->suffix);
1871 if (filename == NULL) {
1872 Py_DECREF(prefix);
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001873 return NULL;
Victor Stinner2fd76e42011-03-14 15:19:39 -04001874 }
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001875
1876 if (Py_VerboseFlag > 1)
1877 PySys_FormatStderr("# trying %R\n", filename);
1878
1879 fp = _Py_fopen(filename, filemode);
1880 if (fp == NULL) {
1881 Py_DECREF(filename);
1882 continue;
1883 }
1884 match = case_ok(filename, -(Py_ssize_t)strlen(fdp->suffix), name);
1885 if (match < 0) {
Victor Stinner2fd76e42011-03-14 15:19:39 -04001886 Py_DECREF(prefix);
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001887 Py_DECREF(filename);
1888 return NULL;
1889 }
1890 if (match) {
Victor Stinner2fd76e42011-03-14 15:19:39 -04001891 Py_DECREF(prefix);
1892 *p_path = filename;
Victor Stinnerd0296212011-03-14 14:04:10 -04001893 *p_fp = fp;
1894 return fdp;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001895 }
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001896 Py_DECREF(filename);
Victor Stinnerd0296212011-03-14 14:04:10 -04001897
1898 fclose(fp);
1899 fp = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001900 }
Victor Stinner2fd76e42011-03-14 15:19:39 -04001901 Py_DECREF(prefix);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001902 }
Victor Stinnerd0296212011-03-14 14:04:10 -04001903 PyErr_Format(PyExc_ImportError,
Victor Stinner98dbba52011-03-14 15:15:47 -04001904 "No module named %R", name);
Victor Stinnerd0296212011-03-14 14:04:10 -04001905 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001906}
1907
Victor Stinner37580282011-03-20 01:34:43 +01001908/* Find a module:
1909
1910 - try find_module() of each sys.meta_path hook
1911 - try find_frozen()
1912 - try is_builtin()
1913 - try _PyWin_FindRegisteredModule() (Windows only)
1914 - otherwise, call find_module_path_list() with search_path_list (if not
1915 NULL) or sys.path
1916
Victor Stinner2fd76e42011-03-14 15:19:39 -04001917 fullname can be NULL, but only if p_loader is NULL.
1918
Victor Stinner37580282011-03-20 01:34:43 +01001919 Return:
1920
1921 - &fd_builtin (C_BUILTIN) if it is a builtin
1922 - &fd_frozen (PY_FROZEN) if it is frozen
Victor Stinner2fd76e42011-03-14 15:19:39 -04001923 - &fd_package (PKG_DIRECTORY) and write the filename into *p_path
Victor Stinner37580282011-03-20 01:34:43 +01001924 if it is a package
1925 - &importhookdescr (IMP_HOOK) and write the loader into *p_loader if a
1926 importer loader was found
1927 - a file descriptor (PY_SOURCE, PY_COMPILED, C_EXTENSION, PY_RESOURCE or
1928 PY_CODERESOURCE: see _PyImport_Filetab), write the filename into
Victor Stinner2fd76e42011-03-14 15:19:39 -04001929 *p_path and the pointer to the open file into *p_fp
Victor Stinner37580282011-03-20 01:34:43 +01001930 - NULL on error
1931
Victor Stinner2fd76e42011-03-14 15:19:39 -04001932 By default, *p_path, *p_fp and *p_loader (if set) are set to NULL.
1933 Eg. *p_path is set to NULL for a builtin package.
1934*/
Victor Stinner37580282011-03-20 01:34:43 +01001935
1936static struct filedescr *
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001937find_module(PyObject *fullname, PyObject *name, PyObject *search_path_list,
Victor Stinner2fd76e42011-03-14 15:19:39 -04001938 PyObject **p_path, FILE **p_fp, PyObject **p_loader)
Victor Stinner37580282011-03-20 01:34:43 +01001939{
1940 Py_ssize_t i, npath;
1941 static struct filedescr fd_frozen = {"", "", PY_FROZEN};
1942 static struct filedescr fd_builtin = {"", "", C_BUILTIN};
1943 PyObject *path_hooks, *path_importer_cache;
Victor Stinner37580282011-03-20 01:34:43 +01001944
Victor Stinner2fd76e42011-03-14 15:19:39 -04001945 *p_path = NULL;
Victor Stinner37580282011-03-20 01:34:43 +01001946 *p_fp = NULL;
1947 if (p_loader != NULL)
1948 *p_loader = NULL;
1949
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001950 if (PyUnicode_GET_SIZE(name) > MAXPATHLEN) {
Victor Stinner37580282011-03-20 01:34:43 +01001951 PyErr_SetString(PyExc_OverflowError,
1952 "module name is too long");
1953 return NULL;
1954 }
1955
1956 /* sys.meta_path import hook */
1957 if (p_loader != NULL) {
1958 PyObject *meta_path;
1959
1960 meta_path = PySys_GetObject("meta_path");
1961 if (meta_path == NULL || !PyList_Check(meta_path)) {
1962 PyErr_SetString(PyExc_ImportError,
1963 "sys.meta_path must be a list of "
1964 "import hooks");
1965 return NULL;
1966 }
1967 Py_INCREF(meta_path); /* zap guard */
1968 npath = PyList_Size(meta_path);
1969 for (i = 0; i < npath; i++) {
1970 PyObject *loader;
1971 PyObject *hook = PyList_GetItem(meta_path, i);
1972 loader = PyObject_CallMethod(hook, "find_module",
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001973 "OO", fullname,
Victor Stinner37580282011-03-20 01:34:43 +01001974 search_path_list != NULL ?
1975 search_path_list : Py_None);
1976 if (loader == NULL) {
1977 Py_DECREF(meta_path);
1978 return NULL; /* true error */
1979 }
1980 if (loader != Py_None) {
1981 /* a loader was found */
1982 *p_loader = loader;
1983 Py_DECREF(meta_path);
1984 return &importhookdescr;
1985 }
1986 Py_DECREF(loader);
1987 }
1988 Py_DECREF(meta_path);
1989 }
1990
Victor Stinnerdf75a022011-03-14 13:40:04 -04001991 if (find_frozen(fullname) != NULL)
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001992 return &fd_frozen;
Victor Stinner37580282011-03-20 01:34:43 +01001993
1994 if (search_path_list == NULL) {
1995#ifdef MS_COREDLL
1996 FILE *fp;
1997 struct filedescr *fdp;
Victor Stinner37580282011-03-20 01:34:43 +01001998#endif
Victor Stinnerdf75a022011-03-14 13:40:04 -04001999 if (is_builtin(name))
Victor Stinner37580282011-03-20 01:34:43 +01002000 return &fd_builtin;
Victor Stinner37580282011-03-20 01:34:43 +01002001#ifdef MS_COREDLL
Victor Stinner2fd76e42011-03-14 15:19:39 -04002002 fp = _PyWin_FindRegisteredModule(name, &fdp, p_path);
Victor Stinner37580282011-03-20 01:34:43 +01002003 if (fp != NULL) {
Victor Stinner37580282011-03-20 01:34:43 +01002004 *p_fp = fp;
2005 return fdp;
2006 }
2007 else if (PyErr_Occurred())
2008 return NULL;
2009#endif
Victor Stinner37580282011-03-20 01:34:43 +01002010 search_path_list = PySys_GetObject("path");
2011 }
2012
2013 if (search_path_list == NULL || !PyList_Check(search_path_list)) {
2014 PyErr_SetString(PyExc_ImportError,
2015 "sys.path must be a list of directory names");
2016 return NULL;
2017 }
2018
2019 path_hooks = PySys_GetObject("path_hooks");
2020 if (path_hooks == NULL || !PyList_Check(path_hooks)) {
2021 PyErr_SetString(PyExc_ImportError,
2022 "sys.path_hooks must be a list of "
2023 "import hooks");
2024 return NULL;
2025 }
2026 path_importer_cache = PySys_GetObject("path_importer_cache");
2027 if (path_importer_cache == NULL ||
2028 !PyDict_Check(path_importer_cache)) {
2029 PyErr_SetString(PyExc_ImportError,
2030 "sys.path_importer_cache must be a dict");
2031 return NULL;
2032 }
2033
2034 return find_module_path_list(fullname, name,
2035 search_path_list, path_hooks,
2036 path_importer_cache,
Victor Stinner2fd76e42011-03-14 15:19:39 -04002037 p_path, p_fp, p_loader);
Victor Stinner37580282011-03-20 01:34:43 +01002038}
2039
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002040/* case_bytes(char* buf, Py_ssize_t len, Py_ssize_t namelen, char* name)
Tim Petersd1e87a82001-03-01 18:12:00 +00002041 * The arguments here are tricky, best shown by example:
2042 * /a/b/c/d/e/f/g/h/i/j/k/some_long_module_name.py\0
2043 * ^ ^ ^ ^
2044 * |--------------------- buf ---------------------|
2045 * |------------------- len ------------------|
2046 * |------ name -------|
2047 * |----- namelen -----|
2048 * buf is the full path, but len only counts up to (& exclusive of) the
2049 * extension. name is the module name, also exclusive of extension.
2050 *
2051 * We've already done a successful stat() or fopen() on buf, so know that
2052 * there's some match, possibly case-insensitive.
2053 *
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002054 * case_bytes() is to return 1 if there's a case-sensitive match for
2055 * name, else 0. case_bytes() is also to return 1 if envar PYTHONCASEOK
Tim Peters50d8d372001-02-28 05:34:27 +00002056 * exists.
Tim Petersd1e87a82001-03-01 18:12:00 +00002057 *
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002058 * case_bytes() is used to implement case-sensitive import semantics even
Tim Peters50d8d372001-02-28 05:34:27 +00002059 * on platforms with case-insensitive filesystems. It's trivial to implement
2060 * for case-sensitive filesystems. It's pretty much a cross-platform
2061 * nightmare for systems with case-insensitive filesystems.
2062 */
Guido van Rossum0980bd91998-02-13 17:18:36 +00002063
Tim Peters50d8d372001-02-28 05:34:27 +00002064/* First we may need a pile of platform-specific header files; the sequence
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002065 * of #if's here should match the sequence in the body of case_bytes().
Tim Peters50d8d372001-02-28 05:34:27 +00002066 */
Jason Tishler7961aa62005-05-20 00:56:54 +00002067#if defined(MS_WINDOWS)
Guido van Rossum0980bd91998-02-13 17:18:36 +00002068#include <windows.h>
Guido van Rossum4c3f57c2001-01-10 20:40:46 +00002069
Tim Peters50d8d372001-02-28 05:34:27 +00002070#elif defined(DJGPP)
2071#include <dir.h>
2072
Jason Tishler7961aa62005-05-20 00:56:54 +00002073#elif (defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) && defined(HAVE_DIRENT_H)
Tim Peters430f5d42001-03-01 01:30:56 +00002074#include <sys/types.h>
2075#include <dirent.h>
2076
Andrew MacIntyred9400542002-02-26 11:41:34 +00002077#elif defined(PYOS_OS2)
2078#define INCL_DOS
2079#define INCL_DOSERRORS
2080#define INCL_NOPMAPI
2081#include <os2.h>
Tim Peters50d8d372001-02-28 05:34:27 +00002082#endif
2083
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002084#if defined(DJGPP) \
2085 || ((defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) \
2086 && defined(HAVE_DIRENT_H)) \
2087 || defined(PYOS_OS2)
2088# define USE_CASE_OK_BYTES
2089#endif
2090
2091
2092#ifdef USE_CASE_OK_BYTES
Guido van Rossum0980bd91998-02-13 17:18:36 +00002093static int
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002094case_bytes(char *buf, Py_ssize_t len, Py_ssize_t namelen, const char *name)
Guido van Rossum0980bd91998-02-13 17:18:36 +00002095{
Tim Peters50d8d372001-02-28 05:34:27 +00002096/* Pick a platform-specific implementation; the sequence of #if's here should
2097 * match the sequence just above.
2098 */
2099
Tim Peters50d8d372001-02-28 05:34:27 +00002100/* DJGPP */
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002101#if defined(DJGPP)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002102 struct ffblk ffblk;
2103 int done;
Tim Peters50d8d372001-02-28 05:34:27 +00002104
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002105 if (Py_GETENV("PYTHONCASEOK") != NULL)
2106 return 1;
Tim Peters50d8d372001-02-28 05:34:27 +00002107
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002108 done = findfirst(buf, &ffblk, FA_ARCH|FA_RDONLY|FA_HIDDEN|FA_DIREC);
2109 if (done) {
2110 PyErr_Format(PyExc_NameError,
2111 "Can't find file for module %.100s\n(filename %.300s)",
2112 name, buf);
Victor Stinner9c61e242011-03-22 01:22:27 +01002113 return -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002114 }
2115 return strncmp(ffblk.ff_name, name, namelen) == 0;
Guido van Rossum0980bd91998-02-13 17:18:36 +00002116
Jason Tishler7961aa62005-05-20 00:56:54 +00002117/* new-fangled macintosh (macosx) or Cygwin */
2118#elif (defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) && defined(HAVE_DIRENT_H)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002119 DIR *dirp;
2120 struct dirent *dp;
2121 char dirname[MAXPATHLEN + 1];
2122 const int dirlen = len - namelen - 1; /* don't want trailing SEP */
Tim Peters430f5d42001-03-01 01:30:56 +00002123
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002124 if (Py_GETENV("PYTHONCASEOK") != NULL)
2125 return 1;
Tim Petersdbe6ebb2001-03-01 08:47:29 +00002126
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002127 /* Copy the dir component into dirname; substitute "." if empty */
2128 if (dirlen <= 0) {
2129 dirname[0] = '.';
2130 dirname[1] = '\0';
2131 }
2132 else {
2133 assert(dirlen <= MAXPATHLEN);
2134 memcpy(dirname, buf, dirlen);
2135 dirname[dirlen] = '\0';
2136 }
2137 /* Open the directory and search the entries for an exact match. */
2138 dirp = opendir(dirname);
2139 if (dirp) {
2140 char *nameWithExt = buf + len - namelen;
2141 while ((dp = readdir(dirp)) != NULL) {
2142 const int thislen =
Tim Peters430f5d42001-03-01 01:30:56 +00002143#ifdef _DIRENT_HAVE_D_NAMELEN
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002144 dp->d_namlen;
Tim Peters430f5d42001-03-01 01:30:56 +00002145#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002146 strlen(dp->d_name);
Tim Peters430f5d42001-03-01 01:30:56 +00002147#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002148 if (thislen >= namelen &&
2149 strcmp(dp->d_name, nameWithExt) == 0) {
2150 (void)closedir(dirp);
2151 return 1; /* Found */
2152 }
2153 }
2154 (void)closedir(dirp);
2155 }
2156 return 0 ; /* Not found */
Tim Peters430f5d42001-03-01 01:30:56 +00002157
Andrew MacIntyred9400542002-02-26 11:41:34 +00002158/* OS/2 */
2159#elif defined(PYOS_OS2)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002160 HDIR hdir = 1;
2161 ULONG srchcnt = 1;
2162 FILEFINDBUF3 ffbuf;
2163 APIRET rc;
Andrew MacIntyred9400542002-02-26 11:41:34 +00002164
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002165 if (Py_GETENV("PYTHONCASEOK") != NULL)
2166 return 1;
Andrew MacIntyred9400542002-02-26 11:41:34 +00002167
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002168 rc = DosFindFirst(buf,
2169 &hdir,
2170 FILE_READONLY | FILE_HIDDEN | FILE_SYSTEM | FILE_DIRECTORY,
2171 &ffbuf, sizeof(ffbuf),
2172 &srchcnt,
2173 FIL_STANDARD);
2174 if (rc != NO_ERROR)
2175 return 0;
2176 return strncmp(ffbuf.achName, name, namelen) == 0;
Andrew MacIntyred9400542002-02-26 11:41:34 +00002177
Tim Peters50d8d372001-02-28 05:34:27 +00002178/* assuming it's a case-sensitive filesystem, so there's nothing to do! */
2179#else
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002180# error "USE_CASE_OK_BYTES is not correctly defined"
2181#endif
2182}
2183#endif
2184
2185/*
2186 * Check if a filename case matchs the name case. We've already done a
2187 * successful stat() or fopen() on buf, so know that there's some match,
2188 * possibly case-insensitive.
2189 *
2190 * case_ok() is to return 1 if there's a case-sensitive match for name, 0 if it
2191 * the filename doesn't match, or -1 on error. case_ok() is also to return 1
2192 * if envar PYTHONCASEOK exists.
2193 *
2194 * case_ok() is used to implement case-sensitive import semantics even
2195 * on platforms with case-insensitive filesystems. It's trivial to implement
2196 * for case-sensitive filesystems. It's pretty much a cross-platform
2197 * nightmare for systems with case-insensitive filesystems.
2198 */
2199
2200static int
2201case_ok(PyObject *filename, Py_ssize_t prefix_delta, PyObject *name)
2202{
2203#ifdef MS_WINDOWS
2204 WIN32_FIND_DATAW data;
2205 HANDLE h;
2206 int cmp;
2207
2208 if (Py_GETENV("PYTHONCASEOK") != NULL)
2209 return 1;
2210
2211 h = FindFirstFileW(PyUnicode_AS_UNICODE(filename), &data);
2212 if (h == INVALID_HANDLE_VALUE) {
2213 PyErr_Format(PyExc_NameError,
2214 "Can't find file for module %R\n(filename %R)",
2215 name, filename);
2216 return 0;
2217 }
2218 FindClose(h);
2219 cmp = wcsncmp(data.cFileName,
2220 PyUnicode_AS_UNICODE(name),
2221 PyUnicode_GET_SIZE(name));
2222 return cmp == 0;
2223#elif defined(USE_CASE_OK_BYTES)
2224 int match;
2225 PyObject *filebytes, *namebytes;
2226 filebytes = PyUnicode_EncodeFSDefault(filename);
2227 if (filebytes == NULL)
2228 return -1;
2229 namebytes = PyUnicode_EncodeFSDefault(name);
2230 if (namebytes == NULL) {
2231 Py_DECREF(filebytes);
2232 return -1;
2233 }
2234 match = case_bytes(
2235 PyBytes_AS_STRING(filebytes),
2236 PyBytes_GET_SIZE(filebytes) + prefix_delta,
Victor Stinner1304f2d2011-03-20 04:28:55 +01002237 PyBytes_GET_SIZE(namebytes),
2238 PyBytes_AS_STRING(namebytes));
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002239 Py_DECREF(filebytes);
2240 Py_DECREF(namebytes);
2241 return match;
2242#else
2243 /* assuming it's a case-sensitive filesystem, so there's nothing to do! */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002244 return 1;
Guido van Rossum0980bd91998-02-13 17:18:36 +00002245
Guido van Rossum4d1b3b91998-02-13 23:27:59 +00002246#endif
Tim Peters50d8d372001-02-28 05:34:27 +00002247}
Guido van Rossum4d1b3b91998-02-13 23:27:59 +00002248
Guido van Rossum197346f1997-10-31 18:38:52 +00002249#ifdef HAVE_STAT
Victor Stinner4f4402c2010-08-14 14:50:26 +00002250
Victor Stinner547a2a62011-03-20 03:07:28 +01002251/* Helper to look for __init__.py or __init__.py[co] in potential package.
2252 Return 1 if __init__ was found, 0 if not, or -1 on error. */
Guido van Rossum197346f1997-10-31 18:38:52 +00002253static int
Victor Stinner547a2a62011-03-20 03:07:28 +01002254find_init_module(PyObject *directory)
Guido van Rossum197346f1997-10-31 18:38:52 +00002255{
Victor Stinner547a2a62011-03-20 03:07:28 +01002256 size_t len;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002257 struct stat statbuf;
Victor Stinner547a2a62011-03-20 03:07:28 +01002258 PyObject *filename;
2259 int match;
Guido van Rossum197346f1997-10-31 18:38:52 +00002260
Victor Stinner547a2a62011-03-20 03:07:28 +01002261 len = PyUnicode_GET_SIZE(directory);
2262 filename = PyUnicode_FromFormat("%U%c__init__.py", directory, SEP);
2263 if (filename == NULL)
2264 return -1;
2265 if (_Py_stat(filename, &statbuf) == 0) {
Victor Stinnercc9564e2011-03-20 04:58:29 +01002266 /* 3=len(".py") */
2267 match = case_ok(filename, -3, initstr);
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002268 if (match < 0) {
2269 Py_DECREF(filename);
2270 return -1;
2271 }
2272 if (match) {
Victor Stinner547a2a62011-03-20 03:07:28 +01002273 Py_DECREF(filename);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002274 return 1;
2275 }
2276 }
Victor Stinner547a2a62011-03-20 03:07:28 +01002277 Py_DECREF(filename);
2278
2279 filename = PyUnicode_FromFormat("%U%c__init__.py%c",
2280 directory, SEP, Py_OptimizeFlag ? 'o' : 'c');
2281 if (filename == NULL)
2282 return -1;
2283 if (_Py_stat(filename, &statbuf) == 0) {
Victor Stinnercc9564e2011-03-20 04:58:29 +01002284 /* 4=len(".pyc") */
2285 match = case_ok(filename, -4, 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);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002296 return 0;
Guido van Rossum197346f1997-10-31 18:38:52 +00002297}
Guido van Rossum48a680c2001-03-02 06:34:14 +00002298
Guido van Rossum197346f1997-10-31 18:38:52 +00002299#endif /* HAVE_STAT */
2300
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002301
Victor Stinner95872862011-03-07 18:20:56 +01002302static int init_builtin(PyObject *); /* Forward */
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002303
Victor Stinner44c6c152010-08-09 00:59:10 +00002304static PyObject*
Victor Stinner95872862011-03-07 18:20:56 +01002305load_builtin(PyObject *name, int type)
Victor Stinner44c6c152010-08-09 00:59:10 +00002306{
2307 PyObject *m, *modules;
2308 int err;
2309
Victor Stinner44c6c152010-08-09 00:59:10 +00002310 if (type == C_BUILTIN)
2311 err = init_builtin(name);
2312 else
Victor Stinner95872862011-03-07 18:20:56 +01002313 err = PyImport_ImportFrozenModuleObject(name);
Victor Stinner44c6c152010-08-09 00:59:10 +00002314 if (err < 0)
2315 return NULL;
2316 if (err == 0) {
2317 PyErr_Format(PyExc_ImportError,
Victor Stinner95872862011-03-07 18:20:56 +01002318 "Purported %s module %R not found",
2319 type == C_BUILTIN ? "builtin" : "frozen",
Victor Stinner44c6c152010-08-09 00:59:10 +00002320 name);
2321 return NULL;
2322 }
2323
2324 modules = PyImport_GetModuleDict();
Victor Stinner95872862011-03-07 18:20:56 +01002325 m = PyDict_GetItem(modules, name);
Victor Stinner44c6c152010-08-09 00:59:10 +00002326 if (m == NULL) {
2327 PyErr_Format(
2328 PyExc_ImportError,
Victor Stinner95872862011-03-07 18:20:56 +01002329 "%s module %R not properly initialized",
2330 type == C_BUILTIN ? "builtin" : "frozen",
Victor Stinner44c6c152010-08-09 00:59:10 +00002331 name);
2332 return NULL;
2333 }
2334 Py_INCREF(m);
2335 return m;
2336}
2337
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002338/* Load an external module using the default search path and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00002339 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002340
Guido van Rossum79f25d91997-04-29 20:08:16 +00002341static PyObject *
Victor Stinner41c5fec2011-03-13 21:46:30 -04002342load_module(PyObject *name, FILE *fp, PyObject *pathname, int type, PyObject *loader)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002343{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002344 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002345
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002346 /* First check that there's an open file (if we need one) */
2347 switch (type) {
2348 case PY_SOURCE:
2349 case PY_COMPILED:
2350 if (fp == NULL) {
2351 PyErr_Format(PyExc_ValueError,
Victor Stinner41c5fec2011-03-13 21:46:30 -04002352 "file object required for import (type code %d)",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002353 type);
2354 return NULL;
2355 }
2356 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002357
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002358 switch (type) {
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002359
Victor Stinner41c5fec2011-03-13 21:46:30 -04002360 case PY_SOURCE:
2361 m = load_source_module(name, pathname, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002362 break;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002363
Victor Stinner41c5fec2011-03-13 21:46:30 -04002364 case PY_COMPILED:
2365 m = load_compiled_module(name, pathname, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002366 break;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002367
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002368#ifdef HAVE_DYNAMIC_LOADING
Victor Stinner41c5fec2011-03-13 21:46:30 -04002369 case C_EXTENSION:
2370 m = _PyImport_LoadDynamicModule(name, pathname, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002371 break;
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002372#endif
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002373
Victor Stinner41c5fec2011-03-13 21:46:30 -04002374 case PKG_DIRECTORY:
2375 m = load_package(name, pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002376 break;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002377
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002378 case C_BUILTIN:
Victor Stinner41c5fec2011-03-13 21:46:30 -04002379 case PY_FROZEN:
2380 m = load_builtin(name, type);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002381 break;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002382
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002383 case IMP_HOOK: {
2384 if (loader == NULL) {
2385 PyErr_SetString(PyExc_ImportError,
2386 "import hook without loader");
2387 return NULL;
2388 }
Victor Stinner41c5fec2011-03-13 21:46:30 -04002389 m = PyObject_CallMethod(loader, "load_module", "O", name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002390 break;
2391 }
Just van Rossum52e14d62002-12-30 22:08:05 +00002392
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002393 default:
2394 PyErr_Format(PyExc_ImportError,
Victor Stinner98dbba52011-03-14 15:15:47 -04002395 "Don't know how to import %R (type code %d)",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002396 name, type);
2397 m = NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002398
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002399 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002400
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002401 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002402}
2403
2404
2405/* Initialize a built-in module.
Thomas Wouters89f507f2006-12-13 04:49:30 +00002406 Return 1 for success, 0 if the module is not found, and -1 with
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002407 an exception set if the initialization failed. */
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002408
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002409static int
Victor Stinner95872862011-03-07 18:20:56 +01002410init_builtin(PyObject *name)
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002411{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002412 struct _inittab *p;
Guido van Rossum25ce5661997-08-02 03:10:38 +00002413
Victor Stinner95872862011-03-07 18:20:56 +01002414 if (_PyImport_FindExtensionObject(name, name) != NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002415 return 1;
Guido van Rossum25ce5661997-08-02 03:10:38 +00002416
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002417 for (p = PyImport_Inittab; p->name != NULL; p++) {
2418 PyObject *mod;
Victor Stinner95872862011-03-07 18:20:56 +01002419 if (PyUnicode_CompareWithASCIIString(name, p->name) == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002420 if (p->initfunc == NULL) {
2421 PyErr_Format(PyExc_ImportError,
Victor Stinner95872862011-03-07 18:20:56 +01002422 "Cannot re-init internal module %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002423 name);
2424 return -1;
2425 }
2426 if (Py_VerboseFlag)
Victor Stinner95872862011-03-07 18:20:56 +01002427 PySys_FormatStderr("import %U # builtin\n", name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002428 mod = (*p->initfunc)();
2429 if (mod == 0)
2430 return -1;
Victor Stinner95872862011-03-07 18:20:56 +01002431 if (_PyImport_FixupExtensionObject(mod, name, name) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002432 return -1;
2433 /* FixupExtension has put the module into sys.modules,
2434 so we can release our own reference. */
2435 Py_DECREF(mod);
2436 return 1;
2437 }
2438 }
2439 return 0;
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002440}
Guido van Rossumf56e3db1993-04-01 20:59:32 +00002441
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002442
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002443/* Frozen modules */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002444
Guido van Rossumcfd0a221996-06-17 17:06:34 +00002445static struct _frozen *
Victor Stinner53dc7352011-03-20 01:50:21 +01002446find_frozen(PyObject *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002447{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002448 struct _frozen *p;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002449
Victor Stinner53dc7352011-03-20 01:50:21 +01002450 if (name == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002451 return NULL;
Benjamin Petersond968e272008-11-05 22:48:33 +00002452
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002453 for (p = PyImport_FrozenModules; ; p++) {
2454 if (p->name == NULL)
2455 return NULL;
Victor Stinner53dc7352011-03-20 01:50:21 +01002456 if (PyUnicode_CompareWithASCIIString(name, p->name) == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002457 break;
2458 }
2459 return p;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002460}
2461
Guido van Rossum79f25d91997-04-29 20:08:16 +00002462static PyObject *
Victor Stinner53dc7352011-03-20 01:50:21 +01002463get_frozen_object(PyObject *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002464{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002465 struct _frozen *p = find_frozen(name);
2466 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002467
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002468 if (p == NULL) {
2469 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002470 "No such frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002471 name);
2472 return NULL;
2473 }
2474 if (p->code == NULL) {
2475 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002476 "Excluded frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002477 name);
2478 return NULL;
2479 }
2480 size = p->size;
2481 if (size < 0)
2482 size = -size;
2483 return PyMarshal_ReadObjectFromString((char *)p->code, size);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002484}
2485
Brett Cannon8d110132009-03-15 02:20:16 +00002486static PyObject *
Victor Stinner53dc7352011-03-20 01:50:21 +01002487is_frozen_package(PyObject *name)
Brett Cannon8d110132009-03-15 02:20:16 +00002488{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002489 struct _frozen *p = find_frozen(name);
2490 int size;
Brett Cannon8d110132009-03-15 02:20:16 +00002491
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002492 if (p == NULL) {
2493 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002494 "No such frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002495 name);
2496 return NULL;
2497 }
Brett Cannon8d110132009-03-15 02:20:16 +00002498
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002499 size = p->size;
Brett Cannon8d110132009-03-15 02:20:16 +00002500
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002501 if (size < 0)
2502 Py_RETURN_TRUE;
2503 else
2504 Py_RETURN_FALSE;
Brett Cannon8d110132009-03-15 02:20:16 +00002505}
2506
2507
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002508/* Initialize a frozen module.
Brett Cannon3c2ac442009-03-08 20:49:47 +00002509 Return 1 for success, 0 if the module is not found, and -1 with
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002510 an exception set if the initialization failed.
2511 This function is also used from frozenmain.c */
Guido van Rossum0b344901995-02-07 15:35:27 +00002512
2513int
Victor Stinner53dc7352011-03-20 01:50:21 +01002514PyImport_ImportFrozenModuleObject(PyObject *name)
Guido van Rossumf56e3db1993-04-01 20:59:32 +00002515{
Victor Stinner53dc7352011-03-20 01:50:21 +01002516 struct _frozen *p;
2517 PyObject *co, *m, *path;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002518 int ispackage;
2519 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002520
Victor Stinner53dc7352011-03-20 01:50:21 +01002521 p = find_frozen(name);
2522
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002523 if (p == NULL)
2524 return 0;
2525 if (p->code == NULL) {
2526 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002527 "Excluded frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002528 name);
2529 return -1;
2530 }
2531 size = p->size;
2532 ispackage = (size < 0);
2533 if (ispackage)
2534 size = -size;
2535 if (Py_VerboseFlag)
Victor Stinner53dc7352011-03-20 01:50:21 +01002536 PySys_FormatStderr("import %U # frozen%s\n",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002537 name, ispackage ? " package" : "");
2538 co = PyMarshal_ReadObjectFromString((char *)p->code, size);
2539 if (co == NULL)
2540 return -1;
2541 if (!PyCode_Check(co)) {
2542 PyErr_Format(PyExc_TypeError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002543 "frozen object %R is not a code object",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002544 name);
2545 goto err_return;
2546 }
2547 if (ispackage) {
2548 /* Set __path__ to the package name */
Victor Stinner53dc7352011-03-20 01:50:21 +01002549 PyObject *d, *l;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002550 int err;
Victor Stinner53dc7352011-03-20 01:50:21 +01002551 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002552 if (m == NULL)
2553 goto err_return;
2554 d = PyModule_GetDict(m);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002555 l = PyList_New(1);
2556 if (l == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002557 goto err_return;
2558 }
Victor Stinner53dc7352011-03-20 01:50:21 +01002559 Py_INCREF(name);
2560 PyList_SET_ITEM(l, 0, name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002561 err = PyDict_SetItemString(d, "__path__", l);
2562 Py_DECREF(l);
2563 if (err != 0)
2564 goto err_return;
2565 }
Victor Stinner53dc7352011-03-20 01:50:21 +01002566 path = PyUnicode_FromString("<frozen>");
2567 if (path == NULL)
2568 goto err_return;
2569 m = PyImport_ExecCodeModuleObject(name, co, path, NULL);
2570 Py_DECREF(path);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002571 if (m == NULL)
2572 goto err_return;
2573 Py_DECREF(co);
2574 Py_DECREF(m);
2575 return 1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002576err_return:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002577 Py_DECREF(co);
2578 return -1;
Guido van Rossumf56e3db1993-04-01 20:59:32 +00002579}
Guido van Rossum74e6a111994-08-29 12:54:38 +00002580
Victor Stinner53dc7352011-03-20 01:50:21 +01002581int
2582PyImport_ImportFrozenModule(char *name)
2583{
2584 PyObject *nameobj;
2585 int ret;
2586 nameobj = PyUnicode_InternFromString(name);
2587 if (nameobj == NULL)
2588 return -1;
2589 ret = PyImport_ImportFrozenModuleObject(nameobj);
2590 Py_DECREF(nameobj);
2591 return ret;
2592}
2593
Guido van Rossum74e6a111994-08-29 12:54:38 +00002594
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002595/* Import a module, either built-in, frozen, or external, and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00002596 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum74e6a111994-08-29 12:54:38 +00002597
Guido van Rossum79f25d91997-04-29 20:08:16 +00002598PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00002599PyImport_ImportModule(const char *name)
Guido van Rossum74e6a111994-08-29 12:54:38 +00002600{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002601 PyObject *pname;
2602 PyObject *result;
Marc-André Lemburg3c61c352001-02-09 19:40:15 +00002603
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002604 pname = PyUnicode_FromString(name);
2605 if (pname == NULL)
2606 return NULL;
2607 result = PyImport_Import(pname);
2608 Py_DECREF(pname);
2609 return result;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002610}
2611
Christian Heimes072c0f12008-01-03 23:01:04 +00002612/* Import a module without blocking
2613 *
2614 * At first it tries to fetch the module from sys.modules. If the module was
2615 * never loaded before it loads it with PyImport_ImportModule() unless another
2616 * thread holds the import lock. In the latter case the function raises an
2617 * ImportError instead of blocking.
2618 *
2619 * Returns the module object with incremented ref count.
2620 */
2621PyObject *
2622PyImport_ImportModuleNoBlock(const char *name)
2623{
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002624 PyObject *nameobj, *modules, *result;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002625 long me;
Christian Heimes072c0f12008-01-03 23:01:04 +00002626
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002627 /* Try to get the module from sys.modules[name] */
2628 modules = PyImport_GetModuleDict();
2629 if (modules == NULL)
2630 return NULL;
Christian Heimes072c0f12008-01-03 23:01:04 +00002631
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002632 nameobj = PyUnicode_FromString(name);
2633 if (nameobj == NULL)
2634 return NULL;
2635 result = PyDict_GetItem(modules, nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002636 if (result != NULL) {
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002637 Py_DECREF(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002638 Py_INCREF(result);
2639 return result;
2640 }
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002641 PyErr_Clear();
Benjamin Peterson3e4f0552008-09-02 00:31:15 +00002642#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002643 /* check the import lock
2644 * me might be -1 but I ignore the error here, the lock function
2645 * takes care of the problem */
2646 me = PyThread_get_thread_ident();
2647 if (import_lock_thread == -1 || import_lock_thread == me) {
2648 /* no thread or me is holding the lock */
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002649 result = PyImport_Import(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002650 }
2651 else {
2652 PyErr_Format(PyExc_ImportError,
Victor Stinnerc24c8102011-03-13 22:38:06 -04002653 "Failed to import %R because the import lock"
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002654 "is held by another thread.",
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002655 nameobj);
2656 result = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002657 }
Benjamin Peterson3e4f0552008-09-02 00:31:15 +00002658#else
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002659 result = PyImport_Import(nameobj);
Benjamin Peterson3e4f0552008-09-02 00:31:15 +00002660#endif
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002661 Py_DECREF(nameobj);
2662 return result;
Christian Heimes072c0f12008-01-03 23:01:04 +00002663}
2664
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002665/* Forward declarations for helper routines */
Victor Stinner974389d2011-03-15 09:33:57 +01002666static PyObject *get_parent(PyObject *globals,
2667 PyObject **p_name,
2668 int level);
Tim Petersdbd9ba62000-07-09 03:09:57 +00002669static PyObject *load_next(PyObject *mod, PyObject *altmod,
Victor Stinner974389d2011-03-15 09:33:57 +01002670 PyObject *inputname, PyObject **p_outputname,
2671 Py_UNICODE *buf, Py_ssize_t *p_buflen,
2672 Py_ssize_t bufsize);
2673static int mark_miss(PyObject *name);
Tim Petersdbd9ba62000-07-09 03:09:57 +00002674static int ensure_fromlist(PyObject *mod, PyObject *fromlist,
Victor Stinner974389d2011-03-15 09:33:57 +01002675 PyObject *buf, int recursive);
2676static PyObject * import_submodule(PyObject *mod, PyObject *name,
2677 PyObject *fullname);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002678
2679/* The Magnum Opus of dotted-name import :-) */
2680
Guido van Rossum75acc9c1998-03-03 22:26:50 +00002681static PyObject *
Victor Stinner974389d2011-03-15 09:33:57 +01002682import_module_level(PyObject *name, PyObject *globals, PyObject *locals,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002683 PyObject *fromlist, int level)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002684{
Victor Stinner974389d2011-03-15 09:33:57 +01002685 Py_UNICODE buf[MAXPATHLEN+1];
2686 Py_ssize_t buflen;
2687 Py_ssize_t bufsize = MAXPATHLEN+1;
2688 PyObject *parent, *head, *next, *tail, *inputname, *outputname;
2689 PyObject *parent_name, *ensure_name;
2690 const Py_UNICODE *nameunicode;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002691
Victor Stinner974389d2011-03-15 09:33:57 +01002692 nameunicode = PyUnicode_AS_UNICODE(name);
2693
2694 if (Py_UNICODE_strchr(nameunicode, SEP) != NULL
2695#ifdef ALTSEP
2696 || Py_UNICODE_strchr(nameunicode, ALTSEP) != NULL
Christian Heimes454f37b2008-01-10 00:10:02 +00002697#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002698 ) {
2699 PyErr_SetString(PyExc_ImportError,
2700 "Import by filename is not supported.");
2701 return NULL;
2702 }
Christian Heimes454f37b2008-01-10 00:10:02 +00002703
Victor Stinner974389d2011-03-15 09:33:57 +01002704 parent = get_parent(globals, &parent_name, level);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002705 if (parent == NULL)
2706 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002707
Victor Stinner974389d2011-03-15 09:33:57 +01002708 buflen = PyUnicode_GET_SIZE(parent_name);
2709 if (buflen+1 > bufsize) {
2710 Py_DECREF(parent_name);
2711 PyErr_SetString(PyExc_ValueError,
2712 "Module name too long");
2713 return NULL;
2714 }
2715 Py_UNICODE_strcpy(buf, PyUnicode_AS_UNICODE(parent_name));
2716 Py_DECREF(parent_name);
2717
2718 head = load_next(parent, level < 0 ? Py_None : parent, name, &outputname,
2719 buf, &buflen, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002720 if (head == NULL)
2721 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002722
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002723 tail = head;
2724 Py_INCREF(tail);
Victor Stinner974389d2011-03-15 09:33:57 +01002725
2726 if (outputname != NULL) {
2727 while (1) {
2728 inputname = outputname;
2729 next = load_next(tail, tail, inputname, &outputname,
2730 buf, &buflen, bufsize);
2731 Py_DECREF(tail);
2732 Py_DECREF(inputname);
2733 if (next == NULL) {
2734 Py_DECREF(head);
2735 return NULL;
2736 }
2737 tail = next;
2738
2739 if (outputname == NULL) {
2740 break;
2741 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002742 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002743 }
2744 if (tail == Py_None) {
2745 /* If tail is Py_None, both get_parent and load_next found
2746 an empty module name: someone called __import__("") or
2747 doctored faulty bytecode */
2748 Py_DECREF(tail);
2749 Py_DECREF(head);
Victor Stinner974389d2011-03-15 09:33:57 +01002750 PyErr_SetString(PyExc_ValueError, "Empty module name");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002751 return NULL;
2752 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002753
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002754 if (fromlist != NULL) {
2755 if (fromlist == Py_None || !PyObject_IsTrue(fromlist))
2756 fromlist = NULL;
2757 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002758
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002759 if (fromlist == NULL) {
2760 Py_DECREF(tail);
2761 return head;
2762 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002763
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002764 Py_DECREF(head);
Victor Stinner974389d2011-03-15 09:33:57 +01002765
2766 ensure_name = PyUnicode_FromUnicode(buf, Py_UNICODE_strlen(buf));
2767 if (ensure_name == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002768 Py_DECREF(tail);
2769 return NULL;
2770 }
Victor Stinner974389d2011-03-15 09:33:57 +01002771 if (!ensure_fromlist(tail, fromlist, ensure_name, 0)) {
2772 Py_DECREF(tail);
2773 Py_DECREF(ensure_name);
2774 return NULL;
2775 }
2776 Py_DECREF(ensure_name);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002777
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002778 return tail;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002779}
2780
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002781PyObject *
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002782PyImport_ImportModuleLevelObject(PyObject *name, PyObject *globals,
2783 PyObject *locals, PyObject *fromlist,
2784 int level)
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002785{
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002786 PyObject *mod;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002787 _PyImport_AcquireLock();
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002788 mod = import_module_level(name, globals, locals, fromlist, level);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002789 if (_PyImport_ReleaseLock() < 0) {
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002790 Py_XDECREF(mod);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002791 PyErr_SetString(PyExc_RuntimeError,
2792 "not holding the import lock");
2793 return NULL;
2794 }
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002795 return mod;
Guido van Rossum75acc9c1998-03-03 22:26:50 +00002796}
2797
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002798PyObject *
2799PyImport_ImportModuleLevel(char *name, PyObject *globals, PyObject *locals,
2800 PyObject *fromlist, int level)
2801{
2802 PyObject *nameobj, *mod;
2803 nameobj = PyUnicode_FromString(name);
2804 if (nameobj == NULL)
2805 return NULL;
2806 mod = PyImport_ImportModuleLevelObject(nameobj, globals, locals,
2807 fromlist, level);
2808 Py_DECREF(nameobj);
2809 return mod;
2810}
2811
2812
Fred Drake87590902004-05-28 20:21:36 +00002813/* Return the package that an import is being performed in. If globals comes
2814 from the module foo.bar.bat (not itself a package), this returns the
2815 sys.modules entry for foo.bar. If globals is from a package's __init__.py,
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00002816 the package's entry in sys.modules is returned, as a borrowed reference.
Fred Drake87590902004-05-28 20:21:36 +00002817
Victor Stinner974389d2011-03-15 09:33:57 +01002818 The name of the returned package is returned in *p_name.
Fred Drake87590902004-05-28 20:21:36 +00002819
2820 If globals doesn't come from a package or a module in a package, or a
2821 corresponding entry is not found in sys.modules, Py_None is returned.
2822*/
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002823static PyObject *
Victor Stinner9599de52011-03-13 22:38:38 -04002824get_parent(PyObject *globals, PyObject **p_name, int level)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002825{
Victor Stinner974389d2011-03-15 09:33:57 +01002826 Py_UNICODE name[MAXPATHLEN+1];
2827 const Py_ssize_t bufsize = MAXPATHLEN+1;
2828 PyObject *nameobj;
2829
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002830 static PyObject *namestr = NULL;
2831 static PyObject *pathstr = NULL;
2832 static PyObject *pkgstr = NULL;
2833 PyObject *pkgname, *modname, *modpath, *modules, *parent;
2834 int orig_level = level;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002835
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002836 if (globals == NULL || !PyDict_Check(globals) || !level)
Victor Stinner974389d2011-03-15 09:33:57 +01002837 goto return_none;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002838
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002839 if (namestr == NULL) {
2840 namestr = PyUnicode_InternFromString("__name__");
2841 if (namestr == NULL)
2842 return NULL;
2843 }
2844 if (pathstr == NULL) {
2845 pathstr = PyUnicode_InternFromString("__path__");
2846 if (pathstr == NULL)
2847 return NULL;
2848 }
2849 if (pkgstr == NULL) {
2850 pkgstr = PyUnicode_InternFromString("__package__");
2851 if (pkgstr == NULL)
2852 return NULL;
2853 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002854
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002855 pkgname = PyDict_GetItem(globals, pkgstr);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002856
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002857 if ((pkgname != NULL) && (pkgname != Py_None)) {
2858 /* __package__ is set, so use it */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002859 if (!PyUnicode_Check(pkgname)) {
2860 PyErr_SetString(PyExc_ValueError,
2861 "__package__ set to non-string");
2862 return NULL;
2863 }
Victor Stinner974389d2011-03-15 09:33:57 +01002864 if (PyUnicode_GET_SIZE(pkgname) == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002865 if (level > 0) {
2866 PyErr_SetString(PyExc_ValueError,
2867 "Attempted relative import in non-package");
2868 return NULL;
2869 }
Victor Stinner974389d2011-03-15 09:33:57 +01002870 goto return_none;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002871 }
Victor Stinner974389d2011-03-15 09:33:57 +01002872 if (PyUnicode_GET_SIZE(pkgname)+1 > bufsize) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002873 PyErr_SetString(PyExc_ValueError,
2874 "Package name too long");
2875 return NULL;
2876 }
Victor Stinner974389d2011-03-15 09:33:57 +01002877 Py_UNICODE_strcpy(name, PyUnicode_AS_UNICODE(pkgname));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002878 } else {
2879 /* __package__ not set, so figure it out and set it */
2880 modname = PyDict_GetItem(globals, namestr);
2881 if (modname == NULL || !PyUnicode_Check(modname))
Victor Stinner974389d2011-03-15 09:33:57 +01002882 goto return_none;
Brett Cannon9a5b25a2010-03-01 02:09:17 +00002883
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002884 modpath = PyDict_GetItem(globals, pathstr);
2885 if (modpath != NULL) {
2886 /* __path__ is set, so modname is already the package name */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002887 int error;
Alexandre Vassalottia85998a2008-05-03 18:24:43 +00002888
Victor Stinner974389d2011-03-15 09:33:57 +01002889 if (PyUnicode_GET_SIZE(modname)+1 > bufsize) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002890 PyErr_SetString(PyExc_ValueError,
2891 "Module name too long");
2892 return NULL;
2893 }
Victor Stinner974389d2011-03-15 09:33:57 +01002894 Py_UNICODE_strcpy(name, PyUnicode_AS_UNICODE(modname));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002895 error = PyDict_SetItem(globals, pkgstr, modname);
2896 if (error) {
2897 PyErr_SetString(PyExc_ValueError,
2898 "Could not set __package__");
2899 return NULL;
2900 }
2901 } else {
2902 /* Normal module, so work out the package name if any */
Victor Stinner974389d2011-03-15 09:33:57 +01002903 Py_UNICODE *start = PyUnicode_AS_UNICODE(modname);
2904 Py_UNICODE *lastdot = Py_UNICODE_strrchr(start, '.');
2905 Py_ssize_t len;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002906 int error;
2907 if (lastdot == NULL && level > 0) {
2908 PyErr_SetString(PyExc_ValueError,
2909 "Attempted relative import in non-package");
2910 return NULL;
2911 }
2912 if (lastdot == NULL) {
2913 error = PyDict_SetItem(globals, pkgstr, Py_None);
2914 if (error) {
2915 PyErr_SetString(PyExc_ValueError,
2916 "Could not set __package__");
2917 return NULL;
2918 }
Victor Stinner974389d2011-03-15 09:33:57 +01002919 goto return_none;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002920 }
2921 len = lastdot - start;
Victor Stinner974389d2011-03-15 09:33:57 +01002922 if (len+1 > bufsize) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002923 PyErr_SetString(PyExc_ValueError,
2924 "Module name too long");
2925 return NULL;
2926 }
Victor Stinner974389d2011-03-15 09:33:57 +01002927 Py_UNICODE_strncpy(name, start, len);
2928 name[len] = '\0';
2929 pkgname = PyUnicode_FromUnicode(name, len);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002930 if (pkgname == NULL) {
2931 return NULL;
2932 }
2933 error = PyDict_SetItem(globals, pkgstr, pkgname);
2934 Py_DECREF(pkgname);
2935 if (error) {
2936 PyErr_SetString(PyExc_ValueError,
2937 "Could not set __package__");
2938 return NULL;
2939 }
2940 }
2941 }
2942 while (--level > 0) {
Victor Stinner974389d2011-03-15 09:33:57 +01002943 Py_UNICODE *dot = Py_UNICODE_strrchr(name, '.');
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002944 if (dot == NULL) {
2945 PyErr_SetString(PyExc_ValueError,
2946 "Attempted relative import beyond "
2947 "toplevel package");
2948 return NULL;
2949 }
2950 *dot = '\0';
2951 }
Victor Stinner974389d2011-03-15 09:33:57 +01002952
2953 nameobj = PyUnicode_FromUnicode(name, Py_UNICODE_strlen(name));
2954 if (nameobj == NULL)
2955 return NULL;
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002956
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002957 modules = PyImport_GetModuleDict();
Victor Stinner974389d2011-03-15 09:33:57 +01002958 parent = PyDict_GetItem(modules, nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002959 if (parent == NULL) {
Victor Stinner974389d2011-03-15 09:33:57 +01002960 int err;
2961
2962 if (orig_level >= 1) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002963 PyErr_Format(PyExc_SystemError,
Victor Stinner974389d2011-03-15 09:33:57 +01002964 "Parent module %R not loaded, "
2965 "cannot perform relative import", nameobj);
2966 Py_DECREF(nameobj);
2967 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002968 }
Victor Stinner974389d2011-03-15 09:33:57 +01002969
2970 err = PyErr_WarnFormat(
2971 PyExc_RuntimeWarning, 1,
2972 "Parent module %R not found while handling absolute import",
2973 nameobj);
2974 Py_DECREF(nameobj);
2975 if (err)
2976 return NULL;
2977
2978 goto return_none;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002979 }
Victor Stinner974389d2011-03-15 09:33:57 +01002980 *p_name = nameobj;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002981 return parent;
2982 /* We expect, but can't guarantee, if parent != None, that:
Victor Stinner974389d2011-03-15 09:33:57 +01002983 - parent.__name__ == name
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002984 - parent.__dict__ is globals
2985 If this is violated... Who cares? */
Victor Stinner974389d2011-03-15 09:33:57 +01002986
2987return_none:
2988 nameobj = PyUnicode_FromUnicode(NULL, 0);
2989 if (nameobj == NULL)
2990 return NULL;
2991 *p_name = nameobj;
2992 return Py_None;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002993}
2994
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002995/* altmod is either None or same as mod */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002996static PyObject *
Victor Stinner974389d2011-03-15 09:33:57 +01002997load_next(PyObject *mod, PyObject *altmod,
2998 PyObject *inputname, PyObject **p_outputname,
2999 Py_UNICODE *buf, Py_ssize_t *p_buflen, Py_ssize_t bufsize)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003000{
Victor Stinner974389d2011-03-15 09:33:57 +01003001 const Py_UNICODE *dot;
3002 Py_ssize_t len;
3003 Py_UNICODE *p;
3004 PyObject *fullname, *name, *result, *mark_name;
3005 const Py_UNICODE *nameuni;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003006
Victor Stinner974389d2011-03-15 09:33:57 +01003007 *p_outputname = NULL;
3008
3009 if (PyUnicode_GET_SIZE(inputname) == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003010 /* completely empty module name should only happen in
3011 'from . import' (or '__import__("")')*/
3012 Py_INCREF(mod);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003013 return mod;
3014 }
Thomas Woutersf7f438b2006-02-28 16:09:29 +00003015
Victor Stinner974389d2011-03-15 09:33:57 +01003016 nameuni = PyUnicode_AS_UNICODE(inputname);
3017 if (nameuni == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003018 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003019
Victor Stinner974389d2011-03-15 09:33:57 +01003020 dot = Py_UNICODE_strchr(nameuni, '.');
3021 if (dot != NULL) {
3022 len = dot - nameuni;
3023 if (len == 0) {
3024 PyErr_SetString(PyExc_ValueError,
3025 "Empty module name");
3026 return NULL;
3027 }
3028 }
3029 else
3030 len = PyUnicode_GET_SIZE(inputname);
3031
3032 if (*p_buflen+len+1 >= bufsize) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003033 PyErr_SetString(PyExc_ValueError,
3034 "Module name too long");
3035 return NULL;
3036 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003037
Victor Stinner974389d2011-03-15 09:33:57 +01003038 p = buf + *p_buflen;
3039 if (p != buf) {
3040 *p++ = '.';
3041 *p_buflen += 1;
3042 }
3043 Py_UNICODE_strncpy(p, nameuni, len);
3044 p[len] = '\0';
3045 *p_buflen += len;
3046
3047 fullname = PyUnicode_FromUnicode(buf, *p_buflen);
3048 if (fullname == NULL)
3049 return NULL;
3050 name = PyUnicode_FromUnicode(p, len);
3051 if (name == NULL) {
3052 Py_DECREF(fullname);
3053 return NULL;
3054 }
3055 result = import_submodule(mod, name, fullname);
3056 Py_DECREF(fullname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003057 if (result == Py_None && altmod != mod) {
3058 Py_DECREF(result);
3059 /* Here, altmod must be None and mod must not be None */
Victor Stinner974389d2011-03-15 09:33:57 +01003060 result = import_submodule(altmod, name, name);
3061 Py_DECREF(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003062 if (result != NULL && result != Py_None) {
Victor Stinner974389d2011-03-15 09:33:57 +01003063 mark_name = PyUnicode_FromUnicode(buf, *p_buflen);
3064 if (mark_name == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003065 Py_DECREF(result);
3066 return NULL;
3067 }
Victor Stinner974389d2011-03-15 09:33:57 +01003068 if (mark_miss(mark_name) != 0) {
3069 Py_DECREF(result);
3070 Py_DECREF(mark_name);
3071 return NULL;
3072 }
3073 Py_DECREF(mark_name);
3074 Py_UNICODE_strncpy(buf, nameuni, len);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003075 buf[len] = '\0';
3076 *p_buflen = len;
3077 }
3078 }
Victor Stinner974389d2011-03-15 09:33:57 +01003079 else
3080 Py_DECREF(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003081 if (result == NULL)
3082 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003083
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003084 if (result == Py_None) {
3085 Py_DECREF(result);
3086 PyErr_Format(PyExc_ImportError,
Victor Stinner974389d2011-03-15 09:33:57 +01003087 "No module named %R", inputname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003088 return NULL;
3089 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003090
Victor Stinner974389d2011-03-15 09:33:57 +01003091 if (dot != NULL) {
3092 *p_outputname = PyUnicode_FromUnicode(dot+1, Py_UNICODE_strlen(dot+1));
3093 if (*p_outputname == NULL) {
3094 Py_DECREF(result);
3095 return NULL;
3096 }
3097 }
3098
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003099 return result;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003100}
3101
3102static int
Victor Stinner974389d2011-03-15 09:33:57 +01003103mark_miss(PyObject *name)
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00003104{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003105 PyObject *modules = PyImport_GetModuleDict();
Victor Stinner974389d2011-03-15 09:33:57 +01003106 return PyDict_SetItem(modules, name, Py_None);
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00003107}
3108
3109static int
Victor Stinner974389d2011-03-15 09:33:57 +01003110ensure_fromlist(PyObject *mod, PyObject *fromlist, PyObject *name,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003111 int recursive)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003112{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003113 int i;
Victor Stinner974389d2011-03-15 09:33:57 +01003114 PyObject *fullname;
3115 Py_ssize_t fromlist_len;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003116
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003117 if (!PyObject_HasAttrString(mod, "__path__"))
3118 return 1;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003119
Victor Stinner974389d2011-03-15 09:33:57 +01003120 fromlist_len = PySequence_Size(fromlist);
3121
3122 for (i = 0; i < fromlist_len; i++) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003123 PyObject *item = PySequence_GetItem(fromlist, i);
3124 int hasit;
Victor Stinner974389d2011-03-15 09:33:57 +01003125 if (item == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003126 return 0;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003127 if (!PyUnicode_Check(item)) {
3128 PyErr_SetString(PyExc_TypeError,
3129 "Item in ``from list'' not a string");
3130 Py_DECREF(item);
3131 return 0;
3132 }
3133 if (PyUnicode_AS_UNICODE(item)[0] == '*') {
3134 PyObject *all;
3135 Py_DECREF(item);
3136 /* See if the package defines __all__ */
3137 if (recursive)
3138 continue; /* Avoid endless recursion */
3139 all = PyObject_GetAttrString(mod, "__all__");
3140 if (all == NULL)
3141 PyErr_Clear();
3142 else {
Victor Stinner974389d2011-03-15 09:33:57 +01003143 int ret = ensure_fromlist(mod, all, name, 1);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003144 Py_DECREF(all);
3145 if (!ret)
3146 return 0;
3147 }
3148 continue;
3149 }
3150 hasit = PyObject_HasAttr(mod, item);
3151 if (!hasit) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003152 PyObject *submod;
Victor Stinner974389d2011-03-15 09:33:57 +01003153 fullname = PyUnicode_FromFormat("%U.%U", name, item);
3154 if (fullname != NULL) {
3155 submod = import_submodule(mod, item, fullname);
3156 Py_DECREF(fullname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003157 }
Victor Stinner974389d2011-03-15 09:33:57 +01003158 else
3159 submod = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003160 Py_XDECREF(submod);
3161 if (submod == NULL) {
3162 Py_DECREF(item);
3163 return 0;
3164 }
3165 }
3166 Py_DECREF(item);
3167 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003168
Victor Stinner974389d2011-03-15 09:33:57 +01003169 return 1;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003170}
3171
Neil Schemenauer00b09662003-06-16 21:03:07 +00003172static int
Victor Stinner974389d2011-03-15 09:33:57 +01003173add_submodule(PyObject *mod, PyObject *submod, PyObject *fullname,
3174 PyObject *subname, PyObject *modules)
Neil Schemenauer00b09662003-06-16 21:03:07 +00003175{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003176 if (mod == Py_None)
3177 return 1;
3178 /* Irrespective of the success of this load, make a
3179 reference to it in the parent package module. A copy gets
3180 saved in the modules dictionary under the full name, so get a
3181 reference from there, if need be. (The exception is when the
3182 load failed with a SyntaxError -- then there's no trace in
3183 sys.modules. In that case, of course, do nothing extra.) */
3184 if (submod == NULL) {
Victor Stinner974389d2011-03-15 09:33:57 +01003185 submod = PyDict_GetItem(modules, fullname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003186 if (submod == NULL)
3187 return 1;
3188 }
3189 if (PyModule_Check(mod)) {
3190 /* We can't use setattr here since it can give a
3191 * spurious warning if the submodule name shadows a
3192 * builtin name */
3193 PyObject *dict = PyModule_GetDict(mod);
3194 if (!dict)
3195 return 0;
Victor Stinner974389d2011-03-15 09:33:57 +01003196 if (PyDict_SetItem(dict, subname, submod) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003197 return 0;
3198 }
3199 else {
Victor Stinner974389d2011-03-15 09:33:57 +01003200 if (PyObject_SetAttr(mod, subname, submod) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003201 return 0;
3202 }
3203 return 1;
Neil Schemenauer00b09662003-06-16 21:03:07 +00003204}
3205
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003206static PyObject *
Victor Stinner974389d2011-03-15 09:33:57 +01003207import_submodule(PyObject *mod, PyObject *subname, PyObject *fullname)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003208{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003209 PyObject *modules = PyImport_GetModuleDict();
Victor Stinner533d7832011-03-14 13:22:54 -04003210 PyObject *m = NULL, *bufobj, *path_list, *loader;
Victor Stinner9599de52011-03-13 22:38:38 -04003211 struct filedescr *fdp;
3212 FILE *fp;
Guido van Rossum74e6a111994-08-29 12:54:38 +00003213
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003214 /* Require:
3215 if mod == None: subname == fullname
3216 else: mod.__name__ + "." + subname == fullname
3217 */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003218
Victor Stinner974389d2011-03-15 09:33:57 +01003219 if ((m = PyDict_GetItem(modules, fullname)) != NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003220 Py_INCREF(m);
Victor Stinner9599de52011-03-13 22:38:38 -04003221 return m;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003222 }
Victor Stinner9599de52011-03-13 22:38:38 -04003223
3224 if (mod == Py_None)
Victor Stinner533d7832011-03-14 13:22:54 -04003225 path_list = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003226 else {
Victor Stinner533d7832011-03-14 13:22:54 -04003227 path_list = PyObject_GetAttrString(mod, "__path__");
3228 if (path_list == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003229 PyErr_Clear();
3230 Py_INCREF(Py_None);
3231 return Py_None;
3232 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003233 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003234
Victor Stinner533d7832011-03-14 13:22:54 -04003235 fdp = find_module(fullname, subname, path_list,
Victor Stinner2fd76e42011-03-14 15:19:39 -04003236 &bufobj, &fp, &loader);
Victor Stinner533d7832011-03-14 13:22:54 -04003237 Py_XDECREF(path_list);
Victor Stinner9599de52011-03-13 22:38:38 -04003238 if (fdp == NULL) {
3239 if (!PyErr_ExceptionMatches(PyExc_ImportError))
3240 return NULL;
3241 PyErr_Clear();
3242 Py_INCREF(Py_None);
3243 return Py_None;
3244 }
Victor Stinner2fd76e42011-03-14 15:19:39 -04003245 m = load_module(fullname, fp, bufobj, fdp->type, loader);
3246 Py_XDECREF(bufobj);
Victor Stinner9599de52011-03-13 22:38:38 -04003247 Py_XDECREF(loader);
3248 if (fp)
3249 fclose(fp);
3250 if (m == NULL)
3251 return NULL;
3252 if (!add_submodule(mod, m, fullname, subname, modules)) {
3253 Py_XDECREF(m);
3254 return NULL;
3255 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003256 return m;
Guido van Rossum74e6a111994-08-29 12:54:38 +00003257}
3258
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003259
3260/* Re-import a module of any kind and return its module object, WITH
3261 INCREMENTED REFERENCE COUNT */
3262
Guido van Rossum79f25d91997-04-29 20:08:16 +00003263PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003264PyImport_ReloadModule(PyObject *m)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003265{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003266 PyInterpreterState *interp = PyThreadState_Get()->interp;
3267 PyObject *modules_reloading = interp->modules_reloading;
3268 PyObject *modules = PyImport_GetModuleDict();
Victor Stinner533d7832011-03-14 13:22:54 -04003269 PyObject *path_list = NULL, *loader = NULL, *existing_m = NULL;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003270 PyObject *nameobj, *bufobj, *subnameobj;
3271 Py_UNICODE *name, *subname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003272 struct filedescr *fdp;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003273 FILE *fp = NULL;
3274 PyObject *newm = NULL;
Brett Cannon9a5b25a2010-03-01 02:09:17 +00003275
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003276 if (modules_reloading == NULL) {
3277 Py_FatalError("PyImport_ReloadModule: "
3278 "no modules_reloading dictionary!");
3279 return NULL;
3280 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003281
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003282 if (m == NULL || !PyModule_Check(m)) {
3283 PyErr_SetString(PyExc_TypeError,
3284 "reload() argument must be module");
3285 return NULL;
3286 }
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003287 nameobj = PyModule_GetNameObject(m);
3288 if (nameobj == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003289 return NULL;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003290 if (m != PyDict_GetItem(modules, nameobj)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003291 PyErr_Format(PyExc_ImportError,
Victor Stinner98dbba52011-03-14 15:15:47 -04003292 "reload(): module %R not in sys.modules",
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003293 nameobj);
3294 Py_DECREF(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003295 return NULL;
3296 }
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003297 existing_m = PyDict_GetItem(modules_reloading, nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003298 if (existing_m != NULL) {
3299 /* Due to a recursive reload, this module is already
3300 being reloaded. */
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003301 Py_DECREF(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003302 Py_INCREF(existing_m);
3303 return existing_m;
3304 }
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003305 if (PyDict_SetItem(modules_reloading, nameobj, m) < 0) {
3306 Py_DECREF(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003307 return NULL;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003308 }
Guido van Rossumd8faa362007-04-27 19:54:29 +00003309
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003310 name = PyUnicode_AS_UNICODE(nameobj);
3311 subname = Py_UNICODE_strrchr(name, '.');
3312 if (subname == NULL) {
3313 Py_INCREF(nameobj);
3314 subnameobj = nameobj;
3315 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003316 else {
3317 PyObject *parentname, *parent;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003318 Py_ssize_t len;
3319 len = subname - name;
3320 parentname = PyUnicode_FromUnicode(name, len);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003321 if (parentname == NULL) {
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003322 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003323 }
3324 parent = PyDict_GetItem(modules, parentname);
3325 if (parent == NULL) {
3326 PyErr_Format(PyExc_ImportError,
Victor Stinner98dbba52011-03-14 15:15:47 -04003327 "reload(): parent %R not in sys.modules",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003328 parentname);
3329 Py_DECREF(parentname);
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003330 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003331 }
3332 Py_DECREF(parentname);
Victor Stinner533d7832011-03-14 13:22:54 -04003333 path_list = PyObject_GetAttrString(parent, "__path__");
3334 if (path_list == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003335 PyErr_Clear();
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003336 subname++;
3337 len = PyUnicode_GET_SIZE(nameobj) - (len + 1);
3338 subnameobj = PyUnicode_FromUnicode(subname, len);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003339 }
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003340 if (subnameobj == NULL)
3341 goto error;
Victor Stinner533d7832011-03-14 13:22:54 -04003342 fdp = find_module(nameobj, subnameobj, path_list,
Victor Stinner2fd76e42011-03-14 15:19:39 -04003343 &bufobj, &fp, &loader);
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003344 Py_DECREF(subnameobj);
Victor Stinner533d7832011-03-14 13:22:54 -04003345 Py_XDECREF(path_list);
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00003346
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003347 if (fdp == NULL) {
3348 Py_XDECREF(loader);
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003349 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003350 }
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00003351
Victor Stinner2fd76e42011-03-14 15:19:39 -04003352 newm = load_module(nameobj, fp, bufobj, fdp->type, loader);
3353 Py_XDECREF(bufobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003354 Py_XDECREF(loader);
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00003355
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003356 if (fp)
3357 fclose(fp);
3358 if (newm == NULL) {
3359 /* load_module probably removed name from modules because of
3360 * the error. Put back the original module object. We're
3361 * going to return NULL in this case regardless of whether
3362 * replacing name succeeds, so the return value is ignored.
3363 */
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003364 PyDict_SetItem(modules, nameobj, m);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003365 }
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003366
3367error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003368 imp_modules_reloading_clear();
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003369 Py_DECREF(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003370 return newm;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003371}
3372
3373
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003374/* Higher-level import emulator which emulates the "import" statement
3375 more accurately -- it invokes the __import__() function from the
3376 builtins of the current globals. This means that the import is
3377 done using whatever import hooks are installed in the current
Brett Cannonbc2eff32010-09-19 21:39:02 +00003378 environment.
Guido van Rossum6058eb41998-12-21 19:51:00 +00003379 A dummy list ["__doc__"] is passed as the 4th argument so that
Neal Norwitz80e7f272007-08-26 06:45:23 +00003380 e.g. PyImport_Import(PyUnicode_FromString("win32com.client.gencache"))
Guido van Rossum6058eb41998-12-21 19:51:00 +00003381 will return <module "gencache"> instead of <module "win32com">. */
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003382
3383PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003384PyImport_Import(PyObject *module_name)
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003385{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003386 static PyObject *silly_list = NULL;
3387 static PyObject *builtins_str = NULL;
3388 static PyObject *import_str = NULL;
3389 PyObject *globals = NULL;
3390 PyObject *import = NULL;
3391 PyObject *builtins = NULL;
Brett Cannonbc2eff32010-09-19 21:39:02 +00003392 PyObject *modules = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003393 PyObject *r = NULL;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003394
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003395 /* Initialize constant string objects */
3396 if (silly_list == NULL) {
3397 import_str = PyUnicode_InternFromString("__import__");
3398 if (import_str == NULL)
3399 return NULL;
3400 builtins_str = PyUnicode_InternFromString("__builtins__");
3401 if (builtins_str == NULL)
3402 return NULL;
Brett Cannonbc2eff32010-09-19 21:39:02 +00003403 silly_list = PyList_New(0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003404 if (silly_list == NULL)
3405 return NULL;
3406 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003407
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003408 /* Get the builtins from current globals */
3409 globals = PyEval_GetGlobals();
3410 if (globals != NULL) {
3411 Py_INCREF(globals);
3412 builtins = PyObject_GetItem(globals, builtins_str);
3413 if (builtins == NULL)
3414 goto err;
3415 }
3416 else {
3417 /* No globals -- use standard builtins, and fake globals */
3418 builtins = PyImport_ImportModuleLevel("builtins",
3419 NULL, NULL, NULL, 0);
3420 if (builtins == NULL)
3421 return NULL;
3422 globals = Py_BuildValue("{OO}", builtins_str, builtins);
3423 if (globals == NULL)
3424 goto err;
3425 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003426
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003427 /* Get the __import__ function from the builtins */
3428 if (PyDict_Check(builtins)) {
3429 import = PyObject_GetItem(builtins, import_str);
3430 if (import == NULL)
3431 PyErr_SetObject(PyExc_KeyError, import_str);
3432 }
3433 else
3434 import = PyObject_GetAttr(builtins, import_str);
3435 if (import == NULL)
3436 goto err;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003437
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003438 /* Call the __import__ function with the proper argument list
Brett Cannonbc2eff32010-09-19 21:39:02 +00003439 Always use absolute import here.
3440 Calling for side-effect of import. */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003441 r = PyObject_CallFunction(import, "OOOOi", module_name, globals,
3442 globals, silly_list, 0, NULL);
Brett Cannonbc2eff32010-09-19 21:39:02 +00003443 if (r == NULL)
3444 goto err;
3445 Py_DECREF(r);
3446
3447 modules = PyImport_GetModuleDict();
3448 r = PyDict_GetItem(modules, module_name);
3449 if (r != NULL)
3450 Py_INCREF(r);
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003451
3452 err:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003453 Py_XDECREF(globals);
3454 Py_XDECREF(builtins);
3455 Py_XDECREF(import);
Tim Peters50d8d372001-02-28 05:34:27 +00003456
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003457 return r;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003458}
3459
3460
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003461/* Module 'imp' provides Python access to the primitives used for
3462 importing modules.
3463*/
3464
Guido van Rossum79f25d91997-04-29 20:08:16 +00003465static PyObject *
Barry Warsaw28a691b2010-04-17 00:19:56 +00003466imp_make_magic(long magic)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003467{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003468 char buf[4];
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003469
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003470 buf[0] = (char) ((magic >> 0) & 0xff);
3471 buf[1] = (char) ((magic >> 8) & 0xff);
3472 buf[2] = (char) ((magic >> 16) & 0xff);
3473 buf[3] = (char) ((magic >> 24) & 0xff);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003474
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003475 return PyBytes_FromStringAndSize(buf, 4);
Victor Stinner3e2b7172010-11-09 09:32:19 +00003476}
Barry Warsaw28a691b2010-04-17 00:19:56 +00003477
3478static PyObject *
3479imp_get_magic(PyObject *self, PyObject *noargs)
3480{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003481 return imp_make_magic(pyc_magic);
Barry Warsaw28a691b2010-04-17 00:19:56 +00003482}
3483
3484static PyObject *
3485imp_get_tag(PyObject *self, PyObject *noargs)
3486{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003487 return PyUnicode_FromString(pyc_tag);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003488}
3489
Guido van Rossum79f25d91997-04-29 20:08:16 +00003490static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +00003491imp_get_suffixes(PyObject *self, PyObject *noargs)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003492{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003493 PyObject *list;
3494 struct filedescr *fdp;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003495
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003496 list = PyList_New(0);
3497 if (list == NULL)
3498 return NULL;
3499 for (fdp = _PyImport_Filetab; fdp->suffix != NULL; fdp++) {
3500 PyObject *item = Py_BuildValue("ssi",
3501 fdp->suffix, fdp->mode, fdp->type);
3502 if (item == NULL) {
3503 Py_DECREF(list);
3504 return NULL;
3505 }
3506 if (PyList_Append(list, item) < 0) {
3507 Py_DECREF(list);
3508 Py_DECREF(item);
3509 return NULL;
3510 }
3511 Py_DECREF(item);
3512 }
3513 return list;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003514}
3515
Guido van Rossum79f25d91997-04-29 20:08:16 +00003516static PyObject *
Victor Stinner533d7832011-03-14 13:22:54 -04003517call_find_module(PyObject *name, PyObject *path_list)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003518{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003519 extern int fclose(FILE *);
3520 PyObject *fob, *ret;
3521 PyObject *pathobj;
3522 struct filedescr *fdp;
Victor Stinner7d8b77c2011-03-12 08:45:02 -05003523 FILE *fp;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003524 int fd = -1;
3525 char *found_encoding = NULL;
3526 char *encoding = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003527
Victor Stinner533d7832011-03-14 13:22:54 -04003528 if (path_list == Py_None)
3529 path_list = NULL;
3530 fdp = find_module(NULL, name, path_list,
Victor Stinner2fd76e42011-03-14 15:19:39 -04003531 &pathobj, &fp, NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003532 if (fdp == NULL)
3533 return NULL;
3534 if (fp != NULL) {
3535 fd = fileno(fp);
3536 if (fd != -1)
3537 fd = dup(fd);
3538 fclose(fp);
3539 fp = NULL;
3540 }
3541 if (fd != -1) {
3542 if (strchr(fdp->mode, 'b') == NULL) {
3543 /* PyTokenizer_FindEncoding() returns PyMem_MALLOC'ed
3544 memory. */
3545 found_encoding = PyTokenizer_FindEncoding(fd);
3546 lseek(fd, 0, 0); /* Reset position */
Victor Stinner2fd76e42011-03-14 15:19:39 -04003547 if (found_encoding == NULL && PyErr_Occurred()) {
3548 Py_XDECREF(pathobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003549 return NULL;
Victor Stinner2fd76e42011-03-14 15:19:39 -04003550 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003551 encoding = (found_encoding != NULL) ? found_encoding :
3552 (char*)PyUnicode_GetDefaultEncoding();
3553 }
Victor Stinner2fd76e42011-03-14 15:19:39 -04003554 fob = PyFile_FromFd(fd, NULL, fdp->mode, -1,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003555 (char*)encoding, NULL, NULL, 1);
3556 if (fob == NULL) {
Victor Stinner2fd76e42011-03-14 15:19:39 -04003557 Py_XDECREF(pathobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003558 close(fd);
3559 PyMem_FREE(found_encoding);
3560 return NULL;
3561 }
3562 }
3563 else {
3564 fob = Py_None;
3565 Py_INCREF(fob);
3566 }
Victor Stinner2fd76e42011-03-14 15:19:39 -04003567 if (pathobj == NULL) {
3568 Py_INCREF(Py_None);
3569 pathobj = Py_None;
3570 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003571 ret = Py_BuildValue("NN(ssi)",
3572 fob, pathobj, fdp->suffix, fdp->mode, fdp->type);
3573 PyMem_FREE(found_encoding);
Brett Cannon3bb42d92007-10-20 03:43:15 +00003574
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003575 return ret;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003576}
3577
Guido van Rossum79f25d91997-04-29 20:08:16 +00003578static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003579imp_find_module(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003580{
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003581 PyObject *name, *path_list = NULL;
3582 if (!PyArg_ParseTuple(args, "U|O:find_module",
3583 &name, &path_list))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003584 return NULL;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003585 return call_find_module(name, path_list);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003586}
3587
3588static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003589imp_init_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003590{
Victor Stinner95872862011-03-07 18:20:56 +01003591 PyObject *name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003592 int ret;
3593 PyObject *m;
Victor Stinner95872862011-03-07 18:20:56 +01003594 if (!PyArg_ParseTuple(args, "U:init_builtin", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003595 return NULL;
3596 ret = init_builtin(name);
3597 if (ret < 0)
3598 return NULL;
3599 if (ret == 0) {
3600 Py_INCREF(Py_None);
3601 return Py_None;
3602 }
Victor Stinner95872862011-03-07 18:20:56 +01003603 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003604 Py_XINCREF(m);
3605 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003606}
3607
Guido van Rossum79f25d91997-04-29 20:08:16 +00003608static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003609imp_init_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003610{
Victor Stinner53dc7352011-03-20 01:50:21 +01003611 PyObject *name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003612 int ret;
3613 PyObject *m;
Victor Stinner53dc7352011-03-20 01:50:21 +01003614 if (!PyArg_ParseTuple(args, "U:init_frozen", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003615 return NULL;
Victor Stinner53dc7352011-03-20 01:50:21 +01003616 ret = PyImport_ImportFrozenModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003617 if (ret < 0)
3618 return NULL;
3619 if (ret == 0) {
3620 Py_INCREF(Py_None);
3621 return Py_None;
3622 }
Victor Stinner53dc7352011-03-20 01:50:21 +01003623 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003624 Py_XINCREF(m);
3625 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003626}
3627
Guido van Rossum79f25d91997-04-29 20:08:16 +00003628static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003629imp_get_frozen_object(PyObject *self, PyObject *args)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00003630{
Victor Stinner53dc7352011-03-20 01:50:21 +01003631 PyObject *name;
Jack Jansen95ffa231995-10-03 14:38:41 +00003632
Victor Stinner53dc7352011-03-20 01:50:21 +01003633 if (!PyArg_ParseTuple(args, "U:get_frozen_object", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003634 return NULL;
3635 return get_frozen_object(name);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00003636}
3637
Guido van Rossum79f25d91997-04-29 20:08:16 +00003638static PyObject *
Brett Cannon8d110132009-03-15 02:20:16 +00003639imp_is_frozen_package(PyObject *self, PyObject *args)
3640{
Victor Stinner53dc7352011-03-20 01:50:21 +01003641 PyObject *name;
Brett Cannon8d110132009-03-15 02:20:16 +00003642
Victor Stinner53dc7352011-03-20 01:50:21 +01003643 if (!PyArg_ParseTuple(args, "U:is_frozen_package", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003644 return NULL;
3645 return is_frozen_package(name);
Brett Cannon8d110132009-03-15 02:20:16 +00003646}
3647
3648static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003649imp_is_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003650{
Victor Stinner95872862011-03-07 18:20:56 +01003651 PyObject *name;
3652 if (!PyArg_ParseTuple(args, "U:is_builtin", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003653 return NULL;
3654 return PyLong_FromLong(is_builtin(name));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003655}
3656
Guido van Rossum79f25d91997-04-29 20:08:16 +00003657static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003658imp_is_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003659{
Victor Stinner53dc7352011-03-20 01:50:21 +01003660 PyObject *name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003661 struct _frozen *p;
Victor Stinner53dc7352011-03-20 01:50:21 +01003662 if (!PyArg_ParseTuple(args, "U:is_frozen", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003663 return NULL;
3664 p = find_frozen(name);
3665 return PyBool_FromLong((long) (p == NULL ? 0 : p->size));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003666}
3667
3668static FILE *
Victor Stinner2f42ae52011-03-20 00:41:24 +01003669get_file(PyObject *pathname, PyObject *fob, char *mode)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003670{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003671 FILE *fp;
3672 if (mode[0] == 'U')
3673 mode = "r" PY_STDIOTEXTMODE;
3674 if (fob == NULL) {
Victor Stinner2f42ae52011-03-20 00:41:24 +01003675 fp = _Py_fopen(pathname, mode);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003676 }
3677 else {
3678 int fd = PyObject_AsFileDescriptor(fob);
3679 if (fd == -1)
3680 return NULL;
3681 if (!_PyVerify_fd(fd))
3682 goto error;
3683 /* the FILE struct gets a new fd, so that it can be closed
3684 * independently of the file descriptor given
3685 */
3686 fd = dup(fd);
3687 if (fd == -1)
3688 goto error;
3689 fp = fdopen(fd, mode);
3690 }
3691 if (fp)
3692 return fp;
Kristján Valur Jónssone1b04452009-03-31 17:43:39 +00003693error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003694 PyErr_SetFromErrno(PyExc_IOError);
3695 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003696}
3697
Guido van Rossum79f25d91997-04-29 20:08:16 +00003698static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003699imp_load_compiled(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003700{
Victor Stinner2f42ae52011-03-20 00:41:24 +01003701 PyObject *name, *pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003702 PyObject *fob = NULL;
3703 PyObject *m;
3704 FILE *fp;
Victor Stinner2f42ae52011-03-20 00:41:24 +01003705 if (!PyArg_ParseTuple(args, "UO&|O:load_compiled",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003706 &name,
Victor Stinner2f42ae52011-03-20 00:41:24 +01003707 PyUnicode_FSDecoder, &pathname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003708 &fob))
3709 return NULL;
Victor Stinner2f42ae52011-03-20 00:41:24 +01003710 fp = get_file(pathname, fob, "rb");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003711 if (fp == NULL) {
Victor Stinnerebc00522010-12-03 17:06:43 +00003712 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003713 return NULL;
3714 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01003715 m = load_compiled_module(name, pathname, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003716 fclose(fp);
Victor Stinnerebc00522010-12-03 17:06:43 +00003717 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003718 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003719}
3720
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003721#ifdef HAVE_DYNAMIC_LOADING
3722
Guido van Rossum79f25d91997-04-29 20:08:16 +00003723static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003724imp_load_dynamic(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003725{
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003726 PyObject *name, *pathname, *fob = NULL, *mod;
3727 FILE *fp;
3728
3729 if (!PyArg_ParseTuple(args, "UO&|O:load_dynamic",
3730 &name, PyUnicode_FSDecoder, &pathname, &fob))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003731 return NULL;
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003732 if (fob != NULL) {
3733 fp = get_file(NULL, fob, "r");
Victor Stinnere9ddbf62011-03-22 10:46:35 +01003734 if (fp == NULL) {
3735 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003736 return NULL;
Victor Stinnere9ddbf62011-03-22 10:46:35 +01003737 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003738 }
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003739 else
3740 fp = NULL;
3741 mod = _PyImport_LoadDynamicModule(name, pathname, fp);
Victor Stinnere9ddbf62011-03-22 10:46:35 +01003742 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003743 if (fp)
3744 fclose(fp);
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003745 return mod;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003746}
3747
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003748#endif /* HAVE_DYNAMIC_LOADING */
3749
Guido van Rossum79f25d91997-04-29 20:08:16 +00003750static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003751imp_load_source(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003752{
Victor Stinner2f42ae52011-03-20 00:41:24 +01003753 PyObject *name, *pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003754 PyObject *fob = NULL;
3755 PyObject *m;
3756 FILE *fp;
Victor Stinner2f42ae52011-03-20 00:41:24 +01003757 if (!PyArg_ParseTuple(args, "UO&|O:load_source",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003758 &name,
Victor Stinner2f42ae52011-03-20 00:41:24 +01003759 PyUnicode_FSDecoder, &pathname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003760 &fob))
3761 return NULL;
Victor Stinner2f42ae52011-03-20 00:41:24 +01003762 fp = get_file(pathname, fob, "r");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003763 if (fp == NULL) {
Victor Stinnerebc00522010-12-03 17:06:43 +00003764 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003765 return NULL;
3766 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01003767 m = load_source_module(name, pathname, fp);
Victor Stinnerebc00522010-12-03 17:06:43 +00003768 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003769 fclose(fp);
3770 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003771}
3772
Guido van Rossum79f25d91997-04-29 20:08:16 +00003773static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003774imp_load_module(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003775{
Victor Stinner6ae1e7f2011-03-20 22:37:17 +01003776 PyObject *name, *fob, *pathname, *pathname_obj, *ret;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003777 char *suffix; /* Unused */
3778 char *mode;
3779 int type;
3780 FILE *fp;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003781
Victor Stinner6ae1e7f2011-03-20 22:37:17 +01003782 if (!PyArg_ParseTuple(args, "UOO(ssi):load_module",
3783 &name, &fob, &pathname_obj, &suffix, &mode, &type))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003784 return NULL;
Victor Stinner6ae1e7f2011-03-20 22:37:17 +01003785 if (pathname_obj != Py_None) {
3786 if (!PyUnicode_FSDecoder(pathname_obj, &pathname))
3787 return NULL;
3788 }
3789 else
3790 pathname = NULL;
3791
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003792 if (*mode) {
3793 /* Mode must start with 'r' or 'U' and must not contain '+'.
3794 Implicit in this test is the assumption that the mode
3795 may contain other modifiers like 'b' or 't'. */
Guido van Rossum5e2c5fa2002-05-30 17:33:07 +00003796
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003797 if (!(*mode == 'r' || *mode == 'U') || strchr(mode, '+')) {
3798 PyErr_Format(PyExc_ValueError,
3799 "invalid file open mode %.200s", mode);
Victor Stinner6ae1e7f2011-03-20 22:37:17 +01003800 Py_XDECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003801 return NULL;
3802 }
3803 }
3804 if (fob == Py_None)
3805 fp = NULL;
3806 else {
3807 fp = get_file(NULL, fob, mode);
3808 if (fp == NULL) {
Victor Stinner6ae1e7f2011-03-20 22:37:17 +01003809 Py_XDECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003810 return NULL;
3811 }
3812 }
Victor Stinner41c5fec2011-03-13 21:46:30 -04003813 ret = load_module(name, fp, pathname, type, NULL);
Victor Stinner6ae1e7f2011-03-20 22:37:17 +01003814 Py_XDECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003815 if (fp)
3816 fclose(fp);
3817 return ret;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003818}
3819
3820static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003821imp_load_package(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003822{
Victor Stinnerc9abda02011-03-14 13:33:46 -04003823 PyObject *name, *pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003824 PyObject * ret;
Victor Stinnerc9abda02011-03-14 13:33:46 -04003825 if (!PyArg_ParseTuple(args, "UO&:load_package",
3826 &name, PyUnicode_FSDecoder, &pathname))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003827 return NULL;
Victor Stinnerc9abda02011-03-14 13:33:46 -04003828 ret = load_package(name, pathname);
Victor Stinnerebc00522010-12-03 17:06:43 +00003829 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003830 return ret;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003831}
3832
3833static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003834imp_new_module(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003835{
Victor Stinnerfe19d212011-03-14 14:53:28 -04003836 PyObject *name;
3837 if (!PyArg_ParseTuple(args, "U:new_module", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003838 return NULL;
Victor Stinnerfe19d212011-03-14 14:53:28 -04003839 return PyModule_NewObject(name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003840}
3841
Christian Heimes13a7a212008-01-07 17:13:09 +00003842static PyObject *
3843imp_reload(PyObject *self, PyObject *v)
3844{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003845 return PyImport_ReloadModule(v);
Christian Heimes13a7a212008-01-07 17:13:09 +00003846}
3847
3848PyDoc_STRVAR(doc_reload,
3849"reload(module) -> module\n\
3850\n\
3851Reload the module. The module must have been successfully imported before.");
3852
Barry Warsaw28a691b2010-04-17 00:19:56 +00003853static PyObject *
3854imp_cache_from_source(PyObject *self, PyObject *args, PyObject *kws)
3855{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003856 static char *kwlist[] = {"path", "debug_override", NULL};
Barry Warsaw28a691b2010-04-17 00:19:56 +00003857
Victor Stinner2f42ae52011-03-20 00:41:24 +01003858 PyObject *pathname, *cpathname;
Benjamin Peterson294a9fc2010-10-16 03:12:39 +00003859 PyObject *debug_override = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003860 int debug = !Py_OptimizeFlag;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003861
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003862 if (!PyArg_ParseTupleAndKeywords(
Victor Stinner3ea23dd2010-10-15 20:34:32 +00003863 args, kws, "O&|O", kwlist,
Victor Stinner2f42ae52011-03-20 00:41:24 +01003864 PyUnicode_FSDecoder, &pathname, &debug_override))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003865 return NULL;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003866
Benjamin Peterson294a9fc2010-10-16 03:12:39 +00003867 if (debug_override != NULL &&
3868 (debug = PyObject_IsTrue(debug_override)) < 0) {
Victor Stinner2f42ae52011-03-20 00:41:24 +01003869 Py_DECREF(pathname);
Benjamin Peterson294a9fc2010-10-16 03:12:39 +00003870 return NULL;
3871 }
Barry Warsaw28a691b2010-04-17 00:19:56 +00003872
Victor Stinner3ea23dd2010-10-15 20:34:32 +00003873 cpathname = make_compiled_pathname(
Victor Stinner2f42ae52011-03-20 00:41:24 +01003874 PyUnicode_AS_UNICODE(pathname),
3875 debug);
3876 Py_DECREF(pathname);
Barry Warsaw28a691b2010-04-17 00:19:56 +00003877
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003878 if (cpathname == NULL) {
3879 PyErr_Format(PyExc_SystemError, "path buffer too short");
3880 return NULL;
3881 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01003882 return cpathname;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003883}
3884
3885PyDoc_STRVAR(doc_cache_from_source,
3886"Given the path to a .py file, return the path to its .pyc/.pyo file.\n\
3887\n\
3888The .py file does not need to exist; this simply returns the path to the\n\
3889.pyc/.pyo file calculated as if the .py file were imported. The extension\n\
3890will be .pyc unless __debug__ is not defined, then it will be .pyo.\n\
3891\n\
3892If debug_override is not None, then it must be a boolean and is taken as\n\
3893the value of __debug__ instead.");
3894
3895static PyObject *
3896imp_source_from_cache(PyObject *self, PyObject *args, PyObject *kws)
3897{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003898 static char *kwlist[] = {"path", NULL};
Victor Stinnerc9abda02011-03-14 13:33:46 -04003899 PyObject *pathname, *source;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003900
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003901 if (!PyArg_ParseTupleAndKeywords(
Victor Stinnerebc00522010-12-03 17:06:43 +00003902 args, kws, "O&", kwlist,
Victor Stinnerc9abda02011-03-14 13:33:46 -04003903 PyUnicode_FSDecoder, &pathname))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003904 return NULL;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003905
Victor Stinnerc9abda02011-03-14 13:33:46 -04003906 source = make_source_pathname(pathname);
3907 if (source == NULL) {
3908 PyErr_Format(PyExc_ValueError, "Not a PEP 3147 pyc path: %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003909 pathname);
Victor Stinnerc9abda02011-03-14 13:33:46 -04003910 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003911 return NULL;
3912 }
Victor Stinnerc9abda02011-03-14 13:33:46 -04003913 Py_DECREF(pathname);
3914 return source;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003915}
3916
3917PyDoc_STRVAR(doc_source_from_cache,
3918"Given the path to a .pyc./.pyo file, return the path to its .py file.\n\
3919\n\
3920The .pyc/.pyo file does not need to exist; this simply returns the path to\n\
3921the .py file calculated to correspond to the .pyc/.pyo file. If path\n\
3922does not conform to PEP 3147 format, ValueError will be raised.");
3923
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003924/* Doc strings */
3925
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003926PyDoc_STRVAR(doc_imp,
3927"This module provides the components needed to build your own\n\
3928__import__ function. Undocumented functions are obsolete.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003929
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003930PyDoc_STRVAR(doc_find_module,
3931"find_module(name, [path]) -> (file, filename, (suffix, mode, type))\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003932Search for a module. If path is omitted or None, search for a\n\
3933built-in, frozen or special module and continue search in sys.path.\n\
3934The module name cannot contain '.'; to search for a submodule of a\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003935package, pass the submodule name and the package's __path__.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003936
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003937PyDoc_STRVAR(doc_load_module,
3938"load_module(name, file, filename, (suffix, mode, type)) -> module\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003939Load a module, given information returned by find_module().\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003940The module name must include the full package name, if any.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003941
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003942PyDoc_STRVAR(doc_get_magic,
3943"get_magic() -> string\n\
3944Return the magic number for .pyc or .pyo files.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003945
Barry Warsaw28a691b2010-04-17 00:19:56 +00003946PyDoc_STRVAR(doc_get_tag,
3947"get_tag() -> string\n\
3948Return the magic tag for .pyc or .pyo files.");
3949
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003950PyDoc_STRVAR(doc_get_suffixes,
3951"get_suffixes() -> [(suffix, mode, type), ...]\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003952Return a list of (suffix, mode, type) tuples describing the files\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003953that find_module() looks for.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003954
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003955PyDoc_STRVAR(doc_new_module,
3956"new_module(name) -> module\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003957Create a new module. Do not enter it in sys.modules.\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_lock_held,
Tim Petersa7c65092004-08-01 23:26:05 +00003961"lock_held() -> boolean\n\
3962Return True if the import lock is currently held, else False.\n\
3963On platforms without threads, return False.");
Tim Peters69232342001-08-30 05:16:13 +00003964
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00003965PyDoc_STRVAR(doc_acquire_lock,
3966"acquire_lock() -> None\n\
Neal Norwitz2294c0d2003-02-12 23:02:21 +00003967Acquires the interpreter's import lock for the current thread.\n\
3968This lock should be used by import hooks to ensure thread-safety\n\
3969when importing modules.\n\
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00003970On platforms without threads, this function does nothing.");
3971
3972PyDoc_STRVAR(doc_release_lock,
3973"release_lock() -> None\n\
3974Release the interpreter's import lock.\n\
3975On platforms without threads, this function does nothing.");
3976
Guido van Rossum79f25d91997-04-29 20:08:16 +00003977static PyMethodDef imp_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003978 {"find_module", imp_find_module, METH_VARARGS, doc_find_module},
3979 {"get_magic", imp_get_magic, METH_NOARGS, doc_get_magic},
3980 {"get_tag", imp_get_tag, METH_NOARGS, doc_get_tag},
3981 {"get_suffixes", imp_get_suffixes, METH_NOARGS, doc_get_suffixes},
3982 {"load_module", imp_load_module, METH_VARARGS, doc_load_module},
3983 {"new_module", imp_new_module, METH_VARARGS, doc_new_module},
3984 {"lock_held", imp_lock_held, METH_NOARGS, doc_lock_held},
3985 {"acquire_lock", imp_acquire_lock, METH_NOARGS, doc_acquire_lock},
3986 {"release_lock", imp_release_lock, METH_NOARGS, doc_release_lock},
3987 {"reload", imp_reload, METH_O, doc_reload},
3988 {"cache_from_source", (PyCFunction)imp_cache_from_source,
3989 METH_VARARGS | METH_KEYWORDS, doc_cache_from_source},
3990 {"source_from_cache", (PyCFunction)imp_source_from_cache,
3991 METH_VARARGS | METH_KEYWORDS, doc_source_from_cache},
3992 /* The rest are obsolete */
3993 {"get_frozen_object", imp_get_frozen_object, METH_VARARGS},
3994 {"is_frozen_package", imp_is_frozen_package, METH_VARARGS},
3995 {"init_builtin", imp_init_builtin, METH_VARARGS},
3996 {"init_frozen", imp_init_frozen, METH_VARARGS},
3997 {"is_builtin", imp_is_builtin, METH_VARARGS},
3998 {"is_frozen", imp_is_frozen, METH_VARARGS},
3999 {"load_compiled", imp_load_compiled, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00004000#ifdef HAVE_DYNAMIC_LOADING
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004001 {"load_dynamic", imp_load_dynamic, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00004002#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004003 {"load_package", imp_load_package, METH_VARARGS},
4004 {"load_source", imp_load_source, METH_VARARGS},
Brett Cannon442c9b92011-03-23 16:14:42 -07004005 {"_fix_co_filename", imp_fix_co_filename, METH_VARARGS},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004006 {NULL, NULL} /* sentinel */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004007};
4008
Guido van Rossum1a8791e1998-08-04 22:46:29 +00004009static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00004010setint(PyObject *d, char *name, int value)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00004011{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004012 PyObject *v;
4013 int err;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00004014
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004015 v = PyLong_FromLong((long)value);
4016 err = PyDict_SetItemString(d, name, v);
4017 Py_XDECREF(v);
4018 return err;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00004019}
4020
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004021typedef struct {
4022 PyObject_HEAD
4023} NullImporter;
4024
4025static int
4026NullImporter_init(NullImporter *self, PyObject *args, PyObject *kwds)
4027{
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004028#ifndef MS_WINDOWS
4029 PyObject *path;
4030 struct stat statbuf;
4031 int rv;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004032
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004033 if (!_PyArg_NoKeywords("NullImporter()", kwds))
4034 return -1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004035
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004036 if (!PyArg_ParseTuple(args, "O&:NullImporter",
4037 PyUnicode_FSConverter, &path))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004038 return -1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004039
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004040 if (PyBytes_GET_SIZE(path) == 0) {
4041 Py_DECREF(path);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004042 PyErr_SetString(PyExc_ImportError, "empty pathname");
4043 return -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004044 }
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004045
4046 rv = stat(PyBytes_AS_STRING(path), &statbuf);
4047 Py_DECREF(path);
4048 if (rv == 0) {
4049 /* it exists */
4050 if (S_ISDIR(statbuf.st_mode)) {
4051 /* it's a directory */
4052 PyErr_SetString(PyExc_ImportError, "existing directory");
4053 return -1;
4054 }
4055 }
4056#else /* MS_WINDOWS */
4057 PyObject *pathobj;
4058 DWORD rv;
Victor Stinner255dfdb2010-09-29 10:28:51 +00004059 wchar_t *path;
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004060
4061 if (!_PyArg_NoKeywords("NullImporter()", kwds))
4062 return -1;
4063
4064 if (!PyArg_ParseTuple(args, "U:NullImporter",
4065 &pathobj))
4066 return -1;
4067
4068 if (PyUnicode_GET_SIZE(pathobj) == 0) {
4069 PyErr_SetString(PyExc_ImportError, "empty pathname");
4070 return -1;
4071 }
4072
Victor Stinnerbeb4135b2010-10-07 01:02:42 +00004073 path = PyUnicode_AsWideCharString(pathobj, NULL);
Victor Stinner255dfdb2010-09-29 10:28:51 +00004074 if (path == NULL)
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004075 return -1;
4076 /* see issue1293 and issue3677:
4077 * stat() on Windows doesn't recognise paths like
4078 * "e:\\shared\\" and "\\\\whiterab-c2znlh\\shared" as dirs.
4079 */
4080 rv = GetFileAttributesW(path);
Victor Stinner255dfdb2010-09-29 10:28:51 +00004081 PyMem_Free(path);
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004082 if (rv != INVALID_FILE_ATTRIBUTES) {
4083 /* it exists */
4084 if (rv & FILE_ATTRIBUTE_DIRECTORY) {
4085 /* it's a directory */
4086 PyErr_SetString(PyExc_ImportError, "existing directory");
4087 return -1;
4088 }
4089 }
4090#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004091 return 0;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004092}
4093
4094static PyObject *
4095NullImporter_find_module(NullImporter *self, PyObject *args)
4096{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004097 Py_RETURN_NONE;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004098}
4099
4100static PyMethodDef NullImporter_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004101 {"find_module", (PyCFunction)NullImporter_find_module, METH_VARARGS,
4102 "Always return None"
4103 },
4104 {NULL} /* Sentinel */
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004105};
4106
4107
Christian Heimes9cd17752007-11-18 19:35:23 +00004108PyTypeObject PyNullImporter_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004109 PyVarObject_HEAD_INIT(NULL, 0)
4110 "imp.NullImporter", /*tp_name*/
4111 sizeof(NullImporter), /*tp_basicsize*/
4112 0, /*tp_itemsize*/
4113 0, /*tp_dealloc*/
4114 0, /*tp_print*/
4115 0, /*tp_getattr*/
4116 0, /*tp_setattr*/
4117 0, /*tp_reserved*/
4118 0, /*tp_repr*/
4119 0, /*tp_as_number*/
4120 0, /*tp_as_sequence*/
4121 0, /*tp_as_mapping*/
4122 0, /*tp_hash */
4123 0, /*tp_call*/
4124 0, /*tp_str*/
4125 0, /*tp_getattro*/
4126 0, /*tp_setattro*/
4127 0, /*tp_as_buffer*/
4128 Py_TPFLAGS_DEFAULT, /*tp_flags*/
4129 "Null importer object", /* tp_doc */
4130 0, /* tp_traverse */
4131 0, /* tp_clear */
4132 0, /* tp_richcompare */
4133 0, /* tp_weaklistoffset */
4134 0, /* tp_iter */
4135 0, /* tp_iternext */
4136 NullImporter_methods, /* tp_methods */
4137 0, /* tp_members */
4138 0, /* tp_getset */
4139 0, /* tp_base */
4140 0, /* tp_dict */
4141 0, /* tp_descr_get */
4142 0, /* tp_descr_set */
4143 0, /* tp_dictoffset */
4144 (initproc)NullImporter_init, /* tp_init */
4145 0, /* tp_alloc */
4146 PyType_GenericNew /* tp_new */
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004147};
4148
Martin v. Löwis1a214512008-06-11 05:26:20 +00004149static struct PyModuleDef impmodule = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004150 PyModuleDef_HEAD_INIT,
4151 "imp",
4152 doc_imp,
4153 0,
4154 imp_methods,
4155 NULL,
4156 NULL,
4157 NULL,
4158 NULL
Martin v. Löwis1a214512008-06-11 05:26:20 +00004159};
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004160
Jason Tishler6bc06ec2003-09-04 11:59:50 +00004161PyMODINIT_FUNC
Martin v. Löwis1a214512008-06-11 05:26:20 +00004162PyInit_imp(void)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004163{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004164 PyObject *m, *d;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004165
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004166 if (PyType_Ready(&PyNullImporter_Type) < 0)
4167 return NULL;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004168
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004169 m = PyModule_Create(&impmodule);
4170 if (m == NULL)
4171 goto failure;
4172 d = PyModule_GetDict(m);
4173 if (d == NULL)
4174 goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004175
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004176 if (setint(d, "SEARCH_ERROR", SEARCH_ERROR) < 0) goto failure;
4177 if (setint(d, "PY_SOURCE", PY_SOURCE) < 0) goto failure;
4178 if (setint(d, "PY_COMPILED", PY_COMPILED) < 0) goto failure;
4179 if (setint(d, "C_EXTENSION", C_EXTENSION) < 0) goto failure;
4180 if (setint(d, "PY_RESOURCE", PY_RESOURCE) < 0) goto failure;
4181 if (setint(d, "PKG_DIRECTORY", PKG_DIRECTORY) < 0) goto failure;
4182 if (setint(d, "C_BUILTIN", C_BUILTIN) < 0) goto failure;
4183 if (setint(d, "PY_FROZEN", PY_FROZEN) < 0) goto failure;
4184 if (setint(d, "PY_CODERESOURCE", PY_CODERESOURCE) < 0) goto failure;
4185 if (setint(d, "IMP_HOOK", IMP_HOOK) < 0) goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004186
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004187 Py_INCREF(&PyNullImporter_Type);
4188 PyModule_AddObject(m, "NullImporter", (PyObject *)&PyNullImporter_Type);
4189 return m;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00004190 failure:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004191 Py_XDECREF(m);
4192 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004193}
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004194
4195
Guido van Rossumb18618d2000-05-03 23:44:39 +00004196/* API for embedding applications that want to add their own entries
4197 to the table of built-in modules. This should normally be called
4198 *before* Py_Initialize(). When the table resize fails, -1 is
4199 returned and the existing table is unchanged.
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004200
4201 After a similar function by Just van Rossum. */
4202
4203int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00004204PyImport_ExtendInittab(struct _inittab *newtab)
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004205{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004206 static struct _inittab *our_copy = NULL;
4207 struct _inittab *p;
4208 int i, n;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004209
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004210 /* Count the number of entries in both tables */
4211 for (n = 0; newtab[n].name != NULL; n++)
4212 ;
4213 if (n == 0)
4214 return 0; /* Nothing to do */
4215 for (i = 0; PyImport_Inittab[i].name != NULL; i++)
4216 ;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004217
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004218 /* Allocate new memory for the combined table */
4219 p = our_copy;
4220 PyMem_RESIZE(p, struct _inittab, i+n+1);
4221 if (p == NULL)
4222 return -1;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004223
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004224 /* Copy the tables into the new memory */
4225 if (our_copy != PyImport_Inittab)
4226 memcpy(p, PyImport_Inittab, (i+1) * sizeof(struct _inittab));
4227 PyImport_Inittab = our_copy = p;
4228 memcpy(p+i, newtab, (n+1) * sizeof(struct _inittab));
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004229
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004230 return 0;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004231}
4232
4233/* Shorthand to add a single entry given a name and a function */
4234
4235int
Brett Cannona826f322009-04-02 03:41:46 +00004236PyImport_AppendInittab(const char *name, PyObject* (*initfunc)(void))
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004237{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004238 struct _inittab newtab[2];
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004239
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004240 memset(newtab, '\0', sizeof newtab);
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004241
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004242 newtab[0].name = (char *)name;
4243 newtab[0].initfunc = initfunc;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004244
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004245 return PyImport_ExtendInittab(newtab);
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004246}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00004247
4248#ifdef __cplusplus
4249}
4250#endif