blob: 59b284654ea538034e41ae467fd4f5252a4e6965 [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 Stinnerd68c2cf2011-03-12 16:02:28 -05001601/* Get the path of a module: get its importer and call importer.find_module()
1602 hook, or check if the module if a package (if path/__init__.py exists).
1603
1604 -1: error: a Python error occurred
1605 0: ignore: an error occurred because of invalid data, but the error is not
1606 important enough to be reported.
1607 1: get path: module not found, but *buf contains its path
1608 2: found: *p_fd is the file descriptor (IMP_HOOK or PKG_DIRECTORY)
1609 and *buf is the path */
1610
1611static int
1612find_module_path(char *fullname, const char *name, PyObject *path,
1613 PyObject *path_hooks, PyObject *path_importer_cache,
1614 char *buf, size_t buflen,
1615 PyObject **p_loader, struct filedescr **p_fd)
1616{
1617 PyObject *path_bytes;
1618 const char *base;
1619 Py_ssize_t len;
1620 size_t namelen;
1621 struct stat statbuf;
1622 static struct filedescr fd_package = {"", "", PKG_DIRECTORY};
1623
1624 if (PyUnicode_Check(path)) {
1625 path_bytes = PyUnicode_EncodeFSDefault(path);
1626 if (path_bytes == NULL)
1627 return -1;
1628 }
1629 else if (PyBytes_Check(path)) {
1630 Py_INCREF(path);
1631 path_bytes = path;
1632 }
1633 else
1634 return 0;
1635
1636 namelen = strlen(name);
1637 base = PyBytes_AS_STRING(path_bytes);
1638 len = PyBytes_GET_SIZE(path_bytes);
1639 if (len + 2 + namelen + MAXSUFFIXSIZE >= buflen) {
1640 Py_DECREF(path_bytes);
1641 return 0; /* Too long */
1642 }
1643 strcpy(buf, base);
1644 Py_DECREF(path_bytes);
1645
1646 if (strlen(buf) != len) {
1647 return 0; /* path_bytes contains '\0' */
1648 }
1649
1650 /* sys.path_hooks import hook */
1651 if (p_loader != NULL) {
1652 PyObject *importer;
1653
1654 importer = get_path_importer(path_importer_cache,
1655 path_hooks, path);
1656 if (importer == NULL) {
1657 return -1;
1658 }
1659 /* Note: importer is a borrowed reference */
1660 if (importer != Py_None) {
1661 PyObject *loader;
1662 loader = PyObject_CallMethod(importer,
1663 "find_module",
1664 "s", fullname);
1665 if (loader == NULL)
1666 return -1; /* error */
1667 if (loader != Py_None) {
1668 /* a loader was found */
1669 *p_loader = loader;
1670 *p_fd = &importhookdescr;
1671 return 2;
1672 }
1673 Py_DECREF(loader);
1674 return 0;
1675 }
1676 }
1677 /* no hook was found, use builtin import */
1678
1679 if (len > 0 && buf[len-1] != SEP
1680#ifdef ALTSEP
1681 && buf[len-1] != ALTSEP
1682#endif
1683 )
1684 buf[len++] = SEP;
1685 strcpy(buf+len, name);
1686 len += namelen;
1687
1688 /* Check for package import (buf holds a directory name,
1689 and there's an __init__ module in that directory */
1690#ifdef HAVE_STAT
1691 if (stat(buf, &statbuf) == 0 && /* it exists */
1692 S_ISDIR(statbuf.st_mode) && /* it's a directory */
1693 case_ok(buf, len, namelen, name)) { /* case matches */
1694 if (find_init_module(buf)) { /* and has __init__.py */
1695 *p_fd = &fd_package;
1696 return 2;
1697 }
1698 else {
1699 int err;
1700 PyObject *unicode = PyUnicode_DecodeFSDefault(buf);
1701 if (unicode == NULL)
1702 return -1;
1703 err = PyErr_WarnFormat(PyExc_ImportWarning, 1,
1704 "Not importing directory '%U': missing __init__.py",
1705 unicode);
1706 Py_DECREF(unicode);
1707 if (err)
1708 return -1;
1709 }
1710 }
1711#endif
1712 return 1;
1713}
1714
1715/* Find a module in search_path_list. For each path, try
1716 find_module_filename() or try each _PyImport_Filetab suffix.
1717
1718 If the module is found, return a file descriptor, write the path in
1719 *p_filename, write the pointer to the file object into *p_fp, and (if
1720 p_loader is not NULL) the loader into *p_loader.
1721
1722 Otherwise, raise an exception and return NULL. */
1723
Victor Stinner37580282011-03-20 01:34:43 +01001724static struct filedescr*
1725find_module_path_list(char *fullname, const char *name,
1726 PyObject *search_path_list, PyObject *path_hooks,
1727 PyObject *path_importer_cache,
1728 char *buf, size_t buflen,
1729 FILE **p_fp, PyObject **p_loader)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001730{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001731 Py_ssize_t i, npath;
1732 size_t len, namelen;
1733 struct filedescr *fdp = NULL;
1734 char *filemode;
1735 FILE *fp = NULL;
Andrew MacIntyred9400542002-02-26 11:41:34 +00001736#if defined(PYOS_OS2)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001737 size_t saved_len;
1738 size_t saved_namelen;
1739 char *saved_buf = NULL;
Andrew MacIntyred9400542002-02-26 11:41:34 +00001740#endif
Victor Stinner53dc7352011-03-20 01:50:21 +01001741
Victor Stinner37580282011-03-20 01:34:43 +01001742 npath = PyList_Size(search_path_list);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001743 namelen = strlen(name);
1744 for (i = 0; i < npath; i++) {
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001745 PyObject *path;
1746 int ok;
1747
1748 path = PyList_GetItem(search_path_list, i);
1749 if (path == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001750 return NULL;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001751
1752 ok = find_module_path(fullname, name, path,
1753 path_hooks, path_importer_cache,
1754 buf, buflen,
1755 p_loader, &fdp);
1756 if (ok < 0)
1757 return NULL;
1758 if (ok == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001759 continue;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001760 if (ok == 2)
1761 return fdp;
Amaury Forgeot d'Arcf1ca0b12008-06-11 17:40:47 +00001762
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001763 len = strlen(buf);
Andrew MacIntyred9400542002-02-26 11:41:34 +00001764#if defined(PYOS_OS2)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001765 /* take a snapshot of the module spec for restoration
1766 * after the 8 character DLL hackery
1767 */
1768 saved_buf = strdup(buf);
1769 saved_len = len;
1770 saved_namelen = namelen;
Andrew MacIntyred9400542002-02-26 11:41:34 +00001771#endif /* PYOS_OS2 */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001772 for (fdp = _PyImport_Filetab; fdp->suffix != NULL; fdp++) {
Guido van Rossum04110fb2007-08-24 16:32:05 +00001773#if defined(PYOS_OS2) && defined(HAVE_DYNAMIC_LOADING)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001774 /* OS/2 limits DLLs to 8 character names (w/o
1775 extension)
1776 * so if the name is longer than that and its a
1777 * dynamically loaded module we're going to try,
1778 * truncate the name before trying
1779 */
Victor Stinnerc6963162011-03-12 09:26:54 -05001780 if (strlen(name) > 8) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001781 /* is this an attempt to load a C extension? */
1782 const struct filedescr *scan;
1783 scan = _PyImport_DynLoadFiletab;
1784 while (scan->suffix != NULL) {
1785 if (!strcmp(scan->suffix, fdp->suffix))
1786 break;
1787 else
1788 scan++;
1789 }
1790 if (scan->suffix != NULL) {
1791 /* yes, so truncate the name */
1792 namelen = 8;
Victor Stinnerc6963162011-03-12 09:26:54 -05001793 len -= strlen(name) - namelen;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001794 buf[len] = '\0';
1795 }
1796 }
Andrew MacIntyred9400542002-02-26 11:41:34 +00001797#endif /* PYOS_OS2 */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001798 strcpy(buf+len, fdp->suffix);
1799 if (Py_VerboseFlag > 1)
1800 PySys_WriteStderr("# trying %s\n", buf);
1801 filemode = fdp->mode;
1802 if (filemode[0] == 'U')
1803 filemode = "r" PY_STDIOTEXTMODE;
1804 fp = fopen(buf, filemode);
1805 if (fp != NULL) {
1806 if (case_ok(buf, len, namelen, name))
1807 break;
1808 else { /* continue search */
1809 fclose(fp);
1810 fp = NULL;
1811 }
1812 }
Andrew MacIntyred9400542002-02-26 11:41:34 +00001813#if defined(PYOS_OS2)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001814 /* restore the saved snapshot */
1815 strcpy(buf, saved_buf);
1816 len = saved_len;
1817 namelen = saved_namelen;
Andrew MacIntyred9400542002-02-26 11:41:34 +00001818#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001819 }
Andrew MacIntyred9400542002-02-26 11:41:34 +00001820#if defined(PYOS_OS2)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001821 /* don't need/want the module name snapshot anymore */
1822 if (saved_buf)
1823 {
1824 free(saved_buf);
1825 saved_buf = NULL;
1826 }
Andrew MacIntyred9400542002-02-26 11:41:34 +00001827#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001828 if (fp != NULL)
1829 break;
1830 }
1831 if (fp == NULL) {
1832 PyErr_Format(PyExc_ImportError,
1833 "No module named %.200s", name);
1834 return NULL;
1835 }
1836 *p_fp = fp;
1837 return fdp;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001838}
1839
Victor Stinner37580282011-03-20 01:34:43 +01001840/* Find a module:
1841
1842 - try find_module() of each sys.meta_path hook
1843 - try find_frozen()
1844 - try is_builtin()
1845 - try _PyWin_FindRegisteredModule() (Windows only)
1846 - otherwise, call find_module_path_list() with search_path_list (if not
1847 NULL) or sys.path
1848
1849 Return:
1850
1851 - &fd_builtin (C_BUILTIN) if it is a builtin
1852 - &fd_frozen (PY_FROZEN) if it is frozen
1853 - &fd_package (PKG_DIRECTORY) and write the filename into *buf
1854 if it is a package
1855 - &importhookdescr (IMP_HOOK) and write the loader into *p_loader if a
1856 importer loader was found
1857 - a file descriptor (PY_SOURCE, PY_COMPILED, C_EXTENSION, PY_RESOURCE or
1858 PY_CODERESOURCE: see _PyImport_Filetab), write the filename into
1859 *buf and the pointer to the open file into *p_fp
1860 - NULL on error
1861
1862 By default, write an empty string into *buf, and *p_fp and *p_loader (if
1863 set) are set to NULL. Eg. *buf is an empty string for a builtin package. */
1864
1865static struct filedescr *
1866find_module(char *fullname, const char *name, PyObject *search_path_list,
1867 char *buf, size_t buflen, FILE **p_fp, PyObject **p_loader)
1868{
1869 Py_ssize_t i, npath;
1870 static struct filedescr fd_frozen = {"", "", PY_FROZEN};
1871 static struct filedescr fd_builtin = {"", "", C_BUILTIN};
1872 PyObject *path_hooks, *path_importer_cache;
1873 PyObject *fullname_obj, *nameobj;
1874
1875 *buf = '\0';
1876 *p_fp = NULL;
1877 if (p_loader != NULL)
1878 *p_loader = NULL;
1879
1880 if (strlen(name) > MAXPATHLEN) {
1881 PyErr_SetString(PyExc_OverflowError,
1882 "module name is too long");
1883 return NULL;
1884 }
1885
1886 /* sys.meta_path import hook */
1887 if (p_loader != NULL) {
1888 PyObject *meta_path;
1889
1890 meta_path = PySys_GetObject("meta_path");
1891 if (meta_path == NULL || !PyList_Check(meta_path)) {
1892 PyErr_SetString(PyExc_ImportError,
1893 "sys.meta_path must be a list of "
1894 "import hooks");
1895 return NULL;
1896 }
1897 Py_INCREF(meta_path); /* zap guard */
1898 npath = PyList_Size(meta_path);
1899 for (i = 0; i < npath; i++) {
1900 PyObject *loader;
1901 PyObject *hook = PyList_GetItem(meta_path, i);
1902 loader = PyObject_CallMethod(hook, "find_module",
1903 "sO", fullname,
1904 search_path_list != NULL ?
1905 search_path_list : Py_None);
1906 if (loader == NULL) {
1907 Py_DECREF(meta_path);
1908 return NULL; /* true error */
1909 }
1910 if (loader != Py_None) {
1911 /* a loader was found */
1912 *p_loader = loader;
1913 Py_DECREF(meta_path);
1914 return &importhookdescr;
1915 }
1916 Py_DECREF(loader);
1917 }
1918 Py_DECREF(meta_path);
1919 }
1920
1921 if (fullname != NULL) {
1922 fullname_obj = PyUnicode_FromString(fullname);
1923 if (fullname == NULL)
1924 return NULL;
1925 if (find_frozen(fullname_obj) != NULL) {
1926 Py_DECREF(fullname_obj);
1927 strcpy(buf, fullname);
1928 return &fd_frozen;
1929 }
1930 Py_DECREF(fullname_obj);
1931 }
1932
1933 if (search_path_list == NULL) {
1934#ifdef MS_COREDLL
1935 FILE *fp;
1936 struct filedescr *fdp;
1937 PyObject *filename, *filename_bytes;
1938#endif
1939 nameobj = PyUnicode_FromString(name);
1940 if (nameobj == NULL)
1941 return NULL;
1942 if (is_builtin(nameobj)) {
1943 Py_DECREF(nameobj);
1944 strcpy(buf, name);
1945 return &fd_builtin;
1946 }
1947#ifdef MS_COREDLL
1948 fp = _PyWin_FindRegisteredModule(nameobj, &fdp, &filename);
1949 if (fp != NULL) {
1950 Py_DECREF(nameobj);
1951 filename_bytes = PyUnicode_EncodeFSDefault(filename);
1952 Py_DECREF(filename);
1953 if (filename_bytes == NULL)
1954 return NULL;
1955 strncpy(buf, PyBytes_AS_STRING(filename_bytes), buflen);
1956 buf[buflen-1] = '\0';
1957 Py_DECREF(filename_bytes);
1958 *p_fp = fp;
1959 return fdp;
1960 }
1961 else if (PyErr_Occurred())
1962 return NULL;
1963#endif
1964 Py_DECREF(nameobj);
1965 search_path_list = PySys_GetObject("path");
1966 }
1967
1968 if (search_path_list == NULL || !PyList_Check(search_path_list)) {
1969 PyErr_SetString(PyExc_ImportError,
1970 "sys.path must be a list of directory names");
1971 return NULL;
1972 }
1973
1974 path_hooks = PySys_GetObject("path_hooks");
1975 if (path_hooks == NULL || !PyList_Check(path_hooks)) {
1976 PyErr_SetString(PyExc_ImportError,
1977 "sys.path_hooks must be a list of "
1978 "import hooks");
1979 return NULL;
1980 }
1981 path_importer_cache = PySys_GetObject("path_importer_cache");
1982 if (path_importer_cache == NULL ||
1983 !PyDict_Check(path_importer_cache)) {
1984 PyErr_SetString(PyExc_ImportError,
1985 "sys.path_importer_cache must be a dict");
1986 return NULL;
1987 }
1988
1989 return find_module_path_list(fullname, name,
1990 search_path_list, path_hooks,
1991 path_importer_cache,
1992 buf, buflen,
1993 p_fp, p_loader);
1994}
1995
Martin v. Löwis18e16552006-02-15 17:27:45 +00001996/* case_ok(char* buf, Py_ssize_t len, Py_ssize_t namelen, char* name)
Tim Petersd1e87a82001-03-01 18:12:00 +00001997 * The arguments here are tricky, best shown by example:
1998 * /a/b/c/d/e/f/g/h/i/j/k/some_long_module_name.py\0
1999 * ^ ^ ^ ^
2000 * |--------------------- buf ---------------------|
2001 * |------------------- len ------------------|
2002 * |------ name -------|
2003 * |----- namelen -----|
2004 * buf is the full path, but len only counts up to (& exclusive of) the
2005 * extension. name is the module name, also exclusive of extension.
2006 *
2007 * We've already done a successful stat() or fopen() on buf, so know that
2008 * there's some match, possibly case-insensitive.
2009 *
Tim Peters50d8d372001-02-28 05:34:27 +00002010 * case_ok() is to return 1 if there's a case-sensitive match for
2011 * name, else 0. case_ok() is also to return 1 if envar PYTHONCASEOK
2012 * exists.
Tim Petersd1e87a82001-03-01 18:12:00 +00002013 *
Tim Peters50d8d372001-02-28 05:34:27 +00002014 * case_ok() is used to implement case-sensitive import semantics even
2015 * on platforms with case-insensitive filesystems. It's trivial to implement
2016 * for case-sensitive filesystems. It's pretty much a cross-platform
2017 * nightmare for systems with case-insensitive filesystems.
2018 */
Guido van Rossum0980bd91998-02-13 17:18:36 +00002019
Tim Peters50d8d372001-02-28 05:34:27 +00002020/* First we may need a pile of platform-specific header files; the sequence
2021 * of #if's here should match the sequence in the body of case_ok().
2022 */
Jason Tishler7961aa62005-05-20 00:56:54 +00002023#if defined(MS_WINDOWS)
Guido van Rossum0980bd91998-02-13 17:18:36 +00002024#include <windows.h>
Guido van Rossum4c3f57c2001-01-10 20:40:46 +00002025
Tim Peters50d8d372001-02-28 05:34:27 +00002026#elif defined(DJGPP)
2027#include <dir.h>
2028
Jason Tishler7961aa62005-05-20 00:56:54 +00002029#elif (defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) && defined(HAVE_DIRENT_H)
Tim Peters430f5d42001-03-01 01:30:56 +00002030#include <sys/types.h>
2031#include <dirent.h>
2032
Andrew MacIntyred9400542002-02-26 11:41:34 +00002033#elif defined(PYOS_OS2)
2034#define INCL_DOS
2035#define INCL_DOSERRORS
2036#define INCL_NOPMAPI
2037#include <os2.h>
Tim Peters50d8d372001-02-28 05:34:27 +00002038#endif
2039
Guido van Rossum0980bd91998-02-13 17:18:36 +00002040static int
Victor Stinnerc6963162011-03-12 09:26:54 -05002041case_ok(char *buf, Py_ssize_t len, Py_ssize_t namelen, const char *name)
Guido van Rossum0980bd91998-02-13 17:18:36 +00002042{
Tim Peters50d8d372001-02-28 05:34:27 +00002043/* Pick a platform-specific implementation; the sequence of #if's here should
2044 * match the sequence just above.
2045 */
2046
Jason Tishler7961aa62005-05-20 00:56:54 +00002047/* MS_WINDOWS */
2048#if defined(MS_WINDOWS)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002049 WIN32_FIND_DATA data;
2050 HANDLE h;
Tim Peters50d8d372001-02-28 05:34:27 +00002051
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002052 if (Py_GETENV("PYTHONCASEOK") != NULL)
2053 return 1;
Tim Peters50d8d372001-02-28 05:34:27 +00002054
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002055 h = FindFirstFile(buf, &data);
2056 if (h == INVALID_HANDLE_VALUE) {
2057 PyErr_Format(PyExc_NameError,
2058 "Can't find file for module %.100s\n(filename %.300s)",
2059 name, buf);
2060 return 0;
2061 }
2062 FindClose(h);
2063 return strncmp(data.cFileName, name, namelen) == 0;
Tim Peters50d8d372001-02-28 05:34:27 +00002064
2065/* DJGPP */
2066#elif defined(DJGPP)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002067 struct ffblk ffblk;
2068 int done;
Tim Peters50d8d372001-02-28 05:34:27 +00002069
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002070 if (Py_GETENV("PYTHONCASEOK") != NULL)
2071 return 1;
Tim Peters50d8d372001-02-28 05:34:27 +00002072
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002073 done = findfirst(buf, &ffblk, FA_ARCH|FA_RDONLY|FA_HIDDEN|FA_DIREC);
2074 if (done) {
2075 PyErr_Format(PyExc_NameError,
2076 "Can't find file for module %.100s\n(filename %.300s)",
2077 name, buf);
2078 return 0;
2079 }
2080 return strncmp(ffblk.ff_name, name, namelen) == 0;
Guido van Rossum0980bd91998-02-13 17:18:36 +00002081
Jason Tishler7961aa62005-05-20 00:56:54 +00002082/* new-fangled macintosh (macosx) or Cygwin */
2083#elif (defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) && defined(HAVE_DIRENT_H)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002084 DIR *dirp;
2085 struct dirent *dp;
2086 char dirname[MAXPATHLEN + 1];
2087 const int dirlen = len - namelen - 1; /* don't want trailing SEP */
Tim Peters430f5d42001-03-01 01:30:56 +00002088
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002089 if (Py_GETENV("PYTHONCASEOK") != NULL)
2090 return 1;
Tim Petersdbe6ebb2001-03-01 08:47:29 +00002091
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002092 /* Copy the dir component into dirname; substitute "." if empty */
2093 if (dirlen <= 0) {
2094 dirname[0] = '.';
2095 dirname[1] = '\0';
2096 }
2097 else {
2098 assert(dirlen <= MAXPATHLEN);
2099 memcpy(dirname, buf, dirlen);
2100 dirname[dirlen] = '\0';
2101 }
2102 /* Open the directory and search the entries for an exact match. */
2103 dirp = opendir(dirname);
2104 if (dirp) {
2105 char *nameWithExt = buf + len - namelen;
2106 while ((dp = readdir(dirp)) != NULL) {
2107 const int thislen =
Tim Peters430f5d42001-03-01 01:30:56 +00002108#ifdef _DIRENT_HAVE_D_NAMELEN
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002109 dp->d_namlen;
Tim Peters430f5d42001-03-01 01:30:56 +00002110#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002111 strlen(dp->d_name);
Tim Peters430f5d42001-03-01 01:30:56 +00002112#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002113 if (thislen >= namelen &&
2114 strcmp(dp->d_name, nameWithExt) == 0) {
2115 (void)closedir(dirp);
2116 return 1; /* Found */
2117 }
2118 }
2119 (void)closedir(dirp);
2120 }
2121 return 0 ; /* Not found */
Tim Peters430f5d42001-03-01 01:30:56 +00002122
Andrew MacIntyred9400542002-02-26 11:41:34 +00002123/* OS/2 */
2124#elif defined(PYOS_OS2)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002125 HDIR hdir = 1;
2126 ULONG srchcnt = 1;
2127 FILEFINDBUF3 ffbuf;
2128 APIRET rc;
Andrew MacIntyred9400542002-02-26 11:41:34 +00002129
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002130 if (Py_GETENV("PYTHONCASEOK") != NULL)
2131 return 1;
Andrew MacIntyred9400542002-02-26 11:41:34 +00002132
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002133 rc = DosFindFirst(buf,
2134 &hdir,
2135 FILE_READONLY | FILE_HIDDEN | FILE_SYSTEM | FILE_DIRECTORY,
2136 &ffbuf, sizeof(ffbuf),
2137 &srchcnt,
2138 FIL_STANDARD);
2139 if (rc != NO_ERROR)
2140 return 0;
2141 return strncmp(ffbuf.achName, name, namelen) == 0;
Andrew MacIntyred9400542002-02-26 11:41:34 +00002142
Tim Peters50d8d372001-02-28 05:34:27 +00002143/* assuming it's a case-sensitive filesystem, so there's nothing to do! */
2144#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002145 return 1;
Guido van Rossum0980bd91998-02-13 17:18:36 +00002146
Guido van Rossum4d1b3b91998-02-13 23:27:59 +00002147#endif
Tim Peters50d8d372001-02-28 05:34:27 +00002148}
Guido van Rossum4d1b3b91998-02-13 23:27:59 +00002149
Guido van Rossum197346f1997-10-31 18:38:52 +00002150#ifdef HAVE_STAT
Victor Stinner4f4402c2010-08-14 14:50:26 +00002151
Guido van Rossum197346f1997-10-31 18:38:52 +00002152/* Helper to look for __init__.py or __init__.py[co] in potential package */
2153static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002154find_init_module(char *buf)
Guido van Rossum197346f1997-10-31 18:38:52 +00002155{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002156 const size_t save_len = strlen(buf);
2157 size_t i = save_len;
2158 char *pname; /* pointer to start of __init__ */
2159 struct stat statbuf;
Guido van Rossum197346f1997-10-31 18:38:52 +00002160
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002161/* For calling case_ok(buf, len, namelen, name):
2162 * /a/b/c/d/e/f/g/h/i/j/k/some_long_module_name.py\0
2163 * ^ ^ ^ ^
2164 * |--------------------- buf ---------------------|
2165 * |------------------- len ------------------|
2166 * |------ name -------|
2167 * |----- namelen -----|
Tim Peters0f9431f2001-07-05 03:47:53 +00002168 */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002169 if (save_len + 13 >= MAXPATHLEN)
2170 return 0;
2171 buf[i++] = SEP;
2172 pname = buf + i;
2173 strcpy(pname, "__init__.py");
2174 if (stat(buf, &statbuf) == 0) {
2175 if (case_ok(buf,
2176 save_len + 9, /* len("/__init__") */
2177 8, /* len("__init__") */
2178 pname)) {
2179 buf[save_len] = '\0';
2180 return 1;
2181 }
2182 }
2183 i += strlen(pname);
2184 strcpy(buf+i, Py_OptimizeFlag ? "o" : "c");
2185 if (stat(buf, &statbuf) == 0) {
2186 if (case_ok(buf,
2187 save_len + 9, /* len("/__init__") */
2188 8, /* len("__init__") */
2189 pname)) {
2190 buf[save_len] = '\0';
2191 return 1;
2192 }
2193 }
2194 buf[save_len] = '\0';
2195 return 0;
Guido van Rossum197346f1997-10-31 18:38:52 +00002196}
Guido van Rossum48a680c2001-03-02 06:34:14 +00002197
Guido van Rossum197346f1997-10-31 18:38:52 +00002198#endif /* HAVE_STAT */
2199
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002200
Victor Stinner95872862011-03-07 18:20:56 +01002201static int init_builtin(PyObject *); /* Forward */
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002202
Victor Stinner44c6c152010-08-09 00:59:10 +00002203static PyObject*
Victor Stinner95872862011-03-07 18:20:56 +01002204load_builtin(PyObject *name, int type)
Victor Stinner44c6c152010-08-09 00:59:10 +00002205{
2206 PyObject *m, *modules;
2207 int err;
2208
Victor Stinner44c6c152010-08-09 00:59:10 +00002209 if (type == C_BUILTIN)
2210 err = init_builtin(name);
2211 else
Victor Stinner95872862011-03-07 18:20:56 +01002212 err = PyImport_ImportFrozenModuleObject(name);
Victor Stinner44c6c152010-08-09 00:59:10 +00002213 if (err < 0)
2214 return NULL;
2215 if (err == 0) {
2216 PyErr_Format(PyExc_ImportError,
Victor Stinner95872862011-03-07 18:20:56 +01002217 "Purported %s module %R not found",
2218 type == C_BUILTIN ? "builtin" : "frozen",
Victor Stinner44c6c152010-08-09 00:59:10 +00002219 name);
2220 return NULL;
2221 }
2222
2223 modules = PyImport_GetModuleDict();
Victor Stinner95872862011-03-07 18:20:56 +01002224 m = PyDict_GetItem(modules, name);
Victor Stinner44c6c152010-08-09 00:59:10 +00002225 if (m == NULL) {
2226 PyErr_Format(
2227 PyExc_ImportError,
Victor Stinner95872862011-03-07 18:20:56 +01002228 "%s module %R not properly initialized",
2229 type == C_BUILTIN ? "builtin" : "frozen",
Victor Stinner44c6c152010-08-09 00:59:10 +00002230 name);
2231 return NULL;
2232 }
2233 Py_INCREF(m);
2234 return m;
2235}
2236
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002237/* Load an external module using the default search path and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00002238 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002239
Guido van Rossum79f25d91997-04-29 20:08:16 +00002240static PyObject *
Alexandre Vassalottie223eb82009-07-29 20:12:15 +00002241load_module(char *name, FILE *fp, char *pathname, int type, PyObject *loader)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002242{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002243 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002244
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002245 /* First check that there's an open file (if we need one) */
2246 switch (type) {
2247 case PY_SOURCE:
2248 case PY_COMPILED:
2249 if (fp == NULL) {
2250 PyErr_Format(PyExc_ValueError,
2251 "file object required for import (type code %d)",
2252 type);
2253 return NULL;
2254 }
2255 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002256
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002257 switch (type) {
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002258
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002259 case PY_SOURCE:
2260 m = load_source_module(name, pathname, fp);
2261 break;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002262
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002263 case PY_COMPILED:
2264 m = load_compiled_module(name, pathname, fp);
2265 break;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002266
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002267#ifdef HAVE_DYNAMIC_LOADING
Victor Stinnerfefd70c2011-03-14 15:54:07 -04002268 case C_EXTENSION: {
2269 PyObject *nameobj, *pathobj;
2270 nameobj = PyUnicode_FromString(name);
2271 if (nameobj == NULL)
2272 return NULL;
2273 pathobj = PyUnicode_DecodeFSDefault(pathname);
2274 if (pathobj == NULL) {
2275 Py_DECREF(nameobj);
2276 return NULL;
2277 }
2278 m = _PyImport_LoadDynamicModule(nameobj, pathobj, fp);
2279 Py_DECREF(nameobj);
2280 Py_DECREF(pathobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002281 break;
Victor Stinnerfefd70c2011-03-14 15:54:07 -04002282 }
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002283#endif
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002284
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002285 case PKG_DIRECTORY:
2286 m = load_package(name, pathname);
2287 break;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002288
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002289 case C_BUILTIN:
Victor Stinner95872862011-03-07 18:20:56 +01002290 case PY_FROZEN: {
2291 PyObject *nameobj = PyUnicode_FromString(name);
Victor Stinnerfefd70c2011-03-14 15:54:07 -04002292 if (nameobj == NULL)
2293 return NULL;
2294 m = load_builtin(nameobj, type);
2295 Py_DECREF(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002296 break;
Victor Stinner95872862011-03-07 18:20:56 +01002297 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002298
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002299 case IMP_HOOK: {
2300 if (loader == NULL) {
2301 PyErr_SetString(PyExc_ImportError,
2302 "import hook without loader");
2303 return NULL;
2304 }
2305 m = PyObject_CallMethod(loader, "load_module", "s", name);
2306 break;
2307 }
Just van Rossum52e14d62002-12-30 22:08:05 +00002308
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002309 default:
2310 PyErr_Format(PyExc_ImportError,
2311 "Don't know how to import %.200s (type code %d)",
2312 name, type);
2313 m = NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002314
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002315 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002316
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002317 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002318}
2319
2320
2321/* Initialize a built-in module.
Thomas Wouters89f507f2006-12-13 04:49:30 +00002322 Return 1 for success, 0 if the module is not found, and -1 with
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002323 an exception set if the initialization failed. */
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002324
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002325static int
Victor Stinner95872862011-03-07 18:20:56 +01002326init_builtin(PyObject *name)
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002327{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002328 struct _inittab *p;
Guido van Rossum25ce5661997-08-02 03:10:38 +00002329
Victor Stinner95872862011-03-07 18:20:56 +01002330 if (_PyImport_FindExtensionObject(name, name) != NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002331 return 1;
Guido van Rossum25ce5661997-08-02 03:10:38 +00002332
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002333 for (p = PyImport_Inittab; p->name != NULL; p++) {
2334 PyObject *mod;
Victor Stinner95872862011-03-07 18:20:56 +01002335 if (PyUnicode_CompareWithASCIIString(name, p->name) == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002336 if (p->initfunc == NULL) {
2337 PyErr_Format(PyExc_ImportError,
Victor Stinner95872862011-03-07 18:20:56 +01002338 "Cannot re-init internal module %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002339 name);
2340 return -1;
2341 }
2342 if (Py_VerboseFlag)
Victor Stinner95872862011-03-07 18:20:56 +01002343 PySys_FormatStderr("import %U # builtin\n", name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002344 mod = (*p->initfunc)();
2345 if (mod == 0)
2346 return -1;
Victor Stinner95872862011-03-07 18:20:56 +01002347 if (_PyImport_FixupExtensionObject(mod, name, name) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002348 return -1;
2349 /* FixupExtension has put the module into sys.modules,
2350 so we can release our own reference. */
2351 Py_DECREF(mod);
2352 return 1;
2353 }
2354 }
2355 return 0;
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002356}
Guido van Rossumf56e3db1993-04-01 20:59:32 +00002357
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002358
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002359/* Frozen modules */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002360
Guido van Rossumcfd0a221996-06-17 17:06:34 +00002361static struct _frozen *
Victor Stinner53dc7352011-03-20 01:50:21 +01002362find_frozen(PyObject *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002363{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002364 struct _frozen *p;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002365
Victor Stinner53dc7352011-03-20 01:50:21 +01002366 if (name == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002367 return NULL;
Benjamin Petersond968e272008-11-05 22:48:33 +00002368
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002369 for (p = PyImport_FrozenModules; ; p++) {
2370 if (p->name == NULL)
2371 return NULL;
Victor Stinner53dc7352011-03-20 01:50:21 +01002372 if (PyUnicode_CompareWithASCIIString(name, p->name) == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002373 break;
2374 }
2375 return p;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002376}
2377
Guido van Rossum79f25d91997-04-29 20:08:16 +00002378static PyObject *
Victor Stinner53dc7352011-03-20 01:50:21 +01002379get_frozen_object(PyObject *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002380{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002381 struct _frozen *p = find_frozen(name);
2382 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002383
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002384 if (p == NULL) {
2385 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002386 "No such frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002387 name);
2388 return NULL;
2389 }
2390 if (p->code == NULL) {
2391 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002392 "Excluded frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002393 name);
2394 return NULL;
2395 }
2396 size = p->size;
2397 if (size < 0)
2398 size = -size;
2399 return PyMarshal_ReadObjectFromString((char *)p->code, size);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002400}
2401
Brett Cannon8d110132009-03-15 02:20:16 +00002402static PyObject *
Victor Stinner53dc7352011-03-20 01:50:21 +01002403is_frozen_package(PyObject *name)
Brett Cannon8d110132009-03-15 02:20:16 +00002404{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002405 struct _frozen *p = find_frozen(name);
2406 int size;
Brett Cannon8d110132009-03-15 02:20:16 +00002407
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002408 if (p == NULL) {
2409 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002410 "No such frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002411 name);
2412 return NULL;
2413 }
Brett Cannon8d110132009-03-15 02:20:16 +00002414
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002415 size = p->size;
Brett Cannon8d110132009-03-15 02:20:16 +00002416
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002417 if (size < 0)
2418 Py_RETURN_TRUE;
2419 else
2420 Py_RETURN_FALSE;
Brett Cannon8d110132009-03-15 02:20:16 +00002421}
2422
2423
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002424/* Initialize a frozen module.
Brett Cannon3c2ac442009-03-08 20:49:47 +00002425 Return 1 for success, 0 if the module is not found, and -1 with
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002426 an exception set if the initialization failed.
2427 This function is also used from frozenmain.c */
Guido van Rossum0b344901995-02-07 15:35:27 +00002428
2429int
Victor Stinner53dc7352011-03-20 01:50:21 +01002430PyImport_ImportFrozenModuleObject(PyObject *name)
Guido van Rossumf56e3db1993-04-01 20:59:32 +00002431{
Victor Stinner53dc7352011-03-20 01:50:21 +01002432 struct _frozen *p;
2433 PyObject *co, *m, *path;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002434 int ispackage;
2435 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002436
Victor Stinner53dc7352011-03-20 01:50:21 +01002437 p = find_frozen(name);
2438
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002439 if (p == NULL)
2440 return 0;
2441 if (p->code == NULL) {
2442 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002443 "Excluded frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002444 name);
2445 return -1;
2446 }
2447 size = p->size;
2448 ispackage = (size < 0);
2449 if (ispackage)
2450 size = -size;
2451 if (Py_VerboseFlag)
Victor Stinner53dc7352011-03-20 01:50:21 +01002452 PySys_FormatStderr("import %U # frozen%s\n",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002453 name, ispackage ? " package" : "");
2454 co = PyMarshal_ReadObjectFromString((char *)p->code, size);
2455 if (co == NULL)
2456 return -1;
2457 if (!PyCode_Check(co)) {
2458 PyErr_Format(PyExc_TypeError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002459 "frozen object %R is not a code object",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002460 name);
2461 goto err_return;
2462 }
2463 if (ispackage) {
2464 /* Set __path__ to the package name */
Victor Stinner53dc7352011-03-20 01:50:21 +01002465 PyObject *d, *l;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002466 int err;
Victor Stinner53dc7352011-03-20 01:50:21 +01002467 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002468 if (m == NULL)
2469 goto err_return;
2470 d = PyModule_GetDict(m);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002471 l = PyList_New(1);
2472 if (l == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002473 goto err_return;
2474 }
Victor Stinner53dc7352011-03-20 01:50:21 +01002475 Py_INCREF(name);
2476 PyList_SET_ITEM(l, 0, name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002477 err = PyDict_SetItemString(d, "__path__", l);
2478 Py_DECREF(l);
2479 if (err != 0)
2480 goto err_return;
2481 }
Victor Stinner53dc7352011-03-20 01:50:21 +01002482 path = PyUnicode_FromString("<frozen>");
2483 if (path == NULL)
2484 goto err_return;
2485 m = PyImport_ExecCodeModuleObject(name, co, path, NULL);
2486 Py_DECREF(path);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002487 if (m == NULL)
2488 goto err_return;
2489 Py_DECREF(co);
2490 Py_DECREF(m);
2491 return 1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002492err_return:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002493 Py_DECREF(co);
2494 return -1;
Guido van Rossumf56e3db1993-04-01 20:59:32 +00002495}
Guido van Rossum74e6a111994-08-29 12:54:38 +00002496
Victor Stinner53dc7352011-03-20 01:50:21 +01002497int
2498PyImport_ImportFrozenModule(char *name)
2499{
2500 PyObject *nameobj;
2501 int ret;
2502 nameobj = PyUnicode_InternFromString(name);
2503 if (nameobj == NULL)
2504 return -1;
2505 ret = PyImport_ImportFrozenModuleObject(nameobj);
2506 Py_DECREF(nameobj);
2507 return ret;
2508}
2509
Guido van Rossum74e6a111994-08-29 12:54:38 +00002510
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002511/* Import a module, either built-in, frozen, or external, and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00002512 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum74e6a111994-08-29 12:54:38 +00002513
Guido van Rossum79f25d91997-04-29 20:08:16 +00002514PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00002515PyImport_ImportModule(const char *name)
Guido van Rossum74e6a111994-08-29 12:54:38 +00002516{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002517 PyObject *pname;
2518 PyObject *result;
Marc-André Lemburg3c61c352001-02-09 19:40:15 +00002519
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002520 pname = PyUnicode_FromString(name);
2521 if (pname == NULL)
2522 return NULL;
2523 result = PyImport_Import(pname);
2524 Py_DECREF(pname);
2525 return result;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002526}
2527
Christian Heimes072c0f12008-01-03 23:01:04 +00002528/* Import a module without blocking
2529 *
2530 * At first it tries to fetch the module from sys.modules. If the module was
2531 * never loaded before it loads it with PyImport_ImportModule() unless another
2532 * thread holds the import lock. In the latter case the function raises an
2533 * ImportError instead of blocking.
2534 *
2535 * Returns the module object with incremented ref count.
2536 */
2537PyObject *
2538PyImport_ImportModuleNoBlock(const char *name)
2539{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002540 PyObject *result;
2541 PyObject *modules;
2542 long me;
Christian Heimes072c0f12008-01-03 23:01:04 +00002543
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002544 /* Try to get the module from sys.modules[name] */
2545 modules = PyImport_GetModuleDict();
2546 if (modules == NULL)
2547 return NULL;
Christian Heimes072c0f12008-01-03 23:01:04 +00002548
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002549 result = PyDict_GetItemString(modules, name);
2550 if (result != NULL) {
2551 Py_INCREF(result);
2552 return result;
2553 }
2554 else {
2555 PyErr_Clear();
2556 }
Benjamin Peterson3e4f0552008-09-02 00:31:15 +00002557#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002558 /* check the import lock
2559 * me might be -1 but I ignore the error here, the lock function
2560 * takes care of the problem */
2561 me = PyThread_get_thread_ident();
2562 if (import_lock_thread == -1 || import_lock_thread == me) {
2563 /* no thread or me is holding the lock */
2564 return PyImport_ImportModule(name);
2565 }
2566 else {
2567 PyErr_Format(PyExc_ImportError,
2568 "Failed to import %.200s because the import lock"
2569 "is held by another thread.",
2570 name);
2571 return NULL;
2572 }
Benjamin Peterson3e4f0552008-09-02 00:31:15 +00002573#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002574 return PyImport_ImportModule(name);
Benjamin Peterson3e4f0552008-09-02 00:31:15 +00002575#endif
Christian Heimes072c0f12008-01-03 23:01:04 +00002576}
2577
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002578/* Forward declarations for helper routines */
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002579static PyObject *get_parent(PyObject *globals, char *buf,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002580 Py_ssize_t *p_buflen, int level);
Tim Petersdbd9ba62000-07-09 03:09:57 +00002581static PyObject *load_next(PyObject *mod, PyObject *altmod,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002582 char **p_name, char *buf, Py_ssize_t *p_buflen);
Tim Petersdbd9ba62000-07-09 03:09:57 +00002583static int mark_miss(char *name);
2584static int ensure_fromlist(PyObject *mod, PyObject *fromlist,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002585 char *buf, Py_ssize_t buflen, int recursive);
Tim Petersdbd9ba62000-07-09 03:09:57 +00002586static PyObject * import_submodule(PyObject *mod, char *name, char *fullname);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002587
2588/* The Magnum Opus of dotted-name import :-) */
2589
Guido van Rossum75acc9c1998-03-03 22:26:50 +00002590static PyObject *
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002591import_module_level(char *name, PyObject *globals, PyObject *locals,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002592 PyObject *fromlist, int level)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002593{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002594 char buf[MAXPATHLEN+1];
2595 Py_ssize_t buflen = 0;
2596 PyObject *parent, *head, *next, *tail;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002597
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002598 if (strchr(name, '/') != NULL
Christian Heimes454f37b2008-01-10 00:10:02 +00002599#ifdef MS_WINDOWS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002600 || strchr(name, '\\') != NULL
Christian Heimes454f37b2008-01-10 00:10:02 +00002601#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002602 ) {
2603 PyErr_SetString(PyExc_ImportError,
2604 "Import by filename is not supported.");
2605 return NULL;
2606 }
Christian Heimes454f37b2008-01-10 00:10:02 +00002607
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002608 parent = get_parent(globals, buf, &buflen, level);
2609 if (parent == NULL)
2610 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002611
Benjamin Peterson556d8002010-06-27 22:37:28 +00002612 head = load_next(parent, level < 0 ? Py_None : parent, &name, buf,
2613 &buflen);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002614 if (head == NULL)
2615 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002616
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002617 tail = head;
2618 Py_INCREF(tail);
2619 while (name) {
2620 next = load_next(tail, tail, &name, buf, &buflen);
2621 Py_DECREF(tail);
2622 if (next == NULL) {
2623 Py_DECREF(head);
2624 return NULL;
2625 }
2626 tail = next;
2627 }
2628 if (tail == Py_None) {
2629 /* If tail is Py_None, both get_parent and load_next found
2630 an empty module name: someone called __import__("") or
2631 doctored faulty bytecode */
2632 Py_DECREF(tail);
2633 Py_DECREF(head);
2634 PyErr_SetString(PyExc_ValueError,
2635 "Empty module name");
2636 return NULL;
2637 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002638
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002639 if (fromlist != NULL) {
2640 if (fromlist == Py_None || !PyObject_IsTrue(fromlist))
2641 fromlist = NULL;
2642 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002643
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002644 if (fromlist == NULL) {
2645 Py_DECREF(tail);
2646 return head;
2647 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002648
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002649 Py_DECREF(head);
2650 if (!ensure_fromlist(tail, fromlist, buf, buflen, 0)) {
2651 Py_DECREF(tail);
2652 return NULL;
2653 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002654
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002655 return tail;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002656}
2657
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002658PyObject *
2659PyImport_ImportModuleLevel(char *name, PyObject *globals, PyObject *locals,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002660 PyObject *fromlist, int level)
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002661{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002662 PyObject *result;
2663 _PyImport_AcquireLock();
2664 result = import_module_level(name, globals, locals, fromlist, level);
2665 if (_PyImport_ReleaseLock() < 0) {
2666 Py_XDECREF(result);
2667 PyErr_SetString(PyExc_RuntimeError,
2668 "not holding the import lock");
2669 return NULL;
2670 }
2671 return result;
Guido van Rossum75acc9c1998-03-03 22:26:50 +00002672}
2673
Fred Drake87590902004-05-28 20:21:36 +00002674/* Return the package that an import is being performed in. If globals comes
2675 from the module foo.bar.bat (not itself a package), this returns the
2676 sys.modules entry for foo.bar. If globals is from a package's __init__.py,
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00002677 the package's entry in sys.modules is returned, as a borrowed reference.
Fred Drake87590902004-05-28 20:21:36 +00002678
2679 The *name* of the returned package is returned in buf, with the length of
2680 the name in *p_buflen.
2681
2682 If globals doesn't come from a package or a module in a package, or a
2683 corresponding entry is not found in sys.modules, Py_None is returned.
2684*/
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002685static PyObject *
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002686get_parent(PyObject *globals, char *buf, Py_ssize_t *p_buflen, int level)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002687{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002688 static PyObject *namestr = NULL;
2689 static PyObject *pathstr = NULL;
2690 static PyObject *pkgstr = NULL;
2691 PyObject *pkgname, *modname, *modpath, *modules, *parent;
2692 int orig_level = level;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002693
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002694 if (globals == NULL || !PyDict_Check(globals) || !level)
2695 return Py_None;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002696
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002697 if (namestr == NULL) {
2698 namestr = PyUnicode_InternFromString("__name__");
2699 if (namestr == NULL)
2700 return NULL;
2701 }
2702 if (pathstr == NULL) {
2703 pathstr = PyUnicode_InternFromString("__path__");
2704 if (pathstr == NULL)
2705 return NULL;
2706 }
2707 if (pkgstr == NULL) {
2708 pkgstr = PyUnicode_InternFromString("__package__");
2709 if (pkgstr == NULL)
2710 return NULL;
2711 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002712
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002713 *buf = '\0';
2714 *p_buflen = 0;
2715 pkgname = PyDict_GetItem(globals, pkgstr);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002716
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002717 if ((pkgname != NULL) && (pkgname != Py_None)) {
2718 /* __package__ is set, so use it */
2719 char *pkgname_str;
2720 Py_ssize_t len;
Alexandre Vassalottia85998a2008-05-03 18:24:43 +00002721
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002722 if (!PyUnicode_Check(pkgname)) {
2723 PyErr_SetString(PyExc_ValueError,
2724 "__package__ set to non-string");
2725 return NULL;
2726 }
2727 pkgname_str = _PyUnicode_AsStringAndSize(pkgname, &len);
2728 if (len == 0) {
2729 if (level > 0) {
2730 PyErr_SetString(PyExc_ValueError,
2731 "Attempted relative import in non-package");
2732 return NULL;
2733 }
2734 return Py_None;
2735 }
2736 if (len > MAXPATHLEN) {
2737 PyErr_SetString(PyExc_ValueError,
2738 "Package name too long");
2739 return NULL;
2740 }
2741 strcpy(buf, pkgname_str);
2742 } else {
2743 /* __package__ not set, so figure it out and set it */
2744 modname = PyDict_GetItem(globals, namestr);
2745 if (modname == NULL || !PyUnicode_Check(modname))
2746 return Py_None;
Brett Cannon9a5b25a2010-03-01 02:09:17 +00002747
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002748 modpath = PyDict_GetItem(globals, pathstr);
2749 if (modpath != NULL) {
2750 /* __path__ is set, so modname is already the package name */
2751 char *modname_str;
2752 Py_ssize_t len;
2753 int error;
Alexandre Vassalottia85998a2008-05-03 18:24:43 +00002754
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002755 modname_str = _PyUnicode_AsStringAndSize(modname, &len);
2756 if (len > MAXPATHLEN) {
2757 PyErr_SetString(PyExc_ValueError,
2758 "Module name too long");
2759 return NULL;
2760 }
2761 strcpy(buf, modname_str);
2762 error = PyDict_SetItem(globals, pkgstr, modname);
2763 if (error) {
2764 PyErr_SetString(PyExc_ValueError,
2765 "Could not set __package__");
2766 return NULL;
2767 }
2768 } else {
2769 /* Normal module, so work out the package name if any */
2770 char *start = _PyUnicode_AsString(modname);
2771 char *lastdot = strrchr(start, '.');
2772 size_t len;
2773 int error;
2774 if (lastdot == NULL && level > 0) {
2775 PyErr_SetString(PyExc_ValueError,
2776 "Attempted relative import in non-package");
2777 return NULL;
2778 }
2779 if (lastdot == NULL) {
2780 error = PyDict_SetItem(globals, pkgstr, Py_None);
2781 if (error) {
2782 PyErr_SetString(PyExc_ValueError,
2783 "Could not set __package__");
2784 return NULL;
2785 }
2786 return Py_None;
2787 }
2788 len = lastdot - start;
2789 if (len >= MAXPATHLEN) {
2790 PyErr_SetString(PyExc_ValueError,
2791 "Module name too long");
2792 return NULL;
2793 }
2794 strncpy(buf, start, len);
2795 buf[len] = '\0';
2796 pkgname = PyUnicode_FromString(buf);
2797 if (pkgname == NULL) {
2798 return NULL;
2799 }
2800 error = PyDict_SetItem(globals, pkgstr, pkgname);
2801 Py_DECREF(pkgname);
2802 if (error) {
2803 PyErr_SetString(PyExc_ValueError,
2804 "Could not set __package__");
2805 return NULL;
2806 }
2807 }
2808 }
2809 while (--level > 0) {
2810 char *dot = strrchr(buf, '.');
2811 if (dot == NULL) {
2812 PyErr_SetString(PyExc_ValueError,
2813 "Attempted relative import beyond "
2814 "toplevel package");
2815 return NULL;
2816 }
2817 *dot = '\0';
2818 }
2819 *p_buflen = strlen(buf);
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002820
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002821 modules = PyImport_GetModuleDict();
2822 parent = PyDict_GetItemString(modules, buf);
2823 if (parent == NULL) {
2824 if (orig_level < 1) {
2825 PyObject *err_msg = PyBytes_FromFormat(
2826 "Parent module '%.200s' not found "
2827 "while handling absolute import", buf);
2828 if (err_msg == NULL) {
2829 return NULL;
2830 }
2831 if (!PyErr_WarnEx(PyExc_RuntimeWarning,
2832 PyBytes_AsString(err_msg), 1)) {
2833 *buf = '\0';
2834 *p_buflen = 0;
2835 parent = Py_None;
2836 }
2837 Py_DECREF(err_msg);
2838 } else {
2839 PyErr_Format(PyExc_SystemError,
2840 "Parent module '%.200s' not loaded, "
2841 "cannot perform relative import", buf);
2842 }
2843 }
2844 return parent;
2845 /* We expect, but can't guarantee, if parent != None, that:
2846 - parent.__name__ == buf
2847 - parent.__dict__ is globals
2848 If this is violated... Who cares? */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002849}
2850
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002851/* altmod is either None or same as mod */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002852static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002853load_next(PyObject *mod, PyObject *altmod, char **p_name, char *buf,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002854 Py_ssize_t *p_buflen)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002855{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002856 char *name = *p_name;
2857 char *dot = strchr(name, '.');
2858 size_t len;
2859 char *p;
2860 PyObject *result;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002861
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002862 if (strlen(name) == 0) {
2863 /* completely empty module name should only happen in
2864 'from . import' (or '__import__("")')*/
2865 Py_INCREF(mod);
2866 *p_name = NULL;
2867 return mod;
2868 }
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002869
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002870 if (dot == NULL) {
2871 *p_name = NULL;
2872 len = strlen(name);
2873 }
2874 else {
2875 *p_name = dot+1;
2876 len = dot-name;
2877 }
2878 if (len == 0) {
2879 PyErr_SetString(PyExc_ValueError,
2880 "Empty module name");
2881 return NULL;
2882 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002883
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002884 p = buf + *p_buflen;
2885 if (p != buf)
2886 *p++ = '.';
2887 if (p+len-buf >= MAXPATHLEN) {
2888 PyErr_SetString(PyExc_ValueError,
2889 "Module name too long");
2890 return NULL;
2891 }
2892 strncpy(p, name, len);
2893 p[len] = '\0';
2894 *p_buflen = p+len-buf;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002895
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002896 result = import_submodule(mod, p, buf);
2897 if (result == Py_None && altmod != mod) {
2898 Py_DECREF(result);
2899 /* Here, altmod must be None and mod must not be None */
2900 result = import_submodule(altmod, p, p);
2901 if (result != NULL && result != Py_None) {
2902 if (mark_miss(buf) != 0) {
2903 Py_DECREF(result);
2904 return NULL;
2905 }
2906 strncpy(buf, name, len);
2907 buf[len] = '\0';
2908 *p_buflen = len;
2909 }
2910 }
2911 if (result == NULL)
2912 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002913
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002914 if (result == Py_None) {
2915 Py_DECREF(result);
2916 PyErr_Format(PyExc_ImportError,
2917 "No module named %.200s", name);
2918 return NULL;
2919 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002920
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002921 return result;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002922}
2923
2924static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002925mark_miss(char *name)
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00002926{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002927 PyObject *modules = PyImport_GetModuleDict();
2928 return PyDict_SetItemString(modules, name, Py_None);
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00002929}
2930
2931static int
Martin v. Löwis18e16552006-02-15 17:27:45 +00002932ensure_fromlist(PyObject *mod, PyObject *fromlist, char *buf, Py_ssize_t buflen,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002933 int recursive)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002934{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002935 int i;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002936
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002937 if (!PyObject_HasAttrString(mod, "__path__"))
2938 return 1;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002939
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002940 for (i = 0; ; i++) {
2941 PyObject *item = PySequence_GetItem(fromlist, i);
2942 int hasit;
2943 if (item == NULL) {
2944 if (PyErr_ExceptionMatches(PyExc_IndexError)) {
2945 PyErr_Clear();
2946 return 1;
2947 }
2948 return 0;
2949 }
2950 if (!PyUnicode_Check(item)) {
2951 PyErr_SetString(PyExc_TypeError,
2952 "Item in ``from list'' not a string");
2953 Py_DECREF(item);
2954 return 0;
2955 }
2956 if (PyUnicode_AS_UNICODE(item)[0] == '*') {
2957 PyObject *all;
2958 Py_DECREF(item);
2959 /* See if the package defines __all__ */
2960 if (recursive)
2961 continue; /* Avoid endless recursion */
2962 all = PyObject_GetAttrString(mod, "__all__");
2963 if (all == NULL)
2964 PyErr_Clear();
2965 else {
2966 int ret = ensure_fromlist(mod, all, buf, buflen, 1);
2967 Py_DECREF(all);
2968 if (!ret)
2969 return 0;
2970 }
2971 continue;
2972 }
2973 hasit = PyObject_HasAttr(mod, item);
2974 if (!hasit) {
2975 PyObject *item8;
2976 char *subname;
2977 PyObject *submod;
2978 char *p;
Victor Stinnerae6265f2010-05-15 16:27:27 +00002979 item8 = PyUnicode_EncodeFSDefault(item);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002980 if (!item8) {
2981 PyErr_SetString(PyExc_ValueError, "Cannot encode path item");
2982 return 0;
2983 }
2984 subname = PyBytes_AS_STRING(item8);
2985 if (buflen + strlen(subname) >= MAXPATHLEN) {
2986 PyErr_SetString(PyExc_ValueError,
2987 "Module name too long");
2988 Py_DECREF(item);
2989 return 0;
2990 }
2991 p = buf + buflen;
2992 *p++ = '.';
2993 strcpy(p, subname);
2994 submod = import_submodule(mod, subname, buf);
2995 Py_DECREF(item8);
2996 Py_XDECREF(submod);
2997 if (submod == NULL) {
2998 Py_DECREF(item);
2999 return 0;
3000 }
3001 }
3002 Py_DECREF(item);
3003 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003004
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003005 /* NOTREACHED */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003006}
3007
Neil Schemenauer00b09662003-06-16 21:03:07 +00003008static int
3009add_submodule(PyObject *mod, PyObject *submod, char *fullname, char *subname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003010 PyObject *modules)
Neil Schemenauer00b09662003-06-16 21:03:07 +00003011{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003012 if (mod == Py_None)
3013 return 1;
3014 /* Irrespective of the success of this load, make a
3015 reference to it in the parent package module. A copy gets
3016 saved in the modules dictionary under the full name, so get a
3017 reference from there, if need be. (The exception is when the
3018 load failed with a SyntaxError -- then there's no trace in
3019 sys.modules. In that case, of course, do nothing extra.) */
3020 if (submod == NULL) {
3021 submod = PyDict_GetItemString(modules, fullname);
3022 if (submod == NULL)
3023 return 1;
3024 }
3025 if (PyModule_Check(mod)) {
3026 /* We can't use setattr here since it can give a
3027 * spurious warning if the submodule name shadows a
3028 * builtin name */
3029 PyObject *dict = PyModule_GetDict(mod);
3030 if (!dict)
3031 return 0;
3032 if (PyDict_SetItemString(dict, subname, submod) < 0)
3033 return 0;
3034 }
3035 else {
3036 if (PyObject_SetAttrString(mod, subname, submod) < 0)
3037 return 0;
3038 }
3039 return 1;
Neil Schemenauer00b09662003-06-16 21:03:07 +00003040}
3041
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003042static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003043import_submodule(PyObject *mod, char *subname, char *fullname)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003044{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003045 PyObject *modules = PyImport_GetModuleDict();
3046 PyObject *m = NULL;
Guido van Rossum74e6a111994-08-29 12:54:38 +00003047
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003048 /* Require:
3049 if mod == None: subname == fullname
3050 else: mod.__name__ + "." + subname == fullname
3051 */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003052
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003053 if ((m = PyDict_GetItemString(modules, fullname)) != NULL) {
3054 Py_INCREF(m);
3055 }
3056 else {
Victor Stinner7d8b77c2011-03-12 08:45:02 -05003057 PyObject *path, *loader;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003058 char buf[MAXPATHLEN+1];
3059 struct filedescr *fdp;
Victor Stinner7d8b77c2011-03-12 08:45:02 -05003060 FILE *fp;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003061
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003062 if (mod == Py_None)
3063 path = NULL;
3064 else {
3065 path = PyObject_GetAttrString(mod, "__path__");
3066 if (path == NULL) {
3067 PyErr_Clear();
3068 Py_INCREF(Py_None);
3069 return Py_None;
3070 }
3071 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003072
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003073 fdp = find_module(fullname, subname, path, buf, MAXPATHLEN+1,
3074 &fp, &loader);
3075 Py_XDECREF(path);
3076 if (fdp == NULL) {
3077 if (!PyErr_ExceptionMatches(PyExc_ImportError))
3078 return NULL;
3079 PyErr_Clear();
3080 Py_INCREF(Py_None);
3081 return Py_None;
3082 }
3083 m = load_module(fullname, fp, buf, fdp->type, loader);
3084 Py_XDECREF(loader);
3085 if (fp)
3086 fclose(fp);
3087 if (!add_submodule(mod, m, fullname, subname, modules)) {
3088 Py_XDECREF(m);
3089 m = NULL;
3090 }
3091 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003092
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003093 return m;
Guido van Rossum74e6a111994-08-29 12:54:38 +00003094}
3095
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003096
3097/* Re-import a module of any kind and return its module object, WITH
3098 INCREMENTED REFERENCE COUNT */
3099
Guido van Rossum79f25d91997-04-29 20:08:16 +00003100PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003101PyImport_ReloadModule(PyObject *m)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003102{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003103 PyInterpreterState *interp = PyThreadState_Get()->interp;
3104 PyObject *modules_reloading = interp->modules_reloading;
3105 PyObject *modules = PyImport_GetModuleDict();
Victor Stinner7d8b77c2011-03-12 08:45:02 -05003106 PyObject *path = NULL, *loader, *existing_m = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003107 char *name, *subname;
3108 char buf[MAXPATHLEN+1];
3109 struct filedescr *fdp;
Victor Stinner7d8b77c2011-03-12 08:45:02 -05003110 FILE *fp;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003111 PyObject *newm;
Brett Cannon9a5b25a2010-03-01 02:09:17 +00003112
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003113 if (modules_reloading == NULL) {
3114 Py_FatalError("PyImport_ReloadModule: "
3115 "no modules_reloading dictionary!");
3116 return NULL;
3117 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003118
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003119 if (m == NULL || !PyModule_Check(m)) {
3120 PyErr_SetString(PyExc_TypeError,
3121 "reload() argument must be module");
3122 return NULL;
3123 }
3124 name = (char*)PyModule_GetName(m);
3125 if (name == NULL)
3126 return NULL;
3127 if (m != PyDict_GetItemString(modules, name)) {
3128 PyErr_Format(PyExc_ImportError,
3129 "reload(): module %.200s not in sys.modules",
3130 name);
3131 return NULL;
3132 }
3133 existing_m = PyDict_GetItemString(modules_reloading, name);
3134 if (existing_m != NULL) {
3135 /* Due to a recursive reload, this module is already
3136 being reloaded. */
3137 Py_INCREF(existing_m);
3138 return existing_m;
3139 }
3140 if (PyDict_SetItemString(modules_reloading, name, m) < 0)
3141 return NULL;
Guido van Rossumd8faa362007-04-27 19:54:29 +00003142
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003143 subname = strrchr(name, '.');
3144 if (subname == NULL)
3145 subname = name;
3146 else {
3147 PyObject *parentname, *parent;
3148 parentname = PyUnicode_FromStringAndSize(name, (subname-name));
3149 if (parentname == NULL) {
3150 imp_modules_reloading_clear();
3151 return NULL;
3152 }
3153 parent = PyDict_GetItem(modules, parentname);
3154 if (parent == NULL) {
3155 PyErr_Format(PyExc_ImportError,
3156 "reload(): parent %U not in sys.modules",
3157 parentname);
3158 Py_DECREF(parentname);
3159 imp_modules_reloading_clear();
3160 return NULL;
3161 }
3162 Py_DECREF(parentname);
3163 subname++;
3164 path = PyObject_GetAttrString(parent, "__path__");
3165 if (path == NULL)
3166 PyErr_Clear();
3167 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003168 fdp = find_module(name, subname, path, buf, MAXPATHLEN+1, &fp, &loader);
3169 Py_XDECREF(path);
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00003170
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003171 if (fdp == NULL) {
3172 Py_XDECREF(loader);
3173 imp_modules_reloading_clear();
3174 return NULL;
3175 }
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00003176
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003177 newm = load_module(name, fp, buf, fdp->type, loader);
3178 Py_XDECREF(loader);
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00003179
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003180 if (fp)
3181 fclose(fp);
3182 if (newm == NULL) {
3183 /* load_module probably removed name from modules because of
3184 * the error. Put back the original module object. We're
3185 * going to return NULL in this case regardless of whether
3186 * replacing name succeeds, so the return value is ignored.
3187 */
3188 PyDict_SetItemString(modules, name, m);
3189 }
3190 imp_modules_reloading_clear();
3191 return newm;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003192}
3193
3194
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003195/* Higher-level import emulator which emulates the "import" statement
3196 more accurately -- it invokes the __import__() function from the
3197 builtins of the current globals. This means that the import is
3198 done using whatever import hooks are installed in the current
Brett Cannonbc2eff32010-09-19 21:39:02 +00003199 environment.
Guido van Rossum6058eb41998-12-21 19:51:00 +00003200 A dummy list ["__doc__"] is passed as the 4th argument so that
Neal Norwitz80e7f272007-08-26 06:45:23 +00003201 e.g. PyImport_Import(PyUnicode_FromString("win32com.client.gencache"))
Guido van Rossum6058eb41998-12-21 19:51:00 +00003202 will return <module "gencache"> instead of <module "win32com">. */
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003203
3204PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003205PyImport_Import(PyObject *module_name)
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003206{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003207 static PyObject *silly_list = NULL;
3208 static PyObject *builtins_str = NULL;
3209 static PyObject *import_str = NULL;
3210 PyObject *globals = NULL;
3211 PyObject *import = NULL;
3212 PyObject *builtins = NULL;
Brett Cannonbc2eff32010-09-19 21:39:02 +00003213 PyObject *modules = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003214 PyObject *r = NULL;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003215
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003216 /* Initialize constant string objects */
3217 if (silly_list == NULL) {
3218 import_str = PyUnicode_InternFromString("__import__");
3219 if (import_str == NULL)
3220 return NULL;
3221 builtins_str = PyUnicode_InternFromString("__builtins__");
3222 if (builtins_str == NULL)
3223 return NULL;
Brett Cannonbc2eff32010-09-19 21:39:02 +00003224 silly_list = PyList_New(0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003225 if (silly_list == NULL)
3226 return NULL;
3227 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003228
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003229 /* Get the builtins from current globals */
3230 globals = PyEval_GetGlobals();
3231 if (globals != NULL) {
3232 Py_INCREF(globals);
3233 builtins = PyObject_GetItem(globals, builtins_str);
3234 if (builtins == NULL)
3235 goto err;
3236 }
3237 else {
3238 /* No globals -- use standard builtins, and fake globals */
3239 builtins = PyImport_ImportModuleLevel("builtins",
3240 NULL, NULL, NULL, 0);
3241 if (builtins == NULL)
3242 return NULL;
3243 globals = Py_BuildValue("{OO}", builtins_str, builtins);
3244 if (globals == NULL)
3245 goto err;
3246 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003247
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003248 /* Get the __import__ function from the builtins */
3249 if (PyDict_Check(builtins)) {
3250 import = PyObject_GetItem(builtins, import_str);
3251 if (import == NULL)
3252 PyErr_SetObject(PyExc_KeyError, import_str);
3253 }
3254 else
3255 import = PyObject_GetAttr(builtins, import_str);
3256 if (import == NULL)
3257 goto err;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003258
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003259 /* Call the __import__ function with the proper argument list
Brett Cannonbc2eff32010-09-19 21:39:02 +00003260 Always use absolute import here.
3261 Calling for side-effect of import. */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003262 r = PyObject_CallFunction(import, "OOOOi", module_name, globals,
3263 globals, silly_list, 0, NULL);
Brett Cannonbc2eff32010-09-19 21:39:02 +00003264 if (r == NULL)
3265 goto err;
3266 Py_DECREF(r);
3267
3268 modules = PyImport_GetModuleDict();
3269 r = PyDict_GetItem(modules, module_name);
3270 if (r != NULL)
3271 Py_INCREF(r);
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003272
3273 err:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003274 Py_XDECREF(globals);
3275 Py_XDECREF(builtins);
3276 Py_XDECREF(import);
Tim Peters50d8d372001-02-28 05:34:27 +00003277
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003278 return r;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003279}
3280
3281
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003282/* Module 'imp' provides Python access to the primitives used for
3283 importing modules.
3284*/
3285
Guido van Rossum79f25d91997-04-29 20:08:16 +00003286static PyObject *
Barry Warsaw28a691b2010-04-17 00:19:56 +00003287imp_make_magic(long magic)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003288{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003289 char buf[4];
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003290
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003291 buf[0] = (char) ((magic >> 0) & 0xff);
3292 buf[1] = (char) ((magic >> 8) & 0xff);
3293 buf[2] = (char) ((magic >> 16) & 0xff);
3294 buf[3] = (char) ((magic >> 24) & 0xff);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003295
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003296 return PyBytes_FromStringAndSize(buf, 4);
Victor Stinner3e2b7172010-11-09 09:32:19 +00003297}
Barry Warsaw28a691b2010-04-17 00:19:56 +00003298
3299static PyObject *
3300imp_get_magic(PyObject *self, PyObject *noargs)
3301{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003302 return imp_make_magic(pyc_magic);
Barry Warsaw28a691b2010-04-17 00:19:56 +00003303}
3304
3305static PyObject *
3306imp_get_tag(PyObject *self, PyObject *noargs)
3307{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003308 return PyUnicode_FromString(pyc_tag);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003309}
3310
Guido van Rossum79f25d91997-04-29 20:08:16 +00003311static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +00003312imp_get_suffixes(PyObject *self, PyObject *noargs)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003313{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003314 PyObject *list;
3315 struct filedescr *fdp;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003316
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003317 list = PyList_New(0);
3318 if (list == NULL)
3319 return NULL;
3320 for (fdp = _PyImport_Filetab; fdp->suffix != NULL; fdp++) {
3321 PyObject *item = Py_BuildValue("ssi",
3322 fdp->suffix, fdp->mode, fdp->type);
3323 if (item == NULL) {
3324 Py_DECREF(list);
3325 return NULL;
3326 }
3327 if (PyList_Append(list, item) < 0) {
3328 Py_DECREF(list);
3329 Py_DECREF(item);
3330 return NULL;
3331 }
3332 Py_DECREF(item);
3333 }
3334 return list;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003335}
3336
Guido van Rossum79f25d91997-04-29 20:08:16 +00003337static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003338call_find_module(char *name, PyObject *path)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003339{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003340 extern int fclose(FILE *);
3341 PyObject *fob, *ret;
3342 PyObject *pathobj;
3343 struct filedescr *fdp;
3344 char pathname[MAXPATHLEN+1];
Victor Stinner7d8b77c2011-03-12 08:45:02 -05003345 FILE *fp;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003346 int fd = -1;
3347 char *found_encoding = NULL;
3348 char *encoding = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003349
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003350 pathname[0] = '\0';
3351 if (path == Py_None)
3352 path = NULL;
3353 fdp = find_module(NULL, name, path, pathname, MAXPATHLEN+1, &fp, NULL);
3354 if (fdp == NULL)
3355 return NULL;
3356 if (fp != NULL) {
3357 fd = fileno(fp);
3358 if (fd != -1)
3359 fd = dup(fd);
3360 fclose(fp);
3361 fp = NULL;
3362 }
3363 if (fd != -1) {
3364 if (strchr(fdp->mode, 'b') == NULL) {
3365 /* PyTokenizer_FindEncoding() returns PyMem_MALLOC'ed
3366 memory. */
3367 found_encoding = PyTokenizer_FindEncoding(fd);
3368 lseek(fd, 0, 0); /* Reset position */
3369 if (found_encoding == NULL && PyErr_Occurred())
3370 return NULL;
3371 encoding = (found_encoding != NULL) ? found_encoding :
3372 (char*)PyUnicode_GetDefaultEncoding();
3373 }
3374 fob = PyFile_FromFd(fd, pathname, fdp->mode, -1,
3375 (char*)encoding, NULL, NULL, 1);
3376 if (fob == NULL) {
3377 close(fd);
3378 PyMem_FREE(found_encoding);
3379 return NULL;
3380 }
3381 }
3382 else {
3383 fob = Py_None;
3384 Py_INCREF(fob);
3385 }
3386 pathobj = PyUnicode_DecodeFSDefault(pathname);
3387 ret = Py_BuildValue("NN(ssi)",
3388 fob, pathobj, fdp->suffix, fdp->mode, fdp->type);
3389 PyMem_FREE(found_encoding);
Brett Cannon3bb42d92007-10-20 03:43:15 +00003390
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003391 return ret;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003392}
3393
Guido van Rossum79f25d91997-04-29 20:08:16 +00003394static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003395imp_find_module(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003396{
Victor Stinnerebc00522010-12-03 17:06:43 +00003397 PyObject *name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003398 PyObject *ret, *path = NULL;
Victor Stinnerebc00522010-12-03 17:06:43 +00003399 if (!PyArg_ParseTuple(args, "O&|O:find_module",
3400 PyUnicode_FSConverter, &name,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003401 &path))
3402 return NULL;
Victor Stinnerebc00522010-12-03 17:06:43 +00003403 ret = call_find_module(PyBytes_AS_STRING(name), path);
3404 Py_DECREF(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003405 return ret;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003406}
3407
3408static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003409imp_init_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003410{
Victor Stinner95872862011-03-07 18:20:56 +01003411 PyObject *name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003412 int ret;
3413 PyObject *m;
Victor Stinner95872862011-03-07 18:20:56 +01003414 if (!PyArg_ParseTuple(args, "U:init_builtin", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003415 return NULL;
3416 ret = init_builtin(name);
3417 if (ret < 0)
3418 return NULL;
3419 if (ret == 0) {
3420 Py_INCREF(Py_None);
3421 return Py_None;
3422 }
Victor Stinner95872862011-03-07 18:20:56 +01003423 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003424 Py_XINCREF(m);
3425 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003426}
3427
Guido van Rossum79f25d91997-04-29 20:08:16 +00003428static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003429imp_init_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003430{
Victor Stinner53dc7352011-03-20 01:50:21 +01003431 PyObject *name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003432 int ret;
3433 PyObject *m;
Victor Stinner53dc7352011-03-20 01:50:21 +01003434 if (!PyArg_ParseTuple(args, "U:init_frozen", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003435 return NULL;
Victor Stinner53dc7352011-03-20 01:50:21 +01003436 ret = PyImport_ImportFrozenModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003437 if (ret < 0)
3438 return NULL;
3439 if (ret == 0) {
3440 Py_INCREF(Py_None);
3441 return Py_None;
3442 }
Victor Stinner53dc7352011-03-20 01:50:21 +01003443 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003444 Py_XINCREF(m);
3445 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003446}
3447
Guido van Rossum79f25d91997-04-29 20:08:16 +00003448static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003449imp_get_frozen_object(PyObject *self, PyObject *args)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00003450{
Victor Stinner53dc7352011-03-20 01:50:21 +01003451 PyObject *name;
Jack Jansen95ffa231995-10-03 14:38:41 +00003452
Victor Stinner53dc7352011-03-20 01:50:21 +01003453 if (!PyArg_ParseTuple(args, "U:get_frozen_object", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003454 return NULL;
3455 return get_frozen_object(name);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00003456}
3457
Guido van Rossum79f25d91997-04-29 20:08:16 +00003458static PyObject *
Brett Cannon8d110132009-03-15 02:20:16 +00003459imp_is_frozen_package(PyObject *self, PyObject *args)
3460{
Victor Stinner53dc7352011-03-20 01:50:21 +01003461 PyObject *name;
Brett Cannon8d110132009-03-15 02:20:16 +00003462
Victor Stinner53dc7352011-03-20 01:50:21 +01003463 if (!PyArg_ParseTuple(args, "U:is_frozen_package", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003464 return NULL;
3465 return is_frozen_package(name);
Brett Cannon8d110132009-03-15 02:20:16 +00003466}
3467
3468static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003469imp_is_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003470{
Victor Stinner95872862011-03-07 18:20:56 +01003471 PyObject *name;
3472 if (!PyArg_ParseTuple(args, "U:is_builtin", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003473 return NULL;
3474 return PyLong_FromLong(is_builtin(name));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003475}
3476
Guido van Rossum79f25d91997-04-29 20:08:16 +00003477static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003478imp_is_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003479{
Victor Stinner53dc7352011-03-20 01:50:21 +01003480 PyObject *name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003481 struct _frozen *p;
Victor Stinner53dc7352011-03-20 01:50:21 +01003482 if (!PyArg_ParseTuple(args, "U:is_frozen", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003483 return NULL;
3484 p = find_frozen(name);
3485 return PyBool_FromLong((long) (p == NULL ? 0 : p->size));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003486}
3487
3488static FILE *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003489get_file(char *pathname, PyObject *fob, char *mode)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003490{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003491 FILE *fp;
3492 if (mode[0] == 'U')
3493 mode = "r" PY_STDIOTEXTMODE;
3494 if (fob == NULL) {
3495 fp = fopen(pathname, mode);
3496 }
3497 else {
3498 int fd = PyObject_AsFileDescriptor(fob);
3499 if (fd == -1)
3500 return NULL;
3501 if (!_PyVerify_fd(fd))
3502 goto error;
3503 /* the FILE struct gets a new fd, so that it can be closed
3504 * independently of the file descriptor given
3505 */
3506 fd = dup(fd);
3507 if (fd == -1)
3508 goto error;
3509 fp = fdopen(fd, mode);
3510 }
3511 if (fp)
3512 return fp;
Kristján Valur Jónssone1b04452009-03-31 17:43:39 +00003513error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003514 PyErr_SetFromErrno(PyExc_IOError);
3515 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003516}
3517
Guido van Rossum79f25d91997-04-29 20:08:16 +00003518static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003519imp_load_compiled(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_compiled",
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, "rb");
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_compiled_module(name, PyBytes_AS_STRING(pathname), fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003537 fclose(fp);
Victor Stinnerebc00522010-12-03 17:06:43 +00003538 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003539 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003540}
3541
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003542#ifdef HAVE_DYNAMIC_LOADING
3543
Guido van Rossum79f25d91997-04-29 20:08:16 +00003544static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003545imp_load_dynamic(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003546{
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003547 PyObject *name, *pathname, *fob = NULL, *mod;
3548 FILE *fp;
3549
3550 if (!PyArg_ParseTuple(args, "UO&|O:load_dynamic",
3551 &name, PyUnicode_FSDecoder, &pathname, &fob))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003552 return NULL;
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003553 if (fob != NULL) {
3554 fp = get_file(NULL, fob, "r");
3555 if (fp == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003556 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003557 }
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003558 else
3559 fp = NULL;
3560 mod = _PyImport_LoadDynamicModule(name, pathname, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003561 if (fp)
3562 fclose(fp);
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003563 return mod;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003564}
3565
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003566#endif /* HAVE_DYNAMIC_LOADING */
3567
Guido van Rossum79f25d91997-04-29 20:08:16 +00003568static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003569imp_load_source(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003570{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003571 char *name;
Victor Stinnerebc00522010-12-03 17:06:43 +00003572 PyObject *pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003573 PyObject *fob = NULL;
3574 PyObject *m;
3575 FILE *fp;
Victor Stinnerebc00522010-12-03 17:06:43 +00003576 if (!PyArg_ParseTuple(args, "sO&|O:load_source",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003577 &name,
Victor Stinnerebc00522010-12-03 17:06:43 +00003578 PyUnicode_FSConverter, &pathname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003579 &fob))
3580 return NULL;
Victor Stinnerebc00522010-12-03 17:06:43 +00003581 fp = get_file(PyBytes_AS_STRING(pathname), fob, "r");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003582 if (fp == NULL) {
Victor Stinnerebc00522010-12-03 17:06:43 +00003583 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003584 return NULL;
3585 }
Victor Stinnerebc00522010-12-03 17:06:43 +00003586 m = load_source_module(name, PyBytes_AS_STRING(pathname), fp);
3587 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003588 fclose(fp);
3589 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003590}
3591
Guido van Rossum79f25d91997-04-29 20:08:16 +00003592static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003593imp_load_module(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003594{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003595 char *name;
3596 PyObject *fob;
Victor Stinner1a563032010-10-15 22:43:10 +00003597 PyObject *pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003598 PyObject * ret;
3599 char *suffix; /* Unused */
3600 char *mode;
3601 int type;
3602 FILE *fp;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003603
Victor Stinner1a563032010-10-15 22:43:10 +00003604 if (!PyArg_ParseTuple(args, "sOO&(ssi):load_module",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003605 &name, &fob,
Victor Stinner1a563032010-10-15 22:43:10 +00003606 PyUnicode_FSConverter, &pathname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003607 &suffix, &mode, &type))
3608 return NULL;
3609 if (*mode) {
3610 /* Mode must start with 'r' or 'U' and must not contain '+'.
3611 Implicit in this test is the assumption that the mode
3612 may contain other modifiers like 'b' or 't'. */
Guido van Rossum5e2c5fa2002-05-30 17:33:07 +00003613
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003614 if (!(*mode == 'r' || *mode == 'U') || strchr(mode, '+')) {
3615 PyErr_Format(PyExc_ValueError,
3616 "invalid file open mode %.200s", mode);
Victor Stinner1a563032010-10-15 22:43:10 +00003617 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003618 return NULL;
3619 }
3620 }
3621 if (fob == Py_None)
3622 fp = NULL;
3623 else {
3624 fp = get_file(NULL, fob, mode);
3625 if (fp == NULL) {
Victor Stinner1a563032010-10-15 22:43:10 +00003626 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003627 return NULL;
3628 }
3629 }
Victor Stinner1a563032010-10-15 22:43:10 +00003630 ret = load_module(name, fp, PyBytes_AS_STRING(pathname), type, NULL);
3631 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003632 if (fp)
3633 fclose(fp);
3634 return ret;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003635}
3636
3637static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003638imp_load_package(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003639{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003640 char *name;
Victor Stinnerebc00522010-12-03 17:06:43 +00003641 PyObject *pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003642 PyObject * ret;
Victor Stinnerebc00522010-12-03 17:06:43 +00003643 if (!PyArg_ParseTuple(args, "sO&:load_package",
3644 &name, PyUnicode_FSConverter, &pathname))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003645 return NULL;
Victor Stinnerebc00522010-12-03 17:06:43 +00003646 ret = load_package(name, PyBytes_AS_STRING(pathname));
3647 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003648 return ret;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003649}
3650
3651static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003652imp_new_module(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003653{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003654 char *name;
3655 if (!PyArg_ParseTuple(args, "s:new_module", &name))
3656 return NULL;
3657 return PyModule_New(name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003658}
3659
Christian Heimes13a7a212008-01-07 17:13:09 +00003660static PyObject *
3661imp_reload(PyObject *self, PyObject *v)
3662{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003663 return PyImport_ReloadModule(v);
Christian Heimes13a7a212008-01-07 17:13:09 +00003664}
3665
3666PyDoc_STRVAR(doc_reload,
3667"reload(module) -> module\n\
3668\n\
3669Reload the module. The module must have been successfully imported before.");
3670
Barry Warsaw28a691b2010-04-17 00:19:56 +00003671static PyObject *
3672imp_cache_from_source(PyObject *self, PyObject *args, PyObject *kws)
3673{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003674 static char *kwlist[] = {"path", "debug_override", NULL};
Barry Warsaw28a691b2010-04-17 00:19:56 +00003675
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003676 char buf[MAXPATHLEN+1];
Victor Stinner3ea23dd2010-10-15 20:34:32 +00003677 PyObject *pathbytes;
3678 char *cpathname;
Benjamin Peterson294a9fc2010-10-16 03:12:39 +00003679 PyObject *debug_override = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003680 int debug = !Py_OptimizeFlag;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003681
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003682 if (!PyArg_ParseTupleAndKeywords(
Victor Stinner3ea23dd2010-10-15 20:34:32 +00003683 args, kws, "O&|O", kwlist,
3684 PyUnicode_FSConverter, &pathbytes, &debug_override))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003685 return NULL;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003686
Benjamin Peterson294a9fc2010-10-16 03:12:39 +00003687 if (debug_override != NULL &&
3688 (debug = PyObject_IsTrue(debug_override)) < 0) {
3689 Py_DECREF(pathbytes);
3690 return NULL;
3691 }
Barry Warsaw28a691b2010-04-17 00:19:56 +00003692
Victor Stinner3ea23dd2010-10-15 20:34:32 +00003693 cpathname = make_compiled_pathname(
3694 PyBytes_AS_STRING(pathbytes),
3695 buf, MAXPATHLEN+1, debug);
3696 Py_DECREF(pathbytes);
Barry Warsaw28a691b2010-04-17 00:19:56 +00003697
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003698 if (cpathname == NULL) {
3699 PyErr_Format(PyExc_SystemError, "path buffer too short");
3700 return NULL;
3701 }
Victor Stinner88bd8912010-10-15 22:46:07 +00003702 return PyUnicode_DecodeFSDefault(buf);
Barry Warsaw28a691b2010-04-17 00:19:56 +00003703}
3704
3705PyDoc_STRVAR(doc_cache_from_source,
3706"Given the path to a .py file, return the path to its .pyc/.pyo file.\n\
3707\n\
3708The .py file does not need to exist; this simply returns the path to the\n\
3709.pyc/.pyo file calculated as if the .py file were imported. The extension\n\
3710will be .pyc unless __debug__ is not defined, then it will be .pyo.\n\
3711\n\
3712If debug_override is not None, then it must be a boolean and is taken as\n\
3713the value of __debug__ instead.");
3714
3715static PyObject *
3716imp_source_from_cache(PyObject *self, PyObject *args, PyObject *kws)
3717{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003718 static char *kwlist[] = {"path", NULL};
Barry Warsaw28a691b2010-04-17 00:19:56 +00003719
Victor Stinnerebc00522010-12-03 17:06:43 +00003720 PyObject *pathname_obj;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003721 char *pathname;
3722 char buf[MAXPATHLEN+1];
Barry Warsaw28a691b2010-04-17 00:19:56 +00003723
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003724 if (!PyArg_ParseTupleAndKeywords(
Victor Stinnerebc00522010-12-03 17:06:43 +00003725 args, kws, "O&", kwlist,
3726 PyUnicode_FSConverter, &pathname_obj))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003727 return NULL;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003728
Victor Stinnerebc00522010-12-03 17:06:43 +00003729 pathname = PyBytes_AS_STRING(pathname_obj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003730 if (make_source_pathname(pathname, buf) == NULL) {
3731 PyErr_Format(PyExc_ValueError, "Not a PEP 3147 pyc path: %s",
3732 pathname);
Victor Stinnerebc00522010-12-03 17:06:43 +00003733 Py_DECREF(pathname_obj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003734 return NULL;
3735 }
Victor Stinnerebc00522010-12-03 17:06:43 +00003736 Py_DECREF(pathname_obj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003737 return PyUnicode_FromString(buf);
Barry Warsaw28a691b2010-04-17 00:19:56 +00003738}
3739
3740PyDoc_STRVAR(doc_source_from_cache,
3741"Given the path to a .pyc./.pyo file, return the path to its .py file.\n\
3742\n\
3743The .pyc/.pyo file does not need to exist; this simply returns the path to\n\
3744the .py file calculated to correspond to the .pyc/.pyo file. If path\n\
3745does not conform to PEP 3147 format, ValueError will be raised.");
3746
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003747/* Doc strings */
3748
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003749PyDoc_STRVAR(doc_imp,
3750"This module provides the components needed to build your own\n\
3751__import__ function. Undocumented functions are obsolete.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003752
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003753PyDoc_STRVAR(doc_find_module,
3754"find_module(name, [path]) -> (file, filename, (suffix, mode, type))\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003755Search for a module. If path is omitted or None, search for a\n\
3756built-in, frozen or special module and continue search in sys.path.\n\
3757The module name cannot contain '.'; to search for a submodule of a\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003758package, pass the submodule name and the package's __path__.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003759
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003760PyDoc_STRVAR(doc_load_module,
3761"load_module(name, file, filename, (suffix, mode, type)) -> module\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003762Load a module, given information returned by find_module().\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003763The module name must include the full package name, if any.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003764
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003765PyDoc_STRVAR(doc_get_magic,
3766"get_magic() -> string\n\
3767Return the magic number for .pyc or .pyo files.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003768
Barry Warsaw28a691b2010-04-17 00:19:56 +00003769PyDoc_STRVAR(doc_get_tag,
3770"get_tag() -> string\n\
3771Return the magic tag for .pyc or .pyo files.");
3772
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003773PyDoc_STRVAR(doc_get_suffixes,
3774"get_suffixes() -> [(suffix, mode, type), ...]\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003775Return a list of (suffix, mode, type) tuples describing the files\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003776that find_module() looks for.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003777
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003778PyDoc_STRVAR(doc_new_module,
3779"new_module(name) -> module\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003780Create a new module. Do not enter it in sys.modules.\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003781The module name must include the full package name, if any.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003782
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003783PyDoc_STRVAR(doc_lock_held,
Tim Petersa7c65092004-08-01 23:26:05 +00003784"lock_held() -> boolean\n\
3785Return True if the import lock is currently held, else False.\n\
3786On platforms without threads, return False.");
Tim Peters69232342001-08-30 05:16:13 +00003787
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00003788PyDoc_STRVAR(doc_acquire_lock,
3789"acquire_lock() -> None\n\
Neal Norwitz2294c0d2003-02-12 23:02:21 +00003790Acquires the interpreter's import lock for the current thread.\n\
3791This lock should be used by import hooks to ensure thread-safety\n\
3792when importing modules.\n\
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00003793On platforms without threads, this function does nothing.");
3794
3795PyDoc_STRVAR(doc_release_lock,
3796"release_lock() -> None\n\
3797Release the interpreter's import lock.\n\
3798On platforms without threads, this function does nothing.");
3799
Guido van Rossum79f25d91997-04-29 20:08:16 +00003800static PyMethodDef imp_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003801 {"find_module", imp_find_module, METH_VARARGS, doc_find_module},
3802 {"get_magic", imp_get_magic, METH_NOARGS, doc_get_magic},
3803 {"get_tag", imp_get_tag, METH_NOARGS, doc_get_tag},
3804 {"get_suffixes", imp_get_suffixes, METH_NOARGS, doc_get_suffixes},
3805 {"load_module", imp_load_module, METH_VARARGS, doc_load_module},
3806 {"new_module", imp_new_module, METH_VARARGS, doc_new_module},
3807 {"lock_held", imp_lock_held, METH_NOARGS, doc_lock_held},
3808 {"acquire_lock", imp_acquire_lock, METH_NOARGS, doc_acquire_lock},
3809 {"release_lock", imp_release_lock, METH_NOARGS, doc_release_lock},
3810 {"reload", imp_reload, METH_O, doc_reload},
3811 {"cache_from_source", (PyCFunction)imp_cache_from_source,
3812 METH_VARARGS | METH_KEYWORDS, doc_cache_from_source},
3813 {"source_from_cache", (PyCFunction)imp_source_from_cache,
3814 METH_VARARGS | METH_KEYWORDS, doc_source_from_cache},
3815 /* The rest are obsolete */
3816 {"get_frozen_object", imp_get_frozen_object, METH_VARARGS},
3817 {"is_frozen_package", imp_is_frozen_package, METH_VARARGS},
3818 {"init_builtin", imp_init_builtin, METH_VARARGS},
3819 {"init_frozen", imp_init_frozen, METH_VARARGS},
3820 {"is_builtin", imp_is_builtin, METH_VARARGS},
3821 {"is_frozen", imp_is_frozen, METH_VARARGS},
3822 {"load_compiled", imp_load_compiled, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003823#ifdef HAVE_DYNAMIC_LOADING
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003824 {"load_dynamic", imp_load_dynamic, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003825#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003826 {"load_package", imp_load_package, METH_VARARGS},
3827 {"load_source", imp_load_source, METH_VARARGS},
3828 {NULL, NULL} /* sentinel */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003829};
3830
Guido van Rossum1a8791e1998-08-04 22:46:29 +00003831static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003832setint(PyObject *d, char *name, int value)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003833{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003834 PyObject *v;
3835 int err;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003836
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003837 v = PyLong_FromLong((long)value);
3838 err = PyDict_SetItemString(d, name, v);
3839 Py_XDECREF(v);
3840 return err;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003841}
3842
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003843typedef struct {
3844 PyObject_HEAD
3845} NullImporter;
3846
3847static int
3848NullImporter_init(NullImporter *self, PyObject *args, PyObject *kwds)
3849{
Victor Stinner1a4d12d2010-08-13 13:07:29 +00003850#ifndef MS_WINDOWS
3851 PyObject *path;
3852 struct stat statbuf;
3853 int rv;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003854
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003855 if (!_PyArg_NoKeywords("NullImporter()", kwds))
3856 return -1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003857
Victor Stinner1a4d12d2010-08-13 13:07:29 +00003858 if (!PyArg_ParseTuple(args, "O&:NullImporter",
3859 PyUnicode_FSConverter, &path))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003860 return -1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003861
Victor Stinner1a4d12d2010-08-13 13:07:29 +00003862 if (PyBytes_GET_SIZE(path) == 0) {
3863 Py_DECREF(path);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003864 PyErr_SetString(PyExc_ImportError, "empty pathname");
3865 return -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003866 }
Victor Stinner1a4d12d2010-08-13 13:07:29 +00003867
3868 rv = stat(PyBytes_AS_STRING(path), &statbuf);
3869 Py_DECREF(path);
3870 if (rv == 0) {
3871 /* it exists */
3872 if (S_ISDIR(statbuf.st_mode)) {
3873 /* it's a directory */
3874 PyErr_SetString(PyExc_ImportError, "existing directory");
3875 return -1;
3876 }
3877 }
3878#else /* MS_WINDOWS */
3879 PyObject *pathobj;
3880 DWORD rv;
Victor Stinner255dfdb2010-09-29 10:28:51 +00003881 wchar_t *path;
Victor Stinner1a4d12d2010-08-13 13:07:29 +00003882
3883 if (!_PyArg_NoKeywords("NullImporter()", kwds))
3884 return -1;
3885
3886 if (!PyArg_ParseTuple(args, "U:NullImporter",
3887 &pathobj))
3888 return -1;
3889
3890 if (PyUnicode_GET_SIZE(pathobj) == 0) {
3891 PyErr_SetString(PyExc_ImportError, "empty pathname");
3892 return -1;
3893 }
3894
Victor Stinnerbeb4135b2010-10-07 01:02:42 +00003895 path = PyUnicode_AsWideCharString(pathobj, NULL);
Victor Stinner255dfdb2010-09-29 10:28:51 +00003896 if (path == NULL)
Victor Stinner1a4d12d2010-08-13 13:07:29 +00003897 return -1;
3898 /* see issue1293 and issue3677:
3899 * stat() on Windows doesn't recognise paths like
3900 * "e:\\shared\\" and "\\\\whiterab-c2znlh\\shared" as dirs.
3901 */
3902 rv = GetFileAttributesW(path);
Victor Stinner255dfdb2010-09-29 10:28:51 +00003903 PyMem_Free(path);
Victor Stinner1a4d12d2010-08-13 13:07:29 +00003904 if (rv != INVALID_FILE_ATTRIBUTES) {
3905 /* it exists */
3906 if (rv & FILE_ATTRIBUTE_DIRECTORY) {
3907 /* it's a directory */
3908 PyErr_SetString(PyExc_ImportError, "existing directory");
3909 return -1;
3910 }
3911 }
3912#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003913 return 0;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003914}
3915
3916static PyObject *
3917NullImporter_find_module(NullImporter *self, PyObject *args)
3918{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003919 Py_RETURN_NONE;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003920}
3921
3922static PyMethodDef NullImporter_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003923 {"find_module", (PyCFunction)NullImporter_find_module, METH_VARARGS,
3924 "Always return None"
3925 },
3926 {NULL} /* Sentinel */
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003927};
3928
3929
Christian Heimes9cd17752007-11-18 19:35:23 +00003930PyTypeObject PyNullImporter_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003931 PyVarObject_HEAD_INIT(NULL, 0)
3932 "imp.NullImporter", /*tp_name*/
3933 sizeof(NullImporter), /*tp_basicsize*/
3934 0, /*tp_itemsize*/
3935 0, /*tp_dealloc*/
3936 0, /*tp_print*/
3937 0, /*tp_getattr*/
3938 0, /*tp_setattr*/
3939 0, /*tp_reserved*/
3940 0, /*tp_repr*/
3941 0, /*tp_as_number*/
3942 0, /*tp_as_sequence*/
3943 0, /*tp_as_mapping*/
3944 0, /*tp_hash */
3945 0, /*tp_call*/
3946 0, /*tp_str*/
3947 0, /*tp_getattro*/
3948 0, /*tp_setattro*/
3949 0, /*tp_as_buffer*/
3950 Py_TPFLAGS_DEFAULT, /*tp_flags*/
3951 "Null importer object", /* tp_doc */
3952 0, /* tp_traverse */
3953 0, /* tp_clear */
3954 0, /* tp_richcompare */
3955 0, /* tp_weaklistoffset */
3956 0, /* tp_iter */
3957 0, /* tp_iternext */
3958 NullImporter_methods, /* tp_methods */
3959 0, /* tp_members */
3960 0, /* tp_getset */
3961 0, /* tp_base */
3962 0, /* tp_dict */
3963 0, /* tp_descr_get */
3964 0, /* tp_descr_set */
3965 0, /* tp_dictoffset */
3966 (initproc)NullImporter_init, /* tp_init */
3967 0, /* tp_alloc */
3968 PyType_GenericNew /* tp_new */
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003969};
3970
Martin v. Löwis1a214512008-06-11 05:26:20 +00003971static struct PyModuleDef impmodule = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003972 PyModuleDef_HEAD_INIT,
3973 "imp",
3974 doc_imp,
3975 0,
3976 imp_methods,
3977 NULL,
3978 NULL,
3979 NULL,
3980 NULL
Martin v. Löwis1a214512008-06-11 05:26:20 +00003981};
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003982
Jason Tishler6bc06ec2003-09-04 11:59:50 +00003983PyMODINIT_FUNC
Martin v. Löwis1a214512008-06-11 05:26:20 +00003984PyInit_imp(void)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003985{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003986 PyObject *m, *d;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003987
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003988 if (PyType_Ready(&PyNullImporter_Type) < 0)
3989 return NULL;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003990
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003991 m = PyModule_Create(&impmodule);
3992 if (m == NULL)
3993 goto failure;
3994 d = PyModule_GetDict(m);
3995 if (d == NULL)
3996 goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003997
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003998 if (setint(d, "SEARCH_ERROR", SEARCH_ERROR) < 0) goto failure;
3999 if (setint(d, "PY_SOURCE", PY_SOURCE) < 0) goto failure;
4000 if (setint(d, "PY_COMPILED", PY_COMPILED) < 0) goto failure;
4001 if (setint(d, "C_EXTENSION", C_EXTENSION) < 0) goto failure;
4002 if (setint(d, "PY_RESOURCE", PY_RESOURCE) < 0) goto failure;
4003 if (setint(d, "PKG_DIRECTORY", PKG_DIRECTORY) < 0) goto failure;
4004 if (setint(d, "C_BUILTIN", C_BUILTIN) < 0) goto failure;
4005 if (setint(d, "PY_FROZEN", PY_FROZEN) < 0) goto failure;
4006 if (setint(d, "PY_CODERESOURCE", PY_CODERESOURCE) < 0) goto failure;
4007 if (setint(d, "IMP_HOOK", IMP_HOOK) < 0) goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004008
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004009 Py_INCREF(&PyNullImporter_Type);
4010 PyModule_AddObject(m, "NullImporter", (PyObject *)&PyNullImporter_Type);
4011 return m;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00004012 failure:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004013 Py_XDECREF(m);
4014 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004015}
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004016
4017
Guido van Rossumb18618d2000-05-03 23:44:39 +00004018/* API for embedding applications that want to add their own entries
4019 to the table of built-in modules. This should normally be called
4020 *before* Py_Initialize(). When the table resize fails, -1 is
4021 returned and the existing table is unchanged.
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004022
4023 After a similar function by Just van Rossum. */
4024
4025int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00004026PyImport_ExtendInittab(struct _inittab *newtab)
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004027{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004028 static struct _inittab *our_copy = NULL;
4029 struct _inittab *p;
4030 int i, n;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004031
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004032 /* Count the number of entries in both tables */
4033 for (n = 0; newtab[n].name != NULL; n++)
4034 ;
4035 if (n == 0)
4036 return 0; /* Nothing to do */
4037 for (i = 0; PyImport_Inittab[i].name != NULL; i++)
4038 ;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004039
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004040 /* Allocate new memory for the combined table */
4041 p = our_copy;
4042 PyMem_RESIZE(p, struct _inittab, i+n+1);
4043 if (p == NULL)
4044 return -1;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004045
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004046 /* Copy the tables into the new memory */
4047 if (our_copy != PyImport_Inittab)
4048 memcpy(p, PyImport_Inittab, (i+1) * sizeof(struct _inittab));
4049 PyImport_Inittab = our_copy = p;
4050 memcpy(p+i, newtab, (n+1) * sizeof(struct _inittab));
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004051
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004052 return 0;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004053}
4054
4055/* Shorthand to add a single entry given a name and a function */
4056
4057int
Brett Cannona826f322009-04-02 03:41:46 +00004058PyImport_AppendInittab(const char *name, PyObject* (*initfunc)(void))
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004059{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004060 struct _inittab newtab[2];
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004061
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004062 memset(newtab, '\0', sizeof newtab);
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004063
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004064 newtab[0].name = (char *)name;
4065 newtab[0].initfunc = initfunc;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004066
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004067 return PyImport_ExtendInittab(newtab);
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004068}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00004069
4070#ifdef __cplusplus
4071}
4072#endif