blob: 565f1336cbe4a4e575d4d94b5cdfaa382071cfa2 [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 *);
Victor Stinnerc6963162011-03-12 09:26:54 -05001431static struct filedescr *find_module(char *, const 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];
Victor Stinner7d8b77c2011-03-12 08:45:02 -05001446 FILE *fp;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001447 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;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001467 fdp = find_module(name, "__init__", path, buf, sizeof(buf), &fp, NULL);
1468 if (fdp == NULL) {
1469 if (PyErr_ExceptionMatches(PyExc_ImportError)) {
1470 PyErr_Clear();
1471 Py_INCREF(m);
1472 }
1473 else
1474 m = NULL;
1475 goto cleanup;
1476 }
1477 m = load_module(name, fp, buf, fdp->type, NULL);
1478 if (fp != NULL)
1479 fclose(fp);
1480 goto cleanup;
Tim Peters1cd70172004-08-02 03:52:12 +00001481
1482 error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001483 m = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001484 cleanup:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001485 Py_XDECREF(path);
1486 Py_XDECREF(file);
1487 return m;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001488}
1489
1490
1491/* Helper to test for built-in module */
1492
1493static int
Victor Stinner95872862011-03-07 18:20:56 +01001494is_builtin(PyObject *name)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001495{
Victor Stinner95872862011-03-07 18:20:56 +01001496 int i, cmp;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001497 for (i = 0; PyImport_Inittab[i].name != NULL; i++) {
Victor Stinner95872862011-03-07 18:20:56 +01001498 cmp = PyUnicode_CompareWithASCIIString(name, PyImport_Inittab[i].name);
1499 if (cmp == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001500 if (PyImport_Inittab[i].initfunc == NULL)
1501 return -1;
1502 else
1503 return 1;
1504 }
1505 }
1506 return 0;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001507}
1508
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001509
Just van Rossum52e14d62002-12-30 22:08:05 +00001510/* Return an importer object for a sys.path/pkg.__path__ item 'p',
1511 possibly by fetching it from the path_importer_cache dict. If it
Thomas Wouters89f507f2006-12-13 04:49:30 +00001512 wasn't yet cached, traverse path_hooks until a hook is found
Just van Rossum52e14d62002-12-30 22:08:05 +00001513 that can handle the path item. Return None if no hook could;
1514 this tells our caller it should fall back to the builtin
1515 import mechanism. Cache the result in path_importer_cache.
1516 Returns a borrowed reference. */
1517
1518static PyObject *
1519get_path_importer(PyObject *path_importer_cache, PyObject *path_hooks,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001520 PyObject *p)
Just van Rossum52e14d62002-12-30 22:08:05 +00001521{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001522 PyObject *importer;
1523 Py_ssize_t j, nhooks;
Just van Rossum52e14d62002-12-30 22:08:05 +00001524
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001525 /* These conditions are the caller's responsibility: */
1526 assert(PyList_Check(path_hooks));
1527 assert(PyDict_Check(path_importer_cache));
Just van Rossum52e14d62002-12-30 22:08:05 +00001528
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001529 nhooks = PyList_Size(path_hooks);
1530 if (nhooks < 0)
1531 return NULL; /* Shouldn't happen */
Just van Rossum52e14d62002-12-30 22:08:05 +00001532
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001533 importer = PyDict_GetItem(path_importer_cache, p);
1534 if (importer != NULL)
1535 return importer;
Just van Rossum52e14d62002-12-30 22:08:05 +00001536
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001537 /* set path_importer_cache[p] to None to avoid recursion */
1538 if (PyDict_SetItem(path_importer_cache, p, Py_None) != 0)
1539 return NULL;
Just van Rossum52e14d62002-12-30 22:08:05 +00001540
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001541 for (j = 0; j < nhooks; j++) {
1542 PyObject *hook = PyList_GetItem(path_hooks, j);
1543 if (hook == NULL)
1544 return NULL;
1545 importer = PyObject_CallFunctionObjArgs(hook, p, NULL);
1546 if (importer != NULL)
1547 break;
Just van Rossum52e14d62002-12-30 22:08:05 +00001548
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001549 if (!PyErr_ExceptionMatches(PyExc_ImportError)) {
1550 return NULL;
1551 }
1552 PyErr_Clear();
1553 }
1554 if (importer == NULL) {
1555 importer = PyObject_CallFunctionObjArgs(
1556 (PyObject *)&PyNullImporter_Type, p, NULL
1557 );
1558 if (importer == NULL) {
1559 if (PyErr_ExceptionMatches(PyExc_ImportError)) {
1560 PyErr_Clear();
1561 return Py_None;
1562 }
1563 }
1564 }
1565 if (importer != NULL) {
1566 int err = PyDict_SetItem(path_importer_cache, p, importer);
1567 Py_DECREF(importer);
1568 if (err != 0)
1569 return NULL;
1570 }
1571 return importer;
Just van Rossum52e14d62002-12-30 22:08:05 +00001572}
1573
Christian Heimes9cd17752007-11-18 19:35:23 +00001574PyAPI_FUNC(PyObject *)
1575PyImport_GetImporter(PyObject *path) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001576 PyObject *importer=NULL, *path_importer_cache=NULL, *path_hooks=NULL;
Christian Heimes9cd17752007-11-18 19:35:23 +00001577
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001578 if ((path_importer_cache = PySys_GetObject("path_importer_cache"))) {
1579 if ((path_hooks = PySys_GetObject("path_hooks"))) {
1580 importer = get_path_importer(path_importer_cache,
1581 path_hooks, path);
1582 }
1583 }
1584 Py_XINCREF(importer); /* get_path_importer returns a borrowed reference */
1585 return importer;
Christian Heimes9cd17752007-11-18 19:35:23 +00001586}
1587
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001588/* Search the path (default sys.path) for a module. Return the
1589 corresponding filedescr struct, and (via return arguments) the
1590 pathname and an open file. Return NULL if the module is not found. */
1591
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001592#ifdef MS_COREDLL
Victor Stinner4d6c1c42011-03-08 23:49:04 +01001593extern FILE *_PyWin_FindRegisteredModule(PyObject *, struct filedescr **,
1594 PyObject **p_path);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001595#endif
1596
Victor Stinnerc6963162011-03-12 09:26:54 -05001597static int case_ok(char *, Py_ssize_t, Py_ssize_t, const char *);
Tim Petersdbd9ba62000-07-09 03:09:57 +00001598static int find_init_module(char *); /* Forward */
Just van Rossum52e14d62002-12-30 22:08:05 +00001599static struct filedescr importhookdescr = {"", "", IMP_HOOK};
Guido van Rossum197346f1997-10-31 18:38:52 +00001600
Victor Stinner37580282011-03-20 01:34:43 +01001601static struct filedescr*
1602find_module_path_list(char *fullname, const char *name,
1603 PyObject *search_path_list, PyObject *path_hooks,
1604 PyObject *path_importer_cache,
1605 char *buf, size_t buflen,
1606 FILE **p_fp, PyObject **p_loader)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001607{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001608 Py_ssize_t i, npath;
1609 size_t len, namelen;
1610 struct filedescr *fdp = NULL;
1611 char *filemode;
1612 FILE *fp = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001613 struct stat statbuf;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001614 static struct filedescr fd_package = {"", "", PKG_DIRECTORY};
Andrew MacIntyred9400542002-02-26 11:41:34 +00001615#if defined(PYOS_OS2)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001616 size_t saved_len;
1617 size_t saved_namelen;
1618 char *saved_buf = NULL;
Andrew MacIntyred9400542002-02-26 11:41:34 +00001619#endif
Victor Stinner53dc7352011-03-20 01:50:21 +01001620
Victor Stinner37580282011-03-20 01:34:43 +01001621 npath = PyList_Size(search_path_list);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001622 namelen = strlen(name);
1623 for (i = 0; i < npath; i++) {
Victor Stinner37580282011-03-20 01:34:43 +01001624 PyObject *v = PyList_GetItem(search_path_list, i);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001625 PyObject *origv = v;
1626 const char *base;
1627 Py_ssize_t size;
1628 if (!v)
1629 return NULL;
1630 if (PyUnicode_Check(v)) {
Victor Stinnerae6265f2010-05-15 16:27:27 +00001631 v = PyUnicode_EncodeFSDefault(v);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001632 if (v == NULL)
1633 return NULL;
1634 }
1635 else if (!PyBytes_Check(v))
1636 continue;
1637 else
1638 Py_INCREF(v);
Amaury Forgeot d'Arcf1ca0b12008-06-11 17:40:47 +00001639
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001640 base = PyBytes_AS_STRING(v);
1641 size = PyBytes_GET_SIZE(v);
1642 len = size;
1643 if (len + 2 + namelen + MAXSUFFIXSIZE >= buflen) {
1644 Py_DECREF(v);
1645 continue; /* Too long */
1646 }
1647 strcpy(buf, base);
1648 Py_DECREF(v);
Amaury Forgeot d'Arcf1ca0b12008-06-11 17:40:47 +00001649
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001650 if (strlen(buf) != len) {
1651 continue; /* v contains '\0' */
1652 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001653
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001654 /* sys.path_hooks import hook */
1655 if (p_loader != NULL) {
1656 PyObject *importer;
Just van Rossum52e14d62002-12-30 22:08:05 +00001657
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001658 importer = get_path_importer(path_importer_cache,
1659 path_hooks, origv);
1660 if (importer == NULL) {
1661 return NULL;
1662 }
1663 /* Note: importer is a borrowed reference */
1664 if (importer != Py_None) {
1665 PyObject *loader;
1666 loader = PyObject_CallMethod(importer,
1667 "find_module",
1668 "s", fullname);
1669 if (loader == NULL)
1670 return NULL; /* error */
1671 if (loader != Py_None) {
1672 /* a loader was found */
1673 *p_loader = loader;
1674 return &importhookdescr;
1675 }
1676 Py_DECREF(loader);
1677 continue;
1678 }
1679 }
1680 /* no hook was found, use builtin import */
Just van Rossum52e14d62002-12-30 22:08:05 +00001681
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001682 if (len > 0 && buf[len-1] != SEP
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001683#ifdef ALTSEP
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001684 && buf[len-1] != ALTSEP
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001685#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001686 )
1687 buf[len++] = SEP;
1688 strcpy(buf+len, name);
1689 len += namelen;
Tim Peters50d8d372001-02-28 05:34:27 +00001690
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001691 /* Check for package import (buf holds a directory name,
1692 and there's an __init__ module in that directory */
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001693#ifdef HAVE_STAT
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001694 if (stat(buf, &statbuf) == 0 && /* it exists */
1695 S_ISDIR(statbuf.st_mode) && /* it's a directory */
1696 case_ok(buf, len, namelen, name)) { /* case matches */
1697 if (find_init_module(buf)) { /* and has __init__.py */
1698 return &fd_package;
1699 }
1700 else {
Victor Stinnered7916d2010-10-17 02:07:09 +00001701 int err;
1702 PyObject *unicode = PyUnicode_DecodeFSDefault(buf);
1703 if (unicode == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001704 return NULL;
Victor Stinnered7916d2010-10-17 02:07:09 +00001705 err = PyErr_WarnFormat(PyExc_ImportWarning, 1,
1706 "Not importing directory '%U': missing __init__.py",
1707 unicode);
1708 Py_DECREF(unicode);
1709 if (err)
1710 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001711 }
1712 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001713#endif
Andrew MacIntyred9400542002-02-26 11:41:34 +00001714#if defined(PYOS_OS2)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001715 /* take a snapshot of the module spec for restoration
1716 * after the 8 character DLL hackery
1717 */
1718 saved_buf = strdup(buf);
1719 saved_len = len;
1720 saved_namelen = namelen;
Andrew MacIntyred9400542002-02-26 11:41:34 +00001721#endif /* PYOS_OS2 */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001722 for (fdp = _PyImport_Filetab; fdp->suffix != NULL; fdp++) {
Guido van Rossum04110fb2007-08-24 16:32:05 +00001723#if defined(PYOS_OS2) && defined(HAVE_DYNAMIC_LOADING)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001724 /* OS/2 limits DLLs to 8 character names (w/o
1725 extension)
1726 * so if the name is longer than that and its a
1727 * dynamically loaded module we're going to try,
1728 * truncate the name before trying
1729 */
Victor Stinnerc6963162011-03-12 09:26:54 -05001730 if (strlen(name) > 8) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001731 /* is this an attempt to load a C extension? */
1732 const struct filedescr *scan;
1733 scan = _PyImport_DynLoadFiletab;
1734 while (scan->suffix != NULL) {
1735 if (!strcmp(scan->suffix, fdp->suffix))
1736 break;
1737 else
1738 scan++;
1739 }
1740 if (scan->suffix != NULL) {
1741 /* yes, so truncate the name */
1742 namelen = 8;
Victor Stinnerc6963162011-03-12 09:26:54 -05001743 len -= strlen(name) - namelen;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001744 buf[len] = '\0';
1745 }
1746 }
Andrew MacIntyred9400542002-02-26 11:41:34 +00001747#endif /* PYOS_OS2 */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001748 strcpy(buf+len, fdp->suffix);
1749 if (Py_VerboseFlag > 1)
1750 PySys_WriteStderr("# trying %s\n", buf);
1751 filemode = fdp->mode;
1752 if (filemode[0] == 'U')
1753 filemode = "r" PY_STDIOTEXTMODE;
1754 fp = fopen(buf, filemode);
1755 if (fp != NULL) {
1756 if (case_ok(buf, len, namelen, name))
1757 break;
1758 else { /* continue search */
1759 fclose(fp);
1760 fp = NULL;
1761 }
1762 }
Andrew MacIntyred9400542002-02-26 11:41:34 +00001763#if defined(PYOS_OS2)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001764 /* restore the saved snapshot */
1765 strcpy(buf, saved_buf);
1766 len = saved_len;
1767 namelen = saved_namelen;
Andrew MacIntyred9400542002-02-26 11:41:34 +00001768#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001769 }
Andrew MacIntyred9400542002-02-26 11:41:34 +00001770#if defined(PYOS_OS2)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001771 /* don't need/want the module name snapshot anymore */
1772 if (saved_buf)
1773 {
1774 free(saved_buf);
1775 saved_buf = NULL;
1776 }
Andrew MacIntyred9400542002-02-26 11:41:34 +00001777#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001778 if (fp != NULL)
1779 break;
1780 }
1781 if (fp == NULL) {
1782 PyErr_Format(PyExc_ImportError,
1783 "No module named %.200s", name);
1784 return NULL;
1785 }
1786 *p_fp = fp;
1787 return fdp;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001788}
1789
Victor Stinner37580282011-03-20 01:34:43 +01001790/* Find a module:
1791
1792 - try find_module() of each sys.meta_path hook
1793 - try find_frozen()
1794 - try is_builtin()
1795 - try _PyWin_FindRegisteredModule() (Windows only)
1796 - otherwise, call find_module_path_list() with search_path_list (if not
1797 NULL) or sys.path
1798
1799 Return:
1800
1801 - &fd_builtin (C_BUILTIN) if it is a builtin
1802 - &fd_frozen (PY_FROZEN) if it is frozen
1803 - &fd_package (PKG_DIRECTORY) and write the filename into *buf
1804 if it is a package
1805 - &importhookdescr (IMP_HOOK) and write the loader into *p_loader if a
1806 importer loader was found
1807 - a file descriptor (PY_SOURCE, PY_COMPILED, C_EXTENSION, PY_RESOURCE or
1808 PY_CODERESOURCE: see _PyImport_Filetab), write the filename into
1809 *buf and the pointer to the open file into *p_fp
1810 - NULL on error
1811
1812 By default, write an empty string into *buf, and *p_fp and *p_loader (if
1813 set) are set to NULL. Eg. *buf is an empty string for a builtin package. */
1814
1815static struct filedescr *
1816find_module(char *fullname, const char *name, PyObject *search_path_list,
1817 char *buf, size_t buflen, FILE **p_fp, PyObject **p_loader)
1818{
1819 Py_ssize_t i, npath;
1820 static struct filedescr fd_frozen = {"", "", PY_FROZEN};
1821 static struct filedescr fd_builtin = {"", "", C_BUILTIN};
1822 PyObject *path_hooks, *path_importer_cache;
1823 PyObject *fullname_obj, *nameobj;
1824
1825 *buf = '\0';
1826 *p_fp = NULL;
1827 if (p_loader != NULL)
1828 *p_loader = NULL;
1829
1830 if (strlen(name) > MAXPATHLEN) {
1831 PyErr_SetString(PyExc_OverflowError,
1832 "module name is too long");
1833 return NULL;
1834 }
1835
1836 /* sys.meta_path import hook */
1837 if (p_loader != NULL) {
1838 PyObject *meta_path;
1839
1840 meta_path = PySys_GetObject("meta_path");
1841 if (meta_path == NULL || !PyList_Check(meta_path)) {
1842 PyErr_SetString(PyExc_ImportError,
1843 "sys.meta_path must be a list of "
1844 "import hooks");
1845 return NULL;
1846 }
1847 Py_INCREF(meta_path); /* zap guard */
1848 npath = PyList_Size(meta_path);
1849 for (i = 0; i < npath; i++) {
1850 PyObject *loader;
1851 PyObject *hook = PyList_GetItem(meta_path, i);
1852 loader = PyObject_CallMethod(hook, "find_module",
1853 "sO", fullname,
1854 search_path_list != NULL ?
1855 search_path_list : Py_None);
1856 if (loader == NULL) {
1857 Py_DECREF(meta_path);
1858 return NULL; /* true error */
1859 }
1860 if (loader != Py_None) {
1861 /* a loader was found */
1862 *p_loader = loader;
1863 Py_DECREF(meta_path);
1864 return &importhookdescr;
1865 }
1866 Py_DECREF(loader);
1867 }
1868 Py_DECREF(meta_path);
1869 }
1870
1871 if (fullname != NULL) {
1872 fullname_obj = PyUnicode_FromString(fullname);
1873 if (fullname == NULL)
1874 return NULL;
1875 if (find_frozen(fullname_obj) != NULL) {
1876 Py_DECREF(fullname_obj);
1877 strcpy(buf, fullname);
1878 return &fd_frozen;
1879 }
1880 Py_DECREF(fullname_obj);
1881 }
1882
1883 if (search_path_list == NULL) {
1884#ifdef MS_COREDLL
1885 FILE *fp;
1886 struct filedescr *fdp;
1887 PyObject *filename, *filename_bytes;
1888#endif
1889 nameobj = PyUnicode_FromString(name);
1890 if (nameobj == NULL)
1891 return NULL;
1892 if (is_builtin(nameobj)) {
1893 Py_DECREF(nameobj);
1894 strcpy(buf, name);
1895 return &fd_builtin;
1896 }
1897#ifdef MS_COREDLL
1898 fp = _PyWin_FindRegisteredModule(nameobj, &fdp, &filename);
1899 if (fp != NULL) {
1900 Py_DECREF(nameobj);
1901 filename_bytes = PyUnicode_EncodeFSDefault(filename);
1902 Py_DECREF(filename);
1903 if (filename_bytes == NULL)
1904 return NULL;
1905 strncpy(buf, PyBytes_AS_STRING(filename_bytes), buflen);
1906 buf[buflen-1] = '\0';
1907 Py_DECREF(filename_bytes);
1908 *p_fp = fp;
1909 return fdp;
1910 }
1911 else if (PyErr_Occurred())
1912 return NULL;
1913#endif
1914 Py_DECREF(nameobj);
1915 search_path_list = PySys_GetObject("path");
1916 }
1917
1918 if (search_path_list == NULL || !PyList_Check(search_path_list)) {
1919 PyErr_SetString(PyExc_ImportError,
1920 "sys.path must be a list of directory names");
1921 return NULL;
1922 }
1923
1924 path_hooks = PySys_GetObject("path_hooks");
1925 if (path_hooks == NULL || !PyList_Check(path_hooks)) {
1926 PyErr_SetString(PyExc_ImportError,
1927 "sys.path_hooks must be a list of "
1928 "import hooks");
1929 return NULL;
1930 }
1931 path_importer_cache = PySys_GetObject("path_importer_cache");
1932 if (path_importer_cache == NULL ||
1933 !PyDict_Check(path_importer_cache)) {
1934 PyErr_SetString(PyExc_ImportError,
1935 "sys.path_importer_cache must be a dict");
1936 return NULL;
1937 }
1938
1939 return find_module_path_list(fullname, name,
1940 search_path_list, path_hooks,
1941 path_importer_cache,
1942 buf, buflen,
1943 p_fp, p_loader);
1944}
1945
Martin v. Löwis18e16552006-02-15 17:27:45 +00001946/* case_ok(char* buf, Py_ssize_t len, Py_ssize_t namelen, char* name)
Tim Petersd1e87a82001-03-01 18:12:00 +00001947 * The arguments here are tricky, best shown by example:
1948 * /a/b/c/d/e/f/g/h/i/j/k/some_long_module_name.py\0
1949 * ^ ^ ^ ^
1950 * |--------------------- buf ---------------------|
1951 * |------------------- len ------------------|
1952 * |------ name -------|
1953 * |----- namelen -----|
1954 * buf is the full path, but len only counts up to (& exclusive of) the
1955 * extension. name is the module name, also exclusive of extension.
1956 *
1957 * We've already done a successful stat() or fopen() on buf, so know that
1958 * there's some match, possibly case-insensitive.
1959 *
Tim Peters50d8d372001-02-28 05:34:27 +00001960 * case_ok() is to return 1 if there's a case-sensitive match for
1961 * name, else 0. case_ok() is also to return 1 if envar PYTHONCASEOK
1962 * exists.
Tim Petersd1e87a82001-03-01 18:12:00 +00001963 *
Tim Peters50d8d372001-02-28 05:34:27 +00001964 * case_ok() is used to implement case-sensitive import semantics even
1965 * on platforms with case-insensitive filesystems. It's trivial to implement
1966 * for case-sensitive filesystems. It's pretty much a cross-platform
1967 * nightmare for systems with case-insensitive filesystems.
1968 */
Guido van Rossum0980bd91998-02-13 17:18:36 +00001969
Tim Peters50d8d372001-02-28 05:34:27 +00001970/* First we may need a pile of platform-specific header files; the sequence
1971 * of #if's here should match the sequence in the body of case_ok().
1972 */
Jason Tishler7961aa62005-05-20 00:56:54 +00001973#if defined(MS_WINDOWS)
Guido van Rossum0980bd91998-02-13 17:18:36 +00001974#include <windows.h>
Guido van Rossum4c3f57c2001-01-10 20:40:46 +00001975
Tim Peters50d8d372001-02-28 05:34:27 +00001976#elif defined(DJGPP)
1977#include <dir.h>
1978
Jason Tishler7961aa62005-05-20 00:56:54 +00001979#elif (defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) && defined(HAVE_DIRENT_H)
Tim Peters430f5d42001-03-01 01:30:56 +00001980#include <sys/types.h>
1981#include <dirent.h>
1982
Andrew MacIntyred9400542002-02-26 11:41:34 +00001983#elif defined(PYOS_OS2)
1984#define INCL_DOS
1985#define INCL_DOSERRORS
1986#define INCL_NOPMAPI
1987#include <os2.h>
Tim Peters50d8d372001-02-28 05:34:27 +00001988#endif
1989
Guido van Rossum0980bd91998-02-13 17:18:36 +00001990static int
Victor Stinnerc6963162011-03-12 09:26:54 -05001991case_ok(char *buf, Py_ssize_t len, Py_ssize_t namelen, const char *name)
Guido van Rossum0980bd91998-02-13 17:18:36 +00001992{
Tim Peters50d8d372001-02-28 05:34:27 +00001993/* Pick a platform-specific implementation; the sequence of #if's here should
1994 * match the sequence just above.
1995 */
1996
Jason Tishler7961aa62005-05-20 00:56:54 +00001997/* MS_WINDOWS */
1998#if defined(MS_WINDOWS)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001999 WIN32_FIND_DATA data;
2000 HANDLE h;
Tim Peters50d8d372001-02-28 05:34:27 +00002001
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002002 if (Py_GETENV("PYTHONCASEOK") != NULL)
2003 return 1;
Tim Peters50d8d372001-02-28 05:34:27 +00002004
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002005 h = FindFirstFile(buf, &data);
2006 if (h == INVALID_HANDLE_VALUE) {
2007 PyErr_Format(PyExc_NameError,
2008 "Can't find file for module %.100s\n(filename %.300s)",
2009 name, buf);
2010 return 0;
2011 }
2012 FindClose(h);
2013 return strncmp(data.cFileName, name, namelen) == 0;
Tim Peters50d8d372001-02-28 05:34:27 +00002014
2015/* DJGPP */
2016#elif defined(DJGPP)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002017 struct ffblk ffblk;
2018 int done;
Tim Peters50d8d372001-02-28 05:34:27 +00002019
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002020 if (Py_GETENV("PYTHONCASEOK") != NULL)
2021 return 1;
Tim Peters50d8d372001-02-28 05:34:27 +00002022
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002023 done = findfirst(buf, &ffblk, FA_ARCH|FA_RDONLY|FA_HIDDEN|FA_DIREC);
2024 if (done) {
2025 PyErr_Format(PyExc_NameError,
2026 "Can't find file for module %.100s\n(filename %.300s)",
2027 name, buf);
2028 return 0;
2029 }
2030 return strncmp(ffblk.ff_name, name, namelen) == 0;
Guido van Rossum0980bd91998-02-13 17:18:36 +00002031
Jason Tishler7961aa62005-05-20 00:56:54 +00002032/* new-fangled macintosh (macosx) or Cygwin */
2033#elif (defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) && defined(HAVE_DIRENT_H)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002034 DIR *dirp;
2035 struct dirent *dp;
2036 char dirname[MAXPATHLEN + 1];
2037 const int dirlen = len - namelen - 1; /* don't want trailing SEP */
Tim Peters430f5d42001-03-01 01:30:56 +00002038
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002039 if (Py_GETENV("PYTHONCASEOK") != NULL)
2040 return 1;
Tim Petersdbe6ebb2001-03-01 08:47:29 +00002041
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002042 /* Copy the dir component into dirname; substitute "." if empty */
2043 if (dirlen <= 0) {
2044 dirname[0] = '.';
2045 dirname[1] = '\0';
2046 }
2047 else {
2048 assert(dirlen <= MAXPATHLEN);
2049 memcpy(dirname, buf, dirlen);
2050 dirname[dirlen] = '\0';
2051 }
2052 /* Open the directory and search the entries for an exact match. */
2053 dirp = opendir(dirname);
2054 if (dirp) {
2055 char *nameWithExt = buf + len - namelen;
2056 while ((dp = readdir(dirp)) != NULL) {
2057 const int thislen =
Tim Peters430f5d42001-03-01 01:30:56 +00002058#ifdef _DIRENT_HAVE_D_NAMELEN
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002059 dp->d_namlen;
Tim Peters430f5d42001-03-01 01:30:56 +00002060#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002061 strlen(dp->d_name);
Tim Peters430f5d42001-03-01 01:30:56 +00002062#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002063 if (thislen >= namelen &&
2064 strcmp(dp->d_name, nameWithExt) == 0) {
2065 (void)closedir(dirp);
2066 return 1; /* Found */
2067 }
2068 }
2069 (void)closedir(dirp);
2070 }
2071 return 0 ; /* Not found */
Tim Peters430f5d42001-03-01 01:30:56 +00002072
Andrew MacIntyred9400542002-02-26 11:41:34 +00002073/* OS/2 */
2074#elif defined(PYOS_OS2)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002075 HDIR hdir = 1;
2076 ULONG srchcnt = 1;
2077 FILEFINDBUF3 ffbuf;
2078 APIRET rc;
Andrew MacIntyred9400542002-02-26 11:41:34 +00002079
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002080 if (Py_GETENV("PYTHONCASEOK") != NULL)
2081 return 1;
Andrew MacIntyred9400542002-02-26 11:41:34 +00002082
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002083 rc = DosFindFirst(buf,
2084 &hdir,
2085 FILE_READONLY | FILE_HIDDEN | FILE_SYSTEM | FILE_DIRECTORY,
2086 &ffbuf, sizeof(ffbuf),
2087 &srchcnt,
2088 FIL_STANDARD);
2089 if (rc != NO_ERROR)
2090 return 0;
2091 return strncmp(ffbuf.achName, name, namelen) == 0;
Andrew MacIntyred9400542002-02-26 11:41:34 +00002092
Tim Peters50d8d372001-02-28 05:34:27 +00002093/* assuming it's a case-sensitive filesystem, so there's nothing to do! */
2094#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002095 return 1;
Guido van Rossum0980bd91998-02-13 17:18:36 +00002096
Guido van Rossum4d1b3b91998-02-13 23:27:59 +00002097#endif
Tim Peters50d8d372001-02-28 05:34:27 +00002098}
Guido van Rossum4d1b3b91998-02-13 23:27:59 +00002099
Guido van Rossum197346f1997-10-31 18:38:52 +00002100#ifdef HAVE_STAT
Victor Stinner4f4402c2010-08-14 14:50:26 +00002101
Guido van Rossum197346f1997-10-31 18:38:52 +00002102/* Helper to look for __init__.py or __init__.py[co] in potential package */
2103static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002104find_init_module(char *buf)
Guido van Rossum197346f1997-10-31 18:38:52 +00002105{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002106 const size_t save_len = strlen(buf);
2107 size_t i = save_len;
2108 char *pname; /* pointer to start of __init__ */
2109 struct stat statbuf;
Guido van Rossum197346f1997-10-31 18:38:52 +00002110
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002111/* For calling case_ok(buf, len, namelen, name):
2112 * /a/b/c/d/e/f/g/h/i/j/k/some_long_module_name.py\0
2113 * ^ ^ ^ ^
2114 * |--------------------- buf ---------------------|
2115 * |------------------- len ------------------|
2116 * |------ name -------|
2117 * |----- namelen -----|
Tim Peters0f9431f2001-07-05 03:47:53 +00002118 */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002119 if (save_len + 13 >= MAXPATHLEN)
2120 return 0;
2121 buf[i++] = SEP;
2122 pname = buf + i;
2123 strcpy(pname, "__init__.py");
2124 if (stat(buf, &statbuf) == 0) {
2125 if (case_ok(buf,
2126 save_len + 9, /* len("/__init__") */
2127 8, /* len("__init__") */
2128 pname)) {
2129 buf[save_len] = '\0';
2130 return 1;
2131 }
2132 }
2133 i += strlen(pname);
2134 strcpy(buf+i, Py_OptimizeFlag ? "o" : "c");
2135 if (stat(buf, &statbuf) == 0) {
2136 if (case_ok(buf,
2137 save_len + 9, /* len("/__init__") */
2138 8, /* len("__init__") */
2139 pname)) {
2140 buf[save_len] = '\0';
2141 return 1;
2142 }
2143 }
2144 buf[save_len] = '\0';
2145 return 0;
Guido van Rossum197346f1997-10-31 18:38:52 +00002146}
Guido van Rossum48a680c2001-03-02 06:34:14 +00002147
Guido van Rossum197346f1997-10-31 18:38:52 +00002148#endif /* HAVE_STAT */
2149
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002150
Victor Stinner95872862011-03-07 18:20:56 +01002151static int init_builtin(PyObject *); /* Forward */
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002152
Victor Stinner44c6c152010-08-09 00:59:10 +00002153static PyObject*
Victor Stinner95872862011-03-07 18:20:56 +01002154load_builtin(PyObject *name, int type)
Victor Stinner44c6c152010-08-09 00:59:10 +00002155{
2156 PyObject *m, *modules;
2157 int err;
2158
Victor Stinner44c6c152010-08-09 00:59:10 +00002159 if (type == C_BUILTIN)
2160 err = init_builtin(name);
2161 else
Victor Stinner95872862011-03-07 18:20:56 +01002162 err = PyImport_ImportFrozenModuleObject(name);
Victor Stinner44c6c152010-08-09 00:59:10 +00002163 if (err < 0)
2164 return NULL;
2165 if (err == 0) {
2166 PyErr_Format(PyExc_ImportError,
Victor Stinner95872862011-03-07 18:20:56 +01002167 "Purported %s module %R not found",
2168 type == C_BUILTIN ? "builtin" : "frozen",
Victor Stinner44c6c152010-08-09 00:59:10 +00002169 name);
2170 return NULL;
2171 }
2172
2173 modules = PyImport_GetModuleDict();
Victor Stinner95872862011-03-07 18:20:56 +01002174 m = PyDict_GetItem(modules, name);
Victor Stinner44c6c152010-08-09 00:59:10 +00002175 if (m == NULL) {
2176 PyErr_Format(
2177 PyExc_ImportError,
Victor Stinner95872862011-03-07 18:20:56 +01002178 "%s module %R not properly initialized",
2179 type == C_BUILTIN ? "builtin" : "frozen",
Victor Stinner44c6c152010-08-09 00:59:10 +00002180 name);
2181 return NULL;
2182 }
2183 Py_INCREF(m);
2184 return m;
2185}
2186
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002187/* Load an external module using the default search path and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00002188 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002189
Guido van Rossum79f25d91997-04-29 20:08:16 +00002190static PyObject *
Alexandre Vassalottie223eb82009-07-29 20:12:15 +00002191load_module(char *name, FILE *fp, char *pathname, int type, PyObject *loader)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002192{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002193 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002194
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002195 /* First check that there's an open file (if we need one) */
2196 switch (type) {
2197 case PY_SOURCE:
2198 case PY_COMPILED:
2199 if (fp == NULL) {
2200 PyErr_Format(PyExc_ValueError,
2201 "file object required for import (type code %d)",
2202 type);
2203 return NULL;
2204 }
2205 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002206
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002207 switch (type) {
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002208
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002209 case PY_SOURCE:
2210 m = load_source_module(name, pathname, fp);
2211 break;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002212
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002213 case PY_COMPILED:
2214 m = load_compiled_module(name, pathname, fp);
2215 break;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002216
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002217#ifdef HAVE_DYNAMIC_LOADING
Victor Stinnerfefd70c2011-03-14 15:54:07 -04002218 case C_EXTENSION: {
2219 PyObject *nameobj, *pathobj;
2220 nameobj = PyUnicode_FromString(name);
2221 if (nameobj == NULL)
2222 return NULL;
2223 pathobj = PyUnicode_DecodeFSDefault(pathname);
2224 if (pathobj == NULL) {
2225 Py_DECREF(nameobj);
2226 return NULL;
2227 }
2228 m = _PyImport_LoadDynamicModule(nameobj, pathobj, fp);
2229 Py_DECREF(nameobj);
2230 Py_DECREF(pathobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002231 break;
Victor Stinnerfefd70c2011-03-14 15:54:07 -04002232 }
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002233#endif
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002234
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002235 case PKG_DIRECTORY:
2236 m = load_package(name, pathname);
2237 break;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002238
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002239 case C_BUILTIN:
Victor Stinner95872862011-03-07 18:20:56 +01002240 case PY_FROZEN: {
2241 PyObject *nameobj = PyUnicode_FromString(name);
Victor Stinnerfefd70c2011-03-14 15:54:07 -04002242 if (nameobj == NULL)
2243 return NULL;
2244 m = load_builtin(nameobj, type);
2245 Py_DECREF(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002246 break;
Victor Stinner95872862011-03-07 18:20:56 +01002247 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002248
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002249 case IMP_HOOK: {
2250 if (loader == NULL) {
2251 PyErr_SetString(PyExc_ImportError,
2252 "import hook without loader");
2253 return NULL;
2254 }
2255 m = PyObject_CallMethod(loader, "load_module", "s", name);
2256 break;
2257 }
Just van Rossum52e14d62002-12-30 22:08:05 +00002258
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002259 default:
2260 PyErr_Format(PyExc_ImportError,
2261 "Don't know how to import %.200s (type code %d)",
2262 name, type);
2263 m = NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002264
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002265 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002266
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002267 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002268}
2269
2270
2271/* Initialize a built-in module.
Thomas Wouters89f507f2006-12-13 04:49:30 +00002272 Return 1 for success, 0 if the module is not found, and -1 with
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002273 an exception set if the initialization failed. */
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002274
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002275static int
Victor Stinner95872862011-03-07 18:20:56 +01002276init_builtin(PyObject *name)
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002277{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002278 struct _inittab *p;
Guido van Rossum25ce5661997-08-02 03:10:38 +00002279
Victor Stinner95872862011-03-07 18:20:56 +01002280 if (_PyImport_FindExtensionObject(name, name) != NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002281 return 1;
Guido van Rossum25ce5661997-08-02 03:10:38 +00002282
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002283 for (p = PyImport_Inittab; p->name != NULL; p++) {
2284 PyObject *mod;
Victor Stinner95872862011-03-07 18:20:56 +01002285 if (PyUnicode_CompareWithASCIIString(name, p->name) == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002286 if (p->initfunc == NULL) {
2287 PyErr_Format(PyExc_ImportError,
Victor Stinner95872862011-03-07 18:20:56 +01002288 "Cannot re-init internal module %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002289 name);
2290 return -1;
2291 }
2292 if (Py_VerboseFlag)
Victor Stinner95872862011-03-07 18:20:56 +01002293 PySys_FormatStderr("import %U # builtin\n", name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002294 mod = (*p->initfunc)();
2295 if (mod == 0)
2296 return -1;
Victor Stinner95872862011-03-07 18:20:56 +01002297 if (_PyImport_FixupExtensionObject(mod, name, name) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002298 return -1;
2299 /* FixupExtension has put the module into sys.modules,
2300 so we can release our own reference. */
2301 Py_DECREF(mod);
2302 return 1;
2303 }
2304 }
2305 return 0;
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002306}
Guido van Rossumf56e3db1993-04-01 20:59:32 +00002307
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002308
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002309/* Frozen modules */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002310
Guido van Rossumcfd0a221996-06-17 17:06:34 +00002311static struct _frozen *
Victor Stinner53dc7352011-03-20 01:50:21 +01002312find_frozen(PyObject *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002313{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002314 struct _frozen *p;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002315
Victor Stinner53dc7352011-03-20 01:50:21 +01002316 if (name == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002317 return NULL;
Benjamin Petersond968e272008-11-05 22:48:33 +00002318
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002319 for (p = PyImport_FrozenModules; ; p++) {
2320 if (p->name == NULL)
2321 return NULL;
Victor Stinner53dc7352011-03-20 01:50:21 +01002322 if (PyUnicode_CompareWithASCIIString(name, p->name) == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002323 break;
2324 }
2325 return p;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002326}
2327
Guido van Rossum79f25d91997-04-29 20:08:16 +00002328static PyObject *
Victor Stinner53dc7352011-03-20 01:50:21 +01002329get_frozen_object(PyObject *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002330{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002331 struct _frozen *p = find_frozen(name);
2332 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002333
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002334 if (p == NULL) {
2335 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002336 "No such frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002337 name);
2338 return NULL;
2339 }
2340 if (p->code == NULL) {
2341 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002342 "Excluded frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002343 name);
2344 return NULL;
2345 }
2346 size = p->size;
2347 if (size < 0)
2348 size = -size;
2349 return PyMarshal_ReadObjectFromString((char *)p->code, size);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002350}
2351
Brett Cannon8d110132009-03-15 02:20:16 +00002352static PyObject *
Victor Stinner53dc7352011-03-20 01:50:21 +01002353is_frozen_package(PyObject *name)
Brett Cannon8d110132009-03-15 02:20:16 +00002354{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002355 struct _frozen *p = find_frozen(name);
2356 int size;
Brett Cannon8d110132009-03-15 02:20:16 +00002357
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002358 if (p == NULL) {
2359 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002360 "No such frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002361 name);
2362 return NULL;
2363 }
Brett Cannon8d110132009-03-15 02:20:16 +00002364
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002365 size = p->size;
Brett Cannon8d110132009-03-15 02:20:16 +00002366
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002367 if (size < 0)
2368 Py_RETURN_TRUE;
2369 else
2370 Py_RETURN_FALSE;
Brett Cannon8d110132009-03-15 02:20:16 +00002371}
2372
2373
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002374/* Initialize a frozen module.
Brett Cannon3c2ac442009-03-08 20:49:47 +00002375 Return 1 for success, 0 if the module is not found, and -1 with
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002376 an exception set if the initialization failed.
2377 This function is also used from frozenmain.c */
Guido van Rossum0b344901995-02-07 15:35:27 +00002378
2379int
Victor Stinner53dc7352011-03-20 01:50:21 +01002380PyImport_ImportFrozenModuleObject(PyObject *name)
Guido van Rossumf56e3db1993-04-01 20:59:32 +00002381{
Victor Stinner53dc7352011-03-20 01:50:21 +01002382 struct _frozen *p;
2383 PyObject *co, *m, *path;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002384 int ispackage;
2385 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002386
Victor Stinner53dc7352011-03-20 01:50:21 +01002387 p = find_frozen(name);
2388
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002389 if (p == NULL)
2390 return 0;
2391 if (p->code == NULL) {
2392 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002393 "Excluded frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002394 name);
2395 return -1;
2396 }
2397 size = p->size;
2398 ispackage = (size < 0);
2399 if (ispackage)
2400 size = -size;
2401 if (Py_VerboseFlag)
Victor Stinner53dc7352011-03-20 01:50:21 +01002402 PySys_FormatStderr("import %U # frozen%s\n",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002403 name, ispackage ? " package" : "");
2404 co = PyMarshal_ReadObjectFromString((char *)p->code, size);
2405 if (co == NULL)
2406 return -1;
2407 if (!PyCode_Check(co)) {
2408 PyErr_Format(PyExc_TypeError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002409 "frozen object %R is not a code object",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002410 name);
2411 goto err_return;
2412 }
2413 if (ispackage) {
2414 /* Set __path__ to the package name */
Victor Stinner53dc7352011-03-20 01:50:21 +01002415 PyObject *d, *l;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002416 int err;
Victor Stinner53dc7352011-03-20 01:50:21 +01002417 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002418 if (m == NULL)
2419 goto err_return;
2420 d = PyModule_GetDict(m);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002421 l = PyList_New(1);
2422 if (l == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002423 goto err_return;
2424 }
Victor Stinner53dc7352011-03-20 01:50:21 +01002425 Py_INCREF(name);
2426 PyList_SET_ITEM(l, 0, name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002427 err = PyDict_SetItemString(d, "__path__", l);
2428 Py_DECREF(l);
2429 if (err != 0)
2430 goto err_return;
2431 }
Victor Stinner53dc7352011-03-20 01:50:21 +01002432 path = PyUnicode_FromString("<frozen>");
2433 if (path == NULL)
2434 goto err_return;
2435 m = PyImport_ExecCodeModuleObject(name, co, path, NULL);
2436 Py_DECREF(path);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002437 if (m == NULL)
2438 goto err_return;
2439 Py_DECREF(co);
2440 Py_DECREF(m);
2441 return 1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002442err_return:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002443 Py_DECREF(co);
2444 return -1;
Guido van Rossumf56e3db1993-04-01 20:59:32 +00002445}
Guido van Rossum74e6a111994-08-29 12:54:38 +00002446
Victor Stinner53dc7352011-03-20 01:50:21 +01002447int
2448PyImport_ImportFrozenModule(char *name)
2449{
2450 PyObject *nameobj;
2451 int ret;
2452 nameobj = PyUnicode_InternFromString(name);
2453 if (nameobj == NULL)
2454 return -1;
2455 ret = PyImport_ImportFrozenModuleObject(nameobj);
2456 Py_DECREF(nameobj);
2457 return ret;
2458}
2459
Guido van Rossum74e6a111994-08-29 12:54:38 +00002460
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002461/* Import a module, either built-in, frozen, or external, and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00002462 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum74e6a111994-08-29 12:54:38 +00002463
Guido van Rossum79f25d91997-04-29 20:08:16 +00002464PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00002465PyImport_ImportModule(const char *name)
Guido van Rossum74e6a111994-08-29 12:54:38 +00002466{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002467 PyObject *pname;
2468 PyObject *result;
Marc-André Lemburg3c61c352001-02-09 19:40:15 +00002469
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002470 pname = PyUnicode_FromString(name);
2471 if (pname == NULL)
2472 return NULL;
2473 result = PyImport_Import(pname);
2474 Py_DECREF(pname);
2475 return result;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002476}
2477
Christian Heimes072c0f12008-01-03 23:01:04 +00002478/* Import a module without blocking
2479 *
2480 * At first it tries to fetch the module from sys.modules. If the module was
2481 * never loaded before it loads it with PyImport_ImportModule() unless another
2482 * thread holds the import lock. In the latter case the function raises an
2483 * ImportError instead of blocking.
2484 *
2485 * Returns the module object with incremented ref count.
2486 */
2487PyObject *
2488PyImport_ImportModuleNoBlock(const char *name)
2489{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002490 PyObject *result;
2491 PyObject *modules;
2492 long me;
Christian Heimes072c0f12008-01-03 23:01:04 +00002493
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002494 /* Try to get the module from sys.modules[name] */
2495 modules = PyImport_GetModuleDict();
2496 if (modules == NULL)
2497 return NULL;
Christian Heimes072c0f12008-01-03 23:01:04 +00002498
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002499 result = PyDict_GetItemString(modules, name);
2500 if (result != NULL) {
2501 Py_INCREF(result);
2502 return result;
2503 }
2504 else {
2505 PyErr_Clear();
2506 }
Benjamin Peterson3e4f0552008-09-02 00:31:15 +00002507#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002508 /* check the import lock
2509 * me might be -1 but I ignore the error here, the lock function
2510 * takes care of the problem */
2511 me = PyThread_get_thread_ident();
2512 if (import_lock_thread == -1 || import_lock_thread == me) {
2513 /* no thread or me is holding the lock */
2514 return PyImport_ImportModule(name);
2515 }
2516 else {
2517 PyErr_Format(PyExc_ImportError,
2518 "Failed to import %.200s because the import lock"
2519 "is held by another thread.",
2520 name);
2521 return NULL;
2522 }
Benjamin Peterson3e4f0552008-09-02 00:31:15 +00002523#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002524 return PyImport_ImportModule(name);
Benjamin Peterson3e4f0552008-09-02 00:31:15 +00002525#endif
Christian Heimes072c0f12008-01-03 23:01:04 +00002526}
2527
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002528/* Forward declarations for helper routines */
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002529static PyObject *get_parent(PyObject *globals, char *buf,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002530 Py_ssize_t *p_buflen, int level);
Tim Petersdbd9ba62000-07-09 03:09:57 +00002531static PyObject *load_next(PyObject *mod, PyObject *altmod,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002532 char **p_name, char *buf, Py_ssize_t *p_buflen);
Tim Petersdbd9ba62000-07-09 03:09:57 +00002533static int mark_miss(char *name);
2534static int ensure_fromlist(PyObject *mod, PyObject *fromlist,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002535 char *buf, Py_ssize_t buflen, int recursive);
Tim Petersdbd9ba62000-07-09 03:09:57 +00002536static PyObject * import_submodule(PyObject *mod, char *name, char *fullname);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002537
2538/* The Magnum Opus of dotted-name import :-) */
2539
Guido van Rossum75acc9c1998-03-03 22:26:50 +00002540static PyObject *
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002541import_module_level(char *name, PyObject *globals, PyObject *locals,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002542 PyObject *fromlist, int level)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002543{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002544 char buf[MAXPATHLEN+1];
2545 Py_ssize_t buflen = 0;
2546 PyObject *parent, *head, *next, *tail;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002547
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002548 if (strchr(name, '/') != NULL
Christian Heimes454f37b2008-01-10 00:10:02 +00002549#ifdef MS_WINDOWS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002550 || strchr(name, '\\') != NULL
Christian Heimes454f37b2008-01-10 00:10:02 +00002551#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002552 ) {
2553 PyErr_SetString(PyExc_ImportError,
2554 "Import by filename is not supported.");
2555 return NULL;
2556 }
Christian Heimes454f37b2008-01-10 00:10:02 +00002557
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002558 parent = get_parent(globals, buf, &buflen, level);
2559 if (parent == NULL)
2560 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002561
Benjamin Peterson556d8002010-06-27 22:37:28 +00002562 head = load_next(parent, level < 0 ? Py_None : parent, &name, buf,
2563 &buflen);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002564 if (head == NULL)
2565 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002566
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002567 tail = head;
2568 Py_INCREF(tail);
2569 while (name) {
2570 next = load_next(tail, tail, &name, buf, &buflen);
2571 Py_DECREF(tail);
2572 if (next == NULL) {
2573 Py_DECREF(head);
2574 return NULL;
2575 }
2576 tail = next;
2577 }
2578 if (tail == Py_None) {
2579 /* If tail is Py_None, both get_parent and load_next found
2580 an empty module name: someone called __import__("") or
2581 doctored faulty bytecode */
2582 Py_DECREF(tail);
2583 Py_DECREF(head);
2584 PyErr_SetString(PyExc_ValueError,
2585 "Empty module name");
2586 return NULL;
2587 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002588
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002589 if (fromlist != NULL) {
2590 if (fromlist == Py_None || !PyObject_IsTrue(fromlist))
2591 fromlist = NULL;
2592 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002593
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002594 if (fromlist == NULL) {
2595 Py_DECREF(tail);
2596 return head;
2597 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002598
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002599 Py_DECREF(head);
2600 if (!ensure_fromlist(tail, fromlist, buf, buflen, 0)) {
2601 Py_DECREF(tail);
2602 return NULL;
2603 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002604
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002605 return tail;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002606}
2607
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002608PyObject *
2609PyImport_ImportModuleLevel(char *name, PyObject *globals, PyObject *locals,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002610 PyObject *fromlist, int level)
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002611{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002612 PyObject *result;
2613 _PyImport_AcquireLock();
2614 result = import_module_level(name, globals, locals, fromlist, level);
2615 if (_PyImport_ReleaseLock() < 0) {
2616 Py_XDECREF(result);
2617 PyErr_SetString(PyExc_RuntimeError,
2618 "not holding the import lock");
2619 return NULL;
2620 }
2621 return result;
Guido van Rossum75acc9c1998-03-03 22:26:50 +00002622}
2623
Fred Drake87590902004-05-28 20:21:36 +00002624/* Return the package that an import is being performed in. If globals comes
2625 from the module foo.bar.bat (not itself a package), this returns the
2626 sys.modules entry for foo.bar. If globals is from a package's __init__.py,
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00002627 the package's entry in sys.modules is returned, as a borrowed reference.
Fred Drake87590902004-05-28 20:21:36 +00002628
2629 The *name* of the returned package is returned in buf, with the length of
2630 the name in *p_buflen.
2631
2632 If globals doesn't come from a package or a module in a package, or a
2633 corresponding entry is not found in sys.modules, Py_None is returned.
2634*/
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002635static PyObject *
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002636get_parent(PyObject *globals, char *buf, Py_ssize_t *p_buflen, int level)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002637{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002638 static PyObject *namestr = NULL;
2639 static PyObject *pathstr = NULL;
2640 static PyObject *pkgstr = NULL;
2641 PyObject *pkgname, *modname, *modpath, *modules, *parent;
2642 int orig_level = level;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002643
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002644 if (globals == NULL || !PyDict_Check(globals) || !level)
2645 return Py_None;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002646
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002647 if (namestr == NULL) {
2648 namestr = PyUnicode_InternFromString("__name__");
2649 if (namestr == NULL)
2650 return NULL;
2651 }
2652 if (pathstr == NULL) {
2653 pathstr = PyUnicode_InternFromString("__path__");
2654 if (pathstr == NULL)
2655 return NULL;
2656 }
2657 if (pkgstr == NULL) {
2658 pkgstr = PyUnicode_InternFromString("__package__");
2659 if (pkgstr == NULL)
2660 return NULL;
2661 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002662
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002663 *buf = '\0';
2664 *p_buflen = 0;
2665 pkgname = PyDict_GetItem(globals, pkgstr);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002666
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002667 if ((pkgname != NULL) && (pkgname != Py_None)) {
2668 /* __package__ is set, so use it */
2669 char *pkgname_str;
2670 Py_ssize_t len;
Alexandre Vassalottia85998a2008-05-03 18:24:43 +00002671
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002672 if (!PyUnicode_Check(pkgname)) {
2673 PyErr_SetString(PyExc_ValueError,
2674 "__package__ set to non-string");
2675 return NULL;
2676 }
2677 pkgname_str = _PyUnicode_AsStringAndSize(pkgname, &len);
2678 if (len == 0) {
2679 if (level > 0) {
2680 PyErr_SetString(PyExc_ValueError,
2681 "Attempted relative import in non-package");
2682 return NULL;
2683 }
2684 return Py_None;
2685 }
2686 if (len > MAXPATHLEN) {
2687 PyErr_SetString(PyExc_ValueError,
2688 "Package name too long");
2689 return NULL;
2690 }
2691 strcpy(buf, pkgname_str);
2692 } else {
2693 /* __package__ not set, so figure it out and set it */
2694 modname = PyDict_GetItem(globals, namestr);
2695 if (modname == NULL || !PyUnicode_Check(modname))
2696 return Py_None;
Brett Cannon9a5b25a2010-03-01 02:09:17 +00002697
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002698 modpath = PyDict_GetItem(globals, pathstr);
2699 if (modpath != NULL) {
2700 /* __path__ is set, so modname is already the package name */
2701 char *modname_str;
2702 Py_ssize_t len;
2703 int error;
Alexandre Vassalottia85998a2008-05-03 18:24:43 +00002704
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002705 modname_str = _PyUnicode_AsStringAndSize(modname, &len);
2706 if (len > MAXPATHLEN) {
2707 PyErr_SetString(PyExc_ValueError,
2708 "Module name too long");
2709 return NULL;
2710 }
2711 strcpy(buf, modname_str);
2712 error = PyDict_SetItem(globals, pkgstr, modname);
2713 if (error) {
2714 PyErr_SetString(PyExc_ValueError,
2715 "Could not set __package__");
2716 return NULL;
2717 }
2718 } else {
2719 /* Normal module, so work out the package name if any */
2720 char *start = _PyUnicode_AsString(modname);
2721 char *lastdot = strrchr(start, '.');
2722 size_t len;
2723 int error;
2724 if (lastdot == NULL && level > 0) {
2725 PyErr_SetString(PyExc_ValueError,
2726 "Attempted relative import in non-package");
2727 return NULL;
2728 }
2729 if (lastdot == NULL) {
2730 error = PyDict_SetItem(globals, pkgstr, Py_None);
2731 if (error) {
2732 PyErr_SetString(PyExc_ValueError,
2733 "Could not set __package__");
2734 return NULL;
2735 }
2736 return Py_None;
2737 }
2738 len = lastdot - start;
2739 if (len >= MAXPATHLEN) {
2740 PyErr_SetString(PyExc_ValueError,
2741 "Module name too long");
2742 return NULL;
2743 }
2744 strncpy(buf, start, len);
2745 buf[len] = '\0';
2746 pkgname = PyUnicode_FromString(buf);
2747 if (pkgname == NULL) {
2748 return NULL;
2749 }
2750 error = PyDict_SetItem(globals, pkgstr, pkgname);
2751 Py_DECREF(pkgname);
2752 if (error) {
2753 PyErr_SetString(PyExc_ValueError,
2754 "Could not set __package__");
2755 return NULL;
2756 }
2757 }
2758 }
2759 while (--level > 0) {
2760 char *dot = strrchr(buf, '.');
2761 if (dot == NULL) {
2762 PyErr_SetString(PyExc_ValueError,
2763 "Attempted relative import beyond "
2764 "toplevel package");
2765 return NULL;
2766 }
2767 *dot = '\0';
2768 }
2769 *p_buflen = strlen(buf);
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002770
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002771 modules = PyImport_GetModuleDict();
2772 parent = PyDict_GetItemString(modules, buf);
2773 if (parent == NULL) {
2774 if (orig_level < 1) {
2775 PyObject *err_msg = PyBytes_FromFormat(
2776 "Parent module '%.200s' not found "
2777 "while handling absolute import", buf);
2778 if (err_msg == NULL) {
2779 return NULL;
2780 }
2781 if (!PyErr_WarnEx(PyExc_RuntimeWarning,
2782 PyBytes_AsString(err_msg), 1)) {
2783 *buf = '\0';
2784 *p_buflen = 0;
2785 parent = Py_None;
2786 }
2787 Py_DECREF(err_msg);
2788 } else {
2789 PyErr_Format(PyExc_SystemError,
2790 "Parent module '%.200s' not loaded, "
2791 "cannot perform relative import", buf);
2792 }
2793 }
2794 return parent;
2795 /* We expect, but can't guarantee, if parent != None, that:
2796 - parent.__name__ == buf
2797 - parent.__dict__ is globals
2798 If this is violated... Who cares? */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002799}
2800
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002801/* altmod is either None or same as mod */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002802static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002803load_next(PyObject *mod, PyObject *altmod, char **p_name, char *buf,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002804 Py_ssize_t *p_buflen)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002805{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002806 char *name = *p_name;
2807 char *dot = strchr(name, '.');
2808 size_t len;
2809 char *p;
2810 PyObject *result;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002811
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002812 if (strlen(name) == 0) {
2813 /* completely empty module name should only happen in
2814 'from . import' (or '__import__("")')*/
2815 Py_INCREF(mod);
2816 *p_name = NULL;
2817 return mod;
2818 }
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002819
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002820 if (dot == NULL) {
2821 *p_name = NULL;
2822 len = strlen(name);
2823 }
2824 else {
2825 *p_name = dot+1;
2826 len = dot-name;
2827 }
2828 if (len == 0) {
2829 PyErr_SetString(PyExc_ValueError,
2830 "Empty module name");
2831 return NULL;
2832 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002833
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002834 p = buf + *p_buflen;
2835 if (p != buf)
2836 *p++ = '.';
2837 if (p+len-buf >= MAXPATHLEN) {
2838 PyErr_SetString(PyExc_ValueError,
2839 "Module name too long");
2840 return NULL;
2841 }
2842 strncpy(p, name, len);
2843 p[len] = '\0';
2844 *p_buflen = p+len-buf;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002845
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002846 result = import_submodule(mod, p, buf);
2847 if (result == Py_None && altmod != mod) {
2848 Py_DECREF(result);
2849 /* Here, altmod must be None and mod must not be None */
2850 result = import_submodule(altmod, p, p);
2851 if (result != NULL && result != Py_None) {
2852 if (mark_miss(buf) != 0) {
2853 Py_DECREF(result);
2854 return NULL;
2855 }
2856 strncpy(buf, name, len);
2857 buf[len] = '\0';
2858 *p_buflen = len;
2859 }
2860 }
2861 if (result == NULL)
2862 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002863
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002864 if (result == Py_None) {
2865 Py_DECREF(result);
2866 PyErr_Format(PyExc_ImportError,
2867 "No module named %.200s", name);
2868 return NULL;
2869 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002870
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002871 return result;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002872}
2873
2874static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002875mark_miss(char *name)
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00002876{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002877 PyObject *modules = PyImport_GetModuleDict();
2878 return PyDict_SetItemString(modules, name, Py_None);
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00002879}
2880
2881static int
Martin v. Löwis18e16552006-02-15 17:27:45 +00002882ensure_fromlist(PyObject *mod, PyObject *fromlist, char *buf, Py_ssize_t buflen,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002883 int recursive)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002884{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002885 int i;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002886
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002887 if (!PyObject_HasAttrString(mod, "__path__"))
2888 return 1;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002889
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002890 for (i = 0; ; i++) {
2891 PyObject *item = PySequence_GetItem(fromlist, i);
2892 int hasit;
2893 if (item == NULL) {
2894 if (PyErr_ExceptionMatches(PyExc_IndexError)) {
2895 PyErr_Clear();
2896 return 1;
2897 }
2898 return 0;
2899 }
2900 if (!PyUnicode_Check(item)) {
2901 PyErr_SetString(PyExc_TypeError,
2902 "Item in ``from list'' not a string");
2903 Py_DECREF(item);
2904 return 0;
2905 }
2906 if (PyUnicode_AS_UNICODE(item)[0] == '*') {
2907 PyObject *all;
2908 Py_DECREF(item);
2909 /* See if the package defines __all__ */
2910 if (recursive)
2911 continue; /* Avoid endless recursion */
2912 all = PyObject_GetAttrString(mod, "__all__");
2913 if (all == NULL)
2914 PyErr_Clear();
2915 else {
2916 int ret = ensure_fromlist(mod, all, buf, buflen, 1);
2917 Py_DECREF(all);
2918 if (!ret)
2919 return 0;
2920 }
2921 continue;
2922 }
2923 hasit = PyObject_HasAttr(mod, item);
2924 if (!hasit) {
2925 PyObject *item8;
2926 char *subname;
2927 PyObject *submod;
2928 char *p;
Victor Stinnerae6265f2010-05-15 16:27:27 +00002929 item8 = PyUnicode_EncodeFSDefault(item);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002930 if (!item8) {
2931 PyErr_SetString(PyExc_ValueError, "Cannot encode path item");
2932 return 0;
2933 }
2934 subname = PyBytes_AS_STRING(item8);
2935 if (buflen + strlen(subname) >= MAXPATHLEN) {
2936 PyErr_SetString(PyExc_ValueError,
2937 "Module name too long");
2938 Py_DECREF(item);
2939 return 0;
2940 }
2941 p = buf + buflen;
2942 *p++ = '.';
2943 strcpy(p, subname);
2944 submod = import_submodule(mod, subname, buf);
2945 Py_DECREF(item8);
2946 Py_XDECREF(submod);
2947 if (submod == NULL) {
2948 Py_DECREF(item);
2949 return 0;
2950 }
2951 }
2952 Py_DECREF(item);
2953 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002954
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002955 /* NOTREACHED */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002956}
2957
Neil Schemenauer00b09662003-06-16 21:03:07 +00002958static int
2959add_submodule(PyObject *mod, PyObject *submod, char *fullname, char *subname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002960 PyObject *modules)
Neil Schemenauer00b09662003-06-16 21:03:07 +00002961{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002962 if (mod == Py_None)
2963 return 1;
2964 /* Irrespective of the success of this load, make a
2965 reference to it in the parent package module. A copy gets
2966 saved in the modules dictionary under the full name, so get a
2967 reference from there, if need be. (The exception is when the
2968 load failed with a SyntaxError -- then there's no trace in
2969 sys.modules. In that case, of course, do nothing extra.) */
2970 if (submod == NULL) {
2971 submod = PyDict_GetItemString(modules, fullname);
2972 if (submod == NULL)
2973 return 1;
2974 }
2975 if (PyModule_Check(mod)) {
2976 /* We can't use setattr here since it can give a
2977 * spurious warning if the submodule name shadows a
2978 * builtin name */
2979 PyObject *dict = PyModule_GetDict(mod);
2980 if (!dict)
2981 return 0;
2982 if (PyDict_SetItemString(dict, subname, submod) < 0)
2983 return 0;
2984 }
2985 else {
2986 if (PyObject_SetAttrString(mod, subname, submod) < 0)
2987 return 0;
2988 }
2989 return 1;
Neil Schemenauer00b09662003-06-16 21:03:07 +00002990}
2991
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002992static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002993import_submodule(PyObject *mod, char *subname, char *fullname)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002994{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002995 PyObject *modules = PyImport_GetModuleDict();
2996 PyObject *m = NULL;
Guido van Rossum74e6a111994-08-29 12:54:38 +00002997
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002998 /* Require:
2999 if mod == None: subname == fullname
3000 else: mod.__name__ + "." + subname == fullname
3001 */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003002
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003003 if ((m = PyDict_GetItemString(modules, fullname)) != NULL) {
3004 Py_INCREF(m);
3005 }
3006 else {
Victor Stinner7d8b77c2011-03-12 08:45:02 -05003007 PyObject *path, *loader;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003008 char buf[MAXPATHLEN+1];
3009 struct filedescr *fdp;
Victor Stinner7d8b77c2011-03-12 08:45:02 -05003010 FILE *fp;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003011
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003012 if (mod == Py_None)
3013 path = NULL;
3014 else {
3015 path = PyObject_GetAttrString(mod, "__path__");
3016 if (path == NULL) {
3017 PyErr_Clear();
3018 Py_INCREF(Py_None);
3019 return Py_None;
3020 }
3021 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003022
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003023 fdp = find_module(fullname, subname, path, buf, MAXPATHLEN+1,
3024 &fp, &loader);
3025 Py_XDECREF(path);
3026 if (fdp == NULL) {
3027 if (!PyErr_ExceptionMatches(PyExc_ImportError))
3028 return NULL;
3029 PyErr_Clear();
3030 Py_INCREF(Py_None);
3031 return Py_None;
3032 }
3033 m = load_module(fullname, fp, buf, fdp->type, loader);
3034 Py_XDECREF(loader);
3035 if (fp)
3036 fclose(fp);
3037 if (!add_submodule(mod, m, fullname, subname, modules)) {
3038 Py_XDECREF(m);
3039 m = NULL;
3040 }
3041 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003042
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003043 return m;
Guido van Rossum74e6a111994-08-29 12:54:38 +00003044}
3045
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003046
3047/* Re-import a module of any kind and return its module object, WITH
3048 INCREMENTED REFERENCE COUNT */
3049
Guido van Rossum79f25d91997-04-29 20:08:16 +00003050PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003051PyImport_ReloadModule(PyObject *m)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003052{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003053 PyInterpreterState *interp = PyThreadState_Get()->interp;
3054 PyObject *modules_reloading = interp->modules_reloading;
3055 PyObject *modules = PyImport_GetModuleDict();
Victor Stinner7d8b77c2011-03-12 08:45:02 -05003056 PyObject *path = NULL, *loader, *existing_m = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003057 char *name, *subname;
3058 char buf[MAXPATHLEN+1];
3059 struct filedescr *fdp;
Victor Stinner7d8b77c2011-03-12 08:45:02 -05003060 FILE *fp;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003061 PyObject *newm;
Brett Cannon9a5b25a2010-03-01 02:09:17 +00003062
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003063 if (modules_reloading == NULL) {
3064 Py_FatalError("PyImport_ReloadModule: "
3065 "no modules_reloading dictionary!");
3066 return NULL;
3067 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003068
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003069 if (m == NULL || !PyModule_Check(m)) {
3070 PyErr_SetString(PyExc_TypeError,
3071 "reload() argument must be module");
3072 return NULL;
3073 }
3074 name = (char*)PyModule_GetName(m);
3075 if (name == NULL)
3076 return NULL;
3077 if (m != PyDict_GetItemString(modules, name)) {
3078 PyErr_Format(PyExc_ImportError,
3079 "reload(): module %.200s not in sys.modules",
3080 name);
3081 return NULL;
3082 }
3083 existing_m = PyDict_GetItemString(modules_reloading, name);
3084 if (existing_m != NULL) {
3085 /* Due to a recursive reload, this module is already
3086 being reloaded. */
3087 Py_INCREF(existing_m);
3088 return existing_m;
3089 }
3090 if (PyDict_SetItemString(modules_reloading, name, m) < 0)
3091 return NULL;
Guido van Rossumd8faa362007-04-27 19:54:29 +00003092
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003093 subname = strrchr(name, '.');
3094 if (subname == NULL)
3095 subname = name;
3096 else {
3097 PyObject *parentname, *parent;
3098 parentname = PyUnicode_FromStringAndSize(name, (subname-name));
3099 if (parentname == NULL) {
3100 imp_modules_reloading_clear();
3101 return NULL;
3102 }
3103 parent = PyDict_GetItem(modules, parentname);
3104 if (parent == NULL) {
3105 PyErr_Format(PyExc_ImportError,
3106 "reload(): parent %U not in sys.modules",
3107 parentname);
3108 Py_DECREF(parentname);
3109 imp_modules_reloading_clear();
3110 return NULL;
3111 }
3112 Py_DECREF(parentname);
3113 subname++;
3114 path = PyObject_GetAttrString(parent, "__path__");
3115 if (path == NULL)
3116 PyErr_Clear();
3117 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003118 fdp = find_module(name, subname, path, buf, MAXPATHLEN+1, &fp, &loader);
3119 Py_XDECREF(path);
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00003120
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003121 if (fdp == NULL) {
3122 Py_XDECREF(loader);
3123 imp_modules_reloading_clear();
3124 return NULL;
3125 }
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00003126
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003127 newm = load_module(name, fp, buf, fdp->type, loader);
3128 Py_XDECREF(loader);
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00003129
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003130 if (fp)
3131 fclose(fp);
3132 if (newm == NULL) {
3133 /* load_module probably removed name from modules because of
3134 * the error. Put back the original module object. We're
3135 * going to return NULL in this case regardless of whether
3136 * replacing name succeeds, so the return value is ignored.
3137 */
3138 PyDict_SetItemString(modules, name, m);
3139 }
3140 imp_modules_reloading_clear();
3141 return newm;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003142}
3143
3144
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003145/* Higher-level import emulator which emulates the "import" statement
3146 more accurately -- it invokes the __import__() function from the
3147 builtins of the current globals. This means that the import is
3148 done using whatever import hooks are installed in the current
Brett Cannonbc2eff32010-09-19 21:39:02 +00003149 environment.
Guido van Rossum6058eb41998-12-21 19:51:00 +00003150 A dummy list ["__doc__"] is passed as the 4th argument so that
Neal Norwitz80e7f272007-08-26 06:45:23 +00003151 e.g. PyImport_Import(PyUnicode_FromString("win32com.client.gencache"))
Guido van Rossum6058eb41998-12-21 19:51:00 +00003152 will return <module "gencache"> instead of <module "win32com">. */
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003153
3154PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003155PyImport_Import(PyObject *module_name)
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003156{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003157 static PyObject *silly_list = NULL;
3158 static PyObject *builtins_str = NULL;
3159 static PyObject *import_str = NULL;
3160 PyObject *globals = NULL;
3161 PyObject *import = NULL;
3162 PyObject *builtins = NULL;
Brett Cannonbc2eff32010-09-19 21:39:02 +00003163 PyObject *modules = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003164 PyObject *r = NULL;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003165
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003166 /* Initialize constant string objects */
3167 if (silly_list == NULL) {
3168 import_str = PyUnicode_InternFromString("__import__");
3169 if (import_str == NULL)
3170 return NULL;
3171 builtins_str = PyUnicode_InternFromString("__builtins__");
3172 if (builtins_str == NULL)
3173 return NULL;
Brett Cannonbc2eff32010-09-19 21:39:02 +00003174 silly_list = PyList_New(0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003175 if (silly_list == NULL)
3176 return NULL;
3177 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003178
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003179 /* Get the builtins from current globals */
3180 globals = PyEval_GetGlobals();
3181 if (globals != NULL) {
3182 Py_INCREF(globals);
3183 builtins = PyObject_GetItem(globals, builtins_str);
3184 if (builtins == NULL)
3185 goto err;
3186 }
3187 else {
3188 /* No globals -- use standard builtins, and fake globals */
3189 builtins = PyImport_ImportModuleLevel("builtins",
3190 NULL, NULL, NULL, 0);
3191 if (builtins == NULL)
3192 return NULL;
3193 globals = Py_BuildValue("{OO}", builtins_str, builtins);
3194 if (globals == NULL)
3195 goto err;
3196 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003197
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003198 /* Get the __import__ function from the builtins */
3199 if (PyDict_Check(builtins)) {
3200 import = PyObject_GetItem(builtins, import_str);
3201 if (import == NULL)
3202 PyErr_SetObject(PyExc_KeyError, import_str);
3203 }
3204 else
3205 import = PyObject_GetAttr(builtins, import_str);
3206 if (import == NULL)
3207 goto err;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003208
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003209 /* Call the __import__ function with the proper argument list
Brett Cannonbc2eff32010-09-19 21:39:02 +00003210 Always use absolute import here.
3211 Calling for side-effect of import. */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003212 r = PyObject_CallFunction(import, "OOOOi", module_name, globals,
3213 globals, silly_list, 0, NULL);
Brett Cannonbc2eff32010-09-19 21:39:02 +00003214 if (r == NULL)
3215 goto err;
3216 Py_DECREF(r);
3217
3218 modules = PyImport_GetModuleDict();
3219 r = PyDict_GetItem(modules, module_name);
3220 if (r != NULL)
3221 Py_INCREF(r);
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003222
3223 err:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003224 Py_XDECREF(globals);
3225 Py_XDECREF(builtins);
3226 Py_XDECREF(import);
Tim Peters50d8d372001-02-28 05:34:27 +00003227
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003228 return r;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003229}
3230
3231
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003232/* Module 'imp' provides Python access to the primitives used for
3233 importing modules.
3234*/
3235
Guido van Rossum79f25d91997-04-29 20:08:16 +00003236static PyObject *
Barry Warsaw28a691b2010-04-17 00:19:56 +00003237imp_make_magic(long magic)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003238{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003239 char buf[4];
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003240
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003241 buf[0] = (char) ((magic >> 0) & 0xff);
3242 buf[1] = (char) ((magic >> 8) & 0xff);
3243 buf[2] = (char) ((magic >> 16) & 0xff);
3244 buf[3] = (char) ((magic >> 24) & 0xff);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003245
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003246 return PyBytes_FromStringAndSize(buf, 4);
Victor Stinner3e2b7172010-11-09 09:32:19 +00003247}
Barry Warsaw28a691b2010-04-17 00:19:56 +00003248
3249static PyObject *
3250imp_get_magic(PyObject *self, PyObject *noargs)
3251{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003252 return imp_make_magic(pyc_magic);
Barry Warsaw28a691b2010-04-17 00:19:56 +00003253}
3254
3255static PyObject *
3256imp_get_tag(PyObject *self, PyObject *noargs)
3257{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003258 return PyUnicode_FromString(pyc_tag);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003259}
3260
Guido van Rossum79f25d91997-04-29 20:08:16 +00003261static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +00003262imp_get_suffixes(PyObject *self, PyObject *noargs)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003263{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003264 PyObject *list;
3265 struct filedescr *fdp;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003266
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003267 list = PyList_New(0);
3268 if (list == NULL)
3269 return NULL;
3270 for (fdp = _PyImport_Filetab; fdp->suffix != NULL; fdp++) {
3271 PyObject *item = Py_BuildValue("ssi",
3272 fdp->suffix, fdp->mode, fdp->type);
3273 if (item == NULL) {
3274 Py_DECREF(list);
3275 return NULL;
3276 }
3277 if (PyList_Append(list, item) < 0) {
3278 Py_DECREF(list);
3279 Py_DECREF(item);
3280 return NULL;
3281 }
3282 Py_DECREF(item);
3283 }
3284 return list;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003285}
3286
Guido van Rossum79f25d91997-04-29 20:08:16 +00003287static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003288call_find_module(char *name, PyObject *path)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003289{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003290 extern int fclose(FILE *);
3291 PyObject *fob, *ret;
3292 PyObject *pathobj;
3293 struct filedescr *fdp;
3294 char pathname[MAXPATHLEN+1];
Victor Stinner7d8b77c2011-03-12 08:45:02 -05003295 FILE *fp;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003296 int fd = -1;
3297 char *found_encoding = NULL;
3298 char *encoding = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003299
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003300 pathname[0] = '\0';
3301 if (path == Py_None)
3302 path = NULL;
3303 fdp = find_module(NULL, name, path, pathname, MAXPATHLEN+1, &fp, NULL);
3304 if (fdp == NULL)
3305 return NULL;
3306 if (fp != NULL) {
3307 fd = fileno(fp);
3308 if (fd != -1)
3309 fd = dup(fd);
3310 fclose(fp);
3311 fp = NULL;
3312 }
3313 if (fd != -1) {
3314 if (strchr(fdp->mode, 'b') == NULL) {
3315 /* PyTokenizer_FindEncoding() returns PyMem_MALLOC'ed
3316 memory. */
3317 found_encoding = PyTokenizer_FindEncoding(fd);
3318 lseek(fd, 0, 0); /* Reset position */
3319 if (found_encoding == NULL && PyErr_Occurred())
3320 return NULL;
3321 encoding = (found_encoding != NULL) ? found_encoding :
3322 (char*)PyUnicode_GetDefaultEncoding();
3323 }
3324 fob = PyFile_FromFd(fd, pathname, fdp->mode, -1,
3325 (char*)encoding, NULL, NULL, 1);
3326 if (fob == NULL) {
3327 close(fd);
3328 PyMem_FREE(found_encoding);
3329 return NULL;
3330 }
3331 }
3332 else {
3333 fob = Py_None;
3334 Py_INCREF(fob);
3335 }
3336 pathobj = PyUnicode_DecodeFSDefault(pathname);
3337 ret = Py_BuildValue("NN(ssi)",
3338 fob, pathobj, fdp->suffix, fdp->mode, fdp->type);
3339 PyMem_FREE(found_encoding);
Brett Cannon3bb42d92007-10-20 03:43:15 +00003340
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003341 return ret;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003342}
3343
Guido van Rossum79f25d91997-04-29 20:08:16 +00003344static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003345imp_find_module(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003346{
Victor Stinnerebc00522010-12-03 17:06:43 +00003347 PyObject *name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003348 PyObject *ret, *path = NULL;
Victor Stinnerebc00522010-12-03 17:06:43 +00003349 if (!PyArg_ParseTuple(args, "O&|O:find_module",
3350 PyUnicode_FSConverter, &name,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003351 &path))
3352 return NULL;
Victor Stinnerebc00522010-12-03 17:06:43 +00003353 ret = call_find_module(PyBytes_AS_STRING(name), path);
3354 Py_DECREF(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003355 return ret;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003356}
3357
3358static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003359imp_init_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003360{
Victor Stinner95872862011-03-07 18:20:56 +01003361 PyObject *name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003362 int ret;
3363 PyObject *m;
Victor Stinner95872862011-03-07 18:20:56 +01003364 if (!PyArg_ParseTuple(args, "U:init_builtin", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003365 return NULL;
3366 ret = init_builtin(name);
3367 if (ret < 0)
3368 return NULL;
3369 if (ret == 0) {
3370 Py_INCREF(Py_None);
3371 return Py_None;
3372 }
Victor Stinner95872862011-03-07 18:20:56 +01003373 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003374 Py_XINCREF(m);
3375 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003376}
3377
Guido van Rossum79f25d91997-04-29 20:08:16 +00003378static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003379imp_init_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003380{
Victor Stinner53dc7352011-03-20 01:50:21 +01003381 PyObject *name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003382 int ret;
3383 PyObject *m;
Victor Stinner53dc7352011-03-20 01:50:21 +01003384 if (!PyArg_ParseTuple(args, "U:init_frozen", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003385 return NULL;
Victor Stinner53dc7352011-03-20 01:50:21 +01003386 ret = PyImport_ImportFrozenModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003387 if (ret < 0)
3388 return NULL;
3389 if (ret == 0) {
3390 Py_INCREF(Py_None);
3391 return Py_None;
3392 }
Victor Stinner53dc7352011-03-20 01:50:21 +01003393 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003394 Py_XINCREF(m);
3395 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003396}
3397
Guido van Rossum79f25d91997-04-29 20:08:16 +00003398static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003399imp_get_frozen_object(PyObject *self, PyObject *args)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00003400{
Victor Stinner53dc7352011-03-20 01:50:21 +01003401 PyObject *name;
Jack Jansen95ffa231995-10-03 14:38:41 +00003402
Victor Stinner53dc7352011-03-20 01:50:21 +01003403 if (!PyArg_ParseTuple(args, "U:get_frozen_object", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003404 return NULL;
3405 return get_frozen_object(name);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00003406}
3407
Guido van Rossum79f25d91997-04-29 20:08:16 +00003408static PyObject *
Brett Cannon8d110132009-03-15 02:20:16 +00003409imp_is_frozen_package(PyObject *self, PyObject *args)
3410{
Victor Stinner53dc7352011-03-20 01:50:21 +01003411 PyObject *name;
Brett Cannon8d110132009-03-15 02:20:16 +00003412
Victor Stinner53dc7352011-03-20 01:50:21 +01003413 if (!PyArg_ParseTuple(args, "U:is_frozen_package", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003414 return NULL;
3415 return is_frozen_package(name);
Brett Cannon8d110132009-03-15 02:20:16 +00003416}
3417
3418static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003419imp_is_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003420{
Victor Stinner95872862011-03-07 18:20:56 +01003421 PyObject *name;
3422 if (!PyArg_ParseTuple(args, "U:is_builtin", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003423 return NULL;
3424 return PyLong_FromLong(is_builtin(name));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003425}
3426
Guido van Rossum79f25d91997-04-29 20:08:16 +00003427static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003428imp_is_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003429{
Victor Stinner53dc7352011-03-20 01:50:21 +01003430 PyObject *name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003431 struct _frozen *p;
Victor Stinner53dc7352011-03-20 01:50:21 +01003432 if (!PyArg_ParseTuple(args, "U:is_frozen", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003433 return NULL;
3434 p = find_frozen(name);
3435 return PyBool_FromLong((long) (p == NULL ? 0 : p->size));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003436}
3437
3438static FILE *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003439get_file(char *pathname, PyObject *fob, char *mode)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003440{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003441 FILE *fp;
3442 if (mode[0] == 'U')
3443 mode = "r" PY_STDIOTEXTMODE;
3444 if (fob == NULL) {
3445 fp = fopen(pathname, mode);
3446 }
3447 else {
3448 int fd = PyObject_AsFileDescriptor(fob);
3449 if (fd == -1)
3450 return NULL;
3451 if (!_PyVerify_fd(fd))
3452 goto error;
3453 /* the FILE struct gets a new fd, so that it can be closed
3454 * independently of the file descriptor given
3455 */
3456 fd = dup(fd);
3457 if (fd == -1)
3458 goto error;
3459 fp = fdopen(fd, mode);
3460 }
3461 if (fp)
3462 return fp;
Kristján Valur Jónssone1b04452009-03-31 17:43:39 +00003463error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003464 PyErr_SetFromErrno(PyExc_IOError);
3465 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003466}
3467
Guido van Rossum79f25d91997-04-29 20:08:16 +00003468static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003469imp_load_compiled(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003470{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003471 char *name;
Victor Stinnerebc00522010-12-03 17:06:43 +00003472 PyObject *pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003473 PyObject *fob = NULL;
3474 PyObject *m;
3475 FILE *fp;
Victor Stinnerebc00522010-12-03 17:06:43 +00003476 if (!PyArg_ParseTuple(args, "sO&|O:load_compiled",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003477 &name,
Victor Stinnerebc00522010-12-03 17:06:43 +00003478 PyUnicode_FSConverter, &pathname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003479 &fob))
3480 return NULL;
Victor Stinnerebc00522010-12-03 17:06:43 +00003481 fp = get_file(PyBytes_AS_STRING(pathname), fob, "rb");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003482 if (fp == NULL) {
Victor Stinnerebc00522010-12-03 17:06:43 +00003483 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003484 return NULL;
3485 }
Victor Stinnerebc00522010-12-03 17:06:43 +00003486 m = load_compiled_module(name, PyBytes_AS_STRING(pathname), fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003487 fclose(fp);
Victor Stinnerebc00522010-12-03 17:06:43 +00003488 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003489 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003490}
3491
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003492#ifdef HAVE_DYNAMIC_LOADING
3493
Guido van Rossum79f25d91997-04-29 20:08:16 +00003494static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003495imp_load_dynamic(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003496{
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003497 PyObject *name, *pathname, *fob = NULL, *mod;
3498 FILE *fp;
3499
3500 if (!PyArg_ParseTuple(args, "UO&|O:load_dynamic",
3501 &name, PyUnicode_FSDecoder, &pathname, &fob))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003502 return NULL;
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003503 if (fob != NULL) {
3504 fp = get_file(NULL, fob, "r");
3505 if (fp == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003506 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003507 }
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003508 else
3509 fp = NULL;
3510 mod = _PyImport_LoadDynamicModule(name, pathname, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003511 if (fp)
3512 fclose(fp);
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003513 return mod;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003514}
3515
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003516#endif /* HAVE_DYNAMIC_LOADING */
3517
Guido van Rossum79f25d91997-04-29 20:08:16 +00003518static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003519imp_load_source(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003520{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003521 char *name;
Victor Stinnerebc00522010-12-03 17:06:43 +00003522 PyObject *pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003523 PyObject *fob = NULL;
3524 PyObject *m;
3525 FILE *fp;
Victor Stinnerebc00522010-12-03 17:06:43 +00003526 if (!PyArg_ParseTuple(args, "sO&|O:load_source",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003527 &name,
Victor Stinnerebc00522010-12-03 17:06:43 +00003528 PyUnicode_FSConverter, &pathname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003529 &fob))
3530 return NULL;
Victor Stinnerebc00522010-12-03 17:06:43 +00003531 fp = get_file(PyBytes_AS_STRING(pathname), fob, "r");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003532 if (fp == NULL) {
Victor Stinnerebc00522010-12-03 17:06:43 +00003533 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003534 return NULL;
3535 }
Victor Stinnerebc00522010-12-03 17:06:43 +00003536 m = load_source_module(name, PyBytes_AS_STRING(pathname), fp);
3537 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003538 fclose(fp);
3539 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003540}
3541
Guido van Rossum79f25d91997-04-29 20:08:16 +00003542static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003543imp_load_module(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003544{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003545 char *name;
3546 PyObject *fob;
Victor Stinner1a563032010-10-15 22:43:10 +00003547 PyObject *pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003548 PyObject * ret;
3549 char *suffix; /* Unused */
3550 char *mode;
3551 int type;
3552 FILE *fp;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003553
Victor Stinner1a563032010-10-15 22:43:10 +00003554 if (!PyArg_ParseTuple(args, "sOO&(ssi):load_module",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003555 &name, &fob,
Victor Stinner1a563032010-10-15 22:43:10 +00003556 PyUnicode_FSConverter, &pathname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003557 &suffix, &mode, &type))
3558 return NULL;
3559 if (*mode) {
3560 /* Mode must start with 'r' or 'U' and must not contain '+'.
3561 Implicit in this test is the assumption that the mode
3562 may contain other modifiers like 'b' or 't'. */
Guido van Rossum5e2c5fa2002-05-30 17:33:07 +00003563
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003564 if (!(*mode == 'r' || *mode == 'U') || strchr(mode, '+')) {
3565 PyErr_Format(PyExc_ValueError,
3566 "invalid file open mode %.200s", mode);
Victor Stinner1a563032010-10-15 22:43:10 +00003567 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003568 return NULL;
3569 }
3570 }
3571 if (fob == Py_None)
3572 fp = NULL;
3573 else {
3574 fp = get_file(NULL, fob, mode);
3575 if (fp == NULL) {
Victor Stinner1a563032010-10-15 22:43:10 +00003576 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003577 return NULL;
3578 }
3579 }
Victor Stinner1a563032010-10-15 22:43:10 +00003580 ret = load_module(name, fp, PyBytes_AS_STRING(pathname), type, NULL);
3581 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003582 if (fp)
3583 fclose(fp);
3584 return ret;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003585}
3586
3587static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003588imp_load_package(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003589{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003590 char *name;
Victor Stinnerebc00522010-12-03 17:06:43 +00003591 PyObject *pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003592 PyObject * ret;
Victor Stinnerebc00522010-12-03 17:06:43 +00003593 if (!PyArg_ParseTuple(args, "sO&:load_package",
3594 &name, PyUnicode_FSConverter, &pathname))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003595 return NULL;
Victor Stinnerebc00522010-12-03 17:06:43 +00003596 ret = load_package(name, PyBytes_AS_STRING(pathname));
3597 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003598 return ret;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003599}
3600
3601static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003602imp_new_module(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003603{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003604 char *name;
3605 if (!PyArg_ParseTuple(args, "s:new_module", &name))
3606 return NULL;
3607 return PyModule_New(name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003608}
3609
Christian Heimes13a7a212008-01-07 17:13:09 +00003610static PyObject *
3611imp_reload(PyObject *self, PyObject *v)
3612{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003613 return PyImport_ReloadModule(v);
Christian Heimes13a7a212008-01-07 17:13:09 +00003614}
3615
3616PyDoc_STRVAR(doc_reload,
3617"reload(module) -> module\n\
3618\n\
3619Reload the module. The module must have been successfully imported before.");
3620
Barry Warsaw28a691b2010-04-17 00:19:56 +00003621static PyObject *
3622imp_cache_from_source(PyObject *self, PyObject *args, PyObject *kws)
3623{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003624 static char *kwlist[] = {"path", "debug_override", NULL};
Barry Warsaw28a691b2010-04-17 00:19:56 +00003625
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003626 char buf[MAXPATHLEN+1];
Victor Stinner3ea23dd2010-10-15 20:34:32 +00003627 PyObject *pathbytes;
3628 char *cpathname;
Benjamin Peterson294a9fc2010-10-16 03:12:39 +00003629 PyObject *debug_override = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003630 int debug = !Py_OptimizeFlag;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003631
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003632 if (!PyArg_ParseTupleAndKeywords(
Victor Stinner3ea23dd2010-10-15 20:34:32 +00003633 args, kws, "O&|O", kwlist,
3634 PyUnicode_FSConverter, &pathbytes, &debug_override))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003635 return NULL;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003636
Benjamin Peterson294a9fc2010-10-16 03:12:39 +00003637 if (debug_override != NULL &&
3638 (debug = PyObject_IsTrue(debug_override)) < 0) {
3639 Py_DECREF(pathbytes);
3640 return NULL;
3641 }
Barry Warsaw28a691b2010-04-17 00:19:56 +00003642
Victor Stinner3ea23dd2010-10-15 20:34:32 +00003643 cpathname = make_compiled_pathname(
3644 PyBytes_AS_STRING(pathbytes),
3645 buf, MAXPATHLEN+1, debug);
3646 Py_DECREF(pathbytes);
Barry Warsaw28a691b2010-04-17 00:19:56 +00003647
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003648 if (cpathname == NULL) {
3649 PyErr_Format(PyExc_SystemError, "path buffer too short");
3650 return NULL;
3651 }
Victor Stinner88bd8912010-10-15 22:46:07 +00003652 return PyUnicode_DecodeFSDefault(buf);
Barry Warsaw28a691b2010-04-17 00:19:56 +00003653}
3654
3655PyDoc_STRVAR(doc_cache_from_source,
3656"Given the path to a .py file, return the path to its .pyc/.pyo file.\n\
3657\n\
3658The .py file does not need to exist; this simply returns the path to the\n\
3659.pyc/.pyo file calculated as if the .py file were imported. The extension\n\
3660will be .pyc unless __debug__ is not defined, then it will be .pyo.\n\
3661\n\
3662If debug_override is not None, then it must be a boolean and is taken as\n\
3663the value of __debug__ instead.");
3664
3665static PyObject *
3666imp_source_from_cache(PyObject *self, PyObject *args, PyObject *kws)
3667{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003668 static char *kwlist[] = {"path", NULL};
Barry Warsaw28a691b2010-04-17 00:19:56 +00003669
Victor Stinnerebc00522010-12-03 17:06:43 +00003670 PyObject *pathname_obj;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003671 char *pathname;
3672 char buf[MAXPATHLEN+1];
Barry Warsaw28a691b2010-04-17 00:19:56 +00003673
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003674 if (!PyArg_ParseTupleAndKeywords(
Victor Stinnerebc00522010-12-03 17:06:43 +00003675 args, kws, "O&", kwlist,
3676 PyUnicode_FSConverter, &pathname_obj))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003677 return NULL;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003678
Victor Stinnerebc00522010-12-03 17:06:43 +00003679 pathname = PyBytes_AS_STRING(pathname_obj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003680 if (make_source_pathname(pathname, buf) == NULL) {
3681 PyErr_Format(PyExc_ValueError, "Not a PEP 3147 pyc path: %s",
3682 pathname);
Victor Stinnerebc00522010-12-03 17:06:43 +00003683 Py_DECREF(pathname_obj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003684 return NULL;
3685 }
Victor Stinnerebc00522010-12-03 17:06:43 +00003686 Py_DECREF(pathname_obj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003687 return PyUnicode_FromString(buf);
Barry Warsaw28a691b2010-04-17 00:19:56 +00003688}
3689
3690PyDoc_STRVAR(doc_source_from_cache,
3691"Given the path to a .pyc./.pyo file, return the path to its .py file.\n\
3692\n\
3693The .pyc/.pyo file does not need to exist; this simply returns the path to\n\
3694the .py file calculated to correspond to the .pyc/.pyo file. If path\n\
3695does not conform to PEP 3147 format, ValueError will be raised.");
3696
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003697/* Doc strings */
3698
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003699PyDoc_STRVAR(doc_imp,
3700"This module provides the components needed to build your own\n\
3701__import__ function. Undocumented functions are obsolete.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003702
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003703PyDoc_STRVAR(doc_find_module,
3704"find_module(name, [path]) -> (file, filename, (suffix, mode, type))\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003705Search for a module. If path is omitted or None, search for a\n\
3706built-in, frozen or special module and continue search in sys.path.\n\
3707The module name cannot contain '.'; to search for a submodule of a\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003708package, pass the submodule name and the package's __path__.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003709
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003710PyDoc_STRVAR(doc_load_module,
3711"load_module(name, file, filename, (suffix, mode, type)) -> module\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003712Load a module, given information returned by find_module().\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003713The module name must include the full package name, if any.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003714
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003715PyDoc_STRVAR(doc_get_magic,
3716"get_magic() -> string\n\
3717Return the magic number for .pyc or .pyo files.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003718
Barry Warsaw28a691b2010-04-17 00:19:56 +00003719PyDoc_STRVAR(doc_get_tag,
3720"get_tag() -> string\n\
3721Return the magic tag for .pyc or .pyo files.");
3722
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003723PyDoc_STRVAR(doc_get_suffixes,
3724"get_suffixes() -> [(suffix, mode, type), ...]\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003725Return a list of (suffix, mode, type) tuples describing the files\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003726that find_module() looks for.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003727
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003728PyDoc_STRVAR(doc_new_module,
3729"new_module(name) -> module\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003730Create a new module. Do not enter it in sys.modules.\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003731The module name must include the full package name, if any.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003732
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003733PyDoc_STRVAR(doc_lock_held,
Tim Petersa7c65092004-08-01 23:26:05 +00003734"lock_held() -> boolean\n\
3735Return True if the import lock is currently held, else False.\n\
3736On platforms without threads, return False.");
Tim Peters69232342001-08-30 05:16:13 +00003737
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00003738PyDoc_STRVAR(doc_acquire_lock,
3739"acquire_lock() -> None\n\
Neal Norwitz2294c0d2003-02-12 23:02:21 +00003740Acquires the interpreter's import lock for the current thread.\n\
3741This lock should be used by import hooks to ensure thread-safety\n\
3742when importing modules.\n\
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00003743On platforms without threads, this function does nothing.");
3744
3745PyDoc_STRVAR(doc_release_lock,
3746"release_lock() -> None\n\
3747Release the interpreter's import lock.\n\
3748On platforms without threads, this function does nothing.");
3749
Guido van Rossum79f25d91997-04-29 20:08:16 +00003750static PyMethodDef imp_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003751 {"find_module", imp_find_module, METH_VARARGS, doc_find_module},
3752 {"get_magic", imp_get_magic, METH_NOARGS, doc_get_magic},
3753 {"get_tag", imp_get_tag, METH_NOARGS, doc_get_tag},
3754 {"get_suffixes", imp_get_suffixes, METH_NOARGS, doc_get_suffixes},
3755 {"load_module", imp_load_module, METH_VARARGS, doc_load_module},
3756 {"new_module", imp_new_module, METH_VARARGS, doc_new_module},
3757 {"lock_held", imp_lock_held, METH_NOARGS, doc_lock_held},
3758 {"acquire_lock", imp_acquire_lock, METH_NOARGS, doc_acquire_lock},
3759 {"release_lock", imp_release_lock, METH_NOARGS, doc_release_lock},
3760 {"reload", imp_reload, METH_O, doc_reload},
3761 {"cache_from_source", (PyCFunction)imp_cache_from_source,
3762 METH_VARARGS | METH_KEYWORDS, doc_cache_from_source},
3763 {"source_from_cache", (PyCFunction)imp_source_from_cache,
3764 METH_VARARGS | METH_KEYWORDS, doc_source_from_cache},
3765 /* The rest are obsolete */
3766 {"get_frozen_object", imp_get_frozen_object, METH_VARARGS},
3767 {"is_frozen_package", imp_is_frozen_package, METH_VARARGS},
3768 {"init_builtin", imp_init_builtin, METH_VARARGS},
3769 {"init_frozen", imp_init_frozen, METH_VARARGS},
3770 {"is_builtin", imp_is_builtin, METH_VARARGS},
3771 {"is_frozen", imp_is_frozen, METH_VARARGS},
3772 {"load_compiled", imp_load_compiled, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003773#ifdef HAVE_DYNAMIC_LOADING
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003774 {"load_dynamic", imp_load_dynamic, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003775#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003776 {"load_package", imp_load_package, METH_VARARGS},
3777 {"load_source", imp_load_source, METH_VARARGS},
3778 {NULL, NULL} /* sentinel */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003779};
3780
Guido van Rossum1a8791e1998-08-04 22:46:29 +00003781static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003782setint(PyObject *d, char *name, int value)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003783{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003784 PyObject *v;
3785 int err;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003786
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003787 v = PyLong_FromLong((long)value);
3788 err = PyDict_SetItemString(d, name, v);
3789 Py_XDECREF(v);
3790 return err;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003791}
3792
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003793typedef struct {
3794 PyObject_HEAD
3795} NullImporter;
3796
3797static int
3798NullImporter_init(NullImporter *self, PyObject *args, PyObject *kwds)
3799{
Victor Stinner1a4d12d2010-08-13 13:07:29 +00003800#ifndef MS_WINDOWS
3801 PyObject *path;
3802 struct stat statbuf;
3803 int rv;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003804
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003805 if (!_PyArg_NoKeywords("NullImporter()", kwds))
3806 return -1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003807
Victor Stinner1a4d12d2010-08-13 13:07:29 +00003808 if (!PyArg_ParseTuple(args, "O&:NullImporter",
3809 PyUnicode_FSConverter, &path))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003810 return -1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003811
Victor Stinner1a4d12d2010-08-13 13:07:29 +00003812 if (PyBytes_GET_SIZE(path) == 0) {
3813 Py_DECREF(path);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003814 PyErr_SetString(PyExc_ImportError, "empty pathname");
3815 return -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003816 }
Victor Stinner1a4d12d2010-08-13 13:07:29 +00003817
3818 rv = stat(PyBytes_AS_STRING(path), &statbuf);
3819 Py_DECREF(path);
3820 if (rv == 0) {
3821 /* it exists */
3822 if (S_ISDIR(statbuf.st_mode)) {
3823 /* it's a directory */
3824 PyErr_SetString(PyExc_ImportError, "existing directory");
3825 return -1;
3826 }
3827 }
3828#else /* MS_WINDOWS */
3829 PyObject *pathobj;
3830 DWORD rv;
Victor Stinner255dfdb2010-09-29 10:28:51 +00003831 wchar_t *path;
Victor Stinner1a4d12d2010-08-13 13:07:29 +00003832
3833 if (!_PyArg_NoKeywords("NullImporter()", kwds))
3834 return -1;
3835
3836 if (!PyArg_ParseTuple(args, "U:NullImporter",
3837 &pathobj))
3838 return -1;
3839
3840 if (PyUnicode_GET_SIZE(pathobj) == 0) {
3841 PyErr_SetString(PyExc_ImportError, "empty pathname");
3842 return -1;
3843 }
3844
Victor Stinnerbeb4135b2010-10-07 01:02:42 +00003845 path = PyUnicode_AsWideCharString(pathobj, NULL);
Victor Stinner255dfdb2010-09-29 10:28:51 +00003846 if (path == NULL)
Victor Stinner1a4d12d2010-08-13 13:07:29 +00003847 return -1;
3848 /* see issue1293 and issue3677:
3849 * stat() on Windows doesn't recognise paths like
3850 * "e:\\shared\\" and "\\\\whiterab-c2znlh\\shared" as dirs.
3851 */
3852 rv = GetFileAttributesW(path);
Victor Stinner255dfdb2010-09-29 10:28:51 +00003853 PyMem_Free(path);
Victor Stinner1a4d12d2010-08-13 13:07:29 +00003854 if (rv != INVALID_FILE_ATTRIBUTES) {
3855 /* it exists */
3856 if (rv & FILE_ATTRIBUTE_DIRECTORY) {
3857 /* it's a directory */
3858 PyErr_SetString(PyExc_ImportError, "existing directory");
3859 return -1;
3860 }
3861 }
3862#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003863 return 0;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003864}
3865
3866static PyObject *
3867NullImporter_find_module(NullImporter *self, PyObject *args)
3868{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003869 Py_RETURN_NONE;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003870}
3871
3872static PyMethodDef NullImporter_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003873 {"find_module", (PyCFunction)NullImporter_find_module, METH_VARARGS,
3874 "Always return None"
3875 },
3876 {NULL} /* Sentinel */
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003877};
3878
3879
Christian Heimes9cd17752007-11-18 19:35:23 +00003880PyTypeObject PyNullImporter_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003881 PyVarObject_HEAD_INIT(NULL, 0)
3882 "imp.NullImporter", /*tp_name*/
3883 sizeof(NullImporter), /*tp_basicsize*/
3884 0, /*tp_itemsize*/
3885 0, /*tp_dealloc*/
3886 0, /*tp_print*/
3887 0, /*tp_getattr*/
3888 0, /*tp_setattr*/
3889 0, /*tp_reserved*/
3890 0, /*tp_repr*/
3891 0, /*tp_as_number*/
3892 0, /*tp_as_sequence*/
3893 0, /*tp_as_mapping*/
3894 0, /*tp_hash */
3895 0, /*tp_call*/
3896 0, /*tp_str*/
3897 0, /*tp_getattro*/
3898 0, /*tp_setattro*/
3899 0, /*tp_as_buffer*/
3900 Py_TPFLAGS_DEFAULT, /*tp_flags*/
3901 "Null importer object", /* tp_doc */
3902 0, /* tp_traverse */
3903 0, /* tp_clear */
3904 0, /* tp_richcompare */
3905 0, /* tp_weaklistoffset */
3906 0, /* tp_iter */
3907 0, /* tp_iternext */
3908 NullImporter_methods, /* tp_methods */
3909 0, /* tp_members */
3910 0, /* tp_getset */
3911 0, /* tp_base */
3912 0, /* tp_dict */
3913 0, /* tp_descr_get */
3914 0, /* tp_descr_set */
3915 0, /* tp_dictoffset */
3916 (initproc)NullImporter_init, /* tp_init */
3917 0, /* tp_alloc */
3918 PyType_GenericNew /* tp_new */
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003919};
3920
Martin v. Löwis1a214512008-06-11 05:26:20 +00003921static struct PyModuleDef impmodule = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003922 PyModuleDef_HEAD_INIT,
3923 "imp",
3924 doc_imp,
3925 0,
3926 imp_methods,
3927 NULL,
3928 NULL,
3929 NULL,
3930 NULL
Martin v. Löwis1a214512008-06-11 05:26:20 +00003931};
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003932
Jason Tishler6bc06ec2003-09-04 11:59:50 +00003933PyMODINIT_FUNC
Martin v. Löwis1a214512008-06-11 05:26:20 +00003934PyInit_imp(void)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003935{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003936 PyObject *m, *d;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003937
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003938 if (PyType_Ready(&PyNullImporter_Type) < 0)
3939 return NULL;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003940
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003941 m = PyModule_Create(&impmodule);
3942 if (m == NULL)
3943 goto failure;
3944 d = PyModule_GetDict(m);
3945 if (d == NULL)
3946 goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003947
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003948 if (setint(d, "SEARCH_ERROR", SEARCH_ERROR) < 0) goto failure;
3949 if (setint(d, "PY_SOURCE", PY_SOURCE) < 0) goto failure;
3950 if (setint(d, "PY_COMPILED", PY_COMPILED) < 0) goto failure;
3951 if (setint(d, "C_EXTENSION", C_EXTENSION) < 0) goto failure;
3952 if (setint(d, "PY_RESOURCE", PY_RESOURCE) < 0) goto failure;
3953 if (setint(d, "PKG_DIRECTORY", PKG_DIRECTORY) < 0) goto failure;
3954 if (setint(d, "C_BUILTIN", C_BUILTIN) < 0) goto failure;
3955 if (setint(d, "PY_FROZEN", PY_FROZEN) < 0) goto failure;
3956 if (setint(d, "PY_CODERESOURCE", PY_CODERESOURCE) < 0) goto failure;
3957 if (setint(d, "IMP_HOOK", IMP_HOOK) < 0) goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003958
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003959 Py_INCREF(&PyNullImporter_Type);
3960 PyModule_AddObject(m, "NullImporter", (PyObject *)&PyNullImporter_Type);
3961 return m;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003962 failure:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003963 Py_XDECREF(m);
3964 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003965}
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003966
3967
Guido van Rossumb18618d2000-05-03 23:44:39 +00003968/* API for embedding applications that want to add their own entries
3969 to the table of built-in modules. This should normally be called
3970 *before* Py_Initialize(). When the table resize fails, -1 is
3971 returned and the existing table is unchanged.
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003972
3973 After a similar function by Just van Rossum. */
3974
3975int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003976PyImport_ExtendInittab(struct _inittab *newtab)
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003977{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003978 static struct _inittab *our_copy = NULL;
3979 struct _inittab *p;
3980 int i, n;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003981
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003982 /* Count the number of entries in both tables */
3983 for (n = 0; newtab[n].name != NULL; n++)
3984 ;
3985 if (n == 0)
3986 return 0; /* Nothing to do */
3987 for (i = 0; PyImport_Inittab[i].name != NULL; i++)
3988 ;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003989
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003990 /* Allocate new memory for the combined table */
3991 p = our_copy;
3992 PyMem_RESIZE(p, struct _inittab, i+n+1);
3993 if (p == NULL)
3994 return -1;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003995
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003996 /* Copy the tables into the new memory */
3997 if (our_copy != PyImport_Inittab)
3998 memcpy(p, PyImport_Inittab, (i+1) * sizeof(struct _inittab));
3999 PyImport_Inittab = our_copy = p;
4000 memcpy(p+i, newtab, (n+1) * sizeof(struct _inittab));
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004001
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004002 return 0;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004003}
4004
4005/* Shorthand to add a single entry given a name and a function */
4006
4007int
Brett Cannona826f322009-04-02 03:41:46 +00004008PyImport_AppendInittab(const char *name, PyObject* (*initfunc)(void))
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004009{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004010 struct _inittab newtab[2];
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004011
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004012 memset(newtab, '\0', sizeof newtab);
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004013
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004014 newtab[0].name = (char *)name;
4015 newtab[0].initfunc = initfunc;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004016
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004017 return PyImport_ExtendInittab(newtab);
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004018}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00004019
4020#ifdef __cplusplus
4021}
4022#endif