blob: 0db7e43d29aeb726839ad34ea9d995205d0bcc6f [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)
Benjamin Petersone7c15fa2011-06-19 19:54:45 -0500105 Python 3.3a0 3190 __class__ super closure changed
Tim Peters36515e22001-11-18 04:06:29 +0000106*/
Guido van Rossum3ddee711991-12-16 13:06:34 +0000107
Nick Coghlancd419ab2010-09-11 00:39:25 +0000108/* MAGIC must change whenever the bytecode emitted by the compiler may no
109 longer be understood by older implementations of the eval loop (usually
110 due to the addition of new opcodes)
Victor Stinner2f42ae52011-03-20 00:41:24 +0100111 TAG and PYC_TAG_UNICODE must change for each major Python release. The magic
112 number will take care of any bytecode changes that occur during development.
Barry Warsaw28a691b2010-04-17 00:19:56 +0000113*/
Benjamin Peterson48deae12011-06-03 17:50:16 -0500114#define QUOTE(arg) #arg
115#define STRIFY(name) QUOTE(name)
116#define MAJOR STRIFY(PY_MAJOR_VERSION)
117#define MINOR STRIFY(PY_MINOR_VERSION)
Benjamin Petersone7c15fa2011-06-19 19:54:45 -0500118#define MAGIC (3190 | ((long)'\r'<<16) | ((long)'\n'<<24))
Benjamin Peterson48deae12011-06-03 17:50:16 -0500119#define TAG "cpython-" MAJOR MINOR;
Barry Warsaw28a691b2010-04-17 00:19:56 +0000120#define CACHEDIR "__pycache__"
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200121static const Py_UCS4 CACHEDIR_UNICODE[] = {
Victor Stinnerc9abda02011-03-14 13:33:46 -0400122 '_', '_', 'p', 'y', 'c', 'a', 'c', 'h', 'e', '_', '_', '\0'};
Barry Warsaw28a691b2010-04-17 00:19:56 +0000123/* Current magic word and string tag as globals. */
Guido van Rossum96774c12000-05-01 20:19:08 +0000124static long pyc_magic = MAGIC;
Barry Warsaw28a691b2010-04-17 00:19:56 +0000125static const char *pyc_tag = TAG;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200126static const Py_UCS4 PYC_TAG_UNICODE[] = {
Benjamin Peterson48deae12011-06-03 17:50:16 -0500127 'c', 'p', 'y', 't', 'h', 'o', 'n', '-', PY_MAJOR_VERSION + 48, PY_MINOR_VERSION + 48, '\0'};
128#undef QUOTE
129#undef STRIFY
130#undef MAJOR
131#undef MINOR
Guido van Rossum96774c12000-05-01 20:19:08 +0000132
Victor Stinner95872862011-03-07 18:20:56 +0100133/* See _PyImport_FixupExtensionObject() below */
Guido van Rossum25ce5661997-08-02 03:10:38 +0000134static PyObject *extensions = NULL;
Guido van Rossum3f5da241990-12-20 15:06:42 +0000135
Victor Stinnerfe7c5b52011-04-05 01:48:03 +0200136/* Function from Parser/tokenizer.c */
137extern char * PyTokenizer_FindEncodingFilename(int, PyObject *);
138
Guido van Rossum771c6c81997-10-31 18:37:24 +0000139/* This table is defined in config.c: */
140extern struct _inittab _PyImport_Inittab[];
141
142struct _inittab *PyImport_Inittab = _PyImport_Inittab;
Guido van Rossum66f1fa81991-04-03 19:03:52 +0000143
Guido van Rossumed1170e1999-12-20 21:23:41 +0000144/* these tables define the module suffixes that Python recognizes */
145struct filedescr * _PyImport_Filetab = NULL;
Guido van Rossum48a680c2001-03-02 06:34:14 +0000146
Guido van Rossumed1170e1999-12-20 21:23:41 +0000147static const struct filedescr _PyImport_StandardFiletab[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000148 {".py", "U", PY_SOURCE},
Martin v. Löwis6238d2b2002-06-30 15:26:10 +0000149#ifdef MS_WINDOWS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000150 {".pyw", "U", PY_SOURCE},
Tim Peters36515e22001-11-18 04:06:29 +0000151#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000152 {".pyc", "rb", PY_COMPILED},
153 {0, 0}
Guido van Rossumed1170e1999-12-20 21:23:41 +0000154};
155
Victor Stinnerd0296212011-03-14 14:04:10 -0400156static PyObject *initstr = NULL;
Martin v. Löwisbd928fe2011-10-14 10:20:37 +0200157_Py_IDENTIFIER(__path__);
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000158
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000159/* Initialize things */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000160
161void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000162_PyImport_Init(void)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000163{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000164 const struct filedescr *scan;
165 struct filedescr *filetab;
166 int countD = 0;
167 int countS = 0;
Guido van Rossumed1170e1999-12-20 21:23:41 +0000168
Victor Stinnerd0296212011-03-14 14:04:10 -0400169 initstr = PyUnicode_InternFromString("__init__");
170 if (initstr == NULL)
171 Py_FatalError("Can't initialize import variables");
172
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000173 /* prepare _PyImport_Filetab: copy entries from
174 _PyImport_DynLoadFiletab and _PyImport_StandardFiletab.
175 */
Guido van Rossum04110fb2007-08-24 16:32:05 +0000176#ifdef HAVE_DYNAMIC_LOADING
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000177 for (scan = _PyImport_DynLoadFiletab; scan->suffix != NULL; ++scan)
178 ++countD;
Guido van Rossum04110fb2007-08-24 16:32:05 +0000179#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000180 for (scan = _PyImport_StandardFiletab; scan->suffix != NULL; ++scan)
181 ++countS;
182 filetab = PyMem_NEW(struct filedescr, countD + countS + 1);
183 if (filetab == NULL)
184 Py_FatalError("Can't initialize import file table.");
Guido van Rossum04110fb2007-08-24 16:32:05 +0000185#ifdef HAVE_DYNAMIC_LOADING
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000186 memcpy(filetab, _PyImport_DynLoadFiletab,
187 countD * sizeof(struct filedescr));
Guido van Rossum04110fb2007-08-24 16:32:05 +0000188#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000189 memcpy(filetab + countD, _PyImport_StandardFiletab,
190 countS * sizeof(struct filedescr));
191 filetab[countD + countS].suffix = NULL;
Guido van Rossumed1170e1999-12-20 21:23:41 +0000192
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000193 _PyImport_Filetab = filetab;
Guido van Rossumed1170e1999-12-20 21:23:41 +0000194
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000195 if (Py_OptimizeFlag) {
196 /* Replace ".pyc" with ".pyo" in _PyImport_Filetab */
197 for (; filetab->suffix != NULL; filetab++) {
198 if (strcmp(filetab->suffix, ".pyc") == 0)
199 filetab->suffix = ".pyo";
200 }
201 }
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000202}
203
Guido van Rossum25ce5661997-08-02 03:10:38 +0000204void
Just van Rossum52e14d62002-12-30 22:08:05 +0000205_PyImportHooks_Init(void)
206{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000207 PyObject *v, *path_hooks = NULL, *zimpimport;
208 int err = 0;
Just van Rossum52e14d62002-12-30 22:08:05 +0000209
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000210 /* adding sys.path_hooks and sys.path_importer_cache, setting up
211 zipimport */
212 if (PyType_Ready(&PyNullImporter_Type) < 0)
213 goto error;
Just van Rossum52e14d62002-12-30 22:08:05 +0000214
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000215 if (Py_VerboseFlag)
216 PySys_WriteStderr("# installing zipimport hook\n");
Just van Rossum52e14d62002-12-30 22:08:05 +0000217
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000218 v = PyList_New(0);
219 if (v == NULL)
220 goto error;
221 err = PySys_SetObject("meta_path", v);
222 Py_DECREF(v);
223 if (err)
224 goto error;
225 v = PyDict_New();
226 if (v == NULL)
227 goto error;
228 err = PySys_SetObject("path_importer_cache", v);
229 Py_DECREF(v);
230 if (err)
231 goto error;
232 path_hooks = PyList_New(0);
233 if (path_hooks == NULL)
234 goto error;
235 err = PySys_SetObject("path_hooks", path_hooks);
236 if (err) {
Just van Rossum52e14d62002-12-30 22:08:05 +0000237 error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000238 PyErr_Print();
239 Py_FatalError("initializing sys.meta_path, sys.path_hooks, "
240 "path_importer_cache, or NullImporter failed"
241 );
242 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000243
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000244 zimpimport = PyImport_ImportModule("zipimport");
245 if (zimpimport == NULL) {
246 PyErr_Clear(); /* No zip import module -- okay */
247 if (Py_VerboseFlag)
248 PySys_WriteStderr("# can't import zipimport\n");
249 }
250 else {
Martin v. Löwisbd928fe2011-10-14 10:20:37 +0200251 _Py_IDENTIFIER(zipimporter);
Martin v. Löwis1ee1b6f2011-10-10 18:11:30 +0200252 PyObject *zipimporter = _PyObject_GetAttrId(zimpimport,
253 &PyId_zipimporter);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000254 Py_DECREF(zimpimport);
255 if (zipimporter == NULL) {
256 PyErr_Clear(); /* No zipimporter object -- okay */
257 if (Py_VerboseFlag)
258 PySys_WriteStderr(
259 "# can't import zipimport.zipimporter\n");
260 }
261 else {
262 /* sys.path_hooks.append(zipimporter) */
263 err = PyList_Append(path_hooks, zipimporter);
264 Py_DECREF(zipimporter);
265 if (err)
266 goto error;
267 if (Py_VerboseFlag)
268 PySys_WriteStderr(
269 "# installed zipimport hook\n");
270 }
271 }
272 Py_DECREF(path_hooks);
Just van Rossum52e14d62002-12-30 22:08:05 +0000273}
274
275void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000276_PyImport_Fini(void)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000277{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000278 Py_XDECREF(extensions);
279 extensions = NULL;
280 PyMem_DEL(_PyImport_Filetab);
281 _PyImport_Filetab = NULL;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000282}
283
284
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000285/* Locking primitives to prevent parallel imports of the same module
286 in different threads to return with a partially loaded module.
287 These calls are serialized by the global interpreter lock. */
288
289#ifdef WITH_THREAD
290
Guido van Rossum49b56061998-10-01 20:42:43 +0000291#include "pythread.h"
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000292
Guido van Rossum65d5b571998-12-21 19:32:43 +0000293static PyThread_type_lock import_lock = 0;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000294static long import_lock_thread = -1;
295static int import_lock_level = 0;
296
Benjamin Peterson0df35a92009-10-04 20:32:25 +0000297void
298_PyImport_AcquireLock(void)
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000299{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000300 long me = PyThread_get_thread_ident();
301 if (me == -1)
302 return; /* Too bad */
303 if (import_lock == NULL) {
304 import_lock = PyThread_allocate_lock();
305 if (import_lock == NULL)
306 return; /* Nothing much we can do. */
307 }
308 if (import_lock_thread == me) {
309 import_lock_level++;
310 return;
311 }
312 if (import_lock_thread != -1 || !PyThread_acquire_lock(import_lock, 0))
313 {
314 PyThreadState *tstate = PyEval_SaveThread();
315 PyThread_acquire_lock(import_lock, 1);
316 PyEval_RestoreThread(tstate);
317 }
318 import_lock_thread = me;
319 import_lock_level = 1;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000320}
321
Benjamin Peterson0df35a92009-10-04 20:32:25 +0000322int
323_PyImport_ReleaseLock(void)
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000324{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000325 long me = PyThread_get_thread_ident();
326 if (me == -1 || import_lock == NULL)
327 return 0; /* Too bad */
328 if (import_lock_thread != me)
329 return -1;
330 import_lock_level--;
331 if (import_lock_level == 0) {
332 import_lock_thread = -1;
333 PyThread_release_lock(import_lock);
334 }
335 return 1;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000336}
337
Gregory P. Smith24cec9f2010-03-01 06:18:41 +0000338/* This function is called from PyOS_AfterFork to ensure that newly
339 created child processes do not share locks with the parent.
340 We now acquire the import lock around fork() calls but on some platforms
341 (Solaris 9 and earlier? see isue7242) that still left us with problems. */
Guido van Rossum8ee3e5a2005-09-14 18:09:42 +0000342
343void
344_PyImport_ReInitLock(void)
345{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000346 if (import_lock != NULL)
347 import_lock = PyThread_allocate_lock();
Nick Coghlanb2ddf792010-12-02 04:11:46 +0000348 if (import_lock_level > 1) {
349 /* Forked as a side effect of import */
350 long me = PyThread_get_thread_ident();
351 PyThread_acquire_lock(import_lock, 0);
Victor Stinner942003c2011-03-07 16:57:48 +0100352 /* XXX: can the previous line fail? */
Nick Coghlanb2ddf792010-12-02 04:11:46 +0000353 import_lock_thread = me;
354 import_lock_level--;
355 } else {
356 import_lock_thread = -1;
357 import_lock_level = 0;
358 }
Guido van Rossum8ee3e5a2005-09-14 18:09:42 +0000359}
360
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000361#endif
362
Tim Peters69232342001-08-30 05:16:13 +0000363static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000364imp_lock_held(PyObject *self, PyObject *noargs)
Tim Peters69232342001-08-30 05:16:13 +0000365{
Tim Peters69232342001-08-30 05:16:13 +0000366#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000367 return PyBool_FromLong(import_lock_thread != -1);
Tim Peters69232342001-08-30 05:16:13 +0000368#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000369 return PyBool_FromLong(0);
Tim Peters69232342001-08-30 05:16:13 +0000370#endif
371}
372
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000373static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000374imp_acquire_lock(PyObject *self, PyObject *noargs)
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000375{
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000376#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000377 _PyImport_AcquireLock();
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000378#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000379 Py_INCREF(Py_None);
380 return Py_None;
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000381}
382
383static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000384imp_release_lock(PyObject *self, PyObject *noargs)
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000385{
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000386#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000387 if (_PyImport_ReleaseLock() < 0) {
388 PyErr_SetString(PyExc_RuntimeError,
389 "not holding the import lock");
390 return NULL;
391 }
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000392#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000393 Py_INCREF(Py_None);
394 return Py_None;
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000395}
396
Guido van Rossumd8faa362007-04-27 19:54:29 +0000397static void
398imp_modules_reloading_clear(void)
399{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000400 PyInterpreterState *interp = PyThreadState_Get()->interp;
401 if (interp->modules_reloading != NULL)
402 PyDict_Clear(interp->modules_reloading);
Guido van Rossumd8faa362007-04-27 19:54:29 +0000403}
404
Guido van Rossum25ce5661997-08-02 03:10:38 +0000405/* Helper for sys */
406
407PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000408PyImport_GetModuleDict(void)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000409{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000410 PyInterpreterState *interp = PyThreadState_GET()->interp;
411 if (interp->modules == NULL)
412 Py_FatalError("PyImport_GetModuleDict: no module dictionary!");
413 return interp->modules;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000414}
415
Guido van Rossum3f5da241990-12-20 15:06:42 +0000416
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000417/* List of names to clear in sys */
418static char* sys_deletes[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000419 "path", "argv", "ps1", "ps2",
420 "last_type", "last_value", "last_traceback",
421 "path_hooks", "path_importer_cache", "meta_path",
422 /* misc stuff */
423 "flags", "float_info",
424 NULL
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000425};
426
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000427static char* sys_files[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000428 "stdin", "__stdin__",
429 "stdout", "__stdout__",
430 "stderr", "__stderr__",
431 NULL
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000432};
433
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000434
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000435/* Un-initialize things, as good as we can */
Guido van Rossum3f5da241990-12-20 15:06:42 +0000436
Guido van Rossum3f5da241990-12-20 15:06:42 +0000437void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000438PyImport_Cleanup(void)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000439{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000440 Py_ssize_t pos, ndone;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000441 PyObject *key, *value, *dict;
442 PyInterpreterState *interp = PyThreadState_GET()->interp;
443 PyObject *modules = interp->modules;
Guido van Rossum758eec01998-01-19 21:58:26 +0000444
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000445 if (modules == NULL)
446 return; /* Already done */
Guido van Rossum758eec01998-01-19 21:58:26 +0000447
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000448 /* Delete some special variables first. These are common
449 places where user values hide and people complain when their
450 destructors fail. Since the modules containing them are
451 deleted *last* of all, they would come too late in the normal
452 destruction order. Sigh. */
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000453
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000454 value = PyDict_GetItemString(modules, "builtins");
455 if (value != NULL && PyModule_Check(value)) {
456 dict = PyModule_GetDict(value);
457 if (Py_VerboseFlag)
458 PySys_WriteStderr("# clear builtins._\n");
459 PyDict_SetItemString(dict, "_", Py_None);
460 }
461 value = PyDict_GetItemString(modules, "sys");
462 if (value != NULL && PyModule_Check(value)) {
463 char **p;
464 PyObject *v;
465 dict = PyModule_GetDict(value);
466 for (p = sys_deletes; *p != NULL; p++) {
467 if (Py_VerboseFlag)
468 PySys_WriteStderr("# clear sys.%s\n", *p);
469 PyDict_SetItemString(dict, *p, Py_None);
470 }
471 for (p = sys_files; *p != NULL; p+=2) {
472 if (Py_VerboseFlag)
473 PySys_WriteStderr("# restore sys.%s\n", *p);
474 v = PyDict_GetItemString(dict, *(p+1));
475 if (v == NULL)
476 v = Py_None;
477 PyDict_SetItemString(dict, *p, v);
478 }
479 }
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000480
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000481 /* First, delete __main__ */
482 value = PyDict_GetItemString(modules, "__main__");
483 if (value != NULL && PyModule_Check(value)) {
484 if (Py_VerboseFlag)
485 PySys_WriteStderr("# cleanup __main__\n");
486 _PyModule_Clear(value);
487 PyDict_SetItemString(modules, "__main__", Py_None);
488 }
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000489
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000490 /* The special treatment of "builtins" here is because even
491 when it's not referenced as a module, its dictionary is
492 referenced by almost every module's __builtins__. Since
493 deleting a module clears its dictionary (even if there are
494 references left to it), we need to delete the "builtins"
495 module last. Likewise, we don't delete sys until the very
496 end because it is implicitly referenced (e.g. by print).
Guido van Rossum758eec01998-01-19 21:58:26 +0000497
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000498 Also note that we 'delete' modules by replacing their entry
499 in the modules dict with None, rather than really deleting
500 them; this avoids a rehash of the modules dictionary and
501 also marks them as "non existent" so they won't be
502 re-imported. */
Guido van Rossum758eec01998-01-19 21:58:26 +0000503
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000504 /* Next, repeatedly delete modules with a reference count of
505 one (skipping builtins and sys) and delete them */
506 do {
507 ndone = 0;
508 pos = 0;
509 while (PyDict_Next(modules, &pos, &key, &value)) {
510 if (value->ob_refcnt != 1)
511 continue;
512 if (PyUnicode_Check(key) && PyModule_Check(value)) {
Victor Stinner9464d612011-03-07 17:08:21 +0100513 if (PyUnicode_CompareWithASCIIString(key, "builtins") == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000514 continue;
Victor Stinner9464d612011-03-07 17:08:21 +0100515 if (PyUnicode_CompareWithASCIIString(key, "sys") == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000516 continue;
517 if (Py_VerboseFlag)
Victor Stinner9464d612011-03-07 17:08:21 +0100518 PySys_FormatStderr(
519 "# cleanup[1] %U\n", key);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000520 _PyModule_Clear(value);
521 PyDict_SetItem(modules, key, Py_None);
522 ndone++;
523 }
524 }
525 } while (ndone > 0);
Guido van Rossum758eec01998-01-19 21:58:26 +0000526
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000527 /* Next, delete all modules (still skipping builtins and sys) */
528 pos = 0;
529 while (PyDict_Next(modules, &pos, &key, &value)) {
530 if (PyUnicode_Check(key) && PyModule_Check(value)) {
Victor Stinner9464d612011-03-07 17:08:21 +0100531 if (PyUnicode_CompareWithASCIIString(key, "builtins") == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000532 continue;
Victor Stinner9464d612011-03-07 17:08:21 +0100533 if (PyUnicode_CompareWithASCIIString(key, "sys") == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000534 continue;
535 if (Py_VerboseFlag)
Victor Stinner9464d612011-03-07 17:08:21 +0100536 PySys_FormatStderr("# cleanup[2] %U\n", key);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000537 _PyModule_Clear(value);
538 PyDict_SetItem(modules, key, Py_None);
539 }
540 }
Guido van Rossum758eec01998-01-19 21:58:26 +0000541
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000542 /* Next, delete sys and builtins (in that order) */
543 value = PyDict_GetItemString(modules, "sys");
544 if (value != NULL && PyModule_Check(value)) {
545 if (Py_VerboseFlag)
546 PySys_WriteStderr("# cleanup sys\n");
547 _PyModule_Clear(value);
548 PyDict_SetItemString(modules, "sys", Py_None);
549 }
550 value = PyDict_GetItemString(modules, "builtins");
551 if (value != NULL && PyModule_Check(value)) {
552 if (Py_VerboseFlag)
553 PySys_WriteStderr("# cleanup builtins\n");
554 _PyModule_Clear(value);
555 PyDict_SetItemString(modules, "builtins", Py_None);
556 }
Guido van Rossum758eec01998-01-19 21:58:26 +0000557
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000558 /* Finally, clear and delete the modules directory */
559 PyDict_Clear(modules);
560 interp->modules = NULL;
561 Py_DECREF(modules);
562 Py_CLEAR(interp->modules_reloading);
Guido van Rossum8d15b5d1990-10-26 14:58:58 +0000563}
Guido van Rossum7f133ed1991-02-19 12:23:57 +0000564
565
Barry Warsaw28a691b2010-04-17 00:19:56 +0000566/* Helper for pythonrun.c -- return magic number and tag. */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000567
568long
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000569PyImport_GetMagicNumber(void)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000570{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000571 return pyc_magic;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000572}
573
574
Barry Warsaw28a691b2010-04-17 00:19:56 +0000575const char *
576PyImport_GetMagicTag(void)
577{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000578 return pyc_tag;
Barry Warsaw28a691b2010-04-17 00:19:56 +0000579}
580
Guido van Rossum25ce5661997-08-02 03:10:38 +0000581/* Magic for extension modules (built-in as well as dynamically
582 loaded). To prevent initializing an extension module more than
583 once, we keep a static dictionary 'extensions' keyed by module name
584 (for built-in modules) or by filename (for dynamically loaded
Barry Warsaw92883382001-08-13 23:05:44 +0000585 modules), containing these modules. A copy of the module's
Victor Stinner95872862011-03-07 18:20:56 +0100586 dictionary is stored by calling _PyImport_FixupExtensionObject()
Guido van Rossum25ce5661997-08-02 03:10:38 +0000587 immediately after the module initialization function succeeds. A
588 copy can be retrieved from there by calling
Victor Stinner95872862011-03-07 18:20:56 +0100589 _PyImport_FindExtensionObject().
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000590
Barry Warsaw7c9627b2010-06-17 18:38:20 +0000591 Modules which do support multiple initialization set their m_size
592 field to a non-negative number (indicating the size of the
593 module-specific state). They are still recorded in the extensions
594 dictionary, to avoid loading shared libraries twice.
Martin v. Löwis1a214512008-06-11 05:26:20 +0000595*/
596
597int
Victor Stinner95872862011-03-07 18:20:56 +0100598_PyImport_FixupExtensionObject(PyObject *mod, PyObject *name,
599 PyObject *filename)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000600{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000601 PyObject *modules, *dict;
602 struct PyModuleDef *def;
603 if (extensions == NULL) {
604 extensions = PyDict_New();
605 if (extensions == NULL)
606 return -1;
607 }
608 if (mod == NULL || !PyModule_Check(mod)) {
609 PyErr_BadInternalCall();
610 return -1;
611 }
612 def = PyModule_GetDef(mod);
613 if (!def) {
614 PyErr_BadInternalCall();
615 return -1;
616 }
617 modules = PyImport_GetModuleDict();
Victor Stinner95872862011-03-07 18:20:56 +0100618 if (PyDict_SetItem(modules, name, mod) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000619 return -1;
620 if (_PyState_AddModule(mod, def) < 0) {
Victor Stinner95872862011-03-07 18:20:56 +0100621 PyDict_DelItem(modules, name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000622 return -1;
623 }
624 if (def->m_size == -1) {
625 if (def->m_base.m_copy) {
626 /* Somebody already imported the module,
627 likely under a different name.
628 XXX this should really not happen. */
629 Py_DECREF(def->m_base.m_copy);
630 def->m_base.m_copy = NULL;
631 }
632 dict = PyModule_GetDict(mod);
633 if (dict == NULL)
634 return -1;
635 def->m_base.m_copy = PyDict_Copy(dict);
636 if (def->m_base.m_copy == NULL)
637 return -1;
638 }
Victor Stinner49d3f252010-10-17 01:24:53 +0000639 PyDict_SetItem(extensions, filename, (PyObject*)def);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000640 return 0;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000641}
642
Victor Stinner49d3f252010-10-17 01:24:53 +0000643int
644_PyImport_FixupBuiltin(PyObject *mod, char *name)
645{
646 int res;
Victor Stinner95872862011-03-07 18:20:56 +0100647 PyObject *nameobj;
Victor Stinner21fcd0c2011-03-07 18:28:15 +0100648 nameobj = PyUnicode_InternFromString(name);
Victor Stinner95872862011-03-07 18:20:56 +0100649 if (nameobj == NULL)
Victor Stinner49d3f252010-10-17 01:24:53 +0000650 return -1;
Victor Stinner95872862011-03-07 18:20:56 +0100651 res = _PyImport_FixupExtensionObject(mod, nameobj, nameobj);
652 Py_DECREF(nameobj);
Victor Stinner49d3f252010-10-17 01:24:53 +0000653 return res;
654}
655
Guido van Rossum25ce5661997-08-02 03:10:38 +0000656PyObject *
Victor Stinner95872862011-03-07 18:20:56 +0100657_PyImport_FindExtensionObject(PyObject *name, PyObject *filename)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000658{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000659 PyObject *mod, *mdict;
660 PyModuleDef* def;
661 if (extensions == NULL)
662 return NULL;
Victor Stinner49d3f252010-10-17 01:24:53 +0000663 def = (PyModuleDef*)PyDict_GetItem(extensions, filename);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000664 if (def == NULL)
665 return NULL;
666 if (def->m_size == -1) {
667 /* Module does not support repeated initialization */
668 if (def->m_base.m_copy == NULL)
669 return NULL;
Victor Stinner95872862011-03-07 18:20:56 +0100670 mod = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000671 if (mod == NULL)
672 return NULL;
673 mdict = PyModule_GetDict(mod);
674 if (mdict == NULL)
675 return NULL;
676 if (PyDict_Update(mdict, def->m_base.m_copy))
677 return NULL;
678 }
679 else {
680 if (def->m_base.m_init == NULL)
681 return NULL;
682 mod = def->m_base.m_init();
683 if (mod == NULL)
684 return NULL;
Victor Stinner95872862011-03-07 18:20:56 +0100685 PyDict_SetItem(PyImport_GetModuleDict(), name, mod);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000686 Py_DECREF(mod);
687 }
688 if (_PyState_AddModule(mod, def) < 0) {
Victor Stinner95872862011-03-07 18:20:56 +0100689 PyDict_DelItem(PyImport_GetModuleDict(), name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000690 Py_DECREF(mod);
691 return NULL;
692 }
693 if (Py_VerboseFlag)
Victor Stinner95872862011-03-07 18:20:56 +0100694 PySys_FormatStderr("import %U # previously loaded (%R)\n",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000695 name, filename);
696 return mod;
Brett Cannon9a5b25a2010-03-01 02:09:17 +0000697
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000698}
699
Victor Stinner49d3f252010-10-17 01:24:53 +0000700PyObject *
Victor Stinner501c09a2011-02-23 00:02:00 +0000701_PyImport_FindBuiltin(const char *name)
Victor Stinner49d3f252010-10-17 01:24:53 +0000702{
Victor Stinner95872862011-03-07 18:20:56 +0100703 PyObject *res, *nameobj;
Victor Stinner21fcd0c2011-03-07 18:28:15 +0100704 nameobj = PyUnicode_InternFromString(name);
Victor Stinner95872862011-03-07 18:20:56 +0100705 if (nameobj == NULL)
Victor Stinner49d3f252010-10-17 01:24:53 +0000706 return NULL;
Victor Stinner95872862011-03-07 18:20:56 +0100707 res = _PyImport_FindExtensionObject(nameobj, nameobj);
708 Py_DECREF(nameobj);
Victor Stinner49d3f252010-10-17 01:24:53 +0000709 return res;
710}
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000711
712/* Get the module object corresponding to a module name.
713 First check the modules dictionary if there's one there,
Walter Dörwaldf0dfc7a2003-10-20 14:01:56 +0000714 if not, create a new one and insert it in the modules dictionary.
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000715 Because the former action is most common, THIS DOES NOT RETURN A
716 'NEW' REFERENCE! */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000717
Guido van Rossum79f25d91997-04-29 20:08:16 +0000718PyObject *
Victor Stinner27ee0892011-03-04 12:57:09 +0000719PyImport_AddModuleObject(PyObject *name)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000720{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000721 PyObject *modules = PyImport_GetModuleDict();
722 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000723
Victor Stinner27ee0892011-03-04 12:57:09 +0000724 if ((m = PyDict_GetItem(modules, name)) != NULL &&
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000725 PyModule_Check(m))
726 return m;
Victor Stinner27ee0892011-03-04 12:57:09 +0000727 m = PyModule_NewObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000728 if (m == NULL)
729 return NULL;
Victor Stinner27ee0892011-03-04 12:57:09 +0000730 if (PyDict_SetItem(modules, name, m) != 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000731 Py_DECREF(m);
732 return NULL;
733 }
734 Py_DECREF(m); /* Yes, it still exists, in modules! */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000735
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000736 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000737}
738
Victor Stinner27ee0892011-03-04 12:57:09 +0000739PyObject *
740PyImport_AddModule(const char *name)
741{
742 PyObject *nameobj, *module;
743 nameobj = PyUnicode_FromString(name);
744 if (nameobj == NULL)
745 return NULL;
746 module = PyImport_AddModuleObject(nameobj);
747 Py_DECREF(nameobj);
748 return module;
749}
750
751
Tim Peters1cd70172004-08-02 03:52:12 +0000752/* Remove name from sys.modules, if it's there. */
753static void
Victor Stinner27ee0892011-03-04 12:57:09 +0000754remove_module(PyObject *name)
Tim Peters1cd70172004-08-02 03:52:12 +0000755{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000756 PyObject *modules = PyImport_GetModuleDict();
Victor Stinner27ee0892011-03-04 12:57:09 +0000757 if (PyDict_GetItem(modules, name) == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000758 return;
Victor Stinner27ee0892011-03-04 12:57:09 +0000759 if (PyDict_DelItem(modules, name) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000760 Py_FatalError("import: deleting existing key in"
761 "sys.modules failed");
Tim Peters1cd70172004-08-02 03:52:12 +0000762}
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000763
Victor Stinnerc9abda02011-03-14 13:33:46 -0400764static PyObject * get_sourcefile(PyObject *filename);
765static PyObject *make_source_pathname(PyObject *pathname);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200766static PyObject* make_compiled_pathname(PyObject *pathname, int debug);
Christian Heimes3b06e532008-01-07 20:12:44 +0000767
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000768/* Execute a code object in a module and return the module object
Tim Peters1cd70172004-08-02 03:52:12 +0000769 * WITH INCREMENTED REFERENCE COUNT. If an error occurs, name is
770 * removed from sys.modules, to avoid leaving damaged module objects
771 * in sys.modules. The caller may wish to restore the original
772 * module object (if any) in this case; PyImport_ReloadModule is an
773 * example.
Barry Warsaw28a691b2010-04-17 00:19:56 +0000774 *
775 * Note that PyImport_ExecCodeModuleWithPathnames() is the preferred, richer
776 * interface. The other two exist primarily for backward compatibility.
Tim Peters1cd70172004-08-02 03:52:12 +0000777 */
Guido van Rossum79f25d91997-04-29 20:08:16 +0000778PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000779PyImport_ExecCodeModule(char *name, PyObject *co)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000780{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000781 return PyImport_ExecCodeModuleWithPathnames(
782 name, co, (char *)NULL, (char *)NULL);
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000783}
784
785PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000786PyImport_ExecCodeModuleEx(char *name, PyObject *co, char *pathname)
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000787{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000788 return PyImport_ExecCodeModuleWithPathnames(
789 name, co, pathname, (char *)NULL);
Barry Warsaw28a691b2010-04-17 00:19:56 +0000790}
791
792PyObject *
793PyImport_ExecCodeModuleWithPathnames(char *name, PyObject *co, char *pathname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000794 char *cpathname)
Barry Warsaw28a691b2010-04-17 00:19:56 +0000795{
Victor Stinner27ee0892011-03-04 12:57:09 +0000796 PyObject *m = NULL;
797 PyObject *nameobj, *pathobj = NULL, *cpathobj = NULL;
798
799 nameobj = PyUnicode_FromString(name);
800 if (nameobj == NULL)
801 return NULL;
802
803 if (pathname != NULL) {
804 pathobj = PyUnicode_DecodeFSDefault(pathname);
805 if (pathobj == NULL)
806 goto error;
807 } else
808 pathobj = NULL;
809 if (cpathname != NULL) {
810 cpathobj = PyUnicode_DecodeFSDefault(cpathname);
811 if (cpathobj == NULL)
812 goto error;
813 } else
814 cpathobj = NULL;
815 m = PyImport_ExecCodeModuleObject(nameobj, co, pathobj, cpathobj);
816error:
817 Py_DECREF(nameobj);
818 Py_XDECREF(pathobj);
819 Py_XDECREF(cpathobj);
820 return m;
821}
822
823PyObject*
824PyImport_ExecCodeModuleObject(PyObject *name, PyObject *co, PyObject *pathname,
825 PyObject *cpathname)
826{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000827 PyObject *modules = PyImport_GetModuleDict();
828 PyObject *m, *d, *v;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000829
Victor Stinner27ee0892011-03-04 12:57:09 +0000830 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000831 if (m == NULL)
832 return NULL;
833 /* If the module is being reloaded, we get the old module back
834 and re-use its dict to exec the new code. */
835 d = PyModule_GetDict(m);
836 if (PyDict_GetItemString(d, "__builtins__") == NULL) {
837 if (PyDict_SetItemString(d, "__builtins__",
838 PyEval_GetBuiltins()) != 0)
839 goto error;
840 }
841 /* Remember the filename as the __file__ attribute */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000842 if (pathname != NULL) {
Victor Stinnerc9abda02011-03-14 13:33:46 -0400843 v = get_sourcefile(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000844 if (v == NULL)
845 PyErr_Clear();
846 }
Victor Stinner27ee0892011-03-04 12:57:09 +0000847 else
848 v = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000849 if (v == NULL) {
850 v = ((PyCodeObject *)co)->co_filename;
851 Py_INCREF(v);
852 }
853 if (PyDict_SetItemString(d, "__file__", v) != 0)
854 PyErr_Clear(); /* Not important enough to report */
855 Py_DECREF(v);
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000856
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000857 /* Remember the pyc path name as the __cached__ attribute. */
Victor Stinner27ee0892011-03-04 12:57:09 +0000858 if (cpathname != NULL)
859 v = cpathname;
860 else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000861 v = Py_None;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000862 if (PyDict_SetItemString(d, "__cached__", v) != 0)
863 PyErr_Clear(); /* Not important enough to report */
Barry Warsaw28a691b2010-04-17 00:19:56 +0000864
Martin v. Löwis4d0d4712010-12-03 20:14:31 +0000865 v = PyEval_EvalCode(co, d, d);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000866 if (v == NULL)
867 goto error;
868 Py_DECREF(v);
Guido van Rossumb65e85c1997-07-10 18:00:45 +0000869
Victor Stinner27ee0892011-03-04 12:57:09 +0000870 if ((m = PyDict_GetItem(modules, name)) == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000871 PyErr_Format(PyExc_ImportError,
Victor Stinner27ee0892011-03-04 12:57:09 +0000872 "Loaded module %R not found in sys.modules",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000873 name);
874 return NULL;
875 }
Guido van Rossumb65e85c1997-07-10 18:00:45 +0000876
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000877 Py_INCREF(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000878
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000879 return m;
Tim Peters1cd70172004-08-02 03:52:12 +0000880
881 error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000882 remove_module(name);
883 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000884}
885
886
Barry Warsaw28a691b2010-04-17 00:19:56 +0000887/* Like strrchr(string, '/') but searches for the rightmost of either SEP
888 or ALTSEP, if the latter is defined.
889*/
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200890static Py_UCS4*
891rightmost_sep(Py_UCS4 *s)
Victor Stinnerc9abda02011-03-14 13:33:46 -0400892{
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200893 Py_UCS4 *found, c;
Victor Stinnerc9abda02011-03-14 13:33:46 -0400894 for (found = NULL; (c = *s); s++) {
895 if (c == SEP
896#ifdef ALTSEP
897 || c == ALTSEP
898#endif
899 )
900 {
901 found = s;
902 }
903 }
904 return found;
905}
906
907
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000908/* Given a pathname for a Python source file, fill a buffer with the
909 pathname for the corresponding compiled file. Return the pathname
910 for the compiled file, or NULL if there's no space in the buffer.
Victor Stinner2f42ae52011-03-20 00:41:24 +0100911 Doesn't set an exception.
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000912
Victor Stinner2f42ae52011-03-20 00:41:24 +0100913 foo.py -> __pycache__/foo.<tag>.pyc */
914
915static PyObject*
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200916make_compiled_pathname(PyObject *pathstr, int debug)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000917{
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200918 Py_UCS4 *pathname;
919 Py_UCS4 buf[MAXPATHLEN];
Victor Stinner2f42ae52011-03-20 00:41:24 +0100920 size_t buflen = (size_t)MAXPATHLEN;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200921 size_t len;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000922 size_t i, save;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200923 Py_UCS4 *pos;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000924 int sep = SEP;
Barry Warsaw28a691b2010-04-17 00:19:56 +0000925
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200926 pathname = PyUnicode_AsUCS4Copy(pathstr);
927 if (!pathname)
928 return NULL;
929 len = Py_UCS4_strlen(pathname);
930
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000931 /* Sanity check that the buffer has roughly enough space to hold what
932 will eventually be the full path to the compiled file. The 5 extra
933 bytes include the slash afer __pycache__, the two extra dots, the
934 extra trailing character ('c' or 'o') and null. This isn't exact
935 because the contents of the buffer can affect how many actual
936 characters of the string get into the buffer. We'll do a final
937 sanity check before writing the extension to ensure we do not
938 overflow the buffer.
939 */
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200940 if (len + Py_UCS4_strlen(CACHEDIR_UNICODE) + Py_UCS4_strlen(PYC_TAG_UNICODE) + 5 > buflen) {
941 PyMem_Free(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000942 return NULL;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200943 }
Tim Petersc1731372001-08-04 08:12:36 +0000944
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000945 /* Find the last path separator and copy everything from the start of
946 the source string up to and including the separator.
947 */
Victor Stinner2f42ae52011-03-20 00:41:24 +0100948 pos = rightmost_sep(pathname);
949 if (pos == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000950 i = 0;
951 }
952 else {
953 sep = *pos;
954 i = pos - pathname + 1;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200955 Py_UCS4_strncpy(buf, pathname, i);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000956 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000957
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000958 save = i;
959 buf[i++] = '\0';
960 /* Add __pycache__/ */
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200961 Py_UCS4_strcat(buf, CACHEDIR_UNICODE);
962 i += Py_UCS4_strlen(CACHEDIR_UNICODE) - 1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000963 buf[i++] = sep;
Victor Stinnerccbf4752011-03-14 15:05:12 -0400964 buf[i] = '\0';
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000965 /* Add the base filename, but remove the .py or .pyw extension, since
966 the tag name must go before the extension.
967 */
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200968 Py_UCS4_strcat(buf, pathname + save);
969 pos = Py_UCS4_strrchr(buf + i, '.');
Victor Stinner2f42ae52011-03-20 00:41:24 +0100970 if (pos != NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000971 *++pos = '\0';
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200972
973 /* pathname is not used from here on. */
974 PyMem_Free(pathname);
975
976 Py_UCS4_strcat(buf, PYC_TAG_UNICODE);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000977 /* The length test above assumes that we're only adding one character
978 to the end of what would normally be the extension. What if there
979 is no extension, or the string ends in '.' or '.p', and otherwise
980 fills the buffer? By appending 4 more characters onto the string
981 here, we could overrun the buffer.
Barry Warsaw28a691b2010-04-17 00:19:56 +0000982
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000983 As a simple example, let's say buflen=32 and the input string is
984 'xxx.py'. strlen() would be 6 and the test above would yield:
Barry Warsaw28a691b2010-04-17 00:19:56 +0000985
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000986 (6 + 11 + 10 + 5 == 32) > 32
Barry Warsaw28a691b2010-04-17 00:19:56 +0000987
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000988 which is false and so the name mangling would continue. This would
989 be fine because we'd end up with this string in buf:
Barry Warsaw28a691b2010-04-17 00:19:56 +0000990
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000991 __pycache__/xxx.cpython-32.pyc\0
Barry Warsaw28a691b2010-04-17 00:19:56 +0000992
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000993 strlen(of that) == 30 + the nul fits inside a 32 character buffer.
994 We can even handle an input string of say 'xxxxx' above because
995 that's (5 + 11 + 10 + 5 == 31) > 32 which is also false. Name
996 mangling that yields:
Barry Warsaw28a691b2010-04-17 00:19:56 +0000997
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000998 __pycache__/xxxxxcpython-32.pyc\0
Barry Warsaw28a691b2010-04-17 00:19:56 +0000999
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001000 which is 32 characters including the nul, and thus fits in the
1001 buffer. However, an input string of 'xxxxxx' would yield a result
1002 string of:
Barry Warsaw28a691b2010-04-17 00:19:56 +00001003
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001004 __pycache__/xxxxxxcpython-32.pyc\0
Barry Warsaw28a691b2010-04-17 00:19:56 +00001005
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001006 which is 33 characters long (including the nul), thus overflowing
1007 the buffer, even though the first test would fail, i.e.: the input
1008 string is also 6 characters long, so 32 > 32 is false.
Barry Warsaw28a691b2010-04-17 00:19:56 +00001009
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001010 The reason the first test fails but we still overflow the buffer is
1011 that the test above only expects to add one extra character to be
1012 added to the extension, and here we're adding three (pyc). We
1013 don't add the first dot, so that reclaims one of expected
1014 positions, leaving us overflowing by 1 byte (3 extra - 1 reclaimed
1015 dot - 1 expected extra == 1 overflowed).
Barry Warsaw28a691b2010-04-17 00:19:56 +00001016
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001017 The best we can do is ensure that we still have enough room in the
1018 target buffer before we write the extension. Because it's always
1019 only the extension that can cause the overflow, and never the other
1020 path bytes we've written, it's sufficient to just do one more test
1021 here. Still, the assertion that follows can't hurt.
1022 */
Barry Warsaw28a691b2010-04-17 00:19:56 +00001023#if 0
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001024 printf("strlen(buf): %d; buflen: %d\n", (int)strlen(buf), (int)buflen);
Barry Warsaw28a691b2010-04-17 00:19:56 +00001025#endif
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001026 len = Py_UCS4_strlen(buf);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001027 if (len + 5 > buflen)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001028 return NULL;
Victor Stinner2f42ae52011-03-20 00:41:24 +01001029 buf[len] = '.'; len++;
1030 buf[len] = 'p'; len++;
1031 buf[len] = 'y'; len++;
1032 buf[len] = debug ? 'c' : 'o'; len++;
1033 assert(len <= buflen);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001034 return PyUnicode_FromKindAndData(PyUnicode_4BYTE_KIND, buf, len);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001035}
1036
1037
Barry Warsaw28a691b2010-04-17 00:19:56 +00001038/* Given a pathname to a Python byte compiled file, return the path to the
1039 source file, if the path matches the PEP 3147 format. This does not check
1040 for any file existence, however, if the pyc file name does not match PEP
1041 3147 style, NULL is returned. buf must be at least as big as pathname;
Victor Stinnerc9abda02011-03-14 13:33:46 -04001042 the resulting path will always be shorter.
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001043
Victor Stinnerc9abda02011-03-14 13:33:46 -04001044 (...)/__pycache__/foo.<tag>.pyc -> (...)/foo.py */
1045
1046static PyObject*
1047make_source_pathname(PyObject *pathobj)
Barry Warsaw28a691b2010-04-17 00:19:56 +00001048{
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001049 Py_UCS4 buf[MAXPATHLEN];
1050 Py_UCS4 *pathname;
1051 Py_UCS4 *left, *right, *dot0, *dot1, sep;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001052 size_t i, j;
Victor Stinnerc9abda02011-03-14 13:33:46 -04001053
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001054 if (PyUnicode_GET_LENGTH(pathobj) > MAXPATHLEN)
Victor Stinnerc9abda02011-03-14 13:33:46 -04001055 return NULL;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001056 pathname = PyUnicode_AsUCS4Copy(pathobj);
1057 if (!pathname)
1058 return NULL;
Barry Warsaw28a691b2010-04-17 00:19:56 +00001059
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001060 /* Look back two slashes from the end. In between these two slashes
1061 must be the string __pycache__ or this is not a PEP 3147 style
1062 path. It's possible for there to be only one slash.
1063 */
Victor Stinner2f42ae52011-03-20 00:41:24 +01001064 right = rightmost_sep(pathname);
Victor Stinnerc9abda02011-03-14 13:33:46 -04001065 if (right == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001066 return NULL;
1067 sep = *right;
1068 *right = '\0';
Victor Stinner2f42ae52011-03-20 00:41:24 +01001069 left = rightmost_sep(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001070 *right = sep;
1071 if (left == NULL)
1072 left = pathname;
1073 else
1074 left++;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001075 if (right-left != Py_UCS4_strlen(CACHEDIR_UNICODE) ||
1076 Py_UCS4_strncmp(left, CACHEDIR_UNICODE, right-left) != 0)
1077 goto error;
Barry Warsaw28a691b2010-04-17 00:19:56 +00001078
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001079 /* Now verify that the path component to the right of the last slash
1080 has two dots in it.
1081 */
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001082 if ((dot0 = Py_UCS4_strchr(right + 1, '.')) == NULL)
1083 goto error;
1084 if ((dot1 = Py_UCS4_strchr(dot0 + 1, '.')) == NULL)
1085 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001086 /* Too many dots? */
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001087 if (Py_UCS4_strchr(dot1 + 1, '.') != NULL)
1088 goto error;
Barry Warsaw28a691b2010-04-17 00:19:56 +00001089
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001090 /* This is a PEP 3147 path. Start by copying everything from the
1091 start of pathname up to and including the leftmost slash. Then
1092 copy the file's basename, removing the magic tag and adding a .py
1093 suffix.
1094 */
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001095 Py_UCS4_strncpy(buf, pathname, (i=left-pathname));
1096 Py_UCS4_strncpy(buf+i, right+1, (j=dot0-right));
Victor Stinnerc9abda02011-03-14 13:33:46 -04001097 buf[i+j] = 'p';
1098 buf[i+j+1] = 'y';
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001099 PyMem_Free(pathname);
1100 return PyUnicode_FromKindAndData(PyUnicode_4BYTE_KIND, buf, i+j+2);
1101 error:
1102 PyMem_Free(pathname);
1103 return NULL;
Barry Warsaw28a691b2010-04-17 00:19:56 +00001104}
1105
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001106/* Given a pathname for a Python source file, its time of last
1107 modification, and a pathname for a compiled file, check whether the
1108 compiled file represents the same version of the source. If so,
1109 return a FILE pointer for the compiled file, positioned just after
1110 the header; if not, return NULL.
1111 Doesn't set an exception. */
1112
1113static FILE *
Victor Stinner2f42ae52011-03-20 00:41:24 +01001114check_compiled_module(PyObject *pathname, time_t mtime, PyObject *cpathname)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001115{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001116 FILE *fp;
1117 long magic;
1118 long pyc_mtime;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001119
Victor Stinner2f42ae52011-03-20 00:41:24 +01001120 fp = _Py_fopen(cpathname, "rb");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001121 if (fp == NULL)
1122 return NULL;
1123 magic = PyMarshal_ReadLongFromFile(fp);
1124 if (magic != pyc_magic) {
1125 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001126 PySys_FormatStderr("# %R has bad magic\n", cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001127 fclose(fp);
1128 return NULL;
1129 }
1130 pyc_mtime = PyMarshal_ReadLongFromFile(fp);
1131 if (pyc_mtime != mtime) {
1132 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001133 PySys_FormatStderr("# %R has bad mtime\n", cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001134 fclose(fp);
1135 return NULL;
1136 }
1137 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001138 PySys_FormatStderr("# %R matches %R\n", cpathname, pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001139 return fp;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001140}
1141
1142
1143/* Read a code object from a file and check it for validity */
1144
Guido van Rossum79f25d91997-04-29 20:08:16 +00001145static PyCodeObject *
Victor Stinner2f42ae52011-03-20 00:41:24 +01001146read_compiled_module(PyObject *cpathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001147{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001148 PyObject *co;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001149
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001150 co = PyMarshal_ReadLastObjectFromFile(fp);
1151 if (co == NULL)
1152 return NULL;
1153 if (!PyCode_Check(co)) {
1154 PyErr_Format(PyExc_ImportError,
Victor Stinner2f42ae52011-03-20 00:41:24 +01001155 "Non-code object in %R", cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001156 Py_DECREF(co);
1157 return NULL;
1158 }
1159 return (PyCodeObject *)co;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001160}
1161
1162
1163/* Load a module from a compiled file, execute it, and return its
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001164 module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001165
Guido van Rossum79f25d91997-04-29 20:08:16 +00001166static PyObject *
Victor Stinner2f42ae52011-03-20 00:41:24 +01001167load_compiled_module(PyObject *name, PyObject *cpathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001168{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001169 long magic;
1170 PyCodeObject *co;
1171 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001172
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001173 magic = PyMarshal_ReadLongFromFile(fp);
1174 if (magic != pyc_magic) {
1175 PyErr_Format(PyExc_ImportError,
Victor Stinner2f42ae52011-03-20 00:41:24 +01001176 "Bad magic number in %R", cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001177 return NULL;
1178 }
1179 (void) PyMarshal_ReadLongFromFile(fp);
1180 co = read_compiled_module(cpathname, fp);
1181 if (co == NULL)
1182 return NULL;
1183 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001184 PySys_FormatStderr("import %U # precompiled from %R\n",
1185 name, cpathname);
1186 m = PyImport_ExecCodeModuleObject(name, (PyObject *)co,
1187 cpathname, cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001188 Py_DECREF(co);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001189
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001190 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001191}
1192
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001193/* Parse a source file and return the corresponding code object */
1194
Guido van Rossum79f25d91997-04-29 20:08:16 +00001195static PyCodeObject *
Victor Stinner2f42ae52011-03-20 00:41:24 +01001196parse_source_module(PyObject *pathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001197{
Victor Stinner2f42ae52011-03-20 00:41:24 +01001198 PyCodeObject *co;
1199 PyObject *pathbytes;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001200 mod_ty mod;
1201 PyCompilerFlags flags;
Victor Stinner2f42ae52011-03-20 00:41:24 +01001202 PyArena *arena;
1203
1204 pathbytes = PyUnicode_EncodeFSDefault(pathname);
1205 if (pathbytes == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001206 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001207
Victor Stinner2f42ae52011-03-20 00:41:24 +01001208 arena = PyArena_New();
1209 if (arena == NULL) {
1210 Py_DECREF(pathbytes);
1211 return NULL;
1212 }
1213
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001214 flags.cf_flags = 0;
Victor Stinner2f42ae52011-03-20 00:41:24 +01001215 mod = PyParser_ASTFromFile(fp, PyBytes_AS_STRING(pathbytes), NULL,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001216 Py_file_input, 0, 0, &flags,
1217 NULL, arena);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001218 if (mod != NULL)
1219 co = PyAST_Compile(mod, PyBytes_AS_STRING(pathbytes), NULL, arena);
1220 else
1221 co = NULL;
1222 Py_DECREF(pathbytes);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001223 PyArena_Free(arena);
1224 return co;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001225}
1226
Guido van Rossum55a83382000-09-20 20:31:38 +00001227/* Helper to open a bytecode file for writing in exclusive mode */
1228
Victor Stinner783c82c2011-04-20 03:27:51 +02001229#ifndef MS_WINDOWS
Guido van Rossum55a83382000-09-20 20:31:38 +00001230static FILE *
Christian Heimes05e8be12008-02-23 18:30:17 +00001231open_exclusive(char *filename, mode_t mode)
Guido van Rossum55a83382000-09-20 20:31:38 +00001232{
1233#if defined(O_EXCL)&&defined(O_CREAT)&&defined(O_WRONLY)&&defined(O_TRUNC)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001234 /* Use O_EXCL to avoid a race condition when another process tries to
1235 write the same file. When that happens, our open() call fails,
1236 which is just fine (since it's only a cache).
1237 XXX If the file exists and is writable but the directory is not
1238 writable, the file will never be written. Oh well.
1239 */
1240 int fd;
1241 (void) unlink(filename);
1242 fd = open(filename, O_EXCL|O_CREAT|O_WRONLY|O_TRUNC
Tim Peters42c83af2000-09-29 04:03:10 +00001243#ifdef O_BINARY
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001244 |O_BINARY /* necessary for Windows */
Tim Peters42c83af2000-09-29 04:03:10 +00001245#endif
Martin v. Löwis79acb9e2002-12-06 12:48:53 +00001246#ifdef __VMS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001247 , mode, "ctxt=bin", "shr=nil"
Martin v. Löwis79acb9e2002-12-06 12:48:53 +00001248#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001249 , mode
Martin v. Löwis79acb9e2002-12-06 12:48:53 +00001250#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001251 );
1252 if (fd < 0)
1253 return NULL;
1254 return fdopen(fd, "wb");
Guido van Rossum55a83382000-09-20 20:31:38 +00001255#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001256 /* Best we can do -- on Windows this can't happen anyway */
1257 return fopen(filename, "wb");
Guido van Rossum55a83382000-09-20 20:31:38 +00001258#endif
1259}
Victor Stinner783c82c2011-04-20 03:27:51 +02001260#endif
Guido van Rossum55a83382000-09-20 20:31:38 +00001261
1262
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001263/* Write a compiled module to a file, placing the time of last
1264 modification of its source into the header.
1265 Errors are ignored, if a write error occurs an attempt is made to
1266 remove the file. */
1267
1268static void
Victor Stinner2f42ae52011-03-20 00:41:24 +01001269write_compiled_module(PyCodeObject *co, PyObject *cpathname,
1270 struct stat *srcstat)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001271{
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001272 Py_UCS4 *cpathname_ucs4;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001273 FILE *fp;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001274 time_t mtime = srcstat->st_mtime;
Alexandre Vassalotti9d58e3e2009-07-17 10:55:50 +00001275#ifdef MS_WINDOWS /* since Windows uses different permissions */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001276 mode_t mode = srcstat->st_mode & ~S_IEXEC;
Alexandre Vassalotti9d58e3e2009-07-17 10:55:50 +00001277#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001278 mode_t mode = srcstat->st_mode & ~S_IXUSR & ~S_IXGRP & ~S_IXOTH;
1279 mode_t dirmode = (srcstat->st_mode |
1280 S_IXUSR | S_IXGRP | S_IXOTH |
1281 S_IWUSR | S_IWGRP | S_IWOTH);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001282 PyObject *dirbytes;
Brett Cannon9a5b25a2010-03-01 02:09:17 +00001283#endif
Victor Stinner783c82c2011-04-20 03:27:51 +02001284#ifdef MS_WINDOWS
1285 int fd;
1286#else
Antoine Pitrou707033a2011-10-17 19:28:44 +02001287 PyObject *cpathbytes, *cpathbytes_tmp;
1288 Py_ssize_t cpathbytes_len;
Victor Stinner783c82c2011-04-20 03:27:51 +02001289#endif
1290 PyObject *dirname;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001291 Py_UCS4 *dirsep;
Victor Stinner2f42ae52011-03-20 00:41:24 +01001292 int res, ok;
Barry Warsaw28a691b2010-04-17 00:19:56 +00001293
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001294 /* Ensure that the __pycache__ directory exists. */
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001295 cpathname_ucs4 = PyUnicode_AsUCS4Copy(cpathname);
1296 if (!cpathname_ucs4)
1297 return;
1298 dirsep = rightmost_sep(cpathname_ucs4);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001299 if (dirsep == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001300 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001301 PySys_FormatStderr("# no %s path found %R\n", CACHEDIR, cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001302 return;
1303 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001304 dirname = PyUnicode_FromKindAndData(PyUnicode_4BYTE_KIND,
1305 cpathname_ucs4,
1306 dirsep - cpathname_ucs4);
1307 PyMem_Free(cpathname_ucs4);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001308 if (dirname == NULL) {
1309 PyErr_Clear();
1310 return;
1311 }
Daniel Stutzbachc7937792010-09-09 21:18:04 +00001312
1313#ifdef MS_WINDOWS
Victor Stinner2f42ae52011-03-20 00:41:24 +01001314 res = CreateDirectoryW(PyUnicode_AS_UNICODE(dirname), NULL);
1315 ok = (res != 0);
1316 if (!ok && GetLastError() == ERROR_ALREADY_EXISTS)
1317 ok = 1;
Daniel Stutzbachc7937792010-09-09 21:18:04 +00001318#else
Victor Stinner2f42ae52011-03-20 00:41:24 +01001319 dirbytes = PyUnicode_EncodeFSDefault(dirname);
1320 if (dirbytes == NULL) {
1321 PyErr_Clear();
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001322 return;
1323 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01001324 res = mkdir(PyBytes_AS_STRING(dirbytes), dirmode);
1325 Py_DECREF(dirbytes);
1326 if (0 <= res)
1327 ok = 1;
1328 else
1329 ok = (errno == EEXIST);
1330#endif
1331 if (!ok) {
1332 if (Py_VerboseFlag)
1333 PySys_FormatStderr("# cannot create cache dir %R\n", dirname);
1334 Py_DECREF(dirname);
1335 return;
1336 }
1337 Py_DECREF(dirname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001338
Victor Stinner783c82c2011-04-20 03:27:51 +02001339#ifdef MS_WINDOWS
1340 (void)DeleteFileW(PyUnicode_AS_UNICODE(cpathname));
1341 fd = _wopen(PyUnicode_AS_UNICODE(cpathname),
1342 O_EXCL | O_CREAT | O_WRONLY | O_TRUNC | O_BINARY,
1343 mode);
1344 if (0 <= fd)
1345 fp = fdopen(fd, "wb");
1346 else
1347 fp = NULL;
1348#else
Antoine Pitrou707033a2011-10-17 19:28:44 +02001349 /* Under POSIX, we first write to a tmp file and then take advantage
1350 of atomic renaming. */
Victor Stinner2f42ae52011-03-20 00:41:24 +01001351 cpathbytes = PyUnicode_EncodeFSDefault(cpathname);
1352 if (cpathbytes == NULL) {
1353 PyErr_Clear();
1354 return;
1355 }
Antoine Pitrou707033a2011-10-17 19:28:44 +02001356 cpathbytes_len = PyBytes_GET_SIZE(cpathbytes);
1357 cpathbytes_tmp = PyBytes_FromStringAndSize(NULL, cpathbytes_len + 4);
1358 if (cpathbytes_tmp == NULL) {
1359 Py_DECREF(cpathbytes);
1360 PyErr_Clear();
1361 return;
1362 }
1363 memcpy(PyBytes_AS_STRING(cpathbytes_tmp), PyBytes_AS_STRING(cpathbytes),
1364 cpathbytes_len);
1365 memcpy(PyBytes_AS_STRING(cpathbytes_tmp) + cpathbytes_len, ".tmp", 4);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001366
Antoine Pitrou707033a2011-10-17 19:28:44 +02001367 fp = open_exclusive(PyBytes_AS_STRING(cpathbytes_tmp), mode);
Victor Stinner783c82c2011-04-20 03:27:51 +02001368#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001369 if (fp == NULL) {
1370 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001371 PySys_FormatStderr(
1372 "# can't create %R\n", cpathname);
Victor Stinner783c82c2011-04-20 03:27:51 +02001373#ifndef MS_WINDOWS
Victor Stinner2f42ae52011-03-20 00:41:24 +01001374 Py_DECREF(cpathbytes);
Antoine Pitrou707033a2011-10-17 19:28:44 +02001375 Py_DECREF(cpathbytes_tmp);
Victor Stinner783c82c2011-04-20 03:27:51 +02001376#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001377 return;
1378 }
1379 PyMarshal_WriteLongToFile(pyc_magic, fp, Py_MARSHAL_VERSION);
1380 /* First write a 0 for mtime */
1381 PyMarshal_WriteLongToFile(0L, fp, Py_MARSHAL_VERSION);
1382 PyMarshal_WriteObjectToFile((PyObject *)co, fp, Py_MARSHAL_VERSION);
Antoine Pitrou707033a2011-10-17 19:28:44 +02001383 fflush(fp);
1384 /* Now write the true mtime */
1385 fseek(fp, 4L, 0);
1386 assert(mtime < LONG_MAX);
1387 PyMarshal_WriteLongToFile((long)mtime, fp, Py_MARSHAL_VERSION);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001388 if (fflush(fp) != 0 || ferror(fp)) {
1389 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001390 PySys_FormatStderr("# can't write %R\n", cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001391 /* Don't keep partial file */
1392 fclose(fp);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001393#ifdef MS_WINDOWS
1394 (void)DeleteFileW(PyUnicode_AS_UNICODE(cpathname));
1395#else
Antoine Pitrou707033a2011-10-17 19:28:44 +02001396 (void) unlink(PyBytes_AS_STRING(cpathbytes_tmp));
Victor Stinner2f42ae52011-03-20 00:41:24 +01001397 Py_DECREF(cpathbytes);
Antoine Pitrou707033a2011-10-17 19:28:44 +02001398 Py_DECREF(cpathbytes_tmp);
Victor Stinner783c82c2011-04-20 03:27:51 +02001399#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001400 return;
1401 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001402 fclose(fp);
Antoine Pitrou707033a2011-10-17 19:28:44 +02001403 /* Under POSIX, do an atomic rename */
1404#ifndef MS_WINDOWS
1405 if (rename(PyBytes_AS_STRING(cpathbytes_tmp),
1406 PyBytes_AS_STRING(cpathbytes))) {
1407 if (Py_VerboseFlag)
1408 PySys_FormatStderr("# can't write %R\n", cpathname);
1409 /* Don't keep tmp file */
1410 unlink(PyBytes_AS_STRING(cpathbytes_tmp));
1411 Py_DECREF(cpathbytes);
1412 Py_DECREF(cpathbytes_tmp);
1413 return;
1414 }
1415 Py_DECREF(cpathbytes);
1416 Py_DECREF(cpathbytes_tmp);
1417#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001418 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001419 PySys_FormatStderr("# wrote %R\n", cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001420}
1421
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001422static void
1423update_code_filenames(PyCodeObject *co, PyObject *oldname, PyObject *newname)
1424{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001425 PyObject *constants, *tmp;
1426 Py_ssize_t i, n;
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001427
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001428 if (PyUnicode_Compare(co->co_filename, oldname))
1429 return;
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001430
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001431 tmp = co->co_filename;
1432 co->co_filename = newname;
1433 Py_INCREF(co->co_filename);
1434 Py_DECREF(tmp);
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001435
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001436 constants = co->co_consts;
1437 n = PyTuple_GET_SIZE(constants);
1438 for (i = 0; i < n; i++) {
1439 tmp = PyTuple_GET_ITEM(constants, i);
1440 if (PyCode_Check(tmp))
1441 update_code_filenames((PyCodeObject *)tmp,
1442 oldname, newname);
1443 }
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001444}
1445
Victor Stinner2f42ae52011-03-20 00:41:24 +01001446static void
1447update_compiled_module(PyCodeObject *co, PyObject *newname)
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001448{
Victor Stinner2f42ae52011-03-20 00:41:24 +01001449 PyObject *oldname;
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001450
Victor Stinner2f42ae52011-03-20 00:41:24 +01001451 if (PyUnicode_Compare(co->co_filename, newname) == 0)
1452 return;
Hirokazu Yamamoto4f447fb2009-03-04 01:52:10 +00001453
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001454 oldname = co->co_filename;
1455 Py_INCREF(oldname);
1456 update_code_filenames(co, oldname, newname);
1457 Py_DECREF(oldname);
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001458}
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001459
Brett Cannon442c9b92011-03-23 16:14:42 -07001460static PyObject *
1461imp_fix_co_filename(PyObject *self, PyObject *args)
1462{
1463 PyObject *co;
1464 PyObject *file_path;
1465
1466 if (!PyArg_ParseTuple(args, "OO:_fix_co_filename", &co, &file_path))
1467 return NULL;
1468
1469 if (!PyCode_Check(co)) {
1470 PyErr_SetString(PyExc_TypeError,
1471 "first argument must be a code object");
1472 return NULL;
1473 }
1474
1475 if (!PyUnicode_Check(file_path)) {
1476 PyErr_SetString(PyExc_TypeError,
1477 "second argument must be a string");
1478 return NULL;
1479 }
1480
1481 update_compiled_module((PyCodeObject*)co, file_path);
1482
1483 Py_RETURN_NONE;
1484}
1485
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001486/* Load a source module from a given file and return its module
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001487 object WITH INCREMENTED REFERENCE COUNT. If there's a matching
1488 byte-compiled file, use that instead. */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001489
Guido van Rossum79f25d91997-04-29 20:08:16 +00001490static PyObject *
Victor Stinner2f42ae52011-03-20 00:41:24 +01001491load_source_module(PyObject *name, PyObject *pathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001492{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001493 struct stat st;
1494 FILE *fpc;
Victor Stinner2f42ae52011-03-20 00:41:24 +01001495 PyObject *cpathname = NULL, *cpathbytes = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001496 PyCodeObject *co;
Victor Stinner2f42ae52011-03-20 00:41:24 +01001497 PyObject *m = NULL;
Brett Cannon9a5b25a2010-03-01 02:09:17 +00001498
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001499 if (fstat(fileno(fp), &st) != 0) {
1500 PyErr_Format(PyExc_RuntimeError,
Victor Stinner2f42ae52011-03-20 00:41:24 +01001501 "unable to get file status from %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001502 pathname);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001503 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001504 }
Fred Drake4c82b232000-06-30 16:18:57 +00001505#if SIZEOF_TIME_T > 4
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001506 /* Python's .pyc timestamp handling presumes that the timestamp fits
1507 in 4 bytes. This will be fine until sometime in the year 2038,
1508 when a 4-byte signed time_t will overflow.
1509 */
1510 if (st.st_mtime >> 32) {
1511 PyErr_SetString(PyExc_OverflowError,
1512 "modification time overflows a 4 byte field");
Victor Stinner2f42ae52011-03-20 00:41:24 +01001513 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001514 }
Fred Drake4c82b232000-06-30 16:18:57 +00001515#endif
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001516 cpathname = make_compiled_pathname(pathname, !Py_OptimizeFlag);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001517
1518 if (cpathname != NULL)
1519 fpc = check_compiled_module(pathname, st.st_mtime, cpathname);
1520 else
1521 fpc = NULL;
1522
1523 if (fpc) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001524 co = read_compiled_module(cpathname, fpc);
1525 fclose(fpc);
1526 if (co == NULL)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001527 goto error;
1528 update_compiled_module(co, pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001529 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001530 PySys_FormatStderr("import %U # precompiled from %R\n",
1531 name, cpathname);
1532 m = PyImport_ExecCodeModuleObject(name, (PyObject *)co,
1533 cpathname, cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001534 }
1535 else {
1536 co = parse_source_module(pathname, fp);
1537 if (co == NULL)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001538 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001539 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001540 PySys_FormatStderr("import %U # from %R\n",
Victor Stinner98dbba52011-03-14 15:15:47 -04001541 name, pathname);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001542 if (cpathname != NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001543 PyObject *ro = PySys_GetObject("dont_write_bytecode");
1544 if (ro == NULL || !PyObject_IsTrue(ro))
1545 write_compiled_module(co, cpathname, &st);
1546 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01001547 m = PyImport_ExecCodeModuleObject(name, (PyObject *)co,
1548 pathname, cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001549 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001550 Py_DECREF(co);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001551
Victor Stinner2f42ae52011-03-20 00:41:24 +01001552error:
1553 Py_XDECREF(cpathbytes);
1554 Py_XDECREF(cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001555 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001556}
1557
Christian Heimes3b06e532008-01-07 20:12:44 +00001558/* Get source file -> unicode or None
1559 * Returns the path to the py file if available, else the given path
1560 */
1561static PyObject *
Victor Stinnerc9abda02011-03-14 13:33:46 -04001562get_sourcefile(PyObject *filename)
Christian Heimes3b06e532008-01-07 20:12:44 +00001563{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001564 Py_ssize_t len;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001565 Py_UCS4 *fileuni;
Victor Stinnerc9abda02011-03-14 13:33:46 -04001566 PyObject *py;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001567 struct stat statbuf;
Christian Heimes3b06e532008-01-07 20:12:44 +00001568
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001569 len = PyUnicode_GET_LENGTH(filename);
Victor Stinnerc9abda02011-03-14 13:33:46 -04001570 if (len == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001571 Py_RETURN_NONE;
Christian Heimes3b06e532008-01-07 20:12:44 +00001572
Victor Stinnerc9abda02011-03-14 13:33:46 -04001573 /* don't match *.pyc or *.pyo? */
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001574 fileuni = PyUnicode_AsUCS4Copy(filename);
1575 if (!fileuni)
1576 return NULL;
Victor Stinnerc9abda02011-03-14 13:33:46 -04001577 if (len < 5
1578 || fileuni[len-4] != '.'
1579 || (fileuni[len-3] != 'p' && fileuni[len-3] != 'P')
1580 || (fileuni[len-2] != 'y' && fileuni[len-2] != 'Y'))
1581 goto unchanged;
Christian Heimes3b06e532008-01-07 20:12:44 +00001582
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001583 /* Start by trying to turn PEP 3147 path into source path. If that
1584 * fails, just chop off the trailing character, i.e. legacy pyc path
1585 * to py.
1586 */
Victor Stinnerc9abda02011-03-14 13:33:46 -04001587 py = make_source_pathname(filename);
1588 if (py == NULL) {
1589 PyErr_Clear();
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001590 py = PyUnicode_FromKindAndData(PyUnicode_4BYTE_KIND, fileuni, len - 1);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001591 }
Victor Stinnerc9abda02011-03-14 13:33:46 -04001592 if (py == NULL)
1593 goto error;
Barry Warsaw28a691b2010-04-17 00:19:56 +00001594
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02001595 if (_Py_stat(py, &statbuf) == 0 && S_ISREG(statbuf.st_mode)) {
1596 PyMem_Free(fileuni);
Victor Stinnerc9abda02011-03-14 13:33:46 -04001597 return py;
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02001598 }
Victor Stinnerc9abda02011-03-14 13:33:46 -04001599 Py_DECREF(py);
1600 goto unchanged;
1601
1602error:
1603 PyErr_Clear();
1604unchanged:
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001605 PyMem_Free(fileuni);
Victor Stinnerc9abda02011-03-14 13:33:46 -04001606 Py_INCREF(filename);
1607 return filename;
Christian Heimes3b06e532008-01-07 20:12:44 +00001608}
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001609
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001610/* Forward */
Victor Stinner41c5fec2011-03-13 21:46:30 -04001611static PyObject *load_module(PyObject *, FILE *, PyObject *, int, PyObject *);
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001612static struct filedescr *find_module(PyObject *, PyObject *, PyObject *,
Victor Stinner2fd76e42011-03-14 15:19:39 -04001613 PyObject **, FILE **, PyObject **);
Victor Stinner53dc7352011-03-20 01:50:21 +01001614static struct _frozen * find_frozen(PyObject *);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001615
1616/* Load a package and return its module object WITH INCREMENTED
1617 REFERENCE COUNT */
1618
1619static PyObject *
Victor Stinnerc9abda02011-03-14 13:33:46 -04001620load_package(PyObject *name, PyObject *pathname)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001621{
Victor Stinner41c5fec2011-03-13 21:46:30 -04001622 PyObject *m, *d, *bufobj;
Victor Stinnerc9abda02011-03-14 13:33:46 -04001623 PyObject *file = NULL, *path_list = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001624 int err;
Victor Stinnerc9abda02011-03-14 13:33:46 -04001625 FILE *fp = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001626 struct filedescr *fdp;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001627
Victor Stinnerc9abda02011-03-14 13:33:46 -04001628 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001629 if (m == NULL)
1630 return NULL;
1631 if (Py_VerboseFlag)
Victor Stinner98dbba52011-03-14 15:15:47 -04001632 PySys_FormatStderr("import %U # directory %R\n",
1633 name, pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001634 file = get_sourcefile(pathname);
1635 if (file == NULL)
Victor Stinnerc9abda02011-03-14 13:33:46 -04001636 return NULL;
1637 path_list = Py_BuildValue("[O]", file);
1638 if (path_list == NULL) {
1639 Py_DECREF(file);
1640 return NULL;
1641 }
1642 d = PyModule_GetDict(m);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001643 err = PyDict_SetItemString(d, "__file__", file);
Victor Stinnerc9abda02011-03-14 13:33:46 -04001644 Py_DECREF(file);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001645 if (err == 0)
Victor Stinnerc9abda02011-03-14 13:33:46 -04001646 err = PyDict_SetItemString(d, "__path__", path_list);
1647 if (err != 0) {
1648 Py_DECREF(path_list);
1649 return NULL;
1650 }
Victor Stinner533d7832011-03-14 13:22:54 -04001651 fdp = find_module(name, initstr, path_list,
Victor Stinner2fd76e42011-03-14 15:19:39 -04001652 &bufobj, &fp, NULL);
Victor Stinnerc9abda02011-03-14 13:33:46 -04001653 Py_DECREF(path_list);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001654 if (fdp == NULL) {
1655 if (PyErr_ExceptionMatches(PyExc_ImportError)) {
1656 PyErr_Clear();
1657 Py_INCREF(m);
Victor Stinnerc9abda02011-03-14 13:33:46 -04001658 return m;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001659 }
1660 else
Victor Stinnerc9abda02011-03-14 13:33:46 -04001661 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001662 }
Victor Stinner2fd76e42011-03-14 15:19:39 -04001663 m = load_module(name, fp, bufobj, fdp->type, NULL);
1664 Py_XDECREF(bufobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001665 if (fp != NULL)
1666 fclose(fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001667 return m;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001668}
1669
1670
1671/* Helper to test for built-in module */
1672
1673static int
Victor Stinner95872862011-03-07 18:20:56 +01001674is_builtin(PyObject *name)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001675{
Victor Stinner95872862011-03-07 18:20:56 +01001676 int i, cmp;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001677 for (i = 0; PyImport_Inittab[i].name != NULL; i++) {
Victor Stinner95872862011-03-07 18:20:56 +01001678 cmp = PyUnicode_CompareWithASCIIString(name, PyImport_Inittab[i].name);
1679 if (cmp == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001680 if (PyImport_Inittab[i].initfunc == NULL)
1681 return -1;
1682 else
1683 return 1;
1684 }
1685 }
1686 return 0;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001687}
1688
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001689
Just van Rossum52e14d62002-12-30 22:08:05 +00001690/* Return an importer object for a sys.path/pkg.__path__ item 'p',
1691 possibly by fetching it from the path_importer_cache dict. If it
Thomas Wouters89f507f2006-12-13 04:49:30 +00001692 wasn't yet cached, traverse path_hooks until a hook is found
Just van Rossum52e14d62002-12-30 22:08:05 +00001693 that can handle the path item. Return None if no hook could;
1694 this tells our caller it should fall back to the builtin
1695 import mechanism. Cache the result in path_importer_cache.
1696 Returns a borrowed reference. */
1697
1698static PyObject *
1699get_path_importer(PyObject *path_importer_cache, PyObject *path_hooks,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001700 PyObject *p)
Just van Rossum52e14d62002-12-30 22:08:05 +00001701{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001702 PyObject *importer;
1703 Py_ssize_t j, nhooks;
Just van Rossum52e14d62002-12-30 22:08:05 +00001704
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001705 /* These conditions are the caller's responsibility: */
1706 assert(PyList_Check(path_hooks));
1707 assert(PyDict_Check(path_importer_cache));
Just van Rossum52e14d62002-12-30 22:08:05 +00001708
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001709 nhooks = PyList_Size(path_hooks);
1710 if (nhooks < 0)
1711 return NULL; /* Shouldn't happen */
Just van Rossum52e14d62002-12-30 22:08:05 +00001712
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001713 importer = PyDict_GetItem(path_importer_cache, p);
1714 if (importer != NULL)
1715 return importer;
Just van Rossum52e14d62002-12-30 22:08:05 +00001716
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001717 /* set path_importer_cache[p] to None to avoid recursion */
1718 if (PyDict_SetItem(path_importer_cache, p, Py_None) != 0)
1719 return NULL;
Just van Rossum52e14d62002-12-30 22:08:05 +00001720
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001721 for (j = 0; j < nhooks; j++) {
1722 PyObject *hook = PyList_GetItem(path_hooks, j);
1723 if (hook == NULL)
1724 return NULL;
1725 importer = PyObject_CallFunctionObjArgs(hook, p, NULL);
1726 if (importer != NULL)
1727 break;
Just van Rossum52e14d62002-12-30 22:08:05 +00001728
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001729 if (!PyErr_ExceptionMatches(PyExc_ImportError)) {
1730 return NULL;
1731 }
1732 PyErr_Clear();
1733 }
1734 if (importer == NULL) {
1735 importer = PyObject_CallFunctionObjArgs(
1736 (PyObject *)&PyNullImporter_Type, p, NULL
1737 );
1738 if (importer == NULL) {
1739 if (PyErr_ExceptionMatches(PyExc_ImportError)) {
1740 PyErr_Clear();
1741 return Py_None;
1742 }
1743 }
1744 }
1745 if (importer != NULL) {
1746 int err = PyDict_SetItem(path_importer_cache, p, importer);
1747 Py_DECREF(importer);
1748 if (err != 0)
1749 return NULL;
1750 }
1751 return importer;
Just van Rossum52e14d62002-12-30 22:08:05 +00001752}
1753
Christian Heimes9cd17752007-11-18 19:35:23 +00001754PyAPI_FUNC(PyObject *)
1755PyImport_GetImporter(PyObject *path) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001756 PyObject *importer=NULL, *path_importer_cache=NULL, *path_hooks=NULL;
Christian Heimes9cd17752007-11-18 19:35:23 +00001757
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001758 if ((path_importer_cache = PySys_GetObject("path_importer_cache"))) {
1759 if ((path_hooks = PySys_GetObject("path_hooks"))) {
1760 importer = get_path_importer(path_importer_cache,
1761 path_hooks, path);
1762 }
1763 }
1764 Py_XINCREF(importer); /* get_path_importer returns a borrowed reference */
1765 return importer;
Christian Heimes9cd17752007-11-18 19:35:23 +00001766}
1767
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001768/* Search the path (default sys.path) for a module. Return the
1769 corresponding filedescr struct, and (via return arguments) the
1770 pathname and an open file. Return NULL if the module is not found. */
1771
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001772#ifdef MS_COREDLL
Victor Stinner4d6c1c42011-03-08 23:49:04 +01001773extern FILE *_PyWin_FindRegisteredModule(PyObject *, struct filedescr **,
1774 PyObject **p_path);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001775#endif
1776
Victor Stinner547a2a62011-03-20 03:07:28 +01001777/* Forward */
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001778static int case_ok(PyObject *, Py_ssize_t, PyObject *);
Victor Stinner547a2a62011-03-20 03:07:28 +01001779static int find_init_module(PyObject *);
Just van Rossum52e14d62002-12-30 22:08:05 +00001780static struct filedescr importhookdescr = {"", "", IMP_HOOK};
Guido van Rossum197346f1997-10-31 18:38:52 +00001781
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001782/* Get the path of a module: get its importer and call importer.find_module()
1783 hook, or check if the module if a package (if path/__init__.py exists).
1784
1785 -1: error: a Python error occurred
1786 0: ignore: an error occurred because of invalid data, but the error is not
1787 important enough to be reported.
1788 1: get path: module not found, but *buf contains its path
1789 2: found: *p_fd is the file descriptor (IMP_HOOK or PKG_DIRECTORY)
1790 and *buf is the path */
1791
1792static int
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001793find_module_path(PyObject *fullname, PyObject *name, PyObject *path,
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001794 PyObject *path_hooks, PyObject *path_importer_cache,
Victor Stinner2fd76e42011-03-14 15:19:39 -04001795 PyObject **p_path, PyObject **p_loader, struct filedescr **p_fd)
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001796{
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001797 Py_UCS4 buf[MAXPATHLEN+1];
Victor Stinner2fd76e42011-03-14 15:19:39 -04001798 PyObject *path_unicode, *filename;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001799 Py_ssize_t len;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001800 struct stat statbuf;
1801 static struct filedescr fd_package = {"", "", PKG_DIRECTORY};
1802
1803 if (PyUnicode_Check(path)) {
Victor Stinner2fd76e42011-03-14 15:19:39 -04001804 Py_INCREF(path);
1805 path_unicode = path;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001806 }
1807 else if (PyBytes_Check(path)) {
Victor Stinner2fd76e42011-03-14 15:19:39 -04001808 path_unicode = PyUnicode_DecodeFSDefaultAndSize(
1809 PyBytes_AS_STRING(path), PyBytes_GET_SIZE(path));
1810 if (path_unicode == NULL)
1811 return -1;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001812 }
1813 else
1814 return 0;
1815
Victor Stinner46084ba2011-10-06 02:39:42 +02001816 if (PyUnicode_READY(path_unicode))
1817 return -1;
1818
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001819 len = PyUnicode_GET_LENGTH(path_unicode);
Georg Brandl4cb0de22011-09-28 21:49:49 +02001820 if (!PyUnicode_AsUCS4(path_unicode, buf, Py_ARRAY_LENGTH(buf), 1)) {
Victor Stinner2fd76e42011-03-14 15:19:39 -04001821 Py_DECREF(path_unicode);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001822 PyErr_Clear();
1823 return 0;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001824 }
Victor Stinner2fd76e42011-03-14 15:19:39 -04001825 Py_DECREF(path_unicode);
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001826
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001827 if (Py_UCS4_strlen(buf) != len)
Victor Stinner2fd76e42011-03-14 15:19:39 -04001828 return 0; /* path contains '\0' */
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001829
1830 /* sys.path_hooks import hook */
1831 if (p_loader != NULL) {
Martin v. Löwisbd928fe2011-10-14 10:20:37 +02001832 _Py_IDENTIFIER(find_module);
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001833 PyObject *importer;
1834
1835 importer = get_path_importer(path_importer_cache,
1836 path_hooks, path);
1837 if (importer == NULL) {
1838 return -1;
1839 }
1840 /* Note: importer is a borrowed reference */
1841 if (importer != Py_None) {
1842 PyObject *loader;
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02001843 loader = _PyObject_CallMethodId(importer,
1844 &PyId_find_module, "O", fullname);
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001845 if (loader == NULL)
1846 return -1; /* error */
1847 if (loader != Py_None) {
1848 /* a loader was found */
1849 *p_loader = loader;
1850 *p_fd = &importhookdescr;
1851 return 2;
1852 }
1853 Py_DECREF(loader);
1854 return 0;
1855 }
1856 }
1857 /* no hook was found, use builtin import */
1858
1859 if (len > 0 && buf[len-1] != SEP
1860#ifdef ALTSEP
1861 && buf[len-1] != ALTSEP
1862#endif
1863 )
1864 buf[len++] = SEP;
Georg Brandl4cb0de22011-09-28 21:49:49 +02001865 if (!PyUnicode_AsUCS4(name, buf+len, Py_ARRAY_LENGTH(buf)-len, 1)) {
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001866 PyErr_Clear();
1867 return 0;
1868 }
1869 len += PyUnicode_GET_LENGTH(name);
Victor Stinner2fd76e42011-03-14 15:19:39 -04001870
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001871 filename = PyUnicode_FromKindAndData(PyUnicode_4BYTE_KIND,
1872 buf, len);
Victor Stinner2fd76e42011-03-14 15:19:39 -04001873 if (filename == NULL)
1874 return -1;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001875
1876 /* Check for package import (buf holds a directory name,
1877 and there's an __init__ module in that directory */
1878#ifdef HAVE_STAT
Victor Stinner2fd76e42011-03-14 15:19:39 -04001879 if (_Py_stat(filename, &statbuf) == 0 && /* it exists */
Victor Stinnerd0296212011-03-14 14:04:10 -04001880 S_ISDIR(statbuf.st_mode)) /* it's a directory */
1881 {
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001882 int match;
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001883
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001884 match = case_ok(filename, 0, name);
1885 if (match < 0) {
1886 Py_DECREF(filename);
1887 return -1;
1888 }
1889 if (match) { /* case matches */
1890 if (find_init_module(filename)) { /* and has __init__.py */
Victor Stinner2fd76e42011-03-14 15:19:39 -04001891 *p_path = filename;
Victor Stinnerd0296212011-03-14 14:04:10 -04001892 *p_fd = &fd_package;
1893 return 2;
1894 }
1895 else {
1896 int err;
Victor Stinnerd0296212011-03-14 14:04:10 -04001897 err = PyErr_WarnFormat(PyExc_ImportWarning, 1,
Victor Stinner547a2a62011-03-20 03:07:28 +01001898 "Not importing directory %R: missing __init__.py",
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001899 filename);
Victor Stinner547a2a62011-03-20 03:07:28 +01001900 if (err) {
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001901 Py_DECREF(filename);
Victor Stinnerd0296212011-03-14 14:04:10 -04001902 return -1;
Victor Stinner547a2a62011-03-20 03:07:28 +01001903 }
Victor Stinnerd0296212011-03-14 14:04:10 -04001904 }
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001905 }
1906 }
1907#endif
Victor Stinner2fd76e42011-03-14 15:19:39 -04001908 *p_path = filename;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001909 return 1;
1910}
1911
1912/* Find a module in search_path_list. For each path, try
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001913 find_module_path() or try each _PyImport_Filetab suffix.
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001914
1915 If the module is found, return a file descriptor, write the path in
1916 *p_filename, write the pointer to the file object into *p_fp, and (if
1917 p_loader is not NULL) the loader into *p_loader.
1918
1919 Otherwise, raise an exception and return NULL. */
1920
Victor Stinner37580282011-03-20 01:34:43 +01001921static struct filedescr*
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001922find_module_path_list(PyObject *fullname, PyObject *name,
Victor Stinner37580282011-03-20 01:34:43 +01001923 PyObject *search_path_list, PyObject *path_hooks,
1924 PyObject *path_importer_cache,
Victor Stinner2fd76e42011-03-14 15:19:39 -04001925 PyObject **p_path, FILE **p_fp, PyObject **p_loader)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001926{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001927 Py_ssize_t i, npath;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001928 struct filedescr *fdp = NULL;
1929 char *filemode;
1930 FILE *fp = NULL;
Victor Stinner2fd76e42011-03-14 15:19:39 -04001931 PyObject *prefix, *filename;
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001932 int match;
Victor Stinner53dc7352011-03-20 01:50:21 +01001933
Victor Stinner37580282011-03-20 01:34:43 +01001934 npath = PyList_Size(search_path_list);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001935 for (i = 0; i < npath; i++) {
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001936 PyObject *path;
1937 int ok;
1938
1939 path = PyList_GetItem(search_path_list, i);
1940 if (path == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001941 return NULL;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001942
Victor Stinner2fd76e42011-03-14 15:19:39 -04001943 prefix = NULL;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001944 ok = find_module_path(fullname, name, path,
1945 path_hooks, path_importer_cache,
Victor Stinner2fd76e42011-03-14 15:19:39 -04001946 &prefix, p_loader, &fdp);
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001947 if (ok < 0)
1948 return NULL;
1949 if (ok == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001950 continue;
Victor Stinner2fd76e42011-03-14 15:19:39 -04001951 if (ok == 2) {
1952 *p_path = prefix;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001953 return fdp;
Victor Stinner2fd76e42011-03-14 15:19:39 -04001954 }
Amaury Forgeot d'Arcf1ca0b12008-06-11 17:40:47 +00001955
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001956 for (fdp = _PyImport_Filetab; fdp->suffix != NULL; fdp++) {
Victor Stinnera1fe1f82011-09-23 18:59:08 +02001957 struct stat statbuf;
1958
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001959 filemode = fdp->mode;
1960 if (filemode[0] == 'U')
1961 filemode = "r" PY_STDIOTEXTMODE;
Victor Stinnerd0296212011-03-14 14:04:10 -04001962
Victor Stinner2fd76e42011-03-14 15:19:39 -04001963 filename = PyUnicode_FromFormat("%U%s", prefix, fdp->suffix);
1964 if (filename == NULL) {
1965 Py_DECREF(prefix);
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001966 return NULL;
Victor Stinner2fd76e42011-03-14 15:19:39 -04001967 }
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001968
1969 if (Py_VerboseFlag > 1)
1970 PySys_FormatStderr("# trying %R\n", filename);
1971
Victor Stinnera1fe1f82011-09-23 18:59:08 +02001972 if (_Py_stat(filename, &statbuf) == 0 && /* it exists */
1973 S_ISDIR(statbuf.st_mode)) /* it's a directory */
1974 {
1975 Py_DECREF(filename);
1976 continue;
1977 }
1978
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001979 fp = _Py_fopen(filename, filemode);
1980 if (fp == NULL) {
1981 Py_DECREF(filename);
Victor Stinner925ef392011-06-20 15:01:10 +02001982 if (PyErr_Occurred()) {
1983 Py_DECREF(prefix);
1984 return NULL;
1985 }
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001986 continue;
1987 }
1988 match = case_ok(filename, -(Py_ssize_t)strlen(fdp->suffix), name);
1989 if (match < 0) {
Victor Stinner2fd76e42011-03-14 15:19:39 -04001990 Py_DECREF(prefix);
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001991 Py_DECREF(filename);
1992 return NULL;
1993 }
1994 if (match) {
Victor Stinner2fd76e42011-03-14 15:19:39 -04001995 Py_DECREF(prefix);
1996 *p_path = filename;
Victor Stinnerd0296212011-03-14 14:04:10 -04001997 *p_fp = fp;
1998 return fdp;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001999 }
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002000 Py_DECREF(filename);
Victor Stinnerd0296212011-03-14 14:04:10 -04002001
2002 fclose(fp);
2003 fp = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002004 }
Victor Stinner2fd76e42011-03-14 15:19:39 -04002005 Py_DECREF(prefix);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002006 }
Victor Stinnerd0296212011-03-14 14:04:10 -04002007 PyErr_Format(PyExc_ImportError,
Victor Stinner98dbba52011-03-14 15:15:47 -04002008 "No module named %R", name);
Victor Stinnerd0296212011-03-14 14:04:10 -04002009 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002010}
2011
Victor Stinner37580282011-03-20 01:34:43 +01002012/* Find a module:
2013
2014 - try find_module() of each sys.meta_path hook
2015 - try find_frozen()
2016 - try is_builtin()
2017 - try _PyWin_FindRegisteredModule() (Windows only)
2018 - otherwise, call find_module_path_list() with search_path_list (if not
2019 NULL) or sys.path
2020
Victor Stinner2fd76e42011-03-14 15:19:39 -04002021 fullname can be NULL, but only if p_loader is NULL.
2022
Victor Stinner37580282011-03-20 01:34:43 +01002023 Return:
2024
2025 - &fd_builtin (C_BUILTIN) if it is a builtin
2026 - &fd_frozen (PY_FROZEN) if it is frozen
Victor Stinner2fd76e42011-03-14 15:19:39 -04002027 - &fd_package (PKG_DIRECTORY) and write the filename into *p_path
Victor Stinner37580282011-03-20 01:34:43 +01002028 if it is a package
2029 - &importhookdescr (IMP_HOOK) and write the loader into *p_loader if a
2030 importer loader was found
2031 - a file descriptor (PY_SOURCE, PY_COMPILED, C_EXTENSION, PY_RESOURCE or
2032 PY_CODERESOURCE: see _PyImport_Filetab), write the filename into
Victor Stinner2fd76e42011-03-14 15:19:39 -04002033 *p_path and the pointer to the open file into *p_fp
Victor Stinner37580282011-03-20 01:34:43 +01002034 - NULL on error
2035
Victor Stinner2fd76e42011-03-14 15:19:39 -04002036 By default, *p_path, *p_fp and *p_loader (if set) are set to NULL.
2037 Eg. *p_path is set to NULL for a builtin package.
2038*/
Victor Stinner37580282011-03-20 01:34:43 +01002039
2040static struct filedescr *
Victor Stinnerad3c03b2011-03-14 09:21:33 -04002041find_module(PyObject *fullname, PyObject *name, PyObject *search_path_list,
Victor Stinner2fd76e42011-03-14 15:19:39 -04002042 PyObject **p_path, FILE **p_fp, PyObject **p_loader)
Victor Stinner37580282011-03-20 01:34:43 +01002043{
2044 Py_ssize_t i, npath;
2045 static struct filedescr fd_frozen = {"", "", PY_FROZEN};
2046 static struct filedescr fd_builtin = {"", "", C_BUILTIN};
2047 PyObject *path_hooks, *path_importer_cache;
Victor Stinner37580282011-03-20 01:34:43 +01002048
Victor Stinner2fd76e42011-03-14 15:19:39 -04002049 *p_path = NULL;
Victor Stinner37580282011-03-20 01:34:43 +01002050 *p_fp = NULL;
2051 if (p_loader != NULL)
2052 *p_loader = NULL;
2053
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002054 if (PyUnicode_GET_LENGTH(name) > MAXPATHLEN) {
2055 PyErr_SetString(PyExc_OverflowError,
2056 "module name is too long");
2057 return NULL;
2058 }
2059
Victor Stinner37580282011-03-20 01:34:43 +01002060 /* sys.meta_path import hook */
2061 if (p_loader != NULL) {
Martin v. Löwisbd928fe2011-10-14 10:20:37 +02002062 _Py_IDENTIFIER(find_module);
Victor Stinner37580282011-03-20 01:34:43 +01002063 PyObject *meta_path;
2064
2065 meta_path = PySys_GetObject("meta_path");
2066 if (meta_path == NULL || !PyList_Check(meta_path)) {
Victor Stinner16191322011-09-15 19:28:05 +02002067 PyErr_SetString(PyExc_RuntimeError,
Victor Stinner37580282011-03-20 01:34:43 +01002068 "sys.meta_path must be a list of "
2069 "import hooks");
2070 return NULL;
2071 }
2072 Py_INCREF(meta_path); /* zap guard */
2073 npath = PyList_Size(meta_path);
2074 for (i = 0; i < npath; i++) {
2075 PyObject *loader;
2076 PyObject *hook = PyList_GetItem(meta_path, i);
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002077 loader = _PyObject_CallMethodId(hook, &PyId_find_module,
Victor Stinnerad3c03b2011-03-14 09:21:33 -04002078 "OO", fullname,
Victor Stinner37580282011-03-20 01:34:43 +01002079 search_path_list != NULL ?
2080 search_path_list : Py_None);
2081 if (loader == NULL) {
2082 Py_DECREF(meta_path);
2083 return NULL; /* true error */
2084 }
2085 if (loader != Py_None) {
2086 /* a loader was found */
2087 *p_loader = loader;
2088 Py_DECREF(meta_path);
2089 return &importhookdescr;
2090 }
2091 Py_DECREF(loader);
2092 }
2093 Py_DECREF(meta_path);
2094 }
2095
Victor Stinnerdf75a022011-03-14 13:40:04 -04002096 if (find_frozen(fullname) != NULL)
Victor Stinnerad3c03b2011-03-14 09:21:33 -04002097 return &fd_frozen;
Victor Stinner37580282011-03-20 01:34:43 +01002098
2099 if (search_path_list == NULL) {
2100#ifdef MS_COREDLL
2101 FILE *fp;
2102 struct filedescr *fdp;
Victor Stinner37580282011-03-20 01:34:43 +01002103#endif
Victor Stinnerdf75a022011-03-14 13:40:04 -04002104 if (is_builtin(name))
Victor Stinner37580282011-03-20 01:34:43 +01002105 return &fd_builtin;
Victor Stinner37580282011-03-20 01:34:43 +01002106#ifdef MS_COREDLL
Victor Stinner2fd76e42011-03-14 15:19:39 -04002107 fp = _PyWin_FindRegisteredModule(name, &fdp, p_path);
Victor Stinner37580282011-03-20 01:34:43 +01002108 if (fp != NULL) {
Victor Stinner37580282011-03-20 01:34:43 +01002109 *p_fp = fp;
2110 return fdp;
2111 }
2112 else if (PyErr_Occurred())
2113 return NULL;
2114#endif
Victor Stinner37580282011-03-20 01:34:43 +01002115 search_path_list = PySys_GetObject("path");
2116 }
2117
2118 if (search_path_list == NULL || !PyList_Check(search_path_list)) {
Victor Stinner16191322011-09-15 19:28:05 +02002119 PyErr_SetString(PyExc_RuntimeError,
Victor Stinner37580282011-03-20 01:34:43 +01002120 "sys.path must be a list of directory names");
2121 return NULL;
2122 }
2123
2124 path_hooks = PySys_GetObject("path_hooks");
2125 if (path_hooks == NULL || !PyList_Check(path_hooks)) {
Victor Stinner16191322011-09-15 19:28:05 +02002126 PyErr_SetString(PyExc_RuntimeError,
Victor Stinner37580282011-03-20 01:34:43 +01002127 "sys.path_hooks must be a list of "
2128 "import hooks");
2129 return NULL;
2130 }
2131 path_importer_cache = PySys_GetObject("path_importer_cache");
2132 if (path_importer_cache == NULL ||
2133 !PyDict_Check(path_importer_cache)) {
Victor Stinner16191322011-09-15 19:28:05 +02002134 PyErr_SetString(PyExc_RuntimeError,
Victor Stinner37580282011-03-20 01:34:43 +01002135 "sys.path_importer_cache must be a dict");
2136 return NULL;
2137 }
2138
2139 return find_module_path_list(fullname, name,
2140 search_path_list, path_hooks,
2141 path_importer_cache,
Victor Stinner2fd76e42011-03-14 15:19:39 -04002142 p_path, p_fp, p_loader);
Victor Stinner37580282011-03-20 01:34:43 +01002143}
2144
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002145/* case_bytes(char* buf, Py_ssize_t len, Py_ssize_t namelen, char* name)
Tim Petersd1e87a82001-03-01 18:12:00 +00002146 * The arguments here are tricky, best shown by example:
2147 * /a/b/c/d/e/f/g/h/i/j/k/some_long_module_name.py\0
2148 * ^ ^ ^ ^
2149 * |--------------------- buf ---------------------|
2150 * |------------------- len ------------------|
2151 * |------ name -------|
2152 * |----- namelen -----|
2153 * buf is the full path, but len only counts up to (& exclusive of) the
2154 * extension. name is the module name, also exclusive of extension.
2155 *
2156 * We've already done a successful stat() or fopen() on buf, so know that
2157 * there's some match, possibly case-insensitive.
2158 *
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002159 * case_bytes() is to return 1 if there's a case-sensitive match for
2160 * name, else 0. case_bytes() is also to return 1 if envar PYTHONCASEOK
Tim Peters50d8d372001-02-28 05:34:27 +00002161 * exists.
Tim Petersd1e87a82001-03-01 18:12:00 +00002162 *
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002163 * case_bytes() is used to implement case-sensitive import semantics even
Tim Peters50d8d372001-02-28 05:34:27 +00002164 * on platforms with case-insensitive filesystems. It's trivial to implement
2165 * for case-sensitive filesystems. It's pretty much a cross-platform
2166 * nightmare for systems with case-insensitive filesystems.
2167 */
Guido van Rossum0980bd91998-02-13 17:18:36 +00002168
Tim Peters50d8d372001-02-28 05:34:27 +00002169/* First we may need a pile of platform-specific header files; the sequence
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002170 * of #if's here should match the sequence in the body of case_bytes().
Tim Peters50d8d372001-02-28 05:34:27 +00002171 */
Jason Tishler7961aa62005-05-20 00:56:54 +00002172#if defined(MS_WINDOWS)
Guido van Rossum0980bd91998-02-13 17:18:36 +00002173#include <windows.h>
Guido van Rossum4c3f57c2001-01-10 20:40:46 +00002174
Tim Peters50d8d372001-02-28 05:34:27 +00002175#elif defined(DJGPP)
2176#include <dir.h>
2177
Jason Tishler7961aa62005-05-20 00:56:54 +00002178#elif (defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) && defined(HAVE_DIRENT_H)
Tim Peters430f5d42001-03-01 01:30:56 +00002179#include <sys/types.h>
2180#include <dirent.h>
2181
Andrew MacIntyred9400542002-02-26 11:41:34 +00002182#elif defined(PYOS_OS2)
2183#define INCL_DOS
2184#define INCL_DOSERRORS
2185#define INCL_NOPMAPI
2186#include <os2.h>
Tim Peters50d8d372001-02-28 05:34:27 +00002187#endif
2188
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002189#if defined(DJGPP) \
2190 || ((defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) \
2191 && defined(HAVE_DIRENT_H)) \
2192 || defined(PYOS_OS2)
2193# define USE_CASE_OK_BYTES
2194#endif
2195
2196
2197#ifdef USE_CASE_OK_BYTES
Guido van Rossum0980bd91998-02-13 17:18:36 +00002198static int
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002199case_bytes(char *buf, Py_ssize_t len, Py_ssize_t namelen, const char *name)
Guido van Rossum0980bd91998-02-13 17:18:36 +00002200{
Tim Peters50d8d372001-02-28 05:34:27 +00002201/* Pick a platform-specific implementation; the sequence of #if's here should
2202 * match the sequence just above.
2203 */
2204
Tim Peters50d8d372001-02-28 05:34:27 +00002205/* DJGPP */
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002206#if defined(DJGPP)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002207 struct ffblk ffblk;
2208 int done;
Tim Peters50d8d372001-02-28 05:34:27 +00002209
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002210 if (Py_GETENV("PYTHONCASEOK") != NULL)
2211 return 1;
Tim Peters50d8d372001-02-28 05:34:27 +00002212
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002213 done = findfirst(buf, &ffblk, FA_ARCH|FA_RDONLY|FA_HIDDEN|FA_DIREC);
2214 if (done) {
2215 PyErr_Format(PyExc_NameError,
2216 "Can't find file for module %.100s\n(filename %.300s)",
2217 name, buf);
Victor Stinner9c61e242011-03-22 01:22:27 +01002218 return -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002219 }
2220 return strncmp(ffblk.ff_name, name, namelen) == 0;
Guido van Rossum0980bd91998-02-13 17:18:36 +00002221
Jason Tishler7961aa62005-05-20 00:56:54 +00002222/* new-fangled macintosh (macosx) or Cygwin */
2223#elif (defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) && defined(HAVE_DIRENT_H)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002224 DIR *dirp;
2225 struct dirent *dp;
2226 char dirname[MAXPATHLEN + 1];
2227 const int dirlen = len - namelen - 1; /* don't want trailing SEP */
Tim Peters430f5d42001-03-01 01:30:56 +00002228
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002229 if (Py_GETENV("PYTHONCASEOK") != NULL)
2230 return 1;
Tim Petersdbe6ebb2001-03-01 08:47:29 +00002231
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002232 /* Copy the dir component into dirname; substitute "." if empty */
2233 if (dirlen <= 0) {
2234 dirname[0] = '.';
2235 dirname[1] = '\0';
2236 }
2237 else {
2238 assert(dirlen <= MAXPATHLEN);
2239 memcpy(dirname, buf, dirlen);
2240 dirname[dirlen] = '\0';
2241 }
2242 /* Open the directory and search the entries for an exact match. */
2243 dirp = opendir(dirname);
2244 if (dirp) {
2245 char *nameWithExt = buf + len - namelen;
2246 while ((dp = readdir(dirp)) != NULL) {
2247 const int thislen =
Tim Peters430f5d42001-03-01 01:30:56 +00002248#ifdef _DIRENT_HAVE_D_NAMELEN
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002249 dp->d_namlen;
Tim Peters430f5d42001-03-01 01:30:56 +00002250#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002251 strlen(dp->d_name);
Tim Peters430f5d42001-03-01 01:30:56 +00002252#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002253 if (thislen >= namelen &&
2254 strcmp(dp->d_name, nameWithExt) == 0) {
2255 (void)closedir(dirp);
2256 return 1; /* Found */
2257 }
2258 }
2259 (void)closedir(dirp);
2260 }
2261 return 0 ; /* Not found */
Tim Peters430f5d42001-03-01 01:30:56 +00002262
Andrew MacIntyred9400542002-02-26 11:41:34 +00002263/* OS/2 */
2264#elif defined(PYOS_OS2)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002265 HDIR hdir = 1;
2266 ULONG srchcnt = 1;
2267 FILEFINDBUF3 ffbuf;
2268 APIRET rc;
Andrew MacIntyred9400542002-02-26 11:41:34 +00002269
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002270 if (Py_GETENV("PYTHONCASEOK") != NULL)
2271 return 1;
Andrew MacIntyred9400542002-02-26 11:41:34 +00002272
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002273 rc = DosFindFirst(buf,
2274 &hdir,
2275 FILE_READONLY | FILE_HIDDEN | FILE_SYSTEM | FILE_DIRECTORY,
2276 &ffbuf, sizeof(ffbuf),
2277 &srchcnt,
2278 FIL_STANDARD);
2279 if (rc != NO_ERROR)
2280 return 0;
2281 return strncmp(ffbuf.achName, name, namelen) == 0;
Andrew MacIntyred9400542002-02-26 11:41:34 +00002282
Tim Peters50d8d372001-02-28 05:34:27 +00002283/* assuming it's a case-sensitive filesystem, so there's nothing to do! */
2284#else
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002285# error "USE_CASE_OK_BYTES is not correctly defined"
2286#endif
2287}
2288#endif
2289
2290/*
2291 * Check if a filename case matchs the name case. We've already done a
2292 * successful stat() or fopen() on buf, so know that there's some match,
2293 * possibly case-insensitive.
2294 *
2295 * case_ok() is to return 1 if there's a case-sensitive match for name, 0 if it
2296 * the filename doesn't match, or -1 on error. case_ok() is also to return 1
2297 * if envar PYTHONCASEOK exists.
2298 *
2299 * case_ok() is used to implement case-sensitive import semantics even
2300 * on platforms with case-insensitive filesystems. It's trivial to implement
2301 * for case-sensitive filesystems. It's pretty much a cross-platform
2302 * nightmare for systems with case-insensitive filesystems.
2303 */
2304
2305static int
2306case_ok(PyObject *filename, Py_ssize_t prefix_delta, PyObject *name)
2307{
2308#ifdef MS_WINDOWS
2309 WIN32_FIND_DATAW data;
2310 HANDLE h;
2311 int cmp;
Victor Stinnerbeac78b2011-10-11 21:55:01 +02002312 wchar_t *wname;
Victor Stinner8c981892011-10-11 22:27:13 +02002313 Py_ssize_t wname_len;
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002314
2315 if (Py_GETENV("PYTHONCASEOK") != NULL)
2316 return 1;
2317
2318 h = FindFirstFileW(PyUnicode_AS_UNICODE(filename), &data);
2319 if (h == INVALID_HANDLE_VALUE) {
2320 PyErr_Format(PyExc_NameError,
2321 "Can't find file for module %R\n(filename %R)",
2322 name, filename);
2323 return 0;
2324 }
2325 FindClose(h);
Victor Stinnerbeac78b2011-10-11 21:55:01 +02002326
2327 wname = PyUnicode_AsUnicodeAndSize(name, &wname_len);
2328 if (wname == NULL)
2329 return -1;
2330
2331 cmp = wcsncmp(data.cFileName, wname, wname_len);
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002332 return cmp == 0;
2333#elif defined(USE_CASE_OK_BYTES)
2334 int match;
2335 PyObject *filebytes, *namebytes;
2336 filebytes = PyUnicode_EncodeFSDefault(filename);
2337 if (filebytes == NULL)
2338 return -1;
2339 namebytes = PyUnicode_EncodeFSDefault(name);
2340 if (namebytes == NULL) {
2341 Py_DECREF(filebytes);
2342 return -1;
2343 }
2344 match = case_bytes(
2345 PyBytes_AS_STRING(filebytes),
2346 PyBytes_GET_SIZE(filebytes) + prefix_delta,
Victor Stinner1304f2d2011-03-20 04:28:55 +01002347 PyBytes_GET_SIZE(namebytes),
2348 PyBytes_AS_STRING(namebytes));
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002349 Py_DECREF(filebytes);
2350 Py_DECREF(namebytes);
2351 return match;
2352#else
2353 /* assuming it's a case-sensitive filesystem, so there's nothing to do! */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002354 return 1;
Guido van Rossum0980bd91998-02-13 17:18:36 +00002355
Guido van Rossum4d1b3b91998-02-13 23:27:59 +00002356#endif
Tim Peters50d8d372001-02-28 05:34:27 +00002357}
Guido van Rossum4d1b3b91998-02-13 23:27:59 +00002358
Guido van Rossum197346f1997-10-31 18:38:52 +00002359#ifdef HAVE_STAT
Victor Stinner4f4402c2010-08-14 14:50:26 +00002360
Victor Stinner547a2a62011-03-20 03:07:28 +01002361/* Helper to look for __init__.py or __init__.py[co] in potential package.
2362 Return 1 if __init__ was found, 0 if not, or -1 on error. */
Guido van Rossum197346f1997-10-31 18:38:52 +00002363static int
Victor Stinner547a2a62011-03-20 03:07:28 +01002364find_init_module(PyObject *directory)
Guido van Rossum197346f1997-10-31 18:38:52 +00002365{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002366 struct stat statbuf;
Victor Stinner547a2a62011-03-20 03:07:28 +01002367 PyObject *filename;
2368 int match;
Guido van Rossum197346f1997-10-31 18:38:52 +00002369
Victor Stinner547a2a62011-03-20 03:07:28 +01002370 filename = PyUnicode_FromFormat("%U%c__init__.py", directory, SEP);
2371 if (filename == NULL)
2372 return -1;
2373 if (_Py_stat(filename, &statbuf) == 0) {
Victor Stinnercc9564e2011-03-20 04:58:29 +01002374 /* 3=len(".py") */
2375 match = case_ok(filename, -3, initstr);
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002376 if (match < 0) {
2377 Py_DECREF(filename);
2378 return -1;
2379 }
2380 if (match) {
Victor Stinner547a2a62011-03-20 03:07:28 +01002381 Py_DECREF(filename);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002382 return 1;
2383 }
2384 }
Victor Stinner547a2a62011-03-20 03:07:28 +01002385 Py_DECREF(filename);
2386
2387 filename = PyUnicode_FromFormat("%U%c__init__.py%c",
2388 directory, SEP, Py_OptimizeFlag ? 'o' : 'c');
2389 if (filename == NULL)
2390 return -1;
2391 if (_Py_stat(filename, &statbuf) == 0) {
Victor Stinnercc9564e2011-03-20 04:58:29 +01002392 /* 4=len(".pyc") */
2393 match = case_ok(filename, -4, initstr);
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002394 if (match < 0) {
2395 Py_DECREF(filename);
2396 return -1;
2397 }
2398 if (match) {
Victor Stinner547a2a62011-03-20 03:07:28 +01002399 Py_DECREF(filename);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002400 return 1;
2401 }
2402 }
Victor Stinner547a2a62011-03-20 03:07:28 +01002403 Py_DECREF(filename);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002404 return 0;
Guido van Rossum197346f1997-10-31 18:38:52 +00002405}
Guido van Rossum48a680c2001-03-02 06:34:14 +00002406
Guido van Rossum197346f1997-10-31 18:38:52 +00002407#endif /* HAVE_STAT */
2408
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002409
Victor Stinner95872862011-03-07 18:20:56 +01002410static int init_builtin(PyObject *); /* Forward */
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002411
Victor Stinner44c6c152010-08-09 00:59:10 +00002412static PyObject*
Victor Stinner95872862011-03-07 18:20:56 +01002413load_builtin(PyObject *name, int type)
Victor Stinner44c6c152010-08-09 00:59:10 +00002414{
2415 PyObject *m, *modules;
2416 int err;
2417
Victor Stinner44c6c152010-08-09 00:59:10 +00002418 if (type == C_BUILTIN)
2419 err = init_builtin(name);
2420 else
Victor Stinner95872862011-03-07 18:20:56 +01002421 err = PyImport_ImportFrozenModuleObject(name);
Victor Stinner44c6c152010-08-09 00:59:10 +00002422 if (err < 0)
2423 return NULL;
2424 if (err == 0) {
2425 PyErr_Format(PyExc_ImportError,
Victor Stinner95872862011-03-07 18:20:56 +01002426 "Purported %s module %R not found",
2427 type == C_BUILTIN ? "builtin" : "frozen",
Victor Stinner44c6c152010-08-09 00:59:10 +00002428 name);
2429 return NULL;
2430 }
2431
2432 modules = PyImport_GetModuleDict();
Victor Stinner95872862011-03-07 18:20:56 +01002433 m = PyDict_GetItem(modules, name);
Victor Stinner44c6c152010-08-09 00:59:10 +00002434 if (m == NULL) {
2435 PyErr_Format(
2436 PyExc_ImportError,
Victor Stinner95872862011-03-07 18:20:56 +01002437 "%s module %R not properly initialized",
2438 type == C_BUILTIN ? "builtin" : "frozen",
Victor Stinner44c6c152010-08-09 00:59:10 +00002439 name);
2440 return NULL;
2441 }
2442 Py_INCREF(m);
2443 return m;
2444}
2445
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002446/* Load an external module using the default search path and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00002447 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002448
Guido van Rossum79f25d91997-04-29 20:08:16 +00002449static PyObject *
Victor Stinner41c5fec2011-03-13 21:46:30 -04002450load_module(PyObject *name, FILE *fp, PyObject *pathname, int type, PyObject *loader)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002451{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002452 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002453
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002454 /* First check that there's an open file (if we need one) */
2455 switch (type) {
2456 case PY_SOURCE:
2457 case PY_COMPILED:
2458 if (fp == NULL) {
2459 PyErr_Format(PyExc_ValueError,
Victor Stinner41c5fec2011-03-13 21:46:30 -04002460 "file object required for import (type code %d)",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002461 type);
2462 return NULL;
2463 }
2464 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002465
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002466 switch (type) {
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002467
Victor Stinner41c5fec2011-03-13 21:46:30 -04002468 case PY_SOURCE:
2469 m = load_source_module(name, pathname, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002470 break;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002471
Victor Stinner41c5fec2011-03-13 21:46:30 -04002472 case PY_COMPILED:
2473 m = load_compiled_module(name, pathname, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002474 break;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002475
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002476#ifdef HAVE_DYNAMIC_LOADING
Victor Stinner41c5fec2011-03-13 21:46:30 -04002477 case C_EXTENSION:
2478 m = _PyImport_LoadDynamicModule(name, pathname, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002479 break;
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002480#endif
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002481
Victor Stinner41c5fec2011-03-13 21:46:30 -04002482 case PKG_DIRECTORY:
2483 m = load_package(name, pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002484 break;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002485
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002486 case C_BUILTIN:
Victor Stinner41c5fec2011-03-13 21:46:30 -04002487 case PY_FROZEN:
2488 m = load_builtin(name, type);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002489 break;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002490
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002491 case IMP_HOOK: {
Martin v. Löwisbd928fe2011-10-14 10:20:37 +02002492 _Py_IDENTIFIER(load_module);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002493 if (loader == NULL) {
2494 PyErr_SetString(PyExc_ImportError,
2495 "import hook without loader");
2496 return NULL;
2497 }
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002498 m = _PyObject_CallMethodId(loader, &PyId_load_module, "O", name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002499 break;
2500 }
Just van Rossum52e14d62002-12-30 22:08:05 +00002501
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002502 default:
2503 PyErr_Format(PyExc_ImportError,
Victor Stinner98dbba52011-03-14 15:15:47 -04002504 "Don't know how to import %R (type code %d)",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002505 name, type);
2506 m = NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002507
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002508 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002509
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002510 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002511}
2512
2513
2514/* Initialize a built-in module.
Thomas Wouters89f507f2006-12-13 04:49:30 +00002515 Return 1 for success, 0 if the module is not found, and -1 with
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002516 an exception set if the initialization failed. */
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002517
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002518static int
Victor Stinner95872862011-03-07 18:20:56 +01002519init_builtin(PyObject *name)
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002520{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002521 struct _inittab *p;
Guido van Rossum25ce5661997-08-02 03:10:38 +00002522
Victor Stinner95872862011-03-07 18:20:56 +01002523 if (_PyImport_FindExtensionObject(name, name) != NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002524 return 1;
Guido van Rossum25ce5661997-08-02 03:10:38 +00002525
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002526 for (p = PyImport_Inittab; p->name != NULL; p++) {
2527 PyObject *mod;
Victor Stinner95872862011-03-07 18:20:56 +01002528 if (PyUnicode_CompareWithASCIIString(name, p->name) == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002529 if (p->initfunc == NULL) {
2530 PyErr_Format(PyExc_ImportError,
Victor Stinner95872862011-03-07 18:20:56 +01002531 "Cannot re-init internal module %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002532 name);
2533 return -1;
2534 }
2535 if (Py_VerboseFlag)
Victor Stinner95872862011-03-07 18:20:56 +01002536 PySys_FormatStderr("import %U # builtin\n", name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002537 mod = (*p->initfunc)();
2538 if (mod == 0)
2539 return -1;
Victor Stinner95872862011-03-07 18:20:56 +01002540 if (_PyImport_FixupExtensionObject(mod, name, name) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002541 return -1;
2542 /* FixupExtension has put the module into sys.modules,
2543 so we can release our own reference. */
2544 Py_DECREF(mod);
2545 return 1;
2546 }
2547 }
2548 return 0;
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002549}
Guido van Rossumf56e3db1993-04-01 20:59:32 +00002550
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002551
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002552/* Frozen modules */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002553
Guido van Rossumcfd0a221996-06-17 17:06:34 +00002554static struct _frozen *
Victor Stinner53dc7352011-03-20 01:50:21 +01002555find_frozen(PyObject *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002556{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002557 struct _frozen *p;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002558
Victor Stinner53dc7352011-03-20 01:50:21 +01002559 if (name == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002560 return NULL;
Benjamin Petersond968e272008-11-05 22:48:33 +00002561
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002562 for (p = PyImport_FrozenModules; ; p++) {
2563 if (p->name == NULL)
2564 return NULL;
Victor Stinner53dc7352011-03-20 01:50:21 +01002565 if (PyUnicode_CompareWithASCIIString(name, p->name) == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002566 break;
2567 }
2568 return p;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002569}
2570
Guido van Rossum79f25d91997-04-29 20:08:16 +00002571static PyObject *
Victor Stinner53dc7352011-03-20 01:50:21 +01002572get_frozen_object(PyObject *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002573{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002574 struct _frozen *p = find_frozen(name);
2575 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002576
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002577 if (p == NULL) {
2578 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002579 "No such frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002580 name);
2581 return NULL;
2582 }
2583 if (p->code == NULL) {
2584 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002585 "Excluded frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002586 name);
2587 return NULL;
2588 }
2589 size = p->size;
2590 if (size < 0)
2591 size = -size;
2592 return PyMarshal_ReadObjectFromString((char *)p->code, size);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002593}
2594
Brett Cannon8d110132009-03-15 02:20:16 +00002595static PyObject *
Victor Stinner53dc7352011-03-20 01:50:21 +01002596is_frozen_package(PyObject *name)
Brett Cannon8d110132009-03-15 02:20:16 +00002597{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002598 struct _frozen *p = find_frozen(name);
2599 int size;
Brett Cannon8d110132009-03-15 02:20:16 +00002600
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002601 if (p == NULL) {
2602 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002603 "No such frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002604 name);
2605 return NULL;
2606 }
Brett Cannon8d110132009-03-15 02:20:16 +00002607
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002608 size = p->size;
Brett Cannon8d110132009-03-15 02:20:16 +00002609
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002610 if (size < 0)
2611 Py_RETURN_TRUE;
2612 else
2613 Py_RETURN_FALSE;
Brett Cannon8d110132009-03-15 02:20:16 +00002614}
2615
2616
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002617/* Initialize a frozen module.
Brett Cannon3c2ac442009-03-08 20:49:47 +00002618 Return 1 for success, 0 if the module is not found, and -1 with
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002619 an exception set if the initialization failed.
2620 This function is also used from frozenmain.c */
Guido van Rossum0b344901995-02-07 15:35:27 +00002621
2622int
Victor Stinner53dc7352011-03-20 01:50:21 +01002623PyImport_ImportFrozenModuleObject(PyObject *name)
Guido van Rossumf56e3db1993-04-01 20:59:32 +00002624{
Victor Stinner53dc7352011-03-20 01:50:21 +01002625 struct _frozen *p;
2626 PyObject *co, *m, *path;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002627 int ispackage;
2628 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002629
Victor Stinner53dc7352011-03-20 01:50:21 +01002630 p = find_frozen(name);
2631
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002632 if (p == NULL)
2633 return 0;
2634 if (p->code == NULL) {
2635 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002636 "Excluded frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002637 name);
2638 return -1;
2639 }
2640 size = p->size;
2641 ispackage = (size < 0);
2642 if (ispackage)
2643 size = -size;
2644 if (Py_VerboseFlag)
Victor Stinner53dc7352011-03-20 01:50:21 +01002645 PySys_FormatStderr("import %U # frozen%s\n",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002646 name, ispackage ? " package" : "");
2647 co = PyMarshal_ReadObjectFromString((char *)p->code, size);
2648 if (co == NULL)
2649 return -1;
2650 if (!PyCode_Check(co)) {
2651 PyErr_Format(PyExc_TypeError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002652 "frozen object %R is not a code object",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002653 name);
2654 goto err_return;
2655 }
2656 if (ispackage) {
2657 /* Set __path__ to the package name */
Victor Stinner53dc7352011-03-20 01:50:21 +01002658 PyObject *d, *l;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002659 int err;
Victor Stinner53dc7352011-03-20 01:50:21 +01002660 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002661 if (m == NULL)
2662 goto err_return;
2663 d = PyModule_GetDict(m);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002664 l = PyList_New(1);
2665 if (l == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002666 goto err_return;
2667 }
Victor Stinner53dc7352011-03-20 01:50:21 +01002668 Py_INCREF(name);
2669 PyList_SET_ITEM(l, 0, name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002670 err = PyDict_SetItemString(d, "__path__", l);
2671 Py_DECREF(l);
2672 if (err != 0)
2673 goto err_return;
2674 }
Victor Stinner53dc7352011-03-20 01:50:21 +01002675 path = PyUnicode_FromString("<frozen>");
2676 if (path == NULL)
2677 goto err_return;
2678 m = PyImport_ExecCodeModuleObject(name, co, path, NULL);
2679 Py_DECREF(path);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002680 if (m == NULL)
2681 goto err_return;
2682 Py_DECREF(co);
2683 Py_DECREF(m);
2684 return 1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002685err_return:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002686 Py_DECREF(co);
2687 return -1;
Guido van Rossumf56e3db1993-04-01 20:59:32 +00002688}
Guido van Rossum74e6a111994-08-29 12:54:38 +00002689
Victor Stinner53dc7352011-03-20 01:50:21 +01002690int
2691PyImport_ImportFrozenModule(char *name)
2692{
2693 PyObject *nameobj;
2694 int ret;
2695 nameobj = PyUnicode_InternFromString(name);
2696 if (nameobj == NULL)
2697 return -1;
2698 ret = PyImport_ImportFrozenModuleObject(nameobj);
2699 Py_DECREF(nameobj);
2700 return ret;
2701}
2702
Guido van Rossum74e6a111994-08-29 12:54:38 +00002703
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002704/* Import a module, either built-in, frozen, or external, and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00002705 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum74e6a111994-08-29 12:54:38 +00002706
Guido van Rossum79f25d91997-04-29 20:08:16 +00002707PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00002708PyImport_ImportModule(const char *name)
Guido van Rossum74e6a111994-08-29 12:54:38 +00002709{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002710 PyObject *pname;
2711 PyObject *result;
Marc-André Lemburg3c61c352001-02-09 19:40:15 +00002712
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002713 pname = PyUnicode_FromString(name);
2714 if (pname == NULL)
2715 return NULL;
2716 result = PyImport_Import(pname);
2717 Py_DECREF(pname);
2718 return result;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002719}
2720
Christian Heimes072c0f12008-01-03 23:01:04 +00002721/* Import a module without blocking
2722 *
2723 * At first it tries to fetch the module from sys.modules. If the module was
2724 * never loaded before it loads it with PyImport_ImportModule() unless another
2725 * thread holds the import lock. In the latter case the function raises an
2726 * ImportError instead of blocking.
2727 *
2728 * Returns the module object with incremented ref count.
2729 */
2730PyObject *
2731PyImport_ImportModuleNoBlock(const char *name)
2732{
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002733 PyObject *nameobj, *modules, *result;
Victor Stinner0af03062011-09-02 00:11:43 +02002734#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002735 long me;
Victor Stinner0af03062011-09-02 00:11:43 +02002736#endif
Christian Heimes072c0f12008-01-03 23:01:04 +00002737
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002738 /* Try to get the module from sys.modules[name] */
2739 modules = PyImport_GetModuleDict();
2740 if (modules == NULL)
2741 return NULL;
Christian Heimes072c0f12008-01-03 23:01:04 +00002742
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002743 nameobj = PyUnicode_FromString(name);
2744 if (nameobj == NULL)
2745 return NULL;
2746 result = PyDict_GetItem(modules, nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002747 if (result != NULL) {
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002748 Py_DECREF(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002749 Py_INCREF(result);
2750 return result;
2751 }
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002752 PyErr_Clear();
Benjamin Peterson3e4f0552008-09-02 00:31:15 +00002753#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002754 /* check the import lock
2755 * me might be -1 but I ignore the error here, the lock function
2756 * takes care of the problem */
2757 me = PyThread_get_thread_ident();
2758 if (import_lock_thread == -1 || import_lock_thread == me) {
2759 /* no thread or me is holding the lock */
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002760 result = PyImport_Import(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002761 }
2762 else {
2763 PyErr_Format(PyExc_ImportError,
Victor Stinnerc24c8102011-03-13 22:38:06 -04002764 "Failed to import %R because the import lock"
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002765 "is held by another thread.",
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002766 nameobj);
2767 result = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002768 }
Benjamin Peterson3e4f0552008-09-02 00:31:15 +00002769#else
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002770 result = PyImport_Import(nameobj);
Benjamin Peterson3e4f0552008-09-02 00:31:15 +00002771#endif
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002772 Py_DECREF(nameobj);
2773 return result;
Christian Heimes072c0f12008-01-03 23:01:04 +00002774}
2775
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002776/* Forward declarations for helper routines */
Victor Stinner974389d2011-03-15 09:33:57 +01002777static PyObject *get_parent(PyObject *globals,
2778 PyObject **p_name,
2779 int level);
Tim Petersdbd9ba62000-07-09 03:09:57 +00002780static PyObject *load_next(PyObject *mod, PyObject *altmod,
Victor Stinner974389d2011-03-15 09:33:57 +01002781 PyObject *inputname, PyObject **p_outputname,
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002782 Py_UCS4 *buf, Py_ssize_t *p_buflen,
Victor Stinner974389d2011-03-15 09:33:57 +01002783 Py_ssize_t bufsize);
2784static int mark_miss(PyObject *name);
Tim Petersdbd9ba62000-07-09 03:09:57 +00002785static int ensure_fromlist(PyObject *mod, PyObject *fromlist,
Victor Stinner974389d2011-03-15 09:33:57 +01002786 PyObject *buf, int recursive);
2787static PyObject * import_submodule(PyObject *mod, PyObject *name,
2788 PyObject *fullname);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002789
2790/* The Magnum Opus of dotted-name import :-) */
2791
Guido van Rossum75acc9c1998-03-03 22:26:50 +00002792static PyObject *
Victor Stinner974389d2011-03-15 09:33:57 +01002793import_module_level(PyObject *name, PyObject *globals, PyObject *locals,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002794 PyObject *fromlist, int level)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002795{
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002796 Py_UCS4 buf[MAXPATHLEN+1];
Victor Stinner974389d2011-03-15 09:33:57 +01002797 Py_ssize_t buflen;
2798 Py_ssize_t bufsize = MAXPATHLEN+1;
2799 PyObject *parent, *head, *next, *tail, *inputname, *outputname;
2800 PyObject *parent_name, *ensure_name;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002801 Py_ssize_t sep, altsep;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002802
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002803 if (PyUnicode_READY(name))
2804 return NULL;
Victor Stinner974389d2011-03-15 09:33:57 +01002805
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002806 sep = PyUnicode_FindChar(name, SEP, 0, PyUnicode_GET_LENGTH(name), 1);
2807 if (sep == -2)
2808 return NULL;
Victor Stinner974389d2011-03-15 09:33:57 +01002809#ifdef ALTSEP
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002810 altsep = PyUnicode_FindChar(name, ALTSEP, 0, PyUnicode_GET_LENGTH(name), 1);
2811 if (altsep == -2)
2812 return NULL;
2813#else
2814 altsep = -1;
Christian Heimes454f37b2008-01-10 00:10:02 +00002815#endif
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002816 if (sep != -1 || altsep != -1)
2817 {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002818 PyErr_SetString(PyExc_ImportError,
2819 "Import by filename is not supported.");
2820 return NULL;
2821 }
Christian Heimes454f37b2008-01-10 00:10:02 +00002822
Victor Stinner974389d2011-03-15 09:33:57 +01002823 parent = get_parent(globals, &parent_name, level);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002824 if (parent == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002825 return NULL;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002826 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002827
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002828 if (PyUnicode_READY(parent_name))
2829 return NULL;
2830 buflen = PyUnicode_GET_LENGTH(parent_name);
Georg Brandl4cb0de22011-09-28 21:49:49 +02002831 if (!PyUnicode_AsUCS4(parent_name, buf, Py_ARRAY_LENGTH(buf), 1)) {
Victor Stinner974389d2011-03-15 09:33:57 +01002832 Py_DECREF(parent_name);
2833 PyErr_SetString(PyExc_ValueError,
2834 "Module name too long");
2835 return NULL;
2836 }
Victor Stinner974389d2011-03-15 09:33:57 +01002837 Py_DECREF(parent_name);
2838
2839 head = load_next(parent, level < 0 ? Py_None : parent, name, &outputname,
2840 buf, &buflen, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002841 if (head == NULL)
2842 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002843
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002844 tail = head;
2845 Py_INCREF(tail);
Victor Stinner974389d2011-03-15 09:33:57 +01002846
2847 if (outputname != NULL) {
2848 while (1) {
2849 inputname = outputname;
2850 next = load_next(tail, tail, inputname, &outputname,
2851 buf, &buflen, bufsize);
2852 Py_DECREF(tail);
2853 Py_DECREF(inputname);
2854 if (next == NULL) {
2855 Py_DECREF(head);
2856 return NULL;
2857 }
2858 tail = next;
2859
2860 if (outputname == NULL) {
2861 break;
2862 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002863 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002864 }
2865 if (tail == Py_None) {
2866 /* If tail is Py_None, both get_parent and load_next found
2867 an empty module name: someone called __import__("") or
2868 doctored faulty bytecode */
2869 Py_DECREF(tail);
2870 Py_DECREF(head);
Victor Stinner974389d2011-03-15 09:33:57 +01002871 PyErr_SetString(PyExc_ValueError, "Empty module name");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002872 return NULL;
2873 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002874
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002875 if (fromlist != NULL) {
2876 if (fromlist == Py_None || !PyObject_IsTrue(fromlist))
2877 fromlist = NULL;
2878 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002879
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002880 if (fromlist == NULL) {
2881 Py_DECREF(tail);
2882 return head;
2883 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002884
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002885 Py_DECREF(head);
Victor Stinner974389d2011-03-15 09:33:57 +01002886
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002887 ensure_name = PyUnicode_FromKindAndData(PyUnicode_4BYTE_KIND,
2888 buf, Py_UCS4_strlen(buf));
Victor Stinner974389d2011-03-15 09:33:57 +01002889 if (ensure_name == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002890 Py_DECREF(tail);
2891 return NULL;
2892 }
Victor Stinner974389d2011-03-15 09:33:57 +01002893 if (!ensure_fromlist(tail, fromlist, ensure_name, 0)) {
2894 Py_DECREF(tail);
2895 Py_DECREF(ensure_name);
2896 return NULL;
2897 }
2898 Py_DECREF(ensure_name);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002899
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002900 return tail;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002901}
2902
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002903PyObject *
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002904PyImport_ImportModuleLevelObject(PyObject *name, PyObject *globals,
2905 PyObject *locals, PyObject *fromlist,
2906 int level)
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002907{
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002908 PyObject *mod;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002909 _PyImport_AcquireLock();
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002910 mod = import_module_level(name, globals, locals, fromlist, level);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002911 if (_PyImport_ReleaseLock() < 0) {
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002912 Py_XDECREF(mod);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002913 PyErr_SetString(PyExc_RuntimeError,
2914 "not holding the import lock");
2915 return NULL;
2916 }
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002917 return mod;
Guido van Rossum75acc9c1998-03-03 22:26:50 +00002918}
2919
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002920PyObject *
Benjamin Peterson04778a82011-05-25 09:29:00 -05002921PyImport_ImportModuleLevel(const char *name, PyObject *globals, PyObject *locals,
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002922 PyObject *fromlist, int level)
2923{
2924 PyObject *nameobj, *mod;
2925 nameobj = PyUnicode_FromString(name);
2926 if (nameobj == NULL)
2927 return NULL;
2928 mod = PyImport_ImportModuleLevelObject(nameobj, globals, locals,
2929 fromlist, level);
2930 Py_DECREF(nameobj);
2931 return mod;
2932}
2933
2934
Fred Drake87590902004-05-28 20:21:36 +00002935/* Return the package that an import is being performed in. If globals comes
2936 from the module foo.bar.bat (not itself a package), this returns the
2937 sys.modules entry for foo.bar. If globals is from a package's __init__.py,
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00002938 the package's entry in sys.modules is returned, as a borrowed reference.
Fred Drake87590902004-05-28 20:21:36 +00002939
Victor Stinner974389d2011-03-15 09:33:57 +01002940 The name of the returned package is returned in *p_name.
Fred Drake87590902004-05-28 20:21:36 +00002941
2942 If globals doesn't come from a package or a module in a package, or a
2943 corresponding entry is not found in sys.modules, Py_None is returned.
2944*/
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002945static PyObject *
Victor Stinner9599de52011-03-13 22:38:38 -04002946get_parent(PyObject *globals, PyObject **p_name, int level)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002947{
Victor Stinner974389d2011-03-15 09:33:57 +01002948 PyObject *nameobj;
2949
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002950 static PyObject *namestr = NULL;
2951 static PyObject *pathstr = NULL;
2952 static PyObject *pkgstr = NULL;
2953 PyObject *pkgname, *modname, *modpath, *modules, *parent;
2954 int orig_level = level;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002955
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002956 if (globals == NULL || !PyDict_Check(globals) || !level)
Victor Stinner974389d2011-03-15 09:33:57 +01002957 goto return_none;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002958
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002959 if (namestr == NULL) {
2960 namestr = PyUnicode_InternFromString("__name__");
2961 if (namestr == NULL)
2962 return NULL;
2963 }
2964 if (pathstr == NULL) {
2965 pathstr = PyUnicode_InternFromString("__path__");
2966 if (pathstr == NULL)
2967 return NULL;
2968 }
2969 if (pkgstr == NULL) {
2970 pkgstr = PyUnicode_InternFromString("__package__");
2971 if (pkgstr == NULL)
2972 return NULL;
2973 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002974
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002975 pkgname = PyDict_GetItem(globals, pkgstr);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002976
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002977 if ((pkgname != NULL) && (pkgname != Py_None)) {
2978 /* __package__ is set, so use it */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002979 if (!PyUnicode_Check(pkgname)) {
2980 PyErr_SetString(PyExc_ValueError,
2981 "__package__ set to non-string");
2982 return NULL;
2983 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002984 if (PyUnicode_GET_LENGTH(pkgname) == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002985 if (level > 0) {
2986 PyErr_SetString(PyExc_ValueError,
2987 "Attempted relative import in non-package");
2988 return NULL;
2989 }
Victor Stinner974389d2011-03-15 09:33:57 +01002990 goto return_none;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002991 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002992 Py_INCREF(pkgname);
2993 nameobj = pkgname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002994 } else {
2995 /* __package__ not set, so figure it out and set it */
2996 modname = PyDict_GetItem(globals, namestr);
2997 if (modname == NULL || !PyUnicode_Check(modname))
Victor Stinner974389d2011-03-15 09:33:57 +01002998 goto return_none;
Brett Cannon9a5b25a2010-03-01 02:09:17 +00002999
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003000 modpath = PyDict_GetItem(globals, pathstr);
3001 if (modpath != NULL) {
3002 /* __path__ is set, so modname is already the package name */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003003 int error;
Alexandre Vassalottia85998a2008-05-03 18:24:43 +00003004
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003005 error = PyDict_SetItem(globals, pkgstr, modname);
3006 if (error) {
3007 PyErr_SetString(PyExc_ValueError,
3008 "Could not set __package__");
3009 return NULL;
3010 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003011 Py_INCREF(modname);
3012 nameobj = modname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003013 } else {
3014 /* Normal module, so work out the package name if any */
Victor Stinner974389d2011-03-15 09:33:57 +01003015 Py_ssize_t len;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003016 len = PyUnicode_FindChar(modname, '.',
3017 0, PyUnicode_GET_LENGTH(modname), -1);
3018 if (len == -2)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003019 return NULL;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003020 if (len < 0) {
3021 if (level > 0) {
3022 PyErr_SetString(PyExc_ValueError,
3023 "Attempted relative import in non-package");
3024 return NULL;
3025 }
3026 if (PyDict_SetItem(globals, pkgstr, Py_None)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003027 PyErr_SetString(PyExc_ValueError,
3028 "Could not set __package__");
3029 return NULL;
3030 }
Victor Stinner974389d2011-03-15 09:33:57 +01003031 goto return_none;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003032 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003033 pkgname = PyUnicode_Substring(modname, 0, len);
3034 if (pkgname == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003035 return NULL;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003036 if (PyDict_SetItem(globals, pkgstr, pkgname)) {
3037 Py_DECREF(pkgname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003038 PyErr_SetString(PyExc_ValueError,
3039 "Could not set __package__");
3040 return NULL;
3041 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003042 nameobj = pkgname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003043 }
3044 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003045 if (level > 1) {
3046 Py_ssize_t dot, end = PyUnicode_GET_LENGTH(nameobj);
3047 PyObject *newname;
3048 while (--level > 0) {
3049 dot = PyUnicode_FindChar(nameobj, '.', 0, end, -1);
3050 if (dot == -2) {
3051 Py_DECREF(nameobj);
3052 return NULL;
3053 }
3054 if (dot < 0) {
3055 Py_DECREF(nameobj);
3056 PyErr_SetString(PyExc_ValueError,
3057 "Attempted relative import beyond "
3058 "toplevel package");
3059 return NULL;
3060 }
3061 end = dot;
3062 }
3063 newname = PyUnicode_Substring(nameobj, 0, end);
3064 Py_DECREF(nameobj);
3065 if (newname == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003066 return NULL;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003067 nameobj = newname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003068 }
Victor Stinner974389d2011-03-15 09:33:57 +01003069
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003070 modules = PyImport_GetModuleDict();
Victor Stinner974389d2011-03-15 09:33:57 +01003071 parent = PyDict_GetItem(modules, nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003072 if (parent == NULL) {
Victor Stinner974389d2011-03-15 09:33:57 +01003073 int err;
3074
3075 if (orig_level >= 1) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003076 PyErr_Format(PyExc_SystemError,
Victor Stinner974389d2011-03-15 09:33:57 +01003077 "Parent module %R not loaded, "
3078 "cannot perform relative import", nameobj);
3079 Py_DECREF(nameobj);
3080 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003081 }
Victor Stinner974389d2011-03-15 09:33:57 +01003082
3083 err = PyErr_WarnFormat(
3084 PyExc_RuntimeWarning, 1,
3085 "Parent module %R not found while handling absolute import",
3086 nameobj);
3087 Py_DECREF(nameobj);
3088 if (err)
3089 return NULL;
3090
3091 goto return_none;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003092 }
Victor Stinner974389d2011-03-15 09:33:57 +01003093 *p_name = nameobj;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003094 return parent;
3095 /* We expect, but can't guarantee, if parent != None, that:
Victor Stinner974389d2011-03-15 09:33:57 +01003096 - parent.__name__ == name
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003097 - parent.__dict__ is globals
3098 If this is violated... Who cares? */
Victor Stinner974389d2011-03-15 09:33:57 +01003099
3100return_none:
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003101 nameobj = PyUnicode_New(0, 0);
Victor Stinner974389d2011-03-15 09:33:57 +01003102 if (nameobj == NULL)
3103 return NULL;
3104 *p_name = nameobj;
3105 return Py_None;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003106}
3107
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003108/* altmod is either None or same as mod */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003109static PyObject *
Victor Stinner974389d2011-03-15 09:33:57 +01003110load_next(PyObject *mod, PyObject *altmod,
3111 PyObject *inputname, PyObject **p_outputname,
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003112 Py_UCS4 *buf, Py_ssize_t *p_buflen, Py_ssize_t bufsize)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003113{
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003114 Py_UCS4 *dot;
Victor Stinner974389d2011-03-15 09:33:57 +01003115 Py_ssize_t len;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003116 Py_UCS4 *p;
Victor Stinner974389d2011-03-15 09:33:57 +01003117 PyObject *fullname, *name, *result, *mark_name;
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003118 Py_UCS4 *nameuni;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003119
Victor Stinner974389d2011-03-15 09:33:57 +01003120 *p_outputname = NULL;
3121
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003122 if (PyUnicode_GET_LENGTH(inputname) == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003123 /* completely empty module name should only happen in
3124 'from . import' (or '__import__("")')*/
3125 Py_INCREF(mod);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003126 return mod;
3127 }
Thomas Woutersf7f438b2006-02-28 16:09:29 +00003128
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003129 nameuni = PyUnicode_AsUCS4Copy(inputname);
Victor Stinner974389d2011-03-15 09:33:57 +01003130 if (nameuni == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003131 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003132
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003133 dot = Py_UCS4_strchr(nameuni, '.');
Victor Stinner974389d2011-03-15 09:33:57 +01003134 if (dot != NULL) {
3135 len = dot - nameuni;
3136 if (len == 0) {
3137 PyErr_SetString(PyExc_ValueError,
3138 "Empty module name");
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003139 goto error;
Victor Stinner974389d2011-03-15 09:33:57 +01003140 }
3141 }
3142 else
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003143 len = PyUnicode_GET_LENGTH(inputname);
Victor Stinner974389d2011-03-15 09:33:57 +01003144
3145 if (*p_buflen+len+1 >= bufsize) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003146 PyErr_SetString(PyExc_ValueError,
3147 "Module name too long");
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003148 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003149 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003150
Victor Stinner974389d2011-03-15 09:33:57 +01003151 p = buf + *p_buflen;
3152 if (p != buf) {
3153 *p++ = '.';
3154 *p_buflen += 1;
3155 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003156 Py_UCS4_strncpy(p, nameuni, len);
Victor Stinner974389d2011-03-15 09:33:57 +01003157 p[len] = '\0';
3158 *p_buflen += len;
3159
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003160 fullname = PyUnicode_FromKindAndData(PyUnicode_4BYTE_KIND,
3161 buf, *p_buflen);
Victor Stinner974389d2011-03-15 09:33:57 +01003162 if (fullname == NULL)
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003163 goto error;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003164 name = PyUnicode_FromKindAndData(PyUnicode_4BYTE_KIND,
3165 p, len);
Victor Stinner974389d2011-03-15 09:33:57 +01003166 if (name == NULL) {
3167 Py_DECREF(fullname);
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003168 goto error;
Victor Stinner974389d2011-03-15 09:33:57 +01003169 }
3170 result = import_submodule(mod, name, fullname);
3171 Py_DECREF(fullname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003172 if (result == Py_None && altmod != mod) {
3173 Py_DECREF(result);
3174 /* Here, altmod must be None and mod must not be None */
Victor Stinner974389d2011-03-15 09:33:57 +01003175 result = import_submodule(altmod, name, name);
3176 Py_DECREF(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003177 if (result != NULL && result != Py_None) {
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003178 mark_name = PyUnicode_FromKindAndData(PyUnicode_4BYTE_KIND,
3179 buf, *p_buflen);
Victor Stinner974389d2011-03-15 09:33:57 +01003180 if (mark_name == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003181 Py_DECREF(result);
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003182 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003183 }
Victor Stinner974389d2011-03-15 09:33:57 +01003184 if (mark_miss(mark_name) != 0) {
3185 Py_DECREF(result);
3186 Py_DECREF(mark_name);
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003187 goto error;
Victor Stinner974389d2011-03-15 09:33:57 +01003188 }
3189 Py_DECREF(mark_name);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003190 Py_UCS4_strncpy(buf, nameuni, len);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003191 buf[len] = '\0';
3192 *p_buflen = len;
3193 }
3194 }
Victor Stinner974389d2011-03-15 09:33:57 +01003195 else
3196 Py_DECREF(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003197 if (result == NULL)
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003198 goto error;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003199
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003200 if (result == Py_None) {
3201 Py_DECREF(result);
3202 PyErr_Format(PyExc_ImportError,
Victor Stinner974389d2011-03-15 09:33:57 +01003203 "No module named %R", inputname);
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003204 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003205 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003206
Victor Stinner974389d2011-03-15 09:33:57 +01003207 if (dot != NULL) {
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003208 *p_outputname = PyUnicode_FromKindAndData(PyUnicode_4BYTE_KIND,
3209 dot+1, Py_UCS4_strlen(dot+1));
Victor Stinner974389d2011-03-15 09:33:57 +01003210 if (*p_outputname == NULL) {
3211 Py_DECREF(result);
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003212 goto error;
Victor Stinner974389d2011-03-15 09:33:57 +01003213 }
3214 }
3215
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003216 PyMem_Free(nameuni);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003217 return result;
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003218
3219error:
3220 PyMem_Free(nameuni);
3221 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003222}
3223
3224static int
Victor Stinner974389d2011-03-15 09:33:57 +01003225mark_miss(PyObject *name)
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00003226{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003227 PyObject *modules = PyImport_GetModuleDict();
Victor Stinner974389d2011-03-15 09:33:57 +01003228 return PyDict_SetItem(modules, name, Py_None);
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00003229}
3230
3231static int
Victor Stinner974389d2011-03-15 09:33:57 +01003232ensure_fromlist(PyObject *mod, PyObject *fromlist, PyObject *name,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003233 int recursive)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003234{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003235 int i;
Victor Stinner974389d2011-03-15 09:33:57 +01003236 PyObject *fullname;
3237 Py_ssize_t fromlist_len;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003238
Martin v. Löwis1ee1b6f2011-10-10 18:11:30 +02003239 if (!_PyObject_HasAttrId(mod, &PyId___path__))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003240 return 1;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003241
Victor Stinner974389d2011-03-15 09:33:57 +01003242 fromlist_len = PySequence_Size(fromlist);
3243
3244 for (i = 0; i < fromlist_len; i++) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003245 PyObject *item = PySequence_GetItem(fromlist, i);
3246 int hasit;
Victor Stinner974389d2011-03-15 09:33:57 +01003247 if (item == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003248 return 0;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003249 if (!PyUnicode_Check(item)) {
3250 PyErr_SetString(PyExc_TypeError,
3251 "Item in ``from list'' not a string");
3252 Py_DECREF(item);
3253 return 0;
3254 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003255 if (PyUnicode_READ_CHAR(item, 0) == '*') {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003256 PyObject *all;
Martin v. Löwisbd928fe2011-10-14 10:20:37 +02003257 _Py_IDENTIFIER(__all__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003258 Py_DECREF(item);
3259 /* See if the package defines __all__ */
3260 if (recursive)
3261 continue; /* Avoid endless recursion */
Martin v. Löwis1ee1b6f2011-10-10 18:11:30 +02003262 all = _PyObject_GetAttrId(mod, &PyId___all__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003263 if (all == NULL)
3264 PyErr_Clear();
3265 else {
Victor Stinner974389d2011-03-15 09:33:57 +01003266 int ret = ensure_fromlist(mod, all, name, 1);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003267 Py_DECREF(all);
3268 if (!ret)
3269 return 0;
3270 }
3271 continue;
3272 }
3273 hasit = PyObject_HasAttr(mod, item);
3274 if (!hasit) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003275 PyObject *submod;
Victor Stinner974389d2011-03-15 09:33:57 +01003276 fullname = PyUnicode_FromFormat("%U.%U", name, item);
3277 if (fullname != NULL) {
3278 submod = import_submodule(mod, item, fullname);
3279 Py_DECREF(fullname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003280 }
Victor Stinner974389d2011-03-15 09:33:57 +01003281 else
3282 submod = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003283 Py_XDECREF(submod);
3284 if (submod == NULL) {
3285 Py_DECREF(item);
3286 return 0;
3287 }
3288 }
3289 Py_DECREF(item);
3290 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003291
Victor Stinner974389d2011-03-15 09:33:57 +01003292 return 1;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003293}
3294
Neil Schemenauer00b09662003-06-16 21:03:07 +00003295static int
Victor Stinner974389d2011-03-15 09:33:57 +01003296add_submodule(PyObject *mod, PyObject *submod, PyObject *fullname,
3297 PyObject *subname, PyObject *modules)
Neil Schemenauer00b09662003-06-16 21:03:07 +00003298{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003299 if (mod == Py_None)
3300 return 1;
3301 /* Irrespective of the success of this load, make a
3302 reference to it in the parent package module. A copy gets
3303 saved in the modules dictionary under the full name, so get a
3304 reference from there, if need be. (The exception is when the
3305 load failed with a SyntaxError -- then there's no trace in
3306 sys.modules. In that case, of course, do nothing extra.) */
3307 if (submod == NULL) {
Victor Stinner974389d2011-03-15 09:33:57 +01003308 submod = PyDict_GetItem(modules, fullname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003309 if (submod == NULL)
3310 return 1;
3311 }
3312 if (PyModule_Check(mod)) {
3313 /* We can't use setattr here since it can give a
3314 * spurious warning if the submodule name shadows a
3315 * builtin name */
3316 PyObject *dict = PyModule_GetDict(mod);
3317 if (!dict)
3318 return 0;
Victor Stinner974389d2011-03-15 09:33:57 +01003319 if (PyDict_SetItem(dict, subname, submod) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003320 return 0;
3321 }
3322 else {
Victor Stinner974389d2011-03-15 09:33:57 +01003323 if (PyObject_SetAttr(mod, subname, submod) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003324 return 0;
3325 }
3326 return 1;
Neil Schemenauer00b09662003-06-16 21:03:07 +00003327}
3328
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003329static PyObject *
Victor Stinner974389d2011-03-15 09:33:57 +01003330import_submodule(PyObject *mod, PyObject *subname, PyObject *fullname)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003331{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003332 PyObject *modules = PyImport_GetModuleDict();
Victor Stinner533d7832011-03-14 13:22:54 -04003333 PyObject *m = NULL, *bufobj, *path_list, *loader;
Victor Stinner9599de52011-03-13 22:38:38 -04003334 struct filedescr *fdp;
3335 FILE *fp;
Guido van Rossum74e6a111994-08-29 12:54:38 +00003336
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003337 /* Require:
3338 if mod == None: subname == fullname
3339 else: mod.__name__ + "." + subname == fullname
3340 */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003341
Victor Stinner974389d2011-03-15 09:33:57 +01003342 if ((m = PyDict_GetItem(modules, fullname)) != NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003343 Py_INCREF(m);
Victor Stinner9599de52011-03-13 22:38:38 -04003344 return m;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003345 }
Victor Stinner9599de52011-03-13 22:38:38 -04003346
3347 if (mod == Py_None)
Victor Stinner533d7832011-03-14 13:22:54 -04003348 path_list = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003349 else {
Martin v. Löwis1ee1b6f2011-10-10 18:11:30 +02003350 path_list = _PyObject_GetAttrId(mod, &PyId___path__);
Victor Stinner533d7832011-03-14 13:22:54 -04003351 if (path_list == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003352 PyErr_Clear();
3353 Py_INCREF(Py_None);
3354 return Py_None;
3355 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003356 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003357
Victor Stinner533d7832011-03-14 13:22:54 -04003358 fdp = find_module(fullname, subname, path_list,
Victor Stinner2fd76e42011-03-14 15:19:39 -04003359 &bufobj, &fp, &loader);
Victor Stinner533d7832011-03-14 13:22:54 -04003360 Py_XDECREF(path_list);
Victor Stinner9599de52011-03-13 22:38:38 -04003361 if (fdp == NULL) {
3362 if (!PyErr_ExceptionMatches(PyExc_ImportError))
3363 return NULL;
3364 PyErr_Clear();
3365 Py_INCREF(Py_None);
3366 return Py_None;
3367 }
Victor Stinner2fd76e42011-03-14 15:19:39 -04003368 m = load_module(fullname, fp, bufobj, fdp->type, loader);
3369 Py_XDECREF(bufobj);
Victor Stinner9599de52011-03-13 22:38:38 -04003370 Py_XDECREF(loader);
3371 if (fp)
3372 fclose(fp);
3373 if (m == NULL)
3374 return NULL;
3375 if (!add_submodule(mod, m, fullname, subname, modules)) {
3376 Py_XDECREF(m);
3377 return NULL;
3378 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003379 return m;
Guido van Rossum74e6a111994-08-29 12:54:38 +00003380}
3381
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003382
3383/* Re-import a module of any kind and return its module object, WITH
3384 INCREMENTED REFERENCE COUNT */
3385
Guido van Rossum79f25d91997-04-29 20:08:16 +00003386PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003387PyImport_ReloadModule(PyObject *m)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003388{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003389 PyInterpreterState *interp = PyThreadState_Get()->interp;
3390 PyObject *modules_reloading = interp->modules_reloading;
3391 PyObject *modules = PyImport_GetModuleDict();
Victor Stinner533d7832011-03-14 13:22:54 -04003392 PyObject *path_list = NULL, *loader = NULL, *existing_m = NULL;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003393 PyObject *nameobj, *bufobj, *subnameobj;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003394 Py_UCS4 *name = NULL, *subname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003395 struct filedescr *fdp;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003396 FILE *fp = NULL;
3397 PyObject *newm = NULL;
Brett Cannon9a5b25a2010-03-01 02:09:17 +00003398
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003399 if (modules_reloading == NULL) {
3400 Py_FatalError("PyImport_ReloadModule: "
3401 "no modules_reloading dictionary!");
3402 return NULL;
3403 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003404
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003405 if (m == NULL || !PyModule_Check(m)) {
3406 PyErr_SetString(PyExc_TypeError,
3407 "reload() argument must be module");
3408 return NULL;
3409 }
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003410 nameobj = PyModule_GetNameObject(m);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003411 if (nameobj == NULL || PyUnicode_READY(nameobj) == -1)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003412 return NULL;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003413 if (m != PyDict_GetItem(modules, nameobj)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003414 PyErr_Format(PyExc_ImportError,
Victor Stinner98dbba52011-03-14 15:15:47 -04003415 "reload(): module %R not in sys.modules",
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003416 nameobj);
3417 Py_DECREF(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003418 return NULL;
3419 }
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003420 existing_m = PyDict_GetItem(modules_reloading, nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003421 if (existing_m != NULL) {
3422 /* Due to a recursive reload, this module is already
3423 being reloaded. */
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003424 Py_DECREF(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003425 Py_INCREF(existing_m);
3426 return existing_m;
3427 }
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003428 if (PyDict_SetItem(modules_reloading, nameobj, m) < 0) {
3429 Py_DECREF(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003430 return NULL;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003431 }
Guido van Rossumd8faa362007-04-27 19:54:29 +00003432
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003433 name = PyUnicode_AsUCS4Copy(nameobj);
3434 if (!name) {
3435 Py_DECREF(nameobj);
3436 return NULL;
3437 }
3438 subname = Py_UCS4_strrchr(name, '.');
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003439 if (subname == NULL) {
3440 Py_INCREF(nameobj);
3441 subnameobj = nameobj;
3442 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003443 else {
3444 PyObject *parentname, *parent;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003445 Py_ssize_t len;
3446 len = subname - name;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003447 parentname = PyUnicode_FromKindAndData(PyUnicode_4BYTE_KIND,
3448 name, len);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003449 if (parentname == NULL) {
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003450 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003451 }
3452 parent = PyDict_GetItem(modules, parentname);
3453 if (parent == NULL) {
3454 PyErr_Format(PyExc_ImportError,
Victor Stinner98dbba52011-03-14 15:15:47 -04003455 "reload(): parent %R not in sys.modules",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003456 parentname);
3457 Py_DECREF(parentname);
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003458 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003459 }
3460 Py_DECREF(parentname);
Martin v. Löwis1ee1b6f2011-10-10 18:11:30 +02003461 path_list = _PyObject_GetAttrId(parent, &PyId___path__);
Victor Stinner533d7832011-03-14 13:22:54 -04003462 if (path_list == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003463 PyErr_Clear();
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003464 subname++;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003465 len = PyUnicode_GET_LENGTH(nameobj) - (len + 1);
3466 subnameobj = PyUnicode_FromKindAndData(PyUnicode_4BYTE_KIND,
3467 subname, len);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003468 }
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003469 if (subnameobj == NULL)
3470 goto error;
Victor Stinner533d7832011-03-14 13:22:54 -04003471 fdp = find_module(nameobj, subnameobj, path_list,
Victor Stinner2fd76e42011-03-14 15:19:39 -04003472 &bufobj, &fp, &loader);
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003473 Py_DECREF(subnameobj);
Victor Stinner533d7832011-03-14 13:22:54 -04003474 Py_XDECREF(path_list);
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00003475
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003476 if (fdp == NULL) {
3477 Py_XDECREF(loader);
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003478 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003479 }
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00003480
Victor Stinner2fd76e42011-03-14 15:19:39 -04003481 newm = load_module(nameobj, fp, bufobj, fdp->type, loader);
3482 Py_XDECREF(bufobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003483 Py_XDECREF(loader);
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00003484
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003485 if (fp)
3486 fclose(fp);
3487 if (newm == NULL) {
3488 /* load_module probably removed name from modules because of
3489 * the error. Put back the original module object. We're
3490 * going to return NULL in this case regardless of whether
3491 * replacing name succeeds, so the return value is ignored.
3492 */
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003493 PyDict_SetItem(modules, nameobj, m);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003494 }
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003495
3496error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003497 imp_modules_reloading_clear();
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003498 Py_DECREF(nameobj);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003499 PyMem_Free(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003500 return newm;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003501}
3502
3503
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003504/* Higher-level import emulator which emulates the "import" statement
3505 more accurately -- it invokes the __import__() function from the
3506 builtins of the current globals. This means that the import is
3507 done using whatever import hooks are installed in the current
Brett Cannonbc2eff32010-09-19 21:39:02 +00003508 environment.
Guido van Rossum6058eb41998-12-21 19:51:00 +00003509 A dummy list ["__doc__"] is passed as the 4th argument so that
Neal Norwitz80e7f272007-08-26 06:45:23 +00003510 e.g. PyImport_Import(PyUnicode_FromString("win32com.client.gencache"))
Guido van Rossum6058eb41998-12-21 19:51:00 +00003511 will return <module "gencache"> instead of <module "win32com">. */
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003512
3513PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003514PyImport_Import(PyObject *module_name)
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003515{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003516 static PyObject *silly_list = NULL;
3517 static PyObject *builtins_str = NULL;
3518 static PyObject *import_str = NULL;
3519 PyObject *globals = NULL;
3520 PyObject *import = NULL;
3521 PyObject *builtins = NULL;
Brett Cannonbc2eff32010-09-19 21:39:02 +00003522 PyObject *modules = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003523 PyObject *r = NULL;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003524
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003525 /* Initialize constant string objects */
3526 if (silly_list == NULL) {
3527 import_str = PyUnicode_InternFromString("__import__");
3528 if (import_str == NULL)
3529 return NULL;
3530 builtins_str = PyUnicode_InternFromString("__builtins__");
3531 if (builtins_str == NULL)
3532 return NULL;
Brett Cannonbc2eff32010-09-19 21:39:02 +00003533 silly_list = PyList_New(0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003534 if (silly_list == NULL)
3535 return NULL;
3536 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003537
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003538 /* Get the builtins from current globals */
3539 globals = PyEval_GetGlobals();
3540 if (globals != NULL) {
3541 Py_INCREF(globals);
3542 builtins = PyObject_GetItem(globals, builtins_str);
3543 if (builtins == NULL)
3544 goto err;
3545 }
3546 else {
3547 /* No globals -- use standard builtins, and fake globals */
3548 builtins = PyImport_ImportModuleLevel("builtins",
3549 NULL, NULL, NULL, 0);
3550 if (builtins == NULL)
3551 return NULL;
3552 globals = Py_BuildValue("{OO}", builtins_str, builtins);
3553 if (globals == NULL)
3554 goto err;
3555 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003556
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003557 /* Get the __import__ function from the builtins */
3558 if (PyDict_Check(builtins)) {
3559 import = PyObject_GetItem(builtins, import_str);
3560 if (import == NULL)
3561 PyErr_SetObject(PyExc_KeyError, import_str);
3562 }
3563 else
3564 import = PyObject_GetAttr(builtins, import_str);
3565 if (import == NULL)
3566 goto err;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003567
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003568 /* Call the __import__ function with the proper argument list
Brett Cannonbc2eff32010-09-19 21:39:02 +00003569 Always use absolute import here.
3570 Calling for side-effect of import. */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003571 r = PyObject_CallFunction(import, "OOOOi", module_name, globals,
3572 globals, silly_list, 0, NULL);
Brett Cannonbc2eff32010-09-19 21:39:02 +00003573 if (r == NULL)
3574 goto err;
3575 Py_DECREF(r);
3576
3577 modules = PyImport_GetModuleDict();
3578 r = PyDict_GetItem(modules, module_name);
3579 if (r != NULL)
3580 Py_INCREF(r);
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003581
3582 err:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003583 Py_XDECREF(globals);
3584 Py_XDECREF(builtins);
3585 Py_XDECREF(import);
Tim Peters50d8d372001-02-28 05:34:27 +00003586
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003587 return r;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003588}
3589
3590
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003591/* Module 'imp' provides Python access to the primitives used for
3592 importing modules.
3593*/
3594
Guido van Rossum79f25d91997-04-29 20:08:16 +00003595static PyObject *
Barry Warsaw28a691b2010-04-17 00:19:56 +00003596imp_make_magic(long magic)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003597{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003598 char buf[4];
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003599
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003600 buf[0] = (char) ((magic >> 0) & 0xff);
3601 buf[1] = (char) ((magic >> 8) & 0xff);
3602 buf[2] = (char) ((magic >> 16) & 0xff);
3603 buf[3] = (char) ((magic >> 24) & 0xff);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003604
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003605 return PyBytes_FromStringAndSize(buf, 4);
Victor Stinner3e2b7172010-11-09 09:32:19 +00003606}
Barry Warsaw28a691b2010-04-17 00:19:56 +00003607
3608static PyObject *
3609imp_get_magic(PyObject *self, PyObject *noargs)
3610{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003611 return imp_make_magic(pyc_magic);
Barry Warsaw28a691b2010-04-17 00:19:56 +00003612}
3613
3614static PyObject *
3615imp_get_tag(PyObject *self, PyObject *noargs)
3616{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003617 return PyUnicode_FromString(pyc_tag);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003618}
3619
Guido van Rossum79f25d91997-04-29 20:08:16 +00003620static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +00003621imp_get_suffixes(PyObject *self, PyObject *noargs)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003622{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003623 PyObject *list;
3624 struct filedescr *fdp;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003625
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003626 list = PyList_New(0);
3627 if (list == NULL)
3628 return NULL;
3629 for (fdp = _PyImport_Filetab; fdp->suffix != NULL; fdp++) {
3630 PyObject *item = Py_BuildValue("ssi",
3631 fdp->suffix, fdp->mode, fdp->type);
3632 if (item == NULL) {
3633 Py_DECREF(list);
3634 return NULL;
3635 }
3636 if (PyList_Append(list, item) < 0) {
3637 Py_DECREF(list);
3638 Py_DECREF(item);
3639 return NULL;
3640 }
3641 Py_DECREF(item);
3642 }
3643 return list;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003644}
3645
Guido van Rossum79f25d91997-04-29 20:08:16 +00003646static PyObject *
Victor Stinner533d7832011-03-14 13:22:54 -04003647call_find_module(PyObject *name, PyObject *path_list)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003648{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003649 extern int fclose(FILE *);
3650 PyObject *fob, *ret;
3651 PyObject *pathobj;
3652 struct filedescr *fdp;
Victor Stinner7d8b77c2011-03-12 08:45:02 -05003653 FILE *fp;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003654 int fd = -1;
3655 char *found_encoding = NULL;
3656 char *encoding = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003657
Victor Stinner533d7832011-03-14 13:22:54 -04003658 if (path_list == Py_None)
3659 path_list = NULL;
3660 fdp = find_module(NULL, name, path_list,
Victor Stinner2fd76e42011-03-14 15:19:39 -04003661 &pathobj, &fp, NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003662 if (fdp == NULL)
3663 return NULL;
3664 if (fp != NULL) {
3665 fd = fileno(fp);
3666 if (fd != -1)
3667 fd = dup(fd);
3668 fclose(fp);
Victor Stinnerd417d012011-06-20 15:16:55 +02003669 if (fd == -1) {
3670 PyErr_SetFromErrno(PyExc_OSError);
3671 return NULL;
3672 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003673 fp = NULL;
3674 }
3675 if (fd != -1) {
3676 if (strchr(fdp->mode, 'b') == NULL) {
Victor Stinnerfe7c5b52011-04-05 01:48:03 +02003677 /* PyTokenizer_FindEncodingFilename() returns PyMem_MALLOC'ed
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003678 memory. */
Victor Stinnerfe7c5b52011-04-05 01:48:03 +02003679 found_encoding = PyTokenizer_FindEncodingFilename(fd, pathobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003680 lseek(fd, 0, 0); /* Reset position */
Victor Stinner2fd76e42011-03-14 15:19:39 -04003681 if (found_encoding == NULL && PyErr_Occurred()) {
3682 Py_XDECREF(pathobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003683 return NULL;
Victor Stinner2fd76e42011-03-14 15:19:39 -04003684 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003685 encoding = (found_encoding != NULL) ? found_encoding :
3686 (char*)PyUnicode_GetDefaultEncoding();
3687 }
Victor Stinner2fd76e42011-03-14 15:19:39 -04003688 fob = PyFile_FromFd(fd, NULL, fdp->mode, -1,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003689 (char*)encoding, NULL, NULL, 1);
3690 if (fob == NULL) {
Victor Stinner2fd76e42011-03-14 15:19:39 -04003691 Py_XDECREF(pathobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003692 close(fd);
3693 PyMem_FREE(found_encoding);
3694 return NULL;
3695 }
3696 }
3697 else {
3698 fob = Py_None;
3699 Py_INCREF(fob);
3700 }
Victor Stinner2fd76e42011-03-14 15:19:39 -04003701 if (pathobj == NULL) {
3702 Py_INCREF(Py_None);
3703 pathobj = Py_None;
3704 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003705 ret = Py_BuildValue("NN(ssi)",
3706 fob, pathobj, fdp->suffix, fdp->mode, fdp->type);
3707 PyMem_FREE(found_encoding);
Brett Cannon3bb42d92007-10-20 03:43:15 +00003708
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003709 return ret;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003710}
3711
Guido van Rossum79f25d91997-04-29 20:08:16 +00003712static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003713imp_find_module(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003714{
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003715 PyObject *name, *path_list = NULL;
3716 if (!PyArg_ParseTuple(args, "U|O:find_module",
3717 &name, &path_list))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003718 return NULL;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003719 return call_find_module(name, path_list);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003720}
3721
3722static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003723imp_init_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003724{
Victor Stinner95872862011-03-07 18:20:56 +01003725 PyObject *name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003726 int ret;
3727 PyObject *m;
Victor Stinner95872862011-03-07 18:20:56 +01003728 if (!PyArg_ParseTuple(args, "U:init_builtin", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003729 return NULL;
3730 ret = init_builtin(name);
3731 if (ret < 0)
3732 return NULL;
3733 if (ret == 0) {
3734 Py_INCREF(Py_None);
3735 return Py_None;
3736 }
Victor Stinner95872862011-03-07 18:20:56 +01003737 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003738 Py_XINCREF(m);
3739 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003740}
3741
Guido van Rossum79f25d91997-04-29 20:08:16 +00003742static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003743imp_init_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003744{
Victor Stinner53dc7352011-03-20 01:50:21 +01003745 PyObject *name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003746 int ret;
3747 PyObject *m;
Victor Stinner53dc7352011-03-20 01:50:21 +01003748 if (!PyArg_ParseTuple(args, "U:init_frozen", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003749 return NULL;
Victor Stinner53dc7352011-03-20 01:50:21 +01003750 ret = PyImport_ImportFrozenModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003751 if (ret < 0)
3752 return NULL;
3753 if (ret == 0) {
3754 Py_INCREF(Py_None);
3755 return Py_None;
3756 }
Victor Stinner53dc7352011-03-20 01:50:21 +01003757 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003758 Py_XINCREF(m);
3759 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003760}
3761
Guido van Rossum79f25d91997-04-29 20:08:16 +00003762static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003763imp_get_frozen_object(PyObject *self, PyObject *args)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00003764{
Victor Stinner53dc7352011-03-20 01:50:21 +01003765 PyObject *name;
Jack Jansen95ffa231995-10-03 14:38:41 +00003766
Victor Stinner53dc7352011-03-20 01:50:21 +01003767 if (!PyArg_ParseTuple(args, "U:get_frozen_object", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003768 return NULL;
3769 return get_frozen_object(name);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00003770}
3771
Guido van Rossum79f25d91997-04-29 20:08:16 +00003772static PyObject *
Brett Cannon8d110132009-03-15 02:20:16 +00003773imp_is_frozen_package(PyObject *self, PyObject *args)
3774{
Victor Stinner53dc7352011-03-20 01:50:21 +01003775 PyObject *name;
Brett Cannon8d110132009-03-15 02:20:16 +00003776
Victor Stinner53dc7352011-03-20 01:50:21 +01003777 if (!PyArg_ParseTuple(args, "U:is_frozen_package", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003778 return NULL;
3779 return is_frozen_package(name);
Brett Cannon8d110132009-03-15 02:20:16 +00003780}
3781
3782static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003783imp_is_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003784{
Victor Stinner95872862011-03-07 18:20:56 +01003785 PyObject *name;
3786 if (!PyArg_ParseTuple(args, "U:is_builtin", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003787 return NULL;
3788 return PyLong_FromLong(is_builtin(name));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003789}
3790
Guido van Rossum79f25d91997-04-29 20:08:16 +00003791static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003792imp_is_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003793{
Victor Stinner53dc7352011-03-20 01:50:21 +01003794 PyObject *name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003795 struct _frozen *p;
Victor Stinner53dc7352011-03-20 01:50:21 +01003796 if (!PyArg_ParseTuple(args, "U:is_frozen", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003797 return NULL;
3798 p = find_frozen(name);
3799 return PyBool_FromLong((long) (p == NULL ? 0 : p->size));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003800}
3801
3802static FILE *
Victor Stinner2f42ae52011-03-20 00:41:24 +01003803get_file(PyObject *pathname, PyObject *fob, char *mode)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003804{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003805 FILE *fp;
3806 if (mode[0] == 'U')
3807 mode = "r" PY_STDIOTEXTMODE;
3808 if (fob == NULL) {
Victor Stinner2f42ae52011-03-20 00:41:24 +01003809 fp = _Py_fopen(pathname, mode);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003810 }
3811 else {
3812 int fd = PyObject_AsFileDescriptor(fob);
3813 if (fd == -1)
3814 return NULL;
3815 if (!_PyVerify_fd(fd))
3816 goto error;
3817 /* the FILE struct gets a new fd, so that it can be closed
3818 * independently of the file descriptor given
3819 */
3820 fd = dup(fd);
3821 if (fd == -1)
3822 goto error;
3823 fp = fdopen(fd, mode);
3824 }
3825 if (fp)
3826 return fp;
Kristján Valur Jónssone1b04452009-03-31 17:43:39 +00003827error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003828 PyErr_SetFromErrno(PyExc_IOError);
3829 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003830}
3831
Guido van Rossum79f25d91997-04-29 20:08:16 +00003832static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003833imp_load_compiled(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003834{
Victor Stinner2f42ae52011-03-20 00:41:24 +01003835 PyObject *name, *pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003836 PyObject *fob = NULL;
3837 PyObject *m;
3838 FILE *fp;
Victor Stinner2f42ae52011-03-20 00:41:24 +01003839 if (!PyArg_ParseTuple(args, "UO&|O:load_compiled",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003840 &name,
Victor Stinner2f42ae52011-03-20 00:41:24 +01003841 PyUnicode_FSDecoder, &pathname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003842 &fob))
3843 return NULL;
Victor Stinner2f42ae52011-03-20 00:41:24 +01003844 fp = get_file(pathname, fob, "rb");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003845 if (fp == NULL) {
Victor Stinnerebc00522010-12-03 17:06:43 +00003846 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003847 return NULL;
3848 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01003849 m = load_compiled_module(name, pathname, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003850 fclose(fp);
Victor Stinnerebc00522010-12-03 17:06:43 +00003851 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003852 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003853}
3854
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003855#ifdef HAVE_DYNAMIC_LOADING
3856
Guido van Rossum79f25d91997-04-29 20:08:16 +00003857static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003858imp_load_dynamic(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003859{
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003860 PyObject *name, *pathname, *fob = NULL, *mod;
3861 FILE *fp;
3862
3863 if (!PyArg_ParseTuple(args, "UO&|O:load_dynamic",
3864 &name, PyUnicode_FSDecoder, &pathname, &fob))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003865 return NULL;
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003866 if (fob != NULL) {
3867 fp = get_file(NULL, fob, "r");
Victor Stinnere9ddbf62011-03-22 10:46:35 +01003868 if (fp == NULL) {
3869 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003870 return NULL;
Victor Stinnere9ddbf62011-03-22 10:46:35 +01003871 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003872 }
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003873 else
3874 fp = NULL;
3875 mod = _PyImport_LoadDynamicModule(name, pathname, fp);
Victor Stinnere9ddbf62011-03-22 10:46:35 +01003876 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003877 if (fp)
3878 fclose(fp);
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003879 return mod;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003880}
3881
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003882#endif /* HAVE_DYNAMIC_LOADING */
3883
Guido van Rossum79f25d91997-04-29 20:08:16 +00003884static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003885imp_load_source(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003886{
Victor Stinner2f42ae52011-03-20 00:41:24 +01003887 PyObject *name, *pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003888 PyObject *fob = NULL;
3889 PyObject *m;
3890 FILE *fp;
Victor Stinner2f42ae52011-03-20 00:41:24 +01003891 if (!PyArg_ParseTuple(args, "UO&|O:load_source",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003892 &name,
Victor Stinner2f42ae52011-03-20 00:41:24 +01003893 PyUnicode_FSDecoder, &pathname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003894 &fob))
3895 return NULL;
Victor Stinner2f42ae52011-03-20 00:41:24 +01003896 fp = get_file(pathname, fob, "r");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003897 if (fp == NULL) {
Victor Stinnerebc00522010-12-03 17:06:43 +00003898 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003899 return NULL;
3900 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01003901 m = load_source_module(name, pathname, fp);
Victor Stinnerebc00522010-12-03 17:06:43 +00003902 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003903 fclose(fp);
3904 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003905}
3906
Guido van Rossum79f25d91997-04-29 20:08:16 +00003907static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003908imp_load_module(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003909{
Victor Stinner6ae1e7f2011-03-20 22:37:17 +01003910 PyObject *name, *fob, *pathname, *pathname_obj, *ret;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003911 char *suffix; /* Unused */
3912 char *mode;
3913 int type;
3914 FILE *fp;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003915
Victor Stinner6ae1e7f2011-03-20 22:37:17 +01003916 if (!PyArg_ParseTuple(args, "UOO(ssi):load_module",
3917 &name, &fob, &pathname_obj, &suffix, &mode, &type))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003918 return NULL;
Victor Stinner6ae1e7f2011-03-20 22:37:17 +01003919 if (pathname_obj != Py_None) {
3920 if (!PyUnicode_FSDecoder(pathname_obj, &pathname))
3921 return NULL;
3922 }
3923 else
3924 pathname = NULL;
3925
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003926 if (*mode) {
3927 /* Mode must start with 'r' or 'U' and must not contain '+'.
3928 Implicit in this test is the assumption that the mode
3929 may contain other modifiers like 'b' or 't'. */
Guido van Rossum5e2c5fa2002-05-30 17:33:07 +00003930
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003931 if (!(*mode == 'r' || *mode == 'U') || strchr(mode, '+')) {
3932 PyErr_Format(PyExc_ValueError,
3933 "invalid file open mode %.200s", mode);
Victor Stinner6ae1e7f2011-03-20 22:37:17 +01003934 Py_XDECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003935 return NULL;
3936 }
3937 }
3938 if (fob == Py_None)
3939 fp = NULL;
3940 else {
3941 fp = get_file(NULL, fob, mode);
3942 if (fp == NULL) {
Victor Stinner6ae1e7f2011-03-20 22:37:17 +01003943 Py_XDECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003944 return NULL;
3945 }
3946 }
Victor Stinner41c5fec2011-03-13 21:46:30 -04003947 ret = load_module(name, fp, pathname, type, NULL);
Victor Stinner6ae1e7f2011-03-20 22:37:17 +01003948 Py_XDECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003949 if (fp)
3950 fclose(fp);
3951 return ret;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003952}
3953
3954static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003955imp_load_package(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003956{
Victor Stinnerc9abda02011-03-14 13:33:46 -04003957 PyObject *name, *pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003958 PyObject * ret;
Victor Stinnerc9abda02011-03-14 13:33:46 -04003959 if (!PyArg_ParseTuple(args, "UO&:load_package",
3960 &name, PyUnicode_FSDecoder, &pathname))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003961 return NULL;
Victor Stinnerc9abda02011-03-14 13:33:46 -04003962 ret = load_package(name, pathname);
Victor Stinnerebc00522010-12-03 17:06:43 +00003963 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003964 return ret;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003965}
3966
3967static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003968imp_new_module(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003969{
Victor Stinnerfe19d212011-03-14 14:53:28 -04003970 PyObject *name;
3971 if (!PyArg_ParseTuple(args, "U:new_module", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003972 return NULL;
Victor Stinnerfe19d212011-03-14 14:53:28 -04003973 return PyModule_NewObject(name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003974}
3975
Christian Heimes13a7a212008-01-07 17:13:09 +00003976static PyObject *
3977imp_reload(PyObject *self, PyObject *v)
3978{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003979 return PyImport_ReloadModule(v);
Christian Heimes13a7a212008-01-07 17:13:09 +00003980}
3981
3982PyDoc_STRVAR(doc_reload,
3983"reload(module) -> module\n\
3984\n\
3985Reload the module. The module must have been successfully imported before.");
3986
Barry Warsaw28a691b2010-04-17 00:19:56 +00003987static PyObject *
3988imp_cache_from_source(PyObject *self, PyObject *args, PyObject *kws)
3989{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003990 static char *kwlist[] = {"path", "debug_override", NULL};
Barry Warsaw28a691b2010-04-17 00:19:56 +00003991
Victor Stinner2f42ae52011-03-20 00:41:24 +01003992 PyObject *pathname, *cpathname;
Benjamin Peterson294a9fc2010-10-16 03:12:39 +00003993 PyObject *debug_override = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003994 int debug = !Py_OptimizeFlag;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003995
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003996 if (!PyArg_ParseTupleAndKeywords(
Victor Stinner3ea23dd2010-10-15 20:34:32 +00003997 args, kws, "O&|O", kwlist,
Victor Stinner2f42ae52011-03-20 00:41:24 +01003998 PyUnicode_FSDecoder, &pathname, &debug_override))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003999 return NULL;
Barry Warsaw28a691b2010-04-17 00:19:56 +00004000
Benjamin Peterson294a9fc2010-10-16 03:12:39 +00004001 if (debug_override != NULL &&
4002 (debug = PyObject_IsTrue(debug_override)) < 0) {
Victor Stinner2f42ae52011-03-20 00:41:24 +01004003 Py_DECREF(pathname);
Benjamin Peterson294a9fc2010-10-16 03:12:39 +00004004 return NULL;
4005 }
Barry Warsaw28a691b2010-04-17 00:19:56 +00004006
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02004007 cpathname = make_compiled_pathname(pathname, debug);
Victor Stinner2f42ae52011-03-20 00:41:24 +01004008 Py_DECREF(pathname);
Barry Warsaw28a691b2010-04-17 00:19:56 +00004009
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004010 if (cpathname == NULL) {
4011 PyErr_Format(PyExc_SystemError, "path buffer too short");
4012 return NULL;
4013 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01004014 return cpathname;
Barry Warsaw28a691b2010-04-17 00:19:56 +00004015}
4016
4017PyDoc_STRVAR(doc_cache_from_source,
4018"Given the path to a .py file, return the path to its .pyc/.pyo file.\n\
4019\n\
4020The .py file does not need to exist; this simply returns the path to the\n\
4021.pyc/.pyo file calculated as if the .py file were imported. The extension\n\
4022will be .pyc unless __debug__ is not defined, then it will be .pyo.\n\
4023\n\
4024If debug_override is not None, then it must be a boolean and is taken as\n\
4025the value of __debug__ instead.");
4026
4027static PyObject *
4028imp_source_from_cache(PyObject *self, PyObject *args, PyObject *kws)
4029{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004030 static char *kwlist[] = {"path", NULL};
Victor Stinnerc9abda02011-03-14 13:33:46 -04004031 PyObject *pathname, *source;
Barry Warsaw28a691b2010-04-17 00:19:56 +00004032
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004033 if (!PyArg_ParseTupleAndKeywords(
Victor Stinnerebc00522010-12-03 17:06:43 +00004034 args, kws, "O&", kwlist,
Victor Stinnerc9abda02011-03-14 13:33:46 -04004035 PyUnicode_FSDecoder, &pathname))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004036 return NULL;
Barry Warsaw28a691b2010-04-17 00:19:56 +00004037
Victor Stinnerc9abda02011-03-14 13:33:46 -04004038 source = make_source_pathname(pathname);
4039 if (source == NULL) {
4040 PyErr_Format(PyExc_ValueError, "Not a PEP 3147 pyc path: %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004041 pathname);
Victor Stinnerc9abda02011-03-14 13:33:46 -04004042 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004043 return NULL;
4044 }
Victor Stinnerc9abda02011-03-14 13:33:46 -04004045 Py_DECREF(pathname);
4046 return source;
Barry Warsaw28a691b2010-04-17 00:19:56 +00004047}
4048
4049PyDoc_STRVAR(doc_source_from_cache,
4050"Given the path to a .pyc./.pyo file, return the path to its .py file.\n\
4051\n\
4052The .pyc/.pyo file does not need to exist; this simply returns the path to\n\
4053the .py file calculated to correspond to the .pyc/.pyo file. If path\n\
4054does not conform to PEP 3147 format, ValueError will be raised.");
4055
Guido van Rossum0207e6d1997-09-09 22:04:42 +00004056/* Doc strings */
4057
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004058PyDoc_STRVAR(doc_imp,
4059"This module provides the components needed to build your own\n\
4060__import__ function. Undocumented functions are obsolete.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00004061
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004062PyDoc_STRVAR(doc_find_module,
4063"find_module(name, [path]) -> (file, filename, (suffix, mode, type))\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00004064Search for a module. If path is omitted or None, search for a\n\
4065built-in, frozen or special module and continue search in sys.path.\n\
4066The module name cannot contain '.'; to search for a submodule of a\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004067package, pass the submodule name and the package's __path__.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00004068
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004069PyDoc_STRVAR(doc_load_module,
4070"load_module(name, file, filename, (suffix, mode, type)) -> module\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00004071Load a module, given information returned by find_module().\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004072The module name must include the full package name, if any.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00004073
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004074PyDoc_STRVAR(doc_get_magic,
4075"get_magic() -> string\n\
4076Return the magic number for .pyc or .pyo files.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00004077
Barry Warsaw28a691b2010-04-17 00:19:56 +00004078PyDoc_STRVAR(doc_get_tag,
4079"get_tag() -> string\n\
4080Return the magic tag for .pyc or .pyo files.");
4081
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004082PyDoc_STRVAR(doc_get_suffixes,
4083"get_suffixes() -> [(suffix, mode, type), ...]\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00004084Return a list of (suffix, mode, type) tuples describing the files\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004085that find_module() looks for.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00004086
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004087PyDoc_STRVAR(doc_new_module,
4088"new_module(name) -> module\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00004089Create a new module. Do not enter it in sys.modules.\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004090The module name must include the full package name, if any.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00004091
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004092PyDoc_STRVAR(doc_lock_held,
Tim Petersa7c65092004-08-01 23:26:05 +00004093"lock_held() -> boolean\n\
4094Return True if the import lock is currently held, else False.\n\
4095On platforms without threads, return False.");
Tim Peters69232342001-08-30 05:16:13 +00004096
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00004097PyDoc_STRVAR(doc_acquire_lock,
4098"acquire_lock() -> None\n\
Neal Norwitz2294c0d2003-02-12 23:02:21 +00004099Acquires the interpreter's import lock for the current thread.\n\
4100This lock should be used by import hooks to ensure thread-safety\n\
4101when importing modules.\n\
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00004102On platforms without threads, this function does nothing.");
4103
4104PyDoc_STRVAR(doc_release_lock,
4105"release_lock() -> None\n\
4106Release the interpreter's import lock.\n\
4107On platforms without threads, this function does nothing.");
4108
Guido van Rossum79f25d91997-04-29 20:08:16 +00004109static PyMethodDef imp_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004110 {"find_module", imp_find_module, METH_VARARGS, doc_find_module},
4111 {"get_magic", imp_get_magic, METH_NOARGS, doc_get_magic},
4112 {"get_tag", imp_get_tag, METH_NOARGS, doc_get_tag},
4113 {"get_suffixes", imp_get_suffixes, METH_NOARGS, doc_get_suffixes},
4114 {"load_module", imp_load_module, METH_VARARGS, doc_load_module},
4115 {"new_module", imp_new_module, METH_VARARGS, doc_new_module},
4116 {"lock_held", imp_lock_held, METH_NOARGS, doc_lock_held},
4117 {"acquire_lock", imp_acquire_lock, METH_NOARGS, doc_acquire_lock},
4118 {"release_lock", imp_release_lock, METH_NOARGS, doc_release_lock},
4119 {"reload", imp_reload, METH_O, doc_reload},
4120 {"cache_from_source", (PyCFunction)imp_cache_from_source,
4121 METH_VARARGS | METH_KEYWORDS, doc_cache_from_source},
4122 {"source_from_cache", (PyCFunction)imp_source_from_cache,
4123 METH_VARARGS | METH_KEYWORDS, doc_source_from_cache},
4124 /* The rest are obsolete */
4125 {"get_frozen_object", imp_get_frozen_object, METH_VARARGS},
4126 {"is_frozen_package", imp_is_frozen_package, METH_VARARGS},
4127 {"init_builtin", imp_init_builtin, METH_VARARGS},
4128 {"init_frozen", imp_init_frozen, METH_VARARGS},
4129 {"is_builtin", imp_is_builtin, METH_VARARGS},
4130 {"is_frozen", imp_is_frozen, METH_VARARGS},
4131 {"load_compiled", imp_load_compiled, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00004132#ifdef HAVE_DYNAMIC_LOADING
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004133 {"load_dynamic", imp_load_dynamic, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00004134#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004135 {"load_package", imp_load_package, METH_VARARGS},
4136 {"load_source", imp_load_source, METH_VARARGS},
Brett Cannon442c9b92011-03-23 16:14:42 -07004137 {"_fix_co_filename", imp_fix_co_filename, METH_VARARGS},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004138 {NULL, NULL} /* sentinel */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004139};
4140
Guido van Rossum1a8791e1998-08-04 22:46:29 +00004141static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00004142setint(PyObject *d, char *name, int value)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00004143{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004144 PyObject *v;
4145 int err;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00004146
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004147 v = PyLong_FromLong((long)value);
4148 err = PyDict_SetItemString(d, name, v);
4149 Py_XDECREF(v);
4150 return err;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00004151}
4152
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004153typedef struct {
4154 PyObject_HEAD
4155} NullImporter;
4156
4157static int
4158NullImporter_init(NullImporter *self, PyObject *args, PyObject *kwds)
4159{
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004160#ifndef MS_WINDOWS
4161 PyObject *path;
4162 struct stat statbuf;
4163 int rv;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004164
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004165 if (!_PyArg_NoKeywords("NullImporter()", kwds))
4166 return -1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004167
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004168 if (!PyArg_ParseTuple(args, "O&:NullImporter",
4169 PyUnicode_FSConverter, &path))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004170 return -1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004171
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004172 if (PyBytes_GET_SIZE(path) == 0) {
4173 Py_DECREF(path);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004174 PyErr_SetString(PyExc_ImportError, "empty pathname");
4175 return -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004176 }
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004177
4178 rv = stat(PyBytes_AS_STRING(path), &statbuf);
4179 Py_DECREF(path);
4180 if (rv == 0) {
4181 /* it exists */
4182 if (S_ISDIR(statbuf.st_mode)) {
4183 /* it's a directory */
4184 PyErr_SetString(PyExc_ImportError, "existing directory");
4185 return -1;
4186 }
4187 }
4188#else /* MS_WINDOWS */
4189 PyObject *pathobj;
4190 DWORD rv;
Victor Stinner255dfdb2010-09-29 10:28:51 +00004191 wchar_t *path;
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004192
4193 if (!_PyArg_NoKeywords("NullImporter()", kwds))
4194 return -1;
4195
4196 if (!PyArg_ParseTuple(args, "U:NullImporter",
4197 &pathobj))
4198 return -1;
4199
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02004200 if (PyUnicode_GET_LENGTH(pathobj) == 0) {
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004201 PyErr_SetString(PyExc_ImportError, "empty pathname");
4202 return -1;
4203 }
4204
Victor Stinnerbeb4135b2010-10-07 01:02:42 +00004205 path = PyUnicode_AsWideCharString(pathobj, NULL);
Victor Stinner255dfdb2010-09-29 10:28:51 +00004206 if (path == NULL)
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004207 return -1;
4208 /* see issue1293 and issue3677:
4209 * stat() on Windows doesn't recognise paths like
4210 * "e:\\shared\\" and "\\\\whiterab-c2znlh\\shared" as dirs.
4211 */
4212 rv = GetFileAttributesW(path);
Victor Stinner255dfdb2010-09-29 10:28:51 +00004213 PyMem_Free(path);
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004214 if (rv != INVALID_FILE_ATTRIBUTES) {
4215 /* it exists */
4216 if (rv & FILE_ATTRIBUTE_DIRECTORY) {
4217 /* it's a directory */
4218 PyErr_SetString(PyExc_ImportError, "existing directory");
4219 return -1;
4220 }
4221 }
4222#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004223 return 0;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004224}
4225
4226static PyObject *
4227NullImporter_find_module(NullImporter *self, PyObject *args)
4228{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004229 Py_RETURN_NONE;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004230}
4231
4232static PyMethodDef NullImporter_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004233 {"find_module", (PyCFunction)NullImporter_find_module, METH_VARARGS,
4234 "Always return None"
4235 },
4236 {NULL} /* Sentinel */
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004237};
4238
4239
Christian Heimes9cd17752007-11-18 19:35:23 +00004240PyTypeObject PyNullImporter_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004241 PyVarObject_HEAD_INIT(NULL, 0)
4242 "imp.NullImporter", /*tp_name*/
4243 sizeof(NullImporter), /*tp_basicsize*/
4244 0, /*tp_itemsize*/
4245 0, /*tp_dealloc*/
4246 0, /*tp_print*/
4247 0, /*tp_getattr*/
4248 0, /*tp_setattr*/
4249 0, /*tp_reserved*/
4250 0, /*tp_repr*/
4251 0, /*tp_as_number*/
4252 0, /*tp_as_sequence*/
4253 0, /*tp_as_mapping*/
4254 0, /*tp_hash */
4255 0, /*tp_call*/
4256 0, /*tp_str*/
4257 0, /*tp_getattro*/
4258 0, /*tp_setattro*/
4259 0, /*tp_as_buffer*/
4260 Py_TPFLAGS_DEFAULT, /*tp_flags*/
4261 "Null importer object", /* tp_doc */
4262 0, /* tp_traverse */
4263 0, /* tp_clear */
4264 0, /* tp_richcompare */
4265 0, /* tp_weaklistoffset */
4266 0, /* tp_iter */
4267 0, /* tp_iternext */
4268 NullImporter_methods, /* tp_methods */
4269 0, /* tp_members */
4270 0, /* tp_getset */
4271 0, /* tp_base */
4272 0, /* tp_dict */
4273 0, /* tp_descr_get */
4274 0, /* tp_descr_set */
4275 0, /* tp_dictoffset */
4276 (initproc)NullImporter_init, /* tp_init */
4277 0, /* tp_alloc */
4278 PyType_GenericNew /* tp_new */
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004279};
4280
Martin v. Löwis1a214512008-06-11 05:26:20 +00004281static struct PyModuleDef impmodule = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004282 PyModuleDef_HEAD_INIT,
4283 "imp",
4284 doc_imp,
4285 0,
4286 imp_methods,
4287 NULL,
4288 NULL,
4289 NULL,
4290 NULL
Martin v. Löwis1a214512008-06-11 05:26:20 +00004291};
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004292
Jason Tishler6bc06ec2003-09-04 11:59:50 +00004293PyMODINIT_FUNC
Martin v. Löwis1a214512008-06-11 05:26:20 +00004294PyInit_imp(void)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004295{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004296 PyObject *m, *d;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004297
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004298 if (PyType_Ready(&PyNullImporter_Type) < 0)
4299 return NULL;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004300
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004301 m = PyModule_Create(&impmodule);
4302 if (m == NULL)
4303 goto failure;
4304 d = PyModule_GetDict(m);
4305 if (d == NULL)
4306 goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004307
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004308 if (setint(d, "SEARCH_ERROR", SEARCH_ERROR) < 0) goto failure;
4309 if (setint(d, "PY_SOURCE", PY_SOURCE) < 0) goto failure;
4310 if (setint(d, "PY_COMPILED", PY_COMPILED) < 0) goto failure;
4311 if (setint(d, "C_EXTENSION", C_EXTENSION) < 0) goto failure;
4312 if (setint(d, "PY_RESOURCE", PY_RESOURCE) < 0) goto failure;
4313 if (setint(d, "PKG_DIRECTORY", PKG_DIRECTORY) < 0) goto failure;
4314 if (setint(d, "C_BUILTIN", C_BUILTIN) < 0) goto failure;
4315 if (setint(d, "PY_FROZEN", PY_FROZEN) < 0) goto failure;
4316 if (setint(d, "PY_CODERESOURCE", PY_CODERESOURCE) < 0) goto failure;
4317 if (setint(d, "IMP_HOOK", IMP_HOOK) < 0) goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004318
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004319 Py_INCREF(&PyNullImporter_Type);
4320 PyModule_AddObject(m, "NullImporter", (PyObject *)&PyNullImporter_Type);
4321 return m;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00004322 failure:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004323 Py_XDECREF(m);
4324 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004325}
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004326
4327
Guido van Rossumb18618d2000-05-03 23:44:39 +00004328/* API for embedding applications that want to add their own entries
4329 to the table of built-in modules. This should normally be called
4330 *before* Py_Initialize(). When the table resize fails, -1 is
4331 returned and the existing table is unchanged.
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004332
4333 After a similar function by Just van Rossum. */
4334
4335int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00004336PyImport_ExtendInittab(struct _inittab *newtab)
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004337{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004338 static struct _inittab *our_copy = NULL;
4339 struct _inittab *p;
4340 int i, n;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004341
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004342 /* Count the number of entries in both tables */
4343 for (n = 0; newtab[n].name != NULL; n++)
4344 ;
4345 if (n == 0)
4346 return 0; /* Nothing to do */
4347 for (i = 0; PyImport_Inittab[i].name != NULL; i++)
4348 ;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004349
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004350 /* Allocate new memory for the combined table */
4351 p = our_copy;
4352 PyMem_RESIZE(p, struct _inittab, i+n+1);
4353 if (p == NULL)
4354 return -1;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004355
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004356 /* Copy the tables into the new memory */
4357 if (our_copy != PyImport_Inittab)
4358 memcpy(p, PyImport_Inittab, (i+1) * sizeof(struct _inittab));
4359 PyImport_Inittab = our_copy = p;
4360 memcpy(p+i, newtab, (n+1) * sizeof(struct _inittab));
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004361
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004362 return 0;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004363}
4364
4365/* Shorthand to add a single entry given a name and a function */
4366
4367int
Brett Cannona826f322009-04-02 03:41:46 +00004368PyImport_AppendInittab(const char *name, PyObject* (*initfunc)(void))
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004369{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004370 struct _inittab newtab[2];
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004371
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004372 memset(newtab, '\0', sizeof newtab);
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004373
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004374 newtab[0].name = (char *)name;
4375 newtab[0].initfunc = initfunc;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004376
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004377 return PyImport_ExtendInittab(newtab);
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004378}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00004379
4380#ifdef __cplusplus
4381}
4382#endif