blob: 2c21112c4bc7e7c5397fb686ea7657d6d7084a5b [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
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000147
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000148/* Initialize things */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000149
150void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000151_PyImport_Init(void)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000152{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000153 const struct filedescr *scan;
154 struct filedescr *filetab;
155 int countD = 0;
156 int countS = 0;
Guido van Rossumed1170e1999-12-20 21:23:41 +0000157
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000158 /* prepare _PyImport_Filetab: copy entries from
159 _PyImport_DynLoadFiletab and _PyImport_StandardFiletab.
160 */
Guido van Rossum04110fb2007-08-24 16:32:05 +0000161#ifdef HAVE_DYNAMIC_LOADING
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000162 for (scan = _PyImport_DynLoadFiletab; scan->suffix != NULL; ++scan)
163 ++countD;
Guido van Rossum04110fb2007-08-24 16:32:05 +0000164#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000165 for (scan = _PyImport_StandardFiletab; scan->suffix != NULL; ++scan)
166 ++countS;
167 filetab = PyMem_NEW(struct filedescr, countD + countS + 1);
168 if (filetab == NULL)
169 Py_FatalError("Can't initialize import file table.");
Guido van Rossum04110fb2007-08-24 16:32:05 +0000170#ifdef HAVE_DYNAMIC_LOADING
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000171 memcpy(filetab, _PyImport_DynLoadFiletab,
172 countD * sizeof(struct filedescr));
Guido van Rossum04110fb2007-08-24 16:32:05 +0000173#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000174 memcpy(filetab + countD, _PyImport_StandardFiletab,
175 countS * sizeof(struct filedescr));
176 filetab[countD + countS].suffix = NULL;
Guido van Rossumed1170e1999-12-20 21:23:41 +0000177
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000178 _PyImport_Filetab = filetab;
Guido van Rossumed1170e1999-12-20 21:23:41 +0000179
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000180 if (Py_OptimizeFlag) {
181 /* Replace ".pyc" with ".pyo" in _PyImport_Filetab */
182 for (; filetab->suffix != NULL; filetab++) {
183 if (strcmp(filetab->suffix, ".pyc") == 0)
184 filetab->suffix = ".pyo";
185 }
186 }
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000187}
188
Guido van Rossum25ce5661997-08-02 03:10:38 +0000189void
Just van Rossum52e14d62002-12-30 22:08:05 +0000190_PyImportHooks_Init(void)
191{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000192 PyObject *v, *path_hooks = NULL, *zimpimport;
193 int err = 0;
Just van Rossum52e14d62002-12-30 22:08:05 +0000194
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000195 /* adding sys.path_hooks and sys.path_importer_cache, setting up
196 zipimport */
197 if (PyType_Ready(&PyNullImporter_Type) < 0)
198 goto error;
Just van Rossum52e14d62002-12-30 22:08:05 +0000199
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000200 if (Py_VerboseFlag)
201 PySys_WriteStderr("# installing zipimport hook\n");
Just van Rossum52e14d62002-12-30 22:08:05 +0000202
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000203 v = PyList_New(0);
204 if (v == NULL)
205 goto error;
206 err = PySys_SetObject("meta_path", v);
207 Py_DECREF(v);
208 if (err)
209 goto error;
210 v = PyDict_New();
211 if (v == NULL)
212 goto error;
213 err = PySys_SetObject("path_importer_cache", v);
214 Py_DECREF(v);
215 if (err)
216 goto error;
217 path_hooks = PyList_New(0);
218 if (path_hooks == NULL)
219 goto error;
220 err = PySys_SetObject("path_hooks", path_hooks);
221 if (err) {
Just van Rossum52e14d62002-12-30 22:08:05 +0000222 error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000223 PyErr_Print();
224 Py_FatalError("initializing sys.meta_path, sys.path_hooks, "
225 "path_importer_cache, or NullImporter failed"
226 );
227 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000228
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000229 zimpimport = PyImport_ImportModule("zipimport");
230 if (zimpimport == NULL) {
231 PyErr_Clear(); /* No zip import module -- okay */
232 if (Py_VerboseFlag)
233 PySys_WriteStderr("# can't import zipimport\n");
234 }
235 else {
236 PyObject *zipimporter = PyObject_GetAttrString(zimpimport,
237 "zipimporter");
238 Py_DECREF(zimpimport);
239 if (zipimporter == NULL) {
240 PyErr_Clear(); /* No zipimporter object -- okay */
241 if (Py_VerboseFlag)
242 PySys_WriteStderr(
243 "# can't import zipimport.zipimporter\n");
244 }
245 else {
246 /* sys.path_hooks.append(zipimporter) */
247 err = PyList_Append(path_hooks, zipimporter);
248 Py_DECREF(zipimporter);
249 if (err)
250 goto error;
251 if (Py_VerboseFlag)
252 PySys_WriteStderr(
253 "# installed zipimport hook\n");
254 }
255 }
256 Py_DECREF(path_hooks);
Just van Rossum52e14d62002-12-30 22:08:05 +0000257}
258
259void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000260_PyImport_Fini(void)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000261{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000262 Py_XDECREF(extensions);
263 extensions = NULL;
264 PyMem_DEL(_PyImport_Filetab);
265 _PyImport_Filetab = NULL;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000266}
267
268
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000269/* Locking primitives to prevent parallel imports of the same module
270 in different threads to return with a partially loaded module.
271 These calls are serialized by the global interpreter lock. */
272
273#ifdef WITH_THREAD
274
Guido van Rossum49b56061998-10-01 20:42:43 +0000275#include "pythread.h"
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000276
Guido van Rossum65d5b571998-12-21 19:32:43 +0000277static PyThread_type_lock import_lock = 0;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000278static long import_lock_thread = -1;
279static int import_lock_level = 0;
280
Benjamin Peterson0df35a92009-10-04 20:32:25 +0000281void
282_PyImport_AcquireLock(void)
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000283{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000284 long me = PyThread_get_thread_ident();
285 if (me == -1)
286 return; /* Too bad */
287 if (import_lock == NULL) {
288 import_lock = PyThread_allocate_lock();
289 if (import_lock == NULL)
290 return; /* Nothing much we can do. */
291 }
292 if (import_lock_thread == me) {
293 import_lock_level++;
294 return;
295 }
296 if (import_lock_thread != -1 || !PyThread_acquire_lock(import_lock, 0))
297 {
298 PyThreadState *tstate = PyEval_SaveThread();
299 PyThread_acquire_lock(import_lock, 1);
300 PyEval_RestoreThread(tstate);
301 }
302 import_lock_thread = me;
303 import_lock_level = 1;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000304}
305
Benjamin Peterson0df35a92009-10-04 20:32:25 +0000306int
307_PyImport_ReleaseLock(void)
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000308{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000309 long me = PyThread_get_thread_ident();
310 if (me == -1 || import_lock == NULL)
311 return 0; /* Too bad */
312 if (import_lock_thread != me)
313 return -1;
314 import_lock_level--;
315 if (import_lock_level == 0) {
316 import_lock_thread = -1;
317 PyThread_release_lock(import_lock);
318 }
319 return 1;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000320}
321
Gregory P. Smith24cec9f2010-03-01 06:18:41 +0000322/* This function is called from PyOS_AfterFork to ensure that newly
323 created child processes do not share locks with the parent.
324 We now acquire the import lock around fork() calls but on some platforms
325 (Solaris 9 and earlier? see isue7242) that still left us with problems. */
Guido van Rossum8ee3e5a2005-09-14 18:09:42 +0000326
327void
328_PyImport_ReInitLock(void)
329{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000330 if (import_lock != NULL)
331 import_lock = PyThread_allocate_lock();
Nick Coghlanb2ddf792010-12-02 04:11:46 +0000332 if (import_lock_level > 1) {
333 /* Forked as a side effect of import */
334 long me = PyThread_get_thread_ident();
335 PyThread_acquire_lock(import_lock, 0);
Victor Stinner942003c2011-03-07 16:57:48 +0100336 /* XXX: can the previous line fail? */
Nick Coghlanb2ddf792010-12-02 04:11:46 +0000337 import_lock_thread = me;
338 import_lock_level--;
339 } else {
340 import_lock_thread = -1;
341 import_lock_level = 0;
342 }
Guido van Rossum8ee3e5a2005-09-14 18:09:42 +0000343}
344
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000345#endif
346
Tim Peters69232342001-08-30 05:16:13 +0000347static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000348imp_lock_held(PyObject *self, PyObject *noargs)
Tim Peters69232342001-08-30 05:16:13 +0000349{
Tim Peters69232342001-08-30 05:16:13 +0000350#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000351 return PyBool_FromLong(import_lock_thread != -1);
Tim Peters69232342001-08-30 05:16:13 +0000352#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000353 return PyBool_FromLong(0);
Tim Peters69232342001-08-30 05:16:13 +0000354#endif
355}
356
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000357static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000358imp_acquire_lock(PyObject *self, PyObject *noargs)
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000359{
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000360#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000361 _PyImport_AcquireLock();
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000362#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000363 Py_INCREF(Py_None);
364 return Py_None;
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000365}
366
367static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000368imp_release_lock(PyObject *self, PyObject *noargs)
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000369{
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000370#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000371 if (_PyImport_ReleaseLock() < 0) {
372 PyErr_SetString(PyExc_RuntimeError,
373 "not holding the import lock");
374 return NULL;
375 }
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000376#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000377 Py_INCREF(Py_None);
378 return Py_None;
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000379}
380
Guido van Rossumd8faa362007-04-27 19:54:29 +0000381static void
382imp_modules_reloading_clear(void)
383{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000384 PyInterpreterState *interp = PyThreadState_Get()->interp;
385 if (interp->modules_reloading != NULL)
386 PyDict_Clear(interp->modules_reloading);
Guido van Rossumd8faa362007-04-27 19:54:29 +0000387}
388
Guido van Rossum25ce5661997-08-02 03:10:38 +0000389/* Helper for sys */
390
391PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000392PyImport_GetModuleDict(void)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000393{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000394 PyInterpreterState *interp = PyThreadState_GET()->interp;
395 if (interp->modules == NULL)
396 Py_FatalError("PyImport_GetModuleDict: no module dictionary!");
397 return interp->modules;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000398}
399
Guido van Rossum3f5da241990-12-20 15:06:42 +0000400
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000401/* List of names to clear in sys */
402static char* sys_deletes[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000403 "path", "argv", "ps1", "ps2",
404 "last_type", "last_value", "last_traceback",
405 "path_hooks", "path_importer_cache", "meta_path",
406 /* misc stuff */
407 "flags", "float_info",
408 NULL
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000409};
410
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000411static char* sys_files[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000412 "stdin", "__stdin__",
413 "stdout", "__stdout__",
414 "stderr", "__stderr__",
415 NULL
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000416};
417
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000418
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000419/* Un-initialize things, as good as we can */
Guido van Rossum3f5da241990-12-20 15:06:42 +0000420
Guido van Rossum3f5da241990-12-20 15:06:42 +0000421void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000422PyImport_Cleanup(void)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000423{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000424 Py_ssize_t pos, ndone;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000425 PyObject *key, *value, *dict;
426 PyInterpreterState *interp = PyThreadState_GET()->interp;
427 PyObject *modules = interp->modules;
Guido van Rossum758eec01998-01-19 21:58:26 +0000428
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000429 if (modules == NULL)
430 return; /* Already done */
Guido van Rossum758eec01998-01-19 21:58:26 +0000431
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000432 /* Delete some special variables first. These are common
433 places where user values hide and people complain when their
434 destructors fail. Since the modules containing them are
435 deleted *last* of all, they would come too late in the normal
436 destruction order. Sigh. */
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000437
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000438 value = PyDict_GetItemString(modules, "builtins");
439 if (value != NULL && PyModule_Check(value)) {
440 dict = PyModule_GetDict(value);
441 if (Py_VerboseFlag)
442 PySys_WriteStderr("# clear builtins._\n");
443 PyDict_SetItemString(dict, "_", Py_None);
444 }
445 value = PyDict_GetItemString(modules, "sys");
446 if (value != NULL && PyModule_Check(value)) {
447 char **p;
448 PyObject *v;
449 dict = PyModule_GetDict(value);
450 for (p = sys_deletes; *p != NULL; p++) {
451 if (Py_VerboseFlag)
452 PySys_WriteStderr("# clear sys.%s\n", *p);
453 PyDict_SetItemString(dict, *p, Py_None);
454 }
455 for (p = sys_files; *p != NULL; p+=2) {
456 if (Py_VerboseFlag)
457 PySys_WriteStderr("# restore sys.%s\n", *p);
458 v = PyDict_GetItemString(dict, *(p+1));
459 if (v == NULL)
460 v = Py_None;
461 PyDict_SetItemString(dict, *p, v);
462 }
463 }
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000464
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000465 /* First, delete __main__ */
466 value = PyDict_GetItemString(modules, "__main__");
467 if (value != NULL && PyModule_Check(value)) {
468 if (Py_VerboseFlag)
469 PySys_WriteStderr("# cleanup __main__\n");
470 _PyModule_Clear(value);
471 PyDict_SetItemString(modules, "__main__", Py_None);
472 }
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000473
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000474 /* The special treatment of "builtins" here is because even
475 when it's not referenced as a module, its dictionary is
476 referenced by almost every module's __builtins__. Since
477 deleting a module clears its dictionary (even if there are
478 references left to it), we need to delete the "builtins"
479 module last. Likewise, we don't delete sys until the very
480 end because it is implicitly referenced (e.g. by print).
Guido van Rossum758eec01998-01-19 21:58:26 +0000481
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000482 Also note that we 'delete' modules by replacing their entry
483 in the modules dict with None, rather than really deleting
484 them; this avoids a rehash of the modules dictionary and
485 also marks them as "non existent" so they won't be
486 re-imported. */
Guido van Rossum758eec01998-01-19 21:58:26 +0000487
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000488 /* Next, repeatedly delete modules with a reference count of
489 one (skipping builtins and sys) and delete them */
490 do {
491 ndone = 0;
492 pos = 0;
493 while (PyDict_Next(modules, &pos, &key, &value)) {
494 if (value->ob_refcnt != 1)
495 continue;
496 if (PyUnicode_Check(key) && PyModule_Check(value)) {
Victor Stinner9464d612011-03-07 17:08:21 +0100497 if (PyUnicode_CompareWithASCIIString(key, "builtins") == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000498 continue;
Victor Stinner9464d612011-03-07 17:08:21 +0100499 if (PyUnicode_CompareWithASCIIString(key, "sys") == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000500 continue;
501 if (Py_VerboseFlag)
Victor Stinner9464d612011-03-07 17:08:21 +0100502 PySys_FormatStderr(
503 "# cleanup[1] %U\n", key);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000504 _PyModule_Clear(value);
505 PyDict_SetItem(modules, key, Py_None);
506 ndone++;
507 }
508 }
509 } while (ndone > 0);
Guido van Rossum758eec01998-01-19 21:58:26 +0000510
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000511 /* Next, delete all modules (still skipping builtins and sys) */
512 pos = 0;
513 while (PyDict_Next(modules, &pos, &key, &value)) {
514 if (PyUnicode_Check(key) && PyModule_Check(value)) {
Victor Stinner9464d612011-03-07 17:08:21 +0100515 if (PyUnicode_CompareWithASCIIString(key, "builtins") == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000516 continue;
Victor Stinner9464d612011-03-07 17:08:21 +0100517 if (PyUnicode_CompareWithASCIIString(key, "sys") == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000518 continue;
519 if (Py_VerboseFlag)
Victor Stinner9464d612011-03-07 17:08:21 +0100520 PySys_FormatStderr("# cleanup[2] %U\n", key);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000521 _PyModule_Clear(value);
522 PyDict_SetItem(modules, key, Py_None);
523 }
524 }
Guido van Rossum758eec01998-01-19 21:58:26 +0000525
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000526 /* Next, delete sys and builtins (in that order) */
527 value = PyDict_GetItemString(modules, "sys");
528 if (value != NULL && PyModule_Check(value)) {
529 if (Py_VerboseFlag)
530 PySys_WriteStderr("# cleanup sys\n");
531 _PyModule_Clear(value);
532 PyDict_SetItemString(modules, "sys", Py_None);
533 }
534 value = PyDict_GetItemString(modules, "builtins");
535 if (value != NULL && PyModule_Check(value)) {
536 if (Py_VerboseFlag)
537 PySys_WriteStderr("# cleanup builtins\n");
538 _PyModule_Clear(value);
539 PyDict_SetItemString(modules, "builtins", Py_None);
540 }
Guido van Rossum758eec01998-01-19 21:58:26 +0000541
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000542 /* Finally, clear and delete the modules directory */
543 PyDict_Clear(modules);
544 interp->modules = NULL;
545 Py_DECREF(modules);
546 Py_CLEAR(interp->modules_reloading);
Guido van Rossum8d15b5d1990-10-26 14:58:58 +0000547}
Guido van Rossum7f133ed1991-02-19 12:23:57 +0000548
549
Barry Warsaw28a691b2010-04-17 00:19:56 +0000550/* Helper for pythonrun.c -- return magic number and tag. */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000551
552long
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000553PyImport_GetMagicNumber(void)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000554{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000555 return pyc_magic;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000556}
557
558
Barry Warsaw28a691b2010-04-17 00:19:56 +0000559const char *
560PyImport_GetMagicTag(void)
561{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000562 return pyc_tag;
Barry Warsaw28a691b2010-04-17 00:19:56 +0000563}
564
Guido van Rossum25ce5661997-08-02 03:10:38 +0000565/* Magic for extension modules (built-in as well as dynamically
566 loaded). To prevent initializing an extension module more than
567 once, we keep a static dictionary 'extensions' keyed by module name
568 (for built-in modules) or by filename (for dynamically loaded
Barry Warsaw92883382001-08-13 23:05:44 +0000569 modules), containing these modules. A copy of the module's
Victor Stinner95872862011-03-07 18:20:56 +0100570 dictionary is stored by calling _PyImport_FixupExtensionObject()
Guido van Rossum25ce5661997-08-02 03:10:38 +0000571 immediately after the module initialization function succeeds. A
572 copy can be retrieved from there by calling
Victor Stinner95872862011-03-07 18:20:56 +0100573 _PyImport_FindExtensionObject().
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000574
Barry Warsaw7c9627b2010-06-17 18:38:20 +0000575 Modules which do support multiple initialization set their m_size
576 field to a non-negative number (indicating the size of the
577 module-specific state). They are still recorded in the extensions
578 dictionary, to avoid loading shared libraries twice.
Martin v. Löwis1a214512008-06-11 05:26:20 +0000579*/
580
581int
Victor Stinner95872862011-03-07 18:20:56 +0100582_PyImport_FixupExtensionObject(PyObject *mod, PyObject *name,
583 PyObject *filename)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000584{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000585 PyObject *modules, *dict;
586 struct PyModuleDef *def;
587 if (extensions == NULL) {
588 extensions = PyDict_New();
589 if (extensions == NULL)
590 return -1;
591 }
592 if (mod == NULL || !PyModule_Check(mod)) {
593 PyErr_BadInternalCall();
594 return -1;
595 }
596 def = PyModule_GetDef(mod);
597 if (!def) {
598 PyErr_BadInternalCall();
599 return -1;
600 }
601 modules = PyImport_GetModuleDict();
Victor Stinner95872862011-03-07 18:20:56 +0100602 if (PyDict_SetItem(modules, name, mod) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000603 return -1;
604 if (_PyState_AddModule(mod, def) < 0) {
Victor Stinner95872862011-03-07 18:20:56 +0100605 PyDict_DelItem(modules, name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000606 return -1;
607 }
608 if (def->m_size == -1) {
609 if (def->m_base.m_copy) {
610 /* Somebody already imported the module,
611 likely under a different name.
612 XXX this should really not happen. */
613 Py_DECREF(def->m_base.m_copy);
614 def->m_base.m_copy = NULL;
615 }
616 dict = PyModule_GetDict(mod);
617 if (dict == NULL)
618 return -1;
619 def->m_base.m_copy = PyDict_Copy(dict);
620 if (def->m_base.m_copy == NULL)
621 return -1;
622 }
Victor Stinner49d3f252010-10-17 01:24:53 +0000623 PyDict_SetItem(extensions, filename, (PyObject*)def);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000624 return 0;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000625}
626
Victor Stinner49d3f252010-10-17 01:24:53 +0000627int
628_PyImport_FixupBuiltin(PyObject *mod, char *name)
629{
630 int res;
Victor Stinner95872862011-03-07 18:20:56 +0100631 PyObject *nameobj;
Victor Stinner21fcd0c2011-03-07 18:28:15 +0100632 nameobj = PyUnicode_InternFromString(name);
Victor Stinner95872862011-03-07 18:20:56 +0100633 if (nameobj == NULL)
Victor Stinner49d3f252010-10-17 01:24:53 +0000634 return -1;
Victor Stinner95872862011-03-07 18:20:56 +0100635 res = _PyImport_FixupExtensionObject(mod, nameobj, nameobj);
636 Py_DECREF(nameobj);
Victor Stinner49d3f252010-10-17 01:24:53 +0000637 return res;
638}
639
Guido van Rossum25ce5661997-08-02 03:10:38 +0000640PyObject *
Victor Stinner95872862011-03-07 18:20:56 +0100641_PyImport_FindExtensionObject(PyObject *name, PyObject *filename)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000642{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000643 PyObject *mod, *mdict;
644 PyModuleDef* def;
645 if (extensions == NULL)
646 return NULL;
Victor Stinner49d3f252010-10-17 01:24:53 +0000647 def = (PyModuleDef*)PyDict_GetItem(extensions, filename);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000648 if (def == NULL)
649 return NULL;
650 if (def->m_size == -1) {
651 /* Module does not support repeated initialization */
652 if (def->m_base.m_copy == NULL)
653 return NULL;
Victor Stinner95872862011-03-07 18:20:56 +0100654 mod = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000655 if (mod == NULL)
656 return NULL;
657 mdict = PyModule_GetDict(mod);
658 if (mdict == NULL)
659 return NULL;
660 if (PyDict_Update(mdict, def->m_base.m_copy))
661 return NULL;
662 }
663 else {
664 if (def->m_base.m_init == NULL)
665 return NULL;
666 mod = def->m_base.m_init();
667 if (mod == NULL)
668 return NULL;
Victor Stinner95872862011-03-07 18:20:56 +0100669 PyDict_SetItem(PyImport_GetModuleDict(), name, mod);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000670 Py_DECREF(mod);
671 }
672 if (_PyState_AddModule(mod, def) < 0) {
Victor Stinner95872862011-03-07 18:20:56 +0100673 PyDict_DelItem(PyImport_GetModuleDict(), name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000674 Py_DECREF(mod);
675 return NULL;
676 }
677 if (Py_VerboseFlag)
Victor Stinner95872862011-03-07 18:20:56 +0100678 PySys_FormatStderr("import %U # previously loaded (%R)\n",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000679 name, filename);
680 return mod;
Brett Cannon9a5b25a2010-03-01 02:09:17 +0000681
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000682}
683
Victor Stinner49d3f252010-10-17 01:24:53 +0000684PyObject *
Victor Stinner501c09a2011-02-23 00:02:00 +0000685_PyImport_FindBuiltin(const char *name)
Victor Stinner49d3f252010-10-17 01:24:53 +0000686{
Victor Stinner95872862011-03-07 18:20:56 +0100687 PyObject *res, *nameobj;
Victor Stinner21fcd0c2011-03-07 18:28:15 +0100688 nameobj = PyUnicode_InternFromString(name);
Victor Stinner95872862011-03-07 18:20:56 +0100689 if (nameobj == NULL)
Victor Stinner49d3f252010-10-17 01:24:53 +0000690 return NULL;
Victor Stinner95872862011-03-07 18:20:56 +0100691 res = _PyImport_FindExtensionObject(nameobj, nameobj);
692 Py_DECREF(nameobj);
Victor Stinner49d3f252010-10-17 01:24:53 +0000693 return res;
694}
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000695
696/* Get the module object corresponding to a module name.
697 First check the modules dictionary if there's one there,
Walter Dörwaldf0dfc7a2003-10-20 14:01:56 +0000698 if not, create a new one and insert it in the modules dictionary.
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000699 Because the former action is most common, THIS DOES NOT RETURN A
700 'NEW' REFERENCE! */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000701
Guido van Rossum79f25d91997-04-29 20:08:16 +0000702PyObject *
Victor Stinner27ee0892011-03-04 12:57:09 +0000703PyImport_AddModuleObject(PyObject *name)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000704{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000705 PyObject *modules = PyImport_GetModuleDict();
706 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000707
Victor Stinner27ee0892011-03-04 12:57:09 +0000708 if ((m = PyDict_GetItem(modules, name)) != NULL &&
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000709 PyModule_Check(m))
710 return m;
Victor Stinner27ee0892011-03-04 12:57:09 +0000711 m = PyModule_NewObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000712 if (m == NULL)
713 return NULL;
Victor Stinner27ee0892011-03-04 12:57:09 +0000714 if (PyDict_SetItem(modules, name, m) != 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000715 Py_DECREF(m);
716 return NULL;
717 }
718 Py_DECREF(m); /* Yes, it still exists, in modules! */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000719
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000720 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000721}
722
Victor Stinner27ee0892011-03-04 12:57:09 +0000723PyObject *
724PyImport_AddModule(const char *name)
725{
726 PyObject *nameobj, *module;
727 nameobj = PyUnicode_FromString(name);
728 if (nameobj == NULL)
729 return NULL;
730 module = PyImport_AddModuleObject(nameobj);
731 Py_DECREF(nameobj);
732 return module;
733}
734
735
Tim Peters1cd70172004-08-02 03:52:12 +0000736/* Remove name from sys.modules, if it's there. */
737static void
Victor Stinner27ee0892011-03-04 12:57:09 +0000738remove_module(PyObject *name)
Tim Peters1cd70172004-08-02 03:52:12 +0000739{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000740 PyObject *modules = PyImport_GetModuleDict();
Victor Stinner27ee0892011-03-04 12:57:09 +0000741 if (PyDict_GetItem(modules, name) == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000742 return;
Victor Stinner27ee0892011-03-04 12:57:09 +0000743 if (PyDict_DelItem(modules, name) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000744 Py_FatalError("import: deleting existing key in"
745 "sys.modules failed");
Tim Peters1cd70172004-08-02 03:52:12 +0000746}
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000747
Victor Stinnerc9abda02011-03-14 13:33:46 -0400748static PyObject * get_sourcefile(PyObject *filename);
749static PyObject *make_source_pathname(PyObject *pathname);
Victor Stinner2f42ae52011-03-20 00:41:24 +0100750static PyObject* make_compiled_pathname(Py_UNICODE *pathname, int debug);
Christian Heimes3b06e532008-01-07 20:12:44 +0000751
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000752/* Execute a code object in a module and return the module object
Tim Peters1cd70172004-08-02 03:52:12 +0000753 * WITH INCREMENTED REFERENCE COUNT. If an error occurs, name is
754 * removed from sys.modules, to avoid leaving damaged module objects
755 * in sys.modules. The caller may wish to restore the original
756 * module object (if any) in this case; PyImport_ReloadModule is an
757 * example.
Barry Warsaw28a691b2010-04-17 00:19:56 +0000758 *
759 * Note that PyImport_ExecCodeModuleWithPathnames() is the preferred, richer
760 * interface. The other two exist primarily for backward compatibility.
Tim Peters1cd70172004-08-02 03:52:12 +0000761 */
Guido van Rossum79f25d91997-04-29 20:08:16 +0000762PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000763PyImport_ExecCodeModule(char *name, PyObject *co)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000764{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000765 return PyImport_ExecCodeModuleWithPathnames(
766 name, co, (char *)NULL, (char *)NULL);
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000767}
768
769PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000770PyImport_ExecCodeModuleEx(char *name, PyObject *co, char *pathname)
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000771{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000772 return PyImport_ExecCodeModuleWithPathnames(
773 name, co, pathname, (char *)NULL);
Barry Warsaw28a691b2010-04-17 00:19:56 +0000774}
775
776PyObject *
777PyImport_ExecCodeModuleWithPathnames(char *name, PyObject *co, char *pathname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000778 char *cpathname)
Barry Warsaw28a691b2010-04-17 00:19:56 +0000779{
Victor Stinner27ee0892011-03-04 12:57:09 +0000780 PyObject *m = NULL;
781 PyObject *nameobj, *pathobj = NULL, *cpathobj = NULL;
782
783 nameobj = PyUnicode_FromString(name);
784 if (nameobj == NULL)
785 return NULL;
786
787 if (pathname != NULL) {
788 pathobj = PyUnicode_DecodeFSDefault(pathname);
789 if (pathobj == NULL)
790 goto error;
791 } else
792 pathobj = NULL;
793 if (cpathname != NULL) {
794 cpathobj = PyUnicode_DecodeFSDefault(cpathname);
795 if (cpathobj == NULL)
796 goto error;
797 } else
798 cpathobj = NULL;
799 m = PyImport_ExecCodeModuleObject(nameobj, co, pathobj, cpathobj);
800error:
801 Py_DECREF(nameobj);
802 Py_XDECREF(pathobj);
803 Py_XDECREF(cpathobj);
804 return m;
805}
806
807PyObject*
808PyImport_ExecCodeModuleObject(PyObject *name, PyObject *co, PyObject *pathname,
809 PyObject *cpathname)
810{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000811 PyObject *modules = PyImport_GetModuleDict();
812 PyObject *m, *d, *v;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000813
Victor Stinner27ee0892011-03-04 12:57:09 +0000814 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000815 if (m == NULL)
816 return NULL;
817 /* If the module is being reloaded, we get the old module back
818 and re-use its dict to exec the new code. */
819 d = PyModule_GetDict(m);
820 if (PyDict_GetItemString(d, "__builtins__") == NULL) {
821 if (PyDict_SetItemString(d, "__builtins__",
822 PyEval_GetBuiltins()) != 0)
823 goto error;
824 }
825 /* Remember the filename as the __file__ attribute */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000826 if (pathname != NULL) {
Victor Stinnerc9abda02011-03-14 13:33:46 -0400827 v = get_sourcefile(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000828 if (v == NULL)
829 PyErr_Clear();
830 }
Victor Stinner27ee0892011-03-04 12:57:09 +0000831 else
832 v = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000833 if (v == NULL) {
834 v = ((PyCodeObject *)co)->co_filename;
835 Py_INCREF(v);
836 }
837 if (PyDict_SetItemString(d, "__file__", v) != 0)
838 PyErr_Clear(); /* Not important enough to report */
839 Py_DECREF(v);
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000840
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000841 /* Remember the pyc path name as the __cached__ attribute. */
Victor Stinner27ee0892011-03-04 12:57:09 +0000842 if (cpathname != NULL)
843 v = cpathname;
844 else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000845 v = Py_None;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000846 if (PyDict_SetItemString(d, "__cached__", v) != 0)
847 PyErr_Clear(); /* Not important enough to report */
Barry Warsaw28a691b2010-04-17 00:19:56 +0000848
Martin v. Löwis4d0d4712010-12-03 20:14:31 +0000849 v = PyEval_EvalCode(co, d, d);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000850 if (v == NULL)
851 goto error;
852 Py_DECREF(v);
Guido van Rossumb65e85c1997-07-10 18:00:45 +0000853
Victor Stinner27ee0892011-03-04 12:57:09 +0000854 if ((m = PyDict_GetItem(modules, name)) == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000855 PyErr_Format(PyExc_ImportError,
Victor Stinner27ee0892011-03-04 12:57:09 +0000856 "Loaded module %R not found in sys.modules",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000857 name);
858 return NULL;
859 }
Guido van Rossumb65e85c1997-07-10 18:00:45 +0000860
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000861 Py_INCREF(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000862
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000863 return m;
Tim Peters1cd70172004-08-02 03:52:12 +0000864
865 error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000866 remove_module(name);
867 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000868}
869
870
Barry Warsaw28a691b2010-04-17 00:19:56 +0000871/* Like strrchr(string, '/') but searches for the rightmost of either SEP
872 or ALTSEP, if the latter is defined.
873*/
Victor Stinnerc9abda02011-03-14 13:33:46 -0400874static Py_UNICODE*
Victor Stinner2f42ae52011-03-20 00:41:24 +0100875rightmost_sep(Py_UNICODE *s)
Victor Stinnerc9abda02011-03-14 13:33:46 -0400876{
877 Py_UNICODE *found, c;
878 for (found = NULL; (c = *s); s++) {
879 if (c == SEP
880#ifdef ALTSEP
881 || c == ALTSEP
882#endif
883 )
884 {
885 found = s;
886 }
887 }
888 return found;
889}
890
891
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000892/* Given a pathname for a Python source file, fill a buffer with the
893 pathname for the corresponding compiled file. Return the pathname
894 for the compiled file, or NULL if there's no space in the buffer.
Victor Stinner2f42ae52011-03-20 00:41:24 +0100895 Doesn't set an exception.
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000896
Victor Stinner2f42ae52011-03-20 00:41:24 +0100897 foo.py -> __pycache__/foo.<tag>.pyc */
898
899static PyObject*
900make_compiled_pathname(Py_UNICODE *pathname, int debug)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000901{
Victor Stinner2f42ae52011-03-20 00:41:24 +0100902 Py_UNICODE buf[MAXPATHLEN];
903 size_t buflen = (size_t)MAXPATHLEN;
904 size_t len = Py_UNICODE_strlen(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000905 size_t i, save;
Victor Stinner2f42ae52011-03-20 00:41:24 +0100906 Py_UNICODE *pos;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000907 int sep = SEP;
Barry Warsaw28a691b2010-04-17 00:19:56 +0000908
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000909 /* Sanity check that the buffer has roughly enough space to hold what
910 will eventually be the full path to the compiled file. The 5 extra
911 bytes include the slash afer __pycache__, the two extra dots, the
912 extra trailing character ('c' or 'o') and null. This isn't exact
913 because the contents of the buffer can affect how many actual
914 characters of the string get into the buffer. We'll do a final
915 sanity check before writing the extension to ensure we do not
916 overflow the buffer.
917 */
Victor Stinner2f42ae52011-03-20 00:41:24 +0100918 if (len + Py_UNICODE_strlen(CACHEDIR_UNICODE) + Py_UNICODE_strlen(PYC_TAG_UNICODE) + 5 > buflen)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000919 return NULL;
Tim Petersc1731372001-08-04 08:12:36 +0000920
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000921 /* Find the last path separator and copy everything from the start of
922 the source string up to and including the separator.
923 */
Victor Stinner2f42ae52011-03-20 00:41:24 +0100924 pos = rightmost_sep(pathname);
925 if (pos == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000926 i = 0;
927 }
928 else {
929 sep = *pos;
930 i = pos - pathname + 1;
Victor Stinner2f42ae52011-03-20 00:41:24 +0100931 Py_UNICODE_strncpy(buf, pathname, i);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000932 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000933
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000934 save = i;
935 buf[i++] = '\0';
936 /* Add __pycache__/ */
Victor Stinner2f42ae52011-03-20 00:41:24 +0100937 Py_UNICODE_strcat(buf, CACHEDIR_UNICODE);
938 i += Py_UNICODE_strlen(CACHEDIR_UNICODE) - 1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000939 buf[i++] = sep;
940 buf[i++] = '\0';
941 /* Add the base filename, but remove the .py or .pyw extension, since
942 the tag name must go before the extension.
943 */
Victor Stinner2f42ae52011-03-20 00:41:24 +0100944 Py_UNICODE_strcat(buf, pathname + save);
945 pos = Py_UNICODE_strrchr(buf, '.');
946 if (pos != NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000947 *++pos = '\0';
Victor Stinner2f42ae52011-03-20 00:41:24 +0100948 Py_UNICODE_strcat(buf, PYC_TAG_UNICODE);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000949 /* The length test above assumes that we're only adding one character
950 to the end of what would normally be the extension. What if there
951 is no extension, or the string ends in '.' or '.p', and otherwise
952 fills the buffer? By appending 4 more characters onto the string
953 here, we could overrun the buffer.
Barry Warsaw28a691b2010-04-17 00:19:56 +0000954
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000955 As a simple example, let's say buflen=32 and the input string is
956 'xxx.py'. strlen() would be 6 and the test above would yield:
Barry Warsaw28a691b2010-04-17 00:19:56 +0000957
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000958 (6 + 11 + 10 + 5 == 32) > 32
Barry Warsaw28a691b2010-04-17 00:19:56 +0000959
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000960 which is false and so the name mangling would continue. This would
961 be fine because we'd end up with this string in buf:
Barry Warsaw28a691b2010-04-17 00:19:56 +0000962
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000963 __pycache__/xxx.cpython-32.pyc\0
Barry Warsaw28a691b2010-04-17 00:19:56 +0000964
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000965 strlen(of that) == 30 + the nul fits inside a 32 character buffer.
966 We can even handle an input string of say 'xxxxx' above because
967 that's (5 + 11 + 10 + 5 == 31) > 32 which is also false. Name
968 mangling that yields:
Barry Warsaw28a691b2010-04-17 00:19:56 +0000969
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000970 __pycache__/xxxxxcpython-32.pyc\0
Barry Warsaw28a691b2010-04-17 00:19:56 +0000971
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000972 which is 32 characters including the nul, and thus fits in the
973 buffer. However, an input string of 'xxxxxx' would yield a result
974 string of:
Barry Warsaw28a691b2010-04-17 00:19:56 +0000975
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000976 __pycache__/xxxxxxcpython-32.pyc\0
Barry Warsaw28a691b2010-04-17 00:19:56 +0000977
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000978 which is 33 characters long (including the nul), thus overflowing
979 the buffer, even though the first test would fail, i.e.: the input
980 string is also 6 characters long, so 32 > 32 is false.
Barry Warsaw28a691b2010-04-17 00:19:56 +0000981
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000982 The reason the first test fails but we still overflow the buffer is
983 that the test above only expects to add one extra character to be
984 added to the extension, and here we're adding three (pyc). We
985 don't add the first dot, so that reclaims one of expected
986 positions, leaving us overflowing by 1 byte (3 extra - 1 reclaimed
987 dot - 1 expected extra == 1 overflowed).
Barry Warsaw28a691b2010-04-17 00:19:56 +0000988
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000989 The best we can do is ensure that we still have enough room in the
990 target buffer before we write the extension. Because it's always
991 only the extension that can cause the overflow, and never the other
992 path bytes we've written, it's sufficient to just do one more test
993 here. Still, the assertion that follows can't hurt.
994 */
Barry Warsaw28a691b2010-04-17 00:19:56 +0000995#if 0
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000996 printf("strlen(buf): %d; buflen: %d\n", (int)strlen(buf), (int)buflen);
Barry Warsaw28a691b2010-04-17 00:19:56 +0000997#endif
Victor Stinner2f42ae52011-03-20 00:41:24 +0100998 len = Py_UNICODE_strlen(buf);
999 if (len + 5 > buflen)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001000 return NULL;
Victor Stinner2f42ae52011-03-20 00:41:24 +01001001 buf[len] = '.'; len++;
1002 buf[len] = 'p'; len++;
1003 buf[len] = 'y'; len++;
1004 buf[len] = debug ? 'c' : 'o'; len++;
1005 assert(len <= buflen);
1006 return PyUnicode_FromUnicode(buf, len);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001007}
1008
1009
Barry Warsaw28a691b2010-04-17 00:19:56 +00001010/* Given a pathname to a Python byte compiled file, return the path to the
1011 source file, if the path matches the PEP 3147 format. This does not check
1012 for any file existence, however, if the pyc file name does not match PEP
1013 3147 style, NULL is returned. buf must be at least as big as pathname;
Victor Stinnerc9abda02011-03-14 13:33:46 -04001014 the resulting path will always be shorter.
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001015
Victor Stinnerc9abda02011-03-14 13:33:46 -04001016 (...)/__pycache__/foo.<tag>.pyc -> (...)/foo.py */
1017
1018static PyObject*
1019make_source_pathname(PyObject *pathobj)
Barry Warsaw28a691b2010-04-17 00:19:56 +00001020{
Victor Stinnerc9abda02011-03-14 13:33:46 -04001021 Py_UNICODE buf[MAXPATHLEN];
1022 Py_UNICODE *pathname;
1023 Py_UNICODE *left, *right, *dot0, *dot1, sep;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001024 size_t i, j;
Victor Stinnerc9abda02011-03-14 13:33:46 -04001025
1026 if (PyUnicode_GET_SIZE(pathobj) > MAXPATHLEN)
1027 return NULL;
1028 pathname = PyUnicode_AS_UNICODE(pathobj);
Barry Warsaw28a691b2010-04-17 00:19:56 +00001029
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001030 /* Look back two slashes from the end. In between these two slashes
1031 must be the string __pycache__ or this is not a PEP 3147 style
1032 path. It's possible for there to be only one slash.
1033 */
Victor Stinner2f42ae52011-03-20 00:41:24 +01001034 right = rightmost_sep(pathname);
Victor Stinnerc9abda02011-03-14 13:33:46 -04001035 if (right == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001036 return NULL;
1037 sep = *right;
1038 *right = '\0';
Victor Stinner2f42ae52011-03-20 00:41:24 +01001039 left = rightmost_sep(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001040 *right = sep;
1041 if (left == NULL)
1042 left = pathname;
1043 else
1044 left++;
Victor Stinnerc9abda02011-03-14 13:33:46 -04001045 if (right-left != Py_UNICODE_strlen(CACHEDIR_UNICODE) ||
1046 Py_UNICODE_strncmp(left, CACHEDIR_UNICODE, right-left) != 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001047 return NULL;
Barry Warsaw28a691b2010-04-17 00:19:56 +00001048
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001049 /* Now verify that the path component to the right of the last slash
1050 has two dots in it.
1051 */
Victor Stinnerc9abda02011-03-14 13:33:46 -04001052 if ((dot0 = Py_UNICODE_strchr(right + 1, '.')) == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001053 return NULL;
Victor Stinnerc9abda02011-03-14 13:33:46 -04001054 if ((dot1 = Py_UNICODE_strchr(dot0 + 1, '.')) == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001055 return NULL;
1056 /* Too many dots? */
Victor Stinnerc9abda02011-03-14 13:33:46 -04001057 if (Py_UNICODE_strchr(dot1 + 1, '.') != NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001058 return NULL;
Barry Warsaw28a691b2010-04-17 00:19:56 +00001059
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001060 /* This is a PEP 3147 path. Start by copying everything from the
1061 start of pathname up to and including the leftmost slash. Then
1062 copy the file's basename, removing the magic tag and adding a .py
1063 suffix.
1064 */
Victor Stinnerc9abda02011-03-14 13:33:46 -04001065 Py_UNICODE_strncpy(buf, pathname, (i=left-pathname));
1066 Py_UNICODE_strncpy(buf+i, right+1, (j=dot0-right));
1067 buf[i+j] = 'p';
1068 buf[i+j+1] = 'y';
1069 return PyUnicode_FromUnicode(buf, i+j+2);
Barry Warsaw28a691b2010-04-17 00:19:56 +00001070}
1071
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001072/* Given a pathname for a Python source file, its time of last
1073 modification, and a pathname for a compiled file, check whether the
1074 compiled file represents the same version of the source. If so,
1075 return a FILE pointer for the compiled file, positioned just after
1076 the header; if not, return NULL.
1077 Doesn't set an exception. */
1078
1079static FILE *
Victor Stinner2f42ae52011-03-20 00:41:24 +01001080check_compiled_module(PyObject *pathname, time_t mtime, PyObject *cpathname)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001081{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001082 FILE *fp;
1083 long magic;
1084 long pyc_mtime;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001085
Victor Stinner2f42ae52011-03-20 00:41:24 +01001086 fp = _Py_fopen(cpathname, "rb");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001087 if (fp == NULL)
1088 return NULL;
1089 magic = PyMarshal_ReadLongFromFile(fp);
1090 if (magic != pyc_magic) {
1091 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001092 PySys_FormatStderr("# %R has bad magic\n", cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001093 fclose(fp);
1094 return NULL;
1095 }
1096 pyc_mtime = PyMarshal_ReadLongFromFile(fp);
1097 if (pyc_mtime != mtime) {
1098 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001099 PySys_FormatStderr("# %R has bad mtime\n", cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001100 fclose(fp);
1101 return NULL;
1102 }
1103 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001104 PySys_FormatStderr("# %R matches %R\n", cpathname, pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001105 return fp;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001106}
1107
1108
1109/* Read a code object from a file and check it for validity */
1110
Guido van Rossum79f25d91997-04-29 20:08:16 +00001111static PyCodeObject *
Victor Stinner2f42ae52011-03-20 00:41:24 +01001112read_compiled_module(PyObject *cpathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001113{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001114 PyObject *co;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001115
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001116 co = PyMarshal_ReadLastObjectFromFile(fp);
1117 if (co == NULL)
1118 return NULL;
1119 if (!PyCode_Check(co)) {
1120 PyErr_Format(PyExc_ImportError,
Victor Stinner2f42ae52011-03-20 00:41:24 +01001121 "Non-code object in %R", cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001122 Py_DECREF(co);
1123 return NULL;
1124 }
1125 return (PyCodeObject *)co;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001126}
1127
1128
1129/* Load a module from a compiled file, execute it, and return its
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001130 module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001131
Guido van Rossum79f25d91997-04-29 20:08:16 +00001132static PyObject *
Victor Stinner2f42ae52011-03-20 00:41:24 +01001133load_compiled_module(PyObject *name, PyObject *cpathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001134{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001135 long magic;
1136 PyCodeObject *co;
1137 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001138
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001139 magic = PyMarshal_ReadLongFromFile(fp);
1140 if (magic != pyc_magic) {
1141 PyErr_Format(PyExc_ImportError,
Victor Stinner2f42ae52011-03-20 00:41:24 +01001142 "Bad magic number in %R", cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001143 return NULL;
1144 }
1145 (void) PyMarshal_ReadLongFromFile(fp);
1146 co = read_compiled_module(cpathname, fp);
1147 if (co == NULL)
1148 return NULL;
1149 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001150 PySys_FormatStderr("import %U # precompiled from %R\n",
1151 name, cpathname);
1152 m = PyImport_ExecCodeModuleObject(name, (PyObject *)co,
1153 cpathname, cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001154 Py_DECREF(co);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001155
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001156 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001157}
1158
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001159/* Parse a source file and return the corresponding code object */
1160
Guido van Rossum79f25d91997-04-29 20:08:16 +00001161static PyCodeObject *
Victor Stinner2f42ae52011-03-20 00:41:24 +01001162parse_source_module(PyObject *pathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001163{
Victor Stinner2f42ae52011-03-20 00:41:24 +01001164 PyCodeObject *co;
1165 PyObject *pathbytes;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001166 mod_ty mod;
1167 PyCompilerFlags flags;
Victor Stinner2f42ae52011-03-20 00:41:24 +01001168 PyArena *arena;
1169
1170 pathbytes = PyUnicode_EncodeFSDefault(pathname);
1171 if (pathbytes == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001172 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001173
Victor Stinner2f42ae52011-03-20 00:41:24 +01001174 arena = PyArena_New();
1175 if (arena == NULL) {
1176 Py_DECREF(pathbytes);
1177 return NULL;
1178 }
1179
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001180 flags.cf_flags = 0;
Victor Stinner2f42ae52011-03-20 00:41:24 +01001181 mod = PyParser_ASTFromFile(fp, PyBytes_AS_STRING(pathbytes), NULL,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001182 Py_file_input, 0, 0, &flags,
1183 NULL, arena);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001184 if (mod != NULL)
1185 co = PyAST_Compile(mod, PyBytes_AS_STRING(pathbytes), NULL, arena);
1186 else
1187 co = NULL;
1188 Py_DECREF(pathbytes);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001189 PyArena_Free(arena);
1190 return co;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001191}
1192
Guido van Rossum55a83382000-09-20 20:31:38 +00001193/* Helper to open a bytecode file for writing in exclusive mode */
1194
1195static FILE *
Christian Heimes05e8be12008-02-23 18:30:17 +00001196open_exclusive(char *filename, mode_t mode)
Guido van Rossum55a83382000-09-20 20:31:38 +00001197{
1198#if defined(O_EXCL)&&defined(O_CREAT)&&defined(O_WRONLY)&&defined(O_TRUNC)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001199 /* Use O_EXCL to avoid a race condition when another process tries to
1200 write the same file. When that happens, our open() call fails,
1201 which is just fine (since it's only a cache).
1202 XXX If the file exists and is writable but the directory is not
1203 writable, the file will never be written. Oh well.
1204 */
1205 int fd;
1206 (void) unlink(filename);
1207 fd = open(filename, O_EXCL|O_CREAT|O_WRONLY|O_TRUNC
Tim Peters42c83af2000-09-29 04:03:10 +00001208#ifdef O_BINARY
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001209 |O_BINARY /* necessary for Windows */
Tim Peters42c83af2000-09-29 04:03:10 +00001210#endif
Martin v. Löwis79acb9e2002-12-06 12:48:53 +00001211#ifdef __VMS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001212 , mode, "ctxt=bin", "shr=nil"
Martin v. Löwis79acb9e2002-12-06 12:48:53 +00001213#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001214 , mode
Martin v. Löwis79acb9e2002-12-06 12:48:53 +00001215#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001216 );
1217 if (fd < 0)
1218 return NULL;
1219 return fdopen(fd, "wb");
Guido van Rossum55a83382000-09-20 20:31:38 +00001220#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001221 /* Best we can do -- on Windows this can't happen anyway */
1222 return fopen(filename, "wb");
Guido van Rossum55a83382000-09-20 20:31:38 +00001223#endif
1224}
1225
1226
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001227/* Write a compiled module to a file, placing the time of last
1228 modification of its source into the header.
1229 Errors are ignored, if a write error occurs an attempt is made to
1230 remove the file. */
1231
1232static void
Victor Stinner2f42ae52011-03-20 00:41:24 +01001233write_compiled_module(PyCodeObject *co, PyObject *cpathname,
1234 struct stat *srcstat)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001235{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001236 FILE *fp;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001237 time_t mtime = srcstat->st_mtime;
Alexandre Vassalotti9d58e3e2009-07-17 10:55:50 +00001238#ifdef MS_WINDOWS /* since Windows uses different permissions */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001239 mode_t mode = srcstat->st_mode & ~S_IEXEC;
Alexandre Vassalotti9d58e3e2009-07-17 10:55:50 +00001240#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001241 mode_t mode = srcstat->st_mode & ~S_IXUSR & ~S_IXGRP & ~S_IXOTH;
1242 mode_t dirmode = (srcstat->st_mode |
1243 S_IXUSR | S_IXGRP | S_IXOTH |
1244 S_IWUSR | S_IWGRP | S_IWOTH);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001245 PyObject *dirbytes;
Brett Cannon9a5b25a2010-03-01 02:09:17 +00001246#endif
Victor Stinner2f42ae52011-03-20 00:41:24 +01001247 PyObject *cpathbytes, *dirname;
1248 Py_UNICODE *dirsep;
1249 int res, ok;
Barry Warsaw28a691b2010-04-17 00:19:56 +00001250
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001251 /* Ensure that the __pycache__ directory exists. */
Victor Stinner2f42ae52011-03-20 00:41:24 +01001252 dirsep = rightmost_sep(PyUnicode_AS_UNICODE(cpathname));
1253 if (dirsep == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001254 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001255 PySys_FormatStderr("# no %s path found %R\n", CACHEDIR, cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001256 return;
1257 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01001258 dirname = PyUnicode_FromUnicode(PyUnicode_AS_UNICODE(cpathname),
1259 dirsep - PyUnicode_AS_UNICODE(cpathname));
1260 if (dirname == NULL) {
1261 PyErr_Clear();
1262 return;
1263 }
Daniel Stutzbachc7937792010-09-09 21:18:04 +00001264
1265#ifdef MS_WINDOWS
Victor Stinner2f42ae52011-03-20 00:41:24 +01001266 res = CreateDirectoryW(PyUnicode_AS_UNICODE(dirname), NULL);
1267 ok = (res != 0);
1268 if (!ok && GetLastError() == ERROR_ALREADY_EXISTS)
1269 ok = 1;
Daniel Stutzbachc7937792010-09-09 21:18:04 +00001270#else
Victor Stinner2f42ae52011-03-20 00:41:24 +01001271 dirbytes = PyUnicode_EncodeFSDefault(dirname);
1272 if (dirbytes == NULL) {
1273 PyErr_Clear();
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001274 return;
1275 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01001276 res = mkdir(PyBytes_AS_STRING(dirbytes), dirmode);
1277 Py_DECREF(dirbytes);
1278 if (0 <= res)
1279 ok = 1;
1280 else
1281 ok = (errno == EEXIST);
1282#endif
1283 if (!ok) {
1284 if (Py_VerboseFlag)
1285 PySys_FormatStderr("# cannot create cache dir %R\n", dirname);
1286 Py_DECREF(dirname);
1287 return;
1288 }
1289 Py_DECREF(dirname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001290
Victor Stinner2f42ae52011-03-20 00:41:24 +01001291 cpathbytes = PyUnicode_EncodeFSDefault(cpathname);
1292 if (cpathbytes == NULL) {
1293 PyErr_Clear();
1294 return;
1295 }
1296
1297 fp = open_exclusive(PyBytes_AS_STRING(cpathbytes), mode);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001298 if (fp == NULL) {
1299 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001300 PySys_FormatStderr(
1301 "# can't create %R\n", cpathname);
1302 Py_DECREF(cpathbytes);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001303 return;
1304 }
1305 PyMarshal_WriteLongToFile(pyc_magic, fp, Py_MARSHAL_VERSION);
1306 /* First write a 0 for mtime */
1307 PyMarshal_WriteLongToFile(0L, fp, Py_MARSHAL_VERSION);
1308 PyMarshal_WriteObjectToFile((PyObject *)co, fp, Py_MARSHAL_VERSION);
1309 if (fflush(fp) != 0 || ferror(fp)) {
1310 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001311 PySys_FormatStderr("# can't write %R\n", cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001312 /* Don't keep partial file */
1313 fclose(fp);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001314#ifdef MS_WINDOWS
1315 (void)DeleteFileW(PyUnicode_AS_UNICODE(cpathname));
1316#else
1317 (void) unlink(PyBytes_AS_STRING(cpathbytes));
1318#endif
1319 Py_DECREF(cpathbytes);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001320 return;
1321 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01001322 Py_DECREF(cpathbytes);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001323 /* Now write the true mtime */
1324 fseek(fp, 4L, 0);
1325 assert(mtime < LONG_MAX);
1326 PyMarshal_WriteLongToFile((long)mtime, fp, Py_MARSHAL_VERSION);
1327 fflush(fp);
1328 fclose(fp);
1329 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001330 PySys_FormatStderr("# wrote %R\n", cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001331}
1332
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001333static void
1334update_code_filenames(PyCodeObject *co, PyObject *oldname, PyObject *newname)
1335{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001336 PyObject *constants, *tmp;
1337 Py_ssize_t i, n;
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001338
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001339 if (PyUnicode_Compare(co->co_filename, oldname))
1340 return;
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001341
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001342 tmp = co->co_filename;
1343 co->co_filename = newname;
1344 Py_INCREF(co->co_filename);
1345 Py_DECREF(tmp);
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001346
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001347 constants = co->co_consts;
1348 n = PyTuple_GET_SIZE(constants);
1349 for (i = 0; i < n; i++) {
1350 tmp = PyTuple_GET_ITEM(constants, i);
1351 if (PyCode_Check(tmp))
1352 update_code_filenames((PyCodeObject *)tmp,
1353 oldname, newname);
1354 }
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001355}
1356
Victor Stinner2f42ae52011-03-20 00:41:24 +01001357static void
1358update_compiled_module(PyCodeObject *co, PyObject *newname)
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001359{
Victor Stinner2f42ae52011-03-20 00:41:24 +01001360 PyObject *oldname;
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001361
Victor Stinner2f42ae52011-03-20 00:41:24 +01001362 if (PyUnicode_Compare(co->co_filename, newname) == 0)
1363 return;
Hirokazu Yamamoto4f447fb2009-03-04 01:52:10 +00001364
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001365 oldname = co->co_filename;
1366 Py_INCREF(oldname);
1367 update_code_filenames(co, oldname, newname);
1368 Py_DECREF(oldname);
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001369}
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001370
1371/* Load a source module from a given file and return its module
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001372 object WITH INCREMENTED REFERENCE COUNT. If there's a matching
1373 byte-compiled file, use that instead. */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001374
Guido van Rossum79f25d91997-04-29 20:08:16 +00001375static PyObject *
Victor Stinner2f42ae52011-03-20 00:41:24 +01001376load_source_module(PyObject *name, PyObject *pathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001377{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001378 struct stat st;
1379 FILE *fpc;
Victor Stinner2f42ae52011-03-20 00:41:24 +01001380 PyObject *cpathname = NULL, *cpathbytes = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001381 PyCodeObject *co;
Victor Stinner2f42ae52011-03-20 00:41:24 +01001382 PyObject *m = NULL;
Brett Cannon9a5b25a2010-03-01 02:09:17 +00001383
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001384 if (fstat(fileno(fp), &st) != 0) {
1385 PyErr_Format(PyExc_RuntimeError,
Victor Stinner2f42ae52011-03-20 00:41:24 +01001386 "unable to get file status from %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001387 pathname);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001388 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001389 }
Fred Drake4c82b232000-06-30 16:18:57 +00001390#if SIZEOF_TIME_T > 4
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001391 /* Python's .pyc timestamp handling presumes that the timestamp fits
1392 in 4 bytes. This will be fine until sometime in the year 2038,
1393 when a 4-byte signed time_t will overflow.
1394 */
1395 if (st.st_mtime >> 32) {
1396 PyErr_SetString(PyExc_OverflowError,
1397 "modification time overflows a 4 byte field");
Victor Stinner2f42ae52011-03-20 00:41:24 +01001398 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001399 }
Fred Drake4c82b232000-06-30 16:18:57 +00001400#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001401 cpathname = make_compiled_pathname(
Victor Stinner2f42ae52011-03-20 00:41:24 +01001402 PyUnicode_AS_UNICODE(pathname),
1403 !Py_OptimizeFlag);
1404
1405 if (cpathname != NULL)
1406 fpc = check_compiled_module(pathname, st.st_mtime, cpathname);
1407 else
1408 fpc = NULL;
1409
1410 if (fpc) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001411 co = read_compiled_module(cpathname, fpc);
1412 fclose(fpc);
1413 if (co == NULL)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001414 goto error;
1415 update_compiled_module(co, pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001416 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001417 PySys_FormatStderr("import %U # precompiled from %R\n",
1418 name, cpathname);
1419 m = PyImport_ExecCodeModuleObject(name, (PyObject *)co,
1420 cpathname, cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001421 }
1422 else {
1423 co = parse_source_module(pathname, fp);
1424 if (co == NULL)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001425 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001426 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001427 PySys_FormatStderr("import %U # from %R\n",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001428 name, pathname);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001429 if (cpathname != NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001430 PyObject *ro = PySys_GetObject("dont_write_bytecode");
1431 if (ro == NULL || !PyObject_IsTrue(ro))
1432 write_compiled_module(co, cpathname, &st);
1433 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01001434 m = PyImport_ExecCodeModuleObject(name, (PyObject *)co,
1435 pathname, cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001436 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001437 Py_DECREF(co);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001438
Victor Stinner2f42ae52011-03-20 00:41:24 +01001439error:
1440 Py_XDECREF(cpathbytes);
1441 Py_XDECREF(cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001442 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001443}
1444
Christian Heimes3b06e532008-01-07 20:12:44 +00001445/* Get source file -> unicode or None
1446 * Returns the path to the py file if available, else the given path
1447 */
1448static PyObject *
Victor Stinnerc9abda02011-03-14 13:33:46 -04001449get_sourcefile(PyObject *filename)
Christian Heimes3b06e532008-01-07 20:12:44 +00001450{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001451 Py_ssize_t len;
Victor Stinnerc9abda02011-03-14 13:33:46 -04001452 Py_UNICODE *fileuni;
1453 PyObject *py;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001454 struct stat statbuf;
Christian Heimes3b06e532008-01-07 20:12:44 +00001455
Victor Stinnerc9abda02011-03-14 13:33:46 -04001456 len = PyUnicode_GET_SIZE(filename);
1457 if (len == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001458 Py_RETURN_NONE;
Christian Heimes3b06e532008-01-07 20:12:44 +00001459
Victor Stinnerc9abda02011-03-14 13:33:46 -04001460 /* don't match *.pyc or *.pyo? */
1461 fileuni = PyUnicode_AS_UNICODE(filename);
1462 if (len < 5
1463 || fileuni[len-4] != '.'
1464 || (fileuni[len-3] != 'p' && fileuni[len-3] != 'P')
1465 || (fileuni[len-2] != 'y' && fileuni[len-2] != 'Y'))
1466 goto unchanged;
Christian Heimes3b06e532008-01-07 20:12:44 +00001467
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001468 /* Start by trying to turn PEP 3147 path into source path. If that
1469 * fails, just chop off the trailing character, i.e. legacy pyc path
1470 * to py.
1471 */
Victor Stinnerc9abda02011-03-14 13:33:46 -04001472 py = make_source_pathname(filename);
1473 if (py == NULL) {
1474 PyErr_Clear();
1475 py = PyUnicode_FromUnicode(fileuni, len - 1);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001476 }
Victor Stinnerc9abda02011-03-14 13:33:46 -04001477 if (py == NULL)
1478 goto error;
Barry Warsaw28a691b2010-04-17 00:19:56 +00001479
Victor Stinnerc9abda02011-03-14 13:33:46 -04001480 if (_Py_stat(py, &statbuf) == 0 && S_ISREG(statbuf.st_mode))
1481 return py;
1482 Py_DECREF(py);
1483 goto unchanged;
1484
1485error:
1486 PyErr_Clear();
1487unchanged:
1488 Py_INCREF(filename);
1489 return filename;
Christian Heimes3b06e532008-01-07 20:12:44 +00001490}
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001491
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001492/* Forward */
Victor Stinner41c5fec2011-03-13 21:46:30 -04001493static PyObject *load_module(PyObject *, FILE *, PyObject *, int, PyObject *);
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001494static struct filedescr *find_module(PyObject *, PyObject *, PyObject *,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001495 char *, size_t, FILE **, PyObject **);
Victor Stinner53dc7352011-03-20 01:50:21 +01001496static struct _frozen * find_frozen(PyObject *);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001497
1498/* Load a package and return its module object WITH INCREMENTED
1499 REFERENCE COUNT */
1500
1501static PyObject *
Victor Stinnerc9abda02011-03-14 13:33:46 -04001502load_package(PyObject *name, PyObject *pathname)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001503{
Victor Stinner41c5fec2011-03-13 21:46:30 -04001504 PyObject *m, *d, *bufobj;
Victor Stinnerc9abda02011-03-14 13:33:46 -04001505 PyObject *file = NULL, *path_list = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001506 int err;
1507 char buf[MAXPATHLEN+1];
Victor Stinnerc9abda02011-03-14 13:33:46 -04001508 FILE *fp = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001509 struct filedescr *fdp;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001510 static PyObject *initstr = NULL;
1511
1512 if (initstr == NULL) {
1513 initstr = PyUnicode_InternFromString("__init__");
1514 if (initstr == NULL)
1515 return NULL;
1516 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001517
Victor Stinnerc9abda02011-03-14 13:33:46 -04001518 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001519 if (m == NULL)
1520 return NULL;
1521 if (Py_VerboseFlag)
Victor Stinnerc9abda02011-03-14 13:33:46 -04001522 PySys_FormatStderr("import %U # directory %U\n",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001523 name, pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001524 file = get_sourcefile(pathname);
1525 if (file == NULL)
Victor Stinnerc9abda02011-03-14 13:33:46 -04001526 return NULL;
1527 path_list = Py_BuildValue("[O]", file);
1528 if (path_list == NULL) {
1529 Py_DECREF(file);
1530 return NULL;
1531 }
1532 d = PyModule_GetDict(m);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001533 err = PyDict_SetItemString(d, "__file__", file);
Victor Stinnerc9abda02011-03-14 13:33:46 -04001534 Py_DECREF(file);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001535 if (err == 0)
Victor Stinnerc9abda02011-03-14 13:33:46 -04001536 err = PyDict_SetItemString(d, "__path__", path_list);
1537 if (err != 0) {
1538 Py_DECREF(path_list);
1539 return NULL;
1540 }
Victor Stinner533d7832011-03-14 13:22:54 -04001541 fdp = find_module(name, initstr, path_list,
1542 buf, sizeof(buf), &fp, NULL);
Victor Stinnerc9abda02011-03-14 13:33:46 -04001543 Py_DECREF(path_list);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001544 if (fdp == NULL) {
1545 if (PyErr_ExceptionMatches(PyExc_ImportError)) {
1546 PyErr_Clear();
1547 Py_INCREF(m);
Victor Stinnerc9abda02011-03-14 13:33:46 -04001548 return m;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001549 }
1550 else
Victor Stinnerc9abda02011-03-14 13:33:46 -04001551 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001552 }
Victor Stinner41c5fec2011-03-13 21:46:30 -04001553 bufobj = PyUnicode_DecodeFSDefault(buf);
1554 if (bufobj != NULL) {
1555 m = load_module(name, fp, bufobj, fdp->type, NULL);
1556 Py_DECREF(bufobj);
1557 }
1558 else
1559 m = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001560 if (fp != NULL)
1561 fclose(fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001562 return m;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001563}
1564
1565
1566/* Helper to test for built-in module */
1567
1568static int
Victor Stinner95872862011-03-07 18:20:56 +01001569is_builtin(PyObject *name)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001570{
Victor Stinner95872862011-03-07 18:20:56 +01001571 int i, cmp;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001572 for (i = 0; PyImport_Inittab[i].name != NULL; i++) {
Victor Stinner95872862011-03-07 18:20:56 +01001573 cmp = PyUnicode_CompareWithASCIIString(name, PyImport_Inittab[i].name);
1574 if (cmp == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001575 if (PyImport_Inittab[i].initfunc == NULL)
1576 return -1;
1577 else
1578 return 1;
1579 }
1580 }
1581 return 0;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001582}
1583
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001584
Just van Rossum52e14d62002-12-30 22:08:05 +00001585/* Return an importer object for a sys.path/pkg.__path__ item 'p',
1586 possibly by fetching it from the path_importer_cache dict. If it
Thomas Wouters89f507f2006-12-13 04:49:30 +00001587 wasn't yet cached, traverse path_hooks until a hook is found
Just van Rossum52e14d62002-12-30 22:08:05 +00001588 that can handle the path item. Return None if no hook could;
1589 this tells our caller it should fall back to the builtin
1590 import mechanism. Cache the result in path_importer_cache.
1591 Returns a borrowed reference. */
1592
1593static PyObject *
1594get_path_importer(PyObject *path_importer_cache, PyObject *path_hooks,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001595 PyObject *p)
Just van Rossum52e14d62002-12-30 22:08:05 +00001596{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001597 PyObject *importer;
1598 Py_ssize_t j, nhooks;
Just van Rossum52e14d62002-12-30 22:08:05 +00001599
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001600 /* These conditions are the caller's responsibility: */
1601 assert(PyList_Check(path_hooks));
1602 assert(PyDict_Check(path_importer_cache));
Just van Rossum52e14d62002-12-30 22:08:05 +00001603
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001604 nhooks = PyList_Size(path_hooks);
1605 if (nhooks < 0)
1606 return NULL; /* Shouldn't happen */
Just van Rossum52e14d62002-12-30 22:08:05 +00001607
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001608 importer = PyDict_GetItem(path_importer_cache, p);
1609 if (importer != NULL)
1610 return importer;
Just van Rossum52e14d62002-12-30 22:08:05 +00001611
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001612 /* set path_importer_cache[p] to None to avoid recursion */
1613 if (PyDict_SetItem(path_importer_cache, p, Py_None) != 0)
1614 return NULL;
Just van Rossum52e14d62002-12-30 22:08:05 +00001615
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001616 for (j = 0; j < nhooks; j++) {
1617 PyObject *hook = PyList_GetItem(path_hooks, j);
1618 if (hook == NULL)
1619 return NULL;
1620 importer = PyObject_CallFunctionObjArgs(hook, p, NULL);
1621 if (importer != NULL)
1622 break;
Just van Rossum52e14d62002-12-30 22:08:05 +00001623
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001624 if (!PyErr_ExceptionMatches(PyExc_ImportError)) {
1625 return NULL;
1626 }
1627 PyErr_Clear();
1628 }
1629 if (importer == NULL) {
1630 importer = PyObject_CallFunctionObjArgs(
1631 (PyObject *)&PyNullImporter_Type, p, NULL
1632 );
1633 if (importer == NULL) {
1634 if (PyErr_ExceptionMatches(PyExc_ImportError)) {
1635 PyErr_Clear();
1636 return Py_None;
1637 }
1638 }
1639 }
1640 if (importer != NULL) {
1641 int err = PyDict_SetItem(path_importer_cache, p, importer);
1642 Py_DECREF(importer);
1643 if (err != 0)
1644 return NULL;
1645 }
1646 return importer;
Just van Rossum52e14d62002-12-30 22:08:05 +00001647}
1648
Christian Heimes9cd17752007-11-18 19:35:23 +00001649PyAPI_FUNC(PyObject *)
1650PyImport_GetImporter(PyObject *path) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001651 PyObject *importer=NULL, *path_importer_cache=NULL, *path_hooks=NULL;
Christian Heimes9cd17752007-11-18 19:35:23 +00001652
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001653 if ((path_importer_cache = PySys_GetObject("path_importer_cache"))) {
1654 if ((path_hooks = PySys_GetObject("path_hooks"))) {
1655 importer = get_path_importer(path_importer_cache,
1656 path_hooks, path);
1657 }
1658 }
1659 Py_XINCREF(importer); /* get_path_importer returns a borrowed reference */
1660 return importer;
Christian Heimes9cd17752007-11-18 19:35:23 +00001661}
1662
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001663/* Search the path (default sys.path) for a module. Return the
1664 corresponding filedescr struct, and (via return arguments) the
1665 pathname and an open file. Return NULL if the module is not found. */
1666
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001667#ifdef MS_COREDLL
Victor Stinner4d6c1c42011-03-08 23:49:04 +01001668extern FILE *_PyWin_FindRegisteredModule(PyObject *, struct filedescr **,
1669 PyObject **p_path);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001670#endif
1671
Victor Stinnerc6963162011-03-12 09:26:54 -05001672static int case_ok(char *, Py_ssize_t, Py_ssize_t, const char *);
Tim Petersdbd9ba62000-07-09 03:09:57 +00001673static int find_init_module(char *); /* Forward */
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 */
1768 S_ISDIR(statbuf.st_mode) && /* it's a directory */
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001769 case_ok(buf, len, namelen, namestr)) { /* case matches */
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001770 if (find_init_module(buf)) { /* and has __init__.py */
1771 *p_fd = &fd_package;
1772 return 2;
1773 }
1774 else {
1775 int err;
1776 PyObject *unicode = PyUnicode_DecodeFSDefault(buf);
1777 if (unicode == NULL)
1778 return -1;
1779 err = PyErr_WarnFormat(PyExc_ImportWarning, 1,
1780 "Not importing directory '%U': missing __init__.py",
1781 unicode);
1782 Py_DECREF(unicode);
1783 if (err)
1784 return -1;
1785 }
1786 }
1787#endif
1788 return 1;
1789}
1790
1791/* Find a module in search_path_list. For each path, try
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001792 find_module_path() or try each _PyImport_Filetab suffix.
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001793
1794 If the module is found, return a file descriptor, write the path in
1795 *p_filename, write the pointer to the file object into *p_fp, and (if
1796 p_loader is not NULL) the loader into *p_loader.
1797
1798 Otherwise, raise an exception and return NULL. */
1799
Victor Stinner37580282011-03-20 01:34:43 +01001800static struct filedescr*
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001801find_module_path_list(PyObject *fullname, PyObject *name,
Victor Stinner37580282011-03-20 01:34:43 +01001802 PyObject *search_path_list, PyObject *path_hooks,
1803 PyObject *path_importer_cache,
1804 char *buf, size_t buflen,
1805 FILE **p_fp, PyObject **p_loader)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001806{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001807 Py_ssize_t i, npath;
1808 size_t len, namelen;
1809 struct filedescr *fdp = NULL;
1810 char *filemode;
1811 FILE *fp = NULL;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001812 char *namestr;
Victor Stinner53dc7352011-03-20 01:50:21 +01001813
Victor Stinner37580282011-03-20 01:34:43 +01001814 npath = PyList_Size(search_path_list);
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001815 namestr = _PyUnicode_AsString(name);
1816 namelen = strlen(namestr);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001817 for (i = 0; i < npath; i++) {
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001818 PyObject *path;
1819 int ok;
1820
1821 path = PyList_GetItem(search_path_list, i);
1822 if (path == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001823 return NULL;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001824
1825 ok = find_module_path(fullname, name, path,
1826 path_hooks, path_importer_cache,
1827 buf, buflen,
1828 p_loader, &fdp);
1829 if (ok < 0)
1830 return NULL;
1831 if (ok == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001832 continue;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001833 if (ok == 2)
1834 return fdp;
Amaury Forgeot d'Arcf1ca0b12008-06-11 17:40:47 +00001835
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001836 len = strlen(buf);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001837 for (fdp = _PyImport_Filetab; fdp->suffix != NULL; fdp++) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001838 strcpy(buf+len, fdp->suffix);
1839 if (Py_VerboseFlag > 1)
1840 PySys_WriteStderr("# trying %s\n", buf);
1841 filemode = fdp->mode;
1842 if (filemode[0] == 'U')
1843 filemode = "r" PY_STDIOTEXTMODE;
1844 fp = fopen(buf, filemode);
1845 if (fp != NULL) {
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001846 if (case_ok(buf, len, namelen, namestr))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001847 break;
1848 else { /* continue search */
1849 fclose(fp);
1850 fp = NULL;
1851 }
1852 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001853 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001854 if (fp != NULL)
1855 break;
1856 }
1857 if (fp == NULL) {
1858 PyErr_Format(PyExc_ImportError,
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001859 "No module named %U", name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001860 return NULL;
1861 }
1862 *p_fp = fp;
1863 return fdp;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001864}
1865
Victor Stinner37580282011-03-20 01:34:43 +01001866/* Find a module:
1867
1868 - try find_module() of each sys.meta_path hook
1869 - try find_frozen()
1870 - try is_builtin()
1871 - try _PyWin_FindRegisteredModule() (Windows only)
1872 - otherwise, call find_module_path_list() with search_path_list (if not
1873 NULL) or sys.path
1874
1875 Return:
1876
1877 - &fd_builtin (C_BUILTIN) if it is a builtin
1878 - &fd_frozen (PY_FROZEN) if it is frozen
1879 - &fd_package (PKG_DIRECTORY) and write the filename into *buf
1880 if it is a package
1881 - &importhookdescr (IMP_HOOK) and write the loader into *p_loader if a
1882 importer loader was found
1883 - a file descriptor (PY_SOURCE, PY_COMPILED, C_EXTENSION, PY_RESOURCE or
1884 PY_CODERESOURCE: see _PyImport_Filetab), write the filename into
1885 *buf and the pointer to the open file into *p_fp
1886 - NULL on error
1887
1888 By default, write an empty string into *buf, and *p_fp and *p_loader (if
1889 set) are set to NULL. Eg. *buf is an empty string for a builtin package. */
1890
1891static struct filedescr *
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001892find_module(PyObject *fullname, PyObject *name, PyObject *search_path_list,
Victor Stinner37580282011-03-20 01:34:43 +01001893 char *buf, size_t buflen, FILE **p_fp, PyObject **p_loader)
1894{
1895 Py_ssize_t i, npath;
1896 static struct filedescr fd_frozen = {"", "", PY_FROZEN};
1897 static struct filedescr fd_builtin = {"", "", C_BUILTIN};
1898 PyObject *path_hooks, *path_importer_cache;
Victor Stinner37580282011-03-20 01:34:43 +01001899
1900 *buf = '\0';
1901 *p_fp = NULL;
1902 if (p_loader != NULL)
1903 *p_loader = NULL;
1904
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001905 if (PyUnicode_GET_SIZE(name) > MAXPATHLEN) {
Victor Stinner37580282011-03-20 01:34:43 +01001906 PyErr_SetString(PyExc_OverflowError,
1907 "module name is too long");
1908 return NULL;
1909 }
1910
1911 /* sys.meta_path import hook */
1912 if (p_loader != NULL) {
1913 PyObject *meta_path;
1914
1915 meta_path = PySys_GetObject("meta_path");
1916 if (meta_path == NULL || !PyList_Check(meta_path)) {
1917 PyErr_SetString(PyExc_ImportError,
1918 "sys.meta_path must be a list of "
1919 "import hooks");
1920 return NULL;
1921 }
1922 Py_INCREF(meta_path); /* zap guard */
1923 npath = PyList_Size(meta_path);
1924 for (i = 0; i < npath; i++) {
1925 PyObject *loader;
1926 PyObject *hook = PyList_GetItem(meta_path, i);
1927 loader = PyObject_CallMethod(hook, "find_module",
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001928 "OO", fullname,
Victor Stinner37580282011-03-20 01:34:43 +01001929 search_path_list != NULL ?
1930 search_path_list : Py_None);
1931 if (loader == NULL) {
1932 Py_DECREF(meta_path);
1933 return NULL; /* true error */
1934 }
1935 if (loader != Py_None) {
1936 /* a loader was found */
1937 *p_loader = loader;
1938 Py_DECREF(meta_path);
1939 return &importhookdescr;
1940 }
1941 Py_DECREF(loader);
1942 }
1943 Py_DECREF(meta_path);
1944 }
1945
Victor Stinnerdf75a022011-03-14 13:40:04 -04001946 if (find_frozen(fullname) != NULL)
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001947 return &fd_frozen;
Victor Stinner37580282011-03-20 01:34:43 +01001948
1949 if (search_path_list == NULL) {
1950#ifdef MS_COREDLL
1951 FILE *fp;
1952 struct filedescr *fdp;
1953 PyObject *filename, *filename_bytes;
1954#endif
Victor Stinnerdf75a022011-03-14 13:40:04 -04001955 if (is_builtin(name))
Victor Stinner37580282011-03-20 01:34:43 +01001956 return &fd_builtin;
Victor Stinner37580282011-03-20 01:34:43 +01001957#ifdef MS_COREDLL
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001958 fp = _PyWin_FindRegisteredModule(name, &fdp, &filename);
Victor Stinner37580282011-03-20 01:34:43 +01001959 if (fp != NULL) {
Victor Stinner37580282011-03-20 01:34:43 +01001960 filename_bytes = PyUnicode_EncodeFSDefault(filename);
1961 Py_DECREF(filename);
1962 if (filename_bytes == NULL)
1963 return NULL;
1964 strncpy(buf, PyBytes_AS_STRING(filename_bytes), buflen);
1965 buf[buflen-1] = '\0';
1966 Py_DECREF(filename_bytes);
1967 *p_fp = fp;
1968 return fdp;
1969 }
1970 else if (PyErr_Occurred())
1971 return NULL;
1972#endif
Victor Stinner37580282011-03-20 01:34:43 +01001973 search_path_list = PySys_GetObject("path");
1974 }
1975
1976 if (search_path_list == NULL || !PyList_Check(search_path_list)) {
1977 PyErr_SetString(PyExc_ImportError,
1978 "sys.path must be a list of directory names");
1979 return NULL;
1980 }
1981
1982 path_hooks = PySys_GetObject("path_hooks");
1983 if (path_hooks == NULL || !PyList_Check(path_hooks)) {
1984 PyErr_SetString(PyExc_ImportError,
1985 "sys.path_hooks must be a list of "
1986 "import hooks");
1987 return NULL;
1988 }
1989 path_importer_cache = PySys_GetObject("path_importer_cache");
1990 if (path_importer_cache == NULL ||
1991 !PyDict_Check(path_importer_cache)) {
1992 PyErr_SetString(PyExc_ImportError,
1993 "sys.path_importer_cache must be a dict");
1994 return NULL;
1995 }
1996
1997 return find_module_path_list(fullname, name,
1998 search_path_list, path_hooks,
1999 path_importer_cache,
2000 buf, buflen,
2001 p_fp, p_loader);
2002}
2003
Martin v. Löwis18e16552006-02-15 17:27:45 +00002004/* case_ok(char* buf, Py_ssize_t len, Py_ssize_t namelen, char* name)
Tim Petersd1e87a82001-03-01 18:12:00 +00002005 * The arguments here are tricky, best shown by example:
2006 * /a/b/c/d/e/f/g/h/i/j/k/some_long_module_name.py\0
2007 * ^ ^ ^ ^
2008 * |--------------------- buf ---------------------|
2009 * |------------------- len ------------------|
2010 * |------ name -------|
2011 * |----- namelen -----|
2012 * buf is the full path, but len only counts up to (& exclusive of) the
2013 * extension. name is the module name, also exclusive of extension.
2014 *
2015 * We've already done a successful stat() or fopen() on buf, so know that
2016 * there's some match, possibly case-insensitive.
2017 *
Tim Peters50d8d372001-02-28 05:34:27 +00002018 * case_ok() is to return 1 if there's a case-sensitive match for
2019 * name, else 0. case_ok() is also to return 1 if envar PYTHONCASEOK
2020 * exists.
Tim Petersd1e87a82001-03-01 18:12:00 +00002021 *
Tim Peters50d8d372001-02-28 05:34:27 +00002022 * case_ok() is used to implement case-sensitive import semantics even
2023 * on platforms with case-insensitive filesystems. It's trivial to implement
2024 * for case-sensitive filesystems. It's pretty much a cross-platform
2025 * nightmare for systems with case-insensitive filesystems.
2026 */
Guido van Rossum0980bd91998-02-13 17:18:36 +00002027
Tim Peters50d8d372001-02-28 05:34:27 +00002028/* First we may need a pile of platform-specific header files; the sequence
2029 * of #if's here should match the sequence in the body of case_ok().
2030 */
Jason Tishler7961aa62005-05-20 00:56:54 +00002031#if defined(MS_WINDOWS)
Guido van Rossum0980bd91998-02-13 17:18:36 +00002032#include <windows.h>
Guido van Rossum4c3f57c2001-01-10 20:40:46 +00002033
Tim Peters50d8d372001-02-28 05:34:27 +00002034#elif defined(DJGPP)
2035#include <dir.h>
2036
Jason Tishler7961aa62005-05-20 00:56:54 +00002037#elif (defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) && defined(HAVE_DIRENT_H)
Tim Peters430f5d42001-03-01 01:30:56 +00002038#include <sys/types.h>
2039#include <dirent.h>
2040
Andrew MacIntyred9400542002-02-26 11:41:34 +00002041#elif defined(PYOS_OS2)
2042#define INCL_DOS
2043#define INCL_DOSERRORS
2044#define INCL_NOPMAPI
2045#include <os2.h>
Tim Peters50d8d372001-02-28 05:34:27 +00002046#endif
2047
Guido van Rossum0980bd91998-02-13 17:18:36 +00002048static int
Victor Stinnerc6963162011-03-12 09:26:54 -05002049case_ok(char *buf, Py_ssize_t len, Py_ssize_t namelen, const char *name)
Guido van Rossum0980bd91998-02-13 17:18:36 +00002050{
Tim Peters50d8d372001-02-28 05:34:27 +00002051/* Pick a platform-specific implementation; the sequence of #if's here should
2052 * match the sequence just above.
2053 */
2054
Jason Tishler7961aa62005-05-20 00:56:54 +00002055/* MS_WINDOWS */
2056#if defined(MS_WINDOWS)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002057 WIN32_FIND_DATA data;
2058 HANDLE h;
Tim Peters50d8d372001-02-28 05:34:27 +00002059
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002060 if (Py_GETENV("PYTHONCASEOK") != NULL)
2061 return 1;
Tim Peters50d8d372001-02-28 05:34:27 +00002062
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002063 h = FindFirstFile(buf, &data);
2064 if (h == INVALID_HANDLE_VALUE) {
2065 PyErr_Format(PyExc_NameError,
2066 "Can't find file for module %.100s\n(filename %.300s)",
2067 name, buf);
2068 return 0;
2069 }
2070 FindClose(h);
2071 return strncmp(data.cFileName, name, namelen) == 0;
Tim Peters50d8d372001-02-28 05:34:27 +00002072
2073/* DJGPP */
2074#elif defined(DJGPP)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002075 struct ffblk ffblk;
2076 int done;
Tim Peters50d8d372001-02-28 05:34:27 +00002077
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002078 if (Py_GETENV("PYTHONCASEOK") != NULL)
2079 return 1;
Tim Peters50d8d372001-02-28 05:34:27 +00002080
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002081 done = findfirst(buf, &ffblk, FA_ARCH|FA_RDONLY|FA_HIDDEN|FA_DIREC);
2082 if (done) {
2083 PyErr_Format(PyExc_NameError,
2084 "Can't find file for module %.100s\n(filename %.300s)",
2085 name, buf);
2086 return 0;
2087 }
2088 return strncmp(ffblk.ff_name, name, namelen) == 0;
Guido van Rossum0980bd91998-02-13 17:18:36 +00002089
Jason Tishler7961aa62005-05-20 00:56:54 +00002090/* new-fangled macintosh (macosx) or Cygwin */
2091#elif (defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) && defined(HAVE_DIRENT_H)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002092 DIR *dirp;
2093 struct dirent *dp;
2094 char dirname[MAXPATHLEN + 1];
2095 const int dirlen = len - namelen - 1; /* don't want trailing SEP */
Tim Peters430f5d42001-03-01 01:30:56 +00002096
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002097 if (Py_GETENV("PYTHONCASEOK") != NULL)
2098 return 1;
Tim Petersdbe6ebb2001-03-01 08:47:29 +00002099
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002100 /* Copy the dir component into dirname; substitute "." if empty */
2101 if (dirlen <= 0) {
2102 dirname[0] = '.';
2103 dirname[1] = '\0';
2104 }
2105 else {
2106 assert(dirlen <= MAXPATHLEN);
2107 memcpy(dirname, buf, dirlen);
2108 dirname[dirlen] = '\0';
2109 }
2110 /* Open the directory and search the entries for an exact match. */
2111 dirp = opendir(dirname);
2112 if (dirp) {
2113 char *nameWithExt = buf + len - namelen;
2114 while ((dp = readdir(dirp)) != NULL) {
2115 const int thislen =
Tim Peters430f5d42001-03-01 01:30:56 +00002116#ifdef _DIRENT_HAVE_D_NAMELEN
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002117 dp->d_namlen;
Tim Peters430f5d42001-03-01 01:30:56 +00002118#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002119 strlen(dp->d_name);
Tim Peters430f5d42001-03-01 01:30:56 +00002120#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002121 if (thislen >= namelen &&
2122 strcmp(dp->d_name, nameWithExt) == 0) {
2123 (void)closedir(dirp);
2124 return 1; /* Found */
2125 }
2126 }
2127 (void)closedir(dirp);
2128 }
2129 return 0 ; /* Not found */
Tim Peters430f5d42001-03-01 01:30:56 +00002130
Andrew MacIntyred9400542002-02-26 11:41:34 +00002131/* OS/2 */
2132#elif defined(PYOS_OS2)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002133 HDIR hdir = 1;
2134 ULONG srchcnt = 1;
2135 FILEFINDBUF3 ffbuf;
2136 APIRET rc;
Andrew MacIntyred9400542002-02-26 11:41:34 +00002137
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002138 if (Py_GETENV("PYTHONCASEOK") != NULL)
2139 return 1;
Andrew MacIntyred9400542002-02-26 11:41:34 +00002140
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002141 rc = DosFindFirst(buf,
2142 &hdir,
2143 FILE_READONLY | FILE_HIDDEN | FILE_SYSTEM | FILE_DIRECTORY,
2144 &ffbuf, sizeof(ffbuf),
2145 &srchcnt,
2146 FIL_STANDARD);
2147 if (rc != NO_ERROR)
2148 return 0;
2149 return strncmp(ffbuf.achName, name, namelen) == 0;
Andrew MacIntyred9400542002-02-26 11:41:34 +00002150
Tim Peters50d8d372001-02-28 05:34:27 +00002151/* assuming it's a case-sensitive filesystem, so there's nothing to do! */
2152#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002153 return 1;
Guido van Rossum0980bd91998-02-13 17:18:36 +00002154
Guido van Rossum4d1b3b91998-02-13 23:27:59 +00002155#endif
Tim Peters50d8d372001-02-28 05:34:27 +00002156}
Guido van Rossum4d1b3b91998-02-13 23:27:59 +00002157
Guido van Rossum197346f1997-10-31 18:38:52 +00002158#ifdef HAVE_STAT
Victor Stinner4f4402c2010-08-14 14:50:26 +00002159
Guido van Rossum197346f1997-10-31 18:38:52 +00002160/* Helper to look for __init__.py or __init__.py[co] in potential package */
2161static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002162find_init_module(char *buf)
Guido van Rossum197346f1997-10-31 18:38:52 +00002163{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002164 const size_t save_len = strlen(buf);
2165 size_t i = save_len;
2166 char *pname; /* pointer to start of __init__ */
2167 struct stat statbuf;
Guido van Rossum197346f1997-10-31 18:38:52 +00002168
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002169/* For calling case_ok(buf, len, namelen, name):
2170 * /a/b/c/d/e/f/g/h/i/j/k/some_long_module_name.py\0
2171 * ^ ^ ^ ^
2172 * |--------------------- buf ---------------------|
2173 * |------------------- len ------------------|
2174 * |------ name -------|
2175 * |----- namelen -----|
Tim Peters0f9431f2001-07-05 03:47:53 +00002176 */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002177 if (save_len + 13 >= MAXPATHLEN)
2178 return 0;
2179 buf[i++] = SEP;
2180 pname = buf + i;
2181 strcpy(pname, "__init__.py");
2182 if (stat(buf, &statbuf) == 0) {
2183 if (case_ok(buf,
2184 save_len + 9, /* len("/__init__") */
2185 8, /* len("__init__") */
2186 pname)) {
2187 buf[save_len] = '\0';
2188 return 1;
2189 }
2190 }
2191 i += strlen(pname);
2192 strcpy(buf+i, Py_OptimizeFlag ? "o" : "c");
2193 if (stat(buf, &statbuf) == 0) {
2194 if (case_ok(buf,
2195 save_len + 9, /* len("/__init__") */
2196 8, /* len("__init__") */
2197 pname)) {
2198 buf[save_len] = '\0';
2199 return 1;
2200 }
2201 }
2202 buf[save_len] = '\0';
2203 return 0;
Guido van Rossum197346f1997-10-31 18:38:52 +00002204}
Guido van Rossum48a680c2001-03-02 06:34:14 +00002205
Guido van Rossum197346f1997-10-31 18:38:52 +00002206#endif /* HAVE_STAT */
2207
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002208
Victor Stinner95872862011-03-07 18:20:56 +01002209static int init_builtin(PyObject *); /* Forward */
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002210
Victor Stinner44c6c152010-08-09 00:59:10 +00002211static PyObject*
Victor Stinner95872862011-03-07 18:20:56 +01002212load_builtin(PyObject *name, int type)
Victor Stinner44c6c152010-08-09 00:59:10 +00002213{
2214 PyObject *m, *modules;
2215 int err;
2216
Victor Stinner44c6c152010-08-09 00:59:10 +00002217 if (type == C_BUILTIN)
2218 err = init_builtin(name);
2219 else
Victor Stinner95872862011-03-07 18:20:56 +01002220 err = PyImport_ImportFrozenModuleObject(name);
Victor Stinner44c6c152010-08-09 00:59:10 +00002221 if (err < 0)
2222 return NULL;
2223 if (err == 0) {
2224 PyErr_Format(PyExc_ImportError,
Victor Stinner95872862011-03-07 18:20:56 +01002225 "Purported %s module %R not found",
2226 type == C_BUILTIN ? "builtin" : "frozen",
Victor Stinner44c6c152010-08-09 00:59:10 +00002227 name);
2228 return NULL;
2229 }
2230
2231 modules = PyImport_GetModuleDict();
Victor Stinner95872862011-03-07 18:20:56 +01002232 m = PyDict_GetItem(modules, name);
Victor Stinner44c6c152010-08-09 00:59:10 +00002233 if (m == NULL) {
2234 PyErr_Format(
2235 PyExc_ImportError,
Victor Stinner95872862011-03-07 18:20:56 +01002236 "%s module %R not properly initialized",
2237 type == C_BUILTIN ? "builtin" : "frozen",
Victor Stinner44c6c152010-08-09 00:59:10 +00002238 name);
2239 return NULL;
2240 }
2241 Py_INCREF(m);
2242 return m;
2243}
2244
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002245/* Load an external module using the default search path and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00002246 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002247
Guido van Rossum79f25d91997-04-29 20:08:16 +00002248static PyObject *
Victor Stinner41c5fec2011-03-13 21:46:30 -04002249load_module(PyObject *name, FILE *fp, PyObject *pathname, int type, PyObject *loader)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002250{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002251 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002252
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002253 /* First check that there's an open file (if we need one) */
2254 switch (type) {
2255 case PY_SOURCE:
2256 case PY_COMPILED:
2257 if (fp == NULL) {
2258 PyErr_Format(PyExc_ValueError,
Victor Stinner41c5fec2011-03-13 21:46:30 -04002259 "file object required for import (type code %d)",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002260 type);
2261 return NULL;
2262 }
2263 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002264
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002265 switch (type) {
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002266
Victor Stinner41c5fec2011-03-13 21:46:30 -04002267 case PY_SOURCE:
2268 m = load_source_module(name, pathname, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002269 break;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002270
Victor Stinner41c5fec2011-03-13 21:46:30 -04002271 case PY_COMPILED:
2272 m = load_compiled_module(name, pathname, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002273 break;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002274
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002275#ifdef HAVE_DYNAMIC_LOADING
Victor Stinner41c5fec2011-03-13 21:46:30 -04002276 case C_EXTENSION:
2277 m = _PyImport_LoadDynamicModule(name, pathname, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002278 break;
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002279#endif
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002280
Victor Stinner41c5fec2011-03-13 21:46:30 -04002281 case PKG_DIRECTORY:
2282 m = load_package(name, pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002283 break;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002284
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002285 case C_BUILTIN:
Victor Stinner41c5fec2011-03-13 21:46:30 -04002286 case PY_FROZEN:
2287 m = load_builtin(name, type);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002288 break;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002289
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002290 case IMP_HOOK: {
2291 if (loader == NULL) {
2292 PyErr_SetString(PyExc_ImportError,
2293 "import hook without loader");
2294 return NULL;
2295 }
Victor Stinner41c5fec2011-03-13 21:46:30 -04002296 m = PyObject_CallMethod(loader, "load_module", "O", name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002297 break;
2298 }
Just van Rossum52e14d62002-12-30 22:08:05 +00002299
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002300 default:
2301 PyErr_Format(PyExc_ImportError,
Victor Stinner41c5fec2011-03-13 21:46:30 -04002302 "Don't know how to import %U (type code %d)",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002303 name, type);
2304 m = NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002305
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002306 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002307
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002308 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002309}
2310
2311
2312/* Initialize a built-in module.
Thomas Wouters89f507f2006-12-13 04:49:30 +00002313 Return 1 for success, 0 if the module is not found, and -1 with
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002314 an exception set if the initialization failed. */
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002315
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002316static int
Victor Stinner95872862011-03-07 18:20:56 +01002317init_builtin(PyObject *name)
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002318{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002319 struct _inittab *p;
Guido van Rossum25ce5661997-08-02 03:10:38 +00002320
Victor Stinner95872862011-03-07 18:20:56 +01002321 if (_PyImport_FindExtensionObject(name, name) != NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002322 return 1;
Guido van Rossum25ce5661997-08-02 03:10:38 +00002323
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002324 for (p = PyImport_Inittab; p->name != NULL; p++) {
2325 PyObject *mod;
Victor Stinner95872862011-03-07 18:20:56 +01002326 if (PyUnicode_CompareWithASCIIString(name, p->name) == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002327 if (p->initfunc == NULL) {
2328 PyErr_Format(PyExc_ImportError,
Victor Stinner95872862011-03-07 18:20:56 +01002329 "Cannot re-init internal module %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002330 name);
2331 return -1;
2332 }
2333 if (Py_VerboseFlag)
Victor Stinner95872862011-03-07 18:20:56 +01002334 PySys_FormatStderr("import %U # builtin\n", name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002335 mod = (*p->initfunc)();
2336 if (mod == 0)
2337 return -1;
Victor Stinner95872862011-03-07 18:20:56 +01002338 if (_PyImport_FixupExtensionObject(mod, name, name) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002339 return -1;
2340 /* FixupExtension has put the module into sys.modules,
2341 so we can release our own reference. */
2342 Py_DECREF(mod);
2343 return 1;
2344 }
2345 }
2346 return 0;
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002347}
Guido van Rossumf56e3db1993-04-01 20:59:32 +00002348
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002349
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002350/* Frozen modules */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002351
Guido van Rossumcfd0a221996-06-17 17:06:34 +00002352static struct _frozen *
Victor Stinner53dc7352011-03-20 01:50:21 +01002353find_frozen(PyObject *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002354{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002355 struct _frozen *p;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002356
Victor Stinner53dc7352011-03-20 01:50:21 +01002357 if (name == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002358 return NULL;
Benjamin Petersond968e272008-11-05 22:48:33 +00002359
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002360 for (p = PyImport_FrozenModules; ; p++) {
2361 if (p->name == NULL)
2362 return NULL;
Victor Stinner53dc7352011-03-20 01:50:21 +01002363 if (PyUnicode_CompareWithASCIIString(name, p->name) == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002364 break;
2365 }
2366 return p;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002367}
2368
Guido van Rossum79f25d91997-04-29 20:08:16 +00002369static PyObject *
Victor Stinner53dc7352011-03-20 01:50:21 +01002370get_frozen_object(PyObject *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002371{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002372 struct _frozen *p = find_frozen(name);
2373 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002374
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002375 if (p == NULL) {
2376 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002377 "No such frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002378 name);
2379 return NULL;
2380 }
2381 if (p->code == NULL) {
2382 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002383 "Excluded frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002384 name);
2385 return NULL;
2386 }
2387 size = p->size;
2388 if (size < 0)
2389 size = -size;
2390 return PyMarshal_ReadObjectFromString((char *)p->code, size);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002391}
2392
Brett Cannon8d110132009-03-15 02:20:16 +00002393static PyObject *
Victor Stinner53dc7352011-03-20 01:50:21 +01002394is_frozen_package(PyObject *name)
Brett Cannon8d110132009-03-15 02:20:16 +00002395{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002396 struct _frozen *p = find_frozen(name);
2397 int size;
Brett Cannon8d110132009-03-15 02:20:16 +00002398
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002399 if (p == NULL) {
2400 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002401 "No such frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002402 name);
2403 return NULL;
2404 }
Brett Cannon8d110132009-03-15 02:20:16 +00002405
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002406 size = p->size;
Brett Cannon8d110132009-03-15 02:20:16 +00002407
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002408 if (size < 0)
2409 Py_RETURN_TRUE;
2410 else
2411 Py_RETURN_FALSE;
Brett Cannon8d110132009-03-15 02:20:16 +00002412}
2413
2414
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002415/* Initialize a frozen module.
Brett Cannon3c2ac442009-03-08 20:49:47 +00002416 Return 1 for success, 0 if the module is not found, and -1 with
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002417 an exception set if the initialization failed.
2418 This function is also used from frozenmain.c */
Guido van Rossum0b344901995-02-07 15:35:27 +00002419
2420int
Victor Stinner53dc7352011-03-20 01:50:21 +01002421PyImport_ImportFrozenModuleObject(PyObject *name)
Guido van Rossumf56e3db1993-04-01 20:59:32 +00002422{
Victor Stinner53dc7352011-03-20 01:50:21 +01002423 struct _frozen *p;
2424 PyObject *co, *m, *path;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002425 int ispackage;
2426 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002427
Victor Stinner53dc7352011-03-20 01:50:21 +01002428 p = find_frozen(name);
2429
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002430 if (p == NULL)
2431 return 0;
2432 if (p->code == NULL) {
2433 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002434 "Excluded frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002435 name);
2436 return -1;
2437 }
2438 size = p->size;
2439 ispackage = (size < 0);
2440 if (ispackage)
2441 size = -size;
2442 if (Py_VerboseFlag)
Victor Stinner53dc7352011-03-20 01:50:21 +01002443 PySys_FormatStderr("import %U # frozen%s\n",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002444 name, ispackage ? " package" : "");
2445 co = PyMarshal_ReadObjectFromString((char *)p->code, size);
2446 if (co == NULL)
2447 return -1;
2448 if (!PyCode_Check(co)) {
2449 PyErr_Format(PyExc_TypeError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002450 "frozen object %R is not a code object",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002451 name);
2452 goto err_return;
2453 }
2454 if (ispackage) {
2455 /* Set __path__ to the package name */
Victor Stinner53dc7352011-03-20 01:50:21 +01002456 PyObject *d, *l;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002457 int err;
Victor Stinner53dc7352011-03-20 01:50:21 +01002458 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002459 if (m == NULL)
2460 goto err_return;
2461 d = PyModule_GetDict(m);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002462 l = PyList_New(1);
2463 if (l == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002464 goto err_return;
2465 }
Victor Stinner53dc7352011-03-20 01:50:21 +01002466 Py_INCREF(name);
2467 PyList_SET_ITEM(l, 0, name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002468 err = PyDict_SetItemString(d, "__path__", l);
2469 Py_DECREF(l);
2470 if (err != 0)
2471 goto err_return;
2472 }
Victor Stinner53dc7352011-03-20 01:50:21 +01002473 path = PyUnicode_FromString("<frozen>");
2474 if (path == NULL)
2475 goto err_return;
2476 m = PyImport_ExecCodeModuleObject(name, co, path, NULL);
2477 Py_DECREF(path);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002478 if (m == NULL)
2479 goto err_return;
2480 Py_DECREF(co);
2481 Py_DECREF(m);
2482 return 1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002483err_return:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002484 Py_DECREF(co);
2485 return -1;
Guido van Rossumf56e3db1993-04-01 20:59:32 +00002486}
Guido van Rossum74e6a111994-08-29 12:54:38 +00002487
Victor Stinner53dc7352011-03-20 01:50:21 +01002488int
2489PyImport_ImportFrozenModule(char *name)
2490{
2491 PyObject *nameobj;
2492 int ret;
2493 nameobj = PyUnicode_InternFromString(name);
2494 if (nameobj == NULL)
2495 return -1;
2496 ret = PyImport_ImportFrozenModuleObject(nameobj);
2497 Py_DECREF(nameobj);
2498 return ret;
2499}
2500
Guido van Rossum74e6a111994-08-29 12:54:38 +00002501
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002502/* Import a module, either built-in, frozen, or external, and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00002503 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum74e6a111994-08-29 12:54:38 +00002504
Guido van Rossum79f25d91997-04-29 20:08:16 +00002505PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00002506PyImport_ImportModule(const char *name)
Guido van Rossum74e6a111994-08-29 12:54:38 +00002507{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002508 PyObject *pname;
2509 PyObject *result;
Marc-André Lemburg3c61c352001-02-09 19:40:15 +00002510
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002511 pname = PyUnicode_FromString(name);
2512 if (pname == NULL)
2513 return NULL;
2514 result = PyImport_Import(pname);
2515 Py_DECREF(pname);
2516 return result;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002517}
2518
Christian Heimes072c0f12008-01-03 23:01:04 +00002519/* Import a module without blocking
2520 *
2521 * At first it tries to fetch the module from sys.modules. If the module was
2522 * never loaded before it loads it with PyImport_ImportModule() unless another
2523 * thread holds the import lock. In the latter case the function raises an
2524 * ImportError instead of blocking.
2525 *
2526 * Returns the module object with incremented ref count.
2527 */
2528PyObject *
2529PyImport_ImportModuleNoBlock(const char *name)
2530{
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002531 PyObject *nameobj, *modules, *result;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002532 long me;
Christian Heimes072c0f12008-01-03 23:01:04 +00002533
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002534 /* Try to get the module from sys.modules[name] */
2535 modules = PyImport_GetModuleDict();
2536 if (modules == NULL)
2537 return NULL;
Christian Heimes072c0f12008-01-03 23:01:04 +00002538
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002539 nameobj = PyUnicode_FromString(name);
2540 if (nameobj == NULL)
2541 return NULL;
2542 result = PyDict_GetItem(modules, nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002543 if (result != NULL) {
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002544 Py_DECREF(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002545 Py_INCREF(result);
2546 return result;
2547 }
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002548 PyErr_Clear();
Benjamin Peterson3e4f0552008-09-02 00:31:15 +00002549#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002550 /* check the import lock
2551 * me might be -1 but I ignore the error here, the lock function
2552 * takes care of the problem */
2553 me = PyThread_get_thread_ident();
2554 if (import_lock_thread == -1 || import_lock_thread == me) {
2555 /* no thread or me is holding the lock */
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002556 result = PyImport_Import(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002557 }
2558 else {
2559 PyErr_Format(PyExc_ImportError,
Victor Stinnerc24c8102011-03-13 22:38:06 -04002560 "Failed to import %R because the import lock"
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002561 "is held by another thread.",
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002562 nameobj);
2563 result = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002564 }
Benjamin Peterson3e4f0552008-09-02 00:31:15 +00002565#else
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002566 result = PyImport_Import(nameobj);
Benjamin Peterson3e4f0552008-09-02 00:31:15 +00002567#endif
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002568 Py_DECREF(nameobj);
2569 return result;
Christian Heimes072c0f12008-01-03 23:01:04 +00002570}
2571
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002572/* Forward declarations for helper routines */
Victor Stinner974389d2011-03-15 09:33:57 +01002573static PyObject *get_parent(PyObject *globals,
2574 PyObject **p_name,
2575 int level);
Tim Petersdbd9ba62000-07-09 03:09:57 +00002576static PyObject *load_next(PyObject *mod, PyObject *altmod,
Victor Stinner974389d2011-03-15 09:33:57 +01002577 PyObject *inputname, PyObject **p_outputname,
2578 Py_UNICODE *buf, Py_ssize_t *p_buflen,
2579 Py_ssize_t bufsize);
2580static int mark_miss(PyObject *name);
Tim Petersdbd9ba62000-07-09 03:09:57 +00002581static int ensure_fromlist(PyObject *mod, PyObject *fromlist,
Victor Stinner974389d2011-03-15 09:33:57 +01002582 PyObject *buf, int recursive);
2583static PyObject * import_submodule(PyObject *mod, PyObject *name,
2584 PyObject *fullname);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002585
2586/* The Magnum Opus of dotted-name import :-) */
2587
Guido van Rossum75acc9c1998-03-03 22:26:50 +00002588static PyObject *
Victor Stinner974389d2011-03-15 09:33:57 +01002589import_module_level(PyObject *name, PyObject *globals, PyObject *locals,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002590 PyObject *fromlist, int level)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002591{
Victor Stinner974389d2011-03-15 09:33:57 +01002592 Py_UNICODE buf[MAXPATHLEN+1];
2593 Py_ssize_t buflen;
2594 Py_ssize_t bufsize = MAXPATHLEN+1;
2595 PyObject *parent, *head, *next, *tail, *inputname, *outputname;
2596 PyObject *parent_name, *ensure_name;
2597 const Py_UNICODE *nameunicode;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002598
Victor Stinner974389d2011-03-15 09:33:57 +01002599 nameunicode = PyUnicode_AS_UNICODE(name);
2600
2601 if (Py_UNICODE_strchr(nameunicode, SEP) != NULL
2602#ifdef ALTSEP
2603 || Py_UNICODE_strchr(nameunicode, ALTSEP) != NULL
Christian Heimes454f37b2008-01-10 00:10:02 +00002604#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002605 ) {
2606 PyErr_SetString(PyExc_ImportError,
2607 "Import by filename is not supported.");
2608 return NULL;
2609 }
Christian Heimes454f37b2008-01-10 00:10:02 +00002610
Victor Stinner974389d2011-03-15 09:33:57 +01002611 parent = get_parent(globals, &parent_name, level);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002612 if (parent == NULL)
2613 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002614
Victor Stinner974389d2011-03-15 09:33:57 +01002615 buflen = PyUnicode_GET_SIZE(parent_name);
2616 if (buflen+1 > bufsize) {
2617 Py_DECREF(parent_name);
2618 PyErr_SetString(PyExc_ValueError,
2619 "Module name too long");
2620 return NULL;
2621 }
2622 Py_UNICODE_strcpy(buf, PyUnicode_AS_UNICODE(parent_name));
2623 Py_DECREF(parent_name);
2624
2625 head = load_next(parent, level < 0 ? Py_None : parent, name, &outputname,
2626 buf, &buflen, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002627 if (head == NULL)
2628 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002629
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002630 tail = head;
2631 Py_INCREF(tail);
Victor Stinner974389d2011-03-15 09:33:57 +01002632
2633 if (outputname != NULL) {
2634 while (1) {
2635 inputname = outputname;
2636 next = load_next(tail, tail, inputname, &outputname,
2637 buf, &buflen, bufsize);
2638 Py_DECREF(tail);
2639 Py_DECREF(inputname);
2640 if (next == NULL) {
2641 Py_DECREF(head);
2642 return NULL;
2643 }
2644 tail = next;
2645
2646 if (outputname == NULL) {
2647 break;
2648 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002649 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002650 }
2651 if (tail == Py_None) {
2652 /* If tail is Py_None, both get_parent and load_next found
2653 an empty module name: someone called __import__("") or
2654 doctored faulty bytecode */
2655 Py_DECREF(tail);
2656 Py_DECREF(head);
Victor Stinner974389d2011-03-15 09:33:57 +01002657 PyErr_SetString(PyExc_ValueError, "Empty module name");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002658 return NULL;
2659 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002660
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002661 if (fromlist != NULL) {
2662 if (fromlist == Py_None || !PyObject_IsTrue(fromlist))
2663 fromlist = NULL;
2664 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002665
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002666 if (fromlist == NULL) {
2667 Py_DECREF(tail);
2668 return head;
2669 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002670
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002671 Py_DECREF(head);
Victor Stinner974389d2011-03-15 09:33:57 +01002672
2673 ensure_name = PyUnicode_FromUnicode(buf, Py_UNICODE_strlen(buf));
2674 if (ensure_name == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002675 Py_DECREF(tail);
2676 return NULL;
2677 }
Victor Stinner974389d2011-03-15 09:33:57 +01002678 if (!ensure_fromlist(tail, fromlist, ensure_name, 0)) {
2679 Py_DECREF(tail);
2680 Py_DECREF(ensure_name);
2681 return NULL;
2682 }
2683 Py_DECREF(ensure_name);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002684
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002685 return tail;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002686}
2687
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002688PyObject *
2689PyImport_ImportModuleLevel(char *name, PyObject *globals, PyObject *locals,
Victor Stinner974389d2011-03-15 09:33:57 +01002690 PyObject *fromlist, int level)
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002691{
Victor Stinner974389d2011-03-15 09:33:57 +01002692 PyObject *nameobj, *result;
2693 nameobj = PyUnicode_FromString(name);
2694 if (nameobj == NULL)
2695 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002696 _PyImport_AcquireLock();
Victor Stinner974389d2011-03-15 09:33:57 +01002697 result = import_module_level(nameobj, globals, locals, fromlist, level);
2698 Py_DECREF(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002699 if (_PyImport_ReleaseLock() < 0) {
2700 Py_XDECREF(result);
2701 PyErr_SetString(PyExc_RuntimeError,
2702 "not holding the import lock");
2703 return NULL;
2704 }
2705 return result;
Guido van Rossum75acc9c1998-03-03 22:26:50 +00002706}
2707
Fred Drake87590902004-05-28 20:21:36 +00002708/* Return the package that an import is being performed in. If globals comes
2709 from the module foo.bar.bat (not itself a package), this returns the
2710 sys.modules entry for foo.bar. If globals is from a package's __init__.py,
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00002711 the package's entry in sys.modules is returned, as a borrowed reference.
Fred Drake87590902004-05-28 20:21:36 +00002712
Victor Stinner974389d2011-03-15 09:33:57 +01002713 The name of the returned package is returned in *p_name.
Fred Drake87590902004-05-28 20:21:36 +00002714
2715 If globals doesn't come from a package or a module in a package, or a
2716 corresponding entry is not found in sys.modules, Py_None is returned.
2717*/
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002718static PyObject *
Victor Stinner9599de52011-03-13 22:38:38 -04002719get_parent(PyObject *globals, PyObject **p_name, int level)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002720{
Victor Stinner974389d2011-03-15 09:33:57 +01002721 Py_UNICODE name[MAXPATHLEN+1];
2722 const Py_ssize_t bufsize = MAXPATHLEN+1;
2723 PyObject *nameobj;
2724
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002725 static PyObject *namestr = NULL;
2726 static PyObject *pathstr = NULL;
2727 static PyObject *pkgstr = NULL;
2728 PyObject *pkgname, *modname, *modpath, *modules, *parent;
2729 int orig_level = level;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002730
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002731 if (globals == NULL || !PyDict_Check(globals) || !level)
Victor Stinner974389d2011-03-15 09:33:57 +01002732 goto return_none;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002733
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002734 if (namestr == NULL) {
2735 namestr = PyUnicode_InternFromString("__name__");
2736 if (namestr == NULL)
2737 return NULL;
2738 }
2739 if (pathstr == NULL) {
2740 pathstr = PyUnicode_InternFromString("__path__");
2741 if (pathstr == NULL)
2742 return NULL;
2743 }
2744 if (pkgstr == NULL) {
2745 pkgstr = PyUnicode_InternFromString("__package__");
2746 if (pkgstr == NULL)
2747 return NULL;
2748 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002749
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002750 pkgname = PyDict_GetItem(globals, pkgstr);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002751
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002752 if ((pkgname != NULL) && (pkgname != Py_None)) {
2753 /* __package__ is set, so use it */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002754 if (!PyUnicode_Check(pkgname)) {
2755 PyErr_SetString(PyExc_ValueError,
2756 "__package__ set to non-string");
2757 return NULL;
2758 }
Victor Stinner974389d2011-03-15 09:33:57 +01002759 if (PyUnicode_GET_SIZE(pkgname) == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002760 if (level > 0) {
2761 PyErr_SetString(PyExc_ValueError,
2762 "Attempted relative import in non-package");
2763 return NULL;
2764 }
Victor Stinner974389d2011-03-15 09:33:57 +01002765 goto return_none;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002766 }
Victor Stinner974389d2011-03-15 09:33:57 +01002767 if (PyUnicode_GET_SIZE(pkgname)+1 > bufsize) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002768 PyErr_SetString(PyExc_ValueError,
2769 "Package name too long");
2770 return NULL;
2771 }
Victor Stinner974389d2011-03-15 09:33:57 +01002772 Py_UNICODE_strcpy(name, PyUnicode_AS_UNICODE(pkgname));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002773 } else {
2774 /* __package__ not set, so figure it out and set it */
2775 modname = PyDict_GetItem(globals, namestr);
2776 if (modname == NULL || !PyUnicode_Check(modname))
Victor Stinner974389d2011-03-15 09:33:57 +01002777 goto return_none;
Brett Cannon9a5b25a2010-03-01 02:09:17 +00002778
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002779 modpath = PyDict_GetItem(globals, pathstr);
2780 if (modpath != NULL) {
2781 /* __path__ is set, so modname is already the package name */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002782 int error;
Alexandre Vassalottia85998a2008-05-03 18:24:43 +00002783
Victor Stinner974389d2011-03-15 09:33:57 +01002784 if (PyUnicode_GET_SIZE(modname)+1 > bufsize) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002785 PyErr_SetString(PyExc_ValueError,
2786 "Module name too long");
2787 return NULL;
2788 }
Victor Stinner974389d2011-03-15 09:33:57 +01002789 Py_UNICODE_strcpy(name, PyUnicode_AS_UNICODE(modname));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002790 error = PyDict_SetItem(globals, pkgstr, modname);
2791 if (error) {
2792 PyErr_SetString(PyExc_ValueError,
2793 "Could not set __package__");
2794 return NULL;
2795 }
2796 } else {
2797 /* Normal module, so work out the package name if any */
Victor Stinner974389d2011-03-15 09:33:57 +01002798 Py_UNICODE *start = PyUnicode_AS_UNICODE(modname);
2799 Py_UNICODE *lastdot = Py_UNICODE_strrchr(start, '.');
2800 Py_ssize_t len;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002801 int error;
2802 if (lastdot == NULL && level > 0) {
2803 PyErr_SetString(PyExc_ValueError,
2804 "Attempted relative import in non-package");
2805 return NULL;
2806 }
2807 if (lastdot == NULL) {
2808 error = PyDict_SetItem(globals, pkgstr, Py_None);
2809 if (error) {
2810 PyErr_SetString(PyExc_ValueError,
2811 "Could not set __package__");
2812 return NULL;
2813 }
Victor Stinner974389d2011-03-15 09:33:57 +01002814 goto return_none;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002815 }
2816 len = lastdot - start;
Victor Stinner974389d2011-03-15 09:33:57 +01002817 if (len+1 > bufsize) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002818 PyErr_SetString(PyExc_ValueError,
2819 "Module name too long");
2820 return NULL;
2821 }
Victor Stinner974389d2011-03-15 09:33:57 +01002822 Py_UNICODE_strncpy(name, start, len);
2823 name[len] = '\0';
2824 pkgname = PyUnicode_FromUnicode(name, len);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002825 if (pkgname == NULL) {
2826 return NULL;
2827 }
2828 error = PyDict_SetItem(globals, pkgstr, pkgname);
2829 Py_DECREF(pkgname);
2830 if (error) {
2831 PyErr_SetString(PyExc_ValueError,
2832 "Could not set __package__");
2833 return NULL;
2834 }
2835 }
2836 }
2837 while (--level > 0) {
Victor Stinner974389d2011-03-15 09:33:57 +01002838 Py_UNICODE *dot = Py_UNICODE_strrchr(name, '.');
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002839 if (dot == NULL) {
2840 PyErr_SetString(PyExc_ValueError,
2841 "Attempted relative import beyond "
2842 "toplevel package");
2843 return NULL;
2844 }
2845 *dot = '\0';
2846 }
Victor Stinner974389d2011-03-15 09:33:57 +01002847
2848 nameobj = PyUnicode_FromUnicode(name, Py_UNICODE_strlen(name));
2849 if (nameobj == NULL)
2850 return NULL;
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002851
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002852 modules = PyImport_GetModuleDict();
Victor Stinner974389d2011-03-15 09:33:57 +01002853 parent = PyDict_GetItem(modules, nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002854 if (parent == NULL) {
Victor Stinner974389d2011-03-15 09:33:57 +01002855 int err;
2856
2857 if (orig_level >= 1) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002858 PyErr_Format(PyExc_SystemError,
Victor Stinner974389d2011-03-15 09:33:57 +01002859 "Parent module %R not loaded, "
2860 "cannot perform relative import", nameobj);
2861 Py_DECREF(nameobj);
2862 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002863 }
Victor Stinner974389d2011-03-15 09:33:57 +01002864
2865 err = PyErr_WarnFormat(
2866 PyExc_RuntimeWarning, 1,
2867 "Parent module %R not found while handling absolute import",
2868 nameobj);
2869 Py_DECREF(nameobj);
2870 if (err)
2871 return NULL;
2872
2873 goto return_none;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002874 }
Victor Stinner974389d2011-03-15 09:33:57 +01002875 *p_name = nameobj;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002876 return parent;
2877 /* We expect, but can't guarantee, if parent != None, that:
Victor Stinner974389d2011-03-15 09:33:57 +01002878 - parent.__name__ == name
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002879 - parent.__dict__ is globals
2880 If this is violated... Who cares? */
Victor Stinner974389d2011-03-15 09:33:57 +01002881
2882return_none:
2883 nameobj = PyUnicode_FromUnicode(NULL, 0);
2884 if (nameobj == NULL)
2885 return NULL;
2886 *p_name = nameobj;
2887 return Py_None;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002888}
2889
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002890/* altmod is either None or same as mod */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002891static PyObject *
Victor Stinner974389d2011-03-15 09:33:57 +01002892load_next(PyObject *mod, PyObject *altmod,
2893 PyObject *inputname, PyObject **p_outputname,
2894 Py_UNICODE *buf, Py_ssize_t *p_buflen, Py_ssize_t bufsize)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002895{
Victor Stinner974389d2011-03-15 09:33:57 +01002896 const Py_UNICODE *dot;
2897 Py_ssize_t len;
2898 Py_UNICODE *p;
2899 PyObject *fullname, *name, *result, *mark_name;
2900 const Py_UNICODE *nameuni;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002901
Victor Stinner974389d2011-03-15 09:33:57 +01002902 *p_outputname = NULL;
2903
2904 if (PyUnicode_GET_SIZE(inputname) == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002905 /* completely empty module name should only happen in
2906 'from . import' (or '__import__("")')*/
2907 Py_INCREF(mod);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002908 return mod;
2909 }
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002910
Victor Stinner974389d2011-03-15 09:33:57 +01002911 nameuni = PyUnicode_AS_UNICODE(inputname);
2912 if (nameuni == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002913 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002914
Victor Stinner974389d2011-03-15 09:33:57 +01002915 dot = Py_UNICODE_strchr(nameuni, '.');
2916 if (dot != NULL) {
2917 len = dot - nameuni;
2918 if (len == 0) {
2919 PyErr_SetString(PyExc_ValueError,
2920 "Empty module name");
2921 return NULL;
2922 }
2923 }
2924 else
2925 len = PyUnicode_GET_SIZE(inputname);
2926
2927 if (*p_buflen+len+1 >= bufsize) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002928 PyErr_SetString(PyExc_ValueError,
2929 "Module name too long");
2930 return NULL;
2931 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002932
Victor Stinner974389d2011-03-15 09:33:57 +01002933 p = buf + *p_buflen;
2934 if (p != buf) {
2935 *p++ = '.';
2936 *p_buflen += 1;
2937 }
2938 Py_UNICODE_strncpy(p, nameuni, len);
2939 p[len] = '\0';
2940 *p_buflen += len;
2941
2942 fullname = PyUnicode_FromUnicode(buf, *p_buflen);
2943 if (fullname == NULL)
2944 return NULL;
2945 name = PyUnicode_FromUnicode(p, len);
2946 if (name == NULL) {
2947 Py_DECREF(fullname);
2948 return NULL;
2949 }
2950 result = import_submodule(mod, name, fullname);
2951 Py_DECREF(fullname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002952 if (result == Py_None && altmod != mod) {
2953 Py_DECREF(result);
2954 /* Here, altmod must be None and mod must not be None */
Victor Stinner974389d2011-03-15 09:33:57 +01002955 result = import_submodule(altmod, name, name);
2956 Py_DECREF(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002957 if (result != NULL && result != Py_None) {
Victor Stinner974389d2011-03-15 09:33:57 +01002958 mark_name = PyUnicode_FromUnicode(buf, *p_buflen);
2959 if (mark_name == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002960 Py_DECREF(result);
2961 return NULL;
2962 }
Victor Stinner974389d2011-03-15 09:33:57 +01002963 if (mark_miss(mark_name) != 0) {
2964 Py_DECREF(result);
2965 Py_DECREF(mark_name);
2966 return NULL;
2967 }
2968 Py_DECREF(mark_name);
2969 Py_UNICODE_strncpy(buf, nameuni, len);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002970 buf[len] = '\0';
2971 *p_buflen = len;
2972 }
2973 }
Victor Stinner974389d2011-03-15 09:33:57 +01002974 else
2975 Py_DECREF(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002976 if (result == NULL)
2977 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002978
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002979 if (result == Py_None) {
2980 Py_DECREF(result);
2981 PyErr_Format(PyExc_ImportError,
Victor Stinner974389d2011-03-15 09:33:57 +01002982 "No module named %R", inputname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002983 return NULL;
2984 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002985
Victor Stinner974389d2011-03-15 09:33:57 +01002986 if (dot != NULL) {
2987 *p_outputname = PyUnicode_FromUnicode(dot+1, Py_UNICODE_strlen(dot+1));
2988 if (*p_outputname == NULL) {
2989 Py_DECREF(result);
2990 return NULL;
2991 }
2992 }
2993
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002994 return result;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002995}
2996
2997static int
Victor Stinner974389d2011-03-15 09:33:57 +01002998mark_miss(PyObject *name)
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00002999{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003000 PyObject *modules = PyImport_GetModuleDict();
Victor Stinner974389d2011-03-15 09:33:57 +01003001 return PyDict_SetItem(modules, name, Py_None);
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00003002}
3003
3004static int
Victor Stinner974389d2011-03-15 09:33:57 +01003005ensure_fromlist(PyObject *mod, PyObject *fromlist, PyObject *name,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003006 int recursive)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003007{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003008 int i;
Victor Stinner974389d2011-03-15 09:33:57 +01003009 PyObject *fullname;
3010 Py_ssize_t fromlist_len;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003011
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003012 if (!PyObject_HasAttrString(mod, "__path__"))
3013 return 1;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003014
Victor Stinner974389d2011-03-15 09:33:57 +01003015 fromlist_len = PySequence_Size(fromlist);
3016
3017 for (i = 0; i < fromlist_len; i++) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003018 PyObject *item = PySequence_GetItem(fromlist, i);
3019 int hasit;
Victor Stinner974389d2011-03-15 09:33:57 +01003020 if (item == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003021 return 0;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003022 if (!PyUnicode_Check(item)) {
3023 PyErr_SetString(PyExc_TypeError,
3024 "Item in ``from list'' not a string");
3025 Py_DECREF(item);
3026 return 0;
3027 }
3028 if (PyUnicode_AS_UNICODE(item)[0] == '*') {
3029 PyObject *all;
3030 Py_DECREF(item);
3031 /* See if the package defines __all__ */
3032 if (recursive)
3033 continue; /* Avoid endless recursion */
3034 all = PyObject_GetAttrString(mod, "__all__");
3035 if (all == NULL)
3036 PyErr_Clear();
3037 else {
Victor Stinner974389d2011-03-15 09:33:57 +01003038 int ret = ensure_fromlist(mod, all, name, 1);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003039 Py_DECREF(all);
3040 if (!ret)
3041 return 0;
3042 }
3043 continue;
3044 }
3045 hasit = PyObject_HasAttr(mod, item);
3046 if (!hasit) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003047 PyObject *submod;
Victor Stinner974389d2011-03-15 09:33:57 +01003048 fullname = PyUnicode_FromFormat("%U.%U", name, item);
3049 if (fullname != NULL) {
3050 submod = import_submodule(mod, item, fullname);
3051 Py_DECREF(fullname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003052 }
Victor Stinner974389d2011-03-15 09:33:57 +01003053 else
3054 submod = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003055 Py_XDECREF(submod);
3056 if (submod == NULL) {
3057 Py_DECREF(item);
3058 return 0;
3059 }
3060 }
3061 Py_DECREF(item);
3062 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003063
Victor Stinner974389d2011-03-15 09:33:57 +01003064 return 1;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003065}
3066
Neil Schemenauer00b09662003-06-16 21:03:07 +00003067static int
Victor Stinner974389d2011-03-15 09:33:57 +01003068add_submodule(PyObject *mod, PyObject *submod, PyObject *fullname,
3069 PyObject *subname, PyObject *modules)
Neil Schemenauer00b09662003-06-16 21:03:07 +00003070{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003071 if (mod == Py_None)
3072 return 1;
3073 /* Irrespective of the success of this load, make a
3074 reference to it in the parent package module. A copy gets
3075 saved in the modules dictionary under the full name, so get a
3076 reference from there, if need be. (The exception is when the
3077 load failed with a SyntaxError -- then there's no trace in
3078 sys.modules. In that case, of course, do nothing extra.) */
3079 if (submod == NULL) {
Victor Stinner974389d2011-03-15 09:33:57 +01003080 submod = PyDict_GetItem(modules, fullname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003081 if (submod == NULL)
3082 return 1;
3083 }
3084 if (PyModule_Check(mod)) {
3085 /* We can't use setattr here since it can give a
3086 * spurious warning if the submodule name shadows a
3087 * builtin name */
3088 PyObject *dict = PyModule_GetDict(mod);
3089 if (!dict)
3090 return 0;
Victor Stinner974389d2011-03-15 09:33:57 +01003091 if (PyDict_SetItem(dict, subname, submod) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003092 return 0;
3093 }
3094 else {
Victor Stinner974389d2011-03-15 09:33:57 +01003095 if (PyObject_SetAttr(mod, subname, submod) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003096 return 0;
3097 }
3098 return 1;
Neil Schemenauer00b09662003-06-16 21:03:07 +00003099}
3100
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003101static PyObject *
Victor Stinner974389d2011-03-15 09:33:57 +01003102import_submodule(PyObject *mod, PyObject *subname, PyObject *fullname)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003103{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003104 PyObject *modules = PyImport_GetModuleDict();
Victor Stinner533d7832011-03-14 13:22:54 -04003105 PyObject *m = NULL, *bufobj, *path_list, *loader;
Victor Stinner9599de52011-03-13 22:38:38 -04003106 char buf[MAXPATHLEN+1];
3107 struct filedescr *fdp;
3108 FILE *fp;
Guido van Rossum74e6a111994-08-29 12:54:38 +00003109
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003110 /* Require:
3111 if mod == None: subname == fullname
3112 else: mod.__name__ + "." + subname == fullname
3113 */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003114
Victor Stinner974389d2011-03-15 09:33:57 +01003115 if ((m = PyDict_GetItem(modules, fullname)) != NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003116 Py_INCREF(m);
Victor Stinner9599de52011-03-13 22:38:38 -04003117 return m;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003118 }
Victor Stinner9599de52011-03-13 22:38:38 -04003119
3120 if (mod == Py_None)
Victor Stinner533d7832011-03-14 13:22:54 -04003121 path_list = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003122 else {
Victor Stinner533d7832011-03-14 13:22:54 -04003123 path_list = PyObject_GetAttrString(mod, "__path__");
3124 if (path_list == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003125 PyErr_Clear();
3126 Py_INCREF(Py_None);
3127 return Py_None;
3128 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003129 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003130
Victor Stinner533d7832011-03-14 13:22:54 -04003131 fdp = find_module(fullname, subname, path_list,
3132 buf, MAXPATHLEN+1, &fp, &loader);
3133 Py_XDECREF(path_list);
Victor Stinner9599de52011-03-13 22:38:38 -04003134 if (fdp == NULL) {
3135 if (!PyErr_ExceptionMatches(PyExc_ImportError))
3136 return NULL;
3137 PyErr_Clear();
3138 Py_INCREF(Py_None);
3139 return Py_None;
3140 }
3141 bufobj = PyUnicode_DecodeFSDefault(buf);
3142 if (bufobj != NULL) {
3143 m = load_module(fullname, fp, bufobj, fdp->type, loader);
3144 Py_DECREF(bufobj);
3145 }
3146 else
3147 m = NULL;
3148 Py_XDECREF(loader);
3149 if (fp)
3150 fclose(fp);
3151 if (m == NULL)
3152 return NULL;
3153 if (!add_submodule(mod, m, fullname, subname, modules)) {
3154 Py_XDECREF(m);
3155 return NULL;
3156 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003157 return m;
Guido van Rossum74e6a111994-08-29 12:54:38 +00003158}
3159
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003160
3161/* Re-import a module of any kind and return its module object, WITH
3162 INCREMENTED REFERENCE COUNT */
3163
Guido van Rossum79f25d91997-04-29 20:08:16 +00003164PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003165PyImport_ReloadModule(PyObject *m)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003166{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003167 PyInterpreterState *interp = PyThreadState_Get()->interp;
3168 PyObject *modules_reloading = interp->modules_reloading;
3169 PyObject *modules = PyImport_GetModuleDict();
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003170 char buf[MAXPATHLEN+1];
Victor Stinner533d7832011-03-14 13:22:54 -04003171 PyObject *path_list = NULL, *loader = NULL, *existing_m = NULL;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003172 PyObject *nameobj, *bufobj, *subnameobj;
3173 Py_UNICODE *name, *subname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003174 struct filedescr *fdp;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003175 FILE *fp = NULL;
3176 PyObject *newm = NULL;
Brett Cannon9a5b25a2010-03-01 02:09:17 +00003177
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003178 if (modules_reloading == NULL) {
3179 Py_FatalError("PyImport_ReloadModule: "
3180 "no modules_reloading dictionary!");
3181 return NULL;
3182 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003183
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003184 if (m == NULL || !PyModule_Check(m)) {
3185 PyErr_SetString(PyExc_TypeError,
3186 "reload() argument must be module");
3187 return NULL;
3188 }
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003189 nameobj = PyModule_GetNameObject(m);
3190 if (nameobj == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003191 return NULL;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003192 if (m != PyDict_GetItem(modules, nameobj)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003193 PyErr_Format(PyExc_ImportError,
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003194 "reload(): module %U not in sys.modules",
3195 nameobj);
3196 Py_DECREF(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003197 return NULL;
3198 }
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003199 existing_m = PyDict_GetItem(modules_reloading, nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003200 if (existing_m != NULL) {
3201 /* Due to a recursive reload, this module is already
3202 being reloaded. */
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003203 Py_DECREF(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003204 Py_INCREF(existing_m);
3205 return existing_m;
3206 }
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003207 if (PyDict_SetItem(modules_reloading, nameobj, m) < 0) {
3208 Py_DECREF(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003209 return NULL;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003210 }
Guido van Rossumd8faa362007-04-27 19:54:29 +00003211
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003212 name = PyUnicode_AS_UNICODE(nameobj);
3213 subname = Py_UNICODE_strrchr(name, '.');
3214 if (subname == NULL) {
3215 Py_INCREF(nameobj);
3216 subnameobj = nameobj;
3217 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003218 else {
3219 PyObject *parentname, *parent;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003220 Py_ssize_t len;
3221 len = subname - name;
3222 parentname = PyUnicode_FromUnicode(name, len);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003223 if (parentname == NULL) {
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003224 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003225 }
3226 parent = PyDict_GetItem(modules, parentname);
3227 if (parent == NULL) {
3228 PyErr_Format(PyExc_ImportError,
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003229 "reload(): parent %U not in sys.modules",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003230 parentname);
3231 Py_DECREF(parentname);
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003232 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003233 }
3234 Py_DECREF(parentname);
Victor Stinner533d7832011-03-14 13:22:54 -04003235 path_list = PyObject_GetAttrString(parent, "__path__");
3236 if (path_list == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003237 PyErr_Clear();
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003238 subname++;
3239 len = PyUnicode_GET_SIZE(nameobj) - (len + 1);
3240 subnameobj = PyUnicode_FromUnicode(subname, len);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003241 }
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003242 if (subnameobj == NULL)
3243 goto error;
Victor Stinner533d7832011-03-14 13:22:54 -04003244 fdp = find_module(nameobj, subnameobj, path_list,
3245 buf, MAXPATHLEN+1, &fp, &loader);
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003246 Py_DECREF(subnameobj);
Victor Stinner533d7832011-03-14 13:22:54 -04003247 Py_XDECREF(path_list);
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00003248
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003249 if (fdp == NULL) {
3250 Py_XDECREF(loader);
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003251 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003252 }
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00003253
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003254 bufobj = PyUnicode_DecodeFSDefault(buf);
3255 if (bufobj != NULL) {
3256 newm = load_module(nameobj, fp, bufobj, fdp->type, loader);
3257 Py_DECREF(bufobj);
Victor Stinner41c5fec2011-03-13 21:46:30 -04003258 }
3259 else
3260 newm = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003261 Py_XDECREF(loader);
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00003262
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003263 if (fp)
3264 fclose(fp);
3265 if (newm == NULL) {
3266 /* load_module probably removed name from modules because of
3267 * the error. Put back the original module object. We're
3268 * going to return NULL in this case regardless of whether
3269 * replacing name succeeds, so the return value is ignored.
3270 */
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003271 PyDict_SetItem(modules, nameobj, m);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003272 }
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003273
3274error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003275 imp_modules_reloading_clear();
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003276 Py_DECREF(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003277 return newm;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003278}
3279
3280
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003281/* Higher-level import emulator which emulates the "import" statement
3282 more accurately -- it invokes the __import__() function from the
3283 builtins of the current globals. This means that the import is
3284 done using whatever import hooks are installed in the current
Brett Cannonbc2eff32010-09-19 21:39:02 +00003285 environment.
Guido van Rossum6058eb41998-12-21 19:51:00 +00003286 A dummy list ["__doc__"] is passed as the 4th argument so that
Neal Norwitz80e7f272007-08-26 06:45:23 +00003287 e.g. PyImport_Import(PyUnicode_FromString("win32com.client.gencache"))
Guido van Rossum6058eb41998-12-21 19:51:00 +00003288 will return <module "gencache"> instead of <module "win32com">. */
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003289
3290PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003291PyImport_Import(PyObject *module_name)
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003292{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003293 static PyObject *silly_list = NULL;
3294 static PyObject *builtins_str = NULL;
3295 static PyObject *import_str = NULL;
3296 PyObject *globals = NULL;
3297 PyObject *import = NULL;
3298 PyObject *builtins = NULL;
Brett Cannonbc2eff32010-09-19 21:39:02 +00003299 PyObject *modules = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003300 PyObject *r = NULL;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003301
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003302 /* Initialize constant string objects */
3303 if (silly_list == NULL) {
3304 import_str = PyUnicode_InternFromString("__import__");
3305 if (import_str == NULL)
3306 return NULL;
3307 builtins_str = PyUnicode_InternFromString("__builtins__");
3308 if (builtins_str == NULL)
3309 return NULL;
Brett Cannonbc2eff32010-09-19 21:39:02 +00003310 silly_list = PyList_New(0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003311 if (silly_list == NULL)
3312 return NULL;
3313 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003314
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003315 /* Get the builtins from current globals */
3316 globals = PyEval_GetGlobals();
3317 if (globals != NULL) {
3318 Py_INCREF(globals);
3319 builtins = PyObject_GetItem(globals, builtins_str);
3320 if (builtins == NULL)
3321 goto err;
3322 }
3323 else {
3324 /* No globals -- use standard builtins, and fake globals */
3325 builtins = PyImport_ImportModuleLevel("builtins",
3326 NULL, NULL, NULL, 0);
3327 if (builtins == NULL)
3328 return NULL;
3329 globals = Py_BuildValue("{OO}", builtins_str, builtins);
3330 if (globals == NULL)
3331 goto err;
3332 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003333
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003334 /* Get the __import__ function from the builtins */
3335 if (PyDict_Check(builtins)) {
3336 import = PyObject_GetItem(builtins, import_str);
3337 if (import == NULL)
3338 PyErr_SetObject(PyExc_KeyError, import_str);
3339 }
3340 else
3341 import = PyObject_GetAttr(builtins, import_str);
3342 if (import == NULL)
3343 goto err;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003344
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003345 /* Call the __import__ function with the proper argument list
Brett Cannonbc2eff32010-09-19 21:39:02 +00003346 Always use absolute import here.
3347 Calling for side-effect of import. */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003348 r = PyObject_CallFunction(import, "OOOOi", module_name, globals,
3349 globals, silly_list, 0, NULL);
Brett Cannonbc2eff32010-09-19 21:39:02 +00003350 if (r == NULL)
3351 goto err;
3352 Py_DECREF(r);
3353
3354 modules = PyImport_GetModuleDict();
3355 r = PyDict_GetItem(modules, module_name);
3356 if (r != NULL)
3357 Py_INCREF(r);
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003358
3359 err:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003360 Py_XDECREF(globals);
3361 Py_XDECREF(builtins);
3362 Py_XDECREF(import);
Tim Peters50d8d372001-02-28 05:34:27 +00003363
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003364 return r;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003365}
3366
3367
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003368/* Module 'imp' provides Python access to the primitives used for
3369 importing modules.
3370*/
3371
Guido van Rossum79f25d91997-04-29 20:08:16 +00003372static PyObject *
Barry Warsaw28a691b2010-04-17 00:19:56 +00003373imp_make_magic(long magic)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003374{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003375 char buf[4];
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003376
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003377 buf[0] = (char) ((magic >> 0) & 0xff);
3378 buf[1] = (char) ((magic >> 8) & 0xff);
3379 buf[2] = (char) ((magic >> 16) & 0xff);
3380 buf[3] = (char) ((magic >> 24) & 0xff);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003381
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003382 return PyBytes_FromStringAndSize(buf, 4);
Victor Stinner3e2b7172010-11-09 09:32:19 +00003383}
Barry Warsaw28a691b2010-04-17 00:19:56 +00003384
3385static PyObject *
3386imp_get_magic(PyObject *self, PyObject *noargs)
3387{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003388 return imp_make_magic(pyc_magic);
Barry Warsaw28a691b2010-04-17 00:19:56 +00003389}
3390
3391static PyObject *
3392imp_get_tag(PyObject *self, PyObject *noargs)
3393{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003394 return PyUnicode_FromString(pyc_tag);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003395}
3396
Guido van Rossum79f25d91997-04-29 20:08:16 +00003397static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +00003398imp_get_suffixes(PyObject *self, PyObject *noargs)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003399{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003400 PyObject *list;
3401 struct filedescr *fdp;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003402
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003403 list = PyList_New(0);
3404 if (list == NULL)
3405 return NULL;
3406 for (fdp = _PyImport_Filetab; fdp->suffix != NULL; fdp++) {
3407 PyObject *item = Py_BuildValue("ssi",
3408 fdp->suffix, fdp->mode, fdp->type);
3409 if (item == NULL) {
3410 Py_DECREF(list);
3411 return NULL;
3412 }
3413 if (PyList_Append(list, item) < 0) {
3414 Py_DECREF(list);
3415 Py_DECREF(item);
3416 return NULL;
3417 }
3418 Py_DECREF(item);
3419 }
3420 return list;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003421}
3422
Guido van Rossum79f25d91997-04-29 20:08:16 +00003423static PyObject *
Victor Stinner533d7832011-03-14 13:22:54 -04003424call_find_module(PyObject *name, PyObject *path_list)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003425{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003426 extern int fclose(FILE *);
3427 PyObject *fob, *ret;
3428 PyObject *pathobj;
3429 struct filedescr *fdp;
3430 char pathname[MAXPATHLEN+1];
Victor Stinner7d8b77c2011-03-12 08:45:02 -05003431 FILE *fp;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003432 int fd = -1;
3433 char *found_encoding = NULL;
3434 char *encoding = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003435
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003436 pathname[0] = '\0';
Victor Stinner533d7832011-03-14 13:22:54 -04003437 if (path_list == Py_None)
3438 path_list = NULL;
3439 fdp = find_module(NULL, name, path_list,
3440 pathname, MAXPATHLEN+1, &fp, NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003441 if (fdp == NULL)
3442 return NULL;
3443 if (fp != NULL) {
3444 fd = fileno(fp);
3445 if (fd != -1)
3446 fd = dup(fd);
3447 fclose(fp);
3448 fp = NULL;
3449 }
3450 if (fd != -1) {
3451 if (strchr(fdp->mode, 'b') == NULL) {
3452 /* PyTokenizer_FindEncoding() returns PyMem_MALLOC'ed
3453 memory. */
3454 found_encoding = PyTokenizer_FindEncoding(fd);
3455 lseek(fd, 0, 0); /* Reset position */
3456 if (found_encoding == NULL && PyErr_Occurred())
3457 return NULL;
3458 encoding = (found_encoding != NULL) ? found_encoding :
3459 (char*)PyUnicode_GetDefaultEncoding();
3460 }
3461 fob = PyFile_FromFd(fd, pathname, fdp->mode, -1,
3462 (char*)encoding, NULL, NULL, 1);
3463 if (fob == NULL) {
3464 close(fd);
3465 PyMem_FREE(found_encoding);
3466 return NULL;
3467 }
3468 }
3469 else {
3470 fob = Py_None;
3471 Py_INCREF(fob);
3472 }
3473 pathobj = PyUnicode_DecodeFSDefault(pathname);
3474 ret = Py_BuildValue("NN(ssi)",
3475 fob, pathobj, fdp->suffix, fdp->mode, fdp->type);
3476 PyMem_FREE(found_encoding);
Brett Cannon3bb42d92007-10-20 03:43:15 +00003477
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003478 return ret;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003479}
3480
Guido van Rossum79f25d91997-04-29 20:08:16 +00003481static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003482imp_find_module(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003483{
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003484 PyObject *name, *path_list = NULL;
3485 if (!PyArg_ParseTuple(args, "U|O:find_module",
3486 &name, &path_list))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003487 return NULL;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003488 return call_find_module(name, path_list);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003489}
3490
3491static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003492imp_init_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003493{
Victor Stinner95872862011-03-07 18:20:56 +01003494 PyObject *name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003495 int ret;
3496 PyObject *m;
Victor Stinner95872862011-03-07 18:20:56 +01003497 if (!PyArg_ParseTuple(args, "U:init_builtin", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003498 return NULL;
3499 ret = init_builtin(name);
3500 if (ret < 0)
3501 return NULL;
3502 if (ret == 0) {
3503 Py_INCREF(Py_None);
3504 return Py_None;
3505 }
Victor Stinner95872862011-03-07 18:20:56 +01003506 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003507 Py_XINCREF(m);
3508 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003509}
3510
Guido van Rossum79f25d91997-04-29 20:08:16 +00003511static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003512imp_init_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003513{
Victor Stinner53dc7352011-03-20 01:50:21 +01003514 PyObject *name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003515 int ret;
3516 PyObject *m;
Victor Stinner53dc7352011-03-20 01:50:21 +01003517 if (!PyArg_ParseTuple(args, "U:init_frozen", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003518 return NULL;
Victor Stinner53dc7352011-03-20 01:50:21 +01003519 ret = PyImport_ImportFrozenModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003520 if (ret < 0)
3521 return NULL;
3522 if (ret == 0) {
3523 Py_INCREF(Py_None);
3524 return Py_None;
3525 }
Victor Stinner53dc7352011-03-20 01:50:21 +01003526 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003527 Py_XINCREF(m);
3528 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003529}
3530
Guido van Rossum79f25d91997-04-29 20:08:16 +00003531static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003532imp_get_frozen_object(PyObject *self, PyObject *args)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00003533{
Victor Stinner53dc7352011-03-20 01:50:21 +01003534 PyObject *name;
Jack Jansen95ffa231995-10-03 14:38:41 +00003535
Victor Stinner53dc7352011-03-20 01:50:21 +01003536 if (!PyArg_ParseTuple(args, "U:get_frozen_object", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003537 return NULL;
3538 return get_frozen_object(name);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00003539}
3540
Guido van Rossum79f25d91997-04-29 20:08:16 +00003541static PyObject *
Brett Cannon8d110132009-03-15 02:20:16 +00003542imp_is_frozen_package(PyObject *self, PyObject *args)
3543{
Victor Stinner53dc7352011-03-20 01:50:21 +01003544 PyObject *name;
Brett Cannon8d110132009-03-15 02:20:16 +00003545
Victor Stinner53dc7352011-03-20 01:50:21 +01003546 if (!PyArg_ParseTuple(args, "U:is_frozen_package", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003547 return NULL;
3548 return is_frozen_package(name);
Brett Cannon8d110132009-03-15 02:20:16 +00003549}
3550
3551static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003552imp_is_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003553{
Victor Stinner95872862011-03-07 18:20:56 +01003554 PyObject *name;
3555 if (!PyArg_ParseTuple(args, "U:is_builtin", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003556 return NULL;
3557 return PyLong_FromLong(is_builtin(name));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003558}
3559
Guido van Rossum79f25d91997-04-29 20:08:16 +00003560static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003561imp_is_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003562{
Victor Stinner53dc7352011-03-20 01:50:21 +01003563 PyObject *name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003564 struct _frozen *p;
Victor Stinner53dc7352011-03-20 01:50:21 +01003565 if (!PyArg_ParseTuple(args, "U:is_frozen", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003566 return NULL;
3567 p = find_frozen(name);
3568 return PyBool_FromLong((long) (p == NULL ? 0 : p->size));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003569}
3570
3571static FILE *
Victor Stinner2f42ae52011-03-20 00:41:24 +01003572get_file(PyObject *pathname, PyObject *fob, char *mode)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003573{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003574 FILE *fp;
3575 if (mode[0] == 'U')
3576 mode = "r" PY_STDIOTEXTMODE;
3577 if (fob == NULL) {
Victor Stinner2f42ae52011-03-20 00:41:24 +01003578 fp = _Py_fopen(pathname, mode);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003579 }
3580 else {
3581 int fd = PyObject_AsFileDescriptor(fob);
3582 if (fd == -1)
3583 return NULL;
3584 if (!_PyVerify_fd(fd))
3585 goto error;
3586 /* the FILE struct gets a new fd, so that it can be closed
3587 * independently of the file descriptor given
3588 */
3589 fd = dup(fd);
3590 if (fd == -1)
3591 goto error;
3592 fp = fdopen(fd, mode);
3593 }
3594 if (fp)
3595 return fp;
Kristján Valur Jónssone1b04452009-03-31 17:43:39 +00003596error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003597 PyErr_SetFromErrno(PyExc_IOError);
3598 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003599}
3600
Guido van Rossum79f25d91997-04-29 20:08:16 +00003601static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003602imp_load_compiled(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003603{
Victor Stinner2f42ae52011-03-20 00:41:24 +01003604 PyObject *name, *pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003605 PyObject *fob = NULL;
3606 PyObject *m;
3607 FILE *fp;
Victor Stinner2f42ae52011-03-20 00:41:24 +01003608 if (!PyArg_ParseTuple(args, "UO&|O:load_compiled",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003609 &name,
Victor Stinner2f42ae52011-03-20 00:41:24 +01003610 PyUnicode_FSDecoder, &pathname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003611 &fob))
3612 return NULL;
Victor Stinner2f42ae52011-03-20 00:41:24 +01003613 fp = get_file(pathname, fob, "rb");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003614 if (fp == NULL) {
Victor Stinnerebc00522010-12-03 17:06:43 +00003615 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003616 return NULL;
3617 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01003618 m = load_compiled_module(name, pathname, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003619 fclose(fp);
Victor Stinnerebc00522010-12-03 17:06:43 +00003620 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003621 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003622}
3623
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003624#ifdef HAVE_DYNAMIC_LOADING
3625
Guido van Rossum79f25d91997-04-29 20:08:16 +00003626static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003627imp_load_dynamic(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003628{
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003629 PyObject *name, *pathname, *fob = NULL, *mod;
3630 FILE *fp;
3631
3632 if (!PyArg_ParseTuple(args, "UO&|O:load_dynamic",
3633 &name, PyUnicode_FSDecoder, &pathname, &fob))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003634 return NULL;
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003635 if (fob != NULL) {
3636 fp = get_file(NULL, fob, "r");
3637 if (fp == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003638 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003639 }
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003640 else
3641 fp = NULL;
3642 mod = _PyImport_LoadDynamicModule(name, pathname, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003643 if (fp)
3644 fclose(fp);
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003645 return mod;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003646}
3647
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003648#endif /* HAVE_DYNAMIC_LOADING */
3649
Guido van Rossum79f25d91997-04-29 20:08:16 +00003650static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003651imp_load_source(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003652{
Victor Stinner2f42ae52011-03-20 00:41:24 +01003653 PyObject *name, *pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003654 PyObject *fob = NULL;
3655 PyObject *m;
3656 FILE *fp;
Victor Stinner2f42ae52011-03-20 00:41:24 +01003657 if (!PyArg_ParseTuple(args, "UO&|O:load_source",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003658 &name,
Victor Stinner2f42ae52011-03-20 00:41:24 +01003659 PyUnicode_FSDecoder, &pathname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003660 &fob))
3661 return NULL;
Victor Stinner2f42ae52011-03-20 00:41:24 +01003662 fp = get_file(pathname, fob, "r");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003663 if (fp == NULL) {
Victor Stinnerebc00522010-12-03 17:06:43 +00003664 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003665 return NULL;
3666 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01003667 m = load_source_module(name, pathname, fp);
Victor Stinnerebc00522010-12-03 17:06:43 +00003668 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003669 fclose(fp);
3670 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003671}
3672
Guido van Rossum79f25d91997-04-29 20:08:16 +00003673static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003674imp_load_module(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003675{
Victor Stinner41c5fec2011-03-13 21:46:30 -04003676 PyObject *name, *fob, *pathname, *ret;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003677 char *suffix; /* Unused */
3678 char *mode;
3679 int type;
3680 FILE *fp;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003681
Victor Stinner41c5fec2011-03-13 21:46:30 -04003682 if (!PyArg_ParseTuple(args, "UOO&(ssi):load_module",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003683 &name, &fob,
Victor Stinner41c5fec2011-03-13 21:46:30 -04003684 PyUnicode_FSDecoder, &pathname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003685 &suffix, &mode, &type))
3686 return NULL;
3687 if (*mode) {
3688 /* Mode must start with 'r' or 'U' and must not contain '+'.
3689 Implicit in this test is the assumption that the mode
3690 may contain other modifiers like 'b' or 't'. */
Guido van Rossum5e2c5fa2002-05-30 17:33:07 +00003691
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003692 if (!(*mode == 'r' || *mode == 'U') || strchr(mode, '+')) {
3693 PyErr_Format(PyExc_ValueError,
3694 "invalid file open mode %.200s", mode);
Victor Stinner1a563032010-10-15 22:43:10 +00003695 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003696 return NULL;
3697 }
3698 }
3699 if (fob == Py_None)
3700 fp = NULL;
3701 else {
3702 fp = get_file(NULL, fob, mode);
3703 if (fp == NULL) {
Victor Stinner1a563032010-10-15 22:43:10 +00003704 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003705 return NULL;
3706 }
3707 }
Victor Stinner41c5fec2011-03-13 21:46:30 -04003708 ret = load_module(name, fp, pathname, type, NULL);
Victor Stinner1a563032010-10-15 22:43:10 +00003709 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003710 if (fp)
3711 fclose(fp);
3712 return ret;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003713}
3714
3715static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003716imp_load_package(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003717{
Victor Stinnerc9abda02011-03-14 13:33:46 -04003718 PyObject *name, *pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003719 PyObject * ret;
Victor Stinnerc9abda02011-03-14 13:33:46 -04003720 if (!PyArg_ParseTuple(args, "UO&:load_package",
3721 &name, PyUnicode_FSDecoder, &pathname))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003722 return NULL;
Victor Stinnerc9abda02011-03-14 13:33:46 -04003723 ret = load_package(name, pathname);
Victor Stinnerebc00522010-12-03 17:06:43 +00003724 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003725 return ret;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003726}
3727
3728static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003729imp_new_module(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003730{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003731 char *name;
3732 if (!PyArg_ParseTuple(args, "s:new_module", &name))
3733 return NULL;
3734 return PyModule_New(name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003735}
3736
Christian Heimes13a7a212008-01-07 17:13:09 +00003737static PyObject *
3738imp_reload(PyObject *self, PyObject *v)
3739{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003740 return PyImport_ReloadModule(v);
Christian Heimes13a7a212008-01-07 17:13:09 +00003741}
3742
3743PyDoc_STRVAR(doc_reload,
3744"reload(module) -> module\n\
3745\n\
3746Reload the module. The module must have been successfully imported before.");
3747
Barry Warsaw28a691b2010-04-17 00:19:56 +00003748static PyObject *
3749imp_cache_from_source(PyObject *self, PyObject *args, PyObject *kws)
3750{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003751 static char *kwlist[] = {"path", "debug_override", NULL};
Barry Warsaw28a691b2010-04-17 00:19:56 +00003752
Victor Stinner2f42ae52011-03-20 00:41:24 +01003753 PyObject *pathname, *cpathname;
Benjamin Peterson294a9fc2010-10-16 03:12:39 +00003754 PyObject *debug_override = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003755 int debug = !Py_OptimizeFlag;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003756
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003757 if (!PyArg_ParseTupleAndKeywords(
Victor Stinner3ea23dd2010-10-15 20:34:32 +00003758 args, kws, "O&|O", kwlist,
Victor Stinner2f42ae52011-03-20 00:41:24 +01003759 PyUnicode_FSDecoder, &pathname, &debug_override))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003760 return NULL;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003761
Benjamin Peterson294a9fc2010-10-16 03:12:39 +00003762 if (debug_override != NULL &&
3763 (debug = PyObject_IsTrue(debug_override)) < 0) {
Victor Stinner2f42ae52011-03-20 00:41:24 +01003764 Py_DECREF(pathname);
Benjamin Peterson294a9fc2010-10-16 03:12:39 +00003765 return NULL;
3766 }
Barry Warsaw28a691b2010-04-17 00:19:56 +00003767
Victor Stinner3ea23dd2010-10-15 20:34:32 +00003768 cpathname = make_compiled_pathname(
Victor Stinner2f42ae52011-03-20 00:41:24 +01003769 PyUnicode_AS_UNICODE(pathname),
3770 debug);
3771 Py_DECREF(pathname);
Barry Warsaw28a691b2010-04-17 00:19:56 +00003772
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003773 if (cpathname == NULL) {
3774 PyErr_Format(PyExc_SystemError, "path buffer too short");
3775 return NULL;
3776 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01003777 return cpathname;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003778}
3779
3780PyDoc_STRVAR(doc_cache_from_source,
3781"Given the path to a .py file, return the path to its .pyc/.pyo file.\n\
3782\n\
3783The .py file does not need to exist; this simply returns the path to the\n\
3784.pyc/.pyo file calculated as if the .py file were imported. The extension\n\
3785will be .pyc unless __debug__ is not defined, then it will be .pyo.\n\
3786\n\
3787If debug_override is not None, then it must be a boolean and is taken as\n\
3788the value of __debug__ instead.");
3789
3790static PyObject *
3791imp_source_from_cache(PyObject *self, PyObject *args, PyObject *kws)
3792{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003793 static char *kwlist[] = {"path", NULL};
Victor Stinnerc9abda02011-03-14 13:33:46 -04003794 PyObject *pathname, *source;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003795
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003796 if (!PyArg_ParseTupleAndKeywords(
Victor Stinnerebc00522010-12-03 17:06:43 +00003797 args, kws, "O&", kwlist,
Victor Stinnerc9abda02011-03-14 13:33:46 -04003798 PyUnicode_FSDecoder, &pathname))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003799 return NULL;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003800
Victor Stinnerc9abda02011-03-14 13:33:46 -04003801 source = make_source_pathname(pathname);
3802 if (source == NULL) {
3803 PyErr_Format(PyExc_ValueError, "Not a PEP 3147 pyc path: %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003804 pathname);
Victor Stinnerc9abda02011-03-14 13:33:46 -04003805 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003806 return NULL;
3807 }
Victor Stinnerc9abda02011-03-14 13:33:46 -04003808 Py_DECREF(pathname);
3809 return source;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003810}
3811
3812PyDoc_STRVAR(doc_source_from_cache,
3813"Given the path to a .pyc./.pyo file, return the path to its .py file.\n\
3814\n\
3815The .pyc/.pyo file does not need to exist; this simply returns the path to\n\
3816the .py file calculated to correspond to the .pyc/.pyo file. If path\n\
3817does not conform to PEP 3147 format, ValueError will be raised.");
3818
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003819/* Doc strings */
3820
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003821PyDoc_STRVAR(doc_imp,
3822"This module provides the components needed to build your own\n\
3823__import__ function. Undocumented functions are obsolete.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003824
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003825PyDoc_STRVAR(doc_find_module,
3826"find_module(name, [path]) -> (file, filename, (suffix, mode, type))\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003827Search for a module. If path is omitted or None, search for a\n\
3828built-in, frozen or special module and continue search in sys.path.\n\
3829The module name cannot contain '.'; to search for a submodule of a\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003830package, pass the submodule name and the package's __path__.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003831
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003832PyDoc_STRVAR(doc_load_module,
3833"load_module(name, file, filename, (suffix, mode, type)) -> module\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003834Load a module, given information returned by find_module().\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003835The module name must include the full package name, if any.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003836
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003837PyDoc_STRVAR(doc_get_magic,
3838"get_magic() -> string\n\
3839Return the magic number for .pyc or .pyo files.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003840
Barry Warsaw28a691b2010-04-17 00:19:56 +00003841PyDoc_STRVAR(doc_get_tag,
3842"get_tag() -> string\n\
3843Return the magic tag for .pyc or .pyo files.");
3844
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003845PyDoc_STRVAR(doc_get_suffixes,
3846"get_suffixes() -> [(suffix, mode, type), ...]\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003847Return a list of (suffix, mode, type) tuples describing the files\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003848that find_module() looks for.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003849
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003850PyDoc_STRVAR(doc_new_module,
3851"new_module(name) -> module\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003852Create a new module. Do not enter it in sys.modules.\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003853The module name must include the full package name, if any.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003854
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003855PyDoc_STRVAR(doc_lock_held,
Tim Petersa7c65092004-08-01 23:26:05 +00003856"lock_held() -> boolean\n\
3857Return True if the import lock is currently held, else False.\n\
3858On platforms without threads, return False.");
Tim Peters69232342001-08-30 05:16:13 +00003859
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00003860PyDoc_STRVAR(doc_acquire_lock,
3861"acquire_lock() -> None\n\
Neal Norwitz2294c0d2003-02-12 23:02:21 +00003862Acquires the interpreter's import lock for the current thread.\n\
3863This lock should be used by import hooks to ensure thread-safety\n\
3864when importing modules.\n\
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00003865On platforms without threads, this function does nothing.");
3866
3867PyDoc_STRVAR(doc_release_lock,
3868"release_lock() -> None\n\
3869Release the interpreter's import lock.\n\
3870On platforms without threads, this function does nothing.");
3871
Guido van Rossum79f25d91997-04-29 20:08:16 +00003872static PyMethodDef imp_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003873 {"find_module", imp_find_module, METH_VARARGS, doc_find_module},
3874 {"get_magic", imp_get_magic, METH_NOARGS, doc_get_magic},
3875 {"get_tag", imp_get_tag, METH_NOARGS, doc_get_tag},
3876 {"get_suffixes", imp_get_suffixes, METH_NOARGS, doc_get_suffixes},
3877 {"load_module", imp_load_module, METH_VARARGS, doc_load_module},
3878 {"new_module", imp_new_module, METH_VARARGS, doc_new_module},
3879 {"lock_held", imp_lock_held, METH_NOARGS, doc_lock_held},
3880 {"acquire_lock", imp_acquire_lock, METH_NOARGS, doc_acquire_lock},
3881 {"release_lock", imp_release_lock, METH_NOARGS, doc_release_lock},
3882 {"reload", imp_reload, METH_O, doc_reload},
3883 {"cache_from_source", (PyCFunction)imp_cache_from_source,
3884 METH_VARARGS | METH_KEYWORDS, doc_cache_from_source},
3885 {"source_from_cache", (PyCFunction)imp_source_from_cache,
3886 METH_VARARGS | METH_KEYWORDS, doc_source_from_cache},
3887 /* The rest are obsolete */
3888 {"get_frozen_object", imp_get_frozen_object, METH_VARARGS},
3889 {"is_frozen_package", imp_is_frozen_package, METH_VARARGS},
3890 {"init_builtin", imp_init_builtin, METH_VARARGS},
3891 {"init_frozen", imp_init_frozen, METH_VARARGS},
3892 {"is_builtin", imp_is_builtin, METH_VARARGS},
3893 {"is_frozen", imp_is_frozen, METH_VARARGS},
3894 {"load_compiled", imp_load_compiled, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003895#ifdef HAVE_DYNAMIC_LOADING
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003896 {"load_dynamic", imp_load_dynamic, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003897#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003898 {"load_package", imp_load_package, METH_VARARGS},
3899 {"load_source", imp_load_source, METH_VARARGS},
3900 {NULL, NULL} /* sentinel */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003901};
3902
Guido van Rossum1a8791e1998-08-04 22:46:29 +00003903static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003904setint(PyObject *d, char *name, int value)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003905{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003906 PyObject *v;
3907 int err;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003908
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003909 v = PyLong_FromLong((long)value);
3910 err = PyDict_SetItemString(d, name, v);
3911 Py_XDECREF(v);
3912 return err;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003913}
3914
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003915typedef struct {
3916 PyObject_HEAD
3917} NullImporter;
3918
3919static int
3920NullImporter_init(NullImporter *self, PyObject *args, PyObject *kwds)
3921{
Victor Stinner1a4d12d2010-08-13 13:07:29 +00003922#ifndef MS_WINDOWS
3923 PyObject *path;
3924 struct stat statbuf;
3925 int rv;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003926
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003927 if (!_PyArg_NoKeywords("NullImporter()", kwds))
3928 return -1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003929
Victor Stinner1a4d12d2010-08-13 13:07:29 +00003930 if (!PyArg_ParseTuple(args, "O&:NullImporter",
3931 PyUnicode_FSConverter, &path))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003932 return -1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003933
Victor Stinner1a4d12d2010-08-13 13:07:29 +00003934 if (PyBytes_GET_SIZE(path) == 0) {
3935 Py_DECREF(path);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003936 PyErr_SetString(PyExc_ImportError, "empty pathname");
3937 return -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003938 }
Victor Stinner1a4d12d2010-08-13 13:07:29 +00003939
3940 rv = stat(PyBytes_AS_STRING(path), &statbuf);
3941 Py_DECREF(path);
3942 if (rv == 0) {
3943 /* it exists */
3944 if (S_ISDIR(statbuf.st_mode)) {
3945 /* it's a directory */
3946 PyErr_SetString(PyExc_ImportError, "existing directory");
3947 return -1;
3948 }
3949 }
3950#else /* MS_WINDOWS */
3951 PyObject *pathobj;
3952 DWORD rv;
Victor Stinner255dfdb2010-09-29 10:28:51 +00003953 wchar_t *path;
Victor Stinner1a4d12d2010-08-13 13:07:29 +00003954
3955 if (!_PyArg_NoKeywords("NullImporter()", kwds))
3956 return -1;
3957
3958 if (!PyArg_ParseTuple(args, "U:NullImporter",
3959 &pathobj))
3960 return -1;
3961
3962 if (PyUnicode_GET_SIZE(pathobj) == 0) {
3963 PyErr_SetString(PyExc_ImportError, "empty pathname");
3964 return -1;
3965 }
3966
Victor Stinnerbeb4135b2010-10-07 01:02:42 +00003967 path = PyUnicode_AsWideCharString(pathobj, NULL);
Victor Stinner255dfdb2010-09-29 10:28:51 +00003968 if (path == NULL)
Victor Stinner1a4d12d2010-08-13 13:07:29 +00003969 return -1;
3970 /* see issue1293 and issue3677:
3971 * stat() on Windows doesn't recognise paths like
3972 * "e:\\shared\\" and "\\\\whiterab-c2znlh\\shared" as dirs.
3973 */
3974 rv = GetFileAttributesW(path);
Victor Stinner255dfdb2010-09-29 10:28:51 +00003975 PyMem_Free(path);
Victor Stinner1a4d12d2010-08-13 13:07:29 +00003976 if (rv != INVALID_FILE_ATTRIBUTES) {
3977 /* it exists */
3978 if (rv & FILE_ATTRIBUTE_DIRECTORY) {
3979 /* it's a directory */
3980 PyErr_SetString(PyExc_ImportError, "existing directory");
3981 return -1;
3982 }
3983 }
3984#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003985 return 0;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003986}
3987
3988static PyObject *
3989NullImporter_find_module(NullImporter *self, PyObject *args)
3990{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003991 Py_RETURN_NONE;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003992}
3993
3994static PyMethodDef NullImporter_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003995 {"find_module", (PyCFunction)NullImporter_find_module, METH_VARARGS,
3996 "Always return None"
3997 },
3998 {NULL} /* Sentinel */
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003999};
4000
4001
Christian Heimes9cd17752007-11-18 19:35:23 +00004002PyTypeObject PyNullImporter_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004003 PyVarObject_HEAD_INIT(NULL, 0)
4004 "imp.NullImporter", /*tp_name*/
4005 sizeof(NullImporter), /*tp_basicsize*/
4006 0, /*tp_itemsize*/
4007 0, /*tp_dealloc*/
4008 0, /*tp_print*/
4009 0, /*tp_getattr*/
4010 0, /*tp_setattr*/
4011 0, /*tp_reserved*/
4012 0, /*tp_repr*/
4013 0, /*tp_as_number*/
4014 0, /*tp_as_sequence*/
4015 0, /*tp_as_mapping*/
4016 0, /*tp_hash */
4017 0, /*tp_call*/
4018 0, /*tp_str*/
4019 0, /*tp_getattro*/
4020 0, /*tp_setattro*/
4021 0, /*tp_as_buffer*/
4022 Py_TPFLAGS_DEFAULT, /*tp_flags*/
4023 "Null importer object", /* tp_doc */
4024 0, /* tp_traverse */
4025 0, /* tp_clear */
4026 0, /* tp_richcompare */
4027 0, /* tp_weaklistoffset */
4028 0, /* tp_iter */
4029 0, /* tp_iternext */
4030 NullImporter_methods, /* tp_methods */
4031 0, /* tp_members */
4032 0, /* tp_getset */
4033 0, /* tp_base */
4034 0, /* tp_dict */
4035 0, /* tp_descr_get */
4036 0, /* tp_descr_set */
4037 0, /* tp_dictoffset */
4038 (initproc)NullImporter_init, /* tp_init */
4039 0, /* tp_alloc */
4040 PyType_GenericNew /* tp_new */
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004041};
4042
Martin v. Löwis1a214512008-06-11 05:26:20 +00004043static struct PyModuleDef impmodule = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004044 PyModuleDef_HEAD_INIT,
4045 "imp",
4046 doc_imp,
4047 0,
4048 imp_methods,
4049 NULL,
4050 NULL,
4051 NULL,
4052 NULL
Martin v. Löwis1a214512008-06-11 05:26:20 +00004053};
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004054
Jason Tishler6bc06ec2003-09-04 11:59:50 +00004055PyMODINIT_FUNC
Martin v. Löwis1a214512008-06-11 05:26:20 +00004056PyInit_imp(void)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004057{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004058 PyObject *m, *d;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004059
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004060 if (PyType_Ready(&PyNullImporter_Type) < 0)
4061 return NULL;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004062
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004063 m = PyModule_Create(&impmodule);
4064 if (m == NULL)
4065 goto failure;
4066 d = PyModule_GetDict(m);
4067 if (d == NULL)
4068 goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004069
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004070 if (setint(d, "SEARCH_ERROR", SEARCH_ERROR) < 0) goto failure;
4071 if (setint(d, "PY_SOURCE", PY_SOURCE) < 0) goto failure;
4072 if (setint(d, "PY_COMPILED", PY_COMPILED) < 0) goto failure;
4073 if (setint(d, "C_EXTENSION", C_EXTENSION) < 0) goto failure;
4074 if (setint(d, "PY_RESOURCE", PY_RESOURCE) < 0) goto failure;
4075 if (setint(d, "PKG_DIRECTORY", PKG_DIRECTORY) < 0) goto failure;
4076 if (setint(d, "C_BUILTIN", C_BUILTIN) < 0) goto failure;
4077 if (setint(d, "PY_FROZEN", PY_FROZEN) < 0) goto failure;
4078 if (setint(d, "PY_CODERESOURCE", PY_CODERESOURCE) < 0) goto failure;
4079 if (setint(d, "IMP_HOOK", IMP_HOOK) < 0) goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004080
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004081 Py_INCREF(&PyNullImporter_Type);
4082 PyModule_AddObject(m, "NullImporter", (PyObject *)&PyNullImporter_Type);
4083 return m;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00004084 failure:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004085 Py_XDECREF(m);
4086 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004087}
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004088
4089
Guido van Rossumb18618d2000-05-03 23:44:39 +00004090/* API for embedding applications that want to add their own entries
4091 to the table of built-in modules. This should normally be called
4092 *before* Py_Initialize(). When the table resize fails, -1 is
4093 returned and the existing table is unchanged.
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004094
4095 After a similar function by Just van Rossum. */
4096
4097int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00004098PyImport_ExtendInittab(struct _inittab *newtab)
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004099{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004100 static struct _inittab *our_copy = NULL;
4101 struct _inittab *p;
4102 int i, n;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004103
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004104 /* Count the number of entries in both tables */
4105 for (n = 0; newtab[n].name != NULL; n++)
4106 ;
4107 if (n == 0)
4108 return 0; /* Nothing to do */
4109 for (i = 0; PyImport_Inittab[i].name != NULL; i++)
4110 ;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004111
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004112 /* Allocate new memory for the combined table */
4113 p = our_copy;
4114 PyMem_RESIZE(p, struct _inittab, i+n+1);
4115 if (p == NULL)
4116 return -1;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004117
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004118 /* Copy the tables into the new memory */
4119 if (our_copy != PyImport_Inittab)
4120 memcpy(p, PyImport_Inittab, (i+1) * sizeof(struct _inittab));
4121 PyImport_Inittab = our_copy = p;
4122 memcpy(p+i, newtab, (n+1) * sizeof(struct _inittab));
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004123
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004124 return 0;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004125}
4126
4127/* Shorthand to add a single entry given a name and a function */
4128
4129int
Brett Cannona826f322009-04-02 03:41:46 +00004130PyImport_AppendInittab(const char *name, PyObject* (*initfunc)(void))
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004131{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004132 struct _inittab newtab[2];
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004133
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004134 memset(newtab, '\0', sizeof newtab);
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004135
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004136 newtab[0].name = (char *)name;
4137 newtab[0].initfunc = initfunc;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004138
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004139 return PyImport_ExtendInittab(newtab);
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004140}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00004141
4142#ifdef __cplusplus
4143}
4144#endif