blob: 64197d7a48e72ba9e88b2e774ce517a9a3d1c763 [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 }
Antoine Pitrou1d8f3f42011-11-15 20:40:55 +01001270 if (PyUnicode_CopyCharacters(cpathname_tmp, 0,
1271 cpathname, 0, cpathname_len) < 0) {
1272 PyErr_Clear();
1273 return;
1274 }
Antoine Pitrou28e401e2011-11-15 19:15:19 +01001275 PyUnicode_WriteChar(cpathname_tmp, cpathname_len + 0, '.');
1276 PyUnicode_WriteChar(cpathname_tmp, cpathname_len + 1, 't');
1277 PyUnicode_WriteChar(cpathname_tmp, cpathname_len + 2, 'm');
1278 PyUnicode_WriteChar(cpathname_tmp, cpathname_len + 3, 'p');
1279 (void)DeleteFileW(PyUnicode_AS_UNICODE(cpathname_tmp));
1280 fd = _wopen(PyUnicode_AS_UNICODE(cpathname_tmp),
1281 O_EXCL | O_CREAT | O_WRONLY | O_BINARY,
1282 mode);
Victor Stinner783c82c2011-04-20 03:27:51 +02001283 if (0 <= fd)
1284 fp = fdopen(fd, "wb");
1285 else
1286 fp = NULL;
1287#else
Victor Stinner2f42ae52011-03-20 00:41:24 +01001288 cpathbytes = PyUnicode_EncodeFSDefault(cpathname);
1289 if (cpathbytes == NULL) {
1290 PyErr_Clear();
1291 return;
1292 }
Antoine Pitrou707033a2011-10-17 19:28:44 +02001293 cpathbytes_len = PyBytes_GET_SIZE(cpathbytes);
Charles-François Natali0c929d92011-11-10 19:12:29 +01001294 cpathbytes_tmp = PyBytes_FromStringAndSize(NULL, cpathbytes_len + 4);
Antoine Pitrou707033a2011-10-17 19:28:44 +02001295 if (cpathbytes_tmp == NULL) {
1296 Py_DECREF(cpathbytes);
1297 PyErr_Clear();
1298 return;
1299 }
1300 memcpy(PyBytes_AS_STRING(cpathbytes_tmp), PyBytes_AS_STRING(cpathbytes),
1301 cpathbytes_len);
Charles-François Natali0c929d92011-11-10 19:12:29 +01001302 memcpy(PyBytes_AS_STRING(cpathbytes_tmp) + cpathbytes_len, ".tmp", 4);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001303
Charles-François Natali0c929d92011-11-10 19:12:29 +01001304 fd = open(PyBytes_AS_STRING(cpathbytes_tmp),
1305 O_CREAT | O_EXCL | O_WRONLY, 0666);
Charles-François Natalie695eec2011-10-31 20:47:31 +01001306 if (0 <= fd)
1307 fp = fdopen(fd, "wb");
1308 else
1309 fp = NULL;
Victor Stinner783c82c2011-04-20 03:27:51 +02001310#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001311 if (fp == NULL) {
1312 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001313 PySys_FormatStderr(
1314 "# can't create %R\n", cpathname);
Antoine Pitrou28e401e2011-11-15 19:15:19 +01001315#ifdef MS_WINDOWS
1316 Py_DECREF(cpathname_tmp);
1317#else
Victor Stinner2f42ae52011-03-20 00:41:24 +01001318 Py_DECREF(cpathbytes);
Antoine Pitrou707033a2011-10-17 19:28:44 +02001319 Py_DECREF(cpathbytes_tmp);
Victor Stinner783c82c2011-04-20 03:27:51 +02001320#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001321 return;
1322 }
1323 PyMarshal_WriteLongToFile(pyc_magic, fp, Py_MARSHAL_VERSION);
1324 /* First write a 0 for mtime */
1325 PyMarshal_WriteLongToFile(0L, fp, Py_MARSHAL_VERSION);
1326 PyMarshal_WriteObjectToFile((PyObject *)co, fp, Py_MARSHAL_VERSION);
Antoine Pitrou707033a2011-10-17 19:28:44 +02001327 fflush(fp);
1328 /* Now write the true mtime */
1329 fseek(fp, 4L, 0);
1330 assert(mtime < LONG_MAX);
1331 PyMarshal_WriteLongToFile((long)mtime, fp, Py_MARSHAL_VERSION);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001332 if (fflush(fp) != 0 || ferror(fp)) {
1333 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001334 PySys_FormatStderr("# can't write %R\n", cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001335 /* Don't keep partial file */
1336 fclose(fp);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001337#ifdef MS_WINDOWS
Antoine Pitrou28e401e2011-11-15 19:15:19 +01001338 (void)DeleteFileW(PyUnicode_AS_UNICODE(cpathname_tmp));
1339 Py_DECREF(cpathname_tmp);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001340#else
Antoine Pitrou707033a2011-10-17 19:28:44 +02001341 (void) unlink(PyBytes_AS_STRING(cpathbytes_tmp));
Victor Stinner2f42ae52011-03-20 00:41:24 +01001342 Py_DECREF(cpathbytes);
Antoine Pitrou707033a2011-10-17 19:28:44 +02001343 Py_DECREF(cpathbytes_tmp);
Victor Stinner783c82c2011-04-20 03:27:51 +02001344#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001345 return;
1346 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001347 fclose(fp);
Antoine Pitrou28e401e2011-11-15 19:15:19 +01001348 /* Do a (hopefully) atomic rename */
1349#ifdef MS_WINDOWS
1350 if (!MoveFileExW(PyUnicode_AS_UNICODE(cpathname_tmp),
1351 PyUnicode_AS_UNICODE(cpathname),
1352 MOVEFILE_REPLACE_EXISTING)) {
1353 if (Py_VerboseFlag)
1354 PySys_FormatStderr("# can't write %R\n", cpathname);
1355 /* Don't keep tmp file */
1356 (void) DeleteFileW(PyUnicode_AS_UNICODE(cpathname_tmp));
1357 Py_DECREF(cpathname_tmp);
1358 return;
1359 }
1360 Py_DECREF(cpathname_tmp);
1361#else
Antoine Pitrou707033a2011-10-17 19:28:44 +02001362 if (rename(PyBytes_AS_STRING(cpathbytes_tmp),
1363 PyBytes_AS_STRING(cpathbytes))) {
1364 if (Py_VerboseFlag)
1365 PySys_FormatStderr("# can't write %R\n", cpathname);
1366 /* Don't keep tmp file */
1367 unlink(PyBytes_AS_STRING(cpathbytes_tmp));
1368 Py_DECREF(cpathbytes);
1369 Py_DECREF(cpathbytes_tmp);
1370 return;
1371 }
1372 Py_DECREF(cpathbytes);
1373 Py_DECREF(cpathbytes_tmp);
1374#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001375 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001376 PySys_FormatStderr("# wrote %R\n", cpathname);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001377}
1378
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001379static void
1380update_code_filenames(PyCodeObject *co, PyObject *oldname, PyObject *newname)
1381{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001382 PyObject *constants, *tmp;
1383 Py_ssize_t i, n;
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001384
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001385 if (PyUnicode_Compare(co->co_filename, oldname))
1386 return;
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001387
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001388 tmp = co->co_filename;
1389 co->co_filename = newname;
1390 Py_INCREF(co->co_filename);
1391 Py_DECREF(tmp);
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001392
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001393 constants = co->co_consts;
1394 n = PyTuple_GET_SIZE(constants);
1395 for (i = 0; i < n; i++) {
1396 tmp = PyTuple_GET_ITEM(constants, i);
1397 if (PyCode_Check(tmp))
1398 update_code_filenames((PyCodeObject *)tmp,
1399 oldname, newname);
1400 }
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001401}
1402
Victor Stinner2f42ae52011-03-20 00:41:24 +01001403static void
1404update_compiled_module(PyCodeObject *co, PyObject *newname)
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001405{
Victor Stinner2f42ae52011-03-20 00:41:24 +01001406 PyObject *oldname;
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001407
Victor Stinner2f42ae52011-03-20 00:41:24 +01001408 if (PyUnicode_Compare(co->co_filename, newname) == 0)
1409 return;
Hirokazu Yamamoto4f447fb2009-03-04 01:52:10 +00001410
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001411 oldname = co->co_filename;
1412 Py_INCREF(oldname);
1413 update_code_filenames(co, oldname, newname);
1414 Py_DECREF(oldname);
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001415}
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001416
Brett Cannon442c9b92011-03-23 16:14:42 -07001417static PyObject *
1418imp_fix_co_filename(PyObject *self, PyObject *args)
1419{
1420 PyObject *co;
1421 PyObject *file_path;
1422
1423 if (!PyArg_ParseTuple(args, "OO:_fix_co_filename", &co, &file_path))
1424 return NULL;
1425
1426 if (!PyCode_Check(co)) {
1427 PyErr_SetString(PyExc_TypeError,
1428 "first argument must be a code object");
1429 return NULL;
1430 }
1431
1432 if (!PyUnicode_Check(file_path)) {
1433 PyErr_SetString(PyExc_TypeError,
1434 "second argument must be a string");
1435 return NULL;
1436 }
1437
1438 update_compiled_module((PyCodeObject*)co, file_path);
1439
1440 Py_RETURN_NONE;
1441}
1442
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001443/* Load a source module from a given file and return its module
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001444 object WITH INCREMENTED REFERENCE COUNT. If there's a matching
1445 byte-compiled file, use that instead. */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001446
Guido van Rossum79f25d91997-04-29 20:08:16 +00001447static PyObject *
Victor Stinner2f42ae52011-03-20 00:41:24 +01001448load_source_module(PyObject *name, PyObject *pathname, FILE *fp)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001449{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001450 struct stat st;
1451 FILE *fpc;
Victor Stinner2f42ae52011-03-20 00:41:24 +01001452 PyObject *cpathname = NULL, *cpathbytes = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001453 PyCodeObject *co;
Victor Stinner2f42ae52011-03-20 00:41:24 +01001454 PyObject *m = NULL;
Brett Cannon9a5b25a2010-03-01 02:09:17 +00001455
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001456 if (fstat(fileno(fp), &st) != 0) {
1457 PyErr_Format(PyExc_RuntimeError,
Victor Stinner2f42ae52011-03-20 00:41:24 +01001458 "unable to get file status from %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001459 pathname);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001460 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001461 }
Fred Drake4c82b232000-06-30 16:18:57 +00001462#if SIZEOF_TIME_T > 4
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001463 /* Python's .pyc timestamp handling presumes that the timestamp fits
1464 in 4 bytes. This will be fine until sometime in the year 2038,
1465 when a 4-byte signed time_t will overflow.
1466 */
1467 if (st.st_mtime >> 32) {
1468 PyErr_SetString(PyExc_OverflowError,
1469 "modification time overflows a 4 byte field");
Victor Stinner2f42ae52011-03-20 00:41:24 +01001470 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001471 }
Fred Drake4c82b232000-06-30 16:18:57 +00001472#endif
Martin v. Löwis30260a72011-10-23 17:35:46 +02001473 if (PyUnicode_READY(pathname) < 0)
1474 return NULL;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001475 cpathname = make_compiled_pathname(pathname, !Py_OptimizeFlag);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001476
1477 if (cpathname != NULL)
1478 fpc = check_compiled_module(pathname, st.st_mtime, cpathname);
1479 else
1480 fpc = NULL;
1481
1482 if (fpc) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001483 co = read_compiled_module(cpathname, fpc);
1484 fclose(fpc);
1485 if (co == NULL)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001486 goto error;
1487 update_compiled_module(co, pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001488 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001489 PySys_FormatStderr("import %U # precompiled from %R\n",
1490 name, cpathname);
1491 m = PyImport_ExecCodeModuleObject(name, (PyObject *)co,
1492 cpathname, cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001493 }
1494 else {
1495 co = parse_source_module(pathname, fp);
1496 if (co == NULL)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001497 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001498 if (Py_VerboseFlag)
Victor Stinner2f42ae52011-03-20 00:41:24 +01001499 PySys_FormatStderr("import %U # from %R\n",
Victor Stinner98dbba52011-03-14 15:15:47 -04001500 name, pathname);
Victor Stinner2f42ae52011-03-20 00:41:24 +01001501 if (cpathname != NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001502 PyObject *ro = PySys_GetObject("dont_write_bytecode");
1503 if (ro == NULL || !PyObject_IsTrue(ro))
1504 write_compiled_module(co, cpathname, &st);
1505 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01001506 m = PyImport_ExecCodeModuleObject(name, (PyObject *)co,
1507 pathname, cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001508 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001509 Py_DECREF(co);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001510
Victor Stinner2f42ae52011-03-20 00:41:24 +01001511error:
1512 Py_XDECREF(cpathbytes);
1513 Py_XDECREF(cpathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001514 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001515}
1516
Christian Heimes3b06e532008-01-07 20:12:44 +00001517/* Get source file -> unicode or None
1518 * Returns the path to the py file if available, else the given path
1519 */
1520static PyObject *
Victor Stinnerc9abda02011-03-14 13:33:46 -04001521get_sourcefile(PyObject *filename)
Christian Heimes3b06e532008-01-07 20:12:44 +00001522{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001523 Py_ssize_t len;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001524 Py_UCS4 *fileuni;
Victor Stinnerc9abda02011-03-14 13:33:46 -04001525 PyObject *py;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001526 struct stat statbuf;
Christian Heimes3b06e532008-01-07 20:12:44 +00001527
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001528 len = PyUnicode_GET_LENGTH(filename);
Victor Stinnerc9abda02011-03-14 13:33:46 -04001529 if (len == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001530 Py_RETURN_NONE;
Christian Heimes3b06e532008-01-07 20:12:44 +00001531
Victor Stinnerc9abda02011-03-14 13:33:46 -04001532 /* don't match *.pyc or *.pyo? */
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001533 fileuni = PyUnicode_AsUCS4Copy(filename);
1534 if (!fileuni)
1535 return NULL;
Victor Stinnerc9abda02011-03-14 13:33:46 -04001536 if (len < 5
1537 || fileuni[len-4] != '.'
1538 || (fileuni[len-3] != 'p' && fileuni[len-3] != 'P')
1539 || (fileuni[len-2] != 'y' && fileuni[len-2] != 'Y'))
1540 goto unchanged;
Christian Heimes3b06e532008-01-07 20:12:44 +00001541
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001542 /* Start by trying to turn PEP 3147 path into source path. If that
1543 * fails, just chop off the trailing character, i.e. legacy pyc path
1544 * to py.
1545 */
Victor Stinnerc9abda02011-03-14 13:33:46 -04001546 py = make_source_pathname(filename);
1547 if (py == NULL) {
1548 PyErr_Clear();
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001549 py = PyUnicode_FromKindAndData(PyUnicode_4BYTE_KIND, fileuni, len - 1);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001550 }
Victor Stinnerc9abda02011-03-14 13:33:46 -04001551 if (py == NULL)
1552 goto error;
Barry Warsaw28a691b2010-04-17 00:19:56 +00001553
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02001554 if (_Py_stat(py, &statbuf) == 0 && S_ISREG(statbuf.st_mode)) {
1555 PyMem_Free(fileuni);
Victor Stinnerc9abda02011-03-14 13:33:46 -04001556 return py;
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02001557 }
Victor Stinnerc9abda02011-03-14 13:33:46 -04001558 Py_DECREF(py);
1559 goto unchanged;
1560
1561error:
1562 PyErr_Clear();
1563unchanged:
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001564 PyMem_Free(fileuni);
Victor Stinnerc9abda02011-03-14 13:33:46 -04001565 Py_INCREF(filename);
1566 return filename;
Christian Heimes3b06e532008-01-07 20:12:44 +00001567}
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001568
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001569/* Forward */
Victor Stinner41c5fec2011-03-13 21:46:30 -04001570static PyObject *load_module(PyObject *, FILE *, PyObject *, int, PyObject *);
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001571static struct filedescr *find_module(PyObject *, PyObject *, PyObject *,
Victor Stinner2fd76e42011-03-14 15:19:39 -04001572 PyObject **, FILE **, PyObject **);
Victor Stinner53dc7352011-03-20 01:50:21 +01001573static struct _frozen * find_frozen(PyObject *);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001574
1575/* Load a package and return its module object WITH INCREMENTED
1576 REFERENCE COUNT */
1577
1578static PyObject *
Victor Stinnerc9abda02011-03-14 13:33:46 -04001579load_package(PyObject *name, PyObject *pathname)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001580{
Victor Stinner41c5fec2011-03-13 21:46:30 -04001581 PyObject *m, *d, *bufobj;
Victor Stinnerc9abda02011-03-14 13:33:46 -04001582 PyObject *file = NULL, *path_list = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001583 int err;
Victor Stinnerc9abda02011-03-14 13:33:46 -04001584 FILE *fp = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001585 struct filedescr *fdp;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001586
Victor Stinnerc9abda02011-03-14 13:33:46 -04001587 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001588 if (m == NULL)
1589 return NULL;
1590 if (Py_VerboseFlag)
Victor Stinner98dbba52011-03-14 15:15:47 -04001591 PySys_FormatStderr("import %U # directory %R\n",
1592 name, pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001593 file = get_sourcefile(pathname);
1594 if (file == NULL)
Victor Stinnerc9abda02011-03-14 13:33:46 -04001595 return NULL;
1596 path_list = Py_BuildValue("[O]", file);
1597 if (path_list == NULL) {
1598 Py_DECREF(file);
1599 return NULL;
1600 }
1601 d = PyModule_GetDict(m);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001602 err = PyDict_SetItemString(d, "__file__", file);
Victor Stinnerc9abda02011-03-14 13:33:46 -04001603 Py_DECREF(file);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001604 if (err == 0)
Victor Stinnerc9abda02011-03-14 13:33:46 -04001605 err = PyDict_SetItemString(d, "__path__", path_list);
1606 if (err != 0) {
1607 Py_DECREF(path_list);
1608 return NULL;
1609 }
Victor Stinner533d7832011-03-14 13:22:54 -04001610 fdp = find_module(name, initstr, path_list,
Victor Stinner2fd76e42011-03-14 15:19:39 -04001611 &bufobj, &fp, NULL);
Victor Stinnerc9abda02011-03-14 13:33:46 -04001612 Py_DECREF(path_list);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001613 if (fdp == NULL) {
1614 if (PyErr_ExceptionMatches(PyExc_ImportError)) {
1615 PyErr_Clear();
1616 Py_INCREF(m);
Victor Stinnerc9abda02011-03-14 13:33:46 -04001617 return m;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001618 }
1619 else
Victor Stinnerc9abda02011-03-14 13:33:46 -04001620 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001621 }
Victor Stinner2fd76e42011-03-14 15:19:39 -04001622 m = load_module(name, fp, bufobj, fdp->type, NULL);
1623 Py_XDECREF(bufobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001624 if (fp != NULL)
1625 fclose(fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001626 return m;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001627}
1628
1629
1630/* Helper to test for built-in module */
1631
1632static int
Victor Stinner95872862011-03-07 18:20:56 +01001633is_builtin(PyObject *name)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001634{
Victor Stinner95872862011-03-07 18:20:56 +01001635 int i, cmp;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001636 for (i = 0; PyImport_Inittab[i].name != NULL; i++) {
Victor Stinner95872862011-03-07 18:20:56 +01001637 cmp = PyUnicode_CompareWithASCIIString(name, PyImport_Inittab[i].name);
1638 if (cmp == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001639 if (PyImport_Inittab[i].initfunc == NULL)
1640 return -1;
1641 else
1642 return 1;
1643 }
1644 }
1645 return 0;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001646}
1647
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001648
Just van Rossum52e14d62002-12-30 22:08:05 +00001649/* Return an importer object for a sys.path/pkg.__path__ item 'p',
1650 possibly by fetching it from the path_importer_cache dict. If it
Thomas Wouters89f507f2006-12-13 04:49:30 +00001651 wasn't yet cached, traverse path_hooks until a hook is found
Just van Rossum52e14d62002-12-30 22:08:05 +00001652 that can handle the path item. Return None if no hook could;
1653 this tells our caller it should fall back to the builtin
1654 import mechanism. Cache the result in path_importer_cache.
1655 Returns a borrowed reference. */
1656
1657static PyObject *
1658get_path_importer(PyObject *path_importer_cache, PyObject *path_hooks,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001659 PyObject *p)
Just van Rossum52e14d62002-12-30 22:08:05 +00001660{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001661 PyObject *importer;
1662 Py_ssize_t j, nhooks;
Just van Rossum52e14d62002-12-30 22:08:05 +00001663
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001664 /* These conditions are the caller's responsibility: */
1665 assert(PyList_Check(path_hooks));
1666 assert(PyDict_Check(path_importer_cache));
Just van Rossum52e14d62002-12-30 22:08:05 +00001667
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001668 nhooks = PyList_Size(path_hooks);
1669 if (nhooks < 0)
1670 return NULL; /* Shouldn't happen */
Just van Rossum52e14d62002-12-30 22:08:05 +00001671
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001672 importer = PyDict_GetItem(path_importer_cache, p);
1673 if (importer != NULL)
1674 return importer;
Just van Rossum52e14d62002-12-30 22:08:05 +00001675
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001676 /* set path_importer_cache[p] to None to avoid recursion */
1677 if (PyDict_SetItem(path_importer_cache, p, Py_None) != 0)
1678 return NULL;
Just van Rossum52e14d62002-12-30 22:08:05 +00001679
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001680 for (j = 0; j < nhooks; j++) {
1681 PyObject *hook = PyList_GetItem(path_hooks, j);
1682 if (hook == NULL)
1683 return NULL;
1684 importer = PyObject_CallFunctionObjArgs(hook, p, NULL);
1685 if (importer != NULL)
1686 break;
Just van Rossum52e14d62002-12-30 22:08:05 +00001687
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001688 if (!PyErr_ExceptionMatches(PyExc_ImportError)) {
1689 return NULL;
1690 }
1691 PyErr_Clear();
1692 }
1693 if (importer == NULL) {
1694 importer = PyObject_CallFunctionObjArgs(
1695 (PyObject *)&PyNullImporter_Type, p, NULL
1696 );
1697 if (importer == NULL) {
1698 if (PyErr_ExceptionMatches(PyExc_ImportError)) {
1699 PyErr_Clear();
1700 return Py_None;
1701 }
1702 }
1703 }
1704 if (importer != NULL) {
1705 int err = PyDict_SetItem(path_importer_cache, p, importer);
1706 Py_DECREF(importer);
1707 if (err != 0)
1708 return NULL;
1709 }
1710 return importer;
Just van Rossum52e14d62002-12-30 22:08:05 +00001711}
1712
Christian Heimes9cd17752007-11-18 19:35:23 +00001713PyAPI_FUNC(PyObject *)
1714PyImport_GetImporter(PyObject *path) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001715 PyObject *importer=NULL, *path_importer_cache=NULL, *path_hooks=NULL;
Christian Heimes9cd17752007-11-18 19:35:23 +00001716
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001717 if ((path_importer_cache = PySys_GetObject("path_importer_cache"))) {
1718 if ((path_hooks = PySys_GetObject("path_hooks"))) {
1719 importer = get_path_importer(path_importer_cache,
1720 path_hooks, path);
1721 }
1722 }
1723 Py_XINCREF(importer); /* get_path_importer returns a borrowed reference */
1724 return importer;
Christian Heimes9cd17752007-11-18 19:35:23 +00001725}
1726
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001727/* Search the path (default sys.path) for a module. Return the
1728 corresponding filedescr struct, and (via return arguments) the
1729 pathname and an open file. Return NULL if the module is not found. */
1730
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001731#ifdef MS_COREDLL
Victor Stinner4d6c1c42011-03-08 23:49:04 +01001732extern FILE *_PyWin_FindRegisteredModule(PyObject *, struct filedescr **,
1733 PyObject **p_path);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001734#endif
1735
Victor Stinner547a2a62011-03-20 03:07:28 +01001736/* Forward */
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001737static int case_ok(PyObject *, Py_ssize_t, PyObject *);
Victor Stinner547a2a62011-03-20 03:07:28 +01001738static int find_init_module(PyObject *);
Just van Rossum52e14d62002-12-30 22:08:05 +00001739static struct filedescr importhookdescr = {"", "", IMP_HOOK};
Guido van Rossum197346f1997-10-31 18:38:52 +00001740
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001741/* Get the path of a module: get its importer and call importer.find_module()
1742 hook, or check if the module if a package (if path/__init__.py exists).
1743
1744 -1: error: a Python error occurred
1745 0: ignore: an error occurred because of invalid data, but the error is not
1746 important enough to be reported.
1747 1: get path: module not found, but *buf contains its path
1748 2: found: *p_fd is the file descriptor (IMP_HOOK or PKG_DIRECTORY)
1749 and *buf is the path */
1750
1751static int
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001752find_module_path(PyObject *fullname, PyObject *name, PyObject *path,
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001753 PyObject *path_hooks, PyObject *path_importer_cache,
Victor Stinner2fd76e42011-03-14 15:19:39 -04001754 PyObject **p_path, PyObject **p_loader, struct filedescr **p_fd)
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001755{
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001756 PyObject *path_unicode, *filename = NULL;
1757 Py_ssize_t len, pos;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001758 struct stat statbuf;
1759 static struct filedescr fd_package = {"", "", PKG_DIRECTORY};
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001760 int result, addsep;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001761
1762 if (PyUnicode_Check(path)) {
Victor Stinner2fd76e42011-03-14 15:19:39 -04001763 Py_INCREF(path);
1764 path_unicode = path;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001765 }
1766 else if (PyBytes_Check(path)) {
Victor Stinner2fd76e42011-03-14 15:19:39 -04001767 path_unicode = PyUnicode_DecodeFSDefaultAndSize(
1768 PyBytes_AS_STRING(path), PyBytes_GET_SIZE(path));
1769 if (path_unicode == NULL)
1770 return -1;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001771 }
1772 else
1773 return 0;
1774
Victor Stinner46084ba2011-10-06 02:39:42 +02001775 if (PyUnicode_READY(path_unicode))
1776 return -1;
1777
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001778 len = PyUnicode_GET_LENGTH(path_unicode);
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001779 if (PyUnicode_FindChar(path_unicode, 0, 0, len, 1) != -1) {
1780 result = 0;
1781 goto out; /* path contains '\0' */
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001782 }
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001783
1784 /* sys.path_hooks import hook */
1785 if (p_loader != NULL) {
Martin v. Löwisbd928fe2011-10-14 10:20:37 +02001786 _Py_IDENTIFIER(find_module);
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001787 PyObject *importer;
1788
1789 importer = get_path_importer(path_importer_cache,
1790 path_hooks, path);
1791 if (importer == NULL) {
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001792 result = -1;
1793 goto out;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001794 }
1795 /* Note: importer is a borrowed reference */
1796 if (importer != Py_None) {
1797 PyObject *loader;
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02001798 loader = _PyObject_CallMethodId(importer,
1799 &PyId_find_module, "O", fullname);
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001800 if (loader == NULL) {
1801 result = -1; /* error */
1802 goto out;
1803 }
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001804 if (loader != Py_None) {
1805 /* a loader was found */
1806 *p_loader = loader;
1807 *p_fd = &importhookdescr;
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001808 result = 2;
1809 goto out;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001810 }
1811 Py_DECREF(loader);
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001812 result = 0;
1813 goto out;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001814 }
1815 }
1816 /* no hook was found, use builtin import */
1817
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001818 addsep = 0;
1819 if (len > 0 && PyUnicode_READ_CHAR(path_unicode, len-1) != SEP
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001820#ifdef ALTSEP
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001821 && PyUnicode_READ_CHAR(path_unicode, len-1) != ALTSEP
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001822#endif
1823 )
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001824 addsep = 1;
1825 filename = PyUnicode_New(len + PyUnicode_GET_LENGTH(name) + addsep,
1826 Py_MAX(PyUnicode_MAX_CHAR_VALUE(path_unicode),
1827 PyUnicode_MAX_CHAR_VALUE(name)));
1828 if (filename == NULL) {
1829 result = -1;
1830 goto out;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001831 }
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001832 PyUnicode_CopyCharacters(filename, 0, path_unicode, 0, len);
1833 pos = len;
1834 if (addsep)
1835 PyUnicode_WRITE(PyUnicode_KIND(filename),
1836 PyUnicode_DATA(filename),
1837 pos++, SEP);
1838 PyUnicode_CopyCharacters(filename, pos, name, 0,
1839 PyUnicode_GET_LENGTH(name));
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001840
1841 /* Check for package import (buf holds a directory name,
1842 and there's an __init__ module in that directory */
1843#ifdef HAVE_STAT
Victor Stinner2fd76e42011-03-14 15:19:39 -04001844 if (_Py_stat(filename, &statbuf) == 0 && /* it exists */
Victor Stinnerd0296212011-03-14 14:04:10 -04001845 S_ISDIR(statbuf.st_mode)) /* it's a directory */
1846 {
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001847 int match;
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001848
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001849 match = case_ok(filename, 0, name);
1850 if (match < 0) {
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001851 result = -1;
1852 goto out;
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001853 }
1854 if (match) { /* case matches */
1855 if (find_init_module(filename)) { /* and has __init__.py */
Victor Stinner2fd76e42011-03-14 15:19:39 -04001856 *p_path = filename;
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001857 filename = NULL;
Victor Stinnerd0296212011-03-14 14:04:10 -04001858 *p_fd = &fd_package;
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001859 result = 2;
1860 goto out;
Victor Stinnerd0296212011-03-14 14:04:10 -04001861 }
1862 else {
1863 int err;
Victor Stinnerd0296212011-03-14 14:04:10 -04001864 err = PyErr_WarnFormat(PyExc_ImportWarning, 1,
Victor Stinner547a2a62011-03-20 03:07:28 +01001865 "Not importing directory %R: missing __init__.py",
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001866 filename);
Victor Stinner547a2a62011-03-20 03:07:28 +01001867 if (err) {
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001868 result = -1;
1869 goto out;
Victor Stinner547a2a62011-03-20 03:07:28 +01001870 }
Victor Stinnerd0296212011-03-14 14:04:10 -04001871 }
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001872 }
1873 }
1874#endif
Victor Stinner2fd76e42011-03-14 15:19:39 -04001875 *p_path = filename;
Martin v. Löwis9af29d32011-10-23 18:45:16 +02001876 filename = NULL;
1877 result = 1;
1878 out:
1879 Py_DECREF(path_unicode);
1880 Py_XDECREF(filename);
1881 return result;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001882}
1883
1884/* Find a module in search_path_list. For each path, try
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001885 find_module_path() or try each _PyImport_Filetab suffix.
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001886
1887 If the module is found, return a file descriptor, write the path in
1888 *p_filename, write the pointer to the file object into *p_fp, and (if
1889 p_loader is not NULL) the loader into *p_loader.
1890
1891 Otherwise, raise an exception and return NULL. */
1892
Victor Stinner37580282011-03-20 01:34:43 +01001893static struct filedescr*
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001894find_module_path_list(PyObject *fullname, PyObject *name,
Victor Stinner37580282011-03-20 01:34:43 +01001895 PyObject *search_path_list, PyObject *path_hooks,
1896 PyObject *path_importer_cache,
Victor Stinner2fd76e42011-03-14 15:19:39 -04001897 PyObject **p_path, FILE **p_fp, PyObject **p_loader)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001898{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001899 Py_ssize_t i, npath;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001900 struct filedescr *fdp = NULL;
1901 char *filemode;
1902 FILE *fp = NULL;
Victor Stinner2fd76e42011-03-14 15:19:39 -04001903 PyObject *prefix, *filename;
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001904 int match;
Victor Stinner53dc7352011-03-20 01:50:21 +01001905
Victor Stinner37580282011-03-20 01:34:43 +01001906 npath = PyList_Size(search_path_list);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001907 for (i = 0; i < npath; i++) {
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001908 PyObject *path;
1909 int ok;
1910
1911 path = PyList_GetItem(search_path_list, i);
1912 if (path == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001913 return NULL;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001914
Victor Stinner2fd76e42011-03-14 15:19:39 -04001915 prefix = NULL;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001916 ok = find_module_path(fullname, name, path,
1917 path_hooks, path_importer_cache,
Victor Stinner2fd76e42011-03-14 15:19:39 -04001918 &prefix, p_loader, &fdp);
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001919 if (ok < 0)
1920 return NULL;
1921 if (ok == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001922 continue;
Victor Stinner2fd76e42011-03-14 15:19:39 -04001923 if (ok == 2) {
1924 *p_path = prefix;
Victor Stinnerd68c2cf2011-03-12 16:02:28 -05001925 return fdp;
Victor Stinner2fd76e42011-03-14 15:19:39 -04001926 }
Amaury Forgeot d'Arcf1ca0b12008-06-11 17:40:47 +00001927
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001928 for (fdp = _PyImport_Filetab; fdp->suffix != NULL; fdp++) {
Victor Stinnera1fe1f82011-09-23 18:59:08 +02001929 struct stat statbuf;
1930
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001931 filemode = fdp->mode;
1932 if (filemode[0] == 'U')
1933 filemode = "r" PY_STDIOTEXTMODE;
Victor Stinnerd0296212011-03-14 14:04:10 -04001934
Victor Stinner2fd76e42011-03-14 15:19:39 -04001935 filename = PyUnicode_FromFormat("%U%s", prefix, fdp->suffix);
1936 if (filename == NULL) {
1937 Py_DECREF(prefix);
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001938 return NULL;
Victor Stinner2fd76e42011-03-14 15:19:39 -04001939 }
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001940
1941 if (Py_VerboseFlag > 1)
1942 PySys_FormatStderr("# trying %R\n", filename);
1943
Victor Stinnera1fe1f82011-09-23 18:59:08 +02001944 if (_Py_stat(filename, &statbuf) == 0 && /* it exists */
1945 S_ISDIR(statbuf.st_mode)) /* it's a directory */
1946 {
1947 Py_DECREF(filename);
1948 continue;
1949 }
1950
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001951 fp = _Py_fopen(filename, filemode);
1952 if (fp == NULL) {
1953 Py_DECREF(filename);
Victor Stinner925ef392011-06-20 15:01:10 +02001954 if (PyErr_Occurred()) {
1955 Py_DECREF(prefix);
1956 return NULL;
1957 }
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001958 continue;
1959 }
1960 match = case_ok(filename, -(Py_ssize_t)strlen(fdp->suffix), name);
1961 if (match < 0) {
Victor Stinner2fd76e42011-03-14 15:19:39 -04001962 Py_DECREF(prefix);
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001963 Py_DECREF(filename);
1964 return NULL;
1965 }
1966 if (match) {
Victor Stinner2fd76e42011-03-14 15:19:39 -04001967 Py_DECREF(prefix);
1968 *p_path = filename;
Victor Stinnerd0296212011-03-14 14:04:10 -04001969 *p_fp = fp;
1970 return fdp;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001971 }
Victor Stinnerc9a271c2011-03-14 14:34:13 -04001972 Py_DECREF(filename);
Victor Stinnerd0296212011-03-14 14:04:10 -04001973
1974 fclose(fp);
1975 fp = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001976 }
Victor Stinner2fd76e42011-03-14 15:19:39 -04001977 Py_DECREF(prefix);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001978 }
Victor Stinnerd0296212011-03-14 14:04:10 -04001979 PyErr_Format(PyExc_ImportError,
Victor Stinner98dbba52011-03-14 15:15:47 -04001980 "No module named %R", name);
Victor Stinnerd0296212011-03-14 14:04:10 -04001981 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001982}
1983
Victor Stinner37580282011-03-20 01:34:43 +01001984/* Find a module:
1985
1986 - try find_module() of each sys.meta_path hook
1987 - try find_frozen()
1988 - try is_builtin()
1989 - try _PyWin_FindRegisteredModule() (Windows only)
1990 - otherwise, call find_module_path_list() with search_path_list (if not
1991 NULL) or sys.path
1992
Victor Stinner2fd76e42011-03-14 15:19:39 -04001993 fullname can be NULL, but only if p_loader is NULL.
1994
Victor Stinner37580282011-03-20 01:34:43 +01001995 Return:
1996
1997 - &fd_builtin (C_BUILTIN) if it is a builtin
1998 - &fd_frozen (PY_FROZEN) if it is frozen
Victor Stinner2fd76e42011-03-14 15:19:39 -04001999 - &fd_package (PKG_DIRECTORY) and write the filename into *p_path
Victor Stinner37580282011-03-20 01:34:43 +01002000 if it is a package
2001 - &importhookdescr (IMP_HOOK) and write the loader into *p_loader if a
2002 importer loader was found
2003 - a file descriptor (PY_SOURCE, PY_COMPILED, C_EXTENSION, PY_RESOURCE or
2004 PY_CODERESOURCE: see _PyImport_Filetab), write the filename into
Victor Stinner2fd76e42011-03-14 15:19:39 -04002005 *p_path and the pointer to the open file into *p_fp
Victor Stinner37580282011-03-20 01:34:43 +01002006 - NULL on error
2007
Victor Stinner2fd76e42011-03-14 15:19:39 -04002008 By default, *p_path, *p_fp and *p_loader (if set) are set to NULL.
2009 Eg. *p_path is set to NULL for a builtin package.
2010*/
Victor Stinner37580282011-03-20 01:34:43 +01002011
2012static struct filedescr *
Victor Stinnerad3c03b2011-03-14 09:21:33 -04002013find_module(PyObject *fullname, PyObject *name, PyObject *search_path_list,
Victor Stinner2fd76e42011-03-14 15:19:39 -04002014 PyObject **p_path, FILE **p_fp, PyObject **p_loader)
Victor Stinner37580282011-03-20 01:34:43 +01002015{
2016 Py_ssize_t i, npath;
2017 static struct filedescr fd_frozen = {"", "", PY_FROZEN};
2018 static struct filedescr fd_builtin = {"", "", C_BUILTIN};
2019 PyObject *path_hooks, *path_importer_cache;
Victor Stinner37580282011-03-20 01:34:43 +01002020
Victor Stinner2fd76e42011-03-14 15:19:39 -04002021 *p_path = NULL;
Victor Stinner37580282011-03-20 01:34:43 +01002022 *p_fp = NULL;
2023 if (p_loader != NULL)
2024 *p_loader = NULL;
2025
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002026 if (PyUnicode_GET_LENGTH(name) > MAXPATHLEN) {
2027 PyErr_SetString(PyExc_OverflowError,
2028 "module name is too long");
2029 return NULL;
2030 }
2031
Victor Stinner37580282011-03-20 01:34:43 +01002032 /* sys.meta_path import hook */
2033 if (p_loader != NULL) {
Martin v. Löwisbd928fe2011-10-14 10:20:37 +02002034 _Py_IDENTIFIER(find_module);
Victor Stinner37580282011-03-20 01:34:43 +01002035 PyObject *meta_path;
2036
2037 meta_path = PySys_GetObject("meta_path");
2038 if (meta_path == NULL || !PyList_Check(meta_path)) {
Victor Stinner16191322011-09-15 19:28:05 +02002039 PyErr_SetString(PyExc_RuntimeError,
Victor Stinner37580282011-03-20 01:34:43 +01002040 "sys.meta_path must be a list of "
2041 "import hooks");
2042 return NULL;
2043 }
2044 Py_INCREF(meta_path); /* zap guard */
2045 npath = PyList_Size(meta_path);
2046 for (i = 0; i < npath; i++) {
2047 PyObject *loader;
2048 PyObject *hook = PyList_GetItem(meta_path, i);
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002049 loader = _PyObject_CallMethodId(hook, &PyId_find_module,
Victor Stinnerad3c03b2011-03-14 09:21:33 -04002050 "OO", fullname,
Victor Stinner37580282011-03-20 01:34:43 +01002051 search_path_list != NULL ?
2052 search_path_list : Py_None);
2053 if (loader == NULL) {
2054 Py_DECREF(meta_path);
2055 return NULL; /* true error */
2056 }
2057 if (loader != Py_None) {
2058 /* a loader was found */
2059 *p_loader = loader;
2060 Py_DECREF(meta_path);
2061 return &importhookdescr;
2062 }
2063 Py_DECREF(loader);
2064 }
2065 Py_DECREF(meta_path);
2066 }
2067
Victor Stinnerdf75a022011-03-14 13:40:04 -04002068 if (find_frozen(fullname) != NULL)
Victor Stinnerad3c03b2011-03-14 09:21:33 -04002069 return &fd_frozen;
Victor Stinner37580282011-03-20 01:34:43 +01002070
2071 if (search_path_list == NULL) {
2072#ifdef MS_COREDLL
2073 FILE *fp;
2074 struct filedescr *fdp;
Victor Stinner37580282011-03-20 01:34:43 +01002075#endif
Victor Stinnerdf75a022011-03-14 13:40:04 -04002076 if (is_builtin(name))
Victor Stinner37580282011-03-20 01:34:43 +01002077 return &fd_builtin;
Victor Stinner37580282011-03-20 01:34:43 +01002078#ifdef MS_COREDLL
Victor Stinner2fd76e42011-03-14 15:19:39 -04002079 fp = _PyWin_FindRegisteredModule(name, &fdp, p_path);
Victor Stinner37580282011-03-20 01:34:43 +01002080 if (fp != NULL) {
Victor Stinner37580282011-03-20 01:34:43 +01002081 *p_fp = fp;
2082 return fdp;
2083 }
2084 else if (PyErr_Occurred())
2085 return NULL;
2086#endif
Victor Stinner37580282011-03-20 01:34:43 +01002087 search_path_list = PySys_GetObject("path");
2088 }
2089
2090 if (search_path_list == NULL || !PyList_Check(search_path_list)) {
Victor Stinner16191322011-09-15 19:28:05 +02002091 PyErr_SetString(PyExc_RuntimeError,
Victor Stinner37580282011-03-20 01:34:43 +01002092 "sys.path must be a list of directory names");
2093 return NULL;
2094 }
2095
2096 path_hooks = PySys_GetObject("path_hooks");
2097 if (path_hooks == NULL || !PyList_Check(path_hooks)) {
Victor Stinner16191322011-09-15 19:28:05 +02002098 PyErr_SetString(PyExc_RuntimeError,
Victor Stinner37580282011-03-20 01:34:43 +01002099 "sys.path_hooks must be a list of "
2100 "import hooks");
2101 return NULL;
2102 }
2103 path_importer_cache = PySys_GetObject("path_importer_cache");
2104 if (path_importer_cache == NULL ||
2105 !PyDict_Check(path_importer_cache)) {
Victor Stinner16191322011-09-15 19:28:05 +02002106 PyErr_SetString(PyExc_RuntimeError,
Victor Stinner37580282011-03-20 01:34:43 +01002107 "sys.path_importer_cache must be a dict");
2108 return NULL;
2109 }
2110
2111 return find_module_path_list(fullname, name,
2112 search_path_list, path_hooks,
2113 path_importer_cache,
Victor Stinner2fd76e42011-03-14 15:19:39 -04002114 p_path, p_fp, p_loader);
Victor Stinner37580282011-03-20 01:34:43 +01002115}
2116
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002117/* case_bytes(char* buf, Py_ssize_t len, Py_ssize_t namelen, char* name)
Tim Petersd1e87a82001-03-01 18:12:00 +00002118 * The arguments here are tricky, best shown by example:
2119 * /a/b/c/d/e/f/g/h/i/j/k/some_long_module_name.py\0
2120 * ^ ^ ^ ^
2121 * |--------------------- buf ---------------------|
2122 * |------------------- len ------------------|
2123 * |------ name -------|
2124 * |----- namelen -----|
2125 * buf is the full path, but len only counts up to (& exclusive of) the
2126 * extension. name is the module name, also exclusive of extension.
2127 *
2128 * We've already done a successful stat() or fopen() on buf, so know that
2129 * there's some match, possibly case-insensitive.
2130 *
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002131 * case_bytes() is to return 1 if there's a case-sensitive match for
2132 * name, else 0. case_bytes() is also to return 1 if envar PYTHONCASEOK
Tim Peters50d8d372001-02-28 05:34:27 +00002133 * exists.
Tim Petersd1e87a82001-03-01 18:12:00 +00002134 *
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002135 * case_bytes() is used to implement case-sensitive import semantics even
Tim Peters50d8d372001-02-28 05:34:27 +00002136 * on platforms with case-insensitive filesystems. It's trivial to implement
2137 * for case-sensitive filesystems. It's pretty much a cross-platform
2138 * nightmare for systems with case-insensitive filesystems.
2139 */
Guido van Rossum0980bd91998-02-13 17:18:36 +00002140
Tim Peters50d8d372001-02-28 05:34:27 +00002141/* First we may need a pile of platform-specific header files; the sequence
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002142 * of #if's here should match the sequence in the body of case_bytes().
Tim Peters50d8d372001-02-28 05:34:27 +00002143 */
Jason Tishler7961aa62005-05-20 00:56:54 +00002144#if defined(MS_WINDOWS)
Guido van Rossum0980bd91998-02-13 17:18:36 +00002145#include <windows.h>
Guido van Rossum4c3f57c2001-01-10 20:40:46 +00002146
Tim Peters50d8d372001-02-28 05:34:27 +00002147#elif defined(DJGPP)
2148#include <dir.h>
2149
Jason Tishler7961aa62005-05-20 00:56:54 +00002150#elif (defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) && defined(HAVE_DIRENT_H)
Tim Peters430f5d42001-03-01 01:30:56 +00002151#include <sys/types.h>
2152#include <dirent.h>
2153
Andrew MacIntyred9400542002-02-26 11:41:34 +00002154#elif defined(PYOS_OS2)
2155#define INCL_DOS
2156#define INCL_DOSERRORS
2157#define INCL_NOPMAPI
2158#include <os2.h>
Tim Peters50d8d372001-02-28 05:34:27 +00002159#endif
2160
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002161#if defined(DJGPP) \
2162 || ((defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) \
2163 && defined(HAVE_DIRENT_H)) \
2164 || defined(PYOS_OS2)
2165# define USE_CASE_OK_BYTES
2166#endif
2167
2168
2169#ifdef USE_CASE_OK_BYTES
Guido van Rossum0980bd91998-02-13 17:18:36 +00002170static int
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002171case_bytes(char *buf, Py_ssize_t len, Py_ssize_t namelen, const char *name)
Guido van Rossum0980bd91998-02-13 17:18:36 +00002172{
Tim Peters50d8d372001-02-28 05:34:27 +00002173/* Pick a platform-specific implementation; the sequence of #if's here should
2174 * match the sequence just above.
2175 */
2176
Tim Peters50d8d372001-02-28 05:34:27 +00002177/* DJGPP */
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002178#if defined(DJGPP)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002179 struct ffblk ffblk;
2180 int done;
Tim Peters50d8d372001-02-28 05:34:27 +00002181
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002182 if (Py_GETENV("PYTHONCASEOK") != NULL)
2183 return 1;
Tim Peters50d8d372001-02-28 05:34:27 +00002184
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002185 done = findfirst(buf, &ffblk, FA_ARCH|FA_RDONLY|FA_HIDDEN|FA_DIREC);
2186 if (done) {
2187 PyErr_Format(PyExc_NameError,
2188 "Can't find file for module %.100s\n(filename %.300s)",
2189 name, buf);
Victor Stinner9c61e242011-03-22 01:22:27 +01002190 return -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002191 }
2192 return strncmp(ffblk.ff_name, name, namelen) == 0;
Guido van Rossum0980bd91998-02-13 17:18:36 +00002193
Jason Tishler7961aa62005-05-20 00:56:54 +00002194/* new-fangled macintosh (macosx) or Cygwin */
2195#elif (defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) && defined(HAVE_DIRENT_H)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002196 DIR *dirp;
2197 struct dirent *dp;
2198 char dirname[MAXPATHLEN + 1];
2199 const int dirlen = len - namelen - 1; /* don't want trailing SEP */
Tim Peters430f5d42001-03-01 01:30:56 +00002200
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002201 if (Py_GETENV("PYTHONCASEOK") != NULL)
2202 return 1;
Tim Petersdbe6ebb2001-03-01 08:47:29 +00002203
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002204 /* Copy the dir component into dirname; substitute "." if empty */
2205 if (dirlen <= 0) {
2206 dirname[0] = '.';
2207 dirname[1] = '\0';
2208 }
2209 else {
2210 assert(dirlen <= MAXPATHLEN);
2211 memcpy(dirname, buf, dirlen);
2212 dirname[dirlen] = '\0';
2213 }
2214 /* Open the directory and search the entries for an exact match. */
2215 dirp = opendir(dirname);
2216 if (dirp) {
2217 char *nameWithExt = buf + len - namelen;
2218 while ((dp = readdir(dirp)) != NULL) {
2219 const int thislen =
Tim Peters430f5d42001-03-01 01:30:56 +00002220#ifdef _DIRENT_HAVE_D_NAMELEN
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002221 dp->d_namlen;
Tim Peters430f5d42001-03-01 01:30:56 +00002222#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002223 strlen(dp->d_name);
Tim Peters430f5d42001-03-01 01:30:56 +00002224#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002225 if (thislen >= namelen &&
2226 strcmp(dp->d_name, nameWithExt) == 0) {
2227 (void)closedir(dirp);
2228 return 1; /* Found */
2229 }
2230 }
2231 (void)closedir(dirp);
2232 }
2233 return 0 ; /* Not found */
Tim Peters430f5d42001-03-01 01:30:56 +00002234
Andrew MacIntyred9400542002-02-26 11:41:34 +00002235/* OS/2 */
2236#elif defined(PYOS_OS2)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002237 HDIR hdir = 1;
2238 ULONG srchcnt = 1;
2239 FILEFINDBUF3 ffbuf;
2240 APIRET rc;
Andrew MacIntyred9400542002-02-26 11:41:34 +00002241
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002242 if (Py_GETENV("PYTHONCASEOK") != NULL)
2243 return 1;
Andrew MacIntyred9400542002-02-26 11:41:34 +00002244
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002245 rc = DosFindFirst(buf,
2246 &hdir,
2247 FILE_READONLY | FILE_HIDDEN | FILE_SYSTEM | FILE_DIRECTORY,
2248 &ffbuf, sizeof(ffbuf),
2249 &srchcnt,
2250 FIL_STANDARD);
2251 if (rc != NO_ERROR)
2252 return 0;
2253 return strncmp(ffbuf.achName, name, namelen) == 0;
Andrew MacIntyred9400542002-02-26 11:41:34 +00002254
Tim Peters50d8d372001-02-28 05:34:27 +00002255/* assuming it's a case-sensitive filesystem, so there's nothing to do! */
2256#else
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002257# error "USE_CASE_OK_BYTES is not correctly defined"
2258#endif
2259}
2260#endif
2261
2262/*
2263 * Check if a filename case matchs the name case. We've already done a
2264 * successful stat() or fopen() on buf, so know that there's some match,
2265 * possibly case-insensitive.
2266 *
2267 * case_ok() is to return 1 if there's a case-sensitive match for name, 0 if it
2268 * the filename doesn't match, or -1 on error. case_ok() is also to return 1
2269 * if envar PYTHONCASEOK exists.
2270 *
2271 * case_ok() is used to implement case-sensitive import semantics even
2272 * on platforms with case-insensitive filesystems. It's trivial to implement
2273 * for case-sensitive filesystems. It's pretty much a cross-platform
2274 * nightmare for systems with case-insensitive filesystems.
2275 */
2276
2277static int
2278case_ok(PyObject *filename, Py_ssize_t prefix_delta, PyObject *name)
2279{
2280#ifdef MS_WINDOWS
2281 WIN32_FIND_DATAW data;
2282 HANDLE h;
2283 int cmp;
Victor Stinnerbeac78b2011-10-11 21:55:01 +02002284 wchar_t *wname;
Victor Stinner8c981892011-10-11 22:27:13 +02002285 Py_ssize_t wname_len;
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002286
2287 if (Py_GETENV("PYTHONCASEOK") != NULL)
2288 return 1;
2289
2290 h = FindFirstFileW(PyUnicode_AS_UNICODE(filename), &data);
2291 if (h == INVALID_HANDLE_VALUE) {
2292 PyErr_Format(PyExc_NameError,
2293 "Can't find file for module %R\n(filename %R)",
2294 name, filename);
2295 return 0;
2296 }
2297 FindClose(h);
Victor Stinnerbeac78b2011-10-11 21:55:01 +02002298
2299 wname = PyUnicode_AsUnicodeAndSize(name, &wname_len);
2300 if (wname == NULL)
2301 return -1;
2302
2303 cmp = wcsncmp(data.cFileName, wname, wname_len);
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002304 return cmp == 0;
2305#elif defined(USE_CASE_OK_BYTES)
2306 int match;
2307 PyObject *filebytes, *namebytes;
2308 filebytes = PyUnicode_EncodeFSDefault(filename);
2309 if (filebytes == NULL)
2310 return -1;
2311 namebytes = PyUnicode_EncodeFSDefault(name);
2312 if (namebytes == NULL) {
2313 Py_DECREF(filebytes);
2314 return -1;
2315 }
2316 match = case_bytes(
2317 PyBytes_AS_STRING(filebytes),
2318 PyBytes_GET_SIZE(filebytes) + prefix_delta,
Victor Stinner1304f2d2011-03-20 04:28:55 +01002319 PyBytes_GET_SIZE(namebytes),
2320 PyBytes_AS_STRING(namebytes));
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002321 Py_DECREF(filebytes);
2322 Py_DECREF(namebytes);
2323 return match;
2324#else
2325 /* assuming it's a case-sensitive filesystem, so there's nothing to do! */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002326 return 1;
Guido van Rossum0980bd91998-02-13 17:18:36 +00002327
Guido van Rossum4d1b3b91998-02-13 23:27:59 +00002328#endif
Tim Peters50d8d372001-02-28 05:34:27 +00002329}
Guido van Rossum4d1b3b91998-02-13 23:27:59 +00002330
Guido van Rossum197346f1997-10-31 18:38:52 +00002331#ifdef HAVE_STAT
Victor Stinner4f4402c2010-08-14 14:50:26 +00002332
Victor Stinner547a2a62011-03-20 03:07:28 +01002333/* Helper to look for __init__.py or __init__.py[co] in potential package.
2334 Return 1 if __init__ was found, 0 if not, or -1 on error. */
Guido van Rossum197346f1997-10-31 18:38:52 +00002335static int
Victor Stinner547a2a62011-03-20 03:07:28 +01002336find_init_module(PyObject *directory)
Guido van Rossum197346f1997-10-31 18:38:52 +00002337{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002338 struct stat statbuf;
Victor Stinner547a2a62011-03-20 03:07:28 +01002339 PyObject *filename;
2340 int match;
Guido van Rossum197346f1997-10-31 18:38:52 +00002341
Victor Stinner547a2a62011-03-20 03:07:28 +01002342 filename = PyUnicode_FromFormat("%U%c__init__.py", directory, SEP);
2343 if (filename == NULL)
2344 return -1;
2345 if (_Py_stat(filename, &statbuf) == 0) {
Victor Stinnercc9564e2011-03-20 04:58:29 +01002346 /* 3=len(".py") */
2347 match = case_ok(filename, -3, initstr);
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002348 if (match < 0) {
2349 Py_DECREF(filename);
2350 return -1;
2351 }
2352 if (match) {
Victor Stinner547a2a62011-03-20 03:07:28 +01002353 Py_DECREF(filename);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002354 return 1;
2355 }
2356 }
Victor Stinner547a2a62011-03-20 03:07:28 +01002357 Py_DECREF(filename);
2358
2359 filename = PyUnicode_FromFormat("%U%c__init__.py%c",
2360 directory, SEP, Py_OptimizeFlag ? 'o' : 'c');
2361 if (filename == NULL)
2362 return -1;
2363 if (_Py_stat(filename, &statbuf) == 0) {
Victor Stinnercc9564e2011-03-20 04:58:29 +01002364 /* 4=len(".pyc") */
2365 match = case_ok(filename, -4, initstr);
Victor Stinnerc9a271c2011-03-14 14:34:13 -04002366 if (match < 0) {
2367 Py_DECREF(filename);
2368 return -1;
2369 }
2370 if (match) {
Victor Stinner547a2a62011-03-20 03:07:28 +01002371 Py_DECREF(filename);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002372 return 1;
2373 }
2374 }
Victor Stinner547a2a62011-03-20 03:07:28 +01002375 Py_DECREF(filename);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002376 return 0;
Guido van Rossum197346f1997-10-31 18:38:52 +00002377}
Guido van Rossum48a680c2001-03-02 06:34:14 +00002378
Guido van Rossum197346f1997-10-31 18:38:52 +00002379#endif /* HAVE_STAT */
2380
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002381
Victor Stinner95872862011-03-07 18:20:56 +01002382static int init_builtin(PyObject *); /* Forward */
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002383
Victor Stinner44c6c152010-08-09 00:59:10 +00002384static PyObject*
Victor Stinner95872862011-03-07 18:20:56 +01002385load_builtin(PyObject *name, int type)
Victor Stinner44c6c152010-08-09 00:59:10 +00002386{
2387 PyObject *m, *modules;
2388 int err;
2389
Victor Stinner44c6c152010-08-09 00:59:10 +00002390 if (type == C_BUILTIN)
2391 err = init_builtin(name);
2392 else
Victor Stinner95872862011-03-07 18:20:56 +01002393 err = PyImport_ImportFrozenModuleObject(name);
Victor Stinner44c6c152010-08-09 00:59:10 +00002394 if (err < 0)
2395 return NULL;
2396 if (err == 0) {
2397 PyErr_Format(PyExc_ImportError,
Victor Stinner95872862011-03-07 18:20:56 +01002398 "Purported %s module %R not found",
2399 type == C_BUILTIN ? "builtin" : "frozen",
Victor Stinner44c6c152010-08-09 00:59:10 +00002400 name);
2401 return NULL;
2402 }
2403
2404 modules = PyImport_GetModuleDict();
Victor Stinner95872862011-03-07 18:20:56 +01002405 m = PyDict_GetItem(modules, name);
Victor Stinner44c6c152010-08-09 00:59:10 +00002406 if (m == NULL) {
2407 PyErr_Format(
2408 PyExc_ImportError,
Victor Stinner95872862011-03-07 18:20:56 +01002409 "%s module %R not properly initialized",
2410 type == C_BUILTIN ? "builtin" : "frozen",
Victor Stinner44c6c152010-08-09 00:59:10 +00002411 name);
2412 return NULL;
2413 }
2414 Py_INCREF(m);
2415 return m;
2416}
2417
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002418/* Load an external module using the default search path and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00002419 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002420
Guido van Rossum79f25d91997-04-29 20:08:16 +00002421static PyObject *
Victor Stinner41c5fec2011-03-13 21:46:30 -04002422load_module(PyObject *name, FILE *fp, PyObject *pathname, int type, PyObject *loader)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002423{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002424 PyObject *m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002425
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002426 /* First check that there's an open file (if we need one) */
2427 switch (type) {
2428 case PY_SOURCE:
2429 case PY_COMPILED:
2430 if (fp == NULL) {
2431 PyErr_Format(PyExc_ValueError,
Victor Stinner41c5fec2011-03-13 21:46:30 -04002432 "file object required for import (type code %d)",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002433 type);
2434 return NULL;
2435 }
2436 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002437
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002438 switch (type) {
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002439
Victor Stinner41c5fec2011-03-13 21:46:30 -04002440 case PY_SOURCE:
2441 m = load_source_module(name, pathname, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002442 break;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002443
Victor Stinner41c5fec2011-03-13 21:46:30 -04002444 case PY_COMPILED:
2445 m = load_compiled_module(name, pathname, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002446 break;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002447
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002448#ifdef HAVE_DYNAMIC_LOADING
Victor Stinner41c5fec2011-03-13 21:46:30 -04002449 case C_EXTENSION:
2450 m = _PyImport_LoadDynamicModule(name, pathname, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002451 break;
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002452#endif
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002453
Victor Stinner41c5fec2011-03-13 21:46:30 -04002454 case PKG_DIRECTORY:
2455 m = load_package(name, pathname);
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 C_BUILTIN:
Victor Stinner41c5fec2011-03-13 21:46:30 -04002459 case PY_FROZEN:
2460 m = load_builtin(name, type);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002461 break;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002462
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002463 case IMP_HOOK: {
Martin v. Löwisbd928fe2011-10-14 10:20:37 +02002464 _Py_IDENTIFIER(load_module);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002465 if (loader == NULL) {
2466 PyErr_SetString(PyExc_ImportError,
2467 "import hook without loader");
2468 return NULL;
2469 }
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002470 m = _PyObject_CallMethodId(loader, &PyId_load_module, "O", name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002471 break;
2472 }
Just van Rossum52e14d62002-12-30 22:08:05 +00002473
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002474 default:
2475 PyErr_Format(PyExc_ImportError,
Victor Stinner98dbba52011-03-14 15:15:47 -04002476 "Don't know how to import %R (type code %d)",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002477 name, type);
2478 m = NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002479
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002480 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002481
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002482 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002483}
2484
2485
2486/* Initialize a built-in module.
Thomas Wouters89f507f2006-12-13 04:49:30 +00002487 Return 1 for success, 0 if the module is not found, and -1 with
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002488 an exception set if the initialization failed. */
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002489
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002490static int
Victor Stinner95872862011-03-07 18:20:56 +01002491init_builtin(PyObject *name)
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002492{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002493 struct _inittab *p;
Guido van Rossum25ce5661997-08-02 03:10:38 +00002494
Victor Stinner95872862011-03-07 18:20:56 +01002495 if (_PyImport_FindExtensionObject(name, name) != NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002496 return 1;
Guido van Rossum25ce5661997-08-02 03:10:38 +00002497
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002498 for (p = PyImport_Inittab; p->name != NULL; p++) {
2499 PyObject *mod;
Victor Stinner95872862011-03-07 18:20:56 +01002500 if (PyUnicode_CompareWithASCIIString(name, p->name) == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002501 if (p->initfunc == NULL) {
2502 PyErr_Format(PyExc_ImportError,
Victor Stinner95872862011-03-07 18:20:56 +01002503 "Cannot re-init internal module %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002504 name);
2505 return -1;
2506 }
2507 if (Py_VerboseFlag)
Victor Stinner95872862011-03-07 18:20:56 +01002508 PySys_FormatStderr("import %U # builtin\n", name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002509 mod = (*p->initfunc)();
2510 if (mod == 0)
2511 return -1;
Victor Stinner95872862011-03-07 18:20:56 +01002512 if (_PyImport_FixupExtensionObject(mod, name, name) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002513 return -1;
2514 /* FixupExtension has put the module into sys.modules,
2515 so we can release our own reference. */
2516 Py_DECREF(mod);
2517 return 1;
2518 }
2519 }
2520 return 0;
Guido van Rossum7f133ed1991-02-19 12:23:57 +00002521}
Guido van Rossumf56e3db1993-04-01 20:59:32 +00002522
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002523
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002524/* Frozen modules */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002525
Guido van Rossumcfd0a221996-06-17 17:06:34 +00002526static struct _frozen *
Victor Stinner53dc7352011-03-20 01:50:21 +01002527find_frozen(PyObject *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002528{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002529 struct _frozen *p;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002530
Victor Stinner53dc7352011-03-20 01:50:21 +01002531 if (name == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002532 return NULL;
Benjamin Petersond968e272008-11-05 22:48:33 +00002533
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002534 for (p = PyImport_FrozenModules; ; p++) {
2535 if (p->name == NULL)
2536 return NULL;
Victor Stinner53dc7352011-03-20 01:50:21 +01002537 if (PyUnicode_CompareWithASCIIString(name, p->name) == 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002538 break;
2539 }
2540 return p;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002541}
2542
Guido van Rossum79f25d91997-04-29 20:08:16 +00002543static PyObject *
Victor Stinner53dc7352011-03-20 01:50:21 +01002544get_frozen_object(PyObject *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002545{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002546 struct _frozen *p = find_frozen(name);
2547 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002548
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002549 if (p == NULL) {
2550 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002551 "No such frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002552 name);
2553 return NULL;
2554 }
2555 if (p->code == NULL) {
2556 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002557 "Excluded frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002558 name);
2559 return NULL;
2560 }
2561 size = p->size;
2562 if (size < 0)
2563 size = -size;
2564 return PyMarshal_ReadObjectFromString((char *)p->code, size);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002565}
2566
Brett Cannon8d110132009-03-15 02:20:16 +00002567static PyObject *
Victor Stinner53dc7352011-03-20 01:50:21 +01002568is_frozen_package(PyObject *name)
Brett Cannon8d110132009-03-15 02:20:16 +00002569{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002570 struct _frozen *p = find_frozen(name);
2571 int size;
Brett Cannon8d110132009-03-15 02:20:16 +00002572
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002573 if (p == NULL) {
2574 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002575 "No such frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002576 name);
2577 return NULL;
2578 }
Brett Cannon8d110132009-03-15 02:20:16 +00002579
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002580 size = p->size;
Brett Cannon8d110132009-03-15 02:20:16 +00002581
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002582 if (size < 0)
2583 Py_RETURN_TRUE;
2584 else
2585 Py_RETURN_FALSE;
Brett Cannon8d110132009-03-15 02:20:16 +00002586}
2587
2588
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002589/* Initialize a frozen module.
Brett Cannon3c2ac442009-03-08 20:49:47 +00002590 Return 1 for success, 0 if the module is not found, and -1 with
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002591 an exception set if the initialization failed.
2592 This function is also used from frozenmain.c */
Guido van Rossum0b344901995-02-07 15:35:27 +00002593
2594int
Victor Stinner53dc7352011-03-20 01:50:21 +01002595PyImport_ImportFrozenModuleObject(PyObject *name)
Guido van Rossumf56e3db1993-04-01 20:59:32 +00002596{
Victor Stinner53dc7352011-03-20 01:50:21 +01002597 struct _frozen *p;
2598 PyObject *co, *m, *path;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002599 int ispackage;
2600 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002601
Victor Stinner53dc7352011-03-20 01:50:21 +01002602 p = find_frozen(name);
2603
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002604 if (p == NULL)
2605 return 0;
2606 if (p->code == NULL) {
2607 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002608 "Excluded frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002609 name);
2610 return -1;
2611 }
2612 size = p->size;
2613 ispackage = (size < 0);
2614 if (ispackage)
2615 size = -size;
2616 if (Py_VerboseFlag)
Victor Stinner53dc7352011-03-20 01:50:21 +01002617 PySys_FormatStderr("import %U # frozen%s\n",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002618 name, ispackage ? " package" : "");
2619 co = PyMarshal_ReadObjectFromString((char *)p->code, size);
2620 if (co == NULL)
2621 return -1;
2622 if (!PyCode_Check(co)) {
2623 PyErr_Format(PyExc_TypeError,
Victor Stinner53dc7352011-03-20 01:50:21 +01002624 "frozen object %R is not a code object",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002625 name);
2626 goto err_return;
2627 }
2628 if (ispackage) {
2629 /* Set __path__ to the package name */
Victor Stinner53dc7352011-03-20 01:50:21 +01002630 PyObject *d, *l;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002631 int err;
Victor Stinner53dc7352011-03-20 01:50:21 +01002632 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002633 if (m == NULL)
2634 goto err_return;
2635 d = PyModule_GetDict(m);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002636 l = PyList_New(1);
2637 if (l == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002638 goto err_return;
2639 }
Victor Stinner53dc7352011-03-20 01:50:21 +01002640 Py_INCREF(name);
2641 PyList_SET_ITEM(l, 0, name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002642 err = PyDict_SetItemString(d, "__path__", l);
2643 Py_DECREF(l);
2644 if (err != 0)
2645 goto err_return;
2646 }
Victor Stinner53dc7352011-03-20 01:50:21 +01002647 path = PyUnicode_FromString("<frozen>");
2648 if (path == NULL)
2649 goto err_return;
2650 m = PyImport_ExecCodeModuleObject(name, co, path, NULL);
2651 Py_DECREF(path);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002652 if (m == NULL)
2653 goto err_return;
2654 Py_DECREF(co);
2655 Py_DECREF(m);
2656 return 1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002657err_return:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002658 Py_DECREF(co);
2659 return -1;
Guido van Rossumf56e3db1993-04-01 20:59:32 +00002660}
Guido van Rossum74e6a111994-08-29 12:54:38 +00002661
Victor Stinner53dc7352011-03-20 01:50:21 +01002662int
2663PyImport_ImportFrozenModule(char *name)
2664{
2665 PyObject *nameobj;
2666 int ret;
2667 nameobj = PyUnicode_InternFromString(name);
2668 if (nameobj == NULL)
2669 return -1;
2670 ret = PyImport_ImportFrozenModuleObject(nameobj);
2671 Py_DECREF(nameobj);
2672 return ret;
2673}
2674
Guido van Rossum74e6a111994-08-29 12:54:38 +00002675
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002676/* Import a module, either built-in, frozen, or external, and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00002677 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum74e6a111994-08-29 12:54:38 +00002678
Guido van Rossum79f25d91997-04-29 20:08:16 +00002679PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00002680PyImport_ImportModule(const char *name)
Guido van Rossum74e6a111994-08-29 12:54:38 +00002681{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002682 PyObject *pname;
2683 PyObject *result;
Marc-André Lemburg3c61c352001-02-09 19:40:15 +00002684
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002685 pname = PyUnicode_FromString(name);
2686 if (pname == NULL)
2687 return NULL;
2688 result = PyImport_Import(pname);
2689 Py_DECREF(pname);
2690 return result;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002691}
2692
Christian Heimes072c0f12008-01-03 23:01:04 +00002693/* Import a module without blocking
2694 *
2695 * At first it tries to fetch the module from sys.modules. If the module was
2696 * never loaded before it loads it with PyImport_ImportModule() unless another
2697 * thread holds the import lock. In the latter case the function raises an
2698 * ImportError instead of blocking.
2699 *
2700 * Returns the module object with incremented ref count.
2701 */
2702PyObject *
2703PyImport_ImportModuleNoBlock(const char *name)
2704{
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002705 PyObject *nameobj, *modules, *result;
Victor Stinner0af03062011-09-02 00:11:43 +02002706#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002707 long me;
Victor Stinner0af03062011-09-02 00:11:43 +02002708#endif
Christian Heimes072c0f12008-01-03 23:01:04 +00002709
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002710 /* Try to get the module from sys.modules[name] */
2711 modules = PyImport_GetModuleDict();
2712 if (modules == NULL)
2713 return NULL;
Christian Heimes072c0f12008-01-03 23:01:04 +00002714
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002715 nameobj = PyUnicode_FromString(name);
2716 if (nameobj == NULL)
2717 return NULL;
2718 result = PyDict_GetItem(modules, nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002719 if (result != NULL) {
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002720 Py_DECREF(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002721 Py_INCREF(result);
2722 return result;
2723 }
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002724 PyErr_Clear();
Benjamin Peterson3e4f0552008-09-02 00:31:15 +00002725#ifdef WITH_THREAD
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002726 /* check the import lock
2727 * me might be -1 but I ignore the error here, the lock function
2728 * takes care of the problem */
2729 me = PyThread_get_thread_ident();
2730 if (import_lock_thread == -1 || import_lock_thread == me) {
2731 /* no thread or me is holding the lock */
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002732 result = PyImport_Import(nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002733 }
2734 else {
2735 PyErr_Format(PyExc_ImportError,
Victor Stinnerc24c8102011-03-13 22:38:06 -04002736 "Failed to import %R because the import lock"
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002737 "is held by another thread.",
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002738 nameobj);
2739 result = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002740 }
Benjamin Peterson3e4f0552008-09-02 00:31:15 +00002741#else
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002742 result = PyImport_Import(nameobj);
Benjamin Peterson3e4f0552008-09-02 00:31:15 +00002743#endif
Victor Stinner2e5f11a2011-03-13 21:57:27 -04002744 Py_DECREF(nameobj);
2745 return result;
Christian Heimes072c0f12008-01-03 23:01:04 +00002746}
2747
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002748/* Forward declarations for helper routines */
Victor Stinner974389d2011-03-15 09:33:57 +01002749static PyObject *get_parent(PyObject *globals,
2750 PyObject **p_name,
2751 int level);
Tim Petersdbd9ba62000-07-09 03:09:57 +00002752static PyObject *load_next(PyObject *mod, PyObject *altmod,
Victor Stinner974389d2011-03-15 09:33:57 +01002753 PyObject *inputname, PyObject **p_outputname,
Martin v. Löwisf45dee92011-10-30 23:50:02 +01002754 PyObject **p_prefix);
Victor Stinner974389d2011-03-15 09:33:57 +01002755static int mark_miss(PyObject *name);
Tim Petersdbd9ba62000-07-09 03:09:57 +00002756static int ensure_fromlist(PyObject *mod, PyObject *fromlist,
Victor Stinner974389d2011-03-15 09:33:57 +01002757 PyObject *buf, int recursive);
2758static PyObject * import_submodule(PyObject *mod, PyObject *name,
2759 PyObject *fullname);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002760
2761/* The Magnum Opus of dotted-name import :-) */
2762
Guido van Rossum75acc9c1998-03-03 22:26:50 +00002763static PyObject *
Victor Stinner974389d2011-03-15 09:33:57 +01002764import_module_level(PyObject *name, PyObject *globals, PyObject *locals,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002765 PyObject *fromlist, int level)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002766{
Martin v. Löwisf45dee92011-10-30 23:50:02 +01002767 PyObject *parent, *next, *inputname, *outputname;
2768 PyObject *head = NULL;
2769 PyObject *tail = NULL;
2770 PyObject *prefix = NULL;
2771 PyObject *result = NULL;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002772 Py_ssize_t sep, altsep;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002773
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002774 if (PyUnicode_READY(name))
2775 return NULL;
Victor Stinner974389d2011-03-15 09:33:57 +01002776
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002777 sep = PyUnicode_FindChar(name, SEP, 0, PyUnicode_GET_LENGTH(name), 1);
2778 if (sep == -2)
2779 return NULL;
Victor Stinner974389d2011-03-15 09:33:57 +01002780#ifdef ALTSEP
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002781 altsep = PyUnicode_FindChar(name, ALTSEP, 0, PyUnicode_GET_LENGTH(name), 1);
2782 if (altsep == -2)
2783 return NULL;
2784#else
2785 altsep = -1;
Christian Heimes454f37b2008-01-10 00:10:02 +00002786#endif
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002787 if (sep != -1 || altsep != -1)
2788 {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002789 PyErr_SetString(PyExc_ImportError,
2790 "Import by filename is not supported.");
2791 return NULL;
2792 }
Christian Heimes454f37b2008-01-10 00:10:02 +00002793
Martin v. Löwisf45dee92011-10-30 23:50:02 +01002794 parent = get_parent(globals, &prefix, level);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002795 if (parent == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002796 return NULL;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002797 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002798
Martin v. Löwisf45dee92011-10-30 23:50:02 +01002799 if (PyUnicode_READY(prefix))
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002800 return NULL;
Victor Stinner974389d2011-03-15 09:33:57 +01002801
2802 head = load_next(parent, level < 0 ? Py_None : parent, name, &outputname,
Martin v. Löwisf45dee92011-10-30 23:50:02 +01002803 &prefix);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002804 if (head == NULL)
Martin v. Löwisf45dee92011-10-30 23:50:02 +01002805 goto out;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002806
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002807 tail = head;
2808 Py_INCREF(tail);
Victor Stinner974389d2011-03-15 09:33:57 +01002809
2810 if (outputname != NULL) {
2811 while (1) {
2812 inputname = outputname;
2813 next = load_next(tail, tail, inputname, &outputname,
Martin v. Löwisf45dee92011-10-30 23:50:02 +01002814 &prefix);
2815 Py_CLEAR(tail);
2816 Py_CLEAR(inputname);
2817 if (next == NULL)
2818 goto out;
Victor Stinner974389d2011-03-15 09:33:57 +01002819 tail = next;
2820
2821 if (outputname == NULL) {
2822 break;
2823 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002824 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002825 }
2826 if (tail == Py_None) {
2827 /* If tail is Py_None, both get_parent and load_next found
2828 an empty module name: someone called __import__("") or
2829 doctored faulty bytecode */
Victor Stinner974389d2011-03-15 09:33:57 +01002830 PyErr_SetString(PyExc_ValueError, "Empty module name");
Martin v. Löwisf45dee92011-10-30 23:50:02 +01002831 goto out;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002832 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002833
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002834 if (fromlist != NULL) {
2835 if (fromlist == Py_None || !PyObject_IsTrue(fromlist))
2836 fromlist = NULL;
2837 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002838
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002839 if (fromlist == NULL) {
Martin v. Löwisf45dee92011-10-30 23:50:02 +01002840 result = head;
2841 Py_INCREF(result);
2842 goto out;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002843 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002844
Martin v. Löwisf45dee92011-10-30 23:50:02 +01002845 if (!ensure_fromlist(tail, fromlist, prefix, 0))
2846 goto out;
2847
2848 result = tail;
2849 Py_INCREF(result);
2850 out:
2851 Py_XDECREF(head);
2852 Py_XDECREF(tail);
2853 Py_XDECREF(prefix);
2854 return result;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002855}
2856
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002857PyObject *
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002858PyImport_ImportModuleLevelObject(PyObject *name, PyObject *globals,
2859 PyObject *locals, PyObject *fromlist,
2860 int level)
Thomas Woutersf7f438b2006-02-28 16:09:29 +00002861{
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002862 PyObject *mod;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002863 _PyImport_AcquireLock();
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002864 mod = import_module_level(name, globals, locals, fromlist, level);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002865 if (_PyImport_ReleaseLock() < 0) {
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002866 Py_XDECREF(mod);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002867 PyErr_SetString(PyExc_RuntimeError,
2868 "not holding the import lock");
2869 return NULL;
2870 }
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002871 return mod;
Guido van Rossum75acc9c1998-03-03 22:26:50 +00002872}
2873
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002874PyObject *
Benjamin Peterson04778a82011-05-25 09:29:00 -05002875PyImport_ImportModuleLevel(const char *name, PyObject *globals, PyObject *locals,
Victor Stinnerfe93faf2011-03-14 15:54:52 -04002876 PyObject *fromlist, int level)
2877{
2878 PyObject *nameobj, *mod;
2879 nameobj = PyUnicode_FromString(name);
2880 if (nameobj == NULL)
2881 return NULL;
2882 mod = PyImport_ImportModuleLevelObject(nameobj, globals, locals,
2883 fromlist, level);
2884 Py_DECREF(nameobj);
2885 return mod;
2886}
2887
2888
Fred Drake87590902004-05-28 20:21:36 +00002889/* Return the package that an import is being performed in. If globals comes
2890 from the module foo.bar.bat (not itself a package), this returns the
2891 sys.modules entry for foo.bar. If globals is from a package's __init__.py,
Thomas Wouters4d70c3d2006-06-08 14:42:34 +00002892 the package's entry in sys.modules is returned, as a borrowed reference.
Fred Drake87590902004-05-28 20:21:36 +00002893
Victor Stinner974389d2011-03-15 09:33:57 +01002894 The name of the returned package is returned in *p_name.
Fred Drake87590902004-05-28 20:21:36 +00002895
2896 If globals doesn't come from a package or a module in a package, or a
2897 corresponding entry is not found in sys.modules, Py_None is returned.
2898*/
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002899static PyObject *
Victor Stinner9599de52011-03-13 22:38:38 -04002900get_parent(PyObject *globals, PyObject **p_name, int level)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002901{
Victor Stinner974389d2011-03-15 09:33:57 +01002902 PyObject *nameobj;
2903
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002904 static PyObject *namestr = NULL;
2905 static PyObject *pathstr = NULL;
2906 static PyObject *pkgstr = NULL;
2907 PyObject *pkgname, *modname, *modpath, *modules, *parent;
2908 int orig_level = level;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002909
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002910 if (globals == NULL || !PyDict_Check(globals) || !level)
Victor Stinner974389d2011-03-15 09:33:57 +01002911 goto return_none;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002912
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002913 if (namestr == NULL) {
2914 namestr = PyUnicode_InternFromString("__name__");
2915 if (namestr == NULL)
2916 return NULL;
2917 }
2918 if (pathstr == NULL) {
2919 pathstr = PyUnicode_InternFromString("__path__");
2920 if (pathstr == NULL)
2921 return NULL;
2922 }
2923 if (pkgstr == NULL) {
2924 pkgstr = PyUnicode_InternFromString("__package__");
2925 if (pkgstr == NULL)
2926 return NULL;
2927 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002928
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002929 pkgname = PyDict_GetItem(globals, pkgstr);
Guido van Rossum17fc85f1997-09-06 18:52:03 +00002930
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002931 if ((pkgname != NULL) && (pkgname != Py_None)) {
2932 /* __package__ is set, so use it */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002933 if (!PyUnicode_Check(pkgname)) {
2934 PyErr_SetString(PyExc_ValueError,
2935 "__package__ set to non-string");
2936 return NULL;
2937 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002938 if (PyUnicode_GET_LENGTH(pkgname) == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002939 if (level > 0) {
2940 PyErr_SetString(PyExc_ValueError,
2941 "Attempted relative import in non-package");
2942 return NULL;
2943 }
Victor Stinner974389d2011-03-15 09:33:57 +01002944 goto return_none;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002945 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002946 Py_INCREF(pkgname);
2947 nameobj = pkgname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002948 } else {
2949 /* __package__ not set, so figure it out and set it */
2950 modname = PyDict_GetItem(globals, namestr);
2951 if (modname == NULL || !PyUnicode_Check(modname))
Victor Stinner974389d2011-03-15 09:33:57 +01002952 goto return_none;
Brett Cannon9a5b25a2010-03-01 02:09:17 +00002953
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002954 modpath = PyDict_GetItem(globals, pathstr);
2955 if (modpath != NULL) {
2956 /* __path__ is set, so modname is already the package name */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002957 int error;
Alexandre Vassalottia85998a2008-05-03 18:24:43 +00002958
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002959 error = PyDict_SetItem(globals, pkgstr, modname);
2960 if (error) {
2961 PyErr_SetString(PyExc_ValueError,
2962 "Could not set __package__");
2963 return NULL;
2964 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002965 Py_INCREF(modname);
2966 nameobj = modname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002967 } else {
2968 /* Normal module, so work out the package name if any */
Victor Stinner974389d2011-03-15 09:33:57 +01002969 Py_ssize_t len;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002970 len = PyUnicode_FindChar(modname, '.',
2971 0, PyUnicode_GET_LENGTH(modname), -1);
2972 if (len == -2)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002973 return NULL;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002974 if (len < 0) {
2975 if (level > 0) {
2976 PyErr_SetString(PyExc_ValueError,
2977 "Attempted relative import in non-package");
2978 return NULL;
2979 }
2980 if (PyDict_SetItem(globals, pkgstr, Py_None)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002981 PyErr_SetString(PyExc_ValueError,
2982 "Could not set __package__");
2983 return NULL;
2984 }
Victor Stinner974389d2011-03-15 09:33:57 +01002985 goto return_none;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002986 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002987 pkgname = PyUnicode_Substring(modname, 0, len);
2988 if (pkgname == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002989 return NULL;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002990 if (PyDict_SetItem(globals, pkgstr, pkgname)) {
2991 Py_DECREF(pkgname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002992 PyErr_SetString(PyExc_ValueError,
2993 "Could not set __package__");
2994 return NULL;
2995 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002996 nameobj = pkgname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002997 }
2998 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002999 if (level > 1) {
3000 Py_ssize_t dot, end = PyUnicode_GET_LENGTH(nameobj);
3001 PyObject *newname;
3002 while (--level > 0) {
3003 dot = PyUnicode_FindChar(nameobj, '.', 0, end, -1);
3004 if (dot == -2) {
3005 Py_DECREF(nameobj);
3006 return NULL;
3007 }
3008 if (dot < 0) {
3009 Py_DECREF(nameobj);
3010 PyErr_SetString(PyExc_ValueError,
3011 "Attempted relative import beyond "
3012 "toplevel package");
3013 return NULL;
3014 }
3015 end = dot;
3016 }
3017 newname = PyUnicode_Substring(nameobj, 0, end);
3018 Py_DECREF(nameobj);
3019 if (newname == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003020 return NULL;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003021 nameobj = newname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003022 }
Victor Stinner974389d2011-03-15 09:33:57 +01003023
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003024 modules = PyImport_GetModuleDict();
Victor Stinner974389d2011-03-15 09:33:57 +01003025 parent = PyDict_GetItem(modules, nameobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003026 if (parent == NULL) {
Victor Stinner974389d2011-03-15 09:33:57 +01003027 int err;
3028
3029 if (orig_level >= 1) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003030 PyErr_Format(PyExc_SystemError,
Victor Stinner974389d2011-03-15 09:33:57 +01003031 "Parent module %R not loaded, "
3032 "cannot perform relative import", nameobj);
3033 Py_DECREF(nameobj);
3034 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003035 }
Victor Stinner974389d2011-03-15 09:33:57 +01003036
3037 err = PyErr_WarnFormat(
3038 PyExc_RuntimeWarning, 1,
3039 "Parent module %R not found while handling absolute import",
3040 nameobj);
3041 Py_DECREF(nameobj);
3042 if (err)
3043 return NULL;
3044
3045 goto return_none;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003046 }
Victor Stinner974389d2011-03-15 09:33:57 +01003047 *p_name = nameobj;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003048 return parent;
3049 /* We expect, but can't guarantee, if parent != None, that:
Victor Stinner974389d2011-03-15 09:33:57 +01003050 - parent.__name__ == name
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003051 - parent.__dict__ is globals
3052 If this is violated... Who cares? */
Victor Stinner974389d2011-03-15 09:33:57 +01003053
3054return_none:
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003055 nameobj = PyUnicode_New(0, 0);
Victor Stinner974389d2011-03-15 09:33:57 +01003056 if (nameobj == NULL)
3057 return NULL;
3058 *p_name = nameobj;
3059 return Py_None;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003060}
3061
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003062/* altmod is either None or same as mod */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003063static PyObject *
Victor Stinner974389d2011-03-15 09:33:57 +01003064load_next(PyObject *mod, PyObject *altmod,
3065 PyObject *inputname, PyObject **p_outputname,
Martin v. Löwisf45dee92011-10-30 23:50:02 +01003066 PyObject **p_prefix)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003067{
Martin v. Löwisf45dee92011-10-30 23:50:02 +01003068 Py_ssize_t dot;
Victor Stinner974389d2011-03-15 09:33:57 +01003069 Py_ssize_t len;
Martin v. Löwisf45dee92011-10-30 23:50:02 +01003070 PyObject *fullname, *name = NULL, *result;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003071
Victor Stinner974389d2011-03-15 09:33:57 +01003072 *p_outputname = NULL;
3073
Martin v. Löwisf45dee92011-10-30 23:50:02 +01003074 len = PyUnicode_GET_LENGTH(inputname);
3075 if (len == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003076 /* completely empty module name should only happen in
3077 'from . import' (or '__import__("")')*/
3078 Py_INCREF(mod);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003079 return mod;
3080 }
Thomas Woutersf7f438b2006-02-28 16:09:29 +00003081
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003082
Martin v. Löwisf45dee92011-10-30 23:50:02 +01003083 dot = PyUnicode_FindChar(inputname, '.', 0, len, 1);
3084 if (dot >= 0) {
3085 len = dot;
Victor Stinner974389d2011-03-15 09:33:57 +01003086 if (len == 0) {
3087 PyErr_SetString(PyExc_ValueError,
3088 "Empty module name");
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003089 goto error;
Victor Stinner974389d2011-03-15 09:33:57 +01003090 }
3091 }
Victor Stinner974389d2011-03-15 09:33:57 +01003092
Martin v. Löwisf45dee92011-10-30 23:50:02 +01003093 /* name = inputname[:len] */
3094 name = PyUnicode_Substring(inputname, 0, len);
3095 if (name == NULL)
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003096 goto error;
Martin v. Löwisf45dee92011-10-30 23:50:02 +01003097
3098 if (PyUnicode_GET_LENGTH(*p_prefix)) {
3099 /* fullname = prefix + "." + name */
3100 fullname = PyUnicode_FromFormat("%U.%U", *p_prefix, name);
3101 if (fullname == NULL)
3102 goto error;
3103 }
3104 else {
3105 fullname = name;
3106 Py_INCREF(fullname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003107 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003108
Victor Stinner974389d2011-03-15 09:33:57 +01003109 result = import_submodule(mod, name, fullname);
Martin v. Löwisf45dee92011-10-30 23:50:02 +01003110 Py_DECREF(*p_prefix);
3111 /* Transfer reference. */
3112 *p_prefix = fullname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003113 if (result == Py_None && altmod != mod) {
3114 Py_DECREF(result);
3115 /* Here, altmod must be None and mod must not be None */
Victor Stinner974389d2011-03-15 09:33:57 +01003116 result = import_submodule(altmod, name, name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003117 if (result != NULL && result != Py_None) {
Martin v. Löwisf45dee92011-10-30 23:50:02 +01003118 if (mark_miss(*p_prefix) != 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003119 Py_DECREF(result);
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003120 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003121 }
Martin v. Löwisf45dee92011-10-30 23:50:02 +01003122 Py_DECREF(*p_prefix);
3123 *p_prefix = name;
3124 Py_INCREF(*p_prefix);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003125 }
3126 }
3127 if (result == NULL)
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003128 goto error;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003129
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003130 if (result == Py_None) {
3131 Py_DECREF(result);
3132 PyErr_Format(PyExc_ImportError,
Victor Stinner974389d2011-03-15 09:33:57 +01003133 "No module named %R", inputname);
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003134 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003135 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003136
Martin v. Löwisf45dee92011-10-30 23:50:02 +01003137 if (dot >= 0) {
3138 *p_outputname = PyUnicode_Substring(inputname, dot+1,
3139 PyUnicode_GET_LENGTH(inputname));
Victor Stinner974389d2011-03-15 09:33:57 +01003140 if (*p_outputname == NULL) {
3141 Py_DECREF(result);
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003142 goto error;
Victor Stinner974389d2011-03-15 09:33:57 +01003143 }
3144 }
3145
Martin v. Löwisf45dee92011-10-30 23:50:02 +01003146 Py_DECREF(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003147 return result;
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003148
3149error:
Martin v. Löwisf45dee92011-10-30 23:50:02 +01003150 Py_XDECREF(name);
Martin v. Löwis0b1d3482011-10-01 16:35:40 +02003151 return NULL;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003152}
3153
3154static int
Victor Stinner974389d2011-03-15 09:33:57 +01003155mark_miss(PyObject *name)
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00003156{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003157 PyObject *modules = PyImport_GetModuleDict();
Victor Stinner974389d2011-03-15 09:33:57 +01003158 return PyDict_SetItem(modules, name, Py_None);
Guido van Rossumf5f5fdb1997-09-06 20:29:52 +00003159}
3160
3161static int
Victor Stinner974389d2011-03-15 09:33:57 +01003162ensure_fromlist(PyObject *mod, PyObject *fromlist, PyObject *name,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003163 int recursive)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003164{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003165 int i;
Victor Stinner974389d2011-03-15 09:33:57 +01003166 PyObject *fullname;
3167 Py_ssize_t fromlist_len;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003168
Martin v. Löwis1ee1b6f2011-10-10 18:11:30 +02003169 if (!_PyObject_HasAttrId(mod, &PyId___path__))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003170 return 1;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003171
Victor Stinner974389d2011-03-15 09:33:57 +01003172 fromlist_len = PySequence_Size(fromlist);
3173
3174 for (i = 0; i < fromlist_len; i++) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003175 PyObject *item = PySequence_GetItem(fromlist, i);
3176 int hasit;
Victor Stinner974389d2011-03-15 09:33:57 +01003177 if (item == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003178 return 0;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003179 if (!PyUnicode_Check(item)) {
3180 PyErr_SetString(PyExc_TypeError,
3181 "Item in ``from list'' not a string");
3182 Py_DECREF(item);
3183 return 0;
3184 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003185 if (PyUnicode_READ_CHAR(item, 0) == '*') {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003186 PyObject *all;
Martin v. Löwisbd928fe2011-10-14 10:20:37 +02003187 _Py_IDENTIFIER(__all__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003188 Py_DECREF(item);
3189 /* See if the package defines __all__ */
3190 if (recursive)
3191 continue; /* Avoid endless recursion */
Martin v. Löwis1ee1b6f2011-10-10 18:11:30 +02003192 all = _PyObject_GetAttrId(mod, &PyId___all__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003193 if (all == NULL)
3194 PyErr_Clear();
3195 else {
Victor Stinner974389d2011-03-15 09:33:57 +01003196 int ret = ensure_fromlist(mod, all, name, 1);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003197 Py_DECREF(all);
3198 if (!ret)
3199 return 0;
3200 }
3201 continue;
3202 }
3203 hasit = PyObject_HasAttr(mod, item);
3204 if (!hasit) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003205 PyObject *submod;
Victor Stinner974389d2011-03-15 09:33:57 +01003206 fullname = PyUnicode_FromFormat("%U.%U", name, item);
3207 if (fullname != NULL) {
3208 submod = import_submodule(mod, item, fullname);
3209 Py_DECREF(fullname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003210 }
Victor Stinner974389d2011-03-15 09:33:57 +01003211 else
3212 submod = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003213 Py_XDECREF(submod);
3214 if (submod == NULL) {
3215 Py_DECREF(item);
3216 return 0;
3217 }
3218 }
3219 Py_DECREF(item);
3220 }
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003221
Victor Stinner974389d2011-03-15 09:33:57 +01003222 return 1;
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003223}
3224
Neil Schemenauer00b09662003-06-16 21:03:07 +00003225static int
Victor Stinner974389d2011-03-15 09:33:57 +01003226add_submodule(PyObject *mod, PyObject *submod, PyObject *fullname,
3227 PyObject *subname, PyObject *modules)
Neil Schemenauer00b09662003-06-16 21:03:07 +00003228{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003229 if (mod == Py_None)
3230 return 1;
3231 /* Irrespective of the success of this load, make a
3232 reference to it in the parent package module. A copy gets
3233 saved in the modules dictionary under the full name, so get a
3234 reference from there, if need be. (The exception is when the
3235 load failed with a SyntaxError -- then there's no trace in
3236 sys.modules. In that case, of course, do nothing extra.) */
3237 if (submod == NULL) {
Victor Stinner974389d2011-03-15 09:33:57 +01003238 submod = PyDict_GetItem(modules, fullname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003239 if (submod == NULL)
3240 return 1;
3241 }
3242 if (PyModule_Check(mod)) {
3243 /* We can't use setattr here since it can give a
3244 * spurious warning if the submodule name shadows a
3245 * builtin name */
3246 PyObject *dict = PyModule_GetDict(mod);
3247 if (!dict)
3248 return 0;
Victor Stinner974389d2011-03-15 09:33:57 +01003249 if (PyDict_SetItem(dict, subname, submod) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003250 return 0;
3251 }
3252 else {
Victor Stinner974389d2011-03-15 09:33:57 +01003253 if (PyObject_SetAttr(mod, subname, submod) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003254 return 0;
3255 }
3256 return 1;
Neil Schemenauer00b09662003-06-16 21:03:07 +00003257}
3258
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003259static PyObject *
Victor Stinner974389d2011-03-15 09:33:57 +01003260import_submodule(PyObject *mod, PyObject *subname, PyObject *fullname)
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003261{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003262 PyObject *modules = PyImport_GetModuleDict();
Victor Stinner533d7832011-03-14 13:22:54 -04003263 PyObject *m = NULL, *bufobj, *path_list, *loader;
Victor Stinner9599de52011-03-13 22:38:38 -04003264 struct filedescr *fdp;
3265 FILE *fp;
Guido van Rossum74e6a111994-08-29 12:54:38 +00003266
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003267 /* Require:
3268 if mod == None: subname == fullname
3269 else: mod.__name__ + "." + subname == fullname
3270 */
Guido van Rossum17fc85f1997-09-06 18:52:03 +00003271
Victor Stinner974389d2011-03-15 09:33:57 +01003272 if ((m = PyDict_GetItem(modules, fullname)) != NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003273 Py_INCREF(m);
Victor Stinner9599de52011-03-13 22:38:38 -04003274 return m;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003275 }
Victor Stinner9599de52011-03-13 22:38:38 -04003276
3277 if (mod == Py_None)
Victor Stinner533d7832011-03-14 13:22:54 -04003278 path_list = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003279 else {
Martin v. Löwis1ee1b6f2011-10-10 18:11:30 +02003280 path_list = _PyObject_GetAttrId(mod, &PyId___path__);
Victor Stinner533d7832011-03-14 13:22:54 -04003281 if (path_list == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003282 PyErr_Clear();
3283 Py_INCREF(Py_None);
3284 return Py_None;
3285 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003286 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003287
Victor Stinner533d7832011-03-14 13:22:54 -04003288 fdp = find_module(fullname, subname, path_list,
Victor Stinner2fd76e42011-03-14 15:19:39 -04003289 &bufobj, &fp, &loader);
Victor Stinner533d7832011-03-14 13:22:54 -04003290 Py_XDECREF(path_list);
Victor Stinner9599de52011-03-13 22:38:38 -04003291 if (fdp == NULL) {
3292 if (!PyErr_ExceptionMatches(PyExc_ImportError))
3293 return NULL;
3294 PyErr_Clear();
3295 Py_INCREF(Py_None);
3296 return Py_None;
3297 }
Victor Stinner2fd76e42011-03-14 15:19:39 -04003298 m = load_module(fullname, fp, bufobj, fdp->type, loader);
3299 Py_XDECREF(bufobj);
Victor Stinner9599de52011-03-13 22:38:38 -04003300 Py_XDECREF(loader);
3301 if (fp)
3302 fclose(fp);
3303 if (m == NULL)
3304 return NULL;
3305 if (!add_submodule(mod, m, fullname, subname, modules)) {
3306 Py_XDECREF(m);
3307 return NULL;
3308 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003309 return m;
Guido van Rossum74e6a111994-08-29 12:54:38 +00003310}
3311
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003312
3313/* Re-import a module of any kind and return its module object, WITH
3314 INCREMENTED REFERENCE COUNT */
3315
Guido van Rossum79f25d91997-04-29 20:08:16 +00003316PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003317PyImport_ReloadModule(PyObject *m)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003318{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003319 PyInterpreterState *interp = PyThreadState_Get()->interp;
3320 PyObject *modules_reloading = interp->modules_reloading;
3321 PyObject *modules = PyImport_GetModuleDict();
Victor Stinner533d7832011-03-14 13:22:54 -04003322 PyObject *path_list = NULL, *loader = NULL, *existing_m = NULL;
Martin v. Löwis796ea532011-10-30 09:07:07 +01003323 PyObject *name, *bufobj, *subname;
3324 Py_ssize_t subname_start;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003325 struct filedescr *fdp;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003326 FILE *fp = NULL;
3327 PyObject *newm = NULL;
Brett Cannon9a5b25a2010-03-01 02:09:17 +00003328
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003329 if (modules_reloading == NULL) {
3330 Py_FatalError("PyImport_ReloadModule: "
3331 "no modules_reloading dictionary!");
3332 return NULL;
3333 }
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003334
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003335 if (m == NULL || !PyModule_Check(m)) {
3336 PyErr_SetString(PyExc_TypeError,
3337 "reload() argument must be module");
3338 return NULL;
3339 }
Martin v. Löwis796ea532011-10-30 09:07:07 +01003340 name = PyModule_GetNameObject(m);
3341 if (name == NULL || PyUnicode_READY(name) == -1)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003342 return NULL;
Martin v. Löwis796ea532011-10-30 09:07:07 +01003343 if (m != PyDict_GetItem(modules, name)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003344 PyErr_Format(PyExc_ImportError,
Victor Stinner98dbba52011-03-14 15:15:47 -04003345 "reload(): module %R not in sys.modules",
Martin v. Löwis796ea532011-10-30 09:07:07 +01003346 name);
3347 Py_DECREF(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003348 return NULL;
3349 }
Martin v. Löwis796ea532011-10-30 09:07:07 +01003350 existing_m = PyDict_GetItem(modules_reloading, name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003351 if (existing_m != NULL) {
3352 /* Due to a recursive reload, this module is already
3353 being reloaded. */
Martin v. Löwis796ea532011-10-30 09:07:07 +01003354 Py_DECREF(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003355 Py_INCREF(existing_m);
3356 return existing_m;
3357 }
Martin v. Löwis796ea532011-10-30 09:07:07 +01003358 if (PyDict_SetItem(modules_reloading, name, m) < 0) {
3359 Py_DECREF(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003360 return NULL;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003361 }
Guido van Rossumd8faa362007-04-27 19:54:29 +00003362
Martin v. Löwis796ea532011-10-30 09:07:07 +01003363 subname_start = PyUnicode_FindChar(name, '.', 0,
3364 PyUnicode_GET_LENGTH(name), -1);
3365 if (subname_start == -1) {
3366 Py_INCREF(name);
3367 subname = name;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003368 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003369 else {
3370 PyObject *parentname, *parent;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003371 Py_ssize_t len;
Martin v. Löwis796ea532011-10-30 09:07:07 +01003372 parentname = PyUnicode_Substring(name, 0, subname_start);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003373 if (parentname == NULL) {
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003374 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003375 }
3376 parent = PyDict_GetItem(modules, parentname);
3377 if (parent == NULL) {
3378 PyErr_Format(PyExc_ImportError,
Victor Stinner98dbba52011-03-14 15:15:47 -04003379 "reload(): parent %R not in sys.modules",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003380 parentname);
3381 Py_DECREF(parentname);
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003382 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003383 }
3384 Py_DECREF(parentname);
Martin v. Löwis1ee1b6f2011-10-10 18:11:30 +02003385 path_list = _PyObject_GetAttrId(parent, &PyId___path__);
Victor Stinner533d7832011-03-14 13:22:54 -04003386 if (path_list == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003387 PyErr_Clear();
Martin v. Löwis796ea532011-10-30 09:07:07 +01003388 subname_start++;
3389 len = PyUnicode_GET_LENGTH(name) - (subname_start + 1);
3390 subname = PyUnicode_Substring(name, subname_start, len);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003391 }
Martin v. Löwis796ea532011-10-30 09:07:07 +01003392 if (subname == NULL)
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003393 goto error;
Martin v. Löwis796ea532011-10-30 09:07:07 +01003394 fdp = find_module(name, subname, path_list,
Victor Stinner2fd76e42011-03-14 15:19:39 -04003395 &bufobj, &fp, &loader);
Martin v. Löwis796ea532011-10-30 09:07:07 +01003396 Py_DECREF(subname);
Victor Stinner533d7832011-03-14 13:22:54 -04003397 Py_XDECREF(path_list);
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00003398
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003399 if (fdp == NULL) {
3400 Py_XDECREF(loader);
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003401 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003402 }
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00003403
Martin v. Löwis796ea532011-10-30 09:07:07 +01003404 newm = load_module(name, fp, bufobj, fdp->type, loader);
Victor Stinner2fd76e42011-03-14 15:19:39 -04003405 Py_XDECREF(bufobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003406 Py_XDECREF(loader);
Phillip J. Eby7ec642a2004-09-23 04:37:36 +00003407
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003408 if (fp)
3409 fclose(fp);
3410 if (newm == NULL) {
3411 /* load_module probably removed name from modules because of
3412 * the error. Put back the original module object. We're
3413 * going to return NULL in this case regardless of whether
3414 * replacing name succeeds, so the return value is ignored.
3415 */
Martin v. Löwis796ea532011-10-30 09:07:07 +01003416 PyDict_SetItem(modules, name, m);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003417 }
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003418
3419error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003420 imp_modules_reloading_clear();
Martin v. Löwis796ea532011-10-30 09:07:07 +01003421 Py_DECREF(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003422 return newm;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003423}
3424
3425
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003426/* Higher-level import emulator which emulates the "import" statement
3427 more accurately -- it invokes the __import__() function from the
3428 builtins of the current globals. This means that the import is
3429 done using whatever import hooks are installed in the current
Brett Cannonbc2eff32010-09-19 21:39:02 +00003430 environment.
Guido van Rossum6058eb41998-12-21 19:51:00 +00003431 A dummy list ["__doc__"] is passed as the 4th argument so that
Neal Norwitz80e7f272007-08-26 06:45:23 +00003432 e.g. PyImport_Import(PyUnicode_FromString("win32com.client.gencache"))
Guido van Rossum6058eb41998-12-21 19:51:00 +00003433 will return <module "gencache"> instead of <module "win32com">. */
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003434
3435PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003436PyImport_Import(PyObject *module_name)
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003437{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003438 static PyObject *silly_list = NULL;
3439 static PyObject *builtins_str = NULL;
3440 static PyObject *import_str = NULL;
3441 PyObject *globals = NULL;
3442 PyObject *import = NULL;
3443 PyObject *builtins = NULL;
Brett Cannonbc2eff32010-09-19 21:39:02 +00003444 PyObject *modules = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003445 PyObject *r = NULL;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003446
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003447 /* Initialize constant string objects */
3448 if (silly_list == NULL) {
3449 import_str = PyUnicode_InternFromString("__import__");
3450 if (import_str == NULL)
3451 return NULL;
3452 builtins_str = PyUnicode_InternFromString("__builtins__");
3453 if (builtins_str == NULL)
3454 return NULL;
Brett Cannonbc2eff32010-09-19 21:39:02 +00003455 silly_list = PyList_New(0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003456 if (silly_list == NULL)
3457 return NULL;
3458 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003459
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003460 /* Get the builtins from current globals */
3461 globals = PyEval_GetGlobals();
3462 if (globals != NULL) {
3463 Py_INCREF(globals);
3464 builtins = PyObject_GetItem(globals, builtins_str);
3465 if (builtins == NULL)
3466 goto err;
3467 }
3468 else {
3469 /* No globals -- use standard builtins, and fake globals */
3470 builtins = PyImport_ImportModuleLevel("builtins",
3471 NULL, NULL, NULL, 0);
3472 if (builtins == NULL)
3473 return NULL;
3474 globals = Py_BuildValue("{OO}", builtins_str, builtins);
3475 if (globals == NULL)
3476 goto err;
3477 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003478
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003479 /* Get the __import__ function from the builtins */
3480 if (PyDict_Check(builtins)) {
3481 import = PyObject_GetItem(builtins, import_str);
3482 if (import == NULL)
3483 PyErr_SetObject(PyExc_KeyError, import_str);
3484 }
3485 else
3486 import = PyObject_GetAttr(builtins, import_str);
3487 if (import == NULL)
3488 goto err;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003489
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003490 /* Call the __import__ function with the proper argument list
Brett Cannonbc2eff32010-09-19 21:39:02 +00003491 Always use absolute import here.
3492 Calling for side-effect of import. */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003493 r = PyObject_CallFunction(import, "OOOOi", module_name, globals,
3494 globals, silly_list, 0, NULL);
Brett Cannonbc2eff32010-09-19 21:39:02 +00003495 if (r == NULL)
3496 goto err;
3497 Py_DECREF(r);
3498
3499 modules = PyImport_GetModuleDict();
3500 r = PyDict_GetItem(modules, module_name);
3501 if (r != NULL)
3502 Py_INCREF(r);
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003503
3504 err:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003505 Py_XDECREF(globals);
3506 Py_XDECREF(builtins);
3507 Py_XDECREF(import);
Tim Peters50d8d372001-02-28 05:34:27 +00003508
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003509 return r;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00003510}
3511
3512
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003513/* Module 'imp' provides Python access to the primitives used for
3514 importing modules.
3515*/
3516
Guido van Rossum79f25d91997-04-29 20:08:16 +00003517static PyObject *
Barry Warsaw28a691b2010-04-17 00:19:56 +00003518imp_make_magic(long magic)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003519{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003520 char buf[4];
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003521
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003522 buf[0] = (char) ((magic >> 0) & 0xff);
3523 buf[1] = (char) ((magic >> 8) & 0xff);
3524 buf[2] = (char) ((magic >> 16) & 0xff);
3525 buf[3] = (char) ((magic >> 24) & 0xff);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003526
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003527 return PyBytes_FromStringAndSize(buf, 4);
Victor Stinner3e2b7172010-11-09 09:32:19 +00003528}
Barry Warsaw28a691b2010-04-17 00:19:56 +00003529
3530static PyObject *
3531imp_get_magic(PyObject *self, PyObject *noargs)
3532{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003533 return imp_make_magic(pyc_magic);
Barry Warsaw28a691b2010-04-17 00:19:56 +00003534}
3535
3536static PyObject *
3537imp_get_tag(PyObject *self, PyObject *noargs)
3538{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003539 return PyUnicode_FromString(pyc_tag);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003540}
3541
Guido van Rossum79f25d91997-04-29 20:08:16 +00003542static PyObject *
Neal Norwitz08ea61a2003-02-17 18:18:00 +00003543imp_get_suffixes(PyObject *self, PyObject *noargs)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003544{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003545 PyObject *list;
3546 struct filedescr *fdp;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003547
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003548 list = PyList_New(0);
3549 if (list == NULL)
3550 return NULL;
3551 for (fdp = _PyImport_Filetab; fdp->suffix != NULL; fdp++) {
3552 PyObject *item = Py_BuildValue("ssi",
3553 fdp->suffix, fdp->mode, fdp->type);
3554 if (item == NULL) {
3555 Py_DECREF(list);
3556 return NULL;
3557 }
3558 if (PyList_Append(list, item) < 0) {
3559 Py_DECREF(list);
3560 Py_DECREF(item);
3561 return NULL;
3562 }
3563 Py_DECREF(item);
3564 }
3565 return list;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003566}
3567
Guido van Rossum79f25d91997-04-29 20:08:16 +00003568static PyObject *
Victor Stinner533d7832011-03-14 13:22:54 -04003569call_find_module(PyObject *name, PyObject *path_list)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003570{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003571 extern int fclose(FILE *);
3572 PyObject *fob, *ret;
3573 PyObject *pathobj;
3574 struct filedescr *fdp;
Victor Stinner7d8b77c2011-03-12 08:45:02 -05003575 FILE *fp;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003576 int fd = -1;
3577 char *found_encoding = NULL;
3578 char *encoding = NULL;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003579
Victor Stinner533d7832011-03-14 13:22:54 -04003580 if (path_list == Py_None)
3581 path_list = NULL;
3582 fdp = find_module(NULL, name, path_list,
Victor Stinner2fd76e42011-03-14 15:19:39 -04003583 &pathobj, &fp, NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003584 if (fdp == NULL)
3585 return NULL;
3586 if (fp != NULL) {
3587 fd = fileno(fp);
3588 if (fd != -1)
3589 fd = dup(fd);
3590 fclose(fp);
Victor Stinnerd417d012011-06-20 15:16:55 +02003591 if (fd == -1) {
3592 PyErr_SetFromErrno(PyExc_OSError);
3593 return NULL;
3594 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003595 fp = NULL;
3596 }
3597 if (fd != -1) {
3598 if (strchr(fdp->mode, 'b') == NULL) {
Victor Stinnerfe7c5b52011-04-05 01:48:03 +02003599 /* PyTokenizer_FindEncodingFilename() returns PyMem_MALLOC'ed
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003600 memory. */
Victor Stinnerfe7c5b52011-04-05 01:48:03 +02003601 found_encoding = PyTokenizer_FindEncodingFilename(fd, pathobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003602 lseek(fd, 0, 0); /* Reset position */
Victor Stinner2fd76e42011-03-14 15:19:39 -04003603 if (found_encoding == NULL && PyErr_Occurred()) {
3604 Py_XDECREF(pathobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003605 return NULL;
Victor Stinner2fd76e42011-03-14 15:19:39 -04003606 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003607 encoding = (found_encoding != NULL) ? found_encoding :
3608 (char*)PyUnicode_GetDefaultEncoding();
3609 }
Victor Stinner2fd76e42011-03-14 15:19:39 -04003610 fob = PyFile_FromFd(fd, NULL, fdp->mode, -1,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003611 (char*)encoding, NULL, NULL, 1);
3612 if (fob == NULL) {
Victor Stinner2fd76e42011-03-14 15:19:39 -04003613 Py_XDECREF(pathobj);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003614 close(fd);
3615 PyMem_FREE(found_encoding);
3616 return NULL;
3617 }
3618 }
3619 else {
3620 fob = Py_None;
3621 Py_INCREF(fob);
3622 }
Victor Stinner2fd76e42011-03-14 15:19:39 -04003623 if (pathobj == NULL) {
3624 Py_INCREF(Py_None);
3625 pathobj = Py_None;
3626 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003627 ret = Py_BuildValue("NN(ssi)",
3628 fob, pathobj, fdp->suffix, fdp->mode, fdp->type);
3629 PyMem_FREE(found_encoding);
Brett Cannon3bb42d92007-10-20 03:43:15 +00003630
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003631 return ret;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003632}
3633
Guido van Rossum79f25d91997-04-29 20:08:16 +00003634static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003635imp_find_module(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003636{
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003637 PyObject *name, *path_list = NULL;
3638 if (!PyArg_ParseTuple(args, "U|O:find_module",
3639 &name, &path_list))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003640 return NULL;
Victor Stinnerad3c03b2011-03-14 09:21:33 -04003641 return call_find_module(name, path_list);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003642}
3643
3644static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003645imp_init_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003646{
Victor Stinner95872862011-03-07 18:20:56 +01003647 PyObject *name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003648 int ret;
3649 PyObject *m;
Victor Stinner95872862011-03-07 18:20:56 +01003650 if (!PyArg_ParseTuple(args, "U:init_builtin", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003651 return NULL;
3652 ret = init_builtin(name);
3653 if (ret < 0)
3654 return NULL;
3655 if (ret == 0) {
3656 Py_INCREF(Py_None);
3657 return Py_None;
3658 }
Victor Stinner95872862011-03-07 18:20:56 +01003659 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003660 Py_XINCREF(m);
3661 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003662}
3663
Guido van Rossum79f25d91997-04-29 20:08:16 +00003664static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003665imp_init_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003666{
Victor Stinner53dc7352011-03-20 01:50:21 +01003667 PyObject *name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003668 int ret;
3669 PyObject *m;
Victor Stinner53dc7352011-03-20 01:50:21 +01003670 if (!PyArg_ParseTuple(args, "U:init_frozen", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003671 return NULL;
Victor Stinner53dc7352011-03-20 01:50:21 +01003672 ret = PyImport_ImportFrozenModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003673 if (ret < 0)
3674 return NULL;
3675 if (ret == 0) {
3676 Py_INCREF(Py_None);
3677 return Py_None;
3678 }
Victor Stinner53dc7352011-03-20 01:50:21 +01003679 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003680 Py_XINCREF(m);
3681 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003682}
3683
Guido van Rossum79f25d91997-04-29 20:08:16 +00003684static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003685imp_get_frozen_object(PyObject *self, PyObject *args)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00003686{
Victor Stinner53dc7352011-03-20 01:50:21 +01003687 PyObject *name;
Jack Jansen95ffa231995-10-03 14:38:41 +00003688
Victor Stinner53dc7352011-03-20 01:50:21 +01003689 if (!PyArg_ParseTuple(args, "U:get_frozen_object", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003690 return NULL;
3691 return get_frozen_object(name);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00003692}
3693
Guido van Rossum79f25d91997-04-29 20:08:16 +00003694static PyObject *
Brett Cannon8d110132009-03-15 02:20:16 +00003695imp_is_frozen_package(PyObject *self, PyObject *args)
3696{
Victor Stinner53dc7352011-03-20 01:50:21 +01003697 PyObject *name;
Brett Cannon8d110132009-03-15 02:20:16 +00003698
Victor Stinner53dc7352011-03-20 01:50:21 +01003699 if (!PyArg_ParseTuple(args, "U:is_frozen_package", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003700 return NULL;
3701 return is_frozen_package(name);
Brett Cannon8d110132009-03-15 02:20:16 +00003702}
3703
3704static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003705imp_is_builtin(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003706{
Victor Stinner95872862011-03-07 18:20:56 +01003707 PyObject *name;
3708 if (!PyArg_ParseTuple(args, "U:is_builtin", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003709 return NULL;
3710 return PyLong_FromLong(is_builtin(name));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003711}
3712
Guido van Rossum79f25d91997-04-29 20:08:16 +00003713static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003714imp_is_frozen(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003715{
Victor Stinner53dc7352011-03-20 01:50:21 +01003716 PyObject *name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003717 struct _frozen *p;
Victor Stinner53dc7352011-03-20 01:50:21 +01003718 if (!PyArg_ParseTuple(args, "U:is_frozen", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003719 return NULL;
3720 p = find_frozen(name);
3721 return PyBool_FromLong((long) (p == NULL ? 0 : p->size));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003722}
3723
3724static FILE *
Victor Stinner2f42ae52011-03-20 00:41:24 +01003725get_file(PyObject *pathname, PyObject *fob, char *mode)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003726{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003727 FILE *fp;
3728 if (mode[0] == 'U')
3729 mode = "r" PY_STDIOTEXTMODE;
3730 if (fob == NULL) {
Victor Stinner2f42ae52011-03-20 00:41:24 +01003731 fp = _Py_fopen(pathname, mode);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003732 }
3733 else {
3734 int fd = PyObject_AsFileDescriptor(fob);
3735 if (fd == -1)
3736 return NULL;
3737 if (!_PyVerify_fd(fd))
3738 goto error;
3739 /* the FILE struct gets a new fd, so that it can be closed
3740 * independently of the file descriptor given
3741 */
3742 fd = dup(fd);
3743 if (fd == -1)
3744 goto error;
3745 fp = fdopen(fd, mode);
3746 }
3747 if (fp)
3748 return fp;
Kristján Valur Jónssone1b04452009-03-31 17:43:39 +00003749error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003750 PyErr_SetFromErrno(PyExc_IOError);
3751 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003752}
3753
Guido van Rossum79f25d91997-04-29 20:08:16 +00003754static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003755imp_load_compiled(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003756{
Victor Stinner2f42ae52011-03-20 00:41:24 +01003757 PyObject *name, *pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003758 PyObject *fob = NULL;
3759 PyObject *m;
3760 FILE *fp;
Victor Stinner2f42ae52011-03-20 00:41:24 +01003761 if (!PyArg_ParseTuple(args, "UO&|O:load_compiled",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003762 &name,
Victor Stinner2f42ae52011-03-20 00:41:24 +01003763 PyUnicode_FSDecoder, &pathname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003764 &fob))
3765 return NULL;
Victor Stinner2f42ae52011-03-20 00:41:24 +01003766 fp = get_file(pathname, fob, "rb");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003767 if (fp == NULL) {
Victor Stinnerebc00522010-12-03 17:06:43 +00003768 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003769 return NULL;
3770 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01003771 m = load_compiled_module(name, pathname, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003772 fclose(fp);
Victor Stinnerebc00522010-12-03 17:06:43 +00003773 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003774 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003775}
3776
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003777#ifdef HAVE_DYNAMIC_LOADING
3778
Guido van Rossum79f25d91997-04-29 20:08:16 +00003779static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003780imp_load_dynamic(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003781{
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003782 PyObject *name, *pathname, *fob = NULL, *mod;
3783 FILE *fp;
3784
3785 if (!PyArg_ParseTuple(args, "UO&|O:load_dynamic",
3786 &name, PyUnicode_FSDecoder, &pathname, &fob))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003787 return NULL;
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003788 if (fob != NULL) {
3789 fp = get_file(NULL, fob, "r");
Victor Stinnere9ddbf62011-03-22 10:46:35 +01003790 if (fp == NULL) {
3791 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003792 return NULL;
Victor Stinnere9ddbf62011-03-22 10:46:35 +01003793 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003794 }
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003795 else
3796 fp = NULL;
3797 mod = _PyImport_LoadDynamicModule(name, pathname, fp);
Victor Stinnere9ddbf62011-03-22 10:46:35 +01003798 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003799 if (fp)
3800 fclose(fp);
Victor Stinnerfefd70c2011-03-14 15:54:07 -04003801 return mod;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003802}
3803
Guido van Rossum96a8fb71999-12-22 14:09:35 +00003804#endif /* HAVE_DYNAMIC_LOADING */
3805
Guido van Rossum79f25d91997-04-29 20:08:16 +00003806static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003807imp_load_source(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003808{
Victor Stinner2f42ae52011-03-20 00:41:24 +01003809 PyObject *name, *pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003810 PyObject *fob = NULL;
3811 PyObject *m;
3812 FILE *fp;
Victor Stinner2f42ae52011-03-20 00:41:24 +01003813 if (!PyArg_ParseTuple(args, "UO&|O:load_source",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003814 &name,
Victor Stinner2f42ae52011-03-20 00:41:24 +01003815 PyUnicode_FSDecoder, &pathname,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003816 &fob))
3817 return NULL;
Victor Stinner2f42ae52011-03-20 00:41:24 +01003818 fp = get_file(pathname, fob, "r");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003819 if (fp == NULL) {
Victor Stinnerebc00522010-12-03 17:06:43 +00003820 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003821 return NULL;
3822 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01003823 m = load_source_module(name, pathname, fp);
Victor Stinnerebc00522010-12-03 17:06:43 +00003824 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003825 fclose(fp);
3826 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003827}
3828
Guido van Rossum79f25d91997-04-29 20:08:16 +00003829static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003830imp_load_module(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003831{
Victor Stinner6ae1e7f2011-03-20 22:37:17 +01003832 PyObject *name, *fob, *pathname, *pathname_obj, *ret;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003833 char *suffix; /* Unused */
3834 char *mode;
3835 int type;
3836 FILE *fp;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003837
Victor Stinner6ae1e7f2011-03-20 22:37:17 +01003838 if (!PyArg_ParseTuple(args, "UOO(ssi):load_module",
3839 &name, &fob, &pathname_obj, &suffix, &mode, &type))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003840 return NULL;
Victor Stinner6ae1e7f2011-03-20 22:37:17 +01003841 if (pathname_obj != Py_None) {
3842 if (!PyUnicode_FSDecoder(pathname_obj, &pathname))
3843 return NULL;
3844 }
3845 else
3846 pathname = NULL;
3847
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003848 if (*mode) {
3849 /* Mode must start with 'r' or 'U' and must not contain '+'.
3850 Implicit in this test is the assumption that the mode
3851 may contain other modifiers like 'b' or 't'. */
Guido van Rossum5e2c5fa2002-05-30 17:33:07 +00003852
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003853 if (!(*mode == 'r' || *mode == 'U') || strchr(mode, '+')) {
3854 PyErr_Format(PyExc_ValueError,
3855 "invalid file open mode %.200s", mode);
Victor Stinner6ae1e7f2011-03-20 22:37:17 +01003856 Py_XDECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003857 return NULL;
3858 }
3859 }
3860 if (fob == Py_None)
3861 fp = NULL;
3862 else {
3863 fp = get_file(NULL, fob, mode);
3864 if (fp == NULL) {
Victor Stinner6ae1e7f2011-03-20 22:37:17 +01003865 Py_XDECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003866 return NULL;
3867 }
3868 }
Victor Stinner41c5fec2011-03-13 21:46:30 -04003869 ret = load_module(name, fp, pathname, type, NULL);
Victor Stinner6ae1e7f2011-03-20 22:37:17 +01003870 Py_XDECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003871 if (fp)
3872 fclose(fp);
3873 return ret;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003874}
3875
3876static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003877imp_load_package(PyObject *self, PyObject *args)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003878{
Victor Stinnerc9abda02011-03-14 13:33:46 -04003879 PyObject *name, *pathname;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003880 PyObject * ret;
Victor Stinnerc9abda02011-03-14 13:33:46 -04003881 if (!PyArg_ParseTuple(args, "UO&:load_package",
3882 &name, PyUnicode_FSDecoder, &pathname))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003883 return NULL;
Victor Stinnerc9abda02011-03-14 13:33:46 -04003884 ret = load_package(name, pathname);
Victor Stinnerebc00522010-12-03 17:06:43 +00003885 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003886 return ret;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00003887}
3888
3889static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00003890imp_new_module(PyObject *self, PyObject *args)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003891{
Victor Stinnerfe19d212011-03-14 14:53:28 -04003892 PyObject *name;
3893 if (!PyArg_ParseTuple(args, "U:new_module", &name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003894 return NULL;
Victor Stinnerfe19d212011-03-14 14:53:28 -04003895 return PyModule_NewObject(name);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00003896}
3897
Christian Heimes13a7a212008-01-07 17:13:09 +00003898static PyObject *
3899imp_reload(PyObject *self, PyObject *v)
3900{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003901 return PyImport_ReloadModule(v);
Christian Heimes13a7a212008-01-07 17:13:09 +00003902}
3903
3904PyDoc_STRVAR(doc_reload,
3905"reload(module) -> module\n\
3906\n\
3907Reload the module. The module must have been successfully imported before.");
3908
Barry Warsaw28a691b2010-04-17 00:19:56 +00003909static PyObject *
3910imp_cache_from_source(PyObject *self, PyObject *args, PyObject *kws)
3911{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003912 static char *kwlist[] = {"path", "debug_override", NULL};
Barry Warsaw28a691b2010-04-17 00:19:56 +00003913
Victor Stinner2f42ae52011-03-20 00:41:24 +01003914 PyObject *pathname, *cpathname;
Benjamin Peterson294a9fc2010-10-16 03:12:39 +00003915 PyObject *debug_override = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003916 int debug = !Py_OptimizeFlag;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003917
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003918 if (!PyArg_ParseTupleAndKeywords(
Victor Stinner3ea23dd2010-10-15 20:34:32 +00003919 args, kws, "O&|O", kwlist,
Victor Stinner2f42ae52011-03-20 00:41:24 +01003920 PyUnicode_FSDecoder, &pathname, &debug_override))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003921 return NULL;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003922
Benjamin Peterson294a9fc2010-10-16 03:12:39 +00003923 if (debug_override != NULL &&
3924 (debug = PyObject_IsTrue(debug_override)) < 0) {
Victor Stinner2f42ae52011-03-20 00:41:24 +01003925 Py_DECREF(pathname);
Benjamin Peterson294a9fc2010-10-16 03:12:39 +00003926 return NULL;
3927 }
Barry Warsaw28a691b2010-04-17 00:19:56 +00003928
Martin v. Löwis30260a72011-10-23 17:35:46 +02003929 if (PyUnicode_READY(pathname) < 0)
3930 return NULL;
3931
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02003932 cpathname = make_compiled_pathname(pathname, debug);
Victor Stinner2f42ae52011-03-20 00:41:24 +01003933 Py_DECREF(pathname);
Barry Warsaw28a691b2010-04-17 00:19:56 +00003934
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003935 if (cpathname == NULL) {
3936 PyErr_Format(PyExc_SystemError, "path buffer too short");
3937 return NULL;
3938 }
Victor Stinner2f42ae52011-03-20 00:41:24 +01003939 return cpathname;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003940}
3941
3942PyDoc_STRVAR(doc_cache_from_source,
Éric Araujo5df11082011-11-03 03:38:44 +01003943"cache_from_source(path, [debug_override]) -> path\n\
3944Given the path to a .py file, return the path to its .pyc/.pyo file.\n\
Barry Warsaw28a691b2010-04-17 00:19:56 +00003945\n\
3946The .py file does not need to exist; this simply returns the path to the\n\
3947.pyc/.pyo file calculated as if the .py file were imported. The extension\n\
3948will be .pyc unless __debug__ is not defined, then it will be .pyo.\n\
3949\n\
3950If debug_override is not None, then it must be a boolean and is taken as\n\
3951the value of __debug__ instead.");
3952
3953static PyObject *
3954imp_source_from_cache(PyObject *self, PyObject *args, PyObject *kws)
3955{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003956 static char *kwlist[] = {"path", NULL};
Victor Stinnerc9abda02011-03-14 13:33:46 -04003957 PyObject *pathname, *source;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003958
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003959 if (!PyArg_ParseTupleAndKeywords(
Victor Stinnerebc00522010-12-03 17:06:43 +00003960 args, kws, "O&", kwlist,
Victor Stinnerc9abda02011-03-14 13:33:46 -04003961 PyUnicode_FSDecoder, &pathname))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003962 return NULL;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003963
Victor Stinnerc9abda02011-03-14 13:33:46 -04003964 source = make_source_pathname(pathname);
3965 if (source == NULL) {
3966 PyErr_Format(PyExc_ValueError, "Not a PEP 3147 pyc path: %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003967 pathname);
Victor Stinnerc9abda02011-03-14 13:33:46 -04003968 Py_DECREF(pathname);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003969 return NULL;
3970 }
Victor Stinnerc9abda02011-03-14 13:33:46 -04003971 Py_DECREF(pathname);
3972 return source;
Barry Warsaw28a691b2010-04-17 00:19:56 +00003973}
3974
3975PyDoc_STRVAR(doc_source_from_cache,
Éric Araujo5df11082011-11-03 03:38:44 +01003976"source_from_cache(path) -> path\n\
3977Given the path to a .pyc./.pyo file, return the path to its .py file.\n\
Barry Warsaw28a691b2010-04-17 00:19:56 +00003978\n\
3979The .pyc/.pyo file does not need to exist; this simply returns the path to\n\
3980the .py file calculated to correspond to the .pyc/.pyo file. If path\n\
3981does not conform to PEP 3147 format, ValueError will be raised.");
3982
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003983/* Doc strings */
3984
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003985PyDoc_STRVAR(doc_imp,
3986"This module provides the components needed to build your own\n\
3987__import__ function. Undocumented functions are obsolete.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003988
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003989PyDoc_STRVAR(doc_find_module,
3990"find_module(name, [path]) -> (file, filename, (suffix, mode, type))\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003991Search for a module. If path is omitted or None, search for a\n\
3992built-in, frozen or special module and continue search in sys.path.\n\
3993The module name cannot contain '.'; to search for a submodule of a\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003994package, pass the submodule name and the package's __path__.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003995
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003996PyDoc_STRVAR(doc_load_module,
3997"load_module(name, file, filename, (suffix, mode, type)) -> module\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00003998Load a module, given information returned by find_module().\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003999The module name must include the full package name, if any.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00004000
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004001PyDoc_STRVAR(doc_get_magic,
4002"get_magic() -> string\n\
4003Return the magic number for .pyc or .pyo files.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00004004
Barry Warsaw28a691b2010-04-17 00:19:56 +00004005PyDoc_STRVAR(doc_get_tag,
4006"get_tag() -> string\n\
4007Return the magic tag for .pyc or .pyo files.");
4008
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004009PyDoc_STRVAR(doc_get_suffixes,
4010"get_suffixes() -> [(suffix, mode, type), ...]\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00004011Return a list of (suffix, mode, type) tuples describing the files\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004012that find_module() looks for.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00004013
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004014PyDoc_STRVAR(doc_new_module,
4015"new_module(name) -> module\n\
Guido van Rossum0207e6d1997-09-09 22:04:42 +00004016Create a new module. Do not enter it in sys.modules.\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004017The module name must include the full package name, if any.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00004018
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004019PyDoc_STRVAR(doc_lock_held,
Tim Petersa7c65092004-08-01 23:26:05 +00004020"lock_held() -> boolean\n\
4021Return True if the import lock is currently held, else False.\n\
4022On platforms without threads, return False.");
Tim Peters69232342001-08-30 05:16:13 +00004023
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00004024PyDoc_STRVAR(doc_acquire_lock,
4025"acquire_lock() -> None\n\
Neal Norwitz2294c0d2003-02-12 23:02:21 +00004026Acquires the interpreter's import lock for the current thread.\n\
4027This lock should be used by import hooks to ensure thread-safety\n\
4028when importing modules.\n\
Guido van Rossumc4f4ca92003-02-12 21:46:11 +00004029On platforms without threads, this function does nothing.");
4030
4031PyDoc_STRVAR(doc_release_lock,
4032"release_lock() -> None\n\
4033Release the interpreter's import lock.\n\
4034On platforms without threads, this function does nothing.");
4035
Guido van Rossum79f25d91997-04-29 20:08:16 +00004036static PyMethodDef imp_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004037 {"find_module", imp_find_module, METH_VARARGS, doc_find_module},
4038 {"get_magic", imp_get_magic, METH_NOARGS, doc_get_magic},
4039 {"get_tag", imp_get_tag, METH_NOARGS, doc_get_tag},
4040 {"get_suffixes", imp_get_suffixes, METH_NOARGS, doc_get_suffixes},
4041 {"load_module", imp_load_module, METH_VARARGS, doc_load_module},
4042 {"new_module", imp_new_module, METH_VARARGS, doc_new_module},
4043 {"lock_held", imp_lock_held, METH_NOARGS, doc_lock_held},
4044 {"acquire_lock", imp_acquire_lock, METH_NOARGS, doc_acquire_lock},
4045 {"release_lock", imp_release_lock, METH_NOARGS, doc_release_lock},
4046 {"reload", imp_reload, METH_O, doc_reload},
4047 {"cache_from_source", (PyCFunction)imp_cache_from_source,
4048 METH_VARARGS | METH_KEYWORDS, doc_cache_from_source},
4049 {"source_from_cache", (PyCFunction)imp_source_from_cache,
4050 METH_VARARGS | METH_KEYWORDS, doc_source_from_cache},
4051 /* The rest are obsolete */
4052 {"get_frozen_object", imp_get_frozen_object, METH_VARARGS},
4053 {"is_frozen_package", imp_is_frozen_package, METH_VARARGS},
4054 {"init_builtin", imp_init_builtin, METH_VARARGS},
4055 {"init_frozen", imp_init_frozen, METH_VARARGS},
4056 {"is_builtin", imp_is_builtin, METH_VARARGS},
4057 {"is_frozen", imp_is_frozen, METH_VARARGS},
4058 {"load_compiled", imp_load_compiled, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00004059#ifdef HAVE_DYNAMIC_LOADING
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004060 {"load_dynamic", imp_load_dynamic, METH_VARARGS},
Guido van Rossum96a8fb71999-12-22 14:09:35 +00004061#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004062 {"load_package", imp_load_package, METH_VARARGS},
4063 {"load_source", imp_load_source, METH_VARARGS},
Brett Cannon442c9b92011-03-23 16:14:42 -07004064 {"_fix_co_filename", imp_fix_co_filename, METH_VARARGS},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004065 {NULL, NULL} /* sentinel */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004066};
4067
Guido van Rossum1a8791e1998-08-04 22:46:29 +00004068static int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00004069setint(PyObject *d, char *name, int value)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00004070{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004071 PyObject *v;
4072 int err;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00004073
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004074 v = PyLong_FromLong((long)value);
4075 err = PyDict_SetItemString(d, name, v);
4076 Py_XDECREF(v);
4077 return err;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00004078}
4079
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004080typedef struct {
4081 PyObject_HEAD
4082} NullImporter;
4083
4084static int
4085NullImporter_init(NullImporter *self, PyObject *args, PyObject *kwds)
4086{
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004087#ifndef MS_WINDOWS
4088 PyObject *path;
4089 struct stat statbuf;
4090 int rv;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004091
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004092 if (!_PyArg_NoKeywords("NullImporter()", kwds))
4093 return -1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004094
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004095 if (!PyArg_ParseTuple(args, "O&:NullImporter",
4096 PyUnicode_FSConverter, &path))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004097 return -1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004098
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004099 if (PyBytes_GET_SIZE(path) == 0) {
4100 Py_DECREF(path);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004101 PyErr_SetString(PyExc_ImportError, "empty pathname");
4102 return -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004103 }
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004104
4105 rv = stat(PyBytes_AS_STRING(path), &statbuf);
4106 Py_DECREF(path);
4107 if (rv == 0) {
4108 /* it exists */
4109 if (S_ISDIR(statbuf.st_mode)) {
4110 /* it's a directory */
4111 PyErr_SetString(PyExc_ImportError, "existing directory");
4112 return -1;
4113 }
4114 }
4115#else /* MS_WINDOWS */
4116 PyObject *pathobj;
4117 DWORD rv;
Victor Stinner255dfdb2010-09-29 10:28:51 +00004118 wchar_t *path;
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004119
4120 if (!_PyArg_NoKeywords("NullImporter()", kwds))
4121 return -1;
4122
4123 if (!PyArg_ParseTuple(args, "U:NullImporter",
4124 &pathobj))
4125 return -1;
4126
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02004127 if (PyUnicode_GET_LENGTH(pathobj) == 0) {
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004128 PyErr_SetString(PyExc_ImportError, "empty pathname");
4129 return -1;
4130 }
4131
Victor Stinnerbeb4135b2010-10-07 01:02:42 +00004132 path = PyUnicode_AsWideCharString(pathobj, NULL);
Victor Stinner255dfdb2010-09-29 10:28:51 +00004133 if (path == NULL)
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004134 return -1;
4135 /* see issue1293 and issue3677:
4136 * stat() on Windows doesn't recognise paths like
4137 * "e:\\shared\\" and "\\\\whiterab-c2znlh\\shared" as dirs.
4138 */
4139 rv = GetFileAttributesW(path);
Victor Stinner255dfdb2010-09-29 10:28:51 +00004140 PyMem_Free(path);
Victor Stinner1a4d12d2010-08-13 13:07:29 +00004141 if (rv != INVALID_FILE_ATTRIBUTES) {
4142 /* it exists */
4143 if (rv & FILE_ATTRIBUTE_DIRECTORY) {
4144 /* it's a directory */
4145 PyErr_SetString(PyExc_ImportError, "existing directory");
4146 return -1;
4147 }
4148 }
4149#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004150 return 0;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004151}
4152
4153static PyObject *
4154NullImporter_find_module(NullImporter *self, PyObject *args)
4155{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004156 Py_RETURN_NONE;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004157}
4158
4159static PyMethodDef NullImporter_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004160 {"find_module", (PyCFunction)NullImporter_find_module, METH_VARARGS,
4161 "Always return None"
4162 },
4163 {NULL} /* Sentinel */
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004164};
4165
4166
Christian Heimes9cd17752007-11-18 19:35:23 +00004167PyTypeObject PyNullImporter_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004168 PyVarObject_HEAD_INIT(NULL, 0)
4169 "imp.NullImporter", /*tp_name*/
4170 sizeof(NullImporter), /*tp_basicsize*/
4171 0, /*tp_itemsize*/
4172 0, /*tp_dealloc*/
4173 0, /*tp_print*/
4174 0, /*tp_getattr*/
4175 0, /*tp_setattr*/
4176 0, /*tp_reserved*/
4177 0, /*tp_repr*/
4178 0, /*tp_as_number*/
4179 0, /*tp_as_sequence*/
4180 0, /*tp_as_mapping*/
4181 0, /*tp_hash */
4182 0, /*tp_call*/
4183 0, /*tp_str*/
4184 0, /*tp_getattro*/
4185 0, /*tp_setattro*/
4186 0, /*tp_as_buffer*/
4187 Py_TPFLAGS_DEFAULT, /*tp_flags*/
4188 "Null importer object", /* tp_doc */
4189 0, /* tp_traverse */
4190 0, /* tp_clear */
4191 0, /* tp_richcompare */
4192 0, /* tp_weaklistoffset */
4193 0, /* tp_iter */
4194 0, /* tp_iternext */
4195 NullImporter_methods, /* tp_methods */
4196 0, /* tp_members */
4197 0, /* tp_getset */
4198 0, /* tp_base */
4199 0, /* tp_dict */
4200 0, /* tp_descr_get */
4201 0, /* tp_descr_set */
4202 0, /* tp_dictoffset */
4203 (initproc)NullImporter_init, /* tp_init */
4204 0, /* tp_alloc */
4205 PyType_GenericNew /* tp_new */
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004206};
4207
Martin v. Löwis1a214512008-06-11 05:26:20 +00004208static struct PyModuleDef impmodule = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004209 PyModuleDef_HEAD_INIT,
4210 "imp",
4211 doc_imp,
4212 0,
4213 imp_methods,
4214 NULL,
4215 NULL,
4216 NULL,
4217 NULL
Martin v. Löwis1a214512008-06-11 05:26:20 +00004218};
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004219
Jason Tishler6bc06ec2003-09-04 11:59:50 +00004220PyMODINIT_FUNC
Martin v. Löwis1a214512008-06-11 05:26:20 +00004221PyInit_imp(void)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004222{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004223 PyObject *m, *d;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004224
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004225 if (PyType_Ready(&PyNullImporter_Type) < 0)
4226 return NULL;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00004227
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004228 m = PyModule_Create(&impmodule);
4229 if (m == NULL)
4230 goto failure;
4231 d = PyModule_GetDict(m);
4232 if (d == NULL)
4233 goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004234
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004235 if (setint(d, "SEARCH_ERROR", SEARCH_ERROR) < 0) goto failure;
4236 if (setint(d, "PY_SOURCE", PY_SOURCE) < 0) goto failure;
4237 if (setint(d, "PY_COMPILED", PY_COMPILED) < 0) goto failure;
4238 if (setint(d, "C_EXTENSION", C_EXTENSION) < 0) goto failure;
4239 if (setint(d, "PY_RESOURCE", PY_RESOURCE) < 0) goto failure;
4240 if (setint(d, "PKG_DIRECTORY", PKG_DIRECTORY) < 0) goto failure;
4241 if (setint(d, "C_BUILTIN", C_BUILTIN) < 0) goto failure;
4242 if (setint(d, "PY_FROZEN", PY_FROZEN) < 0) goto failure;
4243 if (setint(d, "PY_CODERESOURCE", PY_CODERESOURCE) < 0) goto failure;
4244 if (setint(d, "IMP_HOOK", IMP_HOOK) < 0) goto failure;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004245
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004246 Py_INCREF(&PyNullImporter_Type);
4247 PyModule_AddObject(m, "NullImporter", (PyObject *)&PyNullImporter_Type);
4248 return m;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00004249 failure:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004250 Py_XDECREF(m);
4251 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00004252}
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004253
4254
Guido van Rossumb18618d2000-05-03 23:44:39 +00004255/* API for embedding applications that want to add their own entries
4256 to the table of built-in modules. This should normally be called
4257 *before* Py_Initialize(). When the table resize fails, -1 is
4258 returned and the existing table is unchanged.
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004259
4260 After a similar function by Just van Rossum. */
4261
4262int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00004263PyImport_ExtendInittab(struct _inittab *newtab)
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004264{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004265 static struct _inittab *our_copy = NULL;
4266 struct _inittab *p;
4267 int i, n;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004268
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004269 /* Count the number of entries in both tables */
4270 for (n = 0; newtab[n].name != NULL; n++)
4271 ;
4272 if (n == 0)
4273 return 0; /* Nothing to do */
4274 for (i = 0; PyImport_Inittab[i].name != NULL; i++)
4275 ;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004276
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004277 /* Allocate new memory for the combined table */
4278 p = our_copy;
4279 PyMem_RESIZE(p, struct _inittab, i+n+1);
4280 if (p == NULL)
4281 return -1;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004282
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004283 /* Copy the tables into the new memory */
4284 if (our_copy != PyImport_Inittab)
4285 memcpy(p, PyImport_Inittab, (i+1) * sizeof(struct _inittab));
4286 PyImport_Inittab = our_copy = p;
4287 memcpy(p+i, newtab, (n+1) * sizeof(struct _inittab));
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004288
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004289 return 0;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004290}
4291
4292/* Shorthand to add a single entry given a name and a function */
4293
4294int
Brett Cannona826f322009-04-02 03:41:46 +00004295PyImport_AppendInittab(const char *name, PyObject* (*initfunc)(void))
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004296{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004297 struct _inittab newtab[2];
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004298
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004299 memset(newtab, '\0', sizeof newtab);
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004300
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004301 newtab[0].name = (char *)name;
4302 newtab[0].initfunc = initfunc;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004303
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00004304 return PyImport_ExtendInittab(newtab);
Guido van Rossum09cae1f1998-05-14 02:32:54 +00004305}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00004306
4307#ifdef __cplusplus
4308}
4309#endif