blob: a3f263146c70953ed30094a3576d84907627c24c [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 Stinnerad3c03b2011-03-14 09:21:33 -04001541 fdp = find_module(name, initstr, path_list, buf, sizeof(buf), &fp, NULL);
Victor Stinnerc9abda02011-03-14 13:33:46 -04001542 Py_DECREF(path_list);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001543 if (fdp == NULL) {
1544 if (PyErr_ExceptionMatches(PyExc_ImportError)) {
1545 PyErr_Clear();
1546 Py_INCREF(m);
Victor Stinnerc9abda02011-03-14 13:33:46 -04001547 return m;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001548 }
1549 else
Victor Stinnerc9abda02011-03-14 13:33:46 -04001550 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001551 }
Victor Stinner41c5fec2011-03-13 21:46:30 -04001552 bufobj = PyUnicode_DecodeFSDefault(buf);
1553 if (bufobj != NULL) {
1554 m = load_module(name, fp, bufobj, fdp->type, NULL);
1555 Py_DECREF(bufobj);
1556 }
1557 else
1558 m = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001559 if (fp != NULL)
1560 fclose(fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001561 return m;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001562}
1563
1564
1565/* Helper to test for built-in module */
1566
1567static int
Victor Stinner95872862011-03-07 18:20:56 +01001568is_builtin(PyObject *name)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001569{
Victor Stinner95872862011-03-07 18:20:56 +01001570 int i, cmp;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001571 for (i = 0; PyImport_Inittab[i].name != NULL; i++) {
Victor Stinner95872862011-03-07 18:20:56 +01001572 cmp = PyUnicode_CompareWithASCIIString(name, PyImport_Inittab[i].name);
1573 if (cmp == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001574 if (PyImport_Inittab[i].initfunc == NULL)
1575 return -1;
1576 else
1577 return 1;
1578 }
1579 }
1580 return 0;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001581}
1582
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001583
Just van Rossum52e14d62002-12-30 22:08:05 +00001584/* Return an importer object for a sys.path/pkg.__path__ item 'p',
1585 possibly by fetching it from the path_importer_cache dict. If it
Thomas Wouters89f507f2006-12-13 04:49:30 +00001586 wasn't yet cached, traverse path_hooks until a hook is found
Just van Rossum52e14d62002-12-30 22:08:05 +00001587 that can handle the path item. Return None if no hook could;
1588 this tells our caller it should fall back to the builtin
1589 import mechanism. Cache the result in path_importer_cache.
1590 Returns a borrowed reference. */
1591
1592static PyObject *
1593get_path_importer(PyObject *path_importer_cache, PyObject *path_hooks,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001594 PyObject *p)
Just van Rossum52e14d62002-12-30 22:08:05 +00001595{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001596 PyObject *importer;
1597 Py_ssize_t j, nhooks;
Just van Rossum52e14d62002-12-30 22:08:05 +00001598
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001599 /* These conditions are the caller's responsibility: */
1600 assert(PyList_Check(path_hooks));
1601 assert(PyDict_Check(path_importer_cache));
Just van Rossum52e14d62002-12-30 22:08:05 +00001602
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001603 nhooks = PyList_Size(path_hooks);
1604 if (nhooks < 0)
1605 return NULL; /* Shouldn't happen */
Just van Rossum52e14d62002-12-30 22:08:05 +00001606
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001607 importer = PyDict_GetItem(path_importer_cache, p);
1608 if (importer != NULL)
1609 return importer;
Just van Rossum52e14d62002-12-30 22:08:05 +00001610
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001611 /* set path_importer_cache[p] to None to avoid recursion */
1612 if (PyDict_SetItem(path_importer_cache, p, Py_None) != 0)
1613 return NULL;
Just van Rossum52e14d62002-12-30 22:08:05 +00001614
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001615 for (j = 0; j < nhooks; j++) {
1616 PyObject *hook = PyList_GetItem(path_hooks, j);
1617 if (hook == NULL)
1618 return NULL;
1619 importer = PyObject_CallFunctionObjArgs(hook, p, NULL);
1620 if (importer != NULL)
1621 break;
Just van Rossum52e14d62002-12-30 22:08:05 +00001622
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001623 if (!PyErr_ExceptionMatches(PyExc_ImportError)) {
1624 return NULL;
1625 }
1626 PyErr_Clear();
1627 }
1628 if (importer == NULL) {
1629 importer = PyObject_CallFunctionObjArgs(
1630 (PyObject *)&PyNullImporter_Type, p, NULL
1631 );
1632 if (importer == NULL) {
1633 if (PyErr_ExceptionMatches(PyExc_ImportError)) {
1634 PyErr_Clear();
1635 return Py_None;
1636 }
1637 }
1638 }
1639 if (importer != NULL) {
1640 int err = PyDict_SetItem(path_importer_cache, p, importer);
1641 Py_DECREF(importer);
1642 if (err != 0)
1643 return NULL;
1644 }
1645 return importer;
Just van Rossum52e14d62002-12-30 22:08:05 +00001646}
1647
Christian Heimes9cd17752007-11-18 19:35:23 +00001648PyAPI_FUNC(PyObject *)
1649PyImport_GetImporter(PyObject *path) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001650 PyObject *importer=NULL, *path_importer_cache=NULL, *path_hooks=NULL;
Christian Heimes9cd17752007-11-18 19:35:23 +00001651
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001652 if ((path_importer_cache = PySys_GetObject("path_importer_cache"))) {
1653 if ((path_hooks = PySys_GetObject("path_hooks"))) {
1654 importer = get_path_importer(path_importer_cache,
1655 path_hooks, path);
1656 }
1657 }
1658 Py_XINCREF(importer); /* get_path_importer returns a borrowed reference */
1659 return importer;
Christian Heimes9cd17752007-11-18 19:35:23 +00001660}
1661
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001662/* Search the path (default sys.path) for a module. Return the
1663 corresponding filedescr struct, and (via return arguments) the
1664 pathname and an open file. Return NULL if the module is not found. */
1665
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001666#ifdef MS_COREDLL
Victor Stinner4d6c1c42011-03-08 23:49:04 +01001667extern FILE *_PyWin_FindRegisteredModule(PyObject *, struct filedescr **,
1668 PyObject **p_path);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001669#endif
1670
Victor Stinnerc6963162011-03-12 09:26:54 -05001671static int case_ok(char *, Py_ssize_t, Py_ssize_t, const char *);
Tim Petersdbd9ba62000-07-09 03:09:57 +00001672static int find_init_module(char *); /* Forward */
Just van Rossum52e14d62002-12-30 22:08:05 +00001673static struct filedescr importhookdescr = {"", "", IMP_HOOK};
Guido van Rossum197346f1997-10-31 18:38:52 +00001674
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001675/* Get the path of a module: get its importer and call importer.find_module()
1676 hook, or check if the module if a package (if path/__init__.py exists).
1677
1678 -1: error: a Python error occurred
1679 0: ignore: an error occurred because of invalid data, but the error is not
1680 important enough to be reported.
1681 1: get path: module not found, but *buf contains its path
1682 2: found: *p_fd is the file descriptor (IMP_HOOK or PKG_DIRECTORY)
1683 and *buf is the path */
1684
1685static int
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001686find_module_path(PyObject *fullname, PyObject *name, PyObject *path,
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001687 PyObject *path_hooks, PyObject *path_importer_cache,
1688 char *buf, size_t buflen,
1689 PyObject **p_loader, struct filedescr **p_fd)
1690{
1691 PyObject *path_bytes;
1692 const char *base;
1693 Py_ssize_t len;
1694 size_t namelen;
1695 struct stat statbuf;
1696 static struct filedescr fd_package = {"", "", PKG_DIRECTORY};
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001697 char *namestr;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001698
1699 if (PyUnicode_Check(path)) {
1700 path_bytes = PyUnicode_EncodeFSDefault(path);
1701 if (path_bytes == NULL)
1702 return -1;
1703 }
1704 else if (PyBytes_Check(path)) {
1705 Py_INCREF(path);
1706 path_bytes = path;
1707 }
1708 else
1709 return 0;
1710
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001711 namestr = _PyUnicode_AsString(name);
1712 namelen = strlen(namestr);
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001713 base = PyBytes_AS_STRING(path_bytes);
1714 len = PyBytes_GET_SIZE(path_bytes);
1715 if (len + 2 + namelen + MAXSUFFIXSIZE >= buflen) {
1716 Py_DECREF(path_bytes);
1717 return 0; /* Too long */
1718 }
1719 strcpy(buf, base);
1720 Py_DECREF(path_bytes);
1721
1722 if (strlen(buf) != len) {
1723 return 0; /* path_bytes contains '\0' */
1724 }
1725
1726 /* sys.path_hooks import hook */
1727 if (p_loader != NULL) {
1728 PyObject *importer;
1729
1730 importer = get_path_importer(path_importer_cache,
1731 path_hooks, path);
1732 if (importer == NULL) {
1733 return -1;
1734 }
1735 /* Note: importer is a borrowed reference */
1736 if (importer != Py_None) {
1737 PyObject *loader;
1738 loader = PyObject_CallMethod(importer,
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001739 "find_module", "O", fullname);
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001740 if (loader == NULL)
1741 return -1; /* error */
1742 if (loader != Py_None) {
1743 /* a loader was found */
1744 *p_loader = loader;
1745 *p_fd = &importhookdescr;
1746 return 2;
1747 }
1748 Py_DECREF(loader);
1749 return 0;
1750 }
1751 }
1752 /* no hook was found, use builtin import */
1753
1754 if (len > 0 && buf[len-1] != SEP
1755#ifdef ALTSEP
1756 && buf[len-1] != ALTSEP
1757#endif
1758 )
1759 buf[len++] = SEP;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001760 strcpy(buf+len, namestr);
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001761 len += namelen;
1762
1763 /* Check for package import (buf holds a directory name,
1764 and there's an __init__ module in that directory */
1765#ifdef HAVE_STAT
1766 if (stat(buf, &statbuf) == 0 && /* it exists */
1767 S_ISDIR(statbuf.st_mode) && /* it's a directory */
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001768 case_ok(buf, len, namelen, namestr)) { /* case matches */
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001769 if (find_init_module(buf)) { /* and has __init__.py */
1770 *p_fd = &fd_package;
1771 return 2;
1772 }
1773 else {
1774 int err;
1775 PyObject *unicode = PyUnicode_DecodeFSDefault(buf);
1776 if (unicode == NULL)
1777 return -1;
1778 err = PyErr_WarnFormat(PyExc_ImportWarning, 1,
1779 "Not importing directory '%U': missing __init__.py",
1780 unicode);
1781 Py_DECREF(unicode);
1782 if (err)
1783 return -1;
1784 }
1785 }
1786#endif
1787 return 1;
1788}
1789
1790/* Find a module in search_path_list. For each path, try
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001791 find_module_path() or try each _PyImport_Filetab suffix.
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001792
1793 If the module is found, return a file descriptor, write the path in
1794 *p_filename, write the pointer to the file object into *p_fp, and (if
1795 p_loader is not NULL) the loader into *p_loader.
1796
1797 Otherwise, raise an exception and return NULL. */
1798
Victor Stinner37580282011-03-20 01:34:43 +01001799static struct filedescr*
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001800find_module_path_list(PyObject *fullname, PyObject *name,
Victor Stinner37580282011-03-20 01:34:43 +01001801 PyObject *search_path_list, PyObject *path_hooks,
1802 PyObject *path_importer_cache,
1803 char *buf, size_t buflen,
1804 FILE **p_fp, PyObject **p_loader)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001805{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001806 Py_ssize_t i, npath;
1807 size_t len, namelen;
1808 struct filedescr *fdp = NULL;
1809 char *filemode;
1810 FILE *fp = NULL;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001811 char *namestr;
Victor Stinner53dc7352011-03-20 01:50:21 +01001812
Victor Stinner37580282011-03-20 01:34:43 +01001813 npath = PyList_Size(search_path_list);
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001814 namestr = _PyUnicode_AsString(name);
1815 namelen = strlen(namestr);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001816 for (i = 0; i < npath; i++) {
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001817 PyObject *path;
1818 int ok;
1819
1820 path = PyList_GetItem(search_path_list, i);
1821 if (path == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001822 return NULL;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001823
1824 ok = find_module_path(fullname, name, path,
1825 path_hooks, path_importer_cache,
1826 buf, buflen,
1827 p_loader, &fdp);
1828 if (ok < 0)
1829 return NULL;
1830 if (ok == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001831 continue;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001832 if (ok == 2)
1833 return fdp;
Amaury Forgeot d'Arcf1ca0b12008-06-11 17:40:47 +00001834
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001835 len = strlen(buf);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001836 for (fdp = _PyImport_Filetab; fdp->suffix != NULL; fdp++) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001837 strcpy(buf+len, fdp->suffix);
1838 if (Py_VerboseFlag > 1)
1839 PySys_WriteStderr("# trying %s\n", buf);
1840 filemode = fdp->mode;
1841 if (filemode[0] == 'U')
1842 filemode = "r" PY_STDIOTEXTMODE;
1843 fp = fopen(buf, filemode);
1844 if (fp != NULL) {
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001845 if (case_ok(buf, len, namelen, namestr))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001846 break;
1847 else { /* continue search */
1848 fclose(fp);
1849 fp = NULL;
1850 }
1851 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001852 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001853 if (fp != NULL)
1854 break;
1855 }
1856 if (fp == NULL) {
1857 PyErr_Format(PyExc_ImportError,
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001858 "No module named %U", name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001859 return NULL;
1860 }
1861 *p_fp = fp;
1862 return fdp;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001863}
1864
Victor Stinner37580282011-03-20 01:34:43 +01001865/* Find a module:
1866
1867 - try find_module() of each sys.meta_path hook
1868 - try find_frozen()
1869 - try is_builtin()
1870 - try _PyWin_FindRegisteredModule() (Windows only)
1871 - otherwise, call find_module_path_list() with search_path_list (if not
1872 NULL) or sys.path
1873
1874 Return:
1875
1876 - &fd_builtin (C_BUILTIN) if it is a builtin
1877 - &fd_frozen (PY_FROZEN) if it is frozen
1878 - &fd_package (PKG_DIRECTORY) and write the filename into *buf
1879 if it is a package
1880 - &importhookdescr (IMP_HOOK) and write the loader into *p_loader if a
1881 importer loader was found
1882 - a file descriptor (PY_SOURCE, PY_COMPILED, C_EXTENSION, PY_RESOURCE or
1883 PY_CODERESOURCE: see _PyImport_Filetab), write the filename into
1884 *buf and the pointer to the open file into *p_fp
1885 - NULL on error
1886
1887 By default, write an empty string into *buf, and *p_fp and *p_loader (if
1888 set) are set to NULL. Eg. *buf is an empty string for a builtin package. */
1889
1890static struct filedescr *
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001891find_module(PyObject *fullname, PyObject *name, PyObject *search_path_list,
Victor Stinner37580282011-03-20 01:34:43 +01001892 char *buf, size_t buflen, FILE **p_fp, PyObject **p_loader)
1893{
1894 Py_ssize_t i, npath;
1895 static struct filedescr fd_frozen = {"", "", PY_FROZEN};
1896 static struct filedescr fd_builtin = {"", "", C_BUILTIN};
1897 PyObject *path_hooks, *path_importer_cache;
Victor Stinner37580282011-03-20 01:34:43 +01001898
1899 *buf = '\0';
1900 *p_fp = NULL;
1901 if (p_loader != NULL)
1902 *p_loader = NULL;
1903
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001904 if (PyUnicode_GET_SIZE(name) > MAXPATHLEN) {
Victor Stinner37580282011-03-20 01:34:43 +01001905 PyErr_SetString(PyExc_OverflowError,
1906 "module name is too long");
1907 return NULL;
1908 }
1909
1910 /* sys.meta_path import hook */
1911 if (p_loader != NULL) {
1912 PyObject *meta_path;
1913
1914 meta_path = PySys_GetObject("meta_path");
1915 if (meta_path == NULL || !PyList_Check(meta_path)) {
1916 PyErr_SetString(PyExc_ImportError,
1917 "sys.meta_path must be a list of "
1918 "import hooks");
1919 return NULL;
1920 }
1921 Py_INCREF(meta_path); /* zap guard */
1922 npath = PyList_Size(meta_path);
1923 for (i = 0; i < npath; i++) {
1924 PyObject *loader;
1925 PyObject *hook = PyList_GetItem(meta_path, i);
1926 loader = PyObject_CallMethod(hook, "find_module",
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001927 "OO", fullname,
Victor Stinner37580282011-03-20 01:34:43 +01001928 search_path_list != NULL ?
1929 search_path_list : Py_None);
1930 if (loader == NULL) {
1931 Py_DECREF(meta_path);
1932 return NULL; /* true error */
1933 }
1934 if (loader != Py_None) {
1935 /* a loader was found */
1936 *p_loader = loader;
1937 Py_DECREF(meta_path);
1938 return &importhookdescr;
1939 }
1940 Py_DECREF(loader);
1941 }
1942 Py_DECREF(meta_path);
1943 }
1944
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001945 if (find_frozen(fullname) != NULL) {
1946 strcpy(buf, _PyUnicode_AsString(fullname));
1947 return &fd_frozen;
Victor Stinner37580282011-03-20 01:34:43 +01001948 }
1949
1950 if (search_path_list == NULL) {
1951#ifdef MS_COREDLL
1952 FILE *fp;
1953 struct filedescr *fdp;
1954 PyObject *filename, *filename_bytes;
1955#endif
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001956 if (is_builtin(name)) {
1957 strcpy(buf, _PyUnicode_AsString(name));
Victor Stinner37580282011-03-20 01:34:43 +01001958 return &fd_builtin;
1959 }
1960#ifdef MS_COREDLL
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001961 fp = _PyWin_FindRegisteredModule(name, &fdp, &filename);
Victor Stinner37580282011-03-20 01:34:43 +01001962 if (fp != NULL) {
Victor Stinner37580282011-03-20 01:34:43 +01001963 filename_bytes = PyUnicode_EncodeFSDefault(filename);
1964 Py_DECREF(filename);
1965 if (filename_bytes == NULL)
1966 return NULL;
1967 strncpy(buf, PyBytes_AS_STRING(filename_bytes), buflen);
1968 buf[buflen-1] = '\0';
1969 Py_DECREF(filename_bytes);
1970 *p_fp = fp;
1971 return fdp;
1972 }
1973 else if (PyErr_Occurred())
1974 return NULL;
1975#endif
Victor Stinner37580282011-03-20 01:34:43 +01001976 search_path_list = PySys_GetObject("path");
1977 }
1978
1979 if (search_path_list == NULL || !PyList_Check(search_path_list)) {
1980 PyErr_SetString(PyExc_ImportError,
1981 "sys.path must be a list of directory names");
1982 return NULL;
1983 }
1984
1985 path_hooks = PySys_GetObject("path_hooks");
1986 if (path_hooks == NULL || !PyList_Check(path_hooks)) {
1987 PyErr_SetString(PyExc_ImportError,
1988 "sys.path_hooks must be a list of "
1989 "import hooks");
1990 return NULL;
1991 }
1992 path_importer_cache = PySys_GetObject("path_importer_cache");
1993 if (path_importer_cache == NULL ||
1994 !PyDict_Check(path_importer_cache)) {
1995 PyErr_SetString(PyExc_ImportError,
1996 "sys.path_importer_cache must be a dict");
1997 return NULL;
1998 }
1999
2000 return find_module_path_list(fullname, name,
2001 search_path_list, path_hooks,
2002 path_importer_cache,
2003 buf, buflen,
2004 p_fp, p_loader);
2005}
2006
Martin v. Löwis18e16552006-02-15 17:27:45 +00002007/* case_ok(char* buf, Py_ssize_t len, Py_ssize_t namelen, char* name)
Tim Petersd1e87a82001-03-01 18:12:00 +00002008 * The arguments here are tricky, best shown by example:
2009 * /a/b/c/d/e/f/g/h/i/j/k/some_long_module_name.py\0
2010 * ^ ^ ^ ^
2011 * |--------------------- buf ---------------------|
2012 * |------------------- len ------------------|
2013 * |------ name -------|
2014 * |----- namelen -----|
2015 * buf is the full path, but len only counts up to (& exclusive of) the
2016 * extension. name is the module name, also exclusive of extension.
2017 *
2018 * We've already done a successful stat() or fopen() on buf, so know that
2019 * there's some match, possibly case-insensitive.
2020 *
Tim Peters50d8d372001-02-28 05:34:27 +00002021 * case_ok() is to return 1 if there's a case-sensitive match for
2022 * name, else 0. case_ok() is also to return 1 if envar PYTHONCASEOK
2023 * exists.
Tim Petersd1e87a82001-03-01 18:12:00 +00002024 *
Tim Peters50d8d372001-02-28 05:34:27 +00002025 * case_ok() is used to implement case-sensitive import semantics even
2026 * on platforms with case-insensitive filesystems. It's trivial to implement
2027 * for case-sensitive filesystems. It's pretty much a cross-platform
2028 * nightmare for systems with case-insensitive filesystems.
2029 */
Guido van Rossum0980bd91998-02-13 17:18:36 +00002030
Tim Peters50d8d372001-02-28 05:34:27 +00002031/* First we may need a pile of platform-specific header files; the sequence
2032 * of #if's here should match the sequence in the body of case_ok().
2033 */
Jason Tishler7961aa62005-05-20 00:56:54 +00002034#if defined(MS_WINDOWS)
Guido van Rossum0980bd91998-02-13 17:18:36 +00002035#include <windows.h>
Guido van Rossum4c3f57c2001-01-10 20:40:46 +00002036
Tim Peters50d8d372001-02-28 05:34:27 +00002037#elif defined(DJGPP)
2038#include <dir.h>
2039
Jason Tishler7961aa62005-05-20 00:56:54 +00002040#elif (defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) && defined(HAVE_DIRENT_H)
Tim Peters430f5d42001-03-01 01:30:56 +00002041#include <sys/types.h>
2042#include <dirent.h>
2043
Andrew MacIntyred9400542002-02-26 11:41:34 +00002044#elif defined(PYOS_OS2)
2045#define INCL_DOS
2046#define INCL_DOSERRORS
2047#define INCL_NOPMAPI
2048#include <os2.h>
Tim Peters50d8d372001-02-28 05:34:27 +00002049#endif
2050
Guido van Rossum0980bd91998-02-13 17:18:36 +00002051static int
Victor Stinnerc6963162011-03-12 09:26:54 -05002052case_ok(char *buf, Py_ssize_t len, Py_ssize_t namelen, const char *name)
Guido van Rossum0980bd91998-02-13 17:18:36 +00002053{
Tim Peters50d8d372001-02-28 05:34:27 +00002054/* Pick a platform-specific implementation; the sequence of #if's here should
2055 * match the sequence just above.
2056 */
2057
Jason Tishler7961aa62005-05-20 00:56:54 +00002058/* MS_WINDOWS */
2059#if defined(MS_WINDOWS)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002060 WIN32_FIND_DATA data;
2061 HANDLE h;
Tim Peters50d8d372001-02-28 05:34:27 +00002062
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002063 if (Py_GETENV("PYTHONCASEOK") != NULL)
2064 return 1;
Tim Peters50d8d372001-02-28 05:34:27 +00002065
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002066 h = FindFirstFile(buf, &data);
2067 if (h == INVALID_HANDLE_VALUE) {
2068 PyErr_Format(PyExc_NameError,
2069 "Can't find file for module %.100s\n(filename %.300s)",
2070 name, buf);
2071 return 0;
2072 }
2073 FindClose(h);
2074 return strncmp(data.cFileName, name, namelen) == 0;
Tim Peters50d8d372001-02-28 05:34:27 +00002075
2076/* DJGPP */
2077#elif defined(DJGPP)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002078 struct ffblk ffblk;
2079 int done;
Tim Peters50d8d372001-02-28 05:34:27 +00002080
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002081 if (Py_GETENV("PYTHONCASEOK") != NULL)
2082 return 1;
Tim Peters50d8d372001-02-28 05:34:27 +00002083
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002084 done = findfirst(buf, &ffblk, FA_ARCH|FA_RDONLY|FA_HIDDEN|FA_DIREC);
2085 if (done) {
2086 PyErr_Format(PyExc_NameError,
2087 "Can't find file for module %.100s\n(filename %.300s)",
2088 name, buf);
2089 return 0;
2090 }
2091 return strncmp(ffblk.ff_name, name, namelen) == 0;
Guido van Rossum0980bd91998-02-13 17:18:36 +00002092
Jason Tishler7961aa62005-05-20 00:56:54 +00002093/* new-fangled macintosh (macosx) or Cygwin */
2094#elif (defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) && defined(HAVE_DIRENT_H)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002095 DIR *dirp;
2096 struct dirent *dp;
2097 char dirname[MAXPATHLEN + 1];
2098 const int dirlen = len - namelen - 1; /* don't want trailing SEP */
Tim Peters430f5d42001-03-01 01:30:56 +00002099
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002100 if (Py_GETENV("PYTHONCASEOK") != NULL)
2101 return 1;
Tim Petersdbe6ebb2001-03-01 08:47:29 +00002102
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002103 /* Copy the dir component into dirname; substitute "." if empty */
2104 if (dirlen <= 0) {
2105 dirname[0] = '.';
2106 dirname[1] = '\0';
2107 }
2108 else {
2109 assert(dirlen <= MAXPATHLEN);
2110 memcpy(dirname, buf, dirlen);
2111 dirname[dirlen] = '\0';
2112 }
2113 /* Open the directory and search the entries for an exact match. */
2114 dirp = opendir(dirname);
2115 if (dirp) {
2116 char *nameWithExt = buf + len - namelen;
2117 while ((dp = readdir(dirp)) != NULL) {
2118 const int thislen =
Tim Peters430f5d42001-03-01 01:30:56 +00002119#ifdef _DIRENT_HAVE_D_NAMELEN
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002120 dp->d_namlen;
Tim Peters430f5d42001-03-01 01:30:56 +00002121#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002122 strlen(dp->d_name);
Tim Peters430f5d42001-03-01 01:30:56 +00002123#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002124 if (thislen >= namelen &&
2125 strcmp(dp->d_name, nameWithExt) == 0) {
2126 (void)closedir(dirp);
2127 return 1; /* Found */
2128 }
2129 }
2130 (void)closedir(dirp);
2131 }
2132 return 0 ; /* Not found */
Tim Peters430f5d42001-03-01 01:30:56 +00002133
Andrew MacIntyred9400542002-02-26 11:41:34 +00002134/* OS/2 */
2135#elif defined(PYOS_OS2)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002136 HDIR hdir = 1;
2137 ULONG srchcnt = 1;
2138 FILEFINDBUF3 ffbuf;
2139 APIRET rc;
Andrew MacIntyred9400542002-02-26 11:41:34 +00002140
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002141 if (Py_GETENV("PYTHONCASEOK") != NULL)
2142 return 1;
Andrew MacIntyred9400542002-02-26 11:41:34 +00002143
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002144 rc = DosFindFirst(buf,
2145 &hdir,
2146 FILE_READONLY | FILE_HIDDEN | FILE_SYSTEM | FILE_DIRECTORY,
2147 &ffbuf, sizeof(ffbuf),
2148 &srchcnt,
2149 FIL_STANDARD);
2150 if (rc != NO_ERROR)
2151 return 0;
2152 return strncmp(ffbuf.achName, name, namelen) == 0;
Andrew MacIntyred9400542002-02-26 11:41:34 +00002153
Tim Peters50d8d372001-02-28 05:34:27 +00002154/* assuming it's a case-sensitive filesystem, so there's nothing to do! */
2155#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002156 return 1;
Guido van Rossum0980bd91998-02-13 17:18:36 +00002157
Guido van Rossum4d1b3b91998-02-13 23:27:59 +00002158#endif
Tim Peters50d8d372001-02-28 05:34:27 +00002159}
Guido van Rossum4d1b3b91998-02-13 23:27:59 +00002160
Guido van Rossum197346f1997-10-31 18:38:52 +00002161#ifdef HAVE_STAT
Victor Stinner4f4402c2010-08-14 14:50:26 +00002162
Guido van Rossum197346f1997-10-31 18:38:52 +00002163/* Helper to look for __init__.py or __init__.py[co] in potential package */
2164static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002165find_init_module(char *buf)
Guido van Rossum197346f1997-10-31 18:38:52 +00002166{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002167 const size_t save_len = strlen(buf);
2168 size_t i = save_len;
2169 char *pname; /* pointer to start of __init__ */
2170 struct stat statbuf;
Guido van Rossum197346f1997-10-31 18:38:52 +00002171
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002172/* For calling case_ok(buf, len, namelen, name):
2173 * /a/b/c/d/e/f/g/h/i/j/k/some_long_module_name.py\0
2174 * ^ ^ ^ ^
2175 * |--------------------- buf ---------------------|
2176 * |------------------- len ------------------|
2177 * |------ name -------|
2178 * |----- namelen -----|
Tim Peters0f9431f2001-07-05 03:47:53 +00002179 */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002180 if (save_len + 13 >= MAXPATHLEN)
2181 return 0;
2182 buf[i++] = SEP;
2183 pname = buf + i;
2184 strcpy(pname, "__init__.py");
2185 if (stat(buf, &statbuf) == 0) {
2186 if (case_ok(buf,
2187 save_len + 9, /* len("/__init__") */
2188 8, /* len("__init__") */
2189 pname)) {
2190 buf[save_len] = '\0';
2191 return 1;
2192 }
2193 }
2194 i += strlen(pname);
2195 strcpy(buf+i, Py_OptimizeFlag ? "o" : "c");
2196 if (stat(buf, &statbuf) == 0) {
2197 if (case_ok(buf,
2198 save_len + 9, /* len("/__init__") */
2199 8, /* len("__init__") */
2200 pname)) {
2201 buf[save_len] = '\0';
2202 return 1;
2203 }
2204 }
2205 buf[save_len] = '\0';
2206 return 0;
Guido van Rossum197346f1997-10-31 18:38:52 +00002207}
Guido van Rossum48a680c2001-03-02 06:34:14 +00002208
Guido van Rossum197346f1997-10-31 18:38:52 +00002209#endif /* HAVE_STAT */
2210
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002211
Victor Stinner95872862011-03-07 18:20:56 +01002212static int init_builtin(PyObject *); /* Forward */
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002213
Victor Stinner44c6c152010-08-09 00:59:10 +00002214static PyObject*
Victor Stinner95872862011-03-07 18:20:56 +01002215load_builtin(PyObject *name, int type)
Victor Stinner44c6c152010-08-09 00:59:10 +00002216{
2217 PyObject *m, *modules;
2218 int err;
2219
Victor Stinner44c6c152010-08-09 00:59:10 +00002220 if (type == C_BUILTIN)
2221 err = init_builtin(name);
2222 else
Victor Stinner95872862011-03-07 18:20:56 +01002223 err = PyImport_ImportFrozenModuleObject(name);
Victor Stinner44c6c152010-08-09 00:59:10 +00002224 if (err < 0)
2225 return NULL;
2226 if (err == 0) {
2227 PyErr_Format(PyExc_ImportError,
Victor Stinner95872862011-03-07 18:20:56 +01002228 "Purported %s module %R not found",
2229 type == C_BUILTIN ? "builtin" : "frozen",
Victor Stinner44c6c152010-08-09 00:59:10 +00002230 name);
2231 return NULL;
2232 }
2233
2234 modules = PyImport_GetModuleDict();
Victor Stinner95872862011-03-07 18:20:56 +01002235 m = PyDict_GetItem(modules, name);
Victor Stinner44c6c152010-08-09 00:59:10 +00002236 if (m == NULL) {
2237 PyErr_Format(
2238 PyExc_ImportError,
Victor Stinner95872862011-03-07 18:20:56 +01002239 "%s module %R not properly initialized",
2240 type == C_BUILTIN ? "builtin" : "frozen",
Victor Stinner44c6c152010-08-09 00:59:10 +00002241 name);
2242 return NULL;
2243 }
2244 Py_INCREF(m);
2245 return m;
2246}
2247
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002248/* Load an external module using the default search path and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00002249 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002250
Guido van Rossum79f25d91997-04-29 20:08:16 +00002251static PyObject *
Victor Stinner41c5fec2011-03-13 21:46:30 -04002252load_module(PyObject *name, FILE *fp, PyObject *pathname, int type, PyObject *loader)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002253{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002254 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002255
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002256 /* First check that there's an open file (if we need one) */
2257 switch (type) {
2258 case PY_SOURCE:
2259 case PY_COMPILED:
2260 if (fp == NULL) {
2261 PyErr_Format(PyExc_ValueError,
Victor Stinner41c5fec2011-03-13 21:46:30 -04002262 "file object required for import (type code %d)",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002263 type);
2264 return NULL;
2265 }
2266 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002267
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002268 switch (type) {
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002269
Victor Stinner41c5fec2011-03-13 21:46:30 -04002270 case PY_SOURCE:
2271 m = load_source_module(name, pathname, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002272 break;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002273
Victor Stinner41c5fec2011-03-13 21:46:30 -04002274 case PY_COMPILED:
2275 m = load_compiled_module(name, pathname, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002276 break;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002277
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002278#ifdef HAVE_DYNAMIC_LOADING
Victor Stinner41c5fec2011-03-13 21:46:30 -04002279 case C_EXTENSION:
2280 m = _PyImport_LoadDynamicModule(name, pathname, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002281 break;
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002282#endif
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002283
Victor Stinner41c5fec2011-03-13 21:46:30 -04002284 case PKG_DIRECTORY:
2285 m = load_package(name, pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002286 break;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002287
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002288 case C_BUILTIN:
Victor Stinner41c5fec2011-03-13 21:46:30 -04002289 case PY_FROZEN:
2290 m = load_builtin(name, type);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002291 break;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002292
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002293 case IMP_HOOK: {
2294 if (loader == NULL) {
2295 PyErr_SetString(PyExc_ImportError,
2296 "import hook without loader");
2297 return NULL;
2298 }
Victor Stinner41c5fec2011-03-13 21:46:30 -04002299 m = PyObject_CallMethod(loader, "load_module", "O", name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002300 break;
2301 }
Just van Rossum52e14d62002-12-30 22:08:05 +00002302
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002303 default:
2304 PyErr_Format(PyExc_ImportError,
Victor Stinner41c5fec2011-03-13 21:46:30 -04002305 "Don't know how to import %U (type code %d)",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002306 name, type);
2307 m = NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002308
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002309 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002310
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002311 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002312}
2313
2314
2315/* Initialize a built-in module.
Thomas Wouters89f507f2006-12-13 04:49:30 +00002316 Return 1 for success, 0 if the module is not found, and -1 with
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002317 an exception set if the initialization failed. */
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002318
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002319static int
Victor Stinner95872862011-03-07 18:20:56 +01002320init_builtin(PyObject *name)
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002321{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002322 struct _inittab *p;
Guido van Rossum25ce5661997-08-02 03:10:38 +00002323
Victor Stinner95872862011-03-07 18:20:56 +01002324 if (_PyImport_FindExtensionObject(name, name) != NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002325 return 1;
Guido van Rossum25ce5661997-08-02 03:10:38 +00002326
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002327 for (p = PyImport_Inittab; p->name != NULL; p++) {
2328 PyObject *mod;
Victor Stinner95872862011-03-07 18:20:56 +01002329 if (PyUnicode_CompareWithASCIIString(name, p->name) == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002330 if (p->initfunc == NULL) {
2331 PyErr_Format(PyExc_ImportError,
Victor Stinner95872862011-03-07 18:20:56 +01002332 "Cannot re-init internal module %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002333 name);
2334 return -1;
2335 }
2336 if (Py_VerboseFlag)
Victor Stinner95872862011-03-07 18:20:56 +01002337 PySys_FormatStderr("import %U # builtin\n", name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002338 mod = (*p->initfunc)();
2339 if (mod == 0)
2340 return -1;
Victor Stinner95872862011-03-07 18:20:56 +01002341 if (_PyImport_FixupExtensionObject(mod, name, name) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002342 return -1;
2343 /* FixupExtension has put the module into sys.modules,
2344 so we can release our own reference. */
2345 Py_DECREF(mod);
2346 return 1;
2347 }
2348 }
2349 return 0;
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002350}
Guido van Rossumf56e3db1993-04-01 20:59:32 +00002351
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002352
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002353/* Frozen modules */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002354
Guido van Rossumcfd0a221996-06-17 17:06:34 +00002355static struct _frozen *
Victor Stinner53dc7352011-03-20 01:50:21 +01002356find_frozen(PyObject *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002357{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002358 struct _frozen *p;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002359
Victor Stinner53dc7352011-03-20 01:50:21 +01002360 if (name == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002361 return NULL;
Benjamin Petersond968e272008-11-05 22:48:33 +00002362
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002363 for (p = PyImport_FrozenModules; ; p++) {
2364 if (p->name == NULL)
2365 return NULL;
Victor Stinner53dc7352011-03-20 01:50:21 +01002366 if (PyUnicode_CompareWithASCIIString(name, p->name) == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002367 break;
2368 }
2369 return p;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002370}
2371
Guido van Rossum79f25d91997-04-29 20:08:16 +00002372static PyObject *
Victor Stinner53dc7352011-03-20 01:50:21 +01002373get_frozen_object(PyObject *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002374{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002375 struct _frozen *p = find_frozen(name);
2376 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002377
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002378 if (p == NULL) {
2379 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002380 "No such frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002381 name);
2382 return NULL;
2383 }
2384 if (p->code == NULL) {
2385 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002386 "Excluded frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002387 name);
2388 return NULL;
2389 }
2390 size = p->size;
2391 if (size < 0)
2392 size = -size;
2393 return PyMarshal_ReadObjectFromString((char *)p->code, size);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002394}
2395
Brett Cannon8d110132009-03-15 02:20:16 +00002396static PyObject *
Victor Stinner53dc7352011-03-20 01:50:21 +01002397is_frozen_package(PyObject *name)
Brett Cannon8d110132009-03-15 02:20:16 +00002398{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002399 struct _frozen *p = find_frozen(name);
2400 int size;
Brett Cannon8d110132009-03-15 02:20:16 +00002401
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002402 if (p == NULL) {
2403 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002404 "No such frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002405 name);
2406 return NULL;
2407 }
Brett Cannon8d110132009-03-15 02:20:16 +00002408
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002409 size = p->size;
Brett Cannon8d110132009-03-15 02:20:16 +00002410
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002411 if (size < 0)
2412 Py_RETURN_TRUE;
2413 else
2414 Py_RETURN_FALSE;
Brett Cannon8d110132009-03-15 02:20:16 +00002415}
2416
2417
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002418/* Initialize a frozen module.
Brett Cannon3c2ac442009-03-08 20:49:47 +00002419 Return 1 for success, 0 if the module is not found, and -1 with
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002420 an exception set if the initialization failed.
2421 This function is also used from frozenmain.c */
Guido van Rossum0b344901995-02-07 15:35:27 +00002422
2423int
Victor Stinner53dc7352011-03-20 01:50:21 +01002424PyImport_ImportFrozenModuleObject(PyObject *name)
Guido van Rossumf56e3db1993-04-01 20:59:32 +00002425{
Victor Stinner53dc7352011-03-20 01:50:21 +01002426 struct _frozen *p;
2427 PyObject *co, *m, *path;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002428 int ispackage;
2429 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002430
Victor Stinner53dc7352011-03-20 01:50:21 +01002431 p = find_frozen(name);
2432
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002433 if (p == NULL)
2434 return 0;
2435 if (p->code == NULL) {
2436 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002437 "Excluded frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002438 name);
2439 return -1;
2440 }
2441 size = p->size;
2442 ispackage = (size < 0);
2443 if (ispackage)
2444 size = -size;
2445 if (Py_VerboseFlag)
Victor Stinner53dc7352011-03-20 01:50:21 +01002446 PySys_FormatStderr("import %U # frozen%s\n",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002447 name, ispackage ? " package" : "");
2448 co = PyMarshal_ReadObjectFromString((char *)p->code, size);
2449 if (co == NULL)
2450 return -1;
2451 if (!PyCode_Check(co)) {
2452 PyErr_Format(PyExc_TypeError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002453 "frozen object %R is not a code object",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002454 name);
2455 goto err_return;
2456 }
2457 if (ispackage) {
2458 /* Set __path__ to the package name */
Victor Stinner53dc7352011-03-20 01:50:21 +01002459 PyObject *d, *l;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002460 int err;
Victor Stinner53dc7352011-03-20 01:50:21 +01002461 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002462 if (m == NULL)
2463 goto err_return;
2464 d = PyModule_GetDict(m);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002465 l = PyList_New(1);
2466 if (l == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002467 goto err_return;
2468 }
Victor Stinner53dc7352011-03-20 01:50:21 +01002469 Py_INCREF(name);
2470 PyList_SET_ITEM(l, 0, name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002471 err = PyDict_SetItemString(d, "__path__", l);
2472 Py_DECREF(l);
2473 if (err != 0)
2474 goto err_return;
2475 }
Victor Stinner53dc7352011-03-20 01:50:21 +01002476 path = PyUnicode_FromString("<frozen>");
2477 if (path == NULL)
2478 goto err_return;
2479 m = PyImport_ExecCodeModuleObject(name, co, path, NULL);
2480 Py_DECREF(path);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002481 if (m == NULL)
2482 goto err_return;
2483 Py_DECREF(co);
2484 Py_DECREF(m);
2485 return 1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002486err_return:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002487 Py_DECREF(co);
2488 return -1;
Guido van Rossumf56e3db1993-04-01 20:59:32 +00002489}
Guido van Rossum74e6a111994-08-29 12:54:38 +00002490
Victor Stinner53dc7352011-03-20 01:50:21 +01002491int
2492PyImport_ImportFrozenModule(char *name)
2493{
2494 PyObject *nameobj;
2495 int ret;
2496 nameobj = PyUnicode_InternFromString(name);
2497 if (nameobj == NULL)
2498 return -1;
2499 ret = PyImport_ImportFrozenModuleObject(nameobj);
2500 Py_DECREF(nameobj);
2501 return ret;
2502}
2503
Guido van Rossum74e6a111994-08-29 12:54:38 +00002504
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002505/* Import a module, either built-in, frozen, or external, and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00002506 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum74e6a111994-08-29 12:54:38 +00002507
Guido van Rossum79f25d91997-04-29 20:08:16 +00002508PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00002509PyImport_ImportModule(const char *name)
Guido van Rossum74e6a111994-08-29 12:54:38 +00002510{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002511 PyObject *pname;
2512 PyObject *result;
Marc-André Lemburg3c61c352001-02-09 19:40:15 +00002513
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002514 pname = PyUnicode_FromString(name);
2515 if (pname == NULL)
2516 return NULL;
2517 result = PyImport_Import(pname);
2518 Py_DECREF(pname);
2519 return result;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002520}
2521
Christian Heimes072c0f12008-01-03 23:01:04 +00002522/* Import a module without blocking
2523 *
2524 * At first it tries to fetch the module from sys.modules. If the module was
2525 * never loaded before it loads it with PyImport_ImportModule() unless another
2526 * thread holds the import lock. In the latter case the function raises an
2527 * ImportError instead of blocking.
2528 *
2529 * Returns the module object with incremented ref count.
2530 */
2531PyObject *
2532PyImport_ImportModuleNoBlock(const char *name)
2533{
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002534 PyObject *nameobj, *modules, *result;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002535 long me;
Christian Heimes072c0f12008-01-03 23:01:04 +00002536
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002537 /* Try to get the module from sys.modules[name] */
2538 modules = PyImport_GetModuleDict();
2539 if (modules == NULL)
2540 return NULL;
Christian Heimes072c0f12008-01-03 23:01:04 +00002541
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002542 nameobj = PyUnicode_FromString(name);
2543 if (nameobj == NULL)
2544 return NULL;
2545 result = PyDict_GetItem(modules, nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002546 if (result != NULL) {
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002547 Py_DECREF(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002548 Py_INCREF(result);
2549 return result;
2550 }
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002551 PyErr_Clear();
Benjamin Peterson3e4f0552008-09-02 00:31:15 +00002552#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002553 /* check the import lock
2554 * me might be -1 but I ignore the error here, the lock function
2555 * takes care of the problem */
2556 me = PyThread_get_thread_ident();
2557 if (import_lock_thread == -1 || import_lock_thread == me) {
2558 /* no thread or me is holding the lock */
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002559 result = PyImport_Import(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002560 }
2561 else {
2562 PyErr_Format(PyExc_ImportError,
Victor Stinnerc24c8102011-03-13 22:38:06 -04002563 "Failed to import %R because the import lock"
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002564 "is held by another thread.",
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002565 nameobj);
2566 result = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002567 }
Benjamin Peterson3e4f0552008-09-02 00:31:15 +00002568#else
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002569 result = PyImport_Import(nameobj);
Benjamin Peterson3e4f0552008-09-02 00:31:15 +00002570#endif
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002571 Py_DECREF(nameobj);
2572 return result;
Christian Heimes072c0f12008-01-03 23:01:04 +00002573}
2574
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002575/* Forward declarations for helper routines */
Victor Stinner974389d2011-03-15 09:33:57 +01002576static PyObject *get_parent(PyObject *globals,
2577 PyObject **p_name,
2578 int level);
Tim Petersdbd9ba62000-07-09 03:09:57 +00002579static PyObject *load_next(PyObject *mod, PyObject *altmod,
Victor Stinner974389d2011-03-15 09:33:57 +01002580 PyObject *inputname, PyObject **p_outputname,
2581 Py_UNICODE *buf, Py_ssize_t *p_buflen,
2582 Py_ssize_t bufsize);
2583static int mark_miss(PyObject *name);
Tim Petersdbd9ba62000-07-09 03:09:57 +00002584static int ensure_fromlist(PyObject *mod, PyObject *fromlist,
Victor Stinner974389d2011-03-15 09:33:57 +01002585 PyObject *buf, int recursive);
2586static PyObject * import_submodule(PyObject *mod, PyObject *name,
2587 PyObject *fullname);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002588
2589/* The Magnum Opus of dotted-name import :-) */
2590
Guido van Rossum75acc9c1998-03-03 22:26:50 +00002591static PyObject *
Victor Stinner974389d2011-03-15 09:33:57 +01002592import_module_level(PyObject *name, PyObject *globals, PyObject *locals,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002593 PyObject *fromlist, int level)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002594{
Victor Stinner974389d2011-03-15 09:33:57 +01002595 Py_UNICODE buf[MAXPATHLEN+1];
2596 Py_ssize_t buflen;
2597 Py_ssize_t bufsize = MAXPATHLEN+1;
2598 PyObject *parent, *head, *next, *tail, *inputname, *outputname;
2599 PyObject *parent_name, *ensure_name;
2600 const Py_UNICODE *nameunicode;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002601
Victor Stinner974389d2011-03-15 09:33:57 +01002602 nameunicode = PyUnicode_AS_UNICODE(name);
2603
2604 if (Py_UNICODE_strchr(nameunicode, SEP) != NULL
2605#ifdef ALTSEP
2606 || Py_UNICODE_strchr(nameunicode, ALTSEP) != NULL
Christian Heimes454f37b2008-01-10 00:10:02 +00002607#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002608 ) {
2609 PyErr_SetString(PyExc_ImportError,
2610 "Import by filename is not supported.");
2611 return NULL;
2612 }
Christian Heimes454f37b2008-01-10 00:10:02 +00002613
Victor Stinner974389d2011-03-15 09:33:57 +01002614 parent = get_parent(globals, &parent_name, level);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002615 if (parent == NULL)
2616 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002617
Victor Stinner974389d2011-03-15 09:33:57 +01002618 buflen = PyUnicode_GET_SIZE(parent_name);
2619 if (buflen+1 > bufsize) {
2620 Py_DECREF(parent_name);
2621 PyErr_SetString(PyExc_ValueError,
2622 "Module name too long");
2623 return NULL;
2624 }
2625 Py_UNICODE_strcpy(buf, PyUnicode_AS_UNICODE(parent_name));
2626 Py_DECREF(parent_name);
2627
2628 head = load_next(parent, level < 0 ? Py_None : parent, name, &outputname,
2629 buf, &buflen, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002630 if (head == NULL)
2631 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002632
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002633 tail = head;
2634 Py_INCREF(tail);
Victor Stinner974389d2011-03-15 09:33:57 +01002635
2636 if (outputname != NULL) {
2637 while (1) {
2638 inputname = outputname;
2639 next = load_next(tail, tail, inputname, &outputname,
2640 buf, &buflen, bufsize);
2641 Py_DECREF(tail);
2642 Py_DECREF(inputname);
2643 if (next == NULL) {
2644 Py_DECREF(head);
2645 return NULL;
2646 }
2647 tail = next;
2648
2649 if (outputname == NULL) {
2650 break;
2651 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002652 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002653 }
2654 if (tail == Py_None) {
2655 /* If tail is Py_None, both get_parent and load_next found
2656 an empty module name: someone called __import__("") or
2657 doctored faulty bytecode */
2658 Py_DECREF(tail);
2659 Py_DECREF(head);
Victor Stinner974389d2011-03-15 09:33:57 +01002660 PyErr_SetString(PyExc_ValueError, "Empty module name");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002661 return NULL;
2662 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002663
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002664 if (fromlist != NULL) {
2665 if (fromlist == Py_None || !PyObject_IsTrue(fromlist))
2666 fromlist = NULL;
2667 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002668
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002669 if (fromlist == NULL) {
2670 Py_DECREF(tail);
2671 return head;
2672 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002673
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002674 Py_DECREF(head);
Victor Stinner974389d2011-03-15 09:33:57 +01002675
2676 ensure_name = PyUnicode_FromUnicode(buf, Py_UNICODE_strlen(buf));
2677 if (ensure_name == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002678 Py_DECREF(tail);
2679 return NULL;
2680 }
Victor Stinner974389d2011-03-15 09:33:57 +01002681 if (!ensure_fromlist(tail, fromlist, ensure_name, 0)) {
2682 Py_DECREF(tail);
2683 Py_DECREF(ensure_name);
2684 return NULL;
2685 }
2686 Py_DECREF(ensure_name);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002687
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002688 return tail;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002689}
2690
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002691PyObject *
2692PyImport_ImportModuleLevel(char *name, PyObject *globals, PyObject *locals,
Victor Stinner974389d2011-03-15 09:33:57 +01002693 PyObject *fromlist, int level)
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002694{
Victor Stinner974389d2011-03-15 09:33:57 +01002695 PyObject *nameobj, *result;
2696 nameobj = PyUnicode_FromString(name);
2697 if (nameobj == NULL)
2698 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002699 _PyImport_AcquireLock();
Victor Stinner974389d2011-03-15 09:33:57 +01002700 result = import_module_level(nameobj, globals, locals, fromlist, level);
2701 Py_DECREF(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002702 if (_PyImport_ReleaseLock() < 0) {
2703 Py_XDECREF(result);
2704 PyErr_SetString(PyExc_RuntimeError,
2705 "not holding the import lock");
2706 return NULL;
2707 }
2708 return result;
Guido van Rossum75acc9c1998-03-03 22:26:50 +00002709}
2710
Fred Drake87590902004-05-28 20:21:36 +00002711/* Return the package that an import is being performed in. If globals comes
2712 from the module foo.bar.bat (not itself a package), this returns the
2713 sys.modules entry for foo.bar. If globals is from a package's __init__.py,
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00002714 the package's entry in sys.modules is returned, as a borrowed reference.
Fred Drake87590902004-05-28 20:21:36 +00002715
Victor Stinner974389d2011-03-15 09:33:57 +01002716 The name of the returned package is returned in *p_name.
Fred Drake87590902004-05-28 20:21:36 +00002717
2718 If globals doesn't come from a package or a module in a package, or a
2719 corresponding entry is not found in sys.modules, Py_None is returned.
2720*/
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002721static PyObject *
Victor Stinner9599de52011-03-13 22:38:38 -04002722get_parent(PyObject *globals, PyObject **p_name, int level)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002723{
Victor Stinner974389d2011-03-15 09:33:57 +01002724 Py_UNICODE name[MAXPATHLEN+1];
2725 const Py_ssize_t bufsize = MAXPATHLEN+1;
2726 PyObject *nameobj;
2727
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002728 static PyObject *namestr = NULL;
2729 static PyObject *pathstr = NULL;
2730 static PyObject *pkgstr = NULL;
2731 PyObject *pkgname, *modname, *modpath, *modules, *parent;
2732 int orig_level = level;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002733
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002734 if (globals == NULL || !PyDict_Check(globals) || !level)
Victor Stinner974389d2011-03-15 09:33:57 +01002735 goto return_none;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002736
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002737 if (namestr == NULL) {
2738 namestr = PyUnicode_InternFromString("__name__");
2739 if (namestr == NULL)
2740 return NULL;
2741 }
2742 if (pathstr == NULL) {
2743 pathstr = PyUnicode_InternFromString("__path__");
2744 if (pathstr == NULL)
2745 return NULL;
2746 }
2747 if (pkgstr == NULL) {
2748 pkgstr = PyUnicode_InternFromString("__package__");
2749 if (pkgstr == NULL)
2750 return NULL;
2751 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002752
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002753 pkgname = PyDict_GetItem(globals, pkgstr);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002754
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002755 if ((pkgname != NULL) && (pkgname != Py_None)) {
2756 /* __package__ is set, so use it */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002757 if (!PyUnicode_Check(pkgname)) {
2758 PyErr_SetString(PyExc_ValueError,
2759 "__package__ set to non-string");
2760 return NULL;
2761 }
Victor Stinner974389d2011-03-15 09:33:57 +01002762 if (PyUnicode_GET_SIZE(pkgname) == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002763 if (level > 0) {
2764 PyErr_SetString(PyExc_ValueError,
2765 "Attempted relative import in non-package");
2766 return NULL;
2767 }
Victor Stinner974389d2011-03-15 09:33:57 +01002768 goto return_none;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002769 }
Victor Stinner974389d2011-03-15 09:33:57 +01002770 if (PyUnicode_GET_SIZE(pkgname)+1 > bufsize) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002771 PyErr_SetString(PyExc_ValueError,
2772 "Package name too long");
2773 return NULL;
2774 }
Victor Stinner974389d2011-03-15 09:33:57 +01002775 Py_UNICODE_strcpy(name, PyUnicode_AS_UNICODE(pkgname));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002776 } else {
2777 /* __package__ not set, so figure it out and set it */
2778 modname = PyDict_GetItem(globals, namestr);
2779 if (modname == NULL || !PyUnicode_Check(modname))
Victor Stinner974389d2011-03-15 09:33:57 +01002780 goto return_none;
Brett Cannon9a5b25a2010-03-01 02:09:17 +00002781
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002782 modpath = PyDict_GetItem(globals, pathstr);
2783 if (modpath != NULL) {
2784 /* __path__ is set, so modname is already the package name */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002785 int error;
Alexandre Vassalottia85998a2008-05-03 18:24:43 +00002786
Victor Stinner974389d2011-03-15 09:33:57 +01002787 if (PyUnicode_GET_SIZE(modname)+1 > bufsize) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002788 PyErr_SetString(PyExc_ValueError,
2789 "Module name too long");
2790 return NULL;
2791 }
Victor Stinner974389d2011-03-15 09:33:57 +01002792 Py_UNICODE_strcpy(name, PyUnicode_AS_UNICODE(modname));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002793 error = PyDict_SetItem(globals, pkgstr, modname);
2794 if (error) {
2795 PyErr_SetString(PyExc_ValueError,
2796 "Could not set __package__");
2797 return NULL;
2798 }
2799 } else {
2800 /* Normal module, so work out the package name if any */
Victor Stinner974389d2011-03-15 09:33:57 +01002801 Py_UNICODE *start = PyUnicode_AS_UNICODE(modname);
2802 Py_UNICODE *lastdot = Py_UNICODE_strrchr(start, '.');
2803 Py_ssize_t len;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002804 int error;
2805 if (lastdot == NULL && level > 0) {
2806 PyErr_SetString(PyExc_ValueError,
2807 "Attempted relative import in non-package");
2808 return NULL;
2809 }
2810 if (lastdot == NULL) {
2811 error = PyDict_SetItem(globals, pkgstr, Py_None);
2812 if (error) {
2813 PyErr_SetString(PyExc_ValueError,
2814 "Could not set __package__");
2815 return NULL;
2816 }
Victor Stinner974389d2011-03-15 09:33:57 +01002817 goto return_none;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002818 }
2819 len = lastdot - start;
Victor Stinner974389d2011-03-15 09:33:57 +01002820 if (len+1 > bufsize) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002821 PyErr_SetString(PyExc_ValueError,
2822 "Module name too long");
2823 return NULL;
2824 }
Victor Stinner974389d2011-03-15 09:33:57 +01002825 Py_UNICODE_strncpy(name, start, len);
2826 name[len] = '\0';
2827 pkgname = PyUnicode_FromUnicode(name, len);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002828 if (pkgname == NULL) {
2829 return NULL;
2830 }
2831 error = PyDict_SetItem(globals, pkgstr, pkgname);
2832 Py_DECREF(pkgname);
2833 if (error) {
2834 PyErr_SetString(PyExc_ValueError,
2835 "Could not set __package__");
2836 return NULL;
2837 }
2838 }
2839 }
2840 while (--level > 0) {
Victor Stinner974389d2011-03-15 09:33:57 +01002841 Py_UNICODE *dot = Py_UNICODE_strrchr(name, '.');
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002842 if (dot == NULL) {
2843 PyErr_SetString(PyExc_ValueError,
2844 "Attempted relative import beyond "
2845 "toplevel package");
2846 return NULL;
2847 }
2848 *dot = '\0';
2849 }
Victor Stinner974389d2011-03-15 09:33:57 +01002850
2851 nameobj = PyUnicode_FromUnicode(name, Py_UNICODE_strlen(name));
2852 if (nameobj == NULL)
2853 return NULL;
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002854
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002855 modules = PyImport_GetModuleDict();
Victor Stinner974389d2011-03-15 09:33:57 +01002856 parent = PyDict_GetItem(modules, nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002857 if (parent == NULL) {
Victor Stinner974389d2011-03-15 09:33:57 +01002858 int err;
2859
2860 if (orig_level >= 1) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002861 PyErr_Format(PyExc_SystemError,
Victor Stinner974389d2011-03-15 09:33:57 +01002862 "Parent module %R not loaded, "
2863 "cannot perform relative import", nameobj);
2864 Py_DECREF(nameobj);
2865 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002866 }
Victor Stinner974389d2011-03-15 09:33:57 +01002867
2868 err = PyErr_WarnFormat(
2869 PyExc_RuntimeWarning, 1,
2870 "Parent module %R not found while handling absolute import",
2871 nameobj);
2872 Py_DECREF(nameobj);
2873 if (err)
2874 return NULL;
2875
2876 goto return_none;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002877 }
Victor Stinner974389d2011-03-15 09:33:57 +01002878 *p_name = nameobj;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002879 return parent;
2880 /* We expect, but can't guarantee, if parent != None, that:
Victor Stinner974389d2011-03-15 09:33:57 +01002881 - parent.__name__ == name
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002882 - parent.__dict__ is globals
2883 If this is violated... Who cares? */
Victor Stinner974389d2011-03-15 09:33:57 +01002884
2885return_none:
2886 nameobj = PyUnicode_FromUnicode(NULL, 0);
2887 if (nameobj == NULL)
2888 return NULL;
2889 *p_name = nameobj;
2890 return Py_None;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002891}
2892
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002893/* altmod is either None or same as mod */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002894static PyObject *
Victor Stinner974389d2011-03-15 09:33:57 +01002895load_next(PyObject *mod, PyObject *altmod,
2896 PyObject *inputname, PyObject **p_outputname,
2897 Py_UNICODE *buf, Py_ssize_t *p_buflen, Py_ssize_t bufsize)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002898{
Victor Stinner974389d2011-03-15 09:33:57 +01002899 const Py_UNICODE *dot;
2900 Py_ssize_t len;
2901 Py_UNICODE *p;
2902 PyObject *fullname, *name, *result, *mark_name;
2903 const Py_UNICODE *nameuni;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002904
Victor Stinner974389d2011-03-15 09:33:57 +01002905 *p_outputname = NULL;
2906
2907 if (PyUnicode_GET_SIZE(inputname) == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002908 /* completely empty module name should only happen in
2909 'from . import' (or '__import__("")')*/
2910 Py_INCREF(mod);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002911 return mod;
2912 }
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002913
Victor Stinner974389d2011-03-15 09:33:57 +01002914 nameuni = PyUnicode_AS_UNICODE(inputname);
2915 if (nameuni == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002916 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002917
Victor Stinner974389d2011-03-15 09:33:57 +01002918 dot = Py_UNICODE_strchr(nameuni, '.');
2919 if (dot != NULL) {
2920 len = dot - nameuni;
2921 if (len == 0) {
2922 PyErr_SetString(PyExc_ValueError,
2923 "Empty module name");
2924 return NULL;
2925 }
2926 }
2927 else
2928 len = PyUnicode_GET_SIZE(inputname);
2929
2930 if (*p_buflen+len+1 >= bufsize) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002931 PyErr_SetString(PyExc_ValueError,
2932 "Module name too long");
2933 return NULL;
2934 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002935
Victor Stinner974389d2011-03-15 09:33:57 +01002936 p = buf + *p_buflen;
2937 if (p != buf) {
2938 *p++ = '.';
2939 *p_buflen += 1;
2940 }
2941 Py_UNICODE_strncpy(p, nameuni, len);
2942 p[len] = '\0';
2943 *p_buflen += len;
2944
2945 fullname = PyUnicode_FromUnicode(buf, *p_buflen);
2946 if (fullname == NULL)
2947 return NULL;
2948 name = PyUnicode_FromUnicode(p, len);
2949 if (name == NULL) {
2950 Py_DECREF(fullname);
2951 return NULL;
2952 }
2953 result = import_submodule(mod, name, fullname);
2954 Py_DECREF(fullname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002955 if (result == Py_None && altmod != mod) {
2956 Py_DECREF(result);
2957 /* Here, altmod must be None and mod must not be None */
Victor Stinner974389d2011-03-15 09:33:57 +01002958 result = import_submodule(altmod, name, name);
2959 Py_DECREF(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002960 if (result != NULL && result != Py_None) {
Victor Stinner974389d2011-03-15 09:33:57 +01002961 mark_name = PyUnicode_FromUnicode(buf, *p_buflen);
2962 if (mark_name == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002963 Py_DECREF(result);
2964 return NULL;
2965 }
Victor Stinner974389d2011-03-15 09:33:57 +01002966 if (mark_miss(mark_name) != 0) {
2967 Py_DECREF(result);
2968 Py_DECREF(mark_name);
2969 return NULL;
2970 }
2971 Py_DECREF(mark_name);
2972 Py_UNICODE_strncpy(buf, nameuni, len);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002973 buf[len] = '\0';
2974 *p_buflen = len;
2975 }
2976 }
Victor Stinner974389d2011-03-15 09:33:57 +01002977 else
2978 Py_DECREF(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002979 if (result == NULL)
2980 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002981
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002982 if (result == Py_None) {
2983 Py_DECREF(result);
2984 PyErr_Format(PyExc_ImportError,
Victor Stinner974389d2011-03-15 09:33:57 +01002985 "No module named %R", inputname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002986 return NULL;
2987 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002988
Victor Stinner974389d2011-03-15 09:33:57 +01002989 if (dot != NULL) {
2990 *p_outputname = PyUnicode_FromUnicode(dot+1, Py_UNICODE_strlen(dot+1));
2991 if (*p_outputname == NULL) {
2992 Py_DECREF(result);
2993 return NULL;
2994 }
2995 }
2996
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002997 return result;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002998}
2999
3000static int
Victor Stinner974389d2011-03-15 09:33:57 +01003001mark_miss(PyObject *name)
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00003002{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003003 PyObject *modules = PyImport_GetModuleDict();
Victor Stinner974389d2011-03-15 09:33:57 +01003004 return PyDict_SetItem(modules, name, Py_None);
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00003005}
3006
3007static int
Victor Stinner974389d2011-03-15 09:33:57 +01003008ensure_fromlist(PyObject *mod, PyObject *fromlist, PyObject *name,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003009 int recursive)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003010{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003011 int i;
Victor Stinner974389d2011-03-15 09:33:57 +01003012 PyObject *fullname;
3013 Py_ssize_t fromlist_len;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003014
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003015 if (!PyObject_HasAttrString(mod, "__path__"))
3016 return 1;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003017
Victor Stinner974389d2011-03-15 09:33:57 +01003018 fromlist_len = PySequence_Size(fromlist);
3019
3020 for (i = 0; i < fromlist_len; i++) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003021 PyObject *item = PySequence_GetItem(fromlist, i);
3022 int hasit;
Victor Stinner974389d2011-03-15 09:33:57 +01003023 if (item == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003024 return 0;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003025 if (!PyUnicode_Check(item)) {
3026 PyErr_SetString(PyExc_TypeError,
3027 "Item in ``from list'' not a string");
3028 Py_DECREF(item);
3029 return 0;
3030 }
3031 if (PyUnicode_AS_UNICODE(item)[0] == '*') {
3032 PyObject *all;
3033 Py_DECREF(item);
3034 /* See if the package defines __all__ */
3035 if (recursive)
3036 continue; /* Avoid endless recursion */
3037 all = PyObject_GetAttrString(mod, "__all__");
3038 if (all == NULL)
3039 PyErr_Clear();
3040 else {
Victor Stinner974389d2011-03-15 09:33:57 +01003041 int ret = ensure_fromlist(mod, all, name, 1);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003042 Py_DECREF(all);
3043 if (!ret)
3044 return 0;
3045 }
3046 continue;
3047 }
3048 hasit = PyObject_HasAttr(mod, item);
3049 if (!hasit) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003050 PyObject *submod;
Victor Stinner974389d2011-03-15 09:33:57 +01003051 fullname = PyUnicode_FromFormat("%U.%U", name, item);
3052 if (fullname != NULL) {
3053 submod = import_submodule(mod, item, fullname);
3054 Py_DECREF(fullname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003055 }
Victor Stinner974389d2011-03-15 09:33:57 +01003056 else
3057 submod = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003058 Py_XDECREF(submod);
3059 if (submod == NULL) {
3060 Py_DECREF(item);
3061 return 0;
3062 }
3063 }
3064 Py_DECREF(item);
3065 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003066
Victor Stinner974389d2011-03-15 09:33:57 +01003067 return 1;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003068}
3069
Neil Schemenauer00b09662003-06-16 21:03:07 +00003070static int
Victor Stinner974389d2011-03-15 09:33:57 +01003071add_submodule(PyObject *mod, PyObject *submod, PyObject *fullname,
3072 PyObject *subname, PyObject *modules)
Neil Schemenauer00b09662003-06-16 21:03:07 +00003073{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003074 if (mod == Py_None)
3075 return 1;
3076 /* Irrespective of the success of this load, make a
3077 reference to it in the parent package module. A copy gets
3078 saved in the modules dictionary under the full name, so get a
3079 reference from there, if need be. (The exception is when the
3080 load failed with a SyntaxError -- then there's no trace in
3081 sys.modules. In that case, of course, do nothing extra.) */
3082 if (submod == NULL) {
Victor Stinner974389d2011-03-15 09:33:57 +01003083 submod = PyDict_GetItem(modules, fullname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003084 if (submod == NULL)
3085 return 1;
3086 }
3087 if (PyModule_Check(mod)) {
3088 /* We can't use setattr here since it can give a
3089 * spurious warning if the submodule name shadows a
3090 * builtin name */
3091 PyObject *dict = PyModule_GetDict(mod);
3092 if (!dict)
3093 return 0;
Victor Stinner974389d2011-03-15 09:33:57 +01003094 if (PyDict_SetItem(dict, subname, submod) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003095 return 0;
3096 }
3097 else {
Victor Stinner974389d2011-03-15 09:33:57 +01003098 if (PyObject_SetAttr(mod, subname, submod) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003099 return 0;
3100 }
3101 return 1;
Neil Schemenauer00b09662003-06-16 21:03:07 +00003102}
3103
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003104static PyObject *
Victor Stinner974389d2011-03-15 09:33:57 +01003105import_submodule(PyObject *mod, PyObject *subname, PyObject *fullname)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003106{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003107 PyObject *modules = PyImport_GetModuleDict();
Victor Stinner9599de52011-03-13 22:38:38 -04003108 PyObject *m = NULL, *bufobj, *path, *loader;
3109 char buf[MAXPATHLEN+1];
3110 struct filedescr *fdp;
3111 FILE *fp;
Guido van Rossum74e6a111994-08-29 12:54:38 +00003112
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003113 /* Require:
3114 if mod == None: subname == fullname
3115 else: mod.__name__ + "." + subname == fullname
3116 */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003117
Victor Stinner974389d2011-03-15 09:33:57 +01003118 if ((m = PyDict_GetItem(modules, fullname)) != NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003119 Py_INCREF(m);
Victor Stinner9599de52011-03-13 22:38:38 -04003120 return m;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003121 }
Victor Stinner9599de52011-03-13 22:38:38 -04003122
3123 if (mod == Py_None)
3124 path = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003125 else {
Victor Stinner9599de52011-03-13 22:38:38 -04003126 path = PyObject_GetAttrString(mod, "__path__");
3127 if (path == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003128 PyErr_Clear();
3129 Py_INCREF(Py_None);
3130 return Py_None;
3131 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003132 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003133
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003134 fdp = find_module(fullname,
3135 subname,
Victor Stinner9599de52011-03-13 22:38:38 -04003136 path, buf, MAXPATHLEN+1,
3137 &fp, &loader);
3138 Py_XDECREF(path);
3139 if (fdp == NULL) {
3140 if (!PyErr_ExceptionMatches(PyExc_ImportError))
3141 return NULL;
3142 PyErr_Clear();
3143 Py_INCREF(Py_None);
3144 return Py_None;
3145 }
3146 bufobj = PyUnicode_DecodeFSDefault(buf);
3147 if (bufobj != NULL) {
3148 m = load_module(fullname, fp, bufobj, fdp->type, loader);
3149 Py_DECREF(bufobj);
3150 }
3151 else
3152 m = NULL;
3153 Py_XDECREF(loader);
3154 if (fp)
3155 fclose(fp);
3156 if (m == NULL)
3157 return NULL;
3158 if (!add_submodule(mod, m, fullname, subname, modules)) {
3159 Py_XDECREF(m);
3160 return NULL;
3161 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003162 return m;
Guido van Rossum74e6a111994-08-29 12:54:38 +00003163}
3164
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003165
3166/* Re-import a module of any kind and return its module object, WITH
3167 INCREMENTED REFERENCE COUNT */
3168
Guido van Rossum79f25d91997-04-29 20:08:16 +00003169PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003170PyImport_ReloadModule(PyObject *m)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003171{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003172 PyInterpreterState *interp = PyThreadState_Get()->interp;
3173 PyObject *modules_reloading = interp->modules_reloading;
3174 PyObject *modules = PyImport_GetModuleDict();
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003175 char buf[MAXPATHLEN+1];
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003176 PyObject *path = NULL, *loader = NULL, *existing_m = NULL;
3177 PyObject *nameobj, *bufobj, *subnameobj;
3178 Py_UNICODE *name, *subname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003179 struct filedescr *fdp;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003180 FILE *fp = NULL;
3181 PyObject *newm = NULL;
Brett Cannon9a5b25a2010-03-01 02:09:17 +00003182
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003183 if (modules_reloading == NULL) {
3184 Py_FatalError("PyImport_ReloadModule: "
3185 "no modules_reloading dictionary!");
3186 return NULL;
3187 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003188
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003189 if (m == NULL || !PyModule_Check(m)) {
3190 PyErr_SetString(PyExc_TypeError,
3191 "reload() argument must be module");
3192 return NULL;
3193 }
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003194 nameobj = PyModule_GetNameObject(m);
3195 if (nameobj == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003196 return NULL;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003197 if (m != PyDict_GetItem(modules, nameobj)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003198 PyErr_Format(PyExc_ImportError,
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003199 "reload(): module %U not in sys.modules",
3200 nameobj);
3201 Py_DECREF(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003202 return NULL;
3203 }
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003204 existing_m = PyDict_GetItem(modules_reloading, nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003205 if (existing_m != NULL) {
3206 /* Due to a recursive reload, this module is already
3207 being reloaded. */
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003208 Py_DECREF(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003209 Py_INCREF(existing_m);
3210 return existing_m;
3211 }
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003212 if (PyDict_SetItem(modules_reloading, nameobj, m) < 0) {
3213 Py_DECREF(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003214 return NULL;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003215 }
Guido van Rossumd8faa362007-04-27 19:54:29 +00003216
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003217 name = PyUnicode_AS_UNICODE(nameobj);
3218 subname = Py_UNICODE_strrchr(name, '.');
3219 if (subname == NULL) {
3220 Py_INCREF(nameobj);
3221 subnameobj = nameobj;
3222 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003223 else {
3224 PyObject *parentname, *parent;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003225 Py_ssize_t len;
3226 len = subname - name;
3227 parentname = PyUnicode_FromUnicode(name, len);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003228 if (parentname == NULL) {
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003229 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003230 }
3231 parent = PyDict_GetItem(modules, parentname);
3232 if (parent == NULL) {
3233 PyErr_Format(PyExc_ImportError,
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003234 "reload(): parent %U not in sys.modules",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003235 parentname);
3236 Py_DECREF(parentname);
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003237 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003238 }
3239 Py_DECREF(parentname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003240 path = PyObject_GetAttrString(parent, "__path__");
3241 if (path == NULL)
3242 PyErr_Clear();
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003243 subname++;
3244 len = PyUnicode_GET_SIZE(nameobj) - (len + 1);
3245 subnameobj = PyUnicode_FromUnicode(subname, len);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003246 }
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003247 if (subnameobj == NULL)
3248 goto error;
3249 fdp = find_module(nameobj, subnameobj,
3250 path, buf, MAXPATHLEN+1, &fp, &loader);
3251 Py_DECREF(subnameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003252 Py_XDECREF(path);
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00003253
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003254 if (fdp == NULL) {
3255 Py_XDECREF(loader);
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003256 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003257 }
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00003258
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003259 bufobj = PyUnicode_DecodeFSDefault(buf);
3260 if (bufobj != NULL) {
3261 newm = load_module(nameobj, fp, bufobj, fdp->type, loader);
3262 Py_DECREF(bufobj);
Victor Stinner41c5fec2011-03-13 21:46:30 -04003263 }
3264 else
3265 newm = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003266 Py_XDECREF(loader);
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00003267
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003268 if (fp)
3269 fclose(fp);
3270 if (newm == NULL) {
3271 /* load_module probably removed name from modules because of
3272 * the error. Put back the original module object. We're
3273 * going to return NULL in this case regardless of whether
3274 * replacing name succeeds, so the return value is ignored.
3275 */
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003276 PyDict_SetItem(modules, nameobj, m);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003277 }
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003278
3279error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003280 imp_modules_reloading_clear();
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003281 Py_DECREF(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003282 return newm;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003283}
3284
3285
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003286/* Higher-level import emulator which emulates the "import" statement
3287 more accurately -- it invokes the __import__() function from the
3288 builtins of the current globals. This means that the import is
3289 done using whatever import hooks are installed in the current
Brett Cannonbc2eff32010-09-19 21:39:02 +00003290 environment.
Guido van Rossum6058eb41998-12-21 19:51:00 +00003291 A dummy list ["__doc__"] is passed as the 4th argument so that
Neal Norwitz80e7f272007-08-26 06:45:23 +00003292 e.g. PyImport_Import(PyUnicode_FromString("win32com.client.gencache"))
Guido van Rossum6058eb41998-12-21 19:51:00 +00003293 will return <module "gencache"> instead of <module "win32com">. */
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003294
3295PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003296PyImport_Import(PyObject *module_name)
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003297{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003298 static PyObject *silly_list = NULL;
3299 static PyObject *builtins_str = NULL;
3300 static PyObject *import_str = NULL;
3301 PyObject *globals = NULL;
3302 PyObject *import = NULL;
3303 PyObject *builtins = NULL;
Brett Cannonbc2eff32010-09-19 21:39:02 +00003304 PyObject *modules = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003305 PyObject *r = NULL;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003306
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003307 /* Initialize constant string objects */
3308 if (silly_list == NULL) {
3309 import_str = PyUnicode_InternFromString("__import__");
3310 if (import_str == NULL)
3311 return NULL;
3312 builtins_str = PyUnicode_InternFromString("__builtins__");
3313 if (builtins_str == NULL)
3314 return NULL;
Brett Cannonbc2eff32010-09-19 21:39:02 +00003315 silly_list = PyList_New(0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003316 if (silly_list == NULL)
3317 return NULL;
3318 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003319
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003320 /* Get the builtins from current globals */
3321 globals = PyEval_GetGlobals();
3322 if (globals != NULL) {
3323 Py_INCREF(globals);
3324 builtins = PyObject_GetItem(globals, builtins_str);
3325 if (builtins == NULL)
3326 goto err;
3327 }
3328 else {
3329 /* No globals -- use standard builtins, and fake globals */
3330 builtins = PyImport_ImportModuleLevel("builtins",
3331 NULL, NULL, NULL, 0);
3332 if (builtins == NULL)
3333 return NULL;
3334 globals = Py_BuildValue("{OO}", builtins_str, builtins);
3335 if (globals == NULL)
3336 goto err;
3337 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003338
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003339 /* Get the __import__ function from the builtins */
3340 if (PyDict_Check(builtins)) {
3341 import = PyObject_GetItem(builtins, import_str);
3342 if (import == NULL)
3343 PyErr_SetObject(PyExc_KeyError, import_str);
3344 }
3345 else
3346 import = PyObject_GetAttr(builtins, import_str);
3347 if (import == NULL)
3348 goto err;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003349
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003350 /* Call the __import__ function with the proper argument list
Brett Cannonbc2eff32010-09-19 21:39:02 +00003351 Always use absolute import here.
3352 Calling for side-effect of import. */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003353 r = PyObject_CallFunction(import, "OOOOi", module_name, globals,
3354 globals, silly_list, 0, NULL);
Brett Cannonbc2eff32010-09-19 21:39:02 +00003355 if (r == NULL)
3356 goto err;
3357 Py_DECREF(r);
3358
3359 modules = PyImport_GetModuleDict();
3360 r = PyDict_GetItem(modules, module_name);
3361 if (r != NULL)
3362 Py_INCREF(r);
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003363
3364 err:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003365 Py_XDECREF(globals);
3366 Py_XDECREF(builtins);
3367 Py_XDECREF(import);
Tim Peters50d8d372001-02-28 05:34:27 +00003368
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003369 return r;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003370}
3371
3372
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003373/* Module 'imp' provides Python access to the primitives used for
3374 importing modules.
3375*/
3376
Guido van Rossum79f25d91997-04-29 20:08:16 +00003377static PyObject *
Barry Warsaw28a691b2010-04-17 00:19:56 +00003378imp_make_magic(long magic)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003379{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003380 char buf[4];
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003381
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003382 buf[0] = (char) ((magic >> 0) & 0xff);
3383 buf[1] = (char) ((magic >> 8) & 0xff);
3384 buf[2] = (char) ((magic >> 16) & 0xff);
3385 buf[3] = (char) ((magic >> 24) & 0xff);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003386
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003387 return PyBytes_FromStringAndSize(buf, 4);
Victor Stinner3e2b7172010-11-09 09:32:19 +00003388}
Barry Warsaw28a691b2010-04-17 00:19:56 +00003389
3390static PyObject *
3391imp_get_magic(PyObject *self, PyObject *noargs)
3392{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003393 return imp_make_magic(pyc_magic);
Barry Warsaw28a691b2010-04-17 00:19:56 +00003394}
3395
3396static PyObject *
3397imp_get_tag(PyObject *self, PyObject *noargs)
3398{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003399 return PyUnicode_FromString(pyc_tag);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003400}
3401
Guido van Rossum79f25d91997-04-29 20:08:16 +00003402static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +00003403imp_get_suffixes(PyObject *self, PyObject *noargs)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003404{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003405 PyObject *list;
3406 struct filedescr *fdp;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003407
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003408 list = PyList_New(0);
3409 if (list == NULL)
3410 return NULL;
3411 for (fdp = _PyImport_Filetab; fdp->suffix != NULL; fdp++) {
3412 PyObject *item = Py_BuildValue("ssi",
3413 fdp->suffix, fdp->mode, fdp->type);
3414 if (item == NULL) {
3415 Py_DECREF(list);
3416 return NULL;
3417 }
3418 if (PyList_Append(list, item) < 0) {
3419 Py_DECREF(list);
3420 Py_DECREF(item);
3421 return NULL;
3422 }
3423 Py_DECREF(item);
3424 }
3425 return list;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003426}
3427
Guido van Rossum79f25d91997-04-29 20:08:16 +00003428static PyObject *
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003429call_find_module(PyObject *name, PyObject *path)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003430{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003431 extern int fclose(FILE *);
3432 PyObject *fob, *ret;
3433 PyObject *pathobj;
3434 struct filedescr *fdp;
3435 char pathname[MAXPATHLEN+1];
Victor Stinner7d8b77c2011-03-12 08:45:02 -05003436 FILE *fp;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003437 int fd = -1;
3438 char *found_encoding = NULL;
3439 char *encoding = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003440
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003441 pathname[0] = '\0';
3442 if (path == Py_None)
3443 path = NULL;
3444 fdp = find_module(NULL, name, path, pathname, MAXPATHLEN+1, &fp, NULL);
3445 if (fdp == NULL)
3446 return NULL;
3447 if (fp != NULL) {
3448 fd = fileno(fp);
3449 if (fd != -1)
3450 fd = dup(fd);
3451 fclose(fp);
3452 fp = NULL;
3453 }
3454 if (fd != -1) {
3455 if (strchr(fdp->mode, 'b') == NULL) {
3456 /* PyTokenizer_FindEncoding() returns PyMem_MALLOC'ed
3457 memory. */
3458 found_encoding = PyTokenizer_FindEncoding(fd);
3459 lseek(fd, 0, 0); /* Reset position */
3460 if (found_encoding == NULL && PyErr_Occurred())
3461 return NULL;
3462 encoding = (found_encoding != NULL) ? found_encoding :
3463 (char*)PyUnicode_GetDefaultEncoding();
3464 }
3465 fob = PyFile_FromFd(fd, pathname, fdp->mode, -1,
3466 (char*)encoding, NULL, NULL, 1);
3467 if (fob == NULL) {
3468 close(fd);
3469 PyMem_FREE(found_encoding);
3470 return NULL;
3471 }
3472 }
3473 else {
3474 fob = Py_None;
3475 Py_INCREF(fob);
3476 }
3477 pathobj = PyUnicode_DecodeFSDefault(pathname);
3478 ret = Py_BuildValue("NN(ssi)",
3479 fob, pathobj, fdp->suffix, fdp->mode, fdp->type);
3480 PyMem_FREE(found_encoding);
Brett Cannon3bb42d92007-10-20 03:43:15 +00003481
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003482 return ret;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003483}
3484
Guido van Rossum79f25d91997-04-29 20:08:16 +00003485static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003486imp_find_module(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003487{
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003488 PyObject *name, *path_list = NULL;
3489 if (!PyArg_ParseTuple(args, "U|O:find_module",
3490 &name, &path_list))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003491 return NULL;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003492 return call_find_module(name, path_list);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003493}
3494
3495static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003496imp_init_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003497{
Victor Stinner95872862011-03-07 18:20:56 +01003498 PyObject *name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003499 int ret;
3500 PyObject *m;
Victor Stinner95872862011-03-07 18:20:56 +01003501 if (!PyArg_ParseTuple(args, "U:init_builtin", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003502 return NULL;
3503 ret = init_builtin(name);
3504 if (ret < 0)
3505 return NULL;
3506 if (ret == 0) {
3507 Py_INCREF(Py_None);
3508 return Py_None;
3509 }
Victor Stinner95872862011-03-07 18:20:56 +01003510 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003511 Py_XINCREF(m);
3512 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003513}
3514
Guido van Rossum79f25d91997-04-29 20:08:16 +00003515static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003516imp_init_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003517{
Victor Stinner53dc7352011-03-20 01:50:21 +01003518 PyObject *name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003519 int ret;
3520 PyObject *m;
Victor Stinner53dc7352011-03-20 01:50:21 +01003521 if (!PyArg_ParseTuple(args, "U:init_frozen", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003522 return NULL;
Victor Stinner53dc7352011-03-20 01:50:21 +01003523 ret = PyImport_ImportFrozenModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003524 if (ret < 0)
3525 return NULL;
3526 if (ret == 0) {
3527 Py_INCREF(Py_None);
3528 return Py_None;
3529 }
Victor Stinner53dc7352011-03-20 01:50:21 +01003530 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003531 Py_XINCREF(m);
3532 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003533}
3534
Guido van Rossum79f25d91997-04-29 20:08:16 +00003535static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003536imp_get_frozen_object(PyObject *self, PyObject *args)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00003537{
Victor Stinner53dc7352011-03-20 01:50:21 +01003538 PyObject *name;
Jack Jansen95ffa231995-10-03 14:38:41 +00003539
Victor Stinner53dc7352011-03-20 01:50:21 +01003540 if (!PyArg_ParseTuple(args, "U:get_frozen_object", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003541 return NULL;
3542 return get_frozen_object(name);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00003543}
3544
Guido van Rossum79f25d91997-04-29 20:08:16 +00003545static PyObject *
Brett Cannon8d110132009-03-15 02:20:16 +00003546imp_is_frozen_package(PyObject *self, PyObject *args)
3547{
Victor Stinner53dc7352011-03-20 01:50:21 +01003548 PyObject *name;
Brett Cannon8d110132009-03-15 02:20:16 +00003549
Victor Stinner53dc7352011-03-20 01:50:21 +01003550 if (!PyArg_ParseTuple(args, "U:is_frozen_package", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003551 return NULL;
3552 return is_frozen_package(name);
Brett Cannon8d110132009-03-15 02:20:16 +00003553}
3554
3555static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003556imp_is_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003557{
Victor Stinner95872862011-03-07 18:20:56 +01003558 PyObject *name;
3559 if (!PyArg_ParseTuple(args, "U:is_builtin", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003560 return NULL;
3561 return PyLong_FromLong(is_builtin(name));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003562}
3563
Guido van Rossum79f25d91997-04-29 20:08:16 +00003564static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003565imp_is_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003566{
Victor Stinner53dc7352011-03-20 01:50:21 +01003567 PyObject *name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003568 struct _frozen *p;
Victor Stinner53dc7352011-03-20 01:50:21 +01003569 if (!PyArg_ParseTuple(args, "U:is_frozen", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003570 return NULL;
3571 p = find_frozen(name);
3572 return PyBool_FromLong((long) (p == NULL ? 0 : p->size));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003573}
3574
3575static FILE *
Victor Stinner2f42ae52011-03-20 00:41:24 +01003576get_file(PyObject *pathname, PyObject *fob, char *mode)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003577{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003578 FILE *fp;
3579 if (mode[0] == 'U')
3580 mode = "r" PY_STDIOTEXTMODE;
3581 if (fob == NULL) {
Victor Stinner2f42ae52011-03-20 00:41:24 +01003582 fp = _Py_fopen(pathname, mode);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003583 }
3584 else {
3585 int fd = PyObject_AsFileDescriptor(fob);
3586 if (fd == -1)
3587 return NULL;
3588 if (!_PyVerify_fd(fd))
3589 goto error;
3590 /* the FILE struct gets a new fd, so that it can be closed
3591 * independently of the file descriptor given
3592 */
3593 fd = dup(fd);
3594 if (fd == -1)
3595 goto error;
3596 fp = fdopen(fd, mode);
3597 }
3598 if (fp)
3599 return fp;
Kristján Valur Jónssone1b04452009-03-31 17:43:39 +00003600error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003601 PyErr_SetFromErrno(PyExc_IOError);
3602 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003603}
3604
Guido van Rossum79f25d91997-04-29 20:08:16 +00003605static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003606imp_load_compiled(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003607{
Victor Stinner2f42ae52011-03-20 00:41:24 +01003608 PyObject *name, *pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003609 PyObject *fob = NULL;
3610 PyObject *m;
3611 FILE *fp;
Victor Stinner2f42ae52011-03-20 00:41:24 +01003612 if (!PyArg_ParseTuple(args, "UO&|O:load_compiled",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003613 &name,
Victor Stinner2f42ae52011-03-20 00:41:24 +01003614 PyUnicode_FSDecoder, &pathname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003615 &fob))
3616 return NULL;
Victor Stinner2f42ae52011-03-20 00:41:24 +01003617 fp = get_file(pathname, fob, "rb");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003618 if (fp == NULL) {
Victor Stinnerebc00522010-12-03 17:06:43 +00003619 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003620 return NULL;
3621 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01003622 m = load_compiled_module(name, pathname, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003623 fclose(fp);
Victor Stinnerebc00522010-12-03 17:06:43 +00003624 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003625 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003626}
3627
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003628#ifdef HAVE_DYNAMIC_LOADING
3629
Guido van Rossum79f25d91997-04-29 20:08:16 +00003630static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003631imp_load_dynamic(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003632{
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003633 PyObject *name, *pathname, *fob = NULL, *mod;
3634 FILE *fp;
3635
3636 if (!PyArg_ParseTuple(args, "UO&|O:load_dynamic",
3637 &name, PyUnicode_FSDecoder, &pathname, &fob))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003638 return NULL;
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003639 if (fob != NULL) {
3640 fp = get_file(NULL, fob, "r");
3641 if (fp == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003642 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003643 }
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003644 else
3645 fp = NULL;
3646 mod = _PyImport_LoadDynamicModule(name, pathname, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003647 if (fp)
3648 fclose(fp);
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003649 return mod;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003650}
3651
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003652#endif /* HAVE_DYNAMIC_LOADING */
3653
Guido van Rossum79f25d91997-04-29 20:08:16 +00003654static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003655imp_load_source(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003656{
Victor Stinner2f42ae52011-03-20 00:41:24 +01003657 PyObject *name, *pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003658 PyObject *fob = NULL;
3659 PyObject *m;
3660 FILE *fp;
Victor Stinner2f42ae52011-03-20 00:41:24 +01003661 if (!PyArg_ParseTuple(args, "UO&|O:load_source",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003662 &name,
Victor Stinner2f42ae52011-03-20 00:41:24 +01003663 PyUnicode_FSDecoder, &pathname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003664 &fob))
3665 return NULL;
Victor Stinner2f42ae52011-03-20 00:41:24 +01003666 fp = get_file(pathname, fob, "r");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003667 if (fp == NULL) {
Victor Stinnerebc00522010-12-03 17:06:43 +00003668 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003669 return NULL;
3670 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01003671 m = load_source_module(name, pathname, fp);
Victor Stinnerebc00522010-12-03 17:06:43 +00003672 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003673 fclose(fp);
3674 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003675}
3676
Guido van Rossum79f25d91997-04-29 20:08:16 +00003677static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003678imp_load_module(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003679{
Victor Stinner41c5fec2011-03-13 21:46:30 -04003680 PyObject *name, *fob, *pathname, *ret;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003681 char *suffix; /* Unused */
3682 char *mode;
3683 int type;
3684 FILE *fp;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003685
Victor Stinner41c5fec2011-03-13 21:46:30 -04003686 if (!PyArg_ParseTuple(args, "UOO&(ssi):load_module",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003687 &name, &fob,
Victor Stinner41c5fec2011-03-13 21:46:30 -04003688 PyUnicode_FSDecoder, &pathname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003689 &suffix, &mode, &type))
3690 return NULL;
3691 if (*mode) {
3692 /* Mode must start with 'r' or 'U' and must not contain '+'.
3693 Implicit in this test is the assumption that the mode
3694 may contain other modifiers like 'b' or 't'. */
Guido van Rossum5e2c5fa2002-05-30 17:33:07 +00003695
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003696 if (!(*mode == 'r' || *mode == 'U') || strchr(mode, '+')) {
3697 PyErr_Format(PyExc_ValueError,
3698 "invalid file open mode %.200s", mode);
Victor Stinner1a563032010-10-15 22:43:10 +00003699 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003700 return NULL;
3701 }
3702 }
3703 if (fob == Py_None)
3704 fp = NULL;
3705 else {
3706 fp = get_file(NULL, fob, mode);
3707 if (fp == NULL) {
Victor Stinner1a563032010-10-15 22:43:10 +00003708 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003709 return NULL;
3710 }
3711 }
Victor Stinner41c5fec2011-03-13 21:46:30 -04003712 ret = load_module(name, fp, pathname, type, NULL);
Victor Stinner1a563032010-10-15 22:43:10 +00003713 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003714 if (fp)
3715 fclose(fp);
3716 return ret;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003717}
3718
3719static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003720imp_load_package(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003721{
Victor Stinnerc9abda02011-03-14 13:33:46 -04003722 PyObject *name, *pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003723 PyObject * ret;
Victor Stinnerc9abda02011-03-14 13:33:46 -04003724 if (!PyArg_ParseTuple(args, "UO&:load_package",
3725 &name, PyUnicode_FSDecoder, &pathname))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003726 return NULL;
Victor Stinnerc9abda02011-03-14 13:33:46 -04003727 ret = load_package(name, pathname);
Victor Stinnerebc00522010-12-03 17:06:43 +00003728 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003729 return ret;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003730}
3731
3732static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003733imp_new_module(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003734{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003735 char *name;
3736 if (!PyArg_ParseTuple(args, "s:new_module", &name))
3737 return NULL;
3738 return PyModule_New(name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003739}
3740
Christian Heimes13a7a212008-01-07 17:13:09 +00003741static PyObject *
3742imp_reload(PyObject *self, PyObject *v)
3743{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003744 return PyImport_ReloadModule(v);
Christian Heimes13a7a212008-01-07 17:13:09 +00003745}
3746
3747PyDoc_STRVAR(doc_reload,
3748"reload(module) -> module\n\
3749\n\
3750Reload the module. The module must have been successfully imported before.");
3751
Barry Warsaw28a691b2010-04-17 00:19:56 +00003752static PyObject *
3753imp_cache_from_source(PyObject *self, PyObject *args, PyObject *kws)
3754{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003755 static char *kwlist[] = {"path", "debug_override", NULL};
Barry Warsaw28a691b2010-04-17 00:19:56 +00003756
Victor Stinner2f42ae52011-03-20 00:41:24 +01003757 PyObject *pathname, *cpathname;
Benjamin Peterson294a9fc2010-10-16 03:12:39 +00003758 PyObject *debug_override = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003759 int debug = !Py_OptimizeFlag;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003760
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003761 if (!PyArg_ParseTupleAndKeywords(
Victor Stinner3ea23dd2010-10-15 20:34:32 +00003762 args, kws, "O&|O", kwlist,
Victor Stinner2f42ae52011-03-20 00:41:24 +01003763 PyUnicode_FSDecoder, &pathname, &debug_override))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003764 return NULL;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003765
Benjamin Peterson294a9fc2010-10-16 03:12:39 +00003766 if (debug_override != NULL &&
3767 (debug = PyObject_IsTrue(debug_override)) < 0) {
Victor Stinner2f42ae52011-03-20 00:41:24 +01003768 Py_DECREF(pathname);
Benjamin Peterson294a9fc2010-10-16 03:12:39 +00003769 return NULL;
3770 }
Barry Warsaw28a691b2010-04-17 00:19:56 +00003771
Victor Stinner3ea23dd2010-10-15 20:34:32 +00003772 cpathname = make_compiled_pathname(
Victor Stinner2f42ae52011-03-20 00:41:24 +01003773 PyUnicode_AS_UNICODE(pathname),
3774 debug);
3775 Py_DECREF(pathname);
Barry Warsaw28a691b2010-04-17 00:19:56 +00003776
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003777 if (cpathname == NULL) {
3778 PyErr_Format(PyExc_SystemError, "path buffer too short");
3779 return NULL;
3780 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01003781 return cpathname;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003782}
3783
3784PyDoc_STRVAR(doc_cache_from_source,
3785"Given the path to a .py file, return the path to its .pyc/.pyo file.\n\
3786\n\
3787The .py file does not need to exist; this simply returns the path to the\n\
3788.pyc/.pyo file calculated as if the .py file were imported. The extension\n\
3789will be .pyc unless __debug__ is not defined, then it will be .pyo.\n\
3790\n\
3791If debug_override is not None, then it must be a boolean and is taken as\n\
3792the value of __debug__ instead.");
3793
3794static PyObject *
3795imp_source_from_cache(PyObject *self, PyObject *args, PyObject *kws)
3796{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003797 static char *kwlist[] = {"path", NULL};
Victor Stinnerc9abda02011-03-14 13:33:46 -04003798 PyObject *pathname, *source;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003799
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003800 if (!PyArg_ParseTupleAndKeywords(
Victor Stinnerebc00522010-12-03 17:06:43 +00003801 args, kws, "O&", kwlist,
Victor Stinnerc9abda02011-03-14 13:33:46 -04003802 PyUnicode_FSDecoder, &pathname))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003803 return NULL;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003804
Victor Stinnerc9abda02011-03-14 13:33:46 -04003805 source = make_source_pathname(pathname);
3806 if (source == NULL) {
3807 PyErr_Format(PyExc_ValueError, "Not a PEP 3147 pyc path: %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003808 pathname);
Victor Stinnerc9abda02011-03-14 13:33:46 -04003809 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003810 return NULL;
3811 }
Victor Stinnerc9abda02011-03-14 13:33:46 -04003812 Py_DECREF(pathname);
3813 return source;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003814}
3815
3816PyDoc_STRVAR(doc_source_from_cache,
3817"Given the path to a .pyc./.pyo file, return the path to its .py file.\n\
3818\n\
3819The .pyc/.pyo file does not need to exist; this simply returns the path to\n\
3820the .py file calculated to correspond to the .pyc/.pyo file. If path\n\
3821does not conform to PEP 3147 format, ValueError will be raised.");
3822
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003823/* Doc strings */
3824
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003825PyDoc_STRVAR(doc_imp,
3826"This module provides the components needed to build your own\n\
3827__import__ function. Undocumented functions are obsolete.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003828
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003829PyDoc_STRVAR(doc_find_module,
3830"find_module(name, [path]) -> (file, filename, (suffix, mode, type))\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003831Search for a module. If path is omitted or None, search for a\n\
3832built-in, frozen or special module and continue search in sys.path.\n\
3833The module name cannot contain '.'; to search for a submodule of a\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003834package, pass the submodule name and the package's __path__.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003835
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003836PyDoc_STRVAR(doc_load_module,
3837"load_module(name, file, filename, (suffix, mode, type)) -> module\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003838Load a module, given information returned by find_module().\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003839The module name must include the full package name, if any.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003840
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003841PyDoc_STRVAR(doc_get_magic,
3842"get_magic() -> string\n\
3843Return the magic number for .pyc or .pyo files.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003844
Barry Warsaw28a691b2010-04-17 00:19:56 +00003845PyDoc_STRVAR(doc_get_tag,
3846"get_tag() -> string\n\
3847Return the magic tag for .pyc or .pyo files.");
3848
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003849PyDoc_STRVAR(doc_get_suffixes,
3850"get_suffixes() -> [(suffix, mode, type), ...]\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003851Return a list of (suffix, mode, type) tuples describing the files\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003852that find_module() looks for.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003853
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003854PyDoc_STRVAR(doc_new_module,
3855"new_module(name) -> module\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003856Create a new module. Do not enter it in sys.modules.\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003857The module name must include the full package name, if any.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003858
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003859PyDoc_STRVAR(doc_lock_held,
Tim Petersa7c65092004-08-01 23:26:05 +00003860"lock_held() -> boolean\n\
3861Return True if the import lock is currently held, else False.\n\
3862On platforms without threads, return False.");
Tim Peters69232342001-08-30 05:16:13 +00003863
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00003864PyDoc_STRVAR(doc_acquire_lock,
3865"acquire_lock() -> None\n\
Neal Norwitz2294c0d2003-02-12 23:02:21 +00003866Acquires the interpreter's import lock for the current thread.\n\
3867This lock should be used by import hooks to ensure thread-safety\n\
3868when importing modules.\n\
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00003869On platforms without threads, this function does nothing.");
3870
3871PyDoc_STRVAR(doc_release_lock,
3872"release_lock() -> None\n\
3873Release the interpreter's import lock.\n\
3874On platforms without threads, this function does nothing.");
3875
Guido van Rossum79f25d91997-04-29 20:08:16 +00003876static PyMethodDef imp_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003877 {"find_module", imp_find_module, METH_VARARGS, doc_find_module},
3878 {"get_magic", imp_get_magic, METH_NOARGS, doc_get_magic},
3879 {"get_tag", imp_get_tag, METH_NOARGS, doc_get_tag},
3880 {"get_suffixes", imp_get_suffixes, METH_NOARGS, doc_get_suffixes},
3881 {"load_module", imp_load_module, METH_VARARGS, doc_load_module},
3882 {"new_module", imp_new_module, METH_VARARGS, doc_new_module},
3883 {"lock_held", imp_lock_held, METH_NOARGS, doc_lock_held},
3884 {"acquire_lock", imp_acquire_lock, METH_NOARGS, doc_acquire_lock},
3885 {"release_lock", imp_release_lock, METH_NOARGS, doc_release_lock},
3886 {"reload", imp_reload, METH_O, doc_reload},
3887 {"cache_from_source", (PyCFunction)imp_cache_from_source,
3888 METH_VARARGS | METH_KEYWORDS, doc_cache_from_source},
3889 {"source_from_cache", (PyCFunction)imp_source_from_cache,
3890 METH_VARARGS | METH_KEYWORDS, doc_source_from_cache},
3891 /* The rest are obsolete */
3892 {"get_frozen_object", imp_get_frozen_object, METH_VARARGS},
3893 {"is_frozen_package", imp_is_frozen_package, METH_VARARGS},
3894 {"init_builtin", imp_init_builtin, METH_VARARGS},
3895 {"init_frozen", imp_init_frozen, METH_VARARGS},
3896 {"is_builtin", imp_is_builtin, METH_VARARGS},
3897 {"is_frozen", imp_is_frozen, METH_VARARGS},
3898 {"load_compiled", imp_load_compiled, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003899#ifdef HAVE_DYNAMIC_LOADING
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003900 {"load_dynamic", imp_load_dynamic, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003901#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003902 {"load_package", imp_load_package, METH_VARARGS},
3903 {"load_source", imp_load_source, METH_VARARGS},
3904 {NULL, NULL} /* sentinel */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003905};
3906
Guido van Rossum1a8791e1998-08-04 22:46:29 +00003907static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003908setint(PyObject *d, char *name, int value)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003909{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003910 PyObject *v;
3911 int err;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003912
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003913 v = PyLong_FromLong((long)value);
3914 err = PyDict_SetItemString(d, name, v);
3915 Py_XDECREF(v);
3916 return err;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003917}
3918
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003919typedef struct {
3920 PyObject_HEAD
3921} NullImporter;
3922
3923static int
3924NullImporter_init(NullImporter *self, PyObject *args, PyObject *kwds)
3925{
Victor Stinner1a4d12d2010-08-13 13:07:29 +00003926#ifndef MS_WINDOWS
3927 PyObject *path;
3928 struct stat statbuf;
3929 int rv;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003930
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003931 if (!_PyArg_NoKeywords("NullImporter()", kwds))
3932 return -1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003933
Victor Stinner1a4d12d2010-08-13 13:07:29 +00003934 if (!PyArg_ParseTuple(args, "O&:NullImporter",
3935 PyUnicode_FSConverter, &path))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003936 return -1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003937
Victor Stinner1a4d12d2010-08-13 13:07:29 +00003938 if (PyBytes_GET_SIZE(path) == 0) {
3939 Py_DECREF(path);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003940 PyErr_SetString(PyExc_ImportError, "empty pathname");
3941 return -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003942 }
Victor Stinner1a4d12d2010-08-13 13:07:29 +00003943
3944 rv = stat(PyBytes_AS_STRING(path), &statbuf);
3945 Py_DECREF(path);
3946 if (rv == 0) {
3947 /* it exists */
3948 if (S_ISDIR(statbuf.st_mode)) {
3949 /* it's a directory */
3950 PyErr_SetString(PyExc_ImportError, "existing directory");
3951 return -1;
3952 }
3953 }
3954#else /* MS_WINDOWS */
3955 PyObject *pathobj;
3956 DWORD rv;
Victor Stinner255dfdb2010-09-29 10:28:51 +00003957 wchar_t *path;
Victor Stinner1a4d12d2010-08-13 13:07:29 +00003958
3959 if (!_PyArg_NoKeywords("NullImporter()", kwds))
3960 return -1;
3961
3962 if (!PyArg_ParseTuple(args, "U:NullImporter",
3963 &pathobj))
3964 return -1;
3965
3966 if (PyUnicode_GET_SIZE(pathobj) == 0) {
3967 PyErr_SetString(PyExc_ImportError, "empty pathname");
3968 return -1;
3969 }
3970
Victor Stinnerbeb4135b2010-10-07 01:02:42 +00003971 path = PyUnicode_AsWideCharString(pathobj, NULL);
Victor Stinner255dfdb2010-09-29 10:28:51 +00003972 if (path == NULL)
Victor Stinner1a4d12d2010-08-13 13:07:29 +00003973 return -1;
3974 /* see issue1293 and issue3677:
3975 * stat() on Windows doesn't recognise paths like
3976 * "e:\\shared\\" and "\\\\whiterab-c2znlh\\shared" as dirs.
3977 */
3978 rv = GetFileAttributesW(path);
Victor Stinner255dfdb2010-09-29 10:28:51 +00003979 PyMem_Free(path);
Victor Stinner1a4d12d2010-08-13 13:07:29 +00003980 if (rv != INVALID_FILE_ATTRIBUTES) {
3981 /* it exists */
3982 if (rv & FILE_ATTRIBUTE_DIRECTORY) {
3983 /* it's a directory */
3984 PyErr_SetString(PyExc_ImportError, "existing directory");
3985 return -1;
3986 }
3987 }
3988#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003989 return 0;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003990}
3991
3992static PyObject *
3993NullImporter_find_module(NullImporter *self, PyObject *args)
3994{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003995 Py_RETURN_NONE;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003996}
3997
3998static PyMethodDef NullImporter_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003999 {"find_module", (PyCFunction)NullImporter_find_module, METH_VARARGS,
4000 "Always return None"
4001 },
4002 {NULL} /* Sentinel */
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004003};
4004
4005
Christian Heimes9cd17752007-11-18 19:35:23 +00004006PyTypeObject PyNullImporter_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004007 PyVarObject_HEAD_INIT(NULL, 0)
4008 "imp.NullImporter", /*tp_name*/
4009 sizeof(NullImporter), /*tp_basicsize*/
4010 0, /*tp_itemsize*/
4011 0, /*tp_dealloc*/
4012 0, /*tp_print*/
4013 0, /*tp_getattr*/
4014 0, /*tp_setattr*/
4015 0, /*tp_reserved*/
4016 0, /*tp_repr*/
4017 0, /*tp_as_number*/
4018 0, /*tp_as_sequence*/
4019 0, /*tp_as_mapping*/
4020 0, /*tp_hash */
4021 0, /*tp_call*/
4022 0, /*tp_str*/
4023 0, /*tp_getattro*/
4024 0, /*tp_setattro*/
4025 0, /*tp_as_buffer*/
4026 Py_TPFLAGS_DEFAULT, /*tp_flags*/
4027 "Null importer object", /* tp_doc */
4028 0, /* tp_traverse */
4029 0, /* tp_clear */
4030 0, /* tp_richcompare */
4031 0, /* tp_weaklistoffset */
4032 0, /* tp_iter */
4033 0, /* tp_iternext */
4034 NullImporter_methods, /* tp_methods */
4035 0, /* tp_members */
4036 0, /* tp_getset */
4037 0, /* tp_base */
4038 0, /* tp_dict */
4039 0, /* tp_descr_get */
4040 0, /* tp_descr_set */
4041 0, /* tp_dictoffset */
4042 (initproc)NullImporter_init, /* tp_init */
4043 0, /* tp_alloc */
4044 PyType_GenericNew /* tp_new */
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004045};
4046
Martin v. Löwis1a214512008-06-11 05:26:20 +00004047static struct PyModuleDef impmodule = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004048 PyModuleDef_HEAD_INIT,
4049 "imp",
4050 doc_imp,
4051 0,
4052 imp_methods,
4053 NULL,
4054 NULL,
4055 NULL,
4056 NULL
Martin v. Löwis1a214512008-06-11 05:26:20 +00004057};
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004058
Jason Tishler6bc06ec2003-09-04 11:59:50 +00004059PyMODINIT_FUNC
Martin v. Löwis1a214512008-06-11 05:26:20 +00004060PyInit_imp(void)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004061{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004062 PyObject *m, *d;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004063
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004064 if (PyType_Ready(&PyNullImporter_Type) < 0)
4065 return NULL;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004066
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004067 m = PyModule_Create(&impmodule);
4068 if (m == NULL)
4069 goto failure;
4070 d = PyModule_GetDict(m);
4071 if (d == NULL)
4072 goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004073
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004074 if (setint(d, "SEARCH_ERROR", SEARCH_ERROR) < 0) goto failure;
4075 if (setint(d, "PY_SOURCE", PY_SOURCE) < 0) goto failure;
4076 if (setint(d, "PY_COMPILED", PY_COMPILED) < 0) goto failure;
4077 if (setint(d, "C_EXTENSION", C_EXTENSION) < 0) goto failure;
4078 if (setint(d, "PY_RESOURCE", PY_RESOURCE) < 0) goto failure;
4079 if (setint(d, "PKG_DIRECTORY", PKG_DIRECTORY) < 0) goto failure;
4080 if (setint(d, "C_BUILTIN", C_BUILTIN) < 0) goto failure;
4081 if (setint(d, "PY_FROZEN", PY_FROZEN) < 0) goto failure;
4082 if (setint(d, "PY_CODERESOURCE", PY_CODERESOURCE) < 0) goto failure;
4083 if (setint(d, "IMP_HOOK", IMP_HOOK) < 0) goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004084
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004085 Py_INCREF(&PyNullImporter_Type);
4086 PyModule_AddObject(m, "NullImporter", (PyObject *)&PyNullImporter_Type);
4087 return m;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00004088 failure:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004089 Py_XDECREF(m);
4090 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004091}
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004092
4093
Guido van Rossumb18618d2000-05-03 23:44:39 +00004094/* API for embedding applications that want to add their own entries
4095 to the table of built-in modules. This should normally be called
4096 *before* Py_Initialize(). When the table resize fails, -1 is
4097 returned and the existing table is unchanged.
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004098
4099 After a similar function by Just van Rossum. */
4100
4101int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00004102PyImport_ExtendInittab(struct _inittab *newtab)
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004103{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004104 static struct _inittab *our_copy = NULL;
4105 struct _inittab *p;
4106 int i, n;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004107
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004108 /* Count the number of entries in both tables */
4109 for (n = 0; newtab[n].name != NULL; n++)
4110 ;
4111 if (n == 0)
4112 return 0; /* Nothing to do */
4113 for (i = 0; PyImport_Inittab[i].name != NULL; i++)
4114 ;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004115
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004116 /* Allocate new memory for the combined table */
4117 p = our_copy;
4118 PyMem_RESIZE(p, struct _inittab, i+n+1);
4119 if (p == NULL)
4120 return -1;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004121
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004122 /* Copy the tables into the new memory */
4123 if (our_copy != PyImport_Inittab)
4124 memcpy(p, PyImport_Inittab, (i+1) * sizeof(struct _inittab));
4125 PyImport_Inittab = our_copy = p;
4126 memcpy(p+i, newtab, (n+1) * sizeof(struct _inittab));
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004127
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004128 return 0;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004129}
4130
4131/* Shorthand to add a single entry given a name and a function */
4132
4133int
Brett Cannona826f322009-04-02 03:41:46 +00004134PyImport_AppendInittab(const char *name, PyObject* (*initfunc)(void))
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004135{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004136 struct _inittab newtab[2];
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004137
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004138 memset(newtab, '\0', sizeof newtab);
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004139
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004140 newtab[0].name = (char *)name;
4141 newtab[0].initfunc = initfunc;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004142
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004143 return PyImport_ExtendInittab(newtab);
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004144}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00004145
4146#ifdef __cplusplus
4147}
4148#endif