blob: bba01203215d8e02bb3a0f75d532aec0f507ad99 [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 Stinnerc9a271c2011-03-14 14:34:13 -04001672static int case_ok(PyObject *, Py_ssize_t, PyObject *);
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 Stinnerc9a271c2011-03-14 14:34:13 -04001770 int match;
1771 PyObject *filename;
1772
1773 filename = PyUnicode_DecodeFSDefault(buf);
1774 if (filename == NULL)
Victor Stinner547a2a62011-03-20 03:07:28 +01001775 return -1;
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001776 match = case_ok(filename, 0, name);
1777 if (match < 0) {
1778 Py_DECREF(filename);
1779 return -1;
1780 }
1781 if (match) { /* case matches */
1782 if (find_init_module(filename)) { /* and has __init__.py */
1783 Py_DECREF(filename);
Victor Stinnerd0296212011-03-14 14:04:10 -04001784 *p_fd = &fd_package;
1785 return 2;
1786 }
1787 else {
1788 int err;
Victor Stinnerd0296212011-03-14 14:04:10 -04001789 err = PyErr_WarnFormat(PyExc_ImportWarning, 1,
Victor Stinner547a2a62011-03-20 03:07:28 +01001790 "Not importing directory %R: missing __init__.py",
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001791 filename);
Victor Stinner547a2a62011-03-20 03:07:28 +01001792 if (err) {
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001793 Py_DECREF(filename);
Victor Stinnerd0296212011-03-14 14:04:10 -04001794 return -1;
Victor Stinner547a2a62011-03-20 03:07:28 +01001795 }
Victor Stinnerd0296212011-03-14 14:04:10 -04001796 }
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001797 }
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001798 Py_DECREF(filename);
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001799 }
1800#endif
1801 return 1;
1802}
1803
1804/* Find a module in search_path_list. For each path, try
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001805 find_module_path() or try each _PyImport_Filetab suffix.
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001806
1807 If the module is found, return a file descriptor, write the path in
1808 *p_filename, write the pointer to the file object into *p_fp, and (if
1809 p_loader is not NULL) the loader into *p_loader.
1810
1811 Otherwise, raise an exception and return NULL. */
1812
Victor Stinner37580282011-03-20 01:34:43 +01001813static struct filedescr*
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001814find_module_path_list(PyObject *fullname, PyObject *name,
Victor Stinner37580282011-03-20 01:34:43 +01001815 PyObject *search_path_list, PyObject *path_hooks,
1816 PyObject *path_importer_cache,
1817 char *buf, size_t buflen,
1818 FILE **p_fp, PyObject **p_loader)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001819{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001820 Py_ssize_t i, npath;
1821 size_t len, namelen;
1822 struct filedescr *fdp = NULL;
1823 char *filemode;
1824 FILE *fp = NULL;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001825 char *namestr;
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001826 PyObject *filename;
1827 int match;
Victor Stinner53dc7352011-03-20 01:50:21 +01001828
Victor Stinner37580282011-03-20 01:34:43 +01001829 npath = PyList_Size(search_path_list);
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001830 namestr = _PyUnicode_AsString(name);
1831 namelen = strlen(namestr);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001832 for (i = 0; i < npath; i++) {
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001833 PyObject *path;
1834 int ok;
1835
1836 path = PyList_GetItem(search_path_list, i);
1837 if (path == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001838 return NULL;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001839
1840 ok = find_module_path(fullname, name, path,
1841 path_hooks, path_importer_cache,
1842 buf, buflen,
1843 p_loader, &fdp);
1844 if (ok < 0)
1845 return NULL;
1846 if (ok == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001847 continue;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001848 if (ok == 2)
1849 return fdp;
Amaury Forgeot d'Arcf1ca0b12008-06-11 17:40:47 +00001850
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001851 len = strlen(buf);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001852 for (fdp = _PyImport_Filetab; fdp->suffix != NULL; fdp++) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001853 filemode = fdp->mode;
1854 if (filemode[0] == 'U')
1855 filemode = "r" PY_STDIOTEXTMODE;
Victor Stinnerd0296212011-03-14 14:04:10 -04001856
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001857 strcpy(buf+len, fdp->suffix);
1858 filename = PyUnicode_DecodeFSDefault(buf);
1859 if (filename == NULL)
1860 return NULL;
1861
1862 if (Py_VerboseFlag > 1)
1863 PySys_FormatStderr("# trying %R\n", filename);
1864
1865 fp = _Py_fopen(filename, filemode);
1866 if (fp == NULL) {
1867 Py_DECREF(filename);
1868 continue;
1869 }
1870 match = case_ok(filename, -(Py_ssize_t)strlen(fdp->suffix), name);
1871 if (match < 0) {
1872 Py_DECREF(filename);
1873 return NULL;
1874 }
1875 if (match) {
1876 Py_DECREF(filename);
Victor Stinnerd0296212011-03-14 14:04:10 -04001877 *p_fp = fp;
1878 return fdp;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001879 }
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001880 Py_DECREF(filename);
Victor Stinnerd0296212011-03-14 14:04:10 -04001881
1882 fclose(fp);
1883 fp = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001884 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001885 }
Victor Stinnerd0296212011-03-14 14:04:10 -04001886 PyErr_Format(PyExc_ImportError,
1887 "No module named %U", name);
1888 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001889}
1890
Victor Stinner37580282011-03-20 01:34:43 +01001891/* Find a module:
1892
1893 - try find_module() of each sys.meta_path hook
1894 - try find_frozen()
1895 - try is_builtin()
1896 - try _PyWin_FindRegisteredModule() (Windows only)
1897 - otherwise, call find_module_path_list() with search_path_list (if not
1898 NULL) or sys.path
1899
1900 Return:
1901
1902 - &fd_builtin (C_BUILTIN) if it is a builtin
1903 - &fd_frozen (PY_FROZEN) if it is frozen
1904 - &fd_package (PKG_DIRECTORY) and write the filename into *buf
1905 if it is a package
1906 - &importhookdescr (IMP_HOOK) and write the loader into *p_loader if a
1907 importer loader was found
1908 - a file descriptor (PY_SOURCE, PY_COMPILED, C_EXTENSION, PY_RESOURCE or
1909 PY_CODERESOURCE: see _PyImport_Filetab), write the filename into
1910 *buf and the pointer to the open file into *p_fp
1911 - NULL on error
1912
1913 By default, write an empty string into *buf, and *p_fp and *p_loader (if
1914 set) are set to NULL. Eg. *buf is an empty string for a builtin package. */
1915
1916static struct filedescr *
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001917find_module(PyObject *fullname, PyObject *name, PyObject *search_path_list,
Victor Stinner37580282011-03-20 01:34:43 +01001918 char *buf, size_t buflen, FILE **p_fp, PyObject **p_loader)
1919{
1920 Py_ssize_t i, npath;
1921 static struct filedescr fd_frozen = {"", "", PY_FROZEN};
1922 static struct filedescr fd_builtin = {"", "", C_BUILTIN};
1923 PyObject *path_hooks, *path_importer_cache;
Victor Stinner37580282011-03-20 01:34:43 +01001924
1925 *buf = '\0';
1926 *p_fp = NULL;
1927 if (p_loader != NULL)
1928 *p_loader = NULL;
1929
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001930 if (PyUnicode_GET_SIZE(name) > MAXPATHLEN) {
Victor Stinner37580282011-03-20 01:34:43 +01001931 PyErr_SetString(PyExc_OverflowError,
1932 "module name is too long");
1933 return NULL;
1934 }
1935
1936 /* sys.meta_path import hook */
1937 if (p_loader != NULL) {
1938 PyObject *meta_path;
1939
1940 meta_path = PySys_GetObject("meta_path");
1941 if (meta_path == NULL || !PyList_Check(meta_path)) {
1942 PyErr_SetString(PyExc_ImportError,
1943 "sys.meta_path must be a list of "
1944 "import hooks");
1945 return NULL;
1946 }
1947 Py_INCREF(meta_path); /* zap guard */
1948 npath = PyList_Size(meta_path);
1949 for (i = 0; i < npath; i++) {
1950 PyObject *loader;
1951 PyObject *hook = PyList_GetItem(meta_path, i);
1952 loader = PyObject_CallMethod(hook, "find_module",
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001953 "OO", fullname,
Victor Stinner37580282011-03-20 01:34:43 +01001954 search_path_list != NULL ?
1955 search_path_list : Py_None);
1956 if (loader == NULL) {
1957 Py_DECREF(meta_path);
1958 return NULL; /* true error */
1959 }
1960 if (loader != Py_None) {
1961 /* a loader was found */
1962 *p_loader = loader;
1963 Py_DECREF(meta_path);
1964 return &importhookdescr;
1965 }
1966 Py_DECREF(loader);
1967 }
1968 Py_DECREF(meta_path);
1969 }
1970
Victor Stinnerdf75a022011-03-14 13:40:04 -04001971 if (find_frozen(fullname) != NULL)
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001972 return &fd_frozen;
Victor Stinner37580282011-03-20 01:34:43 +01001973
1974 if (search_path_list == NULL) {
1975#ifdef MS_COREDLL
1976 FILE *fp;
1977 struct filedescr *fdp;
1978 PyObject *filename, *filename_bytes;
1979#endif
Victor Stinnerdf75a022011-03-14 13:40:04 -04001980 if (is_builtin(name))
Victor Stinner37580282011-03-20 01:34:43 +01001981 return &fd_builtin;
Victor Stinner37580282011-03-20 01:34:43 +01001982#ifdef MS_COREDLL
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001983 fp = _PyWin_FindRegisteredModule(name, &fdp, &filename);
Victor Stinner37580282011-03-20 01:34:43 +01001984 if (fp != NULL) {
Victor Stinner37580282011-03-20 01:34:43 +01001985 filename_bytes = PyUnicode_EncodeFSDefault(filename);
1986 Py_DECREF(filename);
1987 if (filename_bytes == NULL)
1988 return NULL;
1989 strncpy(buf, PyBytes_AS_STRING(filename_bytes), buflen);
1990 buf[buflen-1] = '\0';
1991 Py_DECREF(filename_bytes);
1992 *p_fp = fp;
1993 return fdp;
1994 }
1995 else if (PyErr_Occurred())
1996 return NULL;
1997#endif
Victor Stinner37580282011-03-20 01:34:43 +01001998 search_path_list = PySys_GetObject("path");
1999 }
2000
2001 if (search_path_list == NULL || !PyList_Check(search_path_list)) {
2002 PyErr_SetString(PyExc_ImportError,
2003 "sys.path must be a list of directory names");
2004 return NULL;
2005 }
2006
2007 path_hooks = PySys_GetObject("path_hooks");
2008 if (path_hooks == NULL || !PyList_Check(path_hooks)) {
2009 PyErr_SetString(PyExc_ImportError,
2010 "sys.path_hooks must be a list of "
2011 "import hooks");
2012 return NULL;
2013 }
2014 path_importer_cache = PySys_GetObject("path_importer_cache");
2015 if (path_importer_cache == NULL ||
2016 !PyDict_Check(path_importer_cache)) {
2017 PyErr_SetString(PyExc_ImportError,
2018 "sys.path_importer_cache must be a dict");
2019 return NULL;
2020 }
2021
2022 return find_module_path_list(fullname, name,
2023 search_path_list, path_hooks,
2024 path_importer_cache,
2025 buf, buflen,
2026 p_fp, p_loader);
2027}
2028
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002029/* case_bytes(char* buf, Py_ssize_t len, Py_ssize_t namelen, char* name)
Tim Petersd1e87a82001-03-01 18:12:00 +00002030 * The arguments here are tricky, best shown by example:
2031 * /a/b/c/d/e/f/g/h/i/j/k/some_long_module_name.py\0
2032 * ^ ^ ^ ^
2033 * |--------------------- buf ---------------------|
2034 * |------------------- len ------------------|
2035 * |------ name -------|
2036 * |----- namelen -----|
2037 * buf is the full path, but len only counts up to (& exclusive of) the
2038 * extension. name is the module name, also exclusive of extension.
2039 *
2040 * We've already done a successful stat() or fopen() on buf, so know that
2041 * there's some match, possibly case-insensitive.
2042 *
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002043 * case_bytes() is to return 1 if there's a case-sensitive match for
2044 * name, else 0. case_bytes() is also to return 1 if envar PYTHONCASEOK
Tim Peters50d8d372001-02-28 05:34:27 +00002045 * exists.
Tim Petersd1e87a82001-03-01 18:12:00 +00002046 *
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002047 * case_bytes() is used to implement case-sensitive import semantics even
Tim Peters50d8d372001-02-28 05:34:27 +00002048 * on platforms with case-insensitive filesystems. It's trivial to implement
2049 * for case-sensitive filesystems. It's pretty much a cross-platform
2050 * nightmare for systems with case-insensitive filesystems.
2051 */
Guido van Rossum0980bd91998-02-13 17:18:36 +00002052
Tim Peters50d8d372001-02-28 05:34:27 +00002053/* First we may need a pile of platform-specific header files; the sequence
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002054 * of #if's here should match the sequence in the body of case_bytes().
Tim Peters50d8d372001-02-28 05:34:27 +00002055 */
Jason Tishler7961aa62005-05-20 00:56:54 +00002056#if defined(MS_WINDOWS)
Guido van Rossum0980bd91998-02-13 17:18:36 +00002057#include <windows.h>
Guido van Rossum4c3f57c2001-01-10 20:40:46 +00002058
Tim Peters50d8d372001-02-28 05:34:27 +00002059#elif defined(DJGPP)
2060#include <dir.h>
2061
Jason Tishler7961aa62005-05-20 00:56:54 +00002062#elif (defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) && defined(HAVE_DIRENT_H)
Tim Peters430f5d42001-03-01 01:30:56 +00002063#include <sys/types.h>
2064#include <dirent.h>
2065
Andrew MacIntyred9400542002-02-26 11:41:34 +00002066#elif defined(PYOS_OS2)
2067#define INCL_DOS
2068#define INCL_DOSERRORS
2069#define INCL_NOPMAPI
2070#include <os2.h>
Tim Peters50d8d372001-02-28 05:34:27 +00002071#endif
2072
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002073#if defined(DJGPP) \
2074 || ((defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) \
2075 && defined(HAVE_DIRENT_H)) \
2076 || defined(PYOS_OS2)
2077# define USE_CASE_OK_BYTES
2078#endif
2079
2080
2081#ifdef USE_CASE_OK_BYTES
Guido van Rossum0980bd91998-02-13 17:18:36 +00002082static int
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002083case_bytes(char *buf, Py_ssize_t len, Py_ssize_t namelen, const char *name)
Guido van Rossum0980bd91998-02-13 17:18:36 +00002084{
Tim Peters50d8d372001-02-28 05:34:27 +00002085/* Pick a platform-specific implementation; the sequence of #if's here should
2086 * match the sequence just above.
2087 */
2088
Tim Peters50d8d372001-02-28 05:34:27 +00002089/* DJGPP */
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002090#if defined(DJGPP)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002091 struct ffblk ffblk;
2092 int done;
Tim Peters50d8d372001-02-28 05:34:27 +00002093
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002094 if (Py_GETENV("PYTHONCASEOK") != NULL)
2095 return 1;
Tim Peters50d8d372001-02-28 05:34:27 +00002096
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002097 done = findfirst(buf, &ffblk, FA_ARCH|FA_RDONLY|FA_HIDDEN|FA_DIREC);
2098 if (done) {
2099 PyErr_Format(PyExc_NameError,
2100 "Can't find file for module %.100s\n(filename %.300s)",
2101 name, buf);
2102 return 0;
2103 }
2104 return strncmp(ffblk.ff_name, name, namelen) == 0;
Guido van Rossum0980bd91998-02-13 17:18:36 +00002105
Jason Tishler7961aa62005-05-20 00:56:54 +00002106/* new-fangled macintosh (macosx) or Cygwin */
2107#elif (defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) && defined(HAVE_DIRENT_H)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002108 DIR *dirp;
2109 struct dirent *dp;
2110 char dirname[MAXPATHLEN + 1];
2111 const int dirlen = len - namelen - 1; /* don't want trailing SEP */
Tim Peters430f5d42001-03-01 01:30:56 +00002112
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002113 if (Py_GETENV("PYTHONCASEOK") != NULL)
2114 return 1;
Tim Petersdbe6ebb2001-03-01 08:47:29 +00002115
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002116 /* Copy the dir component into dirname; substitute "." if empty */
2117 if (dirlen <= 0) {
2118 dirname[0] = '.';
2119 dirname[1] = '\0';
2120 }
2121 else {
2122 assert(dirlen <= MAXPATHLEN);
2123 memcpy(dirname, buf, dirlen);
2124 dirname[dirlen] = '\0';
2125 }
2126 /* Open the directory and search the entries for an exact match. */
2127 dirp = opendir(dirname);
2128 if (dirp) {
2129 char *nameWithExt = buf + len - namelen;
2130 while ((dp = readdir(dirp)) != NULL) {
2131 const int thislen =
Tim Peters430f5d42001-03-01 01:30:56 +00002132#ifdef _DIRENT_HAVE_D_NAMELEN
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002133 dp->d_namlen;
Tim Peters430f5d42001-03-01 01:30:56 +00002134#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002135 strlen(dp->d_name);
Tim Peters430f5d42001-03-01 01:30:56 +00002136#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002137 if (thislen >= namelen &&
2138 strcmp(dp->d_name, nameWithExt) == 0) {
2139 (void)closedir(dirp);
2140 return 1; /* Found */
2141 }
2142 }
2143 (void)closedir(dirp);
2144 }
2145 return 0 ; /* Not found */
Tim Peters430f5d42001-03-01 01:30:56 +00002146
Andrew MacIntyred9400542002-02-26 11:41:34 +00002147/* OS/2 */
2148#elif defined(PYOS_OS2)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002149 HDIR hdir = 1;
2150 ULONG srchcnt = 1;
2151 FILEFINDBUF3 ffbuf;
2152 APIRET rc;
Andrew MacIntyred9400542002-02-26 11:41:34 +00002153
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002154 if (Py_GETENV("PYTHONCASEOK") != NULL)
2155 return 1;
Andrew MacIntyred9400542002-02-26 11:41:34 +00002156
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002157 rc = DosFindFirst(buf,
2158 &hdir,
2159 FILE_READONLY | FILE_HIDDEN | FILE_SYSTEM | FILE_DIRECTORY,
2160 &ffbuf, sizeof(ffbuf),
2161 &srchcnt,
2162 FIL_STANDARD);
2163 if (rc != NO_ERROR)
2164 return 0;
2165 return strncmp(ffbuf.achName, name, namelen) == 0;
Andrew MacIntyred9400542002-02-26 11:41:34 +00002166
Tim Peters50d8d372001-02-28 05:34:27 +00002167/* assuming it's a case-sensitive filesystem, so there's nothing to do! */
2168#else
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002169# error "USE_CASE_OK_BYTES is not correctly defined"
2170#endif
2171}
2172#endif
2173
2174/*
2175 * Check if a filename case matchs the name case. We've already done a
2176 * successful stat() or fopen() on buf, so know that there's some match,
2177 * possibly case-insensitive.
2178 *
2179 * case_ok() is to return 1 if there's a case-sensitive match for name, 0 if it
2180 * the filename doesn't match, or -1 on error. case_ok() is also to return 1
2181 * if envar PYTHONCASEOK exists.
2182 *
2183 * case_ok() is used to implement case-sensitive import semantics even
2184 * on platforms with case-insensitive filesystems. It's trivial to implement
2185 * for case-sensitive filesystems. It's pretty much a cross-platform
2186 * nightmare for systems with case-insensitive filesystems.
2187 */
2188
2189static int
2190case_ok(PyObject *filename, Py_ssize_t prefix_delta, PyObject *name)
2191{
2192#ifdef MS_WINDOWS
2193 WIN32_FIND_DATAW data;
2194 HANDLE h;
2195 int cmp;
2196
2197 if (Py_GETENV("PYTHONCASEOK") != NULL)
2198 return 1;
2199
2200 h = FindFirstFileW(PyUnicode_AS_UNICODE(filename), &data);
2201 if (h == INVALID_HANDLE_VALUE) {
2202 PyErr_Format(PyExc_NameError,
2203 "Can't find file for module %R\n(filename %R)",
2204 name, filename);
2205 return 0;
2206 }
2207 FindClose(h);
2208 cmp = wcsncmp(data.cFileName,
2209 PyUnicode_AS_UNICODE(name),
2210 PyUnicode_GET_SIZE(name));
2211 return cmp == 0;
2212#elif defined(USE_CASE_OK_BYTES)
2213 int match;
2214 PyObject *filebytes, *namebytes;
2215 filebytes = PyUnicode_EncodeFSDefault(filename);
2216 if (filebytes == NULL)
2217 return -1;
2218 namebytes = PyUnicode_EncodeFSDefault(name);
2219 if (namebytes == NULL) {
2220 Py_DECREF(filebytes);
2221 return -1;
2222 }
2223 match = case_bytes(
2224 PyBytes_AS_STRING(filebytes),
2225 PyBytes_GET_SIZE(filebytes) + prefix_delta,
2226 PyBytes_AS_STRING(namebytes),
2227 PyBytes_GET_SIZE(namebytes));
2228 Py_DECREF(filebytes);
2229 Py_DECREF(namebytes);
2230 return match;
2231#else
2232 /* assuming it's a case-sensitive filesystem, so there's nothing to do! */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002233 return 1;
Guido van Rossum0980bd91998-02-13 17:18:36 +00002234
Guido van Rossum4d1b3b91998-02-13 23:27:59 +00002235#endif
Tim Peters50d8d372001-02-28 05:34:27 +00002236}
Guido van Rossum4d1b3b91998-02-13 23:27:59 +00002237
Guido van Rossum197346f1997-10-31 18:38:52 +00002238#ifdef HAVE_STAT
Victor Stinner4f4402c2010-08-14 14:50:26 +00002239
Victor Stinner547a2a62011-03-20 03:07:28 +01002240/* Helper to look for __init__.py or __init__.py[co] in potential package.
2241 Return 1 if __init__ was found, 0 if not, or -1 on error. */
Guido van Rossum197346f1997-10-31 18:38:52 +00002242static int
Victor Stinner547a2a62011-03-20 03:07:28 +01002243find_init_module(PyObject *directory)
Guido van Rossum197346f1997-10-31 18:38:52 +00002244{
Victor Stinner547a2a62011-03-20 03:07:28 +01002245 size_t len;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002246 struct stat statbuf;
Victor Stinner547a2a62011-03-20 03:07:28 +01002247 PyObject *filename;
2248 int match;
Guido van Rossum197346f1997-10-31 18:38:52 +00002249
Victor Stinner547a2a62011-03-20 03:07:28 +01002250 len = PyUnicode_GET_SIZE(directory);
2251 filename = PyUnicode_FromFormat("%U%c__init__.py", directory, SEP);
2252 if (filename == NULL)
2253 return -1;
2254 if (_Py_stat(filename, &statbuf) == 0) {
2255 /* 9=len("/__init__") */
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002256 match = case_ok(filename, 9, initstr);
2257 if (match < 0) {
2258 Py_DECREF(filename);
2259 return -1;
2260 }
2261 if (match) {
Victor Stinner547a2a62011-03-20 03:07:28 +01002262 Py_DECREF(filename);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002263 return 1;
2264 }
2265 }
Victor Stinner547a2a62011-03-20 03:07:28 +01002266 Py_DECREF(filename);
2267
2268 filename = PyUnicode_FromFormat("%U%c__init__.py%c",
2269 directory, SEP, Py_OptimizeFlag ? 'o' : 'c');
2270 if (filename == NULL)
2271 return -1;
2272 if (_Py_stat(filename, &statbuf) == 0) {
2273 /* 9=len("/__init__") */
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002274 match = case_ok(filename, 9, initstr);
2275 if (match < 0) {
2276 Py_DECREF(filename);
2277 return -1;
2278 }
2279 if (match) {
Victor Stinner547a2a62011-03-20 03:07:28 +01002280 Py_DECREF(filename);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002281 return 1;
2282 }
2283 }
Victor Stinner547a2a62011-03-20 03:07:28 +01002284 Py_DECREF(filename);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002285 return 0;
Guido van Rossum197346f1997-10-31 18:38:52 +00002286}
Guido van Rossum48a680c2001-03-02 06:34:14 +00002287
Guido van Rossum197346f1997-10-31 18:38:52 +00002288#endif /* HAVE_STAT */
2289
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002290
Victor Stinner95872862011-03-07 18:20:56 +01002291static int init_builtin(PyObject *); /* Forward */
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002292
Victor Stinner44c6c152010-08-09 00:59:10 +00002293static PyObject*
Victor Stinner95872862011-03-07 18:20:56 +01002294load_builtin(PyObject *name, int type)
Victor Stinner44c6c152010-08-09 00:59:10 +00002295{
2296 PyObject *m, *modules;
2297 int err;
2298
Victor Stinner44c6c152010-08-09 00:59:10 +00002299 if (type == C_BUILTIN)
2300 err = init_builtin(name);
2301 else
Victor Stinner95872862011-03-07 18:20:56 +01002302 err = PyImport_ImportFrozenModuleObject(name);
Victor Stinner44c6c152010-08-09 00:59:10 +00002303 if (err < 0)
2304 return NULL;
2305 if (err == 0) {
2306 PyErr_Format(PyExc_ImportError,
Victor Stinner95872862011-03-07 18:20:56 +01002307 "Purported %s module %R not found",
2308 type == C_BUILTIN ? "builtin" : "frozen",
Victor Stinner44c6c152010-08-09 00:59:10 +00002309 name);
2310 return NULL;
2311 }
2312
2313 modules = PyImport_GetModuleDict();
Victor Stinner95872862011-03-07 18:20:56 +01002314 m = PyDict_GetItem(modules, name);
Victor Stinner44c6c152010-08-09 00:59:10 +00002315 if (m == NULL) {
2316 PyErr_Format(
2317 PyExc_ImportError,
Victor Stinner95872862011-03-07 18:20:56 +01002318 "%s module %R not properly initialized",
2319 type == C_BUILTIN ? "builtin" : "frozen",
Victor Stinner44c6c152010-08-09 00:59:10 +00002320 name);
2321 return NULL;
2322 }
2323 Py_INCREF(m);
2324 return m;
2325}
2326
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002327/* Load an external module using the default search path and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00002328 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002329
Guido van Rossum79f25d91997-04-29 20:08:16 +00002330static PyObject *
Victor Stinner41c5fec2011-03-13 21:46:30 -04002331load_module(PyObject *name, FILE *fp, PyObject *pathname, int type, PyObject *loader)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002332{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002333 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002334
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002335 /* First check that there's an open file (if we need one) */
2336 switch (type) {
2337 case PY_SOURCE:
2338 case PY_COMPILED:
2339 if (fp == NULL) {
2340 PyErr_Format(PyExc_ValueError,
Victor Stinner41c5fec2011-03-13 21:46:30 -04002341 "file object required for import (type code %d)",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002342 type);
2343 return NULL;
2344 }
2345 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002346
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002347 switch (type) {
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002348
Victor Stinner41c5fec2011-03-13 21:46:30 -04002349 case PY_SOURCE:
2350 m = load_source_module(name, pathname, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002351 break;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002352
Victor Stinner41c5fec2011-03-13 21:46:30 -04002353 case PY_COMPILED:
2354 m = load_compiled_module(name, pathname, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002355 break;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002356
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002357#ifdef HAVE_DYNAMIC_LOADING
Victor Stinner41c5fec2011-03-13 21:46:30 -04002358 case C_EXTENSION:
2359 m = _PyImport_LoadDynamicModule(name, pathname, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002360 break;
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002361#endif
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002362
Victor Stinner41c5fec2011-03-13 21:46:30 -04002363 case PKG_DIRECTORY:
2364 m = load_package(name, pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002365 break;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002366
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002367 case C_BUILTIN:
Victor Stinner41c5fec2011-03-13 21:46:30 -04002368 case PY_FROZEN:
2369 m = load_builtin(name, type);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002370 break;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002371
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002372 case IMP_HOOK: {
2373 if (loader == NULL) {
2374 PyErr_SetString(PyExc_ImportError,
2375 "import hook without loader");
2376 return NULL;
2377 }
Victor Stinner41c5fec2011-03-13 21:46:30 -04002378 m = PyObject_CallMethod(loader, "load_module", "O", name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002379 break;
2380 }
Just van Rossum52e14d62002-12-30 22:08:05 +00002381
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002382 default:
2383 PyErr_Format(PyExc_ImportError,
Victor Stinner41c5fec2011-03-13 21:46:30 -04002384 "Don't know how to import %U (type code %d)",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002385 name, type);
2386 m = NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002387
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002388 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002389
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002390 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002391}
2392
2393
2394/* Initialize a built-in module.
Thomas Wouters89f507f2006-12-13 04:49:30 +00002395 Return 1 for success, 0 if the module is not found, and -1 with
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002396 an exception set if the initialization failed. */
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002397
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002398static int
Victor Stinner95872862011-03-07 18:20:56 +01002399init_builtin(PyObject *name)
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002400{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002401 struct _inittab *p;
Guido van Rossum25ce5661997-08-02 03:10:38 +00002402
Victor Stinner95872862011-03-07 18:20:56 +01002403 if (_PyImport_FindExtensionObject(name, name) != NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002404 return 1;
Guido van Rossum25ce5661997-08-02 03:10:38 +00002405
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002406 for (p = PyImport_Inittab; p->name != NULL; p++) {
2407 PyObject *mod;
Victor Stinner95872862011-03-07 18:20:56 +01002408 if (PyUnicode_CompareWithASCIIString(name, p->name) == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002409 if (p->initfunc == NULL) {
2410 PyErr_Format(PyExc_ImportError,
Victor Stinner95872862011-03-07 18:20:56 +01002411 "Cannot re-init internal module %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002412 name);
2413 return -1;
2414 }
2415 if (Py_VerboseFlag)
Victor Stinner95872862011-03-07 18:20:56 +01002416 PySys_FormatStderr("import %U # builtin\n", name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002417 mod = (*p->initfunc)();
2418 if (mod == 0)
2419 return -1;
Victor Stinner95872862011-03-07 18:20:56 +01002420 if (_PyImport_FixupExtensionObject(mod, name, name) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002421 return -1;
2422 /* FixupExtension has put the module into sys.modules,
2423 so we can release our own reference. */
2424 Py_DECREF(mod);
2425 return 1;
2426 }
2427 }
2428 return 0;
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002429}
Guido van Rossumf56e3db1993-04-01 20:59:32 +00002430
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002431
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002432/* Frozen modules */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002433
Guido van Rossumcfd0a221996-06-17 17:06:34 +00002434static struct _frozen *
Victor Stinner53dc7352011-03-20 01:50:21 +01002435find_frozen(PyObject *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002436{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002437 struct _frozen *p;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002438
Victor Stinner53dc7352011-03-20 01:50:21 +01002439 if (name == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002440 return NULL;
Benjamin Petersond968e272008-11-05 22:48:33 +00002441
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002442 for (p = PyImport_FrozenModules; ; p++) {
2443 if (p->name == NULL)
2444 return NULL;
Victor Stinner53dc7352011-03-20 01:50:21 +01002445 if (PyUnicode_CompareWithASCIIString(name, p->name) == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002446 break;
2447 }
2448 return p;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002449}
2450
Guido van Rossum79f25d91997-04-29 20:08:16 +00002451static PyObject *
Victor Stinner53dc7352011-03-20 01:50:21 +01002452get_frozen_object(PyObject *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002453{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002454 struct _frozen *p = find_frozen(name);
2455 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002456
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002457 if (p == NULL) {
2458 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002459 "No such frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002460 name);
2461 return NULL;
2462 }
2463 if (p->code == NULL) {
2464 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002465 "Excluded frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002466 name);
2467 return NULL;
2468 }
2469 size = p->size;
2470 if (size < 0)
2471 size = -size;
2472 return PyMarshal_ReadObjectFromString((char *)p->code, size);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002473}
2474
Brett Cannon8d110132009-03-15 02:20:16 +00002475static PyObject *
Victor Stinner53dc7352011-03-20 01:50:21 +01002476is_frozen_package(PyObject *name)
Brett Cannon8d110132009-03-15 02:20:16 +00002477{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002478 struct _frozen *p = find_frozen(name);
2479 int size;
Brett Cannon8d110132009-03-15 02:20:16 +00002480
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002481 if (p == NULL) {
2482 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002483 "No such frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002484 name);
2485 return NULL;
2486 }
Brett Cannon8d110132009-03-15 02:20:16 +00002487
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002488 size = p->size;
Brett Cannon8d110132009-03-15 02:20:16 +00002489
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002490 if (size < 0)
2491 Py_RETURN_TRUE;
2492 else
2493 Py_RETURN_FALSE;
Brett Cannon8d110132009-03-15 02:20:16 +00002494}
2495
2496
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002497/* Initialize a frozen module.
Brett Cannon3c2ac442009-03-08 20:49:47 +00002498 Return 1 for success, 0 if the module is not found, and -1 with
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002499 an exception set if the initialization failed.
2500 This function is also used from frozenmain.c */
Guido van Rossum0b344901995-02-07 15:35:27 +00002501
2502int
Victor Stinner53dc7352011-03-20 01:50:21 +01002503PyImport_ImportFrozenModuleObject(PyObject *name)
Guido van Rossumf56e3db1993-04-01 20:59:32 +00002504{
Victor Stinner53dc7352011-03-20 01:50:21 +01002505 struct _frozen *p;
2506 PyObject *co, *m, *path;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002507 int ispackage;
2508 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002509
Victor Stinner53dc7352011-03-20 01:50:21 +01002510 p = find_frozen(name);
2511
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002512 if (p == NULL)
2513 return 0;
2514 if (p->code == NULL) {
2515 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002516 "Excluded frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002517 name);
2518 return -1;
2519 }
2520 size = p->size;
2521 ispackage = (size < 0);
2522 if (ispackage)
2523 size = -size;
2524 if (Py_VerboseFlag)
Victor Stinner53dc7352011-03-20 01:50:21 +01002525 PySys_FormatStderr("import %U # frozen%s\n",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002526 name, ispackage ? " package" : "");
2527 co = PyMarshal_ReadObjectFromString((char *)p->code, size);
2528 if (co == NULL)
2529 return -1;
2530 if (!PyCode_Check(co)) {
2531 PyErr_Format(PyExc_TypeError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002532 "frozen object %R is not a code object",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002533 name);
2534 goto err_return;
2535 }
2536 if (ispackage) {
2537 /* Set __path__ to the package name */
Victor Stinner53dc7352011-03-20 01:50:21 +01002538 PyObject *d, *l;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002539 int err;
Victor Stinner53dc7352011-03-20 01:50:21 +01002540 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002541 if (m == NULL)
2542 goto err_return;
2543 d = PyModule_GetDict(m);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002544 l = PyList_New(1);
2545 if (l == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002546 goto err_return;
2547 }
Victor Stinner53dc7352011-03-20 01:50:21 +01002548 Py_INCREF(name);
2549 PyList_SET_ITEM(l, 0, name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002550 err = PyDict_SetItemString(d, "__path__", l);
2551 Py_DECREF(l);
2552 if (err != 0)
2553 goto err_return;
2554 }
Victor Stinner53dc7352011-03-20 01:50:21 +01002555 path = PyUnicode_FromString("<frozen>");
2556 if (path == NULL)
2557 goto err_return;
2558 m = PyImport_ExecCodeModuleObject(name, co, path, NULL);
2559 Py_DECREF(path);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002560 if (m == NULL)
2561 goto err_return;
2562 Py_DECREF(co);
2563 Py_DECREF(m);
2564 return 1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002565err_return:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002566 Py_DECREF(co);
2567 return -1;
Guido van Rossumf56e3db1993-04-01 20:59:32 +00002568}
Guido van Rossum74e6a111994-08-29 12:54:38 +00002569
Victor Stinner53dc7352011-03-20 01:50:21 +01002570int
2571PyImport_ImportFrozenModule(char *name)
2572{
2573 PyObject *nameobj;
2574 int ret;
2575 nameobj = PyUnicode_InternFromString(name);
2576 if (nameobj == NULL)
2577 return -1;
2578 ret = PyImport_ImportFrozenModuleObject(nameobj);
2579 Py_DECREF(nameobj);
2580 return ret;
2581}
2582
Guido van Rossum74e6a111994-08-29 12:54:38 +00002583
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002584/* Import a module, either built-in, frozen, or external, and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00002585 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum74e6a111994-08-29 12:54:38 +00002586
Guido van Rossum79f25d91997-04-29 20:08:16 +00002587PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00002588PyImport_ImportModule(const char *name)
Guido van Rossum74e6a111994-08-29 12:54:38 +00002589{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002590 PyObject *pname;
2591 PyObject *result;
Marc-André Lemburg3c61c352001-02-09 19:40:15 +00002592
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002593 pname = PyUnicode_FromString(name);
2594 if (pname == NULL)
2595 return NULL;
2596 result = PyImport_Import(pname);
2597 Py_DECREF(pname);
2598 return result;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002599}
2600
Christian Heimes072c0f12008-01-03 23:01:04 +00002601/* Import a module without blocking
2602 *
2603 * At first it tries to fetch the module from sys.modules. If the module was
2604 * never loaded before it loads it with PyImport_ImportModule() unless another
2605 * thread holds the import lock. In the latter case the function raises an
2606 * ImportError instead of blocking.
2607 *
2608 * Returns the module object with incremented ref count.
2609 */
2610PyObject *
2611PyImport_ImportModuleNoBlock(const char *name)
2612{
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002613 PyObject *nameobj, *modules, *result;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002614 long me;
Christian Heimes072c0f12008-01-03 23:01:04 +00002615
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002616 /* Try to get the module from sys.modules[name] */
2617 modules = PyImport_GetModuleDict();
2618 if (modules == NULL)
2619 return NULL;
Christian Heimes072c0f12008-01-03 23:01:04 +00002620
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002621 nameobj = PyUnicode_FromString(name);
2622 if (nameobj == NULL)
2623 return NULL;
2624 result = PyDict_GetItem(modules, nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002625 if (result != NULL) {
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002626 Py_DECREF(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002627 Py_INCREF(result);
2628 return result;
2629 }
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002630 PyErr_Clear();
Benjamin Peterson3e4f0552008-09-02 00:31:15 +00002631#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002632 /* check the import lock
2633 * me might be -1 but I ignore the error here, the lock function
2634 * takes care of the problem */
2635 me = PyThread_get_thread_ident();
2636 if (import_lock_thread == -1 || import_lock_thread == me) {
2637 /* no thread or me is holding the lock */
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002638 result = PyImport_Import(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002639 }
2640 else {
2641 PyErr_Format(PyExc_ImportError,
Victor Stinnerc24c8102011-03-13 22:38:06 -04002642 "Failed to import %R because the import lock"
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002643 "is held by another thread.",
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002644 nameobj);
2645 result = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002646 }
Benjamin Peterson3e4f0552008-09-02 00:31:15 +00002647#else
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002648 result = PyImport_Import(nameobj);
Benjamin Peterson3e4f0552008-09-02 00:31:15 +00002649#endif
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002650 Py_DECREF(nameobj);
2651 return result;
Christian Heimes072c0f12008-01-03 23:01:04 +00002652}
2653
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002654/* Forward declarations for helper routines */
Victor Stinner974389d2011-03-15 09:33:57 +01002655static PyObject *get_parent(PyObject *globals,
2656 PyObject **p_name,
2657 int level);
Tim Petersdbd9ba62000-07-09 03:09:57 +00002658static PyObject *load_next(PyObject *mod, PyObject *altmod,
Victor Stinner974389d2011-03-15 09:33:57 +01002659 PyObject *inputname, PyObject **p_outputname,
2660 Py_UNICODE *buf, Py_ssize_t *p_buflen,
2661 Py_ssize_t bufsize);
2662static int mark_miss(PyObject *name);
Tim Petersdbd9ba62000-07-09 03:09:57 +00002663static int ensure_fromlist(PyObject *mod, PyObject *fromlist,
Victor Stinner974389d2011-03-15 09:33:57 +01002664 PyObject *buf, int recursive);
2665static PyObject * import_submodule(PyObject *mod, PyObject *name,
2666 PyObject *fullname);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002667
2668/* The Magnum Opus of dotted-name import :-) */
2669
Guido van Rossum75acc9c1998-03-03 22:26:50 +00002670static PyObject *
Victor Stinner974389d2011-03-15 09:33:57 +01002671import_module_level(PyObject *name, PyObject *globals, PyObject *locals,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002672 PyObject *fromlist, int level)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002673{
Victor Stinner974389d2011-03-15 09:33:57 +01002674 Py_UNICODE buf[MAXPATHLEN+1];
2675 Py_ssize_t buflen;
2676 Py_ssize_t bufsize = MAXPATHLEN+1;
2677 PyObject *parent, *head, *next, *tail, *inputname, *outputname;
2678 PyObject *parent_name, *ensure_name;
2679 const Py_UNICODE *nameunicode;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002680
Victor Stinner974389d2011-03-15 09:33:57 +01002681 nameunicode = PyUnicode_AS_UNICODE(name);
2682
2683 if (Py_UNICODE_strchr(nameunicode, SEP) != NULL
2684#ifdef ALTSEP
2685 || Py_UNICODE_strchr(nameunicode, ALTSEP) != NULL
Christian Heimes454f37b2008-01-10 00:10:02 +00002686#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002687 ) {
2688 PyErr_SetString(PyExc_ImportError,
2689 "Import by filename is not supported.");
2690 return NULL;
2691 }
Christian Heimes454f37b2008-01-10 00:10:02 +00002692
Victor Stinner974389d2011-03-15 09:33:57 +01002693 parent = get_parent(globals, &parent_name, level);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002694 if (parent == NULL)
2695 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002696
Victor Stinner974389d2011-03-15 09:33:57 +01002697 buflen = PyUnicode_GET_SIZE(parent_name);
2698 if (buflen+1 > bufsize) {
2699 Py_DECREF(parent_name);
2700 PyErr_SetString(PyExc_ValueError,
2701 "Module name too long");
2702 return NULL;
2703 }
2704 Py_UNICODE_strcpy(buf, PyUnicode_AS_UNICODE(parent_name));
2705 Py_DECREF(parent_name);
2706
2707 head = load_next(parent, level < 0 ? Py_None : parent, name, &outputname,
2708 buf, &buflen, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002709 if (head == NULL)
2710 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002711
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002712 tail = head;
2713 Py_INCREF(tail);
Victor Stinner974389d2011-03-15 09:33:57 +01002714
2715 if (outputname != NULL) {
2716 while (1) {
2717 inputname = outputname;
2718 next = load_next(tail, tail, inputname, &outputname,
2719 buf, &buflen, bufsize);
2720 Py_DECREF(tail);
2721 Py_DECREF(inputname);
2722 if (next == NULL) {
2723 Py_DECREF(head);
2724 return NULL;
2725 }
2726 tail = next;
2727
2728 if (outputname == NULL) {
2729 break;
2730 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002731 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002732 }
2733 if (tail == Py_None) {
2734 /* If tail is Py_None, both get_parent and load_next found
2735 an empty module name: someone called __import__("") or
2736 doctored faulty bytecode */
2737 Py_DECREF(tail);
2738 Py_DECREF(head);
Victor Stinner974389d2011-03-15 09:33:57 +01002739 PyErr_SetString(PyExc_ValueError, "Empty module name");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002740 return NULL;
2741 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002742
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002743 if (fromlist != NULL) {
2744 if (fromlist == Py_None || !PyObject_IsTrue(fromlist))
2745 fromlist = NULL;
2746 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002747
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002748 if (fromlist == NULL) {
2749 Py_DECREF(tail);
2750 return head;
2751 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002752
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002753 Py_DECREF(head);
Victor Stinner974389d2011-03-15 09:33:57 +01002754
2755 ensure_name = PyUnicode_FromUnicode(buf, Py_UNICODE_strlen(buf));
2756 if (ensure_name == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002757 Py_DECREF(tail);
2758 return NULL;
2759 }
Victor Stinner974389d2011-03-15 09:33:57 +01002760 if (!ensure_fromlist(tail, fromlist, ensure_name, 0)) {
2761 Py_DECREF(tail);
2762 Py_DECREF(ensure_name);
2763 return NULL;
2764 }
2765 Py_DECREF(ensure_name);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002766
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002767 return tail;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002768}
2769
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002770PyObject *
2771PyImport_ImportModuleLevel(char *name, PyObject *globals, PyObject *locals,
Victor Stinner974389d2011-03-15 09:33:57 +01002772 PyObject *fromlist, int level)
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002773{
Victor Stinner974389d2011-03-15 09:33:57 +01002774 PyObject *nameobj, *result;
2775 nameobj = PyUnicode_FromString(name);
2776 if (nameobj == NULL)
2777 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002778 _PyImport_AcquireLock();
Victor Stinner974389d2011-03-15 09:33:57 +01002779 result = import_module_level(nameobj, globals, locals, fromlist, level);
2780 Py_DECREF(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002781 if (_PyImport_ReleaseLock() < 0) {
2782 Py_XDECREF(result);
2783 PyErr_SetString(PyExc_RuntimeError,
2784 "not holding the import lock");
2785 return NULL;
2786 }
2787 return result;
Guido van Rossum75acc9c1998-03-03 22:26:50 +00002788}
2789
Fred Drake87590902004-05-28 20:21:36 +00002790/* Return the package that an import is being performed in. If globals comes
2791 from the module foo.bar.bat (not itself a package), this returns the
2792 sys.modules entry for foo.bar. If globals is from a package's __init__.py,
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00002793 the package's entry in sys.modules is returned, as a borrowed reference.
Fred Drake87590902004-05-28 20:21:36 +00002794
Victor Stinner974389d2011-03-15 09:33:57 +01002795 The name of the returned package is returned in *p_name.
Fred Drake87590902004-05-28 20:21:36 +00002796
2797 If globals doesn't come from a package or a module in a package, or a
2798 corresponding entry is not found in sys.modules, Py_None is returned.
2799*/
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002800static PyObject *
Victor Stinner9599de52011-03-13 22:38:38 -04002801get_parent(PyObject *globals, PyObject **p_name, int level)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002802{
Victor Stinner974389d2011-03-15 09:33:57 +01002803 Py_UNICODE name[MAXPATHLEN+1];
2804 const Py_ssize_t bufsize = MAXPATHLEN+1;
2805 PyObject *nameobj;
2806
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002807 static PyObject *namestr = NULL;
2808 static PyObject *pathstr = NULL;
2809 static PyObject *pkgstr = NULL;
2810 PyObject *pkgname, *modname, *modpath, *modules, *parent;
2811 int orig_level = level;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002812
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002813 if (globals == NULL || !PyDict_Check(globals) || !level)
Victor Stinner974389d2011-03-15 09:33:57 +01002814 goto return_none;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002815
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002816 if (namestr == NULL) {
2817 namestr = PyUnicode_InternFromString("__name__");
2818 if (namestr == NULL)
2819 return NULL;
2820 }
2821 if (pathstr == NULL) {
2822 pathstr = PyUnicode_InternFromString("__path__");
2823 if (pathstr == NULL)
2824 return NULL;
2825 }
2826 if (pkgstr == NULL) {
2827 pkgstr = PyUnicode_InternFromString("__package__");
2828 if (pkgstr == NULL)
2829 return NULL;
2830 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002831
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002832 pkgname = PyDict_GetItem(globals, pkgstr);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002833
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002834 if ((pkgname != NULL) && (pkgname != Py_None)) {
2835 /* __package__ is set, so use it */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002836 if (!PyUnicode_Check(pkgname)) {
2837 PyErr_SetString(PyExc_ValueError,
2838 "__package__ set to non-string");
2839 return NULL;
2840 }
Victor Stinner974389d2011-03-15 09:33:57 +01002841 if (PyUnicode_GET_SIZE(pkgname) == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002842 if (level > 0) {
2843 PyErr_SetString(PyExc_ValueError,
2844 "Attempted relative import in non-package");
2845 return NULL;
2846 }
Victor Stinner974389d2011-03-15 09:33:57 +01002847 goto return_none;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002848 }
Victor Stinner974389d2011-03-15 09:33:57 +01002849 if (PyUnicode_GET_SIZE(pkgname)+1 > bufsize) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002850 PyErr_SetString(PyExc_ValueError,
2851 "Package name too long");
2852 return NULL;
2853 }
Victor Stinner974389d2011-03-15 09:33:57 +01002854 Py_UNICODE_strcpy(name, PyUnicode_AS_UNICODE(pkgname));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002855 } else {
2856 /* __package__ not set, so figure it out and set it */
2857 modname = PyDict_GetItem(globals, namestr);
2858 if (modname == NULL || !PyUnicode_Check(modname))
Victor Stinner974389d2011-03-15 09:33:57 +01002859 goto return_none;
Brett Cannon9a5b25a2010-03-01 02:09:17 +00002860
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002861 modpath = PyDict_GetItem(globals, pathstr);
2862 if (modpath != NULL) {
2863 /* __path__ is set, so modname is already the package name */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002864 int error;
Alexandre Vassalottia85998a2008-05-03 18:24:43 +00002865
Victor Stinner974389d2011-03-15 09:33:57 +01002866 if (PyUnicode_GET_SIZE(modname)+1 > bufsize) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002867 PyErr_SetString(PyExc_ValueError,
2868 "Module name too long");
2869 return NULL;
2870 }
Victor Stinner974389d2011-03-15 09:33:57 +01002871 Py_UNICODE_strcpy(name, PyUnicode_AS_UNICODE(modname));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002872 error = PyDict_SetItem(globals, pkgstr, modname);
2873 if (error) {
2874 PyErr_SetString(PyExc_ValueError,
2875 "Could not set __package__");
2876 return NULL;
2877 }
2878 } else {
2879 /* Normal module, so work out the package name if any */
Victor Stinner974389d2011-03-15 09:33:57 +01002880 Py_UNICODE *start = PyUnicode_AS_UNICODE(modname);
2881 Py_UNICODE *lastdot = Py_UNICODE_strrchr(start, '.');
2882 Py_ssize_t len;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002883 int error;
2884 if (lastdot == NULL && level > 0) {
2885 PyErr_SetString(PyExc_ValueError,
2886 "Attempted relative import in non-package");
2887 return NULL;
2888 }
2889 if (lastdot == NULL) {
2890 error = PyDict_SetItem(globals, pkgstr, Py_None);
2891 if (error) {
2892 PyErr_SetString(PyExc_ValueError,
2893 "Could not set __package__");
2894 return NULL;
2895 }
Victor Stinner974389d2011-03-15 09:33:57 +01002896 goto return_none;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002897 }
2898 len = lastdot - start;
Victor Stinner974389d2011-03-15 09:33:57 +01002899 if (len+1 > bufsize) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002900 PyErr_SetString(PyExc_ValueError,
2901 "Module name too long");
2902 return NULL;
2903 }
Victor Stinner974389d2011-03-15 09:33:57 +01002904 Py_UNICODE_strncpy(name, start, len);
2905 name[len] = '\0';
2906 pkgname = PyUnicode_FromUnicode(name, len);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002907 if (pkgname == NULL) {
2908 return NULL;
2909 }
2910 error = PyDict_SetItem(globals, pkgstr, pkgname);
2911 Py_DECREF(pkgname);
2912 if (error) {
2913 PyErr_SetString(PyExc_ValueError,
2914 "Could not set __package__");
2915 return NULL;
2916 }
2917 }
2918 }
2919 while (--level > 0) {
Victor Stinner974389d2011-03-15 09:33:57 +01002920 Py_UNICODE *dot = Py_UNICODE_strrchr(name, '.');
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002921 if (dot == NULL) {
2922 PyErr_SetString(PyExc_ValueError,
2923 "Attempted relative import beyond "
2924 "toplevel package");
2925 return NULL;
2926 }
2927 *dot = '\0';
2928 }
Victor Stinner974389d2011-03-15 09:33:57 +01002929
2930 nameobj = PyUnicode_FromUnicode(name, Py_UNICODE_strlen(name));
2931 if (nameobj == NULL)
2932 return NULL;
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002933
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002934 modules = PyImport_GetModuleDict();
Victor Stinner974389d2011-03-15 09:33:57 +01002935 parent = PyDict_GetItem(modules, nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002936 if (parent == NULL) {
Victor Stinner974389d2011-03-15 09:33:57 +01002937 int err;
2938
2939 if (orig_level >= 1) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002940 PyErr_Format(PyExc_SystemError,
Victor Stinner974389d2011-03-15 09:33:57 +01002941 "Parent module %R not loaded, "
2942 "cannot perform relative import", nameobj);
2943 Py_DECREF(nameobj);
2944 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002945 }
Victor Stinner974389d2011-03-15 09:33:57 +01002946
2947 err = PyErr_WarnFormat(
2948 PyExc_RuntimeWarning, 1,
2949 "Parent module %R not found while handling absolute import",
2950 nameobj);
2951 Py_DECREF(nameobj);
2952 if (err)
2953 return NULL;
2954
2955 goto return_none;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002956 }
Victor Stinner974389d2011-03-15 09:33:57 +01002957 *p_name = nameobj;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002958 return parent;
2959 /* We expect, but can't guarantee, if parent != None, that:
Victor Stinner974389d2011-03-15 09:33:57 +01002960 - parent.__name__ == name
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002961 - parent.__dict__ is globals
2962 If this is violated... Who cares? */
Victor Stinner974389d2011-03-15 09:33:57 +01002963
2964return_none:
2965 nameobj = PyUnicode_FromUnicode(NULL, 0);
2966 if (nameobj == NULL)
2967 return NULL;
2968 *p_name = nameobj;
2969 return Py_None;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002970}
2971
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002972/* altmod is either None or same as mod */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002973static PyObject *
Victor Stinner974389d2011-03-15 09:33:57 +01002974load_next(PyObject *mod, PyObject *altmod,
2975 PyObject *inputname, PyObject **p_outputname,
2976 Py_UNICODE *buf, Py_ssize_t *p_buflen, Py_ssize_t bufsize)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002977{
Victor Stinner974389d2011-03-15 09:33:57 +01002978 const Py_UNICODE *dot;
2979 Py_ssize_t len;
2980 Py_UNICODE *p;
2981 PyObject *fullname, *name, *result, *mark_name;
2982 const Py_UNICODE *nameuni;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002983
Victor Stinner974389d2011-03-15 09:33:57 +01002984 *p_outputname = NULL;
2985
2986 if (PyUnicode_GET_SIZE(inputname) == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002987 /* completely empty module name should only happen in
2988 'from . import' (or '__import__("")')*/
2989 Py_INCREF(mod);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002990 return mod;
2991 }
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002992
Victor Stinner974389d2011-03-15 09:33:57 +01002993 nameuni = PyUnicode_AS_UNICODE(inputname);
2994 if (nameuni == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002995 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002996
Victor Stinner974389d2011-03-15 09:33:57 +01002997 dot = Py_UNICODE_strchr(nameuni, '.');
2998 if (dot != NULL) {
2999 len = dot - nameuni;
3000 if (len == 0) {
3001 PyErr_SetString(PyExc_ValueError,
3002 "Empty module name");
3003 return NULL;
3004 }
3005 }
3006 else
3007 len = PyUnicode_GET_SIZE(inputname);
3008
3009 if (*p_buflen+len+1 >= bufsize) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003010 PyErr_SetString(PyExc_ValueError,
3011 "Module name too long");
3012 return NULL;
3013 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003014
Victor Stinner974389d2011-03-15 09:33:57 +01003015 p = buf + *p_buflen;
3016 if (p != buf) {
3017 *p++ = '.';
3018 *p_buflen += 1;
3019 }
3020 Py_UNICODE_strncpy(p, nameuni, len);
3021 p[len] = '\0';
3022 *p_buflen += len;
3023
3024 fullname = PyUnicode_FromUnicode(buf, *p_buflen);
3025 if (fullname == NULL)
3026 return NULL;
3027 name = PyUnicode_FromUnicode(p, len);
3028 if (name == NULL) {
3029 Py_DECREF(fullname);
3030 return NULL;
3031 }
3032 result = import_submodule(mod, name, fullname);
3033 Py_DECREF(fullname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003034 if (result == Py_None && altmod != mod) {
3035 Py_DECREF(result);
3036 /* Here, altmod must be None and mod must not be None */
Victor Stinner974389d2011-03-15 09:33:57 +01003037 result = import_submodule(altmod, name, name);
3038 Py_DECREF(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003039 if (result != NULL && result != Py_None) {
Victor Stinner974389d2011-03-15 09:33:57 +01003040 mark_name = PyUnicode_FromUnicode(buf, *p_buflen);
3041 if (mark_name == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003042 Py_DECREF(result);
3043 return NULL;
3044 }
Victor Stinner974389d2011-03-15 09:33:57 +01003045 if (mark_miss(mark_name) != 0) {
3046 Py_DECREF(result);
3047 Py_DECREF(mark_name);
3048 return NULL;
3049 }
3050 Py_DECREF(mark_name);
3051 Py_UNICODE_strncpy(buf, nameuni, len);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003052 buf[len] = '\0';
3053 *p_buflen = len;
3054 }
3055 }
Victor Stinner974389d2011-03-15 09:33:57 +01003056 else
3057 Py_DECREF(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003058 if (result == NULL)
3059 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003060
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003061 if (result == Py_None) {
3062 Py_DECREF(result);
3063 PyErr_Format(PyExc_ImportError,
Victor Stinner974389d2011-03-15 09:33:57 +01003064 "No module named %R", inputname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003065 return NULL;
3066 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003067
Victor Stinner974389d2011-03-15 09:33:57 +01003068 if (dot != NULL) {
3069 *p_outputname = PyUnicode_FromUnicode(dot+1, Py_UNICODE_strlen(dot+1));
3070 if (*p_outputname == NULL) {
3071 Py_DECREF(result);
3072 return NULL;
3073 }
3074 }
3075
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003076 return result;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003077}
3078
3079static int
Victor Stinner974389d2011-03-15 09:33:57 +01003080mark_miss(PyObject *name)
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00003081{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003082 PyObject *modules = PyImport_GetModuleDict();
Victor Stinner974389d2011-03-15 09:33:57 +01003083 return PyDict_SetItem(modules, name, Py_None);
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00003084}
3085
3086static int
Victor Stinner974389d2011-03-15 09:33:57 +01003087ensure_fromlist(PyObject *mod, PyObject *fromlist, PyObject *name,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003088 int recursive)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003089{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003090 int i;
Victor Stinner974389d2011-03-15 09:33:57 +01003091 PyObject *fullname;
3092 Py_ssize_t fromlist_len;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003093
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003094 if (!PyObject_HasAttrString(mod, "__path__"))
3095 return 1;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003096
Victor Stinner974389d2011-03-15 09:33:57 +01003097 fromlist_len = PySequence_Size(fromlist);
3098
3099 for (i = 0; i < fromlist_len; i++) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003100 PyObject *item = PySequence_GetItem(fromlist, i);
3101 int hasit;
Victor Stinner974389d2011-03-15 09:33:57 +01003102 if (item == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003103 return 0;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003104 if (!PyUnicode_Check(item)) {
3105 PyErr_SetString(PyExc_TypeError,
3106 "Item in ``from list'' not a string");
3107 Py_DECREF(item);
3108 return 0;
3109 }
3110 if (PyUnicode_AS_UNICODE(item)[0] == '*') {
3111 PyObject *all;
3112 Py_DECREF(item);
3113 /* See if the package defines __all__ */
3114 if (recursive)
3115 continue; /* Avoid endless recursion */
3116 all = PyObject_GetAttrString(mod, "__all__");
3117 if (all == NULL)
3118 PyErr_Clear();
3119 else {
Victor Stinner974389d2011-03-15 09:33:57 +01003120 int ret = ensure_fromlist(mod, all, name, 1);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003121 Py_DECREF(all);
3122 if (!ret)
3123 return 0;
3124 }
3125 continue;
3126 }
3127 hasit = PyObject_HasAttr(mod, item);
3128 if (!hasit) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003129 PyObject *submod;
Victor Stinner974389d2011-03-15 09:33:57 +01003130 fullname = PyUnicode_FromFormat("%U.%U", name, item);
3131 if (fullname != NULL) {
3132 submod = import_submodule(mod, item, fullname);
3133 Py_DECREF(fullname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003134 }
Victor Stinner974389d2011-03-15 09:33:57 +01003135 else
3136 submod = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003137 Py_XDECREF(submod);
3138 if (submod == NULL) {
3139 Py_DECREF(item);
3140 return 0;
3141 }
3142 }
3143 Py_DECREF(item);
3144 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003145
Victor Stinner974389d2011-03-15 09:33:57 +01003146 return 1;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003147}
3148
Neil Schemenauer00b09662003-06-16 21:03:07 +00003149static int
Victor Stinner974389d2011-03-15 09:33:57 +01003150add_submodule(PyObject *mod, PyObject *submod, PyObject *fullname,
3151 PyObject *subname, PyObject *modules)
Neil Schemenauer00b09662003-06-16 21:03:07 +00003152{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003153 if (mod == Py_None)
3154 return 1;
3155 /* Irrespective of the success of this load, make a
3156 reference to it in the parent package module. A copy gets
3157 saved in the modules dictionary under the full name, so get a
3158 reference from there, if need be. (The exception is when the
3159 load failed with a SyntaxError -- then there's no trace in
3160 sys.modules. In that case, of course, do nothing extra.) */
3161 if (submod == NULL) {
Victor Stinner974389d2011-03-15 09:33:57 +01003162 submod = PyDict_GetItem(modules, fullname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003163 if (submod == NULL)
3164 return 1;
3165 }
3166 if (PyModule_Check(mod)) {
3167 /* We can't use setattr here since it can give a
3168 * spurious warning if the submodule name shadows a
3169 * builtin name */
3170 PyObject *dict = PyModule_GetDict(mod);
3171 if (!dict)
3172 return 0;
Victor Stinner974389d2011-03-15 09:33:57 +01003173 if (PyDict_SetItem(dict, subname, submod) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003174 return 0;
3175 }
3176 else {
Victor Stinner974389d2011-03-15 09:33:57 +01003177 if (PyObject_SetAttr(mod, subname, submod) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003178 return 0;
3179 }
3180 return 1;
Neil Schemenauer00b09662003-06-16 21:03:07 +00003181}
3182
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003183static PyObject *
Victor Stinner974389d2011-03-15 09:33:57 +01003184import_submodule(PyObject *mod, PyObject *subname, PyObject *fullname)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003185{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003186 PyObject *modules = PyImport_GetModuleDict();
Victor Stinner533d7832011-03-14 13:22:54 -04003187 PyObject *m = NULL, *bufobj, *path_list, *loader;
Victor Stinner9599de52011-03-13 22:38:38 -04003188 char buf[MAXPATHLEN+1];
3189 struct filedescr *fdp;
3190 FILE *fp;
Guido van Rossum74e6a111994-08-29 12:54:38 +00003191
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003192 /* Require:
3193 if mod == None: subname == fullname
3194 else: mod.__name__ + "." + subname == fullname
3195 */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003196
Victor Stinner974389d2011-03-15 09:33:57 +01003197 if ((m = PyDict_GetItem(modules, fullname)) != NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003198 Py_INCREF(m);
Victor Stinner9599de52011-03-13 22:38:38 -04003199 return m;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003200 }
Victor Stinner9599de52011-03-13 22:38:38 -04003201
3202 if (mod == Py_None)
Victor Stinner533d7832011-03-14 13:22:54 -04003203 path_list = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003204 else {
Victor Stinner533d7832011-03-14 13:22:54 -04003205 path_list = PyObject_GetAttrString(mod, "__path__");
3206 if (path_list == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003207 PyErr_Clear();
3208 Py_INCREF(Py_None);
3209 return Py_None;
3210 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003211 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003212
Victor Stinner533d7832011-03-14 13:22:54 -04003213 fdp = find_module(fullname, subname, path_list,
3214 buf, MAXPATHLEN+1, &fp, &loader);
3215 Py_XDECREF(path_list);
Victor Stinner9599de52011-03-13 22:38:38 -04003216 if (fdp == NULL) {
3217 if (!PyErr_ExceptionMatches(PyExc_ImportError))
3218 return NULL;
3219 PyErr_Clear();
3220 Py_INCREF(Py_None);
3221 return Py_None;
3222 }
3223 bufobj = PyUnicode_DecodeFSDefault(buf);
3224 if (bufobj != NULL) {
3225 m = load_module(fullname, fp, bufobj, fdp->type, loader);
3226 Py_DECREF(bufobj);
3227 }
3228 else
3229 m = NULL;
3230 Py_XDECREF(loader);
3231 if (fp)
3232 fclose(fp);
3233 if (m == NULL)
3234 return NULL;
3235 if (!add_submodule(mod, m, fullname, subname, modules)) {
3236 Py_XDECREF(m);
3237 return NULL;
3238 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003239 return m;
Guido van Rossum74e6a111994-08-29 12:54:38 +00003240}
3241
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003242
3243/* Re-import a module of any kind and return its module object, WITH
3244 INCREMENTED REFERENCE COUNT */
3245
Guido van Rossum79f25d91997-04-29 20:08:16 +00003246PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003247PyImport_ReloadModule(PyObject *m)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003248{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003249 PyInterpreterState *interp = PyThreadState_Get()->interp;
3250 PyObject *modules_reloading = interp->modules_reloading;
3251 PyObject *modules = PyImport_GetModuleDict();
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003252 char buf[MAXPATHLEN+1];
Victor Stinner533d7832011-03-14 13:22:54 -04003253 PyObject *path_list = NULL, *loader = NULL, *existing_m = NULL;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003254 PyObject *nameobj, *bufobj, *subnameobj;
3255 Py_UNICODE *name, *subname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003256 struct filedescr *fdp;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003257 FILE *fp = NULL;
3258 PyObject *newm = NULL;
Brett Cannon9a5b25a2010-03-01 02:09:17 +00003259
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003260 if (modules_reloading == NULL) {
3261 Py_FatalError("PyImport_ReloadModule: "
3262 "no modules_reloading dictionary!");
3263 return NULL;
3264 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003265
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003266 if (m == NULL || !PyModule_Check(m)) {
3267 PyErr_SetString(PyExc_TypeError,
3268 "reload() argument must be module");
3269 return NULL;
3270 }
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003271 nameobj = PyModule_GetNameObject(m);
3272 if (nameobj == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003273 return NULL;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003274 if (m != PyDict_GetItem(modules, nameobj)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003275 PyErr_Format(PyExc_ImportError,
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003276 "reload(): module %U not in sys.modules",
3277 nameobj);
3278 Py_DECREF(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003279 return NULL;
3280 }
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003281 existing_m = PyDict_GetItem(modules_reloading, nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003282 if (existing_m != NULL) {
3283 /* Due to a recursive reload, this module is already
3284 being reloaded. */
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003285 Py_DECREF(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003286 Py_INCREF(existing_m);
3287 return existing_m;
3288 }
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003289 if (PyDict_SetItem(modules_reloading, nameobj, m) < 0) {
3290 Py_DECREF(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003291 return NULL;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003292 }
Guido van Rossumd8faa362007-04-27 19:54:29 +00003293
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003294 name = PyUnicode_AS_UNICODE(nameobj);
3295 subname = Py_UNICODE_strrchr(name, '.');
3296 if (subname == NULL) {
3297 Py_INCREF(nameobj);
3298 subnameobj = nameobj;
3299 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003300 else {
3301 PyObject *parentname, *parent;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003302 Py_ssize_t len;
3303 len = subname - name;
3304 parentname = PyUnicode_FromUnicode(name, len);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003305 if (parentname == NULL) {
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003306 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003307 }
3308 parent = PyDict_GetItem(modules, parentname);
3309 if (parent == NULL) {
3310 PyErr_Format(PyExc_ImportError,
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003311 "reload(): parent %U not in sys.modules",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003312 parentname);
3313 Py_DECREF(parentname);
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003314 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003315 }
3316 Py_DECREF(parentname);
Victor Stinner533d7832011-03-14 13:22:54 -04003317 path_list = PyObject_GetAttrString(parent, "__path__");
3318 if (path_list == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003319 PyErr_Clear();
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003320 subname++;
3321 len = PyUnicode_GET_SIZE(nameobj) - (len + 1);
3322 subnameobj = PyUnicode_FromUnicode(subname, len);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003323 }
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003324 if (subnameobj == NULL)
3325 goto error;
Victor Stinner533d7832011-03-14 13:22:54 -04003326 fdp = find_module(nameobj, subnameobj, path_list,
3327 buf, MAXPATHLEN+1, &fp, &loader);
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003328 Py_DECREF(subnameobj);
Victor Stinner533d7832011-03-14 13:22:54 -04003329 Py_XDECREF(path_list);
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00003330
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003331 if (fdp == NULL) {
3332 Py_XDECREF(loader);
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003333 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003334 }
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00003335
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003336 bufobj = PyUnicode_DecodeFSDefault(buf);
3337 if (bufobj != NULL) {
3338 newm = load_module(nameobj, fp, bufobj, fdp->type, loader);
3339 Py_DECREF(bufobj);
Victor Stinner41c5fec2011-03-13 21:46:30 -04003340 }
3341 else
3342 newm = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003343 Py_XDECREF(loader);
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00003344
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003345 if (fp)
3346 fclose(fp);
3347 if (newm == NULL) {
3348 /* load_module probably removed name from modules because of
3349 * the error. Put back the original module object. We're
3350 * going to return NULL in this case regardless of whether
3351 * replacing name succeeds, so the return value is ignored.
3352 */
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003353 PyDict_SetItem(modules, nameobj, m);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003354 }
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003355
3356error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003357 imp_modules_reloading_clear();
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003358 Py_DECREF(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003359 return newm;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003360}
3361
3362
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003363/* Higher-level import emulator which emulates the "import" statement
3364 more accurately -- it invokes the __import__() function from the
3365 builtins of the current globals. This means that the import is
3366 done using whatever import hooks are installed in the current
Brett Cannonbc2eff32010-09-19 21:39:02 +00003367 environment.
Guido van Rossum6058eb41998-12-21 19:51:00 +00003368 A dummy list ["__doc__"] is passed as the 4th argument so that
Neal Norwitz80e7f272007-08-26 06:45:23 +00003369 e.g. PyImport_Import(PyUnicode_FromString("win32com.client.gencache"))
Guido van Rossum6058eb41998-12-21 19:51:00 +00003370 will return <module "gencache"> instead of <module "win32com">. */
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003371
3372PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003373PyImport_Import(PyObject *module_name)
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003374{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003375 static PyObject *silly_list = NULL;
3376 static PyObject *builtins_str = NULL;
3377 static PyObject *import_str = NULL;
3378 PyObject *globals = NULL;
3379 PyObject *import = NULL;
3380 PyObject *builtins = NULL;
Brett Cannonbc2eff32010-09-19 21:39:02 +00003381 PyObject *modules = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003382 PyObject *r = NULL;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003383
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003384 /* Initialize constant string objects */
3385 if (silly_list == NULL) {
3386 import_str = PyUnicode_InternFromString("__import__");
3387 if (import_str == NULL)
3388 return NULL;
3389 builtins_str = PyUnicode_InternFromString("__builtins__");
3390 if (builtins_str == NULL)
3391 return NULL;
Brett Cannonbc2eff32010-09-19 21:39:02 +00003392 silly_list = PyList_New(0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003393 if (silly_list == NULL)
3394 return NULL;
3395 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003396
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003397 /* Get the builtins from current globals */
3398 globals = PyEval_GetGlobals();
3399 if (globals != NULL) {
3400 Py_INCREF(globals);
3401 builtins = PyObject_GetItem(globals, builtins_str);
3402 if (builtins == NULL)
3403 goto err;
3404 }
3405 else {
3406 /* No globals -- use standard builtins, and fake globals */
3407 builtins = PyImport_ImportModuleLevel("builtins",
3408 NULL, NULL, NULL, 0);
3409 if (builtins == NULL)
3410 return NULL;
3411 globals = Py_BuildValue("{OO}", builtins_str, builtins);
3412 if (globals == NULL)
3413 goto err;
3414 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003415
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003416 /* Get the __import__ function from the builtins */
3417 if (PyDict_Check(builtins)) {
3418 import = PyObject_GetItem(builtins, import_str);
3419 if (import == NULL)
3420 PyErr_SetObject(PyExc_KeyError, import_str);
3421 }
3422 else
3423 import = PyObject_GetAttr(builtins, import_str);
3424 if (import == NULL)
3425 goto err;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003426
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003427 /* Call the __import__ function with the proper argument list
Brett Cannonbc2eff32010-09-19 21:39:02 +00003428 Always use absolute import here.
3429 Calling for side-effect of import. */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003430 r = PyObject_CallFunction(import, "OOOOi", module_name, globals,
3431 globals, silly_list, 0, NULL);
Brett Cannonbc2eff32010-09-19 21:39:02 +00003432 if (r == NULL)
3433 goto err;
3434 Py_DECREF(r);
3435
3436 modules = PyImport_GetModuleDict();
3437 r = PyDict_GetItem(modules, module_name);
3438 if (r != NULL)
3439 Py_INCREF(r);
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003440
3441 err:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003442 Py_XDECREF(globals);
3443 Py_XDECREF(builtins);
3444 Py_XDECREF(import);
Tim Peters50d8d372001-02-28 05:34:27 +00003445
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003446 return r;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003447}
3448
3449
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003450/* Module 'imp' provides Python access to the primitives used for
3451 importing modules.
3452*/
3453
Guido van Rossum79f25d91997-04-29 20:08:16 +00003454static PyObject *
Barry Warsaw28a691b2010-04-17 00:19:56 +00003455imp_make_magic(long magic)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003456{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003457 char buf[4];
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003458
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003459 buf[0] = (char) ((magic >> 0) & 0xff);
3460 buf[1] = (char) ((magic >> 8) & 0xff);
3461 buf[2] = (char) ((magic >> 16) & 0xff);
3462 buf[3] = (char) ((magic >> 24) & 0xff);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003463
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003464 return PyBytes_FromStringAndSize(buf, 4);
Victor Stinner3e2b7172010-11-09 09:32:19 +00003465}
Barry Warsaw28a691b2010-04-17 00:19:56 +00003466
3467static PyObject *
3468imp_get_magic(PyObject *self, PyObject *noargs)
3469{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003470 return imp_make_magic(pyc_magic);
Barry Warsaw28a691b2010-04-17 00:19:56 +00003471}
3472
3473static PyObject *
3474imp_get_tag(PyObject *self, PyObject *noargs)
3475{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003476 return PyUnicode_FromString(pyc_tag);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003477}
3478
Guido van Rossum79f25d91997-04-29 20:08:16 +00003479static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +00003480imp_get_suffixes(PyObject *self, PyObject *noargs)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003481{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003482 PyObject *list;
3483 struct filedescr *fdp;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003484
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003485 list = PyList_New(0);
3486 if (list == NULL)
3487 return NULL;
3488 for (fdp = _PyImport_Filetab; fdp->suffix != NULL; fdp++) {
3489 PyObject *item = Py_BuildValue("ssi",
3490 fdp->suffix, fdp->mode, fdp->type);
3491 if (item == NULL) {
3492 Py_DECREF(list);
3493 return NULL;
3494 }
3495 if (PyList_Append(list, item) < 0) {
3496 Py_DECREF(list);
3497 Py_DECREF(item);
3498 return NULL;
3499 }
3500 Py_DECREF(item);
3501 }
3502 return list;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003503}
3504
Guido van Rossum79f25d91997-04-29 20:08:16 +00003505static PyObject *
Victor Stinner533d7832011-03-14 13:22:54 -04003506call_find_module(PyObject *name, PyObject *path_list)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003507{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003508 extern int fclose(FILE *);
3509 PyObject *fob, *ret;
3510 PyObject *pathobj;
3511 struct filedescr *fdp;
3512 char pathname[MAXPATHLEN+1];
Victor Stinner7d8b77c2011-03-12 08:45:02 -05003513 FILE *fp;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003514 int fd = -1;
3515 char *found_encoding = NULL;
3516 char *encoding = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003517
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003518 pathname[0] = '\0';
Victor Stinner533d7832011-03-14 13:22:54 -04003519 if (path_list == Py_None)
3520 path_list = NULL;
3521 fdp = find_module(NULL, name, path_list,
3522 pathname, MAXPATHLEN+1, &fp, NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003523 if (fdp == NULL)
3524 return NULL;
3525 if (fp != NULL) {
3526 fd = fileno(fp);
3527 if (fd != -1)
3528 fd = dup(fd);
3529 fclose(fp);
3530 fp = NULL;
3531 }
3532 if (fd != -1) {
3533 if (strchr(fdp->mode, 'b') == NULL) {
3534 /* PyTokenizer_FindEncoding() returns PyMem_MALLOC'ed
3535 memory. */
3536 found_encoding = PyTokenizer_FindEncoding(fd);
3537 lseek(fd, 0, 0); /* Reset position */
3538 if (found_encoding == NULL && PyErr_Occurred())
3539 return NULL;
3540 encoding = (found_encoding != NULL) ? found_encoding :
3541 (char*)PyUnicode_GetDefaultEncoding();
3542 }
3543 fob = PyFile_FromFd(fd, pathname, fdp->mode, -1,
3544 (char*)encoding, NULL, NULL, 1);
3545 if (fob == NULL) {
3546 close(fd);
3547 PyMem_FREE(found_encoding);
3548 return NULL;
3549 }
3550 }
3551 else {
3552 fob = Py_None;
3553 Py_INCREF(fob);
3554 }
3555 pathobj = PyUnicode_DecodeFSDefault(pathname);
3556 ret = Py_BuildValue("NN(ssi)",
3557 fob, pathobj, fdp->suffix, fdp->mode, fdp->type);
3558 PyMem_FREE(found_encoding);
Brett Cannon3bb42d92007-10-20 03:43:15 +00003559
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003560 return ret;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003561}
3562
Guido van Rossum79f25d91997-04-29 20:08:16 +00003563static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003564imp_find_module(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003565{
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003566 PyObject *name, *path_list = NULL;
3567 if (!PyArg_ParseTuple(args, "U|O:find_module",
3568 &name, &path_list))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003569 return NULL;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003570 return call_find_module(name, path_list);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003571}
3572
3573static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003574imp_init_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003575{
Victor Stinner95872862011-03-07 18:20:56 +01003576 PyObject *name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003577 int ret;
3578 PyObject *m;
Victor Stinner95872862011-03-07 18:20:56 +01003579 if (!PyArg_ParseTuple(args, "U:init_builtin", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003580 return NULL;
3581 ret = init_builtin(name);
3582 if (ret < 0)
3583 return NULL;
3584 if (ret == 0) {
3585 Py_INCREF(Py_None);
3586 return Py_None;
3587 }
Victor Stinner95872862011-03-07 18:20:56 +01003588 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003589 Py_XINCREF(m);
3590 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003591}
3592
Guido van Rossum79f25d91997-04-29 20:08:16 +00003593static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003594imp_init_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003595{
Victor Stinner53dc7352011-03-20 01:50:21 +01003596 PyObject *name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003597 int ret;
3598 PyObject *m;
Victor Stinner53dc7352011-03-20 01:50:21 +01003599 if (!PyArg_ParseTuple(args, "U:init_frozen", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003600 return NULL;
Victor Stinner53dc7352011-03-20 01:50:21 +01003601 ret = PyImport_ImportFrozenModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003602 if (ret < 0)
3603 return NULL;
3604 if (ret == 0) {
3605 Py_INCREF(Py_None);
3606 return Py_None;
3607 }
Victor Stinner53dc7352011-03-20 01:50:21 +01003608 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003609 Py_XINCREF(m);
3610 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003611}
3612
Guido van Rossum79f25d91997-04-29 20:08:16 +00003613static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003614imp_get_frozen_object(PyObject *self, PyObject *args)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00003615{
Victor Stinner53dc7352011-03-20 01:50:21 +01003616 PyObject *name;
Jack Jansen95ffa231995-10-03 14:38:41 +00003617
Victor Stinner53dc7352011-03-20 01:50:21 +01003618 if (!PyArg_ParseTuple(args, "U:get_frozen_object", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003619 return NULL;
3620 return get_frozen_object(name);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00003621}
3622
Guido van Rossum79f25d91997-04-29 20:08:16 +00003623static PyObject *
Brett Cannon8d110132009-03-15 02:20:16 +00003624imp_is_frozen_package(PyObject *self, PyObject *args)
3625{
Victor Stinner53dc7352011-03-20 01:50:21 +01003626 PyObject *name;
Brett Cannon8d110132009-03-15 02:20:16 +00003627
Victor Stinner53dc7352011-03-20 01:50:21 +01003628 if (!PyArg_ParseTuple(args, "U:is_frozen_package", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003629 return NULL;
3630 return is_frozen_package(name);
Brett Cannon8d110132009-03-15 02:20:16 +00003631}
3632
3633static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003634imp_is_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003635{
Victor Stinner95872862011-03-07 18:20:56 +01003636 PyObject *name;
3637 if (!PyArg_ParseTuple(args, "U:is_builtin", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003638 return NULL;
3639 return PyLong_FromLong(is_builtin(name));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003640}
3641
Guido van Rossum79f25d91997-04-29 20:08:16 +00003642static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003643imp_is_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003644{
Victor Stinner53dc7352011-03-20 01:50:21 +01003645 PyObject *name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003646 struct _frozen *p;
Victor Stinner53dc7352011-03-20 01:50:21 +01003647 if (!PyArg_ParseTuple(args, "U:is_frozen", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003648 return NULL;
3649 p = find_frozen(name);
3650 return PyBool_FromLong((long) (p == NULL ? 0 : p->size));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003651}
3652
3653static FILE *
Victor Stinner2f42ae52011-03-20 00:41:24 +01003654get_file(PyObject *pathname, PyObject *fob, char *mode)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003655{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003656 FILE *fp;
3657 if (mode[0] == 'U')
3658 mode = "r" PY_STDIOTEXTMODE;
3659 if (fob == NULL) {
Victor Stinner2f42ae52011-03-20 00:41:24 +01003660 fp = _Py_fopen(pathname, mode);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003661 }
3662 else {
3663 int fd = PyObject_AsFileDescriptor(fob);
3664 if (fd == -1)
3665 return NULL;
3666 if (!_PyVerify_fd(fd))
3667 goto error;
3668 /* the FILE struct gets a new fd, so that it can be closed
3669 * independently of the file descriptor given
3670 */
3671 fd = dup(fd);
3672 if (fd == -1)
3673 goto error;
3674 fp = fdopen(fd, mode);
3675 }
3676 if (fp)
3677 return fp;
Kristján Valur Jónssone1b04452009-03-31 17:43:39 +00003678error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003679 PyErr_SetFromErrno(PyExc_IOError);
3680 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003681}
3682
Guido van Rossum79f25d91997-04-29 20:08:16 +00003683static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003684imp_load_compiled(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003685{
Victor Stinner2f42ae52011-03-20 00:41:24 +01003686 PyObject *name, *pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003687 PyObject *fob = NULL;
3688 PyObject *m;
3689 FILE *fp;
Victor Stinner2f42ae52011-03-20 00:41:24 +01003690 if (!PyArg_ParseTuple(args, "UO&|O:load_compiled",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003691 &name,
Victor Stinner2f42ae52011-03-20 00:41:24 +01003692 PyUnicode_FSDecoder, &pathname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003693 &fob))
3694 return NULL;
Victor Stinner2f42ae52011-03-20 00:41:24 +01003695 fp = get_file(pathname, fob, "rb");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003696 if (fp == NULL) {
Victor Stinnerebc00522010-12-03 17:06:43 +00003697 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003698 return NULL;
3699 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01003700 m = load_compiled_module(name, pathname, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003701 fclose(fp);
Victor Stinnerebc00522010-12-03 17:06:43 +00003702 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003703 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003704}
3705
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003706#ifdef HAVE_DYNAMIC_LOADING
3707
Guido van Rossum79f25d91997-04-29 20:08:16 +00003708static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003709imp_load_dynamic(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003710{
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003711 PyObject *name, *pathname, *fob = NULL, *mod;
3712 FILE *fp;
3713
3714 if (!PyArg_ParseTuple(args, "UO&|O:load_dynamic",
3715 &name, PyUnicode_FSDecoder, &pathname, &fob))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003716 return NULL;
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003717 if (fob != NULL) {
3718 fp = get_file(NULL, fob, "r");
3719 if (fp == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003720 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003721 }
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003722 else
3723 fp = NULL;
3724 mod = _PyImport_LoadDynamicModule(name, pathname, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003725 if (fp)
3726 fclose(fp);
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003727 return mod;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003728}
3729
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003730#endif /* HAVE_DYNAMIC_LOADING */
3731
Guido van Rossum79f25d91997-04-29 20:08:16 +00003732static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003733imp_load_source(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003734{
Victor Stinner2f42ae52011-03-20 00:41:24 +01003735 PyObject *name, *pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003736 PyObject *fob = NULL;
3737 PyObject *m;
3738 FILE *fp;
Victor Stinner2f42ae52011-03-20 00:41:24 +01003739 if (!PyArg_ParseTuple(args, "UO&|O:load_source",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003740 &name,
Victor Stinner2f42ae52011-03-20 00:41:24 +01003741 PyUnicode_FSDecoder, &pathname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003742 &fob))
3743 return NULL;
Victor Stinner2f42ae52011-03-20 00:41:24 +01003744 fp = get_file(pathname, fob, "r");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003745 if (fp == NULL) {
Victor Stinnerebc00522010-12-03 17:06:43 +00003746 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003747 return NULL;
3748 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01003749 m = load_source_module(name, pathname, fp);
Victor Stinnerebc00522010-12-03 17:06:43 +00003750 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003751 fclose(fp);
3752 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003753}
3754
Guido van Rossum79f25d91997-04-29 20:08:16 +00003755static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003756imp_load_module(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003757{
Victor Stinner41c5fec2011-03-13 21:46:30 -04003758 PyObject *name, *fob, *pathname, *ret;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003759 char *suffix; /* Unused */
3760 char *mode;
3761 int type;
3762 FILE *fp;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003763
Victor Stinner41c5fec2011-03-13 21:46:30 -04003764 if (!PyArg_ParseTuple(args, "UOO&(ssi):load_module",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003765 &name, &fob,
Victor Stinner41c5fec2011-03-13 21:46:30 -04003766 PyUnicode_FSDecoder, &pathname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003767 &suffix, &mode, &type))
3768 return NULL;
3769 if (*mode) {
3770 /* Mode must start with 'r' or 'U' and must not contain '+'.
3771 Implicit in this test is the assumption that the mode
3772 may contain other modifiers like 'b' or 't'. */
Guido van Rossum5e2c5fa2002-05-30 17:33:07 +00003773
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003774 if (!(*mode == 'r' || *mode == 'U') || strchr(mode, '+')) {
3775 PyErr_Format(PyExc_ValueError,
3776 "invalid file open mode %.200s", mode);
Victor Stinner1a563032010-10-15 22:43:10 +00003777 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003778 return NULL;
3779 }
3780 }
3781 if (fob == Py_None)
3782 fp = NULL;
3783 else {
3784 fp = get_file(NULL, fob, mode);
3785 if (fp == NULL) {
Victor Stinner1a563032010-10-15 22:43:10 +00003786 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003787 return NULL;
3788 }
3789 }
Victor Stinner41c5fec2011-03-13 21:46:30 -04003790 ret = load_module(name, fp, pathname, type, NULL);
Victor Stinner1a563032010-10-15 22:43:10 +00003791 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003792 if (fp)
3793 fclose(fp);
3794 return ret;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003795}
3796
3797static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003798imp_load_package(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003799{
Victor Stinnerc9abda02011-03-14 13:33:46 -04003800 PyObject *name, *pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003801 PyObject * ret;
Victor Stinnerc9abda02011-03-14 13:33:46 -04003802 if (!PyArg_ParseTuple(args, "UO&:load_package",
3803 &name, PyUnicode_FSDecoder, &pathname))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003804 return NULL;
Victor Stinnerc9abda02011-03-14 13:33:46 -04003805 ret = load_package(name, pathname);
Victor Stinnerebc00522010-12-03 17:06:43 +00003806 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003807 return ret;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003808}
3809
3810static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003811imp_new_module(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003812{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003813 char *name;
3814 if (!PyArg_ParseTuple(args, "s:new_module", &name))
3815 return NULL;
3816 return PyModule_New(name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003817}
3818
Christian Heimes13a7a212008-01-07 17:13:09 +00003819static PyObject *
3820imp_reload(PyObject *self, PyObject *v)
3821{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003822 return PyImport_ReloadModule(v);
Christian Heimes13a7a212008-01-07 17:13:09 +00003823}
3824
3825PyDoc_STRVAR(doc_reload,
3826"reload(module) -> module\n\
3827\n\
3828Reload the module. The module must have been successfully imported before.");
3829
Barry Warsaw28a691b2010-04-17 00:19:56 +00003830static PyObject *
3831imp_cache_from_source(PyObject *self, PyObject *args, PyObject *kws)
3832{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003833 static char *kwlist[] = {"path", "debug_override", NULL};
Barry Warsaw28a691b2010-04-17 00:19:56 +00003834
Victor Stinner2f42ae52011-03-20 00:41:24 +01003835 PyObject *pathname, *cpathname;
Benjamin Peterson294a9fc2010-10-16 03:12:39 +00003836 PyObject *debug_override = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003837 int debug = !Py_OptimizeFlag;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003838
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003839 if (!PyArg_ParseTupleAndKeywords(
Victor Stinner3ea23dd2010-10-15 20:34:32 +00003840 args, kws, "O&|O", kwlist,
Victor Stinner2f42ae52011-03-20 00:41:24 +01003841 PyUnicode_FSDecoder, &pathname, &debug_override))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003842 return NULL;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003843
Benjamin Peterson294a9fc2010-10-16 03:12:39 +00003844 if (debug_override != NULL &&
3845 (debug = PyObject_IsTrue(debug_override)) < 0) {
Victor Stinner2f42ae52011-03-20 00:41:24 +01003846 Py_DECREF(pathname);
Benjamin Peterson294a9fc2010-10-16 03:12:39 +00003847 return NULL;
3848 }
Barry Warsaw28a691b2010-04-17 00:19:56 +00003849
Victor Stinner3ea23dd2010-10-15 20:34:32 +00003850 cpathname = make_compiled_pathname(
Victor Stinner2f42ae52011-03-20 00:41:24 +01003851 PyUnicode_AS_UNICODE(pathname),
3852 debug);
3853 Py_DECREF(pathname);
Barry Warsaw28a691b2010-04-17 00:19:56 +00003854
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003855 if (cpathname == NULL) {
3856 PyErr_Format(PyExc_SystemError, "path buffer too short");
3857 return NULL;
3858 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01003859 return cpathname;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003860}
3861
3862PyDoc_STRVAR(doc_cache_from_source,
3863"Given the path to a .py file, return the path to its .pyc/.pyo file.\n\
3864\n\
3865The .py file does not need to exist; this simply returns the path to the\n\
3866.pyc/.pyo file calculated as if the .py file were imported. The extension\n\
3867will be .pyc unless __debug__ is not defined, then it will be .pyo.\n\
3868\n\
3869If debug_override is not None, then it must be a boolean and is taken as\n\
3870the value of __debug__ instead.");
3871
3872static PyObject *
3873imp_source_from_cache(PyObject *self, PyObject *args, PyObject *kws)
3874{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003875 static char *kwlist[] = {"path", NULL};
Victor Stinnerc9abda02011-03-14 13:33:46 -04003876 PyObject *pathname, *source;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003877
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003878 if (!PyArg_ParseTupleAndKeywords(
Victor Stinnerebc00522010-12-03 17:06:43 +00003879 args, kws, "O&", kwlist,
Victor Stinnerc9abda02011-03-14 13:33:46 -04003880 PyUnicode_FSDecoder, &pathname))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003881 return NULL;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003882
Victor Stinnerc9abda02011-03-14 13:33:46 -04003883 source = make_source_pathname(pathname);
3884 if (source == NULL) {
3885 PyErr_Format(PyExc_ValueError, "Not a PEP 3147 pyc path: %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003886 pathname);
Victor Stinnerc9abda02011-03-14 13:33:46 -04003887 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003888 return NULL;
3889 }
Victor Stinnerc9abda02011-03-14 13:33:46 -04003890 Py_DECREF(pathname);
3891 return source;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003892}
3893
3894PyDoc_STRVAR(doc_source_from_cache,
3895"Given the path to a .pyc./.pyo file, return the path to its .py file.\n\
3896\n\
3897The .pyc/.pyo file does not need to exist; this simply returns the path to\n\
3898the .py file calculated to correspond to the .pyc/.pyo file. If path\n\
3899does not conform to PEP 3147 format, ValueError will be raised.");
3900
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003901/* Doc strings */
3902
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003903PyDoc_STRVAR(doc_imp,
3904"This module provides the components needed to build your own\n\
3905__import__ function. Undocumented functions are obsolete.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003906
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003907PyDoc_STRVAR(doc_find_module,
3908"find_module(name, [path]) -> (file, filename, (suffix, mode, type))\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003909Search for a module. If path is omitted or None, search for a\n\
3910built-in, frozen or special module and continue search in sys.path.\n\
3911The module name cannot contain '.'; to search for a submodule of a\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003912package, pass the submodule name and the package's __path__.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003913
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003914PyDoc_STRVAR(doc_load_module,
3915"load_module(name, file, filename, (suffix, mode, type)) -> module\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003916Load a module, given information returned by find_module().\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003917The module name must include the full package name, if any.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003918
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003919PyDoc_STRVAR(doc_get_magic,
3920"get_magic() -> string\n\
3921Return the magic number for .pyc or .pyo files.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003922
Barry Warsaw28a691b2010-04-17 00:19:56 +00003923PyDoc_STRVAR(doc_get_tag,
3924"get_tag() -> string\n\
3925Return the magic tag for .pyc or .pyo files.");
3926
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003927PyDoc_STRVAR(doc_get_suffixes,
3928"get_suffixes() -> [(suffix, mode, type), ...]\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003929Return a list of (suffix, mode, type) tuples describing the files\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003930that find_module() looks for.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003931
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003932PyDoc_STRVAR(doc_new_module,
3933"new_module(name) -> module\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003934Create a new module. Do not enter it in sys.modules.\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003935The module name must include the full package name, if any.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003936
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003937PyDoc_STRVAR(doc_lock_held,
Tim Petersa7c65092004-08-01 23:26:05 +00003938"lock_held() -> boolean\n\
3939Return True if the import lock is currently held, else False.\n\
3940On platforms without threads, return False.");
Tim Peters69232342001-08-30 05:16:13 +00003941
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00003942PyDoc_STRVAR(doc_acquire_lock,
3943"acquire_lock() -> None\n\
Neal Norwitz2294c0d2003-02-12 23:02:21 +00003944Acquires the interpreter's import lock for the current thread.\n\
3945This lock should be used by import hooks to ensure thread-safety\n\
3946when importing modules.\n\
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00003947On platforms without threads, this function does nothing.");
3948
3949PyDoc_STRVAR(doc_release_lock,
3950"release_lock() -> None\n\
3951Release the interpreter's import lock.\n\
3952On platforms without threads, this function does nothing.");
3953
Guido van Rossum79f25d91997-04-29 20:08:16 +00003954static PyMethodDef imp_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003955 {"find_module", imp_find_module, METH_VARARGS, doc_find_module},
3956 {"get_magic", imp_get_magic, METH_NOARGS, doc_get_magic},
3957 {"get_tag", imp_get_tag, METH_NOARGS, doc_get_tag},
3958 {"get_suffixes", imp_get_suffixes, METH_NOARGS, doc_get_suffixes},
3959 {"load_module", imp_load_module, METH_VARARGS, doc_load_module},
3960 {"new_module", imp_new_module, METH_VARARGS, doc_new_module},
3961 {"lock_held", imp_lock_held, METH_NOARGS, doc_lock_held},
3962 {"acquire_lock", imp_acquire_lock, METH_NOARGS, doc_acquire_lock},
3963 {"release_lock", imp_release_lock, METH_NOARGS, doc_release_lock},
3964 {"reload", imp_reload, METH_O, doc_reload},
3965 {"cache_from_source", (PyCFunction)imp_cache_from_source,
3966 METH_VARARGS | METH_KEYWORDS, doc_cache_from_source},
3967 {"source_from_cache", (PyCFunction)imp_source_from_cache,
3968 METH_VARARGS | METH_KEYWORDS, doc_source_from_cache},
3969 /* The rest are obsolete */
3970 {"get_frozen_object", imp_get_frozen_object, METH_VARARGS},
3971 {"is_frozen_package", imp_is_frozen_package, METH_VARARGS},
3972 {"init_builtin", imp_init_builtin, METH_VARARGS},
3973 {"init_frozen", imp_init_frozen, METH_VARARGS},
3974 {"is_builtin", imp_is_builtin, METH_VARARGS},
3975 {"is_frozen", imp_is_frozen, METH_VARARGS},
3976 {"load_compiled", imp_load_compiled, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003977#ifdef HAVE_DYNAMIC_LOADING
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003978 {"load_dynamic", imp_load_dynamic, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003979#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003980 {"load_package", imp_load_package, METH_VARARGS},
3981 {"load_source", imp_load_source, METH_VARARGS},
3982 {NULL, NULL} /* sentinel */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003983};
3984
Guido van Rossum1a8791e1998-08-04 22:46:29 +00003985static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003986setint(PyObject *d, char *name, int value)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003987{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003988 PyObject *v;
3989 int err;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003990
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003991 v = PyLong_FromLong((long)value);
3992 err = PyDict_SetItemString(d, name, v);
3993 Py_XDECREF(v);
3994 return err;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003995}
3996
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003997typedef struct {
3998 PyObject_HEAD
3999} NullImporter;
4000
4001static int
4002NullImporter_init(NullImporter *self, PyObject *args, PyObject *kwds)
4003{
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004004#ifndef MS_WINDOWS
4005 PyObject *path;
4006 struct stat statbuf;
4007 int rv;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004008
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004009 if (!_PyArg_NoKeywords("NullImporter()", kwds))
4010 return -1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004011
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004012 if (!PyArg_ParseTuple(args, "O&:NullImporter",
4013 PyUnicode_FSConverter, &path))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004014 return -1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004015
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004016 if (PyBytes_GET_SIZE(path) == 0) {
4017 Py_DECREF(path);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004018 PyErr_SetString(PyExc_ImportError, "empty pathname");
4019 return -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004020 }
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004021
4022 rv = stat(PyBytes_AS_STRING(path), &statbuf);
4023 Py_DECREF(path);
4024 if (rv == 0) {
4025 /* it exists */
4026 if (S_ISDIR(statbuf.st_mode)) {
4027 /* it's a directory */
4028 PyErr_SetString(PyExc_ImportError, "existing directory");
4029 return -1;
4030 }
4031 }
4032#else /* MS_WINDOWS */
4033 PyObject *pathobj;
4034 DWORD rv;
Victor Stinner255dfdb2010-09-29 10:28:51 +00004035 wchar_t *path;
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004036
4037 if (!_PyArg_NoKeywords("NullImporter()", kwds))
4038 return -1;
4039
4040 if (!PyArg_ParseTuple(args, "U:NullImporter",
4041 &pathobj))
4042 return -1;
4043
4044 if (PyUnicode_GET_SIZE(pathobj) == 0) {
4045 PyErr_SetString(PyExc_ImportError, "empty pathname");
4046 return -1;
4047 }
4048
Victor Stinnerbeb4135b2010-10-07 01:02:42 +00004049 path = PyUnicode_AsWideCharString(pathobj, NULL);
Victor Stinner255dfdb2010-09-29 10:28:51 +00004050 if (path == NULL)
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004051 return -1;
4052 /* see issue1293 and issue3677:
4053 * stat() on Windows doesn't recognise paths like
4054 * "e:\\shared\\" and "\\\\whiterab-c2znlh\\shared" as dirs.
4055 */
4056 rv = GetFileAttributesW(path);
Victor Stinner255dfdb2010-09-29 10:28:51 +00004057 PyMem_Free(path);
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004058 if (rv != INVALID_FILE_ATTRIBUTES) {
4059 /* it exists */
4060 if (rv & FILE_ATTRIBUTE_DIRECTORY) {
4061 /* it's a directory */
4062 PyErr_SetString(PyExc_ImportError, "existing directory");
4063 return -1;
4064 }
4065 }
4066#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004067 return 0;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004068}
4069
4070static PyObject *
4071NullImporter_find_module(NullImporter *self, PyObject *args)
4072{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004073 Py_RETURN_NONE;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004074}
4075
4076static PyMethodDef NullImporter_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004077 {"find_module", (PyCFunction)NullImporter_find_module, METH_VARARGS,
4078 "Always return None"
4079 },
4080 {NULL} /* Sentinel */
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004081};
4082
4083
Christian Heimes9cd17752007-11-18 19:35:23 +00004084PyTypeObject PyNullImporter_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004085 PyVarObject_HEAD_INIT(NULL, 0)
4086 "imp.NullImporter", /*tp_name*/
4087 sizeof(NullImporter), /*tp_basicsize*/
4088 0, /*tp_itemsize*/
4089 0, /*tp_dealloc*/
4090 0, /*tp_print*/
4091 0, /*tp_getattr*/
4092 0, /*tp_setattr*/
4093 0, /*tp_reserved*/
4094 0, /*tp_repr*/
4095 0, /*tp_as_number*/
4096 0, /*tp_as_sequence*/
4097 0, /*tp_as_mapping*/
4098 0, /*tp_hash */
4099 0, /*tp_call*/
4100 0, /*tp_str*/
4101 0, /*tp_getattro*/
4102 0, /*tp_setattro*/
4103 0, /*tp_as_buffer*/
4104 Py_TPFLAGS_DEFAULT, /*tp_flags*/
4105 "Null importer object", /* tp_doc */
4106 0, /* tp_traverse */
4107 0, /* tp_clear */
4108 0, /* tp_richcompare */
4109 0, /* tp_weaklistoffset */
4110 0, /* tp_iter */
4111 0, /* tp_iternext */
4112 NullImporter_methods, /* tp_methods */
4113 0, /* tp_members */
4114 0, /* tp_getset */
4115 0, /* tp_base */
4116 0, /* tp_dict */
4117 0, /* tp_descr_get */
4118 0, /* tp_descr_set */
4119 0, /* tp_dictoffset */
4120 (initproc)NullImporter_init, /* tp_init */
4121 0, /* tp_alloc */
4122 PyType_GenericNew /* tp_new */
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004123};
4124
Martin v. Löwis1a214512008-06-11 05:26:20 +00004125static struct PyModuleDef impmodule = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004126 PyModuleDef_HEAD_INIT,
4127 "imp",
4128 doc_imp,
4129 0,
4130 imp_methods,
4131 NULL,
4132 NULL,
4133 NULL,
4134 NULL
Martin v. Löwis1a214512008-06-11 05:26:20 +00004135};
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004136
Jason Tishler6bc06ec2003-09-04 11:59:50 +00004137PyMODINIT_FUNC
Martin v. Löwis1a214512008-06-11 05:26:20 +00004138PyInit_imp(void)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004139{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004140 PyObject *m, *d;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004141
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004142 if (PyType_Ready(&PyNullImporter_Type) < 0)
4143 return NULL;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004144
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004145 m = PyModule_Create(&impmodule);
4146 if (m == NULL)
4147 goto failure;
4148 d = PyModule_GetDict(m);
4149 if (d == NULL)
4150 goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004151
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004152 if (setint(d, "SEARCH_ERROR", SEARCH_ERROR) < 0) goto failure;
4153 if (setint(d, "PY_SOURCE", PY_SOURCE) < 0) goto failure;
4154 if (setint(d, "PY_COMPILED", PY_COMPILED) < 0) goto failure;
4155 if (setint(d, "C_EXTENSION", C_EXTENSION) < 0) goto failure;
4156 if (setint(d, "PY_RESOURCE", PY_RESOURCE) < 0) goto failure;
4157 if (setint(d, "PKG_DIRECTORY", PKG_DIRECTORY) < 0) goto failure;
4158 if (setint(d, "C_BUILTIN", C_BUILTIN) < 0) goto failure;
4159 if (setint(d, "PY_FROZEN", PY_FROZEN) < 0) goto failure;
4160 if (setint(d, "PY_CODERESOURCE", PY_CODERESOURCE) < 0) goto failure;
4161 if (setint(d, "IMP_HOOK", IMP_HOOK) < 0) goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004162
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004163 Py_INCREF(&PyNullImporter_Type);
4164 PyModule_AddObject(m, "NullImporter", (PyObject *)&PyNullImporter_Type);
4165 return m;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00004166 failure:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004167 Py_XDECREF(m);
4168 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004169}
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004170
4171
Guido van Rossumb18618d2000-05-03 23:44:39 +00004172/* API for embedding applications that want to add their own entries
4173 to the table of built-in modules. This should normally be called
4174 *before* Py_Initialize(). When the table resize fails, -1 is
4175 returned and the existing table is unchanged.
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004176
4177 After a similar function by Just van Rossum. */
4178
4179int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00004180PyImport_ExtendInittab(struct _inittab *newtab)
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004181{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004182 static struct _inittab *our_copy = NULL;
4183 struct _inittab *p;
4184 int i, n;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004185
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004186 /* Count the number of entries in both tables */
4187 for (n = 0; newtab[n].name != NULL; n++)
4188 ;
4189 if (n == 0)
4190 return 0; /* Nothing to do */
4191 for (i = 0; PyImport_Inittab[i].name != NULL; i++)
4192 ;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004193
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004194 /* Allocate new memory for the combined table */
4195 p = our_copy;
4196 PyMem_RESIZE(p, struct _inittab, i+n+1);
4197 if (p == NULL)
4198 return -1;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004199
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004200 /* Copy the tables into the new memory */
4201 if (our_copy != PyImport_Inittab)
4202 memcpy(p, PyImport_Inittab, (i+1) * sizeof(struct _inittab));
4203 PyImport_Inittab = our_copy = p;
4204 memcpy(p+i, newtab, (n+1) * sizeof(struct _inittab));
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004205
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004206 return 0;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004207}
4208
4209/* Shorthand to add a single entry given a name and a function */
4210
4211int
Brett Cannona826f322009-04-02 03:41:46 +00004212PyImport_AppendInittab(const char *name, PyObject* (*initfunc)(void))
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004213{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004214 struct _inittab newtab[2];
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004215
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004216 memset(newtab, '\0', sizeof newtab);
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004217
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004218 newtab[0].name = (char *)name;
4219 newtab[0].initfunc = initfunc;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004220
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004221 return PyImport_ExtendInittab(newtab);
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004222}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00004223
4224#ifdef __cplusplus
4225}
4226#endif