blob: ee3f9b0682f91c1c16320ce785abcce55a40d30d [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 }
1229 /* Now write the true mtime */
1230 fseek(fp, 4L, 0);
1231 assert(mtime < LONG_MAX);
1232 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 }
Fred Drake4c82b232000-06-30 16:18:57 +00001305#if SIZEOF_TIME_T > 4
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001306 /* Python's .pyc timestamp handling presumes that the timestamp fits
1307 in 4 bytes. This will be fine until sometime in the year 2038,
1308 when a 4-byte signed time_t will overflow.
1309 */
1310 if (st.st_mtime >> 32) {
1311 PyErr_SetString(PyExc_OverflowError,
1312 "modification time overflows a 4 byte field");
1313 return NULL;
1314 }
Fred Drake4c82b232000-06-30 16:18:57 +00001315#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001316 cpathname = make_compiled_pathname(
1317 pathname, buf, (size_t)MAXPATHLEN + 1, !Py_OptimizeFlag);
1318 if (cpathname != NULL &&
1319 (fpc = check_compiled_module(pathname, st.st_mtime, cpathname))) {
1320 co = read_compiled_module(cpathname, fpc);
1321 fclose(fpc);
1322 if (co == NULL)
1323 return NULL;
1324 if (update_compiled_module(co, pathname) < 0)
1325 return NULL;
1326 if (Py_VerboseFlag)
1327 PySys_WriteStderr("import %s # precompiled from %s\n",
1328 name, cpathname);
1329 pathname = cpathname;
1330 }
1331 else {
1332 co = parse_source_module(pathname, fp);
1333 if (co == NULL)
1334 return NULL;
1335 if (Py_VerboseFlag)
1336 PySys_WriteStderr("import %s # from %s\n",
1337 name, pathname);
1338 if (cpathname) {
1339 PyObject *ro = PySys_GetObject("dont_write_bytecode");
1340 if (ro == NULL || !PyObject_IsTrue(ro))
1341 write_compiled_module(co, cpathname, &st);
1342 }
1343 }
1344 m = PyImport_ExecCodeModuleWithPathnames(
1345 name, (PyObject *)co, pathname, cpathname);
1346 Py_DECREF(co);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001347
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001348 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001349}
1350
Christian Heimes3b06e532008-01-07 20:12:44 +00001351/* Get source file -> unicode or None
1352 * Returns the path to the py file if available, else the given path
1353 */
1354static PyObject *
Barry Warsaw28a691b2010-04-17 00:19:56 +00001355get_sourcefile(char *file)
Christian Heimes3b06e532008-01-07 20:12:44 +00001356{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001357 char py[MAXPATHLEN + 1];
1358 Py_ssize_t len;
1359 PyObject *u;
1360 struct stat statbuf;
Christian Heimes3b06e532008-01-07 20:12:44 +00001361
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001362 if (!file || !*file) {
1363 Py_RETURN_NONE;
1364 }
Christian Heimes3b06e532008-01-07 20:12:44 +00001365
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001366 len = strlen(file);
1367 /* match '*.py?' */
1368 if (len > MAXPATHLEN || PyOS_strnicmp(&file[len-4], ".py", 3) != 0) {
1369 return PyUnicode_DecodeFSDefault(file);
1370 }
Christian Heimes3b06e532008-01-07 20:12:44 +00001371
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001372 /* Start by trying to turn PEP 3147 path into source path. If that
1373 * fails, just chop off the trailing character, i.e. legacy pyc path
1374 * to py.
1375 */
1376 if (make_source_pathname(file, py) == NULL) {
1377 strncpy(py, file, len-1);
1378 py[len-1] = '\0';
1379 }
Barry Warsaw28a691b2010-04-17 00:19:56 +00001380
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001381 if (stat(py, &statbuf) == 0 &&
1382 S_ISREG(statbuf.st_mode)) {
1383 u = PyUnicode_DecodeFSDefault(py);
1384 }
1385 else {
1386 u = PyUnicode_DecodeFSDefault(file);
1387 }
1388 return u;
Christian Heimes3b06e532008-01-07 20:12:44 +00001389}
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001390
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001391/* Forward */
Just van Rossum52e14d62002-12-30 22:08:05 +00001392static PyObject *load_module(char *, FILE *, char *, int, PyObject *);
1393static struct filedescr *find_module(char *, char *, PyObject *,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001394 char *, size_t, FILE **, PyObject **);
Christian Heimes3b06e532008-01-07 20:12:44 +00001395static struct _frozen * find_frozen(char *);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001396
1397/* Load a package and return its module object WITH INCREMENTED
1398 REFERENCE COUNT */
1399
1400static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001401load_package(char *name, char *pathname)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001402{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001403 PyObject *m, *d;
1404 PyObject *file = NULL;
1405 PyObject *path = NULL;
1406 int err;
1407 char buf[MAXPATHLEN+1];
1408 FILE *fp = NULL;
1409 struct filedescr *fdp;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001410
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001411 m = PyImport_AddModule(name);
1412 if (m == NULL)
1413 return NULL;
1414 if (Py_VerboseFlag)
1415 PySys_WriteStderr("import %s # directory %s\n",
1416 name, pathname);
1417 d = PyModule_GetDict(m);
1418 file = get_sourcefile(pathname);
1419 if (file == NULL)
1420 goto error;
1421 path = Py_BuildValue("[O]", file);
1422 if (path == NULL)
1423 goto error;
1424 err = PyDict_SetItemString(d, "__file__", file);
1425 if (err == 0)
1426 err = PyDict_SetItemString(d, "__path__", path);
1427 if (err != 0)
1428 goto error;
1429 buf[0] = '\0';
1430 fdp = find_module(name, "__init__", path, buf, sizeof(buf), &fp, NULL);
1431 if (fdp == NULL) {
1432 if (PyErr_ExceptionMatches(PyExc_ImportError)) {
1433 PyErr_Clear();
1434 Py_INCREF(m);
1435 }
1436 else
1437 m = NULL;
1438 goto cleanup;
1439 }
1440 m = load_module(name, fp, buf, fdp->type, NULL);
1441 if (fp != NULL)
1442 fclose(fp);
1443 goto cleanup;
Tim Peters1cd70172004-08-02 03:52:12 +00001444
1445 error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001446 m = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001447 cleanup:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001448 Py_XDECREF(path);
1449 Py_XDECREF(file);
1450 return m;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001451}
1452
1453
1454/* Helper to test for built-in module */
1455
1456static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001457is_builtin(char *name)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001458{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001459 int i;
1460 for (i = 0; PyImport_Inittab[i].name != NULL; i++) {
1461 if (strcmp(name, PyImport_Inittab[i].name) == 0) {
1462 if (PyImport_Inittab[i].initfunc == NULL)
1463 return -1;
1464 else
1465 return 1;
1466 }
1467 }
1468 return 0;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001469}
1470
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001471
Just van Rossum52e14d62002-12-30 22:08:05 +00001472/* Return an importer object for a sys.path/pkg.__path__ item 'p',
1473 possibly by fetching it from the path_importer_cache dict. If it
Thomas Wouters89f507f2006-12-13 04:49:30 +00001474 wasn't yet cached, traverse path_hooks until a hook is found
Just van Rossum52e14d62002-12-30 22:08:05 +00001475 that can handle the path item. Return None if no hook could;
1476 this tells our caller it should fall back to the builtin
1477 import mechanism. Cache the result in path_importer_cache.
1478 Returns a borrowed reference. */
1479
1480static PyObject *
1481get_path_importer(PyObject *path_importer_cache, PyObject *path_hooks,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001482 PyObject *p)
Just van Rossum52e14d62002-12-30 22:08:05 +00001483{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001484 PyObject *importer;
1485 Py_ssize_t j, nhooks;
Just van Rossum52e14d62002-12-30 22:08:05 +00001486
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001487 /* These conditions are the caller's responsibility: */
1488 assert(PyList_Check(path_hooks));
1489 assert(PyDict_Check(path_importer_cache));
Just van Rossum52e14d62002-12-30 22:08:05 +00001490
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001491 nhooks = PyList_Size(path_hooks);
1492 if (nhooks < 0)
1493 return NULL; /* Shouldn't happen */
Just van Rossum52e14d62002-12-30 22:08:05 +00001494
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001495 importer = PyDict_GetItem(path_importer_cache, p);
1496 if (importer != NULL)
1497 return importer;
Just van Rossum52e14d62002-12-30 22:08:05 +00001498
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001499 /* set path_importer_cache[p] to None to avoid recursion */
1500 if (PyDict_SetItem(path_importer_cache, p, Py_None) != 0)
1501 return NULL;
Just van Rossum52e14d62002-12-30 22:08:05 +00001502
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001503 for (j = 0; j < nhooks; j++) {
1504 PyObject *hook = PyList_GetItem(path_hooks, j);
1505 if (hook == NULL)
1506 return NULL;
1507 importer = PyObject_CallFunctionObjArgs(hook, p, NULL);
1508 if (importer != NULL)
1509 break;
Just van Rossum52e14d62002-12-30 22:08:05 +00001510
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001511 if (!PyErr_ExceptionMatches(PyExc_ImportError)) {
1512 return NULL;
1513 }
1514 PyErr_Clear();
1515 }
1516 if (importer == NULL) {
1517 importer = PyObject_CallFunctionObjArgs(
1518 (PyObject *)&PyNullImporter_Type, p, NULL
1519 );
1520 if (importer == NULL) {
1521 if (PyErr_ExceptionMatches(PyExc_ImportError)) {
1522 PyErr_Clear();
1523 return Py_None;
1524 }
1525 }
1526 }
1527 if (importer != NULL) {
1528 int err = PyDict_SetItem(path_importer_cache, p, importer);
1529 Py_DECREF(importer);
1530 if (err != 0)
1531 return NULL;
1532 }
1533 return importer;
Just van Rossum52e14d62002-12-30 22:08:05 +00001534}
1535
Christian Heimes9cd17752007-11-18 19:35:23 +00001536PyAPI_FUNC(PyObject *)
1537PyImport_GetImporter(PyObject *path) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001538 PyObject *importer=NULL, *path_importer_cache=NULL, *path_hooks=NULL;
Christian Heimes9cd17752007-11-18 19:35:23 +00001539
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001540 if ((path_importer_cache = PySys_GetObject("path_importer_cache"))) {
1541 if ((path_hooks = PySys_GetObject("path_hooks"))) {
1542 importer = get_path_importer(path_importer_cache,
1543 path_hooks, path);
1544 }
1545 }
1546 Py_XINCREF(importer); /* get_path_importer returns a borrowed reference */
1547 return importer;
Christian Heimes9cd17752007-11-18 19:35:23 +00001548}
1549
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001550/* Search the path (default sys.path) for a module. Return the
1551 corresponding filedescr struct, and (via return arguments) the
1552 pathname and an open file. Return NULL if the module is not found. */
1553
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001554#ifdef MS_COREDLL
Thomas Woutersb4bd21c2000-07-22 23:38:01 +00001555extern FILE *PyWin_FindRegisteredModule(const char *, struct filedescr **,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001556 char *, Py_ssize_t);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001557#endif
1558
Martin v. Löwis18e16552006-02-15 17:27:45 +00001559static int case_ok(char *, Py_ssize_t, Py_ssize_t, char *);
Tim Petersdbd9ba62000-07-09 03:09:57 +00001560static int find_init_module(char *); /* Forward */
Just van Rossum52e14d62002-12-30 22:08:05 +00001561static struct filedescr importhookdescr = {"", "", IMP_HOOK};
Guido van Rossum197346f1997-10-31 18:38:52 +00001562
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001563static struct filedescr *
Just van Rossum52e14d62002-12-30 22:08:05 +00001564find_module(char *fullname, char *subname, PyObject *path, char *buf,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001565 size_t buflen, FILE **p_fp, PyObject **p_loader)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001566{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001567 Py_ssize_t i, npath;
1568 size_t len, namelen;
1569 struct filedescr *fdp = NULL;
1570 char *filemode;
1571 FILE *fp = NULL;
1572 PyObject *path_hooks, *path_importer_cache;
1573 struct stat statbuf;
1574 static struct filedescr fd_frozen = {"", "", PY_FROZEN};
1575 static struct filedescr fd_builtin = {"", "", C_BUILTIN};
1576 static struct filedescr fd_package = {"", "", PKG_DIRECTORY};
1577 char name[MAXPATHLEN+1];
Andrew MacIntyred9400542002-02-26 11:41:34 +00001578#if defined(PYOS_OS2)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001579 size_t saved_len;
1580 size_t saved_namelen;
1581 char *saved_buf = NULL;
Andrew MacIntyred9400542002-02-26 11:41:34 +00001582#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001583 if (p_loader != NULL)
1584 *p_loader = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001585
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001586 if (strlen(subname) > MAXPATHLEN) {
1587 PyErr_SetString(PyExc_OverflowError,
1588 "module name is too long");
1589 return NULL;
1590 }
1591 strcpy(name, subname);
Just van Rossum52e14d62002-12-30 22:08:05 +00001592
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001593 /* sys.meta_path import hook */
1594 if (p_loader != NULL) {
1595 PyObject *meta_path;
Just van Rossum52e14d62002-12-30 22:08:05 +00001596
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001597 meta_path = PySys_GetObject("meta_path");
1598 if (meta_path == NULL || !PyList_Check(meta_path)) {
Victor Stinner16191322011-09-15 19:28:05 +02001599 PyErr_SetString(PyExc_RuntimeError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001600 "sys.meta_path must be a list of "
1601 "import hooks");
1602 return NULL;
1603 }
1604 Py_INCREF(meta_path); /* zap guard */
1605 npath = PyList_Size(meta_path);
1606 for (i = 0; i < npath; i++) {
1607 PyObject *loader;
1608 PyObject *hook = PyList_GetItem(meta_path, i);
1609 loader = PyObject_CallMethod(hook, "find_module",
1610 "sO", fullname,
1611 path != NULL ?
1612 path : Py_None);
1613 if (loader == NULL) {
1614 Py_DECREF(meta_path);
1615 return NULL; /* true error */
1616 }
1617 if (loader != Py_None) {
1618 /* a loader was found */
1619 *p_loader = loader;
1620 Py_DECREF(meta_path);
1621 return &importhookdescr;
1622 }
1623 Py_DECREF(loader);
1624 }
1625 Py_DECREF(meta_path);
1626 }
Guido van Rossum0506a431998-08-11 15:07:39 +00001627
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001628 if (find_frozen(fullname) != NULL) {
1629 strcpy(buf, fullname);
1630 return &fd_frozen;
1631 }
Benjamin Petersond968e272008-11-05 22:48:33 +00001632
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001633 if (path == NULL) {
1634 if (is_builtin(name)) {
1635 strcpy(buf, name);
1636 return &fd_builtin;
1637 }
Guido van Rossumac279101996-08-22 23:10:58 +00001638#ifdef MS_COREDLL
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001639 fp = PyWin_FindRegisteredModule(name, &fdp, buf, buflen);
1640 if (fp != NULL) {
1641 *p_fp = fp;
1642 return fdp;
1643 }
Guido van Rossuma5a3db71996-04-09 02:39:59 +00001644#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001645 path = PySys_GetObject("path");
1646 }
Benjamin Petersond968e272008-11-05 22:48:33 +00001647
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001648 if (path == NULL || !PyList_Check(path)) {
Victor Stinner16191322011-09-15 19:28:05 +02001649 PyErr_SetString(PyExc_RuntimeError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001650 "sys.path must be a list of directory names");
1651 return NULL;
1652 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001653
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001654 path_hooks = PySys_GetObject("path_hooks");
1655 if (path_hooks == NULL || !PyList_Check(path_hooks)) {
Victor Stinner16191322011-09-15 19:28:05 +02001656 PyErr_SetString(PyExc_RuntimeError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001657 "sys.path_hooks must be a list of "
1658 "import hooks");
1659 return NULL;
1660 }
1661 path_importer_cache = PySys_GetObject("path_importer_cache");
1662 if (path_importer_cache == NULL ||
1663 !PyDict_Check(path_importer_cache)) {
Victor Stinner16191322011-09-15 19:28:05 +02001664 PyErr_SetString(PyExc_RuntimeError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001665 "sys.path_importer_cache must be a dict");
1666 return NULL;
1667 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001668
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001669 npath = PyList_Size(path);
1670 namelen = strlen(name);
1671 for (i = 0; i < npath; i++) {
1672 PyObject *v = PyList_GetItem(path, i);
1673 PyObject *origv = v;
1674 const char *base;
1675 Py_ssize_t size;
1676 if (!v)
1677 return NULL;
1678 if (PyUnicode_Check(v)) {
Victor Stinnerae6265f2010-05-15 16:27:27 +00001679 v = PyUnicode_EncodeFSDefault(v);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001680 if (v == NULL)
1681 return NULL;
1682 }
1683 else if (!PyBytes_Check(v))
1684 continue;
1685 else
1686 Py_INCREF(v);
Amaury Forgeot d'Arcf1ca0b12008-06-11 17:40:47 +00001687
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001688 base = PyBytes_AS_STRING(v);
1689 size = PyBytes_GET_SIZE(v);
1690 len = size;
1691 if (len + 2 + namelen + MAXSUFFIXSIZE >= buflen) {
1692 Py_DECREF(v);
1693 continue; /* Too long */
1694 }
1695 strcpy(buf, base);
1696 Py_DECREF(v);
Amaury Forgeot d'Arcf1ca0b12008-06-11 17:40:47 +00001697
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001698 if (strlen(buf) != len) {
1699 continue; /* v contains '\0' */
1700 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001701
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001702 /* sys.path_hooks import hook */
1703 if (p_loader != NULL) {
1704 PyObject *importer;
Just van Rossum52e14d62002-12-30 22:08:05 +00001705
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001706 importer = get_path_importer(path_importer_cache,
1707 path_hooks, origv);
1708 if (importer == NULL) {
1709 return NULL;
1710 }
1711 /* Note: importer is a borrowed reference */
1712 if (importer != Py_None) {
1713 PyObject *loader;
1714 loader = PyObject_CallMethod(importer,
1715 "find_module",
1716 "s", fullname);
1717 if (loader == NULL)
1718 return NULL; /* error */
1719 if (loader != Py_None) {
1720 /* a loader was found */
1721 *p_loader = loader;
1722 return &importhookdescr;
1723 }
1724 Py_DECREF(loader);
1725 continue;
1726 }
1727 }
1728 /* no hook was found, use builtin import */
Just van Rossum52e14d62002-12-30 22:08:05 +00001729
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001730 if (len > 0 && buf[len-1] != SEP
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001731#ifdef ALTSEP
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001732 && buf[len-1] != ALTSEP
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001733#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001734 )
1735 buf[len++] = SEP;
1736 strcpy(buf+len, name);
1737 len += namelen;
Tim Peters50d8d372001-02-28 05:34:27 +00001738
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001739 /* Check for package import (buf holds a directory name,
1740 and there's an __init__ module in that directory */
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001741#ifdef HAVE_STAT
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001742 if (stat(buf, &statbuf) == 0 && /* it exists */
1743 S_ISDIR(statbuf.st_mode) && /* it's a directory */
1744 case_ok(buf, len, namelen, name)) { /* case matches */
1745 if (find_init_module(buf)) { /* and has __init__.py */
1746 return &fd_package;
1747 }
1748 else {
Victor Stinnered7916d2010-10-17 02:07:09 +00001749 int err;
1750 PyObject *unicode = PyUnicode_DecodeFSDefault(buf);
1751 if (unicode == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001752 return NULL;
Victor Stinnered7916d2010-10-17 02:07:09 +00001753 err = PyErr_WarnFormat(PyExc_ImportWarning, 1,
1754 "Not importing directory '%U': missing __init__.py",
1755 unicode);
1756 Py_DECREF(unicode);
1757 if (err)
1758 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001759 }
1760 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001761#endif
Andrew MacIntyred9400542002-02-26 11:41:34 +00001762#if defined(PYOS_OS2)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001763 /* take a snapshot of the module spec for restoration
1764 * after the 8 character DLL hackery
1765 */
1766 saved_buf = strdup(buf);
1767 saved_len = len;
1768 saved_namelen = namelen;
Andrew MacIntyred9400542002-02-26 11:41:34 +00001769#endif /* PYOS_OS2 */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001770 for (fdp = _PyImport_Filetab; fdp->suffix != NULL; fdp++) {
Victor Stinner53ffdc52011-09-23 18:54:40 +02001771 struct stat statbuf;
Guido van Rossum04110fb2007-08-24 16:32:05 +00001772#if defined(PYOS_OS2) && defined(HAVE_DYNAMIC_LOADING)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001773 /* OS/2 limits DLLs to 8 character names (w/o
1774 extension)
1775 * so if the name is longer than that and its a
1776 * dynamically loaded module we're going to try,
1777 * truncate the name before trying
1778 */
1779 if (strlen(subname) > 8) {
1780 /* is this an attempt to load a C extension? */
1781 const struct filedescr *scan;
1782 scan = _PyImport_DynLoadFiletab;
1783 while (scan->suffix != NULL) {
1784 if (!strcmp(scan->suffix, fdp->suffix))
1785 break;
1786 else
1787 scan++;
1788 }
1789 if (scan->suffix != NULL) {
1790 /* yes, so truncate the name */
1791 namelen = 8;
1792 len -= strlen(subname) - namelen;
1793 buf[len] = '\0';
1794 }
1795 }
Andrew MacIntyred9400542002-02-26 11:41:34 +00001796#endif /* PYOS_OS2 */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001797 strcpy(buf+len, fdp->suffix);
1798 if (Py_VerboseFlag > 1)
1799 PySys_WriteStderr("# trying %s\n", buf);
Victor Stinner53ffdc52011-09-23 18:54:40 +02001800
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001801 filemode = fdp->mode;
1802 if (filemode[0] == 'U')
1803 filemode = "r" PY_STDIOTEXTMODE;
Victor Stinner53ffdc52011-09-23 18:54:40 +02001804
1805 if (stat(buf, &statbuf) == 0 && S_ISDIR(statbuf.st_mode))
1806 /* it's a directory */
1807 fp = NULL;
1808 else
1809 fp = fopen(buf, filemode);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001810 if (fp != NULL) {
1811 if (case_ok(buf, len, namelen, name))
1812 break;
1813 else { /* continue search */
1814 fclose(fp);
1815 fp = NULL;
1816 }
1817 }
Andrew MacIntyred9400542002-02-26 11:41:34 +00001818#if defined(PYOS_OS2)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001819 /* restore the saved snapshot */
1820 strcpy(buf, saved_buf);
1821 len = saved_len;
1822 namelen = saved_namelen;
Andrew MacIntyred9400542002-02-26 11:41:34 +00001823#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001824 }
Andrew MacIntyred9400542002-02-26 11:41:34 +00001825#if defined(PYOS_OS2)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001826 /* don't need/want the module name snapshot anymore */
1827 if (saved_buf)
1828 {
1829 free(saved_buf);
1830 saved_buf = NULL;
1831 }
Andrew MacIntyred9400542002-02-26 11:41:34 +00001832#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001833 if (fp != NULL)
1834 break;
1835 }
1836 if (fp == NULL) {
1837 PyErr_Format(PyExc_ImportError,
1838 "No module named %.200s", name);
1839 return NULL;
1840 }
1841 *p_fp = fp;
1842 return fdp;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001843}
1844
Martin v. Löwis18e16552006-02-15 17:27:45 +00001845/* case_ok(char* buf, Py_ssize_t len, Py_ssize_t namelen, char* name)
Tim Petersd1e87a82001-03-01 18:12:00 +00001846 * The arguments here are tricky, best shown by example:
1847 * /a/b/c/d/e/f/g/h/i/j/k/some_long_module_name.py\0
1848 * ^ ^ ^ ^
1849 * |--------------------- buf ---------------------|
1850 * |------------------- len ------------------|
1851 * |------ name -------|
1852 * |----- namelen -----|
1853 * buf is the full path, but len only counts up to (& exclusive of) the
1854 * extension. name is the module name, also exclusive of extension.
1855 *
1856 * We've already done a successful stat() or fopen() on buf, so know that
1857 * there's some match, possibly case-insensitive.
1858 *
Tim Peters50d8d372001-02-28 05:34:27 +00001859 * case_ok() is to return 1 if there's a case-sensitive match for
1860 * name, else 0. case_ok() is also to return 1 if envar PYTHONCASEOK
1861 * exists.
Tim Petersd1e87a82001-03-01 18:12:00 +00001862 *
Tim Peters50d8d372001-02-28 05:34:27 +00001863 * case_ok() is used to implement case-sensitive import semantics even
1864 * on platforms with case-insensitive filesystems. It's trivial to implement
1865 * for case-sensitive filesystems. It's pretty much a cross-platform
1866 * nightmare for systems with case-insensitive filesystems.
1867 */
Guido van Rossum0980bd91998-02-13 17:18:36 +00001868
Tim Peters50d8d372001-02-28 05:34:27 +00001869/* First we may need a pile of platform-specific header files; the sequence
1870 * of #if's here should match the sequence in the body of case_ok().
1871 */
Jason Tishler7961aa62005-05-20 00:56:54 +00001872#if defined(MS_WINDOWS)
Guido van Rossum0980bd91998-02-13 17:18:36 +00001873#include <windows.h>
Guido van Rossum4c3f57c2001-01-10 20:40:46 +00001874
Tim Peters50d8d372001-02-28 05:34:27 +00001875#elif defined(DJGPP)
1876#include <dir.h>
1877
Jason Tishler7961aa62005-05-20 00:56:54 +00001878#elif (defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) && defined(HAVE_DIRENT_H)
Tim Peters430f5d42001-03-01 01:30:56 +00001879#include <sys/types.h>
1880#include <dirent.h>
1881
Andrew MacIntyred9400542002-02-26 11:41:34 +00001882#elif defined(PYOS_OS2)
1883#define INCL_DOS
1884#define INCL_DOSERRORS
1885#define INCL_NOPMAPI
1886#include <os2.h>
Tim Peters50d8d372001-02-28 05:34:27 +00001887#endif
1888
Guido van Rossum0980bd91998-02-13 17:18:36 +00001889static int
Martin v. Löwis18e16552006-02-15 17:27:45 +00001890case_ok(char *buf, Py_ssize_t len, Py_ssize_t namelen, char *name)
Guido van Rossum0980bd91998-02-13 17:18:36 +00001891{
Tim Peters50d8d372001-02-28 05:34:27 +00001892/* Pick a platform-specific implementation; the sequence of #if's here should
1893 * match the sequence just above.
1894 */
1895
Jason Tishler7961aa62005-05-20 00:56:54 +00001896/* MS_WINDOWS */
1897#if defined(MS_WINDOWS)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001898 WIN32_FIND_DATA data;
1899 HANDLE h;
Tim Peters50d8d372001-02-28 05:34:27 +00001900
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001901 if (Py_GETENV("PYTHONCASEOK") != NULL)
1902 return 1;
Tim Peters50d8d372001-02-28 05:34:27 +00001903
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001904 h = FindFirstFile(buf, &data);
1905 if (h == INVALID_HANDLE_VALUE) {
1906 PyErr_Format(PyExc_NameError,
1907 "Can't find file for module %.100s\n(filename %.300s)",
1908 name, buf);
1909 return 0;
1910 }
1911 FindClose(h);
1912 return strncmp(data.cFileName, name, namelen) == 0;
Tim Peters50d8d372001-02-28 05:34:27 +00001913
1914/* DJGPP */
1915#elif defined(DJGPP)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001916 struct ffblk ffblk;
1917 int done;
Tim Peters50d8d372001-02-28 05:34:27 +00001918
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001919 if (Py_GETENV("PYTHONCASEOK") != NULL)
1920 return 1;
Tim Peters50d8d372001-02-28 05:34:27 +00001921
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001922 done = findfirst(buf, &ffblk, FA_ARCH|FA_RDONLY|FA_HIDDEN|FA_DIREC);
1923 if (done) {
1924 PyErr_Format(PyExc_NameError,
1925 "Can't find file for module %.100s\n(filename %.300s)",
1926 name, buf);
1927 return 0;
1928 }
1929 return strncmp(ffblk.ff_name, name, namelen) == 0;
Guido van Rossum0980bd91998-02-13 17:18:36 +00001930
Jason Tishler7961aa62005-05-20 00:56:54 +00001931/* new-fangled macintosh (macosx) or Cygwin */
1932#elif (defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) && defined(HAVE_DIRENT_H)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001933 DIR *dirp;
1934 struct dirent *dp;
1935 char dirname[MAXPATHLEN + 1];
1936 const int dirlen = len - namelen - 1; /* don't want trailing SEP */
Tim Peters430f5d42001-03-01 01:30:56 +00001937
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001938 if (Py_GETENV("PYTHONCASEOK") != NULL)
1939 return 1;
Tim Petersdbe6ebb2001-03-01 08:47:29 +00001940
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001941 /* Copy the dir component into dirname; substitute "." if empty */
1942 if (dirlen <= 0) {
1943 dirname[0] = '.';
1944 dirname[1] = '\0';
1945 }
1946 else {
1947 assert(dirlen <= MAXPATHLEN);
1948 memcpy(dirname, buf, dirlen);
1949 dirname[dirlen] = '\0';
1950 }
1951 /* Open the directory and search the entries for an exact match. */
1952 dirp = opendir(dirname);
1953 if (dirp) {
1954 char *nameWithExt = buf + len - namelen;
1955 while ((dp = readdir(dirp)) != NULL) {
1956 const int thislen =
Tim Peters430f5d42001-03-01 01:30:56 +00001957#ifdef _DIRENT_HAVE_D_NAMELEN
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001958 dp->d_namlen;
Tim Peters430f5d42001-03-01 01:30:56 +00001959#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001960 strlen(dp->d_name);
Tim Peters430f5d42001-03-01 01:30:56 +00001961#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001962 if (thislen >= namelen &&
1963 strcmp(dp->d_name, nameWithExt) == 0) {
1964 (void)closedir(dirp);
1965 return 1; /* Found */
1966 }
1967 }
1968 (void)closedir(dirp);
1969 }
1970 return 0 ; /* Not found */
Tim Peters430f5d42001-03-01 01:30:56 +00001971
Andrew MacIntyred9400542002-02-26 11:41:34 +00001972/* OS/2 */
1973#elif defined(PYOS_OS2)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001974 HDIR hdir = 1;
1975 ULONG srchcnt = 1;
1976 FILEFINDBUF3 ffbuf;
1977 APIRET rc;
Andrew MacIntyred9400542002-02-26 11:41:34 +00001978
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001979 if (Py_GETENV("PYTHONCASEOK") != NULL)
1980 return 1;
Andrew MacIntyred9400542002-02-26 11:41:34 +00001981
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001982 rc = DosFindFirst(buf,
1983 &hdir,
1984 FILE_READONLY | FILE_HIDDEN | FILE_SYSTEM | FILE_DIRECTORY,
1985 &ffbuf, sizeof(ffbuf),
1986 &srchcnt,
1987 FIL_STANDARD);
1988 if (rc != NO_ERROR)
1989 return 0;
1990 return strncmp(ffbuf.achName, name, namelen) == 0;
Andrew MacIntyred9400542002-02-26 11:41:34 +00001991
Tim Peters50d8d372001-02-28 05:34:27 +00001992/* assuming it's a case-sensitive filesystem, so there's nothing to do! */
1993#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001994 return 1;
Guido van Rossum0980bd91998-02-13 17:18:36 +00001995
Guido van Rossum4d1b3b91998-02-13 23:27:59 +00001996#endif
Tim Peters50d8d372001-02-28 05:34:27 +00001997}
Guido van Rossum4d1b3b91998-02-13 23:27:59 +00001998
Guido van Rossum197346f1997-10-31 18:38:52 +00001999#ifdef HAVE_STAT
Victor Stinner4f4402c2010-08-14 14:50:26 +00002000
Guido van Rossum197346f1997-10-31 18:38:52 +00002001/* Helper to look for __init__.py or __init__.py[co] in potential package */
2002static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002003find_init_module(char *buf)
Guido van Rossum197346f1997-10-31 18:38:52 +00002004{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002005 const size_t save_len = strlen(buf);
2006 size_t i = save_len;
2007 char *pname; /* pointer to start of __init__ */
2008 struct stat statbuf;
Guido van Rossum197346f1997-10-31 18:38:52 +00002009
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002010/* For calling case_ok(buf, len, namelen, name):
2011 * /a/b/c/d/e/f/g/h/i/j/k/some_long_module_name.py\0
2012 * ^ ^ ^ ^
2013 * |--------------------- buf ---------------------|
2014 * |------------------- len ------------------|
2015 * |------ name -------|
2016 * |----- namelen -----|
Tim Peters0f9431f2001-07-05 03:47:53 +00002017 */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002018 if (save_len + 13 >= MAXPATHLEN)
2019 return 0;
2020 buf[i++] = SEP;
2021 pname = buf + i;
2022 strcpy(pname, "__init__.py");
2023 if (stat(buf, &statbuf) == 0) {
2024 if (case_ok(buf,
2025 save_len + 9, /* len("/__init__") */
2026 8, /* len("__init__") */
2027 pname)) {
2028 buf[save_len] = '\0';
2029 return 1;
2030 }
2031 }
2032 i += strlen(pname);
2033 strcpy(buf+i, Py_OptimizeFlag ? "o" : "c");
2034 if (stat(buf, &statbuf) == 0) {
2035 if (case_ok(buf,
2036 save_len + 9, /* len("/__init__") */
2037 8, /* len("__init__") */
2038 pname)) {
2039 buf[save_len] = '\0';
2040 return 1;
2041 }
2042 }
2043 buf[save_len] = '\0';
2044 return 0;
Guido van Rossum197346f1997-10-31 18:38:52 +00002045}
Guido van Rossum48a680c2001-03-02 06:34:14 +00002046
Guido van Rossum197346f1997-10-31 18:38:52 +00002047#endif /* HAVE_STAT */
2048
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002049
Tim Petersdbd9ba62000-07-09 03:09:57 +00002050static int init_builtin(char *); /* Forward */
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002051
Victor Stinner44c6c152010-08-09 00:59:10 +00002052static PyObject*
2053load_builtin(char *name, char *pathname, int type)
2054{
2055 PyObject *m, *modules;
2056 int err;
2057
2058 if (pathname != NULL && pathname[0] != '\0')
2059 name = pathname;
2060
2061 if (type == C_BUILTIN)
2062 err = init_builtin(name);
2063 else
2064 err = PyImport_ImportFrozenModule(name);
2065 if (err < 0)
2066 return NULL;
2067 if (err == 0) {
2068 PyErr_Format(PyExc_ImportError,
2069 "Purported %s module %.200s not found",
2070 type == C_BUILTIN ?
2071 "builtin" : "frozen",
2072 name);
2073 return NULL;
2074 }
2075
2076 modules = PyImport_GetModuleDict();
2077 m = PyDict_GetItemString(modules, name);
2078 if (m == NULL) {
2079 PyErr_Format(
2080 PyExc_ImportError,
2081 "%s module %.200s not properly initialized",
2082 type == C_BUILTIN ?
2083 "builtin" : "frozen",
2084 name);
2085 return NULL;
2086 }
2087 Py_INCREF(m);
2088 return m;
2089}
2090
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002091/* Load an external module using the default search path and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00002092 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002093
Guido van Rossum79f25d91997-04-29 20:08:16 +00002094static PyObject *
Alexandre Vassalottie223eb82009-07-29 20:12:15 +00002095load_module(char *name, FILE *fp, char *pathname, int type, PyObject *loader)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002096{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002097 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002098
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002099 /* First check that there's an open file (if we need one) */
2100 switch (type) {
2101 case PY_SOURCE:
2102 case PY_COMPILED:
2103 if (fp == NULL) {
2104 PyErr_Format(PyExc_ValueError,
2105 "file object required for import (type code %d)",
2106 type);
2107 return NULL;
2108 }
2109 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002110
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002111 switch (type) {
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002112
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002113 case PY_SOURCE:
2114 m = load_source_module(name, pathname, fp);
2115 break;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002116
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002117 case PY_COMPILED:
2118 m = load_compiled_module(name, pathname, fp);
2119 break;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002120
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002121#ifdef HAVE_DYNAMIC_LOADING
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002122 case C_EXTENSION:
2123 m = _PyImport_LoadDynamicModule(name, pathname, fp);
2124 break;
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002125#endif
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002126
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002127 case PKG_DIRECTORY:
2128 m = load_package(name, pathname);
2129 break;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002130
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002131 case C_BUILTIN:
2132 case PY_FROZEN:
Victor Stinner44c6c152010-08-09 00:59:10 +00002133 m = load_builtin(name, pathname, type);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002134 break;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002135
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002136 case IMP_HOOK: {
2137 if (loader == NULL) {
2138 PyErr_SetString(PyExc_ImportError,
2139 "import hook without loader");
2140 return NULL;
2141 }
2142 m = PyObject_CallMethod(loader, "load_module", "s", name);
2143 break;
2144 }
Just van Rossum52e14d62002-12-30 22:08:05 +00002145
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002146 default:
2147 PyErr_Format(PyExc_ImportError,
2148 "Don't know how to import %.200s (type code %d)",
2149 name, type);
2150 m = NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002151
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002152 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002153
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002154 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002155}
2156
2157
2158/* Initialize a built-in module.
Thomas Wouters89f507f2006-12-13 04:49:30 +00002159 Return 1 for success, 0 if the module is not found, and -1 with
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002160 an exception set if the initialization failed. */
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002161
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002162static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002163init_builtin(char *name)
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002164{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002165 struct _inittab *p;
Guido van Rossum25ce5661997-08-02 03:10:38 +00002166
Victor Stinner49d3f252010-10-17 01:24:53 +00002167 if (_PyImport_FindBuiltin(name) != NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002168 return 1;
Guido van Rossum25ce5661997-08-02 03:10:38 +00002169
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002170 for (p = PyImport_Inittab; p->name != NULL; p++) {
2171 PyObject *mod;
Antoine Pitrou6c40eb72012-01-18 20:16:09 +01002172 PyModuleDef *def;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002173 if (strcmp(name, p->name) == 0) {
2174 if (p->initfunc == NULL) {
2175 PyErr_Format(PyExc_ImportError,
2176 "Cannot re-init internal module %.200s",
2177 name);
2178 return -1;
2179 }
2180 if (Py_VerboseFlag)
2181 PySys_WriteStderr("import %s # builtin\n", name);
2182 mod = (*p->initfunc)();
2183 if (mod == 0)
2184 return -1;
Antoine Pitrou6c40eb72012-01-18 20:16:09 +01002185 /* Remember pointer to module init function. */
2186 def = PyModule_GetDef(mod);
2187 def->m_base.m_init = p->initfunc;
Victor Stinner49d3f252010-10-17 01:24:53 +00002188 if (_PyImport_FixupBuiltin(mod, name) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002189 return -1;
2190 /* FixupExtension has put the module into sys.modules,
2191 so we can release our own reference. */
2192 Py_DECREF(mod);
2193 return 1;
2194 }
2195 }
2196 return 0;
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002197}
Guido van Rossumf56e3db1993-04-01 20:59:32 +00002198
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002199
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002200/* Frozen modules */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002201
Guido van Rossumcfd0a221996-06-17 17:06:34 +00002202static struct _frozen *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002203find_frozen(char *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002204{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002205 struct _frozen *p;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002206
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002207 if (!name)
2208 return NULL;
Benjamin Petersond968e272008-11-05 22:48:33 +00002209
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002210 for (p = PyImport_FrozenModules; ; p++) {
2211 if (p->name == NULL)
2212 return NULL;
2213 if (strcmp(p->name, name) == 0)
2214 break;
2215 }
2216 return p;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002217}
2218
Guido van Rossum79f25d91997-04-29 20:08:16 +00002219static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002220get_frozen_object(char *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002221{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002222 struct _frozen *p = find_frozen(name);
2223 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002224
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002225 if (p == NULL) {
2226 PyErr_Format(PyExc_ImportError,
2227 "No such frozen object named %.200s",
2228 name);
2229 return NULL;
2230 }
2231 if (p->code == NULL) {
2232 PyErr_Format(PyExc_ImportError,
2233 "Excluded frozen object named %.200s",
2234 name);
2235 return NULL;
2236 }
2237 size = p->size;
2238 if (size < 0)
2239 size = -size;
2240 return PyMarshal_ReadObjectFromString((char *)p->code, size);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002241}
2242
Brett Cannon8d110132009-03-15 02:20:16 +00002243static PyObject *
2244is_frozen_package(char *name)
2245{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002246 struct _frozen *p = find_frozen(name);
2247 int size;
Brett Cannon8d110132009-03-15 02:20:16 +00002248
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002249 if (p == NULL) {
2250 PyErr_Format(PyExc_ImportError,
2251 "No such frozen object named %.200s",
2252 name);
2253 return NULL;
2254 }
Brett Cannon8d110132009-03-15 02:20:16 +00002255
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002256 size = p->size;
Brett Cannon8d110132009-03-15 02:20:16 +00002257
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002258 if (size < 0)
2259 Py_RETURN_TRUE;
2260 else
2261 Py_RETURN_FALSE;
Brett Cannon8d110132009-03-15 02:20:16 +00002262}
2263
2264
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002265/* Initialize a frozen module.
Brett Cannon3c2ac442009-03-08 20:49:47 +00002266 Return 1 for success, 0 if the module is not found, and -1 with
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002267 an exception set if the initialization failed.
2268 This function is also used from frozenmain.c */
Guido van Rossum0b344901995-02-07 15:35:27 +00002269
2270int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002271PyImport_ImportFrozenModule(char *name)
Guido van Rossumf56e3db1993-04-01 20:59:32 +00002272{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002273 struct _frozen *p = find_frozen(name);
2274 PyObject *co;
2275 PyObject *m;
2276 int ispackage;
2277 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002278
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002279 if (p == NULL)
2280 return 0;
2281 if (p->code == NULL) {
2282 PyErr_Format(PyExc_ImportError,
2283 "Excluded frozen object named %.200s",
2284 name);
2285 return -1;
2286 }
2287 size = p->size;
2288 ispackage = (size < 0);
2289 if (ispackage)
2290 size = -size;
2291 if (Py_VerboseFlag)
2292 PySys_WriteStderr("import %s # frozen%s\n",
2293 name, ispackage ? " package" : "");
2294 co = PyMarshal_ReadObjectFromString((char *)p->code, size);
2295 if (co == NULL)
2296 return -1;
2297 if (!PyCode_Check(co)) {
2298 PyErr_Format(PyExc_TypeError,
2299 "frozen object %.200s is not a code object",
2300 name);
2301 goto err_return;
2302 }
2303 if (ispackage) {
2304 /* Set __path__ to the package name */
2305 PyObject *d, *s, *l;
2306 int err;
2307 m = PyImport_AddModule(name);
2308 if (m == NULL)
2309 goto err_return;
2310 d = PyModule_GetDict(m);
2311 s = PyUnicode_InternFromString(name);
2312 if (s == NULL)
2313 goto err_return;
2314 l = PyList_New(1);
2315 if (l == NULL) {
2316 Py_DECREF(s);
2317 goto err_return;
2318 }
2319 PyList_SET_ITEM(l, 0, s);
2320 err = PyDict_SetItemString(d, "__path__", l);
2321 Py_DECREF(l);
2322 if (err != 0)
2323 goto err_return;
2324 }
2325 m = PyImport_ExecCodeModuleEx(name, co, "<frozen>");
2326 if (m == NULL)
2327 goto err_return;
2328 Py_DECREF(co);
2329 Py_DECREF(m);
2330 return 1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002331err_return:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002332 Py_DECREF(co);
2333 return -1;
Guido van Rossumf56e3db1993-04-01 20:59:32 +00002334}
Guido van Rossum74e6a111994-08-29 12:54:38 +00002335
2336
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002337/* Import a module, either built-in, frozen, or external, and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00002338 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum74e6a111994-08-29 12:54:38 +00002339
Guido van Rossum79f25d91997-04-29 20:08:16 +00002340PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00002341PyImport_ImportModule(const char *name)
Guido van Rossum74e6a111994-08-29 12:54:38 +00002342{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002343 PyObject *pname;
2344 PyObject *result;
Marc-André Lemburg3c61c352001-02-09 19:40:15 +00002345
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002346 pname = PyUnicode_FromString(name);
2347 if (pname == NULL)
2348 return NULL;
2349 result = PyImport_Import(pname);
2350 Py_DECREF(pname);
2351 return result;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002352}
2353
Christian Heimes072c0f12008-01-03 23:01:04 +00002354/* Import a module without blocking
2355 *
2356 * At first it tries to fetch the module from sys.modules. If the module was
2357 * never loaded before it loads it with PyImport_ImportModule() unless another
2358 * thread holds the import lock. In the latter case the function raises an
2359 * ImportError instead of blocking.
2360 *
2361 * Returns the module object with incremented ref count.
2362 */
2363PyObject *
2364PyImport_ImportModuleNoBlock(const char *name)
2365{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002366 PyObject *result;
2367 PyObject *modules;
Victor Stinner0af03062011-09-02 00:11:43 +02002368#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002369 long me;
Victor Stinner0af03062011-09-02 00:11:43 +02002370#endif
Christian Heimes072c0f12008-01-03 23:01:04 +00002371
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002372 /* Try to get the module from sys.modules[name] */
2373 modules = PyImport_GetModuleDict();
2374 if (modules == NULL)
2375 return NULL;
Christian Heimes072c0f12008-01-03 23:01:04 +00002376
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002377 result = PyDict_GetItemString(modules, name);
2378 if (result != NULL) {
2379 Py_INCREF(result);
2380 return result;
2381 }
2382 else {
2383 PyErr_Clear();
2384 }
Benjamin Peterson3e4f0552008-09-02 00:31:15 +00002385#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002386 /* check the import lock
2387 * me might be -1 but I ignore the error here, the lock function
2388 * takes care of the problem */
2389 me = PyThread_get_thread_ident();
2390 if (import_lock_thread == -1 || import_lock_thread == me) {
2391 /* no thread or me is holding the lock */
2392 return PyImport_ImportModule(name);
2393 }
2394 else {
2395 PyErr_Format(PyExc_ImportError,
2396 "Failed to import %.200s because the import lock"
2397 "is held by another thread.",
2398 name);
2399 return NULL;
2400 }
Benjamin Peterson3e4f0552008-09-02 00:31:15 +00002401#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002402 return PyImport_ImportModule(name);
Benjamin Peterson3e4f0552008-09-02 00:31:15 +00002403#endif
Christian Heimes072c0f12008-01-03 23:01:04 +00002404}
2405
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002406/* Forward declarations for helper routines */
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002407static PyObject *get_parent(PyObject *globals, char *buf,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002408 Py_ssize_t *p_buflen, int level);
Tim Petersdbd9ba62000-07-09 03:09:57 +00002409static PyObject *load_next(PyObject *mod, PyObject *altmod,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002410 char **p_name, char *buf, Py_ssize_t *p_buflen);
Tim Petersdbd9ba62000-07-09 03:09:57 +00002411static int mark_miss(char *name);
2412static int ensure_fromlist(PyObject *mod, PyObject *fromlist,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002413 char *buf, Py_ssize_t buflen, int recursive);
Tim Petersdbd9ba62000-07-09 03:09:57 +00002414static PyObject * import_submodule(PyObject *mod, char *name, char *fullname);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002415
2416/* The Magnum Opus of dotted-name import :-) */
2417
Guido van Rossum75acc9c1998-03-03 22:26:50 +00002418static PyObject *
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002419import_module_level(char *name, PyObject *globals, PyObject *locals,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002420 PyObject *fromlist, int level)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002421{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002422 char buf[MAXPATHLEN+1];
2423 Py_ssize_t buflen = 0;
2424 PyObject *parent, *head, *next, *tail;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002425
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002426 if (strchr(name, '/') != NULL
Christian Heimes454f37b2008-01-10 00:10:02 +00002427#ifdef MS_WINDOWS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002428 || strchr(name, '\\') != NULL
Christian Heimes454f37b2008-01-10 00:10:02 +00002429#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002430 ) {
2431 PyErr_SetString(PyExc_ImportError,
2432 "Import by filename is not supported.");
2433 return NULL;
2434 }
Christian Heimes454f37b2008-01-10 00:10:02 +00002435
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002436 parent = get_parent(globals, buf, &buflen, level);
2437 if (parent == NULL)
2438 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002439
Benjamin Peterson556d8002010-06-27 22:37:28 +00002440 head = load_next(parent, level < 0 ? Py_None : parent, &name, buf,
2441 &buflen);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002442 if (head == NULL)
2443 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002444
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002445 tail = head;
2446 Py_INCREF(tail);
2447 while (name) {
2448 next = load_next(tail, tail, &name, buf, &buflen);
2449 Py_DECREF(tail);
2450 if (next == NULL) {
2451 Py_DECREF(head);
2452 return NULL;
2453 }
2454 tail = next;
2455 }
2456 if (tail == Py_None) {
2457 /* If tail is Py_None, both get_parent and load_next found
2458 an empty module name: someone called __import__("") or
2459 doctored faulty bytecode */
2460 Py_DECREF(tail);
2461 Py_DECREF(head);
2462 PyErr_SetString(PyExc_ValueError,
2463 "Empty module name");
2464 return NULL;
2465 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002466
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002467 if (fromlist != NULL) {
2468 if (fromlist == Py_None || !PyObject_IsTrue(fromlist))
2469 fromlist = NULL;
2470 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002471
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002472 if (fromlist == NULL) {
2473 Py_DECREF(tail);
2474 return head;
2475 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002476
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002477 Py_DECREF(head);
2478 if (!ensure_fromlist(tail, fromlist, buf, buflen, 0)) {
2479 Py_DECREF(tail);
2480 return NULL;
2481 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002482
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002483 return tail;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002484}
2485
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002486PyObject *
2487PyImport_ImportModuleLevel(char *name, PyObject *globals, PyObject *locals,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002488 PyObject *fromlist, int level)
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002489{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002490 PyObject *result;
2491 _PyImport_AcquireLock();
2492 result = import_module_level(name, globals, locals, fromlist, level);
2493 if (_PyImport_ReleaseLock() < 0) {
2494 Py_XDECREF(result);
2495 PyErr_SetString(PyExc_RuntimeError,
2496 "not holding the import lock");
2497 return NULL;
2498 }
2499 return result;
Guido van Rossum75acc9c1998-03-03 22:26:50 +00002500}
2501
Fred Drake87590902004-05-28 20:21:36 +00002502/* Return the package that an import is being performed in. If globals comes
2503 from the module foo.bar.bat (not itself a package), this returns the
2504 sys.modules entry for foo.bar. If globals is from a package's __init__.py,
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00002505 the package's entry in sys.modules is returned, as a borrowed reference.
Fred Drake87590902004-05-28 20:21:36 +00002506
2507 The *name* of the returned package is returned in buf, with the length of
2508 the name in *p_buflen.
2509
2510 If globals doesn't come from a package or a module in a package, or a
2511 corresponding entry is not found in sys.modules, Py_None is returned.
2512*/
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002513static PyObject *
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002514get_parent(PyObject *globals, char *buf, Py_ssize_t *p_buflen, int level)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002515{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002516 static PyObject *namestr = NULL;
2517 static PyObject *pathstr = NULL;
2518 static PyObject *pkgstr = NULL;
2519 PyObject *pkgname, *modname, *modpath, *modules, *parent;
2520 int orig_level = level;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002521
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002522 if (globals == NULL || !PyDict_Check(globals) || !level)
2523 return Py_None;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002524
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002525 if (namestr == NULL) {
2526 namestr = PyUnicode_InternFromString("__name__");
2527 if (namestr == NULL)
2528 return NULL;
2529 }
2530 if (pathstr == NULL) {
2531 pathstr = PyUnicode_InternFromString("__path__");
2532 if (pathstr == NULL)
2533 return NULL;
2534 }
2535 if (pkgstr == NULL) {
2536 pkgstr = PyUnicode_InternFromString("__package__");
2537 if (pkgstr == NULL)
2538 return NULL;
2539 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002540
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002541 *buf = '\0';
2542 *p_buflen = 0;
2543 pkgname = PyDict_GetItem(globals, pkgstr);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002544
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002545 if ((pkgname != NULL) && (pkgname != Py_None)) {
2546 /* __package__ is set, so use it */
2547 char *pkgname_str;
2548 Py_ssize_t len;
Alexandre Vassalottia85998a2008-05-03 18:24:43 +00002549
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002550 if (!PyUnicode_Check(pkgname)) {
2551 PyErr_SetString(PyExc_ValueError,
2552 "__package__ set to non-string");
2553 return NULL;
2554 }
2555 pkgname_str = _PyUnicode_AsStringAndSize(pkgname, &len);
2556 if (len == 0) {
2557 if (level > 0) {
2558 PyErr_SetString(PyExc_ValueError,
2559 "Attempted relative import in non-package");
2560 return NULL;
2561 }
2562 return Py_None;
2563 }
2564 if (len > MAXPATHLEN) {
2565 PyErr_SetString(PyExc_ValueError,
2566 "Package name too long");
2567 return NULL;
2568 }
2569 strcpy(buf, pkgname_str);
2570 } else {
2571 /* __package__ not set, so figure it out and set it */
2572 modname = PyDict_GetItem(globals, namestr);
2573 if (modname == NULL || !PyUnicode_Check(modname))
2574 return Py_None;
Brett Cannon9a5b25a2010-03-01 02:09:17 +00002575
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002576 modpath = PyDict_GetItem(globals, pathstr);
2577 if (modpath != NULL) {
2578 /* __path__ is set, so modname is already the package name */
2579 char *modname_str;
2580 Py_ssize_t len;
2581 int error;
Alexandre Vassalottia85998a2008-05-03 18:24:43 +00002582
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002583 modname_str = _PyUnicode_AsStringAndSize(modname, &len);
2584 if (len > MAXPATHLEN) {
2585 PyErr_SetString(PyExc_ValueError,
2586 "Module name too long");
2587 return NULL;
2588 }
2589 strcpy(buf, modname_str);
2590 error = PyDict_SetItem(globals, pkgstr, modname);
2591 if (error) {
2592 PyErr_SetString(PyExc_ValueError,
2593 "Could not set __package__");
2594 return NULL;
2595 }
2596 } else {
2597 /* Normal module, so work out the package name if any */
2598 char *start = _PyUnicode_AsString(modname);
2599 char *lastdot = strrchr(start, '.');
2600 size_t len;
2601 int error;
2602 if (lastdot == NULL && level > 0) {
2603 PyErr_SetString(PyExc_ValueError,
2604 "Attempted relative import in non-package");
2605 return NULL;
2606 }
2607 if (lastdot == NULL) {
2608 error = PyDict_SetItem(globals, pkgstr, Py_None);
2609 if (error) {
2610 PyErr_SetString(PyExc_ValueError,
2611 "Could not set __package__");
2612 return NULL;
2613 }
2614 return Py_None;
2615 }
2616 len = lastdot - start;
2617 if (len >= MAXPATHLEN) {
2618 PyErr_SetString(PyExc_ValueError,
2619 "Module name too long");
2620 return NULL;
2621 }
2622 strncpy(buf, start, len);
2623 buf[len] = '\0';
2624 pkgname = PyUnicode_FromString(buf);
2625 if (pkgname == NULL) {
2626 return NULL;
2627 }
2628 error = PyDict_SetItem(globals, pkgstr, pkgname);
2629 Py_DECREF(pkgname);
2630 if (error) {
2631 PyErr_SetString(PyExc_ValueError,
2632 "Could not set __package__");
2633 return NULL;
2634 }
2635 }
2636 }
2637 while (--level > 0) {
2638 char *dot = strrchr(buf, '.');
2639 if (dot == NULL) {
2640 PyErr_SetString(PyExc_ValueError,
2641 "Attempted relative import beyond "
2642 "toplevel package");
2643 return NULL;
2644 }
2645 *dot = '\0';
2646 }
2647 *p_buflen = strlen(buf);
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002648
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002649 modules = PyImport_GetModuleDict();
2650 parent = PyDict_GetItemString(modules, buf);
2651 if (parent == NULL) {
2652 if (orig_level < 1) {
2653 PyObject *err_msg = PyBytes_FromFormat(
2654 "Parent module '%.200s' not found "
2655 "while handling absolute import", buf);
2656 if (err_msg == NULL) {
2657 return NULL;
2658 }
2659 if (!PyErr_WarnEx(PyExc_RuntimeWarning,
2660 PyBytes_AsString(err_msg), 1)) {
2661 *buf = '\0';
2662 *p_buflen = 0;
2663 parent = Py_None;
2664 }
2665 Py_DECREF(err_msg);
2666 } else {
2667 PyErr_Format(PyExc_SystemError,
2668 "Parent module '%.200s' not loaded, "
2669 "cannot perform relative import", buf);
2670 }
2671 }
2672 return parent;
2673 /* We expect, but can't guarantee, if parent != None, that:
2674 - parent.__name__ == buf
2675 - parent.__dict__ is globals
2676 If this is violated... Who cares? */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002677}
2678
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002679/* altmod is either None or same as mod */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002680static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002681load_next(PyObject *mod, PyObject *altmod, char **p_name, char *buf,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002682 Py_ssize_t *p_buflen)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002683{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002684 char *name = *p_name;
2685 char *dot = strchr(name, '.');
2686 size_t len;
2687 char *p;
2688 PyObject *result;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002689
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002690 if (strlen(name) == 0) {
2691 /* completely empty module name should only happen in
2692 'from . import' (or '__import__("")')*/
2693 Py_INCREF(mod);
2694 *p_name = NULL;
2695 return mod;
2696 }
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002697
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002698 if (dot == NULL) {
2699 *p_name = NULL;
2700 len = strlen(name);
2701 }
2702 else {
2703 *p_name = dot+1;
2704 len = dot-name;
2705 }
2706 if (len == 0) {
2707 PyErr_SetString(PyExc_ValueError,
2708 "Empty module name");
2709 return NULL;
2710 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002711
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002712 p = buf + *p_buflen;
2713 if (p != buf)
2714 *p++ = '.';
2715 if (p+len-buf >= MAXPATHLEN) {
2716 PyErr_SetString(PyExc_ValueError,
2717 "Module name too long");
2718 return NULL;
2719 }
2720 strncpy(p, name, len);
2721 p[len] = '\0';
2722 *p_buflen = p+len-buf;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002723
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002724 result = import_submodule(mod, p, buf);
2725 if (result == Py_None && altmod != mod) {
2726 Py_DECREF(result);
2727 /* Here, altmod must be None and mod must not be None */
2728 result = import_submodule(altmod, p, p);
2729 if (result != NULL && result != Py_None) {
2730 if (mark_miss(buf) != 0) {
2731 Py_DECREF(result);
2732 return NULL;
2733 }
2734 strncpy(buf, name, len);
2735 buf[len] = '\0';
2736 *p_buflen = len;
2737 }
2738 }
2739 if (result == NULL)
2740 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002741
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002742 if (result == Py_None) {
2743 Py_DECREF(result);
2744 PyErr_Format(PyExc_ImportError,
2745 "No module named %.200s", name);
2746 return NULL;
2747 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002748
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002749 return result;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002750}
2751
2752static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002753mark_miss(char *name)
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00002754{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002755 PyObject *modules = PyImport_GetModuleDict();
2756 return PyDict_SetItemString(modules, name, Py_None);
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00002757}
2758
2759static int
Martin v. Löwis18e16552006-02-15 17:27:45 +00002760ensure_fromlist(PyObject *mod, PyObject *fromlist, char *buf, Py_ssize_t buflen,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002761 int recursive)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002762{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002763 int i;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002764
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002765 if (!PyObject_HasAttrString(mod, "__path__"))
2766 return 1;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002767
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002768 for (i = 0; ; i++) {
2769 PyObject *item = PySequence_GetItem(fromlist, i);
2770 int hasit;
2771 if (item == NULL) {
2772 if (PyErr_ExceptionMatches(PyExc_IndexError)) {
2773 PyErr_Clear();
2774 return 1;
2775 }
2776 return 0;
2777 }
2778 if (!PyUnicode_Check(item)) {
2779 PyErr_SetString(PyExc_TypeError,
2780 "Item in ``from list'' not a string");
2781 Py_DECREF(item);
2782 return 0;
2783 }
2784 if (PyUnicode_AS_UNICODE(item)[0] == '*') {
2785 PyObject *all;
2786 Py_DECREF(item);
2787 /* See if the package defines __all__ */
2788 if (recursive)
2789 continue; /* Avoid endless recursion */
2790 all = PyObject_GetAttrString(mod, "__all__");
2791 if (all == NULL)
2792 PyErr_Clear();
2793 else {
2794 int ret = ensure_fromlist(mod, all, buf, buflen, 1);
2795 Py_DECREF(all);
2796 if (!ret)
2797 return 0;
2798 }
2799 continue;
2800 }
2801 hasit = PyObject_HasAttr(mod, item);
2802 if (!hasit) {
2803 PyObject *item8;
2804 char *subname;
2805 PyObject *submod;
2806 char *p;
Victor Stinnerae6265f2010-05-15 16:27:27 +00002807 item8 = PyUnicode_EncodeFSDefault(item);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002808 if (!item8) {
2809 PyErr_SetString(PyExc_ValueError, "Cannot encode path item");
2810 return 0;
2811 }
2812 subname = PyBytes_AS_STRING(item8);
2813 if (buflen + strlen(subname) >= MAXPATHLEN) {
2814 PyErr_SetString(PyExc_ValueError,
2815 "Module name too long");
2816 Py_DECREF(item);
2817 return 0;
2818 }
2819 p = buf + buflen;
2820 *p++ = '.';
2821 strcpy(p, subname);
2822 submod = import_submodule(mod, subname, buf);
2823 Py_DECREF(item8);
2824 Py_XDECREF(submod);
2825 if (submod == NULL) {
2826 Py_DECREF(item);
2827 return 0;
2828 }
2829 }
2830 Py_DECREF(item);
2831 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002832
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002833 /* NOTREACHED */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002834}
2835
Neil Schemenauer00b09662003-06-16 21:03:07 +00002836static int
2837add_submodule(PyObject *mod, PyObject *submod, char *fullname, char *subname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002838 PyObject *modules)
Neil Schemenauer00b09662003-06-16 21:03:07 +00002839{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002840 if (mod == Py_None)
2841 return 1;
2842 /* Irrespective of the success of this load, make a
2843 reference to it in the parent package module. A copy gets
2844 saved in the modules dictionary under the full name, so get a
2845 reference from there, if need be. (The exception is when the
2846 load failed with a SyntaxError -- then there's no trace in
2847 sys.modules. In that case, of course, do nothing extra.) */
2848 if (submod == NULL) {
2849 submod = PyDict_GetItemString(modules, fullname);
2850 if (submod == NULL)
2851 return 1;
2852 }
2853 if (PyModule_Check(mod)) {
2854 /* We can't use setattr here since it can give a
2855 * spurious warning if the submodule name shadows a
2856 * builtin name */
2857 PyObject *dict = PyModule_GetDict(mod);
2858 if (!dict)
2859 return 0;
2860 if (PyDict_SetItemString(dict, subname, submod) < 0)
2861 return 0;
2862 }
2863 else {
2864 if (PyObject_SetAttrString(mod, subname, submod) < 0)
2865 return 0;
2866 }
2867 return 1;
Neil Schemenauer00b09662003-06-16 21:03:07 +00002868}
2869
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002870static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002871import_submodule(PyObject *mod, char *subname, char *fullname)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002872{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002873 PyObject *modules = PyImport_GetModuleDict();
2874 PyObject *m = NULL;
Guido van Rossum74e6a111994-08-29 12:54:38 +00002875
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002876 /* Require:
2877 if mod == None: subname == fullname
2878 else: mod.__name__ + "." + subname == fullname
2879 */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002880
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002881 if ((m = PyDict_GetItemString(modules, fullname)) != NULL) {
2882 Py_INCREF(m);
2883 }
2884 else {
2885 PyObject *path, *loader = NULL;
2886 char buf[MAXPATHLEN+1];
2887 struct filedescr *fdp;
2888 FILE *fp = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002889
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002890 if (mod == Py_None)
2891 path = NULL;
2892 else {
2893 path = PyObject_GetAttrString(mod, "__path__");
2894 if (path == NULL) {
2895 PyErr_Clear();
2896 Py_INCREF(Py_None);
2897 return Py_None;
2898 }
2899 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002900
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002901 buf[0] = '\0';
2902 fdp = find_module(fullname, subname, path, buf, MAXPATHLEN+1,
2903 &fp, &loader);
2904 Py_XDECREF(path);
2905 if (fdp == NULL) {
2906 if (!PyErr_ExceptionMatches(PyExc_ImportError))
2907 return NULL;
2908 PyErr_Clear();
2909 Py_INCREF(Py_None);
2910 return Py_None;
2911 }
2912 m = load_module(fullname, fp, buf, fdp->type, loader);
2913 Py_XDECREF(loader);
2914 if (fp)
2915 fclose(fp);
2916 if (!add_submodule(mod, m, fullname, subname, modules)) {
2917 Py_XDECREF(m);
2918 m = NULL;
2919 }
2920 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002921
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002922 return m;
Guido van Rossum74e6a111994-08-29 12:54:38 +00002923}
2924
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002925
2926/* Re-import a module of any kind and return its module object, WITH
2927 INCREMENTED REFERENCE COUNT */
2928
Guido van Rossum79f25d91997-04-29 20:08:16 +00002929PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002930PyImport_ReloadModule(PyObject *m)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002931{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002932 PyInterpreterState *interp = PyThreadState_Get()->interp;
2933 PyObject *modules_reloading = interp->modules_reloading;
2934 PyObject *modules = PyImport_GetModuleDict();
2935 PyObject *path = NULL, *loader = NULL, *existing_m = NULL;
2936 char *name, *subname;
2937 char buf[MAXPATHLEN+1];
2938 struct filedescr *fdp;
2939 FILE *fp = NULL;
2940 PyObject *newm;
Brett Cannon9a5b25a2010-03-01 02:09:17 +00002941
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002942 if (modules_reloading == NULL) {
2943 Py_FatalError("PyImport_ReloadModule: "
2944 "no modules_reloading dictionary!");
2945 return NULL;
2946 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002947
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002948 if (m == NULL || !PyModule_Check(m)) {
2949 PyErr_SetString(PyExc_TypeError,
2950 "reload() argument must be module");
2951 return NULL;
2952 }
2953 name = (char*)PyModule_GetName(m);
2954 if (name == NULL)
2955 return NULL;
2956 if (m != PyDict_GetItemString(modules, name)) {
2957 PyErr_Format(PyExc_ImportError,
2958 "reload(): module %.200s not in sys.modules",
2959 name);
2960 return NULL;
2961 }
2962 existing_m = PyDict_GetItemString(modules_reloading, name);
2963 if (existing_m != NULL) {
2964 /* Due to a recursive reload, this module is already
2965 being reloaded. */
2966 Py_INCREF(existing_m);
2967 return existing_m;
2968 }
2969 if (PyDict_SetItemString(modules_reloading, name, m) < 0)
2970 return NULL;
Guido van Rossumd8faa362007-04-27 19:54:29 +00002971
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002972 subname = strrchr(name, '.');
2973 if (subname == NULL)
2974 subname = name;
2975 else {
2976 PyObject *parentname, *parent;
2977 parentname = PyUnicode_FromStringAndSize(name, (subname-name));
2978 if (parentname == NULL) {
2979 imp_modules_reloading_clear();
2980 return NULL;
2981 }
2982 parent = PyDict_GetItem(modules, parentname);
2983 if (parent == NULL) {
2984 PyErr_Format(PyExc_ImportError,
2985 "reload(): parent %U not in sys.modules",
2986 parentname);
2987 Py_DECREF(parentname);
2988 imp_modules_reloading_clear();
2989 return NULL;
2990 }
2991 Py_DECREF(parentname);
2992 subname++;
2993 path = PyObject_GetAttrString(parent, "__path__");
2994 if (path == NULL)
2995 PyErr_Clear();
2996 }
2997 buf[0] = '\0';
2998 fdp = find_module(name, subname, path, buf, MAXPATHLEN+1, &fp, &loader);
2999 Py_XDECREF(path);
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00003000
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003001 if (fdp == NULL) {
3002 Py_XDECREF(loader);
3003 imp_modules_reloading_clear();
3004 return NULL;
3005 }
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00003006
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003007 newm = load_module(name, fp, buf, fdp->type, loader);
3008 Py_XDECREF(loader);
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00003009
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003010 if (fp)
3011 fclose(fp);
3012 if (newm == NULL) {
3013 /* load_module probably removed name from modules because of
3014 * the error. Put back the original module object. We're
3015 * going to return NULL in this case regardless of whether
3016 * replacing name succeeds, so the return value is ignored.
3017 */
3018 PyDict_SetItemString(modules, name, m);
3019 }
3020 imp_modules_reloading_clear();
3021 return newm;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003022}
3023
3024
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003025/* Higher-level import emulator which emulates the "import" statement
3026 more accurately -- it invokes the __import__() function from the
3027 builtins of the current globals. This means that the import is
3028 done using whatever import hooks are installed in the current
Brett Cannonbc2eff32010-09-19 21:39:02 +00003029 environment.
Guido van Rossum6058eb41998-12-21 19:51:00 +00003030 A dummy list ["__doc__"] is passed as the 4th argument so that
Neal Norwitz80e7f272007-08-26 06:45:23 +00003031 e.g. PyImport_Import(PyUnicode_FromString("win32com.client.gencache"))
Guido van Rossum6058eb41998-12-21 19:51:00 +00003032 will return <module "gencache"> instead of <module "win32com">. */
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003033
3034PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003035PyImport_Import(PyObject *module_name)
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003036{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003037 static PyObject *silly_list = NULL;
3038 static PyObject *builtins_str = NULL;
3039 static PyObject *import_str = NULL;
3040 PyObject *globals = NULL;
3041 PyObject *import = NULL;
3042 PyObject *builtins = NULL;
Brett Cannonbc2eff32010-09-19 21:39:02 +00003043 PyObject *modules = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003044 PyObject *r = NULL;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003045
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003046 /* Initialize constant string objects */
3047 if (silly_list == NULL) {
3048 import_str = PyUnicode_InternFromString("__import__");
3049 if (import_str == NULL)
3050 return NULL;
3051 builtins_str = PyUnicode_InternFromString("__builtins__");
3052 if (builtins_str == NULL)
3053 return NULL;
Brett Cannonbc2eff32010-09-19 21:39:02 +00003054 silly_list = PyList_New(0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003055 if (silly_list == NULL)
3056 return NULL;
3057 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003058
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003059 /* Get the builtins from current globals */
3060 globals = PyEval_GetGlobals();
3061 if (globals != NULL) {
3062 Py_INCREF(globals);
3063 builtins = PyObject_GetItem(globals, builtins_str);
3064 if (builtins == NULL)
3065 goto err;
3066 }
3067 else {
3068 /* No globals -- use standard builtins, and fake globals */
3069 builtins = PyImport_ImportModuleLevel("builtins",
3070 NULL, NULL, NULL, 0);
3071 if (builtins == NULL)
3072 return NULL;
3073 globals = Py_BuildValue("{OO}", builtins_str, builtins);
3074 if (globals == NULL)
3075 goto err;
3076 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003077
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003078 /* Get the __import__ function from the builtins */
3079 if (PyDict_Check(builtins)) {
3080 import = PyObject_GetItem(builtins, import_str);
3081 if (import == NULL)
3082 PyErr_SetObject(PyExc_KeyError, import_str);
3083 }
3084 else
3085 import = PyObject_GetAttr(builtins, import_str);
3086 if (import == NULL)
3087 goto err;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003088
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003089 /* Call the __import__ function with the proper argument list
Brett Cannonbc2eff32010-09-19 21:39:02 +00003090 Always use absolute import here.
3091 Calling for side-effect of import. */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003092 r = PyObject_CallFunction(import, "OOOOi", module_name, globals,
3093 globals, silly_list, 0, NULL);
Brett Cannonbc2eff32010-09-19 21:39:02 +00003094 if (r == NULL)
3095 goto err;
3096 Py_DECREF(r);
3097
3098 modules = PyImport_GetModuleDict();
3099 r = PyDict_GetItem(modules, module_name);
3100 if (r != NULL)
3101 Py_INCREF(r);
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003102
3103 err:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003104 Py_XDECREF(globals);
3105 Py_XDECREF(builtins);
3106 Py_XDECREF(import);
Tim Peters50d8d372001-02-28 05:34:27 +00003107
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003108 return r;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003109}
3110
3111
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003112/* Module 'imp' provides Python access to the primitives used for
3113 importing modules.
3114*/
3115
Guido van Rossum79f25d91997-04-29 20:08:16 +00003116static PyObject *
Barry Warsaw28a691b2010-04-17 00:19:56 +00003117imp_make_magic(long magic)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003118{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003119 char buf[4];
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003120
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003121 buf[0] = (char) ((magic >> 0) & 0xff);
3122 buf[1] = (char) ((magic >> 8) & 0xff);
3123 buf[2] = (char) ((magic >> 16) & 0xff);
3124 buf[3] = (char) ((magic >> 24) & 0xff);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003125
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003126 return PyBytes_FromStringAndSize(buf, 4);
Victor Stinner3e2b7172010-11-09 09:32:19 +00003127}
Barry Warsaw28a691b2010-04-17 00:19:56 +00003128
3129static PyObject *
3130imp_get_magic(PyObject *self, PyObject *noargs)
3131{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003132 return imp_make_magic(pyc_magic);
Barry Warsaw28a691b2010-04-17 00:19:56 +00003133}
3134
3135static PyObject *
3136imp_get_tag(PyObject *self, PyObject *noargs)
3137{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003138 return PyUnicode_FromString(pyc_tag);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003139}
3140
Guido van Rossum79f25d91997-04-29 20:08:16 +00003141static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +00003142imp_get_suffixes(PyObject *self, PyObject *noargs)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003143{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003144 PyObject *list;
3145 struct filedescr *fdp;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003146
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003147 list = PyList_New(0);
3148 if (list == NULL)
3149 return NULL;
3150 for (fdp = _PyImport_Filetab; fdp->suffix != NULL; fdp++) {
3151 PyObject *item = Py_BuildValue("ssi",
3152 fdp->suffix, fdp->mode, fdp->type);
3153 if (item == NULL) {
3154 Py_DECREF(list);
3155 return NULL;
3156 }
3157 if (PyList_Append(list, item) < 0) {
3158 Py_DECREF(list);
3159 Py_DECREF(item);
3160 return NULL;
3161 }
3162 Py_DECREF(item);
3163 }
3164 return list;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003165}
3166
Guido van Rossum79f25d91997-04-29 20:08:16 +00003167static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003168call_find_module(char *name, PyObject *path)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003169{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003170 extern int fclose(FILE *);
3171 PyObject *fob, *ret;
3172 PyObject *pathobj;
3173 struct filedescr *fdp;
3174 char pathname[MAXPATHLEN+1];
3175 FILE *fp = NULL;
3176 int fd = -1;
3177 char *found_encoding = NULL;
3178 char *encoding = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003179
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003180 pathname[0] = '\0';
3181 if (path == Py_None)
3182 path = NULL;
3183 fdp = find_module(NULL, name, path, pathname, MAXPATHLEN+1, &fp, NULL);
3184 if (fdp == NULL)
3185 return NULL;
3186 if (fp != NULL) {
3187 fd = fileno(fp);
3188 if (fd != -1)
3189 fd = dup(fd);
3190 fclose(fp);
3191 fp = NULL;
3192 }
3193 if (fd != -1) {
3194 if (strchr(fdp->mode, 'b') == NULL) {
3195 /* PyTokenizer_FindEncoding() returns PyMem_MALLOC'ed
3196 memory. */
3197 found_encoding = PyTokenizer_FindEncoding(fd);
3198 lseek(fd, 0, 0); /* Reset position */
3199 if (found_encoding == NULL && PyErr_Occurred())
3200 return NULL;
3201 encoding = (found_encoding != NULL) ? found_encoding :
3202 (char*)PyUnicode_GetDefaultEncoding();
3203 }
3204 fob = PyFile_FromFd(fd, pathname, fdp->mode, -1,
3205 (char*)encoding, NULL, NULL, 1);
3206 if (fob == NULL) {
3207 close(fd);
3208 PyMem_FREE(found_encoding);
3209 return NULL;
3210 }
3211 }
3212 else {
3213 fob = Py_None;
3214 Py_INCREF(fob);
3215 }
3216 pathobj = PyUnicode_DecodeFSDefault(pathname);
3217 ret = Py_BuildValue("NN(ssi)",
3218 fob, pathobj, fdp->suffix, fdp->mode, fdp->type);
3219 PyMem_FREE(found_encoding);
Brett Cannon3bb42d92007-10-20 03:43:15 +00003220
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003221 return ret;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003222}
3223
Guido van Rossum79f25d91997-04-29 20:08:16 +00003224static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003225imp_find_module(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003226{
Victor Stinnerebc00522010-12-03 17:06:43 +00003227 PyObject *name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003228 PyObject *ret, *path = NULL;
Victor Stinnerebc00522010-12-03 17:06:43 +00003229 if (!PyArg_ParseTuple(args, "O&|O:find_module",
3230 PyUnicode_FSConverter, &name,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003231 &path))
3232 return NULL;
Victor Stinnerebc00522010-12-03 17:06:43 +00003233 ret = call_find_module(PyBytes_AS_STRING(name), path);
3234 Py_DECREF(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003235 return ret;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003236}
3237
3238static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003239imp_init_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003240{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003241 char *name;
3242 int ret;
3243 PyObject *m;
3244 if (!PyArg_ParseTuple(args, "s:init_builtin", &name))
3245 return NULL;
3246 ret = init_builtin(name);
3247 if (ret < 0)
3248 return NULL;
3249 if (ret == 0) {
3250 Py_INCREF(Py_None);
3251 return Py_None;
3252 }
3253 m = PyImport_AddModule(name);
3254 Py_XINCREF(m);
3255 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003256}
3257
Guido van Rossum79f25d91997-04-29 20:08:16 +00003258static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003259imp_init_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003260{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003261 char *name;
3262 int ret;
3263 PyObject *m;
3264 if (!PyArg_ParseTuple(args, "s:init_frozen", &name))
3265 return NULL;
3266 ret = PyImport_ImportFrozenModule(name);
3267 if (ret < 0)
3268 return NULL;
3269 if (ret == 0) {
3270 Py_INCREF(Py_None);
3271 return Py_None;
3272 }
3273 m = PyImport_AddModule(name);
3274 Py_XINCREF(m);
3275 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003276}
3277
Guido van Rossum79f25d91997-04-29 20:08:16 +00003278static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003279imp_get_frozen_object(PyObject *self, PyObject *args)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00003280{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003281 char *name;
Jack Jansen95ffa231995-10-03 14:38:41 +00003282
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003283 if (!PyArg_ParseTuple(args, "s:get_frozen_object", &name))
3284 return NULL;
3285 return get_frozen_object(name);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00003286}
3287
Guido van Rossum79f25d91997-04-29 20:08:16 +00003288static PyObject *
Brett Cannon8d110132009-03-15 02:20:16 +00003289imp_is_frozen_package(PyObject *self, PyObject *args)
3290{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003291 char *name;
Brett Cannon8d110132009-03-15 02:20:16 +00003292
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003293 if (!PyArg_ParseTuple(args, "s:is_frozen_package", &name))
3294 return NULL;
3295 return is_frozen_package(name);
Brett Cannon8d110132009-03-15 02:20:16 +00003296}
3297
3298static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003299imp_is_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003300{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003301 char *name;
3302 if (!PyArg_ParseTuple(args, "s:is_builtin", &name))
3303 return NULL;
3304 return PyLong_FromLong(is_builtin(name));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003305}
3306
Guido van Rossum79f25d91997-04-29 20:08:16 +00003307static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003308imp_is_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003309{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003310 char *name;
3311 struct _frozen *p;
3312 if (!PyArg_ParseTuple(args, "s:is_frozen", &name))
3313 return NULL;
3314 p = find_frozen(name);
3315 return PyBool_FromLong((long) (p == NULL ? 0 : p->size));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003316}
3317
3318static FILE *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003319get_file(char *pathname, PyObject *fob, char *mode)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003320{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003321 FILE *fp;
3322 if (mode[0] == 'U')
3323 mode = "r" PY_STDIOTEXTMODE;
3324 if (fob == NULL) {
3325 fp = fopen(pathname, mode);
3326 }
3327 else {
3328 int fd = PyObject_AsFileDescriptor(fob);
3329 if (fd == -1)
3330 return NULL;
3331 if (!_PyVerify_fd(fd))
3332 goto error;
3333 /* the FILE struct gets a new fd, so that it can be closed
3334 * independently of the file descriptor given
3335 */
3336 fd = dup(fd);
3337 if (fd == -1)
3338 goto error;
3339 fp = fdopen(fd, mode);
3340 }
3341 if (fp)
3342 return fp;
Kristján Valur Jónssone1b04452009-03-31 17:43:39 +00003343error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003344 PyErr_SetFromErrno(PyExc_IOError);
3345 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003346}
3347
Guido van Rossum79f25d91997-04-29 20:08:16 +00003348static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003349imp_load_compiled(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003350{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003351 char *name;
Victor Stinnerebc00522010-12-03 17:06:43 +00003352 PyObject *pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003353 PyObject *fob = NULL;
3354 PyObject *m;
3355 FILE *fp;
Victor Stinnerebc00522010-12-03 17:06:43 +00003356 if (!PyArg_ParseTuple(args, "sO&|O:load_compiled",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003357 &name,
Victor Stinnerebc00522010-12-03 17:06:43 +00003358 PyUnicode_FSConverter, &pathname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003359 &fob))
3360 return NULL;
Victor Stinnerebc00522010-12-03 17:06:43 +00003361 fp = get_file(PyBytes_AS_STRING(pathname), fob, "rb");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003362 if (fp == NULL) {
Victor Stinnerebc00522010-12-03 17:06:43 +00003363 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003364 return NULL;
3365 }
Victor Stinnerebc00522010-12-03 17:06:43 +00003366 m = load_compiled_module(name, PyBytes_AS_STRING(pathname), fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003367 fclose(fp);
Victor Stinnerebc00522010-12-03 17:06:43 +00003368 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003369 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003370}
3371
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003372#ifdef HAVE_DYNAMIC_LOADING
3373
Guido van Rossum79f25d91997-04-29 20:08:16 +00003374static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003375imp_load_dynamic(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003376{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003377 char *name;
Victor Stinner8dbf6292010-10-15 12:48:01 +00003378 PyObject *pathbytes;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003379 char *pathname;
3380 PyObject *fob = NULL;
3381 PyObject *m;
3382 FILE *fp = NULL;
Victor Stinner8dbf6292010-10-15 12:48:01 +00003383 if (!PyArg_ParseTuple(args, "sO&|O:load_dynamic",
3384 &name, PyUnicode_FSConverter, &pathbytes, &fob))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003385 return NULL;
Victor Stinner8dbf6292010-10-15 12:48:01 +00003386 pathname = PyBytes_AS_STRING(pathbytes);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003387 if (fob) {
3388 fp = get_file(pathname, fob, "r");
3389 if (fp == NULL) {
Victor Stinner8dbf6292010-10-15 12:48:01 +00003390 Py_DECREF(pathbytes);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003391 return NULL;
3392 }
3393 }
3394 m = _PyImport_LoadDynamicModule(name, pathname, fp);
Victor Stinner8dbf6292010-10-15 12:48:01 +00003395 Py_DECREF(pathbytes);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003396 if (fp)
3397 fclose(fp);
3398 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003399}
3400
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003401#endif /* HAVE_DYNAMIC_LOADING */
3402
Guido van Rossum79f25d91997-04-29 20:08:16 +00003403static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003404imp_load_source(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003405{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003406 char *name;
Victor Stinnerebc00522010-12-03 17:06:43 +00003407 PyObject *pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003408 PyObject *fob = NULL;
3409 PyObject *m;
3410 FILE *fp;
Victor Stinnerebc00522010-12-03 17:06:43 +00003411 if (!PyArg_ParseTuple(args, "sO&|O:load_source",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003412 &name,
Victor Stinnerebc00522010-12-03 17:06:43 +00003413 PyUnicode_FSConverter, &pathname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003414 &fob))
3415 return NULL;
Victor Stinnerebc00522010-12-03 17:06:43 +00003416 fp = get_file(PyBytes_AS_STRING(pathname), fob, "r");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003417 if (fp == NULL) {
Victor Stinnerebc00522010-12-03 17:06:43 +00003418 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003419 return NULL;
3420 }
Victor Stinnerebc00522010-12-03 17:06:43 +00003421 m = load_source_module(name, PyBytes_AS_STRING(pathname), fp);
3422 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003423 fclose(fp);
3424 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003425}
3426
Guido van Rossum79f25d91997-04-29 20:08:16 +00003427static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003428imp_load_module(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003429{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003430 char *name;
3431 PyObject *fob;
Victor Stinner1a563032010-10-15 22:43:10 +00003432 PyObject *pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003433 PyObject * ret;
3434 char *suffix; /* Unused */
3435 char *mode;
3436 int type;
3437 FILE *fp;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003438
Victor Stinner1a563032010-10-15 22:43:10 +00003439 if (!PyArg_ParseTuple(args, "sOO&(ssi):load_module",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003440 &name, &fob,
Victor Stinner1a563032010-10-15 22:43:10 +00003441 PyUnicode_FSConverter, &pathname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003442 &suffix, &mode, &type))
3443 return NULL;
3444 if (*mode) {
3445 /* Mode must start with 'r' or 'U' and must not contain '+'.
3446 Implicit in this test is the assumption that the mode
3447 may contain other modifiers like 'b' or 't'. */
Guido van Rossum5e2c5fa2002-05-30 17:33:07 +00003448
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003449 if (!(*mode == 'r' || *mode == 'U') || strchr(mode, '+')) {
3450 PyErr_Format(PyExc_ValueError,
3451 "invalid file open mode %.200s", mode);
Victor Stinner1a563032010-10-15 22:43:10 +00003452 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003453 return NULL;
3454 }
3455 }
3456 if (fob == Py_None)
3457 fp = NULL;
3458 else {
3459 fp = get_file(NULL, fob, mode);
3460 if (fp == NULL) {
Victor Stinner1a563032010-10-15 22:43:10 +00003461 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003462 return NULL;
3463 }
3464 }
Victor Stinner1a563032010-10-15 22:43:10 +00003465 ret = load_module(name, fp, PyBytes_AS_STRING(pathname), type, NULL);
3466 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003467 if (fp)
3468 fclose(fp);
3469 return ret;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003470}
3471
3472static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003473imp_load_package(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003474{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003475 char *name;
Victor Stinnerebc00522010-12-03 17:06:43 +00003476 PyObject *pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003477 PyObject * ret;
Victor Stinnerebc00522010-12-03 17:06:43 +00003478 if (!PyArg_ParseTuple(args, "sO&:load_package",
3479 &name, PyUnicode_FSConverter, &pathname))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003480 return NULL;
Victor Stinnerebc00522010-12-03 17:06:43 +00003481 ret = load_package(name, PyBytes_AS_STRING(pathname));
3482 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003483 return ret;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003484}
3485
3486static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003487imp_new_module(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003488{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003489 char *name;
3490 if (!PyArg_ParseTuple(args, "s:new_module", &name))
3491 return NULL;
3492 return PyModule_New(name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003493}
3494
Christian Heimes13a7a212008-01-07 17:13:09 +00003495static PyObject *
3496imp_reload(PyObject *self, PyObject *v)
3497{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003498 return PyImport_ReloadModule(v);
Christian Heimes13a7a212008-01-07 17:13:09 +00003499}
3500
3501PyDoc_STRVAR(doc_reload,
3502"reload(module) -> module\n\
3503\n\
3504Reload the module. The module must have been successfully imported before.");
3505
Barry Warsaw28a691b2010-04-17 00:19:56 +00003506static PyObject *
3507imp_cache_from_source(PyObject *self, PyObject *args, PyObject *kws)
3508{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003509 static char *kwlist[] = {"path", "debug_override", NULL};
Barry Warsaw28a691b2010-04-17 00:19:56 +00003510
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003511 char buf[MAXPATHLEN+1];
Victor Stinner3ea23dd2010-10-15 20:34:32 +00003512 PyObject *pathbytes;
3513 char *cpathname;
Benjamin Peterson294a9fc2010-10-16 03:12:39 +00003514 PyObject *debug_override = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003515 int debug = !Py_OptimizeFlag;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003516
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003517 if (!PyArg_ParseTupleAndKeywords(
Victor Stinner3ea23dd2010-10-15 20:34:32 +00003518 args, kws, "O&|O", kwlist,
3519 PyUnicode_FSConverter, &pathbytes, &debug_override))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003520 return NULL;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003521
Benjamin Peterson294a9fc2010-10-16 03:12:39 +00003522 if (debug_override != NULL &&
3523 (debug = PyObject_IsTrue(debug_override)) < 0) {
3524 Py_DECREF(pathbytes);
3525 return NULL;
3526 }
Barry Warsaw28a691b2010-04-17 00:19:56 +00003527
Victor Stinner3ea23dd2010-10-15 20:34:32 +00003528 cpathname = make_compiled_pathname(
3529 PyBytes_AS_STRING(pathbytes),
3530 buf, MAXPATHLEN+1, debug);
3531 Py_DECREF(pathbytes);
Barry Warsaw28a691b2010-04-17 00:19:56 +00003532
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003533 if (cpathname == NULL) {
3534 PyErr_Format(PyExc_SystemError, "path buffer too short");
3535 return NULL;
3536 }
Victor Stinner88bd8912010-10-15 22:46:07 +00003537 return PyUnicode_DecodeFSDefault(buf);
Barry Warsaw28a691b2010-04-17 00:19:56 +00003538}
3539
3540PyDoc_STRVAR(doc_cache_from_source,
Éric Araujo5df11082011-11-03 03:38:44 +01003541"cache_from_source(path, [debug_override]) -> path\n\
3542Given the path to a .py file, return the path to its .pyc/.pyo file.\n\
Barry Warsaw28a691b2010-04-17 00:19:56 +00003543\n\
3544The .py file does not need to exist; this simply returns the path to the\n\
3545.pyc/.pyo file calculated as if the .py file were imported. The extension\n\
3546will be .pyc unless __debug__ is not defined, then it will be .pyo.\n\
3547\n\
3548If debug_override is not None, then it must be a boolean and is taken as\n\
3549the value of __debug__ instead.");
3550
3551static PyObject *
3552imp_source_from_cache(PyObject *self, PyObject *args, PyObject *kws)
3553{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003554 static char *kwlist[] = {"path", NULL};
Barry Warsaw28a691b2010-04-17 00:19:56 +00003555
Victor Stinnerebc00522010-12-03 17:06:43 +00003556 PyObject *pathname_obj;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003557 char *pathname;
3558 char buf[MAXPATHLEN+1];
Barry Warsaw28a691b2010-04-17 00:19:56 +00003559
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003560 if (!PyArg_ParseTupleAndKeywords(
Victor Stinnerebc00522010-12-03 17:06:43 +00003561 args, kws, "O&", kwlist,
3562 PyUnicode_FSConverter, &pathname_obj))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003563 return NULL;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003564
Victor Stinnerebc00522010-12-03 17:06:43 +00003565 pathname = PyBytes_AS_STRING(pathname_obj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003566 if (make_source_pathname(pathname, buf) == NULL) {
3567 PyErr_Format(PyExc_ValueError, "Not a PEP 3147 pyc path: %s",
3568 pathname);
Victor Stinnerebc00522010-12-03 17:06:43 +00003569 Py_DECREF(pathname_obj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003570 return NULL;
3571 }
Victor Stinnerebc00522010-12-03 17:06:43 +00003572 Py_DECREF(pathname_obj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003573 return PyUnicode_FromString(buf);
Barry Warsaw28a691b2010-04-17 00:19:56 +00003574}
3575
3576PyDoc_STRVAR(doc_source_from_cache,
Éric Araujo5df11082011-11-03 03:38:44 +01003577"source_from_cache(path) -> path\n\
3578Given the path to a .pyc./.pyo file, return the path to its .py file.\n\
Barry Warsaw28a691b2010-04-17 00:19:56 +00003579\n\
3580The .pyc/.pyo file does not need to exist; this simply returns the path to\n\
3581the .py file calculated to correspond to the .pyc/.pyo file. If path\n\
3582does not conform to PEP 3147 format, ValueError will be raised.");
3583
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003584/* Doc strings */
3585
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003586PyDoc_STRVAR(doc_imp,
3587"This module provides the components needed to build your own\n\
3588__import__ function. Undocumented functions are obsolete.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003589
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003590PyDoc_STRVAR(doc_find_module,
3591"find_module(name, [path]) -> (file, filename, (suffix, mode, type))\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003592Search for a module. If path is omitted or None, search for a\n\
3593built-in, frozen or special module and continue search in sys.path.\n\
3594The module name cannot contain '.'; to search for a submodule of a\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003595package, pass the submodule name and the package's __path__.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003596
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003597PyDoc_STRVAR(doc_load_module,
3598"load_module(name, file, filename, (suffix, mode, type)) -> module\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003599Load a module, given information returned by find_module().\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003600The module name must include the full package name, if any.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003601
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003602PyDoc_STRVAR(doc_get_magic,
3603"get_magic() -> string\n\
3604Return the magic number for .pyc or .pyo files.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003605
Barry Warsaw28a691b2010-04-17 00:19:56 +00003606PyDoc_STRVAR(doc_get_tag,
3607"get_tag() -> string\n\
3608Return the magic tag for .pyc or .pyo files.");
3609
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003610PyDoc_STRVAR(doc_get_suffixes,
3611"get_suffixes() -> [(suffix, mode, type), ...]\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003612Return a list of (suffix, mode, type) tuples describing the files\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003613that find_module() looks for.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003614
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003615PyDoc_STRVAR(doc_new_module,
3616"new_module(name) -> module\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003617Create a new module. Do not enter it in sys.modules.\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003618The module name must include the full package name, if any.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003619
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003620PyDoc_STRVAR(doc_lock_held,
Tim Petersa7c65092004-08-01 23:26:05 +00003621"lock_held() -> boolean\n\
3622Return True if the import lock is currently held, else False.\n\
3623On platforms without threads, return False.");
Tim Peters69232342001-08-30 05:16:13 +00003624
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00003625PyDoc_STRVAR(doc_acquire_lock,
3626"acquire_lock() -> None\n\
Neal Norwitz2294c0d2003-02-12 23:02:21 +00003627Acquires the interpreter's import lock for the current thread.\n\
3628This lock should be used by import hooks to ensure thread-safety\n\
3629when importing modules.\n\
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00003630On platforms without threads, this function does nothing.");
3631
3632PyDoc_STRVAR(doc_release_lock,
3633"release_lock() -> None\n\
3634Release the interpreter's import lock.\n\
3635On platforms without threads, this function does nothing.");
3636
Guido van Rossum79f25d91997-04-29 20:08:16 +00003637static PyMethodDef imp_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003638 {"find_module", imp_find_module, METH_VARARGS, doc_find_module},
3639 {"get_magic", imp_get_magic, METH_NOARGS, doc_get_magic},
3640 {"get_tag", imp_get_tag, METH_NOARGS, doc_get_tag},
3641 {"get_suffixes", imp_get_suffixes, METH_NOARGS, doc_get_suffixes},
3642 {"load_module", imp_load_module, METH_VARARGS, doc_load_module},
3643 {"new_module", imp_new_module, METH_VARARGS, doc_new_module},
3644 {"lock_held", imp_lock_held, METH_NOARGS, doc_lock_held},
3645 {"acquire_lock", imp_acquire_lock, METH_NOARGS, doc_acquire_lock},
3646 {"release_lock", imp_release_lock, METH_NOARGS, doc_release_lock},
3647 {"reload", imp_reload, METH_O, doc_reload},
3648 {"cache_from_source", (PyCFunction)imp_cache_from_source,
3649 METH_VARARGS | METH_KEYWORDS, doc_cache_from_source},
3650 {"source_from_cache", (PyCFunction)imp_source_from_cache,
3651 METH_VARARGS | METH_KEYWORDS, doc_source_from_cache},
3652 /* The rest are obsolete */
3653 {"get_frozen_object", imp_get_frozen_object, METH_VARARGS},
3654 {"is_frozen_package", imp_is_frozen_package, METH_VARARGS},
3655 {"init_builtin", imp_init_builtin, METH_VARARGS},
3656 {"init_frozen", imp_init_frozen, METH_VARARGS},
3657 {"is_builtin", imp_is_builtin, METH_VARARGS},
3658 {"is_frozen", imp_is_frozen, METH_VARARGS},
3659 {"load_compiled", imp_load_compiled, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003660#ifdef HAVE_DYNAMIC_LOADING
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003661 {"load_dynamic", imp_load_dynamic, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003662#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003663 {"load_package", imp_load_package, METH_VARARGS},
3664 {"load_source", imp_load_source, METH_VARARGS},
3665 {NULL, NULL} /* sentinel */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003666};
3667
Guido van Rossum1a8791e1998-08-04 22:46:29 +00003668static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003669setint(PyObject *d, char *name, int value)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003670{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003671 PyObject *v;
3672 int err;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003673
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003674 v = PyLong_FromLong((long)value);
3675 err = PyDict_SetItemString(d, name, v);
3676 Py_XDECREF(v);
3677 return err;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003678}
3679
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003680typedef struct {
3681 PyObject_HEAD
3682} NullImporter;
3683
3684static int
3685NullImporter_init(NullImporter *self, PyObject *args, PyObject *kwds)
3686{
Victor Stinner1a4d12d2010-08-13 13:07:29 +00003687#ifndef MS_WINDOWS
3688 PyObject *path;
3689 struct stat statbuf;
3690 int rv;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003691
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003692 if (!_PyArg_NoKeywords("NullImporter()", kwds))
3693 return -1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003694
Victor Stinner1a4d12d2010-08-13 13:07:29 +00003695 if (!PyArg_ParseTuple(args, "O&:NullImporter",
3696 PyUnicode_FSConverter, &path))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003697 return -1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003698
Victor Stinner1a4d12d2010-08-13 13:07:29 +00003699 if (PyBytes_GET_SIZE(path) == 0) {
3700 Py_DECREF(path);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003701 PyErr_SetString(PyExc_ImportError, "empty pathname");
3702 return -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003703 }
Victor Stinner1a4d12d2010-08-13 13:07:29 +00003704
3705 rv = stat(PyBytes_AS_STRING(path), &statbuf);
3706 Py_DECREF(path);
3707 if (rv == 0) {
3708 /* it exists */
3709 if (S_ISDIR(statbuf.st_mode)) {
3710 /* it's a directory */
3711 PyErr_SetString(PyExc_ImportError, "existing directory");
3712 return -1;
3713 }
3714 }
3715#else /* MS_WINDOWS */
3716 PyObject *pathobj;
3717 DWORD rv;
Victor Stinner255dfdb2010-09-29 10:28:51 +00003718 wchar_t *path;
Victor Stinner1a4d12d2010-08-13 13:07:29 +00003719
3720 if (!_PyArg_NoKeywords("NullImporter()", kwds))
3721 return -1;
3722
3723 if (!PyArg_ParseTuple(args, "U:NullImporter",
3724 &pathobj))
3725 return -1;
3726
3727 if (PyUnicode_GET_SIZE(pathobj) == 0) {
3728 PyErr_SetString(PyExc_ImportError, "empty pathname");
3729 return -1;
3730 }
3731
Victor Stinnerbeb4135b2010-10-07 01:02:42 +00003732 path = PyUnicode_AsWideCharString(pathobj, NULL);
Victor Stinner255dfdb2010-09-29 10:28:51 +00003733 if (path == NULL)
Victor Stinner1a4d12d2010-08-13 13:07:29 +00003734 return -1;
3735 /* see issue1293 and issue3677:
3736 * stat() on Windows doesn't recognise paths like
3737 * "e:\\shared\\" and "\\\\whiterab-c2znlh\\shared" as dirs.
3738 */
3739 rv = GetFileAttributesW(path);
Victor Stinner255dfdb2010-09-29 10:28:51 +00003740 PyMem_Free(path);
Victor Stinner1a4d12d2010-08-13 13:07:29 +00003741 if (rv != INVALID_FILE_ATTRIBUTES) {
3742 /* it exists */
3743 if (rv & FILE_ATTRIBUTE_DIRECTORY) {
3744 /* it's a directory */
3745 PyErr_SetString(PyExc_ImportError, "existing directory");
3746 return -1;
3747 }
3748 }
3749#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003750 return 0;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003751}
3752
3753static PyObject *
3754NullImporter_find_module(NullImporter *self, PyObject *args)
3755{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003756 Py_RETURN_NONE;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003757}
3758
3759static PyMethodDef NullImporter_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003760 {"find_module", (PyCFunction)NullImporter_find_module, METH_VARARGS,
3761 "Always return None"
3762 },
3763 {NULL} /* Sentinel */
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003764};
3765
3766
Christian Heimes9cd17752007-11-18 19:35:23 +00003767PyTypeObject PyNullImporter_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003768 PyVarObject_HEAD_INIT(NULL, 0)
3769 "imp.NullImporter", /*tp_name*/
3770 sizeof(NullImporter), /*tp_basicsize*/
3771 0, /*tp_itemsize*/
3772 0, /*tp_dealloc*/
3773 0, /*tp_print*/
3774 0, /*tp_getattr*/
3775 0, /*tp_setattr*/
3776 0, /*tp_reserved*/
3777 0, /*tp_repr*/
3778 0, /*tp_as_number*/
3779 0, /*tp_as_sequence*/
3780 0, /*tp_as_mapping*/
3781 0, /*tp_hash */
3782 0, /*tp_call*/
3783 0, /*tp_str*/
3784 0, /*tp_getattro*/
3785 0, /*tp_setattro*/
3786 0, /*tp_as_buffer*/
3787 Py_TPFLAGS_DEFAULT, /*tp_flags*/
3788 "Null importer object", /* tp_doc */
3789 0, /* tp_traverse */
3790 0, /* tp_clear */
3791 0, /* tp_richcompare */
3792 0, /* tp_weaklistoffset */
3793 0, /* tp_iter */
3794 0, /* tp_iternext */
3795 NullImporter_methods, /* tp_methods */
3796 0, /* tp_members */
3797 0, /* tp_getset */
3798 0, /* tp_base */
3799 0, /* tp_dict */
3800 0, /* tp_descr_get */
3801 0, /* tp_descr_set */
3802 0, /* tp_dictoffset */
3803 (initproc)NullImporter_init, /* tp_init */
3804 0, /* tp_alloc */
3805 PyType_GenericNew /* tp_new */
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003806};
3807
Martin v. Löwis1a214512008-06-11 05:26:20 +00003808static struct PyModuleDef impmodule = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003809 PyModuleDef_HEAD_INIT,
3810 "imp",
3811 doc_imp,
3812 0,
3813 imp_methods,
3814 NULL,
3815 NULL,
3816 NULL,
3817 NULL
Martin v. Löwis1a214512008-06-11 05:26:20 +00003818};
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003819
Jason Tishler6bc06ec2003-09-04 11:59:50 +00003820PyMODINIT_FUNC
Martin v. Löwis1a214512008-06-11 05:26:20 +00003821PyInit_imp(void)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003822{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003823 PyObject *m, *d;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003824
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003825 if (PyType_Ready(&PyNullImporter_Type) < 0)
3826 return NULL;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003827
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003828 m = PyModule_Create(&impmodule);
3829 if (m == NULL)
3830 goto failure;
3831 d = PyModule_GetDict(m);
3832 if (d == NULL)
3833 goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003834
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003835 if (setint(d, "SEARCH_ERROR", SEARCH_ERROR) < 0) goto failure;
3836 if (setint(d, "PY_SOURCE", PY_SOURCE) < 0) goto failure;
3837 if (setint(d, "PY_COMPILED", PY_COMPILED) < 0) goto failure;
3838 if (setint(d, "C_EXTENSION", C_EXTENSION) < 0) goto failure;
3839 if (setint(d, "PY_RESOURCE", PY_RESOURCE) < 0) goto failure;
3840 if (setint(d, "PKG_DIRECTORY", PKG_DIRECTORY) < 0) goto failure;
3841 if (setint(d, "C_BUILTIN", C_BUILTIN) < 0) goto failure;
3842 if (setint(d, "PY_FROZEN", PY_FROZEN) < 0) goto failure;
3843 if (setint(d, "PY_CODERESOURCE", PY_CODERESOURCE) < 0) goto failure;
3844 if (setint(d, "IMP_HOOK", IMP_HOOK) < 0) goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003845
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003846 Py_INCREF(&PyNullImporter_Type);
3847 PyModule_AddObject(m, "NullImporter", (PyObject *)&PyNullImporter_Type);
3848 return m;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003849 failure:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003850 Py_XDECREF(m);
3851 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003852}
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003853
3854
Guido van Rossumb18618d2000-05-03 23:44:39 +00003855/* API for embedding applications that want to add their own entries
3856 to the table of built-in modules. This should normally be called
3857 *before* Py_Initialize(). When the table resize fails, -1 is
3858 returned and the existing table is unchanged.
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003859
3860 After a similar function by Just van Rossum. */
3861
3862int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003863PyImport_ExtendInittab(struct _inittab *newtab)
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003864{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003865 static struct _inittab *our_copy = NULL;
3866 struct _inittab *p;
3867 int i, n;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003868
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003869 /* Count the number of entries in both tables */
3870 for (n = 0; newtab[n].name != NULL; n++)
3871 ;
3872 if (n == 0)
3873 return 0; /* Nothing to do */
3874 for (i = 0; PyImport_Inittab[i].name != NULL; i++)
3875 ;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003876
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003877 /* Allocate new memory for the combined table */
3878 p = our_copy;
3879 PyMem_RESIZE(p, struct _inittab, i+n+1);
3880 if (p == NULL)
3881 return -1;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003882
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003883 /* Copy the tables into the new memory */
3884 if (our_copy != PyImport_Inittab)
3885 memcpy(p, PyImport_Inittab, (i+1) * sizeof(struct _inittab));
3886 PyImport_Inittab = our_copy = p;
3887 memcpy(p+i, newtab, (n+1) * sizeof(struct _inittab));
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003888
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003889 return 0;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003890}
3891
3892/* Shorthand to add a single entry given a name and a function */
3893
3894int
Brett Cannona826f322009-04-02 03:41:46 +00003895PyImport_AppendInittab(const char *name, PyObject* (*initfunc)(void))
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003896{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003897 struct _inittab newtab[2];
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003898
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003899 memset(newtab, '\0', sizeof newtab);
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003900
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003901 newtab[0].name = (char *)name;
3902 newtab[0].initfunc = initfunc;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003903
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003904 return PyImport_ExtendInittab(newtab);
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003905}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00003906
3907#ifdef __cplusplus
3908}
3909#endif