blob: 8a242a57eb4a55d02e56355bb3e8b70687441fd2 [file] [log] [blame]
Guido van Rossumf70e43a1991-02-19 12:39:46 +00001
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002/* Module definition and import implementation */
3
Guido van Rossum79f25d91997-04-29 20:08:16 +00004#include "Python.h"
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00005
Jeremy Hylton3e0055f2005-10-20 19:59:25 +00006#include "Python-ast.h"
Guido van Rossumd8faa362007-04-27 19:54:29 +00007#undef Yield /* undefine macro conflicting with winbase.h */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00008#include "errcode.h"
Guido van Rossumc405b7b1991-06-04 19:39:42 +00009#include "marshal.h"
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000010#include "code.h"
Guido van Rossumd8bac6d1992-02-26 15:19:13 +000011#include "osdefs.h"
Guido van Rossum1ae940a1995-01-02 19:04:15 +000012#include "importdl.h"
Guido van Rossumc405b7b1991-06-04 19:39:42 +000013
Guido van Rossum55a83382000-09-20 20:31:38 +000014#ifdef HAVE_FCNTL_H
15#include <fcntl.h>
16#endif
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000017#ifdef __cplusplus
Brett Cannon9a5b25a2010-03-01 02:09:17 +000018extern "C" {
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000019#endif
Guido van Rossum55a83382000-09-20 20:31:38 +000020
Christian Heimesd3eb5a152008-02-24 00:38:49 +000021#ifdef MS_WINDOWS
22/* for stat.st_mode */
23typedef unsigned short mode_t;
Daniel Stutzbachc7937792010-09-09 21:18:04 +000024/* for _mkdir */
25#include <direct.h>
Christian Heimesd3eb5a152008-02-24 00:38:49 +000026#endif
27
Guido van Rossum21d335e1993-10-15 13:01:11 +000028
Jeremy Hyltond4ceb312004-04-01 02:45:22 +000029/* Magic word to reject .pyc files generated by other Python versions.
30 It should change for each incompatible change to the bytecode.
31
32 The value of CR and LF is incorporated so if you ever read or write
Guido van Rossum7faeab31995-07-07 22:50:36 +000033 a .pyc file in text mode the magic number will be wrong; also, the
Tim Peters36515e22001-11-18 04:06:29 +000034 Apple MPW compiler swaps their values, botching string constants.
Marc-André Lemburgbd3be8f2002-02-07 11:33:49 +000035
Guido van Rossum45aecf42006-03-15 04:58:47 +000036 The magic numbers must be spaced apart at least 2 values, as the
Martin v. Löwisef82d2f2004-06-27 16:51:46 +000037 -U interpeter flag will cause MAGIC+1 being used. They have been
38 odd numbers for some time now.
Marc-André Lemburgbd3be8f2002-02-07 11:33:49 +000039
Jeremy Hyltond4ceb312004-04-01 02:45:22 +000040 There were a variety of old schemes for setting the magic number.
41 The current working scheme is to increment the previous value by
42 10.
Guido van Rossumf6894922002-08-31 15:16:14 +000043
Barry Warsaw28a691b2010-04-17 00:19:56 +000044 Starting with the adoption of PEP 3147 in Python 3.2, every bump in magic
45 number also includes a new "magic tag", i.e. a human readable string used
46 to represent the magic number in __pycache__ directories. When you change
47 the magic number, you must also set a new unique magic tag. Generally this
48 can be named after the Python major version of the magic number bump, but
49 it can really be anything, as long as it's different than anything else
50 that's come before. The tags are included in the following table, starting
51 with Python 3.2a0.
52
Marc-André Lemburgbd3be8f2002-02-07 11:33:49 +000053 Known values:
54 Python 1.5: 20121
55 Python 1.5.1: 20121
56 Python 1.5.2: 20121
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000057 Python 1.6: 50428
Marc-André Lemburgbd3be8f2002-02-07 11:33:49 +000058 Python 2.0: 50823
59 Python 2.0.1: 50823
60 Python 2.1: 60202
61 Python 2.1.1: 60202
62 Python 2.1.2: 60202
63 Python 2.2: 60717
Neal Norwitz7fdcb412002-06-14 01:07:39 +000064 Python 2.3a0: 62011
Michael W. Hudsondd32a912002-08-15 14:59:02 +000065 Python 2.3a0: 62021
Guido van Rossumf6894922002-08-31 15:16:14 +000066 Python 2.3a0: 62011 (!)
Martin v. Löwisef82d2f2004-06-27 16:51:46 +000067 Python 2.4a0: 62041
Raymond Hettingerfd2d1f72004-08-23 23:37:48 +000068 Python 2.4a3: 62051
Raymond Hettinger2c31a052004-09-22 18:44:21 +000069 Python 2.4b1: 62061
Michael W. Hudsondf888462005-06-03 14:41:55 +000070 Python 2.5a0: 62071
Michael W. Hudsonaee2e282005-10-21 11:32:20 +000071 Python 2.5a0: 62081 (ast-branch)
Guido van Rossumc2e20742006-02-27 22:32:47 +000072 Python 2.5a0: 62091 (with)
Guido van Rossumf6694362006-03-10 02:28:35 +000073 Python 2.5a0: 62092 (changed WITH_CLEANUP opcode)
Thomas Wouters0e3f5912006-08-11 14:57:12 +000074 Python 2.5b3: 62101 (fix wrong code: for x, in ...)
75 Python 2.5b3: 62111 (fix wrong code: x += yield)
76 Python 2.5c1: 62121 (fix wrong lnotab with for loops and
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000077 storing constants that should have been removed)
Thomas Wouters89f507f2006-12-13 04:49:30 +000078 Python 2.5c2: 62131 (fix wrong code: for x, in ... in listcomp/genexp)
Christian Heimes99170a52007-12-19 02:07:34 +000079 Python 2.6a0: 62151 (peephole optimizations and STORE_MAP opcode)
Christian Heimesdd15f6c2008-03-16 00:07:10 +000080 Python 2.6a1: 62161 (WITH_CLEANUP optimization)
Guido van Rossum45aecf42006-03-15 04:58:47 +000081 Python 3000: 3000
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000082 3010 (removed UNARY_CONVERT)
83 3020 (added BUILD_SET)
84 3030 (added keyword-only parameters)
85 3040 (added signature annotations)
86 3050 (print becomes a function)
87 3060 (PEP 3115 metaclass syntax)
88 3061 (string literals become unicode)
89 3071 (PEP 3109 raise changes)
90 3081 (PEP 3137 make __file__ and __name__ unicode)
91 3091 (kill str8 interning)
92 3101 (merge from 2.6a0, see 62151)
93 3103 (__file__ points to source file)
Benjamin Peterson0f6cae02009-12-10 02:09:08 +000094 Python 3.0a4: 3111 (WITH_CLEANUP optimization).
95 Python 3.0a5: 3131 (lexical exception stacking, including POP_EXCEPT)
96 Python 3.1a0: 3141 (optimize list, set and dict comprehensions:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000097 change LIST_APPEND and SET_ADD, add MAP_ADD)
Benjamin Peterson0f6cae02009-12-10 02:09:08 +000098 Python 3.1a0: 3151 (optimize conditional branches:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000099 introduce POP_JUMP_IF_FALSE and POP_JUMP_IF_TRUE)
Benjamin Peterson876b2f22009-06-28 03:18:59 +0000100 Python 3.2a0: 3160 (add SETUP_WITH)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000101 tag: cpython-32
Antoine Pitrou74a69fa2010-09-04 18:43:52 +0000102 Python 3.2a1: 3170 (add DUP_TOP_TWO, remove DUP_TOPX and ROT_FOUR)
103 tag: cpython-32
Benjamin Peterson6246d6d2010-09-10 21:51:44 +0000104 Python 3.2a2 3180 (add DELETE_DEREF)
Tim Peters36515e22001-11-18 04:06:29 +0000105*/
Guido van Rossum3ddee711991-12-16 13:06:34 +0000106
Nick Coghlancd419ab2010-09-11 00:39:25 +0000107/* MAGIC must change whenever the bytecode emitted by the compiler may no
108 longer be understood by older implementations of the eval loop (usually
109 due to the addition of new opcodes)
Victor Stinner2f42ae52011-03-20 00:41:24 +0100110 TAG and PYC_TAG_UNICODE must change for each major Python release. The magic
111 number will take care of any bytecode changes that occur during development.
Barry Warsaw28a691b2010-04-17 00:19:56 +0000112*/
Benjamin Peterson6246d6d2010-09-10 21:51:44 +0000113#define MAGIC (3180 | ((long)'\r'<<16) | ((long)'\n'<<24))
Barry Warsaw28a691b2010-04-17 00:19:56 +0000114#define TAG "cpython-32"
115#define CACHEDIR "__pycache__"
Victor Stinnerc9abda02011-03-14 13:33:46 -0400116static const Py_UNICODE CACHEDIR_UNICODE[] = {
117 '_', '_', 'p', 'y', 'c', 'a', 'c', 'h', 'e', '_', '_', '\0'};
Barry Warsaw28a691b2010-04-17 00:19:56 +0000118/* Current magic word and string tag as globals. */
Guido van Rossum96774c12000-05-01 20:19:08 +0000119static long pyc_magic = MAGIC;
Barry Warsaw28a691b2010-04-17 00:19:56 +0000120static const char *pyc_tag = TAG;
Victor Stinner2f42ae52011-03-20 00:41:24 +0100121static const Py_UNICODE PYC_TAG_UNICODE[] = {
122 'c', 'p', 'y', 't', 'h', 'o', 'n', '-', '3', '2', '\0'};
Guido van Rossum96774c12000-05-01 20:19:08 +0000123
Victor Stinner95872862011-03-07 18:20:56 +0100124/* See _PyImport_FixupExtensionObject() below */
Guido van Rossum25ce5661997-08-02 03:10:38 +0000125static PyObject *extensions = NULL;
Guido van Rossum3f5da241990-12-20 15:06:42 +0000126
Guido van Rossum771c6c81997-10-31 18:37:24 +0000127/* This table is defined in config.c: */
128extern struct _inittab _PyImport_Inittab[];
129
Guido van Rossumce3a72a2007-10-19 23:16:50 +0000130/* Method from Parser/tokenizer.c */
Guido van Rossum40d20bc2007-10-22 00:09:51 +0000131extern char * PyTokenizer_FindEncoding(int);
Guido van Rossumce3a72a2007-10-19 23:16:50 +0000132
Guido van Rossum771c6c81997-10-31 18:37:24 +0000133struct _inittab *PyImport_Inittab = _PyImport_Inittab;
Guido van Rossum66f1fa81991-04-03 19:03:52 +0000134
Guido van Rossumed1170e1999-12-20 21:23:41 +0000135/* these tables define the module suffixes that Python recognizes */
136struct filedescr * _PyImport_Filetab = NULL;
Guido van Rossum48a680c2001-03-02 06:34:14 +0000137
Guido van Rossumed1170e1999-12-20 21:23:41 +0000138static const struct filedescr _PyImport_StandardFiletab[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000139 {".py", "U", PY_SOURCE},
Martin v. Löwis6238d2b2002-06-30 15:26:10 +0000140#ifdef MS_WINDOWS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000141 {".pyw", "U", PY_SOURCE},
Tim Peters36515e22001-11-18 04:06:29 +0000142#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000143 {".pyc", "rb", PY_COMPILED},
144 {0, 0}
Guido van Rossumed1170e1999-12-20 21:23:41 +0000145};
146
Victor Stinnerd0296212011-03-14 14:04:10 -0400147static PyObject *initstr = NULL;
148
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000149
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000150/* Initialize things */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000151
152void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000153_PyImport_Init(void)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000154{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000155 const struct filedescr *scan;
156 struct filedescr *filetab;
157 int countD = 0;
158 int countS = 0;
Guido van Rossumed1170e1999-12-20 21:23:41 +0000159
Victor Stinnerd0296212011-03-14 14:04:10 -0400160 initstr = PyUnicode_InternFromString("__init__");
161 if (initstr == NULL)
162 Py_FatalError("Can't initialize import variables");
163
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000164 /* prepare _PyImport_Filetab: copy entries from
165 _PyImport_DynLoadFiletab and _PyImport_StandardFiletab.
166 */
Guido van Rossum04110fb2007-08-24 16:32:05 +0000167#ifdef HAVE_DYNAMIC_LOADING
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000168 for (scan = _PyImport_DynLoadFiletab; scan->suffix != NULL; ++scan)
169 ++countD;
Guido van Rossum04110fb2007-08-24 16:32:05 +0000170#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000171 for (scan = _PyImport_StandardFiletab; scan->suffix != NULL; ++scan)
172 ++countS;
173 filetab = PyMem_NEW(struct filedescr, countD + countS + 1);
174 if (filetab == NULL)
175 Py_FatalError("Can't initialize import file table.");
Guido van Rossum04110fb2007-08-24 16:32:05 +0000176#ifdef HAVE_DYNAMIC_LOADING
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000177 memcpy(filetab, _PyImport_DynLoadFiletab,
178 countD * sizeof(struct filedescr));
Guido van Rossum04110fb2007-08-24 16:32:05 +0000179#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000180 memcpy(filetab + countD, _PyImport_StandardFiletab,
181 countS * sizeof(struct filedescr));
182 filetab[countD + countS].suffix = NULL;
Guido van Rossumed1170e1999-12-20 21:23:41 +0000183
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000184 _PyImport_Filetab = filetab;
Guido van Rossumed1170e1999-12-20 21:23:41 +0000185
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000186 if (Py_OptimizeFlag) {
187 /* Replace ".pyc" with ".pyo" in _PyImport_Filetab */
188 for (; filetab->suffix != NULL; filetab++) {
189 if (strcmp(filetab->suffix, ".pyc") == 0)
190 filetab->suffix = ".pyo";
191 }
192 }
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000193}
194
Guido van Rossum25ce5661997-08-02 03:10:38 +0000195void
Just van Rossum52e14d62002-12-30 22:08:05 +0000196_PyImportHooks_Init(void)
197{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000198 PyObject *v, *path_hooks = NULL, *zimpimport;
199 int err = 0;
Just van Rossum52e14d62002-12-30 22:08:05 +0000200
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000201 /* adding sys.path_hooks and sys.path_importer_cache, setting up
202 zipimport */
203 if (PyType_Ready(&PyNullImporter_Type) < 0)
204 goto error;
Just van Rossum52e14d62002-12-30 22:08:05 +0000205
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000206 if (Py_VerboseFlag)
207 PySys_WriteStderr("# installing zipimport hook\n");
Just van Rossum52e14d62002-12-30 22:08:05 +0000208
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000209 v = PyList_New(0);
210 if (v == NULL)
211 goto error;
212 err = PySys_SetObject("meta_path", v);
213 Py_DECREF(v);
214 if (err)
215 goto error;
216 v = PyDict_New();
217 if (v == NULL)
218 goto error;
219 err = PySys_SetObject("path_importer_cache", v);
220 Py_DECREF(v);
221 if (err)
222 goto error;
223 path_hooks = PyList_New(0);
224 if (path_hooks == NULL)
225 goto error;
226 err = PySys_SetObject("path_hooks", path_hooks);
227 if (err) {
Just van Rossum52e14d62002-12-30 22:08:05 +0000228 error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000229 PyErr_Print();
230 Py_FatalError("initializing sys.meta_path, sys.path_hooks, "
231 "path_importer_cache, or NullImporter failed"
232 );
233 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000234
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000235 zimpimport = PyImport_ImportModule("zipimport");
236 if (zimpimport == NULL) {
237 PyErr_Clear(); /* No zip import module -- okay */
238 if (Py_VerboseFlag)
239 PySys_WriteStderr("# can't import zipimport\n");
240 }
241 else {
242 PyObject *zipimporter = PyObject_GetAttrString(zimpimport,
243 "zipimporter");
244 Py_DECREF(zimpimport);
245 if (zipimporter == NULL) {
246 PyErr_Clear(); /* No zipimporter object -- okay */
247 if (Py_VerboseFlag)
248 PySys_WriteStderr(
249 "# can't import zipimport.zipimporter\n");
250 }
251 else {
252 /* sys.path_hooks.append(zipimporter) */
253 err = PyList_Append(path_hooks, zipimporter);
254 Py_DECREF(zipimporter);
255 if (err)
256 goto error;
257 if (Py_VerboseFlag)
258 PySys_WriteStderr(
259 "# installed zipimport hook\n");
260 }
261 }
262 Py_DECREF(path_hooks);
Just van Rossum52e14d62002-12-30 22:08:05 +0000263}
264
265void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000266_PyImport_Fini(void)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000267{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000268 Py_XDECREF(extensions);
269 extensions = NULL;
270 PyMem_DEL(_PyImport_Filetab);
271 _PyImport_Filetab = NULL;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000272}
273
274
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000275/* Locking primitives to prevent parallel imports of the same module
276 in different threads to return with a partially loaded module.
277 These calls are serialized by the global interpreter lock. */
278
279#ifdef WITH_THREAD
280
Guido van Rossum49b56061998-10-01 20:42:43 +0000281#include "pythread.h"
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000282
Guido van Rossum65d5b571998-12-21 19:32:43 +0000283static PyThread_type_lock import_lock = 0;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000284static long import_lock_thread = -1;
285static int import_lock_level = 0;
286
Benjamin Peterson0df35a92009-10-04 20:32:25 +0000287void
288_PyImport_AcquireLock(void)
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000289{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000290 long me = PyThread_get_thread_ident();
291 if (me == -1)
292 return; /* Too bad */
293 if (import_lock == NULL) {
294 import_lock = PyThread_allocate_lock();
295 if (import_lock == NULL)
296 return; /* Nothing much we can do. */
297 }
298 if (import_lock_thread == me) {
299 import_lock_level++;
300 return;
301 }
302 if (import_lock_thread != -1 || !PyThread_acquire_lock(import_lock, 0))
303 {
304 PyThreadState *tstate = PyEval_SaveThread();
305 PyThread_acquire_lock(import_lock, 1);
306 PyEval_RestoreThread(tstate);
307 }
308 import_lock_thread = me;
309 import_lock_level = 1;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000310}
311
Benjamin Peterson0df35a92009-10-04 20:32:25 +0000312int
313_PyImport_ReleaseLock(void)
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000314{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000315 long me = PyThread_get_thread_ident();
316 if (me == -1 || import_lock == NULL)
317 return 0; /* Too bad */
318 if (import_lock_thread != me)
319 return -1;
320 import_lock_level--;
321 if (import_lock_level == 0) {
322 import_lock_thread = -1;
323 PyThread_release_lock(import_lock);
324 }
325 return 1;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000326}
327
Gregory P. Smith24cec9f2010-03-01 06:18:41 +0000328/* This function is called from PyOS_AfterFork to ensure that newly
329 created child processes do not share locks with the parent.
330 We now acquire the import lock around fork() calls but on some platforms
331 (Solaris 9 and earlier? see isue7242) that still left us with problems. */
Guido van Rossum8ee3e5a2005-09-14 18:09:42 +0000332
333void
334_PyImport_ReInitLock(void)
335{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000336 if (import_lock != NULL)
337 import_lock = PyThread_allocate_lock();
Nick Coghlanb2ddf792010-12-02 04:11:46 +0000338 if (import_lock_level > 1) {
339 /* Forked as a side effect of import */
340 long me = PyThread_get_thread_ident();
341 PyThread_acquire_lock(import_lock, 0);
Victor Stinner942003c2011-03-07 16:57:48 +0100342 /* XXX: can the previous line fail? */
Nick Coghlanb2ddf792010-12-02 04:11:46 +0000343 import_lock_thread = me;
344 import_lock_level--;
345 } else {
346 import_lock_thread = -1;
347 import_lock_level = 0;
348 }
Guido van Rossum8ee3e5a2005-09-14 18:09:42 +0000349}
350
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000351#endif
352
Tim Peters69232342001-08-30 05:16:13 +0000353static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000354imp_lock_held(PyObject *self, PyObject *noargs)
Tim Peters69232342001-08-30 05:16:13 +0000355{
Tim Peters69232342001-08-30 05:16:13 +0000356#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000357 return PyBool_FromLong(import_lock_thread != -1);
Tim Peters69232342001-08-30 05:16:13 +0000358#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000359 return PyBool_FromLong(0);
Tim Peters69232342001-08-30 05:16:13 +0000360#endif
361}
362
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000363static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000364imp_acquire_lock(PyObject *self, PyObject *noargs)
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000365{
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000366#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000367 _PyImport_AcquireLock();
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000368#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000369 Py_INCREF(Py_None);
370 return Py_None;
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000371}
372
373static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000374imp_release_lock(PyObject *self, PyObject *noargs)
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000375{
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000376#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000377 if (_PyImport_ReleaseLock() < 0) {
378 PyErr_SetString(PyExc_RuntimeError,
379 "not holding the import lock");
380 return NULL;
381 }
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000382#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000383 Py_INCREF(Py_None);
384 return Py_None;
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000385}
386
Guido van Rossumd8faa362007-04-27 19:54:29 +0000387static void
388imp_modules_reloading_clear(void)
389{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000390 PyInterpreterState *interp = PyThreadState_Get()->interp;
391 if (interp->modules_reloading != NULL)
392 PyDict_Clear(interp->modules_reloading);
Guido van Rossumd8faa362007-04-27 19:54:29 +0000393}
394
Guido van Rossum25ce5661997-08-02 03:10:38 +0000395/* Helper for sys */
396
397PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000398PyImport_GetModuleDict(void)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000399{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000400 PyInterpreterState *interp = PyThreadState_GET()->interp;
401 if (interp->modules == NULL)
402 Py_FatalError("PyImport_GetModuleDict: no module dictionary!");
403 return interp->modules;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000404}
405
Guido van Rossum3f5da241990-12-20 15:06:42 +0000406
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000407/* List of names to clear in sys */
408static char* sys_deletes[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000409 "path", "argv", "ps1", "ps2",
410 "last_type", "last_value", "last_traceback",
411 "path_hooks", "path_importer_cache", "meta_path",
412 /* misc stuff */
413 "flags", "float_info",
414 NULL
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000415};
416
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000417static char* sys_files[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000418 "stdin", "__stdin__",
419 "stdout", "__stdout__",
420 "stderr", "__stderr__",
421 NULL
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000422};
423
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000424
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000425/* Un-initialize things, as good as we can */
Guido van Rossum3f5da241990-12-20 15:06:42 +0000426
Guido van Rossum3f5da241990-12-20 15:06:42 +0000427void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000428PyImport_Cleanup(void)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000429{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000430 Py_ssize_t pos, ndone;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000431 PyObject *key, *value, *dict;
432 PyInterpreterState *interp = PyThreadState_GET()->interp;
433 PyObject *modules = interp->modules;
Guido van Rossum758eec01998-01-19 21:58:26 +0000434
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000435 if (modules == NULL)
436 return; /* Already done */
Guido van Rossum758eec01998-01-19 21:58:26 +0000437
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000438 /* Delete some special variables first. These are common
439 places where user values hide and people complain when their
440 destructors fail. Since the modules containing them are
441 deleted *last* of all, they would come too late in the normal
442 destruction order. Sigh. */
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000443
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000444 value = PyDict_GetItemString(modules, "builtins");
445 if (value != NULL && PyModule_Check(value)) {
446 dict = PyModule_GetDict(value);
447 if (Py_VerboseFlag)
448 PySys_WriteStderr("# clear builtins._\n");
449 PyDict_SetItemString(dict, "_", Py_None);
450 }
451 value = PyDict_GetItemString(modules, "sys");
452 if (value != NULL && PyModule_Check(value)) {
453 char **p;
454 PyObject *v;
455 dict = PyModule_GetDict(value);
456 for (p = sys_deletes; *p != NULL; p++) {
457 if (Py_VerboseFlag)
458 PySys_WriteStderr("# clear sys.%s\n", *p);
459 PyDict_SetItemString(dict, *p, Py_None);
460 }
461 for (p = sys_files; *p != NULL; p+=2) {
462 if (Py_VerboseFlag)
463 PySys_WriteStderr("# restore sys.%s\n", *p);
464 v = PyDict_GetItemString(dict, *(p+1));
465 if (v == NULL)
466 v = Py_None;
467 PyDict_SetItemString(dict, *p, v);
468 }
469 }
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000470
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000471 /* First, delete __main__ */
472 value = PyDict_GetItemString(modules, "__main__");
473 if (value != NULL && PyModule_Check(value)) {
474 if (Py_VerboseFlag)
475 PySys_WriteStderr("# cleanup __main__\n");
476 _PyModule_Clear(value);
477 PyDict_SetItemString(modules, "__main__", Py_None);
478 }
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000479
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000480 /* The special treatment of "builtins" here is because even
481 when it's not referenced as a module, its dictionary is
482 referenced by almost every module's __builtins__. Since
483 deleting a module clears its dictionary (even if there are
484 references left to it), we need to delete the "builtins"
485 module last. Likewise, we don't delete sys until the very
486 end because it is implicitly referenced (e.g. by print).
Guido van Rossum758eec01998-01-19 21:58:26 +0000487
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000488 Also note that we 'delete' modules by replacing their entry
489 in the modules dict with None, rather than really deleting
490 them; this avoids a rehash of the modules dictionary and
491 also marks them as "non existent" so they won't be
492 re-imported. */
Guido van Rossum758eec01998-01-19 21:58:26 +0000493
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000494 /* Next, repeatedly delete modules with a reference count of
495 one (skipping builtins and sys) and delete them */
496 do {
497 ndone = 0;
498 pos = 0;
499 while (PyDict_Next(modules, &pos, &key, &value)) {
500 if (value->ob_refcnt != 1)
501 continue;
502 if (PyUnicode_Check(key) && PyModule_Check(value)) {
Victor Stinner9464d612011-03-07 17:08:21 +0100503 if (PyUnicode_CompareWithASCIIString(key, "builtins") == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000504 continue;
Victor Stinner9464d612011-03-07 17:08:21 +0100505 if (PyUnicode_CompareWithASCIIString(key, "sys") == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000506 continue;
507 if (Py_VerboseFlag)
Victor Stinner9464d612011-03-07 17:08:21 +0100508 PySys_FormatStderr(
509 "# cleanup[1] %U\n", key);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000510 _PyModule_Clear(value);
511 PyDict_SetItem(modules, key, Py_None);
512 ndone++;
513 }
514 }
515 } while (ndone > 0);
Guido van Rossum758eec01998-01-19 21:58:26 +0000516
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000517 /* Next, delete all modules (still skipping builtins and sys) */
518 pos = 0;
519 while (PyDict_Next(modules, &pos, &key, &value)) {
520 if (PyUnicode_Check(key) && PyModule_Check(value)) {
Victor Stinner9464d612011-03-07 17:08:21 +0100521 if (PyUnicode_CompareWithASCIIString(key, "builtins") == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000522 continue;
Victor Stinner9464d612011-03-07 17:08:21 +0100523 if (PyUnicode_CompareWithASCIIString(key, "sys") == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000524 continue;
525 if (Py_VerboseFlag)
Victor Stinner9464d612011-03-07 17:08:21 +0100526 PySys_FormatStderr("# cleanup[2] %U\n", key);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000527 _PyModule_Clear(value);
528 PyDict_SetItem(modules, key, Py_None);
529 }
530 }
Guido van Rossum758eec01998-01-19 21:58:26 +0000531
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000532 /* Next, delete sys and builtins (in that order) */
533 value = PyDict_GetItemString(modules, "sys");
534 if (value != NULL && PyModule_Check(value)) {
535 if (Py_VerboseFlag)
536 PySys_WriteStderr("# cleanup sys\n");
537 _PyModule_Clear(value);
538 PyDict_SetItemString(modules, "sys", Py_None);
539 }
540 value = PyDict_GetItemString(modules, "builtins");
541 if (value != NULL && PyModule_Check(value)) {
542 if (Py_VerboseFlag)
543 PySys_WriteStderr("# cleanup builtins\n");
544 _PyModule_Clear(value);
545 PyDict_SetItemString(modules, "builtins", Py_None);
546 }
Guido van Rossum758eec01998-01-19 21:58:26 +0000547
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000548 /* Finally, clear and delete the modules directory */
549 PyDict_Clear(modules);
550 interp->modules = NULL;
551 Py_DECREF(modules);
552 Py_CLEAR(interp->modules_reloading);
Guido van Rossum8d15b5d1990-10-26 14:58:58 +0000553}
Guido van Rossum7f133ed1991-02-19 12:23:57 +0000554
555
Barry Warsaw28a691b2010-04-17 00:19:56 +0000556/* Helper for pythonrun.c -- return magic number and tag. */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000557
558long
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000559PyImport_GetMagicNumber(void)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000560{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000561 return pyc_magic;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000562}
563
564
Barry Warsaw28a691b2010-04-17 00:19:56 +0000565const char *
566PyImport_GetMagicTag(void)
567{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000568 return pyc_tag;
Barry Warsaw28a691b2010-04-17 00:19:56 +0000569}
570
Guido van Rossum25ce5661997-08-02 03:10:38 +0000571/* Magic for extension modules (built-in as well as dynamically
572 loaded). To prevent initializing an extension module more than
573 once, we keep a static dictionary 'extensions' keyed by module name
574 (for built-in modules) or by filename (for dynamically loaded
Barry Warsaw92883382001-08-13 23:05:44 +0000575 modules), containing these modules. A copy of the module's
Victor Stinner95872862011-03-07 18:20:56 +0100576 dictionary is stored by calling _PyImport_FixupExtensionObject()
Guido van Rossum25ce5661997-08-02 03:10:38 +0000577 immediately after the module initialization function succeeds. A
578 copy can be retrieved from there by calling
Victor Stinner95872862011-03-07 18:20:56 +0100579 _PyImport_FindExtensionObject().
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000580
Barry Warsaw7c9627b2010-06-17 18:38:20 +0000581 Modules which do support multiple initialization set their m_size
582 field to a non-negative number (indicating the size of the
583 module-specific state). They are still recorded in the extensions
584 dictionary, to avoid loading shared libraries twice.
Martin v. Löwis1a214512008-06-11 05:26:20 +0000585*/
586
587int
Victor Stinner95872862011-03-07 18:20:56 +0100588_PyImport_FixupExtensionObject(PyObject *mod, PyObject *name,
589 PyObject *filename)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000590{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000591 PyObject *modules, *dict;
592 struct PyModuleDef *def;
593 if (extensions == NULL) {
594 extensions = PyDict_New();
595 if (extensions == NULL)
596 return -1;
597 }
598 if (mod == NULL || !PyModule_Check(mod)) {
599 PyErr_BadInternalCall();
600 return -1;
601 }
602 def = PyModule_GetDef(mod);
603 if (!def) {
604 PyErr_BadInternalCall();
605 return -1;
606 }
607 modules = PyImport_GetModuleDict();
Victor Stinner95872862011-03-07 18:20:56 +0100608 if (PyDict_SetItem(modules, name, mod) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000609 return -1;
610 if (_PyState_AddModule(mod, def) < 0) {
Victor Stinner95872862011-03-07 18:20:56 +0100611 PyDict_DelItem(modules, name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000612 return -1;
613 }
614 if (def->m_size == -1) {
615 if (def->m_base.m_copy) {
616 /* Somebody already imported the module,
617 likely under a different name.
618 XXX this should really not happen. */
619 Py_DECREF(def->m_base.m_copy);
620 def->m_base.m_copy = NULL;
621 }
622 dict = PyModule_GetDict(mod);
623 if (dict == NULL)
624 return -1;
625 def->m_base.m_copy = PyDict_Copy(dict);
626 if (def->m_base.m_copy == NULL)
627 return -1;
628 }
Victor Stinner49d3f252010-10-17 01:24:53 +0000629 PyDict_SetItem(extensions, filename, (PyObject*)def);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000630 return 0;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000631}
632
Victor Stinner49d3f252010-10-17 01:24:53 +0000633int
634_PyImport_FixupBuiltin(PyObject *mod, char *name)
635{
636 int res;
Victor Stinner95872862011-03-07 18:20:56 +0100637 PyObject *nameobj;
Victor Stinner21fcd0c2011-03-07 18:28:15 +0100638 nameobj = PyUnicode_InternFromString(name);
Victor Stinner95872862011-03-07 18:20:56 +0100639 if (nameobj == NULL)
Victor Stinner49d3f252010-10-17 01:24:53 +0000640 return -1;
Victor Stinner95872862011-03-07 18:20:56 +0100641 res = _PyImport_FixupExtensionObject(mod, nameobj, nameobj);
642 Py_DECREF(nameobj);
Victor Stinner49d3f252010-10-17 01:24:53 +0000643 return res;
644}
645
Guido van Rossum25ce5661997-08-02 03:10:38 +0000646PyObject *
Victor Stinner95872862011-03-07 18:20:56 +0100647_PyImport_FindExtensionObject(PyObject *name, PyObject *filename)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000648{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000649 PyObject *mod, *mdict;
650 PyModuleDef* def;
651 if (extensions == NULL)
652 return NULL;
Victor Stinner49d3f252010-10-17 01:24:53 +0000653 def = (PyModuleDef*)PyDict_GetItem(extensions, filename);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000654 if (def == NULL)
655 return NULL;
656 if (def->m_size == -1) {
657 /* Module does not support repeated initialization */
658 if (def->m_base.m_copy == NULL)
659 return NULL;
Victor Stinner95872862011-03-07 18:20:56 +0100660 mod = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000661 if (mod == NULL)
662 return NULL;
663 mdict = PyModule_GetDict(mod);
664 if (mdict == NULL)
665 return NULL;
666 if (PyDict_Update(mdict, def->m_base.m_copy))
667 return NULL;
668 }
669 else {
670 if (def->m_base.m_init == NULL)
671 return NULL;
672 mod = def->m_base.m_init();
673 if (mod == NULL)
674 return NULL;
Victor Stinner95872862011-03-07 18:20:56 +0100675 PyDict_SetItem(PyImport_GetModuleDict(), name, mod);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000676 Py_DECREF(mod);
677 }
678 if (_PyState_AddModule(mod, def) < 0) {
Victor Stinner95872862011-03-07 18:20:56 +0100679 PyDict_DelItem(PyImport_GetModuleDict(), name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000680 Py_DECREF(mod);
681 return NULL;
682 }
683 if (Py_VerboseFlag)
Victor Stinner95872862011-03-07 18:20:56 +0100684 PySys_FormatStderr("import %U # previously loaded (%R)\n",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000685 name, filename);
686 return mod;
Brett Cannon9a5b25a2010-03-01 02:09:17 +0000687
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000688}
689
Victor Stinner49d3f252010-10-17 01:24:53 +0000690PyObject *
Victor Stinner501c09a2011-02-23 00:02:00 +0000691_PyImport_FindBuiltin(const char *name)
Victor Stinner49d3f252010-10-17 01:24:53 +0000692{
Victor Stinner95872862011-03-07 18:20:56 +0100693 PyObject *res, *nameobj;
Victor Stinner21fcd0c2011-03-07 18:28:15 +0100694 nameobj = PyUnicode_InternFromString(name);
Victor Stinner95872862011-03-07 18:20:56 +0100695 if (nameobj == NULL)
Victor Stinner49d3f252010-10-17 01:24:53 +0000696 return NULL;
Victor Stinner95872862011-03-07 18:20:56 +0100697 res = _PyImport_FindExtensionObject(nameobj, nameobj);
698 Py_DECREF(nameobj);
Victor Stinner49d3f252010-10-17 01:24:53 +0000699 return res;
700}
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000701
702/* Get the module object corresponding to a module name.
703 First check the modules dictionary if there's one there,
Walter Dörwaldf0dfc7a2003-10-20 14:01:56 +0000704 if not, create a new one and insert it in the modules dictionary.
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000705 Because the former action is most common, THIS DOES NOT RETURN A
706 'NEW' REFERENCE! */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000707
Guido van Rossum79f25d91997-04-29 20:08:16 +0000708PyObject *
Victor Stinner27ee0892011-03-04 12:57:09 +0000709PyImport_AddModuleObject(PyObject *name)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000710{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000711 PyObject *modules = PyImport_GetModuleDict();
712 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000713
Victor Stinner27ee0892011-03-04 12:57:09 +0000714 if ((m = PyDict_GetItem(modules, name)) != NULL &&
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000715 PyModule_Check(m))
716 return m;
Victor Stinner27ee0892011-03-04 12:57:09 +0000717 m = PyModule_NewObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000718 if (m == NULL)
719 return NULL;
Victor Stinner27ee0892011-03-04 12:57:09 +0000720 if (PyDict_SetItem(modules, name, m) != 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000721 Py_DECREF(m);
722 return NULL;
723 }
724 Py_DECREF(m); /* Yes, it still exists, in modules! */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000725
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000726 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000727}
728
Victor Stinner27ee0892011-03-04 12:57:09 +0000729PyObject *
730PyImport_AddModule(const char *name)
731{
732 PyObject *nameobj, *module;
733 nameobj = PyUnicode_FromString(name);
734 if (nameobj == NULL)
735 return NULL;
736 module = PyImport_AddModuleObject(nameobj);
737 Py_DECREF(nameobj);
738 return module;
739}
740
741
Tim Peters1cd70172004-08-02 03:52:12 +0000742/* Remove name from sys.modules, if it's there. */
743static void
Victor Stinner27ee0892011-03-04 12:57:09 +0000744remove_module(PyObject *name)
Tim Peters1cd70172004-08-02 03:52:12 +0000745{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000746 PyObject *modules = PyImport_GetModuleDict();
Victor Stinner27ee0892011-03-04 12:57:09 +0000747 if (PyDict_GetItem(modules, name) == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000748 return;
Victor Stinner27ee0892011-03-04 12:57:09 +0000749 if (PyDict_DelItem(modules, name) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000750 Py_FatalError("import: deleting existing key in"
751 "sys.modules failed");
Tim Peters1cd70172004-08-02 03:52:12 +0000752}
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000753
Victor Stinnerc9abda02011-03-14 13:33:46 -0400754static PyObject * get_sourcefile(PyObject *filename);
755static PyObject *make_source_pathname(PyObject *pathname);
Victor Stinner2f42ae52011-03-20 00:41:24 +0100756static PyObject* make_compiled_pathname(Py_UNICODE *pathname, int debug);
Christian Heimes3b06e532008-01-07 20:12:44 +0000757
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000758/* Execute a code object in a module and return the module object
Tim Peters1cd70172004-08-02 03:52:12 +0000759 * WITH INCREMENTED REFERENCE COUNT. If an error occurs, name is
760 * removed from sys.modules, to avoid leaving damaged module objects
761 * in sys.modules. The caller may wish to restore the original
762 * module object (if any) in this case; PyImport_ReloadModule is an
763 * example.
Barry Warsaw28a691b2010-04-17 00:19:56 +0000764 *
765 * Note that PyImport_ExecCodeModuleWithPathnames() is the preferred, richer
766 * interface. The other two exist primarily for backward compatibility.
Tim Peters1cd70172004-08-02 03:52:12 +0000767 */
Guido van Rossum79f25d91997-04-29 20:08:16 +0000768PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000769PyImport_ExecCodeModule(char *name, PyObject *co)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000770{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000771 return PyImport_ExecCodeModuleWithPathnames(
772 name, co, (char *)NULL, (char *)NULL);
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000773}
774
775PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000776PyImport_ExecCodeModuleEx(char *name, PyObject *co, char *pathname)
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000777{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000778 return PyImport_ExecCodeModuleWithPathnames(
779 name, co, pathname, (char *)NULL);
Barry Warsaw28a691b2010-04-17 00:19:56 +0000780}
781
782PyObject *
783PyImport_ExecCodeModuleWithPathnames(char *name, PyObject *co, char *pathname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000784 char *cpathname)
Barry Warsaw28a691b2010-04-17 00:19:56 +0000785{
Victor Stinner27ee0892011-03-04 12:57:09 +0000786 PyObject *m = NULL;
787 PyObject *nameobj, *pathobj = NULL, *cpathobj = NULL;
788
789 nameobj = PyUnicode_FromString(name);
790 if (nameobj == NULL)
791 return NULL;
792
793 if (pathname != NULL) {
794 pathobj = PyUnicode_DecodeFSDefault(pathname);
795 if (pathobj == NULL)
796 goto error;
797 } else
798 pathobj = NULL;
799 if (cpathname != NULL) {
800 cpathobj = PyUnicode_DecodeFSDefault(cpathname);
801 if (cpathobj == NULL)
802 goto error;
803 } else
804 cpathobj = NULL;
805 m = PyImport_ExecCodeModuleObject(nameobj, co, pathobj, cpathobj);
806error:
807 Py_DECREF(nameobj);
808 Py_XDECREF(pathobj);
809 Py_XDECREF(cpathobj);
810 return m;
811}
812
813PyObject*
814PyImport_ExecCodeModuleObject(PyObject *name, PyObject *co, PyObject *pathname,
815 PyObject *cpathname)
816{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000817 PyObject *modules = PyImport_GetModuleDict();
818 PyObject *m, *d, *v;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000819
Victor Stinner27ee0892011-03-04 12:57:09 +0000820 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000821 if (m == NULL)
822 return NULL;
823 /* If the module is being reloaded, we get the old module back
824 and re-use its dict to exec the new code. */
825 d = PyModule_GetDict(m);
826 if (PyDict_GetItemString(d, "__builtins__") == NULL) {
827 if (PyDict_SetItemString(d, "__builtins__",
828 PyEval_GetBuiltins()) != 0)
829 goto error;
830 }
831 /* Remember the filename as the __file__ attribute */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000832 if (pathname != NULL) {
Victor Stinnerc9abda02011-03-14 13:33:46 -0400833 v = get_sourcefile(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000834 if (v == NULL)
835 PyErr_Clear();
836 }
Victor Stinner27ee0892011-03-04 12:57:09 +0000837 else
838 v = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000839 if (v == NULL) {
840 v = ((PyCodeObject *)co)->co_filename;
841 Py_INCREF(v);
842 }
843 if (PyDict_SetItemString(d, "__file__", v) != 0)
844 PyErr_Clear(); /* Not important enough to report */
845 Py_DECREF(v);
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000846
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000847 /* Remember the pyc path name as the __cached__ attribute. */
Victor Stinner27ee0892011-03-04 12:57:09 +0000848 if (cpathname != NULL)
849 v = cpathname;
850 else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000851 v = Py_None;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000852 if (PyDict_SetItemString(d, "__cached__", v) != 0)
853 PyErr_Clear(); /* Not important enough to report */
Barry Warsaw28a691b2010-04-17 00:19:56 +0000854
Martin v. Löwis4d0d4712010-12-03 20:14:31 +0000855 v = PyEval_EvalCode(co, d, d);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000856 if (v == NULL)
857 goto error;
858 Py_DECREF(v);
Guido van Rossumb65e85c1997-07-10 18:00:45 +0000859
Victor Stinner27ee0892011-03-04 12:57:09 +0000860 if ((m = PyDict_GetItem(modules, name)) == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000861 PyErr_Format(PyExc_ImportError,
Victor Stinner27ee0892011-03-04 12:57:09 +0000862 "Loaded module %R not found in sys.modules",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000863 name);
864 return NULL;
865 }
Guido van Rossumb65e85c1997-07-10 18:00:45 +0000866
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000867 Py_INCREF(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000868
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000869 return m;
Tim Peters1cd70172004-08-02 03:52:12 +0000870
871 error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000872 remove_module(name);
873 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000874}
875
876
Barry Warsaw28a691b2010-04-17 00:19:56 +0000877/* Like strrchr(string, '/') but searches for the rightmost of either SEP
878 or ALTSEP, if the latter is defined.
879*/
Victor Stinnerc9abda02011-03-14 13:33:46 -0400880static Py_UNICODE*
Victor Stinner2f42ae52011-03-20 00:41:24 +0100881rightmost_sep(Py_UNICODE *s)
Victor Stinnerc9abda02011-03-14 13:33:46 -0400882{
883 Py_UNICODE *found, c;
884 for (found = NULL; (c = *s); s++) {
885 if (c == SEP
886#ifdef ALTSEP
887 || c == ALTSEP
888#endif
889 )
890 {
891 found = s;
892 }
893 }
894 return found;
895}
896
897
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000898/* Given a pathname for a Python source file, fill a buffer with the
899 pathname for the corresponding compiled file. Return the pathname
900 for the compiled file, or NULL if there's no space in the buffer.
Victor Stinner2f42ae52011-03-20 00:41:24 +0100901 Doesn't set an exception.
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000902
Victor Stinner2f42ae52011-03-20 00:41:24 +0100903 foo.py -> __pycache__/foo.<tag>.pyc */
904
905static PyObject*
906make_compiled_pathname(Py_UNICODE *pathname, int debug)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000907{
Victor Stinner2f42ae52011-03-20 00:41:24 +0100908 Py_UNICODE buf[MAXPATHLEN];
909 size_t buflen = (size_t)MAXPATHLEN;
910 size_t len = Py_UNICODE_strlen(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000911 size_t i, save;
Victor Stinner2f42ae52011-03-20 00:41:24 +0100912 Py_UNICODE *pos;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000913 int sep = SEP;
Barry Warsaw28a691b2010-04-17 00:19:56 +0000914
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000915 /* Sanity check that the buffer has roughly enough space to hold what
916 will eventually be the full path to the compiled file. The 5 extra
917 bytes include the slash afer __pycache__, the two extra dots, the
918 extra trailing character ('c' or 'o') and null. This isn't exact
919 because the contents of the buffer can affect how many actual
920 characters of the string get into the buffer. We'll do a final
921 sanity check before writing the extension to ensure we do not
922 overflow the buffer.
923 */
Victor Stinner2f42ae52011-03-20 00:41:24 +0100924 if (len + Py_UNICODE_strlen(CACHEDIR_UNICODE) + Py_UNICODE_strlen(PYC_TAG_UNICODE) + 5 > buflen)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000925 return NULL;
Tim Petersc1731372001-08-04 08:12:36 +0000926
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000927 /* Find the last path separator and copy everything from the start of
928 the source string up to and including the separator.
929 */
Victor Stinner2f42ae52011-03-20 00:41:24 +0100930 pos = rightmost_sep(pathname);
931 if (pos == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000932 i = 0;
933 }
934 else {
935 sep = *pos;
936 i = pos - pathname + 1;
Victor Stinner2f42ae52011-03-20 00:41:24 +0100937 Py_UNICODE_strncpy(buf, pathname, i);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000938 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000939
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000940 save = i;
941 buf[i++] = '\0';
942 /* Add __pycache__/ */
Victor Stinner2f42ae52011-03-20 00:41:24 +0100943 Py_UNICODE_strcat(buf, CACHEDIR_UNICODE);
944 i += Py_UNICODE_strlen(CACHEDIR_UNICODE) - 1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000945 buf[i++] = sep;
946 buf[i++] = '\0';
947 /* Add the base filename, but remove the .py or .pyw extension, since
948 the tag name must go before the extension.
949 */
Victor Stinner2f42ae52011-03-20 00:41:24 +0100950 Py_UNICODE_strcat(buf, pathname + save);
951 pos = Py_UNICODE_strrchr(buf, '.');
952 if (pos != NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000953 *++pos = '\0';
Victor Stinner2f42ae52011-03-20 00:41:24 +0100954 Py_UNICODE_strcat(buf, PYC_TAG_UNICODE);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000955 /* The length test above assumes that we're only adding one character
956 to the end of what would normally be the extension. What if there
957 is no extension, or the string ends in '.' or '.p', and otherwise
958 fills the buffer? By appending 4 more characters onto the string
959 here, we could overrun the buffer.
Barry Warsaw28a691b2010-04-17 00:19:56 +0000960
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000961 As a simple example, let's say buflen=32 and the input string is
962 'xxx.py'. strlen() would be 6 and the test above would yield:
Barry Warsaw28a691b2010-04-17 00:19:56 +0000963
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000964 (6 + 11 + 10 + 5 == 32) > 32
Barry Warsaw28a691b2010-04-17 00:19:56 +0000965
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000966 which is false and so the name mangling would continue. This would
967 be fine because we'd end up with this string in buf:
Barry Warsaw28a691b2010-04-17 00:19:56 +0000968
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000969 __pycache__/xxx.cpython-32.pyc\0
Barry Warsaw28a691b2010-04-17 00:19:56 +0000970
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000971 strlen(of that) == 30 + the nul fits inside a 32 character buffer.
972 We can even handle an input string of say 'xxxxx' above because
973 that's (5 + 11 + 10 + 5 == 31) > 32 which is also false. Name
974 mangling that yields:
Barry Warsaw28a691b2010-04-17 00:19:56 +0000975
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000976 __pycache__/xxxxxcpython-32.pyc\0
Barry Warsaw28a691b2010-04-17 00:19:56 +0000977
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000978 which is 32 characters including the nul, and thus fits in the
979 buffer. However, an input string of 'xxxxxx' would yield a result
980 string of:
Barry Warsaw28a691b2010-04-17 00:19:56 +0000981
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000982 __pycache__/xxxxxxcpython-32.pyc\0
Barry Warsaw28a691b2010-04-17 00:19:56 +0000983
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000984 which is 33 characters long (including the nul), thus overflowing
985 the buffer, even though the first test would fail, i.e.: the input
986 string is also 6 characters long, so 32 > 32 is false.
Barry Warsaw28a691b2010-04-17 00:19:56 +0000987
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000988 The reason the first test fails but we still overflow the buffer is
989 that the test above only expects to add one extra character to be
990 added to the extension, and here we're adding three (pyc). We
991 don't add the first dot, so that reclaims one of expected
992 positions, leaving us overflowing by 1 byte (3 extra - 1 reclaimed
993 dot - 1 expected extra == 1 overflowed).
Barry Warsaw28a691b2010-04-17 00:19:56 +0000994
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000995 The best we can do is ensure that we still have enough room in the
996 target buffer before we write the extension. Because it's always
997 only the extension that can cause the overflow, and never the other
998 path bytes we've written, it's sufficient to just do one more test
999 here. Still, the assertion that follows can't hurt.
1000 */
Barry Warsaw28a691b2010-04-17 00:19:56 +00001001#if 0
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001002 printf("strlen(buf): %d; buflen: %d\n", (int)strlen(buf), (int)buflen);
Barry Warsaw28a691b2010-04-17 00:19:56 +00001003#endif
Victor Stinner2f42ae52011-03-20 00:41:24 +01001004 len = Py_UNICODE_strlen(buf);
1005 if (len + 5 > buflen)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001006 return NULL;
Victor Stinner2f42ae52011-03-20 00:41:24 +01001007 buf[len] = '.'; len++;
1008 buf[len] = 'p'; len++;
1009 buf[len] = 'y'; len++;
1010 buf[len] = debug ? 'c' : 'o'; len++;
1011 assert(len <= buflen);
1012 return PyUnicode_FromUnicode(buf, len);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001013}
1014
1015
Barry Warsaw28a691b2010-04-17 00:19:56 +00001016/* Given a pathname to a Python byte compiled file, return the path to the
1017 source file, if the path matches the PEP 3147 format. This does not check
1018 for any file existence, however, if the pyc file name does not match PEP
1019 3147 style, NULL is returned. buf must be at least as big as pathname;
Victor Stinnerc9abda02011-03-14 13:33:46 -04001020 the resulting path will always be shorter.
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001021
Victor Stinnerc9abda02011-03-14 13:33:46 -04001022 (...)/__pycache__/foo.<tag>.pyc -> (...)/foo.py */
1023
1024static PyObject*
1025make_source_pathname(PyObject *pathobj)
Barry Warsaw28a691b2010-04-17 00:19:56 +00001026{
Victor Stinnerc9abda02011-03-14 13:33:46 -04001027 Py_UNICODE buf[MAXPATHLEN];
1028 Py_UNICODE *pathname;
1029 Py_UNICODE *left, *right, *dot0, *dot1, sep;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001030 size_t i, j;
Victor Stinnerc9abda02011-03-14 13:33:46 -04001031
1032 if (PyUnicode_GET_SIZE(pathobj) > MAXPATHLEN)
1033 return NULL;
1034 pathname = PyUnicode_AS_UNICODE(pathobj);
Barry Warsaw28a691b2010-04-17 00:19:56 +00001035
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001036 /* Look back two slashes from the end. In between these two slashes
1037 must be the string __pycache__ or this is not a PEP 3147 style
1038 path. It's possible for there to be only one slash.
1039 */
Victor Stinner2f42ae52011-03-20 00:41:24 +01001040 right = rightmost_sep(pathname);
Victor Stinnerc9abda02011-03-14 13:33:46 -04001041 if (right == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001042 return NULL;
1043 sep = *right;
1044 *right = '\0';
Victor Stinner2f42ae52011-03-20 00:41:24 +01001045 left = rightmost_sep(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001046 *right = sep;
1047 if (left == NULL)
1048 left = pathname;
1049 else
1050 left++;
Victor Stinnerc9abda02011-03-14 13:33:46 -04001051 if (right-left != Py_UNICODE_strlen(CACHEDIR_UNICODE) ||
1052 Py_UNICODE_strncmp(left, CACHEDIR_UNICODE, right-left) != 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001053 return NULL;
Barry Warsaw28a691b2010-04-17 00:19:56 +00001054
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001055 /* Now verify that the path component to the right of the last slash
1056 has two dots in it.
1057 */
Victor Stinnerc9abda02011-03-14 13:33:46 -04001058 if ((dot0 = Py_UNICODE_strchr(right + 1, '.')) == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001059 return NULL;
Victor Stinnerc9abda02011-03-14 13:33:46 -04001060 if ((dot1 = Py_UNICODE_strchr(dot0 + 1, '.')) == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001061 return NULL;
1062 /* Too many dots? */
Victor Stinnerc9abda02011-03-14 13:33:46 -04001063 if (Py_UNICODE_strchr(dot1 + 1, '.') != NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001064 return NULL;
Barry Warsaw28a691b2010-04-17 00:19:56 +00001065
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001066 /* This is a PEP 3147 path. Start by copying everything from the
1067 start of pathname up to and including the leftmost slash. Then
1068 copy the file's basename, removing the magic tag and adding a .py
1069 suffix.
1070 */
Victor Stinnerc9abda02011-03-14 13:33:46 -04001071 Py_UNICODE_strncpy(buf, pathname, (i=left-pathname));
1072 Py_UNICODE_strncpy(buf+i, right+1, (j=dot0-right));
1073 buf[i+j] = 'p';
1074 buf[i+j+1] = 'y';
1075 return PyUnicode_FromUnicode(buf, i+j+2);
Barry Warsaw28a691b2010-04-17 00:19:56 +00001076}
1077
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001078/* Given a pathname for a Python source file, its time of last
1079 modification, and a pathname for a compiled file, check whether the
1080 compiled file represents the same version of the source. If so,
1081 return a FILE pointer for the compiled file, positioned just after
1082 the header; if not, return NULL.
1083 Doesn't set an exception. */
1084
1085static FILE *
Victor Stinner2f42ae52011-03-20 00:41:24 +01001086check_compiled_module(PyObject *pathname, time_t mtime, PyObject *cpathname)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001087{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001088 FILE *fp;
1089 long magic;
1090 long pyc_mtime;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001091
Victor Stinner2f42ae52011-03-20 00:41:24 +01001092 fp = _Py_fopen(cpathname, "rb");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001093 if (fp == NULL)
1094 return NULL;
1095 magic = PyMarshal_ReadLongFromFile(fp);
1096 if (magic != pyc_magic) {
1097 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001098 PySys_FormatStderr("# %R has bad magic\n", cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001099 fclose(fp);
1100 return NULL;
1101 }
1102 pyc_mtime = PyMarshal_ReadLongFromFile(fp);
1103 if (pyc_mtime != mtime) {
1104 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001105 PySys_FormatStderr("# %R has bad mtime\n", cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001106 fclose(fp);
1107 return NULL;
1108 }
1109 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001110 PySys_FormatStderr("# %R matches %R\n", cpathname, pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001111 return fp;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001112}
1113
1114
1115/* Read a code object from a file and check it for validity */
1116
Guido van Rossum79f25d91997-04-29 20:08:16 +00001117static PyCodeObject *
Victor Stinner2f42ae52011-03-20 00:41:24 +01001118read_compiled_module(PyObject *cpathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001119{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001120 PyObject *co;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001121
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001122 co = PyMarshal_ReadLastObjectFromFile(fp);
1123 if (co == NULL)
1124 return NULL;
1125 if (!PyCode_Check(co)) {
1126 PyErr_Format(PyExc_ImportError,
Victor Stinner2f42ae52011-03-20 00:41:24 +01001127 "Non-code object in %R", cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001128 Py_DECREF(co);
1129 return NULL;
1130 }
1131 return (PyCodeObject *)co;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001132}
1133
1134
1135/* Load a module from a compiled file, execute it, and return its
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001136 module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001137
Guido van Rossum79f25d91997-04-29 20:08:16 +00001138static PyObject *
Victor Stinner2f42ae52011-03-20 00:41:24 +01001139load_compiled_module(PyObject *name, PyObject *cpathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001140{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001141 long magic;
1142 PyCodeObject *co;
1143 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001144
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001145 magic = PyMarshal_ReadLongFromFile(fp);
1146 if (magic != pyc_magic) {
1147 PyErr_Format(PyExc_ImportError,
Victor Stinner2f42ae52011-03-20 00:41:24 +01001148 "Bad magic number in %R", cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001149 return NULL;
1150 }
1151 (void) PyMarshal_ReadLongFromFile(fp);
1152 co = read_compiled_module(cpathname, fp);
1153 if (co == NULL)
1154 return NULL;
1155 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001156 PySys_FormatStderr("import %U # precompiled from %R\n",
1157 name, cpathname);
1158 m = PyImport_ExecCodeModuleObject(name, (PyObject *)co,
1159 cpathname, cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001160 Py_DECREF(co);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001161
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001162 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001163}
1164
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001165/* Parse a source file and return the corresponding code object */
1166
Guido van Rossum79f25d91997-04-29 20:08:16 +00001167static PyCodeObject *
Victor Stinner2f42ae52011-03-20 00:41:24 +01001168parse_source_module(PyObject *pathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001169{
Victor Stinner2f42ae52011-03-20 00:41:24 +01001170 PyCodeObject *co;
1171 PyObject *pathbytes;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001172 mod_ty mod;
1173 PyCompilerFlags flags;
Victor Stinner2f42ae52011-03-20 00:41:24 +01001174 PyArena *arena;
1175
1176 pathbytes = PyUnicode_EncodeFSDefault(pathname);
1177 if (pathbytes == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001178 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001179
Victor Stinner2f42ae52011-03-20 00:41:24 +01001180 arena = PyArena_New();
1181 if (arena == NULL) {
1182 Py_DECREF(pathbytes);
1183 return NULL;
1184 }
1185
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001186 flags.cf_flags = 0;
Victor Stinner2f42ae52011-03-20 00:41:24 +01001187 mod = PyParser_ASTFromFile(fp, PyBytes_AS_STRING(pathbytes), NULL,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001188 Py_file_input, 0, 0, &flags,
1189 NULL, arena);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001190 if (mod != NULL)
1191 co = PyAST_Compile(mod, PyBytes_AS_STRING(pathbytes), NULL, arena);
1192 else
1193 co = NULL;
1194 Py_DECREF(pathbytes);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001195 PyArena_Free(arena);
1196 return co;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001197}
1198
Guido van Rossum55a83382000-09-20 20:31:38 +00001199/* Helper to open a bytecode file for writing in exclusive mode */
1200
1201static FILE *
Christian Heimes05e8be12008-02-23 18:30:17 +00001202open_exclusive(char *filename, mode_t mode)
Guido van Rossum55a83382000-09-20 20:31:38 +00001203{
1204#if defined(O_EXCL)&&defined(O_CREAT)&&defined(O_WRONLY)&&defined(O_TRUNC)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001205 /* Use O_EXCL to avoid a race condition when another process tries to
1206 write the same file. When that happens, our open() call fails,
1207 which is just fine (since it's only a cache).
1208 XXX If the file exists and is writable but the directory is not
1209 writable, the file will never be written. Oh well.
1210 */
1211 int fd;
1212 (void) unlink(filename);
1213 fd = open(filename, O_EXCL|O_CREAT|O_WRONLY|O_TRUNC
Tim Peters42c83af2000-09-29 04:03:10 +00001214#ifdef O_BINARY
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001215 |O_BINARY /* necessary for Windows */
Tim Peters42c83af2000-09-29 04:03:10 +00001216#endif
Martin v. Löwis79acb9e2002-12-06 12:48:53 +00001217#ifdef __VMS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001218 , mode, "ctxt=bin", "shr=nil"
Martin v. Löwis79acb9e2002-12-06 12:48:53 +00001219#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001220 , mode
Martin v. Löwis79acb9e2002-12-06 12:48:53 +00001221#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001222 );
1223 if (fd < 0)
1224 return NULL;
1225 return fdopen(fd, "wb");
Guido van Rossum55a83382000-09-20 20:31:38 +00001226#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001227 /* Best we can do -- on Windows this can't happen anyway */
1228 return fopen(filename, "wb");
Guido van Rossum55a83382000-09-20 20:31:38 +00001229#endif
1230}
1231
1232
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001233/* Write a compiled module to a file, placing the time of last
1234 modification of its source into the header.
1235 Errors are ignored, if a write error occurs an attempt is made to
1236 remove the file. */
1237
1238static void
Victor Stinner2f42ae52011-03-20 00:41:24 +01001239write_compiled_module(PyCodeObject *co, PyObject *cpathname,
1240 struct stat *srcstat)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001241{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001242 FILE *fp;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001243 time_t mtime = srcstat->st_mtime;
Alexandre Vassalotti9d58e3e2009-07-17 10:55:50 +00001244#ifdef MS_WINDOWS /* since Windows uses different permissions */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001245 mode_t mode = srcstat->st_mode & ~S_IEXEC;
Alexandre Vassalotti9d58e3e2009-07-17 10:55:50 +00001246#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001247 mode_t mode = srcstat->st_mode & ~S_IXUSR & ~S_IXGRP & ~S_IXOTH;
1248 mode_t dirmode = (srcstat->st_mode |
1249 S_IXUSR | S_IXGRP | S_IXOTH |
1250 S_IWUSR | S_IWGRP | S_IWOTH);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001251 PyObject *dirbytes;
Brett Cannon9a5b25a2010-03-01 02:09:17 +00001252#endif
Victor Stinner2f42ae52011-03-20 00:41:24 +01001253 PyObject *cpathbytes, *dirname;
1254 Py_UNICODE *dirsep;
1255 int res, ok;
Barry Warsaw28a691b2010-04-17 00:19:56 +00001256
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001257 /* Ensure that the __pycache__ directory exists. */
Victor Stinner2f42ae52011-03-20 00:41:24 +01001258 dirsep = rightmost_sep(PyUnicode_AS_UNICODE(cpathname));
1259 if (dirsep == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001260 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001261 PySys_FormatStderr("# no %s path found %R\n", CACHEDIR, cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001262 return;
1263 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01001264 dirname = PyUnicode_FromUnicode(PyUnicode_AS_UNICODE(cpathname),
1265 dirsep - PyUnicode_AS_UNICODE(cpathname));
1266 if (dirname == NULL) {
1267 PyErr_Clear();
1268 return;
1269 }
Daniel Stutzbachc7937792010-09-09 21:18:04 +00001270
1271#ifdef MS_WINDOWS
Victor Stinner2f42ae52011-03-20 00:41:24 +01001272 res = CreateDirectoryW(PyUnicode_AS_UNICODE(dirname), NULL);
1273 ok = (res != 0);
1274 if (!ok && GetLastError() == ERROR_ALREADY_EXISTS)
1275 ok = 1;
Daniel Stutzbachc7937792010-09-09 21:18:04 +00001276#else
Victor Stinner2f42ae52011-03-20 00:41:24 +01001277 dirbytes = PyUnicode_EncodeFSDefault(dirname);
1278 if (dirbytes == NULL) {
1279 PyErr_Clear();
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001280 return;
1281 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01001282 res = mkdir(PyBytes_AS_STRING(dirbytes), dirmode);
1283 Py_DECREF(dirbytes);
1284 if (0 <= res)
1285 ok = 1;
1286 else
1287 ok = (errno == EEXIST);
1288#endif
1289 if (!ok) {
1290 if (Py_VerboseFlag)
1291 PySys_FormatStderr("# cannot create cache dir %R\n", dirname);
1292 Py_DECREF(dirname);
1293 return;
1294 }
1295 Py_DECREF(dirname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001296
Victor Stinner2f42ae52011-03-20 00:41:24 +01001297 cpathbytes = PyUnicode_EncodeFSDefault(cpathname);
1298 if (cpathbytes == NULL) {
1299 PyErr_Clear();
1300 return;
1301 }
1302
1303 fp = open_exclusive(PyBytes_AS_STRING(cpathbytes), mode);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001304 if (fp == NULL) {
1305 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001306 PySys_FormatStderr(
1307 "# can't create %R\n", cpathname);
1308 Py_DECREF(cpathbytes);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001309 return;
1310 }
1311 PyMarshal_WriteLongToFile(pyc_magic, fp, Py_MARSHAL_VERSION);
1312 /* First write a 0 for mtime */
1313 PyMarshal_WriteLongToFile(0L, fp, Py_MARSHAL_VERSION);
1314 PyMarshal_WriteObjectToFile((PyObject *)co, fp, Py_MARSHAL_VERSION);
1315 if (fflush(fp) != 0 || ferror(fp)) {
1316 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001317 PySys_FormatStderr("# can't write %R\n", cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001318 /* Don't keep partial file */
1319 fclose(fp);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001320#ifdef MS_WINDOWS
1321 (void)DeleteFileW(PyUnicode_AS_UNICODE(cpathname));
1322#else
1323 (void) unlink(PyBytes_AS_STRING(cpathbytes));
1324#endif
1325 Py_DECREF(cpathbytes);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001326 return;
1327 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01001328 Py_DECREF(cpathbytes);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001329 /* Now write the true mtime */
1330 fseek(fp, 4L, 0);
1331 assert(mtime < LONG_MAX);
1332 PyMarshal_WriteLongToFile((long)mtime, fp, Py_MARSHAL_VERSION);
1333 fflush(fp);
1334 fclose(fp);
1335 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001336 PySys_FormatStderr("# wrote %R\n", cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001337}
1338
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001339static void
1340update_code_filenames(PyCodeObject *co, PyObject *oldname, PyObject *newname)
1341{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001342 PyObject *constants, *tmp;
1343 Py_ssize_t i, n;
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001344
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001345 if (PyUnicode_Compare(co->co_filename, oldname))
1346 return;
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001347
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001348 tmp = co->co_filename;
1349 co->co_filename = newname;
1350 Py_INCREF(co->co_filename);
1351 Py_DECREF(tmp);
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001352
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001353 constants = co->co_consts;
1354 n = PyTuple_GET_SIZE(constants);
1355 for (i = 0; i < n; i++) {
1356 tmp = PyTuple_GET_ITEM(constants, i);
1357 if (PyCode_Check(tmp))
1358 update_code_filenames((PyCodeObject *)tmp,
1359 oldname, newname);
1360 }
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001361}
1362
Victor Stinner2f42ae52011-03-20 00:41:24 +01001363static void
1364update_compiled_module(PyCodeObject *co, PyObject *newname)
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001365{
Victor Stinner2f42ae52011-03-20 00:41:24 +01001366 PyObject *oldname;
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001367
Victor Stinner2f42ae52011-03-20 00:41:24 +01001368 if (PyUnicode_Compare(co->co_filename, newname) == 0)
1369 return;
Hirokazu Yamamoto4f447fb2009-03-04 01:52:10 +00001370
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001371 oldname = co->co_filename;
1372 Py_INCREF(oldname);
1373 update_code_filenames(co, oldname, newname);
1374 Py_DECREF(oldname);
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001375}
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001376
1377/* Load a source module from a given file and return its module
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001378 object WITH INCREMENTED REFERENCE COUNT. If there's a matching
1379 byte-compiled file, use that instead. */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001380
Guido van Rossum79f25d91997-04-29 20:08:16 +00001381static PyObject *
Victor Stinner2f42ae52011-03-20 00:41:24 +01001382load_source_module(PyObject *name, PyObject *pathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001383{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001384 struct stat st;
1385 FILE *fpc;
Victor Stinner2f42ae52011-03-20 00:41:24 +01001386 PyObject *cpathname = NULL, *cpathbytes = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001387 PyCodeObject *co;
Victor Stinner2f42ae52011-03-20 00:41:24 +01001388 PyObject *m = NULL;
Brett Cannon9a5b25a2010-03-01 02:09:17 +00001389
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001390 if (fstat(fileno(fp), &st) != 0) {
1391 PyErr_Format(PyExc_RuntimeError,
Victor Stinner2f42ae52011-03-20 00:41:24 +01001392 "unable to get file status from %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001393 pathname);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001394 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001395 }
Fred Drake4c82b232000-06-30 16:18:57 +00001396#if SIZEOF_TIME_T > 4
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001397 /* Python's .pyc timestamp handling presumes that the timestamp fits
1398 in 4 bytes. This will be fine until sometime in the year 2038,
1399 when a 4-byte signed time_t will overflow.
1400 */
1401 if (st.st_mtime >> 32) {
1402 PyErr_SetString(PyExc_OverflowError,
1403 "modification time overflows a 4 byte field");
Victor Stinner2f42ae52011-03-20 00:41:24 +01001404 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001405 }
Fred Drake4c82b232000-06-30 16:18:57 +00001406#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001407 cpathname = make_compiled_pathname(
Victor Stinner2f42ae52011-03-20 00:41:24 +01001408 PyUnicode_AS_UNICODE(pathname),
1409 !Py_OptimizeFlag);
1410
1411 if (cpathname != NULL)
1412 fpc = check_compiled_module(pathname, st.st_mtime, cpathname);
1413 else
1414 fpc = NULL;
1415
1416 if (fpc) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001417 co = read_compiled_module(cpathname, fpc);
1418 fclose(fpc);
1419 if (co == NULL)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001420 goto error;
1421 update_compiled_module(co, pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001422 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001423 PySys_FormatStderr("import %U # precompiled from %R\n",
1424 name, cpathname);
1425 m = PyImport_ExecCodeModuleObject(name, (PyObject *)co,
1426 cpathname, cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001427 }
1428 else {
1429 co = parse_source_module(pathname, fp);
1430 if (co == NULL)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001431 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001432 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001433 PySys_FormatStderr("import %U # from %R\n",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001434 name, pathname);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001435 if (cpathname != NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001436 PyObject *ro = PySys_GetObject("dont_write_bytecode");
1437 if (ro == NULL || !PyObject_IsTrue(ro))
1438 write_compiled_module(co, cpathname, &st);
1439 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01001440 m = PyImport_ExecCodeModuleObject(name, (PyObject *)co,
1441 pathname, cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001442 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001443 Py_DECREF(co);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001444
Victor Stinner2f42ae52011-03-20 00:41:24 +01001445error:
1446 Py_XDECREF(cpathbytes);
1447 Py_XDECREF(cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001448 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001449}
1450
Christian Heimes3b06e532008-01-07 20:12:44 +00001451/* Get source file -> unicode or None
1452 * Returns the path to the py file if available, else the given path
1453 */
1454static PyObject *
Victor Stinnerc9abda02011-03-14 13:33:46 -04001455get_sourcefile(PyObject *filename)
Christian Heimes3b06e532008-01-07 20:12:44 +00001456{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001457 Py_ssize_t len;
Victor Stinnerc9abda02011-03-14 13:33:46 -04001458 Py_UNICODE *fileuni;
1459 PyObject *py;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001460 struct stat statbuf;
Christian Heimes3b06e532008-01-07 20:12:44 +00001461
Victor Stinnerc9abda02011-03-14 13:33:46 -04001462 len = PyUnicode_GET_SIZE(filename);
1463 if (len == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001464 Py_RETURN_NONE;
Christian Heimes3b06e532008-01-07 20:12:44 +00001465
Victor Stinnerc9abda02011-03-14 13:33:46 -04001466 /* don't match *.pyc or *.pyo? */
1467 fileuni = PyUnicode_AS_UNICODE(filename);
1468 if (len < 5
1469 || fileuni[len-4] != '.'
1470 || (fileuni[len-3] != 'p' && fileuni[len-3] != 'P')
1471 || (fileuni[len-2] != 'y' && fileuni[len-2] != 'Y'))
1472 goto unchanged;
Christian Heimes3b06e532008-01-07 20:12:44 +00001473
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001474 /* Start by trying to turn PEP 3147 path into source path. If that
1475 * fails, just chop off the trailing character, i.e. legacy pyc path
1476 * to py.
1477 */
Victor Stinnerc9abda02011-03-14 13:33:46 -04001478 py = make_source_pathname(filename);
1479 if (py == NULL) {
1480 PyErr_Clear();
1481 py = PyUnicode_FromUnicode(fileuni, len - 1);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001482 }
Victor Stinnerc9abda02011-03-14 13:33:46 -04001483 if (py == NULL)
1484 goto error;
Barry Warsaw28a691b2010-04-17 00:19:56 +00001485
Victor Stinnerc9abda02011-03-14 13:33:46 -04001486 if (_Py_stat(py, &statbuf) == 0 && S_ISREG(statbuf.st_mode))
1487 return py;
1488 Py_DECREF(py);
1489 goto unchanged;
1490
1491error:
1492 PyErr_Clear();
1493unchanged:
1494 Py_INCREF(filename);
1495 return filename;
Christian Heimes3b06e532008-01-07 20:12:44 +00001496}
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001497
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001498/* Forward */
Victor Stinner41c5fec2011-03-13 21:46:30 -04001499static PyObject *load_module(PyObject *, FILE *, PyObject *, int, PyObject *);
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001500static struct filedescr *find_module(PyObject *, PyObject *, PyObject *,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001501 char *, size_t, FILE **, PyObject **);
Victor Stinner53dc7352011-03-20 01:50:21 +01001502static struct _frozen * find_frozen(PyObject *);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001503
1504/* Load a package and return its module object WITH INCREMENTED
1505 REFERENCE COUNT */
1506
1507static PyObject *
Victor Stinnerc9abda02011-03-14 13:33:46 -04001508load_package(PyObject *name, PyObject *pathname)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001509{
Victor Stinner41c5fec2011-03-13 21:46:30 -04001510 PyObject *m, *d, *bufobj;
Victor Stinnerc9abda02011-03-14 13:33:46 -04001511 PyObject *file = NULL, *path_list = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001512 int err;
1513 char buf[MAXPATHLEN+1];
Victor Stinnerc9abda02011-03-14 13:33:46 -04001514 FILE *fp = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001515 struct filedescr *fdp;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001516
Victor Stinnerc9abda02011-03-14 13:33:46 -04001517 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001518 if (m == NULL)
1519 return NULL;
1520 if (Py_VerboseFlag)
Victor Stinnerc9abda02011-03-14 13:33:46 -04001521 PySys_FormatStderr("import %U # directory %U\n",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001522 name, pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001523 file = get_sourcefile(pathname);
1524 if (file == NULL)
Victor Stinnerc9abda02011-03-14 13:33:46 -04001525 return NULL;
1526 path_list = Py_BuildValue("[O]", file);
1527 if (path_list == NULL) {
1528 Py_DECREF(file);
1529 return NULL;
1530 }
1531 d = PyModule_GetDict(m);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001532 err = PyDict_SetItemString(d, "__file__", file);
Victor Stinnerc9abda02011-03-14 13:33:46 -04001533 Py_DECREF(file);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001534 if (err == 0)
Victor Stinnerc9abda02011-03-14 13:33:46 -04001535 err = PyDict_SetItemString(d, "__path__", path_list);
1536 if (err != 0) {
1537 Py_DECREF(path_list);
1538 return NULL;
1539 }
Victor Stinner533d7832011-03-14 13:22:54 -04001540 fdp = find_module(name, initstr, path_list,
1541 buf, sizeof(buf), &fp, NULL);
Victor Stinnerc9abda02011-03-14 13:33:46 -04001542 Py_DECREF(path_list);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001543 if (fdp == NULL) {
1544 if (PyErr_ExceptionMatches(PyExc_ImportError)) {
1545 PyErr_Clear();
1546 Py_INCREF(m);
Victor Stinnerc9abda02011-03-14 13:33:46 -04001547 return m;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001548 }
1549 else
Victor Stinnerc9abda02011-03-14 13:33:46 -04001550 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001551 }
Victor Stinner41c5fec2011-03-13 21:46:30 -04001552 bufobj = PyUnicode_DecodeFSDefault(buf);
1553 if (bufobj != NULL) {
1554 m = load_module(name, fp, bufobj, fdp->type, NULL);
1555 Py_DECREF(bufobj);
1556 }
1557 else
1558 m = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001559 if (fp != NULL)
1560 fclose(fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001561 return m;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001562}
1563
1564
1565/* Helper to test for built-in module */
1566
1567static int
Victor Stinner95872862011-03-07 18:20:56 +01001568is_builtin(PyObject *name)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001569{
Victor Stinner95872862011-03-07 18:20:56 +01001570 int i, cmp;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001571 for (i = 0; PyImport_Inittab[i].name != NULL; i++) {
Victor Stinner95872862011-03-07 18:20:56 +01001572 cmp = PyUnicode_CompareWithASCIIString(name, PyImport_Inittab[i].name);
1573 if (cmp == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001574 if (PyImport_Inittab[i].initfunc == NULL)
1575 return -1;
1576 else
1577 return 1;
1578 }
1579 }
1580 return 0;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001581}
1582
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001583
Just van Rossum52e14d62002-12-30 22:08:05 +00001584/* Return an importer object for a sys.path/pkg.__path__ item 'p',
1585 possibly by fetching it from the path_importer_cache dict. If it
Thomas Wouters89f507f2006-12-13 04:49:30 +00001586 wasn't yet cached, traverse path_hooks until a hook is found
Just van Rossum52e14d62002-12-30 22:08:05 +00001587 that can handle the path item. Return None if no hook could;
1588 this tells our caller it should fall back to the builtin
1589 import mechanism. Cache the result in path_importer_cache.
1590 Returns a borrowed reference. */
1591
1592static PyObject *
1593get_path_importer(PyObject *path_importer_cache, PyObject *path_hooks,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001594 PyObject *p)
Just van Rossum52e14d62002-12-30 22:08:05 +00001595{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001596 PyObject *importer;
1597 Py_ssize_t j, nhooks;
Just van Rossum52e14d62002-12-30 22:08:05 +00001598
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001599 /* These conditions are the caller's responsibility: */
1600 assert(PyList_Check(path_hooks));
1601 assert(PyDict_Check(path_importer_cache));
Just van Rossum52e14d62002-12-30 22:08:05 +00001602
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001603 nhooks = PyList_Size(path_hooks);
1604 if (nhooks < 0)
1605 return NULL; /* Shouldn't happen */
Just van Rossum52e14d62002-12-30 22:08:05 +00001606
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001607 importer = PyDict_GetItem(path_importer_cache, p);
1608 if (importer != NULL)
1609 return importer;
Just van Rossum52e14d62002-12-30 22:08:05 +00001610
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001611 /* set path_importer_cache[p] to None to avoid recursion */
1612 if (PyDict_SetItem(path_importer_cache, p, Py_None) != 0)
1613 return NULL;
Just van Rossum52e14d62002-12-30 22:08:05 +00001614
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001615 for (j = 0; j < nhooks; j++) {
1616 PyObject *hook = PyList_GetItem(path_hooks, j);
1617 if (hook == NULL)
1618 return NULL;
1619 importer = PyObject_CallFunctionObjArgs(hook, p, NULL);
1620 if (importer != NULL)
1621 break;
Just van Rossum52e14d62002-12-30 22:08:05 +00001622
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001623 if (!PyErr_ExceptionMatches(PyExc_ImportError)) {
1624 return NULL;
1625 }
1626 PyErr_Clear();
1627 }
1628 if (importer == NULL) {
1629 importer = PyObject_CallFunctionObjArgs(
1630 (PyObject *)&PyNullImporter_Type, p, NULL
1631 );
1632 if (importer == NULL) {
1633 if (PyErr_ExceptionMatches(PyExc_ImportError)) {
1634 PyErr_Clear();
1635 return Py_None;
1636 }
1637 }
1638 }
1639 if (importer != NULL) {
1640 int err = PyDict_SetItem(path_importer_cache, p, importer);
1641 Py_DECREF(importer);
1642 if (err != 0)
1643 return NULL;
1644 }
1645 return importer;
Just van Rossum52e14d62002-12-30 22:08:05 +00001646}
1647
Christian Heimes9cd17752007-11-18 19:35:23 +00001648PyAPI_FUNC(PyObject *)
1649PyImport_GetImporter(PyObject *path) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001650 PyObject *importer=NULL, *path_importer_cache=NULL, *path_hooks=NULL;
Christian Heimes9cd17752007-11-18 19:35:23 +00001651
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001652 if ((path_importer_cache = PySys_GetObject("path_importer_cache"))) {
1653 if ((path_hooks = PySys_GetObject("path_hooks"))) {
1654 importer = get_path_importer(path_importer_cache,
1655 path_hooks, path);
1656 }
1657 }
1658 Py_XINCREF(importer); /* get_path_importer returns a borrowed reference */
1659 return importer;
Christian Heimes9cd17752007-11-18 19:35:23 +00001660}
1661
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001662/* Search the path (default sys.path) for a module. Return the
1663 corresponding filedescr struct, and (via return arguments) the
1664 pathname and an open file. Return NULL if the module is not found. */
1665
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001666#ifdef MS_COREDLL
Victor Stinner4d6c1c42011-03-08 23:49:04 +01001667extern FILE *_PyWin_FindRegisteredModule(PyObject *, struct filedescr **,
1668 PyObject **p_path);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001669#endif
1670
Victor Stinner547a2a62011-03-20 03:07:28 +01001671/* Forward */
Victor Stinnerc6963162011-03-12 09:26:54 -05001672static int case_ok(char *, Py_ssize_t, Py_ssize_t, const char *);
Victor Stinner547a2a62011-03-20 03:07:28 +01001673static int find_init_module(PyObject *);
Just van Rossum52e14d62002-12-30 22:08:05 +00001674static struct filedescr importhookdescr = {"", "", IMP_HOOK};
Guido van Rossum197346f1997-10-31 18:38:52 +00001675
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001676/* Get the path of a module: get its importer and call importer.find_module()
1677 hook, or check if the module if a package (if path/__init__.py exists).
1678
1679 -1: error: a Python error occurred
1680 0: ignore: an error occurred because of invalid data, but the error is not
1681 important enough to be reported.
1682 1: get path: module not found, but *buf contains its path
1683 2: found: *p_fd is the file descriptor (IMP_HOOK or PKG_DIRECTORY)
1684 and *buf is the path */
1685
1686static int
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001687find_module_path(PyObject *fullname, PyObject *name, PyObject *path,
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001688 PyObject *path_hooks, PyObject *path_importer_cache,
1689 char *buf, size_t buflen,
1690 PyObject **p_loader, struct filedescr **p_fd)
1691{
1692 PyObject *path_bytes;
1693 const char *base;
1694 Py_ssize_t len;
1695 size_t namelen;
1696 struct stat statbuf;
1697 static struct filedescr fd_package = {"", "", PKG_DIRECTORY};
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001698 char *namestr;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001699
1700 if (PyUnicode_Check(path)) {
1701 path_bytes = PyUnicode_EncodeFSDefault(path);
1702 if (path_bytes == NULL)
1703 return -1;
1704 }
1705 else if (PyBytes_Check(path)) {
1706 Py_INCREF(path);
1707 path_bytes = path;
1708 }
1709 else
1710 return 0;
1711
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001712 namestr = _PyUnicode_AsString(name);
1713 namelen = strlen(namestr);
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001714 base = PyBytes_AS_STRING(path_bytes);
1715 len = PyBytes_GET_SIZE(path_bytes);
1716 if (len + 2 + namelen + MAXSUFFIXSIZE >= buflen) {
1717 Py_DECREF(path_bytes);
1718 return 0; /* Too long */
1719 }
1720 strcpy(buf, base);
1721 Py_DECREF(path_bytes);
1722
1723 if (strlen(buf) != len) {
1724 return 0; /* path_bytes contains '\0' */
1725 }
1726
1727 /* sys.path_hooks import hook */
1728 if (p_loader != NULL) {
1729 PyObject *importer;
1730
1731 importer = get_path_importer(path_importer_cache,
1732 path_hooks, path);
1733 if (importer == NULL) {
1734 return -1;
1735 }
1736 /* Note: importer is a borrowed reference */
1737 if (importer != Py_None) {
1738 PyObject *loader;
1739 loader = PyObject_CallMethod(importer,
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001740 "find_module", "O", fullname);
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001741 if (loader == NULL)
1742 return -1; /* error */
1743 if (loader != Py_None) {
1744 /* a loader was found */
1745 *p_loader = loader;
1746 *p_fd = &importhookdescr;
1747 return 2;
1748 }
1749 Py_DECREF(loader);
1750 return 0;
1751 }
1752 }
1753 /* no hook was found, use builtin import */
1754
1755 if (len > 0 && buf[len-1] != SEP
1756#ifdef ALTSEP
1757 && buf[len-1] != ALTSEP
1758#endif
1759 )
1760 buf[len++] = SEP;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001761 strcpy(buf+len, namestr);
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001762 len += namelen;
1763
1764 /* Check for package import (buf holds a directory name,
1765 and there's an __init__ module in that directory */
1766#ifdef HAVE_STAT
1767 if (stat(buf, &statbuf) == 0 && /* it exists */
Victor Stinnerd0296212011-03-14 14:04:10 -04001768 S_ISDIR(statbuf.st_mode)) /* it's a directory */
1769 {
Victor Stinner547a2a62011-03-20 03:07:28 +01001770 PyObject *bufobj = PyUnicode_DecodeFSDefault(buf);
1771 if (bufobj == NULL)
1772 return -1;
Victor Stinnerd0296212011-03-14 14:04:10 -04001773 if (case_ok(buf, len, namelen, namestr)) { /* case matches */
Victor Stinner547a2a62011-03-20 03:07:28 +01001774 if (find_init_module(bufobj)) { /* and has __init__.py */
1775 Py_DECREF(bufobj);
Victor Stinnerd0296212011-03-14 14:04:10 -04001776 *p_fd = &fd_package;
1777 return 2;
1778 }
1779 else {
1780 int err;
Victor Stinnerd0296212011-03-14 14:04:10 -04001781 err = PyErr_WarnFormat(PyExc_ImportWarning, 1,
Victor Stinner547a2a62011-03-20 03:07:28 +01001782 "Not importing directory %R: missing __init__.py",
1783 bufobj);
1784 if (err) {
1785 Py_DECREF(bufobj);
Victor Stinnerd0296212011-03-14 14:04:10 -04001786 return -1;
Victor Stinner547a2a62011-03-20 03:07:28 +01001787 }
Victor Stinnerd0296212011-03-14 14:04:10 -04001788 }
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001789 }
Victor Stinner547a2a62011-03-20 03:07:28 +01001790 Py_DECREF(bufobj);
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001791 }
1792#endif
1793 return 1;
1794}
1795
1796/* Find a module in search_path_list. For each path, try
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001797 find_module_path() or try each _PyImport_Filetab suffix.
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001798
1799 If the module is found, return a file descriptor, write the path in
1800 *p_filename, write the pointer to the file object into *p_fp, and (if
1801 p_loader is not NULL) the loader into *p_loader.
1802
1803 Otherwise, raise an exception and return NULL. */
1804
Victor Stinner37580282011-03-20 01:34:43 +01001805static struct filedescr*
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001806find_module_path_list(PyObject *fullname, PyObject *name,
Victor Stinner37580282011-03-20 01:34:43 +01001807 PyObject *search_path_list, PyObject *path_hooks,
1808 PyObject *path_importer_cache,
1809 char *buf, size_t buflen,
1810 FILE **p_fp, PyObject **p_loader)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001811{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001812 Py_ssize_t i, npath;
1813 size_t len, namelen;
1814 struct filedescr *fdp = NULL;
1815 char *filemode;
1816 FILE *fp = NULL;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001817 char *namestr;
Victor Stinner53dc7352011-03-20 01:50:21 +01001818
Victor Stinner37580282011-03-20 01:34:43 +01001819 npath = PyList_Size(search_path_list);
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001820 namestr = _PyUnicode_AsString(name);
1821 namelen = strlen(namestr);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001822 for (i = 0; i < npath; i++) {
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001823 PyObject *path;
1824 int ok;
1825
1826 path = PyList_GetItem(search_path_list, i);
1827 if (path == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001828 return NULL;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001829
1830 ok = find_module_path(fullname, name, path,
1831 path_hooks, path_importer_cache,
1832 buf, buflen,
1833 p_loader, &fdp);
1834 if (ok < 0)
1835 return NULL;
1836 if (ok == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001837 continue;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001838 if (ok == 2)
1839 return fdp;
Amaury Forgeot d'Arcf1ca0b12008-06-11 17:40:47 +00001840
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001841 len = strlen(buf);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001842 for (fdp = _PyImport_Filetab; fdp->suffix != NULL; fdp++) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001843 strcpy(buf+len, fdp->suffix);
1844 if (Py_VerboseFlag > 1)
1845 PySys_WriteStderr("# trying %s\n", buf);
1846 filemode = fdp->mode;
1847 if (filemode[0] == 'U')
1848 filemode = "r" PY_STDIOTEXTMODE;
1849 fp = fopen(buf, filemode);
Victor Stinnerd0296212011-03-14 14:04:10 -04001850 if (fp == NULL)
1851 continue;
1852
1853 if (case_ok(buf, len, namelen, namestr)) {
1854 *p_fp = fp;
1855 return fdp;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001856 }
Victor Stinnerd0296212011-03-14 14:04:10 -04001857
1858 fclose(fp);
1859 fp = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001860 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001861 }
Victor Stinnerd0296212011-03-14 14:04:10 -04001862 PyErr_Format(PyExc_ImportError,
1863 "No module named %U", name);
1864 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001865}
1866
Victor Stinner37580282011-03-20 01:34:43 +01001867/* Find a module:
1868
1869 - try find_module() of each sys.meta_path hook
1870 - try find_frozen()
1871 - try is_builtin()
1872 - try _PyWin_FindRegisteredModule() (Windows only)
1873 - otherwise, call find_module_path_list() with search_path_list (if not
1874 NULL) or sys.path
1875
1876 Return:
1877
1878 - &fd_builtin (C_BUILTIN) if it is a builtin
1879 - &fd_frozen (PY_FROZEN) if it is frozen
1880 - &fd_package (PKG_DIRECTORY) and write the filename into *buf
1881 if it is a package
1882 - &importhookdescr (IMP_HOOK) and write the loader into *p_loader if a
1883 importer loader was found
1884 - a file descriptor (PY_SOURCE, PY_COMPILED, C_EXTENSION, PY_RESOURCE or
1885 PY_CODERESOURCE: see _PyImport_Filetab), write the filename into
1886 *buf and the pointer to the open file into *p_fp
1887 - NULL on error
1888
1889 By default, write an empty string into *buf, and *p_fp and *p_loader (if
1890 set) are set to NULL. Eg. *buf is an empty string for a builtin package. */
1891
1892static struct filedescr *
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001893find_module(PyObject *fullname, PyObject *name, PyObject *search_path_list,
Victor Stinner37580282011-03-20 01:34:43 +01001894 char *buf, size_t buflen, FILE **p_fp, PyObject **p_loader)
1895{
1896 Py_ssize_t i, npath;
1897 static struct filedescr fd_frozen = {"", "", PY_FROZEN};
1898 static struct filedescr fd_builtin = {"", "", C_BUILTIN};
1899 PyObject *path_hooks, *path_importer_cache;
Victor Stinner37580282011-03-20 01:34:43 +01001900
1901 *buf = '\0';
1902 *p_fp = NULL;
1903 if (p_loader != NULL)
1904 *p_loader = NULL;
1905
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001906 if (PyUnicode_GET_SIZE(name) > MAXPATHLEN) {
Victor Stinner37580282011-03-20 01:34:43 +01001907 PyErr_SetString(PyExc_OverflowError,
1908 "module name is too long");
1909 return NULL;
1910 }
1911
1912 /* sys.meta_path import hook */
1913 if (p_loader != NULL) {
1914 PyObject *meta_path;
1915
1916 meta_path = PySys_GetObject("meta_path");
1917 if (meta_path == NULL || !PyList_Check(meta_path)) {
1918 PyErr_SetString(PyExc_ImportError,
1919 "sys.meta_path must be a list of "
1920 "import hooks");
1921 return NULL;
1922 }
1923 Py_INCREF(meta_path); /* zap guard */
1924 npath = PyList_Size(meta_path);
1925 for (i = 0; i < npath; i++) {
1926 PyObject *loader;
1927 PyObject *hook = PyList_GetItem(meta_path, i);
1928 loader = PyObject_CallMethod(hook, "find_module",
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001929 "OO", fullname,
Victor Stinner37580282011-03-20 01:34:43 +01001930 search_path_list != NULL ?
1931 search_path_list : Py_None);
1932 if (loader == NULL) {
1933 Py_DECREF(meta_path);
1934 return NULL; /* true error */
1935 }
1936 if (loader != Py_None) {
1937 /* a loader was found */
1938 *p_loader = loader;
1939 Py_DECREF(meta_path);
1940 return &importhookdescr;
1941 }
1942 Py_DECREF(loader);
1943 }
1944 Py_DECREF(meta_path);
1945 }
1946
Victor Stinnerdf75a022011-03-14 13:40:04 -04001947 if (find_frozen(fullname) != NULL)
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001948 return &fd_frozen;
Victor Stinner37580282011-03-20 01:34:43 +01001949
1950 if (search_path_list == NULL) {
1951#ifdef MS_COREDLL
1952 FILE *fp;
1953 struct filedescr *fdp;
1954 PyObject *filename, *filename_bytes;
1955#endif
Victor Stinnerdf75a022011-03-14 13:40:04 -04001956 if (is_builtin(name))
Victor Stinner37580282011-03-20 01:34:43 +01001957 return &fd_builtin;
Victor Stinner37580282011-03-20 01:34:43 +01001958#ifdef MS_COREDLL
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001959 fp = _PyWin_FindRegisteredModule(name, &fdp, &filename);
Victor Stinner37580282011-03-20 01:34:43 +01001960 if (fp != NULL) {
Victor Stinner37580282011-03-20 01:34:43 +01001961 filename_bytes = PyUnicode_EncodeFSDefault(filename);
1962 Py_DECREF(filename);
1963 if (filename_bytes == NULL)
1964 return NULL;
1965 strncpy(buf, PyBytes_AS_STRING(filename_bytes), buflen);
1966 buf[buflen-1] = '\0';
1967 Py_DECREF(filename_bytes);
1968 *p_fp = fp;
1969 return fdp;
1970 }
1971 else if (PyErr_Occurred())
1972 return NULL;
1973#endif
Victor Stinner37580282011-03-20 01:34:43 +01001974 search_path_list = PySys_GetObject("path");
1975 }
1976
1977 if (search_path_list == NULL || !PyList_Check(search_path_list)) {
1978 PyErr_SetString(PyExc_ImportError,
1979 "sys.path must be a list of directory names");
1980 return NULL;
1981 }
1982
1983 path_hooks = PySys_GetObject("path_hooks");
1984 if (path_hooks == NULL || !PyList_Check(path_hooks)) {
1985 PyErr_SetString(PyExc_ImportError,
1986 "sys.path_hooks must be a list of "
1987 "import hooks");
1988 return NULL;
1989 }
1990 path_importer_cache = PySys_GetObject("path_importer_cache");
1991 if (path_importer_cache == NULL ||
1992 !PyDict_Check(path_importer_cache)) {
1993 PyErr_SetString(PyExc_ImportError,
1994 "sys.path_importer_cache must be a dict");
1995 return NULL;
1996 }
1997
1998 return find_module_path_list(fullname, name,
1999 search_path_list, path_hooks,
2000 path_importer_cache,
2001 buf, buflen,
2002 p_fp, p_loader);
2003}
2004
Martin v. Löwis18e16552006-02-15 17:27:45 +00002005/* case_ok(char* buf, Py_ssize_t len, Py_ssize_t namelen, char* name)
Tim Petersd1e87a82001-03-01 18:12:00 +00002006 * The arguments here are tricky, best shown by example:
2007 * /a/b/c/d/e/f/g/h/i/j/k/some_long_module_name.py\0
2008 * ^ ^ ^ ^
2009 * |--------------------- buf ---------------------|
2010 * |------------------- len ------------------|
2011 * |------ name -------|
2012 * |----- namelen -----|
2013 * buf is the full path, but len only counts up to (& exclusive of) the
2014 * extension. name is the module name, also exclusive of extension.
2015 *
2016 * We've already done a successful stat() or fopen() on buf, so know that
2017 * there's some match, possibly case-insensitive.
2018 *
Tim Peters50d8d372001-02-28 05:34:27 +00002019 * case_ok() is to return 1 if there's a case-sensitive match for
2020 * name, else 0. case_ok() is also to return 1 if envar PYTHONCASEOK
2021 * exists.
Tim Petersd1e87a82001-03-01 18:12:00 +00002022 *
Tim Peters50d8d372001-02-28 05:34:27 +00002023 * case_ok() is used to implement case-sensitive import semantics even
2024 * on platforms with case-insensitive filesystems. It's trivial to implement
2025 * for case-sensitive filesystems. It's pretty much a cross-platform
2026 * nightmare for systems with case-insensitive filesystems.
2027 */
Guido van Rossum0980bd91998-02-13 17:18:36 +00002028
Tim Peters50d8d372001-02-28 05:34:27 +00002029/* First we may need a pile of platform-specific header files; the sequence
2030 * of #if's here should match the sequence in the body of case_ok().
2031 */
Jason Tishler7961aa62005-05-20 00:56:54 +00002032#if defined(MS_WINDOWS)
Guido van Rossum0980bd91998-02-13 17:18:36 +00002033#include <windows.h>
Guido van Rossum4c3f57c2001-01-10 20:40:46 +00002034
Tim Peters50d8d372001-02-28 05:34:27 +00002035#elif defined(DJGPP)
2036#include <dir.h>
2037
Jason Tishler7961aa62005-05-20 00:56:54 +00002038#elif (defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) && defined(HAVE_DIRENT_H)
Tim Peters430f5d42001-03-01 01:30:56 +00002039#include <sys/types.h>
2040#include <dirent.h>
2041
Andrew MacIntyred9400542002-02-26 11:41:34 +00002042#elif defined(PYOS_OS2)
2043#define INCL_DOS
2044#define INCL_DOSERRORS
2045#define INCL_NOPMAPI
2046#include <os2.h>
Tim Peters50d8d372001-02-28 05:34:27 +00002047#endif
2048
Guido van Rossum0980bd91998-02-13 17:18:36 +00002049static int
Victor Stinnerc6963162011-03-12 09:26:54 -05002050case_ok(char *buf, Py_ssize_t len, Py_ssize_t namelen, const char *name)
Guido van Rossum0980bd91998-02-13 17:18:36 +00002051{
Tim Peters50d8d372001-02-28 05:34:27 +00002052/* Pick a platform-specific implementation; the sequence of #if's here should
2053 * match the sequence just above.
2054 */
2055
Jason Tishler7961aa62005-05-20 00:56:54 +00002056/* MS_WINDOWS */
2057#if defined(MS_WINDOWS)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002058 WIN32_FIND_DATA data;
2059 HANDLE h;
Tim Peters50d8d372001-02-28 05:34:27 +00002060
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002061 if (Py_GETENV("PYTHONCASEOK") != NULL)
2062 return 1;
Tim Peters50d8d372001-02-28 05:34:27 +00002063
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002064 h = FindFirstFile(buf, &data);
2065 if (h == INVALID_HANDLE_VALUE) {
2066 PyErr_Format(PyExc_NameError,
2067 "Can't find file for module %.100s\n(filename %.300s)",
2068 name, buf);
2069 return 0;
2070 }
2071 FindClose(h);
2072 return strncmp(data.cFileName, name, namelen) == 0;
Tim Peters50d8d372001-02-28 05:34:27 +00002073
2074/* DJGPP */
2075#elif 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
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002154 return 1;
Guido van Rossum0980bd91998-02-13 17:18:36 +00002155
Guido van Rossum4d1b3b91998-02-13 23:27:59 +00002156#endif
Tim Peters50d8d372001-02-28 05:34:27 +00002157}
Guido van Rossum4d1b3b91998-02-13 23:27:59 +00002158
Guido van Rossum197346f1997-10-31 18:38:52 +00002159#ifdef HAVE_STAT
Victor Stinner4f4402c2010-08-14 14:50:26 +00002160
Victor Stinner547a2a62011-03-20 03:07:28 +01002161/* Helper to look for __init__.py or __init__.py[co] in potential package.
2162 Return 1 if __init__ was found, 0 if not, or -1 on error. */
Guido van Rossum197346f1997-10-31 18:38:52 +00002163static int
Victor Stinner547a2a62011-03-20 03:07:28 +01002164find_init_module(PyObject *directory)
Guido van Rossum197346f1997-10-31 18:38:52 +00002165{
Victor Stinner547a2a62011-03-20 03:07:28 +01002166 size_t len;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002167 struct stat statbuf;
Victor Stinner547a2a62011-03-20 03:07:28 +01002168 PyObject *filename;
2169 int match;
2170 char *filestr;
2171 size_t filelen;
Guido van Rossum197346f1997-10-31 18:38:52 +00002172
Victor Stinner547a2a62011-03-20 03:07:28 +01002173 len = PyUnicode_GET_SIZE(directory);
2174 filename = PyUnicode_FromFormat("%U%c__init__.py", directory, SEP);
2175 if (filename == NULL)
2176 return -1;
2177 if (_Py_stat(filename, &statbuf) == 0) {
2178 /* 9=len("/__init__") */
2179 filestr = _PyUnicode_AsString(filename);
2180 filelen = strlen(filestr);
2181 if (case_ok(filestr, filelen-9, 8, "__init__")) {
2182 Py_DECREF(filename);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002183 return 1;
2184 }
2185 }
Victor Stinner547a2a62011-03-20 03:07:28 +01002186 Py_DECREF(filename);
2187
2188 filename = PyUnicode_FromFormat("%U%c__init__.py%c",
2189 directory, SEP, Py_OptimizeFlag ? 'o' : 'c');
2190 if (filename == NULL)
2191 return -1;
2192 if (_Py_stat(filename, &statbuf) == 0) {
2193 /* 9=len("/__init__") */
2194 filestr = _PyUnicode_AsString(filename);
2195 filelen = strlen(filestr);
2196 if (case_ok(filestr, filelen-9, 8, "__init__")) {
2197 Py_DECREF(filename);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002198 return 1;
2199 }
2200 }
Victor Stinner547a2a62011-03-20 03:07:28 +01002201 Py_DECREF(filename);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002202 return 0;
Guido van Rossum197346f1997-10-31 18:38:52 +00002203}
Guido van Rossum48a680c2001-03-02 06:34:14 +00002204
Guido van Rossum197346f1997-10-31 18:38:52 +00002205#endif /* HAVE_STAT */
2206
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002207
Victor Stinner95872862011-03-07 18:20:56 +01002208static int init_builtin(PyObject *); /* Forward */
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002209
Victor Stinner44c6c152010-08-09 00:59:10 +00002210static PyObject*
Victor Stinner95872862011-03-07 18:20:56 +01002211load_builtin(PyObject *name, int type)
Victor Stinner44c6c152010-08-09 00:59:10 +00002212{
2213 PyObject *m, *modules;
2214 int err;
2215
Victor Stinner44c6c152010-08-09 00:59:10 +00002216 if (type == C_BUILTIN)
2217 err = init_builtin(name);
2218 else
Victor Stinner95872862011-03-07 18:20:56 +01002219 err = PyImport_ImportFrozenModuleObject(name);
Victor Stinner44c6c152010-08-09 00:59:10 +00002220 if (err < 0)
2221 return NULL;
2222 if (err == 0) {
2223 PyErr_Format(PyExc_ImportError,
Victor Stinner95872862011-03-07 18:20:56 +01002224 "Purported %s module %R not found",
2225 type == C_BUILTIN ? "builtin" : "frozen",
Victor Stinner44c6c152010-08-09 00:59:10 +00002226 name);
2227 return NULL;
2228 }
2229
2230 modules = PyImport_GetModuleDict();
Victor Stinner95872862011-03-07 18:20:56 +01002231 m = PyDict_GetItem(modules, name);
Victor Stinner44c6c152010-08-09 00:59:10 +00002232 if (m == NULL) {
2233 PyErr_Format(
2234 PyExc_ImportError,
Victor Stinner95872862011-03-07 18:20:56 +01002235 "%s module %R not properly initialized",
2236 type == C_BUILTIN ? "builtin" : "frozen",
Victor Stinner44c6c152010-08-09 00:59:10 +00002237 name);
2238 return NULL;
2239 }
2240 Py_INCREF(m);
2241 return m;
2242}
2243
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002244/* Load an external module using the default search path and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00002245 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002246
Guido van Rossum79f25d91997-04-29 20:08:16 +00002247static PyObject *
Victor Stinner41c5fec2011-03-13 21:46:30 -04002248load_module(PyObject *name, FILE *fp, PyObject *pathname, int type, PyObject *loader)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002249{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002250 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002251
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002252 /* First check that there's an open file (if we need one) */
2253 switch (type) {
2254 case PY_SOURCE:
2255 case PY_COMPILED:
2256 if (fp == NULL) {
2257 PyErr_Format(PyExc_ValueError,
Victor Stinner41c5fec2011-03-13 21:46:30 -04002258 "file object required for import (type code %d)",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002259 type);
2260 return NULL;
2261 }
2262 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002263
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002264 switch (type) {
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002265
Victor Stinner41c5fec2011-03-13 21:46:30 -04002266 case PY_SOURCE:
2267 m = load_source_module(name, pathname, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002268 break;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002269
Victor Stinner41c5fec2011-03-13 21:46:30 -04002270 case PY_COMPILED:
2271 m = load_compiled_module(name, pathname, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002272 break;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002273
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002274#ifdef HAVE_DYNAMIC_LOADING
Victor Stinner41c5fec2011-03-13 21:46:30 -04002275 case C_EXTENSION:
2276 m = _PyImport_LoadDynamicModule(name, pathname, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002277 break;
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002278#endif
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002279
Victor Stinner41c5fec2011-03-13 21:46:30 -04002280 case PKG_DIRECTORY:
2281 m = load_package(name, pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002282 break;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002283
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002284 case C_BUILTIN:
Victor Stinner41c5fec2011-03-13 21:46:30 -04002285 case PY_FROZEN:
2286 m = load_builtin(name, type);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002287 break;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002288
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002289 case IMP_HOOK: {
2290 if (loader == NULL) {
2291 PyErr_SetString(PyExc_ImportError,
2292 "import hook without loader");
2293 return NULL;
2294 }
Victor Stinner41c5fec2011-03-13 21:46:30 -04002295 m = PyObject_CallMethod(loader, "load_module", "O", name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002296 break;
2297 }
Just van Rossum52e14d62002-12-30 22:08:05 +00002298
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002299 default:
2300 PyErr_Format(PyExc_ImportError,
Victor Stinner41c5fec2011-03-13 21:46:30 -04002301 "Don't know how to import %U (type code %d)",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002302 name, type);
2303 m = NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002304
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002305 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002306
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002307 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002308}
2309
2310
2311/* Initialize a built-in module.
Thomas Wouters89f507f2006-12-13 04:49:30 +00002312 Return 1 for success, 0 if the module is not found, and -1 with
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002313 an exception set if the initialization failed. */
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002314
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002315static int
Victor Stinner95872862011-03-07 18:20:56 +01002316init_builtin(PyObject *name)
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002317{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002318 struct _inittab *p;
Guido van Rossum25ce5661997-08-02 03:10:38 +00002319
Victor Stinner95872862011-03-07 18:20:56 +01002320 if (_PyImport_FindExtensionObject(name, name) != NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002321 return 1;
Guido van Rossum25ce5661997-08-02 03:10:38 +00002322
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002323 for (p = PyImport_Inittab; p->name != NULL; p++) {
2324 PyObject *mod;
Victor Stinner95872862011-03-07 18:20:56 +01002325 if (PyUnicode_CompareWithASCIIString(name, p->name) == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002326 if (p->initfunc == NULL) {
2327 PyErr_Format(PyExc_ImportError,
Victor Stinner95872862011-03-07 18:20:56 +01002328 "Cannot re-init internal module %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002329 name);
2330 return -1;
2331 }
2332 if (Py_VerboseFlag)
Victor Stinner95872862011-03-07 18:20:56 +01002333 PySys_FormatStderr("import %U # builtin\n", name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002334 mod = (*p->initfunc)();
2335 if (mod == 0)
2336 return -1;
Victor Stinner95872862011-03-07 18:20:56 +01002337 if (_PyImport_FixupExtensionObject(mod, name, name) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002338 return -1;
2339 /* FixupExtension has put the module into sys.modules,
2340 so we can release our own reference. */
2341 Py_DECREF(mod);
2342 return 1;
2343 }
2344 }
2345 return 0;
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002346}
Guido van Rossumf56e3db1993-04-01 20:59:32 +00002347
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002348
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002349/* Frozen modules */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002350
Guido van Rossumcfd0a221996-06-17 17:06:34 +00002351static struct _frozen *
Victor Stinner53dc7352011-03-20 01:50:21 +01002352find_frozen(PyObject *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002353{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002354 struct _frozen *p;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002355
Victor Stinner53dc7352011-03-20 01:50:21 +01002356 if (name == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002357 return NULL;
Benjamin Petersond968e272008-11-05 22:48:33 +00002358
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002359 for (p = PyImport_FrozenModules; ; p++) {
2360 if (p->name == NULL)
2361 return NULL;
Victor Stinner53dc7352011-03-20 01:50:21 +01002362 if (PyUnicode_CompareWithASCIIString(name, p->name) == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002363 break;
2364 }
2365 return p;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002366}
2367
Guido van Rossum79f25d91997-04-29 20:08:16 +00002368static PyObject *
Victor Stinner53dc7352011-03-20 01:50:21 +01002369get_frozen_object(PyObject *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002370{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002371 struct _frozen *p = find_frozen(name);
2372 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002373
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002374 if (p == NULL) {
2375 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002376 "No such frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002377 name);
2378 return NULL;
2379 }
2380 if (p->code == NULL) {
2381 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002382 "Excluded frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002383 name);
2384 return NULL;
2385 }
2386 size = p->size;
2387 if (size < 0)
2388 size = -size;
2389 return PyMarshal_ReadObjectFromString((char *)p->code, size);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002390}
2391
Brett Cannon8d110132009-03-15 02:20:16 +00002392static PyObject *
Victor Stinner53dc7352011-03-20 01:50:21 +01002393is_frozen_package(PyObject *name)
Brett Cannon8d110132009-03-15 02:20:16 +00002394{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002395 struct _frozen *p = find_frozen(name);
2396 int size;
Brett Cannon8d110132009-03-15 02:20:16 +00002397
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002398 if (p == NULL) {
2399 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002400 "No such frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002401 name);
2402 return NULL;
2403 }
Brett Cannon8d110132009-03-15 02:20:16 +00002404
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002405 size = p->size;
Brett Cannon8d110132009-03-15 02:20:16 +00002406
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002407 if (size < 0)
2408 Py_RETURN_TRUE;
2409 else
2410 Py_RETURN_FALSE;
Brett Cannon8d110132009-03-15 02:20:16 +00002411}
2412
2413
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002414/* Initialize a frozen module.
Brett Cannon3c2ac442009-03-08 20:49:47 +00002415 Return 1 for success, 0 if the module is not found, and -1 with
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002416 an exception set if the initialization failed.
2417 This function is also used from frozenmain.c */
Guido van Rossum0b344901995-02-07 15:35:27 +00002418
2419int
Victor Stinner53dc7352011-03-20 01:50:21 +01002420PyImport_ImportFrozenModuleObject(PyObject *name)
Guido van Rossumf56e3db1993-04-01 20:59:32 +00002421{
Victor Stinner53dc7352011-03-20 01:50:21 +01002422 struct _frozen *p;
2423 PyObject *co, *m, *path;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002424 int ispackage;
2425 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002426
Victor Stinner53dc7352011-03-20 01:50:21 +01002427 p = find_frozen(name);
2428
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002429 if (p == NULL)
2430 return 0;
2431 if (p->code == NULL) {
2432 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002433 "Excluded frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002434 name);
2435 return -1;
2436 }
2437 size = p->size;
2438 ispackage = (size < 0);
2439 if (ispackage)
2440 size = -size;
2441 if (Py_VerboseFlag)
Victor Stinner53dc7352011-03-20 01:50:21 +01002442 PySys_FormatStderr("import %U # frozen%s\n",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002443 name, ispackage ? " package" : "");
2444 co = PyMarshal_ReadObjectFromString((char *)p->code, size);
2445 if (co == NULL)
2446 return -1;
2447 if (!PyCode_Check(co)) {
2448 PyErr_Format(PyExc_TypeError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002449 "frozen object %R is not a code object",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002450 name);
2451 goto err_return;
2452 }
2453 if (ispackage) {
2454 /* Set __path__ to the package name */
Victor Stinner53dc7352011-03-20 01:50:21 +01002455 PyObject *d, *l;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002456 int err;
Victor Stinner53dc7352011-03-20 01:50:21 +01002457 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002458 if (m == NULL)
2459 goto err_return;
2460 d = PyModule_GetDict(m);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002461 l = PyList_New(1);
2462 if (l == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002463 goto err_return;
2464 }
Victor Stinner53dc7352011-03-20 01:50:21 +01002465 Py_INCREF(name);
2466 PyList_SET_ITEM(l, 0, name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002467 err = PyDict_SetItemString(d, "__path__", l);
2468 Py_DECREF(l);
2469 if (err != 0)
2470 goto err_return;
2471 }
Victor Stinner53dc7352011-03-20 01:50:21 +01002472 path = PyUnicode_FromString("<frozen>");
2473 if (path == NULL)
2474 goto err_return;
2475 m = PyImport_ExecCodeModuleObject(name, co, path, NULL);
2476 Py_DECREF(path);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002477 if (m == NULL)
2478 goto err_return;
2479 Py_DECREF(co);
2480 Py_DECREF(m);
2481 return 1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002482err_return:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002483 Py_DECREF(co);
2484 return -1;
Guido van Rossumf56e3db1993-04-01 20:59:32 +00002485}
Guido van Rossum74e6a111994-08-29 12:54:38 +00002486
Victor Stinner53dc7352011-03-20 01:50:21 +01002487int
2488PyImport_ImportFrozenModule(char *name)
2489{
2490 PyObject *nameobj;
2491 int ret;
2492 nameobj = PyUnicode_InternFromString(name);
2493 if (nameobj == NULL)
2494 return -1;
2495 ret = PyImport_ImportFrozenModuleObject(nameobj);
2496 Py_DECREF(nameobj);
2497 return ret;
2498}
2499
Guido van Rossum74e6a111994-08-29 12:54:38 +00002500
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002501/* Import a module, either built-in, frozen, or external, and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00002502 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum74e6a111994-08-29 12:54:38 +00002503
Guido van Rossum79f25d91997-04-29 20:08:16 +00002504PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00002505PyImport_ImportModule(const char *name)
Guido van Rossum74e6a111994-08-29 12:54:38 +00002506{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002507 PyObject *pname;
2508 PyObject *result;
Marc-André Lemburg3c61c352001-02-09 19:40:15 +00002509
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002510 pname = PyUnicode_FromString(name);
2511 if (pname == NULL)
2512 return NULL;
2513 result = PyImport_Import(pname);
2514 Py_DECREF(pname);
2515 return result;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002516}
2517
Christian Heimes072c0f12008-01-03 23:01:04 +00002518/* Import a module without blocking
2519 *
2520 * At first it tries to fetch the module from sys.modules. If the module was
2521 * never loaded before it loads it with PyImport_ImportModule() unless another
2522 * thread holds the import lock. In the latter case the function raises an
2523 * ImportError instead of blocking.
2524 *
2525 * Returns the module object with incremented ref count.
2526 */
2527PyObject *
2528PyImport_ImportModuleNoBlock(const char *name)
2529{
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002530 PyObject *nameobj, *modules, *result;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002531 long me;
Christian Heimes072c0f12008-01-03 23:01:04 +00002532
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002533 /* Try to get the module from sys.modules[name] */
2534 modules = PyImport_GetModuleDict();
2535 if (modules == NULL)
2536 return NULL;
Christian Heimes072c0f12008-01-03 23:01:04 +00002537
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002538 nameobj = PyUnicode_FromString(name);
2539 if (nameobj == NULL)
2540 return NULL;
2541 result = PyDict_GetItem(modules, nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002542 if (result != NULL) {
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002543 Py_DECREF(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002544 Py_INCREF(result);
2545 return result;
2546 }
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002547 PyErr_Clear();
Benjamin Peterson3e4f0552008-09-02 00:31:15 +00002548#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002549 /* check the import lock
2550 * me might be -1 but I ignore the error here, the lock function
2551 * takes care of the problem */
2552 me = PyThread_get_thread_ident();
2553 if (import_lock_thread == -1 || import_lock_thread == me) {
2554 /* no thread or me is holding the lock */
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002555 result = PyImport_Import(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002556 }
2557 else {
2558 PyErr_Format(PyExc_ImportError,
Victor Stinnerc24c8102011-03-13 22:38:06 -04002559 "Failed to import %R because the import lock"
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002560 "is held by another thread.",
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002561 nameobj);
2562 result = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002563 }
Benjamin Peterson3e4f0552008-09-02 00:31:15 +00002564#else
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002565 result = PyImport_Import(nameobj);
Benjamin Peterson3e4f0552008-09-02 00:31:15 +00002566#endif
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002567 Py_DECREF(nameobj);
2568 return result;
Christian Heimes072c0f12008-01-03 23:01:04 +00002569}
2570
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002571/* Forward declarations for helper routines */
Victor Stinner974389d2011-03-15 09:33:57 +01002572static PyObject *get_parent(PyObject *globals,
2573 PyObject **p_name,
2574 int level);
Tim Petersdbd9ba62000-07-09 03:09:57 +00002575static PyObject *load_next(PyObject *mod, PyObject *altmod,
Victor Stinner974389d2011-03-15 09:33:57 +01002576 PyObject *inputname, PyObject **p_outputname,
2577 Py_UNICODE *buf, Py_ssize_t *p_buflen,
2578 Py_ssize_t bufsize);
2579static int mark_miss(PyObject *name);
Tim Petersdbd9ba62000-07-09 03:09:57 +00002580static int ensure_fromlist(PyObject *mod, PyObject *fromlist,
Victor Stinner974389d2011-03-15 09:33:57 +01002581 PyObject *buf, int recursive);
2582static PyObject * import_submodule(PyObject *mod, PyObject *name,
2583 PyObject *fullname);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002584
2585/* The Magnum Opus of dotted-name import :-) */
2586
Guido van Rossum75acc9c1998-03-03 22:26:50 +00002587static PyObject *
Victor Stinner974389d2011-03-15 09:33:57 +01002588import_module_level(PyObject *name, PyObject *globals, PyObject *locals,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002589 PyObject *fromlist, int level)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002590{
Victor Stinner974389d2011-03-15 09:33:57 +01002591 Py_UNICODE buf[MAXPATHLEN+1];
2592 Py_ssize_t buflen;
2593 Py_ssize_t bufsize = MAXPATHLEN+1;
2594 PyObject *parent, *head, *next, *tail, *inputname, *outputname;
2595 PyObject *parent_name, *ensure_name;
2596 const Py_UNICODE *nameunicode;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002597
Victor Stinner974389d2011-03-15 09:33:57 +01002598 nameunicode = PyUnicode_AS_UNICODE(name);
2599
2600 if (Py_UNICODE_strchr(nameunicode, SEP) != NULL
2601#ifdef ALTSEP
2602 || Py_UNICODE_strchr(nameunicode, ALTSEP) != NULL
Christian Heimes454f37b2008-01-10 00:10:02 +00002603#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002604 ) {
2605 PyErr_SetString(PyExc_ImportError,
2606 "Import by filename is not supported.");
2607 return NULL;
2608 }
Christian Heimes454f37b2008-01-10 00:10:02 +00002609
Victor Stinner974389d2011-03-15 09:33:57 +01002610 parent = get_parent(globals, &parent_name, level);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002611 if (parent == NULL)
2612 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002613
Victor Stinner974389d2011-03-15 09:33:57 +01002614 buflen = PyUnicode_GET_SIZE(parent_name);
2615 if (buflen+1 > bufsize) {
2616 Py_DECREF(parent_name);
2617 PyErr_SetString(PyExc_ValueError,
2618 "Module name too long");
2619 return NULL;
2620 }
2621 Py_UNICODE_strcpy(buf, PyUnicode_AS_UNICODE(parent_name));
2622 Py_DECREF(parent_name);
2623
2624 head = load_next(parent, level < 0 ? Py_None : parent, name, &outputname,
2625 buf, &buflen, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002626 if (head == NULL)
2627 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002628
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002629 tail = head;
2630 Py_INCREF(tail);
Victor Stinner974389d2011-03-15 09:33:57 +01002631
2632 if (outputname != NULL) {
2633 while (1) {
2634 inputname = outputname;
2635 next = load_next(tail, tail, inputname, &outputname,
2636 buf, &buflen, bufsize);
2637 Py_DECREF(tail);
2638 Py_DECREF(inputname);
2639 if (next == NULL) {
2640 Py_DECREF(head);
2641 return NULL;
2642 }
2643 tail = next;
2644
2645 if (outputname == NULL) {
2646 break;
2647 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002648 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002649 }
2650 if (tail == Py_None) {
2651 /* If tail is Py_None, both get_parent and load_next found
2652 an empty module name: someone called __import__("") or
2653 doctored faulty bytecode */
2654 Py_DECREF(tail);
2655 Py_DECREF(head);
Victor Stinner974389d2011-03-15 09:33:57 +01002656 PyErr_SetString(PyExc_ValueError, "Empty module name");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002657 return NULL;
2658 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002659
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002660 if (fromlist != NULL) {
2661 if (fromlist == Py_None || !PyObject_IsTrue(fromlist))
2662 fromlist = NULL;
2663 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002664
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002665 if (fromlist == NULL) {
2666 Py_DECREF(tail);
2667 return head;
2668 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002669
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002670 Py_DECREF(head);
Victor Stinner974389d2011-03-15 09:33:57 +01002671
2672 ensure_name = PyUnicode_FromUnicode(buf, Py_UNICODE_strlen(buf));
2673 if (ensure_name == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002674 Py_DECREF(tail);
2675 return NULL;
2676 }
Victor Stinner974389d2011-03-15 09:33:57 +01002677 if (!ensure_fromlist(tail, fromlist, ensure_name, 0)) {
2678 Py_DECREF(tail);
2679 Py_DECREF(ensure_name);
2680 return NULL;
2681 }
2682 Py_DECREF(ensure_name);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002683
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002684 return tail;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002685}
2686
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002687PyObject *
2688PyImport_ImportModuleLevel(char *name, PyObject *globals, PyObject *locals,
Victor Stinner974389d2011-03-15 09:33:57 +01002689 PyObject *fromlist, int level)
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002690{
Victor Stinner974389d2011-03-15 09:33:57 +01002691 PyObject *nameobj, *result;
2692 nameobj = PyUnicode_FromString(name);
2693 if (nameobj == NULL)
2694 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002695 _PyImport_AcquireLock();
Victor Stinner974389d2011-03-15 09:33:57 +01002696 result = import_module_level(nameobj, globals, locals, fromlist, level);
2697 Py_DECREF(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002698 if (_PyImport_ReleaseLock() < 0) {
2699 Py_XDECREF(result);
2700 PyErr_SetString(PyExc_RuntimeError,
2701 "not holding the import lock");
2702 return NULL;
2703 }
2704 return result;
Guido van Rossum75acc9c1998-03-03 22:26:50 +00002705}
2706
Fred Drake87590902004-05-28 20:21:36 +00002707/* Return the package that an import is being performed in. If globals comes
2708 from the module foo.bar.bat (not itself a package), this returns the
2709 sys.modules entry for foo.bar. If globals is from a package's __init__.py,
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00002710 the package's entry in sys.modules is returned, as a borrowed reference.
Fred Drake87590902004-05-28 20:21:36 +00002711
Victor Stinner974389d2011-03-15 09:33:57 +01002712 The name of the returned package is returned in *p_name.
Fred Drake87590902004-05-28 20:21:36 +00002713
2714 If globals doesn't come from a package or a module in a package, or a
2715 corresponding entry is not found in sys.modules, Py_None is returned.
2716*/
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002717static PyObject *
Victor Stinner9599de52011-03-13 22:38:38 -04002718get_parent(PyObject *globals, PyObject **p_name, int level)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002719{
Victor Stinner974389d2011-03-15 09:33:57 +01002720 Py_UNICODE name[MAXPATHLEN+1];
2721 const Py_ssize_t bufsize = MAXPATHLEN+1;
2722 PyObject *nameobj;
2723
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002724 static PyObject *namestr = NULL;
2725 static PyObject *pathstr = NULL;
2726 static PyObject *pkgstr = NULL;
2727 PyObject *pkgname, *modname, *modpath, *modules, *parent;
2728 int orig_level = level;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002729
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002730 if (globals == NULL || !PyDict_Check(globals) || !level)
Victor Stinner974389d2011-03-15 09:33:57 +01002731 goto return_none;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002732
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002733 if (namestr == NULL) {
2734 namestr = PyUnicode_InternFromString("__name__");
2735 if (namestr == NULL)
2736 return NULL;
2737 }
2738 if (pathstr == NULL) {
2739 pathstr = PyUnicode_InternFromString("__path__");
2740 if (pathstr == NULL)
2741 return NULL;
2742 }
2743 if (pkgstr == NULL) {
2744 pkgstr = PyUnicode_InternFromString("__package__");
2745 if (pkgstr == NULL)
2746 return NULL;
2747 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002748
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002749 pkgname = PyDict_GetItem(globals, pkgstr);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002750
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002751 if ((pkgname != NULL) && (pkgname != Py_None)) {
2752 /* __package__ is set, so use it */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002753 if (!PyUnicode_Check(pkgname)) {
2754 PyErr_SetString(PyExc_ValueError,
2755 "__package__ set to non-string");
2756 return NULL;
2757 }
Victor Stinner974389d2011-03-15 09:33:57 +01002758 if (PyUnicode_GET_SIZE(pkgname) == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002759 if (level > 0) {
2760 PyErr_SetString(PyExc_ValueError,
2761 "Attempted relative import in non-package");
2762 return NULL;
2763 }
Victor Stinner974389d2011-03-15 09:33:57 +01002764 goto return_none;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002765 }
Victor Stinner974389d2011-03-15 09:33:57 +01002766 if (PyUnicode_GET_SIZE(pkgname)+1 > bufsize) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002767 PyErr_SetString(PyExc_ValueError,
2768 "Package name too long");
2769 return NULL;
2770 }
Victor Stinner974389d2011-03-15 09:33:57 +01002771 Py_UNICODE_strcpy(name, PyUnicode_AS_UNICODE(pkgname));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002772 } else {
2773 /* __package__ not set, so figure it out and set it */
2774 modname = PyDict_GetItem(globals, namestr);
2775 if (modname == NULL || !PyUnicode_Check(modname))
Victor Stinner974389d2011-03-15 09:33:57 +01002776 goto return_none;
Brett Cannon9a5b25a2010-03-01 02:09:17 +00002777
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002778 modpath = PyDict_GetItem(globals, pathstr);
2779 if (modpath != NULL) {
2780 /* __path__ is set, so modname is already the package name */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002781 int error;
Alexandre Vassalottia85998a2008-05-03 18:24:43 +00002782
Victor Stinner974389d2011-03-15 09:33:57 +01002783 if (PyUnicode_GET_SIZE(modname)+1 > bufsize) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002784 PyErr_SetString(PyExc_ValueError,
2785 "Module name too long");
2786 return NULL;
2787 }
Victor Stinner974389d2011-03-15 09:33:57 +01002788 Py_UNICODE_strcpy(name, PyUnicode_AS_UNICODE(modname));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002789 error = PyDict_SetItem(globals, pkgstr, modname);
2790 if (error) {
2791 PyErr_SetString(PyExc_ValueError,
2792 "Could not set __package__");
2793 return NULL;
2794 }
2795 } else {
2796 /* Normal module, so work out the package name if any */
Victor Stinner974389d2011-03-15 09:33:57 +01002797 Py_UNICODE *start = PyUnicode_AS_UNICODE(modname);
2798 Py_UNICODE *lastdot = Py_UNICODE_strrchr(start, '.');
2799 Py_ssize_t len;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002800 int error;
2801 if (lastdot == NULL && level > 0) {
2802 PyErr_SetString(PyExc_ValueError,
2803 "Attempted relative import in non-package");
2804 return NULL;
2805 }
2806 if (lastdot == NULL) {
2807 error = PyDict_SetItem(globals, pkgstr, Py_None);
2808 if (error) {
2809 PyErr_SetString(PyExc_ValueError,
2810 "Could not set __package__");
2811 return NULL;
2812 }
Victor Stinner974389d2011-03-15 09:33:57 +01002813 goto return_none;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002814 }
2815 len = lastdot - start;
Victor Stinner974389d2011-03-15 09:33:57 +01002816 if (len+1 > bufsize) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002817 PyErr_SetString(PyExc_ValueError,
2818 "Module name too long");
2819 return NULL;
2820 }
Victor Stinner974389d2011-03-15 09:33:57 +01002821 Py_UNICODE_strncpy(name, start, len);
2822 name[len] = '\0';
2823 pkgname = PyUnicode_FromUnicode(name, len);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002824 if (pkgname == NULL) {
2825 return NULL;
2826 }
2827 error = PyDict_SetItem(globals, pkgstr, pkgname);
2828 Py_DECREF(pkgname);
2829 if (error) {
2830 PyErr_SetString(PyExc_ValueError,
2831 "Could not set __package__");
2832 return NULL;
2833 }
2834 }
2835 }
2836 while (--level > 0) {
Victor Stinner974389d2011-03-15 09:33:57 +01002837 Py_UNICODE *dot = Py_UNICODE_strrchr(name, '.');
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002838 if (dot == NULL) {
2839 PyErr_SetString(PyExc_ValueError,
2840 "Attempted relative import beyond "
2841 "toplevel package");
2842 return NULL;
2843 }
2844 *dot = '\0';
2845 }
Victor Stinner974389d2011-03-15 09:33:57 +01002846
2847 nameobj = PyUnicode_FromUnicode(name, Py_UNICODE_strlen(name));
2848 if (nameobj == NULL)
2849 return NULL;
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002850
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002851 modules = PyImport_GetModuleDict();
Victor Stinner974389d2011-03-15 09:33:57 +01002852 parent = PyDict_GetItem(modules, nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002853 if (parent == NULL) {
Victor Stinner974389d2011-03-15 09:33:57 +01002854 int err;
2855
2856 if (orig_level >= 1) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002857 PyErr_Format(PyExc_SystemError,
Victor Stinner974389d2011-03-15 09:33:57 +01002858 "Parent module %R not loaded, "
2859 "cannot perform relative import", nameobj);
2860 Py_DECREF(nameobj);
2861 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002862 }
Victor Stinner974389d2011-03-15 09:33:57 +01002863
2864 err = PyErr_WarnFormat(
2865 PyExc_RuntimeWarning, 1,
2866 "Parent module %R not found while handling absolute import",
2867 nameobj);
2868 Py_DECREF(nameobj);
2869 if (err)
2870 return NULL;
2871
2872 goto return_none;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002873 }
Victor Stinner974389d2011-03-15 09:33:57 +01002874 *p_name = nameobj;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002875 return parent;
2876 /* We expect, but can't guarantee, if parent != None, that:
Victor Stinner974389d2011-03-15 09:33:57 +01002877 - parent.__name__ == name
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002878 - parent.__dict__ is globals
2879 If this is violated... Who cares? */
Victor Stinner974389d2011-03-15 09:33:57 +01002880
2881return_none:
2882 nameobj = PyUnicode_FromUnicode(NULL, 0);
2883 if (nameobj == NULL)
2884 return NULL;
2885 *p_name = nameobj;
2886 return Py_None;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002887}
2888
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002889/* altmod is either None or same as mod */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002890static PyObject *
Victor Stinner974389d2011-03-15 09:33:57 +01002891load_next(PyObject *mod, PyObject *altmod,
2892 PyObject *inputname, PyObject **p_outputname,
2893 Py_UNICODE *buf, Py_ssize_t *p_buflen, Py_ssize_t bufsize)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002894{
Victor Stinner974389d2011-03-15 09:33:57 +01002895 const Py_UNICODE *dot;
2896 Py_ssize_t len;
2897 Py_UNICODE *p;
2898 PyObject *fullname, *name, *result, *mark_name;
2899 const Py_UNICODE *nameuni;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002900
Victor Stinner974389d2011-03-15 09:33:57 +01002901 *p_outputname = NULL;
2902
2903 if (PyUnicode_GET_SIZE(inputname) == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002904 /* completely empty module name should only happen in
2905 'from . import' (or '__import__("")')*/
2906 Py_INCREF(mod);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002907 return mod;
2908 }
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002909
Victor Stinner974389d2011-03-15 09:33:57 +01002910 nameuni = PyUnicode_AS_UNICODE(inputname);
2911 if (nameuni == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002912 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002913
Victor Stinner974389d2011-03-15 09:33:57 +01002914 dot = Py_UNICODE_strchr(nameuni, '.');
2915 if (dot != NULL) {
2916 len = dot - nameuni;
2917 if (len == 0) {
2918 PyErr_SetString(PyExc_ValueError,
2919 "Empty module name");
2920 return NULL;
2921 }
2922 }
2923 else
2924 len = PyUnicode_GET_SIZE(inputname);
2925
2926 if (*p_buflen+len+1 >= bufsize) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002927 PyErr_SetString(PyExc_ValueError,
2928 "Module name too long");
2929 return NULL;
2930 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002931
Victor Stinner974389d2011-03-15 09:33:57 +01002932 p = buf + *p_buflen;
2933 if (p != buf) {
2934 *p++ = '.';
2935 *p_buflen += 1;
2936 }
2937 Py_UNICODE_strncpy(p, nameuni, len);
2938 p[len] = '\0';
2939 *p_buflen += len;
2940
2941 fullname = PyUnicode_FromUnicode(buf, *p_buflen);
2942 if (fullname == NULL)
2943 return NULL;
2944 name = PyUnicode_FromUnicode(p, len);
2945 if (name == NULL) {
2946 Py_DECREF(fullname);
2947 return NULL;
2948 }
2949 result = import_submodule(mod, name, fullname);
2950 Py_DECREF(fullname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002951 if (result == Py_None && altmod != mod) {
2952 Py_DECREF(result);
2953 /* Here, altmod must be None and mod must not be None */
Victor Stinner974389d2011-03-15 09:33:57 +01002954 result = import_submodule(altmod, name, name);
2955 Py_DECREF(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002956 if (result != NULL && result != Py_None) {
Victor Stinner974389d2011-03-15 09:33:57 +01002957 mark_name = PyUnicode_FromUnicode(buf, *p_buflen);
2958 if (mark_name == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002959 Py_DECREF(result);
2960 return NULL;
2961 }
Victor Stinner974389d2011-03-15 09:33:57 +01002962 if (mark_miss(mark_name) != 0) {
2963 Py_DECREF(result);
2964 Py_DECREF(mark_name);
2965 return NULL;
2966 }
2967 Py_DECREF(mark_name);
2968 Py_UNICODE_strncpy(buf, nameuni, len);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002969 buf[len] = '\0';
2970 *p_buflen = len;
2971 }
2972 }
Victor Stinner974389d2011-03-15 09:33:57 +01002973 else
2974 Py_DECREF(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002975 if (result == NULL)
2976 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002977
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002978 if (result == Py_None) {
2979 Py_DECREF(result);
2980 PyErr_Format(PyExc_ImportError,
Victor Stinner974389d2011-03-15 09:33:57 +01002981 "No module named %R", inputname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002982 return NULL;
2983 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002984
Victor Stinner974389d2011-03-15 09:33:57 +01002985 if (dot != NULL) {
2986 *p_outputname = PyUnicode_FromUnicode(dot+1, Py_UNICODE_strlen(dot+1));
2987 if (*p_outputname == NULL) {
2988 Py_DECREF(result);
2989 return NULL;
2990 }
2991 }
2992
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002993 return result;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002994}
2995
2996static int
Victor Stinner974389d2011-03-15 09:33:57 +01002997mark_miss(PyObject *name)
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00002998{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002999 PyObject *modules = PyImport_GetModuleDict();
Victor Stinner974389d2011-03-15 09:33:57 +01003000 return PyDict_SetItem(modules, name, Py_None);
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00003001}
3002
3003static int
Victor Stinner974389d2011-03-15 09:33:57 +01003004ensure_fromlist(PyObject *mod, PyObject *fromlist, PyObject *name,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003005 int recursive)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003006{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003007 int i;
Victor Stinner974389d2011-03-15 09:33:57 +01003008 PyObject *fullname;
3009 Py_ssize_t fromlist_len;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003010
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003011 if (!PyObject_HasAttrString(mod, "__path__"))
3012 return 1;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003013
Victor Stinner974389d2011-03-15 09:33:57 +01003014 fromlist_len = PySequence_Size(fromlist);
3015
3016 for (i = 0; i < fromlist_len; i++) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003017 PyObject *item = PySequence_GetItem(fromlist, i);
3018 int hasit;
Victor Stinner974389d2011-03-15 09:33:57 +01003019 if (item == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003020 return 0;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003021 if (!PyUnicode_Check(item)) {
3022 PyErr_SetString(PyExc_TypeError,
3023 "Item in ``from list'' not a string");
3024 Py_DECREF(item);
3025 return 0;
3026 }
3027 if (PyUnicode_AS_UNICODE(item)[0] == '*') {
3028 PyObject *all;
3029 Py_DECREF(item);
3030 /* See if the package defines __all__ */
3031 if (recursive)
3032 continue; /* Avoid endless recursion */
3033 all = PyObject_GetAttrString(mod, "__all__");
3034 if (all == NULL)
3035 PyErr_Clear();
3036 else {
Victor Stinner974389d2011-03-15 09:33:57 +01003037 int ret = ensure_fromlist(mod, all, name, 1);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003038 Py_DECREF(all);
3039 if (!ret)
3040 return 0;
3041 }
3042 continue;
3043 }
3044 hasit = PyObject_HasAttr(mod, item);
3045 if (!hasit) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003046 PyObject *submod;
Victor Stinner974389d2011-03-15 09:33:57 +01003047 fullname = PyUnicode_FromFormat("%U.%U", name, item);
3048 if (fullname != NULL) {
3049 submod = import_submodule(mod, item, fullname);
3050 Py_DECREF(fullname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003051 }
Victor Stinner974389d2011-03-15 09:33:57 +01003052 else
3053 submod = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003054 Py_XDECREF(submod);
3055 if (submod == NULL) {
3056 Py_DECREF(item);
3057 return 0;
3058 }
3059 }
3060 Py_DECREF(item);
3061 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003062
Victor Stinner974389d2011-03-15 09:33:57 +01003063 return 1;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003064}
3065
Neil Schemenauer00b09662003-06-16 21:03:07 +00003066static int
Victor Stinner974389d2011-03-15 09:33:57 +01003067add_submodule(PyObject *mod, PyObject *submod, PyObject *fullname,
3068 PyObject *subname, PyObject *modules)
Neil Schemenauer00b09662003-06-16 21:03:07 +00003069{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003070 if (mod == Py_None)
3071 return 1;
3072 /* Irrespective of the success of this load, make a
3073 reference to it in the parent package module. A copy gets
3074 saved in the modules dictionary under the full name, so get a
3075 reference from there, if need be. (The exception is when the
3076 load failed with a SyntaxError -- then there's no trace in
3077 sys.modules. In that case, of course, do nothing extra.) */
3078 if (submod == NULL) {
Victor Stinner974389d2011-03-15 09:33:57 +01003079 submod = PyDict_GetItem(modules, fullname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003080 if (submod == NULL)
3081 return 1;
3082 }
3083 if (PyModule_Check(mod)) {
3084 /* We can't use setattr here since it can give a
3085 * spurious warning if the submodule name shadows a
3086 * builtin name */
3087 PyObject *dict = PyModule_GetDict(mod);
3088 if (!dict)
3089 return 0;
Victor Stinner974389d2011-03-15 09:33:57 +01003090 if (PyDict_SetItem(dict, subname, submod) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003091 return 0;
3092 }
3093 else {
Victor Stinner974389d2011-03-15 09:33:57 +01003094 if (PyObject_SetAttr(mod, subname, submod) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003095 return 0;
3096 }
3097 return 1;
Neil Schemenauer00b09662003-06-16 21:03:07 +00003098}
3099
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003100static PyObject *
Victor Stinner974389d2011-03-15 09:33:57 +01003101import_submodule(PyObject *mod, PyObject *subname, PyObject *fullname)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003102{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003103 PyObject *modules = PyImport_GetModuleDict();
Victor Stinner533d7832011-03-14 13:22:54 -04003104 PyObject *m = NULL, *bufobj, *path_list, *loader;
Victor Stinner9599de52011-03-13 22:38:38 -04003105 char buf[MAXPATHLEN+1];
3106 struct filedescr *fdp;
3107 FILE *fp;
Guido van Rossum74e6a111994-08-29 12:54:38 +00003108
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003109 /* Require:
3110 if mod == None: subname == fullname
3111 else: mod.__name__ + "." + subname == fullname
3112 */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003113
Victor Stinner974389d2011-03-15 09:33:57 +01003114 if ((m = PyDict_GetItem(modules, fullname)) != NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003115 Py_INCREF(m);
Victor Stinner9599de52011-03-13 22:38:38 -04003116 return m;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003117 }
Victor Stinner9599de52011-03-13 22:38:38 -04003118
3119 if (mod == Py_None)
Victor Stinner533d7832011-03-14 13:22:54 -04003120 path_list = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003121 else {
Victor Stinner533d7832011-03-14 13:22:54 -04003122 path_list = PyObject_GetAttrString(mod, "__path__");
3123 if (path_list == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003124 PyErr_Clear();
3125 Py_INCREF(Py_None);
3126 return Py_None;
3127 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003128 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003129
Victor Stinner533d7832011-03-14 13:22:54 -04003130 fdp = find_module(fullname, subname, path_list,
3131 buf, MAXPATHLEN+1, &fp, &loader);
3132 Py_XDECREF(path_list);
Victor Stinner9599de52011-03-13 22:38:38 -04003133 if (fdp == NULL) {
3134 if (!PyErr_ExceptionMatches(PyExc_ImportError))
3135 return NULL;
3136 PyErr_Clear();
3137 Py_INCREF(Py_None);
3138 return Py_None;
3139 }
3140 bufobj = PyUnicode_DecodeFSDefault(buf);
3141 if (bufobj != NULL) {
3142 m = load_module(fullname, fp, bufobj, fdp->type, loader);
3143 Py_DECREF(bufobj);
3144 }
3145 else
3146 m = NULL;
3147 Py_XDECREF(loader);
3148 if (fp)
3149 fclose(fp);
3150 if (m == NULL)
3151 return NULL;
3152 if (!add_submodule(mod, m, fullname, subname, modules)) {
3153 Py_XDECREF(m);
3154 return NULL;
3155 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003156 return m;
Guido van Rossum74e6a111994-08-29 12:54:38 +00003157}
3158
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003159
3160/* Re-import a module of any kind and return its module object, WITH
3161 INCREMENTED REFERENCE COUNT */
3162
Guido van Rossum79f25d91997-04-29 20:08:16 +00003163PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003164PyImport_ReloadModule(PyObject *m)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003165{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003166 PyInterpreterState *interp = PyThreadState_Get()->interp;
3167 PyObject *modules_reloading = interp->modules_reloading;
3168 PyObject *modules = PyImport_GetModuleDict();
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003169 char buf[MAXPATHLEN+1];
Victor Stinner533d7832011-03-14 13:22:54 -04003170 PyObject *path_list = NULL, *loader = NULL, *existing_m = NULL;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003171 PyObject *nameobj, *bufobj, *subnameobj;
3172 Py_UNICODE *name, *subname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003173 struct filedescr *fdp;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003174 FILE *fp = NULL;
3175 PyObject *newm = NULL;
Brett Cannon9a5b25a2010-03-01 02:09:17 +00003176
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003177 if (modules_reloading == NULL) {
3178 Py_FatalError("PyImport_ReloadModule: "
3179 "no modules_reloading dictionary!");
3180 return NULL;
3181 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003182
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003183 if (m == NULL || !PyModule_Check(m)) {
3184 PyErr_SetString(PyExc_TypeError,
3185 "reload() argument must be module");
3186 return NULL;
3187 }
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003188 nameobj = PyModule_GetNameObject(m);
3189 if (nameobj == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003190 return NULL;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003191 if (m != PyDict_GetItem(modules, nameobj)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003192 PyErr_Format(PyExc_ImportError,
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003193 "reload(): module %U not in sys.modules",
3194 nameobj);
3195 Py_DECREF(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003196 return NULL;
3197 }
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003198 existing_m = PyDict_GetItem(modules_reloading, nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003199 if (existing_m != NULL) {
3200 /* Due to a recursive reload, this module is already
3201 being reloaded. */
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003202 Py_DECREF(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003203 Py_INCREF(existing_m);
3204 return existing_m;
3205 }
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003206 if (PyDict_SetItem(modules_reloading, nameobj, m) < 0) {
3207 Py_DECREF(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003208 return NULL;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003209 }
Guido van Rossumd8faa362007-04-27 19:54:29 +00003210
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003211 name = PyUnicode_AS_UNICODE(nameobj);
3212 subname = Py_UNICODE_strrchr(name, '.');
3213 if (subname == NULL) {
3214 Py_INCREF(nameobj);
3215 subnameobj = nameobj;
3216 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003217 else {
3218 PyObject *parentname, *parent;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003219 Py_ssize_t len;
3220 len = subname - name;
3221 parentname = PyUnicode_FromUnicode(name, len);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003222 if (parentname == NULL) {
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003223 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003224 }
3225 parent = PyDict_GetItem(modules, parentname);
3226 if (parent == NULL) {
3227 PyErr_Format(PyExc_ImportError,
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003228 "reload(): parent %U not in sys.modules",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003229 parentname);
3230 Py_DECREF(parentname);
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003231 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003232 }
3233 Py_DECREF(parentname);
Victor Stinner533d7832011-03-14 13:22:54 -04003234 path_list = PyObject_GetAttrString(parent, "__path__");
3235 if (path_list == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003236 PyErr_Clear();
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003237 subname++;
3238 len = PyUnicode_GET_SIZE(nameobj) - (len + 1);
3239 subnameobj = PyUnicode_FromUnicode(subname, len);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003240 }
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003241 if (subnameobj == NULL)
3242 goto error;
Victor Stinner533d7832011-03-14 13:22:54 -04003243 fdp = find_module(nameobj, subnameobj, path_list,
3244 buf, MAXPATHLEN+1, &fp, &loader);
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003245 Py_DECREF(subnameobj);
Victor Stinner533d7832011-03-14 13:22:54 -04003246 Py_XDECREF(path_list);
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00003247
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003248 if (fdp == NULL) {
3249 Py_XDECREF(loader);
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003250 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003251 }
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00003252
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003253 bufobj = PyUnicode_DecodeFSDefault(buf);
3254 if (bufobj != NULL) {
3255 newm = load_module(nameobj, fp, bufobj, fdp->type, loader);
3256 Py_DECREF(bufobj);
Victor Stinner41c5fec2011-03-13 21:46:30 -04003257 }
3258 else
3259 newm = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003260 Py_XDECREF(loader);
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00003261
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003262 if (fp)
3263 fclose(fp);
3264 if (newm == NULL) {
3265 /* load_module probably removed name from modules because of
3266 * the error. Put back the original module object. We're
3267 * going to return NULL in this case regardless of whether
3268 * replacing name succeeds, so the return value is ignored.
3269 */
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003270 PyDict_SetItem(modules, nameobj, m);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003271 }
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003272
3273error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003274 imp_modules_reloading_clear();
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003275 Py_DECREF(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003276 return newm;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003277}
3278
3279
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003280/* Higher-level import emulator which emulates the "import" statement
3281 more accurately -- it invokes the __import__() function from the
3282 builtins of the current globals. This means that the import is
3283 done using whatever import hooks are installed in the current
Brett Cannonbc2eff32010-09-19 21:39:02 +00003284 environment.
Guido van Rossum6058eb41998-12-21 19:51:00 +00003285 A dummy list ["__doc__"] is passed as the 4th argument so that
Neal Norwitz80e7f272007-08-26 06:45:23 +00003286 e.g. PyImport_Import(PyUnicode_FromString("win32com.client.gencache"))
Guido van Rossum6058eb41998-12-21 19:51:00 +00003287 will return <module "gencache"> instead of <module "win32com">. */
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003288
3289PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003290PyImport_Import(PyObject *module_name)
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003291{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003292 static PyObject *silly_list = NULL;
3293 static PyObject *builtins_str = NULL;
3294 static PyObject *import_str = NULL;
3295 PyObject *globals = NULL;
3296 PyObject *import = NULL;
3297 PyObject *builtins = NULL;
Brett Cannonbc2eff32010-09-19 21:39:02 +00003298 PyObject *modules = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003299 PyObject *r = NULL;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003300
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003301 /* Initialize constant string objects */
3302 if (silly_list == NULL) {
3303 import_str = PyUnicode_InternFromString("__import__");
3304 if (import_str == NULL)
3305 return NULL;
3306 builtins_str = PyUnicode_InternFromString("__builtins__");
3307 if (builtins_str == NULL)
3308 return NULL;
Brett Cannonbc2eff32010-09-19 21:39:02 +00003309 silly_list = PyList_New(0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003310 if (silly_list == NULL)
3311 return NULL;
3312 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003313
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003314 /* Get the builtins from current globals */
3315 globals = PyEval_GetGlobals();
3316 if (globals != NULL) {
3317 Py_INCREF(globals);
3318 builtins = PyObject_GetItem(globals, builtins_str);
3319 if (builtins == NULL)
3320 goto err;
3321 }
3322 else {
3323 /* No globals -- use standard builtins, and fake globals */
3324 builtins = PyImport_ImportModuleLevel("builtins",
3325 NULL, NULL, NULL, 0);
3326 if (builtins == NULL)
3327 return NULL;
3328 globals = Py_BuildValue("{OO}", builtins_str, builtins);
3329 if (globals == NULL)
3330 goto err;
3331 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003332
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003333 /* Get the __import__ function from the builtins */
3334 if (PyDict_Check(builtins)) {
3335 import = PyObject_GetItem(builtins, import_str);
3336 if (import == NULL)
3337 PyErr_SetObject(PyExc_KeyError, import_str);
3338 }
3339 else
3340 import = PyObject_GetAttr(builtins, import_str);
3341 if (import == NULL)
3342 goto err;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003343
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003344 /* Call the __import__ function with the proper argument list
Brett Cannonbc2eff32010-09-19 21:39:02 +00003345 Always use absolute import here.
3346 Calling for side-effect of import. */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003347 r = PyObject_CallFunction(import, "OOOOi", module_name, globals,
3348 globals, silly_list, 0, NULL);
Brett Cannonbc2eff32010-09-19 21:39:02 +00003349 if (r == NULL)
3350 goto err;
3351 Py_DECREF(r);
3352
3353 modules = PyImport_GetModuleDict();
3354 r = PyDict_GetItem(modules, module_name);
3355 if (r != NULL)
3356 Py_INCREF(r);
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003357
3358 err:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003359 Py_XDECREF(globals);
3360 Py_XDECREF(builtins);
3361 Py_XDECREF(import);
Tim Peters50d8d372001-02-28 05:34:27 +00003362
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003363 return r;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003364}
3365
3366
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003367/* Module 'imp' provides Python access to the primitives used for
3368 importing modules.
3369*/
3370
Guido van Rossum79f25d91997-04-29 20:08:16 +00003371static PyObject *
Barry Warsaw28a691b2010-04-17 00:19:56 +00003372imp_make_magic(long magic)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003373{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003374 char buf[4];
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003375
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003376 buf[0] = (char) ((magic >> 0) & 0xff);
3377 buf[1] = (char) ((magic >> 8) & 0xff);
3378 buf[2] = (char) ((magic >> 16) & 0xff);
3379 buf[3] = (char) ((magic >> 24) & 0xff);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003380
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003381 return PyBytes_FromStringAndSize(buf, 4);
Victor Stinner3e2b7172010-11-09 09:32:19 +00003382}
Barry Warsaw28a691b2010-04-17 00:19:56 +00003383
3384static PyObject *
3385imp_get_magic(PyObject *self, PyObject *noargs)
3386{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003387 return imp_make_magic(pyc_magic);
Barry Warsaw28a691b2010-04-17 00:19:56 +00003388}
3389
3390static PyObject *
3391imp_get_tag(PyObject *self, PyObject *noargs)
3392{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003393 return PyUnicode_FromString(pyc_tag);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003394}
3395
Guido van Rossum79f25d91997-04-29 20:08:16 +00003396static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +00003397imp_get_suffixes(PyObject *self, PyObject *noargs)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003398{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003399 PyObject *list;
3400 struct filedescr *fdp;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003401
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003402 list = PyList_New(0);
3403 if (list == NULL)
3404 return NULL;
3405 for (fdp = _PyImport_Filetab; fdp->suffix != NULL; fdp++) {
3406 PyObject *item = Py_BuildValue("ssi",
3407 fdp->suffix, fdp->mode, fdp->type);
3408 if (item == NULL) {
3409 Py_DECREF(list);
3410 return NULL;
3411 }
3412 if (PyList_Append(list, item) < 0) {
3413 Py_DECREF(list);
3414 Py_DECREF(item);
3415 return NULL;
3416 }
3417 Py_DECREF(item);
3418 }
3419 return list;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003420}
3421
Guido van Rossum79f25d91997-04-29 20:08:16 +00003422static PyObject *
Victor Stinner533d7832011-03-14 13:22:54 -04003423call_find_module(PyObject *name, PyObject *path_list)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003424{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003425 extern int fclose(FILE *);
3426 PyObject *fob, *ret;
3427 PyObject *pathobj;
3428 struct filedescr *fdp;
3429 char pathname[MAXPATHLEN+1];
Victor Stinner7d8b77c2011-03-12 08:45:02 -05003430 FILE *fp;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003431 int fd = -1;
3432 char *found_encoding = NULL;
3433 char *encoding = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003434
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003435 pathname[0] = '\0';
Victor Stinner533d7832011-03-14 13:22:54 -04003436 if (path_list == Py_None)
3437 path_list = NULL;
3438 fdp = find_module(NULL, name, path_list,
3439 pathname, MAXPATHLEN+1, &fp, NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003440 if (fdp == NULL)
3441 return NULL;
3442 if (fp != NULL) {
3443 fd = fileno(fp);
3444 if (fd != -1)
3445 fd = dup(fd);
3446 fclose(fp);
3447 fp = NULL;
3448 }
3449 if (fd != -1) {
3450 if (strchr(fdp->mode, 'b') == NULL) {
3451 /* PyTokenizer_FindEncoding() returns PyMem_MALLOC'ed
3452 memory. */
3453 found_encoding = PyTokenizer_FindEncoding(fd);
3454 lseek(fd, 0, 0); /* Reset position */
3455 if (found_encoding == NULL && PyErr_Occurred())
3456 return NULL;
3457 encoding = (found_encoding != NULL) ? found_encoding :
3458 (char*)PyUnicode_GetDefaultEncoding();
3459 }
3460 fob = PyFile_FromFd(fd, pathname, fdp->mode, -1,
3461 (char*)encoding, NULL, NULL, 1);
3462 if (fob == NULL) {
3463 close(fd);
3464 PyMem_FREE(found_encoding);
3465 return NULL;
3466 }
3467 }
3468 else {
3469 fob = Py_None;
3470 Py_INCREF(fob);
3471 }
3472 pathobj = PyUnicode_DecodeFSDefault(pathname);
3473 ret = Py_BuildValue("NN(ssi)",
3474 fob, pathobj, fdp->suffix, fdp->mode, fdp->type);
3475 PyMem_FREE(found_encoding);
Brett Cannon3bb42d92007-10-20 03:43:15 +00003476
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003477 return ret;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003478}
3479
Guido van Rossum79f25d91997-04-29 20:08:16 +00003480static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003481imp_find_module(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003482{
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003483 PyObject *name, *path_list = NULL;
3484 if (!PyArg_ParseTuple(args, "U|O:find_module",
3485 &name, &path_list))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003486 return NULL;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003487 return call_find_module(name, path_list);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003488}
3489
3490static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003491imp_init_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003492{
Victor Stinner95872862011-03-07 18:20:56 +01003493 PyObject *name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003494 int ret;
3495 PyObject *m;
Victor Stinner95872862011-03-07 18:20:56 +01003496 if (!PyArg_ParseTuple(args, "U:init_builtin", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003497 return NULL;
3498 ret = init_builtin(name);
3499 if (ret < 0)
3500 return NULL;
3501 if (ret == 0) {
3502 Py_INCREF(Py_None);
3503 return Py_None;
3504 }
Victor Stinner95872862011-03-07 18:20:56 +01003505 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003506 Py_XINCREF(m);
3507 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003508}
3509
Guido van Rossum79f25d91997-04-29 20:08:16 +00003510static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003511imp_init_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003512{
Victor Stinner53dc7352011-03-20 01:50:21 +01003513 PyObject *name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003514 int ret;
3515 PyObject *m;
Victor Stinner53dc7352011-03-20 01:50:21 +01003516 if (!PyArg_ParseTuple(args, "U:init_frozen", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003517 return NULL;
Victor Stinner53dc7352011-03-20 01:50:21 +01003518 ret = PyImport_ImportFrozenModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003519 if (ret < 0)
3520 return NULL;
3521 if (ret == 0) {
3522 Py_INCREF(Py_None);
3523 return Py_None;
3524 }
Victor Stinner53dc7352011-03-20 01:50:21 +01003525 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003526 Py_XINCREF(m);
3527 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003528}
3529
Guido van Rossum79f25d91997-04-29 20:08:16 +00003530static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003531imp_get_frozen_object(PyObject *self, PyObject *args)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00003532{
Victor Stinner53dc7352011-03-20 01:50:21 +01003533 PyObject *name;
Jack Jansen95ffa231995-10-03 14:38:41 +00003534
Victor Stinner53dc7352011-03-20 01:50:21 +01003535 if (!PyArg_ParseTuple(args, "U:get_frozen_object", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003536 return NULL;
3537 return get_frozen_object(name);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00003538}
3539
Guido van Rossum79f25d91997-04-29 20:08:16 +00003540static PyObject *
Brett Cannon8d110132009-03-15 02:20:16 +00003541imp_is_frozen_package(PyObject *self, PyObject *args)
3542{
Victor Stinner53dc7352011-03-20 01:50:21 +01003543 PyObject *name;
Brett Cannon8d110132009-03-15 02:20:16 +00003544
Victor Stinner53dc7352011-03-20 01:50:21 +01003545 if (!PyArg_ParseTuple(args, "U:is_frozen_package", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003546 return NULL;
3547 return is_frozen_package(name);
Brett Cannon8d110132009-03-15 02:20:16 +00003548}
3549
3550static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003551imp_is_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003552{
Victor Stinner95872862011-03-07 18:20:56 +01003553 PyObject *name;
3554 if (!PyArg_ParseTuple(args, "U:is_builtin", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003555 return NULL;
3556 return PyLong_FromLong(is_builtin(name));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003557}
3558
Guido van Rossum79f25d91997-04-29 20:08:16 +00003559static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003560imp_is_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003561{
Victor Stinner53dc7352011-03-20 01:50:21 +01003562 PyObject *name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003563 struct _frozen *p;
Victor Stinner53dc7352011-03-20 01:50:21 +01003564 if (!PyArg_ParseTuple(args, "U:is_frozen", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003565 return NULL;
3566 p = find_frozen(name);
3567 return PyBool_FromLong((long) (p == NULL ? 0 : p->size));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003568}
3569
3570static FILE *
Victor Stinner2f42ae52011-03-20 00:41:24 +01003571get_file(PyObject *pathname, PyObject *fob, char *mode)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003572{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003573 FILE *fp;
3574 if (mode[0] == 'U')
3575 mode = "r" PY_STDIOTEXTMODE;
3576 if (fob == NULL) {
Victor Stinner2f42ae52011-03-20 00:41:24 +01003577 fp = _Py_fopen(pathname, mode);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003578 }
3579 else {
3580 int fd = PyObject_AsFileDescriptor(fob);
3581 if (fd == -1)
3582 return NULL;
3583 if (!_PyVerify_fd(fd))
3584 goto error;
3585 /* the FILE struct gets a new fd, so that it can be closed
3586 * independently of the file descriptor given
3587 */
3588 fd = dup(fd);
3589 if (fd == -1)
3590 goto error;
3591 fp = fdopen(fd, mode);
3592 }
3593 if (fp)
3594 return fp;
Kristján Valur Jónssone1b04452009-03-31 17:43:39 +00003595error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003596 PyErr_SetFromErrno(PyExc_IOError);
3597 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003598}
3599
Guido van Rossum79f25d91997-04-29 20:08:16 +00003600static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003601imp_load_compiled(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003602{
Victor Stinner2f42ae52011-03-20 00:41:24 +01003603 PyObject *name, *pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003604 PyObject *fob = NULL;
3605 PyObject *m;
3606 FILE *fp;
Victor Stinner2f42ae52011-03-20 00:41:24 +01003607 if (!PyArg_ParseTuple(args, "UO&|O:load_compiled",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003608 &name,
Victor Stinner2f42ae52011-03-20 00:41:24 +01003609 PyUnicode_FSDecoder, &pathname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003610 &fob))
3611 return NULL;
Victor Stinner2f42ae52011-03-20 00:41:24 +01003612 fp = get_file(pathname, fob, "rb");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003613 if (fp == NULL) {
Victor Stinnerebc00522010-12-03 17:06:43 +00003614 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003615 return NULL;
3616 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01003617 m = load_compiled_module(name, pathname, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003618 fclose(fp);
Victor Stinnerebc00522010-12-03 17:06:43 +00003619 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003620 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003621}
3622
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003623#ifdef HAVE_DYNAMIC_LOADING
3624
Guido van Rossum79f25d91997-04-29 20:08:16 +00003625static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003626imp_load_dynamic(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003627{
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003628 PyObject *name, *pathname, *fob = NULL, *mod;
3629 FILE *fp;
3630
3631 if (!PyArg_ParseTuple(args, "UO&|O:load_dynamic",
3632 &name, PyUnicode_FSDecoder, &pathname, &fob))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003633 return NULL;
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003634 if (fob != NULL) {
3635 fp = get_file(NULL, fob, "r");
3636 if (fp == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003637 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003638 }
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003639 else
3640 fp = NULL;
3641 mod = _PyImport_LoadDynamicModule(name, pathname, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003642 if (fp)
3643 fclose(fp);
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003644 return mod;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003645}
3646
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003647#endif /* HAVE_DYNAMIC_LOADING */
3648
Guido van Rossum79f25d91997-04-29 20:08:16 +00003649static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003650imp_load_source(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003651{
Victor Stinner2f42ae52011-03-20 00:41:24 +01003652 PyObject *name, *pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003653 PyObject *fob = NULL;
3654 PyObject *m;
3655 FILE *fp;
Victor Stinner2f42ae52011-03-20 00:41:24 +01003656 if (!PyArg_ParseTuple(args, "UO&|O:load_source",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003657 &name,
Victor Stinner2f42ae52011-03-20 00:41:24 +01003658 PyUnicode_FSDecoder, &pathname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003659 &fob))
3660 return NULL;
Victor Stinner2f42ae52011-03-20 00:41:24 +01003661 fp = get_file(pathname, fob, "r");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003662 if (fp == NULL) {
Victor Stinnerebc00522010-12-03 17:06:43 +00003663 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003664 return NULL;
3665 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01003666 m = load_source_module(name, pathname, fp);
Victor Stinnerebc00522010-12-03 17:06:43 +00003667 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003668 fclose(fp);
3669 return m;
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_module(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003674{
Victor Stinner41c5fec2011-03-13 21:46:30 -04003675 PyObject *name, *fob, *pathname, *ret;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003676 char *suffix; /* Unused */
3677 char *mode;
3678 int type;
3679 FILE *fp;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003680
Victor Stinner41c5fec2011-03-13 21:46:30 -04003681 if (!PyArg_ParseTuple(args, "UOO&(ssi):load_module",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003682 &name, &fob,
Victor Stinner41c5fec2011-03-13 21:46:30 -04003683 PyUnicode_FSDecoder, &pathname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003684 &suffix, &mode, &type))
3685 return NULL;
3686 if (*mode) {
3687 /* Mode must start with 'r' or 'U' and must not contain '+'.
3688 Implicit in this test is the assumption that the mode
3689 may contain other modifiers like 'b' or 't'. */
Guido van Rossum5e2c5fa2002-05-30 17:33:07 +00003690
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003691 if (!(*mode == 'r' || *mode == 'U') || strchr(mode, '+')) {
3692 PyErr_Format(PyExc_ValueError,
3693 "invalid file open mode %.200s", mode);
Victor Stinner1a563032010-10-15 22:43:10 +00003694 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003695 return NULL;
3696 }
3697 }
3698 if (fob == Py_None)
3699 fp = NULL;
3700 else {
3701 fp = get_file(NULL, fob, mode);
3702 if (fp == NULL) {
Victor Stinner1a563032010-10-15 22:43:10 +00003703 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003704 return NULL;
3705 }
3706 }
Victor Stinner41c5fec2011-03-13 21:46:30 -04003707 ret = load_module(name, fp, pathname, type, NULL);
Victor Stinner1a563032010-10-15 22:43:10 +00003708 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003709 if (fp)
3710 fclose(fp);
3711 return ret;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003712}
3713
3714static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003715imp_load_package(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003716{
Victor Stinnerc9abda02011-03-14 13:33:46 -04003717 PyObject *name, *pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003718 PyObject * ret;
Victor Stinnerc9abda02011-03-14 13:33:46 -04003719 if (!PyArg_ParseTuple(args, "UO&:load_package",
3720 &name, PyUnicode_FSDecoder, &pathname))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003721 return NULL;
Victor Stinnerc9abda02011-03-14 13:33:46 -04003722 ret = load_package(name, pathname);
Victor Stinnerebc00522010-12-03 17:06:43 +00003723 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003724 return ret;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003725}
3726
3727static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003728imp_new_module(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003729{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003730 char *name;
3731 if (!PyArg_ParseTuple(args, "s:new_module", &name))
3732 return NULL;
3733 return PyModule_New(name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003734}
3735
Christian Heimes13a7a212008-01-07 17:13:09 +00003736static PyObject *
3737imp_reload(PyObject *self, PyObject *v)
3738{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003739 return PyImport_ReloadModule(v);
Christian Heimes13a7a212008-01-07 17:13:09 +00003740}
3741
3742PyDoc_STRVAR(doc_reload,
3743"reload(module) -> module\n\
3744\n\
3745Reload the module. The module must have been successfully imported before.");
3746
Barry Warsaw28a691b2010-04-17 00:19:56 +00003747static PyObject *
3748imp_cache_from_source(PyObject *self, PyObject *args, PyObject *kws)
3749{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003750 static char *kwlist[] = {"path", "debug_override", NULL};
Barry Warsaw28a691b2010-04-17 00:19:56 +00003751
Victor Stinner2f42ae52011-03-20 00:41:24 +01003752 PyObject *pathname, *cpathname;
Benjamin Peterson294a9fc2010-10-16 03:12:39 +00003753 PyObject *debug_override = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003754 int debug = !Py_OptimizeFlag;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003755
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003756 if (!PyArg_ParseTupleAndKeywords(
Victor Stinner3ea23dd2010-10-15 20:34:32 +00003757 args, kws, "O&|O", kwlist,
Victor Stinner2f42ae52011-03-20 00:41:24 +01003758 PyUnicode_FSDecoder, &pathname, &debug_override))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003759 return NULL;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003760
Benjamin Peterson294a9fc2010-10-16 03:12:39 +00003761 if (debug_override != NULL &&
3762 (debug = PyObject_IsTrue(debug_override)) < 0) {
Victor Stinner2f42ae52011-03-20 00:41:24 +01003763 Py_DECREF(pathname);
Benjamin Peterson294a9fc2010-10-16 03:12:39 +00003764 return NULL;
3765 }
Barry Warsaw28a691b2010-04-17 00:19:56 +00003766
Victor Stinner3ea23dd2010-10-15 20:34:32 +00003767 cpathname = make_compiled_pathname(
Victor Stinner2f42ae52011-03-20 00:41:24 +01003768 PyUnicode_AS_UNICODE(pathname),
3769 debug);
3770 Py_DECREF(pathname);
Barry Warsaw28a691b2010-04-17 00:19:56 +00003771
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003772 if (cpathname == NULL) {
3773 PyErr_Format(PyExc_SystemError, "path buffer too short");
3774 return NULL;
3775 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01003776 return cpathname;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003777}
3778
3779PyDoc_STRVAR(doc_cache_from_source,
3780"Given the path to a .py file, return the path to its .pyc/.pyo file.\n\
3781\n\
3782The .py file does not need to exist; this simply returns the path to the\n\
3783.pyc/.pyo file calculated as if the .py file were imported. The extension\n\
3784will be .pyc unless __debug__ is not defined, then it will be .pyo.\n\
3785\n\
3786If debug_override is not None, then it must be a boolean and is taken as\n\
3787the value of __debug__ instead.");
3788
3789static PyObject *
3790imp_source_from_cache(PyObject *self, PyObject *args, PyObject *kws)
3791{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003792 static char *kwlist[] = {"path", NULL};
Victor Stinnerc9abda02011-03-14 13:33:46 -04003793 PyObject *pathname, *source;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003794
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003795 if (!PyArg_ParseTupleAndKeywords(
Victor Stinnerebc00522010-12-03 17:06:43 +00003796 args, kws, "O&", kwlist,
Victor Stinnerc9abda02011-03-14 13:33:46 -04003797 PyUnicode_FSDecoder, &pathname))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003798 return NULL;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003799
Victor Stinnerc9abda02011-03-14 13:33:46 -04003800 source = make_source_pathname(pathname);
3801 if (source == NULL) {
3802 PyErr_Format(PyExc_ValueError, "Not a PEP 3147 pyc path: %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003803 pathname);
Victor Stinnerc9abda02011-03-14 13:33:46 -04003804 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003805 return NULL;
3806 }
Victor Stinnerc9abda02011-03-14 13:33:46 -04003807 Py_DECREF(pathname);
3808 return source;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003809}
3810
3811PyDoc_STRVAR(doc_source_from_cache,
3812"Given the path to a .pyc./.pyo file, return the path to its .py file.\n\
3813\n\
3814The .pyc/.pyo file does not need to exist; this simply returns the path to\n\
3815the .py file calculated to correspond to the .pyc/.pyo file. If path\n\
3816does not conform to PEP 3147 format, ValueError will be raised.");
3817
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003818/* Doc strings */
3819
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003820PyDoc_STRVAR(doc_imp,
3821"This module provides the components needed to build your own\n\
3822__import__ function. Undocumented functions are obsolete.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003823
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003824PyDoc_STRVAR(doc_find_module,
3825"find_module(name, [path]) -> (file, filename, (suffix, mode, type))\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003826Search for a module. If path is omitted or None, search for a\n\
3827built-in, frozen or special module and continue search in sys.path.\n\
3828The module name cannot contain '.'; to search for a submodule of a\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003829package, pass the submodule name and the package's __path__.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003830
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003831PyDoc_STRVAR(doc_load_module,
3832"load_module(name, file, filename, (suffix, mode, type)) -> module\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003833Load a module, given information returned by find_module().\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003834The module name must include the full package name, if any.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003835
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003836PyDoc_STRVAR(doc_get_magic,
3837"get_magic() -> string\n\
3838Return the magic number for .pyc or .pyo files.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003839
Barry Warsaw28a691b2010-04-17 00:19:56 +00003840PyDoc_STRVAR(doc_get_tag,
3841"get_tag() -> string\n\
3842Return the magic tag for .pyc or .pyo files.");
3843
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003844PyDoc_STRVAR(doc_get_suffixes,
3845"get_suffixes() -> [(suffix, mode, type), ...]\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003846Return a list of (suffix, mode, type) tuples describing the files\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003847that find_module() looks for.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003848
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003849PyDoc_STRVAR(doc_new_module,
3850"new_module(name) -> module\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003851Create a new module. Do not enter it in sys.modules.\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003852The module name must include the full package name, if any.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003853
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003854PyDoc_STRVAR(doc_lock_held,
Tim Petersa7c65092004-08-01 23:26:05 +00003855"lock_held() -> boolean\n\
3856Return True if the import lock is currently held, else False.\n\
3857On platforms without threads, return False.");
Tim Peters69232342001-08-30 05:16:13 +00003858
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00003859PyDoc_STRVAR(doc_acquire_lock,
3860"acquire_lock() -> None\n\
Neal Norwitz2294c0d2003-02-12 23:02:21 +00003861Acquires the interpreter's import lock for the current thread.\n\
3862This lock should be used by import hooks to ensure thread-safety\n\
3863when importing modules.\n\
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00003864On platforms without threads, this function does nothing.");
3865
3866PyDoc_STRVAR(doc_release_lock,
3867"release_lock() -> None\n\
3868Release the interpreter's import lock.\n\
3869On platforms without threads, this function does nothing.");
3870
Guido van Rossum79f25d91997-04-29 20:08:16 +00003871static PyMethodDef imp_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003872 {"find_module", imp_find_module, METH_VARARGS, doc_find_module},
3873 {"get_magic", imp_get_magic, METH_NOARGS, doc_get_magic},
3874 {"get_tag", imp_get_tag, METH_NOARGS, doc_get_tag},
3875 {"get_suffixes", imp_get_suffixes, METH_NOARGS, doc_get_suffixes},
3876 {"load_module", imp_load_module, METH_VARARGS, doc_load_module},
3877 {"new_module", imp_new_module, METH_VARARGS, doc_new_module},
3878 {"lock_held", imp_lock_held, METH_NOARGS, doc_lock_held},
3879 {"acquire_lock", imp_acquire_lock, METH_NOARGS, doc_acquire_lock},
3880 {"release_lock", imp_release_lock, METH_NOARGS, doc_release_lock},
3881 {"reload", imp_reload, METH_O, doc_reload},
3882 {"cache_from_source", (PyCFunction)imp_cache_from_source,
3883 METH_VARARGS | METH_KEYWORDS, doc_cache_from_source},
3884 {"source_from_cache", (PyCFunction)imp_source_from_cache,
3885 METH_VARARGS | METH_KEYWORDS, doc_source_from_cache},
3886 /* The rest are obsolete */
3887 {"get_frozen_object", imp_get_frozen_object, METH_VARARGS},
3888 {"is_frozen_package", imp_is_frozen_package, METH_VARARGS},
3889 {"init_builtin", imp_init_builtin, METH_VARARGS},
3890 {"init_frozen", imp_init_frozen, METH_VARARGS},
3891 {"is_builtin", imp_is_builtin, METH_VARARGS},
3892 {"is_frozen", imp_is_frozen, METH_VARARGS},
3893 {"load_compiled", imp_load_compiled, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003894#ifdef HAVE_DYNAMIC_LOADING
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003895 {"load_dynamic", imp_load_dynamic, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003896#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003897 {"load_package", imp_load_package, METH_VARARGS},
3898 {"load_source", imp_load_source, METH_VARARGS},
3899 {NULL, NULL} /* sentinel */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003900};
3901
Guido van Rossum1a8791e1998-08-04 22:46:29 +00003902static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003903setint(PyObject *d, char *name, int value)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003904{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003905 PyObject *v;
3906 int err;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003907
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003908 v = PyLong_FromLong((long)value);
3909 err = PyDict_SetItemString(d, name, v);
3910 Py_XDECREF(v);
3911 return err;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003912}
3913
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003914typedef struct {
3915 PyObject_HEAD
3916} NullImporter;
3917
3918static int
3919NullImporter_init(NullImporter *self, PyObject *args, PyObject *kwds)
3920{
Victor Stinner1a4d12d2010-08-13 13:07:29 +00003921#ifndef MS_WINDOWS
3922 PyObject *path;
3923 struct stat statbuf;
3924 int rv;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003925
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003926 if (!_PyArg_NoKeywords("NullImporter()", kwds))
3927 return -1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003928
Victor Stinner1a4d12d2010-08-13 13:07:29 +00003929 if (!PyArg_ParseTuple(args, "O&:NullImporter",
3930 PyUnicode_FSConverter, &path))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003931 return -1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003932
Victor Stinner1a4d12d2010-08-13 13:07:29 +00003933 if (PyBytes_GET_SIZE(path) == 0) {
3934 Py_DECREF(path);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003935 PyErr_SetString(PyExc_ImportError, "empty pathname");
3936 return -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003937 }
Victor Stinner1a4d12d2010-08-13 13:07:29 +00003938
3939 rv = stat(PyBytes_AS_STRING(path), &statbuf);
3940 Py_DECREF(path);
3941 if (rv == 0) {
3942 /* it exists */
3943 if (S_ISDIR(statbuf.st_mode)) {
3944 /* it's a directory */
3945 PyErr_SetString(PyExc_ImportError, "existing directory");
3946 return -1;
3947 }
3948 }
3949#else /* MS_WINDOWS */
3950 PyObject *pathobj;
3951 DWORD rv;
Victor Stinner255dfdb2010-09-29 10:28:51 +00003952 wchar_t *path;
Victor Stinner1a4d12d2010-08-13 13:07:29 +00003953
3954 if (!_PyArg_NoKeywords("NullImporter()", kwds))
3955 return -1;
3956
3957 if (!PyArg_ParseTuple(args, "U:NullImporter",
3958 &pathobj))
3959 return -1;
3960
3961 if (PyUnicode_GET_SIZE(pathobj) == 0) {
3962 PyErr_SetString(PyExc_ImportError, "empty pathname");
3963 return -1;
3964 }
3965
Victor Stinnerbeb4135b2010-10-07 01:02:42 +00003966 path = PyUnicode_AsWideCharString(pathobj, NULL);
Victor Stinner255dfdb2010-09-29 10:28:51 +00003967 if (path == NULL)
Victor Stinner1a4d12d2010-08-13 13:07:29 +00003968 return -1;
3969 /* see issue1293 and issue3677:
3970 * stat() on Windows doesn't recognise paths like
3971 * "e:\\shared\\" and "\\\\whiterab-c2znlh\\shared" as dirs.
3972 */
3973 rv = GetFileAttributesW(path);
Victor Stinner255dfdb2010-09-29 10:28:51 +00003974 PyMem_Free(path);
Victor Stinner1a4d12d2010-08-13 13:07:29 +00003975 if (rv != INVALID_FILE_ATTRIBUTES) {
3976 /* it exists */
3977 if (rv & FILE_ATTRIBUTE_DIRECTORY) {
3978 /* it's a directory */
3979 PyErr_SetString(PyExc_ImportError, "existing directory");
3980 return -1;
3981 }
3982 }
3983#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003984 return 0;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003985}
3986
3987static PyObject *
3988NullImporter_find_module(NullImporter *self, PyObject *args)
3989{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003990 Py_RETURN_NONE;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003991}
3992
3993static PyMethodDef NullImporter_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003994 {"find_module", (PyCFunction)NullImporter_find_module, METH_VARARGS,
3995 "Always return None"
3996 },
3997 {NULL} /* Sentinel */
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003998};
3999
4000
Christian Heimes9cd17752007-11-18 19:35:23 +00004001PyTypeObject PyNullImporter_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004002 PyVarObject_HEAD_INIT(NULL, 0)
4003 "imp.NullImporter", /*tp_name*/
4004 sizeof(NullImporter), /*tp_basicsize*/
4005 0, /*tp_itemsize*/
4006 0, /*tp_dealloc*/
4007 0, /*tp_print*/
4008 0, /*tp_getattr*/
4009 0, /*tp_setattr*/
4010 0, /*tp_reserved*/
4011 0, /*tp_repr*/
4012 0, /*tp_as_number*/
4013 0, /*tp_as_sequence*/
4014 0, /*tp_as_mapping*/
4015 0, /*tp_hash */
4016 0, /*tp_call*/
4017 0, /*tp_str*/
4018 0, /*tp_getattro*/
4019 0, /*tp_setattro*/
4020 0, /*tp_as_buffer*/
4021 Py_TPFLAGS_DEFAULT, /*tp_flags*/
4022 "Null importer object", /* tp_doc */
4023 0, /* tp_traverse */
4024 0, /* tp_clear */
4025 0, /* tp_richcompare */
4026 0, /* tp_weaklistoffset */
4027 0, /* tp_iter */
4028 0, /* tp_iternext */
4029 NullImporter_methods, /* tp_methods */
4030 0, /* tp_members */
4031 0, /* tp_getset */
4032 0, /* tp_base */
4033 0, /* tp_dict */
4034 0, /* tp_descr_get */
4035 0, /* tp_descr_set */
4036 0, /* tp_dictoffset */
4037 (initproc)NullImporter_init, /* tp_init */
4038 0, /* tp_alloc */
4039 PyType_GenericNew /* tp_new */
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004040};
4041
Martin v. Löwis1a214512008-06-11 05:26:20 +00004042static struct PyModuleDef impmodule = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004043 PyModuleDef_HEAD_INIT,
4044 "imp",
4045 doc_imp,
4046 0,
4047 imp_methods,
4048 NULL,
4049 NULL,
4050 NULL,
4051 NULL
Martin v. Löwis1a214512008-06-11 05:26:20 +00004052};
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004053
Jason Tishler6bc06ec2003-09-04 11:59:50 +00004054PyMODINIT_FUNC
Martin v. Löwis1a214512008-06-11 05:26:20 +00004055PyInit_imp(void)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004056{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004057 PyObject *m, *d;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004058
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004059 if (PyType_Ready(&PyNullImporter_Type) < 0)
4060 return NULL;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004061
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004062 m = PyModule_Create(&impmodule);
4063 if (m == NULL)
4064 goto failure;
4065 d = PyModule_GetDict(m);
4066 if (d == NULL)
4067 goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004068
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004069 if (setint(d, "SEARCH_ERROR", SEARCH_ERROR) < 0) goto failure;
4070 if (setint(d, "PY_SOURCE", PY_SOURCE) < 0) goto failure;
4071 if (setint(d, "PY_COMPILED", PY_COMPILED) < 0) goto failure;
4072 if (setint(d, "C_EXTENSION", C_EXTENSION) < 0) goto failure;
4073 if (setint(d, "PY_RESOURCE", PY_RESOURCE) < 0) goto failure;
4074 if (setint(d, "PKG_DIRECTORY", PKG_DIRECTORY) < 0) goto failure;
4075 if (setint(d, "C_BUILTIN", C_BUILTIN) < 0) goto failure;
4076 if (setint(d, "PY_FROZEN", PY_FROZEN) < 0) goto failure;
4077 if (setint(d, "PY_CODERESOURCE", PY_CODERESOURCE) < 0) goto failure;
4078 if (setint(d, "IMP_HOOK", IMP_HOOK) < 0) goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004079
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004080 Py_INCREF(&PyNullImporter_Type);
4081 PyModule_AddObject(m, "NullImporter", (PyObject *)&PyNullImporter_Type);
4082 return m;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00004083 failure:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004084 Py_XDECREF(m);
4085 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004086}
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004087
4088
Guido van Rossumb18618d2000-05-03 23:44:39 +00004089/* API for embedding applications that want to add their own entries
4090 to the table of built-in modules. This should normally be called
4091 *before* Py_Initialize(). When the table resize fails, -1 is
4092 returned and the existing table is unchanged.
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004093
4094 After a similar function by Just van Rossum. */
4095
4096int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00004097PyImport_ExtendInittab(struct _inittab *newtab)
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004098{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004099 static struct _inittab *our_copy = NULL;
4100 struct _inittab *p;
4101 int i, n;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004102
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004103 /* Count the number of entries in both tables */
4104 for (n = 0; newtab[n].name != NULL; n++)
4105 ;
4106 if (n == 0)
4107 return 0; /* Nothing to do */
4108 for (i = 0; PyImport_Inittab[i].name != NULL; i++)
4109 ;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004110
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004111 /* Allocate new memory for the combined table */
4112 p = our_copy;
4113 PyMem_RESIZE(p, struct _inittab, i+n+1);
4114 if (p == NULL)
4115 return -1;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004116
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004117 /* Copy the tables into the new memory */
4118 if (our_copy != PyImport_Inittab)
4119 memcpy(p, PyImport_Inittab, (i+1) * sizeof(struct _inittab));
4120 PyImport_Inittab = our_copy = p;
4121 memcpy(p+i, newtab, (n+1) * sizeof(struct _inittab));
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004122
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004123 return 0;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004124}
4125
4126/* Shorthand to add a single entry given a name and a function */
4127
4128int
Brett Cannona826f322009-04-02 03:41:46 +00004129PyImport_AppendInittab(const char *name, PyObject* (*initfunc)(void))
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004130{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004131 struct _inittab newtab[2];
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004132
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004133 memset(newtab, '\0', sizeof newtab);
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004134
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004135 newtab[0].name = (char *)name;
4136 newtab[0].initfunc = initfunc;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004137
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004138 return PyImport_ExtendInittab(newtab);
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004139}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00004140
4141#ifdef __cplusplus
4142}
4143#endif