blob: beda7f97d274b2f426cf19d3d0e7921ea352c173 [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)
110 TAG must change for each major Python release. The magic number will take
111 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__"
116/* Current magic word and string tag as globals. */
Guido van Rossum96774c12000-05-01 20:19:08 +0000117static long pyc_magic = MAGIC;
Barry Warsaw28a691b2010-04-17 00:19:56 +0000118static const char *pyc_tag = TAG;
Guido van Rossum96774c12000-05-01 20:19:08 +0000119
Victor Stinner49d3f252010-10-17 01:24:53 +0000120/* See _PyImport_FixupExtensionUnicode() below */
Guido van Rossum25ce5661997-08-02 03:10:38 +0000121static PyObject *extensions = NULL;
Guido van Rossum3f5da241990-12-20 15:06:42 +0000122
Guido van Rossum771c6c81997-10-31 18:37:24 +0000123/* This table is defined in config.c: */
124extern struct _inittab _PyImport_Inittab[];
125
Guido van Rossumce3a72a2007-10-19 23:16:50 +0000126/* Method from Parser/tokenizer.c */
Guido van Rossum40d20bc2007-10-22 00:09:51 +0000127extern char * PyTokenizer_FindEncoding(int);
Guido van Rossumce3a72a2007-10-19 23:16:50 +0000128
Guido van Rossum771c6c81997-10-31 18:37:24 +0000129struct _inittab *PyImport_Inittab = _PyImport_Inittab;
Guido van Rossum66f1fa81991-04-03 19:03:52 +0000130
Guido van Rossumed1170e1999-12-20 21:23:41 +0000131/* these tables define the module suffixes that Python recognizes */
132struct filedescr * _PyImport_Filetab = NULL;
Guido van Rossum48a680c2001-03-02 06:34:14 +0000133
Guido van Rossumed1170e1999-12-20 21:23:41 +0000134static const struct filedescr _PyImport_StandardFiletab[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000135 {".py", "U", PY_SOURCE},
Martin v. Löwis6238d2b2002-06-30 15:26:10 +0000136#ifdef MS_WINDOWS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000137 {".pyw", "U", PY_SOURCE},
Tim Peters36515e22001-11-18 04:06:29 +0000138#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000139 {".pyc", "rb", PY_COMPILED},
140 {0, 0}
Guido van Rossumed1170e1999-12-20 21:23:41 +0000141};
142
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000143
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000144/* Initialize things */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000145
146void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000147_PyImport_Init(void)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000148{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000149 const struct filedescr *scan;
150 struct filedescr *filetab;
151 int countD = 0;
152 int countS = 0;
Guido van Rossumed1170e1999-12-20 21:23:41 +0000153
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000154 /* prepare _PyImport_Filetab: copy entries from
155 _PyImport_DynLoadFiletab and _PyImport_StandardFiletab.
156 */
Guido van Rossum04110fb2007-08-24 16:32:05 +0000157#ifdef HAVE_DYNAMIC_LOADING
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000158 for (scan = _PyImport_DynLoadFiletab; scan->suffix != NULL; ++scan)
159 ++countD;
Guido van Rossum04110fb2007-08-24 16:32:05 +0000160#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000161 for (scan = _PyImport_StandardFiletab; scan->suffix != NULL; ++scan)
162 ++countS;
163 filetab = PyMem_NEW(struct filedescr, countD + countS + 1);
164 if (filetab == NULL)
165 Py_FatalError("Can't initialize import file table.");
Guido van Rossum04110fb2007-08-24 16:32:05 +0000166#ifdef HAVE_DYNAMIC_LOADING
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000167 memcpy(filetab, _PyImport_DynLoadFiletab,
168 countD * sizeof(struct filedescr));
Guido van Rossum04110fb2007-08-24 16:32:05 +0000169#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000170 memcpy(filetab + countD, _PyImport_StandardFiletab,
171 countS * sizeof(struct filedescr));
172 filetab[countD + countS].suffix = NULL;
Guido van Rossumed1170e1999-12-20 21:23:41 +0000173
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000174 _PyImport_Filetab = filetab;
Guido van Rossumed1170e1999-12-20 21:23:41 +0000175
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000176 if (Py_OptimizeFlag) {
177 /* Replace ".pyc" with ".pyo" in _PyImport_Filetab */
178 for (; filetab->suffix != NULL; filetab++) {
179 if (strcmp(filetab->suffix, ".pyc") == 0)
180 filetab->suffix = ".pyo";
181 }
182 }
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000183}
184
Guido van Rossum25ce5661997-08-02 03:10:38 +0000185void
Just van Rossum52e14d62002-12-30 22:08:05 +0000186_PyImportHooks_Init(void)
187{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000188 PyObject *v, *path_hooks = NULL, *zimpimport;
189 int err = 0;
Just van Rossum52e14d62002-12-30 22:08:05 +0000190
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000191 /* adding sys.path_hooks and sys.path_importer_cache, setting up
192 zipimport */
193 if (PyType_Ready(&PyNullImporter_Type) < 0)
194 goto error;
Just van Rossum52e14d62002-12-30 22:08:05 +0000195
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000196 if (Py_VerboseFlag)
197 PySys_WriteStderr("# installing zipimport hook\n");
Just van Rossum52e14d62002-12-30 22:08:05 +0000198
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000199 v = PyList_New(0);
200 if (v == NULL)
201 goto error;
202 err = PySys_SetObject("meta_path", v);
203 Py_DECREF(v);
204 if (err)
205 goto error;
206 v = PyDict_New();
207 if (v == NULL)
208 goto error;
209 err = PySys_SetObject("path_importer_cache", v);
210 Py_DECREF(v);
211 if (err)
212 goto error;
213 path_hooks = PyList_New(0);
214 if (path_hooks == NULL)
215 goto error;
216 err = PySys_SetObject("path_hooks", path_hooks);
217 if (err) {
Just van Rossum52e14d62002-12-30 22:08:05 +0000218 error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000219 PyErr_Print();
220 Py_FatalError("initializing sys.meta_path, sys.path_hooks, "
221 "path_importer_cache, or NullImporter failed"
222 );
223 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000224
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000225 zimpimport = PyImport_ImportModule("zipimport");
226 if (zimpimport == NULL) {
227 PyErr_Clear(); /* No zip import module -- okay */
228 if (Py_VerboseFlag)
229 PySys_WriteStderr("# can't import zipimport\n");
230 }
231 else {
232 PyObject *zipimporter = PyObject_GetAttrString(zimpimport,
233 "zipimporter");
234 Py_DECREF(zimpimport);
235 if (zipimporter == NULL) {
236 PyErr_Clear(); /* No zipimporter object -- okay */
237 if (Py_VerboseFlag)
238 PySys_WriteStderr(
239 "# can't import zipimport.zipimporter\n");
240 }
241 else {
242 /* sys.path_hooks.append(zipimporter) */
243 err = PyList_Append(path_hooks, zipimporter);
244 Py_DECREF(zipimporter);
245 if (err)
246 goto error;
247 if (Py_VerboseFlag)
248 PySys_WriteStderr(
249 "# installed zipimport hook\n");
250 }
251 }
252 Py_DECREF(path_hooks);
Just van Rossum52e14d62002-12-30 22:08:05 +0000253}
254
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000255/* Locking primitives to prevent parallel imports of the same module
256 in different threads to return with a partially loaded module.
257 These calls are serialized by the global interpreter lock. */
258
259#ifdef WITH_THREAD
260
Guido van Rossum49b56061998-10-01 20:42:43 +0000261#include "pythread.h"
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000262
Guido van Rossum65d5b571998-12-21 19:32:43 +0000263static PyThread_type_lock import_lock = 0;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000264static long import_lock_thread = -1;
265static int import_lock_level = 0;
266
Benjamin Peterson0df35a92009-10-04 20:32:25 +0000267void
268_PyImport_AcquireLock(void)
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000269{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000270 long me = PyThread_get_thread_ident();
271 if (me == -1)
272 return; /* Too bad */
273 if (import_lock == NULL) {
274 import_lock = PyThread_allocate_lock();
275 if (import_lock == NULL)
276 return; /* Nothing much we can do. */
277 }
278 if (import_lock_thread == me) {
279 import_lock_level++;
280 return;
281 }
282 if (import_lock_thread != -1 || !PyThread_acquire_lock(import_lock, 0))
283 {
284 PyThreadState *tstate = PyEval_SaveThread();
285 PyThread_acquire_lock(import_lock, 1);
286 PyEval_RestoreThread(tstate);
287 }
288 import_lock_thread = me;
289 import_lock_level = 1;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000290}
291
Benjamin Peterson0df35a92009-10-04 20:32:25 +0000292int
293_PyImport_ReleaseLock(void)
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000294{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000295 long me = PyThread_get_thread_ident();
296 if (me == -1 || import_lock == NULL)
297 return 0; /* Too bad */
298 if (import_lock_thread != me)
299 return -1;
300 import_lock_level--;
301 if (import_lock_level == 0) {
302 import_lock_thread = -1;
303 PyThread_release_lock(import_lock);
304 }
305 return 1;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000306}
307
Gregory P. Smith24cec9f2010-03-01 06:18:41 +0000308/* This function is called from PyOS_AfterFork to ensure that newly
309 created child processes do not share locks with the parent.
310 We now acquire the import lock around fork() calls but on some platforms
311 (Solaris 9 and earlier? see isue7242) that still left us with problems. */
Guido van Rossum8ee3e5a2005-09-14 18:09:42 +0000312
313void
314_PyImport_ReInitLock(void)
315{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000316 if (import_lock != NULL)
317 import_lock = PyThread_allocate_lock();
Nick Coghlanb2ddf792010-12-02 04:11:46 +0000318 if (import_lock_level > 1) {
319 /* Forked as a side effect of import */
320 long me = PyThread_get_thread_ident();
321 PyThread_acquire_lock(import_lock, 0);
322 /* XXX: can the previous line fail? */
323 import_lock_thread = me;
324 import_lock_level--;
325 } else {
326 import_lock_thread = -1;
327 import_lock_level = 0;
328 }
Guido van Rossum8ee3e5a2005-09-14 18:09:42 +0000329}
330
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000331#endif
332
Tim Peters69232342001-08-30 05:16:13 +0000333static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000334imp_lock_held(PyObject *self, PyObject *noargs)
Tim Peters69232342001-08-30 05:16:13 +0000335{
Tim Peters69232342001-08-30 05:16:13 +0000336#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000337 return PyBool_FromLong(import_lock_thread != -1);
Tim Peters69232342001-08-30 05:16:13 +0000338#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000339 return PyBool_FromLong(0);
Tim Peters69232342001-08-30 05:16:13 +0000340#endif
341}
342
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000343static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000344imp_acquire_lock(PyObject *self, PyObject *noargs)
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000345{
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000346#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000347 _PyImport_AcquireLock();
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000348#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000349 Py_INCREF(Py_None);
350 return Py_None;
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000351}
352
353static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000354imp_release_lock(PyObject *self, PyObject *noargs)
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000355{
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000356#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000357 if (_PyImport_ReleaseLock() < 0) {
358 PyErr_SetString(PyExc_RuntimeError,
359 "not holding the import lock");
360 return NULL;
361 }
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
Antoine Pitrou8db076c2011-10-30 19:13:55 +0100367void
368_PyImport_Fini(void)
369{
370 Py_XDECREF(extensions);
371 extensions = NULL;
372 PyMem_DEL(_PyImport_Filetab);
373 _PyImport_Filetab = NULL;
374#ifdef WITH_THREAD
375 if (import_lock != NULL) {
376 PyThread_free_lock(import_lock);
377 import_lock = NULL;
378 }
379#endif
380}
381
Guido van Rossumd8faa362007-04-27 19:54:29 +0000382static void
383imp_modules_reloading_clear(void)
384{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000385 PyInterpreterState *interp = PyThreadState_Get()->interp;
386 if (interp->modules_reloading != NULL)
387 PyDict_Clear(interp->modules_reloading);
Guido van Rossumd8faa362007-04-27 19:54:29 +0000388}
389
Guido van Rossum25ce5661997-08-02 03:10:38 +0000390/* Helper for sys */
391
392PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000393PyImport_GetModuleDict(void)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000394{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000395 PyInterpreterState *interp = PyThreadState_GET()->interp;
396 if (interp->modules == NULL)
397 Py_FatalError("PyImport_GetModuleDict: no module dictionary!");
398 return interp->modules;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000399}
400
Guido van Rossum3f5da241990-12-20 15:06:42 +0000401
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000402/* List of names to clear in sys */
403static char* sys_deletes[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000404 "path", "argv", "ps1", "ps2",
405 "last_type", "last_value", "last_traceback",
406 "path_hooks", "path_importer_cache", "meta_path",
407 /* misc stuff */
408 "flags", "float_info",
409 NULL
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000410};
411
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000412static char* sys_files[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000413 "stdin", "__stdin__",
414 "stdout", "__stdout__",
415 "stderr", "__stderr__",
416 NULL
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000417};
418
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000419
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000420/* Un-initialize things, as good as we can */
Guido van Rossum3f5da241990-12-20 15:06:42 +0000421
Guido van Rossum3f5da241990-12-20 15:06:42 +0000422void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000423PyImport_Cleanup(void)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000424{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000425 Py_ssize_t pos, ndone;
426 char *name;
427 PyObject *key, *value, *dict;
428 PyInterpreterState *interp = PyThreadState_GET()->interp;
429 PyObject *modules = interp->modules;
Guido van Rossum758eec01998-01-19 21:58:26 +0000430
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000431 if (modules == NULL)
432 return; /* Already done */
Guido van Rossum758eec01998-01-19 21:58:26 +0000433
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000434 /* Delete some special variables first. These are common
435 places where user values hide and people complain when their
436 destructors fail. Since the modules containing them are
437 deleted *last* of all, they would come too late in the normal
438 destruction order. Sigh. */
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000439
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000440 value = PyDict_GetItemString(modules, "builtins");
441 if (value != NULL && PyModule_Check(value)) {
442 dict = PyModule_GetDict(value);
443 if (Py_VerboseFlag)
444 PySys_WriteStderr("# clear builtins._\n");
445 PyDict_SetItemString(dict, "_", Py_None);
446 }
447 value = PyDict_GetItemString(modules, "sys");
448 if (value != NULL && PyModule_Check(value)) {
449 char **p;
450 PyObject *v;
451 dict = PyModule_GetDict(value);
452 for (p = sys_deletes; *p != NULL; p++) {
453 if (Py_VerboseFlag)
454 PySys_WriteStderr("# clear sys.%s\n", *p);
455 PyDict_SetItemString(dict, *p, Py_None);
456 }
457 for (p = sys_files; *p != NULL; p+=2) {
458 if (Py_VerboseFlag)
459 PySys_WriteStderr("# restore sys.%s\n", *p);
460 v = PyDict_GetItemString(dict, *(p+1));
461 if (v == NULL)
462 v = Py_None;
463 PyDict_SetItemString(dict, *p, v);
464 }
465 }
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000466
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000467 /* First, delete __main__ */
468 value = PyDict_GetItemString(modules, "__main__");
469 if (value != NULL && PyModule_Check(value)) {
470 if (Py_VerboseFlag)
471 PySys_WriteStderr("# cleanup __main__\n");
472 _PyModule_Clear(value);
473 PyDict_SetItemString(modules, "__main__", Py_None);
474 }
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000475
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000476 /* The special treatment of "builtins" here is because even
477 when it's not referenced as a module, its dictionary is
478 referenced by almost every module's __builtins__. Since
479 deleting a module clears its dictionary (even if there are
480 references left to it), we need to delete the "builtins"
481 module last. Likewise, we don't delete sys until the very
482 end because it is implicitly referenced (e.g. by print).
Guido van Rossum758eec01998-01-19 21:58:26 +0000483
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000484 Also note that we 'delete' modules by replacing their entry
485 in the modules dict with None, rather than really deleting
486 them; this avoids a rehash of the modules dictionary and
487 also marks them as "non existent" so they won't be
488 re-imported. */
Guido van Rossum758eec01998-01-19 21:58:26 +0000489
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000490 /* Next, repeatedly delete modules with a reference count of
491 one (skipping builtins and sys) and delete them */
492 do {
493 ndone = 0;
494 pos = 0;
495 while (PyDict_Next(modules, &pos, &key, &value)) {
496 if (value->ob_refcnt != 1)
497 continue;
498 if (PyUnicode_Check(key) && PyModule_Check(value)) {
499 name = _PyUnicode_AsString(key);
500 if (strcmp(name, "builtins") == 0)
501 continue;
502 if (strcmp(name, "sys") == 0)
503 continue;
504 if (Py_VerboseFlag)
505 PySys_WriteStderr(
506 "# cleanup[1] %s\n", name);
507 _PyModule_Clear(value);
508 PyDict_SetItem(modules, key, Py_None);
509 ndone++;
510 }
511 }
512 } while (ndone > 0);
Guido van Rossum758eec01998-01-19 21:58:26 +0000513
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000514 /* Next, delete all modules (still skipping builtins and sys) */
515 pos = 0;
516 while (PyDict_Next(modules, &pos, &key, &value)) {
517 if (PyUnicode_Check(key) && PyModule_Check(value)) {
518 name = _PyUnicode_AsString(key);
519 if (strcmp(name, "builtins") == 0)
520 continue;
521 if (strcmp(name, "sys") == 0)
522 continue;
523 if (Py_VerboseFlag)
524 PySys_WriteStderr("# cleanup[2] %s\n", name);
525 _PyModule_Clear(value);
526 PyDict_SetItem(modules, key, Py_None);
527 }
528 }
Guido van Rossum758eec01998-01-19 21:58:26 +0000529
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000530 /* Next, delete sys and builtins (in that order) */
531 value = PyDict_GetItemString(modules, "sys");
532 if (value != NULL && PyModule_Check(value)) {
533 if (Py_VerboseFlag)
534 PySys_WriteStderr("# cleanup sys\n");
535 _PyModule_Clear(value);
536 PyDict_SetItemString(modules, "sys", Py_None);
537 }
538 value = PyDict_GetItemString(modules, "builtins");
539 if (value != NULL && PyModule_Check(value)) {
540 if (Py_VerboseFlag)
541 PySys_WriteStderr("# cleanup builtins\n");
542 _PyModule_Clear(value);
543 PyDict_SetItemString(modules, "builtins", Py_None);
544 }
Guido van Rossum758eec01998-01-19 21:58:26 +0000545
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000546 /* Finally, clear and delete the modules directory */
547 PyDict_Clear(modules);
548 interp->modules = NULL;
549 Py_DECREF(modules);
550 Py_CLEAR(interp->modules_reloading);
Guido van Rossum8d15b5d1990-10-26 14:58:58 +0000551}
Guido van Rossum7f133ed1991-02-19 12:23:57 +0000552
553
Barry Warsaw28a691b2010-04-17 00:19:56 +0000554/* Helper for pythonrun.c -- return magic number and tag. */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000555
556long
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000557PyImport_GetMagicNumber(void)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000558{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000559 return pyc_magic;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000560}
561
562
Barry Warsaw28a691b2010-04-17 00:19:56 +0000563const char *
564PyImport_GetMagicTag(void)
565{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000566 return pyc_tag;
Barry Warsaw28a691b2010-04-17 00:19:56 +0000567}
568
Guido van Rossum25ce5661997-08-02 03:10:38 +0000569/* Magic for extension modules (built-in as well as dynamically
570 loaded). To prevent initializing an extension module more than
571 once, we keep a static dictionary 'extensions' keyed by module name
572 (for built-in modules) or by filename (for dynamically loaded
Barry Warsaw92883382001-08-13 23:05:44 +0000573 modules), containing these modules. A copy of the module's
Victor Stinner49d3f252010-10-17 01:24:53 +0000574 dictionary is stored by calling _PyImport_FixupExtensionUnicode()
Guido van Rossum25ce5661997-08-02 03:10:38 +0000575 immediately after the module initialization function succeeds. A
576 copy can be retrieved from there by calling
Victor Stinner49d3f252010-10-17 01:24:53 +0000577 _PyImport_FindExtensionUnicode().
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000578
Barry Warsaw7c9627b2010-06-17 18:38:20 +0000579 Modules which do support multiple initialization set their m_size
580 field to a non-negative number (indicating the size of the
581 module-specific state). They are still recorded in the extensions
582 dictionary, to avoid loading shared libraries twice.
Martin v. Löwis1a214512008-06-11 05:26:20 +0000583*/
584
585int
Victor Stinner49d3f252010-10-17 01:24:53 +0000586_PyImport_FixupExtensionUnicode(PyObject *mod, char *name, PyObject *filename)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000587{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000588 PyObject *modules, *dict;
589 struct PyModuleDef *def;
590 if (extensions == NULL) {
591 extensions = PyDict_New();
592 if (extensions == NULL)
593 return -1;
594 }
595 if (mod == NULL || !PyModule_Check(mod)) {
596 PyErr_BadInternalCall();
597 return -1;
598 }
599 def = PyModule_GetDef(mod);
600 if (!def) {
601 PyErr_BadInternalCall();
602 return -1;
603 }
604 modules = PyImport_GetModuleDict();
605 if (PyDict_SetItemString(modules, name, mod) < 0)
606 return -1;
607 if (_PyState_AddModule(mod, def) < 0) {
608 PyDict_DelItemString(modules, name);
609 return -1;
610 }
611 if (def->m_size == -1) {
612 if (def->m_base.m_copy) {
613 /* Somebody already imported the module,
614 likely under a different name.
615 XXX this should really not happen. */
616 Py_DECREF(def->m_base.m_copy);
617 def->m_base.m_copy = NULL;
618 }
619 dict = PyModule_GetDict(mod);
620 if (dict == NULL)
621 return -1;
622 def->m_base.m_copy = PyDict_Copy(dict);
623 if (def->m_base.m_copy == NULL)
624 return -1;
625 }
Victor Stinner49d3f252010-10-17 01:24:53 +0000626 PyDict_SetItem(extensions, filename, (PyObject*)def);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000627 return 0;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000628}
629
Victor Stinner49d3f252010-10-17 01:24:53 +0000630int
631_PyImport_FixupBuiltin(PyObject *mod, char *name)
632{
633 int res;
634 PyObject *filename;
635 filename = PyUnicode_FromString(name);
636 if (filename == NULL)
637 return -1;
638 res = _PyImport_FixupExtensionUnicode(mod, name, filename);
639 Py_DECREF(filename);
640 return res;
641}
642
Guido van Rossum25ce5661997-08-02 03:10:38 +0000643PyObject *
Victor Stinner49d3f252010-10-17 01:24:53 +0000644_PyImport_FindExtensionUnicode(char *name, PyObject *filename)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000645{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000646 PyObject *mod, *mdict;
647 PyModuleDef* def;
648 if (extensions == NULL)
649 return NULL;
Victor Stinner49d3f252010-10-17 01:24:53 +0000650 def = (PyModuleDef*)PyDict_GetItem(extensions, filename);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000651 if (def == NULL)
652 return NULL;
653 if (def->m_size == -1) {
654 /* Module does not support repeated initialization */
655 if (def->m_base.m_copy == NULL)
656 return NULL;
657 mod = PyImport_AddModule(name);
658 if (mod == NULL)
659 return NULL;
660 mdict = PyModule_GetDict(mod);
661 if (mdict == NULL)
662 return NULL;
663 if (PyDict_Update(mdict, def->m_base.m_copy))
664 return NULL;
665 }
666 else {
667 if (def->m_base.m_init == NULL)
668 return NULL;
669 mod = def->m_base.m_init();
670 if (mod == NULL)
671 return NULL;
672 PyDict_SetItemString(PyImport_GetModuleDict(), name, mod);
673 Py_DECREF(mod);
674 }
675 if (_PyState_AddModule(mod, def) < 0) {
676 PyDict_DelItemString(PyImport_GetModuleDict(), name);
677 Py_DECREF(mod);
678 return NULL;
679 }
680 if (Py_VerboseFlag)
Victor Stinner49d3f252010-10-17 01:24:53 +0000681 PySys_FormatStderr("import %s # previously loaded (%U)\n",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000682 name, filename);
683 return mod;
Brett Cannon9a5b25a2010-03-01 02:09:17 +0000684
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000685}
686
Victor Stinner49d3f252010-10-17 01:24:53 +0000687PyObject *
688_PyImport_FindBuiltin(char *name)
689{
690 PyObject *res, *filename;
691 filename = PyUnicode_FromString(name);
692 if (filename == NULL)
693 return NULL;
694 res = _PyImport_FindExtensionUnicode(name, filename);
695 Py_DECREF(filename);
696 return res;
697}
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000698
699/* Get the module object corresponding to a module name.
700 First check the modules dictionary if there's one there,
Walter Dörwaldf0dfc7a2003-10-20 14:01:56 +0000701 if not, create a new one and insert it in the modules dictionary.
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000702 Because the former action is most common, THIS DOES NOT RETURN A
703 'NEW' REFERENCE! */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000704
Guido van Rossum79f25d91997-04-29 20:08:16 +0000705PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000706PyImport_AddModule(const char *name)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000707{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000708 PyObject *modules = PyImport_GetModuleDict();
709 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000710
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000711 if ((m = PyDict_GetItemString(modules, name)) != NULL &&
712 PyModule_Check(m))
713 return m;
714 m = PyModule_New(name);
715 if (m == NULL)
716 return NULL;
717 if (PyDict_SetItemString(modules, name, m) != 0) {
718 Py_DECREF(m);
719 return NULL;
720 }
721 Py_DECREF(m); /* Yes, it still exists, in modules! */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000722
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000723 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000724}
725
Tim Peters1cd70172004-08-02 03:52:12 +0000726/* Remove name from sys.modules, if it's there. */
727static void
Benjamin Petersonfa0aeba2010-03-25 23:30:20 +0000728remove_module(const char *name)
Tim Peters1cd70172004-08-02 03:52:12 +0000729{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000730 PyObject *modules = PyImport_GetModuleDict();
731 if (PyDict_GetItemString(modules, name) == NULL)
732 return;
733 if (PyDict_DelItemString(modules, name) < 0)
734 Py_FatalError("import: deleting existing key in"
735 "sys.modules failed");
Tim Peters1cd70172004-08-02 03:52:12 +0000736}
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000737
Barry Warsaw28a691b2010-04-17 00:19:56 +0000738static PyObject * get_sourcefile(char *file);
739static char *make_source_pathname(char *pathname, char *buf);
740static char *make_compiled_pathname(char *pathname, char *buf, size_t buflen,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000741 int debug);
Christian Heimes3b06e532008-01-07 20:12:44 +0000742
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000743/* Execute a code object in a module and return the module object
Tim Peters1cd70172004-08-02 03:52:12 +0000744 * WITH INCREMENTED REFERENCE COUNT. If an error occurs, name is
745 * removed from sys.modules, to avoid leaving damaged module objects
746 * in sys.modules. The caller may wish to restore the original
747 * module object (if any) in this case; PyImport_ReloadModule is an
748 * example.
Barry Warsaw28a691b2010-04-17 00:19:56 +0000749 *
750 * Note that PyImport_ExecCodeModuleWithPathnames() is the preferred, richer
751 * interface. The other two exist primarily for backward compatibility.
Tim Peters1cd70172004-08-02 03:52:12 +0000752 */
Guido van Rossum79f25d91997-04-29 20:08:16 +0000753PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000754PyImport_ExecCodeModule(char *name, PyObject *co)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000755{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000756 return PyImport_ExecCodeModuleWithPathnames(
757 name, co, (char *)NULL, (char *)NULL);
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000758}
759
760PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000761PyImport_ExecCodeModuleEx(char *name, PyObject *co, char *pathname)
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000762{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000763 return PyImport_ExecCodeModuleWithPathnames(
764 name, co, pathname, (char *)NULL);
Barry Warsaw28a691b2010-04-17 00:19:56 +0000765}
766
767PyObject *
768PyImport_ExecCodeModuleWithPathnames(char *name, PyObject *co, char *pathname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000769 char *cpathname)
Barry Warsaw28a691b2010-04-17 00:19:56 +0000770{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000771 PyObject *modules = PyImport_GetModuleDict();
772 PyObject *m, *d, *v;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000773
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000774 m = PyImport_AddModule(name);
775 if (m == NULL)
776 return NULL;
777 /* If the module is being reloaded, we get the old module back
778 and re-use its dict to exec the new code. */
779 d = PyModule_GetDict(m);
780 if (PyDict_GetItemString(d, "__builtins__") == NULL) {
781 if (PyDict_SetItemString(d, "__builtins__",
782 PyEval_GetBuiltins()) != 0)
783 goto error;
784 }
785 /* Remember the filename as the __file__ attribute */
786 v = NULL;
787 if (pathname != NULL) {
788 v = get_sourcefile(pathname);
789 if (v == NULL)
790 PyErr_Clear();
791 }
792 if (v == NULL) {
793 v = ((PyCodeObject *)co)->co_filename;
794 Py_INCREF(v);
795 }
796 if (PyDict_SetItemString(d, "__file__", v) != 0)
797 PyErr_Clear(); /* Not important enough to report */
798 Py_DECREF(v);
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000799
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000800 /* Remember the pyc path name as the __cached__ attribute. */
801 if (cpathname == NULL) {
802 v = Py_None;
803 Py_INCREF(v);
804 }
805 else if ((v = PyUnicode_FromString(cpathname)) == NULL) {
806 PyErr_Clear(); /* Not important enough to report */
807 v = Py_None;
808 Py_INCREF(v);
809 }
810 if (PyDict_SetItemString(d, "__cached__", v) != 0)
811 PyErr_Clear(); /* Not important enough to report */
812 Py_DECREF(v);
Barry Warsaw28a691b2010-04-17 00:19:56 +0000813
Martin v. Löwis4d0d4712010-12-03 20:14:31 +0000814 v = PyEval_EvalCode(co, d, d);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000815 if (v == NULL)
816 goto error;
817 Py_DECREF(v);
Guido van Rossumb65e85c1997-07-10 18:00:45 +0000818
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000819 if ((m = PyDict_GetItemString(modules, name)) == NULL) {
820 PyErr_Format(PyExc_ImportError,
821 "Loaded module %.200s not found in sys.modules",
822 name);
823 return NULL;
824 }
Guido van Rossumb65e85c1997-07-10 18:00:45 +0000825
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000826 Py_INCREF(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000827
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000828 return m;
Tim Peters1cd70172004-08-02 03:52:12 +0000829
830 error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000831 remove_module(name);
832 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000833}
834
835
Barry Warsaw28a691b2010-04-17 00:19:56 +0000836/* Like strrchr(string, '/') but searches for the rightmost of either SEP
837 or ALTSEP, if the latter is defined.
838*/
839static char *
840rightmost_sep(char *s)
841{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000842 char *found, c;
843 for (found = NULL; (c = *s); s++) {
844 if (c == SEP
Barry Warsaw28a691b2010-04-17 00:19:56 +0000845#ifdef ALTSEP
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000846 || c == ALTSEP
Barry Warsaw28a691b2010-04-17 00:19:56 +0000847#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000848 )
849 {
850 found = s;
851 }
852 }
853 return found;
Barry Warsaw28a691b2010-04-17 00:19:56 +0000854}
855
856
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000857/* Given a pathname for a Python source file, fill a buffer with the
858 pathname for the corresponding compiled file. Return the pathname
859 for the compiled file, or NULL if there's no space in the buffer.
860 Doesn't set an exception. */
861
862static char *
Barry Warsaw28a691b2010-04-17 00:19:56 +0000863make_compiled_pathname(char *pathname, char *buf, size_t buflen, int debug)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000864{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000865 /* foo.py -> __pycache__/foo.<tag>.pyc */
866 size_t len = strlen(pathname);
867 size_t i, save;
868 char *pos;
869 int sep = SEP;
Barry Warsaw28a691b2010-04-17 00:19:56 +0000870
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000871 /* Sanity check that the buffer has roughly enough space to hold what
872 will eventually be the full path to the compiled file. The 5 extra
873 bytes include the slash afer __pycache__, the two extra dots, the
874 extra trailing character ('c' or 'o') and null. This isn't exact
875 because the contents of the buffer can affect how many actual
876 characters of the string get into the buffer. We'll do a final
877 sanity check before writing the extension to ensure we do not
878 overflow the buffer.
879 */
880 if (len + strlen(CACHEDIR) + strlen(pyc_tag) + 5 > buflen)
881 return NULL;
Tim Petersc1731372001-08-04 08:12:36 +0000882
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000883 /* Find the last path separator and copy everything from the start of
884 the source string up to and including the separator.
885 */
886 if ((pos = rightmost_sep(pathname)) == NULL) {
887 i = 0;
888 }
889 else {
890 sep = *pos;
891 i = pos - pathname + 1;
892 strncpy(buf, pathname, i);
893 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000894
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000895 save = i;
896 buf[i++] = '\0';
897 /* Add __pycache__/ */
898 strcat(buf, CACHEDIR);
899 i += strlen(CACHEDIR) - 1;
900 buf[i++] = sep;
901 buf[i++] = '\0';
902 /* Add the base filename, but remove the .py or .pyw extension, since
903 the tag name must go before the extension.
904 */
905 strcat(buf, pathname + save);
906 if ((pos = strrchr(buf, '.')) != NULL)
907 *++pos = '\0';
908 strcat(buf, pyc_tag);
909 /* The length test above assumes that we're only adding one character
910 to the end of what would normally be the extension. What if there
911 is no extension, or the string ends in '.' or '.p', and otherwise
912 fills the buffer? By appending 4 more characters onto the string
913 here, we could overrun the buffer.
Barry Warsaw28a691b2010-04-17 00:19:56 +0000914
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000915 As a simple example, let's say buflen=32 and the input string is
916 'xxx.py'. strlen() would be 6 and the test above would yield:
Barry Warsaw28a691b2010-04-17 00:19:56 +0000917
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000918 (6 + 11 + 10 + 5 == 32) > 32
Barry Warsaw28a691b2010-04-17 00:19:56 +0000919
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000920 which is false and so the name mangling would continue. This would
921 be fine because we'd end up with this string in buf:
Barry Warsaw28a691b2010-04-17 00:19:56 +0000922
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000923 __pycache__/xxx.cpython-32.pyc\0
Barry Warsaw28a691b2010-04-17 00:19:56 +0000924
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000925 strlen(of that) == 30 + the nul fits inside a 32 character buffer.
926 We can even handle an input string of say 'xxxxx' above because
927 that's (5 + 11 + 10 + 5 == 31) > 32 which is also false. Name
928 mangling that yields:
Barry Warsaw28a691b2010-04-17 00:19:56 +0000929
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000930 __pycache__/xxxxxcpython-32.pyc\0
Barry Warsaw28a691b2010-04-17 00:19:56 +0000931
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000932 which is 32 characters including the nul, and thus fits in the
933 buffer. However, an input string of 'xxxxxx' would yield a result
934 string of:
Barry Warsaw28a691b2010-04-17 00:19:56 +0000935
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000936 __pycache__/xxxxxxcpython-32.pyc\0
Barry Warsaw28a691b2010-04-17 00:19:56 +0000937
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000938 which is 33 characters long (including the nul), thus overflowing
939 the buffer, even though the first test would fail, i.e.: the input
940 string is also 6 characters long, so 32 > 32 is false.
Barry Warsaw28a691b2010-04-17 00:19:56 +0000941
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000942 The reason the first test fails but we still overflow the buffer is
943 that the test above only expects to add one extra character to be
944 added to the extension, and here we're adding three (pyc). We
945 don't add the first dot, so that reclaims one of expected
946 positions, leaving us overflowing by 1 byte (3 extra - 1 reclaimed
947 dot - 1 expected extra == 1 overflowed).
Barry Warsaw28a691b2010-04-17 00:19:56 +0000948
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000949 The best we can do is ensure that we still have enough room in the
950 target buffer before we write the extension. Because it's always
951 only the extension that can cause the overflow, and never the other
952 path bytes we've written, it's sufficient to just do one more test
953 here. Still, the assertion that follows can't hurt.
954 */
Barry Warsaw28a691b2010-04-17 00:19:56 +0000955#if 0
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000956 printf("strlen(buf): %d; buflen: %d\n", (int)strlen(buf), (int)buflen);
Barry Warsaw28a691b2010-04-17 00:19:56 +0000957#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000958 if (strlen(buf) + 5 > buflen)
959 return NULL;
960 strcat(buf, debug ? ".pyc" : ".pyo");
961 assert(strlen(buf) < buflen);
962 return buf;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000963}
964
965
Barry Warsaw28a691b2010-04-17 00:19:56 +0000966/* Given a pathname to a Python byte compiled file, return the path to the
967 source file, if the path matches the PEP 3147 format. This does not check
968 for any file existence, however, if the pyc file name does not match PEP
969 3147 style, NULL is returned. buf must be at least as big as pathname;
970 the resulting path will always be shorter. */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000971
Barry Warsaw28a691b2010-04-17 00:19:56 +0000972static char *
973make_source_pathname(char *pathname, char *buf)
974{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000975 /* __pycache__/foo.<tag>.pyc -> foo.py */
976 size_t i, j;
977 char *left, *right, *dot0, *dot1, sep;
Barry Warsaw28a691b2010-04-17 00:19:56 +0000978
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000979 /* Look back two slashes from the end. In between these two slashes
980 must be the string __pycache__ or this is not a PEP 3147 style
981 path. It's possible for there to be only one slash.
982 */
983 if ((right = rightmost_sep(pathname)) == NULL)
984 return NULL;
985 sep = *right;
986 *right = '\0';
987 left = rightmost_sep(pathname);
988 *right = sep;
989 if (left == NULL)
990 left = pathname;
991 else
992 left++;
993 if (right-left != strlen(CACHEDIR) ||
994 strncmp(left, CACHEDIR, right-left) != 0)
995 return NULL;
Barry Warsaw28a691b2010-04-17 00:19:56 +0000996
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000997 /* Now verify that the path component to the right of the last slash
998 has two dots in it.
999 */
1000 if ((dot0 = strchr(right + 1, '.')) == NULL)
1001 return NULL;
1002 if ((dot1 = strchr(dot0 + 1, '.')) == NULL)
1003 return NULL;
1004 /* Too many dots? */
1005 if (strchr(dot1 + 1, '.') != NULL)
1006 return NULL;
Barry Warsaw28a691b2010-04-17 00:19:56 +00001007
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001008 /* This is a PEP 3147 path. Start by copying everything from the
1009 start of pathname up to and including the leftmost slash. Then
1010 copy the file's basename, removing the magic tag and adding a .py
1011 suffix.
1012 */
1013 strncpy(buf, pathname, (i=left-pathname));
1014 strncpy(buf+i, right+1, (j=dot0-right));
1015 strcpy(buf+i+j, "py");
1016 return buf;
Barry Warsaw28a691b2010-04-17 00:19:56 +00001017}
1018
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001019/* Given a pathname for a Python source file, its time of last
1020 modification, and a pathname for a compiled file, check whether the
1021 compiled file represents the same version of the source. If so,
1022 return a FILE pointer for the compiled file, positioned just after
1023 the header; if not, return NULL.
1024 Doesn't set an exception. */
1025
1026static FILE *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001027check_compiled_module(char *pathname, time_t mtime, char *cpathname)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001028{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001029 FILE *fp;
1030 long magic;
1031 long pyc_mtime;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001032
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001033 fp = fopen(cpathname, "rb");
1034 if (fp == NULL)
1035 return NULL;
1036 magic = PyMarshal_ReadLongFromFile(fp);
1037 if (magic != pyc_magic) {
1038 if (Py_VerboseFlag)
1039 PySys_WriteStderr("# %s has bad magic\n", cpathname);
1040 fclose(fp);
1041 return NULL;
1042 }
1043 pyc_mtime = PyMarshal_ReadLongFromFile(fp);
1044 if (pyc_mtime != mtime) {
1045 if (Py_VerboseFlag)
1046 PySys_WriteStderr("# %s has bad mtime\n", cpathname);
1047 fclose(fp);
1048 return NULL;
1049 }
1050 if (Py_VerboseFlag)
1051 PySys_WriteStderr("# %s matches %s\n", cpathname, pathname);
1052 return fp;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001053}
1054
1055
1056/* Read a code object from a file and check it for validity */
1057
Guido van Rossum79f25d91997-04-29 20:08:16 +00001058static PyCodeObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001059read_compiled_module(char *cpathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001060{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001061 PyObject *co;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001062
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001063 co = PyMarshal_ReadLastObjectFromFile(fp);
1064 if (co == NULL)
1065 return NULL;
1066 if (!PyCode_Check(co)) {
1067 PyErr_Format(PyExc_ImportError,
1068 "Non-code object in %.200s", cpathname);
1069 Py_DECREF(co);
1070 return NULL;
1071 }
1072 return (PyCodeObject *)co;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001073}
1074
1075
1076/* Load a module from a compiled file, execute it, and return its
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001077 module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001078
Guido van Rossum79f25d91997-04-29 20:08:16 +00001079static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001080load_compiled_module(char *name, char *cpathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001081{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001082 long magic;
1083 PyCodeObject *co;
1084 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001085
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001086 magic = PyMarshal_ReadLongFromFile(fp);
1087 if (magic != pyc_magic) {
1088 PyErr_Format(PyExc_ImportError,
1089 "Bad magic number in %.200s", cpathname);
1090 return NULL;
1091 }
1092 (void) PyMarshal_ReadLongFromFile(fp);
1093 co = read_compiled_module(cpathname, fp);
1094 if (co == NULL)
1095 return NULL;
1096 if (Py_VerboseFlag)
1097 PySys_WriteStderr("import %s # precompiled from %s\n",
1098 name, cpathname);
1099 m = PyImport_ExecCodeModuleWithPathnames(
1100 name, (PyObject *)co, cpathname, cpathname);
1101 Py_DECREF(co);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001102
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001103 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001104}
1105
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001106/* Parse a source file and return the corresponding code object */
1107
Guido van Rossum79f25d91997-04-29 20:08:16 +00001108static PyCodeObject *
Jeremy Hylton3e0055f2005-10-20 19:59:25 +00001109parse_source_module(const char *pathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001110{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001111 PyCodeObject *co = NULL;
1112 mod_ty mod;
1113 PyCompilerFlags flags;
1114 PyArena *arena = PyArena_New();
1115 if (arena == NULL)
1116 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001117
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001118 flags.cf_flags = 0;
1119 mod = PyParser_ASTFromFile(fp, pathname, NULL,
1120 Py_file_input, 0, 0, &flags,
1121 NULL, arena);
1122 if (mod) {
1123 co = PyAST_Compile(mod, pathname, NULL, arena);
1124 }
1125 PyArena_Free(arena);
1126 return co;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001127}
1128
1129
Guido van Rossum55a83382000-09-20 20:31:38 +00001130/* Helper to open a bytecode file for writing in exclusive mode */
1131
1132static FILE *
Christian Heimes05e8be12008-02-23 18:30:17 +00001133open_exclusive(char *filename, mode_t mode)
Guido van Rossum55a83382000-09-20 20:31:38 +00001134{
1135#if defined(O_EXCL)&&defined(O_CREAT)&&defined(O_WRONLY)&&defined(O_TRUNC)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001136 /* Use O_EXCL to avoid a race condition when another process tries to
1137 write the same file. When that happens, our open() call fails,
1138 which is just fine (since it's only a cache).
1139 XXX If the file exists and is writable but the directory is not
1140 writable, the file will never be written. Oh well.
1141 */
1142 int fd;
1143 (void) unlink(filename);
1144 fd = open(filename, O_EXCL|O_CREAT|O_WRONLY|O_TRUNC
Tim Peters42c83af2000-09-29 04:03:10 +00001145#ifdef O_BINARY
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001146 |O_BINARY /* necessary for Windows */
Tim Peters42c83af2000-09-29 04:03:10 +00001147#endif
Martin v. Löwis79acb9e2002-12-06 12:48:53 +00001148#ifdef __VMS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001149 , mode, "ctxt=bin", "shr=nil"
Martin v. Löwis79acb9e2002-12-06 12:48:53 +00001150#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001151 , mode
Martin v. Löwis79acb9e2002-12-06 12:48:53 +00001152#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001153 );
1154 if (fd < 0)
1155 return NULL;
1156 return fdopen(fd, "wb");
Guido van Rossum55a83382000-09-20 20:31:38 +00001157#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001158 /* Best we can do -- on Windows this can't happen anyway */
1159 return fopen(filename, "wb");
Guido van Rossum55a83382000-09-20 20:31:38 +00001160#endif
1161}
1162
1163
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001164/* Write a compiled module to a file, placing the time of last
1165 modification of its source into the header.
1166 Errors are ignored, if a write error occurs an attempt is made to
1167 remove the file. */
1168
1169static void
Christian Heimes05e8be12008-02-23 18:30:17 +00001170write_compiled_module(PyCodeObject *co, char *cpathname, struct stat *srcstat)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001171{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001172 FILE *fp;
1173 char *dirpath;
1174 time_t mtime = srcstat->st_mtime;
Alexandre Vassalotti9d58e3e2009-07-17 10:55:50 +00001175#ifdef MS_WINDOWS /* since Windows uses different permissions */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001176 mode_t mode = srcstat->st_mode & ~S_IEXEC;
Alexandre Vassalotti9d58e3e2009-07-17 10:55:50 +00001177#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001178 mode_t mode = srcstat->st_mode & ~S_IXUSR & ~S_IXGRP & ~S_IXOTH;
1179 mode_t dirmode = (srcstat->st_mode |
1180 S_IXUSR | S_IXGRP | S_IXOTH |
1181 S_IWUSR | S_IWGRP | S_IWOTH);
Brett Cannon9a5b25a2010-03-01 02:09:17 +00001182#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001183 int saved;
Barry Warsaw28a691b2010-04-17 00:19:56 +00001184
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001185 /* Ensure that the __pycache__ directory exists. */
1186 dirpath = rightmost_sep(cpathname);
1187 if (dirpath == NULL) {
1188 if (Py_VerboseFlag)
1189 PySys_WriteStderr(
1190 "# no %s path found %s\n",
1191 CACHEDIR, cpathname);
1192 return;
1193 }
1194 saved = *dirpath;
1195 *dirpath = '\0';
Daniel Stutzbachc7937792010-09-09 21:18:04 +00001196
1197#ifdef MS_WINDOWS
1198 if (_mkdir(cpathname) < 0 && errno != EEXIST) {
1199#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001200 if (mkdir(cpathname, dirmode) < 0 && errno != EEXIST) {
Daniel Stutzbachc7937792010-09-09 21:18:04 +00001201#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001202 *dirpath = saved;
1203 if (Py_VerboseFlag)
1204 PySys_WriteStderr(
1205 "# cannot create cache dir %s\n", cpathname);
1206 return;
1207 }
1208 *dirpath = saved;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001209
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001210 fp = open_exclusive(cpathname, mode);
1211 if (fp == NULL) {
1212 if (Py_VerboseFlag)
1213 PySys_WriteStderr(
1214 "# can't create %s\n", cpathname);
1215 return;
1216 }
1217 PyMarshal_WriteLongToFile(pyc_magic, fp, Py_MARSHAL_VERSION);
1218 /* First write a 0 for mtime */
1219 PyMarshal_WriteLongToFile(0L, fp, Py_MARSHAL_VERSION);
1220 PyMarshal_WriteObjectToFile((PyObject *)co, fp, Py_MARSHAL_VERSION);
1221 if (fflush(fp) != 0 || ferror(fp)) {
1222 if (Py_VerboseFlag)
1223 PySys_WriteStderr("# can't write %s\n", cpathname);
1224 /* Don't keep partial file */
1225 fclose(fp);
1226 (void) unlink(cpathname);
1227 return;
1228 }
Antoine Pitrou33d15f72012-01-25 18:01:45 +01001229 /* Now write the true mtime (as a 32-bit field) */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001230 fseek(fp, 4L, 0);
Antoine Pitrou33d15f72012-01-25 18:01:45 +01001231 assert(mtime <= 0xFFFFFFFF);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001232 PyMarshal_WriteLongToFile((long)mtime, fp, Py_MARSHAL_VERSION);
1233 fflush(fp);
1234 fclose(fp);
1235 if (Py_VerboseFlag)
1236 PySys_WriteStderr("# wrote %s\n", cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001237}
1238
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001239static void
1240update_code_filenames(PyCodeObject *co, PyObject *oldname, PyObject *newname)
1241{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001242 PyObject *constants, *tmp;
1243 Py_ssize_t i, n;
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001244
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001245 if (PyUnicode_Compare(co->co_filename, oldname))
1246 return;
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001247
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001248 tmp = co->co_filename;
1249 co->co_filename = newname;
1250 Py_INCREF(co->co_filename);
1251 Py_DECREF(tmp);
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001252
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001253 constants = co->co_consts;
1254 n = PyTuple_GET_SIZE(constants);
1255 for (i = 0; i < n; i++) {
1256 tmp = PyTuple_GET_ITEM(constants, i);
1257 if (PyCode_Check(tmp))
1258 update_code_filenames((PyCodeObject *)tmp,
1259 oldname, newname);
1260 }
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001261}
1262
1263static int
1264update_compiled_module(PyCodeObject *co, char *pathname)
1265{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001266 PyObject *oldname, *newname;
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001267
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001268 newname = PyUnicode_DecodeFSDefault(pathname);
1269 if (newname == NULL)
1270 return -1;
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001271
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001272 if (!PyUnicode_Compare(co->co_filename, newname)) {
1273 Py_DECREF(newname);
1274 return 0;
1275 }
Hirokazu Yamamoto4f447fb2009-03-04 01:52:10 +00001276
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001277 oldname = co->co_filename;
1278 Py_INCREF(oldname);
1279 update_code_filenames(co, oldname, newname);
1280 Py_DECREF(oldname);
1281 Py_DECREF(newname);
1282 return 1;
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001283}
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001284
1285/* Load a source module from a given file and return its module
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001286 object WITH INCREMENTED REFERENCE COUNT. If there's a matching
1287 byte-compiled file, use that instead. */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001288
Guido van Rossum79f25d91997-04-29 20:08:16 +00001289static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001290load_source_module(char *name, char *pathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001291{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001292 struct stat st;
1293 FILE *fpc;
1294 char buf[MAXPATHLEN+1];
1295 char *cpathname;
1296 PyCodeObject *co;
1297 PyObject *m;
Brett Cannon9a5b25a2010-03-01 02:09:17 +00001298
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001299 if (fstat(fileno(fp), &st) != 0) {
1300 PyErr_Format(PyExc_RuntimeError,
1301 "unable to get file status from '%s'",
1302 pathname);
1303 return NULL;
1304 }
Antoine Pitrou33d15f72012-01-25 18:01:45 +01001305 if (sizeof st.st_mtime > 4) {
1306 /* Python's .pyc timestamp handling presumes that the timestamp fits
1307 in 4 bytes. Since the code only does an equality comparison,
1308 ordering is not important and we can safely ignore the higher bits
1309 (collisions are extremely unlikely).
1310 */
1311 st.st_mtime &= 0xFFFFFFFF;
1312 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001313 cpathname = make_compiled_pathname(
1314 pathname, buf, (size_t)MAXPATHLEN + 1, !Py_OptimizeFlag);
1315 if (cpathname != NULL &&
1316 (fpc = check_compiled_module(pathname, st.st_mtime, cpathname))) {
1317 co = read_compiled_module(cpathname, fpc);
1318 fclose(fpc);
1319 if (co == NULL)
1320 return NULL;
1321 if (update_compiled_module(co, pathname) < 0)
1322 return NULL;
1323 if (Py_VerboseFlag)
1324 PySys_WriteStderr("import %s # precompiled from %s\n",
1325 name, cpathname);
1326 pathname = cpathname;
1327 }
1328 else {
1329 co = parse_source_module(pathname, fp);
1330 if (co == NULL)
1331 return NULL;
1332 if (Py_VerboseFlag)
1333 PySys_WriteStderr("import %s # from %s\n",
1334 name, pathname);
1335 if (cpathname) {
1336 PyObject *ro = PySys_GetObject("dont_write_bytecode");
1337 if (ro == NULL || !PyObject_IsTrue(ro))
1338 write_compiled_module(co, cpathname, &st);
1339 }
1340 }
1341 m = PyImport_ExecCodeModuleWithPathnames(
1342 name, (PyObject *)co, pathname, cpathname);
1343 Py_DECREF(co);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001344
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001345 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001346}
1347
Christian Heimes3b06e532008-01-07 20:12:44 +00001348/* Get source file -> unicode or None
1349 * Returns the path to the py file if available, else the given path
1350 */
1351static PyObject *
Barry Warsaw28a691b2010-04-17 00:19:56 +00001352get_sourcefile(char *file)
Christian Heimes3b06e532008-01-07 20:12:44 +00001353{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001354 char py[MAXPATHLEN + 1];
1355 Py_ssize_t len;
1356 PyObject *u;
1357 struct stat statbuf;
Christian Heimes3b06e532008-01-07 20:12:44 +00001358
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001359 if (!file || !*file) {
1360 Py_RETURN_NONE;
1361 }
Christian Heimes3b06e532008-01-07 20:12:44 +00001362
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001363 len = strlen(file);
1364 /* match '*.py?' */
1365 if (len > MAXPATHLEN || PyOS_strnicmp(&file[len-4], ".py", 3) != 0) {
1366 return PyUnicode_DecodeFSDefault(file);
1367 }
Christian Heimes3b06e532008-01-07 20:12:44 +00001368
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001369 /* Start by trying to turn PEP 3147 path into source path. If that
1370 * fails, just chop off the trailing character, i.e. legacy pyc path
1371 * to py.
1372 */
1373 if (make_source_pathname(file, py) == NULL) {
1374 strncpy(py, file, len-1);
1375 py[len-1] = '\0';
1376 }
Barry Warsaw28a691b2010-04-17 00:19:56 +00001377
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001378 if (stat(py, &statbuf) == 0 &&
1379 S_ISREG(statbuf.st_mode)) {
1380 u = PyUnicode_DecodeFSDefault(py);
1381 }
1382 else {
1383 u = PyUnicode_DecodeFSDefault(file);
1384 }
1385 return u;
Christian Heimes3b06e532008-01-07 20:12:44 +00001386}
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001387
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001388/* Forward */
Just van Rossum52e14d62002-12-30 22:08:05 +00001389static PyObject *load_module(char *, FILE *, char *, int, PyObject *);
1390static struct filedescr *find_module(char *, char *, PyObject *,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001391 char *, size_t, FILE **, PyObject **);
Christian Heimes3b06e532008-01-07 20:12:44 +00001392static struct _frozen * find_frozen(char *);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001393
1394/* Load a package and return its module object WITH INCREMENTED
1395 REFERENCE COUNT */
1396
1397static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001398load_package(char *name, char *pathname)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001399{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001400 PyObject *m, *d;
1401 PyObject *file = NULL;
1402 PyObject *path = NULL;
1403 int err;
1404 char buf[MAXPATHLEN+1];
1405 FILE *fp = NULL;
1406 struct filedescr *fdp;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001407
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001408 m = PyImport_AddModule(name);
1409 if (m == NULL)
1410 return NULL;
1411 if (Py_VerboseFlag)
1412 PySys_WriteStderr("import %s # directory %s\n",
1413 name, pathname);
1414 d = PyModule_GetDict(m);
1415 file = get_sourcefile(pathname);
1416 if (file == NULL)
1417 goto error;
1418 path = Py_BuildValue("[O]", file);
1419 if (path == NULL)
1420 goto error;
1421 err = PyDict_SetItemString(d, "__file__", file);
1422 if (err == 0)
1423 err = PyDict_SetItemString(d, "__path__", path);
1424 if (err != 0)
1425 goto error;
1426 buf[0] = '\0';
1427 fdp = find_module(name, "__init__", path, buf, sizeof(buf), &fp, NULL);
1428 if (fdp == NULL) {
1429 if (PyErr_ExceptionMatches(PyExc_ImportError)) {
1430 PyErr_Clear();
1431 Py_INCREF(m);
1432 }
1433 else
1434 m = NULL;
1435 goto cleanup;
1436 }
1437 m = load_module(name, fp, buf, fdp->type, NULL);
1438 if (fp != NULL)
1439 fclose(fp);
1440 goto cleanup;
Tim Peters1cd70172004-08-02 03:52:12 +00001441
1442 error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001443 m = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001444 cleanup:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001445 Py_XDECREF(path);
1446 Py_XDECREF(file);
1447 return m;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001448}
1449
1450
1451/* Helper to test for built-in module */
1452
1453static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001454is_builtin(char *name)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001455{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001456 int i;
1457 for (i = 0; PyImport_Inittab[i].name != NULL; i++) {
1458 if (strcmp(name, PyImport_Inittab[i].name) == 0) {
1459 if (PyImport_Inittab[i].initfunc == NULL)
1460 return -1;
1461 else
1462 return 1;
1463 }
1464 }
1465 return 0;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001466}
1467
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001468
Just van Rossum52e14d62002-12-30 22:08:05 +00001469/* Return an importer object for a sys.path/pkg.__path__ item 'p',
1470 possibly by fetching it from the path_importer_cache dict. If it
Thomas Wouters89f507f2006-12-13 04:49:30 +00001471 wasn't yet cached, traverse path_hooks until a hook is found
Just van Rossum52e14d62002-12-30 22:08:05 +00001472 that can handle the path item. Return None if no hook could;
1473 this tells our caller it should fall back to the builtin
1474 import mechanism. Cache the result in path_importer_cache.
1475 Returns a borrowed reference. */
1476
1477static PyObject *
1478get_path_importer(PyObject *path_importer_cache, PyObject *path_hooks,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001479 PyObject *p)
Just van Rossum52e14d62002-12-30 22:08:05 +00001480{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001481 PyObject *importer;
1482 Py_ssize_t j, nhooks;
Just van Rossum52e14d62002-12-30 22:08:05 +00001483
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001484 /* These conditions are the caller's responsibility: */
1485 assert(PyList_Check(path_hooks));
1486 assert(PyDict_Check(path_importer_cache));
Just van Rossum52e14d62002-12-30 22:08:05 +00001487
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001488 nhooks = PyList_Size(path_hooks);
1489 if (nhooks < 0)
1490 return NULL; /* Shouldn't happen */
Just van Rossum52e14d62002-12-30 22:08:05 +00001491
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001492 importer = PyDict_GetItem(path_importer_cache, p);
1493 if (importer != NULL)
1494 return importer;
Just van Rossum52e14d62002-12-30 22:08:05 +00001495
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001496 /* set path_importer_cache[p] to None to avoid recursion */
1497 if (PyDict_SetItem(path_importer_cache, p, Py_None) != 0)
1498 return NULL;
Just van Rossum52e14d62002-12-30 22:08:05 +00001499
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001500 for (j = 0; j < nhooks; j++) {
1501 PyObject *hook = PyList_GetItem(path_hooks, j);
1502 if (hook == NULL)
1503 return NULL;
1504 importer = PyObject_CallFunctionObjArgs(hook, p, NULL);
1505 if (importer != NULL)
1506 break;
Just van Rossum52e14d62002-12-30 22:08:05 +00001507
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001508 if (!PyErr_ExceptionMatches(PyExc_ImportError)) {
1509 return NULL;
1510 }
1511 PyErr_Clear();
1512 }
1513 if (importer == NULL) {
1514 importer = PyObject_CallFunctionObjArgs(
1515 (PyObject *)&PyNullImporter_Type, p, NULL
1516 );
1517 if (importer == NULL) {
1518 if (PyErr_ExceptionMatches(PyExc_ImportError)) {
1519 PyErr_Clear();
1520 return Py_None;
1521 }
1522 }
1523 }
1524 if (importer != NULL) {
1525 int err = PyDict_SetItem(path_importer_cache, p, importer);
1526 Py_DECREF(importer);
1527 if (err != 0)
1528 return NULL;
1529 }
1530 return importer;
Just van Rossum52e14d62002-12-30 22:08:05 +00001531}
1532
Christian Heimes9cd17752007-11-18 19:35:23 +00001533PyAPI_FUNC(PyObject *)
1534PyImport_GetImporter(PyObject *path) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001535 PyObject *importer=NULL, *path_importer_cache=NULL, *path_hooks=NULL;
Christian Heimes9cd17752007-11-18 19:35:23 +00001536
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001537 if ((path_importer_cache = PySys_GetObject("path_importer_cache"))) {
1538 if ((path_hooks = PySys_GetObject("path_hooks"))) {
1539 importer = get_path_importer(path_importer_cache,
1540 path_hooks, path);
1541 }
1542 }
1543 Py_XINCREF(importer); /* get_path_importer returns a borrowed reference */
1544 return importer;
Christian Heimes9cd17752007-11-18 19:35:23 +00001545}
1546
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001547/* Search the path (default sys.path) for a module. Return the
1548 corresponding filedescr struct, and (via return arguments) the
1549 pathname and an open file. Return NULL if the module is not found. */
1550
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001551#ifdef MS_COREDLL
Thomas Woutersb4bd21c2000-07-22 23:38:01 +00001552extern FILE *PyWin_FindRegisteredModule(const char *, struct filedescr **,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001553 char *, Py_ssize_t);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001554#endif
1555
Martin v. Löwis18e16552006-02-15 17:27:45 +00001556static int case_ok(char *, Py_ssize_t, Py_ssize_t, char *);
Tim Petersdbd9ba62000-07-09 03:09:57 +00001557static int find_init_module(char *); /* Forward */
Just van Rossum52e14d62002-12-30 22:08:05 +00001558static struct filedescr importhookdescr = {"", "", IMP_HOOK};
Guido van Rossum197346f1997-10-31 18:38:52 +00001559
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001560static struct filedescr *
Just van Rossum52e14d62002-12-30 22:08:05 +00001561find_module(char *fullname, char *subname, PyObject *path, char *buf,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001562 size_t buflen, FILE **p_fp, PyObject **p_loader)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001563{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001564 Py_ssize_t i, npath;
1565 size_t len, namelen;
1566 struct filedescr *fdp = NULL;
1567 char *filemode;
1568 FILE *fp = NULL;
1569 PyObject *path_hooks, *path_importer_cache;
1570 struct stat statbuf;
1571 static struct filedescr fd_frozen = {"", "", PY_FROZEN};
1572 static struct filedescr fd_builtin = {"", "", C_BUILTIN};
1573 static struct filedescr fd_package = {"", "", PKG_DIRECTORY};
1574 char name[MAXPATHLEN+1];
Andrew MacIntyred9400542002-02-26 11:41:34 +00001575#if defined(PYOS_OS2)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001576 size_t saved_len;
1577 size_t saved_namelen;
1578 char *saved_buf = NULL;
Andrew MacIntyred9400542002-02-26 11:41:34 +00001579#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001580 if (p_loader != NULL)
1581 *p_loader = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001582
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001583 if (strlen(subname) > MAXPATHLEN) {
1584 PyErr_SetString(PyExc_OverflowError,
1585 "module name is too long");
1586 return NULL;
1587 }
1588 strcpy(name, subname);
Just van Rossum52e14d62002-12-30 22:08:05 +00001589
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001590 /* sys.meta_path import hook */
1591 if (p_loader != NULL) {
1592 PyObject *meta_path;
Just van Rossum52e14d62002-12-30 22:08:05 +00001593
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001594 meta_path = PySys_GetObject("meta_path");
1595 if (meta_path == NULL || !PyList_Check(meta_path)) {
Victor Stinner16191322011-09-15 19:28:05 +02001596 PyErr_SetString(PyExc_RuntimeError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001597 "sys.meta_path must be a list of "
1598 "import hooks");
1599 return NULL;
1600 }
1601 Py_INCREF(meta_path); /* zap guard */
1602 npath = PyList_Size(meta_path);
1603 for (i = 0; i < npath; i++) {
1604 PyObject *loader;
1605 PyObject *hook = PyList_GetItem(meta_path, i);
1606 loader = PyObject_CallMethod(hook, "find_module",
1607 "sO", fullname,
1608 path != NULL ?
1609 path : Py_None);
1610 if (loader == NULL) {
1611 Py_DECREF(meta_path);
1612 return NULL; /* true error */
1613 }
1614 if (loader != Py_None) {
1615 /* a loader was found */
1616 *p_loader = loader;
1617 Py_DECREF(meta_path);
1618 return &importhookdescr;
1619 }
1620 Py_DECREF(loader);
1621 }
1622 Py_DECREF(meta_path);
1623 }
Guido van Rossum0506a431998-08-11 15:07:39 +00001624
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001625 if (find_frozen(fullname) != NULL) {
1626 strcpy(buf, fullname);
1627 return &fd_frozen;
1628 }
Benjamin Petersond968e272008-11-05 22:48:33 +00001629
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001630 if (path == NULL) {
1631 if (is_builtin(name)) {
1632 strcpy(buf, name);
1633 return &fd_builtin;
1634 }
Guido van Rossumac279101996-08-22 23:10:58 +00001635#ifdef MS_COREDLL
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001636 fp = PyWin_FindRegisteredModule(name, &fdp, buf, buflen);
1637 if (fp != NULL) {
1638 *p_fp = fp;
1639 return fdp;
1640 }
Guido van Rossuma5a3db71996-04-09 02:39:59 +00001641#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001642 path = PySys_GetObject("path");
1643 }
Benjamin Petersond968e272008-11-05 22:48:33 +00001644
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001645 if (path == NULL || !PyList_Check(path)) {
Victor Stinner16191322011-09-15 19:28:05 +02001646 PyErr_SetString(PyExc_RuntimeError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001647 "sys.path must be a list of directory names");
1648 return NULL;
1649 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001650
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001651 path_hooks = PySys_GetObject("path_hooks");
1652 if (path_hooks == NULL || !PyList_Check(path_hooks)) {
Victor Stinner16191322011-09-15 19:28:05 +02001653 PyErr_SetString(PyExc_RuntimeError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001654 "sys.path_hooks must be a list of "
1655 "import hooks");
1656 return NULL;
1657 }
1658 path_importer_cache = PySys_GetObject("path_importer_cache");
1659 if (path_importer_cache == NULL ||
1660 !PyDict_Check(path_importer_cache)) {
Victor Stinner16191322011-09-15 19:28:05 +02001661 PyErr_SetString(PyExc_RuntimeError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001662 "sys.path_importer_cache must be a dict");
1663 return NULL;
1664 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001665
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001666 npath = PyList_Size(path);
1667 namelen = strlen(name);
1668 for (i = 0; i < npath; i++) {
1669 PyObject *v = PyList_GetItem(path, i);
1670 PyObject *origv = v;
1671 const char *base;
1672 Py_ssize_t size;
1673 if (!v)
1674 return NULL;
1675 if (PyUnicode_Check(v)) {
Victor Stinnerae6265f2010-05-15 16:27:27 +00001676 v = PyUnicode_EncodeFSDefault(v);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001677 if (v == NULL)
1678 return NULL;
1679 }
1680 else if (!PyBytes_Check(v))
1681 continue;
1682 else
1683 Py_INCREF(v);
Amaury Forgeot d'Arcf1ca0b12008-06-11 17:40:47 +00001684
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001685 base = PyBytes_AS_STRING(v);
1686 size = PyBytes_GET_SIZE(v);
1687 len = size;
1688 if (len + 2 + namelen + MAXSUFFIXSIZE >= buflen) {
1689 Py_DECREF(v);
1690 continue; /* Too long */
1691 }
1692 strcpy(buf, base);
1693 Py_DECREF(v);
Amaury Forgeot d'Arcf1ca0b12008-06-11 17:40:47 +00001694
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001695 if (strlen(buf) != len) {
1696 continue; /* v contains '\0' */
1697 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001698
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001699 /* sys.path_hooks import hook */
1700 if (p_loader != NULL) {
1701 PyObject *importer;
Just van Rossum52e14d62002-12-30 22:08:05 +00001702
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001703 importer = get_path_importer(path_importer_cache,
1704 path_hooks, origv);
1705 if (importer == NULL) {
1706 return NULL;
1707 }
1708 /* Note: importer is a borrowed reference */
1709 if (importer != Py_None) {
1710 PyObject *loader;
1711 loader = PyObject_CallMethod(importer,
1712 "find_module",
1713 "s", fullname);
1714 if (loader == NULL)
1715 return NULL; /* error */
1716 if (loader != Py_None) {
1717 /* a loader was found */
1718 *p_loader = loader;
1719 return &importhookdescr;
1720 }
1721 Py_DECREF(loader);
1722 continue;
1723 }
1724 }
1725 /* no hook was found, use builtin import */
Just van Rossum52e14d62002-12-30 22:08:05 +00001726
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001727 if (len > 0 && buf[len-1] != SEP
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001728#ifdef ALTSEP
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001729 && buf[len-1] != ALTSEP
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001730#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001731 )
1732 buf[len++] = SEP;
1733 strcpy(buf+len, name);
1734 len += namelen;
Tim Peters50d8d372001-02-28 05:34:27 +00001735
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001736 /* Check for package import (buf holds a directory name,
1737 and there's an __init__ module in that directory */
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001738#ifdef HAVE_STAT
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001739 if (stat(buf, &statbuf) == 0 && /* it exists */
1740 S_ISDIR(statbuf.st_mode) && /* it's a directory */
1741 case_ok(buf, len, namelen, name)) { /* case matches */
1742 if (find_init_module(buf)) { /* and has __init__.py */
1743 return &fd_package;
1744 }
1745 else {
Victor Stinnered7916d2010-10-17 02:07:09 +00001746 int err;
1747 PyObject *unicode = PyUnicode_DecodeFSDefault(buf);
1748 if (unicode == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001749 return NULL;
Victor Stinnered7916d2010-10-17 02:07:09 +00001750 err = PyErr_WarnFormat(PyExc_ImportWarning, 1,
1751 "Not importing directory '%U': missing __init__.py",
1752 unicode);
1753 Py_DECREF(unicode);
1754 if (err)
1755 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001756 }
1757 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001758#endif
Andrew MacIntyred9400542002-02-26 11:41:34 +00001759#if defined(PYOS_OS2)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001760 /* take a snapshot of the module spec for restoration
1761 * after the 8 character DLL hackery
1762 */
1763 saved_buf = strdup(buf);
1764 saved_len = len;
1765 saved_namelen = namelen;
Andrew MacIntyred9400542002-02-26 11:41:34 +00001766#endif /* PYOS_OS2 */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001767 for (fdp = _PyImport_Filetab; fdp->suffix != NULL; fdp++) {
Victor Stinner53ffdc52011-09-23 18:54:40 +02001768 struct stat statbuf;
Guido van Rossum04110fb2007-08-24 16:32:05 +00001769#if defined(PYOS_OS2) && defined(HAVE_DYNAMIC_LOADING)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001770 /* OS/2 limits DLLs to 8 character names (w/o
1771 extension)
1772 * so if the name is longer than that and its a
1773 * dynamically loaded module we're going to try,
1774 * truncate the name before trying
1775 */
1776 if (strlen(subname) > 8) {
1777 /* is this an attempt to load a C extension? */
1778 const struct filedescr *scan;
1779 scan = _PyImport_DynLoadFiletab;
1780 while (scan->suffix != NULL) {
1781 if (!strcmp(scan->suffix, fdp->suffix))
1782 break;
1783 else
1784 scan++;
1785 }
1786 if (scan->suffix != NULL) {
1787 /* yes, so truncate the name */
1788 namelen = 8;
1789 len -= strlen(subname) - namelen;
1790 buf[len] = '\0';
1791 }
1792 }
Andrew MacIntyred9400542002-02-26 11:41:34 +00001793#endif /* PYOS_OS2 */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001794 strcpy(buf+len, fdp->suffix);
1795 if (Py_VerboseFlag > 1)
1796 PySys_WriteStderr("# trying %s\n", buf);
Victor Stinner53ffdc52011-09-23 18:54:40 +02001797
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001798 filemode = fdp->mode;
1799 if (filemode[0] == 'U')
1800 filemode = "r" PY_STDIOTEXTMODE;
Victor Stinner53ffdc52011-09-23 18:54:40 +02001801
1802 if (stat(buf, &statbuf) == 0 && S_ISDIR(statbuf.st_mode))
1803 /* it's a directory */
1804 fp = NULL;
1805 else
1806 fp = fopen(buf, filemode);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001807 if (fp != NULL) {
1808 if (case_ok(buf, len, namelen, name))
1809 break;
1810 else { /* continue search */
1811 fclose(fp);
1812 fp = NULL;
1813 }
1814 }
Andrew MacIntyred9400542002-02-26 11:41:34 +00001815#if defined(PYOS_OS2)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001816 /* restore the saved snapshot */
1817 strcpy(buf, saved_buf);
1818 len = saved_len;
1819 namelen = saved_namelen;
Andrew MacIntyred9400542002-02-26 11:41:34 +00001820#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001821 }
Andrew MacIntyred9400542002-02-26 11:41:34 +00001822#if defined(PYOS_OS2)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001823 /* don't need/want the module name snapshot anymore */
1824 if (saved_buf)
1825 {
1826 free(saved_buf);
1827 saved_buf = NULL;
1828 }
Andrew MacIntyred9400542002-02-26 11:41:34 +00001829#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001830 if (fp != NULL)
1831 break;
1832 }
1833 if (fp == NULL) {
1834 PyErr_Format(PyExc_ImportError,
1835 "No module named %.200s", name);
1836 return NULL;
1837 }
1838 *p_fp = fp;
1839 return fdp;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001840}
1841
Martin v. Löwis18e16552006-02-15 17:27:45 +00001842/* case_ok(char* buf, Py_ssize_t len, Py_ssize_t namelen, char* name)
Tim Petersd1e87a82001-03-01 18:12:00 +00001843 * The arguments here are tricky, best shown by example:
1844 * /a/b/c/d/e/f/g/h/i/j/k/some_long_module_name.py\0
1845 * ^ ^ ^ ^
1846 * |--------------------- buf ---------------------|
1847 * |------------------- len ------------------|
1848 * |------ name -------|
1849 * |----- namelen -----|
1850 * buf is the full path, but len only counts up to (& exclusive of) the
1851 * extension. name is the module name, also exclusive of extension.
1852 *
1853 * We've already done a successful stat() or fopen() on buf, so know that
1854 * there's some match, possibly case-insensitive.
1855 *
Tim Peters50d8d372001-02-28 05:34:27 +00001856 * case_ok() is to return 1 if there's a case-sensitive match for
1857 * name, else 0. case_ok() is also to return 1 if envar PYTHONCASEOK
1858 * exists.
Tim Petersd1e87a82001-03-01 18:12:00 +00001859 *
Tim Peters50d8d372001-02-28 05:34:27 +00001860 * case_ok() is used to implement case-sensitive import semantics even
1861 * on platforms with case-insensitive filesystems. It's trivial to implement
1862 * for case-sensitive filesystems. It's pretty much a cross-platform
1863 * nightmare for systems with case-insensitive filesystems.
1864 */
Guido van Rossum0980bd91998-02-13 17:18:36 +00001865
Tim Peters50d8d372001-02-28 05:34:27 +00001866/* First we may need a pile of platform-specific header files; the sequence
1867 * of #if's here should match the sequence in the body of case_ok().
1868 */
Jason Tishler7961aa62005-05-20 00:56:54 +00001869#if defined(MS_WINDOWS)
Guido van Rossum0980bd91998-02-13 17:18:36 +00001870#include <windows.h>
Guido van Rossum4c3f57c2001-01-10 20:40:46 +00001871
Tim Peters50d8d372001-02-28 05:34:27 +00001872#elif defined(DJGPP)
1873#include <dir.h>
1874
Jason Tishler7961aa62005-05-20 00:56:54 +00001875#elif (defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) && defined(HAVE_DIRENT_H)
Tim Peters430f5d42001-03-01 01:30:56 +00001876#include <sys/types.h>
1877#include <dirent.h>
1878
Andrew MacIntyred9400542002-02-26 11:41:34 +00001879#elif defined(PYOS_OS2)
1880#define INCL_DOS
1881#define INCL_DOSERRORS
1882#define INCL_NOPMAPI
1883#include <os2.h>
Tim Peters50d8d372001-02-28 05:34:27 +00001884#endif
1885
Guido van Rossum0980bd91998-02-13 17:18:36 +00001886static int
Martin v. Löwis18e16552006-02-15 17:27:45 +00001887case_ok(char *buf, Py_ssize_t len, Py_ssize_t namelen, char *name)
Guido van Rossum0980bd91998-02-13 17:18:36 +00001888{
Tim Peters50d8d372001-02-28 05:34:27 +00001889/* Pick a platform-specific implementation; the sequence of #if's here should
1890 * match the sequence just above.
1891 */
1892
Jason Tishler7961aa62005-05-20 00:56:54 +00001893/* MS_WINDOWS */
1894#if defined(MS_WINDOWS)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001895 WIN32_FIND_DATA data;
1896 HANDLE h;
Tim Peters50d8d372001-02-28 05:34:27 +00001897
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001898 if (Py_GETENV("PYTHONCASEOK") != NULL)
1899 return 1;
Tim Peters50d8d372001-02-28 05:34:27 +00001900
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001901 h = FindFirstFile(buf, &data);
1902 if (h == INVALID_HANDLE_VALUE) {
1903 PyErr_Format(PyExc_NameError,
1904 "Can't find file for module %.100s\n(filename %.300s)",
1905 name, buf);
1906 return 0;
1907 }
1908 FindClose(h);
1909 return strncmp(data.cFileName, name, namelen) == 0;
Tim Peters50d8d372001-02-28 05:34:27 +00001910
1911/* DJGPP */
1912#elif defined(DJGPP)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001913 struct ffblk ffblk;
1914 int done;
Tim Peters50d8d372001-02-28 05:34:27 +00001915
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001916 if (Py_GETENV("PYTHONCASEOK") != NULL)
1917 return 1;
Tim Peters50d8d372001-02-28 05:34:27 +00001918
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001919 done = findfirst(buf, &ffblk, FA_ARCH|FA_RDONLY|FA_HIDDEN|FA_DIREC);
1920 if (done) {
1921 PyErr_Format(PyExc_NameError,
1922 "Can't find file for module %.100s\n(filename %.300s)",
1923 name, buf);
1924 return 0;
1925 }
1926 return strncmp(ffblk.ff_name, name, namelen) == 0;
Guido van Rossum0980bd91998-02-13 17:18:36 +00001927
Jason Tishler7961aa62005-05-20 00:56:54 +00001928/* new-fangled macintosh (macosx) or Cygwin */
1929#elif (defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) && defined(HAVE_DIRENT_H)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001930 DIR *dirp;
1931 struct dirent *dp;
1932 char dirname[MAXPATHLEN + 1];
1933 const int dirlen = len - namelen - 1; /* don't want trailing SEP */
Tim Peters430f5d42001-03-01 01:30:56 +00001934
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001935 if (Py_GETENV("PYTHONCASEOK") != NULL)
1936 return 1;
Tim Petersdbe6ebb2001-03-01 08:47:29 +00001937
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001938 /* Copy the dir component into dirname; substitute "." if empty */
1939 if (dirlen <= 0) {
1940 dirname[0] = '.';
1941 dirname[1] = '\0';
1942 }
1943 else {
1944 assert(dirlen <= MAXPATHLEN);
1945 memcpy(dirname, buf, dirlen);
1946 dirname[dirlen] = '\0';
1947 }
1948 /* Open the directory and search the entries for an exact match. */
1949 dirp = opendir(dirname);
1950 if (dirp) {
1951 char *nameWithExt = buf + len - namelen;
1952 while ((dp = readdir(dirp)) != NULL) {
1953 const int thislen =
Tim Peters430f5d42001-03-01 01:30:56 +00001954#ifdef _DIRENT_HAVE_D_NAMELEN
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001955 dp->d_namlen;
Tim Peters430f5d42001-03-01 01:30:56 +00001956#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001957 strlen(dp->d_name);
Tim Peters430f5d42001-03-01 01:30:56 +00001958#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001959 if (thislen >= namelen &&
1960 strcmp(dp->d_name, nameWithExt) == 0) {
1961 (void)closedir(dirp);
1962 return 1; /* Found */
1963 }
1964 }
1965 (void)closedir(dirp);
1966 }
1967 return 0 ; /* Not found */
Tim Peters430f5d42001-03-01 01:30:56 +00001968
Andrew MacIntyred9400542002-02-26 11:41:34 +00001969/* OS/2 */
1970#elif defined(PYOS_OS2)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001971 HDIR hdir = 1;
1972 ULONG srchcnt = 1;
1973 FILEFINDBUF3 ffbuf;
1974 APIRET rc;
Andrew MacIntyred9400542002-02-26 11:41:34 +00001975
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001976 if (Py_GETENV("PYTHONCASEOK") != NULL)
1977 return 1;
Andrew MacIntyred9400542002-02-26 11:41:34 +00001978
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001979 rc = DosFindFirst(buf,
1980 &hdir,
1981 FILE_READONLY | FILE_HIDDEN | FILE_SYSTEM | FILE_DIRECTORY,
1982 &ffbuf, sizeof(ffbuf),
1983 &srchcnt,
1984 FIL_STANDARD);
1985 if (rc != NO_ERROR)
1986 return 0;
1987 return strncmp(ffbuf.achName, name, namelen) == 0;
Andrew MacIntyred9400542002-02-26 11:41:34 +00001988
Tim Peters50d8d372001-02-28 05:34:27 +00001989/* assuming it's a case-sensitive filesystem, so there's nothing to do! */
1990#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001991 return 1;
Guido van Rossum0980bd91998-02-13 17:18:36 +00001992
Guido van Rossum4d1b3b91998-02-13 23:27:59 +00001993#endif
Tim Peters50d8d372001-02-28 05:34:27 +00001994}
Guido van Rossum4d1b3b91998-02-13 23:27:59 +00001995
Guido van Rossum197346f1997-10-31 18:38:52 +00001996#ifdef HAVE_STAT
Victor Stinner4f4402c2010-08-14 14:50:26 +00001997
Guido van Rossum197346f1997-10-31 18:38:52 +00001998/* Helper to look for __init__.py or __init__.py[co] in potential package */
1999static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002000find_init_module(char *buf)
Guido van Rossum197346f1997-10-31 18:38:52 +00002001{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002002 const size_t save_len = strlen(buf);
2003 size_t i = save_len;
2004 char *pname; /* pointer to start of __init__ */
2005 struct stat statbuf;
Guido van Rossum197346f1997-10-31 18:38:52 +00002006
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002007/* For calling case_ok(buf, len, namelen, name):
2008 * /a/b/c/d/e/f/g/h/i/j/k/some_long_module_name.py\0
2009 * ^ ^ ^ ^
2010 * |--------------------- buf ---------------------|
2011 * |------------------- len ------------------|
2012 * |------ name -------|
2013 * |----- namelen -----|
Tim Peters0f9431f2001-07-05 03:47:53 +00002014 */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002015 if (save_len + 13 >= MAXPATHLEN)
2016 return 0;
2017 buf[i++] = SEP;
2018 pname = buf + i;
2019 strcpy(pname, "__init__.py");
2020 if (stat(buf, &statbuf) == 0) {
2021 if (case_ok(buf,
2022 save_len + 9, /* len("/__init__") */
2023 8, /* len("__init__") */
2024 pname)) {
2025 buf[save_len] = '\0';
2026 return 1;
2027 }
2028 }
2029 i += strlen(pname);
2030 strcpy(buf+i, Py_OptimizeFlag ? "o" : "c");
2031 if (stat(buf, &statbuf) == 0) {
2032 if (case_ok(buf,
2033 save_len + 9, /* len("/__init__") */
2034 8, /* len("__init__") */
2035 pname)) {
2036 buf[save_len] = '\0';
2037 return 1;
2038 }
2039 }
2040 buf[save_len] = '\0';
2041 return 0;
Guido van Rossum197346f1997-10-31 18:38:52 +00002042}
Guido van Rossum48a680c2001-03-02 06:34:14 +00002043
Guido van Rossum197346f1997-10-31 18:38:52 +00002044#endif /* HAVE_STAT */
2045
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002046
Tim Petersdbd9ba62000-07-09 03:09:57 +00002047static int init_builtin(char *); /* Forward */
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002048
Victor Stinner44c6c152010-08-09 00:59:10 +00002049static PyObject*
2050load_builtin(char *name, char *pathname, int type)
2051{
2052 PyObject *m, *modules;
2053 int err;
2054
2055 if (pathname != NULL && pathname[0] != '\0')
2056 name = pathname;
2057
2058 if (type == C_BUILTIN)
2059 err = init_builtin(name);
2060 else
2061 err = PyImport_ImportFrozenModule(name);
2062 if (err < 0)
2063 return NULL;
2064 if (err == 0) {
2065 PyErr_Format(PyExc_ImportError,
2066 "Purported %s module %.200s not found",
2067 type == C_BUILTIN ?
2068 "builtin" : "frozen",
2069 name);
2070 return NULL;
2071 }
2072
2073 modules = PyImport_GetModuleDict();
2074 m = PyDict_GetItemString(modules, name);
2075 if (m == NULL) {
2076 PyErr_Format(
2077 PyExc_ImportError,
2078 "%s module %.200s not properly initialized",
2079 type == C_BUILTIN ?
2080 "builtin" : "frozen",
2081 name);
2082 return NULL;
2083 }
2084 Py_INCREF(m);
2085 return m;
2086}
2087
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002088/* Load an external module using the default search path and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00002089 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002090
Guido van Rossum79f25d91997-04-29 20:08:16 +00002091static PyObject *
Alexandre Vassalottie223eb82009-07-29 20:12:15 +00002092load_module(char *name, FILE *fp, char *pathname, int type, PyObject *loader)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002093{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002094 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002095
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002096 /* First check that there's an open file (if we need one) */
2097 switch (type) {
2098 case PY_SOURCE:
2099 case PY_COMPILED:
2100 if (fp == NULL) {
2101 PyErr_Format(PyExc_ValueError,
2102 "file object required for import (type code %d)",
2103 type);
2104 return NULL;
2105 }
2106 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002107
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002108 switch (type) {
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002109
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002110 case PY_SOURCE:
2111 m = load_source_module(name, pathname, fp);
2112 break;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002113
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002114 case PY_COMPILED:
2115 m = load_compiled_module(name, pathname, fp);
2116 break;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002117
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002118#ifdef HAVE_DYNAMIC_LOADING
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002119 case C_EXTENSION:
2120 m = _PyImport_LoadDynamicModule(name, pathname, fp);
2121 break;
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002122#endif
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002123
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002124 case PKG_DIRECTORY:
2125 m = load_package(name, pathname);
2126 break;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002127
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002128 case C_BUILTIN:
2129 case PY_FROZEN:
Victor Stinner44c6c152010-08-09 00:59:10 +00002130 m = load_builtin(name, pathname, type);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002131 break;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002132
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002133 case IMP_HOOK: {
2134 if (loader == NULL) {
2135 PyErr_SetString(PyExc_ImportError,
2136 "import hook without loader");
2137 return NULL;
2138 }
2139 m = PyObject_CallMethod(loader, "load_module", "s", name);
2140 break;
2141 }
Just van Rossum52e14d62002-12-30 22:08:05 +00002142
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002143 default:
2144 PyErr_Format(PyExc_ImportError,
2145 "Don't know how to import %.200s (type code %d)",
2146 name, type);
2147 m = NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002148
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002149 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002150
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002151 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002152}
2153
2154
2155/* Initialize a built-in module.
Thomas Wouters89f507f2006-12-13 04:49:30 +00002156 Return 1 for success, 0 if the module is not found, and -1 with
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002157 an exception set if the initialization failed. */
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002158
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002159static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002160init_builtin(char *name)
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002161{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002162 struct _inittab *p;
Guido van Rossum25ce5661997-08-02 03:10:38 +00002163
Victor Stinner49d3f252010-10-17 01:24:53 +00002164 if (_PyImport_FindBuiltin(name) != NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002165 return 1;
Guido van Rossum25ce5661997-08-02 03:10:38 +00002166
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002167 for (p = PyImport_Inittab; p->name != NULL; p++) {
2168 PyObject *mod;
Antoine Pitrou6c40eb72012-01-18 20:16:09 +01002169 PyModuleDef *def;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002170 if (strcmp(name, p->name) == 0) {
2171 if (p->initfunc == NULL) {
2172 PyErr_Format(PyExc_ImportError,
2173 "Cannot re-init internal module %.200s",
2174 name);
2175 return -1;
2176 }
2177 if (Py_VerboseFlag)
2178 PySys_WriteStderr("import %s # builtin\n", name);
2179 mod = (*p->initfunc)();
2180 if (mod == 0)
2181 return -1;
Antoine Pitrou6c40eb72012-01-18 20:16:09 +01002182 /* Remember pointer to module init function. */
2183 def = PyModule_GetDef(mod);
2184 def->m_base.m_init = p->initfunc;
Victor Stinner49d3f252010-10-17 01:24:53 +00002185 if (_PyImport_FixupBuiltin(mod, name) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002186 return -1;
2187 /* FixupExtension has put the module into sys.modules,
2188 so we can release our own reference. */
2189 Py_DECREF(mod);
2190 return 1;
2191 }
2192 }
2193 return 0;
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002194}
Guido van Rossumf56e3db1993-04-01 20:59:32 +00002195
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002196
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002197/* Frozen modules */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002198
Guido van Rossumcfd0a221996-06-17 17:06:34 +00002199static struct _frozen *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002200find_frozen(char *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002201{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002202 struct _frozen *p;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002203
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002204 if (!name)
2205 return NULL;
Benjamin Petersond968e272008-11-05 22:48:33 +00002206
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002207 for (p = PyImport_FrozenModules; ; p++) {
2208 if (p->name == NULL)
2209 return NULL;
2210 if (strcmp(p->name, name) == 0)
2211 break;
2212 }
2213 return p;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002214}
2215
Guido van Rossum79f25d91997-04-29 20:08:16 +00002216static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002217get_frozen_object(char *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002218{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002219 struct _frozen *p = find_frozen(name);
2220 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002221
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002222 if (p == NULL) {
2223 PyErr_Format(PyExc_ImportError,
2224 "No such frozen object named %.200s",
2225 name);
2226 return NULL;
2227 }
2228 if (p->code == NULL) {
2229 PyErr_Format(PyExc_ImportError,
2230 "Excluded frozen object named %.200s",
2231 name);
2232 return NULL;
2233 }
2234 size = p->size;
2235 if (size < 0)
2236 size = -size;
2237 return PyMarshal_ReadObjectFromString((char *)p->code, size);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002238}
2239
Brett Cannon8d110132009-03-15 02:20:16 +00002240static PyObject *
2241is_frozen_package(char *name)
2242{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002243 struct _frozen *p = find_frozen(name);
2244 int size;
Brett Cannon8d110132009-03-15 02:20:16 +00002245
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002246 if (p == NULL) {
2247 PyErr_Format(PyExc_ImportError,
2248 "No such frozen object named %.200s",
2249 name);
2250 return NULL;
2251 }
Brett Cannon8d110132009-03-15 02:20:16 +00002252
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002253 size = p->size;
Brett Cannon8d110132009-03-15 02:20:16 +00002254
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002255 if (size < 0)
2256 Py_RETURN_TRUE;
2257 else
2258 Py_RETURN_FALSE;
Brett Cannon8d110132009-03-15 02:20:16 +00002259}
2260
2261
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002262/* Initialize a frozen module.
Brett Cannon3c2ac442009-03-08 20:49:47 +00002263 Return 1 for success, 0 if the module is not found, and -1 with
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002264 an exception set if the initialization failed.
2265 This function is also used from frozenmain.c */
Guido van Rossum0b344901995-02-07 15:35:27 +00002266
2267int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002268PyImport_ImportFrozenModule(char *name)
Guido van Rossumf56e3db1993-04-01 20:59:32 +00002269{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002270 struct _frozen *p = find_frozen(name);
2271 PyObject *co;
2272 PyObject *m;
2273 int ispackage;
2274 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002275
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002276 if (p == NULL)
2277 return 0;
2278 if (p->code == NULL) {
2279 PyErr_Format(PyExc_ImportError,
2280 "Excluded frozen object named %.200s",
2281 name);
2282 return -1;
2283 }
2284 size = p->size;
2285 ispackage = (size < 0);
2286 if (ispackage)
2287 size = -size;
2288 if (Py_VerboseFlag)
2289 PySys_WriteStderr("import %s # frozen%s\n",
2290 name, ispackage ? " package" : "");
2291 co = PyMarshal_ReadObjectFromString((char *)p->code, size);
2292 if (co == NULL)
2293 return -1;
2294 if (!PyCode_Check(co)) {
2295 PyErr_Format(PyExc_TypeError,
2296 "frozen object %.200s is not a code object",
2297 name);
2298 goto err_return;
2299 }
2300 if (ispackage) {
2301 /* Set __path__ to the package name */
2302 PyObject *d, *s, *l;
2303 int err;
2304 m = PyImport_AddModule(name);
2305 if (m == NULL)
2306 goto err_return;
2307 d = PyModule_GetDict(m);
2308 s = PyUnicode_InternFromString(name);
2309 if (s == NULL)
2310 goto err_return;
2311 l = PyList_New(1);
2312 if (l == NULL) {
2313 Py_DECREF(s);
2314 goto err_return;
2315 }
2316 PyList_SET_ITEM(l, 0, s);
2317 err = PyDict_SetItemString(d, "__path__", l);
2318 Py_DECREF(l);
2319 if (err != 0)
2320 goto err_return;
2321 }
2322 m = PyImport_ExecCodeModuleEx(name, co, "<frozen>");
2323 if (m == NULL)
2324 goto err_return;
2325 Py_DECREF(co);
2326 Py_DECREF(m);
2327 return 1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002328err_return:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002329 Py_DECREF(co);
2330 return -1;
Guido van Rossumf56e3db1993-04-01 20:59:32 +00002331}
Guido van Rossum74e6a111994-08-29 12:54:38 +00002332
2333
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002334/* Import a module, either built-in, frozen, or external, and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00002335 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum74e6a111994-08-29 12:54:38 +00002336
Guido van Rossum79f25d91997-04-29 20:08:16 +00002337PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00002338PyImport_ImportModule(const char *name)
Guido van Rossum74e6a111994-08-29 12:54:38 +00002339{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002340 PyObject *pname;
2341 PyObject *result;
Marc-André Lemburg3c61c352001-02-09 19:40:15 +00002342
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002343 pname = PyUnicode_FromString(name);
2344 if (pname == NULL)
2345 return NULL;
2346 result = PyImport_Import(pname);
2347 Py_DECREF(pname);
2348 return result;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002349}
2350
Christian Heimes072c0f12008-01-03 23:01:04 +00002351/* Import a module without blocking
2352 *
2353 * At first it tries to fetch the module from sys.modules. If the module was
2354 * never loaded before it loads it with PyImport_ImportModule() unless another
2355 * thread holds the import lock. In the latter case the function raises an
2356 * ImportError instead of blocking.
2357 *
2358 * Returns the module object with incremented ref count.
2359 */
2360PyObject *
2361PyImport_ImportModuleNoBlock(const char *name)
2362{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002363 PyObject *result;
2364 PyObject *modules;
Victor Stinner0af03062011-09-02 00:11:43 +02002365#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002366 long me;
Victor Stinner0af03062011-09-02 00:11:43 +02002367#endif
Christian Heimes072c0f12008-01-03 23:01:04 +00002368
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002369 /* Try to get the module from sys.modules[name] */
2370 modules = PyImport_GetModuleDict();
2371 if (modules == NULL)
2372 return NULL;
Christian Heimes072c0f12008-01-03 23:01:04 +00002373
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002374 result = PyDict_GetItemString(modules, name);
2375 if (result != NULL) {
2376 Py_INCREF(result);
2377 return result;
2378 }
2379 else {
2380 PyErr_Clear();
2381 }
Benjamin Peterson3e4f0552008-09-02 00:31:15 +00002382#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002383 /* check the import lock
2384 * me might be -1 but I ignore the error here, the lock function
2385 * takes care of the problem */
2386 me = PyThread_get_thread_ident();
2387 if (import_lock_thread == -1 || import_lock_thread == me) {
2388 /* no thread or me is holding the lock */
2389 return PyImport_ImportModule(name);
2390 }
2391 else {
2392 PyErr_Format(PyExc_ImportError,
2393 "Failed to import %.200s because the import lock"
2394 "is held by another thread.",
2395 name);
2396 return NULL;
2397 }
Benjamin Peterson3e4f0552008-09-02 00:31:15 +00002398#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002399 return PyImport_ImportModule(name);
Benjamin Peterson3e4f0552008-09-02 00:31:15 +00002400#endif
Christian Heimes072c0f12008-01-03 23:01:04 +00002401}
2402
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002403/* Forward declarations for helper routines */
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002404static PyObject *get_parent(PyObject *globals, char *buf,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002405 Py_ssize_t *p_buflen, int level);
Tim Petersdbd9ba62000-07-09 03:09:57 +00002406static PyObject *load_next(PyObject *mod, PyObject *altmod,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002407 char **p_name, char *buf, Py_ssize_t *p_buflen);
Tim Petersdbd9ba62000-07-09 03:09:57 +00002408static int mark_miss(char *name);
2409static int ensure_fromlist(PyObject *mod, PyObject *fromlist,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002410 char *buf, Py_ssize_t buflen, int recursive);
Tim Petersdbd9ba62000-07-09 03:09:57 +00002411static PyObject * import_submodule(PyObject *mod, char *name, char *fullname);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002412
2413/* The Magnum Opus of dotted-name import :-) */
2414
Guido van Rossum75acc9c1998-03-03 22:26:50 +00002415static PyObject *
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002416import_module_level(char *name, PyObject *globals, PyObject *locals,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002417 PyObject *fromlist, int level)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002418{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002419 char buf[MAXPATHLEN+1];
2420 Py_ssize_t buflen = 0;
2421 PyObject *parent, *head, *next, *tail;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002422
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002423 if (strchr(name, '/') != NULL
Christian Heimes454f37b2008-01-10 00:10:02 +00002424#ifdef MS_WINDOWS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002425 || strchr(name, '\\') != NULL
Christian Heimes454f37b2008-01-10 00:10:02 +00002426#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002427 ) {
2428 PyErr_SetString(PyExc_ImportError,
2429 "Import by filename is not supported.");
2430 return NULL;
2431 }
Christian Heimes454f37b2008-01-10 00:10:02 +00002432
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002433 parent = get_parent(globals, buf, &buflen, level);
2434 if (parent == NULL)
2435 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002436
Benjamin Peterson556d8002010-06-27 22:37:28 +00002437 head = load_next(parent, level < 0 ? Py_None : parent, &name, buf,
2438 &buflen);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002439 if (head == NULL)
2440 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002441
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002442 tail = head;
2443 Py_INCREF(tail);
2444 while (name) {
2445 next = load_next(tail, tail, &name, buf, &buflen);
2446 Py_DECREF(tail);
2447 if (next == NULL) {
2448 Py_DECREF(head);
2449 return NULL;
2450 }
2451 tail = next;
2452 }
2453 if (tail == Py_None) {
2454 /* If tail is Py_None, both get_parent and load_next found
2455 an empty module name: someone called __import__("") or
2456 doctored faulty bytecode */
2457 Py_DECREF(tail);
2458 Py_DECREF(head);
2459 PyErr_SetString(PyExc_ValueError,
2460 "Empty module name");
2461 return NULL;
2462 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002463
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002464 if (fromlist != NULL) {
2465 if (fromlist == Py_None || !PyObject_IsTrue(fromlist))
2466 fromlist = NULL;
2467 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002468
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002469 if (fromlist == NULL) {
2470 Py_DECREF(tail);
2471 return head;
2472 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002473
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002474 Py_DECREF(head);
2475 if (!ensure_fromlist(tail, fromlist, buf, buflen, 0)) {
2476 Py_DECREF(tail);
2477 return NULL;
2478 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002479
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002480 return tail;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002481}
2482
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002483PyObject *
2484PyImport_ImportModuleLevel(char *name, PyObject *globals, PyObject *locals,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002485 PyObject *fromlist, int level)
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002486{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002487 PyObject *result;
2488 _PyImport_AcquireLock();
2489 result = import_module_level(name, globals, locals, fromlist, level);
2490 if (_PyImport_ReleaseLock() < 0) {
2491 Py_XDECREF(result);
2492 PyErr_SetString(PyExc_RuntimeError,
2493 "not holding the import lock");
2494 return NULL;
2495 }
2496 return result;
Guido van Rossum75acc9c1998-03-03 22:26:50 +00002497}
2498
Fred Drake87590902004-05-28 20:21:36 +00002499/* Return the package that an import is being performed in. If globals comes
2500 from the module foo.bar.bat (not itself a package), this returns the
2501 sys.modules entry for foo.bar. If globals is from a package's __init__.py,
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00002502 the package's entry in sys.modules is returned, as a borrowed reference.
Fred Drake87590902004-05-28 20:21:36 +00002503
2504 The *name* of the returned package is returned in buf, with the length of
2505 the name in *p_buflen.
2506
2507 If globals doesn't come from a package or a module in a package, or a
2508 corresponding entry is not found in sys.modules, Py_None is returned.
2509*/
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002510static PyObject *
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002511get_parent(PyObject *globals, char *buf, Py_ssize_t *p_buflen, int level)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002512{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002513 static PyObject *namestr = NULL;
2514 static PyObject *pathstr = NULL;
2515 static PyObject *pkgstr = NULL;
2516 PyObject *pkgname, *modname, *modpath, *modules, *parent;
2517 int orig_level = level;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002518
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002519 if (globals == NULL || !PyDict_Check(globals) || !level)
2520 return Py_None;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002521
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002522 if (namestr == NULL) {
2523 namestr = PyUnicode_InternFromString("__name__");
2524 if (namestr == NULL)
2525 return NULL;
2526 }
2527 if (pathstr == NULL) {
2528 pathstr = PyUnicode_InternFromString("__path__");
2529 if (pathstr == NULL)
2530 return NULL;
2531 }
2532 if (pkgstr == NULL) {
2533 pkgstr = PyUnicode_InternFromString("__package__");
2534 if (pkgstr == NULL)
2535 return NULL;
2536 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002537
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002538 *buf = '\0';
2539 *p_buflen = 0;
2540 pkgname = PyDict_GetItem(globals, pkgstr);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002541
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002542 if ((pkgname != NULL) && (pkgname != Py_None)) {
2543 /* __package__ is set, so use it */
2544 char *pkgname_str;
2545 Py_ssize_t len;
Alexandre Vassalottia85998a2008-05-03 18:24:43 +00002546
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002547 if (!PyUnicode_Check(pkgname)) {
2548 PyErr_SetString(PyExc_ValueError,
2549 "__package__ set to non-string");
2550 return NULL;
2551 }
2552 pkgname_str = _PyUnicode_AsStringAndSize(pkgname, &len);
2553 if (len == 0) {
2554 if (level > 0) {
2555 PyErr_SetString(PyExc_ValueError,
2556 "Attempted relative import in non-package");
2557 return NULL;
2558 }
2559 return Py_None;
2560 }
2561 if (len > MAXPATHLEN) {
2562 PyErr_SetString(PyExc_ValueError,
2563 "Package name too long");
2564 return NULL;
2565 }
2566 strcpy(buf, pkgname_str);
2567 } else {
2568 /* __package__ not set, so figure it out and set it */
2569 modname = PyDict_GetItem(globals, namestr);
2570 if (modname == NULL || !PyUnicode_Check(modname))
2571 return Py_None;
Brett Cannon9a5b25a2010-03-01 02:09:17 +00002572
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002573 modpath = PyDict_GetItem(globals, pathstr);
2574 if (modpath != NULL) {
2575 /* __path__ is set, so modname is already the package name */
2576 char *modname_str;
2577 Py_ssize_t len;
2578 int error;
Alexandre Vassalottia85998a2008-05-03 18:24:43 +00002579
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002580 modname_str = _PyUnicode_AsStringAndSize(modname, &len);
2581 if (len > MAXPATHLEN) {
2582 PyErr_SetString(PyExc_ValueError,
2583 "Module name too long");
2584 return NULL;
2585 }
2586 strcpy(buf, modname_str);
2587 error = PyDict_SetItem(globals, pkgstr, modname);
2588 if (error) {
2589 PyErr_SetString(PyExc_ValueError,
2590 "Could not set __package__");
2591 return NULL;
2592 }
2593 } else {
2594 /* Normal module, so work out the package name if any */
2595 char *start = _PyUnicode_AsString(modname);
2596 char *lastdot = strrchr(start, '.');
2597 size_t len;
2598 int error;
2599 if (lastdot == NULL && level > 0) {
2600 PyErr_SetString(PyExc_ValueError,
2601 "Attempted relative import in non-package");
2602 return NULL;
2603 }
2604 if (lastdot == NULL) {
2605 error = PyDict_SetItem(globals, pkgstr, Py_None);
2606 if (error) {
2607 PyErr_SetString(PyExc_ValueError,
2608 "Could not set __package__");
2609 return NULL;
2610 }
2611 return Py_None;
2612 }
2613 len = lastdot - start;
2614 if (len >= MAXPATHLEN) {
2615 PyErr_SetString(PyExc_ValueError,
2616 "Module name too long");
2617 return NULL;
2618 }
2619 strncpy(buf, start, len);
2620 buf[len] = '\0';
2621 pkgname = PyUnicode_FromString(buf);
2622 if (pkgname == NULL) {
2623 return NULL;
2624 }
2625 error = PyDict_SetItem(globals, pkgstr, pkgname);
2626 Py_DECREF(pkgname);
2627 if (error) {
2628 PyErr_SetString(PyExc_ValueError,
2629 "Could not set __package__");
2630 return NULL;
2631 }
2632 }
2633 }
2634 while (--level > 0) {
2635 char *dot = strrchr(buf, '.');
2636 if (dot == NULL) {
2637 PyErr_SetString(PyExc_ValueError,
2638 "Attempted relative import beyond "
2639 "toplevel package");
2640 return NULL;
2641 }
2642 *dot = '\0';
2643 }
2644 *p_buflen = strlen(buf);
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002645
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002646 modules = PyImport_GetModuleDict();
2647 parent = PyDict_GetItemString(modules, buf);
2648 if (parent == NULL) {
2649 if (orig_level < 1) {
2650 PyObject *err_msg = PyBytes_FromFormat(
2651 "Parent module '%.200s' not found "
2652 "while handling absolute import", buf);
2653 if (err_msg == NULL) {
2654 return NULL;
2655 }
2656 if (!PyErr_WarnEx(PyExc_RuntimeWarning,
2657 PyBytes_AsString(err_msg), 1)) {
2658 *buf = '\0';
2659 *p_buflen = 0;
2660 parent = Py_None;
2661 }
2662 Py_DECREF(err_msg);
2663 } else {
2664 PyErr_Format(PyExc_SystemError,
2665 "Parent module '%.200s' not loaded, "
2666 "cannot perform relative import", buf);
2667 }
2668 }
2669 return parent;
2670 /* We expect, but can't guarantee, if parent != None, that:
2671 - parent.__name__ == buf
2672 - parent.__dict__ is globals
2673 If this is violated... Who cares? */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002674}
2675
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002676/* altmod is either None or same as mod */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002677static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002678load_next(PyObject *mod, PyObject *altmod, char **p_name, char *buf,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002679 Py_ssize_t *p_buflen)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002680{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002681 char *name = *p_name;
2682 char *dot = strchr(name, '.');
2683 size_t len;
2684 char *p;
2685 PyObject *result;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002686
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002687 if (strlen(name) == 0) {
2688 /* completely empty module name should only happen in
2689 'from . import' (or '__import__("")')*/
2690 Py_INCREF(mod);
2691 *p_name = NULL;
2692 return mod;
2693 }
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002694
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002695 if (dot == NULL) {
2696 *p_name = NULL;
2697 len = strlen(name);
2698 }
2699 else {
2700 *p_name = dot+1;
2701 len = dot-name;
2702 }
2703 if (len == 0) {
2704 PyErr_SetString(PyExc_ValueError,
2705 "Empty module name");
2706 return NULL;
2707 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002708
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002709 p = buf + *p_buflen;
2710 if (p != buf)
2711 *p++ = '.';
2712 if (p+len-buf >= MAXPATHLEN) {
2713 PyErr_SetString(PyExc_ValueError,
2714 "Module name too long");
2715 return NULL;
2716 }
2717 strncpy(p, name, len);
2718 p[len] = '\0';
2719 *p_buflen = p+len-buf;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002720
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002721 result = import_submodule(mod, p, buf);
2722 if (result == Py_None && altmod != mod) {
2723 Py_DECREF(result);
2724 /* Here, altmod must be None and mod must not be None */
2725 result = import_submodule(altmod, p, p);
2726 if (result != NULL && result != Py_None) {
2727 if (mark_miss(buf) != 0) {
2728 Py_DECREF(result);
2729 return NULL;
2730 }
2731 strncpy(buf, name, len);
2732 buf[len] = '\0';
2733 *p_buflen = len;
2734 }
2735 }
2736 if (result == NULL)
2737 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002738
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002739 if (result == Py_None) {
2740 Py_DECREF(result);
2741 PyErr_Format(PyExc_ImportError,
2742 "No module named %.200s", name);
2743 return NULL;
2744 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002745
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002746 return result;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002747}
2748
2749static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002750mark_miss(char *name)
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00002751{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002752 PyObject *modules = PyImport_GetModuleDict();
2753 return PyDict_SetItemString(modules, name, Py_None);
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00002754}
2755
2756static int
Martin v. Löwis18e16552006-02-15 17:27:45 +00002757ensure_fromlist(PyObject *mod, PyObject *fromlist, char *buf, Py_ssize_t buflen,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002758 int recursive)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002759{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002760 int i;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002761
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002762 if (!PyObject_HasAttrString(mod, "__path__"))
2763 return 1;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002764
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002765 for (i = 0; ; i++) {
2766 PyObject *item = PySequence_GetItem(fromlist, i);
2767 int hasit;
2768 if (item == NULL) {
2769 if (PyErr_ExceptionMatches(PyExc_IndexError)) {
2770 PyErr_Clear();
2771 return 1;
2772 }
2773 return 0;
2774 }
2775 if (!PyUnicode_Check(item)) {
2776 PyErr_SetString(PyExc_TypeError,
2777 "Item in ``from list'' not a string");
2778 Py_DECREF(item);
2779 return 0;
2780 }
2781 if (PyUnicode_AS_UNICODE(item)[0] == '*') {
2782 PyObject *all;
2783 Py_DECREF(item);
2784 /* See if the package defines __all__ */
2785 if (recursive)
2786 continue; /* Avoid endless recursion */
2787 all = PyObject_GetAttrString(mod, "__all__");
2788 if (all == NULL)
2789 PyErr_Clear();
2790 else {
2791 int ret = ensure_fromlist(mod, all, buf, buflen, 1);
2792 Py_DECREF(all);
2793 if (!ret)
2794 return 0;
2795 }
2796 continue;
2797 }
2798 hasit = PyObject_HasAttr(mod, item);
2799 if (!hasit) {
2800 PyObject *item8;
2801 char *subname;
2802 PyObject *submod;
2803 char *p;
Victor Stinnerae6265f2010-05-15 16:27:27 +00002804 item8 = PyUnicode_EncodeFSDefault(item);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002805 if (!item8) {
2806 PyErr_SetString(PyExc_ValueError, "Cannot encode path item");
2807 return 0;
2808 }
2809 subname = PyBytes_AS_STRING(item8);
2810 if (buflen + strlen(subname) >= MAXPATHLEN) {
2811 PyErr_SetString(PyExc_ValueError,
2812 "Module name too long");
2813 Py_DECREF(item);
2814 return 0;
2815 }
2816 p = buf + buflen;
2817 *p++ = '.';
2818 strcpy(p, subname);
2819 submod = import_submodule(mod, subname, buf);
2820 Py_DECREF(item8);
2821 Py_XDECREF(submod);
2822 if (submod == NULL) {
2823 Py_DECREF(item);
2824 return 0;
2825 }
2826 }
2827 Py_DECREF(item);
2828 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002829
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002830 /* NOTREACHED */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002831}
2832
Neil Schemenauer00b09662003-06-16 21:03:07 +00002833static int
2834add_submodule(PyObject *mod, PyObject *submod, char *fullname, char *subname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002835 PyObject *modules)
Neil Schemenauer00b09662003-06-16 21:03:07 +00002836{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002837 if (mod == Py_None)
2838 return 1;
2839 /* Irrespective of the success of this load, make a
2840 reference to it in the parent package module. A copy gets
2841 saved in the modules dictionary under the full name, so get a
2842 reference from there, if need be. (The exception is when the
2843 load failed with a SyntaxError -- then there's no trace in
2844 sys.modules. In that case, of course, do nothing extra.) */
2845 if (submod == NULL) {
2846 submod = PyDict_GetItemString(modules, fullname);
2847 if (submod == NULL)
2848 return 1;
2849 }
2850 if (PyModule_Check(mod)) {
2851 /* We can't use setattr here since it can give a
2852 * spurious warning if the submodule name shadows a
2853 * builtin name */
2854 PyObject *dict = PyModule_GetDict(mod);
2855 if (!dict)
2856 return 0;
2857 if (PyDict_SetItemString(dict, subname, submod) < 0)
2858 return 0;
2859 }
2860 else {
2861 if (PyObject_SetAttrString(mod, subname, submod) < 0)
2862 return 0;
2863 }
2864 return 1;
Neil Schemenauer00b09662003-06-16 21:03:07 +00002865}
2866
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002867static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002868import_submodule(PyObject *mod, char *subname, char *fullname)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002869{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002870 PyObject *modules = PyImport_GetModuleDict();
2871 PyObject *m = NULL;
Guido van Rossum74e6a111994-08-29 12:54:38 +00002872
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002873 /* Require:
2874 if mod == None: subname == fullname
2875 else: mod.__name__ + "." + subname == fullname
2876 */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002877
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002878 if ((m = PyDict_GetItemString(modules, fullname)) != NULL) {
2879 Py_INCREF(m);
2880 }
2881 else {
2882 PyObject *path, *loader = NULL;
2883 char buf[MAXPATHLEN+1];
2884 struct filedescr *fdp;
2885 FILE *fp = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002886
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002887 if (mod == Py_None)
2888 path = NULL;
2889 else {
2890 path = PyObject_GetAttrString(mod, "__path__");
2891 if (path == NULL) {
2892 PyErr_Clear();
2893 Py_INCREF(Py_None);
2894 return Py_None;
2895 }
2896 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002897
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002898 buf[0] = '\0';
2899 fdp = find_module(fullname, subname, path, buf, MAXPATHLEN+1,
2900 &fp, &loader);
2901 Py_XDECREF(path);
2902 if (fdp == NULL) {
2903 if (!PyErr_ExceptionMatches(PyExc_ImportError))
2904 return NULL;
2905 PyErr_Clear();
2906 Py_INCREF(Py_None);
2907 return Py_None;
2908 }
2909 m = load_module(fullname, fp, buf, fdp->type, loader);
2910 Py_XDECREF(loader);
2911 if (fp)
2912 fclose(fp);
2913 if (!add_submodule(mod, m, fullname, subname, modules)) {
2914 Py_XDECREF(m);
2915 m = NULL;
2916 }
2917 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002918
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002919 return m;
Guido van Rossum74e6a111994-08-29 12:54:38 +00002920}
2921
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002922
2923/* Re-import a module of any kind and return its module object, WITH
2924 INCREMENTED REFERENCE COUNT */
2925
Guido van Rossum79f25d91997-04-29 20:08:16 +00002926PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002927PyImport_ReloadModule(PyObject *m)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002928{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002929 PyInterpreterState *interp = PyThreadState_Get()->interp;
2930 PyObject *modules_reloading = interp->modules_reloading;
2931 PyObject *modules = PyImport_GetModuleDict();
2932 PyObject *path = NULL, *loader = NULL, *existing_m = NULL;
2933 char *name, *subname;
2934 char buf[MAXPATHLEN+1];
2935 struct filedescr *fdp;
2936 FILE *fp = NULL;
2937 PyObject *newm;
Brett Cannon9a5b25a2010-03-01 02:09:17 +00002938
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002939 if (modules_reloading == NULL) {
2940 Py_FatalError("PyImport_ReloadModule: "
2941 "no modules_reloading dictionary!");
2942 return NULL;
2943 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002944
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002945 if (m == NULL || !PyModule_Check(m)) {
2946 PyErr_SetString(PyExc_TypeError,
2947 "reload() argument must be module");
2948 return NULL;
2949 }
2950 name = (char*)PyModule_GetName(m);
2951 if (name == NULL)
2952 return NULL;
2953 if (m != PyDict_GetItemString(modules, name)) {
2954 PyErr_Format(PyExc_ImportError,
2955 "reload(): module %.200s not in sys.modules",
2956 name);
2957 return NULL;
2958 }
2959 existing_m = PyDict_GetItemString(modules_reloading, name);
2960 if (existing_m != NULL) {
2961 /* Due to a recursive reload, this module is already
2962 being reloaded. */
2963 Py_INCREF(existing_m);
2964 return existing_m;
2965 }
2966 if (PyDict_SetItemString(modules_reloading, name, m) < 0)
2967 return NULL;
Guido van Rossumd8faa362007-04-27 19:54:29 +00002968
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002969 subname = strrchr(name, '.');
2970 if (subname == NULL)
2971 subname = name;
2972 else {
2973 PyObject *parentname, *parent;
2974 parentname = PyUnicode_FromStringAndSize(name, (subname-name));
2975 if (parentname == NULL) {
2976 imp_modules_reloading_clear();
2977 return NULL;
2978 }
2979 parent = PyDict_GetItem(modules, parentname);
2980 if (parent == NULL) {
2981 PyErr_Format(PyExc_ImportError,
2982 "reload(): parent %U not in sys.modules",
2983 parentname);
2984 Py_DECREF(parentname);
2985 imp_modules_reloading_clear();
2986 return NULL;
2987 }
2988 Py_DECREF(parentname);
2989 subname++;
2990 path = PyObject_GetAttrString(parent, "__path__");
2991 if (path == NULL)
2992 PyErr_Clear();
2993 }
2994 buf[0] = '\0';
2995 fdp = find_module(name, subname, path, buf, MAXPATHLEN+1, &fp, &loader);
2996 Py_XDECREF(path);
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00002997
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002998 if (fdp == NULL) {
2999 Py_XDECREF(loader);
3000 imp_modules_reloading_clear();
3001 return NULL;
3002 }
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00003003
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003004 newm = load_module(name, fp, buf, fdp->type, loader);
3005 Py_XDECREF(loader);
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00003006
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003007 if (fp)
3008 fclose(fp);
3009 if (newm == NULL) {
3010 /* load_module probably removed name from modules because of
3011 * the error. Put back the original module object. We're
3012 * going to return NULL in this case regardless of whether
3013 * replacing name succeeds, so the return value is ignored.
3014 */
3015 PyDict_SetItemString(modules, name, m);
3016 }
3017 imp_modules_reloading_clear();
3018 return newm;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003019}
3020
3021
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003022/* Higher-level import emulator which emulates the "import" statement
3023 more accurately -- it invokes the __import__() function from the
3024 builtins of the current globals. This means that the import is
3025 done using whatever import hooks are installed in the current
Brett Cannonbc2eff32010-09-19 21:39:02 +00003026 environment.
Guido van Rossum6058eb41998-12-21 19:51:00 +00003027 A dummy list ["__doc__"] is passed as the 4th argument so that
Neal Norwitz80e7f272007-08-26 06:45:23 +00003028 e.g. PyImport_Import(PyUnicode_FromString("win32com.client.gencache"))
Guido van Rossum6058eb41998-12-21 19:51:00 +00003029 will return <module "gencache"> instead of <module "win32com">. */
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003030
3031PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003032PyImport_Import(PyObject *module_name)
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003033{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003034 static PyObject *silly_list = NULL;
3035 static PyObject *builtins_str = NULL;
3036 static PyObject *import_str = NULL;
3037 PyObject *globals = NULL;
3038 PyObject *import = NULL;
3039 PyObject *builtins = NULL;
Brett Cannonbc2eff32010-09-19 21:39:02 +00003040 PyObject *modules = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003041 PyObject *r = NULL;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003042
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003043 /* Initialize constant string objects */
3044 if (silly_list == NULL) {
3045 import_str = PyUnicode_InternFromString("__import__");
3046 if (import_str == NULL)
3047 return NULL;
3048 builtins_str = PyUnicode_InternFromString("__builtins__");
3049 if (builtins_str == NULL)
3050 return NULL;
Brett Cannonbc2eff32010-09-19 21:39:02 +00003051 silly_list = PyList_New(0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003052 if (silly_list == NULL)
3053 return NULL;
3054 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003055
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003056 /* Get the builtins from current globals */
3057 globals = PyEval_GetGlobals();
3058 if (globals != NULL) {
3059 Py_INCREF(globals);
3060 builtins = PyObject_GetItem(globals, builtins_str);
3061 if (builtins == NULL)
3062 goto err;
3063 }
3064 else {
3065 /* No globals -- use standard builtins, and fake globals */
3066 builtins = PyImport_ImportModuleLevel("builtins",
3067 NULL, NULL, NULL, 0);
3068 if (builtins == NULL)
3069 return NULL;
3070 globals = Py_BuildValue("{OO}", builtins_str, builtins);
3071 if (globals == NULL)
3072 goto err;
3073 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003074
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003075 /* Get the __import__ function from the builtins */
3076 if (PyDict_Check(builtins)) {
3077 import = PyObject_GetItem(builtins, import_str);
3078 if (import == NULL)
3079 PyErr_SetObject(PyExc_KeyError, import_str);
3080 }
3081 else
3082 import = PyObject_GetAttr(builtins, import_str);
3083 if (import == NULL)
3084 goto err;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003085
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003086 /* Call the __import__ function with the proper argument list
Brett Cannonbc2eff32010-09-19 21:39:02 +00003087 Always use absolute import here.
3088 Calling for side-effect of import. */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003089 r = PyObject_CallFunction(import, "OOOOi", module_name, globals,
3090 globals, silly_list, 0, NULL);
Brett Cannonbc2eff32010-09-19 21:39:02 +00003091 if (r == NULL)
3092 goto err;
3093 Py_DECREF(r);
3094
3095 modules = PyImport_GetModuleDict();
3096 r = PyDict_GetItem(modules, module_name);
3097 if (r != NULL)
3098 Py_INCREF(r);
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003099
3100 err:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003101 Py_XDECREF(globals);
3102 Py_XDECREF(builtins);
3103 Py_XDECREF(import);
Tim Peters50d8d372001-02-28 05:34:27 +00003104
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003105 return r;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003106}
3107
3108
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003109/* Module 'imp' provides Python access to the primitives used for
3110 importing modules.
3111*/
3112
Guido van Rossum79f25d91997-04-29 20:08:16 +00003113static PyObject *
Barry Warsaw28a691b2010-04-17 00:19:56 +00003114imp_make_magic(long magic)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003115{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003116 char buf[4];
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003117
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003118 buf[0] = (char) ((magic >> 0) & 0xff);
3119 buf[1] = (char) ((magic >> 8) & 0xff);
3120 buf[2] = (char) ((magic >> 16) & 0xff);
3121 buf[3] = (char) ((magic >> 24) & 0xff);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003122
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003123 return PyBytes_FromStringAndSize(buf, 4);
Victor Stinner3e2b7172010-11-09 09:32:19 +00003124}
Barry Warsaw28a691b2010-04-17 00:19:56 +00003125
3126static PyObject *
3127imp_get_magic(PyObject *self, PyObject *noargs)
3128{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003129 return imp_make_magic(pyc_magic);
Barry Warsaw28a691b2010-04-17 00:19:56 +00003130}
3131
3132static PyObject *
3133imp_get_tag(PyObject *self, PyObject *noargs)
3134{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003135 return PyUnicode_FromString(pyc_tag);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003136}
3137
Guido van Rossum79f25d91997-04-29 20:08:16 +00003138static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +00003139imp_get_suffixes(PyObject *self, PyObject *noargs)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003140{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003141 PyObject *list;
3142 struct filedescr *fdp;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003143
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003144 list = PyList_New(0);
3145 if (list == NULL)
3146 return NULL;
3147 for (fdp = _PyImport_Filetab; fdp->suffix != NULL; fdp++) {
3148 PyObject *item = Py_BuildValue("ssi",
3149 fdp->suffix, fdp->mode, fdp->type);
3150 if (item == NULL) {
3151 Py_DECREF(list);
3152 return NULL;
3153 }
3154 if (PyList_Append(list, item) < 0) {
3155 Py_DECREF(list);
3156 Py_DECREF(item);
3157 return NULL;
3158 }
3159 Py_DECREF(item);
3160 }
3161 return list;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003162}
3163
Guido van Rossum79f25d91997-04-29 20:08:16 +00003164static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003165call_find_module(char *name, PyObject *path)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003166{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003167 extern int fclose(FILE *);
3168 PyObject *fob, *ret;
3169 PyObject *pathobj;
3170 struct filedescr *fdp;
3171 char pathname[MAXPATHLEN+1];
3172 FILE *fp = NULL;
3173 int fd = -1;
3174 char *found_encoding = NULL;
3175 char *encoding = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003176
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003177 pathname[0] = '\0';
3178 if (path == Py_None)
3179 path = NULL;
3180 fdp = find_module(NULL, name, path, pathname, MAXPATHLEN+1, &fp, NULL);
3181 if (fdp == NULL)
3182 return NULL;
3183 if (fp != NULL) {
3184 fd = fileno(fp);
3185 if (fd != -1)
3186 fd = dup(fd);
3187 fclose(fp);
3188 fp = NULL;
3189 }
3190 if (fd != -1) {
3191 if (strchr(fdp->mode, 'b') == NULL) {
3192 /* PyTokenizer_FindEncoding() returns PyMem_MALLOC'ed
3193 memory. */
3194 found_encoding = PyTokenizer_FindEncoding(fd);
3195 lseek(fd, 0, 0); /* Reset position */
3196 if (found_encoding == NULL && PyErr_Occurred())
3197 return NULL;
3198 encoding = (found_encoding != NULL) ? found_encoding :
3199 (char*)PyUnicode_GetDefaultEncoding();
3200 }
3201 fob = PyFile_FromFd(fd, pathname, fdp->mode, -1,
3202 (char*)encoding, NULL, NULL, 1);
3203 if (fob == NULL) {
3204 close(fd);
3205 PyMem_FREE(found_encoding);
3206 return NULL;
3207 }
3208 }
3209 else {
3210 fob = Py_None;
3211 Py_INCREF(fob);
3212 }
3213 pathobj = PyUnicode_DecodeFSDefault(pathname);
3214 ret = Py_BuildValue("NN(ssi)",
3215 fob, pathobj, fdp->suffix, fdp->mode, fdp->type);
3216 PyMem_FREE(found_encoding);
Brett Cannon3bb42d92007-10-20 03:43:15 +00003217
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003218 return ret;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003219}
3220
Guido van Rossum79f25d91997-04-29 20:08:16 +00003221static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003222imp_find_module(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003223{
Victor Stinnerebc00522010-12-03 17:06:43 +00003224 PyObject *name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003225 PyObject *ret, *path = NULL;
Victor Stinnerebc00522010-12-03 17:06:43 +00003226 if (!PyArg_ParseTuple(args, "O&|O:find_module",
3227 PyUnicode_FSConverter, &name,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003228 &path))
3229 return NULL;
Victor Stinnerebc00522010-12-03 17:06:43 +00003230 ret = call_find_module(PyBytes_AS_STRING(name), path);
3231 Py_DECREF(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003232 return ret;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003233}
3234
3235static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003236imp_init_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003237{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003238 char *name;
3239 int ret;
3240 PyObject *m;
3241 if (!PyArg_ParseTuple(args, "s:init_builtin", &name))
3242 return NULL;
3243 ret = init_builtin(name);
3244 if (ret < 0)
3245 return NULL;
3246 if (ret == 0) {
3247 Py_INCREF(Py_None);
3248 return Py_None;
3249 }
3250 m = PyImport_AddModule(name);
3251 Py_XINCREF(m);
3252 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003253}
3254
Guido van Rossum79f25d91997-04-29 20:08:16 +00003255static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003256imp_init_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003257{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003258 char *name;
3259 int ret;
3260 PyObject *m;
3261 if (!PyArg_ParseTuple(args, "s:init_frozen", &name))
3262 return NULL;
3263 ret = PyImport_ImportFrozenModule(name);
3264 if (ret < 0)
3265 return NULL;
3266 if (ret == 0) {
3267 Py_INCREF(Py_None);
3268 return Py_None;
3269 }
3270 m = PyImport_AddModule(name);
3271 Py_XINCREF(m);
3272 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003273}
3274
Guido van Rossum79f25d91997-04-29 20:08:16 +00003275static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003276imp_get_frozen_object(PyObject *self, PyObject *args)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00003277{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003278 char *name;
Jack Jansen95ffa231995-10-03 14:38:41 +00003279
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003280 if (!PyArg_ParseTuple(args, "s:get_frozen_object", &name))
3281 return NULL;
3282 return get_frozen_object(name);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00003283}
3284
Guido van Rossum79f25d91997-04-29 20:08:16 +00003285static PyObject *
Brett Cannon8d110132009-03-15 02:20:16 +00003286imp_is_frozen_package(PyObject *self, PyObject *args)
3287{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003288 char *name;
Brett Cannon8d110132009-03-15 02:20:16 +00003289
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003290 if (!PyArg_ParseTuple(args, "s:is_frozen_package", &name))
3291 return NULL;
3292 return is_frozen_package(name);
Brett Cannon8d110132009-03-15 02:20:16 +00003293}
3294
3295static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003296imp_is_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003297{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003298 char *name;
3299 if (!PyArg_ParseTuple(args, "s:is_builtin", &name))
3300 return NULL;
3301 return PyLong_FromLong(is_builtin(name));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003302}
3303
Guido van Rossum79f25d91997-04-29 20:08:16 +00003304static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003305imp_is_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003306{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003307 char *name;
3308 struct _frozen *p;
3309 if (!PyArg_ParseTuple(args, "s:is_frozen", &name))
3310 return NULL;
3311 p = find_frozen(name);
3312 return PyBool_FromLong((long) (p == NULL ? 0 : p->size));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003313}
3314
3315static FILE *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003316get_file(char *pathname, PyObject *fob, char *mode)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003317{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003318 FILE *fp;
3319 if (mode[0] == 'U')
3320 mode = "r" PY_STDIOTEXTMODE;
3321 if (fob == NULL) {
3322 fp = fopen(pathname, mode);
3323 }
3324 else {
3325 int fd = PyObject_AsFileDescriptor(fob);
3326 if (fd == -1)
3327 return NULL;
3328 if (!_PyVerify_fd(fd))
3329 goto error;
3330 /* the FILE struct gets a new fd, so that it can be closed
3331 * independently of the file descriptor given
3332 */
3333 fd = dup(fd);
3334 if (fd == -1)
3335 goto error;
3336 fp = fdopen(fd, mode);
3337 }
3338 if (fp)
3339 return fp;
Kristján Valur Jónssone1b04452009-03-31 17:43:39 +00003340error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003341 PyErr_SetFromErrno(PyExc_IOError);
3342 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003343}
3344
Guido van Rossum79f25d91997-04-29 20:08:16 +00003345static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003346imp_load_compiled(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003347{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003348 char *name;
Victor Stinnerebc00522010-12-03 17:06:43 +00003349 PyObject *pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003350 PyObject *fob = NULL;
3351 PyObject *m;
3352 FILE *fp;
Victor Stinnerebc00522010-12-03 17:06:43 +00003353 if (!PyArg_ParseTuple(args, "sO&|O:load_compiled",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003354 &name,
Victor Stinnerebc00522010-12-03 17:06:43 +00003355 PyUnicode_FSConverter, &pathname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003356 &fob))
3357 return NULL;
Victor Stinnerebc00522010-12-03 17:06:43 +00003358 fp = get_file(PyBytes_AS_STRING(pathname), fob, "rb");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003359 if (fp == NULL) {
Victor Stinnerebc00522010-12-03 17:06:43 +00003360 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003361 return NULL;
3362 }
Victor Stinnerebc00522010-12-03 17:06:43 +00003363 m = load_compiled_module(name, PyBytes_AS_STRING(pathname), fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003364 fclose(fp);
Victor Stinnerebc00522010-12-03 17:06:43 +00003365 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003366 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003367}
3368
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003369#ifdef HAVE_DYNAMIC_LOADING
3370
Guido van Rossum79f25d91997-04-29 20:08:16 +00003371static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003372imp_load_dynamic(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003373{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003374 char *name;
Victor Stinner8dbf6292010-10-15 12:48:01 +00003375 PyObject *pathbytes;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003376 char *pathname;
3377 PyObject *fob = NULL;
3378 PyObject *m;
3379 FILE *fp = NULL;
Victor Stinner8dbf6292010-10-15 12:48:01 +00003380 if (!PyArg_ParseTuple(args, "sO&|O:load_dynamic",
3381 &name, PyUnicode_FSConverter, &pathbytes, &fob))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003382 return NULL;
Victor Stinner8dbf6292010-10-15 12:48:01 +00003383 pathname = PyBytes_AS_STRING(pathbytes);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003384 if (fob) {
3385 fp = get_file(pathname, fob, "r");
3386 if (fp == NULL) {
Victor Stinner8dbf6292010-10-15 12:48:01 +00003387 Py_DECREF(pathbytes);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003388 return NULL;
3389 }
3390 }
3391 m = _PyImport_LoadDynamicModule(name, pathname, fp);
Victor Stinner8dbf6292010-10-15 12:48:01 +00003392 Py_DECREF(pathbytes);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003393 if (fp)
3394 fclose(fp);
3395 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003396}
3397
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003398#endif /* HAVE_DYNAMIC_LOADING */
3399
Guido van Rossum79f25d91997-04-29 20:08:16 +00003400static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003401imp_load_source(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003402{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003403 char *name;
Victor Stinnerebc00522010-12-03 17:06:43 +00003404 PyObject *pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003405 PyObject *fob = NULL;
3406 PyObject *m;
3407 FILE *fp;
Victor Stinnerebc00522010-12-03 17:06:43 +00003408 if (!PyArg_ParseTuple(args, "sO&|O:load_source",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003409 &name,
Victor Stinnerebc00522010-12-03 17:06:43 +00003410 PyUnicode_FSConverter, &pathname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003411 &fob))
3412 return NULL;
Victor Stinnerebc00522010-12-03 17:06:43 +00003413 fp = get_file(PyBytes_AS_STRING(pathname), fob, "r");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003414 if (fp == NULL) {
Victor Stinnerebc00522010-12-03 17:06:43 +00003415 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003416 return NULL;
3417 }
Victor Stinnerebc00522010-12-03 17:06:43 +00003418 m = load_source_module(name, PyBytes_AS_STRING(pathname), fp);
3419 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003420 fclose(fp);
3421 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003422}
3423
Guido van Rossum79f25d91997-04-29 20:08:16 +00003424static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003425imp_load_module(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003426{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003427 char *name;
3428 PyObject *fob;
Victor Stinner1a563032010-10-15 22:43:10 +00003429 PyObject *pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003430 PyObject * ret;
3431 char *suffix; /* Unused */
3432 char *mode;
3433 int type;
3434 FILE *fp;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003435
Victor Stinner1a563032010-10-15 22:43:10 +00003436 if (!PyArg_ParseTuple(args, "sOO&(ssi):load_module",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003437 &name, &fob,
Victor Stinner1a563032010-10-15 22:43:10 +00003438 PyUnicode_FSConverter, &pathname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003439 &suffix, &mode, &type))
3440 return NULL;
3441 if (*mode) {
3442 /* Mode must start with 'r' or 'U' and must not contain '+'.
3443 Implicit in this test is the assumption that the mode
3444 may contain other modifiers like 'b' or 't'. */
Guido van Rossum5e2c5fa2002-05-30 17:33:07 +00003445
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003446 if (!(*mode == 'r' || *mode == 'U') || strchr(mode, '+')) {
3447 PyErr_Format(PyExc_ValueError,
3448 "invalid file open mode %.200s", mode);
Victor Stinner1a563032010-10-15 22:43:10 +00003449 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003450 return NULL;
3451 }
3452 }
3453 if (fob == Py_None)
3454 fp = NULL;
3455 else {
3456 fp = get_file(NULL, fob, mode);
3457 if (fp == NULL) {
Victor Stinner1a563032010-10-15 22:43:10 +00003458 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003459 return NULL;
3460 }
3461 }
Victor Stinner1a563032010-10-15 22:43:10 +00003462 ret = load_module(name, fp, PyBytes_AS_STRING(pathname), type, NULL);
3463 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003464 if (fp)
3465 fclose(fp);
3466 return ret;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003467}
3468
3469static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003470imp_load_package(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003471{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003472 char *name;
Victor Stinnerebc00522010-12-03 17:06:43 +00003473 PyObject *pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003474 PyObject * ret;
Victor Stinnerebc00522010-12-03 17:06:43 +00003475 if (!PyArg_ParseTuple(args, "sO&:load_package",
3476 &name, PyUnicode_FSConverter, &pathname))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003477 return NULL;
Victor Stinnerebc00522010-12-03 17:06:43 +00003478 ret = load_package(name, PyBytes_AS_STRING(pathname));
3479 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003480 return ret;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003481}
3482
3483static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003484imp_new_module(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003485{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003486 char *name;
3487 if (!PyArg_ParseTuple(args, "s:new_module", &name))
3488 return NULL;
3489 return PyModule_New(name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003490}
3491
Christian Heimes13a7a212008-01-07 17:13:09 +00003492static PyObject *
3493imp_reload(PyObject *self, PyObject *v)
3494{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003495 return PyImport_ReloadModule(v);
Christian Heimes13a7a212008-01-07 17:13:09 +00003496}
3497
3498PyDoc_STRVAR(doc_reload,
3499"reload(module) -> module\n\
3500\n\
3501Reload the module. The module must have been successfully imported before.");
3502
Barry Warsaw28a691b2010-04-17 00:19:56 +00003503static PyObject *
3504imp_cache_from_source(PyObject *self, PyObject *args, PyObject *kws)
3505{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003506 static char *kwlist[] = {"path", "debug_override", NULL};
Barry Warsaw28a691b2010-04-17 00:19:56 +00003507
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003508 char buf[MAXPATHLEN+1];
Victor Stinner3ea23dd2010-10-15 20:34:32 +00003509 PyObject *pathbytes;
3510 char *cpathname;
Benjamin Peterson294a9fc2010-10-16 03:12:39 +00003511 PyObject *debug_override = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003512 int debug = !Py_OptimizeFlag;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003513
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003514 if (!PyArg_ParseTupleAndKeywords(
Victor Stinner3ea23dd2010-10-15 20:34:32 +00003515 args, kws, "O&|O", kwlist,
3516 PyUnicode_FSConverter, &pathbytes, &debug_override))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003517 return NULL;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003518
Benjamin Peterson294a9fc2010-10-16 03:12:39 +00003519 if (debug_override != NULL &&
3520 (debug = PyObject_IsTrue(debug_override)) < 0) {
3521 Py_DECREF(pathbytes);
3522 return NULL;
3523 }
Barry Warsaw28a691b2010-04-17 00:19:56 +00003524
Victor Stinner3ea23dd2010-10-15 20:34:32 +00003525 cpathname = make_compiled_pathname(
3526 PyBytes_AS_STRING(pathbytes),
3527 buf, MAXPATHLEN+1, debug);
3528 Py_DECREF(pathbytes);
Barry Warsaw28a691b2010-04-17 00:19:56 +00003529
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003530 if (cpathname == NULL) {
3531 PyErr_Format(PyExc_SystemError, "path buffer too short");
3532 return NULL;
3533 }
Victor Stinner88bd8912010-10-15 22:46:07 +00003534 return PyUnicode_DecodeFSDefault(buf);
Barry Warsaw28a691b2010-04-17 00:19:56 +00003535}
3536
3537PyDoc_STRVAR(doc_cache_from_source,
Éric Araujo5df11082011-11-03 03:38:44 +01003538"cache_from_source(path, [debug_override]) -> path\n\
3539Given the path to a .py file, return the path to its .pyc/.pyo file.\n\
Barry Warsaw28a691b2010-04-17 00:19:56 +00003540\n\
3541The .py file does not need to exist; this simply returns the path to the\n\
3542.pyc/.pyo file calculated as if the .py file were imported. The extension\n\
3543will be .pyc unless __debug__ is not defined, then it will be .pyo.\n\
3544\n\
3545If debug_override is not None, then it must be a boolean and is taken as\n\
3546the value of __debug__ instead.");
3547
3548static PyObject *
3549imp_source_from_cache(PyObject *self, PyObject *args, PyObject *kws)
3550{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003551 static char *kwlist[] = {"path", NULL};
Barry Warsaw28a691b2010-04-17 00:19:56 +00003552
Victor Stinnerebc00522010-12-03 17:06:43 +00003553 PyObject *pathname_obj;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003554 char *pathname;
3555 char buf[MAXPATHLEN+1];
Barry Warsaw28a691b2010-04-17 00:19:56 +00003556
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003557 if (!PyArg_ParseTupleAndKeywords(
Victor Stinnerebc00522010-12-03 17:06:43 +00003558 args, kws, "O&", kwlist,
3559 PyUnicode_FSConverter, &pathname_obj))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003560 return NULL;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003561
Victor Stinnerebc00522010-12-03 17:06:43 +00003562 pathname = PyBytes_AS_STRING(pathname_obj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003563 if (make_source_pathname(pathname, buf) == NULL) {
3564 PyErr_Format(PyExc_ValueError, "Not a PEP 3147 pyc path: %s",
3565 pathname);
Victor Stinnerebc00522010-12-03 17:06:43 +00003566 Py_DECREF(pathname_obj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003567 return NULL;
3568 }
Victor Stinnerebc00522010-12-03 17:06:43 +00003569 Py_DECREF(pathname_obj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003570 return PyUnicode_FromString(buf);
Barry Warsaw28a691b2010-04-17 00:19:56 +00003571}
3572
3573PyDoc_STRVAR(doc_source_from_cache,
Éric Araujo5df11082011-11-03 03:38:44 +01003574"source_from_cache(path) -> path\n\
3575Given the path to a .pyc./.pyo file, return the path to its .py file.\n\
Barry Warsaw28a691b2010-04-17 00:19:56 +00003576\n\
3577The .pyc/.pyo file does not need to exist; this simply returns the path to\n\
3578the .py file calculated to correspond to the .pyc/.pyo file. If path\n\
3579does not conform to PEP 3147 format, ValueError will be raised.");
3580
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003581/* Doc strings */
3582
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003583PyDoc_STRVAR(doc_imp,
3584"This module provides the components needed to build your own\n\
3585__import__ function. Undocumented functions are obsolete.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003586
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003587PyDoc_STRVAR(doc_find_module,
3588"find_module(name, [path]) -> (file, filename, (suffix, mode, type))\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003589Search for a module. If path is omitted or None, search for a\n\
3590built-in, frozen or special module and continue search in sys.path.\n\
3591The module name cannot contain '.'; to search for a submodule of a\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003592package, pass the submodule name and the package's __path__.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003593
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003594PyDoc_STRVAR(doc_load_module,
3595"load_module(name, file, filename, (suffix, mode, type)) -> module\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003596Load a module, given information returned by find_module().\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003597The module name must include the full package name, if any.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003598
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003599PyDoc_STRVAR(doc_get_magic,
3600"get_magic() -> string\n\
3601Return the magic number for .pyc or .pyo files.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003602
Barry Warsaw28a691b2010-04-17 00:19:56 +00003603PyDoc_STRVAR(doc_get_tag,
3604"get_tag() -> string\n\
3605Return the magic tag for .pyc or .pyo files.");
3606
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003607PyDoc_STRVAR(doc_get_suffixes,
3608"get_suffixes() -> [(suffix, mode, type), ...]\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003609Return a list of (suffix, mode, type) tuples describing the files\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003610that find_module() looks for.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003611
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003612PyDoc_STRVAR(doc_new_module,
3613"new_module(name) -> module\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003614Create a new module. Do not enter it in sys.modules.\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003615The module name must include the full package name, if any.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003616
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003617PyDoc_STRVAR(doc_lock_held,
Tim Petersa7c65092004-08-01 23:26:05 +00003618"lock_held() -> boolean\n\
3619Return True if the import lock is currently held, else False.\n\
3620On platforms without threads, return False.");
Tim Peters69232342001-08-30 05:16:13 +00003621
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00003622PyDoc_STRVAR(doc_acquire_lock,
3623"acquire_lock() -> None\n\
Neal Norwitz2294c0d2003-02-12 23:02:21 +00003624Acquires the interpreter's import lock for the current thread.\n\
3625This lock should be used by import hooks to ensure thread-safety\n\
3626when importing modules.\n\
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00003627On platforms without threads, this function does nothing.");
3628
3629PyDoc_STRVAR(doc_release_lock,
3630"release_lock() -> None\n\
3631Release the interpreter's import lock.\n\
3632On platforms without threads, this function does nothing.");
3633
Guido van Rossum79f25d91997-04-29 20:08:16 +00003634static PyMethodDef imp_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003635 {"find_module", imp_find_module, METH_VARARGS, doc_find_module},
3636 {"get_magic", imp_get_magic, METH_NOARGS, doc_get_magic},
3637 {"get_tag", imp_get_tag, METH_NOARGS, doc_get_tag},
3638 {"get_suffixes", imp_get_suffixes, METH_NOARGS, doc_get_suffixes},
3639 {"load_module", imp_load_module, METH_VARARGS, doc_load_module},
3640 {"new_module", imp_new_module, METH_VARARGS, doc_new_module},
3641 {"lock_held", imp_lock_held, METH_NOARGS, doc_lock_held},
3642 {"acquire_lock", imp_acquire_lock, METH_NOARGS, doc_acquire_lock},
3643 {"release_lock", imp_release_lock, METH_NOARGS, doc_release_lock},
3644 {"reload", imp_reload, METH_O, doc_reload},
3645 {"cache_from_source", (PyCFunction)imp_cache_from_source,
3646 METH_VARARGS | METH_KEYWORDS, doc_cache_from_source},
3647 {"source_from_cache", (PyCFunction)imp_source_from_cache,
3648 METH_VARARGS | METH_KEYWORDS, doc_source_from_cache},
3649 /* The rest are obsolete */
3650 {"get_frozen_object", imp_get_frozen_object, METH_VARARGS},
3651 {"is_frozen_package", imp_is_frozen_package, METH_VARARGS},
3652 {"init_builtin", imp_init_builtin, METH_VARARGS},
3653 {"init_frozen", imp_init_frozen, METH_VARARGS},
3654 {"is_builtin", imp_is_builtin, METH_VARARGS},
3655 {"is_frozen", imp_is_frozen, METH_VARARGS},
3656 {"load_compiled", imp_load_compiled, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003657#ifdef HAVE_DYNAMIC_LOADING
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003658 {"load_dynamic", imp_load_dynamic, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003659#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003660 {"load_package", imp_load_package, METH_VARARGS},
3661 {"load_source", imp_load_source, METH_VARARGS},
3662 {NULL, NULL} /* sentinel */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003663};
3664
Guido van Rossum1a8791e1998-08-04 22:46:29 +00003665static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003666setint(PyObject *d, char *name, int value)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003667{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003668 PyObject *v;
3669 int err;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003670
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003671 v = PyLong_FromLong((long)value);
3672 err = PyDict_SetItemString(d, name, v);
3673 Py_XDECREF(v);
3674 return err;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003675}
3676
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003677typedef struct {
3678 PyObject_HEAD
3679} NullImporter;
3680
3681static int
3682NullImporter_init(NullImporter *self, PyObject *args, PyObject *kwds)
3683{
Victor Stinner1a4d12d2010-08-13 13:07:29 +00003684#ifndef MS_WINDOWS
3685 PyObject *path;
3686 struct stat statbuf;
3687 int rv;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003688
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003689 if (!_PyArg_NoKeywords("NullImporter()", kwds))
3690 return -1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003691
Victor Stinner1a4d12d2010-08-13 13:07:29 +00003692 if (!PyArg_ParseTuple(args, "O&:NullImporter",
3693 PyUnicode_FSConverter, &path))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003694 return -1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003695
Victor Stinner1a4d12d2010-08-13 13:07:29 +00003696 if (PyBytes_GET_SIZE(path) == 0) {
3697 Py_DECREF(path);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003698 PyErr_SetString(PyExc_ImportError, "empty pathname");
3699 return -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003700 }
Victor Stinner1a4d12d2010-08-13 13:07:29 +00003701
3702 rv = stat(PyBytes_AS_STRING(path), &statbuf);
3703 Py_DECREF(path);
3704 if (rv == 0) {
3705 /* it exists */
3706 if (S_ISDIR(statbuf.st_mode)) {
3707 /* it's a directory */
3708 PyErr_SetString(PyExc_ImportError, "existing directory");
3709 return -1;
3710 }
3711 }
3712#else /* MS_WINDOWS */
3713 PyObject *pathobj;
3714 DWORD rv;
Victor Stinner255dfdb2010-09-29 10:28:51 +00003715 wchar_t *path;
Victor Stinner1a4d12d2010-08-13 13:07:29 +00003716
3717 if (!_PyArg_NoKeywords("NullImporter()", kwds))
3718 return -1;
3719
3720 if (!PyArg_ParseTuple(args, "U:NullImporter",
3721 &pathobj))
3722 return -1;
3723
3724 if (PyUnicode_GET_SIZE(pathobj) == 0) {
3725 PyErr_SetString(PyExc_ImportError, "empty pathname");
3726 return -1;
3727 }
3728
Victor Stinnerbeb4135b2010-10-07 01:02:42 +00003729 path = PyUnicode_AsWideCharString(pathobj, NULL);
Victor Stinner255dfdb2010-09-29 10:28:51 +00003730 if (path == NULL)
Victor Stinner1a4d12d2010-08-13 13:07:29 +00003731 return -1;
3732 /* see issue1293 and issue3677:
3733 * stat() on Windows doesn't recognise paths like
3734 * "e:\\shared\\" and "\\\\whiterab-c2znlh\\shared" as dirs.
3735 */
3736 rv = GetFileAttributesW(path);
Victor Stinner255dfdb2010-09-29 10:28:51 +00003737 PyMem_Free(path);
Victor Stinner1a4d12d2010-08-13 13:07:29 +00003738 if (rv != INVALID_FILE_ATTRIBUTES) {
3739 /* it exists */
3740 if (rv & FILE_ATTRIBUTE_DIRECTORY) {
3741 /* it's a directory */
3742 PyErr_SetString(PyExc_ImportError, "existing directory");
3743 return -1;
3744 }
3745 }
3746#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003747 return 0;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003748}
3749
3750static PyObject *
3751NullImporter_find_module(NullImporter *self, PyObject *args)
3752{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003753 Py_RETURN_NONE;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003754}
3755
3756static PyMethodDef NullImporter_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003757 {"find_module", (PyCFunction)NullImporter_find_module, METH_VARARGS,
3758 "Always return None"
3759 },
3760 {NULL} /* Sentinel */
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003761};
3762
3763
Christian Heimes9cd17752007-11-18 19:35:23 +00003764PyTypeObject PyNullImporter_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003765 PyVarObject_HEAD_INIT(NULL, 0)
3766 "imp.NullImporter", /*tp_name*/
3767 sizeof(NullImporter), /*tp_basicsize*/
3768 0, /*tp_itemsize*/
3769 0, /*tp_dealloc*/
3770 0, /*tp_print*/
3771 0, /*tp_getattr*/
3772 0, /*tp_setattr*/
3773 0, /*tp_reserved*/
3774 0, /*tp_repr*/
3775 0, /*tp_as_number*/
3776 0, /*tp_as_sequence*/
3777 0, /*tp_as_mapping*/
3778 0, /*tp_hash */
3779 0, /*tp_call*/
3780 0, /*tp_str*/
3781 0, /*tp_getattro*/
3782 0, /*tp_setattro*/
3783 0, /*tp_as_buffer*/
3784 Py_TPFLAGS_DEFAULT, /*tp_flags*/
3785 "Null importer object", /* tp_doc */
3786 0, /* tp_traverse */
3787 0, /* tp_clear */
3788 0, /* tp_richcompare */
3789 0, /* tp_weaklistoffset */
3790 0, /* tp_iter */
3791 0, /* tp_iternext */
3792 NullImporter_methods, /* tp_methods */
3793 0, /* tp_members */
3794 0, /* tp_getset */
3795 0, /* tp_base */
3796 0, /* tp_dict */
3797 0, /* tp_descr_get */
3798 0, /* tp_descr_set */
3799 0, /* tp_dictoffset */
3800 (initproc)NullImporter_init, /* tp_init */
3801 0, /* tp_alloc */
3802 PyType_GenericNew /* tp_new */
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003803};
3804
Martin v. Löwis1a214512008-06-11 05:26:20 +00003805static struct PyModuleDef impmodule = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003806 PyModuleDef_HEAD_INIT,
3807 "imp",
3808 doc_imp,
3809 0,
3810 imp_methods,
3811 NULL,
3812 NULL,
3813 NULL,
3814 NULL
Martin v. Löwis1a214512008-06-11 05:26:20 +00003815};
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003816
Jason Tishler6bc06ec2003-09-04 11:59:50 +00003817PyMODINIT_FUNC
Martin v. Löwis1a214512008-06-11 05:26:20 +00003818PyInit_imp(void)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003819{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003820 PyObject *m, *d;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003821
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003822 if (PyType_Ready(&PyNullImporter_Type) < 0)
3823 return NULL;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003824
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003825 m = PyModule_Create(&impmodule);
3826 if (m == NULL)
3827 goto failure;
3828 d = PyModule_GetDict(m);
3829 if (d == NULL)
3830 goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003831
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003832 if (setint(d, "SEARCH_ERROR", SEARCH_ERROR) < 0) goto failure;
3833 if (setint(d, "PY_SOURCE", PY_SOURCE) < 0) goto failure;
3834 if (setint(d, "PY_COMPILED", PY_COMPILED) < 0) goto failure;
3835 if (setint(d, "C_EXTENSION", C_EXTENSION) < 0) goto failure;
3836 if (setint(d, "PY_RESOURCE", PY_RESOURCE) < 0) goto failure;
3837 if (setint(d, "PKG_DIRECTORY", PKG_DIRECTORY) < 0) goto failure;
3838 if (setint(d, "C_BUILTIN", C_BUILTIN) < 0) goto failure;
3839 if (setint(d, "PY_FROZEN", PY_FROZEN) < 0) goto failure;
3840 if (setint(d, "PY_CODERESOURCE", PY_CODERESOURCE) < 0) goto failure;
3841 if (setint(d, "IMP_HOOK", IMP_HOOK) < 0) goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003842
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003843 Py_INCREF(&PyNullImporter_Type);
3844 PyModule_AddObject(m, "NullImporter", (PyObject *)&PyNullImporter_Type);
3845 return m;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003846 failure:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003847 Py_XDECREF(m);
3848 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003849}
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003850
3851
Guido van Rossumb18618d2000-05-03 23:44:39 +00003852/* API for embedding applications that want to add their own entries
3853 to the table of built-in modules. This should normally be called
3854 *before* Py_Initialize(). When the table resize fails, -1 is
3855 returned and the existing table is unchanged.
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003856
3857 After a similar function by Just van Rossum. */
3858
3859int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003860PyImport_ExtendInittab(struct _inittab *newtab)
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003861{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003862 static struct _inittab *our_copy = NULL;
3863 struct _inittab *p;
3864 int i, n;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003865
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003866 /* Count the number of entries in both tables */
3867 for (n = 0; newtab[n].name != NULL; n++)
3868 ;
3869 if (n == 0)
3870 return 0; /* Nothing to do */
3871 for (i = 0; PyImport_Inittab[i].name != NULL; i++)
3872 ;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003873
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003874 /* Allocate new memory for the combined table */
3875 p = our_copy;
3876 PyMem_RESIZE(p, struct _inittab, i+n+1);
3877 if (p == NULL)
3878 return -1;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003879
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003880 /* Copy the tables into the new memory */
3881 if (our_copy != PyImport_Inittab)
3882 memcpy(p, PyImport_Inittab, (i+1) * sizeof(struct _inittab));
3883 PyImport_Inittab = our_copy = p;
3884 memcpy(p+i, newtab, (n+1) * sizeof(struct _inittab));
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003885
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003886 return 0;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003887}
3888
3889/* Shorthand to add a single entry given a name and a function */
3890
3891int
Brett Cannona826f322009-04-02 03:41:46 +00003892PyImport_AppendInittab(const char *name, PyObject* (*initfunc)(void))
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003893{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003894 struct _inittab newtab[2];
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003895
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003896 memset(newtab, '\0', sizeof newtab);
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003897
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003898 newtab[0].name = (char *)name;
3899 newtab[0].initfunc = initfunc;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003900
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003901 return PyImport_ExtendInittab(newtab);
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003902}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00003903
3904#ifdef __cplusplus
3905}
3906#endif