blob: abc390671980be43cae24a23139aac3ad97a1bae [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
1377/* Load a source module from a given file and return its module
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001378 object WITH INCREMENTED REFERENCE COUNT. If there's a matching
1379 byte-compiled file, use that instead. */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001380
Guido van Rossum79f25d91997-04-29 20:08:16 +00001381static PyObject *
Victor Stinner2f42ae52011-03-20 00:41:24 +01001382load_source_module(PyObject *name, PyObject *pathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001383{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001384 struct stat st;
1385 FILE *fpc;
Victor Stinner2f42ae52011-03-20 00:41:24 +01001386 PyObject *cpathname = NULL, *cpathbytes = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001387 PyCodeObject *co;
Victor Stinner2f42ae52011-03-20 00:41:24 +01001388 PyObject *m = NULL;
Brett Cannon9a5b25a2010-03-01 02:09:17 +00001389
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001390 if (fstat(fileno(fp), &st) != 0) {
1391 PyErr_Format(PyExc_RuntimeError,
Victor Stinner2f42ae52011-03-20 00:41:24 +01001392 "unable to get file status from %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001393 pathname);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001394 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001395 }
Fred Drake4c82b232000-06-30 16:18:57 +00001396#if SIZEOF_TIME_T > 4
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001397 /* Python's .pyc timestamp handling presumes that the timestamp fits
1398 in 4 bytes. This will be fine until sometime in the year 2038,
1399 when a 4-byte signed time_t will overflow.
1400 */
1401 if (st.st_mtime >> 32) {
1402 PyErr_SetString(PyExc_OverflowError,
1403 "modification time overflows a 4 byte field");
Victor Stinner2f42ae52011-03-20 00:41:24 +01001404 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001405 }
Fred Drake4c82b232000-06-30 16:18:57 +00001406#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001407 cpathname = make_compiled_pathname(
Victor Stinner2f42ae52011-03-20 00:41:24 +01001408 PyUnicode_AS_UNICODE(pathname),
1409 !Py_OptimizeFlag);
1410
1411 if (cpathname != NULL)
1412 fpc = check_compiled_module(pathname, st.st_mtime, cpathname);
1413 else
1414 fpc = NULL;
1415
1416 if (fpc) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001417 co = read_compiled_module(cpathname, fpc);
1418 fclose(fpc);
1419 if (co == NULL)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001420 goto error;
1421 update_compiled_module(co, pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001422 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001423 PySys_FormatStderr("import %U # precompiled from %R\n",
1424 name, cpathname);
1425 m = PyImport_ExecCodeModuleObject(name, (PyObject *)co,
1426 cpathname, cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001427 }
1428 else {
1429 co = parse_source_module(pathname, fp);
1430 if (co == NULL)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001431 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001432 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001433 PySys_FormatStderr("import %U # from %R\n",
Victor Stinner98dbba52011-03-14 15:15:47 -04001434 name, pathname);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001435 if (cpathname != NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001436 PyObject *ro = PySys_GetObject("dont_write_bytecode");
1437 if (ro == NULL || !PyObject_IsTrue(ro))
1438 write_compiled_module(co, cpathname, &st);
1439 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01001440 m = PyImport_ExecCodeModuleObject(name, (PyObject *)co,
1441 pathname, cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001442 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001443 Py_DECREF(co);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001444
Victor Stinner2f42ae52011-03-20 00:41:24 +01001445error:
1446 Py_XDECREF(cpathbytes);
1447 Py_XDECREF(cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001448 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001449}
1450
Christian Heimes3b06e532008-01-07 20:12:44 +00001451/* Get source file -> unicode or None
1452 * Returns the path to the py file if available, else the given path
1453 */
1454static PyObject *
Victor Stinnerc9abda02011-03-14 13:33:46 -04001455get_sourcefile(PyObject *filename)
Christian Heimes3b06e532008-01-07 20:12:44 +00001456{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001457 Py_ssize_t len;
Victor Stinnerc9abda02011-03-14 13:33:46 -04001458 Py_UNICODE *fileuni;
1459 PyObject *py;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001460 struct stat statbuf;
Christian Heimes3b06e532008-01-07 20:12:44 +00001461
Victor Stinnerc9abda02011-03-14 13:33:46 -04001462 len = PyUnicode_GET_SIZE(filename);
1463 if (len == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001464 Py_RETURN_NONE;
Christian Heimes3b06e532008-01-07 20:12:44 +00001465
Victor Stinnerc9abda02011-03-14 13:33:46 -04001466 /* don't match *.pyc or *.pyo? */
1467 fileuni = PyUnicode_AS_UNICODE(filename);
1468 if (len < 5
1469 || fileuni[len-4] != '.'
1470 || (fileuni[len-3] != 'p' && fileuni[len-3] != 'P')
1471 || (fileuni[len-2] != 'y' && fileuni[len-2] != 'Y'))
1472 goto unchanged;
Christian Heimes3b06e532008-01-07 20:12:44 +00001473
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001474 /* Start by trying to turn PEP 3147 path into source path. If that
1475 * fails, just chop off the trailing character, i.e. legacy pyc path
1476 * to py.
1477 */
Victor Stinnerc9abda02011-03-14 13:33:46 -04001478 py = make_source_pathname(filename);
1479 if (py == NULL) {
1480 PyErr_Clear();
1481 py = PyUnicode_FromUnicode(fileuni, len - 1);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001482 }
Victor Stinnerc9abda02011-03-14 13:33:46 -04001483 if (py == NULL)
1484 goto error;
Barry Warsaw28a691b2010-04-17 00:19:56 +00001485
Victor Stinnerc9abda02011-03-14 13:33:46 -04001486 if (_Py_stat(py, &statbuf) == 0 && S_ISREG(statbuf.st_mode))
1487 return py;
1488 Py_DECREF(py);
1489 goto unchanged;
1490
1491error:
1492 PyErr_Clear();
1493unchanged:
1494 Py_INCREF(filename);
1495 return filename;
Christian Heimes3b06e532008-01-07 20:12:44 +00001496}
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001497
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001498/* Forward */
Victor Stinner41c5fec2011-03-13 21:46:30 -04001499static PyObject *load_module(PyObject *, FILE *, PyObject *, int, PyObject *);
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001500static struct filedescr *find_module(PyObject *, PyObject *, PyObject *,
Victor Stinner2fd76e42011-03-14 15:19:39 -04001501 PyObject **, FILE **, PyObject **);
Victor Stinner53dc7352011-03-20 01:50:21 +01001502static struct _frozen * find_frozen(PyObject *);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001503
1504/* Load a package and return its module object WITH INCREMENTED
1505 REFERENCE COUNT */
1506
1507static PyObject *
Victor Stinnerc9abda02011-03-14 13:33:46 -04001508load_package(PyObject *name, PyObject *pathname)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001509{
Victor Stinner41c5fec2011-03-13 21:46:30 -04001510 PyObject *m, *d, *bufobj;
Victor Stinnerc9abda02011-03-14 13:33:46 -04001511 PyObject *file = NULL, *path_list = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001512 int err;
Victor Stinnerc9abda02011-03-14 13:33:46 -04001513 FILE *fp = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001514 struct filedescr *fdp;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001515
Victor Stinnerc9abda02011-03-14 13:33:46 -04001516 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001517 if (m == NULL)
1518 return NULL;
1519 if (Py_VerboseFlag)
Victor Stinner98dbba52011-03-14 15:15:47 -04001520 PySys_FormatStderr("import %U # directory %R\n",
1521 name, pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001522 file = get_sourcefile(pathname);
1523 if (file == NULL)
Victor Stinnerc9abda02011-03-14 13:33:46 -04001524 return NULL;
1525 path_list = Py_BuildValue("[O]", file);
1526 if (path_list == NULL) {
1527 Py_DECREF(file);
1528 return NULL;
1529 }
1530 d = PyModule_GetDict(m);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001531 err = PyDict_SetItemString(d, "__file__", file);
Victor Stinnerc9abda02011-03-14 13:33:46 -04001532 Py_DECREF(file);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001533 if (err == 0)
Victor Stinnerc9abda02011-03-14 13:33:46 -04001534 err = PyDict_SetItemString(d, "__path__", path_list);
1535 if (err != 0) {
1536 Py_DECREF(path_list);
1537 return NULL;
1538 }
Victor Stinner533d7832011-03-14 13:22:54 -04001539 fdp = find_module(name, initstr, path_list,
Victor Stinner2fd76e42011-03-14 15:19:39 -04001540 &bufobj, &fp, NULL);
Victor Stinnerc9abda02011-03-14 13:33:46 -04001541 Py_DECREF(path_list);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001542 if (fdp == NULL) {
1543 if (PyErr_ExceptionMatches(PyExc_ImportError)) {
1544 PyErr_Clear();
1545 Py_INCREF(m);
Victor Stinnerc9abda02011-03-14 13:33:46 -04001546 return m;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001547 }
1548 else
Victor Stinnerc9abda02011-03-14 13:33:46 -04001549 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001550 }
Victor Stinner2fd76e42011-03-14 15:19:39 -04001551 m = load_module(name, fp, bufobj, fdp->type, NULL);
1552 Py_XDECREF(bufobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001553 if (fp != NULL)
1554 fclose(fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001555 return m;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001556}
1557
1558
1559/* Helper to test for built-in module */
1560
1561static int
Victor Stinner95872862011-03-07 18:20:56 +01001562is_builtin(PyObject *name)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001563{
Victor Stinner95872862011-03-07 18:20:56 +01001564 int i, cmp;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001565 for (i = 0; PyImport_Inittab[i].name != NULL; i++) {
Victor Stinner95872862011-03-07 18:20:56 +01001566 cmp = PyUnicode_CompareWithASCIIString(name, PyImport_Inittab[i].name);
1567 if (cmp == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001568 if (PyImport_Inittab[i].initfunc == NULL)
1569 return -1;
1570 else
1571 return 1;
1572 }
1573 }
1574 return 0;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001575}
1576
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001577
Just van Rossum52e14d62002-12-30 22:08:05 +00001578/* Return an importer object for a sys.path/pkg.__path__ item 'p',
1579 possibly by fetching it from the path_importer_cache dict. If it
Thomas Wouters89f507f2006-12-13 04:49:30 +00001580 wasn't yet cached, traverse path_hooks until a hook is found
Just van Rossum52e14d62002-12-30 22:08:05 +00001581 that can handle the path item. Return None if no hook could;
1582 this tells our caller it should fall back to the builtin
1583 import mechanism. Cache the result in path_importer_cache.
1584 Returns a borrowed reference. */
1585
1586static PyObject *
1587get_path_importer(PyObject *path_importer_cache, PyObject *path_hooks,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001588 PyObject *p)
Just van Rossum52e14d62002-12-30 22:08:05 +00001589{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001590 PyObject *importer;
1591 Py_ssize_t j, nhooks;
Just van Rossum52e14d62002-12-30 22:08:05 +00001592
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001593 /* These conditions are the caller's responsibility: */
1594 assert(PyList_Check(path_hooks));
1595 assert(PyDict_Check(path_importer_cache));
Just van Rossum52e14d62002-12-30 22:08:05 +00001596
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001597 nhooks = PyList_Size(path_hooks);
1598 if (nhooks < 0)
1599 return NULL; /* Shouldn't happen */
Just van Rossum52e14d62002-12-30 22:08:05 +00001600
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001601 importer = PyDict_GetItem(path_importer_cache, p);
1602 if (importer != NULL)
1603 return importer;
Just van Rossum52e14d62002-12-30 22:08:05 +00001604
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001605 /* set path_importer_cache[p] to None to avoid recursion */
1606 if (PyDict_SetItem(path_importer_cache, p, Py_None) != 0)
1607 return NULL;
Just van Rossum52e14d62002-12-30 22:08:05 +00001608
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001609 for (j = 0; j < nhooks; j++) {
1610 PyObject *hook = PyList_GetItem(path_hooks, j);
1611 if (hook == NULL)
1612 return NULL;
1613 importer = PyObject_CallFunctionObjArgs(hook, p, NULL);
1614 if (importer != NULL)
1615 break;
Just van Rossum52e14d62002-12-30 22:08:05 +00001616
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001617 if (!PyErr_ExceptionMatches(PyExc_ImportError)) {
1618 return NULL;
1619 }
1620 PyErr_Clear();
1621 }
1622 if (importer == NULL) {
1623 importer = PyObject_CallFunctionObjArgs(
1624 (PyObject *)&PyNullImporter_Type, p, NULL
1625 );
1626 if (importer == NULL) {
1627 if (PyErr_ExceptionMatches(PyExc_ImportError)) {
1628 PyErr_Clear();
1629 return Py_None;
1630 }
1631 }
1632 }
1633 if (importer != NULL) {
1634 int err = PyDict_SetItem(path_importer_cache, p, importer);
1635 Py_DECREF(importer);
1636 if (err != 0)
1637 return NULL;
1638 }
1639 return importer;
Just van Rossum52e14d62002-12-30 22:08:05 +00001640}
1641
Christian Heimes9cd17752007-11-18 19:35:23 +00001642PyAPI_FUNC(PyObject *)
1643PyImport_GetImporter(PyObject *path) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001644 PyObject *importer=NULL, *path_importer_cache=NULL, *path_hooks=NULL;
Christian Heimes9cd17752007-11-18 19:35:23 +00001645
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001646 if ((path_importer_cache = PySys_GetObject("path_importer_cache"))) {
1647 if ((path_hooks = PySys_GetObject("path_hooks"))) {
1648 importer = get_path_importer(path_importer_cache,
1649 path_hooks, path);
1650 }
1651 }
1652 Py_XINCREF(importer); /* get_path_importer returns a borrowed reference */
1653 return importer;
Christian Heimes9cd17752007-11-18 19:35:23 +00001654}
1655
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001656/* Search the path (default sys.path) for a module. Return the
1657 corresponding filedescr struct, and (via return arguments) the
1658 pathname and an open file. Return NULL if the module is not found. */
1659
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001660#ifdef MS_COREDLL
Victor Stinner4d6c1c42011-03-08 23:49:04 +01001661extern FILE *_PyWin_FindRegisteredModule(PyObject *, struct filedescr **,
1662 PyObject **p_path);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001663#endif
1664
Victor Stinner547a2a62011-03-20 03:07:28 +01001665/* Forward */
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001666static int case_ok(PyObject *, Py_ssize_t, PyObject *);
Victor Stinner547a2a62011-03-20 03:07:28 +01001667static int find_init_module(PyObject *);
Just van Rossum52e14d62002-12-30 22:08:05 +00001668static struct filedescr importhookdescr = {"", "", IMP_HOOK};
Guido van Rossum197346f1997-10-31 18:38:52 +00001669
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001670/* Get the path of a module: get its importer and call importer.find_module()
1671 hook, or check if the module if a package (if path/__init__.py exists).
1672
1673 -1: error: a Python error occurred
1674 0: ignore: an error occurred because of invalid data, but the error is not
1675 important enough to be reported.
1676 1: get path: module not found, but *buf contains its path
1677 2: found: *p_fd is the file descriptor (IMP_HOOK or PKG_DIRECTORY)
1678 and *buf is the path */
1679
1680static int
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001681find_module_path(PyObject *fullname, PyObject *name, PyObject *path,
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001682 PyObject *path_hooks, PyObject *path_importer_cache,
Victor Stinner2fd76e42011-03-14 15:19:39 -04001683 PyObject **p_path, PyObject **p_loader, struct filedescr **p_fd)
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001684{
Victor Stinner2fd76e42011-03-14 15:19:39 -04001685 Py_UNICODE buf[MAXPATHLEN+1];
1686 Py_ssize_t buflen = MAXPATHLEN+1;
1687 PyObject *path_unicode, *filename;
1688 const Py_UNICODE *base;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001689 Py_ssize_t len;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001690 struct stat statbuf;
1691 static struct filedescr fd_package = {"", "", PKG_DIRECTORY};
1692
1693 if (PyUnicode_Check(path)) {
Victor Stinner2fd76e42011-03-14 15:19:39 -04001694 Py_INCREF(path);
1695 path_unicode = path;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001696 }
1697 else if (PyBytes_Check(path)) {
Victor Stinner2fd76e42011-03-14 15:19:39 -04001698 path_unicode = PyUnicode_DecodeFSDefaultAndSize(
1699 PyBytes_AS_STRING(path), PyBytes_GET_SIZE(path));
1700 if (path_unicode == NULL)
1701 return -1;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001702 }
1703 else
1704 return 0;
1705
Victor Stinner2fd76e42011-03-14 15:19:39 -04001706 base = PyUnicode_AS_UNICODE(path_unicode);
1707 len = PyUnicode_GET_SIZE(path_unicode);
1708 if (len + 2 + PyUnicode_GET_SIZE(name) + MAXSUFFIXSIZE >= buflen) {
1709 Py_DECREF(path_unicode);
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001710 return 0; /* Too long */
1711 }
Victor Stinner2fd76e42011-03-14 15:19:39 -04001712 Py_UNICODE_strcpy(buf, PyUnicode_AS_UNICODE(path_unicode));
1713 Py_DECREF(path_unicode);
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001714
Victor Stinner2fd76e42011-03-14 15:19:39 -04001715 if (Py_UNICODE_strlen(buf) != len)
1716 return 0; /* path contains '\0' */
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001717
1718 /* sys.path_hooks import hook */
1719 if (p_loader != NULL) {
1720 PyObject *importer;
1721
1722 importer = get_path_importer(path_importer_cache,
1723 path_hooks, path);
1724 if (importer == NULL) {
1725 return -1;
1726 }
1727 /* Note: importer is a borrowed reference */
1728 if (importer != Py_None) {
1729 PyObject *loader;
1730 loader = PyObject_CallMethod(importer,
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001731 "find_module", "O", fullname);
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001732 if (loader == NULL)
1733 return -1; /* error */
1734 if (loader != Py_None) {
1735 /* a loader was found */
1736 *p_loader = loader;
1737 *p_fd = &importhookdescr;
1738 return 2;
1739 }
1740 Py_DECREF(loader);
1741 return 0;
1742 }
1743 }
1744 /* no hook was found, use builtin import */
1745
1746 if (len > 0 && buf[len-1] != SEP
1747#ifdef ALTSEP
1748 && buf[len-1] != ALTSEP
1749#endif
1750 )
1751 buf[len++] = SEP;
Victor Stinner2fd76e42011-03-14 15:19:39 -04001752 Py_UNICODE_strcpy(buf+len, PyUnicode_AS_UNICODE(name));
1753 len += PyUnicode_GET_SIZE(name);
1754
1755 filename = PyUnicode_FromUnicode(buf, len);
1756 if (filename == NULL)
1757 return -1;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001758
1759 /* Check for package import (buf holds a directory name,
1760 and there's an __init__ module in that directory */
1761#ifdef HAVE_STAT
Victor Stinner2fd76e42011-03-14 15:19:39 -04001762 if (_Py_stat(filename, &statbuf) == 0 && /* it exists */
Victor Stinnerd0296212011-03-14 14:04:10 -04001763 S_ISDIR(statbuf.st_mode)) /* it's a directory */
1764 {
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001765 int match;
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001766
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001767 match = case_ok(filename, 0, name);
1768 if (match < 0) {
1769 Py_DECREF(filename);
1770 return -1;
1771 }
1772 if (match) { /* case matches */
1773 if (find_init_module(filename)) { /* and has __init__.py */
Victor Stinner2fd76e42011-03-14 15:19:39 -04001774 *p_path = filename;
Victor Stinnerd0296212011-03-14 14:04:10 -04001775 *p_fd = &fd_package;
1776 return 2;
1777 }
1778 else {
1779 int err;
Victor Stinnerd0296212011-03-14 14:04:10 -04001780 err = PyErr_WarnFormat(PyExc_ImportWarning, 1,
Victor Stinner547a2a62011-03-20 03:07:28 +01001781 "Not importing directory %R: missing __init__.py",
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001782 filename);
Victor Stinner547a2a62011-03-20 03:07:28 +01001783 if (err) {
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001784 Py_DECREF(filename);
Victor Stinnerd0296212011-03-14 14:04:10 -04001785 return -1;
Victor Stinner547a2a62011-03-20 03:07:28 +01001786 }
Victor Stinnerd0296212011-03-14 14:04:10 -04001787 }
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001788 }
1789 }
1790#endif
Victor Stinner2fd76e42011-03-14 15:19:39 -04001791 *p_path = filename;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001792 return 1;
1793}
1794
1795/* Find a module in search_path_list. For each path, try
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001796 find_module_path() or try each _PyImport_Filetab suffix.
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001797
1798 If the module is found, return a file descriptor, write the path in
1799 *p_filename, write the pointer to the file object into *p_fp, and (if
1800 p_loader is not NULL) the loader into *p_loader.
1801
1802 Otherwise, raise an exception and return NULL. */
1803
Victor Stinner37580282011-03-20 01:34:43 +01001804static struct filedescr*
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001805find_module_path_list(PyObject *fullname, PyObject *name,
Victor Stinner37580282011-03-20 01:34:43 +01001806 PyObject *search_path_list, PyObject *path_hooks,
1807 PyObject *path_importer_cache,
Victor Stinner2fd76e42011-03-14 15:19:39 -04001808 PyObject **p_path, FILE **p_fp, PyObject **p_loader)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001809{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001810 Py_ssize_t i, npath;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001811 struct filedescr *fdp = NULL;
1812 char *filemode;
1813 FILE *fp = NULL;
Victor Stinner2fd76e42011-03-14 15:19:39 -04001814 PyObject *prefix, *filename;
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001815 int match;
Victor Stinner53dc7352011-03-20 01:50:21 +01001816
Victor Stinner37580282011-03-20 01:34:43 +01001817 npath = PyList_Size(search_path_list);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001818 for (i = 0; i < npath; i++) {
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001819 PyObject *path;
1820 int ok;
1821
1822 path = PyList_GetItem(search_path_list, i);
1823 if (path == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001824 return NULL;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001825
Victor Stinner2fd76e42011-03-14 15:19:39 -04001826 prefix = NULL;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001827 ok = find_module_path(fullname, name, path,
1828 path_hooks, path_importer_cache,
Victor Stinner2fd76e42011-03-14 15:19:39 -04001829 &prefix, p_loader, &fdp);
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001830 if (ok < 0)
1831 return NULL;
1832 if (ok == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001833 continue;
Victor Stinner2fd76e42011-03-14 15:19:39 -04001834 if (ok == 2) {
1835 *p_path = prefix;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001836 return fdp;
Victor Stinner2fd76e42011-03-14 15:19:39 -04001837 }
Amaury Forgeot d'Arcf1ca0b12008-06-11 17:40:47 +00001838
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001839 for (fdp = _PyImport_Filetab; fdp->suffix != NULL; fdp++) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001840 filemode = fdp->mode;
1841 if (filemode[0] == 'U')
1842 filemode = "r" PY_STDIOTEXTMODE;
Victor Stinnerd0296212011-03-14 14:04:10 -04001843
Victor Stinner2fd76e42011-03-14 15:19:39 -04001844 filename = PyUnicode_FromFormat("%U%s", prefix, fdp->suffix);
1845 if (filename == NULL) {
1846 Py_DECREF(prefix);
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001847 return NULL;
Victor Stinner2fd76e42011-03-14 15:19:39 -04001848 }
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001849
1850 if (Py_VerboseFlag > 1)
1851 PySys_FormatStderr("# trying %R\n", filename);
1852
1853 fp = _Py_fopen(filename, filemode);
1854 if (fp == NULL) {
1855 Py_DECREF(filename);
1856 continue;
1857 }
1858 match = case_ok(filename, -(Py_ssize_t)strlen(fdp->suffix), name);
1859 if (match < 0) {
Victor Stinner2fd76e42011-03-14 15:19:39 -04001860 Py_DECREF(prefix);
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001861 Py_DECREF(filename);
1862 return NULL;
1863 }
1864 if (match) {
Victor Stinner2fd76e42011-03-14 15:19:39 -04001865 Py_DECREF(prefix);
1866 *p_path = filename;
Victor Stinnerd0296212011-03-14 14:04:10 -04001867 *p_fp = fp;
1868 return fdp;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001869 }
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001870 Py_DECREF(filename);
Victor Stinnerd0296212011-03-14 14:04:10 -04001871
1872 fclose(fp);
1873 fp = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001874 }
Victor Stinner2fd76e42011-03-14 15:19:39 -04001875 Py_DECREF(prefix);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001876 }
Victor Stinnerd0296212011-03-14 14:04:10 -04001877 PyErr_Format(PyExc_ImportError,
Victor Stinner98dbba52011-03-14 15:15:47 -04001878 "No module named %R", name);
Victor Stinnerd0296212011-03-14 14:04:10 -04001879 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001880}
1881
Victor Stinner37580282011-03-20 01:34:43 +01001882/* Find a module:
1883
1884 - try find_module() of each sys.meta_path hook
1885 - try find_frozen()
1886 - try is_builtin()
1887 - try _PyWin_FindRegisteredModule() (Windows only)
1888 - otherwise, call find_module_path_list() with search_path_list (if not
1889 NULL) or sys.path
1890
Victor Stinner2fd76e42011-03-14 15:19:39 -04001891 fullname can be NULL, but only if p_loader is NULL.
1892
Victor Stinner37580282011-03-20 01:34:43 +01001893 Return:
1894
1895 - &fd_builtin (C_BUILTIN) if it is a builtin
1896 - &fd_frozen (PY_FROZEN) if it is frozen
Victor Stinner2fd76e42011-03-14 15:19:39 -04001897 - &fd_package (PKG_DIRECTORY) and write the filename into *p_path
Victor Stinner37580282011-03-20 01:34:43 +01001898 if it is a package
1899 - &importhookdescr (IMP_HOOK) and write the loader into *p_loader if a
1900 importer loader was found
1901 - a file descriptor (PY_SOURCE, PY_COMPILED, C_EXTENSION, PY_RESOURCE or
1902 PY_CODERESOURCE: see _PyImport_Filetab), write the filename into
Victor Stinner2fd76e42011-03-14 15:19:39 -04001903 *p_path and the pointer to the open file into *p_fp
Victor Stinner37580282011-03-20 01:34:43 +01001904 - NULL on error
1905
Victor Stinner2fd76e42011-03-14 15:19:39 -04001906 By default, *p_path, *p_fp and *p_loader (if set) are set to NULL.
1907 Eg. *p_path is set to NULL for a builtin package.
1908*/
Victor Stinner37580282011-03-20 01:34:43 +01001909
1910static struct filedescr *
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001911find_module(PyObject *fullname, PyObject *name, PyObject *search_path_list,
Victor Stinner2fd76e42011-03-14 15:19:39 -04001912 PyObject **p_path, FILE **p_fp, PyObject **p_loader)
Victor Stinner37580282011-03-20 01:34:43 +01001913{
1914 Py_ssize_t i, npath;
1915 static struct filedescr fd_frozen = {"", "", PY_FROZEN};
1916 static struct filedescr fd_builtin = {"", "", C_BUILTIN};
1917 PyObject *path_hooks, *path_importer_cache;
Victor Stinner37580282011-03-20 01:34:43 +01001918
Victor Stinner2fd76e42011-03-14 15:19:39 -04001919 *p_path = NULL;
Victor Stinner37580282011-03-20 01:34:43 +01001920 *p_fp = NULL;
1921 if (p_loader != NULL)
1922 *p_loader = NULL;
1923
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001924 if (PyUnicode_GET_SIZE(name) > MAXPATHLEN) {
Victor Stinner37580282011-03-20 01:34:43 +01001925 PyErr_SetString(PyExc_OverflowError,
1926 "module name is too long");
1927 return NULL;
1928 }
1929
1930 /* sys.meta_path import hook */
1931 if (p_loader != NULL) {
1932 PyObject *meta_path;
1933
1934 meta_path = PySys_GetObject("meta_path");
1935 if (meta_path == NULL || !PyList_Check(meta_path)) {
1936 PyErr_SetString(PyExc_ImportError,
1937 "sys.meta_path must be a list of "
1938 "import hooks");
1939 return NULL;
1940 }
1941 Py_INCREF(meta_path); /* zap guard */
1942 npath = PyList_Size(meta_path);
1943 for (i = 0; i < npath; i++) {
1944 PyObject *loader;
1945 PyObject *hook = PyList_GetItem(meta_path, i);
1946 loader = PyObject_CallMethod(hook, "find_module",
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001947 "OO", fullname,
Victor Stinner37580282011-03-20 01:34:43 +01001948 search_path_list != NULL ?
1949 search_path_list : Py_None);
1950 if (loader == NULL) {
1951 Py_DECREF(meta_path);
1952 return NULL; /* true error */
1953 }
1954 if (loader != Py_None) {
1955 /* a loader was found */
1956 *p_loader = loader;
1957 Py_DECREF(meta_path);
1958 return &importhookdescr;
1959 }
1960 Py_DECREF(loader);
1961 }
1962 Py_DECREF(meta_path);
1963 }
1964
Victor Stinnerdf75a022011-03-14 13:40:04 -04001965 if (find_frozen(fullname) != NULL)
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001966 return &fd_frozen;
Victor Stinner37580282011-03-20 01:34:43 +01001967
1968 if (search_path_list == NULL) {
1969#ifdef MS_COREDLL
1970 FILE *fp;
1971 struct filedescr *fdp;
Victor Stinner37580282011-03-20 01:34:43 +01001972#endif
Victor Stinnerdf75a022011-03-14 13:40:04 -04001973 if (is_builtin(name))
Victor Stinner37580282011-03-20 01:34:43 +01001974 return &fd_builtin;
Victor Stinner37580282011-03-20 01:34:43 +01001975#ifdef MS_COREDLL
Victor Stinner2fd76e42011-03-14 15:19:39 -04001976 fp = _PyWin_FindRegisteredModule(name, &fdp, p_path);
Victor Stinner37580282011-03-20 01:34:43 +01001977 if (fp != NULL) {
Victor Stinner37580282011-03-20 01:34:43 +01001978 *p_fp = fp;
1979 return fdp;
1980 }
1981 else if (PyErr_Occurred())
1982 return NULL;
1983#endif
Victor Stinner37580282011-03-20 01:34:43 +01001984 search_path_list = PySys_GetObject("path");
1985 }
1986
1987 if (search_path_list == NULL || !PyList_Check(search_path_list)) {
1988 PyErr_SetString(PyExc_ImportError,
1989 "sys.path must be a list of directory names");
1990 return NULL;
1991 }
1992
1993 path_hooks = PySys_GetObject("path_hooks");
1994 if (path_hooks == NULL || !PyList_Check(path_hooks)) {
1995 PyErr_SetString(PyExc_ImportError,
1996 "sys.path_hooks must be a list of "
1997 "import hooks");
1998 return NULL;
1999 }
2000 path_importer_cache = PySys_GetObject("path_importer_cache");
2001 if (path_importer_cache == NULL ||
2002 !PyDict_Check(path_importer_cache)) {
2003 PyErr_SetString(PyExc_ImportError,
2004 "sys.path_importer_cache must be a dict");
2005 return NULL;
2006 }
2007
2008 return find_module_path_list(fullname, name,
2009 search_path_list, path_hooks,
2010 path_importer_cache,
Victor Stinner2fd76e42011-03-14 15:19:39 -04002011 p_path, p_fp, p_loader);
Victor Stinner37580282011-03-20 01:34:43 +01002012}
2013
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002014/* case_bytes(char* buf, Py_ssize_t len, Py_ssize_t namelen, char* name)
Tim Petersd1e87a82001-03-01 18:12:00 +00002015 * The arguments here are tricky, best shown by example:
2016 * /a/b/c/d/e/f/g/h/i/j/k/some_long_module_name.py\0
2017 * ^ ^ ^ ^
2018 * |--------------------- buf ---------------------|
2019 * |------------------- len ------------------|
2020 * |------ name -------|
2021 * |----- namelen -----|
2022 * buf is the full path, but len only counts up to (& exclusive of) the
2023 * extension. name is the module name, also exclusive of extension.
2024 *
2025 * We've already done a successful stat() or fopen() on buf, so know that
2026 * there's some match, possibly case-insensitive.
2027 *
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002028 * case_bytes() is to return 1 if there's a case-sensitive match for
2029 * name, else 0. case_bytes() is also to return 1 if envar PYTHONCASEOK
Tim Peters50d8d372001-02-28 05:34:27 +00002030 * exists.
Tim Petersd1e87a82001-03-01 18:12:00 +00002031 *
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002032 * case_bytes() is used to implement case-sensitive import semantics even
Tim Peters50d8d372001-02-28 05:34:27 +00002033 * on platforms with case-insensitive filesystems. It's trivial to implement
2034 * for case-sensitive filesystems. It's pretty much a cross-platform
2035 * nightmare for systems with case-insensitive filesystems.
2036 */
Guido van Rossum0980bd91998-02-13 17:18:36 +00002037
Tim Peters50d8d372001-02-28 05:34:27 +00002038/* First we may need a pile of platform-specific header files; the sequence
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002039 * of #if's here should match the sequence in the body of case_bytes().
Tim Peters50d8d372001-02-28 05:34:27 +00002040 */
Jason Tishler7961aa62005-05-20 00:56:54 +00002041#if defined(MS_WINDOWS)
Guido van Rossum0980bd91998-02-13 17:18:36 +00002042#include <windows.h>
Guido van Rossum4c3f57c2001-01-10 20:40:46 +00002043
Tim Peters50d8d372001-02-28 05:34:27 +00002044#elif defined(DJGPP)
2045#include <dir.h>
2046
Jason Tishler7961aa62005-05-20 00:56:54 +00002047#elif (defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) && defined(HAVE_DIRENT_H)
Tim Peters430f5d42001-03-01 01:30:56 +00002048#include <sys/types.h>
2049#include <dirent.h>
2050
Andrew MacIntyred9400542002-02-26 11:41:34 +00002051#elif defined(PYOS_OS2)
2052#define INCL_DOS
2053#define INCL_DOSERRORS
2054#define INCL_NOPMAPI
2055#include <os2.h>
Tim Peters50d8d372001-02-28 05:34:27 +00002056#endif
2057
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002058#if defined(DJGPP) \
2059 || ((defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) \
2060 && defined(HAVE_DIRENT_H)) \
2061 || defined(PYOS_OS2)
2062# define USE_CASE_OK_BYTES
2063#endif
2064
2065
2066#ifdef USE_CASE_OK_BYTES
Guido van Rossum0980bd91998-02-13 17:18:36 +00002067static int
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002068case_bytes(char *buf, Py_ssize_t len, Py_ssize_t namelen, const char *name)
Guido van Rossum0980bd91998-02-13 17:18:36 +00002069{
Tim Peters50d8d372001-02-28 05:34:27 +00002070/* Pick a platform-specific implementation; the sequence of #if's here should
2071 * match the sequence just above.
2072 */
2073
Tim Peters50d8d372001-02-28 05:34:27 +00002074/* DJGPP */
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002075#if defined(DJGPP)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002076 struct ffblk ffblk;
2077 int done;
Tim Peters50d8d372001-02-28 05:34:27 +00002078
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002079 if (Py_GETENV("PYTHONCASEOK") != NULL)
2080 return 1;
Tim Peters50d8d372001-02-28 05:34:27 +00002081
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002082 done = findfirst(buf, &ffblk, FA_ARCH|FA_RDONLY|FA_HIDDEN|FA_DIREC);
2083 if (done) {
2084 PyErr_Format(PyExc_NameError,
2085 "Can't find file for module %.100s\n(filename %.300s)",
2086 name, buf);
2087 return 0;
2088 }
2089 return strncmp(ffblk.ff_name, name, namelen) == 0;
Guido van Rossum0980bd91998-02-13 17:18:36 +00002090
Jason Tishler7961aa62005-05-20 00:56:54 +00002091/* new-fangled macintosh (macosx) or Cygwin */
2092#elif (defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) && defined(HAVE_DIRENT_H)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002093 DIR *dirp;
2094 struct dirent *dp;
2095 char dirname[MAXPATHLEN + 1];
2096 const int dirlen = len - namelen - 1; /* don't want trailing SEP */
Tim Peters430f5d42001-03-01 01:30:56 +00002097
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002098 if (Py_GETENV("PYTHONCASEOK") != NULL)
2099 return 1;
Tim Petersdbe6ebb2001-03-01 08:47:29 +00002100
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002101 /* Copy the dir component into dirname; substitute "." if empty */
2102 if (dirlen <= 0) {
2103 dirname[0] = '.';
2104 dirname[1] = '\0';
2105 }
2106 else {
2107 assert(dirlen <= MAXPATHLEN);
2108 memcpy(dirname, buf, dirlen);
2109 dirname[dirlen] = '\0';
2110 }
2111 /* Open the directory and search the entries for an exact match. */
2112 dirp = opendir(dirname);
2113 if (dirp) {
2114 char *nameWithExt = buf + len - namelen;
2115 while ((dp = readdir(dirp)) != NULL) {
2116 const int thislen =
Tim Peters430f5d42001-03-01 01:30:56 +00002117#ifdef _DIRENT_HAVE_D_NAMELEN
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002118 dp->d_namlen;
Tim Peters430f5d42001-03-01 01:30:56 +00002119#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002120 strlen(dp->d_name);
Tim Peters430f5d42001-03-01 01:30:56 +00002121#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002122 if (thislen >= namelen &&
2123 strcmp(dp->d_name, nameWithExt) == 0) {
2124 (void)closedir(dirp);
2125 return 1; /* Found */
2126 }
2127 }
2128 (void)closedir(dirp);
2129 }
2130 return 0 ; /* Not found */
Tim Peters430f5d42001-03-01 01:30:56 +00002131
Andrew MacIntyred9400542002-02-26 11:41:34 +00002132/* OS/2 */
2133#elif defined(PYOS_OS2)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002134 HDIR hdir = 1;
2135 ULONG srchcnt = 1;
2136 FILEFINDBUF3 ffbuf;
2137 APIRET rc;
Andrew MacIntyred9400542002-02-26 11:41:34 +00002138
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002139 if (Py_GETENV("PYTHONCASEOK") != NULL)
2140 return 1;
Andrew MacIntyred9400542002-02-26 11:41:34 +00002141
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002142 rc = DosFindFirst(buf,
2143 &hdir,
2144 FILE_READONLY | FILE_HIDDEN | FILE_SYSTEM | FILE_DIRECTORY,
2145 &ffbuf, sizeof(ffbuf),
2146 &srchcnt,
2147 FIL_STANDARD);
2148 if (rc != NO_ERROR)
2149 return 0;
2150 return strncmp(ffbuf.achName, name, namelen) == 0;
Andrew MacIntyred9400542002-02-26 11:41:34 +00002151
Tim Peters50d8d372001-02-28 05:34:27 +00002152/* assuming it's a case-sensitive filesystem, so there's nothing to do! */
2153#else
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002154# error "USE_CASE_OK_BYTES is not correctly defined"
2155#endif
2156}
2157#endif
2158
2159/*
2160 * Check if a filename case matchs the name case. We've already done a
2161 * successful stat() or fopen() on buf, so know that there's some match,
2162 * possibly case-insensitive.
2163 *
2164 * case_ok() is to return 1 if there's a case-sensitive match for name, 0 if it
2165 * the filename doesn't match, or -1 on error. case_ok() is also to return 1
2166 * if envar PYTHONCASEOK exists.
2167 *
2168 * case_ok() is used to implement case-sensitive import semantics even
2169 * on platforms with case-insensitive filesystems. It's trivial to implement
2170 * for case-sensitive filesystems. It's pretty much a cross-platform
2171 * nightmare for systems with case-insensitive filesystems.
2172 */
2173
2174static int
2175case_ok(PyObject *filename, Py_ssize_t prefix_delta, PyObject *name)
2176{
2177#ifdef MS_WINDOWS
2178 WIN32_FIND_DATAW data;
2179 HANDLE h;
2180 int cmp;
2181
2182 if (Py_GETENV("PYTHONCASEOK") != NULL)
2183 return 1;
2184
2185 h = FindFirstFileW(PyUnicode_AS_UNICODE(filename), &data);
2186 if (h == INVALID_HANDLE_VALUE) {
2187 PyErr_Format(PyExc_NameError,
2188 "Can't find file for module %R\n(filename %R)",
2189 name, filename);
2190 return 0;
2191 }
2192 FindClose(h);
2193 cmp = wcsncmp(data.cFileName,
2194 PyUnicode_AS_UNICODE(name),
2195 PyUnicode_GET_SIZE(name));
2196 return cmp == 0;
2197#elif defined(USE_CASE_OK_BYTES)
2198 int match;
2199 PyObject *filebytes, *namebytes;
2200 filebytes = PyUnicode_EncodeFSDefault(filename);
2201 if (filebytes == NULL)
2202 return -1;
2203 namebytes = PyUnicode_EncodeFSDefault(name);
2204 if (namebytes == NULL) {
2205 Py_DECREF(filebytes);
2206 return -1;
2207 }
2208 match = case_bytes(
2209 PyBytes_AS_STRING(filebytes),
2210 PyBytes_GET_SIZE(filebytes) + prefix_delta,
Victor Stinner1304f2d2011-03-20 04:28:55 +01002211 PyBytes_GET_SIZE(namebytes),
2212 PyBytes_AS_STRING(namebytes));
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002213 Py_DECREF(filebytes);
2214 Py_DECREF(namebytes);
2215 return match;
2216#else
2217 /* assuming it's a case-sensitive filesystem, so there's nothing to do! */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002218 return 1;
Guido van Rossum0980bd91998-02-13 17:18:36 +00002219
Guido van Rossum4d1b3b91998-02-13 23:27:59 +00002220#endif
Tim Peters50d8d372001-02-28 05:34:27 +00002221}
Guido van Rossum4d1b3b91998-02-13 23:27:59 +00002222
Guido van Rossum197346f1997-10-31 18:38:52 +00002223#ifdef HAVE_STAT
Victor Stinner4f4402c2010-08-14 14:50:26 +00002224
Victor Stinner547a2a62011-03-20 03:07:28 +01002225/* Helper to look for __init__.py or __init__.py[co] in potential package.
2226 Return 1 if __init__ was found, 0 if not, or -1 on error. */
Guido van Rossum197346f1997-10-31 18:38:52 +00002227static int
Victor Stinner547a2a62011-03-20 03:07:28 +01002228find_init_module(PyObject *directory)
Guido van Rossum197346f1997-10-31 18:38:52 +00002229{
Victor Stinner547a2a62011-03-20 03:07:28 +01002230 size_t len;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002231 struct stat statbuf;
Victor Stinner547a2a62011-03-20 03:07:28 +01002232 PyObject *filename;
2233 int match;
Guido van Rossum197346f1997-10-31 18:38:52 +00002234
Victor Stinner547a2a62011-03-20 03:07:28 +01002235 len = PyUnicode_GET_SIZE(directory);
2236 filename = PyUnicode_FromFormat("%U%c__init__.py", directory, SEP);
2237 if (filename == NULL)
2238 return -1;
2239 if (_Py_stat(filename, &statbuf) == 0) {
Victor Stinnercc9564e2011-03-20 04:58:29 +01002240 /* 3=len(".py") */
2241 match = case_ok(filename, -3, initstr);
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002242 if (match < 0) {
2243 Py_DECREF(filename);
2244 return -1;
2245 }
2246 if (match) {
Victor Stinner547a2a62011-03-20 03:07:28 +01002247 Py_DECREF(filename);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002248 return 1;
2249 }
2250 }
Victor Stinner547a2a62011-03-20 03:07:28 +01002251 Py_DECREF(filename);
2252
2253 filename = PyUnicode_FromFormat("%U%c__init__.py%c",
2254 directory, SEP, Py_OptimizeFlag ? 'o' : 'c');
2255 if (filename == NULL)
2256 return -1;
2257 if (_Py_stat(filename, &statbuf) == 0) {
Victor Stinnercc9564e2011-03-20 04:58:29 +01002258 /* 4=len(".pyc") */
2259 match = case_ok(filename, -4, initstr);
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002260 if (match < 0) {
2261 Py_DECREF(filename);
2262 return -1;
2263 }
2264 if (match) {
Victor Stinner547a2a62011-03-20 03:07:28 +01002265 Py_DECREF(filename);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002266 return 1;
2267 }
2268 }
Victor Stinner547a2a62011-03-20 03:07:28 +01002269 Py_DECREF(filename);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002270 return 0;
Guido van Rossum197346f1997-10-31 18:38:52 +00002271}
Guido van Rossum48a680c2001-03-02 06:34:14 +00002272
Guido van Rossum197346f1997-10-31 18:38:52 +00002273#endif /* HAVE_STAT */
2274
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002275
Victor Stinner95872862011-03-07 18:20:56 +01002276static int init_builtin(PyObject *); /* Forward */
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002277
Victor Stinner44c6c152010-08-09 00:59:10 +00002278static PyObject*
Victor Stinner95872862011-03-07 18:20:56 +01002279load_builtin(PyObject *name, int type)
Victor Stinner44c6c152010-08-09 00:59:10 +00002280{
2281 PyObject *m, *modules;
2282 int err;
2283
Victor Stinner44c6c152010-08-09 00:59:10 +00002284 if (type == C_BUILTIN)
2285 err = init_builtin(name);
2286 else
Victor Stinner95872862011-03-07 18:20:56 +01002287 err = PyImport_ImportFrozenModuleObject(name);
Victor Stinner44c6c152010-08-09 00:59:10 +00002288 if (err < 0)
2289 return NULL;
2290 if (err == 0) {
2291 PyErr_Format(PyExc_ImportError,
Victor Stinner95872862011-03-07 18:20:56 +01002292 "Purported %s module %R not found",
2293 type == C_BUILTIN ? "builtin" : "frozen",
Victor Stinner44c6c152010-08-09 00:59:10 +00002294 name);
2295 return NULL;
2296 }
2297
2298 modules = PyImport_GetModuleDict();
Victor Stinner95872862011-03-07 18:20:56 +01002299 m = PyDict_GetItem(modules, name);
Victor Stinner44c6c152010-08-09 00:59:10 +00002300 if (m == NULL) {
2301 PyErr_Format(
2302 PyExc_ImportError,
Victor Stinner95872862011-03-07 18:20:56 +01002303 "%s module %R not properly initialized",
2304 type == C_BUILTIN ? "builtin" : "frozen",
Victor Stinner44c6c152010-08-09 00:59:10 +00002305 name);
2306 return NULL;
2307 }
2308 Py_INCREF(m);
2309 return m;
2310}
2311
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002312/* Load an external module using the default search path and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00002313 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002314
Guido van Rossum79f25d91997-04-29 20:08:16 +00002315static PyObject *
Victor Stinner41c5fec2011-03-13 21:46:30 -04002316load_module(PyObject *name, FILE *fp, PyObject *pathname, int type, PyObject *loader)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002317{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002318 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002319
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002320 /* First check that there's an open file (if we need one) */
2321 switch (type) {
2322 case PY_SOURCE:
2323 case PY_COMPILED:
2324 if (fp == NULL) {
2325 PyErr_Format(PyExc_ValueError,
Victor Stinner41c5fec2011-03-13 21:46:30 -04002326 "file object required for import (type code %d)",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002327 type);
2328 return NULL;
2329 }
2330 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002331
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002332 switch (type) {
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002333
Victor Stinner41c5fec2011-03-13 21:46:30 -04002334 case PY_SOURCE:
2335 m = load_source_module(name, pathname, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002336 break;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002337
Victor Stinner41c5fec2011-03-13 21:46:30 -04002338 case PY_COMPILED:
2339 m = load_compiled_module(name, pathname, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002340 break;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002341
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002342#ifdef HAVE_DYNAMIC_LOADING
Victor Stinner41c5fec2011-03-13 21:46:30 -04002343 case C_EXTENSION:
2344 m = _PyImport_LoadDynamicModule(name, pathname, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002345 break;
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002346#endif
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002347
Victor Stinner41c5fec2011-03-13 21:46:30 -04002348 case PKG_DIRECTORY:
2349 m = load_package(name, pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002350 break;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002351
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002352 case C_BUILTIN:
Victor Stinner41c5fec2011-03-13 21:46:30 -04002353 case PY_FROZEN:
2354 m = load_builtin(name, type);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002355 break;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002356
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002357 case IMP_HOOK: {
2358 if (loader == NULL) {
2359 PyErr_SetString(PyExc_ImportError,
2360 "import hook without loader");
2361 return NULL;
2362 }
Victor Stinner41c5fec2011-03-13 21:46:30 -04002363 m = PyObject_CallMethod(loader, "load_module", "O", name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002364 break;
2365 }
Just van Rossum52e14d62002-12-30 22:08:05 +00002366
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002367 default:
2368 PyErr_Format(PyExc_ImportError,
Victor Stinner98dbba52011-03-14 15:15:47 -04002369 "Don't know how to import %R (type code %d)",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002370 name, type);
2371 m = NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002372
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002373 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002374
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002375 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002376}
2377
2378
2379/* Initialize a built-in module.
Thomas Wouters89f507f2006-12-13 04:49:30 +00002380 Return 1 for success, 0 if the module is not found, and -1 with
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002381 an exception set if the initialization failed. */
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002382
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002383static int
Victor Stinner95872862011-03-07 18:20:56 +01002384init_builtin(PyObject *name)
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002385{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002386 struct _inittab *p;
Guido van Rossum25ce5661997-08-02 03:10:38 +00002387
Victor Stinner95872862011-03-07 18:20:56 +01002388 if (_PyImport_FindExtensionObject(name, name) != NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002389 return 1;
Guido van Rossum25ce5661997-08-02 03:10:38 +00002390
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002391 for (p = PyImport_Inittab; p->name != NULL; p++) {
2392 PyObject *mod;
Victor Stinner95872862011-03-07 18:20:56 +01002393 if (PyUnicode_CompareWithASCIIString(name, p->name) == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002394 if (p->initfunc == NULL) {
2395 PyErr_Format(PyExc_ImportError,
Victor Stinner95872862011-03-07 18:20:56 +01002396 "Cannot re-init internal module %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002397 name);
2398 return -1;
2399 }
2400 if (Py_VerboseFlag)
Victor Stinner95872862011-03-07 18:20:56 +01002401 PySys_FormatStderr("import %U # builtin\n", name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002402 mod = (*p->initfunc)();
2403 if (mod == 0)
2404 return -1;
Victor Stinner95872862011-03-07 18:20:56 +01002405 if (_PyImport_FixupExtensionObject(mod, name, name) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002406 return -1;
2407 /* FixupExtension has put the module into sys.modules,
2408 so we can release our own reference. */
2409 Py_DECREF(mod);
2410 return 1;
2411 }
2412 }
2413 return 0;
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002414}
Guido van Rossumf56e3db1993-04-01 20:59:32 +00002415
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002416
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002417/* Frozen modules */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002418
Guido van Rossumcfd0a221996-06-17 17:06:34 +00002419static struct _frozen *
Victor Stinner53dc7352011-03-20 01:50:21 +01002420find_frozen(PyObject *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002421{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002422 struct _frozen *p;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002423
Victor Stinner53dc7352011-03-20 01:50:21 +01002424 if (name == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002425 return NULL;
Benjamin Petersond968e272008-11-05 22:48:33 +00002426
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002427 for (p = PyImport_FrozenModules; ; p++) {
2428 if (p->name == NULL)
2429 return NULL;
Victor Stinner53dc7352011-03-20 01:50:21 +01002430 if (PyUnicode_CompareWithASCIIString(name, p->name) == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002431 break;
2432 }
2433 return p;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002434}
2435
Guido van Rossum79f25d91997-04-29 20:08:16 +00002436static PyObject *
Victor Stinner53dc7352011-03-20 01:50:21 +01002437get_frozen_object(PyObject *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002438{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002439 struct _frozen *p = find_frozen(name);
2440 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002441
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002442 if (p == NULL) {
2443 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002444 "No such frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002445 name);
2446 return NULL;
2447 }
2448 if (p->code == NULL) {
2449 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002450 "Excluded frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002451 name);
2452 return NULL;
2453 }
2454 size = p->size;
2455 if (size < 0)
2456 size = -size;
2457 return PyMarshal_ReadObjectFromString((char *)p->code, size);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002458}
2459
Brett Cannon8d110132009-03-15 02:20:16 +00002460static PyObject *
Victor Stinner53dc7352011-03-20 01:50:21 +01002461is_frozen_package(PyObject *name)
Brett Cannon8d110132009-03-15 02:20:16 +00002462{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002463 struct _frozen *p = find_frozen(name);
2464 int size;
Brett Cannon8d110132009-03-15 02:20:16 +00002465
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002466 if (p == NULL) {
2467 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002468 "No such frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002469 name);
2470 return NULL;
2471 }
Brett Cannon8d110132009-03-15 02:20:16 +00002472
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002473 size = p->size;
Brett Cannon8d110132009-03-15 02:20:16 +00002474
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002475 if (size < 0)
2476 Py_RETURN_TRUE;
2477 else
2478 Py_RETURN_FALSE;
Brett Cannon8d110132009-03-15 02:20:16 +00002479}
2480
2481
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002482/* Initialize a frozen module.
Brett Cannon3c2ac442009-03-08 20:49:47 +00002483 Return 1 for success, 0 if the module is not found, and -1 with
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002484 an exception set if the initialization failed.
2485 This function is also used from frozenmain.c */
Guido van Rossum0b344901995-02-07 15:35:27 +00002486
2487int
Victor Stinner53dc7352011-03-20 01:50:21 +01002488PyImport_ImportFrozenModuleObject(PyObject *name)
Guido van Rossumf56e3db1993-04-01 20:59:32 +00002489{
Victor Stinner53dc7352011-03-20 01:50:21 +01002490 struct _frozen *p;
2491 PyObject *co, *m, *path;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002492 int ispackage;
2493 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002494
Victor Stinner53dc7352011-03-20 01:50:21 +01002495 p = find_frozen(name);
2496
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002497 if (p == NULL)
2498 return 0;
2499 if (p->code == NULL) {
2500 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002501 "Excluded frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002502 name);
2503 return -1;
2504 }
2505 size = p->size;
2506 ispackage = (size < 0);
2507 if (ispackage)
2508 size = -size;
2509 if (Py_VerboseFlag)
Victor Stinner53dc7352011-03-20 01:50:21 +01002510 PySys_FormatStderr("import %U # frozen%s\n",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002511 name, ispackage ? " package" : "");
2512 co = PyMarshal_ReadObjectFromString((char *)p->code, size);
2513 if (co == NULL)
2514 return -1;
2515 if (!PyCode_Check(co)) {
2516 PyErr_Format(PyExc_TypeError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002517 "frozen object %R is not a code object",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002518 name);
2519 goto err_return;
2520 }
2521 if (ispackage) {
2522 /* Set __path__ to the package name */
Victor Stinner53dc7352011-03-20 01:50:21 +01002523 PyObject *d, *l;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002524 int err;
Victor Stinner53dc7352011-03-20 01:50:21 +01002525 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002526 if (m == NULL)
2527 goto err_return;
2528 d = PyModule_GetDict(m);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002529 l = PyList_New(1);
2530 if (l == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002531 goto err_return;
2532 }
Victor Stinner53dc7352011-03-20 01:50:21 +01002533 Py_INCREF(name);
2534 PyList_SET_ITEM(l, 0, name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002535 err = PyDict_SetItemString(d, "__path__", l);
2536 Py_DECREF(l);
2537 if (err != 0)
2538 goto err_return;
2539 }
Victor Stinner53dc7352011-03-20 01:50:21 +01002540 path = PyUnicode_FromString("<frozen>");
2541 if (path == NULL)
2542 goto err_return;
2543 m = PyImport_ExecCodeModuleObject(name, co, path, NULL);
2544 Py_DECREF(path);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002545 if (m == NULL)
2546 goto err_return;
2547 Py_DECREF(co);
2548 Py_DECREF(m);
2549 return 1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002550err_return:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002551 Py_DECREF(co);
2552 return -1;
Guido van Rossumf56e3db1993-04-01 20:59:32 +00002553}
Guido van Rossum74e6a111994-08-29 12:54:38 +00002554
Victor Stinner53dc7352011-03-20 01:50:21 +01002555int
2556PyImport_ImportFrozenModule(char *name)
2557{
2558 PyObject *nameobj;
2559 int ret;
2560 nameobj = PyUnicode_InternFromString(name);
2561 if (nameobj == NULL)
2562 return -1;
2563 ret = PyImport_ImportFrozenModuleObject(nameobj);
2564 Py_DECREF(nameobj);
2565 return ret;
2566}
2567
Guido van Rossum74e6a111994-08-29 12:54:38 +00002568
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002569/* Import a module, either built-in, frozen, or external, and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00002570 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum74e6a111994-08-29 12:54:38 +00002571
Guido van Rossum79f25d91997-04-29 20:08:16 +00002572PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00002573PyImport_ImportModule(const char *name)
Guido van Rossum74e6a111994-08-29 12:54:38 +00002574{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002575 PyObject *pname;
2576 PyObject *result;
Marc-André Lemburg3c61c352001-02-09 19:40:15 +00002577
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002578 pname = PyUnicode_FromString(name);
2579 if (pname == NULL)
2580 return NULL;
2581 result = PyImport_Import(pname);
2582 Py_DECREF(pname);
2583 return result;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002584}
2585
Christian Heimes072c0f12008-01-03 23:01:04 +00002586/* Import a module without blocking
2587 *
2588 * At first it tries to fetch the module from sys.modules. If the module was
2589 * never loaded before it loads it with PyImport_ImportModule() unless another
2590 * thread holds the import lock. In the latter case the function raises an
2591 * ImportError instead of blocking.
2592 *
2593 * Returns the module object with incremented ref count.
2594 */
2595PyObject *
2596PyImport_ImportModuleNoBlock(const char *name)
2597{
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002598 PyObject *nameobj, *modules, *result;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002599 long me;
Christian Heimes072c0f12008-01-03 23:01:04 +00002600
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002601 /* Try to get the module from sys.modules[name] */
2602 modules = PyImport_GetModuleDict();
2603 if (modules == NULL)
2604 return NULL;
Christian Heimes072c0f12008-01-03 23:01:04 +00002605
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002606 nameobj = PyUnicode_FromString(name);
2607 if (nameobj == NULL)
2608 return NULL;
2609 result = PyDict_GetItem(modules, nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002610 if (result != NULL) {
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002611 Py_DECREF(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002612 Py_INCREF(result);
2613 return result;
2614 }
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002615 PyErr_Clear();
Benjamin Peterson3e4f0552008-09-02 00:31:15 +00002616#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002617 /* check the import lock
2618 * me might be -1 but I ignore the error here, the lock function
2619 * takes care of the problem */
2620 me = PyThread_get_thread_ident();
2621 if (import_lock_thread == -1 || import_lock_thread == me) {
2622 /* no thread or me is holding the lock */
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002623 result = PyImport_Import(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002624 }
2625 else {
2626 PyErr_Format(PyExc_ImportError,
Victor Stinnerc24c8102011-03-13 22:38:06 -04002627 "Failed to import %R because the import lock"
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002628 "is held by another thread.",
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002629 nameobj);
2630 result = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002631 }
Benjamin Peterson3e4f0552008-09-02 00:31:15 +00002632#else
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002633 result = PyImport_Import(nameobj);
Benjamin Peterson3e4f0552008-09-02 00:31:15 +00002634#endif
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002635 Py_DECREF(nameobj);
2636 return result;
Christian Heimes072c0f12008-01-03 23:01:04 +00002637}
2638
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002639/* Forward declarations for helper routines */
Victor Stinner974389d2011-03-15 09:33:57 +01002640static PyObject *get_parent(PyObject *globals,
2641 PyObject **p_name,
2642 int level);
Tim Petersdbd9ba62000-07-09 03:09:57 +00002643static PyObject *load_next(PyObject *mod, PyObject *altmod,
Victor Stinner974389d2011-03-15 09:33:57 +01002644 PyObject *inputname, PyObject **p_outputname,
2645 Py_UNICODE *buf, Py_ssize_t *p_buflen,
2646 Py_ssize_t bufsize);
2647static int mark_miss(PyObject *name);
Tim Petersdbd9ba62000-07-09 03:09:57 +00002648static int ensure_fromlist(PyObject *mod, PyObject *fromlist,
Victor Stinner974389d2011-03-15 09:33:57 +01002649 PyObject *buf, int recursive);
2650static PyObject * import_submodule(PyObject *mod, PyObject *name,
2651 PyObject *fullname);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002652
2653/* The Magnum Opus of dotted-name import :-) */
2654
Guido van Rossum75acc9c1998-03-03 22:26:50 +00002655static PyObject *
Victor Stinner974389d2011-03-15 09:33:57 +01002656import_module_level(PyObject *name, PyObject *globals, PyObject *locals,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002657 PyObject *fromlist, int level)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002658{
Victor Stinner974389d2011-03-15 09:33:57 +01002659 Py_UNICODE buf[MAXPATHLEN+1];
2660 Py_ssize_t buflen;
2661 Py_ssize_t bufsize = MAXPATHLEN+1;
2662 PyObject *parent, *head, *next, *tail, *inputname, *outputname;
2663 PyObject *parent_name, *ensure_name;
2664 const Py_UNICODE *nameunicode;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002665
Victor Stinner974389d2011-03-15 09:33:57 +01002666 nameunicode = PyUnicode_AS_UNICODE(name);
2667
2668 if (Py_UNICODE_strchr(nameunicode, SEP) != NULL
2669#ifdef ALTSEP
2670 || Py_UNICODE_strchr(nameunicode, ALTSEP) != NULL
Christian Heimes454f37b2008-01-10 00:10:02 +00002671#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002672 ) {
2673 PyErr_SetString(PyExc_ImportError,
2674 "Import by filename is not supported.");
2675 return NULL;
2676 }
Christian Heimes454f37b2008-01-10 00:10:02 +00002677
Victor Stinner974389d2011-03-15 09:33:57 +01002678 parent = get_parent(globals, &parent_name, level);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002679 if (parent == NULL)
2680 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002681
Victor Stinner974389d2011-03-15 09:33:57 +01002682 buflen = PyUnicode_GET_SIZE(parent_name);
2683 if (buflen+1 > bufsize) {
2684 Py_DECREF(parent_name);
2685 PyErr_SetString(PyExc_ValueError,
2686 "Module name too long");
2687 return NULL;
2688 }
2689 Py_UNICODE_strcpy(buf, PyUnicode_AS_UNICODE(parent_name));
2690 Py_DECREF(parent_name);
2691
2692 head = load_next(parent, level < 0 ? Py_None : parent, name, &outputname,
2693 buf, &buflen, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002694 if (head == NULL)
2695 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002696
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002697 tail = head;
2698 Py_INCREF(tail);
Victor Stinner974389d2011-03-15 09:33:57 +01002699
2700 if (outputname != NULL) {
2701 while (1) {
2702 inputname = outputname;
2703 next = load_next(tail, tail, inputname, &outputname,
2704 buf, &buflen, bufsize);
2705 Py_DECREF(tail);
2706 Py_DECREF(inputname);
2707 if (next == NULL) {
2708 Py_DECREF(head);
2709 return NULL;
2710 }
2711 tail = next;
2712
2713 if (outputname == NULL) {
2714 break;
2715 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002716 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002717 }
2718 if (tail == Py_None) {
2719 /* If tail is Py_None, both get_parent and load_next found
2720 an empty module name: someone called __import__("") or
2721 doctored faulty bytecode */
2722 Py_DECREF(tail);
2723 Py_DECREF(head);
Victor Stinner974389d2011-03-15 09:33:57 +01002724 PyErr_SetString(PyExc_ValueError, "Empty module name");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002725 return NULL;
2726 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002727
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002728 if (fromlist != NULL) {
2729 if (fromlist == Py_None || !PyObject_IsTrue(fromlist))
2730 fromlist = NULL;
2731 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002732
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002733 if (fromlist == NULL) {
2734 Py_DECREF(tail);
2735 return head;
2736 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002737
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002738 Py_DECREF(head);
Victor Stinner974389d2011-03-15 09:33:57 +01002739
2740 ensure_name = PyUnicode_FromUnicode(buf, Py_UNICODE_strlen(buf));
2741 if (ensure_name == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002742 Py_DECREF(tail);
2743 return NULL;
2744 }
Victor Stinner974389d2011-03-15 09:33:57 +01002745 if (!ensure_fromlist(tail, fromlist, ensure_name, 0)) {
2746 Py_DECREF(tail);
2747 Py_DECREF(ensure_name);
2748 return NULL;
2749 }
2750 Py_DECREF(ensure_name);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002751
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002752 return tail;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002753}
2754
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002755PyObject *
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002756PyImport_ImportModuleLevelObject(PyObject *name, PyObject *globals,
2757 PyObject *locals, PyObject *fromlist,
2758 int level)
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002759{
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002760 PyObject *mod;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002761 _PyImport_AcquireLock();
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002762 mod = import_module_level(name, globals, locals, fromlist, level);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002763 if (_PyImport_ReleaseLock() < 0) {
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002764 Py_XDECREF(mod);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002765 PyErr_SetString(PyExc_RuntimeError,
2766 "not holding the import lock");
2767 return NULL;
2768 }
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002769 return mod;
Guido van Rossum75acc9c1998-03-03 22:26:50 +00002770}
2771
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002772PyObject *
2773PyImport_ImportModuleLevel(char *name, PyObject *globals, PyObject *locals,
2774 PyObject *fromlist, int level)
2775{
2776 PyObject *nameobj, *mod;
2777 nameobj = PyUnicode_FromString(name);
2778 if (nameobj == NULL)
2779 return NULL;
2780 mod = PyImport_ImportModuleLevelObject(nameobj, globals, locals,
2781 fromlist, level);
2782 Py_DECREF(nameobj);
2783 return mod;
2784}
2785
2786
Fred Drake87590902004-05-28 20:21:36 +00002787/* Return the package that an import is being performed in. If globals comes
2788 from the module foo.bar.bat (not itself a package), this returns the
2789 sys.modules entry for foo.bar. If globals is from a package's __init__.py,
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00002790 the package's entry in sys.modules is returned, as a borrowed reference.
Fred Drake87590902004-05-28 20:21:36 +00002791
Victor Stinner974389d2011-03-15 09:33:57 +01002792 The name of the returned package is returned in *p_name.
Fred Drake87590902004-05-28 20:21:36 +00002793
2794 If globals doesn't come from a package or a module in a package, or a
2795 corresponding entry is not found in sys.modules, Py_None is returned.
2796*/
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002797static PyObject *
Victor Stinner9599de52011-03-13 22:38:38 -04002798get_parent(PyObject *globals, PyObject **p_name, int level)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002799{
Victor Stinner974389d2011-03-15 09:33:57 +01002800 Py_UNICODE name[MAXPATHLEN+1];
2801 const Py_ssize_t bufsize = MAXPATHLEN+1;
2802 PyObject *nameobj;
2803
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002804 static PyObject *namestr = NULL;
2805 static PyObject *pathstr = NULL;
2806 static PyObject *pkgstr = NULL;
2807 PyObject *pkgname, *modname, *modpath, *modules, *parent;
2808 int orig_level = level;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002809
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002810 if (globals == NULL || !PyDict_Check(globals) || !level)
Victor Stinner974389d2011-03-15 09:33:57 +01002811 goto return_none;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002812
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002813 if (namestr == NULL) {
2814 namestr = PyUnicode_InternFromString("__name__");
2815 if (namestr == NULL)
2816 return NULL;
2817 }
2818 if (pathstr == NULL) {
2819 pathstr = PyUnicode_InternFromString("__path__");
2820 if (pathstr == NULL)
2821 return NULL;
2822 }
2823 if (pkgstr == NULL) {
2824 pkgstr = PyUnicode_InternFromString("__package__");
2825 if (pkgstr == NULL)
2826 return NULL;
2827 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002828
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002829 pkgname = PyDict_GetItem(globals, pkgstr);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002830
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002831 if ((pkgname != NULL) && (pkgname != Py_None)) {
2832 /* __package__ is set, so use it */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002833 if (!PyUnicode_Check(pkgname)) {
2834 PyErr_SetString(PyExc_ValueError,
2835 "__package__ set to non-string");
2836 return NULL;
2837 }
Victor Stinner974389d2011-03-15 09:33:57 +01002838 if (PyUnicode_GET_SIZE(pkgname) == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002839 if (level > 0) {
2840 PyErr_SetString(PyExc_ValueError,
2841 "Attempted relative import in non-package");
2842 return NULL;
2843 }
Victor Stinner974389d2011-03-15 09:33:57 +01002844 goto return_none;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002845 }
Victor Stinner974389d2011-03-15 09:33:57 +01002846 if (PyUnicode_GET_SIZE(pkgname)+1 > bufsize) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002847 PyErr_SetString(PyExc_ValueError,
2848 "Package name too long");
2849 return NULL;
2850 }
Victor Stinner974389d2011-03-15 09:33:57 +01002851 Py_UNICODE_strcpy(name, PyUnicode_AS_UNICODE(pkgname));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002852 } else {
2853 /* __package__ not set, so figure it out and set it */
2854 modname = PyDict_GetItem(globals, namestr);
2855 if (modname == NULL || !PyUnicode_Check(modname))
Victor Stinner974389d2011-03-15 09:33:57 +01002856 goto return_none;
Brett Cannon9a5b25a2010-03-01 02:09:17 +00002857
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002858 modpath = PyDict_GetItem(globals, pathstr);
2859 if (modpath != NULL) {
2860 /* __path__ is set, so modname is already the package name */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002861 int error;
Alexandre Vassalottia85998a2008-05-03 18:24:43 +00002862
Victor Stinner974389d2011-03-15 09:33:57 +01002863 if (PyUnicode_GET_SIZE(modname)+1 > bufsize) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002864 PyErr_SetString(PyExc_ValueError,
2865 "Module name too long");
2866 return NULL;
2867 }
Victor Stinner974389d2011-03-15 09:33:57 +01002868 Py_UNICODE_strcpy(name, PyUnicode_AS_UNICODE(modname));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002869 error = PyDict_SetItem(globals, pkgstr, modname);
2870 if (error) {
2871 PyErr_SetString(PyExc_ValueError,
2872 "Could not set __package__");
2873 return NULL;
2874 }
2875 } else {
2876 /* Normal module, so work out the package name if any */
Victor Stinner974389d2011-03-15 09:33:57 +01002877 Py_UNICODE *start = PyUnicode_AS_UNICODE(modname);
2878 Py_UNICODE *lastdot = Py_UNICODE_strrchr(start, '.');
2879 Py_ssize_t len;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002880 int error;
2881 if (lastdot == NULL && level > 0) {
2882 PyErr_SetString(PyExc_ValueError,
2883 "Attempted relative import in non-package");
2884 return NULL;
2885 }
2886 if (lastdot == NULL) {
2887 error = PyDict_SetItem(globals, pkgstr, Py_None);
2888 if (error) {
2889 PyErr_SetString(PyExc_ValueError,
2890 "Could not set __package__");
2891 return NULL;
2892 }
Victor Stinner974389d2011-03-15 09:33:57 +01002893 goto return_none;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002894 }
2895 len = lastdot - start;
Victor Stinner974389d2011-03-15 09:33:57 +01002896 if (len+1 > bufsize) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002897 PyErr_SetString(PyExc_ValueError,
2898 "Module name too long");
2899 return NULL;
2900 }
Victor Stinner974389d2011-03-15 09:33:57 +01002901 Py_UNICODE_strncpy(name, start, len);
2902 name[len] = '\0';
2903 pkgname = PyUnicode_FromUnicode(name, len);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002904 if (pkgname == NULL) {
2905 return NULL;
2906 }
2907 error = PyDict_SetItem(globals, pkgstr, pkgname);
2908 Py_DECREF(pkgname);
2909 if (error) {
2910 PyErr_SetString(PyExc_ValueError,
2911 "Could not set __package__");
2912 return NULL;
2913 }
2914 }
2915 }
2916 while (--level > 0) {
Victor Stinner974389d2011-03-15 09:33:57 +01002917 Py_UNICODE *dot = Py_UNICODE_strrchr(name, '.');
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002918 if (dot == NULL) {
2919 PyErr_SetString(PyExc_ValueError,
2920 "Attempted relative import beyond "
2921 "toplevel package");
2922 return NULL;
2923 }
2924 *dot = '\0';
2925 }
Victor Stinner974389d2011-03-15 09:33:57 +01002926
2927 nameobj = PyUnicode_FromUnicode(name, Py_UNICODE_strlen(name));
2928 if (nameobj == NULL)
2929 return NULL;
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002930
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002931 modules = PyImport_GetModuleDict();
Victor Stinner974389d2011-03-15 09:33:57 +01002932 parent = PyDict_GetItem(modules, nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002933 if (parent == NULL) {
Victor Stinner974389d2011-03-15 09:33:57 +01002934 int err;
2935
2936 if (orig_level >= 1) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002937 PyErr_Format(PyExc_SystemError,
Victor Stinner974389d2011-03-15 09:33:57 +01002938 "Parent module %R not loaded, "
2939 "cannot perform relative import", nameobj);
2940 Py_DECREF(nameobj);
2941 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002942 }
Victor Stinner974389d2011-03-15 09:33:57 +01002943
2944 err = PyErr_WarnFormat(
2945 PyExc_RuntimeWarning, 1,
2946 "Parent module %R not found while handling absolute import",
2947 nameobj);
2948 Py_DECREF(nameobj);
2949 if (err)
2950 return NULL;
2951
2952 goto return_none;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002953 }
Victor Stinner974389d2011-03-15 09:33:57 +01002954 *p_name = nameobj;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002955 return parent;
2956 /* We expect, but can't guarantee, if parent != None, that:
Victor Stinner974389d2011-03-15 09:33:57 +01002957 - parent.__name__ == name
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002958 - parent.__dict__ is globals
2959 If this is violated... Who cares? */
Victor Stinner974389d2011-03-15 09:33:57 +01002960
2961return_none:
2962 nameobj = PyUnicode_FromUnicode(NULL, 0);
2963 if (nameobj == NULL)
2964 return NULL;
2965 *p_name = nameobj;
2966 return Py_None;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002967}
2968
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002969/* altmod is either None or same as mod */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002970static PyObject *
Victor Stinner974389d2011-03-15 09:33:57 +01002971load_next(PyObject *mod, PyObject *altmod,
2972 PyObject *inputname, PyObject **p_outputname,
2973 Py_UNICODE *buf, Py_ssize_t *p_buflen, Py_ssize_t bufsize)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002974{
Victor Stinner974389d2011-03-15 09:33:57 +01002975 const Py_UNICODE *dot;
2976 Py_ssize_t len;
2977 Py_UNICODE *p;
2978 PyObject *fullname, *name, *result, *mark_name;
2979 const Py_UNICODE *nameuni;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002980
Victor Stinner974389d2011-03-15 09:33:57 +01002981 *p_outputname = NULL;
2982
2983 if (PyUnicode_GET_SIZE(inputname) == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002984 /* completely empty module name should only happen in
2985 'from . import' (or '__import__("")')*/
2986 Py_INCREF(mod);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002987 return mod;
2988 }
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002989
Victor Stinner974389d2011-03-15 09:33:57 +01002990 nameuni = PyUnicode_AS_UNICODE(inputname);
2991 if (nameuni == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002992 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002993
Victor Stinner974389d2011-03-15 09:33:57 +01002994 dot = Py_UNICODE_strchr(nameuni, '.');
2995 if (dot != NULL) {
2996 len = dot - nameuni;
2997 if (len == 0) {
2998 PyErr_SetString(PyExc_ValueError,
2999 "Empty module name");
3000 return NULL;
3001 }
3002 }
3003 else
3004 len = PyUnicode_GET_SIZE(inputname);
3005
3006 if (*p_buflen+len+1 >= bufsize) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003007 PyErr_SetString(PyExc_ValueError,
3008 "Module name too long");
3009 return NULL;
3010 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003011
Victor Stinner974389d2011-03-15 09:33:57 +01003012 p = buf + *p_buflen;
3013 if (p != buf) {
3014 *p++ = '.';
3015 *p_buflen += 1;
3016 }
3017 Py_UNICODE_strncpy(p, nameuni, len);
3018 p[len] = '\0';
3019 *p_buflen += len;
3020
3021 fullname = PyUnicode_FromUnicode(buf, *p_buflen);
3022 if (fullname == NULL)
3023 return NULL;
3024 name = PyUnicode_FromUnicode(p, len);
3025 if (name == NULL) {
3026 Py_DECREF(fullname);
3027 return NULL;
3028 }
3029 result = import_submodule(mod, name, fullname);
3030 Py_DECREF(fullname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003031 if (result == Py_None && altmod != mod) {
3032 Py_DECREF(result);
3033 /* Here, altmod must be None and mod must not be None */
Victor Stinner974389d2011-03-15 09:33:57 +01003034 result = import_submodule(altmod, name, name);
3035 Py_DECREF(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003036 if (result != NULL && result != Py_None) {
Victor Stinner974389d2011-03-15 09:33:57 +01003037 mark_name = PyUnicode_FromUnicode(buf, *p_buflen);
3038 if (mark_name == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003039 Py_DECREF(result);
3040 return NULL;
3041 }
Victor Stinner974389d2011-03-15 09:33:57 +01003042 if (mark_miss(mark_name) != 0) {
3043 Py_DECREF(result);
3044 Py_DECREF(mark_name);
3045 return NULL;
3046 }
3047 Py_DECREF(mark_name);
3048 Py_UNICODE_strncpy(buf, nameuni, len);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003049 buf[len] = '\0';
3050 *p_buflen = len;
3051 }
3052 }
Victor Stinner974389d2011-03-15 09:33:57 +01003053 else
3054 Py_DECREF(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003055 if (result == NULL)
3056 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003057
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003058 if (result == Py_None) {
3059 Py_DECREF(result);
3060 PyErr_Format(PyExc_ImportError,
Victor Stinner974389d2011-03-15 09:33:57 +01003061 "No module named %R", inputname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003062 return NULL;
3063 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003064
Victor Stinner974389d2011-03-15 09:33:57 +01003065 if (dot != NULL) {
3066 *p_outputname = PyUnicode_FromUnicode(dot+1, Py_UNICODE_strlen(dot+1));
3067 if (*p_outputname == NULL) {
3068 Py_DECREF(result);
3069 return NULL;
3070 }
3071 }
3072
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003073 return result;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003074}
3075
3076static int
Victor Stinner974389d2011-03-15 09:33:57 +01003077mark_miss(PyObject *name)
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00003078{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003079 PyObject *modules = PyImport_GetModuleDict();
Victor Stinner974389d2011-03-15 09:33:57 +01003080 return PyDict_SetItem(modules, name, Py_None);
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00003081}
3082
3083static int
Victor Stinner974389d2011-03-15 09:33:57 +01003084ensure_fromlist(PyObject *mod, PyObject *fromlist, PyObject *name,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003085 int recursive)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003086{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003087 int i;
Victor Stinner974389d2011-03-15 09:33:57 +01003088 PyObject *fullname;
3089 Py_ssize_t fromlist_len;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003090
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003091 if (!PyObject_HasAttrString(mod, "__path__"))
3092 return 1;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003093
Victor Stinner974389d2011-03-15 09:33:57 +01003094 fromlist_len = PySequence_Size(fromlist);
3095
3096 for (i = 0; i < fromlist_len; i++) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003097 PyObject *item = PySequence_GetItem(fromlist, i);
3098 int hasit;
Victor Stinner974389d2011-03-15 09:33:57 +01003099 if (item == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003100 return 0;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003101 if (!PyUnicode_Check(item)) {
3102 PyErr_SetString(PyExc_TypeError,
3103 "Item in ``from list'' not a string");
3104 Py_DECREF(item);
3105 return 0;
3106 }
3107 if (PyUnicode_AS_UNICODE(item)[0] == '*') {
3108 PyObject *all;
3109 Py_DECREF(item);
3110 /* See if the package defines __all__ */
3111 if (recursive)
3112 continue; /* Avoid endless recursion */
3113 all = PyObject_GetAttrString(mod, "__all__");
3114 if (all == NULL)
3115 PyErr_Clear();
3116 else {
Victor Stinner974389d2011-03-15 09:33:57 +01003117 int ret = ensure_fromlist(mod, all, name, 1);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003118 Py_DECREF(all);
3119 if (!ret)
3120 return 0;
3121 }
3122 continue;
3123 }
3124 hasit = PyObject_HasAttr(mod, item);
3125 if (!hasit) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003126 PyObject *submod;
Victor Stinner974389d2011-03-15 09:33:57 +01003127 fullname = PyUnicode_FromFormat("%U.%U", name, item);
3128 if (fullname != NULL) {
3129 submod = import_submodule(mod, item, fullname);
3130 Py_DECREF(fullname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003131 }
Victor Stinner974389d2011-03-15 09:33:57 +01003132 else
3133 submod = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003134 Py_XDECREF(submod);
3135 if (submod == NULL) {
3136 Py_DECREF(item);
3137 return 0;
3138 }
3139 }
3140 Py_DECREF(item);
3141 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003142
Victor Stinner974389d2011-03-15 09:33:57 +01003143 return 1;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003144}
3145
Neil Schemenauer00b09662003-06-16 21:03:07 +00003146static int
Victor Stinner974389d2011-03-15 09:33:57 +01003147add_submodule(PyObject *mod, PyObject *submod, PyObject *fullname,
3148 PyObject *subname, PyObject *modules)
Neil Schemenauer00b09662003-06-16 21:03:07 +00003149{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003150 if (mod == Py_None)
3151 return 1;
3152 /* Irrespective of the success of this load, make a
3153 reference to it in the parent package module. A copy gets
3154 saved in the modules dictionary under the full name, so get a
3155 reference from there, if need be. (The exception is when the
3156 load failed with a SyntaxError -- then there's no trace in
3157 sys.modules. In that case, of course, do nothing extra.) */
3158 if (submod == NULL) {
Victor Stinner974389d2011-03-15 09:33:57 +01003159 submod = PyDict_GetItem(modules, fullname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003160 if (submod == NULL)
3161 return 1;
3162 }
3163 if (PyModule_Check(mod)) {
3164 /* We can't use setattr here since it can give a
3165 * spurious warning if the submodule name shadows a
3166 * builtin name */
3167 PyObject *dict = PyModule_GetDict(mod);
3168 if (!dict)
3169 return 0;
Victor Stinner974389d2011-03-15 09:33:57 +01003170 if (PyDict_SetItem(dict, subname, submod) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003171 return 0;
3172 }
3173 else {
Victor Stinner974389d2011-03-15 09:33:57 +01003174 if (PyObject_SetAttr(mod, subname, submod) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003175 return 0;
3176 }
3177 return 1;
Neil Schemenauer00b09662003-06-16 21:03:07 +00003178}
3179
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003180static PyObject *
Victor Stinner974389d2011-03-15 09:33:57 +01003181import_submodule(PyObject *mod, PyObject *subname, PyObject *fullname)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003182{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003183 PyObject *modules = PyImport_GetModuleDict();
Victor Stinner533d7832011-03-14 13:22:54 -04003184 PyObject *m = NULL, *bufobj, *path_list, *loader;
Victor Stinner9599de52011-03-13 22:38:38 -04003185 struct filedescr *fdp;
3186 FILE *fp;
Guido van Rossum74e6a111994-08-29 12:54:38 +00003187
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003188 /* Require:
3189 if mod == None: subname == fullname
3190 else: mod.__name__ + "." + subname == fullname
3191 */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003192
Victor Stinner974389d2011-03-15 09:33:57 +01003193 if ((m = PyDict_GetItem(modules, fullname)) != NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003194 Py_INCREF(m);
Victor Stinner9599de52011-03-13 22:38:38 -04003195 return m;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003196 }
Victor Stinner9599de52011-03-13 22:38:38 -04003197
3198 if (mod == Py_None)
Victor Stinner533d7832011-03-14 13:22:54 -04003199 path_list = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003200 else {
Victor Stinner533d7832011-03-14 13:22:54 -04003201 path_list = PyObject_GetAttrString(mod, "__path__");
3202 if (path_list == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003203 PyErr_Clear();
3204 Py_INCREF(Py_None);
3205 return Py_None;
3206 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003207 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003208
Victor Stinner533d7832011-03-14 13:22:54 -04003209 fdp = find_module(fullname, subname, path_list,
Victor Stinner2fd76e42011-03-14 15:19:39 -04003210 &bufobj, &fp, &loader);
Victor Stinner533d7832011-03-14 13:22:54 -04003211 Py_XDECREF(path_list);
Victor Stinner9599de52011-03-13 22:38:38 -04003212 if (fdp == NULL) {
3213 if (!PyErr_ExceptionMatches(PyExc_ImportError))
3214 return NULL;
3215 PyErr_Clear();
3216 Py_INCREF(Py_None);
3217 return Py_None;
3218 }
Victor Stinner2fd76e42011-03-14 15:19:39 -04003219 m = load_module(fullname, fp, bufobj, fdp->type, loader);
3220 Py_XDECREF(bufobj);
Victor Stinner9599de52011-03-13 22:38:38 -04003221 Py_XDECREF(loader);
3222 if (fp)
3223 fclose(fp);
3224 if (m == NULL)
3225 return NULL;
3226 if (!add_submodule(mod, m, fullname, subname, modules)) {
3227 Py_XDECREF(m);
3228 return NULL;
3229 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003230 return m;
Guido van Rossum74e6a111994-08-29 12:54:38 +00003231}
3232
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003233
3234/* Re-import a module of any kind and return its module object, WITH
3235 INCREMENTED REFERENCE COUNT */
3236
Guido van Rossum79f25d91997-04-29 20:08:16 +00003237PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003238PyImport_ReloadModule(PyObject *m)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003239{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003240 PyInterpreterState *interp = PyThreadState_Get()->interp;
3241 PyObject *modules_reloading = interp->modules_reloading;
3242 PyObject *modules = PyImport_GetModuleDict();
Victor Stinner533d7832011-03-14 13:22:54 -04003243 PyObject *path_list = NULL, *loader = NULL, *existing_m = NULL;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003244 PyObject *nameobj, *bufobj, *subnameobj;
3245 Py_UNICODE *name, *subname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003246 struct filedescr *fdp;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003247 FILE *fp = NULL;
3248 PyObject *newm = NULL;
Brett Cannon9a5b25a2010-03-01 02:09:17 +00003249
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003250 if (modules_reloading == NULL) {
3251 Py_FatalError("PyImport_ReloadModule: "
3252 "no modules_reloading dictionary!");
3253 return NULL;
3254 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003255
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003256 if (m == NULL || !PyModule_Check(m)) {
3257 PyErr_SetString(PyExc_TypeError,
3258 "reload() argument must be module");
3259 return NULL;
3260 }
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003261 nameobj = PyModule_GetNameObject(m);
3262 if (nameobj == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003263 return NULL;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003264 if (m != PyDict_GetItem(modules, nameobj)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003265 PyErr_Format(PyExc_ImportError,
Victor Stinner98dbba52011-03-14 15:15:47 -04003266 "reload(): module %R not in sys.modules",
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003267 nameobj);
3268 Py_DECREF(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003269 return NULL;
3270 }
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003271 existing_m = PyDict_GetItem(modules_reloading, nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003272 if (existing_m != NULL) {
3273 /* Due to a recursive reload, this module is already
3274 being reloaded. */
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003275 Py_DECREF(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003276 Py_INCREF(existing_m);
3277 return existing_m;
3278 }
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003279 if (PyDict_SetItem(modules_reloading, nameobj, m) < 0) {
3280 Py_DECREF(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003281 return NULL;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003282 }
Guido van Rossumd8faa362007-04-27 19:54:29 +00003283
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003284 name = PyUnicode_AS_UNICODE(nameobj);
3285 subname = Py_UNICODE_strrchr(name, '.');
3286 if (subname == NULL) {
3287 Py_INCREF(nameobj);
3288 subnameobj = nameobj;
3289 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003290 else {
3291 PyObject *parentname, *parent;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003292 Py_ssize_t len;
3293 len = subname - name;
3294 parentname = PyUnicode_FromUnicode(name, len);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003295 if (parentname == NULL) {
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003296 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003297 }
3298 parent = PyDict_GetItem(modules, parentname);
3299 if (parent == NULL) {
3300 PyErr_Format(PyExc_ImportError,
Victor Stinner98dbba52011-03-14 15:15:47 -04003301 "reload(): parent %R not in sys.modules",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003302 parentname);
3303 Py_DECREF(parentname);
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003304 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003305 }
3306 Py_DECREF(parentname);
Victor Stinner533d7832011-03-14 13:22:54 -04003307 path_list = PyObject_GetAttrString(parent, "__path__");
3308 if (path_list == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003309 PyErr_Clear();
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003310 subname++;
3311 len = PyUnicode_GET_SIZE(nameobj) - (len + 1);
3312 subnameobj = PyUnicode_FromUnicode(subname, len);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003313 }
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003314 if (subnameobj == NULL)
3315 goto error;
Victor Stinner533d7832011-03-14 13:22:54 -04003316 fdp = find_module(nameobj, subnameobj, path_list,
Victor Stinner2fd76e42011-03-14 15:19:39 -04003317 &bufobj, &fp, &loader);
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003318 Py_DECREF(subnameobj);
Victor Stinner533d7832011-03-14 13:22:54 -04003319 Py_XDECREF(path_list);
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00003320
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003321 if (fdp == NULL) {
3322 Py_XDECREF(loader);
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003323 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003324 }
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00003325
Victor Stinner2fd76e42011-03-14 15:19:39 -04003326 newm = load_module(nameobj, fp, bufobj, fdp->type, loader);
3327 Py_XDECREF(bufobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003328 Py_XDECREF(loader);
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00003329
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003330 if (fp)
3331 fclose(fp);
3332 if (newm == NULL) {
3333 /* load_module probably removed name from modules because of
3334 * the error. Put back the original module object. We're
3335 * going to return NULL in this case regardless of whether
3336 * replacing name succeeds, so the return value is ignored.
3337 */
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003338 PyDict_SetItem(modules, nameobj, m);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003339 }
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003340
3341error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003342 imp_modules_reloading_clear();
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003343 Py_DECREF(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003344 return newm;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003345}
3346
3347
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003348/* Higher-level import emulator which emulates the "import" statement
3349 more accurately -- it invokes the __import__() function from the
3350 builtins of the current globals. This means that the import is
3351 done using whatever import hooks are installed in the current
Brett Cannonbc2eff32010-09-19 21:39:02 +00003352 environment.
Guido van Rossum6058eb41998-12-21 19:51:00 +00003353 A dummy list ["__doc__"] is passed as the 4th argument so that
Neal Norwitz80e7f272007-08-26 06:45:23 +00003354 e.g. PyImport_Import(PyUnicode_FromString("win32com.client.gencache"))
Guido van Rossum6058eb41998-12-21 19:51:00 +00003355 will return <module "gencache"> instead of <module "win32com">. */
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003356
3357PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003358PyImport_Import(PyObject *module_name)
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003359{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003360 static PyObject *silly_list = NULL;
3361 static PyObject *builtins_str = NULL;
3362 static PyObject *import_str = NULL;
3363 PyObject *globals = NULL;
3364 PyObject *import = NULL;
3365 PyObject *builtins = NULL;
Brett Cannonbc2eff32010-09-19 21:39:02 +00003366 PyObject *modules = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003367 PyObject *r = NULL;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003368
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003369 /* Initialize constant string objects */
3370 if (silly_list == NULL) {
3371 import_str = PyUnicode_InternFromString("__import__");
3372 if (import_str == NULL)
3373 return NULL;
3374 builtins_str = PyUnicode_InternFromString("__builtins__");
3375 if (builtins_str == NULL)
3376 return NULL;
Brett Cannonbc2eff32010-09-19 21:39:02 +00003377 silly_list = PyList_New(0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003378 if (silly_list == NULL)
3379 return NULL;
3380 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003381
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003382 /* Get the builtins from current globals */
3383 globals = PyEval_GetGlobals();
3384 if (globals != NULL) {
3385 Py_INCREF(globals);
3386 builtins = PyObject_GetItem(globals, builtins_str);
3387 if (builtins == NULL)
3388 goto err;
3389 }
3390 else {
3391 /* No globals -- use standard builtins, and fake globals */
3392 builtins = PyImport_ImportModuleLevel("builtins",
3393 NULL, NULL, NULL, 0);
3394 if (builtins == NULL)
3395 return NULL;
3396 globals = Py_BuildValue("{OO}", builtins_str, builtins);
3397 if (globals == NULL)
3398 goto err;
3399 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003400
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003401 /* Get the __import__ function from the builtins */
3402 if (PyDict_Check(builtins)) {
3403 import = PyObject_GetItem(builtins, import_str);
3404 if (import == NULL)
3405 PyErr_SetObject(PyExc_KeyError, import_str);
3406 }
3407 else
3408 import = PyObject_GetAttr(builtins, import_str);
3409 if (import == NULL)
3410 goto err;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003411
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003412 /* Call the __import__ function with the proper argument list
Brett Cannonbc2eff32010-09-19 21:39:02 +00003413 Always use absolute import here.
3414 Calling for side-effect of import. */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003415 r = PyObject_CallFunction(import, "OOOOi", module_name, globals,
3416 globals, silly_list, 0, NULL);
Brett Cannonbc2eff32010-09-19 21:39:02 +00003417 if (r == NULL)
3418 goto err;
3419 Py_DECREF(r);
3420
3421 modules = PyImport_GetModuleDict();
3422 r = PyDict_GetItem(modules, module_name);
3423 if (r != NULL)
3424 Py_INCREF(r);
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003425
3426 err:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003427 Py_XDECREF(globals);
3428 Py_XDECREF(builtins);
3429 Py_XDECREF(import);
Tim Peters50d8d372001-02-28 05:34:27 +00003430
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003431 return r;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003432}
3433
3434
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003435/* Module 'imp' provides Python access to the primitives used for
3436 importing modules.
3437*/
3438
Guido van Rossum79f25d91997-04-29 20:08:16 +00003439static PyObject *
Barry Warsaw28a691b2010-04-17 00:19:56 +00003440imp_make_magic(long magic)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003441{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003442 char buf[4];
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003443
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003444 buf[0] = (char) ((magic >> 0) & 0xff);
3445 buf[1] = (char) ((magic >> 8) & 0xff);
3446 buf[2] = (char) ((magic >> 16) & 0xff);
3447 buf[3] = (char) ((magic >> 24) & 0xff);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003448
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003449 return PyBytes_FromStringAndSize(buf, 4);
Victor Stinner3e2b7172010-11-09 09:32:19 +00003450}
Barry Warsaw28a691b2010-04-17 00:19:56 +00003451
3452static PyObject *
3453imp_get_magic(PyObject *self, PyObject *noargs)
3454{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003455 return imp_make_magic(pyc_magic);
Barry Warsaw28a691b2010-04-17 00:19:56 +00003456}
3457
3458static PyObject *
3459imp_get_tag(PyObject *self, PyObject *noargs)
3460{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003461 return PyUnicode_FromString(pyc_tag);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003462}
3463
Guido van Rossum79f25d91997-04-29 20:08:16 +00003464static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +00003465imp_get_suffixes(PyObject *self, PyObject *noargs)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003466{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003467 PyObject *list;
3468 struct filedescr *fdp;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003469
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003470 list = PyList_New(0);
3471 if (list == NULL)
3472 return NULL;
3473 for (fdp = _PyImport_Filetab; fdp->suffix != NULL; fdp++) {
3474 PyObject *item = Py_BuildValue("ssi",
3475 fdp->suffix, fdp->mode, fdp->type);
3476 if (item == NULL) {
3477 Py_DECREF(list);
3478 return NULL;
3479 }
3480 if (PyList_Append(list, item) < 0) {
3481 Py_DECREF(list);
3482 Py_DECREF(item);
3483 return NULL;
3484 }
3485 Py_DECREF(item);
3486 }
3487 return list;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003488}
3489
Guido van Rossum79f25d91997-04-29 20:08:16 +00003490static PyObject *
Victor Stinner533d7832011-03-14 13:22:54 -04003491call_find_module(PyObject *name, PyObject *path_list)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003492{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003493 extern int fclose(FILE *);
3494 PyObject *fob, *ret;
3495 PyObject *pathobj;
3496 struct filedescr *fdp;
Victor Stinner7d8b77c2011-03-12 08:45:02 -05003497 FILE *fp;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003498 int fd = -1;
3499 char *found_encoding = NULL;
3500 char *encoding = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003501
Victor Stinner533d7832011-03-14 13:22:54 -04003502 if (path_list == Py_None)
3503 path_list = NULL;
3504 fdp = find_module(NULL, name, path_list,
Victor Stinner2fd76e42011-03-14 15:19:39 -04003505 &pathobj, &fp, NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003506 if (fdp == NULL)
3507 return NULL;
3508 if (fp != NULL) {
3509 fd = fileno(fp);
3510 if (fd != -1)
3511 fd = dup(fd);
3512 fclose(fp);
3513 fp = NULL;
3514 }
3515 if (fd != -1) {
3516 if (strchr(fdp->mode, 'b') == NULL) {
3517 /* PyTokenizer_FindEncoding() returns PyMem_MALLOC'ed
3518 memory. */
3519 found_encoding = PyTokenizer_FindEncoding(fd);
3520 lseek(fd, 0, 0); /* Reset position */
Victor Stinner2fd76e42011-03-14 15:19:39 -04003521 if (found_encoding == NULL && PyErr_Occurred()) {
3522 Py_XDECREF(pathobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003523 return NULL;
Victor Stinner2fd76e42011-03-14 15:19:39 -04003524 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003525 encoding = (found_encoding != NULL) ? found_encoding :
3526 (char*)PyUnicode_GetDefaultEncoding();
3527 }
Victor Stinner2fd76e42011-03-14 15:19:39 -04003528 fob = PyFile_FromFd(fd, NULL, fdp->mode, -1,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003529 (char*)encoding, NULL, NULL, 1);
3530 if (fob == NULL) {
Victor Stinner2fd76e42011-03-14 15:19:39 -04003531 Py_XDECREF(pathobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003532 close(fd);
3533 PyMem_FREE(found_encoding);
3534 return NULL;
3535 }
3536 }
3537 else {
3538 fob = Py_None;
3539 Py_INCREF(fob);
3540 }
Victor Stinner2fd76e42011-03-14 15:19:39 -04003541 if (pathobj == NULL) {
3542 Py_INCREF(Py_None);
3543 pathobj = Py_None;
3544 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003545 ret = Py_BuildValue("NN(ssi)",
3546 fob, pathobj, fdp->suffix, fdp->mode, fdp->type);
3547 PyMem_FREE(found_encoding);
Brett Cannon3bb42d92007-10-20 03:43:15 +00003548
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003549 return ret;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003550}
3551
Guido van Rossum79f25d91997-04-29 20:08:16 +00003552static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003553imp_find_module(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003554{
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003555 PyObject *name, *path_list = NULL;
3556 if (!PyArg_ParseTuple(args, "U|O:find_module",
3557 &name, &path_list))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003558 return NULL;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003559 return call_find_module(name, path_list);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003560}
3561
3562static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003563imp_init_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003564{
Victor Stinner95872862011-03-07 18:20:56 +01003565 PyObject *name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003566 int ret;
3567 PyObject *m;
Victor Stinner95872862011-03-07 18:20:56 +01003568 if (!PyArg_ParseTuple(args, "U:init_builtin", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003569 return NULL;
3570 ret = init_builtin(name);
3571 if (ret < 0)
3572 return NULL;
3573 if (ret == 0) {
3574 Py_INCREF(Py_None);
3575 return Py_None;
3576 }
Victor Stinner95872862011-03-07 18:20:56 +01003577 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003578 Py_XINCREF(m);
3579 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003580}
3581
Guido van Rossum79f25d91997-04-29 20:08:16 +00003582static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003583imp_init_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003584{
Victor Stinner53dc7352011-03-20 01:50:21 +01003585 PyObject *name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003586 int ret;
3587 PyObject *m;
Victor Stinner53dc7352011-03-20 01:50:21 +01003588 if (!PyArg_ParseTuple(args, "U:init_frozen", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003589 return NULL;
Victor Stinner53dc7352011-03-20 01:50:21 +01003590 ret = PyImport_ImportFrozenModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003591 if (ret < 0)
3592 return NULL;
3593 if (ret == 0) {
3594 Py_INCREF(Py_None);
3595 return Py_None;
3596 }
Victor Stinner53dc7352011-03-20 01:50:21 +01003597 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003598 Py_XINCREF(m);
3599 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003600}
3601
Guido van Rossum79f25d91997-04-29 20:08:16 +00003602static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003603imp_get_frozen_object(PyObject *self, PyObject *args)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00003604{
Victor Stinner53dc7352011-03-20 01:50:21 +01003605 PyObject *name;
Jack Jansen95ffa231995-10-03 14:38:41 +00003606
Victor Stinner53dc7352011-03-20 01:50:21 +01003607 if (!PyArg_ParseTuple(args, "U:get_frozen_object", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003608 return NULL;
3609 return get_frozen_object(name);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00003610}
3611
Guido van Rossum79f25d91997-04-29 20:08:16 +00003612static PyObject *
Brett Cannon8d110132009-03-15 02:20:16 +00003613imp_is_frozen_package(PyObject *self, PyObject *args)
3614{
Victor Stinner53dc7352011-03-20 01:50:21 +01003615 PyObject *name;
Brett Cannon8d110132009-03-15 02:20:16 +00003616
Victor Stinner53dc7352011-03-20 01:50:21 +01003617 if (!PyArg_ParseTuple(args, "U:is_frozen_package", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003618 return NULL;
3619 return is_frozen_package(name);
Brett Cannon8d110132009-03-15 02:20:16 +00003620}
3621
3622static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003623imp_is_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003624{
Victor Stinner95872862011-03-07 18:20:56 +01003625 PyObject *name;
3626 if (!PyArg_ParseTuple(args, "U:is_builtin", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003627 return NULL;
3628 return PyLong_FromLong(is_builtin(name));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003629}
3630
Guido van Rossum79f25d91997-04-29 20:08:16 +00003631static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003632imp_is_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003633{
Victor Stinner53dc7352011-03-20 01:50:21 +01003634 PyObject *name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003635 struct _frozen *p;
Victor Stinner53dc7352011-03-20 01:50:21 +01003636 if (!PyArg_ParseTuple(args, "U:is_frozen", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003637 return NULL;
3638 p = find_frozen(name);
3639 return PyBool_FromLong((long) (p == NULL ? 0 : p->size));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003640}
3641
3642static FILE *
Victor Stinner2f42ae52011-03-20 00:41:24 +01003643get_file(PyObject *pathname, PyObject *fob, char *mode)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003644{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003645 FILE *fp;
3646 if (mode[0] == 'U')
3647 mode = "r" PY_STDIOTEXTMODE;
3648 if (fob == NULL) {
Victor Stinner2f42ae52011-03-20 00:41:24 +01003649 fp = _Py_fopen(pathname, mode);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003650 }
3651 else {
3652 int fd = PyObject_AsFileDescriptor(fob);
3653 if (fd == -1)
3654 return NULL;
3655 if (!_PyVerify_fd(fd))
3656 goto error;
3657 /* the FILE struct gets a new fd, so that it can be closed
3658 * independently of the file descriptor given
3659 */
3660 fd = dup(fd);
3661 if (fd == -1)
3662 goto error;
3663 fp = fdopen(fd, mode);
3664 }
3665 if (fp)
3666 return fp;
Kristján Valur Jónssone1b04452009-03-31 17:43:39 +00003667error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003668 PyErr_SetFromErrno(PyExc_IOError);
3669 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003670}
3671
Guido van Rossum79f25d91997-04-29 20:08:16 +00003672static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003673imp_load_compiled(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003674{
Victor Stinner2f42ae52011-03-20 00:41:24 +01003675 PyObject *name, *pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003676 PyObject *fob = NULL;
3677 PyObject *m;
3678 FILE *fp;
Victor Stinner2f42ae52011-03-20 00:41:24 +01003679 if (!PyArg_ParseTuple(args, "UO&|O:load_compiled",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003680 &name,
Victor Stinner2f42ae52011-03-20 00:41:24 +01003681 PyUnicode_FSDecoder, &pathname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003682 &fob))
3683 return NULL;
Victor Stinner2f42ae52011-03-20 00:41:24 +01003684 fp = get_file(pathname, fob, "rb");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003685 if (fp == NULL) {
Victor Stinnerebc00522010-12-03 17:06:43 +00003686 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003687 return NULL;
3688 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01003689 m = load_compiled_module(name, pathname, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003690 fclose(fp);
Victor Stinnerebc00522010-12-03 17:06:43 +00003691 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003692 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003693}
3694
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003695#ifdef HAVE_DYNAMIC_LOADING
3696
Guido van Rossum79f25d91997-04-29 20:08:16 +00003697static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003698imp_load_dynamic(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003699{
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003700 PyObject *name, *pathname, *fob = NULL, *mod;
3701 FILE *fp;
3702
3703 if (!PyArg_ParseTuple(args, "UO&|O:load_dynamic",
3704 &name, PyUnicode_FSDecoder, &pathname, &fob))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003705 return NULL;
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003706 if (fob != NULL) {
3707 fp = get_file(NULL, fob, "r");
3708 if (fp == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003709 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003710 }
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003711 else
3712 fp = NULL;
3713 mod = _PyImport_LoadDynamicModule(name, pathname, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003714 if (fp)
3715 fclose(fp);
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003716 return mod;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003717}
3718
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003719#endif /* HAVE_DYNAMIC_LOADING */
3720
Guido van Rossum79f25d91997-04-29 20:08:16 +00003721static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003722imp_load_source(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003723{
Victor Stinner2f42ae52011-03-20 00:41:24 +01003724 PyObject *name, *pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003725 PyObject *fob = NULL;
3726 PyObject *m;
3727 FILE *fp;
Victor Stinner2f42ae52011-03-20 00:41:24 +01003728 if (!PyArg_ParseTuple(args, "UO&|O:load_source",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003729 &name,
Victor Stinner2f42ae52011-03-20 00:41:24 +01003730 PyUnicode_FSDecoder, &pathname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003731 &fob))
3732 return NULL;
Victor Stinner2f42ae52011-03-20 00:41:24 +01003733 fp = get_file(pathname, fob, "r");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003734 if (fp == NULL) {
Victor Stinnerebc00522010-12-03 17:06:43 +00003735 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003736 return NULL;
3737 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01003738 m = load_source_module(name, pathname, fp);
Victor Stinnerebc00522010-12-03 17:06:43 +00003739 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003740 fclose(fp);
3741 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003742}
3743
Guido van Rossum79f25d91997-04-29 20:08:16 +00003744static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003745imp_load_module(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003746{
Victor Stinner6ae1e7f2011-03-20 22:37:17 +01003747 PyObject *name, *fob, *pathname, *pathname_obj, *ret;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003748 char *suffix; /* Unused */
3749 char *mode;
3750 int type;
3751 FILE *fp;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003752
Victor Stinner6ae1e7f2011-03-20 22:37:17 +01003753 if (!PyArg_ParseTuple(args, "UOO(ssi):load_module",
3754 &name, &fob, &pathname_obj, &suffix, &mode, &type))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003755 return NULL;
Victor Stinner6ae1e7f2011-03-20 22:37:17 +01003756 if (pathname_obj != Py_None) {
3757 if (!PyUnicode_FSDecoder(pathname_obj, &pathname))
3758 return NULL;
3759 }
3760 else
3761 pathname = NULL;
3762
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003763 if (*mode) {
3764 /* Mode must start with 'r' or 'U' and must not contain '+'.
3765 Implicit in this test is the assumption that the mode
3766 may contain other modifiers like 'b' or 't'. */
Guido van Rossum5e2c5fa2002-05-30 17:33:07 +00003767
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003768 if (!(*mode == 'r' || *mode == 'U') || strchr(mode, '+')) {
3769 PyErr_Format(PyExc_ValueError,
3770 "invalid file open mode %.200s", mode);
Victor Stinner6ae1e7f2011-03-20 22:37:17 +01003771 Py_XDECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003772 return NULL;
3773 }
3774 }
3775 if (fob == Py_None)
3776 fp = NULL;
3777 else {
3778 fp = get_file(NULL, fob, mode);
3779 if (fp == NULL) {
Victor Stinner6ae1e7f2011-03-20 22:37:17 +01003780 Py_XDECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003781 return NULL;
3782 }
3783 }
Victor Stinner41c5fec2011-03-13 21:46:30 -04003784 ret = load_module(name, fp, pathname, type, NULL);
Victor Stinner6ae1e7f2011-03-20 22:37:17 +01003785 Py_XDECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003786 if (fp)
3787 fclose(fp);
3788 return ret;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003789}
3790
3791static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003792imp_load_package(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003793{
Victor Stinnerc9abda02011-03-14 13:33:46 -04003794 PyObject *name, *pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003795 PyObject * ret;
Victor Stinnerc9abda02011-03-14 13:33:46 -04003796 if (!PyArg_ParseTuple(args, "UO&:load_package",
3797 &name, PyUnicode_FSDecoder, &pathname))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003798 return NULL;
Victor Stinnerc9abda02011-03-14 13:33:46 -04003799 ret = load_package(name, pathname);
Victor Stinnerebc00522010-12-03 17:06:43 +00003800 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003801 return ret;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003802}
3803
3804static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003805imp_new_module(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003806{
Victor Stinnerfe19d212011-03-14 14:53:28 -04003807 PyObject *name;
3808 if (!PyArg_ParseTuple(args, "U:new_module", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003809 return NULL;
Victor Stinnerfe19d212011-03-14 14:53:28 -04003810 return PyModule_NewObject(name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003811}
3812
Christian Heimes13a7a212008-01-07 17:13:09 +00003813static PyObject *
3814imp_reload(PyObject *self, PyObject *v)
3815{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003816 return PyImport_ReloadModule(v);
Christian Heimes13a7a212008-01-07 17:13:09 +00003817}
3818
3819PyDoc_STRVAR(doc_reload,
3820"reload(module) -> module\n\
3821\n\
3822Reload the module. The module must have been successfully imported before.");
3823
Barry Warsaw28a691b2010-04-17 00:19:56 +00003824static PyObject *
3825imp_cache_from_source(PyObject *self, PyObject *args, PyObject *kws)
3826{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003827 static char *kwlist[] = {"path", "debug_override", NULL};
Barry Warsaw28a691b2010-04-17 00:19:56 +00003828
Victor Stinner2f42ae52011-03-20 00:41:24 +01003829 PyObject *pathname, *cpathname;
Benjamin Peterson294a9fc2010-10-16 03:12:39 +00003830 PyObject *debug_override = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003831 int debug = !Py_OptimizeFlag;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003832
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003833 if (!PyArg_ParseTupleAndKeywords(
Victor Stinner3ea23dd2010-10-15 20:34:32 +00003834 args, kws, "O&|O", kwlist,
Victor Stinner2f42ae52011-03-20 00:41:24 +01003835 PyUnicode_FSDecoder, &pathname, &debug_override))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003836 return NULL;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003837
Benjamin Peterson294a9fc2010-10-16 03:12:39 +00003838 if (debug_override != NULL &&
3839 (debug = PyObject_IsTrue(debug_override)) < 0) {
Victor Stinner2f42ae52011-03-20 00:41:24 +01003840 Py_DECREF(pathname);
Benjamin Peterson294a9fc2010-10-16 03:12:39 +00003841 return NULL;
3842 }
Barry Warsaw28a691b2010-04-17 00:19:56 +00003843
Victor Stinner3ea23dd2010-10-15 20:34:32 +00003844 cpathname = make_compiled_pathname(
Victor Stinner2f42ae52011-03-20 00:41:24 +01003845 PyUnicode_AS_UNICODE(pathname),
3846 debug);
3847 Py_DECREF(pathname);
Barry Warsaw28a691b2010-04-17 00:19:56 +00003848
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003849 if (cpathname == NULL) {
3850 PyErr_Format(PyExc_SystemError, "path buffer too short");
3851 return NULL;
3852 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01003853 return cpathname;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003854}
3855
3856PyDoc_STRVAR(doc_cache_from_source,
3857"Given the path to a .py file, return the path to its .pyc/.pyo file.\n\
3858\n\
3859The .py file does not need to exist; this simply returns the path to the\n\
3860.pyc/.pyo file calculated as if the .py file were imported. The extension\n\
3861will be .pyc unless __debug__ is not defined, then it will be .pyo.\n\
3862\n\
3863If debug_override is not None, then it must be a boolean and is taken as\n\
3864the value of __debug__ instead.");
3865
3866static PyObject *
3867imp_source_from_cache(PyObject *self, PyObject *args, PyObject *kws)
3868{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003869 static char *kwlist[] = {"path", NULL};
Victor Stinnerc9abda02011-03-14 13:33:46 -04003870 PyObject *pathname, *source;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003871
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003872 if (!PyArg_ParseTupleAndKeywords(
Victor Stinnerebc00522010-12-03 17:06:43 +00003873 args, kws, "O&", kwlist,
Victor Stinnerc9abda02011-03-14 13:33:46 -04003874 PyUnicode_FSDecoder, &pathname))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003875 return NULL;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003876
Victor Stinnerc9abda02011-03-14 13:33:46 -04003877 source = make_source_pathname(pathname);
3878 if (source == NULL) {
3879 PyErr_Format(PyExc_ValueError, "Not a PEP 3147 pyc path: %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003880 pathname);
Victor Stinnerc9abda02011-03-14 13:33:46 -04003881 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003882 return NULL;
3883 }
Victor Stinnerc9abda02011-03-14 13:33:46 -04003884 Py_DECREF(pathname);
3885 return source;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003886}
3887
3888PyDoc_STRVAR(doc_source_from_cache,
3889"Given the path to a .pyc./.pyo file, return the path to its .py file.\n\
3890\n\
3891The .pyc/.pyo file does not need to exist; this simply returns the path to\n\
3892the .py file calculated to correspond to the .pyc/.pyo file. If path\n\
3893does not conform to PEP 3147 format, ValueError will be raised.");
3894
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003895/* Doc strings */
3896
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003897PyDoc_STRVAR(doc_imp,
3898"This module provides the components needed to build your own\n\
3899__import__ function. Undocumented functions are obsolete.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003900
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003901PyDoc_STRVAR(doc_find_module,
3902"find_module(name, [path]) -> (file, filename, (suffix, mode, type))\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003903Search for a module. If path is omitted or None, search for a\n\
3904built-in, frozen or special module and continue search in sys.path.\n\
3905The module name cannot contain '.'; to search for a submodule of a\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003906package, pass the submodule name and the package's __path__.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003907
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003908PyDoc_STRVAR(doc_load_module,
3909"load_module(name, file, filename, (suffix, mode, type)) -> module\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003910Load a module, given information returned by find_module().\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003911The module name must include the full package name, if any.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003912
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003913PyDoc_STRVAR(doc_get_magic,
3914"get_magic() -> string\n\
3915Return the magic number for .pyc or .pyo files.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003916
Barry Warsaw28a691b2010-04-17 00:19:56 +00003917PyDoc_STRVAR(doc_get_tag,
3918"get_tag() -> string\n\
3919Return the magic tag for .pyc or .pyo files.");
3920
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003921PyDoc_STRVAR(doc_get_suffixes,
3922"get_suffixes() -> [(suffix, mode, type), ...]\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003923Return a list of (suffix, mode, type) tuples describing the files\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003924that find_module() looks for.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003925
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003926PyDoc_STRVAR(doc_new_module,
3927"new_module(name) -> module\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003928Create a new module. Do not enter it in sys.modules.\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003929The module name must include the full package name, if any.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003930
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003931PyDoc_STRVAR(doc_lock_held,
Tim Petersa7c65092004-08-01 23:26:05 +00003932"lock_held() -> boolean\n\
3933Return True if the import lock is currently held, else False.\n\
3934On platforms without threads, return False.");
Tim Peters69232342001-08-30 05:16:13 +00003935
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00003936PyDoc_STRVAR(doc_acquire_lock,
3937"acquire_lock() -> None\n\
Neal Norwitz2294c0d2003-02-12 23:02:21 +00003938Acquires the interpreter's import lock for the current thread.\n\
3939This lock should be used by import hooks to ensure thread-safety\n\
3940when importing modules.\n\
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00003941On platforms without threads, this function does nothing.");
3942
3943PyDoc_STRVAR(doc_release_lock,
3944"release_lock() -> None\n\
3945Release the interpreter's import lock.\n\
3946On platforms without threads, this function does nothing.");
3947
Guido van Rossum79f25d91997-04-29 20:08:16 +00003948static PyMethodDef imp_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003949 {"find_module", imp_find_module, METH_VARARGS, doc_find_module},
3950 {"get_magic", imp_get_magic, METH_NOARGS, doc_get_magic},
3951 {"get_tag", imp_get_tag, METH_NOARGS, doc_get_tag},
3952 {"get_suffixes", imp_get_suffixes, METH_NOARGS, doc_get_suffixes},
3953 {"load_module", imp_load_module, METH_VARARGS, doc_load_module},
3954 {"new_module", imp_new_module, METH_VARARGS, doc_new_module},
3955 {"lock_held", imp_lock_held, METH_NOARGS, doc_lock_held},
3956 {"acquire_lock", imp_acquire_lock, METH_NOARGS, doc_acquire_lock},
3957 {"release_lock", imp_release_lock, METH_NOARGS, doc_release_lock},
3958 {"reload", imp_reload, METH_O, doc_reload},
3959 {"cache_from_source", (PyCFunction)imp_cache_from_source,
3960 METH_VARARGS | METH_KEYWORDS, doc_cache_from_source},
3961 {"source_from_cache", (PyCFunction)imp_source_from_cache,
3962 METH_VARARGS | METH_KEYWORDS, doc_source_from_cache},
3963 /* The rest are obsolete */
3964 {"get_frozen_object", imp_get_frozen_object, METH_VARARGS},
3965 {"is_frozen_package", imp_is_frozen_package, METH_VARARGS},
3966 {"init_builtin", imp_init_builtin, METH_VARARGS},
3967 {"init_frozen", imp_init_frozen, METH_VARARGS},
3968 {"is_builtin", imp_is_builtin, METH_VARARGS},
3969 {"is_frozen", imp_is_frozen, METH_VARARGS},
3970 {"load_compiled", imp_load_compiled, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003971#ifdef HAVE_DYNAMIC_LOADING
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003972 {"load_dynamic", imp_load_dynamic, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003973#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003974 {"load_package", imp_load_package, METH_VARARGS},
3975 {"load_source", imp_load_source, METH_VARARGS},
3976 {NULL, NULL} /* sentinel */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003977};
3978
Guido van Rossum1a8791e1998-08-04 22:46:29 +00003979static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003980setint(PyObject *d, char *name, int value)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003981{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003982 PyObject *v;
3983 int err;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003984
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003985 v = PyLong_FromLong((long)value);
3986 err = PyDict_SetItemString(d, name, v);
3987 Py_XDECREF(v);
3988 return err;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003989}
3990
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003991typedef struct {
3992 PyObject_HEAD
3993} NullImporter;
3994
3995static int
3996NullImporter_init(NullImporter *self, PyObject *args, PyObject *kwds)
3997{
Victor Stinner1a4d12d2010-08-13 13:07:29 +00003998#ifndef MS_WINDOWS
3999 PyObject *path;
4000 struct stat statbuf;
4001 int rv;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004002
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004003 if (!_PyArg_NoKeywords("NullImporter()", kwds))
4004 return -1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004005
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004006 if (!PyArg_ParseTuple(args, "O&:NullImporter",
4007 PyUnicode_FSConverter, &path))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004008 return -1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004009
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004010 if (PyBytes_GET_SIZE(path) == 0) {
4011 Py_DECREF(path);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004012 PyErr_SetString(PyExc_ImportError, "empty pathname");
4013 return -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004014 }
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004015
4016 rv = stat(PyBytes_AS_STRING(path), &statbuf);
4017 Py_DECREF(path);
4018 if (rv == 0) {
4019 /* it exists */
4020 if (S_ISDIR(statbuf.st_mode)) {
4021 /* it's a directory */
4022 PyErr_SetString(PyExc_ImportError, "existing directory");
4023 return -1;
4024 }
4025 }
4026#else /* MS_WINDOWS */
4027 PyObject *pathobj;
4028 DWORD rv;
Victor Stinner255dfdb2010-09-29 10:28:51 +00004029 wchar_t *path;
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004030
4031 if (!_PyArg_NoKeywords("NullImporter()", kwds))
4032 return -1;
4033
4034 if (!PyArg_ParseTuple(args, "U:NullImporter",
4035 &pathobj))
4036 return -1;
4037
4038 if (PyUnicode_GET_SIZE(pathobj) == 0) {
4039 PyErr_SetString(PyExc_ImportError, "empty pathname");
4040 return -1;
4041 }
4042
Victor Stinnerbeb4135b2010-10-07 01:02:42 +00004043 path = PyUnicode_AsWideCharString(pathobj, NULL);
Victor Stinner255dfdb2010-09-29 10:28:51 +00004044 if (path == NULL)
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004045 return -1;
4046 /* see issue1293 and issue3677:
4047 * stat() on Windows doesn't recognise paths like
4048 * "e:\\shared\\" and "\\\\whiterab-c2znlh\\shared" as dirs.
4049 */
4050 rv = GetFileAttributesW(path);
Victor Stinner255dfdb2010-09-29 10:28:51 +00004051 PyMem_Free(path);
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004052 if (rv != INVALID_FILE_ATTRIBUTES) {
4053 /* it exists */
4054 if (rv & FILE_ATTRIBUTE_DIRECTORY) {
4055 /* it's a directory */
4056 PyErr_SetString(PyExc_ImportError, "existing directory");
4057 return -1;
4058 }
4059 }
4060#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004061 return 0;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004062}
4063
4064static PyObject *
4065NullImporter_find_module(NullImporter *self, PyObject *args)
4066{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004067 Py_RETURN_NONE;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004068}
4069
4070static PyMethodDef NullImporter_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004071 {"find_module", (PyCFunction)NullImporter_find_module, METH_VARARGS,
4072 "Always return None"
4073 },
4074 {NULL} /* Sentinel */
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004075};
4076
4077
Christian Heimes9cd17752007-11-18 19:35:23 +00004078PyTypeObject PyNullImporter_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004079 PyVarObject_HEAD_INIT(NULL, 0)
4080 "imp.NullImporter", /*tp_name*/
4081 sizeof(NullImporter), /*tp_basicsize*/
4082 0, /*tp_itemsize*/
4083 0, /*tp_dealloc*/
4084 0, /*tp_print*/
4085 0, /*tp_getattr*/
4086 0, /*tp_setattr*/
4087 0, /*tp_reserved*/
4088 0, /*tp_repr*/
4089 0, /*tp_as_number*/
4090 0, /*tp_as_sequence*/
4091 0, /*tp_as_mapping*/
4092 0, /*tp_hash */
4093 0, /*tp_call*/
4094 0, /*tp_str*/
4095 0, /*tp_getattro*/
4096 0, /*tp_setattro*/
4097 0, /*tp_as_buffer*/
4098 Py_TPFLAGS_DEFAULT, /*tp_flags*/
4099 "Null importer object", /* tp_doc */
4100 0, /* tp_traverse */
4101 0, /* tp_clear */
4102 0, /* tp_richcompare */
4103 0, /* tp_weaklistoffset */
4104 0, /* tp_iter */
4105 0, /* tp_iternext */
4106 NullImporter_methods, /* tp_methods */
4107 0, /* tp_members */
4108 0, /* tp_getset */
4109 0, /* tp_base */
4110 0, /* tp_dict */
4111 0, /* tp_descr_get */
4112 0, /* tp_descr_set */
4113 0, /* tp_dictoffset */
4114 (initproc)NullImporter_init, /* tp_init */
4115 0, /* tp_alloc */
4116 PyType_GenericNew /* tp_new */
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004117};
4118
Martin v. Löwis1a214512008-06-11 05:26:20 +00004119static struct PyModuleDef impmodule = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004120 PyModuleDef_HEAD_INIT,
4121 "imp",
4122 doc_imp,
4123 0,
4124 imp_methods,
4125 NULL,
4126 NULL,
4127 NULL,
4128 NULL
Martin v. Löwis1a214512008-06-11 05:26:20 +00004129};
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004130
Jason Tishler6bc06ec2003-09-04 11:59:50 +00004131PyMODINIT_FUNC
Martin v. Löwis1a214512008-06-11 05:26:20 +00004132PyInit_imp(void)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004133{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004134 PyObject *m, *d;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004135
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004136 if (PyType_Ready(&PyNullImporter_Type) < 0)
4137 return NULL;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004138
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004139 m = PyModule_Create(&impmodule);
4140 if (m == NULL)
4141 goto failure;
4142 d = PyModule_GetDict(m);
4143 if (d == NULL)
4144 goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004145
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004146 if (setint(d, "SEARCH_ERROR", SEARCH_ERROR) < 0) goto failure;
4147 if (setint(d, "PY_SOURCE", PY_SOURCE) < 0) goto failure;
4148 if (setint(d, "PY_COMPILED", PY_COMPILED) < 0) goto failure;
4149 if (setint(d, "C_EXTENSION", C_EXTENSION) < 0) goto failure;
4150 if (setint(d, "PY_RESOURCE", PY_RESOURCE) < 0) goto failure;
4151 if (setint(d, "PKG_DIRECTORY", PKG_DIRECTORY) < 0) goto failure;
4152 if (setint(d, "C_BUILTIN", C_BUILTIN) < 0) goto failure;
4153 if (setint(d, "PY_FROZEN", PY_FROZEN) < 0) goto failure;
4154 if (setint(d, "PY_CODERESOURCE", PY_CODERESOURCE) < 0) goto failure;
4155 if (setint(d, "IMP_HOOK", IMP_HOOK) < 0) goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004156
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004157 Py_INCREF(&PyNullImporter_Type);
4158 PyModule_AddObject(m, "NullImporter", (PyObject *)&PyNullImporter_Type);
4159 return m;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00004160 failure:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004161 Py_XDECREF(m);
4162 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004163}
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004164
4165
Guido van Rossumb18618d2000-05-03 23:44:39 +00004166/* API for embedding applications that want to add their own entries
4167 to the table of built-in modules. This should normally be called
4168 *before* Py_Initialize(). When the table resize fails, -1 is
4169 returned and the existing table is unchanged.
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004170
4171 After a similar function by Just van Rossum. */
4172
4173int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00004174PyImport_ExtendInittab(struct _inittab *newtab)
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004175{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004176 static struct _inittab *our_copy = NULL;
4177 struct _inittab *p;
4178 int i, n;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004179
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004180 /* Count the number of entries in both tables */
4181 for (n = 0; newtab[n].name != NULL; n++)
4182 ;
4183 if (n == 0)
4184 return 0; /* Nothing to do */
4185 for (i = 0; PyImport_Inittab[i].name != NULL; i++)
4186 ;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004187
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004188 /* Allocate new memory for the combined table */
4189 p = our_copy;
4190 PyMem_RESIZE(p, struct _inittab, i+n+1);
4191 if (p == NULL)
4192 return -1;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004193
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004194 /* Copy the tables into the new memory */
4195 if (our_copy != PyImport_Inittab)
4196 memcpy(p, PyImport_Inittab, (i+1) * sizeof(struct _inittab));
4197 PyImport_Inittab = our_copy = p;
4198 memcpy(p+i, newtab, (n+1) * sizeof(struct _inittab));
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004199
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004200 return 0;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004201}
4202
4203/* Shorthand to add a single entry given a name and a function */
4204
4205int
Brett Cannona826f322009-04-02 03:41:46 +00004206PyImport_AppendInittab(const char *name, PyObject* (*initfunc)(void))
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004207{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004208 struct _inittab newtab[2];
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004209
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004210 memset(newtab, '\0', sizeof newtab);
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004211
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004212 newtab[0].name = (char *)name;
4213 newtab[0].initfunc = initfunc;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004214
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004215 return PyImport_ExtendInittab(newtab);
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004216}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00004217
4218#ifdef __cplusplus
4219}
4220#endif