blob: 3c3e504e284adaf80087ff6f8445c8ad089925c6 [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)
Martin v. Löwisfadcd312011-10-23 18:08:20 +0200111 TAG must change for each major Python release. The magic number will take
112 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__"
121/* Current magic word and string tag as globals. */
Guido van Rossum96774c12000-05-01 20:19:08 +0000122static long pyc_magic = MAGIC;
Barry Warsaw28a691b2010-04-17 00:19:56 +0000123static const char *pyc_tag = TAG;
Benjamin Peterson48deae12011-06-03 17:50:16 -0500124#undef QUOTE
125#undef STRIFY
126#undef MAJOR
127#undef MINOR
Guido van Rossum96774c12000-05-01 20:19:08 +0000128
Victor Stinner95872862011-03-07 18:20:56 +0100129/* See _PyImport_FixupExtensionObject() below */
Guido van Rossum25ce5661997-08-02 03:10:38 +0000130static PyObject *extensions = NULL;
Guido van Rossum3f5da241990-12-20 15:06:42 +0000131
Victor Stinnerfe7c5b52011-04-05 01:48:03 +0200132/* Function from Parser/tokenizer.c */
133extern char * PyTokenizer_FindEncodingFilename(int, PyObject *);
134
Guido van Rossum771c6c81997-10-31 18:37:24 +0000135/* This table is defined in config.c: */
136extern struct _inittab _PyImport_Inittab[];
137
138struct _inittab *PyImport_Inittab = _PyImport_Inittab;
Guido van Rossum66f1fa81991-04-03 19:03:52 +0000139
Guido van Rossumed1170e1999-12-20 21:23:41 +0000140/* these tables define the module suffixes that Python recognizes */
141struct filedescr * _PyImport_Filetab = NULL;
Guido van Rossum48a680c2001-03-02 06:34:14 +0000142
Guido van Rossumed1170e1999-12-20 21:23:41 +0000143static const struct filedescr _PyImport_StandardFiletab[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000144 {".py", "U", PY_SOURCE},
Martin v. Löwis6238d2b2002-06-30 15:26:10 +0000145#ifdef MS_WINDOWS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000146 {".pyw", "U", PY_SOURCE},
Tim Peters36515e22001-11-18 04:06:29 +0000147#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000148 {".pyc", "rb", PY_COMPILED},
149 {0, 0}
Guido van Rossumed1170e1999-12-20 21:23:41 +0000150};
151
Victor Stinnerd0296212011-03-14 14:04:10 -0400152static PyObject *initstr = NULL;
Martin v. Löwisbd928fe2011-10-14 10:20:37 +0200153_Py_IDENTIFIER(__path__);
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000154
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000155/* Initialize things */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000156
157void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000158_PyImport_Init(void)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000159{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000160 const struct filedescr *scan;
161 struct filedescr *filetab;
162 int countD = 0;
163 int countS = 0;
Guido van Rossumed1170e1999-12-20 21:23:41 +0000164
Victor Stinnerd0296212011-03-14 14:04:10 -0400165 initstr = PyUnicode_InternFromString("__init__");
166 if (initstr == NULL)
167 Py_FatalError("Can't initialize import variables");
168
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000169 /* prepare _PyImport_Filetab: copy entries from
170 _PyImport_DynLoadFiletab and _PyImport_StandardFiletab.
171 */
Guido van Rossum04110fb2007-08-24 16:32:05 +0000172#ifdef HAVE_DYNAMIC_LOADING
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000173 for (scan = _PyImport_DynLoadFiletab; scan->suffix != NULL; ++scan)
174 ++countD;
Guido van Rossum04110fb2007-08-24 16:32:05 +0000175#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000176 for (scan = _PyImport_StandardFiletab; scan->suffix != NULL; ++scan)
177 ++countS;
178 filetab = PyMem_NEW(struct filedescr, countD + countS + 1);
179 if (filetab == NULL)
180 Py_FatalError("Can't initialize import file table.");
Guido van Rossum04110fb2007-08-24 16:32:05 +0000181#ifdef HAVE_DYNAMIC_LOADING
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000182 memcpy(filetab, _PyImport_DynLoadFiletab,
183 countD * sizeof(struct filedescr));
Guido van Rossum04110fb2007-08-24 16:32:05 +0000184#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000185 memcpy(filetab + countD, _PyImport_StandardFiletab,
186 countS * sizeof(struct filedescr));
187 filetab[countD + countS].suffix = NULL;
Guido van Rossumed1170e1999-12-20 21:23:41 +0000188
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000189 _PyImport_Filetab = filetab;
Guido van Rossumed1170e1999-12-20 21:23:41 +0000190
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000191 if (Py_OptimizeFlag) {
192 /* Replace ".pyc" with ".pyo" in _PyImport_Filetab */
193 for (; filetab->suffix != NULL; filetab++) {
194 if (strcmp(filetab->suffix, ".pyc") == 0)
195 filetab->suffix = ".pyo";
196 }
197 }
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000198}
199
Guido van Rossum25ce5661997-08-02 03:10:38 +0000200void
Just van Rossum52e14d62002-12-30 22:08:05 +0000201_PyImportHooks_Init(void)
202{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000203 PyObject *v, *path_hooks = NULL, *zimpimport;
204 int err = 0;
Just van Rossum52e14d62002-12-30 22:08:05 +0000205
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000206 /* adding sys.path_hooks and sys.path_importer_cache, setting up
207 zipimport */
208 if (PyType_Ready(&PyNullImporter_Type) < 0)
209 goto error;
Just van Rossum52e14d62002-12-30 22:08:05 +0000210
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000211 if (Py_VerboseFlag)
212 PySys_WriteStderr("# installing zipimport hook\n");
Just van Rossum52e14d62002-12-30 22:08:05 +0000213
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000214 v = PyList_New(0);
215 if (v == NULL)
216 goto error;
217 err = PySys_SetObject("meta_path", v);
218 Py_DECREF(v);
219 if (err)
220 goto error;
221 v = PyDict_New();
222 if (v == NULL)
223 goto error;
224 err = PySys_SetObject("path_importer_cache", v);
225 Py_DECREF(v);
226 if (err)
227 goto error;
228 path_hooks = PyList_New(0);
229 if (path_hooks == NULL)
230 goto error;
231 err = PySys_SetObject("path_hooks", path_hooks);
232 if (err) {
Just van Rossum52e14d62002-12-30 22:08:05 +0000233 error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000234 PyErr_Print();
235 Py_FatalError("initializing sys.meta_path, sys.path_hooks, "
236 "path_importer_cache, or NullImporter failed"
237 );
238 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000239
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000240 zimpimport = PyImport_ImportModule("zipimport");
241 if (zimpimport == NULL) {
242 PyErr_Clear(); /* No zip import module -- okay */
243 if (Py_VerboseFlag)
244 PySys_WriteStderr("# can't import zipimport\n");
245 }
246 else {
Martin v. Löwisbd928fe2011-10-14 10:20:37 +0200247 _Py_IDENTIFIER(zipimporter);
Martin v. Löwis1ee1b6f2011-10-10 18:11:30 +0200248 PyObject *zipimporter = _PyObject_GetAttrId(zimpimport,
249 &PyId_zipimporter);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000250 Py_DECREF(zimpimport);
251 if (zipimporter == NULL) {
252 PyErr_Clear(); /* No zipimporter object -- okay */
253 if (Py_VerboseFlag)
254 PySys_WriteStderr(
255 "# can't import zipimport.zipimporter\n");
256 }
257 else {
258 /* sys.path_hooks.append(zipimporter) */
259 err = PyList_Append(path_hooks, zipimporter);
260 Py_DECREF(zipimporter);
261 if (err)
262 goto error;
263 if (Py_VerboseFlag)
264 PySys_WriteStderr(
265 "# installed zipimport hook\n");
266 }
267 }
268 Py_DECREF(path_hooks);
Just van Rossum52e14d62002-12-30 22:08:05 +0000269}
270
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000271/* Locking primitives to prevent parallel imports of the same module
272 in different threads to return with a partially loaded module.
273 These calls are serialized by the global interpreter lock. */
274
275#ifdef WITH_THREAD
276
Guido van Rossum49b56061998-10-01 20:42:43 +0000277#include "pythread.h"
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000278
Guido van Rossum65d5b571998-12-21 19:32:43 +0000279static PyThread_type_lock import_lock = 0;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000280static long import_lock_thread = -1;
281static int import_lock_level = 0;
282
Benjamin Peterson0df35a92009-10-04 20:32:25 +0000283void
284_PyImport_AcquireLock(void)
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000285{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000286 long me = PyThread_get_thread_ident();
287 if (me == -1)
288 return; /* Too bad */
289 if (import_lock == NULL) {
290 import_lock = PyThread_allocate_lock();
291 if (import_lock == NULL)
292 return; /* Nothing much we can do. */
293 }
294 if (import_lock_thread == me) {
295 import_lock_level++;
296 return;
297 }
298 if (import_lock_thread != -1 || !PyThread_acquire_lock(import_lock, 0))
299 {
300 PyThreadState *tstate = PyEval_SaveThread();
301 PyThread_acquire_lock(import_lock, 1);
302 PyEval_RestoreThread(tstate);
303 }
304 import_lock_thread = me;
305 import_lock_level = 1;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000306}
307
Benjamin Peterson0df35a92009-10-04 20:32:25 +0000308int
309_PyImport_ReleaseLock(void)
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000310{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000311 long me = PyThread_get_thread_ident();
312 if (me == -1 || import_lock == NULL)
313 return 0; /* Too bad */
314 if (import_lock_thread != me)
315 return -1;
316 import_lock_level--;
317 if (import_lock_level == 0) {
318 import_lock_thread = -1;
319 PyThread_release_lock(import_lock);
320 }
321 return 1;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000322}
323
Gregory P. Smith24cec9f2010-03-01 06:18:41 +0000324/* This function is called from PyOS_AfterFork to ensure that newly
325 created child processes do not share locks with the parent.
326 We now acquire the import lock around fork() calls but on some platforms
327 (Solaris 9 and earlier? see isue7242) that still left us with problems. */
Guido van Rossum8ee3e5a2005-09-14 18:09:42 +0000328
329void
330_PyImport_ReInitLock(void)
331{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000332 if (import_lock != NULL)
333 import_lock = PyThread_allocate_lock();
Nick Coghlanb2ddf792010-12-02 04:11:46 +0000334 if (import_lock_level > 1) {
335 /* Forked as a side effect of import */
336 long me = PyThread_get_thread_ident();
337 PyThread_acquire_lock(import_lock, 0);
Victor Stinner942003c2011-03-07 16:57:48 +0100338 /* XXX: can the previous line fail? */
Nick Coghlanb2ddf792010-12-02 04:11:46 +0000339 import_lock_thread = me;
340 import_lock_level--;
341 } else {
342 import_lock_thread = -1;
343 import_lock_level = 0;
344 }
Guido van Rossum8ee3e5a2005-09-14 18:09:42 +0000345}
346
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000347#endif
348
Tim Peters69232342001-08-30 05:16:13 +0000349static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000350imp_lock_held(PyObject *self, PyObject *noargs)
Tim Peters69232342001-08-30 05:16:13 +0000351{
Tim Peters69232342001-08-30 05:16:13 +0000352#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000353 return PyBool_FromLong(import_lock_thread != -1);
Tim Peters69232342001-08-30 05:16:13 +0000354#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000355 return PyBool_FromLong(0);
Tim Peters69232342001-08-30 05:16:13 +0000356#endif
357}
358
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000359static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000360imp_acquire_lock(PyObject *self, PyObject *noargs)
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000361{
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000362#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000363 _PyImport_AcquireLock();
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000364#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000365 Py_INCREF(Py_None);
366 return Py_None;
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000367}
368
369static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +0000370imp_release_lock(PyObject *self, PyObject *noargs)
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000371{
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000372#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000373 if (_PyImport_ReleaseLock() < 0) {
374 PyErr_SetString(PyExc_RuntimeError,
375 "not holding the import lock");
376 return NULL;
377 }
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
Antoine Pitrou8db076c2011-10-30 19:13:55 +0100383void
384_PyImport_Fini(void)
385{
386 Py_XDECREF(extensions);
387 extensions = NULL;
388 PyMem_DEL(_PyImport_Filetab);
389 _PyImport_Filetab = NULL;
390#ifdef WITH_THREAD
391 if (import_lock != NULL) {
392 PyThread_free_lock(import_lock);
393 import_lock = NULL;
394 }
395#endif
396}
397
Guido van Rossumd8faa362007-04-27 19:54:29 +0000398static void
399imp_modules_reloading_clear(void)
400{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000401 PyInterpreterState *interp = PyThreadState_Get()->interp;
402 if (interp->modules_reloading != NULL)
403 PyDict_Clear(interp->modules_reloading);
Guido van Rossumd8faa362007-04-27 19:54:29 +0000404}
405
Guido van Rossum25ce5661997-08-02 03:10:38 +0000406/* Helper for sys */
407
408PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000409PyImport_GetModuleDict(void)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000410{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000411 PyInterpreterState *interp = PyThreadState_GET()->interp;
412 if (interp->modules == NULL)
413 Py_FatalError("PyImport_GetModuleDict: no module dictionary!");
414 return interp->modules;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000415}
416
Guido van Rossum3f5da241990-12-20 15:06:42 +0000417
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000418/* List of names to clear in sys */
419static char* sys_deletes[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000420 "path", "argv", "ps1", "ps2",
421 "last_type", "last_value", "last_traceback",
422 "path_hooks", "path_importer_cache", "meta_path",
423 /* misc stuff */
424 "flags", "float_info",
425 NULL
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000426};
427
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000428static char* sys_files[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000429 "stdin", "__stdin__",
430 "stdout", "__stdout__",
431 "stderr", "__stderr__",
432 NULL
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000433};
434
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000435
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000436/* Un-initialize things, as good as we can */
Guido van Rossum3f5da241990-12-20 15:06:42 +0000437
Guido van Rossum3f5da241990-12-20 15:06:42 +0000438void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000439PyImport_Cleanup(void)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000440{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000441 Py_ssize_t pos, ndone;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000442 PyObject *key, *value, *dict;
443 PyInterpreterState *interp = PyThreadState_GET()->interp;
444 PyObject *modules = interp->modules;
Guido van Rossum758eec01998-01-19 21:58:26 +0000445
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000446 if (modules == NULL)
447 return; /* Already done */
Guido van Rossum758eec01998-01-19 21:58:26 +0000448
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000449 /* Delete some special variables first. These are common
450 places where user values hide and people complain when their
451 destructors fail. Since the modules containing them are
452 deleted *last* of all, they would come too late in the normal
453 destruction order. Sigh. */
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000454
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000455 value = PyDict_GetItemString(modules, "builtins");
456 if (value != NULL && PyModule_Check(value)) {
457 dict = PyModule_GetDict(value);
458 if (Py_VerboseFlag)
459 PySys_WriteStderr("# clear builtins._\n");
460 PyDict_SetItemString(dict, "_", Py_None);
461 }
462 value = PyDict_GetItemString(modules, "sys");
463 if (value != NULL && PyModule_Check(value)) {
464 char **p;
465 PyObject *v;
466 dict = PyModule_GetDict(value);
467 for (p = sys_deletes; *p != NULL; p++) {
468 if (Py_VerboseFlag)
469 PySys_WriteStderr("# clear sys.%s\n", *p);
470 PyDict_SetItemString(dict, *p, Py_None);
471 }
472 for (p = sys_files; *p != NULL; p+=2) {
473 if (Py_VerboseFlag)
474 PySys_WriteStderr("# restore sys.%s\n", *p);
475 v = PyDict_GetItemString(dict, *(p+1));
476 if (v == NULL)
477 v = Py_None;
478 PyDict_SetItemString(dict, *p, v);
479 }
480 }
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000481
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000482 /* First, delete __main__ */
483 value = PyDict_GetItemString(modules, "__main__");
484 if (value != NULL && PyModule_Check(value)) {
485 if (Py_VerboseFlag)
486 PySys_WriteStderr("# cleanup __main__\n");
487 _PyModule_Clear(value);
488 PyDict_SetItemString(modules, "__main__", Py_None);
489 }
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000490
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000491 /* The special treatment of "builtins" here is because even
492 when it's not referenced as a module, its dictionary is
493 referenced by almost every module's __builtins__. Since
494 deleting a module clears its dictionary (even if there are
495 references left to it), we need to delete the "builtins"
496 module last. Likewise, we don't delete sys until the very
497 end because it is implicitly referenced (e.g. by print).
Guido van Rossum758eec01998-01-19 21:58:26 +0000498
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000499 Also note that we 'delete' modules by replacing their entry
500 in the modules dict with None, rather than really deleting
501 them; this avoids a rehash of the modules dictionary and
502 also marks them as "non existent" so they won't be
503 re-imported. */
Guido van Rossum758eec01998-01-19 21:58:26 +0000504
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000505 /* Next, repeatedly delete modules with a reference count of
506 one (skipping builtins and sys) and delete them */
507 do {
508 ndone = 0;
509 pos = 0;
510 while (PyDict_Next(modules, &pos, &key, &value)) {
511 if (value->ob_refcnt != 1)
512 continue;
513 if (PyUnicode_Check(key) && PyModule_Check(value)) {
Victor Stinner9464d612011-03-07 17:08:21 +0100514 if (PyUnicode_CompareWithASCIIString(key, "builtins") == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000515 continue;
Victor Stinner9464d612011-03-07 17:08:21 +0100516 if (PyUnicode_CompareWithASCIIString(key, "sys") == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000517 continue;
518 if (Py_VerboseFlag)
Victor Stinner9464d612011-03-07 17:08:21 +0100519 PySys_FormatStderr(
520 "# cleanup[1] %U\n", key);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000521 _PyModule_Clear(value);
522 PyDict_SetItem(modules, key, Py_None);
523 ndone++;
524 }
525 }
526 } while (ndone > 0);
Guido van Rossum758eec01998-01-19 21:58:26 +0000527
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000528 /* Next, delete all modules (still skipping builtins and sys) */
529 pos = 0;
530 while (PyDict_Next(modules, &pos, &key, &value)) {
531 if (PyUnicode_Check(key) && PyModule_Check(value)) {
Victor Stinner9464d612011-03-07 17:08:21 +0100532 if (PyUnicode_CompareWithASCIIString(key, "builtins") == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000533 continue;
Victor Stinner9464d612011-03-07 17:08:21 +0100534 if (PyUnicode_CompareWithASCIIString(key, "sys") == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000535 continue;
536 if (Py_VerboseFlag)
Victor Stinner9464d612011-03-07 17:08:21 +0100537 PySys_FormatStderr("# cleanup[2] %U\n", key);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000538 _PyModule_Clear(value);
539 PyDict_SetItem(modules, key, Py_None);
540 }
541 }
Guido van Rossum758eec01998-01-19 21:58:26 +0000542
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000543 /* Next, delete sys and builtins (in that order) */
544 value = PyDict_GetItemString(modules, "sys");
545 if (value != NULL && PyModule_Check(value)) {
546 if (Py_VerboseFlag)
547 PySys_WriteStderr("# cleanup sys\n");
548 _PyModule_Clear(value);
549 PyDict_SetItemString(modules, "sys", Py_None);
550 }
551 value = PyDict_GetItemString(modules, "builtins");
552 if (value != NULL && PyModule_Check(value)) {
553 if (Py_VerboseFlag)
554 PySys_WriteStderr("# cleanup builtins\n");
555 _PyModule_Clear(value);
556 PyDict_SetItemString(modules, "builtins", Py_None);
557 }
Guido van Rossum758eec01998-01-19 21:58:26 +0000558
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000559 /* Finally, clear and delete the modules directory */
560 PyDict_Clear(modules);
561 interp->modules = NULL;
562 Py_DECREF(modules);
563 Py_CLEAR(interp->modules_reloading);
Guido van Rossum8d15b5d1990-10-26 14:58:58 +0000564}
Guido van Rossum7f133ed1991-02-19 12:23:57 +0000565
566
Barry Warsaw28a691b2010-04-17 00:19:56 +0000567/* Helper for pythonrun.c -- return magic number and tag. */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000568
569long
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000570PyImport_GetMagicNumber(void)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000571{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000572 return pyc_magic;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000573}
574
575
Barry Warsaw28a691b2010-04-17 00:19:56 +0000576const char *
577PyImport_GetMagicTag(void)
578{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000579 return pyc_tag;
Barry Warsaw28a691b2010-04-17 00:19:56 +0000580}
581
Guido van Rossum25ce5661997-08-02 03:10:38 +0000582/* Magic for extension modules (built-in as well as dynamically
583 loaded). To prevent initializing an extension module more than
584 once, we keep a static dictionary 'extensions' keyed by module name
585 (for built-in modules) or by filename (for dynamically loaded
Barry Warsaw92883382001-08-13 23:05:44 +0000586 modules), containing these modules. A copy of the module's
Victor Stinner95872862011-03-07 18:20:56 +0100587 dictionary is stored by calling _PyImport_FixupExtensionObject()
Guido van Rossum25ce5661997-08-02 03:10:38 +0000588 immediately after the module initialization function succeeds. A
589 copy can be retrieved from there by calling
Victor Stinner95872862011-03-07 18:20:56 +0100590 _PyImport_FindExtensionObject().
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000591
Barry Warsaw7c9627b2010-06-17 18:38:20 +0000592 Modules which do support multiple initialization set their m_size
593 field to a non-negative number (indicating the size of the
594 module-specific state). They are still recorded in the extensions
595 dictionary, to avoid loading shared libraries twice.
Martin v. Löwis1a214512008-06-11 05:26:20 +0000596*/
597
598int
Victor Stinner95872862011-03-07 18:20:56 +0100599_PyImport_FixupExtensionObject(PyObject *mod, PyObject *name,
600 PyObject *filename)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000601{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000602 PyObject *modules, *dict;
603 struct PyModuleDef *def;
604 if (extensions == NULL) {
605 extensions = PyDict_New();
606 if (extensions == NULL)
607 return -1;
608 }
609 if (mod == NULL || !PyModule_Check(mod)) {
610 PyErr_BadInternalCall();
611 return -1;
612 }
613 def = PyModule_GetDef(mod);
614 if (!def) {
615 PyErr_BadInternalCall();
616 return -1;
617 }
618 modules = PyImport_GetModuleDict();
Victor Stinner95872862011-03-07 18:20:56 +0100619 if (PyDict_SetItem(modules, name, mod) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000620 return -1;
621 if (_PyState_AddModule(mod, def) < 0) {
Victor Stinner95872862011-03-07 18:20:56 +0100622 PyDict_DelItem(modules, name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000623 return -1;
624 }
625 if (def->m_size == -1) {
626 if (def->m_base.m_copy) {
627 /* Somebody already imported the module,
628 likely under a different name.
629 XXX this should really not happen. */
630 Py_DECREF(def->m_base.m_copy);
631 def->m_base.m_copy = NULL;
632 }
633 dict = PyModule_GetDict(mod);
634 if (dict == NULL)
635 return -1;
636 def->m_base.m_copy = PyDict_Copy(dict);
637 if (def->m_base.m_copy == NULL)
638 return -1;
639 }
Victor Stinner49d3f252010-10-17 01:24:53 +0000640 PyDict_SetItem(extensions, filename, (PyObject*)def);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000641 return 0;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000642}
643
Victor Stinner49d3f252010-10-17 01:24:53 +0000644int
645_PyImport_FixupBuiltin(PyObject *mod, char *name)
646{
647 int res;
Victor Stinner95872862011-03-07 18:20:56 +0100648 PyObject *nameobj;
Victor Stinner21fcd0c2011-03-07 18:28:15 +0100649 nameobj = PyUnicode_InternFromString(name);
Victor Stinner95872862011-03-07 18:20:56 +0100650 if (nameobj == NULL)
Victor Stinner49d3f252010-10-17 01:24:53 +0000651 return -1;
Victor Stinner95872862011-03-07 18:20:56 +0100652 res = _PyImport_FixupExtensionObject(mod, nameobj, nameobj);
653 Py_DECREF(nameobj);
Victor Stinner49d3f252010-10-17 01:24:53 +0000654 return res;
655}
656
Guido van Rossum25ce5661997-08-02 03:10:38 +0000657PyObject *
Victor Stinner95872862011-03-07 18:20:56 +0100658_PyImport_FindExtensionObject(PyObject *name, PyObject *filename)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000659{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000660 PyObject *mod, *mdict;
661 PyModuleDef* def;
662 if (extensions == NULL)
663 return NULL;
Victor Stinner49d3f252010-10-17 01:24:53 +0000664 def = (PyModuleDef*)PyDict_GetItem(extensions, filename);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000665 if (def == NULL)
666 return NULL;
667 if (def->m_size == -1) {
668 /* Module does not support repeated initialization */
669 if (def->m_base.m_copy == NULL)
670 return NULL;
Victor Stinner95872862011-03-07 18:20:56 +0100671 mod = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000672 if (mod == NULL)
673 return NULL;
674 mdict = PyModule_GetDict(mod);
675 if (mdict == NULL)
676 return NULL;
677 if (PyDict_Update(mdict, def->m_base.m_copy))
678 return NULL;
679 }
680 else {
681 if (def->m_base.m_init == NULL)
682 return NULL;
683 mod = def->m_base.m_init();
684 if (mod == NULL)
685 return NULL;
Victor Stinner95872862011-03-07 18:20:56 +0100686 PyDict_SetItem(PyImport_GetModuleDict(), name, mod);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000687 Py_DECREF(mod);
688 }
689 if (_PyState_AddModule(mod, def) < 0) {
Victor Stinner95872862011-03-07 18:20:56 +0100690 PyDict_DelItem(PyImport_GetModuleDict(), name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000691 Py_DECREF(mod);
692 return NULL;
693 }
694 if (Py_VerboseFlag)
Victor Stinner95872862011-03-07 18:20:56 +0100695 PySys_FormatStderr("import %U # previously loaded (%R)\n",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000696 name, filename);
697 return mod;
Brett Cannon9a5b25a2010-03-01 02:09:17 +0000698
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000699}
700
Victor Stinner49d3f252010-10-17 01:24:53 +0000701PyObject *
Victor Stinner501c09a2011-02-23 00:02:00 +0000702_PyImport_FindBuiltin(const char *name)
Victor Stinner49d3f252010-10-17 01:24:53 +0000703{
Victor Stinner95872862011-03-07 18:20:56 +0100704 PyObject *res, *nameobj;
Victor Stinner21fcd0c2011-03-07 18:28:15 +0100705 nameobj = PyUnicode_InternFromString(name);
Victor Stinner95872862011-03-07 18:20:56 +0100706 if (nameobj == NULL)
Victor Stinner49d3f252010-10-17 01:24:53 +0000707 return NULL;
Victor Stinner95872862011-03-07 18:20:56 +0100708 res = _PyImport_FindExtensionObject(nameobj, nameobj);
709 Py_DECREF(nameobj);
Victor Stinner49d3f252010-10-17 01:24:53 +0000710 return res;
711}
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000712
713/* Get the module object corresponding to a module name.
714 First check the modules dictionary if there's one there,
Walter Dörwaldf0dfc7a2003-10-20 14:01:56 +0000715 if not, create a new one and insert it in the modules dictionary.
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000716 Because the former action is most common, THIS DOES NOT RETURN A
717 'NEW' REFERENCE! */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000718
Guido van Rossum79f25d91997-04-29 20:08:16 +0000719PyObject *
Victor Stinner27ee0892011-03-04 12:57:09 +0000720PyImport_AddModuleObject(PyObject *name)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000721{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000722 PyObject *modules = PyImport_GetModuleDict();
723 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000724
Victor Stinner27ee0892011-03-04 12:57:09 +0000725 if ((m = PyDict_GetItem(modules, name)) != NULL &&
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000726 PyModule_Check(m))
727 return m;
Victor Stinner27ee0892011-03-04 12:57:09 +0000728 m = PyModule_NewObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000729 if (m == NULL)
730 return NULL;
Victor Stinner27ee0892011-03-04 12:57:09 +0000731 if (PyDict_SetItem(modules, name, m) != 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000732 Py_DECREF(m);
733 return NULL;
734 }
735 Py_DECREF(m); /* Yes, it still exists, in modules! */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000736
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000737 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000738}
739
Victor Stinner27ee0892011-03-04 12:57:09 +0000740PyObject *
741PyImport_AddModule(const char *name)
742{
743 PyObject *nameobj, *module;
744 nameobj = PyUnicode_FromString(name);
745 if (nameobj == NULL)
746 return NULL;
747 module = PyImport_AddModuleObject(nameobj);
748 Py_DECREF(nameobj);
749 return module;
750}
751
752
Tim Peters1cd70172004-08-02 03:52:12 +0000753/* Remove name from sys.modules, if it's there. */
754static void
Victor Stinner27ee0892011-03-04 12:57:09 +0000755remove_module(PyObject *name)
Tim Peters1cd70172004-08-02 03:52:12 +0000756{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000757 PyObject *modules = PyImport_GetModuleDict();
Victor Stinner27ee0892011-03-04 12:57:09 +0000758 if (PyDict_GetItem(modules, name) == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000759 return;
Victor Stinner27ee0892011-03-04 12:57:09 +0000760 if (PyDict_DelItem(modules, name) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000761 Py_FatalError("import: deleting existing key in"
762 "sys.modules failed");
Tim Peters1cd70172004-08-02 03:52:12 +0000763}
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000764
Victor Stinnerc9abda02011-03-14 13:33:46 -0400765static PyObject * get_sourcefile(PyObject *filename);
766static PyObject *make_source_pathname(PyObject *pathname);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200767static PyObject* make_compiled_pathname(PyObject *pathname, int debug);
Christian Heimes3b06e532008-01-07 20:12:44 +0000768
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000769/* Execute a code object in a module and return the module object
Tim Peters1cd70172004-08-02 03:52:12 +0000770 * WITH INCREMENTED REFERENCE COUNT. If an error occurs, name is
771 * removed from sys.modules, to avoid leaving damaged module objects
772 * in sys.modules. The caller may wish to restore the original
773 * module object (if any) in this case; PyImport_ReloadModule is an
774 * example.
Barry Warsaw28a691b2010-04-17 00:19:56 +0000775 *
776 * Note that PyImport_ExecCodeModuleWithPathnames() is the preferred, richer
777 * interface. The other two exist primarily for backward compatibility.
Tim Peters1cd70172004-08-02 03:52:12 +0000778 */
Guido van Rossum79f25d91997-04-29 20:08:16 +0000779PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000780PyImport_ExecCodeModule(char *name, PyObject *co)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000781{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000782 return PyImport_ExecCodeModuleWithPathnames(
783 name, co, (char *)NULL, (char *)NULL);
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000784}
785
786PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000787PyImport_ExecCodeModuleEx(char *name, PyObject *co, char *pathname)
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000788{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000789 return PyImport_ExecCodeModuleWithPathnames(
790 name, co, pathname, (char *)NULL);
Barry Warsaw28a691b2010-04-17 00:19:56 +0000791}
792
793PyObject *
794PyImport_ExecCodeModuleWithPathnames(char *name, PyObject *co, char *pathname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000795 char *cpathname)
Barry Warsaw28a691b2010-04-17 00:19:56 +0000796{
Victor Stinner27ee0892011-03-04 12:57:09 +0000797 PyObject *m = NULL;
798 PyObject *nameobj, *pathobj = NULL, *cpathobj = NULL;
799
800 nameobj = PyUnicode_FromString(name);
801 if (nameobj == NULL)
802 return NULL;
803
804 if (pathname != NULL) {
805 pathobj = PyUnicode_DecodeFSDefault(pathname);
806 if (pathobj == NULL)
807 goto error;
808 } else
809 pathobj = NULL;
810 if (cpathname != NULL) {
811 cpathobj = PyUnicode_DecodeFSDefault(cpathname);
812 if (cpathobj == NULL)
813 goto error;
814 } else
815 cpathobj = NULL;
816 m = PyImport_ExecCodeModuleObject(nameobj, co, pathobj, cpathobj);
817error:
818 Py_DECREF(nameobj);
819 Py_XDECREF(pathobj);
820 Py_XDECREF(cpathobj);
821 return m;
822}
823
824PyObject*
825PyImport_ExecCodeModuleObject(PyObject *name, PyObject *co, PyObject *pathname,
826 PyObject *cpathname)
827{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000828 PyObject *modules = PyImport_GetModuleDict();
829 PyObject *m, *d, *v;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000830
Victor Stinner27ee0892011-03-04 12:57:09 +0000831 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000832 if (m == NULL)
833 return NULL;
834 /* If the module is being reloaded, we get the old module back
835 and re-use its dict to exec the new code. */
836 d = PyModule_GetDict(m);
837 if (PyDict_GetItemString(d, "__builtins__") == NULL) {
838 if (PyDict_SetItemString(d, "__builtins__",
839 PyEval_GetBuiltins()) != 0)
840 goto error;
841 }
842 /* Remember the filename as the __file__ attribute */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000843 if (pathname != NULL) {
Victor Stinnerc9abda02011-03-14 13:33:46 -0400844 v = get_sourcefile(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000845 if (v == NULL)
846 PyErr_Clear();
847 }
Victor Stinner27ee0892011-03-04 12:57:09 +0000848 else
849 v = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000850 if (v == NULL) {
851 v = ((PyCodeObject *)co)->co_filename;
852 Py_INCREF(v);
853 }
854 if (PyDict_SetItemString(d, "__file__", v) != 0)
855 PyErr_Clear(); /* Not important enough to report */
856 Py_DECREF(v);
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000857
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000858 /* Remember the pyc path name as the __cached__ attribute. */
Victor Stinner27ee0892011-03-04 12:57:09 +0000859 if (cpathname != NULL)
860 v = cpathname;
861 else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000862 v = Py_None;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000863 if (PyDict_SetItemString(d, "__cached__", v) != 0)
864 PyErr_Clear(); /* Not important enough to report */
Barry Warsaw28a691b2010-04-17 00:19:56 +0000865
Martin v. Löwis4d0d4712010-12-03 20:14:31 +0000866 v = PyEval_EvalCode(co, d, d);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000867 if (v == NULL)
868 goto error;
869 Py_DECREF(v);
Guido van Rossumb65e85c1997-07-10 18:00:45 +0000870
Victor Stinner27ee0892011-03-04 12:57:09 +0000871 if ((m = PyDict_GetItem(modules, name)) == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000872 PyErr_Format(PyExc_ImportError,
Victor Stinner27ee0892011-03-04 12:57:09 +0000873 "Loaded module %R not found in sys.modules",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000874 name);
875 return NULL;
876 }
Guido van Rossumb65e85c1997-07-10 18:00:45 +0000877
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000878 Py_INCREF(m);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000879
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000880 return m;
Tim Peters1cd70172004-08-02 03:52:12 +0000881
882 error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000883 remove_module(name);
884 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000885}
886
887
Barry Warsaw28a691b2010-04-17 00:19:56 +0000888/* Like strrchr(string, '/') but searches for the rightmost of either SEP
889 or ALTSEP, if the latter is defined.
890*/
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200891static Py_UCS4*
892rightmost_sep(Py_UCS4 *s)
Victor Stinnerc9abda02011-03-14 13:33:46 -0400893{
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200894 Py_UCS4 *found, c;
Victor Stinnerc9abda02011-03-14 13:33:46 -0400895 for (found = NULL; (c = *s); s++) {
896 if (c == SEP
897#ifdef ALTSEP
898 || c == ALTSEP
899#endif
900 )
901 {
902 found = s;
903 }
904 }
905 return found;
906}
907
Martin v. Löwis2db72862011-10-23 17:29:08 +0200908/* Like rightmost_sep, but operate on unicode objects. */
909static Py_ssize_t
Martin v. Löwis8a0ef782011-10-23 18:05:06 +0200910rightmost_sep_obj(PyObject* o, Py_ssize_t start, Py_ssize_t end)
Martin v. Löwis2db72862011-10-23 17:29:08 +0200911{
912 Py_ssize_t found, i;
913 Py_UCS4 c;
Martin v. Löwis8a0ef782011-10-23 18:05:06 +0200914 for (found = -1, i = start; i < end; i++) {
Martin v. Löwis2db72862011-10-23 17:29:08 +0200915 c = PyUnicode_READ_CHAR(o, i);
916 if (c == SEP
917#ifdef ALTSEP
918 || c == ALTSEP
919#endif
920 )
921 {
922 found = i;
923 }
924 }
925 return found;
926}
Victor Stinnerc9abda02011-03-14 13:33:46 -0400927
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000928/* Given a pathname for a Python source file, fill a buffer with the
929 pathname for the corresponding compiled file. Return the pathname
930 for the compiled file, or NULL if there's no space in the buffer.
Victor Stinner2f42ae52011-03-20 00:41:24 +0100931 Doesn't set an exception.
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000932
Martin v. Löwis30260a72011-10-23 17:35:46 +0200933 foo.py -> __pycache__/foo.<tag>.pyc
934
935 pathstr is assumed to be "ready".
936*/
Victor Stinner2f42ae52011-03-20 00:41:24 +0100937
938static PyObject*
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200939make_compiled_pathname(PyObject *pathstr, int debug)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000940{
Martin v. Löwis2db72862011-10-23 17:29:08 +0200941 PyObject *result;
942 Py_ssize_t fname, ext, len, i, pos, taglen;
Martin v. Löwisfadcd312011-10-23 18:08:20 +0200943 Py_ssize_t pycache_len = sizeof(CACHEDIR) - 1;
Martin v. Löwis2db72862011-10-23 17:29:08 +0200944 int kind;
945 void *data;
Antoine Pitroub528fcf2011-10-25 00:21:02 +0200946 Py_UCS4 lastsep;
Barry Warsaw28a691b2010-04-17 00:19:56 +0000947
Martin v. Löwis2db72862011-10-23 17:29:08 +0200948 /* Compute the output string size. */
949 len = PyUnicode_GET_LENGTH(pathstr);
950 /* If there is no separator, this returns -1, so
Antoine Pitroub528fcf2011-10-25 00:21:02 +0200951 fname will be 0. */
Martin v. Löwis8a0ef782011-10-23 18:05:06 +0200952 fname = rightmost_sep_obj(pathstr, 0, len) + 1;
Antoine Pitroub528fcf2011-10-25 00:21:02 +0200953 /* Windows: re-use the last separator character (/ or \\) when
954 appending the __pycache__ path. */
955 if (fname > 0)
956 lastsep = PyUnicode_READ_CHAR(pathstr, fname -1);
957 else
958 lastsep = SEP;
Martin v. Löwis2db72862011-10-23 17:29:08 +0200959 ext = fname - 1;
960 for(i = fname; i < len; i++)
961 if (PyUnicode_READ_CHAR(pathstr, i) == '.')
962 ext = i + 1;
963 if (ext < fname)
964 /* No dot in filename; use entire filename */
965 ext = len;
966
967 /* result = pathstr[:fname] + "__pycache__" + SEP +
968 pathstr[fname:ext] + tag + ".py[co]" */
969 taglen = strlen(pyc_tag);
Martin v. Löwis2cc0cc52011-10-23 18:41:56 +0200970 result = PyUnicode_New(ext + pycache_len + 1 + taglen + 4,
Martin v. Löwis2db72862011-10-23 17:29:08 +0200971 PyUnicode_MAX_CHAR_VALUE(pathstr));
972 if (!result)
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200973 return NULL;
Martin v. Löwis2db72862011-10-23 17:29:08 +0200974 kind = PyUnicode_KIND(result);
975 data = PyUnicode_DATA(result);
976 PyUnicode_CopyCharacters(result, 0, pathstr, 0, fname);
977 pos = fname;
Martin v. Löwis2cc0cc52011-10-23 18:41:56 +0200978 for (i = 0; i < pycache_len; i++)
Martin v. Löwisfadcd312011-10-23 18:08:20 +0200979 PyUnicode_WRITE(kind, data, pos++, CACHEDIR[i]);
Antoine Pitroub528fcf2011-10-25 00:21:02 +0200980 PyUnicode_WRITE(kind, data, pos++, lastsep);
Martin v. Löwis2db72862011-10-23 17:29:08 +0200981 PyUnicode_CopyCharacters(result, pos, pathstr,
982 fname, ext - fname);
983 pos += ext - fname;
984 for (i = 0; pyc_tag[i]; i++)
985 PyUnicode_WRITE(kind, data, pos++, pyc_tag[i]);
986 PyUnicode_WRITE(kind, data, pos++, '.');
987 PyUnicode_WRITE(kind, data, pos++, 'p');
988 PyUnicode_WRITE(kind, data, pos++, 'y');
989 PyUnicode_WRITE(kind, data, pos++, debug ? 'c' : 'o');
990 return result;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000991}
992
993
Barry Warsaw28a691b2010-04-17 00:19:56 +0000994/* Given a pathname to a Python byte compiled file, return the path to the
995 source file, if the path matches the PEP 3147 format. This does not check
996 for any file existence, however, if the pyc file name does not match PEP
997 3147 style, NULL is returned. buf must be at least as big as pathname;
Victor Stinnerc9abda02011-03-14 13:33:46 -0400998 the resulting path will always be shorter.
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000999
Victor Stinnerc9abda02011-03-14 13:33:46 -04001000 (...)/__pycache__/foo.<tag>.pyc -> (...)/foo.py */
1001
1002static PyObject*
Martin v. Löwis8a0ef782011-10-23 18:05:06 +02001003make_source_pathname(PyObject *path)
Barry Warsaw28a691b2010-04-17 00:19:56 +00001004{
Martin v. Löwis8a0ef782011-10-23 18:05:06 +02001005 Py_ssize_t left, right, dot0, dot1, len;
1006 Py_ssize_t i, j;
1007 PyObject *result;
1008 int kind;
1009 void *data;
Victor Stinnerc9abda02011-03-14 13:33:46 -04001010
Martin v. Löwis8a0ef782011-10-23 18:05:06 +02001011 len = PyUnicode_GET_LENGTH(path);
1012 if (len > MAXPATHLEN)
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001013 return NULL;
Barry Warsaw28a691b2010-04-17 00:19:56 +00001014
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001015 /* Look back two slashes from the end. In between these two slashes
1016 must be the string __pycache__ or this is not a PEP 3147 style
1017 path. It's possible for there to be only one slash.
1018 */
Martin v. Löwis8a0ef782011-10-23 18:05:06 +02001019 right = rightmost_sep_obj(path, 0, len);
1020 if (right == -1)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001021 return NULL;
Martin v. Löwis8a0ef782011-10-23 18:05:06 +02001022 left = rightmost_sep_obj(path, 0, right);
1023 if (left == -1)
1024 left = 0;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001025 else
1026 left++;
Martin v. Löwis8a0ef782011-10-23 18:05:06 +02001027 if (right-left != sizeof(CACHEDIR)-1)
1028 return NULL;
1029 for (i = 0; i < sizeof(CACHEDIR)-1; i++)
1030 if (PyUnicode_READ_CHAR(path, left+i) != CACHEDIR[i])
1031 return NULL;
Barry Warsaw28a691b2010-04-17 00:19:56 +00001032
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001033 /* Now verify that the path component to the right of the last slash
1034 has two dots in it.
1035 */
Martin v. Löwis8a0ef782011-10-23 18:05:06 +02001036 dot0 = PyUnicode_FindChar(path, '.', right+1, len, 1);
1037 if (dot0 < 0)
1038 return NULL;
1039 dot1 = PyUnicode_FindChar(path, '.', dot0+1, len, 1);
1040 if (dot1 < 0)
1041 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001042 /* Too many dots? */
Martin v. Löwis8a0ef782011-10-23 18:05:06 +02001043 if (PyUnicode_FindChar(path, '.', dot1+1, len, 1) != -1)
1044 return NULL;
Barry Warsaw28a691b2010-04-17 00:19:56 +00001045
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001046 /* This is a PEP 3147 path. Start by copying everything from the
1047 start of pathname up to and including the leftmost slash. Then
1048 copy the file's basename, removing the magic tag and adding a .py
1049 suffix.
1050 */
Martin v. Löwis8a0ef782011-10-23 18:05:06 +02001051 result = PyUnicode_New(left + (dot0-right) + 2,
1052 PyUnicode_MAX_CHAR_VALUE(path));
1053 if (!result)
1054 return NULL;
1055 kind = PyUnicode_KIND(result);
1056 data = PyUnicode_DATA(result);
1057 PyUnicode_CopyCharacters(result, 0, path, 0, (i = left));
1058 PyUnicode_CopyCharacters(result, left, path, right+1,
1059 (j = dot0-right));
1060 PyUnicode_WRITE(kind, data, i+j, 'p');
1061 PyUnicode_WRITE(kind, data, i+j+1, 'y');
1062 return result;
Barry Warsaw28a691b2010-04-17 00:19:56 +00001063}
1064
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001065/* Given a pathname for a Python source file, its time of last
1066 modification, and a pathname for a compiled file, check whether the
1067 compiled file represents the same version of the source. If so,
1068 return a FILE pointer for the compiled file, positioned just after
1069 the header; if not, return NULL.
1070 Doesn't set an exception. */
1071
1072static FILE *
Victor Stinner2f42ae52011-03-20 00:41:24 +01001073check_compiled_module(PyObject *pathname, time_t mtime, PyObject *cpathname)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001074{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001075 FILE *fp;
1076 long magic;
1077 long pyc_mtime;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001078
Victor Stinner2f42ae52011-03-20 00:41:24 +01001079 fp = _Py_fopen(cpathname, "rb");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001080 if (fp == NULL)
1081 return NULL;
1082 magic = PyMarshal_ReadLongFromFile(fp);
1083 if (magic != pyc_magic) {
1084 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001085 PySys_FormatStderr("# %R has bad magic\n", cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001086 fclose(fp);
1087 return NULL;
1088 }
1089 pyc_mtime = PyMarshal_ReadLongFromFile(fp);
1090 if (pyc_mtime != mtime) {
1091 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001092 PySys_FormatStderr("# %R has bad mtime\n", cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001093 fclose(fp);
1094 return NULL;
1095 }
1096 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001097 PySys_FormatStderr("# %R matches %R\n", cpathname, pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001098 return fp;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001099}
1100
1101
1102/* Read a code object from a file and check it for validity */
1103
Guido van Rossum79f25d91997-04-29 20:08:16 +00001104static PyCodeObject *
Victor Stinner2f42ae52011-03-20 00:41:24 +01001105read_compiled_module(PyObject *cpathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001106{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001107 PyObject *co;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001108
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001109 co = PyMarshal_ReadLastObjectFromFile(fp);
1110 if (co == NULL)
1111 return NULL;
1112 if (!PyCode_Check(co)) {
1113 PyErr_Format(PyExc_ImportError,
Victor Stinner2f42ae52011-03-20 00:41:24 +01001114 "Non-code object in %R", cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001115 Py_DECREF(co);
1116 return NULL;
1117 }
1118 return (PyCodeObject *)co;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001119}
1120
1121
1122/* Load a module from a compiled file, execute it, and return its
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001123 module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001124
Guido van Rossum79f25d91997-04-29 20:08:16 +00001125static PyObject *
Victor Stinner2f42ae52011-03-20 00:41:24 +01001126load_compiled_module(PyObject *name, PyObject *cpathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001127{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001128 long magic;
1129 PyCodeObject *co;
1130 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001131
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001132 magic = PyMarshal_ReadLongFromFile(fp);
1133 if (magic != pyc_magic) {
1134 PyErr_Format(PyExc_ImportError,
Victor Stinner2f42ae52011-03-20 00:41:24 +01001135 "Bad magic number in %R", cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001136 return NULL;
1137 }
1138 (void) PyMarshal_ReadLongFromFile(fp);
1139 co = read_compiled_module(cpathname, fp);
1140 if (co == NULL)
1141 return NULL;
1142 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001143 PySys_FormatStderr("import %U # precompiled from %R\n",
1144 name, cpathname);
1145 m = PyImport_ExecCodeModuleObject(name, (PyObject *)co,
1146 cpathname, cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001147 Py_DECREF(co);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001148
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001149 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001150}
1151
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001152/* Parse a source file and return the corresponding code object */
1153
Guido van Rossum79f25d91997-04-29 20:08:16 +00001154static PyCodeObject *
Victor Stinner2f42ae52011-03-20 00:41:24 +01001155parse_source_module(PyObject *pathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001156{
Victor Stinner2f42ae52011-03-20 00:41:24 +01001157 PyCodeObject *co;
1158 PyObject *pathbytes;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001159 mod_ty mod;
1160 PyCompilerFlags flags;
Victor Stinner2f42ae52011-03-20 00:41:24 +01001161 PyArena *arena;
1162
1163 pathbytes = PyUnicode_EncodeFSDefault(pathname);
1164 if (pathbytes == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001165 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001166
Victor Stinner2f42ae52011-03-20 00:41:24 +01001167 arena = PyArena_New();
1168 if (arena == NULL) {
1169 Py_DECREF(pathbytes);
1170 return NULL;
1171 }
1172
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001173 flags.cf_flags = 0;
Victor Stinner2f42ae52011-03-20 00:41:24 +01001174 mod = PyParser_ASTFromFile(fp, PyBytes_AS_STRING(pathbytes), NULL,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001175 Py_file_input, 0, 0, &flags,
1176 NULL, arena);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001177 if (mod != NULL)
1178 co = PyAST_Compile(mod, PyBytes_AS_STRING(pathbytes), NULL, arena);
1179 else
1180 co = NULL;
1181 Py_DECREF(pathbytes);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001182 PyArena_Free(arena);
1183 return co;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001184}
1185
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001186/* Write a compiled module to a file, placing the time of last
1187 modification of its source into the header.
1188 Errors are ignored, if a write error occurs an attempt is made to
1189 remove the file. */
1190
1191static void
Victor Stinner2f42ae52011-03-20 00:41:24 +01001192write_compiled_module(PyCodeObject *co, PyObject *cpathname,
1193 struct stat *srcstat)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001194{
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001195 Py_UCS4 *cpathname_ucs4;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001196 FILE *fp;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001197 time_t mtime = srcstat->st_mtime;
Alexandre Vassalotti9d58e3e2009-07-17 10:55:50 +00001198#ifdef MS_WINDOWS /* since Windows uses different permissions */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001199 mode_t mode = srcstat->st_mode & ~S_IEXEC;
Antoine Pitrou28e401e2011-11-15 19:15:19 +01001200 PyObject *cpathname_tmp;
1201 Py_ssize_t cpathname_len;
Alexandre Vassalotti9d58e3e2009-07-17 10:55:50 +00001202#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001203 mode_t dirmode = (srcstat->st_mode |
1204 S_IXUSR | S_IXGRP | S_IXOTH |
1205 S_IWUSR | S_IWGRP | S_IWOTH);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001206 PyObject *dirbytes;
Antoine Pitrou707033a2011-10-17 19:28:44 +02001207 PyObject *cpathbytes, *cpathbytes_tmp;
1208 Py_ssize_t cpathbytes_len;
Victor Stinner783c82c2011-04-20 03:27:51 +02001209#endif
Charles-François Natali0c929d92011-11-10 19:12:29 +01001210 int fd;
Victor Stinner783c82c2011-04-20 03:27:51 +02001211 PyObject *dirname;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001212 Py_UCS4 *dirsep;
Victor Stinner2f42ae52011-03-20 00:41:24 +01001213 int res, ok;
Barry Warsaw28a691b2010-04-17 00:19:56 +00001214
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001215 /* Ensure that the __pycache__ directory exists. */
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001216 cpathname_ucs4 = PyUnicode_AsUCS4Copy(cpathname);
1217 if (!cpathname_ucs4)
1218 return;
1219 dirsep = rightmost_sep(cpathname_ucs4);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001220 if (dirsep == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001221 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001222 PySys_FormatStderr("# no %s path found %R\n", CACHEDIR, cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001223 return;
1224 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001225 dirname = PyUnicode_FromKindAndData(PyUnicode_4BYTE_KIND,
1226 cpathname_ucs4,
1227 dirsep - cpathname_ucs4);
1228 PyMem_Free(cpathname_ucs4);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001229 if (dirname == NULL) {
1230 PyErr_Clear();
1231 return;
1232 }
Daniel Stutzbachc7937792010-09-09 21:18:04 +00001233
1234#ifdef MS_WINDOWS
Victor Stinner2f42ae52011-03-20 00:41:24 +01001235 res = CreateDirectoryW(PyUnicode_AS_UNICODE(dirname), NULL);
1236 ok = (res != 0);
1237 if (!ok && GetLastError() == ERROR_ALREADY_EXISTS)
1238 ok = 1;
Daniel Stutzbachc7937792010-09-09 21:18:04 +00001239#else
Victor Stinner2f42ae52011-03-20 00:41:24 +01001240 dirbytes = PyUnicode_EncodeFSDefault(dirname);
1241 if (dirbytes == NULL) {
1242 PyErr_Clear();
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001243 return;
1244 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01001245 res = mkdir(PyBytes_AS_STRING(dirbytes), dirmode);
1246 Py_DECREF(dirbytes);
1247 if (0 <= res)
1248 ok = 1;
1249 else
1250 ok = (errno == EEXIST);
1251#endif
1252 if (!ok) {
1253 if (Py_VerboseFlag)
1254 PySys_FormatStderr("# cannot create cache dir %R\n", dirname);
1255 Py_DECREF(dirname);
1256 return;
1257 }
1258 Py_DECREF(dirname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001259
Antoine Pitrou28e401e2011-11-15 19:15:19 +01001260 /* We first write to a tmp file and then take advantage
1261 of atomic renaming (which *should* be true even under Windows). */
Victor Stinner783c82c2011-04-20 03:27:51 +02001262#ifdef MS_WINDOWS
Antoine Pitrou28e401e2011-11-15 19:15:19 +01001263 cpathname_len = PyUnicode_GET_LENGTH(cpathname);
1264 cpathname_tmp = PyUnicode_New(cpathname_len + 4,
1265 PyUnicode_MAX_CHAR_VALUE(cpathname));
1266 if (cpathname_tmp == NULL) {
1267 PyErr_Clear();
1268 return;
1269 }
1270 PyUnicode_WriteChar(cpathname_tmp, cpathname_len + 0, '.');
1271 PyUnicode_WriteChar(cpathname_tmp, cpathname_len + 1, 't');
1272 PyUnicode_WriteChar(cpathname_tmp, cpathname_len + 2, 'm');
1273 PyUnicode_WriteChar(cpathname_tmp, cpathname_len + 3, 'p');
1274 (void)DeleteFileW(PyUnicode_AS_UNICODE(cpathname_tmp));
1275 fd = _wopen(PyUnicode_AS_UNICODE(cpathname_tmp),
1276 O_EXCL | O_CREAT | O_WRONLY | O_BINARY,
1277 mode);
Victor Stinner783c82c2011-04-20 03:27:51 +02001278 if (0 <= fd)
1279 fp = fdopen(fd, "wb");
1280 else
1281 fp = NULL;
1282#else
Victor Stinner2f42ae52011-03-20 00:41:24 +01001283 cpathbytes = PyUnicode_EncodeFSDefault(cpathname);
1284 if (cpathbytes == NULL) {
1285 PyErr_Clear();
1286 return;
1287 }
Antoine Pitrou707033a2011-10-17 19:28:44 +02001288 cpathbytes_len = PyBytes_GET_SIZE(cpathbytes);
Charles-François Natali0c929d92011-11-10 19:12:29 +01001289 cpathbytes_tmp = PyBytes_FromStringAndSize(NULL, cpathbytes_len + 4);
Antoine Pitrou707033a2011-10-17 19:28:44 +02001290 if (cpathbytes_tmp == NULL) {
1291 Py_DECREF(cpathbytes);
1292 PyErr_Clear();
1293 return;
1294 }
1295 memcpy(PyBytes_AS_STRING(cpathbytes_tmp), PyBytes_AS_STRING(cpathbytes),
1296 cpathbytes_len);
Charles-François Natali0c929d92011-11-10 19:12:29 +01001297 memcpy(PyBytes_AS_STRING(cpathbytes_tmp) + cpathbytes_len, ".tmp", 4);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001298
Charles-François Natali0c929d92011-11-10 19:12:29 +01001299 fd = open(PyBytes_AS_STRING(cpathbytes_tmp),
1300 O_CREAT | O_EXCL | O_WRONLY, 0666);
Charles-François Natalie695eec2011-10-31 20:47:31 +01001301 if (0 <= fd)
1302 fp = fdopen(fd, "wb");
1303 else
1304 fp = NULL;
Victor Stinner783c82c2011-04-20 03:27:51 +02001305#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001306 if (fp == NULL) {
1307 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001308 PySys_FormatStderr(
1309 "# can't create %R\n", cpathname);
Antoine Pitrou28e401e2011-11-15 19:15:19 +01001310#ifdef MS_WINDOWS
1311 Py_DECREF(cpathname_tmp);
1312#else
Victor Stinner2f42ae52011-03-20 00:41:24 +01001313 Py_DECREF(cpathbytes);
Antoine Pitrou707033a2011-10-17 19:28:44 +02001314 Py_DECREF(cpathbytes_tmp);
Victor Stinner783c82c2011-04-20 03:27:51 +02001315#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001316 return;
1317 }
1318 PyMarshal_WriteLongToFile(pyc_magic, fp, Py_MARSHAL_VERSION);
1319 /* First write a 0 for mtime */
1320 PyMarshal_WriteLongToFile(0L, fp, Py_MARSHAL_VERSION);
1321 PyMarshal_WriteObjectToFile((PyObject *)co, fp, Py_MARSHAL_VERSION);
Antoine Pitrou707033a2011-10-17 19:28:44 +02001322 fflush(fp);
1323 /* Now write the true mtime */
1324 fseek(fp, 4L, 0);
1325 assert(mtime < LONG_MAX);
1326 PyMarshal_WriteLongToFile((long)mtime, fp, Py_MARSHAL_VERSION);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001327 if (fflush(fp) != 0 || ferror(fp)) {
1328 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001329 PySys_FormatStderr("# can't write %R\n", cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001330 /* Don't keep partial file */
1331 fclose(fp);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001332#ifdef MS_WINDOWS
Antoine Pitrou28e401e2011-11-15 19:15:19 +01001333 (void)DeleteFileW(PyUnicode_AS_UNICODE(cpathname_tmp));
1334 Py_DECREF(cpathname_tmp);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001335#else
Antoine Pitrou707033a2011-10-17 19:28:44 +02001336 (void) unlink(PyBytes_AS_STRING(cpathbytes_tmp));
Victor Stinner2f42ae52011-03-20 00:41:24 +01001337 Py_DECREF(cpathbytes);
Antoine Pitrou707033a2011-10-17 19:28:44 +02001338 Py_DECREF(cpathbytes_tmp);
Victor Stinner783c82c2011-04-20 03:27:51 +02001339#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001340 return;
1341 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001342 fclose(fp);
Antoine Pitrou28e401e2011-11-15 19:15:19 +01001343 /* Do a (hopefully) atomic rename */
1344#ifdef MS_WINDOWS
1345 if (!MoveFileExW(PyUnicode_AS_UNICODE(cpathname_tmp),
1346 PyUnicode_AS_UNICODE(cpathname),
1347 MOVEFILE_REPLACE_EXISTING)) {
1348 if (Py_VerboseFlag)
1349 PySys_FormatStderr("# can't write %R\n", cpathname);
1350 /* Don't keep tmp file */
1351 (void) DeleteFileW(PyUnicode_AS_UNICODE(cpathname_tmp));
1352 Py_DECREF(cpathname_tmp);
1353 return;
1354 }
1355 Py_DECREF(cpathname_tmp);
1356#else
Antoine Pitrou707033a2011-10-17 19:28:44 +02001357 if (rename(PyBytes_AS_STRING(cpathbytes_tmp),
1358 PyBytes_AS_STRING(cpathbytes))) {
1359 if (Py_VerboseFlag)
1360 PySys_FormatStderr("# can't write %R\n", cpathname);
1361 /* Don't keep tmp file */
1362 unlink(PyBytes_AS_STRING(cpathbytes_tmp));
1363 Py_DECREF(cpathbytes);
1364 Py_DECREF(cpathbytes_tmp);
1365 return;
1366 }
1367 Py_DECREF(cpathbytes);
1368 Py_DECREF(cpathbytes_tmp);
1369#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001370 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001371 PySys_FormatStderr("# wrote %R\n", cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001372}
1373
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001374static void
1375update_code_filenames(PyCodeObject *co, PyObject *oldname, PyObject *newname)
1376{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001377 PyObject *constants, *tmp;
1378 Py_ssize_t i, n;
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001379
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001380 if (PyUnicode_Compare(co->co_filename, oldname))
1381 return;
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001382
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001383 tmp = co->co_filename;
1384 co->co_filename = newname;
1385 Py_INCREF(co->co_filename);
1386 Py_DECREF(tmp);
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001387
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001388 constants = co->co_consts;
1389 n = PyTuple_GET_SIZE(constants);
1390 for (i = 0; i < n; i++) {
1391 tmp = PyTuple_GET_ITEM(constants, i);
1392 if (PyCode_Check(tmp))
1393 update_code_filenames((PyCodeObject *)tmp,
1394 oldname, newname);
1395 }
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001396}
1397
Victor Stinner2f42ae52011-03-20 00:41:24 +01001398static void
1399update_compiled_module(PyCodeObject *co, PyObject *newname)
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001400{
Victor Stinner2f42ae52011-03-20 00:41:24 +01001401 PyObject *oldname;
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001402
Victor Stinner2f42ae52011-03-20 00:41:24 +01001403 if (PyUnicode_Compare(co->co_filename, newname) == 0)
1404 return;
Hirokazu Yamamoto4f447fb2009-03-04 01:52:10 +00001405
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001406 oldname = co->co_filename;
1407 Py_INCREF(oldname);
1408 update_code_filenames(co, oldname, newname);
1409 Py_DECREF(oldname);
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001410}
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001411
Brett Cannon442c9b92011-03-23 16:14:42 -07001412static PyObject *
1413imp_fix_co_filename(PyObject *self, PyObject *args)
1414{
1415 PyObject *co;
1416 PyObject *file_path;
1417
1418 if (!PyArg_ParseTuple(args, "OO:_fix_co_filename", &co, &file_path))
1419 return NULL;
1420
1421 if (!PyCode_Check(co)) {
1422 PyErr_SetString(PyExc_TypeError,
1423 "first argument must be a code object");
1424 return NULL;
1425 }
1426
1427 if (!PyUnicode_Check(file_path)) {
1428 PyErr_SetString(PyExc_TypeError,
1429 "second argument must be a string");
1430 return NULL;
1431 }
1432
1433 update_compiled_module((PyCodeObject*)co, file_path);
1434
1435 Py_RETURN_NONE;
1436}
1437
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001438/* Load a source module from a given file and return its module
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001439 object WITH INCREMENTED REFERENCE COUNT. If there's a matching
1440 byte-compiled file, use that instead. */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001441
Guido van Rossum79f25d91997-04-29 20:08:16 +00001442static PyObject *
Victor Stinner2f42ae52011-03-20 00:41:24 +01001443load_source_module(PyObject *name, PyObject *pathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001444{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001445 struct stat st;
1446 FILE *fpc;
Victor Stinner2f42ae52011-03-20 00:41:24 +01001447 PyObject *cpathname = NULL, *cpathbytes = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001448 PyCodeObject *co;
Victor Stinner2f42ae52011-03-20 00:41:24 +01001449 PyObject *m = NULL;
Brett Cannon9a5b25a2010-03-01 02:09:17 +00001450
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001451 if (fstat(fileno(fp), &st) != 0) {
1452 PyErr_Format(PyExc_RuntimeError,
Victor Stinner2f42ae52011-03-20 00:41:24 +01001453 "unable to get file status from %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001454 pathname);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001455 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001456 }
Fred Drake4c82b232000-06-30 16:18:57 +00001457#if SIZEOF_TIME_T > 4
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001458 /* Python's .pyc timestamp handling presumes that the timestamp fits
1459 in 4 bytes. This will be fine until sometime in the year 2038,
1460 when a 4-byte signed time_t will overflow.
1461 */
1462 if (st.st_mtime >> 32) {
1463 PyErr_SetString(PyExc_OverflowError,
1464 "modification time overflows a 4 byte field");
Victor Stinner2f42ae52011-03-20 00:41:24 +01001465 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001466 }
Fred Drake4c82b232000-06-30 16:18:57 +00001467#endif
Martin v. Löwis30260a72011-10-23 17:35:46 +02001468 if (PyUnicode_READY(pathname) < 0)
1469 return NULL;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001470 cpathname = make_compiled_pathname(pathname, !Py_OptimizeFlag);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001471
1472 if (cpathname != NULL)
1473 fpc = check_compiled_module(pathname, st.st_mtime, cpathname);
1474 else
1475 fpc = NULL;
1476
1477 if (fpc) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001478 co = read_compiled_module(cpathname, fpc);
1479 fclose(fpc);
1480 if (co == NULL)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001481 goto error;
1482 update_compiled_module(co, pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001483 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001484 PySys_FormatStderr("import %U # precompiled from %R\n",
1485 name, cpathname);
1486 m = PyImport_ExecCodeModuleObject(name, (PyObject *)co,
1487 cpathname, cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001488 }
1489 else {
1490 co = parse_source_module(pathname, fp);
1491 if (co == NULL)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001492 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001493 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001494 PySys_FormatStderr("import %U # from %R\n",
Victor Stinner98dbba52011-03-14 15:15:47 -04001495 name, pathname);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001496 if (cpathname != NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001497 PyObject *ro = PySys_GetObject("dont_write_bytecode");
1498 if (ro == NULL || !PyObject_IsTrue(ro))
1499 write_compiled_module(co, cpathname, &st);
1500 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01001501 m = PyImport_ExecCodeModuleObject(name, (PyObject *)co,
1502 pathname, cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001503 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001504 Py_DECREF(co);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001505
Victor Stinner2f42ae52011-03-20 00:41:24 +01001506error:
1507 Py_XDECREF(cpathbytes);
1508 Py_XDECREF(cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001509 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001510}
1511
Christian Heimes3b06e532008-01-07 20:12:44 +00001512/* Get source file -> unicode or None
1513 * Returns the path to the py file if available, else the given path
1514 */
1515static PyObject *
Victor Stinnerc9abda02011-03-14 13:33:46 -04001516get_sourcefile(PyObject *filename)
Christian Heimes3b06e532008-01-07 20:12:44 +00001517{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001518 Py_ssize_t len;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001519 Py_UCS4 *fileuni;
Victor Stinnerc9abda02011-03-14 13:33:46 -04001520 PyObject *py;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001521 struct stat statbuf;
Christian Heimes3b06e532008-01-07 20:12:44 +00001522
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001523 len = PyUnicode_GET_LENGTH(filename);
Victor Stinnerc9abda02011-03-14 13:33:46 -04001524 if (len == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001525 Py_RETURN_NONE;
Christian Heimes3b06e532008-01-07 20:12:44 +00001526
Victor Stinnerc9abda02011-03-14 13:33:46 -04001527 /* don't match *.pyc or *.pyo? */
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001528 fileuni = PyUnicode_AsUCS4Copy(filename);
1529 if (!fileuni)
1530 return NULL;
Victor Stinnerc9abda02011-03-14 13:33:46 -04001531 if (len < 5
1532 || fileuni[len-4] != '.'
1533 || (fileuni[len-3] != 'p' && fileuni[len-3] != 'P')
1534 || (fileuni[len-2] != 'y' && fileuni[len-2] != 'Y'))
1535 goto unchanged;
Christian Heimes3b06e532008-01-07 20:12:44 +00001536
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001537 /* Start by trying to turn PEP 3147 path into source path. If that
1538 * fails, just chop off the trailing character, i.e. legacy pyc path
1539 * to py.
1540 */
Victor Stinnerc9abda02011-03-14 13:33:46 -04001541 py = make_source_pathname(filename);
1542 if (py == NULL) {
1543 PyErr_Clear();
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001544 py = PyUnicode_FromKindAndData(PyUnicode_4BYTE_KIND, fileuni, len - 1);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001545 }
Victor Stinnerc9abda02011-03-14 13:33:46 -04001546 if (py == NULL)
1547 goto error;
Barry Warsaw28a691b2010-04-17 00:19:56 +00001548
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02001549 if (_Py_stat(py, &statbuf) == 0 && S_ISREG(statbuf.st_mode)) {
1550 PyMem_Free(fileuni);
Victor Stinnerc9abda02011-03-14 13:33:46 -04001551 return py;
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02001552 }
Victor Stinnerc9abda02011-03-14 13:33:46 -04001553 Py_DECREF(py);
1554 goto unchanged;
1555
1556error:
1557 PyErr_Clear();
1558unchanged:
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001559 PyMem_Free(fileuni);
Victor Stinnerc9abda02011-03-14 13:33:46 -04001560 Py_INCREF(filename);
1561 return filename;
Christian Heimes3b06e532008-01-07 20:12:44 +00001562}
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001563
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001564/* Forward */
Victor Stinner41c5fec2011-03-13 21:46:30 -04001565static PyObject *load_module(PyObject *, FILE *, PyObject *, int, PyObject *);
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001566static struct filedescr *find_module(PyObject *, PyObject *, PyObject *,
Victor Stinner2fd76e42011-03-14 15:19:39 -04001567 PyObject **, FILE **, PyObject **);
Victor Stinner53dc7352011-03-20 01:50:21 +01001568static struct _frozen * find_frozen(PyObject *);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001569
1570/* Load a package and return its module object WITH INCREMENTED
1571 REFERENCE COUNT */
1572
1573static PyObject *
Victor Stinnerc9abda02011-03-14 13:33:46 -04001574load_package(PyObject *name, PyObject *pathname)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001575{
Victor Stinner41c5fec2011-03-13 21:46:30 -04001576 PyObject *m, *d, *bufobj;
Victor Stinnerc9abda02011-03-14 13:33:46 -04001577 PyObject *file = NULL, *path_list = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001578 int err;
Victor Stinnerc9abda02011-03-14 13:33:46 -04001579 FILE *fp = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001580 struct filedescr *fdp;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001581
Victor Stinnerc9abda02011-03-14 13:33:46 -04001582 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001583 if (m == NULL)
1584 return NULL;
1585 if (Py_VerboseFlag)
Victor Stinner98dbba52011-03-14 15:15:47 -04001586 PySys_FormatStderr("import %U # directory %R\n",
1587 name, pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001588 file = get_sourcefile(pathname);
1589 if (file == NULL)
Victor Stinnerc9abda02011-03-14 13:33:46 -04001590 return NULL;
1591 path_list = Py_BuildValue("[O]", file);
1592 if (path_list == NULL) {
1593 Py_DECREF(file);
1594 return NULL;
1595 }
1596 d = PyModule_GetDict(m);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001597 err = PyDict_SetItemString(d, "__file__", file);
Victor Stinnerc9abda02011-03-14 13:33:46 -04001598 Py_DECREF(file);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001599 if (err == 0)
Victor Stinnerc9abda02011-03-14 13:33:46 -04001600 err = PyDict_SetItemString(d, "__path__", path_list);
1601 if (err != 0) {
1602 Py_DECREF(path_list);
1603 return NULL;
1604 }
Victor Stinner533d7832011-03-14 13:22:54 -04001605 fdp = find_module(name, initstr, path_list,
Victor Stinner2fd76e42011-03-14 15:19:39 -04001606 &bufobj, &fp, NULL);
Victor Stinnerc9abda02011-03-14 13:33:46 -04001607 Py_DECREF(path_list);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001608 if (fdp == NULL) {
1609 if (PyErr_ExceptionMatches(PyExc_ImportError)) {
1610 PyErr_Clear();
1611 Py_INCREF(m);
Victor Stinnerc9abda02011-03-14 13:33:46 -04001612 return m;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001613 }
1614 else
Victor Stinnerc9abda02011-03-14 13:33:46 -04001615 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001616 }
Victor Stinner2fd76e42011-03-14 15:19:39 -04001617 m = load_module(name, fp, bufobj, fdp->type, NULL);
1618 Py_XDECREF(bufobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001619 if (fp != NULL)
1620 fclose(fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001621 return m;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001622}
1623
1624
1625/* Helper to test for built-in module */
1626
1627static int
Victor Stinner95872862011-03-07 18:20:56 +01001628is_builtin(PyObject *name)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001629{
Victor Stinner95872862011-03-07 18:20:56 +01001630 int i, cmp;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001631 for (i = 0; PyImport_Inittab[i].name != NULL; i++) {
Victor Stinner95872862011-03-07 18:20:56 +01001632 cmp = PyUnicode_CompareWithASCIIString(name, PyImport_Inittab[i].name);
1633 if (cmp == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001634 if (PyImport_Inittab[i].initfunc == NULL)
1635 return -1;
1636 else
1637 return 1;
1638 }
1639 }
1640 return 0;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001641}
1642
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001643
Just van Rossum52e14d62002-12-30 22:08:05 +00001644/* Return an importer object for a sys.path/pkg.__path__ item 'p',
1645 possibly by fetching it from the path_importer_cache dict. If it
Thomas Wouters89f507f2006-12-13 04:49:30 +00001646 wasn't yet cached, traverse path_hooks until a hook is found
Just van Rossum52e14d62002-12-30 22:08:05 +00001647 that can handle the path item. Return None if no hook could;
1648 this tells our caller it should fall back to the builtin
1649 import mechanism. Cache the result in path_importer_cache.
1650 Returns a borrowed reference. */
1651
1652static PyObject *
1653get_path_importer(PyObject *path_importer_cache, PyObject *path_hooks,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001654 PyObject *p)
Just van Rossum52e14d62002-12-30 22:08:05 +00001655{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001656 PyObject *importer;
1657 Py_ssize_t j, nhooks;
Just van Rossum52e14d62002-12-30 22:08:05 +00001658
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001659 /* These conditions are the caller's responsibility: */
1660 assert(PyList_Check(path_hooks));
1661 assert(PyDict_Check(path_importer_cache));
Just van Rossum52e14d62002-12-30 22:08:05 +00001662
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001663 nhooks = PyList_Size(path_hooks);
1664 if (nhooks < 0)
1665 return NULL; /* Shouldn't happen */
Just van Rossum52e14d62002-12-30 22:08:05 +00001666
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001667 importer = PyDict_GetItem(path_importer_cache, p);
1668 if (importer != NULL)
1669 return importer;
Just van Rossum52e14d62002-12-30 22:08:05 +00001670
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001671 /* set path_importer_cache[p] to None to avoid recursion */
1672 if (PyDict_SetItem(path_importer_cache, p, Py_None) != 0)
1673 return NULL;
Just van Rossum52e14d62002-12-30 22:08:05 +00001674
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001675 for (j = 0; j < nhooks; j++) {
1676 PyObject *hook = PyList_GetItem(path_hooks, j);
1677 if (hook == NULL)
1678 return NULL;
1679 importer = PyObject_CallFunctionObjArgs(hook, p, NULL);
1680 if (importer != NULL)
1681 break;
Just van Rossum52e14d62002-12-30 22:08:05 +00001682
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001683 if (!PyErr_ExceptionMatches(PyExc_ImportError)) {
1684 return NULL;
1685 }
1686 PyErr_Clear();
1687 }
1688 if (importer == NULL) {
1689 importer = PyObject_CallFunctionObjArgs(
1690 (PyObject *)&PyNullImporter_Type, p, NULL
1691 );
1692 if (importer == NULL) {
1693 if (PyErr_ExceptionMatches(PyExc_ImportError)) {
1694 PyErr_Clear();
1695 return Py_None;
1696 }
1697 }
1698 }
1699 if (importer != NULL) {
1700 int err = PyDict_SetItem(path_importer_cache, p, importer);
1701 Py_DECREF(importer);
1702 if (err != 0)
1703 return NULL;
1704 }
1705 return importer;
Just van Rossum52e14d62002-12-30 22:08:05 +00001706}
1707
Christian Heimes9cd17752007-11-18 19:35:23 +00001708PyAPI_FUNC(PyObject *)
1709PyImport_GetImporter(PyObject *path) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001710 PyObject *importer=NULL, *path_importer_cache=NULL, *path_hooks=NULL;
Christian Heimes9cd17752007-11-18 19:35:23 +00001711
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001712 if ((path_importer_cache = PySys_GetObject("path_importer_cache"))) {
1713 if ((path_hooks = PySys_GetObject("path_hooks"))) {
1714 importer = get_path_importer(path_importer_cache,
1715 path_hooks, path);
1716 }
1717 }
1718 Py_XINCREF(importer); /* get_path_importer returns a borrowed reference */
1719 return importer;
Christian Heimes9cd17752007-11-18 19:35:23 +00001720}
1721
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001722/* Search the path (default sys.path) for a module. Return the
1723 corresponding filedescr struct, and (via return arguments) the
1724 pathname and an open file. Return NULL if the module is not found. */
1725
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001726#ifdef MS_COREDLL
Victor Stinner4d6c1c42011-03-08 23:49:04 +01001727extern FILE *_PyWin_FindRegisteredModule(PyObject *, struct filedescr **,
1728 PyObject **p_path);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001729#endif
1730
Victor Stinner547a2a62011-03-20 03:07:28 +01001731/* Forward */
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001732static int case_ok(PyObject *, Py_ssize_t, PyObject *);
Victor Stinner547a2a62011-03-20 03:07:28 +01001733static int find_init_module(PyObject *);
Just van Rossum52e14d62002-12-30 22:08:05 +00001734static struct filedescr importhookdescr = {"", "", IMP_HOOK};
Guido van Rossum197346f1997-10-31 18:38:52 +00001735
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001736/* Get the path of a module: get its importer and call importer.find_module()
1737 hook, or check if the module if a package (if path/__init__.py exists).
1738
1739 -1: error: a Python error occurred
1740 0: ignore: an error occurred because of invalid data, but the error is not
1741 important enough to be reported.
1742 1: get path: module not found, but *buf contains its path
1743 2: found: *p_fd is the file descriptor (IMP_HOOK or PKG_DIRECTORY)
1744 and *buf is the path */
1745
1746static int
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001747find_module_path(PyObject *fullname, PyObject *name, PyObject *path,
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001748 PyObject *path_hooks, PyObject *path_importer_cache,
Victor Stinner2fd76e42011-03-14 15:19:39 -04001749 PyObject **p_path, PyObject **p_loader, struct filedescr **p_fd)
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001750{
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001751 PyObject *path_unicode, *filename = NULL;
1752 Py_ssize_t len, pos;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001753 struct stat statbuf;
1754 static struct filedescr fd_package = {"", "", PKG_DIRECTORY};
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001755 int result, addsep;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001756
1757 if (PyUnicode_Check(path)) {
Victor Stinner2fd76e42011-03-14 15:19:39 -04001758 Py_INCREF(path);
1759 path_unicode = path;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001760 }
1761 else if (PyBytes_Check(path)) {
Victor Stinner2fd76e42011-03-14 15:19:39 -04001762 path_unicode = PyUnicode_DecodeFSDefaultAndSize(
1763 PyBytes_AS_STRING(path), PyBytes_GET_SIZE(path));
1764 if (path_unicode == NULL)
1765 return -1;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001766 }
1767 else
1768 return 0;
1769
Victor Stinner46084ba2011-10-06 02:39:42 +02001770 if (PyUnicode_READY(path_unicode))
1771 return -1;
1772
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001773 len = PyUnicode_GET_LENGTH(path_unicode);
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001774 if (PyUnicode_FindChar(path_unicode, 0, 0, len, 1) != -1) {
1775 result = 0;
1776 goto out; /* path contains '\0' */
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001777 }
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001778
1779 /* sys.path_hooks import hook */
1780 if (p_loader != NULL) {
Martin v. Löwisbd928fe2011-10-14 10:20:37 +02001781 _Py_IDENTIFIER(find_module);
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001782 PyObject *importer;
1783
1784 importer = get_path_importer(path_importer_cache,
1785 path_hooks, path);
1786 if (importer == NULL) {
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001787 result = -1;
1788 goto out;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001789 }
1790 /* Note: importer is a borrowed reference */
1791 if (importer != Py_None) {
1792 PyObject *loader;
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02001793 loader = _PyObject_CallMethodId(importer,
1794 &PyId_find_module, "O", fullname);
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001795 if (loader == NULL) {
1796 result = -1; /* error */
1797 goto out;
1798 }
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001799 if (loader != Py_None) {
1800 /* a loader was found */
1801 *p_loader = loader;
1802 *p_fd = &importhookdescr;
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001803 result = 2;
1804 goto out;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001805 }
1806 Py_DECREF(loader);
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001807 result = 0;
1808 goto out;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001809 }
1810 }
1811 /* no hook was found, use builtin import */
1812
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001813 addsep = 0;
1814 if (len > 0 && PyUnicode_READ_CHAR(path_unicode, len-1) != SEP
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001815#ifdef ALTSEP
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001816 && PyUnicode_READ_CHAR(path_unicode, len-1) != ALTSEP
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001817#endif
1818 )
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001819 addsep = 1;
1820 filename = PyUnicode_New(len + PyUnicode_GET_LENGTH(name) + addsep,
1821 Py_MAX(PyUnicode_MAX_CHAR_VALUE(path_unicode),
1822 PyUnicode_MAX_CHAR_VALUE(name)));
1823 if (filename == NULL) {
1824 result = -1;
1825 goto out;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001826 }
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001827 PyUnicode_CopyCharacters(filename, 0, path_unicode, 0, len);
1828 pos = len;
1829 if (addsep)
1830 PyUnicode_WRITE(PyUnicode_KIND(filename),
1831 PyUnicode_DATA(filename),
1832 pos++, SEP);
1833 PyUnicode_CopyCharacters(filename, pos, name, 0,
1834 PyUnicode_GET_LENGTH(name));
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001835
1836 /* Check for package import (buf holds a directory name,
1837 and there's an __init__ module in that directory */
1838#ifdef HAVE_STAT
Victor Stinner2fd76e42011-03-14 15:19:39 -04001839 if (_Py_stat(filename, &statbuf) == 0 && /* it exists */
Victor Stinnerd0296212011-03-14 14:04:10 -04001840 S_ISDIR(statbuf.st_mode)) /* it's a directory */
1841 {
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001842 int match;
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001843
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001844 match = case_ok(filename, 0, name);
1845 if (match < 0) {
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001846 result = -1;
1847 goto out;
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001848 }
1849 if (match) { /* case matches */
1850 if (find_init_module(filename)) { /* and has __init__.py */
Victor Stinner2fd76e42011-03-14 15:19:39 -04001851 *p_path = filename;
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001852 filename = NULL;
Victor Stinnerd0296212011-03-14 14:04:10 -04001853 *p_fd = &fd_package;
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001854 result = 2;
1855 goto out;
Victor Stinnerd0296212011-03-14 14:04:10 -04001856 }
1857 else {
1858 int err;
Victor Stinnerd0296212011-03-14 14:04:10 -04001859 err = PyErr_WarnFormat(PyExc_ImportWarning, 1,
Victor Stinner547a2a62011-03-20 03:07:28 +01001860 "Not importing directory %R: missing __init__.py",
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001861 filename);
Victor Stinner547a2a62011-03-20 03:07:28 +01001862 if (err) {
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001863 result = -1;
1864 goto out;
Victor Stinner547a2a62011-03-20 03:07:28 +01001865 }
Victor Stinnerd0296212011-03-14 14:04:10 -04001866 }
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001867 }
1868 }
1869#endif
Victor Stinner2fd76e42011-03-14 15:19:39 -04001870 *p_path = filename;
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001871 filename = NULL;
1872 result = 1;
1873 out:
1874 Py_DECREF(path_unicode);
1875 Py_XDECREF(filename);
1876 return result;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001877}
1878
1879/* Find a module in search_path_list. For each path, try
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001880 find_module_path() or try each _PyImport_Filetab suffix.
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001881
1882 If the module is found, return a file descriptor, write the path in
1883 *p_filename, write the pointer to the file object into *p_fp, and (if
1884 p_loader is not NULL) the loader into *p_loader.
1885
1886 Otherwise, raise an exception and return NULL. */
1887
Victor Stinner37580282011-03-20 01:34:43 +01001888static struct filedescr*
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001889find_module_path_list(PyObject *fullname, PyObject *name,
Victor Stinner37580282011-03-20 01:34:43 +01001890 PyObject *search_path_list, PyObject *path_hooks,
1891 PyObject *path_importer_cache,
Victor Stinner2fd76e42011-03-14 15:19:39 -04001892 PyObject **p_path, FILE **p_fp, PyObject **p_loader)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001893{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001894 Py_ssize_t i, npath;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001895 struct filedescr *fdp = NULL;
1896 char *filemode;
1897 FILE *fp = NULL;
Victor Stinner2fd76e42011-03-14 15:19:39 -04001898 PyObject *prefix, *filename;
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001899 int match;
Victor Stinner53dc7352011-03-20 01:50:21 +01001900
Victor Stinner37580282011-03-20 01:34:43 +01001901 npath = PyList_Size(search_path_list);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001902 for (i = 0; i < npath; i++) {
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001903 PyObject *path;
1904 int ok;
1905
1906 path = PyList_GetItem(search_path_list, i);
1907 if (path == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001908 return NULL;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001909
Victor Stinner2fd76e42011-03-14 15:19:39 -04001910 prefix = NULL;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001911 ok = find_module_path(fullname, name, path,
1912 path_hooks, path_importer_cache,
Victor Stinner2fd76e42011-03-14 15:19:39 -04001913 &prefix, p_loader, &fdp);
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001914 if (ok < 0)
1915 return NULL;
1916 if (ok == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001917 continue;
Victor Stinner2fd76e42011-03-14 15:19:39 -04001918 if (ok == 2) {
1919 *p_path = prefix;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001920 return fdp;
Victor Stinner2fd76e42011-03-14 15:19:39 -04001921 }
Amaury Forgeot d'Arcf1ca0b12008-06-11 17:40:47 +00001922
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001923 for (fdp = _PyImport_Filetab; fdp->suffix != NULL; fdp++) {
Victor Stinnera1fe1f82011-09-23 18:59:08 +02001924 struct stat statbuf;
1925
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001926 filemode = fdp->mode;
1927 if (filemode[0] == 'U')
1928 filemode = "r" PY_STDIOTEXTMODE;
Victor Stinnerd0296212011-03-14 14:04:10 -04001929
Victor Stinner2fd76e42011-03-14 15:19:39 -04001930 filename = PyUnicode_FromFormat("%U%s", prefix, fdp->suffix);
1931 if (filename == NULL) {
1932 Py_DECREF(prefix);
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001933 return NULL;
Victor Stinner2fd76e42011-03-14 15:19:39 -04001934 }
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001935
1936 if (Py_VerboseFlag > 1)
1937 PySys_FormatStderr("# trying %R\n", filename);
1938
Victor Stinnera1fe1f82011-09-23 18:59:08 +02001939 if (_Py_stat(filename, &statbuf) == 0 && /* it exists */
1940 S_ISDIR(statbuf.st_mode)) /* it's a directory */
1941 {
1942 Py_DECREF(filename);
1943 continue;
1944 }
1945
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001946 fp = _Py_fopen(filename, filemode);
1947 if (fp == NULL) {
1948 Py_DECREF(filename);
Victor Stinner925ef392011-06-20 15:01:10 +02001949 if (PyErr_Occurred()) {
1950 Py_DECREF(prefix);
1951 return NULL;
1952 }
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001953 continue;
1954 }
1955 match = case_ok(filename, -(Py_ssize_t)strlen(fdp->suffix), name);
1956 if (match < 0) {
Victor Stinner2fd76e42011-03-14 15:19:39 -04001957 Py_DECREF(prefix);
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001958 Py_DECREF(filename);
1959 return NULL;
1960 }
1961 if (match) {
Victor Stinner2fd76e42011-03-14 15:19:39 -04001962 Py_DECREF(prefix);
1963 *p_path = filename;
Victor Stinnerd0296212011-03-14 14:04:10 -04001964 *p_fp = fp;
1965 return fdp;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001966 }
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001967 Py_DECREF(filename);
Victor Stinnerd0296212011-03-14 14:04:10 -04001968
1969 fclose(fp);
1970 fp = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001971 }
Victor Stinner2fd76e42011-03-14 15:19:39 -04001972 Py_DECREF(prefix);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001973 }
Victor Stinnerd0296212011-03-14 14:04:10 -04001974 PyErr_Format(PyExc_ImportError,
Victor Stinner98dbba52011-03-14 15:15:47 -04001975 "No module named %R", name);
Victor Stinnerd0296212011-03-14 14:04:10 -04001976 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001977}
1978
Victor Stinner37580282011-03-20 01:34:43 +01001979/* Find a module:
1980
1981 - try find_module() of each sys.meta_path hook
1982 - try find_frozen()
1983 - try is_builtin()
1984 - try _PyWin_FindRegisteredModule() (Windows only)
1985 - otherwise, call find_module_path_list() with search_path_list (if not
1986 NULL) or sys.path
1987
Victor Stinner2fd76e42011-03-14 15:19:39 -04001988 fullname can be NULL, but only if p_loader is NULL.
1989
Victor Stinner37580282011-03-20 01:34:43 +01001990 Return:
1991
1992 - &fd_builtin (C_BUILTIN) if it is a builtin
1993 - &fd_frozen (PY_FROZEN) if it is frozen
Victor Stinner2fd76e42011-03-14 15:19:39 -04001994 - &fd_package (PKG_DIRECTORY) and write the filename into *p_path
Victor Stinner37580282011-03-20 01:34:43 +01001995 if it is a package
1996 - &importhookdescr (IMP_HOOK) and write the loader into *p_loader if a
1997 importer loader was found
1998 - a file descriptor (PY_SOURCE, PY_COMPILED, C_EXTENSION, PY_RESOURCE or
1999 PY_CODERESOURCE: see _PyImport_Filetab), write the filename into
Victor Stinner2fd76e42011-03-14 15:19:39 -04002000 *p_path and the pointer to the open file into *p_fp
Victor Stinner37580282011-03-20 01:34:43 +01002001 - NULL on error
2002
Victor Stinner2fd76e42011-03-14 15:19:39 -04002003 By default, *p_path, *p_fp and *p_loader (if set) are set to NULL.
2004 Eg. *p_path is set to NULL for a builtin package.
2005*/
Victor Stinner37580282011-03-20 01:34:43 +01002006
2007static struct filedescr *
Victor Stinnerad3c03b2011-03-14 09:21:33 -04002008find_module(PyObject *fullname, PyObject *name, PyObject *search_path_list,
Victor Stinner2fd76e42011-03-14 15:19:39 -04002009 PyObject **p_path, FILE **p_fp, PyObject **p_loader)
Victor Stinner37580282011-03-20 01:34:43 +01002010{
2011 Py_ssize_t i, npath;
2012 static struct filedescr fd_frozen = {"", "", PY_FROZEN};
2013 static struct filedescr fd_builtin = {"", "", C_BUILTIN};
2014 PyObject *path_hooks, *path_importer_cache;
Victor Stinner37580282011-03-20 01:34:43 +01002015
Victor Stinner2fd76e42011-03-14 15:19:39 -04002016 *p_path = NULL;
Victor Stinner37580282011-03-20 01:34:43 +01002017 *p_fp = NULL;
2018 if (p_loader != NULL)
2019 *p_loader = NULL;
2020
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002021 if (PyUnicode_GET_LENGTH(name) > MAXPATHLEN) {
2022 PyErr_SetString(PyExc_OverflowError,
2023 "module name is too long");
2024 return NULL;
2025 }
2026
Victor Stinner37580282011-03-20 01:34:43 +01002027 /* sys.meta_path import hook */
2028 if (p_loader != NULL) {
Martin v. Löwisbd928fe2011-10-14 10:20:37 +02002029 _Py_IDENTIFIER(find_module);
Victor Stinner37580282011-03-20 01:34:43 +01002030 PyObject *meta_path;
2031
2032 meta_path = PySys_GetObject("meta_path");
2033 if (meta_path == NULL || !PyList_Check(meta_path)) {
Victor Stinner16191322011-09-15 19:28:05 +02002034 PyErr_SetString(PyExc_RuntimeError,
Victor Stinner37580282011-03-20 01:34:43 +01002035 "sys.meta_path must be a list of "
2036 "import hooks");
2037 return NULL;
2038 }
2039 Py_INCREF(meta_path); /* zap guard */
2040 npath = PyList_Size(meta_path);
2041 for (i = 0; i < npath; i++) {
2042 PyObject *loader;
2043 PyObject *hook = PyList_GetItem(meta_path, i);
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002044 loader = _PyObject_CallMethodId(hook, &PyId_find_module,
Victor Stinnerad3c03b2011-03-14 09:21:33 -04002045 "OO", fullname,
Victor Stinner37580282011-03-20 01:34:43 +01002046 search_path_list != NULL ?
2047 search_path_list : Py_None);
2048 if (loader == NULL) {
2049 Py_DECREF(meta_path);
2050 return NULL; /* true error */
2051 }
2052 if (loader != Py_None) {
2053 /* a loader was found */
2054 *p_loader = loader;
2055 Py_DECREF(meta_path);
2056 return &importhookdescr;
2057 }
2058 Py_DECREF(loader);
2059 }
2060 Py_DECREF(meta_path);
2061 }
2062
Victor Stinnerdf75a022011-03-14 13:40:04 -04002063 if (find_frozen(fullname) != NULL)
Victor Stinnerad3c03b2011-03-14 09:21:33 -04002064 return &fd_frozen;
Victor Stinner37580282011-03-20 01:34:43 +01002065
2066 if (search_path_list == NULL) {
2067#ifdef MS_COREDLL
2068 FILE *fp;
2069 struct filedescr *fdp;
Victor Stinner37580282011-03-20 01:34:43 +01002070#endif
Victor Stinnerdf75a022011-03-14 13:40:04 -04002071 if (is_builtin(name))
Victor Stinner37580282011-03-20 01:34:43 +01002072 return &fd_builtin;
Victor Stinner37580282011-03-20 01:34:43 +01002073#ifdef MS_COREDLL
Victor Stinner2fd76e42011-03-14 15:19:39 -04002074 fp = _PyWin_FindRegisteredModule(name, &fdp, p_path);
Victor Stinner37580282011-03-20 01:34:43 +01002075 if (fp != NULL) {
Victor Stinner37580282011-03-20 01:34:43 +01002076 *p_fp = fp;
2077 return fdp;
2078 }
2079 else if (PyErr_Occurred())
2080 return NULL;
2081#endif
Victor Stinner37580282011-03-20 01:34:43 +01002082 search_path_list = PySys_GetObject("path");
2083 }
2084
2085 if (search_path_list == NULL || !PyList_Check(search_path_list)) {
Victor Stinner16191322011-09-15 19:28:05 +02002086 PyErr_SetString(PyExc_RuntimeError,
Victor Stinner37580282011-03-20 01:34:43 +01002087 "sys.path must be a list of directory names");
2088 return NULL;
2089 }
2090
2091 path_hooks = PySys_GetObject("path_hooks");
2092 if (path_hooks == NULL || !PyList_Check(path_hooks)) {
Victor Stinner16191322011-09-15 19:28:05 +02002093 PyErr_SetString(PyExc_RuntimeError,
Victor Stinner37580282011-03-20 01:34:43 +01002094 "sys.path_hooks must be a list of "
2095 "import hooks");
2096 return NULL;
2097 }
2098 path_importer_cache = PySys_GetObject("path_importer_cache");
2099 if (path_importer_cache == NULL ||
2100 !PyDict_Check(path_importer_cache)) {
Victor Stinner16191322011-09-15 19:28:05 +02002101 PyErr_SetString(PyExc_RuntimeError,
Victor Stinner37580282011-03-20 01:34:43 +01002102 "sys.path_importer_cache must be a dict");
2103 return NULL;
2104 }
2105
2106 return find_module_path_list(fullname, name,
2107 search_path_list, path_hooks,
2108 path_importer_cache,
Victor Stinner2fd76e42011-03-14 15:19:39 -04002109 p_path, p_fp, p_loader);
Victor Stinner37580282011-03-20 01:34:43 +01002110}
2111
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002112/* case_bytes(char* buf, Py_ssize_t len, Py_ssize_t namelen, char* name)
Tim Petersd1e87a82001-03-01 18:12:00 +00002113 * The arguments here are tricky, best shown by example:
2114 * /a/b/c/d/e/f/g/h/i/j/k/some_long_module_name.py\0
2115 * ^ ^ ^ ^
2116 * |--------------------- buf ---------------------|
2117 * |------------------- len ------------------|
2118 * |------ name -------|
2119 * |----- namelen -----|
2120 * buf is the full path, but len only counts up to (& exclusive of) the
2121 * extension. name is the module name, also exclusive of extension.
2122 *
2123 * We've already done a successful stat() or fopen() on buf, so know that
2124 * there's some match, possibly case-insensitive.
2125 *
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002126 * case_bytes() is to return 1 if there's a case-sensitive match for
2127 * name, else 0. case_bytes() is also to return 1 if envar PYTHONCASEOK
Tim Peters50d8d372001-02-28 05:34:27 +00002128 * exists.
Tim Petersd1e87a82001-03-01 18:12:00 +00002129 *
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002130 * case_bytes() is used to implement case-sensitive import semantics even
Tim Peters50d8d372001-02-28 05:34:27 +00002131 * on platforms with case-insensitive filesystems. It's trivial to implement
2132 * for case-sensitive filesystems. It's pretty much a cross-platform
2133 * nightmare for systems with case-insensitive filesystems.
2134 */
Guido van Rossum0980bd91998-02-13 17:18:36 +00002135
Tim Peters50d8d372001-02-28 05:34:27 +00002136/* First we may need a pile of platform-specific header files; the sequence
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002137 * of #if's here should match the sequence in the body of case_bytes().
Tim Peters50d8d372001-02-28 05:34:27 +00002138 */
Jason Tishler7961aa62005-05-20 00:56:54 +00002139#if defined(MS_WINDOWS)
Guido van Rossum0980bd91998-02-13 17:18:36 +00002140#include <windows.h>
Guido van Rossum4c3f57c2001-01-10 20:40:46 +00002141
Tim Peters50d8d372001-02-28 05:34:27 +00002142#elif defined(DJGPP)
2143#include <dir.h>
2144
Jason Tishler7961aa62005-05-20 00:56:54 +00002145#elif (defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) && defined(HAVE_DIRENT_H)
Tim Peters430f5d42001-03-01 01:30:56 +00002146#include <sys/types.h>
2147#include <dirent.h>
2148
Andrew MacIntyred9400542002-02-26 11:41:34 +00002149#elif defined(PYOS_OS2)
2150#define INCL_DOS
2151#define INCL_DOSERRORS
2152#define INCL_NOPMAPI
2153#include <os2.h>
Tim Peters50d8d372001-02-28 05:34:27 +00002154#endif
2155
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002156#if defined(DJGPP) \
2157 || ((defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) \
2158 && defined(HAVE_DIRENT_H)) \
2159 || defined(PYOS_OS2)
2160# define USE_CASE_OK_BYTES
2161#endif
2162
2163
2164#ifdef USE_CASE_OK_BYTES
Guido van Rossum0980bd91998-02-13 17:18:36 +00002165static int
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002166case_bytes(char *buf, Py_ssize_t len, Py_ssize_t namelen, const char *name)
Guido van Rossum0980bd91998-02-13 17:18:36 +00002167{
Tim Peters50d8d372001-02-28 05:34:27 +00002168/* Pick a platform-specific implementation; the sequence of #if's here should
2169 * match the sequence just above.
2170 */
2171
Tim Peters50d8d372001-02-28 05:34:27 +00002172/* DJGPP */
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002173#if defined(DJGPP)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002174 struct ffblk ffblk;
2175 int done;
Tim Peters50d8d372001-02-28 05:34:27 +00002176
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002177 if (Py_GETENV("PYTHONCASEOK") != NULL)
2178 return 1;
Tim Peters50d8d372001-02-28 05:34:27 +00002179
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002180 done = findfirst(buf, &ffblk, FA_ARCH|FA_RDONLY|FA_HIDDEN|FA_DIREC);
2181 if (done) {
2182 PyErr_Format(PyExc_NameError,
2183 "Can't find file for module %.100s\n(filename %.300s)",
2184 name, buf);
Victor Stinner9c61e242011-03-22 01:22:27 +01002185 return -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002186 }
2187 return strncmp(ffblk.ff_name, name, namelen) == 0;
Guido van Rossum0980bd91998-02-13 17:18:36 +00002188
Jason Tishler7961aa62005-05-20 00:56:54 +00002189/* new-fangled macintosh (macosx) or Cygwin */
2190#elif (defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) && defined(HAVE_DIRENT_H)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002191 DIR *dirp;
2192 struct dirent *dp;
2193 char dirname[MAXPATHLEN + 1];
2194 const int dirlen = len - namelen - 1; /* don't want trailing SEP */
Tim Peters430f5d42001-03-01 01:30:56 +00002195
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002196 if (Py_GETENV("PYTHONCASEOK") != NULL)
2197 return 1;
Tim Petersdbe6ebb2001-03-01 08:47:29 +00002198
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002199 /* Copy the dir component into dirname; substitute "." if empty */
2200 if (dirlen <= 0) {
2201 dirname[0] = '.';
2202 dirname[1] = '\0';
2203 }
2204 else {
2205 assert(dirlen <= MAXPATHLEN);
2206 memcpy(dirname, buf, dirlen);
2207 dirname[dirlen] = '\0';
2208 }
2209 /* Open the directory and search the entries for an exact match. */
2210 dirp = opendir(dirname);
2211 if (dirp) {
2212 char *nameWithExt = buf + len - namelen;
2213 while ((dp = readdir(dirp)) != NULL) {
2214 const int thislen =
Tim Peters430f5d42001-03-01 01:30:56 +00002215#ifdef _DIRENT_HAVE_D_NAMELEN
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002216 dp->d_namlen;
Tim Peters430f5d42001-03-01 01:30:56 +00002217#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002218 strlen(dp->d_name);
Tim Peters430f5d42001-03-01 01:30:56 +00002219#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002220 if (thislen >= namelen &&
2221 strcmp(dp->d_name, nameWithExt) == 0) {
2222 (void)closedir(dirp);
2223 return 1; /* Found */
2224 }
2225 }
2226 (void)closedir(dirp);
2227 }
2228 return 0 ; /* Not found */
Tim Peters430f5d42001-03-01 01:30:56 +00002229
Andrew MacIntyred9400542002-02-26 11:41:34 +00002230/* OS/2 */
2231#elif defined(PYOS_OS2)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002232 HDIR hdir = 1;
2233 ULONG srchcnt = 1;
2234 FILEFINDBUF3 ffbuf;
2235 APIRET rc;
Andrew MacIntyred9400542002-02-26 11:41:34 +00002236
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002237 if (Py_GETENV("PYTHONCASEOK") != NULL)
2238 return 1;
Andrew MacIntyred9400542002-02-26 11:41:34 +00002239
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002240 rc = DosFindFirst(buf,
2241 &hdir,
2242 FILE_READONLY | FILE_HIDDEN | FILE_SYSTEM | FILE_DIRECTORY,
2243 &ffbuf, sizeof(ffbuf),
2244 &srchcnt,
2245 FIL_STANDARD);
2246 if (rc != NO_ERROR)
2247 return 0;
2248 return strncmp(ffbuf.achName, name, namelen) == 0;
Andrew MacIntyred9400542002-02-26 11:41:34 +00002249
Tim Peters50d8d372001-02-28 05:34:27 +00002250/* assuming it's a case-sensitive filesystem, so there's nothing to do! */
2251#else
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002252# error "USE_CASE_OK_BYTES is not correctly defined"
2253#endif
2254}
2255#endif
2256
2257/*
2258 * Check if a filename case matchs the name case. We've already done a
2259 * successful stat() or fopen() on buf, so know that there's some match,
2260 * possibly case-insensitive.
2261 *
2262 * case_ok() is to return 1 if there's a case-sensitive match for name, 0 if it
2263 * the filename doesn't match, or -1 on error. case_ok() is also to return 1
2264 * if envar PYTHONCASEOK exists.
2265 *
2266 * case_ok() is used to implement case-sensitive import semantics even
2267 * on platforms with case-insensitive filesystems. It's trivial to implement
2268 * for case-sensitive filesystems. It's pretty much a cross-platform
2269 * nightmare for systems with case-insensitive filesystems.
2270 */
2271
2272static int
2273case_ok(PyObject *filename, Py_ssize_t prefix_delta, PyObject *name)
2274{
2275#ifdef MS_WINDOWS
2276 WIN32_FIND_DATAW data;
2277 HANDLE h;
2278 int cmp;
Victor Stinnerbeac78b2011-10-11 21:55:01 +02002279 wchar_t *wname;
Victor Stinner8c981892011-10-11 22:27:13 +02002280 Py_ssize_t wname_len;
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002281
2282 if (Py_GETENV("PYTHONCASEOK") != NULL)
2283 return 1;
2284
2285 h = FindFirstFileW(PyUnicode_AS_UNICODE(filename), &data);
2286 if (h == INVALID_HANDLE_VALUE) {
2287 PyErr_Format(PyExc_NameError,
2288 "Can't find file for module %R\n(filename %R)",
2289 name, filename);
2290 return 0;
2291 }
2292 FindClose(h);
Victor Stinnerbeac78b2011-10-11 21:55:01 +02002293
2294 wname = PyUnicode_AsUnicodeAndSize(name, &wname_len);
2295 if (wname == NULL)
2296 return -1;
2297
2298 cmp = wcsncmp(data.cFileName, wname, wname_len);
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002299 return cmp == 0;
2300#elif defined(USE_CASE_OK_BYTES)
2301 int match;
2302 PyObject *filebytes, *namebytes;
2303 filebytes = PyUnicode_EncodeFSDefault(filename);
2304 if (filebytes == NULL)
2305 return -1;
2306 namebytes = PyUnicode_EncodeFSDefault(name);
2307 if (namebytes == NULL) {
2308 Py_DECREF(filebytes);
2309 return -1;
2310 }
2311 match = case_bytes(
2312 PyBytes_AS_STRING(filebytes),
2313 PyBytes_GET_SIZE(filebytes) + prefix_delta,
Victor Stinner1304f2d2011-03-20 04:28:55 +01002314 PyBytes_GET_SIZE(namebytes),
2315 PyBytes_AS_STRING(namebytes));
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002316 Py_DECREF(filebytes);
2317 Py_DECREF(namebytes);
2318 return match;
2319#else
2320 /* assuming it's a case-sensitive filesystem, so there's nothing to do! */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002321 return 1;
Guido van Rossum0980bd91998-02-13 17:18:36 +00002322
Guido van Rossum4d1b3b91998-02-13 23:27:59 +00002323#endif
Tim Peters50d8d372001-02-28 05:34:27 +00002324}
Guido van Rossum4d1b3b91998-02-13 23:27:59 +00002325
Guido van Rossum197346f1997-10-31 18:38:52 +00002326#ifdef HAVE_STAT
Victor Stinner4f4402c2010-08-14 14:50:26 +00002327
Victor Stinner547a2a62011-03-20 03:07:28 +01002328/* Helper to look for __init__.py or __init__.py[co] in potential package.
2329 Return 1 if __init__ was found, 0 if not, or -1 on error. */
Guido van Rossum197346f1997-10-31 18:38:52 +00002330static int
Victor Stinner547a2a62011-03-20 03:07:28 +01002331find_init_module(PyObject *directory)
Guido van Rossum197346f1997-10-31 18:38:52 +00002332{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002333 struct stat statbuf;
Victor Stinner547a2a62011-03-20 03:07:28 +01002334 PyObject *filename;
2335 int match;
Guido van Rossum197346f1997-10-31 18:38:52 +00002336
Victor Stinner547a2a62011-03-20 03:07:28 +01002337 filename = PyUnicode_FromFormat("%U%c__init__.py", directory, SEP);
2338 if (filename == NULL)
2339 return -1;
2340 if (_Py_stat(filename, &statbuf) == 0) {
Victor Stinnercc9564e2011-03-20 04:58:29 +01002341 /* 3=len(".py") */
2342 match = case_ok(filename, -3, initstr);
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002343 if (match < 0) {
2344 Py_DECREF(filename);
2345 return -1;
2346 }
2347 if (match) {
Victor Stinner547a2a62011-03-20 03:07:28 +01002348 Py_DECREF(filename);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002349 return 1;
2350 }
2351 }
Victor Stinner547a2a62011-03-20 03:07:28 +01002352 Py_DECREF(filename);
2353
2354 filename = PyUnicode_FromFormat("%U%c__init__.py%c",
2355 directory, SEP, Py_OptimizeFlag ? 'o' : 'c');
2356 if (filename == NULL)
2357 return -1;
2358 if (_Py_stat(filename, &statbuf) == 0) {
Victor Stinnercc9564e2011-03-20 04:58:29 +01002359 /* 4=len(".pyc") */
2360 match = case_ok(filename, -4, initstr);
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002361 if (match < 0) {
2362 Py_DECREF(filename);
2363 return -1;
2364 }
2365 if (match) {
Victor Stinner547a2a62011-03-20 03:07:28 +01002366 Py_DECREF(filename);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002367 return 1;
2368 }
2369 }
Victor Stinner547a2a62011-03-20 03:07:28 +01002370 Py_DECREF(filename);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002371 return 0;
Guido van Rossum197346f1997-10-31 18:38:52 +00002372}
Guido van Rossum48a680c2001-03-02 06:34:14 +00002373
Guido van Rossum197346f1997-10-31 18:38:52 +00002374#endif /* HAVE_STAT */
2375
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002376
Victor Stinner95872862011-03-07 18:20:56 +01002377static int init_builtin(PyObject *); /* Forward */
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002378
Victor Stinner44c6c152010-08-09 00:59:10 +00002379static PyObject*
Victor Stinner95872862011-03-07 18:20:56 +01002380load_builtin(PyObject *name, int type)
Victor Stinner44c6c152010-08-09 00:59:10 +00002381{
2382 PyObject *m, *modules;
2383 int err;
2384
Victor Stinner44c6c152010-08-09 00:59:10 +00002385 if (type == C_BUILTIN)
2386 err = init_builtin(name);
2387 else
Victor Stinner95872862011-03-07 18:20:56 +01002388 err = PyImport_ImportFrozenModuleObject(name);
Victor Stinner44c6c152010-08-09 00:59:10 +00002389 if (err < 0)
2390 return NULL;
2391 if (err == 0) {
2392 PyErr_Format(PyExc_ImportError,
Victor Stinner95872862011-03-07 18:20:56 +01002393 "Purported %s module %R not found",
2394 type == C_BUILTIN ? "builtin" : "frozen",
Victor Stinner44c6c152010-08-09 00:59:10 +00002395 name);
2396 return NULL;
2397 }
2398
2399 modules = PyImport_GetModuleDict();
Victor Stinner95872862011-03-07 18:20:56 +01002400 m = PyDict_GetItem(modules, name);
Victor Stinner44c6c152010-08-09 00:59:10 +00002401 if (m == NULL) {
2402 PyErr_Format(
2403 PyExc_ImportError,
Victor Stinner95872862011-03-07 18:20:56 +01002404 "%s module %R not properly initialized",
2405 type == C_BUILTIN ? "builtin" : "frozen",
Victor Stinner44c6c152010-08-09 00:59:10 +00002406 name);
2407 return NULL;
2408 }
2409 Py_INCREF(m);
2410 return m;
2411}
2412
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002413/* Load an external module using the default search path and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00002414 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002415
Guido van Rossum79f25d91997-04-29 20:08:16 +00002416static PyObject *
Victor Stinner41c5fec2011-03-13 21:46:30 -04002417load_module(PyObject *name, FILE *fp, PyObject *pathname, int type, PyObject *loader)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002418{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002419 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002420
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002421 /* First check that there's an open file (if we need one) */
2422 switch (type) {
2423 case PY_SOURCE:
2424 case PY_COMPILED:
2425 if (fp == NULL) {
2426 PyErr_Format(PyExc_ValueError,
Victor Stinner41c5fec2011-03-13 21:46:30 -04002427 "file object required for import (type code %d)",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002428 type);
2429 return NULL;
2430 }
2431 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002432
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002433 switch (type) {
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002434
Victor Stinner41c5fec2011-03-13 21:46:30 -04002435 case PY_SOURCE:
2436 m = load_source_module(name, pathname, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002437 break;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002438
Victor Stinner41c5fec2011-03-13 21:46:30 -04002439 case PY_COMPILED:
2440 m = load_compiled_module(name, pathname, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002441 break;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002442
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002443#ifdef HAVE_DYNAMIC_LOADING
Victor Stinner41c5fec2011-03-13 21:46:30 -04002444 case C_EXTENSION:
2445 m = _PyImport_LoadDynamicModule(name, pathname, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002446 break;
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002447#endif
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002448
Victor Stinner41c5fec2011-03-13 21:46:30 -04002449 case PKG_DIRECTORY:
2450 m = load_package(name, pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002451 break;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002452
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002453 case C_BUILTIN:
Victor Stinner41c5fec2011-03-13 21:46:30 -04002454 case PY_FROZEN:
2455 m = load_builtin(name, type);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002456 break;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002457
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002458 case IMP_HOOK: {
Martin v. Löwisbd928fe2011-10-14 10:20:37 +02002459 _Py_IDENTIFIER(load_module);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002460 if (loader == NULL) {
2461 PyErr_SetString(PyExc_ImportError,
2462 "import hook without loader");
2463 return NULL;
2464 }
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002465 m = _PyObject_CallMethodId(loader, &PyId_load_module, "O", name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002466 break;
2467 }
Just van Rossum52e14d62002-12-30 22:08:05 +00002468
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002469 default:
2470 PyErr_Format(PyExc_ImportError,
Victor Stinner98dbba52011-03-14 15:15:47 -04002471 "Don't know how to import %R (type code %d)",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002472 name, type);
2473 m = NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002474
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002475 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002476
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002477 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002478}
2479
2480
2481/* Initialize a built-in module.
Thomas Wouters89f507f2006-12-13 04:49:30 +00002482 Return 1 for success, 0 if the module is not found, and -1 with
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002483 an exception set if the initialization failed. */
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002484
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002485static int
Victor Stinner95872862011-03-07 18:20:56 +01002486init_builtin(PyObject *name)
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002487{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002488 struct _inittab *p;
Guido van Rossum25ce5661997-08-02 03:10:38 +00002489
Victor Stinner95872862011-03-07 18:20:56 +01002490 if (_PyImport_FindExtensionObject(name, name) != NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002491 return 1;
Guido van Rossum25ce5661997-08-02 03:10:38 +00002492
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002493 for (p = PyImport_Inittab; p->name != NULL; p++) {
2494 PyObject *mod;
Victor Stinner95872862011-03-07 18:20:56 +01002495 if (PyUnicode_CompareWithASCIIString(name, p->name) == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002496 if (p->initfunc == NULL) {
2497 PyErr_Format(PyExc_ImportError,
Victor Stinner95872862011-03-07 18:20:56 +01002498 "Cannot re-init internal module %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002499 name);
2500 return -1;
2501 }
2502 if (Py_VerboseFlag)
Victor Stinner95872862011-03-07 18:20:56 +01002503 PySys_FormatStderr("import %U # builtin\n", name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002504 mod = (*p->initfunc)();
2505 if (mod == 0)
2506 return -1;
Victor Stinner95872862011-03-07 18:20:56 +01002507 if (_PyImport_FixupExtensionObject(mod, name, name) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002508 return -1;
2509 /* FixupExtension has put the module into sys.modules,
2510 so we can release our own reference. */
2511 Py_DECREF(mod);
2512 return 1;
2513 }
2514 }
2515 return 0;
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002516}
Guido van Rossumf56e3db1993-04-01 20:59:32 +00002517
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002518
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002519/* Frozen modules */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002520
Guido van Rossumcfd0a221996-06-17 17:06:34 +00002521static struct _frozen *
Victor Stinner53dc7352011-03-20 01:50:21 +01002522find_frozen(PyObject *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002523{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002524 struct _frozen *p;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002525
Victor Stinner53dc7352011-03-20 01:50:21 +01002526 if (name == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002527 return NULL;
Benjamin Petersond968e272008-11-05 22:48:33 +00002528
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002529 for (p = PyImport_FrozenModules; ; p++) {
2530 if (p->name == NULL)
2531 return NULL;
Victor Stinner53dc7352011-03-20 01:50:21 +01002532 if (PyUnicode_CompareWithASCIIString(name, p->name) == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002533 break;
2534 }
2535 return p;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002536}
2537
Guido van Rossum79f25d91997-04-29 20:08:16 +00002538static PyObject *
Victor Stinner53dc7352011-03-20 01:50:21 +01002539get_frozen_object(PyObject *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002540{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002541 struct _frozen *p = find_frozen(name);
2542 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002543
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002544 if (p == NULL) {
2545 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002546 "No such frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002547 name);
2548 return NULL;
2549 }
2550 if (p->code == NULL) {
2551 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002552 "Excluded frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002553 name);
2554 return NULL;
2555 }
2556 size = p->size;
2557 if (size < 0)
2558 size = -size;
2559 return PyMarshal_ReadObjectFromString((char *)p->code, size);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002560}
2561
Brett Cannon8d110132009-03-15 02:20:16 +00002562static PyObject *
Victor Stinner53dc7352011-03-20 01:50:21 +01002563is_frozen_package(PyObject *name)
Brett Cannon8d110132009-03-15 02:20:16 +00002564{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002565 struct _frozen *p = find_frozen(name);
2566 int size;
Brett Cannon8d110132009-03-15 02:20:16 +00002567
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002568 if (p == NULL) {
2569 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002570 "No such frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002571 name);
2572 return NULL;
2573 }
Brett Cannon8d110132009-03-15 02:20:16 +00002574
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002575 size = p->size;
Brett Cannon8d110132009-03-15 02:20:16 +00002576
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002577 if (size < 0)
2578 Py_RETURN_TRUE;
2579 else
2580 Py_RETURN_FALSE;
Brett Cannon8d110132009-03-15 02:20:16 +00002581}
2582
2583
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002584/* Initialize a frozen module.
Brett Cannon3c2ac442009-03-08 20:49:47 +00002585 Return 1 for success, 0 if the module is not found, and -1 with
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002586 an exception set if the initialization failed.
2587 This function is also used from frozenmain.c */
Guido van Rossum0b344901995-02-07 15:35:27 +00002588
2589int
Victor Stinner53dc7352011-03-20 01:50:21 +01002590PyImport_ImportFrozenModuleObject(PyObject *name)
Guido van Rossumf56e3db1993-04-01 20:59:32 +00002591{
Victor Stinner53dc7352011-03-20 01:50:21 +01002592 struct _frozen *p;
2593 PyObject *co, *m, *path;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002594 int ispackage;
2595 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002596
Victor Stinner53dc7352011-03-20 01:50:21 +01002597 p = find_frozen(name);
2598
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002599 if (p == NULL)
2600 return 0;
2601 if (p->code == NULL) {
2602 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002603 "Excluded frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002604 name);
2605 return -1;
2606 }
2607 size = p->size;
2608 ispackage = (size < 0);
2609 if (ispackage)
2610 size = -size;
2611 if (Py_VerboseFlag)
Victor Stinner53dc7352011-03-20 01:50:21 +01002612 PySys_FormatStderr("import %U # frozen%s\n",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002613 name, ispackage ? " package" : "");
2614 co = PyMarshal_ReadObjectFromString((char *)p->code, size);
2615 if (co == NULL)
2616 return -1;
2617 if (!PyCode_Check(co)) {
2618 PyErr_Format(PyExc_TypeError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002619 "frozen object %R is not a code object",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002620 name);
2621 goto err_return;
2622 }
2623 if (ispackage) {
2624 /* Set __path__ to the package name */
Victor Stinner53dc7352011-03-20 01:50:21 +01002625 PyObject *d, *l;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002626 int err;
Victor Stinner53dc7352011-03-20 01:50:21 +01002627 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002628 if (m == NULL)
2629 goto err_return;
2630 d = PyModule_GetDict(m);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002631 l = PyList_New(1);
2632 if (l == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002633 goto err_return;
2634 }
Victor Stinner53dc7352011-03-20 01:50:21 +01002635 Py_INCREF(name);
2636 PyList_SET_ITEM(l, 0, name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002637 err = PyDict_SetItemString(d, "__path__", l);
2638 Py_DECREF(l);
2639 if (err != 0)
2640 goto err_return;
2641 }
Victor Stinner53dc7352011-03-20 01:50:21 +01002642 path = PyUnicode_FromString("<frozen>");
2643 if (path == NULL)
2644 goto err_return;
2645 m = PyImport_ExecCodeModuleObject(name, co, path, NULL);
2646 Py_DECREF(path);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002647 if (m == NULL)
2648 goto err_return;
2649 Py_DECREF(co);
2650 Py_DECREF(m);
2651 return 1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002652err_return:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002653 Py_DECREF(co);
2654 return -1;
Guido van Rossumf56e3db1993-04-01 20:59:32 +00002655}
Guido van Rossum74e6a111994-08-29 12:54:38 +00002656
Victor Stinner53dc7352011-03-20 01:50:21 +01002657int
2658PyImport_ImportFrozenModule(char *name)
2659{
2660 PyObject *nameobj;
2661 int ret;
2662 nameobj = PyUnicode_InternFromString(name);
2663 if (nameobj == NULL)
2664 return -1;
2665 ret = PyImport_ImportFrozenModuleObject(nameobj);
2666 Py_DECREF(nameobj);
2667 return ret;
2668}
2669
Guido van Rossum74e6a111994-08-29 12:54:38 +00002670
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002671/* Import a module, either built-in, frozen, or external, and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00002672 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum74e6a111994-08-29 12:54:38 +00002673
Guido van Rossum79f25d91997-04-29 20:08:16 +00002674PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00002675PyImport_ImportModule(const char *name)
Guido van Rossum74e6a111994-08-29 12:54:38 +00002676{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002677 PyObject *pname;
2678 PyObject *result;
Marc-André Lemburg3c61c352001-02-09 19:40:15 +00002679
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002680 pname = PyUnicode_FromString(name);
2681 if (pname == NULL)
2682 return NULL;
2683 result = PyImport_Import(pname);
2684 Py_DECREF(pname);
2685 return result;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002686}
2687
Christian Heimes072c0f12008-01-03 23:01:04 +00002688/* Import a module without blocking
2689 *
2690 * At first it tries to fetch the module from sys.modules. If the module was
2691 * never loaded before it loads it with PyImport_ImportModule() unless another
2692 * thread holds the import lock. In the latter case the function raises an
2693 * ImportError instead of blocking.
2694 *
2695 * Returns the module object with incremented ref count.
2696 */
2697PyObject *
2698PyImport_ImportModuleNoBlock(const char *name)
2699{
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002700 PyObject *nameobj, *modules, *result;
Victor Stinner0af03062011-09-02 00:11:43 +02002701#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002702 long me;
Victor Stinner0af03062011-09-02 00:11:43 +02002703#endif
Christian Heimes072c0f12008-01-03 23:01:04 +00002704
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002705 /* Try to get the module from sys.modules[name] */
2706 modules = PyImport_GetModuleDict();
2707 if (modules == NULL)
2708 return NULL;
Christian Heimes072c0f12008-01-03 23:01:04 +00002709
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002710 nameobj = PyUnicode_FromString(name);
2711 if (nameobj == NULL)
2712 return NULL;
2713 result = PyDict_GetItem(modules, nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002714 if (result != NULL) {
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002715 Py_DECREF(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002716 Py_INCREF(result);
2717 return result;
2718 }
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002719 PyErr_Clear();
Benjamin Peterson3e4f0552008-09-02 00:31:15 +00002720#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002721 /* check the import lock
2722 * me might be -1 but I ignore the error here, the lock function
2723 * takes care of the problem */
2724 me = PyThread_get_thread_ident();
2725 if (import_lock_thread == -1 || import_lock_thread == me) {
2726 /* no thread or me is holding the lock */
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002727 result = PyImport_Import(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002728 }
2729 else {
2730 PyErr_Format(PyExc_ImportError,
Victor Stinnerc24c8102011-03-13 22:38:06 -04002731 "Failed to import %R because the import lock"
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002732 "is held by another thread.",
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002733 nameobj);
2734 result = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002735 }
Benjamin Peterson3e4f0552008-09-02 00:31:15 +00002736#else
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002737 result = PyImport_Import(nameobj);
Benjamin Peterson3e4f0552008-09-02 00:31:15 +00002738#endif
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002739 Py_DECREF(nameobj);
2740 return result;
Christian Heimes072c0f12008-01-03 23:01:04 +00002741}
2742
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002743/* Forward declarations for helper routines */
Victor Stinner974389d2011-03-15 09:33:57 +01002744static PyObject *get_parent(PyObject *globals,
2745 PyObject **p_name,
2746 int level);
Tim Petersdbd9ba62000-07-09 03:09:57 +00002747static PyObject *load_next(PyObject *mod, PyObject *altmod,
Victor Stinner974389d2011-03-15 09:33:57 +01002748 PyObject *inputname, PyObject **p_outputname,
Martin v. Löwisf45dee92011-10-30 23:50:02 +01002749 PyObject **p_prefix);
Victor Stinner974389d2011-03-15 09:33:57 +01002750static int mark_miss(PyObject *name);
Tim Petersdbd9ba62000-07-09 03:09:57 +00002751static int ensure_fromlist(PyObject *mod, PyObject *fromlist,
Victor Stinner974389d2011-03-15 09:33:57 +01002752 PyObject *buf, int recursive);
2753static PyObject * import_submodule(PyObject *mod, PyObject *name,
2754 PyObject *fullname);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002755
2756/* The Magnum Opus of dotted-name import :-) */
2757
Guido van Rossum75acc9c1998-03-03 22:26:50 +00002758static PyObject *
Victor Stinner974389d2011-03-15 09:33:57 +01002759import_module_level(PyObject *name, PyObject *globals, PyObject *locals,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002760 PyObject *fromlist, int level)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002761{
Martin v. Löwisf45dee92011-10-30 23:50:02 +01002762 PyObject *parent, *next, *inputname, *outputname;
2763 PyObject *head = NULL;
2764 PyObject *tail = NULL;
2765 PyObject *prefix = NULL;
2766 PyObject *result = NULL;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002767 Py_ssize_t sep, altsep;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002768
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002769 if (PyUnicode_READY(name))
2770 return NULL;
Victor Stinner974389d2011-03-15 09:33:57 +01002771
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002772 sep = PyUnicode_FindChar(name, SEP, 0, PyUnicode_GET_LENGTH(name), 1);
2773 if (sep == -2)
2774 return NULL;
Victor Stinner974389d2011-03-15 09:33:57 +01002775#ifdef ALTSEP
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002776 altsep = PyUnicode_FindChar(name, ALTSEP, 0, PyUnicode_GET_LENGTH(name), 1);
2777 if (altsep == -2)
2778 return NULL;
2779#else
2780 altsep = -1;
Christian Heimes454f37b2008-01-10 00:10:02 +00002781#endif
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002782 if (sep != -1 || altsep != -1)
2783 {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002784 PyErr_SetString(PyExc_ImportError,
2785 "Import by filename is not supported.");
2786 return NULL;
2787 }
Christian Heimes454f37b2008-01-10 00:10:02 +00002788
Martin v. Löwisf45dee92011-10-30 23:50:02 +01002789 parent = get_parent(globals, &prefix, level);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002790 if (parent == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002791 return NULL;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002792 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002793
Martin v. Löwisf45dee92011-10-30 23:50:02 +01002794 if (PyUnicode_READY(prefix))
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002795 return NULL;
Victor Stinner974389d2011-03-15 09:33:57 +01002796
2797 head = load_next(parent, level < 0 ? Py_None : parent, name, &outputname,
Martin v. Löwisf45dee92011-10-30 23:50:02 +01002798 &prefix);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002799 if (head == NULL)
Martin v. Löwisf45dee92011-10-30 23:50:02 +01002800 goto out;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002801
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002802 tail = head;
2803 Py_INCREF(tail);
Victor Stinner974389d2011-03-15 09:33:57 +01002804
2805 if (outputname != NULL) {
2806 while (1) {
2807 inputname = outputname;
2808 next = load_next(tail, tail, inputname, &outputname,
Martin v. Löwisf45dee92011-10-30 23:50:02 +01002809 &prefix);
2810 Py_CLEAR(tail);
2811 Py_CLEAR(inputname);
2812 if (next == NULL)
2813 goto out;
Victor Stinner974389d2011-03-15 09:33:57 +01002814 tail = next;
2815
2816 if (outputname == NULL) {
2817 break;
2818 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002819 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002820 }
2821 if (tail == Py_None) {
2822 /* If tail is Py_None, both get_parent and load_next found
2823 an empty module name: someone called __import__("") or
2824 doctored faulty bytecode */
Victor Stinner974389d2011-03-15 09:33:57 +01002825 PyErr_SetString(PyExc_ValueError, "Empty module name");
Martin v. Löwisf45dee92011-10-30 23:50:02 +01002826 goto out;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002827 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002828
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002829 if (fromlist != NULL) {
2830 if (fromlist == Py_None || !PyObject_IsTrue(fromlist))
2831 fromlist = NULL;
2832 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002833
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002834 if (fromlist == NULL) {
Martin v. Löwisf45dee92011-10-30 23:50:02 +01002835 result = head;
2836 Py_INCREF(result);
2837 goto out;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002838 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002839
Martin v. Löwisf45dee92011-10-30 23:50:02 +01002840 if (!ensure_fromlist(tail, fromlist, prefix, 0))
2841 goto out;
2842
2843 result = tail;
2844 Py_INCREF(result);
2845 out:
2846 Py_XDECREF(head);
2847 Py_XDECREF(tail);
2848 Py_XDECREF(prefix);
2849 return result;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002850}
2851
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002852PyObject *
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002853PyImport_ImportModuleLevelObject(PyObject *name, PyObject *globals,
2854 PyObject *locals, PyObject *fromlist,
2855 int level)
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002856{
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002857 PyObject *mod;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002858 _PyImport_AcquireLock();
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002859 mod = import_module_level(name, globals, locals, fromlist, level);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002860 if (_PyImport_ReleaseLock() < 0) {
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002861 Py_XDECREF(mod);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002862 PyErr_SetString(PyExc_RuntimeError,
2863 "not holding the import lock");
2864 return NULL;
2865 }
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002866 return mod;
Guido van Rossum75acc9c1998-03-03 22:26:50 +00002867}
2868
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002869PyObject *
Benjamin Peterson04778a82011-05-25 09:29:00 -05002870PyImport_ImportModuleLevel(const char *name, PyObject *globals, PyObject *locals,
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002871 PyObject *fromlist, int level)
2872{
2873 PyObject *nameobj, *mod;
2874 nameobj = PyUnicode_FromString(name);
2875 if (nameobj == NULL)
2876 return NULL;
2877 mod = PyImport_ImportModuleLevelObject(nameobj, globals, locals,
2878 fromlist, level);
2879 Py_DECREF(nameobj);
2880 return mod;
2881}
2882
2883
Fred Drake87590902004-05-28 20:21:36 +00002884/* Return the package that an import is being performed in. If globals comes
2885 from the module foo.bar.bat (not itself a package), this returns the
2886 sys.modules entry for foo.bar. If globals is from a package's __init__.py,
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00002887 the package's entry in sys.modules is returned, as a borrowed reference.
Fred Drake87590902004-05-28 20:21:36 +00002888
Victor Stinner974389d2011-03-15 09:33:57 +01002889 The name of the returned package is returned in *p_name.
Fred Drake87590902004-05-28 20:21:36 +00002890
2891 If globals doesn't come from a package or a module in a package, or a
2892 corresponding entry is not found in sys.modules, Py_None is returned.
2893*/
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002894static PyObject *
Victor Stinner9599de52011-03-13 22:38:38 -04002895get_parent(PyObject *globals, PyObject **p_name, int level)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002896{
Victor Stinner974389d2011-03-15 09:33:57 +01002897 PyObject *nameobj;
2898
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002899 static PyObject *namestr = NULL;
2900 static PyObject *pathstr = NULL;
2901 static PyObject *pkgstr = NULL;
2902 PyObject *pkgname, *modname, *modpath, *modules, *parent;
2903 int orig_level = level;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002904
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002905 if (globals == NULL || !PyDict_Check(globals) || !level)
Victor Stinner974389d2011-03-15 09:33:57 +01002906 goto return_none;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002907
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002908 if (namestr == NULL) {
2909 namestr = PyUnicode_InternFromString("__name__");
2910 if (namestr == NULL)
2911 return NULL;
2912 }
2913 if (pathstr == NULL) {
2914 pathstr = PyUnicode_InternFromString("__path__");
2915 if (pathstr == NULL)
2916 return NULL;
2917 }
2918 if (pkgstr == NULL) {
2919 pkgstr = PyUnicode_InternFromString("__package__");
2920 if (pkgstr == NULL)
2921 return NULL;
2922 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002923
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002924 pkgname = PyDict_GetItem(globals, pkgstr);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002925
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002926 if ((pkgname != NULL) && (pkgname != Py_None)) {
2927 /* __package__ is set, so use it */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002928 if (!PyUnicode_Check(pkgname)) {
2929 PyErr_SetString(PyExc_ValueError,
2930 "__package__ set to non-string");
2931 return NULL;
2932 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002933 if (PyUnicode_GET_LENGTH(pkgname) == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002934 if (level > 0) {
2935 PyErr_SetString(PyExc_ValueError,
2936 "Attempted relative import in non-package");
2937 return NULL;
2938 }
Victor Stinner974389d2011-03-15 09:33:57 +01002939 goto return_none;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002940 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002941 Py_INCREF(pkgname);
2942 nameobj = pkgname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002943 } else {
2944 /* __package__ not set, so figure it out and set it */
2945 modname = PyDict_GetItem(globals, namestr);
2946 if (modname == NULL || !PyUnicode_Check(modname))
Victor Stinner974389d2011-03-15 09:33:57 +01002947 goto return_none;
Brett Cannon9a5b25a2010-03-01 02:09:17 +00002948
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002949 modpath = PyDict_GetItem(globals, pathstr);
2950 if (modpath != NULL) {
2951 /* __path__ is set, so modname is already the package name */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002952 int error;
Alexandre Vassalottia85998a2008-05-03 18:24:43 +00002953
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002954 error = PyDict_SetItem(globals, pkgstr, modname);
2955 if (error) {
2956 PyErr_SetString(PyExc_ValueError,
2957 "Could not set __package__");
2958 return NULL;
2959 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002960 Py_INCREF(modname);
2961 nameobj = modname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002962 } else {
2963 /* Normal module, so work out the package name if any */
Victor Stinner974389d2011-03-15 09:33:57 +01002964 Py_ssize_t len;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002965 len = PyUnicode_FindChar(modname, '.',
2966 0, PyUnicode_GET_LENGTH(modname), -1);
2967 if (len == -2)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002968 return NULL;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002969 if (len < 0) {
2970 if (level > 0) {
2971 PyErr_SetString(PyExc_ValueError,
2972 "Attempted relative import in non-package");
2973 return NULL;
2974 }
2975 if (PyDict_SetItem(globals, pkgstr, Py_None)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002976 PyErr_SetString(PyExc_ValueError,
2977 "Could not set __package__");
2978 return NULL;
2979 }
Victor Stinner974389d2011-03-15 09:33:57 +01002980 goto return_none;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002981 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002982 pkgname = PyUnicode_Substring(modname, 0, len);
2983 if (pkgname == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002984 return NULL;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002985 if (PyDict_SetItem(globals, pkgstr, pkgname)) {
2986 Py_DECREF(pkgname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002987 PyErr_SetString(PyExc_ValueError,
2988 "Could not set __package__");
2989 return NULL;
2990 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002991 nameobj = pkgname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002992 }
2993 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002994 if (level > 1) {
2995 Py_ssize_t dot, end = PyUnicode_GET_LENGTH(nameobj);
2996 PyObject *newname;
2997 while (--level > 0) {
2998 dot = PyUnicode_FindChar(nameobj, '.', 0, end, -1);
2999 if (dot == -2) {
3000 Py_DECREF(nameobj);
3001 return NULL;
3002 }
3003 if (dot < 0) {
3004 Py_DECREF(nameobj);
3005 PyErr_SetString(PyExc_ValueError,
3006 "Attempted relative import beyond "
3007 "toplevel package");
3008 return NULL;
3009 }
3010 end = dot;
3011 }
3012 newname = PyUnicode_Substring(nameobj, 0, end);
3013 Py_DECREF(nameobj);
3014 if (newname == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003015 return NULL;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003016 nameobj = newname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003017 }
Victor Stinner974389d2011-03-15 09:33:57 +01003018
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003019 modules = PyImport_GetModuleDict();
Victor Stinner974389d2011-03-15 09:33:57 +01003020 parent = PyDict_GetItem(modules, nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003021 if (parent == NULL) {
Victor Stinner974389d2011-03-15 09:33:57 +01003022 int err;
3023
3024 if (orig_level >= 1) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003025 PyErr_Format(PyExc_SystemError,
Victor Stinner974389d2011-03-15 09:33:57 +01003026 "Parent module %R not loaded, "
3027 "cannot perform relative import", nameobj);
3028 Py_DECREF(nameobj);
3029 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003030 }
Victor Stinner974389d2011-03-15 09:33:57 +01003031
3032 err = PyErr_WarnFormat(
3033 PyExc_RuntimeWarning, 1,
3034 "Parent module %R not found while handling absolute import",
3035 nameobj);
3036 Py_DECREF(nameobj);
3037 if (err)
3038 return NULL;
3039
3040 goto return_none;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003041 }
Victor Stinner974389d2011-03-15 09:33:57 +01003042 *p_name = nameobj;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003043 return parent;
3044 /* We expect, but can't guarantee, if parent != None, that:
Victor Stinner974389d2011-03-15 09:33:57 +01003045 - parent.__name__ == name
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003046 - parent.__dict__ is globals
3047 If this is violated... Who cares? */
Victor Stinner974389d2011-03-15 09:33:57 +01003048
3049return_none:
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003050 nameobj = PyUnicode_New(0, 0);
Victor Stinner974389d2011-03-15 09:33:57 +01003051 if (nameobj == NULL)
3052 return NULL;
3053 *p_name = nameobj;
3054 return Py_None;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003055}
3056
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003057/* altmod is either None or same as mod */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003058static PyObject *
Victor Stinner974389d2011-03-15 09:33:57 +01003059load_next(PyObject *mod, PyObject *altmod,
3060 PyObject *inputname, PyObject **p_outputname,
Martin v. Löwisf45dee92011-10-30 23:50:02 +01003061 PyObject **p_prefix)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003062{
Martin v. Löwisf45dee92011-10-30 23:50:02 +01003063 Py_ssize_t dot;
Victor Stinner974389d2011-03-15 09:33:57 +01003064 Py_ssize_t len;
Martin v. Löwisf45dee92011-10-30 23:50:02 +01003065 PyObject *fullname, *name = NULL, *result;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003066
Victor Stinner974389d2011-03-15 09:33:57 +01003067 *p_outputname = NULL;
3068
Martin v. Löwisf45dee92011-10-30 23:50:02 +01003069 len = PyUnicode_GET_LENGTH(inputname);
3070 if (len == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003071 /* completely empty module name should only happen in
3072 'from . import' (or '__import__("")')*/
3073 Py_INCREF(mod);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003074 return mod;
3075 }
Thomas Woutersf7f438b2006-02-28 16:09:29 +00003076
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003077
Martin v. Löwisf45dee92011-10-30 23:50:02 +01003078 dot = PyUnicode_FindChar(inputname, '.', 0, len, 1);
3079 if (dot >= 0) {
3080 len = dot;
Victor Stinner974389d2011-03-15 09:33:57 +01003081 if (len == 0) {
3082 PyErr_SetString(PyExc_ValueError,
3083 "Empty module name");
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003084 goto error;
Victor Stinner974389d2011-03-15 09:33:57 +01003085 }
3086 }
Victor Stinner974389d2011-03-15 09:33:57 +01003087
Martin v. Löwisf45dee92011-10-30 23:50:02 +01003088 /* name = inputname[:len] */
3089 name = PyUnicode_Substring(inputname, 0, len);
3090 if (name == NULL)
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003091 goto error;
Martin v. Löwisf45dee92011-10-30 23:50:02 +01003092
3093 if (PyUnicode_GET_LENGTH(*p_prefix)) {
3094 /* fullname = prefix + "." + name */
3095 fullname = PyUnicode_FromFormat("%U.%U", *p_prefix, name);
3096 if (fullname == NULL)
3097 goto error;
3098 }
3099 else {
3100 fullname = name;
3101 Py_INCREF(fullname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003102 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003103
Victor Stinner974389d2011-03-15 09:33:57 +01003104 result = import_submodule(mod, name, fullname);
Martin v. Löwisf45dee92011-10-30 23:50:02 +01003105 Py_DECREF(*p_prefix);
3106 /* Transfer reference. */
3107 *p_prefix = fullname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003108 if (result == Py_None && altmod != mod) {
3109 Py_DECREF(result);
3110 /* Here, altmod must be None and mod must not be None */
Victor Stinner974389d2011-03-15 09:33:57 +01003111 result = import_submodule(altmod, name, name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003112 if (result != NULL && result != Py_None) {
Martin v. Löwisf45dee92011-10-30 23:50:02 +01003113 if (mark_miss(*p_prefix) != 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003114 Py_DECREF(result);
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003115 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003116 }
Martin v. Löwisf45dee92011-10-30 23:50:02 +01003117 Py_DECREF(*p_prefix);
3118 *p_prefix = name;
3119 Py_INCREF(*p_prefix);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003120 }
3121 }
3122 if (result == NULL)
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003123 goto error;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003124
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003125 if (result == Py_None) {
3126 Py_DECREF(result);
3127 PyErr_Format(PyExc_ImportError,
Victor Stinner974389d2011-03-15 09:33:57 +01003128 "No module named %R", inputname);
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003129 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003130 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003131
Martin v. Löwisf45dee92011-10-30 23:50:02 +01003132 if (dot >= 0) {
3133 *p_outputname = PyUnicode_Substring(inputname, dot+1,
3134 PyUnicode_GET_LENGTH(inputname));
Victor Stinner974389d2011-03-15 09:33:57 +01003135 if (*p_outputname == NULL) {
3136 Py_DECREF(result);
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003137 goto error;
Victor Stinner974389d2011-03-15 09:33:57 +01003138 }
3139 }
3140
Martin v. Löwisf45dee92011-10-30 23:50:02 +01003141 Py_DECREF(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003142 return result;
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003143
3144error:
Martin v. Löwisf45dee92011-10-30 23:50:02 +01003145 Py_XDECREF(name);
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003146 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003147}
3148
3149static int
Victor Stinner974389d2011-03-15 09:33:57 +01003150mark_miss(PyObject *name)
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00003151{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003152 PyObject *modules = PyImport_GetModuleDict();
Victor Stinner974389d2011-03-15 09:33:57 +01003153 return PyDict_SetItem(modules, name, Py_None);
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00003154}
3155
3156static int
Victor Stinner974389d2011-03-15 09:33:57 +01003157ensure_fromlist(PyObject *mod, PyObject *fromlist, PyObject *name,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003158 int recursive)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003159{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003160 int i;
Victor Stinner974389d2011-03-15 09:33:57 +01003161 PyObject *fullname;
3162 Py_ssize_t fromlist_len;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003163
Martin v. Löwis1ee1b6f2011-10-10 18:11:30 +02003164 if (!_PyObject_HasAttrId(mod, &PyId___path__))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003165 return 1;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003166
Victor Stinner974389d2011-03-15 09:33:57 +01003167 fromlist_len = PySequence_Size(fromlist);
3168
3169 for (i = 0; i < fromlist_len; i++) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003170 PyObject *item = PySequence_GetItem(fromlist, i);
3171 int hasit;
Victor Stinner974389d2011-03-15 09:33:57 +01003172 if (item == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003173 return 0;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003174 if (!PyUnicode_Check(item)) {
3175 PyErr_SetString(PyExc_TypeError,
3176 "Item in ``from list'' not a string");
3177 Py_DECREF(item);
3178 return 0;
3179 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003180 if (PyUnicode_READ_CHAR(item, 0) == '*') {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003181 PyObject *all;
Martin v. Löwisbd928fe2011-10-14 10:20:37 +02003182 _Py_IDENTIFIER(__all__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003183 Py_DECREF(item);
3184 /* See if the package defines __all__ */
3185 if (recursive)
3186 continue; /* Avoid endless recursion */
Martin v. Löwis1ee1b6f2011-10-10 18:11:30 +02003187 all = _PyObject_GetAttrId(mod, &PyId___all__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003188 if (all == NULL)
3189 PyErr_Clear();
3190 else {
Victor Stinner974389d2011-03-15 09:33:57 +01003191 int ret = ensure_fromlist(mod, all, name, 1);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003192 Py_DECREF(all);
3193 if (!ret)
3194 return 0;
3195 }
3196 continue;
3197 }
3198 hasit = PyObject_HasAttr(mod, item);
3199 if (!hasit) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003200 PyObject *submod;
Victor Stinner974389d2011-03-15 09:33:57 +01003201 fullname = PyUnicode_FromFormat("%U.%U", name, item);
3202 if (fullname != NULL) {
3203 submod = import_submodule(mod, item, fullname);
3204 Py_DECREF(fullname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003205 }
Victor Stinner974389d2011-03-15 09:33:57 +01003206 else
3207 submod = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003208 Py_XDECREF(submod);
3209 if (submod == NULL) {
3210 Py_DECREF(item);
3211 return 0;
3212 }
3213 }
3214 Py_DECREF(item);
3215 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003216
Victor Stinner974389d2011-03-15 09:33:57 +01003217 return 1;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003218}
3219
Neil Schemenauer00b09662003-06-16 21:03:07 +00003220static int
Victor Stinner974389d2011-03-15 09:33:57 +01003221add_submodule(PyObject *mod, PyObject *submod, PyObject *fullname,
3222 PyObject *subname, PyObject *modules)
Neil Schemenauer00b09662003-06-16 21:03:07 +00003223{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003224 if (mod == Py_None)
3225 return 1;
3226 /* Irrespective of the success of this load, make a
3227 reference to it in the parent package module. A copy gets
3228 saved in the modules dictionary under the full name, so get a
3229 reference from there, if need be. (The exception is when the
3230 load failed with a SyntaxError -- then there's no trace in
3231 sys.modules. In that case, of course, do nothing extra.) */
3232 if (submod == NULL) {
Victor Stinner974389d2011-03-15 09:33:57 +01003233 submod = PyDict_GetItem(modules, fullname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003234 if (submod == NULL)
3235 return 1;
3236 }
3237 if (PyModule_Check(mod)) {
3238 /* We can't use setattr here since it can give a
3239 * spurious warning if the submodule name shadows a
3240 * builtin name */
3241 PyObject *dict = PyModule_GetDict(mod);
3242 if (!dict)
3243 return 0;
Victor Stinner974389d2011-03-15 09:33:57 +01003244 if (PyDict_SetItem(dict, subname, submod) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003245 return 0;
3246 }
3247 else {
Victor Stinner974389d2011-03-15 09:33:57 +01003248 if (PyObject_SetAttr(mod, subname, submod) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003249 return 0;
3250 }
3251 return 1;
Neil Schemenauer00b09662003-06-16 21:03:07 +00003252}
3253
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003254static PyObject *
Victor Stinner974389d2011-03-15 09:33:57 +01003255import_submodule(PyObject *mod, PyObject *subname, PyObject *fullname)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003256{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003257 PyObject *modules = PyImport_GetModuleDict();
Victor Stinner533d7832011-03-14 13:22:54 -04003258 PyObject *m = NULL, *bufobj, *path_list, *loader;
Victor Stinner9599de52011-03-13 22:38:38 -04003259 struct filedescr *fdp;
3260 FILE *fp;
Guido van Rossum74e6a111994-08-29 12:54:38 +00003261
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003262 /* Require:
3263 if mod == None: subname == fullname
3264 else: mod.__name__ + "." + subname == fullname
3265 */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003266
Victor Stinner974389d2011-03-15 09:33:57 +01003267 if ((m = PyDict_GetItem(modules, fullname)) != NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003268 Py_INCREF(m);
Victor Stinner9599de52011-03-13 22:38:38 -04003269 return m;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003270 }
Victor Stinner9599de52011-03-13 22:38:38 -04003271
3272 if (mod == Py_None)
Victor Stinner533d7832011-03-14 13:22:54 -04003273 path_list = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003274 else {
Martin v. Löwis1ee1b6f2011-10-10 18:11:30 +02003275 path_list = _PyObject_GetAttrId(mod, &PyId___path__);
Victor Stinner533d7832011-03-14 13:22:54 -04003276 if (path_list == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003277 PyErr_Clear();
3278 Py_INCREF(Py_None);
3279 return Py_None;
3280 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003281 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003282
Victor Stinner533d7832011-03-14 13:22:54 -04003283 fdp = find_module(fullname, subname, path_list,
Victor Stinner2fd76e42011-03-14 15:19:39 -04003284 &bufobj, &fp, &loader);
Victor Stinner533d7832011-03-14 13:22:54 -04003285 Py_XDECREF(path_list);
Victor Stinner9599de52011-03-13 22:38:38 -04003286 if (fdp == NULL) {
3287 if (!PyErr_ExceptionMatches(PyExc_ImportError))
3288 return NULL;
3289 PyErr_Clear();
3290 Py_INCREF(Py_None);
3291 return Py_None;
3292 }
Victor Stinner2fd76e42011-03-14 15:19:39 -04003293 m = load_module(fullname, fp, bufobj, fdp->type, loader);
3294 Py_XDECREF(bufobj);
Victor Stinner9599de52011-03-13 22:38:38 -04003295 Py_XDECREF(loader);
3296 if (fp)
3297 fclose(fp);
3298 if (m == NULL)
3299 return NULL;
3300 if (!add_submodule(mod, m, fullname, subname, modules)) {
3301 Py_XDECREF(m);
3302 return NULL;
3303 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003304 return m;
Guido van Rossum74e6a111994-08-29 12:54:38 +00003305}
3306
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003307
3308/* Re-import a module of any kind and return its module object, WITH
3309 INCREMENTED REFERENCE COUNT */
3310
Guido van Rossum79f25d91997-04-29 20:08:16 +00003311PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003312PyImport_ReloadModule(PyObject *m)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003313{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003314 PyInterpreterState *interp = PyThreadState_Get()->interp;
3315 PyObject *modules_reloading = interp->modules_reloading;
3316 PyObject *modules = PyImport_GetModuleDict();
Victor Stinner533d7832011-03-14 13:22:54 -04003317 PyObject *path_list = NULL, *loader = NULL, *existing_m = NULL;
Martin v. Löwis796ea532011-10-30 09:07:07 +01003318 PyObject *name, *bufobj, *subname;
3319 Py_ssize_t subname_start;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003320 struct filedescr *fdp;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003321 FILE *fp = NULL;
3322 PyObject *newm = NULL;
Brett Cannon9a5b25a2010-03-01 02:09:17 +00003323
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003324 if (modules_reloading == NULL) {
3325 Py_FatalError("PyImport_ReloadModule: "
3326 "no modules_reloading dictionary!");
3327 return NULL;
3328 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003329
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003330 if (m == NULL || !PyModule_Check(m)) {
3331 PyErr_SetString(PyExc_TypeError,
3332 "reload() argument must be module");
3333 return NULL;
3334 }
Martin v. Löwis796ea532011-10-30 09:07:07 +01003335 name = PyModule_GetNameObject(m);
3336 if (name == NULL || PyUnicode_READY(name) == -1)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003337 return NULL;
Martin v. Löwis796ea532011-10-30 09:07:07 +01003338 if (m != PyDict_GetItem(modules, name)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003339 PyErr_Format(PyExc_ImportError,
Victor Stinner98dbba52011-03-14 15:15:47 -04003340 "reload(): module %R not in sys.modules",
Martin v. Löwis796ea532011-10-30 09:07:07 +01003341 name);
3342 Py_DECREF(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003343 return NULL;
3344 }
Martin v. Löwis796ea532011-10-30 09:07:07 +01003345 existing_m = PyDict_GetItem(modules_reloading, name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003346 if (existing_m != NULL) {
3347 /* Due to a recursive reload, this module is already
3348 being reloaded. */
Martin v. Löwis796ea532011-10-30 09:07:07 +01003349 Py_DECREF(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003350 Py_INCREF(existing_m);
3351 return existing_m;
3352 }
Martin v. Löwis796ea532011-10-30 09:07:07 +01003353 if (PyDict_SetItem(modules_reloading, name, m) < 0) {
3354 Py_DECREF(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003355 return NULL;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003356 }
Guido van Rossumd8faa362007-04-27 19:54:29 +00003357
Martin v. Löwis796ea532011-10-30 09:07:07 +01003358 subname_start = PyUnicode_FindChar(name, '.', 0,
3359 PyUnicode_GET_LENGTH(name), -1);
3360 if (subname_start == -1) {
3361 Py_INCREF(name);
3362 subname = name;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003363 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003364 else {
3365 PyObject *parentname, *parent;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003366 Py_ssize_t len;
Martin v. Löwis796ea532011-10-30 09:07:07 +01003367 parentname = PyUnicode_Substring(name, 0, subname_start);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003368 if (parentname == NULL) {
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003369 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003370 }
3371 parent = PyDict_GetItem(modules, parentname);
3372 if (parent == NULL) {
3373 PyErr_Format(PyExc_ImportError,
Victor Stinner98dbba52011-03-14 15:15:47 -04003374 "reload(): parent %R not in sys.modules",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003375 parentname);
3376 Py_DECREF(parentname);
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003377 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003378 }
3379 Py_DECREF(parentname);
Martin v. Löwis1ee1b6f2011-10-10 18:11:30 +02003380 path_list = _PyObject_GetAttrId(parent, &PyId___path__);
Victor Stinner533d7832011-03-14 13:22:54 -04003381 if (path_list == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003382 PyErr_Clear();
Martin v. Löwis796ea532011-10-30 09:07:07 +01003383 subname_start++;
3384 len = PyUnicode_GET_LENGTH(name) - (subname_start + 1);
3385 subname = PyUnicode_Substring(name, subname_start, len);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003386 }
Martin v. Löwis796ea532011-10-30 09:07:07 +01003387 if (subname == NULL)
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003388 goto error;
Martin v. Löwis796ea532011-10-30 09:07:07 +01003389 fdp = find_module(name, subname, path_list,
Victor Stinner2fd76e42011-03-14 15:19:39 -04003390 &bufobj, &fp, &loader);
Martin v. Löwis796ea532011-10-30 09:07:07 +01003391 Py_DECREF(subname);
Victor Stinner533d7832011-03-14 13:22:54 -04003392 Py_XDECREF(path_list);
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00003393
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003394 if (fdp == NULL) {
3395 Py_XDECREF(loader);
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003396 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003397 }
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00003398
Martin v. Löwis796ea532011-10-30 09:07:07 +01003399 newm = load_module(name, fp, bufobj, fdp->type, loader);
Victor Stinner2fd76e42011-03-14 15:19:39 -04003400 Py_XDECREF(bufobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003401 Py_XDECREF(loader);
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00003402
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003403 if (fp)
3404 fclose(fp);
3405 if (newm == NULL) {
3406 /* load_module probably removed name from modules because of
3407 * the error. Put back the original module object. We're
3408 * going to return NULL in this case regardless of whether
3409 * replacing name succeeds, so the return value is ignored.
3410 */
Martin v. Löwis796ea532011-10-30 09:07:07 +01003411 PyDict_SetItem(modules, name, m);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003412 }
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003413
3414error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003415 imp_modules_reloading_clear();
Martin v. Löwis796ea532011-10-30 09:07:07 +01003416 Py_DECREF(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003417 return newm;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003418}
3419
3420
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003421/* Higher-level import emulator which emulates the "import" statement
3422 more accurately -- it invokes the __import__() function from the
3423 builtins of the current globals. This means that the import is
3424 done using whatever import hooks are installed in the current
Brett Cannonbc2eff32010-09-19 21:39:02 +00003425 environment.
Guido van Rossum6058eb41998-12-21 19:51:00 +00003426 A dummy list ["__doc__"] is passed as the 4th argument so that
Neal Norwitz80e7f272007-08-26 06:45:23 +00003427 e.g. PyImport_Import(PyUnicode_FromString("win32com.client.gencache"))
Guido van Rossum6058eb41998-12-21 19:51:00 +00003428 will return <module "gencache"> instead of <module "win32com">. */
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003429
3430PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003431PyImport_Import(PyObject *module_name)
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003432{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003433 static PyObject *silly_list = NULL;
3434 static PyObject *builtins_str = NULL;
3435 static PyObject *import_str = NULL;
3436 PyObject *globals = NULL;
3437 PyObject *import = NULL;
3438 PyObject *builtins = NULL;
Brett Cannonbc2eff32010-09-19 21:39:02 +00003439 PyObject *modules = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003440 PyObject *r = NULL;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003441
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003442 /* Initialize constant string objects */
3443 if (silly_list == NULL) {
3444 import_str = PyUnicode_InternFromString("__import__");
3445 if (import_str == NULL)
3446 return NULL;
3447 builtins_str = PyUnicode_InternFromString("__builtins__");
3448 if (builtins_str == NULL)
3449 return NULL;
Brett Cannonbc2eff32010-09-19 21:39:02 +00003450 silly_list = PyList_New(0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003451 if (silly_list == NULL)
3452 return NULL;
3453 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003454
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003455 /* Get the builtins from current globals */
3456 globals = PyEval_GetGlobals();
3457 if (globals != NULL) {
3458 Py_INCREF(globals);
3459 builtins = PyObject_GetItem(globals, builtins_str);
3460 if (builtins == NULL)
3461 goto err;
3462 }
3463 else {
3464 /* No globals -- use standard builtins, and fake globals */
3465 builtins = PyImport_ImportModuleLevel("builtins",
3466 NULL, NULL, NULL, 0);
3467 if (builtins == NULL)
3468 return NULL;
3469 globals = Py_BuildValue("{OO}", builtins_str, builtins);
3470 if (globals == NULL)
3471 goto err;
3472 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003473
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003474 /* Get the __import__ function from the builtins */
3475 if (PyDict_Check(builtins)) {
3476 import = PyObject_GetItem(builtins, import_str);
3477 if (import == NULL)
3478 PyErr_SetObject(PyExc_KeyError, import_str);
3479 }
3480 else
3481 import = PyObject_GetAttr(builtins, import_str);
3482 if (import == NULL)
3483 goto err;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003484
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003485 /* Call the __import__ function with the proper argument list
Brett Cannonbc2eff32010-09-19 21:39:02 +00003486 Always use absolute import here.
3487 Calling for side-effect of import. */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003488 r = PyObject_CallFunction(import, "OOOOi", module_name, globals,
3489 globals, silly_list, 0, NULL);
Brett Cannonbc2eff32010-09-19 21:39:02 +00003490 if (r == NULL)
3491 goto err;
3492 Py_DECREF(r);
3493
3494 modules = PyImport_GetModuleDict();
3495 r = PyDict_GetItem(modules, module_name);
3496 if (r != NULL)
3497 Py_INCREF(r);
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003498
3499 err:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003500 Py_XDECREF(globals);
3501 Py_XDECREF(builtins);
3502 Py_XDECREF(import);
Tim Peters50d8d372001-02-28 05:34:27 +00003503
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003504 return r;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003505}
3506
3507
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003508/* Module 'imp' provides Python access to the primitives used for
3509 importing modules.
3510*/
3511
Guido van Rossum79f25d91997-04-29 20:08:16 +00003512static PyObject *
Barry Warsaw28a691b2010-04-17 00:19:56 +00003513imp_make_magic(long magic)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003514{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003515 char buf[4];
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003516
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003517 buf[0] = (char) ((magic >> 0) & 0xff);
3518 buf[1] = (char) ((magic >> 8) & 0xff);
3519 buf[2] = (char) ((magic >> 16) & 0xff);
3520 buf[3] = (char) ((magic >> 24) & 0xff);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003521
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003522 return PyBytes_FromStringAndSize(buf, 4);
Victor Stinner3e2b7172010-11-09 09:32:19 +00003523}
Barry Warsaw28a691b2010-04-17 00:19:56 +00003524
3525static PyObject *
3526imp_get_magic(PyObject *self, PyObject *noargs)
3527{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003528 return imp_make_magic(pyc_magic);
Barry Warsaw28a691b2010-04-17 00:19:56 +00003529}
3530
3531static PyObject *
3532imp_get_tag(PyObject *self, PyObject *noargs)
3533{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003534 return PyUnicode_FromString(pyc_tag);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003535}
3536
Guido van Rossum79f25d91997-04-29 20:08:16 +00003537static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +00003538imp_get_suffixes(PyObject *self, PyObject *noargs)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003539{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003540 PyObject *list;
3541 struct filedescr *fdp;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003542
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003543 list = PyList_New(0);
3544 if (list == NULL)
3545 return NULL;
3546 for (fdp = _PyImport_Filetab; fdp->suffix != NULL; fdp++) {
3547 PyObject *item = Py_BuildValue("ssi",
3548 fdp->suffix, fdp->mode, fdp->type);
3549 if (item == NULL) {
3550 Py_DECREF(list);
3551 return NULL;
3552 }
3553 if (PyList_Append(list, item) < 0) {
3554 Py_DECREF(list);
3555 Py_DECREF(item);
3556 return NULL;
3557 }
3558 Py_DECREF(item);
3559 }
3560 return list;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003561}
3562
Guido van Rossum79f25d91997-04-29 20:08:16 +00003563static PyObject *
Victor Stinner533d7832011-03-14 13:22:54 -04003564call_find_module(PyObject *name, PyObject *path_list)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003565{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003566 extern int fclose(FILE *);
3567 PyObject *fob, *ret;
3568 PyObject *pathobj;
3569 struct filedescr *fdp;
Victor Stinner7d8b77c2011-03-12 08:45:02 -05003570 FILE *fp;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003571 int fd = -1;
3572 char *found_encoding = NULL;
3573 char *encoding = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003574
Victor Stinner533d7832011-03-14 13:22:54 -04003575 if (path_list == Py_None)
3576 path_list = NULL;
3577 fdp = find_module(NULL, name, path_list,
Victor Stinner2fd76e42011-03-14 15:19:39 -04003578 &pathobj, &fp, NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003579 if (fdp == NULL)
3580 return NULL;
3581 if (fp != NULL) {
3582 fd = fileno(fp);
3583 if (fd != -1)
3584 fd = dup(fd);
3585 fclose(fp);
Victor Stinnerd417d012011-06-20 15:16:55 +02003586 if (fd == -1) {
3587 PyErr_SetFromErrno(PyExc_OSError);
3588 return NULL;
3589 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003590 fp = NULL;
3591 }
3592 if (fd != -1) {
3593 if (strchr(fdp->mode, 'b') == NULL) {
Victor Stinnerfe7c5b52011-04-05 01:48:03 +02003594 /* PyTokenizer_FindEncodingFilename() returns PyMem_MALLOC'ed
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003595 memory. */
Victor Stinnerfe7c5b52011-04-05 01:48:03 +02003596 found_encoding = PyTokenizer_FindEncodingFilename(fd, pathobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003597 lseek(fd, 0, 0); /* Reset position */
Victor Stinner2fd76e42011-03-14 15:19:39 -04003598 if (found_encoding == NULL && PyErr_Occurred()) {
3599 Py_XDECREF(pathobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003600 return NULL;
Victor Stinner2fd76e42011-03-14 15:19:39 -04003601 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003602 encoding = (found_encoding != NULL) ? found_encoding :
3603 (char*)PyUnicode_GetDefaultEncoding();
3604 }
Victor Stinner2fd76e42011-03-14 15:19:39 -04003605 fob = PyFile_FromFd(fd, NULL, fdp->mode, -1,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003606 (char*)encoding, NULL, NULL, 1);
3607 if (fob == NULL) {
Victor Stinner2fd76e42011-03-14 15:19:39 -04003608 Py_XDECREF(pathobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003609 close(fd);
3610 PyMem_FREE(found_encoding);
3611 return NULL;
3612 }
3613 }
3614 else {
3615 fob = Py_None;
3616 Py_INCREF(fob);
3617 }
Victor Stinner2fd76e42011-03-14 15:19:39 -04003618 if (pathobj == NULL) {
3619 Py_INCREF(Py_None);
3620 pathobj = Py_None;
3621 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003622 ret = Py_BuildValue("NN(ssi)",
3623 fob, pathobj, fdp->suffix, fdp->mode, fdp->type);
3624 PyMem_FREE(found_encoding);
Brett Cannon3bb42d92007-10-20 03:43:15 +00003625
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003626 return ret;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003627}
3628
Guido van Rossum79f25d91997-04-29 20:08:16 +00003629static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003630imp_find_module(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003631{
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003632 PyObject *name, *path_list = NULL;
3633 if (!PyArg_ParseTuple(args, "U|O:find_module",
3634 &name, &path_list))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003635 return NULL;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003636 return call_find_module(name, path_list);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003637}
3638
3639static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003640imp_init_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003641{
Victor Stinner95872862011-03-07 18:20:56 +01003642 PyObject *name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003643 int ret;
3644 PyObject *m;
Victor Stinner95872862011-03-07 18:20:56 +01003645 if (!PyArg_ParseTuple(args, "U:init_builtin", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003646 return NULL;
3647 ret = init_builtin(name);
3648 if (ret < 0)
3649 return NULL;
3650 if (ret == 0) {
3651 Py_INCREF(Py_None);
3652 return Py_None;
3653 }
Victor Stinner95872862011-03-07 18:20:56 +01003654 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003655 Py_XINCREF(m);
3656 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003657}
3658
Guido van Rossum79f25d91997-04-29 20:08:16 +00003659static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003660imp_init_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003661{
Victor Stinner53dc7352011-03-20 01:50:21 +01003662 PyObject *name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003663 int ret;
3664 PyObject *m;
Victor Stinner53dc7352011-03-20 01:50:21 +01003665 if (!PyArg_ParseTuple(args, "U:init_frozen", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003666 return NULL;
Victor Stinner53dc7352011-03-20 01:50:21 +01003667 ret = PyImport_ImportFrozenModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003668 if (ret < 0)
3669 return NULL;
3670 if (ret == 0) {
3671 Py_INCREF(Py_None);
3672 return Py_None;
3673 }
Victor Stinner53dc7352011-03-20 01:50:21 +01003674 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003675 Py_XINCREF(m);
3676 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003677}
3678
Guido van Rossum79f25d91997-04-29 20:08:16 +00003679static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003680imp_get_frozen_object(PyObject *self, PyObject *args)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00003681{
Victor Stinner53dc7352011-03-20 01:50:21 +01003682 PyObject *name;
Jack Jansen95ffa231995-10-03 14:38:41 +00003683
Victor Stinner53dc7352011-03-20 01:50:21 +01003684 if (!PyArg_ParseTuple(args, "U:get_frozen_object", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003685 return NULL;
3686 return get_frozen_object(name);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00003687}
3688
Guido van Rossum79f25d91997-04-29 20:08:16 +00003689static PyObject *
Brett Cannon8d110132009-03-15 02:20:16 +00003690imp_is_frozen_package(PyObject *self, PyObject *args)
3691{
Victor Stinner53dc7352011-03-20 01:50:21 +01003692 PyObject *name;
Brett Cannon8d110132009-03-15 02:20:16 +00003693
Victor Stinner53dc7352011-03-20 01:50:21 +01003694 if (!PyArg_ParseTuple(args, "U:is_frozen_package", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003695 return NULL;
3696 return is_frozen_package(name);
Brett Cannon8d110132009-03-15 02:20:16 +00003697}
3698
3699static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003700imp_is_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003701{
Victor Stinner95872862011-03-07 18:20:56 +01003702 PyObject *name;
3703 if (!PyArg_ParseTuple(args, "U:is_builtin", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003704 return NULL;
3705 return PyLong_FromLong(is_builtin(name));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003706}
3707
Guido van Rossum79f25d91997-04-29 20:08:16 +00003708static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003709imp_is_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003710{
Victor Stinner53dc7352011-03-20 01:50:21 +01003711 PyObject *name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003712 struct _frozen *p;
Victor Stinner53dc7352011-03-20 01:50:21 +01003713 if (!PyArg_ParseTuple(args, "U:is_frozen", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003714 return NULL;
3715 p = find_frozen(name);
3716 return PyBool_FromLong((long) (p == NULL ? 0 : p->size));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003717}
3718
3719static FILE *
Victor Stinner2f42ae52011-03-20 00:41:24 +01003720get_file(PyObject *pathname, PyObject *fob, char *mode)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003721{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003722 FILE *fp;
3723 if (mode[0] == 'U')
3724 mode = "r" PY_STDIOTEXTMODE;
3725 if (fob == NULL) {
Victor Stinner2f42ae52011-03-20 00:41:24 +01003726 fp = _Py_fopen(pathname, mode);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003727 }
3728 else {
3729 int fd = PyObject_AsFileDescriptor(fob);
3730 if (fd == -1)
3731 return NULL;
3732 if (!_PyVerify_fd(fd))
3733 goto error;
3734 /* the FILE struct gets a new fd, so that it can be closed
3735 * independently of the file descriptor given
3736 */
3737 fd = dup(fd);
3738 if (fd == -1)
3739 goto error;
3740 fp = fdopen(fd, mode);
3741 }
3742 if (fp)
3743 return fp;
Kristján Valur Jónssone1b04452009-03-31 17:43:39 +00003744error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003745 PyErr_SetFromErrno(PyExc_IOError);
3746 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003747}
3748
Guido van Rossum79f25d91997-04-29 20:08:16 +00003749static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003750imp_load_compiled(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003751{
Victor Stinner2f42ae52011-03-20 00:41:24 +01003752 PyObject *name, *pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003753 PyObject *fob = NULL;
3754 PyObject *m;
3755 FILE *fp;
Victor Stinner2f42ae52011-03-20 00:41:24 +01003756 if (!PyArg_ParseTuple(args, "UO&|O:load_compiled",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003757 &name,
Victor Stinner2f42ae52011-03-20 00:41:24 +01003758 PyUnicode_FSDecoder, &pathname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003759 &fob))
3760 return NULL;
Victor Stinner2f42ae52011-03-20 00:41:24 +01003761 fp = get_file(pathname, fob, "rb");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003762 if (fp == NULL) {
Victor Stinnerebc00522010-12-03 17:06:43 +00003763 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003764 return NULL;
3765 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01003766 m = load_compiled_module(name, pathname, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003767 fclose(fp);
Victor Stinnerebc00522010-12-03 17:06:43 +00003768 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003769 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003770}
3771
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003772#ifdef HAVE_DYNAMIC_LOADING
3773
Guido van Rossum79f25d91997-04-29 20:08:16 +00003774static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003775imp_load_dynamic(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003776{
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003777 PyObject *name, *pathname, *fob = NULL, *mod;
3778 FILE *fp;
3779
3780 if (!PyArg_ParseTuple(args, "UO&|O:load_dynamic",
3781 &name, PyUnicode_FSDecoder, &pathname, &fob))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003782 return NULL;
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003783 if (fob != NULL) {
3784 fp = get_file(NULL, fob, "r");
Victor Stinnere9ddbf62011-03-22 10:46:35 +01003785 if (fp == NULL) {
3786 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003787 return NULL;
Victor Stinnere9ddbf62011-03-22 10:46:35 +01003788 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003789 }
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003790 else
3791 fp = NULL;
3792 mod = _PyImport_LoadDynamicModule(name, pathname, fp);
Victor Stinnere9ddbf62011-03-22 10:46:35 +01003793 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003794 if (fp)
3795 fclose(fp);
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003796 return mod;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003797}
3798
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003799#endif /* HAVE_DYNAMIC_LOADING */
3800
Guido van Rossum79f25d91997-04-29 20:08:16 +00003801static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003802imp_load_source(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003803{
Victor Stinner2f42ae52011-03-20 00:41:24 +01003804 PyObject *name, *pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003805 PyObject *fob = NULL;
3806 PyObject *m;
3807 FILE *fp;
Victor Stinner2f42ae52011-03-20 00:41:24 +01003808 if (!PyArg_ParseTuple(args, "UO&|O:load_source",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003809 &name,
Victor Stinner2f42ae52011-03-20 00:41:24 +01003810 PyUnicode_FSDecoder, &pathname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003811 &fob))
3812 return NULL;
Victor Stinner2f42ae52011-03-20 00:41:24 +01003813 fp = get_file(pathname, fob, "r");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003814 if (fp == NULL) {
Victor Stinnerebc00522010-12-03 17:06:43 +00003815 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003816 return NULL;
3817 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01003818 m = load_source_module(name, pathname, fp);
Victor Stinnerebc00522010-12-03 17:06:43 +00003819 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003820 fclose(fp);
3821 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003822}
3823
Guido van Rossum79f25d91997-04-29 20:08:16 +00003824static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003825imp_load_module(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003826{
Victor Stinner6ae1e7f2011-03-20 22:37:17 +01003827 PyObject *name, *fob, *pathname, *pathname_obj, *ret;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003828 char *suffix; /* Unused */
3829 char *mode;
3830 int type;
3831 FILE *fp;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003832
Victor Stinner6ae1e7f2011-03-20 22:37:17 +01003833 if (!PyArg_ParseTuple(args, "UOO(ssi):load_module",
3834 &name, &fob, &pathname_obj, &suffix, &mode, &type))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003835 return NULL;
Victor Stinner6ae1e7f2011-03-20 22:37:17 +01003836 if (pathname_obj != Py_None) {
3837 if (!PyUnicode_FSDecoder(pathname_obj, &pathname))
3838 return NULL;
3839 }
3840 else
3841 pathname = NULL;
3842
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003843 if (*mode) {
3844 /* Mode must start with 'r' or 'U' and must not contain '+'.
3845 Implicit in this test is the assumption that the mode
3846 may contain other modifiers like 'b' or 't'. */
Guido van Rossum5e2c5fa2002-05-30 17:33:07 +00003847
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003848 if (!(*mode == 'r' || *mode == 'U') || strchr(mode, '+')) {
3849 PyErr_Format(PyExc_ValueError,
3850 "invalid file open mode %.200s", mode);
Victor Stinner6ae1e7f2011-03-20 22:37:17 +01003851 Py_XDECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003852 return NULL;
3853 }
3854 }
3855 if (fob == Py_None)
3856 fp = NULL;
3857 else {
3858 fp = get_file(NULL, fob, mode);
3859 if (fp == NULL) {
Victor Stinner6ae1e7f2011-03-20 22:37:17 +01003860 Py_XDECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003861 return NULL;
3862 }
3863 }
Victor Stinner41c5fec2011-03-13 21:46:30 -04003864 ret = load_module(name, fp, pathname, type, NULL);
Victor Stinner6ae1e7f2011-03-20 22:37:17 +01003865 Py_XDECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003866 if (fp)
3867 fclose(fp);
3868 return ret;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003869}
3870
3871static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003872imp_load_package(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003873{
Victor Stinnerc9abda02011-03-14 13:33:46 -04003874 PyObject *name, *pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003875 PyObject * ret;
Victor Stinnerc9abda02011-03-14 13:33:46 -04003876 if (!PyArg_ParseTuple(args, "UO&:load_package",
3877 &name, PyUnicode_FSDecoder, &pathname))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003878 return NULL;
Victor Stinnerc9abda02011-03-14 13:33:46 -04003879 ret = load_package(name, pathname);
Victor Stinnerebc00522010-12-03 17:06:43 +00003880 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003881 return ret;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003882}
3883
3884static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003885imp_new_module(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003886{
Victor Stinnerfe19d212011-03-14 14:53:28 -04003887 PyObject *name;
3888 if (!PyArg_ParseTuple(args, "U:new_module", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003889 return NULL;
Victor Stinnerfe19d212011-03-14 14:53:28 -04003890 return PyModule_NewObject(name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003891}
3892
Christian Heimes13a7a212008-01-07 17:13:09 +00003893static PyObject *
3894imp_reload(PyObject *self, PyObject *v)
3895{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003896 return PyImport_ReloadModule(v);
Christian Heimes13a7a212008-01-07 17:13:09 +00003897}
3898
3899PyDoc_STRVAR(doc_reload,
3900"reload(module) -> module\n\
3901\n\
3902Reload the module. The module must have been successfully imported before.");
3903
Barry Warsaw28a691b2010-04-17 00:19:56 +00003904static PyObject *
3905imp_cache_from_source(PyObject *self, PyObject *args, PyObject *kws)
3906{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003907 static char *kwlist[] = {"path", "debug_override", NULL};
Barry Warsaw28a691b2010-04-17 00:19:56 +00003908
Victor Stinner2f42ae52011-03-20 00:41:24 +01003909 PyObject *pathname, *cpathname;
Benjamin Peterson294a9fc2010-10-16 03:12:39 +00003910 PyObject *debug_override = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003911 int debug = !Py_OptimizeFlag;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003912
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003913 if (!PyArg_ParseTupleAndKeywords(
Victor Stinner3ea23dd2010-10-15 20:34:32 +00003914 args, kws, "O&|O", kwlist,
Victor Stinner2f42ae52011-03-20 00:41:24 +01003915 PyUnicode_FSDecoder, &pathname, &debug_override))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003916 return NULL;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003917
Benjamin Peterson294a9fc2010-10-16 03:12:39 +00003918 if (debug_override != NULL &&
3919 (debug = PyObject_IsTrue(debug_override)) < 0) {
Victor Stinner2f42ae52011-03-20 00:41:24 +01003920 Py_DECREF(pathname);
Benjamin Peterson294a9fc2010-10-16 03:12:39 +00003921 return NULL;
3922 }
Barry Warsaw28a691b2010-04-17 00:19:56 +00003923
Martin v. Löwis30260a72011-10-23 17:35:46 +02003924 if (PyUnicode_READY(pathname) < 0)
3925 return NULL;
3926
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003927 cpathname = make_compiled_pathname(pathname, debug);
Victor Stinner2f42ae52011-03-20 00:41:24 +01003928 Py_DECREF(pathname);
Barry Warsaw28a691b2010-04-17 00:19:56 +00003929
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003930 if (cpathname == NULL) {
3931 PyErr_Format(PyExc_SystemError, "path buffer too short");
3932 return NULL;
3933 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01003934 return cpathname;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003935}
3936
3937PyDoc_STRVAR(doc_cache_from_source,
Éric Araujo5df11082011-11-03 03:38:44 +01003938"cache_from_source(path, [debug_override]) -> path\n\
3939Given the path to a .py file, return the path to its .pyc/.pyo file.\n\
Barry Warsaw28a691b2010-04-17 00:19:56 +00003940\n\
3941The .py file does not need to exist; this simply returns the path to the\n\
3942.pyc/.pyo file calculated as if the .py file were imported. The extension\n\
3943will be .pyc unless __debug__ is not defined, then it will be .pyo.\n\
3944\n\
3945If debug_override is not None, then it must be a boolean and is taken as\n\
3946the value of __debug__ instead.");
3947
3948static PyObject *
3949imp_source_from_cache(PyObject *self, PyObject *args, PyObject *kws)
3950{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003951 static char *kwlist[] = {"path", NULL};
Victor Stinnerc9abda02011-03-14 13:33:46 -04003952 PyObject *pathname, *source;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003953
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003954 if (!PyArg_ParseTupleAndKeywords(
Victor Stinnerebc00522010-12-03 17:06:43 +00003955 args, kws, "O&", kwlist,
Victor Stinnerc9abda02011-03-14 13:33:46 -04003956 PyUnicode_FSDecoder, &pathname))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003957 return NULL;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003958
Victor Stinnerc9abda02011-03-14 13:33:46 -04003959 source = make_source_pathname(pathname);
3960 if (source == NULL) {
3961 PyErr_Format(PyExc_ValueError, "Not a PEP 3147 pyc path: %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003962 pathname);
Victor Stinnerc9abda02011-03-14 13:33:46 -04003963 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003964 return NULL;
3965 }
Victor Stinnerc9abda02011-03-14 13:33:46 -04003966 Py_DECREF(pathname);
3967 return source;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003968}
3969
3970PyDoc_STRVAR(doc_source_from_cache,
Éric Araujo5df11082011-11-03 03:38:44 +01003971"source_from_cache(path) -> path\n\
3972Given the path to a .pyc./.pyo file, return the path to its .py file.\n\
Barry Warsaw28a691b2010-04-17 00:19:56 +00003973\n\
3974The .pyc/.pyo file does not need to exist; this simply returns the path to\n\
3975the .py file calculated to correspond to the .pyc/.pyo file. If path\n\
3976does not conform to PEP 3147 format, ValueError will be raised.");
3977
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003978/* Doc strings */
3979
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003980PyDoc_STRVAR(doc_imp,
3981"This module provides the components needed to build your own\n\
3982__import__ function. Undocumented functions are obsolete.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003983
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003984PyDoc_STRVAR(doc_find_module,
3985"find_module(name, [path]) -> (file, filename, (suffix, mode, type))\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003986Search for a module. If path is omitted or None, search for a\n\
3987built-in, frozen or special module and continue search in sys.path.\n\
3988The module name cannot contain '.'; to search for a submodule of a\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003989package, pass the submodule name and the package's __path__.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003990
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003991PyDoc_STRVAR(doc_load_module,
3992"load_module(name, file, filename, (suffix, mode, type)) -> module\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003993Load a module, given information returned by find_module().\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003994The module name must include the full package name, if any.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003995
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003996PyDoc_STRVAR(doc_get_magic,
3997"get_magic() -> string\n\
3998Return the magic number for .pyc or .pyo files.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003999
Barry Warsaw28a691b2010-04-17 00:19:56 +00004000PyDoc_STRVAR(doc_get_tag,
4001"get_tag() -> string\n\
4002Return the magic tag for .pyc or .pyo files.");
4003
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004004PyDoc_STRVAR(doc_get_suffixes,
4005"get_suffixes() -> [(suffix, mode, type), ...]\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00004006Return a list of (suffix, mode, type) tuples describing the files\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004007that find_module() looks for.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00004008
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004009PyDoc_STRVAR(doc_new_module,
4010"new_module(name) -> module\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00004011Create a new module. Do not enter it in sys.modules.\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004012The module name must include the full package name, if any.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00004013
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004014PyDoc_STRVAR(doc_lock_held,
Tim Petersa7c65092004-08-01 23:26:05 +00004015"lock_held() -> boolean\n\
4016Return True if the import lock is currently held, else False.\n\
4017On platforms without threads, return False.");
Tim Peters69232342001-08-30 05:16:13 +00004018
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00004019PyDoc_STRVAR(doc_acquire_lock,
4020"acquire_lock() -> None\n\
Neal Norwitz2294c0d2003-02-12 23:02:21 +00004021Acquires the interpreter's import lock for the current thread.\n\
4022This lock should be used by import hooks to ensure thread-safety\n\
4023when importing modules.\n\
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00004024On platforms without threads, this function does nothing.");
4025
4026PyDoc_STRVAR(doc_release_lock,
4027"release_lock() -> None\n\
4028Release the interpreter's import lock.\n\
4029On platforms without threads, this function does nothing.");
4030
Guido van Rossum79f25d91997-04-29 20:08:16 +00004031static PyMethodDef imp_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004032 {"find_module", imp_find_module, METH_VARARGS, doc_find_module},
4033 {"get_magic", imp_get_magic, METH_NOARGS, doc_get_magic},
4034 {"get_tag", imp_get_tag, METH_NOARGS, doc_get_tag},
4035 {"get_suffixes", imp_get_suffixes, METH_NOARGS, doc_get_suffixes},
4036 {"load_module", imp_load_module, METH_VARARGS, doc_load_module},
4037 {"new_module", imp_new_module, METH_VARARGS, doc_new_module},
4038 {"lock_held", imp_lock_held, METH_NOARGS, doc_lock_held},
4039 {"acquire_lock", imp_acquire_lock, METH_NOARGS, doc_acquire_lock},
4040 {"release_lock", imp_release_lock, METH_NOARGS, doc_release_lock},
4041 {"reload", imp_reload, METH_O, doc_reload},
4042 {"cache_from_source", (PyCFunction)imp_cache_from_source,
4043 METH_VARARGS | METH_KEYWORDS, doc_cache_from_source},
4044 {"source_from_cache", (PyCFunction)imp_source_from_cache,
4045 METH_VARARGS | METH_KEYWORDS, doc_source_from_cache},
4046 /* The rest are obsolete */
4047 {"get_frozen_object", imp_get_frozen_object, METH_VARARGS},
4048 {"is_frozen_package", imp_is_frozen_package, METH_VARARGS},
4049 {"init_builtin", imp_init_builtin, METH_VARARGS},
4050 {"init_frozen", imp_init_frozen, METH_VARARGS},
4051 {"is_builtin", imp_is_builtin, METH_VARARGS},
4052 {"is_frozen", imp_is_frozen, METH_VARARGS},
4053 {"load_compiled", imp_load_compiled, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00004054#ifdef HAVE_DYNAMIC_LOADING
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004055 {"load_dynamic", imp_load_dynamic, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00004056#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004057 {"load_package", imp_load_package, METH_VARARGS},
4058 {"load_source", imp_load_source, METH_VARARGS},
Brett Cannon442c9b92011-03-23 16:14:42 -07004059 {"_fix_co_filename", imp_fix_co_filename, METH_VARARGS},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004060 {NULL, NULL} /* sentinel */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004061};
4062
Guido van Rossum1a8791e1998-08-04 22:46:29 +00004063static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00004064setint(PyObject *d, char *name, int value)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00004065{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004066 PyObject *v;
4067 int err;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00004068
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004069 v = PyLong_FromLong((long)value);
4070 err = PyDict_SetItemString(d, name, v);
4071 Py_XDECREF(v);
4072 return err;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00004073}
4074
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004075typedef struct {
4076 PyObject_HEAD
4077} NullImporter;
4078
4079static int
4080NullImporter_init(NullImporter *self, PyObject *args, PyObject *kwds)
4081{
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004082#ifndef MS_WINDOWS
4083 PyObject *path;
4084 struct stat statbuf;
4085 int rv;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004086
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004087 if (!_PyArg_NoKeywords("NullImporter()", kwds))
4088 return -1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004089
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004090 if (!PyArg_ParseTuple(args, "O&:NullImporter",
4091 PyUnicode_FSConverter, &path))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004092 return -1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004093
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004094 if (PyBytes_GET_SIZE(path) == 0) {
4095 Py_DECREF(path);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004096 PyErr_SetString(PyExc_ImportError, "empty pathname");
4097 return -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004098 }
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004099
4100 rv = stat(PyBytes_AS_STRING(path), &statbuf);
4101 Py_DECREF(path);
4102 if (rv == 0) {
4103 /* it exists */
4104 if (S_ISDIR(statbuf.st_mode)) {
4105 /* it's a directory */
4106 PyErr_SetString(PyExc_ImportError, "existing directory");
4107 return -1;
4108 }
4109 }
4110#else /* MS_WINDOWS */
4111 PyObject *pathobj;
4112 DWORD rv;
Victor Stinner255dfdb2010-09-29 10:28:51 +00004113 wchar_t *path;
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004114
4115 if (!_PyArg_NoKeywords("NullImporter()", kwds))
4116 return -1;
4117
4118 if (!PyArg_ParseTuple(args, "U:NullImporter",
4119 &pathobj))
4120 return -1;
4121
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02004122 if (PyUnicode_GET_LENGTH(pathobj) == 0) {
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004123 PyErr_SetString(PyExc_ImportError, "empty pathname");
4124 return -1;
4125 }
4126
Victor Stinnerbeb4135b2010-10-07 01:02:42 +00004127 path = PyUnicode_AsWideCharString(pathobj, NULL);
Victor Stinner255dfdb2010-09-29 10:28:51 +00004128 if (path == NULL)
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004129 return -1;
4130 /* see issue1293 and issue3677:
4131 * stat() on Windows doesn't recognise paths like
4132 * "e:\\shared\\" and "\\\\whiterab-c2znlh\\shared" as dirs.
4133 */
4134 rv = GetFileAttributesW(path);
Victor Stinner255dfdb2010-09-29 10:28:51 +00004135 PyMem_Free(path);
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004136 if (rv != INVALID_FILE_ATTRIBUTES) {
4137 /* it exists */
4138 if (rv & FILE_ATTRIBUTE_DIRECTORY) {
4139 /* it's a directory */
4140 PyErr_SetString(PyExc_ImportError, "existing directory");
4141 return -1;
4142 }
4143 }
4144#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004145 return 0;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004146}
4147
4148static PyObject *
4149NullImporter_find_module(NullImporter *self, PyObject *args)
4150{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004151 Py_RETURN_NONE;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004152}
4153
4154static PyMethodDef NullImporter_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004155 {"find_module", (PyCFunction)NullImporter_find_module, METH_VARARGS,
4156 "Always return None"
4157 },
4158 {NULL} /* Sentinel */
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004159};
4160
4161
Christian Heimes9cd17752007-11-18 19:35:23 +00004162PyTypeObject PyNullImporter_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004163 PyVarObject_HEAD_INIT(NULL, 0)
4164 "imp.NullImporter", /*tp_name*/
4165 sizeof(NullImporter), /*tp_basicsize*/
4166 0, /*tp_itemsize*/
4167 0, /*tp_dealloc*/
4168 0, /*tp_print*/
4169 0, /*tp_getattr*/
4170 0, /*tp_setattr*/
4171 0, /*tp_reserved*/
4172 0, /*tp_repr*/
4173 0, /*tp_as_number*/
4174 0, /*tp_as_sequence*/
4175 0, /*tp_as_mapping*/
4176 0, /*tp_hash */
4177 0, /*tp_call*/
4178 0, /*tp_str*/
4179 0, /*tp_getattro*/
4180 0, /*tp_setattro*/
4181 0, /*tp_as_buffer*/
4182 Py_TPFLAGS_DEFAULT, /*tp_flags*/
4183 "Null importer object", /* tp_doc */
4184 0, /* tp_traverse */
4185 0, /* tp_clear */
4186 0, /* tp_richcompare */
4187 0, /* tp_weaklistoffset */
4188 0, /* tp_iter */
4189 0, /* tp_iternext */
4190 NullImporter_methods, /* tp_methods */
4191 0, /* tp_members */
4192 0, /* tp_getset */
4193 0, /* tp_base */
4194 0, /* tp_dict */
4195 0, /* tp_descr_get */
4196 0, /* tp_descr_set */
4197 0, /* tp_dictoffset */
4198 (initproc)NullImporter_init, /* tp_init */
4199 0, /* tp_alloc */
4200 PyType_GenericNew /* tp_new */
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004201};
4202
Martin v. Löwis1a214512008-06-11 05:26:20 +00004203static struct PyModuleDef impmodule = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004204 PyModuleDef_HEAD_INIT,
4205 "imp",
4206 doc_imp,
4207 0,
4208 imp_methods,
4209 NULL,
4210 NULL,
4211 NULL,
4212 NULL
Martin v. Löwis1a214512008-06-11 05:26:20 +00004213};
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004214
Jason Tishler6bc06ec2003-09-04 11:59:50 +00004215PyMODINIT_FUNC
Martin v. Löwis1a214512008-06-11 05:26:20 +00004216PyInit_imp(void)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004217{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004218 PyObject *m, *d;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004219
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004220 if (PyType_Ready(&PyNullImporter_Type) < 0)
4221 return NULL;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004222
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004223 m = PyModule_Create(&impmodule);
4224 if (m == NULL)
4225 goto failure;
4226 d = PyModule_GetDict(m);
4227 if (d == NULL)
4228 goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004229
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004230 if (setint(d, "SEARCH_ERROR", SEARCH_ERROR) < 0) goto failure;
4231 if (setint(d, "PY_SOURCE", PY_SOURCE) < 0) goto failure;
4232 if (setint(d, "PY_COMPILED", PY_COMPILED) < 0) goto failure;
4233 if (setint(d, "C_EXTENSION", C_EXTENSION) < 0) goto failure;
4234 if (setint(d, "PY_RESOURCE", PY_RESOURCE) < 0) goto failure;
4235 if (setint(d, "PKG_DIRECTORY", PKG_DIRECTORY) < 0) goto failure;
4236 if (setint(d, "C_BUILTIN", C_BUILTIN) < 0) goto failure;
4237 if (setint(d, "PY_FROZEN", PY_FROZEN) < 0) goto failure;
4238 if (setint(d, "PY_CODERESOURCE", PY_CODERESOURCE) < 0) goto failure;
4239 if (setint(d, "IMP_HOOK", IMP_HOOK) < 0) goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004240
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004241 Py_INCREF(&PyNullImporter_Type);
4242 PyModule_AddObject(m, "NullImporter", (PyObject *)&PyNullImporter_Type);
4243 return m;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00004244 failure:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004245 Py_XDECREF(m);
4246 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004247}
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004248
4249
Guido van Rossumb18618d2000-05-03 23:44:39 +00004250/* API for embedding applications that want to add their own entries
4251 to the table of built-in modules. This should normally be called
4252 *before* Py_Initialize(). When the table resize fails, -1 is
4253 returned and the existing table is unchanged.
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004254
4255 After a similar function by Just van Rossum. */
4256
4257int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00004258PyImport_ExtendInittab(struct _inittab *newtab)
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004259{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004260 static struct _inittab *our_copy = NULL;
4261 struct _inittab *p;
4262 int i, n;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004263
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004264 /* Count the number of entries in both tables */
4265 for (n = 0; newtab[n].name != NULL; n++)
4266 ;
4267 if (n == 0)
4268 return 0; /* Nothing to do */
4269 for (i = 0; PyImport_Inittab[i].name != NULL; i++)
4270 ;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004271
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004272 /* Allocate new memory for the combined table */
4273 p = our_copy;
4274 PyMem_RESIZE(p, struct _inittab, i+n+1);
4275 if (p == NULL)
4276 return -1;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004277
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004278 /* Copy the tables into the new memory */
4279 if (our_copy != PyImport_Inittab)
4280 memcpy(p, PyImport_Inittab, (i+1) * sizeof(struct _inittab));
4281 PyImport_Inittab = our_copy = p;
4282 memcpy(p+i, newtab, (n+1) * sizeof(struct _inittab));
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004283
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004284 return 0;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004285}
4286
4287/* Shorthand to add a single entry given a name and a function */
4288
4289int
Brett Cannona826f322009-04-02 03:41:46 +00004290PyImport_AppendInittab(const char *name, PyObject* (*initfunc)(void))
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004291{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004292 struct _inittab newtab[2];
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004293
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004294 memset(newtab, '\0', sizeof newtab);
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004295
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004296 newtab[0].name = (char *)name;
4297 newtab[0].initfunc = initfunc;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004298
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004299 return PyImport_ExtendInittab(newtab);
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004300}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00004301
4302#ifdef __cplusplus
4303}
4304#endif