blob: e58d6a04be632daaeb8ba6307ffc642ad7140940 [file] [log] [blame]
Guido van Rossumf70e43a1991-02-19 12:39:46 +00001
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002/* Module definition and import implementation */
3
Guido van Rossum79f25d91997-04-29 20:08:16 +00004#include "Python.h"
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00005
Jeremy Hylton3e0055f2005-10-20 19:59:25 +00006#include "Python-ast.h"
Guido van Rossumd8faa362007-04-27 19:54:29 +00007#undef Yield /* undefine macro conflicting with winbase.h */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00008#include "errcode.h"
Guido van Rossumc405b7b1991-06-04 19:39:42 +00009#include "marshal.h"
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000010#include "code.h"
Guido van Rossumd8bac6d1992-02-26 15:19:13 +000011#include "osdefs.h"
Guido van Rossum1ae940a1995-01-02 19:04:15 +000012#include "importdl.h"
Guido van Rossumc405b7b1991-06-04 19:39:42 +000013
Guido van Rossum55a83382000-09-20 20:31:38 +000014#ifdef HAVE_FCNTL_H
15#include <fcntl.h>
16#endif
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000017#ifdef __cplusplus
Brett Cannon9a5b25a2010-03-01 02:09:17 +000018extern "C" {
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000019#endif
Guido van Rossum55a83382000-09-20 20:31:38 +000020
Christian Heimesd3eb5a152008-02-24 00:38:49 +000021#ifdef MS_WINDOWS
22/* for stat.st_mode */
23typedef unsigned short mode_t;
Daniel Stutzbachc7937792010-09-09 21:18:04 +000024/* for _mkdir */
25#include <direct.h>
Christian Heimesd3eb5a152008-02-24 00:38:49 +000026#endif
27
Guido van Rossum21d335e1993-10-15 13:01:11 +000028
Jeremy Hyltond4ceb312004-04-01 02:45:22 +000029/* Magic word to reject .pyc files generated by other Python versions.
30 It should change for each incompatible change to the bytecode.
31
32 The value of CR and LF is incorporated so if you ever read or write
Guido van Rossum7faeab31995-07-07 22:50:36 +000033 a .pyc file in text mode the magic number will be wrong; also, the
Tim Peters36515e22001-11-18 04:06:29 +000034 Apple MPW compiler swaps their values, botching string constants.
Marc-André Lemburgbd3be8f2002-02-07 11:33:49 +000035
Guido van Rossum45aecf42006-03-15 04:58:47 +000036 The magic numbers must be spaced apart at least 2 values, as the
Martin v. Löwisef82d2f2004-06-27 16:51:46 +000037 -U interpeter flag will cause MAGIC+1 being used. They have been
38 odd numbers for some time now.
Marc-André Lemburgbd3be8f2002-02-07 11:33:49 +000039
Jeremy Hyltond4ceb312004-04-01 02:45:22 +000040 There were a variety of old schemes for setting the magic number.
41 The current working scheme is to increment the previous value by
42 10.
Guido van Rossumf6894922002-08-31 15:16:14 +000043
Barry Warsaw28a691b2010-04-17 00:19:56 +000044 Starting with the adoption of PEP 3147 in Python 3.2, every bump in magic
45 number also includes a new "magic tag", i.e. a human readable string used
46 to represent the magic number in __pycache__ directories. When you change
47 the magic number, you must also set a new unique magic tag. Generally this
48 can be named after the Python major version of the magic number bump, but
49 it can really be anything, as long as it's different than anything else
50 that's come before. The tags are included in the following table, starting
51 with Python 3.2a0.
52
Marc-André Lemburgbd3be8f2002-02-07 11:33:49 +000053 Known values:
54 Python 1.5: 20121
55 Python 1.5.1: 20121
56 Python 1.5.2: 20121
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000057 Python 1.6: 50428
Marc-André Lemburgbd3be8f2002-02-07 11:33:49 +000058 Python 2.0: 50823
59 Python 2.0.1: 50823
60 Python 2.1: 60202
61 Python 2.1.1: 60202
62 Python 2.1.2: 60202
63 Python 2.2: 60717
Neal Norwitz7fdcb412002-06-14 01:07:39 +000064 Python 2.3a0: 62011
Michael W. Hudsondd32a912002-08-15 14:59:02 +000065 Python 2.3a0: 62021
Guido van Rossumf6894922002-08-31 15:16:14 +000066 Python 2.3a0: 62011 (!)
Martin v. Löwisef82d2f2004-06-27 16:51:46 +000067 Python 2.4a0: 62041
Raymond Hettingerfd2d1f72004-08-23 23:37:48 +000068 Python 2.4a3: 62051
Raymond Hettinger2c31a052004-09-22 18:44:21 +000069 Python 2.4b1: 62061
Michael W. Hudsondf888462005-06-03 14:41:55 +000070 Python 2.5a0: 62071
Michael W. Hudsonaee2e282005-10-21 11:32:20 +000071 Python 2.5a0: 62081 (ast-branch)
Guido van Rossumc2e20742006-02-27 22:32:47 +000072 Python 2.5a0: 62091 (with)
Guido van Rossumf6694362006-03-10 02:28:35 +000073 Python 2.5a0: 62092 (changed WITH_CLEANUP opcode)
Thomas Wouters0e3f5912006-08-11 14:57:12 +000074 Python 2.5b3: 62101 (fix wrong code: for x, in ...)
75 Python 2.5b3: 62111 (fix wrong code: x += yield)
76 Python 2.5c1: 62121 (fix wrong lnotab with for loops and
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000077 storing constants that should have been removed)
Thomas Wouters89f507f2006-12-13 04:49:30 +000078 Python 2.5c2: 62131 (fix wrong code: for x, in ... in listcomp/genexp)
Christian Heimes99170a52007-12-19 02:07:34 +000079 Python 2.6a0: 62151 (peephole optimizations and STORE_MAP opcode)
Christian Heimesdd15f6c2008-03-16 00:07:10 +000080 Python 2.6a1: 62161 (WITH_CLEANUP optimization)
Guido van Rossum45aecf42006-03-15 04:58:47 +000081 Python 3000: 3000
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000082 3010 (removed UNARY_CONVERT)
83 3020 (added BUILD_SET)
84 3030 (added keyword-only parameters)
85 3040 (added signature annotations)
86 3050 (print becomes a function)
87 3060 (PEP 3115 metaclass syntax)
88 3061 (string literals become unicode)
89 3071 (PEP 3109 raise changes)
90 3081 (PEP 3137 make __file__ and __name__ unicode)
91 3091 (kill str8 interning)
92 3101 (merge from 2.6a0, see 62151)
93 3103 (__file__ points to source file)
Benjamin Peterson0f6cae02009-12-10 02:09:08 +000094 Python 3.0a4: 3111 (WITH_CLEANUP optimization).
95 Python 3.0a5: 3131 (lexical exception stacking, including POP_EXCEPT)
96 Python 3.1a0: 3141 (optimize list, set and dict comprehensions:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000097 change LIST_APPEND and SET_ADD, add MAP_ADD)
Benjamin Peterson0f6cae02009-12-10 02:09:08 +000098 Python 3.1a0: 3151 (optimize conditional branches:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000099 introduce POP_JUMP_IF_FALSE and POP_JUMP_IF_TRUE)
Benjamin Peterson876b2f22009-06-28 03:18:59 +0000100 Python 3.2a0: 3160 (add SETUP_WITH)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000101 tag: cpython-32
Antoine Pitrou74a69fa2010-09-04 18:43:52 +0000102 Python 3.2a1: 3170 (add DUP_TOP_TWO, remove DUP_TOPX and ROT_FOUR)
103 tag: cpython-32
Benjamin Peterson6246d6d2010-09-10 21:51:44 +0000104 Python 3.2a2 3180 (add DELETE_DEREF)
Tim Peters36515e22001-11-18 04:06:29 +0000105*/
Guido van Rossum3ddee711991-12-16 13:06:34 +0000106
Nick Coghlancd419ab2010-09-11 00:39:25 +0000107/* MAGIC must change whenever the bytecode emitted by the compiler may no
108 longer be understood by older implementations of the eval loop (usually
109 due to the addition of new opcodes)
110 TAG must change for each major Python release. The magic number will take
111 care of any bytecode changes that occur during development.
Barry Warsaw28a691b2010-04-17 00:19:56 +0000112*/
Benjamin Peterson6246d6d2010-09-10 21:51:44 +0000113#define MAGIC (3180 | ((long)'\r'<<16) | ((long)'\n'<<24))
Barry Warsaw28a691b2010-04-17 00:19:56 +0000114#define TAG "cpython-32"
115#define CACHEDIR "__pycache__"
116/* Current magic word and string tag as globals. */
Guido van Rossum96774c12000-05-01 20:19:08 +0000117static long pyc_magic = MAGIC;
Barry Warsaw28a691b2010-04-17 00:19:56 +0000118static const char *pyc_tag = TAG;
Guido van Rossum96774c12000-05-01 20:19:08 +0000119
Victor Stinner95872862011-03-07 18:20:56 +0100120/* See _PyImport_FixupExtensionObject() below */
Guido van Rossum25ce5661997-08-02 03:10:38 +0000121static PyObject *extensions = NULL;
Guido van Rossum3f5da241990-12-20 15:06:42 +0000122
Guido van Rossum771c6c81997-10-31 18:37:24 +0000123/* This table is defined in config.c: */
124extern struct _inittab _PyImport_Inittab[];
125
Guido van Rossumce3a72a2007-10-19 23:16:50 +0000126/* Method from Parser/tokenizer.c */
Guido van Rossum40d20bc2007-10-22 00:09:51 +0000127extern char * PyTokenizer_FindEncoding(int);
Guido van Rossumce3a72a2007-10-19 23:16:50 +0000128
Guido van Rossum771c6c81997-10-31 18:37:24 +0000129struct _inittab *PyImport_Inittab = _PyImport_Inittab;
Guido van Rossum66f1fa81991-04-03 19:03:52 +0000130
Guido van Rossumed1170e1999-12-20 21:23:41 +0000131/* these tables define the module suffixes that Python recognizes */
132struct filedescr * _PyImport_Filetab = NULL;
Guido van Rossum48a680c2001-03-02 06:34:14 +0000133
Guido van Rossumed1170e1999-12-20 21:23:41 +0000134static const struct filedescr _PyImport_StandardFiletab[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000135 {".py", "U", PY_SOURCE},
Martin v. Löwis6238d2b2002-06-30 15:26:10 +0000136#ifdef MS_WINDOWS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000137 {".pyw", "U", PY_SOURCE},
Tim Peters36515e22001-11-18 04:06:29 +0000138#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000139 {".pyc", "rb", PY_COMPILED},
140 {0, 0}
Guido van Rossumed1170e1999-12-20 21:23:41 +0000141};
142
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000143
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000144/* Initialize things */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000145
146void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000147_PyImport_Init(void)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000148{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000149 const struct filedescr *scan;
150 struct filedescr *filetab;
151 int countD = 0;
152 int countS = 0;
Guido van Rossumed1170e1999-12-20 21:23:41 +0000153
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000154 /* prepare _PyImport_Filetab: copy entries from
155 _PyImport_DynLoadFiletab and _PyImport_StandardFiletab.
156 */
Guido van Rossum04110fb2007-08-24 16:32:05 +0000157#ifdef HAVE_DYNAMIC_LOADING
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000158 for (scan = _PyImport_DynLoadFiletab; scan->suffix != NULL; ++scan)
159 ++countD;
Guido van Rossum04110fb2007-08-24 16:32:05 +0000160#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000161 for (scan = _PyImport_StandardFiletab; scan->suffix != NULL; ++scan)
162 ++countS;
163 filetab = PyMem_NEW(struct filedescr, countD + countS + 1);
164 if (filetab == NULL)
165 Py_FatalError("Can't initialize import file table.");
Guido van Rossum04110fb2007-08-24 16:32:05 +0000166#ifdef HAVE_DYNAMIC_LOADING
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000167 memcpy(filetab, _PyImport_DynLoadFiletab,
168 countD * sizeof(struct filedescr));
Guido van Rossum04110fb2007-08-24 16:32:05 +0000169#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000170 memcpy(filetab + countD, _PyImport_StandardFiletab,
171 countS * sizeof(struct filedescr));
172 filetab[countD + countS].suffix = NULL;
Guido van Rossumed1170e1999-12-20 21:23:41 +0000173
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000174 _PyImport_Filetab = filetab;
Guido van Rossumed1170e1999-12-20 21:23:41 +0000175
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000176 if (Py_OptimizeFlag) {
177 /* Replace ".pyc" with ".pyo" in _PyImport_Filetab */
178 for (; filetab->suffix != NULL; filetab++) {
179 if (strcmp(filetab->suffix, ".pyc") == 0)
180 filetab->suffix = ".pyo";
181 }
182 }
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000183}
184
Guido van Rossum25ce5661997-08-02 03:10:38 +0000185void
Just van Rossum52e14d62002-12-30 22:08:05 +0000186_PyImportHooks_Init(void)
187{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000188 PyObject *v, *path_hooks = NULL, *zimpimport;
189 int err = 0;
Just van Rossum52e14d62002-12-30 22:08:05 +0000190
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000191 /* adding sys.path_hooks and sys.path_importer_cache, setting up
192 zipimport */
193 if (PyType_Ready(&PyNullImporter_Type) < 0)
194 goto error;
Just van Rossum52e14d62002-12-30 22:08:05 +0000195
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000196 if (Py_VerboseFlag)
197 PySys_WriteStderr("# installing zipimport hook\n");
Just van Rossum52e14d62002-12-30 22:08:05 +0000198
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000199 v = PyList_New(0);
200 if (v == NULL)
201 goto error;
202 err = PySys_SetObject("meta_path", v);
203 Py_DECREF(v);
204 if (err)
205 goto error;
206 v = PyDict_New();
207 if (v == NULL)
208 goto error;
209 err = PySys_SetObject("path_importer_cache", v);
210 Py_DECREF(v);
211 if (err)
212 goto error;
213 path_hooks = PyList_New(0);
214 if (path_hooks == NULL)
215 goto error;
216 err = PySys_SetObject("path_hooks", path_hooks);
217 if (err) {
Just van Rossum52e14d62002-12-30 22:08:05 +0000218 error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000219 PyErr_Print();
220 Py_FatalError("initializing sys.meta_path, sys.path_hooks, "
221 "path_importer_cache, or NullImporter failed"
222 );
223 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000224
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000225 zimpimport = PyImport_ImportModule("zipimport");
226 if (zimpimport == NULL) {
227 PyErr_Clear(); /* No zip import module -- okay */
228 if (Py_VerboseFlag)
229 PySys_WriteStderr("# can't import zipimport\n");
230 }
231 else {
232 PyObject *zipimporter = PyObject_GetAttrString(zimpimport,
233 "zipimporter");
234 Py_DECREF(zimpimport);
235 if (zipimporter == NULL) {
236 PyErr_Clear(); /* No zipimporter object -- okay */
237 if (Py_VerboseFlag)
238 PySys_WriteStderr(
239 "# can't import zipimport.zipimporter\n");
240 }
241 else {
242 /* sys.path_hooks.append(zipimporter) */
243 err = PyList_Append(path_hooks, zipimporter);
244 Py_DECREF(zipimporter);
245 if (err)
246 goto error;
247 if (Py_VerboseFlag)
248 PySys_WriteStderr(
249 "# installed zipimport hook\n");
250 }
251 }
252 Py_DECREF(path_hooks);
Just van Rossum52e14d62002-12-30 22:08:05 +0000253}
254
255void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000256_PyImport_Fini(void)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000257{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000258 Py_XDECREF(extensions);
259 extensions = NULL;
260 PyMem_DEL(_PyImport_Filetab);
261 _PyImport_Filetab = NULL;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000262}
263
264
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000265/* Locking primitives to prevent parallel imports of the same module
266 in different threads to return with a partially loaded module.
267 These calls are serialized by the global interpreter lock. */
268
269#ifdef WITH_THREAD
270
Guido van Rossum49b56061998-10-01 20:42:43 +0000271#include "pythread.h"
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000272
Guido van Rossum65d5b571998-12-21 19:32:43 +0000273static PyThread_type_lock import_lock = 0;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000274static long import_lock_thread = -1;
275static int import_lock_level = 0;
276
Benjamin Peterson0df35a92009-10-04 20:32:25 +0000277void
278_PyImport_AcquireLock(void)
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000279{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000280 long me = PyThread_get_thread_ident();
281 if (me == -1)
282 return; /* Too bad */
283 if (import_lock == NULL) {
284 import_lock = PyThread_allocate_lock();
285 if (import_lock == NULL)
286 return; /* Nothing much we can do. */
287 }
288 if (import_lock_thread == me) {
289 import_lock_level++;
290 return;
291 }
292 if (import_lock_thread != -1 || !PyThread_acquire_lock(import_lock, 0))
293 {
294 PyThreadState *tstate = PyEval_SaveThread();
295 PyThread_acquire_lock(import_lock, 1);
296 PyEval_RestoreThread(tstate);
297 }
298 import_lock_thread = me;
299 import_lock_level = 1;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000300}
301
Benjamin Peterson0df35a92009-10-04 20:32:25 +0000302int
303_PyImport_ReleaseLock(void)
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000304{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000305 long me = PyThread_get_thread_ident();
306 if (me == -1 || import_lock == NULL)
307 return 0; /* Too bad */
308 if (import_lock_thread != me)
309 return -1;
310 import_lock_level--;
311 if (import_lock_level == 0) {
312 import_lock_thread = -1;
313 PyThread_release_lock(import_lock);
314 }
315 return 1;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000316}
317
Gregory P. Smith24cec9f2010-03-01 06:18:41 +0000318/* This function is called from PyOS_AfterFork to ensure that newly
319 created child processes do not share locks with the parent.
320 We now acquire the import lock around fork() calls but on some platforms
321 (Solaris 9 and earlier? see isue7242) that still left us with problems. */
Guido van Rossum8ee3e5a2005-09-14 18:09:42 +0000322
323void
324_PyImport_ReInitLock(void)
325{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000326 if (import_lock != NULL)
327 import_lock = PyThread_allocate_lock();
Nick Coghlanb2ddf792010-12-02 04:11:46 +0000328 if (import_lock_level > 1) {
329 /* Forked as a side effect of import */
330 long me = PyThread_get_thread_ident();
331 PyThread_acquire_lock(import_lock, 0);
Victor Stinner942003c2011-03-07 16:57:48 +0100332 /* XXX: can the previous line fail? */
Nick Coghlanb2ddf792010-12-02 04:11:46 +0000333 import_lock_thread = me;
334 import_lock_level--;
335 } else {
336 import_lock_thread = -1;
337 import_lock_level = 0;
338 }
Guido van Rossum8ee3e5a2005-09-14 18:09:42 +0000339}
340
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000341#endif
342
Tim Peters69232342001-08-30 05:16:13 +0000343static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000344imp_lock_held(PyObject *self, PyObject *noargs)
Tim Peters69232342001-08-30 05:16:13 +0000345{
Tim Peters69232342001-08-30 05:16:13 +0000346#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000347 return PyBool_FromLong(import_lock_thread != -1);
Tim Peters69232342001-08-30 05:16:13 +0000348#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000349 return PyBool_FromLong(0);
Tim Peters69232342001-08-30 05:16:13 +0000350#endif
351}
352
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000353static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000354imp_acquire_lock(PyObject *self, PyObject *noargs)
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000355{
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000356#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000357 _PyImport_AcquireLock();
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000358#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000359 Py_INCREF(Py_None);
360 return Py_None;
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000361}
362
363static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000364imp_release_lock(PyObject *self, PyObject *noargs)
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000365{
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000366#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000367 if (_PyImport_ReleaseLock() < 0) {
368 PyErr_SetString(PyExc_RuntimeError,
369 "not holding the import lock");
370 return NULL;
371 }
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000372#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000373 Py_INCREF(Py_None);
374 return Py_None;
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000375}
376
Guido van Rossumd8faa362007-04-27 19:54:29 +0000377static void
378imp_modules_reloading_clear(void)
379{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000380 PyInterpreterState *interp = PyThreadState_Get()->interp;
381 if (interp->modules_reloading != NULL)
382 PyDict_Clear(interp->modules_reloading);
Guido van Rossumd8faa362007-04-27 19:54:29 +0000383}
384
Guido van Rossum25ce5661997-08-02 03:10:38 +0000385/* Helper for sys */
386
387PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000388PyImport_GetModuleDict(void)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000389{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000390 PyInterpreterState *interp = PyThreadState_GET()->interp;
391 if (interp->modules == NULL)
392 Py_FatalError("PyImport_GetModuleDict: no module dictionary!");
393 return interp->modules;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000394}
395
Guido van Rossum3f5da241990-12-20 15:06:42 +0000396
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000397/* List of names to clear in sys */
398static char* sys_deletes[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000399 "path", "argv", "ps1", "ps2",
400 "last_type", "last_value", "last_traceback",
401 "path_hooks", "path_importer_cache", "meta_path",
402 /* misc stuff */
403 "flags", "float_info",
404 NULL
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000405};
406
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000407static char* sys_files[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000408 "stdin", "__stdin__",
409 "stdout", "__stdout__",
410 "stderr", "__stderr__",
411 NULL
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000412};
413
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000414
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000415/* Un-initialize things, as good as we can */
Guido van Rossum3f5da241990-12-20 15:06:42 +0000416
Guido van Rossum3f5da241990-12-20 15:06:42 +0000417void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000418PyImport_Cleanup(void)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000419{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000420 Py_ssize_t pos, ndone;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000421 PyObject *key, *value, *dict;
422 PyInterpreterState *interp = PyThreadState_GET()->interp;
423 PyObject *modules = interp->modules;
Guido van Rossum758eec01998-01-19 21:58:26 +0000424
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000425 if (modules == NULL)
426 return; /* Already done */
Guido van Rossum758eec01998-01-19 21:58:26 +0000427
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000428 /* Delete some special variables first. These are common
429 places where user values hide and people complain when their
430 destructors fail. Since the modules containing them are
431 deleted *last* of all, they would come too late in the normal
432 destruction order. Sigh. */
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000433
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000434 value = PyDict_GetItemString(modules, "builtins");
435 if (value != NULL && PyModule_Check(value)) {
436 dict = PyModule_GetDict(value);
437 if (Py_VerboseFlag)
438 PySys_WriteStderr("# clear builtins._\n");
439 PyDict_SetItemString(dict, "_", Py_None);
440 }
441 value = PyDict_GetItemString(modules, "sys");
442 if (value != NULL && PyModule_Check(value)) {
443 char **p;
444 PyObject *v;
445 dict = PyModule_GetDict(value);
446 for (p = sys_deletes; *p != NULL; p++) {
447 if (Py_VerboseFlag)
448 PySys_WriteStderr("# clear sys.%s\n", *p);
449 PyDict_SetItemString(dict, *p, Py_None);
450 }
451 for (p = sys_files; *p != NULL; p+=2) {
452 if (Py_VerboseFlag)
453 PySys_WriteStderr("# restore sys.%s\n", *p);
454 v = PyDict_GetItemString(dict, *(p+1));
455 if (v == NULL)
456 v = Py_None;
457 PyDict_SetItemString(dict, *p, v);
458 }
459 }
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000460
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000461 /* First, delete __main__ */
462 value = PyDict_GetItemString(modules, "__main__");
463 if (value != NULL && PyModule_Check(value)) {
464 if (Py_VerboseFlag)
465 PySys_WriteStderr("# cleanup __main__\n");
466 _PyModule_Clear(value);
467 PyDict_SetItemString(modules, "__main__", Py_None);
468 }
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000469
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000470 /* The special treatment of "builtins" here is because even
471 when it's not referenced as a module, its dictionary is
472 referenced by almost every module's __builtins__. Since
473 deleting a module clears its dictionary (even if there are
474 references left to it), we need to delete the "builtins"
475 module last. Likewise, we don't delete sys until the very
476 end because it is implicitly referenced (e.g. by print).
Guido van Rossum758eec01998-01-19 21:58:26 +0000477
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000478 Also note that we 'delete' modules by replacing their entry
479 in the modules dict with None, rather than really deleting
480 them; this avoids a rehash of the modules dictionary and
481 also marks them as "non existent" so they won't be
482 re-imported. */
Guido van Rossum758eec01998-01-19 21:58:26 +0000483
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000484 /* Next, repeatedly delete modules with a reference count of
485 one (skipping builtins and sys) and delete them */
486 do {
487 ndone = 0;
488 pos = 0;
489 while (PyDict_Next(modules, &pos, &key, &value)) {
490 if (value->ob_refcnt != 1)
491 continue;
492 if (PyUnicode_Check(key) && PyModule_Check(value)) {
Victor Stinner9464d612011-03-07 17:08:21 +0100493 if (PyUnicode_CompareWithASCIIString(key, "builtins") == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000494 continue;
Victor Stinner9464d612011-03-07 17:08:21 +0100495 if (PyUnicode_CompareWithASCIIString(key, "sys") == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000496 continue;
497 if (Py_VerboseFlag)
Victor Stinner9464d612011-03-07 17:08:21 +0100498 PySys_FormatStderr(
499 "# cleanup[1] %U\n", key);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000500 _PyModule_Clear(value);
501 PyDict_SetItem(modules, key, Py_None);
502 ndone++;
503 }
504 }
505 } while (ndone > 0);
Guido van Rossum758eec01998-01-19 21:58:26 +0000506
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000507 /* Next, delete all modules (still skipping builtins and sys) */
508 pos = 0;
509 while (PyDict_Next(modules, &pos, &key, &value)) {
510 if (PyUnicode_Check(key) && PyModule_Check(value)) {
Victor Stinner9464d612011-03-07 17:08:21 +0100511 if (PyUnicode_CompareWithASCIIString(key, "builtins") == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000512 continue;
Victor Stinner9464d612011-03-07 17:08:21 +0100513 if (PyUnicode_CompareWithASCIIString(key, "sys") == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000514 continue;
515 if (Py_VerboseFlag)
Victor Stinner9464d612011-03-07 17:08:21 +0100516 PySys_FormatStderr("# cleanup[2] %U\n", key);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000517 _PyModule_Clear(value);
518 PyDict_SetItem(modules, key, Py_None);
519 }
520 }
Guido van Rossum758eec01998-01-19 21:58:26 +0000521
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000522 /* Next, delete sys and builtins (in that order) */
523 value = PyDict_GetItemString(modules, "sys");
524 if (value != NULL && PyModule_Check(value)) {
525 if (Py_VerboseFlag)
526 PySys_WriteStderr("# cleanup sys\n");
527 _PyModule_Clear(value);
528 PyDict_SetItemString(modules, "sys", Py_None);
529 }
530 value = PyDict_GetItemString(modules, "builtins");
531 if (value != NULL && PyModule_Check(value)) {
532 if (Py_VerboseFlag)
533 PySys_WriteStderr("# cleanup builtins\n");
534 _PyModule_Clear(value);
535 PyDict_SetItemString(modules, "builtins", Py_None);
536 }
Guido van Rossum758eec01998-01-19 21:58:26 +0000537
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000538 /* Finally, clear and delete the modules directory */
539 PyDict_Clear(modules);
540 interp->modules = NULL;
541 Py_DECREF(modules);
542 Py_CLEAR(interp->modules_reloading);
Guido van Rossum8d15b5d1990-10-26 14:58:58 +0000543}
Guido van Rossum7f133ed1991-02-19 12:23:57 +0000544
545
Barry Warsaw28a691b2010-04-17 00:19:56 +0000546/* Helper for pythonrun.c -- return magic number and tag. */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000547
548long
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000549PyImport_GetMagicNumber(void)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000550{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000551 return pyc_magic;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000552}
553
554
Barry Warsaw28a691b2010-04-17 00:19:56 +0000555const char *
556PyImport_GetMagicTag(void)
557{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000558 return pyc_tag;
Barry Warsaw28a691b2010-04-17 00:19:56 +0000559}
560
Guido van Rossum25ce5661997-08-02 03:10:38 +0000561/* Magic for extension modules (built-in as well as dynamically
562 loaded). To prevent initializing an extension module more than
563 once, we keep a static dictionary 'extensions' keyed by module name
564 (for built-in modules) or by filename (for dynamically loaded
Barry Warsaw92883382001-08-13 23:05:44 +0000565 modules), containing these modules. A copy of the module's
Victor Stinner95872862011-03-07 18:20:56 +0100566 dictionary is stored by calling _PyImport_FixupExtensionObject()
Guido van Rossum25ce5661997-08-02 03:10:38 +0000567 immediately after the module initialization function succeeds. A
568 copy can be retrieved from there by calling
Victor Stinner95872862011-03-07 18:20:56 +0100569 _PyImport_FindExtensionObject().
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000570
Barry Warsaw7c9627b2010-06-17 18:38:20 +0000571 Modules which do support multiple initialization set their m_size
572 field to a non-negative number (indicating the size of the
573 module-specific state). They are still recorded in the extensions
574 dictionary, to avoid loading shared libraries twice.
Martin v. Löwis1a214512008-06-11 05:26:20 +0000575*/
576
577int
Victor Stinner95872862011-03-07 18:20:56 +0100578_PyImport_FixupExtensionObject(PyObject *mod, PyObject *name,
579 PyObject *filename)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000580{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000581 PyObject *modules, *dict;
582 struct PyModuleDef *def;
583 if (extensions == NULL) {
584 extensions = PyDict_New();
585 if (extensions == NULL)
586 return -1;
587 }
588 if (mod == NULL || !PyModule_Check(mod)) {
589 PyErr_BadInternalCall();
590 return -1;
591 }
592 def = PyModule_GetDef(mod);
593 if (!def) {
594 PyErr_BadInternalCall();
595 return -1;
596 }
597 modules = PyImport_GetModuleDict();
Victor Stinner95872862011-03-07 18:20:56 +0100598 if (PyDict_SetItem(modules, name, mod) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000599 return -1;
600 if (_PyState_AddModule(mod, def) < 0) {
Victor Stinner95872862011-03-07 18:20:56 +0100601 PyDict_DelItem(modules, name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000602 return -1;
603 }
604 if (def->m_size == -1) {
605 if (def->m_base.m_copy) {
606 /* Somebody already imported the module,
607 likely under a different name.
608 XXX this should really not happen. */
609 Py_DECREF(def->m_base.m_copy);
610 def->m_base.m_copy = NULL;
611 }
612 dict = PyModule_GetDict(mod);
613 if (dict == NULL)
614 return -1;
615 def->m_base.m_copy = PyDict_Copy(dict);
616 if (def->m_base.m_copy == NULL)
617 return -1;
618 }
Victor Stinner49d3f252010-10-17 01:24:53 +0000619 PyDict_SetItem(extensions, filename, (PyObject*)def);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000620 return 0;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000621}
622
Victor Stinner49d3f252010-10-17 01:24:53 +0000623int
624_PyImport_FixupBuiltin(PyObject *mod, char *name)
625{
626 int res;
Victor Stinner95872862011-03-07 18:20:56 +0100627 PyObject *nameobj;
Victor Stinner21fcd0c2011-03-07 18:28:15 +0100628 nameobj = PyUnicode_InternFromString(name);
Victor Stinner95872862011-03-07 18:20:56 +0100629 if (nameobj == NULL)
Victor Stinner49d3f252010-10-17 01:24:53 +0000630 return -1;
Victor Stinner95872862011-03-07 18:20:56 +0100631 res = _PyImport_FixupExtensionObject(mod, nameobj, nameobj);
632 Py_DECREF(nameobj);
Victor Stinner49d3f252010-10-17 01:24:53 +0000633 return res;
634}
635
Guido van Rossum25ce5661997-08-02 03:10:38 +0000636PyObject *
Victor Stinner95872862011-03-07 18:20:56 +0100637_PyImport_FindExtensionObject(PyObject *name, PyObject *filename)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000638{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000639 PyObject *mod, *mdict;
640 PyModuleDef* def;
641 if (extensions == NULL)
642 return NULL;
Victor Stinner49d3f252010-10-17 01:24:53 +0000643 def = (PyModuleDef*)PyDict_GetItem(extensions, filename);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000644 if (def == NULL)
645 return NULL;
646 if (def->m_size == -1) {
647 /* Module does not support repeated initialization */
648 if (def->m_base.m_copy == NULL)
649 return NULL;
Victor Stinner95872862011-03-07 18:20:56 +0100650 mod = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000651 if (mod == NULL)
652 return NULL;
653 mdict = PyModule_GetDict(mod);
654 if (mdict == NULL)
655 return NULL;
656 if (PyDict_Update(mdict, def->m_base.m_copy))
657 return NULL;
658 }
659 else {
660 if (def->m_base.m_init == NULL)
661 return NULL;
662 mod = def->m_base.m_init();
663 if (mod == NULL)
664 return NULL;
Victor Stinner95872862011-03-07 18:20:56 +0100665 PyDict_SetItem(PyImport_GetModuleDict(), name, mod);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000666 Py_DECREF(mod);
667 }
668 if (_PyState_AddModule(mod, def) < 0) {
Victor Stinner95872862011-03-07 18:20:56 +0100669 PyDict_DelItem(PyImport_GetModuleDict(), name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000670 Py_DECREF(mod);
671 return NULL;
672 }
673 if (Py_VerboseFlag)
Victor Stinner95872862011-03-07 18:20:56 +0100674 PySys_FormatStderr("import %U # previously loaded (%R)\n",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000675 name, filename);
676 return mod;
Brett Cannon9a5b25a2010-03-01 02:09:17 +0000677
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000678}
679
Victor Stinner49d3f252010-10-17 01:24:53 +0000680PyObject *
Victor Stinner501c09a2011-02-23 00:02:00 +0000681_PyImport_FindBuiltin(const char *name)
Victor Stinner49d3f252010-10-17 01:24:53 +0000682{
Victor Stinner95872862011-03-07 18:20:56 +0100683 PyObject *res, *nameobj;
Victor Stinner21fcd0c2011-03-07 18:28:15 +0100684 nameobj = PyUnicode_InternFromString(name);
Victor Stinner95872862011-03-07 18:20:56 +0100685 if (nameobj == NULL)
Victor Stinner49d3f252010-10-17 01:24:53 +0000686 return NULL;
Victor Stinner95872862011-03-07 18:20:56 +0100687 res = _PyImport_FindExtensionObject(nameobj, nameobj);
688 Py_DECREF(nameobj);
Victor Stinner49d3f252010-10-17 01:24:53 +0000689 return res;
690}
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000691
692/* Get the module object corresponding to a module name.
693 First check the modules dictionary if there's one there,
Walter Dörwaldf0dfc7a2003-10-20 14:01:56 +0000694 if not, create a new one and insert it in the modules dictionary.
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000695 Because the former action is most common, THIS DOES NOT RETURN A
696 'NEW' REFERENCE! */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000697
Guido van Rossum79f25d91997-04-29 20:08:16 +0000698PyObject *
Victor Stinner27ee0892011-03-04 12:57:09 +0000699PyImport_AddModuleObject(PyObject *name)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000700{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000701 PyObject *modules = PyImport_GetModuleDict();
702 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000703
Victor Stinner27ee0892011-03-04 12:57:09 +0000704 if ((m = PyDict_GetItem(modules, name)) != NULL &&
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000705 PyModule_Check(m))
706 return m;
Victor Stinner27ee0892011-03-04 12:57:09 +0000707 m = PyModule_NewObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000708 if (m == NULL)
709 return NULL;
Victor Stinner27ee0892011-03-04 12:57:09 +0000710 if (PyDict_SetItem(modules, name, m) != 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000711 Py_DECREF(m);
712 return NULL;
713 }
714 Py_DECREF(m); /* Yes, it still exists, in modules! */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000715
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000716 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000717}
718
Victor Stinner27ee0892011-03-04 12:57:09 +0000719PyObject *
720PyImport_AddModule(const char *name)
721{
722 PyObject *nameobj, *module;
723 nameobj = PyUnicode_FromString(name);
724 if (nameobj == NULL)
725 return NULL;
726 module = PyImport_AddModuleObject(nameobj);
727 Py_DECREF(nameobj);
728 return module;
729}
730
731
Tim Peters1cd70172004-08-02 03:52:12 +0000732/* Remove name from sys.modules, if it's there. */
733static void
Victor Stinner27ee0892011-03-04 12:57:09 +0000734remove_module(PyObject *name)
Tim Peters1cd70172004-08-02 03:52:12 +0000735{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000736 PyObject *modules = PyImport_GetModuleDict();
Victor Stinner27ee0892011-03-04 12:57:09 +0000737 if (PyDict_GetItem(modules, name) == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000738 return;
Victor Stinner27ee0892011-03-04 12:57:09 +0000739 if (PyDict_DelItem(modules, name) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000740 Py_FatalError("import: deleting existing key in"
741 "sys.modules failed");
Tim Peters1cd70172004-08-02 03:52:12 +0000742}
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000743
Barry Warsaw28a691b2010-04-17 00:19:56 +0000744static PyObject * get_sourcefile(char *file);
745static char *make_source_pathname(char *pathname, char *buf);
746static char *make_compiled_pathname(char *pathname, char *buf, size_t buflen,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000747 int debug);
Christian Heimes3b06e532008-01-07 20:12:44 +0000748
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000749/* Execute a code object in a module and return the module object
Tim Peters1cd70172004-08-02 03:52:12 +0000750 * WITH INCREMENTED REFERENCE COUNT. If an error occurs, name is
751 * removed from sys.modules, to avoid leaving damaged module objects
752 * in sys.modules. The caller may wish to restore the original
753 * module object (if any) in this case; PyImport_ReloadModule is an
754 * example.
Barry Warsaw28a691b2010-04-17 00:19:56 +0000755 *
756 * Note that PyImport_ExecCodeModuleWithPathnames() is the preferred, richer
757 * interface. The other two exist primarily for backward compatibility.
Tim Peters1cd70172004-08-02 03:52:12 +0000758 */
Guido van Rossum79f25d91997-04-29 20:08:16 +0000759PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000760PyImport_ExecCodeModule(char *name, PyObject *co)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000761{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000762 return PyImport_ExecCodeModuleWithPathnames(
763 name, co, (char *)NULL, (char *)NULL);
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000764}
765
766PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000767PyImport_ExecCodeModuleEx(char *name, PyObject *co, char *pathname)
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000768{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000769 return PyImport_ExecCodeModuleWithPathnames(
770 name, co, pathname, (char *)NULL);
Barry Warsaw28a691b2010-04-17 00:19:56 +0000771}
772
773PyObject *
774PyImport_ExecCodeModuleWithPathnames(char *name, PyObject *co, char *pathname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000775 char *cpathname)
Barry Warsaw28a691b2010-04-17 00:19:56 +0000776{
Victor Stinner27ee0892011-03-04 12:57:09 +0000777 PyObject *m = NULL;
778 PyObject *nameobj, *pathobj = NULL, *cpathobj = NULL;
779
780 nameobj = PyUnicode_FromString(name);
781 if (nameobj == NULL)
782 return NULL;
783
784 if (pathname != NULL) {
785 pathobj = PyUnicode_DecodeFSDefault(pathname);
786 if (pathobj == NULL)
787 goto error;
788 } else
789 pathobj = NULL;
790 if (cpathname != NULL) {
791 cpathobj = PyUnicode_DecodeFSDefault(cpathname);
792 if (cpathobj == NULL)
793 goto error;
794 } else
795 cpathobj = NULL;
796 m = PyImport_ExecCodeModuleObject(nameobj, co, pathobj, cpathobj);
797error:
798 Py_DECREF(nameobj);
799 Py_XDECREF(pathobj);
800 Py_XDECREF(cpathobj);
801 return m;
802}
803
804PyObject*
805PyImport_ExecCodeModuleObject(PyObject *name, PyObject *co, PyObject *pathname,
806 PyObject *cpathname)
807{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000808 PyObject *modules = PyImport_GetModuleDict();
809 PyObject *m, *d, *v;
Victor Stinner27ee0892011-03-04 12:57:09 +0000810 PyObject *pathbytes;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000811
Victor Stinner27ee0892011-03-04 12:57:09 +0000812 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000813 if (m == NULL)
814 return NULL;
815 /* If the module is being reloaded, we get the old module back
816 and re-use its dict to exec the new code. */
817 d = PyModule_GetDict(m);
818 if (PyDict_GetItemString(d, "__builtins__") == NULL) {
819 if (PyDict_SetItemString(d, "__builtins__",
820 PyEval_GetBuiltins()) != 0)
821 goto error;
822 }
823 /* Remember the filename as the __file__ attribute */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000824 if (pathname != NULL) {
Victor Stinner27ee0892011-03-04 12:57:09 +0000825 pathbytes = PyUnicode_EncodeFSDefault(pathname);
826 if (pathbytes != NULL) {
827 v = get_sourcefile(PyBytes_AS_STRING(pathbytes));
828 Py_DECREF(pathbytes);
829 } else
830 v = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000831 if (v == NULL)
832 PyErr_Clear();
833 }
Victor Stinner27ee0892011-03-04 12:57:09 +0000834 else
835 v = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000836 if (v == NULL) {
837 v = ((PyCodeObject *)co)->co_filename;
838 Py_INCREF(v);
839 }
840 if (PyDict_SetItemString(d, "__file__", v) != 0)
841 PyErr_Clear(); /* Not important enough to report */
842 Py_DECREF(v);
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000843
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000844 /* Remember the pyc path name as the __cached__ attribute. */
Victor Stinner27ee0892011-03-04 12:57:09 +0000845 if (cpathname != NULL)
846 v = cpathname;
847 else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000848 v = Py_None;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000849 if (PyDict_SetItemString(d, "__cached__", v) != 0)
850 PyErr_Clear(); /* Not important enough to report */
Barry Warsaw28a691b2010-04-17 00:19:56 +0000851
Martin v. Löwis4d0d4712010-12-03 20:14:31 +0000852 v = PyEval_EvalCode(co, d, d);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000853 if (v == NULL)
854 goto error;
855 Py_DECREF(v);
Guido van Rossumb65e85c1997-07-10 18:00:45 +0000856
Victor Stinner27ee0892011-03-04 12:57:09 +0000857 if ((m = PyDict_GetItem(modules, name)) == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000858 PyErr_Format(PyExc_ImportError,
Victor Stinner27ee0892011-03-04 12:57:09 +0000859 "Loaded module %R not found in sys.modules",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000860 name);
861 return NULL;
862 }
Guido van Rossumb65e85c1997-07-10 18:00:45 +0000863
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000864 Py_INCREF(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000865
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000866 return m;
Tim Peters1cd70172004-08-02 03:52:12 +0000867
868 error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000869 remove_module(name);
870 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000871}
872
873
Barry Warsaw28a691b2010-04-17 00:19:56 +0000874/* Like strrchr(string, '/') but searches for the rightmost of either SEP
875 or ALTSEP, if the latter is defined.
876*/
877static char *
878rightmost_sep(char *s)
879{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000880 char *found, c;
881 for (found = NULL; (c = *s); s++) {
882 if (c == SEP
Barry Warsaw28a691b2010-04-17 00:19:56 +0000883#ifdef ALTSEP
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000884 || c == ALTSEP
Barry Warsaw28a691b2010-04-17 00:19:56 +0000885#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000886 )
887 {
888 found = s;
889 }
890 }
891 return found;
Barry Warsaw28a691b2010-04-17 00:19:56 +0000892}
893
894
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000895/* Given a pathname for a Python source file, fill a buffer with the
896 pathname for the corresponding compiled file. Return the pathname
897 for the compiled file, or NULL if there's no space in the buffer.
898 Doesn't set an exception. */
899
900static char *
Barry Warsaw28a691b2010-04-17 00:19:56 +0000901make_compiled_pathname(char *pathname, char *buf, size_t buflen, int debug)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000902{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000903 /* foo.py -> __pycache__/foo.<tag>.pyc */
904 size_t len = strlen(pathname);
905 size_t i, save;
906 char *pos;
907 int sep = SEP;
Barry Warsaw28a691b2010-04-17 00:19:56 +0000908
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000909 /* Sanity check that the buffer has roughly enough space to hold what
910 will eventually be the full path to the compiled file. The 5 extra
911 bytes include the slash afer __pycache__, the two extra dots, the
912 extra trailing character ('c' or 'o') and null. This isn't exact
913 because the contents of the buffer can affect how many actual
914 characters of the string get into the buffer. We'll do a final
915 sanity check before writing the extension to ensure we do not
916 overflow the buffer.
917 */
918 if (len + strlen(CACHEDIR) + strlen(pyc_tag) + 5 > buflen)
919 return NULL;
Tim Petersc1731372001-08-04 08:12:36 +0000920
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000921 /* Find the last path separator and copy everything from the start of
922 the source string up to and including the separator.
923 */
924 if ((pos = rightmost_sep(pathname)) == NULL) {
925 i = 0;
926 }
927 else {
928 sep = *pos;
929 i = pos - pathname + 1;
930 strncpy(buf, pathname, i);
931 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000932
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000933 save = i;
934 buf[i++] = '\0';
935 /* Add __pycache__/ */
936 strcat(buf, CACHEDIR);
937 i += strlen(CACHEDIR) - 1;
938 buf[i++] = sep;
939 buf[i++] = '\0';
940 /* Add the base filename, but remove the .py or .pyw extension, since
941 the tag name must go before the extension.
942 */
943 strcat(buf, pathname + save);
944 if ((pos = strrchr(buf, '.')) != NULL)
945 *++pos = '\0';
946 strcat(buf, pyc_tag);
947 /* The length test above assumes that we're only adding one character
948 to the end of what would normally be the extension. What if there
949 is no extension, or the string ends in '.' or '.p', and otherwise
950 fills the buffer? By appending 4 more characters onto the string
951 here, we could overrun the buffer.
Barry Warsaw28a691b2010-04-17 00:19:56 +0000952
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000953 As a simple example, let's say buflen=32 and the input string is
954 'xxx.py'. strlen() would be 6 and the test above would yield:
Barry Warsaw28a691b2010-04-17 00:19:56 +0000955
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000956 (6 + 11 + 10 + 5 == 32) > 32
Barry Warsaw28a691b2010-04-17 00:19:56 +0000957
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000958 which is false and so the name mangling would continue. This would
959 be fine because we'd end up with this string in buf:
Barry Warsaw28a691b2010-04-17 00:19:56 +0000960
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000961 __pycache__/xxx.cpython-32.pyc\0
Barry Warsaw28a691b2010-04-17 00:19:56 +0000962
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000963 strlen(of that) == 30 + the nul fits inside a 32 character buffer.
964 We can even handle an input string of say 'xxxxx' above because
965 that's (5 + 11 + 10 + 5 == 31) > 32 which is also false. Name
966 mangling that yields:
Barry Warsaw28a691b2010-04-17 00:19:56 +0000967
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000968 __pycache__/xxxxxcpython-32.pyc\0
Barry Warsaw28a691b2010-04-17 00:19:56 +0000969
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000970 which is 32 characters including the nul, and thus fits in the
971 buffer. However, an input string of 'xxxxxx' would yield a result
972 string of:
Barry Warsaw28a691b2010-04-17 00:19:56 +0000973
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000974 __pycache__/xxxxxxcpython-32.pyc\0
Barry Warsaw28a691b2010-04-17 00:19:56 +0000975
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000976 which is 33 characters long (including the nul), thus overflowing
977 the buffer, even though the first test would fail, i.e.: the input
978 string is also 6 characters long, so 32 > 32 is false.
Barry Warsaw28a691b2010-04-17 00:19:56 +0000979
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000980 The reason the first test fails but we still overflow the buffer is
981 that the test above only expects to add one extra character to be
982 added to the extension, and here we're adding three (pyc). We
983 don't add the first dot, so that reclaims one of expected
984 positions, leaving us overflowing by 1 byte (3 extra - 1 reclaimed
985 dot - 1 expected extra == 1 overflowed).
Barry Warsaw28a691b2010-04-17 00:19:56 +0000986
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000987 The best we can do is ensure that we still have enough room in the
988 target buffer before we write the extension. Because it's always
989 only the extension that can cause the overflow, and never the other
990 path bytes we've written, it's sufficient to just do one more test
991 here. Still, the assertion that follows can't hurt.
992 */
Barry Warsaw28a691b2010-04-17 00:19:56 +0000993#if 0
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000994 printf("strlen(buf): %d; buflen: %d\n", (int)strlen(buf), (int)buflen);
Barry Warsaw28a691b2010-04-17 00:19:56 +0000995#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000996 if (strlen(buf) + 5 > buflen)
997 return NULL;
998 strcat(buf, debug ? ".pyc" : ".pyo");
999 assert(strlen(buf) < buflen);
1000 return buf;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001001}
1002
1003
Barry Warsaw28a691b2010-04-17 00:19:56 +00001004/* Given a pathname to a Python byte compiled file, return the path to the
1005 source file, if the path matches the PEP 3147 format. This does not check
1006 for any file existence, however, if the pyc file name does not match PEP
1007 3147 style, NULL is returned. buf must be at least as big as pathname;
1008 the resulting path will always be shorter. */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001009
Barry Warsaw28a691b2010-04-17 00:19:56 +00001010static char *
1011make_source_pathname(char *pathname, char *buf)
1012{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001013 /* __pycache__/foo.<tag>.pyc -> foo.py */
1014 size_t i, j;
1015 char *left, *right, *dot0, *dot1, sep;
Barry Warsaw28a691b2010-04-17 00:19:56 +00001016
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001017 /* Look back two slashes from the end. In between these two slashes
1018 must be the string __pycache__ or this is not a PEP 3147 style
1019 path. It's possible for there to be only one slash.
1020 */
1021 if ((right = rightmost_sep(pathname)) == NULL)
1022 return NULL;
1023 sep = *right;
1024 *right = '\0';
1025 left = rightmost_sep(pathname);
1026 *right = sep;
1027 if (left == NULL)
1028 left = pathname;
1029 else
1030 left++;
1031 if (right-left != strlen(CACHEDIR) ||
1032 strncmp(left, CACHEDIR, right-left) != 0)
1033 return NULL;
Barry Warsaw28a691b2010-04-17 00:19:56 +00001034
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001035 /* Now verify that the path component to the right of the last slash
1036 has two dots in it.
1037 */
1038 if ((dot0 = strchr(right + 1, '.')) == NULL)
1039 return NULL;
1040 if ((dot1 = strchr(dot0 + 1, '.')) == NULL)
1041 return NULL;
1042 /* Too many dots? */
1043 if (strchr(dot1 + 1, '.') != NULL)
1044 return NULL;
Barry Warsaw28a691b2010-04-17 00:19:56 +00001045
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001046 /* This is a PEP 3147 path. Start by copying everything from the
1047 start of pathname up to and including the leftmost slash. Then
1048 copy the file's basename, removing the magic tag and adding a .py
1049 suffix.
1050 */
1051 strncpy(buf, pathname, (i=left-pathname));
1052 strncpy(buf+i, right+1, (j=dot0-right));
1053 strcpy(buf+i+j, "py");
1054 return buf;
Barry Warsaw28a691b2010-04-17 00:19:56 +00001055}
1056
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001057/* Given a pathname for a Python source file, its time of last
1058 modification, and a pathname for a compiled file, check whether the
1059 compiled file represents the same version of the source. If so,
1060 return a FILE pointer for the compiled file, positioned just after
1061 the header; if not, return NULL.
1062 Doesn't set an exception. */
1063
1064static FILE *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001065check_compiled_module(char *pathname, time_t mtime, char *cpathname)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001066{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001067 FILE *fp;
1068 long magic;
1069 long pyc_mtime;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001070
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001071 fp = fopen(cpathname, "rb");
1072 if (fp == NULL)
1073 return NULL;
1074 magic = PyMarshal_ReadLongFromFile(fp);
1075 if (magic != pyc_magic) {
1076 if (Py_VerboseFlag)
1077 PySys_WriteStderr("# %s has bad magic\n", cpathname);
1078 fclose(fp);
1079 return NULL;
1080 }
1081 pyc_mtime = PyMarshal_ReadLongFromFile(fp);
1082 if (pyc_mtime != mtime) {
1083 if (Py_VerboseFlag)
1084 PySys_WriteStderr("# %s has bad mtime\n", cpathname);
1085 fclose(fp);
1086 return NULL;
1087 }
1088 if (Py_VerboseFlag)
1089 PySys_WriteStderr("# %s matches %s\n", cpathname, pathname);
1090 return fp;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001091}
1092
1093
1094/* Read a code object from a file and check it for validity */
1095
Guido van Rossum79f25d91997-04-29 20:08:16 +00001096static PyCodeObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001097read_compiled_module(char *cpathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001098{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001099 PyObject *co;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001100
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001101 co = PyMarshal_ReadLastObjectFromFile(fp);
1102 if (co == NULL)
1103 return NULL;
1104 if (!PyCode_Check(co)) {
1105 PyErr_Format(PyExc_ImportError,
1106 "Non-code object in %.200s", cpathname);
1107 Py_DECREF(co);
1108 return NULL;
1109 }
1110 return (PyCodeObject *)co;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001111}
1112
1113
1114/* Load a module from a compiled file, execute it, and return its
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001115 module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001116
Guido van Rossum79f25d91997-04-29 20:08:16 +00001117static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001118load_compiled_module(char *name, char *cpathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001119{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001120 long magic;
1121 PyCodeObject *co;
1122 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001123
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001124 magic = PyMarshal_ReadLongFromFile(fp);
1125 if (magic != pyc_magic) {
1126 PyErr_Format(PyExc_ImportError,
1127 "Bad magic number in %.200s", cpathname);
1128 return NULL;
1129 }
1130 (void) PyMarshal_ReadLongFromFile(fp);
1131 co = read_compiled_module(cpathname, fp);
1132 if (co == NULL)
1133 return NULL;
1134 if (Py_VerboseFlag)
1135 PySys_WriteStderr("import %s # precompiled from %s\n",
1136 name, cpathname);
1137 m = PyImport_ExecCodeModuleWithPathnames(
1138 name, (PyObject *)co, cpathname, cpathname);
1139 Py_DECREF(co);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001140
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001141 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001142}
1143
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001144/* Parse a source file and return the corresponding code object */
1145
Guido van Rossum79f25d91997-04-29 20:08:16 +00001146static PyCodeObject *
Jeremy Hylton3e0055f2005-10-20 19:59:25 +00001147parse_source_module(const char *pathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001148{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001149 PyCodeObject *co = NULL;
1150 mod_ty mod;
1151 PyCompilerFlags flags;
1152 PyArena *arena = PyArena_New();
1153 if (arena == NULL)
1154 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001155
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001156 flags.cf_flags = 0;
1157 mod = PyParser_ASTFromFile(fp, pathname, NULL,
1158 Py_file_input, 0, 0, &flags,
1159 NULL, arena);
1160 if (mod) {
1161 co = PyAST_Compile(mod, pathname, NULL, arena);
1162 }
1163 PyArena_Free(arena);
1164 return co;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001165}
1166
1167
Guido van Rossum55a83382000-09-20 20:31:38 +00001168/* Helper to open a bytecode file for writing in exclusive mode */
1169
1170static FILE *
Christian Heimes05e8be12008-02-23 18:30:17 +00001171open_exclusive(char *filename, mode_t mode)
Guido van Rossum55a83382000-09-20 20:31:38 +00001172{
1173#if defined(O_EXCL)&&defined(O_CREAT)&&defined(O_WRONLY)&&defined(O_TRUNC)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001174 /* Use O_EXCL to avoid a race condition when another process tries to
1175 write the same file. When that happens, our open() call fails,
1176 which is just fine (since it's only a cache).
1177 XXX If the file exists and is writable but the directory is not
1178 writable, the file will never be written. Oh well.
1179 */
1180 int fd;
1181 (void) unlink(filename);
1182 fd = open(filename, O_EXCL|O_CREAT|O_WRONLY|O_TRUNC
Tim Peters42c83af2000-09-29 04:03:10 +00001183#ifdef O_BINARY
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001184 |O_BINARY /* necessary for Windows */
Tim Peters42c83af2000-09-29 04:03:10 +00001185#endif
Martin v. Löwis79acb9e2002-12-06 12:48:53 +00001186#ifdef __VMS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001187 , mode, "ctxt=bin", "shr=nil"
Martin v. Löwis79acb9e2002-12-06 12:48:53 +00001188#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001189 , mode
Martin v. Löwis79acb9e2002-12-06 12:48:53 +00001190#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001191 );
1192 if (fd < 0)
1193 return NULL;
1194 return fdopen(fd, "wb");
Guido van Rossum55a83382000-09-20 20:31:38 +00001195#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001196 /* Best we can do -- on Windows this can't happen anyway */
1197 return fopen(filename, "wb");
Guido van Rossum55a83382000-09-20 20:31:38 +00001198#endif
1199}
1200
1201
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001202/* Write a compiled module to a file, placing the time of last
1203 modification of its source into the header.
1204 Errors are ignored, if a write error occurs an attempt is made to
1205 remove the file. */
1206
1207static void
Christian Heimes05e8be12008-02-23 18:30:17 +00001208write_compiled_module(PyCodeObject *co, char *cpathname, struct stat *srcstat)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001209{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001210 FILE *fp;
1211 char *dirpath;
1212 time_t mtime = srcstat->st_mtime;
Alexandre Vassalotti9d58e3e2009-07-17 10:55:50 +00001213#ifdef MS_WINDOWS /* since Windows uses different permissions */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001214 mode_t mode = srcstat->st_mode & ~S_IEXEC;
Alexandre Vassalotti9d58e3e2009-07-17 10:55:50 +00001215#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001216 mode_t mode = srcstat->st_mode & ~S_IXUSR & ~S_IXGRP & ~S_IXOTH;
1217 mode_t dirmode = (srcstat->st_mode |
1218 S_IXUSR | S_IXGRP | S_IXOTH |
1219 S_IWUSR | S_IWGRP | S_IWOTH);
Brett Cannon9a5b25a2010-03-01 02:09:17 +00001220#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001221 int saved;
Barry Warsaw28a691b2010-04-17 00:19:56 +00001222
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001223 /* Ensure that the __pycache__ directory exists. */
1224 dirpath = rightmost_sep(cpathname);
1225 if (dirpath == NULL) {
1226 if (Py_VerboseFlag)
1227 PySys_WriteStderr(
1228 "# no %s path found %s\n",
1229 CACHEDIR, cpathname);
1230 return;
1231 }
1232 saved = *dirpath;
1233 *dirpath = '\0';
Daniel Stutzbachc7937792010-09-09 21:18:04 +00001234
1235#ifdef MS_WINDOWS
1236 if (_mkdir(cpathname) < 0 && errno != EEXIST) {
1237#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001238 if (mkdir(cpathname, dirmode) < 0 && errno != EEXIST) {
Daniel Stutzbachc7937792010-09-09 21:18:04 +00001239#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001240 *dirpath = saved;
1241 if (Py_VerboseFlag)
1242 PySys_WriteStderr(
1243 "# cannot create cache dir %s\n", cpathname);
1244 return;
1245 }
1246 *dirpath = saved;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001247
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001248 fp = open_exclusive(cpathname, mode);
1249 if (fp == NULL) {
1250 if (Py_VerboseFlag)
1251 PySys_WriteStderr(
1252 "# can't create %s\n", cpathname);
1253 return;
1254 }
1255 PyMarshal_WriteLongToFile(pyc_magic, fp, Py_MARSHAL_VERSION);
1256 /* First write a 0 for mtime */
1257 PyMarshal_WriteLongToFile(0L, fp, Py_MARSHAL_VERSION);
1258 PyMarshal_WriteObjectToFile((PyObject *)co, fp, Py_MARSHAL_VERSION);
1259 if (fflush(fp) != 0 || ferror(fp)) {
1260 if (Py_VerboseFlag)
1261 PySys_WriteStderr("# can't write %s\n", cpathname);
1262 /* Don't keep partial file */
1263 fclose(fp);
1264 (void) unlink(cpathname);
1265 return;
1266 }
1267 /* Now write the true mtime */
1268 fseek(fp, 4L, 0);
1269 assert(mtime < LONG_MAX);
1270 PyMarshal_WriteLongToFile((long)mtime, fp, Py_MARSHAL_VERSION);
1271 fflush(fp);
1272 fclose(fp);
1273 if (Py_VerboseFlag)
1274 PySys_WriteStderr("# wrote %s\n", cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001275}
1276
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001277static void
1278update_code_filenames(PyCodeObject *co, PyObject *oldname, PyObject *newname)
1279{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001280 PyObject *constants, *tmp;
1281 Py_ssize_t i, n;
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001282
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001283 if (PyUnicode_Compare(co->co_filename, oldname))
1284 return;
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001285
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001286 tmp = co->co_filename;
1287 co->co_filename = newname;
1288 Py_INCREF(co->co_filename);
1289 Py_DECREF(tmp);
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001290
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001291 constants = co->co_consts;
1292 n = PyTuple_GET_SIZE(constants);
1293 for (i = 0; i < n; i++) {
1294 tmp = PyTuple_GET_ITEM(constants, i);
1295 if (PyCode_Check(tmp))
1296 update_code_filenames((PyCodeObject *)tmp,
1297 oldname, newname);
1298 }
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001299}
1300
1301static int
1302update_compiled_module(PyCodeObject *co, char *pathname)
1303{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001304 PyObject *oldname, *newname;
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001305
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001306 newname = PyUnicode_DecodeFSDefault(pathname);
1307 if (newname == NULL)
1308 return -1;
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001309
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001310 if (!PyUnicode_Compare(co->co_filename, newname)) {
1311 Py_DECREF(newname);
1312 return 0;
1313 }
Hirokazu Yamamoto4f447fb2009-03-04 01:52:10 +00001314
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001315 oldname = co->co_filename;
1316 Py_INCREF(oldname);
1317 update_code_filenames(co, oldname, newname);
1318 Py_DECREF(oldname);
1319 Py_DECREF(newname);
1320 return 1;
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001321}
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001322
1323/* Load a source module from a given file and return its module
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001324 object WITH INCREMENTED REFERENCE COUNT. If there's a matching
1325 byte-compiled file, use that instead. */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001326
Guido van Rossum79f25d91997-04-29 20:08:16 +00001327static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001328load_source_module(char *name, char *pathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001329{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001330 struct stat st;
1331 FILE *fpc;
1332 char buf[MAXPATHLEN+1];
1333 char *cpathname;
1334 PyCodeObject *co;
1335 PyObject *m;
Brett Cannon9a5b25a2010-03-01 02:09:17 +00001336
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001337 if (fstat(fileno(fp), &st) != 0) {
1338 PyErr_Format(PyExc_RuntimeError,
1339 "unable to get file status from '%s'",
1340 pathname);
1341 return NULL;
1342 }
Fred Drake4c82b232000-06-30 16:18:57 +00001343#if SIZEOF_TIME_T > 4
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001344 /* Python's .pyc timestamp handling presumes that the timestamp fits
1345 in 4 bytes. This will be fine until sometime in the year 2038,
1346 when a 4-byte signed time_t will overflow.
1347 */
1348 if (st.st_mtime >> 32) {
1349 PyErr_SetString(PyExc_OverflowError,
1350 "modification time overflows a 4 byte field");
1351 return NULL;
1352 }
Fred Drake4c82b232000-06-30 16:18:57 +00001353#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001354 cpathname = make_compiled_pathname(
1355 pathname, buf, (size_t)MAXPATHLEN + 1, !Py_OptimizeFlag);
1356 if (cpathname != NULL &&
1357 (fpc = check_compiled_module(pathname, st.st_mtime, cpathname))) {
1358 co = read_compiled_module(cpathname, fpc);
1359 fclose(fpc);
1360 if (co == NULL)
1361 return NULL;
1362 if (update_compiled_module(co, pathname) < 0)
1363 return NULL;
1364 if (Py_VerboseFlag)
1365 PySys_WriteStderr("import %s # precompiled from %s\n",
1366 name, cpathname);
1367 pathname = cpathname;
1368 }
1369 else {
1370 co = parse_source_module(pathname, fp);
1371 if (co == NULL)
1372 return NULL;
1373 if (Py_VerboseFlag)
1374 PySys_WriteStderr("import %s # from %s\n",
1375 name, pathname);
1376 if (cpathname) {
1377 PyObject *ro = PySys_GetObject("dont_write_bytecode");
1378 if (ro == NULL || !PyObject_IsTrue(ro))
1379 write_compiled_module(co, cpathname, &st);
1380 }
1381 }
1382 m = PyImport_ExecCodeModuleWithPathnames(
1383 name, (PyObject *)co, pathname, cpathname);
1384 Py_DECREF(co);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001385
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001386 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001387}
1388
Christian Heimes3b06e532008-01-07 20:12:44 +00001389/* Get source file -> unicode or None
1390 * Returns the path to the py file if available, else the given path
1391 */
1392static PyObject *
Barry Warsaw28a691b2010-04-17 00:19:56 +00001393get_sourcefile(char *file)
Christian Heimes3b06e532008-01-07 20:12:44 +00001394{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001395 char py[MAXPATHLEN + 1];
1396 Py_ssize_t len;
1397 PyObject *u;
1398 struct stat statbuf;
Christian Heimes3b06e532008-01-07 20:12:44 +00001399
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001400 if (!file || !*file) {
1401 Py_RETURN_NONE;
1402 }
Christian Heimes3b06e532008-01-07 20:12:44 +00001403
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001404 len = strlen(file);
1405 /* match '*.py?' */
1406 if (len > MAXPATHLEN || PyOS_strnicmp(&file[len-4], ".py", 3) != 0) {
1407 return PyUnicode_DecodeFSDefault(file);
1408 }
Christian Heimes3b06e532008-01-07 20:12:44 +00001409
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001410 /* Start by trying to turn PEP 3147 path into source path. If that
1411 * fails, just chop off the trailing character, i.e. legacy pyc path
1412 * to py.
1413 */
1414 if (make_source_pathname(file, py) == NULL) {
1415 strncpy(py, file, len-1);
1416 py[len-1] = '\0';
1417 }
Barry Warsaw28a691b2010-04-17 00:19:56 +00001418
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001419 if (stat(py, &statbuf) == 0 &&
1420 S_ISREG(statbuf.st_mode)) {
1421 u = PyUnicode_DecodeFSDefault(py);
1422 }
1423 else {
1424 u = PyUnicode_DecodeFSDefault(file);
1425 }
1426 return u;
Christian Heimes3b06e532008-01-07 20:12:44 +00001427}
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001428
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001429/* Forward */
Just van Rossum52e14d62002-12-30 22:08:05 +00001430static PyObject *load_module(char *, FILE *, char *, int, PyObject *);
1431static struct filedescr *find_module(char *, char *, PyObject *,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001432 char *, size_t, FILE **, PyObject **);
Victor Stinner53dc7352011-03-20 01:50:21 +01001433static struct _frozen * find_frozen(PyObject *);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001434
1435/* Load a package and return its module object WITH INCREMENTED
1436 REFERENCE COUNT */
1437
1438static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001439load_package(char *name, char *pathname)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001440{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001441 PyObject *m, *d;
1442 PyObject *file = NULL;
1443 PyObject *path = NULL;
1444 int err;
1445 char buf[MAXPATHLEN+1];
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
Martin v. Löwis18e16552006-02-15 17:27:45 +00001597static int case_ok(char *, Py_ssize_t, Py_ssize_t, 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 Stinner7d8b77c2011-03-12 08:45:02 -05001601/* Find a module:
1602
1603 - try find_module() of each sys.meta_path hook
1604 - try find_frozen()
1605 - try is_builtin()
1606 - try _PyWin_FindRegisteredModule() (Windows only)
1607 - otherwise, call find_module_path_list() with search_path_list (if not
1608 NULL) or sys.path
1609
1610 Return:
1611
1612 - &fd_builtin (C_BUILTIN) if it is a builtin
1613 - &fd_frozen (PY_FROZEN) if it is frozen
1614 - &fd_package (PKG_DIRECTORY) and write the filename into *buf
1615 if it is a package
1616 - &importhookdescr (IMP_HOOK) and write the loader into *p_loader if a
1617 importer loader was found
1618 - a file descriptor (PY_SOURCE, PY_COMPILED, C_EXTENSION, PY_RESOURCE or
1619 PY_CODERESOURCE: see _PyImport_Filetab), write the filename into
1620 *buf and the pointer to the open file into *p_fp
1621 - NULL on error
1622
1623 By default, write an empty string into *buf, and *p_fp and *p_loader (if
1624 set) are set to NULL. Eg. *buf is an empty string for a builtin package. */
1625
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001626static struct filedescr *
Just van Rossum52e14d62002-12-30 22:08:05 +00001627find_module(char *fullname, char *subname, PyObject *path, char *buf,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001628 size_t buflen, FILE **p_fp, PyObject **p_loader)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001629{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001630 Py_ssize_t i, npath;
1631 size_t len, namelen;
1632 struct filedescr *fdp = NULL;
1633 char *filemode;
1634 FILE *fp = NULL;
1635 PyObject *path_hooks, *path_importer_cache;
1636 struct stat statbuf;
1637 static struct filedescr fd_frozen = {"", "", PY_FROZEN};
1638 static struct filedescr fd_builtin = {"", "", C_BUILTIN};
1639 static struct filedescr fd_package = {"", "", PKG_DIRECTORY};
1640 char name[MAXPATHLEN+1];
Andrew MacIntyred9400542002-02-26 11:41:34 +00001641#if defined(PYOS_OS2)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001642 size_t saved_len;
1643 size_t saved_namelen;
1644 char *saved_buf = NULL;
Andrew MacIntyred9400542002-02-26 11:41:34 +00001645#endif
Victor Stinner95872862011-03-07 18:20:56 +01001646 PyObject *fullname_obj, *nameobj;
Victor Stinner53dc7352011-03-20 01:50:21 +01001647
Victor Stinner7d8b77c2011-03-12 08:45:02 -05001648 *buf = '\0';
1649 *p_fp = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001650 if (p_loader != NULL)
1651 *p_loader = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001652
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001653 if (strlen(subname) > MAXPATHLEN) {
1654 PyErr_SetString(PyExc_OverflowError,
1655 "module name is too long");
1656 return NULL;
1657 }
1658 strcpy(name, subname);
Just van Rossum52e14d62002-12-30 22:08:05 +00001659
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001660 /* sys.meta_path import hook */
1661 if (p_loader != NULL) {
1662 PyObject *meta_path;
Just van Rossum52e14d62002-12-30 22:08:05 +00001663
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001664 meta_path = PySys_GetObject("meta_path");
1665 if (meta_path == NULL || !PyList_Check(meta_path)) {
1666 PyErr_SetString(PyExc_ImportError,
1667 "sys.meta_path must be a list of "
1668 "import hooks");
1669 return NULL;
1670 }
1671 Py_INCREF(meta_path); /* zap guard */
1672 npath = PyList_Size(meta_path);
1673 for (i = 0; i < npath; i++) {
1674 PyObject *loader;
1675 PyObject *hook = PyList_GetItem(meta_path, i);
1676 loader = PyObject_CallMethod(hook, "find_module",
1677 "sO", fullname,
1678 path != NULL ?
1679 path : Py_None);
1680 if (loader == NULL) {
1681 Py_DECREF(meta_path);
1682 return NULL; /* true error */
1683 }
1684 if (loader != Py_None) {
1685 /* a loader was found */
1686 *p_loader = loader;
1687 Py_DECREF(meta_path);
1688 return &importhookdescr;
1689 }
1690 Py_DECREF(loader);
1691 }
1692 Py_DECREF(meta_path);
1693 }
Guido van Rossum0506a431998-08-11 15:07:39 +00001694
Victor Stinner53dc7352011-03-20 01:50:21 +01001695 if (fullname != NULL) {
1696 fullname_obj = PyUnicode_FromString(fullname);
1697 if (fullname == NULL)
1698 return NULL;
1699 if (find_frozen(fullname_obj) != NULL) {
1700 Py_DECREF(fullname_obj);
1701 strcpy(buf, fullname);
1702 return &fd_frozen;
1703 }
1704 Py_DECREF(fullname_obj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001705 }
Benjamin Petersond968e272008-11-05 22:48:33 +00001706
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001707 if (path == NULL) {
Victor Stinner4d6c1c42011-03-08 23:49:04 +01001708#ifdef MS_COREDLL
1709 PyObject *filename, *filename_bytes;
1710#endif
Victor Stinner95872862011-03-07 18:20:56 +01001711 nameobj = PyUnicode_FromString(name);
1712 if (nameobj == NULL)
1713 return NULL;
1714 if (is_builtin(nameobj)) {
1715 Py_DECREF(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001716 strcpy(buf, name);
1717 return &fd_builtin;
1718 }
Guido van Rossumac279101996-08-22 23:10:58 +00001719#ifdef MS_COREDLL
Victor Stinner4d6c1c42011-03-08 23:49:04 +01001720 fp = _PyWin_FindRegisteredModule(nameobj, &fdp, &filename);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001721 if (fp != NULL) {
Victor Stinner4d6c1c42011-03-08 23:49:04 +01001722 Py_DECREF(nameobj);
1723 filename_bytes = PyUnicode_EncodeFSDefault(filename);
1724 Py_DECREF(filename);
1725 if (filename_bytes == NULL)
1726 return NULL;
1727 strncpy(buf, PyBytes_AS_STRING(filename_bytes), buflen);
1728 buf[buflen-1] = '\0';
1729 Py_DECREF(filename_bytes);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001730 *p_fp = fp;
1731 return fdp;
1732 }
Victor Stinner4d6c1c42011-03-08 23:49:04 +01001733 else if (PyErr_Occurred())
1734 return NULL;
Guido van Rossuma5a3db71996-04-09 02:39:59 +00001735#endif
Victor Stinner4d6c1c42011-03-08 23:49:04 +01001736 Py_DECREF(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001737 path = PySys_GetObject("path");
1738 }
Benjamin Petersond968e272008-11-05 22:48:33 +00001739
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001740 if (path == NULL || !PyList_Check(path)) {
1741 PyErr_SetString(PyExc_ImportError,
1742 "sys.path must be a list of directory names");
1743 return NULL;
1744 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001745
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001746 path_hooks = PySys_GetObject("path_hooks");
1747 if (path_hooks == NULL || !PyList_Check(path_hooks)) {
1748 PyErr_SetString(PyExc_ImportError,
1749 "sys.path_hooks must be a list of "
1750 "import hooks");
1751 return NULL;
1752 }
1753 path_importer_cache = PySys_GetObject("path_importer_cache");
1754 if (path_importer_cache == NULL ||
1755 !PyDict_Check(path_importer_cache)) {
1756 PyErr_SetString(PyExc_ImportError,
1757 "sys.path_importer_cache must be a dict");
1758 return NULL;
1759 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001760
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001761 npath = PyList_Size(path);
1762 namelen = strlen(name);
1763 for (i = 0; i < npath; i++) {
1764 PyObject *v = PyList_GetItem(path, i);
1765 PyObject *origv = v;
1766 const char *base;
1767 Py_ssize_t size;
1768 if (!v)
1769 return NULL;
1770 if (PyUnicode_Check(v)) {
Victor Stinnerae6265f2010-05-15 16:27:27 +00001771 v = PyUnicode_EncodeFSDefault(v);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001772 if (v == NULL)
1773 return NULL;
1774 }
1775 else if (!PyBytes_Check(v))
1776 continue;
1777 else
1778 Py_INCREF(v);
Amaury Forgeot d'Arcf1ca0b12008-06-11 17:40:47 +00001779
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001780 base = PyBytes_AS_STRING(v);
1781 size = PyBytes_GET_SIZE(v);
1782 len = size;
1783 if (len + 2 + namelen + MAXSUFFIXSIZE >= buflen) {
1784 Py_DECREF(v);
1785 continue; /* Too long */
1786 }
1787 strcpy(buf, base);
1788 Py_DECREF(v);
Amaury Forgeot d'Arcf1ca0b12008-06-11 17:40:47 +00001789
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001790 if (strlen(buf) != len) {
1791 continue; /* v contains '\0' */
1792 }
Just van Rossum52e14d62002-12-30 22:08:05 +00001793
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001794 /* sys.path_hooks import hook */
1795 if (p_loader != NULL) {
1796 PyObject *importer;
Just van Rossum52e14d62002-12-30 22:08:05 +00001797
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001798 importer = get_path_importer(path_importer_cache,
1799 path_hooks, origv);
1800 if (importer == NULL) {
1801 return NULL;
1802 }
1803 /* Note: importer is a borrowed reference */
1804 if (importer != Py_None) {
1805 PyObject *loader;
1806 loader = PyObject_CallMethod(importer,
1807 "find_module",
1808 "s", fullname);
1809 if (loader == NULL)
1810 return NULL; /* error */
1811 if (loader != Py_None) {
1812 /* a loader was found */
1813 *p_loader = loader;
1814 return &importhookdescr;
1815 }
1816 Py_DECREF(loader);
1817 continue;
1818 }
1819 }
1820 /* no hook was found, use builtin import */
Just van Rossum52e14d62002-12-30 22:08:05 +00001821
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001822 if (len > 0 && buf[len-1] != SEP
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001823#ifdef ALTSEP
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001824 && buf[len-1] != ALTSEP
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001825#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001826 )
1827 buf[len++] = SEP;
1828 strcpy(buf+len, name);
1829 len += namelen;
Tim Peters50d8d372001-02-28 05:34:27 +00001830
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001831 /* Check for package import (buf holds a directory name,
1832 and there's an __init__ module in that directory */
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001833#ifdef HAVE_STAT
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001834 if (stat(buf, &statbuf) == 0 && /* it exists */
1835 S_ISDIR(statbuf.st_mode) && /* it's a directory */
1836 case_ok(buf, len, namelen, name)) { /* case matches */
1837 if (find_init_module(buf)) { /* and has __init__.py */
1838 return &fd_package;
1839 }
1840 else {
Victor Stinnered7916d2010-10-17 02:07:09 +00001841 int err;
1842 PyObject *unicode = PyUnicode_DecodeFSDefault(buf);
1843 if (unicode == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001844 return NULL;
Victor Stinnered7916d2010-10-17 02:07:09 +00001845 err = PyErr_WarnFormat(PyExc_ImportWarning, 1,
1846 "Not importing directory '%U': missing __init__.py",
1847 unicode);
1848 Py_DECREF(unicode);
1849 if (err)
1850 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001851 }
1852 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001853#endif
Andrew MacIntyred9400542002-02-26 11:41:34 +00001854#if defined(PYOS_OS2)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001855 /* take a snapshot of the module spec for restoration
1856 * after the 8 character DLL hackery
1857 */
1858 saved_buf = strdup(buf);
1859 saved_len = len;
1860 saved_namelen = namelen;
Andrew MacIntyred9400542002-02-26 11:41:34 +00001861#endif /* PYOS_OS2 */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001862 for (fdp = _PyImport_Filetab; fdp->suffix != NULL; fdp++) {
Guido van Rossum04110fb2007-08-24 16:32:05 +00001863#if defined(PYOS_OS2) && defined(HAVE_DYNAMIC_LOADING)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001864 /* OS/2 limits DLLs to 8 character names (w/o
1865 extension)
1866 * so if the name is longer than that and its a
1867 * dynamically loaded module we're going to try,
1868 * truncate the name before trying
1869 */
1870 if (strlen(subname) > 8) {
1871 /* is this an attempt to load a C extension? */
1872 const struct filedescr *scan;
1873 scan = _PyImport_DynLoadFiletab;
1874 while (scan->suffix != NULL) {
1875 if (!strcmp(scan->suffix, fdp->suffix))
1876 break;
1877 else
1878 scan++;
1879 }
1880 if (scan->suffix != NULL) {
1881 /* yes, so truncate the name */
1882 namelen = 8;
1883 len -= strlen(subname) - namelen;
1884 buf[len] = '\0';
1885 }
1886 }
Andrew MacIntyred9400542002-02-26 11:41:34 +00001887#endif /* PYOS_OS2 */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001888 strcpy(buf+len, fdp->suffix);
1889 if (Py_VerboseFlag > 1)
1890 PySys_WriteStderr("# trying %s\n", buf);
1891 filemode = fdp->mode;
1892 if (filemode[0] == 'U')
1893 filemode = "r" PY_STDIOTEXTMODE;
1894 fp = fopen(buf, filemode);
1895 if (fp != NULL) {
1896 if (case_ok(buf, len, namelen, name))
1897 break;
1898 else { /* continue search */
1899 fclose(fp);
1900 fp = NULL;
1901 }
1902 }
Andrew MacIntyred9400542002-02-26 11:41:34 +00001903#if defined(PYOS_OS2)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001904 /* restore the saved snapshot */
1905 strcpy(buf, saved_buf);
1906 len = saved_len;
1907 namelen = saved_namelen;
Andrew MacIntyred9400542002-02-26 11:41:34 +00001908#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001909 }
Andrew MacIntyred9400542002-02-26 11:41:34 +00001910#if defined(PYOS_OS2)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001911 /* don't need/want the module name snapshot anymore */
1912 if (saved_buf)
1913 {
1914 free(saved_buf);
1915 saved_buf = NULL;
1916 }
Andrew MacIntyred9400542002-02-26 11:41:34 +00001917#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001918 if (fp != NULL)
1919 break;
1920 }
1921 if (fp == NULL) {
1922 PyErr_Format(PyExc_ImportError,
1923 "No module named %.200s", name);
1924 return NULL;
1925 }
1926 *p_fp = fp;
1927 return fdp;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001928}
1929
Martin v. Löwis18e16552006-02-15 17:27:45 +00001930/* case_ok(char* buf, Py_ssize_t len, Py_ssize_t namelen, char* name)
Tim Petersd1e87a82001-03-01 18:12:00 +00001931 * The arguments here are tricky, best shown by example:
1932 * /a/b/c/d/e/f/g/h/i/j/k/some_long_module_name.py\0
1933 * ^ ^ ^ ^
1934 * |--------------------- buf ---------------------|
1935 * |------------------- len ------------------|
1936 * |------ name -------|
1937 * |----- namelen -----|
1938 * buf is the full path, but len only counts up to (& exclusive of) the
1939 * extension. name is the module name, also exclusive of extension.
1940 *
1941 * We've already done a successful stat() or fopen() on buf, so know that
1942 * there's some match, possibly case-insensitive.
1943 *
Tim Peters50d8d372001-02-28 05:34:27 +00001944 * case_ok() is to return 1 if there's a case-sensitive match for
1945 * name, else 0. case_ok() is also to return 1 if envar PYTHONCASEOK
1946 * exists.
Tim Petersd1e87a82001-03-01 18:12:00 +00001947 *
Tim Peters50d8d372001-02-28 05:34:27 +00001948 * case_ok() is used to implement case-sensitive import semantics even
1949 * on platforms with case-insensitive filesystems. It's trivial to implement
1950 * for case-sensitive filesystems. It's pretty much a cross-platform
1951 * nightmare for systems with case-insensitive filesystems.
1952 */
Guido van Rossum0980bd91998-02-13 17:18:36 +00001953
Tim Peters50d8d372001-02-28 05:34:27 +00001954/* First we may need a pile of platform-specific header files; the sequence
1955 * of #if's here should match the sequence in the body of case_ok().
1956 */
Jason Tishler7961aa62005-05-20 00:56:54 +00001957#if defined(MS_WINDOWS)
Guido van Rossum0980bd91998-02-13 17:18:36 +00001958#include <windows.h>
Guido van Rossum4c3f57c2001-01-10 20:40:46 +00001959
Tim Peters50d8d372001-02-28 05:34:27 +00001960#elif defined(DJGPP)
1961#include <dir.h>
1962
Jason Tishler7961aa62005-05-20 00:56:54 +00001963#elif (defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) && defined(HAVE_DIRENT_H)
Tim Peters430f5d42001-03-01 01:30:56 +00001964#include <sys/types.h>
1965#include <dirent.h>
1966
Andrew MacIntyred9400542002-02-26 11:41:34 +00001967#elif defined(PYOS_OS2)
1968#define INCL_DOS
1969#define INCL_DOSERRORS
1970#define INCL_NOPMAPI
1971#include <os2.h>
Tim Peters50d8d372001-02-28 05:34:27 +00001972#endif
1973
Guido van Rossum0980bd91998-02-13 17:18:36 +00001974static int
Martin v. Löwis18e16552006-02-15 17:27:45 +00001975case_ok(char *buf, Py_ssize_t len, Py_ssize_t namelen, char *name)
Guido van Rossum0980bd91998-02-13 17:18:36 +00001976{
Tim Peters50d8d372001-02-28 05:34:27 +00001977/* Pick a platform-specific implementation; the sequence of #if's here should
1978 * match the sequence just above.
1979 */
1980
Jason Tishler7961aa62005-05-20 00:56:54 +00001981/* MS_WINDOWS */
1982#if defined(MS_WINDOWS)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001983 WIN32_FIND_DATA data;
1984 HANDLE h;
Tim Peters50d8d372001-02-28 05:34:27 +00001985
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001986 if (Py_GETENV("PYTHONCASEOK") != NULL)
1987 return 1;
Tim Peters50d8d372001-02-28 05:34:27 +00001988
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001989 h = FindFirstFile(buf, &data);
1990 if (h == INVALID_HANDLE_VALUE) {
1991 PyErr_Format(PyExc_NameError,
1992 "Can't find file for module %.100s\n(filename %.300s)",
1993 name, buf);
1994 return 0;
1995 }
1996 FindClose(h);
1997 return strncmp(data.cFileName, name, namelen) == 0;
Tim Peters50d8d372001-02-28 05:34:27 +00001998
1999/* DJGPP */
2000#elif defined(DJGPP)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002001 struct ffblk ffblk;
2002 int done;
Tim Peters50d8d372001-02-28 05:34:27 +00002003
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002004 if (Py_GETENV("PYTHONCASEOK") != NULL)
2005 return 1;
Tim Peters50d8d372001-02-28 05:34:27 +00002006
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002007 done = findfirst(buf, &ffblk, FA_ARCH|FA_RDONLY|FA_HIDDEN|FA_DIREC);
2008 if (done) {
2009 PyErr_Format(PyExc_NameError,
2010 "Can't find file for module %.100s\n(filename %.300s)",
2011 name, buf);
2012 return 0;
2013 }
2014 return strncmp(ffblk.ff_name, name, namelen) == 0;
Guido van Rossum0980bd91998-02-13 17:18:36 +00002015
Jason Tishler7961aa62005-05-20 00:56:54 +00002016/* new-fangled macintosh (macosx) or Cygwin */
2017#elif (defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) && defined(HAVE_DIRENT_H)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002018 DIR *dirp;
2019 struct dirent *dp;
2020 char dirname[MAXPATHLEN + 1];
2021 const int dirlen = len - namelen - 1; /* don't want trailing SEP */
Tim Peters430f5d42001-03-01 01:30:56 +00002022
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002023 if (Py_GETENV("PYTHONCASEOK") != NULL)
2024 return 1;
Tim Petersdbe6ebb2001-03-01 08:47:29 +00002025
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002026 /* Copy the dir component into dirname; substitute "." if empty */
2027 if (dirlen <= 0) {
2028 dirname[0] = '.';
2029 dirname[1] = '\0';
2030 }
2031 else {
2032 assert(dirlen <= MAXPATHLEN);
2033 memcpy(dirname, buf, dirlen);
2034 dirname[dirlen] = '\0';
2035 }
2036 /* Open the directory and search the entries for an exact match. */
2037 dirp = opendir(dirname);
2038 if (dirp) {
2039 char *nameWithExt = buf + len - namelen;
2040 while ((dp = readdir(dirp)) != NULL) {
2041 const int thislen =
Tim Peters430f5d42001-03-01 01:30:56 +00002042#ifdef _DIRENT_HAVE_D_NAMELEN
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002043 dp->d_namlen;
Tim Peters430f5d42001-03-01 01:30:56 +00002044#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002045 strlen(dp->d_name);
Tim Peters430f5d42001-03-01 01:30:56 +00002046#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002047 if (thislen >= namelen &&
2048 strcmp(dp->d_name, nameWithExt) == 0) {
2049 (void)closedir(dirp);
2050 return 1; /* Found */
2051 }
2052 }
2053 (void)closedir(dirp);
2054 }
2055 return 0 ; /* Not found */
Tim Peters430f5d42001-03-01 01:30:56 +00002056
Andrew MacIntyred9400542002-02-26 11:41:34 +00002057/* OS/2 */
2058#elif defined(PYOS_OS2)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002059 HDIR hdir = 1;
2060 ULONG srchcnt = 1;
2061 FILEFINDBUF3 ffbuf;
2062 APIRET rc;
Andrew MacIntyred9400542002-02-26 11:41:34 +00002063
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002064 if (Py_GETENV("PYTHONCASEOK") != NULL)
2065 return 1;
Andrew MacIntyred9400542002-02-26 11:41:34 +00002066
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002067 rc = DosFindFirst(buf,
2068 &hdir,
2069 FILE_READONLY | FILE_HIDDEN | FILE_SYSTEM | FILE_DIRECTORY,
2070 &ffbuf, sizeof(ffbuf),
2071 &srchcnt,
2072 FIL_STANDARD);
2073 if (rc != NO_ERROR)
2074 return 0;
2075 return strncmp(ffbuf.achName, name, namelen) == 0;
Andrew MacIntyred9400542002-02-26 11:41:34 +00002076
Tim Peters50d8d372001-02-28 05:34:27 +00002077/* assuming it's a case-sensitive filesystem, so there's nothing to do! */
2078#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002079 return 1;
Guido van Rossum0980bd91998-02-13 17:18:36 +00002080
Guido van Rossum4d1b3b91998-02-13 23:27:59 +00002081#endif
Tim Peters50d8d372001-02-28 05:34:27 +00002082}
Guido van Rossum4d1b3b91998-02-13 23:27:59 +00002083
Guido van Rossum197346f1997-10-31 18:38:52 +00002084#ifdef HAVE_STAT
Victor Stinner4f4402c2010-08-14 14:50:26 +00002085
Guido van Rossum197346f1997-10-31 18:38:52 +00002086/* Helper to look for __init__.py or __init__.py[co] in potential package */
2087static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002088find_init_module(char *buf)
Guido van Rossum197346f1997-10-31 18:38:52 +00002089{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002090 const size_t save_len = strlen(buf);
2091 size_t i = save_len;
2092 char *pname; /* pointer to start of __init__ */
2093 struct stat statbuf;
Guido van Rossum197346f1997-10-31 18:38:52 +00002094
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002095/* For calling case_ok(buf, len, namelen, name):
2096 * /a/b/c/d/e/f/g/h/i/j/k/some_long_module_name.py\0
2097 * ^ ^ ^ ^
2098 * |--------------------- buf ---------------------|
2099 * |------------------- len ------------------|
2100 * |------ name -------|
2101 * |----- namelen -----|
Tim Peters0f9431f2001-07-05 03:47:53 +00002102 */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002103 if (save_len + 13 >= MAXPATHLEN)
2104 return 0;
2105 buf[i++] = SEP;
2106 pname = buf + i;
2107 strcpy(pname, "__init__.py");
2108 if (stat(buf, &statbuf) == 0) {
2109 if (case_ok(buf,
2110 save_len + 9, /* len("/__init__") */
2111 8, /* len("__init__") */
2112 pname)) {
2113 buf[save_len] = '\0';
2114 return 1;
2115 }
2116 }
2117 i += strlen(pname);
2118 strcpy(buf+i, Py_OptimizeFlag ? "o" : "c");
2119 if (stat(buf, &statbuf) == 0) {
2120 if (case_ok(buf,
2121 save_len + 9, /* len("/__init__") */
2122 8, /* len("__init__") */
2123 pname)) {
2124 buf[save_len] = '\0';
2125 return 1;
2126 }
2127 }
2128 buf[save_len] = '\0';
2129 return 0;
Guido van Rossum197346f1997-10-31 18:38:52 +00002130}
Guido van Rossum48a680c2001-03-02 06:34:14 +00002131
Guido van Rossum197346f1997-10-31 18:38:52 +00002132#endif /* HAVE_STAT */
2133
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002134
Victor Stinner95872862011-03-07 18:20:56 +01002135static int init_builtin(PyObject *); /* Forward */
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002136
Victor Stinner44c6c152010-08-09 00:59:10 +00002137static PyObject*
Victor Stinner95872862011-03-07 18:20:56 +01002138load_builtin(PyObject *name, int type)
Victor Stinner44c6c152010-08-09 00:59:10 +00002139{
2140 PyObject *m, *modules;
2141 int err;
2142
Victor Stinner44c6c152010-08-09 00:59:10 +00002143 if (type == C_BUILTIN)
2144 err = init_builtin(name);
2145 else
Victor Stinner95872862011-03-07 18:20:56 +01002146 err = PyImport_ImportFrozenModuleObject(name);
Victor Stinner44c6c152010-08-09 00:59:10 +00002147 if (err < 0)
2148 return NULL;
2149 if (err == 0) {
2150 PyErr_Format(PyExc_ImportError,
Victor Stinner95872862011-03-07 18:20:56 +01002151 "Purported %s module %R not found",
2152 type == C_BUILTIN ? "builtin" : "frozen",
Victor Stinner44c6c152010-08-09 00:59:10 +00002153 name);
2154 return NULL;
2155 }
2156
2157 modules = PyImport_GetModuleDict();
Victor Stinner95872862011-03-07 18:20:56 +01002158 m = PyDict_GetItem(modules, name);
Victor Stinner44c6c152010-08-09 00:59:10 +00002159 if (m == NULL) {
2160 PyErr_Format(
2161 PyExc_ImportError,
Victor Stinner95872862011-03-07 18:20:56 +01002162 "%s module %R not properly initialized",
2163 type == C_BUILTIN ? "builtin" : "frozen",
Victor Stinner44c6c152010-08-09 00:59:10 +00002164 name);
2165 return NULL;
2166 }
2167 Py_INCREF(m);
2168 return m;
2169}
2170
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002171/* Load an external module using the default search path and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00002172 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002173
Guido van Rossum79f25d91997-04-29 20:08:16 +00002174static PyObject *
Alexandre Vassalottie223eb82009-07-29 20:12:15 +00002175load_module(char *name, FILE *fp, char *pathname, int type, PyObject *loader)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002176{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002177 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002178
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002179 /* First check that there's an open file (if we need one) */
2180 switch (type) {
2181 case PY_SOURCE:
2182 case PY_COMPILED:
2183 if (fp == NULL) {
2184 PyErr_Format(PyExc_ValueError,
2185 "file object required for import (type code %d)",
2186 type);
2187 return NULL;
2188 }
2189 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002190
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002191 switch (type) {
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002192
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002193 case PY_SOURCE:
2194 m = load_source_module(name, pathname, fp);
2195 break;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002196
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002197 case PY_COMPILED:
2198 m = load_compiled_module(name, pathname, fp);
2199 break;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002200
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002201#ifdef HAVE_DYNAMIC_LOADING
Victor Stinnerfefd70c2011-03-14 15:54:07 -04002202 case C_EXTENSION: {
2203 PyObject *nameobj, *pathobj;
2204 nameobj = PyUnicode_FromString(name);
2205 if (nameobj == NULL)
2206 return NULL;
2207 pathobj = PyUnicode_DecodeFSDefault(pathname);
2208 if (pathobj == NULL) {
2209 Py_DECREF(nameobj);
2210 return NULL;
2211 }
2212 m = _PyImport_LoadDynamicModule(nameobj, pathobj, fp);
2213 Py_DECREF(nameobj);
2214 Py_DECREF(pathobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002215 break;
Victor Stinnerfefd70c2011-03-14 15:54:07 -04002216 }
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002217#endif
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002218
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002219 case PKG_DIRECTORY:
2220 m = load_package(name, pathname);
2221 break;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002222
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002223 case C_BUILTIN:
Victor Stinner95872862011-03-07 18:20:56 +01002224 case PY_FROZEN: {
2225 PyObject *nameobj = PyUnicode_FromString(name);
Victor Stinnerfefd70c2011-03-14 15:54:07 -04002226 if (nameobj == NULL)
2227 return NULL;
2228 m = load_builtin(nameobj, type);
2229 Py_DECREF(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002230 break;
Victor Stinner95872862011-03-07 18:20:56 +01002231 }
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002232
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002233 case IMP_HOOK: {
2234 if (loader == NULL) {
2235 PyErr_SetString(PyExc_ImportError,
2236 "import hook without loader");
2237 return NULL;
2238 }
2239 m = PyObject_CallMethod(loader, "load_module", "s", name);
2240 break;
2241 }
Just van Rossum52e14d62002-12-30 22:08:05 +00002242
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002243 default:
2244 PyErr_Format(PyExc_ImportError,
2245 "Don't know how to import %.200s (type code %d)",
2246 name, type);
2247 m = NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002248
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002249 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002250
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002251 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002252}
2253
2254
2255/* Initialize a built-in module.
Thomas Wouters89f507f2006-12-13 04:49:30 +00002256 Return 1 for success, 0 if the module is not found, and -1 with
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002257 an exception set if the initialization failed. */
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002258
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002259static int
Victor Stinner95872862011-03-07 18:20:56 +01002260init_builtin(PyObject *name)
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002261{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002262 struct _inittab *p;
Guido van Rossum25ce5661997-08-02 03:10:38 +00002263
Victor Stinner95872862011-03-07 18:20:56 +01002264 if (_PyImport_FindExtensionObject(name, name) != NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002265 return 1;
Guido van Rossum25ce5661997-08-02 03:10:38 +00002266
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002267 for (p = PyImport_Inittab; p->name != NULL; p++) {
2268 PyObject *mod;
Victor Stinner95872862011-03-07 18:20:56 +01002269 if (PyUnicode_CompareWithASCIIString(name, p->name) == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002270 if (p->initfunc == NULL) {
2271 PyErr_Format(PyExc_ImportError,
Victor Stinner95872862011-03-07 18:20:56 +01002272 "Cannot re-init internal module %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002273 name);
2274 return -1;
2275 }
2276 if (Py_VerboseFlag)
Victor Stinner95872862011-03-07 18:20:56 +01002277 PySys_FormatStderr("import %U # builtin\n", name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002278 mod = (*p->initfunc)();
2279 if (mod == 0)
2280 return -1;
Victor Stinner95872862011-03-07 18:20:56 +01002281 if (_PyImport_FixupExtensionObject(mod, name, name) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002282 return -1;
2283 /* FixupExtension has put the module into sys.modules,
2284 so we can release our own reference. */
2285 Py_DECREF(mod);
2286 return 1;
2287 }
2288 }
2289 return 0;
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002290}
Guido van Rossumf56e3db1993-04-01 20:59:32 +00002291
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002292
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002293/* Frozen modules */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002294
Guido van Rossumcfd0a221996-06-17 17:06:34 +00002295static struct _frozen *
Victor Stinner53dc7352011-03-20 01:50:21 +01002296find_frozen(PyObject *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002297{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002298 struct _frozen *p;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002299
Victor Stinner53dc7352011-03-20 01:50:21 +01002300 if (name == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002301 return NULL;
Benjamin Petersond968e272008-11-05 22:48:33 +00002302
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002303 for (p = PyImport_FrozenModules; ; p++) {
2304 if (p->name == NULL)
2305 return NULL;
Victor Stinner53dc7352011-03-20 01:50:21 +01002306 if (PyUnicode_CompareWithASCIIString(name, p->name) == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002307 break;
2308 }
2309 return p;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002310}
2311
Guido van Rossum79f25d91997-04-29 20:08:16 +00002312static PyObject *
Victor Stinner53dc7352011-03-20 01:50:21 +01002313get_frozen_object(PyObject *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002314{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002315 struct _frozen *p = find_frozen(name);
2316 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002317
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002318 if (p == NULL) {
2319 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002320 "No such frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002321 name);
2322 return NULL;
2323 }
2324 if (p->code == NULL) {
2325 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002326 "Excluded frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002327 name);
2328 return NULL;
2329 }
2330 size = p->size;
2331 if (size < 0)
2332 size = -size;
2333 return PyMarshal_ReadObjectFromString((char *)p->code, size);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002334}
2335
Brett Cannon8d110132009-03-15 02:20:16 +00002336static PyObject *
Victor Stinner53dc7352011-03-20 01:50:21 +01002337is_frozen_package(PyObject *name)
Brett Cannon8d110132009-03-15 02:20:16 +00002338{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002339 struct _frozen *p = find_frozen(name);
2340 int size;
Brett Cannon8d110132009-03-15 02:20:16 +00002341
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002342 if (p == NULL) {
2343 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002344 "No such frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002345 name);
2346 return NULL;
2347 }
Brett Cannon8d110132009-03-15 02:20:16 +00002348
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002349 size = p->size;
Brett Cannon8d110132009-03-15 02:20:16 +00002350
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002351 if (size < 0)
2352 Py_RETURN_TRUE;
2353 else
2354 Py_RETURN_FALSE;
Brett Cannon8d110132009-03-15 02:20:16 +00002355}
2356
2357
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002358/* Initialize a frozen module.
Brett Cannon3c2ac442009-03-08 20:49:47 +00002359 Return 1 for success, 0 if the module is not found, and -1 with
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002360 an exception set if the initialization failed.
2361 This function is also used from frozenmain.c */
Guido van Rossum0b344901995-02-07 15:35:27 +00002362
2363int
Victor Stinner53dc7352011-03-20 01:50:21 +01002364PyImport_ImportFrozenModuleObject(PyObject *name)
Guido van Rossumf56e3db1993-04-01 20:59:32 +00002365{
Victor Stinner53dc7352011-03-20 01:50:21 +01002366 struct _frozen *p;
2367 PyObject *co, *m, *path;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002368 int ispackage;
2369 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002370
Victor Stinner53dc7352011-03-20 01:50:21 +01002371 p = find_frozen(name);
2372
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002373 if (p == NULL)
2374 return 0;
2375 if (p->code == NULL) {
2376 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002377 "Excluded frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002378 name);
2379 return -1;
2380 }
2381 size = p->size;
2382 ispackage = (size < 0);
2383 if (ispackage)
2384 size = -size;
2385 if (Py_VerboseFlag)
Victor Stinner53dc7352011-03-20 01:50:21 +01002386 PySys_FormatStderr("import %U # frozen%s\n",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002387 name, ispackage ? " package" : "");
2388 co = PyMarshal_ReadObjectFromString((char *)p->code, size);
2389 if (co == NULL)
2390 return -1;
2391 if (!PyCode_Check(co)) {
2392 PyErr_Format(PyExc_TypeError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002393 "frozen object %R is not a code object",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002394 name);
2395 goto err_return;
2396 }
2397 if (ispackage) {
2398 /* Set __path__ to the package name */
Victor Stinner53dc7352011-03-20 01:50:21 +01002399 PyObject *d, *l;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002400 int err;
Victor Stinner53dc7352011-03-20 01:50:21 +01002401 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002402 if (m == NULL)
2403 goto err_return;
2404 d = PyModule_GetDict(m);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002405 l = PyList_New(1);
2406 if (l == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002407 goto err_return;
2408 }
Victor Stinner53dc7352011-03-20 01:50:21 +01002409 Py_INCREF(name);
2410 PyList_SET_ITEM(l, 0, name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002411 err = PyDict_SetItemString(d, "__path__", l);
2412 Py_DECREF(l);
2413 if (err != 0)
2414 goto err_return;
2415 }
Victor Stinner53dc7352011-03-20 01:50:21 +01002416 path = PyUnicode_FromString("<frozen>");
2417 if (path == NULL)
2418 goto err_return;
2419 m = PyImport_ExecCodeModuleObject(name, co, path, NULL);
2420 Py_DECREF(path);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002421 if (m == NULL)
2422 goto err_return;
2423 Py_DECREF(co);
2424 Py_DECREF(m);
2425 return 1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002426err_return:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002427 Py_DECREF(co);
2428 return -1;
Guido van Rossumf56e3db1993-04-01 20:59:32 +00002429}
Guido van Rossum74e6a111994-08-29 12:54:38 +00002430
Victor Stinner53dc7352011-03-20 01:50:21 +01002431int
2432PyImport_ImportFrozenModule(char *name)
2433{
2434 PyObject *nameobj;
2435 int ret;
2436 nameobj = PyUnicode_InternFromString(name);
2437 if (nameobj == NULL)
2438 return -1;
2439 ret = PyImport_ImportFrozenModuleObject(nameobj);
2440 Py_DECREF(nameobj);
2441 return ret;
2442}
2443
Guido van Rossum74e6a111994-08-29 12:54:38 +00002444
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002445/* Import a module, either built-in, frozen, or external, and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00002446 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum74e6a111994-08-29 12:54:38 +00002447
Guido van Rossum79f25d91997-04-29 20:08:16 +00002448PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00002449PyImport_ImportModule(const char *name)
Guido van Rossum74e6a111994-08-29 12:54:38 +00002450{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002451 PyObject *pname;
2452 PyObject *result;
Marc-André Lemburg3c61c352001-02-09 19:40:15 +00002453
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002454 pname = PyUnicode_FromString(name);
2455 if (pname == NULL)
2456 return NULL;
2457 result = PyImport_Import(pname);
2458 Py_DECREF(pname);
2459 return result;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002460}
2461
Christian Heimes072c0f12008-01-03 23:01:04 +00002462/* Import a module without blocking
2463 *
2464 * At first it tries to fetch the module from sys.modules. If the module was
2465 * never loaded before it loads it with PyImport_ImportModule() unless another
2466 * thread holds the import lock. In the latter case the function raises an
2467 * ImportError instead of blocking.
2468 *
2469 * Returns the module object with incremented ref count.
2470 */
2471PyObject *
2472PyImport_ImportModuleNoBlock(const char *name)
2473{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002474 PyObject *result;
2475 PyObject *modules;
2476 long me;
Christian Heimes072c0f12008-01-03 23:01:04 +00002477
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002478 /* Try to get the module from sys.modules[name] */
2479 modules = PyImport_GetModuleDict();
2480 if (modules == NULL)
2481 return NULL;
Christian Heimes072c0f12008-01-03 23:01:04 +00002482
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002483 result = PyDict_GetItemString(modules, name);
2484 if (result != NULL) {
2485 Py_INCREF(result);
2486 return result;
2487 }
2488 else {
2489 PyErr_Clear();
2490 }
Benjamin Peterson3e4f0552008-09-02 00:31:15 +00002491#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002492 /* check the import lock
2493 * me might be -1 but I ignore the error here, the lock function
2494 * takes care of the problem */
2495 me = PyThread_get_thread_ident();
2496 if (import_lock_thread == -1 || import_lock_thread == me) {
2497 /* no thread or me is holding the lock */
2498 return PyImport_ImportModule(name);
2499 }
2500 else {
2501 PyErr_Format(PyExc_ImportError,
2502 "Failed to import %.200s because the import lock"
2503 "is held by another thread.",
2504 name);
2505 return NULL;
2506 }
Benjamin Peterson3e4f0552008-09-02 00:31:15 +00002507#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002508 return PyImport_ImportModule(name);
Benjamin Peterson3e4f0552008-09-02 00:31:15 +00002509#endif
Christian Heimes072c0f12008-01-03 23:01:04 +00002510}
2511
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002512/* Forward declarations for helper routines */
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002513static PyObject *get_parent(PyObject *globals, char *buf,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002514 Py_ssize_t *p_buflen, int level);
Tim Petersdbd9ba62000-07-09 03:09:57 +00002515static PyObject *load_next(PyObject *mod, PyObject *altmod,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002516 char **p_name, char *buf, Py_ssize_t *p_buflen);
Tim Petersdbd9ba62000-07-09 03:09:57 +00002517static int mark_miss(char *name);
2518static int ensure_fromlist(PyObject *mod, PyObject *fromlist,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002519 char *buf, Py_ssize_t buflen, int recursive);
Tim Petersdbd9ba62000-07-09 03:09:57 +00002520static PyObject * import_submodule(PyObject *mod, char *name, char *fullname);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002521
2522/* The Magnum Opus of dotted-name import :-) */
2523
Guido van Rossum75acc9c1998-03-03 22:26:50 +00002524static PyObject *
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002525import_module_level(char *name, PyObject *globals, PyObject *locals,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002526 PyObject *fromlist, int level)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002527{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002528 char buf[MAXPATHLEN+1];
2529 Py_ssize_t buflen = 0;
2530 PyObject *parent, *head, *next, *tail;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002531
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002532 if (strchr(name, '/') != NULL
Christian Heimes454f37b2008-01-10 00:10:02 +00002533#ifdef MS_WINDOWS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002534 || strchr(name, '\\') != NULL
Christian Heimes454f37b2008-01-10 00:10:02 +00002535#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002536 ) {
2537 PyErr_SetString(PyExc_ImportError,
2538 "Import by filename is not supported.");
2539 return NULL;
2540 }
Christian Heimes454f37b2008-01-10 00:10:02 +00002541
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002542 parent = get_parent(globals, buf, &buflen, level);
2543 if (parent == NULL)
2544 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002545
Benjamin Peterson556d8002010-06-27 22:37:28 +00002546 head = load_next(parent, level < 0 ? Py_None : parent, &name, buf,
2547 &buflen);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002548 if (head == NULL)
2549 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002550
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002551 tail = head;
2552 Py_INCREF(tail);
2553 while (name) {
2554 next = load_next(tail, tail, &name, buf, &buflen);
2555 Py_DECREF(tail);
2556 if (next == NULL) {
2557 Py_DECREF(head);
2558 return NULL;
2559 }
2560 tail = next;
2561 }
2562 if (tail == Py_None) {
2563 /* If tail is Py_None, both get_parent and load_next found
2564 an empty module name: someone called __import__("") or
2565 doctored faulty bytecode */
2566 Py_DECREF(tail);
2567 Py_DECREF(head);
2568 PyErr_SetString(PyExc_ValueError,
2569 "Empty module name");
2570 return NULL;
2571 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002572
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002573 if (fromlist != NULL) {
2574 if (fromlist == Py_None || !PyObject_IsTrue(fromlist))
2575 fromlist = NULL;
2576 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002577
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002578 if (fromlist == NULL) {
2579 Py_DECREF(tail);
2580 return head;
2581 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002582
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002583 Py_DECREF(head);
2584 if (!ensure_fromlist(tail, fromlist, buf, buflen, 0)) {
2585 Py_DECREF(tail);
2586 return NULL;
2587 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002588
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002589 return tail;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002590}
2591
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002592PyObject *
2593PyImport_ImportModuleLevel(char *name, PyObject *globals, PyObject *locals,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002594 PyObject *fromlist, int level)
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002595{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002596 PyObject *result;
2597 _PyImport_AcquireLock();
2598 result = import_module_level(name, globals, locals, fromlist, level);
2599 if (_PyImport_ReleaseLock() < 0) {
2600 Py_XDECREF(result);
2601 PyErr_SetString(PyExc_RuntimeError,
2602 "not holding the import lock");
2603 return NULL;
2604 }
2605 return result;
Guido van Rossum75acc9c1998-03-03 22:26:50 +00002606}
2607
Fred Drake87590902004-05-28 20:21:36 +00002608/* Return the package that an import is being performed in. If globals comes
2609 from the module foo.bar.bat (not itself a package), this returns the
2610 sys.modules entry for foo.bar. If globals is from a package's __init__.py,
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00002611 the package's entry in sys.modules is returned, as a borrowed reference.
Fred Drake87590902004-05-28 20:21:36 +00002612
2613 The *name* of the returned package is returned in buf, with the length of
2614 the name in *p_buflen.
2615
2616 If globals doesn't come from a package or a module in a package, or a
2617 corresponding entry is not found in sys.modules, Py_None is returned.
2618*/
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002619static PyObject *
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002620get_parent(PyObject *globals, char *buf, Py_ssize_t *p_buflen, int level)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002621{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002622 static PyObject *namestr = NULL;
2623 static PyObject *pathstr = NULL;
2624 static PyObject *pkgstr = NULL;
2625 PyObject *pkgname, *modname, *modpath, *modules, *parent;
2626 int orig_level = level;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002627
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002628 if (globals == NULL || !PyDict_Check(globals) || !level)
2629 return Py_None;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002630
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002631 if (namestr == NULL) {
2632 namestr = PyUnicode_InternFromString("__name__");
2633 if (namestr == NULL)
2634 return NULL;
2635 }
2636 if (pathstr == NULL) {
2637 pathstr = PyUnicode_InternFromString("__path__");
2638 if (pathstr == NULL)
2639 return NULL;
2640 }
2641 if (pkgstr == NULL) {
2642 pkgstr = PyUnicode_InternFromString("__package__");
2643 if (pkgstr == NULL)
2644 return NULL;
2645 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002646
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002647 *buf = '\0';
2648 *p_buflen = 0;
2649 pkgname = PyDict_GetItem(globals, pkgstr);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002650
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002651 if ((pkgname != NULL) && (pkgname != Py_None)) {
2652 /* __package__ is set, so use it */
2653 char *pkgname_str;
2654 Py_ssize_t len;
Alexandre Vassalottia85998a2008-05-03 18:24:43 +00002655
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002656 if (!PyUnicode_Check(pkgname)) {
2657 PyErr_SetString(PyExc_ValueError,
2658 "__package__ set to non-string");
2659 return NULL;
2660 }
2661 pkgname_str = _PyUnicode_AsStringAndSize(pkgname, &len);
2662 if (len == 0) {
2663 if (level > 0) {
2664 PyErr_SetString(PyExc_ValueError,
2665 "Attempted relative import in non-package");
2666 return NULL;
2667 }
2668 return Py_None;
2669 }
2670 if (len > MAXPATHLEN) {
2671 PyErr_SetString(PyExc_ValueError,
2672 "Package name too long");
2673 return NULL;
2674 }
2675 strcpy(buf, pkgname_str);
2676 } else {
2677 /* __package__ not set, so figure it out and set it */
2678 modname = PyDict_GetItem(globals, namestr);
2679 if (modname == NULL || !PyUnicode_Check(modname))
2680 return Py_None;
Brett Cannon9a5b25a2010-03-01 02:09:17 +00002681
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002682 modpath = PyDict_GetItem(globals, pathstr);
2683 if (modpath != NULL) {
2684 /* __path__ is set, so modname is already the package name */
2685 char *modname_str;
2686 Py_ssize_t len;
2687 int error;
Alexandre Vassalottia85998a2008-05-03 18:24:43 +00002688
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002689 modname_str = _PyUnicode_AsStringAndSize(modname, &len);
2690 if (len > MAXPATHLEN) {
2691 PyErr_SetString(PyExc_ValueError,
2692 "Module name too long");
2693 return NULL;
2694 }
2695 strcpy(buf, modname_str);
2696 error = PyDict_SetItem(globals, pkgstr, modname);
2697 if (error) {
2698 PyErr_SetString(PyExc_ValueError,
2699 "Could not set __package__");
2700 return NULL;
2701 }
2702 } else {
2703 /* Normal module, so work out the package name if any */
2704 char *start = _PyUnicode_AsString(modname);
2705 char *lastdot = strrchr(start, '.');
2706 size_t len;
2707 int error;
2708 if (lastdot == NULL && level > 0) {
2709 PyErr_SetString(PyExc_ValueError,
2710 "Attempted relative import in non-package");
2711 return NULL;
2712 }
2713 if (lastdot == NULL) {
2714 error = PyDict_SetItem(globals, pkgstr, Py_None);
2715 if (error) {
2716 PyErr_SetString(PyExc_ValueError,
2717 "Could not set __package__");
2718 return NULL;
2719 }
2720 return Py_None;
2721 }
2722 len = lastdot - start;
2723 if (len >= MAXPATHLEN) {
2724 PyErr_SetString(PyExc_ValueError,
2725 "Module name too long");
2726 return NULL;
2727 }
2728 strncpy(buf, start, len);
2729 buf[len] = '\0';
2730 pkgname = PyUnicode_FromString(buf);
2731 if (pkgname == NULL) {
2732 return NULL;
2733 }
2734 error = PyDict_SetItem(globals, pkgstr, pkgname);
2735 Py_DECREF(pkgname);
2736 if (error) {
2737 PyErr_SetString(PyExc_ValueError,
2738 "Could not set __package__");
2739 return NULL;
2740 }
2741 }
2742 }
2743 while (--level > 0) {
2744 char *dot = strrchr(buf, '.');
2745 if (dot == NULL) {
2746 PyErr_SetString(PyExc_ValueError,
2747 "Attempted relative import beyond "
2748 "toplevel package");
2749 return NULL;
2750 }
2751 *dot = '\0';
2752 }
2753 *p_buflen = strlen(buf);
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002754
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002755 modules = PyImport_GetModuleDict();
2756 parent = PyDict_GetItemString(modules, buf);
2757 if (parent == NULL) {
2758 if (orig_level < 1) {
2759 PyObject *err_msg = PyBytes_FromFormat(
2760 "Parent module '%.200s' not found "
2761 "while handling absolute import", buf);
2762 if (err_msg == NULL) {
2763 return NULL;
2764 }
2765 if (!PyErr_WarnEx(PyExc_RuntimeWarning,
2766 PyBytes_AsString(err_msg), 1)) {
2767 *buf = '\0';
2768 *p_buflen = 0;
2769 parent = Py_None;
2770 }
2771 Py_DECREF(err_msg);
2772 } else {
2773 PyErr_Format(PyExc_SystemError,
2774 "Parent module '%.200s' not loaded, "
2775 "cannot perform relative import", buf);
2776 }
2777 }
2778 return parent;
2779 /* We expect, but can't guarantee, if parent != None, that:
2780 - parent.__name__ == buf
2781 - parent.__dict__ is globals
2782 If this is violated... Who cares? */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002783}
2784
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002785/* altmod is either None or same as mod */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002786static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002787load_next(PyObject *mod, PyObject *altmod, char **p_name, char *buf,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002788 Py_ssize_t *p_buflen)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002789{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002790 char *name = *p_name;
2791 char *dot = strchr(name, '.');
2792 size_t len;
2793 char *p;
2794 PyObject *result;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002795
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002796 if (strlen(name) == 0) {
2797 /* completely empty module name should only happen in
2798 'from . import' (or '__import__("")')*/
2799 Py_INCREF(mod);
2800 *p_name = NULL;
2801 return mod;
2802 }
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002803
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002804 if (dot == NULL) {
2805 *p_name = NULL;
2806 len = strlen(name);
2807 }
2808 else {
2809 *p_name = dot+1;
2810 len = dot-name;
2811 }
2812 if (len == 0) {
2813 PyErr_SetString(PyExc_ValueError,
2814 "Empty module name");
2815 return NULL;
2816 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002817
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002818 p = buf + *p_buflen;
2819 if (p != buf)
2820 *p++ = '.';
2821 if (p+len-buf >= MAXPATHLEN) {
2822 PyErr_SetString(PyExc_ValueError,
2823 "Module name too long");
2824 return NULL;
2825 }
2826 strncpy(p, name, len);
2827 p[len] = '\0';
2828 *p_buflen = p+len-buf;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002829
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002830 result = import_submodule(mod, p, buf);
2831 if (result == Py_None && altmod != mod) {
2832 Py_DECREF(result);
2833 /* Here, altmod must be None and mod must not be None */
2834 result = import_submodule(altmod, p, p);
2835 if (result != NULL && result != Py_None) {
2836 if (mark_miss(buf) != 0) {
2837 Py_DECREF(result);
2838 return NULL;
2839 }
2840 strncpy(buf, name, len);
2841 buf[len] = '\0';
2842 *p_buflen = len;
2843 }
2844 }
2845 if (result == NULL)
2846 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002847
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002848 if (result == Py_None) {
2849 Py_DECREF(result);
2850 PyErr_Format(PyExc_ImportError,
2851 "No module named %.200s", name);
2852 return NULL;
2853 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002854
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002855 return result;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002856}
2857
2858static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002859mark_miss(char *name)
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00002860{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002861 PyObject *modules = PyImport_GetModuleDict();
2862 return PyDict_SetItemString(modules, name, Py_None);
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00002863}
2864
2865static int
Martin v. Löwis18e16552006-02-15 17:27:45 +00002866ensure_fromlist(PyObject *mod, PyObject *fromlist, char *buf, Py_ssize_t buflen,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002867 int recursive)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002868{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002869 int i;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002870
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002871 if (!PyObject_HasAttrString(mod, "__path__"))
2872 return 1;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002873
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002874 for (i = 0; ; i++) {
2875 PyObject *item = PySequence_GetItem(fromlist, i);
2876 int hasit;
2877 if (item == NULL) {
2878 if (PyErr_ExceptionMatches(PyExc_IndexError)) {
2879 PyErr_Clear();
2880 return 1;
2881 }
2882 return 0;
2883 }
2884 if (!PyUnicode_Check(item)) {
2885 PyErr_SetString(PyExc_TypeError,
2886 "Item in ``from list'' not a string");
2887 Py_DECREF(item);
2888 return 0;
2889 }
2890 if (PyUnicode_AS_UNICODE(item)[0] == '*') {
2891 PyObject *all;
2892 Py_DECREF(item);
2893 /* See if the package defines __all__ */
2894 if (recursive)
2895 continue; /* Avoid endless recursion */
2896 all = PyObject_GetAttrString(mod, "__all__");
2897 if (all == NULL)
2898 PyErr_Clear();
2899 else {
2900 int ret = ensure_fromlist(mod, all, buf, buflen, 1);
2901 Py_DECREF(all);
2902 if (!ret)
2903 return 0;
2904 }
2905 continue;
2906 }
2907 hasit = PyObject_HasAttr(mod, item);
2908 if (!hasit) {
2909 PyObject *item8;
2910 char *subname;
2911 PyObject *submod;
2912 char *p;
Victor Stinnerae6265f2010-05-15 16:27:27 +00002913 item8 = PyUnicode_EncodeFSDefault(item);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002914 if (!item8) {
2915 PyErr_SetString(PyExc_ValueError, "Cannot encode path item");
2916 return 0;
2917 }
2918 subname = PyBytes_AS_STRING(item8);
2919 if (buflen + strlen(subname) >= MAXPATHLEN) {
2920 PyErr_SetString(PyExc_ValueError,
2921 "Module name too long");
2922 Py_DECREF(item);
2923 return 0;
2924 }
2925 p = buf + buflen;
2926 *p++ = '.';
2927 strcpy(p, subname);
2928 submod = import_submodule(mod, subname, buf);
2929 Py_DECREF(item8);
2930 Py_XDECREF(submod);
2931 if (submod == NULL) {
2932 Py_DECREF(item);
2933 return 0;
2934 }
2935 }
2936 Py_DECREF(item);
2937 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002938
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002939 /* NOTREACHED */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002940}
2941
Neil Schemenauer00b09662003-06-16 21:03:07 +00002942static int
2943add_submodule(PyObject *mod, PyObject *submod, char *fullname, char *subname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002944 PyObject *modules)
Neil Schemenauer00b09662003-06-16 21:03:07 +00002945{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002946 if (mod == Py_None)
2947 return 1;
2948 /* Irrespective of the success of this load, make a
2949 reference to it in the parent package module. A copy gets
2950 saved in the modules dictionary under the full name, so get a
2951 reference from there, if need be. (The exception is when the
2952 load failed with a SyntaxError -- then there's no trace in
2953 sys.modules. In that case, of course, do nothing extra.) */
2954 if (submod == NULL) {
2955 submod = PyDict_GetItemString(modules, fullname);
2956 if (submod == NULL)
2957 return 1;
2958 }
2959 if (PyModule_Check(mod)) {
2960 /* We can't use setattr here since it can give a
2961 * spurious warning if the submodule name shadows a
2962 * builtin name */
2963 PyObject *dict = PyModule_GetDict(mod);
2964 if (!dict)
2965 return 0;
2966 if (PyDict_SetItemString(dict, subname, submod) < 0)
2967 return 0;
2968 }
2969 else {
2970 if (PyObject_SetAttrString(mod, subname, submod) < 0)
2971 return 0;
2972 }
2973 return 1;
Neil Schemenauer00b09662003-06-16 21:03:07 +00002974}
2975
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002976static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002977import_submodule(PyObject *mod, char *subname, char *fullname)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002978{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002979 PyObject *modules = PyImport_GetModuleDict();
2980 PyObject *m = NULL;
Guido van Rossum74e6a111994-08-29 12:54:38 +00002981
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002982 /* Require:
2983 if mod == None: subname == fullname
2984 else: mod.__name__ + "." + subname == fullname
2985 */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002986
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002987 if ((m = PyDict_GetItemString(modules, fullname)) != NULL) {
2988 Py_INCREF(m);
2989 }
2990 else {
Victor Stinner7d8b77c2011-03-12 08:45:02 -05002991 PyObject *path, *loader;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002992 char buf[MAXPATHLEN+1];
2993 struct filedescr *fdp;
Victor Stinner7d8b77c2011-03-12 08:45:02 -05002994 FILE *fp;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002995
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002996 if (mod == Py_None)
2997 path = NULL;
2998 else {
2999 path = PyObject_GetAttrString(mod, "__path__");
3000 if (path == NULL) {
3001 PyErr_Clear();
3002 Py_INCREF(Py_None);
3003 return Py_None;
3004 }
3005 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003006
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003007 fdp = find_module(fullname, subname, path, buf, MAXPATHLEN+1,
3008 &fp, &loader);
3009 Py_XDECREF(path);
3010 if (fdp == NULL) {
3011 if (!PyErr_ExceptionMatches(PyExc_ImportError))
3012 return NULL;
3013 PyErr_Clear();
3014 Py_INCREF(Py_None);
3015 return Py_None;
3016 }
3017 m = load_module(fullname, fp, buf, fdp->type, loader);
3018 Py_XDECREF(loader);
3019 if (fp)
3020 fclose(fp);
3021 if (!add_submodule(mod, m, fullname, subname, modules)) {
3022 Py_XDECREF(m);
3023 m = NULL;
3024 }
3025 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003026
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003027 return m;
Guido van Rossum74e6a111994-08-29 12:54:38 +00003028}
3029
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003030
3031/* Re-import a module of any kind and return its module object, WITH
3032 INCREMENTED REFERENCE COUNT */
3033
Guido van Rossum79f25d91997-04-29 20:08:16 +00003034PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003035PyImport_ReloadModule(PyObject *m)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003036{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003037 PyInterpreterState *interp = PyThreadState_Get()->interp;
3038 PyObject *modules_reloading = interp->modules_reloading;
3039 PyObject *modules = PyImport_GetModuleDict();
Victor Stinner7d8b77c2011-03-12 08:45:02 -05003040 PyObject *path = NULL, *loader, *existing_m = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003041 char *name, *subname;
3042 char buf[MAXPATHLEN+1];
3043 struct filedescr *fdp;
Victor Stinner7d8b77c2011-03-12 08:45:02 -05003044 FILE *fp;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003045 PyObject *newm;
Brett Cannon9a5b25a2010-03-01 02:09:17 +00003046
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003047 if (modules_reloading == NULL) {
3048 Py_FatalError("PyImport_ReloadModule: "
3049 "no modules_reloading dictionary!");
3050 return NULL;
3051 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003052
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003053 if (m == NULL || !PyModule_Check(m)) {
3054 PyErr_SetString(PyExc_TypeError,
3055 "reload() argument must be module");
3056 return NULL;
3057 }
3058 name = (char*)PyModule_GetName(m);
3059 if (name == NULL)
3060 return NULL;
3061 if (m != PyDict_GetItemString(modules, name)) {
3062 PyErr_Format(PyExc_ImportError,
3063 "reload(): module %.200s not in sys.modules",
3064 name);
3065 return NULL;
3066 }
3067 existing_m = PyDict_GetItemString(modules_reloading, name);
3068 if (existing_m != NULL) {
3069 /* Due to a recursive reload, this module is already
3070 being reloaded. */
3071 Py_INCREF(existing_m);
3072 return existing_m;
3073 }
3074 if (PyDict_SetItemString(modules_reloading, name, m) < 0)
3075 return NULL;
Guido van Rossumd8faa362007-04-27 19:54:29 +00003076
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003077 subname = strrchr(name, '.');
3078 if (subname == NULL)
3079 subname = name;
3080 else {
3081 PyObject *parentname, *parent;
3082 parentname = PyUnicode_FromStringAndSize(name, (subname-name));
3083 if (parentname == NULL) {
3084 imp_modules_reloading_clear();
3085 return NULL;
3086 }
3087 parent = PyDict_GetItem(modules, parentname);
3088 if (parent == NULL) {
3089 PyErr_Format(PyExc_ImportError,
3090 "reload(): parent %U not in sys.modules",
3091 parentname);
3092 Py_DECREF(parentname);
3093 imp_modules_reloading_clear();
3094 return NULL;
3095 }
3096 Py_DECREF(parentname);
3097 subname++;
3098 path = PyObject_GetAttrString(parent, "__path__");
3099 if (path == NULL)
3100 PyErr_Clear();
3101 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003102 fdp = find_module(name, subname, path, buf, MAXPATHLEN+1, &fp, &loader);
3103 Py_XDECREF(path);
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00003104
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003105 if (fdp == NULL) {
3106 Py_XDECREF(loader);
3107 imp_modules_reloading_clear();
3108 return NULL;
3109 }
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00003110
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003111 newm = load_module(name, fp, buf, fdp->type, loader);
3112 Py_XDECREF(loader);
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00003113
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003114 if (fp)
3115 fclose(fp);
3116 if (newm == NULL) {
3117 /* load_module probably removed name from modules because of
3118 * the error. Put back the original module object. We're
3119 * going to return NULL in this case regardless of whether
3120 * replacing name succeeds, so the return value is ignored.
3121 */
3122 PyDict_SetItemString(modules, name, m);
3123 }
3124 imp_modules_reloading_clear();
3125 return newm;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003126}
3127
3128
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003129/* Higher-level import emulator which emulates the "import" statement
3130 more accurately -- it invokes the __import__() function from the
3131 builtins of the current globals. This means that the import is
3132 done using whatever import hooks are installed in the current
Brett Cannonbc2eff32010-09-19 21:39:02 +00003133 environment.
Guido van Rossum6058eb41998-12-21 19:51:00 +00003134 A dummy list ["__doc__"] is passed as the 4th argument so that
Neal Norwitz80e7f272007-08-26 06:45:23 +00003135 e.g. PyImport_Import(PyUnicode_FromString("win32com.client.gencache"))
Guido van Rossum6058eb41998-12-21 19:51:00 +00003136 will return <module "gencache"> instead of <module "win32com">. */
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003137
3138PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003139PyImport_Import(PyObject *module_name)
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003140{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003141 static PyObject *silly_list = NULL;
3142 static PyObject *builtins_str = NULL;
3143 static PyObject *import_str = NULL;
3144 PyObject *globals = NULL;
3145 PyObject *import = NULL;
3146 PyObject *builtins = NULL;
Brett Cannonbc2eff32010-09-19 21:39:02 +00003147 PyObject *modules = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003148 PyObject *r = NULL;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003149
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003150 /* Initialize constant string objects */
3151 if (silly_list == NULL) {
3152 import_str = PyUnicode_InternFromString("__import__");
3153 if (import_str == NULL)
3154 return NULL;
3155 builtins_str = PyUnicode_InternFromString("__builtins__");
3156 if (builtins_str == NULL)
3157 return NULL;
Brett Cannonbc2eff32010-09-19 21:39:02 +00003158 silly_list = PyList_New(0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003159 if (silly_list == NULL)
3160 return NULL;
3161 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003162
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003163 /* Get the builtins from current globals */
3164 globals = PyEval_GetGlobals();
3165 if (globals != NULL) {
3166 Py_INCREF(globals);
3167 builtins = PyObject_GetItem(globals, builtins_str);
3168 if (builtins == NULL)
3169 goto err;
3170 }
3171 else {
3172 /* No globals -- use standard builtins, and fake globals */
3173 builtins = PyImport_ImportModuleLevel("builtins",
3174 NULL, NULL, NULL, 0);
3175 if (builtins == NULL)
3176 return NULL;
3177 globals = Py_BuildValue("{OO}", builtins_str, builtins);
3178 if (globals == NULL)
3179 goto err;
3180 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003181
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003182 /* Get the __import__ function from the builtins */
3183 if (PyDict_Check(builtins)) {
3184 import = PyObject_GetItem(builtins, import_str);
3185 if (import == NULL)
3186 PyErr_SetObject(PyExc_KeyError, import_str);
3187 }
3188 else
3189 import = PyObject_GetAttr(builtins, import_str);
3190 if (import == NULL)
3191 goto err;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003192
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003193 /* Call the __import__ function with the proper argument list
Brett Cannonbc2eff32010-09-19 21:39:02 +00003194 Always use absolute import here.
3195 Calling for side-effect of import. */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003196 r = PyObject_CallFunction(import, "OOOOi", module_name, globals,
3197 globals, silly_list, 0, NULL);
Brett Cannonbc2eff32010-09-19 21:39:02 +00003198 if (r == NULL)
3199 goto err;
3200 Py_DECREF(r);
3201
3202 modules = PyImport_GetModuleDict();
3203 r = PyDict_GetItem(modules, module_name);
3204 if (r != NULL)
3205 Py_INCREF(r);
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003206
3207 err:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003208 Py_XDECREF(globals);
3209 Py_XDECREF(builtins);
3210 Py_XDECREF(import);
Tim Peters50d8d372001-02-28 05:34:27 +00003211
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003212 return r;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003213}
3214
3215
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003216/* Module 'imp' provides Python access to the primitives used for
3217 importing modules.
3218*/
3219
Guido van Rossum79f25d91997-04-29 20:08:16 +00003220static PyObject *
Barry Warsaw28a691b2010-04-17 00:19:56 +00003221imp_make_magic(long magic)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003222{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003223 char buf[4];
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003224
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003225 buf[0] = (char) ((magic >> 0) & 0xff);
3226 buf[1] = (char) ((magic >> 8) & 0xff);
3227 buf[2] = (char) ((magic >> 16) & 0xff);
3228 buf[3] = (char) ((magic >> 24) & 0xff);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003229
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003230 return PyBytes_FromStringAndSize(buf, 4);
Victor Stinner3e2b7172010-11-09 09:32:19 +00003231}
Barry Warsaw28a691b2010-04-17 00:19:56 +00003232
3233static PyObject *
3234imp_get_magic(PyObject *self, PyObject *noargs)
3235{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003236 return imp_make_magic(pyc_magic);
Barry Warsaw28a691b2010-04-17 00:19:56 +00003237}
3238
3239static PyObject *
3240imp_get_tag(PyObject *self, PyObject *noargs)
3241{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003242 return PyUnicode_FromString(pyc_tag);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003243}
3244
Guido van Rossum79f25d91997-04-29 20:08:16 +00003245static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +00003246imp_get_suffixes(PyObject *self, PyObject *noargs)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003247{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003248 PyObject *list;
3249 struct filedescr *fdp;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003250
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003251 list = PyList_New(0);
3252 if (list == NULL)
3253 return NULL;
3254 for (fdp = _PyImport_Filetab; fdp->suffix != NULL; fdp++) {
3255 PyObject *item = Py_BuildValue("ssi",
3256 fdp->suffix, fdp->mode, fdp->type);
3257 if (item == NULL) {
3258 Py_DECREF(list);
3259 return NULL;
3260 }
3261 if (PyList_Append(list, item) < 0) {
3262 Py_DECREF(list);
3263 Py_DECREF(item);
3264 return NULL;
3265 }
3266 Py_DECREF(item);
3267 }
3268 return list;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003269}
3270
Guido van Rossum79f25d91997-04-29 20:08:16 +00003271static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003272call_find_module(char *name, PyObject *path)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003273{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003274 extern int fclose(FILE *);
3275 PyObject *fob, *ret;
3276 PyObject *pathobj;
3277 struct filedescr *fdp;
3278 char pathname[MAXPATHLEN+1];
Victor Stinner7d8b77c2011-03-12 08:45:02 -05003279 FILE *fp;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003280 int fd = -1;
3281 char *found_encoding = NULL;
3282 char *encoding = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003283
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003284 pathname[0] = '\0';
3285 if (path == Py_None)
3286 path = NULL;
3287 fdp = find_module(NULL, name, path, pathname, MAXPATHLEN+1, &fp, NULL);
3288 if (fdp == NULL)
3289 return NULL;
3290 if (fp != NULL) {
3291 fd = fileno(fp);
3292 if (fd != -1)
3293 fd = dup(fd);
3294 fclose(fp);
3295 fp = NULL;
3296 }
3297 if (fd != -1) {
3298 if (strchr(fdp->mode, 'b') == NULL) {
3299 /* PyTokenizer_FindEncoding() returns PyMem_MALLOC'ed
3300 memory. */
3301 found_encoding = PyTokenizer_FindEncoding(fd);
3302 lseek(fd, 0, 0); /* Reset position */
3303 if (found_encoding == NULL && PyErr_Occurred())
3304 return NULL;
3305 encoding = (found_encoding != NULL) ? found_encoding :
3306 (char*)PyUnicode_GetDefaultEncoding();
3307 }
3308 fob = PyFile_FromFd(fd, pathname, fdp->mode, -1,
3309 (char*)encoding, NULL, NULL, 1);
3310 if (fob == NULL) {
3311 close(fd);
3312 PyMem_FREE(found_encoding);
3313 return NULL;
3314 }
3315 }
3316 else {
3317 fob = Py_None;
3318 Py_INCREF(fob);
3319 }
3320 pathobj = PyUnicode_DecodeFSDefault(pathname);
3321 ret = Py_BuildValue("NN(ssi)",
3322 fob, pathobj, fdp->suffix, fdp->mode, fdp->type);
3323 PyMem_FREE(found_encoding);
Brett Cannon3bb42d92007-10-20 03:43:15 +00003324
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003325 return ret;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003326}
3327
Guido van Rossum79f25d91997-04-29 20:08:16 +00003328static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003329imp_find_module(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003330{
Victor Stinnerebc00522010-12-03 17:06:43 +00003331 PyObject *name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003332 PyObject *ret, *path = NULL;
Victor Stinnerebc00522010-12-03 17:06:43 +00003333 if (!PyArg_ParseTuple(args, "O&|O:find_module",
3334 PyUnicode_FSConverter, &name,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003335 &path))
3336 return NULL;
Victor Stinnerebc00522010-12-03 17:06:43 +00003337 ret = call_find_module(PyBytes_AS_STRING(name), path);
3338 Py_DECREF(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003339 return ret;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003340}
3341
3342static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003343imp_init_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003344{
Victor Stinner95872862011-03-07 18:20:56 +01003345 PyObject *name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003346 int ret;
3347 PyObject *m;
Victor Stinner95872862011-03-07 18:20:56 +01003348 if (!PyArg_ParseTuple(args, "U:init_builtin", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003349 return NULL;
3350 ret = init_builtin(name);
3351 if (ret < 0)
3352 return NULL;
3353 if (ret == 0) {
3354 Py_INCREF(Py_None);
3355 return Py_None;
3356 }
Victor Stinner95872862011-03-07 18:20:56 +01003357 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003358 Py_XINCREF(m);
3359 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003360}
3361
Guido van Rossum79f25d91997-04-29 20:08:16 +00003362static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003363imp_init_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003364{
Victor Stinner53dc7352011-03-20 01:50:21 +01003365 PyObject *name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003366 int ret;
3367 PyObject *m;
Victor Stinner53dc7352011-03-20 01:50:21 +01003368 if (!PyArg_ParseTuple(args, "U:init_frozen", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003369 return NULL;
Victor Stinner53dc7352011-03-20 01:50:21 +01003370 ret = PyImport_ImportFrozenModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003371 if (ret < 0)
3372 return NULL;
3373 if (ret == 0) {
3374 Py_INCREF(Py_None);
3375 return Py_None;
3376 }
Victor Stinner53dc7352011-03-20 01:50:21 +01003377 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003378 Py_XINCREF(m);
3379 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003380}
3381
Guido van Rossum79f25d91997-04-29 20:08:16 +00003382static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003383imp_get_frozen_object(PyObject *self, PyObject *args)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00003384{
Victor Stinner53dc7352011-03-20 01:50:21 +01003385 PyObject *name;
Jack Jansen95ffa231995-10-03 14:38:41 +00003386
Victor Stinner53dc7352011-03-20 01:50:21 +01003387 if (!PyArg_ParseTuple(args, "U:get_frozen_object", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003388 return NULL;
3389 return get_frozen_object(name);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00003390}
3391
Guido van Rossum79f25d91997-04-29 20:08:16 +00003392static PyObject *
Brett Cannon8d110132009-03-15 02:20:16 +00003393imp_is_frozen_package(PyObject *self, PyObject *args)
3394{
Victor Stinner53dc7352011-03-20 01:50:21 +01003395 PyObject *name;
Brett Cannon8d110132009-03-15 02:20:16 +00003396
Victor Stinner53dc7352011-03-20 01:50:21 +01003397 if (!PyArg_ParseTuple(args, "U:is_frozen_package", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003398 return NULL;
3399 return is_frozen_package(name);
Brett Cannon8d110132009-03-15 02:20:16 +00003400}
3401
3402static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003403imp_is_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003404{
Victor Stinner95872862011-03-07 18:20:56 +01003405 PyObject *name;
3406 if (!PyArg_ParseTuple(args, "U:is_builtin", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003407 return NULL;
3408 return PyLong_FromLong(is_builtin(name));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003409}
3410
Guido van Rossum79f25d91997-04-29 20:08:16 +00003411static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003412imp_is_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003413{
Victor Stinner53dc7352011-03-20 01:50:21 +01003414 PyObject *name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003415 struct _frozen *p;
Victor Stinner53dc7352011-03-20 01:50:21 +01003416 if (!PyArg_ParseTuple(args, "U:is_frozen", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003417 return NULL;
3418 p = find_frozen(name);
3419 return PyBool_FromLong((long) (p == NULL ? 0 : p->size));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003420}
3421
3422static FILE *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003423get_file(char *pathname, PyObject *fob, char *mode)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003424{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003425 FILE *fp;
3426 if (mode[0] == 'U')
3427 mode = "r" PY_STDIOTEXTMODE;
3428 if (fob == NULL) {
3429 fp = fopen(pathname, mode);
3430 }
3431 else {
3432 int fd = PyObject_AsFileDescriptor(fob);
3433 if (fd == -1)
3434 return NULL;
3435 if (!_PyVerify_fd(fd))
3436 goto error;
3437 /* the FILE struct gets a new fd, so that it can be closed
3438 * independently of the file descriptor given
3439 */
3440 fd = dup(fd);
3441 if (fd == -1)
3442 goto error;
3443 fp = fdopen(fd, mode);
3444 }
3445 if (fp)
3446 return fp;
Kristján Valur Jónssone1b04452009-03-31 17:43:39 +00003447error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003448 PyErr_SetFromErrno(PyExc_IOError);
3449 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003450}
3451
Guido van Rossum79f25d91997-04-29 20:08:16 +00003452static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003453imp_load_compiled(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003454{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003455 char *name;
Victor Stinnerebc00522010-12-03 17:06:43 +00003456 PyObject *pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003457 PyObject *fob = NULL;
3458 PyObject *m;
3459 FILE *fp;
Victor Stinnerebc00522010-12-03 17:06:43 +00003460 if (!PyArg_ParseTuple(args, "sO&|O:load_compiled",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003461 &name,
Victor Stinnerebc00522010-12-03 17:06:43 +00003462 PyUnicode_FSConverter, &pathname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003463 &fob))
3464 return NULL;
Victor Stinnerebc00522010-12-03 17:06:43 +00003465 fp = get_file(PyBytes_AS_STRING(pathname), fob, "rb");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003466 if (fp == NULL) {
Victor Stinnerebc00522010-12-03 17:06:43 +00003467 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003468 return NULL;
3469 }
Victor Stinnerebc00522010-12-03 17:06:43 +00003470 m = load_compiled_module(name, PyBytes_AS_STRING(pathname), fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003471 fclose(fp);
Victor Stinnerebc00522010-12-03 17:06:43 +00003472 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003473 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003474}
3475
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003476#ifdef HAVE_DYNAMIC_LOADING
3477
Guido van Rossum79f25d91997-04-29 20:08:16 +00003478static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003479imp_load_dynamic(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003480{
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003481 PyObject *name, *pathname, *fob = NULL, *mod;
3482 FILE *fp;
3483
3484 if (!PyArg_ParseTuple(args, "UO&|O:load_dynamic",
3485 &name, PyUnicode_FSDecoder, &pathname, &fob))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003486 return NULL;
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003487 if (fob != NULL) {
3488 fp = get_file(NULL, fob, "r");
3489 if (fp == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003490 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003491 }
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003492 else
3493 fp = NULL;
3494 mod = _PyImport_LoadDynamicModule(name, pathname, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003495 if (fp)
3496 fclose(fp);
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003497 return mod;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003498}
3499
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003500#endif /* HAVE_DYNAMIC_LOADING */
3501
Guido van Rossum79f25d91997-04-29 20:08:16 +00003502static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003503imp_load_source(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003504{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003505 char *name;
Victor Stinnerebc00522010-12-03 17:06:43 +00003506 PyObject *pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003507 PyObject *fob = NULL;
3508 PyObject *m;
3509 FILE *fp;
Victor Stinnerebc00522010-12-03 17:06:43 +00003510 if (!PyArg_ParseTuple(args, "sO&|O:load_source",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003511 &name,
Victor Stinnerebc00522010-12-03 17:06:43 +00003512 PyUnicode_FSConverter, &pathname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003513 &fob))
3514 return NULL;
Victor Stinnerebc00522010-12-03 17:06:43 +00003515 fp = get_file(PyBytes_AS_STRING(pathname), fob, "r");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003516 if (fp == NULL) {
Victor Stinnerebc00522010-12-03 17:06:43 +00003517 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003518 return NULL;
3519 }
Victor Stinnerebc00522010-12-03 17:06:43 +00003520 m = load_source_module(name, PyBytes_AS_STRING(pathname), fp);
3521 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003522 fclose(fp);
3523 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003524}
3525
Guido van Rossum79f25d91997-04-29 20:08:16 +00003526static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003527imp_load_module(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003528{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003529 char *name;
3530 PyObject *fob;
Victor Stinner1a563032010-10-15 22:43:10 +00003531 PyObject *pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003532 PyObject * ret;
3533 char *suffix; /* Unused */
3534 char *mode;
3535 int type;
3536 FILE *fp;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003537
Victor Stinner1a563032010-10-15 22:43:10 +00003538 if (!PyArg_ParseTuple(args, "sOO&(ssi):load_module",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003539 &name, &fob,
Victor Stinner1a563032010-10-15 22:43:10 +00003540 PyUnicode_FSConverter, &pathname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003541 &suffix, &mode, &type))
3542 return NULL;
3543 if (*mode) {
3544 /* Mode must start with 'r' or 'U' and must not contain '+'.
3545 Implicit in this test is the assumption that the mode
3546 may contain other modifiers like 'b' or 't'. */
Guido van Rossum5e2c5fa2002-05-30 17:33:07 +00003547
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003548 if (!(*mode == 'r' || *mode == 'U') || strchr(mode, '+')) {
3549 PyErr_Format(PyExc_ValueError,
3550 "invalid file open mode %.200s", mode);
Victor Stinner1a563032010-10-15 22:43:10 +00003551 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003552 return NULL;
3553 }
3554 }
3555 if (fob == Py_None)
3556 fp = NULL;
3557 else {
3558 fp = get_file(NULL, fob, mode);
3559 if (fp == NULL) {
Victor Stinner1a563032010-10-15 22:43:10 +00003560 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003561 return NULL;
3562 }
3563 }
Victor Stinner1a563032010-10-15 22:43:10 +00003564 ret = load_module(name, fp, PyBytes_AS_STRING(pathname), type, NULL);
3565 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003566 if (fp)
3567 fclose(fp);
3568 return ret;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003569}
3570
3571static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003572imp_load_package(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003573{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003574 char *name;
Victor Stinnerebc00522010-12-03 17:06:43 +00003575 PyObject *pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003576 PyObject * ret;
Victor Stinnerebc00522010-12-03 17:06:43 +00003577 if (!PyArg_ParseTuple(args, "sO&:load_package",
3578 &name, PyUnicode_FSConverter, &pathname))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003579 return NULL;
Victor Stinnerebc00522010-12-03 17:06:43 +00003580 ret = load_package(name, PyBytes_AS_STRING(pathname));
3581 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003582 return ret;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003583}
3584
3585static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003586imp_new_module(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003587{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003588 char *name;
3589 if (!PyArg_ParseTuple(args, "s:new_module", &name))
3590 return NULL;
3591 return PyModule_New(name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003592}
3593
Christian Heimes13a7a212008-01-07 17:13:09 +00003594static PyObject *
3595imp_reload(PyObject *self, PyObject *v)
3596{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003597 return PyImport_ReloadModule(v);
Christian Heimes13a7a212008-01-07 17:13:09 +00003598}
3599
3600PyDoc_STRVAR(doc_reload,
3601"reload(module) -> module\n\
3602\n\
3603Reload the module. The module must have been successfully imported before.");
3604
Barry Warsaw28a691b2010-04-17 00:19:56 +00003605static PyObject *
3606imp_cache_from_source(PyObject *self, PyObject *args, PyObject *kws)
3607{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003608 static char *kwlist[] = {"path", "debug_override", NULL};
Barry Warsaw28a691b2010-04-17 00:19:56 +00003609
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003610 char buf[MAXPATHLEN+1];
Victor Stinner3ea23dd2010-10-15 20:34:32 +00003611 PyObject *pathbytes;
3612 char *cpathname;
Benjamin Peterson294a9fc2010-10-16 03:12:39 +00003613 PyObject *debug_override = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003614 int debug = !Py_OptimizeFlag;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003615
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003616 if (!PyArg_ParseTupleAndKeywords(
Victor Stinner3ea23dd2010-10-15 20:34:32 +00003617 args, kws, "O&|O", kwlist,
3618 PyUnicode_FSConverter, &pathbytes, &debug_override))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003619 return NULL;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003620
Benjamin Peterson294a9fc2010-10-16 03:12:39 +00003621 if (debug_override != NULL &&
3622 (debug = PyObject_IsTrue(debug_override)) < 0) {
3623 Py_DECREF(pathbytes);
3624 return NULL;
3625 }
Barry Warsaw28a691b2010-04-17 00:19:56 +00003626
Victor Stinner3ea23dd2010-10-15 20:34:32 +00003627 cpathname = make_compiled_pathname(
3628 PyBytes_AS_STRING(pathbytes),
3629 buf, MAXPATHLEN+1, debug);
3630 Py_DECREF(pathbytes);
Barry Warsaw28a691b2010-04-17 00:19:56 +00003631
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003632 if (cpathname == NULL) {
3633 PyErr_Format(PyExc_SystemError, "path buffer too short");
3634 return NULL;
3635 }
Victor Stinner88bd8912010-10-15 22:46:07 +00003636 return PyUnicode_DecodeFSDefault(buf);
Barry Warsaw28a691b2010-04-17 00:19:56 +00003637}
3638
3639PyDoc_STRVAR(doc_cache_from_source,
3640"Given the path to a .py file, return the path to its .pyc/.pyo file.\n\
3641\n\
3642The .py file does not need to exist; this simply returns the path to the\n\
3643.pyc/.pyo file calculated as if the .py file were imported. The extension\n\
3644will be .pyc unless __debug__ is not defined, then it will be .pyo.\n\
3645\n\
3646If debug_override is not None, then it must be a boolean and is taken as\n\
3647the value of __debug__ instead.");
3648
3649static PyObject *
3650imp_source_from_cache(PyObject *self, PyObject *args, PyObject *kws)
3651{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003652 static char *kwlist[] = {"path", NULL};
Barry Warsaw28a691b2010-04-17 00:19:56 +00003653
Victor Stinnerebc00522010-12-03 17:06:43 +00003654 PyObject *pathname_obj;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003655 char *pathname;
3656 char buf[MAXPATHLEN+1];
Barry Warsaw28a691b2010-04-17 00:19:56 +00003657
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003658 if (!PyArg_ParseTupleAndKeywords(
Victor Stinnerebc00522010-12-03 17:06:43 +00003659 args, kws, "O&", kwlist,
3660 PyUnicode_FSConverter, &pathname_obj))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003661 return NULL;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003662
Victor Stinnerebc00522010-12-03 17:06:43 +00003663 pathname = PyBytes_AS_STRING(pathname_obj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003664 if (make_source_pathname(pathname, buf) == NULL) {
3665 PyErr_Format(PyExc_ValueError, "Not a PEP 3147 pyc path: %s",
3666 pathname);
Victor Stinnerebc00522010-12-03 17:06:43 +00003667 Py_DECREF(pathname_obj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003668 return NULL;
3669 }
Victor Stinnerebc00522010-12-03 17:06:43 +00003670 Py_DECREF(pathname_obj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003671 return PyUnicode_FromString(buf);
Barry Warsaw28a691b2010-04-17 00:19:56 +00003672}
3673
3674PyDoc_STRVAR(doc_source_from_cache,
3675"Given the path to a .pyc./.pyo file, return the path to its .py file.\n\
3676\n\
3677The .pyc/.pyo file does not need to exist; this simply returns the path to\n\
3678the .py file calculated to correspond to the .pyc/.pyo file. If path\n\
3679does not conform to PEP 3147 format, ValueError will be raised.");
3680
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003681/* Doc strings */
3682
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003683PyDoc_STRVAR(doc_imp,
3684"This module provides the components needed to build your own\n\
3685__import__ function. Undocumented functions are obsolete.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003686
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003687PyDoc_STRVAR(doc_find_module,
3688"find_module(name, [path]) -> (file, filename, (suffix, mode, type))\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003689Search for a module. If path is omitted or None, search for a\n\
3690built-in, frozen or special module and continue search in sys.path.\n\
3691The module name cannot contain '.'; to search for a submodule of a\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003692package, pass the submodule name and the package's __path__.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003693
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003694PyDoc_STRVAR(doc_load_module,
3695"load_module(name, file, filename, (suffix, mode, type)) -> module\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003696Load a module, given information returned by find_module().\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003697The module name must include the full package name, if any.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003698
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003699PyDoc_STRVAR(doc_get_magic,
3700"get_magic() -> string\n\
3701Return the magic number for .pyc or .pyo files.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003702
Barry Warsaw28a691b2010-04-17 00:19:56 +00003703PyDoc_STRVAR(doc_get_tag,
3704"get_tag() -> string\n\
3705Return the magic tag for .pyc or .pyo files.");
3706
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003707PyDoc_STRVAR(doc_get_suffixes,
3708"get_suffixes() -> [(suffix, mode, type), ...]\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003709Return a list of (suffix, mode, type) tuples describing the files\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003710that find_module() looks for.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003711
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003712PyDoc_STRVAR(doc_new_module,
3713"new_module(name) -> module\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003714Create a new module. Do not enter it in sys.modules.\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003715The module name must include the full package name, if any.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003716
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003717PyDoc_STRVAR(doc_lock_held,
Tim Petersa7c65092004-08-01 23:26:05 +00003718"lock_held() -> boolean\n\
3719Return True if the import lock is currently held, else False.\n\
3720On platforms without threads, return False.");
Tim Peters69232342001-08-30 05:16:13 +00003721
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00003722PyDoc_STRVAR(doc_acquire_lock,
3723"acquire_lock() -> None\n\
Neal Norwitz2294c0d2003-02-12 23:02:21 +00003724Acquires the interpreter's import lock for the current thread.\n\
3725This lock should be used by import hooks to ensure thread-safety\n\
3726when importing modules.\n\
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00003727On platforms without threads, this function does nothing.");
3728
3729PyDoc_STRVAR(doc_release_lock,
3730"release_lock() -> None\n\
3731Release the interpreter's import lock.\n\
3732On platforms without threads, this function does nothing.");
3733
Guido van Rossum79f25d91997-04-29 20:08:16 +00003734static PyMethodDef imp_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003735 {"find_module", imp_find_module, METH_VARARGS, doc_find_module},
3736 {"get_magic", imp_get_magic, METH_NOARGS, doc_get_magic},
3737 {"get_tag", imp_get_tag, METH_NOARGS, doc_get_tag},
3738 {"get_suffixes", imp_get_suffixes, METH_NOARGS, doc_get_suffixes},
3739 {"load_module", imp_load_module, METH_VARARGS, doc_load_module},
3740 {"new_module", imp_new_module, METH_VARARGS, doc_new_module},
3741 {"lock_held", imp_lock_held, METH_NOARGS, doc_lock_held},
3742 {"acquire_lock", imp_acquire_lock, METH_NOARGS, doc_acquire_lock},
3743 {"release_lock", imp_release_lock, METH_NOARGS, doc_release_lock},
3744 {"reload", imp_reload, METH_O, doc_reload},
3745 {"cache_from_source", (PyCFunction)imp_cache_from_source,
3746 METH_VARARGS | METH_KEYWORDS, doc_cache_from_source},
3747 {"source_from_cache", (PyCFunction)imp_source_from_cache,
3748 METH_VARARGS | METH_KEYWORDS, doc_source_from_cache},
3749 /* The rest are obsolete */
3750 {"get_frozen_object", imp_get_frozen_object, METH_VARARGS},
3751 {"is_frozen_package", imp_is_frozen_package, METH_VARARGS},
3752 {"init_builtin", imp_init_builtin, METH_VARARGS},
3753 {"init_frozen", imp_init_frozen, METH_VARARGS},
3754 {"is_builtin", imp_is_builtin, METH_VARARGS},
3755 {"is_frozen", imp_is_frozen, METH_VARARGS},
3756 {"load_compiled", imp_load_compiled, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003757#ifdef HAVE_DYNAMIC_LOADING
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003758 {"load_dynamic", imp_load_dynamic, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003759#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003760 {"load_package", imp_load_package, METH_VARARGS},
3761 {"load_source", imp_load_source, METH_VARARGS},
3762 {NULL, NULL} /* sentinel */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003763};
3764
Guido van Rossum1a8791e1998-08-04 22:46:29 +00003765static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003766setint(PyObject *d, char *name, int value)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003767{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003768 PyObject *v;
3769 int err;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003770
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003771 v = PyLong_FromLong((long)value);
3772 err = PyDict_SetItemString(d, name, v);
3773 Py_XDECREF(v);
3774 return err;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003775}
3776
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003777typedef struct {
3778 PyObject_HEAD
3779} NullImporter;
3780
3781static int
3782NullImporter_init(NullImporter *self, PyObject *args, PyObject *kwds)
3783{
Victor Stinner1a4d12d2010-08-13 13:07:29 +00003784#ifndef MS_WINDOWS
3785 PyObject *path;
3786 struct stat statbuf;
3787 int rv;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003788
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003789 if (!_PyArg_NoKeywords("NullImporter()", kwds))
3790 return -1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003791
Victor Stinner1a4d12d2010-08-13 13:07:29 +00003792 if (!PyArg_ParseTuple(args, "O&:NullImporter",
3793 PyUnicode_FSConverter, &path))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003794 return -1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003795
Victor Stinner1a4d12d2010-08-13 13:07:29 +00003796 if (PyBytes_GET_SIZE(path) == 0) {
3797 Py_DECREF(path);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003798 PyErr_SetString(PyExc_ImportError, "empty pathname");
3799 return -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003800 }
Victor Stinner1a4d12d2010-08-13 13:07:29 +00003801
3802 rv = stat(PyBytes_AS_STRING(path), &statbuf);
3803 Py_DECREF(path);
3804 if (rv == 0) {
3805 /* it exists */
3806 if (S_ISDIR(statbuf.st_mode)) {
3807 /* it's a directory */
3808 PyErr_SetString(PyExc_ImportError, "existing directory");
3809 return -1;
3810 }
3811 }
3812#else /* MS_WINDOWS */
3813 PyObject *pathobj;
3814 DWORD rv;
Victor Stinner255dfdb2010-09-29 10:28:51 +00003815 wchar_t *path;
Victor Stinner1a4d12d2010-08-13 13:07:29 +00003816
3817 if (!_PyArg_NoKeywords("NullImporter()", kwds))
3818 return -1;
3819
3820 if (!PyArg_ParseTuple(args, "U:NullImporter",
3821 &pathobj))
3822 return -1;
3823
3824 if (PyUnicode_GET_SIZE(pathobj) == 0) {
3825 PyErr_SetString(PyExc_ImportError, "empty pathname");
3826 return -1;
3827 }
3828
Victor Stinnerbeb4135b2010-10-07 01:02:42 +00003829 path = PyUnicode_AsWideCharString(pathobj, NULL);
Victor Stinner255dfdb2010-09-29 10:28:51 +00003830 if (path == NULL)
Victor Stinner1a4d12d2010-08-13 13:07:29 +00003831 return -1;
3832 /* see issue1293 and issue3677:
3833 * stat() on Windows doesn't recognise paths like
3834 * "e:\\shared\\" and "\\\\whiterab-c2znlh\\shared" as dirs.
3835 */
3836 rv = GetFileAttributesW(path);
Victor Stinner255dfdb2010-09-29 10:28:51 +00003837 PyMem_Free(path);
Victor Stinner1a4d12d2010-08-13 13:07:29 +00003838 if (rv != INVALID_FILE_ATTRIBUTES) {
3839 /* it exists */
3840 if (rv & FILE_ATTRIBUTE_DIRECTORY) {
3841 /* it's a directory */
3842 PyErr_SetString(PyExc_ImportError, "existing directory");
3843 return -1;
3844 }
3845 }
3846#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003847 return 0;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003848}
3849
3850static PyObject *
3851NullImporter_find_module(NullImporter *self, PyObject *args)
3852{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003853 Py_RETURN_NONE;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003854}
3855
3856static PyMethodDef NullImporter_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003857 {"find_module", (PyCFunction)NullImporter_find_module, METH_VARARGS,
3858 "Always return None"
3859 },
3860 {NULL} /* Sentinel */
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003861};
3862
3863
Christian Heimes9cd17752007-11-18 19:35:23 +00003864PyTypeObject PyNullImporter_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003865 PyVarObject_HEAD_INIT(NULL, 0)
3866 "imp.NullImporter", /*tp_name*/
3867 sizeof(NullImporter), /*tp_basicsize*/
3868 0, /*tp_itemsize*/
3869 0, /*tp_dealloc*/
3870 0, /*tp_print*/
3871 0, /*tp_getattr*/
3872 0, /*tp_setattr*/
3873 0, /*tp_reserved*/
3874 0, /*tp_repr*/
3875 0, /*tp_as_number*/
3876 0, /*tp_as_sequence*/
3877 0, /*tp_as_mapping*/
3878 0, /*tp_hash */
3879 0, /*tp_call*/
3880 0, /*tp_str*/
3881 0, /*tp_getattro*/
3882 0, /*tp_setattro*/
3883 0, /*tp_as_buffer*/
3884 Py_TPFLAGS_DEFAULT, /*tp_flags*/
3885 "Null importer object", /* tp_doc */
3886 0, /* tp_traverse */
3887 0, /* tp_clear */
3888 0, /* tp_richcompare */
3889 0, /* tp_weaklistoffset */
3890 0, /* tp_iter */
3891 0, /* tp_iternext */
3892 NullImporter_methods, /* tp_methods */
3893 0, /* tp_members */
3894 0, /* tp_getset */
3895 0, /* tp_base */
3896 0, /* tp_dict */
3897 0, /* tp_descr_get */
3898 0, /* tp_descr_set */
3899 0, /* tp_dictoffset */
3900 (initproc)NullImporter_init, /* tp_init */
3901 0, /* tp_alloc */
3902 PyType_GenericNew /* tp_new */
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003903};
3904
Martin v. Löwis1a214512008-06-11 05:26:20 +00003905static struct PyModuleDef impmodule = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003906 PyModuleDef_HEAD_INIT,
3907 "imp",
3908 doc_imp,
3909 0,
3910 imp_methods,
3911 NULL,
3912 NULL,
3913 NULL,
3914 NULL
Martin v. Löwis1a214512008-06-11 05:26:20 +00003915};
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003916
Jason Tishler6bc06ec2003-09-04 11:59:50 +00003917PyMODINIT_FUNC
Martin v. Löwis1a214512008-06-11 05:26:20 +00003918PyInit_imp(void)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003919{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003920 PyObject *m, *d;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003921
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003922 if (PyType_Ready(&PyNullImporter_Type) < 0)
3923 return NULL;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00003924
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003925 m = PyModule_Create(&impmodule);
3926 if (m == NULL)
3927 goto failure;
3928 d = PyModule_GetDict(m);
3929 if (d == NULL)
3930 goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003931
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003932 if (setint(d, "SEARCH_ERROR", SEARCH_ERROR) < 0) goto failure;
3933 if (setint(d, "PY_SOURCE", PY_SOURCE) < 0) goto failure;
3934 if (setint(d, "PY_COMPILED", PY_COMPILED) < 0) goto failure;
3935 if (setint(d, "C_EXTENSION", C_EXTENSION) < 0) goto failure;
3936 if (setint(d, "PY_RESOURCE", PY_RESOURCE) < 0) goto failure;
3937 if (setint(d, "PKG_DIRECTORY", PKG_DIRECTORY) < 0) goto failure;
3938 if (setint(d, "C_BUILTIN", C_BUILTIN) < 0) goto failure;
3939 if (setint(d, "PY_FROZEN", PY_FROZEN) < 0) goto failure;
3940 if (setint(d, "PY_CODERESOURCE", PY_CODERESOURCE) < 0) goto failure;
3941 if (setint(d, "IMP_HOOK", IMP_HOOK) < 0) goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003942
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003943 Py_INCREF(&PyNullImporter_Type);
3944 PyModule_AddObject(m, "NullImporter", (PyObject *)&PyNullImporter_Type);
3945 return m;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003946 failure:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003947 Py_XDECREF(m);
3948 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003949}
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003950
3951
Guido van Rossumb18618d2000-05-03 23:44:39 +00003952/* API for embedding applications that want to add their own entries
3953 to the table of built-in modules. This should normally be called
3954 *before* Py_Initialize(). When the table resize fails, -1 is
3955 returned and the existing table is unchanged.
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003956
3957 After a similar function by Just van Rossum. */
3958
3959int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003960PyImport_ExtendInittab(struct _inittab *newtab)
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003961{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003962 static struct _inittab *our_copy = NULL;
3963 struct _inittab *p;
3964 int i, n;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003965
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003966 /* Count the number of entries in both tables */
3967 for (n = 0; newtab[n].name != NULL; n++)
3968 ;
3969 if (n == 0)
3970 return 0; /* Nothing to do */
3971 for (i = 0; PyImport_Inittab[i].name != NULL; i++)
3972 ;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003973
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003974 /* Allocate new memory for the combined table */
3975 p = our_copy;
3976 PyMem_RESIZE(p, struct _inittab, i+n+1);
3977 if (p == NULL)
3978 return -1;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003979
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003980 /* Copy the tables into the new memory */
3981 if (our_copy != PyImport_Inittab)
3982 memcpy(p, PyImport_Inittab, (i+1) * sizeof(struct _inittab));
3983 PyImport_Inittab = our_copy = p;
3984 memcpy(p+i, newtab, (n+1) * sizeof(struct _inittab));
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003985
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003986 return 0;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003987}
3988
3989/* Shorthand to add a single entry given a name and a function */
3990
3991int
Brett Cannona826f322009-04-02 03:41:46 +00003992PyImport_AppendInittab(const char *name, PyObject* (*initfunc)(void))
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003993{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003994 struct _inittab newtab[2];
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003995
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003996 memset(newtab, '\0', sizeof newtab);
Guido van Rossum09cae1f1998-05-14 02:32:54 +00003997
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003998 newtab[0].name = (char *)name;
3999 newtab[0].initfunc = initfunc;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004000
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004001 return PyImport_ExtendInittab(newtab);
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004002}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00004003
4004#ifdef __cplusplus
4005}
4006#endif