blob: 598b7e09d909ab26c4e52ddf7eec93a9f341dabb [file] [log] [blame]
Guido van Rossumf70e43a1991-02-19 12:39:46 +00001
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002/* Module definition and import implementation */
3
Guido van Rossum79f25d91997-04-29 20:08:16 +00004#include "Python.h"
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00005
Jeremy Hylton3e0055f2005-10-20 19:59:25 +00006#include "Python-ast.h"
Guido van Rossumd8faa362007-04-27 19:54:29 +00007#undef Yield /* undefine macro conflicting with winbase.h */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00008#include "errcode.h"
Guido van Rossumc405b7b1991-06-04 19:39:42 +00009#include "marshal.h"
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000010#include "code.h"
Guido van Rossumd8bac6d1992-02-26 15:19:13 +000011#include "osdefs.h"
Guido van Rossum1ae940a1995-01-02 19:04:15 +000012#include "importdl.h"
Guido van Rossumc405b7b1991-06-04 19:39:42 +000013
Guido van Rossum55a83382000-09-20 20:31:38 +000014#ifdef HAVE_FCNTL_H
15#include <fcntl.h>
16#endif
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000017#ifdef __cplusplus
Brett Cannon9a5b25a2010-03-01 02:09:17 +000018extern "C" {
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000019#endif
Guido van Rossum55a83382000-09-20 20:31:38 +000020
Christian Heimesd3eb5a152008-02-24 00:38:49 +000021#ifdef MS_WINDOWS
22/* for stat.st_mode */
23typedef unsigned short mode_t;
Daniel Stutzbachc7937792010-09-09 21:18:04 +000024/* for _mkdir */
25#include <direct.h>
Christian Heimesd3eb5a152008-02-24 00:38:49 +000026#endif
27
Guido van Rossum21d335e1993-10-15 13:01:11 +000028
Jeremy Hyltond4ceb312004-04-01 02:45:22 +000029/* Magic word to reject .pyc files generated by other Python versions.
30 It should change for each incompatible change to the bytecode.
31
32 The value of CR and LF is incorporated so if you ever read or write
Guido van Rossum7faeab31995-07-07 22:50:36 +000033 a .pyc file in text mode the magic number will be wrong; also, the
Tim Peters36515e22001-11-18 04:06:29 +000034 Apple MPW compiler swaps their values, botching string constants.
Marc-André Lemburgbd3be8f2002-02-07 11:33:49 +000035
Guido van Rossum45aecf42006-03-15 04:58:47 +000036 The magic numbers must be spaced apart at least 2 values, as the
Martin v. Löwisef82d2f2004-06-27 16:51:46 +000037 -U interpeter flag will cause MAGIC+1 being used. They have been
38 odd numbers for some time now.
Marc-André Lemburgbd3be8f2002-02-07 11:33:49 +000039
Jeremy Hyltond4ceb312004-04-01 02:45:22 +000040 There were a variety of old schemes for setting the magic number.
41 The current working scheme is to increment the previous value by
42 10.
Guido van Rossumf6894922002-08-31 15:16:14 +000043
Barry Warsaw28a691b2010-04-17 00:19:56 +000044 Starting with the adoption of PEP 3147 in Python 3.2, every bump in magic
45 number also includes a new "magic tag", i.e. a human readable string used
46 to represent the magic number in __pycache__ directories. When you change
47 the magic number, you must also set a new unique magic tag. Generally this
48 can be named after the Python major version of the magic number bump, but
49 it can really be anything, as long as it's different than anything else
50 that's come before. The tags are included in the following table, starting
51 with Python 3.2a0.
52
Marc-André Lemburgbd3be8f2002-02-07 11:33:49 +000053 Known values:
54 Python 1.5: 20121
55 Python 1.5.1: 20121
56 Python 1.5.2: 20121
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000057 Python 1.6: 50428
Marc-André Lemburgbd3be8f2002-02-07 11:33:49 +000058 Python 2.0: 50823
59 Python 2.0.1: 50823
60 Python 2.1: 60202
61 Python 2.1.1: 60202
62 Python 2.1.2: 60202
63 Python 2.2: 60717
Neal Norwitz7fdcb412002-06-14 01:07:39 +000064 Python 2.3a0: 62011
Michael W. Hudsondd32a912002-08-15 14:59:02 +000065 Python 2.3a0: 62021
Guido van Rossumf6894922002-08-31 15:16:14 +000066 Python 2.3a0: 62011 (!)
Martin v. Löwisef82d2f2004-06-27 16:51:46 +000067 Python 2.4a0: 62041
Raymond Hettingerfd2d1f72004-08-23 23:37:48 +000068 Python 2.4a3: 62051
Raymond Hettinger2c31a052004-09-22 18:44:21 +000069 Python 2.4b1: 62061
Michael W. Hudsondf888462005-06-03 14:41:55 +000070 Python 2.5a0: 62071
Michael W. Hudsonaee2e282005-10-21 11:32:20 +000071 Python 2.5a0: 62081 (ast-branch)
Guido van Rossumc2e20742006-02-27 22:32:47 +000072 Python 2.5a0: 62091 (with)
Guido van Rossumf6694362006-03-10 02:28:35 +000073 Python 2.5a0: 62092 (changed WITH_CLEANUP opcode)
Thomas Wouters0e3f5912006-08-11 14:57:12 +000074 Python 2.5b3: 62101 (fix wrong code: for x, in ...)
75 Python 2.5b3: 62111 (fix wrong code: x += yield)
76 Python 2.5c1: 62121 (fix wrong lnotab with for loops and
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000077 storing constants that should have been removed)
Thomas Wouters89f507f2006-12-13 04:49:30 +000078 Python 2.5c2: 62131 (fix wrong code: for x, in ... in listcomp/genexp)
Christian Heimes99170a52007-12-19 02:07:34 +000079 Python 2.6a0: 62151 (peephole optimizations and STORE_MAP opcode)
Christian Heimesdd15f6c2008-03-16 00:07:10 +000080 Python 2.6a1: 62161 (WITH_CLEANUP optimization)
Guido van Rossum45aecf42006-03-15 04:58:47 +000081 Python 3000: 3000
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000082 3010 (removed UNARY_CONVERT)
83 3020 (added BUILD_SET)
84 3030 (added keyword-only parameters)
85 3040 (added signature annotations)
86 3050 (print becomes a function)
87 3060 (PEP 3115 metaclass syntax)
88 3061 (string literals become unicode)
89 3071 (PEP 3109 raise changes)
90 3081 (PEP 3137 make __file__ and __name__ unicode)
91 3091 (kill str8 interning)
92 3101 (merge from 2.6a0, see 62151)
93 3103 (__file__ points to source file)
Benjamin Peterson0f6cae02009-12-10 02:09:08 +000094 Python 3.0a4: 3111 (WITH_CLEANUP optimization).
95 Python 3.0a5: 3131 (lexical exception stacking, including POP_EXCEPT)
96 Python 3.1a0: 3141 (optimize list, set and dict comprehensions:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000097 change LIST_APPEND and SET_ADD, add MAP_ADD)
Benjamin Peterson0f6cae02009-12-10 02:09:08 +000098 Python 3.1a0: 3151 (optimize conditional branches:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000099 introduce POP_JUMP_IF_FALSE and POP_JUMP_IF_TRUE)
Benjamin Peterson876b2f22009-06-28 03:18:59 +0000100 Python 3.2a0: 3160 (add SETUP_WITH)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000101 tag: cpython-32
Antoine Pitrou74a69fa2010-09-04 18:43:52 +0000102 Python 3.2a1: 3170 (add DUP_TOP_TWO, remove DUP_TOPX and ROT_FOUR)
103 tag: cpython-32
Benjamin Peterson6246d6d2010-09-10 21:51:44 +0000104 Python 3.2a2 3180 (add DELETE_DEREF)
Tim Peters36515e22001-11-18 04:06:29 +0000105*/
Guido van Rossum3ddee711991-12-16 13:06:34 +0000106
Nick Coghlancd419ab2010-09-11 00:39:25 +0000107/* MAGIC must change whenever the bytecode emitted by the compiler may no
108 longer be understood by older implementations of the eval loop (usually
109 due to the addition of new opcodes)
110 TAG must change for each major Python release. The magic number will take
111 care of any bytecode changes that occur during development.
Barry Warsaw28a691b2010-04-17 00:19:56 +0000112*/
Benjamin Peterson6246d6d2010-09-10 21:51:44 +0000113#define MAGIC (3180 | ((long)'\r'<<16) | ((long)'\n'<<24))
Barry Warsaw28a691b2010-04-17 00:19:56 +0000114#define TAG "cpython-32"
115#define CACHEDIR "__pycache__"
116/* Current magic word and string tag as globals. */
Guido van Rossum96774c12000-05-01 20:19:08 +0000117static long pyc_magic = MAGIC;
Barry Warsaw28a691b2010-04-17 00:19:56 +0000118static const char *pyc_tag = TAG;
Guido van Rossum96774c12000-05-01 20:19:08 +0000119
Victor Stinner49d3f252010-10-17 01:24:53 +0000120/* See _PyImport_FixupExtensionUnicode() below */
Guido van Rossum25ce5661997-08-02 03:10:38 +0000121static PyObject *extensions = NULL;
Guido van Rossum3f5da241990-12-20 15:06:42 +0000122
Guido van Rossum771c6c81997-10-31 18:37:24 +0000123/* This table is defined in config.c: */
124extern struct _inittab _PyImport_Inittab[];
125
Guido van Rossumce3a72a2007-10-19 23:16:50 +0000126/* Method from Parser/tokenizer.c */
Guido van Rossum40d20bc2007-10-22 00:09:51 +0000127extern char * PyTokenizer_FindEncoding(int);
Guido van Rossumce3a72a2007-10-19 23:16:50 +0000128
Guido van Rossum771c6c81997-10-31 18:37:24 +0000129struct _inittab *PyImport_Inittab = _PyImport_Inittab;
Guido van Rossum66f1fa81991-04-03 19:03:52 +0000130
Guido van Rossumed1170e1999-12-20 21:23:41 +0000131/* these tables define the module suffixes that Python recognizes */
132struct filedescr * _PyImport_Filetab = NULL;
Guido van Rossum48a680c2001-03-02 06:34:14 +0000133
Guido van Rossumed1170e1999-12-20 21:23:41 +0000134static const struct filedescr _PyImport_StandardFiletab[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000135 {".py", "U", PY_SOURCE},
Martin v. Löwis6238d2b2002-06-30 15:26:10 +0000136#ifdef MS_WINDOWS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000137 {".pyw", "U", PY_SOURCE},
Tim Peters36515e22001-11-18 04:06:29 +0000138#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000139 {".pyc", "rb", PY_COMPILED},
140 {0, 0}
Guido van Rossumed1170e1999-12-20 21:23:41 +0000141};
142
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000143
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000144/* Initialize things */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000145
146void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000147_PyImport_Init(void)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000148{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000149 const struct filedescr *scan;
150 struct filedescr *filetab;
151 int countD = 0;
152 int countS = 0;
Guido van Rossumed1170e1999-12-20 21:23:41 +0000153
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000154 /* prepare _PyImport_Filetab: copy entries from
155 _PyImport_DynLoadFiletab and _PyImport_StandardFiletab.
156 */
Guido van Rossum04110fb2007-08-24 16:32:05 +0000157#ifdef HAVE_DYNAMIC_LOADING
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000158 for (scan = _PyImport_DynLoadFiletab; scan->suffix != NULL; ++scan)
159 ++countD;
Guido van Rossum04110fb2007-08-24 16:32:05 +0000160#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000161 for (scan = _PyImport_StandardFiletab; scan->suffix != NULL; ++scan)
162 ++countS;
163 filetab = PyMem_NEW(struct filedescr, countD + countS + 1);
164 if (filetab == NULL)
165 Py_FatalError("Can't initialize import file table.");
Guido van Rossum04110fb2007-08-24 16:32:05 +0000166#ifdef HAVE_DYNAMIC_LOADING
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000167 memcpy(filetab, _PyImport_DynLoadFiletab,
168 countD * sizeof(struct filedescr));
Guido van Rossum04110fb2007-08-24 16:32:05 +0000169#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000170 memcpy(filetab + countD, _PyImport_StandardFiletab,
171 countS * sizeof(struct filedescr));
172 filetab[countD + countS].suffix = NULL;
Guido van Rossumed1170e1999-12-20 21:23:41 +0000173
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000174 _PyImport_Filetab = filetab;
Guido van Rossumed1170e1999-12-20 21:23:41 +0000175
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000176 if (Py_OptimizeFlag) {
177 /* Replace ".pyc" with ".pyo" in _PyImport_Filetab */
178 for (; filetab->suffix != NULL; filetab++) {
179 if (strcmp(filetab->suffix, ".pyc") == 0)
180 filetab->suffix = ".pyo";
181 }
182 }
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000183}
184
Guido van Rossum25ce5661997-08-02 03:10:38 +0000185void
Just van Rossum52e14d62002-12-30 22:08:05 +0000186_PyImportHooks_Init(void)
187{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000188 PyObject *v, *path_hooks = NULL, *zimpimport;
189 int err = 0;
Just van Rossum52e14d62002-12-30 22:08:05 +0000190
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000191 /* adding sys.path_hooks and sys.path_importer_cache, setting up
192 zipimport */
193 if (PyType_Ready(&PyNullImporter_Type) < 0)
194 goto error;
Just van Rossum52e14d62002-12-30 22:08:05 +0000195
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000196 if (Py_VerboseFlag)
197 PySys_WriteStderr("# installing zipimport hook\n");
Just van Rossum52e14d62002-12-30 22:08:05 +0000198
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000199 v = PyList_New(0);
200 if (v == NULL)
201 goto error;
202 err = PySys_SetObject("meta_path", v);
203 Py_DECREF(v);
204 if (err)
205 goto error;
206 v = PyDict_New();
207 if (v == NULL)
208 goto error;
209 err = PySys_SetObject("path_importer_cache", v);
210 Py_DECREF(v);
211 if (err)
212 goto error;
213 path_hooks = PyList_New(0);
214 if (path_hooks == NULL)
215 goto error;
216 err = PySys_SetObject("path_hooks", path_hooks);
217 if (err) {
Just van Rossum52e14d62002-12-30 22:08:05 +0000218 error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000219 PyErr_Print();
220 Py_FatalError("initializing sys.meta_path, sys.path_hooks, "
221 "path_importer_cache, or NullImporter failed"
222 );
223 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000224
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000225 zimpimport = PyImport_ImportModule("zipimport");
226 if (zimpimport == NULL) {
227 PyErr_Clear(); /* No zip import module -- okay */
228 if (Py_VerboseFlag)
229 PySys_WriteStderr("# can't import zipimport\n");
230 }
231 else {
232 PyObject *zipimporter = PyObject_GetAttrString(zimpimport,
233 "zipimporter");
234 Py_DECREF(zimpimport);
235 if (zipimporter == NULL) {
236 PyErr_Clear(); /* No zipimporter object -- okay */
237 if (Py_VerboseFlag)
238 PySys_WriteStderr(
239 "# can't import zipimport.zipimporter\n");
240 }
241 else {
242 /* sys.path_hooks.append(zipimporter) */
243 err = PyList_Append(path_hooks, zipimporter);
244 Py_DECREF(zipimporter);
245 if (err)
246 goto error;
247 if (Py_VerboseFlag)
248 PySys_WriteStderr(
249 "# installed zipimport hook\n");
250 }
251 }
252 Py_DECREF(path_hooks);
Just van Rossum52e14d62002-12-30 22:08:05 +0000253}
254
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000255/* Locking primitives to prevent parallel imports of the same module
256 in different threads to return with a partially loaded module.
257 These calls are serialized by the global interpreter lock. */
258
259#ifdef WITH_THREAD
260
Guido van Rossum49b56061998-10-01 20:42:43 +0000261#include "pythread.h"
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000262
Guido van Rossum65d5b571998-12-21 19:32:43 +0000263static PyThread_type_lock import_lock = 0;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000264static long import_lock_thread = -1;
265static int import_lock_level = 0;
266
Benjamin Peterson0df35a92009-10-04 20:32:25 +0000267void
268_PyImport_AcquireLock(void)
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000269{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000270 long me = PyThread_get_thread_ident();
271 if (me == -1)
272 return; /* Too bad */
273 if (import_lock == NULL) {
274 import_lock = PyThread_allocate_lock();
275 if (import_lock == NULL)
276 return; /* Nothing much we can do. */
277 }
278 if (import_lock_thread == me) {
279 import_lock_level++;
280 return;
281 }
282 if (import_lock_thread != -1 || !PyThread_acquire_lock(import_lock, 0))
283 {
284 PyThreadState *tstate = PyEval_SaveThread();
285 PyThread_acquire_lock(import_lock, 1);
286 PyEval_RestoreThread(tstate);
287 }
288 import_lock_thread = me;
289 import_lock_level = 1;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000290}
291
Benjamin Peterson0df35a92009-10-04 20:32:25 +0000292int
293_PyImport_ReleaseLock(void)
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000294{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000295 long me = PyThread_get_thread_ident();
296 if (me == -1 || import_lock == NULL)
297 return 0; /* Too bad */
298 if (import_lock_thread != me)
299 return -1;
300 import_lock_level--;
301 if (import_lock_level == 0) {
302 import_lock_thread = -1;
303 PyThread_release_lock(import_lock);
304 }
305 return 1;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000306}
307
Gregory P. Smith24cec9f2010-03-01 06:18:41 +0000308/* This function is called from PyOS_AfterFork to ensure that newly
309 created child processes do not share locks with the parent.
310 We now acquire the import lock around fork() calls but on some platforms
311 (Solaris 9 and earlier? see isue7242) that still left us with problems. */
Guido van Rossum8ee3e5a2005-09-14 18:09:42 +0000312
313void
314_PyImport_ReInitLock(void)
315{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000316 if (import_lock != NULL)
317 import_lock = PyThread_allocate_lock();
Nick Coghlanb2ddf792010-12-02 04:11:46 +0000318 if (import_lock_level > 1) {
319 /* Forked as a side effect of import */
320 long me = PyThread_get_thread_ident();
321 PyThread_acquire_lock(import_lock, 0);
322 /* XXX: can the previous line fail? */
323 import_lock_thread = me;
324 import_lock_level--;
325 } else {
326 import_lock_thread = -1;
327 import_lock_level = 0;
328 }
Guido van Rossum8ee3e5a2005-09-14 18:09:42 +0000329}
330
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000331#endif
332
Tim Peters69232342001-08-30 05:16:13 +0000333static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000334imp_lock_held(PyObject *self, PyObject *noargs)
Tim Peters69232342001-08-30 05:16:13 +0000335{
Tim Peters69232342001-08-30 05:16:13 +0000336#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000337 return PyBool_FromLong(import_lock_thread != -1);
Tim Peters69232342001-08-30 05:16:13 +0000338#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000339 return PyBool_FromLong(0);
Tim Peters69232342001-08-30 05:16:13 +0000340#endif
341}
342
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000343static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000344imp_acquire_lock(PyObject *self, PyObject *noargs)
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000345{
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000346#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000347 _PyImport_AcquireLock();
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000348#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000349 Py_INCREF(Py_None);
350 return Py_None;
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000351}
352
353static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000354imp_release_lock(PyObject *self, PyObject *noargs)
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000355{
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000356#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000357 if (_PyImport_ReleaseLock() < 0) {
358 PyErr_SetString(PyExc_RuntimeError,
359 "not holding the import lock");
360 return NULL;
361 }
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000362#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000363 Py_INCREF(Py_None);
364 return Py_None;
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000365}
366
Antoine Pitrou8db076c2011-10-30 19:13:55 +0100367void
368_PyImport_Fini(void)
369{
370 Py_XDECREF(extensions);
371 extensions = NULL;
372 PyMem_DEL(_PyImport_Filetab);
373 _PyImport_Filetab = NULL;
374#ifdef WITH_THREAD
375 if (import_lock != NULL) {
376 PyThread_free_lock(import_lock);
377 import_lock = NULL;
378 }
379#endif
380}
381
Guido van Rossumd8faa362007-04-27 19:54:29 +0000382static void
383imp_modules_reloading_clear(void)
384{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000385 PyInterpreterState *interp = PyThreadState_Get()->interp;
386 if (interp->modules_reloading != NULL)
387 PyDict_Clear(interp->modules_reloading);
Guido van Rossumd8faa362007-04-27 19:54:29 +0000388}
389
Guido van Rossum25ce5661997-08-02 03:10:38 +0000390/* Helper for sys */
391
392PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000393PyImport_GetModuleDict(void)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000394{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000395 PyInterpreterState *interp = PyThreadState_GET()->interp;
396 if (interp->modules == NULL)
397 Py_FatalError("PyImport_GetModuleDict: no module dictionary!");
398 return interp->modules;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000399}
400
Guido van Rossum3f5da241990-12-20 15:06:42 +0000401
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000402/* List of names to clear in sys */
403static char* sys_deletes[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000404 "path", "argv", "ps1", "ps2",
405 "last_type", "last_value", "last_traceback",
406 "path_hooks", "path_importer_cache", "meta_path",
407 /* misc stuff */
408 "flags", "float_info",
409 NULL
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000410};
411
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000412static char* sys_files[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000413 "stdin", "__stdin__",
414 "stdout", "__stdout__",
415 "stderr", "__stderr__",
416 NULL
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000417};
418
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000419
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000420/* Un-initialize things, as good as we can */
Guido van Rossum3f5da241990-12-20 15:06:42 +0000421
Guido van Rossum3f5da241990-12-20 15:06:42 +0000422void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000423PyImport_Cleanup(void)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000424{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000425 Py_ssize_t pos, ndone;
426 char *name;
427 PyObject *key, *value, *dict;
428 PyInterpreterState *interp = PyThreadState_GET()->interp;
429 PyObject *modules = interp->modules;
Guido van Rossum758eec01998-01-19 21:58:26 +0000430
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000431 if (modules == NULL)
432 return; /* Already done */
Guido van Rossum758eec01998-01-19 21:58:26 +0000433
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000434 /* Delete some special variables first. These are common
435 places where user values hide and people complain when their
436 destructors fail. Since the modules containing them are
437 deleted *last* of all, they would come too late in the normal
438 destruction order. Sigh. */
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000439
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000440 value = PyDict_GetItemString(modules, "builtins");
441 if (value != NULL && PyModule_Check(value)) {
442 dict = PyModule_GetDict(value);
443 if (Py_VerboseFlag)
444 PySys_WriteStderr("# clear builtins._\n");
445 PyDict_SetItemString(dict, "_", Py_None);
446 }
447 value = PyDict_GetItemString(modules, "sys");
448 if (value != NULL && PyModule_Check(value)) {
449 char **p;
450 PyObject *v;
451 dict = PyModule_GetDict(value);
452 for (p = sys_deletes; *p != NULL; p++) {
453 if (Py_VerboseFlag)
454 PySys_WriteStderr("# clear sys.%s\n", *p);
455 PyDict_SetItemString(dict, *p, Py_None);
456 }
457 for (p = sys_files; *p != NULL; p+=2) {
458 if (Py_VerboseFlag)
459 PySys_WriteStderr("# restore sys.%s\n", *p);
460 v = PyDict_GetItemString(dict, *(p+1));
461 if (v == NULL)
462 v = Py_None;
463 PyDict_SetItemString(dict, *p, v);
464 }
465 }
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000466
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000467 /* First, delete __main__ */
468 value = PyDict_GetItemString(modules, "__main__");
469 if (value != NULL && PyModule_Check(value)) {
470 if (Py_VerboseFlag)
471 PySys_WriteStderr("# cleanup __main__\n");
472 _PyModule_Clear(value);
473 PyDict_SetItemString(modules, "__main__", Py_None);
474 }
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000475
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000476 /* The special treatment of "builtins" here is because even
477 when it's not referenced as a module, its dictionary is
478 referenced by almost every module's __builtins__. Since
479 deleting a module clears its dictionary (even if there are
480 references left to it), we need to delete the "builtins"
481 module last. Likewise, we don't delete sys until the very
482 end because it is implicitly referenced (e.g. by print).
Guido van Rossum758eec01998-01-19 21:58:26 +0000483
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000484 Also note that we 'delete' modules by replacing their entry
485 in the modules dict with None, rather than really deleting
486 them; this avoids a rehash of the modules dictionary and
487 also marks them as "non existent" so they won't be
488 re-imported. */
Guido van Rossum758eec01998-01-19 21:58:26 +0000489
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000490 /* Next, repeatedly delete modules with a reference count of
491 one (skipping builtins and sys) and delete them */
492 do {
493 ndone = 0;
494 pos = 0;
495 while (PyDict_Next(modules, &pos, &key, &value)) {
496 if (value->ob_refcnt != 1)
497 continue;
498 if (PyUnicode_Check(key) && PyModule_Check(value)) {
499 name = _PyUnicode_AsString(key);
500 if (strcmp(name, "builtins") == 0)
501 continue;
502 if (strcmp(name, "sys") == 0)
503 continue;
504 if (Py_VerboseFlag)
505 PySys_WriteStderr(
506 "# cleanup[1] %s\n", name);
507 _PyModule_Clear(value);
508 PyDict_SetItem(modules, key, Py_None);
509 ndone++;
510 }
511 }
512 } while (ndone > 0);
Guido van Rossum758eec01998-01-19 21:58:26 +0000513
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000514 /* Next, delete all modules (still skipping builtins and sys) */
515 pos = 0;
516 while (PyDict_Next(modules, &pos, &key, &value)) {
517 if (PyUnicode_Check(key) && PyModule_Check(value)) {
518 name = _PyUnicode_AsString(key);
519 if (strcmp(name, "builtins") == 0)
520 continue;
521 if (strcmp(name, "sys") == 0)
522 continue;
523 if (Py_VerboseFlag)
524 PySys_WriteStderr("# cleanup[2] %s\n", name);
525 _PyModule_Clear(value);
526 PyDict_SetItem(modules, key, Py_None);
527 }
528 }
Guido van Rossum758eec01998-01-19 21:58:26 +0000529
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000530 /* Next, delete sys and builtins (in that order) */
531 value = PyDict_GetItemString(modules, "sys");
532 if (value != NULL && PyModule_Check(value)) {
533 if (Py_VerboseFlag)
534 PySys_WriteStderr("# cleanup sys\n");
535 _PyModule_Clear(value);
536 PyDict_SetItemString(modules, "sys", Py_None);
537 }
538 value = PyDict_GetItemString(modules, "builtins");
539 if (value != NULL && PyModule_Check(value)) {
540 if (Py_VerboseFlag)
541 PySys_WriteStderr("# cleanup builtins\n");
542 _PyModule_Clear(value);
543 PyDict_SetItemString(modules, "builtins", Py_None);
544 }
Guido van Rossum758eec01998-01-19 21:58:26 +0000545
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000546 /* Finally, clear and delete the modules directory */
547 PyDict_Clear(modules);
548 interp->modules = NULL;
549 Py_DECREF(modules);
550 Py_CLEAR(interp->modules_reloading);
Guido van Rossum8d15b5d1990-10-26 14:58:58 +0000551}
Guido van Rossum7f133ed1991-02-19 12:23:57 +0000552
553
Barry Warsaw28a691b2010-04-17 00:19:56 +0000554/* Helper for pythonrun.c -- return magic number and tag. */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000555
556long
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000557PyImport_GetMagicNumber(void)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000558{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000559 return pyc_magic;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000560}
561
562
Barry Warsaw28a691b2010-04-17 00:19:56 +0000563const char *
564PyImport_GetMagicTag(void)
565{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000566 return pyc_tag;
Barry Warsaw28a691b2010-04-17 00:19:56 +0000567}
568
Guido van Rossum25ce5661997-08-02 03:10:38 +0000569/* Magic for extension modules (built-in as well as dynamically
570 loaded). To prevent initializing an extension module more than
571 once, we keep a static dictionary 'extensions' keyed by module name
572 (for built-in modules) or by filename (for dynamically loaded
Barry Warsaw92883382001-08-13 23:05:44 +0000573 modules), containing these modules. A copy of the module's
Victor Stinner49d3f252010-10-17 01:24:53 +0000574 dictionary is stored by calling _PyImport_FixupExtensionUnicode()
Guido van Rossum25ce5661997-08-02 03:10:38 +0000575 immediately after the module initialization function succeeds. A
576 copy can be retrieved from there by calling
Victor Stinner49d3f252010-10-17 01:24:53 +0000577 _PyImport_FindExtensionUnicode().
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000578
Barry Warsaw7c9627b2010-06-17 18:38:20 +0000579 Modules which do support multiple initialization set their m_size
580 field to a non-negative number (indicating the size of the
581 module-specific state). They are still recorded in the extensions
582 dictionary, to avoid loading shared libraries twice.
Martin v. Löwis1a214512008-06-11 05:26:20 +0000583*/
584
585int
Victor Stinner49d3f252010-10-17 01:24:53 +0000586_PyImport_FixupExtensionUnicode(PyObject *mod, char *name, PyObject *filename)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000587{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000588 PyObject *modules, *dict;
589 struct PyModuleDef *def;
590 if (extensions == NULL) {
591 extensions = PyDict_New();
592 if (extensions == NULL)
593 return -1;
594 }
595 if (mod == NULL || !PyModule_Check(mod)) {
596 PyErr_BadInternalCall();
597 return -1;
598 }
599 def = PyModule_GetDef(mod);
600 if (!def) {
601 PyErr_BadInternalCall();
602 return -1;
603 }
604 modules = PyImport_GetModuleDict();
605 if (PyDict_SetItemString(modules, name, mod) < 0)
606 return -1;
607 if (_PyState_AddModule(mod, def) < 0) {
608 PyDict_DelItemString(modules, name);
609 return -1;
610 }
611 if (def->m_size == -1) {
612 if (def->m_base.m_copy) {
613 /* Somebody already imported the module,
614 likely under a different name.
615 XXX this should really not happen. */
616 Py_DECREF(def->m_base.m_copy);
617 def->m_base.m_copy = NULL;
618 }
619 dict = PyModule_GetDict(mod);
620 if (dict == NULL)
621 return -1;
622 def->m_base.m_copy = PyDict_Copy(dict);
623 if (def->m_base.m_copy == NULL)
624 return -1;
625 }
Victor Stinner49d3f252010-10-17 01:24:53 +0000626 PyDict_SetItem(extensions, filename, (PyObject*)def);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000627 return 0;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000628}
629
Victor Stinner49d3f252010-10-17 01:24:53 +0000630int
631_PyImport_FixupBuiltin(PyObject *mod, char *name)
632{
633 int res;
634 PyObject *filename;
635 filename = PyUnicode_FromString(name);
636 if (filename == NULL)
637 return -1;
638 res = _PyImport_FixupExtensionUnicode(mod, name, filename);
639 Py_DECREF(filename);
640 return res;
641}
642
Guido van Rossum25ce5661997-08-02 03:10:38 +0000643PyObject *
Victor Stinner49d3f252010-10-17 01:24:53 +0000644_PyImport_FindExtensionUnicode(char *name, PyObject *filename)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000645{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000646 PyObject *mod, *mdict;
647 PyModuleDef* def;
648 if (extensions == NULL)
649 return NULL;
Victor Stinner49d3f252010-10-17 01:24:53 +0000650 def = (PyModuleDef*)PyDict_GetItem(extensions, filename);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000651 if (def == NULL)
652 return NULL;
653 if (def->m_size == -1) {
654 /* Module does not support repeated initialization */
655 if (def->m_base.m_copy == NULL)
656 return NULL;
657 mod = PyImport_AddModule(name);
658 if (mod == NULL)
659 return NULL;
660 mdict = PyModule_GetDict(mod);
661 if (mdict == NULL)
662 return NULL;
663 if (PyDict_Update(mdict, def->m_base.m_copy))
664 return NULL;
665 }
666 else {
667 if (def->m_base.m_init == NULL)
668 return NULL;
669 mod = def->m_base.m_init();
670 if (mod == NULL)
671 return NULL;
672 PyDict_SetItemString(PyImport_GetModuleDict(), name, mod);
673 Py_DECREF(mod);
674 }
675 if (_PyState_AddModule(mod, def) < 0) {
676 PyDict_DelItemString(PyImport_GetModuleDict(), name);
677 Py_DECREF(mod);
678 return NULL;
679 }
680 if (Py_VerboseFlag)
Victor Stinner49d3f252010-10-17 01:24:53 +0000681 PySys_FormatStderr("import %s # previously loaded (%U)\n",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000682 name, filename);
683 return mod;
Brett Cannon9a5b25a2010-03-01 02:09:17 +0000684
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000685}
686
Victor Stinner49d3f252010-10-17 01:24:53 +0000687PyObject *
688_PyImport_FindBuiltin(char *name)
689{
690 PyObject *res, *filename;
691 filename = PyUnicode_FromString(name);
692 if (filename == NULL)
693 return NULL;
694 res = _PyImport_FindExtensionUnicode(name, filename);
695 Py_DECREF(filename);
696 return res;
697}
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000698
699/* Get the module object corresponding to a module name.
700 First check the modules dictionary if there's one there,
Walter Dörwaldf0dfc7a2003-10-20 14:01:56 +0000701 if not, create a new one and insert it in the modules dictionary.
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000702 Because the former action is most common, THIS DOES NOT RETURN A
703 'NEW' REFERENCE! */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000704
Guido van Rossum79f25d91997-04-29 20:08:16 +0000705PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000706PyImport_AddModule(const char *name)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000707{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000708 PyObject *modules = PyImport_GetModuleDict();
709 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000710
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000711 if ((m = PyDict_GetItemString(modules, name)) != NULL &&
712 PyModule_Check(m))
713 return m;
714 m = PyModule_New(name);
715 if (m == NULL)
716 return NULL;
717 if (PyDict_SetItemString(modules, name, m) != 0) {
718 Py_DECREF(m);
719 return NULL;
720 }
721 Py_DECREF(m); /* Yes, it still exists, in modules! */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000722
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000723 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000724}
725
Tim Peters1cd70172004-08-02 03:52:12 +0000726/* Remove name from sys.modules, if it's there. */
727static void
Benjamin Petersonfa0aeba2010-03-25 23:30:20 +0000728remove_module(const char *name)
Tim Peters1cd70172004-08-02 03:52:12 +0000729{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000730 PyObject *modules = PyImport_GetModuleDict();
731 if (PyDict_GetItemString(modules, name) == NULL)
732 return;
733 if (PyDict_DelItemString(modules, name) < 0)
734 Py_FatalError("import: deleting existing key in"
735 "sys.modules failed");
Tim Peters1cd70172004-08-02 03:52:12 +0000736}
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000737
Barry Warsaw28a691b2010-04-17 00:19:56 +0000738static PyObject * get_sourcefile(char *file);
739static char *make_source_pathname(char *pathname, char *buf);
740static char *make_compiled_pathname(char *pathname, char *buf, size_t buflen,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000741 int debug);
Christian Heimes3b06e532008-01-07 20:12:44 +0000742
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000743/* Execute a code object in a module and return the module object
Tim Peters1cd70172004-08-02 03:52:12 +0000744 * WITH INCREMENTED REFERENCE COUNT. If an error occurs, name is
745 * removed from sys.modules, to avoid leaving damaged module objects
746 * in sys.modules. The caller may wish to restore the original
747 * module object (if any) in this case; PyImport_ReloadModule is an
748 * example.
Barry Warsaw28a691b2010-04-17 00:19:56 +0000749 *
750 * Note that PyImport_ExecCodeModuleWithPathnames() is the preferred, richer
751 * interface. The other two exist primarily for backward compatibility.
Tim Peters1cd70172004-08-02 03:52:12 +0000752 */
Guido van Rossum79f25d91997-04-29 20:08:16 +0000753PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000754PyImport_ExecCodeModule(char *name, PyObject *co)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000755{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000756 return PyImport_ExecCodeModuleWithPathnames(
757 name, co, (char *)NULL, (char *)NULL);
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000758}
759
760PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000761PyImport_ExecCodeModuleEx(char *name, PyObject *co, char *pathname)
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000762{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000763 return PyImport_ExecCodeModuleWithPathnames(
764 name, co, pathname, (char *)NULL);
Barry Warsaw28a691b2010-04-17 00:19:56 +0000765}
766
767PyObject *
768PyImport_ExecCodeModuleWithPathnames(char *name, PyObject *co, char *pathname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000769 char *cpathname)
Barry Warsaw28a691b2010-04-17 00:19:56 +0000770{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000771 PyObject *modules = PyImport_GetModuleDict();
772 PyObject *m, *d, *v;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000773
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000774 m = PyImport_AddModule(name);
775 if (m == NULL)
776 return NULL;
777 /* If the module is being reloaded, we get the old module back
778 and re-use its dict to exec the new code. */
779 d = PyModule_GetDict(m);
780 if (PyDict_GetItemString(d, "__builtins__") == NULL) {
781 if (PyDict_SetItemString(d, "__builtins__",
782 PyEval_GetBuiltins()) != 0)
783 goto error;
784 }
785 /* Remember the filename as the __file__ attribute */
786 v = NULL;
787 if (pathname != NULL) {
788 v = get_sourcefile(pathname);
789 if (v == NULL)
790 PyErr_Clear();
791 }
792 if (v == NULL) {
793 v = ((PyCodeObject *)co)->co_filename;
794 Py_INCREF(v);
795 }
796 if (PyDict_SetItemString(d, "__file__", v) != 0)
797 PyErr_Clear(); /* Not important enough to report */
798 Py_DECREF(v);
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000799
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000800 /* Remember the pyc path name as the __cached__ attribute. */
801 if (cpathname == NULL) {
802 v = Py_None;
803 Py_INCREF(v);
804 }
805 else if ((v = PyUnicode_FromString(cpathname)) == NULL) {
806 PyErr_Clear(); /* Not important enough to report */
807 v = Py_None;
808 Py_INCREF(v);
809 }
810 if (PyDict_SetItemString(d, "__cached__", v) != 0)
811 PyErr_Clear(); /* Not important enough to report */
812 Py_DECREF(v);
Barry Warsaw28a691b2010-04-17 00:19:56 +0000813
Martin v. Löwis4d0d4712010-12-03 20:14:31 +0000814 v = PyEval_EvalCode(co, d, d);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000815 if (v == NULL)
816 goto error;
817 Py_DECREF(v);
Guido van Rossumb65e85c1997-07-10 18:00:45 +0000818
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000819 if ((m = PyDict_GetItemString(modules, name)) == NULL) {
820 PyErr_Format(PyExc_ImportError,
821 "Loaded module %.200s not found in sys.modules",
822 name);
823 return NULL;
824 }
Guido van Rossumb65e85c1997-07-10 18:00:45 +0000825
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000826 Py_INCREF(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000827
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000828 return m;
Tim Peters1cd70172004-08-02 03:52:12 +0000829
830 error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000831 remove_module(name);
832 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000833}
834
835
Barry Warsaw28a691b2010-04-17 00:19:56 +0000836/* Like strrchr(string, '/') but searches for the rightmost of either SEP
837 or ALTSEP, if the latter is defined.
838*/
839static char *
840rightmost_sep(char *s)
841{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000842 char *found, c;
843 for (found = NULL; (c = *s); s++) {
844 if (c == SEP
Barry Warsaw28a691b2010-04-17 00:19:56 +0000845#ifdef ALTSEP
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000846 || c == ALTSEP
Barry Warsaw28a691b2010-04-17 00:19:56 +0000847#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000848 )
849 {
850 found = s;
851 }
852 }
853 return found;
Barry Warsaw28a691b2010-04-17 00:19:56 +0000854}
855
856
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000857/* Given a pathname for a Python source file, fill a buffer with the
858 pathname for the corresponding compiled file. Return the pathname
859 for the compiled file, or NULL if there's no space in the buffer.
860 Doesn't set an exception. */
861
862static char *
Barry Warsaw28a691b2010-04-17 00:19:56 +0000863make_compiled_pathname(char *pathname, char *buf, size_t buflen, int debug)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000864{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000865 /* foo.py -> __pycache__/foo.<tag>.pyc */
866 size_t len = strlen(pathname);
867 size_t i, save;
868 char *pos;
869 int sep = SEP;
Barry Warsaw28a691b2010-04-17 00:19:56 +0000870
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000871 /* Sanity check that the buffer has roughly enough space to hold what
872 will eventually be the full path to the compiled file. The 5 extra
873 bytes include the slash afer __pycache__, the two extra dots, the
874 extra trailing character ('c' or 'o') and null. This isn't exact
875 because the contents of the buffer can affect how many actual
876 characters of the string get into the buffer. We'll do a final
877 sanity check before writing the extension to ensure we do not
878 overflow the buffer.
879 */
880 if (len + strlen(CACHEDIR) + strlen(pyc_tag) + 5 > buflen)
881 return NULL;
Tim Petersc1731372001-08-04 08:12:36 +0000882
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000883 /* Find the last path separator and copy everything from the start of
884 the source string up to and including the separator.
885 */
886 if ((pos = rightmost_sep(pathname)) == NULL) {
887 i = 0;
888 }
889 else {
890 sep = *pos;
891 i = pos - pathname + 1;
892 strncpy(buf, pathname, i);
893 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000894
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000895 save = i;
896 buf[i++] = '\0';
897 /* Add __pycache__/ */
898 strcat(buf, CACHEDIR);
899 i += strlen(CACHEDIR) - 1;
900 buf[i++] = sep;
901 buf[i++] = '\0';
902 /* Add the base filename, but remove the .py or .pyw extension, since
903 the tag name must go before the extension.
904 */
905 strcat(buf, pathname + save);
906 if ((pos = strrchr(buf, '.')) != NULL)
907 *++pos = '\0';
908 strcat(buf, pyc_tag);
909 /* The length test above assumes that we're only adding one character
910 to the end of what would normally be the extension. What if there
911 is no extension, or the string ends in '.' or '.p', and otherwise
912 fills the buffer? By appending 4 more characters onto the string
913 here, we could overrun the buffer.
Barry Warsaw28a691b2010-04-17 00:19:56 +0000914
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000915 As a simple example, let's say buflen=32 and the input string is
916 'xxx.py'. strlen() would be 6 and the test above would yield:
Barry Warsaw28a691b2010-04-17 00:19:56 +0000917
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000918 (6 + 11 + 10 + 5 == 32) > 32
Barry Warsaw28a691b2010-04-17 00:19:56 +0000919
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000920 which is false and so the name mangling would continue. This would
921 be fine because we'd end up with this string in buf:
Barry Warsaw28a691b2010-04-17 00:19:56 +0000922
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000923 __pycache__/xxx.cpython-32.pyc\0
Barry Warsaw28a691b2010-04-17 00:19:56 +0000924
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000925 strlen(of that) == 30 + the nul fits inside a 32 character buffer.
926 We can even handle an input string of say 'xxxxx' above because
927 that's (5 + 11 + 10 + 5 == 31) > 32 which is also false. Name
928 mangling that yields:
Barry Warsaw28a691b2010-04-17 00:19:56 +0000929
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000930 __pycache__/xxxxxcpython-32.pyc\0
Barry Warsaw28a691b2010-04-17 00:19:56 +0000931
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000932 which is 32 characters including the nul, and thus fits in the
933 buffer. However, an input string of 'xxxxxx' would yield a result
934 string of:
Barry Warsaw28a691b2010-04-17 00:19:56 +0000935
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000936 __pycache__/xxxxxxcpython-32.pyc\0
Barry Warsaw28a691b2010-04-17 00:19:56 +0000937
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000938 which is 33 characters long (including the nul), thus overflowing
939 the buffer, even though the first test would fail, i.e.: the input
940 string is also 6 characters long, so 32 > 32 is false.
Barry Warsaw28a691b2010-04-17 00:19:56 +0000941
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000942 The reason the first test fails but we still overflow the buffer is
943 that the test above only expects to add one extra character to be
944 added to the extension, and here we're adding three (pyc). We
945 don't add the first dot, so that reclaims one of expected
946 positions, leaving us overflowing by 1 byte (3 extra - 1 reclaimed
947 dot - 1 expected extra == 1 overflowed).
Barry Warsaw28a691b2010-04-17 00:19:56 +0000948
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000949 The best we can do is ensure that we still have enough room in the
950 target buffer before we write the extension. Because it's always
951 only the extension that can cause the overflow, and never the other
952 path bytes we've written, it's sufficient to just do one more test
953 here. Still, the assertion that follows can't hurt.
954 */
Barry Warsaw28a691b2010-04-17 00:19:56 +0000955#if 0
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000956 printf("strlen(buf): %d; buflen: %d\n", (int)strlen(buf), (int)buflen);
Barry Warsaw28a691b2010-04-17 00:19:56 +0000957#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000958 if (strlen(buf) + 5 > buflen)
959 return NULL;
960 strcat(buf, debug ? ".pyc" : ".pyo");
961 assert(strlen(buf) < buflen);
962 return buf;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000963}
964
965
Barry Warsaw28a691b2010-04-17 00:19:56 +0000966/* Given a pathname to a Python byte compiled file, return the path to the
967 source file, if the path matches the PEP 3147 format. This does not check
968 for any file existence, however, if the pyc file name does not match PEP
969 3147 style, NULL is returned. buf must be at least as big as pathname;
970 the resulting path will always be shorter. */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000971
Barry Warsaw28a691b2010-04-17 00:19:56 +0000972static char *
973make_source_pathname(char *pathname, char *buf)
974{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000975 /* __pycache__/foo.<tag>.pyc -> foo.py */
976 size_t i, j;
977 char *left, *right, *dot0, *dot1, sep;
Barry Warsaw28a691b2010-04-17 00:19:56 +0000978
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000979 /* Look back two slashes from the end. In between these two slashes
980 must be the string __pycache__ or this is not a PEP 3147 style
981 path. It's possible for there to be only one slash.
982 */
983 if ((right = rightmost_sep(pathname)) == NULL)
984 return NULL;
985 sep = *right;
986 *right = '\0';
987 left = rightmost_sep(pathname);
988 *right = sep;
989 if (left == NULL)
990 left = pathname;
991 else
992 left++;
993 if (right-left != strlen(CACHEDIR) ||
994 strncmp(left, CACHEDIR, right-left) != 0)
995 return NULL;
Barry Warsaw28a691b2010-04-17 00:19:56 +0000996
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000997 /* Now verify that the path component to the right of the last slash
998 has two dots in it.
999 */
1000 if ((dot0 = strchr(right + 1, '.')) == NULL)
1001 return NULL;
1002 if ((dot1 = strchr(dot0 + 1, '.')) == NULL)
1003 return NULL;
1004 /* Too many dots? */
1005 if (strchr(dot1 + 1, '.') != NULL)
1006 return NULL;
Barry Warsaw28a691b2010-04-17 00:19:56 +00001007
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001008 /* This is a PEP 3147 path. Start by copying everything from the
1009 start of pathname up to and including the leftmost slash. Then
1010 copy the file's basename, removing the magic tag and adding a .py
1011 suffix.
1012 */
1013 strncpy(buf, pathname, (i=left-pathname));
1014 strncpy(buf+i, right+1, (j=dot0-right));
1015 strcpy(buf+i+j, "py");
1016 return buf;
Barry Warsaw28a691b2010-04-17 00:19:56 +00001017}
1018
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001019/* Given a pathname for a Python source file, its time of last
1020 modification, and a pathname for a compiled file, check whether the
1021 compiled file represents the same version of the source. If so,
1022 return a FILE pointer for the compiled file, positioned just after
1023 the header; if not, return NULL.
1024 Doesn't set an exception. */
1025
1026static FILE *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001027check_compiled_module(char *pathname, time_t mtime, char *cpathname)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001028{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001029 FILE *fp;
1030 long magic;
1031 long pyc_mtime;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001032
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001033 fp = fopen(cpathname, "rb");
1034 if (fp == NULL)
1035 return NULL;
1036 magic = PyMarshal_ReadLongFromFile(fp);
1037 if (magic != pyc_magic) {
1038 if (Py_VerboseFlag)
1039 PySys_WriteStderr("# %s has bad magic\n", cpathname);
1040 fclose(fp);
1041 return NULL;
1042 }
1043 pyc_mtime = PyMarshal_ReadLongFromFile(fp);
1044 if (pyc_mtime != mtime) {
1045 if (Py_VerboseFlag)
1046 PySys_WriteStderr("# %s has bad mtime\n", cpathname);
1047 fclose(fp);
1048 return NULL;
1049 }
1050 if (Py_VerboseFlag)
1051 PySys_WriteStderr("# %s matches %s\n", cpathname, pathname);
1052 return fp;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001053}
1054
1055
1056/* Read a code object from a file and check it for validity */
1057
Guido van Rossum79f25d91997-04-29 20:08:16 +00001058static PyCodeObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001059read_compiled_module(char *cpathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001060{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001061 PyObject *co;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001062
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001063 co = PyMarshal_ReadLastObjectFromFile(fp);
1064 if (co == NULL)
1065 return NULL;
1066 if (!PyCode_Check(co)) {
1067 PyErr_Format(PyExc_ImportError,
1068 "Non-code object in %.200s", cpathname);
1069 Py_DECREF(co);
1070 return NULL;
1071 }
1072 return (PyCodeObject *)co;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001073}
1074
1075
1076/* Load a module from a compiled file, execute it, and return its
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001077 module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001078
Guido van Rossum79f25d91997-04-29 20:08:16 +00001079static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001080load_compiled_module(char *name, char *cpathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001081{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001082 long magic;
1083 PyCodeObject *co;
1084 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001085
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001086 magic = PyMarshal_ReadLongFromFile(fp);
1087 if (magic != pyc_magic) {
1088 PyErr_Format(PyExc_ImportError,
1089 "Bad magic number in %.200s", cpathname);
1090 return NULL;
1091 }
1092 (void) PyMarshal_ReadLongFromFile(fp);
1093 co = read_compiled_module(cpathname, fp);
1094 if (co == NULL)
1095 return NULL;
1096 if (Py_VerboseFlag)
1097 PySys_WriteStderr("import %s # precompiled from %s\n",
1098 name, cpathname);
1099 m = PyImport_ExecCodeModuleWithPathnames(
1100 name, (PyObject *)co, cpathname, cpathname);
1101 Py_DECREF(co);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001102
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001103 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001104}
1105
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001106/* Parse a source file and return the corresponding code object */
1107
Guido van Rossum79f25d91997-04-29 20:08:16 +00001108static PyCodeObject *
Jeremy Hylton3e0055f2005-10-20 19:59:25 +00001109parse_source_module(const char *pathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001110{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001111 PyCodeObject *co = NULL;
1112 mod_ty mod;
1113 PyCompilerFlags flags;
1114 PyArena *arena = PyArena_New();
1115 if (arena == NULL)
1116 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001117
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001118 flags.cf_flags = 0;
1119 mod = PyParser_ASTFromFile(fp, pathname, NULL,
1120 Py_file_input, 0, 0, &flags,
1121 NULL, arena);
1122 if (mod) {
1123 co = PyAST_Compile(mod, pathname, NULL, arena);
1124 }
1125 PyArena_Free(arena);
1126 return co;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001127}
1128
1129
Guido van Rossum55a83382000-09-20 20:31:38 +00001130/* Helper to open a bytecode file for writing in exclusive mode */
1131
1132static FILE *
Christian Heimes05e8be12008-02-23 18:30:17 +00001133open_exclusive(char *filename, mode_t mode)
Guido van Rossum55a83382000-09-20 20:31:38 +00001134{
1135#if defined(O_EXCL)&&defined(O_CREAT)&&defined(O_WRONLY)&&defined(O_TRUNC)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001136 /* Use O_EXCL to avoid a race condition when another process tries to
1137 write the same file. When that happens, our open() call fails,
1138 which is just fine (since it's only a cache).
1139 XXX If the file exists and is writable but the directory is not
1140 writable, the file will never be written. Oh well.
1141 */
1142 int fd;
1143 (void) unlink(filename);
1144 fd = open(filename, O_EXCL|O_CREAT|O_WRONLY|O_TRUNC
Tim Peters42c83af2000-09-29 04:03:10 +00001145#ifdef O_BINARY
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001146 |O_BINARY /* necessary for Windows */
Tim Peters42c83af2000-09-29 04:03:10 +00001147#endif
Martin v. Löwis79acb9e2002-12-06 12:48:53 +00001148#ifdef __VMS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001149 , mode, "ctxt=bin", "shr=nil"
Martin v. Löwis79acb9e2002-12-06 12:48:53 +00001150#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001151 , mode
Martin v. Löwis79acb9e2002-12-06 12:48:53 +00001152#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001153 );
1154 if (fd < 0)
1155 return NULL;
1156 return fdopen(fd, "wb");
Guido van Rossum55a83382000-09-20 20:31:38 +00001157#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001158 /* Best we can do -- on Windows this can't happen anyway */
1159 return fopen(filename, "wb");
Guido van Rossum55a83382000-09-20 20:31:38 +00001160#endif
1161}
1162
1163
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001164/* Write a compiled module to a file, placing the time of last
1165 modification of its source into the header.
1166 Errors are ignored, if a write error occurs an attempt is made to
1167 remove the file. */
1168
1169static void
Christian Heimes05e8be12008-02-23 18:30:17 +00001170write_compiled_module(PyCodeObject *co, char *cpathname, struct stat *srcstat)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001171{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001172 FILE *fp;
1173 char *dirpath;
1174 time_t mtime = srcstat->st_mtime;
Alexandre Vassalotti9d58e3e2009-07-17 10:55:50 +00001175#ifdef MS_WINDOWS /* since Windows uses different permissions */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001176 mode_t mode = srcstat->st_mode & ~S_IEXEC;
Alexandre Vassalotti9d58e3e2009-07-17 10:55:50 +00001177#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001178 mode_t mode = srcstat->st_mode & ~S_IXUSR & ~S_IXGRP & ~S_IXOTH;
1179 mode_t dirmode = (srcstat->st_mode |
1180 S_IXUSR | S_IXGRP | S_IXOTH |
1181 S_IWUSR | S_IWGRP | S_IWOTH);
Brett Cannon9a5b25a2010-03-01 02:09:17 +00001182#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001183 int saved;
Barry Warsaw28a691b2010-04-17 00:19:56 +00001184
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001185 /* Ensure that the __pycache__ directory exists. */
1186 dirpath = rightmost_sep(cpathname);
1187 if (dirpath == NULL) {
1188 if (Py_VerboseFlag)
1189 PySys_WriteStderr(
1190 "# no %s path found %s\n",
1191 CACHEDIR, cpathname);
1192 return;
1193 }
1194 saved = *dirpath;
1195 *dirpath = '\0';
Daniel Stutzbachc7937792010-09-09 21:18:04 +00001196
1197#ifdef MS_WINDOWS
1198 if (_mkdir(cpathname) < 0 && errno != EEXIST) {
1199#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001200 if (mkdir(cpathname, dirmode) < 0 && errno != EEXIST) {
Daniel Stutzbachc7937792010-09-09 21:18:04 +00001201#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001202 *dirpath = saved;
1203 if (Py_VerboseFlag)
1204 PySys_WriteStderr(
1205 "# cannot create cache dir %s\n", cpathname);
1206 return;
1207 }
1208 *dirpath = saved;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001209
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001210 fp = open_exclusive(cpathname, mode);
1211 if (fp == NULL) {
1212 if (Py_VerboseFlag)
1213 PySys_WriteStderr(
1214 "# can't create %s\n", cpathname);
1215 return;
1216 }
1217 PyMarshal_WriteLongToFile(pyc_magic, fp, Py_MARSHAL_VERSION);
1218 /* First write a 0 for mtime */
1219 PyMarshal_WriteLongToFile(0L, fp, Py_MARSHAL_VERSION);
1220 PyMarshal_WriteObjectToFile((PyObject *)co, fp, Py_MARSHAL_VERSION);
1221 if (fflush(fp) != 0 || ferror(fp)) {
1222 if (Py_VerboseFlag)
1223 PySys_WriteStderr("# can't write %s\n", cpathname);
1224 /* Don't keep partial file */
1225 fclose(fp);
1226 (void) unlink(cpathname);
1227 return;
1228 }
Antoine Pitrou33d15f72012-01-25 18:01:45 +01001229 /* Now write the true mtime (as a 32-bit field) */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001230 fseek(fp, 4L, 0);
Antoine Pitrou33d15f72012-01-25 18:01:45 +01001231 assert(mtime <= 0xFFFFFFFF);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001232 PyMarshal_WriteLongToFile((long)mtime, fp, Py_MARSHAL_VERSION);
1233 fflush(fp);
1234 fclose(fp);
1235 if (Py_VerboseFlag)
1236 PySys_WriteStderr("# wrote %s\n", cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001237}
1238
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001239static void
1240update_code_filenames(PyCodeObject *co, PyObject *oldname, PyObject *newname)
1241{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001242 PyObject *constants, *tmp;
1243 Py_ssize_t i, n;
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001244
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001245 if (PyUnicode_Compare(co->co_filename, oldname))
1246 return;
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001247
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001248 tmp = co->co_filename;
1249 co->co_filename = newname;
1250 Py_INCREF(co->co_filename);
1251 Py_DECREF(tmp);
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001252
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001253 constants = co->co_consts;
1254 n = PyTuple_GET_SIZE(constants);
1255 for (i = 0; i < n; i++) {
1256 tmp = PyTuple_GET_ITEM(constants, i);
1257 if (PyCode_Check(tmp))
1258 update_code_filenames((PyCodeObject *)tmp,
1259 oldname, newname);
1260 }
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001261}
1262
1263static int
1264update_compiled_module(PyCodeObject *co, char *pathname)
1265{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001266 PyObject *oldname, *newname;
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001267
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001268 newname = PyUnicode_DecodeFSDefault(pathname);
1269 if (newname == NULL)
1270 return -1;
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001271
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001272 if (!PyUnicode_Compare(co->co_filename, newname)) {
1273 Py_DECREF(newname);
1274 return 0;
1275 }
Hirokazu Yamamoto4f447fb2009-03-04 01:52:10 +00001276
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001277 oldname = co->co_filename;
1278 Py_INCREF(oldname);
1279 update_code_filenames(co, oldname, newname);
1280 Py_DECREF(oldname);
1281 Py_DECREF(newname);
1282 return 1;
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001283}
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001284
1285/* Load a source module from a given file and return its module
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001286 object WITH INCREMENTED REFERENCE COUNT. If there's a matching
1287 byte-compiled file, use that instead. */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001288
Guido van Rossum79f25d91997-04-29 20:08:16 +00001289static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001290load_source_module(char *name, char *pathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001291{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001292 struct stat st;
1293 FILE *fpc;
Gregory P. Smithc809f982012-03-18 16:06:53 -07001294 char *buf;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001295 char *cpathname;
Antoine Pitroud576c712012-05-09 13:24:31 +02001296 PyCodeObject *co = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001297 PyObject *m;
Brett Cannon9a5b25a2010-03-01 02:09:17 +00001298
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001299 if (fstat(fileno(fp), &st) != 0) {
1300 PyErr_Format(PyExc_RuntimeError,
1301 "unable to get file status from '%s'",
1302 pathname);
1303 return NULL;
1304 }
Antoine Pitrou33d15f72012-01-25 18:01:45 +01001305 if (sizeof st.st_mtime > 4) {
1306 /* Python's .pyc timestamp handling presumes that the timestamp fits
1307 in 4 bytes. Since the code only does an equality comparison,
1308 ordering is not important and we can safely ignore the higher bits
1309 (collisions are extremely unlikely).
1310 */
1311 st.st_mtime &= 0xFFFFFFFF;
1312 }
Gregory P. Smithc809f982012-03-18 16:06:53 -07001313 buf = PyMem_MALLOC(MAXPATHLEN+1);
1314 if (buf == NULL) {
1315 return PyErr_NoMemory();
1316 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001317 cpathname = make_compiled_pathname(
1318 pathname, buf, (size_t)MAXPATHLEN + 1, !Py_OptimizeFlag);
1319 if (cpathname != NULL &&
1320 (fpc = check_compiled_module(pathname, st.st_mtime, cpathname))) {
1321 co = read_compiled_module(cpathname, fpc);
1322 fclose(fpc);
1323 if (co == NULL)
Gregory P. Smithc809f982012-03-18 16:06:53 -07001324 goto error_exit;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001325 if (update_compiled_module(co, pathname) < 0)
Gregory P. Smithc809f982012-03-18 16:06:53 -07001326 goto error_exit;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001327 if (Py_VerboseFlag)
1328 PySys_WriteStderr("import %s # precompiled from %s\n",
1329 name, cpathname);
1330 pathname = cpathname;
1331 }
1332 else {
1333 co = parse_source_module(pathname, fp);
1334 if (co == NULL)
Gregory P. Smithc809f982012-03-18 16:06:53 -07001335 goto error_exit;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001336 if (Py_VerboseFlag)
1337 PySys_WriteStderr("import %s # from %s\n",
1338 name, pathname);
1339 if (cpathname) {
1340 PyObject *ro = PySys_GetObject("dont_write_bytecode");
1341 if (ro == NULL || !PyObject_IsTrue(ro))
1342 write_compiled_module(co, cpathname, &st);
1343 }
1344 }
1345 m = PyImport_ExecCodeModuleWithPathnames(
1346 name, (PyObject *)co, pathname, cpathname);
1347 Py_DECREF(co);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001348
Gregory P. Smithc809f982012-03-18 16:06:53 -07001349 PyMem_FREE(buf);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001350 return m;
Gregory P. Smithc809f982012-03-18 16:06:53 -07001351
1352error_exit:
Antoine Pitroud576c712012-05-09 13:24:31 +02001353 Py_XDECREF(co);
Gregory P. Smithc809f982012-03-18 16:06:53 -07001354 PyMem_FREE(buf);
1355 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001356}
1357
Christian Heimes3b06e532008-01-07 20:12:44 +00001358/* Get source file -> unicode or None
1359 * Returns the path to the py file if available, else the given path
1360 */
1361static PyObject *
Barry Warsaw28a691b2010-04-17 00:19:56 +00001362get_sourcefile(char *file)
Christian Heimes3b06e532008-01-07 20:12:44 +00001363{
Gregory P. Smithc809f982012-03-18 16:06:53 -07001364 char *py = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001365 Py_ssize_t len;
1366 PyObject *u;
1367 struct stat statbuf;
Christian Heimes3b06e532008-01-07 20:12:44 +00001368
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001369 if (!file || !*file) {
1370 Py_RETURN_NONE;
1371 }
Christian Heimes3b06e532008-01-07 20:12:44 +00001372
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001373 len = strlen(file);
1374 /* match '*.py?' */
1375 if (len > MAXPATHLEN || PyOS_strnicmp(&file[len-4], ".py", 3) != 0) {
1376 return PyUnicode_DecodeFSDefault(file);
1377 }
Christian Heimes3b06e532008-01-07 20:12:44 +00001378
Gregory P. Smithc809f982012-03-18 16:06:53 -07001379 py = PyMem_MALLOC(MAXPATHLEN+1);
1380 if (py == NULL) {
1381 return PyErr_NoMemory();
1382 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001383 /* Start by trying to turn PEP 3147 path into source path. If that
1384 * fails, just chop off the trailing character, i.e. legacy pyc path
1385 * to py.
1386 */
1387 if (make_source_pathname(file, py) == NULL) {
1388 strncpy(py, file, len-1);
1389 py[len-1] = '\0';
1390 }
Barry Warsaw28a691b2010-04-17 00:19:56 +00001391
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001392 if (stat(py, &statbuf) == 0 &&
1393 S_ISREG(statbuf.st_mode)) {
1394 u = PyUnicode_DecodeFSDefault(py);
1395 }
1396 else {
1397 u = PyUnicode_DecodeFSDefault(file);
1398 }
Gregory P. Smithc809f982012-03-18 16:06:53 -07001399 PyMem_FREE(py);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001400 return u;
Christian Heimes3b06e532008-01-07 20:12:44 +00001401}
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001402
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001403/* Forward */
Just van Rossum52e14d62002-12-30 22:08:05 +00001404static PyObject *load_module(char *, FILE *, char *, int, PyObject *);
1405static struct filedescr *find_module(char *, char *, PyObject *,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001406 char *, size_t, FILE **, PyObject **);
Christian Heimes3b06e532008-01-07 20:12:44 +00001407static struct _frozen * find_frozen(char *);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001408
1409/* Load a package and return its module object WITH INCREMENTED
1410 REFERENCE COUNT */
1411
1412static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001413load_package(char *name, char *pathname)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001414{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001415 PyObject *m, *d;
1416 PyObject *file = NULL;
1417 PyObject *path = NULL;
1418 int err;
Gregory P. Smithc809f982012-03-18 16:06:53 -07001419 char *buf = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001420 FILE *fp = NULL;
1421 struct filedescr *fdp;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001422
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001423 m = PyImport_AddModule(name);
1424 if (m == NULL)
1425 return NULL;
1426 if (Py_VerboseFlag)
1427 PySys_WriteStderr("import %s # directory %s\n",
1428 name, pathname);
1429 d = PyModule_GetDict(m);
1430 file = get_sourcefile(pathname);
1431 if (file == NULL)
1432 goto error;
1433 path = Py_BuildValue("[O]", file);
1434 if (path == NULL)
1435 goto error;
1436 err = PyDict_SetItemString(d, "__file__", file);
1437 if (err == 0)
1438 err = PyDict_SetItemString(d, "__path__", path);
1439 if (err != 0)
1440 goto error;
Gregory P. Smithc809f982012-03-18 16:06:53 -07001441 buf = PyMem_MALLOC(MAXPATHLEN+1);
1442 if (buf == NULL) {
1443 PyErr_NoMemory();
1444 goto error;
1445 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001446 buf[0] = '\0';
Gregory P. Smithc809f982012-03-18 16:06:53 -07001447 fdp = find_module(name, "__init__", path, buf, MAXPATHLEN+1, &fp, NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001448 if (fdp == NULL) {
1449 if (PyErr_ExceptionMatches(PyExc_ImportError)) {
1450 PyErr_Clear();
1451 Py_INCREF(m);
1452 }
1453 else
1454 m = NULL;
1455 goto cleanup;
1456 }
1457 m = load_module(name, fp, buf, fdp->type, NULL);
1458 if (fp != NULL)
1459 fclose(fp);
1460 goto cleanup;
Tim Peters1cd70172004-08-02 03:52:12 +00001461
1462 error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001463 m = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001464 cleanup:
Gregory P. Smithc809f982012-03-18 16:06:53 -07001465 if (buf)
1466 PyMem_FREE(buf);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001467 Py_XDECREF(path);
1468 Py_XDECREF(file);
1469 return m;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001470}
1471
1472
1473/* Helper to test for built-in module */
1474
1475static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001476is_builtin(char *name)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001477{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001478 int i;
1479 for (i = 0; PyImport_Inittab[i].name != NULL; i++) {
1480 if (strcmp(name, PyImport_Inittab[i].name) == 0) {
1481 if (PyImport_Inittab[i].initfunc == NULL)
1482 return -1;
1483 else
1484 return 1;
1485 }
1486 }
1487 return 0;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001488}
1489
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001490
Just van Rossum52e14d62002-12-30 22:08:05 +00001491/* Return an importer object for a sys.path/pkg.__path__ item 'p',
1492 possibly by fetching it from the path_importer_cache dict. If it
Thomas Wouters89f507f2006-12-13 04:49:30 +00001493 wasn't yet cached, traverse path_hooks until a hook is found
Just van Rossum52e14d62002-12-30 22:08:05 +00001494 that can handle the path item. Return None if no hook could;
1495 this tells our caller it should fall back to the builtin
1496 import mechanism. Cache the result in path_importer_cache.
1497 Returns a borrowed reference. */
1498
1499static PyObject *
1500get_path_importer(PyObject *path_importer_cache, PyObject *path_hooks,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001501 PyObject *p)
Just van Rossum52e14d62002-12-30 22:08:05 +00001502{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001503 PyObject *importer;
1504 Py_ssize_t j, nhooks;
Just van Rossum52e14d62002-12-30 22:08:05 +00001505
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001506 /* These conditions are the caller's responsibility: */
1507 assert(PyList_Check(path_hooks));
1508 assert(PyDict_Check(path_importer_cache));
Just van Rossum52e14d62002-12-30 22:08:05 +00001509
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001510 nhooks = PyList_Size(path_hooks);
1511 if (nhooks < 0)
1512 return NULL; /* Shouldn't happen */
Just van Rossum52e14d62002-12-30 22:08:05 +00001513
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001514 importer = PyDict_GetItem(path_importer_cache, p);
1515 if (importer != NULL)
1516 return importer;
Just van Rossum52e14d62002-12-30 22:08:05 +00001517
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001518 /* set path_importer_cache[p] to None to avoid recursion */
1519 if (PyDict_SetItem(path_importer_cache, p, Py_None) != 0)
1520 return NULL;
Just van Rossum52e14d62002-12-30 22:08:05 +00001521
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001522 for (j = 0; j < nhooks; j++) {
1523 PyObject *hook = PyList_GetItem(path_hooks, j);
1524 if (hook == NULL)
1525 return NULL;
1526 importer = PyObject_CallFunctionObjArgs(hook, p, NULL);
1527 if (importer != NULL)
1528 break;
Just van Rossum52e14d62002-12-30 22:08:05 +00001529
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001530 if (!PyErr_ExceptionMatches(PyExc_ImportError)) {
1531 return NULL;
1532 }
1533 PyErr_Clear();
1534 }
1535 if (importer == NULL) {
1536 importer = PyObject_CallFunctionObjArgs(
1537 (PyObject *)&PyNullImporter_Type, p, NULL
1538 );
1539 if (importer == NULL) {
1540 if (PyErr_ExceptionMatches(PyExc_ImportError)) {
1541 PyErr_Clear();
1542 return Py_None;
1543 }
1544 }
1545 }
1546 if (importer != NULL) {
1547 int err = PyDict_SetItem(path_importer_cache, p, importer);
1548 Py_DECREF(importer);
1549 if (err != 0)
1550 return NULL;
1551 }
1552 return importer;
Just van Rossum52e14d62002-12-30 22:08:05 +00001553}
1554
Christian Heimes9cd17752007-11-18 19:35:23 +00001555PyAPI_FUNC(PyObject *)
1556PyImport_GetImporter(PyObject *path) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001557 PyObject *importer=NULL, *path_importer_cache=NULL, *path_hooks=NULL;
Christian Heimes9cd17752007-11-18 19:35:23 +00001558
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001559 if ((path_importer_cache = PySys_GetObject("path_importer_cache"))) {
1560 if ((path_hooks = PySys_GetObject("path_hooks"))) {
1561 importer = get_path_importer(path_importer_cache,
1562 path_hooks, path);
1563 }
1564 }
1565 Py_XINCREF(importer); /* get_path_importer returns a borrowed reference */
1566 return importer;
Christian Heimes9cd17752007-11-18 19:35:23 +00001567}
1568
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001569/* Search the path (default sys.path) for a module. Return the
1570 corresponding filedescr struct, and (via return arguments) the
1571 pathname and an open file. Return NULL if the module is not found. */
1572
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001573#ifdef MS_COREDLL
Thomas Woutersb4bd21c2000-07-22 23:38:01 +00001574extern FILE *PyWin_FindRegisteredModule(const char *, struct filedescr **,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001575 char *, Py_ssize_t);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001576#endif
1577
Martin v. Löwis18e16552006-02-15 17:27:45 +00001578static int case_ok(char *, Py_ssize_t, Py_ssize_t, char *);
Tim Petersdbd9ba62000-07-09 03:09:57 +00001579static int find_init_module(char *); /* Forward */
Just van Rossum52e14d62002-12-30 22:08:05 +00001580static struct filedescr importhookdescr = {"", "", IMP_HOOK};
Guido van Rossum197346f1997-10-31 18:38:52 +00001581
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001582static struct filedescr *
Just van Rossum52e14d62002-12-30 22:08:05 +00001583find_module(char *fullname, char *subname, PyObject *path, char *buf,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001584 size_t buflen, FILE **p_fp, PyObject **p_loader)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001585{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001586 Py_ssize_t i, npath;
1587 size_t len, namelen;
1588 struct filedescr *fdp = NULL;
1589 char *filemode;
1590 FILE *fp = NULL;
1591 PyObject *path_hooks, *path_importer_cache;
1592 struct stat statbuf;
1593 static struct filedescr fd_frozen = {"", "", PY_FROZEN};
1594 static struct filedescr fd_builtin = {"", "", C_BUILTIN};
1595 static struct filedescr fd_package = {"", "", PKG_DIRECTORY};
Gregory P. Smithc809f982012-03-18 16:06:53 -07001596 char *name;
Andrew MacIntyred9400542002-02-26 11:41:34 +00001597#if defined(PYOS_OS2)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001598 size_t saved_len;
1599 size_t saved_namelen;
1600 char *saved_buf = NULL;
Andrew MacIntyred9400542002-02-26 11:41:34 +00001601#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001602 if (p_loader != NULL)
1603 *p_loader = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001604
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001605 if (strlen(subname) > MAXPATHLEN) {
1606 PyErr_SetString(PyExc_OverflowError,
1607 "module name is too long");
1608 return NULL;
1609 }
Gregory P. Smithc809f982012-03-18 16:06:53 -07001610 name = PyMem_MALLOC(MAXPATHLEN+1);
1611 if (name == NULL) {
1612 PyErr_NoMemory();
1613 return NULL;
1614 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001615 strcpy(name, subname);
Just van Rossum52e14d62002-12-30 22:08:05 +00001616
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001617 /* sys.meta_path import hook */
1618 if (p_loader != NULL) {
1619 PyObject *meta_path;
Just van Rossum52e14d62002-12-30 22:08:05 +00001620
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001621 meta_path = PySys_GetObject("meta_path");
1622 if (meta_path == NULL || !PyList_Check(meta_path)) {
Victor Stinner16191322011-09-15 19:28:05 +02001623 PyErr_SetString(PyExc_RuntimeError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001624 "sys.meta_path must be a list of "
1625 "import hooks");
Gregory P. Smithc809f982012-03-18 16:06:53 -07001626 goto error_exit;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001627 }
1628 Py_INCREF(meta_path); /* zap guard */
1629 npath = PyList_Size(meta_path);
1630 for (i = 0; i < npath; i++) {
1631 PyObject *loader;
1632 PyObject *hook = PyList_GetItem(meta_path, i);
1633 loader = PyObject_CallMethod(hook, "find_module",
1634 "sO", fullname,
1635 path != NULL ?
1636 path : Py_None);
1637 if (loader == NULL) {
1638 Py_DECREF(meta_path);
Gregory P. Smithc809f982012-03-18 16:06:53 -07001639 goto error_exit; /* true error */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001640 }
1641 if (loader != Py_None) {
1642 /* a loader was found */
1643 *p_loader = loader;
1644 Py_DECREF(meta_path);
Gregory P. Smithc809f982012-03-18 16:06:53 -07001645 PyMem_FREE(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001646 return &importhookdescr;
1647 }
1648 Py_DECREF(loader);
1649 }
1650 Py_DECREF(meta_path);
1651 }
Guido van Rossum0506a431998-08-11 15:07:39 +00001652
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001653 if (find_frozen(fullname) != NULL) {
1654 strcpy(buf, fullname);
Gregory P. Smithc809f982012-03-18 16:06:53 -07001655 PyMem_FREE(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001656 return &fd_frozen;
1657 }
Benjamin Petersond968e272008-11-05 22:48:33 +00001658
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001659 if (path == NULL) {
1660 if (is_builtin(name)) {
1661 strcpy(buf, name);
Gregory P. Smithc809f982012-03-18 16:06:53 -07001662 PyMem_FREE(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001663 return &fd_builtin;
1664 }
Guido van Rossumac279101996-08-22 23:10:58 +00001665#ifdef MS_COREDLL
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001666 fp = PyWin_FindRegisteredModule(name, &fdp, buf, buflen);
1667 if (fp != NULL) {
1668 *p_fp = fp;
Gregory P. Smithc809f982012-03-18 16:06:53 -07001669 PyMem_FREE(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001670 return fdp;
1671 }
Guido van Rossuma5a3db71996-04-09 02:39:59 +00001672#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001673 path = PySys_GetObject("path");
1674 }
Benjamin Petersond968e272008-11-05 22:48:33 +00001675
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001676 if (path == NULL || !PyList_Check(path)) {
Victor Stinner16191322011-09-15 19:28:05 +02001677 PyErr_SetString(PyExc_RuntimeError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001678 "sys.path must be a list of directory names");
Gregory P. Smithc809f982012-03-18 16:06:53 -07001679 goto error_exit;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001680 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001681
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001682 path_hooks = PySys_GetObject("path_hooks");
1683 if (path_hooks == NULL || !PyList_Check(path_hooks)) {
Victor Stinner16191322011-09-15 19:28:05 +02001684 PyErr_SetString(PyExc_RuntimeError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001685 "sys.path_hooks must be a list of "
1686 "import hooks");
Gregory P. Smithc809f982012-03-18 16:06:53 -07001687 goto error_exit;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001688 }
1689 path_importer_cache = PySys_GetObject("path_importer_cache");
1690 if (path_importer_cache == NULL ||
1691 !PyDict_Check(path_importer_cache)) {
Victor Stinner16191322011-09-15 19:28:05 +02001692 PyErr_SetString(PyExc_RuntimeError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001693 "sys.path_importer_cache must be a dict");
Gregory P. Smithc809f982012-03-18 16:06:53 -07001694 goto error_exit;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001695 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001696
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001697 npath = PyList_Size(path);
1698 namelen = strlen(name);
1699 for (i = 0; i < npath; i++) {
1700 PyObject *v = PyList_GetItem(path, i);
1701 PyObject *origv = v;
1702 const char *base;
1703 Py_ssize_t size;
1704 if (!v)
Gregory P. Smithc809f982012-03-18 16:06:53 -07001705 goto error_exit;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001706 if (PyUnicode_Check(v)) {
Victor Stinnerae6265f2010-05-15 16:27:27 +00001707 v = PyUnicode_EncodeFSDefault(v);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001708 if (v == NULL)
Gregory P. Smithc809f982012-03-18 16:06:53 -07001709 goto error_exit;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001710 }
1711 else if (!PyBytes_Check(v))
1712 continue;
1713 else
1714 Py_INCREF(v);
Amaury Forgeot d'Arcf1ca0b12008-06-11 17:40:47 +00001715
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001716 base = PyBytes_AS_STRING(v);
1717 size = PyBytes_GET_SIZE(v);
1718 len = size;
1719 if (len + 2 + namelen + MAXSUFFIXSIZE >= buflen) {
1720 Py_DECREF(v);
1721 continue; /* Too long */
1722 }
1723 strcpy(buf, base);
1724 Py_DECREF(v);
Amaury Forgeot d'Arcf1ca0b12008-06-11 17:40:47 +00001725
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001726 if (strlen(buf) != len) {
1727 continue; /* v contains '\0' */
1728 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001729
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001730 /* sys.path_hooks import hook */
1731 if (p_loader != NULL) {
1732 PyObject *importer;
Just van Rossum52e14d62002-12-30 22:08:05 +00001733
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001734 importer = get_path_importer(path_importer_cache,
1735 path_hooks, origv);
1736 if (importer == NULL) {
Gregory P. Smithc809f982012-03-18 16:06:53 -07001737 goto error_exit;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001738 }
1739 /* Note: importer is a borrowed reference */
1740 if (importer != Py_None) {
1741 PyObject *loader;
1742 loader = PyObject_CallMethod(importer,
1743 "find_module",
1744 "s", fullname);
1745 if (loader == NULL)
Gregory P. Smithc809f982012-03-18 16:06:53 -07001746 goto error_exit; /* error */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001747 if (loader != Py_None) {
1748 /* a loader was found */
1749 *p_loader = loader;
Gregory P. Smithc809f982012-03-18 16:06:53 -07001750 PyMem_FREE(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001751 return &importhookdescr;
1752 }
1753 Py_DECREF(loader);
1754 continue;
1755 }
1756 }
1757 /* no hook was found, use builtin import */
Just van Rossum52e14d62002-12-30 22:08:05 +00001758
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001759 if (len > 0 && buf[len-1] != SEP
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001760#ifdef ALTSEP
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001761 && buf[len-1] != ALTSEP
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001762#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001763 )
1764 buf[len++] = SEP;
1765 strcpy(buf+len, name);
1766 len += namelen;
Tim Peters50d8d372001-02-28 05:34:27 +00001767
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001768 /* Check for package import (buf holds a directory name,
1769 and there's an __init__ module in that directory */
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001770#ifdef HAVE_STAT
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001771 if (stat(buf, &statbuf) == 0 && /* it exists */
1772 S_ISDIR(statbuf.st_mode) && /* it's a directory */
1773 case_ok(buf, len, namelen, name)) { /* case matches */
1774 if (find_init_module(buf)) { /* and has __init__.py */
Gregory P. Smithc809f982012-03-18 16:06:53 -07001775 PyMem_FREE(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001776 return &fd_package;
1777 }
1778 else {
Victor Stinnered7916d2010-10-17 02:07:09 +00001779 int err;
1780 PyObject *unicode = PyUnicode_DecodeFSDefault(buf);
1781 if (unicode == NULL)
Gregory P. Smithc809f982012-03-18 16:06:53 -07001782 goto error_exit;
Victor Stinnered7916d2010-10-17 02:07:09 +00001783 err = PyErr_WarnFormat(PyExc_ImportWarning, 1,
1784 "Not importing directory '%U': missing __init__.py",
1785 unicode);
1786 Py_DECREF(unicode);
1787 if (err)
Gregory P. Smithc809f982012-03-18 16:06:53 -07001788 goto error_exit;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001789 }
1790 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001791#endif
Andrew MacIntyred9400542002-02-26 11:41:34 +00001792#if defined(PYOS_OS2)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001793 /* take a snapshot of the module spec for restoration
1794 * after the 8 character DLL hackery
1795 */
1796 saved_buf = strdup(buf);
1797 saved_len = len;
1798 saved_namelen = namelen;
Andrew MacIntyred9400542002-02-26 11:41:34 +00001799#endif /* PYOS_OS2 */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001800 for (fdp = _PyImport_Filetab; fdp->suffix != NULL; fdp++) {
Victor Stinner53ffdc52011-09-23 18:54:40 +02001801 struct stat statbuf;
Guido van Rossum04110fb2007-08-24 16:32:05 +00001802#if defined(PYOS_OS2) && defined(HAVE_DYNAMIC_LOADING)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001803 /* OS/2 limits DLLs to 8 character names (w/o
1804 extension)
1805 * so if the name is longer than that and its a
1806 * dynamically loaded module we're going to try,
1807 * truncate the name before trying
1808 */
1809 if (strlen(subname) > 8) {
1810 /* is this an attempt to load a C extension? */
1811 const struct filedescr *scan;
1812 scan = _PyImport_DynLoadFiletab;
1813 while (scan->suffix != NULL) {
1814 if (!strcmp(scan->suffix, fdp->suffix))
1815 break;
1816 else
1817 scan++;
1818 }
1819 if (scan->suffix != NULL) {
1820 /* yes, so truncate the name */
1821 namelen = 8;
1822 len -= strlen(subname) - namelen;
1823 buf[len] = '\0';
1824 }
1825 }
Andrew MacIntyred9400542002-02-26 11:41:34 +00001826#endif /* PYOS_OS2 */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001827 strcpy(buf+len, fdp->suffix);
1828 if (Py_VerboseFlag > 1)
1829 PySys_WriteStderr("# trying %s\n", buf);
Victor Stinner53ffdc52011-09-23 18:54:40 +02001830
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001831 filemode = fdp->mode;
1832 if (filemode[0] == 'U')
1833 filemode = "r" PY_STDIOTEXTMODE;
Victor Stinner53ffdc52011-09-23 18:54:40 +02001834
1835 if (stat(buf, &statbuf) == 0 && S_ISDIR(statbuf.st_mode))
1836 /* it's a directory */
1837 fp = NULL;
1838 else
1839 fp = fopen(buf, filemode);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001840 if (fp != NULL) {
1841 if (case_ok(buf, len, namelen, name))
1842 break;
1843 else { /* continue search */
1844 fclose(fp);
1845 fp = NULL;
1846 }
1847 }
Andrew MacIntyred9400542002-02-26 11:41:34 +00001848#if defined(PYOS_OS2)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001849 /* restore the saved snapshot */
1850 strcpy(buf, saved_buf);
1851 len = saved_len;
1852 namelen = saved_namelen;
Andrew MacIntyred9400542002-02-26 11:41:34 +00001853#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001854 }
Andrew MacIntyred9400542002-02-26 11:41:34 +00001855#if defined(PYOS_OS2)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001856 /* don't need/want the module name snapshot anymore */
1857 if (saved_buf)
1858 {
1859 free(saved_buf);
1860 saved_buf = NULL;
1861 }
Andrew MacIntyred9400542002-02-26 11:41:34 +00001862#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001863 if (fp != NULL)
1864 break;
1865 }
1866 if (fp == NULL) {
1867 PyErr_Format(PyExc_ImportError,
1868 "No module named %.200s", name);
Gregory P. Smithc809f982012-03-18 16:06:53 -07001869 goto error_exit;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001870 }
1871 *p_fp = fp;
Gregory P. Smithc809f982012-03-18 16:06:53 -07001872 PyMem_FREE(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001873 return fdp;
Gregory P. Smithc809f982012-03-18 16:06:53 -07001874
1875error_exit:
1876 PyMem_FREE(name);
1877 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001878}
1879
Martin v. Löwis18e16552006-02-15 17:27:45 +00001880/* case_ok(char* buf, Py_ssize_t len, Py_ssize_t namelen, char* name)
Tim Petersd1e87a82001-03-01 18:12:00 +00001881 * The arguments here are tricky, best shown by example:
1882 * /a/b/c/d/e/f/g/h/i/j/k/some_long_module_name.py\0
1883 * ^ ^ ^ ^
1884 * |--------------------- buf ---------------------|
1885 * |------------------- len ------------------|
1886 * |------ name -------|
1887 * |----- namelen -----|
1888 * buf is the full path, but len only counts up to (& exclusive of) the
1889 * extension. name is the module name, also exclusive of extension.
1890 *
1891 * We've already done a successful stat() or fopen() on buf, so know that
1892 * there's some match, possibly case-insensitive.
1893 *
Tim Peters50d8d372001-02-28 05:34:27 +00001894 * case_ok() is to return 1 if there's a case-sensitive match for
1895 * name, else 0. case_ok() is also to return 1 if envar PYTHONCASEOK
1896 * exists.
Tim Petersd1e87a82001-03-01 18:12:00 +00001897 *
Tim Peters50d8d372001-02-28 05:34:27 +00001898 * case_ok() is used to implement case-sensitive import semantics even
1899 * on platforms with case-insensitive filesystems. It's trivial to implement
1900 * for case-sensitive filesystems. It's pretty much a cross-platform
1901 * nightmare for systems with case-insensitive filesystems.
1902 */
Guido van Rossum0980bd91998-02-13 17:18:36 +00001903
Tim Peters50d8d372001-02-28 05:34:27 +00001904/* First we may need a pile of platform-specific header files; the sequence
1905 * of #if's here should match the sequence in the body of case_ok().
1906 */
Jason Tishler7961aa62005-05-20 00:56:54 +00001907#if defined(MS_WINDOWS)
Guido van Rossum0980bd91998-02-13 17:18:36 +00001908#include <windows.h>
Guido van Rossum4c3f57c2001-01-10 20:40:46 +00001909
Tim Peters50d8d372001-02-28 05:34:27 +00001910#elif defined(DJGPP)
1911#include <dir.h>
1912
Jason Tishler7961aa62005-05-20 00:56:54 +00001913#elif (defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) && defined(HAVE_DIRENT_H)
Tim Peters430f5d42001-03-01 01:30:56 +00001914#include <sys/types.h>
1915#include <dirent.h>
1916
Andrew MacIntyred9400542002-02-26 11:41:34 +00001917#elif defined(PYOS_OS2)
1918#define INCL_DOS
1919#define INCL_DOSERRORS
1920#define INCL_NOPMAPI
1921#include <os2.h>
Tim Peters50d8d372001-02-28 05:34:27 +00001922#endif
1923
Guido van Rossum0980bd91998-02-13 17:18:36 +00001924static int
Martin v. Löwis18e16552006-02-15 17:27:45 +00001925case_ok(char *buf, Py_ssize_t len, Py_ssize_t namelen, char *name)
Guido van Rossum0980bd91998-02-13 17:18:36 +00001926{
Tim Peters50d8d372001-02-28 05:34:27 +00001927/* Pick a platform-specific implementation; the sequence of #if's here should
1928 * match the sequence just above.
1929 */
1930
Jason Tishler7961aa62005-05-20 00:56:54 +00001931/* MS_WINDOWS */
1932#if defined(MS_WINDOWS)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001933 WIN32_FIND_DATA data;
1934 HANDLE h;
Tim Peters50d8d372001-02-28 05:34:27 +00001935
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001936 if (Py_GETENV("PYTHONCASEOK") != NULL)
1937 return 1;
Tim Peters50d8d372001-02-28 05:34:27 +00001938
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001939 h = FindFirstFile(buf, &data);
1940 if (h == INVALID_HANDLE_VALUE) {
1941 PyErr_Format(PyExc_NameError,
1942 "Can't find file for module %.100s\n(filename %.300s)",
1943 name, buf);
1944 return 0;
1945 }
1946 FindClose(h);
1947 return strncmp(data.cFileName, name, namelen) == 0;
Tim Peters50d8d372001-02-28 05:34:27 +00001948
1949/* DJGPP */
1950#elif defined(DJGPP)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001951 struct ffblk ffblk;
1952 int done;
Tim Peters50d8d372001-02-28 05:34:27 +00001953
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001954 if (Py_GETENV("PYTHONCASEOK") != NULL)
1955 return 1;
Tim Peters50d8d372001-02-28 05:34:27 +00001956
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001957 done = findfirst(buf, &ffblk, FA_ARCH|FA_RDONLY|FA_HIDDEN|FA_DIREC);
1958 if (done) {
1959 PyErr_Format(PyExc_NameError,
1960 "Can't find file for module %.100s\n(filename %.300s)",
1961 name, buf);
1962 return 0;
1963 }
1964 return strncmp(ffblk.ff_name, name, namelen) == 0;
Guido van Rossum0980bd91998-02-13 17:18:36 +00001965
Jason Tishler7961aa62005-05-20 00:56:54 +00001966/* new-fangled macintosh (macosx) or Cygwin */
1967#elif (defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) && defined(HAVE_DIRENT_H)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001968 DIR *dirp;
1969 struct dirent *dp;
1970 char dirname[MAXPATHLEN + 1];
1971 const int dirlen = len - namelen - 1; /* don't want trailing SEP */
Tim Peters430f5d42001-03-01 01:30:56 +00001972
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001973 if (Py_GETENV("PYTHONCASEOK") != NULL)
1974 return 1;
Tim Petersdbe6ebb2001-03-01 08:47:29 +00001975
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001976 /* Copy the dir component into dirname; substitute "." if empty */
1977 if (dirlen <= 0) {
1978 dirname[0] = '.';
1979 dirname[1] = '\0';
1980 }
1981 else {
1982 assert(dirlen <= MAXPATHLEN);
1983 memcpy(dirname, buf, dirlen);
1984 dirname[dirlen] = '\0';
1985 }
1986 /* Open the directory and search the entries for an exact match. */
1987 dirp = opendir(dirname);
1988 if (dirp) {
1989 char *nameWithExt = buf + len - namelen;
1990 while ((dp = readdir(dirp)) != NULL) {
1991 const int thislen =
Tim Peters430f5d42001-03-01 01:30:56 +00001992#ifdef _DIRENT_HAVE_D_NAMELEN
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001993 dp->d_namlen;
Tim Peters430f5d42001-03-01 01:30:56 +00001994#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001995 strlen(dp->d_name);
Tim Peters430f5d42001-03-01 01:30:56 +00001996#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001997 if (thislen >= namelen &&
1998 strcmp(dp->d_name, nameWithExt) == 0) {
1999 (void)closedir(dirp);
2000 return 1; /* Found */
2001 }
2002 }
2003 (void)closedir(dirp);
2004 }
2005 return 0 ; /* Not found */
Tim Peters430f5d42001-03-01 01:30:56 +00002006
Andrew MacIntyred9400542002-02-26 11:41:34 +00002007/* OS/2 */
2008#elif defined(PYOS_OS2)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002009 HDIR hdir = 1;
2010 ULONG srchcnt = 1;
2011 FILEFINDBUF3 ffbuf;
2012 APIRET rc;
Andrew MacIntyred9400542002-02-26 11:41:34 +00002013
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002014 if (Py_GETENV("PYTHONCASEOK") != NULL)
2015 return 1;
Andrew MacIntyred9400542002-02-26 11:41:34 +00002016
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002017 rc = DosFindFirst(buf,
2018 &hdir,
2019 FILE_READONLY | FILE_HIDDEN | FILE_SYSTEM | FILE_DIRECTORY,
2020 &ffbuf, sizeof(ffbuf),
2021 &srchcnt,
2022 FIL_STANDARD);
2023 if (rc != NO_ERROR)
2024 return 0;
2025 return strncmp(ffbuf.achName, name, namelen) == 0;
Andrew MacIntyred9400542002-02-26 11:41:34 +00002026
Tim Peters50d8d372001-02-28 05:34:27 +00002027/* assuming it's a case-sensitive filesystem, so there's nothing to do! */
2028#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002029 return 1;
Guido van Rossum0980bd91998-02-13 17:18:36 +00002030
Guido van Rossum4d1b3b91998-02-13 23:27:59 +00002031#endif
Tim Peters50d8d372001-02-28 05:34:27 +00002032}
Guido van Rossum4d1b3b91998-02-13 23:27:59 +00002033
Guido van Rossum197346f1997-10-31 18:38:52 +00002034#ifdef HAVE_STAT
Victor Stinner4f4402c2010-08-14 14:50:26 +00002035
Guido van Rossum197346f1997-10-31 18:38:52 +00002036/* Helper to look for __init__.py or __init__.py[co] in potential package */
2037static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002038find_init_module(char *buf)
Guido van Rossum197346f1997-10-31 18:38:52 +00002039{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002040 const size_t save_len = strlen(buf);
2041 size_t i = save_len;
2042 char *pname; /* pointer to start of __init__ */
2043 struct stat statbuf;
Guido van Rossum197346f1997-10-31 18:38:52 +00002044
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002045/* For calling case_ok(buf, len, namelen, name):
2046 * /a/b/c/d/e/f/g/h/i/j/k/some_long_module_name.py\0
2047 * ^ ^ ^ ^
2048 * |--------------------- buf ---------------------|
2049 * |------------------- len ------------------|
2050 * |------ name -------|
2051 * |----- namelen -----|
Tim Peters0f9431f2001-07-05 03:47:53 +00002052 */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002053 if (save_len + 13 >= MAXPATHLEN)
2054 return 0;
2055 buf[i++] = SEP;
2056 pname = buf + i;
2057 strcpy(pname, "__init__.py");
2058 if (stat(buf, &statbuf) == 0) {
2059 if (case_ok(buf,
2060 save_len + 9, /* len("/__init__") */
2061 8, /* len("__init__") */
2062 pname)) {
2063 buf[save_len] = '\0';
2064 return 1;
2065 }
2066 }
2067 i += strlen(pname);
2068 strcpy(buf+i, Py_OptimizeFlag ? "o" : "c");
2069 if (stat(buf, &statbuf) == 0) {
2070 if (case_ok(buf,
2071 save_len + 9, /* len("/__init__") */
2072 8, /* len("__init__") */
2073 pname)) {
2074 buf[save_len] = '\0';
2075 return 1;
2076 }
2077 }
2078 buf[save_len] = '\0';
2079 return 0;
Guido van Rossum197346f1997-10-31 18:38:52 +00002080}
Guido van Rossum48a680c2001-03-02 06:34:14 +00002081
Guido van Rossum197346f1997-10-31 18:38:52 +00002082#endif /* HAVE_STAT */
2083
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002084
Tim Petersdbd9ba62000-07-09 03:09:57 +00002085static int init_builtin(char *); /* Forward */
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002086
Victor Stinner44c6c152010-08-09 00:59:10 +00002087static PyObject*
2088load_builtin(char *name, char *pathname, int type)
2089{
2090 PyObject *m, *modules;
2091 int err;
2092
2093 if (pathname != NULL && pathname[0] != '\0')
2094 name = pathname;
2095
2096 if (type == C_BUILTIN)
2097 err = init_builtin(name);
2098 else
2099 err = PyImport_ImportFrozenModule(name);
2100 if (err < 0)
2101 return NULL;
2102 if (err == 0) {
2103 PyErr_Format(PyExc_ImportError,
2104 "Purported %s module %.200s not found",
2105 type == C_BUILTIN ?
2106 "builtin" : "frozen",
2107 name);
2108 return NULL;
2109 }
2110
2111 modules = PyImport_GetModuleDict();
2112 m = PyDict_GetItemString(modules, name);
2113 if (m == NULL) {
2114 PyErr_Format(
2115 PyExc_ImportError,
2116 "%s module %.200s not properly initialized",
2117 type == C_BUILTIN ?
2118 "builtin" : "frozen",
2119 name);
2120 return NULL;
2121 }
2122 Py_INCREF(m);
2123 return m;
2124}
2125
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002126/* Load an external module using the default search path and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00002127 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002128
Guido van Rossum79f25d91997-04-29 20:08:16 +00002129static PyObject *
Alexandre Vassalottie223eb82009-07-29 20:12:15 +00002130load_module(char *name, FILE *fp, char *pathname, int type, PyObject *loader)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002131{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002132 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002133
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002134 /* First check that there's an open file (if we need one) */
2135 switch (type) {
2136 case PY_SOURCE:
2137 case PY_COMPILED:
2138 if (fp == NULL) {
2139 PyErr_Format(PyExc_ValueError,
2140 "file object required for import (type code %d)",
2141 type);
2142 return NULL;
2143 }
2144 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002145
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002146 switch (type) {
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002147
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002148 case PY_SOURCE:
2149 m = load_source_module(name, pathname, fp);
2150 break;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002151
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002152 case PY_COMPILED:
2153 m = load_compiled_module(name, pathname, fp);
2154 break;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002155
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002156#ifdef HAVE_DYNAMIC_LOADING
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002157 case C_EXTENSION:
2158 m = _PyImport_LoadDynamicModule(name, pathname, fp);
2159 break;
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002160#endif
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002161
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002162 case PKG_DIRECTORY:
2163 m = load_package(name, pathname);
2164 break;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002165
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002166 case C_BUILTIN:
2167 case PY_FROZEN:
Victor Stinner44c6c152010-08-09 00:59:10 +00002168 m = load_builtin(name, pathname, type);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002169 break;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002170
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002171 case IMP_HOOK: {
2172 if (loader == NULL) {
2173 PyErr_SetString(PyExc_ImportError,
2174 "import hook without loader");
2175 return NULL;
2176 }
2177 m = PyObject_CallMethod(loader, "load_module", "s", name);
2178 break;
2179 }
Just van Rossum52e14d62002-12-30 22:08:05 +00002180
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002181 default:
2182 PyErr_Format(PyExc_ImportError,
2183 "Don't know how to import %.200s (type code %d)",
2184 name, type);
2185 m = NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002186
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002187 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002188
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002189 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002190}
2191
2192
2193/* Initialize a built-in module.
Thomas Wouters89f507f2006-12-13 04:49:30 +00002194 Return 1 for success, 0 if the module is not found, and -1 with
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002195 an exception set if the initialization failed. */
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002196
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002197static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002198init_builtin(char *name)
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002199{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002200 struct _inittab *p;
Guido van Rossum25ce5661997-08-02 03:10:38 +00002201
Victor Stinner49d3f252010-10-17 01:24:53 +00002202 if (_PyImport_FindBuiltin(name) != NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002203 return 1;
Guido van Rossum25ce5661997-08-02 03:10:38 +00002204
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002205 for (p = PyImport_Inittab; p->name != NULL; p++) {
2206 PyObject *mod;
Antoine Pitrou6c40eb72012-01-18 20:16:09 +01002207 PyModuleDef *def;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002208 if (strcmp(name, p->name) == 0) {
2209 if (p->initfunc == NULL) {
2210 PyErr_Format(PyExc_ImportError,
2211 "Cannot re-init internal module %.200s",
2212 name);
2213 return -1;
2214 }
2215 if (Py_VerboseFlag)
2216 PySys_WriteStderr("import %s # builtin\n", name);
2217 mod = (*p->initfunc)();
2218 if (mod == 0)
2219 return -1;
Antoine Pitrou6c40eb72012-01-18 20:16:09 +01002220 /* Remember pointer to module init function. */
2221 def = PyModule_GetDef(mod);
2222 def->m_base.m_init = p->initfunc;
Victor Stinner49d3f252010-10-17 01:24:53 +00002223 if (_PyImport_FixupBuiltin(mod, name) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002224 return -1;
2225 /* FixupExtension has put the module into sys.modules,
2226 so we can release our own reference. */
2227 Py_DECREF(mod);
2228 return 1;
2229 }
2230 }
2231 return 0;
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002232}
Guido van Rossumf56e3db1993-04-01 20:59:32 +00002233
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002234
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002235/* Frozen modules */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002236
Guido van Rossumcfd0a221996-06-17 17:06:34 +00002237static struct _frozen *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002238find_frozen(char *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002239{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002240 struct _frozen *p;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002241
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002242 if (!name)
2243 return NULL;
Benjamin Petersond968e272008-11-05 22:48:33 +00002244
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002245 for (p = PyImport_FrozenModules; ; p++) {
2246 if (p->name == NULL)
2247 return NULL;
2248 if (strcmp(p->name, name) == 0)
2249 break;
2250 }
2251 return p;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002252}
2253
Guido van Rossum79f25d91997-04-29 20:08:16 +00002254static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002255get_frozen_object(char *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002256{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002257 struct _frozen *p = find_frozen(name);
2258 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002259
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002260 if (p == NULL) {
2261 PyErr_Format(PyExc_ImportError,
2262 "No such frozen object named %.200s",
2263 name);
2264 return NULL;
2265 }
2266 if (p->code == NULL) {
2267 PyErr_Format(PyExc_ImportError,
2268 "Excluded frozen object named %.200s",
2269 name);
2270 return NULL;
2271 }
2272 size = p->size;
2273 if (size < 0)
2274 size = -size;
2275 return PyMarshal_ReadObjectFromString((char *)p->code, size);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002276}
2277
Brett Cannon8d110132009-03-15 02:20:16 +00002278static PyObject *
2279is_frozen_package(char *name)
2280{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002281 struct _frozen *p = find_frozen(name);
2282 int size;
Brett Cannon8d110132009-03-15 02:20:16 +00002283
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002284 if (p == NULL) {
2285 PyErr_Format(PyExc_ImportError,
2286 "No such frozen object named %.200s",
2287 name);
2288 return NULL;
2289 }
Brett Cannon8d110132009-03-15 02:20:16 +00002290
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002291 size = p->size;
Brett Cannon8d110132009-03-15 02:20:16 +00002292
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002293 if (size < 0)
2294 Py_RETURN_TRUE;
2295 else
2296 Py_RETURN_FALSE;
Brett Cannon8d110132009-03-15 02:20:16 +00002297}
2298
2299
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002300/* Initialize a frozen module.
Brett Cannon3c2ac442009-03-08 20:49:47 +00002301 Return 1 for success, 0 if the module is not found, and -1 with
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002302 an exception set if the initialization failed.
2303 This function is also used from frozenmain.c */
Guido van Rossum0b344901995-02-07 15:35:27 +00002304
2305int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002306PyImport_ImportFrozenModule(char *name)
Guido van Rossumf56e3db1993-04-01 20:59:32 +00002307{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002308 struct _frozen *p = find_frozen(name);
2309 PyObject *co;
2310 PyObject *m;
2311 int ispackage;
2312 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002313
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002314 if (p == NULL)
2315 return 0;
2316 if (p->code == NULL) {
2317 PyErr_Format(PyExc_ImportError,
2318 "Excluded frozen object named %.200s",
2319 name);
2320 return -1;
2321 }
2322 size = p->size;
2323 ispackage = (size < 0);
2324 if (ispackage)
2325 size = -size;
2326 if (Py_VerboseFlag)
2327 PySys_WriteStderr("import %s # frozen%s\n",
2328 name, ispackage ? " package" : "");
2329 co = PyMarshal_ReadObjectFromString((char *)p->code, size);
2330 if (co == NULL)
2331 return -1;
2332 if (!PyCode_Check(co)) {
2333 PyErr_Format(PyExc_TypeError,
2334 "frozen object %.200s is not a code object",
2335 name);
2336 goto err_return;
2337 }
2338 if (ispackage) {
2339 /* Set __path__ to the package name */
2340 PyObject *d, *s, *l;
2341 int err;
2342 m = PyImport_AddModule(name);
2343 if (m == NULL)
2344 goto err_return;
2345 d = PyModule_GetDict(m);
2346 s = PyUnicode_InternFromString(name);
2347 if (s == NULL)
2348 goto err_return;
2349 l = PyList_New(1);
2350 if (l == NULL) {
2351 Py_DECREF(s);
2352 goto err_return;
2353 }
2354 PyList_SET_ITEM(l, 0, s);
2355 err = PyDict_SetItemString(d, "__path__", l);
2356 Py_DECREF(l);
2357 if (err != 0)
2358 goto err_return;
2359 }
2360 m = PyImport_ExecCodeModuleEx(name, co, "<frozen>");
2361 if (m == NULL)
2362 goto err_return;
2363 Py_DECREF(co);
2364 Py_DECREF(m);
2365 return 1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002366err_return:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002367 Py_DECREF(co);
2368 return -1;
Guido van Rossumf56e3db1993-04-01 20:59:32 +00002369}
Guido van Rossum74e6a111994-08-29 12:54:38 +00002370
2371
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002372/* Import a module, either built-in, frozen, or external, and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00002373 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum74e6a111994-08-29 12:54:38 +00002374
Guido van Rossum79f25d91997-04-29 20:08:16 +00002375PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00002376PyImport_ImportModule(const char *name)
Guido van Rossum74e6a111994-08-29 12:54:38 +00002377{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002378 PyObject *pname;
2379 PyObject *result;
Marc-André Lemburg3c61c352001-02-09 19:40:15 +00002380
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002381 pname = PyUnicode_FromString(name);
2382 if (pname == NULL)
2383 return NULL;
2384 result = PyImport_Import(pname);
2385 Py_DECREF(pname);
2386 return result;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002387}
2388
Christian Heimes072c0f12008-01-03 23:01:04 +00002389/* Import a module without blocking
2390 *
2391 * At first it tries to fetch the module from sys.modules. If the module was
2392 * never loaded before it loads it with PyImport_ImportModule() unless another
2393 * thread holds the import lock. In the latter case the function raises an
2394 * ImportError instead of blocking.
2395 *
2396 * Returns the module object with incremented ref count.
2397 */
2398PyObject *
2399PyImport_ImportModuleNoBlock(const char *name)
2400{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002401 PyObject *result;
2402 PyObject *modules;
Victor Stinner0af03062011-09-02 00:11:43 +02002403#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002404 long me;
Victor Stinner0af03062011-09-02 00:11:43 +02002405#endif
Christian Heimes072c0f12008-01-03 23:01:04 +00002406
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002407 /* Try to get the module from sys.modules[name] */
2408 modules = PyImport_GetModuleDict();
2409 if (modules == NULL)
2410 return NULL;
Christian Heimes072c0f12008-01-03 23:01:04 +00002411
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002412 result = PyDict_GetItemString(modules, name);
2413 if (result != NULL) {
2414 Py_INCREF(result);
2415 return result;
2416 }
2417 else {
2418 PyErr_Clear();
2419 }
Benjamin Peterson3e4f0552008-09-02 00:31:15 +00002420#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002421 /* check the import lock
2422 * me might be -1 but I ignore the error here, the lock function
2423 * takes care of the problem */
2424 me = PyThread_get_thread_ident();
2425 if (import_lock_thread == -1 || import_lock_thread == me) {
2426 /* no thread or me is holding the lock */
2427 return PyImport_ImportModule(name);
2428 }
2429 else {
2430 PyErr_Format(PyExc_ImportError,
2431 "Failed to import %.200s because the import lock"
2432 "is held by another thread.",
2433 name);
2434 return NULL;
2435 }
Benjamin Peterson3e4f0552008-09-02 00:31:15 +00002436#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002437 return PyImport_ImportModule(name);
Benjamin Peterson3e4f0552008-09-02 00:31:15 +00002438#endif
Christian Heimes072c0f12008-01-03 23:01:04 +00002439}
2440
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002441/* Forward declarations for helper routines */
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002442static PyObject *get_parent(PyObject *globals, char *buf,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002443 Py_ssize_t *p_buflen, int level);
Tim Petersdbd9ba62000-07-09 03:09:57 +00002444static PyObject *load_next(PyObject *mod, PyObject *altmod,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002445 char **p_name, char *buf, Py_ssize_t *p_buflen);
Tim Petersdbd9ba62000-07-09 03:09:57 +00002446static int mark_miss(char *name);
2447static int ensure_fromlist(PyObject *mod, PyObject *fromlist,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002448 char *buf, Py_ssize_t buflen, int recursive);
Tim Petersdbd9ba62000-07-09 03:09:57 +00002449static PyObject * import_submodule(PyObject *mod, char *name, char *fullname);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002450
2451/* The Magnum Opus of dotted-name import :-) */
2452
Guido van Rossum75acc9c1998-03-03 22:26:50 +00002453static PyObject *
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002454import_module_level(char *name, PyObject *globals, PyObject *locals,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002455 PyObject *fromlist, int level)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002456{
Gregory P. Smithc809f982012-03-18 16:06:53 -07002457 char *buf;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002458 Py_ssize_t buflen = 0;
2459 PyObject *parent, *head, *next, *tail;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002460
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002461 if (strchr(name, '/') != NULL
Christian Heimes454f37b2008-01-10 00:10:02 +00002462#ifdef MS_WINDOWS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002463 || strchr(name, '\\') != NULL
Christian Heimes454f37b2008-01-10 00:10:02 +00002464#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002465 ) {
2466 PyErr_SetString(PyExc_ImportError,
2467 "Import by filename is not supported.");
2468 return NULL;
2469 }
Christian Heimes454f37b2008-01-10 00:10:02 +00002470
Gregory P. Smithc809f982012-03-18 16:06:53 -07002471 buf = PyMem_MALLOC(MAXPATHLEN+1);
2472 if (buf == NULL) {
2473 return PyErr_NoMemory();
2474 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002475 parent = get_parent(globals, buf, &buflen, level);
2476 if (parent == NULL)
Gregory P. Smithc809f982012-03-18 16:06:53 -07002477 goto error_exit;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002478
Benjamin Peterson556d8002010-06-27 22:37:28 +00002479 head = load_next(parent, level < 0 ? Py_None : parent, &name, buf,
2480 &buflen);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002481 if (head == NULL)
Gregory P. Smithc809f982012-03-18 16:06:53 -07002482 goto error_exit;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002483
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002484 tail = head;
2485 Py_INCREF(tail);
2486 while (name) {
2487 next = load_next(tail, tail, &name, buf, &buflen);
2488 Py_DECREF(tail);
2489 if (next == NULL) {
2490 Py_DECREF(head);
Gregory P. Smithc809f982012-03-18 16:06:53 -07002491 goto error_exit;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002492 }
2493 tail = next;
2494 }
2495 if (tail == Py_None) {
2496 /* If tail is Py_None, both get_parent and load_next found
2497 an empty module name: someone called __import__("") or
2498 doctored faulty bytecode */
2499 Py_DECREF(tail);
2500 Py_DECREF(head);
2501 PyErr_SetString(PyExc_ValueError,
2502 "Empty module name");
Gregory P. Smithc809f982012-03-18 16:06:53 -07002503 goto error_exit;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002504 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002505
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002506 if (fromlist != NULL) {
2507 if (fromlist == Py_None || !PyObject_IsTrue(fromlist))
2508 fromlist = NULL;
2509 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002510
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002511 if (fromlist == NULL) {
2512 Py_DECREF(tail);
Gregory P. Smithc809f982012-03-18 16:06:53 -07002513 PyMem_FREE(buf);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002514 return head;
2515 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002516
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002517 Py_DECREF(head);
2518 if (!ensure_fromlist(tail, fromlist, buf, buflen, 0)) {
2519 Py_DECREF(tail);
Gregory P. Smithc809f982012-03-18 16:06:53 -07002520 goto error_exit;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002521 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002522
Gregory P. Smithc809f982012-03-18 16:06:53 -07002523 PyMem_FREE(buf);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002524 return tail;
Gregory P. Smithc809f982012-03-18 16:06:53 -07002525
2526error_exit:
2527 PyMem_FREE(buf);
2528 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002529}
2530
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002531PyObject *
2532PyImport_ImportModuleLevel(char *name, PyObject *globals, PyObject *locals,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002533 PyObject *fromlist, int level)
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002534{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002535 PyObject *result;
2536 _PyImport_AcquireLock();
2537 result = import_module_level(name, globals, locals, fromlist, level);
2538 if (_PyImport_ReleaseLock() < 0) {
2539 Py_XDECREF(result);
2540 PyErr_SetString(PyExc_RuntimeError,
2541 "not holding the import lock");
2542 return NULL;
2543 }
2544 return result;
Guido van Rossum75acc9c1998-03-03 22:26:50 +00002545}
2546
Fred Drake87590902004-05-28 20:21:36 +00002547/* Return the package that an import is being performed in. If globals comes
2548 from the module foo.bar.bat (not itself a package), this returns the
2549 sys.modules entry for foo.bar. If globals is from a package's __init__.py,
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00002550 the package's entry in sys.modules is returned, as a borrowed reference.
Fred Drake87590902004-05-28 20:21:36 +00002551
2552 The *name* of the returned package is returned in buf, with the length of
2553 the name in *p_buflen.
2554
2555 If globals doesn't come from a package or a module in a package, or a
2556 corresponding entry is not found in sys.modules, Py_None is returned.
2557*/
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002558static PyObject *
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002559get_parent(PyObject *globals, char *buf, Py_ssize_t *p_buflen, int level)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002560{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002561 static PyObject *namestr = NULL;
2562 static PyObject *pathstr = NULL;
2563 static PyObject *pkgstr = NULL;
2564 PyObject *pkgname, *modname, *modpath, *modules, *parent;
2565 int orig_level = level;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002566
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002567 if (globals == NULL || !PyDict_Check(globals) || !level)
2568 return Py_None;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002569
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002570 if (namestr == NULL) {
2571 namestr = PyUnicode_InternFromString("__name__");
2572 if (namestr == NULL)
2573 return NULL;
2574 }
2575 if (pathstr == NULL) {
2576 pathstr = PyUnicode_InternFromString("__path__");
2577 if (pathstr == NULL)
2578 return NULL;
2579 }
2580 if (pkgstr == NULL) {
2581 pkgstr = PyUnicode_InternFromString("__package__");
2582 if (pkgstr == NULL)
2583 return NULL;
2584 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002585
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002586 *buf = '\0';
2587 *p_buflen = 0;
2588 pkgname = PyDict_GetItem(globals, pkgstr);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002589
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002590 if ((pkgname != NULL) && (pkgname != Py_None)) {
2591 /* __package__ is set, so use it */
2592 char *pkgname_str;
2593 Py_ssize_t len;
Alexandre Vassalottia85998a2008-05-03 18:24:43 +00002594
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002595 if (!PyUnicode_Check(pkgname)) {
2596 PyErr_SetString(PyExc_ValueError,
2597 "__package__ set to non-string");
2598 return NULL;
2599 }
2600 pkgname_str = _PyUnicode_AsStringAndSize(pkgname, &len);
2601 if (len == 0) {
2602 if (level > 0) {
2603 PyErr_SetString(PyExc_ValueError,
2604 "Attempted relative import in non-package");
2605 return NULL;
2606 }
2607 return Py_None;
2608 }
2609 if (len > MAXPATHLEN) {
2610 PyErr_SetString(PyExc_ValueError,
2611 "Package name too long");
2612 return NULL;
2613 }
2614 strcpy(buf, pkgname_str);
2615 } else {
2616 /* __package__ not set, so figure it out and set it */
2617 modname = PyDict_GetItem(globals, namestr);
2618 if (modname == NULL || !PyUnicode_Check(modname))
2619 return Py_None;
Brett Cannon9a5b25a2010-03-01 02:09:17 +00002620
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002621 modpath = PyDict_GetItem(globals, pathstr);
2622 if (modpath != NULL) {
2623 /* __path__ is set, so modname is already the package name */
2624 char *modname_str;
2625 Py_ssize_t len;
2626 int error;
Alexandre Vassalottia85998a2008-05-03 18:24:43 +00002627
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002628 modname_str = _PyUnicode_AsStringAndSize(modname, &len);
2629 if (len > MAXPATHLEN) {
2630 PyErr_SetString(PyExc_ValueError,
2631 "Module name too long");
2632 return NULL;
2633 }
2634 strcpy(buf, modname_str);
2635 error = PyDict_SetItem(globals, pkgstr, modname);
2636 if (error) {
2637 PyErr_SetString(PyExc_ValueError,
2638 "Could not set __package__");
2639 return NULL;
2640 }
2641 } else {
2642 /* Normal module, so work out the package name if any */
2643 char *start = _PyUnicode_AsString(modname);
2644 char *lastdot = strrchr(start, '.');
2645 size_t len;
2646 int error;
2647 if (lastdot == NULL && level > 0) {
2648 PyErr_SetString(PyExc_ValueError,
2649 "Attempted relative import in non-package");
2650 return NULL;
2651 }
2652 if (lastdot == NULL) {
2653 error = PyDict_SetItem(globals, pkgstr, Py_None);
2654 if (error) {
2655 PyErr_SetString(PyExc_ValueError,
2656 "Could not set __package__");
2657 return NULL;
2658 }
2659 return Py_None;
2660 }
2661 len = lastdot - start;
2662 if (len >= MAXPATHLEN) {
2663 PyErr_SetString(PyExc_ValueError,
2664 "Module name too long");
2665 return NULL;
2666 }
2667 strncpy(buf, start, len);
2668 buf[len] = '\0';
2669 pkgname = PyUnicode_FromString(buf);
2670 if (pkgname == NULL) {
2671 return NULL;
2672 }
2673 error = PyDict_SetItem(globals, pkgstr, pkgname);
2674 Py_DECREF(pkgname);
2675 if (error) {
2676 PyErr_SetString(PyExc_ValueError,
2677 "Could not set __package__");
2678 return NULL;
2679 }
2680 }
2681 }
2682 while (--level > 0) {
2683 char *dot = strrchr(buf, '.');
2684 if (dot == NULL) {
2685 PyErr_SetString(PyExc_ValueError,
2686 "Attempted relative import beyond "
2687 "toplevel package");
2688 return NULL;
2689 }
2690 *dot = '\0';
2691 }
2692 *p_buflen = strlen(buf);
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002693
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002694 modules = PyImport_GetModuleDict();
2695 parent = PyDict_GetItemString(modules, buf);
2696 if (parent == NULL) {
2697 if (orig_level < 1) {
2698 PyObject *err_msg = PyBytes_FromFormat(
2699 "Parent module '%.200s' not found "
2700 "while handling absolute import", buf);
2701 if (err_msg == NULL) {
2702 return NULL;
2703 }
2704 if (!PyErr_WarnEx(PyExc_RuntimeWarning,
2705 PyBytes_AsString(err_msg), 1)) {
2706 *buf = '\0';
2707 *p_buflen = 0;
2708 parent = Py_None;
2709 }
2710 Py_DECREF(err_msg);
2711 } else {
2712 PyErr_Format(PyExc_SystemError,
2713 "Parent module '%.200s' not loaded, "
2714 "cannot perform relative import", buf);
2715 }
2716 }
2717 return parent;
2718 /* We expect, but can't guarantee, if parent != None, that:
2719 - parent.__name__ == buf
2720 - parent.__dict__ is globals
2721 If this is violated... Who cares? */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002722}
2723
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002724/* altmod is either None or same as mod */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002725static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002726load_next(PyObject *mod, PyObject *altmod, char **p_name, char *buf,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002727 Py_ssize_t *p_buflen)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002728{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002729 char *name = *p_name;
2730 char *dot = strchr(name, '.');
2731 size_t len;
2732 char *p;
2733 PyObject *result;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002734
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002735 if (strlen(name) == 0) {
2736 /* completely empty module name should only happen in
2737 'from . import' (or '__import__("")')*/
2738 Py_INCREF(mod);
2739 *p_name = NULL;
2740 return mod;
2741 }
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002742
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002743 if (dot == NULL) {
2744 *p_name = NULL;
2745 len = strlen(name);
2746 }
2747 else {
2748 *p_name = dot+1;
2749 len = dot-name;
2750 }
2751 if (len == 0) {
2752 PyErr_SetString(PyExc_ValueError,
2753 "Empty module name");
2754 return NULL;
2755 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002756
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002757 p = buf + *p_buflen;
2758 if (p != buf)
2759 *p++ = '.';
2760 if (p+len-buf >= MAXPATHLEN) {
2761 PyErr_SetString(PyExc_ValueError,
2762 "Module name too long");
2763 return NULL;
2764 }
2765 strncpy(p, name, len);
2766 p[len] = '\0';
2767 *p_buflen = p+len-buf;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002768
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002769 result = import_submodule(mod, p, buf);
2770 if (result == Py_None && altmod != mod) {
2771 Py_DECREF(result);
2772 /* Here, altmod must be None and mod must not be None */
2773 result = import_submodule(altmod, p, p);
2774 if (result != NULL && result != Py_None) {
2775 if (mark_miss(buf) != 0) {
2776 Py_DECREF(result);
2777 return NULL;
2778 }
2779 strncpy(buf, name, len);
2780 buf[len] = '\0';
2781 *p_buflen = len;
2782 }
2783 }
2784 if (result == NULL)
2785 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002786
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002787 if (result == Py_None) {
2788 Py_DECREF(result);
2789 PyErr_Format(PyExc_ImportError,
2790 "No module named %.200s", name);
2791 return NULL;
2792 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002793
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002794 return result;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002795}
2796
2797static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002798mark_miss(char *name)
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00002799{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002800 PyObject *modules = PyImport_GetModuleDict();
2801 return PyDict_SetItemString(modules, name, Py_None);
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00002802}
2803
2804static int
Martin v. Löwis18e16552006-02-15 17:27:45 +00002805ensure_fromlist(PyObject *mod, PyObject *fromlist, char *buf, Py_ssize_t buflen,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002806 int recursive)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002807{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002808 int i;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002809
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002810 if (!PyObject_HasAttrString(mod, "__path__"))
2811 return 1;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002812
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002813 for (i = 0; ; i++) {
2814 PyObject *item = PySequence_GetItem(fromlist, i);
2815 int hasit;
2816 if (item == NULL) {
2817 if (PyErr_ExceptionMatches(PyExc_IndexError)) {
2818 PyErr_Clear();
2819 return 1;
2820 }
2821 return 0;
2822 }
2823 if (!PyUnicode_Check(item)) {
2824 PyErr_SetString(PyExc_TypeError,
2825 "Item in ``from list'' not a string");
2826 Py_DECREF(item);
2827 return 0;
2828 }
2829 if (PyUnicode_AS_UNICODE(item)[0] == '*') {
2830 PyObject *all;
2831 Py_DECREF(item);
2832 /* See if the package defines __all__ */
2833 if (recursive)
2834 continue; /* Avoid endless recursion */
2835 all = PyObject_GetAttrString(mod, "__all__");
2836 if (all == NULL)
2837 PyErr_Clear();
2838 else {
2839 int ret = ensure_fromlist(mod, all, buf, buflen, 1);
2840 Py_DECREF(all);
2841 if (!ret)
2842 return 0;
2843 }
2844 continue;
2845 }
2846 hasit = PyObject_HasAttr(mod, item);
2847 if (!hasit) {
2848 PyObject *item8;
2849 char *subname;
2850 PyObject *submod;
2851 char *p;
Victor Stinnerae6265f2010-05-15 16:27:27 +00002852 item8 = PyUnicode_EncodeFSDefault(item);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002853 if (!item8) {
2854 PyErr_SetString(PyExc_ValueError, "Cannot encode path item");
2855 return 0;
2856 }
2857 subname = PyBytes_AS_STRING(item8);
2858 if (buflen + strlen(subname) >= MAXPATHLEN) {
2859 PyErr_SetString(PyExc_ValueError,
2860 "Module name too long");
2861 Py_DECREF(item);
2862 return 0;
2863 }
2864 p = buf + buflen;
2865 *p++ = '.';
2866 strcpy(p, subname);
2867 submod = import_submodule(mod, subname, buf);
2868 Py_DECREF(item8);
2869 Py_XDECREF(submod);
2870 if (submod == NULL) {
2871 Py_DECREF(item);
2872 return 0;
2873 }
2874 }
2875 Py_DECREF(item);
2876 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002877
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002878 /* NOTREACHED */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002879}
2880
Neil Schemenauer00b09662003-06-16 21:03:07 +00002881static int
2882add_submodule(PyObject *mod, PyObject *submod, char *fullname, char *subname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002883 PyObject *modules)
Neil Schemenauer00b09662003-06-16 21:03:07 +00002884{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002885 if (mod == Py_None)
2886 return 1;
2887 /* Irrespective of the success of this load, make a
2888 reference to it in the parent package module. A copy gets
2889 saved in the modules dictionary under the full name, so get a
2890 reference from there, if need be. (The exception is when the
2891 load failed with a SyntaxError -- then there's no trace in
2892 sys.modules. In that case, of course, do nothing extra.) */
2893 if (submod == NULL) {
2894 submod = PyDict_GetItemString(modules, fullname);
2895 if (submod == NULL)
2896 return 1;
2897 }
2898 if (PyModule_Check(mod)) {
2899 /* We can't use setattr here since it can give a
2900 * spurious warning if the submodule name shadows a
2901 * builtin name */
2902 PyObject *dict = PyModule_GetDict(mod);
2903 if (!dict)
2904 return 0;
2905 if (PyDict_SetItemString(dict, subname, submod) < 0)
2906 return 0;
2907 }
2908 else {
2909 if (PyObject_SetAttrString(mod, subname, submod) < 0)
2910 return 0;
2911 }
2912 return 1;
Neil Schemenauer00b09662003-06-16 21:03:07 +00002913}
2914
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002915static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002916import_submodule(PyObject *mod, char *subname, char *fullname)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002917{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002918 PyObject *modules = PyImport_GetModuleDict();
2919 PyObject *m = NULL;
Guido van Rossum74e6a111994-08-29 12:54:38 +00002920
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002921 /* Require:
2922 if mod == None: subname == fullname
2923 else: mod.__name__ + "." + subname == fullname
2924 */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002925
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002926 if ((m = PyDict_GetItemString(modules, fullname)) != NULL) {
2927 Py_INCREF(m);
2928 }
2929 else {
2930 PyObject *path, *loader = NULL;
Gregory P. Smithc809f982012-03-18 16:06:53 -07002931 char *buf;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002932 struct filedescr *fdp;
2933 FILE *fp = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002934
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002935 if (mod == Py_None)
2936 path = NULL;
2937 else {
2938 path = PyObject_GetAttrString(mod, "__path__");
2939 if (path == NULL) {
2940 PyErr_Clear();
2941 Py_INCREF(Py_None);
2942 return Py_None;
2943 }
2944 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002945
Gregory P. Smithc809f982012-03-18 16:06:53 -07002946 buf = PyMem_MALLOC(MAXPATHLEN+1);
2947 if (buf == NULL) {
2948 return PyErr_NoMemory();
2949 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002950 buf[0] = '\0';
2951 fdp = find_module(fullname, subname, path, buf, MAXPATHLEN+1,
2952 &fp, &loader);
2953 Py_XDECREF(path);
2954 if (fdp == NULL) {
Gregory P. Smithc809f982012-03-18 16:06:53 -07002955 PyMem_FREE(buf);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002956 if (!PyErr_ExceptionMatches(PyExc_ImportError))
2957 return NULL;
2958 PyErr_Clear();
2959 Py_INCREF(Py_None);
2960 return Py_None;
2961 }
2962 m = load_module(fullname, fp, buf, fdp->type, loader);
2963 Py_XDECREF(loader);
2964 if (fp)
2965 fclose(fp);
2966 if (!add_submodule(mod, m, fullname, subname, modules)) {
2967 Py_XDECREF(m);
2968 m = NULL;
2969 }
Gregory P. Smithc809f982012-03-18 16:06:53 -07002970 PyMem_FREE(buf);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002971 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002972
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002973 return m;
Guido van Rossum74e6a111994-08-29 12:54:38 +00002974}
2975
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002976
2977/* Re-import a module of any kind and return its module object, WITH
2978 INCREMENTED REFERENCE COUNT */
2979
Guido van Rossum79f25d91997-04-29 20:08:16 +00002980PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002981PyImport_ReloadModule(PyObject *m)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002982{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002983 PyInterpreterState *interp = PyThreadState_Get()->interp;
2984 PyObject *modules_reloading = interp->modules_reloading;
2985 PyObject *modules = PyImport_GetModuleDict();
2986 PyObject *path = NULL, *loader = NULL, *existing_m = NULL;
2987 char *name, *subname;
Gregory P. Smithc809f982012-03-18 16:06:53 -07002988 char *buf;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002989 struct filedescr *fdp;
2990 FILE *fp = NULL;
2991 PyObject *newm;
Brett Cannon9a5b25a2010-03-01 02:09:17 +00002992
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002993 if (modules_reloading == NULL) {
2994 Py_FatalError("PyImport_ReloadModule: "
2995 "no modules_reloading dictionary!");
2996 return NULL;
2997 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002998
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002999 if (m == NULL || !PyModule_Check(m)) {
3000 PyErr_SetString(PyExc_TypeError,
3001 "reload() argument must be module");
3002 return NULL;
3003 }
3004 name = (char*)PyModule_GetName(m);
3005 if (name == NULL)
3006 return NULL;
3007 if (m != PyDict_GetItemString(modules, name)) {
3008 PyErr_Format(PyExc_ImportError,
3009 "reload(): module %.200s not in sys.modules",
3010 name);
3011 return NULL;
3012 }
3013 existing_m = PyDict_GetItemString(modules_reloading, name);
3014 if (existing_m != NULL) {
3015 /* Due to a recursive reload, this module is already
3016 being reloaded. */
3017 Py_INCREF(existing_m);
3018 return existing_m;
3019 }
3020 if (PyDict_SetItemString(modules_reloading, name, m) < 0)
3021 return NULL;
Guido van Rossumd8faa362007-04-27 19:54:29 +00003022
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003023 subname = strrchr(name, '.');
3024 if (subname == NULL)
3025 subname = name;
3026 else {
3027 PyObject *parentname, *parent;
3028 parentname = PyUnicode_FromStringAndSize(name, (subname-name));
3029 if (parentname == NULL) {
3030 imp_modules_reloading_clear();
3031 return NULL;
3032 }
3033 parent = PyDict_GetItem(modules, parentname);
3034 if (parent == NULL) {
3035 PyErr_Format(PyExc_ImportError,
3036 "reload(): parent %U not in sys.modules",
3037 parentname);
3038 Py_DECREF(parentname);
3039 imp_modules_reloading_clear();
3040 return NULL;
3041 }
3042 Py_DECREF(parentname);
3043 subname++;
3044 path = PyObject_GetAttrString(parent, "__path__");
3045 if (path == NULL)
3046 PyErr_Clear();
3047 }
Gregory P. Smithc809f982012-03-18 16:06:53 -07003048 buf = PyMem_MALLOC(MAXPATHLEN+1);
3049 if (buf == NULL) {
3050 Py_XDECREF(path);
3051 return PyErr_NoMemory();
3052 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003053 buf[0] = '\0';
3054 fdp = find_module(name, subname, path, buf, MAXPATHLEN+1, &fp, &loader);
3055 Py_XDECREF(path);
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00003056
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003057 if (fdp == NULL) {
3058 Py_XDECREF(loader);
3059 imp_modules_reloading_clear();
Gregory P. Smithc809f982012-03-18 16:06:53 -07003060 PyMem_FREE(buf);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003061 return NULL;
3062 }
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00003063
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003064 newm = load_module(name, fp, buf, fdp->type, loader);
3065 Py_XDECREF(loader);
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00003066
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003067 if (fp)
3068 fclose(fp);
3069 if (newm == NULL) {
3070 /* load_module probably removed name from modules because of
3071 * the error. Put back the original module object. We're
3072 * going to return NULL in this case regardless of whether
3073 * replacing name succeeds, so the return value is ignored.
3074 */
3075 PyDict_SetItemString(modules, name, m);
3076 }
3077 imp_modules_reloading_clear();
Gregory P. Smithc809f982012-03-18 16:06:53 -07003078 PyMem_FREE(buf);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003079 return newm;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003080}
3081
3082
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003083/* Higher-level import emulator which emulates the "import" statement
3084 more accurately -- it invokes the __import__() function from the
3085 builtins of the current globals. This means that the import is
3086 done using whatever import hooks are installed in the current
Brett Cannonbc2eff32010-09-19 21:39:02 +00003087 environment.
Guido van Rossum6058eb41998-12-21 19:51:00 +00003088 A dummy list ["__doc__"] is passed as the 4th argument so that
Neal Norwitz80e7f272007-08-26 06:45:23 +00003089 e.g. PyImport_Import(PyUnicode_FromString("win32com.client.gencache"))
Guido van Rossum6058eb41998-12-21 19:51:00 +00003090 will return <module "gencache"> instead of <module "win32com">. */
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003091
3092PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003093PyImport_Import(PyObject *module_name)
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003094{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003095 static PyObject *silly_list = NULL;
3096 static PyObject *builtins_str = NULL;
3097 static PyObject *import_str = NULL;
3098 PyObject *globals = NULL;
3099 PyObject *import = NULL;
3100 PyObject *builtins = NULL;
Brett Cannonbc2eff32010-09-19 21:39:02 +00003101 PyObject *modules = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003102 PyObject *r = NULL;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003103
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003104 /* Initialize constant string objects */
3105 if (silly_list == NULL) {
3106 import_str = PyUnicode_InternFromString("__import__");
3107 if (import_str == NULL)
3108 return NULL;
3109 builtins_str = PyUnicode_InternFromString("__builtins__");
3110 if (builtins_str == NULL)
3111 return NULL;
Brett Cannonbc2eff32010-09-19 21:39:02 +00003112 silly_list = PyList_New(0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003113 if (silly_list == NULL)
3114 return NULL;
3115 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003116
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003117 /* Get the builtins from current globals */
3118 globals = PyEval_GetGlobals();
3119 if (globals != NULL) {
3120 Py_INCREF(globals);
3121 builtins = PyObject_GetItem(globals, builtins_str);
3122 if (builtins == NULL)
3123 goto err;
3124 }
3125 else {
3126 /* No globals -- use standard builtins, and fake globals */
3127 builtins = PyImport_ImportModuleLevel("builtins",
3128 NULL, NULL, NULL, 0);
3129 if (builtins == NULL)
3130 return NULL;
3131 globals = Py_BuildValue("{OO}", builtins_str, builtins);
3132 if (globals == NULL)
3133 goto err;
3134 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003135
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003136 /* Get the __import__ function from the builtins */
3137 if (PyDict_Check(builtins)) {
3138 import = PyObject_GetItem(builtins, import_str);
3139 if (import == NULL)
3140 PyErr_SetObject(PyExc_KeyError, import_str);
3141 }
3142 else
3143 import = PyObject_GetAttr(builtins, import_str);
3144 if (import == NULL)
3145 goto err;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003146
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003147 /* Call the __import__ function with the proper argument list
Brett Cannonbc2eff32010-09-19 21:39:02 +00003148 Always use absolute import here.
3149 Calling for side-effect of import. */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003150 r = PyObject_CallFunction(import, "OOOOi", module_name, globals,
3151 globals, silly_list, 0, NULL);
Brett Cannonbc2eff32010-09-19 21:39:02 +00003152 if (r == NULL)
3153 goto err;
3154 Py_DECREF(r);
3155
3156 modules = PyImport_GetModuleDict();
3157 r = PyDict_GetItem(modules, module_name);
3158 if (r != NULL)
3159 Py_INCREF(r);
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003160
3161 err:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003162 Py_XDECREF(globals);
3163 Py_XDECREF(builtins);
3164 Py_XDECREF(import);
Tim Peters50d8d372001-02-28 05:34:27 +00003165
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003166 return r;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003167}
3168
3169
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003170/* Module 'imp' provides Python access to the primitives used for
3171 importing modules.
3172*/
3173
Guido van Rossum79f25d91997-04-29 20:08:16 +00003174static PyObject *
Barry Warsaw28a691b2010-04-17 00:19:56 +00003175imp_make_magic(long magic)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003176{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003177 char buf[4];
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003178
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003179 buf[0] = (char) ((magic >> 0) & 0xff);
3180 buf[1] = (char) ((magic >> 8) & 0xff);
3181 buf[2] = (char) ((magic >> 16) & 0xff);
3182 buf[3] = (char) ((magic >> 24) & 0xff);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003183
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003184 return PyBytes_FromStringAndSize(buf, 4);
Victor Stinner3e2b7172010-11-09 09:32:19 +00003185}
Barry Warsaw28a691b2010-04-17 00:19:56 +00003186
3187static PyObject *
3188imp_get_magic(PyObject *self, PyObject *noargs)
3189{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003190 return imp_make_magic(pyc_magic);
Barry Warsaw28a691b2010-04-17 00:19:56 +00003191}
3192
3193static PyObject *
3194imp_get_tag(PyObject *self, PyObject *noargs)
3195{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003196 return PyUnicode_FromString(pyc_tag);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003197}
3198
Guido van Rossum79f25d91997-04-29 20:08:16 +00003199static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +00003200imp_get_suffixes(PyObject *self, PyObject *noargs)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003201{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003202 PyObject *list;
3203 struct filedescr *fdp;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003204
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003205 list = PyList_New(0);
3206 if (list == NULL)
3207 return NULL;
3208 for (fdp = _PyImport_Filetab; fdp->suffix != NULL; fdp++) {
3209 PyObject *item = Py_BuildValue("ssi",
3210 fdp->suffix, fdp->mode, fdp->type);
3211 if (item == NULL) {
3212 Py_DECREF(list);
3213 return NULL;
3214 }
3215 if (PyList_Append(list, item) < 0) {
3216 Py_DECREF(list);
3217 Py_DECREF(item);
3218 return NULL;
3219 }
3220 Py_DECREF(item);
3221 }
3222 return list;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003223}
3224
Guido van Rossum79f25d91997-04-29 20:08:16 +00003225static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003226call_find_module(char *name, PyObject *path)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003227{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003228 extern int fclose(FILE *);
3229 PyObject *fob, *ret;
3230 PyObject *pathobj;
3231 struct filedescr *fdp;
Gregory P. Smithc809f982012-03-18 16:06:53 -07003232 char *pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003233 FILE *fp = NULL;
3234 int fd = -1;
3235 char *found_encoding = NULL;
3236 char *encoding = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003237
Gregory P. Smithc809f982012-03-18 16:06:53 -07003238 pathname = PyMem_MALLOC(MAXPATHLEN+1);
3239 if (pathname == NULL) {
3240 return PyErr_NoMemory();
3241 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003242 pathname[0] = '\0';
3243 if (path == Py_None)
3244 path = NULL;
3245 fdp = find_module(NULL, name, path, pathname, MAXPATHLEN+1, &fp, NULL);
3246 if (fdp == NULL)
Gregory P. Smithc809f982012-03-18 16:06:53 -07003247 goto error_exit;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003248 if (fp != NULL) {
3249 fd = fileno(fp);
3250 if (fd != -1)
3251 fd = dup(fd);
3252 fclose(fp);
3253 fp = NULL;
Gregory P. Smithc809f982012-03-18 16:06:53 -07003254 if (fd == -1) {
3255 PyErr_SetFromErrno(PyExc_OSError);
3256 goto error_exit;
3257 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003258 }
3259 if (fd != -1) {
3260 if (strchr(fdp->mode, 'b') == NULL) {
3261 /* PyTokenizer_FindEncoding() returns PyMem_MALLOC'ed
3262 memory. */
3263 found_encoding = PyTokenizer_FindEncoding(fd);
3264 lseek(fd, 0, 0); /* Reset position */
Antoine Pitrou4f22a8d2012-02-22 18:05:43 +01003265 if (found_encoding == NULL && PyErr_Occurred()) {
3266 close(fd);
Gregory P. Smithc809f982012-03-18 16:06:53 -07003267 goto error_exit;
Antoine Pitrou4f22a8d2012-02-22 18:05:43 +01003268 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003269 encoding = (found_encoding != NULL) ? found_encoding :
3270 (char*)PyUnicode_GetDefaultEncoding();
3271 }
3272 fob = PyFile_FromFd(fd, pathname, fdp->mode, -1,
3273 (char*)encoding, NULL, NULL, 1);
3274 if (fob == NULL) {
3275 close(fd);
3276 PyMem_FREE(found_encoding);
Gregory P. Smithc809f982012-03-18 16:06:53 -07003277 goto error_exit;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003278 }
3279 }
3280 else {
3281 fob = Py_None;
3282 Py_INCREF(fob);
3283 }
3284 pathobj = PyUnicode_DecodeFSDefault(pathname);
3285 ret = Py_BuildValue("NN(ssi)",
3286 fob, pathobj, fdp->suffix, fdp->mode, fdp->type);
3287 PyMem_FREE(found_encoding);
Gregory P. Smithc809f982012-03-18 16:06:53 -07003288 PyMem_FREE(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003289 return ret;
Gregory P. Smithc809f982012-03-18 16:06:53 -07003290
3291error_exit:
3292 PyMem_FREE(pathname);
3293 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003294}
3295
Guido van Rossum79f25d91997-04-29 20:08:16 +00003296static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003297imp_find_module(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003298{
Victor Stinnerebc00522010-12-03 17:06:43 +00003299 PyObject *name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003300 PyObject *ret, *path = NULL;
Victor Stinnerebc00522010-12-03 17:06:43 +00003301 if (!PyArg_ParseTuple(args, "O&|O:find_module",
3302 PyUnicode_FSConverter, &name,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003303 &path))
3304 return NULL;
Victor Stinnerebc00522010-12-03 17:06:43 +00003305 ret = call_find_module(PyBytes_AS_STRING(name), path);
3306 Py_DECREF(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003307 return ret;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003308}
3309
3310static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003311imp_init_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003312{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003313 char *name;
3314 int ret;
3315 PyObject *m;
3316 if (!PyArg_ParseTuple(args, "s:init_builtin", &name))
3317 return NULL;
3318 ret = init_builtin(name);
3319 if (ret < 0)
3320 return NULL;
3321 if (ret == 0) {
3322 Py_INCREF(Py_None);
3323 return Py_None;
3324 }
3325 m = PyImport_AddModule(name);
3326 Py_XINCREF(m);
3327 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003328}
3329
Guido van Rossum79f25d91997-04-29 20:08:16 +00003330static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003331imp_init_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003332{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003333 char *name;
3334 int ret;
3335 PyObject *m;
3336 if (!PyArg_ParseTuple(args, "s:init_frozen", &name))
3337 return NULL;
3338 ret = PyImport_ImportFrozenModule(name);
3339 if (ret < 0)
3340 return NULL;
3341 if (ret == 0) {
3342 Py_INCREF(Py_None);
3343 return Py_None;
3344 }
3345 m = PyImport_AddModule(name);
3346 Py_XINCREF(m);
3347 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003348}
3349
Guido van Rossum79f25d91997-04-29 20:08:16 +00003350static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003351imp_get_frozen_object(PyObject *self, PyObject *args)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00003352{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003353 char *name;
Jack Jansen95ffa231995-10-03 14:38:41 +00003354
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003355 if (!PyArg_ParseTuple(args, "s:get_frozen_object", &name))
3356 return NULL;
3357 return get_frozen_object(name);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00003358}
3359
Guido van Rossum79f25d91997-04-29 20:08:16 +00003360static PyObject *
Brett Cannon8d110132009-03-15 02:20:16 +00003361imp_is_frozen_package(PyObject *self, PyObject *args)
3362{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003363 char *name;
Brett Cannon8d110132009-03-15 02:20:16 +00003364
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003365 if (!PyArg_ParseTuple(args, "s:is_frozen_package", &name))
3366 return NULL;
3367 return is_frozen_package(name);
Brett Cannon8d110132009-03-15 02:20:16 +00003368}
3369
3370static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003371imp_is_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003372{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003373 char *name;
3374 if (!PyArg_ParseTuple(args, "s:is_builtin", &name))
3375 return NULL;
3376 return PyLong_FromLong(is_builtin(name));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003377}
3378
Guido van Rossum79f25d91997-04-29 20:08:16 +00003379static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003380imp_is_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003381{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003382 char *name;
3383 struct _frozen *p;
3384 if (!PyArg_ParseTuple(args, "s:is_frozen", &name))
3385 return NULL;
3386 p = find_frozen(name);
3387 return PyBool_FromLong((long) (p == NULL ? 0 : p->size));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003388}
3389
3390static FILE *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003391get_file(char *pathname, PyObject *fob, char *mode)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003392{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003393 FILE *fp;
3394 if (mode[0] == 'U')
3395 mode = "r" PY_STDIOTEXTMODE;
3396 if (fob == NULL) {
3397 fp = fopen(pathname, mode);
3398 }
3399 else {
3400 int fd = PyObject_AsFileDescriptor(fob);
3401 if (fd == -1)
3402 return NULL;
3403 if (!_PyVerify_fd(fd))
3404 goto error;
3405 /* the FILE struct gets a new fd, so that it can be closed
3406 * independently of the file descriptor given
3407 */
3408 fd = dup(fd);
3409 if (fd == -1)
3410 goto error;
3411 fp = fdopen(fd, mode);
3412 }
3413 if (fp)
3414 return fp;
Kristján Valur Jónssone1b04452009-03-31 17:43:39 +00003415error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003416 PyErr_SetFromErrno(PyExc_IOError);
3417 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003418}
3419
Guido van Rossum79f25d91997-04-29 20:08:16 +00003420static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003421imp_load_compiled(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003422{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003423 char *name;
Victor Stinnerebc00522010-12-03 17:06:43 +00003424 PyObject *pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003425 PyObject *fob = NULL;
3426 PyObject *m;
3427 FILE *fp;
Victor Stinnerebc00522010-12-03 17:06:43 +00003428 if (!PyArg_ParseTuple(args, "sO&|O:load_compiled",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003429 &name,
Victor Stinnerebc00522010-12-03 17:06:43 +00003430 PyUnicode_FSConverter, &pathname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003431 &fob))
3432 return NULL;
Victor Stinnerebc00522010-12-03 17:06:43 +00003433 fp = get_file(PyBytes_AS_STRING(pathname), fob, "rb");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003434 if (fp == NULL) {
Victor Stinnerebc00522010-12-03 17:06:43 +00003435 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003436 return NULL;
3437 }
Victor Stinnerebc00522010-12-03 17:06:43 +00003438 m = load_compiled_module(name, PyBytes_AS_STRING(pathname), fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003439 fclose(fp);
Victor Stinnerebc00522010-12-03 17:06:43 +00003440 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003441 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003442}
3443
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003444#ifdef HAVE_DYNAMIC_LOADING
3445
Guido van Rossum79f25d91997-04-29 20:08:16 +00003446static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003447imp_load_dynamic(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003448{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003449 char *name;
Victor Stinner8dbf6292010-10-15 12:48:01 +00003450 PyObject *pathbytes;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003451 char *pathname;
3452 PyObject *fob = NULL;
3453 PyObject *m;
3454 FILE *fp = NULL;
Victor Stinner8dbf6292010-10-15 12:48:01 +00003455 if (!PyArg_ParseTuple(args, "sO&|O:load_dynamic",
3456 &name, PyUnicode_FSConverter, &pathbytes, &fob))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003457 return NULL;
Victor Stinner8dbf6292010-10-15 12:48:01 +00003458 pathname = PyBytes_AS_STRING(pathbytes);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003459 if (fob) {
3460 fp = get_file(pathname, fob, "r");
3461 if (fp == NULL) {
Victor Stinner8dbf6292010-10-15 12:48:01 +00003462 Py_DECREF(pathbytes);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003463 return NULL;
3464 }
3465 }
3466 m = _PyImport_LoadDynamicModule(name, pathname, fp);
Victor Stinner8dbf6292010-10-15 12:48:01 +00003467 Py_DECREF(pathbytes);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003468 if (fp)
3469 fclose(fp);
3470 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003471}
3472
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003473#endif /* HAVE_DYNAMIC_LOADING */
3474
Guido van Rossum79f25d91997-04-29 20:08:16 +00003475static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003476imp_load_source(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003477{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003478 char *name;
Victor Stinnerebc00522010-12-03 17:06:43 +00003479 PyObject *pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003480 PyObject *fob = NULL;
3481 PyObject *m;
3482 FILE *fp;
Victor Stinnerebc00522010-12-03 17:06:43 +00003483 if (!PyArg_ParseTuple(args, "sO&|O:load_source",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003484 &name,
Victor Stinnerebc00522010-12-03 17:06:43 +00003485 PyUnicode_FSConverter, &pathname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003486 &fob))
3487 return NULL;
Victor Stinnerebc00522010-12-03 17:06:43 +00003488 fp = get_file(PyBytes_AS_STRING(pathname), fob, "r");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003489 if (fp == NULL) {
Victor Stinnerebc00522010-12-03 17:06:43 +00003490 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003491 return NULL;
3492 }
Victor Stinnerebc00522010-12-03 17:06:43 +00003493 m = load_source_module(name, PyBytes_AS_STRING(pathname), fp);
3494 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003495 fclose(fp);
3496 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003497}
3498
Guido van Rossum79f25d91997-04-29 20:08:16 +00003499static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003500imp_load_module(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003501{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003502 char *name;
3503 PyObject *fob;
Victor Stinner1a563032010-10-15 22:43:10 +00003504 PyObject *pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003505 PyObject * ret;
3506 char *suffix; /* Unused */
3507 char *mode;
3508 int type;
3509 FILE *fp;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003510
Victor Stinner1a563032010-10-15 22:43:10 +00003511 if (!PyArg_ParseTuple(args, "sOO&(ssi):load_module",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003512 &name, &fob,
Victor Stinner1a563032010-10-15 22:43:10 +00003513 PyUnicode_FSConverter, &pathname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003514 &suffix, &mode, &type))
3515 return NULL;
3516 if (*mode) {
3517 /* Mode must start with 'r' or 'U' and must not contain '+'.
3518 Implicit in this test is the assumption that the mode
3519 may contain other modifiers like 'b' or 't'. */
Guido van Rossum5e2c5fa2002-05-30 17:33:07 +00003520
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003521 if (!(*mode == 'r' || *mode == 'U') || strchr(mode, '+')) {
3522 PyErr_Format(PyExc_ValueError,
3523 "invalid file open mode %.200s", mode);
Victor Stinner1a563032010-10-15 22:43:10 +00003524 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003525 return NULL;
3526 }
3527 }
3528 if (fob == Py_None)
3529 fp = NULL;
3530 else {
3531 fp = get_file(NULL, fob, mode);
3532 if (fp == NULL) {
Victor Stinner1a563032010-10-15 22:43:10 +00003533 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003534 return NULL;
3535 }
3536 }
Victor Stinner1a563032010-10-15 22:43:10 +00003537 ret = load_module(name, fp, PyBytes_AS_STRING(pathname), type, NULL);
3538 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003539 if (fp)
3540 fclose(fp);
3541 return ret;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003542}
3543
3544static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003545imp_load_package(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003546{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003547 char *name;
Victor Stinnerebc00522010-12-03 17:06:43 +00003548 PyObject *pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003549 PyObject * ret;
Victor Stinnerebc00522010-12-03 17:06:43 +00003550 if (!PyArg_ParseTuple(args, "sO&:load_package",
3551 &name, PyUnicode_FSConverter, &pathname))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003552 return NULL;
Victor Stinnerebc00522010-12-03 17:06:43 +00003553 ret = load_package(name, PyBytes_AS_STRING(pathname));
3554 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003555 return ret;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003556}
3557
3558static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003559imp_new_module(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003560{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003561 char *name;
3562 if (!PyArg_ParseTuple(args, "s:new_module", &name))
3563 return NULL;
3564 return PyModule_New(name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003565}
3566
Christian Heimes13a7a212008-01-07 17:13:09 +00003567static PyObject *
3568imp_reload(PyObject *self, PyObject *v)
3569{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003570 return PyImport_ReloadModule(v);
Christian Heimes13a7a212008-01-07 17:13:09 +00003571}
3572
3573PyDoc_STRVAR(doc_reload,
3574"reload(module) -> module\n\
3575\n\
3576Reload the module. The module must have been successfully imported before.");
3577
Barry Warsaw28a691b2010-04-17 00:19:56 +00003578static PyObject *
3579imp_cache_from_source(PyObject *self, PyObject *args, PyObject *kws)
3580{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003581 static char *kwlist[] = {"path", "debug_override", NULL};
Barry Warsaw28a691b2010-04-17 00:19:56 +00003582
Gregory P. Smithc809f982012-03-18 16:06:53 -07003583 char *buf;
Victor Stinner3ea23dd2010-10-15 20:34:32 +00003584 PyObject *pathbytes;
3585 char *cpathname;
Benjamin Peterson294a9fc2010-10-16 03:12:39 +00003586 PyObject *debug_override = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003587 int debug = !Py_OptimizeFlag;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003588
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003589 if (!PyArg_ParseTupleAndKeywords(
Victor Stinner3ea23dd2010-10-15 20:34:32 +00003590 args, kws, "O&|O", kwlist,
3591 PyUnicode_FSConverter, &pathbytes, &debug_override))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003592 return NULL;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003593
Benjamin Peterson294a9fc2010-10-16 03:12:39 +00003594 if (debug_override != NULL &&
3595 (debug = PyObject_IsTrue(debug_override)) < 0) {
3596 Py_DECREF(pathbytes);
3597 return NULL;
3598 }
Barry Warsaw28a691b2010-04-17 00:19:56 +00003599
Gregory P. Smithc809f982012-03-18 16:06:53 -07003600 buf = PyMem_MALLOC(MAXPATHLEN+1);
3601 if (buf == NULL) {
3602 return PyErr_NoMemory();
3603 }
Victor Stinner3ea23dd2010-10-15 20:34:32 +00003604 cpathname = make_compiled_pathname(
3605 PyBytes_AS_STRING(pathbytes),
3606 buf, MAXPATHLEN+1, debug);
3607 Py_DECREF(pathbytes);
Barry Warsaw28a691b2010-04-17 00:19:56 +00003608
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003609 if (cpathname == NULL) {
3610 PyErr_Format(PyExc_SystemError, "path buffer too short");
Gregory P. Smithc809f982012-03-18 16:06:53 -07003611 PyMem_FREE(buf);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003612 return NULL;
3613 }
Gregory P. Smithc809f982012-03-18 16:06:53 -07003614 {
3615 PyObject *ret = PyUnicode_DecodeFSDefault(buf);
3616 PyMem_FREE(buf);
3617 return ret;
3618 }
Barry Warsaw28a691b2010-04-17 00:19:56 +00003619}
3620
3621PyDoc_STRVAR(doc_cache_from_source,
Éric Araujo5df11082011-11-03 03:38:44 +01003622"cache_from_source(path, [debug_override]) -> path\n\
3623Given the path to a .py file, return the path to its .pyc/.pyo file.\n\
Barry Warsaw28a691b2010-04-17 00:19:56 +00003624\n\
3625The .py file does not need to exist; this simply returns the path to the\n\
3626.pyc/.pyo file calculated as if the .py file were imported. The extension\n\
3627will be .pyc unless __debug__ is not defined, then it will be .pyo.\n\
3628\n\
3629If debug_override is not None, then it must be a boolean and is taken as\n\
3630the value of __debug__ instead.");
3631
3632static PyObject *
3633imp_source_from_cache(PyObject *self, PyObject *args, PyObject *kws)
3634{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003635 static char *kwlist[] = {"path", NULL};
Barry Warsaw28a691b2010-04-17 00:19:56 +00003636
Victor Stinnerebc00522010-12-03 17:06:43 +00003637 PyObject *pathname_obj;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003638 char *pathname;
Gregory P. Smithc809f982012-03-18 16:06:53 -07003639 char *buf;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003640
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003641 if (!PyArg_ParseTupleAndKeywords(
Victor Stinnerebc00522010-12-03 17:06:43 +00003642 args, kws, "O&", kwlist,
3643 PyUnicode_FSConverter, &pathname_obj))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003644 return NULL;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003645
Victor Stinnerebc00522010-12-03 17:06:43 +00003646 pathname = PyBytes_AS_STRING(pathname_obj);
Gregory P. Smithc809f982012-03-18 16:06:53 -07003647 buf = PyMem_MALLOC(MAXPATHLEN+1);
3648 if (buf == NULL) {
3649 return PyErr_NoMemory();
3650 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003651 if (make_source_pathname(pathname, buf) == NULL) {
3652 PyErr_Format(PyExc_ValueError, "Not a PEP 3147 pyc path: %s",
3653 pathname);
Victor Stinnerebc00522010-12-03 17:06:43 +00003654 Py_DECREF(pathname_obj);
Gregory P. Smithc809f982012-03-18 16:06:53 -07003655 PyMem_FREE(buf);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003656 return NULL;
3657 }
Victor Stinnerebc00522010-12-03 17:06:43 +00003658 Py_DECREF(pathname_obj);
Gregory P. Smithc809f982012-03-18 16:06:53 -07003659 {
3660 PyObject *ret = PyUnicode_FromString(buf);
3661 PyMem_FREE(buf);
3662 return ret;
3663 }
Barry Warsaw28a691b2010-04-17 00:19:56 +00003664}
3665
3666PyDoc_STRVAR(doc_source_from_cache,
Éric Araujo5df11082011-11-03 03:38:44 +01003667"source_from_cache(path) -> path\n\
3668Given the path to a .pyc./.pyo file, return the path to its .py file.\n\
Barry Warsaw28a691b2010-04-17 00:19:56 +00003669\n\
3670The .pyc/.pyo file does not need to exist; this simply returns the path to\n\
3671the .py file calculated to correspond to the .pyc/.pyo file. If path\n\
3672does not conform to PEP 3147 format, ValueError will be raised.");
3673
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003674/* Doc strings */
3675
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003676PyDoc_STRVAR(doc_imp,
3677"This module provides the components needed to build your own\n\
3678__import__ function. Undocumented functions are obsolete.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003679
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003680PyDoc_STRVAR(doc_find_module,
3681"find_module(name, [path]) -> (file, filename, (suffix, mode, type))\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003682Search for a module. If path is omitted or None, search for a\n\
3683built-in, frozen or special module and continue search in sys.path.\n\
3684The module name cannot contain '.'; to search for a submodule of a\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003685package, pass the submodule name and the package's __path__.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003686
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003687PyDoc_STRVAR(doc_load_module,
3688"load_module(name, file, filename, (suffix, mode, type)) -> module\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003689Load a module, given information returned by find_module().\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003690The module name must include the full package name, if any.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003691
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003692PyDoc_STRVAR(doc_get_magic,
3693"get_magic() -> string\n\
3694Return the magic number for .pyc or .pyo files.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003695
Barry Warsaw28a691b2010-04-17 00:19:56 +00003696PyDoc_STRVAR(doc_get_tag,
3697"get_tag() -> string\n\
3698Return the magic tag for .pyc or .pyo files.");
3699
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003700PyDoc_STRVAR(doc_get_suffixes,
3701"get_suffixes() -> [(suffix, mode, type), ...]\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003702Return a list of (suffix, mode, type) tuples describing the files\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003703that find_module() looks for.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003704
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003705PyDoc_STRVAR(doc_new_module,
3706"new_module(name) -> module\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003707Create a new module. Do not enter it in sys.modules.\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003708The module name must include the full package name, if any.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003709
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003710PyDoc_STRVAR(doc_lock_held,
Tim Petersa7c65092004-08-01 23:26:05 +00003711"lock_held() -> boolean\n\
3712Return True if the import lock is currently held, else False.\n\
3713On platforms without threads, return False.");
Tim Peters69232342001-08-30 05:16:13 +00003714
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00003715PyDoc_STRVAR(doc_acquire_lock,
3716"acquire_lock() -> None\n\
Neal Norwitz2294c0d2003-02-12 23:02:21 +00003717Acquires the interpreter's import lock for the current thread.\n\
3718This lock should be used by import hooks to ensure thread-safety\n\
3719when importing modules.\n\
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00003720On platforms without threads, this function does nothing.");
3721
3722PyDoc_STRVAR(doc_release_lock,
3723"release_lock() -> None\n\
3724Release the interpreter's import lock.\n\
3725On platforms without threads, this function does nothing.");
3726
Guido van Rossum79f25d91997-04-29 20:08:16 +00003727static PyMethodDef imp_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003728 {"find_module", imp_find_module, METH_VARARGS, doc_find_module},
3729 {"get_magic", imp_get_magic, METH_NOARGS, doc_get_magic},
3730 {"get_tag", imp_get_tag, METH_NOARGS, doc_get_tag},
3731 {"get_suffixes", imp_get_suffixes, METH_NOARGS, doc_get_suffixes},
3732 {"load_module", imp_load_module, METH_VARARGS, doc_load_module},
3733 {"new_module", imp_new_module, METH_VARARGS, doc_new_module},
3734 {"lock_held", imp_lock_held, METH_NOARGS, doc_lock_held},
3735 {"acquire_lock", imp_acquire_lock, METH_NOARGS, doc_acquire_lock},
3736 {"release_lock", imp_release_lock, METH_NOARGS, doc_release_lock},
3737 {"reload", imp_reload, METH_O, doc_reload},
3738 {"cache_from_source", (PyCFunction)imp_cache_from_source,
3739 METH_VARARGS | METH_KEYWORDS, doc_cache_from_source},
3740 {"source_from_cache", (PyCFunction)imp_source_from_cache,
3741 METH_VARARGS | METH_KEYWORDS, doc_source_from_cache},
3742 /* The rest are obsolete */
3743 {"get_frozen_object", imp_get_frozen_object, METH_VARARGS},
3744 {"is_frozen_package", imp_is_frozen_package, METH_VARARGS},
3745 {"init_builtin", imp_init_builtin, METH_VARARGS},
3746 {"init_frozen", imp_init_frozen, METH_VARARGS},
3747 {"is_builtin", imp_is_builtin, METH_VARARGS},
3748 {"is_frozen", imp_is_frozen, METH_VARARGS},
3749 {"load_compiled", imp_load_compiled, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003750#ifdef HAVE_DYNAMIC_LOADING
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003751 {"load_dynamic", imp_load_dynamic, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003752#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003753 {"load_package", imp_load_package, METH_VARARGS},
3754 {"load_source", imp_load_source, METH_VARARGS},
3755 {NULL, NULL} /* sentinel */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003756};
3757
Guido van Rossum1a8791e1998-08-04 22:46:29 +00003758static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003759setint(PyObject *d, char *name, int value)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003760{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003761 PyObject *v;
3762 int err;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003763
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003764 v = PyLong_FromLong((long)value);
3765 err = PyDict_SetItemString(d, name, v);
3766 Py_XDECREF(v);
3767 return err;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003768}
3769
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003770typedef struct {
3771 PyObject_HEAD
3772} NullImporter;
3773
3774static int
3775NullImporter_init(NullImporter *self, PyObject *args, PyObject *kwds)
3776{
Victor Stinner1a4d12d2010-08-13 13:07:29 +00003777#ifndef MS_WINDOWS
3778 PyObject *path;
3779 struct stat statbuf;
3780 int rv;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003781
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003782 if (!_PyArg_NoKeywords("NullImporter()", kwds))
3783 return -1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003784
Victor Stinner1a4d12d2010-08-13 13:07:29 +00003785 if (!PyArg_ParseTuple(args, "O&:NullImporter",
3786 PyUnicode_FSConverter, &path))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003787 return -1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003788
Victor Stinner1a4d12d2010-08-13 13:07:29 +00003789 if (PyBytes_GET_SIZE(path) == 0) {
3790 Py_DECREF(path);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003791 PyErr_SetString(PyExc_ImportError, "empty pathname");
3792 return -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003793 }
Victor Stinner1a4d12d2010-08-13 13:07:29 +00003794
3795 rv = stat(PyBytes_AS_STRING(path), &statbuf);
3796 Py_DECREF(path);
3797 if (rv == 0) {
3798 /* it exists */
3799 if (S_ISDIR(statbuf.st_mode)) {
3800 /* it's a directory */
3801 PyErr_SetString(PyExc_ImportError, "existing directory");
3802 return -1;
3803 }
3804 }
3805#else /* MS_WINDOWS */
3806 PyObject *pathobj;
3807 DWORD rv;
Victor Stinner255dfdb2010-09-29 10:28:51 +00003808 wchar_t *path;
Victor Stinner1a4d12d2010-08-13 13:07:29 +00003809
3810 if (!_PyArg_NoKeywords("NullImporter()", kwds))
3811 return -1;
3812
3813 if (!PyArg_ParseTuple(args, "U:NullImporter",
3814 &pathobj))
3815 return -1;
3816
3817 if (PyUnicode_GET_SIZE(pathobj) == 0) {
3818 PyErr_SetString(PyExc_ImportError, "empty pathname");
3819 return -1;
3820 }
3821
Victor Stinnerbeb4135b2010-10-07 01:02:42 +00003822 path = PyUnicode_AsWideCharString(pathobj, NULL);
Victor Stinner255dfdb2010-09-29 10:28:51 +00003823 if (path == NULL)
Victor Stinner1a4d12d2010-08-13 13:07:29 +00003824 return -1;
3825 /* see issue1293 and issue3677:
3826 * stat() on Windows doesn't recognise paths like
3827 * "e:\\shared\\" and "\\\\whiterab-c2znlh\\shared" as dirs.
3828 */
3829 rv = GetFileAttributesW(path);
Victor Stinner255dfdb2010-09-29 10:28:51 +00003830 PyMem_Free(path);
Victor Stinner1a4d12d2010-08-13 13:07:29 +00003831 if (rv != INVALID_FILE_ATTRIBUTES) {
3832 /* it exists */
3833 if (rv & FILE_ATTRIBUTE_DIRECTORY) {
3834 /* it's a directory */
3835 PyErr_SetString(PyExc_ImportError, "existing directory");
3836 return -1;
3837 }
3838 }
3839#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003840 return 0;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003841}
3842
3843static PyObject *
3844NullImporter_find_module(NullImporter *self, PyObject *args)
3845{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003846 Py_RETURN_NONE;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003847}
3848
3849static PyMethodDef NullImporter_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003850 {"find_module", (PyCFunction)NullImporter_find_module, METH_VARARGS,
3851 "Always return None"
3852 },
3853 {NULL} /* Sentinel */
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003854};
3855
3856
Christian Heimes9cd17752007-11-18 19:35:23 +00003857PyTypeObject PyNullImporter_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003858 PyVarObject_HEAD_INIT(NULL, 0)
3859 "imp.NullImporter", /*tp_name*/
3860 sizeof(NullImporter), /*tp_basicsize*/
3861 0, /*tp_itemsize*/
3862 0, /*tp_dealloc*/
3863 0, /*tp_print*/
3864 0, /*tp_getattr*/
3865 0, /*tp_setattr*/
3866 0, /*tp_reserved*/
3867 0, /*tp_repr*/
3868 0, /*tp_as_number*/
3869 0, /*tp_as_sequence*/
3870 0, /*tp_as_mapping*/
3871 0, /*tp_hash */
3872 0, /*tp_call*/
3873 0, /*tp_str*/
3874 0, /*tp_getattro*/
3875 0, /*tp_setattro*/
3876 0, /*tp_as_buffer*/
3877 Py_TPFLAGS_DEFAULT, /*tp_flags*/
3878 "Null importer object", /* tp_doc */
3879 0, /* tp_traverse */
3880 0, /* tp_clear */
3881 0, /* tp_richcompare */
3882 0, /* tp_weaklistoffset */
3883 0, /* tp_iter */
3884 0, /* tp_iternext */
3885 NullImporter_methods, /* tp_methods */
3886 0, /* tp_members */
3887 0, /* tp_getset */
3888 0, /* tp_base */
3889 0, /* tp_dict */
3890 0, /* tp_descr_get */
3891 0, /* tp_descr_set */
3892 0, /* tp_dictoffset */
3893 (initproc)NullImporter_init, /* tp_init */
3894 0, /* tp_alloc */
3895 PyType_GenericNew /* tp_new */
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003896};
3897
Martin v. Löwis1a214512008-06-11 05:26:20 +00003898static struct PyModuleDef impmodule = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003899 PyModuleDef_HEAD_INIT,
3900 "imp",
3901 doc_imp,
3902 0,
3903 imp_methods,
3904 NULL,
3905 NULL,
3906 NULL,
3907 NULL
Martin v. Löwis1a214512008-06-11 05:26:20 +00003908};
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003909
Jason Tishler6bc06ec2003-09-04 11:59:50 +00003910PyMODINIT_FUNC
Martin v. Löwis1a214512008-06-11 05:26:20 +00003911PyInit_imp(void)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003912{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003913 PyObject *m, *d;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003914
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003915 if (PyType_Ready(&PyNullImporter_Type) < 0)
3916 return NULL;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003917
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003918 m = PyModule_Create(&impmodule);
3919 if (m == NULL)
3920 goto failure;
3921 d = PyModule_GetDict(m);
3922 if (d == NULL)
3923 goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003924
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003925 if (setint(d, "SEARCH_ERROR", SEARCH_ERROR) < 0) goto failure;
3926 if (setint(d, "PY_SOURCE", PY_SOURCE) < 0) goto failure;
3927 if (setint(d, "PY_COMPILED", PY_COMPILED) < 0) goto failure;
3928 if (setint(d, "C_EXTENSION", C_EXTENSION) < 0) goto failure;
3929 if (setint(d, "PY_RESOURCE", PY_RESOURCE) < 0) goto failure;
3930 if (setint(d, "PKG_DIRECTORY", PKG_DIRECTORY) < 0) goto failure;
3931 if (setint(d, "C_BUILTIN", C_BUILTIN) < 0) goto failure;
3932 if (setint(d, "PY_FROZEN", PY_FROZEN) < 0) goto failure;
3933 if (setint(d, "PY_CODERESOURCE", PY_CODERESOURCE) < 0) goto failure;
3934 if (setint(d, "IMP_HOOK", IMP_HOOK) < 0) goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003935
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003936 Py_INCREF(&PyNullImporter_Type);
3937 PyModule_AddObject(m, "NullImporter", (PyObject *)&PyNullImporter_Type);
3938 return m;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003939 failure:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003940 Py_XDECREF(m);
3941 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003942}
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003943
3944
Guido van Rossumb18618d2000-05-03 23:44:39 +00003945/* API for embedding applications that want to add their own entries
3946 to the table of built-in modules. This should normally be called
3947 *before* Py_Initialize(). When the table resize fails, -1 is
3948 returned and the existing table is unchanged.
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003949
3950 After a similar function by Just van Rossum. */
3951
3952int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003953PyImport_ExtendInittab(struct _inittab *newtab)
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003954{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003955 static struct _inittab *our_copy = NULL;
3956 struct _inittab *p;
3957 int i, n;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003958
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003959 /* Count the number of entries in both tables */
3960 for (n = 0; newtab[n].name != NULL; n++)
3961 ;
3962 if (n == 0)
3963 return 0; /* Nothing to do */
3964 for (i = 0; PyImport_Inittab[i].name != NULL; i++)
3965 ;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003966
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003967 /* Allocate new memory for the combined table */
3968 p = our_copy;
3969 PyMem_RESIZE(p, struct _inittab, i+n+1);
3970 if (p == NULL)
3971 return -1;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003972
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003973 /* Copy the tables into the new memory */
3974 if (our_copy != PyImport_Inittab)
3975 memcpy(p, PyImport_Inittab, (i+1) * sizeof(struct _inittab));
3976 PyImport_Inittab = our_copy = p;
3977 memcpy(p+i, newtab, (n+1) * sizeof(struct _inittab));
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003978
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003979 return 0;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003980}
3981
3982/* Shorthand to add a single entry given a name and a function */
3983
3984int
Brett Cannona826f322009-04-02 03:41:46 +00003985PyImport_AppendInittab(const char *name, PyObject* (*initfunc)(void))
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003986{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003987 struct _inittab newtab[2];
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003988
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003989 memset(newtab, '\0', sizeof newtab);
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003990
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003991 newtab[0].name = (char *)name;
3992 newtab[0].initfunc = initfunc;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003993
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003994 return PyImport_ExtendInittab(newtab);
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003995}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00003996
3997#ifdef __cplusplus
3998}
3999#endif