blob: 4e5cb2ddbf0fccf48eee9f0c6aca656d259754d6 [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 Stinner95872862011-03-07 18:20:56 +0100120/* See _PyImport_FixupExtensionObject() 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
255void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000256_PyImport_Fini(void)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000257{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000258 Py_XDECREF(extensions);
259 extensions = NULL;
260 PyMem_DEL(_PyImport_Filetab);
261 _PyImport_Filetab = NULL;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000262}
263
264
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000265/* Locking primitives to prevent parallel imports of the same module
266 in different threads to return with a partially loaded module.
267 These calls are serialized by the global interpreter lock. */
268
269#ifdef WITH_THREAD
270
Guido van Rossum49b56061998-10-01 20:42:43 +0000271#include "pythread.h"
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000272
Guido van Rossum65d5b571998-12-21 19:32:43 +0000273static PyThread_type_lock import_lock = 0;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000274static long import_lock_thread = -1;
275static int import_lock_level = 0;
276
Benjamin Peterson0df35a92009-10-04 20:32:25 +0000277void
278_PyImport_AcquireLock(void)
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000279{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000280 long me = PyThread_get_thread_ident();
281 if (me == -1)
282 return; /* Too bad */
283 if (import_lock == NULL) {
284 import_lock = PyThread_allocate_lock();
285 if (import_lock == NULL)
286 return; /* Nothing much we can do. */
287 }
288 if (import_lock_thread == me) {
289 import_lock_level++;
290 return;
291 }
292 if (import_lock_thread != -1 || !PyThread_acquire_lock(import_lock, 0))
293 {
294 PyThreadState *tstate = PyEval_SaveThread();
295 PyThread_acquire_lock(import_lock, 1);
296 PyEval_RestoreThread(tstate);
297 }
298 import_lock_thread = me;
299 import_lock_level = 1;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000300}
301
Benjamin Peterson0df35a92009-10-04 20:32:25 +0000302int
303_PyImport_ReleaseLock(void)
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000304{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000305 long me = PyThread_get_thread_ident();
306 if (me == -1 || import_lock == NULL)
307 return 0; /* Too bad */
308 if (import_lock_thread != me)
309 return -1;
310 import_lock_level--;
311 if (import_lock_level == 0) {
312 import_lock_thread = -1;
313 PyThread_release_lock(import_lock);
314 }
315 return 1;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000316}
317
Gregory P. Smith24cec9f2010-03-01 06:18:41 +0000318/* This function is called from PyOS_AfterFork to ensure that newly
319 created child processes do not share locks with the parent.
320 We now acquire the import lock around fork() calls but on some platforms
321 (Solaris 9 and earlier? see isue7242) that still left us with problems. */
Guido van Rossum8ee3e5a2005-09-14 18:09:42 +0000322
323void
324_PyImport_ReInitLock(void)
325{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000326 if (import_lock != NULL)
327 import_lock = PyThread_allocate_lock();
Nick Coghlanb2ddf792010-12-02 04:11:46 +0000328 if (import_lock_level > 1) {
329 /* Forked as a side effect of import */
330 long me = PyThread_get_thread_ident();
331 PyThread_acquire_lock(import_lock, 0);
Victor Stinner942003c2011-03-07 16:57:48 +0100332 /* XXX: can the previous line fail? */
Nick Coghlanb2ddf792010-12-02 04:11:46 +0000333 import_lock_thread = me;
334 import_lock_level--;
335 } else {
336 import_lock_thread = -1;
337 import_lock_level = 0;
338 }
Guido van Rossum8ee3e5a2005-09-14 18:09:42 +0000339}
340
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000341#endif
342
Tim Peters69232342001-08-30 05:16:13 +0000343static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000344imp_lock_held(PyObject *self, PyObject *noargs)
Tim Peters69232342001-08-30 05:16:13 +0000345{
Tim Peters69232342001-08-30 05:16:13 +0000346#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000347 return PyBool_FromLong(import_lock_thread != -1);
Tim Peters69232342001-08-30 05:16:13 +0000348#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000349 return PyBool_FromLong(0);
Tim Peters69232342001-08-30 05:16:13 +0000350#endif
351}
352
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000353static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000354imp_acquire_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 _PyImport_AcquireLock();
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000358#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000359 Py_INCREF(Py_None);
360 return Py_None;
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000361}
362
363static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000364imp_release_lock(PyObject *self, PyObject *noargs)
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000365{
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000366#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000367 if (_PyImport_ReleaseLock() < 0) {
368 PyErr_SetString(PyExc_RuntimeError,
369 "not holding the import lock");
370 return NULL;
371 }
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000372#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000373 Py_INCREF(Py_None);
374 return Py_None;
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000375}
376
Guido van Rossumd8faa362007-04-27 19:54:29 +0000377static void
378imp_modules_reloading_clear(void)
379{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000380 PyInterpreterState *interp = PyThreadState_Get()->interp;
381 if (interp->modules_reloading != NULL)
382 PyDict_Clear(interp->modules_reloading);
Guido van Rossumd8faa362007-04-27 19:54:29 +0000383}
384
Guido van Rossum25ce5661997-08-02 03:10:38 +0000385/* Helper for sys */
386
387PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000388PyImport_GetModuleDict(void)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000389{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000390 PyInterpreterState *interp = PyThreadState_GET()->interp;
391 if (interp->modules == NULL)
392 Py_FatalError("PyImport_GetModuleDict: no module dictionary!");
393 return interp->modules;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000394}
395
Guido van Rossum3f5da241990-12-20 15:06:42 +0000396
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000397/* List of names to clear in sys */
398static char* sys_deletes[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000399 "path", "argv", "ps1", "ps2",
400 "last_type", "last_value", "last_traceback",
401 "path_hooks", "path_importer_cache", "meta_path",
402 /* misc stuff */
403 "flags", "float_info",
404 NULL
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000405};
406
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000407static char* sys_files[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000408 "stdin", "__stdin__",
409 "stdout", "__stdout__",
410 "stderr", "__stderr__",
411 NULL
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000412};
413
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000414
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000415/* Un-initialize things, as good as we can */
Guido van Rossum3f5da241990-12-20 15:06:42 +0000416
Guido van Rossum3f5da241990-12-20 15:06:42 +0000417void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000418PyImport_Cleanup(void)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000419{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000420 Py_ssize_t pos, ndone;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000421 PyObject *key, *value, *dict;
422 PyInterpreterState *interp = PyThreadState_GET()->interp;
423 PyObject *modules = interp->modules;
Guido van Rossum758eec01998-01-19 21:58:26 +0000424
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000425 if (modules == NULL)
426 return; /* Already done */
Guido van Rossum758eec01998-01-19 21:58:26 +0000427
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000428 /* Delete some special variables first. These are common
429 places where user values hide and people complain when their
430 destructors fail. Since the modules containing them are
431 deleted *last* of all, they would come too late in the normal
432 destruction order. Sigh. */
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000433
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000434 value = PyDict_GetItemString(modules, "builtins");
435 if (value != NULL && PyModule_Check(value)) {
436 dict = PyModule_GetDict(value);
437 if (Py_VerboseFlag)
438 PySys_WriteStderr("# clear builtins._\n");
439 PyDict_SetItemString(dict, "_", Py_None);
440 }
441 value = PyDict_GetItemString(modules, "sys");
442 if (value != NULL && PyModule_Check(value)) {
443 char **p;
444 PyObject *v;
445 dict = PyModule_GetDict(value);
446 for (p = sys_deletes; *p != NULL; p++) {
447 if (Py_VerboseFlag)
448 PySys_WriteStderr("# clear sys.%s\n", *p);
449 PyDict_SetItemString(dict, *p, Py_None);
450 }
451 for (p = sys_files; *p != NULL; p+=2) {
452 if (Py_VerboseFlag)
453 PySys_WriteStderr("# restore sys.%s\n", *p);
454 v = PyDict_GetItemString(dict, *(p+1));
455 if (v == NULL)
456 v = Py_None;
457 PyDict_SetItemString(dict, *p, v);
458 }
459 }
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000460
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000461 /* First, delete __main__ */
462 value = PyDict_GetItemString(modules, "__main__");
463 if (value != NULL && PyModule_Check(value)) {
464 if (Py_VerboseFlag)
465 PySys_WriteStderr("# cleanup __main__\n");
466 _PyModule_Clear(value);
467 PyDict_SetItemString(modules, "__main__", Py_None);
468 }
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000469
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000470 /* The special treatment of "builtins" here is because even
471 when it's not referenced as a module, its dictionary is
472 referenced by almost every module's __builtins__. Since
473 deleting a module clears its dictionary (even if there are
474 references left to it), we need to delete the "builtins"
475 module last. Likewise, we don't delete sys until the very
476 end because it is implicitly referenced (e.g. by print).
Guido van Rossum758eec01998-01-19 21:58:26 +0000477
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000478 Also note that we 'delete' modules by replacing their entry
479 in the modules dict with None, rather than really deleting
480 them; this avoids a rehash of the modules dictionary and
481 also marks them as "non existent" so they won't be
482 re-imported. */
Guido van Rossum758eec01998-01-19 21:58:26 +0000483
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000484 /* Next, repeatedly delete modules with a reference count of
485 one (skipping builtins and sys) and delete them */
486 do {
487 ndone = 0;
488 pos = 0;
489 while (PyDict_Next(modules, &pos, &key, &value)) {
490 if (value->ob_refcnt != 1)
491 continue;
492 if (PyUnicode_Check(key) && PyModule_Check(value)) {
Victor Stinner9464d612011-03-07 17:08:21 +0100493 if (PyUnicode_CompareWithASCIIString(key, "builtins") == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000494 continue;
Victor Stinner9464d612011-03-07 17:08:21 +0100495 if (PyUnicode_CompareWithASCIIString(key, "sys") == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000496 continue;
497 if (Py_VerboseFlag)
Victor Stinner9464d612011-03-07 17:08:21 +0100498 PySys_FormatStderr(
499 "# cleanup[1] %U\n", key);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000500 _PyModule_Clear(value);
501 PyDict_SetItem(modules, key, Py_None);
502 ndone++;
503 }
504 }
505 } while (ndone > 0);
Guido van Rossum758eec01998-01-19 21:58:26 +0000506
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000507 /* Next, delete all modules (still skipping builtins and sys) */
508 pos = 0;
509 while (PyDict_Next(modules, &pos, &key, &value)) {
510 if (PyUnicode_Check(key) && PyModule_Check(value)) {
Victor Stinner9464d612011-03-07 17:08:21 +0100511 if (PyUnicode_CompareWithASCIIString(key, "builtins") == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000512 continue;
Victor Stinner9464d612011-03-07 17:08:21 +0100513 if (PyUnicode_CompareWithASCIIString(key, "sys") == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000514 continue;
515 if (Py_VerboseFlag)
Victor Stinner9464d612011-03-07 17:08:21 +0100516 PySys_FormatStderr("# cleanup[2] %U\n", key);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000517 _PyModule_Clear(value);
518 PyDict_SetItem(modules, key, Py_None);
519 }
520 }
Guido van Rossum758eec01998-01-19 21:58:26 +0000521
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000522 /* Next, delete sys and builtins (in that order) */
523 value = PyDict_GetItemString(modules, "sys");
524 if (value != NULL && PyModule_Check(value)) {
525 if (Py_VerboseFlag)
526 PySys_WriteStderr("# cleanup sys\n");
527 _PyModule_Clear(value);
528 PyDict_SetItemString(modules, "sys", Py_None);
529 }
530 value = PyDict_GetItemString(modules, "builtins");
531 if (value != NULL && PyModule_Check(value)) {
532 if (Py_VerboseFlag)
533 PySys_WriteStderr("# cleanup builtins\n");
534 _PyModule_Clear(value);
535 PyDict_SetItemString(modules, "builtins", Py_None);
536 }
Guido van Rossum758eec01998-01-19 21:58:26 +0000537
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000538 /* Finally, clear and delete the modules directory */
539 PyDict_Clear(modules);
540 interp->modules = NULL;
541 Py_DECREF(modules);
542 Py_CLEAR(interp->modules_reloading);
Guido van Rossum8d15b5d1990-10-26 14:58:58 +0000543}
Guido van Rossum7f133ed1991-02-19 12:23:57 +0000544
545
Barry Warsaw28a691b2010-04-17 00:19:56 +0000546/* Helper for pythonrun.c -- return magic number and tag. */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000547
548long
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000549PyImport_GetMagicNumber(void)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000550{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000551 return pyc_magic;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000552}
553
554
Barry Warsaw28a691b2010-04-17 00:19:56 +0000555const char *
556PyImport_GetMagicTag(void)
557{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000558 return pyc_tag;
Barry Warsaw28a691b2010-04-17 00:19:56 +0000559}
560
Guido van Rossum25ce5661997-08-02 03:10:38 +0000561/* Magic for extension modules (built-in as well as dynamically
562 loaded). To prevent initializing an extension module more than
563 once, we keep a static dictionary 'extensions' keyed by module name
564 (for built-in modules) or by filename (for dynamically loaded
Barry Warsaw92883382001-08-13 23:05:44 +0000565 modules), containing these modules. A copy of the module's
Victor Stinner95872862011-03-07 18:20:56 +0100566 dictionary is stored by calling _PyImport_FixupExtensionObject()
Guido van Rossum25ce5661997-08-02 03:10:38 +0000567 immediately after the module initialization function succeeds. A
568 copy can be retrieved from there by calling
Victor Stinner95872862011-03-07 18:20:56 +0100569 _PyImport_FindExtensionObject().
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000570
Barry Warsaw7c9627b2010-06-17 18:38:20 +0000571 Modules which do support multiple initialization set their m_size
572 field to a non-negative number (indicating the size of the
573 module-specific state). They are still recorded in the extensions
574 dictionary, to avoid loading shared libraries twice.
Martin v. Löwis1a214512008-06-11 05:26:20 +0000575*/
576
577int
Victor Stinner95872862011-03-07 18:20:56 +0100578_PyImport_FixupExtensionObject(PyObject *mod, PyObject *name,
579 PyObject *filename)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000580{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000581 PyObject *modules, *dict;
582 struct PyModuleDef *def;
583 if (extensions == NULL) {
584 extensions = PyDict_New();
585 if (extensions == NULL)
586 return -1;
587 }
588 if (mod == NULL || !PyModule_Check(mod)) {
589 PyErr_BadInternalCall();
590 return -1;
591 }
592 def = PyModule_GetDef(mod);
593 if (!def) {
594 PyErr_BadInternalCall();
595 return -1;
596 }
597 modules = PyImport_GetModuleDict();
Victor Stinner95872862011-03-07 18:20:56 +0100598 if (PyDict_SetItem(modules, name, mod) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000599 return -1;
600 if (_PyState_AddModule(mod, def) < 0) {
Victor Stinner95872862011-03-07 18:20:56 +0100601 PyDict_DelItem(modules, name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000602 return -1;
603 }
604 if (def->m_size == -1) {
605 if (def->m_base.m_copy) {
606 /* Somebody already imported the module,
607 likely under a different name.
608 XXX this should really not happen. */
609 Py_DECREF(def->m_base.m_copy);
610 def->m_base.m_copy = NULL;
611 }
612 dict = PyModule_GetDict(mod);
613 if (dict == NULL)
614 return -1;
615 def->m_base.m_copy = PyDict_Copy(dict);
616 if (def->m_base.m_copy == NULL)
617 return -1;
618 }
Victor Stinner49d3f252010-10-17 01:24:53 +0000619 PyDict_SetItem(extensions, filename, (PyObject*)def);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000620 return 0;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000621}
622
Victor Stinner49d3f252010-10-17 01:24:53 +0000623int
624_PyImport_FixupBuiltin(PyObject *mod, char *name)
625{
626 int res;
Victor Stinner95872862011-03-07 18:20:56 +0100627 PyObject *nameobj;
Victor Stinner21fcd0c2011-03-07 18:28:15 +0100628 nameobj = PyUnicode_InternFromString(name);
Victor Stinner95872862011-03-07 18:20:56 +0100629 if (nameobj == NULL)
Victor Stinner49d3f252010-10-17 01:24:53 +0000630 return -1;
Victor Stinner95872862011-03-07 18:20:56 +0100631 res = _PyImport_FixupExtensionObject(mod, nameobj, nameobj);
632 Py_DECREF(nameobj);
Victor Stinner49d3f252010-10-17 01:24:53 +0000633 return res;
634}
635
Guido van Rossum25ce5661997-08-02 03:10:38 +0000636PyObject *
Victor Stinner95872862011-03-07 18:20:56 +0100637_PyImport_FindExtensionObject(PyObject *name, PyObject *filename)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000638{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000639 PyObject *mod, *mdict;
640 PyModuleDef* def;
641 if (extensions == NULL)
642 return NULL;
Victor Stinner49d3f252010-10-17 01:24:53 +0000643 def = (PyModuleDef*)PyDict_GetItem(extensions, filename);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000644 if (def == NULL)
645 return NULL;
646 if (def->m_size == -1) {
647 /* Module does not support repeated initialization */
648 if (def->m_base.m_copy == NULL)
649 return NULL;
Victor Stinner95872862011-03-07 18:20:56 +0100650 mod = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000651 if (mod == NULL)
652 return NULL;
653 mdict = PyModule_GetDict(mod);
654 if (mdict == NULL)
655 return NULL;
656 if (PyDict_Update(mdict, def->m_base.m_copy))
657 return NULL;
658 }
659 else {
660 if (def->m_base.m_init == NULL)
661 return NULL;
662 mod = def->m_base.m_init();
663 if (mod == NULL)
664 return NULL;
Victor Stinner95872862011-03-07 18:20:56 +0100665 PyDict_SetItem(PyImport_GetModuleDict(), name, mod);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000666 Py_DECREF(mod);
667 }
668 if (_PyState_AddModule(mod, def) < 0) {
Victor Stinner95872862011-03-07 18:20:56 +0100669 PyDict_DelItem(PyImport_GetModuleDict(), name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000670 Py_DECREF(mod);
671 return NULL;
672 }
673 if (Py_VerboseFlag)
Victor Stinner95872862011-03-07 18:20:56 +0100674 PySys_FormatStderr("import %U # previously loaded (%R)\n",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000675 name, filename);
676 return mod;
Brett Cannon9a5b25a2010-03-01 02:09:17 +0000677
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000678}
679
Victor Stinner49d3f252010-10-17 01:24:53 +0000680PyObject *
Victor Stinner501c09a2011-02-23 00:02:00 +0000681_PyImport_FindBuiltin(const char *name)
Victor Stinner49d3f252010-10-17 01:24:53 +0000682{
Victor Stinner95872862011-03-07 18:20:56 +0100683 PyObject *res, *nameobj;
Victor Stinner21fcd0c2011-03-07 18:28:15 +0100684 nameobj = PyUnicode_InternFromString(name);
Victor Stinner95872862011-03-07 18:20:56 +0100685 if (nameobj == NULL)
Victor Stinner49d3f252010-10-17 01:24:53 +0000686 return NULL;
Victor Stinner95872862011-03-07 18:20:56 +0100687 res = _PyImport_FindExtensionObject(nameobj, nameobj);
688 Py_DECREF(nameobj);
Victor Stinner49d3f252010-10-17 01:24:53 +0000689 return res;
690}
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000691
692/* Get the module object corresponding to a module name.
693 First check the modules dictionary if there's one there,
Walter Dörwaldf0dfc7a2003-10-20 14:01:56 +0000694 if not, create a new one and insert it in the modules dictionary.
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000695 Because the former action is most common, THIS DOES NOT RETURN A
696 'NEW' REFERENCE! */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000697
Guido van Rossum79f25d91997-04-29 20:08:16 +0000698PyObject *
Victor Stinner27ee0892011-03-04 12:57:09 +0000699PyImport_AddModuleObject(PyObject *name)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000700{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000701 PyObject *modules = PyImport_GetModuleDict();
702 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000703
Victor Stinner27ee0892011-03-04 12:57:09 +0000704 if ((m = PyDict_GetItem(modules, name)) != NULL &&
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000705 PyModule_Check(m))
706 return m;
Victor Stinner27ee0892011-03-04 12:57:09 +0000707 m = PyModule_NewObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000708 if (m == NULL)
709 return NULL;
Victor Stinner27ee0892011-03-04 12:57:09 +0000710 if (PyDict_SetItem(modules, name, m) != 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000711 Py_DECREF(m);
712 return NULL;
713 }
714 Py_DECREF(m); /* Yes, it still exists, in modules! */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000715
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000716 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000717}
718
Victor Stinner27ee0892011-03-04 12:57:09 +0000719PyObject *
720PyImport_AddModule(const char *name)
721{
722 PyObject *nameobj, *module;
723 nameobj = PyUnicode_FromString(name);
724 if (nameobj == NULL)
725 return NULL;
726 module = PyImport_AddModuleObject(nameobj);
727 Py_DECREF(nameobj);
728 return module;
729}
730
731
Tim Peters1cd70172004-08-02 03:52:12 +0000732/* Remove name from sys.modules, if it's there. */
733static void
Victor Stinner27ee0892011-03-04 12:57:09 +0000734remove_module(PyObject *name)
Tim Peters1cd70172004-08-02 03:52:12 +0000735{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000736 PyObject *modules = PyImport_GetModuleDict();
Victor Stinner27ee0892011-03-04 12:57:09 +0000737 if (PyDict_GetItem(modules, name) == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000738 return;
Victor Stinner27ee0892011-03-04 12:57:09 +0000739 if (PyDict_DelItem(modules, name) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000740 Py_FatalError("import: deleting existing key in"
741 "sys.modules failed");
Tim Peters1cd70172004-08-02 03:52:12 +0000742}
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000743
Barry Warsaw28a691b2010-04-17 00:19:56 +0000744static PyObject * get_sourcefile(char *file);
745static char *make_source_pathname(char *pathname, char *buf);
746static char *make_compiled_pathname(char *pathname, char *buf, size_t buflen,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000747 int debug);
Christian Heimes3b06e532008-01-07 20:12:44 +0000748
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000749/* Execute a code object in a module and return the module object
Tim Peters1cd70172004-08-02 03:52:12 +0000750 * WITH INCREMENTED REFERENCE COUNT. If an error occurs, name is
751 * removed from sys.modules, to avoid leaving damaged module objects
752 * in sys.modules. The caller may wish to restore the original
753 * module object (if any) in this case; PyImport_ReloadModule is an
754 * example.
Barry Warsaw28a691b2010-04-17 00:19:56 +0000755 *
756 * Note that PyImport_ExecCodeModuleWithPathnames() is the preferred, richer
757 * interface. The other two exist primarily for backward compatibility.
Tim Peters1cd70172004-08-02 03:52:12 +0000758 */
Guido van Rossum79f25d91997-04-29 20:08:16 +0000759PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000760PyImport_ExecCodeModule(char *name, PyObject *co)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000761{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000762 return PyImport_ExecCodeModuleWithPathnames(
763 name, co, (char *)NULL, (char *)NULL);
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000764}
765
766PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000767PyImport_ExecCodeModuleEx(char *name, PyObject *co, char *pathname)
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000768{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000769 return PyImport_ExecCodeModuleWithPathnames(
770 name, co, pathname, (char *)NULL);
Barry Warsaw28a691b2010-04-17 00:19:56 +0000771}
772
773PyObject *
774PyImport_ExecCodeModuleWithPathnames(char *name, PyObject *co, char *pathname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000775 char *cpathname)
Barry Warsaw28a691b2010-04-17 00:19:56 +0000776{
Victor Stinner27ee0892011-03-04 12:57:09 +0000777 PyObject *m = NULL;
778 PyObject *nameobj, *pathobj = NULL, *cpathobj = NULL;
779
780 nameobj = PyUnicode_FromString(name);
781 if (nameobj == NULL)
782 return NULL;
783
784 if (pathname != NULL) {
785 pathobj = PyUnicode_DecodeFSDefault(pathname);
786 if (pathobj == NULL)
787 goto error;
788 } else
789 pathobj = NULL;
790 if (cpathname != NULL) {
791 cpathobj = PyUnicode_DecodeFSDefault(cpathname);
792 if (cpathobj == NULL)
793 goto error;
794 } else
795 cpathobj = NULL;
796 m = PyImport_ExecCodeModuleObject(nameobj, co, pathobj, cpathobj);
797error:
798 Py_DECREF(nameobj);
799 Py_XDECREF(pathobj);
800 Py_XDECREF(cpathobj);
801 return m;
802}
803
804PyObject*
805PyImport_ExecCodeModuleObject(PyObject *name, PyObject *co, PyObject *pathname,
806 PyObject *cpathname)
807{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000808 PyObject *modules = PyImport_GetModuleDict();
809 PyObject *m, *d, *v;
Victor Stinner27ee0892011-03-04 12:57:09 +0000810 PyObject *pathbytes;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000811
Victor Stinner27ee0892011-03-04 12:57:09 +0000812 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000813 if (m == NULL)
814 return NULL;
815 /* If the module is being reloaded, we get the old module back
816 and re-use its dict to exec the new code. */
817 d = PyModule_GetDict(m);
818 if (PyDict_GetItemString(d, "__builtins__") == NULL) {
819 if (PyDict_SetItemString(d, "__builtins__",
820 PyEval_GetBuiltins()) != 0)
821 goto error;
822 }
823 /* Remember the filename as the __file__ attribute */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000824 if (pathname != NULL) {
Victor Stinner27ee0892011-03-04 12:57:09 +0000825 pathbytes = PyUnicode_EncodeFSDefault(pathname);
826 if (pathbytes != NULL) {
827 v = get_sourcefile(PyBytes_AS_STRING(pathbytes));
828 Py_DECREF(pathbytes);
829 } else
830 v = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000831 if (v == NULL)
832 PyErr_Clear();
833 }
Victor Stinner27ee0892011-03-04 12:57:09 +0000834 else
835 v = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000836 if (v == NULL) {
837 v = ((PyCodeObject *)co)->co_filename;
838 Py_INCREF(v);
839 }
840 if (PyDict_SetItemString(d, "__file__", v) != 0)
841 PyErr_Clear(); /* Not important enough to report */
842 Py_DECREF(v);
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000843
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000844 /* Remember the pyc path name as the __cached__ attribute. */
Victor Stinner27ee0892011-03-04 12:57:09 +0000845 if (cpathname != NULL)
846 v = cpathname;
847 else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000848 v = Py_None;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000849 if (PyDict_SetItemString(d, "__cached__", v) != 0)
850 PyErr_Clear(); /* Not important enough to report */
Barry Warsaw28a691b2010-04-17 00:19:56 +0000851
Martin v. Löwis4d0d4712010-12-03 20:14:31 +0000852 v = PyEval_EvalCode(co, d, d);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000853 if (v == NULL)
854 goto error;
855 Py_DECREF(v);
Guido van Rossumb65e85c1997-07-10 18:00:45 +0000856
Victor Stinner27ee0892011-03-04 12:57:09 +0000857 if ((m = PyDict_GetItem(modules, name)) == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000858 PyErr_Format(PyExc_ImportError,
Victor Stinner27ee0892011-03-04 12:57:09 +0000859 "Loaded module %R not found in sys.modules",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000860 name);
861 return NULL;
862 }
Guido van Rossumb65e85c1997-07-10 18:00:45 +0000863
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000864 Py_INCREF(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000865
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000866 return m;
Tim Peters1cd70172004-08-02 03:52:12 +0000867
868 error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000869 remove_module(name);
870 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000871}
872
873
Barry Warsaw28a691b2010-04-17 00:19:56 +0000874/* Like strrchr(string, '/') but searches for the rightmost of either SEP
875 or ALTSEP, if the latter is defined.
876*/
877static char *
878rightmost_sep(char *s)
879{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000880 char *found, c;
881 for (found = NULL; (c = *s); s++) {
882 if (c == SEP
Barry Warsaw28a691b2010-04-17 00:19:56 +0000883#ifdef ALTSEP
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000884 || c == ALTSEP
Barry Warsaw28a691b2010-04-17 00:19:56 +0000885#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000886 )
887 {
888 found = s;
889 }
890 }
891 return found;
Barry Warsaw28a691b2010-04-17 00:19:56 +0000892}
893
894
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000895/* Given a pathname for a Python source file, fill a buffer with the
896 pathname for the corresponding compiled file. Return the pathname
897 for the compiled file, or NULL if there's no space in the buffer.
898 Doesn't set an exception. */
899
900static char *
Barry Warsaw28a691b2010-04-17 00:19:56 +0000901make_compiled_pathname(char *pathname, char *buf, size_t buflen, int debug)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000902{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000903 /* foo.py -> __pycache__/foo.<tag>.pyc */
904 size_t len = strlen(pathname);
905 size_t i, save;
906 char *pos;
907 int sep = SEP;
Barry Warsaw28a691b2010-04-17 00:19:56 +0000908
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000909 /* Sanity check that the buffer has roughly enough space to hold what
910 will eventually be the full path to the compiled file. The 5 extra
911 bytes include the slash afer __pycache__, the two extra dots, the
912 extra trailing character ('c' or 'o') and null. This isn't exact
913 because the contents of the buffer can affect how many actual
914 characters of the string get into the buffer. We'll do a final
915 sanity check before writing the extension to ensure we do not
916 overflow the buffer.
917 */
918 if (len + strlen(CACHEDIR) + strlen(pyc_tag) + 5 > buflen)
919 return NULL;
Tim Petersc1731372001-08-04 08:12:36 +0000920
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000921 /* Find the last path separator and copy everything from the start of
922 the source string up to and including the separator.
923 */
924 if ((pos = rightmost_sep(pathname)) == NULL) {
925 i = 0;
926 }
927 else {
928 sep = *pos;
929 i = pos - pathname + 1;
930 strncpy(buf, pathname, i);
931 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000932
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000933 save = i;
934 buf[i++] = '\0';
935 /* Add __pycache__/ */
936 strcat(buf, CACHEDIR);
937 i += strlen(CACHEDIR) - 1;
938 buf[i++] = sep;
939 buf[i++] = '\0';
940 /* Add the base filename, but remove the .py or .pyw extension, since
941 the tag name must go before the extension.
942 */
943 strcat(buf, pathname + save);
944 if ((pos = strrchr(buf, '.')) != NULL)
945 *++pos = '\0';
946 strcat(buf, pyc_tag);
947 /* The length test above assumes that we're only adding one character
948 to the end of what would normally be the extension. What if there
949 is no extension, or the string ends in '.' or '.p', and otherwise
950 fills the buffer? By appending 4 more characters onto the string
951 here, we could overrun the buffer.
Barry Warsaw28a691b2010-04-17 00:19:56 +0000952
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000953 As a simple example, let's say buflen=32 and the input string is
954 'xxx.py'. strlen() would be 6 and the test above would yield:
Barry Warsaw28a691b2010-04-17 00:19:56 +0000955
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000956 (6 + 11 + 10 + 5 == 32) > 32
Barry Warsaw28a691b2010-04-17 00:19:56 +0000957
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000958 which is false and so the name mangling would continue. This would
959 be fine because we'd end up with this string in buf:
Barry Warsaw28a691b2010-04-17 00:19:56 +0000960
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000961 __pycache__/xxx.cpython-32.pyc\0
Barry Warsaw28a691b2010-04-17 00:19:56 +0000962
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000963 strlen(of that) == 30 + the nul fits inside a 32 character buffer.
964 We can even handle an input string of say 'xxxxx' above because
965 that's (5 + 11 + 10 + 5 == 31) > 32 which is also false. Name
966 mangling that yields:
Barry Warsaw28a691b2010-04-17 00:19:56 +0000967
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000968 __pycache__/xxxxxcpython-32.pyc\0
Barry Warsaw28a691b2010-04-17 00:19:56 +0000969
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000970 which is 32 characters including the nul, and thus fits in the
971 buffer. However, an input string of 'xxxxxx' would yield a result
972 string of:
Barry Warsaw28a691b2010-04-17 00:19:56 +0000973
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000974 __pycache__/xxxxxxcpython-32.pyc\0
Barry Warsaw28a691b2010-04-17 00:19:56 +0000975
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000976 which is 33 characters long (including the nul), thus overflowing
977 the buffer, even though the first test would fail, i.e.: the input
978 string is also 6 characters long, so 32 > 32 is false.
Barry Warsaw28a691b2010-04-17 00:19:56 +0000979
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000980 The reason the first test fails but we still overflow the buffer is
981 that the test above only expects to add one extra character to be
982 added to the extension, and here we're adding three (pyc). We
983 don't add the first dot, so that reclaims one of expected
984 positions, leaving us overflowing by 1 byte (3 extra - 1 reclaimed
985 dot - 1 expected extra == 1 overflowed).
Barry Warsaw28a691b2010-04-17 00:19:56 +0000986
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000987 The best we can do is ensure that we still have enough room in the
988 target buffer before we write the extension. Because it's always
989 only the extension that can cause the overflow, and never the other
990 path bytes we've written, it's sufficient to just do one more test
991 here. Still, the assertion that follows can't hurt.
992 */
Barry Warsaw28a691b2010-04-17 00:19:56 +0000993#if 0
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000994 printf("strlen(buf): %d; buflen: %d\n", (int)strlen(buf), (int)buflen);
Barry Warsaw28a691b2010-04-17 00:19:56 +0000995#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000996 if (strlen(buf) + 5 > buflen)
997 return NULL;
998 strcat(buf, debug ? ".pyc" : ".pyo");
999 assert(strlen(buf) < buflen);
1000 return buf;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001001}
1002
1003
Barry Warsaw28a691b2010-04-17 00:19:56 +00001004/* Given a pathname to a Python byte compiled file, return the path to the
1005 source file, if the path matches the PEP 3147 format. This does not check
1006 for any file existence, however, if the pyc file name does not match PEP
1007 3147 style, NULL is returned. buf must be at least as big as pathname;
1008 the resulting path will always be shorter. */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001009
Barry Warsaw28a691b2010-04-17 00:19:56 +00001010static char *
1011make_source_pathname(char *pathname, char *buf)
1012{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001013 /* __pycache__/foo.<tag>.pyc -> foo.py */
1014 size_t i, j;
1015 char *left, *right, *dot0, *dot1, sep;
Barry Warsaw28a691b2010-04-17 00:19:56 +00001016
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001017 /* Look back two slashes from the end. In between these two slashes
1018 must be the string __pycache__ or this is not a PEP 3147 style
1019 path. It's possible for there to be only one slash.
1020 */
1021 if ((right = rightmost_sep(pathname)) == NULL)
1022 return NULL;
1023 sep = *right;
1024 *right = '\0';
1025 left = rightmost_sep(pathname);
1026 *right = sep;
1027 if (left == NULL)
1028 left = pathname;
1029 else
1030 left++;
1031 if (right-left != strlen(CACHEDIR) ||
1032 strncmp(left, CACHEDIR, right-left) != 0)
1033 return NULL;
Barry Warsaw28a691b2010-04-17 00:19:56 +00001034
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001035 /* Now verify that the path component to the right of the last slash
1036 has two dots in it.
1037 */
1038 if ((dot0 = strchr(right + 1, '.')) == NULL)
1039 return NULL;
1040 if ((dot1 = strchr(dot0 + 1, '.')) == NULL)
1041 return NULL;
1042 /* Too many dots? */
1043 if (strchr(dot1 + 1, '.') != NULL)
1044 return NULL;
Barry Warsaw28a691b2010-04-17 00:19:56 +00001045
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001046 /* This is a PEP 3147 path. Start by copying everything from the
1047 start of pathname up to and including the leftmost slash. Then
1048 copy the file's basename, removing the magic tag and adding a .py
1049 suffix.
1050 */
1051 strncpy(buf, pathname, (i=left-pathname));
1052 strncpy(buf+i, right+1, (j=dot0-right));
1053 strcpy(buf+i+j, "py");
1054 return buf;
Barry Warsaw28a691b2010-04-17 00:19:56 +00001055}
1056
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001057/* Given a pathname for a Python source file, its time of last
1058 modification, and a pathname for a compiled file, check whether the
1059 compiled file represents the same version of the source. If so,
1060 return a FILE pointer for the compiled file, positioned just after
1061 the header; if not, return NULL.
1062 Doesn't set an exception. */
1063
1064static FILE *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001065check_compiled_module(char *pathname, time_t mtime, char *cpathname)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001066{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001067 FILE *fp;
1068 long magic;
1069 long pyc_mtime;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001070
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001071 fp = fopen(cpathname, "rb");
1072 if (fp == NULL)
1073 return NULL;
1074 magic = PyMarshal_ReadLongFromFile(fp);
1075 if (magic != pyc_magic) {
1076 if (Py_VerboseFlag)
1077 PySys_WriteStderr("# %s has bad magic\n", cpathname);
1078 fclose(fp);
1079 return NULL;
1080 }
1081 pyc_mtime = PyMarshal_ReadLongFromFile(fp);
1082 if (pyc_mtime != mtime) {
1083 if (Py_VerboseFlag)
1084 PySys_WriteStderr("# %s has bad mtime\n", cpathname);
1085 fclose(fp);
1086 return NULL;
1087 }
1088 if (Py_VerboseFlag)
1089 PySys_WriteStderr("# %s matches %s\n", cpathname, pathname);
1090 return fp;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001091}
1092
1093
1094/* Read a code object from a file and check it for validity */
1095
Guido van Rossum79f25d91997-04-29 20:08:16 +00001096static PyCodeObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001097read_compiled_module(char *cpathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001098{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001099 PyObject *co;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001100
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001101 co = PyMarshal_ReadLastObjectFromFile(fp);
1102 if (co == NULL)
1103 return NULL;
1104 if (!PyCode_Check(co)) {
1105 PyErr_Format(PyExc_ImportError,
1106 "Non-code object in %.200s", cpathname);
1107 Py_DECREF(co);
1108 return NULL;
1109 }
1110 return (PyCodeObject *)co;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001111}
1112
1113
1114/* Load a module from a compiled file, execute it, and return its
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001115 module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001116
Guido van Rossum79f25d91997-04-29 20:08:16 +00001117static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001118load_compiled_module(char *name, char *cpathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001119{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001120 long magic;
1121 PyCodeObject *co;
1122 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001123
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001124 magic = PyMarshal_ReadLongFromFile(fp);
1125 if (magic != pyc_magic) {
1126 PyErr_Format(PyExc_ImportError,
1127 "Bad magic number in %.200s", cpathname);
1128 return NULL;
1129 }
1130 (void) PyMarshal_ReadLongFromFile(fp);
1131 co = read_compiled_module(cpathname, fp);
1132 if (co == NULL)
1133 return NULL;
1134 if (Py_VerboseFlag)
1135 PySys_WriteStderr("import %s # precompiled from %s\n",
1136 name, cpathname);
1137 m = PyImport_ExecCodeModuleWithPathnames(
1138 name, (PyObject *)co, cpathname, cpathname);
1139 Py_DECREF(co);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001140
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001141 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001142}
1143
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001144/* Parse a source file and return the corresponding code object */
1145
Guido van Rossum79f25d91997-04-29 20:08:16 +00001146static PyCodeObject *
Jeremy Hylton3e0055f2005-10-20 19:59:25 +00001147parse_source_module(const char *pathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001148{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001149 PyCodeObject *co = NULL;
1150 mod_ty mod;
1151 PyCompilerFlags flags;
1152 PyArena *arena = PyArena_New();
1153 if (arena == NULL)
1154 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001155
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001156 flags.cf_flags = 0;
1157 mod = PyParser_ASTFromFile(fp, pathname, NULL,
1158 Py_file_input, 0, 0, &flags,
1159 NULL, arena);
1160 if (mod) {
1161 co = PyAST_Compile(mod, pathname, NULL, arena);
1162 }
1163 PyArena_Free(arena);
1164 return co;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001165}
1166
1167
Guido van Rossum55a83382000-09-20 20:31:38 +00001168/* Helper to open a bytecode file for writing in exclusive mode */
1169
1170static FILE *
Christian Heimes05e8be12008-02-23 18:30:17 +00001171open_exclusive(char *filename, mode_t mode)
Guido van Rossum55a83382000-09-20 20:31:38 +00001172{
1173#if defined(O_EXCL)&&defined(O_CREAT)&&defined(O_WRONLY)&&defined(O_TRUNC)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001174 /* Use O_EXCL to avoid a race condition when another process tries to
1175 write the same file. When that happens, our open() call fails,
1176 which is just fine (since it's only a cache).
1177 XXX If the file exists and is writable but the directory is not
1178 writable, the file will never be written. Oh well.
1179 */
1180 int fd;
1181 (void) unlink(filename);
1182 fd = open(filename, O_EXCL|O_CREAT|O_WRONLY|O_TRUNC
Tim Peters42c83af2000-09-29 04:03:10 +00001183#ifdef O_BINARY
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001184 |O_BINARY /* necessary for Windows */
Tim Peters42c83af2000-09-29 04:03:10 +00001185#endif
Martin v. Löwis79acb9e2002-12-06 12:48:53 +00001186#ifdef __VMS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001187 , mode, "ctxt=bin", "shr=nil"
Martin v. Löwis79acb9e2002-12-06 12:48:53 +00001188#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001189 , mode
Martin v. Löwis79acb9e2002-12-06 12:48:53 +00001190#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001191 );
1192 if (fd < 0)
1193 return NULL;
1194 return fdopen(fd, "wb");
Guido van Rossum55a83382000-09-20 20:31:38 +00001195#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001196 /* Best we can do -- on Windows this can't happen anyway */
1197 return fopen(filename, "wb");
Guido van Rossum55a83382000-09-20 20:31:38 +00001198#endif
1199}
1200
1201
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001202/* Write a compiled module to a file, placing the time of last
1203 modification of its source into the header.
1204 Errors are ignored, if a write error occurs an attempt is made to
1205 remove the file. */
1206
1207static void
Christian Heimes05e8be12008-02-23 18:30:17 +00001208write_compiled_module(PyCodeObject *co, char *cpathname, struct stat *srcstat)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001209{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001210 FILE *fp;
1211 char *dirpath;
1212 time_t mtime = srcstat->st_mtime;
Alexandre Vassalotti9d58e3e2009-07-17 10:55:50 +00001213#ifdef MS_WINDOWS /* since Windows uses different permissions */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001214 mode_t mode = srcstat->st_mode & ~S_IEXEC;
Alexandre Vassalotti9d58e3e2009-07-17 10:55:50 +00001215#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001216 mode_t mode = srcstat->st_mode & ~S_IXUSR & ~S_IXGRP & ~S_IXOTH;
1217 mode_t dirmode = (srcstat->st_mode |
1218 S_IXUSR | S_IXGRP | S_IXOTH |
1219 S_IWUSR | S_IWGRP | S_IWOTH);
Brett Cannon9a5b25a2010-03-01 02:09:17 +00001220#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001221 int saved;
Barry Warsaw28a691b2010-04-17 00:19:56 +00001222
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001223 /* Ensure that the __pycache__ directory exists. */
1224 dirpath = rightmost_sep(cpathname);
1225 if (dirpath == NULL) {
1226 if (Py_VerboseFlag)
1227 PySys_WriteStderr(
1228 "# no %s path found %s\n",
1229 CACHEDIR, cpathname);
1230 return;
1231 }
1232 saved = *dirpath;
1233 *dirpath = '\0';
Daniel Stutzbachc7937792010-09-09 21:18:04 +00001234
1235#ifdef MS_WINDOWS
1236 if (_mkdir(cpathname) < 0 && errno != EEXIST) {
1237#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001238 if (mkdir(cpathname, dirmode) < 0 && errno != EEXIST) {
Daniel Stutzbachc7937792010-09-09 21:18:04 +00001239#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001240 *dirpath = saved;
1241 if (Py_VerboseFlag)
1242 PySys_WriteStderr(
1243 "# cannot create cache dir %s\n", cpathname);
1244 return;
1245 }
1246 *dirpath = saved;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001247
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001248 fp = open_exclusive(cpathname, mode);
1249 if (fp == NULL) {
1250 if (Py_VerboseFlag)
1251 PySys_WriteStderr(
1252 "# can't create %s\n", cpathname);
1253 return;
1254 }
1255 PyMarshal_WriteLongToFile(pyc_magic, fp, Py_MARSHAL_VERSION);
1256 /* First write a 0 for mtime */
1257 PyMarshal_WriteLongToFile(0L, fp, Py_MARSHAL_VERSION);
1258 PyMarshal_WriteObjectToFile((PyObject *)co, fp, Py_MARSHAL_VERSION);
1259 if (fflush(fp) != 0 || ferror(fp)) {
1260 if (Py_VerboseFlag)
1261 PySys_WriteStderr("# can't write %s\n", cpathname);
1262 /* Don't keep partial file */
1263 fclose(fp);
1264 (void) unlink(cpathname);
1265 return;
1266 }
1267 /* Now write the true mtime */
1268 fseek(fp, 4L, 0);
1269 assert(mtime < LONG_MAX);
1270 PyMarshal_WriteLongToFile((long)mtime, fp, Py_MARSHAL_VERSION);
1271 fflush(fp);
1272 fclose(fp);
1273 if (Py_VerboseFlag)
1274 PySys_WriteStderr("# wrote %s\n", cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001275}
1276
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001277static void
1278update_code_filenames(PyCodeObject *co, PyObject *oldname, PyObject *newname)
1279{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001280 PyObject *constants, *tmp;
1281 Py_ssize_t i, n;
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001282
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001283 if (PyUnicode_Compare(co->co_filename, oldname))
1284 return;
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001285
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001286 tmp = co->co_filename;
1287 co->co_filename = newname;
1288 Py_INCREF(co->co_filename);
1289 Py_DECREF(tmp);
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001290
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001291 constants = co->co_consts;
1292 n = PyTuple_GET_SIZE(constants);
1293 for (i = 0; i < n; i++) {
1294 tmp = PyTuple_GET_ITEM(constants, i);
1295 if (PyCode_Check(tmp))
1296 update_code_filenames((PyCodeObject *)tmp,
1297 oldname, newname);
1298 }
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001299}
1300
1301static int
1302update_compiled_module(PyCodeObject *co, char *pathname)
1303{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001304 PyObject *oldname, *newname;
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001305
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001306 newname = PyUnicode_DecodeFSDefault(pathname);
1307 if (newname == NULL)
1308 return -1;
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001309
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001310 if (!PyUnicode_Compare(co->co_filename, newname)) {
1311 Py_DECREF(newname);
1312 return 0;
1313 }
Hirokazu Yamamoto4f447fb2009-03-04 01:52:10 +00001314
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001315 oldname = co->co_filename;
1316 Py_INCREF(oldname);
1317 update_code_filenames(co, oldname, newname);
1318 Py_DECREF(oldname);
1319 Py_DECREF(newname);
1320 return 1;
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001321}
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001322
1323/* Load a source module from a given file and return its module
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001324 object WITH INCREMENTED REFERENCE COUNT. If there's a matching
1325 byte-compiled file, use that instead. */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001326
Guido van Rossum79f25d91997-04-29 20:08:16 +00001327static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001328load_source_module(char *name, char *pathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001329{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001330 struct stat st;
1331 FILE *fpc;
1332 char buf[MAXPATHLEN+1];
1333 char *cpathname;
1334 PyCodeObject *co;
1335 PyObject *m;
Brett Cannon9a5b25a2010-03-01 02:09:17 +00001336
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001337 if (fstat(fileno(fp), &st) != 0) {
1338 PyErr_Format(PyExc_RuntimeError,
1339 "unable to get file status from '%s'",
1340 pathname);
1341 return NULL;
1342 }
Fred Drake4c82b232000-06-30 16:18:57 +00001343#if SIZEOF_TIME_T > 4
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001344 /* Python's .pyc timestamp handling presumes that the timestamp fits
1345 in 4 bytes. This will be fine until sometime in the year 2038,
1346 when a 4-byte signed time_t will overflow.
1347 */
1348 if (st.st_mtime >> 32) {
1349 PyErr_SetString(PyExc_OverflowError,
1350 "modification time overflows a 4 byte field");
1351 return NULL;
1352 }
Fred Drake4c82b232000-06-30 16:18:57 +00001353#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001354 cpathname = make_compiled_pathname(
1355 pathname, buf, (size_t)MAXPATHLEN + 1, !Py_OptimizeFlag);
1356 if (cpathname != NULL &&
1357 (fpc = check_compiled_module(pathname, st.st_mtime, cpathname))) {
1358 co = read_compiled_module(cpathname, fpc);
1359 fclose(fpc);
1360 if (co == NULL)
1361 return NULL;
1362 if (update_compiled_module(co, pathname) < 0)
1363 return NULL;
1364 if (Py_VerboseFlag)
1365 PySys_WriteStderr("import %s # precompiled from %s\n",
1366 name, cpathname);
1367 pathname = cpathname;
1368 }
1369 else {
1370 co = parse_source_module(pathname, fp);
1371 if (co == NULL)
1372 return NULL;
1373 if (Py_VerboseFlag)
1374 PySys_WriteStderr("import %s # from %s\n",
1375 name, pathname);
1376 if (cpathname) {
1377 PyObject *ro = PySys_GetObject("dont_write_bytecode");
1378 if (ro == NULL || !PyObject_IsTrue(ro))
1379 write_compiled_module(co, cpathname, &st);
1380 }
1381 }
1382 m = PyImport_ExecCodeModuleWithPathnames(
1383 name, (PyObject *)co, pathname, cpathname);
1384 Py_DECREF(co);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001385
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001386 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001387}
1388
Christian Heimes3b06e532008-01-07 20:12:44 +00001389/* Get source file -> unicode or None
1390 * Returns the path to the py file if available, else the given path
1391 */
1392static PyObject *
Barry Warsaw28a691b2010-04-17 00:19:56 +00001393get_sourcefile(char *file)
Christian Heimes3b06e532008-01-07 20:12:44 +00001394{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001395 char py[MAXPATHLEN + 1];
1396 Py_ssize_t len;
1397 PyObject *u;
1398 struct stat statbuf;
Christian Heimes3b06e532008-01-07 20:12:44 +00001399
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001400 if (!file || !*file) {
1401 Py_RETURN_NONE;
1402 }
Christian Heimes3b06e532008-01-07 20:12:44 +00001403
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001404 len = strlen(file);
1405 /* match '*.py?' */
1406 if (len > MAXPATHLEN || PyOS_strnicmp(&file[len-4], ".py", 3) != 0) {
1407 return PyUnicode_DecodeFSDefault(file);
1408 }
Christian Heimes3b06e532008-01-07 20:12:44 +00001409
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001410 /* Start by trying to turn PEP 3147 path into source path. If that
1411 * fails, just chop off the trailing character, i.e. legacy pyc path
1412 * to py.
1413 */
1414 if (make_source_pathname(file, py) == NULL) {
1415 strncpy(py, file, len-1);
1416 py[len-1] = '\0';
1417 }
Barry Warsaw28a691b2010-04-17 00:19:56 +00001418
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001419 if (stat(py, &statbuf) == 0 &&
1420 S_ISREG(statbuf.st_mode)) {
1421 u = PyUnicode_DecodeFSDefault(py);
1422 }
1423 else {
1424 u = PyUnicode_DecodeFSDefault(file);
1425 }
1426 return u;
Christian Heimes3b06e532008-01-07 20:12:44 +00001427}
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001428
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001429/* Forward */
Just van Rossum52e14d62002-12-30 22:08:05 +00001430static PyObject *load_module(char *, FILE *, char *, int, PyObject *);
1431static struct filedescr *find_module(char *, char *, PyObject *,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001432 char *, size_t, FILE **, PyObject **);
Victor Stinner53dc7352011-03-20 01:50:21 +01001433static struct _frozen * find_frozen(PyObject *);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001434
1435/* Load a package and return its module object WITH INCREMENTED
1436 REFERENCE COUNT */
1437
1438static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001439load_package(char *name, char *pathname)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001440{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001441 PyObject *m, *d;
1442 PyObject *file = NULL;
1443 PyObject *path = NULL;
1444 int err;
1445 char buf[MAXPATHLEN+1];
1446 FILE *fp = NULL;
1447 struct filedescr *fdp;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001448
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001449 m = PyImport_AddModule(name);
1450 if (m == NULL)
1451 return NULL;
1452 if (Py_VerboseFlag)
1453 PySys_WriteStderr("import %s # directory %s\n",
1454 name, pathname);
1455 d = PyModule_GetDict(m);
1456 file = get_sourcefile(pathname);
1457 if (file == NULL)
1458 goto error;
1459 path = Py_BuildValue("[O]", file);
1460 if (path == NULL)
1461 goto error;
1462 err = PyDict_SetItemString(d, "__file__", file);
1463 if (err == 0)
1464 err = PyDict_SetItemString(d, "__path__", path);
1465 if (err != 0)
1466 goto error;
1467 buf[0] = '\0';
1468 fdp = find_module(name, "__init__", path, buf, sizeof(buf), &fp, NULL);
1469 if (fdp == NULL) {
1470 if (PyErr_ExceptionMatches(PyExc_ImportError)) {
1471 PyErr_Clear();
1472 Py_INCREF(m);
1473 }
1474 else
1475 m = NULL;
1476 goto cleanup;
1477 }
1478 m = load_module(name, fp, buf, fdp->type, NULL);
1479 if (fp != NULL)
1480 fclose(fp);
1481 goto cleanup;
Tim Peters1cd70172004-08-02 03:52:12 +00001482
1483 error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001484 m = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001485 cleanup:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001486 Py_XDECREF(path);
1487 Py_XDECREF(file);
1488 return m;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001489}
1490
1491
1492/* Helper to test for built-in module */
1493
1494static int
Victor Stinner95872862011-03-07 18:20:56 +01001495is_builtin(PyObject *name)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001496{
Victor Stinner95872862011-03-07 18:20:56 +01001497 int i, cmp;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001498 for (i = 0; PyImport_Inittab[i].name != NULL; i++) {
Victor Stinner95872862011-03-07 18:20:56 +01001499 cmp = PyUnicode_CompareWithASCIIString(name, PyImport_Inittab[i].name);
1500 if (cmp == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001501 if (PyImport_Inittab[i].initfunc == NULL)
1502 return -1;
1503 else
1504 return 1;
1505 }
1506 }
1507 return 0;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001508}
1509
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001510
Just van Rossum52e14d62002-12-30 22:08:05 +00001511/* Return an importer object for a sys.path/pkg.__path__ item 'p',
1512 possibly by fetching it from the path_importer_cache dict. If it
Thomas Wouters89f507f2006-12-13 04:49:30 +00001513 wasn't yet cached, traverse path_hooks until a hook is found
Just van Rossum52e14d62002-12-30 22:08:05 +00001514 that can handle the path item. Return None if no hook could;
1515 this tells our caller it should fall back to the builtin
1516 import mechanism. Cache the result in path_importer_cache.
1517 Returns a borrowed reference. */
1518
1519static PyObject *
1520get_path_importer(PyObject *path_importer_cache, PyObject *path_hooks,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001521 PyObject *p)
Just van Rossum52e14d62002-12-30 22:08:05 +00001522{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001523 PyObject *importer;
1524 Py_ssize_t j, nhooks;
Just van Rossum52e14d62002-12-30 22:08:05 +00001525
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001526 /* These conditions are the caller's responsibility: */
1527 assert(PyList_Check(path_hooks));
1528 assert(PyDict_Check(path_importer_cache));
Just van Rossum52e14d62002-12-30 22:08:05 +00001529
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001530 nhooks = PyList_Size(path_hooks);
1531 if (nhooks < 0)
1532 return NULL; /* Shouldn't happen */
Just van Rossum52e14d62002-12-30 22:08:05 +00001533
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001534 importer = PyDict_GetItem(path_importer_cache, p);
1535 if (importer != NULL)
1536 return importer;
Just van Rossum52e14d62002-12-30 22:08:05 +00001537
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001538 /* set path_importer_cache[p] to None to avoid recursion */
1539 if (PyDict_SetItem(path_importer_cache, p, Py_None) != 0)
1540 return NULL;
Just van Rossum52e14d62002-12-30 22:08:05 +00001541
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001542 for (j = 0; j < nhooks; j++) {
1543 PyObject *hook = PyList_GetItem(path_hooks, j);
1544 if (hook == NULL)
1545 return NULL;
1546 importer = PyObject_CallFunctionObjArgs(hook, p, NULL);
1547 if (importer != NULL)
1548 break;
Just van Rossum52e14d62002-12-30 22:08:05 +00001549
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001550 if (!PyErr_ExceptionMatches(PyExc_ImportError)) {
1551 return NULL;
1552 }
1553 PyErr_Clear();
1554 }
1555 if (importer == NULL) {
1556 importer = PyObject_CallFunctionObjArgs(
1557 (PyObject *)&PyNullImporter_Type, p, NULL
1558 );
1559 if (importer == NULL) {
1560 if (PyErr_ExceptionMatches(PyExc_ImportError)) {
1561 PyErr_Clear();
1562 return Py_None;
1563 }
1564 }
1565 }
1566 if (importer != NULL) {
1567 int err = PyDict_SetItem(path_importer_cache, p, importer);
1568 Py_DECREF(importer);
1569 if (err != 0)
1570 return NULL;
1571 }
1572 return importer;
Just van Rossum52e14d62002-12-30 22:08:05 +00001573}
1574
Christian Heimes9cd17752007-11-18 19:35:23 +00001575PyAPI_FUNC(PyObject *)
1576PyImport_GetImporter(PyObject *path) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001577 PyObject *importer=NULL, *path_importer_cache=NULL, *path_hooks=NULL;
Christian Heimes9cd17752007-11-18 19:35:23 +00001578
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001579 if ((path_importer_cache = PySys_GetObject("path_importer_cache"))) {
1580 if ((path_hooks = PySys_GetObject("path_hooks"))) {
1581 importer = get_path_importer(path_importer_cache,
1582 path_hooks, path);
1583 }
1584 }
1585 Py_XINCREF(importer); /* get_path_importer returns a borrowed reference */
1586 return importer;
Christian Heimes9cd17752007-11-18 19:35:23 +00001587}
1588
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001589/* Search the path (default sys.path) for a module. Return the
1590 corresponding filedescr struct, and (via return arguments) the
1591 pathname and an open file. Return NULL if the module is not found. */
1592
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001593#ifdef MS_COREDLL
Victor Stinner4d6c1c42011-03-08 23:49:04 +01001594extern FILE *_PyWin_FindRegisteredModule(PyObject *, struct filedescr **,
1595 PyObject **p_path);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001596#endif
1597
Martin v. Löwis18e16552006-02-15 17:27:45 +00001598static int case_ok(char *, Py_ssize_t, Py_ssize_t, char *);
Tim Petersdbd9ba62000-07-09 03:09:57 +00001599static int find_init_module(char *); /* Forward */
Just van Rossum52e14d62002-12-30 22:08:05 +00001600static struct filedescr importhookdescr = {"", "", IMP_HOOK};
Guido van Rossum197346f1997-10-31 18:38:52 +00001601
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001602static struct filedescr *
Just van Rossum52e14d62002-12-30 22:08:05 +00001603find_module(char *fullname, char *subname, PyObject *path, char *buf,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001604 size_t buflen, FILE **p_fp, PyObject **p_loader)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001605{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001606 Py_ssize_t i, npath;
1607 size_t len, namelen;
1608 struct filedescr *fdp = NULL;
1609 char *filemode;
1610 FILE *fp = NULL;
1611 PyObject *path_hooks, *path_importer_cache;
1612 struct stat statbuf;
1613 static struct filedescr fd_frozen = {"", "", PY_FROZEN};
1614 static struct filedescr fd_builtin = {"", "", C_BUILTIN};
1615 static struct filedescr fd_package = {"", "", PKG_DIRECTORY};
1616 char name[MAXPATHLEN+1];
Andrew MacIntyred9400542002-02-26 11:41:34 +00001617#if defined(PYOS_OS2)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001618 size_t saved_len;
1619 size_t saved_namelen;
1620 char *saved_buf = NULL;
Andrew MacIntyred9400542002-02-26 11:41:34 +00001621#endif
Victor Stinner95872862011-03-07 18:20:56 +01001622 PyObject *fullname_obj, *nameobj;
Victor Stinner53dc7352011-03-20 01:50:21 +01001623
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001624 if (p_loader != NULL)
1625 *p_loader = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001626
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001627 if (strlen(subname) > MAXPATHLEN) {
1628 PyErr_SetString(PyExc_OverflowError,
1629 "module name is too long");
1630 return NULL;
1631 }
1632 strcpy(name, subname);
Just van Rossum52e14d62002-12-30 22:08:05 +00001633
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001634 /* sys.meta_path import hook */
1635 if (p_loader != NULL) {
1636 PyObject *meta_path;
Just van Rossum52e14d62002-12-30 22:08:05 +00001637
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001638 meta_path = PySys_GetObject("meta_path");
1639 if (meta_path == NULL || !PyList_Check(meta_path)) {
1640 PyErr_SetString(PyExc_ImportError,
1641 "sys.meta_path must be a list of "
1642 "import hooks");
1643 return NULL;
1644 }
1645 Py_INCREF(meta_path); /* zap guard */
1646 npath = PyList_Size(meta_path);
1647 for (i = 0; i < npath; i++) {
1648 PyObject *loader;
1649 PyObject *hook = PyList_GetItem(meta_path, i);
1650 loader = PyObject_CallMethod(hook, "find_module",
1651 "sO", fullname,
1652 path != NULL ?
1653 path : Py_None);
1654 if (loader == NULL) {
1655 Py_DECREF(meta_path);
1656 return NULL; /* true error */
1657 }
1658 if (loader != Py_None) {
1659 /* a loader was found */
1660 *p_loader = loader;
1661 Py_DECREF(meta_path);
1662 return &importhookdescr;
1663 }
1664 Py_DECREF(loader);
1665 }
1666 Py_DECREF(meta_path);
1667 }
Guido van Rossum0506a431998-08-11 15:07:39 +00001668
Victor Stinner53dc7352011-03-20 01:50:21 +01001669 if (fullname != NULL) {
1670 fullname_obj = PyUnicode_FromString(fullname);
1671 if (fullname == NULL)
1672 return NULL;
1673 if (find_frozen(fullname_obj) != NULL) {
1674 Py_DECREF(fullname_obj);
1675 strcpy(buf, fullname);
1676 return &fd_frozen;
1677 }
1678 Py_DECREF(fullname_obj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001679 }
Benjamin Petersond968e272008-11-05 22:48:33 +00001680
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001681 if (path == NULL) {
Victor Stinner4d6c1c42011-03-08 23:49:04 +01001682#ifdef MS_COREDLL
1683 PyObject *filename, *filename_bytes;
1684#endif
Victor Stinner95872862011-03-07 18:20:56 +01001685 nameobj = PyUnicode_FromString(name);
1686 if (nameobj == NULL)
1687 return NULL;
1688 if (is_builtin(nameobj)) {
1689 Py_DECREF(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001690 strcpy(buf, name);
1691 return &fd_builtin;
1692 }
Guido van Rossumac279101996-08-22 23:10:58 +00001693#ifdef MS_COREDLL
Victor Stinner4d6c1c42011-03-08 23:49:04 +01001694 fp = _PyWin_FindRegisteredModule(nameobj, &fdp, &filename);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001695 if (fp != NULL) {
Victor Stinner4d6c1c42011-03-08 23:49:04 +01001696 Py_DECREF(nameobj);
1697 filename_bytes = PyUnicode_EncodeFSDefault(filename);
1698 Py_DECREF(filename);
1699 if (filename_bytes == NULL)
1700 return NULL;
1701 strncpy(buf, PyBytes_AS_STRING(filename_bytes), buflen);
1702 buf[buflen-1] = '\0';
1703 Py_DECREF(filename_bytes);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001704 *p_fp = fp;
1705 return fdp;
1706 }
Victor Stinner4d6c1c42011-03-08 23:49:04 +01001707 else if (PyErr_Occurred())
1708 return NULL;
Guido van Rossuma5a3db71996-04-09 02:39:59 +00001709#endif
Victor Stinner4d6c1c42011-03-08 23:49:04 +01001710 Py_DECREF(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001711 path = PySys_GetObject("path");
1712 }
Benjamin Petersond968e272008-11-05 22:48:33 +00001713
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001714 if (path == NULL || !PyList_Check(path)) {
1715 PyErr_SetString(PyExc_ImportError,
1716 "sys.path must be a list of directory names");
1717 return NULL;
1718 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001719
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001720 path_hooks = PySys_GetObject("path_hooks");
1721 if (path_hooks == NULL || !PyList_Check(path_hooks)) {
1722 PyErr_SetString(PyExc_ImportError,
1723 "sys.path_hooks must be a list of "
1724 "import hooks");
1725 return NULL;
1726 }
1727 path_importer_cache = PySys_GetObject("path_importer_cache");
1728 if (path_importer_cache == NULL ||
1729 !PyDict_Check(path_importer_cache)) {
1730 PyErr_SetString(PyExc_ImportError,
1731 "sys.path_importer_cache must be a dict");
1732 return NULL;
1733 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001734
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001735 npath = PyList_Size(path);
1736 namelen = strlen(name);
1737 for (i = 0; i < npath; i++) {
1738 PyObject *v = PyList_GetItem(path, i);
1739 PyObject *origv = v;
1740 const char *base;
1741 Py_ssize_t size;
1742 if (!v)
1743 return NULL;
1744 if (PyUnicode_Check(v)) {
Victor Stinnerae6265f2010-05-15 16:27:27 +00001745 v = PyUnicode_EncodeFSDefault(v);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001746 if (v == NULL)
1747 return NULL;
1748 }
1749 else if (!PyBytes_Check(v))
1750 continue;
1751 else
1752 Py_INCREF(v);
Amaury Forgeot d'Arcf1ca0b12008-06-11 17:40:47 +00001753
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001754 base = PyBytes_AS_STRING(v);
1755 size = PyBytes_GET_SIZE(v);
1756 len = size;
1757 if (len + 2 + namelen + MAXSUFFIXSIZE >= buflen) {
1758 Py_DECREF(v);
1759 continue; /* Too long */
1760 }
1761 strcpy(buf, base);
1762 Py_DECREF(v);
Amaury Forgeot d'Arcf1ca0b12008-06-11 17:40:47 +00001763
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001764 if (strlen(buf) != len) {
1765 continue; /* v contains '\0' */
1766 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001767
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001768 /* sys.path_hooks import hook */
1769 if (p_loader != NULL) {
1770 PyObject *importer;
Just van Rossum52e14d62002-12-30 22:08:05 +00001771
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001772 importer = get_path_importer(path_importer_cache,
1773 path_hooks, origv);
1774 if (importer == NULL) {
1775 return NULL;
1776 }
1777 /* Note: importer is a borrowed reference */
1778 if (importer != Py_None) {
1779 PyObject *loader;
1780 loader = PyObject_CallMethod(importer,
1781 "find_module",
1782 "s", fullname);
1783 if (loader == NULL)
1784 return NULL; /* error */
1785 if (loader != Py_None) {
1786 /* a loader was found */
1787 *p_loader = loader;
1788 return &importhookdescr;
1789 }
1790 Py_DECREF(loader);
1791 continue;
1792 }
1793 }
1794 /* no hook was found, use builtin import */
Just van Rossum52e14d62002-12-30 22:08:05 +00001795
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001796 if (len > 0 && buf[len-1] != SEP
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001797#ifdef ALTSEP
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001798 && buf[len-1] != ALTSEP
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001799#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001800 )
1801 buf[len++] = SEP;
1802 strcpy(buf+len, name);
1803 len += namelen;
Tim Peters50d8d372001-02-28 05:34:27 +00001804
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001805 /* Check for package import (buf holds a directory name,
1806 and there's an __init__ module in that directory */
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001807#ifdef HAVE_STAT
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001808 if (stat(buf, &statbuf) == 0 && /* it exists */
1809 S_ISDIR(statbuf.st_mode) && /* it's a directory */
1810 case_ok(buf, len, namelen, name)) { /* case matches */
1811 if (find_init_module(buf)) { /* and has __init__.py */
1812 return &fd_package;
1813 }
1814 else {
Victor Stinnered7916d2010-10-17 02:07:09 +00001815 int err;
1816 PyObject *unicode = PyUnicode_DecodeFSDefault(buf);
1817 if (unicode == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001818 return NULL;
Victor Stinnered7916d2010-10-17 02:07:09 +00001819 err = PyErr_WarnFormat(PyExc_ImportWarning, 1,
1820 "Not importing directory '%U': missing __init__.py",
1821 unicode);
1822 Py_DECREF(unicode);
1823 if (err)
1824 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001825 }
1826 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001827#endif
Andrew MacIntyred9400542002-02-26 11:41:34 +00001828#if defined(PYOS_OS2)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001829 /* take a snapshot of the module spec for restoration
1830 * after the 8 character DLL hackery
1831 */
1832 saved_buf = strdup(buf);
1833 saved_len = len;
1834 saved_namelen = namelen;
Andrew MacIntyred9400542002-02-26 11:41:34 +00001835#endif /* PYOS_OS2 */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001836 for (fdp = _PyImport_Filetab; fdp->suffix != NULL; fdp++) {
Guido van Rossum04110fb2007-08-24 16:32:05 +00001837#if defined(PYOS_OS2) && defined(HAVE_DYNAMIC_LOADING)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001838 /* OS/2 limits DLLs to 8 character names (w/o
1839 extension)
1840 * so if the name is longer than that and its a
1841 * dynamically loaded module we're going to try,
1842 * truncate the name before trying
1843 */
1844 if (strlen(subname) > 8) {
1845 /* is this an attempt to load a C extension? */
1846 const struct filedescr *scan;
1847 scan = _PyImport_DynLoadFiletab;
1848 while (scan->suffix != NULL) {
1849 if (!strcmp(scan->suffix, fdp->suffix))
1850 break;
1851 else
1852 scan++;
1853 }
1854 if (scan->suffix != NULL) {
1855 /* yes, so truncate the name */
1856 namelen = 8;
1857 len -= strlen(subname) - namelen;
1858 buf[len] = '\0';
1859 }
1860 }
Andrew MacIntyred9400542002-02-26 11:41:34 +00001861#endif /* PYOS_OS2 */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001862 strcpy(buf+len, fdp->suffix);
1863 if (Py_VerboseFlag > 1)
1864 PySys_WriteStderr("# trying %s\n", buf);
1865 filemode = fdp->mode;
1866 if (filemode[0] == 'U')
1867 filemode = "r" PY_STDIOTEXTMODE;
1868 fp = fopen(buf, filemode);
1869 if (fp != NULL) {
1870 if (case_ok(buf, len, namelen, name))
1871 break;
1872 else { /* continue search */
1873 fclose(fp);
1874 fp = NULL;
1875 }
1876 }
Andrew MacIntyred9400542002-02-26 11:41:34 +00001877#if defined(PYOS_OS2)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001878 /* restore the saved snapshot */
1879 strcpy(buf, saved_buf);
1880 len = saved_len;
1881 namelen = saved_namelen;
Andrew MacIntyred9400542002-02-26 11:41:34 +00001882#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001883 }
Andrew MacIntyred9400542002-02-26 11:41:34 +00001884#if defined(PYOS_OS2)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001885 /* don't need/want the module name snapshot anymore */
1886 if (saved_buf)
1887 {
1888 free(saved_buf);
1889 saved_buf = NULL;
1890 }
Andrew MacIntyred9400542002-02-26 11:41:34 +00001891#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001892 if (fp != NULL)
1893 break;
1894 }
1895 if (fp == NULL) {
1896 PyErr_Format(PyExc_ImportError,
1897 "No module named %.200s", name);
1898 return NULL;
1899 }
1900 *p_fp = fp;
1901 return fdp;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001902}
1903
Martin v. Löwis18e16552006-02-15 17:27:45 +00001904/* case_ok(char* buf, Py_ssize_t len, Py_ssize_t namelen, char* name)
Tim Petersd1e87a82001-03-01 18:12:00 +00001905 * The arguments here are tricky, best shown by example:
1906 * /a/b/c/d/e/f/g/h/i/j/k/some_long_module_name.py\0
1907 * ^ ^ ^ ^
1908 * |--------------------- buf ---------------------|
1909 * |------------------- len ------------------|
1910 * |------ name -------|
1911 * |----- namelen -----|
1912 * buf is the full path, but len only counts up to (& exclusive of) the
1913 * extension. name is the module name, also exclusive of extension.
1914 *
1915 * We've already done a successful stat() or fopen() on buf, so know that
1916 * there's some match, possibly case-insensitive.
1917 *
Tim Peters50d8d372001-02-28 05:34:27 +00001918 * case_ok() is to return 1 if there's a case-sensitive match for
1919 * name, else 0. case_ok() is also to return 1 if envar PYTHONCASEOK
1920 * exists.
Tim Petersd1e87a82001-03-01 18:12:00 +00001921 *
Tim Peters50d8d372001-02-28 05:34:27 +00001922 * case_ok() is used to implement case-sensitive import semantics even
1923 * on platforms with case-insensitive filesystems. It's trivial to implement
1924 * for case-sensitive filesystems. It's pretty much a cross-platform
1925 * nightmare for systems with case-insensitive filesystems.
1926 */
Guido van Rossum0980bd91998-02-13 17:18:36 +00001927
Tim Peters50d8d372001-02-28 05:34:27 +00001928/* First we may need a pile of platform-specific header files; the sequence
1929 * of #if's here should match the sequence in the body of case_ok().
1930 */
Jason Tishler7961aa62005-05-20 00:56:54 +00001931#if defined(MS_WINDOWS)
Guido van Rossum0980bd91998-02-13 17:18:36 +00001932#include <windows.h>
Guido van Rossum4c3f57c2001-01-10 20:40:46 +00001933
Tim Peters50d8d372001-02-28 05:34:27 +00001934#elif defined(DJGPP)
1935#include <dir.h>
1936
Jason Tishler7961aa62005-05-20 00:56:54 +00001937#elif (defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) && defined(HAVE_DIRENT_H)
Tim Peters430f5d42001-03-01 01:30:56 +00001938#include <sys/types.h>
1939#include <dirent.h>
1940
Andrew MacIntyred9400542002-02-26 11:41:34 +00001941#elif defined(PYOS_OS2)
1942#define INCL_DOS
1943#define INCL_DOSERRORS
1944#define INCL_NOPMAPI
1945#include <os2.h>
Tim Peters50d8d372001-02-28 05:34:27 +00001946#endif
1947
Guido van Rossum0980bd91998-02-13 17:18:36 +00001948static int
Martin v. Löwis18e16552006-02-15 17:27:45 +00001949case_ok(char *buf, Py_ssize_t len, Py_ssize_t namelen, char *name)
Guido van Rossum0980bd91998-02-13 17:18:36 +00001950{
Tim Peters50d8d372001-02-28 05:34:27 +00001951/* Pick a platform-specific implementation; the sequence of #if's here should
1952 * match the sequence just above.
1953 */
1954
Jason Tishler7961aa62005-05-20 00:56:54 +00001955/* MS_WINDOWS */
1956#if defined(MS_WINDOWS)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001957 WIN32_FIND_DATA data;
1958 HANDLE h;
Tim Peters50d8d372001-02-28 05:34:27 +00001959
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001960 if (Py_GETENV("PYTHONCASEOK") != NULL)
1961 return 1;
Tim Peters50d8d372001-02-28 05:34:27 +00001962
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001963 h = FindFirstFile(buf, &data);
1964 if (h == INVALID_HANDLE_VALUE) {
1965 PyErr_Format(PyExc_NameError,
1966 "Can't find file for module %.100s\n(filename %.300s)",
1967 name, buf);
1968 return 0;
1969 }
1970 FindClose(h);
1971 return strncmp(data.cFileName, name, namelen) == 0;
Tim Peters50d8d372001-02-28 05:34:27 +00001972
1973/* DJGPP */
1974#elif defined(DJGPP)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001975 struct ffblk ffblk;
1976 int done;
Tim Peters50d8d372001-02-28 05:34:27 +00001977
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001978 if (Py_GETENV("PYTHONCASEOK") != NULL)
1979 return 1;
Tim Peters50d8d372001-02-28 05:34:27 +00001980
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001981 done = findfirst(buf, &ffblk, FA_ARCH|FA_RDONLY|FA_HIDDEN|FA_DIREC);
1982 if (done) {
1983 PyErr_Format(PyExc_NameError,
1984 "Can't find file for module %.100s\n(filename %.300s)",
1985 name, buf);
1986 return 0;
1987 }
1988 return strncmp(ffblk.ff_name, name, namelen) == 0;
Guido van Rossum0980bd91998-02-13 17:18:36 +00001989
Jason Tishler7961aa62005-05-20 00:56:54 +00001990/* new-fangled macintosh (macosx) or Cygwin */
1991#elif (defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) && defined(HAVE_DIRENT_H)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001992 DIR *dirp;
1993 struct dirent *dp;
1994 char dirname[MAXPATHLEN + 1];
1995 const int dirlen = len - namelen - 1; /* don't want trailing SEP */
Tim Peters430f5d42001-03-01 01:30:56 +00001996
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001997 if (Py_GETENV("PYTHONCASEOK") != NULL)
1998 return 1;
Tim Petersdbe6ebb2001-03-01 08:47:29 +00001999
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002000 /* Copy the dir component into dirname; substitute "." if empty */
2001 if (dirlen <= 0) {
2002 dirname[0] = '.';
2003 dirname[1] = '\0';
2004 }
2005 else {
2006 assert(dirlen <= MAXPATHLEN);
2007 memcpy(dirname, buf, dirlen);
2008 dirname[dirlen] = '\0';
2009 }
2010 /* Open the directory and search the entries for an exact match. */
2011 dirp = opendir(dirname);
2012 if (dirp) {
2013 char *nameWithExt = buf + len - namelen;
2014 while ((dp = readdir(dirp)) != NULL) {
2015 const int thislen =
Tim Peters430f5d42001-03-01 01:30:56 +00002016#ifdef _DIRENT_HAVE_D_NAMELEN
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002017 dp->d_namlen;
Tim Peters430f5d42001-03-01 01:30:56 +00002018#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002019 strlen(dp->d_name);
Tim Peters430f5d42001-03-01 01:30:56 +00002020#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002021 if (thislen >= namelen &&
2022 strcmp(dp->d_name, nameWithExt) == 0) {
2023 (void)closedir(dirp);
2024 return 1; /* Found */
2025 }
2026 }
2027 (void)closedir(dirp);
2028 }
2029 return 0 ; /* Not found */
Tim Peters430f5d42001-03-01 01:30:56 +00002030
Andrew MacIntyred9400542002-02-26 11:41:34 +00002031/* OS/2 */
2032#elif defined(PYOS_OS2)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002033 HDIR hdir = 1;
2034 ULONG srchcnt = 1;
2035 FILEFINDBUF3 ffbuf;
2036 APIRET rc;
Andrew MacIntyred9400542002-02-26 11:41:34 +00002037
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002038 if (Py_GETENV("PYTHONCASEOK") != NULL)
2039 return 1;
Andrew MacIntyred9400542002-02-26 11:41:34 +00002040
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002041 rc = DosFindFirst(buf,
2042 &hdir,
2043 FILE_READONLY | FILE_HIDDEN | FILE_SYSTEM | FILE_DIRECTORY,
2044 &ffbuf, sizeof(ffbuf),
2045 &srchcnt,
2046 FIL_STANDARD);
2047 if (rc != NO_ERROR)
2048 return 0;
2049 return strncmp(ffbuf.achName, name, namelen) == 0;
Andrew MacIntyred9400542002-02-26 11:41:34 +00002050
Tim Peters50d8d372001-02-28 05:34:27 +00002051/* assuming it's a case-sensitive filesystem, so there's nothing to do! */
2052#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002053 return 1;
Guido van Rossum0980bd91998-02-13 17:18:36 +00002054
Guido van Rossum4d1b3b91998-02-13 23:27:59 +00002055#endif
Tim Peters50d8d372001-02-28 05:34:27 +00002056}
Guido van Rossum4d1b3b91998-02-13 23:27:59 +00002057
Guido van Rossum197346f1997-10-31 18:38:52 +00002058#ifdef HAVE_STAT
Victor Stinner4f4402c2010-08-14 14:50:26 +00002059
Guido van Rossum197346f1997-10-31 18:38:52 +00002060/* Helper to look for __init__.py or __init__.py[co] in potential package */
2061static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002062find_init_module(char *buf)
Guido van Rossum197346f1997-10-31 18:38:52 +00002063{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002064 const size_t save_len = strlen(buf);
2065 size_t i = save_len;
2066 char *pname; /* pointer to start of __init__ */
2067 struct stat statbuf;
Guido van Rossum197346f1997-10-31 18:38:52 +00002068
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002069/* For calling case_ok(buf, len, namelen, name):
2070 * /a/b/c/d/e/f/g/h/i/j/k/some_long_module_name.py\0
2071 * ^ ^ ^ ^
2072 * |--------------------- buf ---------------------|
2073 * |------------------- len ------------------|
2074 * |------ name -------|
2075 * |----- namelen -----|
Tim Peters0f9431f2001-07-05 03:47:53 +00002076 */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002077 if (save_len + 13 >= MAXPATHLEN)
2078 return 0;
2079 buf[i++] = SEP;
2080 pname = buf + i;
2081 strcpy(pname, "__init__.py");
2082 if (stat(buf, &statbuf) == 0) {
2083 if (case_ok(buf,
2084 save_len + 9, /* len("/__init__") */
2085 8, /* len("__init__") */
2086 pname)) {
2087 buf[save_len] = '\0';
2088 return 1;
2089 }
2090 }
2091 i += strlen(pname);
2092 strcpy(buf+i, Py_OptimizeFlag ? "o" : "c");
2093 if (stat(buf, &statbuf) == 0) {
2094 if (case_ok(buf,
2095 save_len + 9, /* len("/__init__") */
2096 8, /* len("__init__") */
2097 pname)) {
2098 buf[save_len] = '\0';
2099 return 1;
2100 }
2101 }
2102 buf[save_len] = '\0';
2103 return 0;
Guido van Rossum197346f1997-10-31 18:38:52 +00002104}
Guido van Rossum48a680c2001-03-02 06:34:14 +00002105
Guido van Rossum197346f1997-10-31 18:38:52 +00002106#endif /* HAVE_STAT */
2107
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002108
Victor Stinner95872862011-03-07 18:20:56 +01002109static int init_builtin(PyObject *); /* Forward */
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002110
Victor Stinner44c6c152010-08-09 00:59:10 +00002111static PyObject*
Victor Stinner95872862011-03-07 18:20:56 +01002112load_builtin(PyObject *name, int type)
Victor Stinner44c6c152010-08-09 00:59:10 +00002113{
2114 PyObject *m, *modules;
2115 int err;
2116
Victor Stinner44c6c152010-08-09 00:59:10 +00002117 if (type == C_BUILTIN)
2118 err = init_builtin(name);
2119 else
Victor Stinner95872862011-03-07 18:20:56 +01002120 err = PyImport_ImportFrozenModuleObject(name);
Victor Stinner44c6c152010-08-09 00:59:10 +00002121 if (err < 0)
2122 return NULL;
2123 if (err == 0) {
2124 PyErr_Format(PyExc_ImportError,
Victor Stinner95872862011-03-07 18:20:56 +01002125 "Purported %s module %R not found",
2126 type == C_BUILTIN ? "builtin" : "frozen",
Victor Stinner44c6c152010-08-09 00:59:10 +00002127 name);
2128 return NULL;
2129 }
2130
2131 modules = PyImport_GetModuleDict();
Victor Stinner95872862011-03-07 18:20:56 +01002132 m = PyDict_GetItem(modules, name);
Victor Stinner44c6c152010-08-09 00:59:10 +00002133 if (m == NULL) {
2134 PyErr_Format(
2135 PyExc_ImportError,
Victor Stinner95872862011-03-07 18:20:56 +01002136 "%s module %R not properly initialized",
2137 type == C_BUILTIN ? "builtin" : "frozen",
Victor Stinner44c6c152010-08-09 00:59:10 +00002138 name);
2139 return NULL;
2140 }
2141 Py_INCREF(m);
2142 return m;
2143}
2144
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002145/* Load an external module using the default search path and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00002146 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002147
Guido van Rossum79f25d91997-04-29 20:08:16 +00002148static PyObject *
Alexandre Vassalottie223eb82009-07-29 20:12:15 +00002149load_module(char *name, FILE *fp, char *pathname, int type, PyObject *loader)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002150{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002151 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002152
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002153 /* First check that there's an open file (if we need one) */
2154 switch (type) {
2155 case PY_SOURCE:
2156 case PY_COMPILED:
2157 if (fp == NULL) {
2158 PyErr_Format(PyExc_ValueError,
2159 "file object required for import (type code %d)",
2160 type);
2161 return NULL;
2162 }
2163 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002164
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002165 switch (type) {
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002166
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002167 case PY_SOURCE:
2168 m = load_source_module(name, pathname, fp);
2169 break;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002170
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002171 case PY_COMPILED:
2172 m = load_compiled_module(name, pathname, fp);
2173 break;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002174
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002175#ifdef HAVE_DYNAMIC_LOADING
Victor Stinnerfefd70c2011-03-14 15:54:07 -04002176 case C_EXTENSION: {
2177 PyObject *nameobj, *pathobj;
2178 nameobj = PyUnicode_FromString(name);
2179 if (nameobj == NULL)
2180 return NULL;
2181 pathobj = PyUnicode_DecodeFSDefault(pathname);
2182 if (pathobj == NULL) {
2183 Py_DECREF(nameobj);
2184 return NULL;
2185 }
2186 m = _PyImport_LoadDynamicModule(nameobj, pathobj, fp);
2187 Py_DECREF(nameobj);
2188 Py_DECREF(pathobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002189 break;
Victor Stinnerfefd70c2011-03-14 15:54:07 -04002190 }
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002191#endif
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002192
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002193 case PKG_DIRECTORY:
2194 m = load_package(name, pathname);
2195 break;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002196
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002197 case C_BUILTIN:
Victor Stinner95872862011-03-07 18:20:56 +01002198 case PY_FROZEN: {
2199 PyObject *nameobj = PyUnicode_FromString(name);
Victor Stinnerfefd70c2011-03-14 15:54:07 -04002200 if (nameobj == NULL)
2201 return NULL;
2202 m = load_builtin(nameobj, type);
2203 Py_DECREF(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002204 break;
Victor Stinner95872862011-03-07 18:20:56 +01002205 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002206
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002207 case IMP_HOOK: {
2208 if (loader == NULL) {
2209 PyErr_SetString(PyExc_ImportError,
2210 "import hook without loader");
2211 return NULL;
2212 }
2213 m = PyObject_CallMethod(loader, "load_module", "s", name);
2214 break;
2215 }
Just van Rossum52e14d62002-12-30 22:08:05 +00002216
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002217 default:
2218 PyErr_Format(PyExc_ImportError,
2219 "Don't know how to import %.200s (type code %d)",
2220 name, type);
2221 m = NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002222
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002223 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002224
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002225 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002226}
2227
2228
2229/* Initialize a built-in module.
Thomas Wouters89f507f2006-12-13 04:49:30 +00002230 Return 1 for success, 0 if the module is not found, and -1 with
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002231 an exception set if the initialization failed. */
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002232
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002233static int
Victor Stinner95872862011-03-07 18:20:56 +01002234init_builtin(PyObject *name)
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002235{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002236 struct _inittab *p;
Guido van Rossum25ce5661997-08-02 03:10:38 +00002237
Victor Stinner95872862011-03-07 18:20:56 +01002238 if (_PyImport_FindExtensionObject(name, name) != NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002239 return 1;
Guido van Rossum25ce5661997-08-02 03:10:38 +00002240
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002241 for (p = PyImport_Inittab; p->name != NULL; p++) {
2242 PyObject *mod;
Victor Stinner95872862011-03-07 18:20:56 +01002243 if (PyUnicode_CompareWithASCIIString(name, p->name) == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002244 if (p->initfunc == NULL) {
2245 PyErr_Format(PyExc_ImportError,
Victor Stinner95872862011-03-07 18:20:56 +01002246 "Cannot re-init internal module %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002247 name);
2248 return -1;
2249 }
2250 if (Py_VerboseFlag)
Victor Stinner95872862011-03-07 18:20:56 +01002251 PySys_FormatStderr("import %U # builtin\n", name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002252 mod = (*p->initfunc)();
2253 if (mod == 0)
2254 return -1;
Victor Stinner95872862011-03-07 18:20:56 +01002255 if (_PyImport_FixupExtensionObject(mod, name, name) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002256 return -1;
2257 /* FixupExtension has put the module into sys.modules,
2258 so we can release our own reference. */
2259 Py_DECREF(mod);
2260 return 1;
2261 }
2262 }
2263 return 0;
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002264}
Guido van Rossumf56e3db1993-04-01 20:59:32 +00002265
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002266
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002267/* Frozen modules */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002268
Guido van Rossumcfd0a221996-06-17 17:06:34 +00002269static struct _frozen *
Victor Stinner53dc7352011-03-20 01:50:21 +01002270find_frozen(PyObject *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002271{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002272 struct _frozen *p;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002273
Victor Stinner53dc7352011-03-20 01:50:21 +01002274 if (name == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002275 return NULL;
Benjamin Petersond968e272008-11-05 22:48:33 +00002276
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002277 for (p = PyImport_FrozenModules; ; p++) {
2278 if (p->name == NULL)
2279 return NULL;
Victor Stinner53dc7352011-03-20 01:50:21 +01002280 if (PyUnicode_CompareWithASCIIString(name, p->name) == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002281 break;
2282 }
2283 return p;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002284}
2285
Guido van Rossum79f25d91997-04-29 20:08:16 +00002286static PyObject *
Victor Stinner53dc7352011-03-20 01:50:21 +01002287get_frozen_object(PyObject *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002288{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002289 struct _frozen *p = find_frozen(name);
2290 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002291
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002292 if (p == NULL) {
2293 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002294 "No such frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002295 name);
2296 return NULL;
2297 }
2298 if (p->code == NULL) {
2299 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002300 "Excluded frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002301 name);
2302 return NULL;
2303 }
2304 size = p->size;
2305 if (size < 0)
2306 size = -size;
2307 return PyMarshal_ReadObjectFromString((char *)p->code, size);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002308}
2309
Brett Cannon8d110132009-03-15 02:20:16 +00002310static PyObject *
Victor Stinner53dc7352011-03-20 01:50:21 +01002311is_frozen_package(PyObject *name)
Brett Cannon8d110132009-03-15 02:20:16 +00002312{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002313 struct _frozen *p = find_frozen(name);
2314 int size;
Brett Cannon8d110132009-03-15 02:20:16 +00002315
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002316 if (p == NULL) {
2317 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002318 "No such frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002319 name);
2320 return NULL;
2321 }
Brett Cannon8d110132009-03-15 02:20:16 +00002322
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002323 size = p->size;
Brett Cannon8d110132009-03-15 02:20:16 +00002324
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002325 if (size < 0)
2326 Py_RETURN_TRUE;
2327 else
2328 Py_RETURN_FALSE;
Brett Cannon8d110132009-03-15 02:20:16 +00002329}
2330
2331
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002332/* Initialize a frozen module.
Brett Cannon3c2ac442009-03-08 20:49:47 +00002333 Return 1 for success, 0 if the module is not found, and -1 with
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002334 an exception set if the initialization failed.
2335 This function is also used from frozenmain.c */
Guido van Rossum0b344901995-02-07 15:35:27 +00002336
2337int
Victor Stinner53dc7352011-03-20 01:50:21 +01002338PyImport_ImportFrozenModuleObject(PyObject *name)
Guido van Rossumf56e3db1993-04-01 20:59:32 +00002339{
Victor Stinner53dc7352011-03-20 01:50:21 +01002340 struct _frozen *p;
2341 PyObject *co, *m, *path;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002342 int ispackage;
2343 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002344
Victor Stinner53dc7352011-03-20 01:50:21 +01002345 p = find_frozen(name);
2346
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002347 if (p == NULL)
2348 return 0;
2349 if (p->code == NULL) {
2350 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002351 "Excluded frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002352 name);
2353 return -1;
2354 }
2355 size = p->size;
2356 ispackage = (size < 0);
2357 if (ispackage)
2358 size = -size;
2359 if (Py_VerboseFlag)
Victor Stinner53dc7352011-03-20 01:50:21 +01002360 PySys_FormatStderr("import %U # frozen%s\n",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002361 name, ispackage ? " package" : "");
2362 co = PyMarshal_ReadObjectFromString((char *)p->code, size);
2363 if (co == NULL)
2364 return -1;
2365 if (!PyCode_Check(co)) {
2366 PyErr_Format(PyExc_TypeError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002367 "frozen object %R is not a code object",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002368 name);
2369 goto err_return;
2370 }
2371 if (ispackage) {
2372 /* Set __path__ to the package name */
Victor Stinner53dc7352011-03-20 01:50:21 +01002373 PyObject *d, *l;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002374 int err;
Victor Stinner53dc7352011-03-20 01:50:21 +01002375 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002376 if (m == NULL)
2377 goto err_return;
2378 d = PyModule_GetDict(m);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002379 l = PyList_New(1);
2380 if (l == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002381 goto err_return;
2382 }
Victor Stinner53dc7352011-03-20 01:50:21 +01002383 Py_INCREF(name);
2384 PyList_SET_ITEM(l, 0, name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002385 err = PyDict_SetItemString(d, "__path__", l);
2386 Py_DECREF(l);
2387 if (err != 0)
2388 goto err_return;
2389 }
Victor Stinner53dc7352011-03-20 01:50:21 +01002390 path = PyUnicode_FromString("<frozen>");
2391 if (path == NULL)
2392 goto err_return;
2393 m = PyImport_ExecCodeModuleObject(name, co, path, NULL);
2394 Py_DECREF(path);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002395 if (m == NULL)
2396 goto err_return;
2397 Py_DECREF(co);
2398 Py_DECREF(m);
2399 return 1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002400err_return:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002401 Py_DECREF(co);
2402 return -1;
Guido van Rossumf56e3db1993-04-01 20:59:32 +00002403}
Guido van Rossum74e6a111994-08-29 12:54:38 +00002404
Victor Stinner53dc7352011-03-20 01:50:21 +01002405int
2406PyImport_ImportFrozenModule(char *name)
2407{
2408 PyObject *nameobj;
2409 int ret;
2410 nameobj = PyUnicode_InternFromString(name);
2411 if (nameobj == NULL)
2412 return -1;
2413 ret = PyImport_ImportFrozenModuleObject(nameobj);
2414 Py_DECREF(nameobj);
2415 return ret;
2416}
2417
Guido van Rossum74e6a111994-08-29 12:54:38 +00002418
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002419/* Import a module, either built-in, frozen, or external, and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00002420 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum74e6a111994-08-29 12:54:38 +00002421
Guido van Rossum79f25d91997-04-29 20:08:16 +00002422PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00002423PyImport_ImportModule(const char *name)
Guido van Rossum74e6a111994-08-29 12:54:38 +00002424{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002425 PyObject *pname;
2426 PyObject *result;
Marc-André Lemburg3c61c352001-02-09 19:40:15 +00002427
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002428 pname = PyUnicode_FromString(name);
2429 if (pname == NULL)
2430 return NULL;
2431 result = PyImport_Import(pname);
2432 Py_DECREF(pname);
2433 return result;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002434}
2435
Christian Heimes072c0f12008-01-03 23:01:04 +00002436/* Import a module without blocking
2437 *
2438 * At first it tries to fetch the module from sys.modules. If the module was
2439 * never loaded before it loads it with PyImport_ImportModule() unless another
2440 * thread holds the import lock. In the latter case the function raises an
2441 * ImportError instead of blocking.
2442 *
2443 * Returns the module object with incremented ref count.
2444 */
2445PyObject *
2446PyImport_ImportModuleNoBlock(const char *name)
2447{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002448 PyObject *result;
2449 PyObject *modules;
2450 long me;
Christian Heimes072c0f12008-01-03 23:01:04 +00002451
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002452 /* Try to get the module from sys.modules[name] */
2453 modules = PyImport_GetModuleDict();
2454 if (modules == NULL)
2455 return NULL;
Christian Heimes072c0f12008-01-03 23:01:04 +00002456
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002457 result = PyDict_GetItemString(modules, name);
2458 if (result != NULL) {
2459 Py_INCREF(result);
2460 return result;
2461 }
2462 else {
2463 PyErr_Clear();
2464 }
Benjamin Peterson3e4f0552008-09-02 00:31:15 +00002465#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002466 /* check the import lock
2467 * me might be -1 but I ignore the error here, the lock function
2468 * takes care of the problem */
2469 me = PyThread_get_thread_ident();
2470 if (import_lock_thread == -1 || import_lock_thread == me) {
2471 /* no thread or me is holding the lock */
2472 return PyImport_ImportModule(name);
2473 }
2474 else {
2475 PyErr_Format(PyExc_ImportError,
2476 "Failed to import %.200s because the import lock"
2477 "is held by another thread.",
2478 name);
2479 return NULL;
2480 }
Benjamin Peterson3e4f0552008-09-02 00:31:15 +00002481#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002482 return PyImport_ImportModule(name);
Benjamin Peterson3e4f0552008-09-02 00:31:15 +00002483#endif
Christian Heimes072c0f12008-01-03 23:01:04 +00002484}
2485
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002486/* Forward declarations for helper routines */
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002487static PyObject *get_parent(PyObject *globals, char *buf,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002488 Py_ssize_t *p_buflen, int level);
Tim Petersdbd9ba62000-07-09 03:09:57 +00002489static PyObject *load_next(PyObject *mod, PyObject *altmod,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002490 char **p_name, char *buf, Py_ssize_t *p_buflen);
Tim Petersdbd9ba62000-07-09 03:09:57 +00002491static int mark_miss(char *name);
2492static int ensure_fromlist(PyObject *mod, PyObject *fromlist,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002493 char *buf, Py_ssize_t buflen, int recursive);
Tim Petersdbd9ba62000-07-09 03:09:57 +00002494static PyObject * import_submodule(PyObject *mod, char *name, char *fullname);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002495
2496/* The Magnum Opus of dotted-name import :-) */
2497
Guido van Rossum75acc9c1998-03-03 22:26:50 +00002498static PyObject *
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002499import_module_level(char *name, PyObject *globals, PyObject *locals,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002500 PyObject *fromlist, int level)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002501{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002502 char buf[MAXPATHLEN+1];
2503 Py_ssize_t buflen = 0;
2504 PyObject *parent, *head, *next, *tail;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002505
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002506 if (strchr(name, '/') != NULL
Christian Heimes454f37b2008-01-10 00:10:02 +00002507#ifdef MS_WINDOWS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002508 || strchr(name, '\\') != NULL
Christian Heimes454f37b2008-01-10 00:10:02 +00002509#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002510 ) {
2511 PyErr_SetString(PyExc_ImportError,
2512 "Import by filename is not supported.");
2513 return NULL;
2514 }
Christian Heimes454f37b2008-01-10 00:10:02 +00002515
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002516 parent = get_parent(globals, buf, &buflen, level);
2517 if (parent == NULL)
2518 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002519
Benjamin Peterson556d8002010-06-27 22:37:28 +00002520 head = load_next(parent, level < 0 ? Py_None : parent, &name, buf,
2521 &buflen);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002522 if (head == NULL)
2523 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002524
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002525 tail = head;
2526 Py_INCREF(tail);
2527 while (name) {
2528 next = load_next(tail, tail, &name, buf, &buflen);
2529 Py_DECREF(tail);
2530 if (next == NULL) {
2531 Py_DECREF(head);
2532 return NULL;
2533 }
2534 tail = next;
2535 }
2536 if (tail == Py_None) {
2537 /* If tail is Py_None, both get_parent and load_next found
2538 an empty module name: someone called __import__("") or
2539 doctored faulty bytecode */
2540 Py_DECREF(tail);
2541 Py_DECREF(head);
2542 PyErr_SetString(PyExc_ValueError,
2543 "Empty module name");
2544 return NULL;
2545 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002546
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002547 if (fromlist != NULL) {
2548 if (fromlist == Py_None || !PyObject_IsTrue(fromlist))
2549 fromlist = NULL;
2550 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002551
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002552 if (fromlist == NULL) {
2553 Py_DECREF(tail);
2554 return head;
2555 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002556
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002557 Py_DECREF(head);
2558 if (!ensure_fromlist(tail, fromlist, buf, buflen, 0)) {
2559 Py_DECREF(tail);
2560 return NULL;
2561 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002562
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002563 return tail;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002564}
2565
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002566PyObject *
2567PyImport_ImportModuleLevel(char *name, PyObject *globals, PyObject *locals,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002568 PyObject *fromlist, int level)
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002569{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002570 PyObject *result;
2571 _PyImport_AcquireLock();
2572 result = import_module_level(name, globals, locals, fromlist, level);
2573 if (_PyImport_ReleaseLock() < 0) {
2574 Py_XDECREF(result);
2575 PyErr_SetString(PyExc_RuntimeError,
2576 "not holding the import lock");
2577 return NULL;
2578 }
2579 return result;
Guido van Rossum75acc9c1998-03-03 22:26:50 +00002580}
2581
Fred Drake87590902004-05-28 20:21:36 +00002582/* Return the package that an import is being performed in. If globals comes
2583 from the module foo.bar.bat (not itself a package), this returns the
2584 sys.modules entry for foo.bar. If globals is from a package's __init__.py,
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00002585 the package's entry in sys.modules is returned, as a borrowed reference.
Fred Drake87590902004-05-28 20:21:36 +00002586
2587 The *name* of the returned package is returned in buf, with the length of
2588 the name in *p_buflen.
2589
2590 If globals doesn't come from a package or a module in a package, or a
2591 corresponding entry is not found in sys.modules, Py_None is returned.
2592*/
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002593static PyObject *
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002594get_parent(PyObject *globals, char *buf, Py_ssize_t *p_buflen, int level)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002595{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002596 static PyObject *namestr = NULL;
2597 static PyObject *pathstr = NULL;
2598 static PyObject *pkgstr = NULL;
2599 PyObject *pkgname, *modname, *modpath, *modules, *parent;
2600 int orig_level = level;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002601
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002602 if (globals == NULL || !PyDict_Check(globals) || !level)
2603 return Py_None;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002604
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002605 if (namestr == NULL) {
2606 namestr = PyUnicode_InternFromString("__name__");
2607 if (namestr == NULL)
2608 return NULL;
2609 }
2610 if (pathstr == NULL) {
2611 pathstr = PyUnicode_InternFromString("__path__");
2612 if (pathstr == NULL)
2613 return NULL;
2614 }
2615 if (pkgstr == NULL) {
2616 pkgstr = PyUnicode_InternFromString("__package__");
2617 if (pkgstr == NULL)
2618 return NULL;
2619 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002620
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002621 *buf = '\0';
2622 *p_buflen = 0;
2623 pkgname = PyDict_GetItem(globals, pkgstr);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002624
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002625 if ((pkgname != NULL) && (pkgname != Py_None)) {
2626 /* __package__ is set, so use it */
2627 char *pkgname_str;
2628 Py_ssize_t len;
Alexandre Vassalottia85998a2008-05-03 18:24:43 +00002629
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002630 if (!PyUnicode_Check(pkgname)) {
2631 PyErr_SetString(PyExc_ValueError,
2632 "__package__ set to non-string");
2633 return NULL;
2634 }
2635 pkgname_str = _PyUnicode_AsStringAndSize(pkgname, &len);
2636 if (len == 0) {
2637 if (level > 0) {
2638 PyErr_SetString(PyExc_ValueError,
2639 "Attempted relative import in non-package");
2640 return NULL;
2641 }
2642 return Py_None;
2643 }
2644 if (len > MAXPATHLEN) {
2645 PyErr_SetString(PyExc_ValueError,
2646 "Package name too long");
2647 return NULL;
2648 }
2649 strcpy(buf, pkgname_str);
2650 } else {
2651 /* __package__ not set, so figure it out and set it */
2652 modname = PyDict_GetItem(globals, namestr);
2653 if (modname == NULL || !PyUnicode_Check(modname))
2654 return Py_None;
Brett Cannon9a5b25a2010-03-01 02:09:17 +00002655
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002656 modpath = PyDict_GetItem(globals, pathstr);
2657 if (modpath != NULL) {
2658 /* __path__ is set, so modname is already the package name */
2659 char *modname_str;
2660 Py_ssize_t len;
2661 int error;
Alexandre Vassalottia85998a2008-05-03 18:24:43 +00002662
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002663 modname_str = _PyUnicode_AsStringAndSize(modname, &len);
2664 if (len > MAXPATHLEN) {
2665 PyErr_SetString(PyExc_ValueError,
2666 "Module name too long");
2667 return NULL;
2668 }
2669 strcpy(buf, modname_str);
2670 error = PyDict_SetItem(globals, pkgstr, modname);
2671 if (error) {
2672 PyErr_SetString(PyExc_ValueError,
2673 "Could not set __package__");
2674 return NULL;
2675 }
2676 } else {
2677 /* Normal module, so work out the package name if any */
2678 char *start = _PyUnicode_AsString(modname);
2679 char *lastdot = strrchr(start, '.');
2680 size_t len;
2681 int error;
2682 if (lastdot == NULL && level > 0) {
2683 PyErr_SetString(PyExc_ValueError,
2684 "Attempted relative import in non-package");
2685 return NULL;
2686 }
2687 if (lastdot == NULL) {
2688 error = PyDict_SetItem(globals, pkgstr, Py_None);
2689 if (error) {
2690 PyErr_SetString(PyExc_ValueError,
2691 "Could not set __package__");
2692 return NULL;
2693 }
2694 return Py_None;
2695 }
2696 len = lastdot - start;
2697 if (len >= MAXPATHLEN) {
2698 PyErr_SetString(PyExc_ValueError,
2699 "Module name too long");
2700 return NULL;
2701 }
2702 strncpy(buf, start, len);
2703 buf[len] = '\0';
2704 pkgname = PyUnicode_FromString(buf);
2705 if (pkgname == NULL) {
2706 return NULL;
2707 }
2708 error = PyDict_SetItem(globals, pkgstr, pkgname);
2709 Py_DECREF(pkgname);
2710 if (error) {
2711 PyErr_SetString(PyExc_ValueError,
2712 "Could not set __package__");
2713 return NULL;
2714 }
2715 }
2716 }
2717 while (--level > 0) {
2718 char *dot = strrchr(buf, '.');
2719 if (dot == NULL) {
2720 PyErr_SetString(PyExc_ValueError,
2721 "Attempted relative import beyond "
2722 "toplevel package");
2723 return NULL;
2724 }
2725 *dot = '\0';
2726 }
2727 *p_buflen = strlen(buf);
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002728
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002729 modules = PyImport_GetModuleDict();
2730 parent = PyDict_GetItemString(modules, buf);
2731 if (parent == NULL) {
2732 if (orig_level < 1) {
2733 PyObject *err_msg = PyBytes_FromFormat(
2734 "Parent module '%.200s' not found "
2735 "while handling absolute import", buf);
2736 if (err_msg == NULL) {
2737 return NULL;
2738 }
2739 if (!PyErr_WarnEx(PyExc_RuntimeWarning,
2740 PyBytes_AsString(err_msg), 1)) {
2741 *buf = '\0';
2742 *p_buflen = 0;
2743 parent = Py_None;
2744 }
2745 Py_DECREF(err_msg);
2746 } else {
2747 PyErr_Format(PyExc_SystemError,
2748 "Parent module '%.200s' not loaded, "
2749 "cannot perform relative import", buf);
2750 }
2751 }
2752 return parent;
2753 /* We expect, but can't guarantee, if parent != None, that:
2754 - parent.__name__ == buf
2755 - parent.__dict__ is globals
2756 If this is violated... Who cares? */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002757}
2758
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002759/* altmod is either None or same as mod */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002760static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002761load_next(PyObject *mod, PyObject *altmod, char **p_name, char *buf,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002762 Py_ssize_t *p_buflen)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002763{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002764 char *name = *p_name;
2765 char *dot = strchr(name, '.');
2766 size_t len;
2767 char *p;
2768 PyObject *result;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002769
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002770 if (strlen(name) == 0) {
2771 /* completely empty module name should only happen in
2772 'from . import' (or '__import__("")')*/
2773 Py_INCREF(mod);
2774 *p_name = NULL;
2775 return mod;
2776 }
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002777
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002778 if (dot == NULL) {
2779 *p_name = NULL;
2780 len = strlen(name);
2781 }
2782 else {
2783 *p_name = dot+1;
2784 len = dot-name;
2785 }
2786 if (len == 0) {
2787 PyErr_SetString(PyExc_ValueError,
2788 "Empty module name");
2789 return NULL;
2790 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002791
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002792 p = buf + *p_buflen;
2793 if (p != buf)
2794 *p++ = '.';
2795 if (p+len-buf >= MAXPATHLEN) {
2796 PyErr_SetString(PyExc_ValueError,
2797 "Module name too long");
2798 return NULL;
2799 }
2800 strncpy(p, name, len);
2801 p[len] = '\0';
2802 *p_buflen = p+len-buf;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002803
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002804 result = import_submodule(mod, p, buf);
2805 if (result == Py_None && altmod != mod) {
2806 Py_DECREF(result);
2807 /* Here, altmod must be None and mod must not be None */
2808 result = import_submodule(altmod, p, p);
2809 if (result != NULL && result != Py_None) {
2810 if (mark_miss(buf) != 0) {
2811 Py_DECREF(result);
2812 return NULL;
2813 }
2814 strncpy(buf, name, len);
2815 buf[len] = '\0';
2816 *p_buflen = len;
2817 }
2818 }
2819 if (result == NULL)
2820 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002821
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002822 if (result == Py_None) {
2823 Py_DECREF(result);
2824 PyErr_Format(PyExc_ImportError,
2825 "No module named %.200s", name);
2826 return NULL;
2827 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002828
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002829 return result;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002830}
2831
2832static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002833mark_miss(char *name)
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00002834{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002835 PyObject *modules = PyImport_GetModuleDict();
2836 return PyDict_SetItemString(modules, name, Py_None);
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00002837}
2838
2839static int
Martin v. Löwis18e16552006-02-15 17:27:45 +00002840ensure_fromlist(PyObject *mod, PyObject *fromlist, char *buf, Py_ssize_t buflen,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002841 int recursive)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002842{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002843 int i;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002844
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002845 if (!PyObject_HasAttrString(mod, "__path__"))
2846 return 1;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002847
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002848 for (i = 0; ; i++) {
2849 PyObject *item = PySequence_GetItem(fromlist, i);
2850 int hasit;
2851 if (item == NULL) {
2852 if (PyErr_ExceptionMatches(PyExc_IndexError)) {
2853 PyErr_Clear();
2854 return 1;
2855 }
2856 return 0;
2857 }
2858 if (!PyUnicode_Check(item)) {
2859 PyErr_SetString(PyExc_TypeError,
2860 "Item in ``from list'' not a string");
2861 Py_DECREF(item);
2862 return 0;
2863 }
2864 if (PyUnicode_AS_UNICODE(item)[0] == '*') {
2865 PyObject *all;
2866 Py_DECREF(item);
2867 /* See if the package defines __all__ */
2868 if (recursive)
2869 continue; /* Avoid endless recursion */
2870 all = PyObject_GetAttrString(mod, "__all__");
2871 if (all == NULL)
2872 PyErr_Clear();
2873 else {
2874 int ret = ensure_fromlist(mod, all, buf, buflen, 1);
2875 Py_DECREF(all);
2876 if (!ret)
2877 return 0;
2878 }
2879 continue;
2880 }
2881 hasit = PyObject_HasAttr(mod, item);
2882 if (!hasit) {
2883 PyObject *item8;
2884 char *subname;
2885 PyObject *submod;
2886 char *p;
Victor Stinnerae6265f2010-05-15 16:27:27 +00002887 item8 = PyUnicode_EncodeFSDefault(item);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002888 if (!item8) {
2889 PyErr_SetString(PyExc_ValueError, "Cannot encode path item");
2890 return 0;
2891 }
2892 subname = PyBytes_AS_STRING(item8);
2893 if (buflen + strlen(subname) >= MAXPATHLEN) {
2894 PyErr_SetString(PyExc_ValueError,
2895 "Module name too long");
2896 Py_DECREF(item);
2897 return 0;
2898 }
2899 p = buf + buflen;
2900 *p++ = '.';
2901 strcpy(p, subname);
2902 submod = import_submodule(mod, subname, buf);
2903 Py_DECREF(item8);
2904 Py_XDECREF(submod);
2905 if (submod == NULL) {
2906 Py_DECREF(item);
2907 return 0;
2908 }
2909 }
2910 Py_DECREF(item);
2911 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002912
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002913 /* NOTREACHED */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002914}
2915
Neil Schemenauer00b09662003-06-16 21:03:07 +00002916static int
2917add_submodule(PyObject *mod, PyObject *submod, char *fullname, char *subname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002918 PyObject *modules)
Neil Schemenauer00b09662003-06-16 21:03:07 +00002919{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002920 if (mod == Py_None)
2921 return 1;
2922 /* Irrespective of the success of this load, make a
2923 reference to it in the parent package module. A copy gets
2924 saved in the modules dictionary under the full name, so get a
2925 reference from there, if need be. (The exception is when the
2926 load failed with a SyntaxError -- then there's no trace in
2927 sys.modules. In that case, of course, do nothing extra.) */
2928 if (submod == NULL) {
2929 submod = PyDict_GetItemString(modules, fullname);
2930 if (submod == NULL)
2931 return 1;
2932 }
2933 if (PyModule_Check(mod)) {
2934 /* We can't use setattr here since it can give a
2935 * spurious warning if the submodule name shadows a
2936 * builtin name */
2937 PyObject *dict = PyModule_GetDict(mod);
2938 if (!dict)
2939 return 0;
2940 if (PyDict_SetItemString(dict, subname, submod) < 0)
2941 return 0;
2942 }
2943 else {
2944 if (PyObject_SetAttrString(mod, subname, submod) < 0)
2945 return 0;
2946 }
2947 return 1;
Neil Schemenauer00b09662003-06-16 21:03:07 +00002948}
2949
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002950static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002951import_submodule(PyObject *mod, char *subname, char *fullname)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002952{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002953 PyObject *modules = PyImport_GetModuleDict();
2954 PyObject *m = NULL;
Guido van Rossum74e6a111994-08-29 12:54:38 +00002955
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002956 /* Require:
2957 if mod == None: subname == fullname
2958 else: mod.__name__ + "." + subname == fullname
2959 */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002960
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002961 if ((m = PyDict_GetItemString(modules, fullname)) != NULL) {
2962 Py_INCREF(m);
2963 }
2964 else {
2965 PyObject *path, *loader = NULL;
2966 char buf[MAXPATHLEN+1];
2967 struct filedescr *fdp;
2968 FILE *fp = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002969
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002970 if (mod == Py_None)
2971 path = NULL;
2972 else {
2973 path = PyObject_GetAttrString(mod, "__path__");
2974 if (path == NULL) {
2975 PyErr_Clear();
2976 Py_INCREF(Py_None);
2977 return Py_None;
2978 }
2979 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002980
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002981 buf[0] = '\0';
2982 fdp = find_module(fullname, subname, path, buf, MAXPATHLEN+1,
2983 &fp, &loader);
2984 Py_XDECREF(path);
2985 if (fdp == NULL) {
2986 if (!PyErr_ExceptionMatches(PyExc_ImportError))
2987 return NULL;
2988 PyErr_Clear();
2989 Py_INCREF(Py_None);
2990 return Py_None;
2991 }
2992 m = load_module(fullname, fp, buf, fdp->type, loader);
2993 Py_XDECREF(loader);
2994 if (fp)
2995 fclose(fp);
2996 if (!add_submodule(mod, m, fullname, subname, modules)) {
2997 Py_XDECREF(m);
2998 m = NULL;
2999 }
3000 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003001
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003002 return m;
Guido van Rossum74e6a111994-08-29 12:54:38 +00003003}
3004
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003005
3006/* Re-import a module of any kind and return its module object, WITH
3007 INCREMENTED REFERENCE COUNT */
3008
Guido van Rossum79f25d91997-04-29 20:08:16 +00003009PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003010PyImport_ReloadModule(PyObject *m)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003011{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003012 PyInterpreterState *interp = PyThreadState_Get()->interp;
3013 PyObject *modules_reloading = interp->modules_reloading;
3014 PyObject *modules = PyImport_GetModuleDict();
3015 PyObject *path = NULL, *loader = NULL, *existing_m = NULL;
3016 char *name, *subname;
3017 char buf[MAXPATHLEN+1];
3018 struct filedescr *fdp;
3019 FILE *fp = NULL;
3020 PyObject *newm;
Brett Cannon9a5b25a2010-03-01 02:09:17 +00003021
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003022 if (modules_reloading == NULL) {
3023 Py_FatalError("PyImport_ReloadModule: "
3024 "no modules_reloading dictionary!");
3025 return NULL;
3026 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003027
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003028 if (m == NULL || !PyModule_Check(m)) {
3029 PyErr_SetString(PyExc_TypeError,
3030 "reload() argument must be module");
3031 return NULL;
3032 }
3033 name = (char*)PyModule_GetName(m);
3034 if (name == NULL)
3035 return NULL;
3036 if (m != PyDict_GetItemString(modules, name)) {
3037 PyErr_Format(PyExc_ImportError,
3038 "reload(): module %.200s not in sys.modules",
3039 name);
3040 return NULL;
3041 }
3042 existing_m = PyDict_GetItemString(modules_reloading, name);
3043 if (existing_m != NULL) {
3044 /* Due to a recursive reload, this module is already
3045 being reloaded. */
3046 Py_INCREF(existing_m);
3047 return existing_m;
3048 }
3049 if (PyDict_SetItemString(modules_reloading, name, m) < 0)
3050 return NULL;
Guido van Rossumd8faa362007-04-27 19:54:29 +00003051
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003052 subname = strrchr(name, '.');
3053 if (subname == NULL)
3054 subname = name;
3055 else {
3056 PyObject *parentname, *parent;
3057 parentname = PyUnicode_FromStringAndSize(name, (subname-name));
3058 if (parentname == NULL) {
3059 imp_modules_reloading_clear();
3060 return NULL;
3061 }
3062 parent = PyDict_GetItem(modules, parentname);
3063 if (parent == NULL) {
3064 PyErr_Format(PyExc_ImportError,
3065 "reload(): parent %U not in sys.modules",
3066 parentname);
3067 Py_DECREF(parentname);
3068 imp_modules_reloading_clear();
3069 return NULL;
3070 }
3071 Py_DECREF(parentname);
3072 subname++;
3073 path = PyObject_GetAttrString(parent, "__path__");
3074 if (path == NULL)
3075 PyErr_Clear();
3076 }
3077 buf[0] = '\0';
3078 fdp = find_module(name, subname, path, buf, MAXPATHLEN+1, &fp, &loader);
3079 Py_XDECREF(path);
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00003080
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003081 if (fdp == NULL) {
3082 Py_XDECREF(loader);
3083 imp_modules_reloading_clear();
3084 return NULL;
3085 }
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00003086
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003087 newm = load_module(name, fp, buf, fdp->type, loader);
3088 Py_XDECREF(loader);
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00003089
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003090 if (fp)
3091 fclose(fp);
3092 if (newm == NULL) {
3093 /* load_module probably removed name from modules because of
3094 * the error. Put back the original module object. We're
3095 * going to return NULL in this case regardless of whether
3096 * replacing name succeeds, so the return value is ignored.
3097 */
3098 PyDict_SetItemString(modules, name, m);
3099 }
3100 imp_modules_reloading_clear();
3101 return newm;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003102}
3103
3104
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003105/* Higher-level import emulator which emulates the "import" statement
3106 more accurately -- it invokes the __import__() function from the
3107 builtins of the current globals. This means that the import is
3108 done using whatever import hooks are installed in the current
Brett Cannonbc2eff32010-09-19 21:39:02 +00003109 environment.
Guido van Rossum6058eb41998-12-21 19:51:00 +00003110 A dummy list ["__doc__"] is passed as the 4th argument so that
Neal Norwitz80e7f272007-08-26 06:45:23 +00003111 e.g. PyImport_Import(PyUnicode_FromString("win32com.client.gencache"))
Guido van Rossum6058eb41998-12-21 19:51:00 +00003112 will return <module "gencache"> instead of <module "win32com">. */
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003113
3114PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003115PyImport_Import(PyObject *module_name)
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003116{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003117 static PyObject *silly_list = NULL;
3118 static PyObject *builtins_str = NULL;
3119 static PyObject *import_str = NULL;
3120 PyObject *globals = NULL;
3121 PyObject *import = NULL;
3122 PyObject *builtins = NULL;
Brett Cannonbc2eff32010-09-19 21:39:02 +00003123 PyObject *modules = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003124 PyObject *r = NULL;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003125
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003126 /* Initialize constant string objects */
3127 if (silly_list == NULL) {
3128 import_str = PyUnicode_InternFromString("__import__");
3129 if (import_str == NULL)
3130 return NULL;
3131 builtins_str = PyUnicode_InternFromString("__builtins__");
3132 if (builtins_str == NULL)
3133 return NULL;
Brett Cannonbc2eff32010-09-19 21:39:02 +00003134 silly_list = PyList_New(0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003135 if (silly_list == NULL)
3136 return NULL;
3137 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003138
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003139 /* Get the builtins from current globals */
3140 globals = PyEval_GetGlobals();
3141 if (globals != NULL) {
3142 Py_INCREF(globals);
3143 builtins = PyObject_GetItem(globals, builtins_str);
3144 if (builtins == NULL)
3145 goto err;
3146 }
3147 else {
3148 /* No globals -- use standard builtins, and fake globals */
3149 builtins = PyImport_ImportModuleLevel("builtins",
3150 NULL, NULL, NULL, 0);
3151 if (builtins == NULL)
3152 return NULL;
3153 globals = Py_BuildValue("{OO}", builtins_str, builtins);
3154 if (globals == NULL)
3155 goto err;
3156 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003157
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003158 /* Get the __import__ function from the builtins */
3159 if (PyDict_Check(builtins)) {
3160 import = PyObject_GetItem(builtins, import_str);
3161 if (import == NULL)
3162 PyErr_SetObject(PyExc_KeyError, import_str);
3163 }
3164 else
3165 import = PyObject_GetAttr(builtins, import_str);
3166 if (import == NULL)
3167 goto err;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003168
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003169 /* Call the __import__ function with the proper argument list
Brett Cannonbc2eff32010-09-19 21:39:02 +00003170 Always use absolute import here.
3171 Calling for side-effect of import. */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003172 r = PyObject_CallFunction(import, "OOOOi", module_name, globals,
3173 globals, silly_list, 0, NULL);
Brett Cannonbc2eff32010-09-19 21:39:02 +00003174 if (r == NULL)
3175 goto err;
3176 Py_DECREF(r);
3177
3178 modules = PyImport_GetModuleDict();
3179 r = PyDict_GetItem(modules, module_name);
3180 if (r != NULL)
3181 Py_INCREF(r);
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003182
3183 err:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003184 Py_XDECREF(globals);
3185 Py_XDECREF(builtins);
3186 Py_XDECREF(import);
Tim Peters50d8d372001-02-28 05:34:27 +00003187
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003188 return r;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003189}
3190
3191
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003192/* Module 'imp' provides Python access to the primitives used for
3193 importing modules.
3194*/
3195
Guido van Rossum79f25d91997-04-29 20:08:16 +00003196static PyObject *
Barry Warsaw28a691b2010-04-17 00:19:56 +00003197imp_make_magic(long magic)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003198{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003199 char buf[4];
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003200
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003201 buf[0] = (char) ((magic >> 0) & 0xff);
3202 buf[1] = (char) ((magic >> 8) & 0xff);
3203 buf[2] = (char) ((magic >> 16) & 0xff);
3204 buf[3] = (char) ((magic >> 24) & 0xff);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003205
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003206 return PyBytes_FromStringAndSize(buf, 4);
Victor Stinner3e2b7172010-11-09 09:32:19 +00003207}
Barry Warsaw28a691b2010-04-17 00:19:56 +00003208
3209static PyObject *
3210imp_get_magic(PyObject *self, PyObject *noargs)
3211{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003212 return imp_make_magic(pyc_magic);
Barry Warsaw28a691b2010-04-17 00:19:56 +00003213}
3214
3215static PyObject *
3216imp_get_tag(PyObject *self, PyObject *noargs)
3217{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003218 return PyUnicode_FromString(pyc_tag);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003219}
3220
Guido van Rossum79f25d91997-04-29 20:08:16 +00003221static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +00003222imp_get_suffixes(PyObject *self, PyObject *noargs)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003223{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003224 PyObject *list;
3225 struct filedescr *fdp;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003226
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003227 list = PyList_New(0);
3228 if (list == NULL)
3229 return NULL;
3230 for (fdp = _PyImport_Filetab; fdp->suffix != NULL; fdp++) {
3231 PyObject *item = Py_BuildValue("ssi",
3232 fdp->suffix, fdp->mode, fdp->type);
3233 if (item == NULL) {
3234 Py_DECREF(list);
3235 return NULL;
3236 }
3237 if (PyList_Append(list, item) < 0) {
3238 Py_DECREF(list);
3239 Py_DECREF(item);
3240 return NULL;
3241 }
3242 Py_DECREF(item);
3243 }
3244 return list;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003245}
3246
Guido van Rossum79f25d91997-04-29 20:08:16 +00003247static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003248call_find_module(char *name, PyObject *path)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003249{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003250 extern int fclose(FILE *);
3251 PyObject *fob, *ret;
3252 PyObject *pathobj;
3253 struct filedescr *fdp;
3254 char pathname[MAXPATHLEN+1];
3255 FILE *fp = NULL;
3256 int fd = -1;
3257 char *found_encoding = NULL;
3258 char *encoding = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003259
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003260 pathname[0] = '\0';
3261 if (path == Py_None)
3262 path = NULL;
3263 fdp = find_module(NULL, name, path, pathname, MAXPATHLEN+1, &fp, NULL);
3264 if (fdp == NULL)
3265 return NULL;
3266 if (fp != NULL) {
3267 fd = fileno(fp);
3268 if (fd != -1)
3269 fd = dup(fd);
3270 fclose(fp);
3271 fp = NULL;
3272 }
3273 if (fd != -1) {
3274 if (strchr(fdp->mode, 'b') == NULL) {
3275 /* PyTokenizer_FindEncoding() returns PyMem_MALLOC'ed
3276 memory. */
3277 found_encoding = PyTokenizer_FindEncoding(fd);
3278 lseek(fd, 0, 0); /* Reset position */
3279 if (found_encoding == NULL && PyErr_Occurred())
3280 return NULL;
3281 encoding = (found_encoding != NULL) ? found_encoding :
3282 (char*)PyUnicode_GetDefaultEncoding();
3283 }
3284 fob = PyFile_FromFd(fd, pathname, fdp->mode, -1,
3285 (char*)encoding, NULL, NULL, 1);
3286 if (fob == NULL) {
3287 close(fd);
3288 PyMem_FREE(found_encoding);
3289 return NULL;
3290 }
3291 }
3292 else {
3293 fob = Py_None;
3294 Py_INCREF(fob);
3295 }
3296 pathobj = PyUnicode_DecodeFSDefault(pathname);
3297 ret = Py_BuildValue("NN(ssi)",
3298 fob, pathobj, fdp->suffix, fdp->mode, fdp->type);
3299 PyMem_FREE(found_encoding);
Brett Cannon3bb42d92007-10-20 03:43:15 +00003300
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003301 return ret;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003302}
3303
Guido van Rossum79f25d91997-04-29 20:08:16 +00003304static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003305imp_find_module(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003306{
Victor Stinnerebc00522010-12-03 17:06:43 +00003307 PyObject *name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003308 PyObject *ret, *path = NULL;
Victor Stinnerebc00522010-12-03 17:06:43 +00003309 if (!PyArg_ParseTuple(args, "O&|O:find_module",
3310 PyUnicode_FSConverter, &name,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003311 &path))
3312 return NULL;
Victor Stinnerebc00522010-12-03 17:06:43 +00003313 ret = call_find_module(PyBytes_AS_STRING(name), path);
3314 Py_DECREF(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003315 return ret;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003316}
3317
3318static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003319imp_init_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003320{
Victor Stinner95872862011-03-07 18:20:56 +01003321 PyObject *name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003322 int ret;
3323 PyObject *m;
Victor Stinner95872862011-03-07 18:20:56 +01003324 if (!PyArg_ParseTuple(args, "U:init_builtin", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003325 return NULL;
3326 ret = init_builtin(name);
3327 if (ret < 0)
3328 return NULL;
3329 if (ret == 0) {
3330 Py_INCREF(Py_None);
3331 return Py_None;
3332 }
Victor Stinner95872862011-03-07 18:20:56 +01003333 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003334 Py_XINCREF(m);
3335 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003336}
3337
Guido van Rossum79f25d91997-04-29 20:08:16 +00003338static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003339imp_init_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003340{
Victor Stinner53dc7352011-03-20 01:50:21 +01003341 PyObject *name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003342 int ret;
3343 PyObject *m;
Victor Stinner53dc7352011-03-20 01:50:21 +01003344 if (!PyArg_ParseTuple(args, "U:init_frozen", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003345 return NULL;
Victor Stinner53dc7352011-03-20 01:50:21 +01003346 ret = PyImport_ImportFrozenModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003347 if (ret < 0)
3348 return NULL;
3349 if (ret == 0) {
3350 Py_INCREF(Py_None);
3351 return Py_None;
3352 }
Victor Stinner53dc7352011-03-20 01:50:21 +01003353 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003354 Py_XINCREF(m);
3355 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003356}
3357
Guido van Rossum79f25d91997-04-29 20:08:16 +00003358static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003359imp_get_frozen_object(PyObject *self, PyObject *args)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00003360{
Victor Stinner53dc7352011-03-20 01:50:21 +01003361 PyObject *name;
Jack Jansen95ffa231995-10-03 14:38:41 +00003362
Victor Stinner53dc7352011-03-20 01:50:21 +01003363 if (!PyArg_ParseTuple(args, "U:get_frozen_object", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003364 return NULL;
3365 return get_frozen_object(name);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00003366}
3367
Guido van Rossum79f25d91997-04-29 20:08:16 +00003368static PyObject *
Brett Cannon8d110132009-03-15 02:20:16 +00003369imp_is_frozen_package(PyObject *self, PyObject *args)
3370{
Victor Stinner53dc7352011-03-20 01:50:21 +01003371 PyObject *name;
Brett Cannon8d110132009-03-15 02:20:16 +00003372
Victor Stinner53dc7352011-03-20 01:50:21 +01003373 if (!PyArg_ParseTuple(args, "U:is_frozen_package", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003374 return NULL;
3375 return is_frozen_package(name);
Brett Cannon8d110132009-03-15 02:20:16 +00003376}
3377
3378static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003379imp_is_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003380{
Victor Stinner95872862011-03-07 18:20:56 +01003381 PyObject *name;
3382 if (!PyArg_ParseTuple(args, "U:is_builtin", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003383 return NULL;
3384 return PyLong_FromLong(is_builtin(name));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003385}
3386
Guido van Rossum79f25d91997-04-29 20:08:16 +00003387static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003388imp_is_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003389{
Victor Stinner53dc7352011-03-20 01:50:21 +01003390 PyObject *name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003391 struct _frozen *p;
Victor Stinner53dc7352011-03-20 01:50:21 +01003392 if (!PyArg_ParseTuple(args, "U:is_frozen", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003393 return NULL;
3394 p = find_frozen(name);
3395 return PyBool_FromLong((long) (p == NULL ? 0 : p->size));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003396}
3397
3398static FILE *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003399get_file(char *pathname, PyObject *fob, char *mode)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003400{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003401 FILE *fp;
3402 if (mode[0] == 'U')
3403 mode = "r" PY_STDIOTEXTMODE;
3404 if (fob == NULL) {
3405 fp = fopen(pathname, mode);
3406 }
3407 else {
3408 int fd = PyObject_AsFileDescriptor(fob);
3409 if (fd == -1)
3410 return NULL;
3411 if (!_PyVerify_fd(fd))
3412 goto error;
3413 /* the FILE struct gets a new fd, so that it can be closed
3414 * independently of the file descriptor given
3415 */
3416 fd = dup(fd);
3417 if (fd == -1)
3418 goto error;
3419 fp = fdopen(fd, mode);
3420 }
3421 if (fp)
3422 return fp;
Kristján Valur Jónssone1b04452009-03-31 17:43:39 +00003423error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003424 PyErr_SetFromErrno(PyExc_IOError);
3425 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003426}
3427
Guido van Rossum79f25d91997-04-29 20:08:16 +00003428static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003429imp_load_compiled(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003430{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003431 char *name;
Victor Stinnerebc00522010-12-03 17:06:43 +00003432 PyObject *pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003433 PyObject *fob = NULL;
3434 PyObject *m;
3435 FILE *fp;
Victor Stinnerebc00522010-12-03 17:06:43 +00003436 if (!PyArg_ParseTuple(args, "sO&|O:load_compiled",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003437 &name,
Victor Stinnerebc00522010-12-03 17:06:43 +00003438 PyUnicode_FSConverter, &pathname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003439 &fob))
3440 return NULL;
Victor Stinnerebc00522010-12-03 17:06:43 +00003441 fp = get_file(PyBytes_AS_STRING(pathname), fob, "rb");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003442 if (fp == NULL) {
Victor Stinnerebc00522010-12-03 17:06:43 +00003443 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003444 return NULL;
3445 }
Victor Stinnerebc00522010-12-03 17:06:43 +00003446 m = load_compiled_module(name, PyBytes_AS_STRING(pathname), fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003447 fclose(fp);
Victor Stinnerebc00522010-12-03 17:06:43 +00003448 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003449 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003450}
3451
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003452#ifdef HAVE_DYNAMIC_LOADING
3453
Guido van Rossum79f25d91997-04-29 20:08:16 +00003454static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003455imp_load_dynamic(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003456{
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003457 PyObject *name, *pathname, *fob = NULL, *mod;
3458 FILE *fp;
3459
3460 if (!PyArg_ParseTuple(args, "UO&|O:load_dynamic",
3461 &name, PyUnicode_FSDecoder, &pathname, &fob))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003462 return NULL;
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003463 if (fob != NULL) {
3464 fp = get_file(NULL, fob, "r");
3465 if (fp == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003466 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003467 }
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003468 else
3469 fp = NULL;
3470 mod = _PyImport_LoadDynamicModule(name, pathname, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003471 if (fp)
3472 fclose(fp);
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003473 return mod;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003474}
3475
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003476#endif /* HAVE_DYNAMIC_LOADING */
3477
Guido van Rossum79f25d91997-04-29 20:08:16 +00003478static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003479imp_load_source(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003480{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003481 char *name;
Victor Stinnerebc00522010-12-03 17:06:43 +00003482 PyObject *pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003483 PyObject *fob = NULL;
3484 PyObject *m;
3485 FILE *fp;
Victor Stinnerebc00522010-12-03 17:06:43 +00003486 if (!PyArg_ParseTuple(args, "sO&|O:load_source",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003487 &name,
Victor Stinnerebc00522010-12-03 17:06:43 +00003488 PyUnicode_FSConverter, &pathname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003489 &fob))
3490 return NULL;
Victor Stinnerebc00522010-12-03 17:06:43 +00003491 fp = get_file(PyBytes_AS_STRING(pathname), fob, "r");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003492 if (fp == NULL) {
Victor Stinnerebc00522010-12-03 17:06:43 +00003493 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003494 return NULL;
3495 }
Victor Stinnerebc00522010-12-03 17:06:43 +00003496 m = load_source_module(name, PyBytes_AS_STRING(pathname), fp);
3497 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003498 fclose(fp);
3499 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003500}
3501
Guido van Rossum79f25d91997-04-29 20:08:16 +00003502static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003503imp_load_module(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003504{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003505 char *name;
3506 PyObject *fob;
Victor Stinner1a563032010-10-15 22:43:10 +00003507 PyObject *pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003508 PyObject * ret;
3509 char *suffix; /* Unused */
3510 char *mode;
3511 int type;
3512 FILE *fp;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003513
Victor Stinner1a563032010-10-15 22:43:10 +00003514 if (!PyArg_ParseTuple(args, "sOO&(ssi):load_module",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003515 &name, &fob,
Victor Stinner1a563032010-10-15 22:43:10 +00003516 PyUnicode_FSConverter, &pathname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003517 &suffix, &mode, &type))
3518 return NULL;
3519 if (*mode) {
3520 /* Mode must start with 'r' or 'U' and must not contain '+'.
3521 Implicit in this test is the assumption that the mode
3522 may contain other modifiers like 'b' or 't'. */
Guido van Rossum5e2c5fa2002-05-30 17:33:07 +00003523
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003524 if (!(*mode == 'r' || *mode == 'U') || strchr(mode, '+')) {
3525 PyErr_Format(PyExc_ValueError,
3526 "invalid file open mode %.200s", mode);
Victor Stinner1a563032010-10-15 22:43:10 +00003527 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003528 return NULL;
3529 }
3530 }
3531 if (fob == Py_None)
3532 fp = NULL;
3533 else {
3534 fp = get_file(NULL, fob, mode);
3535 if (fp == NULL) {
Victor Stinner1a563032010-10-15 22:43:10 +00003536 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003537 return NULL;
3538 }
3539 }
Victor Stinner1a563032010-10-15 22:43:10 +00003540 ret = load_module(name, fp, PyBytes_AS_STRING(pathname), type, NULL);
3541 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003542 if (fp)
3543 fclose(fp);
3544 return ret;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003545}
3546
3547static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003548imp_load_package(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003549{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003550 char *name;
Victor Stinnerebc00522010-12-03 17:06:43 +00003551 PyObject *pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003552 PyObject * ret;
Victor Stinnerebc00522010-12-03 17:06:43 +00003553 if (!PyArg_ParseTuple(args, "sO&:load_package",
3554 &name, PyUnicode_FSConverter, &pathname))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003555 return NULL;
Victor Stinnerebc00522010-12-03 17:06:43 +00003556 ret = load_package(name, PyBytes_AS_STRING(pathname));
3557 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003558 return ret;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003559}
3560
3561static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003562imp_new_module(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003563{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003564 char *name;
3565 if (!PyArg_ParseTuple(args, "s:new_module", &name))
3566 return NULL;
3567 return PyModule_New(name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003568}
3569
Christian Heimes13a7a212008-01-07 17:13:09 +00003570static PyObject *
3571imp_reload(PyObject *self, PyObject *v)
3572{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003573 return PyImport_ReloadModule(v);
Christian Heimes13a7a212008-01-07 17:13:09 +00003574}
3575
3576PyDoc_STRVAR(doc_reload,
3577"reload(module) -> module\n\
3578\n\
3579Reload the module. The module must have been successfully imported before.");
3580
Barry Warsaw28a691b2010-04-17 00:19:56 +00003581static PyObject *
3582imp_cache_from_source(PyObject *self, PyObject *args, PyObject *kws)
3583{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003584 static char *kwlist[] = {"path", "debug_override", NULL};
Barry Warsaw28a691b2010-04-17 00:19:56 +00003585
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003586 char buf[MAXPATHLEN+1];
Victor Stinner3ea23dd2010-10-15 20:34:32 +00003587 PyObject *pathbytes;
3588 char *cpathname;
Benjamin Peterson294a9fc2010-10-16 03:12:39 +00003589 PyObject *debug_override = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003590 int debug = !Py_OptimizeFlag;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003591
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003592 if (!PyArg_ParseTupleAndKeywords(
Victor Stinner3ea23dd2010-10-15 20:34:32 +00003593 args, kws, "O&|O", kwlist,
3594 PyUnicode_FSConverter, &pathbytes, &debug_override))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003595 return NULL;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003596
Benjamin Peterson294a9fc2010-10-16 03:12:39 +00003597 if (debug_override != NULL &&
3598 (debug = PyObject_IsTrue(debug_override)) < 0) {
3599 Py_DECREF(pathbytes);
3600 return NULL;
3601 }
Barry Warsaw28a691b2010-04-17 00:19:56 +00003602
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");
3610 return NULL;
3611 }
Victor Stinner88bd8912010-10-15 22:46:07 +00003612 return PyUnicode_DecodeFSDefault(buf);
Barry Warsaw28a691b2010-04-17 00:19:56 +00003613}
3614
3615PyDoc_STRVAR(doc_cache_from_source,
3616"Given the path to a .py file, return the path to its .pyc/.pyo file.\n\
3617\n\
3618The .py file does not need to exist; this simply returns the path to the\n\
3619.pyc/.pyo file calculated as if the .py file were imported. The extension\n\
3620will be .pyc unless __debug__ is not defined, then it will be .pyo.\n\
3621\n\
3622If debug_override is not None, then it must be a boolean and is taken as\n\
3623the value of __debug__ instead.");
3624
3625static PyObject *
3626imp_source_from_cache(PyObject *self, PyObject *args, PyObject *kws)
3627{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003628 static char *kwlist[] = {"path", NULL};
Barry Warsaw28a691b2010-04-17 00:19:56 +00003629
Victor Stinnerebc00522010-12-03 17:06:43 +00003630 PyObject *pathname_obj;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003631 char *pathname;
3632 char buf[MAXPATHLEN+1];
Barry Warsaw28a691b2010-04-17 00:19:56 +00003633
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003634 if (!PyArg_ParseTupleAndKeywords(
Victor Stinnerebc00522010-12-03 17:06:43 +00003635 args, kws, "O&", kwlist,
3636 PyUnicode_FSConverter, &pathname_obj))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003637 return NULL;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003638
Victor Stinnerebc00522010-12-03 17:06:43 +00003639 pathname = PyBytes_AS_STRING(pathname_obj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003640 if (make_source_pathname(pathname, buf) == NULL) {
3641 PyErr_Format(PyExc_ValueError, "Not a PEP 3147 pyc path: %s",
3642 pathname);
Victor Stinnerebc00522010-12-03 17:06:43 +00003643 Py_DECREF(pathname_obj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003644 return NULL;
3645 }
Victor Stinnerebc00522010-12-03 17:06:43 +00003646 Py_DECREF(pathname_obj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003647 return PyUnicode_FromString(buf);
Barry Warsaw28a691b2010-04-17 00:19:56 +00003648}
3649
3650PyDoc_STRVAR(doc_source_from_cache,
3651"Given the path to a .pyc./.pyo file, return the path to its .py file.\n\
3652\n\
3653The .pyc/.pyo file does not need to exist; this simply returns the path to\n\
3654the .py file calculated to correspond to the .pyc/.pyo file. If path\n\
3655does not conform to PEP 3147 format, ValueError will be raised.");
3656
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003657/* Doc strings */
3658
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003659PyDoc_STRVAR(doc_imp,
3660"This module provides the components needed to build your own\n\
3661__import__ function. Undocumented functions are obsolete.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003662
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003663PyDoc_STRVAR(doc_find_module,
3664"find_module(name, [path]) -> (file, filename, (suffix, mode, type))\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003665Search for a module. If path is omitted or None, search for a\n\
3666built-in, frozen or special module and continue search in sys.path.\n\
3667The module name cannot contain '.'; to search for a submodule of a\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003668package, pass the submodule name and the package's __path__.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003669
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003670PyDoc_STRVAR(doc_load_module,
3671"load_module(name, file, filename, (suffix, mode, type)) -> module\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003672Load a module, given information returned by find_module().\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003673The module name must include the full package name, if any.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003674
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003675PyDoc_STRVAR(doc_get_magic,
3676"get_magic() -> string\n\
3677Return the magic number for .pyc or .pyo files.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003678
Barry Warsaw28a691b2010-04-17 00:19:56 +00003679PyDoc_STRVAR(doc_get_tag,
3680"get_tag() -> string\n\
3681Return the magic tag for .pyc or .pyo files.");
3682
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003683PyDoc_STRVAR(doc_get_suffixes,
3684"get_suffixes() -> [(suffix, mode, type), ...]\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003685Return a list of (suffix, mode, type) tuples describing the files\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003686that find_module() looks for.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003687
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003688PyDoc_STRVAR(doc_new_module,
3689"new_module(name) -> module\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003690Create a new module. Do not enter it in sys.modules.\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003691The module name must include the full package name, if any.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003692
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003693PyDoc_STRVAR(doc_lock_held,
Tim Petersa7c65092004-08-01 23:26:05 +00003694"lock_held() -> boolean\n\
3695Return True if the import lock is currently held, else False.\n\
3696On platforms without threads, return False.");
Tim Peters69232342001-08-30 05:16:13 +00003697
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00003698PyDoc_STRVAR(doc_acquire_lock,
3699"acquire_lock() -> None\n\
Neal Norwitz2294c0d2003-02-12 23:02:21 +00003700Acquires the interpreter's import lock for the current thread.\n\
3701This lock should be used by import hooks to ensure thread-safety\n\
3702when importing modules.\n\
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00003703On platforms without threads, this function does nothing.");
3704
3705PyDoc_STRVAR(doc_release_lock,
3706"release_lock() -> None\n\
3707Release the interpreter's import lock.\n\
3708On platforms without threads, this function does nothing.");
3709
Guido van Rossum79f25d91997-04-29 20:08:16 +00003710static PyMethodDef imp_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003711 {"find_module", imp_find_module, METH_VARARGS, doc_find_module},
3712 {"get_magic", imp_get_magic, METH_NOARGS, doc_get_magic},
3713 {"get_tag", imp_get_tag, METH_NOARGS, doc_get_tag},
3714 {"get_suffixes", imp_get_suffixes, METH_NOARGS, doc_get_suffixes},
3715 {"load_module", imp_load_module, METH_VARARGS, doc_load_module},
3716 {"new_module", imp_new_module, METH_VARARGS, doc_new_module},
3717 {"lock_held", imp_lock_held, METH_NOARGS, doc_lock_held},
3718 {"acquire_lock", imp_acquire_lock, METH_NOARGS, doc_acquire_lock},
3719 {"release_lock", imp_release_lock, METH_NOARGS, doc_release_lock},
3720 {"reload", imp_reload, METH_O, doc_reload},
3721 {"cache_from_source", (PyCFunction)imp_cache_from_source,
3722 METH_VARARGS | METH_KEYWORDS, doc_cache_from_source},
3723 {"source_from_cache", (PyCFunction)imp_source_from_cache,
3724 METH_VARARGS | METH_KEYWORDS, doc_source_from_cache},
3725 /* The rest are obsolete */
3726 {"get_frozen_object", imp_get_frozen_object, METH_VARARGS},
3727 {"is_frozen_package", imp_is_frozen_package, METH_VARARGS},
3728 {"init_builtin", imp_init_builtin, METH_VARARGS},
3729 {"init_frozen", imp_init_frozen, METH_VARARGS},
3730 {"is_builtin", imp_is_builtin, METH_VARARGS},
3731 {"is_frozen", imp_is_frozen, METH_VARARGS},
3732 {"load_compiled", imp_load_compiled, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003733#ifdef HAVE_DYNAMIC_LOADING
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003734 {"load_dynamic", imp_load_dynamic, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003735#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003736 {"load_package", imp_load_package, METH_VARARGS},
3737 {"load_source", imp_load_source, METH_VARARGS},
3738 {NULL, NULL} /* sentinel */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003739};
3740
Guido van Rossum1a8791e1998-08-04 22:46:29 +00003741static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003742setint(PyObject *d, char *name, int value)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003743{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003744 PyObject *v;
3745 int err;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003746
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003747 v = PyLong_FromLong((long)value);
3748 err = PyDict_SetItemString(d, name, v);
3749 Py_XDECREF(v);
3750 return err;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003751}
3752
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003753typedef struct {
3754 PyObject_HEAD
3755} NullImporter;
3756
3757static int
3758NullImporter_init(NullImporter *self, PyObject *args, PyObject *kwds)
3759{
Victor Stinner1a4d12d2010-08-13 13:07:29 +00003760#ifndef MS_WINDOWS
3761 PyObject *path;
3762 struct stat statbuf;
3763 int rv;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003764
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003765 if (!_PyArg_NoKeywords("NullImporter()", kwds))
3766 return -1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003767
Victor Stinner1a4d12d2010-08-13 13:07:29 +00003768 if (!PyArg_ParseTuple(args, "O&:NullImporter",
3769 PyUnicode_FSConverter, &path))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003770 return -1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003771
Victor Stinner1a4d12d2010-08-13 13:07:29 +00003772 if (PyBytes_GET_SIZE(path) == 0) {
3773 Py_DECREF(path);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003774 PyErr_SetString(PyExc_ImportError, "empty pathname");
3775 return -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003776 }
Victor Stinner1a4d12d2010-08-13 13:07:29 +00003777
3778 rv = stat(PyBytes_AS_STRING(path), &statbuf);
3779 Py_DECREF(path);
3780 if (rv == 0) {
3781 /* it exists */
3782 if (S_ISDIR(statbuf.st_mode)) {
3783 /* it's a directory */
3784 PyErr_SetString(PyExc_ImportError, "existing directory");
3785 return -1;
3786 }
3787 }
3788#else /* MS_WINDOWS */
3789 PyObject *pathobj;
3790 DWORD rv;
Victor Stinner255dfdb2010-09-29 10:28:51 +00003791 wchar_t *path;
Victor Stinner1a4d12d2010-08-13 13:07:29 +00003792
3793 if (!_PyArg_NoKeywords("NullImporter()", kwds))
3794 return -1;
3795
3796 if (!PyArg_ParseTuple(args, "U:NullImporter",
3797 &pathobj))
3798 return -1;
3799
3800 if (PyUnicode_GET_SIZE(pathobj) == 0) {
3801 PyErr_SetString(PyExc_ImportError, "empty pathname");
3802 return -1;
3803 }
3804
Victor Stinnerbeb4135b2010-10-07 01:02:42 +00003805 path = PyUnicode_AsWideCharString(pathobj, NULL);
Victor Stinner255dfdb2010-09-29 10:28:51 +00003806 if (path == NULL)
Victor Stinner1a4d12d2010-08-13 13:07:29 +00003807 return -1;
3808 /* see issue1293 and issue3677:
3809 * stat() on Windows doesn't recognise paths like
3810 * "e:\\shared\\" and "\\\\whiterab-c2znlh\\shared" as dirs.
3811 */
3812 rv = GetFileAttributesW(path);
Victor Stinner255dfdb2010-09-29 10:28:51 +00003813 PyMem_Free(path);
Victor Stinner1a4d12d2010-08-13 13:07:29 +00003814 if (rv != INVALID_FILE_ATTRIBUTES) {
3815 /* it exists */
3816 if (rv & FILE_ATTRIBUTE_DIRECTORY) {
3817 /* it's a directory */
3818 PyErr_SetString(PyExc_ImportError, "existing directory");
3819 return -1;
3820 }
3821 }
3822#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003823 return 0;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003824}
3825
3826static PyObject *
3827NullImporter_find_module(NullImporter *self, PyObject *args)
3828{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003829 Py_RETURN_NONE;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003830}
3831
3832static PyMethodDef NullImporter_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003833 {"find_module", (PyCFunction)NullImporter_find_module, METH_VARARGS,
3834 "Always return None"
3835 },
3836 {NULL} /* Sentinel */
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003837};
3838
3839
Christian Heimes9cd17752007-11-18 19:35:23 +00003840PyTypeObject PyNullImporter_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003841 PyVarObject_HEAD_INIT(NULL, 0)
3842 "imp.NullImporter", /*tp_name*/
3843 sizeof(NullImporter), /*tp_basicsize*/
3844 0, /*tp_itemsize*/
3845 0, /*tp_dealloc*/
3846 0, /*tp_print*/
3847 0, /*tp_getattr*/
3848 0, /*tp_setattr*/
3849 0, /*tp_reserved*/
3850 0, /*tp_repr*/
3851 0, /*tp_as_number*/
3852 0, /*tp_as_sequence*/
3853 0, /*tp_as_mapping*/
3854 0, /*tp_hash */
3855 0, /*tp_call*/
3856 0, /*tp_str*/
3857 0, /*tp_getattro*/
3858 0, /*tp_setattro*/
3859 0, /*tp_as_buffer*/
3860 Py_TPFLAGS_DEFAULT, /*tp_flags*/
3861 "Null importer object", /* tp_doc */
3862 0, /* tp_traverse */
3863 0, /* tp_clear */
3864 0, /* tp_richcompare */
3865 0, /* tp_weaklistoffset */
3866 0, /* tp_iter */
3867 0, /* tp_iternext */
3868 NullImporter_methods, /* tp_methods */
3869 0, /* tp_members */
3870 0, /* tp_getset */
3871 0, /* tp_base */
3872 0, /* tp_dict */
3873 0, /* tp_descr_get */
3874 0, /* tp_descr_set */
3875 0, /* tp_dictoffset */
3876 (initproc)NullImporter_init, /* tp_init */
3877 0, /* tp_alloc */
3878 PyType_GenericNew /* tp_new */
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003879};
3880
Martin v. Löwis1a214512008-06-11 05:26:20 +00003881static struct PyModuleDef impmodule = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003882 PyModuleDef_HEAD_INIT,
3883 "imp",
3884 doc_imp,
3885 0,
3886 imp_methods,
3887 NULL,
3888 NULL,
3889 NULL,
3890 NULL
Martin v. Löwis1a214512008-06-11 05:26:20 +00003891};
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003892
Jason Tishler6bc06ec2003-09-04 11:59:50 +00003893PyMODINIT_FUNC
Martin v. Löwis1a214512008-06-11 05:26:20 +00003894PyInit_imp(void)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003895{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003896 PyObject *m, *d;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003897
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003898 if (PyType_Ready(&PyNullImporter_Type) < 0)
3899 return NULL;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003900
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003901 m = PyModule_Create(&impmodule);
3902 if (m == NULL)
3903 goto failure;
3904 d = PyModule_GetDict(m);
3905 if (d == NULL)
3906 goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003907
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003908 if (setint(d, "SEARCH_ERROR", SEARCH_ERROR) < 0) goto failure;
3909 if (setint(d, "PY_SOURCE", PY_SOURCE) < 0) goto failure;
3910 if (setint(d, "PY_COMPILED", PY_COMPILED) < 0) goto failure;
3911 if (setint(d, "C_EXTENSION", C_EXTENSION) < 0) goto failure;
3912 if (setint(d, "PY_RESOURCE", PY_RESOURCE) < 0) goto failure;
3913 if (setint(d, "PKG_DIRECTORY", PKG_DIRECTORY) < 0) goto failure;
3914 if (setint(d, "C_BUILTIN", C_BUILTIN) < 0) goto failure;
3915 if (setint(d, "PY_FROZEN", PY_FROZEN) < 0) goto failure;
3916 if (setint(d, "PY_CODERESOURCE", PY_CODERESOURCE) < 0) goto failure;
3917 if (setint(d, "IMP_HOOK", IMP_HOOK) < 0) goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003918
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003919 Py_INCREF(&PyNullImporter_Type);
3920 PyModule_AddObject(m, "NullImporter", (PyObject *)&PyNullImporter_Type);
3921 return m;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003922 failure:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003923 Py_XDECREF(m);
3924 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003925}
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003926
3927
Guido van Rossumb18618d2000-05-03 23:44:39 +00003928/* API for embedding applications that want to add their own entries
3929 to the table of built-in modules. This should normally be called
3930 *before* Py_Initialize(). When the table resize fails, -1 is
3931 returned and the existing table is unchanged.
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003932
3933 After a similar function by Just van Rossum. */
3934
3935int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003936PyImport_ExtendInittab(struct _inittab *newtab)
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003937{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003938 static struct _inittab *our_copy = NULL;
3939 struct _inittab *p;
3940 int i, n;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003941
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003942 /* Count the number of entries in both tables */
3943 for (n = 0; newtab[n].name != NULL; n++)
3944 ;
3945 if (n == 0)
3946 return 0; /* Nothing to do */
3947 for (i = 0; PyImport_Inittab[i].name != NULL; i++)
3948 ;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003949
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003950 /* Allocate new memory for the combined table */
3951 p = our_copy;
3952 PyMem_RESIZE(p, struct _inittab, i+n+1);
3953 if (p == NULL)
3954 return -1;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003955
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003956 /* Copy the tables into the new memory */
3957 if (our_copy != PyImport_Inittab)
3958 memcpy(p, PyImport_Inittab, (i+1) * sizeof(struct _inittab));
3959 PyImport_Inittab = our_copy = p;
3960 memcpy(p+i, newtab, (n+1) * sizeof(struct _inittab));
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003961
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003962 return 0;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003963}
3964
3965/* Shorthand to add a single entry given a name and a function */
3966
3967int
Brett Cannona826f322009-04-02 03:41:46 +00003968PyImport_AppendInittab(const char *name, PyObject* (*initfunc)(void))
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003969{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003970 struct _inittab newtab[2];
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003971
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003972 memset(newtab, '\0', sizeof newtab);
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003973
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003974 newtab[0].name = (char *)name;
3975 newtab[0].initfunc = initfunc;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003976
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003977 return PyImport_ExtendInittab(newtab);
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003978}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00003979
3980#ifdef __cplusplus
3981}
3982#endif