blob: 00a9eccaf879e586ea8a99e2647b025a3799522d [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 Stinnerc6963162011-03-12 09:26:54 -05001494static struct filedescr *find_module(char *, const char *, 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 Stinnerc9abda02011-03-14 13:33:46 -04001510 char *namestr;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001511
Victor Stinnerc9abda02011-03-14 13:33:46 -04001512 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001513 if (m == NULL)
1514 return NULL;
1515 if (Py_VerboseFlag)
Victor Stinnerc9abda02011-03-14 13:33:46 -04001516 PySys_FormatStderr("import %U # directory %U\n",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001517 name, pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001518 file = get_sourcefile(pathname);
1519 if (file == NULL)
Victor Stinnerc9abda02011-03-14 13:33:46 -04001520 return NULL;
1521 path_list = Py_BuildValue("[O]", file);
1522 if (path_list == NULL) {
1523 Py_DECREF(file);
1524 return NULL;
1525 }
1526 d = PyModule_GetDict(m);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001527 err = PyDict_SetItemString(d, "__file__", file);
Victor Stinnerc9abda02011-03-14 13:33:46 -04001528 Py_DECREF(file);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001529 if (err == 0)
Victor Stinnerc9abda02011-03-14 13:33:46 -04001530 err = PyDict_SetItemString(d, "__path__", path_list);
1531 if (err != 0) {
1532 Py_DECREF(path_list);
1533 return NULL;
1534 }
1535 namestr = _PyUnicode_AsString(name);
1536 if (namestr == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001537 goto error;
Victor Stinnerc9abda02011-03-14 13:33:46 -04001538 fdp = find_module(namestr, "__init__", path_list, buf, sizeof(buf), &fp, NULL);
1539 Py_DECREF(path_list);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001540 if (fdp == NULL) {
1541 if (PyErr_ExceptionMatches(PyExc_ImportError)) {
1542 PyErr_Clear();
1543 Py_INCREF(m);
Victor Stinnerc9abda02011-03-14 13:33:46 -04001544 return m;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001545 }
1546 else
Victor Stinnerc9abda02011-03-14 13:33:46 -04001547 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001548 }
Victor Stinner41c5fec2011-03-13 21:46:30 -04001549 bufobj = PyUnicode_DecodeFSDefault(buf);
1550 if (bufobj != NULL) {
1551 m = load_module(name, fp, bufobj, fdp->type, NULL);
1552 Py_DECREF(bufobj);
1553 }
1554 else
1555 m = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001556 if (fp != NULL)
1557 fclose(fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001558 return m;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001559}
1560
1561
1562/* Helper to test for built-in module */
1563
1564static int
Victor Stinner95872862011-03-07 18:20:56 +01001565is_builtin(PyObject *name)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001566{
Victor Stinner95872862011-03-07 18:20:56 +01001567 int i, cmp;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001568 for (i = 0; PyImport_Inittab[i].name != NULL; i++) {
Victor Stinner95872862011-03-07 18:20:56 +01001569 cmp = PyUnicode_CompareWithASCIIString(name, PyImport_Inittab[i].name);
1570 if (cmp == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001571 if (PyImport_Inittab[i].initfunc == NULL)
1572 return -1;
1573 else
1574 return 1;
1575 }
1576 }
1577 return 0;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001578}
1579
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001580
Just van Rossum52e14d62002-12-30 22:08:05 +00001581/* Return an importer object for a sys.path/pkg.__path__ item 'p',
1582 possibly by fetching it from the path_importer_cache dict. If it
Thomas Wouters89f507f2006-12-13 04:49:30 +00001583 wasn't yet cached, traverse path_hooks until a hook is found
Just van Rossum52e14d62002-12-30 22:08:05 +00001584 that can handle the path item. Return None if no hook could;
1585 this tells our caller it should fall back to the builtin
1586 import mechanism. Cache the result in path_importer_cache.
1587 Returns a borrowed reference. */
1588
1589static PyObject *
1590get_path_importer(PyObject *path_importer_cache, PyObject *path_hooks,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001591 PyObject *p)
Just van Rossum52e14d62002-12-30 22:08:05 +00001592{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001593 PyObject *importer;
1594 Py_ssize_t j, nhooks;
Just van Rossum52e14d62002-12-30 22:08:05 +00001595
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001596 /* These conditions are the caller's responsibility: */
1597 assert(PyList_Check(path_hooks));
1598 assert(PyDict_Check(path_importer_cache));
Just van Rossum52e14d62002-12-30 22:08:05 +00001599
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001600 nhooks = PyList_Size(path_hooks);
1601 if (nhooks < 0)
1602 return NULL; /* Shouldn't happen */
Just van Rossum52e14d62002-12-30 22:08:05 +00001603
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001604 importer = PyDict_GetItem(path_importer_cache, p);
1605 if (importer != NULL)
1606 return importer;
Just van Rossum52e14d62002-12-30 22:08:05 +00001607
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001608 /* set path_importer_cache[p] to None to avoid recursion */
1609 if (PyDict_SetItem(path_importer_cache, p, Py_None) != 0)
1610 return NULL;
Just van Rossum52e14d62002-12-30 22:08:05 +00001611
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001612 for (j = 0; j < nhooks; j++) {
1613 PyObject *hook = PyList_GetItem(path_hooks, j);
1614 if (hook == NULL)
1615 return NULL;
1616 importer = PyObject_CallFunctionObjArgs(hook, p, NULL);
1617 if (importer != NULL)
1618 break;
Just van Rossum52e14d62002-12-30 22:08:05 +00001619
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001620 if (!PyErr_ExceptionMatches(PyExc_ImportError)) {
1621 return NULL;
1622 }
1623 PyErr_Clear();
1624 }
1625 if (importer == NULL) {
1626 importer = PyObject_CallFunctionObjArgs(
1627 (PyObject *)&PyNullImporter_Type, p, NULL
1628 );
1629 if (importer == NULL) {
1630 if (PyErr_ExceptionMatches(PyExc_ImportError)) {
1631 PyErr_Clear();
1632 return Py_None;
1633 }
1634 }
1635 }
1636 if (importer != NULL) {
1637 int err = PyDict_SetItem(path_importer_cache, p, importer);
1638 Py_DECREF(importer);
1639 if (err != 0)
1640 return NULL;
1641 }
1642 return importer;
Just van Rossum52e14d62002-12-30 22:08:05 +00001643}
1644
Christian Heimes9cd17752007-11-18 19:35:23 +00001645PyAPI_FUNC(PyObject *)
1646PyImport_GetImporter(PyObject *path) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001647 PyObject *importer=NULL, *path_importer_cache=NULL, *path_hooks=NULL;
Christian Heimes9cd17752007-11-18 19:35:23 +00001648
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001649 if ((path_importer_cache = PySys_GetObject("path_importer_cache"))) {
1650 if ((path_hooks = PySys_GetObject("path_hooks"))) {
1651 importer = get_path_importer(path_importer_cache,
1652 path_hooks, path);
1653 }
1654 }
1655 Py_XINCREF(importer); /* get_path_importer returns a borrowed reference */
1656 return importer;
Christian Heimes9cd17752007-11-18 19:35:23 +00001657}
1658
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001659/* Search the path (default sys.path) for a module. Return the
1660 corresponding filedescr struct, and (via return arguments) the
1661 pathname and an open file. Return NULL if the module is not found. */
1662
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001663#ifdef MS_COREDLL
Victor Stinner4d6c1c42011-03-08 23:49:04 +01001664extern FILE *_PyWin_FindRegisteredModule(PyObject *, struct filedescr **,
1665 PyObject **p_path);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001666#endif
1667
Victor Stinnerc6963162011-03-12 09:26:54 -05001668static int case_ok(char *, Py_ssize_t, Py_ssize_t, const char *);
Tim Petersdbd9ba62000-07-09 03:09:57 +00001669static int find_init_module(char *); /* Forward */
Just van Rossum52e14d62002-12-30 22:08:05 +00001670static struct filedescr importhookdescr = {"", "", IMP_HOOK};
Guido van Rossum197346f1997-10-31 18:38:52 +00001671
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001672/* Get the path of a module: get its importer and call importer.find_module()
1673 hook, or check if the module if a package (if path/__init__.py exists).
1674
1675 -1: error: a Python error occurred
1676 0: ignore: an error occurred because of invalid data, but the error is not
1677 important enough to be reported.
1678 1: get path: module not found, but *buf contains its path
1679 2: found: *p_fd is the file descriptor (IMP_HOOK or PKG_DIRECTORY)
1680 and *buf is the path */
1681
1682static int
1683find_module_path(char *fullname, const char *name, PyObject *path,
1684 PyObject *path_hooks, PyObject *path_importer_cache,
1685 char *buf, size_t buflen,
1686 PyObject **p_loader, struct filedescr **p_fd)
1687{
1688 PyObject *path_bytes;
1689 const char *base;
1690 Py_ssize_t len;
1691 size_t namelen;
1692 struct stat statbuf;
1693 static struct filedescr fd_package = {"", "", PKG_DIRECTORY};
1694
1695 if (PyUnicode_Check(path)) {
1696 path_bytes = PyUnicode_EncodeFSDefault(path);
1697 if (path_bytes == NULL)
1698 return -1;
1699 }
1700 else if (PyBytes_Check(path)) {
1701 Py_INCREF(path);
1702 path_bytes = path;
1703 }
1704 else
1705 return 0;
1706
1707 namelen = strlen(name);
1708 base = PyBytes_AS_STRING(path_bytes);
1709 len = PyBytes_GET_SIZE(path_bytes);
1710 if (len + 2 + namelen + MAXSUFFIXSIZE >= buflen) {
1711 Py_DECREF(path_bytes);
1712 return 0; /* Too long */
1713 }
1714 strcpy(buf, base);
1715 Py_DECREF(path_bytes);
1716
1717 if (strlen(buf) != len) {
1718 return 0; /* path_bytes contains '\0' */
1719 }
1720
1721 /* sys.path_hooks import hook */
1722 if (p_loader != NULL) {
1723 PyObject *importer;
1724
1725 importer = get_path_importer(path_importer_cache,
1726 path_hooks, path);
1727 if (importer == NULL) {
1728 return -1;
1729 }
1730 /* Note: importer is a borrowed reference */
1731 if (importer != Py_None) {
1732 PyObject *loader;
1733 loader = PyObject_CallMethod(importer,
1734 "find_module",
1735 "s", fullname);
1736 if (loader == NULL)
1737 return -1; /* error */
1738 if (loader != Py_None) {
1739 /* a loader was found */
1740 *p_loader = loader;
1741 *p_fd = &importhookdescr;
1742 return 2;
1743 }
1744 Py_DECREF(loader);
1745 return 0;
1746 }
1747 }
1748 /* no hook was found, use builtin import */
1749
1750 if (len > 0 && buf[len-1] != SEP
1751#ifdef ALTSEP
1752 && buf[len-1] != ALTSEP
1753#endif
1754 )
1755 buf[len++] = SEP;
1756 strcpy(buf+len, name);
1757 len += namelen;
1758
1759 /* Check for package import (buf holds a directory name,
1760 and there's an __init__ module in that directory */
1761#ifdef HAVE_STAT
1762 if (stat(buf, &statbuf) == 0 && /* it exists */
1763 S_ISDIR(statbuf.st_mode) && /* it's a directory */
1764 case_ok(buf, len, namelen, name)) { /* case matches */
1765 if (find_init_module(buf)) { /* and has __init__.py */
1766 *p_fd = &fd_package;
1767 return 2;
1768 }
1769 else {
1770 int err;
1771 PyObject *unicode = PyUnicode_DecodeFSDefault(buf);
1772 if (unicode == NULL)
1773 return -1;
1774 err = PyErr_WarnFormat(PyExc_ImportWarning, 1,
1775 "Not importing directory '%U': missing __init__.py",
1776 unicode);
1777 Py_DECREF(unicode);
1778 if (err)
1779 return -1;
1780 }
1781 }
1782#endif
1783 return 1;
1784}
1785
1786/* Find a module in search_path_list. For each path, try
1787 find_module_filename() or try each _PyImport_Filetab suffix.
1788
1789 If the module is found, return a file descriptor, write the path in
1790 *p_filename, write the pointer to the file object into *p_fp, and (if
1791 p_loader is not NULL) the loader into *p_loader.
1792
1793 Otherwise, raise an exception and return NULL. */
1794
Victor Stinner37580282011-03-20 01:34:43 +01001795static struct filedescr*
1796find_module_path_list(char *fullname, const char *name,
1797 PyObject *search_path_list, PyObject *path_hooks,
1798 PyObject *path_importer_cache,
1799 char *buf, size_t buflen,
1800 FILE **p_fp, PyObject **p_loader)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001801{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001802 Py_ssize_t i, npath;
1803 size_t len, namelen;
1804 struct filedescr *fdp = NULL;
1805 char *filemode;
1806 FILE *fp = NULL;
Andrew MacIntyred9400542002-02-26 11:41:34 +00001807#if defined(PYOS_OS2)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001808 size_t saved_len;
1809 size_t saved_namelen;
1810 char *saved_buf = NULL;
Andrew MacIntyred9400542002-02-26 11:41:34 +00001811#endif
Victor Stinner53dc7352011-03-20 01:50:21 +01001812
Victor Stinner37580282011-03-20 01:34:43 +01001813 npath = PyList_Size(search_path_list);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001814 namelen = strlen(name);
1815 for (i = 0; i < npath; i++) {
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001816 PyObject *path;
1817 int ok;
1818
1819 path = PyList_GetItem(search_path_list, i);
1820 if (path == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001821 return NULL;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001822
1823 ok = find_module_path(fullname, name, path,
1824 path_hooks, path_importer_cache,
1825 buf, buflen,
1826 p_loader, &fdp);
1827 if (ok < 0)
1828 return NULL;
1829 if (ok == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001830 continue;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001831 if (ok == 2)
1832 return fdp;
Amaury Forgeot d'Arcf1ca0b12008-06-11 17:40:47 +00001833
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001834 len = strlen(buf);
Andrew MacIntyred9400542002-02-26 11:41:34 +00001835#if defined(PYOS_OS2)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001836 /* take a snapshot of the module spec for restoration
1837 * after the 8 character DLL hackery
1838 */
1839 saved_buf = strdup(buf);
1840 saved_len = len;
1841 saved_namelen = namelen;
Andrew MacIntyred9400542002-02-26 11:41:34 +00001842#endif /* PYOS_OS2 */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001843 for (fdp = _PyImport_Filetab; fdp->suffix != NULL; fdp++) {
Guido van Rossum04110fb2007-08-24 16:32:05 +00001844#if defined(PYOS_OS2) && defined(HAVE_DYNAMIC_LOADING)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001845 /* OS/2 limits DLLs to 8 character names (w/o
1846 extension)
1847 * so if the name is longer than that and its a
1848 * dynamically loaded module we're going to try,
1849 * truncate the name before trying
1850 */
Victor Stinnerc6963162011-03-12 09:26:54 -05001851 if (strlen(name) > 8) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001852 /* is this an attempt to load a C extension? */
1853 const struct filedescr *scan;
1854 scan = _PyImport_DynLoadFiletab;
1855 while (scan->suffix != NULL) {
1856 if (!strcmp(scan->suffix, fdp->suffix))
1857 break;
1858 else
1859 scan++;
1860 }
1861 if (scan->suffix != NULL) {
1862 /* yes, so truncate the name */
1863 namelen = 8;
Victor Stinnerc6963162011-03-12 09:26:54 -05001864 len -= strlen(name) - namelen;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001865 buf[len] = '\0';
1866 }
1867 }
Andrew MacIntyred9400542002-02-26 11:41:34 +00001868#endif /* PYOS_OS2 */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001869 strcpy(buf+len, fdp->suffix);
1870 if (Py_VerboseFlag > 1)
1871 PySys_WriteStderr("# trying %s\n", buf);
1872 filemode = fdp->mode;
1873 if (filemode[0] == 'U')
1874 filemode = "r" PY_STDIOTEXTMODE;
1875 fp = fopen(buf, filemode);
1876 if (fp != NULL) {
1877 if (case_ok(buf, len, namelen, name))
1878 break;
1879 else { /* continue search */
1880 fclose(fp);
1881 fp = NULL;
1882 }
1883 }
Andrew MacIntyred9400542002-02-26 11:41:34 +00001884#if defined(PYOS_OS2)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001885 /* restore the saved snapshot */
1886 strcpy(buf, saved_buf);
1887 len = saved_len;
1888 namelen = saved_namelen;
Andrew MacIntyred9400542002-02-26 11:41:34 +00001889#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001890 }
Andrew MacIntyred9400542002-02-26 11:41:34 +00001891#if defined(PYOS_OS2)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001892 /* don't need/want the module name snapshot anymore */
1893 if (saved_buf)
1894 {
1895 free(saved_buf);
1896 saved_buf = NULL;
1897 }
Andrew MacIntyred9400542002-02-26 11:41:34 +00001898#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001899 if (fp != NULL)
1900 break;
1901 }
1902 if (fp == NULL) {
1903 PyErr_Format(PyExc_ImportError,
1904 "No module named %.200s", name);
1905 return NULL;
1906 }
1907 *p_fp = fp;
1908 return fdp;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001909}
1910
Victor Stinner37580282011-03-20 01:34:43 +01001911/* Find a module:
1912
1913 - try find_module() of each sys.meta_path hook
1914 - try find_frozen()
1915 - try is_builtin()
1916 - try _PyWin_FindRegisteredModule() (Windows only)
1917 - otherwise, call find_module_path_list() with search_path_list (if not
1918 NULL) or sys.path
1919
1920 Return:
1921
1922 - &fd_builtin (C_BUILTIN) if it is a builtin
1923 - &fd_frozen (PY_FROZEN) if it is frozen
1924 - &fd_package (PKG_DIRECTORY) and write the filename into *buf
1925 if it is a package
1926 - &importhookdescr (IMP_HOOK) and write the loader into *p_loader if a
1927 importer loader was found
1928 - a file descriptor (PY_SOURCE, PY_COMPILED, C_EXTENSION, PY_RESOURCE or
1929 PY_CODERESOURCE: see _PyImport_Filetab), write the filename into
1930 *buf and the pointer to the open file into *p_fp
1931 - NULL on error
1932
1933 By default, write an empty string into *buf, and *p_fp and *p_loader (if
1934 set) are set to NULL. Eg. *buf is an empty string for a builtin package. */
1935
1936static struct filedescr *
1937find_module(char *fullname, const char *name, PyObject *search_path_list,
1938 char *buf, size_t buflen, FILE **p_fp, PyObject **p_loader)
1939{
1940 Py_ssize_t i, npath;
1941 static struct filedescr fd_frozen = {"", "", PY_FROZEN};
1942 static struct filedescr fd_builtin = {"", "", C_BUILTIN};
1943 PyObject *path_hooks, *path_importer_cache;
1944 PyObject *fullname_obj, *nameobj;
1945
1946 *buf = '\0';
1947 *p_fp = NULL;
1948 if (p_loader != NULL)
1949 *p_loader = NULL;
1950
1951 if (strlen(name) > MAXPATHLEN) {
1952 PyErr_SetString(PyExc_OverflowError,
1953 "module name is too long");
1954 return NULL;
1955 }
1956
1957 /* sys.meta_path import hook */
1958 if (p_loader != NULL) {
1959 PyObject *meta_path;
1960
1961 meta_path = PySys_GetObject("meta_path");
1962 if (meta_path == NULL || !PyList_Check(meta_path)) {
1963 PyErr_SetString(PyExc_ImportError,
1964 "sys.meta_path must be a list of "
1965 "import hooks");
1966 return NULL;
1967 }
1968 Py_INCREF(meta_path); /* zap guard */
1969 npath = PyList_Size(meta_path);
1970 for (i = 0; i < npath; i++) {
1971 PyObject *loader;
1972 PyObject *hook = PyList_GetItem(meta_path, i);
1973 loader = PyObject_CallMethod(hook, "find_module",
1974 "sO", fullname,
1975 search_path_list != NULL ?
1976 search_path_list : Py_None);
1977 if (loader == NULL) {
1978 Py_DECREF(meta_path);
1979 return NULL; /* true error */
1980 }
1981 if (loader != Py_None) {
1982 /* a loader was found */
1983 *p_loader = loader;
1984 Py_DECREF(meta_path);
1985 return &importhookdescr;
1986 }
1987 Py_DECREF(loader);
1988 }
1989 Py_DECREF(meta_path);
1990 }
1991
1992 if (fullname != NULL) {
1993 fullname_obj = PyUnicode_FromString(fullname);
1994 if (fullname == NULL)
1995 return NULL;
1996 if (find_frozen(fullname_obj) != NULL) {
1997 Py_DECREF(fullname_obj);
1998 strcpy(buf, fullname);
1999 return &fd_frozen;
2000 }
2001 Py_DECREF(fullname_obj);
2002 }
2003
2004 if (search_path_list == NULL) {
2005#ifdef MS_COREDLL
2006 FILE *fp;
2007 struct filedescr *fdp;
2008 PyObject *filename, *filename_bytes;
2009#endif
2010 nameobj = PyUnicode_FromString(name);
2011 if (nameobj == NULL)
2012 return NULL;
2013 if (is_builtin(nameobj)) {
2014 Py_DECREF(nameobj);
2015 strcpy(buf, name);
2016 return &fd_builtin;
2017 }
2018#ifdef MS_COREDLL
2019 fp = _PyWin_FindRegisteredModule(nameobj, &fdp, &filename);
2020 if (fp != NULL) {
2021 Py_DECREF(nameobj);
2022 filename_bytes = PyUnicode_EncodeFSDefault(filename);
2023 Py_DECREF(filename);
2024 if (filename_bytes == NULL)
2025 return NULL;
2026 strncpy(buf, PyBytes_AS_STRING(filename_bytes), buflen);
2027 buf[buflen-1] = '\0';
2028 Py_DECREF(filename_bytes);
2029 *p_fp = fp;
2030 return fdp;
2031 }
2032 else if (PyErr_Occurred())
2033 return NULL;
2034#endif
2035 Py_DECREF(nameobj);
2036 search_path_list = PySys_GetObject("path");
2037 }
2038
2039 if (search_path_list == NULL || !PyList_Check(search_path_list)) {
2040 PyErr_SetString(PyExc_ImportError,
2041 "sys.path must be a list of directory names");
2042 return NULL;
2043 }
2044
2045 path_hooks = PySys_GetObject("path_hooks");
2046 if (path_hooks == NULL || !PyList_Check(path_hooks)) {
2047 PyErr_SetString(PyExc_ImportError,
2048 "sys.path_hooks must be a list of "
2049 "import hooks");
2050 return NULL;
2051 }
2052 path_importer_cache = PySys_GetObject("path_importer_cache");
2053 if (path_importer_cache == NULL ||
2054 !PyDict_Check(path_importer_cache)) {
2055 PyErr_SetString(PyExc_ImportError,
2056 "sys.path_importer_cache must be a dict");
2057 return NULL;
2058 }
2059
2060 return find_module_path_list(fullname, name,
2061 search_path_list, path_hooks,
2062 path_importer_cache,
2063 buf, buflen,
2064 p_fp, p_loader);
2065}
2066
Martin v. Löwis18e16552006-02-15 17:27:45 +00002067/* case_ok(char* buf, Py_ssize_t len, Py_ssize_t namelen, char* name)
Tim Petersd1e87a82001-03-01 18:12:00 +00002068 * The arguments here are tricky, best shown by example:
2069 * /a/b/c/d/e/f/g/h/i/j/k/some_long_module_name.py\0
2070 * ^ ^ ^ ^
2071 * |--------------------- buf ---------------------|
2072 * |------------------- len ------------------|
2073 * |------ name -------|
2074 * |----- namelen -----|
2075 * buf is the full path, but len only counts up to (& exclusive of) the
2076 * extension. name is the module name, also exclusive of extension.
2077 *
2078 * We've already done a successful stat() or fopen() on buf, so know that
2079 * there's some match, possibly case-insensitive.
2080 *
Tim Peters50d8d372001-02-28 05:34:27 +00002081 * case_ok() is to return 1 if there's a case-sensitive match for
2082 * name, else 0. case_ok() is also to return 1 if envar PYTHONCASEOK
2083 * exists.
Tim Petersd1e87a82001-03-01 18:12:00 +00002084 *
Tim Peters50d8d372001-02-28 05:34:27 +00002085 * case_ok() is used to implement case-sensitive import semantics even
2086 * on platforms with case-insensitive filesystems. It's trivial to implement
2087 * for case-sensitive filesystems. It's pretty much a cross-platform
2088 * nightmare for systems with case-insensitive filesystems.
2089 */
Guido van Rossum0980bd91998-02-13 17:18:36 +00002090
Tim Peters50d8d372001-02-28 05:34:27 +00002091/* First we may need a pile of platform-specific header files; the sequence
2092 * of #if's here should match the sequence in the body of case_ok().
2093 */
Jason Tishler7961aa62005-05-20 00:56:54 +00002094#if defined(MS_WINDOWS)
Guido van Rossum0980bd91998-02-13 17:18:36 +00002095#include <windows.h>
Guido van Rossum4c3f57c2001-01-10 20:40:46 +00002096
Tim Peters50d8d372001-02-28 05:34:27 +00002097#elif defined(DJGPP)
2098#include <dir.h>
2099
Jason Tishler7961aa62005-05-20 00:56:54 +00002100#elif (defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) && defined(HAVE_DIRENT_H)
Tim Peters430f5d42001-03-01 01:30:56 +00002101#include <sys/types.h>
2102#include <dirent.h>
2103
Andrew MacIntyred9400542002-02-26 11:41:34 +00002104#elif defined(PYOS_OS2)
2105#define INCL_DOS
2106#define INCL_DOSERRORS
2107#define INCL_NOPMAPI
2108#include <os2.h>
Tim Peters50d8d372001-02-28 05:34:27 +00002109#endif
2110
Guido van Rossum0980bd91998-02-13 17:18:36 +00002111static int
Victor Stinnerc6963162011-03-12 09:26:54 -05002112case_ok(char *buf, Py_ssize_t len, Py_ssize_t namelen, const char *name)
Guido van Rossum0980bd91998-02-13 17:18:36 +00002113{
Tim Peters50d8d372001-02-28 05:34:27 +00002114/* Pick a platform-specific implementation; the sequence of #if's here should
2115 * match the sequence just above.
2116 */
2117
Jason Tishler7961aa62005-05-20 00:56:54 +00002118/* MS_WINDOWS */
2119#if defined(MS_WINDOWS)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002120 WIN32_FIND_DATA data;
2121 HANDLE h;
Tim Peters50d8d372001-02-28 05:34:27 +00002122
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002123 if (Py_GETENV("PYTHONCASEOK") != NULL)
2124 return 1;
Tim Peters50d8d372001-02-28 05:34:27 +00002125
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002126 h = FindFirstFile(buf, &data);
2127 if (h == INVALID_HANDLE_VALUE) {
2128 PyErr_Format(PyExc_NameError,
2129 "Can't find file for module %.100s\n(filename %.300s)",
2130 name, buf);
2131 return 0;
2132 }
2133 FindClose(h);
2134 return strncmp(data.cFileName, name, namelen) == 0;
Tim Peters50d8d372001-02-28 05:34:27 +00002135
2136/* DJGPP */
2137#elif defined(DJGPP)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002138 struct ffblk ffblk;
2139 int done;
Tim Peters50d8d372001-02-28 05:34:27 +00002140
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002141 if (Py_GETENV("PYTHONCASEOK") != NULL)
2142 return 1;
Tim Peters50d8d372001-02-28 05:34:27 +00002143
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002144 done = findfirst(buf, &ffblk, FA_ARCH|FA_RDONLY|FA_HIDDEN|FA_DIREC);
2145 if (done) {
2146 PyErr_Format(PyExc_NameError,
2147 "Can't find file for module %.100s\n(filename %.300s)",
2148 name, buf);
2149 return 0;
2150 }
2151 return strncmp(ffblk.ff_name, name, namelen) == 0;
Guido van Rossum0980bd91998-02-13 17:18:36 +00002152
Jason Tishler7961aa62005-05-20 00:56:54 +00002153/* new-fangled macintosh (macosx) or Cygwin */
2154#elif (defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) && defined(HAVE_DIRENT_H)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002155 DIR *dirp;
2156 struct dirent *dp;
2157 char dirname[MAXPATHLEN + 1];
2158 const int dirlen = len - namelen - 1; /* don't want trailing SEP */
Tim Peters430f5d42001-03-01 01:30:56 +00002159
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002160 if (Py_GETENV("PYTHONCASEOK") != NULL)
2161 return 1;
Tim Petersdbe6ebb2001-03-01 08:47:29 +00002162
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002163 /* Copy the dir component into dirname; substitute "." if empty */
2164 if (dirlen <= 0) {
2165 dirname[0] = '.';
2166 dirname[1] = '\0';
2167 }
2168 else {
2169 assert(dirlen <= MAXPATHLEN);
2170 memcpy(dirname, buf, dirlen);
2171 dirname[dirlen] = '\0';
2172 }
2173 /* Open the directory and search the entries for an exact match. */
2174 dirp = opendir(dirname);
2175 if (dirp) {
2176 char *nameWithExt = buf + len - namelen;
2177 while ((dp = readdir(dirp)) != NULL) {
2178 const int thislen =
Tim Peters430f5d42001-03-01 01:30:56 +00002179#ifdef _DIRENT_HAVE_D_NAMELEN
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002180 dp->d_namlen;
Tim Peters430f5d42001-03-01 01:30:56 +00002181#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002182 strlen(dp->d_name);
Tim Peters430f5d42001-03-01 01:30:56 +00002183#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002184 if (thislen >= namelen &&
2185 strcmp(dp->d_name, nameWithExt) == 0) {
2186 (void)closedir(dirp);
2187 return 1; /* Found */
2188 }
2189 }
2190 (void)closedir(dirp);
2191 }
2192 return 0 ; /* Not found */
Tim Peters430f5d42001-03-01 01:30:56 +00002193
Andrew MacIntyred9400542002-02-26 11:41:34 +00002194/* OS/2 */
2195#elif defined(PYOS_OS2)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002196 HDIR hdir = 1;
2197 ULONG srchcnt = 1;
2198 FILEFINDBUF3 ffbuf;
2199 APIRET rc;
Andrew MacIntyred9400542002-02-26 11:41:34 +00002200
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002201 if (Py_GETENV("PYTHONCASEOK") != NULL)
2202 return 1;
Andrew MacIntyred9400542002-02-26 11:41:34 +00002203
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002204 rc = DosFindFirst(buf,
2205 &hdir,
2206 FILE_READONLY | FILE_HIDDEN | FILE_SYSTEM | FILE_DIRECTORY,
2207 &ffbuf, sizeof(ffbuf),
2208 &srchcnt,
2209 FIL_STANDARD);
2210 if (rc != NO_ERROR)
2211 return 0;
2212 return strncmp(ffbuf.achName, name, namelen) == 0;
Andrew MacIntyred9400542002-02-26 11:41:34 +00002213
Tim Peters50d8d372001-02-28 05:34:27 +00002214/* assuming it's a case-sensitive filesystem, so there's nothing to do! */
2215#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002216 return 1;
Guido van Rossum0980bd91998-02-13 17:18:36 +00002217
Guido van Rossum4d1b3b91998-02-13 23:27:59 +00002218#endif
Tim Peters50d8d372001-02-28 05:34:27 +00002219}
Guido van Rossum4d1b3b91998-02-13 23:27:59 +00002220
Guido van Rossum197346f1997-10-31 18:38:52 +00002221#ifdef HAVE_STAT
Victor Stinner4f4402c2010-08-14 14:50:26 +00002222
Guido van Rossum197346f1997-10-31 18:38:52 +00002223/* Helper to look for __init__.py or __init__.py[co] in potential package */
2224static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002225find_init_module(char *buf)
Guido van Rossum197346f1997-10-31 18:38:52 +00002226{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002227 const size_t save_len = strlen(buf);
2228 size_t i = save_len;
2229 char *pname; /* pointer to start of __init__ */
2230 struct stat statbuf;
Guido van Rossum197346f1997-10-31 18:38:52 +00002231
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002232/* For calling case_ok(buf, len, namelen, name):
2233 * /a/b/c/d/e/f/g/h/i/j/k/some_long_module_name.py\0
2234 * ^ ^ ^ ^
2235 * |--------------------- buf ---------------------|
2236 * |------------------- len ------------------|
2237 * |------ name -------|
2238 * |----- namelen -----|
Tim Peters0f9431f2001-07-05 03:47:53 +00002239 */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002240 if (save_len + 13 >= MAXPATHLEN)
2241 return 0;
2242 buf[i++] = SEP;
2243 pname = buf + i;
2244 strcpy(pname, "__init__.py");
2245 if (stat(buf, &statbuf) == 0) {
2246 if (case_ok(buf,
2247 save_len + 9, /* len("/__init__") */
2248 8, /* len("__init__") */
2249 pname)) {
2250 buf[save_len] = '\0';
2251 return 1;
2252 }
2253 }
2254 i += strlen(pname);
2255 strcpy(buf+i, Py_OptimizeFlag ? "o" : "c");
2256 if (stat(buf, &statbuf) == 0) {
2257 if (case_ok(buf,
2258 save_len + 9, /* len("/__init__") */
2259 8, /* len("__init__") */
2260 pname)) {
2261 buf[save_len] = '\0';
2262 return 1;
2263 }
2264 }
2265 buf[save_len] = '\0';
2266 return 0;
Guido van Rossum197346f1997-10-31 18:38:52 +00002267}
Guido van Rossum48a680c2001-03-02 06:34:14 +00002268
Guido van Rossum197346f1997-10-31 18:38:52 +00002269#endif /* HAVE_STAT */
2270
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002271
Victor Stinner95872862011-03-07 18:20:56 +01002272static int init_builtin(PyObject *); /* Forward */
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002273
Victor Stinner44c6c152010-08-09 00:59:10 +00002274static PyObject*
Victor Stinner95872862011-03-07 18:20:56 +01002275load_builtin(PyObject *name, int type)
Victor Stinner44c6c152010-08-09 00:59:10 +00002276{
2277 PyObject *m, *modules;
2278 int err;
2279
Victor Stinner44c6c152010-08-09 00:59:10 +00002280 if (type == C_BUILTIN)
2281 err = init_builtin(name);
2282 else
Victor Stinner95872862011-03-07 18:20:56 +01002283 err = PyImport_ImportFrozenModuleObject(name);
Victor Stinner44c6c152010-08-09 00:59:10 +00002284 if (err < 0)
2285 return NULL;
2286 if (err == 0) {
2287 PyErr_Format(PyExc_ImportError,
Victor Stinner95872862011-03-07 18:20:56 +01002288 "Purported %s module %R not found",
2289 type == C_BUILTIN ? "builtin" : "frozen",
Victor Stinner44c6c152010-08-09 00:59:10 +00002290 name);
2291 return NULL;
2292 }
2293
2294 modules = PyImport_GetModuleDict();
Victor Stinner95872862011-03-07 18:20:56 +01002295 m = PyDict_GetItem(modules, name);
Victor Stinner44c6c152010-08-09 00:59:10 +00002296 if (m == NULL) {
2297 PyErr_Format(
2298 PyExc_ImportError,
Victor Stinner95872862011-03-07 18:20:56 +01002299 "%s module %R not properly initialized",
2300 type == C_BUILTIN ? "builtin" : "frozen",
Victor Stinner44c6c152010-08-09 00:59:10 +00002301 name);
2302 return NULL;
2303 }
2304 Py_INCREF(m);
2305 return m;
2306}
2307
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002308/* Load an external module using the default search path and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00002309 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002310
Guido van Rossum79f25d91997-04-29 20:08:16 +00002311static PyObject *
Victor Stinner41c5fec2011-03-13 21:46:30 -04002312load_module(PyObject *name, FILE *fp, PyObject *pathname, int type, PyObject *loader)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002313{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002314 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002315
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002316 /* First check that there's an open file (if we need one) */
2317 switch (type) {
2318 case PY_SOURCE:
2319 case PY_COMPILED:
2320 if (fp == NULL) {
2321 PyErr_Format(PyExc_ValueError,
Victor Stinner41c5fec2011-03-13 21:46:30 -04002322 "file object required for import (type code %d)",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002323 type);
2324 return NULL;
2325 }
2326 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002327
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002328 switch (type) {
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002329
Victor Stinner41c5fec2011-03-13 21:46:30 -04002330 case PY_SOURCE:
2331 m = load_source_module(name, pathname, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002332 break;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002333
Victor Stinner41c5fec2011-03-13 21:46:30 -04002334 case PY_COMPILED:
2335 m = load_compiled_module(name, pathname, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002336 break;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002337
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002338#ifdef HAVE_DYNAMIC_LOADING
Victor Stinner41c5fec2011-03-13 21:46:30 -04002339 case C_EXTENSION:
2340 m = _PyImport_LoadDynamicModule(name, pathname, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002341 break;
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002342#endif
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002343
Victor Stinner41c5fec2011-03-13 21:46:30 -04002344 case PKG_DIRECTORY:
2345 m = load_package(name, pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002346 break;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002347
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002348 case C_BUILTIN:
Victor Stinner41c5fec2011-03-13 21:46:30 -04002349 case PY_FROZEN:
2350 m = load_builtin(name, type);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002351 break;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002352
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002353 case IMP_HOOK: {
2354 if (loader == NULL) {
2355 PyErr_SetString(PyExc_ImportError,
2356 "import hook without loader");
2357 return NULL;
2358 }
Victor Stinner41c5fec2011-03-13 21:46:30 -04002359 m = PyObject_CallMethod(loader, "load_module", "O", name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002360 break;
2361 }
Just van Rossum52e14d62002-12-30 22:08:05 +00002362
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002363 default:
2364 PyErr_Format(PyExc_ImportError,
Victor Stinner41c5fec2011-03-13 21:46:30 -04002365 "Don't know how to import %U (type code %d)",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002366 name, type);
2367 m = NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002368
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002369 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002370
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002371 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002372}
2373
2374
2375/* Initialize a built-in module.
Thomas Wouters89f507f2006-12-13 04:49:30 +00002376 Return 1 for success, 0 if the module is not found, and -1 with
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002377 an exception set if the initialization failed. */
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002378
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002379static int
Victor Stinner95872862011-03-07 18:20:56 +01002380init_builtin(PyObject *name)
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002381{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002382 struct _inittab *p;
Guido van Rossum25ce5661997-08-02 03:10:38 +00002383
Victor Stinner95872862011-03-07 18:20:56 +01002384 if (_PyImport_FindExtensionObject(name, name) != NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002385 return 1;
Guido van Rossum25ce5661997-08-02 03:10:38 +00002386
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002387 for (p = PyImport_Inittab; p->name != NULL; p++) {
2388 PyObject *mod;
Victor Stinner95872862011-03-07 18:20:56 +01002389 if (PyUnicode_CompareWithASCIIString(name, p->name) == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002390 if (p->initfunc == NULL) {
2391 PyErr_Format(PyExc_ImportError,
Victor Stinner95872862011-03-07 18:20:56 +01002392 "Cannot re-init internal module %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002393 name);
2394 return -1;
2395 }
2396 if (Py_VerboseFlag)
Victor Stinner95872862011-03-07 18:20:56 +01002397 PySys_FormatStderr("import %U # builtin\n", name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002398 mod = (*p->initfunc)();
2399 if (mod == 0)
2400 return -1;
Victor Stinner95872862011-03-07 18:20:56 +01002401 if (_PyImport_FixupExtensionObject(mod, name, name) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002402 return -1;
2403 /* FixupExtension has put the module into sys.modules,
2404 so we can release our own reference. */
2405 Py_DECREF(mod);
2406 return 1;
2407 }
2408 }
2409 return 0;
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002410}
Guido van Rossumf56e3db1993-04-01 20:59:32 +00002411
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002412
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002413/* Frozen modules */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002414
Guido van Rossumcfd0a221996-06-17 17:06:34 +00002415static struct _frozen *
Victor Stinner53dc7352011-03-20 01:50:21 +01002416find_frozen(PyObject *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002417{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002418 struct _frozen *p;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002419
Victor Stinner53dc7352011-03-20 01:50:21 +01002420 if (name == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002421 return NULL;
Benjamin Petersond968e272008-11-05 22:48:33 +00002422
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002423 for (p = PyImport_FrozenModules; ; p++) {
2424 if (p->name == NULL)
2425 return NULL;
Victor Stinner53dc7352011-03-20 01:50:21 +01002426 if (PyUnicode_CompareWithASCIIString(name, p->name) == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002427 break;
2428 }
2429 return p;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002430}
2431
Guido van Rossum79f25d91997-04-29 20:08:16 +00002432static PyObject *
Victor Stinner53dc7352011-03-20 01:50:21 +01002433get_frozen_object(PyObject *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002434{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002435 struct _frozen *p = find_frozen(name);
2436 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002437
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002438 if (p == NULL) {
2439 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002440 "No such frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002441 name);
2442 return NULL;
2443 }
2444 if (p->code == NULL) {
2445 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002446 "Excluded frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002447 name);
2448 return NULL;
2449 }
2450 size = p->size;
2451 if (size < 0)
2452 size = -size;
2453 return PyMarshal_ReadObjectFromString((char *)p->code, size);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002454}
2455
Brett Cannon8d110132009-03-15 02:20:16 +00002456static PyObject *
Victor Stinner53dc7352011-03-20 01:50:21 +01002457is_frozen_package(PyObject *name)
Brett Cannon8d110132009-03-15 02:20:16 +00002458{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002459 struct _frozen *p = find_frozen(name);
2460 int size;
Brett Cannon8d110132009-03-15 02:20:16 +00002461
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002462 if (p == NULL) {
2463 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002464 "No such frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002465 name);
2466 return NULL;
2467 }
Brett Cannon8d110132009-03-15 02:20:16 +00002468
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002469 size = p->size;
Brett Cannon8d110132009-03-15 02:20:16 +00002470
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002471 if (size < 0)
2472 Py_RETURN_TRUE;
2473 else
2474 Py_RETURN_FALSE;
Brett Cannon8d110132009-03-15 02:20:16 +00002475}
2476
2477
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002478/* Initialize a frozen module.
Brett Cannon3c2ac442009-03-08 20:49:47 +00002479 Return 1 for success, 0 if the module is not found, and -1 with
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002480 an exception set if the initialization failed.
2481 This function is also used from frozenmain.c */
Guido van Rossum0b344901995-02-07 15:35:27 +00002482
2483int
Victor Stinner53dc7352011-03-20 01:50:21 +01002484PyImport_ImportFrozenModuleObject(PyObject *name)
Guido van Rossumf56e3db1993-04-01 20:59:32 +00002485{
Victor Stinner53dc7352011-03-20 01:50:21 +01002486 struct _frozen *p;
2487 PyObject *co, *m, *path;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002488 int ispackage;
2489 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002490
Victor Stinner53dc7352011-03-20 01:50:21 +01002491 p = find_frozen(name);
2492
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002493 if (p == NULL)
2494 return 0;
2495 if (p->code == NULL) {
2496 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002497 "Excluded frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002498 name);
2499 return -1;
2500 }
2501 size = p->size;
2502 ispackage = (size < 0);
2503 if (ispackage)
2504 size = -size;
2505 if (Py_VerboseFlag)
Victor Stinner53dc7352011-03-20 01:50:21 +01002506 PySys_FormatStderr("import %U # frozen%s\n",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002507 name, ispackage ? " package" : "");
2508 co = PyMarshal_ReadObjectFromString((char *)p->code, size);
2509 if (co == NULL)
2510 return -1;
2511 if (!PyCode_Check(co)) {
2512 PyErr_Format(PyExc_TypeError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002513 "frozen object %R is not a code object",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002514 name);
2515 goto err_return;
2516 }
2517 if (ispackage) {
2518 /* Set __path__ to the package name */
Victor Stinner53dc7352011-03-20 01:50:21 +01002519 PyObject *d, *l;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002520 int err;
Victor Stinner53dc7352011-03-20 01:50:21 +01002521 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002522 if (m == NULL)
2523 goto err_return;
2524 d = PyModule_GetDict(m);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002525 l = PyList_New(1);
2526 if (l == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002527 goto err_return;
2528 }
Victor Stinner53dc7352011-03-20 01:50:21 +01002529 Py_INCREF(name);
2530 PyList_SET_ITEM(l, 0, name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002531 err = PyDict_SetItemString(d, "__path__", l);
2532 Py_DECREF(l);
2533 if (err != 0)
2534 goto err_return;
2535 }
Victor Stinner53dc7352011-03-20 01:50:21 +01002536 path = PyUnicode_FromString("<frozen>");
2537 if (path == NULL)
2538 goto err_return;
2539 m = PyImport_ExecCodeModuleObject(name, co, path, NULL);
2540 Py_DECREF(path);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002541 if (m == NULL)
2542 goto err_return;
2543 Py_DECREF(co);
2544 Py_DECREF(m);
2545 return 1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002546err_return:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002547 Py_DECREF(co);
2548 return -1;
Guido van Rossumf56e3db1993-04-01 20:59:32 +00002549}
Guido van Rossum74e6a111994-08-29 12:54:38 +00002550
Victor Stinner53dc7352011-03-20 01:50:21 +01002551int
2552PyImport_ImportFrozenModule(char *name)
2553{
2554 PyObject *nameobj;
2555 int ret;
2556 nameobj = PyUnicode_InternFromString(name);
2557 if (nameobj == NULL)
2558 return -1;
2559 ret = PyImport_ImportFrozenModuleObject(nameobj);
2560 Py_DECREF(nameobj);
2561 return ret;
2562}
2563
Guido van Rossum74e6a111994-08-29 12:54:38 +00002564
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002565/* Import a module, either built-in, frozen, or external, and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00002566 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum74e6a111994-08-29 12:54:38 +00002567
Guido van Rossum79f25d91997-04-29 20:08:16 +00002568PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00002569PyImport_ImportModule(const char *name)
Guido van Rossum74e6a111994-08-29 12:54:38 +00002570{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002571 PyObject *pname;
2572 PyObject *result;
Marc-André Lemburg3c61c352001-02-09 19:40:15 +00002573
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002574 pname = PyUnicode_FromString(name);
2575 if (pname == NULL)
2576 return NULL;
2577 result = PyImport_Import(pname);
2578 Py_DECREF(pname);
2579 return result;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002580}
2581
Christian Heimes072c0f12008-01-03 23:01:04 +00002582/* Import a module without blocking
2583 *
2584 * At first it tries to fetch the module from sys.modules. If the module was
2585 * never loaded before it loads it with PyImport_ImportModule() unless another
2586 * thread holds the import lock. In the latter case the function raises an
2587 * ImportError instead of blocking.
2588 *
2589 * Returns the module object with incremented ref count.
2590 */
2591PyObject *
2592PyImport_ImportModuleNoBlock(const char *name)
2593{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002594 PyObject *result;
2595 PyObject *modules;
2596 long me;
Christian Heimes072c0f12008-01-03 23:01:04 +00002597
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002598 /* Try to get the module from sys.modules[name] */
2599 modules = PyImport_GetModuleDict();
2600 if (modules == NULL)
2601 return NULL;
Christian Heimes072c0f12008-01-03 23:01:04 +00002602
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002603 result = PyDict_GetItemString(modules, name);
2604 if (result != NULL) {
2605 Py_INCREF(result);
2606 return result;
2607 }
2608 else {
2609 PyErr_Clear();
2610 }
Benjamin Peterson3e4f0552008-09-02 00:31:15 +00002611#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002612 /* check the import lock
2613 * me might be -1 but I ignore the error here, the lock function
2614 * takes care of the problem */
2615 me = PyThread_get_thread_ident();
2616 if (import_lock_thread == -1 || import_lock_thread == me) {
2617 /* no thread or me is holding the lock */
2618 return PyImport_ImportModule(name);
2619 }
2620 else {
2621 PyErr_Format(PyExc_ImportError,
2622 "Failed to import %.200s because the import lock"
2623 "is held by another thread.",
2624 name);
2625 return NULL;
2626 }
Benjamin Peterson3e4f0552008-09-02 00:31:15 +00002627#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002628 return PyImport_ImportModule(name);
Benjamin Peterson3e4f0552008-09-02 00:31:15 +00002629#endif
Christian Heimes072c0f12008-01-03 23:01:04 +00002630}
2631
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002632/* Forward declarations for helper routines */
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002633static PyObject *get_parent(PyObject *globals, char *buf,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002634 Py_ssize_t *p_buflen, int level);
Tim Petersdbd9ba62000-07-09 03:09:57 +00002635static PyObject *load_next(PyObject *mod, PyObject *altmod,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002636 char **p_name, char *buf, Py_ssize_t *p_buflen);
Tim Petersdbd9ba62000-07-09 03:09:57 +00002637static int mark_miss(char *name);
2638static int ensure_fromlist(PyObject *mod, PyObject *fromlist,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002639 char *buf, Py_ssize_t buflen, int recursive);
Tim Petersdbd9ba62000-07-09 03:09:57 +00002640static PyObject * import_submodule(PyObject *mod, char *name, char *fullname);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002641
2642/* The Magnum Opus of dotted-name import :-) */
2643
Guido van Rossum75acc9c1998-03-03 22:26:50 +00002644static PyObject *
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002645import_module_level(char *name, PyObject *globals, PyObject *locals,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002646 PyObject *fromlist, int level)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002647{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002648 char buf[MAXPATHLEN+1];
2649 Py_ssize_t buflen = 0;
2650 PyObject *parent, *head, *next, *tail;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002651
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002652 if (strchr(name, '/') != NULL
Christian Heimes454f37b2008-01-10 00:10:02 +00002653#ifdef MS_WINDOWS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002654 || strchr(name, '\\') != NULL
Christian Heimes454f37b2008-01-10 00:10:02 +00002655#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002656 ) {
2657 PyErr_SetString(PyExc_ImportError,
2658 "Import by filename is not supported.");
2659 return NULL;
2660 }
Christian Heimes454f37b2008-01-10 00:10:02 +00002661
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002662 parent = get_parent(globals, buf, &buflen, level);
2663 if (parent == NULL)
2664 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002665
Benjamin Peterson556d8002010-06-27 22:37:28 +00002666 head = load_next(parent, level < 0 ? Py_None : parent, &name, buf,
2667 &buflen);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002668 if (head == NULL)
2669 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002670
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002671 tail = head;
2672 Py_INCREF(tail);
2673 while (name) {
2674 next = load_next(tail, tail, &name, buf, &buflen);
2675 Py_DECREF(tail);
2676 if (next == NULL) {
2677 Py_DECREF(head);
2678 return NULL;
2679 }
2680 tail = next;
2681 }
2682 if (tail == Py_None) {
2683 /* If tail is Py_None, both get_parent and load_next found
2684 an empty module name: someone called __import__("") or
2685 doctored faulty bytecode */
2686 Py_DECREF(tail);
2687 Py_DECREF(head);
2688 PyErr_SetString(PyExc_ValueError,
2689 "Empty module name");
2690 return NULL;
2691 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002692
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002693 if (fromlist != NULL) {
2694 if (fromlist == Py_None || !PyObject_IsTrue(fromlist))
2695 fromlist = NULL;
2696 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002697
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002698 if (fromlist == NULL) {
2699 Py_DECREF(tail);
2700 return head;
2701 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002702
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002703 Py_DECREF(head);
2704 if (!ensure_fromlist(tail, fromlist, buf, buflen, 0)) {
2705 Py_DECREF(tail);
2706 return NULL;
2707 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002708
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002709 return tail;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002710}
2711
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002712PyObject *
2713PyImport_ImportModuleLevel(char *name, PyObject *globals, PyObject *locals,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002714 PyObject *fromlist, int level)
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002715{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002716 PyObject *result;
2717 _PyImport_AcquireLock();
2718 result = import_module_level(name, globals, locals, fromlist, level);
2719 if (_PyImport_ReleaseLock() < 0) {
2720 Py_XDECREF(result);
2721 PyErr_SetString(PyExc_RuntimeError,
2722 "not holding the import lock");
2723 return NULL;
2724 }
2725 return result;
Guido van Rossum75acc9c1998-03-03 22:26:50 +00002726}
2727
Fred Drake87590902004-05-28 20:21:36 +00002728/* Return the package that an import is being performed in. If globals comes
2729 from the module foo.bar.bat (not itself a package), this returns the
2730 sys.modules entry for foo.bar. If globals is from a package's __init__.py,
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00002731 the package's entry in sys.modules is returned, as a borrowed reference.
Fred Drake87590902004-05-28 20:21:36 +00002732
2733 The *name* of the returned package is returned in buf, with the length of
2734 the name in *p_buflen.
2735
2736 If globals doesn't come from a package or a module in a package, or a
2737 corresponding entry is not found in sys.modules, Py_None is returned.
2738*/
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002739static PyObject *
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002740get_parent(PyObject *globals, char *buf, Py_ssize_t *p_buflen, int level)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002741{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002742 static PyObject *namestr = NULL;
2743 static PyObject *pathstr = NULL;
2744 static PyObject *pkgstr = NULL;
2745 PyObject *pkgname, *modname, *modpath, *modules, *parent;
2746 int orig_level = level;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002747
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002748 if (globals == NULL || !PyDict_Check(globals) || !level)
2749 return Py_None;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002750
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002751 if (namestr == NULL) {
2752 namestr = PyUnicode_InternFromString("__name__");
2753 if (namestr == NULL)
2754 return NULL;
2755 }
2756 if (pathstr == NULL) {
2757 pathstr = PyUnicode_InternFromString("__path__");
2758 if (pathstr == NULL)
2759 return NULL;
2760 }
2761 if (pkgstr == NULL) {
2762 pkgstr = PyUnicode_InternFromString("__package__");
2763 if (pkgstr == NULL)
2764 return NULL;
2765 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002766
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002767 *buf = '\0';
2768 *p_buflen = 0;
2769 pkgname = PyDict_GetItem(globals, pkgstr);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002770
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002771 if ((pkgname != NULL) && (pkgname != Py_None)) {
2772 /* __package__ is set, so use it */
2773 char *pkgname_str;
2774 Py_ssize_t len;
Alexandre Vassalottia85998a2008-05-03 18:24:43 +00002775
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002776 if (!PyUnicode_Check(pkgname)) {
2777 PyErr_SetString(PyExc_ValueError,
2778 "__package__ set to non-string");
2779 return NULL;
2780 }
2781 pkgname_str = _PyUnicode_AsStringAndSize(pkgname, &len);
2782 if (len == 0) {
2783 if (level > 0) {
2784 PyErr_SetString(PyExc_ValueError,
2785 "Attempted relative import in non-package");
2786 return NULL;
2787 }
2788 return Py_None;
2789 }
2790 if (len > MAXPATHLEN) {
2791 PyErr_SetString(PyExc_ValueError,
2792 "Package name too long");
2793 return NULL;
2794 }
2795 strcpy(buf, pkgname_str);
2796 } else {
2797 /* __package__ not set, so figure it out and set it */
2798 modname = PyDict_GetItem(globals, namestr);
2799 if (modname == NULL || !PyUnicode_Check(modname))
2800 return Py_None;
Brett Cannon9a5b25a2010-03-01 02:09:17 +00002801
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002802 modpath = PyDict_GetItem(globals, pathstr);
2803 if (modpath != NULL) {
2804 /* __path__ is set, so modname is already the package name */
2805 char *modname_str;
2806 Py_ssize_t len;
2807 int error;
Alexandre Vassalottia85998a2008-05-03 18:24:43 +00002808
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002809 modname_str = _PyUnicode_AsStringAndSize(modname, &len);
2810 if (len > MAXPATHLEN) {
2811 PyErr_SetString(PyExc_ValueError,
2812 "Module name too long");
2813 return NULL;
2814 }
2815 strcpy(buf, modname_str);
2816 error = PyDict_SetItem(globals, pkgstr, modname);
2817 if (error) {
2818 PyErr_SetString(PyExc_ValueError,
2819 "Could not set __package__");
2820 return NULL;
2821 }
2822 } else {
2823 /* Normal module, so work out the package name if any */
2824 char *start = _PyUnicode_AsString(modname);
2825 char *lastdot = strrchr(start, '.');
2826 size_t len;
2827 int error;
2828 if (lastdot == NULL && level > 0) {
2829 PyErr_SetString(PyExc_ValueError,
2830 "Attempted relative import in non-package");
2831 return NULL;
2832 }
2833 if (lastdot == NULL) {
2834 error = PyDict_SetItem(globals, pkgstr, Py_None);
2835 if (error) {
2836 PyErr_SetString(PyExc_ValueError,
2837 "Could not set __package__");
2838 return NULL;
2839 }
2840 return Py_None;
2841 }
2842 len = lastdot - start;
2843 if (len >= MAXPATHLEN) {
2844 PyErr_SetString(PyExc_ValueError,
2845 "Module name too long");
2846 return NULL;
2847 }
2848 strncpy(buf, start, len);
2849 buf[len] = '\0';
2850 pkgname = PyUnicode_FromString(buf);
2851 if (pkgname == NULL) {
2852 return NULL;
2853 }
2854 error = PyDict_SetItem(globals, pkgstr, pkgname);
2855 Py_DECREF(pkgname);
2856 if (error) {
2857 PyErr_SetString(PyExc_ValueError,
2858 "Could not set __package__");
2859 return NULL;
2860 }
2861 }
2862 }
2863 while (--level > 0) {
2864 char *dot = strrchr(buf, '.');
2865 if (dot == NULL) {
2866 PyErr_SetString(PyExc_ValueError,
2867 "Attempted relative import beyond "
2868 "toplevel package");
2869 return NULL;
2870 }
2871 *dot = '\0';
2872 }
2873 *p_buflen = strlen(buf);
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002874
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002875 modules = PyImport_GetModuleDict();
2876 parent = PyDict_GetItemString(modules, buf);
2877 if (parent == NULL) {
2878 if (orig_level < 1) {
2879 PyObject *err_msg = PyBytes_FromFormat(
2880 "Parent module '%.200s' not found "
2881 "while handling absolute import", buf);
2882 if (err_msg == NULL) {
2883 return NULL;
2884 }
2885 if (!PyErr_WarnEx(PyExc_RuntimeWarning,
2886 PyBytes_AsString(err_msg), 1)) {
2887 *buf = '\0';
2888 *p_buflen = 0;
2889 parent = Py_None;
2890 }
2891 Py_DECREF(err_msg);
2892 } else {
2893 PyErr_Format(PyExc_SystemError,
2894 "Parent module '%.200s' not loaded, "
2895 "cannot perform relative import", buf);
2896 }
2897 }
2898 return parent;
2899 /* We expect, but can't guarantee, if parent != None, that:
2900 - parent.__name__ == buf
2901 - parent.__dict__ is globals
2902 If this is violated... Who cares? */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002903}
2904
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002905/* altmod is either None or same as mod */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002906static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002907load_next(PyObject *mod, PyObject *altmod, char **p_name, char *buf,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002908 Py_ssize_t *p_buflen)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002909{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002910 char *name = *p_name;
2911 char *dot = strchr(name, '.');
2912 size_t len;
2913 char *p;
2914 PyObject *result;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002915
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002916 if (strlen(name) == 0) {
2917 /* completely empty module name should only happen in
2918 'from . import' (or '__import__("")')*/
2919 Py_INCREF(mod);
2920 *p_name = NULL;
2921 return mod;
2922 }
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002923
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002924 if (dot == NULL) {
2925 *p_name = NULL;
2926 len = strlen(name);
2927 }
2928 else {
2929 *p_name = dot+1;
2930 len = dot-name;
2931 }
2932 if (len == 0) {
2933 PyErr_SetString(PyExc_ValueError,
2934 "Empty module name");
2935 return NULL;
2936 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002937
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002938 p = buf + *p_buflen;
2939 if (p != buf)
2940 *p++ = '.';
2941 if (p+len-buf >= MAXPATHLEN) {
2942 PyErr_SetString(PyExc_ValueError,
2943 "Module name too long");
2944 return NULL;
2945 }
2946 strncpy(p, name, len);
2947 p[len] = '\0';
2948 *p_buflen = p+len-buf;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002949
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002950 result = import_submodule(mod, p, buf);
2951 if (result == Py_None && altmod != mod) {
2952 Py_DECREF(result);
2953 /* Here, altmod must be None and mod must not be None */
2954 result = import_submodule(altmod, p, p);
2955 if (result != NULL && result != Py_None) {
2956 if (mark_miss(buf) != 0) {
2957 Py_DECREF(result);
2958 return NULL;
2959 }
2960 strncpy(buf, name, len);
2961 buf[len] = '\0';
2962 *p_buflen = len;
2963 }
2964 }
2965 if (result == NULL)
2966 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002967
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002968 if (result == Py_None) {
2969 Py_DECREF(result);
2970 PyErr_Format(PyExc_ImportError,
2971 "No module named %.200s", name);
2972 return NULL;
2973 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002974
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002975 return result;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002976}
2977
2978static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002979mark_miss(char *name)
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00002980{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002981 PyObject *modules = PyImport_GetModuleDict();
2982 return PyDict_SetItemString(modules, name, Py_None);
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00002983}
2984
2985static int
Martin v. Löwis18e16552006-02-15 17:27:45 +00002986ensure_fromlist(PyObject *mod, PyObject *fromlist, char *buf, Py_ssize_t buflen,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002987 int recursive)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002988{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002989 int i;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002990
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002991 if (!PyObject_HasAttrString(mod, "__path__"))
2992 return 1;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002993
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002994 for (i = 0; ; i++) {
2995 PyObject *item = PySequence_GetItem(fromlist, i);
2996 int hasit;
2997 if (item == NULL) {
2998 if (PyErr_ExceptionMatches(PyExc_IndexError)) {
2999 PyErr_Clear();
3000 return 1;
3001 }
3002 return 0;
3003 }
3004 if (!PyUnicode_Check(item)) {
3005 PyErr_SetString(PyExc_TypeError,
3006 "Item in ``from list'' not a string");
3007 Py_DECREF(item);
3008 return 0;
3009 }
3010 if (PyUnicode_AS_UNICODE(item)[0] == '*') {
3011 PyObject *all;
3012 Py_DECREF(item);
3013 /* See if the package defines __all__ */
3014 if (recursive)
3015 continue; /* Avoid endless recursion */
3016 all = PyObject_GetAttrString(mod, "__all__");
3017 if (all == NULL)
3018 PyErr_Clear();
3019 else {
3020 int ret = ensure_fromlist(mod, all, buf, buflen, 1);
3021 Py_DECREF(all);
3022 if (!ret)
3023 return 0;
3024 }
3025 continue;
3026 }
3027 hasit = PyObject_HasAttr(mod, item);
3028 if (!hasit) {
3029 PyObject *item8;
3030 char *subname;
3031 PyObject *submod;
3032 char *p;
Victor Stinnerae6265f2010-05-15 16:27:27 +00003033 item8 = PyUnicode_EncodeFSDefault(item);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003034 if (!item8) {
3035 PyErr_SetString(PyExc_ValueError, "Cannot encode path item");
3036 return 0;
3037 }
3038 subname = PyBytes_AS_STRING(item8);
3039 if (buflen + strlen(subname) >= MAXPATHLEN) {
3040 PyErr_SetString(PyExc_ValueError,
3041 "Module name too long");
3042 Py_DECREF(item);
3043 return 0;
3044 }
3045 p = buf + buflen;
3046 *p++ = '.';
3047 strcpy(p, subname);
3048 submod = import_submodule(mod, subname, buf);
3049 Py_DECREF(item8);
3050 Py_XDECREF(submod);
3051 if (submod == NULL) {
3052 Py_DECREF(item);
3053 return 0;
3054 }
3055 }
3056 Py_DECREF(item);
3057 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003058
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003059 /* NOTREACHED */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003060}
3061
Neil Schemenauer00b09662003-06-16 21:03:07 +00003062static int
3063add_submodule(PyObject *mod, PyObject *submod, char *fullname, char *subname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003064 PyObject *modules)
Neil Schemenauer00b09662003-06-16 21:03:07 +00003065{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003066 if (mod == Py_None)
3067 return 1;
3068 /* Irrespective of the success of this load, make a
3069 reference to it in the parent package module. A copy gets
3070 saved in the modules dictionary under the full name, so get a
3071 reference from there, if need be. (The exception is when the
3072 load failed with a SyntaxError -- then there's no trace in
3073 sys.modules. In that case, of course, do nothing extra.) */
3074 if (submod == NULL) {
3075 submod = PyDict_GetItemString(modules, fullname);
3076 if (submod == NULL)
3077 return 1;
3078 }
3079 if (PyModule_Check(mod)) {
3080 /* We can't use setattr here since it can give a
3081 * spurious warning if the submodule name shadows a
3082 * builtin name */
3083 PyObject *dict = PyModule_GetDict(mod);
3084 if (!dict)
3085 return 0;
3086 if (PyDict_SetItemString(dict, subname, submod) < 0)
3087 return 0;
3088 }
3089 else {
3090 if (PyObject_SetAttrString(mod, subname, submod) < 0)
3091 return 0;
3092 }
3093 return 1;
Neil Schemenauer00b09662003-06-16 21:03:07 +00003094}
3095
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003096static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003097import_submodule(PyObject *mod, char *subname, char *fullname)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003098{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003099 PyObject *modules = PyImport_GetModuleDict();
Victor Stinner41c5fec2011-03-13 21:46:30 -04003100 PyObject *m = NULL, *fullnameobj, *bufobj;
Guido van Rossum74e6a111994-08-29 12:54:38 +00003101
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003102 /* Require:
3103 if mod == None: subname == fullname
3104 else: mod.__name__ + "." + subname == fullname
3105 */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003106
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003107 if ((m = PyDict_GetItemString(modules, fullname)) != NULL) {
3108 Py_INCREF(m);
3109 }
3110 else {
Victor Stinner7d8b77c2011-03-12 08:45:02 -05003111 PyObject *path, *loader;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003112 char buf[MAXPATHLEN+1];
3113 struct filedescr *fdp;
Victor Stinner7d8b77c2011-03-12 08:45:02 -05003114 FILE *fp;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003115
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003116 if (mod == Py_None)
3117 path = NULL;
3118 else {
3119 path = PyObject_GetAttrString(mod, "__path__");
3120 if (path == NULL) {
3121 PyErr_Clear();
3122 Py_INCREF(Py_None);
3123 return Py_None;
3124 }
3125 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003126
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003127 fdp = find_module(fullname, subname, path, buf, MAXPATHLEN+1,
3128 &fp, &loader);
3129 Py_XDECREF(path);
3130 if (fdp == NULL) {
3131 if (!PyErr_ExceptionMatches(PyExc_ImportError))
3132 return NULL;
3133 PyErr_Clear();
3134 Py_INCREF(Py_None);
3135 return Py_None;
3136 }
Victor Stinner41c5fec2011-03-13 21:46:30 -04003137 fullnameobj = PyUnicode_FromString(fullname);
3138 if (fullnameobj != NULL) {
3139 bufobj = PyUnicode_DecodeFSDefault(buf);
3140 if (bufobj != NULL) {
3141 m = load_module(fullnameobj, fp, bufobj, fdp->type, loader);
3142 Py_DECREF(bufobj);
3143 }
3144 else
3145 m = NULL;
3146 Py_DECREF(fullnameobj);
3147 }
3148 else
3149 m = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003150 Py_XDECREF(loader);
3151 if (fp)
3152 fclose(fp);
3153 if (!add_submodule(mod, m, fullname, subname, modules)) {
3154 Py_XDECREF(m);
3155 m = NULL;
3156 }
3157 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003158
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003159 return m;
Guido van Rossum74e6a111994-08-29 12:54:38 +00003160}
3161
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003162
3163/* Re-import a module of any kind and return its module object, WITH
3164 INCREMENTED REFERENCE COUNT */
3165
Guido van Rossum79f25d91997-04-29 20:08:16 +00003166PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003167PyImport_ReloadModule(PyObject *m)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003168{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003169 PyInterpreterState *interp = PyThreadState_Get()->interp;
3170 PyObject *modules_reloading = interp->modules_reloading;
3171 PyObject *modules = PyImport_GetModuleDict();
Victor Stinner7d8b77c2011-03-12 08:45:02 -05003172 PyObject *path = NULL, *loader, *existing_m = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003173 char *name, *subname;
3174 char buf[MAXPATHLEN+1];
3175 struct filedescr *fdp;
Victor Stinner7d8b77c2011-03-12 08:45:02 -05003176 FILE *fp;
Victor Stinner41c5fec2011-03-13 21:46:30 -04003177 PyObject *newm, *nameobj, *bufobj;
Brett Cannon9a5b25a2010-03-01 02:09:17 +00003178
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003179 if (modules_reloading == NULL) {
3180 Py_FatalError("PyImport_ReloadModule: "
3181 "no modules_reloading dictionary!");
3182 return NULL;
3183 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003184
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003185 if (m == NULL || !PyModule_Check(m)) {
3186 PyErr_SetString(PyExc_TypeError,
3187 "reload() argument must be module");
3188 return NULL;
3189 }
3190 name = (char*)PyModule_GetName(m);
3191 if (name == NULL)
3192 return NULL;
3193 if (m != PyDict_GetItemString(modules, name)) {
3194 PyErr_Format(PyExc_ImportError,
3195 "reload(): module %.200s not in sys.modules",
3196 name);
3197 return NULL;
3198 }
3199 existing_m = PyDict_GetItemString(modules_reloading, name);
3200 if (existing_m != NULL) {
3201 /* Due to a recursive reload, this module is already
3202 being reloaded. */
3203 Py_INCREF(existing_m);
3204 return existing_m;
3205 }
3206 if (PyDict_SetItemString(modules_reloading, name, m) < 0)
3207 return NULL;
Guido van Rossumd8faa362007-04-27 19:54:29 +00003208
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003209 subname = strrchr(name, '.');
3210 if (subname == NULL)
3211 subname = name;
3212 else {
3213 PyObject *parentname, *parent;
3214 parentname = PyUnicode_FromStringAndSize(name, (subname-name));
3215 if (parentname == NULL) {
3216 imp_modules_reloading_clear();
3217 return NULL;
3218 }
3219 parent = PyDict_GetItem(modules, parentname);
3220 if (parent == NULL) {
3221 PyErr_Format(PyExc_ImportError,
3222 "reload(): parent %U not in sys.modules",
3223 parentname);
3224 Py_DECREF(parentname);
3225 imp_modules_reloading_clear();
3226 return NULL;
3227 }
3228 Py_DECREF(parentname);
3229 subname++;
3230 path = PyObject_GetAttrString(parent, "__path__");
3231 if (path == NULL)
3232 PyErr_Clear();
3233 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003234 fdp = find_module(name, subname, path, buf, MAXPATHLEN+1, &fp, &loader);
3235 Py_XDECREF(path);
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00003236
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003237 if (fdp == NULL) {
3238 Py_XDECREF(loader);
3239 imp_modules_reloading_clear();
3240 return NULL;
3241 }
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00003242
Victor Stinner41c5fec2011-03-13 21:46:30 -04003243 nameobj = PyUnicode_FromString(name);
3244 if (nameobj != NULL) {
3245 bufobj = PyUnicode_DecodeFSDefault(buf);
3246 if (bufobj != NULL) {
3247 newm = load_module(nameobj, fp, bufobj, fdp->type, loader);
3248 Py_DECREF(bufobj);
3249 }
3250 else
3251 newm = NULL;
3252 Py_DECREF(nameobj);
3253 }
3254 else
3255 newm = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003256 Py_XDECREF(loader);
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00003257
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003258 if (fp)
3259 fclose(fp);
3260 if (newm == NULL) {
3261 /* load_module probably removed name from modules because of
3262 * the error. Put back the original module object. We're
3263 * going to return NULL in this case regardless of whether
3264 * replacing name succeeds, so the return value is ignored.
3265 */
3266 PyDict_SetItemString(modules, name, m);
3267 }
3268 imp_modules_reloading_clear();
3269 return newm;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003270}
3271
3272
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003273/* Higher-level import emulator which emulates the "import" statement
3274 more accurately -- it invokes the __import__() function from the
3275 builtins of the current globals. This means that the import is
3276 done using whatever import hooks are installed in the current
Brett Cannonbc2eff32010-09-19 21:39:02 +00003277 environment.
Guido van Rossum6058eb41998-12-21 19:51:00 +00003278 A dummy list ["__doc__"] is passed as the 4th argument so that
Neal Norwitz80e7f272007-08-26 06:45:23 +00003279 e.g. PyImport_Import(PyUnicode_FromString("win32com.client.gencache"))
Guido van Rossum6058eb41998-12-21 19:51:00 +00003280 will return <module "gencache"> instead of <module "win32com">. */
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003281
3282PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003283PyImport_Import(PyObject *module_name)
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003284{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003285 static PyObject *silly_list = NULL;
3286 static PyObject *builtins_str = NULL;
3287 static PyObject *import_str = NULL;
3288 PyObject *globals = NULL;
3289 PyObject *import = NULL;
3290 PyObject *builtins = NULL;
Brett Cannonbc2eff32010-09-19 21:39:02 +00003291 PyObject *modules = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003292 PyObject *r = NULL;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003293
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003294 /* Initialize constant string objects */
3295 if (silly_list == NULL) {
3296 import_str = PyUnicode_InternFromString("__import__");
3297 if (import_str == NULL)
3298 return NULL;
3299 builtins_str = PyUnicode_InternFromString("__builtins__");
3300 if (builtins_str == NULL)
3301 return NULL;
Brett Cannonbc2eff32010-09-19 21:39:02 +00003302 silly_list = PyList_New(0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003303 if (silly_list == NULL)
3304 return NULL;
3305 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003306
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003307 /* Get the builtins from current globals */
3308 globals = PyEval_GetGlobals();
3309 if (globals != NULL) {
3310 Py_INCREF(globals);
3311 builtins = PyObject_GetItem(globals, builtins_str);
3312 if (builtins == NULL)
3313 goto err;
3314 }
3315 else {
3316 /* No globals -- use standard builtins, and fake globals */
3317 builtins = PyImport_ImportModuleLevel("builtins",
3318 NULL, NULL, NULL, 0);
3319 if (builtins == NULL)
3320 return NULL;
3321 globals = Py_BuildValue("{OO}", builtins_str, builtins);
3322 if (globals == NULL)
3323 goto err;
3324 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003325
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003326 /* Get the __import__ function from the builtins */
3327 if (PyDict_Check(builtins)) {
3328 import = PyObject_GetItem(builtins, import_str);
3329 if (import == NULL)
3330 PyErr_SetObject(PyExc_KeyError, import_str);
3331 }
3332 else
3333 import = PyObject_GetAttr(builtins, import_str);
3334 if (import == NULL)
3335 goto err;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003336
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003337 /* Call the __import__ function with the proper argument list
Brett Cannonbc2eff32010-09-19 21:39:02 +00003338 Always use absolute import here.
3339 Calling for side-effect of import. */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003340 r = PyObject_CallFunction(import, "OOOOi", module_name, globals,
3341 globals, silly_list, 0, NULL);
Brett Cannonbc2eff32010-09-19 21:39:02 +00003342 if (r == NULL)
3343 goto err;
3344 Py_DECREF(r);
3345
3346 modules = PyImport_GetModuleDict();
3347 r = PyDict_GetItem(modules, module_name);
3348 if (r != NULL)
3349 Py_INCREF(r);
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003350
3351 err:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003352 Py_XDECREF(globals);
3353 Py_XDECREF(builtins);
3354 Py_XDECREF(import);
Tim Peters50d8d372001-02-28 05:34:27 +00003355
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003356 return r;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003357}
3358
3359
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003360/* Module 'imp' provides Python access to the primitives used for
3361 importing modules.
3362*/
3363
Guido van Rossum79f25d91997-04-29 20:08:16 +00003364static PyObject *
Barry Warsaw28a691b2010-04-17 00:19:56 +00003365imp_make_magic(long magic)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003366{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003367 char buf[4];
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003368
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003369 buf[0] = (char) ((magic >> 0) & 0xff);
3370 buf[1] = (char) ((magic >> 8) & 0xff);
3371 buf[2] = (char) ((magic >> 16) & 0xff);
3372 buf[3] = (char) ((magic >> 24) & 0xff);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003373
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003374 return PyBytes_FromStringAndSize(buf, 4);
Victor Stinner3e2b7172010-11-09 09:32:19 +00003375}
Barry Warsaw28a691b2010-04-17 00:19:56 +00003376
3377static PyObject *
3378imp_get_magic(PyObject *self, PyObject *noargs)
3379{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003380 return imp_make_magic(pyc_magic);
Barry Warsaw28a691b2010-04-17 00:19:56 +00003381}
3382
3383static PyObject *
3384imp_get_tag(PyObject *self, PyObject *noargs)
3385{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003386 return PyUnicode_FromString(pyc_tag);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003387}
3388
Guido van Rossum79f25d91997-04-29 20:08:16 +00003389static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +00003390imp_get_suffixes(PyObject *self, PyObject *noargs)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003391{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003392 PyObject *list;
3393 struct filedescr *fdp;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003394
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003395 list = PyList_New(0);
3396 if (list == NULL)
3397 return NULL;
3398 for (fdp = _PyImport_Filetab; fdp->suffix != NULL; fdp++) {
3399 PyObject *item = Py_BuildValue("ssi",
3400 fdp->suffix, fdp->mode, fdp->type);
3401 if (item == NULL) {
3402 Py_DECREF(list);
3403 return NULL;
3404 }
3405 if (PyList_Append(list, item) < 0) {
3406 Py_DECREF(list);
3407 Py_DECREF(item);
3408 return NULL;
3409 }
3410 Py_DECREF(item);
3411 }
3412 return list;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003413}
3414
Guido van Rossum79f25d91997-04-29 20:08:16 +00003415static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003416call_find_module(char *name, PyObject *path)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003417{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003418 extern int fclose(FILE *);
3419 PyObject *fob, *ret;
3420 PyObject *pathobj;
3421 struct filedescr *fdp;
3422 char pathname[MAXPATHLEN+1];
Victor Stinner7d8b77c2011-03-12 08:45:02 -05003423 FILE *fp;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003424 int fd = -1;
3425 char *found_encoding = NULL;
3426 char *encoding = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003427
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003428 pathname[0] = '\0';
3429 if (path == Py_None)
3430 path = NULL;
3431 fdp = find_module(NULL, name, path, pathname, MAXPATHLEN+1, &fp, NULL);
3432 if (fdp == NULL)
3433 return NULL;
3434 if (fp != NULL) {
3435 fd = fileno(fp);
3436 if (fd != -1)
3437 fd = dup(fd);
3438 fclose(fp);
3439 fp = NULL;
3440 }
3441 if (fd != -1) {
3442 if (strchr(fdp->mode, 'b') == NULL) {
3443 /* PyTokenizer_FindEncoding() returns PyMem_MALLOC'ed
3444 memory. */
3445 found_encoding = PyTokenizer_FindEncoding(fd);
3446 lseek(fd, 0, 0); /* Reset position */
3447 if (found_encoding == NULL && PyErr_Occurred())
3448 return NULL;
3449 encoding = (found_encoding != NULL) ? found_encoding :
3450 (char*)PyUnicode_GetDefaultEncoding();
3451 }
3452 fob = PyFile_FromFd(fd, pathname, fdp->mode, -1,
3453 (char*)encoding, NULL, NULL, 1);
3454 if (fob == NULL) {
3455 close(fd);
3456 PyMem_FREE(found_encoding);
3457 return NULL;
3458 }
3459 }
3460 else {
3461 fob = Py_None;
3462 Py_INCREF(fob);
3463 }
3464 pathobj = PyUnicode_DecodeFSDefault(pathname);
3465 ret = Py_BuildValue("NN(ssi)",
3466 fob, pathobj, fdp->suffix, fdp->mode, fdp->type);
3467 PyMem_FREE(found_encoding);
Brett Cannon3bb42d92007-10-20 03:43:15 +00003468
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003469 return ret;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003470}
3471
Guido van Rossum79f25d91997-04-29 20:08:16 +00003472static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003473imp_find_module(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003474{
Victor Stinnerebc00522010-12-03 17:06:43 +00003475 PyObject *name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003476 PyObject *ret, *path = NULL;
Victor Stinnerebc00522010-12-03 17:06:43 +00003477 if (!PyArg_ParseTuple(args, "O&|O:find_module",
3478 PyUnicode_FSConverter, &name,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003479 &path))
3480 return NULL;
Victor Stinnerebc00522010-12-03 17:06:43 +00003481 ret = call_find_module(PyBytes_AS_STRING(name), path);
3482 Py_DECREF(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003483 return ret;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003484}
3485
3486static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003487imp_init_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003488{
Victor Stinner95872862011-03-07 18:20:56 +01003489 PyObject *name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003490 int ret;
3491 PyObject *m;
Victor Stinner95872862011-03-07 18:20:56 +01003492 if (!PyArg_ParseTuple(args, "U:init_builtin", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003493 return NULL;
3494 ret = init_builtin(name);
3495 if (ret < 0)
3496 return NULL;
3497 if (ret == 0) {
3498 Py_INCREF(Py_None);
3499 return Py_None;
3500 }
Victor Stinner95872862011-03-07 18:20:56 +01003501 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003502 Py_XINCREF(m);
3503 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003504}
3505
Guido van Rossum79f25d91997-04-29 20:08:16 +00003506static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003507imp_init_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003508{
Victor Stinner53dc7352011-03-20 01:50:21 +01003509 PyObject *name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003510 int ret;
3511 PyObject *m;
Victor Stinner53dc7352011-03-20 01:50:21 +01003512 if (!PyArg_ParseTuple(args, "U:init_frozen", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003513 return NULL;
Victor Stinner53dc7352011-03-20 01:50:21 +01003514 ret = PyImport_ImportFrozenModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003515 if (ret < 0)
3516 return NULL;
3517 if (ret == 0) {
3518 Py_INCREF(Py_None);
3519 return Py_None;
3520 }
Victor Stinner53dc7352011-03-20 01:50:21 +01003521 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003522 Py_XINCREF(m);
3523 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003524}
3525
Guido van Rossum79f25d91997-04-29 20:08:16 +00003526static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003527imp_get_frozen_object(PyObject *self, PyObject *args)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00003528{
Victor Stinner53dc7352011-03-20 01:50:21 +01003529 PyObject *name;
Jack Jansen95ffa231995-10-03 14:38:41 +00003530
Victor Stinner53dc7352011-03-20 01:50:21 +01003531 if (!PyArg_ParseTuple(args, "U:get_frozen_object", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003532 return NULL;
3533 return get_frozen_object(name);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00003534}
3535
Guido van Rossum79f25d91997-04-29 20:08:16 +00003536static PyObject *
Brett Cannon8d110132009-03-15 02:20:16 +00003537imp_is_frozen_package(PyObject *self, PyObject *args)
3538{
Victor Stinner53dc7352011-03-20 01:50:21 +01003539 PyObject *name;
Brett Cannon8d110132009-03-15 02:20:16 +00003540
Victor Stinner53dc7352011-03-20 01:50:21 +01003541 if (!PyArg_ParseTuple(args, "U:is_frozen_package", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003542 return NULL;
3543 return is_frozen_package(name);
Brett Cannon8d110132009-03-15 02:20:16 +00003544}
3545
3546static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003547imp_is_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003548{
Victor Stinner95872862011-03-07 18:20:56 +01003549 PyObject *name;
3550 if (!PyArg_ParseTuple(args, "U:is_builtin", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003551 return NULL;
3552 return PyLong_FromLong(is_builtin(name));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003553}
3554
Guido van Rossum79f25d91997-04-29 20:08:16 +00003555static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003556imp_is_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003557{
Victor Stinner53dc7352011-03-20 01:50:21 +01003558 PyObject *name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003559 struct _frozen *p;
Victor Stinner53dc7352011-03-20 01:50:21 +01003560 if (!PyArg_ParseTuple(args, "U:is_frozen", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003561 return NULL;
3562 p = find_frozen(name);
3563 return PyBool_FromLong((long) (p == NULL ? 0 : p->size));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003564}
3565
3566static FILE *
Victor Stinner2f42ae52011-03-20 00:41:24 +01003567get_file(PyObject *pathname, PyObject *fob, char *mode)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003568{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003569 FILE *fp;
3570 if (mode[0] == 'U')
3571 mode = "r" PY_STDIOTEXTMODE;
3572 if (fob == NULL) {
Victor Stinner2f42ae52011-03-20 00:41:24 +01003573 fp = _Py_fopen(pathname, mode);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003574 }
3575 else {
3576 int fd = PyObject_AsFileDescriptor(fob);
3577 if (fd == -1)
3578 return NULL;
3579 if (!_PyVerify_fd(fd))
3580 goto error;
3581 /* the FILE struct gets a new fd, so that it can be closed
3582 * independently of the file descriptor given
3583 */
3584 fd = dup(fd);
3585 if (fd == -1)
3586 goto error;
3587 fp = fdopen(fd, mode);
3588 }
3589 if (fp)
3590 return fp;
Kristján Valur Jónssone1b04452009-03-31 17:43:39 +00003591error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003592 PyErr_SetFromErrno(PyExc_IOError);
3593 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003594}
3595
Guido van Rossum79f25d91997-04-29 20:08:16 +00003596static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003597imp_load_compiled(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003598{
Victor Stinner2f42ae52011-03-20 00:41:24 +01003599 PyObject *name, *pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003600 PyObject *fob = NULL;
3601 PyObject *m;
3602 FILE *fp;
Victor Stinner2f42ae52011-03-20 00:41:24 +01003603 if (!PyArg_ParseTuple(args, "UO&|O:load_compiled",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003604 &name,
Victor Stinner2f42ae52011-03-20 00:41:24 +01003605 PyUnicode_FSDecoder, &pathname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003606 &fob))
3607 return NULL;
Victor Stinner2f42ae52011-03-20 00:41:24 +01003608 fp = get_file(pathname, fob, "rb");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003609 if (fp == NULL) {
Victor Stinnerebc00522010-12-03 17:06:43 +00003610 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003611 return NULL;
3612 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01003613 m = load_compiled_module(name, pathname, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003614 fclose(fp);
Victor Stinnerebc00522010-12-03 17:06:43 +00003615 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003616 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003617}
3618
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003619#ifdef HAVE_DYNAMIC_LOADING
3620
Guido van Rossum79f25d91997-04-29 20:08:16 +00003621static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003622imp_load_dynamic(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003623{
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003624 PyObject *name, *pathname, *fob = NULL, *mod;
3625 FILE *fp;
3626
3627 if (!PyArg_ParseTuple(args, "UO&|O:load_dynamic",
3628 &name, PyUnicode_FSDecoder, &pathname, &fob))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003629 return NULL;
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003630 if (fob != NULL) {
3631 fp = get_file(NULL, fob, "r");
3632 if (fp == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003633 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003634 }
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003635 else
3636 fp = NULL;
3637 mod = _PyImport_LoadDynamicModule(name, pathname, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003638 if (fp)
3639 fclose(fp);
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003640 return mod;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003641}
3642
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003643#endif /* HAVE_DYNAMIC_LOADING */
3644
Guido van Rossum79f25d91997-04-29 20:08:16 +00003645static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003646imp_load_source(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003647{
Victor Stinner2f42ae52011-03-20 00:41:24 +01003648 PyObject *name, *pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003649 PyObject *fob = NULL;
3650 PyObject *m;
3651 FILE *fp;
Victor Stinner2f42ae52011-03-20 00:41:24 +01003652 if (!PyArg_ParseTuple(args, "UO&|O:load_source",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003653 &name,
Victor Stinner2f42ae52011-03-20 00:41:24 +01003654 PyUnicode_FSDecoder, &pathname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003655 &fob))
3656 return NULL;
Victor Stinner2f42ae52011-03-20 00:41:24 +01003657 fp = get_file(pathname, fob, "r");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003658 if (fp == NULL) {
Victor Stinnerebc00522010-12-03 17:06:43 +00003659 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003660 return NULL;
3661 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01003662 m = load_source_module(name, pathname, fp);
Victor Stinnerebc00522010-12-03 17:06:43 +00003663 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003664 fclose(fp);
3665 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003666}
3667
Guido van Rossum79f25d91997-04-29 20:08:16 +00003668static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003669imp_load_module(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003670{
Victor Stinner41c5fec2011-03-13 21:46:30 -04003671 PyObject *name, *fob, *pathname, *ret;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003672 char *suffix; /* Unused */
3673 char *mode;
3674 int type;
3675 FILE *fp;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003676
Victor Stinner41c5fec2011-03-13 21:46:30 -04003677 if (!PyArg_ParseTuple(args, "UOO&(ssi):load_module",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003678 &name, &fob,
Victor Stinner41c5fec2011-03-13 21:46:30 -04003679 PyUnicode_FSDecoder, &pathname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003680 &suffix, &mode, &type))
3681 return NULL;
3682 if (*mode) {
3683 /* Mode must start with 'r' or 'U' and must not contain '+'.
3684 Implicit in this test is the assumption that the mode
3685 may contain other modifiers like 'b' or 't'. */
Guido van Rossum5e2c5fa2002-05-30 17:33:07 +00003686
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003687 if (!(*mode == 'r' || *mode == 'U') || strchr(mode, '+')) {
3688 PyErr_Format(PyExc_ValueError,
3689 "invalid file open mode %.200s", mode);
Victor Stinner1a563032010-10-15 22:43:10 +00003690 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003691 return NULL;
3692 }
3693 }
3694 if (fob == Py_None)
3695 fp = NULL;
3696 else {
3697 fp = get_file(NULL, fob, mode);
3698 if (fp == NULL) {
Victor Stinner1a563032010-10-15 22:43:10 +00003699 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003700 return NULL;
3701 }
3702 }
Victor Stinner41c5fec2011-03-13 21:46:30 -04003703 ret = load_module(name, fp, pathname, type, NULL);
Victor Stinner1a563032010-10-15 22:43:10 +00003704 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003705 if (fp)
3706 fclose(fp);
3707 return ret;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003708}
3709
3710static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003711imp_load_package(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003712{
Victor Stinnerc9abda02011-03-14 13:33:46 -04003713 PyObject *name, *pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003714 PyObject * ret;
Victor Stinnerc9abda02011-03-14 13:33:46 -04003715 if (!PyArg_ParseTuple(args, "UO&:load_package",
3716 &name, PyUnicode_FSDecoder, &pathname))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003717 return NULL;
Victor Stinnerc9abda02011-03-14 13:33:46 -04003718 ret = load_package(name, pathname);
Victor Stinnerebc00522010-12-03 17:06:43 +00003719 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003720 return ret;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003721}
3722
3723static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003724imp_new_module(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003725{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003726 char *name;
3727 if (!PyArg_ParseTuple(args, "s:new_module", &name))
3728 return NULL;
3729 return PyModule_New(name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003730}
3731
Christian Heimes13a7a212008-01-07 17:13:09 +00003732static PyObject *
3733imp_reload(PyObject *self, PyObject *v)
3734{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003735 return PyImport_ReloadModule(v);
Christian Heimes13a7a212008-01-07 17:13:09 +00003736}
3737
3738PyDoc_STRVAR(doc_reload,
3739"reload(module) -> module\n\
3740\n\
3741Reload the module. The module must have been successfully imported before.");
3742
Barry Warsaw28a691b2010-04-17 00:19:56 +00003743static PyObject *
3744imp_cache_from_source(PyObject *self, PyObject *args, PyObject *kws)
3745{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003746 static char *kwlist[] = {"path", "debug_override", NULL};
Barry Warsaw28a691b2010-04-17 00:19:56 +00003747
Victor Stinner2f42ae52011-03-20 00:41:24 +01003748 PyObject *pathname, *cpathname;
Benjamin Peterson294a9fc2010-10-16 03:12:39 +00003749 PyObject *debug_override = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003750 int debug = !Py_OptimizeFlag;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003751
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003752 if (!PyArg_ParseTupleAndKeywords(
Victor Stinner3ea23dd2010-10-15 20:34:32 +00003753 args, kws, "O&|O", kwlist,
Victor Stinner2f42ae52011-03-20 00:41:24 +01003754 PyUnicode_FSDecoder, &pathname, &debug_override))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003755 return NULL;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003756
Benjamin Peterson294a9fc2010-10-16 03:12:39 +00003757 if (debug_override != NULL &&
3758 (debug = PyObject_IsTrue(debug_override)) < 0) {
Victor Stinner2f42ae52011-03-20 00:41:24 +01003759 Py_DECREF(pathname);
Benjamin Peterson294a9fc2010-10-16 03:12:39 +00003760 return NULL;
3761 }
Barry Warsaw28a691b2010-04-17 00:19:56 +00003762
Victor Stinner3ea23dd2010-10-15 20:34:32 +00003763 cpathname = make_compiled_pathname(
Victor Stinner2f42ae52011-03-20 00:41:24 +01003764 PyUnicode_AS_UNICODE(pathname),
3765 debug);
3766 Py_DECREF(pathname);
Barry Warsaw28a691b2010-04-17 00:19:56 +00003767
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003768 if (cpathname == NULL) {
3769 PyErr_Format(PyExc_SystemError, "path buffer too short");
3770 return NULL;
3771 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01003772 return cpathname;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003773}
3774
3775PyDoc_STRVAR(doc_cache_from_source,
3776"Given the path to a .py file, return the path to its .pyc/.pyo file.\n\
3777\n\
3778The .py file does not need to exist; this simply returns the path to the\n\
3779.pyc/.pyo file calculated as if the .py file were imported. The extension\n\
3780will be .pyc unless __debug__ is not defined, then it will be .pyo.\n\
3781\n\
3782If debug_override is not None, then it must be a boolean and is taken as\n\
3783the value of __debug__ instead.");
3784
3785static PyObject *
3786imp_source_from_cache(PyObject *self, PyObject *args, PyObject *kws)
3787{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003788 static char *kwlist[] = {"path", NULL};
Victor Stinnerc9abda02011-03-14 13:33:46 -04003789 PyObject *pathname, *source;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003790
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003791 if (!PyArg_ParseTupleAndKeywords(
Victor Stinnerebc00522010-12-03 17:06:43 +00003792 args, kws, "O&", kwlist,
Victor Stinnerc9abda02011-03-14 13:33:46 -04003793 PyUnicode_FSDecoder, &pathname))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003794 return NULL;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003795
Victor Stinnerc9abda02011-03-14 13:33:46 -04003796 source = make_source_pathname(pathname);
3797 if (source == NULL) {
3798 PyErr_Format(PyExc_ValueError, "Not a PEP 3147 pyc path: %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003799 pathname);
Victor Stinnerc9abda02011-03-14 13:33:46 -04003800 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003801 return NULL;
3802 }
Victor Stinnerc9abda02011-03-14 13:33:46 -04003803 Py_DECREF(pathname);
3804 return source;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003805}
3806
3807PyDoc_STRVAR(doc_source_from_cache,
3808"Given the path to a .pyc./.pyo file, return the path to its .py file.\n\
3809\n\
3810The .pyc/.pyo file does not need to exist; this simply returns the path to\n\
3811the .py file calculated to correspond to the .pyc/.pyo file. If path\n\
3812does not conform to PEP 3147 format, ValueError will be raised.");
3813
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003814/* Doc strings */
3815
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003816PyDoc_STRVAR(doc_imp,
3817"This module provides the components needed to build your own\n\
3818__import__ function. Undocumented functions are obsolete.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003819
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003820PyDoc_STRVAR(doc_find_module,
3821"find_module(name, [path]) -> (file, filename, (suffix, mode, type))\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003822Search for a module. If path is omitted or None, search for a\n\
3823built-in, frozen or special module and continue search in sys.path.\n\
3824The module name cannot contain '.'; to search for a submodule of a\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003825package, pass the submodule name and the package's __path__.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003826
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003827PyDoc_STRVAR(doc_load_module,
3828"load_module(name, file, filename, (suffix, mode, type)) -> module\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003829Load a module, given information returned by find_module().\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003830The module name must include the full package name, if any.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003831
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003832PyDoc_STRVAR(doc_get_magic,
3833"get_magic() -> string\n\
3834Return the magic number for .pyc or .pyo files.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003835
Barry Warsaw28a691b2010-04-17 00:19:56 +00003836PyDoc_STRVAR(doc_get_tag,
3837"get_tag() -> string\n\
3838Return the magic tag for .pyc or .pyo files.");
3839
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003840PyDoc_STRVAR(doc_get_suffixes,
3841"get_suffixes() -> [(suffix, mode, type), ...]\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003842Return a list of (suffix, mode, type) tuples describing the files\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003843that find_module() looks for.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003844
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003845PyDoc_STRVAR(doc_new_module,
3846"new_module(name) -> module\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003847Create a new module. Do not enter it in sys.modules.\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003848The module name must include the full package name, if any.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003849
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003850PyDoc_STRVAR(doc_lock_held,
Tim Petersa7c65092004-08-01 23:26:05 +00003851"lock_held() -> boolean\n\
3852Return True if the import lock is currently held, else False.\n\
3853On platforms without threads, return False.");
Tim Peters69232342001-08-30 05:16:13 +00003854
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00003855PyDoc_STRVAR(doc_acquire_lock,
3856"acquire_lock() -> None\n\
Neal Norwitz2294c0d2003-02-12 23:02:21 +00003857Acquires the interpreter's import lock for the current thread.\n\
3858This lock should be used by import hooks to ensure thread-safety\n\
3859when importing modules.\n\
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00003860On platforms without threads, this function does nothing.");
3861
3862PyDoc_STRVAR(doc_release_lock,
3863"release_lock() -> None\n\
3864Release the interpreter's import lock.\n\
3865On platforms without threads, this function does nothing.");
3866
Guido van Rossum79f25d91997-04-29 20:08:16 +00003867static PyMethodDef imp_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003868 {"find_module", imp_find_module, METH_VARARGS, doc_find_module},
3869 {"get_magic", imp_get_magic, METH_NOARGS, doc_get_magic},
3870 {"get_tag", imp_get_tag, METH_NOARGS, doc_get_tag},
3871 {"get_suffixes", imp_get_suffixes, METH_NOARGS, doc_get_suffixes},
3872 {"load_module", imp_load_module, METH_VARARGS, doc_load_module},
3873 {"new_module", imp_new_module, METH_VARARGS, doc_new_module},
3874 {"lock_held", imp_lock_held, METH_NOARGS, doc_lock_held},
3875 {"acquire_lock", imp_acquire_lock, METH_NOARGS, doc_acquire_lock},
3876 {"release_lock", imp_release_lock, METH_NOARGS, doc_release_lock},
3877 {"reload", imp_reload, METH_O, doc_reload},
3878 {"cache_from_source", (PyCFunction)imp_cache_from_source,
3879 METH_VARARGS | METH_KEYWORDS, doc_cache_from_source},
3880 {"source_from_cache", (PyCFunction)imp_source_from_cache,
3881 METH_VARARGS | METH_KEYWORDS, doc_source_from_cache},
3882 /* The rest are obsolete */
3883 {"get_frozen_object", imp_get_frozen_object, METH_VARARGS},
3884 {"is_frozen_package", imp_is_frozen_package, METH_VARARGS},
3885 {"init_builtin", imp_init_builtin, METH_VARARGS},
3886 {"init_frozen", imp_init_frozen, METH_VARARGS},
3887 {"is_builtin", imp_is_builtin, METH_VARARGS},
3888 {"is_frozen", imp_is_frozen, METH_VARARGS},
3889 {"load_compiled", imp_load_compiled, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003890#ifdef HAVE_DYNAMIC_LOADING
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003891 {"load_dynamic", imp_load_dynamic, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003892#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003893 {"load_package", imp_load_package, METH_VARARGS},
3894 {"load_source", imp_load_source, METH_VARARGS},
3895 {NULL, NULL} /* sentinel */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003896};
3897
Guido van Rossum1a8791e1998-08-04 22:46:29 +00003898static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003899setint(PyObject *d, char *name, int value)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003900{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003901 PyObject *v;
3902 int err;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003903
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003904 v = PyLong_FromLong((long)value);
3905 err = PyDict_SetItemString(d, name, v);
3906 Py_XDECREF(v);
3907 return err;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003908}
3909
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003910typedef struct {
3911 PyObject_HEAD
3912} NullImporter;
3913
3914static int
3915NullImporter_init(NullImporter *self, PyObject *args, PyObject *kwds)
3916{
Victor Stinner1a4d12d2010-08-13 13:07:29 +00003917#ifndef MS_WINDOWS
3918 PyObject *path;
3919 struct stat statbuf;
3920 int rv;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003921
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003922 if (!_PyArg_NoKeywords("NullImporter()", kwds))
3923 return -1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003924
Victor Stinner1a4d12d2010-08-13 13:07:29 +00003925 if (!PyArg_ParseTuple(args, "O&:NullImporter",
3926 PyUnicode_FSConverter, &path))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003927 return -1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003928
Victor Stinner1a4d12d2010-08-13 13:07:29 +00003929 if (PyBytes_GET_SIZE(path) == 0) {
3930 Py_DECREF(path);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003931 PyErr_SetString(PyExc_ImportError, "empty pathname");
3932 return -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003933 }
Victor Stinner1a4d12d2010-08-13 13:07:29 +00003934
3935 rv = stat(PyBytes_AS_STRING(path), &statbuf);
3936 Py_DECREF(path);
3937 if (rv == 0) {
3938 /* it exists */
3939 if (S_ISDIR(statbuf.st_mode)) {
3940 /* it's a directory */
3941 PyErr_SetString(PyExc_ImportError, "existing directory");
3942 return -1;
3943 }
3944 }
3945#else /* MS_WINDOWS */
3946 PyObject *pathobj;
3947 DWORD rv;
Victor Stinner255dfdb2010-09-29 10:28:51 +00003948 wchar_t *path;
Victor Stinner1a4d12d2010-08-13 13:07:29 +00003949
3950 if (!_PyArg_NoKeywords("NullImporter()", kwds))
3951 return -1;
3952
3953 if (!PyArg_ParseTuple(args, "U:NullImporter",
3954 &pathobj))
3955 return -1;
3956
3957 if (PyUnicode_GET_SIZE(pathobj) == 0) {
3958 PyErr_SetString(PyExc_ImportError, "empty pathname");
3959 return -1;
3960 }
3961
Victor Stinnerbeb4135b2010-10-07 01:02:42 +00003962 path = PyUnicode_AsWideCharString(pathobj, NULL);
Victor Stinner255dfdb2010-09-29 10:28:51 +00003963 if (path == NULL)
Victor Stinner1a4d12d2010-08-13 13:07:29 +00003964 return -1;
3965 /* see issue1293 and issue3677:
3966 * stat() on Windows doesn't recognise paths like
3967 * "e:\\shared\\" and "\\\\whiterab-c2znlh\\shared" as dirs.
3968 */
3969 rv = GetFileAttributesW(path);
Victor Stinner255dfdb2010-09-29 10:28:51 +00003970 PyMem_Free(path);
Victor Stinner1a4d12d2010-08-13 13:07:29 +00003971 if (rv != INVALID_FILE_ATTRIBUTES) {
3972 /* it exists */
3973 if (rv & FILE_ATTRIBUTE_DIRECTORY) {
3974 /* it's a directory */
3975 PyErr_SetString(PyExc_ImportError, "existing directory");
3976 return -1;
3977 }
3978 }
3979#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003980 return 0;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003981}
3982
3983static PyObject *
3984NullImporter_find_module(NullImporter *self, PyObject *args)
3985{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003986 Py_RETURN_NONE;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003987}
3988
3989static PyMethodDef NullImporter_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003990 {"find_module", (PyCFunction)NullImporter_find_module, METH_VARARGS,
3991 "Always return None"
3992 },
3993 {NULL} /* Sentinel */
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003994};
3995
3996
Christian Heimes9cd17752007-11-18 19:35:23 +00003997PyTypeObject PyNullImporter_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003998 PyVarObject_HEAD_INIT(NULL, 0)
3999 "imp.NullImporter", /*tp_name*/
4000 sizeof(NullImporter), /*tp_basicsize*/
4001 0, /*tp_itemsize*/
4002 0, /*tp_dealloc*/
4003 0, /*tp_print*/
4004 0, /*tp_getattr*/
4005 0, /*tp_setattr*/
4006 0, /*tp_reserved*/
4007 0, /*tp_repr*/
4008 0, /*tp_as_number*/
4009 0, /*tp_as_sequence*/
4010 0, /*tp_as_mapping*/
4011 0, /*tp_hash */
4012 0, /*tp_call*/
4013 0, /*tp_str*/
4014 0, /*tp_getattro*/
4015 0, /*tp_setattro*/
4016 0, /*tp_as_buffer*/
4017 Py_TPFLAGS_DEFAULT, /*tp_flags*/
4018 "Null importer object", /* tp_doc */
4019 0, /* tp_traverse */
4020 0, /* tp_clear */
4021 0, /* tp_richcompare */
4022 0, /* tp_weaklistoffset */
4023 0, /* tp_iter */
4024 0, /* tp_iternext */
4025 NullImporter_methods, /* tp_methods */
4026 0, /* tp_members */
4027 0, /* tp_getset */
4028 0, /* tp_base */
4029 0, /* tp_dict */
4030 0, /* tp_descr_get */
4031 0, /* tp_descr_set */
4032 0, /* tp_dictoffset */
4033 (initproc)NullImporter_init, /* tp_init */
4034 0, /* tp_alloc */
4035 PyType_GenericNew /* tp_new */
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004036};
4037
Martin v. Löwis1a214512008-06-11 05:26:20 +00004038static struct PyModuleDef impmodule = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004039 PyModuleDef_HEAD_INIT,
4040 "imp",
4041 doc_imp,
4042 0,
4043 imp_methods,
4044 NULL,
4045 NULL,
4046 NULL,
4047 NULL
Martin v. Löwis1a214512008-06-11 05:26:20 +00004048};
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004049
Jason Tishler6bc06ec2003-09-04 11:59:50 +00004050PyMODINIT_FUNC
Martin v. Löwis1a214512008-06-11 05:26:20 +00004051PyInit_imp(void)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004052{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004053 PyObject *m, *d;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004054
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004055 if (PyType_Ready(&PyNullImporter_Type) < 0)
4056 return NULL;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004057
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004058 m = PyModule_Create(&impmodule);
4059 if (m == NULL)
4060 goto failure;
4061 d = PyModule_GetDict(m);
4062 if (d == NULL)
4063 goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004064
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004065 if (setint(d, "SEARCH_ERROR", SEARCH_ERROR) < 0) goto failure;
4066 if (setint(d, "PY_SOURCE", PY_SOURCE) < 0) goto failure;
4067 if (setint(d, "PY_COMPILED", PY_COMPILED) < 0) goto failure;
4068 if (setint(d, "C_EXTENSION", C_EXTENSION) < 0) goto failure;
4069 if (setint(d, "PY_RESOURCE", PY_RESOURCE) < 0) goto failure;
4070 if (setint(d, "PKG_DIRECTORY", PKG_DIRECTORY) < 0) goto failure;
4071 if (setint(d, "C_BUILTIN", C_BUILTIN) < 0) goto failure;
4072 if (setint(d, "PY_FROZEN", PY_FROZEN) < 0) goto failure;
4073 if (setint(d, "PY_CODERESOURCE", PY_CODERESOURCE) < 0) goto failure;
4074 if (setint(d, "IMP_HOOK", IMP_HOOK) < 0) goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004075
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004076 Py_INCREF(&PyNullImporter_Type);
4077 PyModule_AddObject(m, "NullImporter", (PyObject *)&PyNullImporter_Type);
4078 return m;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00004079 failure:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004080 Py_XDECREF(m);
4081 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004082}
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004083
4084
Guido van Rossumb18618d2000-05-03 23:44:39 +00004085/* API for embedding applications that want to add their own entries
4086 to the table of built-in modules. This should normally be called
4087 *before* Py_Initialize(). When the table resize fails, -1 is
4088 returned and the existing table is unchanged.
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004089
4090 After a similar function by Just van Rossum. */
4091
4092int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00004093PyImport_ExtendInittab(struct _inittab *newtab)
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004094{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004095 static struct _inittab *our_copy = NULL;
4096 struct _inittab *p;
4097 int i, n;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004098
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004099 /* Count the number of entries in both tables */
4100 for (n = 0; newtab[n].name != NULL; n++)
4101 ;
4102 if (n == 0)
4103 return 0; /* Nothing to do */
4104 for (i = 0; PyImport_Inittab[i].name != NULL; i++)
4105 ;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004106
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004107 /* Allocate new memory for the combined table */
4108 p = our_copy;
4109 PyMem_RESIZE(p, struct _inittab, i+n+1);
4110 if (p == NULL)
4111 return -1;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004112
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004113 /* Copy the tables into the new memory */
4114 if (our_copy != PyImport_Inittab)
4115 memcpy(p, PyImport_Inittab, (i+1) * sizeof(struct _inittab));
4116 PyImport_Inittab = our_copy = p;
4117 memcpy(p+i, newtab, (n+1) * sizeof(struct _inittab));
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004118
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004119 return 0;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004120}
4121
4122/* Shorthand to add a single entry given a name and a function */
4123
4124int
Brett Cannona826f322009-04-02 03:41:46 +00004125PyImport_AppendInittab(const char *name, PyObject* (*initfunc)(void))
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004126{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004127 struct _inittab newtab[2];
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004128
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004129 memset(newtab, '\0', sizeof newtab);
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004130
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004131 newtab[0].name = (char *)name;
4132 newtab[0].initfunc = initfunc;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004133
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004134 return PyImport_ExtendInittab(newtab);
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004135}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00004136
4137#ifdef __cplusplus
4138}
4139#endif