blob: 1d3a4859dae8a0cf2ce57280deb33b84f5a81401 [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;
1296 PyCodeObject *co;
1297 PyObject *m;
Brett Cannon9a5b25a2010-03-01 02:09:17 +00001298
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001299 if (fstat(fileno(fp), &st) != 0) {
1300 PyErr_Format(PyExc_RuntimeError,
1301 "unable to get file status from '%s'",
1302 pathname);
1303 return NULL;
1304 }
Antoine Pitrou33d15f72012-01-25 18:01:45 +01001305 if (sizeof st.st_mtime > 4) {
1306 /* Python's .pyc timestamp handling presumes that the timestamp fits
1307 in 4 bytes. Since the code only does an equality comparison,
1308 ordering is not important and we can safely ignore the higher bits
1309 (collisions are extremely unlikely).
1310 */
1311 st.st_mtime &= 0xFFFFFFFF;
1312 }
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:
1353 PyMem_FREE(buf);
1354 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001355}
1356
Christian Heimes3b06e532008-01-07 20:12:44 +00001357/* Get source file -> unicode or None
1358 * Returns the path to the py file if available, else the given path
1359 */
1360static PyObject *
Barry Warsaw28a691b2010-04-17 00:19:56 +00001361get_sourcefile(char *file)
Christian Heimes3b06e532008-01-07 20:12:44 +00001362{
Gregory P. Smithc809f982012-03-18 16:06:53 -07001363 char *py = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001364 Py_ssize_t len;
1365 PyObject *u;
1366 struct stat statbuf;
Christian Heimes3b06e532008-01-07 20:12:44 +00001367
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001368 if (!file || !*file) {
1369 Py_RETURN_NONE;
1370 }
Christian Heimes3b06e532008-01-07 20:12:44 +00001371
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001372 len = strlen(file);
1373 /* match '*.py?' */
1374 if (len > MAXPATHLEN || PyOS_strnicmp(&file[len-4], ".py", 3) != 0) {
1375 return PyUnicode_DecodeFSDefault(file);
1376 }
Christian Heimes3b06e532008-01-07 20:12:44 +00001377
Gregory P. Smithc809f982012-03-18 16:06:53 -07001378 py = PyMem_MALLOC(MAXPATHLEN+1);
1379 if (py == NULL) {
1380 return PyErr_NoMemory();
1381 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001382 /* Start by trying to turn PEP 3147 path into source path. If that
1383 * fails, just chop off the trailing character, i.e. legacy pyc path
1384 * to py.
1385 */
1386 if (make_source_pathname(file, py) == NULL) {
1387 strncpy(py, file, len-1);
1388 py[len-1] = '\0';
1389 }
Barry Warsaw28a691b2010-04-17 00:19:56 +00001390
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001391 if (stat(py, &statbuf) == 0 &&
1392 S_ISREG(statbuf.st_mode)) {
1393 u = PyUnicode_DecodeFSDefault(py);
1394 }
1395 else {
1396 u = PyUnicode_DecodeFSDefault(file);
1397 }
Gregory P. Smithc809f982012-03-18 16:06:53 -07001398 PyMem_FREE(py);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001399 return u;
Christian Heimes3b06e532008-01-07 20:12:44 +00001400}
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001401
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001402/* Forward */
Just van Rossum52e14d62002-12-30 22:08:05 +00001403static PyObject *load_module(char *, FILE *, char *, int, PyObject *);
1404static struct filedescr *find_module(char *, char *, PyObject *,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001405 char *, size_t, FILE **, PyObject **);
Christian Heimes3b06e532008-01-07 20:12:44 +00001406static struct _frozen * find_frozen(char *);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001407
1408/* Load a package and return its module object WITH INCREMENTED
1409 REFERENCE COUNT */
1410
1411static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001412load_package(char *name, char *pathname)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001413{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001414 PyObject *m, *d;
1415 PyObject *file = NULL;
1416 PyObject *path = NULL;
1417 int err;
Gregory P. Smithc809f982012-03-18 16:06:53 -07001418 char *buf = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001419 FILE *fp = NULL;
1420 struct filedescr *fdp;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001421
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001422 m = PyImport_AddModule(name);
1423 if (m == NULL)
1424 return NULL;
1425 if (Py_VerboseFlag)
1426 PySys_WriteStderr("import %s # directory %s\n",
1427 name, pathname);
1428 d = PyModule_GetDict(m);
1429 file = get_sourcefile(pathname);
1430 if (file == NULL)
1431 goto error;
1432 path = Py_BuildValue("[O]", file);
1433 if (path == NULL)
1434 goto error;
1435 err = PyDict_SetItemString(d, "__file__", file);
1436 if (err == 0)
1437 err = PyDict_SetItemString(d, "__path__", path);
1438 if (err != 0)
1439 goto error;
Gregory P. Smithc809f982012-03-18 16:06:53 -07001440 buf = PyMem_MALLOC(MAXPATHLEN+1);
1441 if (buf == NULL) {
1442 PyErr_NoMemory();
1443 goto error;
1444 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001445 buf[0] = '\0';
Gregory P. Smithc809f982012-03-18 16:06:53 -07001446 fdp = find_module(name, "__init__", path, buf, MAXPATHLEN+1, &fp, NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001447 if (fdp == NULL) {
1448 if (PyErr_ExceptionMatches(PyExc_ImportError)) {
1449 PyErr_Clear();
1450 Py_INCREF(m);
1451 }
1452 else
1453 m = NULL;
1454 goto cleanup;
1455 }
1456 m = load_module(name, fp, buf, fdp->type, NULL);
1457 if (fp != NULL)
1458 fclose(fp);
1459 goto cleanup;
Tim Peters1cd70172004-08-02 03:52:12 +00001460
1461 error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001462 m = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001463 cleanup:
Gregory P. Smithc809f982012-03-18 16:06:53 -07001464 if (buf)
1465 PyMem_FREE(buf);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001466 Py_XDECREF(path);
1467 Py_XDECREF(file);
1468 return m;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001469}
1470
1471
1472/* Helper to test for built-in module */
1473
1474static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001475is_builtin(char *name)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001476{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001477 int i;
1478 for (i = 0; PyImport_Inittab[i].name != NULL; i++) {
1479 if (strcmp(name, PyImport_Inittab[i].name) == 0) {
1480 if (PyImport_Inittab[i].initfunc == NULL)
1481 return -1;
1482 else
1483 return 1;
1484 }
1485 }
1486 return 0;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001487}
1488
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001489
Just van Rossum52e14d62002-12-30 22:08:05 +00001490/* Return an importer object for a sys.path/pkg.__path__ item 'p',
1491 possibly by fetching it from the path_importer_cache dict. If it
Thomas Wouters89f507f2006-12-13 04:49:30 +00001492 wasn't yet cached, traverse path_hooks until a hook is found
Just van Rossum52e14d62002-12-30 22:08:05 +00001493 that can handle the path item. Return None if no hook could;
1494 this tells our caller it should fall back to the builtin
1495 import mechanism. Cache the result in path_importer_cache.
1496 Returns a borrowed reference. */
1497
1498static PyObject *
1499get_path_importer(PyObject *path_importer_cache, PyObject *path_hooks,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001500 PyObject *p)
Just van Rossum52e14d62002-12-30 22:08:05 +00001501{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001502 PyObject *importer;
1503 Py_ssize_t j, nhooks;
Just van Rossum52e14d62002-12-30 22:08:05 +00001504
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001505 /* These conditions are the caller's responsibility: */
1506 assert(PyList_Check(path_hooks));
1507 assert(PyDict_Check(path_importer_cache));
Just van Rossum52e14d62002-12-30 22:08:05 +00001508
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001509 nhooks = PyList_Size(path_hooks);
1510 if (nhooks < 0)
1511 return NULL; /* Shouldn't happen */
Just van Rossum52e14d62002-12-30 22:08:05 +00001512
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001513 importer = PyDict_GetItem(path_importer_cache, p);
1514 if (importer != NULL)
1515 return importer;
Just van Rossum52e14d62002-12-30 22:08:05 +00001516
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001517 /* set path_importer_cache[p] to None to avoid recursion */
1518 if (PyDict_SetItem(path_importer_cache, p, Py_None) != 0)
1519 return NULL;
Just van Rossum52e14d62002-12-30 22:08:05 +00001520
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001521 for (j = 0; j < nhooks; j++) {
1522 PyObject *hook = PyList_GetItem(path_hooks, j);
1523 if (hook == NULL)
1524 return NULL;
1525 importer = PyObject_CallFunctionObjArgs(hook, p, NULL);
1526 if (importer != NULL)
1527 break;
Just van Rossum52e14d62002-12-30 22:08:05 +00001528
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001529 if (!PyErr_ExceptionMatches(PyExc_ImportError)) {
1530 return NULL;
1531 }
1532 PyErr_Clear();
1533 }
1534 if (importer == NULL) {
1535 importer = PyObject_CallFunctionObjArgs(
1536 (PyObject *)&PyNullImporter_Type, p, NULL
1537 );
1538 if (importer == NULL) {
1539 if (PyErr_ExceptionMatches(PyExc_ImportError)) {
1540 PyErr_Clear();
1541 return Py_None;
1542 }
1543 }
1544 }
1545 if (importer != NULL) {
1546 int err = PyDict_SetItem(path_importer_cache, p, importer);
1547 Py_DECREF(importer);
1548 if (err != 0)
1549 return NULL;
1550 }
1551 return importer;
Just van Rossum52e14d62002-12-30 22:08:05 +00001552}
1553
Christian Heimes9cd17752007-11-18 19:35:23 +00001554PyAPI_FUNC(PyObject *)
1555PyImport_GetImporter(PyObject *path) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001556 PyObject *importer=NULL, *path_importer_cache=NULL, *path_hooks=NULL;
Christian Heimes9cd17752007-11-18 19:35:23 +00001557
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001558 if ((path_importer_cache = PySys_GetObject("path_importer_cache"))) {
1559 if ((path_hooks = PySys_GetObject("path_hooks"))) {
1560 importer = get_path_importer(path_importer_cache,
1561 path_hooks, path);
1562 }
1563 }
1564 Py_XINCREF(importer); /* get_path_importer returns a borrowed reference */
1565 return importer;
Christian Heimes9cd17752007-11-18 19:35:23 +00001566}
1567
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001568/* Search the path (default sys.path) for a module. Return the
1569 corresponding filedescr struct, and (via return arguments) the
1570 pathname and an open file. Return NULL if the module is not found. */
1571
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001572#ifdef MS_COREDLL
Thomas Woutersb4bd21c2000-07-22 23:38:01 +00001573extern FILE *PyWin_FindRegisteredModule(const char *, struct filedescr **,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001574 char *, Py_ssize_t);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001575#endif
1576
Martin v. Löwis18e16552006-02-15 17:27:45 +00001577static int case_ok(char *, Py_ssize_t, Py_ssize_t, char *);
Tim Petersdbd9ba62000-07-09 03:09:57 +00001578static int find_init_module(char *); /* Forward */
Just van Rossum52e14d62002-12-30 22:08:05 +00001579static struct filedescr importhookdescr = {"", "", IMP_HOOK};
Guido van Rossum197346f1997-10-31 18:38:52 +00001580
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001581static struct filedescr *
Just van Rossum52e14d62002-12-30 22:08:05 +00001582find_module(char *fullname, char *subname, PyObject *path, char *buf,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001583 size_t buflen, FILE **p_fp, PyObject **p_loader)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001584{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001585 Py_ssize_t i, npath;
1586 size_t len, namelen;
1587 struct filedescr *fdp = NULL;
1588 char *filemode;
1589 FILE *fp = NULL;
1590 PyObject *path_hooks, *path_importer_cache;
1591 struct stat statbuf;
1592 static struct filedescr fd_frozen = {"", "", PY_FROZEN};
1593 static struct filedescr fd_builtin = {"", "", C_BUILTIN};
1594 static struct filedescr fd_package = {"", "", PKG_DIRECTORY};
Gregory P. Smithc809f982012-03-18 16:06:53 -07001595 char *name;
Andrew MacIntyred9400542002-02-26 11:41:34 +00001596#if defined(PYOS_OS2)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001597 size_t saved_len;
1598 size_t saved_namelen;
1599 char *saved_buf = NULL;
Andrew MacIntyred9400542002-02-26 11:41:34 +00001600#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001601 if (p_loader != NULL)
1602 *p_loader = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001603
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001604 if (strlen(subname) > MAXPATHLEN) {
1605 PyErr_SetString(PyExc_OverflowError,
1606 "module name is too long");
1607 return NULL;
1608 }
Gregory P. Smithc809f982012-03-18 16:06:53 -07001609 name = PyMem_MALLOC(MAXPATHLEN+1);
1610 if (name == NULL) {
1611 PyErr_NoMemory();
1612 return NULL;
1613 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001614 strcpy(name, subname);
Just van Rossum52e14d62002-12-30 22:08:05 +00001615
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001616 /* sys.meta_path import hook */
1617 if (p_loader != NULL) {
1618 PyObject *meta_path;
Just van Rossum52e14d62002-12-30 22:08:05 +00001619
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001620 meta_path = PySys_GetObject("meta_path");
1621 if (meta_path == NULL || !PyList_Check(meta_path)) {
Victor Stinner16191322011-09-15 19:28:05 +02001622 PyErr_SetString(PyExc_RuntimeError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001623 "sys.meta_path must be a list of "
1624 "import hooks");
Gregory P. Smithc809f982012-03-18 16:06:53 -07001625 goto error_exit;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001626 }
1627 Py_INCREF(meta_path); /* zap guard */
1628 npath = PyList_Size(meta_path);
1629 for (i = 0; i < npath; i++) {
1630 PyObject *loader;
1631 PyObject *hook = PyList_GetItem(meta_path, i);
1632 loader = PyObject_CallMethod(hook, "find_module",
1633 "sO", fullname,
1634 path != NULL ?
1635 path : Py_None);
1636 if (loader == NULL) {
1637 Py_DECREF(meta_path);
Gregory P. Smithc809f982012-03-18 16:06:53 -07001638 goto error_exit; /* true error */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001639 }
1640 if (loader != Py_None) {
1641 /* a loader was found */
1642 *p_loader = loader;
1643 Py_DECREF(meta_path);
Gregory P. Smithc809f982012-03-18 16:06:53 -07001644 PyMem_FREE(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001645 return &importhookdescr;
1646 }
1647 Py_DECREF(loader);
1648 }
1649 Py_DECREF(meta_path);
1650 }
Guido van Rossum0506a431998-08-11 15:07:39 +00001651
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001652 if (find_frozen(fullname) != NULL) {
1653 strcpy(buf, fullname);
Gregory P. Smithc809f982012-03-18 16:06:53 -07001654 PyMem_FREE(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001655 return &fd_frozen;
1656 }
Benjamin Petersond968e272008-11-05 22:48:33 +00001657
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001658 if (path == NULL) {
1659 if (is_builtin(name)) {
1660 strcpy(buf, name);
Gregory P. Smithc809f982012-03-18 16:06:53 -07001661 PyMem_FREE(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001662 return &fd_builtin;
1663 }
Guido van Rossumac279101996-08-22 23:10:58 +00001664#ifdef MS_COREDLL
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001665 fp = PyWin_FindRegisteredModule(name, &fdp, buf, buflen);
1666 if (fp != NULL) {
1667 *p_fp = fp;
Gregory P. Smithc809f982012-03-18 16:06:53 -07001668 PyMem_FREE(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001669 return fdp;
1670 }
Guido van Rossuma5a3db71996-04-09 02:39:59 +00001671#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001672 path = PySys_GetObject("path");
1673 }
Benjamin Petersond968e272008-11-05 22:48:33 +00001674
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001675 if (path == NULL || !PyList_Check(path)) {
Victor Stinner16191322011-09-15 19:28:05 +02001676 PyErr_SetString(PyExc_RuntimeError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001677 "sys.path must be a list of directory names");
Gregory P. Smithc809f982012-03-18 16:06:53 -07001678 goto error_exit;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001679 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001680
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001681 path_hooks = PySys_GetObject("path_hooks");
1682 if (path_hooks == NULL || !PyList_Check(path_hooks)) {
Victor Stinner16191322011-09-15 19:28:05 +02001683 PyErr_SetString(PyExc_RuntimeError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001684 "sys.path_hooks must be a list of "
1685 "import hooks");
Gregory P. Smithc809f982012-03-18 16:06:53 -07001686 goto error_exit;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001687 }
1688 path_importer_cache = PySys_GetObject("path_importer_cache");
1689 if (path_importer_cache == NULL ||
1690 !PyDict_Check(path_importer_cache)) {
Victor Stinner16191322011-09-15 19:28:05 +02001691 PyErr_SetString(PyExc_RuntimeError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001692 "sys.path_importer_cache must be a dict");
Gregory P. Smithc809f982012-03-18 16:06:53 -07001693 goto error_exit;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001694 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001695
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001696 npath = PyList_Size(path);
1697 namelen = strlen(name);
1698 for (i = 0; i < npath; i++) {
1699 PyObject *v = PyList_GetItem(path, i);
1700 PyObject *origv = v;
1701 const char *base;
1702 Py_ssize_t size;
1703 if (!v)
Gregory P. Smithc809f982012-03-18 16:06:53 -07001704 goto error_exit;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001705 if (PyUnicode_Check(v)) {
Victor Stinnerae6265f2010-05-15 16:27:27 +00001706 v = PyUnicode_EncodeFSDefault(v);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001707 if (v == NULL)
Gregory P. Smithc809f982012-03-18 16:06:53 -07001708 goto error_exit;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001709 }
1710 else if (!PyBytes_Check(v))
1711 continue;
1712 else
1713 Py_INCREF(v);
Amaury Forgeot d'Arcf1ca0b12008-06-11 17:40:47 +00001714
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001715 base = PyBytes_AS_STRING(v);
1716 size = PyBytes_GET_SIZE(v);
1717 len = size;
1718 if (len + 2 + namelen + MAXSUFFIXSIZE >= buflen) {
1719 Py_DECREF(v);
1720 continue; /* Too long */
1721 }
1722 strcpy(buf, base);
1723 Py_DECREF(v);
Amaury Forgeot d'Arcf1ca0b12008-06-11 17:40:47 +00001724
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001725 if (strlen(buf) != len) {
1726 continue; /* v contains '\0' */
1727 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001728
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001729 /* sys.path_hooks import hook */
1730 if (p_loader != NULL) {
1731 PyObject *importer;
Just van Rossum52e14d62002-12-30 22:08:05 +00001732
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001733 importer = get_path_importer(path_importer_cache,
1734 path_hooks, origv);
1735 if (importer == NULL) {
Gregory P. Smithc809f982012-03-18 16:06:53 -07001736 goto error_exit;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001737 }
1738 /* Note: importer is a borrowed reference */
1739 if (importer != Py_None) {
1740 PyObject *loader;
1741 loader = PyObject_CallMethod(importer,
1742 "find_module",
1743 "s", fullname);
1744 if (loader == NULL)
Gregory P. Smithc809f982012-03-18 16:06:53 -07001745 goto error_exit; /* error */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001746 if (loader != Py_None) {
1747 /* a loader was found */
1748 *p_loader = loader;
Gregory P. Smithc809f982012-03-18 16:06:53 -07001749 PyMem_FREE(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001750 return &importhookdescr;
1751 }
1752 Py_DECREF(loader);
1753 continue;
1754 }
1755 }
1756 /* no hook was found, use builtin import */
Just van Rossum52e14d62002-12-30 22:08:05 +00001757
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001758 if (len > 0 && buf[len-1] != SEP
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001759#ifdef ALTSEP
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001760 && buf[len-1] != ALTSEP
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001761#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001762 )
1763 buf[len++] = SEP;
1764 strcpy(buf+len, name);
1765 len += namelen;
Tim Peters50d8d372001-02-28 05:34:27 +00001766
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001767 /* Check for package import (buf holds a directory name,
1768 and there's an __init__ module in that directory */
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001769#ifdef HAVE_STAT
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001770 if (stat(buf, &statbuf) == 0 && /* it exists */
1771 S_ISDIR(statbuf.st_mode) && /* it's a directory */
1772 case_ok(buf, len, namelen, name)) { /* case matches */
1773 if (find_init_module(buf)) { /* and has __init__.py */
Gregory P. Smithc809f982012-03-18 16:06:53 -07001774 PyMem_FREE(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001775 return &fd_package;
1776 }
1777 else {
Victor Stinnered7916d2010-10-17 02:07:09 +00001778 int err;
1779 PyObject *unicode = PyUnicode_DecodeFSDefault(buf);
1780 if (unicode == NULL)
Gregory P. Smithc809f982012-03-18 16:06:53 -07001781 goto error_exit;
Victor Stinnered7916d2010-10-17 02:07:09 +00001782 err = PyErr_WarnFormat(PyExc_ImportWarning, 1,
1783 "Not importing directory '%U': missing __init__.py",
1784 unicode);
1785 Py_DECREF(unicode);
1786 if (err)
Gregory P. Smithc809f982012-03-18 16:06:53 -07001787 goto error_exit;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001788 }
1789 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001790#endif
Andrew MacIntyred9400542002-02-26 11:41:34 +00001791#if defined(PYOS_OS2)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001792 /* take a snapshot of the module spec for restoration
1793 * after the 8 character DLL hackery
1794 */
1795 saved_buf = strdup(buf);
1796 saved_len = len;
1797 saved_namelen = namelen;
Andrew MacIntyred9400542002-02-26 11:41:34 +00001798#endif /* PYOS_OS2 */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001799 for (fdp = _PyImport_Filetab; fdp->suffix != NULL; fdp++) {
Victor Stinner53ffdc52011-09-23 18:54:40 +02001800 struct stat statbuf;
Guido van Rossum04110fb2007-08-24 16:32:05 +00001801#if defined(PYOS_OS2) && defined(HAVE_DYNAMIC_LOADING)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001802 /* OS/2 limits DLLs to 8 character names (w/o
1803 extension)
1804 * so if the name is longer than that and its a
1805 * dynamically loaded module we're going to try,
1806 * truncate the name before trying
1807 */
1808 if (strlen(subname) > 8) {
1809 /* is this an attempt to load a C extension? */
1810 const struct filedescr *scan;
1811 scan = _PyImport_DynLoadFiletab;
1812 while (scan->suffix != NULL) {
1813 if (!strcmp(scan->suffix, fdp->suffix))
1814 break;
1815 else
1816 scan++;
1817 }
1818 if (scan->suffix != NULL) {
1819 /* yes, so truncate the name */
1820 namelen = 8;
1821 len -= strlen(subname) - namelen;
1822 buf[len] = '\0';
1823 }
1824 }
Andrew MacIntyred9400542002-02-26 11:41:34 +00001825#endif /* PYOS_OS2 */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001826 strcpy(buf+len, fdp->suffix);
1827 if (Py_VerboseFlag > 1)
1828 PySys_WriteStderr("# trying %s\n", buf);
Victor Stinner53ffdc52011-09-23 18:54:40 +02001829
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001830 filemode = fdp->mode;
1831 if (filemode[0] == 'U')
1832 filemode = "r" PY_STDIOTEXTMODE;
Victor Stinner53ffdc52011-09-23 18:54:40 +02001833
1834 if (stat(buf, &statbuf) == 0 && S_ISDIR(statbuf.st_mode))
1835 /* it's a directory */
1836 fp = NULL;
1837 else
1838 fp = fopen(buf, filemode);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001839 if (fp != NULL) {
1840 if (case_ok(buf, len, namelen, name))
1841 break;
1842 else { /* continue search */
1843 fclose(fp);
1844 fp = NULL;
1845 }
1846 }
Andrew MacIntyred9400542002-02-26 11:41:34 +00001847#if defined(PYOS_OS2)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001848 /* restore the saved snapshot */
1849 strcpy(buf, saved_buf);
1850 len = saved_len;
1851 namelen = saved_namelen;
Andrew MacIntyred9400542002-02-26 11:41:34 +00001852#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001853 }
Andrew MacIntyred9400542002-02-26 11:41:34 +00001854#if defined(PYOS_OS2)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001855 /* don't need/want the module name snapshot anymore */
1856 if (saved_buf)
1857 {
1858 free(saved_buf);
1859 saved_buf = NULL;
1860 }
Andrew MacIntyred9400542002-02-26 11:41:34 +00001861#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001862 if (fp != NULL)
1863 break;
1864 }
1865 if (fp == NULL) {
1866 PyErr_Format(PyExc_ImportError,
1867 "No module named %.200s", name);
Gregory P. Smithc809f982012-03-18 16:06:53 -07001868 goto error_exit;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001869 }
1870 *p_fp = fp;
Gregory P. Smithc809f982012-03-18 16:06:53 -07001871 PyMem_FREE(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001872 return fdp;
Gregory P. Smithc809f982012-03-18 16:06:53 -07001873
1874error_exit:
1875 PyMem_FREE(name);
1876 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001877}
1878
Martin v. Löwis18e16552006-02-15 17:27:45 +00001879/* case_ok(char* buf, Py_ssize_t len, Py_ssize_t namelen, char* name)
Tim Petersd1e87a82001-03-01 18:12:00 +00001880 * The arguments here are tricky, best shown by example:
1881 * /a/b/c/d/e/f/g/h/i/j/k/some_long_module_name.py\0
1882 * ^ ^ ^ ^
1883 * |--------------------- buf ---------------------|
1884 * |------------------- len ------------------|
1885 * |------ name -------|
1886 * |----- namelen -----|
1887 * buf is the full path, but len only counts up to (& exclusive of) the
1888 * extension. name is the module name, also exclusive of extension.
1889 *
1890 * We've already done a successful stat() or fopen() on buf, so know that
1891 * there's some match, possibly case-insensitive.
1892 *
Tim Peters50d8d372001-02-28 05:34:27 +00001893 * case_ok() is to return 1 if there's a case-sensitive match for
1894 * name, else 0. case_ok() is also to return 1 if envar PYTHONCASEOK
1895 * exists.
Tim Petersd1e87a82001-03-01 18:12:00 +00001896 *
Tim Peters50d8d372001-02-28 05:34:27 +00001897 * case_ok() is used to implement case-sensitive import semantics even
1898 * on platforms with case-insensitive filesystems. It's trivial to implement
1899 * for case-sensitive filesystems. It's pretty much a cross-platform
1900 * nightmare for systems with case-insensitive filesystems.
1901 */
Guido van Rossum0980bd91998-02-13 17:18:36 +00001902
Tim Peters50d8d372001-02-28 05:34:27 +00001903/* First we may need a pile of platform-specific header files; the sequence
1904 * of #if's here should match the sequence in the body of case_ok().
1905 */
Jason Tishler7961aa62005-05-20 00:56:54 +00001906#if defined(MS_WINDOWS)
Guido van Rossum0980bd91998-02-13 17:18:36 +00001907#include <windows.h>
Guido van Rossum4c3f57c2001-01-10 20:40:46 +00001908
Tim Peters50d8d372001-02-28 05:34:27 +00001909#elif defined(DJGPP)
1910#include <dir.h>
1911
Jason Tishler7961aa62005-05-20 00:56:54 +00001912#elif (defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) && defined(HAVE_DIRENT_H)
Tim Peters430f5d42001-03-01 01:30:56 +00001913#include <sys/types.h>
1914#include <dirent.h>
1915
Andrew MacIntyred9400542002-02-26 11:41:34 +00001916#elif defined(PYOS_OS2)
1917#define INCL_DOS
1918#define INCL_DOSERRORS
1919#define INCL_NOPMAPI
1920#include <os2.h>
Tim Peters50d8d372001-02-28 05:34:27 +00001921#endif
1922
Guido van Rossum0980bd91998-02-13 17:18:36 +00001923static int
Martin v. Löwis18e16552006-02-15 17:27:45 +00001924case_ok(char *buf, Py_ssize_t len, Py_ssize_t namelen, char *name)
Guido van Rossum0980bd91998-02-13 17:18:36 +00001925{
Tim Peters50d8d372001-02-28 05:34:27 +00001926/* Pick a platform-specific implementation; the sequence of #if's here should
1927 * match the sequence just above.
1928 */
1929
Jason Tishler7961aa62005-05-20 00:56:54 +00001930/* MS_WINDOWS */
1931#if defined(MS_WINDOWS)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001932 WIN32_FIND_DATA data;
1933 HANDLE h;
Tim Peters50d8d372001-02-28 05:34:27 +00001934
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001935 if (Py_GETENV("PYTHONCASEOK") != NULL)
1936 return 1;
Tim Peters50d8d372001-02-28 05:34:27 +00001937
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001938 h = FindFirstFile(buf, &data);
1939 if (h == INVALID_HANDLE_VALUE) {
1940 PyErr_Format(PyExc_NameError,
1941 "Can't find file for module %.100s\n(filename %.300s)",
1942 name, buf);
1943 return 0;
1944 }
1945 FindClose(h);
1946 return strncmp(data.cFileName, name, namelen) == 0;
Tim Peters50d8d372001-02-28 05:34:27 +00001947
1948/* DJGPP */
1949#elif defined(DJGPP)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001950 struct ffblk ffblk;
1951 int done;
Tim Peters50d8d372001-02-28 05:34:27 +00001952
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001953 if (Py_GETENV("PYTHONCASEOK") != NULL)
1954 return 1;
Tim Peters50d8d372001-02-28 05:34:27 +00001955
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001956 done = findfirst(buf, &ffblk, FA_ARCH|FA_RDONLY|FA_HIDDEN|FA_DIREC);
1957 if (done) {
1958 PyErr_Format(PyExc_NameError,
1959 "Can't find file for module %.100s\n(filename %.300s)",
1960 name, buf);
1961 return 0;
1962 }
1963 return strncmp(ffblk.ff_name, name, namelen) == 0;
Guido van Rossum0980bd91998-02-13 17:18:36 +00001964
Jason Tishler7961aa62005-05-20 00:56:54 +00001965/* new-fangled macintosh (macosx) or Cygwin */
1966#elif (defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) && defined(HAVE_DIRENT_H)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001967 DIR *dirp;
1968 struct dirent *dp;
1969 char dirname[MAXPATHLEN + 1];
1970 const int dirlen = len - namelen - 1; /* don't want trailing SEP */
Tim Peters430f5d42001-03-01 01:30:56 +00001971
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001972 if (Py_GETENV("PYTHONCASEOK") != NULL)
1973 return 1;
Tim Petersdbe6ebb2001-03-01 08:47:29 +00001974
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001975 /* Copy the dir component into dirname; substitute "." if empty */
1976 if (dirlen <= 0) {
1977 dirname[0] = '.';
1978 dirname[1] = '\0';
1979 }
1980 else {
1981 assert(dirlen <= MAXPATHLEN);
1982 memcpy(dirname, buf, dirlen);
1983 dirname[dirlen] = '\0';
1984 }
1985 /* Open the directory and search the entries for an exact match. */
1986 dirp = opendir(dirname);
1987 if (dirp) {
1988 char *nameWithExt = buf + len - namelen;
1989 while ((dp = readdir(dirp)) != NULL) {
1990 const int thislen =
Tim Peters430f5d42001-03-01 01:30:56 +00001991#ifdef _DIRENT_HAVE_D_NAMELEN
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001992 dp->d_namlen;
Tim Peters430f5d42001-03-01 01:30:56 +00001993#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001994 strlen(dp->d_name);
Tim Peters430f5d42001-03-01 01:30:56 +00001995#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001996 if (thislen >= namelen &&
1997 strcmp(dp->d_name, nameWithExt) == 0) {
1998 (void)closedir(dirp);
1999 return 1; /* Found */
2000 }
2001 }
2002 (void)closedir(dirp);
2003 }
2004 return 0 ; /* Not found */
Tim Peters430f5d42001-03-01 01:30:56 +00002005
Andrew MacIntyred9400542002-02-26 11:41:34 +00002006/* OS/2 */
2007#elif defined(PYOS_OS2)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002008 HDIR hdir = 1;
2009 ULONG srchcnt = 1;
2010 FILEFINDBUF3 ffbuf;
2011 APIRET rc;
Andrew MacIntyred9400542002-02-26 11:41:34 +00002012
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002013 if (Py_GETENV("PYTHONCASEOK") != NULL)
2014 return 1;
Andrew MacIntyred9400542002-02-26 11:41:34 +00002015
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002016 rc = DosFindFirst(buf,
2017 &hdir,
2018 FILE_READONLY | FILE_HIDDEN | FILE_SYSTEM | FILE_DIRECTORY,
2019 &ffbuf, sizeof(ffbuf),
2020 &srchcnt,
2021 FIL_STANDARD);
2022 if (rc != NO_ERROR)
2023 return 0;
2024 return strncmp(ffbuf.achName, name, namelen) == 0;
Andrew MacIntyred9400542002-02-26 11:41:34 +00002025
Tim Peters50d8d372001-02-28 05:34:27 +00002026/* assuming it's a case-sensitive filesystem, so there's nothing to do! */
2027#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002028 return 1;
Guido van Rossum0980bd91998-02-13 17:18:36 +00002029
Guido van Rossum4d1b3b91998-02-13 23:27:59 +00002030#endif
Tim Peters50d8d372001-02-28 05:34:27 +00002031}
Guido van Rossum4d1b3b91998-02-13 23:27:59 +00002032
Guido van Rossum197346f1997-10-31 18:38:52 +00002033#ifdef HAVE_STAT
Victor Stinner4f4402c2010-08-14 14:50:26 +00002034
Guido van Rossum197346f1997-10-31 18:38:52 +00002035/* Helper to look for __init__.py or __init__.py[co] in potential package */
2036static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002037find_init_module(char *buf)
Guido van Rossum197346f1997-10-31 18:38:52 +00002038{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002039 const size_t save_len = strlen(buf);
2040 size_t i = save_len;
2041 char *pname; /* pointer to start of __init__ */
2042 struct stat statbuf;
Guido van Rossum197346f1997-10-31 18:38:52 +00002043
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002044/* For calling case_ok(buf, len, namelen, name):
2045 * /a/b/c/d/e/f/g/h/i/j/k/some_long_module_name.py\0
2046 * ^ ^ ^ ^
2047 * |--------------------- buf ---------------------|
2048 * |------------------- len ------------------|
2049 * |------ name -------|
2050 * |----- namelen -----|
Tim Peters0f9431f2001-07-05 03:47:53 +00002051 */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002052 if (save_len + 13 >= MAXPATHLEN)
2053 return 0;
2054 buf[i++] = SEP;
2055 pname = buf + i;
2056 strcpy(pname, "__init__.py");
2057 if (stat(buf, &statbuf) == 0) {
2058 if (case_ok(buf,
2059 save_len + 9, /* len("/__init__") */
2060 8, /* len("__init__") */
2061 pname)) {
2062 buf[save_len] = '\0';
2063 return 1;
2064 }
2065 }
2066 i += strlen(pname);
2067 strcpy(buf+i, Py_OptimizeFlag ? "o" : "c");
2068 if (stat(buf, &statbuf) == 0) {
2069 if (case_ok(buf,
2070 save_len + 9, /* len("/__init__") */
2071 8, /* len("__init__") */
2072 pname)) {
2073 buf[save_len] = '\0';
2074 return 1;
2075 }
2076 }
2077 buf[save_len] = '\0';
2078 return 0;
Guido van Rossum197346f1997-10-31 18:38:52 +00002079}
Guido van Rossum48a680c2001-03-02 06:34:14 +00002080
Guido van Rossum197346f1997-10-31 18:38:52 +00002081#endif /* HAVE_STAT */
2082
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002083
Tim Petersdbd9ba62000-07-09 03:09:57 +00002084static int init_builtin(char *); /* Forward */
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002085
Victor Stinner44c6c152010-08-09 00:59:10 +00002086static PyObject*
2087load_builtin(char *name, char *pathname, int type)
2088{
2089 PyObject *m, *modules;
2090 int err;
2091
2092 if (pathname != NULL && pathname[0] != '\0')
2093 name = pathname;
2094
2095 if (type == C_BUILTIN)
2096 err = init_builtin(name);
2097 else
2098 err = PyImport_ImportFrozenModule(name);
2099 if (err < 0)
2100 return NULL;
2101 if (err == 0) {
2102 PyErr_Format(PyExc_ImportError,
2103 "Purported %s module %.200s not found",
2104 type == C_BUILTIN ?
2105 "builtin" : "frozen",
2106 name);
2107 return NULL;
2108 }
2109
2110 modules = PyImport_GetModuleDict();
2111 m = PyDict_GetItemString(modules, name);
2112 if (m == NULL) {
2113 PyErr_Format(
2114 PyExc_ImportError,
2115 "%s module %.200s not properly initialized",
2116 type == C_BUILTIN ?
2117 "builtin" : "frozen",
2118 name);
2119 return NULL;
2120 }
2121 Py_INCREF(m);
2122 return m;
2123}
2124
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002125/* Load an external module using the default search path and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00002126 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002127
Guido van Rossum79f25d91997-04-29 20:08:16 +00002128static PyObject *
Alexandre Vassalottie223eb82009-07-29 20:12:15 +00002129load_module(char *name, FILE *fp, char *pathname, int type, PyObject *loader)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002130{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002131 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002132
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002133 /* First check that there's an open file (if we need one) */
2134 switch (type) {
2135 case PY_SOURCE:
2136 case PY_COMPILED:
2137 if (fp == NULL) {
2138 PyErr_Format(PyExc_ValueError,
2139 "file object required for import (type code %d)",
2140 type);
2141 return NULL;
2142 }
2143 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002144
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002145 switch (type) {
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002146
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002147 case PY_SOURCE:
2148 m = load_source_module(name, pathname, fp);
2149 break;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002150
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002151 case PY_COMPILED:
2152 m = load_compiled_module(name, pathname, fp);
2153 break;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002154
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002155#ifdef HAVE_DYNAMIC_LOADING
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002156 case C_EXTENSION:
2157 m = _PyImport_LoadDynamicModule(name, pathname, fp);
2158 break;
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002159#endif
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002160
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002161 case PKG_DIRECTORY:
2162 m = load_package(name, pathname);
2163 break;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002164
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002165 case C_BUILTIN:
2166 case PY_FROZEN:
Victor Stinner44c6c152010-08-09 00:59:10 +00002167 m = load_builtin(name, pathname, type);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002168 break;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002169
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002170 case IMP_HOOK: {
2171 if (loader == NULL) {
2172 PyErr_SetString(PyExc_ImportError,
2173 "import hook without loader");
2174 return NULL;
2175 }
2176 m = PyObject_CallMethod(loader, "load_module", "s", name);
2177 break;
2178 }
Just van Rossum52e14d62002-12-30 22:08:05 +00002179
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002180 default:
2181 PyErr_Format(PyExc_ImportError,
2182 "Don't know how to import %.200s (type code %d)",
2183 name, type);
2184 m = NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002185
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002186 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002187
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002188 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002189}
2190
2191
2192/* Initialize a built-in module.
Thomas Wouters89f507f2006-12-13 04:49:30 +00002193 Return 1 for success, 0 if the module is not found, and -1 with
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002194 an exception set if the initialization failed. */
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002195
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002196static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002197init_builtin(char *name)
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002198{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002199 struct _inittab *p;
Guido van Rossum25ce5661997-08-02 03:10:38 +00002200
Victor Stinner49d3f252010-10-17 01:24:53 +00002201 if (_PyImport_FindBuiltin(name) != NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002202 return 1;
Guido van Rossum25ce5661997-08-02 03:10:38 +00002203
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002204 for (p = PyImport_Inittab; p->name != NULL; p++) {
2205 PyObject *mod;
Antoine Pitrou6c40eb72012-01-18 20:16:09 +01002206 PyModuleDef *def;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002207 if (strcmp(name, p->name) == 0) {
2208 if (p->initfunc == NULL) {
2209 PyErr_Format(PyExc_ImportError,
2210 "Cannot re-init internal module %.200s",
2211 name);
2212 return -1;
2213 }
2214 if (Py_VerboseFlag)
2215 PySys_WriteStderr("import %s # builtin\n", name);
2216 mod = (*p->initfunc)();
2217 if (mod == 0)
2218 return -1;
Antoine Pitrou6c40eb72012-01-18 20:16:09 +01002219 /* Remember pointer to module init function. */
2220 def = PyModule_GetDef(mod);
2221 def->m_base.m_init = p->initfunc;
Victor Stinner49d3f252010-10-17 01:24:53 +00002222 if (_PyImport_FixupBuiltin(mod, name) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002223 return -1;
2224 /* FixupExtension has put the module into sys.modules,
2225 so we can release our own reference. */
2226 Py_DECREF(mod);
2227 return 1;
2228 }
2229 }
2230 return 0;
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002231}
Guido van Rossumf56e3db1993-04-01 20:59:32 +00002232
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002233
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002234/* Frozen modules */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002235
Guido van Rossumcfd0a221996-06-17 17:06:34 +00002236static struct _frozen *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002237find_frozen(char *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002238{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002239 struct _frozen *p;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002240
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002241 if (!name)
2242 return NULL;
Benjamin Petersond968e272008-11-05 22:48:33 +00002243
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002244 for (p = PyImport_FrozenModules; ; p++) {
2245 if (p->name == NULL)
2246 return NULL;
2247 if (strcmp(p->name, name) == 0)
2248 break;
2249 }
2250 return p;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002251}
2252
Guido van Rossum79f25d91997-04-29 20:08:16 +00002253static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002254get_frozen_object(char *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002255{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002256 struct _frozen *p = find_frozen(name);
2257 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002258
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002259 if (p == NULL) {
2260 PyErr_Format(PyExc_ImportError,
2261 "No such frozen object named %.200s",
2262 name);
2263 return NULL;
2264 }
2265 if (p->code == NULL) {
2266 PyErr_Format(PyExc_ImportError,
2267 "Excluded frozen object named %.200s",
2268 name);
2269 return NULL;
2270 }
2271 size = p->size;
2272 if (size < 0)
2273 size = -size;
2274 return PyMarshal_ReadObjectFromString((char *)p->code, size);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002275}
2276
Brett Cannon8d110132009-03-15 02:20:16 +00002277static PyObject *
2278is_frozen_package(char *name)
2279{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002280 struct _frozen *p = find_frozen(name);
2281 int size;
Brett Cannon8d110132009-03-15 02:20:16 +00002282
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002283 if (p == NULL) {
2284 PyErr_Format(PyExc_ImportError,
2285 "No such frozen object named %.200s",
2286 name);
2287 return NULL;
2288 }
Brett Cannon8d110132009-03-15 02:20:16 +00002289
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002290 size = p->size;
Brett Cannon8d110132009-03-15 02:20:16 +00002291
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002292 if (size < 0)
2293 Py_RETURN_TRUE;
2294 else
2295 Py_RETURN_FALSE;
Brett Cannon8d110132009-03-15 02:20:16 +00002296}
2297
2298
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002299/* Initialize a frozen module.
Brett Cannon3c2ac442009-03-08 20:49:47 +00002300 Return 1 for success, 0 if the module is not found, and -1 with
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002301 an exception set if the initialization failed.
2302 This function is also used from frozenmain.c */
Guido van Rossum0b344901995-02-07 15:35:27 +00002303
2304int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002305PyImport_ImportFrozenModule(char *name)
Guido van Rossumf56e3db1993-04-01 20:59:32 +00002306{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002307 struct _frozen *p = find_frozen(name);
2308 PyObject *co;
2309 PyObject *m;
2310 int ispackage;
2311 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002312
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002313 if (p == NULL)
2314 return 0;
2315 if (p->code == NULL) {
2316 PyErr_Format(PyExc_ImportError,
2317 "Excluded frozen object named %.200s",
2318 name);
2319 return -1;
2320 }
2321 size = p->size;
2322 ispackage = (size < 0);
2323 if (ispackage)
2324 size = -size;
2325 if (Py_VerboseFlag)
2326 PySys_WriteStderr("import %s # frozen%s\n",
2327 name, ispackage ? " package" : "");
2328 co = PyMarshal_ReadObjectFromString((char *)p->code, size);
2329 if (co == NULL)
2330 return -1;
2331 if (!PyCode_Check(co)) {
2332 PyErr_Format(PyExc_TypeError,
2333 "frozen object %.200s is not a code object",
2334 name);
2335 goto err_return;
2336 }
2337 if (ispackage) {
2338 /* Set __path__ to the package name */
2339 PyObject *d, *s, *l;
2340 int err;
2341 m = PyImport_AddModule(name);
2342 if (m == NULL)
2343 goto err_return;
2344 d = PyModule_GetDict(m);
2345 s = PyUnicode_InternFromString(name);
2346 if (s == NULL)
2347 goto err_return;
2348 l = PyList_New(1);
2349 if (l == NULL) {
2350 Py_DECREF(s);
2351 goto err_return;
2352 }
2353 PyList_SET_ITEM(l, 0, s);
2354 err = PyDict_SetItemString(d, "__path__", l);
2355 Py_DECREF(l);
2356 if (err != 0)
2357 goto err_return;
2358 }
2359 m = PyImport_ExecCodeModuleEx(name, co, "<frozen>");
2360 if (m == NULL)
2361 goto err_return;
2362 Py_DECREF(co);
2363 Py_DECREF(m);
2364 return 1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002365err_return:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002366 Py_DECREF(co);
2367 return -1;
Guido van Rossumf56e3db1993-04-01 20:59:32 +00002368}
Guido van Rossum74e6a111994-08-29 12:54:38 +00002369
2370
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002371/* Import a module, either built-in, frozen, or external, and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00002372 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum74e6a111994-08-29 12:54:38 +00002373
Guido van Rossum79f25d91997-04-29 20:08:16 +00002374PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00002375PyImport_ImportModule(const char *name)
Guido van Rossum74e6a111994-08-29 12:54:38 +00002376{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002377 PyObject *pname;
2378 PyObject *result;
Marc-André Lemburg3c61c352001-02-09 19:40:15 +00002379
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002380 pname = PyUnicode_FromString(name);
2381 if (pname == NULL)
2382 return NULL;
2383 result = PyImport_Import(pname);
2384 Py_DECREF(pname);
2385 return result;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002386}
2387
Christian Heimes072c0f12008-01-03 23:01:04 +00002388/* Import a module without blocking
2389 *
2390 * At first it tries to fetch the module from sys.modules. If the module was
2391 * never loaded before it loads it with PyImport_ImportModule() unless another
2392 * thread holds the import lock. In the latter case the function raises an
2393 * ImportError instead of blocking.
2394 *
2395 * Returns the module object with incremented ref count.
2396 */
2397PyObject *
2398PyImport_ImportModuleNoBlock(const char *name)
2399{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002400 PyObject *result;
2401 PyObject *modules;
Victor Stinner0af03062011-09-02 00:11:43 +02002402#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002403 long me;
Victor Stinner0af03062011-09-02 00:11:43 +02002404#endif
Christian Heimes072c0f12008-01-03 23:01:04 +00002405
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002406 /* Try to get the module from sys.modules[name] */
2407 modules = PyImport_GetModuleDict();
2408 if (modules == NULL)
2409 return NULL;
Christian Heimes072c0f12008-01-03 23:01:04 +00002410
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002411 result = PyDict_GetItemString(modules, name);
2412 if (result != NULL) {
2413 Py_INCREF(result);
2414 return result;
2415 }
2416 else {
2417 PyErr_Clear();
2418 }
Benjamin Peterson3e4f0552008-09-02 00:31:15 +00002419#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002420 /* check the import lock
2421 * me might be -1 but I ignore the error here, the lock function
2422 * takes care of the problem */
2423 me = PyThread_get_thread_ident();
2424 if (import_lock_thread == -1 || import_lock_thread == me) {
2425 /* no thread or me is holding the lock */
2426 return PyImport_ImportModule(name);
2427 }
2428 else {
2429 PyErr_Format(PyExc_ImportError,
2430 "Failed to import %.200s because the import lock"
2431 "is held by another thread.",
2432 name);
2433 return NULL;
2434 }
Benjamin Peterson3e4f0552008-09-02 00:31:15 +00002435#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002436 return PyImport_ImportModule(name);
Benjamin Peterson3e4f0552008-09-02 00:31:15 +00002437#endif
Christian Heimes072c0f12008-01-03 23:01:04 +00002438}
2439
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002440/* Forward declarations for helper routines */
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002441static PyObject *get_parent(PyObject *globals, char *buf,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002442 Py_ssize_t *p_buflen, int level);
Tim Petersdbd9ba62000-07-09 03:09:57 +00002443static PyObject *load_next(PyObject *mod, PyObject *altmod,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002444 char **p_name, char *buf, Py_ssize_t *p_buflen);
Tim Petersdbd9ba62000-07-09 03:09:57 +00002445static int mark_miss(char *name);
2446static int ensure_fromlist(PyObject *mod, PyObject *fromlist,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002447 char *buf, Py_ssize_t buflen, int recursive);
Tim Petersdbd9ba62000-07-09 03:09:57 +00002448static PyObject * import_submodule(PyObject *mod, char *name, char *fullname);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002449
2450/* The Magnum Opus of dotted-name import :-) */
2451
Guido van Rossum75acc9c1998-03-03 22:26:50 +00002452static PyObject *
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002453import_module_level(char *name, PyObject *globals, PyObject *locals,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002454 PyObject *fromlist, int level)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002455{
Gregory P. Smithc809f982012-03-18 16:06:53 -07002456 char *buf;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002457 Py_ssize_t buflen = 0;
2458 PyObject *parent, *head, *next, *tail;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002459
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002460 if (strchr(name, '/') != NULL
Christian Heimes454f37b2008-01-10 00:10:02 +00002461#ifdef MS_WINDOWS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002462 || strchr(name, '\\') != NULL
Christian Heimes454f37b2008-01-10 00:10:02 +00002463#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002464 ) {
2465 PyErr_SetString(PyExc_ImportError,
2466 "Import by filename is not supported.");
2467 return NULL;
2468 }
Christian Heimes454f37b2008-01-10 00:10:02 +00002469
Gregory P. Smithc809f982012-03-18 16:06:53 -07002470 buf = PyMem_MALLOC(MAXPATHLEN+1);
2471 if (buf == NULL) {
2472 return PyErr_NoMemory();
2473 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002474 parent = get_parent(globals, buf, &buflen, level);
2475 if (parent == NULL)
Gregory P. Smithc809f982012-03-18 16:06:53 -07002476 goto error_exit;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002477
Benjamin Peterson556d8002010-06-27 22:37:28 +00002478 head = load_next(parent, level < 0 ? Py_None : parent, &name, buf,
2479 &buflen);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002480 if (head == NULL)
Gregory P. Smithc809f982012-03-18 16:06:53 -07002481 goto error_exit;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002482
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002483 tail = head;
2484 Py_INCREF(tail);
2485 while (name) {
2486 next = load_next(tail, tail, &name, buf, &buflen);
2487 Py_DECREF(tail);
2488 if (next == NULL) {
2489 Py_DECREF(head);
Gregory P. Smithc809f982012-03-18 16:06:53 -07002490 goto error_exit;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002491 }
2492 tail = next;
2493 }
2494 if (tail == Py_None) {
2495 /* If tail is Py_None, both get_parent and load_next found
2496 an empty module name: someone called __import__("") or
2497 doctored faulty bytecode */
2498 Py_DECREF(tail);
2499 Py_DECREF(head);
2500 PyErr_SetString(PyExc_ValueError,
2501 "Empty module name");
Gregory P. Smithc809f982012-03-18 16:06:53 -07002502 goto error_exit;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002503 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002504
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002505 if (fromlist != NULL) {
2506 if (fromlist == Py_None || !PyObject_IsTrue(fromlist))
2507 fromlist = NULL;
2508 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002509
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002510 if (fromlist == NULL) {
2511 Py_DECREF(tail);
Gregory P. Smithc809f982012-03-18 16:06:53 -07002512 PyMem_FREE(buf);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002513 return head;
2514 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002515
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002516 Py_DECREF(head);
2517 if (!ensure_fromlist(tail, fromlist, buf, buflen, 0)) {
2518 Py_DECREF(tail);
Gregory P. Smithc809f982012-03-18 16:06:53 -07002519 goto error_exit;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002520 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002521
Gregory P. Smithc809f982012-03-18 16:06:53 -07002522 PyMem_FREE(buf);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002523 return tail;
Gregory P. Smithc809f982012-03-18 16:06:53 -07002524
2525error_exit:
2526 PyMem_FREE(buf);
2527 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002528}
2529
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002530PyObject *
2531PyImport_ImportModuleLevel(char *name, PyObject *globals, PyObject *locals,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002532 PyObject *fromlist, int level)
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002533{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002534 PyObject *result;
2535 _PyImport_AcquireLock();
2536 result = import_module_level(name, globals, locals, fromlist, level);
2537 if (_PyImport_ReleaseLock() < 0) {
2538 Py_XDECREF(result);
2539 PyErr_SetString(PyExc_RuntimeError,
2540 "not holding the import lock");
2541 return NULL;
2542 }
2543 return result;
Guido van Rossum75acc9c1998-03-03 22:26:50 +00002544}
2545
Fred Drake87590902004-05-28 20:21:36 +00002546/* Return the package that an import is being performed in. If globals comes
2547 from the module foo.bar.bat (not itself a package), this returns the
2548 sys.modules entry for foo.bar. If globals is from a package's __init__.py,
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00002549 the package's entry in sys.modules is returned, as a borrowed reference.
Fred Drake87590902004-05-28 20:21:36 +00002550
2551 The *name* of the returned package is returned in buf, with the length of
2552 the name in *p_buflen.
2553
2554 If globals doesn't come from a package or a module in a package, or a
2555 corresponding entry is not found in sys.modules, Py_None is returned.
2556*/
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002557static PyObject *
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002558get_parent(PyObject *globals, char *buf, Py_ssize_t *p_buflen, int level)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002559{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002560 static PyObject *namestr = NULL;
2561 static PyObject *pathstr = NULL;
2562 static PyObject *pkgstr = NULL;
2563 PyObject *pkgname, *modname, *modpath, *modules, *parent;
2564 int orig_level = level;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002565
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002566 if (globals == NULL || !PyDict_Check(globals) || !level)
2567 return Py_None;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002568
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002569 if (namestr == NULL) {
2570 namestr = PyUnicode_InternFromString("__name__");
2571 if (namestr == NULL)
2572 return NULL;
2573 }
2574 if (pathstr == NULL) {
2575 pathstr = PyUnicode_InternFromString("__path__");
2576 if (pathstr == NULL)
2577 return NULL;
2578 }
2579 if (pkgstr == NULL) {
2580 pkgstr = PyUnicode_InternFromString("__package__");
2581 if (pkgstr == NULL)
2582 return NULL;
2583 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002584
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002585 *buf = '\0';
2586 *p_buflen = 0;
2587 pkgname = PyDict_GetItem(globals, pkgstr);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002588
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002589 if ((pkgname != NULL) && (pkgname != Py_None)) {
2590 /* __package__ is set, so use it */
2591 char *pkgname_str;
2592 Py_ssize_t len;
Alexandre Vassalottia85998a2008-05-03 18:24:43 +00002593
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002594 if (!PyUnicode_Check(pkgname)) {
2595 PyErr_SetString(PyExc_ValueError,
2596 "__package__ set to non-string");
2597 return NULL;
2598 }
2599 pkgname_str = _PyUnicode_AsStringAndSize(pkgname, &len);
2600 if (len == 0) {
2601 if (level > 0) {
2602 PyErr_SetString(PyExc_ValueError,
2603 "Attempted relative import in non-package");
2604 return NULL;
2605 }
2606 return Py_None;
2607 }
2608 if (len > MAXPATHLEN) {
2609 PyErr_SetString(PyExc_ValueError,
2610 "Package name too long");
2611 return NULL;
2612 }
2613 strcpy(buf, pkgname_str);
2614 } else {
2615 /* __package__ not set, so figure it out and set it */
2616 modname = PyDict_GetItem(globals, namestr);
2617 if (modname == NULL || !PyUnicode_Check(modname))
2618 return Py_None;
Brett Cannon9a5b25a2010-03-01 02:09:17 +00002619
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002620 modpath = PyDict_GetItem(globals, pathstr);
2621 if (modpath != NULL) {
2622 /* __path__ is set, so modname is already the package name */
2623 char *modname_str;
2624 Py_ssize_t len;
2625 int error;
Alexandre Vassalottia85998a2008-05-03 18:24:43 +00002626
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002627 modname_str = _PyUnicode_AsStringAndSize(modname, &len);
2628 if (len > MAXPATHLEN) {
2629 PyErr_SetString(PyExc_ValueError,
2630 "Module name too long");
2631 return NULL;
2632 }
2633 strcpy(buf, modname_str);
2634 error = PyDict_SetItem(globals, pkgstr, modname);
2635 if (error) {
2636 PyErr_SetString(PyExc_ValueError,
2637 "Could not set __package__");
2638 return NULL;
2639 }
2640 } else {
2641 /* Normal module, so work out the package name if any */
2642 char *start = _PyUnicode_AsString(modname);
2643 char *lastdot = strrchr(start, '.');
2644 size_t len;
2645 int error;
2646 if (lastdot == NULL && level > 0) {
2647 PyErr_SetString(PyExc_ValueError,
2648 "Attempted relative import in non-package");
2649 return NULL;
2650 }
2651 if (lastdot == NULL) {
2652 error = PyDict_SetItem(globals, pkgstr, Py_None);
2653 if (error) {
2654 PyErr_SetString(PyExc_ValueError,
2655 "Could not set __package__");
2656 return NULL;
2657 }
2658 return Py_None;
2659 }
2660 len = lastdot - start;
2661 if (len >= MAXPATHLEN) {
2662 PyErr_SetString(PyExc_ValueError,
2663 "Module name too long");
2664 return NULL;
2665 }
2666 strncpy(buf, start, len);
2667 buf[len] = '\0';
2668 pkgname = PyUnicode_FromString(buf);
2669 if (pkgname == NULL) {
2670 return NULL;
2671 }
2672 error = PyDict_SetItem(globals, pkgstr, pkgname);
2673 Py_DECREF(pkgname);
2674 if (error) {
2675 PyErr_SetString(PyExc_ValueError,
2676 "Could not set __package__");
2677 return NULL;
2678 }
2679 }
2680 }
2681 while (--level > 0) {
2682 char *dot = strrchr(buf, '.');
2683 if (dot == NULL) {
2684 PyErr_SetString(PyExc_ValueError,
2685 "Attempted relative import beyond "
2686 "toplevel package");
2687 return NULL;
2688 }
2689 *dot = '\0';
2690 }
2691 *p_buflen = strlen(buf);
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002692
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002693 modules = PyImport_GetModuleDict();
2694 parent = PyDict_GetItemString(modules, buf);
2695 if (parent == NULL) {
2696 if (orig_level < 1) {
2697 PyObject *err_msg = PyBytes_FromFormat(
2698 "Parent module '%.200s' not found "
2699 "while handling absolute import", buf);
2700 if (err_msg == NULL) {
2701 return NULL;
2702 }
2703 if (!PyErr_WarnEx(PyExc_RuntimeWarning,
2704 PyBytes_AsString(err_msg), 1)) {
2705 *buf = '\0';
2706 *p_buflen = 0;
2707 parent = Py_None;
2708 }
2709 Py_DECREF(err_msg);
2710 } else {
2711 PyErr_Format(PyExc_SystemError,
2712 "Parent module '%.200s' not loaded, "
2713 "cannot perform relative import", buf);
2714 }
2715 }
2716 return parent;
2717 /* We expect, but can't guarantee, if parent != None, that:
2718 - parent.__name__ == buf
2719 - parent.__dict__ is globals
2720 If this is violated... Who cares? */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002721}
2722
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002723/* altmod is either None or same as mod */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002724static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002725load_next(PyObject *mod, PyObject *altmod, char **p_name, char *buf,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002726 Py_ssize_t *p_buflen)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002727{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002728 char *name = *p_name;
2729 char *dot = strchr(name, '.');
2730 size_t len;
2731 char *p;
2732 PyObject *result;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002733
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002734 if (strlen(name) == 0) {
2735 /* completely empty module name should only happen in
2736 'from . import' (or '__import__("")')*/
2737 Py_INCREF(mod);
2738 *p_name = NULL;
2739 return mod;
2740 }
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002741
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002742 if (dot == NULL) {
2743 *p_name = NULL;
2744 len = strlen(name);
2745 }
2746 else {
2747 *p_name = dot+1;
2748 len = dot-name;
2749 }
2750 if (len == 0) {
2751 PyErr_SetString(PyExc_ValueError,
2752 "Empty module name");
2753 return NULL;
2754 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002755
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002756 p = buf + *p_buflen;
2757 if (p != buf)
2758 *p++ = '.';
2759 if (p+len-buf >= MAXPATHLEN) {
2760 PyErr_SetString(PyExc_ValueError,
2761 "Module name too long");
2762 return NULL;
2763 }
2764 strncpy(p, name, len);
2765 p[len] = '\0';
2766 *p_buflen = p+len-buf;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002767
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002768 result = import_submodule(mod, p, buf);
2769 if (result == Py_None && altmod != mod) {
2770 Py_DECREF(result);
2771 /* Here, altmod must be None and mod must not be None */
2772 result = import_submodule(altmod, p, p);
2773 if (result != NULL && result != Py_None) {
2774 if (mark_miss(buf) != 0) {
2775 Py_DECREF(result);
2776 return NULL;
2777 }
2778 strncpy(buf, name, len);
2779 buf[len] = '\0';
2780 *p_buflen = len;
2781 }
2782 }
2783 if (result == NULL)
2784 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002785
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002786 if (result == Py_None) {
2787 Py_DECREF(result);
2788 PyErr_Format(PyExc_ImportError,
2789 "No module named %.200s", name);
2790 return NULL;
2791 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002792
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002793 return result;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002794}
2795
2796static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002797mark_miss(char *name)
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00002798{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002799 PyObject *modules = PyImport_GetModuleDict();
2800 return PyDict_SetItemString(modules, name, Py_None);
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00002801}
2802
2803static int
Martin v. Löwis18e16552006-02-15 17:27:45 +00002804ensure_fromlist(PyObject *mod, PyObject *fromlist, char *buf, Py_ssize_t buflen,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002805 int recursive)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002806{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002807 int i;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002808
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002809 if (!PyObject_HasAttrString(mod, "__path__"))
2810 return 1;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002811
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002812 for (i = 0; ; i++) {
2813 PyObject *item = PySequence_GetItem(fromlist, i);
2814 int hasit;
2815 if (item == NULL) {
2816 if (PyErr_ExceptionMatches(PyExc_IndexError)) {
2817 PyErr_Clear();
2818 return 1;
2819 }
2820 return 0;
2821 }
2822 if (!PyUnicode_Check(item)) {
2823 PyErr_SetString(PyExc_TypeError,
2824 "Item in ``from list'' not a string");
2825 Py_DECREF(item);
2826 return 0;
2827 }
2828 if (PyUnicode_AS_UNICODE(item)[0] == '*') {
2829 PyObject *all;
2830 Py_DECREF(item);
2831 /* See if the package defines __all__ */
2832 if (recursive)
2833 continue; /* Avoid endless recursion */
2834 all = PyObject_GetAttrString(mod, "__all__");
2835 if (all == NULL)
2836 PyErr_Clear();
2837 else {
2838 int ret = ensure_fromlist(mod, all, buf, buflen, 1);
2839 Py_DECREF(all);
2840 if (!ret)
2841 return 0;
2842 }
2843 continue;
2844 }
2845 hasit = PyObject_HasAttr(mod, item);
2846 if (!hasit) {
2847 PyObject *item8;
2848 char *subname;
2849 PyObject *submod;
2850 char *p;
Victor Stinnerae6265f2010-05-15 16:27:27 +00002851 item8 = PyUnicode_EncodeFSDefault(item);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002852 if (!item8) {
2853 PyErr_SetString(PyExc_ValueError, "Cannot encode path item");
2854 return 0;
2855 }
2856 subname = PyBytes_AS_STRING(item8);
2857 if (buflen + strlen(subname) >= MAXPATHLEN) {
2858 PyErr_SetString(PyExc_ValueError,
2859 "Module name too long");
2860 Py_DECREF(item);
2861 return 0;
2862 }
2863 p = buf + buflen;
2864 *p++ = '.';
2865 strcpy(p, subname);
2866 submod = import_submodule(mod, subname, buf);
2867 Py_DECREF(item8);
2868 Py_XDECREF(submod);
2869 if (submod == NULL) {
2870 Py_DECREF(item);
2871 return 0;
2872 }
2873 }
2874 Py_DECREF(item);
2875 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002876
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002877 /* NOTREACHED */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002878}
2879
Neil Schemenauer00b09662003-06-16 21:03:07 +00002880static int
2881add_submodule(PyObject *mod, PyObject *submod, char *fullname, char *subname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002882 PyObject *modules)
Neil Schemenauer00b09662003-06-16 21:03:07 +00002883{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002884 if (mod == Py_None)
2885 return 1;
2886 /* Irrespective of the success of this load, make a
2887 reference to it in the parent package module. A copy gets
2888 saved in the modules dictionary under the full name, so get a
2889 reference from there, if need be. (The exception is when the
2890 load failed with a SyntaxError -- then there's no trace in
2891 sys.modules. In that case, of course, do nothing extra.) */
2892 if (submod == NULL) {
2893 submod = PyDict_GetItemString(modules, fullname);
2894 if (submod == NULL)
2895 return 1;
2896 }
2897 if (PyModule_Check(mod)) {
2898 /* We can't use setattr here since it can give a
2899 * spurious warning if the submodule name shadows a
2900 * builtin name */
2901 PyObject *dict = PyModule_GetDict(mod);
2902 if (!dict)
2903 return 0;
2904 if (PyDict_SetItemString(dict, subname, submod) < 0)
2905 return 0;
2906 }
2907 else {
2908 if (PyObject_SetAttrString(mod, subname, submod) < 0)
2909 return 0;
2910 }
2911 return 1;
Neil Schemenauer00b09662003-06-16 21:03:07 +00002912}
2913
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002914static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002915import_submodule(PyObject *mod, char *subname, char *fullname)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002916{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002917 PyObject *modules = PyImport_GetModuleDict();
2918 PyObject *m = NULL;
Guido van Rossum74e6a111994-08-29 12:54:38 +00002919
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002920 /* Require:
2921 if mod == None: subname == fullname
2922 else: mod.__name__ + "." + subname == fullname
2923 */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002924
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002925 if ((m = PyDict_GetItemString(modules, fullname)) != NULL) {
2926 Py_INCREF(m);
2927 }
2928 else {
2929 PyObject *path, *loader = NULL;
Gregory P. Smithc809f982012-03-18 16:06:53 -07002930 char *buf;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002931 struct filedescr *fdp;
2932 FILE *fp = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002933
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002934 if (mod == Py_None)
2935 path = NULL;
2936 else {
2937 path = PyObject_GetAttrString(mod, "__path__");
2938 if (path == NULL) {
2939 PyErr_Clear();
2940 Py_INCREF(Py_None);
2941 return Py_None;
2942 }
2943 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002944
Gregory P. Smithc809f982012-03-18 16:06:53 -07002945 buf = PyMem_MALLOC(MAXPATHLEN+1);
2946 if (buf == NULL) {
2947 return PyErr_NoMemory();
2948 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002949 buf[0] = '\0';
2950 fdp = find_module(fullname, subname, path, buf, MAXPATHLEN+1,
2951 &fp, &loader);
2952 Py_XDECREF(path);
2953 if (fdp == NULL) {
Gregory P. Smithc809f982012-03-18 16:06:53 -07002954 PyMem_FREE(buf);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002955 if (!PyErr_ExceptionMatches(PyExc_ImportError))
2956 return NULL;
2957 PyErr_Clear();
2958 Py_INCREF(Py_None);
2959 return Py_None;
2960 }
2961 m = load_module(fullname, fp, buf, fdp->type, loader);
2962 Py_XDECREF(loader);
2963 if (fp)
2964 fclose(fp);
2965 if (!add_submodule(mod, m, fullname, subname, modules)) {
2966 Py_XDECREF(m);
2967 m = NULL;
2968 }
Gregory P. Smithc809f982012-03-18 16:06:53 -07002969 PyMem_FREE(buf);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002970 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002971
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002972 return m;
Guido van Rossum74e6a111994-08-29 12:54:38 +00002973}
2974
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002975
2976/* Re-import a module of any kind and return its module object, WITH
2977 INCREMENTED REFERENCE COUNT */
2978
Guido van Rossum79f25d91997-04-29 20:08:16 +00002979PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002980PyImport_ReloadModule(PyObject *m)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002981{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002982 PyInterpreterState *interp = PyThreadState_Get()->interp;
2983 PyObject *modules_reloading = interp->modules_reloading;
2984 PyObject *modules = PyImport_GetModuleDict();
2985 PyObject *path = NULL, *loader = NULL, *existing_m = NULL;
2986 char *name, *subname;
Gregory P. Smithc809f982012-03-18 16:06:53 -07002987 char *buf;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002988 struct filedescr *fdp;
2989 FILE *fp = NULL;
2990 PyObject *newm;
Brett Cannon9a5b25a2010-03-01 02:09:17 +00002991
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002992 if (modules_reloading == NULL) {
2993 Py_FatalError("PyImport_ReloadModule: "
2994 "no modules_reloading dictionary!");
2995 return NULL;
2996 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002997
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002998 if (m == NULL || !PyModule_Check(m)) {
2999 PyErr_SetString(PyExc_TypeError,
3000 "reload() argument must be module");
3001 return NULL;
3002 }
3003 name = (char*)PyModule_GetName(m);
3004 if (name == NULL)
3005 return NULL;
3006 if (m != PyDict_GetItemString(modules, name)) {
3007 PyErr_Format(PyExc_ImportError,
3008 "reload(): module %.200s not in sys.modules",
3009 name);
3010 return NULL;
3011 }
3012 existing_m = PyDict_GetItemString(modules_reloading, name);
3013 if (existing_m != NULL) {
3014 /* Due to a recursive reload, this module is already
3015 being reloaded. */
3016 Py_INCREF(existing_m);
3017 return existing_m;
3018 }
3019 if (PyDict_SetItemString(modules_reloading, name, m) < 0)
3020 return NULL;
Guido van Rossumd8faa362007-04-27 19:54:29 +00003021
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003022 subname = strrchr(name, '.');
3023 if (subname == NULL)
3024 subname = name;
3025 else {
3026 PyObject *parentname, *parent;
3027 parentname = PyUnicode_FromStringAndSize(name, (subname-name));
3028 if (parentname == NULL) {
3029 imp_modules_reloading_clear();
3030 return NULL;
3031 }
3032 parent = PyDict_GetItem(modules, parentname);
3033 if (parent == NULL) {
3034 PyErr_Format(PyExc_ImportError,
3035 "reload(): parent %U not in sys.modules",
3036 parentname);
3037 Py_DECREF(parentname);
3038 imp_modules_reloading_clear();
3039 return NULL;
3040 }
3041 Py_DECREF(parentname);
3042 subname++;
3043 path = PyObject_GetAttrString(parent, "__path__");
3044 if (path == NULL)
3045 PyErr_Clear();
3046 }
Gregory P. Smithc809f982012-03-18 16:06:53 -07003047 buf = PyMem_MALLOC(MAXPATHLEN+1);
3048 if (buf == NULL) {
3049 Py_XDECREF(path);
3050 return PyErr_NoMemory();
3051 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003052 buf[0] = '\0';
3053 fdp = find_module(name, subname, path, buf, MAXPATHLEN+1, &fp, &loader);
3054 Py_XDECREF(path);
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00003055
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003056 if (fdp == NULL) {
3057 Py_XDECREF(loader);
3058 imp_modules_reloading_clear();
Gregory P. Smithc809f982012-03-18 16:06:53 -07003059 PyMem_FREE(buf);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003060 return NULL;
3061 }
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00003062
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003063 newm = load_module(name, fp, buf, fdp->type, loader);
3064 Py_XDECREF(loader);
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00003065
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003066 if (fp)
3067 fclose(fp);
3068 if (newm == NULL) {
3069 /* load_module probably removed name from modules because of
3070 * the error. Put back the original module object. We're
3071 * going to return NULL in this case regardless of whether
3072 * replacing name succeeds, so the return value is ignored.
3073 */
3074 PyDict_SetItemString(modules, name, m);
3075 }
3076 imp_modules_reloading_clear();
Gregory P. Smithc809f982012-03-18 16:06:53 -07003077 PyMem_FREE(buf);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003078 return newm;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003079}
3080
3081
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003082/* Higher-level import emulator which emulates the "import" statement
3083 more accurately -- it invokes the __import__() function from the
3084 builtins of the current globals. This means that the import is
3085 done using whatever import hooks are installed in the current
Brett Cannonbc2eff32010-09-19 21:39:02 +00003086 environment.
Guido van Rossum6058eb41998-12-21 19:51:00 +00003087 A dummy list ["__doc__"] is passed as the 4th argument so that
Neal Norwitz80e7f272007-08-26 06:45:23 +00003088 e.g. PyImport_Import(PyUnicode_FromString("win32com.client.gencache"))
Guido van Rossum6058eb41998-12-21 19:51:00 +00003089 will return <module "gencache"> instead of <module "win32com">. */
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003090
3091PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003092PyImport_Import(PyObject *module_name)
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003093{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003094 static PyObject *silly_list = NULL;
3095 static PyObject *builtins_str = NULL;
3096 static PyObject *import_str = NULL;
3097 PyObject *globals = NULL;
3098 PyObject *import = NULL;
3099 PyObject *builtins = NULL;
Brett Cannonbc2eff32010-09-19 21:39:02 +00003100 PyObject *modules = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003101 PyObject *r = NULL;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003102
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003103 /* Initialize constant string objects */
3104 if (silly_list == NULL) {
3105 import_str = PyUnicode_InternFromString("__import__");
3106 if (import_str == NULL)
3107 return NULL;
3108 builtins_str = PyUnicode_InternFromString("__builtins__");
3109 if (builtins_str == NULL)
3110 return NULL;
Brett Cannonbc2eff32010-09-19 21:39:02 +00003111 silly_list = PyList_New(0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003112 if (silly_list == NULL)
3113 return NULL;
3114 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003115
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003116 /* Get the builtins from current globals */
3117 globals = PyEval_GetGlobals();
3118 if (globals != NULL) {
3119 Py_INCREF(globals);
3120 builtins = PyObject_GetItem(globals, builtins_str);
3121 if (builtins == NULL)
3122 goto err;
3123 }
3124 else {
3125 /* No globals -- use standard builtins, and fake globals */
3126 builtins = PyImport_ImportModuleLevel("builtins",
3127 NULL, NULL, NULL, 0);
3128 if (builtins == NULL)
3129 return NULL;
3130 globals = Py_BuildValue("{OO}", builtins_str, builtins);
3131 if (globals == NULL)
3132 goto err;
3133 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003134
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003135 /* Get the __import__ function from the builtins */
3136 if (PyDict_Check(builtins)) {
3137 import = PyObject_GetItem(builtins, import_str);
3138 if (import == NULL)
3139 PyErr_SetObject(PyExc_KeyError, import_str);
3140 }
3141 else
3142 import = PyObject_GetAttr(builtins, import_str);
3143 if (import == NULL)
3144 goto err;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003145
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003146 /* Call the __import__ function with the proper argument list
Brett Cannonbc2eff32010-09-19 21:39:02 +00003147 Always use absolute import here.
3148 Calling for side-effect of import. */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003149 r = PyObject_CallFunction(import, "OOOOi", module_name, globals,
3150 globals, silly_list, 0, NULL);
Brett Cannonbc2eff32010-09-19 21:39:02 +00003151 if (r == NULL)
3152 goto err;
3153 Py_DECREF(r);
3154
3155 modules = PyImport_GetModuleDict();
3156 r = PyDict_GetItem(modules, module_name);
3157 if (r != NULL)
3158 Py_INCREF(r);
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003159
3160 err:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003161 Py_XDECREF(globals);
3162 Py_XDECREF(builtins);
3163 Py_XDECREF(import);
Tim Peters50d8d372001-02-28 05:34:27 +00003164
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003165 return r;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003166}
3167
3168
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003169/* Module 'imp' provides Python access to the primitives used for
3170 importing modules.
3171*/
3172
Guido van Rossum79f25d91997-04-29 20:08:16 +00003173static PyObject *
Barry Warsaw28a691b2010-04-17 00:19:56 +00003174imp_make_magic(long magic)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003175{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003176 char buf[4];
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003177
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003178 buf[0] = (char) ((magic >> 0) & 0xff);
3179 buf[1] = (char) ((magic >> 8) & 0xff);
3180 buf[2] = (char) ((magic >> 16) & 0xff);
3181 buf[3] = (char) ((magic >> 24) & 0xff);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003182
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003183 return PyBytes_FromStringAndSize(buf, 4);
Victor Stinner3e2b7172010-11-09 09:32:19 +00003184}
Barry Warsaw28a691b2010-04-17 00:19:56 +00003185
3186static PyObject *
3187imp_get_magic(PyObject *self, PyObject *noargs)
3188{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003189 return imp_make_magic(pyc_magic);
Barry Warsaw28a691b2010-04-17 00:19:56 +00003190}
3191
3192static PyObject *
3193imp_get_tag(PyObject *self, PyObject *noargs)
3194{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003195 return PyUnicode_FromString(pyc_tag);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003196}
3197
Guido van Rossum79f25d91997-04-29 20:08:16 +00003198static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +00003199imp_get_suffixes(PyObject *self, PyObject *noargs)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003200{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003201 PyObject *list;
3202 struct filedescr *fdp;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003203
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003204 list = PyList_New(0);
3205 if (list == NULL)
3206 return NULL;
3207 for (fdp = _PyImport_Filetab; fdp->suffix != NULL; fdp++) {
3208 PyObject *item = Py_BuildValue("ssi",
3209 fdp->suffix, fdp->mode, fdp->type);
3210 if (item == NULL) {
3211 Py_DECREF(list);
3212 return NULL;
3213 }
3214 if (PyList_Append(list, item) < 0) {
3215 Py_DECREF(list);
3216 Py_DECREF(item);
3217 return NULL;
3218 }
3219 Py_DECREF(item);
3220 }
3221 return list;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003222}
3223
Guido van Rossum79f25d91997-04-29 20:08:16 +00003224static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003225call_find_module(char *name, PyObject *path)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003226{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003227 extern int fclose(FILE *);
3228 PyObject *fob, *ret;
3229 PyObject *pathobj;
3230 struct filedescr *fdp;
Gregory P. Smithc809f982012-03-18 16:06:53 -07003231 char *pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003232 FILE *fp = NULL;
3233 int fd = -1;
3234 char *found_encoding = NULL;
3235 char *encoding = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003236
Gregory P. Smithc809f982012-03-18 16:06:53 -07003237 pathname = PyMem_MALLOC(MAXPATHLEN+1);
3238 if (pathname == NULL) {
3239 return PyErr_NoMemory();
3240 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003241 pathname[0] = '\0';
3242 if (path == Py_None)
3243 path = NULL;
3244 fdp = find_module(NULL, name, path, pathname, MAXPATHLEN+1, &fp, NULL);
3245 if (fdp == NULL)
Gregory P. Smithc809f982012-03-18 16:06:53 -07003246 goto error_exit;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003247 if (fp != NULL) {
3248 fd = fileno(fp);
3249 if (fd != -1)
3250 fd = dup(fd);
3251 fclose(fp);
3252 fp = NULL;
Gregory P. Smithc809f982012-03-18 16:06:53 -07003253 if (fd == -1) {
3254 PyErr_SetFromErrno(PyExc_OSError);
3255 goto error_exit;
3256 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003257 }
3258 if (fd != -1) {
3259 if (strchr(fdp->mode, 'b') == NULL) {
3260 /* PyTokenizer_FindEncoding() returns PyMem_MALLOC'ed
3261 memory. */
3262 found_encoding = PyTokenizer_FindEncoding(fd);
3263 lseek(fd, 0, 0); /* Reset position */
Antoine Pitrou4f22a8d2012-02-22 18:05:43 +01003264 if (found_encoding == NULL && PyErr_Occurred()) {
3265 close(fd);
Gregory P. Smithc809f982012-03-18 16:06:53 -07003266 goto error_exit;
Antoine Pitrou4f22a8d2012-02-22 18:05:43 +01003267 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003268 encoding = (found_encoding != NULL) ? found_encoding :
3269 (char*)PyUnicode_GetDefaultEncoding();
3270 }
3271 fob = PyFile_FromFd(fd, pathname, fdp->mode, -1,
3272 (char*)encoding, NULL, NULL, 1);
3273 if (fob == NULL) {
3274 close(fd);
3275 PyMem_FREE(found_encoding);
Gregory P. Smithc809f982012-03-18 16:06:53 -07003276 goto error_exit;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003277 }
3278 }
3279 else {
3280 fob = Py_None;
3281 Py_INCREF(fob);
3282 }
3283 pathobj = PyUnicode_DecodeFSDefault(pathname);
3284 ret = Py_BuildValue("NN(ssi)",
3285 fob, pathobj, fdp->suffix, fdp->mode, fdp->type);
3286 PyMem_FREE(found_encoding);
Gregory P. Smithc809f982012-03-18 16:06:53 -07003287 PyMem_FREE(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003288 return ret;
Gregory P. Smithc809f982012-03-18 16:06:53 -07003289
3290error_exit:
3291 PyMem_FREE(pathname);
3292 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003293}
3294
Guido van Rossum79f25d91997-04-29 20:08:16 +00003295static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003296imp_find_module(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003297{
Victor Stinnerebc00522010-12-03 17:06:43 +00003298 PyObject *name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003299 PyObject *ret, *path = NULL;
Victor Stinnerebc00522010-12-03 17:06:43 +00003300 if (!PyArg_ParseTuple(args, "O&|O:find_module",
3301 PyUnicode_FSConverter, &name,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003302 &path))
3303 return NULL;
Victor Stinnerebc00522010-12-03 17:06:43 +00003304 ret = call_find_module(PyBytes_AS_STRING(name), path);
3305 Py_DECREF(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003306 return ret;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003307}
3308
3309static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003310imp_init_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003311{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003312 char *name;
3313 int ret;
3314 PyObject *m;
3315 if (!PyArg_ParseTuple(args, "s:init_builtin", &name))
3316 return NULL;
3317 ret = init_builtin(name);
3318 if (ret < 0)
3319 return NULL;
3320 if (ret == 0) {
3321 Py_INCREF(Py_None);
3322 return Py_None;
3323 }
3324 m = PyImport_AddModule(name);
3325 Py_XINCREF(m);
3326 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003327}
3328
Guido van Rossum79f25d91997-04-29 20:08:16 +00003329static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003330imp_init_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003331{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003332 char *name;
3333 int ret;
3334 PyObject *m;
3335 if (!PyArg_ParseTuple(args, "s:init_frozen", &name))
3336 return NULL;
3337 ret = PyImport_ImportFrozenModule(name);
3338 if (ret < 0)
3339 return NULL;
3340 if (ret == 0) {
3341 Py_INCREF(Py_None);
3342 return Py_None;
3343 }
3344 m = PyImport_AddModule(name);
3345 Py_XINCREF(m);
3346 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003347}
3348
Guido van Rossum79f25d91997-04-29 20:08:16 +00003349static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003350imp_get_frozen_object(PyObject *self, PyObject *args)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00003351{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003352 char *name;
Jack Jansen95ffa231995-10-03 14:38:41 +00003353
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003354 if (!PyArg_ParseTuple(args, "s:get_frozen_object", &name))
3355 return NULL;
3356 return get_frozen_object(name);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00003357}
3358
Guido van Rossum79f25d91997-04-29 20:08:16 +00003359static PyObject *
Brett Cannon8d110132009-03-15 02:20:16 +00003360imp_is_frozen_package(PyObject *self, PyObject *args)
3361{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003362 char *name;
Brett Cannon8d110132009-03-15 02:20:16 +00003363
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003364 if (!PyArg_ParseTuple(args, "s:is_frozen_package", &name))
3365 return NULL;
3366 return is_frozen_package(name);
Brett Cannon8d110132009-03-15 02:20:16 +00003367}
3368
3369static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003370imp_is_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003371{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003372 char *name;
3373 if (!PyArg_ParseTuple(args, "s:is_builtin", &name))
3374 return NULL;
3375 return PyLong_FromLong(is_builtin(name));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003376}
3377
Guido van Rossum79f25d91997-04-29 20:08:16 +00003378static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003379imp_is_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003380{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003381 char *name;
3382 struct _frozen *p;
3383 if (!PyArg_ParseTuple(args, "s:is_frozen", &name))
3384 return NULL;
3385 p = find_frozen(name);
3386 return PyBool_FromLong((long) (p == NULL ? 0 : p->size));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003387}
3388
3389static FILE *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003390get_file(char *pathname, PyObject *fob, char *mode)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003391{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003392 FILE *fp;
3393 if (mode[0] == 'U')
3394 mode = "r" PY_STDIOTEXTMODE;
3395 if (fob == NULL) {
3396 fp = fopen(pathname, mode);
3397 }
3398 else {
3399 int fd = PyObject_AsFileDescriptor(fob);
3400 if (fd == -1)
3401 return NULL;
3402 if (!_PyVerify_fd(fd))
3403 goto error;
3404 /* the FILE struct gets a new fd, so that it can be closed
3405 * independently of the file descriptor given
3406 */
3407 fd = dup(fd);
3408 if (fd == -1)
3409 goto error;
3410 fp = fdopen(fd, mode);
3411 }
3412 if (fp)
3413 return fp;
Kristján Valur Jónssone1b04452009-03-31 17:43:39 +00003414error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003415 PyErr_SetFromErrno(PyExc_IOError);
3416 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003417}
3418
Guido van Rossum79f25d91997-04-29 20:08:16 +00003419static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003420imp_load_compiled(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003421{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003422 char *name;
Victor Stinnerebc00522010-12-03 17:06:43 +00003423 PyObject *pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003424 PyObject *fob = NULL;
3425 PyObject *m;
3426 FILE *fp;
Victor Stinnerebc00522010-12-03 17:06:43 +00003427 if (!PyArg_ParseTuple(args, "sO&|O:load_compiled",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003428 &name,
Victor Stinnerebc00522010-12-03 17:06:43 +00003429 PyUnicode_FSConverter, &pathname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003430 &fob))
3431 return NULL;
Victor Stinnerebc00522010-12-03 17:06:43 +00003432 fp = get_file(PyBytes_AS_STRING(pathname), fob, "rb");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003433 if (fp == NULL) {
Victor Stinnerebc00522010-12-03 17:06:43 +00003434 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003435 return NULL;
3436 }
Victor Stinnerebc00522010-12-03 17:06:43 +00003437 m = load_compiled_module(name, PyBytes_AS_STRING(pathname), fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003438 fclose(fp);
Victor Stinnerebc00522010-12-03 17:06:43 +00003439 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003440 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003441}
3442
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003443#ifdef HAVE_DYNAMIC_LOADING
3444
Guido van Rossum79f25d91997-04-29 20:08:16 +00003445static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003446imp_load_dynamic(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003447{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003448 char *name;
Victor Stinner8dbf6292010-10-15 12:48:01 +00003449 PyObject *pathbytes;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003450 char *pathname;
3451 PyObject *fob = NULL;
3452 PyObject *m;
3453 FILE *fp = NULL;
Victor Stinner8dbf6292010-10-15 12:48:01 +00003454 if (!PyArg_ParseTuple(args, "sO&|O:load_dynamic",
3455 &name, PyUnicode_FSConverter, &pathbytes, &fob))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003456 return NULL;
Victor Stinner8dbf6292010-10-15 12:48:01 +00003457 pathname = PyBytes_AS_STRING(pathbytes);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003458 if (fob) {
3459 fp = get_file(pathname, fob, "r");
3460 if (fp == NULL) {
Victor Stinner8dbf6292010-10-15 12:48:01 +00003461 Py_DECREF(pathbytes);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003462 return NULL;
3463 }
3464 }
3465 m = _PyImport_LoadDynamicModule(name, pathname, fp);
Victor Stinner8dbf6292010-10-15 12:48:01 +00003466 Py_DECREF(pathbytes);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003467 if (fp)
3468 fclose(fp);
3469 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003470}
3471
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003472#endif /* HAVE_DYNAMIC_LOADING */
3473
Guido van Rossum79f25d91997-04-29 20:08:16 +00003474static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003475imp_load_source(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003476{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003477 char *name;
Victor Stinnerebc00522010-12-03 17:06:43 +00003478 PyObject *pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003479 PyObject *fob = NULL;
3480 PyObject *m;
3481 FILE *fp;
Victor Stinnerebc00522010-12-03 17:06:43 +00003482 if (!PyArg_ParseTuple(args, "sO&|O:load_source",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003483 &name,
Victor Stinnerebc00522010-12-03 17:06:43 +00003484 PyUnicode_FSConverter, &pathname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003485 &fob))
3486 return NULL;
Victor Stinnerebc00522010-12-03 17:06:43 +00003487 fp = get_file(PyBytes_AS_STRING(pathname), fob, "r");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003488 if (fp == NULL) {
Victor Stinnerebc00522010-12-03 17:06:43 +00003489 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003490 return NULL;
3491 }
Victor Stinnerebc00522010-12-03 17:06:43 +00003492 m = load_source_module(name, PyBytes_AS_STRING(pathname), fp);
3493 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003494 fclose(fp);
3495 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003496}
3497
Guido van Rossum79f25d91997-04-29 20:08:16 +00003498static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003499imp_load_module(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003500{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003501 char *name;
3502 PyObject *fob;
Victor Stinner1a563032010-10-15 22:43:10 +00003503 PyObject *pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003504 PyObject * ret;
3505 char *suffix; /* Unused */
3506 char *mode;
3507 int type;
3508 FILE *fp;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003509
Victor Stinner1a563032010-10-15 22:43:10 +00003510 if (!PyArg_ParseTuple(args, "sOO&(ssi):load_module",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003511 &name, &fob,
Victor Stinner1a563032010-10-15 22:43:10 +00003512 PyUnicode_FSConverter, &pathname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003513 &suffix, &mode, &type))
3514 return NULL;
3515 if (*mode) {
3516 /* Mode must start with 'r' or 'U' and must not contain '+'.
3517 Implicit in this test is the assumption that the mode
3518 may contain other modifiers like 'b' or 't'. */
Guido van Rossum5e2c5fa2002-05-30 17:33:07 +00003519
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003520 if (!(*mode == 'r' || *mode == 'U') || strchr(mode, '+')) {
3521 PyErr_Format(PyExc_ValueError,
3522 "invalid file open mode %.200s", mode);
Victor Stinner1a563032010-10-15 22:43:10 +00003523 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003524 return NULL;
3525 }
3526 }
3527 if (fob == Py_None)
3528 fp = NULL;
3529 else {
3530 fp = get_file(NULL, fob, mode);
3531 if (fp == NULL) {
Victor Stinner1a563032010-10-15 22:43:10 +00003532 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003533 return NULL;
3534 }
3535 }
Victor Stinner1a563032010-10-15 22:43:10 +00003536 ret = load_module(name, fp, PyBytes_AS_STRING(pathname), type, NULL);
3537 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003538 if (fp)
3539 fclose(fp);
3540 return ret;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003541}
3542
3543static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003544imp_load_package(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003545{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003546 char *name;
Victor Stinnerebc00522010-12-03 17:06:43 +00003547 PyObject *pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003548 PyObject * ret;
Victor Stinnerebc00522010-12-03 17:06:43 +00003549 if (!PyArg_ParseTuple(args, "sO&:load_package",
3550 &name, PyUnicode_FSConverter, &pathname))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003551 return NULL;
Victor Stinnerebc00522010-12-03 17:06:43 +00003552 ret = load_package(name, PyBytes_AS_STRING(pathname));
3553 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003554 return ret;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003555}
3556
3557static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003558imp_new_module(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003559{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003560 char *name;
3561 if (!PyArg_ParseTuple(args, "s:new_module", &name))
3562 return NULL;
3563 return PyModule_New(name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003564}
3565
Christian Heimes13a7a212008-01-07 17:13:09 +00003566static PyObject *
3567imp_reload(PyObject *self, PyObject *v)
3568{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003569 return PyImport_ReloadModule(v);
Christian Heimes13a7a212008-01-07 17:13:09 +00003570}
3571
3572PyDoc_STRVAR(doc_reload,
3573"reload(module) -> module\n\
3574\n\
3575Reload the module. The module must have been successfully imported before.");
3576
Barry Warsaw28a691b2010-04-17 00:19:56 +00003577static PyObject *
3578imp_cache_from_source(PyObject *self, PyObject *args, PyObject *kws)
3579{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003580 static char *kwlist[] = {"path", "debug_override", NULL};
Barry Warsaw28a691b2010-04-17 00:19:56 +00003581
Gregory P. Smithc809f982012-03-18 16:06:53 -07003582 char *buf;
Victor Stinner3ea23dd2010-10-15 20:34:32 +00003583 PyObject *pathbytes;
3584 char *cpathname;
Benjamin Peterson294a9fc2010-10-16 03:12:39 +00003585 PyObject *debug_override = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003586 int debug = !Py_OptimizeFlag;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003587
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003588 if (!PyArg_ParseTupleAndKeywords(
Victor Stinner3ea23dd2010-10-15 20:34:32 +00003589 args, kws, "O&|O", kwlist,
3590 PyUnicode_FSConverter, &pathbytes, &debug_override))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003591 return NULL;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003592
Benjamin Peterson294a9fc2010-10-16 03:12:39 +00003593 if (debug_override != NULL &&
3594 (debug = PyObject_IsTrue(debug_override)) < 0) {
3595 Py_DECREF(pathbytes);
3596 return NULL;
3597 }
Barry Warsaw28a691b2010-04-17 00:19:56 +00003598
Gregory P. Smithc809f982012-03-18 16:06:53 -07003599 buf = PyMem_MALLOC(MAXPATHLEN+1);
3600 if (buf == NULL) {
3601 return PyErr_NoMemory();
3602 }
Victor Stinner3ea23dd2010-10-15 20:34:32 +00003603 cpathname = make_compiled_pathname(
3604 PyBytes_AS_STRING(pathbytes),
3605 buf, MAXPATHLEN+1, debug);
3606 Py_DECREF(pathbytes);
Barry Warsaw28a691b2010-04-17 00:19:56 +00003607
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003608 if (cpathname == NULL) {
3609 PyErr_Format(PyExc_SystemError, "path buffer too short");
Gregory P. Smithc809f982012-03-18 16:06:53 -07003610 PyMem_FREE(buf);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003611 return NULL;
3612 }
Gregory P. Smithc809f982012-03-18 16:06:53 -07003613 {
3614 PyObject *ret = PyUnicode_DecodeFSDefault(buf);
3615 PyMem_FREE(buf);
3616 return ret;
3617 }
Barry Warsaw28a691b2010-04-17 00:19:56 +00003618}
3619
3620PyDoc_STRVAR(doc_cache_from_source,
Éric Araujo5df11082011-11-03 03:38:44 +01003621"cache_from_source(path, [debug_override]) -> path\n\
3622Given the path to a .py file, return the path to its .pyc/.pyo file.\n\
Barry Warsaw28a691b2010-04-17 00:19:56 +00003623\n\
3624The .py file does not need to exist; this simply returns the path to the\n\
3625.pyc/.pyo file calculated as if the .py file were imported. The extension\n\
3626will be .pyc unless __debug__ is not defined, then it will be .pyo.\n\
3627\n\
3628If debug_override is not None, then it must be a boolean and is taken as\n\
3629the value of __debug__ instead.");
3630
3631static PyObject *
3632imp_source_from_cache(PyObject *self, PyObject *args, PyObject *kws)
3633{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003634 static char *kwlist[] = {"path", NULL};
Barry Warsaw28a691b2010-04-17 00:19:56 +00003635
Victor Stinnerebc00522010-12-03 17:06:43 +00003636 PyObject *pathname_obj;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003637 char *pathname;
Gregory P. Smithc809f982012-03-18 16:06:53 -07003638 char *buf;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003639
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003640 if (!PyArg_ParseTupleAndKeywords(
Victor Stinnerebc00522010-12-03 17:06:43 +00003641 args, kws, "O&", kwlist,
3642 PyUnicode_FSConverter, &pathname_obj))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003643 return NULL;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003644
Victor Stinnerebc00522010-12-03 17:06:43 +00003645 pathname = PyBytes_AS_STRING(pathname_obj);
Gregory P. Smithc809f982012-03-18 16:06:53 -07003646 buf = PyMem_MALLOC(MAXPATHLEN+1);
3647 if (buf == NULL) {
3648 return PyErr_NoMemory();
3649 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003650 if (make_source_pathname(pathname, buf) == NULL) {
3651 PyErr_Format(PyExc_ValueError, "Not a PEP 3147 pyc path: %s",
3652 pathname);
Victor Stinnerebc00522010-12-03 17:06:43 +00003653 Py_DECREF(pathname_obj);
Gregory P. Smithc809f982012-03-18 16:06:53 -07003654 PyMem_FREE(buf);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003655 return NULL;
3656 }
Victor Stinnerebc00522010-12-03 17:06:43 +00003657 Py_DECREF(pathname_obj);
Gregory P. Smithc809f982012-03-18 16:06:53 -07003658 {
3659 PyObject *ret = PyUnicode_FromString(buf);
3660 PyMem_FREE(buf);
3661 return ret;
3662 }
Barry Warsaw28a691b2010-04-17 00:19:56 +00003663}
3664
3665PyDoc_STRVAR(doc_source_from_cache,
Éric Araujo5df11082011-11-03 03:38:44 +01003666"source_from_cache(path) -> path\n\
3667Given the path to a .pyc./.pyo file, return the path to its .py file.\n\
Barry Warsaw28a691b2010-04-17 00:19:56 +00003668\n\
3669The .pyc/.pyo file does not need to exist; this simply returns the path to\n\
3670the .py file calculated to correspond to the .pyc/.pyo file. If path\n\
3671does not conform to PEP 3147 format, ValueError will be raised.");
3672
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003673/* Doc strings */
3674
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003675PyDoc_STRVAR(doc_imp,
3676"This module provides the components needed to build your own\n\
3677__import__ function. Undocumented functions are obsolete.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003678
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003679PyDoc_STRVAR(doc_find_module,
3680"find_module(name, [path]) -> (file, filename, (suffix, mode, type))\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003681Search for a module. If path is omitted or None, search for a\n\
3682built-in, frozen or special module and continue search in sys.path.\n\
3683The module name cannot contain '.'; to search for a submodule of a\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003684package, pass the submodule name and the package's __path__.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003685
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003686PyDoc_STRVAR(doc_load_module,
3687"load_module(name, file, filename, (suffix, mode, type)) -> module\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003688Load a module, given information returned by find_module().\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003689The module name must include the full package name, if any.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003690
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003691PyDoc_STRVAR(doc_get_magic,
3692"get_magic() -> string\n\
3693Return the magic number for .pyc or .pyo files.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003694
Barry Warsaw28a691b2010-04-17 00:19:56 +00003695PyDoc_STRVAR(doc_get_tag,
3696"get_tag() -> string\n\
3697Return the magic tag for .pyc or .pyo files.");
3698
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003699PyDoc_STRVAR(doc_get_suffixes,
3700"get_suffixes() -> [(suffix, mode, type), ...]\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003701Return a list of (suffix, mode, type) tuples describing the files\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003702that find_module() looks for.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003703
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003704PyDoc_STRVAR(doc_new_module,
3705"new_module(name) -> module\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003706Create a new module. Do not enter it in sys.modules.\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003707The module name must include the full package name, if any.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003708
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003709PyDoc_STRVAR(doc_lock_held,
Tim Petersa7c65092004-08-01 23:26:05 +00003710"lock_held() -> boolean\n\
3711Return True if the import lock is currently held, else False.\n\
3712On platforms without threads, return False.");
Tim Peters69232342001-08-30 05:16:13 +00003713
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00003714PyDoc_STRVAR(doc_acquire_lock,
3715"acquire_lock() -> None\n\
Neal Norwitz2294c0d2003-02-12 23:02:21 +00003716Acquires the interpreter's import lock for the current thread.\n\
3717This lock should be used by import hooks to ensure thread-safety\n\
3718when importing modules.\n\
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00003719On platforms without threads, this function does nothing.");
3720
3721PyDoc_STRVAR(doc_release_lock,
3722"release_lock() -> None\n\
3723Release the interpreter's import lock.\n\
3724On platforms without threads, this function does nothing.");
3725
Guido van Rossum79f25d91997-04-29 20:08:16 +00003726static PyMethodDef imp_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003727 {"find_module", imp_find_module, METH_VARARGS, doc_find_module},
3728 {"get_magic", imp_get_magic, METH_NOARGS, doc_get_magic},
3729 {"get_tag", imp_get_tag, METH_NOARGS, doc_get_tag},
3730 {"get_suffixes", imp_get_suffixes, METH_NOARGS, doc_get_suffixes},
3731 {"load_module", imp_load_module, METH_VARARGS, doc_load_module},
3732 {"new_module", imp_new_module, METH_VARARGS, doc_new_module},
3733 {"lock_held", imp_lock_held, METH_NOARGS, doc_lock_held},
3734 {"acquire_lock", imp_acquire_lock, METH_NOARGS, doc_acquire_lock},
3735 {"release_lock", imp_release_lock, METH_NOARGS, doc_release_lock},
3736 {"reload", imp_reload, METH_O, doc_reload},
3737 {"cache_from_source", (PyCFunction)imp_cache_from_source,
3738 METH_VARARGS | METH_KEYWORDS, doc_cache_from_source},
3739 {"source_from_cache", (PyCFunction)imp_source_from_cache,
3740 METH_VARARGS | METH_KEYWORDS, doc_source_from_cache},
3741 /* The rest are obsolete */
3742 {"get_frozen_object", imp_get_frozen_object, METH_VARARGS},
3743 {"is_frozen_package", imp_is_frozen_package, METH_VARARGS},
3744 {"init_builtin", imp_init_builtin, METH_VARARGS},
3745 {"init_frozen", imp_init_frozen, METH_VARARGS},
3746 {"is_builtin", imp_is_builtin, METH_VARARGS},
3747 {"is_frozen", imp_is_frozen, METH_VARARGS},
3748 {"load_compiled", imp_load_compiled, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003749#ifdef HAVE_DYNAMIC_LOADING
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003750 {"load_dynamic", imp_load_dynamic, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003751#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003752 {"load_package", imp_load_package, METH_VARARGS},
3753 {"load_source", imp_load_source, METH_VARARGS},
3754 {NULL, NULL} /* sentinel */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003755};
3756
Guido van Rossum1a8791e1998-08-04 22:46:29 +00003757static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003758setint(PyObject *d, char *name, int value)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003759{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003760 PyObject *v;
3761 int err;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003762
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003763 v = PyLong_FromLong((long)value);
3764 err = PyDict_SetItemString(d, name, v);
3765 Py_XDECREF(v);
3766 return err;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003767}
3768
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003769typedef struct {
3770 PyObject_HEAD
3771} NullImporter;
3772
3773static int
3774NullImporter_init(NullImporter *self, PyObject *args, PyObject *kwds)
3775{
Victor Stinner1a4d12d2010-08-13 13:07:29 +00003776#ifndef MS_WINDOWS
3777 PyObject *path;
3778 struct stat statbuf;
3779 int rv;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003780
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003781 if (!_PyArg_NoKeywords("NullImporter()", kwds))
3782 return -1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003783
Victor Stinner1a4d12d2010-08-13 13:07:29 +00003784 if (!PyArg_ParseTuple(args, "O&:NullImporter",
3785 PyUnicode_FSConverter, &path))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003786 return -1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003787
Victor Stinner1a4d12d2010-08-13 13:07:29 +00003788 if (PyBytes_GET_SIZE(path) == 0) {
3789 Py_DECREF(path);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003790 PyErr_SetString(PyExc_ImportError, "empty pathname");
3791 return -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003792 }
Victor Stinner1a4d12d2010-08-13 13:07:29 +00003793
3794 rv = stat(PyBytes_AS_STRING(path), &statbuf);
3795 Py_DECREF(path);
3796 if (rv == 0) {
3797 /* it exists */
3798 if (S_ISDIR(statbuf.st_mode)) {
3799 /* it's a directory */
3800 PyErr_SetString(PyExc_ImportError, "existing directory");
3801 return -1;
3802 }
3803 }
3804#else /* MS_WINDOWS */
3805 PyObject *pathobj;
3806 DWORD rv;
Victor Stinner255dfdb2010-09-29 10:28:51 +00003807 wchar_t *path;
Victor Stinner1a4d12d2010-08-13 13:07:29 +00003808
3809 if (!_PyArg_NoKeywords("NullImporter()", kwds))
3810 return -1;
3811
3812 if (!PyArg_ParseTuple(args, "U:NullImporter",
3813 &pathobj))
3814 return -1;
3815
3816 if (PyUnicode_GET_SIZE(pathobj) == 0) {
3817 PyErr_SetString(PyExc_ImportError, "empty pathname");
3818 return -1;
3819 }
3820
Victor Stinnerbeb4135b2010-10-07 01:02:42 +00003821 path = PyUnicode_AsWideCharString(pathobj, NULL);
Victor Stinner255dfdb2010-09-29 10:28:51 +00003822 if (path == NULL)
Victor Stinner1a4d12d2010-08-13 13:07:29 +00003823 return -1;
3824 /* see issue1293 and issue3677:
3825 * stat() on Windows doesn't recognise paths like
3826 * "e:\\shared\\" and "\\\\whiterab-c2znlh\\shared" as dirs.
3827 */
3828 rv = GetFileAttributesW(path);
Victor Stinner255dfdb2010-09-29 10:28:51 +00003829 PyMem_Free(path);
Victor Stinner1a4d12d2010-08-13 13:07:29 +00003830 if (rv != INVALID_FILE_ATTRIBUTES) {
3831 /* it exists */
3832 if (rv & FILE_ATTRIBUTE_DIRECTORY) {
3833 /* it's a directory */
3834 PyErr_SetString(PyExc_ImportError, "existing directory");
3835 return -1;
3836 }
3837 }
3838#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003839 return 0;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003840}
3841
3842static PyObject *
3843NullImporter_find_module(NullImporter *self, PyObject *args)
3844{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003845 Py_RETURN_NONE;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003846}
3847
3848static PyMethodDef NullImporter_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003849 {"find_module", (PyCFunction)NullImporter_find_module, METH_VARARGS,
3850 "Always return None"
3851 },
3852 {NULL} /* Sentinel */
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003853};
3854
3855
Christian Heimes9cd17752007-11-18 19:35:23 +00003856PyTypeObject PyNullImporter_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003857 PyVarObject_HEAD_INIT(NULL, 0)
3858 "imp.NullImporter", /*tp_name*/
3859 sizeof(NullImporter), /*tp_basicsize*/
3860 0, /*tp_itemsize*/
3861 0, /*tp_dealloc*/
3862 0, /*tp_print*/
3863 0, /*tp_getattr*/
3864 0, /*tp_setattr*/
3865 0, /*tp_reserved*/
3866 0, /*tp_repr*/
3867 0, /*tp_as_number*/
3868 0, /*tp_as_sequence*/
3869 0, /*tp_as_mapping*/
3870 0, /*tp_hash */
3871 0, /*tp_call*/
3872 0, /*tp_str*/
3873 0, /*tp_getattro*/
3874 0, /*tp_setattro*/
3875 0, /*tp_as_buffer*/
3876 Py_TPFLAGS_DEFAULT, /*tp_flags*/
3877 "Null importer object", /* tp_doc */
3878 0, /* tp_traverse */
3879 0, /* tp_clear */
3880 0, /* tp_richcompare */
3881 0, /* tp_weaklistoffset */
3882 0, /* tp_iter */
3883 0, /* tp_iternext */
3884 NullImporter_methods, /* tp_methods */
3885 0, /* tp_members */
3886 0, /* tp_getset */
3887 0, /* tp_base */
3888 0, /* tp_dict */
3889 0, /* tp_descr_get */
3890 0, /* tp_descr_set */
3891 0, /* tp_dictoffset */
3892 (initproc)NullImporter_init, /* tp_init */
3893 0, /* tp_alloc */
3894 PyType_GenericNew /* tp_new */
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003895};
3896
Martin v. Löwis1a214512008-06-11 05:26:20 +00003897static struct PyModuleDef impmodule = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003898 PyModuleDef_HEAD_INIT,
3899 "imp",
3900 doc_imp,
3901 0,
3902 imp_methods,
3903 NULL,
3904 NULL,
3905 NULL,
3906 NULL
Martin v. Löwis1a214512008-06-11 05:26:20 +00003907};
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003908
Jason Tishler6bc06ec2003-09-04 11:59:50 +00003909PyMODINIT_FUNC
Martin v. Löwis1a214512008-06-11 05:26:20 +00003910PyInit_imp(void)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003911{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003912 PyObject *m, *d;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003913
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003914 if (PyType_Ready(&PyNullImporter_Type) < 0)
3915 return NULL;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003916
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003917 m = PyModule_Create(&impmodule);
3918 if (m == NULL)
3919 goto failure;
3920 d = PyModule_GetDict(m);
3921 if (d == NULL)
3922 goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003923
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003924 if (setint(d, "SEARCH_ERROR", SEARCH_ERROR) < 0) goto failure;
3925 if (setint(d, "PY_SOURCE", PY_SOURCE) < 0) goto failure;
3926 if (setint(d, "PY_COMPILED", PY_COMPILED) < 0) goto failure;
3927 if (setint(d, "C_EXTENSION", C_EXTENSION) < 0) goto failure;
3928 if (setint(d, "PY_RESOURCE", PY_RESOURCE) < 0) goto failure;
3929 if (setint(d, "PKG_DIRECTORY", PKG_DIRECTORY) < 0) goto failure;
3930 if (setint(d, "C_BUILTIN", C_BUILTIN) < 0) goto failure;
3931 if (setint(d, "PY_FROZEN", PY_FROZEN) < 0) goto failure;
3932 if (setint(d, "PY_CODERESOURCE", PY_CODERESOURCE) < 0) goto failure;
3933 if (setint(d, "IMP_HOOK", IMP_HOOK) < 0) goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003934
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003935 Py_INCREF(&PyNullImporter_Type);
3936 PyModule_AddObject(m, "NullImporter", (PyObject *)&PyNullImporter_Type);
3937 return m;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003938 failure:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003939 Py_XDECREF(m);
3940 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003941}
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003942
3943
Guido van Rossumb18618d2000-05-03 23:44:39 +00003944/* API for embedding applications that want to add their own entries
3945 to the table of built-in modules. This should normally be called
3946 *before* Py_Initialize(). When the table resize fails, -1 is
3947 returned and the existing table is unchanged.
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003948
3949 After a similar function by Just van Rossum. */
3950
3951int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003952PyImport_ExtendInittab(struct _inittab *newtab)
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003953{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003954 static struct _inittab *our_copy = NULL;
3955 struct _inittab *p;
3956 int i, n;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003957
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003958 /* Count the number of entries in both tables */
3959 for (n = 0; newtab[n].name != NULL; n++)
3960 ;
3961 if (n == 0)
3962 return 0; /* Nothing to do */
3963 for (i = 0; PyImport_Inittab[i].name != NULL; i++)
3964 ;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003965
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003966 /* Allocate new memory for the combined table */
3967 p = our_copy;
3968 PyMem_RESIZE(p, struct _inittab, i+n+1);
3969 if (p == NULL)
3970 return -1;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003971
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003972 /* Copy the tables into the new memory */
3973 if (our_copy != PyImport_Inittab)
3974 memcpy(p, PyImport_Inittab, (i+1) * sizeof(struct _inittab));
3975 PyImport_Inittab = our_copy = p;
3976 memcpy(p+i, newtab, (n+1) * sizeof(struct _inittab));
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003977
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003978 return 0;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003979}
3980
3981/* Shorthand to add a single entry given a name and a function */
3982
3983int
Brett Cannona826f322009-04-02 03:41:46 +00003984PyImport_AppendInittab(const char *name, PyObject* (*initfunc)(void))
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003985{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003986 struct _inittab newtab[2];
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003987
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003988 memset(newtab, '\0', sizeof newtab);
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003989
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003990 newtab[0].name = (char *)name;
3991 newtab[0].initfunc = initfunc;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003992
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003993 return PyImport_ExtendInittab(newtab);
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003994}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00003995
3996#ifdef __cplusplus
3997}
3998#endif